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 83d8e8822SJeremy L Thompson /// 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". 39e9b533fbSJeremy L Thompson /// @section Advanced Advanced Functions 40e9b533fbSJeremy L Thompson /// These functions are intended to be used by advanced users of libCEED 41e9b533fbSJeremy L Thompson /// and can generally be found in "ceed.h". 42ec3da8bcSJed Brown /// @section Backend Backend Developer Functions 43ec3da8bcSJed Brown /// These functions are intended to be used by backend developers of 44ec3da8bcSJed Brown /// libCEED and can generally be found in "ceed-backend.h". 45ec3da8bcSJed Brown /// @section Developer Library Developer Functions 46ec3da8bcSJed Brown /// These functions are intended to be used by library developers of 47ec3da8bcSJed Brown /// libCEED and can generally be found in "ceed-impl.h". 48ec3da8bcSJed Brown 493b271f31SJed Brown #if !defined(CEED_SKIP_VISIBILITY) 503b271f31SJed Brown # define CEED_VISIBILITY(mode) __attribute__((visibility(#mode))) 513b271f31SJed Brown #else 523b271f31SJed Brown # define CEED_VISIBILITY(mode) 533b271f31SJed Brown #endif 543b271f31SJed Brown 55ec3da8bcSJed Brown /** 56ec3da8bcSJed Brown CEED_EXTERN is used in this header to denote all publicly visible symbols. 57ec3da8bcSJed Brown 58ec3da8bcSJed Brown No other file should declare publicly visible symbols, thus it should never be 59ec3da8bcSJed Brown used outside ceed.h. 60ec3da8bcSJed Brown */ 61ec3da8bcSJed Brown #ifdef __cplusplus 623b271f31SJed Brown # define CEED_EXTERN extern "C" CEED_VISIBILITY(default) 63ec3da8bcSJed Brown #else 643b271f31SJed Brown # define CEED_EXTERN extern CEED_VISIBILITY(default) 65ec3da8bcSJed Brown #endif 66ec3da8bcSJed Brown 67ec3da8bcSJed Brown #include <stdarg.h> 68ec3da8bcSJed Brown #include <stdbool.h> 693047f789SJeremy L Thompson #include <stdio.h> 70ec3da8bcSJed Brown 71*c9c2c079SJeremy L Thompson /// Typedefs and macros used in public interfaces and user QFunction source 72*c9c2c079SJeremy L Thompson #include "types.h" 73ec3da8bcSJed Brown 74ec3da8bcSJed Brown /// Library context created by CeedInit() 75ec3da8bcSJed Brown /// @ingroup CeedUser 76ec3da8bcSJed Brown typedef struct Ceed_private *Ceed; 77ec3da8bcSJed Brown /// Non-blocking Ceed interfaces return a CeedRequest. 78ec3da8bcSJed Brown /// To perform an operation immediately, pass \ref CEED_REQUEST_IMMEDIATE instead. 79ec3da8bcSJed Brown /// @ingroup CeedUser 80ec3da8bcSJed Brown typedef struct CeedRequest_private *CeedRequest; 81ec3da8bcSJed Brown /// Handle for vectors over the field \ref CeedScalar 82ec3da8bcSJed Brown /// @ingroup CeedVectorUser 83ec3da8bcSJed Brown typedef struct CeedVector_private *CeedVector; 84ec3da8bcSJed Brown /// Handle for object describing restriction to elements 85ec3da8bcSJed Brown /// @ingroup CeedElemRestrictionUser 86ec3da8bcSJed Brown typedef struct CeedElemRestriction_private *CeedElemRestriction; 87ec3da8bcSJed Brown /// Handle for object describing discrete finite element evaluations 88ec3da8bcSJed Brown /// @ingroup CeedBasisUser 89ec3da8bcSJed Brown typedef struct CeedBasis_private *CeedBasis; 9043bbe138SJeremy L Thompson /// Handle for object describing CeedQFunction fields 9143bbe138SJeremy L Thompson /// @ingroup CeedQFunctionBackend 9243bbe138SJeremy L Thompson typedef struct CeedQFunctionField_private *CeedQFunctionField; 93ec3da8bcSJed Brown /// Handle for object describing functions evaluated independently at quadrature points 94ec3da8bcSJed Brown /// @ingroup CeedQFunctionUser 95ec3da8bcSJed Brown typedef struct CeedQFunction_private *CeedQFunction; 9643bbe138SJeremy L Thompson /// Handle for object describing CeedOperator fields 9743bbe138SJeremy L Thompson /// @ingroup CeedOperatorBackend 9843bbe138SJeremy L Thompson typedef struct CeedOperatorField_private *CeedOperatorField; 99ec3da8bcSJed Brown /// Handle for object describing context data for CeedQFunctions 100ec3da8bcSJed Brown /// @ingroup CeedQFunctionUser 101ec3da8bcSJed Brown typedef struct CeedQFunctionContext_private *CeedQFunctionContext; 1023668ca4bSJeremy L Thompson /// Handle for object describing registered fields for CeedQFunctionContext 1033668ca4bSJeremy L Thompson /// @ingroup CeedQFunctionUser 1043668ca4bSJeremy L Thompson typedef struct CeedContextFieldLabel_private *CeedContextFieldLabel; 105ec3da8bcSJed Brown /// Handle for object describing FE-type operators acting on vectors 106ec3da8bcSJed Brown /// 107ec3da8bcSJed Brown /// Given an element restriction \f$E\f$, basis evaluator \f$B\f$, and 108ec3da8bcSJed Brown /// quadrature function\f$f\f$, a CeedOperator expresses operations of the form 109ec3da8bcSJed Brown /// $$ E^T B^T f(B E u) $$ 110ec3da8bcSJed Brown /// acting on the vector \f$u\f$. 111ec3da8bcSJed Brown /// @ingroup CeedOperatorUser 112ec3da8bcSJed Brown typedef struct CeedOperator_private *CeedOperator; 113ec3da8bcSJed Brown 11422e44211Sjeremylt CEED_EXTERN int CeedRegistryGetList(size_t *n, char ***const resources, CeedInt **array); 115ec3da8bcSJed Brown CEED_EXTERN int CeedInit(const char *resource, Ceed *ceed); 1169560d06aSjeremylt CEED_EXTERN int CeedReferenceCopy(Ceed ceed, Ceed *ceed_copy); 117ec3da8bcSJed Brown CEED_EXTERN int CeedGetResource(Ceed ceed, const char **resource); 118d1d35e2fSjeremylt CEED_EXTERN int CeedIsDeterministic(Ceed ceed, bool *is_deterministic); 119ee5a26f2SJeremy L Thompson CEED_EXTERN int CeedAddJitSourceRoot(Ceed ceed, const char *jit_source_root); 120ec3da8bcSJed Brown CEED_EXTERN int CeedView(Ceed ceed, FILE *stream); 121ec3da8bcSJed Brown CEED_EXTERN int CeedDestroy(Ceed *ceed); 122ec3da8bcSJed Brown 123ec3da8bcSJed Brown CEED_EXTERN int CeedErrorImpl(Ceed, const char *, int, const char *, int, 124ec3da8bcSJed Brown const char *, ...); 125ec3da8bcSJed Brown /// Raise an error on ceed object 126ec3da8bcSJed Brown /// 127ec3da8bcSJed Brown /// @param ceed Ceed library context or NULL 128ec3da8bcSJed Brown /// @param ecode Error code (int) 129ec3da8bcSJed Brown /// @param ... printf-style format string followed by arguments as needed 130ec3da8bcSJed Brown /// 131ec3da8bcSJed Brown /// @ingroup Ceed 132ec3da8bcSJed Brown /// @sa CeedSetErrorHandler() 133ec3da8bcSJed Brown #if defined(__clang__) 134ec3da8bcSJed Brown /// Use nonstandard ternary to convince the compiler/clang-tidy that this 135ec3da8bcSJed Brown /// function never returns zero. 136ec3da8bcSJed Brown # define CeedError(ceed, ecode, ...) \ 13745f1e315Sjeremylt (CeedErrorImpl((ceed), __FILE__, __LINE__, __func__, (ecode), __VA_ARGS__), (ecode)) 138ec3da8bcSJed Brown #else 139ec3da8bcSJed Brown # define CeedError(ceed, ecode, ...) \ 140ec3da8bcSJed Brown CeedErrorImpl((ceed), __FILE__, __LINE__, __func__, (ecode), __VA_ARGS__) ?: (ecode) 141ec3da8bcSJed Brown #endif 142ec3da8bcSJed Brown 143ec3da8bcSJed Brown /// Ceed error handlers 144ec3da8bcSJed Brown CEED_EXTERN int CeedErrorReturn(Ceed, const char *, int, const char *, int, 145ec3da8bcSJed Brown const char *, va_list *); 146ec3da8bcSJed Brown CEED_EXTERN int CeedErrorStore(Ceed, const char *, int, const char *, int, 147ec3da8bcSJed Brown const char *, va_list *); 148ec3da8bcSJed Brown CEED_EXTERN int CeedErrorAbort(Ceed, const char *, int, const char *, int, 149ec3da8bcSJed Brown const char *, va_list *); 150ec3da8bcSJed Brown CEED_EXTERN int CeedErrorExit(Ceed, const char *, int, const char *, int, 151ec3da8bcSJed Brown const char *, va_list *); 152ec3da8bcSJed Brown typedef int (*CeedErrorHandler)(Ceed, const char *, int, 153ec3da8bcSJed Brown const char *, int, const char *, 154ec3da8bcSJed Brown va_list *); 155ec3da8bcSJed Brown CEED_EXTERN int CeedSetErrorHandler(Ceed ceed, CeedErrorHandler eh); 156d1d35e2fSjeremylt CEED_EXTERN int CeedGetErrorMessage(Ceed, const char **err_msg); 157d1d35e2fSjeremylt CEED_EXTERN int CeedResetErrorMessage(Ceed, const char **err_msg); 158ec3da8bcSJed Brown 159ec3da8bcSJed Brown /// libCEED library version numbering 160ec3da8bcSJed Brown /// @ingroup Ceed 161ec3da8bcSJed Brown #define CEED_VERSION_MAJOR 0 162667e613fSJeremy L Thompson #define CEED_VERSION_MINOR 10 163f374d6a3SJeremy L Thompson #define CEED_VERSION_PATCH 1 16438faa2d6SJeremy L Thompson #define CEED_VERSION_RELEASE false 165ec3da8bcSJed Brown 166ec3da8bcSJed Brown /// Compile-time check that the the current library version is at least as 167ec3da8bcSJed Brown /// recent as the specified version. This macro is typically used in 168ec3da8bcSJed Brown /// @code 169ec3da8bcSJed Brown /// #if CEED_VERSION_GE(0, 8, 0) 170ec3da8bcSJed Brown /// code path that needs at least 0.8.0 171ec3da8bcSJed Brown /// #else 172ec3da8bcSJed Brown /// fallback code for older versions 173ec3da8bcSJed Brown /// #endif 174ec3da8bcSJed Brown /// @endcode 175ec3da8bcSJed Brown /// 176ec3da8bcSJed Brown /// A non-release version always compares as positive infinity. 177ec3da8bcSJed Brown /// 178ec3da8bcSJed Brown /// @param major Major version 179ec3da8bcSJed Brown /// @param minor Minor version 180ec3da8bcSJed Brown /// @param patch Patch (subminor) version 181ec3da8bcSJed Brown /// 182ec3da8bcSJed Brown /// @ingroup Ceed 183ec3da8bcSJed Brown /// @sa CeedGetVersion() 184ec3da8bcSJed Brown #define CEED_VERSION_GE(major, minor, patch) \ 185ec3da8bcSJed Brown (!CEED_VERSION_RELEASE || \ 186ec3da8bcSJed Brown (CEED_VERSION_MAJOR > major || \ 187ec3da8bcSJed Brown (CEED_VERSION_MAJOR == major && \ 188ec3da8bcSJed Brown (CEED_VERSION_MINOR > minor || \ 189ec3da8bcSJed Brown (CEED_VERSION_MINOR == minor && CEED_VERSION_PATCH >= patch))))) 190ec3da8bcSJed Brown 191ec3da8bcSJed Brown CEED_EXTERN int CeedGetVersion(int *major, int *minor, int *patch, 192ec3da8bcSJed Brown bool *release); 193ec3da8bcSJed Brown 19480a9ef05SNatalie Beams CEED_EXTERN int CeedGetScalarType(CeedScalarType *scalar_type); 19580a9ef05SNatalie Beams 196ec3da8bcSJed Brown CEED_EXTERN const char *const *CeedErrorTypes; 197ec3da8bcSJed Brown 198ec3da8bcSJed Brown /// Specify memory type 199ec3da8bcSJed Brown /// 200ec3da8bcSJed Brown /// Many Ceed interfaces take or return pointers to memory. This enum is used to 201ec3da8bcSJed Brown /// specify where the memory being provided or requested must reside. 202ec3da8bcSJed Brown /// @ingroup Ceed 203ec3da8bcSJed Brown typedef enum { 204ec3da8bcSJed Brown /// Memory resides on the host 205ec3da8bcSJed Brown CEED_MEM_HOST, 206ec3da8bcSJed Brown /// Memory resides on a device (corresponding to \ref Ceed resource) 207ec3da8bcSJed Brown CEED_MEM_DEVICE, 208ec3da8bcSJed Brown } CeedMemType; 209ec3da8bcSJed Brown CEED_EXTERN const char *const CeedMemTypes[]; 210ec3da8bcSJed Brown 211ec3da8bcSJed Brown CEED_EXTERN int CeedGetPreferredMemType(Ceed ceed, CeedMemType *type); 212ec3da8bcSJed Brown 213ec3da8bcSJed Brown /// Conveys ownership status of arrays passed to Ceed interfaces. 214ec3da8bcSJed Brown /// @ingroup Ceed 215ec3da8bcSJed Brown typedef enum { 216ec3da8bcSJed Brown /// Implementation will copy the values and not store the passed pointer. 217ec3da8bcSJed Brown CEED_COPY_VALUES, 218ec3da8bcSJed Brown /// Implementation can use and modify the data provided by the user, but does 219ec3da8bcSJed Brown /// not take ownership. 220ec3da8bcSJed Brown CEED_USE_POINTER, 221ec3da8bcSJed Brown /// Implementation takes ownership of the pointer and will free using 222ec3da8bcSJed Brown /// CeedFree() when done using it. The user should not assume that the 223ec3da8bcSJed Brown /// pointer remains valid after ownership has been transferred. Note that 224ec3da8bcSJed Brown /// arrays allocated using C++ operator new or other allocators cannot 225ec3da8bcSJed Brown /// generally be freed using CeedFree(). CeedFree() is capable of freeing any 226ec3da8bcSJed Brown /// memory that can be freed using free(3). 227ec3da8bcSJed Brown CEED_OWN_POINTER, 228ec3da8bcSJed Brown } CeedCopyMode; 229cdf32b93SJeremy L Thompson CEED_EXTERN const char *const CeedCopyModes[]; 230ec3da8bcSJed Brown 231ec3da8bcSJed Brown /// Denotes type of vector norm to be computed 232ec3da8bcSJed Brown /// @ingroup CeedVector 233ec3da8bcSJed Brown typedef enum { 234ec3da8bcSJed Brown /// L_1 norm: sum_i |x_i| 235ec3da8bcSJed Brown CEED_NORM_1, 236ec3da8bcSJed Brown /// L_2 norm: sqrt(sum_i |x_i|^2) 237ec3da8bcSJed Brown CEED_NORM_2, 238ec3da8bcSJed Brown /// L_Infinity norm: max_i |x_i| 239ec3da8bcSJed Brown CEED_NORM_MAX, 240ec3da8bcSJed Brown } CeedNormType; 241ec3da8bcSJed Brown 2421f9221feSJeremy L Thompson CEED_EXTERN int CeedVectorCreate(Ceed ceed, CeedSize len, CeedVector *vec); 2439560d06aSjeremylt CEED_EXTERN int CeedVectorReferenceCopy(CeedVector vec, CeedVector *vec_copy); 244d1d35e2fSjeremylt CEED_EXTERN int CeedVectorSetArray(CeedVector vec, CeedMemType mem_type, 245d1d35e2fSjeremylt CeedCopyMode copy_mode, CeedScalar *array); 246ec3da8bcSJed Brown CEED_EXTERN int CeedVectorSetValue(CeedVector vec, CeedScalar value); 247d1d35e2fSjeremylt CEED_EXTERN int CeedVectorSyncArray(CeedVector vec, CeedMemType mem_type); 248d1d35e2fSjeremylt CEED_EXTERN int CeedVectorTakeArray(CeedVector vec, CeedMemType mem_type, 249ec3da8bcSJed Brown CeedScalar **array); 250d1d35e2fSjeremylt CEED_EXTERN int CeedVectorGetArray(CeedVector vec, CeedMemType mem_type, 251ec3da8bcSJed Brown CeedScalar **array); 252d1d35e2fSjeremylt CEED_EXTERN int CeedVectorGetArrayRead(CeedVector vec, CeedMemType mem_type, 253ec3da8bcSJed Brown const CeedScalar **array); 2549c774eddSJeremy L Thompson CEED_EXTERN int CeedVectorGetArrayWrite(CeedVector vec, CeedMemType mem_type, 2559c774eddSJeremy L Thompson CeedScalar **array); 256ec3da8bcSJed Brown CEED_EXTERN int CeedVectorRestoreArray(CeedVector vec, CeedScalar **array); 257ec3da8bcSJed Brown CEED_EXTERN int CeedVectorRestoreArrayRead(CeedVector vec, 258ec3da8bcSJed Brown const CeedScalar **array); 259ec3da8bcSJed Brown CEED_EXTERN int CeedVectorNorm(CeedVector vec, CeedNormType type, 260ec3da8bcSJed Brown CeedScalar *norm); 261e0dd3b27Sjeremylt CEED_EXTERN int CeedVectorScale(CeedVector x, CeedScalar alpha); 2620f7fd0f8Sjeremylt CEED_EXTERN int CeedVectorAXPY(CeedVector y, CeedScalar alpha, CeedVector x); 2630f7fd0f8Sjeremylt CEED_EXTERN int CeedVectorPointwiseMult(CeedVector w, CeedVector x, CeedVector y); 264ec3da8bcSJed Brown CEED_EXTERN int CeedVectorReciprocal(CeedVector vec); 265d1d35e2fSjeremylt CEED_EXTERN int CeedVectorView(CeedVector vec, const char *fp_fmt, FILE *stream); 266b7c9bbdaSJeremy L Thompson CEED_EXTERN int CeedVectorGetCeed(CeedVector vec, Ceed *ceed); 2671f9221feSJeremy L Thompson CEED_EXTERN int CeedVectorGetLength(CeedVector vec, CeedSize *length); 268ec3da8bcSJed Brown CEED_EXTERN int CeedVectorDestroy(CeedVector *vec); 269ec3da8bcSJed Brown 270ec3da8bcSJed Brown CEED_EXTERN CeedRequest *const CEED_REQUEST_IMMEDIATE; 271ec3da8bcSJed Brown CEED_EXTERN CeedRequest *const CEED_REQUEST_ORDERED; 272ec3da8bcSJed Brown CEED_EXTERN int CeedRequestWait(CeedRequest *req); 273ec3da8bcSJed Brown 274ec3da8bcSJed Brown /// Argument for CeedOperatorSetField that vector is collocated with 275151157abSJeremy L Thompson /// quadrature points, only used with CeedEvalMode CEED_EVAL_NONE 276ec3da8bcSJed Brown /// @ingroup CeedBasis 277ec3da8bcSJed Brown CEED_EXTERN const CeedBasis CEED_BASIS_COLLOCATED; 278ec3da8bcSJed Brown 279ec3da8bcSJed Brown /// Argument for CeedOperatorSetField to use active input or output 280ec3da8bcSJed Brown /// @ingroup CeedVector 281ec3da8bcSJed Brown CEED_EXTERN const CeedVector CEED_VECTOR_ACTIVE; 282ec3da8bcSJed Brown 283ec3da8bcSJed Brown /// Argument for CeedOperatorSetField to use no vector, used with 284ec3da8bcSJed Brown /// qfunction input with eval mode CEED_EVAL_WEIGHT 285ec3da8bcSJed Brown /// @ingroup CeedVector 286ec3da8bcSJed Brown CEED_EXTERN const CeedVector CEED_VECTOR_NONE; 287ec3da8bcSJed Brown 288ec3da8bcSJed Brown /// Argument for CeedOperatorSetField to use no ElemRestriction, only used with 289ec3da8bcSJed Brown /// eval mode CEED_EVAL_WEIGHT. 290ec3da8bcSJed Brown /// @ingroup CeedElemRestriction 291ec3da8bcSJed Brown CEED_EXTERN const CeedElemRestriction CEED_ELEMRESTRICTION_NONE; 292ec3da8bcSJed Brown 293ec3da8bcSJed Brown /// Argument for CeedOperatorCreate that QFunction is not created by user. 294ec3da8bcSJed Brown /// Only used for QFunctions dqf and dqfT. If implemented, a backend may 295ec3da8bcSJed Brown /// attempt to provide the action of these QFunctions. 296ec3da8bcSJed Brown /// @ingroup CeedQFunction 297ec3da8bcSJed Brown CEED_EXTERN const CeedQFunction CEED_QFUNCTION_NONE; 298ec3da8bcSJed Brown 299ec3da8bcSJed Brown /// Denotes whether a linear transformation or its transpose should be applied 300ec3da8bcSJed Brown /// @ingroup CeedBasis 301ec3da8bcSJed Brown typedef enum { 302ec3da8bcSJed Brown /// Apply the linear transformation 303ec3da8bcSJed Brown CEED_NOTRANSPOSE, 304ec3da8bcSJed Brown /// Apply the transpose 305ec3da8bcSJed Brown CEED_TRANSPOSE 306ec3da8bcSJed Brown } CeedTransposeMode; 307ec3da8bcSJed Brown CEED_EXTERN const char *const CeedTransposeModes[]; 308ec3da8bcSJed Brown 309ec3da8bcSJed Brown /// Argument for CeedElemRestrictionCreateStrided that L-vector is in 310ec3da8bcSJed Brown /// the Ceed backend's preferred layout. This argument should only be used 311ec3da8bcSJed Brown /// with vectors created by a Ceed backend. 312ec3da8bcSJed Brown /// @ingroup CeedElemRestriction 313ec3da8bcSJed Brown CEED_EXTERN const CeedInt CEED_STRIDES_BACKEND[3]; 314ec3da8bcSJed Brown 315d1d35e2fSjeremylt CEED_EXTERN int CeedElemRestrictionCreate(Ceed ceed, CeedInt num_elem, 316e79b91d9SJeremy L Thompson CeedInt elem_size, CeedInt num_comp, CeedInt comp_stride, CeedSize l_size, 317d1d35e2fSjeremylt CeedMemType mem_type, CeedCopyMode copy_mode, const CeedInt *offsets, 318ec3da8bcSJed Brown CeedElemRestriction *rstr); 319fc0567d9Srezgarshakeri CEED_EXTERN int CeedElemRestrictionCreateOriented(Ceed ceed, CeedInt num_elem, 320e79b91d9SJeremy L Thompson CeedInt elem_size, CeedInt num_comp, CeedInt comp_stride, CeedSize l_size, 321fc0567d9Srezgarshakeri CeedMemType mem_type, CeedCopyMode copy_mode, const CeedInt *offsets, 322fc0567d9Srezgarshakeri const bool *orient, CeedElemRestriction *rstr); 323ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionCreateStrided(Ceed ceed, 324e79b91d9SJeremy L Thompson CeedInt num_elem, CeedInt elem_size, CeedInt num_comp, CeedSize l_size, 325ec3da8bcSJed Brown const CeedInt strides[3], CeedElemRestriction *rstr); 326d1d35e2fSjeremylt CEED_EXTERN int CeedElemRestrictionCreateBlocked(Ceed ceed, CeedInt num_elem, 327d1d35e2fSjeremylt CeedInt elem_size, CeedInt blk_size, CeedInt num_comp, CeedInt comp_stride, 328e79b91d9SJeremy L Thompson CeedSize l_size, CeedMemType mem_type, CeedCopyMode copy_mode, 329ec3da8bcSJed Brown const CeedInt *offsets, CeedElemRestriction *rstr); 330ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionCreateBlockedStrided(Ceed ceed, 331d1d35e2fSjeremylt CeedInt num_elem, CeedInt elem_size, CeedInt blk_size, CeedInt num_comp, 332e79b91d9SJeremy L Thompson CeedSize l_size, const CeedInt strides[3], CeedElemRestriction *rstr); 3339560d06aSjeremylt CEED_EXTERN int CeedElemRestrictionReferenceCopy(CeedElemRestriction rstr, 3349560d06aSjeremylt CeedElemRestriction *rstr_copy); 335ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionCreateVector(CeedElemRestriction rstr, 336ec3da8bcSJed Brown CeedVector *lvec, CeedVector *evec); 337ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionApply(CeedElemRestriction rstr, 338d1d35e2fSjeremylt CeedTransposeMode t_mode, CeedVector u, CeedVector ru, CeedRequest *request); 339ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionApplyBlock(CeedElemRestriction rstr, 340d1d35e2fSjeremylt CeedInt block, CeedTransposeMode t_mode, CeedVector u, CeedVector ru, 341ec3da8bcSJed Brown CeedRequest *request); 342b7c9bbdaSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionGetCeed(CeedElemRestriction rstr, 343b7c9bbdaSJeremy L Thompson Ceed *ceed); 344ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionGetCompStride(CeedElemRestriction rstr, 345d1d35e2fSjeremylt CeedInt *comp_stride); 346ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionGetNumElements(CeedElemRestriction rstr, 347d1d35e2fSjeremylt CeedInt *num_elem); 348ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionGetElementSize(CeedElemRestriction rstr, 349d1d35e2fSjeremylt CeedInt *elem_size); 350ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionGetLVectorSize(CeedElemRestriction rstr, 351e79b91d9SJeremy L Thompson CeedSize *l_size); 352ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionGetNumComponents(CeedElemRestriction rstr, 353d1d35e2fSjeremylt CeedInt *num_comp); 354ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionGetNumBlocks(CeedElemRestriction rstr, 355d1d35e2fSjeremylt CeedInt *num_blk); 356ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionGetBlockSize(CeedElemRestriction rstr, 357d1d35e2fSjeremylt CeedInt *blk_size); 358ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionGetMultiplicity(CeedElemRestriction rstr, 359ec3da8bcSJed Brown CeedVector mult); 360ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionView(CeedElemRestriction rstr, FILE *stream); 361ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionDestroy(CeedElemRestriction *rstr); 362ec3da8bcSJed Brown 363ec3da8bcSJed Brown // The formalism here is that we have the structure 364ec3da8bcSJed Brown // \int_\Omega v^T f_0(u, \nabla u, qdata) + (\nabla v)^T f_1(u, \nabla u, qdata) 365ec3da8bcSJed Brown // where gradients are with respect to the reference element. 366ec3da8bcSJed Brown 367ec3da8bcSJed Brown /// Basis evaluation mode 368ec3da8bcSJed Brown /// 369ec3da8bcSJed Brown /// Modes can be bitwise ORed when passing to most functions. 370ec3da8bcSJed Brown /// @ingroup CeedBasis 371ec3da8bcSJed Brown typedef enum { 372ec3da8bcSJed Brown /// Perform no evaluation (either because there is no data or it is already at 373ec3da8bcSJed Brown /// quadrature points) 374ec3da8bcSJed Brown CEED_EVAL_NONE = 0, 375ec3da8bcSJed Brown /// Interpolate from nodes to quadrature points 376ec3da8bcSJed Brown CEED_EVAL_INTERP = 1, 377ec3da8bcSJed Brown /// Evaluate gradients at quadrature points from input in a nodal basis 378ec3da8bcSJed Brown CEED_EVAL_GRAD = 2, 379ec3da8bcSJed Brown /// Evaluate divergence at quadrature points from input in a nodal basis 380ec3da8bcSJed Brown CEED_EVAL_DIV = 4, 381ec3da8bcSJed Brown /// Evaluate curl at quadrature points from input in a nodal basis 382ec3da8bcSJed Brown CEED_EVAL_CURL = 8, 383ec3da8bcSJed Brown /// Using no input, evaluate quadrature weights on the reference element 384ec3da8bcSJed Brown CEED_EVAL_WEIGHT = 16, 385ec3da8bcSJed Brown } CeedEvalMode; 386ec3da8bcSJed Brown CEED_EXTERN const char *const CeedEvalModes[]; 387ec3da8bcSJed Brown 388ec3da8bcSJed Brown /// Type of quadrature; also used for location of nodes 389ec3da8bcSJed Brown /// @ingroup CeedBasis 390ec3da8bcSJed Brown typedef enum { 391ec3da8bcSJed Brown /// Gauss-Legendre quadrature 392ec3da8bcSJed Brown CEED_GAUSS = 0, 393ec3da8bcSJed Brown /// Gauss-Legendre-Lobatto quadrature 394ec3da8bcSJed Brown CEED_GAUSS_LOBATTO = 1, 395ec3da8bcSJed Brown } CeedQuadMode; 396ec3da8bcSJed Brown CEED_EXTERN const char *const CeedQuadModes[]; 397ec3da8bcSJed Brown 398ec3da8bcSJed Brown /// Type of basis shape to create non-tensor H1 element basis 399ec3da8bcSJed Brown /// 400ec3da8bcSJed Brown /// Dimension can be extracted with bitwise AND 401ec3da8bcSJed Brown /// (CeedElemTopology & 2**(dim + 2)) == TRUE 402ec3da8bcSJed Brown /// @ingroup CeedBasis 403ec3da8bcSJed Brown typedef enum { 404ec3da8bcSJed Brown /// Line 40550c301a5SRezgar Shakeri CEED_TOPOLOGY_LINE = 1 << 16 | 0, 406ec3da8bcSJed Brown /// Triangle - 2D shape 40750c301a5SRezgar Shakeri CEED_TOPOLOGY_TRIANGLE = 2 << 16 | 1, 408ec3da8bcSJed Brown /// Quadralateral - 2D shape 40950c301a5SRezgar Shakeri CEED_TOPOLOGY_QUAD = 2 << 16 | 2, 410ec3da8bcSJed Brown /// Tetrahedron - 3D shape 41150c301a5SRezgar Shakeri CEED_TOPOLOGY_TET = 3 << 16 | 3, 412ec3da8bcSJed Brown /// Pyramid - 3D shape 41350c301a5SRezgar Shakeri CEED_TOPOLOGY_PYRAMID = 3 << 16 | 4, 414ec3da8bcSJed Brown /// Prism - 3D shape 41550c301a5SRezgar Shakeri CEED_TOPOLOGY_PRISM = 3 << 16 | 5, 416ec3da8bcSJed Brown /// Hexehedron - 3D shape 41750c301a5SRezgar Shakeri CEED_TOPOLOGY_HEX = 3 << 16 | 6, 418ec3da8bcSJed Brown } CeedElemTopology; 419ec3da8bcSJed Brown CEED_EXTERN const char *const CeedElemTopologies[]; 420ec3da8bcSJed Brown 421ec3da8bcSJed Brown CEED_EXTERN int CeedBasisCreateTensorH1Lagrange(Ceed ceed, CeedInt dim, 422d1d35e2fSjeremylt CeedInt num_comp, CeedInt P, CeedInt Q, CeedQuadMode quad_mode, CeedBasis *basis); 423d1d35e2fSjeremylt CEED_EXTERN int CeedBasisCreateTensorH1(Ceed ceed, CeedInt dim, CeedInt num_comp, 424d1d35e2fSjeremylt CeedInt P_1d, CeedInt Q_1d, 425d1d35e2fSjeremylt const CeedScalar *interp_1d, 426d1d35e2fSjeremylt const CeedScalar *grad_1d, 427d1d35e2fSjeremylt const CeedScalar *q_ref_1d, 428d1d35e2fSjeremylt const CeedScalar *q_weight_1d, 429ec3da8bcSJed Brown CeedBasis *basis); 430ec3da8bcSJed Brown CEED_EXTERN int CeedBasisCreateH1(Ceed ceed, CeedElemTopology topo, 431d1d35e2fSjeremylt CeedInt num_comp, 432d1d35e2fSjeremylt CeedInt num_nodes, CeedInt nqpts, 433ec3da8bcSJed Brown const CeedScalar *interp, 434ec3da8bcSJed Brown const CeedScalar *grad, 435d1d35e2fSjeremylt const CeedScalar *q_ref, 436d1d35e2fSjeremylt const CeedScalar *q_weights, CeedBasis *basis); 43750c301a5SRezgar Shakeri CEED_EXTERN int CeedBasisCreateHdiv(Ceed ceed, CeedElemTopology topo, 43850c301a5SRezgar Shakeri CeedInt num_comp, 43950c301a5SRezgar Shakeri CeedInt num_nodes, CeedInt nqpts, 44050c301a5SRezgar Shakeri const CeedScalar *interp, 44150c301a5SRezgar Shakeri const CeedScalar *div, 44250c301a5SRezgar Shakeri const CeedScalar *q_ref, 44350c301a5SRezgar Shakeri const CeedScalar *q_weights, CeedBasis *basis); 444446e7af4SJeremy L Thompson CEED_EXTERN int CeedBasisCreateProjection(CeedBasis basis_from, CeedBasis basis_to, CeedBasis *basis_project); 4459560d06aSjeremylt CEED_EXTERN int CeedBasisReferenceCopy(CeedBasis basis, CeedBasis *basis_copy); 446ec3da8bcSJed Brown CEED_EXTERN int CeedBasisView(CeedBasis basis, FILE *stream); 447d1d35e2fSjeremylt CEED_EXTERN int CeedBasisApply(CeedBasis basis, CeedInt num_elem, 448d1d35e2fSjeremylt CeedTransposeMode t_mode, 449d1d35e2fSjeremylt CeedEvalMode eval_mode, CeedVector u, CeedVector v); 450b7c9bbdaSJeremy L Thompson CEED_EXTERN int CeedBasisGetCeed(CeedBasis basis, Ceed *ceed); 451ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetDimension(CeedBasis basis, CeedInt *dim); 452ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetTopology(CeedBasis basis, CeedElemTopology *topo); 45350c301a5SRezgar Shakeri CEED_EXTERN int CeedBasisGetNumQuadratureComponents(CeedBasis basis, CeedInt *Q_comp); 454d1d35e2fSjeremylt CEED_EXTERN int CeedBasisGetNumComponents(CeedBasis basis, CeedInt *num_comp); 455ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetNumNodes(CeedBasis basis, CeedInt *P); 456d1d35e2fSjeremylt CEED_EXTERN int CeedBasisGetNumNodes1D(CeedBasis basis, CeedInt *P_1d); 457ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetNumQuadraturePoints(CeedBasis basis, CeedInt *Q); 458ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetNumQuadraturePoints1D(CeedBasis basis, 459d1d35e2fSjeremylt CeedInt *Q_1d); 460d1d35e2fSjeremylt CEED_EXTERN int CeedBasisGetQRef(CeedBasis basis, const CeedScalar **q_ref); 461ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetQWeights(CeedBasis basis, 462d1d35e2fSjeremylt const CeedScalar **q_weights); 463ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetInterp(CeedBasis basis, const CeedScalar **interp); 464ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetInterp1D(CeedBasis basis, 465d1d35e2fSjeremylt const CeedScalar **interp_1d); 466ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetGrad(CeedBasis basis, const CeedScalar **grad); 467d1d35e2fSjeremylt CEED_EXTERN int CeedBasisGetGrad1D(CeedBasis basis, const CeedScalar **grad_1d); 46850c301a5SRezgar Shakeri CEED_EXTERN int CeedBasisGetDiv(CeedBasis basis, const CeedScalar **div); 469ec3da8bcSJed Brown CEED_EXTERN int CeedBasisDestroy(CeedBasis *basis); 470ec3da8bcSJed Brown 471d1d35e2fSjeremylt CEED_EXTERN int CeedGaussQuadrature(CeedInt Q, CeedScalar *q_ref_1d, 472d1d35e2fSjeremylt CeedScalar *q_weight_1d); 473d1d35e2fSjeremylt CEED_EXTERN int CeedLobattoQuadrature(CeedInt Q, CeedScalar *q_ref_1d, 474d1d35e2fSjeremylt CeedScalar *q_weight_1d); 475ec3da8bcSJed Brown CEED_EXTERN int CeedQRFactorization(Ceed ceed, CeedScalar *mat, CeedScalar *tau, 476ec3da8bcSJed Brown CeedInt m, CeedInt n); 477ec3da8bcSJed Brown CEED_EXTERN int CeedSymmetricSchurDecomposition(Ceed ceed, CeedScalar *mat, 478ec3da8bcSJed Brown CeedScalar *lambda, CeedInt n); 479d1d35e2fSjeremylt CEED_EXTERN int CeedSimultaneousDiagonalization(Ceed ceed, CeedScalar *mat_A, 480d1d35e2fSjeremylt CeedScalar *mat_B, CeedScalar *x, CeedScalar *lambda, CeedInt n); 481ec3da8bcSJed Brown 482cdf32b93SJeremy L Thompson /** Handle for the user provided CeedQFunction callback function 483ec3da8bcSJed Brown 484cdf32b93SJeremy L Thompson @param[in,out] ctx User-defined context set using CeedQFunctionSetContext() or NULL 485cdf32b93SJeremy L Thompson @param[in] Q Number of quadrature points at which to evaluate 486cdf32b93SJeremy L Thompson @param[in] in Array of pointers to each input argument in the order provided 487ec3da8bcSJed Brown by the user in CeedQFunctionAddInput(). Each array has shape 488d1d35e2fSjeremylt `[dim, num_comp, Q]` where `dim` is the geometric dimension for 489ec3da8bcSJed Brown \ref CEED_EVAL_GRAD (`dim=1` for \ref CEED_EVAL_INTERP) and 490d1d35e2fSjeremylt `num_comp` is the number of field components (`num_comp=1` for 491ec3da8bcSJed Brown scalar fields). This results in indexing the `i`th input at 492d1d35e2fSjeremylt quadrature point `j` as `in[i][(d*num_comp + c)*Q + j]`. 493cdf32b93SJeremy L Thompson @param[out] out Array of pointers to each output array in the order provided 494ec3da8bcSJed Brown using CeedQFunctionAddOutput(). The shapes are as above for 495ec3da8bcSJed Brown \a in. 496ec3da8bcSJed Brown 497ec3da8bcSJed Brown @return An error code: 0 - success, otherwise - failure 498ec3da8bcSJed Brown 499ec3da8bcSJed Brown @ingroup CeedQFunction 500ec3da8bcSJed Brown **/ 501ec3da8bcSJed Brown typedef int (*CeedQFunctionUser)(void *ctx, const CeedInt Q, 502ec3da8bcSJed Brown const CeedScalar *const *in, 503ec3da8bcSJed Brown CeedScalar *const *out); 504ec3da8bcSJed Brown 505d1d35e2fSjeremylt CEED_EXTERN int CeedQFunctionCreateInterior(Ceed ceed, CeedInt vec_length, 506ec3da8bcSJed Brown CeedQFunctionUser f, const char *source, CeedQFunction *qf); 507ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionCreateInteriorByName(Ceed ceed, const char *name, 508ec3da8bcSJed Brown CeedQFunction *qf); 509ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionCreateIdentity(Ceed ceed, CeedInt size, 510d1d35e2fSjeremylt CeedEvalMode in_mode, CeedEvalMode out_mode, CeedQFunction *qf); 5119560d06aSjeremylt CEED_EXTERN int CeedQFunctionReferenceCopy(CeedQFunction qf, CeedQFunction *qf_copy); 512d1d35e2fSjeremylt CEED_EXTERN int CeedQFunctionAddInput(CeedQFunction qf, const char *field_name, 513d1d35e2fSjeremylt CeedInt size, CeedEvalMode eval_mode); 514d1d35e2fSjeremylt CEED_EXTERN int CeedQFunctionAddOutput(CeedQFunction qf, const char *field_name, 515d1d35e2fSjeremylt CeedInt size, CeedEvalMode eval_mode); 51643bbe138SJeremy L Thompson CEED_EXTERN int CeedQFunctionGetFields(CeedQFunction qf, 51743bbe138SJeremy L Thompson CeedInt *num_input_fields, 51843bbe138SJeremy L Thompson CeedQFunctionField **input_fields, 51943bbe138SJeremy L Thompson CeedInt *num_output_fields, 52043bbe138SJeremy L Thompson CeedQFunctionField **output_fields); 521ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionSetContext(CeedQFunction qf, 522ec3da8bcSJed Brown CeedQFunctionContext ctx); 523441428dfSJeremy L Thompson CEED_EXTERN int CeedQFunctionSetContextWritable(CeedQFunction qf, bool is_writable); 5249d36ca50SJeremy L Thompson CEED_EXTERN int CeedQFunctionSetUserFlopsEstimate(CeedQFunction qf, CeedSize flops); 525ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionView(CeedQFunction qf, FILE *stream); 526b7c9bbdaSJeremy L Thompson CEED_EXTERN int CeedQFunctionGetCeed(CeedQFunction qf, Ceed *ceed); 527ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionApply(CeedQFunction qf, CeedInt Q, 528ec3da8bcSJed Brown CeedVector *u, CeedVector *v); 529ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionDestroy(CeedQFunction *qf); 530ec3da8bcSJed Brown 53143bbe138SJeremy L Thompson CEED_EXTERN int CeedQFunctionFieldGetName(CeedQFunctionField qf_field, 53243bbe138SJeremy L Thompson char **field_name); 53343bbe138SJeremy L Thompson CEED_EXTERN int CeedQFunctionFieldGetSize(CeedQFunctionField qf_field, 53443bbe138SJeremy L Thompson CeedInt *size); 53543bbe138SJeremy L Thompson CEED_EXTERN int CeedQFunctionFieldGetEvalMode(CeedQFunctionField qf_field, 53643bbe138SJeremy L Thompson CeedEvalMode *eval_mode); 53743bbe138SJeremy L Thompson 538cdf32b93SJeremy L Thompson /// Denotes type of data stored in a CeedQFunctionContext field 539cdf32b93SJeremy L Thompson /// @ingroup CeedQFunction 540cdf32b93SJeremy L Thompson typedef enum { 541cdf32b93SJeremy L Thompson /// Double precision value 5427bfe0f0eSJeremy L Thompson CEED_CONTEXT_FIELD_DOUBLE = 1, 543cdf32b93SJeremy L Thompson /// 32 bit integer value 5447bfe0f0eSJeremy L Thompson CEED_CONTEXT_FIELD_INT32 = 2, 545cdf32b93SJeremy L Thompson } CeedContextFieldType; 546cdf32b93SJeremy L Thompson CEED_EXTERN const char *const CeedContextFieldTypes[]; 547cdf32b93SJeremy L Thompson 5482790b72bSJeremy L Thompson /** Handle for the user provided CeedQFunctionContextDataDestroy callback function 5492790b72bSJeremy L Thompson 5502790b72bSJeremy L Thompson @param[in,out] data User-CeedQFunctionContext data 5512790b72bSJeremy L Thompson 5522790b72bSJeremy L Thompson @return An error code: 0 - success, otherwise - failure 5532790b72bSJeremy L Thompson 5542790b72bSJeremy L Thompson @ingroup CeedQFunction 5552790b72bSJeremy L Thompson **/ 5562790b72bSJeremy L Thompson typedef int (*CeedQFunctionContextDataDestroyUser)(void *data); 5572790b72bSJeremy L Thompson 558ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionContextCreate(Ceed ceed, 559ec3da8bcSJed Brown CeedQFunctionContext *ctx); 5609560d06aSjeremylt CEED_EXTERN int CeedQFunctionContextReferenceCopy(CeedQFunctionContext ctx, 5619560d06aSjeremylt CeedQFunctionContext *ctx_copy); 562ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionContextSetData(CeedQFunctionContext ctx, 563d1d35e2fSjeremylt CeedMemType mem_type, CeedCopyMode copy_mode, size_t size, void *data); 564891038deSjeremylt CEED_EXTERN int CeedQFunctionContextTakeData(CeedQFunctionContext ctx, 565891038deSjeremylt CeedMemType mem_type, void *data); 566ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionContextGetData(CeedQFunctionContext ctx, 567891038deSjeremylt CeedMemType mem_type, void *data); 56828bfd0b7SJeremy L Thompson CEED_EXTERN int CeedQFunctionContextGetDataRead(CeedQFunctionContext ctx, 56928bfd0b7SJeremy L Thompson CeedMemType mem_type, void *data); 570ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionContextRestoreData(CeedQFunctionContext ctx, 571ec3da8bcSJed Brown void *data); 57228bfd0b7SJeremy L Thompson CEED_EXTERN int CeedQFunctionContextRestoreDataRead(CeedQFunctionContext ctx, 57328bfd0b7SJeremy L Thompson void *data); 574cdf32b93SJeremy L Thompson CEED_EXTERN int CeedQFunctionContextRegisterDouble(CeedQFunctionContext ctx, 5757bfe0f0eSJeremy L Thompson const char *field_name, size_t field_offset, size_t num_values, 5767bfe0f0eSJeremy L Thompson const char *field_description); 577cdf32b93SJeremy L Thompson CEED_EXTERN int CeedQFunctionContextRegisterInt32(CeedQFunctionContext ctx, 5787bfe0f0eSJeremy L Thompson const char *field_name, size_t field_offset, size_t num_values, 5797bfe0f0eSJeremy L Thompson const char *field_description); 5803668ca4bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextGetAllFieldLabels(CeedQFunctionContext ctx, 5813668ca4bSJeremy L Thompson const CeedContextFieldLabel **field_labels, CeedInt *num_fields); 5820f86cbe7SJeremy L Thompson CEED_EXTERN int CeedContextFieldLabelGetDescription(CeedContextFieldLabel label, 5837bfe0f0eSJeremy L Thompson const char **field_name, const char **field_description, size_t *num_values, 5840f86cbe7SJeremy L Thompson CeedContextFieldType *field_type); 58580a9ef05SNatalie Beams CEED_EXTERN int CeedQFunctionContextGetContextSize(CeedQFunctionContext ctx, 58680a9ef05SNatalie Beams size_t *ctx_size); 587ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionContextView(CeedQFunctionContext ctx, 588ec3da8bcSJed Brown FILE *stream); 5892e64a2b9SJeremy L Thompson CEED_EXTERN int CeedQFunctionContextSetDataDestroy(CeedQFunctionContext ctx, 5902e64a2b9SJeremy L Thompson CeedMemType f_mem_type, CeedQFunctionContextDataDestroyUser f); 591ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionContextDestroy(CeedQFunctionContext *ctx); 592ec3da8bcSJed Brown 593ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorCreate(Ceed ceed, CeedQFunction qf, 594ec3da8bcSJed Brown CeedQFunction dqf, CeedQFunction dqfT, 595ec3da8bcSJed Brown CeedOperator *op); 596ec3da8bcSJed Brown CEED_EXTERN int CeedCompositeOperatorCreate(Ceed ceed, CeedOperator *op); 5979560d06aSjeremylt CEED_EXTERN int CeedOperatorReferenceCopy(CeedOperator op, CeedOperator *op_copy); 598d1d35e2fSjeremylt CEED_EXTERN int CeedOperatorSetField(CeedOperator op, const char *field_name, 599ec3da8bcSJed Brown CeedElemRestriction r, CeedBasis b, 600ec3da8bcSJed Brown CeedVector v); 60143bbe138SJeremy L Thompson CEED_EXTERN int CeedOperatorGetFields(CeedOperator op, 60243bbe138SJeremy L Thompson CeedInt *num_input_fields, 60343bbe138SJeremy L Thompson CeedOperatorField **input_fields, 60443bbe138SJeremy L Thompson CeedInt *num_output_fields, 60543bbe138SJeremy L Thompson CeedOperatorField **output_fields); 606d1d35e2fSjeremylt CEED_EXTERN int CeedCompositeOperatorAddSub(CeedOperator composite_op, 607d1d35e2fSjeremylt CeedOperator sub_op); 6084db537f9SJeremy L Thompson CEED_EXTERN int CeedOperatorCheckReady(CeedOperator op); 609c9366a6bSJeremy L Thompson CEED_EXTERN int CeedOperatorGetActiveVectorLengths(CeedOperator op, CeedSize *input_size, CeedSize *output_size); 610beecbf24SJeremy L Thompson CEED_EXTERN int CeedOperatorSetQFunctionAssemblyReuse(CeedOperator op, bool reuse_assembly_data); 611beecbf24SJeremy L Thompson CEED_EXTERN int CeedOperatorSetQFunctionAssemblyDataUpdateNeeded(CeedOperator op, bool needs_data_update); 612ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorLinearAssembleQFunction(CeedOperator op, 613ec3da8bcSJed Brown CeedVector *assembled, CeedElemRestriction *rstr, CeedRequest *request); 61470a7ffb3SJeremy L Thompson CEED_EXTERN int CeedOperatorLinearAssembleQFunctionBuildOrUpdate(CeedOperator op, 61570a7ffb3SJeremy L Thompson CeedVector *assembled, CeedElemRestriction *rstr, CeedRequest *request); 616ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorLinearAssembleDiagonal(CeedOperator op, 617ec3da8bcSJed Brown CeedVector assembled, CeedRequest *request); 618ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorLinearAssembleAddDiagonal(CeedOperator op, 619ec3da8bcSJed Brown CeedVector assembled, CeedRequest *request); 620ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorLinearAssemblePointBlockDiagonal(CeedOperator op, 621ec3da8bcSJed Brown CeedVector assembled, CeedRequest *request); 622ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorLinearAssembleAddPointBlockDiagonal(CeedOperator op, 623ec3da8bcSJed Brown CeedVector assembled, CeedRequest *request); 624ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorLinearAssembleSymbolic(CeedOperator op, 625c30b7fbdSJeremy L Thompson CeedSize *num_entries, CeedInt **rows, CeedInt **cols); 626ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorLinearAssemble(CeedOperator op, CeedVector values); 627d1d35e2fSjeremylt CEED_EXTERN int CeedOperatorMultigridLevelCreate(CeedOperator op_fine, 628d1d35e2fSjeremylt CeedVector p_mult_fine, CeedElemRestriction rstr_coarse, CeedBasis basis_coarse, 629d1d35e2fSjeremylt CeedOperator *op_coarse, CeedOperator *op_prolong, CeedOperator *op_restrict); 630ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorMultigridLevelCreateTensorH1( 631d1d35e2fSjeremylt CeedOperator op_fine, CeedVector p_mult_fine, CeedElemRestriction rstr_coarse, 632d1d35e2fSjeremylt CeedBasis basis_coarse, const CeedScalar *interp_c_to_f, CeedOperator *op_coarse, 633d1d35e2fSjeremylt CeedOperator *op_prolong, CeedOperator *op_restrict); 634d1d35e2fSjeremylt CEED_EXTERN int CeedOperatorMultigridLevelCreateH1(CeedOperator op_fine, 635d1d35e2fSjeremylt CeedVector p_mult_fine, CeedElemRestriction rstr_coarse, CeedBasis basis_coarse, 636d1d35e2fSjeremylt const CeedScalar *interp_c_to_f, CeedOperator *op_coarse, 637d1d35e2fSjeremylt CeedOperator *op_prolong, CeedOperator *op_restrict); 638ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorCreateFDMElementInverse(CeedOperator op, 639d1d35e2fSjeremylt CeedOperator *fdm_inv, CeedRequest *request); 640cd4dfc48Sjeremylt CEED_EXTERN int CeedOperatorSetNumQuadraturePoints(CeedOperator op, CeedInt num_qpts); 641ea6b5821SJeremy L Thompson CEED_EXTERN int CeedOperatorSetName(CeedOperator op, const char *name); 642ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorView(CeedOperator op, FILE *stream); 643b7c9bbdaSJeremy L Thompson CEED_EXTERN int CeedOperatorGetCeed(CeedOperator op, Ceed *ceed); 644b7c9bbdaSJeremy L Thompson CEED_EXTERN int CeedOperatorGetNumElements(CeedOperator op, CeedInt *num_elem); 645b7c9bbdaSJeremy L Thompson CEED_EXTERN int CeedOperatorGetNumQuadraturePoints(CeedOperator op, 646b7c9bbdaSJeremy L Thompson CeedInt *num_qpts); 6479d36ca50SJeremy L Thompson CEED_EXTERN int CeedOperatorGetFlopsEstimate(CeedOperator op, CeedSize *flops); 6483668ca4bSJeremy L Thompson CEED_EXTERN int CeedOperatorContextGetFieldLabel(CeedOperator op, 6493668ca4bSJeremy L Thompson const char *field_name, CeedContextFieldLabel *field_label); 6503668ca4bSJeremy L Thompson CEED_EXTERN int CeedOperatorContextSetDouble(CeedOperator op, 6517bfe0f0eSJeremy L Thompson CeedContextFieldLabel field_label, double *values); 6523668ca4bSJeremy L Thompson CEED_EXTERN int CeedOperatorContextSetInt32(CeedOperator op, 6537bfe0f0eSJeremy L Thompson CeedContextFieldLabel field_label, int *values); 654ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorApply(CeedOperator op, CeedVector in, 655ec3da8bcSJed Brown CeedVector out, CeedRequest *request); 656ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorApplyAdd(CeedOperator op, CeedVector in, 657ec3da8bcSJed Brown CeedVector out, CeedRequest *request); 658ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorDestroy(CeedOperator *op); 659ec3da8bcSJed Brown 66028567f8fSJeremy L Thompson CEED_EXTERN int CeedOperatorFieldGetName(CeedOperatorField op_field, 66128567f8fSJeremy L Thompson char **field_name); 66243bbe138SJeremy L Thompson CEED_EXTERN int CeedOperatorFieldGetElemRestriction(CeedOperatorField op_field, 66343bbe138SJeremy L Thompson CeedElemRestriction *rstr); 66443bbe138SJeremy L Thompson CEED_EXTERN int CeedOperatorFieldGetBasis(CeedOperatorField op_field, 66543bbe138SJeremy L Thompson CeedBasis *basis); 66643bbe138SJeremy L Thompson CEED_EXTERN int CeedOperatorFieldGetVector(CeedOperatorField op_field, 66743bbe138SJeremy L Thompson CeedVector *vec); 66843bbe138SJeremy L Thompson 669ec3da8bcSJed Brown /** 670ec3da8bcSJed Brown @brief Return integer power 671ec3da8bcSJed Brown 672ec3da8bcSJed Brown @param[in] base The base to exponentiate 673ec3da8bcSJed Brown @param[in] power The power to raise the base to 674ec3da8bcSJed Brown 675ec3da8bcSJed Brown @return base^power 676ec3da8bcSJed Brown 677ec3da8bcSJed Brown @ref Utility 678ec3da8bcSJed Brown **/ 679ec3da8bcSJed Brown static inline CeedInt CeedIntPow(CeedInt base, CeedInt power) { 680ec3da8bcSJed Brown CeedInt result = 1; 681ec3da8bcSJed Brown while (power) { 682ec3da8bcSJed Brown if (power & 1) result *= base; 683ec3da8bcSJed Brown power >>= 1; 684ec3da8bcSJed Brown base *= base; 685ec3da8bcSJed Brown } 686ec3da8bcSJed Brown return result; 687ec3da8bcSJed Brown } 688ec3da8bcSJed Brown 689ec3da8bcSJed Brown /** 690ec3da8bcSJed Brown @brief Return minimum of two integers 691ec3da8bcSJed Brown 692ec3da8bcSJed Brown @param[in] a The first integer to compare 693ec3da8bcSJed Brown @param[in] b The second integer to compare 694ec3da8bcSJed Brown 695ec3da8bcSJed Brown @return The minimum of the two integers 696ec3da8bcSJed Brown 697ec3da8bcSJed Brown @ref Utility 698ec3da8bcSJed Brown **/ 699ec3da8bcSJed Brown static inline CeedInt CeedIntMin(CeedInt a, CeedInt b) { return a < b ? a : b; } 700ec3da8bcSJed Brown 701ec3da8bcSJed Brown /** 702ec3da8bcSJed Brown @brief Return maximum of two integers 703ec3da8bcSJed Brown 704ec3da8bcSJed Brown @param[in] a The first integer to compare 705ec3da8bcSJed Brown @param[in] b The second integer to compare 706ec3da8bcSJed Brown 707ec3da8bcSJed Brown @return The maximum of the two integers 708ec3da8bcSJed Brown 709ec3da8bcSJed Brown @ref Utility 710ec3da8bcSJed Brown **/ 711ec3da8bcSJed Brown static inline CeedInt CeedIntMax(CeedInt a, CeedInt b) { return a > b ? a : b; } 712ec3da8bcSJed Brown 713ec3da8bcSJed Brown // Used to ensure initialization before CeedInit() 714ec3da8bcSJed Brown CEED_EXTERN int CeedRegisterAll(void); 715ec3da8bcSJed Brown // Used to ensure initialization before CeedQFunctionCreate*() 716ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionRegisterAll(void); 717ec3da8bcSJed Brown 718ec3da8bcSJed Brown #endif 719