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 /// Denotes type of vector norm to be computed 178 /// @ingroup CeedVector 179 typedef enum { 180 /// L_1 norm: sum_i |x_i| 181 CEED_NORM_1, 182 /// L_2 norm: sqrt(sum_i |x_i|^2) 183 CEED_NORM_2, 184 /// L_Infinity norm: max_i |x_i| 185 CEED_NORM_MAX, 186 } CeedNormType; 187 188 CEED_EXTERN const char *const CeedCopyModes[]; 189 190 CEED_EXTERN int CeedVectorCreate(Ceed ceed, CeedInt len, CeedVector *vec); 191 CEED_EXTERN int CeedVectorSetArray(CeedVector vec, CeedMemType mtype, 192 CeedCopyMode cmode, CeedScalar *array); 193 CEED_EXTERN int CeedVectorSetValue(CeedVector vec, CeedScalar value); 194 CEED_EXTERN int CeedVectorSyncArray(CeedVector vec, CeedMemType mtype); 195 CEED_EXTERN int CeedVectorGetArray(CeedVector vec, CeedMemType mtype, 196 CeedScalar **array); 197 CEED_EXTERN int CeedVectorGetArrayRead(CeedVector vec, CeedMemType mtype, 198 const CeedScalar **array); 199 CEED_EXTERN int CeedVectorRestoreArray(CeedVector vec, CeedScalar **array); 200 CEED_EXTERN int CeedVectorRestoreArrayRead(CeedVector vec, 201 const CeedScalar **array); 202 CEED_EXTERN int CeedVectorNorm(CeedVector vec, CeedNormType type, 203 CeedScalar *norm); 204 CEED_EXTERN int CeedVectorView(CeedVector vec, const char *fpfmt, FILE *stream); 205 CEED_EXTERN int CeedVectorGetLength(CeedVector vec, CeedInt *length); 206 CEED_EXTERN int CeedVectorDestroy(CeedVector *vec); 207 208 CEED_EXTERN CeedRequest *const CEED_REQUEST_IMMEDIATE; 209 CEED_EXTERN CeedRequest *const CEED_REQUEST_ORDERED; 210 CEED_EXTERN int CeedRequestWait(CeedRequest *req); 211 212 /// Argument for CeedOperatorSetField that vector is collocated with 213 /// quadrature points, used with QFunction eval mode CEED_EVAL_NONE 214 /// or CEED_EVAL_INTERP only, not with CEED_EVAL_GRAD, CEED_EVAL_DIV, 215 /// or CEED_EVAL_CURL 216 /// @ingroup CeedBasis 217 CEED_EXTERN CeedBasis CEED_BASIS_COLLOCATED; 218 219 /// Argument for CeedOperatorSetField to use active input or output 220 /// @ingroup CeedVector 221 CEED_EXTERN CeedVector CEED_VECTOR_ACTIVE; 222 223 /// Argument for CeedOperatorSetField to use no vector, used with 224 /// qfunction input with eval mode CEED_EVAL_WEIGHTS 225 /// @ingroup CeedVector 226 CEED_EXTERN CeedVector CEED_VECTOR_NONE; 227 228 /// Argument for CeedOperatorCreate that QFunction is not created by user. 229 /// Only used for QFunctions dqf and dqfT. If implemented, a backend may 230 /// attempt to provide the action of these QFunctions. 231 /// @ingroup CeedQFunction 232 CEED_EXTERN CeedQFunction CEED_QFUNCTION_NONE; 233 234 /// Denotes whether a linear transformation or its transpose should be applied 235 /// @ingroup CeedBasis 236 typedef enum { 237 /// Apply the linear transformation 238 CEED_NOTRANSPOSE, 239 /// Apply the transpose 240 CEED_TRANSPOSE 241 } CeedTransposeMode; 242 243 CEED_EXTERN const char *const CeedTransposeModes[]; 244 245 CEED_EXTERN int CeedElemRestrictionCreate(Ceed ceed, CeedInt nelem, 246 CeedInt elemsize, CeedInt nnodes, CeedInt ncomp, CeedMemType mtype, 247 CeedCopyMode cmode, 248 const CeedInt *indices, CeedElemRestriction *rstr); 249 CEED_EXTERN int CeedElemRestrictionCreateIdentity(Ceed ceed, CeedInt nelem, 250 CeedInt elemsize, CeedInt nnodes, CeedInt ncomp, CeedElemRestriction *rstr); 251 CEED_EXTERN int CeedElemRestrictionCreateBlocked(Ceed ceed, CeedInt nelem, 252 CeedInt elemsize, CeedInt blksize, CeedInt nnodes, CeedInt ncomp, 253 CeedMemType mtype, 254 CeedCopyMode cmode, const CeedInt *indices, CeedElemRestriction *rstr); 255 CEED_EXTERN int CeedElemRestrictionCreateVector(CeedElemRestriction rstr, 256 CeedVector *lvec, CeedVector *evec); 257 CEED_EXTERN int CeedElemRestrictionApply(CeedElemRestriction rstr, 258 CeedTransposeMode tmode, CeedTransposeMode lmode, CeedVector u, 259 CeedVector ru, CeedRequest *request); 260 CEED_EXTERN int CeedElemRestrictionApplyBlock(CeedElemRestriction rstr, 261 CeedInt block, CeedTransposeMode tmode, CeedTransposeMode lmode, 262 CeedVector u, CeedVector ru, CeedRequest *request); 263 CEED_EXTERN int CeedElemRestrictionGetMultiplicity(CeedElemRestriction rstr, 264 CeedTransposeMode lmode, CeedVector mult); 265 CEED_EXTERN int CeedElemRestrictionView(CeedElemRestriction rstr, FILE *stream); 266 CEED_EXTERN int CeedElemRestrictionDestroy(CeedElemRestriction *rstr); 267 268 /// The formalism here is that we have the structure 269 /// \int_\Omega v^T f_0(u, \nabla u, qdata) + (\nabla v)^T f_1(u, \nabla u, qdata) 270 /// where gradients are with respect to the reference element. 271 272 /// Basis evaluation mode 273 /// 274 /// Modes can be bitwise ORed when passing to most functions. 275 /// @ingroup CeedBasis 276 typedef enum { 277 /// Perform no evaluation (either because there is no data or it is already at 278 /// quadrature points) 279 CEED_EVAL_NONE = 0, 280 /// Interpolate from nodes to quadrature points 281 CEED_EVAL_INTERP = 1, 282 /// Evaluate gradients at quadrature points from input in a nodal basis 283 CEED_EVAL_GRAD = 2, 284 /// Evaluate divergence at quadrature points from input in a nodal basis 285 CEED_EVAL_DIV = 4, 286 /// Evaluate curl at quadrature points from input in a nodal basis 287 CEED_EVAL_CURL = 8, 288 /// Using no input, evaluate quadrature weights on the reference element 289 CEED_EVAL_WEIGHT = 16, 290 } CeedEvalMode; 291 292 CEED_EXTERN const char *const CeedEvalModes[]; 293 294 /// Type of quadrature; also used for location of nodes 295 /// @ingroup CeedBasis 296 typedef enum { 297 /// Gauss-Legendre quadrature 298 CEED_GAUSS = 0, 299 /// Gauss-Legendre-Lobatto quadrature 300 CEED_GAUSS_LOBATTO = 1, 301 } CeedQuadMode; 302 303 CEED_EXTERN const char *const CeedQuadModes[]; 304 305 /// Type of basis shape to create non-tensor H1 element basis 306 /// 307 /// Dimension can be extracted with bitwise AND 308 /// (CeedElemTopology & 2**(dim + 2)) == TRUE 309 /// @ingroup CeedBasis 310 typedef enum { 311 /// Line 312 CEED_LINE = 1 << 16 | 0, 313 /// Triangle - 2D shape 314 CEED_TRIANGLE = 2 << 16 | 1, 315 /// Quadralateral - 2D shape 316 CEED_QUAD = 2 << 16 | 2, 317 /// Tetrahedron - 3D shape 318 CEED_TET = 3 << 16 | 3, 319 /// Pyramid - 3D shape 320 CEED_PYRAMID = 3 << 16 | 4, 321 /// Prism - 3D shape 322 CEED_PRISM = 3 << 16 | 5, 323 /// Hexehedron - 3D shape 324 CEED_HEX = 3 << 16 | 6, 325 } CeedElemTopology; 326 327 CEED_EXTERN const char *const CeedElemTopologies[]; 328 329 CEED_EXTERN int CeedBasisCreateTensorH1Lagrange(Ceed ceed, CeedInt dim, 330 CeedInt ncomp, CeedInt P, CeedInt Q, CeedQuadMode qmode, CeedBasis *basis); 331 CEED_EXTERN int CeedBasisCreateTensorH1(Ceed ceed, CeedInt dim, CeedInt ncomp, 332 CeedInt P1d, CeedInt Q1d, 333 const CeedScalar *interp1d, 334 const CeedScalar *grad1d, 335 const CeedScalar *qref1d, 336 const CeedScalar *qweight1d, 337 CeedBasis *basis); 338 CEED_EXTERN int CeedBasisCreateH1(Ceed ceed, CeedElemTopology topo, 339 CeedInt ncomp, 340 CeedInt nnodes, CeedInt nqpts, 341 const CeedScalar *interp, 342 const CeedScalar *grad, 343 const CeedScalar *qref, 344 const CeedScalar *qweight, CeedBasis *basis); 345 CEED_EXTERN int CeedBasisView(CeedBasis basis, FILE *stream); 346 CEED_EXTERN int CeedBasisGetNumNodes(CeedBasis basis, CeedInt *P); 347 CEED_EXTERN int CeedBasisGetNumQuadraturePoints(CeedBasis basis, CeedInt *Q); 348 CEED_EXTERN int CeedBasisApply(CeedBasis basis, CeedInt nelem, 349 CeedTransposeMode tmode, 350 CeedEvalMode emode, CeedVector u, CeedVector v); 351 CEED_EXTERN int CeedBasisDestroy(CeedBasis *basis); 352 353 CEED_EXTERN int CeedGaussQuadrature(CeedInt Q, CeedScalar *qref1d, 354 CeedScalar *qweight1d); 355 CEED_EXTERN int CeedLobattoQuadrature(CeedInt Q, CeedScalar *qref1d, 356 CeedScalar *qweight1d); 357 CEED_EXTERN int CeedQRFactorization(Ceed ceed, CeedScalar *mat, CeedScalar *tau, 358 CeedInt m, CeedInt n); 359 CEED_EXTERN int CeedSymmetricSchurDecomposition(Ceed ceed, CeedScalar *mat, 360 CeedScalar *lambda, CeedInt n); 361 CEED_EXTERN int CeedSimultaneousDiagonalization(Ceed ceed, CeedScalar *matA, 362 CeedScalar *matB, CeedScalar *x, CeedScalar *lambda, CeedInt n); 363 364 /** Handle for the object describing the user CeedQFunction 365 366 @param ctx user-defined context set using CeedQFunctionSetContext() or NULL 367 368 @param Q number of quadrature points at which to evaluate 369 370 @param in array of pointers to each input argument in the order provided 371 by the user in CeedQFunctionAddInput(). Each array has shape 372 `[dim, ncomp, Q]` where `dim` is the geometric dimension for 373 \ref CEED_EVAL_GRAD (`dim=1` for \ref CEED_EVAL_INTERP) and 374 `ncomp` is the number of field components (`ncomp=1` for 375 scalar fields). This results in indexing the `i`th input at 376 quadrature point `j` as `in[i][(d*ncomp + c)*Q + j]`. 377 378 @param out array of pointers to each output array in the order provided 379 using CeedQFunctionAddOutput(). The shapes are as above for 380 \a in. 381 382 @return An error code: 0 - success, otherwise - failure 383 384 @ingroup CeedQFunction 385 **/ 386 typedef int (*CeedQFunctionUser)(void *ctx, const CeedInt Q, 387 const CeedScalar *const *in, 388 CeedScalar *const *out); 389 390 CEED_EXTERN int CeedQFunctionCreateInterior(Ceed ceed, CeedInt vlength, 391 CeedQFunctionUser f, const char *source, CeedQFunction *qf); 392 CEED_EXTERN int CeedQFunctionCreateInteriorByName(Ceed ceed, const char *name, 393 CeedQFunction *qf); 394 CEED_EXTERN int CeedQFunctionCreateIdentity(Ceed ceed, CeedInt size, 395 CeedEvalMode inmode, CeedEvalMode outmode, CeedQFunction *qf); 396 CEED_EXTERN int CeedQFunctionAddInput(CeedQFunction qf, const char *fieldname, 397 CeedInt size, CeedEvalMode emode); 398 CEED_EXTERN int CeedQFunctionAddOutput(CeedQFunction qf, const char *fieldname, 399 CeedInt size, CeedEvalMode emode); 400 CEED_EXTERN int CeedQFunctionSetContext(CeedQFunction qf, void *ctx, 401 size_t ctxsize); 402 CEED_EXTERN int CeedQFunctionView(CeedQFunction qf, FILE *stream); 403 CEED_EXTERN int CeedQFunctionApply(CeedQFunction qf, CeedInt Q, 404 CeedVector *u, CeedVector *v); 405 CEED_EXTERN int CeedQFunctionDestroy(CeedQFunction *qf); 406 407 CEED_EXTERN int CeedOperatorCreate(Ceed ceed, CeedQFunction qf, 408 CeedQFunction dqf, CeedQFunction dqfT, 409 CeedOperator *op); 410 CEED_EXTERN int CeedCompositeOperatorCreate(Ceed ceed, CeedOperator *op); 411 CEED_EXTERN int CeedOperatorSetField(CeedOperator op, const char *fieldname, 412 CeedElemRestriction r, 413 CeedTransposeMode lmode, CeedBasis b, 414 CeedVector v); 415 CEED_EXTERN int CeedCompositeOperatorAddSub(CeedOperator compositeop, 416 CeedOperator subop); 417 CEED_EXTERN int CeedOperatorAssembleLinearQFunction(CeedOperator op, 418 CeedVector *assembled, CeedElemRestriction *rstr, CeedRequest *request); 419 CEED_EXTERN int CeedOperatorAssembleLinearDiagonal(CeedOperator op, 420 CeedVector *assembled, CeedRequest *request); 421 CEED_EXTERN int CeedOperatorView(CeedOperator op, FILE *stream); 422 CEED_EXTERN int CeedOperatorCreateFDMElementInverse(CeedOperator op, 423 CeedOperator *fdminv, CeedRequest *request); 424 CEED_EXTERN int CeedOperatorApply(CeedOperator op, CeedVector in, 425 CeedVector out, CeedRequest *request); 426 CEED_EXTERN int CeedOperatorApplyAdd(CeedOperator op, CeedVector in, 427 CeedVector out, CeedRequest *request); 428 CEED_EXTERN int CeedOperatorDestroy(CeedOperator *op); 429 430 /** 431 @brief Return integer power 432 433 @param[in] base The base to exponentiate 434 @param[in] power The power to raise the base to 435 436 @return base^power 437 438 @ref Utility 439 **/ 440 static inline CeedInt CeedIntPow(CeedInt base, CeedInt power) { 441 CeedInt result = 1; 442 while (power) { 443 if (power & 1) result *= base; 444 power >>= 1; 445 base *= base; 446 } 447 return result; 448 } 449 450 /** 451 @brief Return minimum of two integers 452 453 @param[in] a The first integer to compare 454 @param[in] b The second integer to compare 455 456 @return The minimum of the two integers 457 458 @ref Utility 459 **/ 460 static inline CeedInt CeedIntMin(CeedInt a, CeedInt b) { return a < b ? a : b; } 461 462 #endif 463