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 /// Public header for libCEED 19 #ifndef _ceed_h 20 #define _ceed_h 21 22 /// @defgroup Ceed Ceed: core components 23 /// @defgroup CeedVector CeedVector: storing and manipulating vectors 24 /// @defgroup CeedElemRestriction CeedElemRestriction: restriction from vectors to elements 25 /// @defgroup CeedBasis CeedBasis: fully discrete finite element-like objects 26 /// @defgroup CeedQFunction CeedQFunction: independent operations at quadrature points 27 /// @defgroup CeedOperator CeedOperator: composed FE-type operations on vectors 28 /// 29 /// @page FunctionCategories libCEED Function Categories 30 /// @section Utility Utility Functions 31 /// These functions are intended general utilities that may be useful to libCEED developers and users. 32 /// @section Basic User Functions 33 /// These functions are intended to be used by general users of the libCEED interface. 34 /// @section Advanced Backend Developer Functions 35 /// These functions are intended to be used by backend developers of the libCEED interface. 36 /// @section Developer Frontend Developer Functions 37 /// These functions are intended to be used by frontend developers of the libCEED interface. 38 39 /** 40 CEED_EXTERN is used in this header to denote all publicly visible symbols. 41 42 No other file should declare publicly visible symbols, thus it should never be 43 used outside ceed.h. 44 */ 45 #ifdef __cplusplus 46 # define CEED_EXTERN extern "C" 47 #else 48 # define CEED_EXTERN extern 49 #endif 50 51 #include <assert.h> 52 #include <stdint.h> 53 #include <stddef.h> 54 #include <stdarg.h> 55 #include <stdio.h> 56 57 // We can discuss ways to avoid forcing these to be compile-time decisions, but let's leave that for later. 58 /// Integer type, used for indexing 59 /// @ingroup Ceed 60 typedef int32_t CeedInt; 61 /// Scalar (floating point) type 62 /// @ingroup Ceed 63 typedef double CeedScalar; 64 65 /// Library context created by CeedInit() 66 /// @ingroup Ceed 67 typedef struct Ceed_private *Ceed; 68 /// Non-blocking Ceed interfaces return a CeedRequest. 69 /// To perform an operation immediately, pass \ref CEED_REQUEST_IMMEDIATE instead. 70 /// @ingroup Ceed 71 typedef struct CeedRequest_private *CeedRequest; 72 /// Handle for vectors over the field \ref CeedScalar 73 /// @ingroup CeedVector 74 typedef struct CeedVector_private *CeedVector; 75 /// Handle for object describing restriction to elements 76 /// @ingroup CeedElemRestriction 77 typedef struct CeedElemRestriction_private *CeedElemRestriction; 78 /// Handle for object describing discrete finite element evaluations 79 /// @ingroup CeedBasis 80 typedef struct CeedBasis_private *CeedBasis; 81 /// Handle for object describing functions evaluated independently at quadrature points 82 /// @ingroup CeedQFunction 83 typedef struct CeedQFunction_private *CeedQFunction; 84 /// Handle for object describing FE-type operators acting on vectors 85 /// 86 /// Given an element restriction \f$E\f$, basis evaluator \f$B\f$, and quadrature function 87 /// \f$f\f$, a CeedOperator expresses operations of the form 88 /// $$ E^T B^T f(B E u) $$ 89 /// acting on the vector \f$u\f$. 90 typedef struct CeedOperator_private *CeedOperator; 91 92 CEED_EXTERN int CeedRegister(const char *prefix, 93 int (*init)(const char *, Ceed), unsigned int priority); 94 95 CEED_EXTERN int CeedInit(const char *resource, Ceed *ceed); 96 CEED_EXTERN int CeedErrorReturn(Ceed, const char *, int, const char *, int, 97 const char *, va_list); 98 CEED_EXTERN int CeedErrorAbort(Ceed, const char *, int, const char *, int, 99 const char *, va_list); 100 CEED_EXTERN int CeedSetErrorHandler(Ceed ceed, 101 int (eh)(Ceed, const char *, int, const char *, 102 int, const char *, va_list)); 103 CEED_EXTERN int CeedErrorImpl(Ceed, const char *, int, const char *, int, 104 const char *, ...); 105 /// Raise an error on ceed object 106 /// 107 /// @param ceed Ceed library context or NULL 108 /// @param ecode Error code (int) 109 /// @param ... printf-style format string followed by arguments as needed 110 /// 111 /// @ingroup Ceed 112 /// @sa CeedSetErrorHandler() 113 #define CeedError(ceed, ecode, ...) \ 114 CeedErrorImpl((ceed), __FILE__, __LINE__, __func__, (ecode), __VA_ARGS__) 115 CEED_EXTERN int CeedDestroy(Ceed *ceed); 116 117 /// Specify memory type 118 /// 119 /// Many Ceed interfaces take or return pointers to memory. This enum is used to 120 /// specify where the memory being provided or requested must reside. 121 /// @ingroup Ceed 122 typedef enum { 123 /// Memory resides on the host 124 CEED_MEM_HOST, 125 /// Memory resides on a device (corresponding to \ref Ceed resource) 126 CEED_MEM_DEVICE, 127 } CeedMemType; 128 129 /// Conveys ownership status of arrays passed to Ceed interfaces. 130 /// @ingroup Ceed 131 typedef enum { 132 /// Implementation will copy the values and not store the passed pointer. 133 CEED_COPY_VALUES, 134 /// Implementation can use and modify the data provided by the user, but does 135 /// not take ownership. 136 CEED_USE_POINTER, 137 /// Implementation takes ownership of the pointer and will free using 138 /// CeedFree() when done using it. The user should not assume that the 139 /// pointer remains valid after ownership has been transferred. Note that 140 /// arrays allocated using C++ operator new or other allocators cannot 141 /// generally be freed using CeedFree(). CeedFree() is capable of freeing any 142 /// memory that can be freed using free(3). 143 CEED_OWN_POINTER, 144 } CeedCopyMode; 145 146 CEED_EXTERN int CeedVectorCreate(Ceed ceed, CeedInt len, CeedVector *vec); 147 CEED_EXTERN int CeedVectorSetArray(CeedVector vec, CeedMemType mtype, 148 CeedCopyMode cmode, CeedScalar *array); 149 CEED_EXTERN int CeedVectorSetValue(CeedVector vec, CeedScalar value); 150 CEED_EXTERN int CeedVectorGetArray(CeedVector vec, CeedMemType mtype, 151 CeedScalar **array); 152 CEED_EXTERN int CeedVectorGetArrayRead(CeedVector vec, CeedMemType mtype, 153 const CeedScalar **array); 154 CEED_EXTERN int CeedVectorRestoreArray(CeedVector vec, CeedScalar **array); 155 CEED_EXTERN int CeedVectorRestoreArrayRead(CeedVector vec, 156 const CeedScalar **array); 157 CEED_EXTERN int CeedVectorView(CeedVector vec, const char *fpfmt, FILE *stream); 158 CEED_EXTERN int CeedVectorGetLength(CeedVector vec, CeedInt *length); 159 CEED_EXTERN int CeedVectorDestroy(CeedVector *vec); 160 161 CEED_EXTERN CeedRequest *const CEED_REQUEST_IMMEDIATE; 162 CEED_EXTERN CeedRequest *const CEED_REQUEST_ORDERED; 163 CEED_EXTERN int CeedRequestWait(CeedRequest *req); 164 165 /// Argument for CeedOperatorSetField that vector is colocated with 166 /// quadrature points, used with qfunction eval mode CEED_EVAL_NONE 167 /// or CEED_EVAL_INTERP only, not with CEED_EVAL_GRAD, CEED_EVAL_DIV, 168 /// or CEED_EVAL_CURL 169 /// @ingroup CeedBasis 170 CEED_EXTERN CeedBasis CEED_BASIS_COLOCATED; 171 172 /// Argument for CeedOperatorSetField to use active input or output 173 /// @ingroup CeedVector 174 CEED_EXTERN CeedVector CEED_VECTOR_ACTIVE; 175 176 /// Argument for CeedOperatorSetField to use no vector, used with 177 /// qfunction input with eval mode CEED_EVAL_WEIGHTS 178 /// @ingroup CeedVector 179 CEED_EXTERN CeedVector CEED_VECTOR_NONE; 180 181 /// Denotes whether a linear transformation or its transpose should be applied 182 /// @ingroup CeedBasis 183 typedef enum { 184 /// Apply the linear transformation 185 CEED_NOTRANSPOSE, 186 /// Apply the transpose 187 CEED_TRANSPOSE 188 } CeedTransposeMode; 189 190 CEED_EXTERN int CeedElemRestrictionCreate(Ceed ceed, CeedInt nelem, 191 CeedInt elemsize, CeedInt ndof, CeedInt ncomp, CeedMemType mtype, CeedCopyMode cmode, 192 const CeedInt *indices, CeedElemRestriction *r); 193 CEED_EXTERN int CeedElemRestrictionCreateIdentity(Ceed ceed, CeedInt nelem, 194 CeedInt elemsize, CeedInt ndof, CeedInt ncomp, CeedElemRestriction *r); 195 CEED_EXTERN int CeedElemRestrictionCreateBlocked(Ceed ceed, CeedInt nelem, 196 CeedInt elemsize, CeedInt blksize, CeedInt ndof, CeedInt ncomp, CeedMemType mtype, 197 CeedCopyMode cmode, const CeedInt *indices, CeedElemRestriction *r); 198 CEED_EXTERN int CeedElemRestrictionCreateVector(CeedElemRestriction r, 199 CeedVector *lvec, 200 CeedVector *evec); 201 CEED_EXTERN int CeedElemRestrictionGetNumElements(CeedElemRestriction r, 202 CeedInt *numelements); 203 CEED_EXTERN int CeedElemRestrictionApply(CeedElemRestriction r, 204 CeedTransposeMode tmode, CeedTransposeMode lmode, CeedVector u, 205 CeedVector ru, CeedRequest *request); 206 CEED_EXTERN int CeedElemRestrictionDestroy(CeedElemRestriction *r); 207 208 // The formalism here is that we have the structure 209 // \int_\Omega v^T f_0(u, \nabla u, qdata) + (\nabla v)^T f_1(u, \nabla u, qdata) 210 // where gradients are with respect to the reference element. 211 212 /// Basis evaluation mode 213 /// 214 /// Modes can be bitwise ORed when passing to most functions. 215 /// @ingroup CeedBasis 216 typedef enum { 217 /// Perform no evaluation (either because there is no data or it is already at 218 /// quadrature points) 219 CEED_EVAL_NONE = 0, 220 /// Interpolate from nodes to quadrature points 221 CEED_EVAL_INTERP = 1, 222 /// Evaluate gradients at quadrature points from input in a nodal basis 223 CEED_EVAL_GRAD = 2, 224 /// Evaluate divergence at quadrature points from input in a nodal basis 225 CEED_EVAL_DIV = 4, 226 /// Evaluate curl at quadrature points from input in a nodal basis 227 CEED_EVAL_CURL = 8, 228 /// Using no input, evaluate quadrature weights on the reference element 229 CEED_EVAL_WEIGHT = 16, 230 } CeedEvalMode; 231 232 /// Type of quadrature; also used for location of nodes 233 /// @ingroup CeedBasis 234 typedef enum { 235 /// Gauss-Legendre quadrature 236 CEED_GAUSS = 0, 237 /// Gauss-Legendre-Lobatto quadrature 238 CEED_GAUSS_LOBATTO = 1, 239 } CeedQuadMode; 240 241 CEED_EXTERN int CeedBasisCreateTensorH1Lagrange(Ceed ceed, CeedInt dim, 242 CeedInt ndof, CeedInt P, CeedInt Q, CeedQuadMode qmode, CeedBasis *basis); 243 CEED_EXTERN int CeedBasisCreateTensorH1(Ceed ceed, CeedInt dim, CeedInt ndof, 244 CeedInt P1d, CeedInt Q1d, const CeedScalar *interp1d, const CeedScalar *grad1d, 245 const CeedScalar *qref1d, const CeedScalar *qweight1d, CeedBasis *basis); 246 CEED_EXTERN int CeedBasisView(CeedBasis basis, FILE *stream); 247 CEED_EXTERN int CeedQRFactorization(CeedScalar *mat, CeedScalar *tau, CeedInt m, CeedInt n); 248 CEED_EXTERN int CeedBasisGetColocatedGrad(CeedBasis basis, CeedScalar *colograd1d); 249 CEED_EXTERN int CeedBasisApply(CeedBasis basis, CeedInt nelem, CeedTransposeMode tmode, 250 CeedEvalMode emode, const CeedScalar *u, CeedScalar *v); 251 CEED_EXTERN int CeedBasisGetNumNodes(CeedBasis basis, CeedInt *P); 252 CEED_EXTERN int CeedBasisGetNumQuadraturePoints(CeedBasis basis, CeedInt *Q); 253 CEED_EXTERN int CeedBasisDestroy(CeedBasis *basis); 254 255 CEED_EXTERN int CeedGaussQuadrature(CeedInt Q, CeedScalar *qref1d, 256 CeedScalar *qweight1d); 257 CEED_EXTERN int CeedLobattoQuadrature(CeedInt Q, CeedScalar *qref1d, 258 CeedScalar *qweight1d); 259 260 CEED_EXTERN int CeedQFunctionCreateInterior(Ceed ceed, CeedInt vlength, 261 int (*f)(void *ctx, CeedInt nq, const CeedScalar *const *u, 262 CeedScalar *const *v), const char *focca, CeedQFunction *qf); 263 CEED_EXTERN int CeedQFunctionAddInput(CeedQFunction qf, const char *fieldname, 264 CeedInt ncomp, CeedEvalMode emode); 265 CEED_EXTERN int CeedQFunctionAddOutput(CeedQFunction qf, const char *fieldname, 266 CeedInt ncomp, CeedEvalMode emode); 267 CEED_EXTERN int CeedQFunctionGetNumArgs(CeedQFunction qf, CeedInt *numinput, 268 CeedInt *numoutput); 269 CEED_EXTERN int CeedQFunctionSetContext(CeedQFunction qf, void *ctx, 270 size_t ctxsize); 271 CEED_EXTERN int CeedQFunctionApply(CeedQFunction qf, CeedInt Q, 272 const CeedScalar *const *u, 273 CeedScalar *const *v); 274 CEED_EXTERN int CeedQFunctionDestroy(CeedQFunction *qf); 275 276 CEED_EXTERN int CeedOperatorCreate(Ceed ceed, CeedQFunction qf, 277 CeedQFunction dqf, CeedQFunction dqfT, 278 CeedOperator *op); 279 CEED_EXTERN int CeedOperatorSetField(CeedOperator op, const char *fieldname, 280 CeedElemRestriction r, CeedBasis b, 281 CeedVector v); 282 CEED_EXTERN int CeedOperatorApply(CeedOperator op, CeedVector in, 283 CeedVector out, CeedRequest *request); 284 CEED_EXTERN int CeedOperatorDestroy(CeedOperator *op); 285 286 static inline CeedInt CeedPowInt(CeedInt base, CeedInt power) { 287 CeedInt result = 1; 288 while (power) { 289 if (power & 1) result *= base; 290 power >>= 1; 291 base *= base; 292 } 293 return result; 294 } 295 296 #endif 297