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