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 <assert.h> 109 #include <stdint.h> 110 #include <stddef.h> 111 #include <stdarg.h> 112 #include <stdio.h> 113 #include <stdbool.h> 114 115 /// Integer type, used for indexing 116 /// @ingroup Ceed 117 typedef int32_t CeedInt; 118 /// Scalar (floating point) type 119 /// @ingroup Ceed 120 typedef double CeedScalar; 121 122 /// Library context created by CeedInit() 123 /// @ingroup CeedUser 124 typedef struct Ceed_private *Ceed; 125 /// Non-blocking Ceed interfaces return a CeedRequest. 126 /// To perform an operation immediately, pass \ref CEED_REQUEST_IMMEDIATE instead. 127 /// @ingroup CeedUser 128 typedef struct CeedRequest_private *CeedRequest; 129 /// Handle for vectors over the field \ref CeedScalar 130 /// @ingroup CeedVectorUser 131 typedef struct CeedVector_private *CeedVector; 132 /// Handle for object describing restriction to elements 133 /// @ingroup CeedElemRestrictionUser 134 typedef struct CeedElemRestriction_private *CeedElemRestriction; 135 /// Handle for object describing discrete finite element evaluations 136 /// @ingroup CeedBasisUser 137 typedef struct CeedBasis_private *CeedBasis; 138 /// Handle for object describing functions evaluated independently at quadrature points 139 /// @ingroup CeedQFunctionUser 140 typedef struct CeedQFunction_private *CeedQFunction; 141 /// Handle for object describing FE-type operators acting on vectors 142 /// 143 /// Given an element restriction \f$E\f$, basis evaluator \f$B\f$, and 144 /// quadrature function\f$f\f$, a CeedOperator expresses operations of the form 145 /// $$ E^T B^T f(B E u) $$ 146 /// acting on the vector \f$u\f$. 147 /// @ingroup CeedOperatorUser 148 typedef struct CeedOperator_private *CeedOperator; 149 150 CEED_EXTERN int CeedInit(const char *resource, Ceed *ceed); 151 CEED_EXTERN int CeedGetResource(Ceed ceed, const char **resource); 152 CEED_EXTERN int CeedView(Ceed ceed, FILE *stream); 153 CEED_EXTERN int CeedDestroy(Ceed *ceed); 154 155 CEED_EXTERN int CeedErrorImpl(Ceed, const char *, int, const char *, int, 156 const char *, ...); 157 /// Raise an error on ceed object 158 /// 159 /// @param ceed Ceed library context or NULL 160 /// @param ecode Error code (int) 161 /// @param ... printf-style format string followed by arguments as needed 162 /// 163 /// @ingroup Ceed 164 /// @sa CeedSetErrorHandler() 165 #if defined(__clang__) 166 /// Use nonstandard ternary to convince the compiler/clang-tidy that this 167 /// function never returns zero. 168 # define CeedError(ceed, ecode, ...) \ 169 (CeedErrorImpl((ceed), __FILE__, __LINE__, __func__, (ecode), __VA_ARGS__) ?: (ecode)) 170 #else 171 # define CeedError(ceed, ecode, ...) \ 172 CeedErrorImpl((ceed), __FILE__, __LINE__, __func__, (ecode), __VA_ARGS__) ?: (ecode) 173 #endif 174 /// Specify memory type 175 /// 176 /// Many Ceed interfaces take or return pointers to memory. This enum is used to 177 /// specify where the memory being provided or requested must reside. 178 /// @ingroup Ceed 179 typedef enum { 180 /// Memory resides on the host 181 CEED_MEM_HOST, 182 /// Memory resides on a device (corresponding to \ref Ceed resource) 183 CEED_MEM_DEVICE, 184 } CeedMemType; 185 186 CEED_EXTERN const char *const CeedMemTypes[]; 187 188 CEED_EXTERN int CeedGetPreferredMemType(Ceed ceed, CeedMemType *type); 189 190 /// Conveys ownership status of arrays passed to Ceed interfaces. 191 /// @ingroup Ceed 192 typedef enum { 193 /// Implementation will copy the values and not store the passed pointer. 194 CEED_COPY_VALUES, 195 /// Implementation can use and modify the data provided by the user, but does 196 /// not take ownership. 197 CEED_USE_POINTER, 198 /// Implementation takes ownership of the pointer and will free using 199 /// CeedFree() when done using it. The user should not assume that the 200 /// pointer remains valid after ownership has been transferred. Note that 201 /// arrays allocated using C++ operator new or other allocators cannot 202 /// generally be freed using CeedFree(). CeedFree() is capable of freeing any 203 /// memory that can be freed using free(3). 204 CEED_OWN_POINTER, 205 } CeedCopyMode; 206 207 /// Denotes type of vector norm to be computed 208 /// @ingroup CeedVector 209 typedef enum { 210 /// L_1 norm: sum_i |x_i| 211 CEED_NORM_1, 212 /// L_2 norm: sqrt(sum_i |x_i|^2) 213 CEED_NORM_2, 214 /// L_Infinity norm: max_i |x_i| 215 CEED_NORM_MAX, 216 } CeedNormType; 217 218 CEED_EXTERN const char *const CeedCopyModes[]; 219 220 CEED_EXTERN int CeedVectorCreate(Ceed ceed, CeedInt len, CeedVector *vec); 221 CEED_EXTERN int CeedVectorSetArray(CeedVector vec, CeedMemType mtype, 222 CeedCopyMode cmode, CeedScalar *array); 223 CEED_EXTERN int CeedVectorSetValue(CeedVector vec, CeedScalar value); 224 CEED_EXTERN int CeedVectorSyncArray(CeedVector vec, CeedMemType mtype); 225 CEED_EXTERN int CeedVectorGetArray(CeedVector vec, CeedMemType mtype, 226 CeedScalar **array); 227 CEED_EXTERN int CeedVectorGetArrayRead(CeedVector vec, CeedMemType mtype, 228 const CeedScalar **array); 229 CEED_EXTERN int CeedVectorRestoreArray(CeedVector vec, CeedScalar **array); 230 CEED_EXTERN int CeedVectorRestoreArrayRead(CeedVector vec, 231 const CeedScalar **array); 232 CEED_EXTERN int CeedVectorNorm(CeedVector vec, CeedNormType type, 233 CeedScalar *norm); 234 CEED_EXTERN int CeedVectorView(CeedVector vec, const char *fpfmt, FILE *stream); 235 CEED_EXTERN int CeedVectorGetLength(CeedVector vec, CeedInt *length); 236 CEED_EXTERN int CeedVectorDestroy(CeedVector *vec); 237 238 CEED_EXTERN CeedRequest *const CEED_REQUEST_IMMEDIATE; 239 CEED_EXTERN CeedRequest *const CEED_REQUEST_ORDERED; 240 CEED_EXTERN int CeedRequestWait(CeedRequest *req); 241 242 /// Argument for CeedOperatorSetField that vector is collocated with 243 /// quadrature points, used with QFunction eval mode CEED_EVAL_NONE 244 /// or CEED_EVAL_INTERP only, not with CEED_EVAL_GRAD, CEED_EVAL_DIV, 245 /// or CEED_EVAL_CURL 246 /// @ingroup CeedBasis 247 CEED_EXTERN const CeedBasis CEED_BASIS_COLLOCATED; 248 249 /// Argument for CeedOperatorSetField to use active input or output 250 /// @ingroup CeedVector 251 CEED_EXTERN const CeedVector CEED_VECTOR_ACTIVE; 252 253 /// Argument for CeedOperatorSetField to use no vector, used with 254 /// qfunction input with eval mode CEED_EVAL_WEIGHT 255 /// @ingroup CeedVector 256 CEED_EXTERN const CeedVector CEED_VECTOR_NONE; 257 258 /// Argument for CeedOperatorSetField to use no ElemRestriction, only used with 259 /// eval mode CEED_EVAL_WEIGHT. 260 /// @ingroup CeedElemRestriction 261 CEED_EXTERN const CeedElemRestriction CEED_ELEMRESTRICTION_NONE; 262 263 /// Argument for CeedOperatorCreate that QFunction is not created by user. 264 /// Only used for QFunctions dqf and dqfT. If implemented, a backend may 265 /// attempt to provide the action of these QFunctions. 266 /// @ingroup CeedQFunction 267 CEED_EXTERN const CeedQFunction CEED_QFUNCTION_NONE; 268 269 /// Denotes whether a linear transformation or its transpose should be applied 270 /// @ingroup CeedBasis 271 typedef enum { 272 /// Apply the linear transformation 273 CEED_NOTRANSPOSE, 274 /// Apply the transpose 275 CEED_TRANSPOSE 276 } CeedTransposeMode; 277 278 CEED_EXTERN const char *const CeedTransposeModes[]; 279 280 /// Denotes whether a L-vector is ordered [component, node] or [node, component] 281 /// with the right-most index being contiguous in memory 282 /// @ingroup CeedElemRestriction 283 typedef enum { 284 /// L-vector data is not interlaced, ordered [component, node] 285 CEED_NONINTERLACED, 286 /// L-vector data is interlaced, ordered [node, component] 287 CEED_INTERLACED 288 } CeedInterlaceMode; 289 290 CEED_EXTERN const char *const CeedInterlaceModes[]; 291 292 /// Argument for CeedElemRestrictionCreateStrided that L-vector is in 293 /// the Ceed backend's preferred layout. This argument should only be used 294 /// with vectors created by a Ceed backend. 295 /// @ingroup CeedElemRestriction 296 CEED_EXTERN const CeedInt CEED_STRIDES_BACKEND[3]; 297 298 CEED_EXTERN int CeedElemRestrictionCreate(Ceed ceed, CeedInterlaceMode imode, 299 CeedInt nelem, CeedInt elemsize, CeedInt nnodes, CeedInt ncomp, 300 CeedMemType mtype, CeedCopyMode cmode, const CeedInt *indices, 301 CeedElemRestriction *rstr); 302 CEED_EXTERN int CeedElemRestrictionCreateBlocked(Ceed ceed, 303 CeedInterlaceMode imode, CeedInt nelem, CeedInt elemsize, CeedInt blksize, 304 CeedInt nnodes, CeedInt ncomp, CeedMemType mtype, CeedCopyMode cmode, 305 const CeedInt *indices, CeedElemRestriction *rstr); 306 CEED_EXTERN int CeedElemRestrictionCreateStrided(Ceed ceed, 307 CeedInt nelem, CeedInt elemsize, CeedInt nnodes, CeedInt ncomp, 308 const CeedInt strides[3], CeedElemRestriction *rstr); 309 CEED_EXTERN int CeedElemRestrictionCreateBlockedStrided(Ceed ceed, 310 CeedInt nelem, CeedInt elemsize, CeedInt blksize, CeedInt nnodes, 311 CeedInt ncomp, const CeedInt strides[3], CeedElemRestriction *rstr); 312 CEED_EXTERN int CeedElemRestrictionCreateVector(CeedElemRestriction rstr, 313 CeedVector *lvec, CeedVector *evec); 314 CEED_EXTERN int CeedElemRestrictionApply(CeedElemRestriction rstr, 315 CeedTransposeMode tmode, CeedVector u, CeedVector ru, CeedRequest *request); 316 CEED_EXTERN int CeedElemRestrictionApplyBlock(CeedElemRestriction rstr, 317 CeedInt block, CeedTransposeMode tmode, CeedVector u, CeedVector ru, 318 CeedRequest *request); 319 CEED_EXTERN int CeedElemRestrictionGetIMode(CeedElemRestriction rstr, 320 CeedInterlaceMode *Imode); 321 CEED_EXTERN int CeedElemRestrictionGetNumElements(CeedElemRestriction rstr, 322 CeedInt *numelem); 323 CEED_EXTERN int CeedElemRestrictionGetElementSize(CeedElemRestriction rstr, 324 CeedInt *elemsize); 325 CEED_EXTERN int CeedElemRestrictionGetNumNodes(CeedElemRestriction rstr, 326 CeedInt *numnodes); 327 CEED_EXTERN int CeedElemRestrictionGetNumComponents(CeedElemRestriction rstr, 328 CeedInt *numcomp); 329 CEED_EXTERN int CeedElemRestrictionGetNumBlocks(CeedElemRestriction rstr, 330 CeedInt *numblk); 331 CEED_EXTERN int CeedElemRestrictionGetBlockSize(CeedElemRestriction rstr, 332 CeedInt *blksize); 333 CEED_EXTERN int CeedElemRestrictionGetMultiplicity(CeedElemRestriction rstr, 334 CeedVector mult); 335 CEED_EXTERN int CeedElemRestrictionView(CeedElemRestriction rstr, FILE *stream); 336 CEED_EXTERN int CeedElemRestrictionDestroy(CeedElemRestriction *rstr); 337 338 // The formalism here is that we have the structure 339 // \int_\Omega v^T f_0(u, \nabla u, qdata) + (\nabla v)^T f_1(u, \nabla u, qdata) 340 // where gradients are with respect to the reference element. 341 342 /// Basis evaluation mode 343 /// 344 /// Modes can be bitwise ORed when passing to most functions. 345 /// @ingroup CeedBasis 346 typedef enum { 347 /// Perform no evaluation (either because there is no data or it is already at 348 /// quadrature points) 349 CEED_EVAL_NONE = 0, 350 /// Interpolate from nodes to quadrature points 351 CEED_EVAL_INTERP = 1, 352 /// Evaluate gradients at quadrature points from input in a nodal basis 353 CEED_EVAL_GRAD = 2, 354 /// Evaluate divergence at quadrature points from input in a nodal basis 355 CEED_EVAL_DIV = 4, 356 /// Evaluate curl at quadrature points from input in a nodal basis 357 CEED_EVAL_CURL = 8, 358 /// Using no input, evaluate quadrature weights on the reference element 359 CEED_EVAL_WEIGHT = 16, 360 } CeedEvalMode; 361 362 CEED_EXTERN const char *const CeedEvalModes[]; 363 364 /// Type of quadrature; also used for location of nodes 365 /// @ingroup CeedBasis 366 typedef enum { 367 /// Gauss-Legendre quadrature 368 CEED_GAUSS = 0, 369 /// Gauss-Legendre-Lobatto quadrature 370 CEED_GAUSS_LOBATTO = 1, 371 } CeedQuadMode; 372 373 CEED_EXTERN const char *const CeedQuadModes[]; 374 375 /// Type of basis shape to create non-tensor H1 element basis 376 /// 377 /// Dimension can be extracted with bitwise AND 378 /// (CeedElemTopology & 2**(dim + 2)) == TRUE 379 /// @ingroup CeedBasis 380 typedef enum { 381 /// Line 382 CEED_LINE = 1 << 16 | 0, 383 /// Triangle - 2D shape 384 CEED_TRIANGLE = 2 << 16 | 1, 385 /// Quadralateral - 2D shape 386 CEED_QUAD = 2 << 16 | 2, 387 /// Tetrahedron - 3D shape 388 CEED_TET = 3 << 16 | 3, 389 /// Pyramid - 3D shape 390 CEED_PYRAMID = 3 << 16 | 4, 391 /// Prism - 3D shape 392 CEED_PRISM = 3 << 16 | 5, 393 /// Hexehedron - 3D shape 394 CEED_HEX = 3 << 16 | 6, 395 } CeedElemTopology; 396 397 CEED_EXTERN const char *const CeedElemTopologies[]; 398 399 CEED_EXTERN int CeedBasisCreateTensorH1Lagrange(Ceed ceed, CeedInt dim, 400 CeedInt ncomp, CeedInt P, CeedInt Q, CeedQuadMode qmode, CeedBasis *basis); 401 CEED_EXTERN int CeedBasisCreateTensorH1(Ceed ceed, CeedInt dim, CeedInt ncomp, 402 CeedInt P1d, CeedInt Q1d, 403 const CeedScalar *interp1d, 404 const CeedScalar *grad1d, 405 const CeedScalar *qref1d, 406 const CeedScalar *qweight1d, 407 CeedBasis *basis); 408 CEED_EXTERN int CeedBasisCreateH1(Ceed ceed, CeedElemTopology topo, 409 CeedInt ncomp, 410 CeedInt nnodes, CeedInt nqpts, 411 const CeedScalar *interp, 412 const CeedScalar *grad, 413 const CeedScalar *qref, 414 const CeedScalar *qweight, CeedBasis *basis); 415 CEED_EXTERN int CeedBasisView(CeedBasis basis, FILE *stream); 416 CEED_EXTERN int CeedBasisGetNumNodes(CeedBasis basis, CeedInt *P); 417 CEED_EXTERN int CeedBasisGetNumQuadraturePoints(CeedBasis basis, CeedInt *Q); 418 CEED_EXTERN int CeedBasisApply(CeedBasis basis, CeedInt nelem, 419 CeedTransposeMode tmode, 420 CeedEvalMode emode, CeedVector u, CeedVector v); 421 CEED_EXTERN int CeedBasisDestroy(CeedBasis *basis); 422 423 CEED_EXTERN int CeedGaussQuadrature(CeedInt Q, CeedScalar *qref1d, 424 CeedScalar *qweight1d); 425 CEED_EXTERN int CeedLobattoQuadrature(CeedInt Q, CeedScalar *qref1d, 426 CeedScalar *qweight1d); 427 CEED_EXTERN int CeedQRFactorization(Ceed ceed, CeedScalar *mat, CeedScalar *tau, 428 CeedInt m, CeedInt n); 429 CEED_EXTERN int CeedSymmetricSchurDecomposition(Ceed ceed, CeedScalar *mat, 430 CeedScalar *lambda, CeedInt n); 431 CEED_EXTERN int CeedSimultaneousDiagonalization(Ceed ceed, CeedScalar *matA, 432 CeedScalar *matB, CeedScalar *x, CeedScalar *lambda, CeedInt n); 433 434 /** Handle for the object describing the user CeedQFunction 435 436 @param ctx user-defined context set using CeedQFunctionSetContext() or NULL 437 438 @param Q number of quadrature points at which to evaluate 439 440 @param in array of pointers to each input argument in the order provided 441 by the user in CeedQFunctionAddInput(). Each array has shape 442 `[dim, ncomp, Q]` where `dim` is the geometric dimension for 443 \ref CEED_EVAL_GRAD (`dim=1` for \ref CEED_EVAL_INTERP) and 444 `ncomp` is the number of field components (`ncomp=1` for 445 scalar fields). This results in indexing the `i`th input at 446 quadrature point `j` as `in[i][(d*ncomp + c)*Q + j]`. 447 448 @param out array of pointers to each output array in the order provided 449 using CeedQFunctionAddOutput(). The shapes are as above for 450 \a in. 451 452 @return An error code: 0 - success, otherwise - failure 453 454 @ingroup CeedQFunction 455 **/ 456 typedef int (*CeedQFunctionUser)(void *ctx, const CeedInt Q, 457 const CeedScalar *const *in, 458 CeedScalar *const *out); 459 460 CEED_EXTERN int CeedQFunctionCreateInterior(Ceed ceed, CeedInt vlength, 461 CeedQFunctionUser f, const char *source, CeedQFunction *qf); 462 CEED_EXTERN int CeedQFunctionCreateInteriorByName(Ceed ceed, const char *name, 463 CeedQFunction *qf); 464 CEED_EXTERN int CeedQFunctionCreateIdentity(Ceed ceed, CeedInt size, 465 CeedEvalMode inmode, CeedEvalMode outmode, CeedQFunction *qf); 466 CEED_EXTERN int CeedQFunctionAddInput(CeedQFunction qf, const char *fieldname, 467 CeedInt size, CeedEvalMode emode); 468 CEED_EXTERN int CeedQFunctionAddOutput(CeedQFunction qf, const char *fieldname, 469 CeedInt size, CeedEvalMode emode); 470 CEED_EXTERN int CeedQFunctionSetContext(CeedQFunction qf, void *ctx, 471 size_t ctxsize); 472 CEED_EXTERN int CeedQFunctionView(CeedQFunction qf, FILE *stream); 473 CEED_EXTERN int CeedQFunctionApply(CeedQFunction qf, CeedInt Q, 474 CeedVector *u, CeedVector *v); 475 CEED_EXTERN int CeedQFunctionDestroy(CeedQFunction *qf); 476 477 CEED_EXTERN int CeedOperatorCreate(Ceed ceed, CeedQFunction qf, 478 CeedQFunction dqf, CeedQFunction dqfT, 479 CeedOperator *op); 480 CEED_EXTERN int CeedCompositeOperatorCreate(Ceed ceed, CeedOperator *op); 481 CEED_EXTERN int CeedOperatorSetField(CeedOperator op, const char *fieldname, 482 CeedElemRestriction r, CeedBasis b, 483 CeedVector v); 484 CEED_EXTERN int CeedCompositeOperatorAddSub(CeedOperator compositeop, 485 CeedOperator subop); 486 CEED_EXTERN int CeedOperatorAssembleLinearQFunction(CeedOperator op, 487 CeedVector *assembled, CeedElemRestriction *rstr, CeedRequest *request); 488 CEED_EXTERN int CeedOperatorAssembleLinearDiagonal(CeedOperator op, 489 CeedVector *assembled, CeedRequest *request); 490 CEED_EXTERN int CeedOperatorCreateFDMElementInverse(CeedOperator op, 491 CeedOperator *fdminv, CeedRequest *request); 492 CEED_EXTERN int CeedOperatorView(CeedOperator op, FILE *stream); 493 CEED_EXTERN int CeedOperatorApply(CeedOperator op, CeedVector in, 494 CeedVector out, CeedRequest *request); 495 CEED_EXTERN int CeedOperatorApplyAdd(CeedOperator op, CeedVector in, 496 CeedVector out, CeedRequest *request); 497 CEED_EXTERN int CeedOperatorDestroy(CeedOperator *op); 498 499 /** 500 @brief Return integer power 501 502 @param[in] base The base to exponentiate 503 @param[in] power The power to raise the base to 504 505 @return base^power 506 507 @ref Utility 508 **/ 509 static inline CeedInt CeedIntPow(CeedInt base, CeedInt power) { 510 CeedInt result = 1; 511 while (power) { 512 if (power & 1) result *= base; 513 power >>= 1; 514 base *= base; 515 } 516 return result; 517 } 518 519 /** 520 @brief Return minimum of two integers 521 522 @param[in] a The first integer to compare 523 @param[in] b The second integer to compare 524 525 @return The minimum of the two integers 526 527 @ref Utility 528 **/ 529 static inline CeedInt CeedIntMin(CeedInt a, CeedInt b) { return a < b ? a : b; } 530 531 #endif 532