xref: /petsc/src/dm/dt/interface/dtds.c (revision 94a5e212f1bc6b86dd90786c8e2da239eb95ebb5)
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 
82764a2aaSMatthew G. Knepley /*@C
92764a2aaSMatthew G. Knepley   PetscDSRegister - Adds a new PetscDS implementation
102764a2aaSMatthew G. Knepley 
112764a2aaSMatthew G. Knepley   Not Collective
122764a2aaSMatthew G. Knepley 
132764a2aaSMatthew G. Knepley   Input Parameters:
142764a2aaSMatthew G. Knepley + name        - The name of a new user-defined creation routine
152764a2aaSMatthew G. Knepley - create_func - The creation routine itself
162764a2aaSMatthew G. Knepley 
172764a2aaSMatthew G. Knepley   Notes:
182764a2aaSMatthew G. Knepley   PetscDSRegister() may be called multiple times to add several user-defined PetscDSs
192764a2aaSMatthew G. Knepley 
202764a2aaSMatthew G. Knepley   Sample usage:
212764a2aaSMatthew G. Knepley .vb
222764a2aaSMatthew G. Knepley     PetscDSRegister("my_ds", MyPetscDSCreate);
232764a2aaSMatthew G. Knepley .ve
242764a2aaSMatthew G. Knepley 
252764a2aaSMatthew G. Knepley   Then, your PetscDS type can be chosen with the procedural interface via
262764a2aaSMatthew G. Knepley .vb
272764a2aaSMatthew G. Knepley     PetscDSCreate(MPI_Comm, PetscDS *);
282764a2aaSMatthew G. Knepley     PetscDSSetType(PetscDS, "my_ds");
292764a2aaSMatthew G. Knepley .ve
302764a2aaSMatthew G. Knepley    or at runtime via the option
312764a2aaSMatthew G. Knepley .vb
322764a2aaSMatthew G. Knepley     -petscds_type my_ds
332764a2aaSMatthew G. Knepley .ve
342764a2aaSMatthew G. Knepley 
352764a2aaSMatthew G. Knepley   Level: advanced
362764a2aaSMatthew G. Knepley 
37f5f57ec0SBarry Smith    Not available from Fortran
38f5f57ec0SBarry Smith 
392764a2aaSMatthew G. Knepley .keywords: PetscDS, register
402764a2aaSMatthew G. Knepley .seealso: PetscDSRegisterAll(), PetscDSRegisterDestroy()
412764a2aaSMatthew G. Knepley 
422764a2aaSMatthew G. Knepley @*/
432764a2aaSMatthew G. Knepley PetscErrorCode PetscDSRegister(const char sname[], PetscErrorCode (*function)(PetscDS))
442764a2aaSMatthew G. Knepley {
452764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
462764a2aaSMatthew G. Knepley 
472764a2aaSMatthew G. Knepley   PetscFunctionBegin;
482764a2aaSMatthew G. Knepley   ierr = PetscFunctionListAdd(&PetscDSList, sname, function);CHKERRQ(ierr);
492764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
502764a2aaSMatthew G. Knepley }
512764a2aaSMatthew G. Knepley 
522764a2aaSMatthew G. Knepley /*@C
532764a2aaSMatthew G. Knepley   PetscDSSetType - Builds a particular PetscDS
542764a2aaSMatthew G. Knepley 
552764a2aaSMatthew G. Knepley   Collective on PetscDS
562764a2aaSMatthew G. Knepley 
572764a2aaSMatthew G. Knepley   Input Parameters:
582764a2aaSMatthew G. Knepley + prob - The PetscDS object
592764a2aaSMatthew G. Knepley - name - The kind of system
602764a2aaSMatthew G. Knepley 
612764a2aaSMatthew G. Knepley   Options Database Key:
622764a2aaSMatthew G. Knepley . -petscds_type <type> - Sets the PetscDS type; use -help for a list of available types
632764a2aaSMatthew G. Knepley 
642764a2aaSMatthew G. Knepley   Level: intermediate
652764a2aaSMatthew G. Knepley 
66f5f57ec0SBarry Smith    Not available from Fortran
67f5f57ec0SBarry Smith 
682764a2aaSMatthew G. Knepley .keywords: PetscDS, set, type
692764a2aaSMatthew G. Knepley .seealso: PetscDSGetType(), PetscDSCreate()
702764a2aaSMatthew G. Knepley @*/
712764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetType(PetscDS prob, PetscDSType name)
722764a2aaSMatthew G. Knepley {
732764a2aaSMatthew G. Knepley   PetscErrorCode (*r)(PetscDS);
742764a2aaSMatthew G. Knepley   PetscBool      match;
752764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
762764a2aaSMatthew G. Knepley 
772764a2aaSMatthew G. Knepley   PetscFunctionBegin;
782764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
792764a2aaSMatthew G. Knepley   ierr = PetscObjectTypeCompare((PetscObject) prob, name, &match);CHKERRQ(ierr);
802764a2aaSMatthew G. Knepley   if (match) PetscFunctionReturn(0);
812764a2aaSMatthew G. Knepley 
820f51fdf8SToby Isaac   ierr = PetscDSRegisterAll();CHKERRQ(ierr);
832764a2aaSMatthew G. Knepley   ierr = PetscFunctionListFind(PetscDSList, name, &r);CHKERRQ(ierr);
842764a2aaSMatthew G. Knepley   if (!r) SETERRQ1(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_UNKNOWN_TYPE, "Unknown PetscDS type: %s", name);
852764a2aaSMatthew G. Knepley 
862764a2aaSMatthew G. Knepley   if (prob->ops->destroy) {
872764a2aaSMatthew G. Knepley     ierr             = (*prob->ops->destroy)(prob);CHKERRQ(ierr);
882764a2aaSMatthew G. Knepley     prob->ops->destroy = NULL;
892764a2aaSMatthew G. Knepley   }
902764a2aaSMatthew G. Knepley   ierr = (*r)(prob);CHKERRQ(ierr);
912764a2aaSMatthew G. Knepley   ierr = PetscObjectChangeTypeName((PetscObject) prob, name);CHKERRQ(ierr);
922764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
932764a2aaSMatthew G. Knepley }
942764a2aaSMatthew G. Knepley 
952764a2aaSMatthew G. Knepley /*@C
962764a2aaSMatthew G. Knepley   PetscDSGetType - Gets the PetscDS type name (as a string) from the object.
972764a2aaSMatthew G. Knepley 
982764a2aaSMatthew G. Knepley   Not Collective
992764a2aaSMatthew G. Knepley 
1002764a2aaSMatthew G. Knepley   Input Parameter:
1012764a2aaSMatthew G. Knepley . prob  - The PetscDS
1022764a2aaSMatthew G. Knepley 
1032764a2aaSMatthew G. Knepley   Output Parameter:
1042764a2aaSMatthew G. Knepley . name - The PetscDS type name
1052764a2aaSMatthew G. Knepley 
1062764a2aaSMatthew G. Knepley   Level: intermediate
1072764a2aaSMatthew G. Knepley 
108f5f57ec0SBarry Smith    Not available from Fortran
109f5f57ec0SBarry Smith 
1102764a2aaSMatthew G. Knepley .keywords: PetscDS, get, type, name
1112764a2aaSMatthew G. Knepley .seealso: PetscDSSetType(), PetscDSCreate()
1122764a2aaSMatthew G. Knepley @*/
1132764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetType(PetscDS prob, PetscDSType *name)
1142764a2aaSMatthew G. Knepley {
1152764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
1162764a2aaSMatthew G. Knepley 
1172764a2aaSMatthew G. Knepley   PetscFunctionBegin;
1182764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
119c959eef4SJed Brown   PetscValidPointer(name, 2);
1200f51fdf8SToby Isaac   ierr = PetscDSRegisterAll();CHKERRQ(ierr);
1212764a2aaSMatthew G. Knepley   *name = ((PetscObject) prob)->type_name;
1222764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
1232764a2aaSMatthew G. Knepley }
1242764a2aaSMatthew G. Knepley 
1257d8a60eaSMatthew G. Knepley static PetscErrorCode PetscDSView_Ascii(PetscDS prob, PetscViewer viewer)
1267d8a60eaSMatthew G. Knepley {
1277d8a60eaSMatthew G. Knepley   PetscViewerFormat  format;
12897b6e6e8SMatthew G. Knepley   const PetscScalar *constants;
12997b6e6e8SMatthew G. Knepley   PetscInt           numConstants, f;
1307d8a60eaSMatthew G. Knepley   PetscErrorCode     ierr;
1317d8a60eaSMatthew G. Knepley 
1327d8a60eaSMatthew G. Knepley   PetscFunctionBegin;
1337d8a60eaSMatthew G. Knepley   ierr = PetscViewerGetFormat(viewer, &format);CHKERRQ(ierr);
1347d8a60eaSMatthew G. Knepley   ierr = PetscViewerASCIIPrintf(viewer, "Discrete System with %d fields\n", prob->Nf);CHKERRQ(ierr);
1357d8a60eaSMatthew G. Knepley   ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1364727e194SMatthew G. Knepley   ierr = PetscViewerASCIIPrintf(viewer, "  cell total dim %D total comp %D\n", prob->totDim, prob->totComp);CHKERRQ(ierr);
1374727e194SMatthew G. Knepley   if (prob->isHybrid) {ierr = PetscViewerASCIIPrintf(viewer, "  hybrid cell\n");CHKERRQ(ierr);}
1387d8a60eaSMatthew G. Knepley   for (f = 0; f < prob->Nf; ++f) {
1397d8a60eaSMatthew G. Knepley     PetscObject     obj;
1407d8a60eaSMatthew G. Knepley     PetscClassId    id;
141f35450b9SMatthew G. Knepley     PetscQuadrature q;
1427d8a60eaSMatthew G. Knepley     const char     *name;
143f35450b9SMatthew G. Knepley     PetscInt        Nc, Nq, Nqc;
1447d8a60eaSMatthew G. Knepley 
1457d8a60eaSMatthew G. Knepley     ierr = PetscDSGetDiscretization(prob, f, &obj);CHKERRQ(ierr);
1467d8a60eaSMatthew G. Knepley     ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr);
1477d8a60eaSMatthew G. Knepley     ierr = PetscObjectGetName(obj, &name);CHKERRQ(ierr);
1487d8a60eaSMatthew G. Knepley     ierr = PetscViewerASCIIPrintf(viewer, "Field %s", name ? name : "<unknown>");CHKERRQ(ierr);
1494727e194SMatthew G. Knepley     ierr = PetscViewerASCIIUseTabs(viewer, PETSC_FALSE);CHKERRQ(ierr);
1507d8a60eaSMatthew G. Knepley     if (id == PETSCFE_CLASSID)      {
1517d8a60eaSMatthew G. Knepley       ierr = PetscFEGetNumComponents((PetscFE) obj, &Nc);CHKERRQ(ierr);
152f35450b9SMatthew G. Knepley       ierr = PetscFEGetQuadrature((PetscFE) obj, &q);CHKERRQ(ierr);
1537d8a60eaSMatthew G. Knepley       ierr = PetscViewerASCIIPrintf(viewer, " FEM");CHKERRQ(ierr);
1547d8a60eaSMatthew G. Knepley     } else if (id == PETSCFV_CLASSID) {
1557d8a60eaSMatthew G. Knepley       ierr = PetscFVGetNumComponents((PetscFV) obj, &Nc);CHKERRQ(ierr);
156f35450b9SMatthew G. Knepley       ierr = PetscFVGetQuadrature((PetscFV) obj, &q);CHKERRQ(ierr);
1577d8a60eaSMatthew G. Knepley       ierr = PetscViewerASCIIPrintf(viewer, " FVM");CHKERRQ(ierr);
1587d8a60eaSMatthew G. Knepley     }
15997b6e6e8SMatthew G. Knepley     else SETERRQ1(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Unknown discretization type for field %D", f);
16097b6e6e8SMatthew G. Knepley     if (Nc > 1) {ierr = PetscViewerASCIIPrintf(viewer, "%D components", Nc);CHKERRQ(ierr);}
16197b6e6e8SMatthew G. Knepley     else        {ierr = PetscViewerASCIIPrintf(viewer, "%D component ", Nc);CHKERRQ(ierr);}
162249df284SMatthew G. Knepley     if (prob->implicit[f]) {ierr = PetscViewerASCIIPrintf(viewer, " (implicit)");CHKERRQ(ierr);}
163249df284SMatthew G. Knepley     else                   {ierr = PetscViewerASCIIPrintf(viewer, " (explicit)");CHKERRQ(ierr);}
164a6cbbb48SMatthew G. Knepley     if (prob->adjacency[f*2+0]) {
165a6cbbb48SMatthew G. Knepley       if (prob->adjacency[f*2+1]) {ierr = PetscViewerASCIIPrintf(viewer, " (adj FVM++)");CHKERRQ(ierr);}
166a6cbbb48SMatthew G. Knepley       else                        {ierr = PetscViewerASCIIPrintf(viewer, " (adj FVM)");CHKERRQ(ierr);}
167a6cbbb48SMatthew G. Knepley     } else {
168a6cbbb48SMatthew G. Knepley       if (prob->adjacency[f*2+1]) {ierr = PetscViewerASCIIPrintf(viewer, " (adj FEM)");CHKERRQ(ierr);}
169a6cbbb48SMatthew G. Knepley       else                        {ierr = PetscViewerASCIIPrintf(viewer, " (adj FUNKY)");CHKERRQ(ierr);}
170a6cbbb48SMatthew G. Knepley     }
1713e60c2a6SMatthew G. Knepley     if (q) {
172f35450b9SMatthew G. Knepley       ierr = PetscQuadratureGetData(q, NULL, &Nqc, &Nq, NULL, NULL);CHKERRQ(ierr);
173f35450b9SMatthew G. Knepley       ierr = PetscViewerASCIIPrintf(viewer, " (Nq %D Nqc %D)", Nq, Nqc);CHKERRQ(ierr);
1743e60c2a6SMatthew G. Knepley     }
1757d8a60eaSMatthew G. Knepley     ierr = PetscViewerASCIIPrintf(viewer, "\n");CHKERRQ(ierr);
1764727e194SMatthew G. Knepley     ierr = PetscViewerASCIIUseTabs(viewer, PETSC_TRUE);CHKERRQ(ierr);
1775d160056SMatthew G. Knepley     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1787d8a60eaSMatthew G. Knepley     if (id == PETSCFE_CLASSID)      {ierr = PetscFEView((PetscFE) obj, viewer);CHKERRQ(ierr);}
1797d8a60eaSMatthew G. Knepley     else if (id == PETSCFV_CLASSID) {ierr = PetscFVView((PetscFV) obj, viewer);CHKERRQ(ierr);}
1805d160056SMatthew G. Knepley     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1817d8a60eaSMatthew G. Knepley   }
18297b6e6e8SMatthew G. Knepley   ierr = PetscDSGetConstants(prob, &numConstants, &constants);CHKERRQ(ierr);
18397b6e6e8SMatthew G. Knepley   if (numConstants) {
18497b6e6e8SMatthew G. Knepley     ierr = PetscViewerASCIIPrintf(viewer, "%D constants\n", numConstants);CHKERRQ(ierr);
18597b6e6e8SMatthew G. Knepley     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
18657fc01e9SMatthew G. Knepley     for (f = 0; f < numConstants; ++f) {ierr = PetscViewerASCIIPrintf(viewer, "%g\n", (double) PetscRealPart(constants[f]));CHKERRQ(ierr);}
18797b6e6e8SMatthew G. Knepley     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
18897b6e6e8SMatthew G. Knepley   }
1897d8a60eaSMatthew G. Knepley   ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1907d8a60eaSMatthew G. Knepley   PetscFunctionReturn(0);
1917d8a60eaSMatthew G. Knepley }
1927d8a60eaSMatthew G. Knepley 
1932764a2aaSMatthew G. Knepley /*@C
1942764a2aaSMatthew G. Knepley   PetscDSView - Views a PetscDS
1952764a2aaSMatthew G. Knepley 
1962764a2aaSMatthew G. Knepley   Collective on PetscDS
1972764a2aaSMatthew G. Knepley 
1982764a2aaSMatthew G. Knepley   Input Parameter:
1992764a2aaSMatthew G. Knepley + prob - the PetscDS object to view
2002764a2aaSMatthew G. Knepley - v  - the viewer
2012764a2aaSMatthew G. Knepley 
2022764a2aaSMatthew G. Knepley   Level: developer
2032764a2aaSMatthew G. Knepley 
2042764a2aaSMatthew G. Knepley .seealso PetscDSDestroy()
2052764a2aaSMatthew G. Knepley @*/
2062764a2aaSMatthew G. Knepley PetscErrorCode PetscDSView(PetscDS prob, PetscViewer v)
2072764a2aaSMatthew G. Knepley {
2087d8a60eaSMatthew G. Knepley   PetscBool      iascii;
2092764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
2102764a2aaSMatthew G. Knepley 
2112764a2aaSMatthew G. Knepley   PetscFunctionBegin;
2122764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2132764a2aaSMatthew G. Knepley   if (!v) {ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject) prob), &v);CHKERRQ(ierr);}
2147d8a60eaSMatthew G. Knepley   else    {PetscValidHeaderSpecific(v, PETSC_VIEWER_CLASSID, 2);}
2157d8a60eaSMatthew G. Knepley   ierr = PetscObjectTypeCompare((PetscObject) v, PETSCVIEWERASCII, &iascii);CHKERRQ(ierr);
2167d8a60eaSMatthew G. Knepley   if (iascii) {ierr = PetscDSView_Ascii(prob, v);CHKERRQ(ierr);}
2172764a2aaSMatthew G. Knepley   if (prob->ops->view) {ierr = (*prob->ops->view)(prob, v);CHKERRQ(ierr);}
2182764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
2192764a2aaSMatthew G. Knepley }
2202764a2aaSMatthew G. Knepley 
2212764a2aaSMatthew G. Knepley /*@
2222764a2aaSMatthew G. Knepley   PetscDSSetFromOptions - sets parameters in a PetscDS from the options database
2232764a2aaSMatthew G. Knepley 
2242764a2aaSMatthew G. Knepley   Collective on PetscDS
2252764a2aaSMatthew G. Knepley 
2262764a2aaSMatthew G. Knepley   Input Parameter:
2272764a2aaSMatthew G. Knepley . prob - the PetscDS object to set options for
2282764a2aaSMatthew G. Knepley 
2292764a2aaSMatthew G. Knepley   Options Database:
23055c1f793SMatthew G. Knepley + -petscds_type <type>     : Set the DS type
23155c1f793SMatthew G. Knepley . -petscds_view <view opt> : View the DS
23255c1f793SMatthew G. Knepley . -petscds_jac_pre         : Turn formation of a separate Jacobian preconditioner on and off
23355c1f793SMatthew G. Knepley . -bc_<name> <ids>         : Specify a list of label ids for a boundary condition
23455c1f793SMatthew G. Knepley - -bc_<name>_comp <comps>  : Specify a list of field components to constrain for a boundary condition
2352764a2aaSMatthew G. Knepley 
2362764a2aaSMatthew G. Knepley   Level: developer
2372764a2aaSMatthew G. Knepley 
2382764a2aaSMatthew G. Knepley .seealso PetscDSView()
2392764a2aaSMatthew G. Knepley @*/
2402764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetFromOptions(PetscDS prob)
2412764a2aaSMatthew G. Knepley {
242f1fd5e65SToby Isaac   DSBoundary     b;
2432764a2aaSMatthew G. Knepley   const char    *defaultType;
2442764a2aaSMatthew G. Knepley   char           name[256];
2452764a2aaSMatthew G. Knepley   PetscBool      flg;
2462764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
2472764a2aaSMatthew G. Knepley 
2482764a2aaSMatthew G. Knepley   PetscFunctionBegin;
2492764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2502764a2aaSMatthew G. Knepley   if (!((PetscObject) prob)->type_name) {
2512764a2aaSMatthew G. Knepley     defaultType = PETSCDSBASIC;
2522764a2aaSMatthew G. Knepley   } else {
2532764a2aaSMatthew G. Knepley     defaultType = ((PetscObject) prob)->type_name;
2542764a2aaSMatthew G. Knepley   }
2550f51fdf8SToby Isaac   ierr = PetscDSRegisterAll();CHKERRQ(ierr);
2562764a2aaSMatthew G. Knepley 
2572764a2aaSMatthew G. Knepley   ierr = PetscObjectOptionsBegin((PetscObject) prob);CHKERRQ(ierr);
258f1fd5e65SToby Isaac   for (b = prob->boundary; b; b = b->next) {
259f1fd5e65SToby Isaac     char       optname[1024];
260f1fd5e65SToby Isaac     PetscInt   ids[1024], len = 1024;
261f1fd5e65SToby Isaac     PetscBool  flg;
262f1fd5e65SToby Isaac 
263f1fd5e65SToby Isaac     ierr = PetscSNPrintf(optname, sizeof(optname), "-bc_%s", b->name);CHKERRQ(ierr);
264f1fd5e65SToby Isaac     ierr = PetscMemzero(ids, sizeof(ids));CHKERRQ(ierr);
265f1fd5e65SToby Isaac     ierr = PetscOptionsIntArray(optname, "List of boundary IDs", "", ids, &len, &flg);CHKERRQ(ierr);
266f1fd5e65SToby Isaac     if (flg) {
267f1fd5e65SToby Isaac       b->numids = len;
268f1fd5e65SToby Isaac       ierr = PetscFree(b->ids);CHKERRQ(ierr);
269f1fd5e65SToby Isaac       ierr = PetscMalloc1(len, &b->ids);CHKERRQ(ierr);
270f1fd5e65SToby Isaac       ierr = PetscMemcpy(b->ids, ids, len*sizeof(PetscInt));CHKERRQ(ierr);
271f1fd5e65SToby Isaac     }
272e7b0402cSSander Arens     len = 1024;
273f1fd5e65SToby Isaac     ierr = PetscSNPrintf(optname, sizeof(optname), "-bc_%s_comp", b->name);CHKERRQ(ierr);
274f1fd5e65SToby Isaac     ierr = PetscMemzero(ids, sizeof(ids));CHKERRQ(ierr);
275f1fd5e65SToby Isaac     ierr = PetscOptionsIntArray(optname, "List of boundary field components", "", ids, &len, &flg);CHKERRQ(ierr);
276f1fd5e65SToby Isaac     if (flg) {
277f1fd5e65SToby Isaac       b->numcomps = len;
278f1fd5e65SToby Isaac       ierr = PetscFree(b->comps);CHKERRQ(ierr);
279f1fd5e65SToby Isaac       ierr = PetscMalloc1(len, &b->comps);CHKERRQ(ierr);
280f1fd5e65SToby Isaac       ierr = PetscMemcpy(b->comps, ids, len*sizeof(PetscInt));CHKERRQ(ierr);
281f1fd5e65SToby Isaac     }
282f1fd5e65SToby Isaac   }
2832764a2aaSMatthew G. Knepley   ierr = PetscOptionsFList("-petscds_type", "Discrete System", "PetscDSSetType", PetscDSList, defaultType, name, 256, &flg);CHKERRQ(ierr);
2842764a2aaSMatthew G. Knepley   if (flg) {
2852764a2aaSMatthew G. Knepley     ierr = PetscDSSetType(prob, name);CHKERRQ(ierr);
2862764a2aaSMatthew G. Knepley   } else if (!((PetscObject) prob)->type_name) {
2872764a2aaSMatthew G. Knepley     ierr = PetscDSSetType(prob, defaultType);CHKERRQ(ierr);
2882764a2aaSMatthew G. Knepley   }
28955c1f793SMatthew G. Knepley   ierr = PetscOptionsBool("-petscds_jac_pre", "Discrete System", "PetscDSUseJacobianPreconditioner", prob->useJacPre, &prob->useJacPre, &flg);CHKERRQ(ierr);
2902764a2aaSMatthew G. Knepley   if (prob->ops->setfromoptions) {ierr = (*prob->ops->setfromoptions)(prob);CHKERRQ(ierr);}
2912764a2aaSMatthew G. Knepley   /* process any options handlers added with PetscObjectAddOptionsHandler() */
2920633abcbSJed Brown   ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject) prob);CHKERRQ(ierr);
2932764a2aaSMatthew G. Knepley   ierr = PetscOptionsEnd();CHKERRQ(ierr);
2945d160056SMatthew G. Knepley   if (prob->Nf) {ierr = PetscDSViewFromOptions(prob, NULL, "-petscds_view");CHKERRQ(ierr);}
2952764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
2962764a2aaSMatthew G. Knepley }
2972764a2aaSMatthew G. Knepley 
2982764a2aaSMatthew G. Knepley /*@C
2992764a2aaSMatthew G. Knepley   PetscDSSetUp - Construct data structures for the PetscDS
3002764a2aaSMatthew G. Knepley 
3012764a2aaSMatthew G. Knepley   Collective on PetscDS
3022764a2aaSMatthew G. Knepley 
3032764a2aaSMatthew G. Knepley   Input Parameter:
3042764a2aaSMatthew G. Knepley . prob - the PetscDS object to setup
3052764a2aaSMatthew G. Knepley 
3062764a2aaSMatthew G. Knepley   Level: developer
3072764a2aaSMatthew G. Knepley 
3082764a2aaSMatthew G. Knepley .seealso PetscDSView(), PetscDSDestroy()
3092764a2aaSMatthew G. Knepley @*/
3102764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetUp(PetscDS prob)
3112764a2aaSMatthew G. Knepley {
3122764a2aaSMatthew G. Knepley   const PetscInt Nf = prob->Nf;
313*94a5e212SMatthew G. Knepley   PetscInt       dim, dimEmbed, work, NcMax = 0, NqMax = 0, NsMax = 1, f;
3142764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
3152764a2aaSMatthew G. Knepley 
3162764a2aaSMatthew G. Knepley   PetscFunctionBegin;
3172764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
3182764a2aaSMatthew G. Knepley   if (prob->setup) PetscFunctionReturn(0);
3192764a2aaSMatthew G. Knepley   /* Calculate sizes */
3202764a2aaSMatthew G. Knepley   ierr = PetscDSGetSpatialDimension(prob, &dim);CHKERRQ(ierr);
321d1506c7cSMatthew G. Knepley   ierr = PetscDSGetCoordinateDimension(prob, &dimEmbed);CHKERRQ(ierr);
322f744cafaSSander Arens   prob->totDim = prob->totComp = 0;
32347e57110SSander Arens   ierr = PetscMalloc2(Nf,&prob->Nc,Nf,&prob->Nb);CHKERRQ(ierr);
324f744cafaSSander Arens   ierr = PetscCalloc2(Nf+1,&prob->off,Nf+1,&prob->offDer);CHKERRQ(ierr);
325f744cafaSSander Arens   ierr = PetscMalloc4(Nf,&prob->basis,Nf,&prob->basisDer,Nf,&prob->basisFace,Nf,&prob->basisDerFace);CHKERRQ(ierr);
3262764a2aaSMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
3279de99aefSMatthew G. Knepley     PetscObject     obj;
3289de99aefSMatthew G. Knepley     PetscClassId    id;
3292764a2aaSMatthew G. Knepley     PetscQuadrature q;
3309de99aefSMatthew G. Knepley     PetscInt        Nq = 0, Nb, Nc;
3312764a2aaSMatthew G. Knepley 
3329de99aefSMatthew G. Knepley     ierr = PetscDSGetDiscretization(prob, f, &obj);CHKERRQ(ierr);
3339de99aefSMatthew G. Knepley     ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr);
3349de99aefSMatthew G. Knepley     if (id == PETSCFE_CLASSID)      {
3359de99aefSMatthew G. Knepley       PetscFE fe = (PetscFE) obj;
3369de99aefSMatthew G. Knepley 
3372764a2aaSMatthew G. Knepley       ierr = PetscFEGetQuadrature(fe, &q);CHKERRQ(ierr);
3382764a2aaSMatthew G. Knepley       ierr = PetscFEGetDimension(fe, &Nb);CHKERRQ(ierr);
3392764a2aaSMatthew G. Knepley       ierr = PetscFEGetNumComponents(fe, &Nc);CHKERRQ(ierr);
3402764a2aaSMatthew G. Knepley       ierr = PetscFEGetDefaultTabulation(fe, &prob->basis[f], &prob->basisDer[f], NULL);CHKERRQ(ierr);
3414d0b9603SSander Arens       ierr = PetscFEGetFaceTabulation(fe, &prob->basisFace[f], &prob->basisDerFace[f], NULL);CHKERRQ(ierr);
3429de99aefSMatthew G. Knepley     } else if (id == PETSCFV_CLASSID) {
3439de99aefSMatthew G. Knepley       PetscFV fv = (PetscFV) obj;
3449de99aefSMatthew G. Knepley 
3459de99aefSMatthew G. Knepley       ierr = PetscFVGetQuadrature(fv, &q);CHKERRQ(ierr);
3469de99aefSMatthew G. Knepley       ierr = PetscFVGetNumComponents(fv, &Nc);CHKERRQ(ierr);
3479c3cf19fSMatthew G. Knepley       Nb   = Nc;
3486c1a3d01SMatthew G. Knepley       ierr = PetscFVGetDefaultTabulation(fv, &prob->basis[f], &prob->basisDer[f], NULL);CHKERRQ(ierr);
3494d0b9603SSander Arens       /* TODO: should PetscFV also have face tabulation? Otherwise there will be a null pointer in prob->basisFace */
350abac5ca0SMatthew G. Knepley     } else SETERRQ1(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Unknown discretization type for field %d", f);
35147e57110SSander Arens     prob->Nc[f]       = Nc;
35247e57110SSander Arens     prob->Nb[f]       = Nb;
353194d53e6SMatthew G. Knepley     prob->off[f+1]    = Nc     + prob->off[f];
354194d53e6SMatthew G. Knepley     prob->offDer[f+1] = Nc*dim + prob->offDer[f];
355a6b92713SMatthew G. Knepley     if (q) {ierr = PetscQuadratureGetData(q, NULL, NULL, &Nq, NULL, NULL);CHKERRQ(ierr);}
3562764a2aaSMatthew G. Knepley     NqMax          = PetscMax(NqMax, Nq);
3572764a2aaSMatthew G. Knepley     NcMax          = PetscMax(NcMax, Nc);
3589c3cf19fSMatthew G. Knepley     prob->totDim  += Nb;
3592764a2aaSMatthew G. Knepley     prob->totComp += Nc;
360*94a5e212SMatthew G. Knepley     /* There are two faces for all fields but the cohesive field on a hybrid cell */
361*94a5e212SMatthew G. Knepley     if (prob->isHybrid && (f < Nf-1)) prob->totDim += Nb;
3622764a2aaSMatthew G. Knepley   }
3632764a2aaSMatthew G. Knepley   work = PetscMax(prob->totComp*dim, PetscSqr(NcMax*dim));
3642764a2aaSMatthew G. Knepley   /* Allocate works space */
365*94a5e212SMatthew G. Knepley   if (prob->isHybrid) NsMax = 2;
366*94a5e212SMatthew G. Knepley   ierr = PetscMalloc5(NsMax*prob->totComp,&prob->u,NsMax*prob->totComp,&prob->u_t,NsMax*prob->totComp*dimEmbed,&prob->u_x,dimEmbed,&prob->x,work,&prob->refSpaceDer);CHKERRQ(ierr);
367*94a5e212SMatthew G. Knepley   ierr = PetscMalloc6(NsMax*NqMax*NcMax,&prob->f0,NsMax*NqMax*NcMax*dim,&prob->f1,
368*94a5e212SMatthew G. Knepley                       NsMax*NsMax*NqMax*NcMax*NcMax,&prob->g0,NsMax*NsMax*NqMax*NcMax*NcMax*dim,&prob->g1,
369*94a5e212SMatthew G. Knepley                       NsMax*NsMax*NqMax*NcMax*NcMax*dim,&prob->g2,NsMax*NsMax*NqMax*NcMax*NcMax*dim*dim,&prob->g3);CHKERRQ(ierr);
3702764a2aaSMatthew G. Knepley   if (prob->ops->setup) {ierr = (*prob->ops->setup)(prob);CHKERRQ(ierr);}
3712764a2aaSMatthew G. Knepley   prob->setup = PETSC_TRUE;
3722764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
3732764a2aaSMatthew G. Knepley }
3742764a2aaSMatthew G. Knepley 
3752764a2aaSMatthew G. Knepley static PetscErrorCode PetscDSDestroyStructs_Static(PetscDS prob)
3762764a2aaSMatthew G. Knepley {
3772764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
3782764a2aaSMatthew G. Knepley 
3792764a2aaSMatthew G. Knepley   PetscFunctionBegin;
38047e57110SSander Arens   ierr = PetscFree2(prob->Nc,prob->Nb);CHKERRQ(ierr);
381f744cafaSSander Arens   ierr = PetscFree2(prob->off,prob->offDer);CHKERRQ(ierr);
382f744cafaSSander Arens   ierr = PetscFree4(prob->basis,prob->basisDer,prob->basisFace,prob->basisDerFace);CHKERRQ(ierr);
3832764a2aaSMatthew G. Knepley   ierr = PetscFree5(prob->u,prob->u_t,prob->u_x,prob->x,prob->refSpaceDer);CHKERRQ(ierr);
3842764a2aaSMatthew G. Knepley   ierr = PetscFree6(prob->f0,prob->f1,prob->g0,prob->g1,prob->g2,prob->g3);CHKERRQ(ierr);
3852764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
3862764a2aaSMatthew G. Knepley }
3872764a2aaSMatthew G. Knepley 
3882764a2aaSMatthew G. Knepley static PetscErrorCode PetscDSEnlarge_Static(PetscDS prob, PetscInt NfNew)
3892764a2aaSMatthew G. Knepley {
390f744cafaSSander Arens   PetscObject      *tmpd;
391a6cbbb48SMatthew G. Knepley   PetscBool        *tmpi, *tmpa;
39232d2bbc9SMatthew G. Knepley   PetscPointFunc   *tmpobj, *tmpf, *tmpup;
393b7e05686SMatthew G. Knepley   PetscPointJac    *tmpg, *tmpgp, *tmpgt;
3942aa1fc23SMatthew G. Knepley   PetscBdPointFunc *tmpfbd;
3952aa1fc23SMatthew G. Knepley   PetscBdPointJac  *tmpgbd;
396194d53e6SMatthew G. Knepley   PetscRiemannFunc *tmpr;
397c371a6d1SMatthew G. Knepley   PetscSimplePointFunc *tmpexactSol;
3980c2f2876SMatthew G. Knepley   void            **tmpctx;
399a6cbbb48SMatthew G. Knepley   PetscInt          Nf = prob->Nf, f, i;
4002764a2aaSMatthew G. Knepley   PetscErrorCode    ierr;
4012764a2aaSMatthew G. Knepley 
4022764a2aaSMatthew G. Knepley   PetscFunctionBegin;
4032764a2aaSMatthew G. Knepley   if (Nf >= NfNew) PetscFunctionReturn(0);
4042764a2aaSMatthew G. Knepley   prob->setup = PETSC_FALSE;
4052764a2aaSMatthew G. Knepley   ierr = PetscDSDestroyStructs_Static(prob);CHKERRQ(ierr);
406f744cafaSSander Arens   ierr = PetscMalloc3(NfNew, &tmpd, NfNew, &tmpi, NfNew*2, &tmpa);CHKERRQ(ierr);
407f744cafaSSander Arens   for (f = 0; f < Nf; ++f) {tmpd[f] = prob->disc[f]; tmpi[f] = prob->implicit[f]; for (i = 0; i < 2; ++i) tmpa[f*2+i] = prob->adjacency[f*2+i];}
408f744cafaSSander Arens   for (f = Nf; f < NfNew; ++f) {tmpd[f] = NULL; tmpi[f] = PETSC_TRUE; tmpa[f*2+0] = PETSC_FALSE; tmpa[f*2+1] = PETSC_TRUE;}
409f744cafaSSander Arens   ierr = PetscFree3(prob->disc, prob->implicit, prob->adjacency);CHKERRQ(ierr);
4102764a2aaSMatthew G. Knepley   prob->Nf        = NfNew;
4112764a2aaSMatthew G. Knepley   prob->disc      = tmpd;
412249df284SMatthew G. Knepley   prob->implicit  = tmpi;
413a6cbbb48SMatthew G. Knepley   prob->adjacency = tmpa;
414b7e05686SMatthew 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);
41532d2bbc9SMatthew G. Knepley   ierr = PetscCalloc1(NfNew, &tmpup);CHKERRQ(ierr);
4162764a2aaSMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpobj[f] = prob->obj[f];
4172764a2aaSMatthew G. Knepley   for (f = 0; f < Nf*2; ++f) tmpf[f] = prob->f[f];
4182764a2aaSMatthew G. Knepley   for (f = 0; f < Nf*Nf*4; ++f) tmpg[f] = prob->g[f];
419475e0ac9SMatthew G. Knepley   for (f = 0; f < Nf*Nf*4; ++f) tmpgp[f] = prob->gp[f];
4200c2f2876SMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpr[f] = prob->r[f];
42132d2bbc9SMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpup[f] = prob->update[f];
4220c2f2876SMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpctx[f] = prob->ctx[f];
4232764a2aaSMatthew G. Knepley   for (f = Nf; f < NfNew; ++f) tmpobj[f] = NULL;
4242764a2aaSMatthew G. Knepley   for (f = Nf*2; f < NfNew*2; ++f) tmpf[f] = NULL;
4252764a2aaSMatthew G. Knepley   for (f = Nf*Nf*4; f < NfNew*NfNew*4; ++f) tmpg[f] = NULL;
426475e0ac9SMatthew G. Knepley   for (f = Nf*Nf*4; f < NfNew*NfNew*4; ++f) tmpgp[f] = NULL;
427b7e05686SMatthew G. Knepley   for (f = Nf*Nf*4; f < NfNew*NfNew*4; ++f) tmpgt[f] = NULL;
4280c2f2876SMatthew G. Knepley   for (f = Nf; f < NfNew; ++f) tmpr[f] = NULL;
42932d2bbc9SMatthew G. Knepley   for (f = Nf; f < NfNew; ++f) tmpup[f] = NULL;
4300c2f2876SMatthew G. Knepley   for (f = Nf; f < NfNew; ++f) tmpctx[f] = NULL;
431b7e05686SMatthew G. Knepley   ierr = PetscFree7(prob->obj, prob->f, prob->g, prob->gp, prob->gt, prob->r, prob->ctx);CHKERRQ(ierr);
43232d2bbc9SMatthew G. Knepley   ierr = PetscFree(prob->update);CHKERRQ(ierr);
4332764a2aaSMatthew G. Knepley   prob->obj = tmpobj;
4342764a2aaSMatthew G. Knepley   prob->f   = tmpf;
4352764a2aaSMatthew G. Knepley   prob->g   = tmpg;
436475e0ac9SMatthew G. Knepley   prob->gp  = tmpgp;
437b7e05686SMatthew G. Knepley   prob->gt  = tmpgt;
4380c2f2876SMatthew G. Knepley   prob->r   = tmpr;
43932d2bbc9SMatthew G. Knepley   prob->update = tmpup;
4400c2f2876SMatthew G. Knepley   prob->ctx = tmpctx;
441c371a6d1SMatthew G. Knepley   ierr = PetscCalloc3(NfNew*2, &tmpfbd, NfNew*NfNew*4, &tmpgbd, NfNew, &tmpexactSol);CHKERRQ(ierr);
4422764a2aaSMatthew G. Knepley   for (f = 0; f < Nf*2; ++f) tmpfbd[f] = prob->fBd[f];
4432764a2aaSMatthew G. Knepley   for (f = 0; f < Nf*Nf*4; ++f) tmpgbd[f] = prob->gBd[f];
444c371a6d1SMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpexactSol[f] = prob->exactSol[f];
4452764a2aaSMatthew G. Knepley   for (f = Nf*2; f < NfNew*2; ++f) tmpfbd[f] = NULL;
4462764a2aaSMatthew G. Knepley   for (f = Nf*Nf*4; f < NfNew*NfNew*4; ++f) tmpgbd[f] = NULL;
447c371a6d1SMatthew G. Knepley   for (f = Nf; f < NfNew; ++f) tmpexactSol[f] = NULL;
448c371a6d1SMatthew G. Knepley   ierr = PetscFree3(prob->fBd, prob->gBd, prob->exactSol);CHKERRQ(ierr);
4492764a2aaSMatthew G. Knepley   prob->fBd = tmpfbd;
4502764a2aaSMatthew G. Knepley   prob->gBd = tmpgbd;
451c371a6d1SMatthew G. Knepley   prob->exactSol = tmpexactSol;
4522764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
4532764a2aaSMatthew G. Knepley }
4542764a2aaSMatthew G. Knepley 
4552764a2aaSMatthew G. Knepley /*@
4562764a2aaSMatthew G. Knepley   PetscDSDestroy - Destroys a PetscDS object
4572764a2aaSMatthew G. Knepley 
4582764a2aaSMatthew G. Knepley   Collective on PetscDS
4592764a2aaSMatthew G. Knepley 
4602764a2aaSMatthew G. Knepley   Input Parameter:
4612764a2aaSMatthew G. Knepley . prob - the PetscDS object to destroy
4622764a2aaSMatthew G. Knepley 
4632764a2aaSMatthew G. Knepley   Level: developer
4642764a2aaSMatthew G. Knepley 
4652764a2aaSMatthew G. Knepley .seealso PetscDSView()
4662764a2aaSMatthew G. Knepley @*/
4672764a2aaSMatthew G. Knepley PetscErrorCode PetscDSDestroy(PetscDS *prob)
4682764a2aaSMatthew G. Knepley {
4692764a2aaSMatthew G. Knepley   PetscInt       f;
47058ebd649SToby Isaac   DSBoundary     next;
4712764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
4722764a2aaSMatthew G. Knepley 
4732764a2aaSMatthew G. Knepley   PetscFunctionBegin;
4742764a2aaSMatthew G. Knepley   if (!*prob) PetscFunctionReturn(0);
4752764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific((*prob), PETSCDS_CLASSID, 1);
4762764a2aaSMatthew G. Knepley 
4772764a2aaSMatthew G. Knepley   if (--((PetscObject)(*prob))->refct > 0) {*prob = 0; PetscFunctionReturn(0);}
4782764a2aaSMatthew G. Knepley   ((PetscObject) (*prob))->refct = 0;
479df3a45bdSMatthew G. Knepley   if ((*prob)->subprobs) {
480df3a45bdSMatthew G. Knepley     PetscInt dim, d;
481df3a45bdSMatthew G. Knepley 
482df3a45bdSMatthew G. Knepley     ierr = PetscDSGetSpatialDimension(*prob, &dim);CHKERRQ(ierr);
483df3a45bdSMatthew G. Knepley     for (d = 0; d < dim; ++d) {ierr = PetscDSDestroy(&(*prob)->subprobs[d]);CHKERRQ(ierr);}
484df3a45bdSMatthew G. Knepley   }
485df3a45bdSMatthew G. Knepley   ierr = PetscFree((*prob)->subprobs);CHKERRQ(ierr);
4862764a2aaSMatthew G. Knepley   ierr = PetscDSDestroyStructs_Static(*prob);CHKERRQ(ierr);
4872764a2aaSMatthew G. Knepley   for (f = 0; f < (*prob)->Nf; ++f) {
4882764a2aaSMatthew G. Knepley     ierr = PetscObjectDereference((*prob)->disc[f]);CHKERRQ(ierr);
4892764a2aaSMatthew G. Knepley   }
490f744cafaSSander Arens   ierr = PetscFree3((*prob)->disc, (*prob)->implicit, (*prob)->adjacency);CHKERRQ(ierr);
491b7e05686SMatthew G. Knepley   ierr = PetscFree7((*prob)->obj,(*prob)->f,(*prob)->g,(*prob)->gp,(*prob)->gt,(*prob)->r,(*prob)->ctx);CHKERRQ(ierr);
49232d2bbc9SMatthew G. Knepley   ierr = PetscFree((*prob)->update);CHKERRQ(ierr);
493c371a6d1SMatthew G. Knepley   ierr = PetscFree3((*prob)->fBd,(*prob)->gBd,(*prob)->exactSol);CHKERRQ(ierr);
4942764a2aaSMatthew G. Knepley   if ((*prob)->ops->destroy) {ierr = (*(*prob)->ops->destroy)(*prob);CHKERRQ(ierr);}
49558ebd649SToby Isaac   next = (*prob)->boundary;
49658ebd649SToby Isaac   while (next) {
49758ebd649SToby Isaac     DSBoundary b = next;
49858ebd649SToby Isaac 
49958ebd649SToby Isaac     next = b->next;
50058ebd649SToby Isaac     ierr = PetscFree(b->comps);CHKERRQ(ierr);
50158ebd649SToby Isaac     ierr = PetscFree(b->ids);CHKERRQ(ierr);
50258ebd649SToby Isaac     ierr = PetscFree(b->name);CHKERRQ(ierr);
50358ebd649SToby Isaac     ierr = PetscFree(b->labelname);CHKERRQ(ierr);
50458ebd649SToby Isaac     ierr = PetscFree(b);CHKERRQ(ierr);
50558ebd649SToby Isaac   }
50697b6e6e8SMatthew G. Knepley   ierr = PetscFree((*prob)->constants);CHKERRQ(ierr);
5072764a2aaSMatthew G. Knepley   ierr = PetscHeaderDestroy(prob);CHKERRQ(ierr);
5082764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
5092764a2aaSMatthew G. Knepley }
5102764a2aaSMatthew G. Knepley 
5112764a2aaSMatthew G. Knepley /*@
5122764a2aaSMatthew G. Knepley   PetscDSCreate - Creates an empty PetscDS object. The type can then be set with PetscDSSetType().
5132764a2aaSMatthew G. Knepley 
5142764a2aaSMatthew G. Knepley   Collective on MPI_Comm
5152764a2aaSMatthew G. Knepley 
5162764a2aaSMatthew G. Knepley   Input Parameter:
5172764a2aaSMatthew G. Knepley . comm - The communicator for the PetscDS object
5182764a2aaSMatthew G. Knepley 
5192764a2aaSMatthew G. Knepley   Output Parameter:
5202764a2aaSMatthew G. Knepley . prob - The PetscDS object
5212764a2aaSMatthew G. Knepley 
5222764a2aaSMatthew G. Knepley   Level: beginner
5232764a2aaSMatthew G. Knepley 
5242764a2aaSMatthew G. Knepley .seealso: PetscDSSetType(), PETSCDSBASIC
5252764a2aaSMatthew G. Knepley @*/
5262764a2aaSMatthew G. Knepley PetscErrorCode PetscDSCreate(MPI_Comm comm, PetscDS *prob)
5272764a2aaSMatthew G. Knepley {
5282764a2aaSMatthew G. Knepley   PetscDS   p;
5292764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
5302764a2aaSMatthew G. Knepley 
5312764a2aaSMatthew G. Knepley   PetscFunctionBegin;
5322764a2aaSMatthew G. Knepley   PetscValidPointer(prob, 2);
5332764a2aaSMatthew G. Knepley   *prob  = NULL;
5342764a2aaSMatthew G. Knepley   ierr = PetscDSInitializePackage();CHKERRQ(ierr);
5352764a2aaSMatthew G. Knepley 
53673107ff1SLisandro Dalcin   ierr = PetscHeaderCreate(p, PETSCDS_CLASSID, "PetscDS", "Discrete System", "PetscDS", comm, PetscDSDestroy, PetscDSView);CHKERRQ(ierr);
5372764a2aaSMatthew G. Knepley 
5382764a2aaSMatthew G. Knepley   p->Nf    = 0;
5392764a2aaSMatthew G. Knepley   p->setup = PETSC_FALSE;
54097b6e6e8SMatthew G. Knepley   p->numConstants  = 0;
54197b6e6e8SMatthew G. Knepley   p->constants     = NULL;
542a859676bSMatthew G. Knepley   p->dimEmbed      = -1;
54303d90f89SMatthew G. Knepley   p->defaultAdj[0] = PETSC_FALSE;
54403d90f89SMatthew G. Knepley   p->defaultAdj[1] = PETSC_TRUE;
54555c1f793SMatthew G. Knepley   p->useJacPre     = PETSC_TRUE;
5462764a2aaSMatthew G. Knepley 
5472764a2aaSMatthew G. Knepley   *prob = p;
5482764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
5492764a2aaSMatthew G. Knepley }
5502764a2aaSMatthew G. Knepley 
551bc4ae4beSMatthew G. Knepley /*@
552bc4ae4beSMatthew G. Knepley   PetscDSGetNumFields - Returns the number of fields in the DS
553bc4ae4beSMatthew G. Knepley 
554bc4ae4beSMatthew G. Knepley   Not collective
555bc4ae4beSMatthew G. Knepley 
556bc4ae4beSMatthew G. Knepley   Input Parameter:
557bc4ae4beSMatthew G. Knepley . prob - The PetscDS object
558bc4ae4beSMatthew G. Knepley 
559bc4ae4beSMatthew G. Knepley   Output Parameter:
560bc4ae4beSMatthew G. Knepley . Nf - The number of fields
561bc4ae4beSMatthew G. Knepley 
562bc4ae4beSMatthew G. Knepley   Level: beginner
563bc4ae4beSMatthew G. Knepley 
564bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetSpatialDimension(), PetscDSCreate()
565bc4ae4beSMatthew G. Knepley @*/
5662764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetNumFields(PetscDS prob, PetscInt *Nf)
5672764a2aaSMatthew G. Knepley {
5682764a2aaSMatthew G. Knepley   PetscFunctionBegin;
5692764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
5702764a2aaSMatthew G. Knepley   PetscValidPointer(Nf, 2);
5712764a2aaSMatthew G. Knepley   *Nf = prob->Nf;
5722764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
5732764a2aaSMatthew G. Knepley }
5742764a2aaSMatthew G. Knepley 
575bc4ae4beSMatthew G. Knepley /*@
576a859676bSMatthew G. Knepley   PetscDSGetSpatialDimension - Returns the spatial dimension of the DS, meaning the topological dimension of the discretizations
577bc4ae4beSMatthew G. Knepley 
578bc4ae4beSMatthew G. Knepley   Not collective
579bc4ae4beSMatthew G. Knepley 
580bc4ae4beSMatthew G. Knepley   Input Parameter:
581bc4ae4beSMatthew G. Knepley . prob - The PetscDS object
582bc4ae4beSMatthew G. Knepley 
583bc4ae4beSMatthew G. Knepley   Output Parameter:
584bc4ae4beSMatthew G. Knepley . dim - The spatial dimension
585bc4ae4beSMatthew G. Knepley 
586bc4ae4beSMatthew G. Knepley   Level: beginner
587bc4ae4beSMatthew G. Knepley 
588a859676bSMatthew G. Knepley .seealso: PetscDSGetCoordinateDimension(), PetscDSGetNumFields(), PetscDSCreate()
589bc4ae4beSMatthew G. Knepley @*/
5902764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetSpatialDimension(PetscDS prob, PetscInt *dim)
5912764a2aaSMatthew G. Knepley {
5922764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
5932764a2aaSMatthew G. Knepley 
5942764a2aaSMatthew G. Knepley   PetscFunctionBegin;
5952764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
5962764a2aaSMatthew G. Knepley   PetscValidPointer(dim, 2);
5972764a2aaSMatthew G. Knepley   *dim = 0;
5989de99aefSMatthew G. Knepley   if (prob->Nf) {
5999de99aefSMatthew G. Knepley     PetscObject  obj;
6009de99aefSMatthew G. Knepley     PetscClassId id;
6019de99aefSMatthew G. Knepley 
6029de99aefSMatthew G. Knepley     ierr = PetscDSGetDiscretization(prob, 0, &obj);CHKERRQ(ierr);
6039de99aefSMatthew G. Knepley     ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr);
6049de99aefSMatthew G. Knepley     if (id == PETSCFE_CLASSID)      {ierr = PetscFEGetSpatialDimension((PetscFE) obj, dim);CHKERRQ(ierr);}
6059de99aefSMatthew G. Knepley     else if (id == PETSCFV_CLASSID) {ierr = PetscFVGetSpatialDimension((PetscFV) obj, dim);CHKERRQ(ierr);}
6069de99aefSMatthew G. Knepley     else SETERRQ1(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Unknown discretization type for field %d", 0);
6079de99aefSMatthew G. Knepley   }
6082764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
6092764a2aaSMatthew G. Knepley }
6102764a2aaSMatthew G. Knepley 
611bc4ae4beSMatthew G. Knepley /*@
612a859676bSMatthew G. Knepley   PetscDSGetCoordinateDimension - Returns the coordinate dimension of the DS, meaning the dimension of the space into which the discretiaztions are embedded
613a859676bSMatthew G. Knepley 
614a859676bSMatthew G. Knepley   Not collective
615a859676bSMatthew G. Knepley 
616a859676bSMatthew G. Knepley   Input Parameter:
617a859676bSMatthew G. Knepley . prob - The PetscDS object
618a859676bSMatthew G. Knepley 
619a859676bSMatthew G. Knepley   Output Parameter:
620a859676bSMatthew G. Knepley . dimEmbed - The coordinate dimension
621a859676bSMatthew G. Knepley 
622a859676bSMatthew G. Knepley   Level: beginner
623a859676bSMatthew G. Knepley 
624a859676bSMatthew G. Knepley .seealso: PetscDSSetCoordinateDimension(), PetscDSGetSpatialDimension(), PetscDSGetNumFields(), PetscDSCreate()
625a859676bSMatthew G. Knepley @*/
626a859676bSMatthew G. Knepley PetscErrorCode PetscDSGetCoordinateDimension(PetscDS prob, PetscInt *dimEmbed)
627a859676bSMatthew G. Knepley {
628a859676bSMatthew G. Knepley   PetscFunctionBegin;
629a859676bSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
630a859676bSMatthew G. Knepley   PetscValidPointer(dimEmbed, 2);
631a859676bSMatthew G. Knepley   if (prob->dimEmbed < 0) SETERRQ(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONGSTATE, "No coordinate dimension set for this DS");
632a859676bSMatthew G. Knepley   *dimEmbed = prob->dimEmbed;
633a859676bSMatthew G. Knepley   PetscFunctionReturn(0);
634a859676bSMatthew G. Knepley }
635a859676bSMatthew G. Knepley 
636a859676bSMatthew G. Knepley /*@
637a859676bSMatthew G. Knepley   PetscDSSetCoordinateDimension - Set the coordinate dimension of the DS, meaning the dimension of the space into which the discretiaztions are embedded
638a859676bSMatthew G. Knepley 
639a859676bSMatthew G. Knepley   Not collective
640a859676bSMatthew G. Knepley 
641a859676bSMatthew G. Knepley   Input Parameters:
642a859676bSMatthew G. Knepley + prob - The PetscDS object
643a859676bSMatthew G. Knepley - dimEmbed - The coordinate dimension
644a859676bSMatthew G. Knepley 
645a859676bSMatthew G. Knepley   Level: beginner
646a859676bSMatthew G. Knepley 
647a859676bSMatthew G. Knepley .seealso: PetscDSGetCoordinateDimension(), PetscDSGetSpatialDimension(), PetscDSGetNumFields(), PetscDSCreate()
648a859676bSMatthew G. Knepley @*/
649a859676bSMatthew G. Knepley PetscErrorCode PetscDSSetCoordinateDimension(PetscDS prob, PetscInt dimEmbed)
650a859676bSMatthew G. Knepley {
651a859676bSMatthew G. Knepley   PetscFunctionBegin;
652a859676bSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
653a859676bSMatthew G. Knepley   prob->dimEmbed = dimEmbed;
654a859676bSMatthew G. Knepley   PetscFunctionReturn(0);
655a859676bSMatthew G. Knepley }
656a859676bSMatthew G. Knepley 
657a859676bSMatthew G. Knepley /*@
6588edf6225SMatthew G. Knepley   PetscDSGetHybrid - Returns the flag for a hybrid (cohesive) cell
6598edf6225SMatthew G. Knepley 
6608edf6225SMatthew G. Knepley   Not collective
6618edf6225SMatthew G. Knepley 
6628edf6225SMatthew G. Knepley   Input Parameter:
6638edf6225SMatthew G. Knepley . prob - The PetscDS object
6648edf6225SMatthew G. Knepley 
6658edf6225SMatthew G. Knepley   Output Parameter:
6668edf6225SMatthew G. Knepley . isHybrid - The flag
6678edf6225SMatthew G. Knepley 
6688edf6225SMatthew G. Knepley   Level: developer
6698edf6225SMatthew G. Knepley 
6708edf6225SMatthew G. Knepley .seealso: PetscDSSetHybrid(), PetscDSCreate()
6718edf6225SMatthew G. Knepley @*/
6728edf6225SMatthew G. Knepley PetscErrorCode PetscDSGetHybrid(PetscDS prob, PetscBool *isHybrid)
6738edf6225SMatthew G. Knepley {
6748edf6225SMatthew G. Knepley   PetscFunctionBegin;
6758edf6225SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
6768edf6225SMatthew G. Knepley   PetscValidPointer(isHybrid, 2);
6778edf6225SMatthew G. Knepley   *isHybrid = prob->isHybrid;
6788edf6225SMatthew G. Knepley   PetscFunctionReturn(0);
6798edf6225SMatthew G. Knepley }
6808edf6225SMatthew G. Knepley 
6818edf6225SMatthew G. Knepley /*@
6828edf6225SMatthew G. Knepley   PetscDSSetHybrid - Set the flag for a hybrid (cohesive) cell
6838edf6225SMatthew G. Knepley 
6848edf6225SMatthew G. Knepley   Not collective
6858edf6225SMatthew G. Knepley 
6868edf6225SMatthew G. Knepley   Input Parameters:
6878edf6225SMatthew G. Knepley + prob - The PetscDS object
6888edf6225SMatthew G. Knepley - isHybrid - The flag
6898edf6225SMatthew G. Knepley 
6908edf6225SMatthew G. Knepley   Level: developer
6918edf6225SMatthew G. Knepley 
6928edf6225SMatthew G. Knepley .seealso: PetscDSGetHybrid(), PetscDSCreate()
6938edf6225SMatthew G. Knepley @*/
6948edf6225SMatthew G. Knepley PetscErrorCode PetscDSSetHybrid(PetscDS prob, PetscBool isHybrid)
6958edf6225SMatthew G. Knepley {
6968edf6225SMatthew G. Knepley   PetscFunctionBegin;
6978edf6225SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
6988edf6225SMatthew G. Knepley   prob->isHybrid = isHybrid;
6998edf6225SMatthew G. Knepley   PetscFunctionReturn(0);
7008edf6225SMatthew G. Knepley }
7018edf6225SMatthew G. Knepley 
7028edf6225SMatthew G. Knepley /*@
703bc4ae4beSMatthew G. Knepley   PetscDSGetTotalDimension - Returns the total size of the approximation space for this system
704bc4ae4beSMatthew G. Knepley 
705bc4ae4beSMatthew G. Knepley   Not collective
706bc4ae4beSMatthew G. Knepley 
707bc4ae4beSMatthew G. Knepley   Input Parameter:
708bc4ae4beSMatthew G. Knepley . prob - The PetscDS object
709bc4ae4beSMatthew G. Knepley 
710bc4ae4beSMatthew G. Knepley   Output Parameter:
711bc4ae4beSMatthew G. Knepley . dim - The total problem dimension
712bc4ae4beSMatthew G. Knepley 
713bc4ae4beSMatthew G. Knepley   Level: beginner
714bc4ae4beSMatthew G. Knepley 
715bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetNumFields(), PetscDSCreate()
716bc4ae4beSMatthew G. Knepley @*/
7172764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetTotalDimension(PetscDS prob, PetscInt *dim)
7182764a2aaSMatthew G. Knepley {
7192764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
7202764a2aaSMatthew G. Knepley 
7212764a2aaSMatthew G. Knepley   PetscFunctionBegin;
7222764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
7232764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
7242764a2aaSMatthew G. Knepley   PetscValidPointer(dim, 2);
7252764a2aaSMatthew G. Knepley   *dim = prob->totDim;
7262764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
7272764a2aaSMatthew G. Knepley }
7282764a2aaSMatthew G. Knepley 
729bc4ae4beSMatthew G. Knepley /*@
730bc4ae4beSMatthew G. Knepley   PetscDSGetTotalComponents - Returns the total number of components in this system
731bc4ae4beSMatthew G. Knepley 
732bc4ae4beSMatthew G. Knepley   Not collective
733bc4ae4beSMatthew G. Knepley 
734bc4ae4beSMatthew G. Knepley   Input Parameter:
735bc4ae4beSMatthew G. Knepley . prob - The PetscDS object
736bc4ae4beSMatthew G. Knepley 
737bc4ae4beSMatthew G. Knepley   Output Parameter:
738bc4ae4beSMatthew G. Knepley . dim - The total number of components
739bc4ae4beSMatthew G. Knepley 
740bc4ae4beSMatthew G. Knepley   Level: beginner
741bc4ae4beSMatthew G. Knepley 
742bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetNumFields(), PetscDSCreate()
743bc4ae4beSMatthew G. Knepley @*/
7442764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetTotalComponents(PetscDS prob, PetscInt *Nc)
7452764a2aaSMatthew G. Knepley {
7462764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
7472764a2aaSMatthew G. Knepley 
7482764a2aaSMatthew G. Knepley   PetscFunctionBegin;
7492764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
7502764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
7512764a2aaSMatthew G. Knepley   PetscValidPointer(Nc, 2);
7522764a2aaSMatthew G. Knepley   *Nc = prob->totComp;
7532764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
7542764a2aaSMatthew G. Knepley }
7552764a2aaSMatthew G. Knepley 
756bc4ae4beSMatthew G. Knepley /*@
757bc4ae4beSMatthew G. Knepley   PetscDSGetDiscretization - Returns the discretization object for the given field
758bc4ae4beSMatthew G. Knepley 
759bc4ae4beSMatthew G. Knepley   Not collective
760bc4ae4beSMatthew G. Knepley 
761bc4ae4beSMatthew G. Knepley   Input Parameters:
762bc4ae4beSMatthew G. Knepley + prob - The PetscDS object
763bc4ae4beSMatthew G. Knepley - f - The field number
764bc4ae4beSMatthew G. Knepley 
765bc4ae4beSMatthew G. Knepley   Output Parameter:
766bc4ae4beSMatthew G. Knepley . disc - The discretization object
767bc4ae4beSMatthew G. Knepley 
768bc4ae4beSMatthew G. Knepley   Level: beginner
769bc4ae4beSMatthew G. Knepley 
770f744cafaSSander Arens .seealso: PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
771bc4ae4beSMatthew G. Knepley @*/
7722764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetDiscretization(PetscDS prob, PetscInt f, PetscObject *disc)
7732764a2aaSMatthew G. Knepley {
7742764a2aaSMatthew G. Knepley   PetscFunctionBegin;
7752764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
7762764a2aaSMatthew G. Knepley   PetscValidPointer(disc, 3);
7772764a2aaSMatthew 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);
7782764a2aaSMatthew G. Knepley   *disc = prob->disc[f];
7792764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
7802764a2aaSMatthew G. Knepley }
7812764a2aaSMatthew G. Knepley 
782bc4ae4beSMatthew G. Knepley /*@
783bc4ae4beSMatthew G. Knepley   PetscDSSetDiscretization - Sets the discretization object for the given field
784bc4ae4beSMatthew G. Knepley 
785bc4ae4beSMatthew G. Knepley   Not collective
786bc4ae4beSMatthew G. Knepley 
787bc4ae4beSMatthew G. Knepley   Input Parameters:
788bc4ae4beSMatthew G. Knepley + prob - The PetscDS object
789bc4ae4beSMatthew G. Knepley . f - The field number
790bc4ae4beSMatthew G. Knepley - disc - The discretization object
791bc4ae4beSMatthew G. Knepley 
792bc4ae4beSMatthew G. Knepley   Level: beginner
793bc4ae4beSMatthew G. Knepley 
794bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
795bc4ae4beSMatthew G. Knepley @*/
7962764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetDiscretization(PetscDS prob, PetscInt f, PetscObject disc)
7972764a2aaSMatthew G. Knepley {
7982764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
7992764a2aaSMatthew G. Knepley 
8002764a2aaSMatthew G. Knepley   PetscFunctionBegin;
8012764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
8022764a2aaSMatthew G. Knepley   PetscValidPointer(disc, 3);
8032764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
8042764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
805c10f2116SMatthew G. Knepley   ierr = PetscObjectDereference(prob->disc[f]);CHKERRQ(ierr);
8062764a2aaSMatthew G. Knepley   prob->disc[f] = disc;
8072764a2aaSMatthew G. Knepley   ierr = PetscObjectReference(disc);CHKERRQ(ierr);
808249df284SMatthew G. Knepley   {
809249df284SMatthew G. Knepley     PetscClassId id;
810249df284SMatthew G. Knepley 
811249df284SMatthew G. Knepley     ierr = PetscObjectGetClassId(disc, &id);CHKERRQ(ierr);
8121cf84007SMatthew G. Knepley     if (id == PETSCFE_CLASSID) {
8131cf84007SMatthew G. Knepley       ierr = PetscDSSetImplicit(prob, f, PETSC_TRUE);CHKERRQ(ierr);
8141cf84007SMatthew G. Knepley       ierr = PetscDSSetAdjacency(prob, f, PETSC_FALSE, PETSC_TRUE);CHKERRQ(ierr);
8151cf84007SMatthew G. Knepley     } else if (id == PETSCFV_CLASSID) {
8161cf84007SMatthew G. Knepley       ierr = PetscDSSetImplicit(prob, f, PETSC_FALSE);CHKERRQ(ierr);
8171cf84007SMatthew G. Knepley       ierr = PetscDSSetAdjacency(prob, f, PETSC_TRUE, PETSC_FALSE);CHKERRQ(ierr);
818a6cbbb48SMatthew G. Knepley     }
819249df284SMatthew G. Knepley   }
8202764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
8212764a2aaSMatthew G. Knepley }
8222764a2aaSMatthew G. Knepley 
823bc4ae4beSMatthew G. Knepley /*@
824bc4ae4beSMatthew G. Knepley   PetscDSAddDiscretization - Adds a discretization object
825bc4ae4beSMatthew G. Knepley 
826bc4ae4beSMatthew G. Knepley   Not collective
827bc4ae4beSMatthew G. Knepley 
828bc4ae4beSMatthew G. Knepley   Input Parameters:
829bc4ae4beSMatthew G. Knepley + prob - The PetscDS object
830bc4ae4beSMatthew G. Knepley - disc - The boundary discretization object
831bc4ae4beSMatthew G. Knepley 
832bc4ae4beSMatthew G. Knepley   Level: beginner
833bc4ae4beSMatthew G. Knepley 
834bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetDiscretization(), PetscDSSetDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
835bc4ae4beSMatthew G. Knepley @*/
8362764a2aaSMatthew G. Knepley PetscErrorCode PetscDSAddDiscretization(PetscDS prob, PetscObject disc)
8372764a2aaSMatthew G. Knepley {
8382764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
8392764a2aaSMatthew G. Knepley 
8402764a2aaSMatthew G. Knepley   PetscFunctionBegin;
8412764a2aaSMatthew G. Knepley   ierr = PetscDSSetDiscretization(prob, prob->Nf, disc);CHKERRQ(ierr);
8422764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
8432764a2aaSMatthew G. Knepley }
8442764a2aaSMatthew G. Knepley 
845249df284SMatthew G. Knepley /*@
846249df284SMatthew G. Knepley   PetscDSGetImplicit - Returns the flag for implicit solve for this field. This is just a guide for IMEX
847249df284SMatthew G. Knepley 
848249df284SMatthew G. Knepley   Not collective
849249df284SMatthew G. Knepley 
850249df284SMatthew G. Knepley   Input Parameters:
851249df284SMatthew G. Knepley + prob - The PetscDS object
852249df284SMatthew G. Knepley - f - The field number
853249df284SMatthew G. Knepley 
854249df284SMatthew G. Knepley   Output Parameter:
855249df284SMatthew G. Knepley . implicit - The flag indicating what kind of solve to use for this field
856249df284SMatthew G. Knepley 
857249df284SMatthew G. Knepley   Level: developer
858249df284SMatthew G. Knepley 
859f744cafaSSander Arens .seealso: PetscDSSetImplicit(), PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
860249df284SMatthew G. Knepley @*/
861249df284SMatthew G. Knepley PetscErrorCode PetscDSGetImplicit(PetscDS prob, PetscInt f, PetscBool *implicit)
862249df284SMatthew G. Knepley {
863249df284SMatthew G. Knepley   PetscFunctionBegin;
864249df284SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
865249df284SMatthew G. Knepley   PetscValidPointer(implicit, 3);
866249df284SMatthew 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);
867249df284SMatthew G. Knepley   *implicit = prob->implicit[f];
868249df284SMatthew G. Knepley   PetscFunctionReturn(0);
869249df284SMatthew G. Knepley }
870249df284SMatthew G. Knepley 
871249df284SMatthew G. Knepley /*@
872249df284SMatthew G. Knepley   PetscDSSetImplicit - Set the flag for implicit solve for this field. This is just a guide for IMEX
873249df284SMatthew G. Knepley 
874249df284SMatthew G. Knepley   Not collective
875249df284SMatthew G. Knepley 
876249df284SMatthew G. Knepley   Input Parameters:
877249df284SMatthew G. Knepley + prob - The PetscDS object
878249df284SMatthew G. Knepley . f - The field number
879249df284SMatthew G. Knepley - implicit - The flag indicating what kind of solve to use for this field
880249df284SMatthew G. Knepley 
881249df284SMatthew G. Knepley   Level: developer
882249df284SMatthew G. Knepley 
883f744cafaSSander Arens .seealso: PetscDSGetImplicit(), PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
884249df284SMatthew G. Knepley @*/
885249df284SMatthew G. Knepley PetscErrorCode PetscDSSetImplicit(PetscDS prob, PetscInt f, PetscBool implicit)
886249df284SMatthew G. Knepley {
887249df284SMatthew G. Knepley   PetscFunctionBegin;
888249df284SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
889249df284SMatthew 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);
890249df284SMatthew G. Knepley   prob->implicit[f] = implicit;
891249df284SMatthew G. Knepley   PetscFunctionReturn(0);
892249df284SMatthew G. Knepley }
893249df284SMatthew G. Knepley 
894a6cbbb48SMatthew G. Knepley /*@
895a6cbbb48SMatthew G. Knepley   PetscDSGetAdjacency - Returns the flags for determining variable influence
896a6cbbb48SMatthew G. Knepley 
897a6cbbb48SMatthew G. Knepley   Not collective
898a6cbbb48SMatthew G. Knepley 
899a6cbbb48SMatthew G. Knepley   Input Parameters:
900a6cbbb48SMatthew G. Knepley + prob - The PetscDS object
901a6cbbb48SMatthew G. Knepley - f - The field number
902a6cbbb48SMatthew G. Knepley 
903a6cbbb48SMatthew G. Knepley   Output Parameter:
904a6cbbb48SMatthew G. Knepley + useCone    - Flag for variable influence starting with the cone operation
905a6cbbb48SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
906a6cbbb48SMatthew G. Knepley 
907a6cbbb48SMatthew G. Knepley   Note: See the discussion in DMPlexGetAdjacencyUseCone() and DMPlexGetAdjacencyUseClosure()
908a6cbbb48SMatthew G. Knepley 
909a6cbbb48SMatthew G. Knepley   Level: developer
910a6cbbb48SMatthew G. Knepley 
911f744cafaSSander Arens .seealso: PetscDSSetAdjacency(), DMPlexGetAdjacencyUseCone(), DMPlexGetAdjacencyUseClosure(), PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
912a6cbbb48SMatthew G. Knepley @*/
913a6cbbb48SMatthew G. Knepley PetscErrorCode PetscDSGetAdjacency(PetscDS prob, PetscInt f, PetscBool *useCone, PetscBool *useClosure)
914a6cbbb48SMatthew G. Knepley {
915a6cbbb48SMatthew G. Knepley   PetscFunctionBegin;
916a6cbbb48SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
9171cf84007SMatthew G. Knepley   if (useCone) PetscValidPointer(useCone, 3);
9181cf84007SMatthew G. Knepley   if (useClosure) PetscValidPointer(useClosure, 4);
91906cc46feSMatthew G. Knepley   if (f < 0) {
92006cc46feSMatthew G. Knepley     if (useCone)    *useCone    = prob->defaultAdj[0];
92106cc46feSMatthew G. Knepley     if (useClosure) *useClosure = prob->defaultAdj[1];
92206cc46feSMatthew G. Knepley   } else {
92306cc46feSMatthew G. Knepley     if (f >= prob->Nf) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, prob->Nf);
9241cf84007SMatthew G. Knepley     if (useCone)    *useCone    = prob->adjacency[f*2+0];
9251cf84007SMatthew G. Knepley     if (useClosure) *useClosure = prob->adjacency[f*2+1];
92606cc46feSMatthew G. Knepley   }
927a6cbbb48SMatthew G. Knepley   PetscFunctionReturn(0);
928a6cbbb48SMatthew G. Knepley }
929a6cbbb48SMatthew G. Knepley 
930a6cbbb48SMatthew G. Knepley /*@
931a6cbbb48SMatthew G. Knepley   PetscDSSetAdjacency - Set the flags for determining variable influence
932a6cbbb48SMatthew G. Knepley 
933a6cbbb48SMatthew G. Knepley   Not collective
934a6cbbb48SMatthew G. Knepley 
935a6cbbb48SMatthew G. Knepley   Input Parameters:
936a6cbbb48SMatthew G. Knepley + prob - The PetscDS object
937a6cbbb48SMatthew G. Knepley . f - The field number
938a6cbbb48SMatthew G. Knepley . useCone    - Flag for variable influence starting with the cone operation
939a6cbbb48SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
940a6cbbb48SMatthew G. Knepley 
941a6cbbb48SMatthew G. Knepley   Note: See the discussion in DMPlexGetAdjacencyUseCone() and DMPlexGetAdjacencyUseClosure()
942a6cbbb48SMatthew G. Knepley 
943a6cbbb48SMatthew G. Knepley   Level: developer
944a6cbbb48SMatthew G. Knepley 
945f744cafaSSander Arens .seealso: PetscDSGetAdjacency(), DMPlexGetAdjacencyUseCone(), DMPlexGetAdjacencyUseClosure(), PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
946a6cbbb48SMatthew G. Knepley @*/
947a6cbbb48SMatthew G. Knepley PetscErrorCode PetscDSSetAdjacency(PetscDS prob, PetscInt f, PetscBool useCone, PetscBool useClosure)
948a6cbbb48SMatthew G. Knepley {
949a6cbbb48SMatthew G. Knepley   PetscFunctionBegin;
950a6cbbb48SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
95106cc46feSMatthew G. Knepley   if (f < 0) {
95206cc46feSMatthew G. Knepley     prob->defaultAdj[0] = useCone;
95306cc46feSMatthew G. Knepley     prob->defaultAdj[1] = useClosure;
95406cc46feSMatthew G. Knepley   } else {
95506cc46feSMatthew G. Knepley     if (f >= prob->Nf) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, prob->Nf);
956a6cbbb48SMatthew G. Knepley     prob->adjacency[f*2+0] = useCone;
957a6cbbb48SMatthew G. Knepley     prob->adjacency[f*2+1] = useClosure;
95806cc46feSMatthew G. Knepley   }
959a6cbbb48SMatthew G. Knepley   PetscFunctionReturn(0);
960a6cbbb48SMatthew G. Knepley }
961a6cbbb48SMatthew G. Knepley 
9622764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetObjective(PetscDS prob, PetscInt f,
96330b9ff8bSMatthew G. Knepley                                    void (**obj)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
964194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
965194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
96697b6e6e8SMatthew G. Knepley                                                 PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar obj[]))
9672764a2aaSMatthew G. Knepley {
9682764a2aaSMatthew G. Knepley   PetscFunctionBegin;
9692764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
9702764a2aaSMatthew G. Knepley   PetscValidPointer(obj, 2);
9712764a2aaSMatthew 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);
9722764a2aaSMatthew G. Knepley   *obj = prob->obj[f];
9732764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
9742764a2aaSMatthew G. Knepley }
9752764a2aaSMatthew G. Knepley 
9762764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetObjective(PetscDS prob, PetscInt f,
97730b9ff8bSMatthew G. Knepley                                    void (*obj)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
978194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
979194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
98097b6e6e8SMatthew G. Knepley                                                PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar obj[]))
9812764a2aaSMatthew G. Knepley {
9822764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
9832764a2aaSMatthew G. Knepley 
9842764a2aaSMatthew G. Knepley   PetscFunctionBegin;
9852764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
986de716cbcSToby Isaac   if (obj) PetscValidFunction(obj, 2);
9872764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
9882764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
9892764a2aaSMatthew G. Knepley   prob->obj[f] = obj;
9902764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
9912764a2aaSMatthew G. Knepley }
9922764a2aaSMatthew G. Knepley 
993194d53e6SMatthew G. Knepley /*@C
994194d53e6SMatthew G. Knepley   PetscDSGetResidual - Get the pointwise residual function for a given test field
995194d53e6SMatthew G. Knepley 
996194d53e6SMatthew G. Knepley   Not collective
997194d53e6SMatthew G. Knepley 
998194d53e6SMatthew G. Knepley   Input Parameters:
999194d53e6SMatthew G. Knepley + prob - The PetscDS
1000194d53e6SMatthew G. Knepley - f    - The test field number
1001194d53e6SMatthew G. Knepley 
1002194d53e6SMatthew G. Knepley   Output Parameters:
1003194d53e6SMatthew G. Knepley + f0 - integrand for the test function term
1004194d53e6SMatthew G. Knepley - f1 - integrand for the test function gradient term
1005194d53e6SMatthew G. Knepley 
1006194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1007194d53e6SMatthew G. Knepley 
1008194d53e6SMatthew 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)
1009194d53e6SMatthew G. Knepley 
1010194d53e6SMatthew G. Knepley The calling sequence for the callbacks f0 and f1 is given by:
1011194d53e6SMatthew G. Knepley 
101230b9ff8bSMatthew G. Knepley $ f0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1013194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1014194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
101530b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], PetscScalar f0[])
1016194d53e6SMatthew G. Knepley 
1017194d53e6SMatthew G. Knepley + dim - the spatial dimension
1018194d53e6SMatthew G. Knepley . Nf - the number of fields
1019194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1020194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1021194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
1022194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1023194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1024194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1025194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1026194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1027194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1028194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1029194d53e6SMatthew G. Knepley . t - current time
1030194d53e6SMatthew G. Knepley . x - coordinates of the current point
103197b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
103297b6e6e8SMatthew G. Knepley . constants - constant parameters
1033194d53e6SMatthew G. Knepley - f0 - output values at the current point
1034194d53e6SMatthew G. Knepley 
1035194d53e6SMatthew G. Knepley   Level: intermediate
1036194d53e6SMatthew G. Knepley 
1037194d53e6SMatthew G. Knepley .seealso: PetscDSSetResidual()
1038194d53e6SMatthew G. Knepley @*/
10392764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetResidual(PetscDS prob, PetscInt f,
104030b9ff8bSMatthew G. Knepley                                   void (**f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1041194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1042194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
104397b6e6e8SMatthew G. Knepley                                               PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f0[]),
104430b9ff8bSMatthew G. Knepley                                   void (**f1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1045194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1046194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
104797b6e6e8SMatthew G. Knepley                                               PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f1[]))
10482764a2aaSMatthew G. Knepley {
10492764a2aaSMatthew G. Knepley   PetscFunctionBegin;
10502764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
10512764a2aaSMatthew 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);
10522764a2aaSMatthew G. Knepley   if (f0) {PetscValidPointer(f0, 3); *f0 = prob->f[f*2+0];}
10532764a2aaSMatthew G. Knepley   if (f1) {PetscValidPointer(f1, 4); *f1 = prob->f[f*2+1];}
10542764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
10552764a2aaSMatthew G. Knepley }
10562764a2aaSMatthew G. Knepley 
1057194d53e6SMatthew G. Knepley /*@C
1058194d53e6SMatthew G. Knepley   PetscDSSetResidual - Set the pointwise residual function for a given test field
1059194d53e6SMatthew G. Knepley 
1060194d53e6SMatthew G. Knepley   Not collective
1061194d53e6SMatthew G. Knepley 
1062194d53e6SMatthew G. Knepley   Input Parameters:
1063194d53e6SMatthew G. Knepley + prob - The PetscDS
1064194d53e6SMatthew G. Knepley . f    - The test field number
1065194d53e6SMatthew G. Knepley . f0 - integrand for the test function term
1066194d53e6SMatthew G. Knepley - f1 - integrand for the test function gradient term
1067194d53e6SMatthew G. Knepley 
1068194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1069194d53e6SMatthew G. Knepley 
1070194d53e6SMatthew 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)
1071194d53e6SMatthew G. Knepley 
1072194d53e6SMatthew G. Knepley The calling sequence for the callbacks f0 and f1 is given by:
1073194d53e6SMatthew G. Knepley 
107430b9ff8bSMatthew G. Knepley $ f0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1075194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1076194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
107730b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], PetscScalar f0[])
1078194d53e6SMatthew G. Knepley 
1079194d53e6SMatthew G. Knepley + dim - the spatial dimension
1080194d53e6SMatthew G. Knepley . Nf - the number of fields
1081194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1082194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1083194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
1084194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1085194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1086194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1087194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1088194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1089194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1090194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1091194d53e6SMatthew G. Knepley . t - current time
1092194d53e6SMatthew G. Knepley . x - coordinates of the current point
109397b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
109497b6e6e8SMatthew G. Knepley . constants - constant parameters
1095194d53e6SMatthew G. Knepley - f0 - output values at the current point
1096194d53e6SMatthew G. Knepley 
1097194d53e6SMatthew G. Knepley   Level: intermediate
1098194d53e6SMatthew G. Knepley 
1099194d53e6SMatthew G. Knepley .seealso: PetscDSGetResidual()
1100194d53e6SMatthew G. Knepley @*/
11012764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetResidual(PetscDS prob, PetscInt f,
110230b9ff8bSMatthew G. Knepley                                   void (*f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1103194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1104194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
110597b6e6e8SMatthew G. Knepley                                              PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f0[]),
110630b9ff8bSMatthew G. Knepley                                   void (*f1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1107194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1108194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
110997b6e6e8SMatthew G. Knepley                                              PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f1[]))
11102764a2aaSMatthew G. Knepley {
11112764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
11122764a2aaSMatthew G. Knepley 
11132764a2aaSMatthew G. Knepley   PetscFunctionBegin;
11142764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1115f866a1d0SMatthew G. Knepley   if (f0) PetscValidFunction(f0, 3);
1116f866a1d0SMatthew G. Knepley   if (f1) PetscValidFunction(f1, 4);
11172764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
11182764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
11192764a2aaSMatthew G. Knepley   prob->f[f*2+0] = f0;
11202764a2aaSMatthew G. Knepley   prob->f[f*2+1] = f1;
11212764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
11222764a2aaSMatthew G. Knepley }
11232764a2aaSMatthew G. Knepley 
11243e75805dSMatthew G. Knepley /*@C
11253e75805dSMatthew G. Knepley   PetscDSHasJacobian - Signals that Jacobian functions have been set
11263e75805dSMatthew G. Knepley 
11273e75805dSMatthew G. Knepley   Not collective
11283e75805dSMatthew G. Knepley 
11293e75805dSMatthew G. Knepley   Input Parameter:
11303e75805dSMatthew G. Knepley . prob - The PetscDS
11313e75805dSMatthew G. Knepley 
11323e75805dSMatthew G. Knepley   Output Parameter:
11333e75805dSMatthew G. Knepley . hasJac - flag that pointwise function for the Jacobian has been set
11343e75805dSMatthew G. Knepley 
11353e75805dSMatthew G. Knepley   Level: intermediate
11363e75805dSMatthew G. Knepley 
11373e75805dSMatthew G. Knepley .seealso: PetscDSGetJacobianPreconditioner(), PetscDSSetJacobianPreconditioner(), PetscDSGetJacobian()
11383e75805dSMatthew G. Knepley @*/
11393e75805dSMatthew G. Knepley PetscErrorCode PetscDSHasJacobian(PetscDS prob, PetscBool *hasJac)
11403e75805dSMatthew G. Knepley {
11413e75805dSMatthew G. Knepley   PetscInt f, g, h;
11423e75805dSMatthew G. Knepley 
11433e75805dSMatthew G. Knepley   PetscFunctionBegin;
11443e75805dSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
11453e75805dSMatthew G. Knepley   *hasJac = PETSC_FALSE;
11463e75805dSMatthew G. Knepley   for (f = 0; f < prob->Nf; ++f) {
11473e75805dSMatthew G. Knepley     for (g = 0; g < prob->Nf; ++g) {
11483e75805dSMatthew G. Knepley       for (h = 0; h < 4; ++h) {
11493e75805dSMatthew G. Knepley         if (prob->g[(f*prob->Nf + g)*4+h]) *hasJac = PETSC_TRUE;
11503e75805dSMatthew G. Knepley       }
11513e75805dSMatthew G. Knepley     }
11523e75805dSMatthew G. Knepley   }
11533e75805dSMatthew G. Knepley   PetscFunctionReturn(0);
11543e75805dSMatthew G. Knepley }
11553e75805dSMatthew G. Knepley 
1156194d53e6SMatthew G. Knepley /*@C
1157194d53e6SMatthew G. Knepley   PetscDSGetJacobian - Get the pointwise Jacobian function for given test and basis field
1158194d53e6SMatthew G. Knepley 
1159194d53e6SMatthew G. Knepley   Not collective
1160194d53e6SMatthew G. Knepley 
1161194d53e6SMatthew G. Knepley   Input Parameters:
1162194d53e6SMatthew G. Knepley + prob - The PetscDS
1163194d53e6SMatthew G. Knepley . f    - The test field number
1164194d53e6SMatthew G. Knepley - g    - The field number
1165194d53e6SMatthew G. Knepley 
1166194d53e6SMatthew G. Knepley   Output Parameters:
1167194d53e6SMatthew G. Knepley + g0 - integrand for the test and basis function term
1168194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1169194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1170194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1171194d53e6SMatthew G. Knepley 
1172194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1173194d53e6SMatthew G. Knepley 
1174194d53e6SMatthew 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
1175194d53e6SMatthew G. Knepley 
1176194d53e6SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1177194d53e6SMatthew G. Knepley 
117830b9ff8bSMatthew G. Knepley $ g0(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[],
118130b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal u_tShift, const PetscReal x[], PetscScalar g0[])
1182194d53e6SMatthew G. Knepley 
1183194d53e6SMatthew G. Knepley + dim - the spatial dimension
1184194d53e6SMatthew G. Knepley . Nf - the number of fields
1185194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1186194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1187194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
1188194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1189194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1190194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1191194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1192194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1193194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1194194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1195194d53e6SMatthew G. Knepley . t - current time
11962aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1197194d53e6SMatthew G. Knepley . x - coordinates of the current point
119897b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
119997b6e6e8SMatthew G. Knepley . constants - constant parameters
1200194d53e6SMatthew G. Knepley - g0 - output values at the current point
1201194d53e6SMatthew G. Knepley 
1202194d53e6SMatthew G. Knepley   Level: intermediate
1203194d53e6SMatthew G. Knepley 
1204194d53e6SMatthew G. Knepley .seealso: PetscDSSetJacobian()
1205194d53e6SMatthew G. Knepley @*/
12062764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetJacobian(PetscDS prob, PetscInt f, PetscInt g,
120730b9ff8bSMatthew G. Knepley                                   void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1208194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1209194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
121097b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
121130b9ff8bSMatthew G. Knepley                                   void (**g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1212194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1213194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
121497b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
121530b9ff8bSMatthew G. Knepley                                   void (**g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1216194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1217194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
121897b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
121930b9ff8bSMatthew G. Knepley                                   void (**g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1220194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1221194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
122297b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
12232764a2aaSMatthew G. Knepley {
12242764a2aaSMatthew G. Knepley   PetscFunctionBegin;
12252764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
12262764a2aaSMatthew 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);
12272764a2aaSMatthew 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);
12282764a2aaSMatthew G. Knepley   if (g0) {PetscValidPointer(g0, 4); *g0 = prob->g[(f*prob->Nf + g)*4+0];}
12292764a2aaSMatthew G. Knepley   if (g1) {PetscValidPointer(g1, 5); *g1 = prob->g[(f*prob->Nf + g)*4+1];}
12302764a2aaSMatthew G. Knepley   if (g2) {PetscValidPointer(g2, 6); *g2 = prob->g[(f*prob->Nf + g)*4+2];}
12312764a2aaSMatthew G. Knepley   if (g3) {PetscValidPointer(g3, 7); *g3 = prob->g[(f*prob->Nf + g)*4+3];}
12322764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
12332764a2aaSMatthew G. Knepley }
12342764a2aaSMatthew G. Knepley 
1235194d53e6SMatthew G. Knepley /*@C
1236194d53e6SMatthew G. Knepley   PetscDSSetJacobian - Set the pointwise Jacobian function for given test and basis fields
1237194d53e6SMatthew G. Knepley 
1238194d53e6SMatthew G. Knepley   Not collective
1239194d53e6SMatthew G. Knepley 
1240194d53e6SMatthew G. Knepley   Input Parameters:
1241194d53e6SMatthew G. Knepley + prob - The PetscDS
1242194d53e6SMatthew G. Knepley . f    - The test field number
1243194d53e6SMatthew G. Knepley . g    - The field number
1244194d53e6SMatthew G. Knepley . g0 - integrand for the test and basis function term
1245194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1246194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1247194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1248194d53e6SMatthew G. Knepley 
1249194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1250194d53e6SMatthew G. Knepley 
1251194d53e6SMatthew 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
1252194d53e6SMatthew G. Knepley 
1253194d53e6SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1254194d53e6SMatthew G. Knepley 
125530b9ff8bSMatthew G. Knepley $ g0(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[],
125830b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], PetscScalar g0[])
1259194d53e6SMatthew G. Knepley 
1260194d53e6SMatthew G. Knepley + dim - the spatial dimension
1261194d53e6SMatthew G. Knepley . Nf - the number of fields
1262194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1263194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1264194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
1265194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1266194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1267194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1268194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1269194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1270194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1271194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1272194d53e6SMatthew G. Knepley . t - current time
12732aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1274194d53e6SMatthew G. Knepley . x - coordinates of the current point
127597b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
127697b6e6e8SMatthew G. Knepley . constants - constant parameters
1277194d53e6SMatthew G. Knepley - g0 - output values at the current point
1278194d53e6SMatthew G. Knepley 
1279194d53e6SMatthew G. Knepley   Level: intermediate
1280194d53e6SMatthew G. Knepley 
1281194d53e6SMatthew G. Knepley .seealso: PetscDSGetJacobian()
1282194d53e6SMatthew G. Knepley @*/
12832764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetJacobian(PetscDS prob, PetscInt f, PetscInt g,
128430b9ff8bSMatthew G. Knepley                                   void (*g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1285194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1286194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
128797b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
128830b9ff8bSMatthew G. Knepley                                   void (*g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1289194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1290194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
129197b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
129230b9ff8bSMatthew G. Knepley                                   void (*g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1293194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1294194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
129597b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
129630b9ff8bSMatthew G. Knepley                                   void (*g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1297194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1298194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
129997b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
13002764a2aaSMatthew G. Knepley {
13012764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
13022764a2aaSMatthew G. Knepley 
13032764a2aaSMatthew G. Knepley   PetscFunctionBegin;
13042764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
13052764a2aaSMatthew G. Knepley   if (g0) PetscValidFunction(g0, 4);
13062764a2aaSMatthew G. Knepley   if (g1) PetscValidFunction(g1, 5);
13072764a2aaSMatthew G. Knepley   if (g2) PetscValidFunction(g2, 6);
13082764a2aaSMatthew G. Knepley   if (g3) PetscValidFunction(g3, 7);
13092764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
13102764a2aaSMatthew G. Knepley   if (g < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", g);
13112764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, PetscMax(f, g)+1);CHKERRQ(ierr);
13122764a2aaSMatthew G. Knepley   prob->g[(f*prob->Nf + g)*4+0] = g0;
13132764a2aaSMatthew G. Knepley   prob->g[(f*prob->Nf + g)*4+1] = g1;
13142764a2aaSMatthew G. Knepley   prob->g[(f*prob->Nf + g)*4+2] = g2;
13152764a2aaSMatthew G. Knepley   prob->g[(f*prob->Nf + g)*4+3] = g3;
13162764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
13172764a2aaSMatthew G. Knepley }
13182764a2aaSMatthew G. Knepley 
1319475e0ac9SMatthew G. Knepley /*@C
132055c1f793SMatthew G. Knepley   PetscDSUseJacobianPreconditioner - Whether to construct a Jacobian preconditioner
132155c1f793SMatthew G. Knepley 
132255c1f793SMatthew G. Knepley   Not collective
132355c1f793SMatthew G. Knepley 
132455c1f793SMatthew G. Knepley   Input Parameters:
132555c1f793SMatthew G. Knepley + prob - The PetscDS
132655c1f793SMatthew G. Knepley - useJacPre - flag that enables construction of a Jacobian preconditioner
132755c1f793SMatthew G. Knepley 
132855c1f793SMatthew G. Knepley   Level: intermediate
132955c1f793SMatthew G. Knepley 
133055c1f793SMatthew G. Knepley .seealso: PetscDSGetJacobianPreconditioner(), PetscDSSetJacobianPreconditioner(), PetscDSGetJacobian()
133155c1f793SMatthew G. Knepley @*/
133255c1f793SMatthew G. Knepley PetscErrorCode PetscDSUseJacobianPreconditioner(PetscDS prob, PetscBool useJacPre)
133355c1f793SMatthew G. Knepley {
133455c1f793SMatthew G. Knepley   PetscFunctionBegin;
133555c1f793SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
133655c1f793SMatthew G. Knepley   prob->useJacPre = useJacPre;
133755c1f793SMatthew G. Knepley   PetscFunctionReturn(0);
133855c1f793SMatthew G. Knepley }
133955c1f793SMatthew G. Knepley 
134055c1f793SMatthew G. Knepley /*@C
1341475e0ac9SMatthew G. Knepley   PetscDSHasJacobianPreconditioner - Signals that a Jacobian preconditioner matrix has been set
1342475e0ac9SMatthew G. Knepley 
1343475e0ac9SMatthew G. Knepley   Not collective
1344475e0ac9SMatthew G. Knepley 
1345475e0ac9SMatthew G. Knepley   Input Parameter:
1346475e0ac9SMatthew G. Knepley . prob - The PetscDS
1347475e0ac9SMatthew G. Knepley 
1348475e0ac9SMatthew G. Knepley   Output Parameter:
1349475e0ac9SMatthew G. Knepley . hasJacPre - flag that pointwise function for Jacobian preconditioner matrix has been set
1350475e0ac9SMatthew G. Knepley 
1351475e0ac9SMatthew G. Knepley   Level: intermediate
1352475e0ac9SMatthew G. Knepley 
1353475e0ac9SMatthew G. Knepley .seealso: PetscDSGetJacobianPreconditioner(), PetscDSSetJacobianPreconditioner(), PetscDSGetJacobian()
1354475e0ac9SMatthew G. Knepley @*/
1355475e0ac9SMatthew G. Knepley PetscErrorCode PetscDSHasJacobianPreconditioner(PetscDS prob, PetscBool *hasJacPre)
1356475e0ac9SMatthew G. Knepley {
1357475e0ac9SMatthew G. Knepley   PetscInt f, g, h;
1358475e0ac9SMatthew G. Knepley 
1359475e0ac9SMatthew G. Knepley   PetscFunctionBegin;
1360475e0ac9SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1361475e0ac9SMatthew G. Knepley   *hasJacPre = PETSC_FALSE;
136255c1f793SMatthew G. Knepley   if (!prob->useJacPre) PetscFunctionReturn(0);
1363475e0ac9SMatthew G. Knepley   for (f = 0; f < prob->Nf; ++f) {
1364475e0ac9SMatthew G. Knepley     for (g = 0; g < prob->Nf; ++g) {
1365475e0ac9SMatthew G. Knepley       for (h = 0; h < 4; ++h) {
1366475e0ac9SMatthew G. Knepley         if (prob->gp[(f*prob->Nf + g)*4+h]) *hasJacPre = PETSC_TRUE;
1367475e0ac9SMatthew G. Knepley       }
1368475e0ac9SMatthew G. Knepley     }
1369475e0ac9SMatthew G. Knepley   }
1370475e0ac9SMatthew G. Knepley   PetscFunctionReturn(0);
1371475e0ac9SMatthew G. Knepley }
1372475e0ac9SMatthew G. Knepley 
1373475e0ac9SMatthew G. Knepley /*@C
1374475e0ac9SMatthew 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.
1375475e0ac9SMatthew G. Knepley 
1376475e0ac9SMatthew G. Knepley   Not collective
1377475e0ac9SMatthew G. Knepley 
1378475e0ac9SMatthew G. Knepley   Input Parameters:
1379475e0ac9SMatthew G. Knepley + prob - The PetscDS
1380475e0ac9SMatthew G. Knepley . f    - The test field number
1381475e0ac9SMatthew G. Knepley - g    - The field number
1382475e0ac9SMatthew G. Knepley 
1383475e0ac9SMatthew G. Knepley   Output Parameters:
1384475e0ac9SMatthew G. Knepley + g0 - integrand for the test and basis function term
1385475e0ac9SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1386475e0ac9SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1387475e0ac9SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1388475e0ac9SMatthew G. Knepley 
1389475e0ac9SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1390475e0ac9SMatthew G. Knepley 
1391475e0ac9SMatthew 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
1392475e0ac9SMatthew G. Knepley 
1393475e0ac9SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1394475e0ac9SMatthew G. Knepley 
1395475e0ac9SMatthew G. Knepley $ g0(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[],
1398475e0ac9SMatthew G. Knepley $    PetscReal t, const PetscReal u_tShift, const PetscReal x[], PetscScalar g0[])
1399475e0ac9SMatthew G. Knepley 
1400475e0ac9SMatthew G. Knepley + dim - the spatial dimension
1401475e0ac9SMatthew G. Knepley . Nf - the number of fields
1402475e0ac9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1403475e0ac9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1404475e0ac9SMatthew G. Knepley . u - each field evaluated at the current point
1405475e0ac9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1406475e0ac9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1407475e0ac9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1408475e0ac9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1409475e0ac9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1410475e0ac9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1411475e0ac9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1412475e0ac9SMatthew G. Knepley . t - current time
1413475e0ac9SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1414475e0ac9SMatthew G. Knepley . x - coordinates of the current point
141597b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
141697b6e6e8SMatthew G. Knepley . constants - constant parameters
1417475e0ac9SMatthew G. Knepley - g0 - output values at the current point
1418475e0ac9SMatthew G. Knepley 
1419475e0ac9SMatthew G. Knepley   Level: intermediate
1420475e0ac9SMatthew G. Knepley 
1421475e0ac9SMatthew G. Knepley .seealso: PetscDSSetJacobianPreconditioner(), PetscDSGetJacobian()
1422475e0ac9SMatthew G. Knepley @*/
1423475e0ac9SMatthew G. Knepley PetscErrorCode PetscDSGetJacobianPreconditioner(PetscDS prob, PetscInt f, PetscInt g,
1424475e0ac9SMatthew G. Knepley                                   void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1425475e0ac9SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1426475e0ac9SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
142797b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
1428475e0ac9SMatthew G. Knepley                                   void (**g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1429475e0ac9SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1430475e0ac9SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
143197b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
1432475e0ac9SMatthew G. Knepley                                   void (**g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1433475e0ac9SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1434475e0ac9SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
143597b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
1436475e0ac9SMatthew G. Knepley                                   void (**g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1437475e0ac9SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1438475e0ac9SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
143997b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
1440475e0ac9SMatthew G. Knepley {
1441475e0ac9SMatthew G. Knepley   PetscFunctionBegin;
1442475e0ac9SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1443475e0ac9SMatthew 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);
1444475e0ac9SMatthew 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);
1445475e0ac9SMatthew G. Knepley   if (g0) {PetscValidPointer(g0, 4); *g0 = prob->gp[(f*prob->Nf + g)*4+0];}
1446475e0ac9SMatthew G. Knepley   if (g1) {PetscValidPointer(g1, 5); *g1 = prob->gp[(f*prob->Nf + g)*4+1];}
1447475e0ac9SMatthew G. Knepley   if (g2) {PetscValidPointer(g2, 6); *g2 = prob->gp[(f*prob->Nf + g)*4+2];}
1448475e0ac9SMatthew G. Knepley   if (g3) {PetscValidPointer(g3, 7); *g3 = prob->gp[(f*prob->Nf + g)*4+3];}
1449475e0ac9SMatthew G. Knepley   PetscFunctionReturn(0);
1450475e0ac9SMatthew G. Knepley }
1451475e0ac9SMatthew G. Knepley 
1452475e0ac9SMatthew G. Knepley /*@C
1453475e0ac9SMatthew 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.
1454475e0ac9SMatthew G. Knepley 
1455475e0ac9SMatthew G. Knepley   Not collective
1456475e0ac9SMatthew G. Knepley 
1457475e0ac9SMatthew G. Knepley   Input Parameters:
1458475e0ac9SMatthew G. Knepley + prob - The PetscDS
1459475e0ac9SMatthew G. Knepley . f    - The test field number
1460475e0ac9SMatthew G. Knepley . g    - The field number
1461475e0ac9SMatthew G. Knepley . g0 - integrand for the test and basis function term
1462475e0ac9SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1463475e0ac9SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1464475e0ac9SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1465475e0ac9SMatthew G. Knepley 
1466475e0ac9SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1467475e0ac9SMatthew G. Knepley 
1468475e0ac9SMatthew 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
1469475e0ac9SMatthew G. Knepley 
1470475e0ac9SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1471475e0ac9SMatthew G. Knepley 
1472475e0ac9SMatthew G. Knepley $ g0(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[],
1475475e0ac9SMatthew G. Knepley $    PetscReal t, const PetscReal x[], PetscScalar g0[])
1476475e0ac9SMatthew G. Knepley 
1477475e0ac9SMatthew G. Knepley + dim - the spatial dimension
1478475e0ac9SMatthew G. Knepley . Nf - the number of fields
1479475e0ac9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1480475e0ac9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1481475e0ac9SMatthew G. Knepley . u - each field evaluated at the current point
1482475e0ac9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1483475e0ac9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1484475e0ac9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1485475e0ac9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1486475e0ac9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1487475e0ac9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1488475e0ac9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1489475e0ac9SMatthew G. Knepley . t - current time
1490475e0ac9SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1491475e0ac9SMatthew G. Knepley . x - coordinates of the current point
149297b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
149397b6e6e8SMatthew G. Knepley . constants - constant parameters
1494475e0ac9SMatthew G. Knepley - g0 - output values at the current point
1495475e0ac9SMatthew G. Knepley 
1496475e0ac9SMatthew G. Knepley   Level: intermediate
1497475e0ac9SMatthew G. Knepley 
1498475e0ac9SMatthew G. Knepley .seealso: PetscDSGetJacobianPreconditioner(), PetscDSSetJacobian()
1499475e0ac9SMatthew G. Knepley @*/
1500475e0ac9SMatthew G. Knepley PetscErrorCode PetscDSSetJacobianPreconditioner(PetscDS prob, PetscInt f, PetscInt g,
1501475e0ac9SMatthew G. Knepley                                   void (*g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1502475e0ac9SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1503475e0ac9SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
150497b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
1505475e0ac9SMatthew G. Knepley                                   void (*g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1506475e0ac9SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1507475e0ac9SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
150897b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
1509475e0ac9SMatthew G. Knepley                                   void (*g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1510475e0ac9SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1511475e0ac9SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
151297b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
1513475e0ac9SMatthew G. Knepley                                   void (*g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1514475e0ac9SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1515475e0ac9SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
151697b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
1517475e0ac9SMatthew G. Knepley {
1518475e0ac9SMatthew G. Knepley   PetscErrorCode ierr;
1519475e0ac9SMatthew G. Knepley 
1520475e0ac9SMatthew G. Knepley   PetscFunctionBegin;
1521475e0ac9SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1522475e0ac9SMatthew G. Knepley   if (g0) PetscValidFunction(g0, 4);
1523475e0ac9SMatthew G. Knepley   if (g1) PetscValidFunction(g1, 5);
1524475e0ac9SMatthew G. Knepley   if (g2) PetscValidFunction(g2, 6);
1525475e0ac9SMatthew G. Knepley   if (g3) PetscValidFunction(g3, 7);
1526475e0ac9SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
1527475e0ac9SMatthew G. Knepley   if (g < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", g);
1528475e0ac9SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, PetscMax(f, g)+1);CHKERRQ(ierr);
1529475e0ac9SMatthew G. Knepley   prob->gp[(f*prob->Nf + g)*4+0] = g0;
1530475e0ac9SMatthew G. Knepley   prob->gp[(f*prob->Nf + g)*4+1] = g1;
1531475e0ac9SMatthew G. Knepley   prob->gp[(f*prob->Nf + g)*4+2] = g2;
1532475e0ac9SMatthew G. Knepley   prob->gp[(f*prob->Nf + g)*4+3] = g3;
1533475e0ac9SMatthew G. Knepley   PetscFunctionReturn(0);
1534475e0ac9SMatthew G. Knepley }
1535475e0ac9SMatthew G. Knepley 
1536b7e05686SMatthew G. Knepley /*@C
1537b7e05686SMatthew G. Knepley   PetscDSHasDynamicJacobian - Signals that a dynamic Jacobian, dF/du_t, has been set
1538b7e05686SMatthew G. Knepley 
1539b7e05686SMatthew G. Knepley   Not collective
1540b7e05686SMatthew G. Knepley 
1541b7e05686SMatthew G. Knepley   Input Parameter:
1542b7e05686SMatthew G. Knepley . prob - The PetscDS
1543b7e05686SMatthew G. Knepley 
1544b7e05686SMatthew G. Knepley   Output Parameter:
1545b7e05686SMatthew G. Knepley . hasDynJac - flag that pointwise function for dynamic Jacobian has been set
1546b7e05686SMatthew G. Knepley 
1547b7e05686SMatthew G. Knepley   Level: intermediate
1548b7e05686SMatthew G. Knepley 
1549b7e05686SMatthew G. Knepley .seealso: PetscDSGetDynamicJacobian(), PetscDSSetDynamicJacobian(), PetscDSGetJacobian()
1550b7e05686SMatthew G. Knepley @*/
1551b7e05686SMatthew G. Knepley PetscErrorCode PetscDSHasDynamicJacobian(PetscDS prob, PetscBool *hasDynJac)
1552b7e05686SMatthew G. Knepley {
1553b7e05686SMatthew G. Knepley   PetscInt f, g, h;
1554b7e05686SMatthew G. Knepley 
1555b7e05686SMatthew G. Knepley   PetscFunctionBegin;
1556b7e05686SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1557b7e05686SMatthew G. Knepley   *hasDynJac = PETSC_FALSE;
1558b7e05686SMatthew G. Knepley   for (f = 0; f < prob->Nf; ++f) {
1559b7e05686SMatthew G. Knepley     for (g = 0; g < prob->Nf; ++g) {
1560b7e05686SMatthew G. Knepley       for (h = 0; h < 4; ++h) {
1561b7e05686SMatthew G. Knepley         if (prob->gt[(f*prob->Nf + g)*4+h]) *hasDynJac = PETSC_TRUE;
1562b7e05686SMatthew G. Knepley       }
1563b7e05686SMatthew G. Knepley     }
1564b7e05686SMatthew G. Knepley   }
1565b7e05686SMatthew G. Knepley   PetscFunctionReturn(0);
1566b7e05686SMatthew G. Knepley }
1567b7e05686SMatthew G. Knepley 
1568b7e05686SMatthew G. Knepley /*@C
1569b7e05686SMatthew G. Knepley   PetscDSGetDynamicJacobian - Get the pointwise dynamic Jacobian, dF/du_t, function for given test and basis field
1570b7e05686SMatthew G. Knepley 
1571b7e05686SMatthew G. Knepley   Not collective
1572b7e05686SMatthew G. Knepley 
1573b7e05686SMatthew G. Knepley   Input Parameters:
1574b7e05686SMatthew G. Knepley + prob - The PetscDS
1575b7e05686SMatthew G. Knepley . f    - The test field number
1576b7e05686SMatthew G. Knepley - g    - The field number
1577b7e05686SMatthew G. Knepley 
1578b7e05686SMatthew G. Knepley   Output Parameters:
1579b7e05686SMatthew G. Knepley + g0 - integrand for the test and basis function term
1580b7e05686SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1581b7e05686SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1582b7e05686SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1583b7e05686SMatthew G. Knepley 
1584b7e05686SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1585b7e05686SMatthew G. Knepley 
1586b7e05686SMatthew 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
1587b7e05686SMatthew G. Knepley 
1588b7e05686SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1589b7e05686SMatthew G. Knepley 
1590b7e05686SMatthew G. Knepley $ g0(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[],
1593b7e05686SMatthew G. Knepley $    PetscReal t, const PetscReal u_tShift, const PetscReal x[], PetscScalar g0[])
1594b7e05686SMatthew G. Knepley 
1595b7e05686SMatthew G. Knepley + dim - the spatial dimension
1596b7e05686SMatthew G. Knepley . Nf - the number of fields
1597b7e05686SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1598b7e05686SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1599b7e05686SMatthew G. Knepley . u - each field evaluated at the current point
1600b7e05686SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1601b7e05686SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1602b7e05686SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1603b7e05686SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1604b7e05686SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1605b7e05686SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1606b7e05686SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1607b7e05686SMatthew G. Knepley . t - current time
1608b7e05686SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1609b7e05686SMatthew G. Knepley . x - coordinates of the current point
161097b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
161197b6e6e8SMatthew G. Knepley . constants - constant parameters
1612b7e05686SMatthew G. Knepley - g0 - output values at the current point
1613b7e05686SMatthew G. Knepley 
1614b7e05686SMatthew G. Knepley   Level: intermediate
1615b7e05686SMatthew G. Knepley 
1616b7e05686SMatthew G. Knepley .seealso: PetscDSSetJacobian()
1617b7e05686SMatthew G. Knepley @*/
1618b7e05686SMatthew G. Knepley PetscErrorCode PetscDSGetDynamicJacobian(PetscDS prob, PetscInt f, PetscInt g,
1619b7e05686SMatthew G. Knepley                                          void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1620b7e05686SMatthew G. Knepley                                                      const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1621b7e05686SMatthew G. Knepley                                                      const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
162297b6e6e8SMatthew G. Knepley                                                      PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
1623b7e05686SMatthew G. Knepley                                          void (**g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1624b7e05686SMatthew G. Knepley                                                      const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1625b7e05686SMatthew G. Knepley                                                      const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
162697b6e6e8SMatthew G. Knepley                                                      PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
1627b7e05686SMatthew G. Knepley                                          void (**g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1628b7e05686SMatthew G. Knepley                                                      const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1629b7e05686SMatthew G. Knepley                                                      const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
163097b6e6e8SMatthew G. Knepley                                                      PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
1631b7e05686SMatthew G. Knepley                                          void (**g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1632b7e05686SMatthew G. Knepley                                                      const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1633b7e05686SMatthew G. Knepley                                                      const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
163497b6e6e8SMatthew G. Knepley                                                      PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
1635b7e05686SMatthew G. Knepley {
1636b7e05686SMatthew G. Knepley   PetscFunctionBegin;
1637b7e05686SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1638b7e05686SMatthew 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);
1639b7e05686SMatthew 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);
1640b7e05686SMatthew G. Knepley   if (g0) {PetscValidPointer(g0, 4); *g0 = prob->gt[(f*prob->Nf + g)*4+0];}
1641b7e05686SMatthew G. Knepley   if (g1) {PetscValidPointer(g1, 5); *g1 = prob->gt[(f*prob->Nf + g)*4+1];}
1642b7e05686SMatthew G. Knepley   if (g2) {PetscValidPointer(g2, 6); *g2 = prob->gt[(f*prob->Nf + g)*4+2];}
1643b7e05686SMatthew G. Knepley   if (g3) {PetscValidPointer(g3, 7); *g3 = prob->gt[(f*prob->Nf + g)*4+3];}
1644b7e05686SMatthew G. Knepley   PetscFunctionReturn(0);
1645b7e05686SMatthew G. Knepley }
1646b7e05686SMatthew G. Knepley 
1647b7e05686SMatthew G. Knepley /*@C
1648b7e05686SMatthew G. Knepley   PetscDSSetDynamicJacobian - Set the pointwise dynamic Jacobian, dF/du_t, function for given test and basis fields
1649b7e05686SMatthew G. Knepley 
1650b7e05686SMatthew G. Knepley   Not collective
1651b7e05686SMatthew G. Knepley 
1652b7e05686SMatthew G. Knepley   Input Parameters:
1653b7e05686SMatthew G. Knepley + prob - The PetscDS
1654b7e05686SMatthew G. Knepley . f    - The test field number
1655b7e05686SMatthew G. Knepley . g    - The field number
1656b7e05686SMatthew G. Knepley . g0 - integrand for the test and basis function term
1657b7e05686SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1658b7e05686SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1659b7e05686SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1660b7e05686SMatthew G. Knepley 
1661b7e05686SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1662b7e05686SMatthew G. Knepley 
1663b7e05686SMatthew 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
1664b7e05686SMatthew G. Knepley 
1665b7e05686SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1666b7e05686SMatthew G. Knepley 
1667b7e05686SMatthew G. Knepley $ g0(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[],
1670b7e05686SMatthew G. Knepley $    PetscReal t, const PetscReal x[], PetscScalar g0[])
1671b7e05686SMatthew G. Knepley 
1672b7e05686SMatthew G. Knepley + dim - the spatial dimension
1673b7e05686SMatthew G. Knepley . Nf - the number of fields
1674b7e05686SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1675b7e05686SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1676b7e05686SMatthew G. Knepley . u - each field evaluated at the current point
1677b7e05686SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1678b7e05686SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1679b7e05686SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1680b7e05686SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1681b7e05686SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1682b7e05686SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1683b7e05686SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1684b7e05686SMatthew G. Knepley . t - current time
1685b7e05686SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1686b7e05686SMatthew G. Knepley . x - coordinates of the current point
168797b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
168897b6e6e8SMatthew G. Knepley . constants - constant parameters
1689b7e05686SMatthew G. Knepley - g0 - output values at the current point
1690b7e05686SMatthew G. Knepley 
1691b7e05686SMatthew G. Knepley   Level: intermediate
1692b7e05686SMatthew G. Knepley 
1693b7e05686SMatthew G. Knepley .seealso: PetscDSGetJacobian()
1694b7e05686SMatthew G. Knepley @*/
1695b7e05686SMatthew G. Knepley PetscErrorCode PetscDSSetDynamicJacobian(PetscDS prob, PetscInt f, PetscInt g,
1696b7e05686SMatthew G. Knepley                                          void (*g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1697b7e05686SMatthew G. Knepley                                                     const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1698b7e05686SMatthew G. Knepley                                                     const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
169997b6e6e8SMatthew G. Knepley                                                     PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
1700b7e05686SMatthew G. Knepley                                          void (*g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1701b7e05686SMatthew G. Knepley                                                     const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1702b7e05686SMatthew G. Knepley                                                     const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
170397b6e6e8SMatthew G. Knepley                                                     PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
1704b7e05686SMatthew G. Knepley                                          void (*g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1705b7e05686SMatthew G. Knepley                                                     const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1706b7e05686SMatthew G. Knepley                                                     const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
170797b6e6e8SMatthew G. Knepley                                                     PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
1708b7e05686SMatthew G. Knepley                                          void (*g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1709b7e05686SMatthew G. Knepley                                                     const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1710b7e05686SMatthew G. Knepley                                                     const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
171197b6e6e8SMatthew G. Knepley                                                     PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
1712b7e05686SMatthew G. Knepley {
1713b7e05686SMatthew G. Knepley   PetscErrorCode ierr;
1714b7e05686SMatthew G. Knepley 
1715b7e05686SMatthew G. Knepley   PetscFunctionBegin;
1716b7e05686SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1717b7e05686SMatthew G. Knepley   if (g0) PetscValidFunction(g0, 4);
1718b7e05686SMatthew G. Knepley   if (g1) PetscValidFunction(g1, 5);
1719b7e05686SMatthew G. Knepley   if (g2) PetscValidFunction(g2, 6);
1720b7e05686SMatthew G. Knepley   if (g3) PetscValidFunction(g3, 7);
1721b7e05686SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
1722b7e05686SMatthew G. Knepley   if (g < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", g);
1723b7e05686SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, PetscMax(f, g)+1);CHKERRQ(ierr);
1724b7e05686SMatthew G. Knepley   prob->gt[(f*prob->Nf + g)*4+0] = g0;
1725b7e05686SMatthew G. Knepley   prob->gt[(f*prob->Nf + g)*4+1] = g1;
1726b7e05686SMatthew G. Knepley   prob->gt[(f*prob->Nf + g)*4+2] = g2;
1727b7e05686SMatthew G. Knepley   prob->gt[(f*prob->Nf + g)*4+3] = g3;
1728b7e05686SMatthew G. Knepley   PetscFunctionReturn(0);
1729b7e05686SMatthew G. Knepley }
1730b7e05686SMatthew G. Knepley 
17310c2f2876SMatthew G. Knepley /*@C
17320c2f2876SMatthew G. Knepley   PetscDSGetRiemannSolver - Returns the Riemann solver for the given field
17330c2f2876SMatthew G. Knepley 
17340c2f2876SMatthew G. Knepley   Not collective
17350c2f2876SMatthew G. Knepley 
17360c2f2876SMatthew G. Knepley   Input Arguments:
17370c2f2876SMatthew G. Knepley + prob - The PetscDS object
17380c2f2876SMatthew G. Knepley - f    - The field number
17390c2f2876SMatthew G. Knepley 
17400c2f2876SMatthew G. Knepley   Output Argument:
17410c2f2876SMatthew G. Knepley . r    - Riemann solver
17420c2f2876SMatthew G. Knepley 
17430c2f2876SMatthew G. Knepley   Calling sequence for r:
17440c2f2876SMatthew G. Knepley 
17455db36cf9SMatthew G. Knepley $ r(PetscInt dim, PetscInt Nf, const PetscReal x[], const PetscReal n[], const PetscScalar uL[], const PetscScalar uR[], PetscScalar flux[], void *ctx)
17460c2f2876SMatthew G. Knepley 
17475db36cf9SMatthew G. Knepley + dim  - The spatial dimension
17485db36cf9SMatthew G. Knepley . Nf   - The number of fields
17495db36cf9SMatthew G. Knepley . x    - The coordinates at a point on the interface
17500c2f2876SMatthew G. Knepley . n    - The normal vector to the interface
17510c2f2876SMatthew G. Knepley . uL   - The state vector to the left of the interface
17520c2f2876SMatthew G. Knepley . uR   - The state vector to the right of the interface
17530c2f2876SMatthew G. Knepley . flux - output array of flux through the interface
175497b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
175597b6e6e8SMatthew G. Knepley . constants - constant parameters
17560c2f2876SMatthew G. Knepley - ctx  - optional user context
17570c2f2876SMatthew G. Knepley 
17580c2f2876SMatthew G. Knepley   Level: intermediate
17590c2f2876SMatthew G. Knepley 
17600c2f2876SMatthew G. Knepley .seealso: PetscDSSetRiemannSolver()
17610c2f2876SMatthew G. Knepley @*/
17620c2f2876SMatthew G. Knepley PetscErrorCode PetscDSGetRiemannSolver(PetscDS prob, PetscInt f,
176397b6e6e8SMatthew 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))
17640c2f2876SMatthew G. Knepley {
17650c2f2876SMatthew G. Knepley   PetscFunctionBegin;
17660c2f2876SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
17670c2f2876SMatthew 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);
17680c2f2876SMatthew G. Knepley   PetscValidPointer(r, 3);
17690c2f2876SMatthew G. Knepley   *r = prob->r[f];
17700c2f2876SMatthew G. Knepley   PetscFunctionReturn(0);
17710c2f2876SMatthew G. Knepley }
17720c2f2876SMatthew G. Knepley 
17730c2f2876SMatthew G. Knepley /*@C
17740c2f2876SMatthew G. Knepley   PetscDSSetRiemannSolver - Sets the Riemann solver for the given field
17750c2f2876SMatthew G. Knepley 
17760c2f2876SMatthew G. Knepley   Not collective
17770c2f2876SMatthew G. Knepley 
17780c2f2876SMatthew G. Knepley   Input Arguments:
17790c2f2876SMatthew G. Knepley + prob - The PetscDS object
17800c2f2876SMatthew G. Knepley . f    - The field number
17810c2f2876SMatthew G. Knepley - r    - Riemann solver
17820c2f2876SMatthew G. Knepley 
17830c2f2876SMatthew G. Knepley   Calling sequence for r:
17840c2f2876SMatthew G. Knepley 
17855db36cf9SMatthew G. Knepley $ r(PetscInt dim, PetscInt Nf, const PetscReal x[], const PetscReal n[], const PetscScalar uL[], const PetscScalar uR[], PetscScalar flux[], void *ctx)
17860c2f2876SMatthew G. Knepley 
17875db36cf9SMatthew G. Knepley + dim  - The spatial dimension
17885db36cf9SMatthew G. Knepley . Nf   - The number of fields
17895db36cf9SMatthew G. Knepley . x    - The coordinates at a point on the interface
17900c2f2876SMatthew G. Knepley . n    - The normal vector to the interface
17910c2f2876SMatthew G. Knepley . uL   - The state vector to the left of the interface
17920c2f2876SMatthew G. Knepley . uR   - The state vector to the right of the interface
17930c2f2876SMatthew G. Knepley . flux - output array of flux through the interface
179497b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
179597b6e6e8SMatthew G. Knepley . constants - constant parameters
17960c2f2876SMatthew G. Knepley - ctx  - optional user context
17970c2f2876SMatthew G. Knepley 
17980c2f2876SMatthew G. Knepley   Level: intermediate
17990c2f2876SMatthew G. Knepley 
18000c2f2876SMatthew G. Knepley .seealso: PetscDSGetRiemannSolver()
18010c2f2876SMatthew G. Knepley @*/
18020c2f2876SMatthew G. Knepley PetscErrorCode PetscDSSetRiemannSolver(PetscDS prob, PetscInt f,
180397b6e6e8SMatthew 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))
18040c2f2876SMatthew G. Knepley {
18050c2f2876SMatthew G. Knepley   PetscErrorCode ierr;
18060c2f2876SMatthew G. Knepley 
18070c2f2876SMatthew G. Knepley   PetscFunctionBegin;
18080c2f2876SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1809de716cbcSToby Isaac   if (r) PetscValidFunction(r, 3);
18100c2f2876SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
18110c2f2876SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
18120c2f2876SMatthew G. Knepley   prob->r[f] = r;
18130c2f2876SMatthew G. Knepley   PetscFunctionReturn(0);
18140c2f2876SMatthew G. Knepley }
18150c2f2876SMatthew G. Knepley 
181632d2bbc9SMatthew G. Knepley /*@C
181732d2bbc9SMatthew G. Knepley   PetscDSGetUpdate - Get the pointwise update function for a given field
181832d2bbc9SMatthew G. Knepley 
181932d2bbc9SMatthew G. Knepley   Not collective
182032d2bbc9SMatthew G. Knepley 
182132d2bbc9SMatthew G. Knepley   Input Parameters:
182232d2bbc9SMatthew G. Knepley + prob - The PetscDS
182332d2bbc9SMatthew G. Knepley - f    - The field number
182432d2bbc9SMatthew G. Knepley 
182532d2bbc9SMatthew G. Knepley   Output Parameters:
182632d2bbc9SMatthew G. Knepley + update - update function
182732d2bbc9SMatthew G. Knepley 
182832d2bbc9SMatthew G. Knepley   Note: The calling sequence for the callback update is given by:
182932d2bbc9SMatthew G. Knepley 
183032d2bbc9SMatthew G. Knepley $ update(PetscInt dim, PetscInt Nf, PetscInt NfAux,
183132d2bbc9SMatthew G. Knepley $        const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
183232d2bbc9SMatthew G. Knepley $        const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
183332d2bbc9SMatthew G. Knepley $        PetscReal t, const PetscReal x[], PetscScalar uNew[])
183432d2bbc9SMatthew G. Knepley 
183532d2bbc9SMatthew G. Knepley + dim - the spatial dimension
183632d2bbc9SMatthew G. Knepley . Nf - the number of fields
183732d2bbc9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
183832d2bbc9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
183932d2bbc9SMatthew G. Knepley . u - each field evaluated at the current point
184032d2bbc9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
184132d2bbc9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
184232d2bbc9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
184332d2bbc9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
184432d2bbc9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
184532d2bbc9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
184632d2bbc9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
184732d2bbc9SMatthew G. Knepley . t - current time
184832d2bbc9SMatthew G. Knepley . x - coordinates of the current point
184932d2bbc9SMatthew G. Knepley - uNew - new value for field at the current point
185032d2bbc9SMatthew G. Knepley 
185132d2bbc9SMatthew G. Knepley   Level: intermediate
185232d2bbc9SMatthew G. Knepley 
185332d2bbc9SMatthew G. Knepley .seealso: PetscDSSetUpdate(), PetscDSSetResidual()
185432d2bbc9SMatthew G. Knepley @*/
185532d2bbc9SMatthew G. Knepley PetscErrorCode PetscDSGetUpdate(PetscDS prob, PetscInt f,
185632d2bbc9SMatthew G. Knepley                                   void (**update)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
185732d2bbc9SMatthew G. Knepley                                                   const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
185832d2bbc9SMatthew G. Knepley                                                   const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
18593fa77dffSMatthew G. Knepley                                                   PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar uNew[]))
186032d2bbc9SMatthew G. Knepley {
186132d2bbc9SMatthew G. Knepley   PetscFunctionBegin;
186232d2bbc9SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
186332d2bbc9SMatthew 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);
186432d2bbc9SMatthew G. Knepley   if (update) {PetscValidPointer(update, 3); *update = prob->update[f];}
186532d2bbc9SMatthew G. Knepley   PetscFunctionReturn(0);
186632d2bbc9SMatthew G. Knepley }
186732d2bbc9SMatthew G. Knepley 
186832d2bbc9SMatthew G. Knepley /*@C
18693fa77dffSMatthew G. Knepley   PetscDSSetUpdate - Set the pointwise update function for a given field
187032d2bbc9SMatthew G. Knepley 
187132d2bbc9SMatthew G. Knepley   Not collective
187232d2bbc9SMatthew G. Knepley 
187332d2bbc9SMatthew G. Knepley   Input Parameters:
187432d2bbc9SMatthew G. Knepley + prob   - The PetscDS
187532d2bbc9SMatthew G. Knepley . f      - The field number
187632d2bbc9SMatthew G. Knepley - update - update function
187732d2bbc9SMatthew G. Knepley 
187832d2bbc9SMatthew G. Knepley   Note: The calling sequence for the callback update is given by:
187932d2bbc9SMatthew G. Knepley 
188032d2bbc9SMatthew G. Knepley $ update(PetscInt dim, PetscInt Nf, PetscInt NfAux,
188132d2bbc9SMatthew G. Knepley $        const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
188232d2bbc9SMatthew G. Knepley $        const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
188332d2bbc9SMatthew G. Knepley $        PetscReal t, const PetscReal x[], PetscScalar uNew[])
188432d2bbc9SMatthew G. Knepley 
188532d2bbc9SMatthew G. Knepley + dim - the spatial dimension
188632d2bbc9SMatthew G. Knepley . Nf - the number of fields
188732d2bbc9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
188832d2bbc9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
188932d2bbc9SMatthew G. Knepley . u - each field evaluated at the current point
189032d2bbc9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
189132d2bbc9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
189232d2bbc9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
189332d2bbc9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
189432d2bbc9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
189532d2bbc9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
189632d2bbc9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
189732d2bbc9SMatthew G. Knepley . t - current time
189832d2bbc9SMatthew G. Knepley . x - coordinates of the current point
189932d2bbc9SMatthew G. Knepley - uNew - new field values at the current point
190032d2bbc9SMatthew G. Knepley 
190132d2bbc9SMatthew G. Knepley   Level: intermediate
190232d2bbc9SMatthew G. Knepley 
190332d2bbc9SMatthew G. Knepley .seealso: PetscDSGetResidual()
190432d2bbc9SMatthew G. Knepley @*/
190532d2bbc9SMatthew G. Knepley PetscErrorCode PetscDSSetUpdate(PetscDS prob, PetscInt f,
190632d2bbc9SMatthew G. Knepley                                 void (*update)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
190732d2bbc9SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
190832d2bbc9SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
19093fa77dffSMatthew G. Knepley                                                PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar uNew[]))
191032d2bbc9SMatthew G. Knepley {
191132d2bbc9SMatthew G. Knepley   PetscErrorCode ierr;
191232d2bbc9SMatthew G. Knepley 
191332d2bbc9SMatthew G. Knepley   PetscFunctionBegin;
191432d2bbc9SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
191532d2bbc9SMatthew G. Knepley   if (update) PetscValidFunction(update, 3);
191632d2bbc9SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
191732d2bbc9SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
191832d2bbc9SMatthew G. Knepley   prob->update[f] = update;
191932d2bbc9SMatthew G. Knepley   PetscFunctionReturn(0);
192032d2bbc9SMatthew G. Knepley }
192132d2bbc9SMatthew G. Knepley 
19220c2f2876SMatthew G. Knepley PetscErrorCode PetscDSGetContext(PetscDS prob, PetscInt f, void **ctx)
19230c2f2876SMatthew G. Knepley {
19240c2f2876SMatthew G. Knepley   PetscFunctionBegin;
19250c2f2876SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
19260c2f2876SMatthew 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);
19270c2f2876SMatthew G. Knepley   PetscValidPointer(ctx, 3);
19280c2f2876SMatthew G. Knepley   *ctx = prob->ctx[f];
19290c2f2876SMatthew G. Knepley   PetscFunctionReturn(0);
19300c2f2876SMatthew G. Knepley }
19310c2f2876SMatthew G. Knepley 
19320c2f2876SMatthew G. Knepley PetscErrorCode PetscDSSetContext(PetscDS prob, PetscInt f, void *ctx)
19330c2f2876SMatthew G. Knepley {
19340c2f2876SMatthew G. Knepley   PetscErrorCode ierr;
19350c2f2876SMatthew G. Knepley 
19360c2f2876SMatthew G. Knepley   PetscFunctionBegin;
19370c2f2876SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
19380c2f2876SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
19390c2f2876SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
19400c2f2876SMatthew G. Knepley   prob->ctx[f] = ctx;
19410c2f2876SMatthew G. Knepley   PetscFunctionReturn(0);
19420c2f2876SMatthew G. Knepley }
19430c2f2876SMatthew G. Knepley 
1944194d53e6SMatthew G. Knepley /*@C
1945194d53e6SMatthew G. Knepley   PetscDSGetBdResidual - Get the pointwise boundary residual function for a given test field
1946194d53e6SMatthew G. Knepley 
1947194d53e6SMatthew G. Knepley   Not collective
1948194d53e6SMatthew G. Knepley 
1949194d53e6SMatthew G. Knepley   Input Parameters:
1950194d53e6SMatthew G. Knepley + prob - The PetscDS
1951194d53e6SMatthew G. Knepley - f    - The test field number
1952194d53e6SMatthew G. Knepley 
1953194d53e6SMatthew G. Knepley   Output Parameters:
1954194d53e6SMatthew G. Knepley + f0 - boundary integrand for the test function term
1955194d53e6SMatthew G. Knepley - f1 - boundary integrand for the test function gradient term
1956194d53e6SMatthew G. Knepley 
1957194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1958194d53e6SMatthew G. Knepley 
1959194d53e6SMatthew 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
1960194d53e6SMatthew G. Knepley 
1961194d53e6SMatthew G. Knepley The calling sequence for the callbacks f0 and f1 is given by:
1962194d53e6SMatthew G. Knepley 
196330b9ff8bSMatthew G. Knepley $ f0(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[],
196630b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar f0[])
1967194d53e6SMatthew G. Knepley 
1968194d53e6SMatthew G. Knepley + dim - the spatial dimension
1969194d53e6SMatthew G. Knepley . Nf - the number of fields
1970194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1971194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1972194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
1973194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1974194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1975194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1976194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1977194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1978194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1979194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1980194d53e6SMatthew G. Knepley . t - current time
1981194d53e6SMatthew G. Knepley . x - coordinates of the current point
1982194d53e6SMatthew G. Knepley . n - unit normal at the current point
198397b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
198497b6e6e8SMatthew G. Knepley . constants - constant parameters
1985194d53e6SMatthew G. Knepley - f0 - output values at the current point
1986194d53e6SMatthew G. Knepley 
1987194d53e6SMatthew G. Knepley   Level: intermediate
1988194d53e6SMatthew G. Knepley 
1989194d53e6SMatthew G. Knepley .seealso: PetscDSSetBdResidual()
1990194d53e6SMatthew G. Knepley @*/
19912764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetBdResidual(PetscDS prob, PetscInt f,
199230b9ff8bSMatthew G. Knepley                                     void (**f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1993194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1994194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
199597b6e6e8SMatthew G. Knepley                                                 PetscReal t, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f0[]),
199630b9ff8bSMatthew G. Knepley                                     void (**f1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1997194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1998194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
199997b6e6e8SMatthew G. Knepley                                                 PetscReal t, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f1[]))
20002764a2aaSMatthew G. Knepley {
20012764a2aaSMatthew G. Knepley   PetscFunctionBegin;
20022764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
20032764a2aaSMatthew 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);
20042764a2aaSMatthew G. Knepley   if (f0) {PetscValidPointer(f0, 3); *f0 = prob->fBd[f*2+0];}
20052764a2aaSMatthew G. Knepley   if (f1) {PetscValidPointer(f1, 4); *f1 = prob->fBd[f*2+1];}
20062764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
20072764a2aaSMatthew G. Knepley }
20082764a2aaSMatthew G. Knepley 
2009194d53e6SMatthew G. Knepley /*@C
2010194d53e6SMatthew G. Knepley   PetscDSSetBdResidual - Get the pointwise boundary residual function for a given test field
2011194d53e6SMatthew G. Knepley 
2012194d53e6SMatthew G. Knepley   Not collective
2013194d53e6SMatthew G. Knepley 
2014194d53e6SMatthew G. Knepley   Input Parameters:
2015194d53e6SMatthew G. Knepley + prob - The PetscDS
2016194d53e6SMatthew G. Knepley . f    - The test field number
2017194d53e6SMatthew G. Knepley . f0 - boundary integrand for the test function term
2018194d53e6SMatthew G. Knepley - f1 - boundary integrand for the test function gradient term
2019194d53e6SMatthew G. Knepley 
2020194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
2021194d53e6SMatthew G. Knepley 
2022194d53e6SMatthew 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
2023194d53e6SMatthew G. Knepley 
2024194d53e6SMatthew G. Knepley The calling sequence for the callbacks f0 and f1 is given by:
2025194d53e6SMatthew G. Knepley 
202630b9ff8bSMatthew G. Knepley $ f0(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[],
202930b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar f0[])
2030194d53e6SMatthew G. Knepley 
2031194d53e6SMatthew G. Knepley + dim - the spatial dimension
2032194d53e6SMatthew G. Knepley . Nf - the number of fields
2033194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
2034194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
2035194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
2036194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
2037194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
2038194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
2039194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
2040194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
2041194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
2042194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
2043194d53e6SMatthew G. Knepley . t - current time
2044194d53e6SMatthew G. Knepley . x - coordinates of the current point
2045194d53e6SMatthew G. Knepley . n - unit normal at the current point
204697b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
204797b6e6e8SMatthew G. Knepley . constants - constant parameters
2048194d53e6SMatthew G. Knepley - f0 - output values at the current point
2049194d53e6SMatthew G. Knepley 
2050194d53e6SMatthew G. Knepley   Level: intermediate
2051194d53e6SMatthew G. Knepley 
2052194d53e6SMatthew G. Knepley .seealso: PetscDSGetBdResidual()
2053194d53e6SMatthew G. Knepley @*/
20542764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetBdResidual(PetscDS prob, PetscInt f,
205530b9ff8bSMatthew G. Knepley                                     void (*f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2056194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2057194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
205897b6e6e8SMatthew G. Knepley                                                PetscReal t, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f0[]),
205930b9ff8bSMatthew G. Knepley                                     void (*f1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2060194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2061194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
206297b6e6e8SMatthew G. Knepley                                                PetscReal t, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f1[]))
20632764a2aaSMatthew G. Knepley {
20642764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
20652764a2aaSMatthew G. Knepley 
20662764a2aaSMatthew G. Knepley   PetscFunctionBegin;
20672764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
20682764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
20692764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
20702764a2aaSMatthew G. Knepley   if (f0) {PetscValidFunction(f0, 3); prob->fBd[f*2+0] = f0;}
20712764a2aaSMatthew G. Knepley   if (f1) {PetscValidFunction(f1, 4); prob->fBd[f*2+1] = f1;}
20722764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
20732764a2aaSMatthew G. Knepley }
20742764a2aaSMatthew G. Knepley 
2075194d53e6SMatthew G. Knepley /*@C
2076194d53e6SMatthew G. Knepley   PetscDSGetBdJacobian - Get the pointwise boundary Jacobian function for given test and basis field
2077194d53e6SMatthew G. Knepley 
2078194d53e6SMatthew G. Knepley   Not collective
2079194d53e6SMatthew G. Knepley 
2080194d53e6SMatthew G. Knepley   Input Parameters:
2081194d53e6SMatthew G. Knepley + prob - The PetscDS
2082194d53e6SMatthew G. Knepley . f    - The test field number
2083194d53e6SMatthew G. Knepley - g    - The field number
2084194d53e6SMatthew G. Knepley 
2085194d53e6SMatthew G. Knepley   Output Parameters:
2086194d53e6SMatthew G. Knepley + g0 - integrand for the test and basis function term
2087194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
2088194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
2089194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
2090194d53e6SMatthew G. Knepley 
2091194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
2092194d53e6SMatthew G. Knepley 
2093194d53e6SMatthew 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
2094194d53e6SMatthew G. Knepley 
2095194d53e6SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
2096194d53e6SMatthew G. Knepley 
209730b9ff8bSMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2098194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2099194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
210030b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar g0[])
2101194d53e6SMatthew G. Knepley 
2102194d53e6SMatthew G. Knepley + dim - the spatial dimension
2103194d53e6SMatthew G. Knepley . Nf - the number of fields
2104194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
2105194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
2106194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
2107194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
2108194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
2109194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
2110194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
2111194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
2112194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
2113194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
2114194d53e6SMatthew G. Knepley . t - current time
21152aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
2116194d53e6SMatthew G. Knepley . x - coordinates of the current point
2117194d53e6SMatthew G. Knepley . n - normal at the current point
211897b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
211997b6e6e8SMatthew G. Knepley . constants - constant parameters
2120194d53e6SMatthew G. Knepley - g0 - output values at the current point
2121194d53e6SMatthew G. Knepley 
2122194d53e6SMatthew G. Knepley   Level: intermediate
2123194d53e6SMatthew G. Knepley 
2124194d53e6SMatthew G. Knepley .seealso: PetscDSSetBdJacobian()
2125194d53e6SMatthew G. Knepley @*/
21262764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetBdJacobian(PetscDS prob, PetscInt f, PetscInt g,
212730b9ff8bSMatthew G. Knepley                                     void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2128194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2129194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
213097b6e6e8SMatthew G. Knepley                                                 PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
213130b9ff8bSMatthew G. Knepley                                     void (**g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2132194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2133194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
213497b6e6e8SMatthew G. Knepley                                                 PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
213530b9ff8bSMatthew G. Knepley                                     void (**g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2136194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2137194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
213897b6e6e8SMatthew G. Knepley                                                 PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
213930b9ff8bSMatthew G. Knepley                                     void (**g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2140194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2141194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
214297b6e6e8SMatthew G. Knepley                                                 PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
21432764a2aaSMatthew G. Knepley {
21442764a2aaSMatthew G. Knepley   PetscFunctionBegin;
21452764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
21462764a2aaSMatthew 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);
21472764a2aaSMatthew 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);
21482764a2aaSMatthew G. Knepley   if (g0) {PetscValidPointer(g0, 4); *g0 = prob->gBd[(f*prob->Nf + g)*4+0];}
21492764a2aaSMatthew G. Knepley   if (g1) {PetscValidPointer(g1, 5); *g1 = prob->gBd[(f*prob->Nf + g)*4+1];}
21502764a2aaSMatthew G. Knepley   if (g2) {PetscValidPointer(g2, 6); *g2 = prob->gBd[(f*prob->Nf + g)*4+2];}
21512764a2aaSMatthew G. Knepley   if (g3) {PetscValidPointer(g3, 7); *g3 = prob->gBd[(f*prob->Nf + g)*4+3];}
21522764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
21532764a2aaSMatthew G. Knepley }
21542764a2aaSMatthew G. Knepley 
2155194d53e6SMatthew G. Knepley /*@C
2156194d53e6SMatthew G. Knepley   PetscDSSetBdJacobian - Set the pointwise boundary Jacobian function for given test and basis field
2157194d53e6SMatthew G. Knepley 
2158194d53e6SMatthew G. Knepley   Not collective
2159194d53e6SMatthew G. Knepley 
2160194d53e6SMatthew G. Knepley   Input Parameters:
2161194d53e6SMatthew G. Knepley + prob - The PetscDS
2162194d53e6SMatthew G. Knepley . f    - The test field number
2163194d53e6SMatthew G. Knepley . g    - The field number
2164194d53e6SMatthew G. Knepley . g0 - integrand for the test and basis function term
2165194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
2166194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
2167194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
2168194d53e6SMatthew G. Knepley 
2169194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
2170194d53e6SMatthew G. Knepley 
2171194d53e6SMatthew 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
2172194d53e6SMatthew G. Knepley 
2173194d53e6SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
2174194d53e6SMatthew G. Knepley 
217530b9ff8bSMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2176194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2177194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
217830b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar g0[])
2179194d53e6SMatthew G. Knepley 
2180194d53e6SMatthew G. Knepley + dim - the spatial dimension
2181194d53e6SMatthew G. Knepley . Nf - the number of fields
2182194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
2183194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
2184194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
2185194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
2186194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
2187194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
2188194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
2189194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
2190194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
2191194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
2192194d53e6SMatthew G. Knepley . t - current time
21932aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
2194194d53e6SMatthew G. Knepley . x - coordinates of the current point
2195194d53e6SMatthew G. Knepley . n - normal at the current point
219697b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
219797b6e6e8SMatthew G. Knepley . constants - constant parameters
2198194d53e6SMatthew G. Knepley - g0 - output values at the current point
2199194d53e6SMatthew G. Knepley 
2200194d53e6SMatthew G. Knepley   Level: intermediate
2201194d53e6SMatthew G. Knepley 
2202194d53e6SMatthew G. Knepley .seealso: PetscDSGetBdJacobian()
2203194d53e6SMatthew G. Knepley @*/
22042764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetBdJacobian(PetscDS prob, PetscInt f, PetscInt g,
220530b9ff8bSMatthew G. Knepley                                     void (*g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2206194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2207194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
220897b6e6e8SMatthew G. Knepley                                                PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
220930b9ff8bSMatthew G. Knepley                                     void (*g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2210194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2211194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
221297b6e6e8SMatthew G. Knepley                                                PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
221330b9ff8bSMatthew G. Knepley                                     void (*g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2214194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2215194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
221697b6e6e8SMatthew G. Knepley                                                PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
221730b9ff8bSMatthew G. Knepley                                     void (*g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2218194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2219194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
222097b6e6e8SMatthew G. Knepley                                                PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
22212764a2aaSMatthew G. Knepley {
22222764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
22232764a2aaSMatthew G. Knepley 
22242764a2aaSMatthew G. Knepley   PetscFunctionBegin;
22252764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
22262764a2aaSMatthew G. Knepley   if (g0) PetscValidFunction(g0, 4);
22272764a2aaSMatthew G. Knepley   if (g1) PetscValidFunction(g1, 5);
22282764a2aaSMatthew G. Knepley   if (g2) PetscValidFunction(g2, 6);
22292764a2aaSMatthew G. Knepley   if (g3) PetscValidFunction(g3, 7);
22302764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
22312764a2aaSMatthew G. Knepley   if (g < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", g);
22322764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, PetscMax(f, g)+1);CHKERRQ(ierr);
22332764a2aaSMatthew G. Knepley   prob->gBd[(f*prob->Nf + g)*4+0] = g0;
22342764a2aaSMatthew G. Knepley   prob->gBd[(f*prob->Nf + g)*4+1] = g1;
22352764a2aaSMatthew G. Knepley   prob->gBd[(f*prob->Nf + g)*4+2] = g2;
22362764a2aaSMatthew G. Knepley   prob->gBd[(f*prob->Nf + g)*4+3] = g3;
22372764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
22382764a2aaSMatthew G. Knepley }
22392764a2aaSMatthew G. Knepley 
22400d3e9b51SMatthew G. Knepley /*@C
2241c371a6d1SMatthew G. Knepley   PetscDSGetExactSolution - Get the pointwise exact solution function for a given test field
2242c371a6d1SMatthew G. Knepley 
2243c371a6d1SMatthew G. Knepley   Not collective
2244c371a6d1SMatthew G. Knepley 
2245c371a6d1SMatthew G. Knepley   Input Parameters:
2246c371a6d1SMatthew G. Knepley + prob - The PetscDS
2247c371a6d1SMatthew G. Knepley - f    - The test field number
2248c371a6d1SMatthew G. Knepley 
2249c371a6d1SMatthew G. Knepley   Output Parameter:
2250c371a6d1SMatthew G. Knepley . exactSol - exact solution for the test field
2251c371a6d1SMatthew G. Knepley 
2252c371a6d1SMatthew G. Knepley   Note: The calling sequence for the solution functions is given by:
2253c371a6d1SMatthew G. Knepley 
2254c371a6d1SMatthew G. Knepley $ sol(PetscInt dim, PetscReal t, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx)
2255c371a6d1SMatthew G. Knepley 
2256c371a6d1SMatthew G. Knepley + dim - the spatial dimension
2257c371a6d1SMatthew G. Knepley . t - current time
2258c371a6d1SMatthew G. Knepley . x - coordinates of the current point
2259c371a6d1SMatthew G. Knepley . Nc - the number of field components
2260c371a6d1SMatthew G. Knepley . u - the solution field evaluated at the current point
2261c371a6d1SMatthew G. Knepley - ctx - a user context
2262c371a6d1SMatthew G. Knepley 
2263c371a6d1SMatthew G. Knepley   Level: intermediate
2264c371a6d1SMatthew G. Knepley 
2265c371a6d1SMatthew G. Knepley .seealso: PetscDSSetExactSolution()
2266c371a6d1SMatthew G. Knepley @*/
2267c371a6d1SMatthew G. Knepley PetscErrorCode PetscDSGetExactSolution(PetscDS prob, PetscInt f, PetscErrorCode (**sol)(PetscInt dim, PetscReal t, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx))
2268c371a6d1SMatthew G. Knepley {
2269c371a6d1SMatthew G. Knepley   PetscFunctionBegin;
2270c371a6d1SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2271c371a6d1SMatthew 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);
2272c371a6d1SMatthew G. Knepley   if (sol) {PetscValidPointer(sol, 3); *sol = prob->exactSol[f];}
2273c371a6d1SMatthew G. Knepley   PetscFunctionReturn(0);
2274c371a6d1SMatthew G. Knepley }
2275c371a6d1SMatthew G. Knepley 
2276c371a6d1SMatthew G. Knepley /*@C
2277c371a6d1SMatthew G. Knepley   PetscDSSetExactSolution - Get the pointwise exact solution function for a given test field
2278c371a6d1SMatthew G. Knepley 
2279c371a6d1SMatthew G. Knepley   Not collective
2280c371a6d1SMatthew G. Knepley 
2281c371a6d1SMatthew G. Knepley   Input Parameters:
2282c371a6d1SMatthew G. Knepley + prob - The PetscDS
2283c371a6d1SMatthew G. Knepley . f    - The test field number
2284c371a6d1SMatthew G. Knepley - sol  - solution function for the test fields
2285c371a6d1SMatthew G. Knepley 
2286c371a6d1SMatthew G. Knepley   Note: The calling sequence for solution functions is given by:
2287c371a6d1SMatthew G. Knepley 
2288c371a6d1SMatthew G. Knepley $ sol(PetscInt dim, PetscReal t, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx)
2289c371a6d1SMatthew G. Knepley 
2290c371a6d1SMatthew G. Knepley + dim - the spatial dimension
2291c371a6d1SMatthew G. Knepley . t - current time
2292c371a6d1SMatthew G. Knepley . x - coordinates of the current point
2293c371a6d1SMatthew G. Knepley . Nc - the number of field components
2294c371a6d1SMatthew G. Knepley . u - the solution field evaluated at the current point
2295c371a6d1SMatthew G. Knepley - ctx - a user context
2296c371a6d1SMatthew G. Knepley 
2297c371a6d1SMatthew G. Knepley   Level: intermediate
2298c371a6d1SMatthew G. Knepley 
2299c371a6d1SMatthew G. Knepley .seealso: PetscDSGetExactSolution()
2300c371a6d1SMatthew G. Knepley @*/
2301c371a6d1SMatthew G. Knepley PetscErrorCode PetscDSSetExactSolution(PetscDS prob, PetscInt f, PetscErrorCode (*sol)(PetscInt dim, PetscReal t, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx))
2302c371a6d1SMatthew G. Knepley {
2303c371a6d1SMatthew G. Knepley   PetscErrorCode ierr;
2304c371a6d1SMatthew G. Knepley 
2305c371a6d1SMatthew G. Knepley   PetscFunctionBegin;
2306c371a6d1SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2307c371a6d1SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
2308c371a6d1SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
2309c371a6d1SMatthew G. Knepley   if (sol) {PetscValidFunction(sol, 3); prob->exactSol[f] = sol;}
2310c371a6d1SMatthew G. Knepley   PetscFunctionReturn(0);
2311c371a6d1SMatthew G. Knepley }
2312c371a6d1SMatthew G. Knepley 
23135638fd0eSMatthew G. Knepley /*@C
231497b6e6e8SMatthew G. Knepley   PetscDSGetConstants - Returns the array of constants passed to point functions
231597b6e6e8SMatthew G. Knepley 
231697b6e6e8SMatthew G. Knepley   Not collective
231797b6e6e8SMatthew G. Knepley 
231897b6e6e8SMatthew G. Knepley   Input Parameter:
231997b6e6e8SMatthew G. Knepley . prob - The PetscDS object
232097b6e6e8SMatthew G. Knepley 
232197b6e6e8SMatthew G. Knepley   Output Parameters:
232297b6e6e8SMatthew G. Knepley + numConstants - The number of constants
232397b6e6e8SMatthew G. Knepley - constants    - The array of constants, NULL if there are none
232497b6e6e8SMatthew G. Knepley 
232597b6e6e8SMatthew G. Knepley   Level: intermediate
232697b6e6e8SMatthew G. Knepley 
232797b6e6e8SMatthew G. Knepley .seealso: PetscDSSetConstants(), PetscDSCreate()
232897b6e6e8SMatthew G. Knepley @*/
232997b6e6e8SMatthew G. Knepley PetscErrorCode PetscDSGetConstants(PetscDS prob, PetscInt *numConstants, const PetscScalar *constants[])
233097b6e6e8SMatthew G. Knepley {
233197b6e6e8SMatthew G. Knepley   PetscFunctionBegin;
233297b6e6e8SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
233397b6e6e8SMatthew G. Knepley   if (numConstants) {PetscValidPointer(numConstants, 2); *numConstants = prob->numConstants;}
233497b6e6e8SMatthew G. Knepley   if (constants)    {PetscValidPointer(constants, 3);    *constants    = prob->constants;}
233597b6e6e8SMatthew G. Knepley   PetscFunctionReturn(0);
233697b6e6e8SMatthew G. Knepley }
233797b6e6e8SMatthew G. Knepley 
23380d3e9b51SMatthew G. Knepley /*@C
233997b6e6e8SMatthew G. Knepley   PetscDSSetConstants - Set the array of constants passed to point functions
234097b6e6e8SMatthew G. Knepley 
234197b6e6e8SMatthew G. Knepley   Not collective
234297b6e6e8SMatthew G. Knepley 
234397b6e6e8SMatthew G. Knepley   Input Parameters:
234497b6e6e8SMatthew G. Knepley + prob         - The PetscDS object
234597b6e6e8SMatthew G. Knepley . numConstants - The number of constants
234697b6e6e8SMatthew G. Knepley - constants    - The array of constants, NULL if there are none
234797b6e6e8SMatthew G. Knepley 
234897b6e6e8SMatthew G. Knepley   Level: intermediate
234997b6e6e8SMatthew G. Knepley 
235097b6e6e8SMatthew G. Knepley .seealso: PetscDSGetConstants(), PetscDSCreate()
235197b6e6e8SMatthew G. Knepley @*/
235297b6e6e8SMatthew G. Knepley PetscErrorCode PetscDSSetConstants(PetscDS prob, PetscInt numConstants, PetscScalar constants[])
235397b6e6e8SMatthew G. Knepley {
235497b6e6e8SMatthew G. Knepley   PetscErrorCode ierr;
235597b6e6e8SMatthew G. Knepley 
235697b6e6e8SMatthew G. Knepley   PetscFunctionBegin;
235797b6e6e8SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
235897b6e6e8SMatthew G. Knepley   if (numConstants != prob->numConstants) {
235997b6e6e8SMatthew G. Knepley     ierr = PetscFree(prob->constants);CHKERRQ(ierr);
236097b6e6e8SMatthew G. Knepley     prob->numConstants = numConstants;
236197b6e6e8SMatthew G. Knepley     if (prob->numConstants) {
236297b6e6e8SMatthew G. Knepley       ierr = PetscMalloc1(prob->numConstants, &prob->constants);CHKERRQ(ierr);
236320be0f5bSMatthew G. Knepley     } else {
236420be0f5bSMatthew G. Knepley       prob->constants = NULL;
236520be0f5bSMatthew G. Knepley     }
236620be0f5bSMatthew G. Knepley   }
236720be0f5bSMatthew G. Knepley   if (prob->numConstants) {
236820be0f5bSMatthew G. Knepley     PetscValidPointer(constants, 3);
236997b6e6e8SMatthew G. Knepley     ierr = PetscMemcpy(prob->constants, constants, prob->numConstants * sizeof(PetscScalar));CHKERRQ(ierr);
237097b6e6e8SMatthew G. Knepley   }
237197b6e6e8SMatthew G. Knepley   PetscFunctionReturn(0);
237297b6e6e8SMatthew G. Knepley }
237397b6e6e8SMatthew G. Knepley 
23744cd1e086SMatthew G. Knepley /*@
23754cd1e086SMatthew G. Knepley   PetscDSGetFieldIndex - Returns the index of the given field
23764cd1e086SMatthew G. Knepley 
23774cd1e086SMatthew G. Knepley   Not collective
23784cd1e086SMatthew G. Knepley 
23794cd1e086SMatthew G. Knepley   Input Parameters:
23804cd1e086SMatthew G. Knepley + prob - The PetscDS object
23814cd1e086SMatthew G. Knepley - disc - The discretization object
23824cd1e086SMatthew G. Knepley 
23834cd1e086SMatthew G. Knepley   Output Parameter:
23844cd1e086SMatthew G. Knepley . f - The field number
23854cd1e086SMatthew G. Knepley 
23864cd1e086SMatthew G. Knepley   Level: beginner
23874cd1e086SMatthew G. Knepley 
2388f744cafaSSander Arens .seealso: PetscGetDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
23894cd1e086SMatthew G. Knepley @*/
23904cd1e086SMatthew G. Knepley PetscErrorCode PetscDSGetFieldIndex(PetscDS prob, PetscObject disc, PetscInt *f)
23914cd1e086SMatthew G. Knepley {
23924cd1e086SMatthew G. Knepley   PetscInt g;
23934cd1e086SMatthew G. Knepley 
23944cd1e086SMatthew G. Knepley   PetscFunctionBegin;
23954cd1e086SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
23964cd1e086SMatthew G. Knepley   PetscValidPointer(f, 3);
23974cd1e086SMatthew G. Knepley   *f = -1;
23984cd1e086SMatthew G. Knepley   for (g = 0; g < prob->Nf; ++g) {if (disc == prob->disc[g]) break;}
23994cd1e086SMatthew G. Knepley   if (g == prob->Nf) SETERRQ(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Field not found in PetscDS.");
24004cd1e086SMatthew G. Knepley   *f = g;
24014cd1e086SMatthew G. Knepley   PetscFunctionReturn(0);
24024cd1e086SMatthew G. Knepley }
24034cd1e086SMatthew G. Knepley 
24044cd1e086SMatthew G. Knepley /*@
24054cd1e086SMatthew G. Knepley   PetscDSGetFieldSize - Returns the size of the given field in the full space basis
24064cd1e086SMatthew G. Knepley 
24074cd1e086SMatthew G. Knepley   Not collective
24084cd1e086SMatthew G. Knepley 
24094cd1e086SMatthew G. Knepley   Input Parameters:
24104cd1e086SMatthew G. Knepley + prob - The PetscDS object
24114cd1e086SMatthew G. Knepley - f - The field number
24124cd1e086SMatthew G. Knepley 
24134cd1e086SMatthew G. Knepley   Output Parameter:
24144cd1e086SMatthew G. Knepley . size - The size
24154cd1e086SMatthew G. Knepley 
24164cd1e086SMatthew G. Knepley   Level: beginner
24174cd1e086SMatthew G. Knepley 
2418f744cafaSSander Arens .seealso: PetscDSGetFieldOffset(), PetscDSGetNumFields(), PetscDSCreate()
24194cd1e086SMatthew G. Knepley @*/
24204cd1e086SMatthew G. Knepley PetscErrorCode PetscDSGetFieldSize(PetscDS prob, PetscInt f, PetscInt *size)
24214cd1e086SMatthew G. Knepley {
24222166fd64SMatthew G. Knepley   PetscErrorCode ierr;
24232166fd64SMatthew G. Knepley 
24244cd1e086SMatthew G. Knepley   PetscFunctionBegin;
24254cd1e086SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
24264cd1e086SMatthew G. Knepley   PetscValidPointer(size, 3);
24274cd1e086SMatthew 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);
24282166fd64SMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
2429d4742ddaSMatthew G. Knepley   *size = prob->Nb[f];
24304cd1e086SMatthew G. Knepley   PetscFunctionReturn(0);
24314cd1e086SMatthew G. Knepley }
24324cd1e086SMatthew G. Knepley 
2433bc4ae4beSMatthew G. Knepley /*@
2434bc4ae4beSMatthew G. Knepley   PetscDSGetFieldOffset - Returns the offset of the given field in the full space basis
2435bc4ae4beSMatthew G. Knepley 
2436bc4ae4beSMatthew G. Knepley   Not collective
2437bc4ae4beSMatthew G. Knepley 
2438bc4ae4beSMatthew G. Knepley   Input Parameters:
2439bc4ae4beSMatthew G. Knepley + prob - The PetscDS object
2440bc4ae4beSMatthew G. Knepley - f - The field number
2441bc4ae4beSMatthew G. Knepley 
2442bc4ae4beSMatthew G. Knepley   Output Parameter:
2443bc4ae4beSMatthew G. Knepley . off - The offset
2444bc4ae4beSMatthew G. Knepley 
2445bc4ae4beSMatthew G. Knepley   Level: beginner
2446bc4ae4beSMatthew G. Knepley 
2447f744cafaSSander Arens .seealso: PetscDSGetFieldSize(), PetscDSGetNumFields(), PetscDSCreate()
2448bc4ae4beSMatthew G. Knepley @*/
24492764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetFieldOffset(PetscDS prob, PetscInt f, PetscInt *off)
24502764a2aaSMatthew G. Knepley {
24514cd1e086SMatthew G. Knepley   PetscInt       size, g;
24522764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
24532764a2aaSMatthew G. Knepley 
24542764a2aaSMatthew G. Knepley   PetscFunctionBegin;
24552764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
24562764a2aaSMatthew G. Knepley   PetscValidPointer(off, 3);
24572764a2aaSMatthew 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);
24582764a2aaSMatthew G. Knepley   *off = 0;
24592764a2aaSMatthew G. Knepley   for (g = 0; g < f; ++g) {
24604cd1e086SMatthew G. Knepley     ierr = PetscDSGetFieldSize(prob, g, &size);CHKERRQ(ierr);
24614cd1e086SMatthew G. Knepley     *off += size;
24622764a2aaSMatthew G. Knepley   }
24632764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
24642764a2aaSMatthew G. Knepley }
24652764a2aaSMatthew G. Knepley 
2466bc4ae4beSMatthew G. Knepley /*@
246747e57110SSander Arens   PetscDSGetDimensions - Returns the size of the approximation space for each field on an evaluation point
2468bc4ae4beSMatthew G. Knepley 
2469bc4ae4beSMatthew G. Knepley   Not collective
2470bc4ae4beSMatthew G. Knepley 
247147e57110SSander Arens   Input Parameter:
247247e57110SSander Arens . prob - The PetscDS object
2473bc4ae4beSMatthew G. Knepley 
2474bc4ae4beSMatthew G. Knepley   Output Parameter:
247547e57110SSander Arens . dimensions - The number of dimensions
2476bc4ae4beSMatthew G. Knepley 
2477bc4ae4beSMatthew G. Knepley   Level: beginner
2478bc4ae4beSMatthew G. Knepley 
247947e57110SSander Arens .seealso: PetscDSGetComponentOffsets(), PetscDSGetNumFields(), PetscDSCreate()
2480bc4ae4beSMatthew G. Knepley @*/
248147e57110SSander Arens PetscErrorCode PetscDSGetDimensions(PetscDS prob, PetscInt *dimensions[])
24822764a2aaSMatthew G. Knepley {
24832764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
24842764a2aaSMatthew G. Knepley 
24852764a2aaSMatthew G. Knepley   PetscFunctionBegin;
24862764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
248747e57110SSander Arens   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
248847e57110SSander Arens   PetscValidPointer(dimensions, 2);
248947e57110SSander Arens   *dimensions = prob->Nb;
249047e57110SSander Arens   PetscFunctionReturn(0);
24916ce16762SMatthew G. Knepley }
249247e57110SSander Arens 
249347e57110SSander Arens /*@
249447e57110SSander Arens   PetscDSGetComponents - Returns the number of components for each field on an evaluation point
249547e57110SSander Arens 
249647e57110SSander Arens   Not collective
249747e57110SSander Arens 
249847e57110SSander Arens   Input Parameter:
249947e57110SSander Arens . prob - The PetscDS object
250047e57110SSander Arens 
250147e57110SSander Arens   Output Parameter:
250247e57110SSander Arens . components - The number of components
250347e57110SSander Arens 
250447e57110SSander Arens   Level: beginner
250547e57110SSander Arens 
250647e57110SSander Arens .seealso: PetscDSGetComponentOffsets(), PetscDSGetNumFields(), PetscDSCreate()
250747e57110SSander Arens @*/
250847e57110SSander Arens PetscErrorCode PetscDSGetComponents(PetscDS prob, PetscInt *components[])
250947e57110SSander Arens {
251047e57110SSander Arens   PetscErrorCode ierr;
251147e57110SSander Arens 
251247e57110SSander Arens   PetscFunctionBegin;
251347e57110SSander Arens   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
251447e57110SSander Arens   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
251547e57110SSander Arens   PetscValidPointer(components, 2);
251647e57110SSander Arens   *components = prob->Nc;
25176ce16762SMatthew G. Knepley   PetscFunctionReturn(0);
25186ce16762SMatthew G. Knepley }
25196ce16762SMatthew G. Knepley 
25206ce16762SMatthew G. Knepley /*@
25216ce16762SMatthew G. Knepley   PetscDSGetComponentOffset - Returns the offset of the given field on an evaluation point
25226ce16762SMatthew G. Knepley 
25236ce16762SMatthew G. Knepley   Not collective
25246ce16762SMatthew G. Knepley 
25256ce16762SMatthew G. Knepley   Input Parameters:
25266ce16762SMatthew G. Knepley + prob - The PetscDS object
25276ce16762SMatthew G. Knepley - f - The field number
25286ce16762SMatthew G. Knepley 
25296ce16762SMatthew G. Knepley   Output Parameter:
25306ce16762SMatthew G. Knepley . off - The offset
25316ce16762SMatthew G. Knepley 
25326ce16762SMatthew G. Knepley   Level: beginner
25336ce16762SMatthew G. Knepley 
2534f744cafaSSander Arens .seealso: PetscDSGetNumFields(), PetscDSCreate()
25356ce16762SMatthew G. Knepley @*/
25366ce16762SMatthew G. Knepley PetscErrorCode PetscDSGetComponentOffset(PetscDS prob, PetscInt f, PetscInt *off)
25376ce16762SMatthew G. Knepley {
25386ce16762SMatthew G. Knepley   PetscFunctionBegin;
25396ce16762SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
25406ce16762SMatthew G. Knepley   PetscValidPointer(off, 3);
25416ce16762SMatthew 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);
254247e57110SSander Arens   *off = prob->off[f];
25432764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
25442764a2aaSMatthew G. Knepley }
25452764a2aaSMatthew G. Knepley 
2546194d53e6SMatthew G. Knepley /*@
2547194d53e6SMatthew G. Knepley   PetscDSGetComponentOffsets - Returns the offset of each field on an evaluation point
2548194d53e6SMatthew G. Knepley 
2549194d53e6SMatthew G. Knepley   Not collective
2550194d53e6SMatthew G. Knepley 
2551194d53e6SMatthew G. Knepley   Input Parameter:
2552194d53e6SMatthew G. Knepley . prob - The PetscDS object
2553194d53e6SMatthew G. Knepley 
2554194d53e6SMatthew G. Knepley   Output Parameter:
2555194d53e6SMatthew G. Knepley . offsets - The offsets
2556194d53e6SMatthew G. Knepley 
2557194d53e6SMatthew G. Knepley   Level: beginner
2558194d53e6SMatthew G. Knepley 
2559f744cafaSSander Arens .seealso: PetscDSGetNumFields(), PetscDSCreate()
2560194d53e6SMatthew G. Knepley @*/
2561194d53e6SMatthew G. Knepley PetscErrorCode PetscDSGetComponentOffsets(PetscDS prob, PetscInt *offsets[])
2562194d53e6SMatthew G. Knepley {
2563194d53e6SMatthew G. Knepley   PetscFunctionBegin;
2564194d53e6SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2565194d53e6SMatthew G. Knepley   PetscValidPointer(offsets, 2);
2566194d53e6SMatthew G. Knepley   *offsets = prob->off;
2567194d53e6SMatthew G. Knepley   PetscFunctionReturn(0);
2568194d53e6SMatthew G. Knepley }
2569194d53e6SMatthew G. Knepley 
2570194d53e6SMatthew G. Knepley /*@
2571194d53e6SMatthew G. Knepley   PetscDSGetComponentDerivativeOffsets - Returns the offset of each field derivative on an evaluation point
2572194d53e6SMatthew G. Knepley 
2573194d53e6SMatthew G. Knepley   Not collective
2574194d53e6SMatthew G. Knepley 
2575194d53e6SMatthew G. Knepley   Input Parameter:
2576194d53e6SMatthew G. Knepley . prob - The PetscDS object
2577194d53e6SMatthew G. Knepley 
2578194d53e6SMatthew G. Knepley   Output Parameter:
2579194d53e6SMatthew G. Knepley . offsets - The offsets
2580194d53e6SMatthew G. Knepley 
2581194d53e6SMatthew G. Knepley   Level: beginner
2582194d53e6SMatthew G. Knepley 
2583f744cafaSSander Arens .seealso: PetscDSGetNumFields(), PetscDSCreate()
2584194d53e6SMatthew G. Knepley @*/
2585194d53e6SMatthew G. Knepley PetscErrorCode PetscDSGetComponentDerivativeOffsets(PetscDS prob, PetscInt *offsets[])
2586194d53e6SMatthew G. Knepley {
2587194d53e6SMatthew G. Knepley   PetscFunctionBegin;
2588194d53e6SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2589194d53e6SMatthew G. Knepley   PetscValidPointer(offsets, 2);
2590194d53e6SMatthew G. Knepley   *offsets = prob->offDer;
2591194d53e6SMatthew G. Knepley   PetscFunctionReturn(0);
2592194d53e6SMatthew G. Knepley }
2593194d53e6SMatthew G. Knepley 
259468c9edb9SMatthew G. Knepley /*@C
259568c9edb9SMatthew G. Knepley   PetscDSGetTabulation - Return the basis tabulation at quadrature points for the volume discretization
259668c9edb9SMatthew G. Knepley 
259768c9edb9SMatthew G. Knepley   Not collective
259868c9edb9SMatthew G. Knepley 
259968c9edb9SMatthew G. Knepley   Input Parameter:
260068c9edb9SMatthew G. Knepley . prob - The PetscDS object
260168c9edb9SMatthew G. Knepley 
260268c9edb9SMatthew G. Knepley   Output Parameters:
260368c9edb9SMatthew G. Knepley + basis - The basis function tabulation at quadrature points
260468c9edb9SMatthew G. Knepley - basisDer - The basis function derivative tabulation at quadrature points
260568c9edb9SMatthew G. Knepley 
260668c9edb9SMatthew G. Knepley   Level: intermediate
260768c9edb9SMatthew G. Knepley 
2608f744cafaSSander Arens .seealso: PetscDSCreate()
260968c9edb9SMatthew G. Knepley @*/
26102764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetTabulation(PetscDS prob, PetscReal ***basis, PetscReal ***basisDer)
26112764a2aaSMatthew G. Knepley {
26122764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
26132764a2aaSMatthew G. Knepley 
26142764a2aaSMatthew G. Knepley   PetscFunctionBegin;
26152764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
26162764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
26172764a2aaSMatthew G. Knepley   if (basis)    {PetscValidPointer(basis, 2);    *basis    = prob->basis;}
26182764a2aaSMatthew G. Knepley   if (basisDer) {PetscValidPointer(basisDer, 3); *basisDer = prob->basisDer;}
26192764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
26202764a2aaSMatthew G. Knepley }
26212764a2aaSMatthew G. Knepley 
262268c9edb9SMatthew G. Knepley /*@C
26234d0b9603SSander Arens   PetscDSGetFaceTabulation - Return the basis tabulation at quadrature points on the faces
262468c9edb9SMatthew G. Knepley 
262568c9edb9SMatthew G. Knepley   Not collective
262668c9edb9SMatthew G. Knepley 
262768c9edb9SMatthew G. Knepley   Input Parameter:
262868c9edb9SMatthew G. Knepley . prob - The PetscDS object
262968c9edb9SMatthew G. Knepley 
263068c9edb9SMatthew G. Knepley   Output Parameters:
26314d0b9603SSander Arens + basisFace - The basis function tabulation at quadrature points
26324d0b9603SSander Arens - basisDerFace - The basis function derivative tabulation at quadrature points
263368c9edb9SMatthew G. Knepley 
263468c9edb9SMatthew G. Knepley   Level: intermediate
263568c9edb9SMatthew G. Knepley 
263668c9edb9SMatthew G. Knepley .seealso: PetscDSGetTabulation(), PetscDSCreate()
263768c9edb9SMatthew G. Knepley @*/
26384d0b9603SSander Arens PetscErrorCode PetscDSGetFaceTabulation(PetscDS prob, PetscReal ***basis, PetscReal ***basisDer)
26392764a2aaSMatthew G. Knepley {
26402764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
26412764a2aaSMatthew G. Knepley 
26422764a2aaSMatthew G. Knepley   PetscFunctionBegin;
26432764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
26442764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
26454d0b9603SSander Arens   if (basis)    {PetscValidPointer(basis, 2);    *basis    = prob->basisFace;}
26464d0b9603SSander Arens   if (basisDer) {PetscValidPointer(basisDer, 3); *basisDer = prob->basisDerFace;}
26472764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
26482764a2aaSMatthew G. Knepley }
26492764a2aaSMatthew G. Knepley 
26502764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetEvaluationArrays(PetscDS prob, PetscScalar **u, PetscScalar **u_t, PetscScalar **u_x)
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 (u)   {PetscValidPointer(u, 2);   *u   = prob->u;}
26582764a2aaSMatthew G. Knepley   if (u_t) {PetscValidPointer(u_t, 3); *u_t = prob->u_t;}
26592764a2aaSMatthew G. Knepley   if (u_x) {PetscValidPointer(u_x, 4); *u_x = prob->u_x;}
26602764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
26612764a2aaSMatthew G. Knepley }
26622764a2aaSMatthew G. Knepley 
26632764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetWeakFormArrays(PetscDS prob, PetscScalar **f0, PetscScalar **f1, PetscScalar **g0, PetscScalar **g1, PetscScalar **g2, PetscScalar **g3)
26642764a2aaSMatthew G. Knepley {
26652764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
26662764a2aaSMatthew G. Knepley 
26672764a2aaSMatthew G. Knepley   PetscFunctionBegin;
26682764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
26692764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
26702764a2aaSMatthew G. Knepley   if (f0) {PetscValidPointer(f0, 2); *f0 = prob->f0;}
26712764a2aaSMatthew G. Knepley   if (f1) {PetscValidPointer(f1, 3); *f1 = prob->f1;}
26722764a2aaSMatthew G. Knepley   if (g0) {PetscValidPointer(g0, 4); *g0 = prob->g0;}
26732764a2aaSMatthew G. Knepley   if (g1) {PetscValidPointer(g1, 5); *g1 = prob->g1;}
26742764a2aaSMatthew G. Knepley   if (g2) {PetscValidPointer(g2, 6); *g2 = prob->g2;}
26752764a2aaSMatthew G. Knepley   if (g3) {PetscValidPointer(g3, 7); *g3 = prob->g3;}
26762764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
26772764a2aaSMatthew G. Knepley }
26782764a2aaSMatthew G. Knepley 
26792764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetRefCoordArrays(PetscDS prob, PetscReal **x, PetscScalar **refSpaceDer)
26802764a2aaSMatthew G. Knepley {
26812764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
26822764a2aaSMatthew G. Knepley 
26832764a2aaSMatthew G. Knepley   PetscFunctionBegin;
26842764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
26852764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
26862764a2aaSMatthew G. Knepley   if (x)           {PetscValidPointer(x, 2);           *x           = prob->x;}
26872764a2aaSMatthew G. Knepley   if (refSpaceDer) {PetscValidPointer(refSpaceDer, 3); *refSpaceDer = prob->refSpaceDer;}
26882764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
26892764a2aaSMatthew G. Knepley }
26902764a2aaSMatthew G. Knepley 
269158ebd649SToby Isaac /*@C
269258ebd649SToby Isaac   PetscDSAddBoundary - Add a boundary condition to the model
269358ebd649SToby Isaac 
269458ebd649SToby Isaac   Input Parameters:
269558ebd649SToby Isaac + ds          - The PetscDS object
26962d47a189SJulian Andrej . type        - The type of condition, e.g. DM_BC_ESSENTIAL/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann)
269758ebd649SToby Isaac . name        - The BC name
269858ebd649SToby Isaac . labelname   - The label defining constrained points
269958ebd649SToby Isaac . field       - The field to constrain
2700e8ecbf3fSStefano Zampini . numcomps    - The number of constrained field components (0 will constrain all fields)
270158ebd649SToby Isaac . comps       - An array of constrained component numbers
270258ebd649SToby Isaac . bcFunc      - A pointwise function giving boundary values
270358ebd649SToby Isaac . numids      - The number of DMLabel ids for constrained points
270458ebd649SToby Isaac . ids         - An array of ids for constrained points
270558ebd649SToby Isaac - ctx         - An optional user context for bcFunc
270658ebd649SToby Isaac 
270758ebd649SToby Isaac   Options Database Keys:
270858ebd649SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids
270958ebd649SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components
271058ebd649SToby Isaac 
271158ebd649SToby Isaac   Level: developer
271258ebd649SToby Isaac 
271358ebd649SToby Isaac .seealso: PetscDSGetBoundary()
271458ebd649SToby Isaac @*/
2715a30ec4eaSSatish 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)
271658ebd649SToby Isaac {
271758ebd649SToby Isaac   DSBoundary     b;
271858ebd649SToby Isaac   PetscErrorCode ierr;
271958ebd649SToby Isaac 
272058ebd649SToby Isaac   PetscFunctionBegin;
272158ebd649SToby Isaac   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1);
272258ebd649SToby Isaac   ierr = PetscNew(&b);CHKERRQ(ierr);
272358ebd649SToby Isaac   ierr = PetscStrallocpy(name, (char **) &b->name);CHKERRQ(ierr);
272458ebd649SToby Isaac   ierr = PetscStrallocpy(labelname, (char **) &b->labelname);CHKERRQ(ierr);
272558ebd649SToby Isaac   ierr = PetscMalloc1(numcomps, &b->comps);CHKERRQ(ierr);
272658ebd649SToby Isaac   if (numcomps) {ierr = PetscMemcpy(b->comps, comps, numcomps*sizeof(PetscInt));CHKERRQ(ierr);}
272758ebd649SToby Isaac   ierr = PetscMalloc1(numids, &b->ids);CHKERRQ(ierr);
272858ebd649SToby Isaac   if (numids) {ierr = PetscMemcpy(b->ids, ids, numids*sizeof(PetscInt));CHKERRQ(ierr);}
2729f971fd6bSMatthew G. Knepley   b->type            = type;
273058ebd649SToby Isaac   b->field           = field;
273158ebd649SToby Isaac   b->numcomps        = numcomps;
273258ebd649SToby Isaac   b->func            = bcFunc;
273358ebd649SToby Isaac   b->numids          = numids;
273458ebd649SToby Isaac   b->ctx             = ctx;
273558ebd649SToby Isaac   b->next            = ds->boundary;
273658ebd649SToby Isaac   ds->boundary       = b;
273758ebd649SToby Isaac   PetscFunctionReturn(0);
273858ebd649SToby Isaac }
273958ebd649SToby Isaac 
2740b67eacb3SMatthew G. Knepley /*@C
2741b67eacb3SMatthew G. Knepley   PetscDSUpdateBoundary - Change a boundary condition for the model
2742b67eacb3SMatthew G. Knepley 
2743b67eacb3SMatthew G. Knepley   Input Parameters:
2744b67eacb3SMatthew G. Knepley + ds          - The PetscDS object
2745b67eacb3SMatthew G. Knepley . bd          - The boundary condition number
2746b67eacb3SMatthew G. Knepley . type        - The type of condition, e.g. DM_BC_ESSENTIAL/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann)
2747b67eacb3SMatthew G. Knepley . name        - The BC name
2748b67eacb3SMatthew G. Knepley . labelname   - The label defining constrained points
2749b67eacb3SMatthew G. Knepley . field       - The field to constrain
2750b67eacb3SMatthew G. Knepley . numcomps    - The number of constrained field components
2751b67eacb3SMatthew G. Knepley . comps       - An array of constrained component numbers
2752b67eacb3SMatthew G. Knepley . bcFunc      - A pointwise function giving boundary values
2753b67eacb3SMatthew G. Knepley . numids      - The number of DMLabel ids for constrained points
2754b67eacb3SMatthew G. Knepley . ids         - An array of ids for constrained points
2755b67eacb3SMatthew G. Knepley - ctx         - An optional user context for bcFunc
2756b67eacb3SMatthew G. Knepley 
27579a6efb6aSMatthew 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().
27589a6efb6aSMatthew G. Knepley 
2759b67eacb3SMatthew G. Knepley   Level: developer
2760b67eacb3SMatthew G. Knepley 
27619a6efb6aSMatthew G. Knepley .seealso: PetscDSAddBoundary(), PetscDSGetBoundary(), PetscDSGetNumBoundary()
2762b67eacb3SMatthew G. Knepley @*/
2763b67eacb3SMatthew 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)
2764b67eacb3SMatthew G. Knepley {
2765b67eacb3SMatthew G. Knepley   DSBoundary     b = ds->boundary;
2766b67eacb3SMatthew G. Knepley   PetscInt       n = 0;
2767b67eacb3SMatthew G. Knepley   PetscErrorCode ierr;
2768b67eacb3SMatthew G. Knepley 
2769b67eacb3SMatthew G. Knepley   PetscFunctionBegin;
2770b67eacb3SMatthew G. Knepley   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1);
2771b67eacb3SMatthew G. Knepley   while (b) {
2772b67eacb3SMatthew G. Knepley     if (n == bd) break;
2773b67eacb3SMatthew G. Knepley     b = b->next;
2774b67eacb3SMatthew G. Knepley     ++n;
2775b67eacb3SMatthew G. Knepley   }
2776b67eacb3SMatthew G. Knepley   if (!b) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Boundary %d is not in [0, %d)", bd, n);
2777b67eacb3SMatthew G. Knepley   if (name) {
2778b67eacb3SMatthew G. Knepley     ierr = PetscFree(b->name);CHKERRQ(ierr);
2779b67eacb3SMatthew G. Knepley     ierr = PetscStrallocpy(name, (char **) &b->name);CHKERRQ(ierr);
2780b67eacb3SMatthew G. Knepley   }
2781b67eacb3SMatthew G. Knepley   if (labelname) {
2782b67eacb3SMatthew G. Knepley     ierr = PetscFree(b->labelname);CHKERRQ(ierr);
2783b67eacb3SMatthew G. Knepley     ierr = PetscStrallocpy(labelname, (char **) &b->labelname);CHKERRQ(ierr);
2784b67eacb3SMatthew G. Knepley   }
2785b67eacb3SMatthew G. Knepley   if (numcomps >= 0 && numcomps != b->numcomps) {
2786b67eacb3SMatthew G. Knepley     b->numcomps = numcomps;
2787b67eacb3SMatthew G. Knepley     ierr = PetscFree(b->comps);CHKERRQ(ierr);
2788b67eacb3SMatthew G. Knepley     ierr = PetscMalloc1(numcomps, &b->comps);CHKERRQ(ierr);
2789b67eacb3SMatthew G. Knepley     if (numcomps) {ierr = PetscMemcpy(b->comps, comps, numcomps*sizeof(PetscInt));CHKERRQ(ierr);}
2790b67eacb3SMatthew G. Knepley   }
2791b67eacb3SMatthew G. Knepley   if (numids >= 0 && numids != b->numids) {
2792b67eacb3SMatthew G. Knepley     b->numids = numids;
2793b67eacb3SMatthew G. Knepley     ierr = PetscFree(b->ids);CHKERRQ(ierr);
2794b67eacb3SMatthew G. Knepley     ierr = PetscMalloc1(numids, &b->ids);CHKERRQ(ierr);
2795b67eacb3SMatthew G. Knepley     if (numids) {ierr = PetscMemcpy(b->ids, ids, numids*sizeof(PetscInt));CHKERRQ(ierr);}
2796b67eacb3SMatthew G. Knepley   }
2797b67eacb3SMatthew G. Knepley   b->type = type;
2798b67eacb3SMatthew G. Knepley   if (field >= 0) {b->field  = field;}
2799b67eacb3SMatthew G. Knepley   if (bcFunc)     {b->func   = bcFunc;}
2800b67eacb3SMatthew G. Knepley   if (ctx)        {b->ctx    = ctx;}
2801b67eacb3SMatthew G. Knepley   PetscFunctionReturn(0);
2802b67eacb3SMatthew G. Knepley }
2803b67eacb3SMatthew G. Knepley 
280458ebd649SToby Isaac /*@
280558ebd649SToby Isaac   PetscDSGetNumBoundary - Get the number of registered BC
280658ebd649SToby Isaac 
280758ebd649SToby Isaac   Input Parameters:
280858ebd649SToby Isaac . ds - The PetscDS object
280958ebd649SToby Isaac 
281058ebd649SToby Isaac   Output Parameters:
281158ebd649SToby Isaac . numBd - The number of BC
281258ebd649SToby Isaac 
281358ebd649SToby Isaac   Level: intermediate
281458ebd649SToby Isaac 
281558ebd649SToby Isaac .seealso: PetscDSAddBoundary(), PetscDSGetBoundary()
281658ebd649SToby Isaac @*/
281758ebd649SToby Isaac PetscErrorCode PetscDSGetNumBoundary(PetscDS ds, PetscInt *numBd)
281858ebd649SToby Isaac {
281958ebd649SToby Isaac   DSBoundary b = ds->boundary;
282058ebd649SToby Isaac 
282158ebd649SToby Isaac   PetscFunctionBegin;
282258ebd649SToby Isaac   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1);
282358ebd649SToby Isaac   PetscValidPointer(numBd, 2);
282458ebd649SToby Isaac   *numBd = 0;
282558ebd649SToby Isaac   while (b) {++(*numBd); b = b->next;}
282658ebd649SToby Isaac   PetscFunctionReturn(0);
282758ebd649SToby Isaac }
282858ebd649SToby Isaac 
282958ebd649SToby Isaac /*@C
28309a6efb6aSMatthew G. Knepley   PetscDSGetBoundary - Gets a boundary condition to the model
283158ebd649SToby Isaac 
283258ebd649SToby Isaac   Input Parameters:
283358ebd649SToby Isaac + ds          - The PetscDS object
283458ebd649SToby Isaac - bd          - The BC number
283558ebd649SToby Isaac 
283658ebd649SToby Isaac   Output Parameters:
28372d47a189SJulian Andrej + type        - The type of condition, e.g. DM_BC_ESSENTIAL/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann)
283858ebd649SToby Isaac . name        - The BC name
283958ebd649SToby Isaac . labelname   - The label defining constrained points
284058ebd649SToby Isaac . field       - The field to constrain
284158ebd649SToby Isaac . numcomps    - The number of constrained field components
284258ebd649SToby Isaac . comps       - An array of constrained component numbers
284358ebd649SToby Isaac . bcFunc      - A pointwise function giving boundary values
284458ebd649SToby Isaac . numids      - The number of DMLabel ids for constrained points
284558ebd649SToby Isaac . ids         - An array of ids for constrained points
284658ebd649SToby Isaac - ctx         - An optional user context for bcFunc
284758ebd649SToby Isaac 
284858ebd649SToby Isaac   Options Database Keys:
284958ebd649SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids
285058ebd649SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components
285158ebd649SToby Isaac 
285258ebd649SToby Isaac   Level: developer
285358ebd649SToby Isaac 
285458ebd649SToby Isaac .seealso: PetscDSAddBoundary()
285558ebd649SToby Isaac @*/
2856a30ec4eaSSatish 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)
285758ebd649SToby Isaac {
285858ebd649SToby Isaac   DSBoundary b    = ds->boundary;
285958ebd649SToby Isaac   PetscInt   n    = 0;
286058ebd649SToby Isaac 
286158ebd649SToby Isaac   PetscFunctionBegin;
286258ebd649SToby Isaac   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1);
286358ebd649SToby Isaac   while (b) {
286458ebd649SToby Isaac     if (n == bd) break;
286558ebd649SToby Isaac     b = b->next;
286658ebd649SToby Isaac     ++n;
286758ebd649SToby Isaac   }
286858ebd649SToby Isaac   if (!b) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Boundary %d is not in [0, %d)", bd, n);
2869f971fd6bSMatthew G. Knepley   if (type) {
2870f971fd6bSMatthew G. Knepley     PetscValidPointer(type, 3);
2871f971fd6bSMatthew G. Knepley     *type = b->type;
287258ebd649SToby Isaac   }
287358ebd649SToby Isaac   if (name) {
287458ebd649SToby Isaac     PetscValidPointer(name, 4);
287558ebd649SToby Isaac     *name = b->name;
287658ebd649SToby Isaac   }
287758ebd649SToby Isaac   if (labelname) {
287858ebd649SToby Isaac     PetscValidPointer(labelname, 5);
287958ebd649SToby Isaac     *labelname = b->labelname;
288058ebd649SToby Isaac   }
288158ebd649SToby Isaac   if (field) {
288258ebd649SToby Isaac     PetscValidPointer(field, 6);
288358ebd649SToby Isaac     *field = b->field;
288458ebd649SToby Isaac   }
288558ebd649SToby Isaac   if (numcomps) {
288658ebd649SToby Isaac     PetscValidPointer(numcomps, 7);
288758ebd649SToby Isaac     *numcomps = b->numcomps;
288858ebd649SToby Isaac   }
288958ebd649SToby Isaac   if (comps) {
289058ebd649SToby Isaac     PetscValidPointer(comps, 8);
289158ebd649SToby Isaac     *comps = b->comps;
289258ebd649SToby Isaac   }
289358ebd649SToby Isaac   if (func) {
289458ebd649SToby Isaac     PetscValidPointer(func, 9);
289558ebd649SToby Isaac     *func = b->func;
289658ebd649SToby Isaac   }
289758ebd649SToby Isaac   if (numids) {
289858ebd649SToby Isaac     PetscValidPointer(numids, 10);
289958ebd649SToby Isaac     *numids = b->numids;
290058ebd649SToby Isaac   }
290158ebd649SToby Isaac   if (ids) {
290258ebd649SToby Isaac     PetscValidPointer(ids, 11);
290358ebd649SToby Isaac     *ids = b->ids;
290458ebd649SToby Isaac   }
290558ebd649SToby Isaac   if (ctx) {
290658ebd649SToby Isaac     PetscValidPointer(ctx, 12);
290758ebd649SToby Isaac     *ctx = b->ctx;
290858ebd649SToby Isaac   }
290958ebd649SToby Isaac   PetscFunctionReturn(0);
291058ebd649SToby Isaac }
291158ebd649SToby Isaac 
29129252d075SMatthew G. Knepley /*@
29139252d075SMatthew G. Knepley   PetscDSCopyBoundary - Copy all boundary condition objects to the new problem
29149252d075SMatthew G. Knepley 
29159252d075SMatthew G. Knepley   Not collective
29169252d075SMatthew G. Knepley 
29179252d075SMatthew G. Knepley   Input Parameter:
29189252d075SMatthew G. Knepley . prob - The PetscDS object
29199252d075SMatthew G. Knepley 
29209252d075SMatthew G. Knepley   Output Parameter:
29219252d075SMatthew G. Knepley . newprob - The PetscDS copy
29229252d075SMatthew G. Knepley 
29239252d075SMatthew G. Knepley   Level: intermediate
29249252d075SMatthew G. Knepley 
29259252d075SMatthew G. Knepley .seealso: PetscDSCopyEquations(), PetscDSSetResidual(), PetscDSSetJacobian(), PetscDSSetRiemannSolver(), PetscDSSetBdResidual(), PetscDSSetBdJacobian(), PetscDSCreate()
29269252d075SMatthew G. Knepley @*/
2927dff059c6SToby Isaac PetscErrorCode PetscDSCopyBoundary(PetscDS probA, PetscDS probB)
2928dff059c6SToby Isaac {
2929dff059c6SToby Isaac   DSBoundary     b, next, *lastnext;
2930dff059c6SToby Isaac   PetscErrorCode ierr;
2931dff059c6SToby Isaac 
2932dff059c6SToby Isaac   PetscFunctionBegin;
2933dff059c6SToby Isaac   PetscValidHeaderSpecific(probA, PETSCDS_CLASSID, 1);
2934dff059c6SToby Isaac   PetscValidHeaderSpecific(probB, PETSCDS_CLASSID, 2);
2935dff059c6SToby Isaac   if (probA == probB) PetscFunctionReturn(0);
2936dff059c6SToby Isaac   next = probB->boundary;
2937dff059c6SToby Isaac   while (next) {
2938dff059c6SToby Isaac     DSBoundary b = next;
2939dff059c6SToby Isaac 
2940dff059c6SToby Isaac     next = b->next;
2941dff059c6SToby Isaac     ierr = PetscFree(b->comps);CHKERRQ(ierr);
2942dff059c6SToby Isaac     ierr = PetscFree(b->ids);CHKERRQ(ierr);
2943dff059c6SToby Isaac     ierr = PetscFree(b->name);CHKERRQ(ierr);
2944dff059c6SToby Isaac     ierr = PetscFree(b->labelname);CHKERRQ(ierr);
2945dff059c6SToby Isaac     ierr = PetscFree(b);CHKERRQ(ierr);
2946dff059c6SToby Isaac   }
2947dff059c6SToby Isaac   lastnext = &(probB->boundary);
2948dff059c6SToby Isaac   for (b = probA->boundary; b; b = b->next) {
2949dff059c6SToby Isaac     DSBoundary bNew;
2950dff059c6SToby Isaac 
2951459726d8SSatish Balay     ierr = PetscNew(&bNew);CHKERRQ(ierr);
2952dff059c6SToby Isaac     bNew->numcomps = b->numcomps;
2953dff059c6SToby Isaac     ierr = PetscMalloc1(bNew->numcomps, &bNew->comps);CHKERRQ(ierr);
2954dff059c6SToby Isaac     ierr = PetscMemcpy(bNew->comps, b->comps, bNew->numcomps*sizeof(PetscInt));CHKERRQ(ierr);
2955dff059c6SToby Isaac     bNew->numids = b->numids;
2956dff059c6SToby Isaac     ierr = PetscMalloc1(bNew->numids, &bNew->ids);CHKERRQ(ierr);
2957dff059c6SToby Isaac     ierr = PetscMemcpy(bNew->ids, b->ids, bNew->numids*sizeof(PetscInt));CHKERRQ(ierr);
2958dff059c6SToby Isaac     ierr = PetscStrallocpy(b->labelname,(char **) &(bNew->labelname));CHKERRQ(ierr);
2959dff059c6SToby Isaac     ierr = PetscStrallocpy(b->name,(char **) &(bNew->name));CHKERRQ(ierr);
2960dff059c6SToby Isaac     bNew->ctx   = b->ctx;
2961f971fd6bSMatthew G. Knepley     bNew->type  = b->type;
2962dff059c6SToby Isaac     bNew->field = b->field;
2963dff059c6SToby Isaac     bNew->func  = b->func;
2964dff059c6SToby Isaac 
2965dff059c6SToby Isaac     *lastnext = bNew;
2966dff059c6SToby Isaac     lastnext = &(bNew->next);
2967dff059c6SToby Isaac   }
2968dff059c6SToby Isaac   PetscFunctionReturn(0);
2969dff059c6SToby Isaac }
2970dff059c6SToby Isaac 
29719252d075SMatthew G. Knepley /*@C
29729252d075SMatthew G. Knepley   PetscDSSelectEquations - Copy pointwise function pointers to the new problem with different field layout
29739252d075SMatthew G. Knepley 
29749252d075SMatthew G. Knepley   Not collective
29759252d075SMatthew G. Knepley 
29769252d075SMatthew G. Knepley   Input Parameter:
29779252d075SMatthew G. Knepley + prob - The PetscDS object
29789252d075SMatthew G. Knepley . numFields - Number of new fields
29799252d075SMatthew G. Knepley - fields - Old field number for each new field
29809252d075SMatthew G. Knepley 
29819252d075SMatthew G. Knepley   Output Parameter:
29829252d075SMatthew G. Knepley . newprob - The PetscDS copy
29839252d075SMatthew G. Knepley 
29849252d075SMatthew G. Knepley   Level: intermediate
29859252d075SMatthew G. Knepley 
29869252d075SMatthew G. Knepley .seealso: PetscDSCopyBoundary(), PetscDSSetResidual(), PetscDSSetJacobian(), PetscDSSetRiemannSolver(), PetscDSSetBdResidual(), PetscDSSetBdJacobian(), PetscDSCreate()
29879252d075SMatthew G. Knepley @*/
29889252d075SMatthew G. Knepley PetscErrorCode PetscDSSelectEquations(PetscDS prob, PetscInt numFields, const PetscInt fields[], PetscDS newprob)
29899252d075SMatthew G. Knepley {
29909252d075SMatthew G. Knepley   PetscInt       Nf, Nfn, fn, gn;
29919252d075SMatthew G. Knepley   PetscErrorCode ierr;
29929252d075SMatthew G. Knepley 
29939252d075SMatthew G. Knepley   PetscFunctionBegin;
29949252d075SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
29959252d075SMatthew G. Knepley   if (fields) PetscValidPointer(fields, 3);
29969252d075SMatthew G. Knepley   PetscValidHeaderSpecific(newprob, PETSCDS_CLASSID, 4);
29979252d075SMatthew G. Knepley   ierr = PetscDSGetNumFields(prob, &Nf);CHKERRQ(ierr);
29989252d075SMatthew G. Knepley   ierr = PetscDSGetNumFields(newprob, &Nfn);CHKERRQ(ierr);
29999252d075SMatthew 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);
30009252d075SMatthew G. Knepley   for (fn = 0; fn < numFields; ++fn) {
30019252d075SMatthew G. Knepley     const PetscInt   f = fields ? fields[fn] : fn;
30029252d075SMatthew G. Knepley     PetscPointFunc   obj;
30039252d075SMatthew G. Knepley     PetscPointFunc   f0, f1;
30049252d075SMatthew G. Knepley     PetscBdPointFunc f0Bd, f1Bd;
30059252d075SMatthew G. Knepley     PetscRiemannFunc r;
30069252d075SMatthew G. Knepley 
30079252d075SMatthew G. Knepley     if (f >= Nf) SETERRQ2(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_SIZ, "Field %D must be in [0, %D)", f, Nf);
30089252d075SMatthew G. Knepley     ierr = PetscDSGetObjective(prob, f, &obj);CHKERRQ(ierr);
30099252d075SMatthew G. Knepley     ierr = PetscDSGetResidual(prob, f, &f0, &f1);CHKERRQ(ierr);
30109252d075SMatthew G. Knepley     ierr = PetscDSGetBdResidual(prob, f, &f0Bd, &f1Bd);CHKERRQ(ierr);
30119252d075SMatthew G. Knepley     ierr = PetscDSGetRiemannSolver(prob, f, &r);CHKERRQ(ierr);
30129252d075SMatthew G. Knepley     ierr = PetscDSSetObjective(newprob, fn, obj);CHKERRQ(ierr);
30139252d075SMatthew G. Knepley     ierr = PetscDSSetResidual(newprob, fn, f0, f1);CHKERRQ(ierr);
30149252d075SMatthew G. Knepley     ierr = PetscDSSetBdResidual(newprob, fn, f0Bd, f1Bd);CHKERRQ(ierr);
30159252d075SMatthew G. Knepley     ierr = PetscDSSetRiemannSolver(newprob, fn, r);CHKERRQ(ierr);
30169252d075SMatthew G. Knepley     for (gn = 0; gn < numFields; ++gn) {
30179252d075SMatthew G. Knepley       const PetscInt  g = fields ? fields[gn] : gn;
30189252d075SMatthew G. Knepley       PetscPointJac   g0, g1, g2, g3;
30199252d075SMatthew G. Knepley       PetscPointJac   g0p, g1p, g2p, g3p;
30209252d075SMatthew G. Knepley       PetscBdPointJac g0Bd, g1Bd, g2Bd, g3Bd;
30219252d075SMatthew G. Knepley 
30229252d075SMatthew G. Knepley       if (g >= Nf) SETERRQ2(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_SIZ, "Field %D must be in [0, %D)", g, Nf);
30239252d075SMatthew G. Knepley       ierr = PetscDSGetJacobian(prob, f, g, &g0, &g1, &g2, &g3);CHKERRQ(ierr);
30249252d075SMatthew G. Knepley       ierr = PetscDSGetJacobianPreconditioner(prob, f, g, &g0p, &g1p, &g2p, &g3p);CHKERRQ(ierr);
30259252d075SMatthew G. Knepley       ierr = PetscDSGetBdJacobian(prob, f, g, &g0Bd, &g1Bd, &g2Bd, &g3Bd);CHKERRQ(ierr);
30269252d075SMatthew G. Knepley       ierr = PetscDSSetJacobian(newprob, fn, gn, g0, g1, g2, g3);CHKERRQ(ierr);
30279252d075SMatthew G. Knepley       ierr = PetscDSSetJacobianPreconditioner(prob, fn, gn, g0p, g1p, g2p, g3p);CHKERRQ(ierr);
30289252d075SMatthew G. Knepley       ierr = PetscDSSetBdJacobian(newprob, fn, gn, g0Bd, g1Bd, g2Bd, g3Bd);CHKERRQ(ierr);
30299252d075SMatthew G. Knepley     }
30309252d075SMatthew G. Knepley   }
30319252d075SMatthew G. Knepley   PetscFunctionReturn(0);
30329252d075SMatthew G. Knepley }
30339252d075SMatthew G. Knepley 
3034da51fcedSMatthew G. Knepley /*@
3035da51fcedSMatthew G. Knepley   PetscDSCopyEquations - Copy all pointwise function pointers to the new problem
3036da51fcedSMatthew G. Knepley 
3037da51fcedSMatthew G. Knepley   Not collective
3038da51fcedSMatthew G. Knepley 
3039da51fcedSMatthew G. Knepley   Input Parameter:
3040da51fcedSMatthew G. Knepley . prob - The PetscDS object
3041da51fcedSMatthew G. Knepley 
3042da51fcedSMatthew G. Knepley   Output Parameter:
3043da51fcedSMatthew G. Knepley . newprob - The PetscDS copy
3044da51fcedSMatthew G. Knepley 
3045da51fcedSMatthew G. Knepley   Level: intermediate
3046da51fcedSMatthew G. Knepley 
30479252d075SMatthew G. Knepley .seealso: PetscDSCopyBoundary(), PetscDSSetResidual(), PetscDSSetJacobian(), PetscDSSetRiemannSolver(), PetscDSSetBdResidual(), PetscDSSetBdJacobian(), PetscDSCreate()
3048da51fcedSMatthew G. Knepley @*/
3049da51fcedSMatthew G. Knepley PetscErrorCode PetscDSCopyEquations(PetscDS prob, PetscDS newprob)
3050da51fcedSMatthew G. Knepley {
30519252d075SMatthew G. Knepley   PetscInt       Nf, Ng;
3052da51fcedSMatthew G. Knepley   PetscErrorCode ierr;
3053da51fcedSMatthew G. Knepley 
3054da51fcedSMatthew G. Knepley   PetscFunctionBegin;
3055da51fcedSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
3056da51fcedSMatthew G. Knepley   PetscValidHeaderSpecific(newprob, PETSCDS_CLASSID, 2);
3057da51fcedSMatthew G. Knepley   ierr = PetscDSGetNumFields(prob, &Nf);CHKERRQ(ierr);
3058da51fcedSMatthew G. Knepley   ierr = PetscDSGetNumFields(newprob, &Ng);CHKERRQ(ierr);
305913903a91SSatish Balay   if (Nf != Ng) SETERRQ2(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_SIZ, "Number of fields must match %D != %D", Nf, Ng);
30609252d075SMatthew G. Knepley   ierr = PetscDSSelectEquations(prob, Nf, NULL, newprob);CHKERRQ(ierr);
30619252d075SMatthew G. Knepley   PetscFunctionReturn(0);
30629252d075SMatthew G. Knepley }
30639252d075SMatthew G. Knepley /*@
30649252d075SMatthew G. Knepley   PetscDSCopyConstants - Copy all constants to the new problem
3065da51fcedSMatthew G. Knepley 
30669252d075SMatthew G. Knepley   Not collective
30679252d075SMatthew G. Knepley 
30689252d075SMatthew G. Knepley   Input Parameter:
30699252d075SMatthew G. Knepley . prob - The PetscDS object
30709252d075SMatthew G. Knepley 
30719252d075SMatthew G. Knepley   Output Parameter:
30729252d075SMatthew G. Knepley . newprob - The PetscDS copy
30739252d075SMatthew G. Knepley 
30749252d075SMatthew G. Knepley   Level: intermediate
30759252d075SMatthew G. Knepley 
30769252d075SMatthew G. Knepley .seealso: PetscDSCopyBoundary(), PetscDSCopyEquations(), PetscDSSetResidual(), PetscDSSetJacobian(), PetscDSSetRiemannSolver(), PetscDSSetBdResidual(), PetscDSSetBdJacobian(), PetscDSCreate()
30779252d075SMatthew G. Knepley @*/
30789252d075SMatthew G. Knepley PetscErrorCode PetscDSCopyConstants(PetscDS prob, PetscDS newprob)
30799252d075SMatthew G. Knepley {
30809252d075SMatthew G. Knepley   PetscInt           Nc;
30819252d075SMatthew G. Knepley   const PetscScalar *constants;
30829252d075SMatthew G. Knepley   PetscErrorCode     ierr;
30839252d075SMatthew G. Knepley 
30849252d075SMatthew G. Knepley   PetscFunctionBegin;
30859252d075SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
30869252d075SMatthew G. Knepley   PetscValidHeaderSpecific(newprob, PETSCDS_CLASSID, 2);
30879252d075SMatthew G. Knepley   ierr = PetscDSGetConstants(prob, &Nc, &constants);CHKERRQ(ierr);
30889252d075SMatthew G. Knepley   ierr = PetscDSSetConstants(newprob, Nc, (PetscScalar *) constants);CHKERRQ(ierr);
3089da51fcedSMatthew G. Knepley   PetscFunctionReturn(0);
3090da51fcedSMatthew G. Knepley }
3091da51fcedSMatthew G. Knepley 
3092b1353e8eSMatthew G. Knepley PetscErrorCode PetscDSGetHeightSubspace(PetscDS prob, PetscInt height, PetscDS *subprob)
3093b1353e8eSMatthew G. Knepley {
3094df3a45bdSMatthew G. Knepley   PetscInt       dim, Nf, f;
3095b1353e8eSMatthew G. Knepley   PetscErrorCode ierr;
3096b1353e8eSMatthew G. Knepley 
3097b1353e8eSMatthew G. Knepley   PetscFunctionBegin;
3098b1353e8eSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
3099b1353e8eSMatthew G. Knepley   PetscValidPointer(subprob, 3);
3100b1353e8eSMatthew G. Knepley   if (height == 0) {*subprob = prob; PetscFunctionReturn(0);}
3101b1353e8eSMatthew G. Knepley   ierr = PetscDSGetNumFields(prob, &Nf);CHKERRQ(ierr);
3102df3a45bdSMatthew G. Knepley   ierr = PetscDSGetSpatialDimension(prob, &dim);CHKERRQ(ierr);
3103df3a45bdSMatthew 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);
3104df3a45bdSMatthew G. Knepley   if (!prob->subprobs) {ierr = PetscCalloc1(dim, &prob->subprobs);CHKERRQ(ierr);}
3105df3a45bdSMatthew G. Knepley   if (!prob->subprobs[height-1]) {
3106b1353e8eSMatthew G. Knepley     PetscInt cdim;
3107b1353e8eSMatthew G. Knepley 
3108df3a45bdSMatthew G. Knepley     ierr = PetscDSCreate(PetscObjectComm((PetscObject) prob), &prob->subprobs[height-1]);CHKERRQ(ierr);
3109b1353e8eSMatthew G. Knepley     ierr = PetscDSGetCoordinateDimension(prob, &cdim);CHKERRQ(ierr);
3110df3a45bdSMatthew G. Knepley     ierr = PetscDSSetCoordinateDimension(prob->subprobs[height-1], cdim);CHKERRQ(ierr);
3111b1353e8eSMatthew G. Knepley     for (f = 0; f < Nf; ++f) {
3112b1353e8eSMatthew G. Knepley       PetscFE      subfe;
3113b1353e8eSMatthew G. Knepley       PetscObject  obj;
3114b1353e8eSMatthew G. Knepley       PetscClassId id;
3115b1353e8eSMatthew G. Knepley 
3116b1353e8eSMatthew G. Knepley       ierr = PetscDSGetDiscretization(prob, f, &obj);CHKERRQ(ierr);
3117b1353e8eSMatthew G. Knepley       ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr);
3118b1353e8eSMatthew G. Knepley       if (id == PETSCFE_CLASSID) {ierr = PetscFEGetHeightSubspace((PetscFE) obj, height, &subfe);CHKERRQ(ierr);}
3119b1353e8eSMatthew G. Knepley       else SETERRQ1(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Unsupported discretization type for field %d", f);
3120df3a45bdSMatthew G. Knepley       ierr = PetscDSSetDiscretization(prob->subprobs[height-1], f, (PetscObject) subfe);CHKERRQ(ierr);
3121b1353e8eSMatthew G. Knepley     }
3122b1353e8eSMatthew G. Knepley   }
3123df3a45bdSMatthew G. Knepley   *subprob = prob->subprobs[height-1];
3124b1353e8eSMatthew G. Knepley   PetscFunctionReturn(0);
3125b1353e8eSMatthew G. Knepley }
3126b1353e8eSMatthew G. Knepley 
3127bc4ae4beSMatthew G. Knepley static PetscErrorCode PetscDSDestroy_Basic(PetscDS prob)
31282764a2aaSMatthew G. Knepley {
3129931fb3b8SToby Isaac   PetscErrorCode      ierr;
3130931fb3b8SToby Isaac 
31312764a2aaSMatthew G. Knepley   PetscFunctionBegin;
3132931fb3b8SToby Isaac   ierr = PetscFree(prob->data);CHKERRQ(ierr);
31332764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
31342764a2aaSMatthew G. Knepley }
31352764a2aaSMatthew G. Knepley 
3136bc4ae4beSMatthew G. Knepley static PetscErrorCode PetscDSInitialize_Basic(PetscDS prob)
31372764a2aaSMatthew G. Knepley {
31382764a2aaSMatthew G. Knepley   PetscFunctionBegin;
31392764a2aaSMatthew G. Knepley   prob->ops->setfromoptions = NULL;
31402764a2aaSMatthew G. Knepley   prob->ops->setup          = NULL;
31412764a2aaSMatthew G. Knepley   prob->ops->view           = NULL;
31422764a2aaSMatthew G. Knepley   prob->ops->destroy        = PetscDSDestroy_Basic;
31432764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
31442764a2aaSMatthew G. Knepley }
31452764a2aaSMatthew G. Knepley 
31462764a2aaSMatthew G. Knepley /*MC
31472764a2aaSMatthew G. Knepley   PETSCDSBASIC = "basic" - A discrete system with pointwise residual and boundary residual functions
31482764a2aaSMatthew G. Knepley 
31492764a2aaSMatthew G. Knepley   Level: intermediate
31502764a2aaSMatthew G. Knepley 
31512764a2aaSMatthew G. Knepley .seealso: PetscDSType, PetscDSCreate(), PetscDSSetType()
31522764a2aaSMatthew G. Knepley M*/
31532764a2aaSMatthew G. Knepley 
31542764a2aaSMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscDSCreate_Basic(PetscDS prob)
31552764a2aaSMatthew G. Knepley {
31562764a2aaSMatthew G. Knepley   PetscDS_Basic *b;
31572764a2aaSMatthew G. Knepley   PetscErrorCode      ierr;
31582764a2aaSMatthew G. Knepley 
31592764a2aaSMatthew G. Knepley   PetscFunctionBegin;
3160931fb3b8SToby Isaac   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
31612764a2aaSMatthew G. Knepley   ierr       = PetscNewLog(prob, &b);CHKERRQ(ierr);
31622764a2aaSMatthew G. Knepley   prob->data = b;
31632764a2aaSMatthew G. Knepley 
31642764a2aaSMatthew G. Knepley   ierr = PetscDSInitialize_Basic(prob);CHKERRQ(ierr);
31652764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
31662764a2aaSMatthew G. Knepley }
3167