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 user and utility components of 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: Types of Functions 30 /// libCEED provides three different header files depending upon the type of 31 /// functions a user requires. 32 /// @section Utility Utility Functions 33 /// These functions are intended general utilities that may be useful to 34 /// libCEED developers and users. These functions can generally be found in "ceed.h". 35 /// @section Basic User Functions 36 /// These functions are intended to be used by general users of the libCEED 37 /// interface. These functions can generally be found in "ceed.h". 38 /// @section Advanced Backend Developer Functions 39 /// These functions are intended to be used by backend developers of the 40 /// libCEED interface. These functions can generally be found in "ceed-backend.h". 41 /// @section Developer Frontend Developer Functions 42 /// These functions are intended to be used by frontend developers of the 43 /// libCEED interface. These functions can generally be found in "ceed-impl.h". 44 45 /** 46 CEED_EXTERN is used in this header to denote all publicly visible symbols. 47 48 No other file should declare publicly visible symbols, thus it should never be 49 used outside ceed.h. 50 */ 51 #ifdef __cplusplus 52 # define CEED_EXTERN extern "C" 53 #else 54 # define CEED_EXTERN extern 55 #endif 56 57 #ifndef CEED_QFUNCTION 58 #define CEED_QFUNCTION(name) \ 59 static const char name ## _loc[] = __FILE__ ":" #name; \ 60 static int name 61 #endif 62 63 #ifndef CeedPragmaSIMD 64 # if defined(__GNUC__) && __GNUC__ >= 5 65 # define CeedPragmaSIMD _Pragma("GCC ivdep") 66 # elif defined(_OPENMP) && _OPENMP >= 201307 // OpenMP-4.0 (July, 2013) 67 # define CeedPragmaSIMD _Pragma("omp simd") 68 # else 69 # define CeedPragmaSIMD 70 # endif 71 #endif 72 73 #include <assert.h> 74 #include <stdint.h> 75 #include <stddef.h> 76 #include <stdarg.h> 77 #include <stdio.h> 78 #include <stdbool.h> 79 80 // We can discuss ways to avoid forcing these to be compile-time decisions, but let's leave that for later. 81 /// Integer type, used for indexing 82 /// @ingroup Ceed 83 typedef int32_t CeedInt; 84 /// Scalar (floating point) type 85 /// @ingroup Ceed 86 typedef double CeedScalar; 87 88 /// Library context created by CeedInit() 89 /// @ingroup Ceed 90 typedef struct Ceed_private *Ceed; 91 /// Non-blocking Ceed interfaces return a CeedRequest. 92 /// To perform an operation immediately, pass \ref CEED_REQUEST_IMMEDIATE instead. 93 /// @ingroup Ceed 94 typedef struct CeedRequest_private *CeedRequest; 95 /// Handle for vectors over the field \ref CeedScalar 96 /// @ingroup CeedVector 97 typedef struct CeedVector_private *CeedVector; 98 /// Handle for object describing restriction to elements 99 /// @ingroup CeedElemRestriction 100 typedef struct CeedElemRestriction_private *CeedElemRestriction; 101 /// Handle for object describing discrete finite element evaluations 102 /// @ingroup CeedBasis 103 typedef struct CeedBasis_private *CeedBasis; 104 /// Handle for object describing functions evaluated independently at quadrature points 105 /// @ingroup CeedQFunction 106 typedef struct CeedQFunction_private *CeedQFunction; 107 /// Handle for object describing FE-type operators acting on vectors 108 /// 109 /// Given an element restriction \f$E\f$, basis evaluator \f$B\f$, and quadrature function 110 /// \f$f\f$, a CeedOperator expresses operations of the form 111 /// $$ E^T B^T f(B E u) $$ 112 /// acting on the vector \f$u\f$. 113 /// @ingroup CeedOperator 114 typedef struct CeedOperator_private *CeedOperator; 115 116 CEED_EXTERN int CeedInit(const char *resource, Ceed *ceed); 117 CEED_EXTERN int CeedGetResource(Ceed ceed, const char **resource); 118 CEED_EXTERN int CeedDestroy(Ceed *ceed); 119 120 CEED_EXTERN int CeedErrorImpl(Ceed, const char *, int, const char *, int, 121 const char *, ...); 122 /// Raise an error on ceed object 123 /// 124 /// @param ceed Ceed library context or NULL 125 /// @param ecode Error code (int) 126 /// @param ... printf-style format string followed by arguments as needed 127 /// 128 /// @ingroup Ceed 129 /// @sa CeedSetErrorHandler() 130 #if defined(__clang__) 131 // Use nonstandard ternary to convince the compiler/clang-tidy that this 132 // function never returns zero. 133 # define CeedError(ceed, ecode, ...) \ 134 (CeedErrorImpl((ceed), __FILE__, __LINE__, __func__, (ecode), __VA_ARGS__) ?: (ecode)) 135 #else 136 # define CeedError(ceed, ecode, ...) \ 137 CeedErrorImpl((ceed), __FILE__, __LINE__, __func__, (ecode), __VA_ARGS__) ?: (ecode) 138 #endif 139 /// Specify memory type 140 /// 141 /// Many Ceed interfaces take or return pointers to memory. This enum is used to 142 /// specify where the memory being provided or requested must reside. 143 /// @ingroup Ceed 144 typedef enum { 145 /// Memory resides on the host 146 CEED_MEM_HOST, 147 /// Memory resides on a device (corresponding to \ref Ceed resource) 148 CEED_MEM_DEVICE, 149 } CeedMemType; 150 151 CEED_EXTERN int CeedGetPreferredMemType(Ceed ceed, CeedMemType *type); 152 153 /// Conveys ownership status of arrays passed to Ceed interfaces. 154 /// @ingroup Ceed 155 typedef enum { 156 /// Implementation will copy the values and not store the passed pointer. 157 CEED_COPY_VALUES, 158 /// Implementation can use and modify the data provided by the user, but does 159 /// not take ownership. 160 CEED_USE_POINTER, 161 /// Implementation takes ownership of the pointer and will free using 162 /// CeedFree() when done using it. The user should not assume that the 163 /// pointer remains valid after ownership has been transferred. Note that 164 /// arrays allocated using C++ operator new or other allocators cannot 165 /// generally be freed using CeedFree(). CeedFree() is capable of freeing any 166 /// memory that can be freed using free(3). 167 CEED_OWN_POINTER, 168 } CeedCopyMode; 169 170 CEED_EXTERN int CeedVectorCreate(Ceed ceed, CeedInt len, CeedVector *vec); 171 CEED_EXTERN int CeedVectorSetArray(CeedVector vec, CeedMemType mtype, 172 CeedCopyMode cmode, CeedScalar *array); 173 CEED_EXTERN int CeedVectorSetValue(CeedVector vec, CeedScalar value); 174 CEED_EXTERN int CeedVectorSyncArray(CeedVector vec, CeedMemType mtype); 175 CEED_EXTERN int CeedVectorGetArray(CeedVector vec, CeedMemType mtype, 176 CeedScalar **array); 177 CEED_EXTERN int CeedVectorGetArrayRead(CeedVector vec, CeedMemType mtype, 178 const CeedScalar **array); 179 CEED_EXTERN int CeedVectorRestoreArray(CeedVector vec, CeedScalar **array); 180 CEED_EXTERN int CeedVectorRestoreArrayRead(CeedVector vec, 181 const CeedScalar **array); 182 CEED_EXTERN int CeedVectorView(CeedVector vec, const char *fpfmt, FILE *stream); 183 CEED_EXTERN int CeedVectorGetLength(CeedVector vec, CeedInt *length); 184 CEED_EXTERN int CeedVectorDestroy(CeedVector *vec); 185 186 CEED_EXTERN CeedRequest *const CEED_REQUEST_IMMEDIATE; 187 CEED_EXTERN CeedRequest *const CEED_REQUEST_ORDERED; 188 CEED_EXTERN int CeedRequestWait(CeedRequest *req); 189 190 /// Argument for CeedOperatorSetField that vector is collocated with 191 /// quadrature points, used with QFunction eval mode CEED_EVAL_NONE 192 /// or CEED_EVAL_INTERP only, not with CEED_EVAL_GRAD, CEED_EVAL_DIV, 193 /// or CEED_EVAL_CURL 194 /// @ingroup CeedBasis 195 CEED_EXTERN CeedBasis CEED_BASIS_COLLOCATED; 196 197 /// Argument for CeedOperatorSetField to use active input or output 198 /// @ingroup CeedVector 199 CEED_EXTERN CeedVector CEED_VECTOR_ACTIVE; 200 201 /// Argument for CeedOperatorSetField to use no vector, used with 202 /// qfunction input with eval mode CEED_EVAL_WEIGHTS 203 /// @ingroup CeedVector 204 CEED_EXTERN CeedVector CEED_VECTOR_NONE; 205 206 /// Argument for CeedOperatorCreate that QFunction is not created by user. 207 /// Only used for QFunctions dqf and dqfT. If implemented, a backend may 208 /// attempt to provide the action of these QFunctions. 209 /// @ingroup CeedQFunction 210 CEED_EXTERN CeedQFunction CEED_QFUNCTION_NONE; 211 212 /// Denotes whether a linear transformation or its transpose should be applied 213 /// @ingroup CeedBasis 214 typedef enum { 215 /// Apply the linear transformation 216 CEED_NOTRANSPOSE, 217 /// Apply the transpose 218 CEED_TRANSPOSE 219 } CeedTransposeMode; 220 221 CEED_EXTERN int CeedElemRestrictionCreate(Ceed ceed, CeedInt nelem, 222 CeedInt elemsize, CeedInt nnodes, CeedInt ncomp, CeedMemType mtype, 223 CeedCopyMode cmode, 224 const CeedInt *indices, CeedElemRestriction *rstr); 225 CEED_EXTERN int CeedElemRestrictionCreateIdentity(Ceed ceed, CeedInt nelem, 226 CeedInt elemsize, CeedInt nnodes, CeedInt ncomp, CeedElemRestriction *rstr); 227 CEED_EXTERN int CeedElemRestrictionCreateBlocked(Ceed ceed, CeedInt nelem, 228 CeedInt elemsize, CeedInt blksize, CeedInt nnodes, CeedInt ncomp, 229 CeedMemType mtype, 230 CeedCopyMode cmode, const CeedInt *indices, CeedElemRestriction *rstr); 231 CEED_EXTERN int CeedElemRestrictionCreateVector(CeedElemRestriction rstr, 232 CeedVector *lvec, CeedVector *evec); 233 CEED_EXTERN int CeedElemRestrictionApply(CeedElemRestriction rstr, 234 CeedTransposeMode tmode, CeedTransposeMode lmode, CeedVector u, 235 CeedVector ru, CeedRequest *request); 236 CEED_EXTERN int CeedElemRestrictionApplyBlock(CeedElemRestriction rstr, 237 CeedInt block, CeedTransposeMode tmode, CeedTransposeMode lmode, 238 CeedVector u, CeedVector ru, CeedRequest *request); 239 CEED_EXTERN int CeedElemRestrictionGetMultiplicity(CeedElemRestriction rstr, 240 CeedVector mult); 241 CEED_EXTERN int CeedElemRestrictionCreateVector(CeedElemRestriction rstr, 242 CeedVector *lvec, CeedVector *evec); 243 CEED_EXTERN int CeedElemRestrictionView(CeedElemRestriction rstr, FILE *stream); 244 CEED_EXTERN int CeedElemRestrictionDestroy(CeedElemRestriction *rstr); 245 246 // The formalism here is that we have the structure 247 // \int_\Omega v^T f_0(u, \nabla u, qdata) + (\nabla v)^T f_1(u, \nabla u, qdata) 248 // where gradients are with respect to the reference element. 249 250 /// Basis evaluation mode 251 /// 252 /// Modes can be bitwise ORed when passing to most functions. 253 /// @ingroup CeedBasis 254 typedef enum { 255 /// Perform no evaluation (either because there is no data or it is already at 256 /// quadrature points) 257 CEED_EVAL_NONE = 0, 258 /// Interpolate from nodes to quadrature points 259 CEED_EVAL_INTERP = 1, 260 /// Evaluate gradients at quadrature points from input in a nodal basis 261 CEED_EVAL_GRAD = 2, 262 /// Evaluate divergence at quadrature points from input in a nodal basis 263 CEED_EVAL_DIV = 4, 264 /// Evaluate curl at quadrature points from input in a nodal basis 265 CEED_EVAL_CURL = 8, 266 /// Using no input, evaluate quadrature weights on the reference element 267 CEED_EVAL_WEIGHT = 16, 268 } CeedEvalMode; 269 270 /// Type of quadrature; also used for location of nodes 271 /// @ingroup CeedBasis 272 typedef enum { 273 /// Gauss-Legendre quadrature 274 CEED_GAUSS = 0, 275 /// Gauss-Legendre-Lobatto quadrature 276 CEED_GAUSS_LOBATTO = 1, 277 } CeedQuadMode; 278 279 /// Type of basis shape to create non-tensor H1 element basis 280 /// 281 /// Dimension can be extracted with bitwise AND 282 /// (CeedElemTopology & 2**(dim + 2)) == TRUE 283 /// @ingroup CeedBasis 284 typedef enum { 285 /// Line 286 CEED_LINE = 1 << 16 | 0, 287 /// Triangle - 2D shape 288 CEED_TRIANGLE = 2 << 16 | 1, 289 /// Quadralateral - 2D shape 290 CEED_QUAD = 2 << 16 | 2, 291 /// Tetrahedron - 3D shape 292 CEED_TET = 3 << 16 | 3, 293 /// Pyramid - 3D shape 294 CEED_PYRAMID = 3 << 16 | 4, 295 /// Prism - 3D shape 296 CEED_PRISM = 3 << 16 | 5, 297 /// Hexehedron - 3D shape 298 CEED_HEX = 3 << 16 | 6, 299 } CeedElemTopology; 300 301 CEED_EXTERN int CeedBasisCreateTensorH1Lagrange(Ceed ceed, CeedInt dim, 302 CeedInt ncomp, CeedInt P, CeedInt Q, CeedQuadMode qmode, CeedBasis *basis); 303 CEED_EXTERN int CeedBasisCreateTensorH1(Ceed ceed, CeedInt dim, CeedInt ncomp, 304 CeedInt P1d, CeedInt Q1d, 305 const CeedScalar *interp1d, 306 const CeedScalar *grad1d, 307 const CeedScalar *qref1d, 308 const CeedScalar *qweight1d, 309 CeedBasis *basis); 310 CEED_EXTERN int CeedBasisCreateH1(Ceed ceed, CeedElemTopology topo, 311 CeedInt ncomp, 312 CeedInt nnodes, CeedInt nqpts, 313 const CeedScalar *interp, 314 const CeedScalar *grad, 315 const CeedScalar *qref, 316 const CeedScalar *qweight, CeedBasis *basis); 317 CEED_EXTERN int CeedBasisView(CeedBasis basis, FILE *stream); 318 CEED_EXTERN int CeedBasisGetNumNodes(CeedBasis basis, CeedInt *P); 319 CEED_EXTERN int CeedBasisGetNumQuadraturePoints(CeedBasis basis, CeedInt *Q); 320 CEED_EXTERN int CeedBasisApply(CeedBasis basis, CeedInt nelem, 321 CeedTransposeMode tmode, 322 CeedEvalMode emode, CeedVector u, CeedVector v); 323 CEED_EXTERN int CeedBasisDestroy(CeedBasis *basis); 324 325 CEED_EXTERN int CeedGaussQuadrature(CeedInt Q, CeedScalar *qref1d, 326 CeedScalar *qweight1d); 327 CEED_EXTERN int CeedLobattoQuadrature(CeedInt Q, CeedScalar *qref1d, 328 CeedScalar *qweight1d); 329 CEED_EXTERN int CeedQRFactorization(Ceed ceed, CeedScalar *mat, CeedScalar *tau, 330 CeedInt m, CeedInt n); 331 CEED_EXTERN int CeedSymmetricSchurDecomposition(Ceed ceed, CeedScalar *mat, 332 CeedScalar *lambda, CeedInt n); 333 CEED_EXTERN int CeedSimultaneousDiagonalization(Ceed ceed, CeedScalar *matA, 334 CeedScalar *matB, CeedScalar *x, CeedScalar *lambda, CeedInt n); 335 336 /// Handle for the object describing the user CeedQFunction 337 /// 338 /// @param ctx - user-defined context set using CeedQFunctionSetContext() or NULL 339 /// 340 /// @param Q - number of quadrature points at which to evaluate 341 /// 342 /// @param in - array of pointers to each input argument in the order provided 343 /// by the user in CeedQFunctionAddInput(). Each array has shape 344 /// `[dim, ncomp, Q]` where `dim` is the geometric dimension for 345 /// \ref CEED_EVAL_GRAD (`dim=1` for \ref CEED_EVAL_INTERP) and 346 /// `ncomp` is the number of field components (`ncomp=1` for 347 /// scalar fields). This results in indexing the `i`th input at 348 /// quadrature point `j` as `in[i][(d*ncomp + c)*Q + j]`. 349 /// 350 /// @param out - array of pointers to each output array in the order provided 351 /// using CeedQFunctionAddOutput(). The shapes are as above for 352 /// \a in. 353 /// 354 /// @return 0 on success, nonzero for failure. 355 /// 356 /// @ingroup CeedQFunction 357 typedef int (*CeedQFunctionUser)(void *ctx, const CeedInt Q, 358 const CeedScalar *const *in, 359 CeedScalar *const *out); 360 361 CEED_EXTERN int CeedQFunctionCreateInterior(Ceed ceed, CeedInt vlength, 362 CeedQFunctionUser f, const char *source, CeedQFunction *qf); 363 CEED_EXTERN int CeedQFunctionCreateInteriorByName(Ceed ceed, const char *name, 364 CeedQFunction *qf); 365 CEED_EXTERN int CeedQFunctionCreateIdentity(Ceed ceed, CeedInt size, 366 CeedEvalMode inmode, CeedEvalMode outmode, CeedQFunction *qf); 367 CEED_EXTERN int CeedQFunctionAddInput(CeedQFunction qf, const char *fieldname, 368 CeedInt size, CeedEvalMode emode); 369 CEED_EXTERN int CeedQFunctionAddOutput(CeedQFunction qf, const char *fieldname, 370 CeedInt size, CeedEvalMode emode); 371 CEED_EXTERN int CeedQFunctionSetContext(CeedQFunction qf, void *ctx, 372 size_t ctxsize); 373 CEED_EXTERN int CeedQFunctionApply(CeedQFunction qf, CeedInt Q, 374 CeedVector *u, CeedVector *v); 375 CEED_EXTERN int CeedQFunctionDestroy(CeedQFunction *qf); 376 377 CEED_EXTERN int CeedOperatorCreate(Ceed ceed, CeedQFunction qf, 378 CeedQFunction dqf, CeedQFunction dqfT, 379 CeedOperator *op); 380 CEED_EXTERN int CeedCompositeOperatorCreate(Ceed ceed, CeedOperator *op); 381 CEED_EXTERN int CeedOperatorSetField(CeedOperator op, const char *fieldname, 382 CeedElemRestriction r, 383 CeedTransposeMode lmode, CeedBasis b, 384 CeedVector v); 385 CEED_EXTERN int CeedCompositeOperatorAddSub(CeedOperator compositeop, 386 CeedOperator subop); 387 CEED_EXTERN int CeedOperatorAssembleLinearQFunction(CeedOperator op, 388 CeedVector *assembled, CeedElemRestriction *rstr, CeedRequest *request); 389 CEED_EXTERN int CeedOperatorAssembleLinearDiagonal(CeedOperator op, 390 CeedVector *assembled, CeedRequest *request); 391 CEED_EXTERN int CeedOperatorApply(CeedOperator op, CeedVector in, 392 CeedVector out, CeedRequest *request); 393 CEED_EXTERN int CeedOperatorDestroy(CeedOperator *op); 394 395 /** 396 @brief Return integer power 397 398 @param[in] base The base to exponentiate 399 @param[in] power The power to raise the base to 400 401 @return base^power 402 403 @ref Utility 404 **/ 405 static inline CeedInt CeedIntPow(CeedInt base, CeedInt power) { 406 CeedInt result = 1; 407 while (power) { 408 if (power & 1) result *= base; 409 power >>= 1; 410 base *= base; 411 } 412 return result; 413 } 414 415 /** 416 @brief Return minimum of two integers 417 418 @param[in] a The first integer to compare 419 @param[in] b The second integer to compare 420 421 @return The minimum of the two integers 422 423 @ref Utility 424 **/ 425 static inline CeedInt CeedIntMin(CeedInt a, CeedInt b) { return a < b ? a : b; } 426 427 #endif 428