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