1 /// Copyright (c) 2017-2024, 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 #pragma once 11 12 /// @defgroup Ceed Ceed: core components 13 /// @defgroup CeedVector CeedVector: storing and manipulating vectors 14 /// @defgroup CeedElemRestriction CeedElemRestriction: restriction from local vectors to elements 15 /// @defgroup CeedBasis CeedBasis: fully discrete finite element-like objects 16 /// @defgroup CeedQFunction CeedQFunction: independent operations at quadrature points 17 /// @defgroup CeedOperator CeedOperator: composed FE-type operations on vectors 18 /// 19 /// @page FunctionCategories libCEED: Types of Functions libCEED provides three different header files depending upon the type of functions a user 20 /// requires. 21 /// @section Utility Utility Functions 22 /// These functions are intended general utilities that may be useful to libCEED developers and users. 23 /// These functions can generally be found in `"ceed.h"`. 24 /// @section User User Functions 25 /// These functions are intended to be used by general users of libCEED and can generally be found in `"ceed.h"`. 26 /// @section Advanced Advanced Functions 27 /// These functions are intended to be used by advanced users of libCEED and can generally be found in `"ceed.h"`. 28 /// @section Backend Backend Developer Functions 29 /// These functions are intended to be used by backend developers of libCEED and can generally be found in `"ceed-backend.h"`. 30 /// @section Developer Library Developer Functions 31 /// These functions are intended to be used by library developers of libCEED and can generally be found in `"ceed-impl.h"`. 32 33 #if !defined(CEED_SKIP_VISIBILITY) 34 #define CEED_VISIBILITY(mode) __attribute__((visibility(#mode))) 35 #else 36 #define CEED_VISIBILITY(mode) 37 #endif 38 39 /* 40 CEED_EXTERN is used in this header to denote all publicly visible symbols. 41 42 No other file should declare publicly visible symbols, thus it should never be used outside `"ceed.h"`. 43 */ 44 #if defined(__clang_analyzer__) 45 #define CEED_EXTERN extern 46 #elif defined(__cplusplus) 47 #define CEED_EXTERN extern "C" CEED_VISIBILITY(default) 48 #else 49 #define CEED_EXTERN extern CEED_VISIBILITY(default) 50 #endif 51 52 #include <stdarg.h> 53 #include <stdbool.h> 54 #include <stdio.h> 55 56 /* 57 Typedefs and macros used in public interfaces and user `CeedQFunction` source 58 */ 59 #include "types.h" // IWYU pragma: export 60 61 /* 62 This line prevents IWYU from suggesting "ceed.h" 63 */ 64 // IWYU pragma: private, include <ceed.h> 65 66 /// Library context created by CeedInit() 67 /// @ingroup CeedUser 68 typedef struct Ceed_private *Ceed; 69 /// Non-blocking Ceed interfaces return a CeedRequest. 70 /// To perform an operation immediately, pass @ref CEED_REQUEST_IMMEDIATE instead. 71 /// @ingroup CeedUser 72 typedef struct CeedRequest_private *CeedRequest; 73 /// Handle for vectors over the field @ref CeedScalar 74 /// @ingroup CeedVectorUser 75 typedef struct CeedVector_private *CeedVector; 76 /// Handle for object describing restriction to elements 77 /// @ingroup CeedElemRestrictionUser 78 typedef struct CeedElemRestriction_private *CeedElemRestriction; 79 /// Handle for object describing discrete finite element evaluations 80 /// @ingroup CeedBasisUser 81 typedef struct CeedBasis_private *CeedBasis; 82 /// Handle for object describing CeedQFunction fields 83 /// @ingroup CeedQFunctionBackend 84 typedef struct CeedQFunctionField_private *CeedQFunctionField; 85 /// Handle for object describing functions evaluated independently at quadrature points 86 /// @ingroup CeedQFunctionUser 87 typedef struct CeedQFunction_private *CeedQFunction; 88 /// Handle for object describing CeedOperator fields 89 /// @ingroup CeedOperatorBackend 90 typedef struct CeedOperatorField_private *CeedOperatorField; 91 /// Handle for object describing context data for CeedQFunctions 92 /// @ingroup CeedQFunctionUser 93 typedef struct CeedQFunctionContext_private *CeedQFunctionContext; 94 /// Handle for object describing registered fields for CeedQFunctionContext 95 /// @ingroup CeedQFunctionUser 96 typedef struct CeedContextFieldLabel_private *CeedContextFieldLabel; 97 /// Handle for object describing FE-type operators acting on vectors 98 /// 99 /// 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$. 100 /// @ingroup CeedOperatorUser 101 typedef struct CeedOperator_private *CeedOperator; 102 103 CEED_EXTERN int CeedRegistryGetList(size_t *n, char ***const resources, CeedInt **array); 104 CEED_EXTERN int CeedInit(const char *resource, Ceed *ceed); 105 CEED_EXTERN int CeedSetStream(Ceed ceed, void *handle); 106 CEED_EXTERN int CeedReferenceCopy(Ceed ceed, Ceed *ceed_copy); 107 CEED_EXTERN int CeedGetResource(Ceed ceed, const char **resource); 108 CEED_EXTERN int CeedIsDeterministic(Ceed ceed, bool *is_deterministic); 109 CEED_EXTERN int CeedAddJitSourceRoot(Ceed ceed, const char *jit_source_root); 110 CEED_EXTERN int CeedAddJitDefine(Ceed ceed, const char *jit_define); 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 CeedVectorCopyStrided(CeedVector vec, CeedSize start, CeedInt step, CeedVector vec_copy); 185 CEED_EXTERN int CeedVectorSetArray(CeedVector vec, CeedMemType mem_type, CeedCopyMode copy_mode, CeedScalar *array); 186 CEED_EXTERN int CeedVectorSetValue(CeedVector vec, CeedScalar value); 187 CEED_EXTERN int CeedVectorSetValueStrided(CeedVector vec, CeedSize start, CeedInt step, CeedScalar value); 188 CEED_EXTERN int CeedVectorSyncArray(CeedVector vec, CeedMemType mem_type); 189 CEED_EXTERN int CeedVectorTakeArray(CeedVector vec, CeedMemType mem_type, CeedScalar **array); 190 CEED_EXTERN int CeedVectorGetArray(CeedVector vec, CeedMemType mem_type, CeedScalar **array); 191 CEED_EXTERN int CeedVectorGetArrayRead(CeedVector vec, CeedMemType mem_type, const CeedScalar **array); 192 CEED_EXTERN int CeedVectorGetArrayWrite(CeedVector vec, CeedMemType mem_type, CeedScalar **array); 193 CEED_EXTERN int CeedVectorRestoreArray(CeedVector vec, CeedScalar **array); 194 CEED_EXTERN int CeedVectorRestoreArrayRead(CeedVector vec, const CeedScalar **array); 195 CEED_EXTERN int CeedVectorNorm(CeedVector vec, CeedNormType type, CeedScalar *norm); 196 CEED_EXTERN int CeedVectorScale(CeedVector x, CeedScalar alpha); 197 CEED_EXTERN int CeedVectorAXPY(CeedVector y, CeedScalar alpha, CeedVector x); 198 CEED_EXTERN int CeedVectorAXPBY(CeedVector y, CeedScalar alpha, CeedScalar beta, CeedVector x); 199 CEED_EXTERN int CeedVectorPointwiseMult(CeedVector w, CeedVector x, CeedVector y); 200 CEED_EXTERN int CeedVectorReciprocal(CeedVector vec); 201 CEED_EXTERN int CeedVectorViewRange(CeedVector vec, CeedSize start, CeedSize stop, CeedInt step, const char *fp_fmt, FILE *stream); 202 CEED_EXTERN int CeedVectorView(CeedVector vec, const char *fp_fmt, FILE *stream); 203 CEED_EXTERN int CeedVectorGetCeed(CeedVector vec, Ceed *ceed); 204 CEED_EXTERN Ceed CeedVectorReturnCeed(CeedVector vec); 205 CEED_EXTERN int CeedVectorGetLength(CeedVector vec, CeedSize *length); 206 CEED_EXTERN int CeedVectorDestroy(CeedVector *vec); 207 208 CEED_EXTERN CeedRequest *const CEED_REQUEST_IMMEDIATE; 209 CEED_EXTERN CeedRequest *const CEED_REQUEST_ORDERED; 210 CEED_EXTERN int CeedRequestWait(CeedRequest *req); 211 212 /// Argument for @ref CeedOperatorSetField() to use active input or output. 213 /// @ingroup CeedVector 214 CEED_EXTERN const CeedVector CEED_VECTOR_ACTIVE; 215 216 /// Argument for @ref CeedOperatorSetField() to use no `CeedVector`. 217 /// Only use this option with @ref CeedEvalMode @ref CEED_EVAL_WEIGHT. 218 /// @ingroup CeedVector 219 CEED_EXTERN const CeedVector CEED_VECTOR_NONE; 220 221 /// Argument for @ref CeedOperatorSetField() that no basis operation is needed to translate between the E-vector and the Q-vector. 222 /// Only use this option with @ref CeedEvalMode @ref CEED_EVAL_NONE. 223 /// @ingroup CeedBasis 224 CEED_EXTERN const CeedBasis CEED_BASIS_NONE; 225 226 /// Argument for @ref CeedOperatorSetField() to use no `CeedElemRestriction`. 227 /// Only use this option with @ref CeedEvalMode @ref CEED_EVAL_WEIGHT. 228 /// @ingroup CeedElemRestriction 229 CEED_EXTERN const CeedElemRestriction CEED_ELEMRESTRICTION_NONE; 230 231 /// Argument for @ref CeedOperatorCreate() that `CeedQFunction` is not created by user. 232 /// Only used for `CeedQFunction` `dqf` and `dqfT`. 233 /// If implemented, a backend may attempt to provide the action of these `CeedQFunction`. 234 /// @ingroup CeedQFunction 235 CEED_EXTERN const CeedQFunction CEED_QFUNCTION_NONE; 236 237 /// Argument for @ref CeedElemRestrictionCreateStrided() that L-vector is in the Ceed backend's preferred layout. 238 /// This argument should only be used with vectors created by a Ceed backend. 239 /// @ingroup CeedElemRestriction 240 CEED_EXTERN const CeedInt CEED_STRIDES_BACKEND[3]; 241 242 CEED_EXTERN int CeedElemRestrictionCreate(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt num_comp, CeedInt comp_stride, CeedSize l_size, 243 CeedMemType mem_type, CeedCopyMode copy_mode, const CeedInt *offsets, CeedElemRestriction *rstr); 244 CEED_EXTERN int CeedElemRestrictionCreateOriented(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 bool *orients, CeedElemRestriction *rstr); 247 CEED_EXTERN int CeedElemRestrictionCreateCurlOriented(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt num_comp, CeedInt comp_stride, 248 CeedSize l_size, CeedMemType mem_type, CeedCopyMode copy_mode, const CeedInt *offsets, 249 const CeedInt8 *curl_orients, CeedElemRestriction *rstr); 250 CEED_EXTERN int CeedElemRestrictionCreateStrided(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt num_comp, CeedSize l_size, 251 const CeedInt strides[3], CeedElemRestriction *rstr); 252 CEED_EXTERN int CeedElemRestrictionCreateAtPoints(Ceed ceed, CeedInt num_elem, CeedInt num_points, CeedInt num_comp, CeedSize l_size, 253 CeedMemType mem_type, CeedCopyMode copy_mode, const CeedInt *offsets, CeedElemRestriction *rstr); 254 CEED_EXTERN int CeedElemRestrictionCreateBlocked(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, CeedElemRestriction *rstr); 257 CEED_EXTERN int CeedElemRestrictionCreateBlockedOriented(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 bool *orients, CeedElemRestriction *rstr); 260 CEED_EXTERN int CeedElemRestrictionCreateBlockedCurlOriented(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt block_size, CeedInt num_comp, 261 CeedInt comp_stride, CeedSize l_size, CeedMemType mem_type, CeedCopyMode copy_mode, 262 const CeedInt *offsets, const CeedInt8 *curl_orients, CeedElemRestriction *rstr); 263 CEED_EXTERN int CeedElemRestrictionCreateBlockedStrided(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt block_size, CeedInt num_comp, 264 CeedSize l_size, const CeedInt strides[3], CeedElemRestriction *rstr); 265 CEED_EXTERN int CeedElemRestrictionCreateUnsignedCopy(CeedElemRestriction rstr, CeedElemRestriction *rstr_unsigned); 266 CEED_EXTERN int CeedElemRestrictionCreateUnorientedCopy(CeedElemRestriction rstr, CeedElemRestriction *rstr_unoriented); 267 CEED_EXTERN int CeedElemRestrictionReferenceCopy(CeedElemRestriction rstr, CeedElemRestriction *rstr_copy); 268 CEED_EXTERN int CeedElemRestrictionCreateVector(CeedElemRestriction rstr, CeedVector *lvec, CeedVector *evec); 269 CEED_EXTERN int CeedElemRestrictionApply(CeedElemRestriction rstr, CeedTransposeMode t_mode, CeedVector u, CeedVector ru, CeedRequest *request); 270 CEED_EXTERN int CeedElemRestrictionApplyAtPointsInElement(CeedElemRestriction rstr, CeedInt elem, CeedTransposeMode t_mode, CeedVector u, 271 CeedVector ru, CeedRequest *request); 272 CEED_EXTERN int CeedElemRestrictionApplyBlock(CeedElemRestriction rstr, CeedInt block, CeedTransposeMode t_mode, CeedVector u, CeedVector ru, 273 CeedRequest *request); 274 CEED_EXTERN int CeedElemRestrictionGetCeed(CeedElemRestriction rstr, Ceed *ceed); 275 CEED_EXTERN Ceed CeedElemRestrictionReturnCeed(CeedElemRestriction rstr); 276 CEED_EXTERN int CeedElemRestrictionGetCompStride(CeedElemRestriction rstr, CeedInt *comp_stride); 277 CEED_EXTERN int CeedElemRestrictionGetNumElements(CeedElemRestriction rstr, CeedInt *num_elem); 278 CEED_EXTERN int CeedElemRestrictionGetElementSize(CeedElemRestriction rstr, CeedInt *elem_size); 279 CEED_EXTERN int CeedElemRestrictionGetNumPoints(CeedElemRestriction rstr, CeedInt *num_points); 280 CEED_EXTERN int CeedElemRestrictionGetNumPointsInElement(CeedElemRestriction rstr, CeedInt elem, CeedInt *num_points); 281 CEED_EXTERN int CeedElemRestrictionGetMaxPointsInElement(CeedElemRestriction rstr, CeedInt *max_points); 282 CEED_EXTERN int CeedElemRestrictionGetMinPointsInElement(CeedElemRestriction rstr, CeedInt *min_points); 283 CEED_EXTERN int CeedElemRestrictionGetMinMaxPointsInElement(CeedElemRestriction rstr, CeedInt *min_points, CeedInt *max_points); 284 CEED_EXTERN int CeedElemRestrictionGetLVectorSize(CeedElemRestriction rstr, CeedSize *l_size); 285 CEED_EXTERN int CeedElemRestrictionGetEVectorSize(CeedElemRestriction rstr, CeedSize *e_size); 286 CEED_EXTERN int CeedElemRestrictionGetNumComponents(CeedElemRestriction rstr, CeedInt *num_comp); 287 CEED_EXTERN int CeedElemRestrictionGetNumBlocks(CeedElemRestriction rstr, CeedInt *num_block); 288 CEED_EXTERN int CeedElemRestrictionGetBlockSize(CeedElemRestriction rstr, CeedInt *block_size); 289 CEED_EXTERN int CeedElemRestrictionGetMultiplicity(CeedElemRestriction rstr, CeedVector mult); 290 CEED_EXTERN int CeedElemRestrictionView(CeedElemRestriction rstr, FILE *stream); 291 CEED_EXTERN int CeedElemRestrictionDestroy(CeedElemRestriction *rstr); 292 293 // The formalism here is that we have the structure 294 // \int_\Omega v^T f_0(u, \nabla u, qdata) + (\nabla v)^T f_1(u, \nabla u, qdata) 295 // where gradients are with respect to the reference element. 296 297 CEED_EXTERN int CeedBasisCreateTensorH1Lagrange(Ceed ceed, CeedInt dim, CeedInt num_comp, CeedInt P, CeedInt Q, CeedQuadMode quad_mode, 298 CeedBasis *basis); 299 CEED_EXTERN int CeedBasisCreateTensorH1(Ceed ceed, CeedInt dim, CeedInt num_comp, CeedInt P_1d, CeedInt Q_1d, const CeedScalar *interp_1d, 300 const CeedScalar *grad_1d, const CeedScalar *q_ref_1d, const CeedScalar *q_weight_1d, CeedBasis *basis); 301 CEED_EXTERN int CeedBasisCreateH1(Ceed ceed, CeedElemTopology topo, CeedInt num_comp, CeedInt num_nodes, CeedInt nqpts, const CeedScalar *interp, 302 const CeedScalar *grad, const CeedScalar *q_ref, const CeedScalar *q_weights, CeedBasis *basis); 303 CEED_EXTERN int CeedBasisCreateHdiv(Ceed ceed, CeedElemTopology topo, CeedInt num_comp, CeedInt num_nodes, CeedInt nqpts, const CeedScalar *interp, 304 const CeedScalar *div, const CeedScalar *q_ref, const CeedScalar *q_weights, CeedBasis *basis); 305 CEED_EXTERN int CeedBasisCreateHcurl(Ceed ceed, CeedElemTopology topo, CeedInt num_comp, CeedInt num_nodes, CeedInt nqpts, const CeedScalar *interp, 306 const CeedScalar *curl, const CeedScalar *q_ref, const CeedScalar *q_weights, CeedBasis *basis); 307 CEED_EXTERN int CeedBasisCreateProjection(CeedBasis basis_from, CeedBasis basis_to, CeedBasis *basis_project); 308 CEED_EXTERN int CeedBasisReferenceCopy(CeedBasis basis, CeedBasis *basis_copy); 309 CEED_EXTERN int CeedBasisView(CeedBasis basis, FILE *stream); 310 CEED_EXTERN int CeedBasisApply(CeedBasis basis, CeedInt num_elem, CeedTransposeMode t_mode, CeedEvalMode eval_mode, CeedVector u, CeedVector v); 311 CEED_EXTERN int CeedBasisApplyAdd(CeedBasis basis, CeedInt num_elem, CeedTransposeMode t_mode, CeedEvalMode eval_mode, CeedVector u, CeedVector v); 312 CEED_EXTERN int CeedBasisApplyAtPoints(CeedBasis basis, CeedInt num_elem, const CeedInt *num_points, CeedTransposeMode t_mode, CeedEvalMode eval_mode, 313 CeedVector x_ref, CeedVector u, CeedVector v); 314 CEED_EXTERN int CeedBasisApplyAddAtPoints(CeedBasis basis, CeedInt num_elem, const CeedInt *num_points, CeedTransposeMode t_mode, 315 CeedEvalMode eval_mode, CeedVector x_ref, CeedVector u, CeedVector v); 316 CEED_EXTERN int CeedBasisGetCeed(CeedBasis basis, Ceed *ceed); 317 CEED_EXTERN Ceed CeedBasisReturnCeed(CeedBasis basis); 318 CEED_EXTERN int CeedBasisGetDimension(CeedBasis basis, CeedInt *dim); 319 CEED_EXTERN int CeedBasisGetTopology(CeedBasis basis, CeedElemTopology *topo); 320 CEED_EXTERN int CeedBasisGetNumComponents(CeedBasis basis, CeedInt *num_comp); 321 CEED_EXTERN int CeedBasisGetNumNodes(CeedBasis basis, CeedInt *P); 322 CEED_EXTERN int CeedBasisGetNumNodes1D(CeedBasis basis, CeedInt *P_1d); 323 CEED_EXTERN int CeedBasisGetNumQuadraturePoints(CeedBasis basis, CeedInt *Q); 324 CEED_EXTERN int CeedBasisGetNumQuadraturePoints1D(CeedBasis basis, CeedInt *Q_1d); 325 CEED_EXTERN int CeedBasisGetQRef(CeedBasis basis, const CeedScalar **q_ref); 326 CEED_EXTERN int CeedBasisGetQWeights(CeedBasis basis, const CeedScalar **q_weights); 327 CEED_EXTERN int CeedBasisGetInterp(CeedBasis basis, const CeedScalar **interp); 328 CEED_EXTERN int CeedBasisGetInterp1D(CeedBasis basis, const CeedScalar **interp_1d); 329 CEED_EXTERN int CeedBasisGetGrad(CeedBasis basis, const CeedScalar **grad); 330 CEED_EXTERN int CeedBasisGetGrad1D(CeedBasis basis, const CeedScalar **grad_1d); 331 CEED_EXTERN int CeedBasisGetDiv(CeedBasis basis, const CeedScalar **div); 332 CEED_EXTERN int CeedBasisGetCurl(CeedBasis basis, const CeedScalar **curl); 333 CEED_EXTERN int CeedBasisDestroy(CeedBasis *basis); 334 335 CEED_EXTERN int CeedGaussQuadrature(CeedInt Q, CeedScalar *q_ref_1d, CeedScalar *q_weight_1d); 336 CEED_EXTERN int CeedLobattoQuadrature(CeedInt Q, CeedScalar *q_ref_1d, CeedScalar *q_weight_1d); 337 338 /** Handle for the user provided `CeedQFunction` callback function 339 340 @param[in,out] ctx User-defined context set using @ref CeedQFunctionSetContext() or `NULL` 341 @param[in] Q Number of quadrature points at which to evaluate 342 @param[in] in Array of pointers to each input argument in the order provided by the user in @ref CeedQFunctionAddInput(). 343 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). 344 This results in indexing the `i`th input at quadrature point `j` as `in[i][(d*num_comp + c)*Q + j]`. 345 @param[out] out Array of pointers to each output array in the order provided using @ref CeedQFunctionAddOutput(). 346 The shapes are as above for `in`. 347 348 @return An error code: 0 - success, otherwise - failure 349 350 @ingroup CeedQFunction 351 **/ 352 typedef int (*CeedQFunctionUser)(void *ctx, const CeedInt Q, const CeedScalar *const *in, CeedScalar *const *out); 353 354 CEED_EXTERN int CeedQFunctionCreateInterior(Ceed ceed, CeedInt vec_length, CeedQFunctionUser f, const char *source, CeedQFunction *qf); 355 CEED_EXTERN int CeedQFunctionCreateInteriorByName(Ceed ceed, const char *name, CeedQFunction *qf); 356 CEED_EXTERN int CeedQFunctionCreateIdentity(Ceed ceed, CeedInt size, CeedEvalMode in_mode, CeedEvalMode out_mode, CeedQFunction *qf); 357 CEED_EXTERN int CeedQFunctionReferenceCopy(CeedQFunction qf, CeedQFunction *qf_copy); 358 CEED_EXTERN int CeedQFunctionAddInput(CeedQFunction qf, const char *field_name, CeedInt size, CeedEvalMode eval_mode); 359 CEED_EXTERN int CeedQFunctionAddOutput(CeedQFunction qf, const char *field_name, CeedInt size, CeedEvalMode eval_mode); 360 CEED_EXTERN int CeedQFunctionGetFields(CeedQFunction qf, CeedInt *num_input_fields, CeedQFunctionField **input_fields, CeedInt *num_output_fields, 361 CeedQFunctionField **output_fields); 362 CEED_EXTERN int CeedQFunctionSetContext(CeedQFunction qf, CeedQFunctionContext ctx); 363 CEED_EXTERN int CeedQFunctionSetContextWritable(CeedQFunction qf, bool is_writable); 364 CEED_EXTERN int CeedQFunctionSetUserFlopsEstimate(CeedQFunction qf, CeedSize flops); 365 CEED_EXTERN int CeedQFunctionView(CeedQFunction qf, FILE *stream); 366 CEED_EXTERN int CeedQFunctionGetCeed(CeedQFunction qf, Ceed *ceed); 367 CEED_EXTERN Ceed CeedQFunctionReturnCeed(CeedQFunction qf); 368 CEED_EXTERN int CeedQFunctionApply(CeedQFunction qf, CeedInt Q, CeedVector *u, CeedVector *v); 369 CEED_EXTERN int CeedQFunctionDestroy(CeedQFunction *qf); 370 371 CEED_EXTERN int CeedQFunctionFieldGetName(CeedQFunctionField qf_field, const char **field_name); 372 CEED_EXTERN int CeedQFunctionFieldGetSize(CeedQFunctionField qf_field, CeedInt *size); 373 CEED_EXTERN int CeedQFunctionFieldGetEvalMode(CeedQFunctionField qf_field, CeedEvalMode *eval_mode); 374 CEED_EXTERN int CeedQFunctionFieldGetData(CeedQFunctionField qf_field, const char **field_name, CeedInt *size, CeedEvalMode *eval_mode); 375 376 /** Handle for the user provided @ref CeedQFunctionContextDestroy() callback function 377 378 @param[in,out] data User `CeedQFunctionContext` data 379 380 @return An error code: 0 - success, otherwise - failure 381 382 @ingroup CeedQFunction 383 **/ 384 typedef int (*CeedQFunctionContextDataDestroyUser)(void *data); 385 386 CEED_EXTERN int CeedQFunctionContextCreate(Ceed ceed, CeedQFunctionContext *ctx); 387 CEED_EXTERN int CeedQFunctionContextReferenceCopy(CeedQFunctionContext ctx, CeedQFunctionContext *ctx_copy); 388 CEED_EXTERN int CeedQFunctionContextSetData(CeedQFunctionContext ctx, CeedMemType mem_type, CeedCopyMode copy_mode, size_t size, void *data); 389 CEED_EXTERN int CeedQFunctionContextTakeData(CeedQFunctionContext ctx, CeedMemType mem_type, void *data); 390 CEED_EXTERN int CeedQFunctionContextGetData(CeedQFunctionContext ctx, CeedMemType mem_type, void *data); 391 CEED_EXTERN int CeedQFunctionContextGetDataRead(CeedQFunctionContext ctx, CeedMemType mem_type, void *data); 392 CEED_EXTERN int CeedQFunctionContextRestoreData(CeedQFunctionContext ctx, void *data); 393 CEED_EXTERN int CeedQFunctionContextRestoreDataRead(CeedQFunctionContext ctx, void *data); 394 CEED_EXTERN int CeedQFunctionContextRegisterDouble(CeedQFunctionContext ctx, const char *field_name, size_t field_offset, size_t num_values, 395 const char *field_description); 396 CEED_EXTERN int CeedQFunctionContextRegisterInt32(CeedQFunctionContext ctx, const char *field_name, size_t field_offset, size_t num_values, 397 const char *field_description); 398 CEED_EXTERN int CeedQFunctionContextRegisterBoolean(CeedQFunctionContext ctx, const char *field_name, size_t field_offset, size_t num_values, 399 const char *field_description); 400 CEED_EXTERN int CeedQFunctionContextGetAllFieldLabels(CeedQFunctionContext ctx, const CeedContextFieldLabel **field_labels, CeedInt *num_fields); 401 CEED_EXTERN int CeedContextFieldLabelGetDescription(CeedContextFieldLabel label, const char **field_name, size_t *field_offset, size_t *num_values, 402 const char **field_description, CeedContextFieldType *field_type); 403 CEED_EXTERN int CeedQFunctionContextGetContextSize(CeedQFunctionContext ctx, size_t *ctx_size); 404 CEED_EXTERN int CeedQFunctionContextView(CeedQFunctionContext ctx, FILE *stream); 405 CEED_EXTERN int CeedQFunctionContextSetDataDestroy(CeedQFunctionContext ctx, CeedMemType f_mem_type, CeedQFunctionContextDataDestroyUser f); 406 CEED_EXTERN int CeedQFunctionContextDestroy(CeedQFunctionContext *ctx); 407 408 CEED_EXTERN int CeedOperatorCreate(Ceed ceed, CeedQFunction qf, CeedQFunction dqf, CeedQFunction dqfT, CeedOperator *op); 409 CEED_EXTERN int CeedOperatorCreateAtPoints(Ceed ceed, CeedQFunction qf, CeedQFunction dqf, CeedQFunction dqfT, CeedOperator *op); 410 CEED_EXTERN int CeedCompositeOperatorCreate(Ceed ceed, CeedOperator *op); 411 CEED_EXTERN int CeedOperatorReferenceCopy(CeedOperator op, CeedOperator *op_copy); 412 CEED_EXTERN int CeedOperatorSetField(CeedOperator op, const char *field_name, CeedElemRestriction rstr, CeedBasis basis, CeedVector vec); 413 CEED_EXTERN int CeedOperatorGetFields(CeedOperator op, CeedInt *num_input_fields, CeedOperatorField **input_fields, CeedInt *num_output_fields, 414 CeedOperatorField **output_fields); 415 416 CEED_EXTERN int CeedOperatorAtPointsSetPoints(CeedOperator op, CeedElemRestriction rstr_points, CeedVector point_coords); 417 CEED_EXTERN int CeedOperatorAtPointsGetPoints(CeedOperator op, CeedElemRestriction *rstr_points, CeedVector *point_coords); 418 CEED_EXTERN int CeedOperatorIsAtPoints(CeedOperator op, bool *is_at_points); 419 CEED_EXTERN int CeedCompositeOperatorAddSub(CeedOperator composite_op, CeedOperator sub_op); 420 CEED_EXTERN int CeedCompositeOperatorGetNumSub(CeedOperator op, CeedInt *num_suboperators); 421 CEED_EXTERN int CeedCompositeOperatorGetSubList(CeedOperator op, CeedOperator **sub_operators); 422 CEED_EXTERN int CeedCompositeOperatorGetSubByName(CeedOperator op, const char *op_name, CeedOperator *sub_op); 423 CEED_EXTERN int CeedOperatorCheckReady(CeedOperator op); 424 CEED_EXTERN int CeedOperatorGetActiveVectorLengths(CeedOperator op, CeedSize *input_size, CeedSize *output_size); 425 CEED_EXTERN int CeedOperatorSetQFunctionAssemblyReuse(CeedOperator op, bool reuse_assembly_data); 426 CEED_EXTERN int CeedOperatorSetQFunctionAssemblyDataUpdateNeeded(CeedOperator op, bool needs_data_update); 427 CEED_EXTERN int CeedOperatorLinearAssembleQFunction(CeedOperator op, CeedVector *assembled, CeedElemRestriction *rstr, CeedRequest *request); 428 CEED_EXTERN int CeedOperatorLinearAssembleQFunctionBuildOrUpdate(CeedOperator op, CeedVector *assembled, CeedElemRestriction *rstr, 429 CeedRequest *request); 430 CEED_EXTERN int CeedOperatorLinearAssembleDiagonal(CeedOperator op, CeedVector assembled, CeedRequest *request); 431 CEED_EXTERN int CeedOperatorLinearAssembleAddDiagonal(CeedOperator op, CeedVector assembled, CeedRequest *request); 432 CEED_EXTERN int CeedOperatorLinearAssemblePointBlockDiagonal(CeedOperator op, CeedVector assembled, CeedRequest *request); 433 CEED_EXTERN int CeedOperatorLinearAssembleAddPointBlockDiagonal(CeedOperator op, CeedVector assembled, CeedRequest *request); 434 CEED_EXTERN int CeedOperatorLinearAssemblePointBlockDiagonalSymbolic(CeedOperator op, CeedSize *num_entries, CeedInt **rows, CeedInt **cols); 435 CEED_EXTERN int CeedOperatorLinearAssembleSymbolic(CeedOperator op, CeedSize *num_entries, CeedInt **rows, CeedInt **cols); 436 CEED_EXTERN int CeedOperatorLinearAssemble(CeedOperator op, CeedVector values); 437 CEED_EXTERN int CeedCompositeOperatorGetMultiplicity(CeedOperator op, CeedInt num_skip_indices, CeedInt *skip_indices, CeedVector mult); 438 CEED_EXTERN int CeedOperatorMultigridLevelCreate(CeedOperator op_fine, CeedVector p_mult_fine, CeedElemRestriction rstr_coarse, 439 CeedBasis basis_coarse, CeedOperator *op_coarse, CeedOperator *op_prolong, 440 CeedOperator *op_restrict); 441 CEED_EXTERN int CeedOperatorMultigridLevelCreateTensorH1(CeedOperator op_fine, CeedVector p_mult_fine, CeedElemRestriction rstr_coarse, 442 CeedBasis basis_coarse, const CeedScalar *interp_c_to_f, CeedOperator *op_coarse, 443 CeedOperator *op_prolong, CeedOperator *op_restrict); 444 CEED_EXTERN int CeedOperatorMultigridLevelCreateH1(CeedOperator op_fine, CeedVector p_mult_fine, CeedElemRestriction rstr_coarse, 445 CeedBasis basis_coarse, const CeedScalar *interp_c_to_f, CeedOperator *op_coarse, 446 CeedOperator *op_prolong, CeedOperator *op_restrict); 447 CEED_EXTERN int CeedOperatorCreateFDMElementInverse(CeedOperator op, CeedOperator *fdm_inv, CeedRequest *request); 448 CEED_EXTERN int CeedOperatorSetName(CeedOperator op, const char *name); 449 CEED_EXTERN int CeedOperatorView(CeedOperator op, FILE *stream); 450 CEED_EXTERN int CeedOperatorViewTerse(CeedOperator op, FILE *stream); 451 CEED_EXTERN int CeedOperatorGetCeed(CeedOperator op, Ceed *ceed); 452 CEED_EXTERN Ceed CeedOperatorReturnCeed(CeedOperator op); 453 CEED_EXTERN int CeedOperatorGetNumElements(CeedOperator op, CeedInt *num_elem); 454 CEED_EXTERN int CeedOperatorGetNumQuadraturePoints(CeedOperator op, CeedInt *num_qpts); 455 CEED_EXTERN int CeedOperatorGetFlopsEstimate(CeedOperator op, CeedSize *flops); 456 CEED_EXTERN int CeedOperatorGetContext(CeedOperator op, CeedQFunctionContext *ctx); 457 CEED_EXTERN int CeedOperatorGetContextFieldLabel(CeedOperator op, const char *field_name, CeedContextFieldLabel *field_label); 458 CEED_EXTERN int CeedOperatorSetContextDouble(CeedOperator op, CeedContextFieldLabel field_label, double *values); 459 CEED_EXTERN int CeedOperatorGetContextDoubleRead(CeedOperator op, CeedContextFieldLabel field_label, size_t *num_values, const double **values); 460 CEED_EXTERN int CeedOperatorRestoreContextDoubleRead(CeedOperator op, CeedContextFieldLabel field_label, const double **values); 461 CEED_EXTERN int CeedOperatorSetContextInt32(CeedOperator op, CeedContextFieldLabel field_label, int32_t *values); 462 CEED_EXTERN int CeedOperatorGetContextInt32Read(CeedOperator op, CeedContextFieldLabel field_label, size_t *num_values, const int32_t **values); 463 CEED_EXTERN int CeedOperatorRestoreContextInt32Read(CeedOperator op, CeedContextFieldLabel field_label, const int32_t **values); 464 CEED_EXTERN int CeedOperatorSetContextBoolean(CeedOperator op, CeedContextFieldLabel field_label, bool *values); 465 CEED_EXTERN int CeedOperatorGetContextBooleanRead(CeedOperator op, CeedContextFieldLabel field_label, size_t *num_values, const bool **values); 466 CEED_EXTERN int CeedOperatorRestoreContextBooleanRead(CeedOperator op, CeedContextFieldLabel field_label, const bool **values); 467 CEED_EXTERN int CeedOperatorApply(CeedOperator op, CeedVector in, CeedVector out, CeedRequest *request); 468 CEED_EXTERN int CeedOperatorApplyAdd(CeedOperator op, CeedVector in, CeedVector out, CeedRequest *request); 469 CEED_EXTERN int CeedOperatorAssemblyDataStrip(CeedOperator op); 470 CEED_EXTERN int CeedOperatorDestroy(CeedOperator *op); 471 472 CEED_EXTERN int CeedOperatorGetFieldByName(CeedOperator op, const char *field_name, CeedOperatorField *op_field); 473 CEED_EXTERN int CeedOperatorFieldGetName(CeedOperatorField op_field, const char **field_name); 474 CEED_EXTERN int CeedOperatorFieldGetElemRestriction(CeedOperatorField op_field, CeedElemRestriction *rstr); 475 CEED_EXTERN int CeedOperatorFieldGetBasis(CeedOperatorField op_field, CeedBasis *basis); 476 CEED_EXTERN int CeedOperatorFieldGetVector(CeedOperatorField op_field, CeedVector *vec); 477 CEED_EXTERN int CeedOperatorFieldGetData(CeedOperatorField op_field, const char **field_name, CeedElemRestriction *rstr, CeedBasis *basis, 478 CeedVector *vec); 479 480 /** 481 @brief Return integer power 482 483 @param[in] base The base to exponentiate 484 @param[in] power The power to raise the base to 485 486 @return base^power 487 488 @ref Utility 489 **/ 490 static inline CeedInt CeedIntPow(CeedInt base, CeedInt power) { 491 CeedInt result = 1; 492 while (power) { 493 if (power & 1) result *= base; 494 power >>= 1; 495 base *= base; 496 } 497 return result; 498 } 499 500 /** 501 @brief Return minimum of two integers 502 503 @param[in] a The first integer to compare 504 @param[in] b The second integer to compare 505 506 @return The minimum of the two integers 507 508 @ref Utility 509 **/ 510 static inline CeedInt CeedIntMin(CeedInt a, CeedInt b) { return a < b ? a : b; } 511 512 /** 513 @brief Return maximum of two integers 514 515 @param[in] a The first integer to compare 516 @param[in] b The second integer to compare 517 518 @return The maximum of the two integers 519 520 @ref Utility 521 **/ 522 static inline CeedInt CeedIntMax(CeedInt a, CeedInt b) { return a > b ? a : b; } 523 524 // Used to ensure initialization before CeedInit() 525 CEED_EXTERN int CeedRegisterAll(void); 526 // Used to ensure initialization before CeedQFunctionCreate*() 527 CEED_EXTERN int CeedQFunctionRegisterAll(void); 528