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