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 #define CEED_INTERN CEED_EXTERN __attribute__((visibility ("hidden"))) 27 28 #define CEED_MAX_RESOURCE_LEN 1024 29 #define CEED_ALIGN 64 30 31 #define CEED_NUM_BACKEND_FUNCTIONS 30 32 #define CEED_COMPOSITE_MAX 16 33 34 // Lookup table field for backend functions 35 typedef struct { 36 const char *fname; 37 size_t offset; 38 } foffset; 39 40 struct Ceed_private { 41 Ceed delegate; 42 Ceed parent; 43 int (*Error)(Ceed, const char *, int, const char *, int, const char *, 44 va_list); 45 int (*GetPreferredMemType)(CeedMemType *); 46 int (*Destroy)(Ceed); 47 int (*VecCreate)(CeedInt, CeedVector); 48 int (*ElemRestrictionCreate)(CeedMemType, CeedCopyMode, 49 const CeedInt *, CeedElemRestriction); 50 int (*ElemRestrictionCreateBlocked)(CeedMemType, CeedCopyMode, 51 const CeedInt *, CeedElemRestriction); 52 int (*BasisCreateTensorH1)(CeedInt, CeedInt, CeedInt, const CeedScalar *, 53 const CeedScalar *, const CeedScalar *, 54 const CeedScalar *, CeedBasis); 55 int (*BasisCreateH1)(CeedElemTopology, CeedInt, CeedInt, CeedInt, 56 const CeedScalar *, 57 const CeedScalar *, const CeedScalar *, 58 const CeedScalar *, CeedBasis); 59 int (*TensorContractCreate)(CeedBasis, CeedTensorContract); 60 int (*QFunctionCreate)(CeedQFunction); 61 int (*OperatorCreate)(CeedOperator); 62 int (*CompositeOperatorCreate)(CeedOperator); 63 int refcount; 64 void *data; 65 foffset foffsets[CEED_NUM_BACKEND_FUNCTIONS]; 66 }; 67 68 struct CeedVector_private { 69 Ceed ceed; 70 int (*SetArray)(CeedVector, CeedMemType, CeedCopyMode, CeedScalar *); 71 int (*SetValue)(CeedVector, CeedScalar); 72 int (*SyncArray)(CeedVector, CeedMemType); 73 int (*GetArray)(CeedVector, CeedMemType, CeedScalar **); 74 int (*GetArrayRead)(CeedVector, CeedMemType, const CeedScalar **); 75 int (*RestoreArray)(CeedVector); 76 int (*RestoreArrayRead)(CeedVector); 77 int (*Destroy)(CeedVector); 78 int refcount; 79 CeedInt length; 80 uint64_t state; 81 uint64_t numreaders; 82 void *data; 83 }; 84 85 struct CeedElemRestriction_private { 86 Ceed ceed; 87 int (*Apply)(CeedElemRestriction, CeedTransposeMode, CeedTransposeMode, 88 CeedVector, CeedVector, CeedRequest *); 89 int (*Destroy)(CeedElemRestriction); 90 int refcount; 91 CeedInt nelem; /* number of elements */ 92 CeedInt elemsize; /* number of dofs per element */ 93 CeedInt ndof; /* size of the L-vector, can be used for checking for 94 correct vector sizes */ 95 CeedInt ncomp; /* number of components */ 96 CeedInt blksize; /* number of elements in a batch */ 97 CeedInt nblk; /* number of blocks of elements */ 98 void *data; /* place for the backend to store any data */ 99 }; 100 101 struct CeedBasis_private { 102 Ceed ceed; 103 int (*Apply)(CeedBasis, CeedInt, CeedTransposeMode, CeedEvalMode, 104 CeedVector, CeedVector); 105 int (*Destroy)(CeedBasis); 106 int refcount; 107 bool tensorbasis; /* flag for tensor basis */ 108 CeedInt dim; /* topological dimension */ 109 CeedInt ncomp; /* number of field components (1 for scalar fields) */ 110 CeedInt P1d; /* number of nodes in one dimension */ 111 CeedInt Q1d; /* number of quadrature points in one dimension */ 112 CeedInt P; /* total number of nodes */ 113 CeedInt Q; /* total number of quadrature points */ 114 CeedScalar *qref1d; /* Array of length Q1d holding the locations of 115 quadrature points on the 1D reference element [-1, 1] */ 116 CeedScalar *qweight1d; /* array of length Q1d holding the quadrature weights on 117 the reference element */ 118 CeedScalar 119 *interp1d; /* row-major matrix of shape [Q1d, P1d] expressing the values of 120 nodal basis functions at quadrature points */ 121 CeedScalar 122 *grad1d; /* row-major matrix of shape [Q1d, P1d] matrix expressing derivatives of 123 nodal basis functions at quadrature points */ 124 CeedTensorContract contract; /* tensor contraction object */ 125 void *data; /* place for the backend to store any data */ 126 }; 127 128 struct CeedTensorContract_private { 129 Ceed ceed; 130 int (*Apply)(CeedTensorContract, CeedInt, CeedInt, CeedInt, CeedInt, 131 const CeedScalar *restrict, CeedTransposeMode, const CeedInt, 132 const CeedScalar *restrict, CeedScalar *restrict); 133 int (*Destroy)(CeedTensorContract); 134 int refcount; 135 void *data; 136 }; 137 138 struct CeedQFunctionField_private { 139 const char *fieldname; 140 CeedInt ncomp; 141 CeedEvalMode emode; 142 }; 143 144 struct CeedQFunction_private { 145 Ceed ceed; 146 int (*Apply)(CeedQFunction, CeedInt, CeedVector *, CeedVector *); 147 int (*Destroy)(CeedQFunction); 148 int refcount; 149 CeedInt vlength; // Number of quadrature points must be padded to a multiple of vlength 150 CeedQFunctionField *inputfields; 151 CeedQFunctionField *outputfields; 152 CeedInt numinputfields, numoutputfields; 153 CeedQFunctionUser function; 154 const char *focca; 155 bool fortranstatus; 156 void *ctx; /* user context for function */ 157 size_t ctxsize; /* size of user context; may be used to copy to a device */ 158 void *data; /* backend data */ 159 }; 160 161 /// Struct to handle the context data to use the Fortran QFunction stub 162 /// @ingroup CeedQFunction 163 typedef struct { 164 CeedScalar *innerctx; 165 size_t innerctxsize; 166 void (*f)(void *ctx, int *nq, 167 const CeedScalar *u,const CeedScalar *u1, 168 const CeedScalar *u2,const CeedScalar *u3, 169 const CeedScalar *u4,const CeedScalar *u5, 170 const CeedScalar *u6,const CeedScalar *u7, 171 const CeedScalar *u8,const CeedScalar *u9, 172 const CeedScalar *u10,const CeedScalar *u11, 173 const CeedScalar *u12,const CeedScalar *u13, 174 const CeedScalar *u14,const CeedScalar *u15, 175 CeedScalar *v,CeedScalar *v1,CeedScalar *v2, 176 CeedScalar *v3,CeedScalar *v4,CeedScalar *v5, 177 CeedScalar *v6,CeedScalar *v7,CeedScalar *v8, 178 CeedScalar *v9, CeedScalar *v10,CeedScalar *v11, 179 CeedScalar *v12,CeedScalar *v13,CeedScalar *v14, 180 CeedScalar *v15, int *err); 181 } fContext; 182 183 struct CeedOperatorField_private { 184 CeedElemRestriction Erestrict; /// Restriction from L-vector or NULL if identity 185 CeedTransposeMode lmode; /// Transpose mode for lvector ordering 186 CeedBasis basis; /// Basis or NULL for collocated fields 187 CeedVector 188 vec; /// State vector for passive fields, NULL for active fields 189 }; 190 191 struct CeedOperator_private { 192 Ceed ceed; 193 int refcount; 194 int (*Apply)(CeedOperator, CeedVector, CeedVector, CeedRequest *); 195 int (*ApplyJacobian)(CeedOperator, CeedVector, CeedVector, CeedVector, 196 CeedVector, CeedRequest *); 197 int (*Destroy)(CeedOperator); 198 CeedOperatorField *inputfields; 199 CeedOperatorField *outputfields; 200 CeedInt numelements; /// Number of elements 201 CeedInt numqpoints; /// Number of quadrature points over all elements 202 CeedInt nfields; /// Number of fields that have been set 203 CeedQFunction qf; 204 CeedQFunction dqf; 205 CeedQFunction dqfT; 206 bool setupdone; 207 bool composite; 208 CeedOperator *suboperators; 209 CeedInt numsub; 210 void *data; 211 }; 212 213 CEED_INTERN int CeedErrorReturn(Ceed, const char *, int, const char *, int, 214 const char *, va_list); 215 CEED_INTERN int CeedErrorAbort(Ceed, const char *, int, const char *, int, 216 const char *, va_list); 217 CEED_INTERN int CeedErrorExit(Ceed, const char *, int, const char *, int, 218 const char *, va_list); 219 CEED_INTERN int CeedSetErrorHandler(Ceed ceed, 220 int (eh)(Ceed, const char *, int, 221 const char *, int, const char *, 222 va_list)); 223 224 #endif 225