1ea61e9acSJeremy L Thompson /// Copyright (c) 2017-2022, Lawrence Livermore National Security, LLC and other CEED contributors. 2ea61e9acSJeremy L Thompson /// All Rights Reserved. See the top-level LICENSE and NOTICE files for details. 3ec3da8bcSJed Brown /// 4ea61e9acSJeremy L Thompson /// SPDX-License-Identifier: BSD-2-Clause 5ec3da8bcSJed Brown /// 6ea61e9acSJeremy 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 /// 20ea61e9acSJeremy L Thompson /// @page FunctionCategories libCEED: Types of Functions libCEED provides three different header files depending upon the type of functions a user 21ea61e9acSJeremy L Thompson /// requires. 22ec3da8bcSJed Brown /// @section Utility Utility Functions 23ea61e9acSJeremy L Thompson /// These functions are intended general utilities that may be useful to libCEED developers and users. 24ea61e9acSJeremy L Thompson /// These functions can generally be found in "ceed.h". 25ec3da8bcSJed Brown /// @section User User Functions 26ea61e9acSJeremy 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 28ea61e9acSJeremy 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 30ea61e9acSJeremy 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 32ea61e9acSJeremy 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 43ea61e9acSJeremy 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 58*49aac155SJeremy L Thompson #include "types.h" // IWYU pragma: export 59*49aac155SJeremy L Thompson /// This line prevents IWYU from suggesting "ceed.h" 60*49aac155SJeremy L Thompson // IWYU pragma: private, include <ceed.h> 61ec3da8bcSJed Brown 62ec3da8bcSJed Brown /// Library context created by CeedInit() 63ec3da8bcSJed Brown /// @ingroup CeedUser 64ec3da8bcSJed Brown typedef struct Ceed_private *Ceed; 65ec3da8bcSJed Brown /// Non-blocking Ceed interfaces return a CeedRequest. 66ec3da8bcSJed Brown /// To perform an operation immediately, pass \ref CEED_REQUEST_IMMEDIATE instead. 67ec3da8bcSJed Brown /// @ingroup CeedUser 68ec3da8bcSJed Brown typedef struct CeedRequest_private *CeedRequest; 69ec3da8bcSJed Brown /// Handle for vectors over the field \ref CeedScalar 70ec3da8bcSJed Brown /// @ingroup CeedVectorUser 71ec3da8bcSJed Brown typedef struct CeedVector_private *CeedVector; 72ec3da8bcSJed Brown /// Handle for object describing restriction to elements 73ec3da8bcSJed Brown /// @ingroup CeedElemRestrictionUser 74ec3da8bcSJed Brown typedef struct CeedElemRestriction_private *CeedElemRestriction; 75ec3da8bcSJed Brown /// Handle for object describing discrete finite element evaluations 76ec3da8bcSJed Brown /// @ingroup CeedBasisUser 77ec3da8bcSJed Brown typedef struct CeedBasis_private *CeedBasis; 7843bbe138SJeremy L Thompson /// Handle for object describing CeedQFunction fields 7943bbe138SJeremy L Thompson /// @ingroup CeedQFunctionBackend 8043bbe138SJeremy L Thompson typedef struct CeedQFunctionField_private *CeedQFunctionField; 81ec3da8bcSJed Brown /// Handle for object describing functions evaluated independently at quadrature points 82ec3da8bcSJed Brown /// @ingroup CeedQFunctionUser 83ec3da8bcSJed Brown typedef struct CeedQFunction_private *CeedQFunction; 8443bbe138SJeremy L Thompson /// Handle for object describing CeedOperator fields 8543bbe138SJeremy L Thompson /// @ingroup CeedOperatorBackend 8643bbe138SJeremy L Thompson typedef struct CeedOperatorField_private *CeedOperatorField; 87ec3da8bcSJed Brown /// Handle for object describing context data for CeedQFunctions 88ec3da8bcSJed Brown /// @ingroup CeedQFunctionUser 89ec3da8bcSJed Brown typedef struct CeedQFunctionContext_private *CeedQFunctionContext; 903668ca4bSJeremy L Thompson /// Handle for object describing registered fields for CeedQFunctionContext 913668ca4bSJeremy L Thompson /// @ingroup CeedQFunctionUser 923668ca4bSJeremy L Thompson typedef struct CeedContextFieldLabel_private *CeedContextFieldLabel; 93ec3da8bcSJed Brown /// Handle for object describing FE-type operators acting on vectors 94ec3da8bcSJed Brown /// 95859c15bbSJames Wright /// 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 96859c15bbSJames Wright /// \f$E^T B^T f(B E u)\f$ acting on the vector \f$u\f$. 97ec3da8bcSJed Brown /// @ingroup CeedOperatorUser 98ec3da8bcSJed Brown typedef struct CeedOperator_private *CeedOperator; 99ec3da8bcSJed Brown 10022e44211Sjeremylt CEED_EXTERN int CeedRegistryGetList(size_t *n, char ***const resources, CeedInt **array); 101ec3da8bcSJed Brown CEED_EXTERN int CeedInit(const char *resource, Ceed *ceed); 1029560d06aSjeremylt CEED_EXTERN int CeedReferenceCopy(Ceed ceed, Ceed *ceed_copy); 103ec3da8bcSJed Brown CEED_EXTERN int CeedGetResource(Ceed ceed, const char **resource); 104d1d35e2fSjeremylt CEED_EXTERN int CeedIsDeterministic(Ceed ceed, bool *is_deterministic); 105ee5a26f2SJeremy L Thompson CEED_EXTERN int CeedAddJitSourceRoot(Ceed ceed, const char *jit_source_root); 106ec3da8bcSJed Brown CEED_EXTERN int CeedView(Ceed ceed, FILE *stream); 107ec3da8bcSJed Brown CEED_EXTERN int CeedDestroy(Ceed *ceed); 108ec3da8bcSJed Brown 1092b730f8bSJeremy L Thompson CEED_EXTERN int CeedErrorImpl(Ceed, const char *, int, const char *, int, const char *, ...); 110ec3da8bcSJed Brown /// Raise an error on ceed object 111ec3da8bcSJed Brown /// 112ec3da8bcSJed Brown /// @param ceed Ceed library context or NULL 113ec3da8bcSJed Brown /// @param ecode Error code (int) 114ec3da8bcSJed Brown /// @param ... printf-style format string followed by arguments as needed 115ec3da8bcSJed Brown /// 116ec3da8bcSJed Brown /// @ingroup Ceed 117ec3da8bcSJed Brown /// @sa CeedSetErrorHandler() 118ec3da8bcSJed Brown #if defined(__clang__) 119ea61e9acSJeremy L Thompson /// Use nonstandard ternary to convince the compiler/clang-tidy that this function never returns zero. 1202b730f8bSJeremy L Thompson #define CeedError(ceed, ecode, ...) (CeedErrorImpl((ceed), __FILE__, __LINE__, __func__, (ecode), __VA_ARGS__), (ecode)) 121ec3da8bcSJed Brown #else 1222b730f8bSJeremy L Thompson #define CeedError(ceed, ecode, ...) CeedErrorImpl((ceed), __FILE__, __LINE__, __func__, (ecode), __VA_ARGS__) ?: (ecode) 123ec3da8bcSJed Brown #endif 124ec3da8bcSJed Brown 125ec3da8bcSJed Brown /// Ceed error handlers 1262b730f8bSJeremy L Thompson CEED_EXTERN int CeedErrorReturn(Ceed, const char *, int, const char *, int, const char *, va_list *); 1272b730f8bSJeremy L Thompson CEED_EXTERN int CeedErrorStore(Ceed, const char *, int, const char *, int, const char *, va_list *); 1282b730f8bSJeremy L Thompson CEED_EXTERN int CeedErrorAbort(Ceed, const char *, int, const char *, int, const char *, va_list *); 1292b730f8bSJeremy L Thompson CEED_EXTERN int CeedErrorExit(Ceed, const char *, int, const char *, int, const char *, va_list *); 1302b730f8bSJeremy L Thompson typedef int (*CeedErrorHandler)(Ceed, const char *, int, const char *, int, const char *, va_list *); 131ec3da8bcSJed Brown CEED_EXTERN int CeedSetErrorHandler(Ceed ceed, CeedErrorHandler eh); 132d1d35e2fSjeremylt CEED_EXTERN int CeedGetErrorMessage(Ceed, const char **err_msg); 133d1d35e2fSjeremylt CEED_EXTERN int CeedResetErrorMessage(Ceed, const char **err_msg); 134ec3da8bcSJed Brown 135ec3da8bcSJed Brown /// libCEED library version numbering 136ec3da8bcSJed Brown /// @ingroup Ceed 137ec3da8bcSJed Brown #define CEED_VERSION_MAJOR 0 1388ec64e9aSJed Brown #define CEED_VERSION_MINOR 11 1398ec64e9aSJed Brown #define CEED_VERSION_PATCH 0 1408ec64e9aSJed Brown #define CEED_VERSION_RELEASE true 141ec3da8bcSJed Brown 142ea61e9acSJeremy L Thompson /// Compile-time check that the the current library version is at least as recent as the specified version. 143ea61e9acSJeremy L Thompson /// This macro is typically used in 144ec3da8bcSJed Brown /// @code 145ec3da8bcSJed Brown /// #if CEED_VERSION_GE(0, 8, 0) 146ec3da8bcSJed Brown /// code path that needs at least 0.8.0 147ec3da8bcSJed Brown /// #else 148ec3da8bcSJed Brown /// fallback code for older versions 149ec3da8bcSJed Brown /// #endif 150ec3da8bcSJed Brown /// @endcode 151ec3da8bcSJed Brown /// 152ec3da8bcSJed Brown /// A non-release version always compares as positive infinity. 153ec3da8bcSJed Brown /// 154ec3da8bcSJed Brown /// @param major Major version 155ec3da8bcSJed Brown /// @param minor Minor version 156ec3da8bcSJed Brown /// @param patch Patch (subminor) version 157ec3da8bcSJed Brown /// 158ec3da8bcSJed Brown /// @ingroup Ceed 159ec3da8bcSJed Brown /// @sa CeedGetVersion() 160ec3da8bcSJed Brown #define CEED_VERSION_GE(major, minor, patch) \ 161ec3da8bcSJed Brown (!CEED_VERSION_RELEASE || \ 162ec3da8bcSJed Brown (CEED_VERSION_MAJOR > major || \ 1632b730f8bSJeremy L Thompson (CEED_VERSION_MAJOR == major && (CEED_VERSION_MINOR > minor || (CEED_VERSION_MINOR == minor && CEED_VERSION_PATCH >= patch))))) 164ec3da8bcSJed Brown 1652b730f8bSJeremy L Thompson CEED_EXTERN int CeedGetVersion(int *major, int *minor, int *patch, bool *release); 166ec3da8bcSJed Brown 16780a9ef05SNatalie Beams CEED_EXTERN int CeedGetScalarType(CeedScalarType *scalar_type); 16880a9ef05SNatalie Beams 169ec3da8bcSJed Brown CEED_EXTERN const char *const *CeedErrorTypes; 170ec3da8bcSJed Brown 171ec3da8bcSJed Brown /// Specify memory type 172ec3da8bcSJed Brown /// 173ea61e9acSJeremy L Thompson /// Many Ceed interfaces take or return pointers to memory. 174ea61e9acSJeremy L Thompson /// This enum is used to specify where the memory being provided or requested must reside. 175ec3da8bcSJed Brown /// @ingroup Ceed 176ec3da8bcSJed Brown typedef enum { 177ec3da8bcSJed Brown /// Memory resides on the host 178ec3da8bcSJed Brown CEED_MEM_HOST, 179ec3da8bcSJed Brown /// Memory resides on a device (corresponding to \ref Ceed resource) 180ec3da8bcSJed Brown CEED_MEM_DEVICE, 181ec3da8bcSJed Brown } CeedMemType; 182ec3da8bcSJed Brown CEED_EXTERN const char *const CeedMemTypes[]; 183ec3da8bcSJed Brown 184ec3da8bcSJed Brown CEED_EXTERN int CeedGetPreferredMemType(Ceed ceed, CeedMemType *type); 185ec3da8bcSJed Brown 186ec3da8bcSJed Brown /// Conveys ownership status of arrays passed to Ceed interfaces. 187ec3da8bcSJed Brown /// @ingroup Ceed 188ec3da8bcSJed Brown typedef enum { 189ec3da8bcSJed Brown /// Implementation will copy the values and not store the passed pointer. 190ec3da8bcSJed Brown CEED_COPY_VALUES, 191ea61e9acSJeremy L Thompson /// Implementation can use and modify the data provided by the user, but does not take ownership. 192ec3da8bcSJed Brown CEED_USE_POINTER, 193ea61e9acSJeremy L Thompson /// Implementation takes ownership of the pointer and will free using CeedFree() when done using it. 194ea61e9acSJeremy L Thompson /// The user should not assume that the pointer remains valid after ownership has been transferred. 195ea61e9acSJeremy L Thompson /// Note that arrays allocated using C++ operator new or other allocators cannot generally be freed using CeedFree(). 196ea61e9acSJeremy L Thompson /// CeedFree() is capable of freeing any memory that can be freed using free(). 197ec3da8bcSJed Brown CEED_OWN_POINTER, 198ec3da8bcSJed Brown } CeedCopyMode; 199cdf32b93SJeremy L Thompson CEED_EXTERN const char *const CeedCopyModes[]; 200ec3da8bcSJed Brown 201ec3da8bcSJed Brown /// Denotes type of vector norm to be computed 202ec3da8bcSJed Brown /// @ingroup CeedVector 203ec3da8bcSJed Brown typedef enum { 204859c15bbSJames Wright /// \f$\Vert \bm{x}\Vert_1 = \sum_i \vert x_i\vert\f$ 205ec3da8bcSJed Brown CEED_NORM_1, 206859c15bbSJames Wright /// \f$\Vert \bm{x} \Vert_2 = \sqrt{\sum_i x_i^2}\f$ 207ec3da8bcSJed Brown CEED_NORM_2, 208859c15bbSJames Wright /// \f$\Vert \bm{x} \Vert_\infty = \max_i \vert x_i \vert\f$ 209ec3da8bcSJed Brown CEED_NORM_MAX, 210ec3da8bcSJed Brown } CeedNormType; 211ec3da8bcSJed Brown 2121f9221feSJeremy L Thompson CEED_EXTERN int CeedVectorCreate(Ceed ceed, CeedSize len, CeedVector *vec); 2139560d06aSjeremylt CEED_EXTERN int CeedVectorReferenceCopy(CeedVector vec, CeedVector *vec_copy); 2145fb68f37SKaren (Ren) Stengel CEED_EXTERN int CeedVectorCopy(CeedVector vec, CeedVector vec_copy); 2152b730f8bSJeremy L Thompson CEED_EXTERN int CeedVectorSetArray(CeedVector vec, CeedMemType mem_type, CeedCopyMode copy_mode, CeedScalar *array); 216ec3da8bcSJed Brown CEED_EXTERN int CeedVectorSetValue(CeedVector vec, CeedScalar value); 217d1d35e2fSjeremylt CEED_EXTERN int CeedVectorSyncArray(CeedVector vec, CeedMemType mem_type); 2182b730f8bSJeremy L Thompson CEED_EXTERN int CeedVectorTakeArray(CeedVector vec, CeedMemType mem_type, CeedScalar **array); 2192b730f8bSJeremy L Thompson CEED_EXTERN int CeedVectorGetArray(CeedVector vec, CeedMemType mem_type, CeedScalar **array); 2202b730f8bSJeremy L Thompson CEED_EXTERN int CeedVectorGetArrayRead(CeedVector vec, CeedMemType mem_type, const CeedScalar **array); 2212b730f8bSJeremy L Thompson CEED_EXTERN int CeedVectorGetArrayWrite(CeedVector vec, CeedMemType mem_type, CeedScalar **array); 222ec3da8bcSJed Brown CEED_EXTERN int CeedVectorRestoreArray(CeedVector vec, CeedScalar **array); 2232b730f8bSJeremy L Thompson CEED_EXTERN int CeedVectorRestoreArrayRead(CeedVector vec, const CeedScalar **array); 2242b730f8bSJeremy L Thompson CEED_EXTERN int CeedVectorNorm(CeedVector vec, CeedNormType type, CeedScalar *norm); 225e0dd3b27Sjeremylt CEED_EXTERN int CeedVectorScale(CeedVector x, CeedScalar alpha); 2260f7fd0f8Sjeremylt CEED_EXTERN int CeedVectorAXPY(CeedVector y, CeedScalar alpha, CeedVector x); 2275fb68f37SKaren (Ren) Stengel CEED_EXTERN int CeedVectorAXPBY(CeedVector y, CeedScalar alpha, CeedScalar beta, CeedVector x); 2280f7fd0f8Sjeremylt CEED_EXTERN int CeedVectorPointwiseMult(CeedVector w, CeedVector x, CeedVector y); 229ec3da8bcSJed Brown CEED_EXTERN int CeedVectorReciprocal(CeedVector vec); 230d1d35e2fSjeremylt CEED_EXTERN int CeedVectorView(CeedVector vec, const char *fp_fmt, FILE *stream); 231b7c9bbdaSJeremy L Thompson CEED_EXTERN int CeedVectorGetCeed(CeedVector vec, Ceed *ceed); 2321f9221feSJeremy L Thompson CEED_EXTERN int CeedVectorGetLength(CeedVector vec, CeedSize *length); 233ec3da8bcSJed Brown CEED_EXTERN int CeedVectorDestroy(CeedVector *vec); 234ec3da8bcSJed Brown 235ec3da8bcSJed Brown CEED_EXTERN CeedRequest *const CEED_REQUEST_IMMEDIATE; 236ec3da8bcSJed Brown CEED_EXTERN CeedRequest *const CEED_REQUEST_ORDERED; 237ec3da8bcSJed Brown CEED_EXTERN int CeedRequestWait(CeedRequest *req); 238ec3da8bcSJed Brown 239ea61e9acSJeremy L Thompson /// Argument for CeedOperatorSetField that vector is collocated with quadrature points, only used with CeedEvalMode CEED_EVAL_NONE 240ec3da8bcSJed Brown /// @ingroup CeedBasis 241ec3da8bcSJed Brown CEED_EXTERN const CeedBasis CEED_BASIS_COLLOCATED; 242ec3da8bcSJed Brown 243ec3da8bcSJed Brown /// Argument for CeedOperatorSetField to use active input or output 244ec3da8bcSJed Brown /// @ingroup CeedVector 245ec3da8bcSJed Brown CEED_EXTERN const CeedVector CEED_VECTOR_ACTIVE; 246ec3da8bcSJed Brown 247ea61e9acSJeremy L Thompson /// Argument for CeedOperatorSetField to use no vector, used with QFunction input with eval mode CEED_EVAL_WEIGHT 248ec3da8bcSJed Brown /// @ingroup CeedVector 249ec3da8bcSJed Brown CEED_EXTERN const CeedVector CEED_VECTOR_NONE; 250ec3da8bcSJed Brown 251ea61e9acSJeremy L Thompson /// Argument for CeedOperatorSetField to use no ElemRestriction, only used with eval mode CEED_EVAL_WEIGHT. 252ec3da8bcSJed Brown /// @ingroup CeedElemRestriction 253ec3da8bcSJed Brown CEED_EXTERN const CeedElemRestriction CEED_ELEMRESTRICTION_NONE; 254ec3da8bcSJed Brown 255ec3da8bcSJed Brown /// Argument for CeedOperatorCreate that QFunction is not created by user. 256ea61e9acSJeremy L Thompson /// Only used for QFunctions dqf and dqfT. 257ea61e9acSJeremy L Thompson /// If implemented, a backend may attempt to provide the action of these QFunctions. 258ec3da8bcSJed Brown /// @ingroup CeedQFunction 259ec3da8bcSJed Brown CEED_EXTERN const CeedQFunction CEED_QFUNCTION_NONE; 260ec3da8bcSJed Brown 261ec3da8bcSJed Brown /// Denotes whether a linear transformation or its transpose should be applied 262ec3da8bcSJed Brown /// @ingroup CeedBasis 263ec3da8bcSJed Brown typedef enum { 264ec3da8bcSJed Brown /// Apply the linear transformation 265ec3da8bcSJed Brown CEED_NOTRANSPOSE, 266ec3da8bcSJed Brown /// Apply the transpose 267ec3da8bcSJed Brown CEED_TRANSPOSE 268ec3da8bcSJed Brown } CeedTransposeMode; 269ec3da8bcSJed Brown CEED_EXTERN const char *const CeedTransposeModes[]; 270ec3da8bcSJed Brown 271ea61e9acSJeremy L Thompson /// Argument for CeedElemRestrictionCreateStrided that L-vector is in the Ceed backend's preferred layout. 272ea61e9acSJeremy L Thompson /// This argument should only be used with vectors created by a Ceed backend. 273ec3da8bcSJed Brown /// @ingroup CeedElemRestriction 274ec3da8bcSJed Brown CEED_EXTERN const CeedInt CEED_STRIDES_BACKEND[3]; 275ec3da8bcSJed Brown 2762b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionCreate(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt num_comp, CeedInt comp_stride, CeedSize l_size, 2772b730f8bSJeremy L Thompson CeedMemType mem_type, CeedCopyMode copy_mode, const CeedInt *offsets, CeedElemRestriction *rstr); 2782b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionCreateOriented(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt num_comp, CeedInt comp_stride, 2792b730f8bSJeremy L Thompson CeedSize l_size, CeedMemType mem_type, CeedCopyMode copy_mode, const CeedInt *offsets, 280fc0567d9Srezgarshakeri const bool *orient, CeedElemRestriction *rstr); 2812b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionCreateStrided(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt num_comp, CeedSize l_size, 282ec3da8bcSJed Brown const CeedInt strides[3], CeedElemRestriction *rstr); 2832b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionCreateBlocked(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt blk_size, CeedInt num_comp, 2842b730f8bSJeremy L Thompson CeedInt comp_stride, CeedSize l_size, CeedMemType mem_type, CeedCopyMode copy_mode, 285ec3da8bcSJed Brown const CeedInt *offsets, CeedElemRestriction *rstr); 2862b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionCreateBlockedStrided(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt blk_size, CeedInt num_comp, 287e79b91d9SJeremy L Thompson CeedSize l_size, const CeedInt strides[3], CeedElemRestriction *rstr); 2882b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionReferenceCopy(CeedElemRestriction rstr, CeedElemRestriction *rstr_copy); 2892b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionCreateVector(CeedElemRestriction rstr, CeedVector *lvec, CeedVector *evec); 2902b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionApply(CeedElemRestriction rstr, CeedTransposeMode t_mode, CeedVector u, CeedVector ru, CeedRequest *request); 2912b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionApplyBlock(CeedElemRestriction rstr, CeedInt block, CeedTransposeMode t_mode, CeedVector u, CeedVector ru, 292ec3da8bcSJed Brown CeedRequest *request); 2932b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionGetCeed(CeedElemRestriction rstr, Ceed *ceed); 2942b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionGetCompStride(CeedElemRestriction rstr, CeedInt *comp_stride); 2952b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionGetNumElements(CeedElemRestriction rstr, CeedInt *num_elem); 2962b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionGetElementSize(CeedElemRestriction rstr, CeedInt *elem_size); 2972b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionGetLVectorSize(CeedElemRestriction rstr, CeedSize *l_size); 2982b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionGetNumComponents(CeedElemRestriction rstr, CeedInt *num_comp); 2992b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionGetNumBlocks(CeedElemRestriction rstr, CeedInt *num_blk); 3002b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionGetBlockSize(CeedElemRestriction rstr, CeedInt *blk_size); 3012b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionGetMultiplicity(CeedElemRestriction rstr, CeedVector mult); 302ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionView(CeedElemRestriction rstr, FILE *stream); 303ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionDestroy(CeedElemRestriction *rstr); 304ec3da8bcSJed Brown 305ec3da8bcSJed Brown // The formalism here is that we have the structure 306ec3da8bcSJed Brown // \int_\Omega v^T f_0(u, \nabla u, qdata) + (\nabla v)^T f_1(u, \nabla u, qdata) 307ec3da8bcSJed Brown // where gradients are with respect to the reference element. 308ec3da8bcSJed Brown 309ec3da8bcSJed Brown /// Basis evaluation mode 310ec3da8bcSJed Brown /// 311ec3da8bcSJed Brown /// Modes can be bitwise ORed when passing to most functions. 312ec3da8bcSJed Brown /// @ingroup CeedBasis 313ec3da8bcSJed Brown typedef enum { 314ea61e9acSJeremy L Thompson /// Perform no evaluation (either because there is no data or it is already at quadrature points) 315ec3da8bcSJed Brown CEED_EVAL_NONE = 0, 316ec3da8bcSJed Brown /// Interpolate from nodes to quadrature points 317ec3da8bcSJed Brown CEED_EVAL_INTERP = 1, 318ec3da8bcSJed Brown /// Evaluate gradients at quadrature points from input in a nodal basis 319ec3da8bcSJed Brown CEED_EVAL_GRAD = 2, 320ec3da8bcSJed Brown /// Evaluate divergence at quadrature points from input in a nodal basis 321ec3da8bcSJed Brown CEED_EVAL_DIV = 4, 322ec3da8bcSJed Brown /// Evaluate curl at quadrature points from input in a nodal basis 323ec3da8bcSJed Brown CEED_EVAL_CURL = 8, 324ec3da8bcSJed Brown /// Using no input, evaluate quadrature weights on the reference element 325ec3da8bcSJed Brown CEED_EVAL_WEIGHT = 16, 326ec3da8bcSJed Brown } CeedEvalMode; 327ec3da8bcSJed Brown CEED_EXTERN const char *const CeedEvalModes[]; 328ec3da8bcSJed Brown 329ec3da8bcSJed Brown /// Type of quadrature; also used for location of nodes 330ec3da8bcSJed Brown /// @ingroup CeedBasis 331ec3da8bcSJed Brown typedef enum { 332ec3da8bcSJed Brown /// Gauss-Legendre quadrature 333ec3da8bcSJed Brown CEED_GAUSS = 0, 334ec3da8bcSJed Brown /// Gauss-Legendre-Lobatto quadrature 335ec3da8bcSJed Brown CEED_GAUSS_LOBATTO = 1, 336ec3da8bcSJed Brown } CeedQuadMode; 337ec3da8bcSJed Brown CEED_EXTERN const char *const CeedQuadModes[]; 338ec3da8bcSJed Brown 339ec3da8bcSJed Brown /// Type of basis shape to create non-tensor H1 element basis 340ec3da8bcSJed Brown /// 341ea61e9acSJeremy L Thompson /// Dimension can be extracted with bitwise AND (CeedElemTopology & 2**(dim + 2)) == TRUE 342ec3da8bcSJed Brown /// @ingroup CeedBasis 343ec3da8bcSJed Brown typedef enum { 344ec3da8bcSJed Brown /// Line 34550c301a5SRezgar Shakeri CEED_TOPOLOGY_LINE = 1 << 16 | 0, 346ec3da8bcSJed Brown /// Triangle - 2D shape 34750c301a5SRezgar Shakeri CEED_TOPOLOGY_TRIANGLE = 2 << 16 | 1, 348ec3da8bcSJed Brown /// Quadralateral - 2D shape 34950c301a5SRezgar Shakeri CEED_TOPOLOGY_QUAD = 2 << 16 | 2, 350ec3da8bcSJed Brown /// Tetrahedron - 3D shape 35150c301a5SRezgar Shakeri CEED_TOPOLOGY_TET = 3 << 16 | 3, 352ec3da8bcSJed Brown /// Pyramid - 3D shape 35350c301a5SRezgar Shakeri CEED_TOPOLOGY_PYRAMID = 3 << 16 | 4, 354ec3da8bcSJed Brown /// Prism - 3D shape 35550c301a5SRezgar Shakeri CEED_TOPOLOGY_PRISM = 3 << 16 | 5, 356ec3da8bcSJed Brown /// Hexehedron - 3D shape 35750c301a5SRezgar Shakeri CEED_TOPOLOGY_HEX = 3 << 16 | 6, 358ec3da8bcSJed Brown } CeedElemTopology; 359ec3da8bcSJed Brown CEED_EXTERN const char *const CeedElemTopologies[]; 360ec3da8bcSJed Brown 3612b730f8bSJeremy L Thompson CEED_EXTERN int CeedBasisCreateTensorH1Lagrange(Ceed ceed, CeedInt dim, CeedInt num_comp, CeedInt P, CeedInt Q, CeedQuadMode quad_mode, 362ec3da8bcSJed Brown CeedBasis *basis); 3632b730f8bSJeremy L Thompson CEED_EXTERN int CeedBasisCreateTensorH1(Ceed ceed, CeedInt dim, CeedInt num_comp, CeedInt P_1d, CeedInt Q_1d, const CeedScalar *interp_1d, 3642b730f8bSJeremy L Thompson const CeedScalar *grad_1d, const CeedScalar *q_ref_1d, const CeedScalar *q_weight_1d, CeedBasis *basis); 3652b730f8bSJeremy L Thompson CEED_EXTERN int CeedBasisCreateH1(Ceed ceed, CeedElemTopology topo, CeedInt num_comp, CeedInt num_nodes, CeedInt nqpts, const CeedScalar *interp, 3662b730f8bSJeremy L Thompson const CeedScalar *grad, const CeedScalar *q_ref, const CeedScalar *q_weights, CeedBasis *basis); 3672b730f8bSJeremy L Thompson CEED_EXTERN int CeedBasisCreateHdiv(Ceed ceed, CeedElemTopology topo, CeedInt num_comp, CeedInt num_nodes, CeedInt nqpts, const CeedScalar *interp, 3682b730f8bSJeremy L Thompson const CeedScalar *div, const CeedScalar *q_ref, const CeedScalar *q_weights, CeedBasis *basis); 369446e7af4SJeremy L Thompson CEED_EXTERN int CeedBasisCreateProjection(CeedBasis basis_from, CeedBasis basis_to, CeedBasis *basis_project); 3709560d06aSjeremylt CEED_EXTERN int CeedBasisReferenceCopy(CeedBasis basis, CeedBasis *basis_copy); 371ec3da8bcSJed Brown CEED_EXTERN int CeedBasisView(CeedBasis basis, FILE *stream); 3722b730f8bSJeremy L Thompson CEED_EXTERN int CeedBasisApply(CeedBasis basis, CeedInt num_elem, CeedTransposeMode t_mode, CeedEvalMode eval_mode, CeedVector u, CeedVector v); 373b7c9bbdaSJeremy L Thompson CEED_EXTERN int CeedBasisGetCeed(CeedBasis basis, Ceed *ceed); 374ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetDimension(CeedBasis basis, CeedInt *dim); 375ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetTopology(CeedBasis basis, CeedElemTopology *topo); 37650c301a5SRezgar Shakeri CEED_EXTERN int CeedBasisGetNumQuadratureComponents(CeedBasis basis, CeedInt *Q_comp); 377d1d35e2fSjeremylt CEED_EXTERN int CeedBasisGetNumComponents(CeedBasis basis, CeedInt *num_comp); 378ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetNumNodes(CeedBasis basis, CeedInt *P); 379d1d35e2fSjeremylt CEED_EXTERN int CeedBasisGetNumNodes1D(CeedBasis basis, CeedInt *P_1d); 380ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetNumQuadraturePoints(CeedBasis basis, CeedInt *Q); 3812b730f8bSJeremy L Thompson CEED_EXTERN int CeedBasisGetNumQuadraturePoints1D(CeedBasis basis, CeedInt *Q_1d); 382d1d35e2fSjeremylt CEED_EXTERN int CeedBasisGetQRef(CeedBasis basis, const CeedScalar **q_ref); 3832b730f8bSJeremy L Thompson CEED_EXTERN int CeedBasisGetQWeights(CeedBasis basis, const CeedScalar **q_weights); 384ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetInterp(CeedBasis basis, const CeedScalar **interp); 3852b730f8bSJeremy L Thompson CEED_EXTERN int CeedBasisGetInterp1D(CeedBasis basis, const CeedScalar **interp_1d); 386ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetGrad(CeedBasis basis, const CeedScalar **grad); 387d1d35e2fSjeremylt CEED_EXTERN int CeedBasisGetGrad1D(CeedBasis basis, const CeedScalar **grad_1d); 38850c301a5SRezgar Shakeri CEED_EXTERN int CeedBasisGetDiv(CeedBasis basis, const CeedScalar **div); 389ec3da8bcSJed Brown CEED_EXTERN int CeedBasisDestroy(CeedBasis *basis); 390ec3da8bcSJed Brown 3912b730f8bSJeremy L Thompson CEED_EXTERN int CeedGaussQuadrature(CeedInt Q, CeedScalar *q_ref_1d, CeedScalar *q_weight_1d); 3922b730f8bSJeremy L Thompson CEED_EXTERN int CeedLobattoQuadrature(CeedInt Q, CeedScalar *q_ref_1d, CeedScalar *q_weight_1d); 393ec3da8bcSJed Brown 394cdf32b93SJeremy L Thompson /** Handle for the user provided CeedQFunction callback function 395ec3da8bcSJed Brown 396cdf32b93SJeremy L Thompson @param[in,out] ctx User-defined context set using CeedQFunctionSetContext() or NULL 397cdf32b93SJeremy L Thompson @param[in] Q Number of quadrature points at which to evaluate 398ea61e9acSJeremy L Thompson @param[in] in Array of pointers to each input argument in the order provided by the user in CeedQFunctionAddInput(). 399ea61e9acSJeremy 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 400ea61e9acSJeremy 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 401d1d35e2fSjeremylt quadrature point `j` as `in[i][(d*num_comp + c)*Q + j]`. 402ea61e9acSJeremy L Thompson @param[out] out Array of pointers to each output array in the order provided using CeedQFunctionAddOutput(). 403ea61e9acSJeremy L Thompson The shapes are as above for \a in. 404ec3da8bcSJed Brown 405ec3da8bcSJed Brown @return An error code: 0 - success, otherwise - failure 406ec3da8bcSJed Brown 407ec3da8bcSJed Brown @ingroup CeedQFunction 408ec3da8bcSJed Brown **/ 4092b730f8bSJeremy L Thompson typedef int (*CeedQFunctionUser)(void *ctx, const CeedInt Q, const CeedScalar *const *in, CeedScalar *const *out); 410ec3da8bcSJed Brown 4112b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionCreateInterior(Ceed ceed, CeedInt vec_length, CeedQFunctionUser f, const char *source, CeedQFunction *qf); 4122b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionCreateInteriorByName(Ceed ceed, const char *name, CeedQFunction *qf); 4132b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionCreateIdentity(Ceed ceed, CeedInt size, CeedEvalMode in_mode, CeedEvalMode out_mode, CeedQFunction *qf); 4149560d06aSjeremylt CEED_EXTERN int CeedQFunctionReferenceCopy(CeedQFunction qf, CeedQFunction *qf_copy); 4152b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionAddInput(CeedQFunction qf, const char *field_name, CeedInt size, CeedEvalMode eval_mode); 4162b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionAddOutput(CeedQFunction qf, const char *field_name, CeedInt size, CeedEvalMode eval_mode); 4172b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionGetFields(CeedQFunction qf, CeedInt *num_input_fields, CeedQFunctionField **input_fields, CeedInt *num_output_fields, 41843bbe138SJeremy L Thompson CeedQFunctionField **output_fields); 4192b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionSetContext(CeedQFunction qf, CeedQFunctionContext ctx); 420441428dfSJeremy L Thompson CEED_EXTERN int CeedQFunctionSetContextWritable(CeedQFunction qf, bool is_writable); 4219d36ca50SJeremy L Thompson CEED_EXTERN int CeedQFunctionSetUserFlopsEstimate(CeedQFunction qf, CeedSize flops); 422ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionView(CeedQFunction qf, FILE *stream); 423b7c9bbdaSJeremy L Thompson CEED_EXTERN int CeedQFunctionGetCeed(CeedQFunction qf, Ceed *ceed); 4242b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionApply(CeedQFunction qf, CeedInt Q, CeedVector *u, CeedVector *v); 425ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionDestroy(CeedQFunction *qf); 426ec3da8bcSJed Brown 4272b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionFieldGetName(CeedQFunctionField qf_field, char **field_name); 4282b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionFieldGetSize(CeedQFunctionField qf_field, CeedInt *size); 4292b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionFieldGetEvalMode(CeedQFunctionField qf_field, CeedEvalMode *eval_mode); 43043bbe138SJeremy L Thompson 431cdf32b93SJeremy L Thompson /// Denotes type of data stored in a CeedQFunctionContext field 432cdf32b93SJeremy L Thompson /// @ingroup CeedQFunction 433cdf32b93SJeremy L Thompson typedef enum { 434cdf32b93SJeremy L Thompson /// Double precision value 4357bfe0f0eSJeremy L Thompson CEED_CONTEXT_FIELD_DOUBLE = 1, 436cdf32b93SJeremy L Thompson /// 32 bit integer value 4377bfe0f0eSJeremy L Thompson CEED_CONTEXT_FIELD_INT32 = 2, 438cdf32b93SJeremy L Thompson } CeedContextFieldType; 439cdf32b93SJeremy L Thompson CEED_EXTERN const char *const CeedContextFieldTypes[]; 440cdf32b93SJeremy L Thompson 4412790b72bSJeremy L Thompson /** Handle for the user provided CeedQFunctionContextDataDestroy callback function 4422790b72bSJeremy L Thompson 4432790b72bSJeremy L Thompson @param[in,out] data User-CeedQFunctionContext data 4442790b72bSJeremy L Thompson 4452790b72bSJeremy L Thompson @return An error code: 0 - success, otherwise - failure 4462790b72bSJeremy L Thompson 4472790b72bSJeremy L Thompson @ingroup CeedQFunction 4482790b72bSJeremy L Thompson **/ 4492790b72bSJeremy L Thompson typedef int (*CeedQFunctionContextDataDestroyUser)(void *data); 4502790b72bSJeremy L Thompson 4512b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextCreate(Ceed ceed, CeedQFunctionContext *ctx); 4522b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextReferenceCopy(CeedQFunctionContext ctx, CeedQFunctionContext *ctx_copy); 4532b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextSetData(CeedQFunctionContext ctx, CeedMemType mem_type, CeedCopyMode copy_mode, size_t size, void *data); 4542b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextTakeData(CeedQFunctionContext ctx, CeedMemType mem_type, void *data); 4552b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextGetData(CeedQFunctionContext ctx, CeedMemType mem_type, void *data); 4562b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextGetDataRead(CeedQFunctionContext ctx, CeedMemType mem_type, void *data); 4572b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextRestoreData(CeedQFunctionContext ctx, void *data); 4582b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextRestoreDataRead(CeedQFunctionContext ctx, void *data); 4592b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextRegisterDouble(CeedQFunctionContext ctx, const char *field_name, size_t field_offset, size_t num_values, 4607bfe0f0eSJeremy L Thompson const char *field_description); 4612b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextRegisterInt32(CeedQFunctionContext ctx, const char *field_name, size_t field_offset, size_t num_values, 4627bfe0f0eSJeremy L Thompson const char *field_description); 4632b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextGetAllFieldLabels(CeedQFunctionContext ctx, const CeedContextFieldLabel **field_labels, CeedInt *num_fields); 4642b730f8bSJeremy L Thompson CEED_EXTERN int CeedContextFieldLabelGetDescription(CeedContextFieldLabel label, const char **field_name, const char **field_description, 4652b730f8bSJeremy L Thompson size_t *num_values, CeedContextFieldType *field_type); 4662b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextGetContextSize(CeedQFunctionContext ctx, size_t *ctx_size); 4672b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextView(CeedQFunctionContext ctx, FILE *stream); 4682b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextSetDataDestroy(CeedQFunctionContext ctx, CeedMemType f_mem_type, CeedQFunctionContextDataDestroyUser f); 469ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionContextDestroy(CeedQFunctionContext *ctx); 470ec3da8bcSJed Brown 4712b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorCreate(Ceed ceed, CeedQFunction qf, CeedQFunction dqf, CeedQFunction dqfT, CeedOperator *op); 472ec3da8bcSJed Brown CEED_EXTERN int CeedCompositeOperatorCreate(Ceed ceed, CeedOperator *op); 4739560d06aSjeremylt CEED_EXTERN int CeedOperatorReferenceCopy(CeedOperator op, CeedOperator *op_copy); 4742b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorSetField(CeedOperator op, const char *field_name, CeedElemRestriction r, CeedBasis b, CeedVector v); 4752b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorGetFields(CeedOperator op, CeedInt *num_input_fields, CeedOperatorField **input_fields, CeedInt *num_output_fields, 47643bbe138SJeremy L Thompson CeedOperatorField **output_fields); 4772b730f8bSJeremy L Thompson CEED_EXTERN int CeedCompositeOperatorAddSub(CeedOperator composite_op, CeedOperator sub_op); 478c6ebc35dSJeremy L Thompson CEED_EXTERN int CeedCompositeOperatorGetNumSub(CeedOperator op, CeedInt *num_suboperators); 479c6ebc35dSJeremy L Thompson CEED_EXTERN int CeedCompositeOperatorGetSubList(CeedOperator op, CeedOperator **sub_operators); 4804db537f9SJeremy L Thompson CEED_EXTERN int CeedOperatorCheckReady(CeedOperator op); 481c9366a6bSJeremy L Thompson CEED_EXTERN int CeedOperatorGetActiveVectorLengths(CeedOperator op, CeedSize *input_size, CeedSize *output_size); 482beecbf24SJeremy L Thompson CEED_EXTERN int CeedOperatorSetQFunctionAssemblyReuse(CeedOperator op, bool reuse_assembly_data); 483beecbf24SJeremy L Thompson CEED_EXTERN int CeedOperatorSetQFunctionAssemblyDataUpdateNeeded(CeedOperator op, bool needs_data_update); 4842b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorLinearAssembleQFunction(CeedOperator op, CeedVector *assembled, CeedElemRestriction *rstr, CeedRequest *request); 4852b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorLinearAssembleQFunctionBuildOrUpdate(CeedOperator op, CeedVector *assembled, CeedElemRestriction *rstr, 4862b730f8bSJeremy L Thompson CeedRequest *request); 4872b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorLinearAssembleDiagonal(CeedOperator op, CeedVector assembled, CeedRequest *request); 4882b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorLinearAssembleAddDiagonal(CeedOperator op, CeedVector assembled, CeedRequest *request); 4892b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorLinearAssemblePointBlockDiagonal(CeedOperator op, CeedVector assembled, CeedRequest *request); 4902b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorLinearAssembleAddPointBlockDiagonal(CeedOperator op, CeedVector assembled, CeedRequest *request); 4912b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorLinearAssembleSymbolic(CeedOperator op, CeedSize *num_entries, CeedInt **rows, CeedInt **cols); 492ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorLinearAssemble(CeedOperator op, CeedVector values); 49375f0d5a4SJeremy L Thompson CEED_EXTERN int CeedCompositeOperatorGetMultiplicity(CeedOperator op, CeedInt num_skip_indices, CeedInt *skip_indices, CeedVector mult); 4942b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorMultigridLevelCreate(CeedOperator op_fine, CeedVector p_mult_fine, CeedElemRestriction rstr_coarse, 4952b730f8bSJeremy L Thompson CeedBasis basis_coarse, CeedOperator *op_coarse, CeedOperator *op_prolong, 4962b730f8bSJeremy L Thompson CeedOperator *op_restrict); 4972b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorMultigridLevelCreateTensorH1(CeedOperator op_fine, CeedVector p_mult_fine, CeedElemRestriction rstr_coarse, 498d1d35e2fSjeremylt CeedBasis basis_coarse, const CeedScalar *interp_c_to_f, CeedOperator *op_coarse, 499d1d35e2fSjeremylt CeedOperator *op_prolong, CeedOperator *op_restrict); 5002b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorMultigridLevelCreateH1(CeedOperator op_fine, CeedVector p_mult_fine, CeedElemRestriction rstr_coarse, 5012b730f8bSJeremy L Thompson CeedBasis basis_coarse, const CeedScalar *interp_c_to_f, CeedOperator *op_coarse, 502d1d35e2fSjeremylt CeedOperator *op_prolong, CeedOperator *op_restrict); 5032b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorCreateFDMElementInverse(CeedOperator op, CeedOperator *fdm_inv, CeedRequest *request); 504cd4dfc48Sjeremylt CEED_EXTERN int CeedOperatorSetNumQuadraturePoints(CeedOperator op, CeedInt num_qpts); 505ea6b5821SJeremy L Thompson CEED_EXTERN int CeedOperatorSetName(CeedOperator op, const char *name); 506ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorView(CeedOperator op, FILE *stream); 507b7c9bbdaSJeremy L Thompson CEED_EXTERN int CeedOperatorGetCeed(CeedOperator op, Ceed *ceed); 508b7c9bbdaSJeremy L Thompson CEED_EXTERN int CeedOperatorGetNumElements(CeedOperator op, CeedInt *num_elem); 5092b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorGetNumQuadraturePoints(CeedOperator op, CeedInt *num_qpts); 5109d36ca50SJeremy L Thompson CEED_EXTERN int CeedOperatorGetFlopsEstimate(CeedOperator op, CeedSize *flops); 5110126412dSJeremy L Thompson CEED_EXTERN int CeedOperatorGetContext(CeedOperator op, CeedQFunctionContext *ctx); 51217b0d5c6SJeremy L Thompson CEED_EXTERN int CeedOperatorGetContextFieldLabel(CeedOperator op, const char *field_name, CeedContextFieldLabel *field_label); 51317b0d5c6SJeremy L Thompson CEED_EXTERN int CeedOperatorSetContextDouble(CeedOperator op, CeedContextFieldLabel field_label, double *values); 51417b0d5c6SJeremy L Thompson CEED_EXTERN int CeedOperatorGetContextDoubleRead(CeedOperator op, CeedContextFieldLabel field_label, size_t *num_values, const double **values); 51517b0d5c6SJeremy L Thompson CEED_EXTERN int CeedOperatorRestoreContextDoubleRead(CeedOperator op, CeedContextFieldLabel field_label, const double **values); 51617b0d5c6SJeremy L Thompson CEED_EXTERN int CeedOperatorSetContextInt32(CeedOperator op, CeedContextFieldLabel field_label, int *values); 51717b0d5c6SJeremy L Thompson CEED_EXTERN int CeedOperatorGetContextInt32Read(CeedOperator op, CeedContextFieldLabel field_label, size_t *num_values, const int **values); 51817b0d5c6SJeremy L Thompson CEED_EXTERN int CeedOperatorRestoreContextInt32Read(CeedOperator op, CeedContextFieldLabel field_label, const int **values); 5192b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorApply(CeedOperator op, CeedVector in, CeedVector out, CeedRequest *request); 5202b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorApplyAdd(CeedOperator op, CeedVector in, CeedVector out, CeedRequest *request); 521ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorDestroy(CeedOperator *op); 522ec3da8bcSJed Brown 523de5900adSJames Wright CEED_EXTERN int CeedOperatorGetFieldByName(CeedOperator op, const char *field_name, CeedOperatorField *op_field); 5242b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorFieldGetName(CeedOperatorField op_field, char **field_name); 5252b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorFieldGetElemRestriction(CeedOperatorField op_field, CeedElemRestriction *rstr); 5262b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorFieldGetBasis(CeedOperatorField op_field, CeedBasis *basis); 5272b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorFieldGetVector(CeedOperatorField op_field, CeedVector *vec); 52843bbe138SJeremy L Thompson 529ec3da8bcSJed Brown /** 530ec3da8bcSJed Brown @brief Return integer power 531ec3da8bcSJed Brown 532ec3da8bcSJed Brown @param[in] base The base to exponentiate 533ec3da8bcSJed Brown @param[in] power The power to raise the base to 534ec3da8bcSJed Brown 535ec3da8bcSJed Brown @return base^power 536ec3da8bcSJed Brown 537ec3da8bcSJed Brown @ref Utility 538ec3da8bcSJed Brown **/ 539ec3da8bcSJed Brown static inline CeedInt CeedIntPow(CeedInt base, CeedInt power) { 540ec3da8bcSJed Brown CeedInt result = 1; 541ec3da8bcSJed Brown while (power) { 542ec3da8bcSJed Brown if (power & 1) result *= base; 543ec3da8bcSJed Brown power >>= 1; 544ec3da8bcSJed Brown base *= base; 545ec3da8bcSJed Brown } 546ec3da8bcSJed Brown return result; 547ec3da8bcSJed Brown } 548ec3da8bcSJed Brown 549ec3da8bcSJed Brown /** 550ec3da8bcSJed Brown @brief Return minimum of two integers 551ec3da8bcSJed Brown 552ec3da8bcSJed Brown @param[in] a The first integer to compare 553ec3da8bcSJed Brown @param[in] b The second integer to compare 554ec3da8bcSJed Brown 555ec3da8bcSJed Brown @return The minimum of the two integers 556ec3da8bcSJed Brown 557ec3da8bcSJed Brown @ref Utility 558ec3da8bcSJed Brown **/ 559ec3da8bcSJed Brown static inline CeedInt CeedIntMin(CeedInt a, CeedInt b) { return a < b ? a : b; } 560ec3da8bcSJed Brown 561ec3da8bcSJed Brown /** 562ec3da8bcSJed Brown @brief Return maximum of two integers 563ec3da8bcSJed Brown 564ec3da8bcSJed Brown @param[in] a The first integer to compare 565ec3da8bcSJed Brown @param[in] b The second integer to compare 566ec3da8bcSJed Brown 567ec3da8bcSJed Brown @return The maximum of the two integers 568ec3da8bcSJed Brown 569ec3da8bcSJed Brown @ref Utility 570ec3da8bcSJed Brown **/ 571ec3da8bcSJed Brown static inline CeedInt CeedIntMax(CeedInt a, CeedInt b) { return a > b ? a : b; } 572ec3da8bcSJed Brown 573ec3da8bcSJed Brown // Used to ensure initialization before CeedInit() 574ec3da8bcSJed Brown CEED_EXTERN int CeedRegisterAll(void); 575ec3da8bcSJed Brown // Used to ensure initialization before CeedQFunctionCreate*() 576ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionRegisterAll(void); 577ec3da8bcSJed Brown 578ec3da8bcSJed Brown #endif 579