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