xref: /libCEED/include/ceed/backend.h (revision 23dbfd29b85e94cc994238a4cc96ab82cd670d42)
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
1094b7b29bSJeremy L Thompson #ifndef CEED_BACKEND_H
1194b7b29bSJeremy L Thompson #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)
5558c07c4fSSebastian Grimberg #define CeedPragmaOptimizeOn _Pragma("optimize('', on)")
5603d18186Sjeremylt #else
5703d18186Sjeremylt #define CeedPragmaOptimizeOn
5803d18186Sjeremylt #endif
5903d18186Sjeremylt #endif
6003d18186Sjeremylt 
6158c07c4fSSebastian Grimberg /// This macro provides the appropriate OpenMP Pragmas for the compilation environment.
6258c07c4fSSebastian Grimberg /// @ingroup Ceed
6358c07c4fSSebastian Grimberg #ifndef CeedPragmaOMP
6458c07c4fSSebastian Grimberg #ifdef _OPENMP
6558c07c4fSSebastian Grimberg #define CeedPragmaOMPHelper(x) _Pragma(#x)
6658c07c4fSSebastian Grimberg #define CeedPragmaOMP(x) CeedPragmaOMPHelper(omp x)
6758c07c4fSSebastian Grimberg #else
6858c07c4fSSebastian Grimberg #define CeedPragmaOMP(x)
6958c07c4fSSebastian Grimberg #endif
7058c07c4fSSebastian Grimberg #endif
7158c07c4fSSebastian Grimberg #ifndef CeedPragmaAtomic
7258c07c4fSSebastian Grimberg #define CeedPragmaAtomic CeedPragmaOMP(atomic update)
7358c07c4fSSebastian Grimberg #endif
7458c07c4fSSebastian Grimberg #ifndef CeedPragmaCritical
7558c07c4fSSebastian Grimberg #define CeedPragmaCritical(x) CeedPragmaOMP(critical(x))
7658c07c4fSSebastian Grimberg #endif
7758c07c4fSSebastian Grimberg 
781f97d2f1SJeremy L Thompson /**
791f97d2f1SJeremy L Thompson   This enum supples common colors for CeedDebug256 debugging output.
801f97d2f1SJeremy L Thompson   Set the environment variable `CEED_DEBUG = 1` to activate debugging output.
811f97d2f1SJeremy L Thompson 
821f97d2f1SJeremy L Thompson   @ingroup Ceed
831f97d2f1SJeremy L Thompson   @ref     Backend
841f97d2f1SJeremy L Thompson **/
8523d4529eSJeremy L Thompson typedef enum {
8623d4529eSJeremy L Thompson   /// Success color
8723d4529eSJeremy L Thompson   CEED_DEBUG_COLOR_SUCCESS = 108,
8823d4529eSJeremy L Thompson   /// Warning color
8923d4529eSJeremy L Thompson   CEED_DEBUG_COLOR_WARNING = 208,
9023d4529eSJeremy L Thompson   /// Error color
9123d4529eSJeremy L Thompson   CEED_DEBUG_COLOR_ERROR = 196,
9223d4529eSJeremy L Thompson   /// Use native terminal coloring
9323d4529eSJeremy L Thompson   CEED_DEBUG_COLOR_NONE = 255,
9423d4529eSJeremy L Thompson } CeedDebugColor;
953f21f6b1SJeremy L Thompson 
963f21f6b1SJeremy L Thompson CEED_EXTERN void CeedDebugImpl256(const unsigned char, const char *, ...);
973f21f6b1SJeremy L Thompson CEED_EXTERN bool CeedDebugFlag(const Ceed ceed);
983f21f6b1SJeremy L Thompson CEED_EXTERN bool CeedDebugFlagEnv(void);
991f97d2f1SJeremy L Thompson /**
1001f97d2f1SJeremy L Thompson   Print debugging information in color
1011f97d2f1SJeremy L Thompson 
1021f97d2f1SJeremy L Thompson   @param[in] ceed  Ceed
1031f97d2f1SJeremy L Thompson   @param[in] color Color to print with
1041f97d2f1SJeremy L Thompson 
1051f97d2f1SJeremy L Thompson   @ingroup Ceed
1061f97d2f1SJeremy L Thompson   @ref     Backend
1071f97d2f1SJeremy L Thompson **/
1083f21f6b1SJeremy L Thompson #define CeedDebug256(ceed, color, ...)                               \
1092b730f8bSJeremy L Thompson   {                                                                  \
1102b730f8bSJeremy L Thompson     if (CeedDebugFlag(ceed)) CeedDebugImpl256(color, ##__VA_ARGS__); \
1112b730f8bSJeremy L Thompson   }
1121f97d2f1SJeremy L Thompson /**
1131f97d2f1SJeremy L Thompson   Print debugging information to terminal
1141f97d2f1SJeremy L Thompson 
1151f97d2f1SJeremy L Thompson   @param[in] ceed  Ceed
1161f97d2f1SJeremy L Thompson 
1171f97d2f1SJeremy L Thompson   @ingroup Ceed
1181f97d2f1SJeremy L Thompson   @ref     Backend
1191f97d2f1SJeremy L Thompson **/
1203f21f6b1SJeremy L Thompson #define CeedDebug(ceed, ...) CeedDebug256(ceed, (unsigned char)CEED_DEBUG_COLOR_NONE, ##__VA_ARGS__)
1211f97d2f1SJeremy L Thompson /**
1221f97d2f1SJeremy L Thompson   Print debugging information in color without Ceed to reference
1231f97d2f1SJeremy L Thompson 
1241f97d2f1SJeremy L Thompson   @param[in] color Color to print with
1251f97d2f1SJeremy L Thompson 
1261f97d2f1SJeremy L Thompson   @ingroup Ceed
1271f97d2f1SJeremy L Thompson   @ref     Backend
1281f97d2f1SJeremy L Thompson **/
1293f21f6b1SJeremy L Thompson #define CeedDebugEnv256(color, ...)                                 \
1302b730f8bSJeremy L Thompson   {                                                                 \
1312b730f8bSJeremy L Thompson     if (CeedDebugFlagEnv()) CeedDebugImpl256(color, ##__VA_ARGS__); \
1322b730f8bSJeremy L Thompson   }
1331f97d2f1SJeremy L Thompson /**
1341f97d2f1SJeremy L Thompson   Print debugging information to terminal without Ceed to reference
1351f97d2f1SJeremy L Thompson 
1361f97d2f1SJeremy L Thompson   @ingroup Ceed
1371f97d2f1SJeremy L Thompson   @ref     Backend
1381f97d2f1SJeremy L Thompson **/
1393f21f6b1SJeremy L Thompson #define CeedDebugEnv(...) CeedDebugEnv256((unsigned char)CEED_DEBUG_COLOR_NONE, ##__VA_ARGS__)
140aca496beSJeremy L Thompson /**
141aca496beSJeremy L Thompson   Print warning information in color
142aca496beSJeremy L Thompson 
143aca496beSJeremy L Thompson   @ingroup Ceed
144aca496beSJeremy L Thompson   @ref     Backend
145aca496beSJeremy L Thompson **/
146aca496beSJeremy L Thompson #define CeedWarn(...) \
147aca496beSJeremy L Thompson   { CeedDebugImpl256(CEED_DEBUG_COLOR_WARNING, ##__VA_ARGS__); }
148ec3da8bcSJed Brown 
1491c66c397SJeremy L Thompson /**
1501c66c397SJeremy L Thompson   Swap the values of two CeedScalars
1511c66c397SJeremy L Thompson 
1521c66c397SJeremy L Thompson   @param[in,out] a  First CeedScalar
1531c66c397SJeremy L Thompson   @param[in,out] b  Second CeedScalar
1541c66c397SJeremy L Thompson 
1551c66c397SJeremy L Thompson   @ingroup Ceed
1561c66c397SJeremy L Thompson   @ref     Backend
1571c66c397SJeremy L Thompson **/
1581c66c397SJeremy L Thompson #define CeedScalarSwap(a, b)        \
1591c66c397SJeremy L Thompson   {                                 \
1601c66c397SJeremy L Thompson     const CeedScalar temp_ = a;     \
1611c66c397SJeremy L Thompson     a                      = b;     \
1621c66c397SJeremy L Thompson     b                      = temp_; \
1631c66c397SJeremy L Thompson   }
1641c66c397SJeremy L Thompson 
165ec3da8bcSJed Brown /// Handle for object handling TensorContraction
166ec3da8bcSJed Brown /// @ingroup CeedBasis
167ec3da8bcSJed Brown typedef struct CeedTensorContract_private *CeedTensorContract;
168ec3da8bcSJed Brown 
169480fae85SJeremy L Thompson /// Handle for object handling assembled QFunction data
170480fae85SJeremy L Thompson /// @ingroup CeedOperator
171480fae85SJeremy L Thompson typedef struct CeedQFunctionAssemblyData_private *CeedQFunctionAssemblyData;
172480fae85SJeremy L Thompson 
173ed9e99e6SJeremy L Thompson /// Handle for object handling assembled Operator data
174ed9e99e6SJeremy L Thompson /// @ingroup CeedOperator
175ed9e99e6SJeremy L Thompson typedef struct CeedOperatorAssemblyData_private *CeedOperatorAssemblyData;
176ed9e99e6SJeremy L Thompson 
177ea61e9acSJeremy 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. */
178ec3da8bcSJed Brown CEED_INTERN int CeedMallocArray(size_t n, size_t unit, void *p);
179ec3da8bcSJed Brown CEED_INTERN int CeedCallocArray(size_t n, size_t unit, void *p);
180ec3da8bcSJed Brown CEED_INTERN int CeedReallocArray(size_t n, size_t unit, void *p);
181f7e22acaSJeremy L Thompson CEED_INTERN int CeedStringAllocCopy(const char *source, char **copy);
182ec3da8bcSJed Brown CEED_INTERN int CeedFree(void *p);
183ec3da8bcSJed Brown 
184d109957bSJeremy L Thompson /**
185d109957bSJeremy L Thompson   @brief Calls a libCEED function and then checks the resulting error code.
186d109957bSJeremy 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.
1872b730f8bSJeremy L Thompson 
188d109957bSJeremy L Thompson   @ref Developer
189d109957bSJeremy L Thompson **/
1902b730f8bSJeremy L Thompson #define CeedCall(...)        \
1912b730f8bSJeremy L Thompson   do {                       \
192d109957bSJeremy L Thompson     int ierr_ = __VA_ARGS__; \
193d109957bSJeremy L Thompson     if (ierr_) return ierr_; \
1940126412dSJeremy L Thompson   } while (0)
1952b730f8bSJeremy L Thompson 
196d109957bSJeremy L Thompson /**
197d109957bSJeremy L Thompson   @brief Calls a libCEED function and then checks the resulting error code.
198d109957bSJeremy 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.
199d109957bSJeremy L Thompson   All interface level error codes are upgraded to `CEED_ERROR_BACKEND`.
200d109957bSJeremy L Thompson 
201d109957bSJeremy L Thompson   @ref Developer
202d109957bSJeremy L Thompson **/
203d109957bSJeremy L Thompson #define CeedCallBackend(...)                                                     \
204d109957bSJeremy L Thompson   do {                                                                           \
205d109957bSJeremy L Thompson     int ierr_ = __VA_ARGS__;                                                     \
206d109957bSJeremy L Thompson     if (ierr_) return (ierr_ > CEED_ERROR_SUCCESS) ? CEED_ERROR_BACKEND : ierr_; \
207d109957bSJeremy L Thompson   } while (0)
208d109957bSJeremy L Thompson 
209d109957bSJeremy L Thompson /**
210d109957bSJeremy L Thompson   @brief Check that a particular condition is true and returns a `CeedError` if not.
211d109957bSJeremy L Thompson 
212d109957bSJeremy L Thompson   @ref Developer
213d109957bSJeremy L Thompson **/
2146574a04fSJeremy L Thompson #define CeedCheck(cond, ceed, ecode, ...)                    \
2156574a04fSJeremy L Thompson   do {                                                       \
216d109957bSJeremy L Thompson     if (!(cond)) return CeedError(ceed, ecode, __VA_ARGS__); \
2176574a04fSJeremy L Thompson   } while (0)
2186574a04fSJeremy L Thompson 
219d109957bSJeremy L Thompson /* Note - these are legacy macros that should be removed eventually */
220d109957bSJeremy L Thompson #define CeedChk(...) CeedCall(__VA_ARGS__)
221d109957bSJeremy L Thompson #define CeedChkBackend(...) CeedCallBackend(__VA_ARGS__)
222d109957bSJeremy L Thompson 
223ea61e9acSJeremy L Thompson /* Note that CeedMalloc and CeedCalloc will, generally, return pointers with different memory alignments:
224ea61e9acSJeremy L Thompson    CeedMalloc returns pointers aligned at CEED_ALIGN bytes, while CeedCalloc uses the alignment of calloc. */
225ec3da8bcSJed Brown #define CeedMalloc(n, p) CeedMallocArray((n), sizeof(**(p)), p)
226ec3da8bcSJed Brown #define CeedCalloc(n, p) CeedCallocArray((n), sizeof(**(p)), p)
227ec3da8bcSJed Brown #define CeedRealloc(n, p) CeedReallocArray((n), sizeof(**(p)), p)
228ec3da8bcSJed Brown 
2292b730f8bSJeremy L Thompson CEED_EXTERN int CeedRegister(const char *prefix, int (*init)(const char *, Ceed), unsigned int priority);
2302b730f8bSJeremy L Thompson CEED_EXTERN int CeedRegisterImpl(const char *prefix, int (*init)(const char *, Ceed), unsigned int priority);
231ec3da8bcSJed Brown 
232d1d35e2fSjeremylt CEED_EXTERN int CeedIsDebug(Ceed ceed, bool *is_debug);
233bc246734SJeremy L Thompson CEED_EXTERN int CeedGetResourceRoot(Ceed ceed, const char *resource, const char *delineator, char **resource_root);
234ec3da8bcSJed Brown CEED_EXTERN int CeedGetParent(Ceed ceed, Ceed *parent);
235ec3da8bcSJed Brown CEED_EXTERN int CeedGetDelegate(Ceed ceed, Ceed *delegate);
236ec3da8bcSJed Brown CEED_EXTERN int CeedSetDelegate(Ceed ceed, Ceed delegate);
2372b730f8bSJeremy L Thompson CEED_EXTERN int CeedGetObjectDelegate(Ceed ceed, Ceed *delegate, const char *obj_name);
2382b730f8bSJeremy L Thompson CEED_EXTERN int CeedSetObjectDelegate(Ceed ceed, Ceed delegate, const char *obj_name);
239363aefefSSebastian Grimberg CEED_EXTERN int CeedGetOperatorFallbackResource(Ceed ceed, const char **resource);
2408687e1d4SJeremy L Thompson CEED_EXTERN int CeedGetOperatorFallbackCeed(Ceed ceed, Ceed *fallback_ceed);
2412b730f8bSJeremy L Thompson CEED_EXTERN int CeedSetOperatorFallbackResource(Ceed ceed, const char *resource);
242d1d35e2fSjeremylt CEED_EXTERN int CeedSetDeterministic(Ceed ceed, bool is_deterministic);
2432b730f8bSJeremy L Thompson CEED_EXTERN int CeedSetBackendFunction(Ceed ceed, const char *type, void *object, const char *func_name, int (*f)());
244ec3da8bcSJed Brown CEED_EXTERN int CeedGetData(Ceed ceed, void *data);
245ec3da8bcSJed Brown CEED_EXTERN int CeedSetData(Ceed ceed, void *data);
2469560d06aSjeremylt CEED_EXTERN int CeedReference(Ceed ceed);
247ec3da8bcSJed Brown 
2489c774eddSJeremy L Thompson CEED_EXTERN int CeedVectorHasValidArray(CeedVector vec, bool *has_valid_array);
2492b730f8bSJeremy L Thompson CEED_EXTERN int CeedVectorHasBorrowedArrayOfType(CeedVector vec, CeedMemType mem_type, bool *has_borrowed_array_of_type);
2509c774eddSJeremy L Thompson CEED_EXTERN int CeedVectorHasValidArray(CeedVector vec, bool *has_valid_array);
251ec3da8bcSJed Brown CEED_EXTERN int CeedVectorGetState(CeedVector vec, uint64_t *state);
252ec3da8bcSJed Brown CEED_EXTERN int CeedVectorGetData(CeedVector vec, void *data);
253ec3da8bcSJed Brown CEED_EXTERN int CeedVectorSetData(CeedVector vec, void *data);
2549560d06aSjeremylt CEED_EXTERN int CeedVectorReference(CeedVector vec);
255ec3da8bcSJed Brown 
256fcbe8c06SSebastian Grimberg /// Type of element restriction;
257fcbe8c06SSebastian Grimberg /// @ingroup CeedElemRestriction
258fcbe8c06SSebastian Grimberg typedef enum {
25961a27d74SSebastian Grimberg   /// Standard element restriction with offsets
26061a27d74SSebastian Grimberg   CEED_RESTRICTION_STANDARD = 1,
261fcbe8c06SSebastian Grimberg   /// Oriented element restriction
262fcbe8c06SSebastian Grimberg   CEED_RESTRICTION_ORIENTED = 2,
263fcbe8c06SSebastian Grimberg   /// Curl-oriented element restriction
264fcbe8c06SSebastian Grimberg   CEED_RESTRICTION_CURL_ORIENTED = 3,
265fcbe8c06SSebastian Grimberg   /// Strided element restriction
266fcbe8c06SSebastian Grimberg   CEED_RESTRICTION_STRIDED = 4,
2673ac8f562SJeremy L Thompson   /// Point-in-cell element restriction
2683ac8f562SJeremy L Thompson   CEED_RESTRICTION_POINTS = 5,
269fcbe8c06SSebastian Grimberg } CeedRestrictionType;
270fcbe8c06SSebastian Grimberg 
271fcbe8c06SSebastian Grimberg CEED_EXTERN int CeedElemRestrictionGetType(CeedElemRestriction rstr, CeedRestrictionType *rstr_type);
27277d1c127SSebastian Grimberg CEED_EXTERN int CeedElemRestrictionIsStrided(CeedElemRestriction rstr, bool *is_strided);
2733ac8f562SJeremy L Thompson CEED_EXTERN int CeedElemRestrictionIsPoints(CeedElemRestriction rstr, bool *is_points);
2742b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionGetStrides(CeedElemRestriction rstr, CeedInt (*strides)[3]);
27577d1c127SSebastian Grimberg CEED_EXTERN int CeedElemRestrictionHasBackendStrides(CeedElemRestriction rstr, bool *has_backend_strides);
2762b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionGetOffsets(CeedElemRestriction rstr, CeedMemType mem_type, const CeedInt **offsets);
2772b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionRestoreOffsets(CeedElemRestriction rstr, const CeedInt **offsets);
27877d1c127SSebastian Grimberg CEED_EXTERN int CeedElemRestrictionGetOrientations(CeedElemRestriction rstr, CeedMemType mem_type, const bool **orients);
27977d1c127SSebastian Grimberg CEED_EXTERN int CeedElemRestrictionRestoreOrientations(CeedElemRestriction rstr, const bool **orients);
2800c73c039SSebastian Grimberg CEED_EXTERN int CeedElemRestrictionGetCurlOrientations(CeedElemRestriction rstr, CeedMemType mem_type, const CeedInt8 **curl_orients);
2810c73c039SSebastian Grimberg CEED_EXTERN int CeedElemRestrictionRestoreCurlOrientations(CeedElemRestriction rstr, const CeedInt8 **curl_orients);
2822b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionGetELayout(CeedElemRestriction rstr, CeedInt (*layout)[3]);
2832b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionSetELayout(CeedElemRestriction rstr, CeedInt layout[3]);
2842b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionGetData(CeedElemRestriction rstr, void *data);
2852b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionSetData(CeedElemRestriction rstr, void *data);
2869560d06aSjeremylt CEED_EXTERN int CeedElemRestrictionReference(CeedElemRestriction rstr);
2879d36ca50SJeremy L Thompson CEED_EXTERN int CeedElemRestrictionGetFlopsEstimate(CeedElemRestriction rstr, CeedTransposeMode t_mode, CeedSize *flops);
288ec3da8bcSJed Brown 
2896f117663SJeremy L Thompson /// Type of FE space;
2906f117663SJeremy L Thompson /// @ingroup CeedBasis
2916f117663SJeremy L Thompson typedef enum {
292c4e3f59bSSebastian Grimberg   /// H^1 FE space
2936f117663SJeremy L Thompson   CEED_FE_SPACE_H1 = 1,
2946f117663SJeremy L Thompson   /// H(div) FE space
2956f117663SJeremy L Thompson   CEED_FE_SPACE_HDIV = 2,
296c4e3f59bSSebastian Grimberg   /// H(curl) FE space
297c4e3f59bSSebastian Grimberg   CEED_FE_SPACE_HCURL = 3,
2986f117663SJeremy L Thompson } CeedFESpace;
2996f117663SJeremy L Thompson CEED_EXTERN const char *const CeedFESpaces[];
3006f117663SJeremy L Thompson 
3012b730f8bSJeremy L Thompson CEED_EXTERN int CeedBasisGetCollocatedGrad(CeedBasis basis, CeedScalar *colo_grad_1d);
302d1d35e2fSjeremylt CEED_EXTERN int CeedBasisIsTensor(CeedBasis basis, bool *is_tensor);
303ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetData(CeedBasis basis, void *data);
304ec3da8bcSJed Brown CEED_EXTERN int CeedBasisSetData(CeedBasis basis, void *data);
3059560d06aSjeremylt CEED_EXTERN int CeedBasisReference(CeedBasis basis);
306c4e3f59bSSebastian Grimberg CEED_EXTERN int CeedBasisGetNumQuadratureComponents(CeedBasis basis, CeedEvalMode eval_mode, CeedInt *q_comp);
3079d36ca50SJeremy L Thompson CEED_EXTERN int CeedBasisGetFlopsEstimate(CeedBasis basis, CeedTransposeMode t_mode, CeedEvalMode eval_mode, CeedSize *flops);
308c4e3f59bSSebastian Grimberg CEED_EXTERN int CeedBasisGetFESpace(CeedBasis basis, CeedFESpace *fe_space);
3092b730f8bSJeremy L Thompson CEED_EXTERN int CeedBasisGetTopologyDimension(CeedElemTopology topo, CeedInt *dim);
3102b730f8bSJeremy L Thompson CEED_EXTERN int CeedBasisGetTensorContract(CeedBasis basis, CeedTensorContract *contract);
3112b730f8bSJeremy L Thompson CEED_EXTERN int CeedBasisSetTensorContract(CeedBasis basis, CeedTensorContract contract);
312c4e3f59bSSebastian Grimberg 
313a71faab1SSebastian Grimberg CEED_EXTERN int CeedTensorContractCreate(Ceed ceed, CeedTensorContract *contract);
3142b730f8bSJeremy L Thompson CEED_EXTERN int CeedTensorContractApply(CeedTensorContract contract, CeedInt A, CeedInt B, CeedInt C, CeedInt J, const CeedScalar *__restrict__ t,
3152b730f8bSJeremy L Thompson                                         CeedTransposeMode t_mode, const CeedInt Add, const CeedScalar *__restrict__ u, CeedScalar *__restrict__ v);
316c4e3f59bSSebastian Grimberg CEED_EXTERN int CeedTensorContractStridedApply(CeedTensorContract contract, CeedInt A, CeedInt B, CeedInt C, CeedInt D, CeedInt J,
317c4e3f59bSSebastian Grimberg                                                const CeedScalar *__restrict__ t, CeedTransposeMode t_mode, const CeedInt add,
318c4e3f59bSSebastian Grimberg                                                const CeedScalar *__restrict__ u, CeedScalar *__restrict__ v);
3192b730f8bSJeremy L Thompson CEED_EXTERN int CeedTensorContractGetCeed(CeedTensorContract contract, Ceed *ceed);
3202b730f8bSJeremy L Thompson CEED_EXTERN int CeedTensorContractGetData(CeedTensorContract contract, void *data);
3212b730f8bSJeremy L Thompson CEED_EXTERN int CeedTensorContractSetData(CeedTensorContract contract, void *data);
3229560d06aSjeremylt CEED_EXTERN int CeedTensorContractReference(CeedTensorContract contract);
323585a562dSJeremy L Thompson CEED_EXTERN int CeedTensorContractReferenceCopy(CeedTensorContract tensor, CeedTensorContract *tensor_copy);
324ec3da8bcSJed Brown CEED_EXTERN int CeedTensorContractDestroy(CeedTensorContract *contract);
325ec3da8bcSJed Brown 
326509668d5SJeremy L Thompson CEED_EXTERN int CeedQFunctionRegister(const char *name, const char *source, CeedInt vec_length, CeedQFunctionUser f,
327509668d5SJeremy L Thompson                                       int (*init)(Ceed, const char *, CeedQFunction));
328ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionSetFortranStatus(CeedQFunction qf, bool status);
3292b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionGetVectorLength(CeedQFunction qf, CeedInt *vec_length);
3302b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionGetNumArgs(CeedQFunction qf, CeedInt *num_input_fields, CeedInt *num_output_fields);
33143e1b16fSJeremy L Thompson CEED_EXTERN int CeedQFunctionGetKernelName(CeedQFunction qf, char **kernel_name);
33243e1b16fSJeremy L Thompson CEED_EXTERN int CeedQFunctionGetSourcePath(CeedQFunction qf, char **source_path);
3333d3250a0SJeremy L Thompson CEED_EXTERN int CeedQFunctionLoadSourceToBuffer(CeedQFunction qf, char **source_buffer);
3342b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionGetUserFunction(CeedQFunction qf, CeedQFunctionUser *f);
3352b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionGetContext(CeedQFunction qf, CeedQFunctionContext *ctx);
336441428dfSJeremy L Thompson CEED_EXTERN int CeedQFunctionGetContextData(CeedQFunction qf, CeedMemType mem_type, void *data);
337441428dfSJeremy L Thompson CEED_EXTERN int CeedQFunctionRestoreContextData(CeedQFunction qf, void *data);
3382b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionGetInnerContext(CeedQFunction qf, CeedQFunctionContext *ctx);
339441428dfSJeremy L Thompson CEED_EXTERN int CeedQFunctionGetInnerContextData(CeedQFunction qf, CeedMemType mem_type, void *data);
340441428dfSJeremy L Thompson CEED_EXTERN int CeedQFunctionRestoreInnerContextData(CeedQFunction qf, void *data);
341d1d35e2fSjeremylt CEED_EXTERN int CeedQFunctionIsIdentity(CeedQFunction qf, bool *is_identity);
342441428dfSJeremy L Thompson CEED_EXTERN int CeedQFunctionIsContextWritable(CeedQFunction qf, bool *is_writable);
343ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionGetData(CeedQFunction qf, void *data);
344ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionSetData(CeedQFunction qf, void *data);
3459560d06aSjeremylt CEED_EXTERN int CeedQFunctionReference(CeedQFunction qf);
3469d36ca50SJeremy L Thompson CEED_EXTERN int CeedQFunctionGetFlopsEstimate(CeedQFunction qf, CeedSize *flops);
347ec3da8bcSJed Brown 
3482b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextGetCeed(CeedQFunctionContext ctx, Ceed *ceed);
3492b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextHasValidData(CeedQFunctionContext ctx, bool *has_valid_data);
3502b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextHasBorrowedDataOfType(CeedQFunctionContext ctx, CeedMemType mem_type, bool *has_borrowed_data_of_type);
3512b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextGetState(CeedQFunctionContext ctx, uint64_t *state);
3522b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextGetBackendData(CeedQFunctionContext ctx, void *data);
3532b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextSetBackendData(CeedQFunctionContext ctx, void *data);
3542b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextGetFieldLabel(CeedQFunctionContext ctx, const char *field_name, CeedContextFieldLabel *field_label);
3552b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextSetGeneric(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, CeedContextFieldType field_type,
3562b730f8bSJeremy L Thompson                                                void *value);
3572788fa27SJeremy L Thompson CEED_EXTERN int CeedQFunctionContextGetGenericRead(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, CeedContextFieldType field_type,
3582788fa27SJeremy L Thompson                                                    size_t *num_values, void *value);
3592788fa27SJeremy L Thompson CEED_EXTERN int CeedQFunctionContextRestoreGenericRead(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, CeedContextFieldType field_type,
3602788fa27SJeremy L Thompson                                                        void *value);
3612b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextSetDouble(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, double *values);
3622788fa27SJeremy L Thompson CEED_EXTERN int CeedQFunctionContextGetDoubleRead(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, size_t *num_values,
3632788fa27SJeremy L Thompson                                                   const double **values);
3642788fa27SJeremy L Thompson CEED_EXTERN int CeedQFunctionContextRestoreDoubleRead(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, const double **values);
365*23dbfd29SJeremy L Thompson CEED_EXTERN int CeedQFunctionContextSetInt32(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, int32_t *values);
366*23dbfd29SJeremy L Thompson CEED_EXTERN int CeedQFunctionContextGetInt32Read(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, size_t *num_values,
367*23dbfd29SJeremy L Thompson                                                  const int32_t **values);
368*23dbfd29SJeremy L Thompson CEED_EXTERN int CeedQFunctionContextRestoreInt32Read(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, const int32_t **values);
3695b6ec284SJeremy L Thompson CEED_EXTERN int CeedQFunctionContextSetBoolean(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, bool *values);
3705b6ec284SJeremy L Thompson CEED_EXTERN int CeedQFunctionContextGetBooleanRead(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, size_t *num_values,
3715b6ec284SJeremy L Thompson                                                    const bool **values);
3725b6ec284SJeremy L Thompson CEED_EXTERN int CeedQFunctionContextRestoreBooleanRead(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, const bool **values);
3732b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionContextGetDataDestroy(CeedQFunctionContext ctx, CeedMemType *f_mem_type, CeedQFunctionContextDataDestroyUser *f);
3749560d06aSjeremylt CEED_EXTERN int CeedQFunctionContextReference(CeedQFunctionContext ctx);
375ec3da8bcSJed Brown 
376506b1a0cSSebastian Grimberg CEED_EXTERN int CeedOperatorCreateActivePointBlockRestriction(CeedElemRestriction rstr, CeedElemRestriction *pointblock_rstr);
377480fae85SJeremy L Thompson CEED_EXTERN int CeedQFunctionAssemblyDataCreate(Ceed ceed, CeedQFunctionAssemblyData *data);
378480fae85SJeremy L Thompson CEED_EXTERN int CeedQFunctionAssemblyDataReference(CeedQFunctionAssemblyData data);
379beecbf24SJeremy L Thompson CEED_EXTERN int CeedQFunctionAssemblyDataSetReuse(CeedQFunctionAssemblyData data, bool reuse_assembly_data);
380beecbf24SJeremy L Thompson CEED_EXTERN int CeedQFunctionAssemblyDataSetUpdateNeeded(CeedQFunctionAssemblyData data, bool needs_data_update);
3818b919e6bSJeremy L Thompson CEED_EXTERN int CeedQFunctionAssemblyDataIsUpdateNeeded(CeedQFunctionAssemblyData data, bool *is_update_needed);
382480fae85SJeremy L Thompson CEED_EXTERN int CeedQFunctionAssemblyDataReferenceCopy(CeedQFunctionAssemblyData data, CeedQFunctionAssemblyData *data_copy);
383480fae85SJeremy L Thompson CEED_EXTERN int CeedQFunctionAssemblyDataIsSetup(CeedQFunctionAssemblyData data, bool *is_setup);
384480fae85SJeremy L Thompson CEED_EXTERN int CeedQFunctionAssemblyDataSetObjects(CeedQFunctionAssemblyData data, CeedVector vec, CeedElemRestriction rstr);
385480fae85SJeremy L Thompson CEED_EXTERN int CeedQFunctionAssemblyDataGetObjects(CeedQFunctionAssemblyData data, CeedVector *vec, CeedElemRestriction *rstr);
386480fae85SJeremy L Thompson CEED_EXTERN int CeedQFunctionAssemblyDataDestroy(CeedQFunctionAssemblyData *data);
387480fae85SJeremy L Thompson 
388ed9e99e6SJeremy L Thompson CEED_EXTERN int CeedOperatorAssemblyDataCreate(Ceed ceed, CeedOperator op, CeedOperatorAssemblyData *data);
389506b1a0cSSebastian Grimberg CEED_EXTERN int CeedOperatorAssemblyDataGetEvalModes(CeedOperatorAssemblyData data, CeedInt *num_active_bases_in, CeedInt **num_eval_modes_in,
390437c7c90SJeremy L Thompson                                                      const CeedEvalMode ***eval_modes_in, CeedSize ***eval_mode_offsets_in,
391506b1a0cSSebastian Grimberg                                                      CeedInt *num_active_bases_out, CeedInt **num_eval_modes_out,
392506b1a0cSSebastian Grimberg                                                      const CeedEvalMode ***eval_modes_out, CeedSize ***eval_mode_offsets_out,
393506b1a0cSSebastian Grimberg                                                      CeedSize *num_output_components);
394506b1a0cSSebastian Grimberg CEED_EXTERN int CeedOperatorAssemblyDataGetBases(CeedOperatorAssemblyData data, CeedInt *num_active_bases_in, CeedBasis **active_bases_in,
395506b1a0cSSebastian Grimberg                                                  const CeedScalar ***assembled_bases_in, CeedInt *num_active_bases_out, CeedBasis **active_bases_out,
396506b1a0cSSebastian Grimberg                                                  const CeedScalar ***assembled_bases_out);
397506b1a0cSSebastian Grimberg CEED_EXTERN int CeedOperatorAssemblyDataGetElemRestrictions(CeedOperatorAssemblyData data, CeedInt *num_active_elem_rstrs_in,
398506b1a0cSSebastian Grimberg                                                             CeedElemRestriction **active_elem_rstrs_in, CeedInt *num_active_elem_rstrs_out,
399506b1a0cSSebastian Grimberg                                                             CeedElemRestriction **active_elem_rstrs_out);
400ed9e99e6SJeremy L Thompson CEED_EXTERN int CeedOperatorAssemblyDataDestroy(CeedOperatorAssemblyData *data);
401ed9e99e6SJeremy L Thompson 
402ed9e99e6SJeremy L Thompson CEED_EXTERN int CeedOperatorGetOperatorAssemblyData(CeedOperator op, CeedOperatorAssemblyData *data);
4032b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorGetActiveBasis(CeedOperator op, CeedBasis *active_basis);
404506b1a0cSSebastian Grimberg CEED_EXTERN int CeedOperatorGetActiveBases(CeedOperator op, CeedBasis *active_input_basis, CeedBasis *active_output_basis);
405ed9e99e6SJeremy L Thompson CEED_EXTERN int CeedOperatorGetActiveElemRestriction(CeedOperator op, CeedElemRestriction *active_rstr);
406506b1a0cSSebastian Grimberg CEED_EXTERN int CeedOperatorGetActiveElemRestrictions(CeedOperator op, CeedElemRestriction *active_input_rstr,
407506b1a0cSSebastian Grimberg                                                       CeedElemRestriction *active_output_rstr);
408d1d35e2fSjeremylt CEED_EXTERN int CeedOperatorGetNumArgs(CeedOperator op, CeedInt *num_args);
409d1d35e2fSjeremylt CEED_EXTERN int CeedOperatorIsSetupDone(CeedOperator op, bool *is_setup_done);
410ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorGetQFunction(CeedOperator op, CeedQFunction *qf);
411d1d35e2fSjeremylt CEED_EXTERN int CeedOperatorIsComposite(CeedOperator op, bool *is_composite);
412ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorGetData(CeedOperator op, void *data);
413ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorSetData(CeedOperator op, void *data);
4149560d06aSjeremylt CEED_EXTERN int CeedOperatorReference(CeedOperator op);
415bb229da9SJeremy L Thompson CEED_EXTERN int CeedOperatorGetFallback(CeedOperator op, CeedOperator *op_fallback);
416bb229da9SJeremy L Thompson CEED_EXTERN int CeedOperatorGetFallbackParent(CeedOperator op, CeedOperator *parent);
417bb229da9SJeremy L Thompson CEED_EXTERN int CeedOperatorGetFallbackParentCeed(CeedOperator op, Ceed *parent);
418ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorSetSetupDone(CeedOperator op);
419ec3da8bcSJed Brown 
4202b730f8bSJeremy L Thompson CEED_INTERN int CeedMatrixMatrixMultiply(Ceed ceed, const CeedScalar *mat_A, const CeedScalar *mat_B, CeedScalar *mat_C, CeedInt m, CeedInt n,
4212b730f8bSJeremy L Thompson                                          CeedInt kk);
422ba59ac12SSebastian Grimberg CEED_EXTERN int CeedQRFactorization(Ceed ceed, CeedScalar *mat, CeedScalar *tau, CeedInt m, CeedInt n);
423ba59ac12SSebastian Grimberg CEED_EXTERN int CeedHouseholderApplyQ(CeedScalar *mat_A, const CeedScalar *mat_Q, const CeedScalar *tau, CeedTransposeMode t_mode, CeedInt m,
424ba59ac12SSebastian Grimberg                                       CeedInt n, CeedInt k, CeedInt row, CeedInt col);
425ba59ac12SSebastian Grimberg CEED_EXTERN int CeedSymmetricSchurDecomposition(Ceed ceed, CeedScalar *mat, CeedScalar *lambda, CeedInt n);
426ba59ac12SSebastian Grimberg CEED_EXTERN int CeedSimultaneousDiagonalization(Ceed ceed, CeedScalar *mat_A, CeedScalar *mat_B, CeedScalar *x, CeedScalar *lambda, CeedInt n);
427ec3da8bcSJed Brown 
42894b7b29bSJeremy L Thompson #endif  // CEED_BACKEND_H
429