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