1 /// Copyright (c) 2017, Lawrence Livermore National Security, LLC. Produced at 2 /// the Lawrence Livermore National Laboratory. LLNL-CODE-734707. All Rights 3 /// reserved. See files LICENSE and NOTICE for details. 4 /// 5 /// This file is part of CEED, a collection of benchmarks, miniapps, software 6 /// libraries and APIs for efficient high-order finite element and spectral 7 /// element discretizations for exascale applications. For more information and 8 /// source code availability see http://github.com/ceed 9 /// 10 /// The CEED research is supported by the Exascale Computing Project 17-SC-20-SC, 11 /// a collaborative effort of two U.S. Department of Energy organizations (Office 12 /// of Science and the National Nuclear Security Administration) responsible for 13 /// the planning and preparation of a capable exascale ecosystem, including 14 /// software, applications, hardware, advanced system engineering and early 15 /// testbed platforms, in support of the nation's exascale computing imperative. 16 17 /// @file 18 /// Public header for user and utility components of libCEED 19 #ifndef _ceed_h 20 #define _ceed_h 21 22 /// @defgroup Ceed Ceed: core components 23 /// @defgroup CeedVector CeedVector: storing and manipulating vectors 24 /// @defgroup CeedElemRestriction CeedElemRestriction: restriction from local vectors to elements 25 /// @defgroup CeedBasis CeedBasis: fully discrete finite element-like objects 26 /// @defgroup CeedQFunction CeedQFunction: independent operations at quadrature points 27 /// @defgroup CeedOperator CeedOperator: composed FE-type operations on vectors 28 /// 29 /// @page FunctionCategories libCEED: Types of Functions 30 /// libCEED provides three different header files depending upon the type of 31 /// functions a user requires. 32 /// @section Utility Utility Functions 33 /// These functions are intended general utilities that may be useful to 34 /// libCEED developers and users. These functions can generally be found in 35 /// "ceed.h". 36 /// @section User User Functions 37 /// These functions are intended to be used by general users of libCEED 38 /// and can generally be found in "ceed.h". 39 /// @section Advanced Advanced Functions 40 /// These functions are intended to be used by advanced users of libCEED 41 /// and can generally be found in "ceed.h". 42 /// @section Backend Backend Developer Functions 43 /// These functions are intended to be used by backend developers of 44 /// libCEED and can generally be found in "ceed-backend.h". 45 /// @section Developer Library Developer Functions 46 /// These functions are intended to be used by library developers of 47 /// libCEED and can generally be found in "ceed-impl.h". 48 49 #if !defined(CEED_SKIP_VISIBILITY) 50 #define CEED_VISIBILITY(mode) __attribute__((visibility(#mode))) 51 #else 52 #define CEED_VISIBILITY(mode) 53 #endif 54 55 /** 56 CEED_EXTERN is used in this header to denote all publicly visible symbols. 57 58 No other file should declare publicly visible symbols, thus it should never be 59 used outside ceed.h. 60 */ 61 #if defined(__clang_analyzer__) 62 #define CEED_EXTERN extern 63 #elif defined(__cplusplus) 64 #define CEED_EXTERN extern "C" CEED_VISIBILITY(default) 65 #else 66 #define CEED_EXTERN extern CEED_VISIBILITY(default) 67 #endif 68 69 #include <stdarg.h> 70 #include <stdbool.h> 71 #include <stdio.h> 72 73 /// Typedefs and macros used in public interfaces and user QFunction source 74 #include "types.h" 75 76 /// Library context created by CeedInit() 77 /// @ingroup CeedUser 78 typedef struct Ceed_private *Ceed; 79 /// Non-blocking Ceed interfaces return a CeedRequest. 80 /// To perform an operation immediately, pass \ref CEED_REQUEST_IMMEDIATE instead. 81 /// @ingroup CeedUser 82 typedef struct CeedRequest_private *CeedRequest; 83 /// Handle for vectors over the field \ref CeedScalar 84 /// @ingroup CeedVectorUser 85 typedef struct CeedVector_private *CeedVector; 86 /// Handle for object describing restriction to elements 87 /// @ingroup CeedElemRestrictionUser 88 typedef struct CeedElemRestriction_private *CeedElemRestriction; 89 /// Handle for object describing discrete finite element evaluations 90 /// @ingroup CeedBasisUser 91 typedef struct CeedBasis_private *CeedBasis; 92 /// Handle for object describing CeedQFunction fields 93 /// @ingroup CeedQFunctionBackend 94 typedef struct CeedQFunctionField_private *CeedQFunctionField; 95 /// Handle for object describing functions evaluated independently at quadrature points 96 /// @ingroup CeedQFunctionUser 97 typedef struct CeedQFunction_private *CeedQFunction; 98 /// Handle for object describing CeedOperator fields 99 /// @ingroup CeedOperatorBackend 100 typedef struct CeedOperatorField_private *CeedOperatorField; 101 /// Handle for object describing context data for CeedQFunctions 102 /// @ingroup CeedQFunctionUser 103 typedef struct CeedQFunctionContext_private *CeedQFunctionContext; 104 /// Handle for object describing registered fields for CeedQFunctionContext 105 /// @ingroup CeedQFunctionUser 106 typedef struct CeedContextFieldLabel_private *CeedContextFieldLabel; 107 /// Handle for object describing FE-type operators acting on vectors 108 /// 109 /// Given an element restriction \f$E\f$, basis evaluator \f$B\f$, and 110 /// quadrature function\f$f\f$, a CeedOperator expresses operations of the form 111 /// $$ E^T B^T f(B E u) $$ 112 /// acting on the vector \f$u\f$. 113 /// @ingroup CeedOperatorUser 114 typedef struct CeedOperator_private *CeedOperator; 115 116 CEED_EXTERN int CeedRegistryGetList(size_t *n, char ***const resources, CeedInt **array); 117 CEED_EXTERN int CeedInit(const char *resource, Ceed *ceed); 118 CEED_EXTERN int CeedReferenceCopy(Ceed ceed, Ceed *ceed_copy); 119 CEED_EXTERN int CeedGetResource(Ceed ceed, const char **resource); 120 CEED_EXTERN int CeedIsDeterministic(Ceed ceed, bool *is_deterministic); 121 CEED_EXTERN int CeedAddJitSourceRoot(Ceed ceed, const char *jit_source_root); 122 CEED_EXTERN int CeedView(Ceed ceed, FILE *stream); 123 CEED_EXTERN int CeedDestroy(Ceed *ceed); 124 125 CEED_EXTERN int CeedErrorImpl(Ceed, const char *, int, const char *, int, const char *, ...); 126 /// Raise an error on ceed object 127 /// 128 /// @param ceed Ceed library context or NULL 129 /// @param ecode Error code (int) 130 /// @param ... printf-style format string followed by arguments as needed 131 /// 132 /// @ingroup Ceed 133 /// @sa CeedSetErrorHandler() 134 #if defined(__clang__) 135 /// Use nonstandard ternary to convince the compiler/clang-tidy that this 136 /// function never returns zero. 137 #define CeedError(ceed, ecode, ...) (CeedErrorImpl((ceed), __FILE__, __LINE__, __func__, (ecode), __VA_ARGS__), (ecode)) 138 #else 139 #define CeedError(ceed, ecode, ...) CeedErrorImpl((ceed), __FILE__, __LINE__, __func__, (ecode), __VA_ARGS__) ?: (ecode) 140 #endif 141 142 /// Ceed error handlers 143 CEED_EXTERN int CeedErrorReturn(Ceed, const char *, int, const char *, int, const char *, va_list *); 144 CEED_EXTERN int CeedErrorStore(Ceed, const char *, int, const char *, int, const char *, va_list *); 145 CEED_EXTERN int CeedErrorAbort(Ceed, const char *, int, const char *, int, const char *, va_list *); 146 CEED_EXTERN int CeedErrorExit(Ceed, const char *, int, const char *, int, const char *, va_list *); 147 typedef int (*CeedErrorHandler)(Ceed, const char *, int, const char *, int, const char *, va_list *); 148 CEED_EXTERN int CeedSetErrorHandler(Ceed ceed, CeedErrorHandler eh); 149 CEED_EXTERN int CeedGetErrorMessage(Ceed, const char **err_msg); 150 CEED_EXTERN int CeedResetErrorMessage(Ceed, const char **err_msg); 151 152 /// libCEED library version numbering 153 /// @ingroup Ceed 154 #define CEED_VERSION_MAJOR 0 155 #define CEED_VERSION_MINOR 10 156 #define CEED_VERSION_PATCH 1 157 #define CEED_VERSION_RELEASE false 158 159 /// Compile-time check that the the current library version is at least as 160 /// recent as the specified version. This macro is typically used in 161 /// @code 162 /// #if CEED_VERSION_GE(0, 8, 0) 163 /// code path that needs at least 0.8.0 164 /// #else 165 /// fallback code for older versions 166 /// #endif 167 /// @endcode 168 /// 169 /// A non-release version always compares as positive infinity. 170 /// 171 /// @param major Major version 172 /// @param minor Minor version 173 /// @param patch Patch (subminor) version 174 /// 175 /// @ingroup Ceed 176 /// @sa CeedGetVersion() 177 #define CEED_VERSION_GE(major, minor, patch) \ 178 (!CEED_VERSION_RELEASE || \ 179 (CEED_VERSION_MAJOR > major || \ 180 (CEED_VERSION_MAJOR == major && (CEED_VERSION_MINOR > minor || (CEED_VERSION_MINOR == minor && CEED_VERSION_PATCH >= patch))))) 181 182 CEED_EXTERN int CeedGetVersion(int *major, int *minor, int *patch, bool *release); 183 184 CEED_EXTERN int CeedGetScalarType(CeedScalarType *scalar_type); 185 186 CEED_EXTERN const char *const *CeedErrorTypes; 187 188 /// Specify memory type 189 /// 190 /// Many Ceed interfaces take or return pointers to memory. This enum is used to 191 /// specify where the memory being provided or requested must reside. 192 /// @ingroup Ceed 193 typedef enum { 194 /// Memory resides on the host 195 CEED_MEM_HOST, 196 /// Memory resides on a device (corresponding to \ref Ceed resource) 197 CEED_MEM_DEVICE, 198 } CeedMemType; 199 CEED_EXTERN const char *const CeedMemTypes[]; 200 201 CEED_EXTERN int CeedGetPreferredMemType(Ceed ceed, CeedMemType *type); 202 203 /// Conveys ownership status of arrays passed to Ceed interfaces. 204 /// @ingroup Ceed 205 typedef enum { 206 /// Implementation will copy the values and not store the passed pointer. 207 CEED_COPY_VALUES, 208 /// Implementation can use and modify the data provided by the user, but does 209 /// not take ownership. 210 CEED_USE_POINTER, 211 /// Implementation takes ownership of the pointer and will free using 212 /// CeedFree() when done using it. The user should not assume that the 213 /// pointer remains valid after ownership has been transferred. Note that 214 /// arrays allocated using C++ operator new or other allocators cannot 215 /// generally be freed using CeedFree(). CeedFree() is capable of freeing any 216 /// memory that can be freed using free(3). 217 CEED_OWN_POINTER, 218 } CeedCopyMode; 219 CEED_EXTERN const char *const CeedCopyModes[]; 220 221 /// Denotes type of vector norm to be computed 222 /// @ingroup CeedVector 223 typedef enum { 224 /// L_1 norm: sum_i |x_i| 225 CEED_NORM_1, 226 /// L_2 norm: sqrt(sum_i |x_i|^2) 227 CEED_NORM_2, 228 /// L_Infinity norm: max_i |x_i| 229 CEED_NORM_MAX, 230 } CeedNormType; 231 232 CEED_EXTERN int CeedVectorCreate(Ceed ceed, CeedSize len, CeedVector *vec); 233 CEED_EXTERN int CeedVectorReferenceCopy(CeedVector vec, CeedVector *vec_copy); 234 CEED_EXTERN int CeedVectorSetArray(CeedVector vec, CeedMemType mem_type, CeedCopyMode copy_mode, CeedScalar *array); 235 CEED_EXTERN int CeedVectorSetValue(CeedVector vec, CeedScalar value); 236 CEED_EXTERN int CeedVectorSyncArray(CeedVector vec, CeedMemType mem_type); 237 CEED_EXTERN int CeedVectorTakeArray(CeedVector vec, CeedMemType mem_type, CeedScalar **array); 238 CEED_EXTERN int CeedVectorGetArray(CeedVector vec, CeedMemType mem_type, CeedScalar **array); 239 CEED_EXTERN int CeedVectorGetArrayRead(CeedVector vec, CeedMemType mem_type, const CeedScalar **array); 240 CEED_EXTERN int CeedVectorGetArrayWrite(CeedVector vec, CeedMemType mem_type, CeedScalar **array); 241 CEED_EXTERN int CeedVectorRestoreArray(CeedVector vec, CeedScalar **array); 242 CEED_EXTERN int CeedVectorRestoreArrayRead(CeedVector vec, const CeedScalar **array); 243 CEED_EXTERN int CeedVectorNorm(CeedVector vec, CeedNormType type, CeedScalar *norm); 244 CEED_EXTERN int CeedVectorScale(CeedVector x, CeedScalar alpha); 245 CEED_EXTERN int CeedVectorAXPY(CeedVector y, CeedScalar alpha, CeedVector x); 246 CEED_EXTERN int CeedVectorPointwiseMult(CeedVector w, CeedVector x, CeedVector y); 247 CEED_EXTERN int CeedVectorReciprocal(CeedVector vec); 248 CEED_EXTERN int CeedVectorView(CeedVector vec, const char *fp_fmt, FILE *stream); 249 CEED_EXTERN int CeedVectorGetCeed(CeedVector vec, Ceed *ceed); 250 CEED_EXTERN int CeedVectorGetLength(CeedVector vec, CeedSize *length); 251 CEED_EXTERN int CeedVectorDestroy(CeedVector *vec); 252 253 CEED_EXTERN CeedRequest *const CEED_REQUEST_IMMEDIATE; 254 CEED_EXTERN CeedRequest *const CEED_REQUEST_ORDERED; 255 CEED_EXTERN int CeedRequestWait(CeedRequest *req); 256 257 /// Argument for CeedOperatorSetField that vector is collocated with 258 /// quadrature points, only used with CeedEvalMode CEED_EVAL_NONE 259 /// @ingroup CeedBasis 260 CEED_EXTERN const CeedBasis CEED_BASIS_COLLOCATED; 261 262 /// Argument for CeedOperatorSetField to use active input or output 263 /// @ingroup CeedVector 264 CEED_EXTERN const CeedVector CEED_VECTOR_ACTIVE; 265 266 /// Argument for CeedOperatorSetField to use no vector, used with 267 /// qfunction input with eval mode CEED_EVAL_WEIGHT 268 /// @ingroup CeedVector 269 CEED_EXTERN const CeedVector CEED_VECTOR_NONE; 270 271 /// Argument for CeedOperatorSetField to use no ElemRestriction, only used with 272 /// eval mode CEED_EVAL_WEIGHT. 273 /// @ingroup CeedElemRestriction 274 CEED_EXTERN const CeedElemRestriction CEED_ELEMRESTRICTION_NONE; 275 276 /// Argument for CeedOperatorCreate that QFunction is not created by user. 277 /// Only used for QFunctions dqf and dqfT. If implemented, a backend may 278 /// attempt to provide the action of these QFunctions. 279 /// @ingroup CeedQFunction 280 CEED_EXTERN const CeedQFunction CEED_QFUNCTION_NONE; 281 282 /// Denotes whether a linear transformation or its transpose should be applied 283 /// @ingroup CeedBasis 284 typedef enum { 285 /// Apply the linear transformation 286 CEED_NOTRANSPOSE, 287 /// Apply the transpose 288 CEED_TRANSPOSE 289 } CeedTransposeMode; 290 CEED_EXTERN const char *const CeedTransposeModes[]; 291 292 /// Argument for CeedElemRestrictionCreateStrided that L-vector is in 293 /// the Ceed backend's preferred layout. This argument should only be used 294 /// with vectors created by a Ceed backend. 295 /// @ingroup CeedElemRestriction 296 CEED_EXTERN const CeedInt CEED_STRIDES_BACKEND[3]; 297 298 CEED_EXTERN int CeedElemRestrictionCreate(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt num_comp, CeedInt comp_stride, CeedSize l_size, 299 CeedMemType mem_type, CeedCopyMode copy_mode, const CeedInt *offsets, CeedElemRestriction *rstr); 300 CEED_EXTERN int CeedElemRestrictionCreateOriented(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt num_comp, CeedInt comp_stride, 301 CeedSize l_size, CeedMemType mem_type, CeedCopyMode copy_mode, const CeedInt *offsets, 302 const bool *orient, CeedElemRestriction *rstr); 303 CEED_EXTERN int CeedElemRestrictionCreateStrided(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt num_comp, CeedSize l_size, 304 const CeedInt strides[3], CeedElemRestriction *rstr); 305 CEED_EXTERN int CeedElemRestrictionCreateBlocked(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt blk_size, CeedInt num_comp, 306 CeedInt comp_stride, CeedSize l_size, CeedMemType mem_type, CeedCopyMode copy_mode, 307 const CeedInt *offsets, CeedElemRestriction *rstr); 308 CEED_EXTERN int CeedElemRestrictionCreateBlockedStrided(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt blk_size, CeedInt num_comp, 309 CeedSize l_size, const CeedInt strides[3], CeedElemRestriction *rstr); 310 CEED_EXTERN int CeedElemRestrictionReferenceCopy(CeedElemRestriction rstr, CeedElemRestriction *rstr_copy); 311 CEED_EXTERN int CeedElemRestrictionCreateVector(CeedElemRestriction rstr, CeedVector *lvec, CeedVector *evec); 312 CEED_EXTERN int CeedElemRestrictionApply(CeedElemRestriction rstr, CeedTransposeMode t_mode, CeedVector u, CeedVector ru, CeedRequest *request); 313 CEED_EXTERN int CeedElemRestrictionApplyBlock(CeedElemRestriction rstr, CeedInt block, CeedTransposeMode t_mode, CeedVector u, CeedVector ru, 314 CeedRequest *request); 315 CEED_EXTERN int CeedElemRestrictionGetCeed(CeedElemRestriction rstr, Ceed *ceed); 316 CEED_EXTERN int CeedElemRestrictionGetCompStride(CeedElemRestriction rstr, CeedInt *comp_stride); 317 CEED_EXTERN int CeedElemRestrictionGetNumElements(CeedElemRestriction rstr, CeedInt *num_elem); 318 CEED_EXTERN int CeedElemRestrictionGetElementSize(CeedElemRestriction rstr, CeedInt *elem_size); 319 CEED_EXTERN int CeedElemRestrictionGetLVectorSize(CeedElemRestriction rstr, CeedSize *l_size); 320 CEED_EXTERN int CeedElemRestrictionGetNumComponents(CeedElemRestriction rstr, CeedInt *num_comp); 321 CEED_EXTERN int CeedElemRestrictionGetNumBlocks(CeedElemRestriction rstr, CeedInt *num_blk); 322 CEED_EXTERN int CeedElemRestrictionGetBlockSize(CeedElemRestriction rstr, CeedInt *blk_size); 323 CEED_EXTERN int CeedElemRestrictionGetMultiplicity(CeedElemRestriction rstr, CeedVector mult); 324 CEED_EXTERN int CeedElemRestrictionView(CeedElemRestriction rstr, FILE *stream); 325 CEED_EXTERN int CeedElemRestrictionDestroy(CeedElemRestriction *rstr); 326 327 // The formalism here is that we have the structure 328 // \int_\Omega v^T f_0(u, \nabla u, qdata) + (\nabla v)^T f_1(u, \nabla u, qdata) 329 // where gradients are with respect to the reference element. 330 331 /// Basis evaluation mode 332 /// 333 /// Modes can be bitwise ORed when passing to most functions. 334 /// @ingroup CeedBasis 335 typedef enum { 336 /// Perform no evaluation (either because there is no data or it is already at 337 /// quadrature points) 338 CEED_EVAL_NONE = 0, 339 /// Interpolate from nodes to quadrature points 340 CEED_EVAL_INTERP = 1, 341 /// Evaluate gradients at quadrature points from input in a nodal basis 342 CEED_EVAL_GRAD = 2, 343 /// Evaluate divergence at quadrature points from input in a nodal basis 344 CEED_EVAL_DIV = 4, 345 /// Evaluate curl at quadrature points from input in a nodal basis 346 CEED_EVAL_CURL = 8, 347 /// Using no input, evaluate quadrature weights on the reference element 348 CEED_EVAL_WEIGHT = 16, 349 } CeedEvalMode; 350 CEED_EXTERN const char *const CeedEvalModes[]; 351 352 /// Type of quadrature; also used for location of nodes 353 /// @ingroup CeedBasis 354 typedef enum { 355 /// Gauss-Legendre quadrature 356 CEED_GAUSS = 0, 357 /// Gauss-Legendre-Lobatto quadrature 358 CEED_GAUSS_LOBATTO = 1, 359 } CeedQuadMode; 360 CEED_EXTERN const char *const CeedQuadModes[]; 361 362 /// Type of basis shape to create non-tensor H1 element basis 363 /// 364 /// Dimension can be extracted with bitwise AND 365 /// (CeedElemTopology & 2**(dim + 2)) == TRUE 366 /// @ingroup CeedBasis 367 typedef enum { 368 /// Line 369 CEED_TOPOLOGY_LINE = 1 << 16 | 0, 370 /// Triangle - 2D shape 371 CEED_TOPOLOGY_TRIANGLE = 2 << 16 | 1, 372 /// Quadralateral - 2D shape 373 CEED_TOPOLOGY_QUAD = 2 << 16 | 2, 374 /// Tetrahedron - 3D shape 375 CEED_TOPOLOGY_TET = 3 << 16 | 3, 376 /// Pyramid - 3D shape 377 CEED_TOPOLOGY_PYRAMID = 3 << 16 | 4, 378 /// Prism - 3D shape 379 CEED_TOPOLOGY_PRISM = 3 << 16 | 5, 380 /// Hexehedron - 3D shape 381 CEED_TOPOLOGY_HEX = 3 << 16 | 6, 382 } CeedElemTopology; 383 CEED_EXTERN const char *const CeedElemTopologies[]; 384 385 CEED_EXTERN int CeedBasisCreateTensorH1Lagrange(Ceed ceed, CeedInt dim, CeedInt num_comp, CeedInt P, CeedInt Q, CeedQuadMode quad_mode, 386 CeedBasis *basis); 387 CEED_EXTERN int CeedBasisCreateTensorH1(Ceed ceed, CeedInt dim, CeedInt num_comp, CeedInt P_1d, CeedInt Q_1d, const CeedScalar *interp_1d, 388 const CeedScalar *grad_1d, const CeedScalar *q_ref_1d, const CeedScalar *q_weight_1d, CeedBasis *basis); 389 CEED_EXTERN int CeedBasisCreateH1(Ceed ceed, CeedElemTopology topo, CeedInt num_comp, CeedInt num_nodes, CeedInt nqpts, const CeedScalar *interp, 390 const CeedScalar *grad, const CeedScalar *q_ref, const CeedScalar *q_weights, CeedBasis *basis); 391 CEED_EXTERN int CeedBasisCreateHdiv(Ceed ceed, CeedElemTopology topo, CeedInt num_comp, CeedInt num_nodes, CeedInt nqpts, const CeedScalar *interp, 392 const CeedScalar *div, const CeedScalar *q_ref, const CeedScalar *q_weights, CeedBasis *basis); 393 CEED_EXTERN int CeedBasisCreateProjection(CeedBasis basis_from, CeedBasis basis_to, CeedBasis *basis_project); 394 CEED_EXTERN int CeedBasisReferenceCopy(CeedBasis basis, CeedBasis *basis_copy); 395 CEED_EXTERN int CeedBasisView(CeedBasis basis, FILE *stream); 396 CEED_EXTERN int CeedBasisApply(CeedBasis basis, CeedInt num_elem, CeedTransposeMode t_mode, CeedEvalMode eval_mode, CeedVector u, CeedVector v); 397 CEED_EXTERN int CeedBasisGetCeed(CeedBasis basis, Ceed *ceed); 398 CEED_EXTERN int CeedBasisGetDimension(CeedBasis basis, CeedInt *dim); 399 CEED_EXTERN int CeedBasisGetTopology(CeedBasis basis, CeedElemTopology *topo); 400 CEED_EXTERN int CeedBasisGetNumQuadratureComponents(CeedBasis basis, CeedInt *Q_comp); 401 CEED_EXTERN int CeedBasisGetNumComponents(CeedBasis basis, CeedInt *num_comp); 402 CEED_EXTERN int CeedBasisGetNumNodes(CeedBasis basis, CeedInt *P); 403 CEED_EXTERN int CeedBasisGetNumNodes1D(CeedBasis basis, CeedInt *P_1d); 404 CEED_EXTERN int CeedBasisGetNumQuadraturePoints(CeedBasis basis, CeedInt *Q); 405 CEED_EXTERN int CeedBasisGetNumQuadraturePoints1D(CeedBasis basis, CeedInt *Q_1d); 406 CEED_EXTERN int CeedBasisGetQRef(CeedBasis basis, const CeedScalar **q_ref); 407 CEED_EXTERN int CeedBasisGetQWeights(CeedBasis basis, const CeedScalar **q_weights); 408 CEED_EXTERN int CeedBasisGetInterp(CeedBasis basis, const CeedScalar **interp); 409 CEED_EXTERN int CeedBasisGetInterp1D(CeedBasis basis, const CeedScalar **interp_1d); 410 CEED_EXTERN int CeedBasisGetGrad(CeedBasis basis, const CeedScalar **grad); 411 CEED_EXTERN int CeedBasisGetGrad1D(CeedBasis basis, const CeedScalar **grad_1d); 412 CEED_EXTERN int CeedBasisGetDiv(CeedBasis basis, const CeedScalar **div); 413 CEED_EXTERN int CeedBasisDestroy(CeedBasis *basis); 414 415 CEED_EXTERN int CeedGaussQuadrature(CeedInt Q, CeedScalar *q_ref_1d, CeedScalar *q_weight_1d); 416 CEED_EXTERN int CeedLobattoQuadrature(CeedInt Q, CeedScalar *q_ref_1d, CeedScalar *q_weight_1d); 417 CEED_EXTERN int CeedQRFactorization(Ceed ceed, CeedScalar *mat, CeedScalar *tau, CeedInt m, CeedInt n); 418 CEED_EXTERN int CeedSymmetricSchurDecomposition(Ceed ceed, CeedScalar *mat, CeedScalar *lambda, CeedInt n); 419 CEED_EXTERN int CeedSimultaneousDiagonalization(Ceed ceed, CeedScalar *mat_A, CeedScalar *mat_B, CeedScalar *x, CeedScalar *lambda, CeedInt n); 420 421 /** Handle for the user provided CeedQFunction callback function 422 423 @param[in,out] ctx User-defined context set using CeedQFunctionSetContext() or NULL 424 @param[in] Q Number of quadrature points at which to evaluate 425 @param[in] in Array of pointers to each input argument in the order provided 426 by the user in CeedQFunctionAddInput(). Each array has shape 427 `[dim, num_comp, Q]` where `dim` is the geometric dimension for 428 \ref CEED_EVAL_GRAD (`dim=1` for \ref CEED_EVAL_INTERP) and 429 `num_comp` is the number of field components (`num_comp=1` for 430 scalar fields). This results in indexing the `i`th input at 431 quadrature point `j` as `in[i][(d*num_comp + c)*Q + j]`. 432 @param[out] out Array of pointers to each output array in the order provided 433 using CeedQFunctionAddOutput(). The shapes are as above for 434 \a in. 435 436 @return An error code: 0 - success, otherwise - failure 437 438 @ingroup CeedQFunction 439 **/ 440 typedef int (*CeedQFunctionUser)(void *ctx, const CeedInt Q, const CeedScalar *const *in, CeedScalar *const *out); 441 442 CEED_EXTERN int CeedQFunctionCreateInterior(Ceed ceed, CeedInt vec_length, CeedQFunctionUser f, const char *source, CeedQFunction *qf); 443 CEED_EXTERN int CeedQFunctionCreateInteriorByName(Ceed ceed, const char *name, CeedQFunction *qf); 444 CEED_EXTERN int CeedQFunctionCreateIdentity(Ceed ceed, CeedInt size, CeedEvalMode in_mode, CeedEvalMode out_mode, CeedQFunction *qf); 445 CEED_EXTERN int CeedQFunctionReferenceCopy(CeedQFunction qf, CeedQFunction *qf_copy); 446 CEED_EXTERN int CeedQFunctionAddInput(CeedQFunction qf, const char *field_name, CeedInt size, CeedEvalMode eval_mode); 447 CEED_EXTERN int CeedQFunctionAddOutput(CeedQFunction qf, const char *field_name, CeedInt size, CeedEvalMode eval_mode); 448 CEED_EXTERN int CeedQFunctionGetFields(CeedQFunction qf, CeedInt *num_input_fields, CeedQFunctionField **input_fields, CeedInt *num_output_fields, 449 CeedQFunctionField **output_fields); 450 CEED_EXTERN int CeedQFunctionSetContext(CeedQFunction qf, CeedQFunctionContext ctx); 451 CEED_EXTERN int CeedQFunctionSetContextWritable(CeedQFunction qf, bool is_writable); 452 CEED_EXTERN int CeedQFunctionSetUserFlopsEstimate(CeedQFunction qf, CeedSize flops); 453 CEED_EXTERN int CeedQFunctionView(CeedQFunction qf, FILE *stream); 454 CEED_EXTERN int CeedQFunctionGetCeed(CeedQFunction qf, Ceed *ceed); 455 CEED_EXTERN int CeedQFunctionApply(CeedQFunction qf, CeedInt Q, CeedVector *u, CeedVector *v); 456 CEED_EXTERN int CeedQFunctionDestroy(CeedQFunction *qf); 457 458 CEED_EXTERN int CeedQFunctionFieldGetName(CeedQFunctionField qf_field, char **field_name); 459 CEED_EXTERN int CeedQFunctionFieldGetSize(CeedQFunctionField qf_field, CeedInt *size); 460 CEED_EXTERN int CeedQFunctionFieldGetEvalMode(CeedQFunctionField qf_field, CeedEvalMode *eval_mode); 461 462 /// Denotes type of data stored in a CeedQFunctionContext field 463 /// @ingroup CeedQFunction 464 typedef enum { 465 /// Double precision value 466 CEED_CONTEXT_FIELD_DOUBLE = 1, 467 /// 32 bit integer value 468 CEED_CONTEXT_FIELD_INT32 = 2, 469 } CeedContextFieldType; 470 CEED_EXTERN const char *const CeedContextFieldTypes[]; 471 472 /** Handle for the user provided CeedQFunctionContextDataDestroy callback function 473 474 @param[in,out] data User-CeedQFunctionContext data 475 476 @return An error code: 0 - success, otherwise - failure 477 478 @ingroup CeedQFunction 479 **/ 480 typedef int (*CeedQFunctionContextDataDestroyUser)(void *data); 481 482 CEED_EXTERN int CeedQFunctionContextCreate(Ceed ceed, CeedQFunctionContext *ctx); 483 CEED_EXTERN int CeedQFunctionContextReferenceCopy(CeedQFunctionContext ctx, CeedQFunctionContext *ctx_copy); 484 CEED_EXTERN int CeedQFunctionContextSetData(CeedQFunctionContext ctx, CeedMemType mem_type, CeedCopyMode copy_mode, size_t size, void *data); 485 CEED_EXTERN int CeedQFunctionContextTakeData(CeedQFunctionContext ctx, CeedMemType mem_type, void *data); 486 CEED_EXTERN int CeedQFunctionContextGetData(CeedQFunctionContext ctx, CeedMemType mem_type, void *data); 487 CEED_EXTERN int CeedQFunctionContextGetDataRead(CeedQFunctionContext ctx, CeedMemType mem_type, void *data); 488 CEED_EXTERN int CeedQFunctionContextRestoreData(CeedQFunctionContext ctx, void *data); 489 CEED_EXTERN int CeedQFunctionContextRestoreDataRead(CeedQFunctionContext ctx, void *data); 490 CEED_EXTERN int CeedQFunctionContextRegisterDouble(CeedQFunctionContext ctx, const char *field_name, size_t field_offset, size_t num_values, 491 const char *field_description); 492 CEED_EXTERN int CeedQFunctionContextRegisterInt32(CeedQFunctionContext ctx, const char *field_name, size_t field_offset, size_t num_values, 493 const char *field_description); 494 CEED_EXTERN int CeedQFunctionContextGetAllFieldLabels(CeedQFunctionContext ctx, const CeedContextFieldLabel **field_labels, CeedInt *num_fields); 495 CEED_EXTERN int CeedContextFieldLabelGetDescription(CeedContextFieldLabel label, const char **field_name, const char **field_description, 496 size_t *num_values, CeedContextFieldType *field_type); 497 CEED_EXTERN int CeedQFunctionContextGetContextSize(CeedQFunctionContext ctx, size_t *ctx_size); 498 CEED_EXTERN int CeedQFunctionContextView(CeedQFunctionContext ctx, FILE *stream); 499 CEED_EXTERN int CeedQFunctionContextSetDataDestroy(CeedQFunctionContext ctx, CeedMemType f_mem_type, CeedQFunctionContextDataDestroyUser f); 500 CEED_EXTERN int CeedQFunctionContextDestroy(CeedQFunctionContext *ctx); 501 502 CEED_EXTERN int CeedOperatorCreate(Ceed ceed, CeedQFunction qf, CeedQFunction dqf, CeedQFunction dqfT, CeedOperator *op); 503 CEED_EXTERN int CeedCompositeOperatorCreate(Ceed ceed, CeedOperator *op); 504 CEED_EXTERN int CeedOperatorReferenceCopy(CeedOperator op, CeedOperator *op_copy); 505 CEED_EXTERN int CeedOperatorSetField(CeedOperator op, const char *field_name, CeedElemRestriction r, CeedBasis b, CeedVector v); 506 CEED_EXTERN int CeedOperatorGetFields(CeedOperator op, CeedInt *num_input_fields, CeedOperatorField **input_fields, CeedInt *num_output_fields, 507 CeedOperatorField **output_fields); 508 CEED_EXTERN int CeedCompositeOperatorAddSub(CeedOperator composite_op, CeedOperator sub_op); 509 CEED_EXTERN int CeedOperatorCheckReady(CeedOperator op); 510 CEED_EXTERN int CeedOperatorGetActiveVectorLengths(CeedOperator op, CeedSize *input_size, CeedSize *output_size); 511 CEED_EXTERN int CeedOperatorSetQFunctionAssemblyReuse(CeedOperator op, bool reuse_assembly_data); 512 CEED_EXTERN int CeedOperatorSetQFunctionAssemblyDataUpdateNeeded(CeedOperator op, bool needs_data_update); 513 CEED_EXTERN int CeedOperatorLinearAssembleQFunction(CeedOperator op, CeedVector *assembled, CeedElemRestriction *rstr, CeedRequest *request); 514 CEED_EXTERN int CeedOperatorLinearAssembleQFunctionBuildOrUpdate(CeedOperator op, CeedVector *assembled, CeedElemRestriction *rstr, 515 CeedRequest *request); 516 CEED_EXTERN int CeedOperatorLinearAssembleDiagonal(CeedOperator op, CeedVector assembled, CeedRequest *request); 517 CEED_EXTERN int CeedOperatorLinearAssembleAddDiagonal(CeedOperator op, CeedVector assembled, CeedRequest *request); 518 CEED_EXTERN int CeedOperatorLinearAssemblePointBlockDiagonal(CeedOperator op, CeedVector assembled, CeedRequest *request); 519 CEED_EXTERN int CeedOperatorLinearAssembleAddPointBlockDiagonal(CeedOperator op, CeedVector assembled, CeedRequest *request); 520 CEED_EXTERN int CeedOperatorLinearAssembleSymbolic(CeedOperator op, CeedSize *num_entries, CeedInt **rows, CeedInt **cols); 521 CEED_EXTERN int CeedOperatorLinearAssemble(CeedOperator op, CeedVector values); 522 CEED_EXTERN int CeedOperatorMultigridLevelCreate(CeedOperator op_fine, CeedVector p_mult_fine, CeedElemRestriction rstr_coarse, 523 CeedBasis basis_coarse, CeedOperator *op_coarse, CeedOperator *op_prolong, 524 CeedOperator *op_restrict); 525 CEED_EXTERN int CeedOperatorMultigridLevelCreateTensorH1(CeedOperator op_fine, CeedVector p_mult_fine, CeedElemRestriction rstr_coarse, 526 CeedBasis basis_coarse, const CeedScalar *interp_c_to_f, CeedOperator *op_coarse, 527 CeedOperator *op_prolong, CeedOperator *op_restrict); 528 CEED_EXTERN int CeedOperatorMultigridLevelCreateH1(CeedOperator op_fine, CeedVector p_mult_fine, CeedElemRestriction rstr_coarse, 529 CeedBasis basis_coarse, const CeedScalar *interp_c_to_f, CeedOperator *op_coarse, 530 CeedOperator *op_prolong, CeedOperator *op_restrict); 531 CEED_EXTERN int CeedOperatorCreateFDMElementInverse(CeedOperator op, CeedOperator *fdm_inv, CeedRequest *request); 532 CEED_EXTERN int CeedOperatorSetNumQuadraturePoints(CeedOperator op, CeedInt num_qpts); 533 CEED_EXTERN int CeedOperatorSetName(CeedOperator op, const char *name); 534 CEED_EXTERN int CeedOperatorView(CeedOperator op, FILE *stream); 535 CEED_EXTERN int CeedOperatorGetCeed(CeedOperator op, Ceed *ceed); 536 CEED_EXTERN int CeedOperatorGetNumElements(CeedOperator op, CeedInt *num_elem); 537 CEED_EXTERN int CeedOperatorGetNumQuadraturePoints(CeedOperator op, CeedInt *num_qpts); 538 CEED_EXTERN int CeedOperatorGetFlopsEstimate(CeedOperator op, CeedSize *flops); 539 CEED_EXTERN int CeedOperatorContextGetFieldLabel(CeedOperator op, const char *field_name, CeedContextFieldLabel *field_label); 540 CEED_EXTERN int CeedOperatorContextSetDouble(CeedOperator op, CeedContextFieldLabel field_label, double *values); 541 CEED_EXTERN int CeedOperatorContextSetInt32(CeedOperator op, CeedContextFieldLabel field_label, int *values); 542 CEED_EXTERN int CeedOperatorApply(CeedOperator op, CeedVector in, CeedVector out, CeedRequest *request); 543 CEED_EXTERN int CeedOperatorApplyAdd(CeedOperator op, CeedVector in, CeedVector out, CeedRequest *request); 544 CEED_EXTERN int CeedOperatorDestroy(CeedOperator *op); 545 546 CEED_EXTERN int CeedOperatorFieldGetName(CeedOperatorField op_field, char **field_name); 547 CEED_EXTERN int CeedOperatorFieldGetElemRestriction(CeedOperatorField op_field, CeedElemRestriction *rstr); 548 CEED_EXTERN int CeedOperatorFieldGetBasis(CeedOperatorField op_field, CeedBasis *basis); 549 CEED_EXTERN int CeedOperatorFieldGetVector(CeedOperatorField op_field, CeedVector *vec); 550 551 /** 552 @brief Return integer power 553 554 @param[in] base The base to exponentiate 555 @param[in] power The power to raise the base to 556 557 @return base^power 558 559 @ref Utility 560 **/ 561 static inline CeedInt CeedIntPow(CeedInt base, CeedInt power) { 562 CeedInt result = 1; 563 while (power) { 564 if (power & 1) result *= base; 565 power >>= 1; 566 base *= base; 567 } 568 return result; 569 } 570 571 /** 572 @brief Return minimum of two integers 573 574 @param[in] a The first integer to compare 575 @param[in] b The second integer to compare 576 577 @return The minimum of the two integers 578 579 @ref Utility 580 **/ 581 static inline CeedInt CeedIntMin(CeedInt a, CeedInt b) { return a < b ? a : b; } 582 583 /** 584 @brief Return maximum of two integers 585 586 @param[in] a The first integer to compare 587 @param[in] b The second integer to compare 588 589 @return The maximum of the two integers 590 591 @ref Utility 592 **/ 593 static inline CeedInt CeedIntMax(CeedInt a, CeedInt b) { return a > b ? a : b; } 594 595 // Used to ensure initialization before CeedInit() 596 CEED_EXTERN int CeedRegisterAll(void); 597 // Used to ensure initialization before CeedQFunctionCreate*() 598 CEED_EXTERN int CeedQFunctionRegisterAll(void); 599 600 #endif 601