xref: /petsc/src/dm/dt/interface/dtds.c (revision d083f849a86f1f43e18d534ee43954e2786cb29a)
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 .seealso: PetscDSRegisterAll(), PetscDSRegisterDestroy()
532764a2aaSMatthew G. Knepley 
542764a2aaSMatthew G. Knepley @*/
552764a2aaSMatthew G. Knepley PetscErrorCode PetscDSRegister(const char sname[], PetscErrorCode (*function)(PetscDS))
562764a2aaSMatthew G. Knepley {
572764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
582764a2aaSMatthew G. Knepley 
592764a2aaSMatthew G. Knepley   PetscFunctionBegin;
602764a2aaSMatthew G. Knepley   ierr = PetscFunctionListAdd(&PetscDSList, sname, function);CHKERRQ(ierr);
612764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
622764a2aaSMatthew G. Knepley }
632764a2aaSMatthew G. Knepley 
642764a2aaSMatthew G. Knepley /*@C
652764a2aaSMatthew G. Knepley   PetscDSSetType - Builds a particular PetscDS
662764a2aaSMatthew G. Knepley 
67*d083f849SBarry Smith   Collective on prob
682764a2aaSMatthew G. Knepley 
692764a2aaSMatthew G. Knepley   Input Parameters:
702764a2aaSMatthew G. Knepley + prob - The PetscDS object
712764a2aaSMatthew G. Knepley - name - The kind of system
722764a2aaSMatthew G. Knepley 
732764a2aaSMatthew G. Knepley   Options Database Key:
742764a2aaSMatthew G. Knepley . -petscds_type <type> - Sets the PetscDS type; use -help for a list of available types
752764a2aaSMatthew G. Knepley 
762764a2aaSMatthew G. Knepley   Level: intermediate
772764a2aaSMatthew G. Knepley 
78f5f57ec0SBarry Smith    Not available from Fortran
79f5f57ec0SBarry Smith 
802764a2aaSMatthew G. Knepley .seealso: PetscDSGetType(), PetscDSCreate()
812764a2aaSMatthew G. Knepley @*/
822764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetType(PetscDS prob, PetscDSType name)
832764a2aaSMatthew G. Knepley {
842764a2aaSMatthew G. Knepley   PetscErrorCode (*r)(PetscDS);
852764a2aaSMatthew G. Knepley   PetscBool      match;
862764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
872764a2aaSMatthew G. Knepley 
882764a2aaSMatthew G. Knepley   PetscFunctionBegin;
892764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
902764a2aaSMatthew G. Knepley   ierr = PetscObjectTypeCompare((PetscObject) prob, name, &match);CHKERRQ(ierr);
912764a2aaSMatthew G. Knepley   if (match) PetscFunctionReturn(0);
922764a2aaSMatthew G. Knepley 
930f51fdf8SToby Isaac   ierr = PetscDSRegisterAll();CHKERRQ(ierr);
942764a2aaSMatthew G. Knepley   ierr = PetscFunctionListFind(PetscDSList, name, &r);CHKERRQ(ierr);
952764a2aaSMatthew G. Knepley   if (!r) SETERRQ1(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_UNKNOWN_TYPE, "Unknown PetscDS type: %s", name);
962764a2aaSMatthew G. Knepley 
972764a2aaSMatthew G. Knepley   if (prob->ops->destroy) {
982764a2aaSMatthew G. Knepley     ierr             = (*prob->ops->destroy)(prob);CHKERRQ(ierr);
992764a2aaSMatthew G. Knepley     prob->ops->destroy = NULL;
1002764a2aaSMatthew G. Knepley   }
1012764a2aaSMatthew G. Knepley   ierr = (*r)(prob);CHKERRQ(ierr);
1022764a2aaSMatthew G. Knepley   ierr = PetscObjectChangeTypeName((PetscObject) prob, name);CHKERRQ(ierr);
1032764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
1042764a2aaSMatthew G. Knepley }
1052764a2aaSMatthew G. Knepley 
1062764a2aaSMatthew G. Knepley /*@C
1072764a2aaSMatthew G. Knepley   PetscDSGetType - Gets the PetscDS type name (as a string) from the object.
1082764a2aaSMatthew G. Knepley 
1092764a2aaSMatthew G. Knepley   Not Collective
1102764a2aaSMatthew G. Knepley 
1112764a2aaSMatthew G. Knepley   Input Parameter:
1122764a2aaSMatthew G. Knepley . prob  - The PetscDS
1132764a2aaSMatthew G. Knepley 
1142764a2aaSMatthew G. Knepley   Output Parameter:
1152764a2aaSMatthew G. Knepley . name - The PetscDS type name
1162764a2aaSMatthew G. Knepley 
1172764a2aaSMatthew G. Knepley   Level: intermediate
1182764a2aaSMatthew G. Knepley 
119f5f57ec0SBarry Smith    Not available from Fortran
120f5f57ec0SBarry Smith 
1212764a2aaSMatthew G. Knepley .seealso: PetscDSSetType(), PetscDSCreate()
1222764a2aaSMatthew G. Knepley @*/
1232764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetType(PetscDS prob, PetscDSType *name)
1242764a2aaSMatthew G. Knepley {
1252764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
1262764a2aaSMatthew G. Knepley 
1272764a2aaSMatthew G. Knepley   PetscFunctionBegin;
1282764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
129c959eef4SJed Brown   PetscValidPointer(name, 2);
1300f51fdf8SToby Isaac   ierr = PetscDSRegisterAll();CHKERRQ(ierr);
1312764a2aaSMatthew G. Knepley   *name = ((PetscObject) prob)->type_name;
1322764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
1332764a2aaSMatthew G. Knepley }
1342764a2aaSMatthew G. Knepley 
1357d8a60eaSMatthew G. Knepley static PetscErrorCode PetscDSView_Ascii(PetscDS prob, PetscViewer viewer)
1367d8a60eaSMatthew G. Knepley {
1377d8a60eaSMatthew G. Knepley   PetscViewerFormat  format;
13897b6e6e8SMatthew G. Knepley   const PetscScalar *constants;
13997b6e6e8SMatthew G. Knepley   PetscInt           numConstants, f;
1407d8a60eaSMatthew G. Knepley   PetscErrorCode     ierr;
1417d8a60eaSMatthew G. Knepley 
1427d8a60eaSMatthew G. Knepley   PetscFunctionBegin;
1437d8a60eaSMatthew G. Knepley   ierr = PetscViewerGetFormat(viewer, &format);CHKERRQ(ierr);
1447d8a60eaSMatthew G. Knepley   ierr = PetscViewerASCIIPrintf(viewer, "Discrete System with %d fields\n", prob->Nf);CHKERRQ(ierr);
1457d8a60eaSMatthew G. Knepley   ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1464727e194SMatthew G. Knepley   ierr = PetscViewerASCIIPrintf(viewer, "  cell total dim %D total comp %D\n", prob->totDim, prob->totComp);CHKERRQ(ierr);
1474727e194SMatthew G. Knepley   if (prob->isHybrid) {ierr = PetscViewerASCIIPrintf(viewer, "  hybrid cell\n");CHKERRQ(ierr);}
1487d8a60eaSMatthew G. Knepley   for (f = 0; f < prob->Nf; ++f) {
14940967b3bSMatthew G. Knepley     DSBoundary      b;
1507d8a60eaSMatthew G. Knepley     PetscObject     obj;
1517d8a60eaSMatthew G. Knepley     PetscClassId    id;
152f35450b9SMatthew G. Knepley     PetscQuadrature q;
1537d8a60eaSMatthew G. Knepley     const char     *name;
154f35450b9SMatthew G. Knepley     PetscInt        Nc, Nq, Nqc;
1557d8a60eaSMatthew G. Knepley 
1567d8a60eaSMatthew G. Knepley     ierr = PetscDSGetDiscretization(prob, f, &obj);CHKERRQ(ierr);
1577d8a60eaSMatthew G. Knepley     ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr);
1587d8a60eaSMatthew G. Knepley     ierr = PetscObjectGetName(obj, &name);CHKERRQ(ierr);
1597d8a60eaSMatthew G. Knepley     ierr = PetscViewerASCIIPrintf(viewer, "Field %s", name ? name : "<unknown>");CHKERRQ(ierr);
1604727e194SMatthew G. Knepley     ierr = PetscViewerASCIIUseTabs(viewer, PETSC_FALSE);CHKERRQ(ierr);
1617d8a60eaSMatthew G. Knepley     if (id == PETSCFE_CLASSID)      {
1627d8a60eaSMatthew G. Knepley       ierr = PetscFEGetNumComponents((PetscFE) obj, &Nc);CHKERRQ(ierr);
163f35450b9SMatthew G. Knepley       ierr = PetscFEGetQuadrature((PetscFE) obj, &q);CHKERRQ(ierr);
1647d8a60eaSMatthew G. Knepley       ierr = PetscViewerASCIIPrintf(viewer, " FEM");CHKERRQ(ierr);
1657d8a60eaSMatthew G. Knepley     } else if (id == PETSCFV_CLASSID) {
1667d8a60eaSMatthew G. Knepley       ierr = PetscFVGetNumComponents((PetscFV) obj, &Nc);CHKERRQ(ierr);
167f35450b9SMatthew G. Knepley       ierr = PetscFVGetQuadrature((PetscFV) obj, &q);CHKERRQ(ierr);
1687d8a60eaSMatthew G. Knepley       ierr = PetscViewerASCIIPrintf(viewer, " FVM");CHKERRQ(ierr);
1697d8a60eaSMatthew G. Knepley     }
17097b6e6e8SMatthew G. Knepley     else SETERRQ1(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Unknown discretization type for field %D", f);
17197b6e6e8SMatthew G. Knepley     if (Nc > 1) {ierr = PetscViewerASCIIPrintf(viewer, "%D components", Nc);CHKERRQ(ierr);}
17297b6e6e8SMatthew G. Knepley     else        {ierr = PetscViewerASCIIPrintf(viewer, "%D component ", Nc);CHKERRQ(ierr);}
173249df284SMatthew G. Knepley     if (prob->implicit[f]) {ierr = PetscViewerASCIIPrintf(viewer, " (implicit)");CHKERRQ(ierr);}
174249df284SMatthew G. Knepley     else                   {ierr = PetscViewerASCIIPrintf(viewer, " (explicit)");CHKERRQ(ierr);}
1753e60c2a6SMatthew G. Knepley     if (q) {
176f35450b9SMatthew G. Knepley       ierr = PetscQuadratureGetData(q, NULL, &Nqc, &Nq, NULL, NULL);CHKERRQ(ierr);
177f35450b9SMatthew G. Knepley       ierr = PetscViewerASCIIPrintf(viewer, " (Nq %D Nqc %D)", Nq, Nqc);CHKERRQ(ierr);
1783e60c2a6SMatthew G. Knepley     }
1797d8a60eaSMatthew G. Knepley     ierr = PetscViewerASCIIPrintf(viewer, "\n");CHKERRQ(ierr);
1804727e194SMatthew G. Knepley     ierr = PetscViewerASCIIUseTabs(viewer, PETSC_TRUE);CHKERRQ(ierr);
1815d160056SMatthew G. Knepley     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1827d8a60eaSMatthew G. Knepley     if (id == PETSCFE_CLASSID)      {ierr = PetscFEView((PetscFE) obj, viewer);CHKERRQ(ierr);}
1837d8a60eaSMatthew G. Knepley     else if (id == PETSCFV_CLASSID) {ierr = PetscFVView((PetscFV) obj, viewer);CHKERRQ(ierr);}
1845d160056SMatthew G. Knepley     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
18540967b3bSMatthew G. Knepley 
18640967b3bSMatthew G. Knepley     for (b = prob->boundary; b; b = b->next) {
18740967b3bSMatthew G. Knepley       PetscInt c, i;
18840967b3bSMatthew G. Knepley 
18940967b3bSMatthew G. Knepley       if (b->field != f) continue;
19040967b3bSMatthew G. Knepley       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
19140967b3bSMatthew G. Knepley       ierr = PetscViewerASCIIPrintf(viewer, "Boundary %s (%s) %s\n", b->name, b->labelname, DMBoundaryConditionTypes[b->type]);CHKERRQ(ierr);
19240967b3bSMatthew G. Knepley       if (!b->numcomps) {
19340967b3bSMatthew G. Knepley         ierr = PetscViewerASCIIPrintf(viewer, "  all components\n");CHKERRQ(ierr);
19440967b3bSMatthew G. Knepley       } else {
19540967b3bSMatthew G. Knepley         ierr = PetscViewerASCIIPrintf(viewer, "  components: ");CHKERRQ(ierr);
19640967b3bSMatthew G. Knepley         ierr = PetscViewerASCIIUseTabs(viewer, PETSC_FALSE);CHKERRQ(ierr);
19740967b3bSMatthew G. Knepley         for (c = 0; c < b->numcomps; ++c) {
19840967b3bSMatthew G. Knepley           if (c > 0) {ierr = PetscViewerASCIIPrintf(viewer, ", ");CHKERRQ(ierr);}
19940967b3bSMatthew G. Knepley           ierr = PetscViewerASCIIPrintf(viewer, "%D", b->comps[c]);CHKERRQ(ierr);
20040967b3bSMatthew G. Knepley         }
20140967b3bSMatthew G. Knepley         ierr = PetscViewerASCIIPrintf(viewer, "\n");CHKERRQ(ierr);
20240967b3bSMatthew G. Knepley         ierr = PetscViewerASCIIUseTabs(viewer, PETSC_TRUE);CHKERRQ(ierr);
20340967b3bSMatthew G. Knepley       }
20440967b3bSMatthew G. Knepley       ierr = PetscViewerASCIIPrintf(viewer, "  ids: ");CHKERRQ(ierr);
20540967b3bSMatthew G. Knepley       ierr = PetscViewerASCIIUseTabs(viewer, PETSC_FALSE);CHKERRQ(ierr);
20640967b3bSMatthew G. Knepley       for (i = 0; i < b->numids; ++i) {
20740967b3bSMatthew G. Knepley         if (i > 0) {ierr = PetscViewerASCIIPrintf(viewer, ", ");CHKERRQ(ierr);}
20840967b3bSMatthew G. Knepley         ierr = PetscViewerASCIIPrintf(viewer, "%D", b->ids[i]);CHKERRQ(ierr);
20940967b3bSMatthew G. Knepley       }
21040967b3bSMatthew G. Knepley       ierr = PetscViewerASCIIPrintf(viewer, "\n");CHKERRQ(ierr);
21140967b3bSMatthew G. Knepley       ierr = PetscViewerASCIIUseTabs(viewer, PETSC_TRUE);CHKERRQ(ierr);
21240967b3bSMatthew G. Knepley       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
21340967b3bSMatthew G. Knepley     }
2147d8a60eaSMatthew G. Knepley   }
21597b6e6e8SMatthew G. Knepley   ierr = PetscDSGetConstants(prob, &numConstants, &constants);CHKERRQ(ierr);
21697b6e6e8SMatthew G. Knepley   if (numConstants) {
21797b6e6e8SMatthew G. Knepley     ierr = PetscViewerASCIIPrintf(viewer, "%D constants\n", numConstants);CHKERRQ(ierr);
21897b6e6e8SMatthew G. Knepley     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
21957fc01e9SMatthew G. Knepley     for (f = 0; f < numConstants; ++f) {ierr = PetscViewerASCIIPrintf(viewer, "%g\n", (double) PetscRealPart(constants[f]));CHKERRQ(ierr);}
22097b6e6e8SMatthew G. Knepley     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
22197b6e6e8SMatthew G. Knepley   }
2227d8a60eaSMatthew G. Knepley   ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
2237d8a60eaSMatthew G. Knepley   PetscFunctionReturn(0);
2247d8a60eaSMatthew G. Knepley }
2257d8a60eaSMatthew G. Knepley 
2262764a2aaSMatthew G. Knepley /*@C
2272764a2aaSMatthew G. Knepley   PetscDSView - Views a PetscDS
2282764a2aaSMatthew G. Knepley 
229*d083f849SBarry Smith   Collective on prob
2302764a2aaSMatthew G. Knepley 
2312764a2aaSMatthew G. Knepley   Input Parameter:
2322764a2aaSMatthew G. Knepley + prob - the PetscDS object to view
2332764a2aaSMatthew G. Knepley - v  - the viewer
2342764a2aaSMatthew G. Knepley 
2352764a2aaSMatthew G. Knepley   Level: developer
2362764a2aaSMatthew G. Knepley 
2372764a2aaSMatthew G. Knepley .seealso PetscDSDestroy()
2382764a2aaSMatthew G. Knepley @*/
2392764a2aaSMatthew G. Knepley PetscErrorCode PetscDSView(PetscDS prob, PetscViewer v)
2402764a2aaSMatthew G. Knepley {
2417d8a60eaSMatthew G. Knepley   PetscBool      iascii;
2422764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
2432764a2aaSMatthew G. Knepley 
2442764a2aaSMatthew G. Knepley   PetscFunctionBegin;
2452764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2462764a2aaSMatthew G. Knepley   if (!v) {ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject) prob), &v);CHKERRQ(ierr);}
2477d8a60eaSMatthew G. Knepley   else    {PetscValidHeaderSpecific(v, PETSC_VIEWER_CLASSID, 2);}
2487d8a60eaSMatthew G. Knepley   ierr = PetscObjectTypeCompare((PetscObject) v, PETSCVIEWERASCII, &iascii);CHKERRQ(ierr);
2497d8a60eaSMatthew G. Knepley   if (iascii) {ierr = PetscDSView_Ascii(prob, v);CHKERRQ(ierr);}
2502764a2aaSMatthew G. Knepley   if (prob->ops->view) {ierr = (*prob->ops->view)(prob, v);CHKERRQ(ierr);}
2512764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
2522764a2aaSMatthew G. Knepley }
2532764a2aaSMatthew G. Knepley 
2542764a2aaSMatthew G. Knepley /*@
2552764a2aaSMatthew G. Knepley   PetscDSSetFromOptions - sets parameters in a PetscDS from the options database
2562764a2aaSMatthew G. Knepley 
257*d083f849SBarry Smith   Collective on prob
2582764a2aaSMatthew G. Knepley 
2592764a2aaSMatthew G. Knepley   Input Parameter:
2602764a2aaSMatthew G. Knepley . prob - the PetscDS object to set options for
2612764a2aaSMatthew G. Knepley 
2622764a2aaSMatthew G. Knepley   Options Database:
26355c1f793SMatthew G. Knepley + -petscds_type <type>     : Set the DS type
26455c1f793SMatthew G. Knepley . -petscds_view <view opt> : View the DS
26555c1f793SMatthew G. Knepley . -petscds_jac_pre         : Turn formation of a separate Jacobian preconditioner on and off
26655c1f793SMatthew G. Knepley . -bc_<name> <ids>         : Specify a list of label ids for a boundary condition
26755c1f793SMatthew G. Knepley - -bc_<name>_comp <comps>  : Specify a list of field components to constrain for a boundary condition
2682764a2aaSMatthew G. Knepley 
2692764a2aaSMatthew G. Knepley   Level: developer
2702764a2aaSMatthew G. Knepley 
2712764a2aaSMatthew G. Knepley .seealso PetscDSView()
2722764a2aaSMatthew G. Knepley @*/
2732764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetFromOptions(PetscDS prob)
2742764a2aaSMatthew G. Knepley {
275f1fd5e65SToby Isaac   DSBoundary     b;
2762764a2aaSMatthew G. Knepley   const char    *defaultType;
2772764a2aaSMatthew G. Knepley   char           name[256];
2782764a2aaSMatthew G. Knepley   PetscBool      flg;
2792764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
2802764a2aaSMatthew G. Knepley 
2812764a2aaSMatthew G. Knepley   PetscFunctionBegin;
2822764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2832764a2aaSMatthew G. Knepley   if (!((PetscObject) prob)->type_name) {
2842764a2aaSMatthew G. Knepley     defaultType = PETSCDSBASIC;
2852764a2aaSMatthew G. Knepley   } else {
2862764a2aaSMatthew G. Knepley     defaultType = ((PetscObject) prob)->type_name;
2872764a2aaSMatthew G. Knepley   }
2880f51fdf8SToby Isaac   ierr = PetscDSRegisterAll();CHKERRQ(ierr);
2892764a2aaSMatthew G. Knepley 
2902764a2aaSMatthew G. Knepley   ierr = PetscObjectOptionsBegin((PetscObject) prob);CHKERRQ(ierr);
291f1fd5e65SToby Isaac   for (b = prob->boundary; b; b = b->next) {
292f1fd5e65SToby Isaac     char       optname[1024];
293f1fd5e65SToby Isaac     PetscInt   ids[1024], len = 1024;
294f1fd5e65SToby Isaac     PetscBool  flg;
295f1fd5e65SToby Isaac 
296f1fd5e65SToby Isaac     ierr = PetscSNPrintf(optname, sizeof(optname), "-bc_%s", b->name);CHKERRQ(ierr);
297f1fd5e65SToby Isaac     ierr = PetscMemzero(ids, sizeof(ids));CHKERRQ(ierr);
298f1fd5e65SToby Isaac     ierr = PetscOptionsIntArray(optname, "List of boundary IDs", "", ids, &len, &flg);CHKERRQ(ierr);
299f1fd5e65SToby Isaac     if (flg) {
300f1fd5e65SToby Isaac       b->numids = len;
301f1fd5e65SToby Isaac       ierr = PetscFree(b->ids);CHKERRQ(ierr);
302f1fd5e65SToby Isaac       ierr = PetscMalloc1(len, &b->ids);CHKERRQ(ierr);
303f1fd5e65SToby Isaac       ierr = PetscMemcpy(b->ids, ids, len*sizeof(PetscInt));CHKERRQ(ierr);
304f1fd5e65SToby Isaac     }
305e7b0402cSSander Arens     len = 1024;
306f1fd5e65SToby Isaac     ierr = PetscSNPrintf(optname, sizeof(optname), "-bc_%s_comp", b->name);CHKERRQ(ierr);
307f1fd5e65SToby Isaac     ierr = PetscMemzero(ids, sizeof(ids));CHKERRQ(ierr);
308f1fd5e65SToby Isaac     ierr = PetscOptionsIntArray(optname, "List of boundary field components", "", ids, &len, &flg);CHKERRQ(ierr);
309f1fd5e65SToby Isaac     if (flg) {
310f1fd5e65SToby Isaac       b->numcomps = len;
311f1fd5e65SToby Isaac       ierr = PetscFree(b->comps);CHKERRQ(ierr);
312f1fd5e65SToby Isaac       ierr = PetscMalloc1(len, &b->comps);CHKERRQ(ierr);
313f1fd5e65SToby Isaac       ierr = PetscMemcpy(b->comps, ids, len*sizeof(PetscInt));CHKERRQ(ierr);
314f1fd5e65SToby Isaac     }
315f1fd5e65SToby Isaac   }
3162764a2aaSMatthew G. Knepley   ierr = PetscOptionsFList("-petscds_type", "Discrete System", "PetscDSSetType", PetscDSList, defaultType, name, 256, &flg);CHKERRQ(ierr);
3172764a2aaSMatthew G. Knepley   if (flg) {
3182764a2aaSMatthew G. Knepley     ierr = PetscDSSetType(prob, name);CHKERRQ(ierr);
3192764a2aaSMatthew G. Knepley   } else if (!((PetscObject) prob)->type_name) {
3202764a2aaSMatthew G. Knepley     ierr = PetscDSSetType(prob, defaultType);CHKERRQ(ierr);
3212764a2aaSMatthew G. Knepley   }
32255c1f793SMatthew G. Knepley   ierr = PetscOptionsBool("-petscds_jac_pre", "Discrete System", "PetscDSUseJacobianPreconditioner", prob->useJacPre, &prob->useJacPre, &flg);CHKERRQ(ierr);
3232764a2aaSMatthew G. Knepley   if (prob->ops->setfromoptions) {ierr = (*prob->ops->setfromoptions)(prob);CHKERRQ(ierr);}
3242764a2aaSMatthew G. Knepley   /* process any options handlers added with PetscObjectAddOptionsHandler() */
3250633abcbSJed Brown   ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject) prob);CHKERRQ(ierr);
3262764a2aaSMatthew G. Knepley   ierr = PetscOptionsEnd();CHKERRQ(ierr);
3275d160056SMatthew G. Knepley   if (prob->Nf) {ierr = PetscDSViewFromOptions(prob, NULL, "-petscds_view");CHKERRQ(ierr);}
3282764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
3292764a2aaSMatthew G. Knepley }
3302764a2aaSMatthew G. Knepley 
3312764a2aaSMatthew G. Knepley /*@C
3322764a2aaSMatthew G. Knepley   PetscDSSetUp - Construct data structures for the PetscDS
3332764a2aaSMatthew G. Knepley 
334*d083f849SBarry Smith   Collective on prob
3352764a2aaSMatthew G. Knepley 
3362764a2aaSMatthew G. Knepley   Input Parameter:
3372764a2aaSMatthew G. Knepley . prob - the PetscDS object to setup
3382764a2aaSMatthew G. Knepley 
3392764a2aaSMatthew G. Knepley   Level: developer
3402764a2aaSMatthew G. Knepley 
3412764a2aaSMatthew G. Knepley .seealso PetscDSView(), PetscDSDestroy()
3422764a2aaSMatthew G. Knepley @*/
3432764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetUp(PetscDS prob)
3442764a2aaSMatthew G. Knepley {
3452764a2aaSMatthew G. Knepley   const PetscInt Nf = prob->Nf;
3464bee2e38SMatthew G. Knepley   PetscInt       dim, dimEmbed, NbMax = 0, NcMax = 0, NqMax = 0, NsMax = 1, f;
3472764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
3482764a2aaSMatthew G. Knepley 
3492764a2aaSMatthew G. Knepley   PetscFunctionBegin;
3502764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
3512764a2aaSMatthew G. Knepley   if (prob->setup) PetscFunctionReturn(0);
3522764a2aaSMatthew G. Knepley   /* Calculate sizes */
3532764a2aaSMatthew G. Knepley   ierr = PetscDSGetSpatialDimension(prob, &dim);CHKERRQ(ierr);
354d1506c7cSMatthew G. Knepley   ierr = PetscDSGetCoordinateDimension(prob, &dimEmbed);CHKERRQ(ierr);
355f744cafaSSander Arens   prob->totDim = prob->totComp = 0;
35647e57110SSander Arens   ierr = PetscMalloc2(Nf,&prob->Nc,Nf,&prob->Nb);CHKERRQ(ierr);
357f744cafaSSander Arens   ierr = PetscCalloc2(Nf+1,&prob->off,Nf+1,&prob->offDer);CHKERRQ(ierr);
358f744cafaSSander Arens   ierr = PetscMalloc4(Nf,&prob->basis,Nf,&prob->basisDer,Nf,&prob->basisFace,Nf,&prob->basisDerFace);CHKERRQ(ierr);
3592764a2aaSMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
3609de99aefSMatthew G. Knepley     PetscObject     obj;
3619de99aefSMatthew G. Knepley     PetscClassId    id;
3622764a2aaSMatthew G. Knepley     PetscQuadrature q;
3639de99aefSMatthew G. Knepley     PetscInt        Nq = 0, Nb, Nc;
3642764a2aaSMatthew G. Knepley 
3659de99aefSMatthew G. Knepley     ierr = PetscDSGetDiscretization(prob, f, &obj);CHKERRQ(ierr);
3669de99aefSMatthew G. Knepley     ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr);
3679de99aefSMatthew G. Knepley     if (id == PETSCFE_CLASSID)      {
3689de99aefSMatthew G. Knepley       PetscFE fe = (PetscFE) obj;
3699de99aefSMatthew G. Knepley 
3702764a2aaSMatthew G. Knepley       ierr = PetscFEGetQuadrature(fe, &q);CHKERRQ(ierr);
3712764a2aaSMatthew G. Knepley       ierr = PetscFEGetDimension(fe, &Nb);CHKERRQ(ierr);
3722764a2aaSMatthew G. Knepley       ierr = PetscFEGetNumComponents(fe, &Nc);CHKERRQ(ierr);
3732764a2aaSMatthew G. Knepley       ierr = PetscFEGetDefaultTabulation(fe, &prob->basis[f], &prob->basisDer[f], NULL);CHKERRQ(ierr);
3744d0b9603SSander Arens       ierr = PetscFEGetFaceTabulation(fe, &prob->basisFace[f], &prob->basisDerFace[f], NULL);CHKERRQ(ierr);
3759de99aefSMatthew G. Knepley     } else if (id == PETSCFV_CLASSID) {
3769de99aefSMatthew G. Knepley       PetscFV fv = (PetscFV) obj;
3779de99aefSMatthew G. Knepley 
3789de99aefSMatthew G. Knepley       ierr = PetscFVGetQuadrature(fv, &q);CHKERRQ(ierr);
3799de99aefSMatthew G. Knepley       ierr = PetscFVGetNumComponents(fv, &Nc);CHKERRQ(ierr);
3809c3cf19fSMatthew G. Knepley       Nb   = Nc;
3816c1a3d01SMatthew G. Knepley       ierr = PetscFVGetDefaultTabulation(fv, &prob->basis[f], &prob->basisDer[f], NULL);CHKERRQ(ierr);
3824d0b9603SSander Arens       /* TODO: should PetscFV also have face tabulation? Otherwise there will be a null pointer in prob->basisFace */
383abac5ca0SMatthew G. Knepley     } else SETERRQ1(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Unknown discretization type for field %d", f);
38447e57110SSander Arens     prob->Nc[f]       = Nc;
38547e57110SSander Arens     prob->Nb[f]       = Nb;
386194d53e6SMatthew G. Knepley     prob->off[f+1]    = Nc     + prob->off[f];
387194d53e6SMatthew G. Knepley     prob->offDer[f+1] = Nc*dim + prob->offDer[f];
388a6b92713SMatthew G. Knepley     if (q) {ierr = PetscQuadratureGetData(q, NULL, NULL, &Nq, NULL, NULL);CHKERRQ(ierr);}
3892764a2aaSMatthew G. Knepley     NqMax          = PetscMax(NqMax, Nq);
3904bee2e38SMatthew G. Knepley     NbMax          = PetscMax(NbMax, Nb);
3912764a2aaSMatthew G. Knepley     NcMax          = PetscMax(NcMax, Nc);
3929c3cf19fSMatthew G. Knepley     prob->totDim  += Nb;
3932764a2aaSMatthew G. Knepley     prob->totComp += Nc;
39494a5e212SMatthew G. Knepley     /* There are two faces for all fields but the cohesive field on a hybrid cell */
39594a5e212SMatthew G. Knepley     if (prob->isHybrid && (f < Nf-1)) prob->totDim += Nb;
3962764a2aaSMatthew G. Knepley   }
3972764a2aaSMatthew G. Knepley   /* Allocate works space */
39894a5e212SMatthew G. Knepley   if (prob->isHybrid) NsMax = 2;
3994bee2e38SMatthew G. Knepley   ierr = PetscMalloc3(NsMax*prob->totComp,&prob->u,NsMax*prob->totComp,&prob->u_t,NsMax*prob->totComp*dimEmbed,&prob->u_x);CHKERRQ(ierr);
4004bee2e38SMatthew 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);
40194a5e212SMatthew G. Knepley   ierr = PetscMalloc6(NsMax*NqMax*NcMax,&prob->f0,NsMax*NqMax*NcMax*dim,&prob->f1,
40294a5e212SMatthew G. Knepley                       NsMax*NsMax*NqMax*NcMax*NcMax,&prob->g0,NsMax*NsMax*NqMax*NcMax*NcMax*dim,&prob->g1,
40394a5e212SMatthew G. Knepley                       NsMax*NsMax*NqMax*NcMax*NcMax*dim,&prob->g2,NsMax*NsMax*NqMax*NcMax*NcMax*dim*dim,&prob->g3);CHKERRQ(ierr);
4042764a2aaSMatthew G. Knepley   if (prob->ops->setup) {ierr = (*prob->ops->setup)(prob);CHKERRQ(ierr);}
4052764a2aaSMatthew G. Knepley   prob->setup = PETSC_TRUE;
4062764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
4072764a2aaSMatthew G. Knepley }
4082764a2aaSMatthew G. Knepley 
4092764a2aaSMatthew G. Knepley static PetscErrorCode PetscDSDestroyStructs_Static(PetscDS prob)
4102764a2aaSMatthew G. Knepley {
4112764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
4122764a2aaSMatthew G. Knepley 
4132764a2aaSMatthew G. Knepley   PetscFunctionBegin;
41447e57110SSander Arens   ierr = PetscFree2(prob->Nc,prob->Nb);CHKERRQ(ierr);
415f744cafaSSander Arens   ierr = PetscFree2(prob->off,prob->offDer);CHKERRQ(ierr);
416f744cafaSSander Arens   ierr = PetscFree4(prob->basis,prob->basisDer,prob->basisFace,prob->basisDerFace);CHKERRQ(ierr);
4174bee2e38SMatthew G. Knepley   ierr = PetscFree3(prob->u,prob->u_t,prob->u_x);CHKERRQ(ierr);
4184bee2e38SMatthew G. Knepley   ierr = PetscFree5(prob->x,prob->basisReal, prob->basisDerReal,prob->testReal,prob->testDerReal);CHKERRQ(ierr);
4192764a2aaSMatthew G. Knepley   ierr = PetscFree6(prob->f0,prob->f1,prob->g0,prob->g1,prob->g2,prob->g3);CHKERRQ(ierr);
4202764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
4212764a2aaSMatthew G. Knepley }
4222764a2aaSMatthew G. Knepley 
4232764a2aaSMatthew G. Knepley static PetscErrorCode PetscDSEnlarge_Static(PetscDS prob, PetscInt NfNew)
4242764a2aaSMatthew G. Knepley {
425f744cafaSSander Arens   PetscObject      *tmpd;
42634aa8a36SMatthew G. Knepley   PetscBool        *tmpi;
42732d2bbc9SMatthew G. Knepley   PetscPointFunc   *tmpobj, *tmpf, *tmpup;
428b7e05686SMatthew G. Knepley   PetscPointJac    *tmpg, *tmpgp, *tmpgt;
4292aa1fc23SMatthew G. Knepley   PetscBdPointFunc *tmpfbd;
4302aa1fc23SMatthew G. Knepley   PetscBdPointJac  *tmpgbd;
431194d53e6SMatthew G. Knepley   PetscRiemannFunc *tmpr;
432c371a6d1SMatthew G. Knepley   PetscSimplePointFunc *tmpexactSol;
43395cbbfd3SMatthew G. Knepley   void                **tmpexactCtx;
4340c2f2876SMatthew G. Knepley   void            **tmpctx;
43534aa8a36SMatthew G. Knepley   PetscInt          Nf = prob->Nf, f;
4362764a2aaSMatthew G. Knepley   PetscErrorCode    ierr;
4372764a2aaSMatthew G. Knepley 
4382764a2aaSMatthew G. Knepley   PetscFunctionBegin;
4392764a2aaSMatthew G. Knepley   if (Nf >= NfNew) PetscFunctionReturn(0);
4402764a2aaSMatthew G. Knepley   prob->setup = PETSC_FALSE;
4412764a2aaSMatthew G. Knepley   ierr = PetscDSDestroyStructs_Static(prob);CHKERRQ(ierr);
44234aa8a36SMatthew G. Knepley   ierr = PetscMalloc2(NfNew, &tmpd, NfNew, &tmpi);CHKERRQ(ierr);
44334aa8a36SMatthew G. Knepley   for (f = 0; f < Nf; ++f) {tmpd[f] = prob->disc[f]; tmpi[f] = prob->implicit[f];}
44434aa8a36SMatthew G. Knepley   for (f = Nf; f < NfNew; ++f) {tmpd[f] = NULL; tmpi[f] = PETSC_TRUE;}
44534aa8a36SMatthew G. Knepley   ierr = PetscFree2(prob->disc, prob->implicit);CHKERRQ(ierr);
4462764a2aaSMatthew G. Knepley   prob->Nf        = NfNew;
4472764a2aaSMatthew G. Knepley   prob->disc      = tmpd;
448249df284SMatthew G. Knepley   prob->implicit  = tmpi;
449b7e05686SMatthew 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);
45032d2bbc9SMatthew G. Knepley   ierr = PetscCalloc1(NfNew, &tmpup);CHKERRQ(ierr);
4512764a2aaSMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpobj[f] = prob->obj[f];
4522764a2aaSMatthew G. Knepley   for (f = 0; f < Nf*2; ++f) tmpf[f] = prob->f[f];
4532764a2aaSMatthew G. Knepley   for (f = 0; f < Nf*Nf*4; ++f) tmpg[f] = prob->g[f];
454475e0ac9SMatthew G. Knepley   for (f = 0; f < Nf*Nf*4; ++f) tmpgp[f] = prob->gp[f];
4550c2f2876SMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpr[f] = prob->r[f];
45632d2bbc9SMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpup[f] = prob->update[f];
4570c2f2876SMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpctx[f] = prob->ctx[f];
4582764a2aaSMatthew G. Knepley   for (f = Nf; f < NfNew; ++f) tmpobj[f] = NULL;
4592764a2aaSMatthew G. Knepley   for (f = Nf*2; f < NfNew*2; ++f) tmpf[f] = NULL;
4602764a2aaSMatthew G. Knepley   for (f = Nf*Nf*4; f < NfNew*NfNew*4; ++f) tmpg[f] = NULL;
461475e0ac9SMatthew G. Knepley   for (f = Nf*Nf*4; f < NfNew*NfNew*4; ++f) tmpgp[f] = NULL;
462b7e05686SMatthew G. Knepley   for (f = Nf*Nf*4; f < NfNew*NfNew*4; ++f) tmpgt[f] = NULL;
4630c2f2876SMatthew G. Knepley   for (f = Nf; f < NfNew; ++f) tmpr[f] = NULL;
46432d2bbc9SMatthew G. Knepley   for (f = Nf; f < NfNew; ++f) tmpup[f] = NULL;
4650c2f2876SMatthew G. Knepley   for (f = Nf; f < NfNew; ++f) tmpctx[f] = NULL;
466b7e05686SMatthew G. Knepley   ierr = PetscFree7(prob->obj, prob->f, prob->g, prob->gp, prob->gt, prob->r, prob->ctx);CHKERRQ(ierr);
46732d2bbc9SMatthew G. Knepley   ierr = PetscFree(prob->update);CHKERRQ(ierr);
4682764a2aaSMatthew G. Knepley   prob->obj = tmpobj;
4692764a2aaSMatthew G. Knepley   prob->f   = tmpf;
4702764a2aaSMatthew G. Knepley   prob->g   = tmpg;
471475e0ac9SMatthew G. Knepley   prob->gp  = tmpgp;
472b7e05686SMatthew G. Knepley   prob->gt  = tmpgt;
4730c2f2876SMatthew G. Knepley   prob->r   = tmpr;
47432d2bbc9SMatthew G. Knepley   prob->update = tmpup;
4750c2f2876SMatthew G. Knepley   prob->ctx = tmpctx;
47695cbbfd3SMatthew G. Knepley   ierr = PetscCalloc4(NfNew*2, &tmpfbd, NfNew*NfNew*4, &tmpgbd, NfNew, &tmpexactSol, NfNew, &tmpexactCtx);CHKERRQ(ierr);
4772764a2aaSMatthew G. Knepley   for (f = 0; f < Nf*2; ++f) tmpfbd[f] = prob->fBd[f];
4782764a2aaSMatthew G. Knepley   for (f = 0; f < Nf*Nf*4; ++f) tmpgbd[f] = prob->gBd[f];
479c371a6d1SMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpexactSol[f] = prob->exactSol[f];
48095cbbfd3SMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpexactCtx[f] = prob->exactCtx[f];
4812764a2aaSMatthew G. Knepley   for (f = Nf*2; f < NfNew*2; ++f) tmpfbd[f] = NULL;
4822764a2aaSMatthew G. Knepley   for (f = Nf*Nf*4; f < NfNew*NfNew*4; ++f) tmpgbd[f] = NULL;
483c371a6d1SMatthew G. Knepley   for (f = Nf; f < NfNew; ++f) tmpexactSol[f] = NULL;
48495cbbfd3SMatthew G. Knepley   for (f = Nf; f < NfNew; ++f) tmpexactCtx[f] = NULL;
48595cbbfd3SMatthew G. Knepley   ierr = PetscFree4(prob->fBd, prob->gBd, prob->exactSol, prob->exactCtx);CHKERRQ(ierr);
4862764a2aaSMatthew G. Knepley   prob->fBd = tmpfbd;
4872764a2aaSMatthew G. Knepley   prob->gBd = tmpgbd;
488c371a6d1SMatthew G. Knepley   prob->exactSol = tmpexactSol;
48995cbbfd3SMatthew G. Knepley   prob->exactCtx = tmpexactCtx;
4902764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
4912764a2aaSMatthew G. Knepley }
4922764a2aaSMatthew G. Knepley 
4932764a2aaSMatthew G. Knepley /*@
4942764a2aaSMatthew G. Knepley   PetscDSDestroy - Destroys a PetscDS object
4952764a2aaSMatthew G. Knepley 
496*d083f849SBarry Smith   Collective on prob
4972764a2aaSMatthew G. Knepley 
4982764a2aaSMatthew G. Knepley   Input Parameter:
4992764a2aaSMatthew G. Knepley . prob - the PetscDS object to destroy
5002764a2aaSMatthew G. Knepley 
5012764a2aaSMatthew G. Knepley   Level: developer
5022764a2aaSMatthew G. Knepley 
5032764a2aaSMatthew G. Knepley .seealso PetscDSView()
5042764a2aaSMatthew G. Knepley @*/
5052764a2aaSMatthew G. Knepley PetscErrorCode PetscDSDestroy(PetscDS *prob)
5062764a2aaSMatthew G. Knepley {
5072764a2aaSMatthew G. Knepley   PetscInt       f;
50858ebd649SToby Isaac   DSBoundary     next;
5092764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
5102764a2aaSMatthew G. Knepley 
5112764a2aaSMatthew G. Knepley   PetscFunctionBegin;
5122764a2aaSMatthew G. Knepley   if (!*prob) PetscFunctionReturn(0);
5132764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific((*prob), PETSCDS_CLASSID, 1);
5142764a2aaSMatthew G. Knepley 
5152764a2aaSMatthew G. Knepley   if (--((PetscObject)(*prob))->refct > 0) {*prob = 0; PetscFunctionReturn(0);}
5162764a2aaSMatthew G. Knepley   ((PetscObject) (*prob))->refct = 0;
517df3a45bdSMatthew G. Knepley   if ((*prob)->subprobs) {
518df3a45bdSMatthew G. Knepley     PetscInt dim, d;
519df3a45bdSMatthew G. Knepley 
520df3a45bdSMatthew G. Knepley     ierr = PetscDSGetSpatialDimension(*prob, &dim);CHKERRQ(ierr);
521df3a45bdSMatthew G. Knepley     for (d = 0; d < dim; ++d) {ierr = PetscDSDestroy(&(*prob)->subprobs[d]);CHKERRQ(ierr);}
522df3a45bdSMatthew G. Knepley   }
523df3a45bdSMatthew G. Knepley   ierr = PetscFree((*prob)->subprobs);CHKERRQ(ierr);
5242764a2aaSMatthew G. Knepley   ierr = PetscDSDestroyStructs_Static(*prob);CHKERRQ(ierr);
5252764a2aaSMatthew G. Knepley   for (f = 0; f < (*prob)->Nf; ++f) {
5262764a2aaSMatthew G. Knepley     ierr = PetscObjectDereference((*prob)->disc[f]);CHKERRQ(ierr);
5272764a2aaSMatthew G. Knepley   }
52834aa8a36SMatthew G. Knepley   ierr = PetscFree2((*prob)->disc, (*prob)->implicit);CHKERRQ(ierr);
529b7e05686SMatthew G. Knepley   ierr = PetscFree7((*prob)->obj,(*prob)->f,(*prob)->g,(*prob)->gp,(*prob)->gt,(*prob)->r,(*prob)->ctx);CHKERRQ(ierr);
53032d2bbc9SMatthew G. Knepley   ierr = PetscFree((*prob)->update);CHKERRQ(ierr);
53195cbbfd3SMatthew G. Knepley   ierr = PetscFree4((*prob)->fBd,(*prob)->gBd,(*prob)->exactSol,(*prob)->exactCtx);CHKERRQ(ierr);
5322764a2aaSMatthew G. Knepley   if ((*prob)->ops->destroy) {ierr = (*(*prob)->ops->destroy)(*prob);CHKERRQ(ierr);}
53358ebd649SToby Isaac   next = (*prob)->boundary;
53458ebd649SToby Isaac   while (next) {
53558ebd649SToby Isaac     DSBoundary b = next;
53658ebd649SToby Isaac 
53758ebd649SToby Isaac     next = b->next;
53858ebd649SToby Isaac     ierr = PetscFree(b->comps);CHKERRQ(ierr);
53958ebd649SToby Isaac     ierr = PetscFree(b->ids);CHKERRQ(ierr);
54058ebd649SToby Isaac     ierr = PetscFree(b->name);CHKERRQ(ierr);
54158ebd649SToby Isaac     ierr = PetscFree(b->labelname);CHKERRQ(ierr);
54258ebd649SToby Isaac     ierr = PetscFree(b);CHKERRQ(ierr);
54358ebd649SToby Isaac   }
54497b6e6e8SMatthew G. Knepley   ierr = PetscFree((*prob)->constants);CHKERRQ(ierr);
5452764a2aaSMatthew G. Knepley   ierr = PetscHeaderDestroy(prob);CHKERRQ(ierr);
5462764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
5472764a2aaSMatthew G. Knepley }
5482764a2aaSMatthew G. Knepley 
5492764a2aaSMatthew G. Knepley /*@
5502764a2aaSMatthew G. Knepley   PetscDSCreate - Creates an empty PetscDS object. The type can then be set with PetscDSSetType().
5512764a2aaSMatthew G. Knepley 
552*d083f849SBarry Smith   Collective
5532764a2aaSMatthew G. Knepley 
5542764a2aaSMatthew G. Knepley   Input Parameter:
5552764a2aaSMatthew G. Knepley . comm - The communicator for the PetscDS object
5562764a2aaSMatthew G. Knepley 
5572764a2aaSMatthew G. Knepley   Output Parameter:
5582764a2aaSMatthew G. Knepley . prob - The PetscDS object
5592764a2aaSMatthew G. Knepley 
5602764a2aaSMatthew G. Knepley   Level: beginner
5612764a2aaSMatthew G. Knepley 
5622764a2aaSMatthew G. Knepley .seealso: PetscDSSetType(), PETSCDSBASIC
5632764a2aaSMatthew G. Knepley @*/
5642764a2aaSMatthew G. Knepley PetscErrorCode PetscDSCreate(MPI_Comm comm, PetscDS *prob)
5652764a2aaSMatthew G. Knepley {
5662764a2aaSMatthew G. Knepley   PetscDS   p;
5672764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
5682764a2aaSMatthew G. Knepley 
5692764a2aaSMatthew G. Knepley   PetscFunctionBegin;
5702764a2aaSMatthew G. Knepley   PetscValidPointer(prob, 2);
5712764a2aaSMatthew G. Knepley   *prob  = NULL;
5722764a2aaSMatthew G. Knepley   ierr = PetscDSInitializePackage();CHKERRQ(ierr);
5732764a2aaSMatthew G. Knepley 
57473107ff1SLisandro Dalcin   ierr = PetscHeaderCreate(p, PETSCDS_CLASSID, "PetscDS", "Discrete System", "PetscDS", comm, PetscDSDestroy, PetscDSView);CHKERRQ(ierr);
5752764a2aaSMatthew G. Knepley 
5762764a2aaSMatthew G. Knepley   p->Nf           = 0;
5772764a2aaSMatthew G. Knepley   p->setup        = PETSC_FALSE;
57897b6e6e8SMatthew G. Knepley   p->numConstants = 0;
57997b6e6e8SMatthew G. Knepley   p->constants    = NULL;
580a859676bSMatthew G. Knepley   p->dimEmbed     = -1;
58155c1f793SMatthew G. Knepley   p->useJacPre    = PETSC_TRUE;
5822764a2aaSMatthew G. Knepley 
5832764a2aaSMatthew G. Knepley   *prob = p;
5842764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
5852764a2aaSMatthew G. Knepley }
5862764a2aaSMatthew G. Knepley 
587bc4ae4beSMatthew G. Knepley /*@
588bc4ae4beSMatthew G. Knepley   PetscDSGetNumFields - Returns the number of fields in the DS
589bc4ae4beSMatthew G. Knepley 
590bc4ae4beSMatthew G. Knepley   Not collective
591bc4ae4beSMatthew G. Knepley 
592bc4ae4beSMatthew G. Knepley   Input Parameter:
593bc4ae4beSMatthew G. Knepley . prob - The PetscDS object
594bc4ae4beSMatthew G. Knepley 
595bc4ae4beSMatthew G. Knepley   Output Parameter:
596bc4ae4beSMatthew G. Knepley . Nf - The number of fields
597bc4ae4beSMatthew G. Knepley 
598bc4ae4beSMatthew G. Knepley   Level: beginner
599bc4ae4beSMatthew G. Knepley 
600bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetSpatialDimension(), PetscDSCreate()
601bc4ae4beSMatthew G. Knepley @*/
6022764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetNumFields(PetscDS prob, PetscInt *Nf)
6032764a2aaSMatthew G. Knepley {
6042764a2aaSMatthew G. Knepley   PetscFunctionBegin;
6052764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
6062764a2aaSMatthew G. Knepley   PetscValidPointer(Nf, 2);
6072764a2aaSMatthew G. Knepley   *Nf = prob->Nf;
6082764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
6092764a2aaSMatthew G. Knepley }
6102764a2aaSMatthew G. Knepley 
611bc4ae4beSMatthew G. Knepley /*@
612a859676bSMatthew G. Knepley   PetscDSGetSpatialDimension - Returns the spatial dimension of the DS, meaning the topological dimension of the discretizations
613bc4ae4beSMatthew G. Knepley 
614bc4ae4beSMatthew G. Knepley   Not collective
615bc4ae4beSMatthew G. Knepley 
616bc4ae4beSMatthew G. Knepley   Input Parameter:
617bc4ae4beSMatthew G. Knepley . prob - The PetscDS object
618bc4ae4beSMatthew G. Knepley 
619bc4ae4beSMatthew G. Knepley   Output Parameter:
620bc4ae4beSMatthew G. Knepley . dim - The spatial dimension
621bc4ae4beSMatthew G. Knepley 
622bc4ae4beSMatthew G. Knepley   Level: beginner
623bc4ae4beSMatthew G. Knepley 
624a859676bSMatthew G. Knepley .seealso: PetscDSGetCoordinateDimension(), PetscDSGetNumFields(), PetscDSCreate()
625bc4ae4beSMatthew G. Knepley @*/
6262764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetSpatialDimension(PetscDS prob, PetscInt *dim)
6272764a2aaSMatthew G. Knepley {
6282764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
6292764a2aaSMatthew G. Knepley 
6302764a2aaSMatthew G. Knepley   PetscFunctionBegin;
6312764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
6322764a2aaSMatthew G. Knepley   PetscValidPointer(dim, 2);
6332764a2aaSMatthew G. Knepley   *dim = 0;
6349de99aefSMatthew G. Knepley   if (prob->Nf) {
6359de99aefSMatthew G. Knepley     PetscObject  obj;
6369de99aefSMatthew G. Knepley     PetscClassId id;
6379de99aefSMatthew G. Knepley 
6389de99aefSMatthew G. Knepley     ierr = PetscDSGetDiscretization(prob, 0, &obj);CHKERRQ(ierr);
6399de99aefSMatthew G. Knepley     ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr);
6409de99aefSMatthew G. Knepley     if (id == PETSCFE_CLASSID)      {ierr = PetscFEGetSpatialDimension((PetscFE) obj, dim);CHKERRQ(ierr);}
6419de99aefSMatthew G. Knepley     else if (id == PETSCFV_CLASSID) {ierr = PetscFVGetSpatialDimension((PetscFV) obj, dim);CHKERRQ(ierr);}
6429de99aefSMatthew G. Knepley     else SETERRQ1(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Unknown discretization type for field %d", 0);
6439de99aefSMatthew G. Knepley   }
6442764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
6452764a2aaSMatthew G. Knepley }
6462764a2aaSMatthew G. Knepley 
647bc4ae4beSMatthew G. Knepley /*@
648a859676bSMatthew G. Knepley   PetscDSGetCoordinateDimension - Returns the coordinate dimension of the DS, meaning the dimension of the space into which the discretiaztions are embedded
649a859676bSMatthew G. Knepley 
650a859676bSMatthew G. Knepley   Not collective
651a859676bSMatthew G. Knepley 
652a859676bSMatthew G. Knepley   Input Parameter:
653a859676bSMatthew G. Knepley . prob - The PetscDS object
654a859676bSMatthew G. Knepley 
655a859676bSMatthew G. Knepley   Output Parameter:
656a859676bSMatthew G. Knepley . dimEmbed - The coordinate dimension
657a859676bSMatthew G. Knepley 
658a859676bSMatthew G. Knepley   Level: beginner
659a859676bSMatthew G. Knepley 
660a859676bSMatthew G. Knepley .seealso: PetscDSSetCoordinateDimension(), PetscDSGetSpatialDimension(), PetscDSGetNumFields(), PetscDSCreate()
661a859676bSMatthew G. Knepley @*/
662a859676bSMatthew G. Knepley PetscErrorCode PetscDSGetCoordinateDimension(PetscDS prob, PetscInt *dimEmbed)
663a859676bSMatthew G. Knepley {
664a859676bSMatthew G. Knepley   PetscFunctionBegin;
665a859676bSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
666a859676bSMatthew G. Knepley   PetscValidPointer(dimEmbed, 2);
667a859676bSMatthew G. Knepley   if (prob->dimEmbed < 0) SETERRQ(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONGSTATE, "No coordinate dimension set for this DS");
668a859676bSMatthew G. Knepley   *dimEmbed = prob->dimEmbed;
669a859676bSMatthew G. Knepley   PetscFunctionReturn(0);
670a859676bSMatthew G. Knepley }
671a859676bSMatthew G. Knepley 
672a859676bSMatthew G. Knepley /*@
673a859676bSMatthew G. Knepley   PetscDSSetCoordinateDimension - Set the coordinate dimension of the DS, meaning the dimension of the space into which the discretiaztions are embedded
674a859676bSMatthew G. Knepley 
675*d083f849SBarry Smith   Logically collective on prob
676a859676bSMatthew G. Knepley 
677a859676bSMatthew G. Knepley   Input Parameters:
678a859676bSMatthew G. Knepley + prob - The PetscDS object
679a859676bSMatthew G. Knepley - dimEmbed - The coordinate dimension
680a859676bSMatthew G. Knepley 
681a859676bSMatthew G. Knepley   Level: beginner
682a859676bSMatthew G. Knepley 
683a859676bSMatthew G. Knepley .seealso: PetscDSGetCoordinateDimension(), PetscDSGetSpatialDimension(), PetscDSGetNumFields(), PetscDSCreate()
684a859676bSMatthew G. Knepley @*/
685a859676bSMatthew G. Knepley PetscErrorCode PetscDSSetCoordinateDimension(PetscDS prob, PetscInt dimEmbed)
686a859676bSMatthew G. Knepley {
687a859676bSMatthew G. Knepley   PetscFunctionBegin;
688a859676bSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
689ebfe4b0dSMatthew G. Knepley   if (dimEmbed < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Coordinate dimension must be non-negative, not %D", dimEmbed);
690a859676bSMatthew G. Knepley   prob->dimEmbed = dimEmbed;
691a859676bSMatthew G. Knepley   PetscFunctionReturn(0);
692a859676bSMatthew G. Knepley }
693a859676bSMatthew G. Knepley 
694a859676bSMatthew G. Knepley /*@
6958edf6225SMatthew G. Knepley   PetscDSGetHybrid - Returns the flag for a hybrid (cohesive) cell
6968edf6225SMatthew G. Knepley 
6978edf6225SMatthew G. Knepley   Not collective
6988edf6225SMatthew G. Knepley 
6998edf6225SMatthew G. Knepley   Input Parameter:
7008edf6225SMatthew G. Knepley . prob - The PetscDS object
7018edf6225SMatthew G. Knepley 
7028edf6225SMatthew G. Knepley   Output Parameter:
7038edf6225SMatthew G. Knepley . isHybrid - The flag
7048edf6225SMatthew G. Knepley 
7058edf6225SMatthew G. Knepley   Level: developer
7068edf6225SMatthew G. Knepley 
7078edf6225SMatthew G. Knepley .seealso: PetscDSSetHybrid(), PetscDSCreate()
7088edf6225SMatthew G. Knepley @*/
7098edf6225SMatthew G. Knepley PetscErrorCode PetscDSGetHybrid(PetscDS prob, PetscBool *isHybrid)
7108edf6225SMatthew G. Knepley {
7118edf6225SMatthew G. Knepley   PetscFunctionBegin;
7128edf6225SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
7138edf6225SMatthew G. Knepley   PetscValidPointer(isHybrid, 2);
7148edf6225SMatthew G. Knepley   *isHybrid = prob->isHybrid;
7158edf6225SMatthew G. Knepley   PetscFunctionReturn(0);
7168edf6225SMatthew G. Knepley }
7178edf6225SMatthew G. Knepley 
7188edf6225SMatthew G. Knepley /*@
7198edf6225SMatthew G. Knepley   PetscDSSetHybrid - Set the flag for a hybrid (cohesive) cell
7208edf6225SMatthew G. Knepley 
7218edf6225SMatthew G. Knepley   Not collective
7228edf6225SMatthew G. Knepley 
7238edf6225SMatthew G. Knepley   Input Parameters:
7248edf6225SMatthew G. Knepley + prob - The PetscDS object
7258edf6225SMatthew G. Knepley - isHybrid - The flag
7268edf6225SMatthew G. Knepley 
7278edf6225SMatthew G. Knepley   Level: developer
7288edf6225SMatthew G. Knepley 
7298edf6225SMatthew G. Knepley .seealso: PetscDSGetHybrid(), PetscDSCreate()
7308edf6225SMatthew G. Knepley @*/
7318edf6225SMatthew G. Knepley PetscErrorCode PetscDSSetHybrid(PetscDS prob, PetscBool isHybrid)
7328edf6225SMatthew G. Knepley {
7338edf6225SMatthew G. Knepley   PetscFunctionBegin;
7348edf6225SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
7358edf6225SMatthew G. Knepley   prob->isHybrid = isHybrid;
7368edf6225SMatthew G. Knepley   PetscFunctionReturn(0);
7378edf6225SMatthew G. Knepley }
7388edf6225SMatthew G. Knepley 
7398edf6225SMatthew G. Knepley /*@
740bc4ae4beSMatthew G. Knepley   PetscDSGetTotalDimension - Returns the total size of the approximation space for this system
741bc4ae4beSMatthew G. Knepley 
742bc4ae4beSMatthew G. Knepley   Not collective
743bc4ae4beSMatthew G. Knepley 
744bc4ae4beSMatthew G. Knepley   Input Parameter:
745bc4ae4beSMatthew G. Knepley . prob - The PetscDS object
746bc4ae4beSMatthew G. Knepley 
747bc4ae4beSMatthew G. Knepley   Output Parameter:
748bc4ae4beSMatthew G. Knepley . dim - The total problem dimension
749bc4ae4beSMatthew G. Knepley 
750bc4ae4beSMatthew G. Knepley   Level: beginner
751bc4ae4beSMatthew G. Knepley 
752bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetNumFields(), PetscDSCreate()
753bc4ae4beSMatthew G. Knepley @*/
7542764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetTotalDimension(PetscDS prob, PetscInt *dim)
7552764a2aaSMatthew G. Knepley {
7562764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
7572764a2aaSMatthew G. Knepley 
7582764a2aaSMatthew G. Knepley   PetscFunctionBegin;
7592764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
7602764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
7612764a2aaSMatthew G. Knepley   PetscValidPointer(dim, 2);
7622764a2aaSMatthew G. Knepley   *dim = prob->totDim;
7632764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
7642764a2aaSMatthew G. Knepley }
7652764a2aaSMatthew G. Knepley 
766bc4ae4beSMatthew G. Knepley /*@
767bc4ae4beSMatthew G. Knepley   PetscDSGetTotalComponents - Returns the total number of components in this system
768bc4ae4beSMatthew G. Knepley 
769bc4ae4beSMatthew G. Knepley   Not collective
770bc4ae4beSMatthew G. Knepley 
771bc4ae4beSMatthew G. Knepley   Input Parameter:
772bc4ae4beSMatthew G. Knepley . prob - The PetscDS object
773bc4ae4beSMatthew G. Knepley 
774bc4ae4beSMatthew G. Knepley   Output Parameter:
775bc4ae4beSMatthew G. Knepley . dim - The total number of components
776bc4ae4beSMatthew G. Knepley 
777bc4ae4beSMatthew G. Knepley   Level: beginner
778bc4ae4beSMatthew G. Knepley 
779bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetNumFields(), PetscDSCreate()
780bc4ae4beSMatthew G. Knepley @*/
7812764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetTotalComponents(PetscDS prob, PetscInt *Nc)
7822764a2aaSMatthew G. Knepley {
7832764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
7842764a2aaSMatthew G. Knepley 
7852764a2aaSMatthew G. Knepley   PetscFunctionBegin;
7862764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
7872764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
7882764a2aaSMatthew G. Knepley   PetscValidPointer(Nc, 2);
7892764a2aaSMatthew G. Knepley   *Nc = prob->totComp;
7902764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
7912764a2aaSMatthew G. Knepley }
7922764a2aaSMatthew G. Knepley 
793bc4ae4beSMatthew G. Knepley /*@
794bc4ae4beSMatthew G. Knepley   PetscDSGetDiscretization - Returns the discretization object for the given field
795bc4ae4beSMatthew G. Knepley 
796bc4ae4beSMatthew G. Knepley   Not collective
797bc4ae4beSMatthew G. Knepley 
798bc4ae4beSMatthew G. Knepley   Input Parameters:
799bc4ae4beSMatthew G. Knepley + prob - The PetscDS object
800bc4ae4beSMatthew G. Knepley - f - The field number
801bc4ae4beSMatthew G. Knepley 
802bc4ae4beSMatthew G. Knepley   Output Parameter:
803bc4ae4beSMatthew G. Knepley . disc - The discretization object
804bc4ae4beSMatthew G. Knepley 
805bc4ae4beSMatthew G. Knepley   Level: beginner
806bc4ae4beSMatthew G. Knepley 
807f744cafaSSander Arens .seealso: PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
808bc4ae4beSMatthew G. Knepley @*/
8092764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetDiscretization(PetscDS prob, PetscInt f, PetscObject *disc)
8102764a2aaSMatthew G. Knepley {
8112764a2aaSMatthew G. Knepley   PetscFunctionBegin;
8122764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
8132764a2aaSMatthew G. Knepley   PetscValidPointer(disc, 3);
8142764a2aaSMatthew 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);
8152764a2aaSMatthew G. Knepley   *disc = prob->disc[f];
8162764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
8172764a2aaSMatthew G. Knepley }
8182764a2aaSMatthew G. Knepley 
819bc4ae4beSMatthew G. Knepley /*@
820bc4ae4beSMatthew G. Knepley   PetscDSSetDiscretization - Sets the discretization object for the given field
821bc4ae4beSMatthew G. Knepley 
822bc4ae4beSMatthew G. Knepley   Not collective
823bc4ae4beSMatthew G. Knepley 
824bc4ae4beSMatthew G. Knepley   Input Parameters:
825bc4ae4beSMatthew G. Knepley + prob - The PetscDS object
826bc4ae4beSMatthew G. Knepley . f - The field number
827bc4ae4beSMatthew G. Knepley - disc - The discretization object
828bc4ae4beSMatthew G. Knepley 
829bc4ae4beSMatthew G. Knepley   Level: beginner
830bc4ae4beSMatthew G. Knepley 
831bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
832bc4ae4beSMatthew G. Knepley @*/
8332764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetDiscretization(PetscDS prob, PetscInt f, PetscObject disc)
8342764a2aaSMatthew G. Knepley {
8352764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
8362764a2aaSMatthew G. Knepley 
8372764a2aaSMatthew G. Knepley   PetscFunctionBegin;
8382764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
8392764a2aaSMatthew G. Knepley   PetscValidPointer(disc, 3);
8402764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
8412764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
842c10f2116SMatthew G. Knepley   ierr = PetscObjectDereference(prob->disc[f]);CHKERRQ(ierr);
8432764a2aaSMatthew G. Knepley   prob->disc[f] = disc;
8442764a2aaSMatthew G. Knepley   ierr = PetscObjectReference(disc);CHKERRQ(ierr);
845249df284SMatthew G. Knepley   {
846249df284SMatthew G. Knepley     PetscClassId id;
847249df284SMatthew G. Knepley 
848249df284SMatthew G. Knepley     ierr = PetscObjectGetClassId(disc, &id);CHKERRQ(ierr);
8491cf84007SMatthew G. Knepley     if (id == PETSCFE_CLASSID) {
8501cf84007SMatthew G. Knepley       ierr = PetscDSSetImplicit(prob, f, PETSC_TRUE);CHKERRQ(ierr);
8511cf84007SMatthew G. Knepley     } else if (id == PETSCFV_CLASSID) {
8521cf84007SMatthew G. Knepley       ierr = PetscDSSetImplicit(prob, f, PETSC_FALSE);CHKERRQ(ierr);
853a6cbbb48SMatthew G. Knepley     }
854249df284SMatthew G. Knepley   }
8552764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
8562764a2aaSMatthew G. Knepley }
8572764a2aaSMatthew G. Knepley 
858bc4ae4beSMatthew G. Knepley /*@
859bc4ae4beSMatthew G. Knepley   PetscDSAddDiscretization - Adds a discretization object
860bc4ae4beSMatthew G. Knepley 
861bc4ae4beSMatthew G. Knepley   Not collective
862bc4ae4beSMatthew G. Knepley 
863bc4ae4beSMatthew G. Knepley   Input Parameters:
864bc4ae4beSMatthew G. Knepley + prob - The PetscDS object
865bc4ae4beSMatthew G. Knepley - disc - The boundary discretization object
866bc4ae4beSMatthew G. Knepley 
867bc4ae4beSMatthew G. Knepley   Level: beginner
868bc4ae4beSMatthew G. Knepley 
869bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetDiscretization(), PetscDSSetDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
870bc4ae4beSMatthew G. Knepley @*/
8712764a2aaSMatthew G. Knepley PetscErrorCode PetscDSAddDiscretization(PetscDS prob, PetscObject disc)
8722764a2aaSMatthew G. Knepley {
8732764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
8742764a2aaSMatthew G. Knepley 
8752764a2aaSMatthew G. Knepley   PetscFunctionBegin;
8762764a2aaSMatthew G. Knepley   ierr = PetscDSSetDiscretization(prob, prob->Nf, disc);CHKERRQ(ierr);
8772764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
8782764a2aaSMatthew G. Knepley }
8792764a2aaSMatthew G. Knepley 
880249df284SMatthew G. Knepley /*@
881249df284SMatthew G. Knepley   PetscDSGetImplicit - Returns the flag for implicit solve for this field. This is just a guide for IMEX
882249df284SMatthew G. Knepley 
883249df284SMatthew G. Knepley   Not collective
884249df284SMatthew G. Knepley 
885249df284SMatthew G. Knepley   Input Parameters:
886249df284SMatthew G. Knepley + prob - The PetscDS object
887249df284SMatthew G. Knepley - f - The field number
888249df284SMatthew G. Knepley 
889249df284SMatthew G. Knepley   Output Parameter:
890249df284SMatthew G. Knepley . implicit - The flag indicating what kind of solve to use for this field
891249df284SMatthew G. Knepley 
892249df284SMatthew G. Knepley   Level: developer
893249df284SMatthew G. Knepley 
894f744cafaSSander Arens .seealso: PetscDSSetImplicit(), PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
895249df284SMatthew G. Knepley @*/
896249df284SMatthew G. Knepley PetscErrorCode PetscDSGetImplicit(PetscDS prob, PetscInt f, PetscBool *implicit)
897249df284SMatthew G. Knepley {
898249df284SMatthew G. Knepley   PetscFunctionBegin;
899249df284SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
900249df284SMatthew G. Knepley   PetscValidPointer(implicit, 3);
901249df284SMatthew 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);
902249df284SMatthew G. Knepley   *implicit = prob->implicit[f];
903249df284SMatthew G. Knepley   PetscFunctionReturn(0);
904249df284SMatthew G. Knepley }
905249df284SMatthew G. Knepley 
906249df284SMatthew G. Knepley /*@
907249df284SMatthew G. Knepley   PetscDSSetImplicit - Set the flag for implicit solve for this field. This is just a guide for IMEX
908249df284SMatthew G. Knepley 
909249df284SMatthew G. Knepley   Not collective
910249df284SMatthew G. Knepley 
911249df284SMatthew G. Knepley   Input Parameters:
912249df284SMatthew G. Knepley + prob - The PetscDS object
913249df284SMatthew G. Knepley . f - The field number
914249df284SMatthew G. Knepley - implicit - The flag indicating what kind of solve to use for this field
915249df284SMatthew G. Knepley 
916249df284SMatthew G. Knepley   Level: developer
917249df284SMatthew G. Knepley 
918f744cafaSSander Arens .seealso: PetscDSGetImplicit(), PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
919249df284SMatthew G. Knepley @*/
920249df284SMatthew G. Knepley PetscErrorCode PetscDSSetImplicit(PetscDS prob, PetscInt f, PetscBool implicit)
921249df284SMatthew G. Knepley {
922249df284SMatthew G. Knepley   PetscFunctionBegin;
923249df284SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
924249df284SMatthew 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);
925249df284SMatthew G. Knepley   prob->implicit[f] = implicit;
926249df284SMatthew G. Knepley   PetscFunctionReturn(0);
927249df284SMatthew G. Knepley }
928249df284SMatthew G. Knepley 
9292764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetObjective(PetscDS prob, PetscInt f,
93030b9ff8bSMatthew G. Knepley                                    void (**obj)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
931194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
932194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
93397b6e6e8SMatthew G. Knepley                                                 PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar obj[]))
9342764a2aaSMatthew G. Knepley {
9352764a2aaSMatthew G. Knepley   PetscFunctionBegin;
9362764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
9372764a2aaSMatthew G. Knepley   PetscValidPointer(obj, 2);
9382764a2aaSMatthew 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);
9392764a2aaSMatthew G. Knepley   *obj = prob->obj[f];
9402764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
9412764a2aaSMatthew G. Knepley }
9422764a2aaSMatthew G. Knepley 
9432764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetObjective(PetscDS prob, PetscInt f,
94430b9ff8bSMatthew G. Knepley                                    void (*obj)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
945194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
946194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
94797b6e6e8SMatthew G. Knepley                                                PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar obj[]))
9482764a2aaSMatthew G. Knepley {
9492764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
9502764a2aaSMatthew G. Knepley 
9512764a2aaSMatthew G. Knepley   PetscFunctionBegin;
9522764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
953de716cbcSToby Isaac   if (obj) PetscValidFunction(obj, 2);
9542764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
9552764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
9562764a2aaSMatthew G. Knepley   prob->obj[f] = obj;
9572764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
9582764a2aaSMatthew G. Knepley }
9592764a2aaSMatthew G. Knepley 
960194d53e6SMatthew G. Knepley /*@C
961194d53e6SMatthew G. Knepley   PetscDSGetResidual - Get the pointwise residual function for a given test field
962194d53e6SMatthew G. Knepley 
963194d53e6SMatthew G. Knepley   Not collective
964194d53e6SMatthew G. Knepley 
965194d53e6SMatthew G. Knepley   Input Parameters:
966194d53e6SMatthew G. Knepley + prob - The PetscDS
967194d53e6SMatthew G. Knepley - f    - The test field number
968194d53e6SMatthew G. Knepley 
969194d53e6SMatthew G. Knepley   Output Parameters:
970194d53e6SMatthew G. Knepley + f0 - integrand for the test function term
971194d53e6SMatthew G. Knepley - f1 - integrand for the test function gradient term
972194d53e6SMatthew G. Knepley 
973194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
974194d53e6SMatthew G. Knepley 
975194d53e6SMatthew 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)
976194d53e6SMatthew G. Knepley 
977194d53e6SMatthew G. Knepley The calling sequence for the callbacks f0 and f1 is given by:
978194d53e6SMatthew G. Knepley 
97930b9ff8bSMatthew G. Knepley $ f0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
980194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
981194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
98230b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], PetscScalar f0[])
983194d53e6SMatthew G. Knepley 
984194d53e6SMatthew G. Knepley + dim - the spatial dimension
985194d53e6SMatthew G. Knepley . Nf - the number of fields
986194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
987194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
988194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
989194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
990194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
991194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
992194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
993194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
994194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
995194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
996194d53e6SMatthew G. Knepley . t - current time
997194d53e6SMatthew G. Knepley . x - coordinates of the current point
99897b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
99997b6e6e8SMatthew G. Knepley . constants - constant parameters
1000194d53e6SMatthew G. Knepley - f0 - output values at the current point
1001194d53e6SMatthew G. Knepley 
1002194d53e6SMatthew G. Knepley   Level: intermediate
1003194d53e6SMatthew G. Knepley 
1004194d53e6SMatthew G. Knepley .seealso: PetscDSSetResidual()
1005194d53e6SMatthew G. Knepley @*/
10062764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetResidual(PetscDS prob, PetscInt f,
100730b9ff8bSMatthew G. Knepley                                   void (**f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1008194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1009194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
101097b6e6e8SMatthew G. Knepley                                               PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f0[]),
101130b9ff8bSMatthew G. Knepley                                   void (**f1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1012194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1013194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
101497b6e6e8SMatthew G. Knepley                                               PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f1[]))
10152764a2aaSMatthew G. Knepley {
10162764a2aaSMatthew G. Knepley   PetscFunctionBegin;
10172764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
10182764a2aaSMatthew 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);
10192764a2aaSMatthew G. Knepley   if (f0) {PetscValidPointer(f0, 3); *f0 = prob->f[f*2+0];}
10202764a2aaSMatthew G. Knepley   if (f1) {PetscValidPointer(f1, 4); *f1 = prob->f[f*2+1];}
10212764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
10222764a2aaSMatthew G. Knepley }
10232764a2aaSMatthew G. Knepley 
1024194d53e6SMatthew G. Knepley /*@C
1025194d53e6SMatthew G. Knepley   PetscDSSetResidual - Set the pointwise residual function for a given test field
1026194d53e6SMatthew G. Knepley 
1027194d53e6SMatthew G. Knepley   Not collective
1028194d53e6SMatthew G. Knepley 
1029194d53e6SMatthew G. Knepley   Input Parameters:
1030194d53e6SMatthew G. Knepley + prob - The PetscDS
1031194d53e6SMatthew G. Knepley . f    - The test field number
1032194d53e6SMatthew G. Knepley . f0 - integrand for the test function term
1033194d53e6SMatthew G. Knepley - f1 - integrand for the test function gradient term
1034194d53e6SMatthew G. Knepley 
1035194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1036194d53e6SMatthew G. Knepley 
1037194d53e6SMatthew 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)
1038194d53e6SMatthew G. Knepley 
1039194d53e6SMatthew G. Knepley The calling sequence for the callbacks f0 and f1 is given by:
1040194d53e6SMatthew G. Knepley 
104130b9ff8bSMatthew G. Knepley $ f0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1042194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1043194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
104430b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], PetscScalar f0[])
1045194d53e6SMatthew G. Knepley 
1046194d53e6SMatthew G. Knepley + dim - the spatial dimension
1047194d53e6SMatthew G. Knepley . Nf - the number of fields
1048194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1049194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1050194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
1051194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1052194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1053194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1054194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1055194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1056194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1057194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1058194d53e6SMatthew G. Knepley . t - current time
1059194d53e6SMatthew G. Knepley . x - coordinates of the current point
106097b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
106197b6e6e8SMatthew G. Knepley . constants - constant parameters
1062194d53e6SMatthew G. Knepley - f0 - output values at the current point
1063194d53e6SMatthew G. Knepley 
1064194d53e6SMatthew G. Knepley   Level: intermediate
1065194d53e6SMatthew G. Knepley 
1066194d53e6SMatthew G. Knepley .seealso: PetscDSGetResidual()
1067194d53e6SMatthew G. Knepley @*/
10682764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetResidual(PetscDS prob, PetscInt f,
106930b9ff8bSMatthew G. Knepley                                   void (*f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1070194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1071194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
107297b6e6e8SMatthew G. Knepley                                              PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f0[]),
107330b9ff8bSMatthew G. Knepley                                   void (*f1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1074194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1075194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
107697b6e6e8SMatthew G. Knepley                                              PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f1[]))
10772764a2aaSMatthew G. Knepley {
10782764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
10792764a2aaSMatthew G. Knepley 
10802764a2aaSMatthew G. Knepley   PetscFunctionBegin;
10812764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1082f866a1d0SMatthew G. Knepley   if (f0) PetscValidFunction(f0, 3);
1083f866a1d0SMatthew G. Knepley   if (f1) PetscValidFunction(f1, 4);
10842764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
10852764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
10862764a2aaSMatthew G. Knepley   prob->f[f*2+0] = f0;
10872764a2aaSMatthew G. Knepley   prob->f[f*2+1] = f1;
10882764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
10892764a2aaSMatthew G. Knepley }
10902764a2aaSMatthew G. Knepley 
10913e75805dSMatthew G. Knepley /*@C
10923e75805dSMatthew G. Knepley   PetscDSHasJacobian - Signals that Jacobian functions have been set
10933e75805dSMatthew G. Knepley 
10943e75805dSMatthew G. Knepley   Not collective
10953e75805dSMatthew G. Knepley 
10963e75805dSMatthew G. Knepley   Input Parameter:
10973e75805dSMatthew G. Knepley . prob - The PetscDS
10983e75805dSMatthew G. Knepley 
10993e75805dSMatthew G. Knepley   Output Parameter:
11003e75805dSMatthew G. Knepley . hasJac - flag that pointwise function for the Jacobian has been set
11013e75805dSMatthew G. Knepley 
11023e75805dSMatthew G. Knepley   Level: intermediate
11033e75805dSMatthew G. Knepley 
11043e75805dSMatthew G. Knepley .seealso: PetscDSGetJacobianPreconditioner(), PetscDSSetJacobianPreconditioner(), PetscDSGetJacobian()
11053e75805dSMatthew G. Knepley @*/
11063e75805dSMatthew G. Knepley PetscErrorCode PetscDSHasJacobian(PetscDS prob, PetscBool *hasJac)
11073e75805dSMatthew G. Knepley {
11083e75805dSMatthew G. Knepley   PetscInt f, g, h;
11093e75805dSMatthew G. Knepley 
11103e75805dSMatthew G. Knepley   PetscFunctionBegin;
11113e75805dSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
11123e75805dSMatthew G. Knepley   *hasJac = PETSC_FALSE;
11133e75805dSMatthew G. Knepley   for (f = 0; f < prob->Nf; ++f) {
11143e75805dSMatthew G. Knepley     for (g = 0; g < prob->Nf; ++g) {
11153e75805dSMatthew G. Knepley       for (h = 0; h < 4; ++h) {
11163e75805dSMatthew G. Knepley         if (prob->g[(f*prob->Nf + g)*4+h]) *hasJac = PETSC_TRUE;
11173e75805dSMatthew G. Knepley       }
11183e75805dSMatthew G. Knepley     }
11193e75805dSMatthew G. Knepley   }
11203e75805dSMatthew G. Knepley   PetscFunctionReturn(0);
11213e75805dSMatthew G. Knepley }
11223e75805dSMatthew G. Knepley 
1123194d53e6SMatthew G. Knepley /*@C
1124194d53e6SMatthew G. Knepley   PetscDSGetJacobian - Get the pointwise Jacobian function for given test and basis field
1125194d53e6SMatthew G. Knepley 
1126194d53e6SMatthew G. Knepley   Not collective
1127194d53e6SMatthew G. Knepley 
1128194d53e6SMatthew G. Knepley   Input Parameters:
1129194d53e6SMatthew G. Knepley + prob - The PetscDS
1130194d53e6SMatthew G. Knepley . f    - The test field number
1131194d53e6SMatthew G. Knepley - g    - The field number
1132194d53e6SMatthew G. Knepley 
1133194d53e6SMatthew G. Knepley   Output Parameters:
1134194d53e6SMatthew G. Knepley + g0 - integrand for the test and basis function term
1135194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1136194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1137194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1138194d53e6SMatthew G. Knepley 
1139194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1140194d53e6SMatthew G. Knepley 
1141194d53e6SMatthew 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
1142194d53e6SMatthew G. Knepley 
1143194d53e6SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1144194d53e6SMatthew G. Knepley 
114530b9ff8bSMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1146194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1147194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
114830b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal u_tShift, const PetscReal x[], PetscScalar g0[])
1149194d53e6SMatthew G. Knepley 
1150194d53e6SMatthew G. Knepley + dim - the spatial dimension
1151194d53e6SMatthew G. Knepley . Nf - the number of fields
1152194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1153194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1154194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
1155194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1156194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1157194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1158194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1159194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1160194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1161194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1162194d53e6SMatthew G. Knepley . t - current time
11632aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1164194d53e6SMatthew G. Knepley . x - coordinates of the current point
116597b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
116697b6e6e8SMatthew G. Knepley . constants - constant parameters
1167194d53e6SMatthew G. Knepley - g0 - output values at the current point
1168194d53e6SMatthew G. Knepley 
1169194d53e6SMatthew G. Knepley   Level: intermediate
1170194d53e6SMatthew G. Knepley 
1171194d53e6SMatthew G. Knepley .seealso: PetscDSSetJacobian()
1172194d53e6SMatthew G. Knepley @*/
11732764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetJacobian(PetscDS prob, PetscInt f, PetscInt g,
117430b9ff8bSMatthew G. Knepley                                   void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1175194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1176194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
117797b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
117830b9ff8bSMatthew G. Knepley                                   void (**g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1179194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1180194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
118197b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
118230b9ff8bSMatthew G. Knepley                                   void (**g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1183194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1184194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
118597b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
118630b9ff8bSMatthew G. Knepley                                   void (**g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1187194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1188194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
118997b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
11902764a2aaSMatthew G. Knepley {
11912764a2aaSMatthew G. Knepley   PetscFunctionBegin;
11922764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
11932764a2aaSMatthew 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);
11942764a2aaSMatthew 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);
11952764a2aaSMatthew G. Knepley   if (g0) {PetscValidPointer(g0, 4); *g0 = prob->g[(f*prob->Nf + g)*4+0];}
11962764a2aaSMatthew G. Knepley   if (g1) {PetscValidPointer(g1, 5); *g1 = prob->g[(f*prob->Nf + g)*4+1];}
11972764a2aaSMatthew G. Knepley   if (g2) {PetscValidPointer(g2, 6); *g2 = prob->g[(f*prob->Nf + g)*4+2];}
11982764a2aaSMatthew G. Knepley   if (g3) {PetscValidPointer(g3, 7); *g3 = prob->g[(f*prob->Nf + g)*4+3];}
11992764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
12002764a2aaSMatthew G. Knepley }
12012764a2aaSMatthew G. Knepley 
1202194d53e6SMatthew G. Knepley /*@C
1203194d53e6SMatthew G. Knepley   PetscDSSetJacobian - Set the pointwise Jacobian function for given test and basis fields
1204194d53e6SMatthew G. Knepley 
1205194d53e6SMatthew G. Knepley   Not collective
1206194d53e6SMatthew G. Knepley 
1207194d53e6SMatthew G. Knepley   Input Parameters:
1208194d53e6SMatthew G. Knepley + prob - The PetscDS
1209194d53e6SMatthew G. Knepley . f    - The test field number
1210194d53e6SMatthew G. Knepley . g    - The field number
1211194d53e6SMatthew G. Knepley . g0 - integrand for the test and basis function term
1212194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1213194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1214194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1215194d53e6SMatthew G. Knepley 
1216194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1217194d53e6SMatthew G. Knepley 
1218194d53e6SMatthew 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
1219194d53e6SMatthew G. Knepley 
1220194d53e6SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1221194d53e6SMatthew G. Knepley 
122230b9ff8bSMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1223194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1224194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
122530b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], PetscScalar g0[])
1226194d53e6SMatthew G. Knepley 
1227194d53e6SMatthew G. Knepley + dim - the spatial dimension
1228194d53e6SMatthew G. Knepley . Nf - the number of fields
1229194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1230194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1231194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
1232194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1233194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1234194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1235194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1236194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1237194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1238194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1239194d53e6SMatthew G. Knepley . t - current time
12402aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1241194d53e6SMatthew G. Knepley . x - coordinates of the current point
124297b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
124397b6e6e8SMatthew G. Knepley . constants - constant parameters
1244194d53e6SMatthew G. Knepley - g0 - output values at the current point
1245194d53e6SMatthew G. Knepley 
1246194d53e6SMatthew G. Knepley   Level: intermediate
1247194d53e6SMatthew G. Knepley 
1248194d53e6SMatthew G. Knepley .seealso: PetscDSGetJacobian()
1249194d53e6SMatthew G. Knepley @*/
12502764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetJacobian(PetscDS prob, PetscInt f, PetscInt g,
125130b9ff8bSMatthew G. Knepley                                   void (*g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1252194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1253194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
125497b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
125530b9ff8bSMatthew G. Knepley                                   void (*g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1256194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1257194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
125897b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
125930b9ff8bSMatthew G. Knepley                                   void (*g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1260194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1261194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
126297b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
126330b9ff8bSMatthew G. Knepley                                   void (*g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1264194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1265194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
126697b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
12672764a2aaSMatthew G. Knepley {
12682764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
12692764a2aaSMatthew G. Knepley 
12702764a2aaSMatthew G. Knepley   PetscFunctionBegin;
12712764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
12722764a2aaSMatthew G. Knepley   if (g0) PetscValidFunction(g0, 4);
12732764a2aaSMatthew G. Knepley   if (g1) PetscValidFunction(g1, 5);
12742764a2aaSMatthew G. Knepley   if (g2) PetscValidFunction(g2, 6);
12752764a2aaSMatthew G. Knepley   if (g3) PetscValidFunction(g3, 7);
12762764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
12772764a2aaSMatthew G. Knepley   if (g < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", g);
12782764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, PetscMax(f, g)+1);CHKERRQ(ierr);
12792764a2aaSMatthew G. Knepley   prob->g[(f*prob->Nf + g)*4+0] = g0;
12802764a2aaSMatthew G. Knepley   prob->g[(f*prob->Nf + g)*4+1] = g1;
12812764a2aaSMatthew G. Knepley   prob->g[(f*prob->Nf + g)*4+2] = g2;
12822764a2aaSMatthew G. Knepley   prob->g[(f*prob->Nf + g)*4+3] = g3;
12832764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
12842764a2aaSMatthew G. Knepley }
12852764a2aaSMatthew G. Knepley 
1286475e0ac9SMatthew G. Knepley /*@C
128755c1f793SMatthew G. Knepley   PetscDSUseJacobianPreconditioner - Whether to construct a Jacobian preconditioner
128855c1f793SMatthew G. Knepley 
128955c1f793SMatthew G. Knepley   Not collective
129055c1f793SMatthew G. Knepley 
129155c1f793SMatthew G. Knepley   Input Parameters:
129255c1f793SMatthew G. Knepley + prob - The PetscDS
129355c1f793SMatthew G. Knepley - useJacPre - flag that enables construction of a Jacobian preconditioner
129455c1f793SMatthew G. Knepley 
129555c1f793SMatthew G. Knepley   Level: intermediate
129655c1f793SMatthew G. Knepley 
129755c1f793SMatthew G. Knepley .seealso: PetscDSGetJacobianPreconditioner(), PetscDSSetJacobianPreconditioner(), PetscDSGetJacobian()
129855c1f793SMatthew G. Knepley @*/
129955c1f793SMatthew G. Knepley PetscErrorCode PetscDSUseJacobianPreconditioner(PetscDS prob, PetscBool useJacPre)
130055c1f793SMatthew G. Knepley {
130155c1f793SMatthew G. Knepley   PetscFunctionBegin;
130255c1f793SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
130355c1f793SMatthew G. Knepley   prob->useJacPre = useJacPre;
130455c1f793SMatthew G. Knepley   PetscFunctionReturn(0);
130555c1f793SMatthew G. Knepley }
130655c1f793SMatthew G. Knepley 
130755c1f793SMatthew G. Knepley /*@C
1308475e0ac9SMatthew G. Knepley   PetscDSHasJacobianPreconditioner - Signals that a Jacobian preconditioner matrix has been set
1309475e0ac9SMatthew G. Knepley 
1310475e0ac9SMatthew G. Knepley   Not collective
1311475e0ac9SMatthew G. Knepley 
1312475e0ac9SMatthew G. Knepley   Input Parameter:
1313475e0ac9SMatthew G. Knepley . prob - The PetscDS
1314475e0ac9SMatthew G. Knepley 
1315475e0ac9SMatthew G. Knepley   Output Parameter:
1316475e0ac9SMatthew G. Knepley . hasJacPre - flag that pointwise function for Jacobian preconditioner matrix has been set
1317475e0ac9SMatthew G. Knepley 
1318475e0ac9SMatthew G. Knepley   Level: intermediate
1319475e0ac9SMatthew G. Knepley 
1320475e0ac9SMatthew G. Knepley .seealso: PetscDSGetJacobianPreconditioner(), PetscDSSetJacobianPreconditioner(), PetscDSGetJacobian()
1321475e0ac9SMatthew G. Knepley @*/
1322475e0ac9SMatthew G. Knepley PetscErrorCode PetscDSHasJacobianPreconditioner(PetscDS prob, PetscBool *hasJacPre)
1323475e0ac9SMatthew G. Knepley {
1324475e0ac9SMatthew G. Knepley   PetscInt f, g, h;
1325475e0ac9SMatthew G. Knepley 
1326475e0ac9SMatthew G. Knepley   PetscFunctionBegin;
1327475e0ac9SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1328475e0ac9SMatthew G. Knepley   *hasJacPre = PETSC_FALSE;
132955c1f793SMatthew G. Knepley   if (!prob->useJacPre) PetscFunctionReturn(0);
1330475e0ac9SMatthew G. Knepley   for (f = 0; f < prob->Nf; ++f) {
1331475e0ac9SMatthew G. Knepley     for (g = 0; g < prob->Nf; ++g) {
1332475e0ac9SMatthew G. Knepley       for (h = 0; h < 4; ++h) {
1333475e0ac9SMatthew G. Knepley         if (prob->gp[(f*prob->Nf + g)*4+h]) *hasJacPre = PETSC_TRUE;
1334475e0ac9SMatthew G. Knepley       }
1335475e0ac9SMatthew G. Knepley     }
1336475e0ac9SMatthew G. Knepley   }
1337475e0ac9SMatthew G. Knepley   PetscFunctionReturn(0);
1338475e0ac9SMatthew G. Knepley }
1339475e0ac9SMatthew G. Knepley 
1340475e0ac9SMatthew G. Knepley /*@C
1341475e0ac9SMatthew 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.
1342475e0ac9SMatthew G. Knepley 
1343475e0ac9SMatthew G. Knepley   Not collective
1344475e0ac9SMatthew G. Knepley 
1345475e0ac9SMatthew G. Knepley   Input Parameters:
1346475e0ac9SMatthew G. Knepley + prob - The PetscDS
1347475e0ac9SMatthew G. Knepley . f    - The test field number
1348475e0ac9SMatthew G. Knepley - g    - The field number
1349475e0ac9SMatthew G. Knepley 
1350475e0ac9SMatthew G. Knepley   Output Parameters:
1351475e0ac9SMatthew G. Knepley + g0 - integrand for the test and basis function term
1352475e0ac9SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1353475e0ac9SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1354475e0ac9SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1355475e0ac9SMatthew G. Knepley 
1356475e0ac9SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1357475e0ac9SMatthew G. Knepley 
1358475e0ac9SMatthew 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
1359475e0ac9SMatthew G. Knepley 
1360475e0ac9SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1361475e0ac9SMatthew G. Knepley 
1362475e0ac9SMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1363475e0ac9SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1364475e0ac9SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1365475e0ac9SMatthew G. Knepley $    PetscReal t, const PetscReal u_tShift, const PetscReal x[], PetscScalar g0[])
1366475e0ac9SMatthew G. Knepley 
1367475e0ac9SMatthew G. Knepley + dim - the spatial dimension
1368475e0ac9SMatthew G. Knepley . Nf - the number of fields
1369475e0ac9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1370475e0ac9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1371475e0ac9SMatthew G. Knepley . u - each field evaluated at the current point
1372475e0ac9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1373475e0ac9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1374475e0ac9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1375475e0ac9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1376475e0ac9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1377475e0ac9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1378475e0ac9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1379475e0ac9SMatthew G. Knepley . t - current time
1380475e0ac9SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1381475e0ac9SMatthew G. Knepley . x - coordinates of the current point
138297b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
138397b6e6e8SMatthew G. Knepley . constants - constant parameters
1384475e0ac9SMatthew G. Knepley - g0 - output values at the current point
1385475e0ac9SMatthew G. Knepley 
1386475e0ac9SMatthew G. Knepley   Level: intermediate
1387475e0ac9SMatthew G. Knepley 
1388475e0ac9SMatthew G. Knepley .seealso: PetscDSSetJacobianPreconditioner(), PetscDSGetJacobian()
1389475e0ac9SMatthew G. Knepley @*/
1390475e0ac9SMatthew G. Knepley PetscErrorCode PetscDSGetJacobianPreconditioner(PetscDS prob, PetscInt f, PetscInt g,
1391475e0ac9SMatthew G. Knepley                                   void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1392475e0ac9SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1393475e0ac9SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
139497b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
1395475e0ac9SMatthew G. Knepley                                   void (**g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1396475e0ac9SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1397475e0ac9SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
139897b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
1399475e0ac9SMatthew G. Knepley                                   void (**g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1400475e0ac9SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1401475e0ac9SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
140297b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
1403475e0ac9SMatthew G. Knepley                                   void (**g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1404475e0ac9SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1405475e0ac9SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
140697b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
1407475e0ac9SMatthew G. Knepley {
1408475e0ac9SMatthew G. Knepley   PetscFunctionBegin;
1409475e0ac9SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1410475e0ac9SMatthew 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);
1411475e0ac9SMatthew 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);
1412475e0ac9SMatthew G. Knepley   if (g0) {PetscValidPointer(g0, 4); *g0 = prob->gp[(f*prob->Nf + g)*4+0];}
1413475e0ac9SMatthew G. Knepley   if (g1) {PetscValidPointer(g1, 5); *g1 = prob->gp[(f*prob->Nf + g)*4+1];}
1414475e0ac9SMatthew G. Knepley   if (g2) {PetscValidPointer(g2, 6); *g2 = prob->gp[(f*prob->Nf + g)*4+2];}
1415475e0ac9SMatthew G. Knepley   if (g3) {PetscValidPointer(g3, 7); *g3 = prob->gp[(f*prob->Nf + g)*4+3];}
1416475e0ac9SMatthew G. Knepley   PetscFunctionReturn(0);
1417475e0ac9SMatthew G. Knepley }
1418475e0ac9SMatthew G. Knepley 
1419475e0ac9SMatthew G. Knepley /*@C
1420475e0ac9SMatthew 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.
1421475e0ac9SMatthew G. Knepley 
1422475e0ac9SMatthew G. Knepley   Not collective
1423475e0ac9SMatthew G. Knepley 
1424475e0ac9SMatthew G. Knepley   Input Parameters:
1425475e0ac9SMatthew G. Knepley + prob - The PetscDS
1426475e0ac9SMatthew G. Knepley . f    - The test field number
1427475e0ac9SMatthew G. Knepley . g    - The field number
1428475e0ac9SMatthew G. Knepley . g0 - integrand for the test and basis function term
1429475e0ac9SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1430475e0ac9SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1431475e0ac9SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1432475e0ac9SMatthew G. Knepley 
1433475e0ac9SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1434475e0ac9SMatthew G. Knepley 
1435475e0ac9SMatthew 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
1436475e0ac9SMatthew G. Knepley 
1437475e0ac9SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1438475e0ac9SMatthew G. Knepley 
1439475e0ac9SMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1440475e0ac9SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1441475e0ac9SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1442475e0ac9SMatthew G. Knepley $    PetscReal t, const PetscReal x[], PetscScalar g0[])
1443475e0ac9SMatthew G. Knepley 
1444475e0ac9SMatthew G. Knepley + dim - the spatial dimension
1445475e0ac9SMatthew G. Knepley . Nf - the number of fields
1446475e0ac9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1447475e0ac9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1448475e0ac9SMatthew G. Knepley . u - each field evaluated at the current point
1449475e0ac9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1450475e0ac9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1451475e0ac9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1452475e0ac9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1453475e0ac9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1454475e0ac9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1455475e0ac9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1456475e0ac9SMatthew G. Knepley . t - current time
1457475e0ac9SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1458475e0ac9SMatthew G. Knepley . x - coordinates of the current point
145997b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
146097b6e6e8SMatthew G. Knepley . constants - constant parameters
1461475e0ac9SMatthew G. Knepley - g0 - output values at the current point
1462475e0ac9SMatthew G. Knepley 
1463475e0ac9SMatthew G. Knepley   Level: intermediate
1464475e0ac9SMatthew G. Knepley 
1465475e0ac9SMatthew G. Knepley .seealso: PetscDSGetJacobianPreconditioner(), PetscDSSetJacobian()
1466475e0ac9SMatthew G. Knepley @*/
1467475e0ac9SMatthew G. Knepley PetscErrorCode PetscDSSetJacobianPreconditioner(PetscDS prob, PetscInt f, PetscInt g,
1468475e0ac9SMatthew G. Knepley                                   void (*g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1469475e0ac9SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1470475e0ac9SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
147197b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
1472475e0ac9SMatthew G. Knepley                                   void (*g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1473475e0ac9SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1474475e0ac9SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
147597b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
1476475e0ac9SMatthew G. Knepley                                   void (*g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1477475e0ac9SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1478475e0ac9SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
147997b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
1480475e0ac9SMatthew G. Knepley                                   void (*g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1481475e0ac9SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1482475e0ac9SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
148397b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
1484475e0ac9SMatthew G. Knepley {
1485475e0ac9SMatthew G. Knepley   PetscErrorCode ierr;
1486475e0ac9SMatthew G. Knepley 
1487475e0ac9SMatthew G. Knepley   PetscFunctionBegin;
1488475e0ac9SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1489475e0ac9SMatthew G. Knepley   if (g0) PetscValidFunction(g0, 4);
1490475e0ac9SMatthew G. Knepley   if (g1) PetscValidFunction(g1, 5);
1491475e0ac9SMatthew G. Knepley   if (g2) PetscValidFunction(g2, 6);
1492475e0ac9SMatthew G. Knepley   if (g3) PetscValidFunction(g3, 7);
1493475e0ac9SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
1494475e0ac9SMatthew G. Knepley   if (g < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", g);
1495475e0ac9SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, PetscMax(f, g)+1);CHKERRQ(ierr);
1496475e0ac9SMatthew G. Knepley   prob->gp[(f*prob->Nf + g)*4+0] = g0;
1497475e0ac9SMatthew G. Knepley   prob->gp[(f*prob->Nf + g)*4+1] = g1;
1498475e0ac9SMatthew G. Knepley   prob->gp[(f*prob->Nf + g)*4+2] = g2;
1499475e0ac9SMatthew G. Knepley   prob->gp[(f*prob->Nf + g)*4+3] = g3;
1500475e0ac9SMatthew G. Knepley   PetscFunctionReturn(0);
1501475e0ac9SMatthew G. Knepley }
1502475e0ac9SMatthew G. Knepley 
1503b7e05686SMatthew G. Knepley /*@C
1504b7e05686SMatthew G. Knepley   PetscDSHasDynamicJacobian - Signals that a dynamic Jacobian, dF/du_t, has been set
1505b7e05686SMatthew G. Knepley 
1506b7e05686SMatthew G. Knepley   Not collective
1507b7e05686SMatthew G. Knepley 
1508b7e05686SMatthew G. Knepley   Input Parameter:
1509b7e05686SMatthew G. Knepley . prob - The PetscDS
1510b7e05686SMatthew G. Knepley 
1511b7e05686SMatthew G. Knepley   Output Parameter:
1512b7e05686SMatthew G. Knepley . hasDynJac - flag that pointwise function for dynamic Jacobian has been set
1513b7e05686SMatthew G. Knepley 
1514b7e05686SMatthew G. Knepley   Level: intermediate
1515b7e05686SMatthew G. Knepley 
1516b7e05686SMatthew G. Knepley .seealso: PetscDSGetDynamicJacobian(), PetscDSSetDynamicJacobian(), PetscDSGetJacobian()
1517b7e05686SMatthew G. Knepley @*/
1518b7e05686SMatthew G. Knepley PetscErrorCode PetscDSHasDynamicJacobian(PetscDS prob, PetscBool *hasDynJac)
1519b7e05686SMatthew G. Knepley {
1520b7e05686SMatthew G. Knepley   PetscInt f, g, h;
1521b7e05686SMatthew G. Knepley 
1522b7e05686SMatthew G. Knepley   PetscFunctionBegin;
1523b7e05686SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1524b7e05686SMatthew G. Knepley   *hasDynJac = PETSC_FALSE;
1525b7e05686SMatthew G. Knepley   for (f = 0; f < prob->Nf; ++f) {
1526b7e05686SMatthew G. Knepley     for (g = 0; g < prob->Nf; ++g) {
1527b7e05686SMatthew G. Knepley       for (h = 0; h < 4; ++h) {
1528b7e05686SMatthew G. Knepley         if (prob->gt[(f*prob->Nf + g)*4+h]) *hasDynJac = PETSC_TRUE;
1529b7e05686SMatthew G. Knepley       }
1530b7e05686SMatthew G. Knepley     }
1531b7e05686SMatthew G. Knepley   }
1532b7e05686SMatthew G. Knepley   PetscFunctionReturn(0);
1533b7e05686SMatthew G. Knepley }
1534b7e05686SMatthew G. Knepley 
1535b7e05686SMatthew G. Knepley /*@C
1536b7e05686SMatthew G. Knepley   PetscDSGetDynamicJacobian - Get the pointwise dynamic Jacobian, dF/du_t, function for given test and basis field
1537b7e05686SMatthew G. Knepley 
1538b7e05686SMatthew G. Knepley   Not collective
1539b7e05686SMatthew G. Knepley 
1540b7e05686SMatthew G. Knepley   Input Parameters:
1541b7e05686SMatthew G. Knepley + prob - The PetscDS
1542b7e05686SMatthew G. Knepley . f    - The test field number
1543b7e05686SMatthew G. Knepley - g    - The field number
1544b7e05686SMatthew G. Knepley 
1545b7e05686SMatthew G. Knepley   Output Parameters:
1546b7e05686SMatthew G. Knepley + g0 - integrand for the test and basis function term
1547b7e05686SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1548b7e05686SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1549b7e05686SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1550b7e05686SMatthew G. Knepley 
1551b7e05686SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1552b7e05686SMatthew G. Knepley 
1553b7e05686SMatthew 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
1554b7e05686SMatthew G. Knepley 
1555b7e05686SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1556b7e05686SMatthew G. Knepley 
1557b7e05686SMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1558b7e05686SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1559b7e05686SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1560b7e05686SMatthew G. Knepley $    PetscReal t, const PetscReal u_tShift, const PetscReal x[], PetscScalar g0[])
1561b7e05686SMatthew G. Knepley 
1562b7e05686SMatthew G. Knepley + dim - the spatial dimension
1563b7e05686SMatthew G. Knepley . Nf - the number of fields
1564b7e05686SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1565b7e05686SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1566b7e05686SMatthew G. Knepley . u - each field evaluated at the current point
1567b7e05686SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1568b7e05686SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1569b7e05686SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1570b7e05686SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1571b7e05686SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1572b7e05686SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1573b7e05686SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1574b7e05686SMatthew G. Knepley . t - current time
1575b7e05686SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1576b7e05686SMatthew G. Knepley . x - coordinates of the current point
157797b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
157897b6e6e8SMatthew G. Knepley . constants - constant parameters
1579b7e05686SMatthew G. Knepley - g0 - output values at the current point
1580b7e05686SMatthew G. Knepley 
1581b7e05686SMatthew G. Knepley   Level: intermediate
1582b7e05686SMatthew G. Knepley 
1583b7e05686SMatthew G. Knepley .seealso: PetscDSSetJacobian()
1584b7e05686SMatthew G. Knepley @*/
1585b7e05686SMatthew G. Knepley PetscErrorCode PetscDSGetDynamicJacobian(PetscDS prob, PetscInt f, PetscInt g,
1586b7e05686SMatthew G. Knepley                                          void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1587b7e05686SMatthew G. Knepley                                                      const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1588b7e05686SMatthew G. Knepley                                                      const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
158997b6e6e8SMatthew G. Knepley                                                      PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
1590b7e05686SMatthew G. Knepley                                          void (**g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1591b7e05686SMatthew G. Knepley                                                      const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1592b7e05686SMatthew G. Knepley                                                      const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
159397b6e6e8SMatthew G. Knepley                                                      PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
1594b7e05686SMatthew G. Knepley                                          void (**g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1595b7e05686SMatthew G. Knepley                                                      const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1596b7e05686SMatthew G. Knepley                                                      const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
159797b6e6e8SMatthew G. Knepley                                                      PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
1598b7e05686SMatthew G. Knepley                                          void (**g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1599b7e05686SMatthew G. Knepley                                                      const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1600b7e05686SMatthew G. Knepley                                                      const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
160197b6e6e8SMatthew G. Knepley                                                      PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
1602b7e05686SMatthew G. Knepley {
1603b7e05686SMatthew G. Knepley   PetscFunctionBegin;
1604b7e05686SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1605b7e05686SMatthew 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);
1606b7e05686SMatthew 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);
1607b7e05686SMatthew G. Knepley   if (g0) {PetscValidPointer(g0, 4); *g0 = prob->gt[(f*prob->Nf + g)*4+0];}
1608b7e05686SMatthew G. Knepley   if (g1) {PetscValidPointer(g1, 5); *g1 = prob->gt[(f*prob->Nf + g)*4+1];}
1609b7e05686SMatthew G. Knepley   if (g2) {PetscValidPointer(g2, 6); *g2 = prob->gt[(f*prob->Nf + g)*4+2];}
1610b7e05686SMatthew G. Knepley   if (g3) {PetscValidPointer(g3, 7); *g3 = prob->gt[(f*prob->Nf + g)*4+3];}
1611b7e05686SMatthew G. Knepley   PetscFunctionReturn(0);
1612b7e05686SMatthew G. Knepley }
1613b7e05686SMatthew G. Knepley 
1614b7e05686SMatthew G. Knepley /*@C
1615b7e05686SMatthew G. Knepley   PetscDSSetDynamicJacobian - Set the pointwise dynamic Jacobian, dF/du_t, function for given test and basis fields
1616b7e05686SMatthew G. Knepley 
1617b7e05686SMatthew G. Knepley   Not collective
1618b7e05686SMatthew G. Knepley 
1619b7e05686SMatthew G. Knepley   Input Parameters:
1620b7e05686SMatthew G. Knepley + prob - The PetscDS
1621b7e05686SMatthew G. Knepley . f    - The test field number
1622b7e05686SMatthew G. Knepley . g    - The field number
1623b7e05686SMatthew G. Knepley . g0 - integrand for the test and basis function term
1624b7e05686SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1625b7e05686SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1626b7e05686SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1627b7e05686SMatthew G. Knepley 
1628b7e05686SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1629b7e05686SMatthew G. Knepley 
1630b7e05686SMatthew 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
1631b7e05686SMatthew G. Knepley 
1632b7e05686SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1633b7e05686SMatthew G. Knepley 
1634b7e05686SMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1635b7e05686SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1636b7e05686SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1637b7e05686SMatthew G. Knepley $    PetscReal t, const PetscReal x[], PetscScalar g0[])
1638b7e05686SMatthew G. Knepley 
1639b7e05686SMatthew G. Knepley + dim - the spatial dimension
1640b7e05686SMatthew G. Knepley . Nf - the number of fields
1641b7e05686SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1642b7e05686SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1643b7e05686SMatthew G. Knepley . u - each field evaluated at the current point
1644b7e05686SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1645b7e05686SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1646b7e05686SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1647b7e05686SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1648b7e05686SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1649b7e05686SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1650b7e05686SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1651b7e05686SMatthew G. Knepley . t - current time
1652b7e05686SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1653b7e05686SMatthew G. Knepley . x - coordinates of the current point
165497b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
165597b6e6e8SMatthew G. Knepley . constants - constant parameters
1656b7e05686SMatthew G. Knepley - g0 - output values at the current point
1657b7e05686SMatthew G. Knepley 
1658b7e05686SMatthew G. Knepley   Level: intermediate
1659b7e05686SMatthew G. Knepley 
1660b7e05686SMatthew G. Knepley .seealso: PetscDSGetJacobian()
1661b7e05686SMatthew G. Knepley @*/
1662b7e05686SMatthew G. Knepley PetscErrorCode PetscDSSetDynamicJacobian(PetscDS prob, PetscInt f, PetscInt g,
1663b7e05686SMatthew G. Knepley                                          void (*g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1664b7e05686SMatthew G. Knepley                                                     const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1665b7e05686SMatthew G. Knepley                                                     const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
166697b6e6e8SMatthew G. Knepley                                                     PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
1667b7e05686SMatthew G. Knepley                                          void (*g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1668b7e05686SMatthew G. Knepley                                                     const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1669b7e05686SMatthew G. Knepley                                                     const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
167097b6e6e8SMatthew G. Knepley                                                     PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
1671b7e05686SMatthew G. Knepley                                          void (*g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1672b7e05686SMatthew G. Knepley                                                     const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1673b7e05686SMatthew G. Knepley                                                     const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
167497b6e6e8SMatthew G. Knepley                                                     PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
1675b7e05686SMatthew G. Knepley                                          void (*g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1676b7e05686SMatthew G. Knepley                                                     const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1677b7e05686SMatthew G. Knepley                                                     const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
167897b6e6e8SMatthew G. Knepley                                                     PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
1679b7e05686SMatthew G. Knepley {
1680b7e05686SMatthew G. Knepley   PetscErrorCode ierr;
1681b7e05686SMatthew G. Knepley 
1682b7e05686SMatthew G. Knepley   PetscFunctionBegin;
1683b7e05686SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1684b7e05686SMatthew G. Knepley   if (g0) PetscValidFunction(g0, 4);
1685b7e05686SMatthew G. Knepley   if (g1) PetscValidFunction(g1, 5);
1686b7e05686SMatthew G. Knepley   if (g2) PetscValidFunction(g2, 6);
1687b7e05686SMatthew G. Knepley   if (g3) PetscValidFunction(g3, 7);
1688b7e05686SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
1689b7e05686SMatthew G. Knepley   if (g < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", g);
1690b7e05686SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, PetscMax(f, g)+1);CHKERRQ(ierr);
1691b7e05686SMatthew G. Knepley   prob->gt[(f*prob->Nf + g)*4+0] = g0;
1692b7e05686SMatthew G. Knepley   prob->gt[(f*prob->Nf + g)*4+1] = g1;
1693b7e05686SMatthew G. Knepley   prob->gt[(f*prob->Nf + g)*4+2] = g2;
1694b7e05686SMatthew G. Knepley   prob->gt[(f*prob->Nf + g)*4+3] = g3;
1695b7e05686SMatthew G. Knepley   PetscFunctionReturn(0);
1696b7e05686SMatthew G. Knepley }
1697b7e05686SMatthew G. Knepley 
16980c2f2876SMatthew G. Knepley /*@C
16990c2f2876SMatthew G. Knepley   PetscDSGetRiemannSolver - Returns the Riemann solver for the given field
17000c2f2876SMatthew G. Knepley 
17010c2f2876SMatthew G. Knepley   Not collective
17020c2f2876SMatthew G. Knepley 
17030c2f2876SMatthew G. Knepley   Input Arguments:
17040c2f2876SMatthew G. Knepley + prob - The PetscDS object
17050c2f2876SMatthew G. Knepley - f    - The field number
17060c2f2876SMatthew G. Knepley 
17070c2f2876SMatthew G. Knepley   Output Argument:
17080c2f2876SMatthew G. Knepley . r    - Riemann solver
17090c2f2876SMatthew G. Knepley 
17100c2f2876SMatthew G. Knepley   Calling sequence for r:
17110c2f2876SMatthew G. Knepley 
17125db36cf9SMatthew G. Knepley $ r(PetscInt dim, PetscInt Nf, const PetscReal x[], const PetscReal n[], const PetscScalar uL[], const PetscScalar uR[], PetscScalar flux[], void *ctx)
17130c2f2876SMatthew G. Knepley 
17145db36cf9SMatthew G. Knepley + dim  - The spatial dimension
17155db36cf9SMatthew G. Knepley . Nf   - The number of fields
17165db36cf9SMatthew G. Knepley . x    - The coordinates at a point on the interface
17170c2f2876SMatthew G. Knepley . n    - The normal vector to the interface
17180c2f2876SMatthew G. Knepley . uL   - The state vector to the left of the interface
17190c2f2876SMatthew G. Knepley . uR   - The state vector to the right of the interface
17200c2f2876SMatthew G. Knepley . flux - output array of flux through the interface
172197b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
172297b6e6e8SMatthew G. Knepley . constants - constant parameters
17230c2f2876SMatthew G. Knepley - ctx  - optional user context
17240c2f2876SMatthew G. Knepley 
17250c2f2876SMatthew G. Knepley   Level: intermediate
17260c2f2876SMatthew G. Knepley 
17270c2f2876SMatthew G. Knepley .seealso: PetscDSSetRiemannSolver()
17280c2f2876SMatthew G. Knepley @*/
17290c2f2876SMatthew G. Knepley PetscErrorCode PetscDSGetRiemannSolver(PetscDS prob, PetscInt f,
173097b6e6e8SMatthew 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))
17310c2f2876SMatthew G. Knepley {
17320c2f2876SMatthew G. Knepley   PetscFunctionBegin;
17330c2f2876SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
17340c2f2876SMatthew 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);
17350c2f2876SMatthew G. Knepley   PetscValidPointer(r, 3);
17360c2f2876SMatthew G. Knepley   *r = prob->r[f];
17370c2f2876SMatthew G. Knepley   PetscFunctionReturn(0);
17380c2f2876SMatthew G. Knepley }
17390c2f2876SMatthew G. Knepley 
17400c2f2876SMatthew G. Knepley /*@C
17410c2f2876SMatthew G. Knepley   PetscDSSetRiemannSolver - Sets the Riemann solver for the given field
17420c2f2876SMatthew G. Knepley 
17430c2f2876SMatthew G. Knepley   Not collective
17440c2f2876SMatthew G. Knepley 
17450c2f2876SMatthew G. Knepley   Input Arguments:
17460c2f2876SMatthew G. Knepley + prob - The PetscDS object
17470c2f2876SMatthew G. Knepley . f    - The field number
17480c2f2876SMatthew G. Knepley - r    - Riemann solver
17490c2f2876SMatthew G. Knepley 
17500c2f2876SMatthew G. Knepley   Calling sequence for r:
17510c2f2876SMatthew G. Knepley 
17525db36cf9SMatthew G. Knepley $ r(PetscInt dim, PetscInt Nf, const PetscReal x[], const PetscReal n[], const PetscScalar uL[], const PetscScalar uR[], PetscScalar flux[], void *ctx)
17530c2f2876SMatthew G. Knepley 
17545db36cf9SMatthew G. Knepley + dim  - The spatial dimension
17555db36cf9SMatthew G. Knepley . Nf   - The number of fields
17565db36cf9SMatthew G. Knepley . x    - The coordinates at a point on the interface
17570c2f2876SMatthew G. Knepley . n    - The normal vector to the interface
17580c2f2876SMatthew G. Knepley . uL   - The state vector to the left of the interface
17590c2f2876SMatthew G. Knepley . uR   - The state vector to the right of the interface
17600c2f2876SMatthew G. Knepley . flux - output array of flux through the interface
176197b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
176297b6e6e8SMatthew G. Knepley . constants - constant parameters
17630c2f2876SMatthew G. Knepley - ctx  - optional user context
17640c2f2876SMatthew G. Knepley 
17650c2f2876SMatthew G. Knepley   Level: intermediate
17660c2f2876SMatthew G. Knepley 
17670c2f2876SMatthew G. Knepley .seealso: PetscDSGetRiemannSolver()
17680c2f2876SMatthew G. Knepley @*/
17690c2f2876SMatthew G. Knepley PetscErrorCode PetscDSSetRiemannSolver(PetscDS prob, PetscInt f,
177097b6e6e8SMatthew 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))
17710c2f2876SMatthew G. Knepley {
17720c2f2876SMatthew G. Knepley   PetscErrorCode ierr;
17730c2f2876SMatthew G. Knepley 
17740c2f2876SMatthew G. Knepley   PetscFunctionBegin;
17750c2f2876SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1776de716cbcSToby Isaac   if (r) PetscValidFunction(r, 3);
17770c2f2876SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
17780c2f2876SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
17790c2f2876SMatthew G. Knepley   prob->r[f] = r;
17800c2f2876SMatthew G. Knepley   PetscFunctionReturn(0);
17810c2f2876SMatthew G. Knepley }
17820c2f2876SMatthew G. Knepley 
178332d2bbc9SMatthew G. Knepley /*@C
178432d2bbc9SMatthew G. Knepley   PetscDSGetUpdate - Get the pointwise update function for a given field
178532d2bbc9SMatthew G. Knepley 
178632d2bbc9SMatthew G. Knepley   Not collective
178732d2bbc9SMatthew G. Knepley 
178832d2bbc9SMatthew G. Knepley   Input Parameters:
178932d2bbc9SMatthew G. Knepley + prob - The PetscDS
179032d2bbc9SMatthew G. Knepley - f    - The field number
179132d2bbc9SMatthew G. Knepley 
179232d2bbc9SMatthew G. Knepley   Output Parameters:
179332d2bbc9SMatthew G. Knepley + update - update function
179432d2bbc9SMatthew G. Knepley 
179532d2bbc9SMatthew G. Knepley   Note: The calling sequence for the callback update is given by:
179632d2bbc9SMatthew G. Knepley 
179732d2bbc9SMatthew G. Knepley $ update(PetscInt dim, PetscInt Nf, PetscInt NfAux,
179832d2bbc9SMatthew G. Knepley $        const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
179932d2bbc9SMatthew G. Knepley $        const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
180032d2bbc9SMatthew G. Knepley $        PetscReal t, const PetscReal x[], PetscScalar uNew[])
180132d2bbc9SMatthew G. Knepley 
180232d2bbc9SMatthew G. Knepley + dim - the spatial dimension
180332d2bbc9SMatthew G. Knepley . Nf - the number of fields
180432d2bbc9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
180532d2bbc9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
180632d2bbc9SMatthew G. Knepley . u - each field evaluated at the current point
180732d2bbc9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
180832d2bbc9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
180932d2bbc9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
181032d2bbc9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
181132d2bbc9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
181232d2bbc9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
181332d2bbc9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
181432d2bbc9SMatthew G. Knepley . t - current time
181532d2bbc9SMatthew G. Knepley . x - coordinates of the current point
181632d2bbc9SMatthew G. Knepley - uNew - new value for field at the current point
181732d2bbc9SMatthew G. Knepley 
181832d2bbc9SMatthew G. Knepley   Level: intermediate
181932d2bbc9SMatthew G. Knepley 
182032d2bbc9SMatthew G. Knepley .seealso: PetscDSSetUpdate(), PetscDSSetResidual()
182132d2bbc9SMatthew G. Knepley @*/
182232d2bbc9SMatthew G. Knepley PetscErrorCode PetscDSGetUpdate(PetscDS prob, PetscInt f,
182332d2bbc9SMatthew G. Knepley                                   void (**update)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
182432d2bbc9SMatthew G. Knepley                                                   const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
182532d2bbc9SMatthew G. Knepley                                                   const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
18263fa77dffSMatthew G. Knepley                                                   PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar uNew[]))
182732d2bbc9SMatthew G. Knepley {
182832d2bbc9SMatthew G. Knepley   PetscFunctionBegin;
182932d2bbc9SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
183032d2bbc9SMatthew 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);
183132d2bbc9SMatthew G. Knepley   if (update) {PetscValidPointer(update, 3); *update = prob->update[f];}
183232d2bbc9SMatthew G. Knepley   PetscFunctionReturn(0);
183332d2bbc9SMatthew G. Knepley }
183432d2bbc9SMatthew G. Knepley 
183532d2bbc9SMatthew G. Knepley /*@C
18363fa77dffSMatthew G. Knepley   PetscDSSetUpdate - Set the pointwise update function for a given field
183732d2bbc9SMatthew G. Knepley 
183832d2bbc9SMatthew G. Knepley   Not collective
183932d2bbc9SMatthew G. Knepley 
184032d2bbc9SMatthew G. Knepley   Input Parameters:
184132d2bbc9SMatthew G. Knepley + prob   - The PetscDS
184232d2bbc9SMatthew G. Knepley . f      - The field number
184332d2bbc9SMatthew G. Knepley - update - update function
184432d2bbc9SMatthew G. Knepley 
184532d2bbc9SMatthew G. Knepley   Note: The calling sequence for the callback update is given by:
184632d2bbc9SMatthew G. Knepley 
184732d2bbc9SMatthew G. Knepley $ update(PetscInt dim, PetscInt Nf, PetscInt NfAux,
184832d2bbc9SMatthew G. Knepley $        const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
184932d2bbc9SMatthew G. Knepley $        const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
185032d2bbc9SMatthew G. Knepley $        PetscReal t, const PetscReal x[], PetscScalar uNew[])
185132d2bbc9SMatthew G. Knepley 
185232d2bbc9SMatthew G. Knepley + dim - the spatial dimension
185332d2bbc9SMatthew G. Knepley . Nf - the number of fields
185432d2bbc9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
185532d2bbc9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
185632d2bbc9SMatthew G. Knepley . u - each field evaluated at the current point
185732d2bbc9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
185832d2bbc9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
185932d2bbc9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
186032d2bbc9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
186132d2bbc9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
186232d2bbc9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
186332d2bbc9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
186432d2bbc9SMatthew G. Knepley . t - current time
186532d2bbc9SMatthew G. Knepley . x - coordinates of the current point
186632d2bbc9SMatthew G. Knepley - uNew - new field values at the current point
186732d2bbc9SMatthew G. Knepley 
186832d2bbc9SMatthew G. Knepley   Level: intermediate
186932d2bbc9SMatthew G. Knepley 
187032d2bbc9SMatthew G. Knepley .seealso: PetscDSGetResidual()
187132d2bbc9SMatthew G. Knepley @*/
187232d2bbc9SMatthew G. Knepley PetscErrorCode PetscDSSetUpdate(PetscDS prob, PetscInt f,
187332d2bbc9SMatthew G. Knepley                                 void (*update)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
187432d2bbc9SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
187532d2bbc9SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
18763fa77dffSMatthew G. Knepley                                                PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar uNew[]))
187732d2bbc9SMatthew G. Knepley {
187832d2bbc9SMatthew G. Knepley   PetscErrorCode ierr;
187932d2bbc9SMatthew G. Knepley 
188032d2bbc9SMatthew G. Knepley   PetscFunctionBegin;
188132d2bbc9SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
188232d2bbc9SMatthew G. Knepley   if (update) PetscValidFunction(update, 3);
188332d2bbc9SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
188432d2bbc9SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
188532d2bbc9SMatthew G. Knepley   prob->update[f] = update;
188632d2bbc9SMatthew G. Knepley   PetscFunctionReturn(0);
188732d2bbc9SMatthew G. Knepley }
188832d2bbc9SMatthew G. Knepley 
18890c2f2876SMatthew G. Knepley PetscErrorCode PetscDSGetContext(PetscDS prob, PetscInt f, void **ctx)
18900c2f2876SMatthew G. Knepley {
18910c2f2876SMatthew G. Knepley   PetscFunctionBegin;
18920c2f2876SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
18930c2f2876SMatthew 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);
18940c2f2876SMatthew G. Knepley   PetscValidPointer(ctx, 3);
18950c2f2876SMatthew G. Knepley   *ctx = prob->ctx[f];
18960c2f2876SMatthew G. Knepley   PetscFunctionReturn(0);
18970c2f2876SMatthew G. Knepley }
18980c2f2876SMatthew G. Knepley 
18990c2f2876SMatthew G. Knepley PetscErrorCode PetscDSSetContext(PetscDS prob, PetscInt f, void *ctx)
19000c2f2876SMatthew G. Knepley {
19010c2f2876SMatthew G. Knepley   PetscErrorCode ierr;
19020c2f2876SMatthew G. Knepley 
19030c2f2876SMatthew G. Knepley   PetscFunctionBegin;
19040c2f2876SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
19050c2f2876SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
19060c2f2876SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
19070c2f2876SMatthew G. Knepley   prob->ctx[f] = ctx;
19080c2f2876SMatthew G. Knepley   PetscFunctionReturn(0);
19090c2f2876SMatthew G. Knepley }
19100c2f2876SMatthew G. Knepley 
1911194d53e6SMatthew G. Knepley /*@C
1912194d53e6SMatthew G. Knepley   PetscDSGetBdResidual - Get the pointwise boundary residual function for a given test field
1913194d53e6SMatthew G. Knepley 
1914194d53e6SMatthew G. Knepley   Not collective
1915194d53e6SMatthew G. Knepley 
1916194d53e6SMatthew G. Knepley   Input Parameters:
1917194d53e6SMatthew G. Knepley + prob - The PetscDS
1918194d53e6SMatthew G. Knepley - f    - The test field number
1919194d53e6SMatthew G. Knepley 
1920194d53e6SMatthew G. Knepley   Output Parameters:
1921194d53e6SMatthew G. Knepley + f0 - boundary integrand for the test function term
1922194d53e6SMatthew G. Knepley - f1 - boundary integrand for the test function gradient term
1923194d53e6SMatthew G. Knepley 
1924194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1925194d53e6SMatthew G. Knepley 
1926194d53e6SMatthew 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
1927194d53e6SMatthew G. Knepley 
1928194d53e6SMatthew G. Knepley The calling sequence for the callbacks f0 and f1 is given by:
1929194d53e6SMatthew G. Knepley 
193030b9ff8bSMatthew G. Knepley $ f0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1931194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1932194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
193330b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar f0[])
1934194d53e6SMatthew G. Knepley 
1935194d53e6SMatthew G. Knepley + dim - the spatial dimension
1936194d53e6SMatthew G. Knepley . Nf - the number of fields
1937194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1938194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1939194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
1940194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1941194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1942194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1943194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1944194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1945194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1946194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1947194d53e6SMatthew G. Knepley . t - current time
1948194d53e6SMatthew G. Knepley . x - coordinates of the current point
1949194d53e6SMatthew G. Knepley . n - unit normal at the current point
195097b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
195197b6e6e8SMatthew G. Knepley . constants - constant parameters
1952194d53e6SMatthew G. Knepley - f0 - output values at the current point
1953194d53e6SMatthew G. Knepley 
1954194d53e6SMatthew G. Knepley   Level: intermediate
1955194d53e6SMatthew G. Knepley 
1956194d53e6SMatthew G. Knepley .seealso: PetscDSSetBdResidual()
1957194d53e6SMatthew G. Knepley @*/
19582764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetBdResidual(PetscDS prob, PetscInt f,
195930b9ff8bSMatthew G. Knepley                                     void (**f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1960194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1961194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
196297b6e6e8SMatthew G. Knepley                                                 PetscReal t, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f0[]),
196330b9ff8bSMatthew G. Knepley                                     void (**f1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1964194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1965194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
196697b6e6e8SMatthew G. Knepley                                                 PetscReal t, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f1[]))
19672764a2aaSMatthew G. Knepley {
19682764a2aaSMatthew G. Knepley   PetscFunctionBegin;
19692764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
19702764a2aaSMatthew 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);
19712764a2aaSMatthew G. Knepley   if (f0) {PetscValidPointer(f0, 3); *f0 = prob->fBd[f*2+0];}
19722764a2aaSMatthew G. Knepley   if (f1) {PetscValidPointer(f1, 4); *f1 = prob->fBd[f*2+1];}
19732764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
19742764a2aaSMatthew G. Knepley }
19752764a2aaSMatthew G. Knepley 
1976194d53e6SMatthew G. Knepley /*@C
1977194d53e6SMatthew G. Knepley   PetscDSSetBdResidual - Get the pointwise boundary residual function for a given test field
1978194d53e6SMatthew G. Knepley 
1979194d53e6SMatthew G. Knepley   Not collective
1980194d53e6SMatthew G. Knepley 
1981194d53e6SMatthew G. Knepley   Input Parameters:
1982194d53e6SMatthew G. Knepley + prob - The PetscDS
1983194d53e6SMatthew G. Knepley . f    - The test field number
1984194d53e6SMatthew G. Knepley . f0 - boundary integrand for the test function term
1985194d53e6SMatthew G. Knepley - f1 - boundary integrand for the test function gradient term
1986194d53e6SMatthew G. Knepley 
1987194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1988194d53e6SMatthew G. Knepley 
1989194d53e6SMatthew 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
1990194d53e6SMatthew G. Knepley 
1991194d53e6SMatthew G. Knepley The calling sequence for the callbacks f0 and f1 is given by:
1992194d53e6SMatthew G. Knepley 
199330b9ff8bSMatthew G. Knepley $ f0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1994194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1995194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
199630b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar f0[])
1997194d53e6SMatthew G. Knepley 
1998194d53e6SMatthew G. Knepley + dim - the spatial dimension
1999194d53e6SMatthew G. Knepley . Nf - the number of fields
2000194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
2001194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
2002194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
2003194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
2004194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
2005194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
2006194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
2007194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
2008194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
2009194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
2010194d53e6SMatthew G. Knepley . t - current time
2011194d53e6SMatthew G. Knepley . x - coordinates of the current point
2012194d53e6SMatthew G. Knepley . n - unit normal at the current point
201397b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
201497b6e6e8SMatthew G. Knepley . constants - constant parameters
2015194d53e6SMatthew G. Knepley - f0 - output values at the current point
2016194d53e6SMatthew G. Knepley 
2017194d53e6SMatthew G. Knepley   Level: intermediate
2018194d53e6SMatthew G. Knepley 
2019194d53e6SMatthew G. Knepley .seealso: PetscDSGetBdResidual()
2020194d53e6SMatthew G. Knepley @*/
20212764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetBdResidual(PetscDS prob, PetscInt f,
202230b9ff8bSMatthew G. Knepley                                     void (*f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2023194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2024194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
202597b6e6e8SMatthew G. Knepley                                                PetscReal t, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f0[]),
202630b9ff8bSMatthew G. Knepley                                     void (*f1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2027194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2028194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
202997b6e6e8SMatthew G. Knepley                                                PetscReal t, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f1[]))
20302764a2aaSMatthew G. Knepley {
20312764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
20322764a2aaSMatthew G. Knepley 
20332764a2aaSMatthew G. Knepley   PetscFunctionBegin;
20342764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
20352764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
20362764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
20372764a2aaSMatthew G. Knepley   if (f0) {PetscValidFunction(f0, 3); prob->fBd[f*2+0] = f0;}
20382764a2aaSMatthew G. Knepley   if (f1) {PetscValidFunction(f1, 4); prob->fBd[f*2+1] = f1;}
20392764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
20402764a2aaSMatthew G. Knepley }
20412764a2aaSMatthew G. Knepley 
2042194d53e6SMatthew G. Knepley /*@C
2043194d53e6SMatthew G. Knepley   PetscDSGetBdJacobian - Get the pointwise boundary Jacobian function for given test and basis field
2044194d53e6SMatthew G. Knepley 
2045194d53e6SMatthew G. Knepley   Not collective
2046194d53e6SMatthew G. Knepley 
2047194d53e6SMatthew G. Knepley   Input Parameters:
2048194d53e6SMatthew G. Knepley + prob - The PetscDS
2049194d53e6SMatthew G. Knepley . f    - The test field number
2050194d53e6SMatthew G. Knepley - g    - The field number
2051194d53e6SMatthew G. Knepley 
2052194d53e6SMatthew G. Knepley   Output Parameters:
2053194d53e6SMatthew G. Knepley + g0 - integrand for the test and basis function term
2054194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
2055194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
2056194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
2057194d53e6SMatthew G. Knepley 
2058194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
2059194d53e6SMatthew G. Knepley 
2060194d53e6SMatthew 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
2061194d53e6SMatthew G. Knepley 
2062194d53e6SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
2063194d53e6SMatthew G. Knepley 
206430b9ff8bSMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2065194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2066194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
206730b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar g0[])
2068194d53e6SMatthew G. Knepley 
2069194d53e6SMatthew G. Knepley + dim - the spatial dimension
2070194d53e6SMatthew G. Knepley . Nf - the number of fields
2071194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
2072194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
2073194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
2074194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
2075194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
2076194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
2077194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
2078194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
2079194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
2080194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
2081194d53e6SMatthew G. Knepley . t - current time
20822aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
2083194d53e6SMatthew G. Knepley . x - coordinates of the current point
2084194d53e6SMatthew G. Knepley . n - normal at the current point
208597b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
208697b6e6e8SMatthew G. Knepley . constants - constant parameters
2087194d53e6SMatthew G. Knepley - g0 - output values at the current point
2088194d53e6SMatthew G. Knepley 
2089194d53e6SMatthew G. Knepley   Level: intermediate
2090194d53e6SMatthew G. Knepley 
2091194d53e6SMatthew G. Knepley .seealso: PetscDSSetBdJacobian()
2092194d53e6SMatthew G. Knepley @*/
20932764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetBdJacobian(PetscDS prob, PetscInt f, PetscInt g,
209430b9ff8bSMatthew G. Knepley                                     void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2095194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2096194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
209797b6e6e8SMatthew G. Knepley                                                 PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
209830b9ff8bSMatthew G. Knepley                                     void (**g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2099194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2100194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
210197b6e6e8SMatthew G. Knepley                                                 PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
210230b9ff8bSMatthew G. Knepley                                     void (**g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2103194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2104194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
210597b6e6e8SMatthew G. Knepley                                                 PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
210630b9ff8bSMatthew G. Knepley                                     void (**g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2107194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2108194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
210997b6e6e8SMatthew G. Knepley                                                 PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
21102764a2aaSMatthew G. Knepley {
21112764a2aaSMatthew G. Knepley   PetscFunctionBegin;
21122764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
21132764a2aaSMatthew 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);
21142764a2aaSMatthew 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);
21152764a2aaSMatthew G. Knepley   if (g0) {PetscValidPointer(g0, 4); *g0 = prob->gBd[(f*prob->Nf + g)*4+0];}
21162764a2aaSMatthew G. Knepley   if (g1) {PetscValidPointer(g1, 5); *g1 = prob->gBd[(f*prob->Nf + g)*4+1];}
21172764a2aaSMatthew G. Knepley   if (g2) {PetscValidPointer(g2, 6); *g2 = prob->gBd[(f*prob->Nf + g)*4+2];}
21182764a2aaSMatthew G. Knepley   if (g3) {PetscValidPointer(g3, 7); *g3 = prob->gBd[(f*prob->Nf + g)*4+3];}
21192764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
21202764a2aaSMatthew G. Knepley }
21212764a2aaSMatthew G. Knepley 
2122194d53e6SMatthew G. Knepley /*@C
2123194d53e6SMatthew G. Knepley   PetscDSSetBdJacobian - Set the pointwise boundary Jacobian function for given test and basis field
2124194d53e6SMatthew G. Knepley 
2125194d53e6SMatthew G. Knepley   Not collective
2126194d53e6SMatthew G. Knepley 
2127194d53e6SMatthew G. Knepley   Input Parameters:
2128194d53e6SMatthew G. Knepley + prob - The PetscDS
2129194d53e6SMatthew G. Knepley . f    - The test field number
2130194d53e6SMatthew G. Knepley . g    - The field number
2131194d53e6SMatthew G. Knepley . g0 - integrand for the test and basis function term
2132194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
2133194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
2134194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
2135194d53e6SMatthew G. Knepley 
2136194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
2137194d53e6SMatthew G. Knepley 
2138194d53e6SMatthew 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
2139194d53e6SMatthew G. Knepley 
2140194d53e6SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
2141194d53e6SMatthew G. Knepley 
214230b9ff8bSMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2143194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2144194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
214530b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar g0[])
2146194d53e6SMatthew G. Knepley 
2147194d53e6SMatthew G. Knepley + dim - the spatial dimension
2148194d53e6SMatthew G. Knepley . Nf - the number of fields
2149194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
2150194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
2151194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
2152194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
2153194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
2154194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
2155194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
2156194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
2157194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
2158194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
2159194d53e6SMatthew G. Knepley . t - current time
21602aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
2161194d53e6SMatthew G. Knepley . x - coordinates of the current point
2162194d53e6SMatthew G. Knepley . n - normal at the current point
216397b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
216497b6e6e8SMatthew G. Knepley . constants - constant parameters
2165194d53e6SMatthew G. Knepley - g0 - output values at the current point
2166194d53e6SMatthew G. Knepley 
2167194d53e6SMatthew G. Knepley   Level: intermediate
2168194d53e6SMatthew G. Knepley 
2169194d53e6SMatthew G. Knepley .seealso: PetscDSGetBdJacobian()
2170194d53e6SMatthew G. Knepley @*/
21712764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetBdJacobian(PetscDS prob, PetscInt f, PetscInt g,
217230b9ff8bSMatthew G. Knepley                                     void (*g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2173194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2174194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
217597b6e6e8SMatthew G. Knepley                                                PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
217630b9ff8bSMatthew G. Knepley                                     void (*g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2177194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2178194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
217997b6e6e8SMatthew G. Knepley                                                PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
218030b9ff8bSMatthew G. Knepley                                     void (*g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2181194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2182194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
218397b6e6e8SMatthew G. Knepley                                                PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
218430b9ff8bSMatthew G. Knepley                                     void (*g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2185194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2186194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
218797b6e6e8SMatthew G. Knepley                                                PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
21882764a2aaSMatthew G. Knepley {
21892764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
21902764a2aaSMatthew G. Knepley 
21912764a2aaSMatthew G. Knepley   PetscFunctionBegin;
21922764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
21932764a2aaSMatthew G. Knepley   if (g0) PetscValidFunction(g0, 4);
21942764a2aaSMatthew G. Knepley   if (g1) PetscValidFunction(g1, 5);
21952764a2aaSMatthew G. Knepley   if (g2) PetscValidFunction(g2, 6);
21962764a2aaSMatthew G. Knepley   if (g3) PetscValidFunction(g3, 7);
21972764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
21982764a2aaSMatthew G. Knepley   if (g < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", g);
21992764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, PetscMax(f, g)+1);CHKERRQ(ierr);
22002764a2aaSMatthew G. Knepley   prob->gBd[(f*prob->Nf + g)*4+0] = g0;
22012764a2aaSMatthew G. Knepley   prob->gBd[(f*prob->Nf + g)*4+1] = g1;
22022764a2aaSMatthew G. Knepley   prob->gBd[(f*prob->Nf + g)*4+2] = g2;
22032764a2aaSMatthew G. Knepley   prob->gBd[(f*prob->Nf + g)*4+3] = g3;
22042764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
22052764a2aaSMatthew G. Knepley }
22062764a2aaSMatthew G. Knepley 
22070d3e9b51SMatthew G. Knepley /*@C
2208c371a6d1SMatthew G. Knepley   PetscDSGetExactSolution - Get the pointwise exact solution function for a given test field
2209c371a6d1SMatthew G. Knepley 
2210c371a6d1SMatthew G. Knepley   Not collective
2211c371a6d1SMatthew G. Knepley 
2212c371a6d1SMatthew G. Knepley   Input Parameters:
2213c371a6d1SMatthew G. Knepley + prob - The PetscDS
2214c371a6d1SMatthew G. Knepley - f    - The test field number
2215c371a6d1SMatthew G. Knepley 
2216c371a6d1SMatthew G. Knepley   Output Parameter:
221795cbbfd3SMatthew G. Knepley + exactSol - exact solution for the test field
221895cbbfd3SMatthew G. Knepley - exactCtx - exact solution context
2219c371a6d1SMatthew G. Knepley 
2220c371a6d1SMatthew G. Knepley   Note: The calling sequence for the solution functions is given by:
2221c371a6d1SMatthew G. Knepley 
2222c371a6d1SMatthew G. Knepley $ sol(PetscInt dim, PetscReal t, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx)
2223c371a6d1SMatthew G. Knepley 
2224c371a6d1SMatthew G. Knepley + dim - the spatial dimension
2225c371a6d1SMatthew G. Knepley . t - current time
2226c371a6d1SMatthew G. Knepley . x - coordinates of the current point
2227c371a6d1SMatthew G. Knepley . Nc - the number of field components
2228c371a6d1SMatthew G. Knepley . u - the solution field evaluated at the current point
2229c371a6d1SMatthew G. Knepley - ctx - a user context
2230c371a6d1SMatthew G. Knepley 
2231c371a6d1SMatthew G. Knepley   Level: intermediate
2232c371a6d1SMatthew G. Knepley 
2233c371a6d1SMatthew G. Knepley .seealso: PetscDSSetExactSolution()
2234c371a6d1SMatthew G. Knepley @*/
223595cbbfd3SMatthew 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)
2236c371a6d1SMatthew G. Knepley {
2237c371a6d1SMatthew G. Knepley   PetscFunctionBegin;
2238c371a6d1SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2239c371a6d1SMatthew 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);
2240c371a6d1SMatthew G. Knepley   if (sol) {PetscValidPointer(sol, 3); *sol = prob->exactSol[f];}
224195cbbfd3SMatthew G. Knepley   if (ctx) {PetscValidPointer(ctx, 4); *ctx = prob->exactCtx[f];}
2242c371a6d1SMatthew G. Knepley   PetscFunctionReturn(0);
2243c371a6d1SMatthew G. Knepley }
2244c371a6d1SMatthew G. Knepley 
2245c371a6d1SMatthew G. Knepley /*@C
2246578a5ef5SMatthew Knepley   PetscDSSetExactSolution - Set the pointwise exact solution function for a given test field
2247c371a6d1SMatthew G. Knepley 
2248c371a6d1SMatthew G. Knepley   Not collective
2249c371a6d1SMatthew G. Knepley 
2250c371a6d1SMatthew G. Knepley   Input Parameters:
2251c371a6d1SMatthew G. Knepley + prob - The PetscDS
2252c371a6d1SMatthew G. Knepley . f    - The test field number
225395cbbfd3SMatthew G. Knepley . sol  - solution function for the test fields
225495cbbfd3SMatthew G. Knepley - ctx  - solution context or NULL
2255c371a6d1SMatthew G. Knepley 
2256c371a6d1SMatthew G. Knepley   Note: The calling sequence for solution functions is given by:
2257c371a6d1SMatthew G. Knepley 
2258c371a6d1SMatthew G. Knepley $ sol(PetscInt dim, PetscReal t, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx)
2259c371a6d1SMatthew G. Knepley 
2260c371a6d1SMatthew G. Knepley + dim - the spatial dimension
2261c371a6d1SMatthew G. Knepley . t - current time
2262c371a6d1SMatthew G. Knepley . x - coordinates of the current point
2263c371a6d1SMatthew G. Knepley . Nc - the number of field components
2264c371a6d1SMatthew G. Knepley . u - the solution field evaluated at the current point
2265c371a6d1SMatthew G. Knepley - ctx - a user context
2266c371a6d1SMatthew G. Knepley 
2267c371a6d1SMatthew G. Knepley   Level: intermediate
2268c371a6d1SMatthew G. Knepley 
2269c371a6d1SMatthew G. Knepley .seealso: PetscDSGetExactSolution()
2270c371a6d1SMatthew G. Knepley @*/
227195cbbfd3SMatthew 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)
2272c371a6d1SMatthew G. Knepley {
2273c371a6d1SMatthew G. Knepley   PetscErrorCode ierr;
2274c371a6d1SMatthew G. Knepley 
2275c371a6d1SMatthew G. Knepley   PetscFunctionBegin;
2276c371a6d1SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2277c371a6d1SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
2278c371a6d1SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
2279c371a6d1SMatthew G. Knepley   if (sol) {PetscValidFunction(sol, 3); prob->exactSol[f] = sol;}
228095cbbfd3SMatthew G. Knepley   if (ctx) {PetscValidFunction(ctx, 4); prob->exactCtx[f] = ctx;}
2281c371a6d1SMatthew G. Knepley   PetscFunctionReturn(0);
2282c371a6d1SMatthew G. Knepley }
2283c371a6d1SMatthew G. Knepley 
22845638fd0eSMatthew G. Knepley /*@C
228597b6e6e8SMatthew G. Knepley   PetscDSGetConstants - Returns the array of constants passed to point functions
228697b6e6e8SMatthew G. Knepley 
228797b6e6e8SMatthew G. Knepley   Not collective
228897b6e6e8SMatthew G. Knepley 
228997b6e6e8SMatthew G. Knepley   Input Parameter:
229097b6e6e8SMatthew G. Knepley . prob - The PetscDS object
229197b6e6e8SMatthew G. Knepley 
229297b6e6e8SMatthew G. Knepley   Output Parameters:
229397b6e6e8SMatthew G. Knepley + numConstants - The number of constants
229497b6e6e8SMatthew G. Knepley - constants    - The array of constants, NULL if there are none
229597b6e6e8SMatthew G. Knepley 
229697b6e6e8SMatthew G. Knepley   Level: intermediate
229797b6e6e8SMatthew G. Knepley 
229897b6e6e8SMatthew G. Knepley .seealso: PetscDSSetConstants(), PetscDSCreate()
229997b6e6e8SMatthew G. Knepley @*/
230097b6e6e8SMatthew G. Knepley PetscErrorCode PetscDSGetConstants(PetscDS prob, PetscInt *numConstants, const PetscScalar *constants[])
230197b6e6e8SMatthew G. Knepley {
230297b6e6e8SMatthew G. Knepley   PetscFunctionBegin;
230397b6e6e8SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
230497b6e6e8SMatthew G. Knepley   if (numConstants) {PetscValidPointer(numConstants, 2); *numConstants = prob->numConstants;}
230597b6e6e8SMatthew G. Knepley   if (constants)    {PetscValidPointer(constants, 3);    *constants    = prob->constants;}
230697b6e6e8SMatthew G. Knepley   PetscFunctionReturn(0);
230797b6e6e8SMatthew G. Knepley }
230897b6e6e8SMatthew G. Knepley 
23090d3e9b51SMatthew G. Knepley /*@C
231097b6e6e8SMatthew G. Knepley   PetscDSSetConstants - Set the array of constants passed to point functions
231197b6e6e8SMatthew G. Knepley 
231297b6e6e8SMatthew G. Knepley   Not collective
231397b6e6e8SMatthew G. Knepley 
231497b6e6e8SMatthew G. Knepley   Input Parameters:
231597b6e6e8SMatthew G. Knepley + prob         - The PetscDS object
231697b6e6e8SMatthew G. Knepley . numConstants - The number of constants
231797b6e6e8SMatthew G. Knepley - constants    - The array of constants, NULL if there are none
231897b6e6e8SMatthew G. Knepley 
231997b6e6e8SMatthew G. Knepley   Level: intermediate
232097b6e6e8SMatthew G. Knepley 
232197b6e6e8SMatthew G. Knepley .seealso: PetscDSGetConstants(), PetscDSCreate()
232297b6e6e8SMatthew G. Knepley @*/
232397b6e6e8SMatthew G. Knepley PetscErrorCode PetscDSSetConstants(PetscDS prob, PetscInt numConstants, PetscScalar constants[])
232497b6e6e8SMatthew G. Knepley {
232597b6e6e8SMatthew G. Knepley   PetscErrorCode ierr;
232697b6e6e8SMatthew G. Knepley 
232797b6e6e8SMatthew G. Knepley   PetscFunctionBegin;
232897b6e6e8SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
232997b6e6e8SMatthew G. Knepley   if (numConstants != prob->numConstants) {
233097b6e6e8SMatthew G. Knepley     ierr = PetscFree(prob->constants);CHKERRQ(ierr);
233197b6e6e8SMatthew G. Knepley     prob->numConstants = numConstants;
233297b6e6e8SMatthew G. Knepley     if (prob->numConstants) {
233397b6e6e8SMatthew G. Knepley       ierr = PetscMalloc1(prob->numConstants, &prob->constants);CHKERRQ(ierr);
233420be0f5bSMatthew G. Knepley     } else {
233520be0f5bSMatthew G. Knepley       prob->constants = NULL;
233620be0f5bSMatthew G. Knepley     }
233720be0f5bSMatthew G. Knepley   }
233820be0f5bSMatthew G. Knepley   if (prob->numConstants) {
233920be0f5bSMatthew G. Knepley     PetscValidPointer(constants, 3);
234097b6e6e8SMatthew G. Knepley     ierr = PetscMemcpy(prob->constants, constants, prob->numConstants * sizeof(PetscScalar));CHKERRQ(ierr);
234197b6e6e8SMatthew G. Knepley   }
234297b6e6e8SMatthew G. Knepley   PetscFunctionReturn(0);
234397b6e6e8SMatthew G. Knepley }
234497b6e6e8SMatthew G. Knepley 
23454cd1e086SMatthew G. Knepley /*@
23464cd1e086SMatthew G. Knepley   PetscDSGetFieldIndex - Returns the index of the given field
23474cd1e086SMatthew G. Knepley 
23484cd1e086SMatthew G. Knepley   Not collective
23494cd1e086SMatthew G. Knepley 
23504cd1e086SMatthew G. Knepley   Input Parameters:
23514cd1e086SMatthew G. Knepley + prob - The PetscDS object
23524cd1e086SMatthew G. Knepley - disc - The discretization object
23534cd1e086SMatthew G. Knepley 
23544cd1e086SMatthew G. Knepley   Output Parameter:
23554cd1e086SMatthew G. Knepley . f - The field number
23564cd1e086SMatthew G. Knepley 
23574cd1e086SMatthew G. Knepley   Level: beginner
23584cd1e086SMatthew G. Knepley 
2359f744cafaSSander Arens .seealso: PetscGetDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
23604cd1e086SMatthew G. Knepley @*/
23614cd1e086SMatthew G. Knepley PetscErrorCode PetscDSGetFieldIndex(PetscDS prob, PetscObject disc, PetscInt *f)
23624cd1e086SMatthew G. Knepley {
23634cd1e086SMatthew G. Knepley   PetscInt g;
23644cd1e086SMatthew G. Knepley 
23654cd1e086SMatthew G. Knepley   PetscFunctionBegin;
23664cd1e086SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
23674cd1e086SMatthew G. Knepley   PetscValidPointer(f, 3);
23684cd1e086SMatthew G. Knepley   *f = -1;
23694cd1e086SMatthew G. Knepley   for (g = 0; g < prob->Nf; ++g) {if (disc == prob->disc[g]) break;}
23704cd1e086SMatthew G. Knepley   if (g == prob->Nf) SETERRQ(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Field not found in PetscDS.");
23714cd1e086SMatthew G. Knepley   *f = g;
23724cd1e086SMatthew G. Knepley   PetscFunctionReturn(0);
23734cd1e086SMatthew G. Knepley }
23744cd1e086SMatthew G. Knepley 
23754cd1e086SMatthew G. Knepley /*@
23764cd1e086SMatthew G. Knepley   PetscDSGetFieldSize - Returns the size of the given field in the full space basis
23774cd1e086SMatthew G. Knepley 
23784cd1e086SMatthew G. Knepley   Not collective
23794cd1e086SMatthew G. Knepley 
23804cd1e086SMatthew G. Knepley   Input Parameters:
23814cd1e086SMatthew G. Knepley + prob - The PetscDS object
23824cd1e086SMatthew G. Knepley - f - The field number
23834cd1e086SMatthew G. Knepley 
23844cd1e086SMatthew G. Knepley   Output Parameter:
23854cd1e086SMatthew G. Knepley . size - The size
23864cd1e086SMatthew G. Knepley 
23874cd1e086SMatthew G. Knepley   Level: beginner
23884cd1e086SMatthew G. Knepley 
2389f744cafaSSander Arens .seealso: PetscDSGetFieldOffset(), PetscDSGetNumFields(), PetscDSCreate()
23904cd1e086SMatthew G. Knepley @*/
23914cd1e086SMatthew G. Knepley PetscErrorCode PetscDSGetFieldSize(PetscDS prob, PetscInt f, PetscInt *size)
23924cd1e086SMatthew G. Knepley {
23932166fd64SMatthew G. Knepley   PetscErrorCode ierr;
23942166fd64SMatthew G. Knepley 
23954cd1e086SMatthew G. Knepley   PetscFunctionBegin;
23964cd1e086SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
23974cd1e086SMatthew G. Knepley   PetscValidPointer(size, 3);
23984cd1e086SMatthew 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);
23992166fd64SMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
2400d4742ddaSMatthew G. Knepley   *size = prob->Nb[f];
24014cd1e086SMatthew G. Knepley   PetscFunctionReturn(0);
24024cd1e086SMatthew G. Knepley }
24034cd1e086SMatthew G. Knepley 
2404bc4ae4beSMatthew G. Knepley /*@
2405bc4ae4beSMatthew G. Knepley   PetscDSGetFieldOffset - Returns the offset of the given field in the full space basis
2406bc4ae4beSMatthew G. Knepley 
2407bc4ae4beSMatthew G. Knepley   Not collective
2408bc4ae4beSMatthew G. Knepley 
2409bc4ae4beSMatthew G. Knepley   Input Parameters:
2410bc4ae4beSMatthew G. Knepley + prob - The PetscDS object
2411bc4ae4beSMatthew G. Knepley - f - The field number
2412bc4ae4beSMatthew G. Knepley 
2413bc4ae4beSMatthew G. Knepley   Output Parameter:
2414bc4ae4beSMatthew G. Knepley . off - The offset
2415bc4ae4beSMatthew G. Knepley 
2416bc4ae4beSMatthew G. Knepley   Level: beginner
2417bc4ae4beSMatthew G. Knepley 
2418f744cafaSSander Arens .seealso: PetscDSGetFieldSize(), PetscDSGetNumFields(), PetscDSCreate()
2419bc4ae4beSMatthew G. Knepley @*/
24202764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetFieldOffset(PetscDS prob, PetscInt f, PetscInt *off)
24212764a2aaSMatthew G. Knepley {
24224cd1e086SMatthew G. Knepley   PetscInt       size, g;
24232764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
24242764a2aaSMatthew G. Knepley 
24252764a2aaSMatthew G. Knepley   PetscFunctionBegin;
24262764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
24272764a2aaSMatthew G. Knepley   PetscValidPointer(off, 3);
24282764a2aaSMatthew 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);
24292764a2aaSMatthew G. Knepley   *off = 0;
24302764a2aaSMatthew G. Knepley   for (g = 0; g < f; ++g) {
24314cd1e086SMatthew G. Knepley     ierr = PetscDSGetFieldSize(prob, g, &size);CHKERRQ(ierr);
24324cd1e086SMatthew G. Knepley     *off += size;
24332764a2aaSMatthew G. Knepley   }
24342764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
24352764a2aaSMatthew G. Knepley }
24362764a2aaSMatthew G. Knepley 
2437bc4ae4beSMatthew G. Knepley /*@
243847e57110SSander Arens   PetscDSGetDimensions - Returns the size of the approximation space for each field on an evaluation point
2439bc4ae4beSMatthew G. Knepley 
2440bc4ae4beSMatthew G. Knepley   Not collective
2441bc4ae4beSMatthew G. Knepley 
244247e57110SSander Arens   Input Parameter:
244347e57110SSander Arens . prob - The PetscDS object
2444bc4ae4beSMatthew G. Knepley 
2445bc4ae4beSMatthew G. Knepley   Output Parameter:
244647e57110SSander Arens . dimensions - The number of dimensions
2447bc4ae4beSMatthew G. Knepley 
2448bc4ae4beSMatthew G. Knepley   Level: beginner
2449bc4ae4beSMatthew G. Knepley 
245047e57110SSander Arens .seealso: PetscDSGetComponentOffsets(), PetscDSGetNumFields(), PetscDSCreate()
2451bc4ae4beSMatthew G. Knepley @*/
245247e57110SSander Arens PetscErrorCode PetscDSGetDimensions(PetscDS prob, PetscInt *dimensions[])
24532764a2aaSMatthew G. Knepley {
24542764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
24552764a2aaSMatthew G. Knepley 
24562764a2aaSMatthew G. Knepley   PetscFunctionBegin;
24572764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
245847e57110SSander Arens   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
245947e57110SSander Arens   PetscValidPointer(dimensions, 2);
246047e57110SSander Arens   *dimensions = prob->Nb;
246147e57110SSander Arens   PetscFunctionReturn(0);
24626ce16762SMatthew G. Knepley }
246347e57110SSander Arens 
246447e57110SSander Arens /*@
246547e57110SSander Arens   PetscDSGetComponents - Returns the number of components for each field on an evaluation point
246647e57110SSander Arens 
246747e57110SSander Arens   Not collective
246847e57110SSander Arens 
246947e57110SSander Arens   Input Parameter:
247047e57110SSander Arens . prob - The PetscDS object
247147e57110SSander Arens 
247247e57110SSander Arens   Output Parameter:
247347e57110SSander Arens . components - The number of components
247447e57110SSander Arens 
247547e57110SSander Arens   Level: beginner
247647e57110SSander Arens 
247747e57110SSander Arens .seealso: PetscDSGetComponentOffsets(), PetscDSGetNumFields(), PetscDSCreate()
247847e57110SSander Arens @*/
247947e57110SSander Arens PetscErrorCode PetscDSGetComponents(PetscDS prob, PetscInt *components[])
248047e57110SSander Arens {
248147e57110SSander Arens   PetscErrorCode ierr;
248247e57110SSander Arens 
248347e57110SSander Arens   PetscFunctionBegin;
248447e57110SSander Arens   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
248547e57110SSander Arens   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
248647e57110SSander Arens   PetscValidPointer(components, 2);
248747e57110SSander Arens   *components = prob->Nc;
24886ce16762SMatthew G. Knepley   PetscFunctionReturn(0);
24896ce16762SMatthew G. Knepley }
24906ce16762SMatthew G. Knepley 
24916ce16762SMatthew G. Knepley /*@
24926ce16762SMatthew G. Knepley   PetscDSGetComponentOffset - Returns the offset of the given field on an evaluation point
24936ce16762SMatthew G. Knepley 
24946ce16762SMatthew G. Knepley   Not collective
24956ce16762SMatthew G. Knepley 
24966ce16762SMatthew G. Knepley   Input Parameters:
24976ce16762SMatthew G. Knepley + prob - The PetscDS object
24986ce16762SMatthew G. Knepley - f - The field number
24996ce16762SMatthew G. Knepley 
25006ce16762SMatthew G. Knepley   Output Parameter:
25016ce16762SMatthew G. Knepley . off - The offset
25026ce16762SMatthew G. Knepley 
25036ce16762SMatthew G. Knepley   Level: beginner
25046ce16762SMatthew G. Knepley 
2505f744cafaSSander Arens .seealso: PetscDSGetNumFields(), PetscDSCreate()
25066ce16762SMatthew G. Knepley @*/
25076ce16762SMatthew G. Knepley PetscErrorCode PetscDSGetComponentOffset(PetscDS prob, PetscInt f, PetscInt *off)
25086ce16762SMatthew G. Knepley {
25096ce16762SMatthew G. Knepley   PetscFunctionBegin;
25106ce16762SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
25116ce16762SMatthew G. Knepley   PetscValidPointer(off, 3);
25126ce16762SMatthew 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);
251347e57110SSander Arens   *off = prob->off[f];
25142764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
25152764a2aaSMatthew G. Knepley }
25162764a2aaSMatthew G. Knepley 
2517194d53e6SMatthew G. Knepley /*@
2518194d53e6SMatthew G. Knepley   PetscDSGetComponentOffsets - Returns the offset of each field on an evaluation point
2519194d53e6SMatthew G. Knepley 
2520194d53e6SMatthew G. Knepley   Not collective
2521194d53e6SMatthew G. Knepley 
2522194d53e6SMatthew G. Knepley   Input Parameter:
2523194d53e6SMatthew G. Knepley . prob - The PetscDS object
2524194d53e6SMatthew G. Knepley 
2525194d53e6SMatthew G. Knepley   Output Parameter:
2526194d53e6SMatthew G. Knepley . offsets - The offsets
2527194d53e6SMatthew G. Knepley 
2528194d53e6SMatthew G. Knepley   Level: beginner
2529194d53e6SMatthew G. Knepley 
2530f744cafaSSander Arens .seealso: PetscDSGetNumFields(), PetscDSCreate()
2531194d53e6SMatthew G. Knepley @*/
2532194d53e6SMatthew G. Knepley PetscErrorCode PetscDSGetComponentOffsets(PetscDS prob, PetscInt *offsets[])
2533194d53e6SMatthew G. Knepley {
2534194d53e6SMatthew G. Knepley   PetscFunctionBegin;
2535194d53e6SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2536194d53e6SMatthew G. Knepley   PetscValidPointer(offsets, 2);
2537194d53e6SMatthew G. Knepley   *offsets = prob->off;
2538194d53e6SMatthew G. Knepley   PetscFunctionReturn(0);
2539194d53e6SMatthew G. Knepley }
2540194d53e6SMatthew G. Knepley 
2541194d53e6SMatthew G. Knepley /*@
2542194d53e6SMatthew G. Knepley   PetscDSGetComponentDerivativeOffsets - Returns the offset of each field derivative on an evaluation point
2543194d53e6SMatthew G. Knepley 
2544194d53e6SMatthew G. Knepley   Not collective
2545194d53e6SMatthew G. Knepley 
2546194d53e6SMatthew G. Knepley   Input Parameter:
2547194d53e6SMatthew G. Knepley . prob - The PetscDS object
2548194d53e6SMatthew G. Knepley 
2549194d53e6SMatthew G. Knepley   Output Parameter:
2550194d53e6SMatthew G. Knepley . offsets - The offsets
2551194d53e6SMatthew G. Knepley 
2552194d53e6SMatthew G. Knepley   Level: beginner
2553194d53e6SMatthew G. Knepley 
2554f744cafaSSander Arens .seealso: PetscDSGetNumFields(), PetscDSCreate()
2555194d53e6SMatthew G. Knepley @*/
2556194d53e6SMatthew G. Knepley PetscErrorCode PetscDSGetComponentDerivativeOffsets(PetscDS prob, PetscInt *offsets[])
2557194d53e6SMatthew G. Knepley {
2558194d53e6SMatthew G. Knepley   PetscFunctionBegin;
2559194d53e6SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2560194d53e6SMatthew G. Knepley   PetscValidPointer(offsets, 2);
2561194d53e6SMatthew G. Knepley   *offsets = prob->offDer;
2562194d53e6SMatthew G. Knepley   PetscFunctionReturn(0);
2563194d53e6SMatthew G. Knepley }
2564194d53e6SMatthew G. Knepley 
256568c9edb9SMatthew G. Knepley /*@C
256668c9edb9SMatthew G. Knepley   PetscDSGetTabulation - Return the basis tabulation at quadrature points for the volume discretization
256768c9edb9SMatthew G. Knepley 
256868c9edb9SMatthew G. Knepley   Not collective
256968c9edb9SMatthew G. Knepley 
257068c9edb9SMatthew G. Knepley   Input Parameter:
257168c9edb9SMatthew G. Knepley . prob - The PetscDS object
257268c9edb9SMatthew G. Knepley 
257368c9edb9SMatthew G. Knepley   Output Parameters:
257468c9edb9SMatthew G. Knepley + basis - The basis function tabulation at quadrature points
257568c9edb9SMatthew G. Knepley - basisDer - The basis function derivative tabulation at quadrature points
257668c9edb9SMatthew G. Knepley 
257768c9edb9SMatthew G. Knepley   Level: intermediate
257868c9edb9SMatthew G. Knepley 
2579f744cafaSSander Arens .seealso: PetscDSCreate()
258068c9edb9SMatthew G. Knepley @*/
25812764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetTabulation(PetscDS prob, PetscReal ***basis, PetscReal ***basisDer)
25822764a2aaSMatthew G. Knepley {
25832764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
25842764a2aaSMatthew G. Knepley 
25852764a2aaSMatthew G. Knepley   PetscFunctionBegin;
25862764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
25872764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
25882764a2aaSMatthew G. Knepley   if (basis)    {PetscValidPointer(basis, 2);    *basis    = prob->basis;}
25892764a2aaSMatthew G. Knepley   if (basisDer) {PetscValidPointer(basisDer, 3); *basisDer = prob->basisDer;}
25902764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
25912764a2aaSMatthew G. Knepley }
25922764a2aaSMatthew G. Knepley 
259368c9edb9SMatthew G. Knepley /*@C
25944d0b9603SSander Arens   PetscDSGetFaceTabulation - Return the basis tabulation at quadrature points on the faces
259568c9edb9SMatthew G. Knepley 
259668c9edb9SMatthew G. Knepley   Not collective
259768c9edb9SMatthew G. Knepley 
259868c9edb9SMatthew G. Knepley   Input Parameter:
259968c9edb9SMatthew G. Knepley . prob - The PetscDS object
260068c9edb9SMatthew G. Knepley 
260168c9edb9SMatthew G. Knepley   Output Parameters:
26024d0b9603SSander Arens + basisFace - The basis function tabulation at quadrature points
26034d0b9603SSander Arens - basisDerFace - The basis function derivative tabulation at quadrature points
260468c9edb9SMatthew G. Knepley 
260568c9edb9SMatthew G. Knepley   Level: intermediate
260668c9edb9SMatthew G. Knepley 
260768c9edb9SMatthew G. Knepley .seealso: PetscDSGetTabulation(), PetscDSCreate()
260868c9edb9SMatthew G. Knepley @*/
26094d0b9603SSander Arens PetscErrorCode PetscDSGetFaceTabulation(PetscDS prob, PetscReal ***basis, PetscReal ***basisDer)
26102764a2aaSMatthew G. Knepley {
26112764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
26122764a2aaSMatthew G. Knepley 
26132764a2aaSMatthew G. Knepley   PetscFunctionBegin;
26142764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
26152764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
26164d0b9603SSander Arens   if (basis)    {PetscValidPointer(basis, 2);    *basis    = prob->basisFace;}
26174d0b9603SSander Arens   if (basisDer) {PetscValidPointer(basisDer, 3); *basisDer = prob->basisDerFace;}
26182764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
26192764a2aaSMatthew G. Knepley }
26202764a2aaSMatthew G. Knepley 
26212764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetEvaluationArrays(PetscDS prob, PetscScalar **u, PetscScalar **u_t, PetscScalar **u_x)
26222764a2aaSMatthew G. Knepley {
26232764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
26242764a2aaSMatthew G. Knepley 
26252764a2aaSMatthew G. Knepley   PetscFunctionBegin;
26262764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
26272764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
26282764a2aaSMatthew G. Knepley   if (u)   {PetscValidPointer(u, 2);   *u   = prob->u;}
26292764a2aaSMatthew G. Knepley   if (u_t) {PetscValidPointer(u_t, 3); *u_t = prob->u_t;}
26302764a2aaSMatthew G. Knepley   if (u_x) {PetscValidPointer(u_x, 4); *u_x = prob->u_x;}
26312764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
26322764a2aaSMatthew G. Knepley }
26332764a2aaSMatthew G. Knepley 
26342764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetWeakFormArrays(PetscDS prob, PetscScalar **f0, PetscScalar **f1, PetscScalar **g0, PetscScalar **g1, PetscScalar **g2, PetscScalar **g3)
26352764a2aaSMatthew G. Knepley {
26362764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
26372764a2aaSMatthew G. Knepley 
26382764a2aaSMatthew G. Knepley   PetscFunctionBegin;
26392764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
26402764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
26412764a2aaSMatthew G. Knepley   if (f0) {PetscValidPointer(f0, 2); *f0 = prob->f0;}
26422764a2aaSMatthew G. Knepley   if (f1) {PetscValidPointer(f1, 3); *f1 = prob->f1;}
26432764a2aaSMatthew G. Knepley   if (g0) {PetscValidPointer(g0, 4); *g0 = prob->g0;}
26442764a2aaSMatthew G. Knepley   if (g1) {PetscValidPointer(g1, 5); *g1 = prob->g1;}
26452764a2aaSMatthew G. Knepley   if (g2) {PetscValidPointer(g2, 6); *g2 = prob->g2;}
26462764a2aaSMatthew G. Knepley   if (g3) {PetscValidPointer(g3, 7); *g3 = prob->g3;}
26472764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
26482764a2aaSMatthew G. Knepley }
26492764a2aaSMatthew G. Knepley 
26504bee2e38SMatthew G. Knepley PetscErrorCode PetscDSGetWorkspace(PetscDS prob, PetscReal **x, PetscScalar **basisReal, PetscScalar **basisDerReal, PetscScalar **testReal, PetscScalar **testDerReal)
26512764a2aaSMatthew G. Knepley {
26522764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
26532764a2aaSMatthew G. Knepley 
26542764a2aaSMatthew G. Knepley   PetscFunctionBegin;
26552764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
26562764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
26572764a2aaSMatthew G. Knepley   if (x)            {PetscValidPointer(x, 2);            *x            = prob->x;}
26584bee2e38SMatthew G. Knepley   if (basisReal)    {PetscValidPointer(basisReal, 3);    *basisReal    = prob->basisReal;}
26594bee2e38SMatthew G. Knepley   if (basisDerReal) {PetscValidPointer(basisDerReal, 3); *basisDerReal = prob->basisDerReal;}
26604bee2e38SMatthew G. Knepley   if (testReal)     {PetscValidPointer(testReal, 3);     *testReal     = prob->testReal;}
26614bee2e38SMatthew G. Knepley   if (testDerReal)  {PetscValidPointer(testDerReal, 3);  *testDerReal  = prob->testDerReal;}
26622764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
26632764a2aaSMatthew G. Knepley }
26642764a2aaSMatthew G. Knepley 
266558ebd649SToby Isaac /*@C
266658ebd649SToby Isaac   PetscDSAddBoundary - Add a boundary condition to the model
266758ebd649SToby Isaac 
266858ebd649SToby Isaac   Input Parameters:
266958ebd649SToby Isaac + ds          - The PetscDS object
26702d47a189SJulian Andrej . type        - The type of condition, e.g. DM_BC_ESSENTIAL/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann)
267158ebd649SToby Isaac . name        - The BC name
267258ebd649SToby Isaac . labelname   - The label defining constrained points
267358ebd649SToby Isaac . field       - The field to constrain
2674e8ecbf3fSStefano Zampini . numcomps    - The number of constrained field components (0 will constrain all fields)
267558ebd649SToby Isaac . comps       - An array of constrained component numbers
267658ebd649SToby Isaac . bcFunc      - A pointwise function giving boundary values
267758ebd649SToby Isaac . numids      - The number of DMLabel ids for constrained points
267858ebd649SToby Isaac . ids         - An array of ids for constrained points
267958ebd649SToby Isaac - ctx         - An optional user context for bcFunc
268058ebd649SToby Isaac 
268158ebd649SToby Isaac   Options Database Keys:
268258ebd649SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids
268358ebd649SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components
268458ebd649SToby Isaac 
268558ebd649SToby Isaac   Level: developer
268658ebd649SToby Isaac 
268758ebd649SToby Isaac .seealso: PetscDSGetBoundary()
268858ebd649SToby Isaac @*/
2689a30ec4eaSSatish 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)
269058ebd649SToby Isaac {
269158ebd649SToby Isaac   DSBoundary     b;
269258ebd649SToby Isaac   PetscErrorCode ierr;
269358ebd649SToby Isaac 
269458ebd649SToby Isaac   PetscFunctionBegin;
269558ebd649SToby Isaac   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1);
269658ebd649SToby Isaac   ierr = PetscNew(&b);CHKERRQ(ierr);
269758ebd649SToby Isaac   ierr = PetscStrallocpy(name, (char **) &b->name);CHKERRQ(ierr);
269858ebd649SToby Isaac   ierr = PetscStrallocpy(labelname, (char **) &b->labelname);CHKERRQ(ierr);
269958ebd649SToby Isaac   ierr = PetscMalloc1(numcomps, &b->comps);CHKERRQ(ierr);
270058ebd649SToby Isaac   if (numcomps) {ierr = PetscMemcpy(b->comps, comps, numcomps*sizeof(PetscInt));CHKERRQ(ierr);}
270158ebd649SToby Isaac   ierr = PetscMalloc1(numids, &b->ids);CHKERRQ(ierr);
270258ebd649SToby Isaac   if (numids) {ierr = PetscMemcpy(b->ids, ids, numids*sizeof(PetscInt));CHKERRQ(ierr);}
2703f971fd6bSMatthew G. Knepley   b->type            = type;
270458ebd649SToby Isaac   b->field           = field;
270558ebd649SToby Isaac   b->numcomps        = numcomps;
270658ebd649SToby Isaac   b->func            = bcFunc;
270758ebd649SToby Isaac   b->numids          = numids;
270858ebd649SToby Isaac   b->ctx             = ctx;
270958ebd649SToby Isaac   b->next            = ds->boundary;
271058ebd649SToby Isaac   ds->boundary       = b;
271158ebd649SToby Isaac   PetscFunctionReturn(0);
271258ebd649SToby Isaac }
271358ebd649SToby Isaac 
2714b67eacb3SMatthew G. Knepley /*@C
2715b67eacb3SMatthew G. Knepley   PetscDSUpdateBoundary - Change a boundary condition for the model
2716b67eacb3SMatthew G. Knepley 
2717b67eacb3SMatthew G. Knepley   Input Parameters:
2718b67eacb3SMatthew G. Knepley + ds          - The PetscDS object
2719b67eacb3SMatthew G. Knepley . bd          - The boundary condition number
2720b67eacb3SMatthew G. Knepley . type        - The type of condition, e.g. DM_BC_ESSENTIAL/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann)
2721b67eacb3SMatthew G. Knepley . name        - The BC name
2722b67eacb3SMatthew G. Knepley . labelname   - The label defining constrained points
2723b67eacb3SMatthew G. Knepley . field       - The field to constrain
2724b67eacb3SMatthew G. Knepley . numcomps    - The number of constrained field components
2725b67eacb3SMatthew G. Knepley . comps       - An array of constrained component numbers
2726b67eacb3SMatthew G. Knepley . bcFunc      - A pointwise function giving boundary values
2727b67eacb3SMatthew G. Knepley . numids      - The number of DMLabel ids for constrained points
2728b67eacb3SMatthew G. Knepley . ids         - An array of ids for constrained points
2729b67eacb3SMatthew G. Knepley - ctx         - An optional user context for bcFunc
2730b67eacb3SMatthew G. Knepley 
27319a6efb6aSMatthew 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().
27329a6efb6aSMatthew G. Knepley 
2733b67eacb3SMatthew G. Knepley   Level: developer
2734b67eacb3SMatthew G. Knepley 
27359a6efb6aSMatthew G. Knepley .seealso: PetscDSAddBoundary(), PetscDSGetBoundary(), PetscDSGetNumBoundary()
2736b67eacb3SMatthew G. Knepley @*/
2737b67eacb3SMatthew 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)
2738b67eacb3SMatthew G. Knepley {
2739b67eacb3SMatthew G. Knepley   DSBoundary     b = ds->boundary;
2740b67eacb3SMatthew G. Knepley   PetscInt       n = 0;
2741b67eacb3SMatthew G. Knepley   PetscErrorCode ierr;
2742b67eacb3SMatthew G. Knepley 
2743b67eacb3SMatthew G. Knepley   PetscFunctionBegin;
2744b67eacb3SMatthew G. Knepley   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1);
2745b67eacb3SMatthew G. Knepley   while (b) {
2746b67eacb3SMatthew G. Knepley     if (n == bd) break;
2747b67eacb3SMatthew G. Knepley     b = b->next;
2748b67eacb3SMatthew G. Knepley     ++n;
2749b67eacb3SMatthew G. Knepley   }
2750b67eacb3SMatthew G. Knepley   if (!b) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Boundary %d is not in [0, %d)", bd, n);
2751b67eacb3SMatthew G. Knepley   if (name) {
2752b67eacb3SMatthew G. Knepley     ierr = PetscFree(b->name);CHKERRQ(ierr);
2753b67eacb3SMatthew G. Knepley     ierr = PetscStrallocpy(name, (char **) &b->name);CHKERRQ(ierr);
2754b67eacb3SMatthew G. Knepley   }
2755b67eacb3SMatthew G. Knepley   if (labelname) {
2756b67eacb3SMatthew G. Knepley     ierr = PetscFree(b->labelname);CHKERRQ(ierr);
2757b67eacb3SMatthew G. Knepley     ierr = PetscStrallocpy(labelname, (char **) &b->labelname);CHKERRQ(ierr);
2758b67eacb3SMatthew G. Knepley   }
2759b67eacb3SMatthew G. Knepley   if (numcomps >= 0 && numcomps != b->numcomps) {
2760b67eacb3SMatthew G. Knepley     b->numcomps = numcomps;
2761b67eacb3SMatthew G. Knepley     ierr = PetscFree(b->comps);CHKERRQ(ierr);
2762b67eacb3SMatthew G. Knepley     ierr = PetscMalloc1(numcomps, &b->comps);CHKERRQ(ierr);
2763b67eacb3SMatthew G. Knepley     if (numcomps) {ierr = PetscMemcpy(b->comps, comps, numcomps*sizeof(PetscInt));CHKERRQ(ierr);}
2764b67eacb3SMatthew G. Knepley   }
2765b67eacb3SMatthew G. Knepley   if (numids >= 0 && numids != b->numids) {
2766b67eacb3SMatthew G. Knepley     b->numids = numids;
2767b67eacb3SMatthew G. Knepley     ierr = PetscFree(b->ids);CHKERRQ(ierr);
2768b67eacb3SMatthew G. Knepley     ierr = PetscMalloc1(numids, &b->ids);CHKERRQ(ierr);
2769b67eacb3SMatthew G. Knepley     if (numids) {ierr = PetscMemcpy(b->ids, ids, numids*sizeof(PetscInt));CHKERRQ(ierr);}
2770b67eacb3SMatthew G. Knepley   }
2771b67eacb3SMatthew G. Knepley   b->type = type;
2772b67eacb3SMatthew G. Knepley   if (field >= 0) {b->field  = field;}
2773b67eacb3SMatthew G. Knepley   if (bcFunc)     {b->func   = bcFunc;}
2774b67eacb3SMatthew G. Knepley   if (ctx)        {b->ctx    = ctx;}
2775b67eacb3SMatthew G. Knepley   PetscFunctionReturn(0);
2776b67eacb3SMatthew G. Knepley }
2777b67eacb3SMatthew G. Knepley 
277858ebd649SToby Isaac /*@
277958ebd649SToby Isaac   PetscDSGetNumBoundary - Get the number of registered BC
278058ebd649SToby Isaac 
278158ebd649SToby Isaac   Input Parameters:
278258ebd649SToby Isaac . ds - The PetscDS object
278358ebd649SToby Isaac 
278458ebd649SToby Isaac   Output Parameters:
278558ebd649SToby Isaac . numBd - The number of BC
278658ebd649SToby Isaac 
278758ebd649SToby Isaac   Level: intermediate
278858ebd649SToby Isaac 
278958ebd649SToby Isaac .seealso: PetscDSAddBoundary(), PetscDSGetBoundary()
279058ebd649SToby Isaac @*/
279158ebd649SToby Isaac PetscErrorCode PetscDSGetNumBoundary(PetscDS ds, PetscInt *numBd)
279258ebd649SToby Isaac {
279358ebd649SToby Isaac   DSBoundary b = ds->boundary;
279458ebd649SToby Isaac 
279558ebd649SToby Isaac   PetscFunctionBegin;
279658ebd649SToby Isaac   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1);
279758ebd649SToby Isaac   PetscValidPointer(numBd, 2);
279858ebd649SToby Isaac   *numBd = 0;
279958ebd649SToby Isaac   while (b) {++(*numBd); b = b->next;}
280058ebd649SToby Isaac   PetscFunctionReturn(0);
280158ebd649SToby Isaac }
280258ebd649SToby Isaac 
280358ebd649SToby Isaac /*@C
28049a6efb6aSMatthew G. Knepley   PetscDSGetBoundary - Gets a boundary condition to the model
280558ebd649SToby Isaac 
280658ebd649SToby Isaac   Input Parameters:
280758ebd649SToby Isaac + ds          - The PetscDS object
280858ebd649SToby Isaac - bd          - The BC number
280958ebd649SToby Isaac 
281058ebd649SToby Isaac   Output Parameters:
28112d47a189SJulian Andrej + type        - The type of condition, e.g. DM_BC_ESSENTIAL/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann)
281258ebd649SToby Isaac . name        - The BC name
281358ebd649SToby Isaac . labelname   - The label defining constrained points
281458ebd649SToby Isaac . field       - The field to constrain
281558ebd649SToby Isaac . numcomps    - The number of constrained field components
281658ebd649SToby Isaac . comps       - An array of constrained component numbers
281758ebd649SToby Isaac . bcFunc      - A pointwise function giving boundary values
281858ebd649SToby Isaac . numids      - The number of DMLabel ids for constrained points
281958ebd649SToby Isaac . ids         - An array of ids for constrained points
282058ebd649SToby Isaac - ctx         - An optional user context for bcFunc
282158ebd649SToby Isaac 
282258ebd649SToby Isaac   Options Database Keys:
282358ebd649SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids
282458ebd649SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components
282558ebd649SToby Isaac 
282658ebd649SToby Isaac   Level: developer
282758ebd649SToby Isaac 
282858ebd649SToby Isaac .seealso: PetscDSAddBoundary()
282958ebd649SToby Isaac @*/
2830a30ec4eaSSatish 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)
283158ebd649SToby Isaac {
283258ebd649SToby Isaac   DSBoundary b    = ds->boundary;
283358ebd649SToby Isaac   PetscInt   n    = 0;
283458ebd649SToby Isaac 
283558ebd649SToby Isaac   PetscFunctionBegin;
283658ebd649SToby Isaac   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1);
283758ebd649SToby Isaac   while (b) {
283858ebd649SToby Isaac     if (n == bd) break;
283958ebd649SToby Isaac     b = b->next;
284058ebd649SToby Isaac     ++n;
284158ebd649SToby Isaac   }
284258ebd649SToby Isaac   if (!b) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Boundary %d is not in [0, %d)", bd, n);
2843f971fd6bSMatthew G. Knepley   if (type) {
2844f971fd6bSMatthew G. Knepley     PetscValidPointer(type, 3);
2845f971fd6bSMatthew G. Knepley     *type = b->type;
284658ebd649SToby Isaac   }
284758ebd649SToby Isaac   if (name) {
284858ebd649SToby Isaac     PetscValidPointer(name, 4);
284958ebd649SToby Isaac     *name = b->name;
285058ebd649SToby Isaac   }
285158ebd649SToby Isaac   if (labelname) {
285258ebd649SToby Isaac     PetscValidPointer(labelname, 5);
285358ebd649SToby Isaac     *labelname = b->labelname;
285458ebd649SToby Isaac   }
285558ebd649SToby Isaac   if (field) {
285658ebd649SToby Isaac     PetscValidPointer(field, 6);
285758ebd649SToby Isaac     *field = b->field;
285858ebd649SToby Isaac   }
285958ebd649SToby Isaac   if (numcomps) {
286058ebd649SToby Isaac     PetscValidPointer(numcomps, 7);
286158ebd649SToby Isaac     *numcomps = b->numcomps;
286258ebd649SToby Isaac   }
286358ebd649SToby Isaac   if (comps) {
286458ebd649SToby Isaac     PetscValidPointer(comps, 8);
286558ebd649SToby Isaac     *comps = b->comps;
286658ebd649SToby Isaac   }
286758ebd649SToby Isaac   if (func) {
286858ebd649SToby Isaac     PetscValidPointer(func, 9);
286958ebd649SToby Isaac     *func = b->func;
287058ebd649SToby Isaac   }
287158ebd649SToby Isaac   if (numids) {
287258ebd649SToby Isaac     PetscValidPointer(numids, 10);
287358ebd649SToby Isaac     *numids = b->numids;
287458ebd649SToby Isaac   }
287558ebd649SToby Isaac   if (ids) {
287658ebd649SToby Isaac     PetscValidPointer(ids, 11);
287758ebd649SToby Isaac     *ids = b->ids;
287858ebd649SToby Isaac   }
287958ebd649SToby Isaac   if (ctx) {
288058ebd649SToby Isaac     PetscValidPointer(ctx, 12);
288158ebd649SToby Isaac     *ctx = b->ctx;
288258ebd649SToby Isaac   }
288358ebd649SToby Isaac   PetscFunctionReturn(0);
288458ebd649SToby Isaac }
288558ebd649SToby Isaac 
28869252d075SMatthew G. Knepley /*@
28879252d075SMatthew G. Knepley   PetscDSCopyBoundary - Copy all boundary condition objects to the new problem
28889252d075SMatthew G. Knepley 
28899252d075SMatthew G. Knepley   Not collective
28909252d075SMatthew G. Knepley 
28919252d075SMatthew G. Knepley   Input Parameter:
28929252d075SMatthew G. Knepley . prob - The PetscDS object
28939252d075SMatthew G. Knepley 
28949252d075SMatthew G. Knepley   Output Parameter:
28959252d075SMatthew G. Knepley . newprob - The PetscDS copy
28969252d075SMatthew G. Knepley 
28979252d075SMatthew G. Knepley   Level: intermediate
28989252d075SMatthew G. Knepley 
28999252d075SMatthew G. Knepley .seealso: PetscDSCopyEquations(), PetscDSSetResidual(), PetscDSSetJacobian(), PetscDSSetRiemannSolver(), PetscDSSetBdResidual(), PetscDSSetBdJacobian(), PetscDSCreate()
29009252d075SMatthew G. Knepley @*/
2901dff059c6SToby Isaac PetscErrorCode PetscDSCopyBoundary(PetscDS probA, PetscDS probB)
2902dff059c6SToby Isaac {
2903dff059c6SToby Isaac   DSBoundary     b, next, *lastnext;
2904dff059c6SToby Isaac   PetscErrorCode ierr;
2905dff059c6SToby Isaac 
2906dff059c6SToby Isaac   PetscFunctionBegin;
2907dff059c6SToby Isaac   PetscValidHeaderSpecific(probA, PETSCDS_CLASSID, 1);
2908dff059c6SToby Isaac   PetscValidHeaderSpecific(probB, PETSCDS_CLASSID, 2);
2909dff059c6SToby Isaac   if (probA == probB) PetscFunctionReturn(0);
2910dff059c6SToby Isaac   next = probB->boundary;
2911dff059c6SToby Isaac   while (next) {
2912dff059c6SToby Isaac     DSBoundary b = next;
2913dff059c6SToby Isaac 
2914dff059c6SToby Isaac     next = b->next;
2915dff059c6SToby Isaac     ierr = PetscFree(b->comps);CHKERRQ(ierr);
2916dff059c6SToby Isaac     ierr = PetscFree(b->ids);CHKERRQ(ierr);
2917dff059c6SToby Isaac     ierr = PetscFree(b->name);CHKERRQ(ierr);
2918dff059c6SToby Isaac     ierr = PetscFree(b->labelname);CHKERRQ(ierr);
2919dff059c6SToby Isaac     ierr = PetscFree(b);CHKERRQ(ierr);
2920dff059c6SToby Isaac   }
2921dff059c6SToby Isaac   lastnext = &(probB->boundary);
2922dff059c6SToby Isaac   for (b = probA->boundary; b; b = b->next) {
2923dff059c6SToby Isaac     DSBoundary bNew;
2924dff059c6SToby Isaac 
2925459726d8SSatish Balay     ierr = PetscNew(&bNew);CHKERRQ(ierr);
2926dff059c6SToby Isaac     bNew->numcomps = b->numcomps;
2927dff059c6SToby Isaac     ierr = PetscMalloc1(bNew->numcomps, &bNew->comps);CHKERRQ(ierr);
2928dff059c6SToby Isaac     ierr = PetscMemcpy(bNew->comps, b->comps, bNew->numcomps*sizeof(PetscInt));CHKERRQ(ierr);
2929dff059c6SToby Isaac     bNew->numids = b->numids;
2930dff059c6SToby Isaac     ierr = PetscMalloc1(bNew->numids, &bNew->ids);CHKERRQ(ierr);
2931dff059c6SToby Isaac     ierr = PetscMemcpy(bNew->ids, b->ids, bNew->numids*sizeof(PetscInt));CHKERRQ(ierr);
2932dff059c6SToby Isaac     ierr = PetscStrallocpy(b->labelname,(char **) &(bNew->labelname));CHKERRQ(ierr);
2933dff059c6SToby Isaac     ierr = PetscStrallocpy(b->name,(char **) &(bNew->name));CHKERRQ(ierr);
2934dff059c6SToby Isaac     bNew->ctx   = b->ctx;
2935f971fd6bSMatthew G. Knepley     bNew->type  = b->type;
2936dff059c6SToby Isaac     bNew->field = b->field;
2937dff059c6SToby Isaac     bNew->func  = b->func;
2938dff059c6SToby Isaac 
2939dff059c6SToby Isaac     *lastnext = bNew;
2940dff059c6SToby Isaac     lastnext = &(bNew->next);
2941dff059c6SToby Isaac   }
2942dff059c6SToby Isaac   PetscFunctionReturn(0);
2943dff059c6SToby Isaac }
2944dff059c6SToby Isaac 
29459252d075SMatthew G. Knepley /*@C
29469252d075SMatthew G. Knepley   PetscDSSelectEquations - Copy pointwise function pointers to the new problem with different field layout
29479252d075SMatthew G. Knepley 
29489252d075SMatthew G. Knepley   Not collective
29499252d075SMatthew G. Knepley 
29509252d075SMatthew G. Knepley   Input Parameter:
29519252d075SMatthew G. Knepley + prob - The PetscDS object
29529252d075SMatthew G. Knepley . numFields - Number of new fields
29539252d075SMatthew G. Knepley - fields - Old field number for each new field
29549252d075SMatthew G. Knepley 
29559252d075SMatthew G. Knepley   Output Parameter:
29569252d075SMatthew G. Knepley . newprob - The PetscDS copy
29579252d075SMatthew G. Knepley 
29589252d075SMatthew G. Knepley   Level: intermediate
29599252d075SMatthew G. Knepley 
29609252d075SMatthew G. Knepley .seealso: PetscDSCopyBoundary(), PetscDSSetResidual(), PetscDSSetJacobian(), PetscDSSetRiemannSolver(), PetscDSSetBdResidual(), PetscDSSetBdJacobian(), PetscDSCreate()
29619252d075SMatthew G. Knepley @*/
29629252d075SMatthew G. Knepley PetscErrorCode PetscDSSelectEquations(PetscDS prob, PetscInt numFields, const PetscInt fields[], PetscDS newprob)
29639252d075SMatthew G. Knepley {
29649252d075SMatthew G. Knepley   PetscInt       Nf, Nfn, fn, gn;
29659252d075SMatthew G. Knepley   PetscErrorCode ierr;
29669252d075SMatthew G. Knepley 
29679252d075SMatthew G. Knepley   PetscFunctionBegin;
29689252d075SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
29699252d075SMatthew G. Knepley   if (fields) PetscValidPointer(fields, 3);
29709252d075SMatthew G. Knepley   PetscValidHeaderSpecific(newprob, PETSCDS_CLASSID, 4);
29719252d075SMatthew G. Knepley   ierr = PetscDSGetNumFields(prob, &Nf);CHKERRQ(ierr);
29729252d075SMatthew G. Knepley   ierr = PetscDSGetNumFields(newprob, &Nfn);CHKERRQ(ierr);
29739252d075SMatthew 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);
29749252d075SMatthew G. Knepley   for (fn = 0; fn < numFields; ++fn) {
29759252d075SMatthew G. Knepley     const PetscInt   f = fields ? fields[fn] : fn;
29769252d075SMatthew G. Knepley     PetscPointFunc   obj;
29779252d075SMatthew G. Knepley     PetscPointFunc   f0, f1;
29789252d075SMatthew G. Knepley     PetscBdPointFunc f0Bd, f1Bd;
29799252d075SMatthew G. Knepley     PetscRiemannFunc r;
29809252d075SMatthew G. Knepley 
29819252d075SMatthew G. Knepley     if (f >= Nf) SETERRQ2(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_SIZ, "Field %D must be in [0, %D)", f, Nf);
29829252d075SMatthew G. Knepley     ierr = PetscDSGetObjective(prob, f, &obj);CHKERRQ(ierr);
29839252d075SMatthew G. Knepley     ierr = PetscDSGetResidual(prob, f, &f0, &f1);CHKERRQ(ierr);
29849252d075SMatthew G. Knepley     ierr = PetscDSGetBdResidual(prob, f, &f0Bd, &f1Bd);CHKERRQ(ierr);
29859252d075SMatthew G. Knepley     ierr = PetscDSGetRiemannSolver(prob, f, &r);CHKERRQ(ierr);
29869252d075SMatthew G. Knepley     ierr = PetscDSSetObjective(newprob, fn, obj);CHKERRQ(ierr);
29879252d075SMatthew G. Knepley     ierr = PetscDSSetResidual(newprob, fn, f0, f1);CHKERRQ(ierr);
29889252d075SMatthew G. Knepley     ierr = PetscDSSetBdResidual(newprob, fn, f0Bd, f1Bd);CHKERRQ(ierr);
29899252d075SMatthew G. Knepley     ierr = PetscDSSetRiemannSolver(newprob, fn, r);CHKERRQ(ierr);
29909252d075SMatthew G. Knepley     for (gn = 0; gn < numFields; ++gn) {
29919252d075SMatthew G. Knepley       const PetscInt  g = fields ? fields[gn] : gn;
29929252d075SMatthew G. Knepley       PetscPointJac   g0, g1, g2, g3;
29939252d075SMatthew G. Knepley       PetscPointJac   g0p, g1p, g2p, g3p;
29949252d075SMatthew G. Knepley       PetscBdPointJac g0Bd, g1Bd, g2Bd, g3Bd;
29959252d075SMatthew G. Knepley 
29969252d075SMatthew G. Knepley       if (g >= Nf) SETERRQ2(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_SIZ, "Field %D must be in [0, %D)", g, Nf);
29979252d075SMatthew G. Knepley       ierr = PetscDSGetJacobian(prob, f, g, &g0, &g1, &g2, &g3);CHKERRQ(ierr);
29989252d075SMatthew G. Knepley       ierr = PetscDSGetJacobianPreconditioner(prob, f, g, &g0p, &g1p, &g2p, &g3p);CHKERRQ(ierr);
29999252d075SMatthew G. Knepley       ierr = PetscDSGetBdJacobian(prob, f, g, &g0Bd, &g1Bd, &g2Bd, &g3Bd);CHKERRQ(ierr);
30009252d075SMatthew G. Knepley       ierr = PetscDSSetJacobian(newprob, fn, gn, g0, g1, g2, g3);CHKERRQ(ierr);
30019252d075SMatthew G. Knepley       ierr = PetscDSSetJacobianPreconditioner(prob, fn, gn, g0p, g1p, g2p, g3p);CHKERRQ(ierr);
30029252d075SMatthew G. Knepley       ierr = PetscDSSetBdJacobian(newprob, fn, gn, g0Bd, g1Bd, g2Bd, g3Bd);CHKERRQ(ierr);
30039252d075SMatthew G. Knepley     }
30049252d075SMatthew G. Knepley   }
30059252d075SMatthew G. Knepley   PetscFunctionReturn(0);
30069252d075SMatthew G. Knepley }
30079252d075SMatthew G. Knepley 
3008da51fcedSMatthew G. Knepley /*@
3009da51fcedSMatthew G. Knepley   PetscDSCopyEquations - Copy all pointwise function pointers to the new problem
3010da51fcedSMatthew G. Knepley 
3011da51fcedSMatthew G. Knepley   Not collective
3012da51fcedSMatthew G. Knepley 
3013da51fcedSMatthew G. Knepley   Input Parameter:
3014da51fcedSMatthew G. Knepley . prob - The PetscDS object
3015da51fcedSMatthew G. Knepley 
3016da51fcedSMatthew G. Knepley   Output Parameter:
3017da51fcedSMatthew G. Knepley . newprob - The PetscDS copy
3018da51fcedSMatthew G. Knepley 
3019da51fcedSMatthew G. Knepley   Level: intermediate
3020da51fcedSMatthew G. Knepley 
30219252d075SMatthew G. Knepley .seealso: PetscDSCopyBoundary(), PetscDSSetResidual(), PetscDSSetJacobian(), PetscDSSetRiemannSolver(), PetscDSSetBdResidual(), PetscDSSetBdJacobian(), PetscDSCreate()
3022da51fcedSMatthew G. Knepley @*/
3023da51fcedSMatthew G. Knepley PetscErrorCode PetscDSCopyEquations(PetscDS prob, PetscDS newprob)
3024da51fcedSMatthew G. Knepley {
30259252d075SMatthew G. Knepley   PetscInt       Nf, Ng;
3026da51fcedSMatthew G. Knepley   PetscErrorCode ierr;
3027da51fcedSMatthew G. Knepley 
3028da51fcedSMatthew G. Knepley   PetscFunctionBegin;
3029da51fcedSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
3030da51fcedSMatthew G. Knepley   PetscValidHeaderSpecific(newprob, PETSCDS_CLASSID, 2);
3031da51fcedSMatthew G. Knepley   ierr = PetscDSGetNumFields(prob, &Nf);CHKERRQ(ierr);
3032da51fcedSMatthew G. Knepley   ierr = PetscDSGetNumFields(newprob, &Ng);CHKERRQ(ierr);
303313903a91SSatish Balay   if (Nf != Ng) SETERRQ2(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_SIZ, "Number of fields must match %D != %D", Nf, Ng);
30349252d075SMatthew G. Knepley   ierr = PetscDSSelectEquations(prob, Nf, NULL, newprob);CHKERRQ(ierr);
30359252d075SMatthew G. Knepley   PetscFunctionReturn(0);
30369252d075SMatthew G. Knepley }
30379252d075SMatthew G. Knepley /*@
30389252d075SMatthew G. Knepley   PetscDSCopyConstants - Copy all constants to the new problem
3039da51fcedSMatthew G. Knepley 
30409252d075SMatthew G. Knepley   Not collective
30419252d075SMatthew G. Knepley 
30429252d075SMatthew G. Knepley   Input Parameter:
30439252d075SMatthew G. Knepley . prob - The PetscDS object
30449252d075SMatthew G. Knepley 
30459252d075SMatthew G. Knepley   Output Parameter:
30469252d075SMatthew G. Knepley . newprob - The PetscDS copy
30479252d075SMatthew G. Knepley 
30489252d075SMatthew G. Knepley   Level: intermediate
30499252d075SMatthew G. Knepley 
30509252d075SMatthew G. Knepley .seealso: PetscDSCopyBoundary(), PetscDSCopyEquations(), PetscDSSetResidual(), PetscDSSetJacobian(), PetscDSSetRiemannSolver(), PetscDSSetBdResidual(), PetscDSSetBdJacobian(), PetscDSCreate()
30519252d075SMatthew G. Knepley @*/
30529252d075SMatthew G. Knepley PetscErrorCode PetscDSCopyConstants(PetscDS prob, PetscDS newprob)
30539252d075SMatthew G. Knepley {
30549252d075SMatthew G. Knepley   PetscInt           Nc;
30559252d075SMatthew G. Knepley   const PetscScalar *constants;
30569252d075SMatthew G. Knepley   PetscErrorCode     ierr;
30579252d075SMatthew G. Knepley 
30589252d075SMatthew G. Knepley   PetscFunctionBegin;
30599252d075SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
30609252d075SMatthew G. Knepley   PetscValidHeaderSpecific(newprob, PETSCDS_CLASSID, 2);
30619252d075SMatthew G. Knepley   ierr = PetscDSGetConstants(prob, &Nc, &constants);CHKERRQ(ierr);
30629252d075SMatthew G. Knepley   ierr = PetscDSSetConstants(newprob, Nc, (PetscScalar *) constants);CHKERRQ(ierr);
3063da51fcedSMatthew G. Knepley   PetscFunctionReturn(0);
3064da51fcedSMatthew G. Knepley }
3065da51fcedSMatthew G. Knepley 
3066b1353e8eSMatthew G. Knepley PetscErrorCode PetscDSGetHeightSubspace(PetscDS prob, PetscInt height, PetscDS *subprob)
3067b1353e8eSMatthew G. Knepley {
3068df3a45bdSMatthew G. Knepley   PetscInt       dim, Nf, f;
3069b1353e8eSMatthew G. Knepley   PetscErrorCode ierr;
3070b1353e8eSMatthew G. Knepley 
3071b1353e8eSMatthew G. Knepley   PetscFunctionBegin;
3072b1353e8eSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
3073b1353e8eSMatthew G. Knepley   PetscValidPointer(subprob, 3);
3074b1353e8eSMatthew G. Knepley   if (height == 0) {*subprob = prob; PetscFunctionReturn(0);}
3075b1353e8eSMatthew G. Knepley   ierr = PetscDSGetNumFields(prob, &Nf);CHKERRQ(ierr);
3076df3a45bdSMatthew G. Knepley   ierr = PetscDSGetSpatialDimension(prob, &dim);CHKERRQ(ierr);
3077df3a45bdSMatthew 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);
3078df3a45bdSMatthew G. Knepley   if (!prob->subprobs) {ierr = PetscCalloc1(dim, &prob->subprobs);CHKERRQ(ierr);}
3079df3a45bdSMatthew G. Knepley   if (!prob->subprobs[height-1]) {
3080b1353e8eSMatthew G. Knepley     PetscInt cdim;
3081b1353e8eSMatthew G. Knepley 
3082df3a45bdSMatthew G. Knepley     ierr = PetscDSCreate(PetscObjectComm((PetscObject) prob), &prob->subprobs[height-1]);CHKERRQ(ierr);
3083b1353e8eSMatthew G. Knepley     ierr = PetscDSGetCoordinateDimension(prob, &cdim);CHKERRQ(ierr);
3084df3a45bdSMatthew G. Knepley     ierr = PetscDSSetCoordinateDimension(prob->subprobs[height-1], cdim);CHKERRQ(ierr);
3085b1353e8eSMatthew G. Knepley     for (f = 0; f < Nf; ++f) {
3086b1353e8eSMatthew G. Knepley       PetscFE      subfe;
3087b1353e8eSMatthew G. Knepley       PetscObject  obj;
3088b1353e8eSMatthew G. Knepley       PetscClassId id;
3089b1353e8eSMatthew G. Knepley 
3090b1353e8eSMatthew G. Knepley       ierr = PetscDSGetDiscretization(prob, f, &obj);CHKERRQ(ierr);
3091b1353e8eSMatthew G. Knepley       ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr);
3092b1353e8eSMatthew G. Knepley       if (id == PETSCFE_CLASSID) {ierr = PetscFEGetHeightSubspace((PetscFE) obj, height, &subfe);CHKERRQ(ierr);}
3093b1353e8eSMatthew G. Knepley       else SETERRQ1(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Unsupported discretization type for field %d", f);
3094df3a45bdSMatthew G. Knepley       ierr = PetscDSSetDiscretization(prob->subprobs[height-1], f, (PetscObject) subfe);CHKERRQ(ierr);
3095b1353e8eSMatthew G. Knepley     }
3096b1353e8eSMatthew G. Knepley   }
3097df3a45bdSMatthew G. Knepley   *subprob = prob->subprobs[height-1];
3098b1353e8eSMatthew G. Knepley   PetscFunctionReturn(0);
3099b1353e8eSMatthew G. Knepley }
3100b1353e8eSMatthew G. Knepley 
3101bc4ae4beSMatthew G. Knepley static PetscErrorCode PetscDSDestroy_Basic(PetscDS prob)
31022764a2aaSMatthew G. Knepley {
3103931fb3b8SToby Isaac   PetscErrorCode      ierr;
3104931fb3b8SToby Isaac 
31052764a2aaSMatthew G. Knepley   PetscFunctionBegin;
3106931fb3b8SToby Isaac   ierr = PetscFree(prob->data);CHKERRQ(ierr);
31072764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
31082764a2aaSMatthew G. Knepley }
31092764a2aaSMatthew G. Knepley 
3110bc4ae4beSMatthew G. Knepley static PetscErrorCode PetscDSInitialize_Basic(PetscDS prob)
31112764a2aaSMatthew G. Knepley {
31122764a2aaSMatthew G. Knepley   PetscFunctionBegin;
31132764a2aaSMatthew G. Knepley   prob->ops->setfromoptions = NULL;
31142764a2aaSMatthew G. Knepley   prob->ops->setup          = NULL;
31152764a2aaSMatthew G. Knepley   prob->ops->view           = NULL;
31162764a2aaSMatthew G. Knepley   prob->ops->destroy        = PetscDSDestroy_Basic;
31172764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
31182764a2aaSMatthew G. Knepley }
31192764a2aaSMatthew G. Knepley 
31202764a2aaSMatthew G. Knepley /*MC
31212764a2aaSMatthew G. Knepley   PETSCDSBASIC = "basic" - A discrete system with pointwise residual and boundary residual functions
31222764a2aaSMatthew G. Knepley 
31232764a2aaSMatthew G. Knepley   Level: intermediate
31242764a2aaSMatthew G. Knepley 
31252764a2aaSMatthew G. Knepley .seealso: PetscDSType, PetscDSCreate(), PetscDSSetType()
31262764a2aaSMatthew G. Knepley M*/
31272764a2aaSMatthew G. Knepley 
31282764a2aaSMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscDSCreate_Basic(PetscDS prob)
31292764a2aaSMatthew G. Knepley {
31302764a2aaSMatthew G. Knepley   PetscDS_Basic *b;
31312764a2aaSMatthew G. Knepley   PetscErrorCode      ierr;
31322764a2aaSMatthew G. Knepley 
31332764a2aaSMatthew G. Knepley   PetscFunctionBegin;
3134931fb3b8SToby Isaac   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
31352764a2aaSMatthew G. Knepley   ierr       = PetscNewLog(prob, &b);CHKERRQ(ierr);
31362764a2aaSMatthew G. Knepley   prob->data = b;
31372764a2aaSMatthew G. Knepley 
31382764a2aaSMatthew G. Knepley   ierr = PetscDSInitialize_Basic(prob);CHKERRQ(ierr);
31392764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
31402764a2aaSMatthew G. Knepley }
3141