xref: /libCEED/include/ceed.h (revision 523b8ea09bebe65e72854bf0f9327b4f4d8bccdb)
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 Basic User Functions
37 ///    These functions are intended to be used by general users of the libCEED
38 ///    interface. These functions can generally be found in "ceed.h".
39 /// @section Advanced Backend Developer Functions
40 ///    These functions are intended to be used by backend developers of the
41 ///    libCEED interface. These functions can generally be found in
42 ///    "ceed-backend.h".
43 /// @section Developer Frontend Developer Functions
44 ///    These functions are intended to be used by frontend developers of the
45 ///    libCEED interface. These functions can generally be found in "ceed-impl.h".
46 
47 /**
48   CEED_EXTERN is used in this header to denote all publicly visible symbols.
49 
50   No other file should declare publicly visible symbols, thus it should never be
51   used outside ceed.h.
52  */
53 #ifdef __cplusplus
54 #  define CEED_EXTERN extern "C"
55 #else
56 #  define CEED_EXTERN extern
57 #endif
58 
59 #ifndef CEED_QFUNCTION
60 #define CEED_QFUNCTION(name) \
61   static const char name ## _loc[] = __FILE__ ":" #name;        \
62   static int name
63 #endif
64 
65 #ifndef CeedPragmaSIMD
66 #  if defined(__INTEL_COMPILER) &&__INTEL_COMPILER >= 900
67 #    define CeedPragmaSIMD _Pragma("simd")
68 #  elif defined(__GNUC__) && __GNUC__ >= 5
69 #    define CeedPragmaSIMD _Pragma("GCC ivdep")
70 #  elif defined(_OPENMP) && _OPENMP >= 201307 // OpenMP-4.0 (July, 2013)
71 #    define CeedPragmaSIMD _Pragma("omp simd")
72 #  else
73 #    define CeedPragmaSIMD
74 #  endif
75 #endif
76 
77 #include <assert.h>
78 #include <stdint.h>
79 #include <stddef.h>
80 #include <stdarg.h>
81 #include <stdio.h>
82 #include <stdbool.h>
83 
84 /// We can discuss ways to avoid forcing these to be compile-time decisions,
85 ///   but let's leave that for later.
86 /// Integer type, used for indexing
87 /// @ingroup Ceed
88 typedef int32_t CeedInt;
89 /// Scalar (floating point) type
90 /// @ingroup Ceed
91 typedef double CeedScalar;
92 
93 /// Library context created by CeedInit()
94 /// @ingroup Ceed
95 typedef struct Ceed_private *Ceed;
96 /// Non-blocking Ceed interfaces return a CeedRequest.
97 /// To perform an operation immediately, pass \ref CEED_REQUEST_IMMEDIATE instead.
98 /// @ingroup Ceed
99 typedef struct CeedRequest_private *CeedRequest;
100 /// Handle for vectors over the field \ref CeedScalar
101 /// @ingroup CeedVector
102 typedef struct CeedVector_private *CeedVector;
103 /// Handle for object describing restriction to elements
104 /// @ingroup CeedElemRestriction
105 typedef struct CeedElemRestriction_private *CeedElemRestriction;
106 /// Handle for object describing discrete finite element evaluations
107 /// @ingroup CeedBasis
108 typedef struct CeedBasis_private *CeedBasis;
109 /// Handle for object describing functions evaluated independently at quadrature points
110 /// @ingroup CeedQFunction
111 typedef struct CeedQFunction_private *CeedQFunction;
112 /// Handle for object describing FE-type operators acting on vectors
113 ///
114 /// Given an element restriction \f$E\f$, basis evaluator \f$B\f$, and
115 ///   quadrature function\f$f\f$, a CeedOperator expresses operations of the form
116 ///   $$ E^T B^T f(B E u) $$
117 ///   acting on the vector \f$u\f$.
118 /// @ingroup CeedOperator
119 typedef struct CeedOperator_private *CeedOperator;
120 
121 CEED_EXTERN int CeedInit(const char *resource, Ceed *ceed);
122 CEED_EXTERN int CeedGetResource(Ceed ceed, const char **resource);
123 CEED_EXTERN int CeedDestroy(Ceed *ceed);
124 
125 CEED_EXTERN int CeedErrorImpl(Ceed, const char *, int, const char *, int,
126                               const char *, ...);
127 /// Raise an error on ceed object
128 ///
129 /// @param ceed Ceed library context or NULL
130 /// @param ecode Error code (int)
131 /// @param ... printf-style format string followed by arguments as needed
132 ///
133 /// @ingroup Ceed
134 /// @sa CeedSetErrorHandler()
135 #if defined(__clang__)
136 /// Use nonstandard ternary to convince the compiler/clang-tidy that this
137 /// function never returns zero.
138 #  define CeedError(ceed, ecode, ...)                                     \
139   (CeedErrorImpl((ceed), __FILE__, __LINE__, __func__, (ecode), __VA_ARGS__) ?: (ecode))
140 #else
141 #  define CeedError(ceed, ecode, ...)                                     \
142   CeedErrorImpl((ceed), __FILE__, __LINE__, __func__, (ecode), __VA_ARGS__) ?: (ecode)
143 #endif
144 /// Specify memory type
145 ///
146 /// Many Ceed interfaces take or return pointers to memory.  This enum is used to
147 /// specify where the memory being provided or requested must reside.
148 /// @ingroup Ceed
149 typedef enum {
150   /// Memory resides on the host
151   CEED_MEM_HOST,
152   /// Memory resides on a device (corresponding to \ref Ceed resource)
153   CEED_MEM_DEVICE,
154 } CeedMemType;
155 
156 CEED_EXTERN const char *const CeedMemTypes[];
157 
158 CEED_EXTERN int CeedGetPreferredMemType(Ceed ceed, CeedMemType *type);
159 
160 /// Conveys ownership status of arrays passed to Ceed interfaces.
161 /// @ingroup Ceed
162 typedef enum {
163   /// Implementation will copy the values and not store the passed pointer.
164   CEED_COPY_VALUES,
165   /// Implementation can use and modify the data provided by the user, but does
166   /// not take ownership.
167   CEED_USE_POINTER,
168   /// Implementation takes ownership of the pointer and will free using
169   /// CeedFree() when done using it.  The user should not assume that the
170   /// pointer remains valid after ownership has been transferred.  Note that
171   /// arrays allocated using C++ operator new or other allocators cannot
172   /// generally be freed using CeedFree().  CeedFree() is capable of freeing any
173   /// memory that can be freed using free(3).
174   CEED_OWN_POINTER,
175 } CeedCopyMode;
176 
177 /// Denotes type of vector norm to be computed
178 /// @ingroup CeedVector
179 typedef enum {
180   /// L_1 norm: sum_i |x_i|
181   CEED_NORM_1,
182   /// L_2 norm: sqrt(sum_i |x_i|^2)
183   CEED_NORM_2,
184   /// L_Infinity norm: max_i |x_i|
185   CEED_NORM_MAX,
186 } CeedNormType;
187 
188 CEED_EXTERN const char *const CeedCopyModes[];
189 
190 CEED_EXTERN int CeedVectorCreate(Ceed ceed, CeedInt len, CeedVector *vec);
191 CEED_EXTERN int CeedVectorSetArray(CeedVector vec, CeedMemType mtype,
192                                    CeedCopyMode cmode, CeedScalar *array);
193 CEED_EXTERN int CeedVectorSetValue(CeedVector vec, CeedScalar value);
194 CEED_EXTERN int CeedVectorSyncArray(CeedVector vec, CeedMemType mtype);
195 CEED_EXTERN int CeedVectorGetArray(CeedVector vec, CeedMemType mtype,
196                                    CeedScalar **array);
197 CEED_EXTERN int CeedVectorGetArrayRead(CeedVector vec, CeedMemType mtype,
198                                        const CeedScalar **array);
199 CEED_EXTERN int CeedVectorRestoreArray(CeedVector vec, CeedScalar **array);
200 CEED_EXTERN int CeedVectorRestoreArrayRead(CeedVector vec,
201     const CeedScalar **array);
202 CEED_EXTERN int CeedVectorNorm(CeedVector vec, CeedNormType type,
203                                CeedScalar *norm);
204 CEED_EXTERN int CeedVectorView(CeedVector vec, const char *fpfmt, FILE *stream);
205 CEED_EXTERN int CeedVectorGetLength(CeedVector vec, CeedInt *length);
206 CEED_EXTERN int CeedVectorDestroy(CeedVector *vec);
207 
208 CEED_EXTERN CeedRequest *const CEED_REQUEST_IMMEDIATE;
209 CEED_EXTERN CeedRequest *const CEED_REQUEST_ORDERED;
210 CEED_EXTERN int CeedRequestWait(CeedRequest *req);
211 
212 /// Argument for CeedOperatorSetField that vector is collocated with
213 /// quadrature points, used with QFunction eval mode CEED_EVAL_NONE
214 /// or CEED_EVAL_INTERP only, not with CEED_EVAL_GRAD, CEED_EVAL_DIV,
215 /// or CEED_EVAL_CURL
216 /// @ingroup CeedBasis
217 CEED_EXTERN CeedBasis CEED_BASIS_COLLOCATED;
218 
219 /// Argument for CeedOperatorSetField to use active input or output
220 /// @ingroup CeedVector
221 CEED_EXTERN CeedVector CEED_VECTOR_ACTIVE;
222 
223 /// Argument for CeedOperatorSetField to use no vector, used with
224 /// qfunction input with eval mode CEED_EVAL_WEIGHTS
225 /// @ingroup CeedVector
226 CEED_EXTERN CeedVector CEED_VECTOR_NONE;
227 
228 /// Argument for CeedOperatorCreate that QFunction is not created by user.
229 /// Only used for QFunctions dqf and dqfT. If implemented, a backend may
230 /// attempt to provide the action of these QFunctions.
231 /// @ingroup CeedQFunction
232 CEED_EXTERN CeedQFunction CEED_QFUNCTION_NONE;
233 
234 /// Denotes whether a linear transformation or its transpose should be applied
235 /// @ingroup CeedBasis
236 typedef enum {
237   /// Apply the linear transformation
238   CEED_NOTRANSPOSE,
239   /// Apply the transpose
240   CEED_TRANSPOSE
241 } CeedTransposeMode;
242 
243 CEED_EXTERN const char *const CeedTransposeModes[];
244 
245 /// Denotes whether a L-vector is ordered [component, node] or [node, component]
246 ///   with the right-most index being contiguous in memory
247 /// @ingroup CeedElemRestriction
248 typedef enum {
249   /// L-vector data is not interlaced, ordered [component, node]
250   CEED_NONINTERLACED,
251   /// L-vector data is interlaced, ordered [node, component]
252   CEED_INTERLACED
253 } CeedInterlaceMode;
254 
255 CEED_EXTERN const char *const CeedInterlaceModes[];
256 
257 /// Argument for CeedElemRestrictionCreateStrided that L-vector is in
258 /// the Ceed backend's preferred layout. This argument should only be used
259 /// with vectors created by a Ceed backend.
260 /// @ingroup CeedElemRestriction
261 CEED_EXTERN CeedInt CEED_STRIDES_BACKEND[3];
262 
263 CEED_EXTERN int CeedElemRestrictionCreate(Ceed ceed, CeedInterlaceMode imode,
264     CeedInt nelem, CeedInt elemsize, CeedInt nnodes, CeedInt ncomp,
265     CeedMemType mtype, CeedCopyMode cmode, const CeedInt *indices,
266     CeedElemRestriction *rstr);
267 CEED_EXTERN int CeedElemRestrictionCreateBlocked(Ceed ceed,
268     CeedInterlaceMode imode, CeedInt nelem, CeedInt elemsize, CeedInt blksize,
269     CeedInt nnodes, CeedInt ncomp, CeedMemType mtype, CeedCopyMode cmode,
270     const CeedInt *indices, CeedElemRestriction *rstr);
271 CEED_EXTERN int CeedElemRestrictionCreateStrided(Ceed ceed,
272     CeedInt nelem, CeedInt elemsize, CeedInt nnodes, CeedInt ncomp,
273     CeedInt strides[3], CeedElemRestriction *rstr);
274 CEED_EXTERN int CeedElemRestrictionCreateBlockedStrided(Ceed ceed,
275     CeedInt nelem, CeedInt elemsize, CeedInt blksize, CeedInt nnodes,
276     CeedInt ncomp, CeedInt strides[3], CeedElemRestriction *rstr);
277 CEED_EXTERN int CeedElemRestrictionCreateVector(CeedElemRestriction rstr,
278     CeedVector *lvec, CeedVector *evec);
279 CEED_EXTERN int CeedElemRestrictionApply(CeedElemRestriction rstr,
280     CeedTransposeMode tmode, CeedVector u, CeedVector ru, CeedRequest *request);
281 CEED_EXTERN int CeedElemRestrictionApplyBlock(CeedElemRestriction rstr,
282     CeedInt block, CeedTransposeMode tmode, CeedVector u, CeedVector ru,
283     CeedRequest *request);
284 CEED_EXTERN int CeedElemRestrictionGetIMode(CeedElemRestriction rstr,
285     CeedInterlaceMode *Imode);
286 CEED_EXTERN int CeedElemRestrictionGetNumElements(CeedElemRestriction rstr,
287     CeedInt *numelem);
288 CEED_EXTERN int CeedElemRestrictionGetElementSize(CeedElemRestriction rstr,
289     CeedInt *elemsize);
290 CEED_EXTERN int CeedElemRestrictionGetNumNodes(CeedElemRestriction rstr,
291     CeedInt *numnodes);
292 CEED_EXTERN int CeedElemRestrictionGetNumComponents(CeedElemRestriction rstr,
293     CeedInt *numcomp);
294 CEED_EXTERN int CeedElemRestrictionGetNumBlocks(CeedElemRestriction rstr,
295     CeedInt *numblk);
296 CEED_EXTERN int CeedElemRestrictionGetBlockSize(CeedElemRestriction rstr,
297     CeedInt *blksize);
298 CEED_EXTERN int CeedElemRestrictionGetMultiplicity(CeedElemRestriction rstr,
299     CeedVector mult);
300 CEED_EXTERN int CeedElemRestrictionView(CeedElemRestriction rstr, FILE *stream);
301 CEED_EXTERN int CeedElemRestrictionDestroy(CeedElemRestriction *rstr);
302 
303 /// The formalism here is that we have the structure
304 ///   \int_\Omega v^T f_0(u, \nabla u, qdata) + (\nabla v)^T f_1(u, \nabla u, qdata)
305 /// where gradients are with respect to the reference element.
306 
307 /// Basis evaluation mode
308 ///
309 /// Modes can be bitwise ORed when passing to most functions.
310 /// @ingroup CeedBasis
311 typedef enum {
312   /// Perform no evaluation (either because there is no data or it is already at
313   /// quadrature points)
314   CEED_EVAL_NONE   = 0,
315   /// Interpolate from nodes to quadrature points
316   CEED_EVAL_INTERP = 1,
317   /// Evaluate gradients at quadrature points from input in a nodal basis
318   CEED_EVAL_GRAD   = 2,
319   /// Evaluate divergence at quadrature points from input in a nodal basis
320   CEED_EVAL_DIV    = 4,
321   /// Evaluate curl at quadrature points from input in a nodal basis
322   CEED_EVAL_CURL   = 8,
323   /// Using no input, evaluate quadrature weights on the reference element
324   CEED_EVAL_WEIGHT = 16,
325 } CeedEvalMode;
326 
327 CEED_EXTERN const char *const CeedEvalModes[];
328 
329 /// Type of quadrature; also used for location of nodes
330 /// @ingroup CeedBasis
331 typedef enum {
332   /// Gauss-Legendre quadrature
333   CEED_GAUSS = 0,
334   /// Gauss-Legendre-Lobatto quadrature
335   CEED_GAUSS_LOBATTO = 1,
336 } CeedQuadMode;
337 
338 CEED_EXTERN const char *const CeedQuadModes[];
339 
340 /// Type of basis shape to create non-tensor H1 element basis
341 ///
342 /// Dimension can be extracted with bitwise AND
343 /// (CeedElemTopology & 2**(dim + 2)) == TRUE
344 /// @ingroup CeedBasis
345 typedef enum {
346   /// Line
347   CEED_LINE = 1 << 16 | 0,
348   /// Triangle - 2D shape
349   CEED_TRIANGLE = 2 << 16 | 1,
350   /// Quadralateral - 2D shape
351   CEED_QUAD = 2 << 16 | 2,
352   /// Tetrahedron - 3D shape
353   CEED_TET = 3 << 16 | 3,
354   /// Pyramid - 3D shape
355   CEED_PYRAMID = 3 << 16 | 4,
356   /// Prism - 3D shape
357   CEED_PRISM = 3 << 16 | 5,
358   /// Hexehedron - 3D shape
359   CEED_HEX = 3 << 16 | 6,
360 } CeedElemTopology;
361 
362 CEED_EXTERN const char *const CeedElemTopologies[];
363 
364 CEED_EXTERN int CeedBasisCreateTensorH1Lagrange(Ceed ceed, CeedInt dim,
365     CeedInt ncomp, CeedInt P, CeedInt Q, CeedQuadMode qmode, CeedBasis *basis);
366 CEED_EXTERN int CeedBasisCreateTensorH1(Ceed ceed, CeedInt dim, CeedInt ncomp,
367                                         CeedInt P1d, CeedInt Q1d,
368                                         const CeedScalar *interp1d,
369                                         const CeedScalar *grad1d,
370                                         const CeedScalar *qref1d,
371                                         const CeedScalar *qweight1d,
372                                         CeedBasis *basis);
373 CEED_EXTERN int CeedBasisCreateH1(Ceed ceed, CeedElemTopology topo,
374                                   CeedInt ncomp,
375                                   CeedInt nnodes, CeedInt nqpts,
376                                   const CeedScalar *interp,
377                                   const CeedScalar *grad,
378                                   const CeedScalar *qref,
379                                   const CeedScalar *qweight, CeedBasis *basis);
380 CEED_EXTERN int CeedBasisView(CeedBasis basis, FILE *stream);
381 CEED_EXTERN int CeedBasisGetNumNodes(CeedBasis basis, CeedInt *P);
382 CEED_EXTERN int CeedBasisGetNumQuadraturePoints(CeedBasis basis, CeedInt *Q);
383 CEED_EXTERN int CeedBasisApply(CeedBasis basis, CeedInt nelem,
384                                CeedTransposeMode tmode,
385                                CeedEvalMode emode, CeedVector u, CeedVector v);
386 CEED_EXTERN int CeedBasisDestroy(CeedBasis *basis);
387 
388 CEED_EXTERN int CeedGaussQuadrature(CeedInt Q, CeedScalar *qref1d,
389                                     CeedScalar *qweight1d);
390 CEED_EXTERN int CeedLobattoQuadrature(CeedInt Q, CeedScalar *qref1d,
391                                       CeedScalar *qweight1d);
392 CEED_EXTERN int CeedQRFactorization(Ceed ceed, CeedScalar *mat, CeedScalar *tau,
393                                     CeedInt m, CeedInt n);
394 CEED_EXTERN int CeedSymmetricSchurDecomposition(Ceed ceed, CeedScalar *mat,
395     CeedScalar *lambda, CeedInt n);
396 CEED_EXTERN int CeedSimultaneousDiagonalization(Ceed ceed, CeedScalar *matA,
397     CeedScalar *matB, CeedScalar *x, CeedScalar *lambda, CeedInt n);
398 
399 /** Handle for the object describing the user CeedQFunction
400 
401  @param ctx user-defined context set using CeedQFunctionSetContext() or NULL
402 
403  @param Q   number of quadrature points at which to evaluate
404 
405  @param in  array of pointers to each input argument in the order provided
406               by the user in CeedQFunctionAddInput().  Each array has shape
407               `[dim, ncomp, Q]` where `dim` is the geometric dimension for
408               \ref CEED_EVAL_GRAD (`dim=1` for \ref CEED_EVAL_INTERP) and
409               `ncomp` is the number of field components (`ncomp=1` for
410               scalar fields).  This results in indexing the `i`th input at
411               quadrature point `j` as `in[i][(d*ncomp + c)*Q + j]`.
412 
413  @param out array of pointers to each output array in the order provided
414               using CeedQFunctionAddOutput().  The shapes are as above for
415               \a in.
416 
417  @return An error code: 0 - success, otherwise - failure
418 
419  @ingroup CeedQFunction
420 **/
421 typedef int (*CeedQFunctionUser)(void *ctx, const CeedInt Q,
422                                  const CeedScalar *const *in,
423                                  CeedScalar *const *out);
424 
425 CEED_EXTERN int CeedQFunctionCreateInterior(Ceed ceed, CeedInt vlength,
426     CeedQFunctionUser f, const char *source, CeedQFunction *qf);
427 CEED_EXTERN int CeedQFunctionCreateInteriorByName(Ceed ceed, const char *name,
428     CeedQFunction *qf);
429 CEED_EXTERN int CeedQFunctionCreateIdentity(Ceed ceed, CeedInt size,
430     CeedEvalMode inmode, CeedEvalMode outmode, CeedQFunction *qf);
431 CEED_EXTERN int CeedQFunctionAddInput(CeedQFunction qf, const char *fieldname,
432                                       CeedInt size, CeedEvalMode emode);
433 CEED_EXTERN int CeedQFunctionAddOutput(CeedQFunction qf, const char *fieldname,
434                                        CeedInt size, CeedEvalMode emode);
435 CEED_EXTERN int CeedQFunctionSetContext(CeedQFunction qf, void *ctx,
436                                         size_t ctxsize);
437 CEED_EXTERN int CeedQFunctionView(CeedQFunction qf, FILE *stream);
438 CEED_EXTERN int CeedQFunctionApply(CeedQFunction qf, CeedInt Q,
439                                    CeedVector *u, CeedVector *v);
440 CEED_EXTERN int CeedQFunctionDestroy(CeedQFunction *qf);
441 
442 CEED_EXTERN int CeedOperatorCreate(Ceed ceed, CeedQFunction qf,
443                                    CeedQFunction dqf, CeedQFunction dqfT,
444                                    CeedOperator *op);
445 CEED_EXTERN int CeedCompositeOperatorCreate(Ceed ceed, CeedOperator *op);
446 CEED_EXTERN int CeedOperatorSetField(CeedOperator op, const char *fieldname,
447                                      CeedElemRestriction r, CeedBasis b,
448                                      CeedVector v);
449 CEED_EXTERN int CeedCompositeOperatorAddSub(CeedOperator compositeop,
450     CeedOperator subop);
451 CEED_EXTERN int CeedOperatorAssembleLinearQFunction(CeedOperator op,
452     CeedVector *assembled, CeedElemRestriction *rstr, CeedRequest *request);
453 CEED_EXTERN int CeedOperatorAssembleLinearDiagonal(CeedOperator op,
454     CeedVector *assembled, CeedRequest *request);
455 CEED_EXTERN int CeedOperatorView(CeedOperator op, FILE *stream);
456 CEED_EXTERN int CeedOperatorCreateFDMElementInverse(CeedOperator op,
457     CeedOperator *fdminv, CeedRequest *request);
458 CEED_EXTERN int CeedOperatorApply(CeedOperator op, CeedVector in,
459                                   CeedVector out, CeedRequest *request);
460 CEED_EXTERN int CeedOperatorApplyAdd(CeedOperator op, CeedVector in,
461                                      CeedVector out, CeedRequest *request);
462 CEED_EXTERN int CeedOperatorDestroy(CeedOperator *op);
463 
464 /**
465   @brief Return integer power
466 
467   @param[in] base   The base to exponentiate
468   @param[in] power  The power to raise the base to
469 
470   @return base^power
471 
472   @ref Utility
473 **/
474 static inline CeedInt CeedIntPow(CeedInt base, CeedInt power) {
475   CeedInt result = 1;
476   while (power) {
477     if (power & 1) result *= base;
478     power >>= 1;
479     base *= base;
480   }
481   return result;
482 }
483 
484 /**
485   @brief Return minimum of two integers
486 
487   @param[in] a  The first integer to compare
488   @param[in] b  The second integer to compare
489 
490   @return The minimum of the two integers
491 
492   @ref Utility
493 **/
494 static inline CeedInt CeedIntMin(CeedInt a, CeedInt b) { return a < b ? a : b; }
495 
496 #endif
497