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