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