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 /// Denotes whether a linear transformation or its transpose should be applied 207 /// @ingroup CeedBasis 208 typedef enum { 209 /// Apply the linear transformation 210 CEED_NOTRANSPOSE, 211 /// Apply the transpose 212 CEED_TRANSPOSE 213 } CeedTransposeMode; 214 215 CEED_EXTERN int CeedElemRestrictionCreate(Ceed ceed, CeedInt nelem, 216 CeedInt elemsize, CeedInt nnodes, CeedInt ncomp, CeedMemType mtype, 217 CeedCopyMode cmode, 218 const CeedInt *indices, CeedElemRestriction *rstr); 219 CEED_EXTERN int CeedElemRestrictionCreateIdentity(Ceed ceed, CeedInt nelem, 220 CeedInt elemsize, CeedInt nnodes, CeedInt ncomp, CeedElemRestriction *rstr); 221 CEED_EXTERN int CeedElemRestrictionCreateBlocked(Ceed ceed, CeedInt nelem, 222 CeedInt elemsize, CeedInt blksize, CeedInt nnodes, CeedInt ncomp, 223 CeedMemType mtype, 224 CeedCopyMode cmode, const CeedInt *indices, CeedElemRestriction *rstr); 225 CEED_EXTERN int CeedElemRestrictionCreateVector(CeedElemRestriction rstr, 226 CeedVector *lvec, CeedVector *evec); 227 CEED_EXTERN int CeedElemRestrictionApply(CeedElemRestriction rstr, 228 CeedTransposeMode tmode, CeedTransposeMode lmode, CeedVector u, 229 CeedVector ru, CeedRequest *request); 230 CEED_EXTERN int CeedElemRestrictionApplyBlock(CeedElemRestriction rstr, 231 CeedInt block, CeedTransposeMode tmode, CeedTransposeMode lmode, 232 CeedVector u, CeedVector ru, CeedRequest *request); 233 CEED_EXTERN int CeedElemRestrictionGetMultiplicity(CeedElemRestriction rstr, 234 CeedVector mult); 235 CEED_EXTERN int CeedElemRestrictionCreateVector(CeedElemRestriction rstr, 236 CeedVector *lvec, CeedVector *evec); 237 CEED_EXTERN int CeedElemRestrictionView(CeedElemRestriction rstr, FILE *stream); 238 CEED_EXTERN int CeedElemRestrictionDestroy(CeedElemRestriction *rstr); 239 240 // The formalism here is that we have the structure 241 // \int_\Omega v^T f_0(u, \nabla u, qdata) + (\nabla v)^T f_1(u, \nabla u, qdata) 242 // where gradients are with respect to the reference element. 243 244 /// Basis evaluation mode 245 /// 246 /// Modes can be bitwise ORed when passing to most functions. 247 /// @ingroup CeedBasis 248 typedef enum { 249 /// Perform no evaluation (either because there is no data or it is already at 250 /// quadrature points) 251 CEED_EVAL_NONE = 0, 252 /// Interpolate from nodes to quadrature points 253 CEED_EVAL_INTERP = 1, 254 /// Evaluate gradients at quadrature points from input in a nodal basis 255 CEED_EVAL_GRAD = 2, 256 /// Evaluate divergence at quadrature points from input in a nodal basis 257 CEED_EVAL_DIV = 4, 258 /// Evaluate curl at quadrature points from input in a nodal basis 259 CEED_EVAL_CURL = 8, 260 /// Using no input, evaluate quadrature weights on the reference element 261 CEED_EVAL_WEIGHT = 16, 262 } CeedEvalMode; 263 264 /// Type of quadrature; also used for location of nodes 265 /// @ingroup CeedBasis 266 typedef enum { 267 /// Gauss-Legendre quadrature 268 CEED_GAUSS = 0, 269 /// Gauss-Legendre-Lobatto quadrature 270 CEED_GAUSS_LOBATTO = 1, 271 } CeedQuadMode; 272 273 /// Type of basis shape to create non-tensor H1 element basis 274 /// 275 /// Dimension can be extracted with bitwise AND 276 /// (CeedElemTopology & 2**(dim + 2)) == TRUE 277 /// @ingroup CeedBasis 278 typedef enum { 279 /// Line 280 CEED_LINE = 1 << 16 | 0, 281 /// Triangle - 2D shape 282 CEED_TRIANGLE = 2 << 16 | 1, 283 /// Quadralateral - 2D shape 284 CEED_QUAD = 2 << 16 | 2, 285 /// Tetrahedron - 3D shape 286 CEED_TET = 3 << 16 | 3, 287 /// Pyramid - 3D shape 288 CEED_PYRAMID = 3 << 16 | 4, 289 /// Prism - 3D shape 290 CEED_PRISM = 3 << 16 | 5, 291 /// Hexehedron - 3D shape 292 CEED_HEX = 3 << 16 | 6, 293 } CeedElemTopology; 294 295 CEED_EXTERN int CeedBasisCreateTensorH1Lagrange(Ceed ceed, CeedInt dim, 296 CeedInt ncomp, CeedInt P, CeedInt Q, CeedQuadMode qmode, CeedBasis *basis); 297 CEED_EXTERN int CeedBasisCreateTensorH1(Ceed ceed, CeedInt dim, CeedInt ncomp, 298 CeedInt P1d, CeedInt Q1d, 299 const CeedScalar *interp1d, 300 const CeedScalar *grad1d, 301 const CeedScalar *qref1d, 302 const CeedScalar *qweight1d, 303 CeedBasis *basis); 304 CEED_EXTERN int CeedBasisCreateH1(Ceed ceed, CeedElemTopology topo, 305 CeedInt ncomp, 306 CeedInt nnodes, CeedInt nqpts, 307 const CeedScalar *interp, 308 const CeedScalar *grad, 309 const CeedScalar *qref, 310 const CeedScalar *qweight, CeedBasis *basis); 311 CEED_EXTERN int CeedBasisView(CeedBasis basis, FILE *stream); 312 CEED_EXTERN int CeedBasisGetNumNodes(CeedBasis basis, CeedInt *P); 313 CEED_EXTERN int CeedBasisGetNumQuadraturePoints(CeedBasis basis, CeedInt *Q); 314 CEED_EXTERN int CeedBasisApply(CeedBasis basis, CeedInt nelem, 315 CeedTransposeMode tmode, 316 CeedEvalMode emode, CeedVector u, CeedVector v); 317 CEED_EXTERN int CeedBasisDestroy(CeedBasis *basis); 318 319 CEED_EXTERN int CeedGaussQuadrature(CeedInt Q, CeedScalar *qref1d, 320 CeedScalar *qweight1d); 321 CEED_EXTERN int CeedLobattoQuadrature(CeedInt Q, CeedScalar *qref1d, 322 CeedScalar *qweight1d); 323 CEED_EXTERN int CeedQRFactorization(Ceed ceed, CeedScalar *mat, CeedScalar *tau, 324 CeedInt m, CeedInt n); 325 CEED_EXTERN int CeedSymmetricSchurDecomposition(Ceed ceed, CeedScalar *mat, 326 CeedScalar *lambda, CeedInt n); 327 CEED_EXTERN int CeedSimultaneousDiagonalization(Ceed ceed, CeedScalar *matA, 328 CeedScalar *matB, CeedScalar *x, CeedScalar *lambda, CeedInt n); 329 330 /// Handle for the object describing the user CeedQFunction 331 /// 332 /// @param ctx - user-defined context set using CeedQFunctionSetContext() or NULL 333 /// 334 /// @param Q - number of quadrature points at which to evaluate 335 /// 336 /// @param in - array of pointers to each input argument in the order provided 337 /// by the user in CeedQFunctionAddInput(). Each array has shape 338 /// `[dim, ncomp, Q]` where `dim` is the geometric dimension for 339 /// \ref CEED_EVAL_GRAD (`dim=1` for \ref CEED_EVAL_INTERP) and 340 /// `ncomp` is the number of field components (`ncomp=1` for 341 /// scalar fields). This results in indexing the `i`th input at 342 /// quadrature point `j` as `in[i][(d*ncomp + c)*Q + j]`. 343 /// 344 /// @param out - array of pointers to each output array in the order provided 345 /// using CeedQFunctionAddOutput(). The shapes are as above for 346 /// \a in. 347 /// 348 /// @return 0 on success, nonzero for failure. 349 /// 350 /// @ingroup CeedQFunction 351 typedef int (*CeedQFunctionUser)(void *ctx, const CeedInt Q, 352 const CeedScalar *const *in, 353 CeedScalar *const *out); 354 355 CEED_EXTERN int CeedQFunctionCreateInterior(Ceed ceed, CeedInt vlength, 356 CeedQFunctionUser f, const char *source, CeedQFunction *qf); 357 CEED_EXTERN int CeedQFunctionCreateInteriorByName(Ceed ceed, const char *name, 358 CeedQFunction *qf); 359 CEED_EXTERN int CeedQFunctionCreateIdentity(Ceed ceed, CeedInt size, 360 CeedQFunction *qf); 361 CEED_EXTERN int CeedQFunctionAddInput(CeedQFunction qf, const char *fieldname, 362 CeedInt size, CeedEvalMode emode); 363 CEED_EXTERN int CeedQFunctionAddOutput(CeedQFunction qf, const char *fieldname, 364 CeedInt size, CeedEvalMode emode); 365 CEED_EXTERN int CeedQFunctionSetContext(CeedQFunction qf, void *ctx, 366 size_t ctxsize); 367 CEED_EXTERN int CeedQFunctionApply(CeedQFunction qf, CeedInt Q, 368 CeedVector *u, CeedVector *v); 369 CEED_EXTERN int CeedQFunctionDestroy(CeedQFunction *qf); 370 371 CEED_EXTERN int CeedOperatorCreate(Ceed ceed, CeedQFunction qf, 372 CeedQFunction dqf, CeedQFunction dqfT, 373 CeedOperator *op); 374 CEED_EXTERN int CeedCompositeOperatorCreate(Ceed ceed, CeedOperator *op); 375 CEED_EXTERN int CeedOperatorSetField(CeedOperator op, const char *fieldname, 376 CeedElemRestriction r, 377 CeedTransposeMode lmode, CeedBasis b, 378 CeedVector v); 379 CEED_EXTERN int CeedCompositeOperatorAddSub(CeedOperator compositeop, 380 CeedOperator subop); 381 CEED_EXTERN int CeedOperatorAssembleLinearQFunction(CeedOperator op, 382 CeedVector *assembled, CeedElemRestriction *rstr, CeedRequest *request); 383 CEED_EXTERN int CeedOperatorAssembleLinearDiagonal(CeedOperator op, 384 CeedVector *assembled, CeedRequest *request); 385 CEED_EXTERN int CeedOperatorApply(CeedOperator op, CeedVector in, 386 CeedVector out, CeedRequest *request); 387 CEED_EXTERN int CeedOperatorDestroy(CeedOperator *op); 388 389 /** 390 @brief Return integer power 391 392 @param[in] base The base to exponentiate 393 @param[in] power The power to raise the base to 394 395 @return base^power 396 397 @ref Utility 398 **/ 399 static inline CeedInt CeedIntPow(CeedInt base, CeedInt power) { 400 CeedInt result = 1; 401 while (power) { 402 if (power & 1) result *= base; 403 power >>= 1; 404 base *= base; 405 } 406 return result; 407 } 408 409 /** 410 @brief Return minimum of two integers 411 412 @param[in] a The first integer to compare 413 @param[in] b The second integer to compare 414 415 @return The minimum of the two integers 416 417 @ref Utility 418 **/ 419 static inline CeedInt CeedIntMin(CeedInt a, CeedInt b) { return a < b ? a : b; } 420 421 #endif 422