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