xref: /libCEED/include/ceed/backend.h (revision ff1bc20e5f1db9421803faf3e8c80e7a5d10bee0)
15aed82e4SJeremy L Thompson // Copyright (c) 2017-2024, 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
10a844dea2SJeremy L Thompson #pragma once
11ec3da8bcSJed Brown 
1249aac155SJeremy L Thompson #include <ceed.h>
13d0c91ce9Sjeremylt #include <limits.h>
14ec3da8bcSJed Brown #include <stdbool.h>
15ec3da8bcSJed Brown 
162b730f8bSJeremy L Thompson #if defined(__clang_analyzer__)
172b730f8bSJeremy L Thompson #define CEED_INTERN
182b730f8bSJeremy L Thompson #elif defined(__cplusplus)
193b271f31SJed Brown #define CEED_INTERN extern "C" CEED_VISIBILITY(hidden)
203b271f31SJed Brown #else
213b271f31SJed Brown #define CEED_INTERN extern CEED_VISIBILITY(hidden)
223b271f31SJed Brown #endif
233b271f31SJed Brown 
24ec3da8bcSJed Brown #define CEED_UNUSED __attribute__((unused))
25ec3da8bcSJed Brown 
26ec3da8bcSJed Brown #define CEED_MAX_RESOURCE_LEN 1024
27d0c91ce9Sjeremylt #define CEED_MAX_BACKEND_PRIORITY UINT_MAX
28ec3da8bcSJed Brown #define CEED_ALIGN 64
29ec3da8bcSJed Brown #define CEED_COMPOSITE_MAX 16
30bf4cb664SJeremy L Thompson #define CEED_FIELD_MAX 16
31ec3da8bcSJed Brown 
3203d18186Sjeremylt #ifndef CeedPragmaOptimizeOff
3303d18186Sjeremylt #if defined(__clang__)
341f97d2f1SJeremy L Thompson /// This macro provides the ability to disable optimization flags for functions that are sensitive to floating point optimizations.
351f97d2f1SJeremy L Thompson /// @ingroup Ceed
3603d18186Sjeremylt #define CeedPragmaOptimizeOff _Pragma("clang optimize off")
3703d18186Sjeremylt #elif defined(__GNUC__)
3803d18186Sjeremylt #define CeedPragmaOptimizeOff _Pragma("GCC push_options") _Pragma("GCC optimize 0")
3903d18186Sjeremylt #elif defined(__INTEL_COMPILER) || defined(__INTEL_LLVM_COMPILER)
4003d18186Sjeremylt #define CeedPragmaOptimizeOff _Pragma("optimize('', off)")
4103d18186Sjeremylt #else
4203d18186Sjeremylt #define CeedPragmaOptimizeOff
4303d18186Sjeremylt #endif
4403d18186Sjeremylt #endif
4503d18186Sjeremylt 
4603d18186Sjeremylt #ifndef CeedPragmaOptimizeOn
4703d18186Sjeremylt #if defined(__clang__)
481f97d2f1SJeremy L Thompson /// This macro restores previously set optimization flags after CeedPragmaOptimizeOff.
491f97d2f1SJeremy L Thompson /// @ingroup Ceed
5003d18186Sjeremylt #define CeedPragmaOptimizeOn _Pragma("clang optimize on")
5103d18186Sjeremylt #elif defined(__GNUC__)
5203d18186Sjeremylt #define CeedPragmaOptimizeOn _Pragma("GCC pop_options")
5303d18186Sjeremylt #elif defined(__INTEL_COMPILER) || defined(__INTEL_LLVM_COMPILER)
5458c07c4fSSebastian Grimberg #define CeedPragmaOptimizeOn _Pragma("optimize('', on)")
5503d18186Sjeremylt #else
5603d18186Sjeremylt #define CeedPragmaOptimizeOn
5703d18186Sjeremylt #endif
5803d18186Sjeremylt #endif
5903d18186Sjeremylt 
6058c07c4fSSebastian Grimberg /// This macro provides the appropriate OpenMP Pragmas for the compilation environment.
6158c07c4fSSebastian Grimberg /// @ingroup Ceed
6258c07c4fSSebastian Grimberg #ifndef CeedPragmaOMP
6358c07c4fSSebastian Grimberg #ifdef _OPENMP
6458c07c4fSSebastian Grimberg #define CeedPragmaOMPHelper(x) _Pragma(#x)
6558c07c4fSSebastian Grimberg #define CeedPragmaOMP(x) CeedPragmaOMPHelper(omp x)
6658c07c4fSSebastian Grimberg #else
6758c07c4fSSebastian Grimberg #define CeedPragmaOMP(x)
6858c07c4fSSebastian Grimberg #endif
6958c07c4fSSebastian Grimberg #endif
7058c07c4fSSebastian Grimberg #ifndef CeedPragmaAtomic
7158c07c4fSSebastian Grimberg #define CeedPragmaAtomic CeedPragmaOMP(atomic update)
7258c07c4fSSebastian Grimberg #endif
7358c07c4fSSebastian Grimberg #ifndef CeedPragmaCritical
7458c07c4fSSebastian Grimberg #define CeedPragmaCritical(x) CeedPragmaOMP(critical(x))
7558c07c4fSSebastian Grimberg #endif
7658c07c4fSSebastian Grimberg 
771f97d2f1SJeremy L Thompson /**
781f97d2f1SJeremy L Thompson   This enum supples common colors for CeedDebug256 debugging output.
791f97d2f1SJeremy L Thompson   Set the environment variable `CEED_DEBUG = 1` to activate debugging output.
801f97d2f1SJeremy L Thompson 
811f97d2f1SJeremy L Thompson   @ingroup Ceed
821f97d2f1SJeremy L Thompson   @ref     Backend
831f97d2f1SJeremy L Thompson **/
8423d4529eSJeremy L Thompson typedef enum {
8523d4529eSJeremy L Thompson   /// Success color
8623d4529eSJeremy L Thompson   CEED_DEBUG_COLOR_SUCCESS = 108,
8723d4529eSJeremy L Thompson   /// Warning color
8823d4529eSJeremy L Thompson   CEED_DEBUG_COLOR_WARNING = 208,
8923d4529eSJeremy L Thompson   /// Error color
9023d4529eSJeremy L Thompson   CEED_DEBUG_COLOR_ERROR = 196,
9123d4529eSJeremy L Thompson   /// Use native terminal coloring
9223d4529eSJeremy L Thompson   CEED_DEBUG_COLOR_NONE = 255,
9323d4529eSJeremy L Thompson } CeedDebugColor;
943f21f6b1SJeremy L Thompson 
953f21f6b1SJeremy L Thompson CEED_EXTERN void CeedDebugImpl256(const unsigned char, const char *, ...);
963f21f6b1SJeremy L Thompson CEED_EXTERN bool CeedDebugFlag(const Ceed ceed);
973f21f6b1SJeremy L Thompson CEED_EXTERN bool CeedDebugFlagEnv(void);
981f97d2f1SJeremy L Thompson /**
991f97d2f1SJeremy L Thompson   Print debugging information in color
1001f97d2f1SJeremy L Thompson 
1011f97d2f1SJeremy L Thompson   @param[in] ceed  Ceed
1021f97d2f1SJeremy L Thompson   @param[in] color Color to print with
1031f97d2f1SJeremy L Thompson 
1041f97d2f1SJeremy L Thompson   @ingroup Ceed
1051f97d2f1SJeremy L Thompson   @ref     Backend
1061f97d2f1SJeremy L Thompson **/
1073f21f6b1SJeremy L Thompson #define CeedDebug256(ceed, color, ...)                               \
1082b730f8bSJeremy L Thompson   {                                                                  \
1092b730f8bSJeremy L Thompson     if (CeedDebugFlag(ceed)) CeedDebugImpl256(color, ##__VA_ARGS__); \
1102b730f8bSJeremy L Thompson   }
1111f97d2f1SJeremy L Thompson /**
1121f97d2f1SJeremy L Thompson   Print debugging information to terminal
1131f97d2f1SJeremy L Thompson 
1141f97d2f1SJeremy L Thompson   @param[in] ceed  Ceed
1151f97d2f1SJeremy L Thompson 
1161f97d2f1SJeremy L Thompson   @ingroup Ceed
1171f97d2f1SJeremy L Thompson   @ref     Backend
1181f97d2f1SJeremy L Thompson **/
1193f21f6b1SJeremy L Thompson #define CeedDebug(ceed, ...) CeedDebug256(ceed, (unsigned char)CEED_DEBUG_COLOR_NONE, ##__VA_ARGS__)
1201f97d2f1SJeremy L Thompson /**
1211f97d2f1SJeremy L Thompson   Print debugging information in color without Ceed to reference
1221f97d2f1SJeremy L Thompson 
1231f97d2f1SJeremy L Thompson   @param[in] color Color to print with
1241f97d2f1SJeremy L Thompson 
1251f97d2f1SJeremy L Thompson   @ingroup Ceed
1261f97d2f1SJeremy L Thompson   @ref     Backend
1271f97d2f1SJeremy L Thompson **/
1283f21f6b1SJeremy L Thompson #define CeedDebugEnv256(color, ...)                                 \
1292b730f8bSJeremy L Thompson   {                                                                 \
1302b730f8bSJeremy L Thompson     if (CeedDebugFlagEnv()) CeedDebugImpl256(color, ##__VA_ARGS__); \
1312b730f8bSJeremy L Thompson   }
1321f97d2f1SJeremy L Thompson /**
1331f97d2f1SJeremy L Thompson   Print debugging information to terminal without Ceed to reference
1341f97d2f1SJeremy L Thompson 
1351f97d2f1SJeremy L Thompson   @ingroup Ceed
1361f97d2f1SJeremy L Thompson   @ref     Backend
1371f97d2f1SJeremy L Thompson **/
1383f21f6b1SJeremy L Thompson #define CeedDebugEnv(...) CeedDebugEnv256((unsigned char)CEED_DEBUG_COLOR_NONE, ##__VA_ARGS__)
139aca496beSJeremy L Thompson /**
140aca496beSJeremy L Thompson   Print warning information in color
141aca496beSJeremy L Thompson 
142aca496beSJeremy L Thompson   @ingroup Ceed
143aca496beSJeremy L Thompson   @ref     Backend
144aca496beSJeremy L Thompson **/
145aca496beSJeremy L Thompson #define CeedWarn(...) \
146aca496beSJeremy L Thompson   { CeedDebugImpl256(CEED_DEBUG_COLOR_WARNING, ##__VA_ARGS__); }
147ec3da8bcSJed Brown 
1481c66c397SJeremy L Thompson /**
1491c66c397SJeremy L Thompson   Swap the values of two CeedScalars
1501c66c397SJeremy L Thompson 
1511c66c397SJeremy L Thompson   @param[in,out] a  First CeedScalar
1521c66c397SJeremy L Thompson   @param[in,out] b  Second CeedScalar
1531c66c397SJeremy L Thompson 
1541c66c397SJeremy L Thompson   @ingroup Ceed
1551c66c397SJeremy L Thompson   @ref     Backend
1561c66c397SJeremy L Thompson **/
1571c66c397SJeremy L Thompson #define CeedScalarSwap(a, b)        \
1581c66c397SJeremy L Thompson   {                                 \
1591c66c397SJeremy L Thompson     const CeedScalar temp_ = a;     \
1601c66c397SJeremy L Thompson     a                      = b;     \
1611c66c397SJeremy L Thompson     b                      = temp_; \
1621c66c397SJeremy L Thompson   }
1631c66c397SJeremy L Thompson 
164ec3da8bcSJed Brown /// Handle for object handling TensorContraction
165ec3da8bcSJed Brown /// @ingroup CeedBasis
166ec3da8bcSJed Brown typedef struct CeedTensorContract_private *CeedTensorContract;
167ec3da8bcSJed Brown 
168480fae85SJeremy L Thompson /// Handle for object handling assembled QFunction data
169480fae85SJeremy L Thompson /// @ingroup CeedOperator
170480fae85SJeremy L Thompson typedef struct CeedQFunctionAssemblyData_private *CeedQFunctionAssemblyData;
171480fae85SJeremy L Thompson 
172ed9e99e6SJeremy L Thompson /// Handle for object handling assembled Operator data
173ed9e99e6SJeremy L Thompson /// @ingroup CeedOperator
174ed9e99e6SJeremy L Thompson typedef struct CeedOperatorAssemblyData_private *CeedOperatorAssemblyData;
175ed9e99e6SJeremy L Thompson 
176ea61e9acSJeremy 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. */
177ec3da8bcSJed Brown CEED_INTERN int CeedMallocArray(size_t n, size_t unit, void *p);
178ec3da8bcSJed Brown CEED_INTERN int CeedCallocArray(size_t n, size_t unit, void *p);
179ec3da8bcSJed Brown CEED_INTERN int CeedReallocArray(size_t n, size_t unit, void *p);
180f7e22acaSJeremy L Thompson CEED_INTERN int CeedStringAllocCopy(const char *source, char **copy);
181ec3da8bcSJed Brown CEED_INTERN int CeedFree(void *p);
182ec3da8bcSJed Brown 
183f5d1e504SJeremy L Thompson CEED_INTERN int CeedSetHostBoolArray(const bool *source_array, CeedCopyMode copy_mode, CeedSize num_values, const bool **target_array_owned,
184f5d1e504SJeremy L Thompson                                      const bool **target_array_borrowed, const bool **target_array);
185f5d1e504SJeremy L Thompson CEED_INTERN int CeedSetHostCeedInt8Array(const CeedInt8 *source_array, CeedCopyMode copy_mode, CeedSize num_values,
186f5d1e504SJeremy L Thompson                                          const CeedInt8 **target_array_owned, const CeedInt8 **target_array_borrowed, const CeedInt8 **target_array);
187f5d1e504SJeremy L Thompson CEED_INTERN int CeedSetHostCeedIntArray(const CeedInt *source_array, CeedCopyMode copy_mode, CeedSize num_values, const CeedInt **target_array_owned,
188f5d1e504SJeremy L Thompson                                         const CeedInt **target_array_borrowed, const CeedInt **target_array);
189f5d1e504SJeremy L Thompson CEED_INTERN int CeedSetHostCeedScalarArray(const CeedScalar *source_array, CeedCopyMode copy_mode, CeedSize num_values,
190f5d1e504SJeremy L Thompson                                            const CeedScalar **target_array_owned, const CeedScalar **target_array_borrowed,
191f5d1e504SJeremy L Thompson                                            const CeedScalar **target_array);
192f5d1e504SJeremy L Thompson 
193d109957bSJeremy L Thompson /**
194d109957bSJeremy L Thompson   @brief Calls a libCEED function and then checks the resulting error code.
195d109957bSJeremy 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.
1962b730f8bSJeremy L Thompson 
197d109957bSJeremy L Thompson   @ref Developer
198d109957bSJeremy L Thompson **/
1992b730f8bSJeremy L Thompson #define CeedCall(...)        \
2002b730f8bSJeremy L Thompson   do {                       \
201d109957bSJeremy L Thompson     int ierr_ = __VA_ARGS__; \
202d109957bSJeremy L Thompson     if (ierr_) return ierr_; \
2030126412dSJeremy L Thompson   } while (0)
2042b730f8bSJeremy L Thompson 
205d109957bSJeremy L Thompson /**
206d109957bSJeremy L Thompson   @brief Calls a libCEED function and then checks the resulting error code.
207d109957bSJeremy 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.
208d109957bSJeremy L Thompson   All interface level error codes are upgraded to `CEED_ERROR_BACKEND`.
209d109957bSJeremy L Thompson 
210d109957bSJeremy L Thompson   @ref Developer
211d109957bSJeremy L Thompson **/
212d109957bSJeremy L Thompson #define CeedCallBackend(...)                                                     \
213d109957bSJeremy L Thompson   do {                                                                           \
214d109957bSJeremy L Thompson     int ierr_ = __VA_ARGS__;                                                     \
215d109957bSJeremy L Thompson     if (ierr_) return (ierr_ > CEED_ERROR_SUCCESS) ? CEED_ERROR_BACKEND : ierr_; \
216d109957bSJeremy L Thompson   } while (0)
217d109957bSJeremy L Thompson 
218d109957bSJeremy L Thompson /**
219d109957bSJeremy L Thompson   @brief Check that a particular condition is true and returns a `CeedError` if not.
220d109957bSJeremy L Thompson 
221d109957bSJeremy L Thompson   @ref Developer
222d109957bSJeremy L Thompson **/
2236574a04fSJeremy L Thompson #define CeedCheck(cond, ceed, ecode, ...)                    \
2246574a04fSJeremy L Thompson   do {                                                       \
225d109957bSJeremy L Thompson     if (!(cond)) return CeedError(ceed, ecode, __VA_ARGS__); \
2266574a04fSJeremy L Thompson   } while (0)
2276574a04fSJeremy L Thompson 
228ea61e9acSJeremy L Thompson /* Note that CeedMalloc and CeedCalloc will, generally, return pointers with different memory alignments:
229ea61e9acSJeremy L Thompson    CeedMalloc returns pointers aligned at CEED_ALIGN bytes, while CeedCalloc uses the alignment of calloc. */
230ec3da8bcSJed Brown #define CeedMalloc(n, p) CeedMallocArray((n), sizeof(**(p)), p)
231ec3da8bcSJed Brown #define CeedCalloc(n, p) CeedCallocArray((n), sizeof(**(p)), p)
232ec3da8bcSJed Brown #define CeedRealloc(n, p) CeedReallocArray((n), sizeof(**(p)), p)
233ec3da8bcSJed Brown 
2346a8ec7bdSSebastian Grimberg /* Allows calling CeedSetBackendFunctionImpl using incompatible pointer types */
235897d4737SSebastian Grimberg #define CeedSetBackendFunction(ceed, type, object, func_name, f) CeedSetBackendFunctionImpl(ceed, type, object, func_name, (void (*)(void))f)
236360501f4SSebastian Grimberg 
2372b730f8bSJeremy L Thompson CEED_EXTERN int CeedRegister(const char *prefix, int (*init)(const char *, Ceed), unsigned int priority);
2382b730f8bSJeremy L Thompson CEED_EXTERN int CeedRegisterImpl(const char *prefix, int (*init)(const char *, Ceed), unsigned int priority);
239ec3da8bcSJed Brown 
240d1d35e2fSjeremylt CEED_EXTERN int CeedIsDebug(Ceed ceed, bool *is_debug);
241bc246734SJeremy L Thompson CEED_EXTERN int CeedGetResourceRoot(Ceed ceed, const char *resource, const char *delineator, char **resource_root);
242ec3da8bcSJed Brown CEED_EXTERN int CeedGetParent(Ceed ceed, Ceed *parent);
243ec3da8bcSJed Brown CEED_EXTERN int CeedGetDelegate(Ceed ceed, Ceed *delegate);
244ec3da8bcSJed Brown CEED_EXTERN int CeedSetDelegate(Ceed ceed, Ceed delegate);
2452b730f8bSJeremy L Thompson CEED_EXTERN int CeedGetObjectDelegate(Ceed ceed, Ceed *delegate, const char *obj_name);
2462b730f8bSJeremy L Thompson CEED_EXTERN int CeedSetObjectDelegate(Ceed ceed, Ceed delegate, const char *obj_name);
247363aefefSSebastian Grimberg CEED_EXTERN int CeedGetOperatorFallbackResource(Ceed ceed, const char **resource);
2488687e1d4SJeremy L Thompson CEED_EXTERN int CeedGetOperatorFallbackCeed(Ceed ceed, Ceed *fallback_ceed);
2492b730f8bSJeremy L Thompson CEED_EXTERN int CeedSetOperatorFallbackResource(Ceed ceed, const char *resource);
250d1d35e2fSjeremylt CEED_EXTERN int CeedSetDeterministic(Ceed ceed, bool is_deterministic);
251897d4737SSebastian Grimberg CEED_EXTERN int CeedSetBackendFunctionImpl(Ceed ceed, const char *type, void *object, const char *func_name, void (*f)(void));
252ec3da8bcSJed Brown CEED_EXTERN int CeedGetData(Ceed ceed, void *data);
253ec3da8bcSJed Brown CEED_EXTERN int CeedSetData(Ceed ceed, void *data);
2549560d06aSjeremylt CEED_EXTERN int CeedReference(Ceed ceed);
255ec3da8bcSJed Brown 
2569c774eddSJeremy L Thompson CEED_EXTERN int CeedVectorHasValidArray(CeedVector vec, bool *has_valid_array);
2572b730f8bSJeremy L Thompson CEED_EXTERN int CeedVectorHasBorrowedArrayOfType(CeedVector vec, CeedMemType mem_type, bool *has_borrowed_array_of_type);
2589c774eddSJeremy L Thompson CEED_EXTERN int CeedVectorHasValidArray(CeedVector vec, bool *has_valid_array);
259ec3da8bcSJed Brown CEED_EXTERN int CeedVectorGetState(CeedVector vec, uint64_t *state);
260ec3da8bcSJed Brown CEED_EXTERN int CeedVectorGetData(CeedVector vec, void *data);
261ec3da8bcSJed Brown CEED_EXTERN int CeedVectorSetData(CeedVector vec, void *data);
2629560d06aSjeremylt CEED_EXTERN int CeedVectorReference(CeedVector vec);
263ec3da8bcSJed Brown 
264fcbe8c06SSebastian Grimberg /// Type of element restriction;
265fcbe8c06SSebastian Grimberg /// @ingroup CeedElemRestriction
266fcbe8c06SSebastian Grimberg typedef enum {
26761a27d74SSebastian Grimberg   /// Standard element restriction with offsets
26861a27d74SSebastian Grimberg   CEED_RESTRICTION_STANDARD = 1,
269fcbe8c06SSebastian Grimberg   /// Oriented element restriction
270fcbe8c06SSebastian Grimberg   CEED_RESTRICTION_ORIENTED = 2,
271fcbe8c06SSebastian Grimberg   /// Curl-oriented element restriction
272fcbe8c06SSebastian Grimberg   CEED_RESTRICTION_CURL_ORIENTED = 3,
273fcbe8c06SSebastian Grimberg   /// Strided element restriction
274fcbe8c06SSebastian Grimberg   CEED_RESTRICTION_STRIDED = 4,
2753ac8f562SJeremy L Thompson   /// Point-in-cell element restriction
2763ac8f562SJeremy L Thompson   CEED_RESTRICTION_POINTS = 5,
277fcbe8c06SSebastian Grimberg } CeedRestrictionType;
278fcbe8c06SSebastian Grimberg 
279fcbe8c06SSebastian Grimberg CEED_EXTERN int CeedElemRestrictionGetType(CeedElemRestriction rstr, CeedRestrictionType *rstr_type);
28077d1c127SSebastian Grimberg CEED_EXTERN int CeedElemRestrictionIsStrided(CeedElemRestriction rstr, bool *is_strided);
2813ac8f562SJeremy L Thompson CEED_EXTERN int CeedElemRestrictionIsPoints(CeedElemRestriction rstr, bool *is_points);
28248acf710SJeremy L Thompson CEED_EXTERN int CeedElemRestrictionAtPointsAreCompatible(CeedElemRestriction rstr_a, CeedElemRestriction rstr_b, bool *are_compatible);
28356c48462SJeremy L Thompson CEED_EXTERN int CeedElemRestrictionGetStrides(CeedElemRestriction rstr, CeedInt strides[3]);
28477d1c127SSebastian Grimberg CEED_EXTERN int CeedElemRestrictionHasBackendStrides(CeedElemRestriction rstr, bool *has_backend_strides);
2852b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionGetOffsets(CeedElemRestriction rstr, CeedMemType mem_type, const CeedInt **offsets);
2862b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionRestoreOffsets(CeedElemRestriction rstr, const CeedInt **offsets);
28777d1c127SSebastian Grimberg CEED_EXTERN int CeedElemRestrictionGetOrientations(CeedElemRestriction rstr, CeedMemType mem_type, const bool **orients);
28877d1c127SSebastian Grimberg CEED_EXTERN int CeedElemRestrictionRestoreOrientations(CeedElemRestriction rstr, const bool **orients);
2890c73c039SSebastian Grimberg CEED_EXTERN int CeedElemRestrictionGetCurlOrientations(CeedElemRestriction rstr, CeedMemType mem_type, const CeedInt8 **curl_orients);
2900c73c039SSebastian Grimberg CEED_EXTERN int CeedElemRestrictionRestoreCurlOrientations(CeedElemRestriction rstr, const CeedInt8 **curl_orients);
29156c48462SJeremy L Thompson CEED_EXTERN int CeedElemRestrictionGetLLayout(CeedElemRestriction rstr, CeedInt layout[3]);
29222eb1385SJeremy L Thompson CEED_EXTERN int CeedElemRestrictionSetLLayout(CeedElemRestriction rstr, CeedInt layout[3]);
29356c48462SJeremy L Thompson CEED_EXTERN int CeedElemRestrictionGetELayout(CeedElemRestriction rstr, CeedInt layout[3]);
2942b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionSetELayout(CeedElemRestriction rstr, CeedInt layout[3]);
29519605835SJeremy L Thompson CEED_EXTERN int CeedElemRestrictionGetAtPointsElementOffset(CeedElemRestriction rstr, CeedInt elem, CeedSize *elem_offset);
296*ff1bc20eSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionSetAtPointsEVectorSize(CeedElemRestriction rstr, CeedSize e_size);
2972b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionGetData(CeedElemRestriction rstr, void *data);
2982b730f8bSJeremy L Thompson CEED_EXTERN int CeedElemRestrictionSetData(CeedElemRestriction rstr, void *data);
2999560d06aSjeremylt CEED_EXTERN int CeedElemRestrictionReference(CeedElemRestriction rstr);
3009d36ca50SJeremy L Thompson CEED_EXTERN int CeedElemRestrictionGetFlopsEstimate(CeedElemRestriction rstr, CeedTransposeMode t_mode, CeedSize *flops);
301ec3da8bcSJed Brown 
3026f117663SJeremy L Thompson /// Type of FE space;
3036f117663SJeremy L Thompson /// @ingroup CeedBasis
3046f117663SJeremy L Thompson typedef enum {
305c4e3f59bSSebastian Grimberg   /// H^1 FE space
3066f117663SJeremy L Thompson   CEED_FE_SPACE_H1 = 1,
3076f117663SJeremy L Thompson   /// H(div) FE space
3086f117663SJeremy L Thompson   CEED_FE_SPACE_HDIV = 2,
309c4e3f59bSSebastian Grimberg   /// H(curl) FE space
310c4e3f59bSSebastian Grimberg   CEED_FE_SPACE_HCURL = 3,
3116f117663SJeremy L Thompson } CeedFESpace;
3126f117663SJeremy L Thompson CEED_EXTERN const char *const CeedFESpaces[];
3136f117663SJeremy L Thompson 
3142b730f8bSJeremy L Thompson CEED_EXTERN int CeedBasisGetCollocatedGrad(CeedBasis basis, CeedScalar *colo_grad_1d);
315d1d35e2fSjeremylt CEED_EXTERN int CeedBasisIsTensor(CeedBasis basis, bool *is_tensor);
316ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetData(CeedBasis basis, void *data);
317ec3da8bcSJed Brown CEED_EXTERN int CeedBasisSetData(CeedBasis basis, void *data);
3189560d06aSjeremylt CEED_EXTERN int CeedBasisReference(CeedBasis basis);
319c4e3f59bSSebastian Grimberg CEED_EXTERN int CeedBasisGetNumQuadratureComponents(CeedBasis basis, CeedEvalMode eval_mode, CeedInt *q_comp);
3209d36ca50SJeremy L Thompson CEED_EXTERN int CeedBasisGetFlopsEstimate(CeedBasis basis, CeedTransposeMode t_mode, CeedEvalMode eval_mode, CeedSize *flops);
321c4e3f59bSSebastian Grimberg CEED_EXTERN int CeedBasisGetFESpace(CeedBasis basis, CeedFESpace *fe_space);
3222b730f8bSJeremy L Thompson CEED_EXTERN int CeedBasisGetTopologyDimension(CeedElemTopology topo, CeedInt *dim);
3232b730f8bSJeremy L Thompson CEED_EXTERN int CeedBasisGetTensorContract(CeedBasis basis, CeedTensorContract *contract);
3242b730f8bSJeremy L Thompson CEED_EXTERN int CeedBasisSetTensorContract(CeedBasis basis, CeedTensorContract contract);
325c4e3f59bSSebastian Grimberg 
326a71faab1SSebastian Grimberg CEED_EXTERN int  CeedTensorContractCreate(Ceed ceed, CeedTensorContract *contract);
3272b730f8bSJeremy L Thompson CEED_EXTERN int  CeedTensorContractApply(CeedTensorContract contract, CeedInt A, CeedInt B, CeedInt C, CeedInt J, const CeedScalar *__restrict__ t,
3282b730f8bSJeremy L Thompson                                          CeedTransposeMode t_mode, const CeedInt Add, const CeedScalar *__restrict__ u, CeedScalar *__restrict__ v);
329c4e3f59bSSebastian Grimberg CEED_EXTERN int  CeedTensorContractStridedApply(CeedTensorContract contract, CeedInt A, CeedInt B, CeedInt C, CeedInt D, CeedInt J,
330c4e3f59bSSebastian Grimberg                                                 const CeedScalar *__restrict__ t, CeedTransposeMode t_mode, const CeedInt add,
331c4e3f59bSSebastian Grimberg                                                 const CeedScalar *__restrict__ u, CeedScalar *__restrict__ v);
3322b730f8bSJeremy L Thompson CEED_EXTERN int  CeedTensorContractGetCeed(CeedTensorContract contract, Ceed *ceed);
3336e536b99SJeremy L Thompson CEED_EXTERN Ceed CeedTensorContractReturnCeed(CeedTensorContract contract);
3342b730f8bSJeremy L Thompson CEED_EXTERN int  CeedTensorContractGetData(CeedTensorContract contract, void *data);
3352b730f8bSJeremy L Thompson CEED_EXTERN int  CeedTensorContractSetData(CeedTensorContract contract, void *data);
3369560d06aSjeremylt CEED_EXTERN int  CeedTensorContractReference(CeedTensorContract contract);
337585a562dSJeremy L Thompson CEED_EXTERN int  CeedTensorContractReferenceCopy(CeedTensorContract tensor, CeedTensorContract *tensor_copy);
338ec3da8bcSJed Brown CEED_EXTERN int  CeedTensorContractDestroy(CeedTensorContract *contract);
339ec3da8bcSJed Brown 
340509668d5SJeremy L Thompson CEED_EXTERN int CeedQFunctionRegister(const char *name, const char *source, CeedInt vec_length, CeedQFunctionUser f,
341509668d5SJeremy L Thompson                                       int (*init)(Ceed, const char *, CeedQFunction));
342ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionSetFortranStatus(CeedQFunction qf, bool status);
3432b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionGetVectorLength(CeedQFunction qf, CeedInt *vec_length);
3442b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionGetNumArgs(CeedQFunction qf, CeedInt *num_input_fields, CeedInt *num_output_fields);
3457d023984SJeremy L Thompson CEED_EXTERN int CeedQFunctionGetKernelName(CeedQFunction qf, const char **kernel_name);
34634ffed21SJeremy L Thompson CEED_EXTERN int CeedQFunctionGetSourcePath(CeedQFunction qf, const char **source_path);
347f8d308faSJed Brown CEED_EXTERN int CeedQFunctionLoadSourceToBuffer(CeedQFunction qf, const char **source_buffer);
3482b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionGetUserFunction(CeedQFunction qf, CeedQFunctionUser *f);
3492b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionGetContext(CeedQFunction qf, CeedQFunctionContext *ctx);
350441428dfSJeremy L Thompson CEED_EXTERN int CeedQFunctionGetContextData(CeedQFunction qf, CeedMemType mem_type, void *data);
351441428dfSJeremy L Thompson CEED_EXTERN int CeedQFunctionRestoreContextData(CeedQFunction qf, void *data);
3522b730f8bSJeremy L Thompson CEED_EXTERN int CeedQFunctionGetInnerContext(CeedQFunction qf, CeedQFunctionContext *ctx);
353441428dfSJeremy L Thompson CEED_EXTERN int CeedQFunctionGetInnerContextData(CeedQFunction qf, CeedMemType mem_type, void *data);
354441428dfSJeremy L Thompson CEED_EXTERN int CeedQFunctionRestoreInnerContextData(CeedQFunction qf, void *data);
355d1d35e2fSjeremylt CEED_EXTERN int CeedQFunctionIsIdentity(CeedQFunction qf, bool *is_identity);
356441428dfSJeremy L Thompson CEED_EXTERN int CeedQFunctionIsContextWritable(CeedQFunction qf, bool *is_writable);
357ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionGetData(CeedQFunction qf, void *data);
358ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionSetData(CeedQFunction qf, void *data);
3591203703bSJeremy L Thompson CEED_EXTERN int CeedQFunctionIsImmutable(CeedQFunction qf, bool *is_immutable);
3601203703bSJeremy L Thompson CEED_EXTERN int CeedQFunctionSetImmutable(CeedQFunction qf);
3619560d06aSjeremylt CEED_EXTERN int CeedQFunctionReference(CeedQFunction qf);
3629d36ca50SJeremy L Thompson CEED_EXTERN int CeedQFunctionGetFlopsEstimate(CeedQFunction qf, CeedSize *flops);
363ec3da8bcSJed Brown 
3642b730f8bSJeremy L Thompson CEED_EXTERN int  CeedQFunctionContextGetCeed(CeedQFunctionContext ctx, Ceed *ceed);
3656e536b99SJeremy L Thompson CEED_EXTERN Ceed CeedQFunctionContextReturnCeed(CeedQFunctionContext ctx);
3662b730f8bSJeremy L Thompson CEED_EXTERN int  CeedQFunctionContextHasValidData(CeedQFunctionContext ctx, bool *has_valid_data);
3672b730f8bSJeremy L Thompson CEED_EXTERN int  CeedQFunctionContextHasBorrowedDataOfType(CeedQFunctionContext ctx, CeedMemType mem_type, bool *has_borrowed_data_of_type);
3682b730f8bSJeremy L Thompson CEED_EXTERN int  CeedQFunctionContextGetState(CeedQFunctionContext ctx, uint64_t *state);
3692b730f8bSJeremy L Thompson CEED_EXTERN int  CeedQFunctionContextGetBackendData(CeedQFunctionContext ctx, void *data);
3702b730f8bSJeremy L Thompson CEED_EXTERN int  CeedQFunctionContextSetBackendData(CeedQFunctionContext ctx, void *data);
3712b730f8bSJeremy L Thompson CEED_EXTERN int  CeedQFunctionContextGetFieldLabel(CeedQFunctionContext ctx, const char *field_name, CeedContextFieldLabel *field_label);
3722b730f8bSJeremy L Thompson CEED_EXTERN int  CeedQFunctionContextSetGeneric(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, CeedContextFieldType field_type,
3732b730f8bSJeremy L Thompson                                                 void *value);
3742788fa27SJeremy L Thompson CEED_EXTERN int  CeedQFunctionContextGetGenericRead(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, CeedContextFieldType field_type,
3752788fa27SJeremy L Thompson                                                     size_t *num_values, void *value);
3762788fa27SJeremy L Thompson CEED_EXTERN int  CeedQFunctionContextRestoreGenericRead(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, CeedContextFieldType field_type,
3772788fa27SJeremy L Thompson                                                         void *value);
3782b730f8bSJeremy L Thompson CEED_EXTERN int  CeedQFunctionContextSetDouble(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, double *values);
3792788fa27SJeremy L Thompson CEED_EXTERN int  CeedQFunctionContextGetDoubleRead(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, size_t *num_values,
3802788fa27SJeremy L Thompson                                                    const double **values);
3812788fa27SJeremy L Thompson CEED_EXTERN int  CeedQFunctionContextRestoreDoubleRead(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, const double **values);
38223dbfd29SJeremy L Thompson CEED_EXTERN int  CeedQFunctionContextSetInt32(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, int32_t *values);
38323dbfd29SJeremy L Thompson CEED_EXTERN int  CeedQFunctionContextGetInt32Read(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, size_t *num_values,
38423dbfd29SJeremy L Thompson                                                   const int32_t **values);
38523dbfd29SJeremy L Thompson CEED_EXTERN int  CeedQFunctionContextRestoreInt32Read(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, const int32_t **values);
3865b6ec284SJeremy L Thompson CEED_EXTERN int  CeedQFunctionContextSetBoolean(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, bool *values);
3875b6ec284SJeremy L Thompson CEED_EXTERN int  CeedQFunctionContextGetBooleanRead(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, size_t *num_values,
3885b6ec284SJeremy L Thompson                                                     const bool **values);
3895b6ec284SJeremy L Thompson CEED_EXTERN int  CeedQFunctionContextRestoreBooleanRead(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, const bool **values);
3902b730f8bSJeremy L Thompson CEED_EXTERN int  CeedQFunctionContextGetDataDestroy(CeedQFunctionContext ctx, CeedMemType *f_mem_type, CeedQFunctionContextDataDestroyUser *f);
3919560d06aSjeremylt CEED_EXTERN int  CeedQFunctionContextReference(CeedQFunctionContext ctx);
392ec3da8bcSJed Brown 
393004e4986SSebastian Grimberg CEED_EXTERN int CeedOperatorGetBasisPointer(CeedBasis basis, CeedEvalMode eval_mode, const CeedScalar *identity, const CeedScalar **basis_ptr);
394506b1a0cSSebastian Grimberg CEED_EXTERN int CeedOperatorCreateActivePointBlockRestriction(CeedElemRestriction rstr, CeedElemRestriction *pointblock_rstr);
395480fae85SJeremy L Thompson CEED_EXTERN int CeedQFunctionAssemblyDataCreate(Ceed ceed, CeedQFunctionAssemblyData *data);
396480fae85SJeremy L Thompson CEED_EXTERN int CeedQFunctionAssemblyDataReference(CeedQFunctionAssemblyData data);
397beecbf24SJeremy L Thompson CEED_EXTERN int CeedQFunctionAssemblyDataSetReuse(CeedQFunctionAssemblyData data, bool reuse_assembly_data);
398beecbf24SJeremy L Thompson CEED_EXTERN int CeedQFunctionAssemblyDataSetUpdateNeeded(CeedQFunctionAssemblyData data, bool needs_data_update);
3998b919e6bSJeremy L Thompson CEED_EXTERN int CeedQFunctionAssemblyDataIsUpdateNeeded(CeedQFunctionAssemblyData data, bool *is_update_needed);
400480fae85SJeremy L Thompson CEED_EXTERN int CeedQFunctionAssemblyDataReferenceCopy(CeedQFunctionAssemblyData data, CeedQFunctionAssemblyData *data_copy);
401480fae85SJeremy L Thompson CEED_EXTERN int CeedQFunctionAssemblyDataIsSetup(CeedQFunctionAssemblyData data, bool *is_setup);
402480fae85SJeremy L Thompson CEED_EXTERN int CeedQFunctionAssemblyDataSetObjects(CeedQFunctionAssemblyData data, CeedVector vec, CeedElemRestriction rstr);
403480fae85SJeremy L Thompson CEED_EXTERN int CeedQFunctionAssemblyDataGetObjects(CeedQFunctionAssemblyData data, CeedVector *vec, CeedElemRestriction *rstr);
404480fae85SJeremy L Thompson CEED_EXTERN int CeedQFunctionAssemblyDataDestroy(CeedQFunctionAssemblyData *data);
405480fae85SJeremy L Thompson 
406ed9e99e6SJeremy L Thompson CEED_EXTERN int CeedOperatorAssemblyDataCreate(Ceed ceed, CeedOperator op, CeedOperatorAssemblyData *data);
407506b1a0cSSebastian Grimberg CEED_EXTERN int CeedOperatorAssemblyDataGetEvalModes(CeedOperatorAssemblyData data, CeedInt *num_active_bases_in, CeedInt **num_eval_modes_in,
408437c7c90SJeremy L Thompson                                                      const CeedEvalMode ***eval_modes_in, CeedSize ***eval_mode_offsets_in,
409506b1a0cSSebastian Grimberg                                                      CeedInt *num_active_bases_out, CeedInt **num_eval_modes_out,
410506b1a0cSSebastian Grimberg                                                      const CeedEvalMode ***eval_modes_out, CeedSize ***eval_mode_offsets_out,
411506b1a0cSSebastian Grimberg                                                      CeedSize *num_output_components);
412506b1a0cSSebastian Grimberg CEED_EXTERN int CeedOperatorAssemblyDataGetBases(CeedOperatorAssemblyData data, CeedInt *num_active_bases_in, CeedBasis **active_bases_in,
413506b1a0cSSebastian Grimberg                                                  const CeedScalar ***assembled_bases_in, CeedInt *num_active_bases_out, CeedBasis **active_bases_out,
414506b1a0cSSebastian Grimberg                                                  const CeedScalar ***assembled_bases_out);
415506b1a0cSSebastian Grimberg CEED_EXTERN int CeedOperatorAssemblyDataGetElemRestrictions(CeedOperatorAssemblyData data, CeedInt *num_active_elem_rstrs_in,
416506b1a0cSSebastian Grimberg                                                             CeedElemRestriction **active_elem_rstrs_in, CeedInt *num_active_elem_rstrs_out,
417506b1a0cSSebastian Grimberg                                                             CeedElemRestriction **active_elem_rstrs_out);
418ed9e99e6SJeremy L Thompson CEED_EXTERN int CeedOperatorAssemblyDataDestroy(CeedOperatorAssemblyData *data);
419ed9e99e6SJeremy L Thompson 
420ed9e99e6SJeremy L Thompson CEED_EXTERN int CeedOperatorGetOperatorAssemblyData(CeedOperator op, CeedOperatorAssemblyData *data);
4212b730f8bSJeremy L Thompson CEED_EXTERN int CeedOperatorGetActiveBasis(CeedOperator op, CeedBasis *active_basis);
422506b1a0cSSebastian Grimberg CEED_EXTERN int CeedOperatorGetActiveBases(CeedOperator op, CeedBasis *active_input_basis, CeedBasis *active_output_basis);
423ed9e99e6SJeremy L Thompson CEED_EXTERN int CeedOperatorGetActiveElemRestriction(CeedOperator op, CeedElemRestriction *active_rstr);
424506b1a0cSSebastian Grimberg CEED_EXTERN int CeedOperatorGetActiveElemRestrictions(CeedOperator op, CeedElemRestriction *active_input_rstr,
425506b1a0cSSebastian Grimberg                                                       CeedElemRestriction *active_output_rstr);
426d1d35e2fSjeremylt CEED_EXTERN int CeedOperatorGetNumArgs(CeedOperator op, CeedInt *num_args);
4279463e855SJeremy L Thompson CEED_EXTERN int CeedOperatorHasTensorBases(CeedOperator op, bool *has_tensor_bases);
4281203703bSJeremy L Thompson CEED_EXTERN int CeedOperatorIsImmutable(CeedOperator op, bool *is_immutable);
429d1d35e2fSjeremylt CEED_EXTERN int CeedOperatorIsSetupDone(CeedOperator op, bool *is_setup_done);
430ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorGetQFunction(CeedOperator op, CeedQFunction *qf);
431d1d35e2fSjeremylt CEED_EXTERN int CeedOperatorIsComposite(CeedOperator op, bool *is_composite);
432ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorGetData(CeedOperator op, void *data);
433ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorSetData(CeedOperator op, void *data);
4349560d06aSjeremylt CEED_EXTERN int CeedOperatorReference(CeedOperator op);
435bb229da9SJeremy L Thompson CEED_EXTERN int CeedOperatorGetFallback(CeedOperator op, CeedOperator *op_fallback);
436bb229da9SJeremy L Thompson CEED_EXTERN int CeedOperatorGetFallbackParent(CeedOperator op, CeedOperator *parent);
437bb229da9SJeremy L Thompson CEED_EXTERN int CeedOperatorGetFallbackParentCeed(CeedOperator op, Ceed *parent);
438ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorSetSetupDone(CeedOperator op);
439ec3da8bcSJed Brown 
4402b730f8bSJeremy L Thompson CEED_INTERN int CeedMatrixMatrixMultiply(Ceed ceed, const CeedScalar *mat_A, const CeedScalar *mat_B, CeedScalar *mat_C, CeedInt m, CeedInt n,
4412b730f8bSJeremy L Thompson                                          CeedInt kk);
442ba59ac12SSebastian Grimberg CEED_EXTERN int CeedQRFactorization(Ceed ceed, CeedScalar *mat, CeedScalar *tau, CeedInt m, CeedInt n);
443ba59ac12SSebastian Grimberg CEED_EXTERN int CeedHouseholderApplyQ(CeedScalar *mat_A, const CeedScalar *mat_Q, const CeedScalar *tau, CeedTransposeMode t_mode, CeedInt m,
444ba59ac12SSebastian Grimberg                                       CeedInt n, CeedInt k, CeedInt row, CeedInt col);
4451203703bSJeremy L Thompson CEED_EXTERN int CeedMatrixPseudoinverse(Ceed ceed, const CeedScalar *mat, CeedInt m, CeedInt n, CeedScalar *mat_pinv);
446ba59ac12SSebastian Grimberg CEED_EXTERN int CeedSymmetricSchurDecomposition(Ceed ceed, CeedScalar *mat, CeedScalar *lambda, CeedInt n);
447ba59ac12SSebastian Grimberg CEED_EXTERN int CeedSimultaneousDiagonalization(Ceed ceed, CeedScalar *mat_A, CeedScalar *mat_B, CeedScalar *x, CeedScalar *lambda, CeedInt n);
448