xref: /libCEED/interface/ceed-operator.c (revision 0f60e0a85cff69af5844af73e93e5983547dc5e0)
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 
17ec3da8bcSJed Brown #include <ceed/ceed.h>
18ec3da8bcSJed Brown #include <ceed/backend.h>
193d576824SJeremy L Thompson #include <ceed-impl.h>
203d576824SJeremy L Thompson #include <stdbool.h>
213d576824SJeremy L Thompson #include <stdio.h>
223d576824SJeremy L Thompson #include <string.h>
23d7b241e6Sjeremylt 
24dfdf5a53Sjeremylt /// @file
257a982d89SJeremy L. Thompson /// Implementation of CeedOperator interfaces
267a982d89SJeremy L. Thompson 
277a982d89SJeremy L. Thompson /// ----------------------------------------------------------------------------
287a982d89SJeremy L. Thompson /// CeedOperator Library Internal Functions
297a982d89SJeremy L. Thompson /// ----------------------------------------------------------------------------
307a982d89SJeremy L. Thompson /// @addtogroup CeedOperatorDeveloper
317a982d89SJeremy L. Thompson /// @{
327a982d89SJeremy L. Thompson 
337a982d89SJeremy L. Thompson /**
34e15f9bd0SJeremy L Thompson   @brief Check if a CeedOperator Field matches the QFunction Field
35e15f9bd0SJeremy L Thompson 
36e15f9bd0SJeremy L Thompson   @param[in] ceed      Ceed object for error handling
37d1d35e2fSjeremylt   @param[in] qf_field  QFunction Field matching Operator Field
38e15f9bd0SJeremy L Thompson   @param[in] r         Operator Field ElemRestriction
39e15f9bd0SJeremy L Thompson   @param[in] b         Operator Field Basis
40e15f9bd0SJeremy L Thompson 
41e15f9bd0SJeremy L Thompson   @return An error code: 0 - success, otherwise - failure
42e15f9bd0SJeremy L Thompson 
43e15f9bd0SJeremy L Thompson   @ref Developer
44e15f9bd0SJeremy L Thompson **/
45d1d35e2fSjeremylt static int CeedOperatorCheckField(Ceed ceed, CeedQFunctionField qf_field,
46e15f9bd0SJeremy L Thompson                                   CeedElemRestriction r, CeedBasis b) {
47e15f9bd0SJeremy L Thompson   int ierr;
48d1d35e2fSjeremylt   CeedEvalMode eval_mode = qf_field->eval_mode;
49d1d35e2fSjeremylt   CeedInt dim = 1, num_comp = 1, restr_num_comp = 1, size = qf_field->size;
50e15f9bd0SJeremy L Thompson   // Restriction
51e15f9bd0SJeremy L Thompson   if (r != CEED_ELEMRESTRICTION_NONE) {
52d1d35e2fSjeremylt     if (eval_mode == CEED_EVAL_WEIGHT) {
53e15f9bd0SJeremy L Thompson       // LCOV_EXCL_START
54e1e9e29dSJed Brown       return CeedError(ceed, CEED_ERROR_INCOMPATIBLE,
55e1e9e29dSJed Brown                        "CEED_ELEMRESTRICTION_NONE should be used "
56e15f9bd0SJeremy L Thompson                        "for a field with eval mode CEED_EVAL_WEIGHT");
57e15f9bd0SJeremy L Thompson       // LCOV_EXCL_STOP
58e15f9bd0SJeremy L Thompson     }
59d1d35e2fSjeremylt     ierr = CeedElemRestrictionGetNumComponents(r, &restr_num_comp);
6078464608Sjeremylt     CeedChk(ierr);
61e1e9e29dSJed Brown   }
62d1d35e2fSjeremylt   if ((r == CEED_ELEMRESTRICTION_NONE) != (eval_mode == CEED_EVAL_WEIGHT)) {
63e1e9e29dSJed Brown     // LCOV_EXCL_START
64e1e9e29dSJed Brown     return CeedError(ceed, CEED_ERROR_INCOMPATIBLE,
65e1e9e29dSJed Brown                      "CEED_ELEMRESTRICTION_NONE and CEED_EVAL_WEIGHT "
66e1e9e29dSJed Brown                      "must be used together.");
67e1e9e29dSJed Brown     // LCOV_EXCL_STOP
68e1e9e29dSJed Brown   }
69e15f9bd0SJeremy L Thompson   // Basis
70e15f9bd0SJeremy L Thompson   if (b != CEED_BASIS_COLLOCATED) {
71d1d35e2fSjeremylt     if (eval_mode == CEED_EVAL_NONE)
728229195eSjeremylt       // LCOV_EXCL_START
73e1e9e29dSJed Brown       return CeedError(ceed, CEED_ERROR_INCOMPATIBLE,
74d1d35e2fSjeremylt                        "Field '%s' configured with CEED_EVAL_NONE must "
75d1d35e2fSjeremylt                        "be used with CEED_BASIS_COLLOCATED",
768229195eSjeremylt                        // LCOV_EXCL_STOP
77d1d35e2fSjeremylt                        qf_field->field_name);
78e15f9bd0SJeremy L Thompson     ierr = CeedBasisGetDimension(b, &dim); CeedChk(ierr);
79d1d35e2fSjeremylt     ierr = CeedBasisGetNumComponents(b, &num_comp); CeedChk(ierr);
80d1d35e2fSjeremylt     if (r != CEED_ELEMRESTRICTION_NONE && restr_num_comp != num_comp) {
81e15f9bd0SJeremy L Thompson       // LCOV_EXCL_START
82e15f9bd0SJeremy L Thompson       return CeedError(ceed, CEED_ERROR_DIMENSION,
83d1d35e2fSjeremylt                        "Field '%s' of size %d and EvalMode %s: ElemRestriction "
84d1d35e2fSjeremylt                        "has %d components, but Basis has %d components",
85d1d35e2fSjeremylt                        qf_field->field_name, qf_field->size, CeedEvalModes[qf_field->eval_mode],
86d1d35e2fSjeremylt                        restr_num_comp,
87d1d35e2fSjeremylt                        num_comp);
88e15f9bd0SJeremy L Thompson       // LCOV_EXCL_STOP
89e15f9bd0SJeremy L Thompson     }
90e15f9bd0SJeremy L Thompson   }
91e15f9bd0SJeremy L Thompson   // Field size
92d1d35e2fSjeremylt   switch(eval_mode) {
93e15f9bd0SJeremy L Thompson   case CEED_EVAL_NONE:
94d1d35e2fSjeremylt     if (size != restr_num_comp)
95e15f9bd0SJeremy L Thompson       // LCOV_EXCL_START
96e15f9bd0SJeremy L Thompson       return CeedError(ceed, CEED_ERROR_DIMENSION,
97e1e9e29dSJed Brown                        "Field '%s' of size %d and EvalMode %s: ElemRestriction has %d components",
98d1d35e2fSjeremylt                        qf_field->field_name, qf_field->size, CeedEvalModes[qf_field->eval_mode],
99d1d35e2fSjeremylt                        restr_num_comp);
100e15f9bd0SJeremy L Thompson     // LCOV_EXCL_STOP
101e15f9bd0SJeremy L Thompson     break;
102e15f9bd0SJeremy L Thompson   case CEED_EVAL_INTERP:
103d1d35e2fSjeremylt     if (size != num_comp)
104e15f9bd0SJeremy L Thompson       // LCOV_EXCL_START
105e15f9bd0SJeremy L Thompson       return CeedError(ceed, CEED_ERROR_DIMENSION,
106e1e9e29dSJed Brown                        "Field '%s' of size %d and EvalMode %s: ElemRestriction/Basis has %d components",
107d1d35e2fSjeremylt                        qf_field->field_name, qf_field->size, CeedEvalModes[qf_field->eval_mode],
108d1d35e2fSjeremylt                        num_comp);
109e15f9bd0SJeremy L Thompson     // LCOV_EXCL_STOP
110e15f9bd0SJeremy L Thompson     break;
111e15f9bd0SJeremy L Thompson   case CEED_EVAL_GRAD:
112d1d35e2fSjeremylt     if (size != num_comp * dim)
113e15f9bd0SJeremy L Thompson       // LCOV_EXCL_START
114e15f9bd0SJeremy L Thompson       return CeedError(ceed, CEED_ERROR_DIMENSION,
115d1d35e2fSjeremylt                        "Field '%s' of size %d and EvalMode %s in %d dimensions: "
116d1d35e2fSjeremylt                        "ElemRestriction/Basis has %d components",
117d1d35e2fSjeremylt                        qf_field->field_name, qf_field->size, CeedEvalModes[qf_field->eval_mode], dim,
118d1d35e2fSjeremylt                        num_comp);
119e15f9bd0SJeremy L Thompson     // LCOV_EXCL_STOP
120e15f9bd0SJeremy L Thompson     break;
121e15f9bd0SJeremy L Thompson   case CEED_EVAL_WEIGHT:
122d1d35e2fSjeremylt     // No additional checks required
123e15f9bd0SJeremy L Thompson     break;
124e15f9bd0SJeremy L Thompson   case CEED_EVAL_DIV:
125e15f9bd0SJeremy L Thompson     // Not implemented
126e15f9bd0SJeremy L Thompson     break;
127e15f9bd0SJeremy L Thompson   case CEED_EVAL_CURL:
128e15f9bd0SJeremy L Thompson     // Not implemented
129e15f9bd0SJeremy L Thompson     break;
130e15f9bd0SJeremy L Thompson   }
131e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
1327a982d89SJeremy L. Thompson }
1337a982d89SJeremy L. Thompson 
1347a982d89SJeremy L. Thompson /**
1357a982d89SJeremy L. Thompson   @brief View a field of a CeedOperator
1367a982d89SJeremy L. Thompson 
1377a982d89SJeremy L. Thompson   @param[in] field         Operator field to view
138d1d35e2fSjeremylt   @param[in] qf_field      QFunction field (carries field name)
139d1d35e2fSjeremylt   @param[in] field_number  Number of field being viewed
1404c4400c7SValeria Barra   @param[in] sub           true indicates sub-operator, which increases indentation; false for top-level operator
141d1d35e2fSjeremylt   @param[in] input         true for an input field; false for output field
1427a982d89SJeremy L. Thompson   @param[in] stream        Stream to view to, e.g., stdout
1437a982d89SJeremy L. Thompson 
1447a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
1457a982d89SJeremy L. Thompson 
1467a982d89SJeremy L. Thompson   @ref Utility
1477a982d89SJeremy L. Thompson **/
1487a982d89SJeremy L. Thompson static int CeedOperatorFieldView(CeedOperatorField field,
149d1d35e2fSjeremylt                                  CeedQFunctionField qf_field,
150d1d35e2fSjeremylt                                  CeedInt field_number, bool sub, bool input,
1517a982d89SJeremy L. Thompson                                  FILE *stream) {
1527a982d89SJeremy L. Thompson   const char *pre = sub ? "  " : "";
153d1d35e2fSjeremylt   const char *in_out = input ? "Input" : "Output";
1547a982d89SJeremy L. Thompson 
1557a982d89SJeremy L. Thompson   fprintf(stream, "%s    %s Field [%d]:\n"
1567a982d89SJeremy L. Thompson           "%s      Name: \"%s\"\n",
157d1d35e2fSjeremylt           pre, in_out, field_number, pre, qf_field->field_name);
1587a982d89SJeremy L. Thompson 
1597a982d89SJeremy L. Thompson   if (field->basis == CEED_BASIS_COLLOCATED)
1607a982d89SJeremy L. Thompson     fprintf(stream, "%s      Collocated basis\n", pre);
1617a982d89SJeremy L. Thompson 
1627a982d89SJeremy L. Thompson   if (field->vec == CEED_VECTOR_ACTIVE)
1637a982d89SJeremy L. Thompson     fprintf(stream, "%s      Active vector\n", pre);
1647a982d89SJeremy L. Thompson   else if (field->vec == CEED_VECTOR_NONE)
1657a982d89SJeremy L. Thompson     fprintf(stream, "%s      No vector\n", pre);
166e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
1677a982d89SJeremy L. Thompson }
1687a982d89SJeremy L. Thompson 
1697a982d89SJeremy L. Thompson /**
1707a982d89SJeremy L. Thompson   @brief View a single CeedOperator
1717a982d89SJeremy L. Thompson 
1727a982d89SJeremy L. Thompson   @param[in] op      CeedOperator to view
1737a982d89SJeremy L. Thompson   @param[in] sub     Boolean flag for sub-operator
1747a982d89SJeremy L. Thompson   @param[in] stream  Stream to write; typically stdout/stderr or a file
1757a982d89SJeremy L. Thompson 
1767a982d89SJeremy L. Thompson   @return Error code: 0 - success, otherwise - failure
1777a982d89SJeremy L. Thompson 
1787a982d89SJeremy L. Thompson   @ref Utility
1797a982d89SJeremy L. Thompson **/
1807a982d89SJeremy L. Thompson int CeedOperatorSingleView(CeedOperator op, bool sub, FILE *stream) {
1817a982d89SJeremy L. Thompson   int ierr;
1827a982d89SJeremy L. Thompson   const char *pre = sub ? "  " : "";
1837a982d89SJeremy L. Thompson 
18478464608Sjeremylt   CeedInt total_fields = 0;
18578464608Sjeremylt   ierr = CeedOperatorGetNumArgs(op, &total_fields); CeedChk(ierr);
1867a982d89SJeremy L. Thompson 
18778464608Sjeremylt   fprintf(stream, "%s  %d Field%s\n", pre, total_fields,
18878464608Sjeremylt           total_fields>1 ? "s" : "");
1897a982d89SJeremy L. Thompson 
190d1d35e2fSjeremylt   fprintf(stream, "%s  %d Input Field%s:\n", pre, op->qf->num_input_fields,
191d1d35e2fSjeremylt           op->qf->num_input_fields>1 ? "s" : "");
192d1d35e2fSjeremylt   for (CeedInt i=0; i<op->qf->num_input_fields; i++) {
193d1d35e2fSjeremylt     ierr = CeedOperatorFieldView(op->input_fields[i], op->qf->input_fields[i],
1947a982d89SJeremy L. Thompson                                  i, sub, 1, stream); CeedChk(ierr);
1957a982d89SJeremy L. Thompson   }
1967a982d89SJeremy L. Thompson 
197d1d35e2fSjeremylt   fprintf(stream, "%s  %d Output Field%s:\n", pre, op->qf->num_output_fields,
198d1d35e2fSjeremylt           op->qf->num_output_fields>1 ? "s" : "");
199d1d35e2fSjeremylt   for (CeedInt i=0; i<op->qf->num_output_fields; i++) {
200d1d35e2fSjeremylt     ierr = CeedOperatorFieldView(op->output_fields[i], op->qf->output_fields[i],
2017a982d89SJeremy L. Thompson                                  i, sub, 0, stream); CeedChk(ierr);
2027a982d89SJeremy L. Thompson   }
203e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
2047a982d89SJeremy L. Thompson }
2057a982d89SJeremy L. Thompson 
206d99fa3c5SJeremy L Thompson /**
207*0f60e0a8SJeremy L Thompson   @brief Find the active vector basis for a non-composite CeedOperator
208eaf62fffSJeremy L Thompson 
209eaf62fffSJeremy L Thompson   @param[in] op             CeedOperator to find active basis for
210*0f60e0a8SJeremy L Thompson   @param[out] active_basis  Basis for active input vector or NULL for composite operator
211eaf62fffSJeremy L Thompson 
212eaf62fffSJeremy L Thompson   @return An error code: 0 - success, otherwise - failure
213eaf62fffSJeremy L Thompson 
214eaf62fffSJeremy L Thompson   @ ref Developer
215eaf62fffSJeremy L Thompson **/
216eaf62fffSJeremy L Thompson int CeedOperatorGetActiveBasis(CeedOperator op, CeedBasis *active_basis) {
217eaf62fffSJeremy L Thompson   *active_basis = NULL;
218*0f60e0a8SJeremy L Thompson   if (op->is_composite) return CEED_ERROR_SUCCESS;
219eaf62fffSJeremy L Thompson   for (int i = 0; i < op->qf->num_input_fields; i++)
220eaf62fffSJeremy L Thompson     if (op->input_fields[i]->vec == CEED_VECTOR_ACTIVE) {
221eaf62fffSJeremy L Thompson       *active_basis = op->input_fields[i]->basis;
222eaf62fffSJeremy L Thompson       break;
223eaf62fffSJeremy L Thompson     }
224eaf62fffSJeremy L Thompson 
225eaf62fffSJeremy L Thompson   if (!*active_basis) {
226eaf62fffSJeremy L Thompson     // LCOV_EXCL_START
227eaf62fffSJeremy L Thompson     int ierr;
228eaf62fffSJeremy L Thompson     Ceed ceed;
229eaf62fffSJeremy L Thompson     ierr = CeedOperatorGetCeed(op, &ceed); CeedChk(ierr);
230eaf62fffSJeremy L Thompson     return CeedError(ceed, CEED_ERROR_MINOR,
231eaf62fffSJeremy L Thompson                      "No active CeedBasis found");
232eaf62fffSJeremy L Thompson     // LCOV_EXCL_STOP
233eaf62fffSJeremy L Thompson   }
234eaf62fffSJeremy L Thompson   return CEED_ERROR_SUCCESS;
235eaf62fffSJeremy L Thompson }
236eaf62fffSJeremy L Thompson 
237eaf62fffSJeremy L Thompson /**
238*0f60e0a8SJeremy L Thompson   @brief Find the active vector ElemRestriction for a non-composite CeedOperator
239e2f04181SAndrew T. Barker 
240e2f04181SAndrew T. Barker   @param[in] op            CeedOperator to find active basis for
241*0f60e0a8SJeremy L Thompson   @param[out] active_rstr  ElemRestriction for active input vector or NULL for composite operator
242e2f04181SAndrew T. Barker 
243e2f04181SAndrew T. Barker   @return An error code: 0 - success, otherwise - failure
244e2f04181SAndrew T. Barker 
245e2f04181SAndrew T. Barker   @ref Utility
246e2f04181SAndrew T. Barker **/
247eaf62fffSJeremy L Thompson int CeedOperatorGetActiveElemRestriction(CeedOperator op,
248d1d35e2fSjeremylt     CeedElemRestriction *active_rstr) {
249d1d35e2fSjeremylt   *active_rstr = NULL;
250*0f60e0a8SJeremy L Thompson   if (op->is_composite) return CEED_ERROR_SUCCESS;
251d1d35e2fSjeremylt   for (int i = 0; i < op->qf->num_input_fields; i++)
252d1d35e2fSjeremylt     if (op->input_fields[i]->vec == CEED_VECTOR_ACTIVE) {
253d1d35e2fSjeremylt       *active_rstr = op->input_fields[i]->elem_restr;
254e2f04181SAndrew T. Barker       break;
255e2f04181SAndrew T. Barker     }
256e2f04181SAndrew T. Barker 
257d1d35e2fSjeremylt   if (!*active_rstr) {
258e2f04181SAndrew T. Barker     // LCOV_EXCL_START
259e2f04181SAndrew T. Barker     int ierr;
260e2f04181SAndrew T. Barker     Ceed ceed;
261e2f04181SAndrew T. Barker     ierr = CeedOperatorGetCeed(op, &ceed); CeedChk(ierr);
262e2f04181SAndrew T. Barker     return CeedError(ceed, CEED_ERROR_INCOMPLETE,
263eaf62fffSJeremy L Thompson                      "No active CeedElemRestriction found");
264e2f04181SAndrew T. Barker     // LCOV_EXCL_STOP
265e2f04181SAndrew T. Barker   }
266e2f04181SAndrew T. Barker   return CEED_ERROR_SUCCESS;
267e2f04181SAndrew T. Barker }
268e2f04181SAndrew T. Barker 
269d8dd9a91SJeremy L Thompson /**
270d8dd9a91SJeremy L Thompson   @brief Set QFunctionContext field value of the specified type.
271d8dd9a91SJeremy L Thompson            For composite operators, the value is set in all
272d8dd9a91SJeremy L Thompson            sub-operator QFunctionContexts that have a matching `field_name`.
273d8dd9a91SJeremy L Thompson            A non-zero error code is returned for single operators
274d8dd9a91SJeremy L Thompson            that do not have a matching field of the same type or composite
275d8dd9a91SJeremy L Thompson            operators that do not have any field of a matching type.
276d8dd9a91SJeremy L Thompson 
277d8dd9a91SJeremy L Thompson   @param op          CeedOperator
2783668ca4bSJeremy L Thompson   @param field_label Label of field to set
279d8dd9a91SJeremy L Thompson   @param field_type  Type of field to set
280d8dd9a91SJeremy L Thompson   @param value       Value to set
281d8dd9a91SJeremy L Thompson 
282d8dd9a91SJeremy L Thompson   @return An error code: 0 - success, otherwise - failure
283d8dd9a91SJeremy L Thompson 
284d8dd9a91SJeremy L Thompson   @ref User
285d8dd9a91SJeremy L Thompson **/
286d8dd9a91SJeremy L Thompson static int CeedOperatorContextSetGeneric(CeedOperator op,
2873668ca4bSJeremy L Thompson     CeedContextFieldLabel field_label, CeedContextFieldType field_type,
2883668ca4bSJeremy L Thompson     void *value) {
289d8dd9a91SJeremy L Thompson   int ierr;
290d8dd9a91SJeremy L Thompson 
2913668ca4bSJeremy L Thompson   if (!field_label)
2923668ca4bSJeremy L Thompson     // LCOV_EXCL_START
2933668ca4bSJeremy L Thompson     return CeedError(op->ceed, CEED_ERROR_UNSUPPORTED,
2943668ca4bSJeremy L Thompson                      "Invalid field label");
2953668ca4bSJeremy L Thompson   // LCOV_EXCL_STOP
2963668ca4bSJeremy L Thompson 
2973668ca4bSJeremy L Thompson   bool is_composite = false;
298d8dd9a91SJeremy L Thompson   ierr = CeedOperatorIsComposite(op, &is_composite); CeedChk(ierr);
299d8dd9a91SJeremy L Thompson   if (is_composite) {
300d8dd9a91SJeremy L Thompson     CeedInt num_sub;
301d8dd9a91SJeremy L Thompson     CeedOperator *sub_operators;
302d8dd9a91SJeremy L Thompson 
303d8dd9a91SJeremy L Thompson     ierr = CeedOperatorGetNumSub(op, &num_sub); CeedChk(ierr);
304d8dd9a91SJeremy L Thompson     ierr = CeedOperatorGetSubList(op, &sub_operators); CeedChk(ierr);
3053668ca4bSJeremy L Thompson     if (num_sub != field_label->num_sub_labels)
3063668ca4bSJeremy L Thompson       // LCOV_EXCL_START
3073668ca4bSJeremy L Thompson       return CeedError(op->ceed, CEED_ERROR_UNSUPPORTED,
3083668ca4bSJeremy L Thompson                        "ContextLabel does not correspond to composite operator.\n"
3093668ca4bSJeremy L Thompson                        "Use CeedOperatorGetContextFieldLabel().");
3103668ca4bSJeremy L Thompson     // LCOV_EXCL_STOP
311d8dd9a91SJeremy L Thompson 
312d8dd9a91SJeremy L Thompson     for (CeedInt i = 0; i < num_sub; i++) {
313d8dd9a91SJeremy L Thompson       // Try every sub-operator, ok if some sub-operators do not have field
3143668ca4bSJeremy L Thompson       if (field_label->sub_labels[i] && sub_operators[i]->qf->ctx) {
3153668ca4bSJeremy L Thompson         ierr = CeedQFunctionContextSetGeneric(sub_operators[i]->qf->ctx,
3163668ca4bSJeremy L Thompson                                               field_label->sub_labels[i],
3173668ca4bSJeremy L Thompson                                               field_type, value); CeedChk(ierr);
318d8dd9a91SJeremy L Thompson       }
319d8dd9a91SJeremy L Thompson     }
320d8dd9a91SJeremy L Thompson   } else {
321d8dd9a91SJeremy L Thompson     if (!op->qf->ctx)
322d8dd9a91SJeremy L Thompson       // LCOV_EXCL_START
323d8dd9a91SJeremy L Thompson       return CeedError(op->ceed, CEED_ERROR_UNSUPPORTED,
324d8dd9a91SJeremy L Thompson                        "QFunction does not have context data");
325d8dd9a91SJeremy L Thompson     // LCOV_EXCL_STOP
326d8dd9a91SJeremy L Thompson 
3273668ca4bSJeremy L Thompson     ierr = CeedQFunctionContextSetGeneric(op->qf->ctx, field_label,
3283668ca4bSJeremy L Thompson                                           field_type, value); CeedChk(ierr);
329d8dd9a91SJeremy L Thompson   }
330d8dd9a91SJeremy L Thompson 
331d8dd9a91SJeremy L Thompson   return CEED_ERROR_SUCCESS;
332d8dd9a91SJeremy L Thompson }
333d8dd9a91SJeremy L Thompson 
3347a982d89SJeremy L. Thompson /// @}
3357a982d89SJeremy L. Thompson 
3367a982d89SJeremy L. Thompson /// ----------------------------------------------------------------------------
3377a982d89SJeremy L. Thompson /// CeedOperator Backend API
3387a982d89SJeremy L. Thompson /// ----------------------------------------------------------------------------
3397a982d89SJeremy L. Thompson /// @addtogroup CeedOperatorBackend
3407a982d89SJeremy L. Thompson /// @{
3417a982d89SJeremy L. Thompson 
3427a982d89SJeremy L. Thompson /**
3437a982d89SJeremy L. Thompson   @brief Get the number of arguments associated with a CeedOperator
3447a982d89SJeremy L. Thompson 
3457a982d89SJeremy L. Thompson   @param op             CeedOperator
346d1d35e2fSjeremylt   @param[out] num_args  Variable to store vector number of arguments
3477a982d89SJeremy L. Thompson 
3487a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
3497a982d89SJeremy L. Thompson 
3507a982d89SJeremy L. Thompson   @ref Backend
3517a982d89SJeremy L. Thompson **/
3527a982d89SJeremy L. Thompson 
353d1d35e2fSjeremylt int CeedOperatorGetNumArgs(CeedOperator op, CeedInt *num_args) {
354f04ea552SJeremy L Thompson   if (op->is_composite)
3557a982d89SJeremy L. Thompson     // LCOV_EXCL_START
356e15f9bd0SJeremy L Thompson     return CeedError(op->ceed, CEED_ERROR_MINOR,
357e15f9bd0SJeremy L Thompson                      "Not defined for composite operators");
3587a982d89SJeremy L. Thompson   // LCOV_EXCL_STOP
3597a982d89SJeremy L. Thompson 
360d1d35e2fSjeremylt   *num_args = op->num_fields;
361e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
3627a982d89SJeremy L. Thompson }
3637a982d89SJeremy L. Thompson 
3647a982d89SJeremy L. Thompson /**
3657a982d89SJeremy L. Thompson   @brief Get the setup status of a CeedOperator
3667a982d89SJeremy L. Thompson 
3677a982d89SJeremy L. Thompson   @param op                  CeedOperator
368d1d35e2fSjeremylt   @param[out] is_setup_done  Variable to store setup status
3697a982d89SJeremy L. Thompson 
3707a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
3717a982d89SJeremy L. Thompson 
3727a982d89SJeremy L. Thompson   @ref Backend
3737a982d89SJeremy L. Thompson **/
3747a982d89SJeremy L. Thompson 
375d1d35e2fSjeremylt int CeedOperatorIsSetupDone(CeedOperator op, bool *is_setup_done) {
376f04ea552SJeremy L Thompson   *is_setup_done = op->is_backend_setup;
377e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
3787a982d89SJeremy L. Thompson }
3797a982d89SJeremy L. Thompson 
3807a982d89SJeremy L. Thompson /**
3817a982d89SJeremy L. Thompson   @brief Get the QFunction associated with a CeedOperator
3827a982d89SJeremy L. Thompson 
3837a982d89SJeremy L. Thompson   @param op       CeedOperator
3847a982d89SJeremy L. Thompson   @param[out] qf  Variable to store QFunction
3857a982d89SJeremy L. Thompson 
3867a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
3877a982d89SJeremy L. Thompson 
3887a982d89SJeremy L. Thompson   @ref Backend
3897a982d89SJeremy L. Thompson **/
3907a982d89SJeremy L. Thompson 
3917a982d89SJeremy L. Thompson int CeedOperatorGetQFunction(CeedOperator op, CeedQFunction *qf) {
392f04ea552SJeremy L Thompson   if (op->is_composite)
3937a982d89SJeremy L. Thompson     // LCOV_EXCL_START
394e15f9bd0SJeremy L Thompson     return CeedError(op->ceed, CEED_ERROR_MINOR,
395e15f9bd0SJeremy L Thompson                      "Not defined for composite operator");
3967a982d89SJeremy L. Thompson   // LCOV_EXCL_STOP
3977a982d89SJeremy L. Thompson 
3987a982d89SJeremy L. Thompson   *qf = op->qf;
399e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
4007a982d89SJeremy L. Thompson }
4017a982d89SJeremy L. Thompson 
4027a982d89SJeremy L. Thompson /**
403c04a41a7SJeremy L Thompson   @brief Get a boolean value indicating if the CeedOperator is composite
404c04a41a7SJeremy L Thompson 
405c04a41a7SJeremy L Thompson   @param op                 CeedOperator
406d1d35e2fSjeremylt   @param[out] is_composite  Variable to store composite status
407c04a41a7SJeremy L Thompson 
408c04a41a7SJeremy L Thompson   @return An error code: 0 - success, otherwise - failure
409c04a41a7SJeremy L Thompson 
410c04a41a7SJeremy L Thompson   @ref Backend
411c04a41a7SJeremy L Thompson **/
412c04a41a7SJeremy L Thompson 
413d1d35e2fSjeremylt int CeedOperatorIsComposite(CeedOperator op, bool *is_composite) {
414f04ea552SJeremy L Thompson   *is_composite = op->is_composite;
415e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
416c04a41a7SJeremy L Thompson }
417c04a41a7SJeremy L Thompson 
418c04a41a7SJeremy L Thompson /**
419d1d35e2fSjeremylt   @brief Get the number of sub_operators associated with a CeedOperator
4207a982d89SJeremy L. Thompson 
4217a982d89SJeremy L. Thompson   @param op                     CeedOperator
422d1d35e2fSjeremylt   @param[out] num_suboperators  Variable to store number of sub_operators
4237a982d89SJeremy L. Thompson 
4247a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
4257a982d89SJeremy L. Thompson 
4267a982d89SJeremy L. Thompson   @ref Backend
4277a982d89SJeremy L. Thompson **/
4287a982d89SJeremy L. Thompson 
429d1d35e2fSjeremylt int CeedOperatorGetNumSub(CeedOperator op, CeedInt *num_suboperators) {
430f04ea552SJeremy L Thompson   if (!op->is_composite)
4317a982d89SJeremy L. Thompson     // LCOV_EXCL_START
432e15f9bd0SJeremy L Thompson     return CeedError(op->ceed, CEED_ERROR_MINOR, "Not a composite operator");
4337a982d89SJeremy L. Thompson   // LCOV_EXCL_STOP
4347a982d89SJeremy L. Thompson 
435d1d35e2fSjeremylt   *num_suboperators = op->num_suboperators;
436e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
4377a982d89SJeremy L. Thompson }
4387a982d89SJeremy L. Thompson 
4397a982d89SJeremy L. Thompson /**
440d1d35e2fSjeremylt   @brief Get the list of sub_operators associated with a CeedOperator
4417a982d89SJeremy L. Thompson 
4427a982d89SJeremy L. Thompson   @param op                  CeedOperator
443d1d35e2fSjeremylt   @param[out] sub_operators  Variable to store list of sub_operators
4447a982d89SJeremy L. Thompson 
4457a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
4467a982d89SJeremy L. Thompson 
4477a982d89SJeremy L. Thompson   @ref Backend
4487a982d89SJeremy L. Thompson **/
4497a982d89SJeremy L. Thompson 
450d1d35e2fSjeremylt int CeedOperatorGetSubList(CeedOperator op, CeedOperator **sub_operators) {
451f04ea552SJeremy L Thompson   if (!op->is_composite)
4527a982d89SJeremy L. Thompson     // LCOV_EXCL_START
453e15f9bd0SJeremy L Thompson     return CeedError(op->ceed, CEED_ERROR_MINOR, "Not a composite operator");
4547a982d89SJeremy L. Thompson   // LCOV_EXCL_STOP
4557a982d89SJeremy L. Thompson 
456d1d35e2fSjeremylt   *sub_operators = op->sub_operators;
457e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
4587a982d89SJeremy L. Thompson }
4597a982d89SJeremy L. Thompson 
4607a982d89SJeremy L. Thompson /**
4617a982d89SJeremy L. Thompson   @brief Get the backend data of a CeedOperator
4627a982d89SJeremy L. Thompson 
4637a982d89SJeremy L. Thompson   @param op         CeedOperator
4647a982d89SJeremy L. Thompson   @param[out] data  Variable to store data
4657a982d89SJeremy L. Thompson 
4667a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
4677a982d89SJeremy L. Thompson 
4687a982d89SJeremy L. Thompson   @ref Backend
4697a982d89SJeremy L. Thompson **/
4707a982d89SJeremy L. Thompson 
471777ff853SJeremy L Thompson int CeedOperatorGetData(CeedOperator op, void *data) {
472777ff853SJeremy L Thompson   *(void **)data = op->data;
473e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
4747a982d89SJeremy L. Thompson }
4757a982d89SJeremy L. Thompson 
4767a982d89SJeremy L. Thompson /**
4777a982d89SJeremy L. Thompson   @brief Set the backend data of a CeedOperator
4787a982d89SJeremy L. Thompson 
4797a982d89SJeremy L. Thompson   @param[out] op  CeedOperator
4807a982d89SJeremy L. Thompson   @param data     Data to set
4817a982d89SJeremy L. Thompson 
4827a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
4837a982d89SJeremy L. Thompson 
4847a982d89SJeremy L. Thompson   @ref Backend
4857a982d89SJeremy L. Thompson **/
4867a982d89SJeremy L. Thompson 
487777ff853SJeremy L Thompson int CeedOperatorSetData(CeedOperator op, void *data) {
488777ff853SJeremy L Thompson   op->data = data;
489e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
4907a982d89SJeremy L. Thompson }
4917a982d89SJeremy L. Thompson 
4927a982d89SJeremy L. Thompson /**
49334359f16Sjeremylt   @brief Increment the reference counter for a CeedOperator
49434359f16Sjeremylt 
49534359f16Sjeremylt   @param op  CeedOperator to increment the reference counter
49634359f16Sjeremylt 
49734359f16Sjeremylt   @return An error code: 0 - success, otherwise - failure
49834359f16Sjeremylt 
49934359f16Sjeremylt   @ref Backend
50034359f16Sjeremylt **/
5019560d06aSjeremylt int CeedOperatorReference(CeedOperator op) {
50234359f16Sjeremylt   op->ref_count++;
50334359f16Sjeremylt   return CEED_ERROR_SUCCESS;
50434359f16Sjeremylt }
50534359f16Sjeremylt 
50634359f16Sjeremylt /**
5077a982d89SJeremy L. Thompson   @brief Set the setup flag of a CeedOperator to True
5087a982d89SJeremy L. Thompson 
5097a982d89SJeremy L. Thompson   @param op  CeedOperator
5107a982d89SJeremy L. Thompson 
5117a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
5127a982d89SJeremy L. Thompson 
5137a982d89SJeremy L. Thompson   @ref Backend
5147a982d89SJeremy L. Thompson **/
5157a982d89SJeremy L. Thompson 
5167a982d89SJeremy L. Thompson int CeedOperatorSetSetupDone(CeedOperator op) {
517f04ea552SJeremy L Thompson   op->is_backend_setup = true;
518e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
5197a982d89SJeremy L. Thompson }
5207a982d89SJeremy L. Thompson 
5217a982d89SJeremy L. Thompson /// @}
5227a982d89SJeremy L. Thompson 
5237a982d89SJeremy L. Thompson /// ----------------------------------------------------------------------------
5247a982d89SJeremy L. Thompson /// CeedOperator Public API
5257a982d89SJeremy L. Thompson /// ----------------------------------------------------------------------------
5267a982d89SJeremy L. Thompson /// @addtogroup CeedOperatorUser
527dfdf5a53Sjeremylt /// @{
528d7b241e6Sjeremylt 
529d7b241e6Sjeremylt /**
5300219ea01SJeremy L Thompson   @brief Create a CeedOperator and associate a CeedQFunction. A CeedBasis and
5310219ea01SJeremy L Thompson            CeedElemRestriction can be associated with CeedQFunction fields with
5320219ea01SJeremy L Thompson            \ref CeedOperatorSetField.
533d7b241e6Sjeremylt 
534b11c1e72Sjeremylt   @param ceed     A Ceed object where the CeedOperator will be created
535d7b241e6Sjeremylt   @param qf       QFunction defining the action of the operator at quadrature points
53634138859Sjeremylt   @param dqf      QFunction defining the action of the Jacobian of @a qf (or
5374cc79fe7SJed Brown                     @ref CEED_QFUNCTION_NONE)
538d7b241e6Sjeremylt   @param dqfT     QFunction defining the action of the transpose of the Jacobian
5394cc79fe7SJed Brown                     of @a qf (or @ref CEED_QFUNCTION_NONE)
540b11c1e72Sjeremylt   @param[out] op  Address of the variable where the newly created
541b11c1e72Sjeremylt                     CeedOperator will be stored
542b11c1e72Sjeremylt 
543b11c1e72Sjeremylt   @return An error code: 0 - success, otherwise - failure
544dfdf5a53Sjeremylt 
5457a982d89SJeremy L. Thompson   @ref User
546d7b241e6Sjeremylt  */
547d7b241e6Sjeremylt int CeedOperatorCreate(Ceed ceed, CeedQFunction qf, CeedQFunction dqf,
548d7b241e6Sjeremylt                        CeedQFunction dqfT, CeedOperator *op) {
549d7b241e6Sjeremylt   int ierr;
550d7b241e6Sjeremylt 
5515fe0d4faSjeremylt   if (!ceed->OperatorCreate) {
5525fe0d4faSjeremylt     Ceed delegate;
553aefd8378Sjeremylt     ierr = CeedGetObjectDelegate(ceed, &delegate, "Operator"); CeedChk(ierr);
5545fe0d4faSjeremylt 
5555fe0d4faSjeremylt     if (!delegate)
556c042f62fSJeremy L Thompson       // LCOV_EXCL_START
557e15f9bd0SJeremy L Thompson       return CeedError(ceed, CEED_ERROR_UNSUPPORTED,
558e15f9bd0SJeremy L Thompson                        "Backend does not support OperatorCreate");
559c042f62fSJeremy L Thompson     // LCOV_EXCL_STOP
5605fe0d4faSjeremylt 
5615fe0d4faSjeremylt     ierr = CeedOperatorCreate(delegate, qf, dqf, dqfT, op); CeedChk(ierr);
562e15f9bd0SJeremy L Thompson     return CEED_ERROR_SUCCESS;
5635fe0d4faSjeremylt   }
5645fe0d4faSjeremylt 
565b3b7035fSJeremy L Thompson   if (!qf || qf == CEED_QFUNCTION_NONE)
566b3b7035fSJeremy L Thompson     // LCOV_EXCL_START
567e15f9bd0SJeremy L Thompson     return CeedError(ceed, CEED_ERROR_MINOR,
568e15f9bd0SJeremy L Thompson                      "Operator must have a valid QFunction.");
569b3b7035fSJeremy L Thompson   // LCOV_EXCL_STOP
570d7b241e6Sjeremylt   ierr = CeedCalloc(1, op); CeedChk(ierr);
571d7b241e6Sjeremylt   (*op)->ceed = ceed;
5729560d06aSjeremylt   ierr = CeedReference(ceed); CeedChk(ierr);
573d1d35e2fSjeremylt   (*op)->ref_count = 1;
574d7b241e6Sjeremylt   (*op)->qf = qf;
5759560d06aSjeremylt   ierr = CeedQFunctionReference(qf); CeedChk(ierr);
576442e7f0bSjeremylt   if (dqf && dqf != CEED_QFUNCTION_NONE) {
577d7b241e6Sjeremylt     (*op)->dqf = dqf;
5789560d06aSjeremylt     ierr = CeedQFunctionReference(dqf); CeedChk(ierr);
579442e7f0bSjeremylt   }
580442e7f0bSjeremylt   if (dqfT && dqfT != CEED_QFUNCTION_NONE) {
581d7b241e6Sjeremylt     (*op)->dqfT = dqfT;
5829560d06aSjeremylt     ierr = CeedQFunctionReference(dqfT); CeedChk(ierr);
583442e7f0bSjeremylt   }
584480fae85SJeremy L Thompson   ierr = CeedQFunctionAssemblyDataCreate(ceed, &(*op)->qf_assembled);
585480fae85SJeremy L Thompson   CeedChk(ierr);
586bf4cb664SJeremy L Thompson   ierr = CeedCalloc(CEED_FIELD_MAX, &(*op)->input_fields); CeedChk(ierr);
587bf4cb664SJeremy L Thompson   ierr = CeedCalloc(CEED_FIELD_MAX, &(*op)->output_fields); CeedChk(ierr);
588d7b241e6Sjeremylt   ierr = ceed->OperatorCreate(*op); CeedChk(ierr);
589e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
590d7b241e6Sjeremylt }
591d7b241e6Sjeremylt 
592d7b241e6Sjeremylt /**
59352d6035fSJeremy L Thompson   @brief Create an operator that composes the action of several operators
59452d6035fSJeremy L Thompson 
59552d6035fSJeremy L Thompson   @param ceed     A Ceed object where the CeedOperator will be created
59652d6035fSJeremy L Thompson   @param[out] op  Address of the variable where the newly created
59752d6035fSJeremy L Thompson                     Composite CeedOperator will be stored
59852d6035fSJeremy L Thompson 
59952d6035fSJeremy L Thompson   @return An error code: 0 - success, otherwise - failure
60052d6035fSJeremy L Thompson 
6017a982d89SJeremy L. Thompson   @ref User
60252d6035fSJeremy L Thompson  */
60352d6035fSJeremy L Thompson int CeedCompositeOperatorCreate(Ceed ceed, CeedOperator *op) {
60452d6035fSJeremy L Thompson   int ierr;
60552d6035fSJeremy L Thompson 
60652d6035fSJeremy L Thompson   if (!ceed->CompositeOperatorCreate) {
60752d6035fSJeremy L Thompson     Ceed delegate;
608aefd8378Sjeremylt     ierr = CeedGetObjectDelegate(ceed, &delegate, "Operator"); CeedChk(ierr);
60952d6035fSJeremy L Thompson 
610250756a7Sjeremylt     if (delegate) {
61152d6035fSJeremy L Thompson       ierr = CeedCompositeOperatorCreate(delegate, op); CeedChk(ierr);
612e15f9bd0SJeremy L Thompson       return CEED_ERROR_SUCCESS;
61352d6035fSJeremy L Thompson     }
614250756a7Sjeremylt   }
61552d6035fSJeremy L Thompson 
61652d6035fSJeremy L Thompson   ierr = CeedCalloc(1, op); CeedChk(ierr);
61752d6035fSJeremy L Thompson   (*op)->ceed = ceed;
6189560d06aSjeremylt   ierr = CeedReference(ceed); CeedChk(ierr);
619f04ea552SJeremy L Thompson   (*op)->is_composite = true;
620bf4cb664SJeremy L Thompson   ierr = CeedCalloc(CEED_COMPOSITE_MAX, &(*op)->sub_operators); CeedChk(ierr);
621250756a7Sjeremylt 
622250756a7Sjeremylt   if (ceed->CompositeOperatorCreate) {
62352d6035fSJeremy L Thompson     ierr = ceed->CompositeOperatorCreate(*op); CeedChk(ierr);
624250756a7Sjeremylt   }
625e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
62652d6035fSJeremy L Thompson }
62752d6035fSJeremy L Thompson 
62852d6035fSJeremy L Thompson /**
6299560d06aSjeremylt   @brief Copy the pointer to a CeedOperator. Both pointers should
6309560d06aSjeremylt            be destroyed with `CeedOperatorDestroy()`;
6319560d06aSjeremylt            Note: If `*op_copy` is non-NULL, then it is assumed that
6329560d06aSjeremylt            `*op_copy` is a pointer to a CeedOperator. This
6339560d06aSjeremylt            CeedOperator will be destroyed if `*op_copy` is the only
6349560d06aSjeremylt            reference to this CeedOperator.
6359560d06aSjeremylt 
6369560d06aSjeremylt   @param op            CeedOperator to copy reference to
6379560d06aSjeremylt   @param[out] op_copy  Variable to store copied reference
6389560d06aSjeremylt 
6399560d06aSjeremylt   @return An error code: 0 - success, otherwise - failure
6409560d06aSjeremylt 
6419560d06aSjeremylt   @ref User
6429560d06aSjeremylt **/
6439560d06aSjeremylt int CeedOperatorReferenceCopy(CeedOperator op, CeedOperator *op_copy) {
6449560d06aSjeremylt   int ierr;
6459560d06aSjeremylt 
6469560d06aSjeremylt   ierr = CeedOperatorReference(op); CeedChk(ierr);
6479560d06aSjeremylt   ierr = CeedOperatorDestroy(op_copy); CeedChk(ierr);
6489560d06aSjeremylt   *op_copy = op;
6499560d06aSjeremylt   return CEED_ERROR_SUCCESS;
6509560d06aSjeremylt }
6519560d06aSjeremylt 
6529560d06aSjeremylt /**
653b11c1e72Sjeremylt   @brief Provide a field to a CeedOperator for use by its CeedQFunction
654d7b241e6Sjeremylt 
655d7b241e6Sjeremylt   This function is used to specify both active and passive fields to a
656d7b241e6Sjeremylt   CeedOperator.  For passive fields, a vector @arg v must be provided.  Passive
657d7b241e6Sjeremylt   fields can inputs or outputs (updated in-place when operator is applied).
658d7b241e6Sjeremylt 
659d7b241e6Sjeremylt   Active fields must be specified using this function, but their data (in a
660d7b241e6Sjeremylt   CeedVector) is passed in CeedOperatorApply().  There can be at most one active
661d7b241e6Sjeremylt   input and at most one active output.
662d7b241e6Sjeremylt 
6638c91a0c9SJeremy L Thompson   @param op          CeedOperator on which to provide the field
664d1d35e2fSjeremylt   @param field_name  Name of the field (to be matched with the name used by
6658795c945Sjeremylt                        CeedQFunction)
666b11c1e72Sjeremylt   @param r           CeedElemRestriction
6674cc79fe7SJed Brown   @param b           CeedBasis in which the field resides or @ref CEED_BASIS_COLLOCATED
668b11c1e72Sjeremylt                        if collocated with quadrature points
6694cc79fe7SJed Brown   @param v           CeedVector to be used by CeedOperator or @ref CEED_VECTOR_ACTIVE
6704cc79fe7SJed Brown                        if field is active or @ref CEED_VECTOR_NONE if using
6714cc79fe7SJed Brown                        @ref CEED_EVAL_WEIGHT in the QFunction
672b11c1e72Sjeremylt 
673b11c1e72Sjeremylt   @return An error code: 0 - success, otherwise - failure
674dfdf5a53Sjeremylt 
6757a982d89SJeremy L. Thompson   @ref User
676b11c1e72Sjeremylt **/
677d1d35e2fSjeremylt int CeedOperatorSetField(CeedOperator op, const char *field_name,
678a8d32208Sjeremylt                          CeedElemRestriction r, CeedBasis b, CeedVector v) {
679d7b241e6Sjeremylt   int ierr;
680f04ea552SJeremy L Thompson   if (op->is_composite)
681c042f62fSJeremy L Thompson     // LCOV_EXCL_START
682e1e9e29dSJed Brown     return CeedError(op->ceed, CEED_ERROR_INCOMPATIBLE,
683e15f9bd0SJeremy L Thompson                      "Cannot add field to composite operator.");
684c042f62fSJeremy L Thompson   // LCOV_EXCL_STOP
685f04ea552SJeremy L Thompson   if (op->is_immutable)
686f04ea552SJeremy L Thompson     // LCOV_EXCL_START
687f04ea552SJeremy L Thompson     return CeedError(op->ceed, CEED_ERROR_MAJOR,
688f04ea552SJeremy L Thompson                      "Operator cannot be changed after set as immutable");
689f04ea552SJeremy L Thompson   // LCOV_EXCL_STOP
6908b067b84SJed Brown   if (!r)
691c042f62fSJeremy L Thompson     // LCOV_EXCL_START
692e1e9e29dSJed Brown     return CeedError(op->ceed, CEED_ERROR_INCOMPATIBLE,
693c042f62fSJeremy L Thompson                      "ElemRestriction r for field \"%s\" must be non-NULL.",
694d1d35e2fSjeremylt                      field_name);
695c042f62fSJeremy L Thompson   // LCOV_EXCL_STOP
6968b067b84SJed Brown   if (!b)
697c042f62fSJeremy L Thompson     // LCOV_EXCL_START
698e1e9e29dSJed Brown     return CeedError(op->ceed, CEED_ERROR_INCOMPATIBLE,
699e15f9bd0SJeremy L Thompson                      "Basis b for field \"%s\" must be non-NULL.",
700d1d35e2fSjeremylt                      field_name);
701c042f62fSJeremy L Thompson   // LCOV_EXCL_STOP
7028b067b84SJed Brown   if (!v)
703c042f62fSJeremy L Thompson     // LCOV_EXCL_START
704e1e9e29dSJed Brown     return CeedError(op->ceed, CEED_ERROR_INCOMPATIBLE,
705e15f9bd0SJeremy L Thompson                      "Vector v for field \"%s\" must be non-NULL.",
706d1d35e2fSjeremylt                      field_name);
707c042f62fSJeremy L Thompson   // LCOV_EXCL_STOP
70852d6035fSJeremy L Thompson 
709d1d35e2fSjeremylt   CeedInt num_elem;
710d1d35e2fSjeremylt   ierr = CeedElemRestrictionGetNumElements(r, &num_elem); CeedChk(ierr);
711d1d35e2fSjeremylt   if (r != CEED_ELEMRESTRICTION_NONE && op->has_restriction &&
712d1d35e2fSjeremylt       op->num_elem != num_elem)
713c042f62fSJeremy L Thompson     // LCOV_EXCL_START
714e15f9bd0SJeremy L Thompson     return CeedError(op->ceed, CEED_ERROR_DIMENSION,
7151d102b48SJeremy L Thompson                      "ElemRestriction with %d elements incompatible with prior "
716d1d35e2fSjeremylt                      "%d elements", num_elem, op->num_elem);
717c042f62fSJeremy L Thompson   // LCOV_EXCL_STOP
718d7b241e6Sjeremylt 
71978464608Sjeremylt   CeedInt num_qpts = 0;
720e15f9bd0SJeremy L Thompson   if (b != CEED_BASIS_COLLOCATED) {
721d1d35e2fSjeremylt     ierr = CeedBasisGetNumQuadraturePoints(b, &num_qpts); CeedChk(ierr);
722d1d35e2fSjeremylt     if (op->num_qpts && op->num_qpts != num_qpts)
723c042f62fSJeremy L Thompson       // LCOV_EXCL_START
724e15f9bd0SJeremy L Thompson       return CeedError(op->ceed, CEED_ERROR_DIMENSION,
725e15f9bd0SJeremy L Thompson                        "Basis with %d quadrature points "
726d1d35e2fSjeremylt                        "incompatible with prior %d points", num_qpts,
727d1d35e2fSjeremylt                        op->num_qpts);
728c042f62fSJeremy L Thompson     // LCOV_EXCL_STOP
729d7b241e6Sjeremylt   }
730d1d35e2fSjeremylt   CeedQFunctionField qf_field;
731d1d35e2fSjeremylt   CeedOperatorField *op_field;
732d1d35e2fSjeremylt   for (CeedInt i=0; i<op->qf->num_input_fields; i++) {
733d1d35e2fSjeremylt     if (!strcmp(field_name, (*op->qf->input_fields[i]).field_name)) {
734d1d35e2fSjeremylt       qf_field = op->qf->input_fields[i];
735d1d35e2fSjeremylt       op_field = &op->input_fields[i];
736d7b241e6Sjeremylt       goto found;
737d7b241e6Sjeremylt     }
738d7b241e6Sjeremylt   }
739d1d35e2fSjeremylt   for (CeedInt i=0; i<op->qf->num_output_fields; i++) {
740d1d35e2fSjeremylt     if (!strcmp(field_name, (*op->qf->output_fields[i]).field_name)) {
741d1d35e2fSjeremylt       qf_field = op->qf->output_fields[i];
742d1d35e2fSjeremylt       op_field = &op->output_fields[i];
743d7b241e6Sjeremylt       goto found;
744d7b241e6Sjeremylt     }
745d7b241e6Sjeremylt   }
746c042f62fSJeremy L Thompson   // LCOV_EXCL_START
747e15f9bd0SJeremy L Thompson   return CeedError(op->ceed, CEED_ERROR_INCOMPLETE,
748e15f9bd0SJeremy L Thompson                    "QFunction has no knowledge of field '%s'",
749d1d35e2fSjeremylt                    field_name);
750c042f62fSJeremy L Thompson   // LCOV_EXCL_STOP
751d7b241e6Sjeremylt found:
752d1d35e2fSjeremylt   ierr = CeedOperatorCheckField(op->ceed, qf_field, r, b); CeedChk(ierr);
753d1d35e2fSjeremylt   ierr = CeedCalloc(1, op_field); CeedChk(ierr);
754e15f9bd0SJeremy L Thompson 
755d1d35e2fSjeremylt   (*op_field)->vec = v;
756e15f9bd0SJeremy L Thompson   if (v != CEED_VECTOR_ACTIVE && v != CEED_VECTOR_NONE) {
7579560d06aSjeremylt     ierr = CeedVectorReference(v); CeedChk(ierr);
758e15f9bd0SJeremy L Thompson   }
759e15f9bd0SJeremy L Thompson 
760d1d35e2fSjeremylt   (*op_field)->elem_restr = r;
7619560d06aSjeremylt   ierr = CeedElemRestrictionReference(r); CeedChk(ierr);
762e15f9bd0SJeremy L Thompson   if (r != CEED_ELEMRESTRICTION_NONE) {
763d1d35e2fSjeremylt     op->num_elem = num_elem;
764d1d35e2fSjeremylt     op->has_restriction = true; // Restriction set, but num_elem may be 0
765e15f9bd0SJeremy L Thompson   }
766d99fa3c5SJeremy L Thompson 
767d1d35e2fSjeremylt   (*op_field)->basis = b;
768e15f9bd0SJeremy L Thompson   if (b != CEED_BASIS_COLLOCATED) {
769cd4dfc48Sjeremylt     if (!op->num_qpts) {
770cd4dfc48Sjeremylt       ierr = CeedOperatorSetNumQuadraturePoints(op, num_qpts); CeedChk(ierr);
771cd4dfc48Sjeremylt     }
7729560d06aSjeremylt     ierr = CeedBasisReference(b); CeedChk(ierr);
773e15f9bd0SJeremy L Thompson   }
774e15f9bd0SJeremy L Thompson 
775d1d35e2fSjeremylt   op->num_fields += 1;
776f7e22acaSJeremy L Thompson   ierr = CeedStringAllocCopy(field_name, (char **)&(*op_field)->field_name);
777f7e22acaSJeremy L Thompson   CeedChk(ierr);
778e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
779d7b241e6Sjeremylt }
780d7b241e6Sjeremylt 
781d7b241e6Sjeremylt /**
78243bbe138SJeremy L Thompson   @brief Get the CeedOperatorFields of a CeedOperator
78343bbe138SJeremy L Thompson 
784f04ea552SJeremy L Thompson   Note: Calling this function asserts that setup is complete
785f04ea552SJeremy L Thompson           and sets the CeedOperator as immutable.
786f04ea552SJeremy L Thompson 
78743bbe138SJeremy L Thompson   @param op                      CeedOperator
788f74ec584SJeremy L Thompson   @param[out] num_input_fields   Variable to store number of input fields
78943bbe138SJeremy L Thompson   @param[out] input_fields       Variable to store input_fields
790f74ec584SJeremy L Thompson   @param[out] num_output_fields  Variable to store number of output fields
79143bbe138SJeremy L Thompson   @param[out] output_fields      Variable to store output_fields
79243bbe138SJeremy L Thompson 
79343bbe138SJeremy L Thompson   @return An error code: 0 - success, otherwise - failure
79443bbe138SJeremy L Thompson 
795e9b533fbSJeremy L Thompson   @ref Advanced
79643bbe138SJeremy L Thompson **/
79743bbe138SJeremy L Thompson int CeedOperatorGetFields(CeedOperator op, CeedInt *num_input_fields,
79843bbe138SJeremy L Thompson                           CeedOperatorField **input_fields,
79943bbe138SJeremy L Thompson                           CeedInt *num_output_fields,
80043bbe138SJeremy L Thompson                           CeedOperatorField **output_fields) {
801f04ea552SJeremy L Thompson   int ierr;
802f04ea552SJeremy L Thompson 
803f04ea552SJeremy L Thompson   if (op->is_composite)
80443bbe138SJeremy L Thompson     // LCOV_EXCL_START
80543bbe138SJeremy L Thompson     return CeedError(op->ceed, CEED_ERROR_MINOR,
80643bbe138SJeremy L Thompson                      "Not defined for composite operator");
80743bbe138SJeremy L Thompson   // LCOV_EXCL_STOP
808f04ea552SJeremy L Thompson   ierr = CeedOperatorCheckReady(op); CeedChk(ierr);
80943bbe138SJeremy L Thompson 
81043bbe138SJeremy L Thompson   if (num_input_fields) *num_input_fields = op->qf->num_input_fields;
81143bbe138SJeremy L Thompson   if (input_fields) *input_fields = op->input_fields;
81243bbe138SJeremy L Thompson   if (num_output_fields) *num_output_fields = op->qf->num_output_fields;
81343bbe138SJeremy L Thompson   if (output_fields) *output_fields = op->output_fields;
81443bbe138SJeremy L Thompson   return CEED_ERROR_SUCCESS;
81543bbe138SJeremy L Thompson }
81643bbe138SJeremy L Thompson 
81743bbe138SJeremy L Thompson /**
81828567f8fSJeremy L Thompson   @brief Get the name of a CeedOperatorField
81928567f8fSJeremy L Thompson 
82028567f8fSJeremy L Thompson   @param op_field         CeedOperatorField
82128567f8fSJeremy L Thompson   @param[out] field_name  Variable to store the field name
82228567f8fSJeremy L Thompson 
82328567f8fSJeremy L Thompson   @return An error code: 0 - success, otherwise - failure
82428567f8fSJeremy L Thompson 
825e9b533fbSJeremy L Thompson   @ref Advanced
82628567f8fSJeremy L Thompson **/
82728567f8fSJeremy L Thompson int CeedOperatorFieldGetName(CeedOperatorField op_field, char **field_name) {
82828567f8fSJeremy L Thompson   *field_name = (char *)op_field->field_name;
82928567f8fSJeremy L Thompson   return CEED_ERROR_SUCCESS;
83028567f8fSJeremy L Thompson }
83128567f8fSJeremy L Thompson 
83228567f8fSJeremy L Thompson /**
83343bbe138SJeremy L Thompson   @brief Get the CeedElemRestriction of a CeedOperatorField
83443bbe138SJeremy L Thompson 
83543bbe138SJeremy L Thompson   @param op_field   CeedOperatorField
83643bbe138SJeremy L Thompson   @param[out] rstr  Variable to store CeedElemRestriction
83743bbe138SJeremy L Thompson 
83843bbe138SJeremy L Thompson   @return An error code: 0 - success, otherwise - failure
83943bbe138SJeremy L Thompson 
840e9b533fbSJeremy L Thompson   @ref Advanced
84143bbe138SJeremy L Thompson **/
84243bbe138SJeremy L Thompson int CeedOperatorFieldGetElemRestriction(CeedOperatorField op_field,
84343bbe138SJeremy L Thompson                                         CeedElemRestriction *rstr) {
84443bbe138SJeremy L Thompson   *rstr = op_field->elem_restr;
84543bbe138SJeremy L Thompson   return CEED_ERROR_SUCCESS;
84643bbe138SJeremy L Thompson }
84743bbe138SJeremy L Thompson 
84843bbe138SJeremy L Thompson /**
84943bbe138SJeremy L Thompson   @brief Get the CeedBasis of a CeedOperatorField
85043bbe138SJeremy L Thompson 
85143bbe138SJeremy L Thompson   @param op_field    CeedOperatorField
85243bbe138SJeremy L Thompson   @param[out] basis  Variable to store CeedBasis
85343bbe138SJeremy L Thompson 
85443bbe138SJeremy L Thompson   @return An error code: 0 - success, otherwise - failure
85543bbe138SJeremy L Thompson 
856e9b533fbSJeremy L Thompson   @ref Advanced
85743bbe138SJeremy L Thompson **/
85843bbe138SJeremy L Thompson int CeedOperatorFieldGetBasis(CeedOperatorField op_field, CeedBasis *basis) {
85943bbe138SJeremy L Thompson   *basis = op_field->basis;
86043bbe138SJeremy L Thompson   return CEED_ERROR_SUCCESS;
86143bbe138SJeremy L Thompson }
86243bbe138SJeremy L Thompson 
86343bbe138SJeremy L Thompson /**
86443bbe138SJeremy L Thompson   @brief Get the CeedVector of a CeedOperatorField
86543bbe138SJeremy L Thompson 
86643bbe138SJeremy L Thompson   @param op_field  CeedOperatorField
86743bbe138SJeremy L Thompson   @param[out] vec  Variable to store CeedVector
86843bbe138SJeremy L Thompson 
86943bbe138SJeremy L Thompson   @return An error code: 0 - success, otherwise - failure
87043bbe138SJeremy L Thompson 
871e9b533fbSJeremy L Thompson   @ref Advanced
87243bbe138SJeremy L Thompson **/
87343bbe138SJeremy L Thompson int CeedOperatorFieldGetVector(CeedOperatorField op_field, CeedVector *vec) {
87443bbe138SJeremy L Thompson   *vec = op_field->vec;
87543bbe138SJeremy L Thompson   return CEED_ERROR_SUCCESS;
87643bbe138SJeremy L Thompson }
87743bbe138SJeremy L Thompson 
87843bbe138SJeremy L Thompson /**
87952d6035fSJeremy L Thompson   @brief Add a sub-operator to a composite CeedOperator
880288c0443SJeremy L Thompson 
881d1d35e2fSjeremylt   @param[out] composite_op  Composite CeedOperator
882d1d35e2fSjeremylt   @param      sub_op        Sub-operator CeedOperator
88352d6035fSJeremy L Thompson 
88452d6035fSJeremy L Thompson   @return An error code: 0 - success, otherwise - failure
88552d6035fSJeremy L Thompson 
8867a982d89SJeremy L. Thompson   @ref User
88752d6035fSJeremy L Thompson  */
888d1d35e2fSjeremylt int CeedCompositeOperatorAddSub(CeedOperator composite_op,
889d1d35e2fSjeremylt                                 CeedOperator sub_op) {
89034359f16Sjeremylt   int ierr;
89134359f16Sjeremylt 
892f04ea552SJeremy L Thompson   if (!composite_op->is_composite)
893c042f62fSJeremy L Thompson     // LCOV_EXCL_START
894d1d35e2fSjeremylt     return CeedError(composite_op->ceed, CEED_ERROR_MINOR,
895e2f04181SAndrew T. Barker                      "CeedOperator is not a composite operator");
896c042f62fSJeremy L Thompson   // LCOV_EXCL_STOP
89752d6035fSJeremy L Thompson 
898d1d35e2fSjeremylt   if (composite_op->num_suboperators == CEED_COMPOSITE_MAX)
899c042f62fSJeremy L Thompson     // LCOV_EXCL_START
900d1d35e2fSjeremylt     return CeedError(composite_op->ceed, CEED_ERROR_UNSUPPORTED,
901d1d35e2fSjeremylt                      "Cannot add additional sub_operators");
902c042f62fSJeremy L Thompson   // LCOV_EXCL_STOP
903f04ea552SJeremy L Thompson   if (composite_op->is_immutable)
904f04ea552SJeremy L Thompson     // LCOV_EXCL_START
905f04ea552SJeremy L Thompson     return CeedError(composite_op->ceed, CEED_ERROR_MAJOR,
906f04ea552SJeremy L Thompson                      "Operator cannot be changed after set as immutable");
907f04ea552SJeremy L Thompson   // LCOV_EXCL_STOP
90852d6035fSJeremy L Thompson 
909d1d35e2fSjeremylt   composite_op->sub_operators[composite_op->num_suboperators] = sub_op;
9109560d06aSjeremylt   ierr = CeedOperatorReference(sub_op); CeedChk(ierr);
911d1d35e2fSjeremylt   composite_op->num_suboperators++;
912e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
91352d6035fSJeremy L Thompson }
91452d6035fSJeremy L Thompson 
91552d6035fSJeremy L Thompson /**
9164db537f9SJeremy L Thompson   @brief Check if a CeedOperator is ready to be used.
9174db537f9SJeremy L Thompson 
9184db537f9SJeremy L Thompson   @param[in] op  CeedOperator to check
9194db537f9SJeremy L Thompson 
9204db537f9SJeremy L Thompson   @return An error code: 0 - success, otherwise - failure
9214db537f9SJeremy L Thompson 
9224db537f9SJeremy L Thompson   @ref User
9234db537f9SJeremy L Thompson **/
9244db537f9SJeremy L Thompson int CeedOperatorCheckReady(CeedOperator op) {
9254db537f9SJeremy L Thompson   int ierr;
9264db537f9SJeremy L Thompson   Ceed ceed;
9274db537f9SJeremy L Thompson   ierr = CeedOperatorGetCeed(op, &ceed); CeedChk(ierr);
9284db537f9SJeremy L Thompson 
9294db537f9SJeremy L Thompson   if (op->is_interface_setup)
9304db537f9SJeremy L Thompson     return CEED_ERROR_SUCCESS;
9314db537f9SJeremy L Thompson 
9324db537f9SJeremy L Thompson   CeedQFunction qf = op->qf;
9334db537f9SJeremy L Thompson   if (op->is_composite) {
9344db537f9SJeremy L Thompson     if (!op->num_suboperators)
9354db537f9SJeremy L Thompson       // LCOV_EXCL_START
9364db537f9SJeremy L Thompson       return CeedError(ceed, CEED_ERROR_INCOMPLETE, "No sub_operators set");
9374db537f9SJeremy L Thompson     // LCOV_EXCL_STOP
9384db537f9SJeremy L Thompson     for (CeedInt i = 0; i < op->num_suboperators; i++) {
9394db537f9SJeremy L Thompson       ierr = CeedOperatorCheckReady(op->sub_operators[i]); CeedChk(ierr);
9404db537f9SJeremy L Thompson     }
9414db537f9SJeremy L Thompson   } else {
9424db537f9SJeremy L Thompson     if (op->num_fields == 0)
9434db537f9SJeremy L Thompson       // LCOV_EXCL_START
9444db537f9SJeremy L Thompson       return CeedError(ceed, CEED_ERROR_INCOMPLETE, "No operator fields set");
9454db537f9SJeremy L Thompson     // LCOV_EXCL_STOP
9464db537f9SJeremy L Thompson     if (op->num_fields < qf->num_input_fields + qf->num_output_fields)
9474db537f9SJeremy L Thompson       // LCOV_EXCL_START
9484db537f9SJeremy L Thompson       return CeedError(ceed, CEED_ERROR_INCOMPLETE, "Not all operator fields set");
9494db537f9SJeremy L Thompson     // LCOV_EXCL_STOP
9504db537f9SJeremy L Thompson     if (!op->has_restriction)
9514db537f9SJeremy L Thompson       // LCOV_EXCL_START
9524db537f9SJeremy L Thompson       return CeedError(ceed, CEED_ERROR_INCOMPLETE,
9534db537f9SJeremy L Thompson                        "At least one restriction required");
9544db537f9SJeremy L Thompson     // LCOV_EXCL_STOP
9554db537f9SJeremy L Thompson     if (op->num_qpts == 0)
9564db537f9SJeremy L Thompson       // LCOV_EXCL_START
9574db537f9SJeremy L Thompson       return CeedError(ceed, CEED_ERROR_INCOMPLETE,
9584db537f9SJeremy L Thompson                        "At least one non-collocated basis is required "
9594db537f9SJeremy L Thompson                        "or the number of quadrature points must be set");
9604db537f9SJeremy L Thompson     // LCOV_EXCL_STOP
9614db537f9SJeremy L Thompson   }
9624db537f9SJeremy L Thompson 
9634db537f9SJeremy L Thompson   // Flag as immutable and ready
9644db537f9SJeremy L Thompson   op->is_interface_setup = true;
9654db537f9SJeremy L Thompson   if (op->qf && op->qf != CEED_QFUNCTION_NONE)
9664db537f9SJeremy L Thompson     // LCOV_EXCL_START
9674db537f9SJeremy L Thompson     op->qf->is_immutable = true;
9684db537f9SJeremy L Thompson   // LCOV_EXCL_STOP
9694db537f9SJeremy L Thompson   if (op->dqf && op->dqf != CEED_QFUNCTION_NONE)
9704db537f9SJeremy L Thompson     // LCOV_EXCL_START
9714db537f9SJeremy L Thompson     op->dqf->is_immutable = true;
9724db537f9SJeremy L Thompson   // LCOV_EXCL_STOP
9734db537f9SJeremy L Thompson   if (op->dqfT && op->dqfT != CEED_QFUNCTION_NONE)
9744db537f9SJeremy L Thompson     // LCOV_EXCL_START
9754db537f9SJeremy L Thompson     op->dqfT->is_immutable = true;
9764db537f9SJeremy L Thompson   // LCOV_EXCL_STOP
9774db537f9SJeremy L Thompson   return CEED_ERROR_SUCCESS;
9784db537f9SJeremy L Thompson }
9794db537f9SJeremy L Thompson 
9804db537f9SJeremy L Thompson /**
981beecbf24SJeremy L Thompson   @brief Set reuse of CeedQFunction data in CeedOperatorLinearAssemble* functions.
982beecbf24SJeremy L Thompson            When `reuse_assembly_data = false` (default), the CeedQFunction associated
983beecbf24SJeremy L Thompson            with this CeedOperator is re-assembled every time a `CeedOperatorLinearAssemble*`
984beecbf24SJeremy L Thompson            function is called.
985beecbf24SJeremy L Thompson            When `reuse_assembly_data = true`, the CeedQFunction associated with
986beecbf24SJeremy L Thompson            this CeedOperator is reused between calls to
987beecbf24SJeremy L Thompson            `CeedOperatorSetQFunctionAssemblyDataUpdated`.
9888b919e6bSJeremy L Thompson 
989beecbf24SJeremy L Thompson   @param[in] op                  CeedOperator
990beecbf24SJeremy L Thompson   @param[in] reuse_assembly_data Boolean flag setting assembly data reuse
9918b919e6bSJeremy L Thompson 
9928b919e6bSJeremy L Thompson   @return An error code: 0 - success, otherwise - failure
9938b919e6bSJeremy L Thompson 
9948b919e6bSJeremy L Thompson   @ref Advanced
9958b919e6bSJeremy L Thompson **/
996beecbf24SJeremy L Thompson int CeedOperatorSetQFunctionAssemblyReuse(CeedOperator op,
997beecbf24SJeremy L Thompson     bool reuse_assembly_data) {
9988b919e6bSJeremy L Thompson   int ierr;
9998b919e6bSJeremy L Thompson   bool is_composite;
10008b919e6bSJeremy L Thompson 
10018b919e6bSJeremy L Thompson   ierr = CeedOperatorIsComposite(op, &is_composite); CeedChk(ierr);
10028b919e6bSJeremy L Thompson   if (is_composite) {
10038b919e6bSJeremy L Thompson     for (CeedInt i = 0; i < op->num_suboperators; i++) {
1004beecbf24SJeremy L Thompson       ierr = CeedOperatorSetQFunctionAssemblyReuse(op->sub_operators[i],
1005beecbf24SJeremy L Thompson              reuse_assembly_data); CeedChk(ierr);
10068b919e6bSJeremy L Thompson     }
10078b919e6bSJeremy L Thompson   } else {
1008beecbf24SJeremy L Thompson     ierr = CeedQFunctionAssemblyDataSetReuse(op->qf_assembled, reuse_assembly_data);
1009beecbf24SJeremy L Thompson     CeedChk(ierr);
1010beecbf24SJeremy L Thompson   }
1011beecbf24SJeremy L Thompson 
1012beecbf24SJeremy L Thompson   return CEED_ERROR_SUCCESS;
1013beecbf24SJeremy L Thompson }
1014beecbf24SJeremy L Thompson 
1015beecbf24SJeremy L Thompson /**
1016beecbf24SJeremy L Thompson   @brief Mark CeedQFunction data as updated and the CeedQFunction as requiring re-assembly.
1017beecbf24SJeremy L Thompson 
1018beecbf24SJeremy L Thompson   @param[in] op                  CeedOperator
1019beecbf24SJeremy L Thompson   @param[in] reuse_assembly_data Boolean flag setting assembly data reuse
1020beecbf24SJeremy L Thompson 
1021beecbf24SJeremy L Thompson   @return An error code: 0 - success, otherwise - failure
1022beecbf24SJeremy L Thompson 
1023beecbf24SJeremy L Thompson   @ref Advanced
1024beecbf24SJeremy L Thompson **/
1025beecbf24SJeremy L Thompson int CeedOperatorSetQFunctionAssemblyDataUpdateNeeded(CeedOperator op,
1026beecbf24SJeremy L Thompson     bool needs_data_update) {
1027beecbf24SJeremy L Thompson   int ierr;
1028beecbf24SJeremy L Thompson   bool is_composite;
1029beecbf24SJeremy L Thompson 
1030beecbf24SJeremy L Thompson   ierr = CeedOperatorIsComposite(op, &is_composite); CeedChk(ierr);
1031beecbf24SJeremy L Thompson   if (is_composite) {
1032beecbf24SJeremy L Thompson     for (CeedInt i = 0; i < op->num_suboperators; i++) {
1033beecbf24SJeremy L Thompson       ierr = CeedOperatorSetQFunctionAssemblyDataUpdateNeeded(op->sub_operators[i],
1034beecbf24SJeremy L Thompson              needs_data_update); CeedChk(ierr);
1035beecbf24SJeremy L Thompson     }
1036beecbf24SJeremy L Thompson   } else {
1037beecbf24SJeremy L Thompson     ierr = CeedQFunctionAssemblyDataSetUpdateNeeded(op->qf_assembled,
1038beecbf24SJeremy L Thompson            needs_data_update);
10398b919e6bSJeremy L Thompson     CeedChk(ierr);
10408b919e6bSJeremy L Thompson   }
10418b919e6bSJeremy L Thompson 
10428b919e6bSJeremy L Thompson   return CEED_ERROR_SUCCESS;
10438b919e6bSJeremy L Thompson }
10448b919e6bSJeremy L Thompson 
10458b919e6bSJeremy L Thompson /**
1046cd4dfc48Sjeremylt   @brief Set the number of quadrature points associated with a CeedOperator.
1047cd4dfc48Sjeremylt            This should be used when creating a CeedOperator where every
1048cd4dfc48Sjeremylt            field has a collocated basis. This function cannot be used for
1049cd4dfc48Sjeremylt            composite CeedOperators.
1050cd4dfc48Sjeremylt 
1051cd4dfc48Sjeremylt   @param op        CeedOperator
1052cd4dfc48Sjeremylt   @param num_qpts  Number of quadrature points to set
1053cd4dfc48Sjeremylt 
1054cd4dfc48Sjeremylt   @return An error code: 0 - success, otherwise - failure
1055cd4dfc48Sjeremylt 
1056e9b533fbSJeremy L Thompson   @ref Advanced
1057cd4dfc48Sjeremylt **/
1058cd4dfc48Sjeremylt int CeedOperatorSetNumQuadraturePoints(CeedOperator op, CeedInt num_qpts) {
1059f04ea552SJeremy L Thompson   if (op->is_composite)
1060cd4dfc48Sjeremylt     // LCOV_EXCL_START
1061cd4dfc48Sjeremylt     return CeedError(op->ceed, CEED_ERROR_MINOR,
1062cd4dfc48Sjeremylt                      "Not defined for composite operator");
1063cd4dfc48Sjeremylt   // LCOV_EXCL_STOP
1064cd4dfc48Sjeremylt   if (op->num_qpts)
1065cd4dfc48Sjeremylt     // LCOV_EXCL_START
1066cd4dfc48Sjeremylt     return CeedError(op->ceed, CEED_ERROR_MINOR,
1067cd4dfc48Sjeremylt                      "Number of quadrature points already defined");
1068cd4dfc48Sjeremylt   // LCOV_EXCL_STOP
1069f04ea552SJeremy L Thompson   if (op->is_immutable)
1070f04ea552SJeremy L Thompson     // LCOV_EXCL_START
1071f04ea552SJeremy L Thompson     return CeedError(op->ceed, CEED_ERROR_MAJOR,
1072f04ea552SJeremy L Thompson                      "Operator cannot be changed after set as immutable");
1073f04ea552SJeremy L Thompson   // LCOV_EXCL_STOP
1074cd4dfc48Sjeremylt 
1075cd4dfc48Sjeremylt   op->num_qpts = num_qpts;
1076cd4dfc48Sjeremylt   return CEED_ERROR_SUCCESS;
1077cd4dfc48Sjeremylt }
1078cd4dfc48Sjeremylt 
1079cd4dfc48Sjeremylt /**
10807a982d89SJeremy L. Thompson   @brief View a CeedOperator
10817a982d89SJeremy L. Thompson 
10827a982d89SJeremy L. Thompson   @param[in] op      CeedOperator to view
10837a982d89SJeremy L. Thompson   @param[in] stream  Stream to write; typically stdout/stderr or a file
10847a982d89SJeremy L. Thompson 
10857a982d89SJeremy L. Thompson   @return Error code: 0 - success, otherwise - failure
10867a982d89SJeremy L. Thompson 
10877a982d89SJeremy L. Thompson   @ref User
10887a982d89SJeremy L. Thompson **/
10897a982d89SJeremy L. Thompson int CeedOperatorView(CeedOperator op, FILE *stream) {
10907a982d89SJeremy L. Thompson   int ierr;
10917a982d89SJeremy L. Thompson 
1092f04ea552SJeremy L Thompson   if (op->is_composite) {
10937a982d89SJeremy L. Thompson     fprintf(stream, "Composite CeedOperator\n");
10947a982d89SJeremy L. Thompson 
1095d1d35e2fSjeremylt     for (CeedInt i=0; i<op->num_suboperators; i++) {
10967a982d89SJeremy L. Thompson       fprintf(stream, "  SubOperator [%d]:\n", i);
1097d1d35e2fSjeremylt       ierr = CeedOperatorSingleView(op->sub_operators[i], 1, stream);
10987a982d89SJeremy L. Thompson       CeedChk(ierr);
10997a982d89SJeremy L. Thompson     }
11007a982d89SJeremy L. Thompson   } else {
11017a982d89SJeremy L. Thompson     fprintf(stream, "CeedOperator\n");
11027a982d89SJeremy L. Thompson     ierr = CeedOperatorSingleView(op, 0, stream); CeedChk(ierr);
11037a982d89SJeremy L. Thompson   }
1104e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
11057a982d89SJeremy L. Thompson }
11063bd813ffSjeremylt 
11073bd813ffSjeremylt /**
1108b7c9bbdaSJeremy L Thompson   @brief Get the Ceed associated with a CeedOperator
1109b7c9bbdaSJeremy L Thompson 
1110b7c9bbdaSJeremy L Thompson   @param op         CeedOperator
1111b7c9bbdaSJeremy L Thompson   @param[out] ceed  Variable to store Ceed
1112b7c9bbdaSJeremy L Thompson 
1113b7c9bbdaSJeremy L Thompson   @return An error code: 0 - success, otherwise - failure
1114b7c9bbdaSJeremy L Thompson 
1115b7c9bbdaSJeremy L Thompson   @ref Advanced
1116b7c9bbdaSJeremy L Thompson **/
1117b7c9bbdaSJeremy L Thompson int CeedOperatorGetCeed(CeedOperator op, Ceed *ceed) {
1118b7c9bbdaSJeremy L Thompson   *ceed = op->ceed;
1119b7c9bbdaSJeremy L Thompson   return CEED_ERROR_SUCCESS;
1120b7c9bbdaSJeremy L Thompson }
1121b7c9bbdaSJeremy L Thompson 
1122b7c9bbdaSJeremy L Thompson /**
1123b7c9bbdaSJeremy L Thompson   @brief Get the number of elements associated with a CeedOperator
1124b7c9bbdaSJeremy L Thompson 
1125b7c9bbdaSJeremy L Thompson   @param op             CeedOperator
1126b7c9bbdaSJeremy L Thompson   @param[out] num_elem  Variable to store number of elements
1127b7c9bbdaSJeremy L Thompson 
1128b7c9bbdaSJeremy L Thompson   @return An error code: 0 - success, otherwise - failure
1129b7c9bbdaSJeremy L Thompson 
1130b7c9bbdaSJeremy L Thompson   @ref Advanced
1131b7c9bbdaSJeremy L Thompson **/
1132b7c9bbdaSJeremy L Thompson int CeedOperatorGetNumElements(CeedOperator op, CeedInt *num_elem) {
1133b7c9bbdaSJeremy L Thompson   if (op->is_composite)
1134b7c9bbdaSJeremy L Thompson     // LCOV_EXCL_START
1135b7c9bbdaSJeremy L Thompson     return CeedError(op->ceed, CEED_ERROR_MINOR,
1136b7c9bbdaSJeremy L Thompson                      "Not defined for composite operator");
1137b7c9bbdaSJeremy L Thompson   // LCOV_EXCL_STOP
1138b7c9bbdaSJeremy L Thompson 
1139b7c9bbdaSJeremy L Thompson   *num_elem = op->num_elem;
1140b7c9bbdaSJeremy L Thompson   return CEED_ERROR_SUCCESS;
1141b7c9bbdaSJeremy L Thompson }
1142b7c9bbdaSJeremy L Thompson 
1143b7c9bbdaSJeremy L Thompson /**
1144b7c9bbdaSJeremy L Thompson   @brief Get the number of quadrature points associated with a CeedOperator
1145b7c9bbdaSJeremy L Thompson 
1146b7c9bbdaSJeremy L Thompson   @param op             CeedOperator
1147b7c9bbdaSJeremy L Thompson   @param[out] num_qpts  Variable to store vector number of quadrature points
1148b7c9bbdaSJeremy L Thompson 
1149b7c9bbdaSJeremy L Thompson   @return An error code: 0 - success, otherwise - failure
1150b7c9bbdaSJeremy L Thompson 
1151b7c9bbdaSJeremy L Thompson   @ref Advanced
1152b7c9bbdaSJeremy L Thompson **/
1153b7c9bbdaSJeremy L Thompson int CeedOperatorGetNumQuadraturePoints(CeedOperator op, CeedInt *num_qpts) {
1154b7c9bbdaSJeremy L Thompson   if (op->is_composite)
1155b7c9bbdaSJeremy L Thompson     // LCOV_EXCL_START
1156b7c9bbdaSJeremy L Thompson     return CeedError(op->ceed, CEED_ERROR_MINOR,
1157b7c9bbdaSJeremy L Thompson                      "Not defined for composite operator");
1158b7c9bbdaSJeremy L Thompson   // LCOV_EXCL_STOP
1159b7c9bbdaSJeremy L Thompson 
1160b7c9bbdaSJeremy L Thompson   *num_qpts = op->num_qpts;
1161b7c9bbdaSJeremy L Thompson   return CEED_ERROR_SUCCESS;
1162b7c9bbdaSJeremy L Thompson }
1163b7c9bbdaSJeremy L Thompson 
1164b7c9bbdaSJeremy L Thompson /**
11653668ca4bSJeremy L Thompson   @brief Get label for a registered QFunctionContext field, or `NULL` if no
11663668ca4bSJeremy L Thompson            field has been registered with this `field_name`.
11673668ca4bSJeremy L Thompson 
11683668ca4bSJeremy L Thompson   @param[in] op            CeedOperator
11693668ca4bSJeremy L Thompson   @param[in] field_name    Name of field to retrieve label
11703668ca4bSJeremy L Thompson   @param[out] field_label  Variable to field label
11713668ca4bSJeremy L Thompson 
11723668ca4bSJeremy L Thompson   @return An error code: 0 - success, otherwise - failure
11733668ca4bSJeremy L Thompson 
11743668ca4bSJeremy L Thompson   @ref User
11753668ca4bSJeremy L Thompson **/
11763668ca4bSJeremy L Thompson int CeedOperatorContextGetFieldLabel(CeedOperator op,
11773668ca4bSJeremy L Thompson                                      const char *field_name,
11783668ca4bSJeremy L Thompson                                      CeedContextFieldLabel *field_label) {
11793668ca4bSJeremy L Thompson   int ierr;
11803668ca4bSJeremy L Thompson 
11813668ca4bSJeremy L Thompson   bool is_composite;
11823668ca4bSJeremy L Thompson   ierr = CeedOperatorIsComposite(op, &is_composite); CeedChk(ierr);
11833668ca4bSJeremy L Thompson   if (is_composite) {
11843668ca4bSJeremy L Thompson     // Check if composite label already created
11853668ca4bSJeremy L Thompson     for (CeedInt i=0; i<op->num_context_labels; i++) {
11863668ca4bSJeremy L Thompson       if (!strcmp(op->context_labels[i]->name, field_name)) {
11873668ca4bSJeremy L Thompson         *field_label = op->context_labels[i];
11883668ca4bSJeremy L Thompson         return CEED_ERROR_SUCCESS;
11893668ca4bSJeremy L Thompson       }
11903668ca4bSJeremy L Thompson     }
11913668ca4bSJeremy L Thompson 
11923668ca4bSJeremy L Thompson     // Create composite label if needed
11933668ca4bSJeremy L Thompson     CeedInt num_sub;
11943668ca4bSJeremy L Thompson     CeedOperator *sub_operators;
11953668ca4bSJeremy L Thompson     CeedContextFieldLabel new_field_label;
11963668ca4bSJeremy L Thompson 
11973668ca4bSJeremy L Thompson     ierr = CeedCalloc(1, &new_field_label); CeedChk(ierr);
11983668ca4bSJeremy L Thompson     ierr = CeedOperatorGetNumSub(op, &num_sub); CeedChk(ierr);
11993668ca4bSJeremy L Thompson     ierr = CeedOperatorGetSubList(op, &sub_operators); CeedChk(ierr);
12003668ca4bSJeremy L Thompson     ierr = CeedCalloc(num_sub, &new_field_label->sub_labels); CeedChk(ierr);
12013668ca4bSJeremy L Thompson     new_field_label->num_sub_labels = num_sub;
12023668ca4bSJeremy L Thompson 
12033668ca4bSJeremy L Thompson     bool label_found = false;
12043668ca4bSJeremy L Thompson     for (CeedInt i=0; i<num_sub; i++) {
12053668ca4bSJeremy L Thompson       if (sub_operators[i]->qf->ctx) {
12063668ca4bSJeremy L Thompson         CeedContextFieldLabel new_field_label_i;
12073668ca4bSJeremy L Thompson         ierr = CeedQFunctionContextGetFieldLabel(sub_operators[i]->qf->ctx, field_name,
12083668ca4bSJeremy L Thompson                &new_field_label_i); CeedChk(ierr);
12093668ca4bSJeremy L Thompson         if (new_field_label_i) {
12103668ca4bSJeremy L Thompson           label_found = true;
12113668ca4bSJeremy L Thompson           new_field_label->sub_labels[i] = new_field_label_i;
12123668ca4bSJeremy L Thompson           new_field_label->name = new_field_label_i->name;
12133668ca4bSJeremy L Thompson           new_field_label->description = new_field_label_i->description;
12147bfe0f0eSJeremy L Thompson           if (new_field_label->type &&
12157bfe0f0eSJeremy L Thompson               new_field_label->type != new_field_label_i->type) {
12167bfe0f0eSJeremy L Thompson             // LCOV_EXCL_START
12177bfe0f0eSJeremy L Thompson             ierr = CeedFree(&new_field_label); CeedChk(ierr);
12187bfe0f0eSJeremy L Thompson             return CeedError(op->ceed, CEED_ERROR_INCOMPATIBLE,
12197bfe0f0eSJeremy L Thompson                              "Incompatible field types on sub-operator contexts. "
12207bfe0f0eSJeremy L Thompson                              "%s != %s",
12217bfe0f0eSJeremy L Thompson                              CeedContextFieldTypes[new_field_label->type],
12227bfe0f0eSJeremy L Thompson                              CeedContextFieldTypes[new_field_label_i->type]);
12237bfe0f0eSJeremy L Thompson             // LCOV_EXCL_STOP
12247bfe0f0eSJeremy L Thompson           } else {
12257bfe0f0eSJeremy L Thompson             new_field_label->type = new_field_label_i->type;
12267bfe0f0eSJeremy L Thompson           }
12277bfe0f0eSJeremy L Thompson           if (new_field_label->num_values != 0 &&
12287bfe0f0eSJeremy L Thompson               new_field_label->num_values != new_field_label_i->num_values) {
12297bfe0f0eSJeremy L Thompson             // LCOV_EXCL_START
12307bfe0f0eSJeremy L Thompson             ierr = CeedFree(&new_field_label); CeedChk(ierr);
12317bfe0f0eSJeremy L Thompson             return CeedError(op->ceed, CEED_ERROR_INCOMPATIBLE,
12327bfe0f0eSJeremy L Thompson                              "Incompatible field number of values on sub-operator"
12337bfe0f0eSJeremy L Thompson                              " contexts. %ld != %ld",
12347bfe0f0eSJeremy L Thompson                              new_field_label->num_values, new_field_label_i->num_values);
12357bfe0f0eSJeremy L Thompson             // LCOV_EXCL_STOP
12367bfe0f0eSJeremy L Thompson           } else {
12377bfe0f0eSJeremy L Thompson             new_field_label->num_values = new_field_label_i->num_values;
12387bfe0f0eSJeremy L Thompson           }
12393668ca4bSJeremy L Thompson         }
12403668ca4bSJeremy L Thompson       }
12413668ca4bSJeremy L Thompson     }
12423668ca4bSJeremy L Thompson     if (!label_found) {
12433668ca4bSJeremy L Thompson       // LCOV_EXCL_START
1244a48e5f43SJeremy L Thompson       ierr = CeedFree(&new_field_label->sub_labels); CeedChk(ierr);
12453668ca4bSJeremy L Thompson       ierr = CeedFree(&new_field_label); CeedChk(ierr);
12463668ca4bSJeremy L Thompson       *field_label = NULL;
12473668ca4bSJeremy L Thompson       // LCOV_EXCL_STOP
12483668ca4bSJeremy L Thompson     } else {
12493668ca4bSJeremy L Thompson       // Move new composite label to operator
12503668ca4bSJeremy L Thompson       if (op->num_context_labels == 0) {
12513668ca4bSJeremy L Thompson         ierr = CeedCalloc(1, &op->context_labels); CeedChk(ierr);
12523668ca4bSJeremy L Thompson         op->max_context_labels = 1;
12533668ca4bSJeremy L Thompson       } else if (op->num_context_labels == op->max_context_labels) {
12543668ca4bSJeremy L Thompson         ierr = CeedRealloc(2*op->num_context_labels, &op->context_labels);
12553668ca4bSJeremy L Thompson         CeedChk(ierr);
12563668ca4bSJeremy L Thompson         op->max_context_labels *= 2;
12573668ca4bSJeremy L Thompson       }
12583668ca4bSJeremy L Thompson       op->context_labels[op->num_context_labels] = new_field_label;
12593668ca4bSJeremy L Thompson       *field_label = new_field_label;
12603668ca4bSJeremy L Thompson       op->num_context_labels++;
12613668ca4bSJeremy L Thompson     }
12623668ca4bSJeremy L Thompson 
12633668ca4bSJeremy L Thompson     return CEED_ERROR_SUCCESS;
12643668ca4bSJeremy L Thompson   } else {
12653668ca4bSJeremy L Thompson     return CeedQFunctionContextGetFieldLabel(op->qf->ctx, field_name, field_label);
12663668ca4bSJeremy L Thompson   }
12673668ca4bSJeremy L Thompson }
12683668ca4bSJeremy L Thompson 
12693668ca4bSJeremy L Thompson /**
1270d8dd9a91SJeremy L Thompson   @brief Set QFunctionContext field holding a double precision value.
1271d8dd9a91SJeremy L Thompson            For composite operators, the value is set in all
1272d8dd9a91SJeremy L Thompson            sub-operator QFunctionContexts that have a matching `field_name`.
1273d8dd9a91SJeremy L Thompson 
1274d8dd9a91SJeremy L Thompson   @param op          CeedOperator
12753668ca4bSJeremy L Thompson   @param field_label Label of field to register
12767bfe0f0eSJeremy L Thompson   @param values      Values to set
1277d8dd9a91SJeremy L Thompson 
1278d8dd9a91SJeremy L Thompson   @return An error code: 0 - success, otherwise - failure
1279d8dd9a91SJeremy L Thompson 
1280d8dd9a91SJeremy L Thompson   @ref User
1281d8dd9a91SJeremy L Thompson **/
12823668ca4bSJeremy L Thompson int CeedOperatorContextSetDouble(CeedOperator op,
12833668ca4bSJeremy L Thompson                                  CeedContextFieldLabel field_label,
12847bfe0f0eSJeremy L Thompson                                  double *values) {
12853668ca4bSJeremy L Thompson   return CeedOperatorContextSetGeneric(op, field_label, CEED_CONTEXT_FIELD_DOUBLE,
12867bfe0f0eSJeremy L Thompson                                        values);
1287d8dd9a91SJeremy L Thompson }
1288d8dd9a91SJeremy L Thompson 
1289d8dd9a91SJeremy L Thompson /**
1290d8dd9a91SJeremy L Thompson   @brief Set QFunctionContext field holding an int32 value.
1291d8dd9a91SJeremy L Thompson            For composite operators, the value is set in all
1292d8dd9a91SJeremy L Thompson            sub-operator QFunctionContexts that have a matching `field_name`.
1293d8dd9a91SJeremy L Thompson 
1294d8dd9a91SJeremy L Thompson   @param op          CeedOperator
12953668ca4bSJeremy L Thompson   @param field_label Label of field to set
12967bfe0f0eSJeremy L Thompson   @param values      Values to set
1297d8dd9a91SJeremy L Thompson 
1298d8dd9a91SJeremy L Thompson   @return An error code: 0 - success, otherwise - failure
1299d8dd9a91SJeremy L Thompson 
1300d8dd9a91SJeremy L Thompson   @ref User
1301d8dd9a91SJeremy L Thompson **/
13023668ca4bSJeremy L Thompson int CeedOperatorContextSetInt32(CeedOperator op,
13033668ca4bSJeremy L Thompson                                 CeedContextFieldLabel field_label,
13047bfe0f0eSJeremy L Thompson                                 int *values) {
13053668ca4bSJeremy L Thompson   return CeedOperatorContextSetGeneric(op, field_label, CEED_CONTEXT_FIELD_INT32,
13067bfe0f0eSJeremy L Thompson                                        values);
1307d8dd9a91SJeremy L Thompson }
1308d8dd9a91SJeremy L Thompson 
1309d8dd9a91SJeremy L Thompson /**
13103bd813ffSjeremylt   @brief Apply CeedOperator to a vector
1311d7b241e6Sjeremylt 
1312d7b241e6Sjeremylt   This computes the action of the operator on the specified (active) input,
1313d7b241e6Sjeremylt   yielding its (active) output.  All inputs and outputs must be specified using
1314d7b241e6Sjeremylt   CeedOperatorSetField().
1315d7b241e6Sjeremylt 
1316f04ea552SJeremy L Thompson   Note: Calling this function asserts that setup is complete
1317f04ea552SJeremy L Thompson           and sets the CeedOperator as immutable.
1318f04ea552SJeremy L Thompson 
1319d7b241e6Sjeremylt   @param op        CeedOperator to apply
13204cc79fe7SJed Brown   @param[in] in    CeedVector containing input state or @ref CEED_VECTOR_NONE if
132134138859Sjeremylt                      there are no active inputs
1322b11c1e72Sjeremylt   @param[out] out  CeedVector to store result of applying operator (must be
13234cc79fe7SJed Brown                      distinct from @a in) or @ref CEED_VECTOR_NONE if there are no
132434138859Sjeremylt                      active outputs
1325d7b241e6Sjeremylt   @param request   Address of CeedRequest for non-blocking completion, else
13264cc79fe7SJed Brown                      @ref CEED_REQUEST_IMMEDIATE
1327b11c1e72Sjeremylt 
1328b11c1e72Sjeremylt   @return An error code: 0 - success, otherwise - failure
1329dfdf5a53Sjeremylt 
13307a982d89SJeremy L. Thompson   @ref User
1331b11c1e72Sjeremylt **/
1332692c2638Sjeremylt int CeedOperatorApply(CeedOperator op, CeedVector in, CeedVector out,
1333692c2638Sjeremylt                       CeedRequest *request) {
1334d7b241e6Sjeremylt   int ierr;
1335e2f04181SAndrew T. Barker   ierr = CeedOperatorCheckReady(op); CeedChk(ierr);
1336d7b241e6Sjeremylt 
1337d1d35e2fSjeremylt   if (op->num_elem)  {
1338250756a7Sjeremylt     // Standard Operator
1339cae8b89aSjeremylt     if (op->Apply) {
1340250756a7Sjeremylt       ierr = op->Apply(op, in, out, request); CeedChk(ierr);
1341cae8b89aSjeremylt     } else {
1342cae8b89aSjeremylt       // Zero all output vectors
1343250756a7Sjeremylt       CeedQFunction qf = op->qf;
1344d1d35e2fSjeremylt       for (CeedInt i=0; i<qf->num_output_fields; i++) {
1345d1d35e2fSjeremylt         CeedVector vec = op->output_fields[i]->vec;
1346cae8b89aSjeremylt         if (vec == CEED_VECTOR_ACTIVE)
1347cae8b89aSjeremylt           vec = out;
1348cae8b89aSjeremylt         if (vec != CEED_VECTOR_NONE) {
1349cae8b89aSjeremylt           ierr = CeedVectorSetValue(vec, 0.0); CeedChk(ierr);
1350cae8b89aSjeremylt         }
1351cae8b89aSjeremylt       }
1352250756a7Sjeremylt       // Apply
1353250756a7Sjeremylt       ierr = op->ApplyAdd(op, in, out, request); CeedChk(ierr);
1354250756a7Sjeremylt     }
1355f04ea552SJeremy L Thompson   } else if (op->is_composite) {
1356250756a7Sjeremylt     // Composite Operator
1357250756a7Sjeremylt     if (op->ApplyComposite) {
1358250756a7Sjeremylt       ierr = op->ApplyComposite(op, in, out, request); CeedChk(ierr);
1359250756a7Sjeremylt     } else {
1360d1d35e2fSjeremylt       CeedInt num_suboperators;
1361d1d35e2fSjeremylt       ierr = CeedOperatorGetNumSub(op, &num_suboperators); CeedChk(ierr);
1362d1d35e2fSjeremylt       CeedOperator *sub_operators;
1363d1d35e2fSjeremylt       ierr = CeedOperatorGetSubList(op, &sub_operators); CeedChk(ierr);
1364250756a7Sjeremylt 
1365250756a7Sjeremylt       // Zero all output vectors
1366250756a7Sjeremylt       if (out != CEED_VECTOR_NONE) {
1367cae8b89aSjeremylt         ierr = CeedVectorSetValue(out, 0.0); CeedChk(ierr);
1368cae8b89aSjeremylt       }
1369d1d35e2fSjeremylt       for (CeedInt i=0; i<num_suboperators; i++) {
1370d1d35e2fSjeremylt         for (CeedInt j=0; j<sub_operators[i]->qf->num_output_fields; j++) {
1371d1d35e2fSjeremylt           CeedVector vec = sub_operators[i]->output_fields[j]->vec;
1372250756a7Sjeremylt           if (vec != CEED_VECTOR_ACTIVE && vec != CEED_VECTOR_NONE) {
1373250756a7Sjeremylt             ierr = CeedVectorSetValue(vec, 0.0); CeedChk(ierr);
1374250756a7Sjeremylt           }
1375250756a7Sjeremylt         }
1376250756a7Sjeremylt       }
1377250756a7Sjeremylt       // Apply
1378d1d35e2fSjeremylt       for (CeedInt i=0; i<op->num_suboperators; i++) {
1379d1d35e2fSjeremylt         ierr = CeedOperatorApplyAdd(op->sub_operators[i], in, out, request);
1380cae8b89aSjeremylt         CeedChk(ierr);
1381cae8b89aSjeremylt       }
1382cae8b89aSjeremylt     }
1383250756a7Sjeremylt   }
1384e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
1385cae8b89aSjeremylt }
1386cae8b89aSjeremylt 
1387cae8b89aSjeremylt /**
1388cae8b89aSjeremylt   @brief Apply CeedOperator to a vector and add result to output vector
1389cae8b89aSjeremylt 
1390cae8b89aSjeremylt   This computes the action of the operator on the specified (active) input,
1391cae8b89aSjeremylt   yielding its (active) output.  All inputs and outputs must be specified using
1392cae8b89aSjeremylt   CeedOperatorSetField().
1393cae8b89aSjeremylt 
1394cae8b89aSjeremylt   @param op        CeedOperator to apply
1395cae8b89aSjeremylt   @param[in] in    CeedVector containing input state or NULL if there are no
1396cae8b89aSjeremylt                      active inputs
1397cae8b89aSjeremylt   @param[out] out  CeedVector to sum in result of applying operator (must be
1398cae8b89aSjeremylt                      distinct from @a in) or NULL if there are no active outputs
1399cae8b89aSjeremylt   @param request   Address of CeedRequest for non-blocking completion, else
14004cc79fe7SJed Brown                      @ref CEED_REQUEST_IMMEDIATE
1401cae8b89aSjeremylt 
1402cae8b89aSjeremylt   @return An error code: 0 - success, otherwise - failure
1403cae8b89aSjeremylt 
14047a982d89SJeremy L. Thompson   @ref User
1405cae8b89aSjeremylt **/
1406cae8b89aSjeremylt int CeedOperatorApplyAdd(CeedOperator op, CeedVector in, CeedVector out,
1407cae8b89aSjeremylt                          CeedRequest *request) {
1408cae8b89aSjeremylt   int ierr;
1409e2f04181SAndrew T. Barker   ierr = CeedOperatorCheckReady(op); CeedChk(ierr);
1410cae8b89aSjeremylt 
1411d1d35e2fSjeremylt   if (op->num_elem)  {
1412250756a7Sjeremylt     // Standard Operator
1413250756a7Sjeremylt     ierr = op->ApplyAdd(op, in, out, request); CeedChk(ierr);
1414f04ea552SJeremy L Thompson   } else if (op->is_composite) {
1415250756a7Sjeremylt     // Composite Operator
1416250756a7Sjeremylt     if (op->ApplyAddComposite) {
1417250756a7Sjeremylt       ierr = op->ApplyAddComposite(op, in, out, request); CeedChk(ierr);
1418cae8b89aSjeremylt     } else {
1419d1d35e2fSjeremylt       CeedInt num_suboperators;
1420d1d35e2fSjeremylt       ierr = CeedOperatorGetNumSub(op, &num_suboperators); CeedChk(ierr);
1421d1d35e2fSjeremylt       CeedOperator *sub_operators;
1422d1d35e2fSjeremylt       ierr = CeedOperatorGetSubList(op, &sub_operators); CeedChk(ierr);
1423250756a7Sjeremylt 
1424d1d35e2fSjeremylt       for (CeedInt i=0; i<num_suboperators; i++) {
1425d1d35e2fSjeremylt         ierr = CeedOperatorApplyAdd(sub_operators[i], in, out, request);
1426cae8b89aSjeremylt         CeedChk(ierr);
14271d7d2407SJeremy L Thompson       }
1428250756a7Sjeremylt     }
1429250756a7Sjeremylt   }
1430e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
1431d7b241e6Sjeremylt }
1432d7b241e6Sjeremylt 
1433d7b241e6Sjeremylt /**
1434b11c1e72Sjeremylt   @brief Destroy a CeedOperator
1435d7b241e6Sjeremylt 
1436d7b241e6Sjeremylt   @param op  CeedOperator to destroy
1437b11c1e72Sjeremylt 
1438b11c1e72Sjeremylt   @return An error code: 0 - success, otherwise - failure
1439dfdf5a53Sjeremylt 
14407a982d89SJeremy L. Thompson   @ref User
1441b11c1e72Sjeremylt **/
1442d7b241e6Sjeremylt int CeedOperatorDestroy(CeedOperator *op) {
1443d7b241e6Sjeremylt   int ierr;
1444d7b241e6Sjeremylt 
1445d1d35e2fSjeremylt   if (!*op || --(*op)->ref_count > 0) return CEED_ERROR_SUCCESS;
1446d7b241e6Sjeremylt   if ((*op)->Destroy) {
1447d7b241e6Sjeremylt     ierr = (*op)->Destroy(*op); CeedChk(ierr);
1448d7b241e6Sjeremylt   }
1449fe2413ffSjeremylt   ierr = CeedDestroy(&(*op)->ceed); CeedChk(ierr);
1450fe2413ffSjeremylt   // Free fields
14513668ca4bSJeremy L Thompson   for (CeedInt i=0; i<(*op)->num_fields; i++)
1452d1d35e2fSjeremylt     if ((*op)->input_fields[i]) {
1453d1d35e2fSjeremylt       if ((*op)->input_fields[i]->elem_restr != CEED_ELEMRESTRICTION_NONE) {
1454d1d35e2fSjeremylt         ierr = CeedElemRestrictionDestroy(&(*op)->input_fields[i]->elem_restr);
145571352a93Sjeremylt         CeedChk(ierr);
145615910d16Sjeremylt       }
1457d1d35e2fSjeremylt       if ((*op)->input_fields[i]->basis != CEED_BASIS_COLLOCATED) {
1458d1d35e2fSjeremylt         ierr = CeedBasisDestroy(&(*op)->input_fields[i]->basis); CeedChk(ierr);
145971352a93Sjeremylt       }
1460d1d35e2fSjeremylt       if ((*op)->input_fields[i]->vec != CEED_VECTOR_ACTIVE &&
1461d1d35e2fSjeremylt           (*op)->input_fields[i]->vec != CEED_VECTOR_NONE ) {
1462d1d35e2fSjeremylt         ierr = CeedVectorDestroy(&(*op)->input_fields[i]->vec); CeedChk(ierr);
146371352a93Sjeremylt       }
1464d1d35e2fSjeremylt       ierr = CeedFree(&(*op)->input_fields[i]->field_name); CeedChk(ierr);
1465d1d35e2fSjeremylt       ierr = CeedFree(&(*op)->input_fields[i]); CeedChk(ierr);
1466fe2413ffSjeremylt     }
14673668ca4bSJeremy L Thompson   for (CeedInt i=0; i<(*op)->num_fields; i++)
1468d1d35e2fSjeremylt     if ((*op)->output_fields[i]) {
1469d1d35e2fSjeremylt       ierr = CeedElemRestrictionDestroy(&(*op)->output_fields[i]->elem_restr);
147071352a93Sjeremylt       CeedChk(ierr);
1471d1d35e2fSjeremylt       if ((*op)->output_fields[i]->basis != CEED_BASIS_COLLOCATED) {
1472d1d35e2fSjeremylt         ierr = CeedBasisDestroy(&(*op)->output_fields[i]->basis); CeedChk(ierr);
147371352a93Sjeremylt       }
1474d1d35e2fSjeremylt       if ((*op)->output_fields[i]->vec != CEED_VECTOR_ACTIVE &&
1475d1d35e2fSjeremylt           (*op)->output_fields[i]->vec != CEED_VECTOR_NONE ) {
1476d1d35e2fSjeremylt         ierr = CeedVectorDestroy(&(*op)->output_fields[i]->vec); CeedChk(ierr);
147771352a93Sjeremylt       }
1478d1d35e2fSjeremylt       ierr = CeedFree(&(*op)->output_fields[i]->field_name); CeedChk(ierr);
1479d1d35e2fSjeremylt       ierr = CeedFree(&(*op)->output_fields[i]); CeedChk(ierr);
1480fe2413ffSjeremylt     }
1481d1d35e2fSjeremylt   // Destroy sub_operators
14823668ca4bSJeremy L Thompson   for (CeedInt i=0; i<(*op)->num_suboperators; i++)
1483d1d35e2fSjeremylt     if ((*op)->sub_operators[i]) {
1484d1d35e2fSjeremylt       ierr = CeedOperatorDestroy(&(*op)->sub_operators[i]); CeedChk(ierr);
148552d6035fSJeremy L Thompson     }
1486d7b241e6Sjeremylt   ierr = CeedQFunctionDestroy(&(*op)->qf); CeedChk(ierr);
1487d7b241e6Sjeremylt   ierr = CeedQFunctionDestroy(&(*op)->dqf); CeedChk(ierr);
1488d7b241e6Sjeremylt   ierr = CeedQFunctionDestroy(&(*op)->dqfT); CeedChk(ierr);
14893668ca4bSJeremy L Thompson   // Destroy any composite labels
14903668ca4bSJeremy L Thompson   for (CeedInt i=0; i<(*op)->num_context_labels; i++) {
14913668ca4bSJeremy L Thompson     ierr = CeedFree(&(*op)->context_labels[i]->sub_labels); CeedChk(ierr);
14923668ca4bSJeremy L Thompson     ierr = CeedFree(&(*op)->context_labels[i]); CeedChk(ierr);
14933668ca4bSJeremy L Thompson   }
14943668ca4bSJeremy L Thompson   ierr = CeedFree(&(*op)->context_labels); CeedChk(ierr);
1495fe2413ffSjeremylt 
14965107b09fSJeremy L Thompson   // Destroy fallback
1497d1d35e2fSjeremylt   if ((*op)->op_fallback) {
1498d1d35e2fSjeremylt     ierr = (*op)->qf_fallback->Destroy((*op)->qf_fallback); CeedChk(ierr);
1499d1d35e2fSjeremylt     ierr = CeedFree(&(*op)->qf_fallback); CeedChk(ierr);
1500d1d35e2fSjeremylt     ierr = (*op)->op_fallback->Destroy((*op)->op_fallback); CeedChk(ierr);
1501d1d35e2fSjeremylt     ierr = CeedFree(&(*op)->op_fallback); CeedChk(ierr);
15025107b09fSJeremy L Thompson   }
15035107b09fSJeremy L Thompson 
150470a7ffb3SJeremy L Thompson   // Destroy QF assembly cache
1505480fae85SJeremy L Thompson   ierr = CeedQFunctionAssemblyDataDestroy(&(*op)->qf_assembled); CeedChk(ierr);
150670a7ffb3SJeremy L Thompson 
1507d1d35e2fSjeremylt   ierr = CeedFree(&(*op)->input_fields); CeedChk(ierr);
1508d1d35e2fSjeremylt   ierr = CeedFree(&(*op)->output_fields); CeedChk(ierr);
1509d1d35e2fSjeremylt   ierr = CeedFree(&(*op)->sub_operators); CeedChk(ierr);
1510d7b241e6Sjeremylt   ierr = CeedFree(op); CeedChk(ierr);
1511e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
1512d7b241e6Sjeremylt }
1513d7b241e6Sjeremylt 
1514d7b241e6Sjeremylt /// @}
1515