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 /// Handle for object describing CeedQFunction fields 117 /// @ingroup CeedQFunction 118 typedef struct CeedQFunctionField_private *CeedQFunctionField; 119 /// Handle for object describing CeedOperator fields 120 /// @ingroup CeedOperator 121 typedef struct CeedOperatorField_private *CeedOperatorField; 122 123 CEED_EXTERN int CeedInit(const char *resource, Ceed *ceed); 124 CEED_EXTERN int CeedDestroy(Ceed *ceed); 125 126 CEED_EXTERN int CeedErrorImpl(Ceed, const char *, int, const char *, int, 127 const char *, ...); 128 /// Raise an error on ceed object 129 /// 130 /// @param ceed Ceed library context or NULL 131 /// @param ecode Error code (int) 132 /// @param ... printf-style format string followed by arguments as needed 133 /// 134 /// @ingroup Ceed 135 /// @sa CeedSetErrorHandler() 136 #if defined(__clang__) 137 // Use nonstandard ternary to convince the compiler/clang-tidy that this 138 // function never returns zero. 139 # define CeedError(ceed, ecode, ...) \ 140 (CeedErrorImpl((ceed), __FILE__, __LINE__, __func__, (ecode), __VA_ARGS__) ?: (ecode)) 141 #else 142 # define CeedError(ceed, ecode, ...) \ 143 CeedErrorImpl((ceed), __FILE__, __LINE__, __func__, (ecode), __VA_ARGS__) ?: (ecode) 144 #endif 145 /// Specify memory type 146 /// 147 /// Many Ceed interfaces take or return pointers to memory. This enum is used to 148 /// specify where the memory being provided or requested must reside. 149 /// @ingroup Ceed 150 typedef enum { 151 /// Memory resides on the host 152 CEED_MEM_HOST, 153 /// Memory resides on a device (corresponding to \ref Ceed resource) 154 CEED_MEM_DEVICE, 155 } CeedMemType; 156 157 CEED_EXTERN int CeedGetPreferredMemType(Ceed ceed, CeedMemType *type); 158 159 /// Conveys ownership status of arrays passed to Ceed interfaces. 160 /// @ingroup Ceed 161 typedef enum { 162 /// Implementation will copy the values and not store the passed pointer. 163 CEED_COPY_VALUES, 164 /// Implementation can use and modify the data provided by the user, but does 165 /// not take ownership. 166 CEED_USE_POINTER, 167 /// Implementation takes ownership of the pointer and will free using 168 /// CeedFree() when done using it. The user should not assume that the 169 /// pointer remains valid after ownership has been transferred. Note that 170 /// arrays allocated using C++ operator new or other allocators cannot 171 /// generally be freed using CeedFree(). CeedFree() is capable of freeing any 172 /// memory that can be freed using free(3). 173 CEED_OWN_POINTER, 174 } CeedCopyMode; 175 176 CEED_EXTERN int CeedVectorCreate(Ceed ceed, CeedInt len, CeedVector *vec); 177 CEED_EXTERN int CeedVectorSetArray(CeedVector vec, CeedMemType mtype, 178 CeedCopyMode cmode, CeedScalar *array); 179 CEED_EXTERN int CeedVectorSetValue(CeedVector vec, CeedScalar value); 180 CEED_EXTERN int CeedVectorSyncArray(CeedVector vec, CeedMemType mtype); 181 CEED_EXTERN int CeedVectorGetArray(CeedVector vec, CeedMemType mtype, 182 CeedScalar **array); 183 CEED_EXTERN int CeedVectorGetArrayRead(CeedVector vec, CeedMemType mtype, 184 const CeedScalar **array); 185 CEED_EXTERN int CeedVectorRestoreArray(CeedVector vec, CeedScalar **array); 186 CEED_EXTERN int CeedVectorRestoreArrayRead(CeedVector vec, 187 const CeedScalar **array); 188 CEED_EXTERN int CeedVectorView(CeedVector vec, const char *fpfmt, FILE *stream); 189 CEED_EXTERN int CeedVectorGetLength(CeedVector vec, CeedInt *length); 190 CEED_EXTERN int CeedVectorDestroy(CeedVector *vec); 191 192 CEED_EXTERN CeedRequest *const CEED_REQUEST_IMMEDIATE; 193 CEED_EXTERN CeedRequest *const CEED_REQUEST_ORDERED; 194 CEED_EXTERN int CeedRequestWait(CeedRequest *req); 195 196 /// Argument for CeedOperatorSetField that vector is collocated with 197 /// quadrature points, used with QFunction eval mode CEED_EVAL_NONE 198 /// or CEED_EVAL_INTERP only, not with CEED_EVAL_GRAD, CEED_EVAL_DIV, 199 /// or CEED_EVAL_CURL 200 /// @ingroup CeedBasis 201 CEED_EXTERN CeedBasis CEED_BASIS_COLLOCATED; 202 203 /// Argument for CeedOperatorSetField to use active input or output 204 /// @ingroup CeedVector 205 CEED_EXTERN CeedVector CEED_VECTOR_ACTIVE; 206 207 /// Argument for CeedOperatorSetField to use no vector, used with 208 /// qfunction input with eval mode CEED_EVAL_WEIGHTS 209 /// @ingroup CeedVector 210 CEED_EXTERN CeedVector CEED_VECTOR_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, 335 CeedScalar *lambda, CeedInt n); 336 337 /// Handle for the object describing the user CeedQFunction 338 /// 339 /// @param ctx - user-defined context set using CeedQFunctionSetContext() or NULL 340 /// 341 /// @param Q - number of quadrature points at which to evaluate 342 /// 343 /// @param in - array of pointers to each input argument in the order provided 344 /// by the user in CeedQFunctionAddInput(). Each array has shape 345 /// `[dim, ncomp, Q]` where `dim` is the geometric dimension for 346 /// \ref CEED_EVAL_GRAD (`dim=1` for \ref CEED_EVAL_INTERP) and 347 /// `ncomp` is the number of field components (`ncomp=1` for 348 /// scalar fields). This results in indexing the `i`th input at 349 /// quadrature point `j` as `in[i][(d*ncomp + c)*Q + j]`. 350 /// 351 /// @param out - array of pointers to each output array in the order provided 352 /// using CeedQFunctionAddOutput(). The shapes are as above for 353 /// \a in. 354 /// 355 /// @return 0 on success, nonzero for failure. 356 /// 357 /// @ingroup CeedQFunction 358 typedef int (*CeedQFunctionUser)(void *ctx, const CeedInt Q, 359 const CeedScalar *const *in, 360 CeedScalar *const *out); 361 362 CEED_EXTERN int CeedQFunctionCreateInterior(Ceed ceed, CeedInt vlength, 363 CeedQFunctionUser f, const char *source, CeedQFunction *qf); 364 CEED_EXTERN int CeedQFunctionCreateInteriorByName(Ceed ceed, const char *name, 365 CeedQFunction *qf); 366 CEED_EXTERN int CeedQFunctionCreateIdentity(Ceed ceed, CeedInt size, 367 CeedQFunction *qf); 368 CEED_EXTERN int CeedQFunctionAddInput(CeedQFunction qf, const char *fieldname, 369 CeedInt size, CeedEvalMode emode); 370 CEED_EXTERN int CeedQFunctionAddOutput(CeedQFunction qf, const char *fieldname, 371 CeedInt size, CeedEvalMode emode); 372 CEED_EXTERN int CeedQFunctionSetContext(CeedQFunction qf, void *ctx, 373 size_t ctxsize); 374 CEED_EXTERN int CeedQFunctionApply(CeedQFunction qf, CeedInt Q, 375 CeedVector *u, CeedVector *v); 376 CEED_EXTERN int CeedQFunctionDestroy(CeedQFunction *qf); 377 378 CEED_EXTERN int CeedOperatorCreate(Ceed ceed, CeedQFunction qf, 379 CeedQFunction dqf, CeedQFunction dqfT, 380 CeedOperator *op); 381 CEED_EXTERN int CeedCompositeOperatorCreate(Ceed ceed, CeedOperator *op); 382 CEED_EXTERN int CeedOperatorSetField(CeedOperator op, const char *fieldname, 383 CeedElemRestriction r, 384 CeedTransposeMode lmode, CeedBasis b, 385 CeedVector v); 386 CEED_EXTERN int CeedCompositeOperatorAddSub(CeedOperator compositeop, 387 CeedOperator subop); 388 CEED_EXTERN int CeedOperatorAssembleLinearQFunction(CeedOperator op, 389 CeedVector *assembled, CeedElemRestriction *rstr, CeedRequest *request); 390 CEED_EXTERN int CeedOperatorApply(CeedOperator op, CeedVector in, 391 CeedVector out, CeedRequest *request); 392 CEED_EXTERN int CeedOperatorDestroy(CeedOperator *op); 393 394 /** 395 @brief Return integer power 396 397 @param[in] base The base to exponentiate 398 @param[in] power The power to raise the base to 399 400 @return base^power 401 402 @ref Utility 403 **/ 404 static inline CeedInt CeedIntPow(CeedInt base, CeedInt power) { 405 CeedInt result = 1; 406 while (power) { 407 if (power & 1) result *= base; 408 power >>= 1; 409 base *= base; 410 } 411 return result; 412 } 413 414 /** 415 @brief Return minimum of two integers 416 417 @param[in] a The first integer to compare 418 @param[in] b The second integer to compare 419 420 @return The minimum of the two integers 421 422 @ref Utility 423 **/ 424 static inline CeedInt CeedIntMin(CeedInt a, CeedInt b) { return a < b ? a : b; } 425 426 #endif 427