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 CeedInt *, CeedElemRestriction); 102 int (*ElemRestrictionCreateBlocked)(CeedMemType, CeedCopyMode, const CeedInt *, const bool *, 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 (*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_signed; 154 int (*Apply)(CeedElemRestriction, CeedTransposeMode, CeedVector, CeedVector, CeedRequest *); 155 int (*ApplyUnsigned)(CeedElemRestriction, CeedTransposeMode, CeedVector, CeedVector, CeedRequest *); 156 int (*ApplyBlock)(CeedElemRestriction, CeedInt, CeedTransposeMode, CeedVector, CeedVector, CeedRequest *); 157 int (*GetOffsets)(CeedElemRestriction, CeedMemType, const CeedInt **); 158 int (*GetOrientations)(CeedElemRestriction, CeedMemType, const bool **); 159 int (*GetCurlOrientations)(CeedElemRestriction, CeedMemType, const CeedInt **); 160 int (*Destroy)(CeedElemRestriction); 161 int ref_count; 162 CeedInt num_elem; /* number of elements */ 163 CeedInt elem_size; /* number of nodes per element */ 164 CeedInt num_comp; /* number of components */ 165 CeedInt comp_stride; /* Component stride for L-vector ordering */ 166 CeedSize l_size; /* size of the L-vector, can be used for checking for correct vector sizes */ 167 CeedInt blk_size; /* number of elements in a batch */ 168 CeedInt num_blk; /* number of blocks of elements */ 169 CeedInt *strides; /* strides between [nodes, components, elements] */ 170 CeedInt layout[3]; /* E-vector layout [nodes, components, elements] */ 171 CeedRestrictionType 172 rstr_type; /* initialized in element restriction constructor for default, oriented, curl-oriented, or strided element restriction */ 173 uint64_t num_readers; /* number of instances of offset read only access */ 174 void *data; /* place for the backend to store any data */ 175 }; 176 177 struct CeedBasis_private { 178 Ceed ceed; 179 int (*Apply)(CeedBasis, CeedInt, CeedTransposeMode, CeedEvalMode, CeedVector, CeedVector); 180 int (*ApplyAtPoints)(CeedBasis, CeedInt, CeedTransposeMode, CeedEvalMode, CeedVector, CeedVector, CeedVector); 181 int (*Destroy)(CeedBasis); 182 int ref_count; 183 bool is_tensor_basis; /* flag for tensor basis */ 184 CeedInt dim; /* topological dimension */ 185 CeedElemTopology topo; /* element topology */ 186 CeedInt num_comp; /* number of field components (1 for scalar fields) */ 187 CeedInt P_1d; /* number of nodes in one dimension */ 188 CeedInt Q_1d; /* number of quadrature points in one dimension */ 189 CeedInt P; /* total number of nodes */ 190 CeedInt Q; /* total number of quadrature points */ 191 CeedFESpace fe_space; /* initialized in basis constructor with 1, 2, 3 for H^1, H(div), and H(curl) FE space */ 192 CeedTensorContract contract; /* tensor contraction object */ 193 CeedScalar *q_ref_1d; /* array of length Q1d holding the locations of quadrature points on the 1D reference element [-1, 1] */ 194 CeedScalar *q_weight_1d; /* array of length Q1d holding the quadrature weights on the reference element */ 195 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 196 quadrature points */ 197 CeedScalar *interp_1d; /* row-major matrix of shape [Q1d, P1d] expressing the values of nodal basis functions at quadrature points */ 198 CeedScalar *grad; /* row-major matrix of shape [dim * Q, P] matrix expressing derivatives of nodal basis functions at quadrature points */ 199 CeedScalar *grad_1d; /* row-major matrix of shape [Q1d, P1d] matrix expressing derivatives of nodal basis functions at quadrature points */ 200 CeedScalar *div; /* row-major matrix of shape [Q, P] expressing the divergence of basis functions at quadrature points for H(div) discretizations */ 201 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 202 quadrature points for H(curl) discretizations */ 203 CeedVector vec_chebyshev; 204 CeedBasis basis_chebyshev; /* basis interpolating from nodes to Chebyshev polynomial coefficients */ 205 void *data; /* place for the backend to store any data */ 206 }; 207 208 struct CeedTensorContract_private { 209 Ceed ceed; 210 int (*Apply)(CeedTensorContract, CeedInt, CeedInt, CeedInt, CeedInt, const CeedScalar *restrict, CeedTransposeMode, const CeedInt, 211 const CeedScalar *restrict, CeedScalar *restrict); 212 int (*Destroy)(CeedTensorContract); 213 int ref_count; 214 void *data; 215 }; 216 217 struct CeedQFunctionField_private { 218 const char *field_name; 219 CeedInt size; 220 CeedEvalMode eval_mode; 221 }; 222 223 struct CeedQFunction_private { 224 Ceed ceed; 225 int (*Apply)(CeedQFunction, CeedInt, CeedVector *, CeedVector *); 226 int (*SetCUDAUserFunction)(CeedQFunction, void *); 227 int (*SetHIPUserFunction)(CeedQFunction, void *); 228 int (*Destroy)(CeedQFunction); 229 int ref_count; 230 CeedInt vec_length; /* Number of quadrature points must be padded to a multiple of vec_length */ 231 CeedQFunctionField *input_fields; 232 CeedQFunctionField *output_fields; 233 CeedInt num_input_fields, num_output_fields; 234 CeedQFunctionUser function; 235 CeedInt user_flop_estimate; 236 const char *user_source; 237 const char *source_path; 238 const char *kernel_name; 239 const char *gallery_name; 240 bool is_gallery; 241 bool is_identity; 242 bool is_fortran; 243 bool is_immutable; 244 bool is_context_writable; 245 CeedQFunctionContext ctx; /* user context for function */ 246 void *data; /* place for the backend to store any data */ 247 }; 248 249 struct CeedQFunctionContext_private { 250 Ceed ceed; 251 int ref_count; 252 int (*HasValidData)(CeedQFunctionContext, bool *); 253 int (*HasBorrowedDataOfType)(CeedQFunctionContext, CeedMemType, bool *); 254 int (*SetData)(CeedQFunctionContext, CeedMemType, CeedCopyMode, void *); 255 int (*TakeData)(CeedQFunctionContext, CeedMemType, void *); 256 int (*GetData)(CeedQFunctionContext, CeedMemType, void *); 257 int (*GetDataRead)(CeedQFunctionContext, CeedMemType, void *); 258 int (*RestoreData)(CeedQFunctionContext); 259 int (*RestoreDataRead)(CeedQFunctionContext); 260 int (*DataDestroy)(CeedQFunctionContext); 261 int (*Destroy)(CeedQFunctionContext); 262 CeedQFunctionContextDataDestroyUser data_destroy_function; 263 CeedMemType data_destroy_mem_type; 264 CeedInt num_fields; 265 CeedInt max_fields; 266 CeedContextFieldLabel *field_labels; 267 uint64_t state; 268 uint64_t num_readers; 269 size_t ctx_size; 270 void *data; 271 }; 272 273 /// Struct to handle the context data to use the Fortran QFunction stub 274 /// @ingroup CeedQFunction 275 struct CeedFortranContext_private { 276 CeedQFunctionContext inner_ctx; 277 void (*f)(void *ctx, int *nq, const CeedScalar *u, const CeedScalar *u1, const CeedScalar *u2, const CeedScalar *u3, const CeedScalar *u4, 278 const CeedScalar *u5, const CeedScalar *u6, const CeedScalar *u7, const CeedScalar *u8, const CeedScalar *u9, const CeedScalar *u10, 279 const CeedScalar *u11, const CeedScalar *u12, const CeedScalar *u13, const CeedScalar *u14, const CeedScalar *u15, CeedScalar *v, 280 CeedScalar *v1, CeedScalar *v2, CeedScalar *v3, CeedScalar *v4, CeedScalar *v5, CeedScalar *v6, CeedScalar *v7, CeedScalar *v8, 281 CeedScalar *v9, CeedScalar *v10, CeedScalar *v11, CeedScalar *v12, CeedScalar *v13, CeedScalar *v14, CeedScalar *v15, int *err); 282 }; 283 typedef struct CeedFortranContext_private *CeedFortranContext; 284 285 struct CeedContextFieldLabel_private { 286 const char *name; 287 const char *description; 288 CeedContextFieldType type; 289 size_t size; 290 size_t num_values; 291 size_t offset; 292 CeedInt num_sub_labels; 293 CeedContextFieldLabel *sub_labels; 294 bool from_op; 295 }; 296 297 struct CeedOperatorField_private { 298 CeedElemRestriction elem_rstr; /* Restriction from L-vector */ 299 CeedBasis basis; /* Basis or CEED_BASIS_COLLOCATED for collocated fields */ 300 CeedVector vec; /* State vector for passive fields or CEED_VECTOR_NONE for no vector */ 301 const char *field_name; /* matching QFunction field name */ 302 }; 303 304 struct CeedQFunctionAssemblyData_private { 305 Ceed ceed; 306 int ref_count; 307 bool is_setup; 308 bool reuse_data; 309 bool needs_data_update; 310 CeedVector vec; 311 CeedElemRestriction rstr; 312 }; 313 314 struct CeedOperatorAssemblyData_private { 315 Ceed ceed; 316 CeedInt num_active_bases; 317 CeedBasis *active_bases; 318 CeedElemRestriction *active_elem_rstrs; 319 CeedInt *num_eval_modes_in, *num_eval_modes_out; 320 CeedEvalMode **eval_modes_in, **eval_modes_out; 321 CeedScalar **assembled_bases_in, **assembled_bases_out; 322 CeedSize **eval_mode_offsets_in, **eval_mode_offsets_out, num_output_components; 323 }; 324 325 struct CeedOperator_private { 326 Ceed ceed; 327 CeedOperator op_fallback, op_fallback_parent; 328 int ref_count; 329 int (*LinearAssembleQFunction)(CeedOperator, CeedVector *, CeedElemRestriction *, CeedRequest *); 330 int (*LinearAssembleQFunctionUpdate)(CeedOperator, CeedVector, CeedElemRestriction, CeedRequest *); 331 int (*LinearAssembleDiagonal)(CeedOperator, CeedVector, CeedRequest *); 332 int (*LinearAssembleAddDiagonal)(CeedOperator, CeedVector, CeedRequest *); 333 int (*LinearAssemblePointBlockDiagonal)(CeedOperator, CeedVector, CeedRequest *); 334 int (*LinearAssembleAddPointBlockDiagonal)(CeedOperator, CeedVector, CeedRequest *); 335 int (*LinearAssembleSymbolic)(CeedOperator, CeedSize *, CeedInt **, CeedInt **); 336 int (*LinearAssemble)(CeedOperator, CeedVector); 337 int (*LinearAssembleSingle)(CeedOperator, CeedInt, CeedVector); 338 int (*CreateFDMElementInverse)(CeedOperator, CeedOperator *, CeedRequest *); 339 int (*Apply)(CeedOperator, CeedVector, CeedVector, CeedRequest *); 340 int (*ApplyComposite)(CeedOperator, CeedVector, CeedVector, CeedRequest *); 341 int (*ApplyAdd)(CeedOperator, CeedVector, CeedVector, CeedRequest *); 342 int (*ApplyAddComposite)(CeedOperator, CeedVector, CeedVector, CeedRequest *); 343 int (*ApplyJacobian)(CeedOperator, CeedVector, CeedVector, CeedVector, CeedVector, CeedRequest *); 344 int (*Destroy)(CeedOperator); 345 CeedOperatorField *input_fields; 346 CeedOperatorField *output_fields; 347 CeedSize input_size, output_size; 348 CeedInt num_elem; /* Number of elements */ 349 CeedInt num_qpts; /* Number of quadrature points over all elements */ 350 CeedInt num_fields; /* Number of fields that have been set */ 351 CeedQFunction qf; 352 CeedQFunction dqf; 353 CeedQFunction dqfT; 354 const char *name; 355 bool is_immutable; 356 bool is_interface_setup; 357 bool is_backend_setup; 358 bool is_composite; 359 bool has_restriction; 360 CeedQFunctionAssemblyData qf_assembled; 361 CeedOperatorAssemblyData op_assembled; 362 CeedOperator *sub_operators; 363 CeedInt num_suboperators; 364 void *data; 365 CeedInt num_context_labels; 366 CeedInt max_context_labels; 367 CeedContextFieldLabel *context_labels; 368 }; 369 370 CEED_INTERN int CeedOperatorGetFallback(CeedOperator op, CeedOperator *op_fallback); 371 372 #endif 373