1ec3da8bcSJed Brown // Copyright (c) 2017, Lawrence Livermore National Security, LLC. Produced at 2ec3da8bcSJed Brown // the Lawrence Livermore National Laboratory. LLNL-CODE-734707. All Rights 3ec3da8bcSJed Brown // reserved. See files LICENSE and NOTICE for details. 4ec3da8bcSJed Brown // 5ec3da8bcSJed Brown // This file is part of CEED, a collection of benchmarks, miniapps, software 6ec3da8bcSJed Brown // libraries and APIs for efficient high-order finite element and spectral 7ec3da8bcSJed Brown // element discretizations for exascale applications. For more information and 8ec3da8bcSJed Brown // source code availability see http://github.com/ceed. 9ec3da8bcSJed Brown // 10ec3da8bcSJed Brown // The CEED research is supported by the Exascale Computing Project 17-SC-20-SC, 11ec3da8bcSJed Brown // a collaborative effort of two U.S. Department of Energy organizations (Office 12ec3da8bcSJed Brown // of Science and the National Nuclear Security Administration) responsible for 13ec3da8bcSJed Brown // the planning and preparation of a capable exascale ecosystem, including 14ec3da8bcSJed Brown // software, applications, hardware, advanced system engineering and early 15ec3da8bcSJed Brown // testbed platforms, in support of the nation's exascale computing imperative. 16ec3da8bcSJed Brown 17ec3da8bcSJed Brown /// @file 18ec3da8bcSJed Brown /// Public header for backend components of libCEED 19ec3da8bcSJed Brown #ifndef _ceed_backend_h 20ec3da8bcSJed Brown #define _ceed_backend_h 21ec3da8bcSJed Brown 22ec3da8bcSJed Brown #include <ceed/ceed.h> 23d0c91ce9Sjeremylt #include <limits.h> 24ec3da8bcSJed Brown #include <stdbool.h> 25ec3da8bcSJed Brown 26ec3da8bcSJed Brown #define CEED_INTERN CEED_EXTERN __attribute__((visibility ("hidden"))) 27ec3da8bcSJed Brown #define CEED_UNUSED __attribute__((unused)) 28ec3da8bcSJed Brown 29ec3da8bcSJed Brown #define CEED_MAX_RESOURCE_LEN 1024 30d0c91ce9Sjeremylt #define CEED_MAX_BACKEND_PRIORITY UINT_MAX 31ec3da8bcSJed Brown #define CEED_ALIGN 64 32ec3da8bcSJed Brown #define CEED_COMPOSITE_MAX 16 33ec3da8bcSJed Brown #define CEED_EPSILON 1E-16 34ec3da8bcSJed Brown 35ec3da8bcSJed Brown /// CEED_DEBUG_COLOR default value, forward CeedDebug* declarations & macros 36ec3da8bcSJed Brown #ifndef CEED_DEBUG_COLOR 37ec3da8bcSJed Brown #define CEED_DEBUG_COLOR 0 38ec3da8bcSJed Brown #endif 39ec3da8bcSJed Brown CEED_EXTERN void CeedDebugImpl(const Ceed,const char *,...); 40ec3da8bcSJed Brown CEED_EXTERN void CeedDebugImpl256(const Ceed,const unsigned char,const char *, 41ec3da8bcSJed Brown ...); 42ec3da8bcSJed Brown #define CeedDebug1(ceed,format, ...) CeedDebugImpl(ceed,format, ## __VA_ARGS__) 43ec3da8bcSJed Brown #define CeedDebug256(ceed,color, ...) CeedDebugImpl256(ceed,color, ## __VA_ARGS__) 44ec3da8bcSJed Brown #define CeedDebug(...) CeedDebug256(ceed,(unsigned char)CEED_DEBUG_COLOR, ## __VA_ARGS__) 45ec3da8bcSJed Brown 46ec3da8bcSJed Brown /// Handle for object handling TensorContraction 47ec3da8bcSJed Brown /// @ingroup CeedBasis 48ec3da8bcSJed Brown typedef struct CeedTensorContract_private *CeedTensorContract; 49ec3da8bcSJed Brown 50ec3da8bcSJed Brown /* In the next 3 functions, p has to be the address of a pointer type, i.e. p 51ec3da8bcSJed Brown has to be a pointer to a pointer. */ 52ec3da8bcSJed Brown CEED_INTERN int CeedMallocArray(size_t n, size_t unit, void *p); 53ec3da8bcSJed Brown CEED_INTERN int CeedCallocArray(size_t n, size_t unit, void *p); 54ec3da8bcSJed Brown CEED_INTERN int CeedReallocArray(size_t n, size_t unit, void *p); 55ec3da8bcSJed Brown CEED_INTERN int CeedFree(void *p); 56ec3da8bcSJed Brown 57ec3da8bcSJed Brown #define CeedChk(ierr) do { int ierr_ = ierr; if (ierr_) return ierr_; } while (0) 58ec3da8bcSJed Brown #define CeedChkBackend(ierr) do { int ierr_ = ierr; if (ierr_) { if (ierr_ > CEED_ERROR_SUCCESS) return CEED_ERROR_BACKEND; else return ierr_; } } while (0) 59ec3da8bcSJed Brown /* Note that CeedMalloc and CeedCalloc will, generally, return pointers with 60ec3da8bcSJed Brown different memory alignments: CeedMalloc returns pointers aligned at 61ec3da8bcSJed Brown CEED_ALIGN bytes, while CeedCalloc uses the alignment of calloc. */ 62ec3da8bcSJed Brown #define CeedMalloc(n, p) CeedMallocArray((n), sizeof(**(p)), p) 63ec3da8bcSJed Brown #define CeedCalloc(n, p) CeedCallocArray((n), sizeof(**(p)), p) 64ec3da8bcSJed Brown #define CeedRealloc(n, p) CeedReallocArray((n), sizeof(**(p)), p) 65ec3da8bcSJed Brown 66ec3da8bcSJed Brown /// Handle for object describing CeedQFunction fields 67ec3da8bcSJed Brown /// @ingroup CeedQFunctionBackend 68ec3da8bcSJed Brown typedef struct CeedQFunctionField_private *CeedQFunctionField; 69ec3da8bcSJed Brown /// Handle for object describing CeedOperator fields 70ec3da8bcSJed Brown /// @ingroup CeedOperatorBackend 71ec3da8bcSJed Brown typedef struct CeedOperatorField_private *CeedOperatorField; 72ec3da8bcSJed Brown 73ec3da8bcSJed Brown CEED_EXTERN int CeedRegister(const char *prefix, 74ec3da8bcSJed Brown int (*init)(const char *, Ceed), 75ec3da8bcSJed Brown unsigned int priority); 76ec3da8bcSJed Brown 77d1d35e2fSjeremylt CEED_EXTERN int CeedIsDebug(Ceed ceed, bool *is_debug); 78ec3da8bcSJed Brown CEED_EXTERN int CeedGetParent(Ceed ceed, Ceed *parent); 79ec3da8bcSJed Brown CEED_EXTERN int CeedGetDelegate(Ceed ceed, Ceed *delegate); 80ec3da8bcSJed Brown CEED_EXTERN int CeedSetDelegate(Ceed ceed, Ceed delegate); 81ec3da8bcSJed Brown CEED_EXTERN int CeedGetObjectDelegate(Ceed ceed, Ceed *delegate, 82d1d35e2fSjeremylt const char *obj_name); 83ec3da8bcSJed Brown CEED_EXTERN int CeedSetObjectDelegate(Ceed ceed, Ceed delegate, 84d1d35e2fSjeremylt const char *obj_name); 85ec3da8bcSJed Brown CEED_EXTERN int CeedGetOperatorFallbackResource(Ceed ceed, 86ec3da8bcSJed Brown const char **resource); 87ec3da8bcSJed Brown CEED_EXTERN int CeedSetOperatorFallbackResource(Ceed ceed, 88ec3da8bcSJed Brown const char *resource); 89ec3da8bcSJed Brown CEED_EXTERN int CeedGetOperatorFallbackParentCeed(Ceed ceed, Ceed *parent); 90d1d35e2fSjeremylt CEED_EXTERN int CeedSetDeterministic(Ceed ceed, bool is_deterministic); 91ec3da8bcSJed Brown CEED_EXTERN int CeedSetBackendFunction(Ceed ceed, 92ec3da8bcSJed Brown const char *type, void *object, 93d1d35e2fSjeremylt const char *func_name, int (*f)()); 94ec3da8bcSJed Brown CEED_EXTERN int CeedGetData(Ceed ceed, void *data); 95ec3da8bcSJed Brown CEED_EXTERN int CeedSetData(Ceed ceed, void *data); 96*9560d06aSjeremylt CEED_EXTERN int CeedReference(Ceed ceed); 97ec3da8bcSJed Brown 98ec3da8bcSJed Brown CEED_EXTERN int CeedVectorGetCeed(CeedVector vec, Ceed *ceed); 99ec3da8bcSJed Brown CEED_EXTERN int CeedVectorGetState(CeedVector vec, uint64_t *state); 100ec3da8bcSJed Brown CEED_EXTERN int CeedVectorAddReference(CeedVector vec); 101ec3da8bcSJed Brown CEED_EXTERN int CeedVectorGetData(CeedVector vec, void *data); 102ec3da8bcSJed Brown CEED_EXTERN int CeedVectorSetData(CeedVector vec, void *data); 103*9560d06aSjeremylt CEED_EXTERN int CeedVectorReference(CeedVector vec); 104ec3da8bcSJed Brown 105ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionGetCeed(CeedElemRestriction rstr, 106ec3da8bcSJed Brown Ceed *ceed); 107ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionGetStrides(CeedElemRestriction rstr, 108ec3da8bcSJed Brown CeedInt (*strides)[3]); 109ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionGetOffsets(CeedElemRestriction rstr, 110d1d35e2fSjeremylt CeedMemType mem_type, const CeedInt **offsets); 111ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionRestoreOffsets(CeedElemRestriction rstr, 112ec3da8bcSJed Brown const CeedInt **offsets); 113ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionIsStrided(CeedElemRestriction rstr, 114d1d35e2fSjeremylt bool *is_strided); 115ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionHasBackendStrides( CeedElemRestriction rstr, 116d1d35e2fSjeremylt bool *has_backend_strides); 117ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionGetELayout(CeedElemRestriction rstr, 118ec3da8bcSJed Brown CeedInt (*layout)[3]); 119ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionSetELayout(CeedElemRestriction rstr, 120ec3da8bcSJed Brown CeedInt layout[3]); 121ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionGetData(CeedElemRestriction rstr, 122ec3da8bcSJed Brown void *data); 123ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionSetData(CeedElemRestriction rstr, 124ec3da8bcSJed Brown void *data); 125*9560d06aSjeremylt CEED_EXTERN int CeedElemRestrictionReference(CeedElemRestriction rstr); 126ec3da8bcSJed Brown 127ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetCollocatedGrad(CeedBasis basis, 128d1d35e2fSjeremylt CeedScalar *colo_grad_1d); 129ec3da8bcSJed Brown CEED_EXTERN int CeedHouseholderApplyQ(CeedScalar *A, const CeedScalar *Q, 130d1d35e2fSjeremylt const CeedScalar *tau, CeedTransposeMode t_mode, CeedInt m, CeedInt n, 131ec3da8bcSJed Brown CeedInt k, CeedInt row, CeedInt col); 132ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetCeed(CeedBasis basis, Ceed *ceed); 133d1d35e2fSjeremylt CEED_EXTERN int CeedBasisIsTensor(CeedBasis basis, bool *is_tensor); 134ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetData(CeedBasis basis, void *data); 135ec3da8bcSJed Brown CEED_EXTERN int CeedBasisSetData(CeedBasis basis, void *data); 136*9560d06aSjeremylt CEED_EXTERN int CeedBasisReference(CeedBasis basis); 137ec3da8bcSJed Brown 138ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetTopologyDimension(CeedElemTopology topo, 139ec3da8bcSJed Brown CeedInt *dim); 140ec3da8bcSJed Brown 141ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetTensorContract(CeedBasis basis, 142ec3da8bcSJed Brown CeedTensorContract *contract); 143ec3da8bcSJed Brown CEED_EXTERN int CeedBasisSetTensorContract(CeedBasis basis, 14434359f16Sjeremylt CeedTensorContract contract); 145ec3da8bcSJed Brown CEED_EXTERN int CeedTensorContractCreate(Ceed ceed, CeedBasis basis, 146ec3da8bcSJed Brown CeedTensorContract *contract); 147ec3da8bcSJed Brown CEED_EXTERN int CeedTensorContractApply(CeedTensorContract contract, CeedInt A, 148ec3da8bcSJed Brown CeedInt B, CeedInt C, CeedInt J, 149ec3da8bcSJed Brown const CeedScalar *__restrict__ t, 150d1d35e2fSjeremylt CeedTransposeMode t_mode, 151ec3da8bcSJed Brown const CeedInt Add, 152ec3da8bcSJed Brown const CeedScalar *__restrict__ u, 153ec3da8bcSJed Brown CeedScalar *__restrict__ v); 154ec3da8bcSJed Brown CEED_EXTERN int CeedTensorContractGetCeed(CeedTensorContract contract, 155ec3da8bcSJed Brown Ceed *ceed); 156ec3da8bcSJed Brown CEED_EXTERN int CeedTensorContractGetData(CeedTensorContract contract, 157ec3da8bcSJed Brown void *data); 158ec3da8bcSJed Brown CEED_EXTERN int CeedTensorContractSetData(CeedTensorContract contract, 159ec3da8bcSJed Brown void *data); 160*9560d06aSjeremylt CEED_EXTERN int CeedTensorContractReference(CeedTensorContract contract); 161ec3da8bcSJed Brown CEED_EXTERN int CeedTensorContractDestroy(CeedTensorContract *contract); 162ec3da8bcSJed Brown 163ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionRegister(const char *, const char *, CeedInt, 164ec3da8bcSJed Brown CeedQFunctionUser, int (*init)(Ceed, const char *, CeedQFunction)); 165ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionSetFortranStatus(CeedQFunction qf, bool status); 166ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionGetCeed(CeedQFunction qf, Ceed *ceed); 167ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionGetVectorLength(CeedQFunction qf, 168d1d35e2fSjeremylt CeedInt *vec_length); 169ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionGetNumArgs(CeedQFunction qf, 170d1d35e2fSjeremylt CeedInt *num_input_fields, 171d1d35e2fSjeremylt CeedInt *num_output_fields); 172ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionGetSourcePath(CeedQFunction qf, char **source); 173ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionGetUserFunction(CeedQFunction qf, 174ec3da8bcSJed Brown CeedQFunctionUser *f); 175ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionGetContext(CeedQFunction qf, 176ec3da8bcSJed Brown CeedQFunctionContext *ctx); 177ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionGetInnerContext(CeedQFunction qf, 178ec3da8bcSJed Brown CeedQFunctionContext *ctx); 179d1d35e2fSjeremylt CEED_EXTERN int CeedQFunctionIsIdentity(CeedQFunction qf, bool *is_identity); 180ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionGetData(CeedQFunction qf, void *data); 181ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionSetData(CeedQFunction qf, void *data); 182*9560d06aSjeremylt CEED_EXTERN int CeedQFunctionReference(CeedQFunction qf); 183ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionGetFields(CeedQFunction qf, 184d1d35e2fSjeremylt CeedQFunctionField **input_fields, 185d1d35e2fSjeremylt CeedQFunctionField **output_fields); 186d1d35e2fSjeremylt CEED_EXTERN int CeedQFunctionFieldGetName(CeedQFunctionField qf_field, 187d1d35e2fSjeremylt char **field_name); 188d1d35e2fSjeremylt CEED_EXTERN int CeedQFunctionFieldGetSize(CeedQFunctionField qf_field, 189ec3da8bcSJed Brown CeedInt *size); 190d1d35e2fSjeremylt CEED_EXTERN int CeedQFunctionFieldGetEvalMode(CeedQFunctionField qf_field, 191d1d35e2fSjeremylt CeedEvalMode *eval_mode); 192ec3da8bcSJed Brown 193ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionContextGetCeed(CeedQFunctionContext cxt, 194ec3da8bcSJed Brown Ceed *ceed); 195ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionContextGetState(CeedQFunctionContext ctx, 196ec3da8bcSJed Brown uint64_t *state); 197ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionContextGetContextSize(CeedQFunctionContext ctx, 198d1d35e2fSjeremylt size_t *ctx_size); 199ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionContextGetBackendData(CeedQFunctionContext ctx, 200ec3da8bcSJed Brown void *data); 201ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionContextSetBackendData(CeedQFunctionContext ctx, 202ec3da8bcSJed Brown void *data); 203*9560d06aSjeremylt CEED_EXTERN int CeedQFunctionContextReference(CeedQFunctionContext ctx); 204ec3da8bcSJed Brown 205ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorGetCeed(CeedOperator op, Ceed *ceed); 206d1d35e2fSjeremylt CEED_EXTERN int CeedOperatorGetNumElements(CeedOperator op, CeedInt *num_elem); 207ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorGetNumQuadraturePoints(CeedOperator op, 208ec3da8bcSJed Brown CeedInt *numqpts); 209d1d35e2fSjeremylt CEED_EXTERN int CeedOperatorGetNumArgs(CeedOperator op, CeedInt *num_args); 210d1d35e2fSjeremylt CEED_EXTERN int CeedOperatorIsSetupDone(CeedOperator op, bool *is_setup_done); 211ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorGetQFunction(CeedOperator op, CeedQFunction *qf); 212d1d35e2fSjeremylt CEED_EXTERN int CeedOperatorIsComposite(CeedOperator op, bool *is_composite); 213d1d35e2fSjeremylt CEED_EXTERN int CeedOperatorGetNumSub(CeedOperator op, CeedInt *num_suboperators); 214ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorGetSubList(CeedOperator op, 215d1d35e2fSjeremylt CeedOperator **sub_operators); 216ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorGetData(CeedOperator op, void *data); 217ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorSetData(CeedOperator op, void *data); 218*9560d06aSjeremylt CEED_EXTERN int CeedOperatorReference(CeedOperator op); 219ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorSetSetupDone(CeedOperator op); 220ec3da8bcSJed Brown 221ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorGetFields(CeedOperator op, 222d1d35e2fSjeremylt CeedOperatorField **input_fields, 223d1d35e2fSjeremylt CeedOperatorField **output_fields); 224d1d35e2fSjeremylt CEED_EXTERN int CeedOperatorFieldGetElemRestriction(CeedOperatorField op_field, 225ec3da8bcSJed Brown CeedElemRestriction *rstr); 226d1d35e2fSjeremylt CEED_EXTERN int CeedOperatorFieldGetBasis(CeedOperatorField op_field, 227ec3da8bcSJed Brown CeedBasis *basis); 228d1d35e2fSjeremylt CEED_EXTERN int CeedOperatorFieldGetVector(CeedOperatorField op_field, 229ec3da8bcSJed Brown CeedVector *vec); 230ec3da8bcSJed Brown 231d1d35e2fSjeremylt CEED_INTERN int CeedMatrixMultiply(Ceed ceed, const CeedScalar *mat_A, 232d1d35e2fSjeremylt const CeedScalar *mat_B, CeedScalar *mat_C, 233ec3da8bcSJed Brown CeedInt m, CeedInt n, CeedInt kk); 234ec3da8bcSJed Brown 235ec3da8bcSJed Brown #endif 236