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