1*ea61e9acSJeremy L Thompson /// Copyright (c) 2017-2022, Lawrence Livermore National Security, LLC and other CEED contributors. 2*ea61e9acSJeremy L Thompson /// All Rights Reserved. See the top-level LICENSE and NOTICE files for details. 3ec3da8bcSJed Brown /// 4*ea61e9acSJeremy L Thompson /// SPDX-License-Identifier: BSD-2-Clause 5ec3da8bcSJed Brown /// 6*ea61e9acSJeremy L Thompson /// This file is part of CEED: http://github.com/ceed 7ec3da8bcSJed Brown 8ec3da8bcSJed Brown /// @file 9ec3da8bcSJed Brown /// Public header for user and utility components of libCEED 10ec3da8bcSJed Brown #ifndef _ceed_h 11ec3da8bcSJed Brown #define _ceed_h 12ec3da8bcSJed Brown 13ec3da8bcSJed Brown /// @defgroup Ceed Ceed: core components 14ec3da8bcSJed Brown /// @defgroup CeedVector CeedVector: storing and manipulating vectors 15ec3da8bcSJed Brown /// @defgroup CeedElemRestriction CeedElemRestriction: restriction from local vectors to elements 16ec3da8bcSJed Brown /// @defgroup CeedBasis CeedBasis: fully discrete finite element-like objects 17ec3da8bcSJed Brown /// @defgroup CeedQFunction CeedQFunction: independent operations at quadrature points 18ec3da8bcSJed Brown /// @defgroup CeedOperator CeedOperator: composed FE-type operations on vectors 19ec3da8bcSJed Brown /// 20*ea61e9acSJeremy L Thompson /// @page FunctionCategories libCEED: Types of Functions libCEED provides three different header files depending upon the type of functions a user 21*ea61e9acSJeremy L Thompson /// requires. 22ec3da8bcSJed Brown /// @section Utility Utility Functions 23*ea61e9acSJeremy L Thompson /// These functions are intended general utilities that may be useful to libCEED developers and users. 24*ea61e9acSJeremy L Thompson /// These functions can generally be found in "ceed.h". 25ec3da8bcSJed Brown /// @section User User Functions 26*ea61e9acSJeremy L Thompson /// These functions are intended to be used by general users of libCEED and can generally be found in "ceed.h". 27e9b533fbSJeremy L Thompson /// @section Advanced Advanced Functions 28*ea61e9acSJeremy L Thompson /// These functions are intended to be used by advanced users of libCEED and can generally be found in "ceed.h". 29ec3da8bcSJed Brown /// @section Backend Backend Developer Functions 30*ea61e9acSJeremy L Thompson /// These functions are intended to be used by backend developers of libCEED and can generally be found in "ceed-backend.h". 31ec3da8bcSJed Brown /// @section Developer Library Developer Functions 32*ea61e9acSJeremy L Thompson /// These functions are intended to be used by library developers of libCEED and can generally be found in "ceed-impl.h". 33ec3da8bcSJed Brown 343b271f31SJed Brown #if !defined(CEED_SKIP_VISIBILITY) 353b271f31SJed Brown #define CEED_VISIBILITY(mode) __attribute__((visibility(#mode))) 363b271f31SJed Brown #else 373b271f31SJed Brown #define CEED_VISIBILITY(mode) 383b271f31SJed Brown #endif 393b271f31SJed Brown 40ec3da8bcSJed Brown /** 41ec3da8bcSJed Brown CEED_EXTERN is used in this header to denote all publicly visible symbols. 42ec3da8bcSJed Brown 43*ea61e9acSJeremy L Thompson No other file should declare publicly visible symbols, thus it should never be used outside ceed.h. 44ec3da8bcSJed Brown */ 452b730f8bSJeremy L Thompson #if defined(__clang_analyzer__) 462b730f8bSJeremy L Thompson #define CEED_EXTERN extern 472b730f8bSJeremy L Thompson #elif defined(__cplusplus) 483b271f31SJed Brown #define CEED_EXTERN extern "C" CEED_VISIBILITY(default) 49ec3da8bcSJed Brown #else 503b271f31SJed Brown #define CEED_EXTERN extern CEED_VISIBILITY(default) 51ec3da8bcSJed Brown #endif 52ec3da8bcSJed Brown 53ec3da8bcSJed Brown #include <stdarg.h> 54ec3da8bcSJed Brown #include <stdbool.h> 553047f789SJeremy L Thompson #include <stdio.h> 56ec3da8bcSJed Brown 57c9c2c079SJeremy L Thompson /// Typedefs and macros used in public interfaces and user QFunction source 58c9c2c079SJeremy L Thompson #include "types.h" 59ec3da8bcSJed Brown 60ec3da8bcSJed Brown /// Library context created by CeedInit() 61ec3da8bcSJed Brown /// @ingroup CeedUser 62ec3da8bcSJed Brown typedef struct Ceed_private *Ceed; 63ec3da8bcSJed Brown /// Non-blocking Ceed interfaces return a CeedRequest. 64ec3da8bcSJed Brown /// To perform an operation immediately, pass \ref CEED_REQUEST_IMMEDIATE instead. 65ec3da8bcSJed Brown /// @ingroup CeedUser 66ec3da8bcSJed Brown typedef struct CeedRequest_private *CeedRequest; 67ec3da8bcSJed Brown /// Handle for vectors over the field \ref CeedScalar 68ec3da8bcSJed Brown /// @ingroup CeedVectorUser 69ec3da8bcSJed Brown typedef struct CeedVector_private *CeedVector; 70ec3da8bcSJed Brown /// Handle for object describing restriction to elements 71ec3da8bcSJed Brown /// @ingroup CeedElemRestrictionUser 72ec3da8bcSJed Brown typedef struct CeedElemRestriction_private *CeedElemRestriction; 73ec3da8bcSJed Brown /// Handle for object describing discrete finite element evaluations 74ec3da8bcSJed Brown /// @ingroup CeedBasisUser 75ec3da8bcSJed Brown typedef struct CeedBasis_private *CeedBasis; 7643bbe138SJeremy L Thompson /// Handle for object describing CeedQFunction fields 7743bbe138SJeremy L Thompson /// @ingroup CeedQFunctionBackend 7843bbe138SJeremy L Thompson typedef struct CeedQFunctionField_private *CeedQFunctionField; 79ec3da8bcSJed Brown /// Handle for object describing functions evaluated independently at quadrature points 80ec3da8bcSJed Brown /// @ingroup CeedQFunctionUser 81ec3da8bcSJed Brown typedef struct CeedQFunction_private *CeedQFunction; 8243bbe138SJeremy L Thompson /// Handle for object describing CeedOperator fields 8343bbe138SJeremy L Thompson /// @ingroup CeedOperatorBackend 8443bbe138SJeremy L Thompson typedef struct CeedOperatorField_private *CeedOperatorField; 85ec3da8bcSJed Brown /// Handle for object describing context data for CeedQFunctions 86ec3da8bcSJed Brown /// @ingroup CeedQFunctionUser 87ec3da8bcSJed Brown typedef struct CeedQFunctionContext_private *CeedQFunctionContext; 883668ca4bSJeremy L Thompson /// Handle for object describing registered fields for CeedQFunctionContext 893668ca4bSJeremy L Thompson /// @ingroup CeedQFunctionUser 903668ca4bSJeremy L Thompson typedef struct CeedContextFieldLabel_private *CeedContextFieldLabel; 91ec3da8bcSJed Brown /// Handle for object describing FE-type operators acting on vectors 92ec3da8bcSJed Brown /// 93*ea61e9acSJeremy L Thompson /// Given an element restriction \f$E\f$, basis evaluator \f$B\f$, and quadrature function\f$f\f$, a CeedOperator expresses operations of the form $$ 94*ea61e9acSJeremy L Thompson /// E^T B^T f(B E u) $$ acting on the vector \f$u\f$. 95ec3da8bcSJed Brown /// @ingroup CeedOperatorUser 96ec3da8bcSJed Brown typedef struct CeedOperator_private *CeedOperator; 97ec3da8bcSJed Brown 9822e44211Sjeremylt CEED_EXTERN int CeedRegistryGetList(size_t *n, char ***const resources, CeedInt **array); 99ec3da8bcSJed Brown CEED_EXTERN int CeedInit(const char *resource, Ceed *ceed); 1009560d06aSjeremylt CEED_EXTERN int CeedReferenceCopy(Ceed ceed, Ceed *ceed_copy); 101ec3da8bcSJed Brown CEED_EXTERN int CeedGetResource(Ceed ceed, const char **resource); 102d1d35e2fSjeremylt CEED_EXTERN int CeedIsDeterministic(Ceed ceed, bool *is_deterministic); 103ee5a26f2SJeremy L Thompson CEED_EXTERN int CeedAddJitSourceRoot(Ceed ceed, const char *jit_source_root); 104ec3da8bcSJed Brown CEED_EXTERN int CeedView(Ceed ceed, FILE *stream); 105ec3da8bcSJed Brown CEED_EXTERN int CeedDestroy(Ceed *ceed); 106ec3da8bcSJed Brown 1072b730f8bSJeremy L Thompson CEED_EXTERN int CeedErrorImpl(Ceed, const char *, int, const char *, int, const char *, ...); 108ec3da8bcSJed Brown /// Raise an error on ceed object 109ec3da8bcSJed Brown /// 110ec3da8bcSJed Brown /// @param ceed Ceed library context or NULL 111ec3da8bcSJed Brown /// @param ecode Error code (int) 112ec3da8bcSJed Brown /// @param ... printf-style format string followed by arguments as needed 113ec3da8bcSJed Brown /// 114ec3da8bcSJed Brown /// @ingroup Ceed 115ec3da8bcSJed Brown /// @sa CeedSetErrorHandler() 116ec3da8bcSJed Brown #if defined(__clang__) 117*ea61e9acSJeremy L Thompson /// Use nonstandard ternary to convince the compiler/clang-tidy that this function never returns zero. 1182b730f8bSJeremy L Thompson #define CeedError(ceed, ecode, ...) (CeedErrorImpl((ceed), __FILE__, __LINE__, __func__, (ecode), __VA_ARGS__), (ecode)) 119ec3da8bcSJed Brown #else 1202b730f8bSJeremy L Thompson #define CeedError(ceed, ecode, ...) CeedErrorImpl((ceed), __FILE__, __LINE__, __func__, (ecode), __VA_ARGS__) ?: (ecode) 121ec3da8bcSJed Brown #endif 122ec3da8bcSJed Brown 123ec3da8bcSJed Brown /// Ceed error handlers 1242b730f8bSJeremy L Thompson CEED_EXTERN int CeedErrorReturn(Ceed, const char *, int, const char *, int, const char *, va_list *); 1252b730f8bSJeremy L Thompson CEED_EXTERN int CeedErrorStore(Ceed, const char *, int, const char *, int, const char *, va_list *); 1262b730f8bSJeremy L Thompson CEED_EXTERN int CeedErrorAbort(Ceed, const char *, int, const char *, int, const char *, va_list *); 1272b730f8bSJeremy L Thompson CEED_EXTERN int CeedErrorExit(Ceed, const char *, int, const char *, int, const char *, va_list *); 1282b730f8bSJeremy L Thompson typedef int (*CeedErrorHandler)(Ceed, const char *, int, const char *, int, const char *, va_list *); 129ec3da8bcSJed Brown CEED_EXTERN int CeedSetErrorHandler(Ceed ceed, CeedErrorHandler eh); 130d1d35e2fSjeremylt CEED_EXTERN int CeedGetErrorMessage(Ceed, const char **err_msg); 131d1d35e2fSjeremylt CEED_EXTERN int CeedResetErrorMessage(Ceed, const char **err_msg); 132ec3da8bcSJed Brown 133ec3da8bcSJed Brown /// libCEED library version numbering 134ec3da8bcSJed Brown /// @ingroup Ceed 135ec3da8bcSJed Brown #define CEED_VERSION_MAJOR 0 136667e613fSJeremy L Thompson #define CEED_VERSION_MINOR 10 137f374d6a3SJeremy L Thompson #define CEED_VERSION_PATCH 1 13838faa2d6SJeremy L Thompson #define CEED_VERSION_RELEASE false 139ec3da8bcSJed Brown 140*ea61e9acSJeremy L Thompson /// Compile-time check that the the current library version is at least as recent as the specified version. 141*ea61e9acSJeremy L Thompson /// This macro is typically used in 142ec3da8bcSJed Brown /// @code 143ec3da8bcSJed Brown /// #if CEED_VERSION_GE(0, 8, 0) 144ec3da8bcSJed Brown /// code path that needs at least 0.8.0 145ec3da8bcSJed Brown /// #else 146ec3da8bcSJed Brown /// fallback code for older versions 147ec3da8bcSJed Brown /// #endif 148ec3da8bcSJed Brown /// @endcode 149ec3da8bcSJed Brown /// 150ec3da8bcSJed Brown /// A non-release version always compares as positive infinity. 151ec3da8bcSJed Brown /// 152ec3da8bcSJed Brown /// @param major Major version 153ec3da8bcSJed Brown /// @param minor Minor version 154ec3da8bcSJed Brown /// @param patch Patch (subminor) version 155ec3da8bcSJed Brown /// 156ec3da8bcSJed Brown /// @ingroup Ceed 157ec3da8bcSJed Brown /// @sa CeedGetVersion() 158ec3da8bcSJed Brown #define CEED_VERSION_GE(major, minor, patch) \ 159ec3da8bcSJed Brown (!CEED_VERSION_RELEASE || \ 160ec3da8bcSJed Brown (CEED_VERSION_MAJOR > major || \ 1612b730f8bSJeremy L Thompson (CEED_VERSION_MAJOR == major && (CEED_VERSION_MINOR > minor || (CEED_VERSION_MINOR == minor && CEED_VERSION_PATCH >= patch))))) 162ec3da8bcSJed Brown 1632b730f8bSJeremy L Thompson CEED_EXTERN int CeedGetVersion(int *major, int *minor, int *patch, bool *release); 164ec3da8bcSJed Brown 16580a9ef05SNatalie Beams CEED_EXTERN int CeedGetScalarType(CeedScalarType *scalar_type); 16680a9ef05SNatalie Beams 167ec3da8bcSJed Brown CEED_EXTERN const char *const *CeedErrorTypes; 168ec3da8bcSJed Brown 169ec3da8bcSJed Brown /// Specify memory type 170ec3da8bcSJed Brown /// 171*ea61e9acSJeremy L Thompson /// Many Ceed interfaces take or return pointers to memory. 172*ea61e9acSJeremy L Thompson /// This enum is used to specify where the memory being provided or requested must reside. 173ec3da8bcSJed Brown /// @ingroup Ceed 174ec3da8bcSJed Brown typedef enum { 175ec3da8bcSJed Brown /// Memory resides on the host 176ec3da8bcSJed Brown CEED_MEM_HOST, 177ec3da8bcSJed Brown /// Memory resides on a device (corresponding to \ref Ceed resource) 178ec3da8bcSJed Brown CEED_MEM_DEVICE, 179ec3da8bcSJed Brown } CeedMemType; 180ec3da8bcSJed Brown CEED_EXTERN const char *const CeedMemTypes[]; 181ec3da8bcSJed Brown 182ec3da8bcSJed Brown CEED_EXTERN int CeedGetPreferredMemType(Ceed ceed, CeedMemType *type); 183ec3da8bcSJed Brown 184ec3da8bcSJed Brown /// Conveys ownership status of arrays passed to Ceed interfaces. 185ec3da8bcSJed Brown /// @ingroup Ceed 186ec3da8bcSJed Brown typedef enum { 187ec3da8bcSJed Brown /// Implementation will copy the values and not store the passed pointer. 188ec3da8bcSJed Brown CEED_COPY_VALUES, 189*ea61e9acSJeremy L Thompson /// Implementation can use and modify the data provided by the user, but does not take ownership. 190ec3da8bcSJed Brown CEED_USE_POINTER, 191*ea61e9acSJeremy L Thompson /// Implementation takes ownership of the pointer and will free using CeedFree() when done using it. 192*ea61e9acSJeremy L Thompson /// The user should not assume that the pointer remains valid after ownership has been transferred. 193*ea61e9acSJeremy L Thompson /// Note that arrays allocated using C++ operator new or other allocators cannot generally be freed using CeedFree(). 194*ea61e9acSJeremy L Thompson /// CeedFree() is capable of freeing any memory that can be freed using free(). 195ec3da8bcSJed Brown CEED_OWN_POINTER, 196ec3da8bcSJed Brown } CeedCopyMode; 197cdf32b93SJeremy L Thompson CEED_EXTERN const char *const CeedCopyModes[]; 198ec3da8bcSJed Brown 199ec3da8bcSJed Brown /// Denotes type of vector norm to be computed 200ec3da8bcSJed Brown /// @ingroup CeedVector 201ec3da8bcSJed Brown typedef enum { 202ec3da8bcSJed Brown /// L_1 norm: sum_i |x_i| 203ec3da8bcSJed Brown CEED_NORM_1, 204ec3da8bcSJed Brown /// L_2 norm: sqrt(sum_i |x_i|^2) 205ec3da8bcSJed Brown CEED_NORM_2, 206ec3da8bcSJed Brown /// L_Infinity norm: max_i |x_i| 207ec3da8bcSJed Brown CEED_NORM_MAX, 208ec3da8bcSJed Brown } CeedNormType; 209ec3da8bcSJed Brown 2101f9221feSJeremy L Thompson CEED_EXTERN int CeedVectorCreate(Ceed ceed, CeedSize len, CeedVector *vec); 2119560d06aSjeremylt CEED_EXTERN int CeedVectorReferenceCopy(CeedVector vec, CeedVector *vec_copy); 2122b730f8bSJeremy L Thompson CEED_EXTERN int CeedVectorSetArray(CeedVector vec, CeedMemType mem_type, CeedCopyMode copy_mode, CeedScalar *array); 213ec3da8bcSJed Brown CEED_EXTERN int CeedVectorSetValue(CeedVector vec, CeedScalar value); 214d1d35e2fSjeremylt CEED_EXTERN int CeedVectorSyncArray(CeedVector vec, CeedMemType mem_type); 2152b730f8bSJeremy L Thompson CEED_EXTERN int CeedVectorTakeArray(CeedVector vec, CeedMemType mem_type, CeedScalar **array); 2162b730f8bSJeremy L Thompson CEED_EXTERN int CeedVectorGetArray(CeedVector vec, CeedMemType mem_type, CeedScalar **array); 2172b730f8bSJeremy L Thompson CEED_EXTERN int CeedVectorGetArrayRead(CeedVector vec, CeedMemType mem_type, const CeedScalar **array); 2182b730f8bSJeremy L Thompson CEED_EXTERN int CeedVectorGetArrayWrite(CeedVector vec, CeedMemType mem_type, CeedScalar **array); 219ec3da8bcSJed Brown CEED_EXTERN int CeedVectorRestoreArray(CeedVector vec, CeedScalar **array); 2202b730f8bSJeremy L Thompson CEED_EXTERN int CeedVectorRestoreArrayRead(CeedVector vec, const CeedScalar **array); 2212b730f8bSJeremy L Thompson CEED_EXTERN int CeedVectorNorm(CeedVector vec, CeedNormType type, CeedScalar *norm); 222e0dd3b27Sjeremylt CEED_EXTERN int CeedVectorScale(CeedVector x, CeedScalar alpha); 2230f7fd0f8Sjeremylt CEED_EXTERN int CeedVectorAXPY(CeedVector y, CeedScalar alpha, CeedVector x); 2240f7fd0f8Sjeremylt CEED_EXTERN int CeedVectorPointwiseMult(CeedVector w, CeedVector x, CeedVector y); 225ec3da8bcSJed Brown CEED_EXTERN int CeedVectorReciprocal(CeedVector vec); 226d1d35e2fSjeremylt CEED_EXTERN int CeedVectorView(CeedVector vec, const char *fp_fmt, FILE *stream); 227b7c9bbdaSJeremy L Thompson CEED_EXTERN int CeedVectorGetCeed(CeedVector vec, Ceed *ceed); 2281f9221feSJeremy L Thompson CEED_EXTERN int CeedVectorGetLength(CeedVector vec, CeedSize *length); 229ec3da8bcSJed Brown CEED_EXTERN int CeedVectorDestroy(CeedVector *vec); 230ec3da8bcSJed Brown 231ec3da8bcSJed Brown CEED_EXTERN CeedRequest *const CEED_REQUEST_IMMEDIATE; 232ec3da8bcSJed Brown CEED_EXTERN CeedRequest *const CEED_REQUEST_ORDERED; 233ec3da8bcSJed Brown CEED_EXTERN int CeedRequestWait(CeedRequest *req); 234ec3da8bcSJed Brown 235*ea61e9acSJeremy L Thompson /// Argument for CeedOperatorSetField that vector is collocated with quadrature points, only used with CeedEvalMode CEED_EVAL_NONE 236ec3da8bcSJed Brown /// @ingroup CeedBasis 237ec3da8bcSJed Brown CEED_EXTERN const CeedBasis CEED_BASIS_COLLOCATED; 238ec3da8bcSJed Brown 239ec3da8bcSJed Brown /// Argument for CeedOperatorSetField to use active input or output 240ec3da8bcSJed Brown /// @ingroup CeedVector 241ec3da8bcSJed Brown CEED_EXTERN const CeedVector CEED_VECTOR_ACTIVE; 242ec3da8bcSJed Brown 243*ea61e9acSJeremy L Thompson /// Argument for CeedOperatorSetField to use no vector, used with QFunction input with eval mode CEED_EVAL_WEIGHT 244ec3da8bcSJed Brown /// @ingroup CeedVector 245ec3da8bcSJed Brown CEED_EXTERN const CeedVector CEED_VECTOR_NONE; 246ec3da8bcSJed Brown 247*ea61e9acSJeremy L Thompson /// Argument for CeedOperatorSetField to use no ElemRestriction, only used with eval mode CEED_EVAL_WEIGHT. 248ec3da8bcSJed Brown /// @ingroup CeedElemRestriction 249ec3da8bcSJed Brown CEED_EXTERN const CeedElemRestriction CEED_ELEMRESTRICTION_NONE; 250ec3da8bcSJed Brown 251ec3da8bcSJed Brown /// Argument for CeedOperatorCreate that QFunction is not created by user. 252*ea61e9acSJeremy L Thompson /// Only used for QFunctions dqf and dqfT. 253*ea61e9acSJeremy L Thompson /// If implemented, a backend may attempt to provide the action of these QFunctions. 254ec3da8bcSJed Brown /// @ingroup CeedQFunction 255ec3da8bcSJed Brown CEED_EXTERN const CeedQFunction CEED_QFUNCTION_NONE; 256ec3da8bcSJed Brown 257ec3da8bcSJed Brown /// Denotes whether a linear transformation or its transpose should be applied 258ec3da8bcSJed Brown /// @ingroup CeedBasis 259ec3da8bcSJed Brown typedef enum { 260ec3da8bcSJed Brown /// Apply the linear transformation 261ec3da8bcSJed Brown CEED_NOTRANSPOSE, 262ec3da8bcSJed Brown /// Apply the transpose 263ec3da8bcSJed Brown CEED_TRANSPOSE 264ec3da8bcSJed Brown } CeedTransposeMode; 265ec3da8bcSJed Brown CEED_EXTERN const char *const CeedTransposeModes[]; 266ec3da8bcSJed Brown 267*ea61e9acSJeremy L Thompson /// Argument for CeedElemRestrictionCreateStrided that L-vector is in the Ceed backend's preferred layout. 268*ea61e9acSJeremy L Thompson /// This argument should only be used with vectors created by a Ceed backend. 269ec3da8bcSJed Brown /// @ingroup CeedElemRestriction 270ec3da8bcSJed Brown CEED_EXTERN const CeedInt CEED_STRIDES_BACKEND[3]; 271ec3da8bcSJed Brown 2722b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionCreate(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt num_comp, CeedInt comp_stride, CeedSize l_size, 2732b730f8bSJeremy L Thompson CeedMemType mem_type, CeedCopyMode copy_mode, const CeedInt *offsets, CeedElemRestriction *rstr); 2742b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionCreateOriented(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt num_comp, CeedInt comp_stride, 2752b730f8bSJeremy L Thompson CeedSize l_size, CeedMemType mem_type, CeedCopyMode copy_mode, const CeedInt *offsets, 276fc0567d9Srezgarshakeri const bool *orient, CeedElemRestriction *rstr); 2772b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionCreateStrided(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt num_comp, CeedSize l_size, 278ec3da8bcSJed Brown const CeedInt strides[3], CeedElemRestriction *rstr); 2792b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionCreateBlocked(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt blk_size, CeedInt num_comp, 2802b730f8bSJeremy L Thompson CeedInt comp_stride, CeedSize l_size, CeedMemType mem_type, CeedCopyMode copy_mode, 281ec3da8bcSJed Brown const CeedInt *offsets, CeedElemRestriction *rstr); 2822b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionCreateBlockedStrided(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt blk_size, CeedInt num_comp, 283e79b91d9SJeremy L Thompson CeedSize l_size, const CeedInt strides[3], CeedElemRestriction *rstr); 2842b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionReferenceCopy(CeedElemRestriction rstr, CeedElemRestriction *rstr_copy); 2852b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionCreateVector(CeedElemRestriction rstr, CeedVector *lvec, CeedVector *evec); 2862b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionApply(CeedElemRestriction rstr, CeedTransposeMode t_mode, CeedVector u, CeedVector ru, CeedRequest *request); 2872b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionApplyBlock(CeedElemRestriction rstr, CeedInt block, CeedTransposeMode t_mode, CeedVector u, CeedVector ru, 288ec3da8bcSJed Brown CeedRequest *request); 2892b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionGetCeed(CeedElemRestriction rstr, Ceed *ceed); 2902b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionGetCompStride(CeedElemRestriction rstr, CeedInt *comp_stride); 2912b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionGetNumElements(CeedElemRestriction rstr, CeedInt *num_elem); 2922b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionGetElementSize(CeedElemRestriction rstr, CeedInt *elem_size); 2932b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionGetLVectorSize(CeedElemRestriction rstr, CeedSize *l_size); 2942b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionGetNumComponents(CeedElemRestriction rstr, CeedInt *num_comp); 2952b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionGetNumBlocks(CeedElemRestriction rstr, CeedInt *num_blk); 2962b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionGetBlockSize(CeedElemRestriction rstr, CeedInt *blk_size); 2972b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionGetMultiplicity(CeedElemRestriction rstr, CeedVector mult); 298ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionView(CeedElemRestriction rstr, FILE *stream); 299ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionDestroy(CeedElemRestriction *rstr); 300ec3da8bcSJed Brown 301ec3da8bcSJed Brown // The formalism here is that we have the structure 302ec3da8bcSJed Brown // \int_\Omega v^T f_0(u, \nabla u, qdata) + (\nabla v)^T f_1(u, \nabla u, qdata) 303ec3da8bcSJed Brown // where gradients are with respect to the reference element. 304ec3da8bcSJed Brown 305ec3da8bcSJed Brown /// Basis evaluation mode 306ec3da8bcSJed Brown /// 307ec3da8bcSJed Brown /// Modes can be bitwise ORed when passing to most functions. 308ec3da8bcSJed Brown /// @ingroup CeedBasis 309ec3da8bcSJed Brown typedef enum { 310*ea61e9acSJeremy L Thompson /// Perform no evaluation (either because there is no data or it is already at quadrature points) 311ec3da8bcSJed Brown CEED_EVAL_NONE = 0, 312ec3da8bcSJed Brown /// Interpolate from nodes to quadrature points 313ec3da8bcSJed Brown CEED_EVAL_INTERP = 1, 314ec3da8bcSJed Brown /// Evaluate gradients at quadrature points from input in a nodal basis 315ec3da8bcSJed Brown CEED_EVAL_GRAD = 2, 316ec3da8bcSJed Brown /// Evaluate divergence at quadrature points from input in a nodal basis 317ec3da8bcSJed Brown CEED_EVAL_DIV = 4, 318ec3da8bcSJed Brown /// Evaluate curl at quadrature points from input in a nodal basis 319ec3da8bcSJed Brown CEED_EVAL_CURL = 8, 320ec3da8bcSJed Brown /// Using no input, evaluate quadrature weights on the reference element 321ec3da8bcSJed Brown CEED_EVAL_WEIGHT = 16, 322ec3da8bcSJed Brown } CeedEvalMode; 323ec3da8bcSJed Brown CEED_EXTERN const char *const CeedEvalModes[]; 324ec3da8bcSJed Brown 325ec3da8bcSJed Brown /// Type of quadrature; also used for location of nodes 326ec3da8bcSJed Brown /// @ingroup CeedBasis 327ec3da8bcSJed Brown typedef enum { 328ec3da8bcSJed Brown /// Gauss-Legendre quadrature 329ec3da8bcSJed Brown CEED_GAUSS = 0, 330ec3da8bcSJed Brown /// Gauss-Legendre-Lobatto quadrature 331ec3da8bcSJed Brown CEED_GAUSS_LOBATTO = 1, 332ec3da8bcSJed Brown } CeedQuadMode; 333ec3da8bcSJed Brown CEED_EXTERN const char *const CeedQuadModes[]; 334ec3da8bcSJed Brown 335ec3da8bcSJed Brown /// Type of basis shape to create non-tensor H1 element basis 336ec3da8bcSJed Brown /// 337*ea61e9acSJeremy L Thompson /// Dimension can be extracted with bitwise AND (CeedElemTopology & 2**(dim + 2)) == TRUE 338ec3da8bcSJed Brown /// @ingroup CeedBasis 339ec3da8bcSJed Brown typedef enum { 340ec3da8bcSJed Brown /// Line 34150c301a5SRezgar Shakeri CEED_TOPOLOGY_LINE = 1 << 16 | 0, 342ec3da8bcSJed Brown /// Triangle - 2D shape 34350c301a5SRezgar Shakeri CEED_TOPOLOGY_TRIANGLE = 2 << 16 | 1, 344ec3da8bcSJed Brown /// Quadralateral - 2D shape 34550c301a5SRezgar Shakeri CEED_TOPOLOGY_QUAD = 2 << 16 | 2, 346ec3da8bcSJed Brown /// Tetrahedron - 3D shape 34750c301a5SRezgar Shakeri CEED_TOPOLOGY_TET = 3 << 16 | 3, 348ec3da8bcSJed Brown /// Pyramid - 3D shape 34950c301a5SRezgar Shakeri CEED_TOPOLOGY_PYRAMID = 3 << 16 | 4, 350ec3da8bcSJed Brown /// Prism - 3D shape 35150c301a5SRezgar Shakeri CEED_TOPOLOGY_PRISM = 3 << 16 | 5, 352ec3da8bcSJed Brown /// Hexehedron - 3D shape 35350c301a5SRezgar Shakeri CEED_TOPOLOGY_HEX = 3 << 16 | 6, 354ec3da8bcSJed Brown } CeedElemTopology; 355ec3da8bcSJed Brown CEED_EXTERN const char *const CeedElemTopologies[]; 356ec3da8bcSJed Brown 3572b730f8bSJeremy L Thompson CEED_EXTERN int CeedBasisCreateTensorH1Lagrange(Ceed ceed, CeedInt dim, CeedInt num_comp, CeedInt P, CeedInt Q, CeedQuadMode quad_mode, 358ec3da8bcSJed Brown CeedBasis *basis); 3592b730f8bSJeremy L Thompson CEED_EXTERN int CeedBasisCreateTensorH1(Ceed ceed, CeedInt dim, CeedInt num_comp, CeedInt P_1d, CeedInt Q_1d, const CeedScalar *interp_1d, 3602b730f8bSJeremy L Thompson const CeedScalar *grad_1d, const CeedScalar *q_ref_1d, const CeedScalar *q_weight_1d, CeedBasis *basis); 3612b730f8bSJeremy L Thompson CEED_EXTERN int CeedBasisCreateH1(Ceed ceed, CeedElemTopology topo, CeedInt num_comp, CeedInt num_nodes, CeedInt nqpts, const CeedScalar *interp, 3622b730f8bSJeremy L Thompson const CeedScalar *grad, const CeedScalar *q_ref, const CeedScalar *q_weights, CeedBasis *basis); 3632b730f8bSJeremy L Thompson CEED_EXTERN int CeedBasisCreateHdiv(Ceed ceed, CeedElemTopology topo, CeedInt num_comp, CeedInt num_nodes, CeedInt nqpts, const CeedScalar *interp, 3642b730f8bSJeremy L Thompson const CeedScalar *div, const CeedScalar *q_ref, const CeedScalar *q_weights, CeedBasis *basis); 365446e7af4SJeremy L Thompson CEED_EXTERN int CeedBasisCreateProjection(CeedBasis basis_from, CeedBasis basis_to, CeedBasis *basis_project); 3669560d06aSjeremylt CEED_EXTERN int CeedBasisReferenceCopy(CeedBasis basis, CeedBasis *basis_copy); 367ec3da8bcSJed Brown CEED_EXTERN int CeedBasisView(CeedBasis basis, FILE *stream); 3682b730f8bSJeremy L Thompson CEED_EXTERN int CeedBasisApply(CeedBasis basis, CeedInt num_elem, CeedTransposeMode t_mode, CeedEvalMode eval_mode, CeedVector u, CeedVector v); 369b7c9bbdaSJeremy L Thompson CEED_EXTERN int CeedBasisGetCeed(CeedBasis basis, Ceed *ceed); 370ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetDimension(CeedBasis basis, CeedInt *dim); 371ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetTopology(CeedBasis basis, CeedElemTopology *topo); 37250c301a5SRezgar Shakeri CEED_EXTERN int CeedBasisGetNumQuadratureComponents(CeedBasis basis, CeedInt *Q_comp); 373d1d35e2fSjeremylt CEED_EXTERN int CeedBasisGetNumComponents(CeedBasis basis, CeedInt *num_comp); 374ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetNumNodes(CeedBasis basis, CeedInt *P); 375d1d35e2fSjeremylt CEED_EXTERN int CeedBasisGetNumNodes1D(CeedBasis basis, CeedInt *P_1d); 376ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetNumQuadraturePoints(CeedBasis basis, CeedInt *Q); 3772b730f8bSJeremy L Thompson CEED_EXTERN int CeedBasisGetNumQuadraturePoints1D(CeedBasis basis, CeedInt *Q_1d); 378d1d35e2fSjeremylt CEED_EXTERN int CeedBasisGetQRef(CeedBasis basis, const CeedScalar **q_ref); 3792b730f8bSJeremy L Thompson CEED_EXTERN int CeedBasisGetQWeights(CeedBasis basis, const CeedScalar **q_weights); 380ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetInterp(CeedBasis basis, const CeedScalar **interp); 3812b730f8bSJeremy L Thompson CEED_EXTERN int CeedBasisGetInterp1D(CeedBasis basis, const CeedScalar **interp_1d); 382ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetGrad(CeedBasis basis, const CeedScalar **grad); 383d1d35e2fSjeremylt CEED_EXTERN int CeedBasisGetGrad1D(CeedBasis basis, const CeedScalar **grad_1d); 38450c301a5SRezgar Shakeri CEED_EXTERN int CeedBasisGetDiv(CeedBasis basis, const CeedScalar **div); 385ec3da8bcSJed Brown CEED_EXTERN int CeedBasisDestroy(CeedBasis *basis); 386ec3da8bcSJed Brown 3872b730f8bSJeremy L Thompson CEED_EXTERN int CeedGaussQuadrature(CeedInt Q, CeedScalar *q_ref_1d, CeedScalar *q_weight_1d); 3882b730f8bSJeremy L Thompson CEED_EXTERN int CeedLobattoQuadrature(CeedInt Q, CeedScalar *q_ref_1d, CeedScalar *q_weight_1d); 3892b730f8bSJeremy L Thompson CEED_EXTERN int CeedQRFactorization(Ceed ceed, CeedScalar *mat, CeedScalar *tau, CeedInt m, CeedInt n); 3902b730f8bSJeremy L Thompson CEED_EXTERN int CeedSymmetricSchurDecomposition(Ceed ceed, CeedScalar *mat, CeedScalar *lambda, CeedInt n); 3912b730f8bSJeremy L Thompson CEED_EXTERN int CeedSimultaneousDiagonalization(Ceed ceed, CeedScalar *mat_A, CeedScalar *mat_B, CeedScalar *x, CeedScalar *lambda, CeedInt n); 392ec3da8bcSJed Brown 393cdf32b93SJeremy L Thompson /** Handle for the user provided CeedQFunction callback function 394ec3da8bcSJed Brown 395cdf32b93SJeremy L Thompson @param[in,out] ctx User-defined context set using CeedQFunctionSetContext() or NULL 396cdf32b93SJeremy L Thompson @param[in] Q Number of quadrature points at which to evaluate 397*ea61e9acSJeremy L Thompson @param[in] in Array of pointers to each input argument in the order provided by the user in CeedQFunctionAddInput(). 398*ea61e9acSJeremy L Thompson Each array has shape `[dim, num_comp, Q]` where `dim` is the geometric dimension for \ref CEED_EVAL_GRAD (`dim=1` for \ref 399*ea61e9acSJeremy L Thompson CEED_EVAL_INTERP) and `num_comp` is the number of field components (`num_comp=1` for scalar fields). This results in indexing the `i`th input at 400d1d35e2fSjeremylt quadrature point `j` as `in[i][(d*num_comp + c)*Q + j]`. 401*ea61e9acSJeremy L Thompson @param[out] out Array of pointers to each output array in the order provided using CeedQFunctionAddOutput(). 402*ea61e9acSJeremy L Thompson The shapes are as above for \a in. 403ec3da8bcSJed Brown 404ec3da8bcSJed Brown @return An error code: 0 - success, otherwise - failure 405ec3da8bcSJed Brown 406ec3da8bcSJed Brown @ingroup CeedQFunction 407ec3da8bcSJed Brown **/ 4082b730f8bSJeremy L Thompson typedef int (*CeedQFunctionUser)(void *ctx, const CeedInt Q, const CeedScalar *const *in, CeedScalar *const *out); 409ec3da8bcSJed Brown 4102b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionCreateInterior(Ceed ceed, CeedInt vec_length, CeedQFunctionUser f, const char *source, CeedQFunction *qf); 4112b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionCreateInteriorByName(Ceed ceed, const char *name, CeedQFunction *qf); 4122b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionCreateIdentity(Ceed ceed, CeedInt size, CeedEvalMode in_mode, CeedEvalMode out_mode, CeedQFunction *qf); 4139560d06aSjeremylt CEED_EXTERN int CeedQFunctionReferenceCopy(CeedQFunction qf, CeedQFunction *qf_copy); 4142b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionAddInput(CeedQFunction qf, const char *field_name, CeedInt size, CeedEvalMode eval_mode); 4152b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionAddOutput(CeedQFunction qf, const char *field_name, CeedInt size, CeedEvalMode eval_mode); 4162b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionGetFields(CeedQFunction qf, CeedInt *num_input_fields, CeedQFunctionField **input_fields, CeedInt *num_output_fields, 41743bbe138SJeremy L Thompson CeedQFunctionField **output_fields); 4182b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionSetContext(CeedQFunction qf, CeedQFunctionContext ctx); 419441428dfSJeremy L Thompson CEED_EXTERN int CeedQFunctionSetContextWritable(CeedQFunction qf, bool is_writable); 4209d36ca50SJeremy L Thompson CEED_EXTERN int CeedQFunctionSetUserFlopsEstimate(CeedQFunction qf, CeedSize flops); 421ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionView(CeedQFunction qf, FILE *stream); 422b7c9bbdaSJeremy L Thompson CEED_EXTERN int CeedQFunctionGetCeed(CeedQFunction qf, Ceed *ceed); 4232b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionApply(CeedQFunction qf, CeedInt Q, CeedVector *u, CeedVector *v); 424ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionDestroy(CeedQFunction *qf); 425ec3da8bcSJed Brown 4262b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionFieldGetName(CeedQFunctionField qf_field, char **field_name); 4272b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionFieldGetSize(CeedQFunctionField qf_field, CeedInt *size); 4282b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionFieldGetEvalMode(CeedQFunctionField qf_field, CeedEvalMode *eval_mode); 42943bbe138SJeremy L Thompson 430cdf32b93SJeremy L Thompson /// Denotes type of data stored in a CeedQFunctionContext field 431cdf32b93SJeremy L Thompson /// @ingroup CeedQFunction 432cdf32b93SJeremy L Thompson typedef enum { 433cdf32b93SJeremy L Thompson /// Double precision value 4347bfe0f0eSJeremy L Thompson CEED_CONTEXT_FIELD_DOUBLE = 1, 435cdf32b93SJeremy L Thompson /// 32 bit integer value 4367bfe0f0eSJeremy L Thompson CEED_CONTEXT_FIELD_INT32 = 2, 437cdf32b93SJeremy L Thompson } CeedContextFieldType; 438cdf32b93SJeremy L Thompson CEED_EXTERN const char *const CeedContextFieldTypes[]; 439cdf32b93SJeremy L Thompson 4402790b72bSJeremy L Thompson /** Handle for the user provided CeedQFunctionContextDataDestroy callback function 4412790b72bSJeremy L Thompson 4422790b72bSJeremy L Thompson @param[in,out] data User-CeedQFunctionContext data 4432790b72bSJeremy L Thompson 4442790b72bSJeremy L Thompson @return An error code: 0 - success, otherwise - failure 4452790b72bSJeremy L Thompson 4462790b72bSJeremy L Thompson @ingroup CeedQFunction 4472790b72bSJeremy L Thompson **/ 4482790b72bSJeremy L Thompson typedef int (*CeedQFunctionContextDataDestroyUser)(void *data); 4492790b72bSJeremy L Thompson 4502b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextCreate(Ceed ceed, CeedQFunctionContext *ctx); 4512b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextReferenceCopy(CeedQFunctionContext ctx, CeedQFunctionContext *ctx_copy); 4522b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextSetData(CeedQFunctionContext ctx, CeedMemType mem_type, CeedCopyMode copy_mode, size_t size, void *data); 4532b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextTakeData(CeedQFunctionContext ctx, CeedMemType mem_type, void *data); 4542b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextGetData(CeedQFunctionContext ctx, CeedMemType mem_type, void *data); 4552b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextGetDataRead(CeedQFunctionContext ctx, CeedMemType mem_type, void *data); 4562b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextRestoreData(CeedQFunctionContext ctx, void *data); 4572b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextRestoreDataRead(CeedQFunctionContext ctx, void *data); 4582b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextRegisterDouble(CeedQFunctionContext ctx, const char *field_name, size_t field_offset, size_t num_values, 4597bfe0f0eSJeremy L Thompson const char *field_description); 4602b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextRegisterInt32(CeedQFunctionContext ctx, const char *field_name, size_t field_offset, size_t num_values, 4617bfe0f0eSJeremy L Thompson const char *field_description); 4622b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextGetAllFieldLabels(CeedQFunctionContext ctx, const CeedContextFieldLabel **field_labels, CeedInt *num_fields); 4632b730f8bSJeremy L Thompson CEED_EXTERN int CeedContextFieldLabelGetDescription(CeedContextFieldLabel label, const char **field_name, const char **field_description, 4642b730f8bSJeremy L Thompson size_t *num_values, CeedContextFieldType *field_type); 4652b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextGetContextSize(CeedQFunctionContext ctx, size_t *ctx_size); 4662b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextView(CeedQFunctionContext ctx, FILE *stream); 4672b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextSetDataDestroy(CeedQFunctionContext ctx, CeedMemType f_mem_type, CeedQFunctionContextDataDestroyUser f); 468ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionContextDestroy(CeedQFunctionContext *ctx); 469ec3da8bcSJed Brown 4702b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorCreate(Ceed ceed, CeedQFunction qf, CeedQFunction dqf, CeedQFunction dqfT, CeedOperator *op); 471ec3da8bcSJed Brown CEED_EXTERN int CeedCompositeOperatorCreate(Ceed ceed, CeedOperator *op); 4729560d06aSjeremylt CEED_EXTERN int CeedOperatorReferenceCopy(CeedOperator op, CeedOperator *op_copy); 4732b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorSetField(CeedOperator op, const char *field_name, CeedElemRestriction r, CeedBasis b, CeedVector v); 4742b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorGetFields(CeedOperator op, CeedInt *num_input_fields, CeedOperatorField **input_fields, CeedInt *num_output_fields, 47543bbe138SJeremy L Thompson CeedOperatorField **output_fields); 4762b730f8bSJeremy L Thompson CEED_EXTERN int CeedCompositeOperatorAddSub(CeedOperator composite_op, CeedOperator sub_op); 4774db537f9SJeremy L Thompson CEED_EXTERN int CeedOperatorCheckReady(CeedOperator op); 478c9366a6bSJeremy L Thompson CEED_EXTERN int CeedOperatorGetActiveVectorLengths(CeedOperator op, CeedSize *input_size, CeedSize *output_size); 479beecbf24SJeremy L Thompson CEED_EXTERN int CeedOperatorSetQFunctionAssemblyReuse(CeedOperator op, bool reuse_assembly_data); 480beecbf24SJeremy L Thompson CEED_EXTERN int CeedOperatorSetQFunctionAssemblyDataUpdateNeeded(CeedOperator op, bool needs_data_update); 4812b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorLinearAssembleQFunction(CeedOperator op, CeedVector *assembled, CeedElemRestriction *rstr, CeedRequest *request); 4822b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorLinearAssembleQFunctionBuildOrUpdate(CeedOperator op, CeedVector *assembled, CeedElemRestriction *rstr, 4832b730f8bSJeremy L Thompson CeedRequest *request); 4842b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorLinearAssembleDiagonal(CeedOperator op, CeedVector assembled, CeedRequest *request); 4852b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorLinearAssembleAddDiagonal(CeedOperator op, CeedVector assembled, CeedRequest *request); 4862b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorLinearAssemblePointBlockDiagonal(CeedOperator op, CeedVector assembled, CeedRequest *request); 4872b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorLinearAssembleAddPointBlockDiagonal(CeedOperator op, CeedVector assembled, CeedRequest *request); 4882b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorLinearAssembleSymbolic(CeedOperator op, CeedSize *num_entries, CeedInt **rows, CeedInt **cols); 489ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorLinearAssemble(CeedOperator op, CeedVector values); 4902b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorMultigridLevelCreate(CeedOperator op_fine, CeedVector p_mult_fine, CeedElemRestriction rstr_coarse, 4912b730f8bSJeremy L Thompson CeedBasis basis_coarse, CeedOperator *op_coarse, CeedOperator *op_prolong, 4922b730f8bSJeremy L Thompson CeedOperator *op_restrict); 4932b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorMultigridLevelCreateTensorH1(CeedOperator op_fine, CeedVector p_mult_fine, CeedElemRestriction rstr_coarse, 494d1d35e2fSjeremylt CeedBasis basis_coarse, const CeedScalar *interp_c_to_f, CeedOperator *op_coarse, 495d1d35e2fSjeremylt CeedOperator *op_prolong, CeedOperator *op_restrict); 4962b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorMultigridLevelCreateH1(CeedOperator op_fine, CeedVector p_mult_fine, CeedElemRestriction rstr_coarse, 4972b730f8bSJeremy L Thompson CeedBasis basis_coarse, const CeedScalar *interp_c_to_f, CeedOperator *op_coarse, 498d1d35e2fSjeremylt CeedOperator *op_prolong, CeedOperator *op_restrict); 4992b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorCreateFDMElementInverse(CeedOperator op, CeedOperator *fdm_inv, CeedRequest *request); 500cd4dfc48Sjeremylt CEED_EXTERN int CeedOperatorSetNumQuadraturePoints(CeedOperator op, CeedInt num_qpts); 501ea6b5821SJeremy L Thompson CEED_EXTERN int CeedOperatorSetName(CeedOperator op, const char *name); 502ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorView(CeedOperator op, FILE *stream); 503b7c9bbdaSJeremy L Thompson CEED_EXTERN int CeedOperatorGetCeed(CeedOperator op, Ceed *ceed); 504b7c9bbdaSJeremy L Thompson CEED_EXTERN int CeedOperatorGetNumElements(CeedOperator op, CeedInt *num_elem); 5052b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorGetNumQuadraturePoints(CeedOperator op, CeedInt *num_qpts); 5069d36ca50SJeremy L Thompson CEED_EXTERN int CeedOperatorGetFlopsEstimate(CeedOperator op, CeedSize *flops); 5072b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorContextGetFieldLabel(CeedOperator op, const char *field_name, CeedContextFieldLabel *field_label); 5082b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorContextSetDouble(CeedOperator op, CeedContextFieldLabel field_label, double *values); 5092b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorContextSetInt32(CeedOperator op, CeedContextFieldLabel field_label, int *values); 5102b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorApply(CeedOperator op, CeedVector in, CeedVector out, CeedRequest *request); 5112b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorApplyAdd(CeedOperator op, CeedVector in, CeedVector out, CeedRequest *request); 512ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorDestroy(CeedOperator *op); 513ec3da8bcSJed Brown 5142b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorFieldGetName(CeedOperatorField op_field, char **field_name); 5152b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorFieldGetElemRestriction(CeedOperatorField op_field, CeedElemRestriction *rstr); 5162b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorFieldGetBasis(CeedOperatorField op_field, CeedBasis *basis); 5172b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorFieldGetVector(CeedOperatorField op_field, CeedVector *vec); 51843bbe138SJeremy L Thompson 519ec3da8bcSJed Brown /** 520ec3da8bcSJed Brown @brief Return integer power 521ec3da8bcSJed Brown 522ec3da8bcSJed Brown @param[in] base The base to exponentiate 523ec3da8bcSJed Brown @param[in] power The power to raise the base to 524ec3da8bcSJed Brown 525ec3da8bcSJed Brown @return base^power 526ec3da8bcSJed Brown 527ec3da8bcSJed Brown @ref Utility 528ec3da8bcSJed Brown **/ 529ec3da8bcSJed Brown static inline CeedInt CeedIntPow(CeedInt base, CeedInt power) { 530ec3da8bcSJed Brown CeedInt result = 1; 531ec3da8bcSJed Brown while (power) { 532ec3da8bcSJed Brown if (power & 1) result *= base; 533ec3da8bcSJed Brown power >>= 1; 534ec3da8bcSJed Brown base *= base; 535ec3da8bcSJed Brown } 536ec3da8bcSJed Brown return result; 537ec3da8bcSJed Brown } 538ec3da8bcSJed Brown 539ec3da8bcSJed Brown /** 540ec3da8bcSJed Brown @brief Return minimum of two integers 541ec3da8bcSJed Brown 542ec3da8bcSJed Brown @param[in] a The first integer to compare 543ec3da8bcSJed Brown @param[in] b The second integer to compare 544ec3da8bcSJed Brown 545ec3da8bcSJed Brown @return The minimum of the two integers 546ec3da8bcSJed Brown 547ec3da8bcSJed Brown @ref Utility 548ec3da8bcSJed Brown **/ 549ec3da8bcSJed Brown static inline CeedInt CeedIntMin(CeedInt a, CeedInt b) { return a < b ? a : b; } 550ec3da8bcSJed Brown 551ec3da8bcSJed Brown /** 552ec3da8bcSJed Brown @brief Return maximum of two integers 553ec3da8bcSJed Brown 554ec3da8bcSJed Brown @param[in] a The first integer to compare 555ec3da8bcSJed Brown @param[in] b The second integer to compare 556ec3da8bcSJed Brown 557ec3da8bcSJed Brown @return The maximum of the two integers 558ec3da8bcSJed Brown 559ec3da8bcSJed Brown @ref Utility 560ec3da8bcSJed Brown **/ 561ec3da8bcSJed Brown static inline CeedInt CeedIntMax(CeedInt a, CeedInt b) { return a > b ? a : b; } 562ec3da8bcSJed Brown 563ec3da8bcSJed Brown // Used to ensure initialization before CeedInit() 564ec3da8bcSJed Brown CEED_EXTERN int CeedRegisterAll(void); 565ec3da8bcSJed Brown // Used to ensure initialization before CeedQFunctionCreate*() 566ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionRegisterAll(void); 567ec3da8bcSJed Brown 568ec3da8bcSJed Brown #endif 569