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