xref: /libCEED/rust/libceed-sys/c-src/include/ceed/backend.h (revision fcbe8c069ccd22d836386af4823e4c7d84ee0a69)
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__)
123ec3da8bcSJed Brown 
124ec3da8bcSJed Brown /// Handle for object handling TensorContraction
125ec3da8bcSJed Brown /// @ingroup CeedBasis
126ec3da8bcSJed Brown typedef struct CeedTensorContract_private *CeedTensorContract;
127ec3da8bcSJed Brown 
128480fae85SJeremy L Thompson /// Handle for object handling assembled QFunction data
129480fae85SJeremy L Thompson /// @ingroup CeedOperator
130480fae85SJeremy L Thompson typedef struct CeedQFunctionAssemblyData_private *CeedQFunctionAssemblyData;
131480fae85SJeremy L Thompson 
132ed9e99e6SJeremy L Thompson /// Handle for object handling assembled Operator data
133ed9e99e6SJeremy L Thompson /// @ingroup CeedOperator
134ed9e99e6SJeremy L Thompson typedef struct CeedOperatorAssemblyData_private *CeedOperatorAssemblyData;
135ed9e99e6SJeremy L Thompson 
136ea61e9acSJeremy 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. */
137ec3da8bcSJed Brown CEED_INTERN int CeedMallocArray(size_t n, size_t unit, void *p);
138ec3da8bcSJed Brown CEED_INTERN int CeedCallocArray(size_t n, size_t unit, void *p);
139ec3da8bcSJed Brown CEED_INTERN int CeedReallocArray(size_t n, size_t unit, void *p);
140f7e22acaSJeremy L Thompson CEED_INTERN int CeedStringAllocCopy(const char *source, char **copy);
141ec3da8bcSJed Brown CEED_INTERN int CeedFree(void *p);
142ec3da8bcSJed Brown 
1432b730f8bSJeremy L Thompson #define CeedChk(ierr)        \
1442b730f8bSJeremy L Thompson   do {                       \
1452b730f8bSJeremy L Thompson     int ierr_ = ierr;        \
1462b730f8bSJeremy L Thompson     if (ierr_) return ierr_; \
1472b730f8bSJeremy L Thompson   } while (0)
1482b730f8bSJeremy L Thompson #define CeedChkBackend(ierr)                                     \
1492b730f8bSJeremy L Thompson   do {                                                           \
1502b730f8bSJeremy L Thompson     int ierr_ = ierr;                                            \
1512b730f8bSJeremy L Thompson     if (ierr_) {                                                 \
1522b730f8bSJeremy L Thompson       if (ierr_ > CEED_ERROR_SUCCESS) return CEED_ERROR_BACKEND; \
1532b730f8bSJeremy L Thompson       else return ierr_;                                         \
1542b730f8bSJeremy L Thompson     }                                                            \
1552b730f8bSJeremy L Thompson   } while (0)
1562b730f8bSJeremy L Thompson 
1572b730f8bSJeremy L Thompson #define CeedCall(...)          \
1582b730f8bSJeremy L Thompson   do {                         \
1592b730f8bSJeremy L Thompson     int ierr_q_ = __VA_ARGS__; \
1602b730f8bSJeremy L Thompson     CeedChk(ierr_q_);          \
1610126412dSJeremy L Thompson   } while (0)
1622b730f8bSJeremy L Thompson #define CeedCallBackend(...)   \
1632b730f8bSJeremy L Thompson   do {                         \
1642b730f8bSJeremy L Thompson     int ierr_q_ = __VA_ARGS__; \
1652b730f8bSJeremy L Thompson     CeedChkBackend(ierr_q_);   \
1660126412dSJeremy L Thompson   } while (0)
1672b730f8bSJeremy L Thompson 
1686574a04fSJeremy L Thompson #define CeedCheck(cond, ceed, ecode, ...)         \
1696574a04fSJeremy L Thompson   do {                                            \
1706574a04fSJeremy L Thompson     if (!(cond)) {                                \
1716574a04fSJeremy L Thompson       return CeedError(ceed, ecode, __VA_ARGS__); \
1726574a04fSJeremy L Thompson     }                                             \
1736574a04fSJeremy L Thompson   } while (0)
1746574a04fSJeremy L Thompson 
175ea61e9acSJeremy L Thompson /* Note that CeedMalloc and CeedCalloc will, generally, return pointers with different memory alignments:
176ea61e9acSJeremy L Thompson    CeedMalloc returns pointers aligned at CEED_ALIGN bytes, while CeedCalloc uses the alignment of calloc. */
177ec3da8bcSJed Brown #define CeedMalloc(n, p) CeedMallocArray((n), sizeof(**(p)), p)
178ec3da8bcSJed Brown #define CeedCalloc(n, p) CeedCallocArray((n), sizeof(**(p)), p)
179ec3da8bcSJed Brown #define CeedRealloc(n, p) CeedReallocArray((n), sizeof(**(p)), p)
180ec3da8bcSJed Brown 
1812b730f8bSJeremy L Thompson CEED_EXTERN int CeedRegister(const char *prefix, int (*init)(const char *, Ceed), unsigned int priority);
1822b730f8bSJeremy L Thompson CEED_EXTERN int CeedRegisterImpl(const char *prefix, int (*init)(const char *, Ceed), unsigned int priority);
183ec3da8bcSJed Brown 
184d1d35e2fSjeremylt CEED_EXTERN int CeedIsDebug(Ceed ceed, bool *is_debug);
185bc246734SJeremy L Thompson CEED_EXTERN int CeedGetResourceRoot(Ceed ceed, const char *resource, const char *delineator, char **resource_root);
186ec3da8bcSJed Brown CEED_EXTERN int CeedGetParent(Ceed ceed, Ceed *parent);
187ec3da8bcSJed Brown CEED_EXTERN int CeedGetDelegate(Ceed ceed, Ceed *delegate);
188ec3da8bcSJed Brown CEED_EXTERN int CeedSetDelegate(Ceed ceed, Ceed delegate);
1892b730f8bSJeremy L Thompson CEED_EXTERN int CeedGetObjectDelegate(Ceed ceed, Ceed *delegate, const char *obj_name);
1902b730f8bSJeremy L Thompson CEED_EXTERN int CeedSetObjectDelegate(Ceed ceed, Ceed delegate, const char *obj_name);
1912b730f8bSJeremy L Thompson CEED_EXTERN int CeedGetOperatorFallbackResource(Ceed ceed, const char **resource);
1928687e1d4SJeremy L Thompson CEED_EXTERN int CeedGetOperatorFallbackCeed(Ceed ceed, Ceed *fallback_ceed);
1932b730f8bSJeremy L Thompson CEED_EXTERN int CeedSetOperatorFallbackResource(Ceed ceed, const char *resource);
194ec3da8bcSJed Brown CEED_EXTERN int CeedGetOperatorFallbackParentCeed(Ceed ceed, Ceed *parent);
195d1d35e2fSjeremylt CEED_EXTERN int CeedSetDeterministic(Ceed ceed, bool is_deterministic);
1962b730f8bSJeremy L Thompson CEED_EXTERN int CeedSetBackendFunction(Ceed ceed, const char *type, void *object, const char *func_name, int (*f)());
197ec3da8bcSJed Brown CEED_EXTERN int CeedGetData(Ceed ceed, void *data);
198ec3da8bcSJed Brown CEED_EXTERN int CeedSetData(Ceed ceed, void *data);
1999560d06aSjeremylt CEED_EXTERN int CeedReference(Ceed ceed);
200ec3da8bcSJed Brown 
2019c774eddSJeremy L Thompson CEED_EXTERN int CeedVectorHasValidArray(CeedVector vec, bool *has_valid_array);
2022b730f8bSJeremy L Thompson CEED_EXTERN int CeedVectorHasBorrowedArrayOfType(CeedVector vec, CeedMemType mem_type, bool *has_borrowed_array_of_type);
2039c774eddSJeremy L Thompson CEED_EXTERN int CeedVectorHasValidArray(CeedVector vec, bool *has_valid_array);
204ec3da8bcSJed Brown CEED_EXTERN int CeedVectorGetState(CeedVector vec, uint64_t *state);
205ec3da8bcSJed Brown CEED_EXTERN int CeedVectorGetData(CeedVector vec, void *data);
206ec3da8bcSJed Brown CEED_EXTERN int CeedVectorSetData(CeedVector vec, void *data);
2079560d06aSjeremylt CEED_EXTERN int CeedVectorReference(CeedVector vec);
208ec3da8bcSJed Brown 
209*fcbe8c06SSebastian Grimberg /// Type of element restriction;
210*fcbe8c06SSebastian Grimberg /// @ingroup CeedElemRestriction
211*fcbe8c06SSebastian Grimberg typedef enum {
212*fcbe8c06SSebastian Grimberg   /// Default element restriction with offsets
213*fcbe8c06SSebastian Grimberg   CEED_RESTRICTION_DEFAULT = 1,
214*fcbe8c06SSebastian Grimberg   /// Oriented element restriction
215*fcbe8c06SSebastian Grimberg   CEED_RESTRICTION_ORIENTED = 2,
216*fcbe8c06SSebastian Grimberg   /// Curl-oriented element restriction
217*fcbe8c06SSebastian Grimberg   CEED_RESTRICTION_CURL_ORIENTED = 3,
218*fcbe8c06SSebastian Grimberg   /// Strided element restriction
219*fcbe8c06SSebastian Grimberg   CEED_RESTRICTION_STRIDED = 4,
220*fcbe8c06SSebastian Grimberg } CeedRestrictionType;
221*fcbe8c06SSebastian Grimberg 
22278b2e752SJeremy L Thompson CEED_EXTERN int CeedElemRestrictionApplyUnsigned(CeedElemRestriction rstr, CeedTransposeMode t_mode, CeedVector u, CeedVector ru,
22378b2e752SJeremy L Thompson                                                  CeedRequest *request);
224*fcbe8c06SSebastian Grimberg CEED_EXTERN int CeedElemRestrictionGetType(CeedElemRestriction rstr, CeedRestrictionType *rstr_type);
22577d1c127SSebastian Grimberg CEED_EXTERN int CeedElemRestrictionIsStrided(CeedElemRestriction rstr, bool *is_strided);
2262b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionGetStrides(CeedElemRestriction rstr, CeedInt (*strides)[3]);
22777d1c127SSebastian Grimberg CEED_EXTERN int CeedElemRestrictionHasBackendStrides(CeedElemRestriction rstr, bool *has_backend_strides);
2282b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionGetOffsets(CeedElemRestriction rstr, CeedMemType mem_type, const CeedInt **offsets);
2292b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionRestoreOffsets(CeedElemRestriction rstr, const CeedInt **offsets);
23077d1c127SSebastian Grimberg CEED_EXTERN int CeedElemRestrictionGetOrientations(CeedElemRestriction rstr, CeedMemType mem_type, const bool **orients);
23177d1c127SSebastian Grimberg CEED_EXTERN int CeedElemRestrictionRestoreOrientations(CeedElemRestriction rstr, const bool **orients);
23277d1c127SSebastian Grimberg CEED_EXTERN int CeedElemRestrictionGetCurlOrientations(CeedElemRestriction rstr, CeedMemType mem_type, const CeedInt **curl_orients);
23377d1c127SSebastian Grimberg CEED_EXTERN int CeedElemRestrictionRestoreCurlOrientations(CeedElemRestriction rstr, const CeedInt **curl_orients);
2342b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionGetELayout(CeedElemRestriction rstr, CeedInt (*layout)[3]);
2352b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionSetELayout(CeedElemRestriction rstr, CeedInt layout[3]);
2362b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionGetData(CeedElemRestriction rstr, void *data);
2372b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionSetData(CeedElemRestriction rstr, void *data);
2389560d06aSjeremylt CEED_EXTERN int CeedElemRestrictionReference(CeedElemRestriction rstr);
2399d36ca50SJeremy L Thompson CEED_EXTERN int CeedElemRestrictionGetFlopsEstimate(CeedElemRestriction rstr, CeedTransposeMode t_mode, CeedSize *flops);
240ec3da8bcSJed Brown 
2416f117663SJeremy L Thompson /// Type of FE space;
2426f117663SJeremy L Thompson /// @ingroup CeedBasis
2436f117663SJeremy L Thompson typedef enum {
244c4e3f59bSSebastian Grimberg   /// H^1 FE space
2456f117663SJeremy L Thompson   CEED_FE_SPACE_H1 = 1,
2466f117663SJeremy L Thompson   /// H(div) FE space
2476f117663SJeremy L Thompson   CEED_FE_SPACE_HDIV = 2,
248c4e3f59bSSebastian Grimberg   /// H(curl) FE space
249c4e3f59bSSebastian Grimberg   CEED_FE_SPACE_HCURL = 3,
2506f117663SJeremy L Thompson } CeedFESpace;
2516f117663SJeremy L Thompson CEED_EXTERN const char *const CeedFESpaces[];
2526f117663SJeremy L Thompson 
2532b730f8bSJeremy L Thompson CEED_EXTERN int CeedBasisGetCollocatedGrad(CeedBasis basis, CeedScalar *colo_grad_1d);
254d1d35e2fSjeremylt CEED_EXTERN int CeedBasisIsTensor(CeedBasis basis, bool *is_tensor);
255ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetData(CeedBasis basis, void *data);
256ec3da8bcSJed Brown CEED_EXTERN int CeedBasisSetData(CeedBasis basis, void *data);
2579560d06aSjeremylt CEED_EXTERN int CeedBasisReference(CeedBasis basis);
258c4e3f59bSSebastian Grimberg CEED_EXTERN int CeedBasisGetNumQuadratureComponents(CeedBasis basis, CeedEvalMode eval_mode, CeedInt *q_comp);
2599d36ca50SJeremy L Thompson CEED_EXTERN int CeedBasisGetFlopsEstimate(CeedBasis basis, CeedTransposeMode t_mode, CeedEvalMode eval_mode, CeedSize *flops);
260c4e3f59bSSebastian Grimberg CEED_EXTERN int CeedBasisGetFESpace(CeedBasis basis, CeedFESpace *fe_space);
2612b730f8bSJeremy L Thompson CEED_EXTERN int CeedBasisGetTopologyDimension(CeedElemTopology topo, CeedInt *dim);
2622b730f8bSJeremy L Thompson CEED_EXTERN int CeedBasisGetTensorContract(CeedBasis basis, CeedTensorContract *contract);
2632b730f8bSJeremy L Thompson CEED_EXTERN int CeedBasisSetTensorContract(CeedBasis basis, CeedTensorContract contract);
264c4e3f59bSSebastian Grimberg 
2652b730f8bSJeremy L Thompson CEED_EXTERN int CeedTensorContractCreate(Ceed ceed, CeedBasis basis, CeedTensorContract *contract);
2662b730f8bSJeremy L Thompson CEED_EXTERN int CeedTensorContractApply(CeedTensorContract contract, CeedInt A, CeedInt B, CeedInt C, CeedInt J, const CeedScalar *__restrict__ t,
2672b730f8bSJeremy L Thompson                                         CeedTransposeMode t_mode, const CeedInt Add, const CeedScalar *__restrict__ u, CeedScalar *__restrict__ v);
268c4e3f59bSSebastian Grimberg CEED_EXTERN int CeedTensorContractStridedApply(CeedTensorContract contract, CeedInt A, CeedInt B, CeedInt C, CeedInt D, CeedInt J,
269c4e3f59bSSebastian Grimberg                                                const CeedScalar *__restrict__ t, CeedTransposeMode t_mode, const CeedInt add,
270c4e3f59bSSebastian Grimberg                                                const CeedScalar *__restrict__ u, CeedScalar *__restrict__ v);
2712b730f8bSJeremy L Thompson CEED_EXTERN int CeedTensorContractGetCeed(CeedTensorContract contract, Ceed *ceed);
2722b730f8bSJeremy L Thompson CEED_EXTERN int CeedTensorContractGetData(CeedTensorContract contract, void *data);
2732b730f8bSJeremy L Thompson CEED_EXTERN int CeedTensorContractSetData(CeedTensorContract contract, void *data);
2749560d06aSjeremylt CEED_EXTERN int CeedTensorContractReference(CeedTensorContract contract);
275ec3da8bcSJed Brown CEED_EXTERN int CeedTensorContractDestroy(CeedTensorContract *contract);
276ec3da8bcSJed Brown 
277509668d5SJeremy L Thompson CEED_EXTERN int CeedQFunctionRegister(const char *name, const char *source, CeedInt vec_length, CeedQFunctionUser f,
278509668d5SJeremy L Thompson                                       int (*init)(Ceed, const char *, CeedQFunction));
279ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionSetFortranStatus(CeedQFunction qf, bool status);
2802b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionGetVectorLength(CeedQFunction qf, CeedInt *vec_length);
2812b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionGetNumArgs(CeedQFunction qf, CeedInt *num_input_fields, CeedInt *num_output_fields);
28243e1b16fSJeremy L Thompson CEED_EXTERN int CeedQFunctionGetKernelName(CeedQFunction qf, char **kernel_name);
28343e1b16fSJeremy L Thompson CEED_EXTERN int CeedQFunctionGetSourcePath(CeedQFunction qf, char **source_path);
2843d3250a0SJeremy L Thompson CEED_EXTERN int CeedQFunctionLoadSourceToBuffer(CeedQFunction qf, char **source_buffer);
2852b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionGetUserFunction(CeedQFunction qf, CeedQFunctionUser *f);
2862b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionGetContext(CeedQFunction qf, CeedQFunctionContext *ctx);
287441428dfSJeremy L Thompson CEED_EXTERN int CeedQFunctionGetContextData(CeedQFunction qf, CeedMemType mem_type, void *data);
288441428dfSJeremy L Thompson CEED_EXTERN int CeedQFunctionRestoreContextData(CeedQFunction qf, void *data);
2892b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionGetInnerContext(CeedQFunction qf, CeedQFunctionContext *ctx);
290441428dfSJeremy L Thompson CEED_EXTERN int CeedQFunctionGetInnerContextData(CeedQFunction qf, CeedMemType mem_type, void *data);
291441428dfSJeremy L Thompson CEED_EXTERN int CeedQFunctionRestoreInnerContextData(CeedQFunction qf, void *data);
292d1d35e2fSjeremylt CEED_EXTERN int CeedQFunctionIsIdentity(CeedQFunction qf, bool *is_identity);
293441428dfSJeremy L Thompson CEED_EXTERN int CeedQFunctionIsContextWritable(CeedQFunction qf, bool *is_writable);
294ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionGetData(CeedQFunction qf, void *data);
295ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionSetData(CeedQFunction qf, void *data);
2969560d06aSjeremylt CEED_EXTERN int CeedQFunctionReference(CeedQFunction qf);
2979d36ca50SJeremy L Thompson CEED_EXTERN int CeedQFunctionGetFlopsEstimate(CeedQFunction qf, CeedSize *flops);
298ec3da8bcSJed Brown 
2992b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextGetCeed(CeedQFunctionContext ctx, Ceed *ceed);
3002b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextHasValidData(CeedQFunctionContext ctx, bool *has_valid_data);
3012b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextHasBorrowedDataOfType(CeedQFunctionContext ctx, CeedMemType mem_type, bool *has_borrowed_data_of_type);
3022b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextGetState(CeedQFunctionContext ctx, uint64_t *state);
3032b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextGetBackendData(CeedQFunctionContext ctx, void *data);
3042b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextSetBackendData(CeedQFunctionContext ctx, void *data);
3052b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextGetFieldLabel(CeedQFunctionContext ctx, const char *field_name, CeedContextFieldLabel *field_label);
3062b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextSetGeneric(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, CeedContextFieldType field_type,
3072b730f8bSJeremy L Thompson                                                void *value);
3082788fa27SJeremy L Thompson CEED_EXTERN int CeedQFunctionContextGetGenericRead(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, CeedContextFieldType field_type,
3092788fa27SJeremy L Thompson                                                    size_t *num_values, void *value);
3102788fa27SJeremy L Thompson CEED_EXTERN int CeedQFunctionContextRestoreGenericRead(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, CeedContextFieldType field_type,
3112788fa27SJeremy L Thompson                                                        void *value);
3122b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextSetDouble(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, double *values);
3132788fa27SJeremy L Thompson CEED_EXTERN int CeedQFunctionContextGetDoubleRead(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, size_t *num_values,
3142788fa27SJeremy L Thompson                                                   const double **values);
3152788fa27SJeremy L Thompson CEED_EXTERN int CeedQFunctionContextRestoreDoubleRead(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, const double **values);
3162b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextSetInt32(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, int *values);
3172788fa27SJeremy L Thompson CEED_EXTERN int CeedQFunctionContextGetInt32Read(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, size_t *num_values, const int **values);
3182788fa27SJeremy L Thompson CEED_EXTERN int CeedQFunctionContextRestoreInt32Read(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, const int **values);
3192b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextGetDataDestroy(CeedQFunctionContext ctx, CeedMemType *f_mem_type, CeedQFunctionContextDataDestroyUser *f);
3209560d06aSjeremylt CEED_EXTERN int CeedQFunctionContextReference(CeedQFunctionContext ctx);
321ec3da8bcSJed Brown 
322480fae85SJeremy L Thompson CEED_EXTERN int CeedQFunctionAssemblyDataCreate(Ceed ceed, CeedQFunctionAssemblyData *data);
323480fae85SJeremy L Thompson CEED_EXTERN int CeedQFunctionAssemblyDataReference(CeedQFunctionAssemblyData data);
324beecbf24SJeremy L Thompson CEED_EXTERN int CeedQFunctionAssemblyDataSetReuse(CeedQFunctionAssemblyData data, bool reuse_assembly_data);
325beecbf24SJeremy L Thompson CEED_EXTERN int CeedQFunctionAssemblyDataSetUpdateNeeded(CeedQFunctionAssemblyData data, bool needs_data_update);
3268b919e6bSJeremy L Thompson CEED_EXTERN int CeedQFunctionAssemblyDataIsUpdateNeeded(CeedQFunctionAssemblyData data, bool *is_update_needed);
327480fae85SJeremy L Thompson CEED_EXTERN int CeedQFunctionAssemblyDataReferenceCopy(CeedQFunctionAssemblyData data, CeedQFunctionAssemblyData *data_copy);
328480fae85SJeremy L Thompson CEED_EXTERN int CeedQFunctionAssemblyDataIsSetup(CeedQFunctionAssemblyData data, bool *is_setup);
329480fae85SJeremy L Thompson CEED_EXTERN int CeedQFunctionAssemblyDataSetObjects(CeedQFunctionAssemblyData data, CeedVector vec, CeedElemRestriction rstr);
330480fae85SJeremy L Thompson CEED_EXTERN int CeedQFunctionAssemblyDataGetObjects(CeedQFunctionAssemblyData data, CeedVector *vec, CeedElemRestriction *rstr);
331480fae85SJeremy L Thompson CEED_EXTERN int CeedQFunctionAssemblyDataDestroy(CeedQFunctionAssemblyData *data);
332480fae85SJeremy L Thompson 
333ed9e99e6SJeremy L Thompson CEED_EXTERN int CeedOperatorAssemblyDataCreate(Ceed ceed, CeedOperator op, CeedOperatorAssemblyData *data);
334437c7c90SJeremy L Thompson CEED_EXTERN int CeedOperatorAssemblyDataGetEvalModes(CeedOperatorAssemblyData data, CeedInt *num_active_bases, CeedInt **num_eval_modes_in,
335437c7c90SJeremy L Thompson                                                      const CeedEvalMode ***eval_modes_in, CeedSize ***eval_mode_offsets_in,
336437c7c90SJeremy L Thompson                                                      CeedInt **num_eval_modes_out, const CeedEvalMode ***eval_modes_out,
337437c7c90SJeremy L Thompson                                                      CeedSize ***eval_mode_offsets_out, CeedSize *num_output_components);
338437c7c90SJeremy L Thompson CEED_EXTERN int CeedOperatorAssemblyDataGetBases(CeedOperatorAssemblyData data, CeedInt *num_active_bases, CeedBasis **active_bases,
339437c7c90SJeremy L Thompson                                                  const CeedScalar ***assembled_bases_in, const CeedScalar ***assembled_bases_out);
340437c7c90SJeremy L Thompson CEED_EXTERN int CeedOperatorAssemblyDataGetElemRestrictions(CeedOperatorAssemblyData data, CeedInt *num_active_elem_rstrs,
341437c7c90SJeremy L Thompson                                                             CeedElemRestriction **active_elem_rstrs);
342ed9e99e6SJeremy L Thompson CEED_EXTERN int CeedOperatorAssemblyDataDestroy(CeedOperatorAssemblyData *data);
343ed9e99e6SJeremy L Thompson 
344ed9e99e6SJeremy L Thompson CEED_EXTERN int CeedOperatorGetOperatorAssemblyData(CeedOperator op, CeedOperatorAssemblyData *data);
3452b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorGetActiveBasis(CeedOperator op, CeedBasis *active_basis);
346ed9e99e6SJeremy L Thompson CEED_EXTERN int CeedOperatorGetActiveElemRestriction(CeedOperator op, CeedElemRestriction *active_rstr);
347d1d35e2fSjeremylt CEED_EXTERN int CeedOperatorGetNumArgs(CeedOperator op, CeedInt *num_args);
348d1d35e2fSjeremylt CEED_EXTERN int CeedOperatorIsSetupDone(CeedOperator op, bool *is_setup_done);
349ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorGetQFunction(CeedOperator op, CeedQFunction *qf);
350d1d35e2fSjeremylt CEED_EXTERN int CeedOperatorIsComposite(CeedOperator op, bool *is_composite);
351ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorGetData(CeedOperator op, void *data);
352ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorSetData(CeedOperator op, void *data);
3539560d06aSjeremylt CEED_EXTERN int CeedOperatorReference(CeedOperator op);
354ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorSetSetupDone(CeedOperator op);
355ec3da8bcSJed Brown 
3562b730f8bSJeremy L Thompson CEED_INTERN int CeedMatrixMatrixMultiply(Ceed ceed, const CeedScalar *mat_A, const CeedScalar *mat_B, CeedScalar *mat_C, CeedInt m, CeedInt n,
3572b730f8bSJeremy L Thompson                                          CeedInt kk);
358ba59ac12SSebastian Grimberg CEED_EXTERN int CeedQRFactorization(Ceed ceed, CeedScalar *mat, CeedScalar *tau, CeedInt m, CeedInt n);
359ba59ac12SSebastian Grimberg CEED_EXTERN int CeedHouseholderApplyQ(CeedScalar *mat_A, const CeedScalar *mat_Q, const CeedScalar *tau, CeedTransposeMode t_mode, CeedInt m,
360ba59ac12SSebastian Grimberg                                       CeedInt n, CeedInt k, CeedInt row, CeedInt col);
361ba59ac12SSebastian Grimberg CEED_EXTERN int CeedSymmetricSchurDecomposition(Ceed ceed, CeedScalar *mat, CeedScalar *lambda, CeedInt n);
362ba59ac12SSebastian Grimberg CEED_EXTERN int CeedSimultaneousDiagonalization(Ceed ceed, CeedScalar *mat_A, CeedScalar *mat_B, CeedScalar *x, CeedScalar *lambda, CeedInt n);
363ec3da8bcSJed Brown 
364ec3da8bcSJed Brown #endif
365