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