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