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