1 // Copyright (c) 2017-2026, Lawrence Livermore National Security, LLC and other CEED contributors. 2 // All Rights Reserved. See the top-level LICENSE and NOTICE files for details. 3 // 4 // SPDX-License-Identifier: BSD-2-Clause 5 // 6 // This file is part of CEED: http://github.com/ceed 7 8 /// @file 9 /// Private header for frontend components of libCEED 10 #pragma once 11 12 #include <ceed.h> 13 #include <ceed/backend.h> 14 #include <stdbool.h> 15 16 CEED_INTERN const char *CeedJitSourceRootDefault; 17 18 /** @defgroup CeedUser Public API for Ceed 19 @ingroup Ceed 20 */ 21 /** @defgroup CeedBackend Backend API for Ceed 22 @ingroup Ceed 23 */ 24 /** @defgroup CeedDeveloper Internal library functions for Ceed 25 @ingroup Ceed 26 */ 27 /** @defgroup CeedVectorUser Public API for CeedVector 28 @ingroup CeedVector 29 */ 30 /** @defgroup CeedVectorBackend Backend API for CeedVector 31 @ingroup CeedVector 32 */ 33 /** @defgroup CeedVectorDeveloper Internal library functions for CeedVector 34 @ingroup CeedVector 35 */ 36 /** @defgroup CeedElemRestrictionUser Public API for CeedElemRestriction 37 @ingroup CeedElemRestriction 38 */ 39 /** @defgroup CeedElemRestrictionBackend Backend API for CeedElemRestriction 40 @ingroup CeedElemRestriction 41 */ 42 /** @defgroup CeedElemRestrictionDeveloper Internal library functions for CeedElemRestriction 43 @ingroup CeedElemRestriction 44 */ 45 /** @defgroup CeedBasisUser Public API for CeedBasis 46 @ingroup CeedBasis 47 */ 48 /** @defgroup CeedBasisBackend Backend API for CeedBasis 49 @ingroup CeedBasis 50 */ 51 /** @defgroup CeedBasisDeveloper Internal library functions for CeedBasis 52 @ingroup CeedBasis 53 */ 54 /** @defgroup CeedQFunctionUser Public API for CeedQFunction 55 @ingroup CeedQFunction 56 */ 57 /** @defgroup CeedQFunctionBackend Backend API for CeedQFunction 58 @ingroup CeedQFunction 59 */ 60 /** @defgroup CeedQFunctionDeveloper Internal library functions for CeedQFunction 61 @ingroup CeedQFunction 62 */ 63 /** @defgroup CeedOperatorUser Public API for CeedOperator 64 @ingroup CeedOperator 65 */ 66 /** @defgroup CeedOperatorBackend Backend API for CeedOperator 67 @ingroup CeedOperator 68 */ 69 /** @defgroup CeedOperatorDeveloper Internal library functions for CeedOperator 70 @ingroup CeedOperator 71 */ 72 73 // Lookup table field for backend functions 74 typedef struct { 75 const char *func_name; 76 size_t offset; 77 } FOffset; 78 79 // Lookup table field for object delegates 80 typedef struct { 81 char *obj_name; 82 Ceed delegate; 83 } ObjDelegate; 84 85 // Work vector tracking 86 typedef struct CeedWorkVectors_private *CeedWorkVectors; 87 struct CeedWorkVectors_private { 88 CeedInt num_vecs, max_vecs; 89 bool *is_in_use; 90 CeedVector *vecs; 91 }; 92 93 typedef struct CeedObject_private { 94 Ceed ceed; 95 int (*View)(CeedObject, FILE *); 96 int (*Destroy)(CeedObject *); 97 int ref_count; 98 CeedInt num_view_tabs; 99 } CeedObject_private; 100 101 struct Ceed_private { 102 CeedObject_private obj; 103 const char *resource; 104 Ceed delegate; 105 Ceed parent; 106 ObjDelegate *obj_delegates; 107 int obj_delegate_count; 108 Ceed op_fallback_ceed; 109 char **jit_source_roots; 110 char **rust_source_roots; 111 CeedInt num_rust_source_roots, max_rust_source_roots, num_rust_source_roots_readers; 112 CeedInt num_jit_source_roots, max_jit_source_roots, num_jit_source_roots_readers; 113 bool cuda_compile_with_clang; 114 char **jit_defines; 115 CeedInt num_jit_defines, max_jit_defines, num_jit_defines_readers; 116 int (*Error)(Ceed, const char *, int, const char *, int, const char *, va_list *); 117 int (*SetStream)(Ceed, void *); 118 int (*GetPreferredMemType)(CeedMemType *); 119 int (*Destroy)(Ceed); 120 int (*VectorCreate)(CeedSize, CeedVector); 121 int (*ElemRestrictionCreate)(CeedMemType, CeedCopyMode, const CeedInt *, const bool *, const CeedInt8 *, CeedElemRestriction); 122 int (*ElemRestrictionCreateAtPoints)(CeedMemType, CeedCopyMode, const CeedInt *, const bool *, const CeedInt8 *, CeedElemRestriction); 123 int (*ElemRestrictionCreateBlocked)(CeedMemType, CeedCopyMode, const CeedInt *, const bool *, const CeedInt8 *, CeedElemRestriction); 124 int (*BasisCreateTensorH1)(CeedInt, CeedInt, CeedInt, const CeedScalar *, const CeedScalar *, const CeedScalar *, const CeedScalar *, CeedBasis); 125 int (*BasisCreateH1)(CeedElemTopology, CeedInt, CeedInt, CeedInt, const CeedScalar *, const CeedScalar *, const CeedScalar *, const CeedScalar *, 126 CeedBasis); 127 int (*BasisCreateHdiv)(CeedElemTopology, CeedInt, CeedInt, CeedInt, const CeedScalar *, const CeedScalar *, const CeedScalar *, const CeedScalar *, 128 CeedBasis); 129 int (*BasisCreateHcurl)(CeedElemTopology, CeedInt, CeedInt, CeedInt, const CeedScalar *, const CeedScalar *, const CeedScalar *, const CeedScalar *, 130 CeedBasis); 131 int (*TensorContractCreate)(CeedTensorContract); 132 int (*QFunctionCreate)(CeedQFunction); 133 int (*QFunctionContextCreate)(CeedQFunctionContext); 134 int (*OperatorCreate)(CeedOperator); 135 int (*OperatorCreateAtPoints)(CeedOperator); 136 int (*CompositeOperatorCreate)(CeedOperator); 137 void *data; 138 bool is_debug; 139 bool is_deterministic; 140 char err_msg[CEED_MAX_RESOURCE_LEN]; 141 FOffset *f_offsets; 142 CeedWorkVectors work_vectors; 143 }; 144 145 struct CeedVector_private { 146 CeedObject_private obj; 147 int (*HasValidArray)(CeedVector, bool *); 148 int (*HasBorrowedArrayOfType)(CeedVector, CeedMemType, bool *); 149 int (*CopyStrided)(CeedVector, CeedSize, CeedSize, CeedSize, CeedVector); 150 int (*SetArray)(CeedVector, CeedMemType, CeedCopyMode, CeedScalar *); 151 int (*SetValue)(CeedVector, CeedScalar); 152 int (*SetValueStrided)(CeedVector, CeedSize, CeedSize, CeedSize, CeedScalar); 153 int (*SyncArray)(CeedVector, CeedMemType); 154 int (*TakeArray)(CeedVector, CeedMemType, CeedScalar **); 155 int (*GetArray)(CeedVector, CeedMemType, CeedScalar **); 156 int (*GetArrayRead)(CeedVector, CeedMemType, const CeedScalar **); 157 int (*GetArrayWrite)(CeedVector, CeedMemType, CeedScalar **); 158 int (*RestoreArray)(CeedVector); 159 int (*RestoreArrayRead)(CeedVector); 160 int (*Norm)(CeedVector, CeedNormType, CeedScalar *); 161 int (*Scale)(CeedVector, CeedScalar); 162 int (*AXPY)(CeedVector, CeedScalar, CeedVector); 163 int (*AXPBY)(CeedVector, CeedScalar, CeedScalar, CeedVector); 164 int (*PointwiseMult)(CeedVector, CeedVector, CeedVector); 165 int (*Reciprocal)(CeedVector); 166 int (*Destroy)(CeedVector); 167 CeedSize length; 168 uint64_t state; 169 uint64_t num_readers; 170 void *data; 171 }; 172 173 struct CeedElemRestriction_private { 174 CeedObject_private obj; 175 CeedElemRestriction rstr_base; 176 int (*Apply)(CeedElemRestriction, CeedTransposeMode, CeedVector, CeedVector, CeedRequest *); 177 int (*ApplyUnsigned)(CeedElemRestriction, CeedTransposeMode, CeedVector, CeedVector, CeedRequest *); 178 int (*ApplyUnoriented)(CeedElemRestriction, CeedTransposeMode, CeedVector, CeedVector, CeedRequest *); 179 int (*ApplyAtPointsInElement)(CeedElemRestriction, CeedInt, CeedTransposeMode, CeedVector, CeedVector, CeedRequest *); 180 int (*ApplyBlock)(CeedElemRestriction, CeedInt, CeedTransposeMode, CeedVector, CeedVector, CeedRequest *); 181 int (*GetAtPointsElementOffset)(CeedElemRestriction, CeedInt, CeedSize *); 182 int (*GetOffsets)(CeedElemRestriction, CeedMemType, const CeedInt **); 183 int (*GetOrientations)(CeedElemRestriction, CeedMemType, const bool **); 184 int (*GetCurlOrientations)(CeedElemRestriction, CeedMemType, const CeedInt8 **); 185 int (*Destroy)(CeedElemRestriction); 186 CeedInt num_elem; /* number of elements */ 187 CeedInt elem_size; /* number of nodes per element */ 188 CeedInt num_points; /* number of points, for points restriction */ 189 CeedInt num_comp; /* number of components */ 190 CeedInt comp_stride; /* Component stride for L-vector ordering */ 191 CeedSize l_size; /* size of the L-vector, can be used for checking for correct vector sizes */ 192 CeedSize e_size; /* minimum size of the E-vector, can be used for checking for correct vector sizes */ 193 CeedInt block_size; /* number of elements in a batch */ 194 CeedInt num_block; /* number of blocks of elements */ 195 CeedInt *strides; /* strides between [nodes, components, elements] */ 196 CeedInt l_layout[3]; /* L-vector layout [nodes, components, elements] */ 197 CeedInt e_layout[3]; /* E-vector layout [nodes, components, elements] */ 198 CeedRestrictionType 199 rstr_type; /* initialized in element restriction constructor for default, oriented, curl-oriented, or strided element restriction */ 200 uint64_t num_readers; /* number of instances of offset read only access */ 201 void *data; /* place for the backend to store any data */ 202 }; 203 204 struct CeedBasis_private { 205 CeedObject_private obj; 206 int (*Apply)(CeedBasis, CeedInt, CeedTransposeMode, CeedEvalMode, CeedVector, CeedVector); 207 int (*ApplyAdd)(CeedBasis, CeedInt, CeedTransposeMode, CeedEvalMode, CeedVector, CeedVector); 208 int (*ApplyAtPoints)(CeedBasis, CeedInt, const CeedInt *, CeedTransposeMode, CeedEvalMode, CeedVector, CeedVector, CeedVector); 209 int (*ApplyAddAtPoints)(CeedBasis, CeedInt, const CeedInt *, CeedTransposeMode, CeedEvalMode, CeedVector, CeedVector, CeedVector); 210 int (*Destroy)(CeedBasis); 211 bool is_tensor_basis; /* flag for tensor basis */ 212 CeedInt dim; /* topological dimension */ 213 CeedElemTopology topo; /* element topology */ 214 CeedInt num_comp; /* number of field components (1 for scalar fields) */ 215 CeedInt P_1d; /* number of nodes in one dimension */ 216 CeedInt Q_1d; /* number of quadrature points in one dimension */ 217 CeedInt P; /* total number of nodes */ 218 CeedInt Q; /* total number of quadrature points */ 219 CeedFESpace fe_space; /* initialized in basis constructor with 1, 2, 3 for H^1, H(div), and H(curl) FE space */ 220 CeedTensorContract contract; /* tensor contraction object */ 221 CeedScalar *q_ref_1d; /* array of length Q1d holding the locations of quadrature points on the 1D reference element [-1, 1] */ 222 CeedScalar *q_weight_1d; /* array of length Q1d holding the quadrature weights on the reference element */ 223 CeedScalar *interp; /* row-major matrix of shape [Q, P] or [dim * Q, P] expressing the values of nodal basis functions or vector basis functions at 224 quadrature points */ 225 CeedScalar *interp_1d; /* row-major matrix of shape [Q1d, P1d] expressing the values of nodal basis functions at quadrature points */ 226 CeedScalar *grad; /* row-major matrix of shape [dim * Q, P] matrix expressing derivatives of nodal basis functions at quadrature points */ 227 CeedScalar *grad_1d; /* row-major matrix of shape [Q1d, P1d] matrix expressing derivatives of nodal basis functions at quadrature points */ 228 CeedScalar *div; /* row-major matrix of shape [Q, P] expressing the divergence of basis functions at quadrature points for H(div) discretizations */ 229 CeedScalar *curl; /* row-major matrix of shape [curl_dim * Q, P], curl_dim = 1 if dim < 3 else dim, expressing the curl of basis functions at 230 quadrature points for H(curl) discretizations */ 231 CeedVector vec_chebyshev; 232 CeedBasis basis_chebyshev; /* basis interpolating from nodes to Chebyshev polynomial coefficients */ 233 void *data; /* place for the backend to store any data */ 234 }; 235 236 struct CeedTensorContract_private { 237 CeedObject_private obj; 238 int (*Apply)(CeedTensorContract, CeedInt, CeedInt, CeedInt, CeedInt, const CeedScalar *restrict, CeedTransposeMode, const CeedInt, 239 const CeedScalar *restrict, CeedScalar *restrict); 240 int (*Destroy)(CeedTensorContract); 241 void *data; 242 }; 243 244 struct CeedQFunctionField_private { 245 const char *field_name; 246 CeedInt size; 247 CeedEvalMode eval_mode; 248 }; 249 250 struct CeedQFunction_private { 251 CeedObject_private obj; 252 int (*Apply)(CeedQFunction, CeedInt, CeedVector *, CeedVector *); 253 int (*SetCUDAUserFunction)(CeedQFunction, void *); 254 int (*SetHIPUserFunction)(CeedQFunction, void *); 255 int (*Destroy)(CeedQFunction); 256 CeedInt vec_length; /* Number of quadrature points must be padded to a multiple of vec_length */ 257 CeedQFunctionField *input_fields; 258 CeedQFunctionField *output_fields; 259 CeedInt num_input_fields, num_output_fields; 260 CeedQFunctionUser function; 261 CeedInt user_flop_estimate; 262 const char *user_source; 263 const char *source_path; 264 const char *kernel_name; 265 const char *gallery_name; 266 bool is_gallery; 267 bool is_identity; 268 bool is_fortran; 269 bool is_immutable; 270 bool is_context_writable; 271 CeedQFunctionContext ctx; /* user context for function */ 272 void *data; /* place for the backend to store any data */ 273 }; 274 275 struct CeedQFunctionContext_private { 276 CeedObject_private obj; 277 int (*HasValidData)(CeedQFunctionContext, bool *); 278 int (*HasBorrowedDataOfType)(CeedQFunctionContext, CeedMemType, bool *); 279 int (*SetData)(CeedQFunctionContext, CeedMemType, CeedCopyMode, void *); 280 int (*TakeData)(CeedQFunctionContext, CeedMemType, void *); 281 int (*GetData)(CeedQFunctionContext, CeedMemType, void *); 282 int (*GetDataRead)(CeedQFunctionContext, CeedMemType, void *); 283 int (*RestoreData)(CeedQFunctionContext); 284 int (*RestoreDataRead)(CeedQFunctionContext); 285 int (*DataDestroy)(CeedQFunctionContext); 286 int (*Destroy)(CeedQFunctionContext); 287 CeedQFunctionContextDataDestroyUser data_destroy_function; 288 CeedMemType data_destroy_mem_type; 289 CeedInt num_fields; 290 CeedInt max_fields; 291 CeedContextFieldLabel *field_labels; 292 uint64_t state; 293 uint64_t num_readers; 294 size_t ctx_size; 295 void *data; 296 }; 297 298 /// Struct to handle the context data to use the Fortran QFunction stub 299 /// @ingroup CeedQFunction 300 struct CeedFortranContext_private { 301 CeedQFunctionContext inner_ctx; 302 void (*f)(void *ctx, int *nq, const CeedScalar *u, const CeedScalar *u1, const CeedScalar *u2, const CeedScalar *u3, const CeedScalar *u4, 303 const CeedScalar *u5, const CeedScalar *u6, const CeedScalar *u7, const CeedScalar *u8, const CeedScalar *u9, const CeedScalar *u10, 304 const CeedScalar *u11, const CeedScalar *u12, const CeedScalar *u13, const CeedScalar *u14, const CeedScalar *u15, CeedScalar *v, 305 CeedScalar *v1, CeedScalar *v2, CeedScalar *v3, CeedScalar *v4, CeedScalar *v5, CeedScalar *v6, CeedScalar *v7, CeedScalar *v8, 306 CeedScalar *v9, CeedScalar *v10, CeedScalar *v11, CeedScalar *v12, CeedScalar *v13, CeedScalar *v14, CeedScalar *v15, int *err); 307 }; 308 typedef struct CeedFortranContext_private *CeedFortranContext; 309 310 struct CeedContextFieldLabel_private { 311 const char *name; 312 const char *description; 313 CeedContextFieldType type; 314 size_t size; 315 size_t num_values; 316 size_t offset; 317 CeedInt num_sub_labels; 318 CeedContextFieldLabel *sub_labels; 319 bool from_op; 320 }; 321 322 struct CeedOperatorField_private { 323 CeedElemRestriction elem_rstr; /* Restriction from L-vector */ 324 CeedBasis basis; /* Basis or CEED_BASIS_NONE for collocated fields */ 325 CeedVector vec; /* State vector for passive fields or CEED_VECTOR_NONE for no vector */ 326 const char *field_name; /* matching QFunction field name */ 327 }; 328 329 struct CeedQFunctionAssemblyData_private { 330 Ceed ceed; 331 int ref_count; 332 bool is_setup; 333 bool reuse_data; 334 bool needs_data_update; 335 CeedVector vec; 336 CeedElemRestriction rstr; 337 }; 338 339 struct CeedOperatorAssemblyData_private { 340 Ceed ceed; 341 CeedInt num_active_bases_in, num_active_bases_out; 342 CeedBasis *active_bases_in, *active_bases_out; 343 CeedElemRestriction *active_elem_rstrs_in, *active_elem_rstrs_out; 344 CeedInt *num_eval_modes_in, *num_eval_modes_out; 345 CeedEvalMode **eval_modes_in, **eval_modes_out; 346 CeedScalar **assembled_bases_in, **assembled_bases_out; 347 CeedSize **eval_mode_offsets_in, **eval_mode_offsets_out, num_output_components; 348 }; 349 350 struct CeedOperator_private { 351 CeedObject_private obj; 352 CeedOperator op_fallback, op_fallback_parent; 353 int (*LinearAssembleQFunction)(CeedOperator, CeedVector *, CeedElemRestriction *, CeedRequest *); 354 int (*LinearAssembleQFunctionUpdate)(CeedOperator, CeedVector, CeedElemRestriction, CeedRequest *); 355 int (*LinearAssembleDiagonal)(CeedOperator, CeedVector, CeedRequest *); 356 int (*LinearAssembleAddDiagonal)(CeedOperator, CeedVector, CeedRequest *); 357 int (*LinearAssemblePointBlockDiagonal)(CeedOperator, CeedVector, CeedRequest *); 358 int (*LinearAssembleAddPointBlockDiagonal)(CeedOperator, CeedVector, CeedRequest *); 359 int (*LinearAssembleSymbolic)(CeedOperator, CeedSize *, CeedInt **, CeedInt **); 360 int (*LinearAssemble)(CeedOperator, CeedVector); 361 int (*LinearAssembleSingle)(CeedOperator, CeedInt, CeedVector); 362 int (*CreateFDMElementInverse)(CeedOperator, CeedOperator *, CeedRequest *); 363 int (*Apply)(CeedOperator, CeedVector, CeedVector, CeedRequest *); 364 int (*ApplyComposite)(CeedOperator, CeedVector, CeedVector, CeedRequest *); 365 int (*ApplyAdd)(CeedOperator, CeedVector, CeedVector, CeedRequest *); 366 int (*ApplyAddComposite)(CeedOperator, CeedVector, CeedVector, CeedRequest *); 367 int (*ApplyJacobian)(CeedOperator, CeedVector, CeedVector, CeedVector, CeedVector, CeedRequest *); 368 int (*Destroy)(CeedOperator); 369 CeedOperatorField *input_fields; 370 CeedOperatorField *output_fields; 371 CeedSize input_size, output_size; 372 CeedInt num_elem; /* Number of elements */ 373 CeedInt num_qpts; /* Number of quadrature points over all elements */ 374 CeedInt num_fields; /* Number of fields that have been set */ 375 CeedQFunction qf; 376 CeedQFunction dqf; 377 CeedQFunction dqfT; 378 const char *name; 379 bool is_immutable; 380 bool is_interface_setup; 381 bool is_backend_setup; 382 bool is_composite; 383 bool is_at_points; 384 bool has_restriction; 385 bool is_sequential; 386 CeedQFunctionAssemblyData qf_assembled; 387 CeedOperatorAssemblyData op_assembled; 388 CeedOperator *sub_operators; 389 CeedInt num_suboperators; 390 void *data; 391 CeedInt num_context_labels; 392 CeedInt max_context_labels; 393 CeedContextFieldLabel *context_labels; 394 CeedElemRestriction rstr_points, first_points_rstr; 395 CeedVector point_coords; 396 }; 397