xref: /libCEED/include/ceed/ceed.h (revision 58ed9354cf70802e6cf804e18743c75a47d3a127) 
1 /// Copyright (c) 2017-2025, 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 CEED_EXTERN int CeedGetGitVersion(const char **git_version);
167 CEED_EXTERN int CeedGetBuildConfiguration(const char **build_config);
168 
169 CEED_EXTERN int CeedGetScalarType(CeedScalarType *scalar_type);
170 
171 /// String names for enum pretty printing
172 CEED_EXTERN const char *const *CeedErrorTypes;
173 CEED_EXTERN const char *const  CeedMemTypes[];
174 CEED_EXTERN const char *const  CeedCopyModes[];
175 CEED_EXTERN const char *const  CeedTransposeModes[];
176 CEED_EXTERN const char *const  CeedEvalModes[];
177 CEED_EXTERN const char *const  CeedQuadModes[];
178 CEED_EXTERN const char *const  CeedElemTopologies[];
179 CEED_EXTERN const char *const  CeedContextFieldTypes[];
180 
181 CEED_EXTERN int CeedGetPreferredMemType(Ceed ceed, CeedMemType *type);
182 
183 CEED_EXTERN int  CeedVectorCreate(Ceed ceed, CeedSize len, CeedVector *vec);
184 CEED_EXTERN int  CeedVectorReferenceCopy(CeedVector vec, CeedVector *vec_copy);
185 CEED_EXTERN int  CeedVectorCopy(CeedVector vec, CeedVector vec_copy);
186 CEED_EXTERN int  CeedVectorCopyStrided(CeedVector vec, CeedSize start, CeedSize stop, CeedSize step, CeedVector vec_copy);
187 CEED_EXTERN int  CeedVectorSetArray(CeedVector vec, CeedMemType mem_type, CeedCopyMode copy_mode, CeedScalar *array);
188 CEED_EXTERN int  CeedVectorSetValue(CeedVector vec, CeedScalar value);
189 CEED_EXTERN int  CeedVectorSetValueStrided(CeedVector vec, CeedSize start, CeedSize stop, CeedSize step, CeedScalar value);
190 CEED_EXTERN int  CeedVectorSyncArray(CeedVector vec, CeedMemType mem_type);
191 CEED_EXTERN int  CeedVectorTakeArray(CeedVector vec, CeedMemType mem_type, CeedScalar **array);
192 CEED_EXTERN int  CeedVectorGetArray(CeedVector vec, CeedMemType mem_type, CeedScalar **array);
193 CEED_EXTERN int  CeedVectorGetArrayRead(CeedVector vec, CeedMemType mem_type, const CeedScalar **array);
194 CEED_EXTERN int  CeedVectorGetArrayWrite(CeedVector vec, CeedMemType mem_type, CeedScalar **array);
195 CEED_EXTERN int  CeedVectorRestoreArray(CeedVector vec, CeedScalar **array);
196 CEED_EXTERN int  CeedVectorRestoreArrayRead(CeedVector vec, const CeedScalar **array);
197 CEED_EXTERN int  CeedVectorNorm(CeedVector vec, CeedNormType type, CeedScalar *norm);
198 CEED_EXTERN int  CeedVectorScale(CeedVector x, CeedScalar alpha);
199 CEED_EXTERN int  CeedVectorAXPY(CeedVector y, CeedScalar alpha, CeedVector x);
200 CEED_EXTERN int  CeedVectorAXPBY(CeedVector y, CeedScalar alpha, CeedScalar beta, CeedVector x);
201 CEED_EXTERN int  CeedVectorPointwiseMult(CeedVector w, CeedVector x, CeedVector y);
202 CEED_EXTERN int  CeedVectorReciprocal(CeedVector vec);
203 CEED_EXTERN int  CeedVectorViewRange(CeedVector vec, CeedSize start, CeedSize stop, CeedInt step, const char *fp_fmt, FILE *stream);
204 CEED_EXTERN int  CeedVectorView(CeedVector vec, const char *fp_fmt, FILE *stream);
205 CEED_EXTERN int  CeedVectorGetCeed(CeedVector vec, Ceed *ceed);
206 CEED_EXTERN Ceed CeedVectorReturnCeed(CeedVector vec);
207 CEED_EXTERN int  CeedVectorGetLength(CeedVector vec, CeedSize *length);
208 CEED_EXTERN int  CeedVectorDestroy(CeedVector *vec);
209 
210 CEED_EXTERN CeedRequest *const CEED_REQUEST_IMMEDIATE;
211 CEED_EXTERN CeedRequest *const CEED_REQUEST_ORDERED;
212 CEED_EXTERN int                CeedRequestWait(CeedRequest *req);
213 
214 /// Argument for @ref CeedOperatorSetField() to use active input or output.
215 /// @ingroup CeedVector
216 CEED_EXTERN const CeedVector CEED_VECTOR_ACTIVE;
217 
218 /// Argument for @ref CeedOperatorSetField() to use no `CeedVector`.
219 /// Only use this option with @ref CeedEvalMode @ref CEED_EVAL_WEIGHT.
220 /// @ingroup CeedVector
221 CEED_EXTERN const CeedVector CEED_VECTOR_NONE;
222 
223 /// Argument for @ref CeedOperatorSetField() that no basis operation is needed to translate between the E-vector and the Q-vector.
224 /// Only use this option with @ref CeedEvalMode @ref CEED_EVAL_NONE.
225 /// @ingroup CeedBasis
226 CEED_EXTERN const CeedBasis CEED_BASIS_NONE;
227 
228 /// Argument for @ref CeedOperatorSetField() to use no `CeedElemRestriction`.
229 /// Only use this option with @ref CeedEvalMode @ref CEED_EVAL_WEIGHT.
230 /// @ingroup CeedElemRestriction
231 CEED_EXTERN const CeedElemRestriction CEED_ELEMRESTRICTION_NONE;
232 
233 /// Argument for @ref CeedOperatorCreate() that `CeedQFunction` is not created by user.
234 /// Only used for `CeedQFunction` `dqf` and `dqfT`.
235 /// If implemented, a backend may attempt to provide the action of these `CeedQFunction`.
236 /// @ingroup CeedQFunction
237 CEED_EXTERN const CeedQFunction CEED_QFUNCTION_NONE;
238 
239 /// Argument for @ref CeedElemRestrictionCreateStrided() that L-vector is in the Ceed backend's preferred layout.
240 /// This argument should only be used with vectors created by a Ceed backend.
241 /// @ingroup CeedElemRestriction
242 CEED_EXTERN const CeedInt CEED_STRIDES_BACKEND[3];
243 
244 CEED_EXTERN int  CeedElemRestrictionCreate(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt num_comp, CeedInt comp_stride, CeedSize l_size,
245                                            CeedMemType mem_type, CeedCopyMode copy_mode, const CeedInt *offsets, CeedElemRestriction *rstr);
246 CEED_EXTERN int  CeedElemRestrictionCreateOriented(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt num_comp, CeedInt comp_stride,
247                                                    CeedSize l_size, CeedMemType mem_type, CeedCopyMode copy_mode, const CeedInt *offsets,
248                                                    const bool *orients, CeedElemRestriction *rstr);
249 CEED_EXTERN int  CeedElemRestrictionCreateCurlOriented(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt num_comp, CeedInt comp_stride,
250                                                        CeedSize l_size, CeedMemType mem_type, CeedCopyMode copy_mode, const CeedInt *offsets,
251                                                        const CeedInt8 *curl_orients, CeedElemRestriction *rstr);
252 CEED_EXTERN int  CeedElemRestrictionCreateStrided(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt num_comp, CeedSize l_size,
253                                                   const CeedInt strides[3], CeedElemRestriction *rstr);
254 CEED_EXTERN int  CeedElemRestrictionCreateAtPoints(Ceed ceed, CeedInt num_elem, CeedInt num_points, CeedInt num_comp, CeedSize l_size,
255                                                    CeedMemType mem_type, CeedCopyMode copy_mode, const CeedInt *offsets, CeedElemRestriction *rstr);
256 CEED_EXTERN int  CeedElemRestrictionCreateBlocked(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt block_size, CeedInt num_comp,
257                                                   CeedInt comp_stride, CeedSize l_size, CeedMemType mem_type, CeedCopyMode copy_mode,
258                                                   const CeedInt *offsets, CeedElemRestriction *rstr);
259 CEED_EXTERN int  CeedElemRestrictionCreateBlockedOriented(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt block_size, CeedInt num_comp,
260                                                           CeedInt comp_stride, CeedSize l_size, CeedMemType mem_type, CeedCopyMode copy_mode,
261                                                           const CeedInt *offsets, const bool *orients, CeedElemRestriction *rstr);
262 CEED_EXTERN int  CeedElemRestrictionCreateBlockedCurlOriented(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt block_size, CeedInt num_comp,
263                                                               CeedInt comp_stride, CeedSize l_size, CeedMemType mem_type, CeedCopyMode copy_mode,
264                                                               const CeedInt *offsets, const CeedInt8 *curl_orients, CeedElemRestriction *rstr);
265 CEED_EXTERN int  CeedElemRestrictionCreateBlockedStrided(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt block_size, CeedInt num_comp,
266                                                          CeedSize l_size, const CeedInt strides[3], CeedElemRestriction *rstr);
267 CEED_EXTERN int  CeedElemRestrictionCreateUnsignedCopy(CeedElemRestriction rstr, CeedElemRestriction *rstr_unsigned);
268 CEED_EXTERN int  CeedElemRestrictionCreateUnorientedCopy(CeedElemRestriction rstr, CeedElemRestriction *rstr_unoriented);
269 CEED_EXTERN int  CeedElemRestrictionReferenceCopy(CeedElemRestriction rstr, CeedElemRestriction *rstr_copy);
270 CEED_EXTERN int  CeedElemRestrictionCreateVector(CeedElemRestriction rstr, CeedVector *lvec, CeedVector *evec);
271 CEED_EXTERN int  CeedElemRestrictionApply(CeedElemRestriction rstr, CeedTransposeMode t_mode, CeedVector u, CeedVector ru, CeedRequest *request);
272 CEED_EXTERN int  CeedElemRestrictionApplyAtPointsInElement(CeedElemRestriction rstr, CeedInt elem, CeedTransposeMode t_mode, CeedVector u,
273                                                            CeedVector ru, CeedRequest *request);
274 CEED_EXTERN int  CeedElemRestrictionApplyBlock(CeedElemRestriction rstr, CeedInt block, CeedTransposeMode t_mode, CeedVector u, CeedVector ru,
275                                                CeedRequest *request);
276 CEED_EXTERN int  CeedElemRestrictionGetCeed(CeedElemRestriction rstr, Ceed *ceed);
277 CEED_EXTERN Ceed CeedElemRestrictionReturnCeed(CeedElemRestriction rstr);
278 CEED_EXTERN int  CeedElemRestrictionGetCompStride(CeedElemRestriction rstr, CeedInt *comp_stride);
279 CEED_EXTERN int  CeedElemRestrictionGetNumElements(CeedElemRestriction rstr, CeedInt *num_elem);
280 CEED_EXTERN int  CeedElemRestrictionGetElementSize(CeedElemRestriction rstr, CeedInt *elem_size);
281 CEED_EXTERN int  CeedElemRestrictionGetNumPoints(CeedElemRestriction rstr, CeedInt *num_points);
282 CEED_EXTERN int  CeedElemRestrictionGetNumPointsInElement(CeedElemRestriction rstr, CeedInt elem, CeedInt *num_points);
283 CEED_EXTERN int  CeedElemRestrictionGetMaxPointsInElement(CeedElemRestriction rstr, CeedInt *max_points);
284 CEED_EXTERN int  CeedElemRestrictionGetMinPointsInElement(CeedElemRestriction rstr, CeedInt *min_points);
285 CEED_EXTERN int  CeedElemRestrictionGetMinMaxPointsInElement(CeedElemRestriction rstr, CeedInt *min_points, CeedInt *max_points);
286 CEED_EXTERN int  CeedElemRestrictionGetLVectorSize(CeedElemRestriction rstr, CeedSize *l_size);
287 CEED_EXTERN int  CeedElemRestrictionGetEVectorSize(CeedElemRestriction rstr, CeedSize *e_size);
288 CEED_EXTERN int  CeedElemRestrictionGetNumComponents(CeedElemRestriction rstr, CeedInt *num_comp);
289 CEED_EXTERN int  CeedElemRestrictionGetNumBlocks(CeedElemRestriction rstr, CeedInt *num_block);
290 CEED_EXTERN int  CeedElemRestrictionGetBlockSize(CeedElemRestriction rstr, CeedInt *block_size);
291 CEED_EXTERN int  CeedElemRestrictionGetMultiplicity(CeedElemRestriction rstr, CeedVector mult);
292 CEED_EXTERN int  CeedElemRestrictionView(CeedElemRestriction rstr, FILE *stream);
293 CEED_EXTERN int  CeedElemRestrictionDestroy(CeedElemRestriction *rstr);
294 
295 // The formalism here is that we have the structure
296 //  \int_\Omega v^T f_0(u, \nabla u, qdata) + (\nabla v)^T f_1(u, \nabla u, qdata)
297 // where gradients are with respect to the reference element.
298 
299 CEED_EXTERN int CeedBasisCreateTensorH1Lagrange(Ceed ceed, CeedInt dim, CeedInt num_comp, CeedInt P, CeedInt Q, CeedQuadMode quad_mode,
300                                                 CeedBasis *basis);
301 CEED_EXTERN int CeedBasisCreateTensorH1(Ceed ceed, CeedInt dim, CeedInt num_comp, CeedInt P_1d, CeedInt Q_1d, const CeedScalar *interp_1d,
302                                         const CeedScalar *grad_1d, const CeedScalar *q_ref_1d, const CeedScalar *q_weight_1d, CeedBasis *basis);
303 CEED_EXTERN int CeedBasisCreateH1(Ceed ceed, CeedElemTopology topo, CeedInt num_comp, CeedInt num_nodes, CeedInt nqpts, const CeedScalar *interp,
304                                   const CeedScalar *grad, const CeedScalar *q_ref, const CeedScalar *q_weights, CeedBasis *basis);
305 CEED_EXTERN int CeedBasisCreateHdiv(Ceed ceed, CeedElemTopology topo, CeedInt num_comp, CeedInt num_nodes, CeedInt nqpts, const CeedScalar *interp,
306                                     const CeedScalar *div, const CeedScalar *q_ref, const CeedScalar *q_weights, CeedBasis *basis);
307 CEED_EXTERN int CeedBasisCreateHcurl(Ceed ceed, CeedElemTopology topo, CeedInt num_comp, CeedInt num_nodes, CeedInt nqpts, const CeedScalar *interp,
308                                      const CeedScalar *curl, const CeedScalar *q_ref, const CeedScalar *q_weights, CeedBasis *basis);
309 CEED_EXTERN int CeedBasisCreateProjection(CeedBasis basis_from, CeedBasis basis_to, CeedBasis *basis_project);
310 CEED_EXTERN int CeedBasisReferenceCopy(CeedBasis basis, CeedBasis *basis_copy);
311 CEED_EXTERN int CeedBasisView(CeedBasis basis, FILE *stream);
312 CEED_EXTERN int CeedBasisApply(CeedBasis basis, CeedInt num_elem, CeedTransposeMode t_mode, CeedEvalMode eval_mode, CeedVector u, CeedVector v);
313 CEED_EXTERN int CeedBasisApplyAdd(CeedBasis basis, CeedInt num_elem, CeedTransposeMode t_mode, CeedEvalMode eval_mode, CeedVector u, CeedVector v);
314 CEED_EXTERN int CeedBasisApplyAtPoints(CeedBasis basis, CeedInt num_elem, const CeedInt *num_points, CeedTransposeMode t_mode, CeedEvalMode eval_mode,
315                                        CeedVector x_ref, CeedVector u, CeedVector v);
316 CEED_EXTERN int CeedBasisApplyAddAtPoints(CeedBasis basis, CeedInt num_elem, const CeedInt *num_points, CeedTransposeMode t_mode,
317                                           CeedEvalMode eval_mode, CeedVector x_ref, CeedVector u, CeedVector v);
318 CEED_EXTERN int CeedBasisGetCeed(CeedBasis basis, Ceed *ceed);
319 CEED_EXTERN Ceed CeedBasisReturnCeed(CeedBasis basis);
320 CEED_EXTERN int  CeedBasisGetDimension(CeedBasis basis, CeedInt *dim);
321 CEED_EXTERN int  CeedBasisGetTopology(CeedBasis basis, CeedElemTopology *topo);
322 CEED_EXTERN int  CeedBasisGetNumComponents(CeedBasis basis, CeedInt *num_comp);
323 CEED_EXTERN int  CeedBasisGetNumNodes(CeedBasis basis, CeedInt *P);
324 CEED_EXTERN int  CeedBasisGetNumNodes1D(CeedBasis basis, CeedInt *P_1d);
325 CEED_EXTERN int  CeedBasisGetNumQuadraturePoints(CeedBasis basis, CeedInt *Q);
326 CEED_EXTERN int  CeedBasisGetNumQuadraturePoints1D(CeedBasis basis, CeedInt *Q_1d);
327 CEED_EXTERN int  CeedBasisGetQRef(CeedBasis basis, const CeedScalar **q_ref);
328 CEED_EXTERN int  CeedBasisGetQWeights(CeedBasis basis, const CeedScalar **q_weights);
329 CEED_EXTERN int  CeedBasisGetInterp(CeedBasis basis, const CeedScalar **interp);
330 CEED_EXTERN int  CeedBasisGetInterp1D(CeedBasis basis, const CeedScalar **interp_1d);
331 CEED_EXTERN int  CeedBasisGetGrad(CeedBasis basis, const CeedScalar **grad);
332 CEED_EXTERN int  CeedBasisGetGrad1D(CeedBasis basis, const CeedScalar **grad_1d);
333 CEED_EXTERN int  CeedBasisGetDiv(CeedBasis basis, const CeedScalar **div);
334 CEED_EXTERN int  CeedBasisGetCurl(CeedBasis basis, const CeedScalar **curl);
335 CEED_EXTERN int  CeedBasisDestroy(CeedBasis *basis);
336 
337 CEED_EXTERN int CeedGaussQuadrature(CeedInt Q, CeedScalar *q_ref_1d, CeedScalar *q_weight_1d);
338 CEED_EXTERN int CeedLobattoQuadrature(CeedInt Q, CeedScalar *q_ref_1d, CeedScalar *q_weight_1d);
339 
340 /** Handle for the user provided `CeedQFunction` callback function
341 
342  @param[in,out] ctx User-defined context set using @ref CeedQFunctionSetContext() or `NULL`
343  @param[in] Q       Number of quadrature points at which to evaluate
344  @param[in] in      Array of pointers to each input argument in the order provided by the user in @ref CeedQFunctionAddInput().
345                       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).
346                       This results in indexing the `i`th input at quadrature point `j` as `in[i][(d*num_comp + c)*Q + j]`.
347  @param[out]   out  Array of pointers to each output array in the order provided using @ref CeedQFunctionAddOutput().
348                       The shapes are as above for `in`.
349 
350  @return An error code: 0 - success, otherwise - failure
351 
352  @ingroup CeedQFunction
353 **/
354 typedef int (*CeedQFunctionUser)(void *ctx, const CeedInt Q, const CeedScalar *const *in, CeedScalar *const *out);
355 
356 CEED_EXTERN int  CeedQFunctionCreateInterior(Ceed ceed, CeedInt vec_length, CeedQFunctionUser f, const char *source, CeedQFunction *qf);
357 CEED_EXTERN int  CeedQFunctionCreateInteriorByName(Ceed ceed, const char *name, CeedQFunction *qf);
358 CEED_EXTERN int  CeedQFunctionCreateIdentity(Ceed ceed, CeedInt size, CeedEvalMode in_mode, CeedEvalMode out_mode, CeedQFunction *qf);
359 CEED_EXTERN int  CeedQFunctionReferenceCopy(CeedQFunction qf, CeedQFunction *qf_copy);
360 CEED_EXTERN int  CeedQFunctionAddInput(CeedQFunction qf, const char *field_name, CeedInt size, CeedEvalMode eval_mode);
361 CEED_EXTERN int  CeedQFunctionAddOutput(CeedQFunction qf, const char *field_name, CeedInt size, CeedEvalMode eval_mode);
362 CEED_EXTERN int  CeedQFunctionGetFields(CeedQFunction qf, CeedInt *num_input_fields, CeedQFunctionField **input_fields, CeedInt *num_output_fields,
363                                         CeedQFunctionField **output_fields);
364 CEED_EXTERN int  CeedQFunctionSetContext(CeedQFunction qf, CeedQFunctionContext ctx);
365 CEED_EXTERN int  CeedQFunctionSetContextWritable(CeedQFunction qf, bool is_writable);
366 CEED_EXTERN int  CeedQFunctionSetUserFlopsEstimate(CeedQFunction qf, CeedSize flops);
367 CEED_EXTERN int  CeedQFunctionView(CeedQFunction qf, FILE *stream);
368 CEED_EXTERN int  CeedQFunctionGetCeed(CeedQFunction qf, Ceed *ceed);
369 CEED_EXTERN Ceed CeedQFunctionReturnCeed(CeedQFunction qf);
370 CEED_EXTERN int  CeedQFunctionApply(CeedQFunction qf, CeedInt Q, CeedVector *u, CeedVector *v);
371 CEED_EXTERN int  CeedQFunctionDestroy(CeedQFunction *qf);
372 
373 CEED_EXTERN int CeedQFunctionFieldGetName(CeedQFunctionField qf_field, const char **field_name);
374 CEED_EXTERN int CeedQFunctionFieldGetSize(CeedQFunctionField qf_field, CeedInt *size);
375 CEED_EXTERN int CeedQFunctionFieldGetEvalMode(CeedQFunctionField qf_field, CeedEvalMode *eval_mode);
376 CEED_EXTERN int CeedQFunctionFieldGetData(CeedQFunctionField qf_field, const char **field_name, CeedInt *size, CeedEvalMode *eval_mode);
377 
378 /** Handle for the user provided @ref CeedQFunctionContextDestroy() callback function
379 
380  @param[in,out] data  User `CeedQFunctionContext` data
381 
382  @return An error code: 0 - success, otherwise - failure
383 
384  @ingroup CeedQFunction
385 **/
386 typedef int (*CeedQFunctionContextDataDestroyUser)(void *data);
387 
388 CEED_EXTERN int CeedQFunctionContextCreate(Ceed ceed, CeedQFunctionContext *ctx);
389 CEED_EXTERN int CeedQFunctionContextReferenceCopy(CeedQFunctionContext ctx, CeedQFunctionContext *ctx_copy);
390 CEED_EXTERN int CeedQFunctionContextSetData(CeedQFunctionContext ctx, CeedMemType mem_type, CeedCopyMode copy_mode, size_t size, void *data);
391 CEED_EXTERN int CeedQFunctionContextTakeData(CeedQFunctionContext ctx, CeedMemType mem_type, void *data);
392 CEED_EXTERN int CeedQFunctionContextGetData(CeedQFunctionContext ctx, CeedMemType mem_type, void *data);
393 CEED_EXTERN int CeedQFunctionContextGetDataRead(CeedQFunctionContext ctx, CeedMemType mem_type, void *data);
394 CEED_EXTERN int CeedQFunctionContextRestoreData(CeedQFunctionContext ctx, void *data);
395 CEED_EXTERN int CeedQFunctionContextRestoreDataRead(CeedQFunctionContext ctx, void *data);
396 CEED_EXTERN int CeedQFunctionContextRegisterDouble(CeedQFunctionContext ctx, const char *field_name, size_t field_offset, size_t num_values,
397                                                    const char *field_description);
398 CEED_EXTERN int CeedQFunctionContextRegisterInt32(CeedQFunctionContext ctx, const char *field_name, size_t field_offset, size_t num_values,
399                                                   const char *field_description);
400 CEED_EXTERN int CeedQFunctionContextRegisterBoolean(CeedQFunctionContext ctx, const char *field_name, size_t field_offset, size_t num_values,
401                                                     const char *field_description);
402 CEED_EXTERN int CeedQFunctionContextGetAllFieldLabels(CeedQFunctionContext ctx, const CeedContextFieldLabel **field_labels, CeedInt *num_fields);
403 CEED_EXTERN int CeedContextFieldLabelGetDescription(CeedContextFieldLabel label, const char **field_name, size_t *field_offset, size_t *num_values,
404                                                     const char **field_description, CeedContextFieldType *field_type);
405 CEED_EXTERN int CeedQFunctionContextGetContextSize(CeedQFunctionContext ctx, size_t *ctx_size);
406 CEED_EXTERN int CeedQFunctionContextView(CeedQFunctionContext ctx, FILE *stream);
407 CEED_EXTERN int CeedQFunctionContextSetDataDestroy(CeedQFunctionContext ctx, CeedMemType f_mem_type, CeedQFunctionContextDataDestroyUser f);
408 CEED_EXTERN int CeedQFunctionContextDestroy(CeedQFunctionContext *ctx);
409 
410 CEED_EXTERN int CeedOperatorCreate(Ceed ceed, CeedQFunction qf, CeedQFunction dqf, CeedQFunction dqfT, CeedOperator *op);
411 CEED_EXTERN int CeedOperatorCreateAtPoints(Ceed ceed, CeedQFunction qf, CeedQFunction dqf, CeedQFunction dqfT, CeedOperator *op);
412 CEED_EXTERN int CeedCompositeOperatorCreate(Ceed ceed, CeedOperator *op);
413 CEED_EXTERN int CeedOperatorReferenceCopy(CeedOperator op, CeedOperator *op_copy);
414 CEED_EXTERN int CeedOperatorSetField(CeedOperator op, const char *field_name, CeedElemRestriction rstr, CeedBasis basis, CeedVector vec);
415 CEED_EXTERN int CeedOperatorGetFields(CeedOperator op, CeedInt *num_input_fields, CeedOperatorField **input_fields, CeedInt *num_output_fields,
416                                       CeedOperatorField **output_fields);
417 
418 CEED_EXTERN int  CeedOperatorAtPointsSetPoints(CeedOperator op, CeedElemRestriction rstr_points, CeedVector point_coords);
419 CEED_EXTERN int  CeedOperatorAtPointsGetPoints(CeedOperator op, CeedElemRestriction *rstr_points, CeedVector *point_coords);
420 CEED_EXTERN int  CeedOperatorIsAtPoints(CeedOperator op, bool *is_at_points);
421 CEED_EXTERN int  CeedCompositeOperatorAddSub(CeedOperator composite_op, CeedOperator sub_op);
422 CEED_EXTERN int  CeedCompositeOperatorGetNumSub(CeedOperator op, CeedInt *num_suboperators);
423 CEED_EXTERN int  CeedCompositeOperatorGetSubList(CeedOperator op, CeedOperator **sub_operators);
424 CEED_EXTERN int  CeedCompositeOperatorGetSubByName(CeedOperator op, const char *op_name, CeedOperator *sub_op);
425 CEED_EXTERN int  CeedOperatorCheckReady(CeedOperator op);
426 CEED_EXTERN int  CeedOperatorGetActiveVectorLengths(CeedOperator op, CeedSize *input_size, CeedSize *output_size);
427 CEED_EXTERN int  CeedOperatorSetQFunctionAssemblyReuse(CeedOperator op, bool reuse_assembly_data);
428 CEED_EXTERN int  CeedOperatorSetQFunctionAssemblyDataUpdateNeeded(CeedOperator op, bool needs_data_update);
429 CEED_EXTERN int  CeedOperatorLinearAssembleQFunction(CeedOperator op, CeedVector *assembled, CeedElemRestriction *rstr, CeedRequest *request);
430 CEED_EXTERN int  CeedOperatorLinearAssembleQFunctionBuildOrUpdate(CeedOperator op, CeedVector *assembled, CeedElemRestriction *rstr,
431                                                                   CeedRequest *request);
432 CEED_EXTERN int  CeedOperatorLinearAssembleDiagonal(CeedOperator op, CeedVector assembled, CeedRequest *request);
433 CEED_EXTERN int  CeedOperatorLinearAssembleAddDiagonal(CeedOperator op, CeedVector assembled, CeedRequest *request);
434 CEED_EXTERN int  CeedOperatorLinearAssemblePointBlockDiagonal(CeedOperator op, CeedVector assembled, CeedRequest *request);
435 CEED_EXTERN int  CeedOperatorLinearAssembleAddPointBlockDiagonal(CeedOperator op, CeedVector assembled, CeedRequest *request);
436 CEED_EXTERN int  CeedOperatorLinearAssemblePointBlockDiagonalSymbolic(CeedOperator op, CeedSize *num_entries, CeedInt **rows, CeedInt **cols);
437 CEED_EXTERN int  CeedOperatorLinearAssembleSymbolic(CeedOperator op, CeedSize *num_entries, CeedInt **rows, CeedInt **cols);
438 CEED_EXTERN int  CeedOperatorLinearAssemble(CeedOperator op, CeedVector values);
439 CEED_EXTERN int  CeedCompositeOperatorGetMultiplicity(CeedOperator op, CeedInt num_skip_indices, CeedInt *skip_indices, CeedVector mult);
440 CEED_EXTERN int  CeedOperatorMultigridLevelCreate(CeedOperator op_fine, CeedVector p_mult_fine, CeedElemRestriction rstr_coarse,
441                                                   CeedBasis basis_coarse, CeedOperator *op_coarse, CeedOperator *op_prolong,
442                                                   CeedOperator *op_restrict);
443 CEED_EXTERN int  CeedOperatorMultigridLevelCreateTensorH1(CeedOperator op_fine, CeedVector p_mult_fine, CeedElemRestriction rstr_coarse,
444                                                           CeedBasis basis_coarse, const CeedScalar *interp_c_to_f, CeedOperator *op_coarse,
445                                                           CeedOperator *op_prolong, CeedOperator *op_restrict);
446 CEED_EXTERN int  CeedOperatorMultigridLevelCreateH1(CeedOperator op_fine, CeedVector p_mult_fine, CeedElemRestriction rstr_coarse,
447                                                     CeedBasis basis_coarse, const CeedScalar *interp_c_to_f, CeedOperator *op_coarse,
448                                                     CeedOperator *op_prolong, CeedOperator *op_restrict);
449 CEED_EXTERN int  CeedOperatorCreateFDMElementInverse(CeedOperator op, CeedOperator *fdm_inv, CeedRequest *request);
450 CEED_EXTERN int  CeedOperatorSetName(CeedOperator op, const char *name);
451 CEED_EXTERN int  CeedOperatorGetName(CeedOperator op, const char **name);
452 CEED_EXTERN int  CeedOperatorView(CeedOperator op, FILE *stream);
453 CEED_EXTERN int  CeedOperatorViewTerse(CeedOperator op, FILE *stream);
454 CEED_EXTERN int  CeedOperatorGetCeed(CeedOperator op, Ceed *ceed);
455 CEED_EXTERN Ceed CeedOperatorReturnCeed(CeedOperator op);
456 CEED_EXTERN int  CeedOperatorGetNumElements(CeedOperator op, CeedInt *num_elem);
457 CEED_EXTERN int  CeedOperatorGetNumQuadraturePoints(CeedOperator op, CeedInt *num_qpts);
458 CEED_EXTERN int  CeedOperatorGetFlopsEstimate(CeedOperator op, CeedSize *flops);
459 CEED_EXTERN int  CeedOperatorGetContext(CeedOperator op, CeedQFunctionContext *ctx);
460 CEED_EXTERN int  CeedOperatorGetContextFieldLabel(CeedOperator op, const char *field_name, CeedContextFieldLabel *field_label);
461 CEED_EXTERN int  CeedOperatorSetContextDouble(CeedOperator op, CeedContextFieldLabel field_label, double *values);
462 CEED_EXTERN int  CeedOperatorGetContextDoubleRead(CeedOperator op, CeedContextFieldLabel field_label, size_t *num_values, const double **values);
463 CEED_EXTERN int  CeedOperatorRestoreContextDoubleRead(CeedOperator op, CeedContextFieldLabel field_label, const double **values);
464 CEED_EXTERN int  CeedOperatorSetContextInt32(CeedOperator op, CeedContextFieldLabel field_label, int32_t *values);
465 CEED_EXTERN int  CeedOperatorGetContextInt32Read(CeedOperator op, CeedContextFieldLabel field_label, size_t *num_values, const int32_t **values);
466 CEED_EXTERN int  CeedOperatorRestoreContextInt32Read(CeedOperator op, CeedContextFieldLabel field_label, const int32_t **values);
467 CEED_EXTERN int  CeedOperatorSetContextBoolean(CeedOperator op, CeedContextFieldLabel field_label, bool *values);
468 CEED_EXTERN int  CeedOperatorGetContextBooleanRead(CeedOperator op, CeedContextFieldLabel field_label, size_t *num_values, const bool **values);
469 CEED_EXTERN int  CeedOperatorRestoreContextBooleanRead(CeedOperator op, CeedContextFieldLabel field_label, const bool **values);
470 CEED_EXTERN int  CeedOperatorApply(CeedOperator op, CeedVector in, CeedVector out, CeedRequest *request);
471 CEED_EXTERN int  CeedOperatorApplyAdd(CeedOperator op, CeedVector in, CeedVector out, CeedRequest *request);
472 CEED_EXTERN int  CeedOperatorApplyAddActive(CeedOperator op, CeedVector in, CeedVector out, CeedRequest *request);
473 CEED_EXTERN int  CeedOperatorAssemblyDataStrip(CeedOperator op);
474 CEED_EXTERN int  CeedOperatorDestroy(CeedOperator *op);
475 
476 CEED_EXTERN int CeedOperatorGetFieldByName(CeedOperator op, const char *field_name, CeedOperatorField *op_field);
477 CEED_EXTERN int CeedOperatorFieldGetName(CeedOperatorField op_field, const char **field_name);
478 CEED_EXTERN int CeedOperatorFieldGetElemRestriction(CeedOperatorField op_field, CeedElemRestriction *rstr);
479 CEED_EXTERN int CeedOperatorFieldGetBasis(CeedOperatorField op_field, CeedBasis *basis);
480 CEED_EXTERN int CeedOperatorFieldGetVector(CeedOperatorField op_field, CeedVector *vec);
481 CEED_EXTERN int CeedOperatorFieldGetData(CeedOperatorField op_field, const char **field_name, CeedElemRestriction *rstr, CeedBasis *basis,
482                                          CeedVector *vec);
483 
484 /**
485   @brief Return integer power
486 
487   @param[in] base  The base to exponentiate
488   @param[in] power The power to raise the base to
489 
490   @return base^power
491 
492   @ref Utility
493 **/
494 static inline CeedInt CeedIntPow(CeedInt base, CeedInt power) {
495   CeedInt result = 1;
496   while (power) {
497     if (power & 1) result *= base;
498     power >>= 1;
499     base *= base;
500   }
501   return result;
502 }
503 
504 /**
505   @brief Return minimum of two integers
506 
507   @param[in] a The first integer to compare
508   @param[in] b The second integer to compare
509 
510   @return The minimum of the two integers
511 
512   @ref Utility
513 **/
514 static inline CeedInt CeedIntMin(CeedInt a, CeedInt b) { return a < b ? a : b; }
515 
516 /**
517   @brief Return maximum of two integers
518 
519   @param[in] a The first integer to compare
520   @param[in] b The second integer to compare
521 
522   @return The maximum of the two integers
523 
524   @ref Utility
525 **/
526 static inline CeedInt CeedIntMax(CeedInt a, CeedInt b) { return a > b ? a : b; }
527 
528 // Used to ensure initialization before CeedInit()
529 CEED_EXTERN int CeedRegisterAll(void);
530 // Used to ensure initialization before CeedQFunctionCreate*()
531 CEED_EXTERN int CeedQFunctionRegisterAll(void);
532