xref: /libCEED/include/ceed/backend.h (revision 9c34f28efacf2a1982e0e33d5357c64f609fddc7)
1 // Copyright (c) 2017-2022, Lawrence Livermore National Security, LLC and other CEED contributors.
2 // All Rights Reserved. See the top-level LICENSE and NOTICE files for details.
3 //
4 // SPDX-License-Identifier: BSD-2-Clause
5 //
6 // This file is part of CEED:  http://github.com/ceed
7 
8 /// @file
9 /// Public header for backend components of libCEED
10 #ifndef CEED_BACKEND_H
11 #define CEED_BACKEND_H
12 
13 #include <ceed.h>
14 #include <limits.h>
15 #include <stdbool.h>
16 
17 #if defined(__clang_analyzer__)
18 #define CEED_INTERN
19 #elif defined(__cplusplus)
20 #define CEED_INTERN extern "C" CEED_VISIBILITY(hidden)
21 #else
22 #define CEED_INTERN extern CEED_VISIBILITY(hidden)
23 #endif
24 
25 #define CEED_UNUSED __attribute__((unused))
26 
27 #define CEED_MAX_RESOURCE_LEN 1024
28 #define CEED_MAX_BACKEND_PRIORITY UINT_MAX
29 #define CEED_ALIGN 64
30 #define CEED_COMPOSITE_MAX 16
31 #define CEED_FIELD_MAX 16
32 
33 #ifndef CeedPragmaOptimizeOff
34 #if defined(__clang__)
35 /// This macro provides the ability to disable optimization flags for functions that are sensitive to floating point optimizations.
36 /// @ingroup Ceed
37 #define CeedPragmaOptimizeOff _Pragma("clang optimize off")
38 #elif defined(__GNUC__)
39 #define CeedPragmaOptimizeOff _Pragma("GCC push_options") _Pragma("GCC optimize 0")
40 #elif defined(__INTEL_COMPILER) || defined(__INTEL_LLVM_COMPILER)
41 #define CeedPragmaOptimizeOff _Pragma("optimize('', off)")
42 #else
43 #define CeedPragmaOptimizeOff
44 #endif
45 #endif
46 
47 #ifndef CeedPragmaOptimizeOn
48 #if defined(__clang__)
49 /// This macro restores previously set optimization flags after CeedPragmaOptimizeOff.
50 /// @ingroup Ceed
51 #define CeedPragmaOptimizeOn _Pragma("clang optimize on")
52 #elif defined(__GNUC__)
53 #define CeedPragmaOptimizeOn _Pragma("GCC pop_options")
54 #elif defined(__INTEL_COMPILER) || defined(__INTEL_LLVM_COMPILER)
55 #define CeedPragmaOptimizeOn _Pragma("optimize('', on)")
56 #else
57 #define CeedPragmaOptimizeOn
58 #endif
59 #endif
60 
61 /// This macro provides the appropriate OpenMP Pragmas for the compilation environment.
62 /// @ingroup Ceed
63 #ifndef CeedPragmaOMP
64 #ifdef _OPENMP
65 #define CeedPragmaOMPHelper(x) _Pragma(#x)
66 #define CeedPragmaOMP(x) CeedPragmaOMPHelper(omp x)
67 #else
68 #define CeedPragmaOMP(x)
69 #endif
70 #endif
71 #ifndef CeedPragmaAtomic
72 #define CeedPragmaAtomic CeedPragmaOMP(atomic update)
73 #endif
74 #ifndef CeedPragmaCritical
75 #define CeedPragmaCritical(x) CeedPragmaOMP(critical(x))
76 #endif
77 
78 /**
79   This enum supples common colors for CeedDebug256 debugging output.
80   Set the environment variable `CEED_DEBUG = 1` to activate debugging output.
81 
82   @ingroup Ceed
83   @ref     Backend
84 **/
85 typedef enum {
86   /// Success color
87   CEED_DEBUG_COLOR_SUCCESS = 108,
88   /// Warning color
89   CEED_DEBUG_COLOR_WARNING = 208,
90   /// Error color
91   CEED_DEBUG_COLOR_ERROR = 196,
92   /// Use native terminal coloring
93   CEED_DEBUG_COLOR_NONE = 255,
94 } CeedDebugColor;
95 
96 CEED_EXTERN void CeedDebugImpl256(const unsigned char, const char *, ...);
97 CEED_EXTERN bool CeedDebugFlag(const Ceed ceed);
98 CEED_EXTERN bool CeedDebugFlagEnv(void);
99 /**
100   Print debugging information in color
101 
102   @param[in] ceed  Ceed
103   @param[in] color Color to print with
104 
105   @ingroup Ceed
106   @ref     Backend
107 **/
108 #define CeedDebug256(ceed, color, ...)                               \
109   {                                                                  \
110     if (CeedDebugFlag(ceed)) CeedDebugImpl256(color, ##__VA_ARGS__); \
111   }
112 /**
113   Print debugging information to terminal
114 
115   @param[in] ceed  Ceed
116 
117   @ingroup Ceed
118   @ref     Backend
119 **/
120 #define CeedDebug(ceed, ...) CeedDebug256(ceed, (unsigned char)CEED_DEBUG_COLOR_NONE, ##__VA_ARGS__)
121 /**
122   Print debugging information in color without Ceed to reference
123 
124   @param[in] color Color to print with
125 
126   @ingroup Ceed
127   @ref     Backend
128 **/
129 #define CeedDebugEnv256(color, ...)                                 \
130   {                                                                 \
131     if (CeedDebugFlagEnv()) CeedDebugImpl256(color, ##__VA_ARGS__); \
132   }
133 /**
134   Print debugging information to terminal without Ceed to reference
135 
136   @ingroup Ceed
137   @ref     Backend
138 **/
139 #define CeedDebugEnv(...) CeedDebugEnv256((unsigned char)CEED_DEBUG_COLOR_NONE, ##__VA_ARGS__)
140 /**
141   Print warning information in color
142 
143   @ingroup Ceed
144   @ref     Backend
145 **/
146 #define CeedWarn(...) \
147   { CeedDebugImpl256(CEED_DEBUG_COLOR_WARNING, ##__VA_ARGS__); }
148 
149 /**
150   Swap the values of two CeedScalars
151 
152   @param[in,out] a  First CeedScalar
153   @param[in,out] b  Second CeedScalar
154 
155   @ingroup Ceed
156   @ref     Backend
157 **/
158 #define CeedScalarSwap(a, b)        \
159   {                                 \
160     const CeedScalar temp_ = a;     \
161     a                      = b;     \
162     b                      = temp_; \
163   }
164 
165 /// Handle for object handling TensorContraction
166 /// @ingroup CeedBasis
167 typedef struct CeedTensorContract_private *CeedTensorContract;
168 
169 /// Handle for object handling assembled QFunction data
170 /// @ingroup CeedOperator
171 typedef struct CeedQFunctionAssemblyData_private *CeedQFunctionAssemblyData;
172 
173 /// Handle for object handling assembled Operator data
174 /// @ingroup CeedOperator
175 typedef struct CeedOperatorAssemblyData_private *CeedOperatorAssemblyData;
176 
177 /* 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. */
178 CEED_INTERN int CeedMallocArray(size_t n, size_t unit, void *p);
179 CEED_INTERN int CeedCallocArray(size_t n, size_t unit, void *p);
180 CEED_INTERN int CeedReallocArray(size_t n, size_t unit, void *p);
181 CEED_INTERN int CeedStringAllocCopy(const char *source, char **copy);
182 CEED_INTERN int CeedFree(void *p);
183 
184 /**
185   @brief Calls a libCEED function and then checks the resulting error code.
186   If the error code is non-zero, then the error handler is called and the call from the current function with the error code.
187 
188   @ref Developer
189 **/
190 #define CeedCall(...)        \
191   do {                       \
192     int ierr_ = __VA_ARGS__; \
193     if (ierr_) return ierr_; \
194   } while (0)
195 
196 /**
197   @brief Calls a libCEED function and then checks the resulting error code.
198   If the error code is non-zero, then the error handler is called and the call from the current function with the error code.
199   All interface level error codes are upgraded to `CEED_ERROR_BACKEND`.
200 
201   @ref Developer
202 **/
203 #define CeedCallBackend(...)                                                     \
204   do {                                                                           \
205     int ierr_ = __VA_ARGS__;                                                     \
206     if (ierr_) return (ierr_ > CEED_ERROR_SUCCESS) ? CEED_ERROR_BACKEND : ierr_; \
207   } while (0)
208 
209 /**
210   @brief Check that a particular condition is true and returns a `CeedError` if not.
211 
212   @ref Developer
213 **/
214 #define CeedCheck(cond, ceed, ecode, ...)                    \
215   do {                                                       \
216     if (!(cond)) return CeedError(ceed, ecode, __VA_ARGS__); \
217   } while (0)
218 
219 /* Note that CeedMalloc and CeedCalloc will, generally, return pointers with different memory alignments:
220    CeedMalloc returns pointers aligned at CEED_ALIGN bytes, while CeedCalloc uses the alignment of calloc. */
221 #define CeedMalloc(n, p) CeedMallocArray((n), sizeof(**(p)), p)
222 #define CeedCalloc(n, p) CeedCallocArray((n), sizeof(**(p)), p)
223 #define CeedRealloc(n, p) CeedReallocArray((n), sizeof(**(p)), p)
224 
225 CEED_EXTERN int CeedRegister(const char *prefix, int (*init)(const char *, Ceed), unsigned int priority);
226 CEED_EXTERN int CeedRegisterImpl(const char *prefix, int (*init)(const char *, Ceed), unsigned int priority);
227 
228 CEED_EXTERN int CeedIsDebug(Ceed ceed, bool *is_debug);
229 CEED_EXTERN int CeedGetResourceRoot(Ceed ceed, const char *resource, const char *delineator, char **resource_root);
230 CEED_EXTERN int CeedGetParent(Ceed ceed, Ceed *parent);
231 CEED_EXTERN int CeedGetDelegate(Ceed ceed, Ceed *delegate);
232 CEED_EXTERN int CeedSetDelegate(Ceed ceed, Ceed delegate);
233 CEED_EXTERN int CeedGetObjectDelegate(Ceed ceed, Ceed *delegate, const char *obj_name);
234 CEED_EXTERN int CeedSetObjectDelegate(Ceed ceed, Ceed delegate, const char *obj_name);
235 CEED_EXTERN int CeedGetOperatorFallbackResource(Ceed ceed, const char **resource);
236 CEED_EXTERN int CeedGetOperatorFallbackCeed(Ceed ceed, Ceed *fallback_ceed);
237 CEED_EXTERN int CeedSetOperatorFallbackResource(Ceed ceed, const char *resource);
238 CEED_EXTERN int CeedSetDeterministic(Ceed ceed, bool is_deterministic);
239 CEED_EXTERN int CeedSetBackendFunction(Ceed ceed, const char *type, void *object, const char *func_name, int (*f)());
240 CEED_EXTERN int CeedGetData(Ceed ceed, void *data);
241 CEED_EXTERN int CeedSetData(Ceed ceed, void *data);
242 CEED_EXTERN int CeedReference(Ceed ceed);
243 
244 CEED_EXTERN int CeedVectorHasValidArray(CeedVector vec, bool *has_valid_array);
245 CEED_EXTERN int CeedVectorHasBorrowedArrayOfType(CeedVector vec, CeedMemType mem_type, bool *has_borrowed_array_of_type);
246 CEED_EXTERN int CeedVectorHasValidArray(CeedVector vec, bool *has_valid_array);
247 CEED_EXTERN int CeedVectorGetState(CeedVector vec, uint64_t *state);
248 CEED_EXTERN int CeedVectorGetData(CeedVector vec, void *data);
249 CEED_EXTERN int CeedVectorSetData(CeedVector vec, void *data);
250 CEED_EXTERN int CeedVectorReference(CeedVector vec);
251 
252 /// Type of element restriction;
253 /// @ingroup CeedElemRestriction
254 typedef enum {
255   /// Standard element restriction with offsets
256   CEED_RESTRICTION_STANDARD = 1,
257   /// Oriented element restriction
258   CEED_RESTRICTION_ORIENTED = 2,
259   /// Curl-oriented element restriction
260   CEED_RESTRICTION_CURL_ORIENTED = 3,
261   /// Strided element restriction
262   CEED_RESTRICTION_STRIDED = 4,
263   /// Point-in-cell element restriction
264   CEED_RESTRICTION_POINTS = 5,
265 } CeedRestrictionType;
266 
267 CEED_EXTERN int CeedElemRestrictionGetType(CeedElemRestriction rstr, CeedRestrictionType *rstr_type);
268 CEED_EXTERN int CeedElemRestrictionIsStrided(CeedElemRestriction rstr, bool *is_strided);
269 CEED_EXTERN int CeedElemRestrictionIsPoints(CeedElemRestriction rstr, bool *is_points);
270 CEED_EXTERN int CeedElemRestrictionGetStrides(CeedElemRestriction rstr, CeedInt (*strides)[3]);
271 CEED_EXTERN int CeedElemRestrictionHasBackendStrides(CeedElemRestriction rstr, bool *has_backend_strides);
272 CEED_EXTERN int CeedElemRestrictionGetOffsets(CeedElemRestriction rstr, CeedMemType mem_type, const CeedInt **offsets);
273 CEED_EXTERN int CeedElemRestrictionRestoreOffsets(CeedElemRestriction rstr, const CeedInt **offsets);
274 CEED_EXTERN int CeedElemRestrictionGetOrientations(CeedElemRestriction rstr, CeedMemType mem_type, const bool **orients);
275 CEED_EXTERN int CeedElemRestrictionRestoreOrientations(CeedElemRestriction rstr, const bool **orients);
276 CEED_EXTERN int CeedElemRestrictionGetCurlOrientations(CeedElemRestriction rstr, CeedMemType mem_type, const CeedInt8 **curl_orients);
277 CEED_EXTERN int CeedElemRestrictionRestoreCurlOrientations(CeedElemRestriction rstr, const CeedInt8 **curl_orients);
278 CEED_EXTERN int CeedElemRestrictionGetELayout(CeedElemRestriction rstr, CeedInt (*layout)[3]);
279 CEED_EXTERN int CeedElemRestrictionSetELayout(CeedElemRestriction rstr, CeedInt layout[3]);
280 CEED_EXTERN int CeedElemRestrictionGetData(CeedElemRestriction rstr, void *data);
281 CEED_EXTERN int CeedElemRestrictionSetData(CeedElemRestriction rstr, void *data);
282 CEED_EXTERN int CeedElemRestrictionReference(CeedElemRestriction rstr);
283 CEED_EXTERN int CeedElemRestrictionGetFlopsEstimate(CeedElemRestriction rstr, CeedTransposeMode t_mode, CeedSize *flops);
284 
285 /// Type of FE space;
286 /// @ingroup CeedBasis
287 typedef enum {
288   /// H^1 FE space
289   CEED_FE_SPACE_H1 = 1,
290   /// H(div) FE space
291   CEED_FE_SPACE_HDIV = 2,
292   /// H(curl) FE space
293   CEED_FE_SPACE_HCURL = 3,
294 } CeedFESpace;
295 CEED_EXTERN const char *const CeedFESpaces[];
296 
297 CEED_EXTERN int CeedBasisGetCollocatedGrad(CeedBasis basis, CeedScalar *colo_grad_1d);
298 CEED_EXTERN int CeedBasisIsTensor(CeedBasis basis, bool *is_tensor);
299 CEED_EXTERN int CeedBasisGetData(CeedBasis basis, void *data);
300 CEED_EXTERN int CeedBasisSetData(CeedBasis basis, void *data);
301 CEED_EXTERN int CeedBasisReference(CeedBasis basis);
302 CEED_EXTERN int CeedBasisGetNumQuadratureComponents(CeedBasis basis, CeedEvalMode eval_mode, CeedInt *q_comp);
303 CEED_EXTERN int CeedBasisGetFlopsEstimate(CeedBasis basis, CeedTransposeMode t_mode, CeedEvalMode eval_mode, CeedSize *flops);
304 CEED_EXTERN int CeedBasisGetFESpace(CeedBasis basis, CeedFESpace *fe_space);
305 CEED_EXTERN int CeedBasisGetTopologyDimension(CeedElemTopology topo, CeedInt *dim);
306 CEED_EXTERN int CeedBasisGetTensorContract(CeedBasis basis, CeedTensorContract *contract);
307 CEED_EXTERN int CeedBasisSetTensorContract(CeedBasis basis, CeedTensorContract contract);
308 
309 CEED_EXTERN int CeedTensorContractCreate(Ceed ceed, CeedTensorContract *contract);
310 CEED_EXTERN int CeedTensorContractApply(CeedTensorContract contract, CeedInt A, CeedInt B, CeedInt C, CeedInt J, const CeedScalar *__restrict__ t,
311                                         CeedTransposeMode t_mode, const CeedInt Add, const CeedScalar *__restrict__ u, CeedScalar *__restrict__ v);
312 CEED_EXTERN int CeedTensorContractStridedApply(CeedTensorContract contract, CeedInt A, CeedInt B, CeedInt C, CeedInt D, CeedInt J,
313                                                const CeedScalar *__restrict__ t, CeedTransposeMode t_mode, const CeedInt add,
314                                                const CeedScalar *__restrict__ u, CeedScalar *__restrict__ v);
315 CEED_EXTERN int CeedTensorContractGetCeed(CeedTensorContract contract, Ceed *ceed);
316 CEED_EXTERN int CeedTensorContractGetData(CeedTensorContract contract, void *data);
317 CEED_EXTERN int CeedTensorContractSetData(CeedTensorContract contract, void *data);
318 CEED_EXTERN int CeedTensorContractReference(CeedTensorContract contract);
319 CEED_EXTERN int CeedTensorContractReferenceCopy(CeedTensorContract tensor, CeedTensorContract *tensor_copy);
320 CEED_EXTERN int CeedTensorContractDestroy(CeedTensorContract *contract);
321 
322 CEED_EXTERN int CeedQFunctionRegister(const char *name, const char *source, CeedInt vec_length, CeedQFunctionUser f,
323                                       int (*init)(Ceed, const char *, CeedQFunction));
324 CEED_EXTERN int CeedQFunctionSetFortranStatus(CeedQFunction qf, bool status);
325 CEED_EXTERN int CeedQFunctionGetVectorLength(CeedQFunction qf, CeedInt *vec_length);
326 CEED_EXTERN int CeedQFunctionGetNumArgs(CeedQFunction qf, CeedInt *num_input_fields, CeedInt *num_output_fields);
327 CEED_EXTERN int CeedQFunctionGetKernelName(CeedQFunction qf, char **kernel_name);
328 CEED_EXTERN int CeedQFunctionGetSourcePath(CeedQFunction qf, char **source_path);
329 CEED_EXTERN int CeedQFunctionLoadSourceToBuffer(CeedQFunction qf, char **source_buffer);
330 CEED_EXTERN int CeedQFunctionGetUserFunction(CeedQFunction qf, CeedQFunctionUser *f);
331 CEED_EXTERN int CeedQFunctionGetContext(CeedQFunction qf, CeedQFunctionContext *ctx);
332 CEED_EXTERN int CeedQFunctionGetContextData(CeedQFunction qf, CeedMemType mem_type, void *data);
333 CEED_EXTERN int CeedQFunctionRestoreContextData(CeedQFunction qf, void *data);
334 CEED_EXTERN int CeedQFunctionGetInnerContext(CeedQFunction qf, CeedQFunctionContext *ctx);
335 CEED_EXTERN int CeedQFunctionGetInnerContextData(CeedQFunction qf, CeedMemType mem_type, void *data);
336 CEED_EXTERN int CeedQFunctionRestoreInnerContextData(CeedQFunction qf, void *data);
337 CEED_EXTERN int CeedQFunctionIsIdentity(CeedQFunction qf, bool *is_identity);
338 CEED_EXTERN int CeedQFunctionIsContextWritable(CeedQFunction qf, bool *is_writable);
339 CEED_EXTERN int CeedQFunctionGetData(CeedQFunction qf, void *data);
340 CEED_EXTERN int CeedQFunctionSetData(CeedQFunction qf, void *data);
341 CEED_EXTERN int CeedQFunctionReference(CeedQFunction qf);
342 CEED_EXTERN int CeedQFunctionGetFlopsEstimate(CeedQFunction qf, CeedSize *flops);
343 
344 CEED_EXTERN int CeedQFunctionContextGetCeed(CeedQFunctionContext ctx, Ceed *ceed);
345 CEED_EXTERN int CeedQFunctionContextHasValidData(CeedQFunctionContext ctx, bool *has_valid_data);
346 CEED_EXTERN int CeedQFunctionContextHasBorrowedDataOfType(CeedQFunctionContext ctx, CeedMemType mem_type, bool *has_borrowed_data_of_type);
347 CEED_EXTERN int CeedQFunctionContextGetState(CeedQFunctionContext ctx, uint64_t *state);
348 CEED_EXTERN int CeedQFunctionContextGetBackendData(CeedQFunctionContext ctx, void *data);
349 CEED_EXTERN int CeedQFunctionContextSetBackendData(CeedQFunctionContext ctx, void *data);
350 CEED_EXTERN int CeedQFunctionContextGetFieldLabel(CeedQFunctionContext ctx, const char *field_name, CeedContextFieldLabel *field_label);
351 CEED_EXTERN int CeedQFunctionContextSetGeneric(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, CeedContextFieldType field_type,
352                                                void *value);
353 CEED_EXTERN int CeedQFunctionContextGetGenericRead(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, CeedContextFieldType field_type,
354                                                    size_t *num_values, void *value);
355 CEED_EXTERN int CeedQFunctionContextRestoreGenericRead(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, CeedContextFieldType field_type,
356                                                        void *value);
357 CEED_EXTERN int CeedQFunctionContextSetDouble(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, double *values);
358 CEED_EXTERN int CeedQFunctionContextGetDoubleRead(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, size_t *num_values,
359                                                   const double **values);
360 CEED_EXTERN int CeedQFunctionContextRestoreDoubleRead(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, const double **values);
361 CEED_EXTERN int CeedQFunctionContextSetInt32(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, int32_t *values);
362 CEED_EXTERN int CeedQFunctionContextGetInt32Read(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, size_t *num_values,
363                                                  const int32_t **values);
364 CEED_EXTERN int CeedQFunctionContextRestoreInt32Read(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, const int32_t **values);
365 CEED_EXTERN int CeedQFunctionContextSetBoolean(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, bool *values);
366 CEED_EXTERN int CeedQFunctionContextGetBooleanRead(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, size_t *num_values,
367                                                    const bool **values);
368 CEED_EXTERN int CeedQFunctionContextRestoreBooleanRead(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, const bool **values);
369 CEED_EXTERN int CeedQFunctionContextGetDataDestroy(CeedQFunctionContext ctx, CeedMemType *f_mem_type, CeedQFunctionContextDataDestroyUser *f);
370 CEED_EXTERN int CeedQFunctionContextReference(CeedQFunctionContext ctx);
371 
372 CEED_EXTERN int CeedOperatorCreateActivePointBlockRestriction(CeedElemRestriction rstr, CeedElemRestriction *pointblock_rstr);
373 CEED_EXTERN int CeedQFunctionAssemblyDataCreate(Ceed ceed, CeedQFunctionAssemblyData *data);
374 CEED_EXTERN int CeedQFunctionAssemblyDataReference(CeedQFunctionAssemblyData data);
375 CEED_EXTERN int CeedQFunctionAssemblyDataSetReuse(CeedQFunctionAssemblyData data, bool reuse_assembly_data);
376 CEED_EXTERN int CeedQFunctionAssemblyDataSetUpdateNeeded(CeedQFunctionAssemblyData data, bool needs_data_update);
377 CEED_EXTERN int CeedQFunctionAssemblyDataIsUpdateNeeded(CeedQFunctionAssemblyData data, bool *is_update_needed);
378 CEED_EXTERN int CeedQFunctionAssemblyDataReferenceCopy(CeedQFunctionAssemblyData data, CeedQFunctionAssemblyData *data_copy);
379 CEED_EXTERN int CeedQFunctionAssemblyDataIsSetup(CeedQFunctionAssemblyData data, bool *is_setup);
380 CEED_EXTERN int CeedQFunctionAssemblyDataSetObjects(CeedQFunctionAssemblyData data, CeedVector vec, CeedElemRestriction rstr);
381 CEED_EXTERN int CeedQFunctionAssemblyDataGetObjects(CeedQFunctionAssemblyData data, CeedVector *vec, CeedElemRestriction *rstr);
382 CEED_EXTERN int CeedQFunctionAssemblyDataDestroy(CeedQFunctionAssemblyData *data);
383 
384 CEED_EXTERN int CeedOperatorAssemblyDataCreate(Ceed ceed, CeedOperator op, CeedOperatorAssemblyData *data);
385 CEED_EXTERN int CeedOperatorAssemblyDataGetEvalModes(CeedOperatorAssemblyData data, CeedInt *num_active_bases_in, CeedInt **num_eval_modes_in,
386                                                      const CeedEvalMode ***eval_modes_in, CeedSize ***eval_mode_offsets_in,
387                                                      CeedInt *num_active_bases_out, CeedInt **num_eval_modes_out,
388                                                      const CeedEvalMode ***eval_modes_out, CeedSize ***eval_mode_offsets_out,
389                                                      CeedSize *num_output_components);
390 CEED_EXTERN int CeedOperatorAssemblyDataGetBases(CeedOperatorAssemblyData data, CeedInt *num_active_bases_in, CeedBasis **active_bases_in,
391                                                  const CeedScalar ***assembled_bases_in, CeedInt *num_active_bases_out, CeedBasis **active_bases_out,
392                                                  const CeedScalar ***assembled_bases_out);
393 CEED_EXTERN int CeedOperatorAssemblyDataGetElemRestrictions(CeedOperatorAssemblyData data, CeedInt *num_active_elem_rstrs_in,
394                                                             CeedElemRestriction **active_elem_rstrs_in, CeedInt *num_active_elem_rstrs_out,
395                                                             CeedElemRestriction **active_elem_rstrs_out);
396 CEED_EXTERN int CeedOperatorAssemblyDataDestroy(CeedOperatorAssemblyData *data);
397 
398 CEED_EXTERN int CeedOperatorGetOperatorAssemblyData(CeedOperator op, CeedOperatorAssemblyData *data);
399 CEED_EXTERN int CeedOperatorGetActiveBasis(CeedOperator op, CeedBasis *active_basis);
400 CEED_EXTERN int CeedOperatorGetActiveBases(CeedOperator op, CeedBasis *active_input_basis, CeedBasis *active_output_basis);
401 CEED_EXTERN int CeedOperatorGetActiveElemRestriction(CeedOperator op, CeedElemRestriction *active_rstr);
402 CEED_EXTERN int CeedOperatorGetActiveElemRestrictions(CeedOperator op, CeedElemRestriction *active_input_rstr,
403                                                       CeedElemRestriction *active_output_rstr);
404 CEED_EXTERN int CeedOperatorGetNumArgs(CeedOperator op, CeedInt *num_args);
405 CEED_EXTERN int CeedOperatorIsSetupDone(CeedOperator op, bool *is_setup_done);
406 CEED_EXTERN int CeedOperatorGetQFunction(CeedOperator op, CeedQFunction *qf);
407 CEED_EXTERN int CeedOperatorIsComposite(CeedOperator op, bool *is_composite);
408 CEED_EXTERN int CeedOperatorGetData(CeedOperator op, void *data);
409 CEED_EXTERN int CeedOperatorSetData(CeedOperator op, void *data);
410 CEED_EXTERN int CeedOperatorReference(CeedOperator op);
411 CEED_EXTERN int CeedOperatorGetFallback(CeedOperator op, CeedOperator *op_fallback);
412 CEED_EXTERN int CeedOperatorGetFallbackParent(CeedOperator op, CeedOperator *parent);
413 CEED_EXTERN int CeedOperatorGetFallbackParentCeed(CeedOperator op, Ceed *parent);
414 CEED_EXTERN int CeedOperatorSetSetupDone(CeedOperator op);
415 
416 CEED_INTERN int CeedMatrixMatrixMultiply(Ceed ceed, const CeedScalar *mat_A, const CeedScalar *mat_B, CeedScalar *mat_C, CeedInt m, CeedInt n,
417                                          CeedInt kk);
418 CEED_EXTERN int CeedQRFactorization(Ceed ceed, CeedScalar *mat, CeedScalar *tau, CeedInt m, CeedInt n);
419 CEED_EXTERN int CeedHouseholderApplyQ(CeedScalar *mat_A, const CeedScalar *mat_Q, const CeedScalar *tau, CeedTransposeMode t_mode, CeedInt m,
420                                       CeedInt n, CeedInt k, CeedInt row, CeedInt col);
421 CEED_EXTERN int CeedSymmetricSchurDecomposition(Ceed ceed, CeedScalar *mat, CeedScalar *lambda, CeedInt n);
422 CEED_EXTERN int CeedSimultaneousDiagonalization(Ceed ceed, CeedScalar *mat_A, CeedScalar *mat_B, CeedScalar *x, CeedScalar *lambda, CeedInt n);
423 
424 #endif  // CEED_BACKEND_H
425