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