xref: /libCEED/include/ceed.h (revision 43eb8658e93cf9fd755519a22e1b9e935e2fadb9)
1 /// Copyright (c) 2017, Lawrence Livermore National Security, LLC. Produced at
2 /// the Lawrence Livermore National Laboratory. LLNL-CODE-734707. All Rights
3 /// reserved. See files LICENSE and NOTICE for details.
4 ///
5 /// This file is part of CEED, a collection of benchmarks, miniapps, software
6 /// libraries and APIs for efficient high-order finite element and spectral
7 /// element discretizations for exascale applications. For more information and
8 /// source code availability see http://github.com/ceed.
9 ///
10 /// The CEED research is supported by the Exascale Computing Project 17-SC-20-SC,
11 /// a collaborative effort of two U.S. Department of Energy organizations (Office
12 /// of Science and the National Nuclear Security Administration) responsible for
13 /// the planning and preparation of a capable exascale ecosystem, including
14 /// software, applications, hardware, advanced system engineering and early
15 /// testbed platforms, in support of the nation's exascale computing imperative.
16 
17 /// @file
18 /// Public header for user and utility components of libCEED
19 #ifndef _ceed_h
20 #define _ceed_h
21 
22 /// @defgroup Ceed Ceed: core components
23 /// @defgroup CeedVector CeedVector: storing and manipulating vectors
24 /// @defgroup CeedElemRestriction CeedElemRestriction: restriction from local vectors to elements
25 /// @defgroup CeedBasis CeedBasis: fully discrete finite element-like objects
26 /// @defgroup CeedQFunction CeedQFunction: independent operations at quadrature points
27 /// @defgroup CeedOperator CeedOperator: composed FE-type operations on vectors
28 ///
29 /// @page FunctionCategories libCEED: Types of Functions
30 ///    libCEED provides three different header files depending upon the type of
31 ///    functions a user requires.
32 /// @section Utility Utility Functions
33 ///    These functions are intended general utilities that may be useful to
34 ///    libCEED developers and users. These functions can generally be found in
35 ///    "ceed.h".
36 /// @section User User Functions
37 ///    These functions are intended to be used by general users of libCEED
38 ///    and can generally be found in "ceed.h".
39 /// @section Backend Backend Developer Functions
40 ///    These functions are intended to be used by backend developers of
41 ///    libCEED and can generally be found in "ceed-backend.h".
42 /// @section Developer Library Developer Functions
43 ///    These functions are intended to be used by library developers of
44 ///    libCEED and can generally be found in "ceed-impl.h".
45 
46 /**
47   CEED_EXTERN is used in this header to denote all publicly visible symbols.
48 
49   No other file should declare publicly visible symbols, thus it should never be
50   used outside ceed.h.
51  */
52 #ifdef __cplusplus
53 #  define CEED_EXTERN extern "C"
54 #else
55 #  define CEED_EXTERN extern
56 #endif
57 
58 /**
59   @ingroup CeedQFunction
60   This macro populates the correct function annotations for User QFunction
61     source for code generation backends or populates default values for CPU
62     backends.
63 **/
64 #ifndef CEED_QFUNCTION
65 #define CEED_QFUNCTION(name) \
66   static const char name ## _loc[] = __FILE__ ":" #name;        \
67   static int name
68 #endif
69 
70 /**
71   @ingroup CeedQFunction
72   Using VLA syntax to reshape User QFunction inputs and outputs can make
73     user code more readable. VLA is a C99 feature that is not supported by
74     the C++ dialect used by CUDA. This macro allows users to use the VLA
75     syntax with the CUDA backends.
76 **/
77 #ifndef CEED_Q_VLA
78 #  define CEED_Q_VLA Q
79 #endif
80 
81 /**
82   @ingroup Ceed
83   This macro provides the appropriate SIMD Pragma for the compilation
84     environment. Code generation backends may redefine this macro, as needed.
85 **/
86 #ifndef CeedPragmaSIMD
87 #  if defined(__INTEL_COMPILER)
88 #    define CeedPragmaSIMD _Pragma("vector")
89 // Cannot use Intel pragma ivdep because it miscompiles unpacking symmetric tensors, as in
90 // Poisson2DApply, where the SIMD loop body contains temporaries such as the following.
91 //
92 //     const CeedScalar dXdxdXdxT[2][2] = {{qd[i+0*Q], qd[i+2*Q]},
93 //                                         {qd[i+2*Q], qd[i+1*Q]}};
94 //     for (int j=0; j<2; j++)
95 //        vg[i+j*Q] = (du[0] * dXdxdXdxT[0][j] + du[1] * dXdxdXdxT[1][j]);
96 //
97 // Miscompilation with pragma ivdep observed with icc (ICC) 19.0.5.281 20190815
98 // at -O2 and above.
99 #  elif defined(__GNUC__) && __GNUC__ >= 5
100 #    define CeedPragmaSIMD _Pragma("GCC ivdep")
101 #  elif defined(_OPENMP) && _OPENMP >= 201307 // OpenMP-4.0 (July, 2013)
102 #    define CeedPragmaSIMD _Pragma("omp simd")
103 #  else
104 #    define CeedPragmaSIMD
105 #  endif
106 #endif
107 
108 #include <assert.h>
109 #include <stdint.h>
110 #include <stddef.h>
111 #include <stdarg.h>
112 #include <stdio.h>
113 #include <stdbool.h>
114 
115 /// Integer type, used for indexing
116 /// @ingroup Ceed
117 typedef int32_t CeedInt;
118 /// Scalar (floating point) type
119 /// @ingroup Ceed
120 typedef double CeedScalar;
121 
122 /// Library context created by CeedInit()
123 /// @ingroup CeedUser
124 typedef struct Ceed_private *Ceed;
125 /// Non-blocking Ceed interfaces return a CeedRequest.
126 /// To perform an operation immediately, pass \ref CEED_REQUEST_IMMEDIATE instead.
127 /// @ingroup CeedUser
128 typedef struct CeedRequest_private *CeedRequest;
129 /// Handle for vectors over the field \ref CeedScalar
130 /// @ingroup CeedVectorUser
131 typedef struct CeedVector_private *CeedVector;
132 /// Handle for object describing restriction to elements
133 /// @ingroup CeedElemRestrictionUser
134 typedef struct CeedElemRestriction_private *CeedElemRestriction;
135 /// Handle for object describing discrete finite element evaluations
136 /// @ingroup CeedBasisUser
137 typedef struct CeedBasis_private *CeedBasis;
138 /// Handle for object describing functions evaluated independently at quadrature points
139 /// @ingroup CeedQFunctionUser
140 typedef struct CeedQFunction_private *CeedQFunction;
141 /// Handle for object describing FE-type operators acting on vectors
142 ///
143 /// Given an element restriction \f$E\f$, basis evaluator \f$B\f$, and
144 ///   quadrature function\f$f\f$, a CeedOperator expresses operations of the form
145 ///   $$ E^T B^T f(B E u) $$
146 ///   acting on the vector \f$u\f$.
147 /// @ingroup CeedOperatorUser
148 typedef struct CeedOperator_private *CeedOperator;
149 
150 CEED_EXTERN int CeedInit(const char *resource, Ceed *ceed);
151 CEED_EXTERN int CeedGetResource(Ceed ceed, const char **resource);
152 CEED_EXTERN int CeedIsDeterministic(Ceed ceed, bool *isDeterministic);
153 CEED_EXTERN int CeedView(Ceed ceed, FILE *stream);
154 CEED_EXTERN int CeedDestroy(Ceed *ceed);
155 
156 CEED_EXTERN int CeedErrorImpl(Ceed, const char *, int, const char *, int,
157                               const char *, ...);
158 /// Raise an error on ceed object
159 ///
160 /// @param ceed Ceed library context or NULL
161 /// @param ecode Error code (int)
162 /// @param ... printf-style format string followed by arguments as needed
163 ///
164 /// @ingroup Ceed
165 /// @sa CeedSetErrorHandler()
166 #if defined(__clang__)
167 /// Use nonstandard ternary to convince the compiler/clang-tidy that this
168 /// function never returns zero.
169 #  define CeedError(ceed, ecode, ...)                                     \
170   (CeedErrorImpl((ceed), __FILE__, __LINE__, __func__, (ecode), __VA_ARGS__) ?: (ecode))
171 #else
172 #  define CeedError(ceed, ecode, ...)                                     \
173   CeedErrorImpl((ceed), __FILE__, __LINE__, __func__, (ecode), __VA_ARGS__) ?: (ecode)
174 #endif
175 
176 /// Specify memory type
177 ///
178 /// Many Ceed interfaces take or return pointers to memory.  This enum is used to
179 /// specify where the memory being provided or requested must reside.
180 /// @ingroup Ceed
181 typedef enum {
182   /// Memory resides on the host
183   CEED_MEM_HOST,
184   /// Memory resides on a device (corresponding to \ref Ceed resource)
185   CEED_MEM_DEVICE,
186 } CeedMemType;
187 
188 CEED_EXTERN const char *const CeedMemTypes[];
189 
190 CEED_EXTERN int CeedGetPreferredMemType(Ceed ceed, CeedMemType *type);
191 
192 /// Conveys ownership status of arrays passed to Ceed interfaces.
193 /// @ingroup Ceed
194 typedef enum {
195   /// Implementation will copy the values and not store the passed pointer.
196   CEED_COPY_VALUES,
197   /// Implementation can use and modify the data provided by the user, but does
198   /// not take ownership.
199   CEED_USE_POINTER,
200   /// Implementation takes ownership of the pointer and will free using
201   /// CeedFree() when done using it.  The user should not assume that the
202   /// pointer remains valid after ownership has been transferred.  Note that
203   /// arrays allocated using C++ operator new or other allocators cannot
204   /// generally be freed using CeedFree().  CeedFree() is capable of freeing any
205   /// memory that can be freed using free(3).
206   CEED_OWN_POINTER,
207 } CeedCopyMode;
208 
209 /// Denotes type of vector norm to be computed
210 /// @ingroup CeedVector
211 typedef enum {
212   /// L_1 norm: sum_i |x_i|
213   CEED_NORM_1,
214   /// L_2 norm: sqrt(sum_i |x_i|^2)
215   CEED_NORM_2,
216   /// L_Infinity norm: max_i |x_i|
217   CEED_NORM_MAX,
218 } CeedNormType;
219 
220 CEED_EXTERN const char *const CeedCopyModes[];
221 
222 CEED_EXTERN int CeedVectorCreate(Ceed ceed, CeedInt len, CeedVector *vec);
223 CEED_EXTERN int CeedVectorSetArray(CeedVector vec, CeedMemType mtype,
224                                    CeedCopyMode cmode, CeedScalar *array);
225 CEED_EXTERN int CeedVectorSetValue(CeedVector vec, CeedScalar value);
226 CEED_EXTERN int CeedVectorSyncArray(CeedVector vec, CeedMemType mtype);
227 CEED_EXTERN int CeedVectorGetArray(CeedVector vec, CeedMemType mtype,
228                                    CeedScalar **array);
229 CEED_EXTERN int CeedVectorGetArrayRead(CeedVector vec, CeedMemType mtype,
230                                        const CeedScalar **array);
231 CEED_EXTERN int CeedVectorRestoreArray(CeedVector vec, CeedScalar **array);
232 CEED_EXTERN int CeedVectorRestoreArrayRead(CeedVector vec,
233     const CeedScalar **array);
234 CEED_EXTERN int CeedVectorNorm(CeedVector vec, CeedNormType type,
235                                CeedScalar *norm);
236 CEED_EXTERN int CeedVectorView(CeedVector vec, const char *fpfmt, FILE *stream);
237 CEED_EXTERN int CeedVectorGetLength(CeedVector vec, CeedInt *length);
238 CEED_EXTERN int CeedVectorDestroy(CeedVector *vec);
239 
240 CEED_EXTERN CeedRequest *const CEED_REQUEST_IMMEDIATE;
241 CEED_EXTERN CeedRequest *const CEED_REQUEST_ORDERED;
242 CEED_EXTERN int CeedRequestWait(CeedRequest *req);
243 
244 /// Argument for CeedOperatorSetField that vector is collocated with
245 /// quadrature points, used with QFunction eval mode CEED_EVAL_NONE
246 /// or CEED_EVAL_INTERP only, not with CEED_EVAL_GRAD, CEED_EVAL_DIV,
247 /// or CEED_EVAL_CURL
248 /// @ingroup CeedBasis
249 CEED_EXTERN const CeedBasis CEED_BASIS_COLLOCATED;
250 
251 /// Argument for CeedOperatorSetField to use active input or output
252 /// @ingroup CeedVector
253 CEED_EXTERN const CeedVector CEED_VECTOR_ACTIVE;
254 
255 /// Argument for CeedOperatorSetField to use no vector, used with
256 /// qfunction input with eval mode CEED_EVAL_WEIGHT
257 /// @ingroup CeedVector
258 CEED_EXTERN const CeedVector CEED_VECTOR_NONE;
259 
260 /// Argument for CeedOperatorSetField to use no ElemRestriction, only used with
261 /// eval mode CEED_EVAL_WEIGHT.
262 /// @ingroup CeedElemRestriction
263 CEED_EXTERN const CeedElemRestriction CEED_ELEMRESTRICTION_NONE;
264 
265 /// Argument for CeedOperatorCreate that QFunction is not created by user.
266 /// Only used for QFunctions dqf and dqfT. If implemented, a backend may
267 /// attempt to provide the action of these QFunctions.
268 /// @ingroup CeedQFunction
269 CEED_EXTERN const CeedQFunction CEED_QFUNCTION_NONE;
270 
271 /// Denotes whether a linear transformation or its transpose should be applied
272 /// @ingroup CeedBasis
273 typedef enum {
274   /// Apply the linear transformation
275   CEED_NOTRANSPOSE,
276   /// Apply the transpose
277   CEED_TRANSPOSE
278 } CeedTransposeMode;
279 
280 CEED_EXTERN const char *const CeedTransposeModes[];
281 
282 /// Argument for CeedElemRestrictionCreateStrided that L-vector is in
283 /// the Ceed backend's preferred layout. This argument should only be used
284 /// with vectors created by a Ceed backend.
285 /// @ingroup CeedElemRestriction
286 CEED_EXTERN const CeedInt CEED_STRIDES_BACKEND[3];
287 
288 CEED_EXTERN int CeedElemRestrictionCreate(Ceed ceed, CeedInt nelem,
289     CeedInt elemsize, CeedInt ncomp, CeedInt compstride, CeedInt lsize,
290     CeedMemType mtype, CeedCopyMode cmode, const CeedInt *offsets,
291     CeedElemRestriction *rstr);
292 CEED_EXTERN int CeedElemRestrictionCreateStrided(Ceed ceed,
293     CeedInt nelem, CeedInt elemsize, CeedInt ncomp, CeedInt lsize,
294     const CeedInt strides[3], CeedElemRestriction *rstr);
295 CEED_EXTERN int CeedElemRestrictionCreateBlocked(Ceed ceed, CeedInt nelem,
296     CeedInt elemsize, CeedInt blksize, CeedInt ncomp, CeedInt compstride,
297     CeedInt lsize, CeedMemType mtype, CeedCopyMode cmode,
298     const CeedInt *offsets, CeedElemRestriction *rstr);
299 CEED_EXTERN int CeedElemRestrictionCreateBlockedStrided(Ceed ceed,
300     CeedInt nelem, CeedInt elemsize, CeedInt blksize, CeedInt ncomp,
301     CeedInt lsize, const CeedInt strides[3], CeedElemRestriction *rstr);
302 CEED_EXTERN int CeedElemRestrictionCreateVector(CeedElemRestriction rstr,
303     CeedVector *lvec, CeedVector *evec);
304 CEED_EXTERN int CeedElemRestrictionApply(CeedElemRestriction rstr,
305     CeedTransposeMode tmode, CeedVector u, CeedVector ru, CeedRequest *request);
306 CEED_EXTERN int CeedElemRestrictionApplyBlock(CeedElemRestriction rstr,
307     CeedInt block, CeedTransposeMode tmode, CeedVector u, CeedVector ru,
308     CeedRequest *request);
309 CEED_EXTERN int CeedElemRestrictionGetCompStride(CeedElemRestriction rstr,
310     CeedInt *compstride);
311 CEED_EXTERN int CeedElemRestrictionGetNumElements(CeedElemRestriction rstr,
312     CeedInt *numelem);
313 CEED_EXTERN int CeedElemRestrictionGetElementSize(CeedElemRestriction rstr,
314     CeedInt *elemsize);
315 CEED_EXTERN int CeedElemRestrictionGetLVectorSize(CeedElemRestriction rstr,
316     CeedInt *lsize);
317 CEED_EXTERN int CeedElemRestrictionGetNumComponents(CeedElemRestriction rstr,
318     CeedInt *numcomp);
319 CEED_EXTERN int CeedElemRestrictionGetNumBlocks(CeedElemRestriction rstr,
320     CeedInt *numblk);
321 CEED_EXTERN int CeedElemRestrictionGetBlockSize(CeedElemRestriction rstr,
322     CeedInt *blksize);
323 CEED_EXTERN int CeedElemRestrictionGetMultiplicity(CeedElemRestriction rstr,
324     CeedVector mult);
325 CEED_EXTERN int CeedElemRestrictionView(CeedElemRestriction rstr, FILE *stream);
326 CEED_EXTERN int CeedElemRestrictionDestroy(CeedElemRestriction *rstr);
327 
328 // The formalism here is that we have the structure
329 //  \int_\Omega v^T f_0(u, \nabla u, qdata) + (\nabla v)^T f_1(u, \nabla u, qdata)
330 // where gradients are with respect to the reference element.
331 
332 /// Basis evaluation mode
333 ///
334 /// Modes can be bitwise ORed when passing to most functions.
335 /// @ingroup CeedBasis
336 typedef enum {
337   /// Perform no evaluation (either because there is no data or it is already at
338   /// quadrature points)
339   CEED_EVAL_NONE   = 0,
340   /// Interpolate from nodes to quadrature points
341   CEED_EVAL_INTERP = 1,
342   /// Evaluate gradients at quadrature points from input in a nodal basis
343   CEED_EVAL_GRAD   = 2,
344   /// Evaluate divergence at quadrature points from input in a nodal basis
345   CEED_EVAL_DIV    = 4,
346   /// Evaluate curl at quadrature points from input in a nodal basis
347   CEED_EVAL_CURL   = 8,
348   /// Using no input, evaluate quadrature weights on the reference element
349   CEED_EVAL_WEIGHT = 16,
350 } CeedEvalMode;
351 
352 CEED_EXTERN const char *const CeedEvalModes[];
353 
354 /// Type of quadrature; also used for location of nodes
355 /// @ingroup CeedBasis
356 typedef enum {
357   /// Gauss-Legendre quadrature
358   CEED_GAUSS = 0,
359   /// Gauss-Legendre-Lobatto quadrature
360   CEED_GAUSS_LOBATTO = 1,
361 } CeedQuadMode;
362 
363 CEED_EXTERN const char *const CeedQuadModes[];
364 
365 /// Type of basis shape to create non-tensor H1 element basis
366 ///
367 /// Dimension can be extracted with bitwise AND
368 /// (CeedElemTopology & 2**(dim + 2)) == TRUE
369 /// @ingroup CeedBasis
370 typedef enum {
371   /// Line
372   CEED_LINE = 1 << 16 | 0,
373   /// Triangle - 2D shape
374   CEED_TRIANGLE = 2 << 16 | 1,
375   /// Quadralateral - 2D shape
376   CEED_QUAD = 2 << 16 | 2,
377   /// Tetrahedron - 3D shape
378   CEED_TET = 3 << 16 | 3,
379   /// Pyramid - 3D shape
380   CEED_PYRAMID = 3 << 16 | 4,
381   /// Prism - 3D shape
382   CEED_PRISM = 3 << 16 | 5,
383   /// Hexehedron - 3D shape
384   CEED_HEX = 3 << 16 | 6,
385 } CeedElemTopology;
386 
387 CEED_EXTERN const char *const CeedElemTopologies[];
388 
389 CEED_EXTERN int CeedBasisCreateTensorH1Lagrange(Ceed ceed, CeedInt dim,
390     CeedInt ncomp, CeedInt P, CeedInt Q, CeedQuadMode qmode, CeedBasis *basis);
391 CEED_EXTERN int CeedBasisCreateTensorH1(Ceed ceed, CeedInt dim, CeedInt ncomp,
392                                         CeedInt P1d, CeedInt Q1d,
393                                         const CeedScalar *interp1d,
394                                         const CeedScalar *grad1d,
395                                         const CeedScalar *qref1d,
396                                         const CeedScalar *qweight1d,
397                                         CeedBasis *basis);
398 CEED_EXTERN int CeedBasisCreateH1(Ceed ceed, CeedElemTopology topo,
399                                   CeedInt ncomp,
400                                   CeedInt nnodes, CeedInt nqpts,
401                                   const CeedScalar *interp,
402                                   const CeedScalar *grad,
403                                   const CeedScalar *qref,
404                                   const CeedScalar *qweight, CeedBasis *basis);
405 CEED_EXTERN int CeedBasisView(CeedBasis basis, FILE *stream);
406 CEED_EXTERN int CeedBasisApply(CeedBasis basis, CeedInt nelem,
407                                CeedTransposeMode tmode,
408                                CeedEvalMode emode, CeedVector u, CeedVector v);
409 CEED_EXTERN int CeedBasisGetDimension(CeedBasis basis, CeedInt *dim);
410 CEED_EXTERN int CeedBasisGetNumComponents(CeedBasis basis, CeedInt *numcomp);
411 CEED_EXTERN int CeedBasisGetNumNodes(CeedBasis basis, CeedInt *P);
412 CEED_EXTERN int CeedBasisGetNumNodes1D(CeedBasis basis, CeedInt *P1d);
413 CEED_EXTERN int CeedBasisGetNumQuadraturePoints(CeedBasis basis, CeedInt *Q);
414 CEED_EXTERN int CeedBasisGetNumQuadraturePoints1D(CeedBasis basis,
415     CeedInt *Q1d);
416 CEED_EXTERN int CeedBasisGetQRef(CeedBasis basis, const CeedScalar **qref);
417 CEED_EXTERN int CeedBasisGetQWeights(CeedBasis basis,
418                                      const CeedScalar **qweight);
419 CEED_EXTERN int CeedBasisGetInterp(CeedBasis basis, const CeedScalar **interp);
420 CEED_EXTERN int CeedBasisGetInterp1D(CeedBasis basis,
421                                      const CeedScalar **interp1d);
422 CEED_EXTERN int CeedBasisGetGrad(CeedBasis basis, const CeedScalar **grad);
423 CEED_EXTERN int CeedBasisGetGrad1D(CeedBasis basis, const CeedScalar **grad1d);
424 CEED_EXTERN int CeedBasisDestroy(CeedBasis *basis);
425 
426 CEED_EXTERN int CeedGaussQuadrature(CeedInt Q, CeedScalar *qref1d,
427                                     CeedScalar *qweight1d);
428 CEED_EXTERN int CeedLobattoQuadrature(CeedInt Q, CeedScalar *qref1d,
429                                       CeedScalar *qweight1d);
430 CEED_EXTERN int CeedQRFactorization(Ceed ceed, CeedScalar *mat, CeedScalar *tau,
431                                     CeedInt m, CeedInt n);
432 CEED_EXTERN int CeedSymmetricSchurDecomposition(Ceed ceed, CeedScalar *mat,
433     CeedScalar *lambda, CeedInt n);
434 CEED_EXTERN int CeedSimultaneousDiagonalization(Ceed ceed, CeedScalar *matA,
435     CeedScalar *matB, CeedScalar *x, CeedScalar *lambda, CeedInt n);
436 
437 /** Handle for the object describing the user CeedQFunction
438 
439  @param ctx user-defined context set using CeedQFunctionSetContext() or NULL
440 
441  @param Q   number of quadrature points at which to evaluate
442 
443  @param in  array of pointers to each input argument in the order provided
444               by the user in CeedQFunctionAddInput().  Each array has shape
445               `[dim, ncomp, Q]` where `dim` is the geometric dimension for
446               \ref CEED_EVAL_GRAD (`dim=1` for \ref CEED_EVAL_INTERP) and
447               `ncomp` is the number of field components (`ncomp=1` for
448               scalar fields).  This results in indexing the `i`th input at
449               quadrature point `j` as `in[i][(d*ncomp + c)*Q + j]`.
450 
451  @param out array of pointers to each output array in the order provided
452               using CeedQFunctionAddOutput().  The shapes are as above for
453               \a in.
454 
455  @return An error code: 0 - success, otherwise - failure
456 
457  @ingroup CeedQFunction
458 **/
459 typedef int (*CeedQFunctionUser)(void *ctx, const CeedInt Q,
460                                  const CeedScalar *const *in,
461                                  CeedScalar *const *out);
462 
463 CEED_EXTERN int CeedQFunctionCreateInterior(Ceed ceed, CeedInt vlength,
464     CeedQFunctionUser f, const char *source, CeedQFunction *qf);
465 CEED_EXTERN int CeedQFunctionCreateInteriorByName(Ceed ceed, const char *name,
466     CeedQFunction *qf);
467 CEED_EXTERN int CeedQFunctionCreateIdentity(Ceed ceed, CeedInt size,
468     CeedEvalMode inmode, CeedEvalMode outmode, CeedQFunction *qf);
469 CEED_EXTERN int CeedQFunctionAddInput(CeedQFunction qf, const char *fieldname,
470                                       CeedInt size, CeedEvalMode emode);
471 CEED_EXTERN int CeedQFunctionAddOutput(CeedQFunction qf, const char *fieldname,
472                                        CeedInt size, CeedEvalMode emode);
473 CEED_EXTERN int CeedQFunctionSetContext(CeedQFunction qf, void *ctx,
474                                         size_t ctxsize);
475 CEED_EXTERN int CeedQFunctionView(CeedQFunction qf, FILE *stream);
476 CEED_EXTERN int CeedQFunctionApply(CeedQFunction qf, CeedInt Q,
477                                    CeedVector *u, CeedVector *v);
478 CEED_EXTERN int CeedQFunctionDestroy(CeedQFunction *qf);
479 
480 CEED_EXTERN int CeedOperatorCreate(Ceed ceed, CeedQFunction qf,
481                                    CeedQFunction dqf, CeedQFunction dqfT,
482                                    CeedOperator *op);
483 CEED_EXTERN int CeedCompositeOperatorCreate(Ceed ceed, CeedOperator *op);
484 CEED_EXTERN int CeedOperatorSetField(CeedOperator op, const char *fieldname,
485                                      CeedElemRestriction r, CeedBasis b,
486                                      CeedVector v);
487 CEED_EXTERN int CeedCompositeOperatorAddSub(CeedOperator compositeop,
488     CeedOperator subop);
489 CEED_EXTERN int CeedOperatorLinearAssembleQFunction(CeedOperator op,
490     CeedVector *assembled, CeedElemRestriction *rstr, CeedRequest *request);
491 CEED_EXTERN int CeedOperatorLinearAssembleDiagonal(CeedOperator op,
492     CeedVector assembled, CeedRequest *request);
493 CEED_EXTERN int CeedOperatorLinearAssembleAddDiagonal(CeedOperator op,
494     CeedVector assembled, CeedRequest *request);
495 CEED_EXTERN int CeedOperatorLinearAssemblePointBlockDiagonal(CeedOperator op,
496     CeedVector assembled, CeedRequest *request);
497 CEED_EXTERN int CeedOperatorLinearAssembleAddPointBlockDiagonal(CeedOperator op,
498     CeedVector assembled, CeedRequest *request);
499 CEED_EXTERN int CeedOperatorCreateFDMElementInverse(CeedOperator op,
500     CeedOperator *fdminv, CeedRequest *request);
501 CEED_EXTERN int CeedOperatorView(CeedOperator op, FILE *stream);
502 CEED_EXTERN int CeedOperatorApply(CeedOperator op, CeedVector in,
503                                   CeedVector out, CeedRequest *request);
504 CEED_EXTERN int CeedOperatorApplyAdd(CeedOperator op, CeedVector in,
505                                      CeedVector out, CeedRequest *request);
506 CEED_EXTERN int CeedOperatorDestroy(CeedOperator *op);
507 
508 /**
509   @brief Return integer power
510 
511   @param[in] base   The base to exponentiate
512   @param[in] power  The power to raise the base to
513 
514   @return base^power
515 
516   @ref Utility
517 **/
518 static inline CeedInt CeedIntPow(CeedInt base, CeedInt power) {
519   CeedInt result = 1;
520   while (power) {
521     if (power & 1) result *= base;
522     power >>= 1;
523     base *= base;
524   }
525   return result;
526 }
527 
528 /**
529   @brief Return minimum of two integers
530 
531   @param[in] a  The first integer to compare
532   @param[in] b  The second integer to compare
533 
534   @return The minimum of the two integers
535 
536   @ref Utility
537 **/
538 static inline CeedInt CeedIntMin(CeedInt a, CeedInt b) { return a < b ? a : b; }
539 
540 #endif
541