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 #include <stdbool.h> 57 58 // We can discuss ways to avoid forcing these to be compile-time decisions, but let's leave that for later. 59 /// Integer type, used for indexing 60 /// @ingroup Ceed 61 typedef int32_t CeedInt; 62 /// Scalar (floating point) type 63 /// @ingroup Ceed 64 typedef double CeedScalar; 65 66 /// Library context created by CeedInit() 67 /// @ingroup Ceed 68 typedef struct Ceed_private *Ceed; 69 /// Non-blocking Ceed interfaces return a CeedRequest. 70 /// To perform an operation immediately, pass \ref CEED_REQUEST_IMMEDIATE instead. 71 /// @ingroup Ceed 72 typedef struct CeedRequest_private *CeedRequest; 73 /// Handle for vectors over the field \ref CeedScalar 74 /// @ingroup CeedVector 75 typedef struct CeedVector_private *CeedVector; 76 /// Handle for object describing restriction to elements 77 /// @ingroup CeedElemRestriction 78 typedef struct CeedElemRestriction_private *CeedElemRestriction; 79 /// Handle for object describing discrete finite element evaluations 80 /// @ingroup CeedBasis 81 typedef struct CeedBasis_private *CeedBasis; 82 /// Handle for object describing functions evaluated independently at quadrature points 83 /// @ingroup CeedQFunction 84 typedef struct CeedQFunction_private *CeedQFunction; 85 /// Handle for object describing FE-type operators acting on vectors 86 /// 87 /// Given an element restriction \f$E\f$, basis evaluator \f$B\f$, and quadrature function 88 /// \f$f\f$, a CeedOperator expresses operations of the form 89 /// $$ E^T B^T f(B E u) $$ 90 /// acting on the vector \f$u\f$. 91 /// @ingroup CeedOperator 92 typedef struct CeedOperator_private *CeedOperator; 93 94 /// Handle for object describing CeedQFunction fields 95 /// @ingroup CeedQFunction 96 typedef struct CeedQFunctionField_private CeedQFunctionField; 97 /// Handle for object describing CeedOperator fields 98 /// @ingroup CeedOperator 99 typedef struct CeedOperatorField_private CeedOperatorField; 100 101 CEED_EXTERN int CeedInit(const char *resource, Ceed *ceed); 102 CEED_EXTERN int CeedDestroy(Ceed *ceed); 103 104 CEED_EXTERN int CeedErrorImpl(Ceed, const char *, int, const char *, int, 105 const char *, ...); 106 /// Raise an error on ceed object 107 /// 108 /// @param ceed Ceed library context or NULL 109 /// @param ecode Error code (int) 110 /// @param ... printf-style format string followed by arguments as needed 111 /// 112 /// @ingroup Ceed 113 /// @sa CeedSetErrorHandler() 114 #define CeedError(ceed, ecode, ...) \ 115 CeedErrorImpl((ceed), __FILE__, __LINE__, __func__, (ecode), __VA_ARGS__) 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 collocated 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_COLLOCATED; 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, 192 CeedCopyMode cmode, 193 const CeedInt *indices, CeedElemRestriction *rstr); 194 CEED_EXTERN int CeedElemRestrictionCreateIdentity(Ceed ceed, CeedInt nelem, 195 CeedInt elemsize, CeedInt ndof, CeedInt ncomp, CeedElemRestriction *rstr); 196 CEED_EXTERN int CeedElemRestrictionCreateBlocked(Ceed ceed, CeedInt nelem, 197 CeedInt elemsize, CeedInt blksize, CeedInt ndof, CeedInt ncomp, 198 CeedMemType mtype, 199 CeedCopyMode cmode, const CeedInt *indices, CeedElemRestriction *rstr); 200 CEED_EXTERN int CeedElemRestrictionApply(CeedElemRestriction rstr, 201 CeedTransposeMode tmode, CeedTransposeMode lmode, CeedVector u, 202 CeedVector ru, CeedRequest *request); 203 CEED_EXTERN int CeedElemRestrictionDestroy(CeedElemRestriction *rstr); 204 205 // The formalism here is that we have the structure 206 // \int_\Omega v^T f_0(u, \nabla u, qdata) + (\nabla v)^T f_1(u, \nabla u, qdata) 207 // where gradients are with respect to the reference element. 208 209 /// Basis evaluation mode 210 /// 211 /// Modes can be bitwise ORed when passing to most functions. 212 /// @ingroup CeedBasis 213 typedef enum { 214 /// Perform no evaluation (either because there is no data or it is already at 215 /// quadrature points) 216 CEED_EVAL_NONE = 0, 217 /// Interpolate from nodes to quadrature points 218 CEED_EVAL_INTERP = 1, 219 /// Evaluate gradients at quadrature points from input in a nodal basis 220 CEED_EVAL_GRAD = 2, 221 /// Evaluate divergence at quadrature points from input in a nodal basis 222 CEED_EVAL_DIV = 4, 223 /// Evaluate curl at quadrature points from input in a nodal basis 224 CEED_EVAL_CURL = 8, 225 /// Using no input, evaluate quadrature weights on the reference element 226 CEED_EVAL_WEIGHT = 16, 227 } CeedEvalMode; 228 229 /// Type of quadrature; also used for location of nodes 230 /// @ingroup CeedBasis 231 typedef enum { 232 /// Gauss-Legendre quadrature 233 CEED_GAUSS = 0, 234 /// Gauss-Legendre-Lobatto quadrature 235 CEED_GAUSS_LOBATTO = 1, 236 } CeedQuadMode; 237 238 /// Type of basis shape to create non-tensor H1 element basis 239 /// 240 /// Dimension can be extracted with bitwise AND 241 /// (CeedElemTopology & 2**(dim + 2)) == TRUE 242 /// @ingroup CeedBasis 243 typedef enum { 244 /// Line 245 CEED_LINE = 1 << 16 | 0, 246 /// Triangle - 2D shape 247 CEED_TRIANGLE = 2 << 16 | 1, 248 /// Quadralateral - 2D shape 249 CEED_QUAD = 2 << 16 | 2, 250 /// Tetrahedron - 3D shape 251 CEED_TET = 3 << 16 | 3, 252 /// Pyramid - 3D shape 253 CEED_PYRAMID = 3 << 16 | 4, 254 /// Prism - 3D shape 255 CEED_PRISM = 3 << 16 | 5, 256 /// Hexehedron - 3D shape 257 CEED_HEX = 3 << 16 | 6, 258 } CeedElemTopology; 259 260 CEED_EXTERN int CeedBasisCreateTensorH1Lagrange(Ceed ceed, CeedInt dim, 261 CeedInt ncomp, CeedInt P, CeedInt Q, CeedQuadMode qmode, CeedBasis *basis); 262 CEED_EXTERN int CeedBasisCreateTensorH1(Ceed ceed, CeedInt dim, CeedInt ncomp, 263 CeedInt P1d, CeedInt Q1d, const CeedScalar *interp1d, const CeedScalar *grad1d, 264 const CeedScalar *qref1d, const CeedScalar *qweight1d, CeedBasis *basis); 265 CEED_EXTERN int CeedBasisCreateH1(Ceed ceed, CeedElemTopology topo, 266 CeedInt ncomp, 267 CeedInt ndof, CeedInt nqpts, 268 const CeedScalar *interp, const CeedScalar *grad, 269 const CeedScalar *qref, const CeedScalar *qweight, CeedBasis *basis); 270 CEED_EXTERN int CeedBasisView(CeedBasis basis, FILE *stream); 271 CEED_EXTERN int CeedBasisGetNumNodes(CeedBasis basis, CeedInt *P); 272 CEED_EXTERN int CeedBasisGetNumQuadraturePoints(CeedBasis basis, CeedInt *Q); 273 CEED_EXTERN int CeedBasisApply(CeedBasis basis, CeedInt nelem, 274 CeedTransposeMode tmode, 275 CeedEvalMode emode, const CeedScalar *u, CeedScalar *v); 276 CEED_EXTERN int CeedBasisDestroy(CeedBasis *basis); 277 278 CEED_EXTERN int CeedGaussQuadrature(CeedInt Q, CeedScalar *qref1d, 279 CeedScalar *qweight1d); 280 CEED_EXTERN int CeedLobattoQuadrature(CeedInt Q, CeedScalar *qref1d, 281 CeedScalar *qweight1d); 282 CEED_EXTERN int CeedQRFactorization(CeedScalar *mat, CeedScalar *tau, CeedInt m, 283 CeedInt n); 284 285 CEED_EXTERN int CeedQFunctionCreateInterior(Ceed ceed, CeedInt vlength, 286 int (*f)(void *ctx, CeedInt nq, const CeedScalar *const *u, 287 CeedScalar *const *v), const char *focca, CeedQFunction *qf); 288 CEED_EXTERN int CeedQFunctionAddInput(CeedQFunction qf, const char *fieldname, 289 CeedInt ncomp, CeedEvalMode emode); 290 CEED_EXTERN int CeedQFunctionAddOutput(CeedQFunction qf, const char *fieldname, 291 CeedInt ncomp, CeedEvalMode emode); 292 CEED_EXTERN int CeedQFunctionSetContext(CeedQFunction qf, void *ctx, 293 size_t ctxsize); 294 CEED_EXTERN int CeedQFunctionApply(CeedQFunction qf, CeedInt Q, 295 const CeedScalar *const *u, 296 CeedScalar *const *v); 297 CEED_EXTERN int CeedQFunctionDestroy(CeedQFunction *qf); 298 299 CEED_EXTERN int CeedOperatorCreate(Ceed ceed, CeedQFunction qf, 300 CeedQFunction dqf, CeedQFunction dqfT, 301 CeedOperator *op); 302 CEED_EXTERN int CeedOperatorSetField(CeedOperator op, const char *fieldname, 303 CeedElemRestriction r, CeedBasis b, 304 CeedVector v); 305 CEED_EXTERN int CeedOperatorApply(CeedOperator op, CeedVector in, 306 CeedVector out, CeedRequest *request); 307 CEED_EXTERN int CeedOperatorDestroy(CeedOperator *op); 308 309 /** 310 @brief Return integer power 311 312 @param[in] base The base to exponentiate 313 @param[in] power The power to raise the base to 314 315 @return base^power 316 317 @ref Utility 318 **/ 319 static inline CeedInt CeedIntPow(CeedInt base, CeedInt power) { 320 CeedInt result = 1; 321 while (power) { 322 if (power & 1) result *= base; 323 power >>= 1; 324 base *= base; 325 } 326 return result; 327 } 328 329 /** 330 @brief Return mimimum of two integers 331 332 @param[in] a The first integer to compare 333 @param[in] b The second integer to compare 334 335 @return The minimum of the two integers 336 337 @ref Utility 338 **/ 339 static inline CeedInt CeedIntMin(CeedInt a, CeedInt b) { return a < b ? a : b; } 340 341 #endif 342