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