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/backend.h> 14 #include <ceed/ceed.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 (*GetPreferredMemType)(CeedMemType *); 98 int (*Destroy)(Ceed); 99 int (*VectorCreate)(CeedSize, CeedVector); 100 int (*ElemRestrictionCreate)(CeedMemType, CeedCopyMode, const CeedInt *, CeedElemRestriction); 101 int (*ElemRestrictionCreateOriented)(CeedMemType, CeedCopyMode, const CeedInt *, const bool *, CeedElemRestriction); 102 int (*ElemRestrictionCreateBlocked)(CeedMemType, CeedCopyMode, const CeedInt *, 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 (*TensorContractCreate)(CeedBasis, CeedTensorContract); 109 int (*QFunctionCreate)(CeedQFunction); 110 int (*QFunctionContextCreate)(CeedQFunctionContext); 111 int (*OperatorCreate)(CeedOperator); 112 int (*CompositeOperatorCreate)(CeedOperator); 113 int ref_count; 114 void *data; 115 bool is_debug; 116 bool has_valid_op_fallback_resource; 117 bool is_deterministic; 118 char err_msg[CEED_MAX_RESOURCE_LEN]; 119 FOffset *f_offsets; 120 }; 121 122 struct CeedVector_private { 123 Ceed ceed; 124 int (*HasValidArray)(CeedVector, bool *); 125 int (*HasBorrowedArrayOfType)(CeedVector, CeedMemType, bool *); 126 int (*SetArray)(CeedVector, CeedMemType, CeedCopyMode, CeedScalar *); 127 int (*SetValue)(CeedVector, CeedScalar); 128 int (*SyncArray)(CeedVector, CeedMemType); 129 int (*TakeArray)(CeedVector, CeedMemType, CeedScalar **); 130 int (*GetArray)(CeedVector, CeedMemType, CeedScalar **); 131 int (*GetArrayRead)(CeedVector, CeedMemType, const CeedScalar **); 132 int (*GetArrayWrite)(CeedVector, CeedMemType, CeedScalar **); 133 int (*RestoreArray)(CeedVector); 134 int (*RestoreArrayRead)(CeedVector); 135 int (*Norm)(CeedVector, CeedNormType, CeedScalar *); 136 int (*Scale)(CeedVector, CeedScalar); 137 int (*AXPY)(CeedVector, CeedScalar, CeedVector); 138 int (*PointwiseMult)(CeedVector, CeedVector, CeedVector); 139 int (*Reciprocal)(CeedVector); 140 int (*Destroy)(CeedVector); 141 int ref_count; 142 CeedSize length; 143 uint64_t state; 144 uint64_t num_readers; 145 void *data; 146 }; 147 148 struct CeedElemRestriction_private { 149 Ceed ceed; 150 int (*Apply)(CeedElemRestriction, CeedTransposeMode, CeedVector, CeedVector, CeedRequest *); 151 int (*ApplyBlock)(CeedElemRestriction, CeedInt, CeedTransposeMode, CeedVector, CeedVector, CeedRequest *); 152 int (*GetOffsets)(CeedElemRestriction, CeedMemType, const CeedInt **); 153 int (*Destroy)(CeedElemRestriction); 154 int ref_count; 155 CeedInt num_elem; /* number of elements */ 156 CeedInt elem_size; /* number of nodes per element */ 157 CeedInt num_comp; /* number of components */ 158 CeedInt comp_stride; /* Component stride for L-vector ordering */ 159 CeedSize l_size; /* size of the L-vector, can be used for checking for correct vector sizes */ 160 CeedInt blk_size; /* number of elements in a batch */ 161 CeedInt num_blk; /* number of blocks of elements */ 162 CeedInt *strides; /* strides between [nodes, components, elements] */ 163 CeedInt layout[3]; /* E-vector layout [nodes, components, elements] */ 164 uint64_t num_readers; /* number of instances of offset read only access */ 165 bool is_oriented; /* flag for oriented restriction */ 166 void *data; /* place for the backend to store any data */ 167 }; 168 169 struct CeedBasis_private { 170 Ceed ceed; 171 int (*Apply)(CeedBasis, CeedInt, CeedTransposeMode, CeedEvalMode, CeedVector, CeedVector); 172 int (*Destroy)(CeedBasis); 173 int ref_count; 174 bool tensor_basis; /* flag for tensor basis */ 175 CeedInt dim; /* topological dimension */ 176 CeedElemTopology topo; /* element topology */ 177 CeedInt num_comp; /* number of field components (1 for scalar fields) */ 178 CeedInt Q_comp; /* number of Q-vector components (1 for H^1, dim for H(div)) */ 179 CeedInt P_1d; /* number of nodes in one dimension */ 180 CeedInt Q_1d; /* number of quadrature points in one dimension */ 181 CeedInt P; /* total number of nodes */ 182 CeedInt Q; /* total number of quadrature points */ 183 CeedScalar *q_ref_1d; /* Array of length Q1d holding the locations of quadrature points on the 1D reference element [-1, 1] */ 184 CeedScalar *q_weight_1d; /* array of length Q1d holding the quadrature weights on the reference element */ 185 CeedScalar *interp; /* row-major matrix of shape [Q_comp*Q, P] expressing the values of nodal basis functions at quadrature points */ 186 CeedScalar *interp_1d; /* row-major matrix of shape [Q1d, P1d] expressing the values of nodal basis functions at quadrature points */ 187 CeedScalar *grad; /* row-major matrix of shape [dim*Q_comp*Q, P] matrix expressing derivatives of nodal basis functions at quadrature points */ 188 CeedScalar *grad_1d; /* row-major matrix of shape [Q1d, P1d] matrix expressing derivatives of nodal basis functions at quadrature points */ 189 CeedTensorContract contract; /* tensor contraction object */ 190 CeedFESpace basis_space; /* Initialize in basis constructor with 1,2 for H^1, H(div) FE space */ 191 CeedScalar 192 *div; /* row-major matrix of shape [Q, P] expressing the divergence of nodal basis functions at quadrature points for H(div) discretizations */ 193 void *data; /* place for the backend to store any data */ 194 }; 195 196 struct CeedTensorContract_private { 197 Ceed ceed; 198 int (*Apply)(CeedTensorContract, CeedInt, CeedInt, CeedInt, CeedInt, const CeedScalar *restrict, CeedTransposeMode, const CeedInt, 199 const CeedScalar *restrict, CeedScalar *restrict); 200 int (*Destroy)(CeedTensorContract); 201 int ref_count; 202 void *data; 203 }; 204 205 struct CeedQFunctionField_private { 206 const char *field_name; 207 CeedInt size; 208 CeedEvalMode eval_mode; 209 }; 210 211 struct CeedQFunction_private { 212 Ceed ceed; 213 int (*Apply)(CeedQFunction, CeedInt, CeedVector *, CeedVector *); 214 int (*SetCUDAUserFunction)(CeedQFunction, void *); 215 int (*SetHIPUserFunction)(CeedQFunction, void *); 216 int (*Destroy)(CeedQFunction); 217 int ref_count; 218 CeedInt vec_length; /* Number of quadrature points must be padded to a multiple of vec_length */ 219 CeedQFunctionField *input_fields; 220 CeedQFunctionField *output_fields; 221 CeedInt num_input_fields, num_output_fields; 222 CeedQFunctionUser function; 223 CeedInt user_flop_estimate; 224 const char *user_source; 225 const char *source_path; 226 const char *kernel_name; 227 const char *gallery_name; 228 bool is_gallery; 229 bool is_identity; 230 bool is_fortran; 231 bool is_immutable; 232 bool is_context_writable; 233 CeedQFunctionContext ctx; /* user context for function */ 234 void *data; /* place for the backend to store any data */ 235 }; 236 237 struct CeedQFunctionContext_private { 238 Ceed ceed; 239 int ref_count; 240 int (*HasValidData)(CeedQFunctionContext, bool *); 241 int (*HasBorrowedDataOfType)(CeedQFunctionContext, CeedMemType, bool *); 242 int (*SetData)(CeedQFunctionContext, CeedMemType, CeedCopyMode, void *); 243 int (*TakeData)(CeedQFunctionContext, CeedMemType, void *); 244 int (*GetData)(CeedQFunctionContext, CeedMemType, void *); 245 int (*GetDataRead)(CeedQFunctionContext, CeedMemType, void *); 246 int (*RestoreData)(CeedQFunctionContext); 247 int (*RestoreDataRead)(CeedQFunctionContext); 248 int (*DataDestroy)(CeedQFunctionContext); 249 int (*Destroy)(CeedQFunctionContext); 250 CeedQFunctionContextDataDestroyUser data_destroy_function; 251 CeedMemType data_destroy_mem_type; 252 CeedInt num_fields; 253 CeedInt max_fields; 254 CeedContextFieldLabel *field_labels; 255 uint64_t state; 256 uint64_t num_readers; 257 size_t ctx_size; 258 void *data; 259 }; 260 261 /// Struct to handle the context data to use the Fortran QFunction stub 262 /// @ingroup CeedQFunction 263 struct CeedFortranContext_private { 264 CeedQFunctionContext inner_ctx; 265 void (*f)(void *ctx, int *nq, const CeedScalar *u, const CeedScalar *u1, const CeedScalar *u2, const CeedScalar *u3, const CeedScalar *u4, 266 const CeedScalar *u5, const CeedScalar *u6, const CeedScalar *u7, const CeedScalar *u8, const CeedScalar *u9, const CeedScalar *u10, 267 const CeedScalar *u11, const CeedScalar *u12, const CeedScalar *u13, const CeedScalar *u14, const CeedScalar *u15, CeedScalar *v, 268 CeedScalar *v1, CeedScalar *v2, CeedScalar *v3, CeedScalar *v4, CeedScalar *v5, CeedScalar *v6, CeedScalar *v7, CeedScalar *v8, 269 CeedScalar *v9, CeedScalar *v10, CeedScalar *v11, CeedScalar *v12, CeedScalar *v13, CeedScalar *v14, CeedScalar *v15, int *err); 270 }; 271 typedef struct CeedFortranContext_private *CeedFortranContext; 272 273 struct CeedContextFieldLabel_private { 274 const char *name; 275 const char *description; 276 CeedContextFieldType type; 277 size_t size; 278 size_t num_values; 279 size_t offset; 280 CeedInt num_sub_labels; 281 CeedContextFieldLabel *sub_labels; 282 }; 283 284 struct CeedOperatorField_private { 285 CeedElemRestriction elem_restr; /* Restriction from L-vector */ 286 CeedBasis basis; /* Basis or CEED_BASIS_COLLOCATED for collocated fields */ 287 CeedVector vec; /* State vector for passive fields or CEED_VECTOR_NONE for no vector */ 288 const char *field_name; /* matching QFunction field name */ 289 }; 290 291 struct CeedQFunctionAssemblyData_private { 292 Ceed ceed; 293 int ref_count; 294 bool is_setup; 295 bool reuse_data; 296 bool needs_data_update; 297 CeedVector vec; 298 CeedElemRestriction rstr; 299 }; 300 301 struct CeedOperatorAssemblyData_private { 302 Ceed ceed; 303 CeedInt num_eval_mode_in, num_eval_mode_out; 304 CeedEvalMode *eval_mode_in, *eval_mode_out; 305 CeedScalar *B_in, *B_out; 306 CeedBasis basis_in, basis_out; 307 }; 308 309 struct CeedOperator_private { 310 Ceed ceed; 311 CeedOperator op_fallback; 312 int ref_count; 313 int (*LinearAssembleQFunction)(CeedOperator, CeedVector *, CeedElemRestriction *, CeedRequest *); 314 int (*LinearAssembleQFunctionUpdate)(CeedOperator, CeedVector, CeedElemRestriction, CeedRequest *); 315 int (*LinearAssembleDiagonal)(CeedOperator, CeedVector, CeedRequest *); 316 int (*LinearAssembleAddDiagonal)(CeedOperator, CeedVector, CeedRequest *); 317 int (*LinearAssemblePointBlockDiagonal)(CeedOperator, CeedVector, CeedRequest *); 318 int (*LinearAssembleAddPointBlockDiagonal)(CeedOperator, CeedVector, CeedRequest *); 319 int (*LinearAssembleSymbolic)(CeedOperator, CeedSize *, CeedInt **, CeedInt **); 320 int (*LinearAssemble)(CeedOperator, CeedVector); 321 int (*LinearAssembleSingle)(CeedOperator, CeedInt, CeedVector); 322 int (*CreateFDMElementInverse)(CeedOperator, CeedOperator *, CeedRequest *); 323 int (*Apply)(CeedOperator, CeedVector, CeedVector, CeedRequest *); 324 int (*ApplyComposite)(CeedOperator, CeedVector, CeedVector, CeedRequest *); 325 int (*ApplyAdd)(CeedOperator, CeedVector, CeedVector, CeedRequest *); 326 int (*ApplyAddComposite)(CeedOperator, CeedVector, CeedVector, CeedRequest *); 327 int (*ApplyJacobian)(CeedOperator, CeedVector, CeedVector, CeedVector, CeedVector, CeedRequest *); 328 int (*Destroy)(CeedOperator); 329 CeedOperatorField *input_fields; 330 CeedOperatorField *output_fields; 331 CeedSize input_size, output_size; 332 CeedInt num_elem; /* Number of elements */ 333 CeedInt num_qpts; /* Number of quadrature points over all elements */ 334 CeedInt num_fields; /* Number of fields that have been set */ 335 CeedQFunction qf; 336 CeedQFunction dqf; 337 CeedQFunction dqfT; 338 const char *name; 339 bool is_immutable; 340 bool is_interface_setup; 341 bool is_backend_setup; 342 bool is_composite; 343 bool has_restriction; 344 CeedQFunctionAssemblyData qf_assembled; 345 CeedOperatorAssemblyData op_assembled; 346 CeedOperator *sub_operators; 347 CeedInt num_suboperators; 348 void *data; 349 CeedInt num_context_labels; 350 CeedInt max_context_labels; 351 CeedContextFieldLabel *context_labels; 352 }; 353 354 CEED_INTERN int CeedOperatorGetFallback(CeedOperator op, CeedOperator *op_fallback); 355 356 #endif 357