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 CEED_EXTERN int CeedGetPreferredMemType(Ceed ceed, CeedMemType *type); 137 138 /// Conveys ownership status of arrays passed to Ceed interfaces. 139 /// @ingroup Ceed 140 typedef enum { 141 /// Implementation will copy the values and not store the passed pointer. 142 CEED_COPY_VALUES, 143 /// Implementation can use and modify the data provided by the user, but does 144 /// not take ownership. 145 CEED_USE_POINTER, 146 /// Implementation takes ownership of the pointer and will free using 147 /// CeedFree() when done using it. The user should not assume that the 148 /// pointer remains valid after ownership has been transferred. Note that 149 /// arrays allocated using C++ operator new or other allocators cannot 150 /// generally be freed using CeedFree(). CeedFree() is capable of freeing any 151 /// memory that can be freed using free(3). 152 CEED_OWN_POINTER, 153 } CeedCopyMode; 154 155 CEED_EXTERN int CeedVectorCreate(Ceed ceed, CeedInt len, CeedVector *vec); 156 CEED_EXTERN int CeedVectorSetArray(CeedVector vec, CeedMemType mtype, 157 CeedCopyMode cmode, CeedScalar *array); 158 CEED_EXTERN int CeedVectorSetValue(CeedVector vec, CeedScalar value); 159 CEED_EXTERN int CeedVectorSyncArray(CeedVector vec, CeedMemType mtype); 160 CEED_EXTERN int CeedVectorGetArray(CeedVector vec, CeedMemType mtype, 161 CeedScalar **array); 162 CEED_EXTERN int CeedVectorGetArrayRead(CeedVector vec, CeedMemType mtype, 163 const CeedScalar **array); 164 CEED_EXTERN int CeedVectorRestoreArray(CeedVector vec, CeedScalar **array); 165 CEED_EXTERN int CeedVectorRestoreArrayRead(CeedVector vec, 166 const CeedScalar **array); 167 CEED_EXTERN int CeedVectorView(CeedVector vec, const char *fpfmt, FILE *stream); 168 CEED_EXTERN int CeedVectorGetLength(CeedVector vec, CeedInt *length); 169 CEED_EXTERN int CeedVectorDestroy(CeedVector *vec); 170 171 CEED_EXTERN CeedRequest *const CEED_REQUEST_IMMEDIATE; 172 CEED_EXTERN CeedRequest *const CEED_REQUEST_ORDERED; 173 CEED_EXTERN int CeedRequestWait(CeedRequest *req); 174 175 /// Argument for CeedOperatorSetField that vector is collocated with 176 /// quadrature points, used with qfunction eval mode CEED_EVAL_NONE 177 /// or CEED_EVAL_INTERP only, not with CEED_EVAL_GRAD, CEED_EVAL_DIV, 178 /// or CEED_EVAL_CURL 179 /// @ingroup CeedBasis 180 CEED_EXTERN CeedBasis CEED_BASIS_COLLOCATED; 181 182 /// Argument for CeedOperatorSetField to use active input or output 183 /// @ingroup CeedVector 184 CEED_EXTERN CeedVector CEED_VECTOR_ACTIVE; 185 186 /// Argument for CeedOperatorSetField to use no vector, used with 187 /// qfunction input with eval mode CEED_EVAL_WEIGHTS 188 /// @ingroup CeedVector 189 CEED_EXTERN CeedVector CEED_VECTOR_NONE; 190 191 /// Denotes whether a linear transformation or its transpose should be applied 192 /// @ingroup CeedBasis 193 typedef enum { 194 /// Apply the linear transformation 195 CEED_NOTRANSPOSE, 196 /// Apply the transpose 197 CEED_TRANSPOSE 198 } CeedTransposeMode; 199 200 CEED_EXTERN int CeedElemRestrictionCreate(Ceed ceed, CeedInt nelem, 201 CeedInt elemsize, CeedInt ndof, CeedInt ncomp, CeedMemType mtype, 202 CeedCopyMode cmode, 203 const CeedInt *indices, CeedElemRestriction *rstr); 204 CEED_EXTERN int CeedElemRestrictionCreateIdentity(Ceed ceed, CeedInt nelem, 205 CeedInt elemsize, CeedInt ndof, CeedInt ncomp, CeedElemRestriction *rstr); 206 CEED_EXTERN int CeedElemRestrictionCreateBlocked(Ceed ceed, CeedInt nelem, 207 CeedInt elemsize, CeedInt blksize, CeedInt ndof, CeedInt ncomp, 208 CeedMemType mtype, 209 CeedCopyMode cmode, const CeedInt *indices, CeedElemRestriction *rstr); 210 CEED_EXTERN int CeedElemRestrictionApply(CeedElemRestriction rstr, 211 CeedTransposeMode tmode, CeedTransposeMode lmode, CeedVector u, 212 CeedVector ru, CeedRequest *request); 213 CEED_EXTERN int CeedElemRestrictionDestroy(CeedElemRestriction *rstr); 214 215 // The formalism here is that we have the structure 216 // \int_\Omega v^T f_0(u, \nabla u, qdata) + (\nabla v)^T f_1(u, \nabla u, qdata) 217 // where gradients are with respect to the reference element. 218 219 /// Basis evaluation mode 220 /// 221 /// Modes can be bitwise ORed when passing to most functions. 222 /// @ingroup CeedBasis 223 typedef enum { 224 /// Perform no evaluation (either because there is no data or it is already at 225 /// quadrature points) 226 CEED_EVAL_NONE = 0, 227 /// Interpolate from nodes to quadrature points 228 CEED_EVAL_INTERP = 1, 229 /// Evaluate gradients at quadrature points from input in a nodal basis 230 CEED_EVAL_GRAD = 2, 231 /// Evaluate divergence at quadrature points from input in a nodal basis 232 CEED_EVAL_DIV = 4, 233 /// Evaluate curl at quadrature points from input in a nodal basis 234 CEED_EVAL_CURL = 8, 235 /// Using no input, evaluate quadrature weights on the reference element 236 CEED_EVAL_WEIGHT = 16, 237 } CeedEvalMode; 238 239 /// Type of quadrature; also used for location of nodes 240 /// @ingroup CeedBasis 241 typedef enum { 242 /// Gauss-Legendre quadrature 243 CEED_GAUSS = 0, 244 /// Gauss-Legendre-Lobatto quadrature 245 CEED_GAUSS_LOBATTO = 1, 246 } CeedQuadMode; 247 248 /// Type of basis shape to create non-tensor H1 element basis 249 /// 250 /// Dimension can be extracted with bitwise AND 251 /// (CeedElemTopology & 2**(dim + 2)) == TRUE 252 /// @ingroup CeedBasis 253 typedef enum { 254 /// Line 255 CEED_LINE = 1 << 16 | 0, 256 /// Triangle - 2D shape 257 CEED_TRIANGLE = 2 << 16 | 1, 258 /// Quadralateral - 2D shape 259 CEED_QUAD = 2 << 16 | 2, 260 /// Tetrahedron - 3D shape 261 CEED_TET = 3 << 16 | 3, 262 /// Pyramid - 3D shape 263 CEED_PYRAMID = 3 << 16 | 4, 264 /// Prism - 3D shape 265 CEED_PRISM = 3 << 16 | 5, 266 /// Hexehedron - 3D shape 267 CEED_HEX = 3 << 16 | 6, 268 } CeedElemTopology; 269 270 CEED_EXTERN int CeedBasisCreateTensorH1Lagrange(Ceed ceed, CeedInt dim, 271 CeedInt ncomp, CeedInt P, CeedInt Q, CeedQuadMode qmode, CeedBasis *basis); 272 CEED_EXTERN int CeedBasisCreateTensorH1(Ceed ceed, CeedInt dim, CeedInt ncomp, 273 CeedInt P1d, CeedInt Q1d, const CeedScalar *interp1d, const CeedScalar *grad1d, 274 const CeedScalar *qref1d, const CeedScalar *qweight1d, CeedBasis *basis); 275 CEED_EXTERN int CeedBasisCreateH1(Ceed ceed, CeedElemTopology topo, 276 CeedInt ncomp, 277 CeedInt ndof, CeedInt nqpts, 278 const CeedScalar *interp, const CeedScalar *grad, 279 const CeedScalar *qref, const CeedScalar *qweight, CeedBasis *basis); 280 CEED_EXTERN int CeedBasisView(CeedBasis basis, FILE *stream); 281 CEED_EXTERN int CeedBasisGetNumNodes(CeedBasis basis, CeedInt *P); 282 CEED_EXTERN int CeedBasisGetNumQuadraturePoints(CeedBasis basis, CeedInt *Q); 283 CEED_EXTERN int CeedBasisApply(CeedBasis basis, CeedInt nelem, 284 CeedTransposeMode tmode, 285 CeedEvalMode emode, CeedVector u, CeedVector v); 286 CEED_EXTERN int CeedBasisDestroy(CeedBasis *basis); 287 288 CEED_EXTERN int CeedGaussQuadrature(CeedInt Q, CeedScalar *qref1d, 289 CeedScalar *qweight1d); 290 CEED_EXTERN int CeedLobattoQuadrature(CeedInt Q, CeedScalar *qref1d, 291 CeedScalar *qweight1d); 292 CEED_EXTERN int CeedQRFactorization(CeedScalar *mat, CeedScalar *tau, CeedInt m, 293 CeedInt n); 294 295 /// Handle for the object describing the user CeedQFunction 296 /// 297 /// @param ctx - user-defined context set using CeedQFunctionSetContext() or NULL 298 /// 299 /// @param Q - number of quadrature points at which to evaluate 300 /// 301 /// @param in - array of pointers to each input argument in the order provided 302 /// by the user in CeedQFunctionAddInput(). Each array has shape 303 /// `[dim, ncomp, Q]` where `dim` is the geometric dimension for 304 /// \ref CEED_EVAL_GRAD (`dim=1` for \ref CEED_EVAL_INTERP) and 305 /// `ncomp` is the number of field components (`ncomp=1` for 306 /// scalar fields). This results in indexing the `i`th input at 307 /// quadarture point `j` as `in[i][(d*ncomp + c)*Q + j]`. 308 /// 309 /// @param out - array of pointers to each output array in the order provided 310 /// using CeedQFunctionAddOutput(). The shapes are as above for 311 /// \a in. 312 /// 313 /// @return 0 on success, nonzero for failure. 314 /// 315 /// @ingroup CeedQFunction 316 typedef int (*CeedQFunctionUser)(void *ctx, const CeedInt Q, 317 const CeedScalar *const *in, CeedScalar *const *out); 318 319 CEED_EXTERN int CeedQFunctionCreateInterior(Ceed ceed, CeedInt vlength, 320 CeedQFunctionUser f, const char *focca, CeedQFunction *qf); 321 CEED_EXTERN int CeedQFunctionAddInput(CeedQFunction qf, const char *fieldname, 322 CeedInt ncomp, CeedEvalMode emode); 323 CEED_EXTERN int CeedQFunctionAddOutput(CeedQFunction qf, const char *fieldname, 324 CeedInt ncomp, CeedEvalMode emode); 325 CEED_EXTERN int CeedQFunctionSetContext(CeedQFunction qf, void *ctx, 326 size_t ctxsize); 327 CEED_EXTERN int CeedQFunctionApply(CeedQFunction qf, CeedInt Q, 328 CeedVector *u, CeedVector *v); 329 CEED_EXTERN int CeedQFunctionDestroy(CeedQFunction *qf); 330 331 CEED_EXTERN int CeedOperatorCreate(Ceed ceed, CeedQFunction qf, 332 CeedQFunction dqf, CeedQFunction dqfT, 333 CeedOperator *op); 334 CEED_EXTERN int CeedCompositeOperatorCreate(Ceed ceed, CeedOperator *op); 335 CEED_EXTERN int CeedOperatorSetField(CeedOperator op, const char *fieldname, 336 CeedElemRestriction r, 337 CeedTransposeMode lmode, CeedBasis b, 338 CeedVector v); 339 CEED_EXTERN int CeedCompositeOperatorAddSub(CeedOperator compositeop, 340 CeedOperator subop); 341 CEED_EXTERN int CeedOperatorApply(CeedOperator op, CeedVector in, 342 CeedVector out, CeedRequest *request); 343 CEED_EXTERN int CeedOperatorDestroy(CeedOperator *op); 344 345 /** 346 @brief Return integer power 347 348 @param[in] base The base to exponentiate 349 @param[in] power The power to raise the base to 350 351 @return base^power 352 353 @ref Utility 354 **/ 355 static inline CeedInt CeedIntPow(CeedInt base, CeedInt power) { 356 CeedInt result = 1; 357 while (power) { 358 if (power & 1) result *= base; 359 power >>= 1; 360 base *= base; 361 } 362 return result; 363 } 364 365 /** 366 @brief Return mimimum of two integers 367 368 @param[in] a The first integer to compare 369 @param[in] b The second integer to compare 370 371 @return The minimum of the two integers 372 373 @ref Utility 374 **/ 375 static inline CeedInt CeedIntMin(CeedInt a, CeedInt b) { return a < b ? a : b; } 376 377 #endif 378