1 // Copyright (c) 2017-2025, 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 struct Ceed_private { 94 const char *resource; 95 Ceed delegate; 96 Ceed parent; 97 ObjDelegate *obj_delegates; 98 int obj_delegate_count; 99 Ceed op_fallback_ceed; 100 char **jit_source_roots; 101 char **rust_source_roots; 102 CeedInt num_rust_source_roots, max_rust_source_roots, num_rust_source_roots_readers; 103 CeedInt num_jit_source_roots, max_jit_source_roots, num_jit_source_roots_readers; 104 bool cuda_compile_with_clang; 105 char **jit_defines; 106 CeedInt num_jit_defines, max_jit_defines, num_jit_defines_readers; 107 int (*Error)(Ceed, const char *, int, const char *, int, const char *, va_list *); 108 int (*SetStream)(Ceed, void *); 109 int (*GetPreferredMemType)(CeedMemType *); 110 int (*Destroy)(Ceed); 111 int (*VectorCreate)(CeedSize, CeedVector); 112 int (*ElemRestrictionCreate)(CeedMemType, CeedCopyMode, const CeedInt *, const bool *, const CeedInt8 *, CeedElemRestriction); 113 int (*ElemRestrictionCreateAtPoints)(CeedMemType, CeedCopyMode, const CeedInt *, const bool *, const CeedInt8 *, CeedElemRestriction); 114 int (*ElemRestrictionCreateBlocked)(CeedMemType, CeedCopyMode, const CeedInt *, const bool *, const CeedInt8 *, CeedElemRestriction); 115 int (*BasisCreateTensorH1)(CeedInt, CeedInt, CeedInt, const CeedScalar *, const CeedScalar *, const CeedScalar *, const CeedScalar *, CeedBasis); 116 int (*BasisCreateH1)(CeedElemTopology, CeedInt, CeedInt, CeedInt, const CeedScalar *, const CeedScalar *, const CeedScalar *, const CeedScalar *, 117 CeedBasis); 118 int (*BasisCreateHdiv)(CeedElemTopology, CeedInt, CeedInt, CeedInt, const CeedScalar *, const CeedScalar *, const CeedScalar *, const CeedScalar *, 119 CeedBasis); 120 int (*BasisCreateHcurl)(CeedElemTopology, CeedInt, CeedInt, CeedInt, const CeedScalar *, const CeedScalar *, const CeedScalar *, const CeedScalar *, 121 CeedBasis); 122 int (*TensorContractCreate)(CeedTensorContract); 123 int (*QFunctionCreate)(CeedQFunction); 124 int (*QFunctionContextCreate)(CeedQFunctionContext); 125 int (*OperatorCreate)(CeedOperator); 126 int (*OperatorCreateAtPoints)(CeedOperator); 127 int (*CompositeOperatorCreate)(CeedOperator); 128 int ref_count; 129 void *data; 130 bool is_debug; 131 bool is_deterministic; 132 char err_msg[CEED_MAX_RESOURCE_LEN]; 133 FOffset *f_offsets; 134 CeedWorkVectors work_vectors; 135 }; 136 137 struct CeedVector_private { 138 Ceed ceed; 139 int (*HasValidArray)(CeedVector, bool *); 140 int (*HasBorrowedArrayOfType)(CeedVector, CeedMemType, bool *); 141 int (*CopyStrided)(CeedVector, CeedSize, CeedSize, CeedSize, CeedVector); 142 int (*SetArray)(CeedVector, CeedMemType, CeedCopyMode, CeedScalar *); 143 int (*SetValue)(CeedVector, CeedScalar); 144 int (*SetValueStrided)(CeedVector, CeedSize, CeedSize, CeedSize, CeedScalar); 145 int (*SyncArray)(CeedVector, CeedMemType); 146 int (*TakeArray)(CeedVector, CeedMemType, CeedScalar **); 147 int (*GetArray)(CeedVector, CeedMemType, CeedScalar **); 148 int (*GetArrayRead)(CeedVector, CeedMemType, const CeedScalar **); 149 int (*GetArrayWrite)(CeedVector, CeedMemType, CeedScalar **); 150 int (*RestoreArray)(CeedVector); 151 int (*RestoreArrayRead)(CeedVector); 152 int (*Norm)(CeedVector, CeedNormType, CeedScalar *); 153 int (*Scale)(CeedVector, CeedScalar); 154 int (*AXPY)(CeedVector, CeedScalar, CeedVector); 155 int (*AXPBY)(CeedVector, CeedScalar, CeedScalar, CeedVector); 156 int (*PointwiseMult)(CeedVector, CeedVector, CeedVector); 157 int (*Reciprocal)(CeedVector); 158 int (*Destroy)(CeedVector); 159 int ref_count; 160 CeedSize length; 161 uint64_t state; 162 uint64_t num_readers; 163 void *data; 164 }; 165 166 struct CeedElemRestriction_private { 167 Ceed ceed; 168 CeedElemRestriction rstr_base; 169 int (*Apply)(CeedElemRestriction, CeedTransposeMode, CeedVector, CeedVector, CeedRequest *); 170 int (*ApplyUnsigned)(CeedElemRestriction, CeedTransposeMode, CeedVector, CeedVector, CeedRequest *); 171 int (*ApplyUnoriented)(CeedElemRestriction, CeedTransposeMode, CeedVector, CeedVector, CeedRequest *); 172 int (*ApplyAtPointsInElement)(CeedElemRestriction, CeedInt, CeedTransposeMode, CeedVector, CeedVector, CeedRequest *); 173 int (*ApplyBlock)(CeedElemRestriction, CeedInt, CeedTransposeMode, CeedVector, CeedVector, CeedRequest *); 174 int (*GetAtPointsElementOffset)(CeedElemRestriction, CeedInt, CeedSize *); 175 int (*GetOffsets)(CeedElemRestriction, CeedMemType, const CeedInt **); 176 int (*GetOrientations)(CeedElemRestriction, CeedMemType, const bool **); 177 int (*GetCurlOrientations)(CeedElemRestriction, CeedMemType, const CeedInt8 **); 178 int (*Destroy)(CeedElemRestriction); 179 int ref_count; 180 CeedInt num_elem; /* number of elements */ 181 CeedInt elem_size; /* number of nodes per element */ 182 CeedInt num_points; /* number of points, for points restriction */ 183 CeedInt num_comp; /* number of components */ 184 CeedInt comp_stride; /* Component stride for L-vector ordering */ 185 CeedSize l_size; /* size of the L-vector, can be used for checking for correct vector sizes */ 186 CeedSize e_size; /* minimum size of the E-vector, can be used for checking for correct vector sizes */ 187 CeedInt block_size; /* number of elements in a batch */ 188 CeedInt num_block; /* number of blocks of elements */ 189 CeedInt *strides; /* strides between [nodes, components, elements] */ 190 CeedInt l_layout[3]; /* L-vector layout [nodes, components, elements] */ 191 CeedInt e_layout[3]; /* E-vector layout [nodes, components, elements] */ 192 CeedRestrictionType 193 rstr_type; /* initialized in element restriction constructor for default, oriented, curl-oriented, or strided element restriction */ 194 uint64_t num_readers; /* number of instances of offset read only access */ 195 void *data; /* place for the backend to store any data */ 196 }; 197 198 struct CeedBasis_private { 199 Ceed ceed; 200 int (*Apply)(CeedBasis, CeedInt, CeedTransposeMode, CeedEvalMode, CeedVector, CeedVector); 201 int (*ApplyAdd)(CeedBasis, CeedInt, CeedTransposeMode, CeedEvalMode, CeedVector, CeedVector); 202 int (*ApplyAtPoints)(CeedBasis, CeedInt, const CeedInt *, CeedTransposeMode, CeedEvalMode, CeedVector, CeedVector, CeedVector); 203 int (*ApplyAddAtPoints)(CeedBasis, CeedInt, const CeedInt *, CeedTransposeMode, CeedEvalMode, CeedVector, CeedVector, CeedVector); 204 int (*Destroy)(CeedBasis); 205 int ref_count; 206 bool is_tensor_basis; /* flag for tensor basis */ 207 CeedInt dim; /* topological dimension */ 208 CeedElemTopology topo; /* element topology */ 209 CeedInt num_comp; /* number of field components (1 for scalar fields) */ 210 CeedInt P_1d; /* number of nodes in one dimension */ 211 CeedInt Q_1d; /* number of quadrature points in one dimension */ 212 CeedInt P; /* total number of nodes */ 213 CeedInt Q; /* total number of quadrature points */ 214 CeedFESpace fe_space; /* initialized in basis constructor with 1, 2, 3 for H^1, H(div), and H(curl) FE space */ 215 CeedTensorContract contract; /* tensor contraction object */ 216 CeedScalar *q_ref_1d; /* array of length Q1d holding the locations of quadrature points on the 1D reference element [-1, 1] */ 217 CeedScalar *q_weight_1d; /* array of length Q1d holding the quadrature weights on the reference element */ 218 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 219 quadrature points */ 220 CeedScalar *interp_1d; /* row-major matrix of shape [Q1d, P1d] expressing the values of nodal basis functions at quadrature points */ 221 CeedScalar *grad; /* row-major matrix of shape [dim * Q, P] matrix expressing derivatives of nodal basis functions at quadrature points */ 222 CeedScalar *grad_1d; /* row-major matrix of shape [Q1d, P1d] matrix expressing derivatives of nodal basis functions at quadrature points */ 223 CeedScalar *div; /* row-major matrix of shape [Q, P] expressing the divergence of basis functions at quadrature points for H(div) discretizations */ 224 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 225 quadrature points for H(curl) discretizations */ 226 CeedVector vec_chebyshev; 227 CeedBasis basis_chebyshev; /* basis interpolating from nodes to Chebyshev polynomial coefficients */ 228 void *data; /* place for the backend to store any data */ 229 }; 230 231 struct CeedTensorContract_private { 232 Ceed ceed; 233 int (*Apply)(CeedTensorContract, CeedInt, CeedInt, CeedInt, CeedInt, const CeedScalar *restrict, CeedTransposeMode, const CeedInt, 234 const CeedScalar *restrict, CeedScalar *restrict); 235 int (*Destroy)(CeedTensorContract); 236 int ref_count; 237 void *data; 238 }; 239 240 struct CeedQFunctionField_private { 241 const char *field_name; 242 CeedInt size; 243 CeedEvalMode eval_mode; 244 }; 245 246 struct CeedQFunction_private { 247 Ceed ceed; 248 int (*Apply)(CeedQFunction, CeedInt, CeedVector *, CeedVector *); 249 int (*SetCUDAUserFunction)(CeedQFunction, void *); 250 int (*SetHIPUserFunction)(CeedQFunction, void *); 251 int (*Destroy)(CeedQFunction); 252 int ref_count; 253 CeedInt vec_length; /* Number of quadrature points must be padded to a multiple of vec_length */ 254 CeedQFunctionField *input_fields; 255 CeedQFunctionField *output_fields; 256 CeedInt num_input_fields, num_output_fields; 257 CeedQFunctionUser function; 258 CeedInt user_flop_estimate; 259 const char *user_source; 260 const char *source_path; 261 const char *kernel_name; 262 const char *gallery_name; 263 bool is_gallery; 264 bool is_identity; 265 bool is_fortran; 266 bool is_immutable; 267 bool is_context_writable; 268 CeedQFunctionContext ctx; /* user context for function */ 269 void *data; /* place for the backend to store any data */ 270 }; 271 272 struct CeedQFunctionContext_private { 273 Ceed ceed; 274 int ref_count; 275 int (*HasValidData)(CeedQFunctionContext, bool *); 276 int (*HasBorrowedDataOfType)(CeedQFunctionContext, CeedMemType, bool *); 277 int (*SetData)(CeedQFunctionContext, CeedMemType, CeedCopyMode, void *); 278 int (*TakeData)(CeedQFunctionContext, CeedMemType, void *); 279 int (*GetData)(CeedQFunctionContext, CeedMemType, void *); 280 int (*GetDataRead)(CeedQFunctionContext, CeedMemType, void *); 281 int (*RestoreData)(CeedQFunctionContext); 282 int (*RestoreDataRead)(CeedQFunctionContext); 283 int (*DataDestroy)(CeedQFunctionContext); 284 int (*Destroy)(CeedQFunctionContext); 285 CeedQFunctionContextDataDestroyUser data_destroy_function; 286 CeedMemType data_destroy_mem_type; 287 CeedInt num_fields; 288 CeedInt max_fields; 289 CeedContextFieldLabel *field_labels; 290 uint64_t state; 291 uint64_t num_readers; 292 size_t ctx_size; 293 void *data; 294 }; 295 296 /// Struct to handle the context data to use the Fortran QFunction stub 297 /// @ingroup CeedQFunction 298 struct CeedFortranContext_private { 299 CeedQFunctionContext inner_ctx; 300 void (*f)(void *ctx, int *nq, const CeedScalar *u, const CeedScalar *u1, const CeedScalar *u2, const CeedScalar *u3, const CeedScalar *u4, 301 const CeedScalar *u5, const CeedScalar *u6, const CeedScalar *u7, const CeedScalar *u8, const CeedScalar *u9, const CeedScalar *u10, 302 const CeedScalar *u11, const CeedScalar *u12, const CeedScalar *u13, const CeedScalar *u14, const CeedScalar *u15, CeedScalar *v, 303 CeedScalar *v1, CeedScalar *v2, CeedScalar *v3, CeedScalar *v4, CeedScalar *v5, CeedScalar *v6, CeedScalar *v7, CeedScalar *v8, 304 CeedScalar *v9, CeedScalar *v10, CeedScalar *v11, CeedScalar *v12, CeedScalar *v13, CeedScalar *v14, CeedScalar *v15, int *err); 305 }; 306 typedef struct CeedFortranContext_private *CeedFortranContext; 307 308 struct CeedContextFieldLabel_private { 309 const char *name; 310 const char *description; 311 CeedContextFieldType type; 312 size_t size; 313 size_t num_values; 314 size_t offset; 315 CeedInt num_sub_labels; 316 CeedContextFieldLabel *sub_labels; 317 bool from_op; 318 }; 319 320 struct CeedOperatorField_private { 321 CeedElemRestriction elem_rstr; /* Restriction from L-vector */ 322 CeedBasis basis; /* Basis or CEED_BASIS_NONE for collocated fields */ 323 CeedVector vec; /* State vector for passive fields or CEED_VECTOR_NONE for no vector */ 324 const char *field_name; /* matching QFunction field name */ 325 }; 326 327 struct CeedQFunctionAssemblyData_private { 328 Ceed ceed; 329 int ref_count; 330 bool is_setup; 331 bool reuse_data; 332 bool needs_data_update; 333 CeedVector vec; 334 CeedElemRestriction rstr; 335 }; 336 337 struct CeedOperatorAssemblyData_private { 338 Ceed ceed; 339 CeedInt num_active_bases_in, num_active_bases_out; 340 CeedBasis *active_bases_in, *active_bases_out; 341 CeedElemRestriction *active_elem_rstrs_in, *active_elem_rstrs_out; 342 CeedInt *num_eval_modes_in, *num_eval_modes_out; 343 CeedEvalMode **eval_modes_in, **eval_modes_out; 344 CeedScalar **assembled_bases_in, **assembled_bases_out; 345 CeedSize **eval_mode_offsets_in, **eval_mode_offsets_out, num_output_components; 346 }; 347 348 struct CeedOperator_private { 349 Ceed ceed; 350 CeedOperator op_fallback, op_fallback_parent; 351 int ref_count; 352 int (*LinearAssembleQFunction)(CeedOperator, CeedVector *, CeedElemRestriction *, CeedRequest *); 353 int (*LinearAssembleQFunctionUpdate)(CeedOperator, CeedVector, CeedElemRestriction, CeedRequest *); 354 int (*LinearAssembleDiagonal)(CeedOperator, CeedVector, CeedRequest *); 355 int (*LinearAssembleAddDiagonal)(CeedOperator, CeedVector, CeedRequest *); 356 int (*LinearAssemblePointBlockDiagonal)(CeedOperator, CeedVector, CeedRequest *); 357 int (*LinearAssembleAddPointBlockDiagonal)(CeedOperator, CeedVector, CeedRequest *); 358 int (*LinearAssembleSymbolic)(CeedOperator, CeedSize *, CeedInt **, CeedInt **); 359 int (*LinearAssemble)(CeedOperator, CeedVector); 360 int (*LinearAssembleSingle)(CeedOperator, CeedInt, CeedVector); 361 int (*CreateFDMElementInverse)(CeedOperator, CeedOperator *, CeedRequest *); 362 int (*Apply)(CeedOperator, CeedVector, CeedVector, CeedRequest *); 363 int (*ApplyComposite)(CeedOperator, CeedVector, CeedVector, CeedRequest *); 364 int (*ApplyAdd)(CeedOperator, CeedVector, CeedVector, CeedRequest *); 365 int (*ApplyAddComposite)(CeedOperator, CeedVector, CeedVector, CeedRequest *); 366 int (*ApplyJacobian)(CeedOperator, CeedVector, CeedVector, CeedVector, CeedVector, CeedRequest *); 367 int (*Destroy)(CeedOperator); 368 CeedOperatorField *input_fields; 369 CeedOperatorField *output_fields; 370 CeedSize input_size, output_size; 371 CeedInt num_tabs; /* Viewing offset */ 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 CeedQFunctionAssemblyData qf_assembled; 386 CeedOperatorAssemblyData op_assembled; 387 CeedOperator *sub_operators; 388 CeedInt num_suboperators; 389 void *data; 390 CeedInt num_context_labels; 391 CeedInt max_context_labels; 392 CeedContextFieldLabel *context_labels; 393 CeedElemRestriction rstr_points, first_points_rstr; 394 CeedVector point_coords; 395 }; 396