xref: /libCEED/rust/libceed-sys/c-src/interface/ceed-qfunction.c (revision e15f9bd09af0280c89b79924fa9af7dd2e3e30be)
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 
173d576824SJeremy L Thompson #include <ceed.h>
18d863ab9bSjeremylt #include <ceed-backend.h>
193d576824SJeremy L Thompson #include <ceed-impl.h>
20288c0443SJeremy L Thompson #include <limits.h>
213d576824SJeremy L Thompson #include <stdbool.h>
223d576824SJeremy L Thompson #include <stdio.h>
233d576824SJeremy 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
79*e15f9bd0SJeremy L Thompson     return CeedError(NULL, CEED_ERROR_MAJOR, "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++;
90*e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
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 
115*e15f9bd0SJeremy L Thompson   ierr = CeedCalloc(1, f); CeedChk(ierr);
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;
121*e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
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]);
145*e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
1467a982d89SJeremy L. Thompson }
1477a982d89SJeremy L. Thompson 
148777ff853SJeremy L Thompson 
149777ff853SJeremy L Thompson /**
150777ff853SJeremy L Thompson   @brief Set flag to determine if Fortran interface is used
151777ff853SJeremy L Thompson 
152777ff853SJeremy L Thompson   @param qf                  CeedQFunction
153777ff853SJeremy L Thompson   @param status              Boolean value to set as Fortran status
154777ff853SJeremy L Thompson 
155777ff853SJeremy L Thompson   @return An error code: 0 - success, otherwise - failure
156777ff853SJeremy L Thompson 
157777ff853SJeremy L Thompson   @ref Backend
158777ff853SJeremy L Thompson **/
159777ff853SJeremy L Thompson int CeedQFunctionSetFortranStatus(CeedQFunction qf, bool status) {
160777ff853SJeremy L Thompson   qf->fortranstatus = status;
161*e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
162777ff853SJeremy L Thompson }
163777ff853SJeremy L Thompson 
1647a982d89SJeremy L. Thompson /// @}
1657a982d89SJeremy L. Thompson 
1667a982d89SJeremy L. Thompson /// ----------------------------------------------------------------------------
1677a982d89SJeremy L. Thompson /// CeedQFunction Backend API
1687a982d89SJeremy L. Thompson /// ----------------------------------------------------------------------------
1697a982d89SJeremy L. Thompson /// @addtogroup CeedQFunctionBackend
1707a982d89SJeremy L. Thompson /// @{
1717a982d89SJeremy L. Thompson 
1727a982d89SJeremy L. Thompson /**
1737a982d89SJeremy L. Thompson   @brief Get the Ceed associated with a CeedQFunction
1747a982d89SJeremy L. Thompson 
1757a982d89SJeremy L. Thompson   @param qf              CeedQFunction
1767a982d89SJeremy L. Thompson   @param[out] ceed       Variable to store Ceed
1777a982d89SJeremy L. Thompson 
1787a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
1797a982d89SJeremy L. Thompson 
1807a982d89SJeremy L. Thompson   @ref Backend
1817a982d89SJeremy L. Thompson **/
1827a982d89SJeremy L. Thompson int CeedQFunctionGetCeed(CeedQFunction qf, Ceed *ceed) {
1837a982d89SJeremy L. Thompson   *ceed = qf->ceed;
184*e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
1857a982d89SJeremy L. Thompson }
1867a982d89SJeremy L. Thompson 
1877a982d89SJeremy L. Thompson /**
1887a982d89SJeremy L. Thompson   @brief Get the vector length of a CeedQFunction
1897a982d89SJeremy L. Thompson 
1907a982d89SJeremy L. Thompson   @param qf            CeedQFunction
1917a982d89SJeremy L. Thompson   @param[out] vlength  Variable to store vector length
1927a982d89SJeremy L. Thompson 
1937a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
1947a982d89SJeremy L. Thompson 
1957a982d89SJeremy L. Thompson   @ref Backend
1967a982d89SJeremy L. Thompson **/
1977a982d89SJeremy L. Thompson int CeedQFunctionGetVectorLength(CeedQFunction qf, CeedInt *vlength) {
1987a982d89SJeremy L. Thompson   *vlength = qf->vlength;
199*e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
2007a982d89SJeremy L. Thompson }
2017a982d89SJeremy L. Thompson 
2027a982d89SJeremy L. Thompson /**
2037a982d89SJeremy L. Thompson   @brief Get the number of inputs and outputs to a CeedQFunction
2047a982d89SJeremy L. Thompson 
2057a982d89SJeremy L. Thompson   @param qf              CeedQFunction
2067a982d89SJeremy L. Thompson   @param[out] numinput   Variable to store number of input fields
2077a982d89SJeremy L. Thompson   @param[out] numoutput  Variable to store number of output fields
2087a982d89SJeremy L. Thompson 
2097a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
2107a982d89SJeremy L. Thompson 
2117a982d89SJeremy L. Thompson   @ref Backend
2127a982d89SJeremy L. Thompson **/
2137a982d89SJeremy L. Thompson int CeedQFunctionGetNumArgs(CeedQFunction qf, CeedInt *numinput,
2147a982d89SJeremy L. Thompson                             CeedInt *numoutput) {
2157a982d89SJeremy L. Thompson   if (numinput) *numinput = qf->numinputfields;
2167a982d89SJeremy L. Thompson   if (numoutput) *numoutput = qf->numoutputfields;
217*e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
2187a982d89SJeremy L. Thompson }
2197a982d89SJeremy L. Thompson 
2207a982d89SJeremy L. Thompson /**
2217a982d89SJeremy L. Thompson   @brief Get the source path string for a CeedQFunction
2227a982d89SJeremy L. Thompson 
2237a982d89SJeremy L. Thompson   @param qf              CeedQFunction
2247a982d89SJeremy L. Thompson   @param[out] source     Variable to store source path string
2257a982d89SJeremy L. Thompson 
2267a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
2277a982d89SJeremy L. Thompson 
2287a982d89SJeremy L. Thompson   @ref Backend
2297a982d89SJeremy L. Thompson **/
2307a982d89SJeremy L. Thompson int CeedQFunctionGetSourcePath(CeedQFunction qf, char **source) {
2317a982d89SJeremy L. Thompson   *source = (char *) qf->sourcepath;
232*e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
2337a982d89SJeremy L. Thompson }
2347a982d89SJeremy L. Thompson 
2357a982d89SJeremy L. Thompson /**
2367a982d89SJeremy L. Thompson   @brief Get the User Function for a CeedQFunction
2377a982d89SJeremy L. Thompson 
2387a982d89SJeremy L. Thompson   @param qf              CeedQFunction
2397a982d89SJeremy L. Thompson   @param[out] f          Variable to store user function
2407a982d89SJeremy L. Thompson 
2417a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
2427a982d89SJeremy L. Thompson 
2437a982d89SJeremy L. Thompson   @ref Backend
2447a982d89SJeremy L. Thompson **/
2457a982d89SJeremy L. Thompson int CeedQFunctionGetUserFunction(CeedQFunction qf, CeedQFunctionUser *f) {
2467a982d89SJeremy L. Thompson   *f = qf->function;
247*e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
2487a982d89SJeremy L. Thompson }
2497a982d89SJeremy L. Thompson 
2507a982d89SJeremy L. Thompson /**
251777ff853SJeremy L Thompson   @brief Get global context for a CeedQFunction.
252777ff853SJeremy L Thompson          Note: For QFunctions from the Fortran interface, this
253777ff853SJeremy L Thompson                function will return the Fortran context
254777ff853SJeremy L Thompson                CeedQFunctionContext.
2557a982d89SJeremy L. Thompson 
2567a982d89SJeremy L. Thompson   @param qf              CeedQFunction
257777ff853SJeremy L Thompson   @param[out] ctx        Variable to store CeedQFunctionContext
2587a982d89SJeremy L. Thompson 
2597a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
2607a982d89SJeremy L. Thompson 
2617a982d89SJeremy L. Thompson   @ref Backend
2627a982d89SJeremy L. Thompson **/
263777ff853SJeremy L Thompson int CeedQFunctionGetContext(CeedQFunction qf, CeedQFunctionContext *ctx) {
2647a982d89SJeremy L. Thompson   *ctx = qf->ctx;
265*e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
2667a982d89SJeremy L. Thompson }
2677a982d89SJeremy L. Thompson 
2687a982d89SJeremy L. Thompson /**
2697a982d89SJeremy L. Thompson   @brief Get true user context for a CeedQFunction
270777ff853SJeremy L Thompson          Note: For all QFunctions this function will return the user
271777ff853SJeremy L Thompson                CeedQFunctionContext and not interface context
272777ff853SJeremy L Thompson                CeedQFunctionContext, if any such object exists.
2737a982d89SJeremy L. Thompson 
2747a982d89SJeremy L. Thompson   @param qf              CeedQFunction
275777ff853SJeremy L Thompson   @param[out] ctx        Variable to store CeedQFunctionContext
2767a982d89SJeremy L. Thompson 
2777a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
2787a982d89SJeremy L. Thompson   @ref Backend
2797a982d89SJeremy L. Thompson **/
280777ff853SJeremy L Thompson int CeedQFunctionGetInnerContext(CeedQFunction qf, CeedQFunctionContext *ctx) {
281777ff853SJeremy L Thompson   int ierr;
2827a982d89SJeremy L. Thompson   if (qf->fortranstatus) {
283777ff853SJeremy L Thompson     CeedFortranContext fctx = NULL;
284777ff853SJeremy L Thompson     ierr = CeedQFunctionContextGetData(qf->ctx, CEED_MEM_HOST, &fctx);
285777ff853SJeremy L Thompson     CeedChk(ierr);
2867a982d89SJeremy L. Thompson     *ctx = fctx->innerctx;
287777ff853SJeremy L Thompson     ierr = CeedQFunctionContextRestoreData(qf->ctx, (void *)&fctx); CeedChk(ierr);
2887a982d89SJeremy L. Thompson   } else {
2897a982d89SJeremy L. Thompson     *ctx = qf->ctx;
2907a982d89SJeremy L. Thompson   }
291*e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
2927a982d89SJeremy L. Thompson }
2937a982d89SJeremy L. Thompson 
2947a982d89SJeremy L. Thompson /**
2957a982d89SJeremy L. Thompson   @brief Determine if QFunction is identity
2967a982d89SJeremy L. Thompson 
2977a982d89SJeremy L. Thompson   @param qf               CeedQFunction
298fd364f38SJeremy L Thompson   @param[out] isidentity  Variable to store identity status
2997a982d89SJeremy L. Thompson 
3007a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
3017a982d89SJeremy L. Thompson 
3027a982d89SJeremy L. Thompson   @ref Backend
3037a982d89SJeremy L. Thompson **/
304fd364f38SJeremy L Thompson int CeedQFunctionIsIdentity(CeedQFunction qf, bool *isidentity) {
305fd364f38SJeremy L Thompson   *isidentity = qf->identity;
306*e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
3077a982d89SJeremy L. Thompson }
3087a982d89SJeremy L. Thompson 
3097a982d89SJeremy L. Thompson /**
3107a982d89SJeremy L. Thompson   @brief Get backend data of a CeedQFunction
3117a982d89SJeremy L. Thompson 
3127a982d89SJeremy L. Thompson   @param qf              CeedQFunction
3137a982d89SJeremy L. Thompson   @param[out] data       Variable to store data
3147a982d89SJeremy L. Thompson 
3157a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
3167a982d89SJeremy L. Thompson 
3177a982d89SJeremy L. Thompson   @ref Backend
3187a982d89SJeremy L. Thompson **/
319777ff853SJeremy L Thompson int CeedQFunctionGetData(CeedQFunction qf, void *data) {
320777ff853SJeremy L Thompson   *(void **)data = qf->data;
321*e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
3227a982d89SJeremy L. Thompson }
3237a982d89SJeremy L. Thompson 
3247a982d89SJeremy L. Thompson /**
3257a982d89SJeremy L. Thompson   @brief Set backend data of a CeedQFunction
3267a982d89SJeremy L. Thompson 
3277a982d89SJeremy L. Thompson   @param[out] qf         CeedQFunction
3287a982d89SJeremy L. Thompson   @param data            Data to set
3297a982d89SJeremy L. Thompson 
3307a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
3317a982d89SJeremy L. Thompson 
3327a982d89SJeremy L. Thompson   @ref Backend
3337a982d89SJeremy L. Thompson **/
334777ff853SJeremy L Thompson int CeedQFunctionSetData(CeedQFunction qf, void *data) {
335777ff853SJeremy L Thompson   qf->data = data;
336*e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
3377a982d89SJeremy L. Thompson }
3387a982d89SJeremy L. Thompson 
3397a982d89SJeremy L. Thompson /**
3407a982d89SJeremy L. Thompson   @brief Get the CeedQFunctionFields of a CeedQFunction
3417a982d89SJeremy L. Thompson 
3427a982d89SJeremy L. Thompson   @param qf                 CeedQFunction
3437a982d89SJeremy L. Thompson   @param[out] inputfields   Variable to store inputfields
3447a982d89SJeremy L. Thompson   @param[out] outputfields  Variable to store outputfields
3457a982d89SJeremy L. Thompson 
3467a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
3477a982d89SJeremy L. Thompson 
3487a982d89SJeremy L. Thompson   @ref Backend
3497a982d89SJeremy L. Thompson **/
3507a982d89SJeremy L. Thompson int CeedQFunctionGetFields(CeedQFunction qf, CeedQFunctionField **inputfields,
3517a982d89SJeremy L. Thompson                            CeedQFunctionField **outputfields) {
352*e15f9bd0SJeremy L Thompson   if (inputfields) *inputfields = qf->inputfields;
353*e15f9bd0SJeremy L Thompson   if (outputfields) *outputfields = qf->outputfields;
354*e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
3557a982d89SJeremy L. Thompson }
3567a982d89SJeremy L. Thompson 
3577a982d89SJeremy L. Thompson /**
3587a982d89SJeremy L. Thompson   @brief Get the name of a CeedQFunctionField
3597a982d89SJeremy L. Thompson 
3607a982d89SJeremy L. Thompson   @param qffield         CeedQFunctionField
3617a982d89SJeremy L. Thompson   @param[out] fieldname  Variable to store the field name
3627a982d89SJeremy L. Thompson 
3637a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
3647a982d89SJeremy L. Thompson 
3657a982d89SJeremy L. Thompson   @ref Backend
3667a982d89SJeremy L. Thompson **/
3677a982d89SJeremy L. Thompson int CeedQFunctionFieldGetName(CeedQFunctionField qffield, char **fieldname) {
3687a982d89SJeremy L. Thompson   *fieldname = (char *)qffield->fieldname;
369*e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
3707a982d89SJeremy L. Thompson }
3717a982d89SJeremy L. Thompson 
3727a982d89SJeremy L. Thompson /**
3737a982d89SJeremy L. Thompson   @brief Get the number of components of a CeedQFunctionField
3747a982d89SJeremy L. Thompson 
3757a982d89SJeremy L. Thompson   @param qffield    CeedQFunctionField
3767a982d89SJeremy L. Thompson   @param[out] size  Variable to store the size of the field
3777a982d89SJeremy L. Thompson 
3787a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
3797a982d89SJeremy L. Thompson 
3807a982d89SJeremy L. Thompson   @ref Backend
3817a982d89SJeremy L. Thompson **/
3827a982d89SJeremy L. Thompson int CeedQFunctionFieldGetSize(CeedQFunctionField qffield, CeedInt *size) {
3837a982d89SJeremy L. Thompson   *size = qffield->size;
384*e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
3857a982d89SJeremy L. Thompson }
3867a982d89SJeremy L. Thompson 
3877a982d89SJeremy L. Thompson /**
3887a982d89SJeremy L. Thompson   @brief Get the CeedEvalMode of a CeedQFunctionField
3897a982d89SJeremy L. Thompson 
3907a982d89SJeremy L. Thompson   @param qffield         CeedQFunctionField
3917a982d89SJeremy L. Thompson   @param[out] emode      Variable to store the field evaluation mode
3927a982d89SJeremy L. Thompson 
3937a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
3947a982d89SJeremy L. Thompson 
3957a982d89SJeremy L. Thompson   @ref Backend
3967a982d89SJeremy L. Thompson **/
3977a982d89SJeremy L. Thompson int CeedQFunctionFieldGetEvalMode(CeedQFunctionField qffield,
3987a982d89SJeremy L. Thompson                                   CeedEvalMode *emode) {
3997a982d89SJeremy L. Thompson   *emode = qffield->emode;
400*e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
4017a982d89SJeremy L. Thompson }
4027a982d89SJeremy L. Thompson 
4037a982d89SJeremy L. Thompson /// @}
4047a982d89SJeremy L. Thompson 
4057a982d89SJeremy L. Thompson /// ----------------------------------------------------------------------------
4067a982d89SJeremy L. Thompson /// CeedQFunction Public API
4077a982d89SJeremy L. Thompson /// ----------------------------------------------------------------------------
4087a982d89SJeremy L. Thompson /// @addtogroup CeedQFunctionUser
4097a982d89SJeremy L. Thompson /// @{
4107a982d89SJeremy L. Thompson 
4117a982d89SJeremy L. Thompson /**
4127a982d89SJeremy L. Thompson   @brief Create a CeedQFunction for evaluating interior (volumetric) terms.
4137a982d89SJeremy L. Thompson 
4147a982d89SJeremy L. Thompson   @param ceed       A Ceed object where the CeedQFunction will be created
4157a982d89SJeremy L. Thompson   @param vlength    Vector length. Caller must ensure that number of quadrature
4167a982d89SJeremy L. Thompson                       points is a multiple of vlength.
4177a982d89SJeremy L. Thompson   @param f          Function pointer to evaluate action at quadrature points.
4187a982d89SJeremy L. Thompson                       See \ref CeedQFunctionUser.
4197a982d89SJeremy L. Thompson   @param source     Absolute path to source of QFunction,
420c8d5b03cSJeremy L Thompson                       "\abs_path\file.h:function_name".
421c8d5b03cSJeremy L Thompson                       For support across all backends, this source must only
422c8d5b03cSJeremy L Thompson                       contain constructs supported by C99, C++11, and CUDA.
4237a982d89SJeremy L. Thompson   @param[out] qf    Address of the variable where the newly created
4247a982d89SJeremy L. Thompson                       CeedQFunction will be stored
4257a982d89SJeremy L. Thompson 
4267a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
4277a982d89SJeremy L. Thompson 
4287a982d89SJeremy L. Thompson   See \ref CeedQFunctionUser for details on the call-back function @a f's
4297a982d89SJeremy L. Thompson     arguments.
4307a982d89SJeremy L. Thompson 
4317a982d89SJeremy L. Thompson   @ref User
4327a982d89SJeremy L. Thompson **/
4337a982d89SJeremy L. Thompson int CeedQFunctionCreateInterior(Ceed ceed, CeedInt vlength, CeedQFunctionUser f,
4347a982d89SJeremy L. Thompson                                 const char *source, CeedQFunction *qf) {
4357a982d89SJeremy L. Thompson   int ierr;
4367a982d89SJeremy L. Thompson   char *source_copy;
4377a982d89SJeremy L. Thompson 
4387a982d89SJeremy L. Thompson   if (!ceed->QFunctionCreate) {
4397a982d89SJeremy L. Thompson     Ceed delegate;
4407a982d89SJeremy L. Thompson     ierr = CeedGetObjectDelegate(ceed, &delegate, "QFunction"); CeedChk(ierr);
4417a982d89SJeremy L. Thompson 
4427a982d89SJeremy L. Thompson     if (!delegate)
4437a982d89SJeremy L. Thompson       // LCOV_EXCL_START
444*e15f9bd0SJeremy L Thompson       return CeedError(ceed, CEED_ERROR_UNSUPPORTED,
445*e15f9bd0SJeremy L Thompson                        "Backend does not support QFunctionCreate");
4467a982d89SJeremy L. Thompson     // LCOV_EXCL_STOP
4477a982d89SJeremy L. Thompson 
4487a982d89SJeremy L. Thompson     ierr = CeedQFunctionCreateInterior(delegate, vlength, f, source, qf);
4497a982d89SJeremy L. Thompson     CeedChk(ierr);
450*e15f9bd0SJeremy L Thompson     return CEED_ERROR_SUCCESS;
4517a982d89SJeremy L. Thompson   }
4527a982d89SJeremy L. Thompson 
4537a982d89SJeremy L. Thompson   ierr = CeedCalloc(1, qf); CeedChk(ierr);
4547a982d89SJeremy L. Thompson   (*qf)->ceed = ceed;
4557a982d89SJeremy L. Thompson   ceed->refcount++;
4567a982d89SJeremy L. Thompson   (*qf)->refcount = 1;
4577a982d89SJeremy L. Thompson   (*qf)->vlength = vlength;
4587a982d89SJeremy L. Thompson   (*qf)->identity = 0;
4597a982d89SJeremy L. Thompson   (*qf)->function = f;
4607a982d89SJeremy L. Thompson   size_t slen = strlen(source) + 1;
4617a982d89SJeremy L. Thompson   ierr = CeedMalloc(slen, &source_copy); CeedChk(ierr);
4627a982d89SJeremy L. Thompson   memcpy(source_copy, source, slen);
4637a982d89SJeremy L. Thompson   (*qf)->sourcepath = source_copy;
4647a982d89SJeremy L. Thompson   ierr = CeedCalloc(16, &(*qf)->inputfields); CeedChk(ierr);
4657a982d89SJeremy L. Thompson   ierr = CeedCalloc(16, &(*qf)->outputfields); CeedChk(ierr);
4667a982d89SJeremy L. Thompson   ierr = ceed->QFunctionCreate(*qf); CeedChk(ierr);
467*e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
4687a982d89SJeremy L. Thompson }
4697a982d89SJeremy L. Thompson 
4707a982d89SJeremy L. Thompson /**
471288c0443SJeremy L Thompson   @brief Create a CeedQFunction for evaluating interior (volumetric) terms by name.
472288c0443SJeremy L Thompson 
473288c0443SJeremy L Thompson   @param ceed       A Ceed object where the CeedQFunction will be created
474288c0443SJeremy L Thompson   @param name       Name of QFunction to use from gallery
475288c0443SJeremy L Thompson   @param[out] qf    Address of the variable where the newly created
476288c0443SJeremy L Thompson                       CeedQFunction will be stored
477288c0443SJeremy L Thompson 
478288c0443SJeremy L Thompson   @return An error code: 0 - success, otherwise - failure
479288c0443SJeremy L Thompson 
4807a982d89SJeremy L. Thompson   @ref User
481288c0443SJeremy L Thompson **/
482288c0443SJeremy L Thompson int CeedQFunctionCreateInteriorByName(Ceed ceed,  const char *name,
483288c0443SJeremy L Thompson                                       CeedQFunction *qf) {
484288c0443SJeremy L Thompson   int ierr;
485288c0443SJeremy L Thompson   size_t matchlen = 0, matchidx = UINT_MAX;
48675affc3bSjeremylt   char *name_copy;
487288c0443SJeremy L Thompson 
4881d013790SJed Brown   ierr = CeedQFunctionRegisterAll(); CeedChk(ierr);
489288c0443SJeremy L Thompson   // Find matching backend
490*e15f9bd0SJeremy L Thompson   if (!name) return CeedError(ceed, CEED_ERROR_INCOMPLETE,
491*e15f9bd0SJeremy L Thompson                                 "No QFunction name provided");
492288c0443SJeremy L Thompson   for (size_t i=0; i<num_qfunctions; i++) {
493288c0443SJeremy L Thompson     size_t n;
494288c0443SJeremy L Thompson     const char *currname = qfunctions[i].name;
495288c0443SJeremy L Thompson     for (n = 0; currname[n] && currname[n] == name[n]; n++) {}
496288c0443SJeremy L Thompson     if (n > matchlen) {
497288c0443SJeremy L Thompson       matchlen = n;
498288c0443SJeremy L Thompson       matchidx = i;
499288c0443SJeremy L Thompson     }
500288c0443SJeremy L Thompson   }
5011d102b48SJeremy L Thompson   if (!matchlen)
502138d4072Sjeremylt     // LCOV_EXCL_START
503*e15f9bd0SJeremy L Thompson     return CeedError(ceed, CEED_ERROR_UNSUPPORTED, "No suitable gallery QFunction");
504138d4072Sjeremylt   // LCOV_EXCL_STOP
505288c0443SJeremy L Thompson 
506288c0443SJeremy L Thompson   // Create QFunction
507288c0443SJeremy L Thompson   ierr = CeedQFunctionCreateInterior(ceed, qfunctions[matchidx].vlength,
508288c0443SJeremy L Thompson                                      qfunctions[matchidx].f,
509288c0443SJeremy L Thompson                                      qfunctions[matchidx].source, qf);
510288c0443SJeremy L Thompson   CeedChk(ierr);
511288c0443SJeremy L Thompson 
512288c0443SJeremy L Thompson   // QFunction specific setup
513288c0443SJeremy L Thompson   ierr = qfunctions[matchidx].init(ceed, name, *qf); CeedChk(ierr);
514288c0443SJeremy L Thompson 
51575affc3bSjeremylt   // Copy name
51675affc3bSjeremylt   size_t slen = strlen(name) + 1;
51775affc3bSjeremylt   ierr = CeedMalloc(slen, &name_copy); CeedChk(ierr);
51875affc3bSjeremylt   memcpy(name_copy, name, slen);
51975affc3bSjeremylt   (*qf)->qfname = name_copy;
520*e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
521288c0443SJeremy L Thompson }
522288c0443SJeremy L Thompson 
523288c0443SJeremy L Thompson /**
5240219ea01SJeremy L Thompson   @brief Create an identity CeedQFunction. Inputs are written into outputs in
5250219ea01SJeremy L Thompson            the order given. This is useful for CeedOperators that can be
5260219ea01SJeremy L Thompson            represented with only the action of a CeedRestriction and CeedBasis,
5270219ea01SJeremy L Thompson            such as restriction and prolongation operators for p-multigrid.
5280219ea01SJeremy L Thompson            Backends may optimize CeedOperators with this CeedQFunction to avoid
5290219ea01SJeremy L Thompson            the copy of input data to output fields by using the same memory
5300219ea01SJeremy L Thompson            location for both.
5310219ea01SJeremy L Thompson 
5320219ea01SJeremy L Thompson   @param ceed         A Ceed object where the CeedQFunction will be created
53360f77c51Sjeremylt   @param[in] size     Size of the qfunction fields
53460f77c51Sjeremylt   @param[in] inmode   CeedEvalMode for input to CeedQFunction
53560f77c51Sjeremylt   @param[in] outmode  CeedEvalMode for output to CeedQFunction
5360219ea01SJeremy L Thompson   @param[out] qf      Address of the variable where the newly created
5370219ea01SJeremy L Thompson                         CeedQFunction will be stored
5380219ea01SJeremy L Thompson 
5390219ea01SJeremy L Thompson   @return An error code: 0 - success, otherwise - failure
5400219ea01SJeremy L Thompson 
5417a982d89SJeremy L. Thompson   @ref User
5420219ea01SJeremy L Thompson **/
54360f77c51Sjeremylt int CeedQFunctionCreateIdentity(Ceed ceed, CeedInt size, CeedEvalMode inmode,
54460f77c51Sjeremylt                                 CeedEvalMode outmode, CeedQFunction *qf) {
5450219ea01SJeremy L Thompson   int ierr;
5460219ea01SJeremy L Thompson 
54760f77c51Sjeremylt   if (inmode == CEED_EVAL_NONE && outmode == CEED_EVAL_NONE)
54860f77c51Sjeremylt     // LCOV_EXCL_START
549*e15f9bd0SJeremy L Thompson     return CeedError(ceed, CEED_ERROR_UNSUPPORTED,
550*e15f9bd0SJeremy L Thompson                      "CEED_EVAL_NONE for a both the input and "
55160f77c51Sjeremylt                      "output does not make sense with an identity QFunction");
55260f77c51Sjeremylt   // LCOV_EXCL_STOP
55360f77c51Sjeremylt 
5540219ea01SJeremy L Thompson   ierr = CeedQFunctionCreateInteriorByName(ceed, "Identity", qf); CeedChk(ierr);
5551dfeea39SJeremy L Thompson   ierr = CeedQFunctionAddInput(*qf, "input", size, inmode); CeedChk(ierr);
5561dfeea39SJeremy L Thompson   ierr = CeedQFunctionAddOutput(*qf, "output", size, outmode); CeedChk(ierr);
5570219ea01SJeremy L Thompson 
5580219ea01SJeremy L Thompson   (*qf)->identity = 1;
559777ff853SJeremy L Thompson   CeedInt *sizeData;
560777ff853SJeremy L Thompson   ierr = CeedCalloc(1, &sizeData); CeedChk(ierr);
561777ff853SJeremy L Thompson   sizeData[0] = size;
562777ff853SJeremy L Thompson   CeedQFunctionContext ctx;
563777ff853SJeremy L Thompson   ierr = CeedQFunctionContextCreate(ceed, &ctx); CeedChk(ierr);
564777ff853SJeremy L Thompson   ierr = CeedQFunctionContextSetData(ctx, CEED_MEM_HOST, CEED_OWN_POINTER,
565777ff853SJeremy L Thompson                                      sizeof(*sizeData), (void *)sizeData);
566777ff853SJeremy L Thompson   CeedChk(ierr);
567777ff853SJeremy L Thompson   ierr = CeedQFunctionSetContext(*qf, ctx); CeedChk(ierr);
568777ff853SJeremy L Thompson   ierr = CeedQFunctionContextDestroy(&ctx); CeedChk(ierr);
569*e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
5700219ea01SJeremy L Thompson }
5710219ea01SJeremy L Thompson 
5720219ea01SJeremy L Thompson /**
573a0a97fcfSJed Brown   @brief Add a CeedQFunction input
574b11c1e72Sjeremylt 
575b11c1e72Sjeremylt   @param qf         CeedQFunction
576b11c1e72Sjeremylt   @param fieldname  Name of QFunction field
5774cc79fe7SJed Brown   @param size       Size of QFunction field, (ncomp * dim) for @ref CEED_EVAL_GRAD or
5784cc79fe7SJed Brown                       (ncomp * 1) for @ref CEED_EVAL_NONE and @ref CEED_EVAL_INTERP
579b11c1e72Sjeremylt   @param emode      \ref CEED_EVAL_NONE to use values directly,
580b11c1e72Sjeremylt                       \ref CEED_EVAL_INTERP to use interpolated values,
581b11c1e72Sjeremylt                       \ref CEED_EVAL_GRAD to use gradients.
582b11c1e72Sjeremylt 
583b11c1e72Sjeremylt   @return An error code: 0 - success, otherwise - failure
584dfdf5a53Sjeremylt 
5857a982d89SJeremy L. Thompson   @ref User
586b11c1e72Sjeremylt **/
5871d102b48SJeremy L Thompson int CeedQFunctionAddInput(CeedQFunction qf, const char *fieldname, CeedInt size,
5881d102b48SJeremy L Thompson                           CeedEvalMode emode) {
589*e15f9bd0SJeremy L Thompson   if (qf->operatorsset)
590*e15f9bd0SJeremy L Thompson     // LCOV_EXCL_START
591*e15f9bd0SJeremy L Thompson     return CeedError(qf->ceed, CEED_ERROR_MAJOR,
592*e15f9bd0SJeremy L Thompson                      "QFunction cannot be changed when in use by an operator");
593*e15f9bd0SJeremy L Thompson   // LCOV_EXCL_STOP
594*e15f9bd0SJeremy L Thompson   if ((emode == CEED_EVAL_WEIGHT) && (size != 1))
595*e15f9bd0SJeremy L Thompson     // LCOV_EXCL_START
596*e15f9bd0SJeremy L Thompson     return CeedError(qf->ceed, CEED_ERROR_DIMENSION,
597*e15f9bd0SJeremy L Thompson                      "CEED_EVAL_WEIGHT should have size 1");
598*e15f9bd0SJeremy L Thompson   // LCOV_EXCL_STOP
599fe2413ffSjeremylt   int ierr = CeedQFunctionFieldSet(&qf->inputfields[qf->numinputfields],
6004d537eeaSYohann                                    fieldname, size, emode);
601fe2413ffSjeremylt   CeedChk(ierr);
602fe2413ffSjeremylt   qf->numinputfields++;
603*e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
604d7b241e6Sjeremylt }
605d7b241e6Sjeremylt 
606b11c1e72Sjeremylt /**
607a0a97fcfSJed Brown   @brief Add a CeedQFunction output
608b11c1e72Sjeremylt 
609b11c1e72Sjeremylt   @param qf         CeedQFunction
610b11c1e72Sjeremylt   @param fieldname  Name of QFunction field
6114cc79fe7SJed Brown   @param size       Size of QFunction field, (ncomp * dim) for @ref CEED_EVAL_GRAD or
6124cc79fe7SJed Brown                       (ncomp * 1) for @ref CEED_EVAL_NONE and @ref CEED_EVAL_INTERP
613b11c1e72Sjeremylt   @param emode      \ref CEED_EVAL_NONE to use values directly,
614b11c1e72Sjeremylt                       \ref CEED_EVAL_INTERP to use interpolated values,
615b11c1e72Sjeremylt                       \ref CEED_EVAL_GRAD to use gradients.
616b11c1e72Sjeremylt 
617b11c1e72Sjeremylt   @return An error code: 0 - success, otherwise - failure
618dfdf5a53Sjeremylt 
6197a982d89SJeremy L. Thompson   @ref User
620b11c1e72Sjeremylt **/
621d7b241e6Sjeremylt int CeedQFunctionAddOutput(CeedQFunction qf, const char *fieldname,
6224d537eeaSYohann                            CeedInt size, CeedEvalMode emode) {
623*e15f9bd0SJeremy L Thompson   if (qf->operatorsset)
624*e15f9bd0SJeremy L Thompson     // LCOV_EXCL_START
625*e15f9bd0SJeremy L Thompson     return CeedError(qf->ceed, CEED_ERROR_MAJOR,
626*e15f9bd0SJeremy L Thompson                      "QFunction cannot be changed when in use by an operator");
627*e15f9bd0SJeremy L Thompson   // LCOV_EXCL_STOP
628d7b241e6Sjeremylt   if (emode == CEED_EVAL_WEIGHT)
629c042f62fSJeremy L Thompson     // LCOV_EXCL_START
630*e15f9bd0SJeremy L Thompson     return CeedError(qf->ceed, CEED_ERROR_DIMENSION,
631*e15f9bd0SJeremy L Thompson                      "Cannot create QFunction output with "
6321d102b48SJeremy L Thompson                      "CEED_EVAL_WEIGHT");
633c042f62fSJeremy L Thompson   // LCOV_EXCL_STOP
634fe2413ffSjeremylt   int ierr = CeedQFunctionFieldSet(&qf->outputfields[qf->numoutputfields],
6354d537eeaSYohann                                    fieldname, size, emode);
636fe2413ffSjeremylt   CeedChk(ierr);
637fe2413ffSjeremylt   qf->numoutputfields++;
638*e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
639d7b241e6Sjeremylt }
640d7b241e6Sjeremylt 
641dfdf5a53Sjeremylt /**
6424ce2993fSjeremylt   @brief Set global context for a CeedQFunction
643b11c1e72Sjeremylt 
644b11c1e72Sjeremylt   @param qf       CeedQFunction
645b11c1e72Sjeremylt   @param ctx      Context data to set
646b11c1e72Sjeremylt 
647b11c1e72Sjeremylt   @return An error code: 0 - success, otherwise - failure
648dfdf5a53Sjeremylt 
6497a982d89SJeremy L. Thompson   @ref User
650b11c1e72Sjeremylt **/
651777ff853SJeremy L Thompson int CeedQFunctionSetContext(CeedQFunction qf, CeedQFunctionContext ctx) {
652d7b241e6Sjeremylt   qf->ctx = ctx;
653777ff853SJeremy L Thompson   ctx->refcount++;
654*e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
655d7b241e6Sjeremylt }
656d7b241e6Sjeremylt 
657b11c1e72Sjeremylt /**
65875affc3bSjeremylt   @brief View a CeedQFunction
65975affc3bSjeremylt 
66075affc3bSjeremylt   @param[in] qf      CeedQFunction to view
66175affc3bSjeremylt   @param[in] stream  Stream to write; typically stdout/stderr or a file
66275affc3bSjeremylt 
66375affc3bSjeremylt   @return Error code: 0 - success, otherwise - failure
66475affc3bSjeremylt 
6657a982d89SJeremy L. Thompson   @ref User
66675affc3bSjeremylt **/
66775affc3bSjeremylt int CeedQFunctionView(CeedQFunction qf, FILE *stream) {
66875affc3bSjeremylt   int ierr;
66975affc3bSjeremylt 
67075affc3bSjeremylt   fprintf(stream, "%sCeedQFunction %s\n",
67175affc3bSjeremylt           qf->qfname ? "Gallery " : "User ", qf->qfname ? qf->qfname : "");
67275affc3bSjeremylt 
6732da88da5Sjeremylt   fprintf(stream, "  %d Input Field%s:\n", qf->numinputfields,
67475affc3bSjeremylt           qf->numinputfields>1 ? "s" : "");
67575affc3bSjeremylt   for (CeedInt i=0; i<qf->numinputfields; i++) {
6762da88da5Sjeremylt     ierr = CeedQFunctionFieldView(qf->inputfields[i], i, 1, stream);
6772da88da5Sjeremylt     CeedChk(ierr);
67875affc3bSjeremylt   }
67975affc3bSjeremylt 
6802da88da5Sjeremylt   fprintf(stream, "  %d Output Field%s:\n", qf->numoutputfields,
68175affc3bSjeremylt           qf->numoutputfields>1 ? "s" : "");
68275affc3bSjeremylt   for (CeedInt i=0; i<qf->numoutputfields; i++) {
6832da88da5Sjeremylt     ierr = CeedQFunctionFieldView(qf->outputfields[i], i, 0, stream);
68475affc3bSjeremylt     CeedChk(ierr);
68575affc3bSjeremylt   }
686*e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
68775affc3bSjeremylt }
68875affc3bSjeremylt 
68975affc3bSjeremylt /**
690b11c1e72Sjeremylt   @brief Apply the action of a CeedQFunction
691b11c1e72Sjeremylt 
692b11c1e72Sjeremylt   @param qf      CeedQFunction
693b11c1e72Sjeremylt   @param Q       Number of quadrature points
69434138859Sjeremylt   @param[in] u   Array of input CeedVectors
69534138859Sjeremylt   @param[out] v  Array of output CeedVectors
696b11c1e72Sjeremylt 
697b11c1e72Sjeremylt   @return An error code: 0 - success, otherwise - failure
698dfdf5a53Sjeremylt 
6997a982d89SJeremy L. Thompson   @ref User
700b11c1e72Sjeremylt **/
701d7b241e6Sjeremylt int CeedQFunctionApply(CeedQFunction qf, CeedInt Q,
702aedaa0e5Sjeremylt                        CeedVector *u, CeedVector *v) {
703d7b241e6Sjeremylt   int ierr;
704d7b241e6Sjeremylt   if (!qf->Apply)
705c042f62fSJeremy L Thompson     // LCOV_EXCL_START
706*e15f9bd0SJeremy L Thompson     return CeedError(qf->ceed, CEED_ERROR_UNSUPPORTED,
707*e15f9bd0SJeremy L Thompson                      "Backend does not support QFunctionApply");
708c042f62fSJeremy L Thompson   // LCOV_EXCL_STOP
709d7b241e6Sjeremylt   if (Q % qf->vlength)
710c042f62fSJeremy L Thompson     // LCOV_EXCL_START
711*e15f9bd0SJeremy L Thompson     return CeedError(qf->ceed, CEED_ERROR_DIMENSION,
712*e15f9bd0SJeremy L Thompson                      "Number of quadrature points %d must be a "
7131d102b48SJeremy L Thompson                      "multiple of %d", Q, qf->vlength);
714c042f62fSJeremy L Thompson   // LCOV_EXCL_STOP
715d7b241e6Sjeremylt   ierr = qf->Apply(qf, Q, u, v); CeedChk(ierr);
716*e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
717d7b241e6Sjeremylt }
718d7b241e6Sjeremylt 
719b11c1e72Sjeremylt /**
720b11c1e72Sjeremylt   @brief Destroy a CeedQFunction
721b11c1e72Sjeremylt 
722b11c1e72Sjeremylt   @param qf CeedQFunction to destroy
723b11c1e72Sjeremylt 
724b11c1e72Sjeremylt   @return An error code: 0 - success, otherwise - failure
725dfdf5a53Sjeremylt 
7267a982d89SJeremy L. Thompson   @ref User
727b11c1e72Sjeremylt **/
728d7b241e6Sjeremylt int CeedQFunctionDestroy(CeedQFunction *qf) {
729d7b241e6Sjeremylt   int ierr;
730d7b241e6Sjeremylt 
731*e15f9bd0SJeremy L Thompson   if (!*qf || --(*qf)->refcount > 0) return CEED_ERROR_SUCCESS;
732fe2413ffSjeremylt   // Backend destroy
733d7b241e6Sjeremylt   if ((*qf)->Destroy) {
734d7b241e6Sjeremylt     ierr = (*qf)->Destroy(*qf); CeedChk(ierr);
735d7b241e6Sjeremylt   }
736fe2413ffSjeremylt   // Free fields
737fe2413ffSjeremylt   for (int i=0; i<(*qf)->numinputfields; i++) {
738fe2413ffSjeremylt     ierr = CeedFree(&(*(*qf)->inputfields[i]).fieldname); CeedChk(ierr);
739fe2413ffSjeremylt     ierr = CeedFree(&(*qf)->inputfields[i]); CeedChk(ierr);
740fe2413ffSjeremylt   }
741fe2413ffSjeremylt   for (int i=0; i<(*qf)->numoutputfields; i++) {
742fe2413ffSjeremylt     ierr = CeedFree(&(*(*qf)->outputfields[i]).fieldname); CeedChk(ierr);
743fe2413ffSjeremylt     ierr = CeedFree(&(*qf)->outputfields[i]); CeedChk(ierr);
744fe2413ffSjeremylt   }
745fe2413ffSjeremylt   ierr = CeedFree(&(*qf)->inputfields); CeedChk(ierr);
746fe2413ffSjeremylt   ierr = CeedFree(&(*qf)->outputfields); CeedChk(ierr);
747777ff853SJeremy L Thompson 
748777ff853SJeremy L Thompson   // User context data object
749777ff853SJeremy L Thompson   ierr = CeedQFunctionContextDestroy(&(*qf)->ctx); CeedChk(ierr);
750fe2413ffSjeremylt 
751288c0443SJeremy L Thompson   ierr = CeedFree(&(*qf)->sourcepath); CeedChk(ierr);
75275affc3bSjeremylt   ierr = CeedFree(&(*qf)->qfname); CeedChk(ierr);
753d7b241e6Sjeremylt   ierr = CeedDestroy(&(*qf)->ceed); CeedChk(ierr);
754d7b241e6Sjeremylt   ierr = CeedFree(qf); CeedChk(ierr);
755*e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
756d7b241e6Sjeremylt }
757d7b241e6Sjeremylt 
758d7b241e6Sjeremylt /// @}
759