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