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 /// libCEED library version numbering 194 /// @ingroup Ceed 195 #define CEED_VERSION_MAJOR 0 196 #define CEED_VERSION_MINOR 7 197 #define CEED_VERSION_PATCH 0 198 #define CEED_VERSION_RELEASE false 199 200 /// Compile-time check that the the current library version is at least as 201 /// recent as the specified version. This macro is typically used in 202 /// @code 203 /// #if CEED_VERSION_GE(0, 8, 0) 204 /// code path that needs at least 0.8.0 205 /// #else 206 /// fallback code for older versions 207 /// #endif 208 /// @endcode 209 /// 210 /// A non-release version always compares as positive infinity. 211 /// 212 /// @param major Major version 213 /// @param minor Minor version 214 /// @param patch Patch (subminor) version 215 /// 216 /// @ingroup Ceed 217 /// @sa CeedGetVersion() 218 #define CEED_VERSION_GE(major, minor, patch) \ 219 (!CEED_VERSION_RELEASE || \ 220 (CEED_VERSION_MAJOR > major || \ 221 (CEED_VERSION_MAJOR == major && \ 222 (CEED_VERSION_MINOR > minor || \ 223 (CEED_VERSION_MINOR == minor && CEED_VERSION_PATCH >= patch))))) 224 225 CEED_EXTERN int CeedGetVersion(int *major, int *minor, int *patch, 226 bool *release); 227 228 /// Specify memory type 229 /// 230 /// Many Ceed interfaces take or return pointers to memory. This enum is used to 231 /// specify where the memory being provided or requested must reside. 232 /// @ingroup Ceed 233 typedef enum { 234 /// Memory resides on the host 235 CEED_MEM_HOST, 236 /// Memory resides on a device (corresponding to \ref Ceed resource) 237 CEED_MEM_DEVICE, 238 } CeedMemType; 239 240 CEED_EXTERN const char *const CeedMemTypes[]; 241 242 CEED_EXTERN int CeedGetPreferredMemType(Ceed ceed, CeedMemType *type); 243 244 /// Conveys ownership status of arrays passed to Ceed interfaces. 245 /// @ingroup Ceed 246 typedef enum { 247 /// Implementation will copy the values and not store the passed pointer. 248 CEED_COPY_VALUES, 249 /// Implementation can use and modify the data provided by the user, but does 250 /// not take ownership. 251 CEED_USE_POINTER, 252 /// Implementation takes ownership of the pointer and will free using 253 /// CeedFree() when done using it. The user should not assume that the 254 /// pointer remains valid after ownership has been transferred. Note that 255 /// arrays allocated using C++ operator new or other allocators cannot 256 /// generally be freed using CeedFree(). CeedFree() is capable of freeing any 257 /// memory that can be freed using free(3). 258 CEED_OWN_POINTER, 259 } CeedCopyMode; 260 261 /// Denotes type of vector norm to be computed 262 /// @ingroup CeedVector 263 typedef enum { 264 /// L_1 norm: sum_i |x_i| 265 CEED_NORM_1, 266 /// L_2 norm: sqrt(sum_i |x_i|^2) 267 CEED_NORM_2, 268 /// L_Infinity norm: max_i |x_i| 269 CEED_NORM_MAX, 270 } CeedNormType; 271 272 CEED_EXTERN const char *const CeedCopyModes[]; 273 274 CEED_EXTERN int CeedVectorCreate(Ceed ceed, CeedInt len, CeedVector *vec); 275 CEED_EXTERN int CeedVectorSetArray(CeedVector vec, CeedMemType mtype, 276 CeedCopyMode cmode, CeedScalar *array); 277 CEED_EXTERN int CeedVectorSetValue(CeedVector vec, CeedScalar value); 278 CEED_EXTERN int CeedVectorSyncArray(CeedVector vec, CeedMemType mtype); 279 CEED_EXTERN int CeedVectorTakeArray(CeedVector vec, CeedMemType mtype, 280 CeedScalar **array); 281 CEED_EXTERN int CeedVectorGetArray(CeedVector vec, CeedMemType mtype, 282 CeedScalar **array); 283 CEED_EXTERN int CeedVectorGetArrayRead(CeedVector vec, CeedMemType mtype, 284 const CeedScalar **array); 285 CEED_EXTERN int CeedVectorRestoreArray(CeedVector vec, CeedScalar **array); 286 CEED_EXTERN int CeedVectorRestoreArrayRead(CeedVector vec, 287 const CeedScalar **array); 288 CEED_EXTERN int CeedVectorNorm(CeedVector vec, CeedNormType type, 289 CeedScalar *norm); 290 CEED_EXTERN int CeedVectorReciprocal(CeedVector vec); 291 CEED_EXTERN int CeedVectorView(CeedVector vec, const char *fpfmt, FILE *stream); 292 CEED_EXTERN int CeedVectorGetLength(CeedVector vec, CeedInt *length); 293 CEED_EXTERN int CeedVectorDestroy(CeedVector *vec); 294 295 CEED_EXTERN CeedRequest *const CEED_REQUEST_IMMEDIATE; 296 CEED_EXTERN CeedRequest *const CEED_REQUEST_ORDERED; 297 CEED_EXTERN int CeedRequestWait(CeedRequest *req); 298 299 /// Argument for CeedOperatorSetField that vector is collocated with 300 /// quadrature points, used with QFunction eval mode CEED_EVAL_NONE 301 /// or CEED_EVAL_INTERP only, not with CEED_EVAL_GRAD, CEED_EVAL_DIV, 302 /// or CEED_EVAL_CURL 303 /// @ingroup CeedBasis 304 CEED_EXTERN const CeedBasis CEED_BASIS_COLLOCATED; 305 306 /// Argument for CeedOperatorSetField to use active input or output 307 /// @ingroup CeedVector 308 CEED_EXTERN const CeedVector CEED_VECTOR_ACTIVE; 309 310 /// Argument for CeedOperatorSetField to use no vector, used with 311 /// qfunction input with eval mode CEED_EVAL_WEIGHT 312 /// @ingroup CeedVector 313 CEED_EXTERN const CeedVector CEED_VECTOR_NONE; 314 315 /// Argument for CeedOperatorSetField to use no ElemRestriction, only used with 316 /// eval mode CEED_EVAL_WEIGHT. 317 /// @ingroup CeedElemRestriction 318 CEED_EXTERN const CeedElemRestriction CEED_ELEMRESTRICTION_NONE; 319 320 /// Argument for CeedOperatorCreate that QFunction is not created by user. 321 /// Only used for QFunctions dqf and dqfT. If implemented, a backend may 322 /// attempt to provide the action of these QFunctions. 323 /// @ingroup CeedQFunction 324 CEED_EXTERN const CeedQFunction CEED_QFUNCTION_NONE; 325 326 /// Denotes whether a linear transformation or its transpose should be applied 327 /// @ingroup CeedBasis 328 typedef enum { 329 /// Apply the linear transformation 330 CEED_NOTRANSPOSE, 331 /// Apply the transpose 332 CEED_TRANSPOSE 333 } CeedTransposeMode; 334 335 CEED_EXTERN const char *const CeedTransposeModes[]; 336 337 /// Argument for CeedElemRestrictionCreateStrided that L-vector is in 338 /// the Ceed backend's preferred layout. This argument should only be used 339 /// with vectors created by a Ceed backend. 340 /// @ingroup CeedElemRestriction 341 CEED_EXTERN const CeedInt CEED_STRIDES_BACKEND[3]; 342 343 CEED_EXTERN int CeedElemRestrictionCreate(Ceed ceed, CeedInt nelem, 344 CeedInt elemsize, CeedInt ncomp, CeedInt compstride, CeedInt lsize, 345 CeedMemType mtype, CeedCopyMode cmode, const CeedInt *offsets, 346 CeedElemRestriction *rstr); 347 CEED_EXTERN int CeedElemRestrictionCreateStrided(Ceed ceed, 348 CeedInt nelem, CeedInt elemsize, CeedInt ncomp, CeedInt lsize, 349 const CeedInt strides[3], CeedElemRestriction *rstr); 350 CEED_EXTERN int CeedElemRestrictionCreateBlocked(Ceed ceed, CeedInt nelem, 351 CeedInt elemsize, CeedInt blksize, CeedInt ncomp, CeedInt compstride, 352 CeedInt lsize, CeedMemType mtype, CeedCopyMode cmode, 353 const CeedInt *offsets, CeedElemRestriction *rstr); 354 CEED_EXTERN int CeedElemRestrictionCreateBlockedStrided(Ceed ceed, 355 CeedInt nelem, CeedInt elemsize, CeedInt blksize, CeedInt ncomp, 356 CeedInt lsize, const CeedInt strides[3], CeedElemRestriction *rstr); 357 CEED_EXTERN int CeedElemRestrictionCreateVector(CeedElemRestriction rstr, 358 CeedVector *lvec, CeedVector *evec); 359 CEED_EXTERN int CeedElemRestrictionApply(CeedElemRestriction rstr, 360 CeedTransposeMode tmode, CeedVector u, CeedVector ru, CeedRequest *request); 361 CEED_EXTERN int CeedElemRestrictionApplyBlock(CeedElemRestriction rstr, 362 CeedInt block, CeedTransposeMode tmode, CeedVector u, CeedVector ru, 363 CeedRequest *request); 364 CEED_EXTERN int CeedElemRestrictionGetCompStride(CeedElemRestriction rstr, 365 CeedInt *compstride); 366 CEED_EXTERN int CeedElemRestrictionGetNumElements(CeedElemRestriction rstr, 367 CeedInt *numelem); 368 CEED_EXTERN int CeedElemRestrictionGetElementSize(CeedElemRestriction rstr, 369 CeedInt *elemsize); 370 CEED_EXTERN int CeedElemRestrictionGetLVectorSize(CeedElemRestriction rstr, 371 CeedInt *lsize); 372 CEED_EXTERN int CeedElemRestrictionGetNumComponents(CeedElemRestriction rstr, 373 CeedInt *numcomp); 374 CEED_EXTERN int CeedElemRestrictionGetNumBlocks(CeedElemRestriction rstr, 375 CeedInt *numblk); 376 CEED_EXTERN int CeedElemRestrictionGetBlockSize(CeedElemRestriction rstr, 377 CeedInt *blksize); 378 CEED_EXTERN int CeedElemRestrictionGetMultiplicity(CeedElemRestriction rstr, 379 CeedVector mult); 380 CEED_EXTERN int CeedElemRestrictionView(CeedElemRestriction rstr, FILE *stream); 381 CEED_EXTERN int CeedElemRestrictionDestroy(CeedElemRestriction *rstr); 382 383 // The formalism here is that we have the structure 384 // \int_\Omega v^T f_0(u, \nabla u, qdata) + (\nabla v)^T f_1(u, \nabla u, qdata) 385 // where gradients are with respect to the reference element. 386 387 /// Basis evaluation mode 388 /// 389 /// Modes can be bitwise ORed when passing to most functions. 390 /// @ingroup CeedBasis 391 typedef enum { 392 /// Perform no evaluation (either because there is no data or it is already at 393 /// quadrature points) 394 CEED_EVAL_NONE = 0, 395 /// Interpolate from nodes to quadrature points 396 CEED_EVAL_INTERP = 1, 397 /// Evaluate gradients at quadrature points from input in a nodal basis 398 CEED_EVAL_GRAD = 2, 399 /// Evaluate divergence at quadrature points from input in a nodal basis 400 CEED_EVAL_DIV = 4, 401 /// Evaluate curl at quadrature points from input in a nodal basis 402 CEED_EVAL_CURL = 8, 403 /// Using no input, evaluate quadrature weights on the reference element 404 CEED_EVAL_WEIGHT = 16, 405 } CeedEvalMode; 406 407 CEED_EXTERN const char *const CeedEvalModes[]; 408 409 /// Type of quadrature; also used for location of nodes 410 /// @ingroup CeedBasis 411 typedef enum { 412 /// Gauss-Legendre quadrature 413 CEED_GAUSS = 0, 414 /// Gauss-Legendre-Lobatto quadrature 415 CEED_GAUSS_LOBATTO = 1, 416 } CeedQuadMode; 417 418 CEED_EXTERN const char *const CeedQuadModes[]; 419 420 /// Type of basis shape to create non-tensor H1 element basis 421 /// 422 /// Dimension can be extracted with bitwise AND 423 /// (CeedElemTopology & 2**(dim + 2)) == TRUE 424 /// @ingroup CeedBasis 425 typedef enum { 426 /// Line 427 CEED_LINE = 1 << 16 | 0, 428 /// Triangle - 2D shape 429 CEED_TRIANGLE = 2 << 16 | 1, 430 /// Quadralateral - 2D shape 431 CEED_QUAD = 2 << 16 | 2, 432 /// Tetrahedron - 3D shape 433 CEED_TET = 3 << 16 | 3, 434 /// Pyramid - 3D shape 435 CEED_PYRAMID = 3 << 16 | 4, 436 /// Prism - 3D shape 437 CEED_PRISM = 3 << 16 | 5, 438 /// Hexehedron - 3D shape 439 CEED_HEX = 3 << 16 | 6, 440 } CeedElemTopology; 441 442 CEED_EXTERN const char *const CeedElemTopologies[]; 443 444 CEED_EXTERN int CeedBasisCreateTensorH1Lagrange(Ceed ceed, CeedInt dim, 445 CeedInt ncomp, CeedInt P, CeedInt Q, CeedQuadMode qmode, CeedBasis *basis); 446 CEED_EXTERN int CeedBasisCreateTensorH1(Ceed ceed, CeedInt dim, CeedInt ncomp, 447 CeedInt P1d, CeedInt Q1d, 448 const CeedScalar *interp1d, 449 const CeedScalar *grad1d, 450 const CeedScalar *qref1d, 451 const CeedScalar *qweight1d, 452 CeedBasis *basis); 453 CEED_EXTERN int CeedBasisCreateH1(Ceed ceed, CeedElemTopology topo, 454 CeedInt ncomp, 455 CeedInt nnodes, CeedInt nqpts, 456 const CeedScalar *interp, 457 const CeedScalar *grad, 458 const CeedScalar *qref, 459 const CeedScalar *qweight, CeedBasis *basis); 460 CEED_EXTERN int CeedBasisView(CeedBasis basis, FILE *stream); 461 CEED_EXTERN int CeedBasisApply(CeedBasis basis, CeedInt nelem, 462 CeedTransposeMode tmode, 463 CeedEvalMode emode, CeedVector u, CeedVector v); 464 CEED_EXTERN int CeedBasisGetDimension(CeedBasis basis, CeedInt *dim); 465 CEED_EXTERN int CeedBasisGetTopology(CeedBasis basis, CeedElemTopology *topo); 466 CEED_EXTERN int CeedBasisGetNumComponents(CeedBasis basis, CeedInt *numcomp); 467 CEED_EXTERN int CeedBasisGetNumNodes(CeedBasis basis, CeedInt *P); 468 CEED_EXTERN int CeedBasisGetNumNodes1D(CeedBasis basis, CeedInt *P1d); 469 CEED_EXTERN int CeedBasisGetNumQuadraturePoints(CeedBasis basis, CeedInt *Q); 470 CEED_EXTERN int CeedBasisGetNumQuadraturePoints1D(CeedBasis basis, 471 CeedInt *Q1d); 472 CEED_EXTERN int CeedBasisGetQRef(CeedBasis basis, const CeedScalar **qref); 473 CEED_EXTERN int CeedBasisGetQWeights(CeedBasis basis, 474 const CeedScalar **qweight); 475 CEED_EXTERN int CeedBasisGetInterp(CeedBasis basis, const CeedScalar **interp); 476 CEED_EXTERN int CeedBasisGetInterp1D(CeedBasis basis, 477 const CeedScalar **interp1d); 478 CEED_EXTERN int CeedBasisGetGrad(CeedBasis basis, const CeedScalar **grad); 479 CEED_EXTERN int CeedBasisGetGrad1D(CeedBasis basis, const CeedScalar **grad1d); 480 CEED_EXTERN int CeedBasisDestroy(CeedBasis *basis); 481 482 CEED_EXTERN int CeedGaussQuadrature(CeedInt Q, CeedScalar *qref1d, 483 CeedScalar *qweight1d); 484 CEED_EXTERN int CeedLobattoQuadrature(CeedInt Q, CeedScalar *qref1d, 485 CeedScalar *qweight1d); 486 CEED_EXTERN int CeedQRFactorization(Ceed ceed, CeedScalar *mat, CeedScalar *tau, 487 CeedInt m, CeedInt n); 488 CEED_EXTERN int CeedSymmetricSchurDecomposition(Ceed ceed, CeedScalar *mat, 489 CeedScalar *lambda, CeedInt n); 490 CEED_EXTERN int CeedSimultaneousDiagonalization(Ceed ceed, CeedScalar *matA, 491 CeedScalar *matB, CeedScalar *x, CeedScalar *lambda, CeedInt n); 492 493 /** Handle for the object describing the user CeedQFunction 494 495 @param ctx user-defined context set using CeedQFunctionSetContext() or NULL 496 497 @param Q number of quadrature points at which to evaluate 498 499 @param in array of pointers to each input argument in the order provided 500 by the user in CeedQFunctionAddInput(). Each array has shape 501 `[dim, ncomp, Q]` where `dim` is the geometric dimension for 502 \ref CEED_EVAL_GRAD (`dim=1` for \ref CEED_EVAL_INTERP) and 503 `ncomp` is the number of field components (`ncomp=1` for 504 scalar fields). This results in indexing the `i`th input at 505 quadrature point `j` as `in[i][(d*ncomp + c)*Q + j]`. 506 507 @param out array of pointers to each output array in the order provided 508 using CeedQFunctionAddOutput(). The shapes are as above for 509 \a in. 510 511 @return An error code: 0 - success, otherwise - failure 512 513 @ingroup CeedQFunction 514 **/ 515 typedef int (*CeedQFunctionUser)(void *ctx, const CeedInt Q, 516 const CeedScalar *const *in, 517 CeedScalar *const *out); 518 519 CEED_EXTERN int CeedQFunctionCreateInterior(Ceed ceed, CeedInt vlength, 520 CeedQFunctionUser f, const char *source, CeedQFunction *qf); 521 CEED_EXTERN int CeedQFunctionCreateInteriorByName(Ceed ceed, const char *name, 522 CeedQFunction *qf); 523 CEED_EXTERN int CeedQFunctionCreateIdentity(Ceed ceed, CeedInt size, 524 CeedEvalMode inmode, CeedEvalMode outmode, CeedQFunction *qf); 525 CEED_EXTERN int CeedQFunctionAddInput(CeedQFunction qf, const char *fieldname, 526 CeedInt size, CeedEvalMode emode); 527 CEED_EXTERN int CeedQFunctionAddOutput(CeedQFunction qf, const char *fieldname, 528 CeedInt size, CeedEvalMode emode); 529 CEED_EXTERN int CeedQFunctionSetContext(CeedQFunction qf, 530 CeedQFunctionContext ctx); 531 CEED_EXTERN int CeedQFunctionView(CeedQFunction qf, FILE *stream); 532 CEED_EXTERN int CeedQFunctionApply(CeedQFunction qf, CeedInt Q, 533 CeedVector *u, CeedVector *v); 534 CEED_EXTERN int CeedQFunctionDestroy(CeedQFunction *qf); 535 536 CEED_EXTERN int CeedQFunctionContextCreate(Ceed ceed, 537 CeedQFunctionContext *ctx); 538 CEED_EXTERN int CeedQFunctionContextSetData(CeedQFunctionContext ctx, 539 CeedMemType mtype, CeedCopyMode cmode, size_t size, void *data); 540 CEED_EXTERN int CeedQFunctionContextGetData(CeedQFunctionContext ctx, 541 CeedMemType mtype, 542 void *data); 543 CEED_EXTERN int CeedQFunctionContextRestoreData(CeedQFunctionContext ctx, 544 void *data); 545 CEED_EXTERN int CeedQFunctionContextView(CeedQFunctionContext ctx, 546 FILE *stream); 547 CEED_EXTERN int CeedQFunctionContextDestroy(CeedQFunctionContext *ctx); 548 549 CEED_EXTERN int CeedOperatorCreate(Ceed ceed, CeedQFunction qf, 550 CeedQFunction dqf, CeedQFunction dqfT, 551 CeedOperator *op); 552 CEED_EXTERN int CeedCompositeOperatorCreate(Ceed ceed, CeedOperator *op); 553 CEED_EXTERN int CeedOperatorSetField(CeedOperator op, const char *fieldname, 554 CeedElemRestriction r, CeedBasis b, 555 CeedVector v); 556 CEED_EXTERN int CeedCompositeOperatorAddSub(CeedOperator compositeop, 557 CeedOperator subop); 558 CEED_EXTERN int CeedOperatorLinearAssembleQFunction(CeedOperator op, 559 CeedVector *assembled, CeedElemRestriction *rstr, CeedRequest *request); 560 CEED_EXTERN int CeedOperatorLinearAssembleDiagonal(CeedOperator op, 561 CeedVector assembled, CeedRequest *request); 562 CEED_EXTERN int CeedOperatorLinearAssembleAddDiagonal(CeedOperator op, 563 CeedVector assembled, CeedRequest *request); 564 CEED_EXTERN int CeedOperatorLinearAssemblePointBlockDiagonal(CeedOperator op, 565 CeedVector assembled, CeedRequest *request); 566 CEED_EXTERN int CeedOperatorLinearAssembleAddPointBlockDiagonal(CeedOperator op, 567 CeedVector assembled, CeedRequest *request); 568 CEED_EXTERN int CeedOperatorMultigridLevelCreate(CeedOperator opFine, 569 CeedVector PMultFine, CeedElemRestriction rstrCoarse, CeedBasis basisCoarse, 570 CeedOperator *opCoarse, CeedOperator *opProlong, CeedOperator *opRestrict); 571 CEED_EXTERN int CeedOperatorMultigridLevelCreateTensorH1( 572 CeedOperator opFine, CeedVector PMultFine, CeedElemRestriction rstrCoarse, 573 CeedBasis basisCoarse, const CeedScalar *interpCtoF, CeedOperator *opCoarse, 574 CeedOperator *opProlong, CeedOperator *opRestrict); 575 CEED_EXTERN int CeedOperatorMultigridLevelCreateH1(CeedOperator opFine, 576 CeedVector PMultFine, CeedElemRestriction rstrCoarse, CeedBasis basisCoarse, 577 const CeedScalar *interpCtoF, CeedOperator *opCoarse, 578 CeedOperator *opProlong, CeedOperator *opRestrict); 579 CEED_EXTERN int CeedOperatorCreateFDMElementInverse(CeedOperator op, 580 CeedOperator *fdminv, CeedRequest *request); 581 CEED_EXTERN int CeedOperatorView(CeedOperator op, FILE *stream); 582 CEED_EXTERN int CeedOperatorApply(CeedOperator op, CeedVector in, 583 CeedVector out, CeedRequest *request); 584 CEED_EXTERN int CeedOperatorApplyAdd(CeedOperator op, CeedVector in, 585 CeedVector out, CeedRequest *request); 586 CEED_EXTERN int CeedOperatorDestroy(CeedOperator *op); 587 588 /** 589 @brief Return integer power 590 591 @param[in] base The base to exponentiate 592 @param[in] power The power to raise the base to 593 594 @return base^power 595 596 @ref Utility 597 **/ 598 static inline CeedInt CeedIntPow(CeedInt base, CeedInt power) { 599 CeedInt result = 1; 600 while (power) { 601 if (power & 1) result *= base; 602 power >>= 1; 603 base *= base; 604 } 605 return result; 606 } 607 608 /** 609 @brief Return minimum of two integers 610 611 @param[in] a The first integer to compare 612 @param[in] b The second integer to compare 613 614 @return The minimum of the two integers 615 616 @ref Utility 617 **/ 618 static inline CeedInt CeedIntMin(CeedInt a, CeedInt b) { return a < b ? a : b; } 619 620 /** 621 @brief Return maximum of two integers 622 623 @param[in] a The first integer to compare 624 @param[in] b The second integer to compare 625 626 @return The maximum of the two integers 627 628 @ref Utility 629 **/ 630 static inline CeedInt CeedIntMax(CeedInt a, CeedInt b) { return a > b ? a : b; } 631 632 // Used to ensure initialization before CeedInit() 633 CEED_EXTERN int CeedRegisterAll(void); 634 // Used to ensure initialization before CeedQFunctionCreate*() 635 CEED_EXTERN int CeedQFunctionRegisterAll(void); 636 637 #endif 638