xref: /libCEED/interface/ceed-qfunction.c (revision 3d576824e8d990e1f48c6609089904bee9170514)
1d7b241e6Sjeremylt // Copyright (c) 2017, Lawrence Livermore National Security, LLC. Produced at
2d7b241e6Sjeremylt // the Lawrence Livermore National Laboratory. LLNL-CODE-734707. All Rights
3d7b241e6Sjeremylt // reserved. See files LICENSE and NOTICE for details.
4d7b241e6Sjeremylt //
5d7b241e6Sjeremylt // This file is part of CEED, a collection of benchmarks, miniapps, software
6d7b241e6Sjeremylt // libraries and APIs for efficient high-order finite element and spectral
7d7b241e6Sjeremylt // element discretizations for exascale applications. For more information and
8d7b241e6Sjeremylt // source code availability see http://github.com/ceed.
9d7b241e6Sjeremylt //
10d7b241e6Sjeremylt // The CEED research is supported by the Exascale Computing Project 17-SC-20-SC,
11d7b241e6Sjeremylt // a collaborative effort of two U.S. Department of Energy organizations (Office
12d7b241e6Sjeremylt // of Science and the National Nuclear Security Administration) responsible for
13d7b241e6Sjeremylt // the planning and preparation of a capable exascale ecosystem, including
14d7b241e6Sjeremylt // software, applications, hardware, advanced system engineering and early
15d7b241e6Sjeremylt // testbed platforms, in support of the nation's exascale computing imperative.
16d7b241e6Sjeremylt 
17*3d576824SJeremy L Thompson #include <ceed.h>
18d863ab9bSjeremylt #include <ceed-backend.h>
19*3d576824SJeremy L Thompson #include <ceed-impl.h>
20288c0443SJeremy L Thompson #include <limits.h>
21*3d576824SJeremy L Thompson #include <stdbool.h>
22*3d576824SJeremy L Thompson #include <stdio.h>
23*3d576824SJeremy L Thompson #include <string.h>
24288c0443SJeremy L Thompson 
257a982d89SJeremy L. Thompson /// @file
267a982d89SJeremy L. Thompson /// Implementation of public CeedQFunction interfaces
277a982d89SJeremy L. Thompson 
28288c0443SJeremy L Thompson /// @cond DOXYGEN_SKIP
29442e7f0bSjeremylt static struct CeedQFunction_private ceed_qfunction_none;
30442e7f0bSjeremylt /// @endcond
31442e7f0bSjeremylt 
327a982d89SJeremy L. Thompson /// @addtogroup CeedQFunctionUser
337a982d89SJeremy L. Thompson /// @{
347a982d89SJeremy L. Thompson 
357a982d89SJeremy L. Thompson // Indicate that no QFunction is provided by the user
367a982d89SJeremy L. Thompson const CeedQFunction CEED_QFUNCTION_NONE = &ceed_qfunction_none;
377a982d89SJeremy L. Thompson 
387a982d89SJeremy L. Thompson /// @}
397a982d89SJeremy L. Thompson 
40442e7f0bSjeremylt /// @cond DOXYGEN_SKIP
41288c0443SJeremy L Thompson static struct {
42288c0443SJeremy L Thompson   char name[CEED_MAX_RESOURCE_LEN];
43288c0443SJeremy L Thompson   char source[CEED_MAX_RESOURCE_LEN];
44288c0443SJeremy L Thompson   CeedInt vlength;
45288c0443SJeremy L Thompson   CeedQFunctionUser f;
46288c0443SJeremy L Thompson   int (*init)(Ceed ceed, const char *name, CeedQFunction qf);
47288c0443SJeremy L Thompson } qfunctions[1024];
48288c0443SJeremy L Thompson static size_t num_qfunctions;
49288c0443SJeremy L Thompson /// @endcond
50d7b241e6Sjeremylt 
51777ff853SJeremy L Thompson /// ----------------------------------------------------------------------------
52777ff853SJeremy L Thompson /// CeedQFunction Library Internal Functions
53777ff853SJeremy L Thompson /// ----------------------------------------------------------------------------
54777ff853SJeremy L Thompson /// @addtogroup CeedQFunctionDeveloper
55777ff853SJeremy L Thompson /// @{
56777ff853SJeremy L Thompson 
57b11c1e72Sjeremylt /**
58288c0443SJeremy L Thompson   @brief Register a gallery QFunction
59288c0443SJeremy L Thompson 
60288c0443SJeremy L Thompson   @param name     Name for this backend to respond to
611176cc3aSJeremy L Thompson   @param source   Absolute path to source of QFunction,
621176cc3aSJeremy L Thompson                     "\path\CEED_DIR\gallery\folder\file.h:function_name"
63288c0443SJeremy L Thompson   @param vlength  Vector length.  Caller must ensure that number of quadrature
64288c0443SJeremy L Thompson                     points is a multiple of vlength.
65288c0443SJeremy L Thompson   @param f        Function pointer to evaluate action at quadrature points.
66288c0443SJeremy L Thompson                     See \ref CeedQFunctionUser.
67288c0443SJeremy L Thompson   @param init     Initialization function called by CeedQFunctionInit() when the
68288c0443SJeremy L Thompson                     QFunction is selected.
69288c0443SJeremy L Thompson 
70288c0443SJeremy L Thompson   @return An error code: 0 - success, otherwise - failure
71288c0443SJeremy L Thompson 
727a982d89SJeremy L. Thompson   @ref Developer
73288c0443SJeremy L Thompson **/
74288c0443SJeremy L Thompson int CeedQFunctionRegister(const char *name, const char *source,
75288c0443SJeremy L Thompson                           CeedInt vlength, CeedQFunctionUser f,
76288c0443SJeremy L Thompson                           int (*init)(Ceed, const char *, CeedQFunction)) {
77c042f62fSJeremy L Thompson   if (num_qfunctions >= sizeof(qfunctions) / sizeof(qfunctions[0]))
78c042f62fSJeremy L Thompson     // LCOV_EXCL_START
79288c0443SJeremy L Thompson     return CeedError(NULL, 1, "Too many gallery QFunctions");
80c042f62fSJeremy L Thompson   // LCOV_EXCL_STOP
81c042f62fSJeremy L Thompson 
82288c0443SJeremy L Thompson   strncpy(qfunctions[num_qfunctions].name, name, CEED_MAX_RESOURCE_LEN);
83288c0443SJeremy L Thompson   qfunctions[num_qfunctions].name[CEED_MAX_RESOURCE_LEN-1] = 0;
84288c0443SJeremy L Thompson   strncpy(qfunctions[num_qfunctions].source, source, CEED_MAX_RESOURCE_LEN);
85288c0443SJeremy L Thompson   qfunctions[num_qfunctions].source[CEED_MAX_RESOURCE_LEN-1] = 0;
86288c0443SJeremy L Thompson   qfunctions[num_qfunctions].vlength = vlength;
87288c0443SJeremy L Thompson   qfunctions[num_qfunctions].f = f;
88288c0443SJeremy L Thompson   qfunctions[num_qfunctions].init = init;
89288c0443SJeremy L Thompson   num_qfunctions++;
90288c0443SJeremy L Thompson   return 0;
91288c0443SJeremy L Thompson }
92288c0443SJeremy L Thompson 
93288c0443SJeremy L Thompson /**
947a982d89SJeremy L. Thompson   @brief Set a CeedQFunction field, used by CeedQFunctionAddInput/Output
957a982d89SJeremy L. Thompson 
967a982d89SJeremy L. Thompson   @param f          CeedQFunctionField
977a982d89SJeremy L. Thompson   @param fieldname  Name of QFunction field
984cc79fe7SJed Brown   @param size       Size of QFunction field, (ncomp * dim) for @ref CEED_EVAL_GRAD or
994cc79fe7SJed Brown                       (ncomp * 1) for @ref CEED_EVAL_NONE, @ref CEED_EVAL_INTERP, and @ref CEED_EVAL_WEIGHT
1007a982d89SJeremy L. Thompson   @param emode      \ref CEED_EVAL_NONE to use values directly,
1017a982d89SJeremy L. Thompson                       \ref CEED_EVAL_INTERP to use interpolated values,
1027a982d89SJeremy L. Thompson                       \ref CEED_EVAL_GRAD to use gradients,
1037a982d89SJeremy L. Thompson                       \ref CEED_EVAL_WEIGHT to use quadrature weights.
1047a982d89SJeremy L. Thompson 
1057a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
1067a982d89SJeremy L. Thompson 
1077a982d89SJeremy L. Thompson   @ref Developer
1087a982d89SJeremy L. Thompson **/
1097a982d89SJeremy L. Thompson static int CeedQFunctionFieldSet(CeedQFunctionField *f,const char *fieldname,
1107a982d89SJeremy L. Thompson                                  CeedInt size, CeedEvalMode emode) {
1117a982d89SJeremy L. Thompson   size_t len = strlen(fieldname);
1127a982d89SJeremy L. Thompson   char *tmp;
1137a982d89SJeremy L. Thompson   int ierr;
1147a982d89SJeremy L. Thompson   ierr = CeedCalloc(1,f); CeedChk(ierr);
1157a982d89SJeremy L. Thompson 
1167a982d89SJeremy L. Thompson   ierr = CeedCalloc(len+1, &tmp); CeedChk(ierr);
1177a982d89SJeremy L. Thompson   memcpy(tmp, fieldname, len+1);
1187a982d89SJeremy L. Thompson   (*f)->fieldname = tmp;
1197a982d89SJeremy L. Thompson   (*f)->size = size;
1207a982d89SJeremy L. Thompson   (*f)->emode = emode;
1217a982d89SJeremy L. Thompson   return 0;
1227a982d89SJeremy L. Thompson }
1237a982d89SJeremy L. Thompson 
1247a982d89SJeremy L. Thompson /**
1257a982d89SJeremy L. Thompson   @brief View a field of a CeedQFunction
1267a982d89SJeremy L. Thompson 
1277a982d89SJeremy L. Thompson   @param[in] field        QFunction field to view
1287a982d89SJeremy L. Thompson   @param[in] fieldnumber  Number of field being viewed
1294c4400c7SValeria Barra   @param[in] in           true for input field, false for output
1307a982d89SJeremy L. Thompson   @param[in] stream       Stream to view to, e.g., stdout
1317a982d89SJeremy L. Thompson 
1327a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
1337a982d89SJeremy L. Thompson 
1347a982d89SJeremy L. Thompson   @ref Utility
1357a982d89SJeremy L. Thompson **/
1367a982d89SJeremy L. Thompson static int CeedQFunctionFieldView(CeedQFunctionField field, CeedInt fieldnumber,
1377a982d89SJeremy L. Thompson                                   bool in, FILE *stream) {
1387a982d89SJeremy L. Thompson   const char *inout = in ? "Input" : "Output";
1397a982d89SJeremy L. Thompson   fprintf(stream, "    %s Field [%d]:\n"
1407a982d89SJeremy L. Thompson           "      Name: \"%s\"\n"
1417a982d89SJeremy L. Thompson           "      Size: %d\n"
1427a982d89SJeremy L. Thompson           "      EvalMode: \"%s\"\n",
1437a982d89SJeremy L. Thompson           inout, fieldnumber, field->fieldname, field->size,
1447a982d89SJeremy L. Thompson           CeedEvalModes[field->emode]);
1457a982d89SJeremy L. Thompson 
1467a982d89SJeremy L. Thompson   return 0;
1477a982d89SJeremy L. Thompson }
1487a982d89SJeremy L. Thompson 
149777ff853SJeremy L Thompson 
150777ff853SJeremy L Thompson /**
151777ff853SJeremy L Thompson   @brief Set flag to determine if Fortran interface is used
152777ff853SJeremy L Thompson 
153777ff853SJeremy L Thompson   @param qf                  CeedQFunction
154777ff853SJeremy L Thompson   @param status              Boolean value to set as Fortran status
155777ff853SJeremy L Thompson 
156777ff853SJeremy L Thompson   @return An error code: 0 - success, otherwise - failure
157777ff853SJeremy L Thompson 
158777ff853SJeremy L Thompson   @ref Backend
159777ff853SJeremy L Thompson **/
160777ff853SJeremy L Thompson int CeedQFunctionSetFortranStatus(CeedQFunction qf, bool status) {
161777ff853SJeremy L Thompson   qf->fortranstatus = status;
162777ff853SJeremy L Thompson   return 0;
163777ff853SJeremy L Thompson }
164777ff853SJeremy L Thompson 
1657a982d89SJeremy L. Thompson /// @}
1667a982d89SJeremy L. Thompson 
1677a982d89SJeremy L. Thompson /// ----------------------------------------------------------------------------
1687a982d89SJeremy L. Thompson /// CeedQFunction Backend API
1697a982d89SJeremy L. Thompson /// ----------------------------------------------------------------------------
1707a982d89SJeremy L. Thompson /// @addtogroup CeedQFunctionBackend
1717a982d89SJeremy L. Thompson /// @{
1727a982d89SJeremy L. Thompson 
1737a982d89SJeremy L. Thompson /**
1747a982d89SJeremy L. Thompson   @brief Get the Ceed associated with a CeedQFunction
1757a982d89SJeremy L. Thompson 
1767a982d89SJeremy L. Thompson   @param qf              CeedQFunction
1777a982d89SJeremy L. Thompson   @param[out] ceed       Variable to store Ceed
1787a982d89SJeremy L. Thompson 
1797a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
1807a982d89SJeremy L. Thompson 
1817a982d89SJeremy L. Thompson   @ref Backend
1827a982d89SJeremy L. Thompson **/
1837a982d89SJeremy L. Thompson int CeedQFunctionGetCeed(CeedQFunction qf, Ceed *ceed) {
1847a982d89SJeremy L. Thompson   *ceed = qf->ceed;
1857a982d89SJeremy L. Thompson   return 0;
1867a982d89SJeremy L. Thompson }
1877a982d89SJeremy L. Thompson 
1887a982d89SJeremy L. Thompson /**
1897a982d89SJeremy L. Thompson   @brief Get the vector length of a CeedQFunction
1907a982d89SJeremy L. Thompson 
1917a982d89SJeremy L. Thompson   @param qf            CeedQFunction
1927a982d89SJeremy L. Thompson   @param[out] vlength  Variable to store vector length
1937a982d89SJeremy L. Thompson 
1947a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
1957a982d89SJeremy L. Thompson 
1967a982d89SJeremy L. Thompson   @ref Backend
1977a982d89SJeremy L. Thompson **/
1987a982d89SJeremy L. Thompson int CeedQFunctionGetVectorLength(CeedQFunction qf, CeedInt *vlength) {
1997a982d89SJeremy L. Thompson   *vlength = qf->vlength;
2007a982d89SJeremy L. Thompson   return 0;
2017a982d89SJeremy L. Thompson }
2027a982d89SJeremy L. Thompson 
2037a982d89SJeremy L. Thompson /**
2047a982d89SJeremy L. Thompson   @brief Get the number of inputs and outputs to a CeedQFunction
2057a982d89SJeremy L. Thompson 
2067a982d89SJeremy L. Thompson   @param qf              CeedQFunction
2077a982d89SJeremy L. Thompson   @param[out] numinput   Variable to store number of input fields
2087a982d89SJeremy L. Thompson   @param[out] numoutput  Variable to store number of output fields
2097a982d89SJeremy L. Thompson 
2107a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
2117a982d89SJeremy L. Thompson 
2127a982d89SJeremy L. Thompson   @ref Backend
2137a982d89SJeremy L. Thompson **/
2147a982d89SJeremy L. Thompson int CeedQFunctionGetNumArgs(CeedQFunction qf, CeedInt *numinput,
2157a982d89SJeremy L. Thompson                             CeedInt *numoutput) {
2167a982d89SJeremy L. Thompson   if (numinput) *numinput = qf->numinputfields;
2177a982d89SJeremy L. Thompson   if (numoutput) *numoutput = qf->numoutputfields;
2187a982d89SJeremy L. Thompson   return 0;
2197a982d89SJeremy L. Thompson }
2207a982d89SJeremy L. Thompson 
2217a982d89SJeremy L. Thompson /**
2227a982d89SJeremy L. Thompson   @brief Get the source path string for a CeedQFunction
2237a982d89SJeremy L. Thompson 
2247a982d89SJeremy L. Thompson   @param qf              CeedQFunction
2257a982d89SJeremy L. Thompson   @param[out] source     Variable to store source path string
2267a982d89SJeremy L. Thompson 
2277a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
2287a982d89SJeremy L. Thompson 
2297a982d89SJeremy L. Thompson   @ref Backend
2307a982d89SJeremy L. Thompson **/
2317a982d89SJeremy L. Thompson int CeedQFunctionGetSourcePath(CeedQFunction qf, char **source) {
2327a982d89SJeremy L. Thompson   *source = (char *) qf->sourcepath;
2337a982d89SJeremy L. Thompson   return 0;
2347a982d89SJeremy L. Thompson }
2357a982d89SJeremy L. Thompson 
2367a982d89SJeremy L. Thompson /**
2377a982d89SJeremy L. Thompson   @brief Get the User Function for a CeedQFunction
2387a982d89SJeremy L. Thompson 
2397a982d89SJeremy L. Thompson   @param qf              CeedQFunction
2407a982d89SJeremy L. Thompson   @param[out] f          Variable to store user function
2417a982d89SJeremy L. Thompson 
2427a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
2437a982d89SJeremy L. Thompson 
2447a982d89SJeremy L. Thompson   @ref Backend
2457a982d89SJeremy L. Thompson **/
2467a982d89SJeremy L. Thompson int CeedQFunctionGetUserFunction(CeedQFunction qf, CeedQFunctionUser *f) {
2477a982d89SJeremy L. Thompson   *f = qf->function;
2487a982d89SJeremy L. Thompson   return 0;
2497a982d89SJeremy L. Thompson }
2507a982d89SJeremy L. Thompson 
2517a982d89SJeremy L. Thompson /**
252777ff853SJeremy L Thompson   @brief Get global context for a CeedQFunction.
253777ff853SJeremy L Thompson          Note: For QFunctions from the Fortran interface, this
254777ff853SJeremy L Thompson                function will return the Fortran context
255777ff853SJeremy L Thompson                CeedQFunctionContext.
2567a982d89SJeremy L. Thompson 
2577a982d89SJeremy L. Thompson   @param qf              CeedQFunction
258777ff853SJeremy L Thompson   @param[out] ctx        Variable to store CeedQFunctionContext
2597a982d89SJeremy L. Thompson 
2607a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
2617a982d89SJeremy L. Thompson 
2627a982d89SJeremy L. Thompson   @ref Backend
2637a982d89SJeremy L. Thompson **/
264777ff853SJeremy L Thompson int CeedQFunctionGetContext(CeedQFunction qf, CeedQFunctionContext *ctx) {
2657a982d89SJeremy L. Thompson   *ctx = qf->ctx;
2667a982d89SJeremy L. Thompson   return 0;
2677a982d89SJeremy L. Thompson }
2687a982d89SJeremy L. Thompson 
2697a982d89SJeremy L. Thompson /**
2707a982d89SJeremy L. Thompson   @brief Get true user context for a CeedQFunction
271777ff853SJeremy L Thompson          Note: For all QFunctions this function will return the user
272777ff853SJeremy L Thompson                CeedQFunctionContext and not interface context
273777ff853SJeremy L Thompson                CeedQFunctionContext, if any such object exists.
2747a982d89SJeremy L. Thompson 
2757a982d89SJeremy L. Thompson   @param qf              CeedQFunction
276777ff853SJeremy L Thompson   @param[out] ctx        Variable to store CeedQFunctionContext
2777a982d89SJeremy L. Thompson 
2787a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
2797a982d89SJeremy L. Thompson   @ref Backend
2807a982d89SJeremy L. Thompson **/
281777ff853SJeremy L Thompson int CeedQFunctionGetInnerContext(CeedQFunction qf, CeedQFunctionContext *ctx) {
282777ff853SJeremy L Thompson   int ierr;
2837a982d89SJeremy L. Thompson   if (qf->fortranstatus) {
284777ff853SJeremy L Thompson     CeedFortranContext fctx = NULL;
285777ff853SJeremy L Thompson     ierr = CeedQFunctionContextGetData(qf->ctx, CEED_MEM_HOST, &fctx);
286777ff853SJeremy L Thompson     CeedChk(ierr);
2877a982d89SJeremy L. Thompson     *ctx = fctx->innerctx;
288777ff853SJeremy L Thompson     ierr = CeedQFunctionContextRestoreData(qf->ctx, (void *)&fctx); CeedChk(ierr);
2897a982d89SJeremy L. Thompson   } else {
2907a982d89SJeremy L. Thompson     *ctx = qf->ctx;
2917a982d89SJeremy L. Thompson   }
2927a982d89SJeremy L. Thompson 
2937a982d89SJeremy L. Thompson 
2947a982d89SJeremy L. Thompson   return 0;
2957a982d89SJeremy L. Thompson }
2967a982d89SJeremy L. Thompson 
2977a982d89SJeremy L. Thompson /**
2987a982d89SJeremy L. Thompson   @brief Determine if QFunction is identity
2997a982d89SJeremy L. Thompson 
3007a982d89SJeremy L. Thompson   @param qf               CeedQFunction
301fd364f38SJeremy L Thompson   @param[out] isidentity  Variable to store identity status
3027a982d89SJeremy L. Thompson 
3037a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
3047a982d89SJeremy L. Thompson 
3057a982d89SJeremy L. Thompson   @ref Backend
3067a982d89SJeremy L. Thompson **/
307fd364f38SJeremy L Thompson int CeedQFunctionIsIdentity(CeedQFunction qf, bool *isidentity) {
308fd364f38SJeremy L Thompson   *isidentity = qf->identity;
3097a982d89SJeremy L. Thompson   return 0;
3107a982d89SJeremy L. Thompson }
3117a982d89SJeremy L. Thompson 
3127a982d89SJeremy L. Thompson /**
3137a982d89SJeremy L. Thompson   @brief Get backend data of a CeedQFunction
3147a982d89SJeremy L. Thompson 
3157a982d89SJeremy L. Thompson   @param qf              CeedQFunction
3167a982d89SJeremy L. Thompson   @param[out] data       Variable to store data
3177a982d89SJeremy L. Thompson 
3187a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
3197a982d89SJeremy L. Thompson 
3207a982d89SJeremy L. Thompson   @ref Backend
3217a982d89SJeremy L. Thompson **/
322777ff853SJeremy L Thompson int CeedQFunctionGetData(CeedQFunction qf, void *data) {
323777ff853SJeremy L Thompson   *(void **)data = qf->data;
3247a982d89SJeremy L. Thompson   return 0;
3257a982d89SJeremy L. Thompson }
3267a982d89SJeremy L. Thompson 
3277a982d89SJeremy L. Thompson /**
3287a982d89SJeremy L. Thompson   @brief Set backend data of a CeedQFunction
3297a982d89SJeremy L. Thompson 
3307a982d89SJeremy L. Thompson   @param[out] qf         CeedQFunction
3317a982d89SJeremy L. Thompson   @param data            Data to set
3327a982d89SJeremy L. Thompson 
3337a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
3347a982d89SJeremy L. Thompson 
3357a982d89SJeremy L. Thompson   @ref Backend
3367a982d89SJeremy L. Thompson **/
337777ff853SJeremy L Thompson int CeedQFunctionSetData(CeedQFunction qf, void *data) {
338777ff853SJeremy L Thompson   qf->data = data;
3397a982d89SJeremy L. Thompson   return 0;
3407a982d89SJeremy L. Thompson }
3417a982d89SJeremy L. Thompson 
3427a982d89SJeremy L. Thompson /**
3437a982d89SJeremy L. Thompson   @brief Get the CeedQFunctionFields of a CeedQFunction
3447a982d89SJeremy L. Thompson 
3457a982d89SJeremy L. Thompson   @param qf                 CeedQFunction
3467a982d89SJeremy L. Thompson   @param[out] inputfields   Variable to store inputfields
3477a982d89SJeremy L. Thompson   @param[out] outputfields  Variable to store outputfields
3487a982d89SJeremy L. Thompson 
3497a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
3507a982d89SJeremy L. Thompson 
3517a982d89SJeremy L. Thompson   @ref Backend
3527a982d89SJeremy L. Thompson **/
3537a982d89SJeremy L. Thompson int CeedQFunctionGetFields(CeedQFunction qf, CeedQFunctionField **inputfields,
3547a982d89SJeremy L. Thompson                            CeedQFunctionField **outputfields) {
3557a982d89SJeremy L. Thompson   if (inputfields)
3567a982d89SJeremy L. Thompson     *inputfields = qf->inputfields;
3577a982d89SJeremy L. Thompson   if (outputfields)
3587a982d89SJeremy L. Thompson     *outputfields = qf->outputfields;
3597a982d89SJeremy L. Thompson   return 0;
3607a982d89SJeremy L. Thompson }
3617a982d89SJeremy L. Thompson 
3627a982d89SJeremy L. Thompson /**
3637a982d89SJeremy L. Thompson   @brief Get the name of a CeedQFunctionField
3647a982d89SJeremy L. Thompson 
3657a982d89SJeremy L. Thompson   @param qffield         CeedQFunctionField
3667a982d89SJeremy L. Thompson   @param[out] fieldname  Variable to store the field name
3677a982d89SJeremy L. Thompson 
3687a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
3697a982d89SJeremy L. Thompson 
3707a982d89SJeremy L. Thompson   @ref Backend
3717a982d89SJeremy L. Thompson **/
3727a982d89SJeremy L. Thompson int CeedQFunctionFieldGetName(CeedQFunctionField qffield, char **fieldname) {
3737a982d89SJeremy L. Thompson   *fieldname = (char *)qffield->fieldname;
3747a982d89SJeremy L. Thompson   return 0;
3757a982d89SJeremy L. Thompson }
3767a982d89SJeremy L. Thompson 
3777a982d89SJeremy L. Thompson /**
3787a982d89SJeremy L. Thompson   @brief Get the number of components of a CeedQFunctionField
3797a982d89SJeremy L. Thompson 
3807a982d89SJeremy L. Thompson   @param qffield    CeedQFunctionField
3817a982d89SJeremy L. Thompson   @param[out] size  Variable to store the size of the field
3827a982d89SJeremy L. Thompson 
3837a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
3847a982d89SJeremy L. Thompson 
3857a982d89SJeremy L. Thompson   @ref Backend
3867a982d89SJeremy L. Thompson **/
3877a982d89SJeremy L. Thompson int CeedQFunctionFieldGetSize(CeedQFunctionField qffield, CeedInt *size) {
3887a982d89SJeremy L. Thompson   *size = qffield->size;
3897a982d89SJeremy L. Thompson   return 0;
3907a982d89SJeremy L. Thompson }
3917a982d89SJeremy L. Thompson 
3927a982d89SJeremy L. Thompson /**
3937a982d89SJeremy L. Thompson   @brief Get the CeedEvalMode of a CeedQFunctionField
3947a982d89SJeremy L. Thompson 
3957a982d89SJeremy L. Thompson   @param qffield         CeedQFunctionField
3967a982d89SJeremy L. Thompson   @param[out] emode      Variable to store the field evaluation mode
3977a982d89SJeremy L. Thompson 
3987a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
3997a982d89SJeremy L. Thompson 
4007a982d89SJeremy L. Thompson   @ref Backend
4017a982d89SJeremy L. Thompson **/
4027a982d89SJeremy L. Thompson int CeedQFunctionFieldGetEvalMode(CeedQFunctionField qffield,
4037a982d89SJeremy L. Thompson                                   CeedEvalMode *emode) {
4047a982d89SJeremy L. Thompson   *emode = qffield->emode;
4057a982d89SJeremy L. Thompson   return 0;
4067a982d89SJeremy L. Thompson }
4077a982d89SJeremy L. Thompson 
4087a982d89SJeremy L. Thompson /// @}
4097a982d89SJeremy L. Thompson 
4107a982d89SJeremy L. Thompson /// ----------------------------------------------------------------------------
4117a982d89SJeremy L. Thompson /// CeedQFunction Public API
4127a982d89SJeremy L. Thompson /// ----------------------------------------------------------------------------
4137a982d89SJeremy L. Thompson /// @addtogroup CeedQFunctionUser
4147a982d89SJeremy L. Thompson /// @{
4157a982d89SJeremy L. Thompson 
4167a982d89SJeremy L. Thompson /**
4177a982d89SJeremy L. Thompson   @brief Create a CeedQFunction for evaluating interior (volumetric) terms.
4187a982d89SJeremy L. Thompson 
4197a982d89SJeremy L. Thompson   @param ceed       A Ceed object where the CeedQFunction will be created
4207a982d89SJeremy L. Thompson   @param vlength    Vector length. Caller must ensure that number of quadrature
4217a982d89SJeremy L. Thompson                       points is a multiple of vlength.
4227a982d89SJeremy L. Thompson   @param f          Function pointer to evaluate action at quadrature points.
4237a982d89SJeremy L. Thompson                       See \ref CeedQFunctionUser.
4247a982d89SJeremy L. Thompson   @param source     Absolute path to source of QFunction,
425c8d5b03cSJeremy L Thompson                       "\abs_path\file.h:function_name".
426c8d5b03cSJeremy L Thompson                       For support across all backends, this source must only
427c8d5b03cSJeremy L Thompson                       contain constructs supported by C99, C++11, and CUDA.
4287a982d89SJeremy L. Thompson   @param[out] qf    Address of the variable where the newly created
4297a982d89SJeremy L. Thompson                       CeedQFunction will be stored
4307a982d89SJeremy L. Thompson 
4317a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
4327a982d89SJeremy L. Thompson 
4337a982d89SJeremy L. Thompson   See \ref CeedQFunctionUser for details on the call-back function @a f's
4347a982d89SJeremy L. Thompson     arguments.
4357a982d89SJeremy L. Thompson 
4367a982d89SJeremy L. Thompson   @ref User
4377a982d89SJeremy L. Thompson **/
4387a982d89SJeremy L. Thompson int CeedQFunctionCreateInterior(Ceed ceed, CeedInt vlength, CeedQFunctionUser f,
4397a982d89SJeremy L. Thompson                                 const char *source, CeedQFunction *qf) {
4407a982d89SJeremy L. Thompson   int ierr;
4417a982d89SJeremy L. Thompson   char *source_copy;
4427a982d89SJeremy L. Thompson 
4437a982d89SJeremy L. Thompson   if (!ceed->QFunctionCreate) {
4447a982d89SJeremy L. Thompson     Ceed delegate;
4457a982d89SJeremy L. Thompson     ierr = CeedGetObjectDelegate(ceed, &delegate, "QFunction"); CeedChk(ierr);
4467a982d89SJeremy L. Thompson 
4477a982d89SJeremy L. Thompson     if (!delegate)
4487a982d89SJeremy L. Thompson       // LCOV_EXCL_START
4497a982d89SJeremy L. Thompson       return CeedError(ceed, 1, "Backend does not support QFunctionCreate");
4507a982d89SJeremy L. Thompson     // LCOV_EXCL_STOP
4517a982d89SJeremy L. Thompson 
4527a982d89SJeremy L. Thompson     ierr = CeedQFunctionCreateInterior(delegate, vlength, f, source, qf);
4537a982d89SJeremy L. Thompson     CeedChk(ierr);
4547a982d89SJeremy L. Thompson     return 0;
4557a982d89SJeremy L. Thompson   }
4567a982d89SJeremy L. Thompson 
4577a982d89SJeremy L. Thompson   ierr = CeedCalloc(1, qf); CeedChk(ierr);
4587a982d89SJeremy L. Thompson   (*qf)->ceed = ceed;
4597a982d89SJeremy L. Thompson   ceed->refcount++;
4607a982d89SJeremy L. Thompson   (*qf)->refcount = 1;
4617a982d89SJeremy L. Thompson   (*qf)->vlength = vlength;
4627a982d89SJeremy L. Thompson   (*qf)->identity = 0;
4637a982d89SJeremy L. Thompson   (*qf)->function = f;
4647a982d89SJeremy L. Thompson   size_t slen = strlen(source) + 1;
4657a982d89SJeremy L. Thompson   ierr = CeedMalloc(slen, &source_copy); CeedChk(ierr);
4667a982d89SJeremy L. Thompson   memcpy(source_copy, source, slen);
4677a982d89SJeremy L. Thompson   (*qf)->sourcepath = source_copy;
4687a982d89SJeremy L. Thompson   ierr = CeedCalloc(16, &(*qf)->inputfields); CeedChk(ierr);
4697a982d89SJeremy L. Thompson   ierr = CeedCalloc(16, &(*qf)->outputfields); CeedChk(ierr);
4707a982d89SJeremy L. Thompson   ierr = ceed->QFunctionCreate(*qf); CeedChk(ierr);
4717a982d89SJeremy L. Thompson   return 0;
4727a982d89SJeremy L. Thompson }
4737a982d89SJeremy L. Thompson 
4747a982d89SJeremy L. Thompson /**
475288c0443SJeremy L Thompson   @brief Create a CeedQFunction for evaluating interior (volumetric) terms by name.
476288c0443SJeremy L Thompson 
477288c0443SJeremy L Thompson   @param ceed       A Ceed object where the CeedQFunction will be created
478288c0443SJeremy L Thompson   @param name       Name of QFunction to use from gallery
479288c0443SJeremy L Thompson   @param[out] qf    Address of the variable where the newly created
480288c0443SJeremy L Thompson                       CeedQFunction will be stored
481288c0443SJeremy L Thompson 
482288c0443SJeremy L Thompson   @return An error code: 0 - success, otherwise - failure
483288c0443SJeremy L Thompson 
4847a982d89SJeremy L. Thompson   @ref User
485288c0443SJeremy L Thompson **/
486288c0443SJeremy L Thompson int CeedQFunctionCreateInteriorByName(Ceed ceed,  const char *name,
487288c0443SJeremy L Thompson                                       CeedQFunction *qf) {
488288c0443SJeremy L Thompson   int ierr;
489288c0443SJeremy L Thompson   size_t matchlen = 0, matchidx = UINT_MAX;
49075affc3bSjeremylt   char *name_copy;
491288c0443SJeremy L Thompson 
4921d013790SJed Brown   ierr = CeedQFunctionRegisterAll(); CeedChk(ierr);
493288c0443SJeremy L Thompson   // Find matching backend
494278f913bSWill Pazner   if (!name) return CeedError(ceed, 1, "No QFunction name provided");
495288c0443SJeremy L Thompson   for (size_t i=0; i<num_qfunctions; i++) {
496288c0443SJeremy L Thompson     size_t n;
497288c0443SJeremy L Thompson     const char *currname = qfunctions[i].name;
498288c0443SJeremy L Thompson     for (n = 0; currname[n] && currname[n] == name[n]; n++) {}
499288c0443SJeremy L Thompson     if (n > matchlen) {
500288c0443SJeremy L Thompson       matchlen = n;
501288c0443SJeremy L Thompson       matchidx = i;
502288c0443SJeremy L Thompson     }
503288c0443SJeremy L Thompson   }
5041d102b48SJeremy L Thompson   if (!matchlen)
505138d4072Sjeremylt     // LCOV_EXCL_START
506278f913bSWill Pazner     return CeedError(ceed, 1, "No suitable gallery QFunction");
507138d4072Sjeremylt   // LCOV_EXCL_STOP
508288c0443SJeremy L Thompson 
509288c0443SJeremy L Thompson   // Create QFunction
510288c0443SJeremy L Thompson   ierr = CeedQFunctionCreateInterior(ceed, qfunctions[matchidx].vlength,
511288c0443SJeremy L Thompson                                      qfunctions[matchidx].f,
512288c0443SJeremy L Thompson                                      qfunctions[matchidx].source, qf);
513288c0443SJeremy L Thompson   CeedChk(ierr);
514288c0443SJeremy L Thompson 
515288c0443SJeremy L Thompson   // QFunction specific setup
516288c0443SJeremy L Thompson   ierr = qfunctions[matchidx].init(ceed, name, *qf); CeedChk(ierr);
517288c0443SJeremy L Thompson 
51875affc3bSjeremylt   // Copy name
51975affc3bSjeremylt   size_t slen = strlen(name) + 1;
52075affc3bSjeremylt   ierr = CeedMalloc(slen, &name_copy); CeedChk(ierr);
52175affc3bSjeremylt   memcpy(name_copy, name, slen);
52275affc3bSjeremylt   (*qf)->qfname = name_copy;
52375affc3bSjeremylt 
524288c0443SJeremy L Thompson   return 0;
525288c0443SJeremy L Thompson }
526288c0443SJeremy L Thompson 
527288c0443SJeremy L Thompson /**
5280219ea01SJeremy L Thompson   @brief Create an identity CeedQFunction. Inputs are written into outputs in
5290219ea01SJeremy L Thompson            the order given. This is useful for CeedOperators that can be
5300219ea01SJeremy L Thompson            represented with only the action of a CeedRestriction and CeedBasis,
5310219ea01SJeremy L Thompson            such as restriction and prolongation operators for p-multigrid.
5320219ea01SJeremy L Thompson            Backends may optimize CeedOperators with this CeedQFunction to avoid
5330219ea01SJeremy L Thompson            the copy of input data to output fields by using the same memory
5340219ea01SJeremy L Thompson            location for both.
5350219ea01SJeremy L Thompson 
5360219ea01SJeremy L Thompson   @param ceed         A Ceed object where the CeedQFunction will be created
53760f77c51Sjeremylt   @param[in] size     Size of the qfunction fields
53860f77c51Sjeremylt   @param[in] inmode   CeedEvalMode for input to CeedQFunction
53960f77c51Sjeremylt   @param[in] outmode  CeedEvalMode for output to CeedQFunction
5400219ea01SJeremy L Thompson   @param[out] qf      Address of the variable where the newly created
5410219ea01SJeremy L Thompson                         CeedQFunction will be stored
5420219ea01SJeremy L Thompson 
5430219ea01SJeremy L Thompson   @return An error code: 0 - success, otherwise - failure
5440219ea01SJeremy L Thompson 
5457a982d89SJeremy L. Thompson   @ref User
5460219ea01SJeremy L Thompson **/
54760f77c51Sjeremylt int CeedQFunctionCreateIdentity(Ceed ceed, CeedInt size, CeedEvalMode inmode,
54860f77c51Sjeremylt                                 CeedEvalMode outmode, CeedQFunction *qf) {
5490219ea01SJeremy L Thompson   int ierr;
5500219ea01SJeremy L Thompson 
55160f77c51Sjeremylt   if (inmode == CEED_EVAL_NONE && outmode == CEED_EVAL_NONE)
55260f77c51Sjeremylt     // LCOV_EXCL_START
55360f77c51Sjeremylt     return CeedError(ceed, 1, "CEED_EVAL_NONE for a both the input and "
55460f77c51Sjeremylt                      "output does not make sense with an identity QFunction");
55560f77c51Sjeremylt   // LCOV_EXCL_STOP
55660f77c51Sjeremylt 
5570219ea01SJeremy L Thompson   ierr = CeedQFunctionCreateInteriorByName(ceed, "Identity", qf); CeedChk(ierr);
5581dfeea39SJeremy L Thompson   ierr = CeedQFunctionAddInput(*qf, "input", size, inmode); CeedChk(ierr);
5591dfeea39SJeremy L Thompson   ierr = CeedQFunctionAddOutput(*qf, "output", size, outmode); CeedChk(ierr);
5600219ea01SJeremy L Thompson 
5610219ea01SJeremy L Thompson   (*qf)->identity = 1;
562777ff853SJeremy L Thompson   CeedInt *sizeData;
563777ff853SJeremy L Thompson   ierr = CeedCalloc(1, &sizeData); CeedChk(ierr);
564777ff853SJeremy L Thompson   sizeData[0] = size;
565777ff853SJeremy L Thompson   CeedQFunctionContext ctx;
566777ff853SJeremy L Thompson   ierr = CeedQFunctionContextCreate(ceed, &ctx); CeedChk(ierr);
567777ff853SJeremy L Thompson   ierr = CeedQFunctionContextSetData(ctx, CEED_MEM_HOST, CEED_OWN_POINTER,
568777ff853SJeremy L Thompson                                      sizeof(*sizeData), (void *)sizeData);
569777ff853SJeremy L Thompson   CeedChk(ierr);
570777ff853SJeremy L Thompson   ierr = CeedQFunctionSetContext(*qf, ctx); CeedChk(ierr);
571777ff853SJeremy L Thompson   ierr = CeedQFunctionContextDestroy(&ctx); CeedChk(ierr);
5720219ea01SJeremy L Thompson 
5730219ea01SJeremy L Thompson   return 0;
5740219ea01SJeremy L Thompson }
5750219ea01SJeremy L Thompson 
5760219ea01SJeremy L Thompson /**
577a0a97fcfSJed Brown   @brief Add a CeedQFunction input
578b11c1e72Sjeremylt 
579b11c1e72Sjeremylt   @param qf         CeedQFunction
580b11c1e72Sjeremylt   @param fieldname  Name of QFunction field
5814cc79fe7SJed Brown   @param size       Size of QFunction field, (ncomp * dim) for @ref CEED_EVAL_GRAD or
5824cc79fe7SJed Brown                       (ncomp * 1) for @ref CEED_EVAL_NONE and @ref CEED_EVAL_INTERP
583b11c1e72Sjeremylt   @param emode      \ref CEED_EVAL_NONE to use values directly,
584b11c1e72Sjeremylt                       \ref CEED_EVAL_INTERP to use interpolated values,
585b11c1e72Sjeremylt                       \ref CEED_EVAL_GRAD to use gradients.
586b11c1e72Sjeremylt 
587b11c1e72Sjeremylt   @return An error code: 0 - success, otherwise - failure
588dfdf5a53Sjeremylt 
5897a982d89SJeremy L. Thompson   @ref User
590b11c1e72Sjeremylt **/
5911d102b48SJeremy L Thompson int CeedQFunctionAddInput(CeedQFunction qf, const char *fieldname, CeedInt size,
5921d102b48SJeremy L Thompson                           CeedEvalMode emode) {
593fe2413ffSjeremylt   int ierr = CeedQFunctionFieldSet(&qf->inputfields[qf->numinputfields],
5944d537eeaSYohann                                    fieldname, size, emode);
595fe2413ffSjeremylt   CeedChk(ierr);
596fe2413ffSjeremylt   qf->numinputfields++;
597d7b241e6Sjeremylt   return 0;
598d7b241e6Sjeremylt }
599d7b241e6Sjeremylt 
600b11c1e72Sjeremylt /**
601a0a97fcfSJed Brown   @brief Add a CeedQFunction output
602b11c1e72Sjeremylt 
603b11c1e72Sjeremylt   @param qf         CeedQFunction
604b11c1e72Sjeremylt   @param fieldname  Name of QFunction field
6054cc79fe7SJed Brown   @param size       Size of QFunction field, (ncomp * dim) for @ref CEED_EVAL_GRAD or
6064cc79fe7SJed Brown                       (ncomp * 1) for @ref CEED_EVAL_NONE and @ref CEED_EVAL_INTERP
607b11c1e72Sjeremylt   @param emode      \ref CEED_EVAL_NONE to use values directly,
608b11c1e72Sjeremylt                       \ref CEED_EVAL_INTERP to use interpolated values,
609b11c1e72Sjeremylt                       \ref CEED_EVAL_GRAD to use gradients.
610b11c1e72Sjeremylt 
611b11c1e72Sjeremylt   @return An error code: 0 - success, otherwise - failure
612dfdf5a53Sjeremylt 
6137a982d89SJeremy L. Thompson   @ref User
614b11c1e72Sjeremylt **/
615d7b241e6Sjeremylt int CeedQFunctionAddOutput(CeedQFunction qf, const char *fieldname,
6164d537eeaSYohann                            CeedInt size, CeedEvalMode emode) {
617d7b241e6Sjeremylt   if (emode == CEED_EVAL_WEIGHT)
618c042f62fSJeremy L Thompson     // LCOV_EXCL_START
6191d102b48SJeremy L Thompson     return CeedError(qf->ceed, 1, "Cannot create QFunction output with "
6201d102b48SJeremy L Thompson                      "CEED_EVAL_WEIGHT");
621c042f62fSJeremy L Thompson   // LCOV_EXCL_STOP
622fe2413ffSjeremylt   int ierr = CeedQFunctionFieldSet(&qf->outputfields[qf->numoutputfields],
6234d537eeaSYohann                                    fieldname, size, emode);
624fe2413ffSjeremylt   CeedChk(ierr);
625fe2413ffSjeremylt   qf->numoutputfields++;
626d7b241e6Sjeremylt   return 0;
627d7b241e6Sjeremylt }
628d7b241e6Sjeremylt 
629dfdf5a53Sjeremylt /**
6304ce2993fSjeremylt   @brief Set global context for a CeedQFunction
631b11c1e72Sjeremylt 
632b11c1e72Sjeremylt   @param qf       CeedQFunction
633b11c1e72Sjeremylt   @param ctx      Context data to set
634b11c1e72Sjeremylt 
635b11c1e72Sjeremylt   @return An error code: 0 - success, otherwise - failure
636dfdf5a53Sjeremylt 
6377a982d89SJeremy L. Thompson   @ref User
638b11c1e72Sjeremylt **/
639777ff853SJeremy L Thompson int CeedQFunctionSetContext(CeedQFunction qf, CeedQFunctionContext ctx) {
640d7b241e6Sjeremylt   qf->ctx = ctx;
641777ff853SJeremy L Thompson   ctx->refcount++;
642d7b241e6Sjeremylt   return 0;
643d7b241e6Sjeremylt }
644d7b241e6Sjeremylt 
645b11c1e72Sjeremylt /**
64675affc3bSjeremylt   @brief View a CeedQFunction
64775affc3bSjeremylt 
64875affc3bSjeremylt   @param[in] qf      CeedQFunction to view
64975affc3bSjeremylt   @param[in] stream  Stream to write; typically stdout/stderr or a file
65075affc3bSjeremylt 
65175affc3bSjeremylt   @return Error code: 0 - success, otherwise - failure
65275affc3bSjeremylt 
6537a982d89SJeremy L. Thompson   @ref User
65475affc3bSjeremylt **/
65575affc3bSjeremylt int CeedQFunctionView(CeedQFunction qf, FILE *stream) {
65675affc3bSjeremylt   int ierr;
65775affc3bSjeremylt 
65875affc3bSjeremylt   fprintf(stream, "%sCeedQFunction %s\n",
65975affc3bSjeremylt           qf->qfname ? "Gallery " : "User ", qf->qfname ? qf->qfname : "");
66075affc3bSjeremylt 
6612da88da5Sjeremylt   fprintf(stream, "  %d Input Field%s:\n", qf->numinputfields,
66275affc3bSjeremylt           qf->numinputfields>1 ? "s" : "");
66375affc3bSjeremylt   for (CeedInt i=0; i<qf->numinputfields; i++) {
6642da88da5Sjeremylt     ierr = CeedQFunctionFieldView(qf->inputfields[i], i, 1, stream);
6652da88da5Sjeremylt     CeedChk(ierr);
66675affc3bSjeremylt   }
66775affc3bSjeremylt 
6682da88da5Sjeremylt   fprintf(stream, "  %d Output Field%s:\n", qf->numoutputfields,
66975affc3bSjeremylt           qf->numoutputfields>1 ? "s" : "");
67075affc3bSjeremylt   for (CeedInt i=0; i<qf->numoutputfields; i++) {
6712da88da5Sjeremylt     ierr = CeedQFunctionFieldView(qf->outputfields[i], i, 0, stream);
67275affc3bSjeremylt     CeedChk(ierr);
67375affc3bSjeremylt   }
67475affc3bSjeremylt   return 0;
67575affc3bSjeremylt }
67675affc3bSjeremylt 
67775affc3bSjeremylt /**
678b11c1e72Sjeremylt   @brief Apply the action of a CeedQFunction
679b11c1e72Sjeremylt 
680b11c1e72Sjeremylt   @param qf      CeedQFunction
681b11c1e72Sjeremylt   @param Q       Number of quadrature points
68234138859Sjeremylt   @param[in] u   Array of input CeedVectors
68334138859Sjeremylt   @param[out] v  Array of output CeedVectors
684b11c1e72Sjeremylt 
685b11c1e72Sjeremylt   @return An error code: 0 - success, otherwise - failure
686dfdf5a53Sjeremylt 
6877a982d89SJeremy L. Thompson   @ref User
688b11c1e72Sjeremylt **/
689d7b241e6Sjeremylt int CeedQFunctionApply(CeedQFunction qf, CeedInt Q,
690aedaa0e5Sjeremylt                        CeedVector *u, CeedVector *v) {
691d7b241e6Sjeremylt   int ierr;
692d7b241e6Sjeremylt   if (!qf->Apply)
693c042f62fSJeremy L Thompson     // LCOV_EXCL_START
694d7b241e6Sjeremylt     return CeedError(qf->ceed, 1, "Backend does not support QFunctionApply");
695c042f62fSJeremy L Thompson   // LCOV_EXCL_STOP
696d7b241e6Sjeremylt   if (Q % qf->vlength)
697c042f62fSJeremy L Thompson     // LCOV_EXCL_START
6981d102b48SJeremy L Thompson     return CeedError(qf->ceed, 2, "Number of quadrature points %d must be a "
6991d102b48SJeremy L Thompson                      "multiple of %d", Q, qf->vlength);
700c042f62fSJeremy L Thompson   // LCOV_EXCL_STOP
701d7b241e6Sjeremylt   ierr = qf->Apply(qf, Q, u, v); CeedChk(ierr);
702d7b241e6Sjeremylt   return 0;
703d7b241e6Sjeremylt }
704d7b241e6Sjeremylt 
705b11c1e72Sjeremylt /**
706b11c1e72Sjeremylt   @brief Destroy a CeedQFunction
707b11c1e72Sjeremylt 
708b11c1e72Sjeremylt   @param qf CeedQFunction to destroy
709b11c1e72Sjeremylt 
710b11c1e72Sjeremylt   @return An error code: 0 - success, otherwise - failure
711dfdf5a53Sjeremylt 
7127a982d89SJeremy L. Thompson   @ref User
713b11c1e72Sjeremylt **/
714d7b241e6Sjeremylt int CeedQFunctionDestroy(CeedQFunction *qf) {
715d7b241e6Sjeremylt   int ierr;
716d7b241e6Sjeremylt 
717752c3701SJeremy L Thompson   if (!*qf || --(*qf)->refcount > 0) return 0;
718fe2413ffSjeremylt   // Backend destroy
719d7b241e6Sjeremylt   if ((*qf)->Destroy) {
720d7b241e6Sjeremylt     ierr = (*qf)->Destroy(*qf); CeedChk(ierr);
721d7b241e6Sjeremylt   }
722fe2413ffSjeremylt   // Free fields
723fe2413ffSjeremylt   for (int i=0; i<(*qf)->numinputfields; i++) {
724fe2413ffSjeremylt     ierr = CeedFree(&(*(*qf)->inputfields[i]).fieldname); CeedChk(ierr);
725fe2413ffSjeremylt     ierr = CeedFree(&(*qf)->inputfields[i]); CeedChk(ierr);
726fe2413ffSjeremylt   }
727fe2413ffSjeremylt   for (int i=0; i<(*qf)->numoutputfields; i++) {
728fe2413ffSjeremylt     ierr = CeedFree(&(*(*qf)->outputfields[i]).fieldname); CeedChk(ierr);
729fe2413ffSjeremylt     ierr = CeedFree(&(*qf)->outputfields[i]); CeedChk(ierr);
730fe2413ffSjeremylt   }
731fe2413ffSjeremylt   ierr = CeedFree(&(*qf)->inputfields); CeedChk(ierr);
732fe2413ffSjeremylt   ierr = CeedFree(&(*qf)->outputfields); CeedChk(ierr);
733777ff853SJeremy L Thompson 
734777ff853SJeremy L Thompson   // User context data object
735777ff853SJeremy L Thompson   ierr = CeedQFunctionContextDestroy(&(*qf)->ctx); CeedChk(ierr);
736fe2413ffSjeremylt 
737288c0443SJeremy L Thompson   ierr = CeedFree(&(*qf)->sourcepath); CeedChk(ierr);
73875affc3bSjeremylt   ierr = CeedFree(&(*qf)->qfname); CeedChk(ierr);
739d7b241e6Sjeremylt   ierr = CeedDestroy(&(*qf)->ceed); CeedChk(ierr);
740d7b241e6Sjeremylt   ierr = CeedFree(qf); CeedChk(ierr);
741d7b241e6Sjeremylt   return 0;
742d7b241e6Sjeremylt }
743d7b241e6Sjeremylt 
744d7b241e6Sjeremylt /// @}
745