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