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