1 // Copyright (c) 2017, Lawrence Livermore National Security, LLC. Produced at 2 // the Lawrence Livermore National Laboratory. LLNL-CODE-734707. All Rights 3 // reserved. See files LICENSE and NOTICE for details. 4 // 5 // This file is part of CEED, a collection of benchmarks, miniapps, software 6 // libraries and APIs for efficient high-order finite element and spectral 7 // element discretizations for exascale applications. For more information and 8 // source code availability see http://github.com/ceed. 9 // 10 // The CEED research is supported by the Exascale Computing Project 17-SC-20-SC, 11 // a collaborative effort of two U.S. Department of Energy organizations (Office 12 // of Science and the National Nuclear Security Administration) responsible for 13 // the planning and preparation of a capable exascale ecosystem, including 14 // software, applications, hardware, advanced system engineering and early 15 // testbed platforms, in support of the nation's exascale computing imperative. 16 17 /// @file 18 /// Private header for frontend components of libCEED 19 #ifndef _ceed_impl_h 20 #define _ceed_impl_h 21 22 #include <ceed.h> 23 #include <ceed-backend.h> 24 #include <stdbool.h> 25 26 /** @defgroup CeedUser Public API for Ceed 27 @ingroup Ceed 28 */ 29 /** @defgroup CeedBackend Backend API for Ceed 30 @ingroup Ceed 31 */ 32 /** @defgroup CeedDeveloper Internal library functions for Ceed 33 @ingroup Ceed 34 */ 35 /** @defgroup CeedVectorUser Public API for CeedVector 36 @ingroup CeedVector 37 */ 38 /** @defgroup CeedVectorBackend Backend API for CeedVector 39 @ingroup CeedVector 40 */ 41 /** @defgroup CeedVectorDeveloper Internal library functions for CeedVector 42 @ingroup CeedVector 43 */ 44 /** @defgroup CeedElemRestrictionUser Public API for CeedElemRestriction 45 @ingroup CeedElemRestriction 46 */ 47 /** @defgroup CeedElemRestrictionBackend Backend API for CeedElemRestriction 48 @ingroup CeedElemRestriction 49 */ 50 /** @defgroup CeedElemRestrictionDeveloper Internal library functions for CeedElemRestriction 51 @ingroup CeedElemRestriction 52 */ 53 /** @defgroup CeedBasisUser Public API for CeedBasis 54 @ingroup CeedBasis 55 */ 56 /** @defgroup CeedBasisBackend Backend API for CeedBasis 57 @ingroup CeedBasis 58 */ 59 /** @defgroup CeedBasisDeveloper Internal library functions for CeedBasis 60 @ingroup CeedBasis 61 */ 62 /** @defgroup CeedQFunctionUser Public API for CeedQFunction 63 @ingroup CeedQFunction 64 */ 65 /** @defgroup CeedQFunctionBackend Backend API for CeedQFunction 66 @ingroup CeedQFunction 67 */ 68 /** @defgroup CeedQFunctionDeveloper Internal library functions for CeedQFunction 69 @ingroup CeedQFunction 70 */ 71 /** @defgroup CeedOperatorUser Public API for CeedOperator 72 @ingroup CeedOperator 73 */ 74 /** @defgroup CeedOperatorBackend Backend API for CeedOperator 75 @ingroup CeedOperator 76 */ 77 /** @defgroup CeedOperatorDeveloper Internal library functions for CeedOperator 78 @ingroup CeedOperator 79 */ 80 81 // Lookup table field for backend functions 82 typedef struct { 83 const char *fname; 84 size_t offset; 85 } foffset; 86 87 // Lookup table field for object delegates 88 typedef struct { 89 char *objname; 90 Ceed delegate; 91 } objdelegate; 92 93 struct Ceed_private { 94 const char *resource; 95 Ceed delegate; 96 Ceed parent; 97 objdelegate *objdelegates; 98 int objdelegatecount; 99 Ceed opfallbackceed, opfallbackparent; 100 const char *opfallbackresource; 101 int (*Error)(Ceed, const char *, int, const char *, int, const char *, 102 va_list); 103 int (*GetPreferredMemType)(CeedMemType *); 104 int (*Destroy)(Ceed); 105 int (*VectorCreate)(CeedInt, CeedVector); 106 int (*ElemRestrictionCreate)(CeedMemType, CeedCopyMode, 107 const CeedInt *, CeedElemRestriction); 108 int (*ElemRestrictionCreateBlocked)(CeedMemType, CeedCopyMode, 109 const CeedInt *, CeedElemRestriction); 110 int (*BasisCreateTensorH1)(CeedInt, CeedInt, CeedInt, const CeedScalar *, 111 const CeedScalar *, const CeedScalar *, 112 const CeedScalar *, CeedBasis); 113 int (*BasisCreateH1)(CeedElemTopology, CeedInt, CeedInt, CeedInt, 114 const CeedScalar *, 115 const CeedScalar *, const CeedScalar *, 116 const CeedScalar *, CeedBasis); 117 int (*TensorContractCreate)(CeedBasis, CeedTensorContract); 118 int (*QFunctionCreate)(CeedQFunction); 119 int (*QFunctionContextCreate)(CeedQFunctionContext); 120 int (*OperatorCreate)(CeedOperator); 121 int (*CompositeOperatorCreate)(CeedOperator); 122 int refcount; 123 bool isDeterministic; 124 void *data; 125 bool debug; 126 char errmsg[CEED_MAX_RESOURCE_LEN]; 127 foffset *foffsets; 128 }; 129 130 struct CeedVector_private { 131 Ceed ceed; 132 int (*SetArray)(CeedVector, CeedMemType, CeedCopyMode, CeedScalar *); 133 int (*SetValue)(CeedVector, CeedScalar); 134 int (*SyncArray)(CeedVector, CeedMemType); 135 int (*TakeArray)(CeedVector, CeedMemType, CeedScalar **); 136 int (*GetArray)(CeedVector, CeedMemType, CeedScalar **); 137 int (*GetArrayRead)(CeedVector, CeedMemType, const CeedScalar **); 138 int (*RestoreArray)(CeedVector); 139 int (*RestoreArrayRead)(CeedVector); 140 int (*Norm)(CeedVector, CeedNormType, CeedScalar *); 141 int (*Reciprocal)(CeedVector); 142 int (*Destroy)(CeedVector); 143 int refcount; 144 CeedInt length; 145 uint64_t state; 146 uint64_t numreaders; 147 void *data; 148 }; 149 150 struct CeedElemRestriction_private { 151 Ceed ceed; 152 int (*Apply)(CeedElemRestriction, CeedTransposeMode, CeedVector, CeedVector, 153 CeedRequest *); 154 int (*ApplyBlock)(CeedElemRestriction, CeedInt, CeedTransposeMode, CeedVector, 155 CeedVector, CeedRequest *); 156 int (*GetOffsets)(CeedElemRestriction, CeedMemType, const CeedInt **); 157 int (*Destroy)(CeedElemRestriction); 158 int refcount; 159 CeedInt nelem; /* number of elements */ 160 CeedInt elemsize; /* number of nodes per element */ 161 CeedInt ncomp; /* number of components */ 162 CeedInt compstride; /* Component stride for L-vector ordering */ 163 CeedInt lsize; /* size of the L-vector, can be used for checking 164 for correct vector sizes */ 165 CeedInt blksize; /* number of elements in a batch */ 166 CeedInt nblk; /* number of blocks of elements */ 167 CeedInt *strides; /* strides between [nodes, components, elements] */ 168 CeedInt layout[3]; /* E-vector layout [nodes, components, elements] */ 169 uint64_t numreaders; /* number of instances of offset read only access */ 170 void *data; /* place for the backend to store any data */ 171 }; 172 173 struct CeedBasis_private { 174 Ceed ceed; 175 int (*Apply)(CeedBasis, CeedInt, CeedTransposeMode, CeedEvalMode, 176 CeedVector, CeedVector); 177 int (*Destroy)(CeedBasis); 178 int refcount; 179 bool tensorbasis; /* flag for tensor basis */ 180 CeedInt dim; /* topological dimension */ 181 CeedElemTopology topo; /* element topology */ 182 CeedInt ncomp; /* number of field components (1 for scalar fields) */ 183 CeedInt P1d; /* number of nodes in one dimension */ 184 CeedInt Q1d; /* number of quadrature points in one dimension */ 185 CeedInt P; /* total number of nodes */ 186 CeedInt Q; /* total number of quadrature points */ 187 CeedScalar *qref1d; /* Array of length Q1d holding the locations of 188 quadrature points on the 1D reference 189 element [-1, 1] */ 190 CeedScalar *qweight1d; /* array of length Q1d holding the quadrature weights on 191 the reference element */ 192 CeedScalar 193 *interp; /* row-major matrix of shape [Q, P] expressing the values of 194 nodal basis functions at quadrature points */ 195 CeedScalar 196 *interp1d; /* row-major matrix of shape [Q1d, P1d] expressing the values of 197 nodal basis functions at quadrature points */ 198 CeedScalar 199 *grad; /* row-major matrix of shape [dim*Q, P] matrix expressing 200 derivatives of nodal basis functions at quadrature points */ 201 CeedScalar 202 *grad1d; /* row-major matrix of shape [Q1d, P1d] matrix expressing 203 derivatives of nodal basis functions at quadrature points */ 204 CeedTensorContract contract; /* tensor contraction object */ 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, 211 const CeedScalar *restrict, CeedTransposeMode, const CeedInt, 212 const CeedScalar *restrict, CeedScalar *restrict); 213 int (*Destroy)(CeedTensorContract); 214 int refcount; 215 void *data; 216 }; 217 218 struct CeedQFunctionField_private { 219 const char *fieldname; 220 CeedInt size; 221 CeedEvalMode emode; 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 refcount; 231 CeedInt vlength; /* Number of quadrature points must be padded to a 232 multiple of vlength */ 233 CeedQFunctionField *inputfields; 234 CeedQFunctionField *outputfields; 235 CeedInt numinputfields, numoutputfields; 236 CeedQFunctionUser function; 237 const char *sourcepath; 238 const char *qfname; 239 bool identity; 240 bool fortranstatus; 241 CeedQFunctionContext ctx; /* user context for function */ 242 void *data; /* place for the backend to store any data */ 243 }; 244 245 struct CeedQFunctionContext_private { 246 Ceed ceed; 247 int refcount; 248 int (*SetData)(CeedQFunctionContext, CeedMemType, CeedCopyMode, void *); 249 int (*GetData)(CeedQFunctionContext, CeedMemType, void *); 250 int (*RestoreData)(CeedQFunctionContext); 251 int (*Destroy)(CeedQFunctionContext); 252 uint64_t state; 253 size_t ctxsize; 254 void *data; 255 }; 256 257 /// Struct to handle the context data to use the Fortran QFunction stub 258 /// @ingroup CeedQFunction 259 struct CeedFortranContext_private { 260 CeedQFunctionContext innerctx; 261 void (*f)(void *ctx, int *nq, 262 const CeedScalar *u,const CeedScalar *u1, 263 const CeedScalar *u2,const CeedScalar *u3, 264 const CeedScalar *u4,const CeedScalar *u5, 265 const CeedScalar *u6,const CeedScalar *u7, 266 const CeedScalar *u8,const CeedScalar *u9, 267 const CeedScalar *u10,const CeedScalar *u11, 268 const CeedScalar *u12,const CeedScalar *u13, 269 const CeedScalar *u14,const CeedScalar *u15, 270 CeedScalar *v,CeedScalar *v1,CeedScalar *v2, 271 CeedScalar *v3,CeedScalar *v4,CeedScalar *v5, 272 CeedScalar *v6,CeedScalar *v7,CeedScalar *v8, 273 CeedScalar *v9, CeedScalar *v10,CeedScalar *v11, 274 CeedScalar *v12,CeedScalar *v13,CeedScalar *v14, 275 CeedScalar *v15, int *err); 276 }; 277 typedef struct CeedFortranContext_private *CeedFortranContext; 278 279 struct CeedOperatorField_private { 280 CeedElemRestriction Erestrict; /* Restriction from L-vector */ 281 CeedBasis basis; /* Basis or CEED_BASIS_COLLOCATED for 282 collocated fields */ 283 CeedVector vec; /* State vector for passive fields or 284 CEED_VECTOR_NONE for no vector */ 285 const char *fieldname; /* matching QFunction field name */ 286 }; 287 288 struct CeedOperator_private { 289 Ceed ceed; 290 CeedOperator opfallback; 291 CeedQFunction qffallback; 292 int refcount; 293 int (*LinearAssembleQFunction)(CeedOperator, CeedVector *, 294 CeedElemRestriction *, CeedRequest *); 295 int (*LinearAssembleDiagonal)(CeedOperator, CeedVector, CeedRequest *); 296 int (*LinearAssembleAddDiagonal)(CeedOperator, CeedVector, CeedRequest *); 297 int (*LinearAssemblePointBlockDiagonal)(CeedOperator, CeedVector, 298 CeedRequest *); 299 int (*LinearAssembleAddPointBlockDiagonal)(CeedOperator, CeedVector, 300 CeedRequest *); 301 int (*CreateFDMElementInverse)(CeedOperator, CeedOperator *, CeedRequest *); 302 int (*Apply)(CeedOperator, CeedVector, CeedVector, CeedRequest *); 303 int (*ApplyComposite)(CeedOperator, CeedVector, CeedVector, CeedRequest *); 304 int (*ApplyAdd)(CeedOperator, CeedVector, CeedVector, CeedRequest *); 305 int (*ApplyAddComposite)(CeedOperator, CeedVector, CeedVector, CeedRequest *); 306 int (*ApplyJacobian)(CeedOperator, CeedVector, CeedVector, CeedVector, 307 CeedVector, CeedRequest *); 308 int (*Destroy)(CeedOperator); 309 CeedOperatorField *inputfields; 310 CeedOperatorField *outputfields; 311 CeedInt numelements; /// Number of elements 312 CeedInt numqpoints; /// Number of quadrature points over all elements 313 CeedInt nfields; /// Number of fields that have been set 314 CeedQFunction qf; 315 CeedQFunction dqf; 316 CeedQFunction dqfT; 317 bool setupdone; 318 bool composite; 319 bool hasrestriction; 320 CeedOperator *suboperators; 321 CeedInt numsub; 322 void *data; 323 }; 324 325 #endif 326