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 CEED_INTERN int CeedSetHostBoolArray(const bool *source_array, CeedCopyMode copy_mode, CeedSize num_values, const bool **target_array_owned, 185 const bool **target_array_borrowed, const bool **target_array); 186 CEED_INTERN int CeedSetHostCeedInt8Array(const CeedInt8 *source_array, CeedCopyMode copy_mode, CeedSize num_values, 187 const CeedInt8 **target_array_owned, const CeedInt8 **target_array_borrowed, const CeedInt8 **target_array); 188 CEED_INTERN int CeedSetHostCeedIntArray(const CeedInt *source_array, CeedCopyMode copy_mode, CeedSize num_values, const CeedInt **target_array_owned, 189 const CeedInt **target_array_borrowed, const CeedInt **target_array); 190 CEED_INTERN int CeedSetHostCeedScalarArray(const CeedScalar *source_array, CeedCopyMode copy_mode, CeedSize num_values, 191 const CeedScalar **target_array_owned, const CeedScalar **target_array_borrowed, 192 const CeedScalar **target_array); 193 194 /** 195 @brief Calls a libCEED function and then checks the resulting error code. 196 If the error code is non-zero, then the error handler is called and the call from the current function with the error code. 197 198 @ref Developer 199 **/ 200 #define CeedCall(...) \ 201 do { \ 202 int ierr_ = __VA_ARGS__; \ 203 if (ierr_) return ierr_; \ 204 } while (0) 205 206 /** 207 @brief Calls a libCEED function and then checks the resulting error code. 208 If the error code is non-zero, then the error handler is called and the call from the current function with the error code. 209 All interface level error codes are upgraded to `CEED_ERROR_BACKEND`. 210 211 @ref Developer 212 **/ 213 #define CeedCallBackend(...) \ 214 do { \ 215 int ierr_ = __VA_ARGS__; \ 216 if (ierr_) return (ierr_ > CEED_ERROR_SUCCESS) ? CEED_ERROR_BACKEND : ierr_; \ 217 } while (0) 218 219 /** 220 @brief Check that a particular condition is true and returns a `CeedError` if not. 221 222 @ref Developer 223 **/ 224 #define CeedCheck(cond, ceed, ecode, ...) \ 225 do { \ 226 if (!(cond)) return CeedError(ceed, ecode, __VA_ARGS__); \ 227 } while (0) 228 229 /* Note that CeedMalloc and CeedCalloc will, generally, return pointers with different memory alignments: 230 CeedMalloc returns pointers aligned at CEED_ALIGN bytes, while CeedCalloc uses the alignment of calloc. */ 231 #define CeedMalloc(n, p) CeedMallocArray((n), sizeof(**(p)), p) 232 #define CeedCalloc(n, p) CeedCallocArray((n), sizeof(**(p)), p) 233 #define CeedRealloc(n, p) CeedReallocArray((n), sizeof(**(p)), p) 234 235 /* Allows calling CeedSetBackendFunctionImpl using incompatible pointer types */ 236 #define CeedSetBackendFunction(ceed, type, object, func_name, f) CeedSetBackendFunctionImpl(ceed, type, object, func_name, (void (*)(void))f) 237 238 CEED_EXTERN int CeedRegister(const char *prefix, int (*init)(const char *, Ceed), unsigned int priority); 239 CEED_EXTERN int CeedRegisterImpl(const char *prefix, int (*init)(const char *, Ceed), unsigned int priority); 240 241 CEED_EXTERN int CeedIsDebug(Ceed ceed, bool *is_debug); 242 CEED_EXTERN int CeedGetResourceRoot(Ceed ceed, const char *resource, const char *delineator, char **resource_root); 243 CEED_EXTERN int CeedGetParent(Ceed ceed, Ceed *parent); 244 CEED_EXTERN int CeedGetDelegate(Ceed ceed, Ceed *delegate); 245 CEED_EXTERN int CeedSetDelegate(Ceed ceed, Ceed delegate); 246 CEED_EXTERN int CeedGetObjectDelegate(Ceed ceed, Ceed *delegate, const char *obj_name); 247 CEED_EXTERN int CeedSetObjectDelegate(Ceed ceed, Ceed delegate, const char *obj_name); 248 CEED_EXTERN int CeedGetOperatorFallbackResource(Ceed ceed, const char **resource); 249 CEED_EXTERN int CeedGetOperatorFallbackCeed(Ceed ceed, Ceed *fallback_ceed); 250 CEED_EXTERN int CeedSetOperatorFallbackResource(Ceed ceed, const char *resource); 251 CEED_EXTERN int CeedSetDeterministic(Ceed ceed, bool is_deterministic); 252 CEED_EXTERN int CeedSetBackendFunctionImpl(Ceed ceed, const char *type, void *object, const char *func_name, void (*f)(void)); 253 CEED_EXTERN int CeedGetData(Ceed ceed, void *data); 254 CEED_EXTERN int CeedSetData(Ceed ceed, void *data); 255 CEED_EXTERN int CeedReference(Ceed ceed); 256 257 CEED_EXTERN int CeedVectorHasValidArray(CeedVector vec, bool *has_valid_array); 258 CEED_EXTERN int CeedVectorHasBorrowedArrayOfType(CeedVector vec, CeedMemType mem_type, bool *has_borrowed_array_of_type); 259 CEED_EXTERN int CeedVectorHasValidArray(CeedVector vec, bool *has_valid_array); 260 CEED_EXTERN int CeedVectorGetState(CeedVector vec, uint64_t *state); 261 CEED_EXTERN int CeedVectorGetData(CeedVector vec, void *data); 262 CEED_EXTERN int CeedVectorSetData(CeedVector vec, void *data); 263 CEED_EXTERN int CeedVectorReference(CeedVector vec); 264 265 /// Type of element restriction; 266 /// @ingroup CeedElemRestriction 267 typedef enum { 268 /// Standard element restriction with offsets 269 CEED_RESTRICTION_STANDARD = 1, 270 /// Oriented element restriction 271 CEED_RESTRICTION_ORIENTED = 2, 272 /// Curl-oriented element restriction 273 CEED_RESTRICTION_CURL_ORIENTED = 3, 274 /// Strided element restriction 275 CEED_RESTRICTION_STRIDED = 4, 276 /// Point-in-cell element restriction 277 CEED_RESTRICTION_POINTS = 5, 278 } CeedRestrictionType; 279 280 CEED_EXTERN int CeedElemRestrictionGetType(CeedElemRestriction rstr, CeedRestrictionType *rstr_type); 281 CEED_EXTERN int CeedElemRestrictionIsStrided(CeedElemRestriction rstr, bool *is_strided); 282 CEED_EXTERN int CeedElemRestrictionIsPoints(CeedElemRestriction rstr, bool *is_points); 283 CEED_EXTERN int CeedElemRestrictionAtPointsAreCompatible(CeedElemRestriction rstr_a, CeedElemRestriction rstr_b, bool *are_compatible); 284 CEED_EXTERN int CeedElemRestrictionGetStrides(CeedElemRestriction rstr, CeedInt strides[3]); 285 CEED_EXTERN int CeedElemRestrictionHasBackendStrides(CeedElemRestriction rstr, bool *has_backend_strides); 286 CEED_EXTERN int CeedElemRestrictionGetOffsets(CeedElemRestriction rstr, CeedMemType mem_type, const CeedInt **offsets); 287 CEED_EXTERN int CeedElemRestrictionRestoreOffsets(CeedElemRestriction rstr, const CeedInt **offsets); 288 CEED_EXTERN int CeedElemRestrictionGetOrientations(CeedElemRestriction rstr, CeedMemType mem_type, const bool **orients); 289 CEED_EXTERN int CeedElemRestrictionRestoreOrientations(CeedElemRestriction rstr, const bool **orients); 290 CEED_EXTERN int CeedElemRestrictionGetCurlOrientations(CeedElemRestriction rstr, CeedMemType mem_type, const CeedInt8 **curl_orients); 291 CEED_EXTERN int CeedElemRestrictionRestoreCurlOrientations(CeedElemRestriction rstr, const CeedInt8 **curl_orients); 292 CEED_EXTERN int CeedElemRestrictionGetLLayout(CeedElemRestriction rstr, CeedInt layout[3]); 293 CEED_EXTERN int CeedElemRestrictionSetLLayout(CeedElemRestriction rstr, CeedInt layout[3]); 294 CEED_EXTERN int CeedElemRestrictionGetELayout(CeedElemRestriction rstr, CeedInt layout[3]); 295 CEED_EXTERN int CeedElemRestrictionSetELayout(CeedElemRestriction rstr, CeedInt layout[3]); 296 CEED_EXTERN int CeedElemRestrictionGetData(CeedElemRestriction rstr, void *data); 297 CEED_EXTERN int CeedElemRestrictionSetData(CeedElemRestriction rstr, void *data); 298 CEED_EXTERN int CeedElemRestrictionReference(CeedElemRestriction rstr); 299 CEED_EXTERN int CeedElemRestrictionGetFlopsEstimate(CeedElemRestriction rstr, CeedTransposeMode t_mode, CeedSize *flops); 300 301 /// Type of FE space; 302 /// @ingroup CeedBasis 303 typedef enum { 304 /// H^1 FE space 305 CEED_FE_SPACE_H1 = 1, 306 /// H(div) FE space 307 CEED_FE_SPACE_HDIV = 2, 308 /// H(curl) FE space 309 CEED_FE_SPACE_HCURL = 3, 310 } CeedFESpace; 311 CEED_EXTERN const char *const CeedFESpaces[]; 312 313 CEED_EXTERN int CeedBasisGetCollocatedGrad(CeedBasis basis, CeedScalar *colo_grad_1d); 314 CEED_EXTERN int CeedBasisIsTensor(CeedBasis basis, bool *is_tensor); 315 CEED_EXTERN int CeedBasisGetData(CeedBasis basis, void *data); 316 CEED_EXTERN int CeedBasisSetData(CeedBasis basis, void *data); 317 CEED_EXTERN int CeedBasisReference(CeedBasis basis); 318 CEED_EXTERN int CeedBasisGetNumQuadratureComponents(CeedBasis basis, CeedEvalMode eval_mode, CeedInt *q_comp); 319 CEED_EXTERN int CeedBasisGetFlopsEstimate(CeedBasis basis, CeedTransposeMode t_mode, CeedEvalMode eval_mode, CeedSize *flops); 320 CEED_EXTERN int CeedBasisGetFESpace(CeedBasis basis, CeedFESpace *fe_space); 321 CEED_EXTERN int CeedBasisGetTopologyDimension(CeedElemTopology topo, CeedInt *dim); 322 CEED_EXTERN int CeedBasisGetTensorContract(CeedBasis basis, CeedTensorContract *contract); 323 CEED_EXTERN int CeedBasisSetTensorContract(CeedBasis basis, CeedTensorContract contract); 324 325 CEED_EXTERN int CeedTensorContractCreate(Ceed ceed, CeedTensorContract *contract); 326 CEED_EXTERN int CeedTensorContractApply(CeedTensorContract contract, CeedInt A, CeedInt B, CeedInt C, CeedInt J, const CeedScalar *__restrict__ t, 327 CeedTransposeMode t_mode, const CeedInt Add, const CeedScalar *__restrict__ u, CeedScalar *__restrict__ v); 328 CEED_EXTERN int CeedTensorContractStridedApply(CeedTensorContract contract, CeedInt A, CeedInt B, CeedInt C, CeedInt D, CeedInt J, 329 const CeedScalar *__restrict__ t, CeedTransposeMode t_mode, const CeedInt add, 330 const CeedScalar *__restrict__ u, CeedScalar *__restrict__ v); 331 CEED_EXTERN int CeedTensorContractGetCeed(CeedTensorContract contract, Ceed *ceed); 332 CEED_EXTERN Ceed CeedTensorContractReturnCeed(CeedTensorContract contract); 333 CEED_EXTERN int CeedTensorContractGetData(CeedTensorContract contract, void *data); 334 CEED_EXTERN int CeedTensorContractSetData(CeedTensorContract contract, void *data); 335 CEED_EXTERN int CeedTensorContractReference(CeedTensorContract contract); 336 CEED_EXTERN int CeedTensorContractReferenceCopy(CeedTensorContract tensor, CeedTensorContract *tensor_copy); 337 CEED_EXTERN int CeedTensorContractDestroy(CeedTensorContract *contract); 338 339 CEED_EXTERN int CeedQFunctionRegister(const char *name, const char *source, CeedInt vec_length, CeedQFunctionUser f, 340 int (*init)(Ceed, const char *, CeedQFunction)); 341 CEED_EXTERN int CeedQFunctionSetFortranStatus(CeedQFunction qf, bool status); 342 CEED_EXTERN int CeedQFunctionGetVectorLength(CeedQFunction qf, CeedInt *vec_length); 343 CEED_EXTERN int CeedQFunctionGetNumArgs(CeedQFunction qf, CeedInt *num_input_fields, CeedInt *num_output_fields); 344 CEED_EXTERN int CeedQFunctionGetKernelName(CeedQFunction qf, const char **kernel_name); 345 CEED_EXTERN int CeedQFunctionGetSourcePath(CeedQFunction qf, const char **source_path); 346 CEED_EXTERN int CeedQFunctionLoadSourceToBuffer(CeedQFunction qf, const char **source_buffer); 347 CEED_EXTERN int CeedQFunctionGetUserFunction(CeedQFunction qf, CeedQFunctionUser *f); 348 CEED_EXTERN int CeedQFunctionGetContext(CeedQFunction qf, CeedQFunctionContext *ctx); 349 CEED_EXTERN int CeedQFunctionGetContextData(CeedQFunction qf, CeedMemType mem_type, void *data); 350 CEED_EXTERN int CeedQFunctionRestoreContextData(CeedQFunction qf, void *data); 351 CEED_EXTERN int CeedQFunctionGetInnerContext(CeedQFunction qf, CeedQFunctionContext *ctx); 352 CEED_EXTERN int CeedQFunctionGetInnerContextData(CeedQFunction qf, CeedMemType mem_type, void *data); 353 CEED_EXTERN int CeedQFunctionRestoreInnerContextData(CeedQFunction qf, void *data); 354 CEED_EXTERN int CeedQFunctionIsIdentity(CeedQFunction qf, bool *is_identity); 355 CEED_EXTERN int CeedQFunctionIsContextWritable(CeedQFunction qf, bool *is_writable); 356 CEED_EXTERN int CeedQFunctionGetData(CeedQFunction qf, void *data); 357 CEED_EXTERN int CeedQFunctionSetData(CeedQFunction qf, void *data); 358 CEED_EXTERN int CeedQFunctionIsImmutable(CeedQFunction qf, bool *is_immutable); 359 CEED_EXTERN int CeedQFunctionSetImmutable(CeedQFunction qf); 360 CEED_EXTERN int CeedQFunctionReference(CeedQFunction qf); 361 CEED_EXTERN int CeedQFunctionGetFlopsEstimate(CeedQFunction qf, CeedSize *flops); 362 363 CEED_EXTERN int CeedQFunctionContextGetCeed(CeedQFunctionContext ctx, Ceed *ceed); 364 CEED_EXTERN Ceed CeedQFunctionContextReturnCeed(CeedQFunctionContext ctx); 365 CEED_EXTERN int CeedQFunctionContextHasValidData(CeedQFunctionContext ctx, bool *has_valid_data); 366 CEED_EXTERN int CeedQFunctionContextHasBorrowedDataOfType(CeedQFunctionContext ctx, CeedMemType mem_type, bool *has_borrowed_data_of_type); 367 CEED_EXTERN int CeedQFunctionContextGetState(CeedQFunctionContext ctx, uint64_t *state); 368 CEED_EXTERN int CeedQFunctionContextGetBackendData(CeedQFunctionContext ctx, void *data); 369 CEED_EXTERN int CeedQFunctionContextSetBackendData(CeedQFunctionContext ctx, void *data); 370 CEED_EXTERN int CeedQFunctionContextGetFieldLabel(CeedQFunctionContext ctx, const char *field_name, CeedContextFieldLabel *field_label); 371 CEED_EXTERN int CeedQFunctionContextSetGeneric(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, CeedContextFieldType field_type, 372 void *value); 373 CEED_EXTERN int CeedQFunctionContextGetGenericRead(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, CeedContextFieldType field_type, 374 size_t *num_values, void *value); 375 CEED_EXTERN int CeedQFunctionContextRestoreGenericRead(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, CeedContextFieldType field_type, 376 void *value); 377 CEED_EXTERN int CeedQFunctionContextSetDouble(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, double *values); 378 CEED_EXTERN int CeedQFunctionContextGetDoubleRead(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, size_t *num_values, 379 const double **values); 380 CEED_EXTERN int CeedQFunctionContextRestoreDoubleRead(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, const double **values); 381 CEED_EXTERN int CeedQFunctionContextSetInt32(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, int32_t *values); 382 CEED_EXTERN int CeedQFunctionContextGetInt32Read(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, size_t *num_values, 383 const int32_t **values); 384 CEED_EXTERN int CeedQFunctionContextRestoreInt32Read(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, const int32_t **values); 385 CEED_EXTERN int CeedQFunctionContextSetBoolean(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, bool *values); 386 CEED_EXTERN int CeedQFunctionContextGetBooleanRead(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, size_t *num_values, 387 const bool **values); 388 CEED_EXTERN int CeedQFunctionContextRestoreBooleanRead(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, const bool **values); 389 CEED_EXTERN int CeedQFunctionContextGetDataDestroy(CeedQFunctionContext ctx, CeedMemType *f_mem_type, CeedQFunctionContextDataDestroyUser *f); 390 CEED_EXTERN int CeedQFunctionContextReference(CeedQFunctionContext ctx); 391 392 CEED_EXTERN int CeedOperatorGetBasisPointer(CeedBasis basis, CeedEvalMode eval_mode, const CeedScalar *identity, const CeedScalar **basis_ptr); 393 CEED_EXTERN int CeedOperatorCreateActivePointBlockRestriction(CeedElemRestriction rstr, CeedElemRestriction *pointblock_rstr); 394 CEED_EXTERN int CeedQFunctionAssemblyDataCreate(Ceed ceed, CeedQFunctionAssemblyData *data); 395 CEED_EXTERN int CeedQFunctionAssemblyDataReference(CeedQFunctionAssemblyData data); 396 CEED_EXTERN int CeedQFunctionAssemblyDataSetReuse(CeedQFunctionAssemblyData data, bool reuse_assembly_data); 397 CEED_EXTERN int CeedQFunctionAssemblyDataSetUpdateNeeded(CeedQFunctionAssemblyData data, bool needs_data_update); 398 CEED_EXTERN int CeedQFunctionAssemblyDataIsUpdateNeeded(CeedQFunctionAssemblyData data, bool *is_update_needed); 399 CEED_EXTERN int CeedQFunctionAssemblyDataReferenceCopy(CeedQFunctionAssemblyData data, CeedQFunctionAssemblyData *data_copy); 400 CEED_EXTERN int CeedQFunctionAssemblyDataIsSetup(CeedQFunctionAssemblyData data, bool *is_setup); 401 CEED_EXTERN int CeedQFunctionAssemblyDataSetObjects(CeedQFunctionAssemblyData data, CeedVector vec, CeedElemRestriction rstr); 402 CEED_EXTERN int CeedQFunctionAssemblyDataGetObjects(CeedQFunctionAssemblyData data, CeedVector *vec, CeedElemRestriction *rstr); 403 CEED_EXTERN int CeedQFunctionAssemblyDataDestroy(CeedQFunctionAssemblyData *data); 404 405 CEED_EXTERN int CeedOperatorAssemblyDataCreate(Ceed ceed, CeedOperator op, CeedOperatorAssemblyData *data); 406 CEED_EXTERN int CeedOperatorAssemblyDataGetEvalModes(CeedOperatorAssemblyData data, CeedInt *num_active_bases_in, CeedInt **num_eval_modes_in, 407 const CeedEvalMode ***eval_modes_in, CeedSize ***eval_mode_offsets_in, 408 CeedInt *num_active_bases_out, CeedInt **num_eval_modes_out, 409 const CeedEvalMode ***eval_modes_out, CeedSize ***eval_mode_offsets_out, 410 CeedSize *num_output_components); 411 CEED_EXTERN int CeedOperatorAssemblyDataGetBases(CeedOperatorAssemblyData data, CeedInt *num_active_bases_in, CeedBasis **active_bases_in, 412 const CeedScalar ***assembled_bases_in, CeedInt *num_active_bases_out, CeedBasis **active_bases_out, 413 const CeedScalar ***assembled_bases_out); 414 CEED_EXTERN int CeedOperatorAssemblyDataGetElemRestrictions(CeedOperatorAssemblyData data, CeedInt *num_active_elem_rstrs_in, 415 CeedElemRestriction **active_elem_rstrs_in, CeedInt *num_active_elem_rstrs_out, 416 CeedElemRestriction **active_elem_rstrs_out); 417 CEED_EXTERN int CeedOperatorAssemblyDataDestroy(CeedOperatorAssemblyData *data); 418 419 CEED_EXTERN int CeedOperatorGetOperatorAssemblyData(CeedOperator op, CeedOperatorAssemblyData *data); 420 CEED_EXTERN int CeedOperatorGetActiveBasis(CeedOperator op, CeedBasis *active_basis); 421 CEED_EXTERN int CeedOperatorGetActiveBases(CeedOperator op, CeedBasis *active_input_basis, CeedBasis *active_output_basis); 422 CEED_EXTERN int CeedOperatorGetActiveElemRestriction(CeedOperator op, CeedElemRestriction *active_rstr); 423 CEED_EXTERN int CeedOperatorGetActiveElemRestrictions(CeedOperator op, CeedElemRestriction *active_input_rstr, 424 CeedElemRestriction *active_output_rstr); 425 CEED_EXTERN int CeedOperatorGetNumArgs(CeedOperator op, CeedInt *num_args); 426 CEED_EXTERN int CeedOperatorHasTensorBases(CeedOperator op, bool *has_tensor_bases); 427 CEED_EXTERN int CeedOperatorIsImmutable(CeedOperator op, bool *is_immutable); 428 CEED_EXTERN int CeedOperatorIsSetupDone(CeedOperator op, bool *is_setup_done); 429 CEED_EXTERN int CeedOperatorGetQFunction(CeedOperator op, CeedQFunction *qf); 430 CEED_EXTERN int CeedOperatorIsComposite(CeedOperator op, bool *is_composite); 431 CEED_EXTERN int CeedOperatorGetData(CeedOperator op, void *data); 432 CEED_EXTERN int CeedOperatorSetData(CeedOperator op, void *data); 433 CEED_EXTERN int CeedOperatorReference(CeedOperator op); 434 CEED_EXTERN int CeedOperatorGetFallback(CeedOperator op, CeedOperator *op_fallback); 435 CEED_EXTERN int CeedOperatorGetFallbackParent(CeedOperator op, CeedOperator *parent); 436 CEED_EXTERN int CeedOperatorGetFallbackParentCeed(CeedOperator op, Ceed *parent); 437 CEED_EXTERN int CeedOperatorSetSetupDone(CeedOperator op); 438 439 CEED_INTERN int CeedMatrixMatrixMultiply(Ceed ceed, const CeedScalar *mat_A, const CeedScalar *mat_B, CeedScalar *mat_C, CeedInt m, CeedInt n, 440 CeedInt kk); 441 CEED_EXTERN int CeedQRFactorization(Ceed ceed, CeedScalar *mat, CeedScalar *tau, CeedInt m, CeedInt n); 442 CEED_EXTERN int CeedHouseholderApplyQ(CeedScalar *mat_A, const CeedScalar *mat_Q, const CeedScalar *tau, CeedTransposeMode t_mode, CeedInt m, 443 CeedInt n, CeedInt k, CeedInt row, CeedInt col); 444 CEED_EXTERN int CeedMatrixPseudoinverse(Ceed ceed, const CeedScalar *mat, CeedInt m, CeedInt n, CeedScalar *mat_pinv); 445 CEED_EXTERN int CeedSymmetricSchurDecomposition(Ceed ceed, CeedScalar *mat, CeedScalar *lambda, CeedInt n); 446 CEED_EXTERN int CeedSimultaneousDiagonalization(Ceed ceed, CeedScalar *mat_A, CeedScalar *mat_B, CeedScalar *x, CeedScalar *lambda, CeedInt n); 447 448 #endif // CEED_BACKEND_H 449