1 /// Copyright (c) 2017-2022, Lawrence Livermore National Security, LLC and other CEED contributors. 2 /// All Rights Reserved. See the top-level LICENSE and NOTICE files for details. 3 /// 4 /// SPDX-License-Identifier: BSD-2-Clause 5 /// 6 /// This file is part of CEED: http://github.com/ceed 7 8 /// @file 9 /// Public header for user and utility components of libCEED 10 #ifndef CEED_H 11 #define CEED_H 12 13 /// @defgroup Ceed Ceed: core components 14 /// @defgroup CeedVector CeedVector: storing and manipulating vectors 15 /// @defgroup CeedElemRestriction CeedElemRestriction: restriction from local vectors to elements 16 /// @defgroup CeedBasis CeedBasis: fully discrete finite element-like objects 17 /// @defgroup CeedQFunction CeedQFunction: independent operations at quadrature points 18 /// @defgroup CeedOperator CeedOperator: composed FE-type operations on vectors 19 /// 20 /// @page FunctionCategories libCEED: Types of Functions libCEED provides three different header files depending upon the type of functions a user 21 /// requires. 22 /// @section Utility Utility Functions 23 /// These functions are intended general utilities that may be useful to libCEED developers and users. 24 /// These functions can generally be found in `"ceed.h"`. 25 /// @section User User Functions 26 /// These functions are intended to be used by general users of libCEED and can generally be found in `"ceed.h"`. 27 /// @section Advanced Advanced Functions 28 /// These functions are intended to be used by advanced users of libCEED and can generally be found in `"ceed.h"`. 29 /// @section Backend Backend Developer Functions 30 /// These functions are intended to be used by backend developers of libCEED and can generally be found in `"ceed-backend.h"`. 31 /// @section Developer Library Developer Functions 32 /// These functions are intended to be used by library developers of libCEED and can generally be found in `"ceed-impl.h"`. 33 34 #if !defined(CEED_SKIP_VISIBILITY) 35 #define CEED_VISIBILITY(mode) __attribute__((visibility(#mode))) 36 #else 37 #define CEED_VISIBILITY(mode) 38 #endif 39 40 /* 41 CEED_EXTERN is used in this header to denote all publicly visible symbols. 42 43 No other file should declare publicly visible symbols, thus it should never be used outside `"ceed.h"`. 44 */ 45 #if defined(__clang_analyzer__) 46 #define CEED_EXTERN extern 47 #elif defined(__cplusplus) 48 #define CEED_EXTERN extern "C" CEED_VISIBILITY(default) 49 #else 50 #define CEED_EXTERN extern CEED_VISIBILITY(default) 51 #endif 52 53 #include <stdarg.h> 54 #include <stdbool.h> 55 #include <stdio.h> 56 57 /* 58 Typedefs and macros used in public interfaces and user `CeedQFunction` source 59 */ 60 #include "types.h" // IWYU pragma: export 61 62 /* 63 This line prevents IWYU from suggesting "ceed.h" 64 */ 65 // IWYU pragma: private, include <ceed.h> 66 67 /// Library context created by CeedInit() 68 /// @ingroup CeedUser 69 typedef struct Ceed_private *Ceed; 70 /// Non-blocking Ceed interfaces return a CeedRequest. 71 /// To perform an operation immediately, pass @ref CEED_REQUEST_IMMEDIATE instead. 72 /// @ingroup CeedUser 73 typedef struct CeedRequest_private *CeedRequest; 74 /// Handle for vectors over the field @ref CeedScalar 75 /// @ingroup CeedVectorUser 76 typedef struct CeedVector_private *CeedVector; 77 /// Handle for object describing restriction to elements 78 /// @ingroup CeedElemRestrictionUser 79 typedef struct CeedElemRestriction_private *CeedElemRestriction; 80 /// Handle for object describing discrete finite element evaluations 81 /// @ingroup CeedBasisUser 82 typedef struct CeedBasis_private *CeedBasis; 83 /// Handle for object describing CeedQFunction fields 84 /// @ingroup CeedQFunctionBackend 85 typedef struct CeedQFunctionField_private *CeedQFunctionField; 86 /// Handle for object describing functions evaluated independently at quadrature points 87 /// @ingroup CeedQFunctionUser 88 typedef struct CeedQFunction_private *CeedQFunction; 89 /// Handle for object describing CeedOperator fields 90 /// @ingroup CeedOperatorBackend 91 typedef struct CeedOperatorField_private *CeedOperatorField; 92 /// Handle for object describing context data for CeedQFunctions 93 /// @ingroup CeedQFunctionUser 94 typedef struct CeedQFunctionContext_private *CeedQFunctionContext; 95 /// Handle for object describing registered fields for CeedQFunctionContext 96 /// @ingroup CeedQFunctionUser 97 typedef struct CeedContextFieldLabel_private *CeedContextFieldLabel; 98 /// Handle for object describing FE-type operators acting on vectors 99 /// 100 /// Given an element restriction \f$E\f$, basis evaluator \f$B\f$, and quadrature function\f$f\f$, a `CeedOperator` expresses operations of the form \f$E^T B^T f(B E u)\f$ acting on the vector \f$u\f$. 101 /// @ingroup CeedOperatorUser 102 typedef struct CeedOperator_private *CeedOperator; 103 104 CEED_EXTERN int CeedRegistryGetList(size_t *n, char ***const resources, CeedInt **array); 105 CEED_EXTERN int CeedInit(const char *resource, Ceed *ceed); 106 CEED_EXTERN int CeedSetStream(Ceed ceed, void *handle); 107 CEED_EXTERN int CeedReferenceCopy(Ceed ceed, Ceed *ceed_copy); 108 CEED_EXTERN int CeedGetResource(Ceed ceed, const char **resource); 109 CEED_EXTERN int CeedIsDeterministic(Ceed ceed, bool *is_deterministic); 110 CEED_EXTERN int CeedAddJitSourceRoot(Ceed ceed, const char *jit_source_root); 111 CEED_EXTERN int CeedView(Ceed ceed, FILE *stream); 112 CEED_EXTERN int CeedDestroy(Ceed *ceed); 113 CEED_EXTERN int CeedErrorImpl(Ceed ceed, const char *filename, int lineno, const char *func, int ecode, const char *format, ...); 114 115 /// Raise an error on `Ceed` object 116 /// 117 /// @param ceed `Ceed` library context or `NULL` 118 /// @param ecode Error code (int) 119 /// @param ... printf-style format string followed by arguments as needed 120 /// 121 /// @ingroup Ceed 122 /// @sa CeedSetErrorHandler() 123 #define CeedError(ceed, ecode, ...) (CeedErrorImpl((ceed), __FILE__, __LINE__, __func__, (ecode), __VA_ARGS__), (ecode)) 124 125 /// Ceed error handlers 126 typedef int (*CeedErrorHandler)(Ceed, const char *, int, const char *, int, const char *, va_list *); 127 CEED_EXTERN int CeedSetErrorHandler(Ceed ceed, CeedErrorHandler handler); 128 CEED_EXTERN int CeedGetErrorMessage(Ceed ceed, const char **err_msg); 129 CEED_EXTERN int CeedResetErrorMessage(Ceed ceed, const char **err_msg); 130 CEED_EXTERN int CeedErrorReturn(Ceed ceed, const char *filename, int line_no, const char *func, int err_code, const char *format, va_list *args); 131 CEED_EXTERN int CeedErrorStore(Ceed ceed, const char *filename, int line_no, const char *func, int err_code, const char *format, va_list *args); 132 CEED_EXTERN int CeedErrorAbort(Ceed ceed, const char *filename, int line_no, const char *func, int err_code, const char *format, va_list *args); 133 CEED_EXTERN int CeedErrorExit(Ceed ceed, const char *filename, int line_no, const char *func, int err_code, const char *format, va_list *args); 134 135 /// libCEED library version numbering 136 /// @ingroup Ceed 137 #define CEED_VERSION_MAJOR 0 138 #define CEED_VERSION_MINOR 12 139 #define CEED_VERSION_PATCH 0 140 #define CEED_VERSION_RELEASE false 141 142 /// Compile-time check that the the current library version is at least as recent as the specified version. 143 /// This macro is typically used in 144 /// @code 145 /// #if CEED_VERSION_GE(0, 8, 0) 146 /// code path that needs at least 0.8.0 147 /// #else 148 /// fallback code for older versions 149 /// #endif 150 /// @endcode 151 /// 152 /// A non-release version always compares as positive infinity. 153 /// 154 /// @param major Major version 155 /// @param minor Minor version 156 /// @param patch Patch (subminor) version 157 /// 158 /// @ingroup Ceed 159 /// @sa CeedGetVersion() 160 #define CEED_VERSION_GE(major, minor, patch) \ 161 (!CEED_VERSION_RELEASE || \ 162 (CEED_VERSION_MAJOR > major || \ 163 (CEED_VERSION_MAJOR == major && (CEED_VERSION_MINOR > minor || (CEED_VERSION_MINOR == minor && CEED_VERSION_PATCH >= patch))))) 164 165 CEED_EXTERN int CeedGetVersion(int *major, int *minor, int *patch, bool *release); 166 167 CEED_EXTERN int CeedGetScalarType(CeedScalarType *scalar_type); 168 169 /// String names for enum pretty printing 170 CEED_EXTERN const char *const *CeedErrorTypes; 171 CEED_EXTERN const char *const CeedMemTypes[]; 172 CEED_EXTERN const char *const CeedCopyModes[]; 173 CEED_EXTERN const char *const CeedTransposeModes[]; 174 CEED_EXTERN const char *const CeedEvalModes[]; 175 CEED_EXTERN const char *const CeedQuadModes[]; 176 CEED_EXTERN const char *const CeedElemTopologies[]; 177 CEED_EXTERN const char *const CeedContextFieldTypes[]; 178 179 CEED_EXTERN int CeedGetPreferredMemType(Ceed ceed, CeedMemType *type); 180 181 CEED_EXTERN int CeedVectorCreate(Ceed ceed, CeedSize len, CeedVector *vec); 182 CEED_EXTERN int CeedVectorReferenceCopy(CeedVector vec, CeedVector *vec_copy); 183 CEED_EXTERN int CeedVectorCopy(CeedVector vec, CeedVector vec_copy); 184 CEED_EXTERN int CeedVectorSetArray(CeedVector vec, CeedMemType mem_type, CeedCopyMode copy_mode, CeedScalar *array); 185 CEED_EXTERN int CeedVectorSetValue(CeedVector vec, CeedScalar value); 186 CEED_EXTERN int CeedVectorSyncArray(CeedVector vec, CeedMemType mem_type); 187 CEED_EXTERN int CeedVectorTakeArray(CeedVector vec, CeedMemType mem_type, CeedScalar **array); 188 CEED_EXTERN int CeedVectorGetArray(CeedVector vec, CeedMemType mem_type, CeedScalar **array); 189 CEED_EXTERN int CeedVectorGetArrayRead(CeedVector vec, CeedMemType mem_type, const CeedScalar **array); 190 CEED_EXTERN int CeedVectorGetArrayWrite(CeedVector vec, CeedMemType mem_type, CeedScalar **array); 191 CEED_EXTERN int CeedVectorRestoreArray(CeedVector vec, CeedScalar **array); 192 CEED_EXTERN int CeedVectorRestoreArrayRead(CeedVector vec, const CeedScalar **array); 193 CEED_EXTERN int CeedVectorNorm(CeedVector vec, CeedNormType type, CeedScalar *norm); 194 CEED_EXTERN int CeedVectorScale(CeedVector x, CeedScalar alpha); 195 CEED_EXTERN int CeedVectorAXPY(CeedVector y, CeedScalar alpha, CeedVector x); 196 CEED_EXTERN int CeedVectorAXPBY(CeedVector y, CeedScalar alpha, CeedScalar beta, CeedVector x); 197 CEED_EXTERN int CeedVectorPointwiseMult(CeedVector w, CeedVector x, CeedVector y); 198 CEED_EXTERN int CeedVectorReciprocal(CeedVector vec); 199 CEED_EXTERN int CeedVectorViewRange(CeedVector vec, CeedSize start, CeedSize stop, CeedInt step, const char *fp_fmt, FILE *stream); 200 CEED_EXTERN int CeedVectorView(CeedVector vec, const char *fp_fmt, FILE *stream); 201 CEED_EXTERN int CeedVectorGetCeed(CeedVector vec, Ceed *ceed); 202 CEED_EXTERN int CeedVectorGetLength(CeedVector vec, CeedSize *length); 203 CEED_EXTERN int CeedVectorDestroy(CeedVector *vec); 204 205 CEED_EXTERN CeedRequest *const CEED_REQUEST_IMMEDIATE; 206 CEED_EXTERN CeedRequest *const CEED_REQUEST_ORDERED; 207 CEED_EXTERN int CeedRequestWait(CeedRequest *req); 208 209 /// Argument for @ref CeedOperatorSetField() to use active input or output. 210 /// @ingroup CeedVector 211 CEED_EXTERN const CeedVector CEED_VECTOR_ACTIVE; 212 213 /// Argument for @ref CeedOperatorSetField() to use no `CeedVector`. 214 /// Only use this option with @ref CeedEvalMode @ref CEED_EVAL_WEIGHT. 215 /// @ingroup CeedVector 216 CEED_EXTERN const CeedVector CEED_VECTOR_NONE; 217 218 /// Argument for @ref CeedOperatorSetField() that no basis operation is needed to translate between the E-vector and the Q-vector. 219 /// Only use this option with @ref CeedEvalMode @ref CEED_EVAL_NONE. 220 /// @ingroup CeedBasis 221 CEED_EXTERN const CeedBasis CEED_BASIS_NONE; 222 223 /// Argument for @ref CeedOperatorSetField() to use no `CeedElemRestriction`. 224 /// Only use this option with @ref CeedEvalMode @ref CEED_EVAL_WEIGHT. 225 /// @ingroup CeedElemRestriction 226 CEED_EXTERN const CeedElemRestriction CEED_ELEMRESTRICTION_NONE; 227 228 /// Argument for @ref CeedOperatorCreate() that `CeedQFunction` is not created by user. 229 /// Only used for `CeedQFunction` `dqf` and `dqfT`. 230 /// If implemented, a backend may attempt to provide the action of these `CeedQFunction`. 231 /// @ingroup CeedQFunction 232 CEED_EXTERN const CeedQFunction CEED_QFUNCTION_NONE; 233 234 /// Argument for @ref CeedElemRestrictionCreateStrided() that L-vector is in the Ceed backend's preferred layout. 235 /// This argument should only be used with vectors created by a Ceed backend. 236 /// @ingroup CeedElemRestriction 237 CEED_EXTERN const CeedInt CEED_STRIDES_BACKEND[3]; 238 239 CEED_EXTERN int CeedElemRestrictionCreate(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt num_comp, CeedInt comp_stride, CeedSize l_size, 240 CeedMemType mem_type, CeedCopyMode copy_mode, const CeedInt *offsets, CeedElemRestriction *rstr); 241 CEED_EXTERN int CeedElemRestrictionCreateOriented(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt num_comp, CeedInt comp_stride, 242 CeedSize l_size, CeedMemType mem_type, CeedCopyMode copy_mode, const CeedInt *offsets, 243 const bool *orients, CeedElemRestriction *rstr); 244 CEED_EXTERN int CeedElemRestrictionCreateCurlOriented(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt num_comp, CeedInt comp_stride, 245 CeedSize l_size, CeedMemType mem_type, CeedCopyMode copy_mode, const CeedInt *offsets, 246 const CeedInt8 *curl_orients, CeedElemRestriction *rstr); 247 CEED_EXTERN int CeedElemRestrictionCreateStrided(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt num_comp, CeedSize l_size, 248 const CeedInt strides[3], CeedElemRestriction *rstr); 249 CEED_EXTERN int CeedElemRestrictionCreateAtPoints(Ceed ceed, CeedInt num_elem, CeedInt num_points, CeedInt num_comp, CeedSize l_size, 250 CeedMemType mem_type, CeedCopyMode copy_mode, const CeedInt *offsets, CeedElemRestriction *rstr); 251 CEED_EXTERN int CeedElemRestrictionCreateBlocked(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt block_size, CeedInt num_comp, 252 CeedInt comp_stride, CeedSize l_size, CeedMemType mem_type, CeedCopyMode copy_mode, 253 const CeedInt *offsets, CeedElemRestriction *rstr); 254 CEED_EXTERN int CeedElemRestrictionCreateBlockedOriented(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt block_size, CeedInt num_comp, 255 CeedInt comp_stride, CeedSize l_size, CeedMemType mem_type, CeedCopyMode copy_mode, 256 const CeedInt *offsets, const bool *orients, CeedElemRestriction *rstr); 257 CEED_EXTERN int CeedElemRestrictionCreateBlockedCurlOriented(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt block_size, CeedInt num_comp, 258 CeedInt comp_stride, CeedSize l_size, CeedMemType mem_type, CeedCopyMode copy_mode, 259 const CeedInt *offsets, const CeedInt8 *curl_orients, CeedElemRestriction *rstr); 260 CEED_EXTERN int CeedElemRestrictionCreateBlockedStrided(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt block_size, CeedInt num_comp, 261 CeedSize l_size, const CeedInt strides[3], CeedElemRestriction *rstr); 262 CEED_EXTERN int CeedElemRestrictionCreateUnsignedCopy(CeedElemRestriction rstr, CeedElemRestriction *rstr_unsigned); 263 CEED_EXTERN int CeedElemRestrictionCreateUnorientedCopy(CeedElemRestriction rstr, CeedElemRestriction *rstr_unoriented); 264 CEED_EXTERN int CeedElemRestrictionReferenceCopy(CeedElemRestriction rstr, CeedElemRestriction *rstr_copy); 265 CEED_EXTERN int CeedElemRestrictionCreateVector(CeedElemRestriction rstr, CeedVector *lvec, CeedVector *evec); 266 CEED_EXTERN int CeedElemRestrictionApply(CeedElemRestriction rstr, CeedTransposeMode t_mode, CeedVector u, CeedVector ru, CeedRequest *request); 267 CEED_EXTERN int CeedElemRestrictionApplyAtPointsInElement(CeedElemRestriction rstr, CeedInt elem, CeedTransposeMode t_mode, CeedVector u, 268 CeedVector ru, CeedRequest *request); 269 CEED_EXTERN int CeedElemRestrictionApplyBlock(CeedElemRestriction rstr, CeedInt block, CeedTransposeMode t_mode, CeedVector u, CeedVector ru, 270 CeedRequest *request); 271 CEED_EXTERN int CeedElemRestrictionGetCeed(CeedElemRestriction rstr, Ceed *ceed); 272 CEED_EXTERN int CeedElemRestrictionGetCompStride(CeedElemRestriction rstr, CeedInt *comp_stride); 273 CEED_EXTERN int CeedElemRestrictionGetNumElements(CeedElemRestriction rstr, CeedInt *num_elem); 274 CEED_EXTERN int CeedElemRestrictionGetElementSize(CeedElemRestriction rstr, CeedInt *elem_size); 275 CEED_EXTERN int CeedElemRestrictionGetNumPoints(CeedElemRestriction rstr, CeedInt *num_points); 276 CEED_EXTERN int CeedElemRestrictionGetNumPointsInElement(CeedElemRestriction rstr, CeedInt elem, CeedInt *num_points); 277 CEED_EXTERN int CeedElemRestrictionGetMaxPointsInElement(CeedElemRestriction rstr, CeedInt *max_points); 278 CEED_EXTERN int CeedElemRestrictionGetLVectorSize(CeedElemRestriction rstr, CeedSize *l_size); 279 CEED_EXTERN int CeedElemRestrictionGetNumComponents(CeedElemRestriction rstr, CeedInt *num_comp); 280 CEED_EXTERN int CeedElemRestrictionGetNumBlocks(CeedElemRestriction rstr, CeedInt *num_block); 281 CEED_EXTERN int CeedElemRestrictionGetBlockSize(CeedElemRestriction rstr, CeedInt *block_size); 282 CEED_EXTERN int CeedElemRestrictionGetMultiplicity(CeedElemRestriction rstr, CeedVector mult); 283 CEED_EXTERN int CeedElemRestrictionView(CeedElemRestriction rstr, FILE *stream); 284 CEED_EXTERN int CeedElemRestrictionDestroy(CeedElemRestriction *rstr); 285 286 // The formalism here is that we have the structure 287 // \int_\Omega v^T f_0(u, \nabla u, qdata) + (\nabla v)^T f_1(u, \nabla u, qdata) 288 // where gradients are with respect to the reference element. 289 290 CEED_EXTERN int CeedBasisCreateTensorH1Lagrange(Ceed ceed, CeedInt dim, CeedInt num_comp, CeedInt P, CeedInt Q, CeedQuadMode quad_mode, 291 CeedBasis *basis); 292 CEED_EXTERN int CeedBasisCreateTensorH1(Ceed ceed, CeedInt dim, CeedInt num_comp, CeedInt P_1d, CeedInt Q_1d, const CeedScalar *interp_1d, 293 const CeedScalar *grad_1d, const CeedScalar *q_ref_1d, const CeedScalar *q_weight_1d, CeedBasis *basis); 294 CEED_EXTERN int CeedBasisCreateH1(Ceed ceed, CeedElemTopology topo, CeedInt num_comp, CeedInt num_nodes, CeedInt nqpts, const CeedScalar *interp, 295 const CeedScalar *grad, const CeedScalar *q_ref, const CeedScalar *q_weights, CeedBasis *basis); 296 CEED_EXTERN int CeedBasisCreateHdiv(Ceed ceed, CeedElemTopology topo, CeedInt num_comp, CeedInt num_nodes, CeedInt nqpts, const CeedScalar *interp, 297 const CeedScalar *div, const CeedScalar *q_ref, const CeedScalar *q_weights, CeedBasis *basis); 298 CEED_EXTERN int CeedBasisCreateHcurl(Ceed ceed, CeedElemTopology topo, CeedInt num_comp, CeedInt num_nodes, CeedInt nqpts, const CeedScalar *interp, 299 const CeedScalar *curl, const CeedScalar *q_ref, const CeedScalar *q_weights, CeedBasis *basis); 300 CEED_EXTERN int CeedBasisCreateProjection(CeedBasis basis_from, CeedBasis basis_to, CeedBasis *basis_project); 301 CEED_EXTERN int CeedBasisReferenceCopy(CeedBasis basis, CeedBasis *basis_copy); 302 CEED_EXTERN int CeedBasisView(CeedBasis basis, FILE *stream); 303 CEED_EXTERN int CeedBasisApply(CeedBasis basis, CeedInt num_elem, CeedTransposeMode t_mode, CeedEvalMode eval_mode, CeedVector u, CeedVector v); 304 CEED_EXTERN int CeedBasisApplyAtPoints(CeedBasis basis, CeedInt num_points, CeedTransposeMode t_mode, CeedEvalMode eval_mode, CeedVector x_ref, 305 CeedVector u, CeedVector v); 306 CEED_EXTERN int CeedBasisGetCeed(CeedBasis basis, Ceed *ceed); 307 CEED_EXTERN int CeedBasisGetDimension(CeedBasis basis, CeedInt *dim); 308 CEED_EXTERN int CeedBasisGetTopology(CeedBasis basis, CeedElemTopology *topo); 309 CEED_EXTERN int CeedBasisGetNumComponents(CeedBasis basis, CeedInt *num_comp); 310 CEED_EXTERN int CeedBasisGetNumNodes(CeedBasis basis, CeedInt *P); 311 CEED_EXTERN int CeedBasisGetNumNodes1D(CeedBasis basis, CeedInt *P_1d); 312 CEED_EXTERN int CeedBasisGetNumQuadraturePoints(CeedBasis basis, CeedInt *Q); 313 CEED_EXTERN int CeedBasisGetNumQuadraturePoints1D(CeedBasis basis, CeedInt *Q_1d); 314 CEED_EXTERN int CeedBasisGetQRef(CeedBasis basis, const CeedScalar **q_ref); 315 CEED_EXTERN int CeedBasisGetQWeights(CeedBasis basis, const CeedScalar **q_weights); 316 CEED_EXTERN int CeedBasisGetInterp(CeedBasis basis, const CeedScalar **interp); 317 CEED_EXTERN int CeedBasisGetInterp1D(CeedBasis basis, const CeedScalar **interp_1d); 318 CEED_EXTERN int CeedBasisGetGrad(CeedBasis basis, const CeedScalar **grad); 319 CEED_EXTERN int CeedBasisGetGrad1D(CeedBasis basis, const CeedScalar **grad_1d); 320 CEED_EXTERN int CeedBasisGetDiv(CeedBasis basis, const CeedScalar **div); 321 CEED_EXTERN int CeedBasisGetCurl(CeedBasis basis, const CeedScalar **curl); 322 CEED_EXTERN int CeedBasisDestroy(CeedBasis *basis); 323 324 CEED_EXTERN int CeedGaussQuadrature(CeedInt Q, CeedScalar *q_ref_1d, CeedScalar *q_weight_1d); 325 CEED_EXTERN int CeedLobattoQuadrature(CeedInt Q, CeedScalar *q_ref_1d, CeedScalar *q_weight_1d); 326 327 /** Handle for the user provided `CeedQFunction` callback function 328 329 @param[in,out] ctx User-defined context set using @ref CeedQFunctionSetContext() or `NULL` 330 @param[in] Q Number of quadrature points at which to evaluate 331 @param[in] in Array of pointers to each input argument in the order provided by the user in @ref CeedQFunctionAddInput(). 332 Each array has shape `[dim, num_comp, Q]` where `dim` is the geometric dimension for @ref CEED_EVAL_GRAD (`dim=1` for @ref CEED_EVAL_INTERP) and `num_comp` is the number of field components (`num_comp=1` for scalar fields). 333 This results in indexing the `i`th input at quadrature point `j` as `in[i][(d*num_comp + c)*Q + j]`. 334 @param[out] out Array of pointers to each output array in the order provided using @ref CeedQFunctionAddOutput(). 335 The shapes are as above for `in`. 336 337 @return An error code: 0 - success, otherwise - failure 338 339 @ingroup CeedQFunction 340 **/ 341 typedef int (*CeedQFunctionUser)(void *ctx, const CeedInt Q, const CeedScalar *const *in, CeedScalar *const *out); 342 343 CEED_EXTERN int CeedQFunctionCreateInterior(Ceed ceed, CeedInt vec_length, CeedQFunctionUser f, const char *source, CeedQFunction *qf); 344 CEED_EXTERN int CeedQFunctionCreateInteriorByName(Ceed ceed, const char *name, CeedQFunction *qf); 345 CEED_EXTERN int CeedQFunctionCreateIdentity(Ceed ceed, CeedInt size, CeedEvalMode in_mode, CeedEvalMode out_mode, CeedQFunction *qf); 346 CEED_EXTERN int CeedQFunctionReferenceCopy(CeedQFunction qf, CeedQFunction *qf_copy); 347 CEED_EXTERN int CeedQFunctionAddInput(CeedQFunction qf, const char *field_name, CeedInt size, CeedEvalMode eval_mode); 348 CEED_EXTERN int CeedQFunctionAddOutput(CeedQFunction qf, const char *field_name, CeedInt size, CeedEvalMode eval_mode); 349 CEED_EXTERN int CeedQFunctionGetFields(CeedQFunction qf, CeedInt *num_input_fields, CeedQFunctionField **input_fields, CeedInt *num_output_fields, 350 CeedQFunctionField **output_fields); 351 CEED_EXTERN int CeedQFunctionSetContext(CeedQFunction qf, CeedQFunctionContext ctx); 352 CEED_EXTERN int CeedQFunctionSetContextWritable(CeedQFunction qf, bool is_writable); 353 CEED_EXTERN int CeedQFunctionSetUserFlopsEstimate(CeedQFunction qf, CeedSize flops); 354 CEED_EXTERN int CeedQFunctionView(CeedQFunction qf, FILE *stream); 355 CEED_EXTERN int CeedQFunctionGetCeed(CeedQFunction qf, Ceed *ceed); 356 CEED_EXTERN int CeedQFunctionApply(CeedQFunction qf, CeedInt Q, CeedVector *u, CeedVector *v); 357 CEED_EXTERN int CeedQFunctionDestroy(CeedQFunction *qf); 358 359 CEED_EXTERN int CeedQFunctionFieldGetName(CeedQFunctionField qf_field, char **field_name); 360 CEED_EXTERN int CeedQFunctionFieldGetSize(CeedQFunctionField qf_field, CeedInt *size); 361 CEED_EXTERN int CeedQFunctionFieldGetEvalMode(CeedQFunctionField qf_field, CeedEvalMode *eval_mode); 362 363 /** Handle for the user provided @ref CeedQFunctionContextDestroy() callback function 364 365 @param[in,out] data User `CeedQFunctionContext` data 366 367 @return An error code: 0 - success, otherwise - failure 368 369 @ingroup CeedQFunction 370 **/ 371 typedef int (*CeedQFunctionContextDataDestroyUser)(void *data); 372 373 CEED_EXTERN int CeedQFunctionContextCreate(Ceed ceed, CeedQFunctionContext *ctx); 374 CEED_EXTERN int CeedQFunctionContextReferenceCopy(CeedQFunctionContext ctx, CeedQFunctionContext *ctx_copy); 375 CEED_EXTERN int CeedQFunctionContextSetData(CeedQFunctionContext ctx, CeedMemType mem_type, CeedCopyMode copy_mode, size_t size, void *data); 376 CEED_EXTERN int CeedQFunctionContextTakeData(CeedQFunctionContext ctx, CeedMemType mem_type, void *data); 377 CEED_EXTERN int CeedQFunctionContextGetData(CeedQFunctionContext ctx, CeedMemType mem_type, void *data); 378 CEED_EXTERN int CeedQFunctionContextGetDataRead(CeedQFunctionContext ctx, CeedMemType mem_type, void *data); 379 CEED_EXTERN int CeedQFunctionContextRestoreData(CeedQFunctionContext ctx, void *data); 380 CEED_EXTERN int CeedQFunctionContextRestoreDataRead(CeedQFunctionContext ctx, void *data); 381 CEED_EXTERN int CeedQFunctionContextRegisterDouble(CeedQFunctionContext ctx, const char *field_name, size_t field_offset, size_t num_values, 382 const char *field_description); 383 CEED_EXTERN int CeedQFunctionContextRegisterInt32(CeedQFunctionContext ctx, const char *field_name, size_t field_offset, size_t num_values, 384 const char *field_description); 385 CEED_EXTERN int CeedQFunctionContextRegisterBoolean(CeedQFunctionContext ctx, const char *field_name, size_t field_offset, size_t num_values, 386 const char *field_description); 387 CEED_EXTERN int CeedQFunctionContextGetAllFieldLabels(CeedQFunctionContext ctx, const CeedContextFieldLabel **field_labels, CeedInt *num_fields); 388 CEED_EXTERN int CeedContextFieldLabelGetDescription(CeedContextFieldLabel label, const char **field_name, size_t *field_offset, size_t *num_values, 389 const char **field_description, CeedContextFieldType *field_type); 390 CEED_EXTERN int CeedQFunctionContextGetContextSize(CeedQFunctionContext ctx, size_t *ctx_size); 391 CEED_EXTERN int CeedQFunctionContextView(CeedQFunctionContext ctx, FILE *stream); 392 CEED_EXTERN int CeedQFunctionContextSetDataDestroy(CeedQFunctionContext ctx, CeedMemType f_mem_type, CeedQFunctionContextDataDestroyUser f); 393 CEED_EXTERN int CeedQFunctionContextDestroy(CeedQFunctionContext *ctx); 394 395 CEED_EXTERN int CeedOperatorCreate(Ceed ceed, CeedQFunction qf, CeedQFunction dqf, CeedQFunction dqfT, CeedOperator *op); 396 CEED_EXTERN int CeedOperatorCreateAtPoints(Ceed ceed, CeedQFunction qf, CeedQFunction dqf, CeedQFunction dqfT, CeedOperator *op); 397 CEED_EXTERN int CeedCompositeOperatorCreate(Ceed ceed, CeedOperator *op); 398 CEED_EXTERN int CeedOperatorReferenceCopy(CeedOperator op, CeedOperator *op_copy); 399 CEED_EXTERN int CeedOperatorSetField(CeedOperator op, const char *field_name, CeedElemRestriction rstr, CeedBasis basis, CeedVector vec); 400 CEED_EXTERN int CeedOperatorGetFields(CeedOperator op, CeedInt *num_input_fields, CeedOperatorField **input_fields, CeedInt *num_output_fields, 401 CeedOperatorField **output_fields); 402 403 CEED_EXTERN int CeedOperatorAtPointsSetPoints(CeedOperator op, CeedElemRestriction rstr_points, CeedVector point_coords); 404 CEED_EXTERN int CeedOperatorAtPointsGetPoints(CeedOperator op, CeedElemRestriction *rstr_points, CeedVector *point_coords); 405 CEED_EXTERN int CeedCompositeOperatorAddSub(CeedOperator composite_op, CeedOperator sub_op); 406 CEED_EXTERN int CeedCompositeOperatorGetNumSub(CeedOperator op, CeedInt *num_suboperators); 407 CEED_EXTERN int CeedCompositeOperatorGetSubList(CeedOperator op, CeedOperator **sub_operators); 408 CEED_EXTERN int CeedOperatorCheckReady(CeedOperator op); 409 CEED_EXTERN int CeedOperatorGetActiveVectorLengths(CeedOperator op, CeedSize *input_size, CeedSize *output_size); 410 CEED_EXTERN int CeedOperatorSetQFunctionAssemblyReuse(CeedOperator op, bool reuse_assembly_data); 411 CEED_EXTERN int CeedOperatorSetQFunctionAssemblyDataUpdateNeeded(CeedOperator op, bool needs_data_update); 412 CEED_EXTERN int CeedOperatorLinearAssembleQFunction(CeedOperator op, CeedVector *assembled, CeedElemRestriction *rstr, CeedRequest *request); 413 CEED_EXTERN int CeedOperatorLinearAssembleQFunctionBuildOrUpdate(CeedOperator op, CeedVector *assembled, CeedElemRestriction *rstr, 414 CeedRequest *request); 415 CEED_EXTERN int CeedOperatorLinearAssembleDiagonal(CeedOperator op, CeedVector assembled, CeedRequest *request); 416 CEED_EXTERN int CeedOperatorLinearAssembleAddDiagonal(CeedOperator op, CeedVector assembled, CeedRequest *request); 417 CEED_EXTERN int CeedOperatorLinearAssemblePointBlockDiagonal(CeedOperator op, CeedVector assembled, CeedRequest *request); 418 CEED_EXTERN int CeedOperatorLinearAssembleAddPointBlockDiagonal(CeedOperator op, CeedVector assembled, CeedRequest *request); 419 CEED_EXTERN int CeedOperatorLinearAssemblePointBlockDiagonalSymbolic(CeedOperator op, CeedSize *num_entries, CeedInt **rows, CeedInt **cols); 420 CEED_EXTERN int CeedOperatorLinearAssembleSymbolic(CeedOperator op, CeedSize *num_entries, CeedInt **rows, CeedInt **cols); 421 CEED_EXTERN int CeedOperatorLinearAssemble(CeedOperator op, CeedVector values); 422 CEED_EXTERN int CeedCompositeOperatorGetMultiplicity(CeedOperator op, CeedInt num_skip_indices, CeedInt *skip_indices, CeedVector mult); 423 CEED_EXTERN int CeedOperatorMultigridLevelCreate(CeedOperator op_fine, CeedVector p_mult_fine, CeedElemRestriction rstr_coarse, 424 CeedBasis basis_coarse, CeedOperator *op_coarse, CeedOperator *op_prolong, 425 CeedOperator *op_restrict); 426 CEED_EXTERN int CeedOperatorMultigridLevelCreateTensorH1(CeedOperator op_fine, CeedVector p_mult_fine, CeedElemRestriction rstr_coarse, 427 CeedBasis basis_coarse, const CeedScalar *interp_c_to_f, CeedOperator *op_coarse, 428 CeedOperator *op_prolong, CeedOperator *op_restrict); 429 CEED_EXTERN int CeedOperatorMultigridLevelCreateH1(CeedOperator op_fine, CeedVector p_mult_fine, CeedElemRestriction rstr_coarse, 430 CeedBasis basis_coarse, const CeedScalar *interp_c_to_f, CeedOperator *op_coarse, 431 CeedOperator *op_prolong, CeedOperator *op_restrict); 432 CEED_EXTERN int CeedOperatorCreateFDMElementInverse(CeedOperator op, CeedOperator *fdm_inv, CeedRequest *request); 433 CEED_EXTERN int CeedOperatorSetName(CeedOperator op, const char *name); 434 CEED_EXTERN int CeedOperatorView(CeedOperator op, FILE *stream); 435 CEED_EXTERN int CeedOperatorGetCeed(CeedOperator op, Ceed *ceed); 436 CEED_EXTERN int CeedOperatorGetNumElements(CeedOperator op, CeedInt *num_elem); 437 CEED_EXTERN int CeedOperatorGetNumQuadraturePoints(CeedOperator op, CeedInt *num_qpts); 438 CEED_EXTERN int CeedOperatorGetFlopsEstimate(CeedOperator op, CeedSize *flops); 439 CEED_EXTERN int CeedOperatorGetContext(CeedOperator op, CeedQFunctionContext *ctx); 440 CEED_EXTERN int CeedOperatorGetContextFieldLabel(CeedOperator op, const char *field_name, CeedContextFieldLabel *field_label); 441 CEED_EXTERN int CeedOperatorSetContextDouble(CeedOperator op, CeedContextFieldLabel field_label, double *values); 442 CEED_EXTERN int CeedOperatorGetContextDoubleRead(CeedOperator op, CeedContextFieldLabel field_label, size_t *num_values, const double **values); 443 CEED_EXTERN int CeedOperatorRestoreContextDoubleRead(CeedOperator op, CeedContextFieldLabel field_label, const double **values); 444 CEED_EXTERN int CeedOperatorSetContextInt32(CeedOperator op, CeedContextFieldLabel field_label, int32_t *values); 445 CEED_EXTERN int CeedOperatorGetContextInt32Read(CeedOperator op, CeedContextFieldLabel field_label, size_t *num_values, const int32_t **values); 446 CEED_EXTERN int CeedOperatorRestoreContextInt32Read(CeedOperator op, CeedContextFieldLabel field_label, const int32_t **values); 447 CEED_EXTERN int CeedOperatorSetContextBoolean(CeedOperator op, CeedContextFieldLabel field_label, bool *values); 448 CEED_EXTERN int CeedOperatorGetContextBooleanRead(CeedOperator op, CeedContextFieldLabel field_label, size_t *num_values, const bool **values); 449 CEED_EXTERN int CeedOperatorRestoreContextBooleanRead(CeedOperator op, CeedContextFieldLabel field_label, const bool **values); 450 CEED_EXTERN int CeedOperatorApply(CeedOperator op, CeedVector in, CeedVector out, CeedRequest *request); 451 CEED_EXTERN int CeedOperatorApplyAdd(CeedOperator op, CeedVector in, CeedVector out, CeedRequest *request); 452 CEED_EXTERN int CeedOperatorDestroy(CeedOperator *op); 453 454 CEED_EXTERN int CeedOperatorGetFieldByName(CeedOperator op, const char *field_name, CeedOperatorField *op_field); 455 CEED_EXTERN int CeedOperatorFieldGetName(CeedOperatorField op_field, char **field_name); 456 CEED_EXTERN int CeedOperatorFieldGetElemRestriction(CeedOperatorField op_field, CeedElemRestriction *rstr); 457 CEED_EXTERN int CeedOperatorFieldGetBasis(CeedOperatorField op_field, CeedBasis *basis); 458 CEED_EXTERN int CeedOperatorFieldGetVector(CeedOperatorField op_field, CeedVector *vec); 459 460 /** 461 @brief Return integer power 462 463 @param[in] base The base to exponentiate 464 @param[in] power The power to raise the base to 465 466 @return base^power 467 468 @ref Utility 469 **/ 470 static inline CeedInt CeedIntPow(CeedInt base, CeedInt power) { 471 CeedInt result = 1; 472 while (power) { 473 if (power & 1) result *= base; 474 power >>= 1; 475 base *= base; 476 } 477 return result; 478 } 479 480 /** 481 @brief Return minimum of two integers 482 483 @param[in] a The first integer to compare 484 @param[in] b The second integer to compare 485 486 @return The minimum of the two integers 487 488 @ref Utility 489 **/ 490 static inline CeedInt CeedIntMin(CeedInt a, CeedInt b) { return a < b ? a : b; } 491 492 /** 493 @brief Return maximum of two integers 494 495 @param[in] a The first integer to compare 496 @param[in] b The second integer to compare 497 498 @return The maximum of the two integers 499 500 @ref Utility 501 **/ 502 static inline CeedInt CeedIntMax(CeedInt a, CeedInt b) { return a > b ? a : b; } 503 504 // Used to ensure initialization before CeedInit() 505 CEED_EXTERN int CeedRegisterAll(void); 506 // Used to ensure initialization before CeedQFunctionCreate*() 507 CEED_EXTERN int CeedQFunctionRegisterAll(void); 508 509 #endif // CEED_H 510