xref: /libCEED/rust/libceed-sys/c-src/include/ceed/backend.h (revision aca496be06f7af637de27d72e7ffdf1c079082ea) !
13d8e8822SJeremy L Thompson // Copyright (c) 2017-2022, Lawrence Livermore National Security, LLC and other CEED contributors.
23d8e8822SJeremy L Thompson // All Rights Reserved. See the top-level LICENSE and NOTICE files for details.
3ec3da8bcSJed Brown //
43d8e8822SJeremy L Thompson // SPDX-License-Identifier: BSD-2-Clause
5ec3da8bcSJed Brown //
63d8e8822SJeremy L Thompson // This file is part of CEED:  http://github.com/ceed
7ec3da8bcSJed Brown 
8ec3da8bcSJed Brown /// @file
9ec3da8bcSJed Brown /// Public header for backend components of libCEED
10ec3da8bcSJed Brown #ifndef _ceed_backend_h
11ec3da8bcSJed Brown #define _ceed_backend_h
12ec3da8bcSJed Brown 
1349aac155SJeremy L Thompson #include <ceed.h>
14d0c91ce9Sjeremylt #include <limits.h>
15ec3da8bcSJed Brown #include <stdbool.h>
16ec3da8bcSJed Brown 
172b730f8bSJeremy L Thompson #if defined(__clang_analyzer__)
182b730f8bSJeremy L Thompson #define CEED_INTERN
192b730f8bSJeremy L Thompson #elif defined(__cplusplus)
203b271f31SJed Brown #define CEED_INTERN extern "C" CEED_VISIBILITY(hidden)
213b271f31SJed Brown #else
223b271f31SJed Brown #define CEED_INTERN extern CEED_VISIBILITY(hidden)
233b271f31SJed Brown #endif
243b271f31SJed Brown 
25ec3da8bcSJed Brown #define CEED_UNUSED __attribute__((unused))
26ec3da8bcSJed Brown 
27ec3da8bcSJed Brown #define CEED_MAX_RESOURCE_LEN 1024
28d0c91ce9Sjeremylt #define CEED_MAX_BACKEND_PRIORITY UINT_MAX
29ec3da8bcSJed Brown #define CEED_ALIGN 64
30ec3da8bcSJed Brown #define CEED_COMPOSITE_MAX 16
31bf4cb664SJeremy L Thompson #define CEED_FIELD_MAX 16
32ec3da8bcSJed Brown 
3303d18186Sjeremylt #ifndef CeedPragmaOptimizeOff
3403d18186Sjeremylt #if defined(__clang__)
351f97d2f1SJeremy L Thompson /// This macro provides the ability to disable optimization flags for functions that are sensitive to floating point optimizations.
361f97d2f1SJeremy L Thompson /// @ingroup Ceed
3703d18186Sjeremylt #define CeedPragmaOptimizeOff _Pragma("clang optimize off")
3803d18186Sjeremylt #elif defined(__GNUC__)
3903d18186Sjeremylt #define CeedPragmaOptimizeOff _Pragma("GCC push_options") _Pragma("GCC optimize 0")
4003d18186Sjeremylt #elif defined(__INTEL_COMPILER) || defined(__INTEL_LLVM_COMPILER)
4103d18186Sjeremylt #define CeedPragmaOptimizeOff _Pragma("optimize('', off)")
4203d18186Sjeremylt #else
4303d18186Sjeremylt #define CeedPragmaOptimizeOff
4403d18186Sjeremylt #endif
4503d18186Sjeremylt #endif
4603d18186Sjeremylt 
4703d18186Sjeremylt #ifndef CeedPragmaOptimizeOn
4803d18186Sjeremylt #if defined(__clang__)
491f97d2f1SJeremy L Thompson /// This macro restores previously set optimization flags after CeedPragmaOptimizeOff.
501f97d2f1SJeremy L Thompson /// @ingroup Ceed
5103d18186Sjeremylt #define CeedPragmaOptimizeOn _Pragma("clang optimize on")
5203d18186Sjeremylt #elif defined(__GNUC__)
5303d18186Sjeremylt #define CeedPragmaOptimizeOn _Pragma("GCC pop_options")
5403d18186Sjeremylt #elif defined(__INTEL_COMPILER) || defined(__INTEL_LLVM_COMPILER)
5503d18186Sjeremylt #define CeedPragmaOptimizeOff _Pragma("optimize('', on)")
5603d18186Sjeremylt #else
5703d18186Sjeremylt #define CeedPragmaOptimizeOn
5803d18186Sjeremylt #endif
5903d18186Sjeremylt #endif
6003d18186Sjeremylt 
611f97d2f1SJeremy L Thompson /**
621f97d2f1SJeremy L Thompson   This enum supples common colors for CeedDebug256 debugging output.
631f97d2f1SJeremy L Thompson   Set the environment variable `CEED_DEBUG = 1` to activate debugging output.
641f97d2f1SJeremy L Thompson 
651f97d2f1SJeremy L Thompson   @ingroup Ceed
661f97d2f1SJeremy L Thompson   @ref     Backend
671f97d2f1SJeremy L Thompson **/
6823d4529eSJeremy L Thompson typedef enum {
6923d4529eSJeremy L Thompson   /// Success color
7023d4529eSJeremy L Thompson   CEED_DEBUG_COLOR_SUCCESS = 108,
7123d4529eSJeremy L Thompson   /// Warning color
7223d4529eSJeremy L Thompson   CEED_DEBUG_COLOR_WARNING = 208,
7323d4529eSJeremy L Thompson   /// Error color
7423d4529eSJeremy L Thompson   CEED_DEBUG_COLOR_ERROR = 196,
7523d4529eSJeremy L Thompson   /// Use native terminal coloring
7623d4529eSJeremy L Thompson   CEED_DEBUG_COLOR_NONE = 255,
7723d4529eSJeremy L Thompson } CeedDebugColor;
783f21f6b1SJeremy L Thompson 
793f21f6b1SJeremy L Thompson CEED_EXTERN void CeedDebugImpl256(const unsigned char, const char *, ...);
803f21f6b1SJeremy L Thompson CEED_EXTERN bool CeedDebugFlag(const Ceed ceed);
813f21f6b1SJeremy L Thompson CEED_EXTERN bool CeedDebugFlagEnv(void);
821f97d2f1SJeremy L Thompson /**
831f97d2f1SJeremy L Thompson   Print debugging information in color
841f97d2f1SJeremy L Thompson 
851f97d2f1SJeremy L Thompson   @param[in] ceed  Ceed
861f97d2f1SJeremy L Thompson   @param[in] color Color to print with
871f97d2f1SJeremy L Thompson 
881f97d2f1SJeremy L Thompson   @ingroup Ceed
891f97d2f1SJeremy L Thompson   @ref     Backend
901f97d2f1SJeremy L Thompson **/
913f21f6b1SJeremy L Thompson #define CeedDebug256(ceed, color, ...)                               \
922b730f8bSJeremy L Thompson   {                                                                  \
932b730f8bSJeremy L Thompson     if (CeedDebugFlag(ceed)) CeedDebugImpl256(color, ##__VA_ARGS__); \
942b730f8bSJeremy L Thompson   }
951f97d2f1SJeremy L Thompson /**
961f97d2f1SJeremy L Thompson   Print debugging information to terminal
971f97d2f1SJeremy L Thompson 
981f97d2f1SJeremy L Thompson   @param[in] ceed  Ceed
991f97d2f1SJeremy L Thompson 
1001f97d2f1SJeremy L Thompson   @ingroup Ceed
1011f97d2f1SJeremy L Thompson   @ref     Backend
1021f97d2f1SJeremy L Thompson **/
1033f21f6b1SJeremy L Thompson #define CeedDebug(ceed, ...) CeedDebug256(ceed, (unsigned char)CEED_DEBUG_COLOR_NONE, ##__VA_ARGS__)
1041f97d2f1SJeremy L Thompson /**
1051f97d2f1SJeremy L Thompson   Print debugging information in color without Ceed to reference
1061f97d2f1SJeremy L Thompson 
1071f97d2f1SJeremy L Thompson   @param[in] color Color to print with
1081f97d2f1SJeremy L Thompson 
1091f97d2f1SJeremy L Thompson   @ingroup Ceed
1101f97d2f1SJeremy L Thompson   @ref     Backend
1111f97d2f1SJeremy L Thompson **/
1123f21f6b1SJeremy L Thompson #define CeedDebugEnv256(color, ...)                                 \
1132b730f8bSJeremy L Thompson   {                                                                 \
1142b730f8bSJeremy L Thompson     if (CeedDebugFlagEnv()) CeedDebugImpl256(color, ##__VA_ARGS__); \
1152b730f8bSJeremy L Thompson   }
1161f97d2f1SJeremy L Thompson /**
1171f97d2f1SJeremy L Thompson   Print debugging information to terminal without Ceed to reference
1181f97d2f1SJeremy L Thompson 
1191f97d2f1SJeremy L Thompson   @ingroup Ceed
1201f97d2f1SJeremy L Thompson   @ref     Backend
1211f97d2f1SJeremy L Thompson **/
1223f21f6b1SJeremy L Thompson #define CeedDebugEnv(...) CeedDebugEnv256((unsigned char)CEED_DEBUG_COLOR_NONE, ##__VA_ARGS__)
123*aca496beSJeremy L Thompson /**
124*aca496beSJeremy L Thompson   Print warning information in color
125*aca496beSJeremy L Thompson 
126*aca496beSJeremy L Thompson   @ingroup Ceed
127*aca496beSJeremy L Thompson   @ref     Backend
128*aca496beSJeremy L Thompson **/
129*aca496beSJeremy L Thompson #define CeedWarn(...) \
130*aca496beSJeremy L Thompson   { CeedDebugImpl256(CEED_DEBUG_COLOR_WARNING, ##__VA_ARGS__); }
131ec3da8bcSJed Brown 
132ec3da8bcSJed Brown /// Handle for object handling TensorContraction
133ec3da8bcSJed Brown /// @ingroup CeedBasis
134ec3da8bcSJed Brown typedef struct CeedTensorContract_private *CeedTensorContract;
135ec3da8bcSJed Brown 
136480fae85SJeremy L Thompson /// Handle for object handling assembled QFunction data
137480fae85SJeremy L Thompson /// @ingroup CeedOperator
138480fae85SJeremy L Thompson typedef struct CeedQFunctionAssemblyData_private *CeedQFunctionAssemblyData;
139480fae85SJeremy L Thompson 
140ed9e99e6SJeremy L Thompson /// Handle for object handling assembled Operator data
141ed9e99e6SJeremy L Thompson /// @ingroup CeedOperator
142ed9e99e6SJeremy L Thompson typedef struct CeedOperatorAssemblyData_private *CeedOperatorAssemblyData;
143ed9e99e6SJeremy L Thompson 
144ea61e9acSJeremy L Thompson /* In the next 3 functions, p has to be the address of a pointer type, i.e. p has to be a pointer to a pointer. */
145ec3da8bcSJed Brown CEED_INTERN int CeedMallocArray(size_t n, size_t unit, void *p);
146ec3da8bcSJed Brown CEED_INTERN int CeedCallocArray(size_t n, size_t unit, void *p);
147ec3da8bcSJed Brown CEED_INTERN int CeedReallocArray(size_t n, size_t unit, void *p);
148f7e22acaSJeremy L Thompson CEED_INTERN int CeedStringAllocCopy(const char *source, char **copy);
149ec3da8bcSJed Brown CEED_INTERN int CeedFree(void *p);
150ec3da8bcSJed Brown 
151d109957bSJeremy L Thompson /**
152d109957bSJeremy L Thompson   @brief Calls a libCEED function and then checks the resulting error code.
153d109957bSJeremy L Thompson   If the error code is non-zero, then the error handler is called and the call from the current function with the error code.
1542b730f8bSJeremy L Thompson 
155d109957bSJeremy L Thompson   @ref Developer
156d109957bSJeremy L Thompson **/
1572b730f8bSJeremy L Thompson #define CeedCall(...)        \
1582b730f8bSJeremy L Thompson   do {                       \
159d109957bSJeremy L Thompson     int ierr_ = __VA_ARGS__; \
160d109957bSJeremy L Thompson     if (ierr_) return ierr_; \
1610126412dSJeremy L Thompson   } while (0)
1622b730f8bSJeremy L Thompson 
163d109957bSJeremy L Thompson /**
164d109957bSJeremy L Thompson   @brief Calls a libCEED function and then checks the resulting error code.
165d109957bSJeremy L Thompson   If the error code is non-zero, then the error handler is called and the call from the current function with the error code.
166d109957bSJeremy L Thompson   All interface level error codes are upgraded to `CEED_ERROR_BACKEND`.
167d109957bSJeremy L Thompson 
168d109957bSJeremy L Thompson   @ref Developer
169d109957bSJeremy L Thompson **/
170d109957bSJeremy L Thompson #define CeedCallBackend(...)                                                     \
171d109957bSJeremy L Thompson   do {                                                                           \
172d109957bSJeremy L Thompson     int ierr_ = __VA_ARGS__;                                                     \
173d109957bSJeremy L Thompson     if (ierr_) return (ierr_ > CEED_ERROR_SUCCESS) ? CEED_ERROR_BACKEND : ierr_; \
174d109957bSJeremy L Thompson   } while (0)
175d109957bSJeremy L Thompson 
176d109957bSJeremy L Thompson /**
177d109957bSJeremy L Thompson   @brief Check that a particular condition is true and returns a `CeedError` if not.
178d109957bSJeremy L Thompson 
179d109957bSJeremy L Thompson   @ref Developer
180d109957bSJeremy L Thompson **/
1816574a04fSJeremy L Thompson #define CeedCheck(cond, ceed, ecode, ...)                    \
1826574a04fSJeremy L Thompson   do {                                                       \
183d109957bSJeremy L Thompson     if (!(cond)) return CeedError(ceed, ecode, __VA_ARGS__); \
1846574a04fSJeremy L Thompson   } while (0)
1856574a04fSJeremy L Thompson 
186d109957bSJeremy L Thompson /* Note - these are legacy macros that should be removed eventually */
187d109957bSJeremy L Thompson #define CeedChk(...) CeedCall(__VA_ARGS__)
188d109957bSJeremy L Thompson #define CeedChkBackend(...) CeedCallBackend(__VA_ARGS__)
189d109957bSJeremy L Thompson 
190ea61e9acSJeremy L Thompson /* Note that CeedMalloc and CeedCalloc will, generally, return pointers with different memory alignments:
191ea61e9acSJeremy L Thompson    CeedMalloc returns pointers aligned at CEED_ALIGN bytes, while CeedCalloc uses the alignment of calloc. */
192ec3da8bcSJed Brown #define CeedMalloc(n, p) CeedMallocArray((n), sizeof(**(p)), p)
193ec3da8bcSJed Brown #define CeedCalloc(n, p) CeedCallocArray((n), sizeof(**(p)), p)
194ec3da8bcSJed Brown #define CeedRealloc(n, p) CeedReallocArray((n), sizeof(**(p)), p)
195ec3da8bcSJed Brown 
1962b730f8bSJeremy L Thompson CEED_EXTERN int CeedRegister(const char *prefix, int (*init)(const char *, Ceed), unsigned int priority);
1972b730f8bSJeremy L Thompson CEED_EXTERN int CeedRegisterImpl(const char *prefix, int (*init)(const char *, Ceed), unsigned int priority);
198ec3da8bcSJed Brown 
199d1d35e2fSjeremylt CEED_EXTERN int CeedIsDebug(Ceed ceed, bool *is_debug);
200bc246734SJeremy L Thompson CEED_EXTERN int CeedGetResourceRoot(Ceed ceed, const char *resource, const char *delineator, char **resource_root);
201ec3da8bcSJed Brown CEED_EXTERN int CeedGetParent(Ceed ceed, Ceed *parent);
202ec3da8bcSJed Brown CEED_EXTERN int CeedGetDelegate(Ceed ceed, Ceed *delegate);
203ec3da8bcSJed Brown CEED_EXTERN int CeedSetDelegate(Ceed ceed, Ceed delegate);
2042b730f8bSJeremy L Thompson CEED_EXTERN int CeedGetObjectDelegate(Ceed ceed, Ceed *delegate, const char *obj_name);
2052b730f8bSJeremy L Thompson CEED_EXTERN int CeedSetObjectDelegate(Ceed ceed, Ceed delegate, const char *obj_name);
2062b730f8bSJeremy L Thompson CEED_EXTERN int CeedGetOperatorFallbackResource(Ceed ceed, const char **resource);
2078687e1d4SJeremy L Thompson CEED_EXTERN int CeedGetOperatorFallbackCeed(Ceed ceed, Ceed *fallback_ceed);
2082b730f8bSJeremy L Thompson CEED_EXTERN int CeedSetOperatorFallbackResource(Ceed ceed, const char *resource);
209ec3da8bcSJed Brown CEED_EXTERN int CeedGetOperatorFallbackParentCeed(Ceed ceed, Ceed *parent);
210d1d35e2fSjeremylt CEED_EXTERN int CeedSetDeterministic(Ceed ceed, bool is_deterministic);
2112b730f8bSJeremy L Thompson CEED_EXTERN int CeedSetBackendFunction(Ceed ceed, const char *type, void *object, const char *func_name, int (*f)());
212ec3da8bcSJed Brown CEED_EXTERN int CeedGetData(Ceed ceed, void *data);
213ec3da8bcSJed Brown CEED_EXTERN int CeedSetData(Ceed ceed, void *data);
2149560d06aSjeremylt CEED_EXTERN int CeedReference(Ceed ceed);
215ec3da8bcSJed Brown 
2169c774eddSJeremy L Thompson CEED_EXTERN int CeedVectorHasValidArray(CeedVector vec, bool *has_valid_array);
2172b730f8bSJeremy L Thompson CEED_EXTERN int CeedVectorHasBorrowedArrayOfType(CeedVector vec, CeedMemType mem_type, bool *has_borrowed_array_of_type);
2189c774eddSJeremy L Thompson CEED_EXTERN int CeedVectorHasValidArray(CeedVector vec, bool *has_valid_array);
219ec3da8bcSJed Brown CEED_EXTERN int CeedVectorGetState(CeedVector vec, uint64_t *state);
220ec3da8bcSJed Brown CEED_EXTERN int CeedVectorGetData(CeedVector vec, void *data);
221ec3da8bcSJed Brown CEED_EXTERN int CeedVectorSetData(CeedVector vec, void *data);
2229560d06aSjeremylt CEED_EXTERN int CeedVectorReference(CeedVector vec);
223ec3da8bcSJed Brown 
224fcbe8c06SSebastian Grimberg /// Type of element restriction;
225fcbe8c06SSebastian Grimberg /// @ingroup CeedElemRestriction
226fcbe8c06SSebastian Grimberg typedef enum {
22761a27d74SSebastian Grimberg   /// Standard element restriction with offsets
22861a27d74SSebastian Grimberg   CEED_RESTRICTION_STANDARD = 1,
229fcbe8c06SSebastian Grimberg   /// Oriented element restriction
230fcbe8c06SSebastian Grimberg   CEED_RESTRICTION_ORIENTED = 2,
231fcbe8c06SSebastian Grimberg   /// Curl-oriented element restriction
232fcbe8c06SSebastian Grimberg   CEED_RESTRICTION_CURL_ORIENTED = 3,
233fcbe8c06SSebastian Grimberg   /// Strided element restriction
234fcbe8c06SSebastian Grimberg   CEED_RESTRICTION_STRIDED = 4,
235fcbe8c06SSebastian Grimberg } CeedRestrictionType;
236fcbe8c06SSebastian Grimberg 
237fcbe8c06SSebastian Grimberg CEED_EXTERN int CeedElemRestrictionGetType(CeedElemRestriction rstr, CeedRestrictionType *rstr_type);
23877d1c127SSebastian Grimberg CEED_EXTERN int CeedElemRestrictionIsStrided(CeedElemRestriction rstr, bool *is_strided);
2392b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionGetStrides(CeedElemRestriction rstr, CeedInt (*strides)[3]);
24077d1c127SSebastian Grimberg CEED_EXTERN int CeedElemRestrictionHasBackendStrides(CeedElemRestriction rstr, bool *has_backend_strides);
2412b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionGetOffsets(CeedElemRestriction rstr, CeedMemType mem_type, const CeedInt **offsets);
2422b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionRestoreOffsets(CeedElemRestriction rstr, const CeedInt **offsets);
24377d1c127SSebastian Grimberg CEED_EXTERN int CeedElemRestrictionGetOrientations(CeedElemRestriction rstr, CeedMemType mem_type, const bool **orients);
24477d1c127SSebastian Grimberg CEED_EXTERN int CeedElemRestrictionRestoreOrientations(CeedElemRestriction rstr, const bool **orients);
2450c73c039SSebastian Grimberg CEED_EXTERN int CeedElemRestrictionGetCurlOrientations(CeedElemRestriction rstr, CeedMemType mem_type, const CeedInt8 **curl_orients);
2460c73c039SSebastian Grimberg CEED_EXTERN int CeedElemRestrictionRestoreCurlOrientations(CeedElemRestriction rstr, const CeedInt8 **curl_orients);
2472b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionGetELayout(CeedElemRestriction rstr, CeedInt (*layout)[3]);
2482b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionSetELayout(CeedElemRestriction rstr, CeedInt layout[3]);
2492b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionGetData(CeedElemRestriction rstr, void *data);
2502b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionSetData(CeedElemRestriction rstr, void *data);
2519560d06aSjeremylt CEED_EXTERN int CeedElemRestrictionReference(CeedElemRestriction rstr);
2529d36ca50SJeremy L Thompson CEED_EXTERN int CeedElemRestrictionGetFlopsEstimate(CeedElemRestriction rstr, CeedTransposeMode t_mode, CeedSize *flops);
253ec3da8bcSJed Brown 
2546f117663SJeremy L Thompson /// Type of FE space;
2556f117663SJeremy L Thompson /// @ingroup CeedBasis
2566f117663SJeremy L Thompson typedef enum {
257c4e3f59bSSebastian Grimberg   /// H^1 FE space
2586f117663SJeremy L Thompson   CEED_FE_SPACE_H1 = 1,
2596f117663SJeremy L Thompson   /// H(div) FE space
2606f117663SJeremy L Thompson   CEED_FE_SPACE_HDIV = 2,
261c4e3f59bSSebastian Grimberg   /// H(curl) FE space
262c4e3f59bSSebastian Grimberg   CEED_FE_SPACE_HCURL = 3,
2636f117663SJeremy L Thompson } CeedFESpace;
2646f117663SJeremy L Thompson CEED_EXTERN const char *const CeedFESpaces[];
2656f117663SJeremy L Thompson 
2662b730f8bSJeremy L Thompson CEED_EXTERN int CeedBasisGetCollocatedGrad(CeedBasis basis, CeedScalar *colo_grad_1d);
267d1d35e2fSjeremylt CEED_EXTERN int CeedBasisIsTensor(CeedBasis basis, bool *is_tensor);
268ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetData(CeedBasis basis, void *data);
269ec3da8bcSJed Brown CEED_EXTERN int CeedBasisSetData(CeedBasis basis, void *data);
2709560d06aSjeremylt CEED_EXTERN int CeedBasisReference(CeedBasis basis);
271c4e3f59bSSebastian Grimberg CEED_EXTERN int CeedBasisGetNumQuadratureComponents(CeedBasis basis, CeedEvalMode eval_mode, CeedInt *q_comp);
2729d36ca50SJeremy L Thompson CEED_EXTERN int CeedBasisGetFlopsEstimate(CeedBasis basis, CeedTransposeMode t_mode, CeedEvalMode eval_mode, CeedSize *flops);
273c4e3f59bSSebastian Grimberg CEED_EXTERN int CeedBasisGetFESpace(CeedBasis basis, CeedFESpace *fe_space);
2742b730f8bSJeremy L Thompson CEED_EXTERN int CeedBasisGetTopologyDimension(CeedElemTopology topo, CeedInt *dim);
2752b730f8bSJeremy L Thompson CEED_EXTERN int CeedBasisGetTensorContract(CeedBasis basis, CeedTensorContract *contract);
2762b730f8bSJeremy L Thompson CEED_EXTERN int CeedBasisSetTensorContract(CeedBasis basis, CeedTensorContract contract);
277c4e3f59bSSebastian Grimberg 
2782b730f8bSJeremy L Thompson CEED_EXTERN int CeedTensorContractCreate(Ceed ceed, CeedBasis basis, CeedTensorContract *contract);
2792b730f8bSJeremy L Thompson CEED_EXTERN int CeedTensorContractApply(CeedTensorContract contract, CeedInt A, CeedInt B, CeedInt C, CeedInt J, const CeedScalar *__restrict__ t,
2802b730f8bSJeremy L Thompson                                         CeedTransposeMode t_mode, const CeedInt Add, const CeedScalar *__restrict__ u, CeedScalar *__restrict__ v);
281c4e3f59bSSebastian Grimberg CEED_EXTERN int CeedTensorContractStridedApply(CeedTensorContract contract, CeedInt A, CeedInt B, CeedInt C, CeedInt D, CeedInt J,
282c4e3f59bSSebastian Grimberg                                                const CeedScalar *__restrict__ t, CeedTransposeMode t_mode, const CeedInt add,
283c4e3f59bSSebastian Grimberg                                                const CeedScalar *__restrict__ u, CeedScalar *__restrict__ v);
2842b730f8bSJeremy L Thompson CEED_EXTERN int CeedTensorContractGetCeed(CeedTensorContract contract, Ceed *ceed);
2852b730f8bSJeremy L Thompson CEED_EXTERN int CeedTensorContractGetData(CeedTensorContract contract, void *data);
2862b730f8bSJeremy L Thompson CEED_EXTERN int CeedTensorContractSetData(CeedTensorContract contract, void *data);
2879560d06aSjeremylt CEED_EXTERN int CeedTensorContractReference(CeedTensorContract contract);
288585a562dSJeremy L Thompson CEED_EXTERN int CeedTensorContractReferenceCopy(CeedTensorContract tensor, CeedTensorContract *tensor_copy);
289ec3da8bcSJed Brown CEED_EXTERN int CeedTensorContractDestroy(CeedTensorContract *contract);
290ec3da8bcSJed Brown 
291509668d5SJeremy L Thompson CEED_EXTERN int CeedQFunctionRegister(const char *name, const char *source, CeedInt vec_length, CeedQFunctionUser f,
292509668d5SJeremy L Thompson                                       int (*init)(Ceed, const char *, CeedQFunction));
293ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionSetFortranStatus(CeedQFunction qf, bool status);
2942b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionGetVectorLength(CeedQFunction qf, CeedInt *vec_length);
2952b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionGetNumArgs(CeedQFunction qf, CeedInt *num_input_fields, CeedInt *num_output_fields);
29643e1b16fSJeremy L Thompson CEED_EXTERN int CeedQFunctionGetKernelName(CeedQFunction qf, char **kernel_name);
29743e1b16fSJeremy L Thompson CEED_EXTERN int CeedQFunctionGetSourcePath(CeedQFunction qf, char **source_path);
2983d3250a0SJeremy L Thompson CEED_EXTERN int CeedQFunctionLoadSourceToBuffer(CeedQFunction qf, char **source_buffer);
2992b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionGetUserFunction(CeedQFunction qf, CeedQFunctionUser *f);
3002b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionGetContext(CeedQFunction qf, CeedQFunctionContext *ctx);
301441428dfSJeremy L Thompson CEED_EXTERN int CeedQFunctionGetContextData(CeedQFunction qf, CeedMemType mem_type, void *data);
302441428dfSJeremy L Thompson CEED_EXTERN int CeedQFunctionRestoreContextData(CeedQFunction qf, void *data);
3032b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionGetInnerContext(CeedQFunction qf, CeedQFunctionContext *ctx);
304441428dfSJeremy L Thompson CEED_EXTERN int CeedQFunctionGetInnerContextData(CeedQFunction qf, CeedMemType mem_type, void *data);
305441428dfSJeremy L Thompson CEED_EXTERN int CeedQFunctionRestoreInnerContextData(CeedQFunction qf, void *data);
306d1d35e2fSjeremylt CEED_EXTERN int CeedQFunctionIsIdentity(CeedQFunction qf, bool *is_identity);
307441428dfSJeremy L Thompson CEED_EXTERN int CeedQFunctionIsContextWritable(CeedQFunction qf, bool *is_writable);
308ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionGetData(CeedQFunction qf, void *data);
309ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionSetData(CeedQFunction qf, void *data);
3109560d06aSjeremylt CEED_EXTERN int CeedQFunctionReference(CeedQFunction qf);
3119d36ca50SJeremy L Thompson CEED_EXTERN int CeedQFunctionGetFlopsEstimate(CeedQFunction qf, CeedSize *flops);
312ec3da8bcSJed Brown 
3132b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextGetCeed(CeedQFunctionContext ctx, Ceed *ceed);
3142b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextHasValidData(CeedQFunctionContext ctx, bool *has_valid_data);
3152b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextHasBorrowedDataOfType(CeedQFunctionContext ctx, CeedMemType mem_type, bool *has_borrowed_data_of_type);
3162b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextGetState(CeedQFunctionContext ctx, uint64_t *state);
3172b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextGetBackendData(CeedQFunctionContext ctx, void *data);
3182b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextSetBackendData(CeedQFunctionContext ctx, void *data);
3192b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextGetFieldLabel(CeedQFunctionContext ctx, const char *field_name, CeedContextFieldLabel *field_label);
3202b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextSetGeneric(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, CeedContextFieldType field_type,
3212b730f8bSJeremy L Thompson                                                void *value);
3222788fa27SJeremy L Thompson CEED_EXTERN int CeedQFunctionContextGetGenericRead(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, CeedContextFieldType field_type,
3232788fa27SJeremy L Thompson                                                    size_t *num_values, void *value);
3242788fa27SJeremy L Thompson CEED_EXTERN int CeedQFunctionContextRestoreGenericRead(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, CeedContextFieldType field_type,
3252788fa27SJeremy L Thompson                                                        void *value);
3262b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextSetDouble(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, double *values);
3272788fa27SJeremy L Thompson CEED_EXTERN int CeedQFunctionContextGetDoubleRead(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, size_t *num_values,
3282788fa27SJeremy L Thompson                                                   const double **values);
3292788fa27SJeremy L Thompson CEED_EXTERN int CeedQFunctionContextRestoreDoubleRead(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, const double **values);
3302b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextSetInt32(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, int *values);
3312788fa27SJeremy L Thompson CEED_EXTERN int CeedQFunctionContextGetInt32Read(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, size_t *num_values, const int **values);
3322788fa27SJeremy L Thompson CEED_EXTERN int CeedQFunctionContextRestoreInt32Read(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, const int **values);
3332b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextGetDataDestroy(CeedQFunctionContext ctx, CeedMemType *f_mem_type, CeedQFunctionContextDataDestroyUser *f);
3349560d06aSjeremylt CEED_EXTERN int CeedQFunctionContextReference(CeedQFunctionContext ctx);
335ec3da8bcSJed Brown 
336480fae85SJeremy L Thompson CEED_EXTERN int CeedQFunctionAssemblyDataCreate(Ceed ceed, CeedQFunctionAssemblyData *data);
337480fae85SJeremy L Thompson CEED_EXTERN int CeedQFunctionAssemblyDataReference(CeedQFunctionAssemblyData data);
338beecbf24SJeremy L Thompson CEED_EXTERN int CeedQFunctionAssemblyDataSetReuse(CeedQFunctionAssemblyData data, bool reuse_assembly_data);
339beecbf24SJeremy L Thompson CEED_EXTERN int CeedQFunctionAssemblyDataSetUpdateNeeded(CeedQFunctionAssemblyData data, bool needs_data_update);
3408b919e6bSJeremy L Thompson CEED_EXTERN int CeedQFunctionAssemblyDataIsUpdateNeeded(CeedQFunctionAssemblyData data, bool *is_update_needed);
341480fae85SJeremy L Thompson CEED_EXTERN int CeedQFunctionAssemblyDataReferenceCopy(CeedQFunctionAssemblyData data, CeedQFunctionAssemblyData *data_copy);
342480fae85SJeremy L Thompson CEED_EXTERN int CeedQFunctionAssemblyDataIsSetup(CeedQFunctionAssemblyData data, bool *is_setup);
343480fae85SJeremy L Thompson CEED_EXTERN int CeedQFunctionAssemblyDataSetObjects(CeedQFunctionAssemblyData data, CeedVector vec, CeedElemRestriction rstr);
344480fae85SJeremy L Thompson CEED_EXTERN int CeedQFunctionAssemblyDataGetObjects(CeedQFunctionAssemblyData data, CeedVector *vec, CeedElemRestriction *rstr);
345480fae85SJeremy L Thompson CEED_EXTERN int CeedQFunctionAssemblyDataDestroy(CeedQFunctionAssemblyData *data);
346480fae85SJeremy L Thompson 
347ed9e99e6SJeremy L Thompson CEED_EXTERN int CeedOperatorAssemblyDataCreate(Ceed ceed, CeedOperator op, CeedOperatorAssemblyData *data);
348437c7c90SJeremy L Thompson CEED_EXTERN int CeedOperatorAssemblyDataGetEvalModes(CeedOperatorAssemblyData data, CeedInt *num_active_bases, CeedInt **num_eval_modes_in,
349437c7c90SJeremy L Thompson                                                      const CeedEvalMode ***eval_modes_in, CeedSize ***eval_mode_offsets_in,
350437c7c90SJeremy L Thompson                                                      CeedInt **num_eval_modes_out, const CeedEvalMode ***eval_modes_out,
351437c7c90SJeremy L Thompson                                                      CeedSize ***eval_mode_offsets_out, CeedSize *num_output_components);
352437c7c90SJeremy L Thompson CEED_EXTERN int CeedOperatorAssemblyDataGetBases(CeedOperatorAssemblyData data, CeedInt *num_active_bases, CeedBasis **active_bases,
353437c7c90SJeremy L Thompson                                                  const CeedScalar ***assembled_bases_in, const CeedScalar ***assembled_bases_out);
354437c7c90SJeremy L Thompson CEED_EXTERN int CeedOperatorAssemblyDataGetElemRestrictions(CeedOperatorAssemblyData data, CeedInt *num_active_elem_rstrs,
355437c7c90SJeremy L Thompson                                                             CeedElemRestriction **active_elem_rstrs);
356ed9e99e6SJeremy L Thompson CEED_EXTERN int CeedOperatorAssemblyDataDestroy(CeedOperatorAssemblyData *data);
357ed9e99e6SJeremy L Thompson 
358ed9e99e6SJeremy L Thompson CEED_EXTERN int CeedOperatorGetOperatorAssemblyData(CeedOperator op, CeedOperatorAssemblyData *data);
3592b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorGetActiveBasis(CeedOperator op, CeedBasis *active_basis);
360ed9e99e6SJeremy L Thompson CEED_EXTERN int CeedOperatorGetActiveElemRestriction(CeedOperator op, CeedElemRestriction *active_rstr);
361d1d35e2fSjeremylt CEED_EXTERN int CeedOperatorGetNumArgs(CeedOperator op, CeedInt *num_args);
362d1d35e2fSjeremylt CEED_EXTERN int CeedOperatorIsSetupDone(CeedOperator op, bool *is_setup_done);
363ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorGetQFunction(CeedOperator op, CeedQFunction *qf);
364d1d35e2fSjeremylt CEED_EXTERN int CeedOperatorIsComposite(CeedOperator op, bool *is_composite);
365ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorGetData(CeedOperator op, void *data);
366ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorSetData(CeedOperator op, void *data);
3679560d06aSjeremylt CEED_EXTERN int CeedOperatorReference(CeedOperator op);
368ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorSetSetupDone(CeedOperator op);
369ec3da8bcSJed Brown 
3702b730f8bSJeremy L Thompson CEED_INTERN int CeedMatrixMatrixMultiply(Ceed ceed, const CeedScalar *mat_A, const CeedScalar *mat_B, CeedScalar *mat_C, CeedInt m, CeedInt n,
3712b730f8bSJeremy L Thompson                                          CeedInt kk);
372ba59ac12SSebastian Grimberg CEED_EXTERN int CeedQRFactorization(Ceed ceed, CeedScalar *mat, CeedScalar *tau, CeedInt m, CeedInt n);
373ba59ac12SSebastian Grimberg CEED_EXTERN int CeedHouseholderApplyQ(CeedScalar *mat_A, const CeedScalar *mat_Q, const CeedScalar *tau, CeedTransposeMode t_mode, CeedInt m,
374ba59ac12SSebastian Grimberg                                       CeedInt n, CeedInt k, CeedInt row, CeedInt col);
375ba59ac12SSebastian Grimberg CEED_EXTERN int CeedSymmetricSchurDecomposition(Ceed ceed, CeedScalar *mat, CeedScalar *lambda, CeedInt n);
376ba59ac12SSebastian Grimberg CEED_EXTERN int CeedSimultaneousDiagonalization(Ceed ceed, CeedScalar *mat_A, CeedScalar *mat_B, CeedScalar *x, CeedScalar *lambda, CeedInt n);
377ec3da8bcSJed Brown 
378ec3da8bcSJed Brown #endif
379