1ec3da8bcSJed Brown /// Copyright (c) 2017, Lawrence Livermore National Security, LLC. Produced at 2ec3da8bcSJed Brown /// the Lawrence Livermore National Laboratory. LLNL-CODE-734707. All Rights 3ec3da8bcSJed Brown /// reserved. See files LICENSE and NOTICE for details. 4ec3da8bcSJed Brown /// 5ec3da8bcSJed Brown /// This file is part of CEED, a collection of benchmarks, miniapps, software 6ec3da8bcSJed Brown /// libraries and APIs for efficient high-order finite element and spectral 7ec3da8bcSJed Brown /// element discretizations for exascale applications. For more information and 8ec3da8bcSJed Brown /// source code availability see http://github.com/ceed. 9ec3da8bcSJed Brown /// 10ec3da8bcSJed Brown /// The CEED research is supported by the Exascale Computing Project 17-SC-20-SC, 11ec3da8bcSJed Brown /// a collaborative effort of two U.S. Department of Energy organizations (Office 12ec3da8bcSJed Brown /// of Science and the National Nuclear Security Administration) responsible for 13ec3da8bcSJed Brown /// the planning and preparation of a capable exascale ecosystem, including 14ec3da8bcSJed Brown /// software, applications, hardware, advanced system engineering and early 15ec3da8bcSJed Brown /// testbed platforms, in support of the nation's exascale computing imperative. 16ec3da8bcSJed Brown 17ec3da8bcSJed Brown /// @file 18ec3da8bcSJed Brown /// Public header for user and utility components of libCEED 19ec3da8bcSJed Brown #ifndef _ceed_h 20ec3da8bcSJed Brown #define _ceed_h 21ec3da8bcSJed Brown 22ec3da8bcSJed Brown /// @defgroup Ceed Ceed: core components 23ec3da8bcSJed Brown /// @defgroup CeedVector CeedVector: storing and manipulating vectors 24ec3da8bcSJed Brown /// @defgroup CeedElemRestriction CeedElemRestriction: restriction from local vectors to elements 25ec3da8bcSJed Brown /// @defgroup CeedBasis CeedBasis: fully discrete finite element-like objects 26ec3da8bcSJed Brown /// @defgroup CeedQFunction CeedQFunction: independent operations at quadrature points 27ec3da8bcSJed Brown /// @defgroup CeedOperator CeedOperator: composed FE-type operations on vectors 28ec3da8bcSJed Brown /// 29ec3da8bcSJed Brown /// @page FunctionCategories libCEED: Types of Functions 30ec3da8bcSJed Brown /// libCEED provides three different header files depending upon the type of 31ec3da8bcSJed Brown /// functions a user requires. 32ec3da8bcSJed Brown /// @section Utility Utility Functions 33ec3da8bcSJed Brown /// These functions are intended general utilities that may be useful to 34ec3da8bcSJed Brown /// libCEED developers and users. These functions can generally be found in 35ec3da8bcSJed Brown /// "ceed.h". 36ec3da8bcSJed Brown /// @section User User Functions 37ec3da8bcSJed Brown /// These functions are intended to be used by general users of libCEED 38ec3da8bcSJed Brown /// and can generally be found in "ceed.h". 39ec3da8bcSJed Brown /// @section Backend Backend Developer Functions 40ec3da8bcSJed Brown /// These functions are intended to be used by backend developers of 41ec3da8bcSJed Brown /// libCEED and can generally be found in "ceed-backend.h". 42ec3da8bcSJed Brown /// @section Developer Library Developer Functions 43ec3da8bcSJed Brown /// These functions are intended to be used by library developers of 44ec3da8bcSJed Brown /// libCEED and can generally be found in "ceed-impl.h". 45ec3da8bcSJed Brown 46ec3da8bcSJed Brown /** 47ec3da8bcSJed Brown CEED_EXTERN is used in this header to denote all publicly visible symbols. 48ec3da8bcSJed Brown 49ec3da8bcSJed Brown No other file should declare publicly visible symbols, thus it should never be 50ec3da8bcSJed Brown used outside ceed.h. 51ec3da8bcSJed Brown */ 52ec3da8bcSJed Brown #ifdef __cplusplus 53ec3da8bcSJed Brown # define CEED_EXTERN extern "C" 54ec3da8bcSJed Brown #else 55ec3da8bcSJed Brown # define CEED_EXTERN extern 56ec3da8bcSJed Brown #endif 57ec3da8bcSJed Brown 58ec3da8bcSJed Brown /** 59ec3da8bcSJed Brown @ingroup CeedQFunction 60ec3da8bcSJed Brown This macro populates the correct function annotations for User QFunction 61ec3da8bcSJed Brown source for code generation backends or populates default values for CPU 62ec3da8bcSJed Brown backends. 63ec3da8bcSJed Brown **/ 64ec3da8bcSJed Brown #ifndef CEED_QFUNCTION 65ec3da8bcSJed Brown #define CEED_QFUNCTION(name) \ 66ec3da8bcSJed Brown static const char name ## _loc[] = __FILE__ ":" #name; \ 67ec3da8bcSJed Brown static int name 68ec3da8bcSJed Brown #endif 69ec3da8bcSJed Brown 70ec3da8bcSJed Brown /** 71ec3da8bcSJed Brown @ingroup CeedQFunction 72ec3da8bcSJed Brown Using VLA syntax to reshape User QFunction inputs and outputs can make 73ec3da8bcSJed Brown user code more readable. VLA is a C99 feature that is not supported by 74ec3da8bcSJed Brown the C++ dialect used by CUDA. This macro allows users to use the VLA 75ec3da8bcSJed Brown syntax with the CUDA backends. 76ec3da8bcSJed Brown **/ 77ec3da8bcSJed Brown #ifndef CEED_Q_VLA 78ec3da8bcSJed Brown # define CEED_Q_VLA Q 79ec3da8bcSJed Brown #endif 80ec3da8bcSJed Brown 81ec3da8bcSJed Brown /** 82ec3da8bcSJed Brown @ingroup Ceed 83ec3da8bcSJed Brown This macro provides the appropriate SIMD Pragma for the compilation 84ec3da8bcSJed Brown environment. Code generation backends may redefine this macro, as needed. 85ec3da8bcSJed Brown **/ 86ec3da8bcSJed Brown #ifndef CeedPragmaSIMD 87ec3da8bcSJed Brown # if defined(__INTEL_COMPILER) 88ec3da8bcSJed Brown # define CeedPragmaSIMD _Pragma("vector") 89ec3da8bcSJed Brown // Cannot use Intel pragma ivdep because it miscompiles unpacking symmetric tensors, as in 90ec3da8bcSJed Brown // Poisson2DApply, where the SIMD loop body contains temporaries such as the following. 91ec3da8bcSJed Brown // 92ec3da8bcSJed Brown // const CeedScalar dXdxdXdxT[2][2] = {{qd[i+0*Q], qd[i+2*Q]}, 93ec3da8bcSJed Brown // {qd[i+2*Q], qd[i+1*Q]}}; 94ec3da8bcSJed Brown // for (int j=0; j<2; j++) 95ec3da8bcSJed Brown // vg[i+j*Q] = (du[0] * dXdxdXdxT[0][j] + du[1] * dXdxdXdxT[1][j]); 96ec3da8bcSJed Brown // 97ec3da8bcSJed Brown // Miscompilation with pragma ivdep observed with icc (ICC) 19.0.5.281 20190815 98ec3da8bcSJed Brown // at -O2 and above. 99ec3da8bcSJed Brown # elif defined(__GNUC__) && __GNUC__ >= 5 100ec3da8bcSJed Brown # define CeedPragmaSIMD _Pragma("GCC ivdep") 101ec3da8bcSJed Brown # elif defined(_OPENMP) && _OPENMP >= 201307 // OpenMP-4.0 (July, 2013) 102ec3da8bcSJed Brown # define CeedPragmaSIMD _Pragma("omp simd") 103ec3da8bcSJed Brown # else 104ec3da8bcSJed Brown # define CeedPragmaSIMD 105ec3da8bcSJed Brown # endif 106ec3da8bcSJed Brown #endif 107ec3da8bcSJed Brown 108ec3da8bcSJed Brown #include <stdint.h> 109ec3da8bcSJed Brown #include <stdarg.h> 110ec3da8bcSJed Brown #include <stdio.h> 111ec3da8bcSJed Brown #include <stdbool.h> 112ec3da8bcSJed Brown 113ec3da8bcSJed Brown /// Integer type, used for indexing 114ec3da8bcSJed Brown /// @ingroup Ceed 115ec3da8bcSJed Brown typedef int32_t CeedInt; 116ec3da8bcSJed Brown /// Scalar (floating point) type 117ec3da8bcSJed Brown /// @ingroup Ceed 118ec3da8bcSJed Brown typedef double CeedScalar; 119ec3da8bcSJed Brown 120ec3da8bcSJed Brown /// Library context created by CeedInit() 121ec3da8bcSJed Brown /// @ingroup CeedUser 122ec3da8bcSJed Brown typedef struct Ceed_private *Ceed; 123ec3da8bcSJed Brown /// Non-blocking Ceed interfaces return a CeedRequest. 124ec3da8bcSJed Brown /// To perform an operation immediately, pass \ref CEED_REQUEST_IMMEDIATE instead. 125ec3da8bcSJed Brown /// @ingroup CeedUser 126ec3da8bcSJed Brown typedef struct CeedRequest_private *CeedRequest; 127ec3da8bcSJed Brown /// Handle for vectors over the field \ref CeedScalar 128ec3da8bcSJed Brown /// @ingroup CeedVectorUser 129ec3da8bcSJed Brown typedef struct CeedVector_private *CeedVector; 130ec3da8bcSJed Brown /// Handle for object describing restriction to elements 131ec3da8bcSJed Brown /// @ingroup CeedElemRestrictionUser 132ec3da8bcSJed Brown typedef struct CeedElemRestriction_private *CeedElemRestriction; 133ec3da8bcSJed Brown /// Handle for object describing discrete finite element evaluations 134ec3da8bcSJed Brown /// @ingroup CeedBasisUser 135ec3da8bcSJed Brown typedef struct CeedBasis_private *CeedBasis; 136ec3da8bcSJed Brown /// Handle for object describing functions evaluated independently at quadrature points 137ec3da8bcSJed Brown /// @ingroup CeedQFunctionUser 138ec3da8bcSJed Brown typedef struct CeedQFunction_private *CeedQFunction; 139ec3da8bcSJed Brown /// Handle for object describing context data for CeedQFunctions 140ec3da8bcSJed Brown /// @ingroup CeedQFunctionUser 141ec3da8bcSJed Brown typedef struct CeedQFunctionContext_private *CeedQFunctionContext; 142ec3da8bcSJed Brown /// Handle for object describing FE-type operators acting on vectors 143ec3da8bcSJed Brown /// 144ec3da8bcSJed Brown /// Given an element restriction \f$E\f$, basis evaluator \f$B\f$, and 145ec3da8bcSJed Brown /// quadrature function\f$f\f$, a CeedOperator expresses operations of the form 146ec3da8bcSJed Brown /// $$ E^T B^T f(B E u) $$ 147ec3da8bcSJed Brown /// acting on the vector \f$u\f$. 148ec3da8bcSJed Brown /// @ingroup CeedOperatorUser 149ec3da8bcSJed Brown typedef struct CeedOperator_private *CeedOperator; 150ec3da8bcSJed Brown 15122e44211Sjeremylt CEED_EXTERN int CeedRegistryGetList(size_t *n, char ***const resources, CeedInt **array); 152ec3da8bcSJed Brown CEED_EXTERN int CeedInit(const char *resource, Ceed *ceed); 1539560d06aSjeremylt CEED_EXTERN int CeedReferenceCopy(Ceed ceed, Ceed *ceed_copy); 154ec3da8bcSJed Brown CEED_EXTERN int CeedGetResource(Ceed ceed, const char **resource); 155d1d35e2fSjeremylt CEED_EXTERN int CeedIsDeterministic(Ceed ceed, bool *is_deterministic); 156ec3da8bcSJed Brown CEED_EXTERN int CeedView(Ceed ceed, FILE *stream); 157ec3da8bcSJed Brown CEED_EXTERN int CeedDestroy(Ceed *ceed); 158ec3da8bcSJed Brown 159ec3da8bcSJed Brown CEED_EXTERN int CeedErrorImpl(Ceed, const char *, int, const char *, int, 160ec3da8bcSJed Brown const char *, ...); 161ec3da8bcSJed Brown /// Raise an error on ceed object 162ec3da8bcSJed Brown /// 163ec3da8bcSJed Brown /// @param ceed Ceed library context or NULL 164ec3da8bcSJed Brown /// @param ecode Error code (int) 165ec3da8bcSJed Brown /// @param ... printf-style format string followed by arguments as needed 166ec3da8bcSJed Brown /// 167ec3da8bcSJed Brown /// @ingroup Ceed 168ec3da8bcSJed Brown /// @sa CeedSetErrorHandler() 169ec3da8bcSJed Brown #if defined(__clang__) 170ec3da8bcSJed Brown /// Use nonstandard ternary to convince the compiler/clang-tidy that this 171ec3da8bcSJed Brown /// function never returns zero. 172ec3da8bcSJed Brown # define CeedError(ceed, ecode, ...) \ 173ec3da8bcSJed Brown (CeedErrorImpl((ceed), __FILE__, __LINE__, __func__, (ecode), __VA_ARGS__) ?: (ecode)) 174ec3da8bcSJed Brown #else 175ec3da8bcSJed Brown # define CeedError(ceed, ecode, ...) \ 176ec3da8bcSJed Brown CeedErrorImpl((ceed), __FILE__, __LINE__, __func__, (ecode), __VA_ARGS__) ?: (ecode) 177ec3da8bcSJed Brown #endif 178ec3da8bcSJed Brown 179ec3da8bcSJed Brown /// Ceed error handlers 180ec3da8bcSJed Brown CEED_EXTERN int CeedErrorReturn(Ceed, const char *, int, const char *, int, 181ec3da8bcSJed Brown const char *, va_list *); 182ec3da8bcSJed Brown CEED_EXTERN int CeedErrorStore(Ceed, const char *, int, const char *, int, 183ec3da8bcSJed Brown const char *, va_list *); 184ec3da8bcSJed Brown CEED_EXTERN int CeedErrorAbort(Ceed, const char *, int, const char *, int, 185ec3da8bcSJed Brown const char *, va_list *); 186ec3da8bcSJed Brown CEED_EXTERN int CeedErrorExit(Ceed, const char *, int, const char *, int, 187ec3da8bcSJed Brown const char *, va_list *); 188ec3da8bcSJed Brown typedef int (*CeedErrorHandler)(Ceed, const char *, int, 189ec3da8bcSJed Brown const char *, int, const char *, 190ec3da8bcSJed Brown va_list *); 191ec3da8bcSJed Brown CEED_EXTERN int CeedSetErrorHandler(Ceed ceed, CeedErrorHandler eh); 192d1d35e2fSjeremylt CEED_EXTERN int CeedGetErrorMessage(Ceed, const char **err_msg); 193d1d35e2fSjeremylt CEED_EXTERN int CeedResetErrorMessage(Ceed, const char **err_msg); 194ec3da8bcSJed Brown 195ec3da8bcSJed Brown /// libCEED library version numbering 196ec3da8bcSJed Brown /// @ingroup Ceed 197ec3da8bcSJed Brown #define CEED_VERSION_MAJOR 0 198240131baSJeremy L Thompson #define CEED_VERSION_MINOR 8 199ec3da8bcSJed Brown #define CEED_VERSION_PATCH 0 200ec3da8bcSJed Brown #define CEED_VERSION_RELEASE false 201ec3da8bcSJed Brown 202ec3da8bcSJed Brown /// Compile-time check that the the current library version is at least as 203ec3da8bcSJed Brown /// recent as the specified version. This macro is typically used in 204ec3da8bcSJed Brown /// @code 205ec3da8bcSJed Brown /// #if CEED_VERSION_GE(0, 8, 0) 206ec3da8bcSJed Brown /// code path that needs at least 0.8.0 207ec3da8bcSJed Brown /// #else 208ec3da8bcSJed Brown /// fallback code for older versions 209ec3da8bcSJed Brown /// #endif 210ec3da8bcSJed Brown /// @endcode 211ec3da8bcSJed Brown /// 212ec3da8bcSJed Brown /// A non-release version always compares as positive infinity. 213ec3da8bcSJed Brown /// 214ec3da8bcSJed Brown /// @param major Major version 215ec3da8bcSJed Brown /// @param minor Minor version 216ec3da8bcSJed Brown /// @param patch Patch (subminor) version 217ec3da8bcSJed Brown /// 218ec3da8bcSJed Brown /// @ingroup Ceed 219ec3da8bcSJed Brown /// @sa CeedGetVersion() 220ec3da8bcSJed Brown #define CEED_VERSION_GE(major, minor, patch) \ 221ec3da8bcSJed Brown (!CEED_VERSION_RELEASE || \ 222ec3da8bcSJed Brown (CEED_VERSION_MAJOR > major || \ 223ec3da8bcSJed Brown (CEED_VERSION_MAJOR == major && \ 224ec3da8bcSJed Brown (CEED_VERSION_MINOR > minor || \ 225ec3da8bcSJed Brown (CEED_VERSION_MINOR == minor && CEED_VERSION_PATCH >= patch))))) 226ec3da8bcSJed Brown 227ec3da8bcSJed Brown CEED_EXTERN int CeedGetVersion(int *major, int *minor, int *patch, 228ec3da8bcSJed Brown bool *release); 229ec3da8bcSJed Brown 230ec3da8bcSJed Brown /// Ceed Errors 231ec3da8bcSJed Brown /// 232ec3da8bcSJed Brown /// This enum is used to specify the type of error returned by a function. 233ec3da8bcSJed Brown /// A zero error code is success, negative error codes indicate terminal errors 234ec3da8bcSJed Brown /// and positive error codes indicate nonterminal errors. With nonterminal errors 235ec3da8bcSJed Brown /// the object state has not been modifiend, but with terminal errors the object 236ec3da8bcSJed Brown /// data is likely modified or corrupted. 237ec3da8bcSJed Brown /// @ingroup Ceed 238ec3da8bcSJed Brown typedef enum { 2390f7fd0f8Sjeremylt /// Success error code 240ec3da8bcSJed Brown CEED_ERROR_SUCCESS = 0, 241ec3da8bcSJed Brown /// Minor error, generic 242ec3da8bcSJed Brown CEED_ERROR_MINOR = 1, 243ec3da8bcSJed Brown /// Minor error, dimension mismatch in inputs 244ec3da8bcSJed Brown CEED_ERROR_DIMENSION = 2, 245ec3da8bcSJed Brown /// Minor error, incomplete object setup 246ec3da8bcSJed Brown CEED_ERROR_INCOMPLETE = 3, 247ec3da8bcSJed Brown /// Minor error, incompatible arguments/configuration 248ec3da8bcSJed Brown CEED_ERROR_INCOMPATIBLE = 4, 249ec3da8bcSJed Brown /// Minor error, access lock problem 250ec3da8bcSJed Brown CEED_ERROR_ACCESS = 5, 251ec3da8bcSJed Brown /// Major error, generic 252ec3da8bcSJed Brown CEED_ERROR_MAJOR = -1, 253ec3da8bcSJed Brown /// Major error, internal backend error 254ec3da8bcSJed Brown CEED_ERROR_BACKEND = -2, 255ec3da8bcSJed Brown /// Major error, operation unsupported by current backend 256ec3da8bcSJed Brown CEED_ERROR_UNSUPPORTED = -3, 257ec3da8bcSJed Brown } CeedErrorType; 258ec3da8bcSJed Brown 259ec3da8bcSJed Brown CEED_EXTERN const char *const *CeedErrorTypes; 260ec3da8bcSJed Brown 261ec3da8bcSJed Brown /// Specify memory type 262ec3da8bcSJed Brown /// 263ec3da8bcSJed Brown /// Many Ceed interfaces take or return pointers to memory. This enum is used to 264ec3da8bcSJed Brown /// specify where the memory being provided or requested must reside. 265ec3da8bcSJed Brown /// @ingroup Ceed 266ec3da8bcSJed Brown typedef enum { 267ec3da8bcSJed Brown /// Memory resides on the host 268ec3da8bcSJed Brown CEED_MEM_HOST, 269ec3da8bcSJed Brown /// Memory resides on a device (corresponding to \ref Ceed resource) 270ec3da8bcSJed Brown CEED_MEM_DEVICE, 271ec3da8bcSJed Brown } CeedMemType; 272ec3da8bcSJed Brown 273ec3da8bcSJed Brown CEED_EXTERN const char *const CeedMemTypes[]; 274ec3da8bcSJed Brown 275ec3da8bcSJed Brown CEED_EXTERN int CeedGetPreferredMemType(Ceed ceed, CeedMemType *type); 276ec3da8bcSJed Brown 277ec3da8bcSJed Brown /// Conveys ownership status of arrays passed to Ceed interfaces. 278ec3da8bcSJed Brown /// @ingroup Ceed 279ec3da8bcSJed Brown typedef enum { 280ec3da8bcSJed Brown /// Implementation will copy the values and not store the passed pointer. 281ec3da8bcSJed Brown CEED_COPY_VALUES, 282ec3da8bcSJed Brown /// Implementation can use and modify the data provided by the user, but does 283ec3da8bcSJed Brown /// not take ownership. 284ec3da8bcSJed Brown CEED_USE_POINTER, 285ec3da8bcSJed Brown /// Implementation takes ownership of the pointer and will free using 286ec3da8bcSJed Brown /// CeedFree() when done using it. The user should not assume that the 287ec3da8bcSJed Brown /// pointer remains valid after ownership has been transferred. Note that 288ec3da8bcSJed Brown /// arrays allocated using C++ operator new or other allocators cannot 289ec3da8bcSJed Brown /// generally be freed using CeedFree(). CeedFree() is capable of freeing any 290ec3da8bcSJed Brown /// memory that can be freed using free(3). 291ec3da8bcSJed Brown CEED_OWN_POINTER, 292ec3da8bcSJed Brown } CeedCopyMode; 293ec3da8bcSJed Brown 294ec3da8bcSJed Brown /// Denotes type of vector norm to be computed 295ec3da8bcSJed Brown /// @ingroup CeedVector 296ec3da8bcSJed Brown typedef enum { 297ec3da8bcSJed Brown /// L_1 norm: sum_i |x_i| 298ec3da8bcSJed Brown CEED_NORM_1, 299ec3da8bcSJed Brown /// L_2 norm: sqrt(sum_i |x_i|^2) 300ec3da8bcSJed Brown CEED_NORM_2, 301ec3da8bcSJed Brown /// L_Infinity norm: max_i |x_i| 302ec3da8bcSJed Brown CEED_NORM_MAX, 303ec3da8bcSJed Brown } CeedNormType; 304ec3da8bcSJed Brown 305ec3da8bcSJed Brown CEED_EXTERN const char *const CeedCopyModes[]; 306ec3da8bcSJed Brown 307ec3da8bcSJed Brown CEED_EXTERN int CeedVectorCreate(Ceed ceed, CeedInt len, CeedVector *vec); 3089560d06aSjeremylt CEED_EXTERN int CeedVectorReferenceCopy(CeedVector vec, CeedVector *vec_copy); 309d1d35e2fSjeremylt CEED_EXTERN int CeedVectorSetArray(CeedVector vec, CeedMemType mem_type, 310d1d35e2fSjeremylt CeedCopyMode copy_mode, CeedScalar *array); 311ec3da8bcSJed Brown CEED_EXTERN int CeedVectorSetValue(CeedVector vec, CeedScalar value); 312d1d35e2fSjeremylt CEED_EXTERN int CeedVectorSyncArray(CeedVector vec, CeedMemType mem_type); 313d1d35e2fSjeremylt CEED_EXTERN int CeedVectorTakeArray(CeedVector vec, CeedMemType mem_type, 314ec3da8bcSJed Brown CeedScalar **array); 315d1d35e2fSjeremylt CEED_EXTERN int CeedVectorGetArray(CeedVector vec, CeedMemType mem_type, 316ec3da8bcSJed Brown CeedScalar **array); 317d1d35e2fSjeremylt CEED_EXTERN int CeedVectorGetArrayRead(CeedVector vec, CeedMemType mem_type, 318ec3da8bcSJed Brown const CeedScalar **array); 319ec3da8bcSJed Brown CEED_EXTERN int CeedVectorRestoreArray(CeedVector vec, CeedScalar **array); 320ec3da8bcSJed Brown CEED_EXTERN int CeedVectorRestoreArrayRead(CeedVector vec, 321ec3da8bcSJed Brown const CeedScalar **array); 322ec3da8bcSJed Brown CEED_EXTERN int CeedVectorNorm(CeedVector vec, CeedNormType type, 323ec3da8bcSJed Brown CeedScalar *norm); 324*e0dd3b27Sjeremylt CEED_EXTERN int CeedVectorScale(CeedVector x, CeedScalar alpha); 3250f7fd0f8Sjeremylt CEED_EXTERN int CeedVectorAXPY(CeedVector y, CeedScalar alpha, CeedVector x); 3260f7fd0f8Sjeremylt CEED_EXTERN int CeedVectorPointwiseMult(CeedVector w, CeedVector x, CeedVector y); 327ec3da8bcSJed Brown CEED_EXTERN int CeedVectorReciprocal(CeedVector vec); 328d1d35e2fSjeremylt CEED_EXTERN int CeedVectorView(CeedVector vec, const char *fp_fmt, FILE *stream); 329ec3da8bcSJed Brown CEED_EXTERN int CeedVectorGetLength(CeedVector vec, CeedInt *length); 330ec3da8bcSJed Brown CEED_EXTERN int CeedVectorDestroy(CeedVector *vec); 331ec3da8bcSJed Brown 332ec3da8bcSJed Brown CEED_EXTERN CeedRequest *const CEED_REQUEST_IMMEDIATE; 333ec3da8bcSJed Brown CEED_EXTERN CeedRequest *const CEED_REQUEST_ORDERED; 334ec3da8bcSJed Brown CEED_EXTERN int CeedRequestWait(CeedRequest *req); 335ec3da8bcSJed Brown 336ec3da8bcSJed Brown /// Argument for CeedOperatorSetField that vector is collocated with 337ec3da8bcSJed Brown /// quadrature points, used with QFunction eval mode CEED_EVAL_NONE 338ec3da8bcSJed Brown /// or CEED_EVAL_INTERP only, not with CEED_EVAL_GRAD, CEED_EVAL_DIV, 339ec3da8bcSJed Brown /// or CEED_EVAL_CURL 340ec3da8bcSJed Brown /// @ingroup CeedBasis 341ec3da8bcSJed Brown CEED_EXTERN const CeedBasis CEED_BASIS_COLLOCATED; 342ec3da8bcSJed Brown 343ec3da8bcSJed Brown /// Argument for CeedOperatorSetField to use active input or output 344ec3da8bcSJed Brown /// @ingroup CeedVector 345ec3da8bcSJed Brown CEED_EXTERN const CeedVector CEED_VECTOR_ACTIVE; 346ec3da8bcSJed Brown 347ec3da8bcSJed Brown /// Argument for CeedOperatorSetField to use no vector, used with 348ec3da8bcSJed Brown /// qfunction input with eval mode CEED_EVAL_WEIGHT 349ec3da8bcSJed Brown /// @ingroup CeedVector 350ec3da8bcSJed Brown CEED_EXTERN const CeedVector CEED_VECTOR_NONE; 351ec3da8bcSJed Brown 352ec3da8bcSJed Brown /// Argument for CeedOperatorSetField to use no ElemRestriction, only used with 353ec3da8bcSJed Brown /// eval mode CEED_EVAL_WEIGHT. 354ec3da8bcSJed Brown /// @ingroup CeedElemRestriction 355ec3da8bcSJed Brown CEED_EXTERN const CeedElemRestriction CEED_ELEMRESTRICTION_NONE; 356ec3da8bcSJed Brown 357ec3da8bcSJed Brown /// Argument for CeedOperatorCreate that QFunction is not created by user. 358ec3da8bcSJed Brown /// Only used for QFunctions dqf and dqfT. If implemented, a backend may 359ec3da8bcSJed Brown /// attempt to provide the action of these QFunctions. 360ec3da8bcSJed Brown /// @ingroup CeedQFunction 361ec3da8bcSJed Brown CEED_EXTERN const CeedQFunction CEED_QFUNCTION_NONE; 362ec3da8bcSJed Brown 363ec3da8bcSJed Brown /// Denotes whether a linear transformation or its transpose should be applied 364ec3da8bcSJed Brown /// @ingroup CeedBasis 365ec3da8bcSJed Brown typedef enum { 366ec3da8bcSJed Brown /// Apply the linear transformation 367ec3da8bcSJed Brown CEED_NOTRANSPOSE, 368ec3da8bcSJed Brown /// Apply the transpose 369ec3da8bcSJed Brown CEED_TRANSPOSE 370ec3da8bcSJed Brown } CeedTransposeMode; 371ec3da8bcSJed Brown 372ec3da8bcSJed Brown CEED_EXTERN const char *const CeedTransposeModes[]; 373ec3da8bcSJed Brown 374ec3da8bcSJed Brown /// Argument for CeedElemRestrictionCreateStrided that L-vector is in 375ec3da8bcSJed Brown /// the Ceed backend's preferred layout. This argument should only be used 376ec3da8bcSJed Brown /// with vectors created by a Ceed backend. 377ec3da8bcSJed Brown /// @ingroup CeedElemRestriction 378ec3da8bcSJed Brown CEED_EXTERN const CeedInt CEED_STRIDES_BACKEND[3]; 379ec3da8bcSJed Brown 380d1d35e2fSjeremylt CEED_EXTERN int CeedElemRestrictionCreate(Ceed ceed, CeedInt num_elem, 381d1d35e2fSjeremylt CeedInt elem_size, CeedInt num_comp, CeedInt comp_stride, CeedInt l_size, 382d1d35e2fSjeremylt CeedMemType mem_type, CeedCopyMode copy_mode, const CeedInt *offsets, 383ec3da8bcSJed Brown CeedElemRestriction *rstr); 384ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionCreateStrided(Ceed ceed, 385d1d35e2fSjeremylt CeedInt num_elem, CeedInt elem_size, CeedInt num_comp, CeedInt l_size, 386ec3da8bcSJed Brown const CeedInt strides[3], CeedElemRestriction *rstr); 387d1d35e2fSjeremylt CEED_EXTERN int CeedElemRestrictionCreateBlocked(Ceed ceed, CeedInt num_elem, 388d1d35e2fSjeremylt CeedInt elem_size, CeedInt blk_size, CeedInt num_comp, CeedInt comp_stride, 389d1d35e2fSjeremylt CeedInt l_size, CeedMemType mem_type, CeedCopyMode copy_mode, 390ec3da8bcSJed Brown const CeedInt *offsets, CeedElemRestriction *rstr); 391ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionCreateBlockedStrided(Ceed ceed, 392d1d35e2fSjeremylt CeedInt num_elem, CeedInt elem_size, CeedInt blk_size, CeedInt num_comp, 393d1d35e2fSjeremylt CeedInt l_size, const CeedInt strides[3], CeedElemRestriction *rstr); 3949560d06aSjeremylt CEED_EXTERN int CeedElemRestrictionReferenceCopy(CeedElemRestriction rstr, 3959560d06aSjeremylt CeedElemRestriction *rstr_copy); 396ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionCreateVector(CeedElemRestriction rstr, 397ec3da8bcSJed Brown CeedVector *lvec, CeedVector *evec); 398ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionApply(CeedElemRestriction rstr, 399d1d35e2fSjeremylt CeedTransposeMode t_mode, CeedVector u, CeedVector ru, CeedRequest *request); 400ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionApplyBlock(CeedElemRestriction rstr, 401d1d35e2fSjeremylt CeedInt block, CeedTransposeMode t_mode, CeedVector u, CeedVector ru, 402ec3da8bcSJed Brown CeedRequest *request); 403ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionGetCompStride(CeedElemRestriction rstr, 404d1d35e2fSjeremylt CeedInt *comp_stride); 405ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionGetNumElements(CeedElemRestriction rstr, 406d1d35e2fSjeremylt CeedInt *num_elem); 407ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionGetElementSize(CeedElemRestriction rstr, 408d1d35e2fSjeremylt CeedInt *elem_size); 409ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionGetLVectorSize(CeedElemRestriction rstr, 410d1d35e2fSjeremylt CeedInt *l_size); 411ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionGetNumComponents(CeedElemRestriction rstr, 412d1d35e2fSjeremylt CeedInt *num_comp); 413ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionGetNumBlocks(CeedElemRestriction rstr, 414d1d35e2fSjeremylt CeedInt *num_blk); 415ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionGetBlockSize(CeedElemRestriction rstr, 416d1d35e2fSjeremylt CeedInt *blk_size); 417ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionGetMultiplicity(CeedElemRestriction rstr, 418ec3da8bcSJed Brown CeedVector mult); 419ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionView(CeedElemRestriction rstr, FILE *stream); 420ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionDestroy(CeedElemRestriction *rstr); 421ec3da8bcSJed Brown 422ec3da8bcSJed Brown // The formalism here is that we have the structure 423ec3da8bcSJed Brown // \int_\Omega v^T f_0(u, \nabla u, qdata) + (\nabla v)^T f_1(u, \nabla u, qdata) 424ec3da8bcSJed Brown // where gradients are with respect to the reference element. 425ec3da8bcSJed Brown 426ec3da8bcSJed Brown /// Basis evaluation mode 427ec3da8bcSJed Brown /// 428ec3da8bcSJed Brown /// Modes can be bitwise ORed when passing to most functions. 429ec3da8bcSJed Brown /// @ingroup CeedBasis 430ec3da8bcSJed Brown typedef enum { 431ec3da8bcSJed Brown /// Perform no evaluation (either because there is no data or it is already at 432ec3da8bcSJed Brown /// quadrature points) 433ec3da8bcSJed Brown CEED_EVAL_NONE = 0, 434ec3da8bcSJed Brown /// Interpolate from nodes to quadrature points 435ec3da8bcSJed Brown CEED_EVAL_INTERP = 1, 436ec3da8bcSJed Brown /// Evaluate gradients at quadrature points from input in a nodal basis 437ec3da8bcSJed Brown CEED_EVAL_GRAD = 2, 438ec3da8bcSJed Brown /// Evaluate divergence at quadrature points from input in a nodal basis 439ec3da8bcSJed Brown CEED_EVAL_DIV = 4, 440ec3da8bcSJed Brown /// Evaluate curl at quadrature points from input in a nodal basis 441ec3da8bcSJed Brown CEED_EVAL_CURL = 8, 442ec3da8bcSJed Brown /// Using no input, evaluate quadrature weights on the reference element 443ec3da8bcSJed Brown CEED_EVAL_WEIGHT = 16, 444ec3da8bcSJed Brown } CeedEvalMode; 445ec3da8bcSJed Brown 446ec3da8bcSJed Brown CEED_EXTERN const char *const CeedEvalModes[]; 447ec3da8bcSJed Brown 448ec3da8bcSJed Brown /// Type of quadrature; also used for location of nodes 449ec3da8bcSJed Brown /// @ingroup CeedBasis 450ec3da8bcSJed Brown typedef enum { 451ec3da8bcSJed Brown /// Gauss-Legendre quadrature 452ec3da8bcSJed Brown CEED_GAUSS = 0, 453ec3da8bcSJed Brown /// Gauss-Legendre-Lobatto quadrature 454ec3da8bcSJed Brown CEED_GAUSS_LOBATTO = 1, 455ec3da8bcSJed Brown } CeedQuadMode; 456ec3da8bcSJed Brown 457ec3da8bcSJed Brown CEED_EXTERN const char *const CeedQuadModes[]; 458ec3da8bcSJed Brown 459ec3da8bcSJed Brown /// Type of basis shape to create non-tensor H1 element basis 460ec3da8bcSJed Brown /// 461ec3da8bcSJed Brown /// Dimension can be extracted with bitwise AND 462ec3da8bcSJed Brown /// (CeedElemTopology & 2**(dim + 2)) == TRUE 463ec3da8bcSJed Brown /// @ingroup CeedBasis 464ec3da8bcSJed Brown typedef enum { 465ec3da8bcSJed Brown /// Line 466ec3da8bcSJed Brown CEED_LINE = 1 << 16 | 0, 467ec3da8bcSJed Brown /// Triangle - 2D shape 468ec3da8bcSJed Brown CEED_TRIANGLE = 2 << 16 | 1, 469ec3da8bcSJed Brown /// Quadralateral - 2D shape 470ec3da8bcSJed Brown CEED_QUAD = 2 << 16 | 2, 471ec3da8bcSJed Brown /// Tetrahedron - 3D shape 472ec3da8bcSJed Brown CEED_TET = 3 << 16 | 3, 473ec3da8bcSJed Brown /// Pyramid - 3D shape 474ec3da8bcSJed Brown CEED_PYRAMID = 3 << 16 | 4, 475ec3da8bcSJed Brown /// Prism - 3D shape 476ec3da8bcSJed Brown CEED_PRISM = 3 << 16 | 5, 477ec3da8bcSJed Brown /// Hexehedron - 3D shape 478ec3da8bcSJed Brown CEED_HEX = 3 << 16 | 6, 479ec3da8bcSJed Brown } CeedElemTopology; 480ec3da8bcSJed Brown 481ec3da8bcSJed Brown CEED_EXTERN const char *const CeedElemTopologies[]; 482ec3da8bcSJed Brown 483ec3da8bcSJed Brown CEED_EXTERN int CeedBasisCreateTensorH1Lagrange(Ceed ceed, CeedInt dim, 484d1d35e2fSjeremylt CeedInt num_comp, CeedInt P, CeedInt Q, CeedQuadMode quad_mode, CeedBasis *basis); 485d1d35e2fSjeremylt CEED_EXTERN int CeedBasisCreateTensorH1(Ceed ceed, CeedInt dim, CeedInt num_comp, 486d1d35e2fSjeremylt CeedInt P_1d, CeedInt Q_1d, 487d1d35e2fSjeremylt const CeedScalar *interp_1d, 488d1d35e2fSjeremylt const CeedScalar *grad_1d, 489d1d35e2fSjeremylt const CeedScalar *q_ref_1d, 490d1d35e2fSjeremylt const CeedScalar *q_weight_1d, 491ec3da8bcSJed Brown CeedBasis *basis); 492ec3da8bcSJed Brown CEED_EXTERN int CeedBasisCreateH1(Ceed ceed, CeedElemTopology topo, 493d1d35e2fSjeremylt CeedInt num_comp, 494d1d35e2fSjeremylt CeedInt num_nodes, CeedInt nqpts, 495ec3da8bcSJed Brown const CeedScalar *interp, 496ec3da8bcSJed Brown const CeedScalar *grad, 497d1d35e2fSjeremylt const CeedScalar *q_ref, 498d1d35e2fSjeremylt const CeedScalar *q_weights, CeedBasis *basis); 4999560d06aSjeremylt CEED_EXTERN int CeedBasisReferenceCopy(CeedBasis basis, CeedBasis *basis_copy); 500ec3da8bcSJed Brown CEED_EXTERN int CeedBasisView(CeedBasis basis, FILE *stream); 501d1d35e2fSjeremylt CEED_EXTERN int CeedBasisApply(CeedBasis basis, CeedInt num_elem, 502d1d35e2fSjeremylt CeedTransposeMode t_mode, 503d1d35e2fSjeremylt CeedEvalMode eval_mode, CeedVector u, CeedVector v); 504ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetDimension(CeedBasis basis, CeedInt *dim); 505ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetTopology(CeedBasis basis, CeedElemTopology *topo); 506d1d35e2fSjeremylt CEED_EXTERN int CeedBasisGetNumComponents(CeedBasis basis, CeedInt *num_comp); 507ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetNumNodes(CeedBasis basis, CeedInt *P); 508d1d35e2fSjeremylt CEED_EXTERN int CeedBasisGetNumNodes1D(CeedBasis basis, CeedInt *P_1d); 509ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetNumQuadraturePoints(CeedBasis basis, CeedInt *Q); 510ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetNumQuadraturePoints1D(CeedBasis basis, 511d1d35e2fSjeremylt CeedInt *Q_1d); 512d1d35e2fSjeremylt CEED_EXTERN int CeedBasisGetQRef(CeedBasis basis, const CeedScalar **q_ref); 513ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetQWeights(CeedBasis basis, 514d1d35e2fSjeremylt const CeedScalar **q_weights); 515ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetInterp(CeedBasis basis, const CeedScalar **interp); 516ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetInterp1D(CeedBasis basis, 517d1d35e2fSjeremylt const CeedScalar **interp_1d); 518ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetGrad(CeedBasis basis, const CeedScalar **grad); 519d1d35e2fSjeremylt CEED_EXTERN int CeedBasisGetGrad1D(CeedBasis basis, const CeedScalar **grad_1d); 520ec3da8bcSJed Brown CEED_EXTERN int CeedBasisDestroy(CeedBasis *basis); 521ec3da8bcSJed Brown 522d1d35e2fSjeremylt CEED_EXTERN int CeedGaussQuadrature(CeedInt Q, CeedScalar *q_ref_1d, 523d1d35e2fSjeremylt CeedScalar *q_weight_1d); 524d1d35e2fSjeremylt CEED_EXTERN int CeedLobattoQuadrature(CeedInt Q, CeedScalar *q_ref_1d, 525d1d35e2fSjeremylt CeedScalar *q_weight_1d); 526ec3da8bcSJed Brown CEED_EXTERN int CeedQRFactorization(Ceed ceed, CeedScalar *mat, CeedScalar *tau, 527ec3da8bcSJed Brown CeedInt m, CeedInt n); 528ec3da8bcSJed Brown CEED_EXTERN int CeedSymmetricSchurDecomposition(Ceed ceed, CeedScalar *mat, 529ec3da8bcSJed Brown CeedScalar *lambda, CeedInt n); 530d1d35e2fSjeremylt CEED_EXTERN int CeedSimultaneousDiagonalization(Ceed ceed, CeedScalar *mat_A, 531d1d35e2fSjeremylt CeedScalar *mat_B, CeedScalar *x, CeedScalar *lambda, CeedInt n); 532ec3da8bcSJed Brown 533ec3da8bcSJed Brown /** Handle for the object describing the user CeedQFunction 534ec3da8bcSJed Brown 535ec3da8bcSJed Brown @param ctx user-defined context set using CeedQFunctionSetContext() or NULL 536ec3da8bcSJed Brown 537ec3da8bcSJed Brown @param Q number of quadrature points at which to evaluate 538ec3da8bcSJed Brown 539ec3da8bcSJed Brown @param in array of pointers to each input argument in the order provided 540ec3da8bcSJed Brown by the user in CeedQFunctionAddInput(). Each array has shape 541d1d35e2fSjeremylt `[dim, num_comp, Q]` where `dim` is the geometric dimension for 542ec3da8bcSJed Brown \ref CEED_EVAL_GRAD (`dim=1` for \ref CEED_EVAL_INTERP) and 543d1d35e2fSjeremylt `num_comp` is the number of field components (`num_comp=1` for 544ec3da8bcSJed Brown scalar fields). This results in indexing the `i`th input at 545d1d35e2fSjeremylt quadrature point `j` as `in[i][(d*num_comp + c)*Q + j]`. 546ec3da8bcSJed Brown 547ec3da8bcSJed Brown @param out array of pointers to each output array in the order provided 548ec3da8bcSJed Brown using CeedQFunctionAddOutput(). The shapes are as above for 549ec3da8bcSJed Brown \a in. 550ec3da8bcSJed Brown 551ec3da8bcSJed Brown @return An error code: 0 - success, otherwise - failure 552ec3da8bcSJed Brown 553ec3da8bcSJed Brown @ingroup CeedQFunction 554ec3da8bcSJed Brown **/ 555ec3da8bcSJed Brown typedef int (*CeedQFunctionUser)(void *ctx, const CeedInt Q, 556ec3da8bcSJed Brown const CeedScalar *const *in, 557ec3da8bcSJed Brown CeedScalar *const *out); 558ec3da8bcSJed Brown 559d1d35e2fSjeremylt CEED_EXTERN int CeedQFunctionCreateInterior(Ceed ceed, CeedInt vec_length, 560ec3da8bcSJed Brown CeedQFunctionUser f, const char *source, CeedQFunction *qf); 561ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionCreateInteriorByName(Ceed ceed, const char *name, 562ec3da8bcSJed Brown CeedQFunction *qf); 563ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionCreateIdentity(Ceed ceed, CeedInt size, 564d1d35e2fSjeremylt CeedEvalMode in_mode, CeedEvalMode out_mode, CeedQFunction *qf); 5659560d06aSjeremylt CEED_EXTERN int CeedQFunctionReferenceCopy(CeedQFunction qf, CeedQFunction *qf_copy); 566d1d35e2fSjeremylt CEED_EXTERN int CeedQFunctionAddInput(CeedQFunction qf, const char *field_name, 567d1d35e2fSjeremylt CeedInt size, CeedEvalMode eval_mode); 568d1d35e2fSjeremylt CEED_EXTERN int CeedQFunctionAddOutput(CeedQFunction qf, const char *field_name, 569d1d35e2fSjeremylt CeedInt size, CeedEvalMode eval_mode); 570ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionSetContext(CeedQFunction qf, 571ec3da8bcSJed Brown CeedQFunctionContext ctx); 572ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionView(CeedQFunction qf, FILE *stream); 573ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionApply(CeedQFunction qf, CeedInt Q, 574ec3da8bcSJed Brown CeedVector *u, CeedVector *v); 575ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionDestroy(CeedQFunction *qf); 576ec3da8bcSJed Brown 577ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionContextCreate(Ceed ceed, 578ec3da8bcSJed Brown CeedQFunctionContext *ctx); 5799560d06aSjeremylt CEED_EXTERN int CeedQFunctionContextReferenceCopy(CeedQFunctionContext ctx, 5809560d06aSjeremylt CeedQFunctionContext *ctx_copy); 581ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionContextSetData(CeedQFunctionContext ctx, 582d1d35e2fSjeremylt CeedMemType mem_type, CeedCopyMode copy_mode, size_t size, void *data); 583ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionContextGetData(CeedQFunctionContext ctx, 584d1d35e2fSjeremylt CeedMemType mem_type, 585ec3da8bcSJed Brown void *data); 586ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionContextRestoreData(CeedQFunctionContext ctx, 587ec3da8bcSJed Brown void *data); 588ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionContextView(CeedQFunctionContext ctx, 589ec3da8bcSJed Brown FILE *stream); 590ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionContextDestroy(CeedQFunctionContext *ctx); 591ec3da8bcSJed Brown 592ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorCreate(Ceed ceed, CeedQFunction qf, 593ec3da8bcSJed Brown CeedQFunction dqf, CeedQFunction dqfT, 594ec3da8bcSJed Brown CeedOperator *op); 595ec3da8bcSJed Brown CEED_EXTERN int CeedCompositeOperatorCreate(Ceed ceed, CeedOperator *op); 5969560d06aSjeremylt CEED_EXTERN int CeedOperatorReferenceCopy(CeedOperator op, CeedOperator *op_copy); 597d1d35e2fSjeremylt CEED_EXTERN int CeedOperatorSetField(CeedOperator op, const char *field_name, 598ec3da8bcSJed Brown CeedElemRestriction r, CeedBasis b, 599ec3da8bcSJed Brown CeedVector v); 600d1d35e2fSjeremylt CEED_EXTERN int CeedCompositeOperatorAddSub(CeedOperator composite_op, 601d1d35e2fSjeremylt CeedOperator sub_op); 602ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorLinearAssembleQFunction(CeedOperator op, 603ec3da8bcSJed Brown CeedVector *assembled, CeedElemRestriction *rstr, CeedRequest *request); 604ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorLinearAssembleDiagonal(CeedOperator op, 605ec3da8bcSJed Brown CeedVector assembled, CeedRequest *request); 606ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorLinearAssembleAddDiagonal(CeedOperator op, 607ec3da8bcSJed Brown CeedVector assembled, CeedRequest *request); 608ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorLinearAssemblePointBlockDiagonal(CeedOperator op, 609ec3da8bcSJed Brown CeedVector assembled, CeedRequest *request); 610ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorLinearAssembleAddPointBlockDiagonal(CeedOperator op, 611ec3da8bcSJed Brown CeedVector assembled, CeedRequest *request); 612ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorLinearAssembleSymbolic(CeedOperator op, 613d1d35e2fSjeremylt CeedInt *num_entries, CeedInt **rows, CeedInt **cols); 614ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorLinearAssemble(CeedOperator op, CeedVector values); 615d1d35e2fSjeremylt CEED_EXTERN int CeedOperatorMultigridLevelCreate(CeedOperator op_fine, 616d1d35e2fSjeremylt CeedVector p_mult_fine, CeedElemRestriction rstr_coarse, CeedBasis basis_coarse, 617d1d35e2fSjeremylt CeedOperator *op_coarse, CeedOperator *op_prolong, CeedOperator *op_restrict); 618ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorMultigridLevelCreateTensorH1( 619d1d35e2fSjeremylt CeedOperator op_fine, CeedVector p_mult_fine, CeedElemRestriction rstr_coarse, 620d1d35e2fSjeremylt CeedBasis basis_coarse, const CeedScalar *interp_c_to_f, CeedOperator *op_coarse, 621d1d35e2fSjeremylt CeedOperator *op_prolong, CeedOperator *op_restrict); 622d1d35e2fSjeremylt CEED_EXTERN int CeedOperatorMultigridLevelCreateH1(CeedOperator op_fine, 623d1d35e2fSjeremylt CeedVector p_mult_fine, CeedElemRestriction rstr_coarse, CeedBasis basis_coarse, 624d1d35e2fSjeremylt const CeedScalar *interp_c_to_f, CeedOperator *op_coarse, 625d1d35e2fSjeremylt CeedOperator *op_prolong, CeedOperator *op_restrict); 626ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorCreateFDMElementInverse(CeedOperator op, 627d1d35e2fSjeremylt CeedOperator *fdm_inv, CeedRequest *request); 628cd4dfc48Sjeremylt CEED_EXTERN int CeedOperatorSetNumQuadraturePoints(CeedOperator op, CeedInt num_qpts); 629ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorView(CeedOperator op, FILE *stream); 630ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorApply(CeedOperator op, CeedVector in, 631ec3da8bcSJed Brown CeedVector out, CeedRequest *request); 632ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorApplyAdd(CeedOperator op, CeedVector in, 633ec3da8bcSJed Brown CeedVector out, CeedRequest *request); 634ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorDestroy(CeedOperator *op); 635ec3da8bcSJed Brown 636ec3da8bcSJed Brown /** 637ec3da8bcSJed Brown @brief Return integer power 638ec3da8bcSJed Brown 639ec3da8bcSJed Brown @param[in] base The base to exponentiate 640ec3da8bcSJed Brown @param[in] power The power to raise the base to 641ec3da8bcSJed Brown 642ec3da8bcSJed Brown @return base^power 643ec3da8bcSJed Brown 644ec3da8bcSJed Brown @ref Utility 645ec3da8bcSJed Brown **/ 646ec3da8bcSJed Brown static inline CeedInt CeedIntPow(CeedInt base, CeedInt power) { 647ec3da8bcSJed Brown CeedInt result = 1; 648ec3da8bcSJed Brown while (power) { 649ec3da8bcSJed Brown if (power & 1) result *= base; 650ec3da8bcSJed Brown power >>= 1; 651ec3da8bcSJed Brown base *= base; 652ec3da8bcSJed Brown } 653ec3da8bcSJed Brown return result; 654ec3da8bcSJed Brown } 655ec3da8bcSJed Brown 656ec3da8bcSJed Brown /** 657ec3da8bcSJed Brown @brief Return minimum of two integers 658ec3da8bcSJed Brown 659ec3da8bcSJed Brown @param[in] a The first integer to compare 660ec3da8bcSJed Brown @param[in] b The second integer to compare 661ec3da8bcSJed Brown 662ec3da8bcSJed Brown @return The minimum of the two integers 663ec3da8bcSJed Brown 664ec3da8bcSJed Brown @ref Utility 665ec3da8bcSJed Brown **/ 666ec3da8bcSJed Brown static inline CeedInt CeedIntMin(CeedInt a, CeedInt b) { return a < b ? a : b; } 667ec3da8bcSJed Brown 668ec3da8bcSJed Brown /** 669ec3da8bcSJed Brown @brief Return maximum of two integers 670ec3da8bcSJed Brown 671ec3da8bcSJed Brown @param[in] a The first integer to compare 672ec3da8bcSJed Brown @param[in] b The second integer to compare 673ec3da8bcSJed Brown 674ec3da8bcSJed Brown @return The maximum of the two integers 675ec3da8bcSJed Brown 676ec3da8bcSJed Brown @ref Utility 677ec3da8bcSJed Brown **/ 678ec3da8bcSJed Brown static inline CeedInt CeedIntMax(CeedInt a, CeedInt b) { return a > b ? a : b; } 679ec3da8bcSJed Brown 680ec3da8bcSJed Brown // Used to ensure initialization before CeedInit() 681ec3da8bcSJed Brown CEED_EXTERN int CeedRegisterAll(void); 682ec3da8bcSJed Brown // Used to ensure initialization before CeedQFunctionCreate*() 683ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionRegisterAll(void); 684ec3da8bcSJed Brown 685ec3da8bcSJed Brown #endif 686