xref: /petsc/src/dm/dt/interface/dtds.c (revision 4bee2e389ac4efdf19d1420f70098a911b40ccd1)
1af0996ceSBarry Smith #include <petsc/private/petscdsimpl.h> /*I "petscds.h" I*/
22764a2aaSMatthew G. Knepley 
32764a2aaSMatthew G. Knepley PetscClassId PETSCDS_CLASSID = 0;
42764a2aaSMatthew G. Knepley 
52764a2aaSMatthew G. Knepley PetscFunctionList PetscDSList              = NULL;
62764a2aaSMatthew G. Knepley PetscBool         PetscDSRegisterAllCalled = PETSC_FALSE;
72764a2aaSMatthew G. Knepley 
894dcdc3fSMatthew G. Knepley /* A PetscDS (Discrete System) encodes a set of equations posed in a discrete space, which represents a set of
994dcdc3fSMatthew G. Knepley    nonlinear continuum equations. The equations can have multiple fields, each field having a different
1094dcdc3fSMatthew G. Knepley    discretization. In addition, different pieces of the domain can have different field combinations and equations.
1194dcdc3fSMatthew G. Knepley 
1294dcdc3fSMatthew G. Knepley    The DS provides the user a description of the approximation space on any given cell. It also gives pointwise
1394dcdc3fSMatthew G. Knepley    functions representing the equations.
1494dcdc3fSMatthew G. Knepley 
1594dcdc3fSMatthew G. Knepley    Each field is associated with a label, marking the cells on which it is supported. Note that a field can be
1694dcdc3fSMatthew G. Knepley    supported on the closure of a cell not in the label due to overlap of the boundary of neighboring cells. The DM
1794dcdc3fSMatthew G. Knepley    then creates a DS for each set of cells with identical approximation spaces. When assembling, the user asks for
1894dcdc3fSMatthew G. Knepley    the space associated with a given cell. DMPlex uses the labels associated with each DS in the default integration loop.
1994dcdc3fSMatthew G. Knepley */
2094dcdc3fSMatthew G. Knepley 
212764a2aaSMatthew G. Knepley /*@C
222764a2aaSMatthew G. Knepley   PetscDSRegister - Adds a new PetscDS implementation
232764a2aaSMatthew G. Knepley 
242764a2aaSMatthew G. Knepley   Not Collective
252764a2aaSMatthew G. Knepley 
262764a2aaSMatthew G. Knepley   Input Parameters:
272764a2aaSMatthew G. Knepley + name        - The name of a new user-defined creation routine
282764a2aaSMatthew G. Knepley - create_func - The creation routine itself
292764a2aaSMatthew G. Knepley 
302764a2aaSMatthew G. Knepley   Notes:
312764a2aaSMatthew G. Knepley   PetscDSRegister() may be called multiple times to add several user-defined PetscDSs
322764a2aaSMatthew G. Knepley 
332764a2aaSMatthew G. Knepley   Sample usage:
342764a2aaSMatthew G. Knepley .vb
352764a2aaSMatthew G. Knepley     PetscDSRegister("my_ds", MyPetscDSCreate);
362764a2aaSMatthew G. Knepley .ve
372764a2aaSMatthew G. Knepley 
382764a2aaSMatthew G. Knepley   Then, your PetscDS type can be chosen with the procedural interface via
392764a2aaSMatthew G. Knepley .vb
402764a2aaSMatthew G. Knepley     PetscDSCreate(MPI_Comm, PetscDS *);
412764a2aaSMatthew G. Knepley     PetscDSSetType(PetscDS, "my_ds");
422764a2aaSMatthew G. Knepley .ve
432764a2aaSMatthew G. Knepley    or at runtime via the option
442764a2aaSMatthew G. Knepley .vb
452764a2aaSMatthew G. Knepley     -petscds_type my_ds
462764a2aaSMatthew G. Knepley .ve
472764a2aaSMatthew G. Knepley 
482764a2aaSMatthew G. Knepley   Level: advanced
492764a2aaSMatthew G. Knepley 
50f5f57ec0SBarry Smith    Not available from Fortran
51f5f57ec0SBarry Smith 
522764a2aaSMatthew G. Knepley .keywords: PetscDS, register
532764a2aaSMatthew G. Knepley .seealso: PetscDSRegisterAll(), PetscDSRegisterDestroy()
542764a2aaSMatthew G. Knepley 
552764a2aaSMatthew G. Knepley @*/
562764a2aaSMatthew G. Knepley PetscErrorCode PetscDSRegister(const char sname[], PetscErrorCode (*function)(PetscDS))
572764a2aaSMatthew G. Knepley {
582764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
592764a2aaSMatthew G. Knepley 
602764a2aaSMatthew G. Knepley   PetscFunctionBegin;
612764a2aaSMatthew G. Knepley   ierr = PetscFunctionListAdd(&PetscDSList, sname, function);CHKERRQ(ierr);
622764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
632764a2aaSMatthew G. Knepley }
642764a2aaSMatthew G. Knepley 
652764a2aaSMatthew G. Knepley /*@C
662764a2aaSMatthew G. Knepley   PetscDSSetType - Builds a particular PetscDS
672764a2aaSMatthew G. Knepley 
682764a2aaSMatthew G. Knepley   Collective on PetscDS
692764a2aaSMatthew G. Knepley 
702764a2aaSMatthew G. Knepley   Input Parameters:
712764a2aaSMatthew G. Knepley + prob - The PetscDS object
722764a2aaSMatthew G. Knepley - name - The kind of system
732764a2aaSMatthew G. Knepley 
742764a2aaSMatthew G. Knepley   Options Database Key:
752764a2aaSMatthew G. Knepley . -petscds_type <type> - Sets the PetscDS type; use -help for a list of available types
762764a2aaSMatthew G. Knepley 
772764a2aaSMatthew G. Knepley   Level: intermediate
782764a2aaSMatthew G. Knepley 
79f5f57ec0SBarry Smith    Not available from Fortran
80f5f57ec0SBarry Smith 
812764a2aaSMatthew G. Knepley .keywords: PetscDS, set, type
822764a2aaSMatthew G. Knepley .seealso: PetscDSGetType(), PetscDSCreate()
832764a2aaSMatthew G. Knepley @*/
842764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetType(PetscDS prob, PetscDSType name)
852764a2aaSMatthew G. Knepley {
862764a2aaSMatthew G. Knepley   PetscErrorCode (*r)(PetscDS);
872764a2aaSMatthew G. Knepley   PetscBool      match;
882764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
892764a2aaSMatthew G. Knepley 
902764a2aaSMatthew G. Knepley   PetscFunctionBegin;
912764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
922764a2aaSMatthew G. Knepley   ierr = PetscObjectTypeCompare((PetscObject) prob, name, &match);CHKERRQ(ierr);
932764a2aaSMatthew G. Knepley   if (match) PetscFunctionReturn(0);
942764a2aaSMatthew G. Knepley 
950f51fdf8SToby Isaac   ierr = PetscDSRegisterAll();CHKERRQ(ierr);
962764a2aaSMatthew G. Knepley   ierr = PetscFunctionListFind(PetscDSList, name, &r);CHKERRQ(ierr);
972764a2aaSMatthew G. Knepley   if (!r) SETERRQ1(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_UNKNOWN_TYPE, "Unknown PetscDS type: %s", name);
982764a2aaSMatthew G. Knepley 
992764a2aaSMatthew G. Knepley   if (prob->ops->destroy) {
1002764a2aaSMatthew G. Knepley     ierr             = (*prob->ops->destroy)(prob);CHKERRQ(ierr);
1012764a2aaSMatthew G. Knepley     prob->ops->destroy = NULL;
1022764a2aaSMatthew G. Knepley   }
1032764a2aaSMatthew G. Knepley   ierr = (*r)(prob);CHKERRQ(ierr);
1042764a2aaSMatthew G. Knepley   ierr = PetscObjectChangeTypeName((PetscObject) prob, name);CHKERRQ(ierr);
1052764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
1062764a2aaSMatthew G. Knepley }
1072764a2aaSMatthew G. Knepley 
1082764a2aaSMatthew G. Knepley /*@C
1092764a2aaSMatthew G. Knepley   PetscDSGetType - Gets the PetscDS type name (as a string) from the object.
1102764a2aaSMatthew G. Knepley 
1112764a2aaSMatthew G. Knepley   Not Collective
1122764a2aaSMatthew G. Knepley 
1132764a2aaSMatthew G. Knepley   Input Parameter:
1142764a2aaSMatthew G. Knepley . prob  - The PetscDS
1152764a2aaSMatthew G. Knepley 
1162764a2aaSMatthew G. Knepley   Output Parameter:
1172764a2aaSMatthew G. Knepley . name - The PetscDS type name
1182764a2aaSMatthew G. Knepley 
1192764a2aaSMatthew G. Knepley   Level: intermediate
1202764a2aaSMatthew G. Knepley 
121f5f57ec0SBarry Smith    Not available from Fortran
122f5f57ec0SBarry Smith 
1232764a2aaSMatthew G. Knepley .keywords: PetscDS, get, type, name
1242764a2aaSMatthew G. Knepley .seealso: PetscDSSetType(), PetscDSCreate()
1252764a2aaSMatthew G. Knepley @*/
1262764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetType(PetscDS prob, PetscDSType *name)
1272764a2aaSMatthew G. Knepley {
1282764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
1292764a2aaSMatthew G. Knepley 
1302764a2aaSMatthew G. Knepley   PetscFunctionBegin;
1312764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
132c959eef4SJed Brown   PetscValidPointer(name, 2);
1330f51fdf8SToby Isaac   ierr = PetscDSRegisterAll();CHKERRQ(ierr);
1342764a2aaSMatthew G. Knepley   *name = ((PetscObject) prob)->type_name;
1352764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
1362764a2aaSMatthew G. Knepley }
1372764a2aaSMatthew G. Knepley 
1387d8a60eaSMatthew G. Knepley static PetscErrorCode PetscDSView_Ascii(PetscDS prob, PetscViewer viewer)
1397d8a60eaSMatthew G. Knepley {
1407d8a60eaSMatthew G. Knepley   PetscViewerFormat  format;
14197b6e6e8SMatthew G. Knepley   const PetscScalar *constants;
14297b6e6e8SMatthew G. Knepley   PetscInt           numConstants, f;
1437d8a60eaSMatthew G. Knepley   PetscErrorCode     ierr;
1447d8a60eaSMatthew G. Knepley 
1457d8a60eaSMatthew G. Knepley   PetscFunctionBegin;
1467d8a60eaSMatthew G. Knepley   ierr = PetscViewerGetFormat(viewer, &format);CHKERRQ(ierr);
1477d8a60eaSMatthew G. Knepley   ierr = PetscViewerASCIIPrintf(viewer, "Discrete System with %d fields\n", prob->Nf);CHKERRQ(ierr);
1487d8a60eaSMatthew G. Knepley   ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1494727e194SMatthew G. Knepley   ierr = PetscViewerASCIIPrintf(viewer, "  cell total dim %D total comp %D\n", prob->totDim, prob->totComp);CHKERRQ(ierr);
1504727e194SMatthew G. Knepley   if (prob->isHybrid) {ierr = PetscViewerASCIIPrintf(viewer, "  hybrid cell\n");CHKERRQ(ierr);}
1517d8a60eaSMatthew G. Knepley   for (f = 0; f < prob->Nf; ++f) {
15240967b3bSMatthew G. Knepley     DSBoundary      b;
1537d8a60eaSMatthew G. Knepley     PetscObject     obj;
1547d8a60eaSMatthew G. Knepley     PetscClassId    id;
155f35450b9SMatthew G. Knepley     PetscQuadrature q;
1567d8a60eaSMatthew G. Knepley     const char     *name;
157f35450b9SMatthew G. Knepley     PetscInt        Nc, Nq, Nqc;
1587d8a60eaSMatthew G. Knepley 
1597d8a60eaSMatthew G. Knepley     ierr = PetscDSGetDiscretization(prob, f, &obj);CHKERRQ(ierr);
1607d8a60eaSMatthew G. Knepley     ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr);
1617d8a60eaSMatthew G. Knepley     ierr = PetscObjectGetName(obj, &name);CHKERRQ(ierr);
1627d8a60eaSMatthew G. Knepley     ierr = PetscViewerASCIIPrintf(viewer, "Field %s", name ? name : "<unknown>");CHKERRQ(ierr);
1634727e194SMatthew G. Knepley     ierr = PetscViewerASCIIUseTabs(viewer, PETSC_FALSE);CHKERRQ(ierr);
1647d8a60eaSMatthew G. Knepley     if (id == PETSCFE_CLASSID)      {
1657d8a60eaSMatthew G. Knepley       ierr = PetscFEGetNumComponents((PetscFE) obj, &Nc);CHKERRQ(ierr);
166f35450b9SMatthew G. Knepley       ierr = PetscFEGetQuadrature((PetscFE) obj, &q);CHKERRQ(ierr);
1677d8a60eaSMatthew G. Knepley       ierr = PetscViewerASCIIPrintf(viewer, " FEM");CHKERRQ(ierr);
1687d8a60eaSMatthew G. Knepley     } else if (id == PETSCFV_CLASSID) {
1697d8a60eaSMatthew G. Knepley       ierr = PetscFVGetNumComponents((PetscFV) obj, &Nc);CHKERRQ(ierr);
170f35450b9SMatthew G. Knepley       ierr = PetscFVGetQuadrature((PetscFV) obj, &q);CHKERRQ(ierr);
1717d8a60eaSMatthew G. Knepley       ierr = PetscViewerASCIIPrintf(viewer, " FVM");CHKERRQ(ierr);
1727d8a60eaSMatthew G. Knepley     }
17397b6e6e8SMatthew G. Knepley     else SETERRQ1(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Unknown discretization type for field %D", f);
17497b6e6e8SMatthew G. Knepley     if (Nc > 1) {ierr = PetscViewerASCIIPrintf(viewer, "%D components", Nc);CHKERRQ(ierr);}
17597b6e6e8SMatthew G. Knepley     else        {ierr = PetscViewerASCIIPrintf(viewer, "%D component ", Nc);CHKERRQ(ierr);}
176249df284SMatthew G. Knepley     if (prob->implicit[f]) {ierr = PetscViewerASCIIPrintf(viewer, " (implicit)");CHKERRQ(ierr);}
177249df284SMatthew G. Knepley     else                   {ierr = PetscViewerASCIIPrintf(viewer, " (explicit)");CHKERRQ(ierr);}
1783e60c2a6SMatthew G. Knepley     if (q) {
179f35450b9SMatthew G. Knepley       ierr = PetscQuadratureGetData(q, NULL, &Nqc, &Nq, NULL, NULL);CHKERRQ(ierr);
180f35450b9SMatthew G. Knepley       ierr = PetscViewerASCIIPrintf(viewer, " (Nq %D Nqc %D)", Nq, Nqc);CHKERRQ(ierr);
1813e60c2a6SMatthew G. Knepley     }
1827d8a60eaSMatthew G. Knepley     ierr = PetscViewerASCIIPrintf(viewer, "\n");CHKERRQ(ierr);
1834727e194SMatthew G. Knepley     ierr = PetscViewerASCIIUseTabs(viewer, PETSC_TRUE);CHKERRQ(ierr);
1845d160056SMatthew G. Knepley     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1857d8a60eaSMatthew G. Knepley     if (id == PETSCFE_CLASSID)      {ierr = PetscFEView((PetscFE) obj, viewer);CHKERRQ(ierr);}
1867d8a60eaSMatthew G. Knepley     else if (id == PETSCFV_CLASSID) {ierr = PetscFVView((PetscFV) obj, viewer);CHKERRQ(ierr);}
1875d160056SMatthew G. Knepley     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
18840967b3bSMatthew G. Knepley 
18940967b3bSMatthew G. Knepley     for (b = prob->boundary; b; b = b->next) {
19040967b3bSMatthew G. Knepley       PetscInt c, i;
19140967b3bSMatthew G. Knepley 
19240967b3bSMatthew G. Knepley       if (b->field != f) continue;
19340967b3bSMatthew G. Knepley       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
19440967b3bSMatthew G. Knepley       ierr = PetscViewerASCIIPrintf(viewer, "Boundary %s (%s) %s\n", b->name, b->labelname, DMBoundaryConditionTypes[b->type]);CHKERRQ(ierr);
19540967b3bSMatthew G. Knepley       if (!b->numcomps) {
19640967b3bSMatthew G. Knepley         ierr = PetscViewerASCIIPrintf(viewer, "  all components\n");CHKERRQ(ierr);
19740967b3bSMatthew G. Knepley       } else {
19840967b3bSMatthew G. Knepley         ierr = PetscViewerASCIIPrintf(viewer, "  components: ");CHKERRQ(ierr);
19940967b3bSMatthew G. Knepley         ierr = PetscViewerASCIIUseTabs(viewer, PETSC_FALSE);CHKERRQ(ierr);
20040967b3bSMatthew G. Knepley         for (c = 0; c < b->numcomps; ++c) {
20140967b3bSMatthew G. Knepley           if (c > 0) {ierr = PetscViewerASCIIPrintf(viewer, ", ");CHKERRQ(ierr);}
20240967b3bSMatthew G. Knepley           ierr = PetscViewerASCIIPrintf(viewer, "%D", b->comps[c]);CHKERRQ(ierr);
20340967b3bSMatthew G. Knepley         }
20440967b3bSMatthew G. Knepley         ierr = PetscViewerASCIIPrintf(viewer, "\n");CHKERRQ(ierr);
20540967b3bSMatthew G. Knepley         ierr = PetscViewerASCIIUseTabs(viewer, PETSC_TRUE);CHKERRQ(ierr);
20640967b3bSMatthew G. Knepley       }
20740967b3bSMatthew G. Knepley       ierr = PetscViewerASCIIPrintf(viewer, "  ids: ");CHKERRQ(ierr);
20840967b3bSMatthew G. Knepley       ierr = PetscViewerASCIIUseTabs(viewer, PETSC_FALSE);CHKERRQ(ierr);
20940967b3bSMatthew G. Knepley       for (i = 0; i < b->numids; ++i) {
21040967b3bSMatthew G. Knepley         if (i > 0) {ierr = PetscViewerASCIIPrintf(viewer, ", ");CHKERRQ(ierr);}
21140967b3bSMatthew G. Knepley         ierr = PetscViewerASCIIPrintf(viewer, "%D", b->ids[i]);CHKERRQ(ierr);
21240967b3bSMatthew G. Knepley       }
21340967b3bSMatthew G. Knepley       ierr = PetscViewerASCIIPrintf(viewer, "\n");CHKERRQ(ierr);
21440967b3bSMatthew G. Knepley       ierr = PetscViewerASCIIUseTabs(viewer, PETSC_TRUE);CHKERRQ(ierr);
21540967b3bSMatthew G. Knepley       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
21640967b3bSMatthew G. Knepley     }
2177d8a60eaSMatthew G. Knepley   }
21897b6e6e8SMatthew G. Knepley   ierr = PetscDSGetConstants(prob, &numConstants, &constants);CHKERRQ(ierr);
21997b6e6e8SMatthew G. Knepley   if (numConstants) {
22097b6e6e8SMatthew G. Knepley     ierr = PetscViewerASCIIPrintf(viewer, "%D constants\n", numConstants);CHKERRQ(ierr);
22197b6e6e8SMatthew G. Knepley     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
22257fc01e9SMatthew G. Knepley     for (f = 0; f < numConstants; ++f) {ierr = PetscViewerASCIIPrintf(viewer, "%g\n", (double) PetscRealPart(constants[f]));CHKERRQ(ierr);}
22397b6e6e8SMatthew G. Knepley     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
22497b6e6e8SMatthew G. Knepley   }
2257d8a60eaSMatthew G. Knepley   ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
2267d8a60eaSMatthew G. Knepley   PetscFunctionReturn(0);
2277d8a60eaSMatthew G. Knepley }
2287d8a60eaSMatthew G. Knepley 
2292764a2aaSMatthew G. Knepley /*@C
2302764a2aaSMatthew G. Knepley   PetscDSView - Views a PetscDS
2312764a2aaSMatthew G. Knepley 
2322764a2aaSMatthew G. Knepley   Collective on PetscDS
2332764a2aaSMatthew G. Knepley 
2342764a2aaSMatthew G. Knepley   Input Parameter:
2352764a2aaSMatthew G. Knepley + prob - the PetscDS object to view
2362764a2aaSMatthew G. Knepley - v  - the viewer
2372764a2aaSMatthew G. Knepley 
2382764a2aaSMatthew G. Knepley   Level: developer
2392764a2aaSMatthew G. Knepley 
2402764a2aaSMatthew G. Knepley .seealso PetscDSDestroy()
2412764a2aaSMatthew G. Knepley @*/
2422764a2aaSMatthew G. Knepley PetscErrorCode PetscDSView(PetscDS prob, PetscViewer v)
2432764a2aaSMatthew G. Knepley {
2447d8a60eaSMatthew G. Knepley   PetscBool      iascii;
2452764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
2462764a2aaSMatthew G. Knepley 
2472764a2aaSMatthew G. Knepley   PetscFunctionBegin;
2482764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2492764a2aaSMatthew G. Knepley   if (!v) {ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject) prob), &v);CHKERRQ(ierr);}
2507d8a60eaSMatthew G. Knepley   else    {PetscValidHeaderSpecific(v, PETSC_VIEWER_CLASSID, 2);}
2517d8a60eaSMatthew G. Knepley   ierr = PetscObjectTypeCompare((PetscObject) v, PETSCVIEWERASCII, &iascii);CHKERRQ(ierr);
2527d8a60eaSMatthew G. Knepley   if (iascii) {ierr = PetscDSView_Ascii(prob, v);CHKERRQ(ierr);}
2532764a2aaSMatthew G. Knepley   if (prob->ops->view) {ierr = (*prob->ops->view)(prob, v);CHKERRQ(ierr);}
2542764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
2552764a2aaSMatthew G. Knepley }
2562764a2aaSMatthew G. Knepley 
2572764a2aaSMatthew G. Knepley /*@
2582764a2aaSMatthew G. Knepley   PetscDSSetFromOptions - sets parameters in a PetscDS from the options database
2592764a2aaSMatthew G. Knepley 
2602764a2aaSMatthew G. Knepley   Collective on PetscDS
2612764a2aaSMatthew G. Knepley 
2622764a2aaSMatthew G. Knepley   Input Parameter:
2632764a2aaSMatthew G. Knepley . prob - the PetscDS object to set options for
2642764a2aaSMatthew G. Knepley 
2652764a2aaSMatthew G. Knepley   Options Database:
26655c1f793SMatthew G. Knepley + -petscds_type <type>     : Set the DS type
26755c1f793SMatthew G. Knepley . -petscds_view <view opt> : View the DS
26855c1f793SMatthew G. Knepley . -petscds_jac_pre         : Turn formation of a separate Jacobian preconditioner on and off
26955c1f793SMatthew G. Knepley . -bc_<name> <ids>         : Specify a list of label ids for a boundary condition
27055c1f793SMatthew G. Knepley - -bc_<name>_comp <comps>  : Specify a list of field components to constrain for a boundary condition
2712764a2aaSMatthew G. Knepley 
2722764a2aaSMatthew G. Knepley   Level: developer
2732764a2aaSMatthew G. Knepley 
2742764a2aaSMatthew G. Knepley .seealso PetscDSView()
2752764a2aaSMatthew G. Knepley @*/
2762764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetFromOptions(PetscDS prob)
2772764a2aaSMatthew G. Knepley {
278f1fd5e65SToby Isaac   DSBoundary     b;
2792764a2aaSMatthew G. Knepley   const char    *defaultType;
2802764a2aaSMatthew G. Knepley   char           name[256];
2812764a2aaSMatthew G. Knepley   PetscBool      flg;
2822764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
2832764a2aaSMatthew G. Knepley 
2842764a2aaSMatthew G. Knepley   PetscFunctionBegin;
2852764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2862764a2aaSMatthew G. Knepley   if (!((PetscObject) prob)->type_name) {
2872764a2aaSMatthew G. Knepley     defaultType = PETSCDSBASIC;
2882764a2aaSMatthew G. Knepley   } else {
2892764a2aaSMatthew G. Knepley     defaultType = ((PetscObject) prob)->type_name;
2902764a2aaSMatthew G. Knepley   }
2910f51fdf8SToby Isaac   ierr = PetscDSRegisterAll();CHKERRQ(ierr);
2922764a2aaSMatthew G. Knepley 
2932764a2aaSMatthew G. Knepley   ierr = PetscObjectOptionsBegin((PetscObject) prob);CHKERRQ(ierr);
294f1fd5e65SToby Isaac   for (b = prob->boundary; b; b = b->next) {
295f1fd5e65SToby Isaac     char       optname[1024];
296f1fd5e65SToby Isaac     PetscInt   ids[1024], len = 1024;
297f1fd5e65SToby Isaac     PetscBool  flg;
298f1fd5e65SToby Isaac 
299f1fd5e65SToby Isaac     ierr = PetscSNPrintf(optname, sizeof(optname), "-bc_%s", b->name);CHKERRQ(ierr);
300f1fd5e65SToby Isaac     ierr = PetscMemzero(ids, sizeof(ids));CHKERRQ(ierr);
301f1fd5e65SToby Isaac     ierr = PetscOptionsIntArray(optname, "List of boundary IDs", "", ids, &len, &flg);CHKERRQ(ierr);
302f1fd5e65SToby Isaac     if (flg) {
303f1fd5e65SToby Isaac       b->numids = len;
304f1fd5e65SToby Isaac       ierr = PetscFree(b->ids);CHKERRQ(ierr);
305f1fd5e65SToby Isaac       ierr = PetscMalloc1(len, &b->ids);CHKERRQ(ierr);
306f1fd5e65SToby Isaac       ierr = PetscMemcpy(b->ids, ids, len*sizeof(PetscInt));CHKERRQ(ierr);
307f1fd5e65SToby Isaac     }
308e7b0402cSSander Arens     len = 1024;
309f1fd5e65SToby Isaac     ierr = PetscSNPrintf(optname, sizeof(optname), "-bc_%s_comp", b->name);CHKERRQ(ierr);
310f1fd5e65SToby Isaac     ierr = PetscMemzero(ids, sizeof(ids));CHKERRQ(ierr);
311f1fd5e65SToby Isaac     ierr = PetscOptionsIntArray(optname, "List of boundary field components", "", ids, &len, &flg);CHKERRQ(ierr);
312f1fd5e65SToby Isaac     if (flg) {
313f1fd5e65SToby Isaac       b->numcomps = len;
314f1fd5e65SToby Isaac       ierr = PetscFree(b->comps);CHKERRQ(ierr);
315f1fd5e65SToby Isaac       ierr = PetscMalloc1(len, &b->comps);CHKERRQ(ierr);
316f1fd5e65SToby Isaac       ierr = PetscMemcpy(b->comps, ids, len*sizeof(PetscInt));CHKERRQ(ierr);
317f1fd5e65SToby Isaac     }
318f1fd5e65SToby Isaac   }
3192764a2aaSMatthew G. Knepley   ierr = PetscOptionsFList("-petscds_type", "Discrete System", "PetscDSSetType", PetscDSList, defaultType, name, 256, &flg);CHKERRQ(ierr);
3202764a2aaSMatthew G. Knepley   if (flg) {
3212764a2aaSMatthew G. Knepley     ierr = PetscDSSetType(prob, name);CHKERRQ(ierr);
3222764a2aaSMatthew G. Knepley   } else if (!((PetscObject) prob)->type_name) {
3232764a2aaSMatthew G. Knepley     ierr = PetscDSSetType(prob, defaultType);CHKERRQ(ierr);
3242764a2aaSMatthew G. Knepley   }
32555c1f793SMatthew G. Knepley   ierr = PetscOptionsBool("-petscds_jac_pre", "Discrete System", "PetscDSUseJacobianPreconditioner", prob->useJacPre, &prob->useJacPre, &flg);CHKERRQ(ierr);
3262764a2aaSMatthew G. Knepley   if (prob->ops->setfromoptions) {ierr = (*prob->ops->setfromoptions)(prob);CHKERRQ(ierr);}
3272764a2aaSMatthew G. Knepley   /* process any options handlers added with PetscObjectAddOptionsHandler() */
3280633abcbSJed Brown   ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject) prob);CHKERRQ(ierr);
3292764a2aaSMatthew G. Knepley   ierr = PetscOptionsEnd();CHKERRQ(ierr);
3305d160056SMatthew G. Knepley   if (prob->Nf) {ierr = PetscDSViewFromOptions(prob, NULL, "-petscds_view");CHKERRQ(ierr);}
3312764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
3322764a2aaSMatthew G. Knepley }
3332764a2aaSMatthew G. Knepley 
3342764a2aaSMatthew G. Knepley /*@C
3352764a2aaSMatthew G. Knepley   PetscDSSetUp - Construct data structures for the PetscDS
3362764a2aaSMatthew G. Knepley 
3372764a2aaSMatthew G. Knepley   Collective on PetscDS
3382764a2aaSMatthew G. Knepley 
3392764a2aaSMatthew G. Knepley   Input Parameter:
3402764a2aaSMatthew G. Knepley . prob - the PetscDS object to setup
3412764a2aaSMatthew G. Knepley 
3422764a2aaSMatthew G. Knepley   Level: developer
3432764a2aaSMatthew G. Knepley 
3442764a2aaSMatthew G. Knepley .seealso PetscDSView(), PetscDSDestroy()
3452764a2aaSMatthew G. Knepley @*/
3462764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetUp(PetscDS prob)
3472764a2aaSMatthew G. Knepley {
3482764a2aaSMatthew G. Knepley   const PetscInt Nf = prob->Nf;
349*4bee2e38SMatthew G. Knepley   PetscInt       dim, dimEmbed, NbMax = 0, NcMax = 0, NqMax = 0, NsMax = 1, f;
3502764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
3512764a2aaSMatthew G. Knepley 
3522764a2aaSMatthew G. Knepley   PetscFunctionBegin;
3532764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
3542764a2aaSMatthew G. Knepley   if (prob->setup) PetscFunctionReturn(0);
3552764a2aaSMatthew G. Knepley   /* Calculate sizes */
3562764a2aaSMatthew G. Knepley   ierr = PetscDSGetSpatialDimension(prob, &dim);CHKERRQ(ierr);
357d1506c7cSMatthew G. Knepley   ierr = PetscDSGetCoordinateDimension(prob, &dimEmbed);CHKERRQ(ierr);
358f744cafaSSander Arens   prob->totDim = prob->totComp = 0;
35947e57110SSander Arens   ierr = PetscMalloc2(Nf,&prob->Nc,Nf,&prob->Nb);CHKERRQ(ierr);
360f744cafaSSander Arens   ierr = PetscCalloc2(Nf+1,&prob->off,Nf+1,&prob->offDer);CHKERRQ(ierr);
361f744cafaSSander Arens   ierr = PetscMalloc4(Nf,&prob->basis,Nf,&prob->basisDer,Nf,&prob->basisFace,Nf,&prob->basisDerFace);CHKERRQ(ierr);
3622764a2aaSMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
3639de99aefSMatthew G. Knepley     PetscObject     obj;
3649de99aefSMatthew G. Knepley     PetscClassId    id;
3652764a2aaSMatthew G. Knepley     PetscQuadrature q;
3669de99aefSMatthew G. Knepley     PetscInt        Nq = 0, Nb, Nc;
3672764a2aaSMatthew G. Knepley 
3689de99aefSMatthew G. Knepley     ierr = PetscDSGetDiscretization(prob, f, &obj);CHKERRQ(ierr);
3699de99aefSMatthew G. Knepley     ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr);
3709de99aefSMatthew G. Knepley     if (id == PETSCFE_CLASSID)      {
3719de99aefSMatthew G. Knepley       PetscFE fe = (PetscFE) obj;
3729de99aefSMatthew G. Knepley 
3732764a2aaSMatthew G. Knepley       ierr = PetscFEGetQuadrature(fe, &q);CHKERRQ(ierr);
3742764a2aaSMatthew G. Knepley       ierr = PetscFEGetDimension(fe, &Nb);CHKERRQ(ierr);
3752764a2aaSMatthew G. Knepley       ierr = PetscFEGetNumComponents(fe, &Nc);CHKERRQ(ierr);
3762764a2aaSMatthew G. Knepley       ierr = PetscFEGetDefaultTabulation(fe, &prob->basis[f], &prob->basisDer[f], NULL);CHKERRQ(ierr);
3774d0b9603SSander Arens       ierr = PetscFEGetFaceTabulation(fe, &prob->basisFace[f], &prob->basisDerFace[f], NULL);CHKERRQ(ierr);
3789de99aefSMatthew G. Knepley     } else if (id == PETSCFV_CLASSID) {
3799de99aefSMatthew G. Knepley       PetscFV fv = (PetscFV) obj;
3809de99aefSMatthew G. Knepley 
3819de99aefSMatthew G. Knepley       ierr = PetscFVGetQuadrature(fv, &q);CHKERRQ(ierr);
3829de99aefSMatthew G. Knepley       ierr = PetscFVGetNumComponents(fv, &Nc);CHKERRQ(ierr);
3839c3cf19fSMatthew G. Knepley       Nb   = Nc;
3846c1a3d01SMatthew G. Knepley       ierr = PetscFVGetDefaultTabulation(fv, &prob->basis[f], &prob->basisDer[f], NULL);CHKERRQ(ierr);
3854d0b9603SSander Arens       /* TODO: should PetscFV also have face tabulation? Otherwise there will be a null pointer in prob->basisFace */
386abac5ca0SMatthew G. Knepley     } else SETERRQ1(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Unknown discretization type for field %d", f);
38747e57110SSander Arens     prob->Nc[f]       = Nc;
38847e57110SSander Arens     prob->Nb[f]       = Nb;
389194d53e6SMatthew G. Knepley     prob->off[f+1]    = Nc     + prob->off[f];
390194d53e6SMatthew G. Knepley     prob->offDer[f+1] = Nc*dim + prob->offDer[f];
391a6b92713SMatthew G. Knepley     if (q) {ierr = PetscQuadratureGetData(q, NULL, NULL, &Nq, NULL, NULL);CHKERRQ(ierr);}
3922764a2aaSMatthew G. Knepley     NqMax          = PetscMax(NqMax, Nq);
393*4bee2e38SMatthew G. Knepley     NbMax          = PetscMax(NbMax, Nb);
3942764a2aaSMatthew G. Knepley     NcMax          = PetscMax(NcMax, Nc);
3959c3cf19fSMatthew G. Knepley     prob->totDim  += Nb;
3962764a2aaSMatthew G. Knepley     prob->totComp += Nc;
39794a5e212SMatthew G. Knepley     /* There are two faces for all fields but the cohesive field on a hybrid cell */
39894a5e212SMatthew G. Knepley     if (prob->isHybrid && (f < Nf-1)) prob->totDim += Nb;
3992764a2aaSMatthew G. Knepley   }
4002764a2aaSMatthew G. Knepley   /* Allocate works space */
40194a5e212SMatthew G. Knepley   if (prob->isHybrid) NsMax = 2;
402*4bee2e38SMatthew G. Knepley   ierr = PetscMalloc3(NsMax*prob->totComp,&prob->u,NsMax*prob->totComp,&prob->u_t,NsMax*prob->totComp*dimEmbed,&prob->u_x);CHKERRQ(ierr);
403*4bee2e38SMatthew G. Knepley   ierr = PetscMalloc5(dimEmbed,&prob->x,NbMax*NcMax,&prob->basisReal,NbMax*NcMax*dimEmbed,&prob->basisDerReal,NbMax*NcMax,&prob->testReal,NbMax*NcMax*dimEmbed,&prob->testDerReal);CHKERRQ(ierr);
40494a5e212SMatthew G. Knepley   ierr = PetscMalloc6(NsMax*NqMax*NcMax,&prob->f0,NsMax*NqMax*NcMax*dim,&prob->f1,
40594a5e212SMatthew G. Knepley                       NsMax*NsMax*NqMax*NcMax*NcMax,&prob->g0,NsMax*NsMax*NqMax*NcMax*NcMax*dim,&prob->g1,
40694a5e212SMatthew G. Knepley                       NsMax*NsMax*NqMax*NcMax*NcMax*dim,&prob->g2,NsMax*NsMax*NqMax*NcMax*NcMax*dim*dim,&prob->g3);CHKERRQ(ierr);
4072764a2aaSMatthew G. Knepley   if (prob->ops->setup) {ierr = (*prob->ops->setup)(prob);CHKERRQ(ierr);}
4082764a2aaSMatthew G. Knepley   prob->setup = PETSC_TRUE;
4092764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
4102764a2aaSMatthew G. Knepley }
4112764a2aaSMatthew G. Knepley 
4122764a2aaSMatthew G. Knepley static PetscErrorCode PetscDSDestroyStructs_Static(PetscDS prob)
4132764a2aaSMatthew G. Knepley {
4142764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
4152764a2aaSMatthew G. Knepley 
4162764a2aaSMatthew G. Knepley   PetscFunctionBegin;
41747e57110SSander Arens   ierr = PetscFree2(prob->Nc,prob->Nb);CHKERRQ(ierr);
418f744cafaSSander Arens   ierr = PetscFree2(prob->off,prob->offDer);CHKERRQ(ierr);
419f744cafaSSander Arens   ierr = PetscFree4(prob->basis,prob->basisDer,prob->basisFace,prob->basisDerFace);CHKERRQ(ierr);
420*4bee2e38SMatthew G. Knepley   ierr = PetscFree3(prob->u,prob->u_t,prob->u_x);CHKERRQ(ierr);
421*4bee2e38SMatthew G. Knepley   ierr = PetscFree5(prob->x,prob->basisReal, prob->basisDerReal,prob->testReal,prob->testDerReal);CHKERRQ(ierr);
4222764a2aaSMatthew G. Knepley   ierr = PetscFree6(prob->f0,prob->f1,prob->g0,prob->g1,prob->g2,prob->g3);CHKERRQ(ierr);
4232764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
4242764a2aaSMatthew G. Knepley }
4252764a2aaSMatthew G. Knepley 
4262764a2aaSMatthew G. Knepley static PetscErrorCode PetscDSEnlarge_Static(PetscDS prob, PetscInt NfNew)
4272764a2aaSMatthew G. Knepley {
428f744cafaSSander Arens   PetscObject      *tmpd;
42934aa8a36SMatthew G. Knepley   PetscBool        *tmpi;
43032d2bbc9SMatthew G. Knepley   PetscPointFunc   *tmpobj, *tmpf, *tmpup;
431b7e05686SMatthew G. Knepley   PetscPointJac    *tmpg, *tmpgp, *tmpgt;
4322aa1fc23SMatthew G. Knepley   PetscBdPointFunc *tmpfbd;
4332aa1fc23SMatthew G. Knepley   PetscBdPointJac  *tmpgbd;
434194d53e6SMatthew G. Knepley   PetscRiemannFunc *tmpr;
435c371a6d1SMatthew G. Knepley   PetscSimplePointFunc *tmpexactSol;
43695cbbfd3SMatthew G. Knepley   void                **tmpexactCtx;
4370c2f2876SMatthew G. Knepley   void            **tmpctx;
43834aa8a36SMatthew G. Knepley   PetscInt          Nf = prob->Nf, f;
4392764a2aaSMatthew G. Knepley   PetscErrorCode    ierr;
4402764a2aaSMatthew G. Knepley 
4412764a2aaSMatthew G. Knepley   PetscFunctionBegin;
4422764a2aaSMatthew G. Knepley   if (Nf >= NfNew) PetscFunctionReturn(0);
4432764a2aaSMatthew G. Knepley   prob->setup = PETSC_FALSE;
4442764a2aaSMatthew G. Knepley   ierr = PetscDSDestroyStructs_Static(prob);CHKERRQ(ierr);
44534aa8a36SMatthew G. Knepley   ierr = PetscMalloc2(NfNew, &tmpd, NfNew, &tmpi);CHKERRQ(ierr);
44634aa8a36SMatthew G. Knepley   for (f = 0; f < Nf; ++f) {tmpd[f] = prob->disc[f]; tmpi[f] = prob->implicit[f];}
44734aa8a36SMatthew G. Knepley   for (f = Nf; f < NfNew; ++f) {tmpd[f] = NULL; tmpi[f] = PETSC_TRUE;}
44834aa8a36SMatthew G. Knepley   ierr = PetscFree2(prob->disc, prob->implicit);CHKERRQ(ierr);
4492764a2aaSMatthew G. Knepley   prob->Nf        = NfNew;
4502764a2aaSMatthew G. Knepley   prob->disc      = tmpd;
451249df284SMatthew G. Knepley   prob->implicit  = tmpi;
452b7e05686SMatthew G. Knepley   ierr = PetscCalloc7(NfNew, &tmpobj, NfNew*2, &tmpf, NfNew*NfNew*4, &tmpg, NfNew*NfNew*4, &tmpgp, NfNew*NfNew*4, &tmpgt, NfNew, &tmpr, NfNew, &tmpctx);CHKERRQ(ierr);
45332d2bbc9SMatthew G. Knepley   ierr = PetscCalloc1(NfNew, &tmpup);CHKERRQ(ierr);
4542764a2aaSMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpobj[f] = prob->obj[f];
4552764a2aaSMatthew G. Knepley   for (f = 0; f < Nf*2; ++f) tmpf[f] = prob->f[f];
4562764a2aaSMatthew G. Knepley   for (f = 0; f < Nf*Nf*4; ++f) tmpg[f] = prob->g[f];
457475e0ac9SMatthew G. Knepley   for (f = 0; f < Nf*Nf*4; ++f) tmpgp[f] = prob->gp[f];
4580c2f2876SMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpr[f] = prob->r[f];
45932d2bbc9SMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpup[f] = prob->update[f];
4600c2f2876SMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpctx[f] = prob->ctx[f];
4612764a2aaSMatthew G. Knepley   for (f = Nf; f < NfNew; ++f) tmpobj[f] = NULL;
4622764a2aaSMatthew G. Knepley   for (f = Nf*2; f < NfNew*2; ++f) tmpf[f] = NULL;
4632764a2aaSMatthew G. Knepley   for (f = Nf*Nf*4; f < NfNew*NfNew*4; ++f) tmpg[f] = NULL;
464475e0ac9SMatthew G. Knepley   for (f = Nf*Nf*4; f < NfNew*NfNew*4; ++f) tmpgp[f] = NULL;
465b7e05686SMatthew G. Knepley   for (f = Nf*Nf*4; f < NfNew*NfNew*4; ++f) tmpgt[f] = NULL;
4660c2f2876SMatthew G. Knepley   for (f = Nf; f < NfNew; ++f) tmpr[f] = NULL;
46732d2bbc9SMatthew G. Knepley   for (f = Nf; f < NfNew; ++f) tmpup[f] = NULL;
4680c2f2876SMatthew G. Knepley   for (f = Nf; f < NfNew; ++f) tmpctx[f] = NULL;
469b7e05686SMatthew G. Knepley   ierr = PetscFree7(prob->obj, prob->f, prob->g, prob->gp, prob->gt, prob->r, prob->ctx);CHKERRQ(ierr);
47032d2bbc9SMatthew G. Knepley   ierr = PetscFree(prob->update);CHKERRQ(ierr);
4712764a2aaSMatthew G. Knepley   prob->obj = tmpobj;
4722764a2aaSMatthew G. Knepley   prob->f   = tmpf;
4732764a2aaSMatthew G. Knepley   prob->g   = tmpg;
474475e0ac9SMatthew G. Knepley   prob->gp  = tmpgp;
475b7e05686SMatthew G. Knepley   prob->gt  = tmpgt;
4760c2f2876SMatthew G. Knepley   prob->r   = tmpr;
47732d2bbc9SMatthew G. Knepley   prob->update = tmpup;
4780c2f2876SMatthew G. Knepley   prob->ctx = tmpctx;
47995cbbfd3SMatthew G. Knepley   ierr = PetscCalloc4(NfNew*2, &tmpfbd, NfNew*NfNew*4, &tmpgbd, NfNew, &tmpexactSol, NfNew, &tmpexactCtx);CHKERRQ(ierr);
4802764a2aaSMatthew G. Knepley   for (f = 0; f < Nf*2; ++f) tmpfbd[f] = prob->fBd[f];
4812764a2aaSMatthew G. Knepley   for (f = 0; f < Nf*Nf*4; ++f) tmpgbd[f] = prob->gBd[f];
482c371a6d1SMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpexactSol[f] = prob->exactSol[f];
48395cbbfd3SMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpexactCtx[f] = prob->exactCtx[f];
4842764a2aaSMatthew G. Knepley   for (f = Nf*2; f < NfNew*2; ++f) tmpfbd[f] = NULL;
4852764a2aaSMatthew G. Knepley   for (f = Nf*Nf*4; f < NfNew*NfNew*4; ++f) tmpgbd[f] = NULL;
486c371a6d1SMatthew G. Knepley   for (f = Nf; f < NfNew; ++f) tmpexactSol[f] = NULL;
48795cbbfd3SMatthew G. Knepley   for (f = Nf; f < NfNew; ++f) tmpexactCtx[f] = NULL;
48895cbbfd3SMatthew G. Knepley   ierr = PetscFree4(prob->fBd, prob->gBd, prob->exactSol, prob->exactCtx);CHKERRQ(ierr);
4892764a2aaSMatthew G. Knepley   prob->fBd = tmpfbd;
4902764a2aaSMatthew G. Knepley   prob->gBd = tmpgbd;
491c371a6d1SMatthew G. Knepley   prob->exactSol = tmpexactSol;
49295cbbfd3SMatthew G. Knepley   prob->exactCtx = tmpexactCtx;
4932764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
4942764a2aaSMatthew G. Knepley }
4952764a2aaSMatthew G. Knepley 
4962764a2aaSMatthew G. Knepley /*@
4972764a2aaSMatthew G. Knepley   PetscDSDestroy - Destroys a PetscDS object
4982764a2aaSMatthew G. Knepley 
4992764a2aaSMatthew G. Knepley   Collective on PetscDS
5002764a2aaSMatthew G. Knepley 
5012764a2aaSMatthew G. Knepley   Input Parameter:
5022764a2aaSMatthew G. Knepley . prob - the PetscDS object to destroy
5032764a2aaSMatthew G. Knepley 
5042764a2aaSMatthew G. Knepley   Level: developer
5052764a2aaSMatthew G. Knepley 
5062764a2aaSMatthew G. Knepley .seealso PetscDSView()
5072764a2aaSMatthew G. Knepley @*/
5082764a2aaSMatthew G. Knepley PetscErrorCode PetscDSDestroy(PetscDS *prob)
5092764a2aaSMatthew G. Knepley {
5102764a2aaSMatthew G. Knepley   PetscInt       f;
51158ebd649SToby Isaac   DSBoundary     next;
5122764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
5132764a2aaSMatthew G. Knepley 
5142764a2aaSMatthew G. Knepley   PetscFunctionBegin;
5152764a2aaSMatthew G. Knepley   if (!*prob) PetscFunctionReturn(0);
5162764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific((*prob), PETSCDS_CLASSID, 1);
5172764a2aaSMatthew G. Knepley 
5182764a2aaSMatthew G. Knepley   if (--((PetscObject)(*prob))->refct > 0) {*prob = 0; PetscFunctionReturn(0);}
5192764a2aaSMatthew G. Knepley   ((PetscObject) (*prob))->refct = 0;
520df3a45bdSMatthew G. Knepley   if ((*prob)->subprobs) {
521df3a45bdSMatthew G. Knepley     PetscInt dim, d;
522df3a45bdSMatthew G. Knepley 
523df3a45bdSMatthew G. Knepley     ierr = PetscDSGetSpatialDimension(*prob, &dim);CHKERRQ(ierr);
524df3a45bdSMatthew G. Knepley     for (d = 0; d < dim; ++d) {ierr = PetscDSDestroy(&(*prob)->subprobs[d]);CHKERRQ(ierr);}
525df3a45bdSMatthew G. Knepley   }
526df3a45bdSMatthew G. Knepley   ierr = PetscFree((*prob)->subprobs);CHKERRQ(ierr);
5272764a2aaSMatthew G. Knepley   ierr = PetscDSDestroyStructs_Static(*prob);CHKERRQ(ierr);
5282764a2aaSMatthew G. Knepley   for (f = 0; f < (*prob)->Nf; ++f) {
5292764a2aaSMatthew G. Knepley     ierr = PetscObjectDereference((*prob)->disc[f]);CHKERRQ(ierr);
5302764a2aaSMatthew G. Knepley   }
53134aa8a36SMatthew G. Knepley   ierr = PetscFree2((*prob)->disc, (*prob)->implicit);CHKERRQ(ierr);
532b7e05686SMatthew G. Knepley   ierr = PetscFree7((*prob)->obj,(*prob)->f,(*prob)->g,(*prob)->gp,(*prob)->gt,(*prob)->r,(*prob)->ctx);CHKERRQ(ierr);
53332d2bbc9SMatthew G. Knepley   ierr = PetscFree((*prob)->update);CHKERRQ(ierr);
53495cbbfd3SMatthew G. Knepley   ierr = PetscFree4((*prob)->fBd,(*prob)->gBd,(*prob)->exactSol,(*prob)->exactCtx);CHKERRQ(ierr);
5352764a2aaSMatthew G. Knepley   if ((*prob)->ops->destroy) {ierr = (*(*prob)->ops->destroy)(*prob);CHKERRQ(ierr);}
53658ebd649SToby Isaac   next = (*prob)->boundary;
53758ebd649SToby Isaac   while (next) {
53858ebd649SToby Isaac     DSBoundary b = next;
53958ebd649SToby Isaac 
54058ebd649SToby Isaac     next = b->next;
54158ebd649SToby Isaac     ierr = PetscFree(b->comps);CHKERRQ(ierr);
54258ebd649SToby Isaac     ierr = PetscFree(b->ids);CHKERRQ(ierr);
54358ebd649SToby Isaac     ierr = PetscFree(b->name);CHKERRQ(ierr);
54458ebd649SToby Isaac     ierr = PetscFree(b->labelname);CHKERRQ(ierr);
54558ebd649SToby Isaac     ierr = PetscFree(b);CHKERRQ(ierr);
54658ebd649SToby Isaac   }
54797b6e6e8SMatthew G. Knepley   ierr = PetscFree((*prob)->constants);CHKERRQ(ierr);
5482764a2aaSMatthew G. Knepley   ierr = PetscHeaderDestroy(prob);CHKERRQ(ierr);
5492764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
5502764a2aaSMatthew G. Knepley }
5512764a2aaSMatthew G. Knepley 
5522764a2aaSMatthew G. Knepley /*@
5532764a2aaSMatthew G. Knepley   PetscDSCreate - Creates an empty PetscDS object. The type can then be set with PetscDSSetType().
5542764a2aaSMatthew G. Knepley 
5552764a2aaSMatthew G. Knepley   Collective on MPI_Comm
5562764a2aaSMatthew G. Knepley 
5572764a2aaSMatthew G. Knepley   Input Parameter:
5582764a2aaSMatthew G. Knepley . comm - The communicator for the PetscDS object
5592764a2aaSMatthew G. Knepley 
5602764a2aaSMatthew G. Knepley   Output Parameter:
5612764a2aaSMatthew G. Knepley . prob - The PetscDS object
5622764a2aaSMatthew G. Knepley 
5632764a2aaSMatthew G. Knepley   Level: beginner
5642764a2aaSMatthew G. Knepley 
5652764a2aaSMatthew G. Knepley .seealso: PetscDSSetType(), PETSCDSBASIC
5662764a2aaSMatthew G. Knepley @*/
5672764a2aaSMatthew G. Knepley PetscErrorCode PetscDSCreate(MPI_Comm comm, PetscDS *prob)
5682764a2aaSMatthew G. Knepley {
5692764a2aaSMatthew G. Knepley   PetscDS   p;
5702764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
5712764a2aaSMatthew G. Knepley 
5722764a2aaSMatthew G. Knepley   PetscFunctionBegin;
5732764a2aaSMatthew G. Knepley   PetscValidPointer(prob, 2);
5742764a2aaSMatthew G. Knepley   *prob  = NULL;
5752764a2aaSMatthew G. Knepley   ierr = PetscDSInitializePackage();CHKERRQ(ierr);
5762764a2aaSMatthew G. Knepley 
57773107ff1SLisandro Dalcin   ierr = PetscHeaderCreate(p, PETSCDS_CLASSID, "PetscDS", "Discrete System", "PetscDS", comm, PetscDSDestroy, PetscDSView);CHKERRQ(ierr);
5782764a2aaSMatthew G. Knepley 
5792764a2aaSMatthew G. Knepley   p->Nf           = 0;
5802764a2aaSMatthew G. Knepley   p->setup        = PETSC_FALSE;
58197b6e6e8SMatthew G. Knepley   p->numConstants = 0;
58297b6e6e8SMatthew G. Knepley   p->constants    = NULL;
583a859676bSMatthew G. Knepley   p->dimEmbed     = -1;
58455c1f793SMatthew G. Knepley   p->useJacPre    = PETSC_TRUE;
5852764a2aaSMatthew G. Knepley 
5862764a2aaSMatthew G. Knepley   *prob = p;
5872764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
5882764a2aaSMatthew G. Knepley }
5892764a2aaSMatthew G. Knepley 
590bc4ae4beSMatthew G. Knepley /*@
591bc4ae4beSMatthew G. Knepley   PetscDSGetNumFields - Returns the number of fields in the DS
592bc4ae4beSMatthew G. Knepley 
593bc4ae4beSMatthew G. Knepley   Not collective
594bc4ae4beSMatthew G. Knepley 
595bc4ae4beSMatthew G. Knepley   Input Parameter:
596bc4ae4beSMatthew G. Knepley . prob - The PetscDS object
597bc4ae4beSMatthew G. Knepley 
598bc4ae4beSMatthew G. Knepley   Output Parameter:
599bc4ae4beSMatthew G. Knepley . Nf - The number of fields
600bc4ae4beSMatthew G. Knepley 
601bc4ae4beSMatthew G. Knepley   Level: beginner
602bc4ae4beSMatthew G. Knepley 
603bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetSpatialDimension(), PetscDSCreate()
604bc4ae4beSMatthew G. Knepley @*/
6052764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetNumFields(PetscDS prob, PetscInt *Nf)
6062764a2aaSMatthew G. Knepley {
6072764a2aaSMatthew G. Knepley   PetscFunctionBegin;
6082764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
6092764a2aaSMatthew G. Knepley   PetscValidPointer(Nf, 2);
6102764a2aaSMatthew G. Knepley   *Nf = prob->Nf;
6112764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
6122764a2aaSMatthew G. Knepley }
6132764a2aaSMatthew G. Knepley 
614bc4ae4beSMatthew G. Knepley /*@
615a859676bSMatthew G. Knepley   PetscDSGetSpatialDimension - Returns the spatial dimension of the DS, meaning the topological dimension of the discretizations
616bc4ae4beSMatthew G. Knepley 
617bc4ae4beSMatthew G. Knepley   Not collective
618bc4ae4beSMatthew G. Knepley 
619bc4ae4beSMatthew G. Knepley   Input Parameter:
620bc4ae4beSMatthew G. Knepley . prob - The PetscDS object
621bc4ae4beSMatthew G. Knepley 
622bc4ae4beSMatthew G. Knepley   Output Parameter:
623bc4ae4beSMatthew G. Knepley . dim - The spatial dimension
624bc4ae4beSMatthew G. Knepley 
625bc4ae4beSMatthew G. Knepley   Level: beginner
626bc4ae4beSMatthew G. Knepley 
627a859676bSMatthew G. Knepley .seealso: PetscDSGetCoordinateDimension(), PetscDSGetNumFields(), PetscDSCreate()
628bc4ae4beSMatthew G. Knepley @*/
6292764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetSpatialDimension(PetscDS prob, PetscInt *dim)
6302764a2aaSMatthew G. Knepley {
6312764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
6322764a2aaSMatthew G. Knepley 
6332764a2aaSMatthew G. Knepley   PetscFunctionBegin;
6342764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
6352764a2aaSMatthew G. Knepley   PetscValidPointer(dim, 2);
6362764a2aaSMatthew G. Knepley   *dim = 0;
6379de99aefSMatthew G. Knepley   if (prob->Nf) {
6389de99aefSMatthew G. Knepley     PetscObject  obj;
6399de99aefSMatthew G. Knepley     PetscClassId id;
6409de99aefSMatthew G. Knepley 
6419de99aefSMatthew G. Knepley     ierr = PetscDSGetDiscretization(prob, 0, &obj);CHKERRQ(ierr);
6429de99aefSMatthew G. Knepley     ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr);
6439de99aefSMatthew G. Knepley     if (id == PETSCFE_CLASSID)      {ierr = PetscFEGetSpatialDimension((PetscFE) obj, dim);CHKERRQ(ierr);}
6449de99aefSMatthew G. Knepley     else if (id == PETSCFV_CLASSID) {ierr = PetscFVGetSpatialDimension((PetscFV) obj, dim);CHKERRQ(ierr);}
6459de99aefSMatthew G. Knepley     else SETERRQ1(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Unknown discretization type for field %d", 0);
6469de99aefSMatthew G. Knepley   }
6472764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
6482764a2aaSMatthew G. Knepley }
6492764a2aaSMatthew G. Knepley 
650bc4ae4beSMatthew G. Knepley /*@
651a859676bSMatthew G. Knepley   PetscDSGetCoordinateDimension - Returns the coordinate dimension of the DS, meaning the dimension of the space into which the discretiaztions are embedded
652a859676bSMatthew G. Knepley 
653a859676bSMatthew G. Knepley   Not collective
654a859676bSMatthew G. Knepley 
655a859676bSMatthew G. Knepley   Input Parameter:
656a859676bSMatthew G. Knepley . prob - The PetscDS object
657a859676bSMatthew G. Knepley 
658a859676bSMatthew G. Knepley   Output Parameter:
659a859676bSMatthew G. Knepley . dimEmbed - The coordinate dimension
660a859676bSMatthew G. Knepley 
661a859676bSMatthew G. Knepley   Level: beginner
662a859676bSMatthew G. Knepley 
663a859676bSMatthew G. Knepley .seealso: PetscDSSetCoordinateDimension(), PetscDSGetSpatialDimension(), PetscDSGetNumFields(), PetscDSCreate()
664a859676bSMatthew G. Knepley @*/
665a859676bSMatthew G. Knepley PetscErrorCode PetscDSGetCoordinateDimension(PetscDS prob, PetscInt *dimEmbed)
666a859676bSMatthew G. Knepley {
667a859676bSMatthew G. Knepley   PetscFunctionBegin;
668a859676bSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
669a859676bSMatthew G. Knepley   PetscValidPointer(dimEmbed, 2);
670a859676bSMatthew G. Knepley   if (prob->dimEmbed < 0) SETERRQ(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONGSTATE, "No coordinate dimension set for this DS");
671a859676bSMatthew G. Knepley   *dimEmbed = prob->dimEmbed;
672a859676bSMatthew G. Knepley   PetscFunctionReturn(0);
673a859676bSMatthew G. Knepley }
674a859676bSMatthew G. Knepley 
675a859676bSMatthew G. Knepley /*@
676a859676bSMatthew G. Knepley   PetscDSSetCoordinateDimension - Set the coordinate dimension of the DS, meaning the dimension of the space into which the discretiaztions are embedded
677a859676bSMatthew G. Knepley 
678ebfe4b0dSMatthew G. Knepley   Logically collective on DS
679a859676bSMatthew G. Knepley 
680a859676bSMatthew G. Knepley   Input Parameters:
681a859676bSMatthew G. Knepley + prob - The PetscDS object
682a859676bSMatthew G. Knepley - dimEmbed - The coordinate dimension
683a859676bSMatthew G. Knepley 
684a859676bSMatthew G. Knepley   Level: beginner
685a859676bSMatthew G. Knepley 
686a859676bSMatthew G. Knepley .seealso: PetscDSGetCoordinateDimension(), PetscDSGetSpatialDimension(), PetscDSGetNumFields(), PetscDSCreate()
687a859676bSMatthew G. Knepley @*/
688a859676bSMatthew G. Knepley PetscErrorCode PetscDSSetCoordinateDimension(PetscDS prob, PetscInt dimEmbed)
689a859676bSMatthew G. Knepley {
690a859676bSMatthew G. Knepley   PetscFunctionBegin;
691a859676bSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
692ebfe4b0dSMatthew G. Knepley   if (dimEmbed < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Coordinate dimension must be non-negative, not %D", dimEmbed);
693a859676bSMatthew G. Knepley   prob->dimEmbed = dimEmbed;
694a859676bSMatthew G. Knepley   PetscFunctionReturn(0);
695a859676bSMatthew G. Knepley }
696a859676bSMatthew G. Knepley 
697a859676bSMatthew G. Knepley /*@
6988edf6225SMatthew G. Knepley   PetscDSGetHybrid - Returns the flag for a hybrid (cohesive) cell
6998edf6225SMatthew G. Knepley 
7008edf6225SMatthew G. Knepley   Not collective
7018edf6225SMatthew G. Knepley 
7028edf6225SMatthew G. Knepley   Input Parameter:
7038edf6225SMatthew G. Knepley . prob - The PetscDS object
7048edf6225SMatthew G. Knepley 
7058edf6225SMatthew G. Knepley   Output Parameter:
7068edf6225SMatthew G. Knepley . isHybrid - The flag
7078edf6225SMatthew G. Knepley 
7088edf6225SMatthew G. Knepley   Level: developer
7098edf6225SMatthew G. Knepley 
7108edf6225SMatthew G. Knepley .seealso: PetscDSSetHybrid(), PetscDSCreate()
7118edf6225SMatthew G. Knepley @*/
7128edf6225SMatthew G. Knepley PetscErrorCode PetscDSGetHybrid(PetscDS prob, PetscBool *isHybrid)
7138edf6225SMatthew G. Knepley {
7148edf6225SMatthew G. Knepley   PetscFunctionBegin;
7158edf6225SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
7168edf6225SMatthew G. Knepley   PetscValidPointer(isHybrid, 2);
7178edf6225SMatthew G. Knepley   *isHybrid = prob->isHybrid;
7188edf6225SMatthew G. Knepley   PetscFunctionReturn(0);
7198edf6225SMatthew G. Knepley }
7208edf6225SMatthew G. Knepley 
7218edf6225SMatthew G. Knepley /*@
7228edf6225SMatthew G. Knepley   PetscDSSetHybrid - Set the flag for a hybrid (cohesive) cell
7238edf6225SMatthew G. Knepley 
7248edf6225SMatthew G. Knepley   Not collective
7258edf6225SMatthew G. Knepley 
7268edf6225SMatthew G. Knepley   Input Parameters:
7278edf6225SMatthew G. Knepley + prob - The PetscDS object
7288edf6225SMatthew G. Knepley - isHybrid - The flag
7298edf6225SMatthew G. Knepley 
7308edf6225SMatthew G. Knepley   Level: developer
7318edf6225SMatthew G. Knepley 
7328edf6225SMatthew G. Knepley .seealso: PetscDSGetHybrid(), PetscDSCreate()
7338edf6225SMatthew G. Knepley @*/
7348edf6225SMatthew G. Knepley PetscErrorCode PetscDSSetHybrid(PetscDS prob, PetscBool isHybrid)
7358edf6225SMatthew G. Knepley {
7368edf6225SMatthew G. Knepley   PetscFunctionBegin;
7378edf6225SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
7388edf6225SMatthew G. Knepley   prob->isHybrid = isHybrid;
7398edf6225SMatthew G. Knepley   PetscFunctionReturn(0);
7408edf6225SMatthew G. Knepley }
7418edf6225SMatthew G. Knepley 
7428edf6225SMatthew G. Knepley /*@
743bc4ae4beSMatthew G. Knepley   PetscDSGetTotalDimension - Returns the total size of the approximation space for this system
744bc4ae4beSMatthew G. Knepley 
745bc4ae4beSMatthew G. Knepley   Not collective
746bc4ae4beSMatthew G. Knepley 
747bc4ae4beSMatthew G. Knepley   Input Parameter:
748bc4ae4beSMatthew G. Knepley . prob - The PetscDS object
749bc4ae4beSMatthew G. Knepley 
750bc4ae4beSMatthew G. Knepley   Output Parameter:
751bc4ae4beSMatthew G. Knepley . dim - The total problem dimension
752bc4ae4beSMatthew G. Knepley 
753bc4ae4beSMatthew G. Knepley   Level: beginner
754bc4ae4beSMatthew G. Knepley 
755bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetNumFields(), PetscDSCreate()
756bc4ae4beSMatthew G. Knepley @*/
7572764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetTotalDimension(PetscDS prob, PetscInt *dim)
7582764a2aaSMatthew G. Knepley {
7592764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
7602764a2aaSMatthew G. Knepley 
7612764a2aaSMatthew G. Knepley   PetscFunctionBegin;
7622764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
7632764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
7642764a2aaSMatthew G. Knepley   PetscValidPointer(dim, 2);
7652764a2aaSMatthew G. Knepley   *dim = prob->totDim;
7662764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
7672764a2aaSMatthew G. Knepley }
7682764a2aaSMatthew G. Knepley 
769bc4ae4beSMatthew G. Knepley /*@
770bc4ae4beSMatthew G. Knepley   PetscDSGetTotalComponents - Returns the total number of components in this system
771bc4ae4beSMatthew G. Knepley 
772bc4ae4beSMatthew G. Knepley   Not collective
773bc4ae4beSMatthew G. Knepley 
774bc4ae4beSMatthew G. Knepley   Input Parameter:
775bc4ae4beSMatthew G. Knepley . prob - The PetscDS object
776bc4ae4beSMatthew G. Knepley 
777bc4ae4beSMatthew G. Knepley   Output Parameter:
778bc4ae4beSMatthew G. Knepley . dim - The total number of components
779bc4ae4beSMatthew G. Knepley 
780bc4ae4beSMatthew G. Knepley   Level: beginner
781bc4ae4beSMatthew G. Knepley 
782bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetNumFields(), PetscDSCreate()
783bc4ae4beSMatthew G. Knepley @*/
7842764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetTotalComponents(PetscDS prob, PetscInt *Nc)
7852764a2aaSMatthew G. Knepley {
7862764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
7872764a2aaSMatthew G. Knepley 
7882764a2aaSMatthew G. Knepley   PetscFunctionBegin;
7892764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
7902764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
7912764a2aaSMatthew G. Knepley   PetscValidPointer(Nc, 2);
7922764a2aaSMatthew G. Knepley   *Nc = prob->totComp;
7932764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
7942764a2aaSMatthew G. Knepley }
7952764a2aaSMatthew G. Knepley 
796bc4ae4beSMatthew G. Knepley /*@
797bc4ae4beSMatthew G. Knepley   PetscDSGetDiscretization - Returns the discretization object for the given field
798bc4ae4beSMatthew G. Knepley 
799bc4ae4beSMatthew G. Knepley   Not collective
800bc4ae4beSMatthew G. Knepley 
801bc4ae4beSMatthew G. Knepley   Input Parameters:
802bc4ae4beSMatthew G. Knepley + prob - The PetscDS object
803bc4ae4beSMatthew G. Knepley - f - The field number
804bc4ae4beSMatthew G. Knepley 
805bc4ae4beSMatthew G. Knepley   Output Parameter:
806bc4ae4beSMatthew G. Knepley . disc - The discretization object
807bc4ae4beSMatthew G. Knepley 
808bc4ae4beSMatthew G. Knepley   Level: beginner
809bc4ae4beSMatthew G. Knepley 
810f744cafaSSander Arens .seealso: PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
811bc4ae4beSMatthew G. Knepley @*/
8122764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetDiscretization(PetscDS prob, PetscInt f, PetscObject *disc)
8132764a2aaSMatthew G. Knepley {
8142764a2aaSMatthew G. Knepley   PetscFunctionBegin;
8152764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
8162764a2aaSMatthew G. Knepley   PetscValidPointer(disc, 3);
8172764a2aaSMatthew G. Knepley   if ((f < 0) || (f >= prob->Nf)) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, prob->Nf);
8182764a2aaSMatthew G. Knepley   *disc = prob->disc[f];
8192764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
8202764a2aaSMatthew G. Knepley }
8212764a2aaSMatthew G. Knepley 
822bc4ae4beSMatthew G. Knepley /*@
823bc4ae4beSMatthew G. Knepley   PetscDSSetDiscretization - Sets the discretization object for the given field
824bc4ae4beSMatthew G. Knepley 
825bc4ae4beSMatthew G. Knepley   Not collective
826bc4ae4beSMatthew G. Knepley 
827bc4ae4beSMatthew G. Knepley   Input Parameters:
828bc4ae4beSMatthew G. Knepley + prob - The PetscDS object
829bc4ae4beSMatthew G. Knepley . f - The field number
830bc4ae4beSMatthew G. Knepley - disc - The discretization object
831bc4ae4beSMatthew G. Knepley 
832bc4ae4beSMatthew G. Knepley   Level: beginner
833bc4ae4beSMatthew G. Knepley 
834bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
835bc4ae4beSMatthew G. Knepley @*/
8362764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetDiscretization(PetscDS prob, PetscInt f, PetscObject disc)
8372764a2aaSMatthew G. Knepley {
8382764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
8392764a2aaSMatthew G. Knepley 
8402764a2aaSMatthew G. Knepley   PetscFunctionBegin;
8412764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
8422764a2aaSMatthew G. Knepley   PetscValidPointer(disc, 3);
8432764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
8442764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
845c10f2116SMatthew G. Knepley   ierr = PetscObjectDereference(prob->disc[f]);CHKERRQ(ierr);
8462764a2aaSMatthew G. Knepley   prob->disc[f] = disc;
8472764a2aaSMatthew G. Knepley   ierr = PetscObjectReference(disc);CHKERRQ(ierr);
848249df284SMatthew G. Knepley   {
849249df284SMatthew G. Knepley     PetscClassId id;
850249df284SMatthew G. Knepley 
851249df284SMatthew G. Knepley     ierr = PetscObjectGetClassId(disc, &id);CHKERRQ(ierr);
8521cf84007SMatthew G. Knepley     if (id == PETSCFE_CLASSID) {
8531cf84007SMatthew G. Knepley       ierr = PetscDSSetImplicit(prob, f, PETSC_TRUE);CHKERRQ(ierr);
8541cf84007SMatthew G. Knepley     } else if (id == PETSCFV_CLASSID) {
8551cf84007SMatthew G. Knepley       ierr = PetscDSSetImplicit(prob, f, PETSC_FALSE);CHKERRQ(ierr);
856a6cbbb48SMatthew G. Knepley     }
857249df284SMatthew G. Knepley   }
8582764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
8592764a2aaSMatthew G. Knepley }
8602764a2aaSMatthew G. Knepley 
861bc4ae4beSMatthew G. Knepley /*@
862bc4ae4beSMatthew G. Knepley   PetscDSAddDiscretization - Adds a discretization object
863bc4ae4beSMatthew G. Knepley 
864bc4ae4beSMatthew G. Knepley   Not collective
865bc4ae4beSMatthew G. Knepley 
866bc4ae4beSMatthew G. Knepley   Input Parameters:
867bc4ae4beSMatthew G. Knepley + prob - The PetscDS object
868bc4ae4beSMatthew G. Knepley - disc - The boundary discretization object
869bc4ae4beSMatthew G. Knepley 
870bc4ae4beSMatthew G. Knepley   Level: beginner
871bc4ae4beSMatthew G. Knepley 
872bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetDiscretization(), PetscDSSetDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
873bc4ae4beSMatthew G. Knepley @*/
8742764a2aaSMatthew G. Knepley PetscErrorCode PetscDSAddDiscretization(PetscDS prob, PetscObject disc)
8752764a2aaSMatthew G. Knepley {
8762764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
8772764a2aaSMatthew G. Knepley 
8782764a2aaSMatthew G. Knepley   PetscFunctionBegin;
8792764a2aaSMatthew G. Knepley   ierr = PetscDSSetDiscretization(prob, prob->Nf, disc);CHKERRQ(ierr);
8802764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
8812764a2aaSMatthew G. Knepley }
8822764a2aaSMatthew G. Knepley 
883249df284SMatthew G. Knepley /*@
884249df284SMatthew G. Knepley   PetscDSGetImplicit - Returns the flag for implicit solve for this field. This is just a guide for IMEX
885249df284SMatthew G. Knepley 
886249df284SMatthew G. Knepley   Not collective
887249df284SMatthew G. Knepley 
888249df284SMatthew G. Knepley   Input Parameters:
889249df284SMatthew G. Knepley + prob - The PetscDS object
890249df284SMatthew G. Knepley - f - The field number
891249df284SMatthew G. Knepley 
892249df284SMatthew G. Knepley   Output Parameter:
893249df284SMatthew G. Knepley . implicit - The flag indicating what kind of solve to use for this field
894249df284SMatthew G. Knepley 
895249df284SMatthew G. Knepley   Level: developer
896249df284SMatthew G. Knepley 
897f744cafaSSander Arens .seealso: PetscDSSetImplicit(), PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
898249df284SMatthew G. Knepley @*/
899249df284SMatthew G. Knepley PetscErrorCode PetscDSGetImplicit(PetscDS prob, PetscInt f, PetscBool *implicit)
900249df284SMatthew G. Knepley {
901249df284SMatthew G. Knepley   PetscFunctionBegin;
902249df284SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
903249df284SMatthew G. Knepley   PetscValidPointer(implicit, 3);
904249df284SMatthew G. Knepley   if ((f < 0) || (f >= prob->Nf)) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, prob->Nf);
905249df284SMatthew G. Knepley   *implicit = prob->implicit[f];
906249df284SMatthew G. Knepley   PetscFunctionReturn(0);
907249df284SMatthew G. Knepley }
908249df284SMatthew G. Knepley 
909249df284SMatthew G. Knepley /*@
910249df284SMatthew G. Knepley   PetscDSSetImplicit - Set the flag for implicit solve for this field. This is just a guide for IMEX
911249df284SMatthew G. Knepley 
912249df284SMatthew G. Knepley   Not collective
913249df284SMatthew G. Knepley 
914249df284SMatthew G. Knepley   Input Parameters:
915249df284SMatthew G. Knepley + prob - The PetscDS object
916249df284SMatthew G. Knepley . f - The field number
917249df284SMatthew G. Knepley - implicit - The flag indicating what kind of solve to use for this field
918249df284SMatthew G. Knepley 
919249df284SMatthew G. Knepley   Level: developer
920249df284SMatthew G. Knepley 
921f744cafaSSander Arens .seealso: PetscDSGetImplicit(), PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
922249df284SMatthew G. Knepley @*/
923249df284SMatthew G. Knepley PetscErrorCode PetscDSSetImplicit(PetscDS prob, PetscInt f, PetscBool implicit)
924249df284SMatthew G. Knepley {
925249df284SMatthew G. Knepley   PetscFunctionBegin;
926249df284SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
927249df284SMatthew G. Knepley   if ((f < 0) || (f >= prob->Nf)) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, prob->Nf);
928249df284SMatthew G. Knepley   prob->implicit[f] = implicit;
929249df284SMatthew G. Knepley   PetscFunctionReturn(0);
930249df284SMatthew G. Knepley }
931249df284SMatthew G. Knepley 
9322764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetObjective(PetscDS prob, PetscInt f,
93330b9ff8bSMatthew G. Knepley                                    void (**obj)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
934194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
935194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
93697b6e6e8SMatthew G. Knepley                                                 PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar obj[]))
9372764a2aaSMatthew G. Knepley {
9382764a2aaSMatthew G. Knepley   PetscFunctionBegin;
9392764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
9402764a2aaSMatthew G. Knepley   PetscValidPointer(obj, 2);
9412764a2aaSMatthew G. Knepley   if ((f < 0) || (f >= prob->Nf)) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, prob->Nf);
9422764a2aaSMatthew G. Knepley   *obj = prob->obj[f];
9432764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
9442764a2aaSMatthew G. Knepley }
9452764a2aaSMatthew G. Knepley 
9462764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetObjective(PetscDS prob, PetscInt f,
94730b9ff8bSMatthew G. Knepley                                    void (*obj)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
948194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
949194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
95097b6e6e8SMatthew G. Knepley                                                PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar obj[]))
9512764a2aaSMatthew G. Knepley {
9522764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
9532764a2aaSMatthew G. Knepley 
9542764a2aaSMatthew G. Knepley   PetscFunctionBegin;
9552764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
956de716cbcSToby Isaac   if (obj) PetscValidFunction(obj, 2);
9572764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
9582764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
9592764a2aaSMatthew G. Knepley   prob->obj[f] = obj;
9602764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
9612764a2aaSMatthew G. Knepley }
9622764a2aaSMatthew G. Knepley 
963194d53e6SMatthew G. Knepley /*@C
964194d53e6SMatthew G. Knepley   PetscDSGetResidual - Get the pointwise residual function for a given test field
965194d53e6SMatthew G. Knepley 
966194d53e6SMatthew G. Knepley   Not collective
967194d53e6SMatthew G. Knepley 
968194d53e6SMatthew G. Knepley   Input Parameters:
969194d53e6SMatthew G. Knepley + prob - The PetscDS
970194d53e6SMatthew G. Knepley - f    - The test field number
971194d53e6SMatthew G. Knepley 
972194d53e6SMatthew G. Knepley   Output Parameters:
973194d53e6SMatthew G. Knepley + f0 - integrand for the test function term
974194d53e6SMatthew G. Knepley - f1 - integrand for the test function gradient term
975194d53e6SMatthew G. Knepley 
976194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
977194d53e6SMatthew G. Knepley 
978194d53e6SMatthew G. Knepley   \int_\Omega \phi f_0(u, u_t, \nabla u, x, t) + \nabla\phi \cdot {\vec f}_1(u, u_t, \nabla u, x, t)
979194d53e6SMatthew G. Knepley 
980194d53e6SMatthew G. Knepley The calling sequence for the callbacks f0 and f1 is given by:
981194d53e6SMatthew G. Knepley 
98230b9ff8bSMatthew G. Knepley $ f0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
983194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
984194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
98530b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], PetscScalar f0[])
986194d53e6SMatthew G. Knepley 
987194d53e6SMatthew G. Knepley + dim - the spatial dimension
988194d53e6SMatthew G. Knepley . Nf - the number of fields
989194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
990194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
991194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
992194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
993194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
994194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
995194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
996194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
997194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
998194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
999194d53e6SMatthew G. Knepley . t - current time
1000194d53e6SMatthew G. Knepley . x - coordinates of the current point
100197b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
100297b6e6e8SMatthew G. Knepley . constants - constant parameters
1003194d53e6SMatthew G. Knepley - f0 - output values at the current point
1004194d53e6SMatthew G. Knepley 
1005194d53e6SMatthew G. Knepley   Level: intermediate
1006194d53e6SMatthew G. Knepley 
1007194d53e6SMatthew G. Knepley .seealso: PetscDSSetResidual()
1008194d53e6SMatthew G. Knepley @*/
10092764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetResidual(PetscDS prob, PetscInt f,
101030b9ff8bSMatthew G. Knepley                                   void (**f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1011194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1012194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
101397b6e6e8SMatthew G. Knepley                                               PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f0[]),
101430b9ff8bSMatthew G. Knepley                                   void (**f1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1015194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1016194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
101797b6e6e8SMatthew G. Knepley                                               PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f1[]))
10182764a2aaSMatthew G. Knepley {
10192764a2aaSMatthew G. Knepley   PetscFunctionBegin;
10202764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
10212764a2aaSMatthew G. Knepley   if ((f < 0) || (f >= prob->Nf)) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, prob->Nf);
10222764a2aaSMatthew G. Knepley   if (f0) {PetscValidPointer(f0, 3); *f0 = prob->f[f*2+0];}
10232764a2aaSMatthew G. Knepley   if (f1) {PetscValidPointer(f1, 4); *f1 = prob->f[f*2+1];}
10242764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
10252764a2aaSMatthew G. Knepley }
10262764a2aaSMatthew G. Knepley 
1027194d53e6SMatthew G. Knepley /*@C
1028194d53e6SMatthew G. Knepley   PetscDSSetResidual - Set the pointwise residual function for a given test field
1029194d53e6SMatthew G. Knepley 
1030194d53e6SMatthew G. Knepley   Not collective
1031194d53e6SMatthew G. Knepley 
1032194d53e6SMatthew G. Knepley   Input Parameters:
1033194d53e6SMatthew G. Knepley + prob - The PetscDS
1034194d53e6SMatthew G. Knepley . f    - The test field number
1035194d53e6SMatthew G. Knepley . f0 - integrand for the test function term
1036194d53e6SMatthew G. Knepley - f1 - integrand for the test function gradient term
1037194d53e6SMatthew G. Knepley 
1038194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1039194d53e6SMatthew G. Knepley 
1040194d53e6SMatthew G. Knepley   \int_\Omega \phi f_0(u, u_t, \nabla u, x, t) + \nabla\phi \cdot {\vec f}_1(u, u_t, \nabla u, x, t)
1041194d53e6SMatthew G. Knepley 
1042194d53e6SMatthew G. Knepley The calling sequence for the callbacks f0 and f1 is given by:
1043194d53e6SMatthew G. Knepley 
104430b9ff8bSMatthew G. Knepley $ f0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1045194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1046194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
104730b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], PetscScalar f0[])
1048194d53e6SMatthew G. Knepley 
1049194d53e6SMatthew G. Knepley + dim - the spatial dimension
1050194d53e6SMatthew G. Knepley . Nf - the number of fields
1051194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1052194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1053194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
1054194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1055194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1056194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1057194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1058194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1059194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1060194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1061194d53e6SMatthew G. Knepley . t - current time
1062194d53e6SMatthew G. Knepley . x - coordinates of the current point
106397b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
106497b6e6e8SMatthew G. Knepley . constants - constant parameters
1065194d53e6SMatthew G. Knepley - f0 - output values at the current point
1066194d53e6SMatthew G. Knepley 
1067194d53e6SMatthew G. Knepley   Level: intermediate
1068194d53e6SMatthew G. Knepley 
1069194d53e6SMatthew G. Knepley .seealso: PetscDSGetResidual()
1070194d53e6SMatthew G. Knepley @*/
10712764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetResidual(PetscDS prob, PetscInt f,
107230b9ff8bSMatthew G. Knepley                                   void (*f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1073194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1074194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
107597b6e6e8SMatthew G. Knepley                                              PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f0[]),
107630b9ff8bSMatthew G. Knepley                                   void (*f1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1077194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1078194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
107997b6e6e8SMatthew G. Knepley                                              PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f1[]))
10802764a2aaSMatthew G. Knepley {
10812764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
10822764a2aaSMatthew G. Knepley 
10832764a2aaSMatthew G. Knepley   PetscFunctionBegin;
10842764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1085f866a1d0SMatthew G. Knepley   if (f0) PetscValidFunction(f0, 3);
1086f866a1d0SMatthew G. Knepley   if (f1) PetscValidFunction(f1, 4);
10872764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
10882764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
10892764a2aaSMatthew G. Knepley   prob->f[f*2+0] = f0;
10902764a2aaSMatthew G. Knepley   prob->f[f*2+1] = f1;
10912764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
10922764a2aaSMatthew G. Knepley }
10932764a2aaSMatthew G. Knepley 
10943e75805dSMatthew G. Knepley /*@C
10953e75805dSMatthew G. Knepley   PetscDSHasJacobian - Signals that Jacobian functions have been set
10963e75805dSMatthew G. Knepley 
10973e75805dSMatthew G. Knepley   Not collective
10983e75805dSMatthew G. Knepley 
10993e75805dSMatthew G. Knepley   Input Parameter:
11003e75805dSMatthew G. Knepley . prob - The PetscDS
11013e75805dSMatthew G. Knepley 
11023e75805dSMatthew G. Knepley   Output Parameter:
11033e75805dSMatthew G. Knepley . hasJac - flag that pointwise function for the Jacobian has been set
11043e75805dSMatthew G. Knepley 
11053e75805dSMatthew G. Knepley   Level: intermediate
11063e75805dSMatthew G. Knepley 
11073e75805dSMatthew G. Knepley .seealso: PetscDSGetJacobianPreconditioner(), PetscDSSetJacobianPreconditioner(), PetscDSGetJacobian()
11083e75805dSMatthew G. Knepley @*/
11093e75805dSMatthew G. Knepley PetscErrorCode PetscDSHasJacobian(PetscDS prob, PetscBool *hasJac)
11103e75805dSMatthew G. Knepley {
11113e75805dSMatthew G. Knepley   PetscInt f, g, h;
11123e75805dSMatthew G. Knepley 
11133e75805dSMatthew G. Knepley   PetscFunctionBegin;
11143e75805dSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
11153e75805dSMatthew G. Knepley   *hasJac = PETSC_FALSE;
11163e75805dSMatthew G. Knepley   for (f = 0; f < prob->Nf; ++f) {
11173e75805dSMatthew G. Knepley     for (g = 0; g < prob->Nf; ++g) {
11183e75805dSMatthew G. Knepley       for (h = 0; h < 4; ++h) {
11193e75805dSMatthew G. Knepley         if (prob->g[(f*prob->Nf + g)*4+h]) *hasJac = PETSC_TRUE;
11203e75805dSMatthew G. Knepley       }
11213e75805dSMatthew G. Knepley     }
11223e75805dSMatthew G. Knepley   }
11233e75805dSMatthew G. Knepley   PetscFunctionReturn(0);
11243e75805dSMatthew G. Knepley }
11253e75805dSMatthew G. Knepley 
1126194d53e6SMatthew G. Knepley /*@C
1127194d53e6SMatthew G. Knepley   PetscDSGetJacobian - Get the pointwise Jacobian function for given test and basis field
1128194d53e6SMatthew G. Knepley 
1129194d53e6SMatthew G. Knepley   Not collective
1130194d53e6SMatthew G. Knepley 
1131194d53e6SMatthew G. Knepley   Input Parameters:
1132194d53e6SMatthew G. Knepley + prob - The PetscDS
1133194d53e6SMatthew G. Knepley . f    - The test field number
1134194d53e6SMatthew G. Knepley - g    - The field number
1135194d53e6SMatthew G. Knepley 
1136194d53e6SMatthew G. Knepley   Output Parameters:
1137194d53e6SMatthew G. Knepley + g0 - integrand for the test and basis function term
1138194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1139194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1140194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1141194d53e6SMatthew G. Knepley 
1142194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1143194d53e6SMatthew G. Knepley 
1144194d53e6SMatthew G. Knepley   \int_\Omega \phi g_0(u, u_t, \nabla u, x, t) \psi + \phi {\vec g}_1(u, u_t, \nabla u, x, t) \nabla \psi + \nabla\phi \cdot {\vec g}_2(u, u_t, \nabla u, x, t) \psi + \nabla\phi \cdot {\overleftrightarrow g}_3(u, u_t, \nabla u, x, t) \cdot \nabla \psi
1145194d53e6SMatthew G. Knepley 
1146194d53e6SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1147194d53e6SMatthew G. Knepley 
114830b9ff8bSMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1149194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1150194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
115130b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal u_tShift, const PetscReal x[], PetscScalar g0[])
1152194d53e6SMatthew G. Knepley 
1153194d53e6SMatthew G. Knepley + dim - the spatial dimension
1154194d53e6SMatthew G. Knepley . Nf - the number of fields
1155194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1156194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1157194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
1158194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1159194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1160194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1161194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1162194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1163194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1164194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1165194d53e6SMatthew G. Knepley . t - current time
11662aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1167194d53e6SMatthew G. Knepley . x - coordinates of the current point
116897b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
116997b6e6e8SMatthew G. Knepley . constants - constant parameters
1170194d53e6SMatthew G. Knepley - g0 - output values at the current point
1171194d53e6SMatthew G. Knepley 
1172194d53e6SMatthew G. Knepley   Level: intermediate
1173194d53e6SMatthew G. Knepley 
1174194d53e6SMatthew G. Knepley .seealso: PetscDSSetJacobian()
1175194d53e6SMatthew G. Knepley @*/
11762764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetJacobian(PetscDS prob, PetscInt f, PetscInt g,
117730b9ff8bSMatthew G. Knepley                                   void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1178194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1179194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
118097b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
118130b9ff8bSMatthew G. Knepley                                   void (**g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1182194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1183194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
118497b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
118530b9ff8bSMatthew G. Knepley                                   void (**g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1186194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1187194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
118897b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
118930b9ff8bSMatthew G. Knepley                                   void (**g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1190194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1191194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
119297b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
11932764a2aaSMatthew G. Knepley {
11942764a2aaSMatthew G. Knepley   PetscFunctionBegin;
11952764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
11962764a2aaSMatthew G. Knepley   if ((f < 0) || (f >= prob->Nf)) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, prob->Nf);
11972764a2aaSMatthew G. Knepley   if ((g < 0) || (g >= prob->Nf)) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", g, prob->Nf);
11982764a2aaSMatthew G. Knepley   if (g0) {PetscValidPointer(g0, 4); *g0 = prob->g[(f*prob->Nf + g)*4+0];}
11992764a2aaSMatthew G. Knepley   if (g1) {PetscValidPointer(g1, 5); *g1 = prob->g[(f*prob->Nf + g)*4+1];}
12002764a2aaSMatthew G. Knepley   if (g2) {PetscValidPointer(g2, 6); *g2 = prob->g[(f*prob->Nf + g)*4+2];}
12012764a2aaSMatthew G. Knepley   if (g3) {PetscValidPointer(g3, 7); *g3 = prob->g[(f*prob->Nf + g)*4+3];}
12022764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
12032764a2aaSMatthew G. Knepley }
12042764a2aaSMatthew G. Knepley 
1205194d53e6SMatthew G. Knepley /*@C
1206194d53e6SMatthew G. Knepley   PetscDSSetJacobian - Set the pointwise Jacobian function for given test and basis fields
1207194d53e6SMatthew G. Knepley 
1208194d53e6SMatthew G. Knepley   Not collective
1209194d53e6SMatthew G. Knepley 
1210194d53e6SMatthew G. Knepley   Input Parameters:
1211194d53e6SMatthew G. Knepley + prob - The PetscDS
1212194d53e6SMatthew G. Knepley . f    - The test field number
1213194d53e6SMatthew G. Knepley . g    - The field number
1214194d53e6SMatthew G. Knepley . g0 - integrand for the test and basis function term
1215194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1216194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1217194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1218194d53e6SMatthew G. Knepley 
1219194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1220194d53e6SMatthew G. Knepley 
1221194d53e6SMatthew G. Knepley   \int_\Omega \phi g_0(u, u_t, \nabla u, x, t) \psi + \phi {\vec g}_1(u, u_t, \nabla u, x, t) \nabla \psi + \nabla\phi \cdot {\vec g}_2(u, u_t, \nabla u, x, t) \psi + \nabla\phi \cdot {\overleftrightarrow g}_3(u, u_t, \nabla u, x, t) \cdot \nabla \psi
1222194d53e6SMatthew G. Knepley 
1223194d53e6SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1224194d53e6SMatthew G. Knepley 
122530b9ff8bSMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1226194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1227194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
122830b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], PetscScalar g0[])
1229194d53e6SMatthew G. Knepley 
1230194d53e6SMatthew G. Knepley + dim - the spatial dimension
1231194d53e6SMatthew G. Knepley . Nf - the number of fields
1232194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1233194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1234194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
1235194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1236194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1237194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1238194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1239194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1240194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1241194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1242194d53e6SMatthew G. Knepley . t - current time
12432aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1244194d53e6SMatthew G. Knepley . x - coordinates of the current point
124597b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
124697b6e6e8SMatthew G. Knepley . constants - constant parameters
1247194d53e6SMatthew G. Knepley - g0 - output values at the current point
1248194d53e6SMatthew G. Knepley 
1249194d53e6SMatthew G. Knepley   Level: intermediate
1250194d53e6SMatthew G. Knepley 
1251194d53e6SMatthew G. Knepley .seealso: PetscDSGetJacobian()
1252194d53e6SMatthew G. Knepley @*/
12532764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetJacobian(PetscDS prob, PetscInt f, PetscInt g,
125430b9ff8bSMatthew G. Knepley                                   void (*g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1255194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1256194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
125797b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
125830b9ff8bSMatthew G. Knepley                                   void (*g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1259194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1260194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
126197b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
126230b9ff8bSMatthew G. Knepley                                   void (*g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1263194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1264194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
126597b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
126630b9ff8bSMatthew G. Knepley                                   void (*g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1267194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1268194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
126997b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
12702764a2aaSMatthew G. Knepley {
12712764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
12722764a2aaSMatthew G. Knepley 
12732764a2aaSMatthew G. Knepley   PetscFunctionBegin;
12742764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
12752764a2aaSMatthew G. Knepley   if (g0) PetscValidFunction(g0, 4);
12762764a2aaSMatthew G. Knepley   if (g1) PetscValidFunction(g1, 5);
12772764a2aaSMatthew G. Knepley   if (g2) PetscValidFunction(g2, 6);
12782764a2aaSMatthew G. Knepley   if (g3) PetscValidFunction(g3, 7);
12792764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
12802764a2aaSMatthew G. Knepley   if (g < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", g);
12812764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, PetscMax(f, g)+1);CHKERRQ(ierr);
12822764a2aaSMatthew G. Knepley   prob->g[(f*prob->Nf + g)*4+0] = g0;
12832764a2aaSMatthew G. Knepley   prob->g[(f*prob->Nf + g)*4+1] = g1;
12842764a2aaSMatthew G. Knepley   prob->g[(f*prob->Nf + g)*4+2] = g2;
12852764a2aaSMatthew G. Knepley   prob->g[(f*prob->Nf + g)*4+3] = g3;
12862764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
12872764a2aaSMatthew G. Knepley }
12882764a2aaSMatthew G. Knepley 
1289475e0ac9SMatthew G. Knepley /*@C
129055c1f793SMatthew G. Knepley   PetscDSUseJacobianPreconditioner - Whether to construct a Jacobian preconditioner
129155c1f793SMatthew G. Knepley 
129255c1f793SMatthew G. Knepley   Not collective
129355c1f793SMatthew G. Knepley 
129455c1f793SMatthew G. Knepley   Input Parameters:
129555c1f793SMatthew G. Knepley + prob - The PetscDS
129655c1f793SMatthew G. Knepley - useJacPre - flag that enables construction of a Jacobian preconditioner
129755c1f793SMatthew G. Knepley 
129855c1f793SMatthew G. Knepley   Level: intermediate
129955c1f793SMatthew G. Knepley 
130055c1f793SMatthew G. Knepley .seealso: PetscDSGetJacobianPreconditioner(), PetscDSSetJacobianPreconditioner(), PetscDSGetJacobian()
130155c1f793SMatthew G. Knepley @*/
130255c1f793SMatthew G. Knepley PetscErrorCode PetscDSUseJacobianPreconditioner(PetscDS prob, PetscBool useJacPre)
130355c1f793SMatthew G. Knepley {
130455c1f793SMatthew G. Knepley   PetscFunctionBegin;
130555c1f793SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
130655c1f793SMatthew G. Knepley   prob->useJacPre = useJacPre;
130755c1f793SMatthew G. Knepley   PetscFunctionReturn(0);
130855c1f793SMatthew G. Knepley }
130955c1f793SMatthew G. Knepley 
131055c1f793SMatthew G. Knepley /*@C
1311475e0ac9SMatthew G. Knepley   PetscDSHasJacobianPreconditioner - Signals that a Jacobian preconditioner matrix has been set
1312475e0ac9SMatthew G. Knepley 
1313475e0ac9SMatthew G. Knepley   Not collective
1314475e0ac9SMatthew G. Knepley 
1315475e0ac9SMatthew G. Knepley   Input Parameter:
1316475e0ac9SMatthew G. Knepley . prob - The PetscDS
1317475e0ac9SMatthew G. Knepley 
1318475e0ac9SMatthew G. Knepley   Output Parameter:
1319475e0ac9SMatthew G. Knepley . hasJacPre - flag that pointwise function for Jacobian preconditioner matrix has been set
1320475e0ac9SMatthew G. Knepley 
1321475e0ac9SMatthew G. Knepley   Level: intermediate
1322475e0ac9SMatthew G. Knepley 
1323475e0ac9SMatthew G. Knepley .seealso: PetscDSGetJacobianPreconditioner(), PetscDSSetJacobianPreconditioner(), PetscDSGetJacobian()
1324475e0ac9SMatthew G. Knepley @*/
1325475e0ac9SMatthew G. Knepley PetscErrorCode PetscDSHasJacobianPreconditioner(PetscDS prob, PetscBool *hasJacPre)
1326475e0ac9SMatthew G. Knepley {
1327475e0ac9SMatthew G. Knepley   PetscInt f, g, h;
1328475e0ac9SMatthew G. Knepley 
1329475e0ac9SMatthew G. Knepley   PetscFunctionBegin;
1330475e0ac9SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1331475e0ac9SMatthew G. Knepley   *hasJacPre = PETSC_FALSE;
133255c1f793SMatthew G. Knepley   if (!prob->useJacPre) PetscFunctionReturn(0);
1333475e0ac9SMatthew G. Knepley   for (f = 0; f < prob->Nf; ++f) {
1334475e0ac9SMatthew G. Knepley     for (g = 0; g < prob->Nf; ++g) {
1335475e0ac9SMatthew G. Knepley       for (h = 0; h < 4; ++h) {
1336475e0ac9SMatthew G. Knepley         if (prob->gp[(f*prob->Nf + g)*4+h]) *hasJacPre = PETSC_TRUE;
1337475e0ac9SMatthew G. Knepley       }
1338475e0ac9SMatthew G. Knepley     }
1339475e0ac9SMatthew G. Knepley   }
1340475e0ac9SMatthew G. Knepley   PetscFunctionReturn(0);
1341475e0ac9SMatthew G. Knepley }
1342475e0ac9SMatthew G. Knepley 
1343475e0ac9SMatthew G. Knepley /*@C
1344475e0ac9SMatthew G. Knepley   PetscDSGetJacobianPreconditioner - Get the pointwise Jacobian preconditioner function for given test and basis field. If this is missing, the system matrix is used to build the preconditioner.
1345475e0ac9SMatthew G. Knepley 
1346475e0ac9SMatthew G. Knepley   Not collective
1347475e0ac9SMatthew G. Knepley 
1348475e0ac9SMatthew G. Knepley   Input Parameters:
1349475e0ac9SMatthew G. Knepley + prob - The PetscDS
1350475e0ac9SMatthew G. Knepley . f    - The test field number
1351475e0ac9SMatthew G. Knepley - g    - The field number
1352475e0ac9SMatthew G. Knepley 
1353475e0ac9SMatthew G. Knepley   Output Parameters:
1354475e0ac9SMatthew G. Knepley + g0 - integrand for the test and basis function term
1355475e0ac9SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1356475e0ac9SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1357475e0ac9SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1358475e0ac9SMatthew G. Knepley 
1359475e0ac9SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1360475e0ac9SMatthew G. Knepley 
1361475e0ac9SMatthew G. Knepley   \int_\Omega \phi g_0(u, u_t, \nabla u, x, t) \psi + \phi {\vec g}_1(u, u_t, \nabla u, x, t) \nabla \psi + \nabla\phi \cdot {\vec g}_2(u, u_t, \nabla u, x, t) \psi + \nabla\phi \cdot {\overleftrightarrow g}_3(u, u_t, \nabla u, x, t) \cdot \nabla \psi
1362475e0ac9SMatthew G. Knepley 
1363475e0ac9SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1364475e0ac9SMatthew G. Knepley 
1365475e0ac9SMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1366475e0ac9SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1367475e0ac9SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1368475e0ac9SMatthew G. Knepley $    PetscReal t, const PetscReal u_tShift, const PetscReal x[], PetscScalar g0[])
1369475e0ac9SMatthew G. Knepley 
1370475e0ac9SMatthew G. Knepley + dim - the spatial dimension
1371475e0ac9SMatthew G. Knepley . Nf - the number of fields
1372475e0ac9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1373475e0ac9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1374475e0ac9SMatthew G. Knepley . u - each field evaluated at the current point
1375475e0ac9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1376475e0ac9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1377475e0ac9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1378475e0ac9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1379475e0ac9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1380475e0ac9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1381475e0ac9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1382475e0ac9SMatthew G. Knepley . t - current time
1383475e0ac9SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1384475e0ac9SMatthew G. Knepley . x - coordinates of the current point
138597b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
138697b6e6e8SMatthew G. Knepley . constants - constant parameters
1387475e0ac9SMatthew G. Knepley - g0 - output values at the current point
1388475e0ac9SMatthew G. Knepley 
1389475e0ac9SMatthew G. Knepley   Level: intermediate
1390475e0ac9SMatthew G. Knepley 
1391475e0ac9SMatthew G. Knepley .seealso: PetscDSSetJacobianPreconditioner(), PetscDSGetJacobian()
1392475e0ac9SMatthew G. Knepley @*/
1393475e0ac9SMatthew G. Knepley PetscErrorCode PetscDSGetJacobianPreconditioner(PetscDS prob, PetscInt f, PetscInt g,
1394475e0ac9SMatthew G. Knepley                                   void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1395475e0ac9SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1396475e0ac9SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
139797b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
1398475e0ac9SMatthew G. Knepley                                   void (**g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1399475e0ac9SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1400475e0ac9SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
140197b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
1402475e0ac9SMatthew G. Knepley                                   void (**g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1403475e0ac9SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1404475e0ac9SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
140597b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
1406475e0ac9SMatthew G. Knepley                                   void (**g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1407475e0ac9SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1408475e0ac9SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
140997b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
1410475e0ac9SMatthew G. Knepley {
1411475e0ac9SMatthew G. Knepley   PetscFunctionBegin;
1412475e0ac9SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1413475e0ac9SMatthew G. Knepley   if ((f < 0) || (f >= prob->Nf)) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, prob->Nf);
1414475e0ac9SMatthew G. Knepley   if ((g < 0) || (g >= prob->Nf)) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", g, prob->Nf);
1415475e0ac9SMatthew G. Knepley   if (g0) {PetscValidPointer(g0, 4); *g0 = prob->gp[(f*prob->Nf + g)*4+0];}
1416475e0ac9SMatthew G. Knepley   if (g1) {PetscValidPointer(g1, 5); *g1 = prob->gp[(f*prob->Nf + g)*4+1];}
1417475e0ac9SMatthew G. Knepley   if (g2) {PetscValidPointer(g2, 6); *g2 = prob->gp[(f*prob->Nf + g)*4+2];}
1418475e0ac9SMatthew G. Knepley   if (g3) {PetscValidPointer(g3, 7); *g3 = prob->gp[(f*prob->Nf + g)*4+3];}
1419475e0ac9SMatthew G. Knepley   PetscFunctionReturn(0);
1420475e0ac9SMatthew G. Knepley }
1421475e0ac9SMatthew G. Knepley 
1422475e0ac9SMatthew G. Knepley /*@C
1423475e0ac9SMatthew G. Knepley   PetscDSSetJacobianPreconditioner - Set the pointwise Jacobian preconditioner function for given test and basis fields. If this is missing, the system matrix is used to build the preconditioner.
1424475e0ac9SMatthew G. Knepley 
1425475e0ac9SMatthew G. Knepley   Not collective
1426475e0ac9SMatthew G. Knepley 
1427475e0ac9SMatthew G. Knepley   Input Parameters:
1428475e0ac9SMatthew G. Knepley + prob - The PetscDS
1429475e0ac9SMatthew G. Knepley . f    - The test field number
1430475e0ac9SMatthew G. Knepley . g    - The field number
1431475e0ac9SMatthew G. Knepley . g0 - integrand for the test and basis function term
1432475e0ac9SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1433475e0ac9SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1434475e0ac9SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1435475e0ac9SMatthew G. Knepley 
1436475e0ac9SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1437475e0ac9SMatthew G. Knepley 
1438475e0ac9SMatthew G. Knepley   \int_\Omega \phi g_0(u, u_t, \nabla u, x, t) \psi + \phi {\vec g}_1(u, u_t, \nabla u, x, t) \nabla \psi + \nabla\phi \cdot {\vec g}_2(u, u_t, \nabla u, x, t) \psi + \nabla\phi \cdot {\overleftrightarrow g}_3(u, u_t, \nabla u, x, t) \cdot \nabla \psi
1439475e0ac9SMatthew G. Knepley 
1440475e0ac9SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1441475e0ac9SMatthew G. Knepley 
1442475e0ac9SMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1443475e0ac9SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1444475e0ac9SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1445475e0ac9SMatthew G. Knepley $    PetscReal t, const PetscReal x[], PetscScalar g0[])
1446475e0ac9SMatthew G. Knepley 
1447475e0ac9SMatthew G. Knepley + dim - the spatial dimension
1448475e0ac9SMatthew G. Knepley . Nf - the number of fields
1449475e0ac9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1450475e0ac9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1451475e0ac9SMatthew G. Knepley . u - each field evaluated at the current point
1452475e0ac9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1453475e0ac9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1454475e0ac9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1455475e0ac9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1456475e0ac9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1457475e0ac9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1458475e0ac9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1459475e0ac9SMatthew G. Knepley . t - current time
1460475e0ac9SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1461475e0ac9SMatthew G. Knepley . x - coordinates of the current point
146297b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
146397b6e6e8SMatthew G. Knepley . constants - constant parameters
1464475e0ac9SMatthew G. Knepley - g0 - output values at the current point
1465475e0ac9SMatthew G. Knepley 
1466475e0ac9SMatthew G. Knepley   Level: intermediate
1467475e0ac9SMatthew G. Knepley 
1468475e0ac9SMatthew G. Knepley .seealso: PetscDSGetJacobianPreconditioner(), PetscDSSetJacobian()
1469475e0ac9SMatthew G. Knepley @*/
1470475e0ac9SMatthew G. Knepley PetscErrorCode PetscDSSetJacobianPreconditioner(PetscDS prob, PetscInt f, PetscInt g,
1471475e0ac9SMatthew G. Knepley                                   void (*g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1472475e0ac9SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1473475e0ac9SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
147497b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
1475475e0ac9SMatthew G. Knepley                                   void (*g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1476475e0ac9SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1477475e0ac9SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
147897b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
1479475e0ac9SMatthew G. Knepley                                   void (*g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1480475e0ac9SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1481475e0ac9SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
148297b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
1483475e0ac9SMatthew G. Knepley                                   void (*g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1484475e0ac9SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1485475e0ac9SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
148697b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
1487475e0ac9SMatthew G. Knepley {
1488475e0ac9SMatthew G. Knepley   PetscErrorCode ierr;
1489475e0ac9SMatthew G. Knepley 
1490475e0ac9SMatthew G. Knepley   PetscFunctionBegin;
1491475e0ac9SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1492475e0ac9SMatthew G. Knepley   if (g0) PetscValidFunction(g0, 4);
1493475e0ac9SMatthew G. Knepley   if (g1) PetscValidFunction(g1, 5);
1494475e0ac9SMatthew G. Knepley   if (g2) PetscValidFunction(g2, 6);
1495475e0ac9SMatthew G. Knepley   if (g3) PetscValidFunction(g3, 7);
1496475e0ac9SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
1497475e0ac9SMatthew G. Knepley   if (g < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", g);
1498475e0ac9SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, PetscMax(f, g)+1);CHKERRQ(ierr);
1499475e0ac9SMatthew G. Knepley   prob->gp[(f*prob->Nf + g)*4+0] = g0;
1500475e0ac9SMatthew G. Knepley   prob->gp[(f*prob->Nf + g)*4+1] = g1;
1501475e0ac9SMatthew G. Knepley   prob->gp[(f*prob->Nf + g)*4+2] = g2;
1502475e0ac9SMatthew G. Knepley   prob->gp[(f*prob->Nf + g)*4+3] = g3;
1503475e0ac9SMatthew G. Knepley   PetscFunctionReturn(0);
1504475e0ac9SMatthew G. Knepley }
1505475e0ac9SMatthew G. Knepley 
1506b7e05686SMatthew G. Knepley /*@C
1507b7e05686SMatthew G. Knepley   PetscDSHasDynamicJacobian - Signals that a dynamic Jacobian, dF/du_t, has been set
1508b7e05686SMatthew G. Knepley 
1509b7e05686SMatthew G. Knepley   Not collective
1510b7e05686SMatthew G. Knepley 
1511b7e05686SMatthew G. Knepley   Input Parameter:
1512b7e05686SMatthew G. Knepley . prob - The PetscDS
1513b7e05686SMatthew G. Knepley 
1514b7e05686SMatthew G. Knepley   Output Parameter:
1515b7e05686SMatthew G. Knepley . hasDynJac - flag that pointwise function for dynamic Jacobian has been set
1516b7e05686SMatthew G. Knepley 
1517b7e05686SMatthew G. Knepley   Level: intermediate
1518b7e05686SMatthew G. Knepley 
1519b7e05686SMatthew G. Knepley .seealso: PetscDSGetDynamicJacobian(), PetscDSSetDynamicJacobian(), PetscDSGetJacobian()
1520b7e05686SMatthew G. Knepley @*/
1521b7e05686SMatthew G. Knepley PetscErrorCode PetscDSHasDynamicJacobian(PetscDS prob, PetscBool *hasDynJac)
1522b7e05686SMatthew G. Knepley {
1523b7e05686SMatthew G. Knepley   PetscInt f, g, h;
1524b7e05686SMatthew G. Knepley 
1525b7e05686SMatthew G. Knepley   PetscFunctionBegin;
1526b7e05686SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1527b7e05686SMatthew G. Knepley   *hasDynJac = PETSC_FALSE;
1528b7e05686SMatthew G. Knepley   for (f = 0; f < prob->Nf; ++f) {
1529b7e05686SMatthew G. Knepley     for (g = 0; g < prob->Nf; ++g) {
1530b7e05686SMatthew G. Knepley       for (h = 0; h < 4; ++h) {
1531b7e05686SMatthew G. Knepley         if (prob->gt[(f*prob->Nf + g)*4+h]) *hasDynJac = PETSC_TRUE;
1532b7e05686SMatthew G. Knepley       }
1533b7e05686SMatthew G. Knepley     }
1534b7e05686SMatthew G. Knepley   }
1535b7e05686SMatthew G. Knepley   PetscFunctionReturn(0);
1536b7e05686SMatthew G. Knepley }
1537b7e05686SMatthew G. Knepley 
1538b7e05686SMatthew G. Knepley /*@C
1539b7e05686SMatthew G. Knepley   PetscDSGetDynamicJacobian - Get the pointwise dynamic Jacobian, dF/du_t, function for given test and basis field
1540b7e05686SMatthew G. Knepley 
1541b7e05686SMatthew G. Knepley   Not collective
1542b7e05686SMatthew G. Knepley 
1543b7e05686SMatthew G. Knepley   Input Parameters:
1544b7e05686SMatthew G. Knepley + prob - The PetscDS
1545b7e05686SMatthew G. Knepley . f    - The test field number
1546b7e05686SMatthew G. Knepley - g    - The field number
1547b7e05686SMatthew G. Knepley 
1548b7e05686SMatthew G. Knepley   Output Parameters:
1549b7e05686SMatthew G. Knepley + g0 - integrand for the test and basis function term
1550b7e05686SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1551b7e05686SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1552b7e05686SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1553b7e05686SMatthew G. Knepley 
1554b7e05686SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1555b7e05686SMatthew G. Knepley 
1556b7e05686SMatthew G. Knepley   \int_\Omega \phi g_0(u, u_t, \nabla u, x, t) \psi + \phi {\vec g}_1(u, u_t, \nabla u, x, t) \nabla \psi + \nabla\phi \cdot {\vec g}_2(u, u_t, \nabla u, x, t) \psi + \nabla\phi \cdot {\overleftrightarrow g}_3(u, u_t, \nabla u, x, t) \cdot \nabla \psi
1557b7e05686SMatthew G. Knepley 
1558b7e05686SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1559b7e05686SMatthew G. Knepley 
1560b7e05686SMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1561b7e05686SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1562b7e05686SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1563b7e05686SMatthew G. Knepley $    PetscReal t, const PetscReal u_tShift, const PetscReal x[], PetscScalar g0[])
1564b7e05686SMatthew G. Knepley 
1565b7e05686SMatthew G. Knepley + dim - the spatial dimension
1566b7e05686SMatthew G. Knepley . Nf - the number of fields
1567b7e05686SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1568b7e05686SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1569b7e05686SMatthew G. Knepley . u - each field evaluated at the current point
1570b7e05686SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1571b7e05686SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1572b7e05686SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1573b7e05686SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1574b7e05686SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1575b7e05686SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1576b7e05686SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1577b7e05686SMatthew G. Knepley . t - current time
1578b7e05686SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1579b7e05686SMatthew G. Knepley . x - coordinates of the current point
158097b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
158197b6e6e8SMatthew G. Knepley . constants - constant parameters
1582b7e05686SMatthew G. Knepley - g0 - output values at the current point
1583b7e05686SMatthew G. Knepley 
1584b7e05686SMatthew G. Knepley   Level: intermediate
1585b7e05686SMatthew G. Knepley 
1586b7e05686SMatthew G. Knepley .seealso: PetscDSSetJacobian()
1587b7e05686SMatthew G. Knepley @*/
1588b7e05686SMatthew G. Knepley PetscErrorCode PetscDSGetDynamicJacobian(PetscDS prob, PetscInt f, PetscInt g,
1589b7e05686SMatthew G. Knepley                                          void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1590b7e05686SMatthew G. Knepley                                                      const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1591b7e05686SMatthew G. Knepley                                                      const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
159297b6e6e8SMatthew G. Knepley                                                      PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
1593b7e05686SMatthew G. Knepley                                          void (**g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1594b7e05686SMatthew G. Knepley                                                      const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1595b7e05686SMatthew G. Knepley                                                      const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
159697b6e6e8SMatthew G. Knepley                                                      PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
1597b7e05686SMatthew G. Knepley                                          void (**g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1598b7e05686SMatthew G. Knepley                                                      const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1599b7e05686SMatthew G. Knepley                                                      const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
160097b6e6e8SMatthew G. Knepley                                                      PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
1601b7e05686SMatthew G. Knepley                                          void (**g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1602b7e05686SMatthew G. Knepley                                                      const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1603b7e05686SMatthew G. Knepley                                                      const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
160497b6e6e8SMatthew G. Knepley                                                      PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
1605b7e05686SMatthew G. Knepley {
1606b7e05686SMatthew G. Knepley   PetscFunctionBegin;
1607b7e05686SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1608b7e05686SMatthew G. Knepley   if ((f < 0) || (f >= prob->Nf)) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, prob->Nf);
1609b7e05686SMatthew G. Knepley   if ((g < 0) || (g >= prob->Nf)) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", g, prob->Nf);
1610b7e05686SMatthew G. Knepley   if (g0) {PetscValidPointer(g0, 4); *g0 = prob->gt[(f*prob->Nf + g)*4+0];}
1611b7e05686SMatthew G. Knepley   if (g1) {PetscValidPointer(g1, 5); *g1 = prob->gt[(f*prob->Nf + g)*4+1];}
1612b7e05686SMatthew G. Knepley   if (g2) {PetscValidPointer(g2, 6); *g2 = prob->gt[(f*prob->Nf + g)*4+2];}
1613b7e05686SMatthew G. Knepley   if (g3) {PetscValidPointer(g3, 7); *g3 = prob->gt[(f*prob->Nf + g)*4+3];}
1614b7e05686SMatthew G. Knepley   PetscFunctionReturn(0);
1615b7e05686SMatthew G. Knepley }
1616b7e05686SMatthew G. Knepley 
1617b7e05686SMatthew G. Knepley /*@C
1618b7e05686SMatthew G. Knepley   PetscDSSetDynamicJacobian - Set the pointwise dynamic Jacobian, dF/du_t, function for given test and basis fields
1619b7e05686SMatthew G. Knepley 
1620b7e05686SMatthew G. Knepley   Not collective
1621b7e05686SMatthew G. Knepley 
1622b7e05686SMatthew G. Knepley   Input Parameters:
1623b7e05686SMatthew G. Knepley + prob - The PetscDS
1624b7e05686SMatthew G. Knepley . f    - The test field number
1625b7e05686SMatthew G. Knepley . g    - The field number
1626b7e05686SMatthew G. Knepley . g0 - integrand for the test and basis function term
1627b7e05686SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1628b7e05686SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1629b7e05686SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1630b7e05686SMatthew G. Knepley 
1631b7e05686SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1632b7e05686SMatthew G. Knepley 
1633b7e05686SMatthew G. Knepley   \int_\Omega \phi g_0(u, u_t, \nabla u, x, t) \psi + \phi {\vec g}_1(u, u_t, \nabla u, x, t) \nabla \psi + \nabla\phi \cdot {\vec g}_2(u, u_t, \nabla u, x, t) \psi + \nabla\phi \cdot {\overleftrightarrow g}_3(u, u_t, \nabla u, x, t) \cdot \nabla \psi
1634b7e05686SMatthew G. Knepley 
1635b7e05686SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1636b7e05686SMatthew G. Knepley 
1637b7e05686SMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1638b7e05686SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1639b7e05686SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1640b7e05686SMatthew G. Knepley $    PetscReal t, const PetscReal x[], PetscScalar g0[])
1641b7e05686SMatthew G. Knepley 
1642b7e05686SMatthew G. Knepley + dim - the spatial dimension
1643b7e05686SMatthew G. Knepley . Nf - the number of fields
1644b7e05686SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1645b7e05686SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1646b7e05686SMatthew G. Knepley . u - each field evaluated at the current point
1647b7e05686SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1648b7e05686SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1649b7e05686SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1650b7e05686SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1651b7e05686SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1652b7e05686SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1653b7e05686SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1654b7e05686SMatthew G. Knepley . t - current time
1655b7e05686SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1656b7e05686SMatthew G. Knepley . x - coordinates of the current point
165797b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
165897b6e6e8SMatthew G. Knepley . constants - constant parameters
1659b7e05686SMatthew G. Knepley - g0 - output values at the current point
1660b7e05686SMatthew G. Knepley 
1661b7e05686SMatthew G. Knepley   Level: intermediate
1662b7e05686SMatthew G. Knepley 
1663b7e05686SMatthew G. Knepley .seealso: PetscDSGetJacobian()
1664b7e05686SMatthew G. Knepley @*/
1665b7e05686SMatthew G. Knepley PetscErrorCode PetscDSSetDynamicJacobian(PetscDS prob, PetscInt f, PetscInt g,
1666b7e05686SMatthew G. Knepley                                          void (*g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1667b7e05686SMatthew G. Knepley                                                     const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1668b7e05686SMatthew G. Knepley                                                     const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
166997b6e6e8SMatthew G. Knepley                                                     PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
1670b7e05686SMatthew G. Knepley                                          void (*g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1671b7e05686SMatthew G. Knepley                                                     const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1672b7e05686SMatthew G. Knepley                                                     const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
167397b6e6e8SMatthew G. Knepley                                                     PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
1674b7e05686SMatthew G. Knepley                                          void (*g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1675b7e05686SMatthew G. Knepley                                                     const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1676b7e05686SMatthew G. Knepley                                                     const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
167797b6e6e8SMatthew G. Knepley                                                     PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
1678b7e05686SMatthew G. Knepley                                          void (*g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1679b7e05686SMatthew G. Knepley                                                     const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1680b7e05686SMatthew G. Knepley                                                     const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
168197b6e6e8SMatthew G. Knepley                                                     PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
1682b7e05686SMatthew G. Knepley {
1683b7e05686SMatthew G. Knepley   PetscErrorCode ierr;
1684b7e05686SMatthew G. Knepley 
1685b7e05686SMatthew G. Knepley   PetscFunctionBegin;
1686b7e05686SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1687b7e05686SMatthew G. Knepley   if (g0) PetscValidFunction(g0, 4);
1688b7e05686SMatthew G. Knepley   if (g1) PetscValidFunction(g1, 5);
1689b7e05686SMatthew G. Knepley   if (g2) PetscValidFunction(g2, 6);
1690b7e05686SMatthew G. Knepley   if (g3) PetscValidFunction(g3, 7);
1691b7e05686SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
1692b7e05686SMatthew G. Knepley   if (g < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", g);
1693b7e05686SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, PetscMax(f, g)+1);CHKERRQ(ierr);
1694b7e05686SMatthew G. Knepley   prob->gt[(f*prob->Nf + g)*4+0] = g0;
1695b7e05686SMatthew G. Knepley   prob->gt[(f*prob->Nf + g)*4+1] = g1;
1696b7e05686SMatthew G. Knepley   prob->gt[(f*prob->Nf + g)*4+2] = g2;
1697b7e05686SMatthew G. Knepley   prob->gt[(f*prob->Nf + g)*4+3] = g3;
1698b7e05686SMatthew G. Knepley   PetscFunctionReturn(0);
1699b7e05686SMatthew G. Knepley }
1700b7e05686SMatthew G. Knepley 
17010c2f2876SMatthew G. Knepley /*@C
17020c2f2876SMatthew G. Knepley   PetscDSGetRiemannSolver - Returns the Riemann solver for the given field
17030c2f2876SMatthew G. Knepley 
17040c2f2876SMatthew G. Knepley   Not collective
17050c2f2876SMatthew G. Knepley 
17060c2f2876SMatthew G. Knepley   Input Arguments:
17070c2f2876SMatthew G. Knepley + prob - The PetscDS object
17080c2f2876SMatthew G. Knepley - f    - The field number
17090c2f2876SMatthew G. Knepley 
17100c2f2876SMatthew G. Knepley   Output Argument:
17110c2f2876SMatthew G. Knepley . r    - Riemann solver
17120c2f2876SMatthew G. Knepley 
17130c2f2876SMatthew G. Knepley   Calling sequence for r:
17140c2f2876SMatthew G. Knepley 
17155db36cf9SMatthew G. Knepley $ r(PetscInt dim, PetscInt Nf, const PetscReal x[], const PetscReal n[], const PetscScalar uL[], const PetscScalar uR[], PetscScalar flux[], void *ctx)
17160c2f2876SMatthew G. Knepley 
17175db36cf9SMatthew G. Knepley + dim  - The spatial dimension
17185db36cf9SMatthew G. Knepley . Nf   - The number of fields
17195db36cf9SMatthew G. Knepley . x    - The coordinates at a point on the interface
17200c2f2876SMatthew G. Knepley . n    - The normal vector to the interface
17210c2f2876SMatthew G. Knepley . uL   - The state vector to the left of the interface
17220c2f2876SMatthew G. Knepley . uR   - The state vector to the right of the interface
17230c2f2876SMatthew G. Knepley . flux - output array of flux through the interface
172497b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
172597b6e6e8SMatthew G. Knepley . constants - constant parameters
17260c2f2876SMatthew G. Knepley - ctx  - optional user context
17270c2f2876SMatthew G. Knepley 
17280c2f2876SMatthew G. Knepley   Level: intermediate
17290c2f2876SMatthew G. Knepley 
17300c2f2876SMatthew G. Knepley .seealso: PetscDSSetRiemannSolver()
17310c2f2876SMatthew G. Knepley @*/
17320c2f2876SMatthew G. Knepley PetscErrorCode PetscDSGetRiemannSolver(PetscDS prob, PetscInt f,
173397b6e6e8SMatthew G. Knepley                                        void (**r)(PetscInt dim, PetscInt Nf, const PetscReal x[], const PetscReal n[], const PetscScalar uL[], const PetscScalar uR[], PetscInt numConstants, const PetscScalar constants[], PetscScalar flux[], void *ctx))
17340c2f2876SMatthew G. Knepley {
17350c2f2876SMatthew G. Knepley   PetscFunctionBegin;
17360c2f2876SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
17370c2f2876SMatthew G. Knepley   if ((f < 0) || (f >= prob->Nf)) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, prob->Nf);
17380c2f2876SMatthew G. Knepley   PetscValidPointer(r, 3);
17390c2f2876SMatthew G. Knepley   *r = prob->r[f];
17400c2f2876SMatthew G. Knepley   PetscFunctionReturn(0);
17410c2f2876SMatthew G. Knepley }
17420c2f2876SMatthew G. Knepley 
17430c2f2876SMatthew G. Knepley /*@C
17440c2f2876SMatthew G. Knepley   PetscDSSetRiemannSolver - Sets the Riemann solver for the given field
17450c2f2876SMatthew G. Knepley 
17460c2f2876SMatthew G. Knepley   Not collective
17470c2f2876SMatthew G. Knepley 
17480c2f2876SMatthew G. Knepley   Input Arguments:
17490c2f2876SMatthew G. Knepley + prob - The PetscDS object
17500c2f2876SMatthew G. Knepley . f    - The field number
17510c2f2876SMatthew G. Knepley - r    - Riemann solver
17520c2f2876SMatthew G. Knepley 
17530c2f2876SMatthew G. Knepley   Calling sequence for r:
17540c2f2876SMatthew G. Knepley 
17555db36cf9SMatthew G. Knepley $ r(PetscInt dim, PetscInt Nf, const PetscReal x[], const PetscReal n[], const PetscScalar uL[], const PetscScalar uR[], PetscScalar flux[], void *ctx)
17560c2f2876SMatthew G. Knepley 
17575db36cf9SMatthew G. Knepley + dim  - The spatial dimension
17585db36cf9SMatthew G. Knepley . Nf   - The number of fields
17595db36cf9SMatthew G. Knepley . x    - The coordinates at a point on the interface
17600c2f2876SMatthew G. Knepley . n    - The normal vector to the interface
17610c2f2876SMatthew G. Knepley . uL   - The state vector to the left of the interface
17620c2f2876SMatthew G. Knepley . uR   - The state vector to the right of the interface
17630c2f2876SMatthew G. Knepley . flux - output array of flux through the interface
176497b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
176597b6e6e8SMatthew G. Knepley . constants - constant parameters
17660c2f2876SMatthew G. Knepley - ctx  - optional user context
17670c2f2876SMatthew G. Knepley 
17680c2f2876SMatthew G. Knepley   Level: intermediate
17690c2f2876SMatthew G. Knepley 
17700c2f2876SMatthew G. Knepley .seealso: PetscDSGetRiemannSolver()
17710c2f2876SMatthew G. Knepley @*/
17720c2f2876SMatthew G. Knepley PetscErrorCode PetscDSSetRiemannSolver(PetscDS prob, PetscInt f,
177397b6e6e8SMatthew G. Knepley                                        void (*r)(PetscInt dim, PetscInt Nf, const PetscReal x[], const PetscReal n[], const PetscScalar uL[], const PetscScalar uR[], PetscInt numConstants, const PetscScalar constants[], PetscScalar flux[], void *ctx))
17740c2f2876SMatthew G. Knepley {
17750c2f2876SMatthew G. Knepley   PetscErrorCode ierr;
17760c2f2876SMatthew G. Knepley 
17770c2f2876SMatthew G. Knepley   PetscFunctionBegin;
17780c2f2876SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1779de716cbcSToby Isaac   if (r) PetscValidFunction(r, 3);
17800c2f2876SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
17810c2f2876SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
17820c2f2876SMatthew G. Knepley   prob->r[f] = r;
17830c2f2876SMatthew G. Knepley   PetscFunctionReturn(0);
17840c2f2876SMatthew G. Knepley }
17850c2f2876SMatthew G. Knepley 
178632d2bbc9SMatthew G. Knepley /*@C
178732d2bbc9SMatthew G. Knepley   PetscDSGetUpdate - Get the pointwise update function for a given field
178832d2bbc9SMatthew G. Knepley 
178932d2bbc9SMatthew G. Knepley   Not collective
179032d2bbc9SMatthew G. Knepley 
179132d2bbc9SMatthew G. Knepley   Input Parameters:
179232d2bbc9SMatthew G. Knepley + prob - The PetscDS
179332d2bbc9SMatthew G. Knepley - f    - The field number
179432d2bbc9SMatthew G. Knepley 
179532d2bbc9SMatthew G. Knepley   Output Parameters:
179632d2bbc9SMatthew G. Knepley + update - update function
179732d2bbc9SMatthew G. Knepley 
179832d2bbc9SMatthew G. Knepley   Note: The calling sequence for the callback update is given by:
179932d2bbc9SMatthew G. Knepley 
180032d2bbc9SMatthew G. Knepley $ update(PetscInt dim, PetscInt Nf, PetscInt NfAux,
180132d2bbc9SMatthew G. Knepley $        const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
180232d2bbc9SMatthew G. Knepley $        const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
180332d2bbc9SMatthew G. Knepley $        PetscReal t, const PetscReal x[], PetscScalar uNew[])
180432d2bbc9SMatthew G. Knepley 
180532d2bbc9SMatthew G. Knepley + dim - the spatial dimension
180632d2bbc9SMatthew G. Knepley . Nf - the number of fields
180732d2bbc9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
180832d2bbc9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
180932d2bbc9SMatthew G. Knepley . u - each field evaluated at the current point
181032d2bbc9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
181132d2bbc9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
181232d2bbc9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
181332d2bbc9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
181432d2bbc9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
181532d2bbc9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
181632d2bbc9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
181732d2bbc9SMatthew G. Knepley . t - current time
181832d2bbc9SMatthew G. Knepley . x - coordinates of the current point
181932d2bbc9SMatthew G. Knepley - uNew - new value for field at the current point
182032d2bbc9SMatthew G. Knepley 
182132d2bbc9SMatthew G. Knepley   Level: intermediate
182232d2bbc9SMatthew G. Knepley 
182332d2bbc9SMatthew G. Knepley .seealso: PetscDSSetUpdate(), PetscDSSetResidual()
182432d2bbc9SMatthew G. Knepley @*/
182532d2bbc9SMatthew G. Knepley PetscErrorCode PetscDSGetUpdate(PetscDS prob, PetscInt f,
182632d2bbc9SMatthew G. Knepley                                   void (**update)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
182732d2bbc9SMatthew G. Knepley                                                   const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
182832d2bbc9SMatthew G. Knepley                                                   const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
18293fa77dffSMatthew G. Knepley                                                   PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar uNew[]))
183032d2bbc9SMatthew G. Knepley {
183132d2bbc9SMatthew G. Knepley   PetscFunctionBegin;
183232d2bbc9SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
183332d2bbc9SMatthew G. Knepley   if ((f < 0) || (f >= prob->Nf)) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, prob->Nf);
183432d2bbc9SMatthew G. Knepley   if (update) {PetscValidPointer(update, 3); *update = prob->update[f];}
183532d2bbc9SMatthew G. Knepley   PetscFunctionReturn(0);
183632d2bbc9SMatthew G. Knepley }
183732d2bbc9SMatthew G. Knepley 
183832d2bbc9SMatthew G. Knepley /*@C
18393fa77dffSMatthew G. Knepley   PetscDSSetUpdate - Set the pointwise update function for a given field
184032d2bbc9SMatthew G. Knepley 
184132d2bbc9SMatthew G. Knepley   Not collective
184232d2bbc9SMatthew G. Knepley 
184332d2bbc9SMatthew G. Knepley   Input Parameters:
184432d2bbc9SMatthew G. Knepley + prob   - The PetscDS
184532d2bbc9SMatthew G. Knepley . f      - The field number
184632d2bbc9SMatthew G. Knepley - update - update function
184732d2bbc9SMatthew G. Knepley 
184832d2bbc9SMatthew G. Knepley   Note: The calling sequence for the callback update is given by:
184932d2bbc9SMatthew G. Knepley 
185032d2bbc9SMatthew G. Knepley $ update(PetscInt dim, PetscInt Nf, PetscInt NfAux,
185132d2bbc9SMatthew G. Knepley $        const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
185232d2bbc9SMatthew G. Knepley $        const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
185332d2bbc9SMatthew G. Knepley $        PetscReal t, const PetscReal x[], PetscScalar uNew[])
185432d2bbc9SMatthew G. Knepley 
185532d2bbc9SMatthew G. Knepley + dim - the spatial dimension
185632d2bbc9SMatthew G. Knepley . Nf - the number of fields
185732d2bbc9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
185832d2bbc9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
185932d2bbc9SMatthew G. Knepley . u - each field evaluated at the current point
186032d2bbc9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
186132d2bbc9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
186232d2bbc9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
186332d2bbc9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
186432d2bbc9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
186532d2bbc9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
186632d2bbc9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
186732d2bbc9SMatthew G. Knepley . t - current time
186832d2bbc9SMatthew G. Knepley . x - coordinates of the current point
186932d2bbc9SMatthew G. Knepley - uNew - new field values at the current point
187032d2bbc9SMatthew G. Knepley 
187132d2bbc9SMatthew G. Knepley   Level: intermediate
187232d2bbc9SMatthew G. Knepley 
187332d2bbc9SMatthew G. Knepley .seealso: PetscDSGetResidual()
187432d2bbc9SMatthew G. Knepley @*/
187532d2bbc9SMatthew G. Knepley PetscErrorCode PetscDSSetUpdate(PetscDS prob, PetscInt f,
187632d2bbc9SMatthew G. Knepley                                 void (*update)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
187732d2bbc9SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
187832d2bbc9SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
18793fa77dffSMatthew G. Knepley                                                PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar uNew[]))
188032d2bbc9SMatthew G. Knepley {
188132d2bbc9SMatthew G. Knepley   PetscErrorCode ierr;
188232d2bbc9SMatthew G. Knepley 
188332d2bbc9SMatthew G. Knepley   PetscFunctionBegin;
188432d2bbc9SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
188532d2bbc9SMatthew G. Knepley   if (update) PetscValidFunction(update, 3);
188632d2bbc9SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
188732d2bbc9SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
188832d2bbc9SMatthew G. Knepley   prob->update[f] = update;
188932d2bbc9SMatthew G. Knepley   PetscFunctionReturn(0);
189032d2bbc9SMatthew G. Knepley }
189132d2bbc9SMatthew G. Knepley 
18920c2f2876SMatthew G. Knepley PetscErrorCode PetscDSGetContext(PetscDS prob, PetscInt f, void **ctx)
18930c2f2876SMatthew G. Knepley {
18940c2f2876SMatthew G. Knepley   PetscFunctionBegin;
18950c2f2876SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
18960c2f2876SMatthew G. Knepley   if ((f < 0) || (f >= prob->Nf)) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, prob->Nf);
18970c2f2876SMatthew G. Knepley   PetscValidPointer(ctx, 3);
18980c2f2876SMatthew G. Knepley   *ctx = prob->ctx[f];
18990c2f2876SMatthew G. Knepley   PetscFunctionReturn(0);
19000c2f2876SMatthew G. Knepley }
19010c2f2876SMatthew G. Knepley 
19020c2f2876SMatthew G. Knepley PetscErrorCode PetscDSSetContext(PetscDS prob, PetscInt f, void *ctx)
19030c2f2876SMatthew G. Knepley {
19040c2f2876SMatthew G. Knepley   PetscErrorCode ierr;
19050c2f2876SMatthew G. Knepley 
19060c2f2876SMatthew G. Knepley   PetscFunctionBegin;
19070c2f2876SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
19080c2f2876SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
19090c2f2876SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
19100c2f2876SMatthew G. Knepley   prob->ctx[f] = ctx;
19110c2f2876SMatthew G. Knepley   PetscFunctionReturn(0);
19120c2f2876SMatthew G. Knepley }
19130c2f2876SMatthew G. Knepley 
1914194d53e6SMatthew G. Knepley /*@C
1915194d53e6SMatthew G. Knepley   PetscDSGetBdResidual - Get the pointwise boundary residual function for a given test field
1916194d53e6SMatthew G. Knepley 
1917194d53e6SMatthew G. Knepley   Not collective
1918194d53e6SMatthew G. Knepley 
1919194d53e6SMatthew G. Knepley   Input Parameters:
1920194d53e6SMatthew G. Knepley + prob - The PetscDS
1921194d53e6SMatthew G. Knepley - f    - The test field number
1922194d53e6SMatthew G. Knepley 
1923194d53e6SMatthew G. Knepley   Output Parameters:
1924194d53e6SMatthew G. Knepley + f0 - boundary integrand for the test function term
1925194d53e6SMatthew G. Knepley - f1 - boundary integrand for the test function gradient term
1926194d53e6SMatthew G. Knepley 
1927194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1928194d53e6SMatthew G. Knepley 
1929194d53e6SMatthew G. Knepley   \int_\Gamma \phi {\vec f}_0(u, u_t, \nabla u, x, t) \cdot \hat n + \nabla\phi \cdot {\overleftrightarrow f}_1(u, u_t, \nabla u, x, t) \cdot \hat n
1930194d53e6SMatthew G. Knepley 
1931194d53e6SMatthew G. Knepley The calling sequence for the callbacks f0 and f1 is given by:
1932194d53e6SMatthew G. Knepley 
193330b9ff8bSMatthew G. Knepley $ f0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1934194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1935194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
193630b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar f0[])
1937194d53e6SMatthew G. Knepley 
1938194d53e6SMatthew G. Knepley + dim - the spatial dimension
1939194d53e6SMatthew G. Knepley . Nf - the number of fields
1940194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1941194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1942194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
1943194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1944194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1945194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1946194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1947194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1948194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1949194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1950194d53e6SMatthew G. Knepley . t - current time
1951194d53e6SMatthew G. Knepley . x - coordinates of the current point
1952194d53e6SMatthew G. Knepley . n - unit normal at the current point
195397b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
195497b6e6e8SMatthew G. Knepley . constants - constant parameters
1955194d53e6SMatthew G. Knepley - f0 - output values at the current point
1956194d53e6SMatthew G. Knepley 
1957194d53e6SMatthew G. Knepley   Level: intermediate
1958194d53e6SMatthew G. Knepley 
1959194d53e6SMatthew G. Knepley .seealso: PetscDSSetBdResidual()
1960194d53e6SMatthew G. Knepley @*/
19612764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetBdResidual(PetscDS prob, PetscInt f,
196230b9ff8bSMatthew G. Knepley                                     void (**f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1963194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1964194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
196597b6e6e8SMatthew G. Knepley                                                 PetscReal t, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f0[]),
196630b9ff8bSMatthew G. Knepley                                     void (**f1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1967194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1968194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
196997b6e6e8SMatthew G. Knepley                                                 PetscReal t, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f1[]))
19702764a2aaSMatthew G. Knepley {
19712764a2aaSMatthew G. Knepley   PetscFunctionBegin;
19722764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
19732764a2aaSMatthew G. Knepley   if ((f < 0) || (f >= prob->Nf)) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, prob->Nf);
19742764a2aaSMatthew G. Knepley   if (f0) {PetscValidPointer(f0, 3); *f0 = prob->fBd[f*2+0];}
19752764a2aaSMatthew G. Knepley   if (f1) {PetscValidPointer(f1, 4); *f1 = prob->fBd[f*2+1];}
19762764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
19772764a2aaSMatthew G. Knepley }
19782764a2aaSMatthew G. Knepley 
1979194d53e6SMatthew G. Knepley /*@C
1980194d53e6SMatthew G. Knepley   PetscDSSetBdResidual - Get the pointwise boundary residual function for a given test field
1981194d53e6SMatthew G. Knepley 
1982194d53e6SMatthew G. Knepley   Not collective
1983194d53e6SMatthew G. Knepley 
1984194d53e6SMatthew G. Knepley   Input Parameters:
1985194d53e6SMatthew G. Knepley + prob - The PetscDS
1986194d53e6SMatthew G. Knepley . f    - The test field number
1987194d53e6SMatthew G. Knepley . f0 - boundary integrand for the test function term
1988194d53e6SMatthew G. Knepley - f1 - boundary integrand for the test function gradient term
1989194d53e6SMatthew G. Knepley 
1990194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1991194d53e6SMatthew G. Knepley 
1992194d53e6SMatthew G. Knepley   \int_\Gamma \phi {\vec f}_0(u, u_t, \nabla u, x, t) \cdot \hat n + \nabla\phi \cdot {\overleftrightarrow f}_1(u, u_t, \nabla u, x, t) \cdot \hat n
1993194d53e6SMatthew G. Knepley 
1994194d53e6SMatthew G. Knepley The calling sequence for the callbacks f0 and f1 is given by:
1995194d53e6SMatthew G. Knepley 
199630b9ff8bSMatthew G. Knepley $ f0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1997194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1998194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
199930b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar f0[])
2000194d53e6SMatthew G. Knepley 
2001194d53e6SMatthew G. Knepley + dim - the spatial dimension
2002194d53e6SMatthew G. Knepley . Nf - the number of fields
2003194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
2004194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
2005194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
2006194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
2007194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
2008194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
2009194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
2010194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
2011194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
2012194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
2013194d53e6SMatthew G. Knepley . t - current time
2014194d53e6SMatthew G. Knepley . x - coordinates of the current point
2015194d53e6SMatthew G. Knepley . n - unit normal at the current point
201697b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
201797b6e6e8SMatthew G. Knepley . constants - constant parameters
2018194d53e6SMatthew G. Knepley - f0 - output values at the current point
2019194d53e6SMatthew G. Knepley 
2020194d53e6SMatthew G. Knepley   Level: intermediate
2021194d53e6SMatthew G. Knepley 
2022194d53e6SMatthew G. Knepley .seealso: PetscDSGetBdResidual()
2023194d53e6SMatthew G. Knepley @*/
20242764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetBdResidual(PetscDS prob, PetscInt f,
202530b9ff8bSMatthew G. Knepley                                     void (*f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2026194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2027194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
202897b6e6e8SMatthew G. Knepley                                                PetscReal t, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f0[]),
202930b9ff8bSMatthew G. Knepley                                     void (*f1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2030194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2031194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
203297b6e6e8SMatthew G. Knepley                                                PetscReal t, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f1[]))
20332764a2aaSMatthew G. Knepley {
20342764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
20352764a2aaSMatthew G. Knepley 
20362764a2aaSMatthew G. Knepley   PetscFunctionBegin;
20372764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
20382764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
20392764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
20402764a2aaSMatthew G. Knepley   if (f0) {PetscValidFunction(f0, 3); prob->fBd[f*2+0] = f0;}
20412764a2aaSMatthew G. Knepley   if (f1) {PetscValidFunction(f1, 4); prob->fBd[f*2+1] = f1;}
20422764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
20432764a2aaSMatthew G. Knepley }
20442764a2aaSMatthew G. Knepley 
2045194d53e6SMatthew G. Knepley /*@C
2046194d53e6SMatthew G. Knepley   PetscDSGetBdJacobian - Get the pointwise boundary Jacobian function for given test and basis field
2047194d53e6SMatthew G. Knepley 
2048194d53e6SMatthew G. Knepley   Not collective
2049194d53e6SMatthew G. Knepley 
2050194d53e6SMatthew G. Knepley   Input Parameters:
2051194d53e6SMatthew G. Knepley + prob - The PetscDS
2052194d53e6SMatthew G. Knepley . f    - The test field number
2053194d53e6SMatthew G. Knepley - g    - The field number
2054194d53e6SMatthew G. Knepley 
2055194d53e6SMatthew G. Knepley   Output Parameters:
2056194d53e6SMatthew G. Knepley + g0 - integrand for the test and basis function term
2057194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
2058194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
2059194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
2060194d53e6SMatthew G. Knepley 
2061194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
2062194d53e6SMatthew G. Knepley 
2063194d53e6SMatthew G. Knepley   \int_\Gamma \phi {\vec g}_0(u, u_t, \nabla u, x, t) \cdot \hat n \psi + \phi {\vec g}_1(u, u_t, \nabla u, x, t) \cdot \hat n \nabla \psi + \nabla\phi \cdot {\vec g}_2(u, u_t, \nabla u, x, t) \cdot \hat n \psi + \nabla\phi \cdot {\overleftrightarrow g}_3(u, u_t, \nabla u, x, t) \cdot \hat n \cdot \nabla \psi
2064194d53e6SMatthew G. Knepley 
2065194d53e6SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
2066194d53e6SMatthew G. Knepley 
206730b9ff8bSMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2068194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2069194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
207030b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar g0[])
2071194d53e6SMatthew G. Knepley 
2072194d53e6SMatthew G. Knepley + dim - the spatial dimension
2073194d53e6SMatthew G. Knepley . Nf - the number of fields
2074194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
2075194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
2076194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
2077194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
2078194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
2079194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
2080194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
2081194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
2082194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
2083194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
2084194d53e6SMatthew G. Knepley . t - current time
20852aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
2086194d53e6SMatthew G. Knepley . x - coordinates of the current point
2087194d53e6SMatthew G. Knepley . n - normal at the current point
208897b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
208997b6e6e8SMatthew G. Knepley . constants - constant parameters
2090194d53e6SMatthew G. Knepley - g0 - output values at the current point
2091194d53e6SMatthew G. Knepley 
2092194d53e6SMatthew G. Knepley   Level: intermediate
2093194d53e6SMatthew G. Knepley 
2094194d53e6SMatthew G. Knepley .seealso: PetscDSSetBdJacobian()
2095194d53e6SMatthew G. Knepley @*/
20962764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetBdJacobian(PetscDS prob, PetscInt f, PetscInt g,
209730b9ff8bSMatthew G. Knepley                                     void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2098194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2099194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
210097b6e6e8SMatthew G. Knepley                                                 PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
210130b9ff8bSMatthew G. Knepley                                     void (**g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2102194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2103194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
210497b6e6e8SMatthew G. Knepley                                                 PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
210530b9ff8bSMatthew G. Knepley                                     void (**g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2106194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2107194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
210897b6e6e8SMatthew G. Knepley                                                 PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
210930b9ff8bSMatthew G. Knepley                                     void (**g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2110194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2111194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
211297b6e6e8SMatthew G. Knepley                                                 PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
21132764a2aaSMatthew G. Knepley {
21142764a2aaSMatthew G. Knepley   PetscFunctionBegin;
21152764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
21162764a2aaSMatthew G. Knepley   if ((f < 0) || (f >= prob->Nf)) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, prob->Nf);
21172764a2aaSMatthew G. Knepley   if ((g < 0) || (g >= prob->Nf)) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", g, prob->Nf);
21182764a2aaSMatthew G. Knepley   if (g0) {PetscValidPointer(g0, 4); *g0 = prob->gBd[(f*prob->Nf + g)*4+0];}
21192764a2aaSMatthew G. Knepley   if (g1) {PetscValidPointer(g1, 5); *g1 = prob->gBd[(f*prob->Nf + g)*4+1];}
21202764a2aaSMatthew G. Knepley   if (g2) {PetscValidPointer(g2, 6); *g2 = prob->gBd[(f*prob->Nf + g)*4+2];}
21212764a2aaSMatthew G. Knepley   if (g3) {PetscValidPointer(g3, 7); *g3 = prob->gBd[(f*prob->Nf + g)*4+3];}
21222764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
21232764a2aaSMatthew G. Knepley }
21242764a2aaSMatthew G. Knepley 
2125194d53e6SMatthew G. Knepley /*@C
2126194d53e6SMatthew G. Knepley   PetscDSSetBdJacobian - Set the pointwise boundary Jacobian function for given test and basis field
2127194d53e6SMatthew G. Knepley 
2128194d53e6SMatthew G. Knepley   Not collective
2129194d53e6SMatthew G. Knepley 
2130194d53e6SMatthew G. Knepley   Input Parameters:
2131194d53e6SMatthew G. Knepley + prob - The PetscDS
2132194d53e6SMatthew G. Knepley . f    - The test field number
2133194d53e6SMatthew G. Knepley . g    - The field number
2134194d53e6SMatthew G. Knepley . g0 - integrand for the test and basis function term
2135194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
2136194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
2137194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
2138194d53e6SMatthew G. Knepley 
2139194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
2140194d53e6SMatthew G. Knepley 
2141194d53e6SMatthew G. Knepley   \int_\Gamma \phi {\vec g}_0(u, u_t, \nabla u, x, t) \cdot \hat n \psi + \phi {\vec g}_1(u, u_t, \nabla u, x, t) \cdot \hat n \nabla \psi + \nabla\phi \cdot {\vec g}_2(u, u_t, \nabla u, x, t) \cdot \hat n \psi + \nabla\phi \cdot {\overleftrightarrow g}_3(u, u_t, \nabla u, x, t) \cdot \hat n \cdot \nabla \psi
2142194d53e6SMatthew G. Knepley 
2143194d53e6SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
2144194d53e6SMatthew G. Knepley 
214530b9ff8bSMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2146194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2147194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
214830b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar g0[])
2149194d53e6SMatthew G. Knepley 
2150194d53e6SMatthew G. Knepley + dim - the spatial dimension
2151194d53e6SMatthew G. Knepley . Nf - the number of fields
2152194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
2153194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
2154194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
2155194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
2156194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
2157194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
2158194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
2159194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
2160194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
2161194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
2162194d53e6SMatthew G. Knepley . t - current time
21632aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
2164194d53e6SMatthew G. Knepley . x - coordinates of the current point
2165194d53e6SMatthew G. Knepley . n - normal at the current point
216697b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
216797b6e6e8SMatthew G. Knepley . constants - constant parameters
2168194d53e6SMatthew G. Knepley - g0 - output values at the current point
2169194d53e6SMatthew G. Knepley 
2170194d53e6SMatthew G. Knepley   Level: intermediate
2171194d53e6SMatthew G. Knepley 
2172194d53e6SMatthew G. Knepley .seealso: PetscDSGetBdJacobian()
2173194d53e6SMatthew G. Knepley @*/
21742764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetBdJacobian(PetscDS prob, PetscInt f, PetscInt g,
217530b9ff8bSMatthew G. Knepley                                     void (*g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2176194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2177194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
217897b6e6e8SMatthew G. Knepley                                                PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
217930b9ff8bSMatthew G. Knepley                                     void (*g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2180194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2181194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
218297b6e6e8SMatthew G. Knepley                                                PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
218330b9ff8bSMatthew G. Knepley                                     void (*g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2184194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2185194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
218697b6e6e8SMatthew G. Knepley                                                PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
218730b9ff8bSMatthew G. Knepley                                     void (*g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2188194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2189194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
219097b6e6e8SMatthew G. Knepley                                                PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
21912764a2aaSMatthew G. Knepley {
21922764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
21932764a2aaSMatthew G. Knepley 
21942764a2aaSMatthew G. Knepley   PetscFunctionBegin;
21952764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
21962764a2aaSMatthew G. Knepley   if (g0) PetscValidFunction(g0, 4);
21972764a2aaSMatthew G. Knepley   if (g1) PetscValidFunction(g1, 5);
21982764a2aaSMatthew G. Knepley   if (g2) PetscValidFunction(g2, 6);
21992764a2aaSMatthew G. Knepley   if (g3) PetscValidFunction(g3, 7);
22002764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
22012764a2aaSMatthew G. Knepley   if (g < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", g);
22022764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, PetscMax(f, g)+1);CHKERRQ(ierr);
22032764a2aaSMatthew G. Knepley   prob->gBd[(f*prob->Nf + g)*4+0] = g0;
22042764a2aaSMatthew G. Knepley   prob->gBd[(f*prob->Nf + g)*4+1] = g1;
22052764a2aaSMatthew G. Knepley   prob->gBd[(f*prob->Nf + g)*4+2] = g2;
22062764a2aaSMatthew G. Knepley   prob->gBd[(f*prob->Nf + g)*4+3] = g3;
22072764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
22082764a2aaSMatthew G. Knepley }
22092764a2aaSMatthew G. Knepley 
22100d3e9b51SMatthew G. Knepley /*@C
2211c371a6d1SMatthew G. Knepley   PetscDSGetExactSolution - Get the pointwise exact solution function for a given test field
2212c371a6d1SMatthew G. Knepley 
2213c371a6d1SMatthew G. Knepley   Not collective
2214c371a6d1SMatthew G. Knepley 
2215c371a6d1SMatthew G. Knepley   Input Parameters:
2216c371a6d1SMatthew G. Knepley + prob - The PetscDS
2217c371a6d1SMatthew G. Knepley - f    - The test field number
2218c371a6d1SMatthew G. Knepley 
2219c371a6d1SMatthew G. Knepley   Output Parameter:
222095cbbfd3SMatthew G. Knepley + exactSol - exact solution for the test field
222195cbbfd3SMatthew G. Knepley - exactCtx - exact solution context
2222c371a6d1SMatthew G. Knepley 
2223c371a6d1SMatthew G. Knepley   Note: The calling sequence for the solution functions is given by:
2224c371a6d1SMatthew G. Knepley 
2225c371a6d1SMatthew G. Knepley $ sol(PetscInt dim, PetscReal t, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx)
2226c371a6d1SMatthew G. Knepley 
2227c371a6d1SMatthew G. Knepley + dim - the spatial dimension
2228c371a6d1SMatthew G. Knepley . t - current time
2229c371a6d1SMatthew G. Knepley . x - coordinates of the current point
2230c371a6d1SMatthew G. Knepley . Nc - the number of field components
2231c371a6d1SMatthew G. Knepley . u - the solution field evaluated at the current point
2232c371a6d1SMatthew G. Knepley - ctx - a user context
2233c371a6d1SMatthew G. Knepley 
2234c371a6d1SMatthew G. Knepley   Level: intermediate
2235c371a6d1SMatthew G. Knepley 
2236c371a6d1SMatthew G. Knepley .seealso: PetscDSSetExactSolution()
2237c371a6d1SMatthew G. Knepley @*/
223895cbbfd3SMatthew G. Knepley PetscErrorCode PetscDSGetExactSolution(PetscDS prob, PetscInt f, PetscErrorCode (**sol)(PetscInt dim, PetscReal t, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx), void **ctx)
2239c371a6d1SMatthew G. Knepley {
2240c371a6d1SMatthew G. Knepley   PetscFunctionBegin;
2241c371a6d1SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2242c371a6d1SMatthew G. Knepley   if ((f < 0) || (f >= prob->Nf)) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, prob->Nf);
2243c371a6d1SMatthew G. Knepley   if (sol) {PetscValidPointer(sol, 3); *sol = prob->exactSol[f];}
224495cbbfd3SMatthew G. Knepley   if (ctx) {PetscValidPointer(ctx, 4); *ctx = prob->exactCtx[f];}
2245c371a6d1SMatthew G. Knepley   PetscFunctionReturn(0);
2246c371a6d1SMatthew G. Knepley }
2247c371a6d1SMatthew G. Knepley 
2248c371a6d1SMatthew G. Knepley /*@C
2249578a5ef5SMatthew Knepley   PetscDSSetExactSolution - Set the pointwise exact solution function for a given test field
2250c371a6d1SMatthew G. Knepley 
2251c371a6d1SMatthew G. Knepley   Not collective
2252c371a6d1SMatthew G. Knepley 
2253c371a6d1SMatthew G. Knepley   Input Parameters:
2254c371a6d1SMatthew G. Knepley + prob - The PetscDS
2255c371a6d1SMatthew G. Knepley . f    - The test field number
225695cbbfd3SMatthew G. Knepley . sol  - solution function for the test fields
225795cbbfd3SMatthew G. Knepley - ctx  - solution context or NULL
2258c371a6d1SMatthew G. Knepley 
2259c371a6d1SMatthew G. Knepley   Note: The calling sequence for solution functions is given by:
2260c371a6d1SMatthew G. Knepley 
2261c371a6d1SMatthew G. Knepley $ sol(PetscInt dim, PetscReal t, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx)
2262c371a6d1SMatthew G. Knepley 
2263c371a6d1SMatthew G. Knepley + dim - the spatial dimension
2264c371a6d1SMatthew G. Knepley . t - current time
2265c371a6d1SMatthew G. Knepley . x - coordinates of the current point
2266c371a6d1SMatthew G. Knepley . Nc - the number of field components
2267c371a6d1SMatthew G. Knepley . u - the solution field evaluated at the current point
2268c371a6d1SMatthew G. Knepley - ctx - a user context
2269c371a6d1SMatthew G. Knepley 
2270c371a6d1SMatthew G. Knepley   Level: intermediate
2271c371a6d1SMatthew G. Knepley 
2272c371a6d1SMatthew G. Knepley .seealso: PetscDSGetExactSolution()
2273c371a6d1SMatthew G. Knepley @*/
227495cbbfd3SMatthew G. Knepley PetscErrorCode PetscDSSetExactSolution(PetscDS prob, PetscInt f, PetscErrorCode (*sol)(PetscInt dim, PetscReal t, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx), void *ctx)
2275c371a6d1SMatthew G. Knepley {
2276c371a6d1SMatthew G. Knepley   PetscErrorCode ierr;
2277c371a6d1SMatthew G. Knepley 
2278c371a6d1SMatthew G. Knepley   PetscFunctionBegin;
2279c371a6d1SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2280c371a6d1SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
2281c371a6d1SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
2282c371a6d1SMatthew G. Knepley   if (sol) {PetscValidFunction(sol, 3); prob->exactSol[f] = sol;}
228395cbbfd3SMatthew G. Knepley   if (ctx) {PetscValidFunction(ctx, 4); prob->exactCtx[f] = ctx;}
2284c371a6d1SMatthew G. Knepley   PetscFunctionReturn(0);
2285c371a6d1SMatthew G. Knepley }
2286c371a6d1SMatthew G. Knepley 
22875638fd0eSMatthew G. Knepley /*@C
228897b6e6e8SMatthew G. Knepley   PetscDSGetConstants - Returns the array of constants passed to point functions
228997b6e6e8SMatthew G. Knepley 
229097b6e6e8SMatthew G. Knepley   Not collective
229197b6e6e8SMatthew G. Knepley 
229297b6e6e8SMatthew G. Knepley   Input Parameter:
229397b6e6e8SMatthew G. Knepley . prob - The PetscDS object
229497b6e6e8SMatthew G. Knepley 
229597b6e6e8SMatthew G. Knepley   Output Parameters:
229697b6e6e8SMatthew G. Knepley + numConstants - The number of constants
229797b6e6e8SMatthew G. Knepley - constants    - The array of constants, NULL if there are none
229897b6e6e8SMatthew G. Knepley 
229997b6e6e8SMatthew G. Knepley   Level: intermediate
230097b6e6e8SMatthew G. Knepley 
230197b6e6e8SMatthew G. Knepley .seealso: PetscDSSetConstants(), PetscDSCreate()
230297b6e6e8SMatthew G. Knepley @*/
230397b6e6e8SMatthew G. Knepley PetscErrorCode PetscDSGetConstants(PetscDS prob, PetscInt *numConstants, const PetscScalar *constants[])
230497b6e6e8SMatthew G. Knepley {
230597b6e6e8SMatthew G. Knepley   PetscFunctionBegin;
230697b6e6e8SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
230797b6e6e8SMatthew G. Knepley   if (numConstants) {PetscValidPointer(numConstants, 2); *numConstants = prob->numConstants;}
230897b6e6e8SMatthew G. Knepley   if (constants)    {PetscValidPointer(constants, 3);    *constants    = prob->constants;}
230997b6e6e8SMatthew G. Knepley   PetscFunctionReturn(0);
231097b6e6e8SMatthew G. Knepley }
231197b6e6e8SMatthew G. Knepley 
23120d3e9b51SMatthew G. Knepley /*@C
231397b6e6e8SMatthew G. Knepley   PetscDSSetConstants - Set the array of constants passed to point functions
231497b6e6e8SMatthew G. Knepley 
231597b6e6e8SMatthew G. Knepley   Not collective
231697b6e6e8SMatthew G. Knepley 
231797b6e6e8SMatthew G. Knepley   Input Parameters:
231897b6e6e8SMatthew G. Knepley + prob         - The PetscDS object
231997b6e6e8SMatthew G. Knepley . numConstants - The number of constants
232097b6e6e8SMatthew G. Knepley - constants    - The array of constants, NULL if there are none
232197b6e6e8SMatthew G. Knepley 
232297b6e6e8SMatthew G. Knepley   Level: intermediate
232397b6e6e8SMatthew G. Knepley 
232497b6e6e8SMatthew G. Knepley .seealso: PetscDSGetConstants(), PetscDSCreate()
232597b6e6e8SMatthew G. Knepley @*/
232697b6e6e8SMatthew G. Knepley PetscErrorCode PetscDSSetConstants(PetscDS prob, PetscInt numConstants, PetscScalar constants[])
232797b6e6e8SMatthew G. Knepley {
232897b6e6e8SMatthew G. Knepley   PetscErrorCode ierr;
232997b6e6e8SMatthew G. Knepley 
233097b6e6e8SMatthew G. Knepley   PetscFunctionBegin;
233197b6e6e8SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
233297b6e6e8SMatthew G. Knepley   if (numConstants != prob->numConstants) {
233397b6e6e8SMatthew G. Knepley     ierr = PetscFree(prob->constants);CHKERRQ(ierr);
233497b6e6e8SMatthew G. Knepley     prob->numConstants = numConstants;
233597b6e6e8SMatthew G. Knepley     if (prob->numConstants) {
233697b6e6e8SMatthew G. Knepley       ierr = PetscMalloc1(prob->numConstants, &prob->constants);CHKERRQ(ierr);
233720be0f5bSMatthew G. Knepley     } else {
233820be0f5bSMatthew G. Knepley       prob->constants = NULL;
233920be0f5bSMatthew G. Knepley     }
234020be0f5bSMatthew G. Knepley   }
234120be0f5bSMatthew G. Knepley   if (prob->numConstants) {
234220be0f5bSMatthew G. Knepley     PetscValidPointer(constants, 3);
234397b6e6e8SMatthew G. Knepley     ierr = PetscMemcpy(prob->constants, constants, prob->numConstants * sizeof(PetscScalar));CHKERRQ(ierr);
234497b6e6e8SMatthew G. Knepley   }
234597b6e6e8SMatthew G. Knepley   PetscFunctionReturn(0);
234697b6e6e8SMatthew G. Knepley }
234797b6e6e8SMatthew G. Knepley 
23484cd1e086SMatthew G. Knepley /*@
23494cd1e086SMatthew G. Knepley   PetscDSGetFieldIndex - Returns the index of the given field
23504cd1e086SMatthew G. Knepley 
23514cd1e086SMatthew G. Knepley   Not collective
23524cd1e086SMatthew G. Knepley 
23534cd1e086SMatthew G. Knepley   Input Parameters:
23544cd1e086SMatthew G. Knepley + prob - The PetscDS object
23554cd1e086SMatthew G. Knepley - disc - The discretization object
23564cd1e086SMatthew G. Knepley 
23574cd1e086SMatthew G. Knepley   Output Parameter:
23584cd1e086SMatthew G. Knepley . f - The field number
23594cd1e086SMatthew G. Knepley 
23604cd1e086SMatthew G. Knepley   Level: beginner
23614cd1e086SMatthew G. Knepley 
2362f744cafaSSander Arens .seealso: PetscGetDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
23634cd1e086SMatthew G. Knepley @*/
23644cd1e086SMatthew G. Knepley PetscErrorCode PetscDSGetFieldIndex(PetscDS prob, PetscObject disc, PetscInt *f)
23654cd1e086SMatthew G. Knepley {
23664cd1e086SMatthew G. Knepley   PetscInt g;
23674cd1e086SMatthew G. Knepley 
23684cd1e086SMatthew G. Knepley   PetscFunctionBegin;
23694cd1e086SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
23704cd1e086SMatthew G. Knepley   PetscValidPointer(f, 3);
23714cd1e086SMatthew G. Knepley   *f = -1;
23724cd1e086SMatthew G. Knepley   for (g = 0; g < prob->Nf; ++g) {if (disc == prob->disc[g]) break;}
23734cd1e086SMatthew G. Knepley   if (g == prob->Nf) SETERRQ(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Field not found in PetscDS.");
23744cd1e086SMatthew G. Knepley   *f = g;
23754cd1e086SMatthew G. Knepley   PetscFunctionReturn(0);
23764cd1e086SMatthew G. Knepley }
23774cd1e086SMatthew G. Knepley 
23784cd1e086SMatthew G. Knepley /*@
23794cd1e086SMatthew G. Knepley   PetscDSGetFieldSize - Returns the size of the given field in the full space basis
23804cd1e086SMatthew G. Knepley 
23814cd1e086SMatthew G. Knepley   Not collective
23824cd1e086SMatthew G. Knepley 
23834cd1e086SMatthew G. Knepley   Input Parameters:
23844cd1e086SMatthew G. Knepley + prob - The PetscDS object
23854cd1e086SMatthew G. Knepley - f - The field number
23864cd1e086SMatthew G. Knepley 
23874cd1e086SMatthew G. Knepley   Output Parameter:
23884cd1e086SMatthew G. Knepley . size - The size
23894cd1e086SMatthew G. Knepley 
23904cd1e086SMatthew G. Knepley   Level: beginner
23914cd1e086SMatthew G. Knepley 
2392f744cafaSSander Arens .seealso: PetscDSGetFieldOffset(), PetscDSGetNumFields(), PetscDSCreate()
23934cd1e086SMatthew G. Knepley @*/
23944cd1e086SMatthew G. Knepley PetscErrorCode PetscDSGetFieldSize(PetscDS prob, PetscInt f, PetscInt *size)
23954cd1e086SMatthew G. Knepley {
23962166fd64SMatthew G. Knepley   PetscErrorCode ierr;
23972166fd64SMatthew G. Knepley 
23984cd1e086SMatthew G. Knepley   PetscFunctionBegin;
23994cd1e086SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
24004cd1e086SMatthew G. Knepley   PetscValidPointer(size, 3);
24014cd1e086SMatthew G. Knepley   if ((f < 0) || (f >= prob->Nf)) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, prob->Nf);
24022166fd64SMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
2403d4742ddaSMatthew G. Knepley   *size = prob->Nb[f];
24044cd1e086SMatthew G. Knepley   PetscFunctionReturn(0);
24054cd1e086SMatthew G. Knepley }
24064cd1e086SMatthew G. Knepley 
2407bc4ae4beSMatthew G. Knepley /*@
2408bc4ae4beSMatthew G. Knepley   PetscDSGetFieldOffset - Returns the offset of the given field in the full space basis
2409bc4ae4beSMatthew G. Knepley 
2410bc4ae4beSMatthew G. Knepley   Not collective
2411bc4ae4beSMatthew G. Knepley 
2412bc4ae4beSMatthew G. Knepley   Input Parameters:
2413bc4ae4beSMatthew G. Knepley + prob - The PetscDS object
2414bc4ae4beSMatthew G. Knepley - f - The field number
2415bc4ae4beSMatthew G. Knepley 
2416bc4ae4beSMatthew G. Knepley   Output Parameter:
2417bc4ae4beSMatthew G. Knepley . off - The offset
2418bc4ae4beSMatthew G. Knepley 
2419bc4ae4beSMatthew G. Knepley   Level: beginner
2420bc4ae4beSMatthew G. Knepley 
2421f744cafaSSander Arens .seealso: PetscDSGetFieldSize(), PetscDSGetNumFields(), PetscDSCreate()
2422bc4ae4beSMatthew G. Knepley @*/
24232764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetFieldOffset(PetscDS prob, PetscInt f, PetscInt *off)
24242764a2aaSMatthew G. Knepley {
24254cd1e086SMatthew G. Knepley   PetscInt       size, g;
24262764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
24272764a2aaSMatthew G. Knepley 
24282764a2aaSMatthew G. Knepley   PetscFunctionBegin;
24292764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
24302764a2aaSMatthew G. Knepley   PetscValidPointer(off, 3);
24312764a2aaSMatthew G. Knepley   if ((f < 0) || (f >= prob->Nf)) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, prob->Nf);
24322764a2aaSMatthew G. Knepley   *off = 0;
24332764a2aaSMatthew G. Knepley   for (g = 0; g < f; ++g) {
24344cd1e086SMatthew G. Knepley     ierr = PetscDSGetFieldSize(prob, g, &size);CHKERRQ(ierr);
24354cd1e086SMatthew G. Knepley     *off += size;
24362764a2aaSMatthew G. Knepley   }
24372764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
24382764a2aaSMatthew G. Knepley }
24392764a2aaSMatthew G. Knepley 
2440bc4ae4beSMatthew G. Knepley /*@
244147e57110SSander Arens   PetscDSGetDimensions - Returns the size of the approximation space for each field on an evaluation point
2442bc4ae4beSMatthew G. Knepley 
2443bc4ae4beSMatthew G. Knepley   Not collective
2444bc4ae4beSMatthew G. Knepley 
244547e57110SSander Arens   Input Parameter:
244647e57110SSander Arens . prob - The PetscDS object
2447bc4ae4beSMatthew G. Knepley 
2448bc4ae4beSMatthew G. Knepley   Output Parameter:
244947e57110SSander Arens . dimensions - The number of dimensions
2450bc4ae4beSMatthew G. Knepley 
2451bc4ae4beSMatthew G. Knepley   Level: beginner
2452bc4ae4beSMatthew G. Knepley 
245347e57110SSander Arens .seealso: PetscDSGetComponentOffsets(), PetscDSGetNumFields(), PetscDSCreate()
2454bc4ae4beSMatthew G. Knepley @*/
245547e57110SSander Arens PetscErrorCode PetscDSGetDimensions(PetscDS prob, PetscInt *dimensions[])
24562764a2aaSMatthew G. Knepley {
24572764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
24582764a2aaSMatthew G. Knepley 
24592764a2aaSMatthew G. Knepley   PetscFunctionBegin;
24602764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
246147e57110SSander Arens   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
246247e57110SSander Arens   PetscValidPointer(dimensions, 2);
246347e57110SSander Arens   *dimensions = prob->Nb;
246447e57110SSander Arens   PetscFunctionReturn(0);
24656ce16762SMatthew G. Knepley }
246647e57110SSander Arens 
246747e57110SSander Arens /*@
246847e57110SSander Arens   PetscDSGetComponents - Returns the number of components for each field on an evaluation point
246947e57110SSander Arens 
247047e57110SSander Arens   Not collective
247147e57110SSander Arens 
247247e57110SSander Arens   Input Parameter:
247347e57110SSander Arens . prob - The PetscDS object
247447e57110SSander Arens 
247547e57110SSander Arens   Output Parameter:
247647e57110SSander Arens . components - The number of components
247747e57110SSander Arens 
247847e57110SSander Arens   Level: beginner
247947e57110SSander Arens 
248047e57110SSander Arens .seealso: PetscDSGetComponentOffsets(), PetscDSGetNumFields(), PetscDSCreate()
248147e57110SSander Arens @*/
248247e57110SSander Arens PetscErrorCode PetscDSGetComponents(PetscDS prob, PetscInt *components[])
248347e57110SSander Arens {
248447e57110SSander Arens   PetscErrorCode ierr;
248547e57110SSander Arens 
248647e57110SSander Arens   PetscFunctionBegin;
248747e57110SSander Arens   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
248847e57110SSander Arens   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
248947e57110SSander Arens   PetscValidPointer(components, 2);
249047e57110SSander Arens   *components = prob->Nc;
24916ce16762SMatthew G. Knepley   PetscFunctionReturn(0);
24926ce16762SMatthew G. Knepley }
24936ce16762SMatthew G. Knepley 
24946ce16762SMatthew G. Knepley /*@
24956ce16762SMatthew G. Knepley   PetscDSGetComponentOffset - Returns the offset of the given field on an evaluation point
24966ce16762SMatthew G. Knepley 
24976ce16762SMatthew G. Knepley   Not collective
24986ce16762SMatthew G. Knepley 
24996ce16762SMatthew G. Knepley   Input Parameters:
25006ce16762SMatthew G. Knepley + prob - The PetscDS object
25016ce16762SMatthew G. Knepley - f - The field number
25026ce16762SMatthew G. Knepley 
25036ce16762SMatthew G. Knepley   Output Parameter:
25046ce16762SMatthew G. Knepley . off - The offset
25056ce16762SMatthew G. Knepley 
25066ce16762SMatthew G. Knepley   Level: beginner
25076ce16762SMatthew G. Knepley 
2508f744cafaSSander Arens .seealso: PetscDSGetNumFields(), PetscDSCreate()
25096ce16762SMatthew G. Knepley @*/
25106ce16762SMatthew G. Knepley PetscErrorCode PetscDSGetComponentOffset(PetscDS prob, PetscInt f, PetscInt *off)
25116ce16762SMatthew G. Knepley {
25126ce16762SMatthew G. Knepley   PetscFunctionBegin;
25136ce16762SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
25146ce16762SMatthew G. Knepley   PetscValidPointer(off, 3);
25156ce16762SMatthew G. Knepley   if ((f < 0) || (f >= prob->Nf)) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, prob->Nf);
251647e57110SSander Arens   *off = prob->off[f];
25172764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
25182764a2aaSMatthew G. Knepley }
25192764a2aaSMatthew G. Knepley 
2520194d53e6SMatthew G. Knepley /*@
2521194d53e6SMatthew G. Knepley   PetscDSGetComponentOffsets - Returns the offset of each field on an evaluation point
2522194d53e6SMatthew G. Knepley 
2523194d53e6SMatthew G. Knepley   Not collective
2524194d53e6SMatthew G. Knepley 
2525194d53e6SMatthew G. Knepley   Input Parameter:
2526194d53e6SMatthew G. Knepley . prob - The PetscDS object
2527194d53e6SMatthew G. Knepley 
2528194d53e6SMatthew G. Knepley   Output Parameter:
2529194d53e6SMatthew G. Knepley . offsets - The offsets
2530194d53e6SMatthew G. Knepley 
2531194d53e6SMatthew G. Knepley   Level: beginner
2532194d53e6SMatthew G. Knepley 
2533f744cafaSSander Arens .seealso: PetscDSGetNumFields(), PetscDSCreate()
2534194d53e6SMatthew G. Knepley @*/
2535194d53e6SMatthew G. Knepley PetscErrorCode PetscDSGetComponentOffsets(PetscDS prob, PetscInt *offsets[])
2536194d53e6SMatthew G. Knepley {
2537194d53e6SMatthew G. Knepley   PetscFunctionBegin;
2538194d53e6SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2539194d53e6SMatthew G. Knepley   PetscValidPointer(offsets, 2);
2540194d53e6SMatthew G. Knepley   *offsets = prob->off;
2541194d53e6SMatthew G. Knepley   PetscFunctionReturn(0);
2542194d53e6SMatthew G. Knepley }
2543194d53e6SMatthew G. Knepley 
2544194d53e6SMatthew G. Knepley /*@
2545194d53e6SMatthew G. Knepley   PetscDSGetComponentDerivativeOffsets - Returns the offset of each field derivative on an evaluation point
2546194d53e6SMatthew G. Knepley 
2547194d53e6SMatthew G. Knepley   Not collective
2548194d53e6SMatthew G. Knepley 
2549194d53e6SMatthew G. Knepley   Input Parameter:
2550194d53e6SMatthew G. Knepley . prob - The PetscDS object
2551194d53e6SMatthew G. Knepley 
2552194d53e6SMatthew G. Knepley   Output Parameter:
2553194d53e6SMatthew G. Knepley . offsets - The offsets
2554194d53e6SMatthew G. Knepley 
2555194d53e6SMatthew G. Knepley   Level: beginner
2556194d53e6SMatthew G. Knepley 
2557f744cafaSSander Arens .seealso: PetscDSGetNumFields(), PetscDSCreate()
2558194d53e6SMatthew G. Knepley @*/
2559194d53e6SMatthew G. Knepley PetscErrorCode PetscDSGetComponentDerivativeOffsets(PetscDS prob, PetscInt *offsets[])
2560194d53e6SMatthew G. Knepley {
2561194d53e6SMatthew G. Knepley   PetscFunctionBegin;
2562194d53e6SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2563194d53e6SMatthew G. Knepley   PetscValidPointer(offsets, 2);
2564194d53e6SMatthew G. Knepley   *offsets = prob->offDer;
2565194d53e6SMatthew G. Knepley   PetscFunctionReturn(0);
2566194d53e6SMatthew G. Knepley }
2567194d53e6SMatthew G. Knepley 
256868c9edb9SMatthew G. Knepley /*@C
256968c9edb9SMatthew G. Knepley   PetscDSGetTabulation - Return the basis tabulation at quadrature points for the volume discretization
257068c9edb9SMatthew G. Knepley 
257168c9edb9SMatthew G. Knepley   Not collective
257268c9edb9SMatthew G. Knepley 
257368c9edb9SMatthew G. Knepley   Input Parameter:
257468c9edb9SMatthew G. Knepley . prob - The PetscDS object
257568c9edb9SMatthew G. Knepley 
257668c9edb9SMatthew G. Knepley   Output Parameters:
257768c9edb9SMatthew G. Knepley + basis - The basis function tabulation at quadrature points
257868c9edb9SMatthew G. Knepley - basisDer - The basis function derivative tabulation at quadrature points
257968c9edb9SMatthew G. Knepley 
258068c9edb9SMatthew G. Knepley   Level: intermediate
258168c9edb9SMatthew G. Knepley 
2582f744cafaSSander Arens .seealso: PetscDSCreate()
258368c9edb9SMatthew G. Knepley @*/
25842764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetTabulation(PetscDS prob, PetscReal ***basis, PetscReal ***basisDer)
25852764a2aaSMatthew G. Knepley {
25862764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
25872764a2aaSMatthew G. Knepley 
25882764a2aaSMatthew G. Knepley   PetscFunctionBegin;
25892764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
25902764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
25912764a2aaSMatthew G. Knepley   if (basis)    {PetscValidPointer(basis, 2);    *basis    = prob->basis;}
25922764a2aaSMatthew G. Knepley   if (basisDer) {PetscValidPointer(basisDer, 3); *basisDer = prob->basisDer;}
25932764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
25942764a2aaSMatthew G. Knepley }
25952764a2aaSMatthew G. Knepley 
259668c9edb9SMatthew G. Knepley /*@C
25974d0b9603SSander Arens   PetscDSGetFaceTabulation - Return the basis tabulation at quadrature points on the faces
259868c9edb9SMatthew G. Knepley 
259968c9edb9SMatthew G. Knepley   Not collective
260068c9edb9SMatthew G. Knepley 
260168c9edb9SMatthew G. Knepley   Input Parameter:
260268c9edb9SMatthew G. Knepley . prob - The PetscDS object
260368c9edb9SMatthew G. Knepley 
260468c9edb9SMatthew G. Knepley   Output Parameters:
26054d0b9603SSander Arens + basisFace - The basis function tabulation at quadrature points
26064d0b9603SSander Arens - basisDerFace - The basis function derivative tabulation at quadrature points
260768c9edb9SMatthew G. Knepley 
260868c9edb9SMatthew G. Knepley   Level: intermediate
260968c9edb9SMatthew G. Knepley 
261068c9edb9SMatthew G. Knepley .seealso: PetscDSGetTabulation(), PetscDSCreate()
261168c9edb9SMatthew G. Knepley @*/
26124d0b9603SSander Arens PetscErrorCode PetscDSGetFaceTabulation(PetscDS prob, PetscReal ***basis, PetscReal ***basisDer)
26132764a2aaSMatthew G. Knepley {
26142764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
26152764a2aaSMatthew G. Knepley 
26162764a2aaSMatthew G. Knepley   PetscFunctionBegin;
26172764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
26182764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
26194d0b9603SSander Arens   if (basis)    {PetscValidPointer(basis, 2);    *basis    = prob->basisFace;}
26204d0b9603SSander Arens   if (basisDer) {PetscValidPointer(basisDer, 3); *basisDer = prob->basisDerFace;}
26212764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
26222764a2aaSMatthew G. Knepley }
26232764a2aaSMatthew G. Knepley 
26242764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetEvaluationArrays(PetscDS prob, PetscScalar **u, PetscScalar **u_t, PetscScalar **u_x)
26252764a2aaSMatthew G. Knepley {
26262764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
26272764a2aaSMatthew G. Knepley 
26282764a2aaSMatthew G. Knepley   PetscFunctionBegin;
26292764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
26302764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
26312764a2aaSMatthew G. Knepley   if (u)   {PetscValidPointer(u, 2);   *u   = prob->u;}
26322764a2aaSMatthew G. Knepley   if (u_t) {PetscValidPointer(u_t, 3); *u_t = prob->u_t;}
26332764a2aaSMatthew G. Knepley   if (u_x) {PetscValidPointer(u_x, 4); *u_x = prob->u_x;}
26342764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
26352764a2aaSMatthew G. Knepley }
26362764a2aaSMatthew G. Knepley 
26372764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetWeakFormArrays(PetscDS prob, PetscScalar **f0, PetscScalar **f1, PetscScalar **g0, PetscScalar **g1, PetscScalar **g2, PetscScalar **g3)
26382764a2aaSMatthew G. Knepley {
26392764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
26402764a2aaSMatthew G. Knepley 
26412764a2aaSMatthew G. Knepley   PetscFunctionBegin;
26422764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
26432764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
26442764a2aaSMatthew G. Knepley   if (f0) {PetscValidPointer(f0, 2); *f0 = prob->f0;}
26452764a2aaSMatthew G. Knepley   if (f1) {PetscValidPointer(f1, 3); *f1 = prob->f1;}
26462764a2aaSMatthew G. Knepley   if (g0) {PetscValidPointer(g0, 4); *g0 = prob->g0;}
26472764a2aaSMatthew G. Knepley   if (g1) {PetscValidPointer(g1, 5); *g1 = prob->g1;}
26482764a2aaSMatthew G. Knepley   if (g2) {PetscValidPointer(g2, 6); *g2 = prob->g2;}
26492764a2aaSMatthew G. Knepley   if (g3) {PetscValidPointer(g3, 7); *g3 = prob->g3;}
26502764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
26512764a2aaSMatthew G. Knepley }
26522764a2aaSMatthew G. Knepley 
2653*4bee2e38SMatthew G. Knepley PetscErrorCode PetscDSGetWorkspace(PetscDS prob, PetscReal **x, PetscScalar **basisReal, PetscScalar **basisDerReal, PetscScalar **testReal, PetscScalar **testDerReal)
26542764a2aaSMatthew G. Knepley {
26552764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
26562764a2aaSMatthew G. Knepley 
26572764a2aaSMatthew G. Knepley   PetscFunctionBegin;
26582764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
26592764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
26602764a2aaSMatthew G. Knepley   if (x)            {PetscValidPointer(x, 2);            *x            = prob->x;}
2661*4bee2e38SMatthew G. Knepley   if (basisReal)    {PetscValidPointer(basisReal, 3);    *basisReal    = prob->basisReal;}
2662*4bee2e38SMatthew G. Knepley   if (basisDerReal) {PetscValidPointer(basisDerReal, 3); *basisDerReal = prob->basisDerReal;}
2663*4bee2e38SMatthew G. Knepley   if (testReal)     {PetscValidPointer(testReal, 3);     *testReal     = prob->testReal;}
2664*4bee2e38SMatthew G. Knepley   if (testDerReal)  {PetscValidPointer(testDerReal, 3);  *testDerReal  = prob->testDerReal;}
26652764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
26662764a2aaSMatthew G. Knepley }
26672764a2aaSMatthew G. Knepley 
266858ebd649SToby Isaac /*@C
266958ebd649SToby Isaac   PetscDSAddBoundary - Add a boundary condition to the model
267058ebd649SToby Isaac 
267158ebd649SToby Isaac   Input Parameters:
267258ebd649SToby Isaac + ds          - The PetscDS object
26732d47a189SJulian Andrej . type        - The type of condition, e.g. DM_BC_ESSENTIAL/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann)
267458ebd649SToby Isaac . name        - The BC name
267558ebd649SToby Isaac . labelname   - The label defining constrained points
267658ebd649SToby Isaac . field       - The field to constrain
2677e8ecbf3fSStefano Zampini . numcomps    - The number of constrained field components (0 will constrain all fields)
267858ebd649SToby Isaac . comps       - An array of constrained component numbers
267958ebd649SToby Isaac . bcFunc      - A pointwise function giving boundary values
268058ebd649SToby Isaac . numids      - The number of DMLabel ids for constrained points
268158ebd649SToby Isaac . ids         - An array of ids for constrained points
268258ebd649SToby Isaac - ctx         - An optional user context for bcFunc
268358ebd649SToby Isaac 
268458ebd649SToby Isaac   Options Database Keys:
268558ebd649SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids
268658ebd649SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components
268758ebd649SToby Isaac 
268858ebd649SToby Isaac   Level: developer
268958ebd649SToby Isaac 
269058ebd649SToby Isaac .seealso: PetscDSGetBoundary()
269158ebd649SToby Isaac @*/
2692a30ec4eaSSatish Balay PetscErrorCode PetscDSAddBoundary(PetscDS ds, DMBoundaryConditionType type, const char name[], const char labelname[], PetscInt field, PetscInt numcomps, const PetscInt *comps, void (*bcFunc)(void), PetscInt numids, const PetscInt *ids, void *ctx)
269358ebd649SToby Isaac {
269458ebd649SToby Isaac   DSBoundary     b;
269558ebd649SToby Isaac   PetscErrorCode ierr;
269658ebd649SToby Isaac 
269758ebd649SToby Isaac   PetscFunctionBegin;
269858ebd649SToby Isaac   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1);
269958ebd649SToby Isaac   ierr = PetscNew(&b);CHKERRQ(ierr);
270058ebd649SToby Isaac   ierr = PetscStrallocpy(name, (char **) &b->name);CHKERRQ(ierr);
270158ebd649SToby Isaac   ierr = PetscStrallocpy(labelname, (char **) &b->labelname);CHKERRQ(ierr);
270258ebd649SToby Isaac   ierr = PetscMalloc1(numcomps, &b->comps);CHKERRQ(ierr);
270358ebd649SToby Isaac   if (numcomps) {ierr = PetscMemcpy(b->comps, comps, numcomps*sizeof(PetscInt));CHKERRQ(ierr);}
270458ebd649SToby Isaac   ierr = PetscMalloc1(numids, &b->ids);CHKERRQ(ierr);
270558ebd649SToby Isaac   if (numids) {ierr = PetscMemcpy(b->ids, ids, numids*sizeof(PetscInt));CHKERRQ(ierr);}
2706f971fd6bSMatthew G. Knepley   b->type            = type;
270758ebd649SToby Isaac   b->field           = field;
270858ebd649SToby Isaac   b->numcomps        = numcomps;
270958ebd649SToby Isaac   b->func            = bcFunc;
271058ebd649SToby Isaac   b->numids          = numids;
271158ebd649SToby Isaac   b->ctx             = ctx;
271258ebd649SToby Isaac   b->next            = ds->boundary;
271358ebd649SToby Isaac   ds->boundary       = b;
271458ebd649SToby Isaac   PetscFunctionReturn(0);
271558ebd649SToby Isaac }
271658ebd649SToby Isaac 
2717b67eacb3SMatthew G. Knepley /*@C
2718b67eacb3SMatthew G. Knepley   PetscDSUpdateBoundary - Change a boundary condition for the model
2719b67eacb3SMatthew G. Knepley 
2720b67eacb3SMatthew G. Knepley   Input Parameters:
2721b67eacb3SMatthew G. Knepley + ds          - The PetscDS object
2722b67eacb3SMatthew G. Knepley . bd          - The boundary condition number
2723b67eacb3SMatthew G. Knepley . type        - The type of condition, e.g. DM_BC_ESSENTIAL/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann)
2724b67eacb3SMatthew G. Knepley . name        - The BC name
2725b67eacb3SMatthew G. Knepley . labelname   - The label defining constrained points
2726b67eacb3SMatthew G. Knepley . field       - The field to constrain
2727b67eacb3SMatthew G. Knepley . numcomps    - The number of constrained field components
2728b67eacb3SMatthew G. Knepley . comps       - An array of constrained component numbers
2729b67eacb3SMatthew G. Knepley . bcFunc      - A pointwise function giving boundary values
2730b67eacb3SMatthew G. Knepley . numids      - The number of DMLabel ids for constrained points
2731b67eacb3SMatthew G. Knepley . ids         - An array of ids for constrained points
2732b67eacb3SMatthew G. Knepley - ctx         - An optional user context for bcFunc
2733b67eacb3SMatthew G. Knepley 
27349a6efb6aSMatthew G. Knepley   Note: The boundary condition number is the order in which it was registered. The user can get the number of boundary conditions from PetscDSGetNumBoundary().
27359a6efb6aSMatthew G. Knepley 
2736b67eacb3SMatthew G. Knepley   Level: developer
2737b67eacb3SMatthew G. Knepley 
27389a6efb6aSMatthew G. Knepley .seealso: PetscDSAddBoundary(), PetscDSGetBoundary(), PetscDSGetNumBoundary()
2739b67eacb3SMatthew G. Knepley @*/
2740b67eacb3SMatthew G. Knepley PetscErrorCode PetscDSUpdateBoundary(PetscDS ds, PetscInt bd, DMBoundaryConditionType type, const char name[], const char labelname[], PetscInt field, PetscInt numcomps, const PetscInt *comps, void (*bcFunc)(void), PetscInt numids, const PetscInt *ids, void *ctx)
2741b67eacb3SMatthew G. Knepley {
2742b67eacb3SMatthew G. Knepley   DSBoundary     b = ds->boundary;
2743b67eacb3SMatthew G. Knepley   PetscInt       n = 0;
2744b67eacb3SMatthew G. Knepley   PetscErrorCode ierr;
2745b67eacb3SMatthew G. Knepley 
2746b67eacb3SMatthew G. Knepley   PetscFunctionBegin;
2747b67eacb3SMatthew G. Knepley   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1);
2748b67eacb3SMatthew G. Knepley   while (b) {
2749b67eacb3SMatthew G. Knepley     if (n == bd) break;
2750b67eacb3SMatthew G. Knepley     b = b->next;
2751b67eacb3SMatthew G. Knepley     ++n;
2752b67eacb3SMatthew G. Knepley   }
2753b67eacb3SMatthew G. Knepley   if (!b) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Boundary %d is not in [0, %d)", bd, n);
2754b67eacb3SMatthew G. Knepley   if (name) {
2755b67eacb3SMatthew G. Knepley     ierr = PetscFree(b->name);CHKERRQ(ierr);
2756b67eacb3SMatthew G. Knepley     ierr = PetscStrallocpy(name, (char **) &b->name);CHKERRQ(ierr);
2757b67eacb3SMatthew G. Knepley   }
2758b67eacb3SMatthew G. Knepley   if (labelname) {
2759b67eacb3SMatthew G. Knepley     ierr = PetscFree(b->labelname);CHKERRQ(ierr);
2760b67eacb3SMatthew G. Knepley     ierr = PetscStrallocpy(labelname, (char **) &b->labelname);CHKERRQ(ierr);
2761b67eacb3SMatthew G. Knepley   }
2762b67eacb3SMatthew G. Knepley   if (numcomps >= 0 && numcomps != b->numcomps) {
2763b67eacb3SMatthew G. Knepley     b->numcomps = numcomps;
2764b67eacb3SMatthew G. Knepley     ierr = PetscFree(b->comps);CHKERRQ(ierr);
2765b67eacb3SMatthew G. Knepley     ierr = PetscMalloc1(numcomps, &b->comps);CHKERRQ(ierr);
2766b67eacb3SMatthew G. Knepley     if (numcomps) {ierr = PetscMemcpy(b->comps, comps, numcomps*sizeof(PetscInt));CHKERRQ(ierr);}
2767b67eacb3SMatthew G. Knepley   }
2768b67eacb3SMatthew G. Knepley   if (numids >= 0 && numids != b->numids) {
2769b67eacb3SMatthew G. Knepley     b->numids = numids;
2770b67eacb3SMatthew G. Knepley     ierr = PetscFree(b->ids);CHKERRQ(ierr);
2771b67eacb3SMatthew G. Knepley     ierr = PetscMalloc1(numids, &b->ids);CHKERRQ(ierr);
2772b67eacb3SMatthew G. Knepley     if (numids) {ierr = PetscMemcpy(b->ids, ids, numids*sizeof(PetscInt));CHKERRQ(ierr);}
2773b67eacb3SMatthew G. Knepley   }
2774b67eacb3SMatthew G. Knepley   b->type = type;
2775b67eacb3SMatthew G. Knepley   if (field >= 0) {b->field  = field;}
2776b67eacb3SMatthew G. Knepley   if (bcFunc)     {b->func   = bcFunc;}
2777b67eacb3SMatthew G. Knepley   if (ctx)        {b->ctx    = ctx;}
2778b67eacb3SMatthew G. Knepley   PetscFunctionReturn(0);
2779b67eacb3SMatthew G. Knepley }
2780b67eacb3SMatthew G. Knepley 
278158ebd649SToby Isaac /*@
278258ebd649SToby Isaac   PetscDSGetNumBoundary - Get the number of registered BC
278358ebd649SToby Isaac 
278458ebd649SToby Isaac   Input Parameters:
278558ebd649SToby Isaac . ds - The PetscDS object
278658ebd649SToby Isaac 
278758ebd649SToby Isaac   Output Parameters:
278858ebd649SToby Isaac . numBd - The number of BC
278958ebd649SToby Isaac 
279058ebd649SToby Isaac   Level: intermediate
279158ebd649SToby Isaac 
279258ebd649SToby Isaac .seealso: PetscDSAddBoundary(), PetscDSGetBoundary()
279358ebd649SToby Isaac @*/
279458ebd649SToby Isaac PetscErrorCode PetscDSGetNumBoundary(PetscDS ds, PetscInt *numBd)
279558ebd649SToby Isaac {
279658ebd649SToby Isaac   DSBoundary b = ds->boundary;
279758ebd649SToby Isaac 
279858ebd649SToby Isaac   PetscFunctionBegin;
279958ebd649SToby Isaac   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1);
280058ebd649SToby Isaac   PetscValidPointer(numBd, 2);
280158ebd649SToby Isaac   *numBd = 0;
280258ebd649SToby Isaac   while (b) {++(*numBd); b = b->next;}
280358ebd649SToby Isaac   PetscFunctionReturn(0);
280458ebd649SToby Isaac }
280558ebd649SToby Isaac 
280658ebd649SToby Isaac /*@C
28079a6efb6aSMatthew G. Knepley   PetscDSGetBoundary - Gets a boundary condition to the model
280858ebd649SToby Isaac 
280958ebd649SToby Isaac   Input Parameters:
281058ebd649SToby Isaac + ds          - The PetscDS object
281158ebd649SToby Isaac - bd          - The BC number
281258ebd649SToby Isaac 
281358ebd649SToby Isaac   Output Parameters:
28142d47a189SJulian Andrej + type        - The type of condition, e.g. DM_BC_ESSENTIAL/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann)
281558ebd649SToby Isaac . name        - The BC name
281658ebd649SToby Isaac . labelname   - The label defining constrained points
281758ebd649SToby Isaac . field       - The field to constrain
281858ebd649SToby Isaac . numcomps    - The number of constrained field components
281958ebd649SToby Isaac . comps       - An array of constrained component numbers
282058ebd649SToby Isaac . bcFunc      - A pointwise function giving boundary values
282158ebd649SToby Isaac . numids      - The number of DMLabel ids for constrained points
282258ebd649SToby Isaac . ids         - An array of ids for constrained points
282358ebd649SToby Isaac - ctx         - An optional user context for bcFunc
282458ebd649SToby Isaac 
282558ebd649SToby Isaac   Options Database Keys:
282658ebd649SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids
282758ebd649SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components
282858ebd649SToby Isaac 
282958ebd649SToby Isaac   Level: developer
283058ebd649SToby Isaac 
283158ebd649SToby Isaac .seealso: PetscDSAddBoundary()
283258ebd649SToby Isaac @*/
2833a30ec4eaSSatish Balay PetscErrorCode PetscDSGetBoundary(PetscDS ds, PetscInt bd, DMBoundaryConditionType *type, const char **name, const char **labelname, PetscInt *field, PetscInt *numcomps, const PetscInt **comps, void (**func)(void), PetscInt *numids, const PetscInt **ids, void **ctx)
283458ebd649SToby Isaac {
283558ebd649SToby Isaac   DSBoundary b    = ds->boundary;
283658ebd649SToby Isaac   PetscInt   n    = 0;
283758ebd649SToby Isaac 
283858ebd649SToby Isaac   PetscFunctionBegin;
283958ebd649SToby Isaac   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1);
284058ebd649SToby Isaac   while (b) {
284158ebd649SToby Isaac     if (n == bd) break;
284258ebd649SToby Isaac     b = b->next;
284358ebd649SToby Isaac     ++n;
284458ebd649SToby Isaac   }
284558ebd649SToby Isaac   if (!b) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Boundary %d is not in [0, %d)", bd, n);
2846f971fd6bSMatthew G. Knepley   if (type) {
2847f971fd6bSMatthew G. Knepley     PetscValidPointer(type, 3);
2848f971fd6bSMatthew G. Knepley     *type = b->type;
284958ebd649SToby Isaac   }
285058ebd649SToby Isaac   if (name) {
285158ebd649SToby Isaac     PetscValidPointer(name, 4);
285258ebd649SToby Isaac     *name = b->name;
285358ebd649SToby Isaac   }
285458ebd649SToby Isaac   if (labelname) {
285558ebd649SToby Isaac     PetscValidPointer(labelname, 5);
285658ebd649SToby Isaac     *labelname = b->labelname;
285758ebd649SToby Isaac   }
285858ebd649SToby Isaac   if (field) {
285958ebd649SToby Isaac     PetscValidPointer(field, 6);
286058ebd649SToby Isaac     *field = b->field;
286158ebd649SToby Isaac   }
286258ebd649SToby Isaac   if (numcomps) {
286358ebd649SToby Isaac     PetscValidPointer(numcomps, 7);
286458ebd649SToby Isaac     *numcomps = b->numcomps;
286558ebd649SToby Isaac   }
286658ebd649SToby Isaac   if (comps) {
286758ebd649SToby Isaac     PetscValidPointer(comps, 8);
286858ebd649SToby Isaac     *comps = b->comps;
286958ebd649SToby Isaac   }
287058ebd649SToby Isaac   if (func) {
287158ebd649SToby Isaac     PetscValidPointer(func, 9);
287258ebd649SToby Isaac     *func = b->func;
287358ebd649SToby Isaac   }
287458ebd649SToby Isaac   if (numids) {
287558ebd649SToby Isaac     PetscValidPointer(numids, 10);
287658ebd649SToby Isaac     *numids = b->numids;
287758ebd649SToby Isaac   }
287858ebd649SToby Isaac   if (ids) {
287958ebd649SToby Isaac     PetscValidPointer(ids, 11);
288058ebd649SToby Isaac     *ids = b->ids;
288158ebd649SToby Isaac   }
288258ebd649SToby Isaac   if (ctx) {
288358ebd649SToby Isaac     PetscValidPointer(ctx, 12);
288458ebd649SToby Isaac     *ctx = b->ctx;
288558ebd649SToby Isaac   }
288658ebd649SToby Isaac   PetscFunctionReturn(0);
288758ebd649SToby Isaac }
288858ebd649SToby Isaac 
28899252d075SMatthew G. Knepley /*@
28909252d075SMatthew G. Knepley   PetscDSCopyBoundary - Copy all boundary condition objects to the new problem
28919252d075SMatthew G. Knepley 
28929252d075SMatthew G. Knepley   Not collective
28939252d075SMatthew G. Knepley 
28949252d075SMatthew G. Knepley   Input Parameter:
28959252d075SMatthew G. Knepley . prob - The PetscDS object
28969252d075SMatthew G. Knepley 
28979252d075SMatthew G. Knepley   Output Parameter:
28989252d075SMatthew G. Knepley . newprob - The PetscDS copy
28999252d075SMatthew G. Knepley 
29009252d075SMatthew G. Knepley   Level: intermediate
29019252d075SMatthew G. Knepley 
29029252d075SMatthew G. Knepley .seealso: PetscDSCopyEquations(), PetscDSSetResidual(), PetscDSSetJacobian(), PetscDSSetRiemannSolver(), PetscDSSetBdResidual(), PetscDSSetBdJacobian(), PetscDSCreate()
29039252d075SMatthew G. Knepley @*/
2904dff059c6SToby Isaac PetscErrorCode PetscDSCopyBoundary(PetscDS probA, PetscDS probB)
2905dff059c6SToby Isaac {
2906dff059c6SToby Isaac   DSBoundary     b, next, *lastnext;
2907dff059c6SToby Isaac   PetscErrorCode ierr;
2908dff059c6SToby Isaac 
2909dff059c6SToby Isaac   PetscFunctionBegin;
2910dff059c6SToby Isaac   PetscValidHeaderSpecific(probA, PETSCDS_CLASSID, 1);
2911dff059c6SToby Isaac   PetscValidHeaderSpecific(probB, PETSCDS_CLASSID, 2);
2912dff059c6SToby Isaac   if (probA == probB) PetscFunctionReturn(0);
2913dff059c6SToby Isaac   next = probB->boundary;
2914dff059c6SToby Isaac   while (next) {
2915dff059c6SToby Isaac     DSBoundary b = next;
2916dff059c6SToby Isaac 
2917dff059c6SToby Isaac     next = b->next;
2918dff059c6SToby Isaac     ierr = PetscFree(b->comps);CHKERRQ(ierr);
2919dff059c6SToby Isaac     ierr = PetscFree(b->ids);CHKERRQ(ierr);
2920dff059c6SToby Isaac     ierr = PetscFree(b->name);CHKERRQ(ierr);
2921dff059c6SToby Isaac     ierr = PetscFree(b->labelname);CHKERRQ(ierr);
2922dff059c6SToby Isaac     ierr = PetscFree(b);CHKERRQ(ierr);
2923dff059c6SToby Isaac   }
2924dff059c6SToby Isaac   lastnext = &(probB->boundary);
2925dff059c6SToby Isaac   for (b = probA->boundary; b; b = b->next) {
2926dff059c6SToby Isaac     DSBoundary bNew;
2927dff059c6SToby Isaac 
2928459726d8SSatish Balay     ierr = PetscNew(&bNew);CHKERRQ(ierr);
2929dff059c6SToby Isaac     bNew->numcomps = b->numcomps;
2930dff059c6SToby Isaac     ierr = PetscMalloc1(bNew->numcomps, &bNew->comps);CHKERRQ(ierr);
2931dff059c6SToby Isaac     ierr = PetscMemcpy(bNew->comps, b->comps, bNew->numcomps*sizeof(PetscInt));CHKERRQ(ierr);
2932dff059c6SToby Isaac     bNew->numids = b->numids;
2933dff059c6SToby Isaac     ierr = PetscMalloc1(bNew->numids, &bNew->ids);CHKERRQ(ierr);
2934dff059c6SToby Isaac     ierr = PetscMemcpy(bNew->ids, b->ids, bNew->numids*sizeof(PetscInt));CHKERRQ(ierr);
2935dff059c6SToby Isaac     ierr = PetscStrallocpy(b->labelname,(char **) &(bNew->labelname));CHKERRQ(ierr);
2936dff059c6SToby Isaac     ierr = PetscStrallocpy(b->name,(char **) &(bNew->name));CHKERRQ(ierr);
2937dff059c6SToby Isaac     bNew->ctx   = b->ctx;
2938f971fd6bSMatthew G. Knepley     bNew->type  = b->type;
2939dff059c6SToby Isaac     bNew->field = b->field;
2940dff059c6SToby Isaac     bNew->func  = b->func;
2941dff059c6SToby Isaac 
2942dff059c6SToby Isaac     *lastnext = bNew;
2943dff059c6SToby Isaac     lastnext = &(bNew->next);
2944dff059c6SToby Isaac   }
2945dff059c6SToby Isaac   PetscFunctionReturn(0);
2946dff059c6SToby Isaac }
2947dff059c6SToby Isaac 
29489252d075SMatthew G. Knepley /*@C
29499252d075SMatthew G. Knepley   PetscDSSelectEquations - Copy pointwise function pointers to the new problem with different field layout
29509252d075SMatthew G. Knepley 
29519252d075SMatthew G. Knepley   Not collective
29529252d075SMatthew G. Knepley 
29539252d075SMatthew G. Knepley   Input Parameter:
29549252d075SMatthew G. Knepley + prob - The PetscDS object
29559252d075SMatthew G. Knepley . numFields - Number of new fields
29569252d075SMatthew G. Knepley - fields - Old field number for each new field
29579252d075SMatthew G. Knepley 
29589252d075SMatthew G. Knepley   Output Parameter:
29599252d075SMatthew G. Knepley . newprob - The PetscDS copy
29609252d075SMatthew G. Knepley 
29619252d075SMatthew G. Knepley   Level: intermediate
29629252d075SMatthew G. Knepley 
29639252d075SMatthew G. Knepley .seealso: PetscDSCopyBoundary(), PetscDSSetResidual(), PetscDSSetJacobian(), PetscDSSetRiemannSolver(), PetscDSSetBdResidual(), PetscDSSetBdJacobian(), PetscDSCreate()
29649252d075SMatthew G. Knepley @*/
29659252d075SMatthew G. Knepley PetscErrorCode PetscDSSelectEquations(PetscDS prob, PetscInt numFields, const PetscInt fields[], PetscDS newprob)
29669252d075SMatthew G. Knepley {
29679252d075SMatthew G. Knepley   PetscInt       Nf, Nfn, fn, gn;
29689252d075SMatthew G. Knepley   PetscErrorCode ierr;
29699252d075SMatthew G. Knepley 
29709252d075SMatthew G. Knepley   PetscFunctionBegin;
29719252d075SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
29729252d075SMatthew G. Knepley   if (fields) PetscValidPointer(fields, 3);
29739252d075SMatthew G. Knepley   PetscValidHeaderSpecific(newprob, PETSCDS_CLASSID, 4);
29749252d075SMatthew G. Knepley   ierr = PetscDSGetNumFields(prob, &Nf);CHKERRQ(ierr);
29759252d075SMatthew G. Knepley   ierr = PetscDSGetNumFields(newprob, &Nfn);CHKERRQ(ierr);
29769252d075SMatthew G. Knepley   if (numFields > Nfn) SETERRQ2(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_SIZ, "Number of fields %D to transfer must not be greater then the total number of fields %D", numFields, Nfn);
29779252d075SMatthew G. Knepley   for (fn = 0; fn < numFields; ++fn) {
29789252d075SMatthew G. Knepley     const PetscInt   f = fields ? fields[fn] : fn;
29799252d075SMatthew G. Knepley     PetscPointFunc   obj;
29809252d075SMatthew G. Knepley     PetscPointFunc   f0, f1;
29819252d075SMatthew G. Knepley     PetscBdPointFunc f0Bd, f1Bd;
29829252d075SMatthew G. Knepley     PetscRiemannFunc r;
29839252d075SMatthew G. Knepley 
29849252d075SMatthew G. Knepley     if (f >= Nf) SETERRQ2(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_SIZ, "Field %D must be in [0, %D)", f, Nf);
29859252d075SMatthew G. Knepley     ierr = PetscDSGetObjective(prob, f, &obj);CHKERRQ(ierr);
29869252d075SMatthew G. Knepley     ierr = PetscDSGetResidual(prob, f, &f0, &f1);CHKERRQ(ierr);
29879252d075SMatthew G. Knepley     ierr = PetscDSGetBdResidual(prob, f, &f0Bd, &f1Bd);CHKERRQ(ierr);
29889252d075SMatthew G. Knepley     ierr = PetscDSGetRiemannSolver(prob, f, &r);CHKERRQ(ierr);
29899252d075SMatthew G. Knepley     ierr = PetscDSSetObjective(newprob, fn, obj);CHKERRQ(ierr);
29909252d075SMatthew G. Knepley     ierr = PetscDSSetResidual(newprob, fn, f0, f1);CHKERRQ(ierr);
29919252d075SMatthew G. Knepley     ierr = PetscDSSetBdResidual(newprob, fn, f0Bd, f1Bd);CHKERRQ(ierr);
29929252d075SMatthew G. Knepley     ierr = PetscDSSetRiemannSolver(newprob, fn, r);CHKERRQ(ierr);
29939252d075SMatthew G. Knepley     for (gn = 0; gn < numFields; ++gn) {
29949252d075SMatthew G. Knepley       const PetscInt  g = fields ? fields[gn] : gn;
29959252d075SMatthew G. Knepley       PetscPointJac   g0, g1, g2, g3;
29969252d075SMatthew G. Knepley       PetscPointJac   g0p, g1p, g2p, g3p;
29979252d075SMatthew G. Knepley       PetscBdPointJac g0Bd, g1Bd, g2Bd, g3Bd;
29989252d075SMatthew G. Knepley 
29999252d075SMatthew G. Knepley       if (g >= Nf) SETERRQ2(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_SIZ, "Field %D must be in [0, %D)", g, Nf);
30009252d075SMatthew G. Knepley       ierr = PetscDSGetJacobian(prob, f, g, &g0, &g1, &g2, &g3);CHKERRQ(ierr);
30019252d075SMatthew G. Knepley       ierr = PetscDSGetJacobianPreconditioner(prob, f, g, &g0p, &g1p, &g2p, &g3p);CHKERRQ(ierr);
30029252d075SMatthew G. Knepley       ierr = PetscDSGetBdJacobian(prob, f, g, &g0Bd, &g1Bd, &g2Bd, &g3Bd);CHKERRQ(ierr);
30039252d075SMatthew G. Knepley       ierr = PetscDSSetJacobian(newprob, fn, gn, g0, g1, g2, g3);CHKERRQ(ierr);
30049252d075SMatthew G. Knepley       ierr = PetscDSSetJacobianPreconditioner(prob, fn, gn, g0p, g1p, g2p, g3p);CHKERRQ(ierr);
30059252d075SMatthew G. Knepley       ierr = PetscDSSetBdJacobian(newprob, fn, gn, g0Bd, g1Bd, g2Bd, g3Bd);CHKERRQ(ierr);
30069252d075SMatthew G. Knepley     }
30079252d075SMatthew G. Knepley   }
30089252d075SMatthew G. Knepley   PetscFunctionReturn(0);
30099252d075SMatthew G. Knepley }
30109252d075SMatthew G. Knepley 
3011da51fcedSMatthew G. Knepley /*@
3012da51fcedSMatthew G. Knepley   PetscDSCopyEquations - Copy all pointwise function pointers to the new problem
3013da51fcedSMatthew G. Knepley 
3014da51fcedSMatthew G. Knepley   Not collective
3015da51fcedSMatthew G. Knepley 
3016da51fcedSMatthew G. Knepley   Input Parameter:
3017da51fcedSMatthew G. Knepley . prob - The PetscDS object
3018da51fcedSMatthew G. Knepley 
3019da51fcedSMatthew G. Knepley   Output Parameter:
3020da51fcedSMatthew G. Knepley . newprob - The PetscDS copy
3021da51fcedSMatthew G. Knepley 
3022da51fcedSMatthew G. Knepley   Level: intermediate
3023da51fcedSMatthew G. Knepley 
30249252d075SMatthew G. Knepley .seealso: PetscDSCopyBoundary(), PetscDSSetResidual(), PetscDSSetJacobian(), PetscDSSetRiemannSolver(), PetscDSSetBdResidual(), PetscDSSetBdJacobian(), PetscDSCreate()
3025da51fcedSMatthew G. Knepley @*/
3026da51fcedSMatthew G. Knepley PetscErrorCode PetscDSCopyEquations(PetscDS prob, PetscDS newprob)
3027da51fcedSMatthew G. Knepley {
30289252d075SMatthew G. Knepley   PetscInt       Nf, Ng;
3029da51fcedSMatthew G. Knepley   PetscErrorCode ierr;
3030da51fcedSMatthew G. Knepley 
3031da51fcedSMatthew G. Knepley   PetscFunctionBegin;
3032da51fcedSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
3033da51fcedSMatthew G. Knepley   PetscValidHeaderSpecific(newprob, PETSCDS_CLASSID, 2);
3034da51fcedSMatthew G. Knepley   ierr = PetscDSGetNumFields(prob, &Nf);CHKERRQ(ierr);
3035da51fcedSMatthew G. Knepley   ierr = PetscDSGetNumFields(newprob, &Ng);CHKERRQ(ierr);
303613903a91SSatish Balay   if (Nf != Ng) SETERRQ2(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_SIZ, "Number of fields must match %D != %D", Nf, Ng);
30379252d075SMatthew G. Knepley   ierr = PetscDSSelectEquations(prob, Nf, NULL, newprob);CHKERRQ(ierr);
30389252d075SMatthew G. Knepley   PetscFunctionReturn(0);
30399252d075SMatthew G. Knepley }
30409252d075SMatthew G. Knepley /*@
30419252d075SMatthew G. Knepley   PetscDSCopyConstants - Copy all constants to the new problem
3042da51fcedSMatthew G. Knepley 
30439252d075SMatthew G. Knepley   Not collective
30449252d075SMatthew G. Knepley 
30459252d075SMatthew G. Knepley   Input Parameter:
30469252d075SMatthew G. Knepley . prob - The PetscDS object
30479252d075SMatthew G. Knepley 
30489252d075SMatthew G. Knepley   Output Parameter:
30499252d075SMatthew G. Knepley . newprob - The PetscDS copy
30509252d075SMatthew G. Knepley 
30519252d075SMatthew G. Knepley   Level: intermediate
30529252d075SMatthew G. Knepley 
30539252d075SMatthew G. Knepley .seealso: PetscDSCopyBoundary(), PetscDSCopyEquations(), PetscDSSetResidual(), PetscDSSetJacobian(), PetscDSSetRiemannSolver(), PetscDSSetBdResidual(), PetscDSSetBdJacobian(), PetscDSCreate()
30549252d075SMatthew G. Knepley @*/
30559252d075SMatthew G. Knepley PetscErrorCode PetscDSCopyConstants(PetscDS prob, PetscDS newprob)
30569252d075SMatthew G. Knepley {
30579252d075SMatthew G. Knepley   PetscInt           Nc;
30589252d075SMatthew G. Knepley   const PetscScalar *constants;
30599252d075SMatthew G. Knepley   PetscErrorCode     ierr;
30609252d075SMatthew G. Knepley 
30619252d075SMatthew G. Knepley   PetscFunctionBegin;
30629252d075SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
30639252d075SMatthew G. Knepley   PetscValidHeaderSpecific(newprob, PETSCDS_CLASSID, 2);
30649252d075SMatthew G. Knepley   ierr = PetscDSGetConstants(prob, &Nc, &constants);CHKERRQ(ierr);
30659252d075SMatthew G. Knepley   ierr = PetscDSSetConstants(newprob, Nc, (PetscScalar *) constants);CHKERRQ(ierr);
3066da51fcedSMatthew G. Knepley   PetscFunctionReturn(0);
3067da51fcedSMatthew G. Knepley }
3068da51fcedSMatthew G. Knepley 
3069b1353e8eSMatthew G. Knepley PetscErrorCode PetscDSGetHeightSubspace(PetscDS prob, PetscInt height, PetscDS *subprob)
3070b1353e8eSMatthew G. Knepley {
3071df3a45bdSMatthew G. Knepley   PetscInt       dim, Nf, f;
3072b1353e8eSMatthew G. Knepley   PetscErrorCode ierr;
3073b1353e8eSMatthew G. Knepley 
3074b1353e8eSMatthew G. Knepley   PetscFunctionBegin;
3075b1353e8eSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
3076b1353e8eSMatthew G. Knepley   PetscValidPointer(subprob, 3);
3077b1353e8eSMatthew G. Knepley   if (height == 0) {*subprob = prob; PetscFunctionReturn(0);}
3078b1353e8eSMatthew G. Knepley   ierr = PetscDSGetNumFields(prob, &Nf);CHKERRQ(ierr);
3079df3a45bdSMatthew G. Knepley   ierr = PetscDSGetSpatialDimension(prob, &dim);CHKERRQ(ierr);
3080df3a45bdSMatthew G. Knepley   if (height > dim) SETERRQ2(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_OUTOFRANGE, "DS can only handle height in [0, %D], not %D", dim, height);
3081df3a45bdSMatthew G. Knepley   if (!prob->subprobs) {ierr = PetscCalloc1(dim, &prob->subprobs);CHKERRQ(ierr);}
3082df3a45bdSMatthew G. Knepley   if (!prob->subprobs[height-1]) {
3083b1353e8eSMatthew G. Knepley     PetscInt cdim;
3084b1353e8eSMatthew G. Knepley 
3085df3a45bdSMatthew G. Knepley     ierr = PetscDSCreate(PetscObjectComm((PetscObject) prob), &prob->subprobs[height-1]);CHKERRQ(ierr);
3086b1353e8eSMatthew G. Knepley     ierr = PetscDSGetCoordinateDimension(prob, &cdim);CHKERRQ(ierr);
3087df3a45bdSMatthew G. Knepley     ierr = PetscDSSetCoordinateDimension(prob->subprobs[height-1], cdim);CHKERRQ(ierr);
3088b1353e8eSMatthew G. Knepley     for (f = 0; f < Nf; ++f) {
3089b1353e8eSMatthew G. Knepley       PetscFE      subfe;
3090b1353e8eSMatthew G. Knepley       PetscObject  obj;
3091b1353e8eSMatthew G. Knepley       PetscClassId id;
3092b1353e8eSMatthew G. Knepley 
3093b1353e8eSMatthew G. Knepley       ierr = PetscDSGetDiscretization(prob, f, &obj);CHKERRQ(ierr);
3094b1353e8eSMatthew G. Knepley       ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr);
3095b1353e8eSMatthew G. Knepley       if (id == PETSCFE_CLASSID) {ierr = PetscFEGetHeightSubspace((PetscFE) obj, height, &subfe);CHKERRQ(ierr);}
3096b1353e8eSMatthew G. Knepley       else SETERRQ1(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Unsupported discretization type for field %d", f);
3097df3a45bdSMatthew G. Knepley       ierr = PetscDSSetDiscretization(prob->subprobs[height-1], f, (PetscObject) subfe);CHKERRQ(ierr);
3098b1353e8eSMatthew G. Knepley     }
3099b1353e8eSMatthew G. Knepley   }
3100df3a45bdSMatthew G. Knepley   *subprob = prob->subprobs[height-1];
3101b1353e8eSMatthew G. Knepley   PetscFunctionReturn(0);
3102b1353e8eSMatthew G. Knepley }
3103b1353e8eSMatthew G. Knepley 
3104bc4ae4beSMatthew G. Knepley static PetscErrorCode PetscDSDestroy_Basic(PetscDS prob)
31052764a2aaSMatthew G. Knepley {
3106931fb3b8SToby Isaac   PetscErrorCode      ierr;
3107931fb3b8SToby Isaac 
31082764a2aaSMatthew G. Knepley   PetscFunctionBegin;
3109931fb3b8SToby Isaac   ierr = PetscFree(prob->data);CHKERRQ(ierr);
31102764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
31112764a2aaSMatthew G. Knepley }
31122764a2aaSMatthew G. Knepley 
3113bc4ae4beSMatthew G. Knepley static PetscErrorCode PetscDSInitialize_Basic(PetscDS prob)
31142764a2aaSMatthew G. Knepley {
31152764a2aaSMatthew G. Knepley   PetscFunctionBegin;
31162764a2aaSMatthew G. Knepley   prob->ops->setfromoptions = NULL;
31172764a2aaSMatthew G. Knepley   prob->ops->setup          = NULL;
31182764a2aaSMatthew G. Knepley   prob->ops->view           = NULL;
31192764a2aaSMatthew G. Knepley   prob->ops->destroy        = PetscDSDestroy_Basic;
31202764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
31212764a2aaSMatthew G. Knepley }
31222764a2aaSMatthew G. Knepley 
31232764a2aaSMatthew G. Knepley /*MC
31242764a2aaSMatthew G. Knepley   PETSCDSBASIC = "basic" - A discrete system with pointwise residual and boundary residual functions
31252764a2aaSMatthew G. Knepley 
31262764a2aaSMatthew G. Knepley   Level: intermediate
31272764a2aaSMatthew G. Knepley 
31282764a2aaSMatthew G. Knepley .seealso: PetscDSType, PetscDSCreate(), PetscDSSetType()
31292764a2aaSMatthew G. Knepley M*/
31302764a2aaSMatthew G. Knepley 
31312764a2aaSMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscDSCreate_Basic(PetscDS prob)
31322764a2aaSMatthew G. Knepley {
31332764a2aaSMatthew G. Knepley   PetscDS_Basic *b;
31342764a2aaSMatthew G. Knepley   PetscErrorCode      ierr;
31352764a2aaSMatthew G. Knepley 
31362764a2aaSMatthew G. Knepley   PetscFunctionBegin;
3137931fb3b8SToby Isaac   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
31382764a2aaSMatthew G. Knepley   ierr       = PetscNewLog(prob, &b);CHKERRQ(ierr);
31392764a2aaSMatthew G. Knepley   prob->data = b;
31402764a2aaSMatthew G. Knepley 
31412764a2aaSMatthew G. Knepley   ierr = PetscDSInitialize_Basic(prob);CHKERRQ(ierr);
31422764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
31432764a2aaSMatthew G. Knepley }
3144