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 User User Functions 37 /// These functions are intended to be used by general users of libCEED 38 /// and can generally be found in "ceed.h". 39 /// @section Backend Backend Developer Functions 40 /// These functions are intended to be used by backend developers of 41 /// libCEED and can generally be found in "ceed-backend.h". 42 /// @section Developer Library Developer Functions 43 /// These functions are intended to be used by library developers of 44 /// libCEED and 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 /** 59 @ingroup CeedQFunction 60 This macro populates the correct function annotations for User QFunction 61 source for code generation backends or populates default values for CPU 62 backends. 63 **/ 64 #ifndef CEED_QFUNCTION 65 #define CEED_QFUNCTION(name) \ 66 static const char name ## _loc[] = __FILE__ ":" #name; \ 67 static int name 68 #endif 69 70 /** 71 @ingroup CeedQFunction 72 Using VLA syntax to reshape User QFunction inputs and outputs can make 73 user code more readable. VLA is a C99 feature that is not supported by 74 the C++ dialect used by CUDA. This macro allows users to use the VLA 75 syntax with the CUDA backends. 76 **/ 77 #ifndef CEED_Q_VLA 78 # define CEED_Q_VLA Q 79 #endif 80 81 /** 82 @ingroup Ceed 83 This macro provides the appropriate SIMD Pragma for the compilation 84 environment. Code generation backends may redefine this macro, as needed. 85 **/ 86 #ifndef CeedPragmaSIMD 87 # if defined(__INTEL_COMPILER) 88 # define CeedPragmaSIMD _Pragma("vector") 89 // Cannot use Intel pragma ivdep because it miscompiles unpacking symmetric tensors, as in 90 // Poisson2DApply, where the SIMD loop body contains temporaries such as the following. 91 // 92 // const CeedScalar dXdxdXdxT[2][2] = {{qd[i+0*Q], qd[i+2*Q]}, 93 // {qd[i+2*Q], qd[i+1*Q]}}; 94 // for (int j=0; j<2; j++) 95 // vg[i+j*Q] = (du[0] * dXdxdXdxT[0][j] + du[1] * dXdxdXdxT[1][j]); 96 // 97 // Miscompilation with pragma ivdep observed with icc (ICC) 19.0.5.281 20190815 98 // at -O2 and above. 99 # elif defined(__GNUC__) && __GNUC__ >= 5 100 # define CeedPragmaSIMD _Pragma("GCC ivdep") 101 # elif defined(_OPENMP) && _OPENMP >= 201307 // OpenMP-4.0 (July, 2013) 102 # define CeedPragmaSIMD _Pragma("omp simd") 103 # else 104 # define CeedPragmaSIMD 105 # endif 106 #endif 107 108 #include <stdint.h> 109 #include <stdarg.h> 110 #include <stdio.h> 111 #include <stdbool.h> 112 113 /// Integer type, used for indexing 114 /// @ingroup Ceed 115 typedef int32_t CeedInt; 116 /// Scalar (floating point) type 117 /// @ingroup Ceed 118 typedef double CeedScalar; 119 120 /// Library context created by CeedInit() 121 /// @ingroup CeedUser 122 typedef struct Ceed_private *Ceed; 123 /// Non-blocking Ceed interfaces return a CeedRequest. 124 /// To perform an operation immediately, pass \ref CEED_REQUEST_IMMEDIATE instead. 125 /// @ingroup CeedUser 126 typedef struct CeedRequest_private *CeedRequest; 127 /// Handle for vectors over the field \ref CeedScalar 128 /// @ingroup CeedVectorUser 129 typedef struct CeedVector_private *CeedVector; 130 /// Handle for object describing restriction to elements 131 /// @ingroup CeedElemRestrictionUser 132 typedef struct CeedElemRestriction_private *CeedElemRestriction; 133 /// Handle for object describing discrete finite element evaluations 134 /// @ingroup CeedBasisUser 135 typedef struct CeedBasis_private *CeedBasis; 136 /// Handle for object describing functions evaluated independently at quadrature points 137 /// @ingroup CeedQFunctionUser 138 typedef struct CeedQFunction_private *CeedQFunction; 139 /// Handle for object describing context data for CeedQFunctions 140 /// @ingroup CeedQFunctionUser 141 typedef struct CeedQFunctionContext_private *CeedQFunctionContext; 142 /// Handle for object describing FE-type operators acting on vectors 143 /// 144 /// Given an element restriction \f$E\f$, basis evaluator \f$B\f$, and 145 /// quadrature function\f$f\f$, a CeedOperator expresses operations of the form 146 /// $$ E^T B^T f(B E u) $$ 147 /// acting on the vector \f$u\f$. 148 /// @ingroup CeedOperatorUser 149 typedef struct CeedOperator_private *CeedOperator; 150 151 CEED_EXTERN int CeedInit(const char *resource, Ceed *ceed); 152 CEED_EXTERN int CeedGetResource(Ceed ceed, const char **resource); 153 CEED_EXTERN int CeedIsDeterministic(Ceed ceed, bool *isDeterministic); 154 CEED_EXTERN int CeedView(Ceed ceed, FILE *stream); 155 CEED_EXTERN int CeedDestroy(Ceed *ceed); 156 157 CEED_EXTERN int CeedErrorImpl(Ceed, const char *, int, const char *, int, 158 const char *, ...); 159 /// Raise an error on ceed object 160 /// 161 /// @param ceed Ceed library context or NULL 162 /// @param ecode Error code (int) 163 /// @param ... printf-style format string followed by arguments as needed 164 /// 165 /// @ingroup Ceed 166 /// @sa CeedSetErrorHandler() 167 #if defined(__clang__) 168 /// Use nonstandard ternary to convince the compiler/clang-tidy that this 169 /// function never returns zero. 170 # define CeedError(ceed, ecode, ...) \ 171 (CeedErrorImpl((ceed), __FILE__, __LINE__, __func__, (ecode), __VA_ARGS__) ?: (ecode)) 172 #else 173 # define CeedError(ceed, ecode, ...) \ 174 CeedErrorImpl((ceed), __FILE__, __LINE__, __func__, (ecode), __VA_ARGS__) ?: (ecode) 175 #endif 176 177 /// Ceed error handlers 178 CEED_EXTERN int CeedErrorReturn(Ceed, const char *, int, const char *, int, 179 const char *, va_list *); 180 CEED_EXTERN int CeedErrorStore(Ceed, const char *, int, const char *, int, 181 const char *, va_list *); 182 CEED_EXTERN int CeedErrorAbort(Ceed, const char *, int, const char *, int, 183 const char *, va_list *); 184 CEED_EXTERN int CeedErrorExit(Ceed, const char *, int, const char *, int, 185 const char *, va_list *); 186 CEED_EXTERN int CeedSetErrorHandler(Ceed ceed, 187 int (*eh)(Ceed, const char *, int, 188 const char *, int, const char *, 189 va_list *)); 190 CEED_EXTERN int CeedGetErrorMessage(Ceed, const char **errmsg); 191 CEED_EXTERN int CeedResetErrorMessage(Ceed, const char **errmsg); 192 193 /// Specify memory type 194 /// 195 /// Many Ceed interfaces take or return pointers to memory. This enum is used to 196 /// specify where the memory being provided or requested must reside. 197 /// @ingroup Ceed 198 typedef enum { 199 /// Memory resides on the host 200 CEED_MEM_HOST, 201 /// Memory resides on a device (corresponding to \ref Ceed resource) 202 CEED_MEM_DEVICE, 203 } CeedMemType; 204 205 CEED_EXTERN const char *const CeedMemTypes[]; 206 207 CEED_EXTERN int CeedGetPreferredMemType(Ceed ceed, CeedMemType *type); 208 209 /// Conveys ownership status of arrays passed to Ceed interfaces. 210 /// @ingroup Ceed 211 typedef enum { 212 /// Implementation will copy the values and not store the passed pointer. 213 CEED_COPY_VALUES, 214 /// Implementation can use and modify the data provided by the user, but does 215 /// not take ownership. 216 CEED_USE_POINTER, 217 /// Implementation takes ownership of the pointer and will free using 218 /// CeedFree() when done using it. The user should not assume that the 219 /// pointer remains valid after ownership has been transferred. Note that 220 /// arrays allocated using C++ operator new or other allocators cannot 221 /// generally be freed using CeedFree(). CeedFree() is capable of freeing any 222 /// memory that can be freed using free(3). 223 CEED_OWN_POINTER, 224 } CeedCopyMode; 225 226 /// Denotes type of vector norm to be computed 227 /// @ingroup CeedVector 228 typedef enum { 229 /// L_1 norm: sum_i |x_i| 230 CEED_NORM_1, 231 /// L_2 norm: sqrt(sum_i |x_i|^2) 232 CEED_NORM_2, 233 /// L_Infinity norm: max_i |x_i| 234 CEED_NORM_MAX, 235 } CeedNormType; 236 237 CEED_EXTERN const char *const CeedCopyModes[]; 238 239 CEED_EXTERN int CeedVectorCreate(Ceed ceed, CeedInt len, CeedVector *vec); 240 CEED_EXTERN int CeedVectorSetArray(CeedVector vec, CeedMemType mtype, 241 CeedCopyMode cmode, CeedScalar *array); 242 CEED_EXTERN int CeedVectorSetValue(CeedVector vec, CeedScalar value); 243 CEED_EXTERN int CeedVectorSyncArray(CeedVector vec, CeedMemType mtype); 244 CEED_EXTERN int CeedVectorTakeArray(CeedVector vec, CeedMemType mtype, 245 CeedScalar **array); 246 CEED_EXTERN int CeedVectorGetArray(CeedVector vec, CeedMemType mtype, 247 CeedScalar **array); 248 CEED_EXTERN int CeedVectorGetArrayRead(CeedVector vec, CeedMemType mtype, 249 const CeedScalar **array); 250 CEED_EXTERN int CeedVectorRestoreArray(CeedVector vec, CeedScalar **array); 251 CEED_EXTERN int CeedVectorRestoreArrayRead(CeedVector vec, 252 const CeedScalar **array); 253 CEED_EXTERN int CeedVectorNorm(CeedVector vec, CeedNormType type, 254 CeedScalar *norm); 255 CEED_EXTERN int CeedVectorReciprocal(CeedVector vec); 256 CEED_EXTERN int CeedVectorView(CeedVector vec, const char *fpfmt, FILE *stream); 257 CEED_EXTERN int CeedVectorGetLength(CeedVector vec, CeedInt *length); 258 CEED_EXTERN int CeedVectorDestroy(CeedVector *vec); 259 260 CEED_EXTERN CeedRequest *const CEED_REQUEST_IMMEDIATE; 261 CEED_EXTERN CeedRequest *const CEED_REQUEST_ORDERED; 262 CEED_EXTERN int CeedRequestWait(CeedRequest *req); 263 264 /// Argument for CeedOperatorSetField that vector is collocated with 265 /// quadrature points, used with QFunction eval mode CEED_EVAL_NONE 266 /// or CEED_EVAL_INTERP only, not with CEED_EVAL_GRAD, CEED_EVAL_DIV, 267 /// or CEED_EVAL_CURL 268 /// @ingroup CeedBasis 269 CEED_EXTERN const CeedBasis CEED_BASIS_COLLOCATED; 270 271 /// Argument for CeedOperatorSetField to use active input or output 272 /// @ingroup CeedVector 273 CEED_EXTERN const CeedVector CEED_VECTOR_ACTIVE; 274 275 /// Argument for CeedOperatorSetField to use no vector, used with 276 /// qfunction input with eval mode CEED_EVAL_WEIGHT 277 /// @ingroup CeedVector 278 CEED_EXTERN const CeedVector CEED_VECTOR_NONE; 279 280 /// Argument for CeedOperatorSetField to use no ElemRestriction, only used with 281 /// eval mode CEED_EVAL_WEIGHT. 282 /// @ingroup CeedElemRestriction 283 CEED_EXTERN const CeedElemRestriction CEED_ELEMRESTRICTION_NONE; 284 285 /// Argument for CeedOperatorCreate that QFunction is not created by user. 286 /// Only used for QFunctions dqf and dqfT. If implemented, a backend may 287 /// attempt to provide the action of these QFunctions. 288 /// @ingroup CeedQFunction 289 CEED_EXTERN const CeedQFunction CEED_QFUNCTION_NONE; 290 291 /// Denotes whether a linear transformation or its transpose should be applied 292 /// @ingroup CeedBasis 293 typedef enum { 294 /// Apply the linear transformation 295 CEED_NOTRANSPOSE, 296 /// Apply the transpose 297 CEED_TRANSPOSE 298 } CeedTransposeMode; 299 300 CEED_EXTERN const char *const CeedTransposeModes[]; 301 302 /// Argument for CeedElemRestrictionCreateStrided that L-vector is in 303 /// the Ceed backend's preferred layout. This argument should only be used 304 /// with vectors created by a Ceed backend. 305 /// @ingroup CeedElemRestriction 306 CEED_EXTERN const CeedInt CEED_STRIDES_BACKEND[3]; 307 308 CEED_EXTERN int CeedElemRestrictionCreate(Ceed ceed, CeedInt nelem, 309 CeedInt elemsize, CeedInt ncomp, CeedInt compstride, CeedInt lsize, 310 CeedMemType mtype, CeedCopyMode cmode, const CeedInt *offsets, 311 CeedElemRestriction *rstr); 312 CEED_EXTERN int CeedElemRestrictionCreateStrided(Ceed ceed, 313 CeedInt nelem, CeedInt elemsize, CeedInt ncomp, CeedInt lsize, 314 const CeedInt strides[3], CeedElemRestriction *rstr); 315 CEED_EXTERN int CeedElemRestrictionCreateBlocked(Ceed ceed, CeedInt nelem, 316 CeedInt elemsize, CeedInt blksize, CeedInt ncomp, CeedInt compstride, 317 CeedInt lsize, CeedMemType mtype, CeedCopyMode cmode, 318 const CeedInt *offsets, CeedElemRestriction *rstr); 319 CEED_EXTERN int CeedElemRestrictionCreateBlockedStrided(Ceed ceed, 320 CeedInt nelem, CeedInt elemsize, CeedInt blksize, CeedInt ncomp, 321 CeedInt lsize, const CeedInt strides[3], CeedElemRestriction *rstr); 322 CEED_EXTERN int CeedElemRestrictionCreateVector(CeedElemRestriction rstr, 323 CeedVector *lvec, CeedVector *evec); 324 CEED_EXTERN int CeedElemRestrictionApply(CeedElemRestriction rstr, 325 CeedTransposeMode tmode, CeedVector u, CeedVector ru, CeedRequest *request); 326 CEED_EXTERN int CeedElemRestrictionApplyBlock(CeedElemRestriction rstr, 327 CeedInt block, CeedTransposeMode tmode, CeedVector u, CeedVector ru, 328 CeedRequest *request); 329 CEED_EXTERN int CeedElemRestrictionGetCompStride(CeedElemRestriction rstr, 330 CeedInt *compstride); 331 CEED_EXTERN int CeedElemRestrictionGetNumElements(CeedElemRestriction rstr, 332 CeedInt *numelem); 333 CEED_EXTERN int CeedElemRestrictionGetElementSize(CeedElemRestriction rstr, 334 CeedInt *elemsize); 335 CEED_EXTERN int CeedElemRestrictionGetLVectorSize(CeedElemRestriction rstr, 336 CeedInt *lsize); 337 CEED_EXTERN int CeedElemRestrictionGetNumComponents(CeedElemRestriction rstr, 338 CeedInt *numcomp); 339 CEED_EXTERN int CeedElemRestrictionGetNumBlocks(CeedElemRestriction rstr, 340 CeedInt *numblk); 341 CEED_EXTERN int CeedElemRestrictionGetBlockSize(CeedElemRestriction rstr, 342 CeedInt *blksize); 343 CEED_EXTERN int CeedElemRestrictionGetMultiplicity(CeedElemRestriction rstr, 344 CeedVector mult); 345 CEED_EXTERN int CeedElemRestrictionView(CeedElemRestriction rstr, FILE *stream); 346 CEED_EXTERN int CeedElemRestrictionDestroy(CeedElemRestriction *rstr); 347 348 // The formalism here is that we have the structure 349 // \int_\Omega v^T f_0(u, \nabla u, qdata) + (\nabla v)^T f_1(u, \nabla u, qdata) 350 // where gradients are with respect to the reference element. 351 352 /// Basis evaluation mode 353 /// 354 /// Modes can be bitwise ORed when passing to most functions. 355 /// @ingroup CeedBasis 356 typedef enum { 357 /// Perform no evaluation (either because there is no data or it is already at 358 /// quadrature points) 359 CEED_EVAL_NONE = 0, 360 /// Interpolate from nodes to quadrature points 361 CEED_EVAL_INTERP = 1, 362 /// Evaluate gradients at quadrature points from input in a nodal basis 363 CEED_EVAL_GRAD = 2, 364 /// Evaluate divergence at quadrature points from input in a nodal basis 365 CEED_EVAL_DIV = 4, 366 /// Evaluate curl at quadrature points from input in a nodal basis 367 CEED_EVAL_CURL = 8, 368 /// Using no input, evaluate quadrature weights on the reference element 369 CEED_EVAL_WEIGHT = 16, 370 } CeedEvalMode; 371 372 CEED_EXTERN const char *const CeedEvalModes[]; 373 374 /// Type of quadrature; also used for location of nodes 375 /// @ingroup CeedBasis 376 typedef enum { 377 /// Gauss-Legendre quadrature 378 CEED_GAUSS = 0, 379 /// Gauss-Legendre-Lobatto quadrature 380 CEED_GAUSS_LOBATTO = 1, 381 } CeedQuadMode; 382 383 CEED_EXTERN const char *const CeedQuadModes[]; 384 385 /// Type of basis shape to create non-tensor H1 element basis 386 /// 387 /// Dimension can be extracted with bitwise AND 388 /// (CeedElemTopology & 2**(dim + 2)) == TRUE 389 /// @ingroup CeedBasis 390 typedef enum { 391 /// Line 392 CEED_LINE = 1 << 16 | 0, 393 /// Triangle - 2D shape 394 CEED_TRIANGLE = 2 << 16 | 1, 395 /// Quadralateral - 2D shape 396 CEED_QUAD = 2 << 16 | 2, 397 /// Tetrahedron - 3D shape 398 CEED_TET = 3 << 16 | 3, 399 /// Pyramid - 3D shape 400 CEED_PYRAMID = 3 << 16 | 4, 401 /// Prism - 3D shape 402 CEED_PRISM = 3 << 16 | 5, 403 /// Hexehedron - 3D shape 404 CEED_HEX = 3 << 16 | 6, 405 } CeedElemTopology; 406 407 CEED_EXTERN const char *const CeedElemTopologies[]; 408 409 CEED_EXTERN int CeedBasisCreateTensorH1Lagrange(Ceed ceed, CeedInt dim, 410 CeedInt ncomp, CeedInt P, CeedInt Q, CeedQuadMode qmode, CeedBasis *basis); 411 CEED_EXTERN int CeedBasisCreateTensorH1(Ceed ceed, CeedInt dim, CeedInt ncomp, 412 CeedInt P1d, CeedInt Q1d, 413 const CeedScalar *interp1d, 414 const CeedScalar *grad1d, 415 const CeedScalar *qref1d, 416 const CeedScalar *qweight1d, 417 CeedBasis *basis); 418 CEED_EXTERN int CeedBasisCreateH1(Ceed ceed, CeedElemTopology topo, 419 CeedInt ncomp, 420 CeedInt nnodes, CeedInt nqpts, 421 const CeedScalar *interp, 422 const CeedScalar *grad, 423 const CeedScalar *qref, 424 const CeedScalar *qweight, CeedBasis *basis); 425 CEED_EXTERN int CeedBasisView(CeedBasis basis, FILE *stream); 426 CEED_EXTERN int CeedBasisApply(CeedBasis basis, CeedInt nelem, 427 CeedTransposeMode tmode, 428 CeedEvalMode emode, CeedVector u, CeedVector v); 429 CEED_EXTERN int CeedBasisGetDimension(CeedBasis basis, CeedInt *dim); 430 CEED_EXTERN int CeedBasisGetTopology(CeedBasis basis, CeedElemTopology *topo); 431 CEED_EXTERN int CeedBasisGetNumComponents(CeedBasis basis, CeedInt *numcomp); 432 CEED_EXTERN int CeedBasisGetNumNodes(CeedBasis basis, CeedInt *P); 433 CEED_EXTERN int CeedBasisGetNumNodes1D(CeedBasis basis, CeedInt *P1d); 434 CEED_EXTERN int CeedBasisGetNumQuadraturePoints(CeedBasis basis, CeedInt *Q); 435 CEED_EXTERN int CeedBasisGetNumQuadraturePoints1D(CeedBasis basis, 436 CeedInt *Q1d); 437 CEED_EXTERN int CeedBasisGetQRef(CeedBasis basis, const CeedScalar **qref); 438 CEED_EXTERN int CeedBasisGetQWeights(CeedBasis basis, 439 const CeedScalar **qweight); 440 CEED_EXTERN int CeedBasisGetInterp(CeedBasis basis, const CeedScalar **interp); 441 CEED_EXTERN int CeedBasisGetInterp1D(CeedBasis basis, 442 const CeedScalar **interp1d); 443 CEED_EXTERN int CeedBasisGetGrad(CeedBasis basis, const CeedScalar **grad); 444 CEED_EXTERN int CeedBasisGetGrad1D(CeedBasis basis, const CeedScalar **grad1d); 445 CEED_EXTERN int CeedBasisDestroy(CeedBasis *basis); 446 447 CEED_EXTERN int CeedGaussQuadrature(CeedInt Q, CeedScalar *qref1d, 448 CeedScalar *qweight1d); 449 CEED_EXTERN int CeedLobattoQuadrature(CeedInt Q, CeedScalar *qref1d, 450 CeedScalar *qweight1d); 451 CEED_EXTERN int CeedQRFactorization(Ceed ceed, CeedScalar *mat, CeedScalar *tau, 452 CeedInt m, CeedInt n); 453 CEED_EXTERN int CeedSymmetricSchurDecomposition(Ceed ceed, CeedScalar *mat, 454 CeedScalar *lambda, CeedInt n); 455 CEED_EXTERN int CeedSimultaneousDiagonalization(Ceed ceed, CeedScalar *matA, 456 CeedScalar *matB, CeedScalar *x, CeedScalar *lambda, CeedInt n); 457 458 /** Handle for the object describing the user CeedQFunction 459 460 @param ctx user-defined context set using CeedQFunctionSetContext() or NULL 461 462 @param Q number of quadrature points at which to evaluate 463 464 @param in array of pointers to each input argument in the order provided 465 by the user in CeedQFunctionAddInput(). Each array has shape 466 `[dim, ncomp, Q]` where `dim` is the geometric dimension for 467 \ref CEED_EVAL_GRAD (`dim=1` for \ref CEED_EVAL_INTERP) and 468 `ncomp` is the number of field components (`ncomp=1` for 469 scalar fields). This results in indexing the `i`th input at 470 quadrature point `j` as `in[i][(d*ncomp + c)*Q + j]`. 471 472 @param out array of pointers to each output array in the order provided 473 using CeedQFunctionAddOutput(). The shapes are as above for 474 \a in. 475 476 @return An error code: 0 - success, otherwise - failure 477 478 @ingroup CeedQFunction 479 **/ 480 typedef int (*CeedQFunctionUser)(void *ctx, const CeedInt Q, 481 const CeedScalar *const *in, 482 CeedScalar *const *out); 483 484 CEED_EXTERN int CeedQFunctionCreateInterior(Ceed ceed, CeedInt vlength, 485 CeedQFunctionUser f, const char *source, CeedQFunction *qf); 486 CEED_EXTERN int CeedQFunctionCreateInteriorByName(Ceed ceed, const char *name, 487 CeedQFunction *qf); 488 CEED_EXTERN int CeedQFunctionCreateIdentity(Ceed ceed, CeedInt size, 489 CeedEvalMode inmode, CeedEvalMode outmode, CeedQFunction *qf); 490 CEED_EXTERN int CeedQFunctionAddInput(CeedQFunction qf, const char *fieldname, 491 CeedInt size, CeedEvalMode emode); 492 CEED_EXTERN int CeedQFunctionAddOutput(CeedQFunction qf, const char *fieldname, 493 CeedInt size, CeedEvalMode emode); 494 CEED_EXTERN int CeedQFunctionSetContext(CeedQFunction qf, 495 CeedQFunctionContext ctx); 496 CEED_EXTERN int CeedQFunctionView(CeedQFunction qf, FILE *stream); 497 CEED_EXTERN int CeedQFunctionApply(CeedQFunction qf, CeedInt Q, 498 CeedVector *u, CeedVector *v); 499 CEED_EXTERN int CeedQFunctionDestroy(CeedQFunction *qf); 500 501 CEED_EXTERN int CeedQFunctionContextCreate(Ceed ceed, 502 CeedQFunctionContext *ctx); 503 CEED_EXTERN int CeedQFunctionContextSetData(CeedQFunctionContext ctx, 504 CeedMemType mtype, CeedCopyMode cmode, size_t size, void *data); 505 CEED_EXTERN int CeedQFunctionContextGetData(CeedQFunctionContext ctx, 506 CeedMemType mtype, 507 void *data); 508 CEED_EXTERN int CeedQFunctionContextRestoreData(CeedQFunctionContext ctx, 509 void *data); 510 CEED_EXTERN int CeedQFunctionContextView(CeedQFunctionContext ctx, 511 FILE *stream); 512 CEED_EXTERN int CeedQFunctionContextDestroy(CeedQFunctionContext *ctx); 513 514 CEED_EXTERN int CeedOperatorCreate(Ceed ceed, CeedQFunction qf, 515 CeedQFunction dqf, CeedQFunction dqfT, 516 CeedOperator *op); 517 CEED_EXTERN int CeedCompositeOperatorCreate(Ceed ceed, CeedOperator *op); 518 CEED_EXTERN int CeedOperatorSetField(CeedOperator op, const char *fieldname, 519 CeedElemRestriction r, CeedBasis b, 520 CeedVector v); 521 CEED_EXTERN int CeedCompositeOperatorAddSub(CeedOperator compositeop, 522 CeedOperator subop); 523 CEED_EXTERN int CeedOperatorLinearAssembleQFunction(CeedOperator op, 524 CeedVector *assembled, CeedElemRestriction *rstr, CeedRequest *request); 525 CEED_EXTERN int CeedOperatorLinearAssembleDiagonal(CeedOperator op, 526 CeedVector assembled, CeedRequest *request); 527 CEED_EXTERN int CeedOperatorLinearAssembleAddDiagonal(CeedOperator op, 528 CeedVector assembled, CeedRequest *request); 529 CEED_EXTERN int CeedOperatorLinearAssemblePointBlockDiagonal(CeedOperator op, 530 CeedVector assembled, CeedRequest *request); 531 CEED_EXTERN int CeedOperatorLinearAssembleAddPointBlockDiagonal(CeedOperator op, 532 CeedVector assembled, CeedRequest *request); 533 CEED_EXTERN int CeedOperatorMultigridLevelCreate(CeedOperator opFine, 534 CeedVector PMultFine, CeedElemRestriction rstrCoarse, CeedBasis basisCoarse, 535 CeedOperator *opCoarse, CeedOperator *opProlong, CeedOperator *opRestrict); 536 CEED_EXTERN int CeedOperatorMultigridLevelCreateTensorH1( 537 CeedOperator opFine, CeedVector PMultFine, CeedElemRestriction rstrCoarse, 538 CeedBasis basisCoarse, const CeedScalar *interpCtoF, CeedOperator *opCoarse, 539 CeedOperator *opProlong, CeedOperator *opRestrict); 540 CEED_EXTERN int CeedOperatorMultigridLevelCreateH1(CeedOperator opFine, 541 CeedVector PMultFine, CeedElemRestriction rstrCoarse, CeedBasis basisCoarse, 542 const CeedScalar *interpCtoF, CeedOperator *opCoarse, 543 CeedOperator *opProlong, CeedOperator *opRestrict); 544 CEED_EXTERN int CeedOperatorCreateFDMElementInverse(CeedOperator op, 545 CeedOperator *fdminv, CeedRequest *request); 546 CEED_EXTERN int CeedOperatorView(CeedOperator op, FILE *stream); 547 CEED_EXTERN int CeedOperatorApply(CeedOperator op, CeedVector in, 548 CeedVector out, CeedRequest *request); 549 CEED_EXTERN int CeedOperatorApplyAdd(CeedOperator op, CeedVector in, 550 CeedVector out, CeedRequest *request); 551 CEED_EXTERN int CeedOperatorDestroy(CeedOperator *op); 552 553 /** 554 @brief Return integer power 555 556 @param[in] base The base to exponentiate 557 @param[in] power The power to raise the base to 558 559 @return base^power 560 561 @ref Utility 562 **/ 563 static inline CeedInt CeedIntPow(CeedInt base, CeedInt power) { 564 CeedInt result = 1; 565 while (power) { 566 if (power & 1) result *= base; 567 power >>= 1; 568 base *= base; 569 } 570 return result; 571 } 572 573 /** 574 @brief Return minimum of two integers 575 576 @param[in] a The first integer to compare 577 @param[in] b The second integer to compare 578 579 @return The minimum of the two integers 580 581 @ref Utility 582 **/ 583 static inline CeedInt CeedIntMin(CeedInt a, CeedInt b) { return a < b ? a : b; } 584 585 /** 586 @brief Return maximum of two integers 587 588 @param[in] a The first integer to compare 589 @param[in] b The second integer to compare 590 591 @return The maximum of the two integers 592 593 @ref Utility 594 **/ 595 static inline CeedInt CeedIntMax(CeedInt a, CeedInt b) { return a > b ? a : b; } 596 597 // Used to ensure initialization before CeedInit() 598 CEED_EXTERN int CeedRegisterAll(void); 599 // Used to ensure initialization before CeedQFunctionCreate*() 600 CEED_EXTERN int CeedQFunctionRegisterAll(void); 601 602 #endif 603