xref: /petsc/src/dm/dt/interface/dtds.c (revision f5f57ec0aaa1e5be6a6f3c2ef714a1a38ff0b64a)
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 
37*f5f57ec0SBarry Smith    Not available from Fortran
38*f5f57ec0SBarry 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 
66*f5f57ec0SBarry Smith    Not available from Fortran
67*f5f57ec0SBarry 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 
108*f5f57ec0SBarry Smith    Not available from Fortran
109*f5f57ec0SBarry 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);
1367d8a60eaSMatthew G. Knepley   for (f = 0; f < prob->Nf; ++f) {
1377d8a60eaSMatthew G. Knepley     PetscObject  obj;
1387d8a60eaSMatthew G. Knepley     PetscClassId id;
1397d8a60eaSMatthew G. Knepley     const char  *name;
1407d8a60eaSMatthew G. Knepley     PetscInt     Nc;
1417d8a60eaSMatthew G. Knepley 
1427d8a60eaSMatthew G. Knepley     ierr = PetscDSGetDiscretization(prob, f, &obj);CHKERRQ(ierr);
1437d8a60eaSMatthew G. Knepley     ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr);
1447d8a60eaSMatthew G. Knepley     ierr = PetscObjectGetName(obj, &name);CHKERRQ(ierr);
1457d8a60eaSMatthew G. Knepley     ierr = PetscViewerASCIIPrintf(viewer, "Field %s", name ? name : "<unknown>");CHKERRQ(ierr);
1467d8a60eaSMatthew G. Knepley     if (id == PETSCFE_CLASSID)      {
1477d8a60eaSMatthew G. Knepley       ierr = PetscFEGetNumComponents((PetscFE) obj, &Nc);CHKERRQ(ierr);
1487d8a60eaSMatthew G. Knepley       ierr = PetscViewerASCIIPrintf(viewer, " FEM");CHKERRQ(ierr);
1497d8a60eaSMatthew G. Knepley     } else if (id == PETSCFV_CLASSID) {
1507d8a60eaSMatthew G. Knepley       ierr = PetscFVGetNumComponents((PetscFV) obj, &Nc);CHKERRQ(ierr);
1517d8a60eaSMatthew G. Knepley       ierr = PetscViewerASCIIPrintf(viewer, " FVM");CHKERRQ(ierr);
1527d8a60eaSMatthew G. Knepley     }
15397b6e6e8SMatthew G. Knepley     else SETERRQ1(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Unknown discretization type for field %D", f);
15497b6e6e8SMatthew G. Knepley     if (Nc > 1) {ierr = PetscViewerASCIIPrintf(viewer, "%D components", Nc);CHKERRQ(ierr);}
15597b6e6e8SMatthew G. Knepley     else        {ierr = PetscViewerASCIIPrintf(viewer, "%D component ", Nc);CHKERRQ(ierr);}
156249df284SMatthew G. Knepley     if (prob->implicit[f]) {ierr = PetscViewerASCIIPrintf(viewer, " (implicit)");CHKERRQ(ierr);}
157249df284SMatthew G. Knepley     else                   {ierr = PetscViewerASCIIPrintf(viewer, " (explicit)");CHKERRQ(ierr);}
158a6cbbb48SMatthew G. Knepley     if (prob->adjacency[f*2+0]) {
159a6cbbb48SMatthew G. Knepley       if (prob->adjacency[f*2+1]) {ierr = PetscViewerASCIIPrintf(viewer, " (adj FVM++)");CHKERRQ(ierr);}
160a6cbbb48SMatthew G. Knepley       else                        {ierr = PetscViewerASCIIPrintf(viewer, " (adj FVM)");CHKERRQ(ierr);}
161a6cbbb48SMatthew G. Knepley     } else {
162a6cbbb48SMatthew G. Knepley       if (prob->adjacency[f*2+1]) {ierr = PetscViewerASCIIPrintf(viewer, " (adj FEM)");CHKERRQ(ierr);}
163a6cbbb48SMatthew G. Knepley       else                        {ierr = PetscViewerASCIIPrintf(viewer, " (adj FUNKY)");CHKERRQ(ierr);}
164a6cbbb48SMatthew G. Knepley     }
1657d8a60eaSMatthew G. Knepley     ierr = PetscViewerASCIIPrintf(viewer, "\n");CHKERRQ(ierr);
1667d8a60eaSMatthew G. Knepley     if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
1677d8a60eaSMatthew G. Knepley       if (id == PETSCFE_CLASSID)      {ierr = PetscFEView((PetscFE) obj, viewer);CHKERRQ(ierr);}
1687d8a60eaSMatthew G. Knepley       else if (id == PETSCFV_CLASSID) {ierr = PetscFVView((PetscFV) obj, viewer);CHKERRQ(ierr);}
1697d8a60eaSMatthew G. Knepley     }
1707d8a60eaSMatthew G. Knepley   }
17197b6e6e8SMatthew G. Knepley   ierr = PetscDSGetConstants(prob, &numConstants, &constants);CHKERRQ(ierr);
17297b6e6e8SMatthew G. Knepley   if (numConstants) {
17397b6e6e8SMatthew G. Knepley     ierr = PetscViewerASCIIPrintf(viewer, "%D constants\n", numConstants);CHKERRQ(ierr);
17497b6e6e8SMatthew G. Knepley     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
17557fc01e9SMatthew G. Knepley     for (f = 0; f < numConstants; ++f) {ierr = PetscViewerASCIIPrintf(viewer, "%g\n", (double) PetscRealPart(constants[f]));CHKERRQ(ierr);}
17697b6e6e8SMatthew G. Knepley     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
17797b6e6e8SMatthew G. Knepley   }
1787d8a60eaSMatthew G. Knepley   ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1797d8a60eaSMatthew G. Knepley   PetscFunctionReturn(0);
1807d8a60eaSMatthew G. Knepley }
1817d8a60eaSMatthew G. Knepley 
1822764a2aaSMatthew G. Knepley /*@C
1832764a2aaSMatthew G. Knepley   PetscDSView - Views a PetscDS
1842764a2aaSMatthew G. Knepley 
1852764a2aaSMatthew G. Knepley   Collective on PetscDS
1862764a2aaSMatthew G. Knepley 
1872764a2aaSMatthew G. Knepley   Input Parameter:
1882764a2aaSMatthew G. Knepley + prob - the PetscDS object to view
1892764a2aaSMatthew G. Knepley - v  - the viewer
1902764a2aaSMatthew G. Knepley 
1912764a2aaSMatthew G. Knepley   Level: developer
1922764a2aaSMatthew G. Knepley 
1932764a2aaSMatthew G. Knepley .seealso PetscDSDestroy()
1942764a2aaSMatthew G. Knepley @*/
1952764a2aaSMatthew G. Knepley PetscErrorCode PetscDSView(PetscDS prob, PetscViewer v)
1962764a2aaSMatthew G. Knepley {
1977d8a60eaSMatthew G. Knepley   PetscBool      iascii;
1982764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
1992764a2aaSMatthew G. Knepley 
2002764a2aaSMatthew G. Knepley   PetscFunctionBegin;
2012764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2022764a2aaSMatthew G. Knepley   if (!v) {ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject) prob), &v);CHKERRQ(ierr);}
2037d8a60eaSMatthew G. Knepley   else    {PetscValidHeaderSpecific(v, PETSC_VIEWER_CLASSID, 2);}
2047d8a60eaSMatthew G. Knepley   ierr = PetscObjectTypeCompare((PetscObject) v, PETSCVIEWERASCII, &iascii);CHKERRQ(ierr);
2057d8a60eaSMatthew G. Knepley   if (iascii) {ierr = PetscDSView_Ascii(prob, v);CHKERRQ(ierr);}
2062764a2aaSMatthew G. Knepley   if (prob->ops->view) {ierr = (*prob->ops->view)(prob, v);CHKERRQ(ierr);}
2072764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
2082764a2aaSMatthew G. Knepley }
2092764a2aaSMatthew G. Knepley 
2102764a2aaSMatthew G. Knepley /*@
2112764a2aaSMatthew G. Knepley   PetscDSSetFromOptions - sets parameters in a PetscDS from the options database
2122764a2aaSMatthew G. Knepley 
2132764a2aaSMatthew G. Knepley   Collective on PetscDS
2142764a2aaSMatthew G. Knepley 
2152764a2aaSMatthew G. Knepley   Input Parameter:
2162764a2aaSMatthew G. Knepley . prob - the PetscDS object to set options for
2172764a2aaSMatthew G. Knepley 
2182764a2aaSMatthew G. Knepley   Options Database:
2192764a2aaSMatthew G. Knepley 
2202764a2aaSMatthew G. Knepley   Level: developer
2212764a2aaSMatthew G. Knepley 
2222764a2aaSMatthew G. Knepley .seealso PetscDSView()
2232764a2aaSMatthew G. Knepley @*/
2242764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetFromOptions(PetscDS prob)
2252764a2aaSMatthew G. Knepley {
226f1fd5e65SToby Isaac   DSBoundary     b;
2272764a2aaSMatthew G. Knepley   const char    *defaultType;
2282764a2aaSMatthew G. Knepley   char           name[256];
2292764a2aaSMatthew G. Knepley   PetscBool      flg;
2302764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
2312764a2aaSMatthew G. Knepley 
2322764a2aaSMatthew G. Knepley   PetscFunctionBegin;
2332764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2342764a2aaSMatthew G. Knepley   if (!((PetscObject) prob)->type_name) {
2352764a2aaSMatthew G. Knepley     defaultType = PETSCDSBASIC;
2362764a2aaSMatthew G. Knepley   } else {
2372764a2aaSMatthew G. Knepley     defaultType = ((PetscObject) prob)->type_name;
2382764a2aaSMatthew G. Knepley   }
2390f51fdf8SToby Isaac   ierr = PetscDSRegisterAll();CHKERRQ(ierr);
2402764a2aaSMatthew G. Knepley 
2412764a2aaSMatthew G. Knepley   ierr = PetscObjectOptionsBegin((PetscObject) prob);CHKERRQ(ierr);
242f1fd5e65SToby Isaac   for (b = prob->boundary; b; b = b->next) {
243f1fd5e65SToby Isaac     char       optname[1024];
244f1fd5e65SToby Isaac     PetscInt   ids[1024], len = 1024;
245f1fd5e65SToby Isaac     PetscBool  flg;
246f1fd5e65SToby Isaac 
247f1fd5e65SToby Isaac     ierr = PetscSNPrintf(optname, sizeof(optname), "-bc_%s", b->name);CHKERRQ(ierr);
248f1fd5e65SToby Isaac     ierr = PetscMemzero(ids, sizeof(ids));CHKERRQ(ierr);
249f1fd5e65SToby Isaac     ierr = PetscOptionsIntArray(optname, "List of boundary IDs", "", ids, &len, &flg);CHKERRQ(ierr);
250f1fd5e65SToby Isaac     if (flg) {
251f1fd5e65SToby Isaac       b->numids = len;
252f1fd5e65SToby Isaac       ierr = PetscFree(b->ids);CHKERRQ(ierr);
253f1fd5e65SToby Isaac       ierr = PetscMalloc1(len, &b->ids);CHKERRQ(ierr);
254f1fd5e65SToby Isaac       ierr = PetscMemcpy(b->ids, ids, len*sizeof(PetscInt));CHKERRQ(ierr);
255f1fd5e65SToby Isaac     }
256e7b0402cSSander Arens     len = 1024;
257f1fd5e65SToby Isaac     ierr = PetscSNPrintf(optname, sizeof(optname), "-bc_%s_comp", b->name);CHKERRQ(ierr);
258f1fd5e65SToby Isaac     ierr = PetscMemzero(ids, sizeof(ids));CHKERRQ(ierr);
259f1fd5e65SToby Isaac     ierr = PetscOptionsIntArray(optname, "List of boundary field components", "", ids, &len, &flg);CHKERRQ(ierr);
260f1fd5e65SToby Isaac     if (flg) {
261f1fd5e65SToby Isaac       b->numcomps = len;
262f1fd5e65SToby Isaac       ierr = PetscFree(b->comps);CHKERRQ(ierr);
263f1fd5e65SToby Isaac       ierr = PetscMalloc1(len, &b->comps);CHKERRQ(ierr);
264f1fd5e65SToby Isaac       ierr = PetscMemcpy(b->comps, ids, len*sizeof(PetscInt));CHKERRQ(ierr);
265f1fd5e65SToby Isaac     }
266f1fd5e65SToby Isaac   }
2672764a2aaSMatthew G. Knepley   ierr = PetscOptionsFList("-petscds_type", "Discrete System", "PetscDSSetType", PetscDSList, defaultType, name, 256, &flg);CHKERRQ(ierr);
2682764a2aaSMatthew G. Knepley   if (flg) {
2692764a2aaSMatthew G. Knepley     ierr = PetscDSSetType(prob, name);CHKERRQ(ierr);
2702764a2aaSMatthew G. Knepley   } else if (!((PetscObject) prob)->type_name) {
2712764a2aaSMatthew G. Knepley     ierr = PetscDSSetType(prob, defaultType);CHKERRQ(ierr);
2722764a2aaSMatthew G. Knepley   }
2732764a2aaSMatthew G. Knepley   if (prob->ops->setfromoptions) {ierr = (*prob->ops->setfromoptions)(prob);CHKERRQ(ierr);}
2742764a2aaSMatthew G. Knepley   /* process any options handlers added with PetscObjectAddOptionsHandler() */
2750633abcbSJed Brown   ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject) prob);CHKERRQ(ierr);
2762764a2aaSMatthew G. Knepley   ierr = PetscOptionsEnd();CHKERRQ(ierr);
2772764a2aaSMatthew G. Knepley   ierr = PetscDSViewFromOptions(prob, NULL, "-petscds_view");CHKERRQ(ierr);
2782764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
2792764a2aaSMatthew G. Knepley }
2802764a2aaSMatthew G. Knepley 
2812764a2aaSMatthew G. Knepley /*@C
2822764a2aaSMatthew G. Knepley   PetscDSSetUp - Construct data structures for the PetscDS
2832764a2aaSMatthew G. Knepley 
2842764a2aaSMatthew G. Knepley   Collective on PetscDS
2852764a2aaSMatthew G. Knepley 
2862764a2aaSMatthew G. Knepley   Input Parameter:
2872764a2aaSMatthew G. Knepley . prob - the PetscDS object to setup
2882764a2aaSMatthew G. Knepley 
2892764a2aaSMatthew G. Knepley   Level: developer
2902764a2aaSMatthew G. Knepley 
2912764a2aaSMatthew G. Knepley .seealso PetscDSView(), PetscDSDestroy()
2922764a2aaSMatthew G. Knepley @*/
2932764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetUp(PetscDS prob)
2942764a2aaSMatthew G. Knepley {
2952764a2aaSMatthew G. Knepley   const PetscInt Nf = prob->Nf;
296d1506c7cSMatthew G. Knepley   PetscInt       dim, dimEmbed, work, NcMax = 0, NqMax = 0, f;
2972764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
2982764a2aaSMatthew G. Knepley 
2992764a2aaSMatthew G. Knepley   PetscFunctionBegin;
3002764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
3012764a2aaSMatthew G. Knepley   if (prob->setup) PetscFunctionReturn(0);
3022764a2aaSMatthew G. Knepley   /* Calculate sizes */
3032764a2aaSMatthew G. Knepley   ierr = PetscDSGetSpatialDimension(prob, &dim);CHKERRQ(ierr);
304d1506c7cSMatthew G. Knepley   ierr = PetscDSGetCoordinateDimension(prob, &dimEmbed);CHKERRQ(ierr);
305f744cafaSSander Arens   prob->totDim = prob->totComp = 0;
30647e57110SSander Arens   ierr = PetscMalloc2(Nf,&prob->Nc,Nf,&prob->Nb);CHKERRQ(ierr);
307f744cafaSSander Arens   ierr = PetscCalloc2(Nf+1,&prob->off,Nf+1,&prob->offDer);CHKERRQ(ierr);
308f744cafaSSander Arens   ierr = PetscMalloc4(Nf,&prob->basis,Nf,&prob->basisDer,Nf,&prob->basisFace,Nf,&prob->basisDerFace);CHKERRQ(ierr);
3092764a2aaSMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
3109de99aefSMatthew G. Knepley     PetscObject     obj;
3119de99aefSMatthew G. Knepley     PetscClassId    id;
3122764a2aaSMatthew G. Knepley     PetscQuadrature q;
3139de99aefSMatthew G. Knepley     PetscInt        Nq = 0, Nb, Nc;
3142764a2aaSMatthew G. Knepley 
3159de99aefSMatthew G. Knepley     ierr = PetscDSGetDiscretization(prob, f, &obj);CHKERRQ(ierr);
3169de99aefSMatthew G. Knepley     ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr);
3179de99aefSMatthew G. Knepley     if (id == PETSCFE_CLASSID)      {
3189de99aefSMatthew G. Knepley       PetscFE fe = (PetscFE) obj;
3199de99aefSMatthew G. Knepley 
3202764a2aaSMatthew G. Knepley       ierr = PetscFEGetQuadrature(fe, &q);CHKERRQ(ierr);
3212764a2aaSMatthew G. Knepley       ierr = PetscFEGetDimension(fe, &Nb);CHKERRQ(ierr);
3222764a2aaSMatthew G. Knepley       ierr = PetscFEGetNumComponents(fe, &Nc);CHKERRQ(ierr);
3232764a2aaSMatthew G. Knepley       ierr = PetscFEGetDefaultTabulation(fe, &prob->basis[f], &prob->basisDer[f], NULL);CHKERRQ(ierr);
3244d0b9603SSander Arens       ierr = PetscFEGetFaceTabulation(fe, &prob->basisFace[f], &prob->basisDerFace[f], NULL);CHKERRQ(ierr);
3259de99aefSMatthew G. Knepley     } else if (id == PETSCFV_CLASSID) {
3269de99aefSMatthew G. Knepley       PetscFV fv = (PetscFV) obj;
3279de99aefSMatthew G. Knepley 
3289de99aefSMatthew G. Knepley       ierr = PetscFVGetQuadrature(fv, &q);CHKERRQ(ierr);
3299de99aefSMatthew G. Knepley       ierr = PetscFVGetNumComponents(fv, &Nc);CHKERRQ(ierr);
3309c3cf19fSMatthew G. Knepley       Nb   = Nc;
3316c1a3d01SMatthew G. Knepley       ierr = PetscFVGetDefaultTabulation(fv, &prob->basis[f], &prob->basisDer[f], NULL);CHKERRQ(ierr);
3324d0b9603SSander Arens       /* TODO: should PetscFV also have face tabulation? Otherwise there will be a null pointer in prob->basisFace */
333abac5ca0SMatthew G. Knepley     } else SETERRQ1(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Unknown discretization type for field %d", f);
33447e57110SSander Arens     prob->Nc[f]       = Nc;
33547e57110SSander Arens     prob->Nb[f]       = Nb;
336194d53e6SMatthew G. Knepley     prob->off[f+1]    = Nc     + prob->off[f];
337194d53e6SMatthew G. Knepley     prob->offDer[f+1] = Nc*dim + prob->offDer[f];
338a6b92713SMatthew G. Knepley     if (q) {ierr = PetscQuadratureGetData(q, NULL, NULL, &Nq, NULL, NULL);CHKERRQ(ierr);}
3392764a2aaSMatthew G. Knepley     NqMax          = PetscMax(NqMax, Nq);
3402764a2aaSMatthew G. Knepley     NcMax          = PetscMax(NcMax, Nc);
3419c3cf19fSMatthew G. Knepley     prob->totDim  += Nb;
3422764a2aaSMatthew G. Knepley     prob->totComp += Nc;
3432764a2aaSMatthew G. Knepley   }
3442764a2aaSMatthew G. Knepley   work = PetscMax(prob->totComp*dim, PetscSqr(NcMax*dim));
3452764a2aaSMatthew G. Knepley   /* Allocate works space */
346d1506c7cSMatthew G. Knepley   ierr = PetscMalloc5(prob->totComp,&prob->u,prob->totComp,&prob->u_t,prob->totComp*dim,&prob->u_x,dimEmbed,&prob->x,work,&prob->refSpaceDer);CHKERRQ(ierr);
3472764a2aaSMatthew G. Knepley   ierr = PetscMalloc6(NqMax*NcMax,&prob->f0,NqMax*NcMax*dim,&prob->f1,NqMax*NcMax*NcMax,&prob->g0,NqMax*NcMax*NcMax*dim,&prob->g1,NqMax*NcMax*NcMax*dim,&prob->g2,NqMax*NcMax*NcMax*dim*dim,&prob->g3);CHKERRQ(ierr);
3482764a2aaSMatthew G. Knepley   if (prob->ops->setup) {ierr = (*prob->ops->setup)(prob);CHKERRQ(ierr);}
3492764a2aaSMatthew G. Knepley   prob->setup = PETSC_TRUE;
3502764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
3512764a2aaSMatthew G. Knepley }
3522764a2aaSMatthew G. Knepley 
3532764a2aaSMatthew G. Knepley static PetscErrorCode PetscDSDestroyStructs_Static(PetscDS prob)
3542764a2aaSMatthew G. Knepley {
3552764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
3562764a2aaSMatthew G. Knepley 
3572764a2aaSMatthew G. Knepley   PetscFunctionBegin;
35847e57110SSander Arens   ierr = PetscFree2(prob->Nc,prob->Nb);CHKERRQ(ierr);
359f744cafaSSander Arens   ierr = PetscFree2(prob->off,prob->offDer);CHKERRQ(ierr);
360f744cafaSSander Arens   ierr = PetscFree4(prob->basis,prob->basisDer,prob->basisFace,prob->basisDerFace);CHKERRQ(ierr);
3612764a2aaSMatthew G. Knepley   ierr = PetscFree5(prob->u,prob->u_t,prob->u_x,prob->x,prob->refSpaceDer);CHKERRQ(ierr);
3622764a2aaSMatthew G. Knepley   ierr = PetscFree6(prob->f0,prob->f1,prob->g0,prob->g1,prob->g2,prob->g3);CHKERRQ(ierr);
3632764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
3642764a2aaSMatthew G. Knepley }
3652764a2aaSMatthew G. Knepley 
3662764a2aaSMatthew G. Knepley static PetscErrorCode PetscDSEnlarge_Static(PetscDS prob, PetscInt NfNew)
3672764a2aaSMatthew G. Knepley {
368f744cafaSSander Arens   PetscObject      *tmpd;
369a6cbbb48SMatthew G. Knepley   PetscBool        *tmpi, *tmpa;
37032d2bbc9SMatthew G. Knepley   PetscPointFunc   *tmpobj, *tmpf, *tmpup;
371b7e05686SMatthew G. Knepley   PetscPointJac    *tmpg, *tmpgp, *tmpgt;
3722aa1fc23SMatthew G. Knepley   PetscBdPointFunc *tmpfbd;
3732aa1fc23SMatthew G. Knepley   PetscBdPointJac  *tmpgbd;
374194d53e6SMatthew G. Knepley   PetscRiemannFunc *tmpr;
375c371a6d1SMatthew G. Knepley   PetscSimplePointFunc *tmpexactSol;
3760c2f2876SMatthew G. Knepley   void            **tmpctx;
377a6cbbb48SMatthew G. Knepley   PetscInt          Nf = prob->Nf, f, i;
3782764a2aaSMatthew G. Knepley   PetscErrorCode    ierr;
3792764a2aaSMatthew G. Knepley 
3802764a2aaSMatthew G. Knepley   PetscFunctionBegin;
3812764a2aaSMatthew G. Knepley   if (Nf >= NfNew) PetscFunctionReturn(0);
3822764a2aaSMatthew G. Knepley   prob->setup = PETSC_FALSE;
3832764a2aaSMatthew G. Knepley   ierr = PetscDSDestroyStructs_Static(prob);CHKERRQ(ierr);
384f744cafaSSander Arens   ierr = PetscMalloc3(NfNew, &tmpd, NfNew, &tmpi, NfNew*2, &tmpa);CHKERRQ(ierr);
385f744cafaSSander 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];}
386f744cafaSSander 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;}
387f744cafaSSander Arens   ierr = PetscFree3(prob->disc, prob->implicit, prob->adjacency);CHKERRQ(ierr);
3882764a2aaSMatthew G. Knepley   prob->Nf        = NfNew;
3892764a2aaSMatthew G. Knepley   prob->disc      = tmpd;
390249df284SMatthew G. Knepley   prob->implicit  = tmpi;
391a6cbbb48SMatthew G. Knepley   prob->adjacency = tmpa;
392b7e05686SMatthew 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);
39332d2bbc9SMatthew G. Knepley   ierr = PetscCalloc1(NfNew, &tmpup);CHKERRQ(ierr);
3942764a2aaSMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpobj[f] = prob->obj[f];
3952764a2aaSMatthew G. Knepley   for (f = 0; f < Nf*2; ++f) tmpf[f] = prob->f[f];
3962764a2aaSMatthew G. Knepley   for (f = 0; f < Nf*Nf*4; ++f) tmpg[f] = prob->g[f];
397475e0ac9SMatthew G. Knepley   for (f = 0; f < Nf*Nf*4; ++f) tmpgp[f] = prob->gp[f];
3980c2f2876SMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpr[f] = prob->r[f];
39932d2bbc9SMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpup[f] = prob->update[f];
4000c2f2876SMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpctx[f] = prob->ctx[f];
4012764a2aaSMatthew G. Knepley   for (f = Nf; f < NfNew; ++f) tmpobj[f] = NULL;
4022764a2aaSMatthew G. Knepley   for (f = Nf*2; f < NfNew*2; ++f) tmpf[f] = NULL;
4032764a2aaSMatthew G. Knepley   for (f = Nf*Nf*4; f < NfNew*NfNew*4; ++f) tmpg[f] = NULL;
404475e0ac9SMatthew G. Knepley   for (f = Nf*Nf*4; f < NfNew*NfNew*4; ++f) tmpgp[f] = NULL;
405b7e05686SMatthew G. Knepley   for (f = Nf*Nf*4; f < NfNew*NfNew*4; ++f) tmpgt[f] = NULL;
4060c2f2876SMatthew G. Knepley   for (f = Nf; f < NfNew; ++f) tmpr[f] = NULL;
40732d2bbc9SMatthew G. Knepley   for (f = Nf; f < NfNew; ++f) tmpup[f] = NULL;
4080c2f2876SMatthew G. Knepley   for (f = Nf; f < NfNew; ++f) tmpctx[f] = NULL;
409b7e05686SMatthew G. Knepley   ierr = PetscFree7(prob->obj, prob->f, prob->g, prob->gp, prob->gt, prob->r, prob->ctx);CHKERRQ(ierr);
41032d2bbc9SMatthew G. Knepley   ierr = PetscFree(prob->update);CHKERRQ(ierr);
4112764a2aaSMatthew G. Knepley   prob->obj = tmpobj;
4122764a2aaSMatthew G. Knepley   prob->f   = tmpf;
4132764a2aaSMatthew G. Knepley   prob->g   = tmpg;
414475e0ac9SMatthew G. Knepley   prob->gp  = tmpgp;
415b7e05686SMatthew G. Knepley   prob->gt  = tmpgt;
4160c2f2876SMatthew G. Knepley   prob->r   = tmpr;
41732d2bbc9SMatthew G. Knepley   prob->update = tmpup;
4180c2f2876SMatthew G. Knepley   prob->ctx = tmpctx;
419c371a6d1SMatthew G. Knepley   ierr = PetscCalloc3(NfNew*2, &tmpfbd, NfNew*NfNew*4, &tmpgbd, NfNew, &tmpexactSol);CHKERRQ(ierr);
4202764a2aaSMatthew G. Knepley   for (f = 0; f < Nf*2; ++f) tmpfbd[f] = prob->fBd[f];
4212764a2aaSMatthew G. Knepley   for (f = 0; f < Nf*Nf*4; ++f) tmpgbd[f] = prob->gBd[f];
422c371a6d1SMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpexactSol[f] = prob->exactSol[f];
4232764a2aaSMatthew G. Knepley   for (f = Nf*2; f < NfNew*2; ++f) tmpfbd[f] = NULL;
4242764a2aaSMatthew G. Knepley   for (f = Nf*Nf*4; f < NfNew*NfNew*4; ++f) tmpgbd[f] = NULL;
425c371a6d1SMatthew G. Knepley   for (f = Nf; f < NfNew; ++f) tmpexactSol[f] = NULL;
426c371a6d1SMatthew G. Knepley   ierr = PetscFree3(prob->fBd, prob->gBd, prob->exactSol);CHKERRQ(ierr);
4272764a2aaSMatthew G. Knepley   prob->fBd = tmpfbd;
4282764a2aaSMatthew G. Knepley   prob->gBd = tmpgbd;
429c371a6d1SMatthew G. Knepley   prob->exactSol = tmpexactSol;
4302764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
4312764a2aaSMatthew G. Knepley }
4322764a2aaSMatthew G. Knepley 
4332764a2aaSMatthew G. Knepley /*@
4342764a2aaSMatthew G. Knepley   PetscDSDestroy - Destroys a PetscDS object
4352764a2aaSMatthew G. Knepley 
4362764a2aaSMatthew G. Knepley   Collective on PetscDS
4372764a2aaSMatthew G. Knepley 
4382764a2aaSMatthew G. Knepley   Input Parameter:
4392764a2aaSMatthew G. Knepley . prob - the PetscDS object to destroy
4402764a2aaSMatthew G. Knepley 
4412764a2aaSMatthew G. Knepley   Level: developer
4422764a2aaSMatthew G. Knepley 
4432764a2aaSMatthew G. Knepley .seealso PetscDSView()
4442764a2aaSMatthew G. Knepley @*/
4452764a2aaSMatthew G. Knepley PetscErrorCode PetscDSDestroy(PetscDS *prob)
4462764a2aaSMatthew G. Knepley {
4472764a2aaSMatthew G. Knepley   PetscInt       f;
44858ebd649SToby Isaac   DSBoundary     next;
4492764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
4502764a2aaSMatthew G. Knepley 
4512764a2aaSMatthew G. Knepley   PetscFunctionBegin;
4522764a2aaSMatthew G. Knepley   if (!*prob) PetscFunctionReturn(0);
4532764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific((*prob), PETSCDS_CLASSID, 1);
4542764a2aaSMatthew G. Knepley 
4552764a2aaSMatthew G. Knepley   if (--((PetscObject)(*prob))->refct > 0) {*prob = 0; PetscFunctionReturn(0);}
4562764a2aaSMatthew G. Knepley   ((PetscObject) (*prob))->refct = 0;
457df3a45bdSMatthew G. Knepley   if ((*prob)->subprobs) {
458df3a45bdSMatthew G. Knepley     PetscInt dim, d;
459df3a45bdSMatthew G. Knepley 
460df3a45bdSMatthew G. Knepley     ierr = PetscDSGetSpatialDimension(*prob, &dim);CHKERRQ(ierr);
461df3a45bdSMatthew G. Knepley     for (d = 0; d < dim; ++d) {ierr = PetscDSDestroy(&(*prob)->subprobs[d]);CHKERRQ(ierr);}
462df3a45bdSMatthew G. Knepley   }
463df3a45bdSMatthew G. Knepley   ierr = PetscFree((*prob)->subprobs);CHKERRQ(ierr);
4642764a2aaSMatthew G. Knepley   ierr = PetscDSDestroyStructs_Static(*prob);CHKERRQ(ierr);
4652764a2aaSMatthew G. Knepley   for (f = 0; f < (*prob)->Nf; ++f) {
4662764a2aaSMatthew G. Knepley     ierr = PetscObjectDereference((*prob)->disc[f]);CHKERRQ(ierr);
4672764a2aaSMatthew G. Knepley   }
468f744cafaSSander Arens   ierr = PetscFree3((*prob)->disc, (*prob)->implicit, (*prob)->adjacency);CHKERRQ(ierr);
469b7e05686SMatthew G. Knepley   ierr = PetscFree7((*prob)->obj,(*prob)->f,(*prob)->g,(*prob)->gp,(*prob)->gt,(*prob)->r,(*prob)->ctx);CHKERRQ(ierr);
47032d2bbc9SMatthew G. Knepley   ierr = PetscFree((*prob)->update);CHKERRQ(ierr);
471c371a6d1SMatthew G. Knepley   ierr = PetscFree3((*prob)->fBd,(*prob)->gBd,(*prob)->exactSol);CHKERRQ(ierr);
4722764a2aaSMatthew G. Knepley   if ((*prob)->ops->destroy) {ierr = (*(*prob)->ops->destroy)(*prob);CHKERRQ(ierr);}
47358ebd649SToby Isaac   next = (*prob)->boundary;
47458ebd649SToby Isaac   while (next) {
47558ebd649SToby Isaac     DSBoundary b = next;
47658ebd649SToby Isaac 
47758ebd649SToby Isaac     next = b->next;
47858ebd649SToby Isaac     ierr = PetscFree(b->comps);CHKERRQ(ierr);
47958ebd649SToby Isaac     ierr = PetscFree(b->ids);CHKERRQ(ierr);
48058ebd649SToby Isaac     ierr = PetscFree(b->name);CHKERRQ(ierr);
48158ebd649SToby Isaac     ierr = PetscFree(b->labelname);CHKERRQ(ierr);
48258ebd649SToby Isaac     ierr = PetscFree(b);CHKERRQ(ierr);
48358ebd649SToby Isaac   }
48497b6e6e8SMatthew G. Knepley   ierr = PetscFree((*prob)->constants);CHKERRQ(ierr);
4852764a2aaSMatthew G. Knepley   ierr = PetscHeaderDestroy(prob);CHKERRQ(ierr);
4862764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
4872764a2aaSMatthew G. Knepley }
4882764a2aaSMatthew G. Knepley 
4892764a2aaSMatthew G. Knepley /*@
4902764a2aaSMatthew G. Knepley   PetscDSCreate - Creates an empty PetscDS object. The type can then be set with PetscDSSetType().
4912764a2aaSMatthew G. Knepley 
4922764a2aaSMatthew G. Knepley   Collective on MPI_Comm
4932764a2aaSMatthew G. Knepley 
4942764a2aaSMatthew G. Knepley   Input Parameter:
4952764a2aaSMatthew G. Knepley . comm - The communicator for the PetscDS object
4962764a2aaSMatthew G. Knepley 
4972764a2aaSMatthew G. Knepley   Output Parameter:
4982764a2aaSMatthew G. Knepley . prob - The PetscDS object
4992764a2aaSMatthew G. Knepley 
5002764a2aaSMatthew G. Knepley   Level: beginner
5012764a2aaSMatthew G. Knepley 
5022764a2aaSMatthew G. Knepley .seealso: PetscDSSetType(), PETSCDSBASIC
5032764a2aaSMatthew G. Knepley @*/
5042764a2aaSMatthew G. Knepley PetscErrorCode PetscDSCreate(MPI_Comm comm, PetscDS *prob)
5052764a2aaSMatthew G. Knepley {
5062764a2aaSMatthew G. Knepley   PetscDS   p;
5072764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
5082764a2aaSMatthew G. Knepley 
5092764a2aaSMatthew G. Knepley   PetscFunctionBegin;
5102764a2aaSMatthew G. Knepley   PetscValidPointer(prob, 2);
5112764a2aaSMatthew G. Knepley   *prob  = NULL;
5122764a2aaSMatthew G. Knepley   ierr = PetscDSInitializePackage();CHKERRQ(ierr);
5132764a2aaSMatthew G. Knepley 
51473107ff1SLisandro Dalcin   ierr = PetscHeaderCreate(p, PETSCDS_CLASSID, "PetscDS", "Discrete System", "PetscDS", comm, PetscDSDestroy, PetscDSView);CHKERRQ(ierr);
5152764a2aaSMatthew G. Knepley 
5162764a2aaSMatthew G. Knepley   p->Nf    = 0;
5172764a2aaSMatthew G. Knepley   p->setup = PETSC_FALSE;
51897b6e6e8SMatthew G. Knepley   p->numConstants  = 0;
51997b6e6e8SMatthew G. Knepley   p->constants     = NULL;
520a859676bSMatthew G. Knepley   p->dimEmbed      = -1;
52103d90f89SMatthew G. Knepley   p->defaultAdj[0] = PETSC_FALSE;
52203d90f89SMatthew G. Knepley   p->defaultAdj[1] = PETSC_TRUE;
5232764a2aaSMatthew G. Knepley 
5242764a2aaSMatthew G. Knepley   *prob = p;
5252764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
5262764a2aaSMatthew G. Knepley }
5272764a2aaSMatthew G. Knepley 
528bc4ae4beSMatthew G. Knepley /*@
529bc4ae4beSMatthew G. Knepley   PetscDSGetNumFields - Returns the number of fields in the DS
530bc4ae4beSMatthew G. Knepley 
531bc4ae4beSMatthew G. Knepley   Not collective
532bc4ae4beSMatthew G. Knepley 
533bc4ae4beSMatthew G. Knepley   Input Parameter:
534bc4ae4beSMatthew G. Knepley . prob - The PetscDS object
535bc4ae4beSMatthew G. Knepley 
536bc4ae4beSMatthew G. Knepley   Output Parameter:
537bc4ae4beSMatthew G. Knepley . Nf - The number of fields
538bc4ae4beSMatthew G. Knepley 
539bc4ae4beSMatthew G. Knepley   Level: beginner
540bc4ae4beSMatthew G. Knepley 
541bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetSpatialDimension(), PetscDSCreate()
542bc4ae4beSMatthew G. Knepley @*/
5432764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetNumFields(PetscDS prob, PetscInt *Nf)
5442764a2aaSMatthew G. Knepley {
5452764a2aaSMatthew G. Knepley   PetscFunctionBegin;
5462764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
5472764a2aaSMatthew G. Knepley   PetscValidPointer(Nf, 2);
5482764a2aaSMatthew G. Knepley   *Nf = prob->Nf;
5492764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
5502764a2aaSMatthew G. Knepley }
5512764a2aaSMatthew G. Knepley 
552bc4ae4beSMatthew G. Knepley /*@
553a859676bSMatthew G. Knepley   PetscDSGetSpatialDimension - Returns the spatial dimension of the DS, meaning the topological dimension of the discretizations
554bc4ae4beSMatthew G. Knepley 
555bc4ae4beSMatthew G. Knepley   Not collective
556bc4ae4beSMatthew G. Knepley 
557bc4ae4beSMatthew G. Knepley   Input Parameter:
558bc4ae4beSMatthew G. Knepley . prob - The PetscDS object
559bc4ae4beSMatthew G. Knepley 
560bc4ae4beSMatthew G. Knepley   Output Parameter:
561bc4ae4beSMatthew G. Knepley . dim - The spatial dimension
562bc4ae4beSMatthew G. Knepley 
563bc4ae4beSMatthew G. Knepley   Level: beginner
564bc4ae4beSMatthew G. Knepley 
565a859676bSMatthew G. Knepley .seealso: PetscDSGetCoordinateDimension(), PetscDSGetNumFields(), PetscDSCreate()
566bc4ae4beSMatthew G. Knepley @*/
5672764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetSpatialDimension(PetscDS prob, PetscInt *dim)
5682764a2aaSMatthew G. Knepley {
5692764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
5702764a2aaSMatthew G. Knepley 
5712764a2aaSMatthew G. Knepley   PetscFunctionBegin;
5722764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
5732764a2aaSMatthew G. Knepley   PetscValidPointer(dim, 2);
5742764a2aaSMatthew G. Knepley   *dim = 0;
5759de99aefSMatthew G. Knepley   if (prob->Nf) {
5769de99aefSMatthew G. Knepley     PetscObject  obj;
5779de99aefSMatthew G. Knepley     PetscClassId id;
5789de99aefSMatthew G. Knepley 
5799de99aefSMatthew G. Knepley     ierr = PetscDSGetDiscretization(prob, 0, &obj);CHKERRQ(ierr);
5809de99aefSMatthew G. Knepley     ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr);
5819de99aefSMatthew G. Knepley     if (id == PETSCFE_CLASSID)      {ierr = PetscFEGetSpatialDimension((PetscFE) obj, dim);CHKERRQ(ierr);}
5829de99aefSMatthew G. Knepley     else if (id == PETSCFV_CLASSID) {ierr = PetscFVGetSpatialDimension((PetscFV) obj, dim);CHKERRQ(ierr);}
5839de99aefSMatthew G. Knepley     else SETERRQ1(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Unknown discretization type for field %d", 0);
5849de99aefSMatthew G. Knepley   }
5852764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
5862764a2aaSMatthew G. Knepley }
5872764a2aaSMatthew G. Knepley 
588bc4ae4beSMatthew G. Knepley /*@
589a859676bSMatthew G. Knepley   PetscDSGetCoordinateDimension - Returns the coordinate dimension of the DS, meaning the dimension of the space into which the discretiaztions are embedded
590a859676bSMatthew G. Knepley 
591a859676bSMatthew G. Knepley   Not collective
592a859676bSMatthew G. Knepley 
593a859676bSMatthew G. Knepley   Input Parameter:
594a859676bSMatthew G. Knepley . prob - The PetscDS object
595a859676bSMatthew G. Knepley 
596a859676bSMatthew G. Knepley   Output Parameter:
597a859676bSMatthew G. Knepley . dimEmbed - The coordinate dimension
598a859676bSMatthew G. Knepley 
599a859676bSMatthew G. Knepley   Level: beginner
600a859676bSMatthew G. Knepley 
601a859676bSMatthew G. Knepley .seealso: PetscDSSetCoordinateDimension(), PetscDSGetSpatialDimension(), PetscDSGetNumFields(), PetscDSCreate()
602a859676bSMatthew G. Knepley @*/
603a859676bSMatthew G. Knepley PetscErrorCode PetscDSGetCoordinateDimension(PetscDS prob, PetscInt *dimEmbed)
604a859676bSMatthew G. Knepley {
605a859676bSMatthew G. Knepley   PetscFunctionBegin;
606a859676bSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
607a859676bSMatthew G. Knepley   PetscValidPointer(dimEmbed, 2);
608a859676bSMatthew G. Knepley   if (prob->dimEmbed < 0) SETERRQ(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONGSTATE, "No coordinate dimension set for this DS");
609a859676bSMatthew G. Knepley   *dimEmbed = prob->dimEmbed;
610a859676bSMatthew G. Knepley   PetscFunctionReturn(0);
611a859676bSMatthew G. Knepley }
612a859676bSMatthew G. Knepley 
613a859676bSMatthew G. Knepley /*@
614a859676bSMatthew G. Knepley   PetscDSSetCoordinateDimension - Set the coordinate dimension of the DS, meaning the dimension of the space into which the discretiaztions are embedded
615a859676bSMatthew G. Knepley 
616a859676bSMatthew G. Knepley   Not collective
617a859676bSMatthew G. Knepley 
618a859676bSMatthew G. Knepley   Input Parameters:
619a859676bSMatthew G. Knepley + prob - The PetscDS object
620a859676bSMatthew G. Knepley - dimEmbed - The coordinate dimension
621a859676bSMatthew G. Knepley 
622a859676bSMatthew G. Knepley   Level: beginner
623a859676bSMatthew G. Knepley 
624a859676bSMatthew G. Knepley .seealso: PetscDSGetCoordinateDimension(), PetscDSGetSpatialDimension(), PetscDSGetNumFields(), PetscDSCreate()
625a859676bSMatthew G. Knepley @*/
626a859676bSMatthew G. Knepley PetscErrorCode PetscDSSetCoordinateDimension(PetscDS prob, PetscInt dimEmbed)
627a859676bSMatthew G. Knepley {
628a859676bSMatthew G. Knepley   PetscFunctionBegin;
629a859676bSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
630a859676bSMatthew G. Knepley   prob->dimEmbed = dimEmbed;
631a859676bSMatthew G. Knepley   PetscFunctionReturn(0);
632a859676bSMatthew G. Knepley }
633a859676bSMatthew G. Knepley 
634a859676bSMatthew G. Knepley /*@
635bc4ae4beSMatthew G. Knepley   PetscDSGetTotalDimension - Returns the total size of the approximation space for this system
636bc4ae4beSMatthew G. Knepley 
637bc4ae4beSMatthew G. Knepley   Not collective
638bc4ae4beSMatthew G. Knepley 
639bc4ae4beSMatthew G. Knepley   Input Parameter:
640bc4ae4beSMatthew G. Knepley . prob - The PetscDS object
641bc4ae4beSMatthew G. Knepley 
642bc4ae4beSMatthew G. Knepley   Output Parameter:
643bc4ae4beSMatthew G. Knepley . dim - The total problem dimension
644bc4ae4beSMatthew G. Knepley 
645bc4ae4beSMatthew G. Knepley   Level: beginner
646bc4ae4beSMatthew G. Knepley 
647bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetNumFields(), PetscDSCreate()
648bc4ae4beSMatthew G. Knepley @*/
6492764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetTotalDimension(PetscDS prob, PetscInt *dim)
6502764a2aaSMatthew G. Knepley {
6512764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
6522764a2aaSMatthew G. Knepley 
6532764a2aaSMatthew G. Knepley   PetscFunctionBegin;
6542764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
6552764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
6562764a2aaSMatthew G. Knepley   PetscValidPointer(dim, 2);
6572764a2aaSMatthew G. Knepley   *dim = prob->totDim;
6582764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
6592764a2aaSMatthew G. Knepley }
6602764a2aaSMatthew G. Knepley 
661bc4ae4beSMatthew G. Knepley /*@
662bc4ae4beSMatthew G. Knepley   PetscDSGetTotalComponents - Returns the total number of components in this system
663bc4ae4beSMatthew G. Knepley 
664bc4ae4beSMatthew G. Knepley   Not collective
665bc4ae4beSMatthew G. Knepley 
666bc4ae4beSMatthew G. Knepley   Input Parameter:
667bc4ae4beSMatthew G. Knepley . prob - The PetscDS object
668bc4ae4beSMatthew G. Knepley 
669bc4ae4beSMatthew G. Knepley   Output Parameter:
670bc4ae4beSMatthew G. Knepley . dim - The total number of components
671bc4ae4beSMatthew G. Knepley 
672bc4ae4beSMatthew G. Knepley   Level: beginner
673bc4ae4beSMatthew G. Knepley 
674bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetNumFields(), PetscDSCreate()
675bc4ae4beSMatthew G. Knepley @*/
6762764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetTotalComponents(PetscDS prob, PetscInt *Nc)
6772764a2aaSMatthew G. Knepley {
6782764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
6792764a2aaSMatthew G. Knepley 
6802764a2aaSMatthew G. Knepley   PetscFunctionBegin;
6812764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
6822764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
6832764a2aaSMatthew G. Knepley   PetscValidPointer(Nc, 2);
6842764a2aaSMatthew G. Knepley   *Nc = prob->totComp;
6852764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
6862764a2aaSMatthew G. Knepley }
6872764a2aaSMatthew G. Knepley 
688bc4ae4beSMatthew G. Knepley /*@
689bc4ae4beSMatthew G. Knepley   PetscDSGetDiscretization - Returns the discretization object for the given field
690bc4ae4beSMatthew G. Knepley 
691bc4ae4beSMatthew G. Knepley   Not collective
692bc4ae4beSMatthew G. Knepley 
693bc4ae4beSMatthew G. Knepley   Input Parameters:
694bc4ae4beSMatthew G. Knepley + prob - The PetscDS object
695bc4ae4beSMatthew G. Knepley - f - The field number
696bc4ae4beSMatthew G. Knepley 
697bc4ae4beSMatthew G. Knepley   Output Parameter:
698bc4ae4beSMatthew G. Knepley . disc - The discretization object
699bc4ae4beSMatthew G. Knepley 
700bc4ae4beSMatthew G. Knepley   Level: beginner
701bc4ae4beSMatthew G. Knepley 
702f744cafaSSander Arens .seealso: PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
703bc4ae4beSMatthew G. Knepley @*/
7042764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetDiscretization(PetscDS prob, PetscInt f, PetscObject *disc)
7052764a2aaSMatthew G. Knepley {
7062764a2aaSMatthew G. Knepley   PetscFunctionBegin;
7072764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
7082764a2aaSMatthew G. Knepley   PetscValidPointer(disc, 3);
7092764a2aaSMatthew 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);
7102764a2aaSMatthew G. Knepley   *disc = prob->disc[f];
7112764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
7122764a2aaSMatthew G. Knepley }
7132764a2aaSMatthew G. Knepley 
714bc4ae4beSMatthew G. Knepley /*@
715bc4ae4beSMatthew G. Knepley   PetscDSSetDiscretization - Sets the discretization object for the given field
716bc4ae4beSMatthew G. Knepley 
717bc4ae4beSMatthew G. Knepley   Not collective
718bc4ae4beSMatthew G. Knepley 
719bc4ae4beSMatthew G. Knepley   Input Parameters:
720bc4ae4beSMatthew G. Knepley + prob - The PetscDS object
721bc4ae4beSMatthew G. Knepley . f - The field number
722bc4ae4beSMatthew G. Knepley - disc - The discretization object
723bc4ae4beSMatthew G. Knepley 
724bc4ae4beSMatthew G. Knepley   Level: beginner
725bc4ae4beSMatthew G. Knepley 
726bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
727bc4ae4beSMatthew G. Knepley @*/
7282764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetDiscretization(PetscDS prob, PetscInt f, PetscObject disc)
7292764a2aaSMatthew G. Knepley {
7302764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
7312764a2aaSMatthew G. Knepley 
7322764a2aaSMatthew G. Knepley   PetscFunctionBegin;
7332764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
7342764a2aaSMatthew G. Knepley   PetscValidPointer(disc, 3);
7352764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
7362764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
7372764a2aaSMatthew G. Knepley   if (prob->disc[f]) {ierr = PetscObjectDereference(prob->disc[f]);CHKERRQ(ierr);}
7382764a2aaSMatthew G. Knepley   prob->disc[f] = disc;
7392764a2aaSMatthew G. Knepley   ierr = PetscObjectReference(disc);CHKERRQ(ierr);
740249df284SMatthew G. Knepley   {
741249df284SMatthew G. Knepley     PetscClassId id;
742249df284SMatthew G. Knepley 
743249df284SMatthew G. Knepley     ierr = PetscObjectGetClassId(disc, &id);CHKERRQ(ierr);
7441cf84007SMatthew G. Knepley     if (id == PETSCFE_CLASSID) {
7451cf84007SMatthew G. Knepley       ierr = PetscDSSetImplicit(prob, f, PETSC_TRUE);CHKERRQ(ierr);
7461cf84007SMatthew G. Knepley       ierr = PetscDSSetAdjacency(prob, f, PETSC_FALSE, PETSC_TRUE);CHKERRQ(ierr);
7471cf84007SMatthew G. Knepley     } else if (id == PETSCFV_CLASSID) {
7481cf84007SMatthew G. Knepley       ierr = PetscDSSetImplicit(prob, f, PETSC_FALSE);CHKERRQ(ierr);
7491cf84007SMatthew G. Knepley       ierr = PetscDSSetAdjacency(prob, f, PETSC_TRUE, PETSC_FALSE);CHKERRQ(ierr);
750a6cbbb48SMatthew G. Knepley     }
751249df284SMatthew G. Knepley   }
7522764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
7532764a2aaSMatthew G. Knepley }
7542764a2aaSMatthew G. Knepley 
755bc4ae4beSMatthew G. Knepley /*@
756bc4ae4beSMatthew G. Knepley   PetscDSAddDiscretization - Adds a discretization object
757bc4ae4beSMatthew G. Knepley 
758bc4ae4beSMatthew G. Knepley   Not collective
759bc4ae4beSMatthew G. Knepley 
760bc4ae4beSMatthew G. Knepley   Input Parameters:
761bc4ae4beSMatthew G. Knepley + prob - The PetscDS object
762bc4ae4beSMatthew G. Knepley - disc - The boundary discretization object
763bc4ae4beSMatthew G. Knepley 
764bc4ae4beSMatthew G. Knepley   Level: beginner
765bc4ae4beSMatthew G. Knepley 
766bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetDiscretization(), PetscDSSetDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
767bc4ae4beSMatthew G. Knepley @*/
7682764a2aaSMatthew G. Knepley PetscErrorCode PetscDSAddDiscretization(PetscDS prob, PetscObject disc)
7692764a2aaSMatthew G. Knepley {
7702764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
7712764a2aaSMatthew G. Knepley 
7722764a2aaSMatthew G. Knepley   PetscFunctionBegin;
7732764a2aaSMatthew G. Knepley   ierr = PetscDSSetDiscretization(prob, prob->Nf, disc);CHKERRQ(ierr);
7742764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
7752764a2aaSMatthew G. Knepley }
7762764a2aaSMatthew G. Knepley 
777249df284SMatthew G. Knepley /*@
778249df284SMatthew G. Knepley   PetscDSGetImplicit - Returns the flag for implicit solve for this field. This is just a guide for IMEX
779249df284SMatthew G. Knepley 
780249df284SMatthew G. Knepley   Not collective
781249df284SMatthew G. Knepley 
782249df284SMatthew G. Knepley   Input Parameters:
783249df284SMatthew G. Knepley + prob - The PetscDS object
784249df284SMatthew G. Knepley - f - The field number
785249df284SMatthew G. Knepley 
786249df284SMatthew G. Knepley   Output Parameter:
787249df284SMatthew G. Knepley . implicit - The flag indicating what kind of solve to use for this field
788249df284SMatthew G. Knepley 
789249df284SMatthew G. Knepley   Level: developer
790249df284SMatthew G. Knepley 
791f744cafaSSander Arens .seealso: PetscDSSetImplicit(), PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
792249df284SMatthew G. Knepley @*/
793249df284SMatthew G. Knepley PetscErrorCode PetscDSGetImplicit(PetscDS prob, PetscInt f, PetscBool *implicit)
794249df284SMatthew G. Knepley {
795249df284SMatthew G. Knepley   PetscFunctionBegin;
796249df284SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
797249df284SMatthew G. Knepley   PetscValidPointer(implicit, 3);
798249df284SMatthew 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);
799249df284SMatthew G. Knepley   *implicit = prob->implicit[f];
800249df284SMatthew G. Knepley   PetscFunctionReturn(0);
801249df284SMatthew G. Knepley }
802249df284SMatthew G. Knepley 
803249df284SMatthew G. Knepley /*@
804249df284SMatthew G. Knepley   PetscDSSetImplicit - Set the flag for implicit solve for this field. This is just a guide for IMEX
805249df284SMatthew G. Knepley 
806249df284SMatthew G. Knepley   Not collective
807249df284SMatthew G. Knepley 
808249df284SMatthew G. Knepley   Input Parameters:
809249df284SMatthew G. Knepley + prob - The PetscDS object
810249df284SMatthew G. Knepley . f - The field number
811249df284SMatthew G. Knepley - implicit - The flag indicating what kind of solve to use for this field
812249df284SMatthew G. Knepley 
813249df284SMatthew G. Knepley   Level: developer
814249df284SMatthew G. Knepley 
815f744cafaSSander Arens .seealso: PetscDSGetImplicit(), PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
816249df284SMatthew G. Knepley @*/
817249df284SMatthew G. Knepley PetscErrorCode PetscDSSetImplicit(PetscDS prob, PetscInt f, PetscBool implicit)
818249df284SMatthew G. Knepley {
819249df284SMatthew G. Knepley   PetscFunctionBegin;
820249df284SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
821249df284SMatthew 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);
822249df284SMatthew G. Knepley   prob->implicit[f] = implicit;
823249df284SMatthew G. Knepley   PetscFunctionReturn(0);
824249df284SMatthew G. Knepley }
825249df284SMatthew G. Knepley 
826a6cbbb48SMatthew G. Knepley /*@
827a6cbbb48SMatthew G. Knepley   PetscDSGetAdjacency - Returns the flags for determining variable influence
828a6cbbb48SMatthew G. Knepley 
829a6cbbb48SMatthew G. Knepley   Not collective
830a6cbbb48SMatthew G. Knepley 
831a6cbbb48SMatthew G. Knepley   Input Parameters:
832a6cbbb48SMatthew G. Knepley + prob - The PetscDS object
833a6cbbb48SMatthew G. Knepley - f - The field number
834a6cbbb48SMatthew G. Knepley 
835a6cbbb48SMatthew G. Knepley   Output Parameter:
836a6cbbb48SMatthew G. Knepley + useCone    - Flag for variable influence starting with the cone operation
837a6cbbb48SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
838a6cbbb48SMatthew G. Knepley 
839a6cbbb48SMatthew G. Knepley   Note: See the discussion in DMPlexGetAdjacencyUseCone() and DMPlexGetAdjacencyUseClosure()
840a6cbbb48SMatthew G. Knepley 
841a6cbbb48SMatthew G. Knepley   Level: developer
842a6cbbb48SMatthew G. Knepley 
843f744cafaSSander Arens .seealso: PetscDSSetAdjacency(), DMPlexGetAdjacencyUseCone(), DMPlexGetAdjacencyUseClosure(), PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
844a6cbbb48SMatthew G. Knepley @*/
845a6cbbb48SMatthew G. Knepley PetscErrorCode PetscDSGetAdjacency(PetscDS prob, PetscInt f, PetscBool *useCone, PetscBool *useClosure)
846a6cbbb48SMatthew G. Knepley {
847a6cbbb48SMatthew G. Knepley   PetscFunctionBegin;
848a6cbbb48SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
8491cf84007SMatthew G. Knepley   if (useCone) PetscValidPointer(useCone, 3);
8501cf84007SMatthew G. Knepley   if (useClosure) PetscValidPointer(useClosure, 4);
85106cc46feSMatthew G. Knepley   if (f < 0) {
85206cc46feSMatthew G. Knepley     if (useCone)    *useCone    = prob->defaultAdj[0];
85306cc46feSMatthew G. Knepley     if (useClosure) *useClosure = prob->defaultAdj[1];
85406cc46feSMatthew G. Knepley   } else {
85506cc46feSMatthew 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);
8561cf84007SMatthew G. Knepley     if (useCone)    *useCone    = prob->adjacency[f*2+0];
8571cf84007SMatthew G. Knepley     if (useClosure) *useClosure = prob->adjacency[f*2+1];
85806cc46feSMatthew G. Knepley   }
859a6cbbb48SMatthew G. Knepley   PetscFunctionReturn(0);
860a6cbbb48SMatthew G. Knepley }
861a6cbbb48SMatthew G. Knepley 
862a6cbbb48SMatthew G. Knepley /*@
863a6cbbb48SMatthew G. Knepley   PetscDSSetAdjacency - Set the flags for determining variable influence
864a6cbbb48SMatthew G. Knepley 
865a6cbbb48SMatthew G. Knepley   Not collective
866a6cbbb48SMatthew G. Knepley 
867a6cbbb48SMatthew G. Knepley   Input Parameters:
868a6cbbb48SMatthew G. Knepley + prob - The PetscDS object
869a6cbbb48SMatthew G. Knepley . f - The field number
870a6cbbb48SMatthew G. Knepley . useCone    - Flag for variable influence starting with the cone operation
871a6cbbb48SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
872a6cbbb48SMatthew G. Knepley 
873a6cbbb48SMatthew G. Knepley   Note: See the discussion in DMPlexGetAdjacencyUseCone() and DMPlexGetAdjacencyUseClosure()
874a6cbbb48SMatthew G. Knepley 
875a6cbbb48SMatthew G. Knepley   Level: developer
876a6cbbb48SMatthew G. Knepley 
877f744cafaSSander Arens .seealso: PetscDSGetAdjacency(), DMPlexGetAdjacencyUseCone(), DMPlexGetAdjacencyUseClosure(), PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
878a6cbbb48SMatthew G. Knepley @*/
879a6cbbb48SMatthew G. Knepley PetscErrorCode PetscDSSetAdjacency(PetscDS prob, PetscInt f, PetscBool useCone, PetscBool useClosure)
880a6cbbb48SMatthew G. Knepley {
881a6cbbb48SMatthew G. Knepley   PetscFunctionBegin;
882a6cbbb48SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
88306cc46feSMatthew G. Knepley   if (f < 0) {
88406cc46feSMatthew G. Knepley     prob->defaultAdj[0] = useCone;
88506cc46feSMatthew G. Knepley     prob->defaultAdj[1] = useClosure;
88606cc46feSMatthew G. Knepley   } else {
88706cc46feSMatthew 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);
888a6cbbb48SMatthew G. Knepley     prob->adjacency[f*2+0] = useCone;
889a6cbbb48SMatthew G. Knepley     prob->adjacency[f*2+1] = useClosure;
89006cc46feSMatthew G. Knepley   }
891a6cbbb48SMatthew G. Knepley   PetscFunctionReturn(0);
892a6cbbb48SMatthew G. Knepley }
893a6cbbb48SMatthew G. Knepley 
8942764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetObjective(PetscDS prob, PetscInt f,
89530b9ff8bSMatthew G. Knepley                                    void (**obj)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
896194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
897194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
89897b6e6e8SMatthew G. Knepley                                                 PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar obj[]))
8992764a2aaSMatthew G. Knepley {
9002764a2aaSMatthew G. Knepley   PetscFunctionBegin;
9012764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
9022764a2aaSMatthew G. Knepley   PetscValidPointer(obj, 2);
9032764a2aaSMatthew 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);
9042764a2aaSMatthew G. Knepley   *obj = prob->obj[f];
9052764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
9062764a2aaSMatthew G. Knepley }
9072764a2aaSMatthew G. Knepley 
9082764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetObjective(PetscDS prob, PetscInt f,
90930b9ff8bSMatthew G. Knepley                                    void (*obj)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
910194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
911194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
91297b6e6e8SMatthew G. Knepley                                                PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar obj[]))
9132764a2aaSMatthew G. Knepley {
9142764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
9152764a2aaSMatthew G. Knepley 
9162764a2aaSMatthew G. Knepley   PetscFunctionBegin;
9172764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
918de716cbcSToby Isaac   if (obj) PetscValidFunction(obj, 2);
9192764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
9202764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
9212764a2aaSMatthew G. Knepley   prob->obj[f] = obj;
9222764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
9232764a2aaSMatthew G. Knepley }
9242764a2aaSMatthew G. Knepley 
925194d53e6SMatthew G. Knepley /*@C
926194d53e6SMatthew G. Knepley   PetscDSGetResidual - Get the pointwise residual function for a given test field
927194d53e6SMatthew G. Knepley 
928194d53e6SMatthew G. Knepley   Not collective
929194d53e6SMatthew G. Knepley 
930194d53e6SMatthew G. Knepley   Input Parameters:
931194d53e6SMatthew G. Knepley + prob - The PetscDS
932194d53e6SMatthew G. Knepley - f    - The test field number
933194d53e6SMatthew G. Knepley 
934194d53e6SMatthew G. Knepley   Output Parameters:
935194d53e6SMatthew G. Knepley + f0 - integrand for the test function term
936194d53e6SMatthew G. Knepley - f1 - integrand for the test function gradient term
937194d53e6SMatthew G. Knepley 
938194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
939194d53e6SMatthew G. Knepley 
940194d53e6SMatthew 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)
941194d53e6SMatthew G. Knepley 
942194d53e6SMatthew G. Knepley The calling sequence for the callbacks f0 and f1 is given by:
943194d53e6SMatthew G. Knepley 
94430b9ff8bSMatthew G. Knepley $ f0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
945194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
946194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
94730b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], PetscScalar f0[])
948194d53e6SMatthew G. Knepley 
949194d53e6SMatthew G. Knepley + dim - the spatial dimension
950194d53e6SMatthew G. Knepley . Nf - the number of fields
951194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
952194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
953194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
954194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
955194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
956194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
957194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
958194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
959194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
960194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
961194d53e6SMatthew G. Knepley . t - current time
962194d53e6SMatthew G. Knepley . x - coordinates of the current point
96397b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
96497b6e6e8SMatthew G. Knepley . constants - constant parameters
965194d53e6SMatthew G. Knepley - f0 - output values at the current point
966194d53e6SMatthew G. Knepley 
967194d53e6SMatthew G. Knepley   Level: intermediate
968194d53e6SMatthew G. Knepley 
969194d53e6SMatthew G. Knepley .seealso: PetscDSSetResidual()
970194d53e6SMatthew G. Knepley @*/
9712764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetResidual(PetscDS prob, PetscInt f,
97230b9ff8bSMatthew G. Knepley                                   void (**f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
973194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
974194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
97597b6e6e8SMatthew G. Knepley                                               PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f0[]),
97630b9ff8bSMatthew G. Knepley                                   void (**f1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
977194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
978194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
97997b6e6e8SMatthew G. Knepley                                               PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f1[]))
9802764a2aaSMatthew G. Knepley {
9812764a2aaSMatthew G. Knepley   PetscFunctionBegin;
9822764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
9832764a2aaSMatthew 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);
9842764a2aaSMatthew G. Knepley   if (f0) {PetscValidPointer(f0, 3); *f0 = prob->f[f*2+0];}
9852764a2aaSMatthew G. Knepley   if (f1) {PetscValidPointer(f1, 4); *f1 = prob->f[f*2+1];}
9862764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
9872764a2aaSMatthew G. Knepley }
9882764a2aaSMatthew G. Knepley 
989194d53e6SMatthew G. Knepley /*@C
990194d53e6SMatthew G. Knepley   PetscDSSetResidual - Set the pointwise residual function for a given test field
991194d53e6SMatthew G. Knepley 
992194d53e6SMatthew G. Knepley   Not collective
993194d53e6SMatthew G. Knepley 
994194d53e6SMatthew G. Knepley   Input Parameters:
995194d53e6SMatthew G. Knepley + prob - The PetscDS
996194d53e6SMatthew G. Knepley . f    - The test field number
997194d53e6SMatthew G. Knepley . f0 - integrand for the test function term
998194d53e6SMatthew G. Knepley - f1 - integrand for the test function gradient term
999194d53e6SMatthew G. Knepley 
1000194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1001194d53e6SMatthew G. Knepley 
1002194d53e6SMatthew 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)
1003194d53e6SMatthew G. Knepley 
1004194d53e6SMatthew G. Knepley The calling sequence for the callbacks f0 and f1 is given by:
1005194d53e6SMatthew G. Knepley 
100630b9ff8bSMatthew G. Knepley $ f0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1007194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1008194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
100930b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], PetscScalar f0[])
1010194d53e6SMatthew G. Knepley 
1011194d53e6SMatthew G. Knepley + dim - the spatial dimension
1012194d53e6SMatthew G. Knepley . Nf - the number of fields
1013194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1014194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1015194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
1016194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1017194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1018194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1019194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1020194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1021194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1022194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1023194d53e6SMatthew G. Knepley . t - current time
1024194d53e6SMatthew G. Knepley . x - coordinates of the current point
102597b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
102697b6e6e8SMatthew G. Knepley . constants - constant parameters
1027194d53e6SMatthew G. Knepley - f0 - output values at the current point
1028194d53e6SMatthew G. Knepley 
1029194d53e6SMatthew G. Knepley   Level: intermediate
1030194d53e6SMatthew G. Knepley 
1031194d53e6SMatthew G. Knepley .seealso: PetscDSGetResidual()
1032194d53e6SMatthew G. Knepley @*/
10332764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetResidual(PetscDS prob, PetscInt f,
103430b9ff8bSMatthew G. Knepley                                   void (*f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1035194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1036194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
103797b6e6e8SMatthew G. Knepley                                              PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f0[]),
103830b9ff8bSMatthew G. Knepley                                   void (*f1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1039194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1040194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
104197b6e6e8SMatthew G. Knepley                                              PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f1[]))
10422764a2aaSMatthew G. Knepley {
10432764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
10442764a2aaSMatthew G. Knepley 
10452764a2aaSMatthew G. Knepley   PetscFunctionBegin;
10462764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1047f866a1d0SMatthew G. Knepley   if (f0) PetscValidFunction(f0, 3);
1048f866a1d0SMatthew G. Knepley   if (f1) PetscValidFunction(f1, 4);
10492764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
10502764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
10512764a2aaSMatthew G. Knepley   prob->f[f*2+0] = f0;
10522764a2aaSMatthew G. Knepley   prob->f[f*2+1] = f1;
10532764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
10542764a2aaSMatthew G. Knepley }
10552764a2aaSMatthew G. Knepley 
10563e75805dSMatthew G. Knepley /*@C
10573e75805dSMatthew G. Knepley   PetscDSHasJacobian - Signals that Jacobian functions have been set
10583e75805dSMatthew G. Knepley 
10593e75805dSMatthew G. Knepley   Not collective
10603e75805dSMatthew G. Knepley 
10613e75805dSMatthew G. Knepley   Input Parameter:
10623e75805dSMatthew G. Knepley . prob - The PetscDS
10633e75805dSMatthew G. Knepley 
10643e75805dSMatthew G. Knepley   Output Parameter:
10653e75805dSMatthew G. Knepley . hasJac - flag that pointwise function for the Jacobian has been set
10663e75805dSMatthew G. Knepley 
10673e75805dSMatthew G. Knepley   Level: intermediate
10683e75805dSMatthew G. Knepley 
10693e75805dSMatthew G. Knepley .seealso: PetscDSGetJacobianPreconditioner(), PetscDSSetJacobianPreconditioner(), PetscDSGetJacobian()
10703e75805dSMatthew G. Knepley @*/
10713e75805dSMatthew G. Knepley PetscErrorCode PetscDSHasJacobian(PetscDS prob, PetscBool *hasJac)
10723e75805dSMatthew G. Knepley {
10733e75805dSMatthew G. Knepley   PetscInt f, g, h;
10743e75805dSMatthew G. Knepley 
10753e75805dSMatthew G. Knepley   PetscFunctionBegin;
10763e75805dSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
10773e75805dSMatthew G. Knepley   *hasJac = PETSC_FALSE;
10783e75805dSMatthew G. Knepley   for (f = 0; f < prob->Nf; ++f) {
10793e75805dSMatthew G. Knepley     for (g = 0; g < prob->Nf; ++g) {
10803e75805dSMatthew G. Knepley       for (h = 0; h < 4; ++h) {
10813e75805dSMatthew G. Knepley         if (prob->g[(f*prob->Nf + g)*4+h]) *hasJac = PETSC_TRUE;
10823e75805dSMatthew G. Knepley       }
10833e75805dSMatthew G. Knepley     }
10843e75805dSMatthew G. Knepley   }
10853e75805dSMatthew G. Knepley   PetscFunctionReturn(0);
10863e75805dSMatthew G. Knepley }
10873e75805dSMatthew G. Knepley 
1088194d53e6SMatthew G. Knepley /*@C
1089194d53e6SMatthew G. Knepley   PetscDSGetJacobian - Get the pointwise Jacobian function for given test and basis field
1090194d53e6SMatthew G. Knepley 
1091194d53e6SMatthew G. Knepley   Not collective
1092194d53e6SMatthew G. Knepley 
1093194d53e6SMatthew G. Knepley   Input Parameters:
1094194d53e6SMatthew G. Knepley + prob - The PetscDS
1095194d53e6SMatthew G. Knepley . f    - The test field number
1096194d53e6SMatthew G. Knepley - g    - The field number
1097194d53e6SMatthew G. Knepley 
1098194d53e6SMatthew G. Knepley   Output Parameters:
1099194d53e6SMatthew G. Knepley + g0 - integrand for the test and basis function term
1100194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1101194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1102194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1103194d53e6SMatthew G. Knepley 
1104194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1105194d53e6SMatthew G. Knepley 
1106194d53e6SMatthew 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
1107194d53e6SMatthew G. Knepley 
1108194d53e6SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1109194d53e6SMatthew G. Knepley 
111030b9ff8bSMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1111194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1112194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
111330b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal u_tShift, const PetscReal x[], PetscScalar g0[])
1114194d53e6SMatthew G. Knepley 
1115194d53e6SMatthew G. Knepley + dim - the spatial dimension
1116194d53e6SMatthew G. Knepley . Nf - the number of fields
1117194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1118194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1119194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
1120194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1121194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1122194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1123194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1124194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1125194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1126194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1127194d53e6SMatthew G. Knepley . t - current time
11282aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1129194d53e6SMatthew G. Knepley . x - coordinates of the current point
113097b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
113197b6e6e8SMatthew G. Knepley . constants - constant parameters
1132194d53e6SMatthew G. Knepley - g0 - output values at the current point
1133194d53e6SMatthew G. Knepley 
1134194d53e6SMatthew G. Knepley   Level: intermediate
1135194d53e6SMatthew G. Knepley 
1136194d53e6SMatthew G. Knepley .seealso: PetscDSSetJacobian()
1137194d53e6SMatthew G. Knepley @*/
11382764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetJacobian(PetscDS prob, PetscInt f, PetscInt g,
113930b9ff8bSMatthew G. Knepley                                   void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1140194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1141194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
114297b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
114330b9ff8bSMatthew G. Knepley                                   void (**g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1144194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1145194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
114697b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
114730b9ff8bSMatthew G. Knepley                                   void (**g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1148194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1149194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
115097b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
115130b9ff8bSMatthew G. Knepley                                   void (**g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1152194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1153194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
115497b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
11552764a2aaSMatthew G. Knepley {
11562764a2aaSMatthew G. Knepley   PetscFunctionBegin;
11572764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
11582764a2aaSMatthew 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);
11592764a2aaSMatthew 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);
11602764a2aaSMatthew G. Knepley   if (g0) {PetscValidPointer(g0, 4); *g0 = prob->g[(f*prob->Nf + g)*4+0];}
11612764a2aaSMatthew G. Knepley   if (g1) {PetscValidPointer(g1, 5); *g1 = prob->g[(f*prob->Nf + g)*4+1];}
11622764a2aaSMatthew G. Knepley   if (g2) {PetscValidPointer(g2, 6); *g2 = prob->g[(f*prob->Nf + g)*4+2];}
11632764a2aaSMatthew G. Knepley   if (g3) {PetscValidPointer(g3, 7); *g3 = prob->g[(f*prob->Nf + g)*4+3];}
11642764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
11652764a2aaSMatthew G. Knepley }
11662764a2aaSMatthew G. Knepley 
1167194d53e6SMatthew G. Knepley /*@C
1168194d53e6SMatthew G. Knepley   PetscDSSetJacobian - Set the pointwise Jacobian function for given test and basis fields
1169194d53e6SMatthew G. Knepley 
1170194d53e6SMatthew G. Knepley   Not collective
1171194d53e6SMatthew G. Knepley 
1172194d53e6SMatthew G. Knepley   Input Parameters:
1173194d53e6SMatthew G. Knepley + prob - The PetscDS
1174194d53e6SMatthew G. Knepley . f    - The test field number
1175194d53e6SMatthew G. Knepley . g    - The field number
1176194d53e6SMatthew G. Knepley . g0 - integrand for the test and basis function term
1177194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1178194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1179194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1180194d53e6SMatthew G. Knepley 
1181194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1182194d53e6SMatthew G. Knepley 
1183194d53e6SMatthew 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
1184194d53e6SMatthew G. Knepley 
1185194d53e6SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1186194d53e6SMatthew G. Knepley 
118730b9ff8bSMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1188194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1189194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
119030b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], PetscScalar g0[])
1191194d53e6SMatthew G. Knepley 
1192194d53e6SMatthew G. Knepley + dim - the spatial dimension
1193194d53e6SMatthew G. Knepley . Nf - the number of fields
1194194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1195194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1196194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
1197194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1198194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1199194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1200194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1201194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1202194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1203194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1204194d53e6SMatthew G. Knepley . t - current time
12052aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1206194d53e6SMatthew G. Knepley . x - coordinates of the current point
120797b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
120897b6e6e8SMatthew G. Knepley . constants - constant parameters
1209194d53e6SMatthew G. Knepley - g0 - output values at the current point
1210194d53e6SMatthew G. Knepley 
1211194d53e6SMatthew G. Knepley   Level: intermediate
1212194d53e6SMatthew G. Knepley 
1213194d53e6SMatthew G. Knepley .seealso: PetscDSGetJacobian()
1214194d53e6SMatthew G. Knepley @*/
12152764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetJacobian(PetscDS prob, PetscInt f, PetscInt g,
121630b9ff8bSMatthew G. Knepley                                   void (*g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1217194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1218194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
121997b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
122030b9ff8bSMatthew G. Knepley                                   void (*g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1221194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1222194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
122397b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
122430b9ff8bSMatthew G. Knepley                                   void (*g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1225194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1226194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
122797b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
122830b9ff8bSMatthew G. Knepley                                   void (*g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1229194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1230194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
123197b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
12322764a2aaSMatthew G. Knepley {
12332764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
12342764a2aaSMatthew G. Knepley 
12352764a2aaSMatthew G. Knepley   PetscFunctionBegin;
12362764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
12372764a2aaSMatthew G. Knepley   if (g0) PetscValidFunction(g0, 4);
12382764a2aaSMatthew G. Knepley   if (g1) PetscValidFunction(g1, 5);
12392764a2aaSMatthew G. Knepley   if (g2) PetscValidFunction(g2, 6);
12402764a2aaSMatthew G. Knepley   if (g3) PetscValidFunction(g3, 7);
12412764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
12422764a2aaSMatthew G. Knepley   if (g < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", g);
12432764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, PetscMax(f, g)+1);CHKERRQ(ierr);
12442764a2aaSMatthew G. Knepley   prob->g[(f*prob->Nf + g)*4+0] = g0;
12452764a2aaSMatthew G. Knepley   prob->g[(f*prob->Nf + g)*4+1] = g1;
12462764a2aaSMatthew G. Knepley   prob->g[(f*prob->Nf + g)*4+2] = g2;
12472764a2aaSMatthew G. Knepley   prob->g[(f*prob->Nf + g)*4+3] = g3;
12482764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
12492764a2aaSMatthew G. Knepley }
12502764a2aaSMatthew G. Knepley 
1251475e0ac9SMatthew G. Knepley /*@C
1252475e0ac9SMatthew G. Knepley   PetscDSHasJacobianPreconditioner - Signals that a Jacobian preconditioner matrix has been set
1253475e0ac9SMatthew G. Knepley 
1254475e0ac9SMatthew G. Knepley   Not collective
1255475e0ac9SMatthew G. Knepley 
1256475e0ac9SMatthew G. Knepley   Input Parameter:
1257475e0ac9SMatthew G. Knepley . prob - The PetscDS
1258475e0ac9SMatthew G. Knepley 
1259475e0ac9SMatthew G. Knepley   Output Parameter:
1260475e0ac9SMatthew G. Knepley . hasJacPre - flag that pointwise function for Jacobian preconditioner matrix has been set
1261475e0ac9SMatthew G. Knepley 
1262475e0ac9SMatthew G. Knepley   Level: intermediate
1263475e0ac9SMatthew G. Knepley 
1264475e0ac9SMatthew G. Knepley .seealso: PetscDSGetJacobianPreconditioner(), PetscDSSetJacobianPreconditioner(), PetscDSGetJacobian()
1265475e0ac9SMatthew G. Knepley @*/
1266475e0ac9SMatthew G. Knepley PetscErrorCode PetscDSHasJacobianPreconditioner(PetscDS prob, PetscBool *hasJacPre)
1267475e0ac9SMatthew G. Knepley {
1268475e0ac9SMatthew G. Knepley   PetscInt f, g, h;
1269475e0ac9SMatthew G. Knepley 
1270475e0ac9SMatthew G. Knepley   PetscFunctionBegin;
1271475e0ac9SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1272475e0ac9SMatthew G. Knepley   *hasJacPre = PETSC_FALSE;
1273475e0ac9SMatthew G. Knepley   for (f = 0; f < prob->Nf; ++f) {
1274475e0ac9SMatthew G. Knepley     for (g = 0; g < prob->Nf; ++g) {
1275475e0ac9SMatthew G. Knepley       for (h = 0; h < 4; ++h) {
1276475e0ac9SMatthew G. Knepley         if (prob->gp[(f*prob->Nf + g)*4+h]) *hasJacPre = PETSC_TRUE;
1277475e0ac9SMatthew G. Knepley       }
1278475e0ac9SMatthew G. Knepley     }
1279475e0ac9SMatthew G. Knepley   }
1280475e0ac9SMatthew G. Knepley   PetscFunctionReturn(0);
1281475e0ac9SMatthew G. Knepley }
1282475e0ac9SMatthew G. Knepley 
1283475e0ac9SMatthew G. Knepley /*@C
1284475e0ac9SMatthew 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.
1285475e0ac9SMatthew G. Knepley 
1286475e0ac9SMatthew G. Knepley   Not collective
1287475e0ac9SMatthew G. Knepley 
1288475e0ac9SMatthew G. Knepley   Input Parameters:
1289475e0ac9SMatthew G. Knepley + prob - The PetscDS
1290475e0ac9SMatthew G. Knepley . f    - The test field number
1291475e0ac9SMatthew G. Knepley - g    - The field number
1292475e0ac9SMatthew G. Knepley 
1293475e0ac9SMatthew G. Knepley   Output Parameters:
1294475e0ac9SMatthew G. Knepley + g0 - integrand for the test and basis function term
1295475e0ac9SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1296475e0ac9SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1297475e0ac9SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1298475e0ac9SMatthew G. Knepley 
1299475e0ac9SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1300475e0ac9SMatthew G. Knepley 
1301475e0ac9SMatthew 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
1302475e0ac9SMatthew G. Knepley 
1303475e0ac9SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1304475e0ac9SMatthew G. Knepley 
1305475e0ac9SMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1306475e0ac9SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1307475e0ac9SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1308475e0ac9SMatthew G. Knepley $    PetscReal t, const PetscReal u_tShift, const PetscReal x[], PetscScalar g0[])
1309475e0ac9SMatthew G. Knepley 
1310475e0ac9SMatthew G. Knepley + dim - the spatial dimension
1311475e0ac9SMatthew G. Knepley . Nf - the number of fields
1312475e0ac9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1313475e0ac9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1314475e0ac9SMatthew G. Knepley . u - each field evaluated at the current point
1315475e0ac9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1316475e0ac9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1317475e0ac9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1318475e0ac9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1319475e0ac9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1320475e0ac9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1321475e0ac9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1322475e0ac9SMatthew G. Knepley . t - current time
1323475e0ac9SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1324475e0ac9SMatthew G. Knepley . x - coordinates of the current point
132597b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
132697b6e6e8SMatthew G. Knepley . constants - constant parameters
1327475e0ac9SMatthew G. Knepley - g0 - output values at the current point
1328475e0ac9SMatthew G. Knepley 
1329475e0ac9SMatthew G. Knepley   Level: intermediate
1330475e0ac9SMatthew G. Knepley 
1331475e0ac9SMatthew G. Knepley .seealso: PetscDSSetJacobianPreconditioner(), PetscDSGetJacobian()
1332475e0ac9SMatthew G. Knepley @*/
1333475e0ac9SMatthew G. Knepley PetscErrorCode PetscDSGetJacobianPreconditioner(PetscDS prob, PetscInt f, PetscInt g,
1334475e0ac9SMatthew G. Knepley                                   void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1335475e0ac9SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1336475e0ac9SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
133797b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
1338475e0ac9SMatthew G. Knepley                                   void (**g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1339475e0ac9SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1340475e0ac9SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
134197b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
1342475e0ac9SMatthew G. Knepley                                   void (**g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1343475e0ac9SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1344475e0ac9SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
134597b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
1346475e0ac9SMatthew G. Knepley                                   void (**g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1347475e0ac9SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1348475e0ac9SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
134997b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
1350475e0ac9SMatthew G. Knepley {
1351475e0ac9SMatthew G. Knepley   PetscFunctionBegin;
1352475e0ac9SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1353475e0ac9SMatthew 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);
1354475e0ac9SMatthew 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);
1355475e0ac9SMatthew G. Knepley   if (g0) {PetscValidPointer(g0, 4); *g0 = prob->gp[(f*prob->Nf + g)*4+0];}
1356475e0ac9SMatthew G. Knepley   if (g1) {PetscValidPointer(g1, 5); *g1 = prob->gp[(f*prob->Nf + g)*4+1];}
1357475e0ac9SMatthew G. Knepley   if (g2) {PetscValidPointer(g2, 6); *g2 = prob->gp[(f*prob->Nf + g)*4+2];}
1358475e0ac9SMatthew G. Knepley   if (g3) {PetscValidPointer(g3, 7); *g3 = prob->gp[(f*prob->Nf + g)*4+3];}
1359475e0ac9SMatthew G. Knepley   PetscFunctionReturn(0);
1360475e0ac9SMatthew G. Knepley }
1361475e0ac9SMatthew G. Knepley 
1362475e0ac9SMatthew G. Knepley /*@C
1363475e0ac9SMatthew 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.
1364475e0ac9SMatthew G. Knepley 
1365475e0ac9SMatthew G. Knepley   Not collective
1366475e0ac9SMatthew G. Knepley 
1367475e0ac9SMatthew G. Knepley   Input Parameters:
1368475e0ac9SMatthew G. Knepley + prob - The PetscDS
1369475e0ac9SMatthew G. Knepley . f    - The test field number
1370475e0ac9SMatthew G. Knepley . g    - The field number
1371475e0ac9SMatthew G. Knepley . g0 - integrand for the test and basis function term
1372475e0ac9SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1373475e0ac9SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1374475e0ac9SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1375475e0ac9SMatthew G. Knepley 
1376475e0ac9SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1377475e0ac9SMatthew G. Knepley 
1378475e0ac9SMatthew 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
1379475e0ac9SMatthew G. Knepley 
1380475e0ac9SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1381475e0ac9SMatthew G. Knepley 
1382475e0ac9SMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1383475e0ac9SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1384475e0ac9SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1385475e0ac9SMatthew G. Knepley $    PetscReal t, const PetscReal x[], PetscScalar g0[])
1386475e0ac9SMatthew G. Knepley 
1387475e0ac9SMatthew G. Knepley + dim - the spatial dimension
1388475e0ac9SMatthew G. Knepley . Nf - the number of fields
1389475e0ac9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1390475e0ac9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1391475e0ac9SMatthew G. Knepley . u - each field evaluated at the current point
1392475e0ac9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1393475e0ac9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1394475e0ac9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1395475e0ac9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1396475e0ac9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1397475e0ac9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1398475e0ac9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1399475e0ac9SMatthew G. Knepley . t - current time
1400475e0ac9SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1401475e0ac9SMatthew G. Knepley . x - coordinates of the current point
140297b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
140397b6e6e8SMatthew G. Knepley . constants - constant parameters
1404475e0ac9SMatthew G. Knepley - g0 - output values at the current point
1405475e0ac9SMatthew G. Knepley 
1406475e0ac9SMatthew G. Knepley   Level: intermediate
1407475e0ac9SMatthew G. Knepley 
1408475e0ac9SMatthew G. Knepley .seealso: PetscDSGetJacobianPreconditioner(), PetscDSSetJacobian()
1409475e0ac9SMatthew G. Knepley @*/
1410475e0ac9SMatthew G. Knepley PetscErrorCode PetscDSSetJacobianPreconditioner(PetscDS prob, PetscInt f, PetscInt g,
1411475e0ac9SMatthew G. Knepley                                   void (*g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1412475e0ac9SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1413475e0ac9SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
141497b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
1415475e0ac9SMatthew G. Knepley                                   void (*g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1416475e0ac9SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1417475e0ac9SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
141897b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
1419475e0ac9SMatthew G. Knepley                                   void (*g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1420475e0ac9SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1421475e0ac9SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
142297b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
1423475e0ac9SMatthew G. Knepley                                   void (*g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1424475e0ac9SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1425475e0ac9SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
142697b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
1427475e0ac9SMatthew G. Knepley {
1428475e0ac9SMatthew G. Knepley   PetscErrorCode ierr;
1429475e0ac9SMatthew G. Knepley 
1430475e0ac9SMatthew G. Knepley   PetscFunctionBegin;
1431475e0ac9SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1432475e0ac9SMatthew G. Knepley   if (g0) PetscValidFunction(g0, 4);
1433475e0ac9SMatthew G. Knepley   if (g1) PetscValidFunction(g1, 5);
1434475e0ac9SMatthew G. Knepley   if (g2) PetscValidFunction(g2, 6);
1435475e0ac9SMatthew G. Knepley   if (g3) PetscValidFunction(g3, 7);
1436475e0ac9SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
1437475e0ac9SMatthew G. Knepley   if (g < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", g);
1438475e0ac9SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, PetscMax(f, g)+1);CHKERRQ(ierr);
1439475e0ac9SMatthew G. Knepley   prob->gp[(f*prob->Nf + g)*4+0] = g0;
1440475e0ac9SMatthew G. Knepley   prob->gp[(f*prob->Nf + g)*4+1] = g1;
1441475e0ac9SMatthew G. Knepley   prob->gp[(f*prob->Nf + g)*4+2] = g2;
1442475e0ac9SMatthew G. Knepley   prob->gp[(f*prob->Nf + g)*4+3] = g3;
1443475e0ac9SMatthew G. Knepley   PetscFunctionReturn(0);
1444475e0ac9SMatthew G. Knepley }
1445475e0ac9SMatthew G. Knepley 
1446b7e05686SMatthew G. Knepley /*@C
1447b7e05686SMatthew G. Knepley   PetscDSHasDynamicJacobian - Signals that a dynamic Jacobian, dF/du_t, has been set
1448b7e05686SMatthew G. Knepley 
1449b7e05686SMatthew G. Knepley   Not collective
1450b7e05686SMatthew G. Knepley 
1451b7e05686SMatthew G. Knepley   Input Parameter:
1452b7e05686SMatthew G. Knepley . prob - The PetscDS
1453b7e05686SMatthew G. Knepley 
1454b7e05686SMatthew G. Knepley   Output Parameter:
1455b7e05686SMatthew G. Knepley . hasDynJac - flag that pointwise function for dynamic Jacobian has been set
1456b7e05686SMatthew G. Knepley 
1457b7e05686SMatthew G. Knepley   Level: intermediate
1458b7e05686SMatthew G. Knepley 
1459b7e05686SMatthew G. Knepley .seealso: PetscDSGetDynamicJacobian(), PetscDSSetDynamicJacobian(), PetscDSGetJacobian()
1460b7e05686SMatthew G. Knepley @*/
1461b7e05686SMatthew G. Knepley PetscErrorCode PetscDSHasDynamicJacobian(PetscDS prob, PetscBool *hasDynJac)
1462b7e05686SMatthew G. Knepley {
1463b7e05686SMatthew G. Knepley   PetscInt f, g, h;
1464b7e05686SMatthew G. Knepley 
1465b7e05686SMatthew G. Knepley   PetscFunctionBegin;
1466b7e05686SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1467b7e05686SMatthew G. Knepley   *hasDynJac = PETSC_FALSE;
1468b7e05686SMatthew G. Knepley   for (f = 0; f < prob->Nf; ++f) {
1469b7e05686SMatthew G. Knepley     for (g = 0; g < prob->Nf; ++g) {
1470b7e05686SMatthew G. Knepley       for (h = 0; h < 4; ++h) {
1471b7e05686SMatthew G. Knepley         if (prob->gt[(f*prob->Nf + g)*4+h]) *hasDynJac = PETSC_TRUE;
1472b7e05686SMatthew G. Knepley       }
1473b7e05686SMatthew G. Knepley     }
1474b7e05686SMatthew G. Knepley   }
1475b7e05686SMatthew G. Knepley   PetscFunctionReturn(0);
1476b7e05686SMatthew G. Knepley }
1477b7e05686SMatthew G. Knepley 
1478b7e05686SMatthew G. Knepley /*@C
1479b7e05686SMatthew G. Knepley   PetscDSGetDynamicJacobian - Get the pointwise dynamic Jacobian, dF/du_t, function for given test and basis field
1480b7e05686SMatthew G. Knepley 
1481b7e05686SMatthew G. Knepley   Not collective
1482b7e05686SMatthew G. Knepley 
1483b7e05686SMatthew G. Knepley   Input Parameters:
1484b7e05686SMatthew G. Knepley + prob - The PetscDS
1485b7e05686SMatthew G. Knepley . f    - The test field number
1486b7e05686SMatthew G. Knepley - g    - The field number
1487b7e05686SMatthew G. Knepley 
1488b7e05686SMatthew G. Knepley   Output Parameters:
1489b7e05686SMatthew G. Knepley + g0 - integrand for the test and basis function term
1490b7e05686SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1491b7e05686SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1492b7e05686SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1493b7e05686SMatthew G. Knepley 
1494b7e05686SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1495b7e05686SMatthew G. Knepley 
1496b7e05686SMatthew 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
1497b7e05686SMatthew G. Knepley 
1498b7e05686SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1499b7e05686SMatthew G. Knepley 
1500b7e05686SMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1501b7e05686SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1502b7e05686SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1503b7e05686SMatthew G. Knepley $    PetscReal t, const PetscReal u_tShift, const PetscReal x[], PetscScalar g0[])
1504b7e05686SMatthew G. Knepley 
1505b7e05686SMatthew G. Knepley + dim - the spatial dimension
1506b7e05686SMatthew G. Knepley . Nf - the number of fields
1507b7e05686SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1508b7e05686SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1509b7e05686SMatthew G. Knepley . u - each field evaluated at the current point
1510b7e05686SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1511b7e05686SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1512b7e05686SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1513b7e05686SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1514b7e05686SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1515b7e05686SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1516b7e05686SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1517b7e05686SMatthew G. Knepley . t - current time
1518b7e05686SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1519b7e05686SMatthew G. Knepley . x - coordinates of the current point
152097b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
152197b6e6e8SMatthew G. Knepley . constants - constant parameters
1522b7e05686SMatthew G. Knepley - g0 - output values at the current point
1523b7e05686SMatthew G. Knepley 
1524b7e05686SMatthew G. Knepley   Level: intermediate
1525b7e05686SMatthew G. Knepley 
1526b7e05686SMatthew G. Knepley .seealso: PetscDSSetJacobian()
1527b7e05686SMatthew G. Knepley @*/
1528b7e05686SMatthew G. Knepley PetscErrorCode PetscDSGetDynamicJacobian(PetscDS prob, PetscInt f, PetscInt g,
1529b7e05686SMatthew G. Knepley                                          void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1530b7e05686SMatthew G. Knepley                                                      const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1531b7e05686SMatthew G. Knepley                                                      const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
153297b6e6e8SMatthew G. Knepley                                                      PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
1533b7e05686SMatthew G. Knepley                                          void (**g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1534b7e05686SMatthew G. Knepley                                                      const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1535b7e05686SMatthew G. Knepley                                                      const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
153697b6e6e8SMatthew G. Knepley                                                      PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
1537b7e05686SMatthew G. Knepley                                          void (**g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1538b7e05686SMatthew G. Knepley                                                      const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1539b7e05686SMatthew G. Knepley                                                      const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
154097b6e6e8SMatthew G. Knepley                                                      PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
1541b7e05686SMatthew G. Knepley                                          void (**g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1542b7e05686SMatthew G. Knepley                                                      const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1543b7e05686SMatthew G. Knepley                                                      const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
154497b6e6e8SMatthew G. Knepley                                                      PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
1545b7e05686SMatthew G. Knepley {
1546b7e05686SMatthew G. Knepley   PetscFunctionBegin;
1547b7e05686SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1548b7e05686SMatthew 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);
1549b7e05686SMatthew 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);
1550b7e05686SMatthew G. Knepley   if (g0) {PetscValidPointer(g0, 4); *g0 = prob->gt[(f*prob->Nf + g)*4+0];}
1551b7e05686SMatthew G. Knepley   if (g1) {PetscValidPointer(g1, 5); *g1 = prob->gt[(f*prob->Nf + g)*4+1];}
1552b7e05686SMatthew G. Knepley   if (g2) {PetscValidPointer(g2, 6); *g2 = prob->gt[(f*prob->Nf + g)*4+2];}
1553b7e05686SMatthew G. Knepley   if (g3) {PetscValidPointer(g3, 7); *g3 = prob->gt[(f*prob->Nf + g)*4+3];}
1554b7e05686SMatthew G. Knepley   PetscFunctionReturn(0);
1555b7e05686SMatthew G. Knepley }
1556b7e05686SMatthew G. Knepley 
1557b7e05686SMatthew G. Knepley /*@C
1558b7e05686SMatthew G. Knepley   PetscDSSetDynamicJacobian - Set the pointwise dynamic Jacobian, dF/du_t, function for given test and basis fields
1559b7e05686SMatthew G. Knepley 
1560b7e05686SMatthew G. Knepley   Not collective
1561b7e05686SMatthew G. Knepley 
1562b7e05686SMatthew G. Knepley   Input Parameters:
1563b7e05686SMatthew G. Knepley + prob - The PetscDS
1564b7e05686SMatthew G. Knepley . f    - The test field number
1565b7e05686SMatthew G. Knepley . g    - The field number
1566b7e05686SMatthew G. Knepley . g0 - integrand for the test and basis function term
1567b7e05686SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1568b7e05686SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1569b7e05686SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1570b7e05686SMatthew G. Knepley 
1571b7e05686SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1572b7e05686SMatthew G. Knepley 
1573b7e05686SMatthew 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
1574b7e05686SMatthew G. Knepley 
1575b7e05686SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1576b7e05686SMatthew G. Knepley 
1577b7e05686SMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1578b7e05686SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1579b7e05686SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1580b7e05686SMatthew G. Knepley $    PetscReal t, const PetscReal x[], PetscScalar g0[])
1581b7e05686SMatthew G. Knepley 
1582b7e05686SMatthew G. Knepley + dim - the spatial dimension
1583b7e05686SMatthew G. Knepley . Nf - the number of fields
1584b7e05686SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1585b7e05686SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1586b7e05686SMatthew G. Knepley . u - each field evaluated at the current point
1587b7e05686SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1588b7e05686SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1589b7e05686SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1590b7e05686SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1591b7e05686SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1592b7e05686SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1593b7e05686SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1594b7e05686SMatthew G. Knepley . t - current time
1595b7e05686SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1596b7e05686SMatthew G. Knepley . x - coordinates of the current point
159797b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
159897b6e6e8SMatthew G. Knepley . constants - constant parameters
1599b7e05686SMatthew G. Knepley - g0 - output values at the current point
1600b7e05686SMatthew G. Knepley 
1601b7e05686SMatthew G. Knepley   Level: intermediate
1602b7e05686SMatthew G. Knepley 
1603b7e05686SMatthew G. Knepley .seealso: PetscDSGetJacobian()
1604b7e05686SMatthew G. Knepley @*/
1605b7e05686SMatthew G. Knepley PetscErrorCode PetscDSSetDynamicJacobian(PetscDS prob, PetscInt f, PetscInt g,
1606b7e05686SMatthew G. Knepley                                          void (*g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1607b7e05686SMatthew G. Knepley                                                     const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1608b7e05686SMatthew G. Knepley                                                     const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
160997b6e6e8SMatthew G. Knepley                                                     PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
1610b7e05686SMatthew G. Knepley                                          void (*g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1611b7e05686SMatthew G. Knepley                                                     const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1612b7e05686SMatthew G. Knepley                                                     const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
161397b6e6e8SMatthew G. Knepley                                                     PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
1614b7e05686SMatthew G. Knepley                                          void (*g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1615b7e05686SMatthew G. Knepley                                                     const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1616b7e05686SMatthew G. Knepley                                                     const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
161797b6e6e8SMatthew G. Knepley                                                     PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
1618b7e05686SMatthew G. Knepley                                          void (*g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1619b7e05686SMatthew G. Knepley                                                     const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1620b7e05686SMatthew G. Knepley                                                     const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
162197b6e6e8SMatthew G. Knepley                                                     PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
1622b7e05686SMatthew G. Knepley {
1623b7e05686SMatthew G. Knepley   PetscErrorCode ierr;
1624b7e05686SMatthew G. Knepley 
1625b7e05686SMatthew G. Knepley   PetscFunctionBegin;
1626b7e05686SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1627b7e05686SMatthew G. Knepley   if (g0) PetscValidFunction(g0, 4);
1628b7e05686SMatthew G. Knepley   if (g1) PetscValidFunction(g1, 5);
1629b7e05686SMatthew G. Knepley   if (g2) PetscValidFunction(g2, 6);
1630b7e05686SMatthew G. Knepley   if (g3) PetscValidFunction(g3, 7);
1631b7e05686SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
1632b7e05686SMatthew G. Knepley   if (g < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", g);
1633b7e05686SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, PetscMax(f, g)+1);CHKERRQ(ierr);
1634b7e05686SMatthew G. Knepley   prob->gt[(f*prob->Nf + g)*4+0] = g0;
1635b7e05686SMatthew G. Knepley   prob->gt[(f*prob->Nf + g)*4+1] = g1;
1636b7e05686SMatthew G. Knepley   prob->gt[(f*prob->Nf + g)*4+2] = g2;
1637b7e05686SMatthew G. Knepley   prob->gt[(f*prob->Nf + g)*4+3] = g3;
1638b7e05686SMatthew G. Knepley   PetscFunctionReturn(0);
1639b7e05686SMatthew G. Knepley }
1640b7e05686SMatthew G. Knepley 
16410c2f2876SMatthew G. Knepley /*@C
16420c2f2876SMatthew G. Knepley   PetscDSGetRiemannSolver - Returns the Riemann solver for the given field
16430c2f2876SMatthew G. Knepley 
16440c2f2876SMatthew G. Knepley   Not collective
16450c2f2876SMatthew G. Knepley 
16460c2f2876SMatthew G. Knepley   Input Arguments:
16470c2f2876SMatthew G. Knepley + prob - The PetscDS object
16480c2f2876SMatthew G. Knepley - f    - The field number
16490c2f2876SMatthew G. Knepley 
16500c2f2876SMatthew G. Knepley   Output Argument:
16510c2f2876SMatthew G. Knepley . r    - Riemann solver
16520c2f2876SMatthew G. Knepley 
16530c2f2876SMatthew G. Knepley   Calling sequence for r:
16540c2f2876SMatthew G. Knepley 
16555db36cf9SMatthew G. Knepley $ r(PetscInt dim, PetscInt Nf, const PetscReal x[], const PetscReal n[], const PetscScalar uL[], const PetscScalar uR[], PetscScalar flux[], void *ctx)
16560c2f2876SMatthew G. Knepley 
16575db36cf9SMatthew G. Knepley + dim  - The spatial dimension
16585db36cf9SMatthew G. Knepley . Nf   - The number of fields
16595db36cf9SMatthew G. Knepley . x    - The coordinates at a point on the interface
16600c2f2876SMatthew G. Knepley . n    - The normal vector to the interface
16610c2f2876SMatthew G. Knepley . uL   - The state vector to the left of the interface
16620c2f2876SMatthew G. Knepley . uR   - The state vector to the right of the interface
16630c2f2876SMatthew G. Knepley . flux - output array of flux through the interface
166497b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
166597b6e6e8SMatthew G. Knepley . constants - constant parameters
16660c2f2876SMatthew G. Knepley - ctx  - optional user context
16670c2f2876SMatthew G. Knepley 
16680c2f2876SMatthew G. Knepley   Level: intermediate
16690c2f2876SMatthew G. Knepley 
16700c2f2876SMatthew G. Knepley .seealso: PetscDSSetRiemannSolver()
16710c2f2876SMatthew G. Knepley @*/
16720c2f2876SMatthew G. Knepley PetscErrorCode PetscDSGetRiemannSolver(PetscDS prob, PetscInt f,
167397b6e6e8SMatthew 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))
16740c2f2876SMatthew G. Knepley {
16750c2f2876SMatthew G. Knepley   PetscFunctionBegin;
16760c2f2876SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
16770c2f2876SMatthew 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);
16780c2f2876SMatthew G. Knepley   PetscValidPointer(r, 3);
16790c2f2876SMatthew G. Knepley   *r = prob->r[f];
16800c2f2876SMatthew G. Knepley   PetscFunctionReturn(0);
16810c2f2876SMatthew G. Knepley }
16820c2f2876SMatthew G. Knepley 
16830c2f2876SMatthew G. Knepley /*@C
16840c2f2876SMatthew G. Knepley   PetscDSSetRiemannSolver - Sets the Riemann solver for the given field
16850c2f2876SMatthew G. Knepley 
16860c2f2876SMatthew G. Knepley   Not collective
16870c2f2876SMatthew G. Knepley 
16880c2f2876SMatthew G. Knepley   Input Arguments:
16890c2f2876SMatthew G. Knepley + prob - The PetscDS object
16900c2f2876SMatthew G. Knepley . f    - The field number
16910c2f2876SMatthew G. Knepley - r    - Riemann solver
16920c2f2876SMatthew G. Knepley 
16930c2f2876SMatthew G. Knepley   Calling sequence for r:
16940c2f2876SMatthew G. Knepley 
16955db36cf9SMatthew G. Knepley $ r(PetscInt dim, PetscInt Nf, const PetscReal x[], const PetscReal n[], const PetscScalar uL[], const PetscScalar uR[], PetscScalar flux[], void *ctx)
16960c2f2876SMatthew G. Knepley 
16975db36cf9SMatthew G. Knepley + dim  - The spatial dimension
16985db36cf9SMatthew G. Knepley . Nf   - The number of fields
16995db36cf9SMatthew G. Knepley . x    - The coordinates at a point on the interface
17000c2f2876SMatthew G. Knepley . n    - The normal vector to the interface
17010c2f2876SMatthew G. Knepley . uL   - The state vector to the left of the interface
17020c2f2876SMatthew G. Knepley . uR   - The state vector to the right of the interface
17030c2f2876SMatthew G. Knepley . flux - output array of flux through the interface
170497b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
170597b6e6e8SMatthew G. Knepley . constants - constant parameters
17060c2f2876SMatthew G. Knepley - ctx  - optional user context
17070c2f2876SMatthew G. Knepley 
17080c2f2876SMatthew G. Knepley   Level: intermediate
17090c2f2876SMatthew G. Knepley 
17100c2f2876SMatthew G. Knepley .seealso: PetscDSGetRiemannSolver()
17110c2f2876SMatthew G. Knepley @*/
17120c2f2876SMatthew G. Knepley PetscErrorCode PetscDSSetRiemannSolver(PetscDS prob, PetscInt f,
171397b6e6e8SMatthew 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))
17140c2f2876SMatthew G. Knepley {
17150c2f2876SMatthew G. Knepley   PetscErrorCode ierr;
17160c2f2876SMatthew G. Knepley 
17170c2f2876SMatthew G. Knepley   PetscFunctionBegin;
17180c2f2876SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1719de716cbcSToby Isaac   if (r) PetscValidFunction(r, 3);
17200c2f2876SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
17210c2f2876SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
17220c2f2876SMatthew G. Knepley   prob->r[f] = r;
17230c2f2876SMatthew G. Knepley   PetscFunctionReturn(0);
17240c2f2876SMatthew G. Knepley }
17250c2f2876SMatthew G. Knepley 
172632d2bbc9SMatthew G. Knepley /*@C
172732d2bbc9SMatthew G. Knepley   PetscDSGetUpdate - Get the pointwise update function for a given field
172832d2bbc9SMatthew G. Knepley 
172932d2bbc9SMatthew G. Knepley   Not collective
173032d2bbc9SMatthew G. Knepley 
173132d2bbc9SMatthew G. Knepley   Input Parameters:
173232d2bbc9SMatthew G. Knepley + prob - The PetscDS
173332d2bbc9SMatthew G. Knepley - f    - The field number
173432d2bbc9SMatthew G. Knepley 
173532d2bbc9SMatthew G. Knepley   Output Parameters:
173632d2bbc9SMatthew G. Knepley + update - update function
173732d2bbc9SMatthew G. Knepley 
173832d2bbc9SMatthew G. Knepley   Note: The calling sequence for the callback update is given by:
173932d2bbc9SMatthew G. Knepley 
174032d2bbc9SMatthew G. Knepley $ update(PetscInt dim, PetscInt Nf, PetscInt NfAux,
174132d2bbc9SMatthew G. Knepley $        const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
174232d2bbc9SMatthew G. Knepley $        const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
174332d2bbc9SMatthew G. Knepley $        PetscReal t, const PetscReal x[], PetscScalar uNew[])
174432d2bbc9SMatthew G. Knepley 
174532d2bbc9SMatthew G. Knepley + dim - the spatial dimension
174632d2bbc9SMatthew G. Knepley . Nf - the number of fields
174732d2bbc9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
174832d2bbc9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
174932d2bbc9SMatthew G. Knepley . u - each field evaluated at the current point
175032d2bbc9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
175132d2bbc9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
175232d2bbc9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
175332d2bbc9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
175432d2bbc9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
175532d2bbc9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
175632d2bbc9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
175732d2bbc9SMatthew G. Knepley . t - current time
175832d2bbc9SMatthew G. Knepley . x - coordinates of the current point
175932d2bbc9SMatthew G. Knepley - uNew - new value for field at the current point
176032d2bbc9SMatthew G. Knepley 
176132d2bbc9SMatthew G. Knepley   Level: intermediate
176232d2bbc9SMatthew G. Knepley 
176332d2bbc9SMatthew G. Knepley .seealso: PetscDSSetUpdate(), PetscDSSetResidual()
176432d2bbc9SMatthew G. Knepley @*/
176532d2bbc9SMatthew G. Knepley PetscErrorCode PetscDSGetUpdate(PetscDS prob, PetscInt f,
176632d2bbc9SMatthew G. Knepley                                   void (**update)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
176732d2bbc9SMatthew G. Knepley                                                   const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
176832d2bbc9SMatthew G. Knepley                                                   const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
17693fa77dffSMatthew G. Knepley                                                   PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar uNew[]))
177032d2bbc9SMatthew G. Knepley {
177132d2bbc9SMatthew G. Knepley   PetscFunctionBegin;
177232d2bbc9SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
177332d2bbc9SMatthew 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);
177432d2bbc9SMatthew G. Knepley   if (update) {PetscValidPointer(update, 3); *update = prob->update[f];}
177532d2bbc9SMatthew G. Knepley   PetscFunctionReturn(0);
177632d2bbc9SMatthew G. Knepley }
177732d2bbc9SMatthew G. Knepley 
177832d2bbc9SMatthew G. Knepley /*@C
17793fa77dffSMatthew G. Knepley   PetscDSSetUpdate - Set the pointwise update function for a given field
178032d2bbc9SMatthew G. Knepley 
178132d2bbc9SMatthew G. Knepley   Not collective
178232d2bbc9SMatthew G. Knepley 
178332d2bbc9SMatthew G. Knepley   Input Parameters:
178432d2bbc9SMatthew G. Knepley + prob   - The PetscDS
178532d2bbc9SMatthew G. Knepley . f      - The field number
178632d2bbc9SMatthew G. Knepley - update - update function
178732d2bbc9SMatthew G. Knepley 
178832d2bbc9SMatthew G. Knepley   Note: The calling sequence for the callback update is given by:
178932d2bbc9SMatthew G. Knepley 
179032d2bbc9SMatthew G. Knepley $ update(PetscInt dim, PetscInt Nf, PetscInt NfAux,
179132d2bbc9SMatthew G. Knepley $        const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
179232d2bbc9SMatthew G. Knepley $        const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
179332d2bbc9SMatthew G. Knepley $        PetscReal t, const PetscReal x[], PetscScalar uNew[])
179432d2bbc9SMatthew G. Knepley 
179532d2bbc9SMatthew G. Knepley + dim - the spatial dimension
179632d2bbc9SMatthew G. Knepley . Nf - the number of fields
179732d2bbc9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
179832d2bbc9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
179932d2bbc9SMatthew G. Knepley . u - each field evaluated at the current point
180032d2bbc9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
180132d2bbc9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
180232d2bbc9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
180332d2bbc9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
180432d2bbc9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
180532d2bbc9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
180632d2bbc9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
180732d2bbc9SMatthew G. Knepley . t - current time
180832d2bbc9SMatthew G. Knepley . x - coordinates of the current point
180932d2bbc9SMatthew G. Knepley - uNew - new field values at the current point
181032d2bbc9SMatthew G. Knepley 
181132d2bbc9SMatthew G. Knepley   Level: intermediate
181232d2bbc9SMatthew G. Knepley 
181332d2bbc9SMatthew G. Knepley .seealso: PetscDSGetResidual()
181432d2bbc9SMatthew G. Knepley @*/
181532d2bbc9SMatthew G. Knepley PetscErrorCode PetscDSSetUpdate(PetscDS prob, PetscInt f,
181632d2bbc9SMatthew G. Knepley                                 void (*update)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
181732d2bbc9SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
181832d2bbc9SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
18193fa77dffSMatthew G. Knepley                                                PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar uNew[]))
182032d2bbc9SMatthew G. Knepley {
182132d2bbc9SMatthew G. Knepley   PetscErrorCode ierr;
182232d2bbc9SMatthew G. Knepley 
182332d2bbc9SMatthew G. Knepley   PetscFunctionBegin;
182432d2bbc9SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
182532d2bbc9SMatthew G. Knepley   if (update) PetscValidFunction(update, 3);
182632d2bbc9SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
182732d2bbc9SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
182832d2bbc9SMatthew G. Knepley   prob->update[f] = update;
182932d2bbc9SMatthew G. Knepley   PetscFunctionReturn(0);
183032d2bbc9SMatthew G. Knepley }
183132d2bbc9SMatthew G. Knepley 
18320c2f2876SMatthew G. Knepley PetscErrorCode PetscDSGetContext(PetscDS prob, PetscInt f, void **ctx)
18330c2f2876SMatthew G. Knepley {
18340c2f2876SMatthew G. Knepley   PetscFunctionBegin;
18350c2f2876SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
18360c2f2876SMatthew 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);
18370c2f2876SMatthew G. Knepley   PetscValidPointer(ctx, 3);
18380c2f2876SMatthew G. Knepley   *ctx = prob->ctx[f];
18390c2f2876SMatthew G. Knepley   PetscFunctionReturn(0);
18400c2f2876SMatthew G. Knepley }
18410c2f2876SMatthew G. Knepley 
18420c2f2876SMatthew G. Knepley PetscErrorCode PetscDSSetContext(PetscDS prob, PetscInt f, void *ctx)
18430c2f2876SMatthew G. Knepley {
18440c2f2876SMatthew G. Knepley   PetscErrorCode ierr;
18450c2f2876SMatthew G. Knepley 
18460c2f2876SMatthew G. Knepley   PetscFunctionBegin;
18470c2f2876SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
18480c2f2876SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
18490c2f2876SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
18500c2f2876SMatthew G. Knepley   prob->ctx[f] = ctx;
18510c2f2876SMatthew G. Knepley   PetscFunctionReturn(0);
18520c2f2876SMatthew G. Knepley }
18530c2f2876SMatthew G. Knepley 
1854194d53e6SMatthew G. Knepley /*@C
1855194d53e6SMatthew G. Knepley   PetscDSGetBdResidual - Get the pointwise boundary residual function for a given test field
1856194d53e6SMatthew G. Knepley 
1857194d53e6SMatthew G. Knepley   Not collective
1858194d53e6SMatthew G. Knepley 
1859194d53e6SMatthew G. Knepley   Input Parameters:
1860194d53e6SMatthew G. Knepley + prob - The PetscDS
1861194d53e6SMatthew G. Knepley - f    - The test field number
1862194d53e6SMatthew G. Knepley 
1863194d53e6SMatthew G. Knepley   Output Parameters:
1864194d53e6SMatthew G. Knepley + f0 - boundary integrand for the test function term
1865194d53e6SMatthew G. Knepley - f1 - boundary integrand for the test function gradient term
1866194d53e6SMatthew G. Knepley 
1867194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1868194d53e6SMatthew G. Knepley 
1869194d53e6SMatthew 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
1870194d53e6SMatthew G. Knepley 
1871194d53e6SMatthew G. Knepley The calling sequence for the callbacks f0 and f1 is given by:
1872194d53e6SMatthew G. Knepley 
187330b9ff8bSMatthew G. Knepley $ f0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1874194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1875194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
187630b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar f0[])
1877194d53e6SMatthew G. Knepley 
1878194d53e6SMatthew G. Knepley + dim - the spatial dimension
1879194d53e6SMatthew G. Knepley . Nf - the number of fields
1880194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1881194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1882194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
1883194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1884194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1885194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1886194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1887194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1888194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1889194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1890194d53e6SMatthew G. Knepley . t - current time
1891194d53e6SMatthew G. Knepley . x - coordinates of the current point
1892194d53e6SMatthew G. Knepley . n - unit normal at the current point
189397b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
189497b6e6e8SMatthew G. Knepley . constants - constant parameters
1895194d53e6SMatthew G. Knepley - f0 - output values at the current point
1896194d53e6SMatthew G. Knepley 
1897194d53e6SMatthew G. Knepley   Level: intermediate
1898194d53e6SMatthew G. Knepley 
1899194d53e6SMatthew G. Knepley .seealso: PetscDSSetBdResidual()
1900194d53e6SMatthew G. Knepley @*/
19012764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetBdResidual(PetscDS prob, PetscInt f,
190230b9ff8bSMatthew G. Knepley                                     void (**f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1903194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1904194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
190597b6e6e8SMatthew G. Knepley                                                 PetscReal t, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f0[]),
190630b9ff8bSMatthew G. Knepley                                     void (**f1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1907194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1908194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
190997b6e6e8SMatthew G. Knepley                                                 PetscReal t, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f1[]))
19102764a2aaSMatthew G. Knepley {
19112764a2aaSMatthew G. Knepley   PetscFunctionBegin;
19122764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
19132764a2aaSMatthew 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);
19142764a2aaSMatthew G. Knepley   if (f0) {PetscValidPointer(f0, 3); *f0 = prob->fBd[f*2+0];}
19152764a2aaSMatthew G. Knepley   if (f1) {PetscValidPointer(f1, 4); *f1 = prob->fBd[f*2+1];}
19162764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
19172764a2aaSMatthew G. Knepley }
19182764a2aaSMatthew G. Knepley 
1919194d53e6SMatthew G. Knepley /*@C
1920194d53e6SMatthew G. Knepley   PetscDSSetBdResidual - Get the pointwise boundary residual function for a given test field
1921194d53e6SMatthew G. Knepley 
1922194d53e6SMatthew G. Knepley   Not collective
1923194d53e6SMatthew G. Knepley 
1924194d53e6SMatthew G. Knepley   Input Parameters:
1925194d53e6SMatthew G. Knepley + prob - The PetscDS
1926194d53e6SMatthew G. Knepley . f    - The test field number
1927194d53e6SMatthew G. Knepley . f0 - boundary integrand for the test function term
1928194d53e6SMatthew G. Knepley - f1 - boundary integrand for the test function gradient term
1929194d53e6SMatthew G. Knepley 
1930194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1931194d53e6SMatthew G. Knepley 
1932194d53e6SMatthew 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
1933194d53e6SMatthew G. Knepley 
1934194d53e6SMatthew G. Knepley The calling sequence for the callbacks f0 and f1 is given by:
1935194d53e6SMatthew G. Knepley 
193630b9ff8bSMatthew G. Knepley $ f0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1937194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1938194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
193930b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar f0[])
1940194d53e6SMatthew G. Knepley 
1941194d53e6SMatthew G. Knepley + dim - the spatial dimension
1942194d53e6SMatthew G. Knepley . Nf - the number of fields
1943194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1944194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1945194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
1946194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1947194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1948194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1949194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1950194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1951194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1952194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1953194d53e6SMatthew G. Knepley . t - current time
1954194d53e6SMatthew G. Knepley . x - coordinates of the current point
1955194d53e6SMatthew G. Knepley . n - unit normal at the current point
195697b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
195797b6e6e8SMatthew G. Knepley . constants - constant parameters
1958194d53e6SMatthew G. Knepley - f0 - output values at the current point
1959194d53e6SMatthew G. Knepley 
1960194d53e6SMatthew G. Knepley   Level: intermediate
1961194d53e6SMatthew G. Knepley 
1962194d53e6SMatthew G. Knepley .seealso: PetscDSGetBdResidual()
1963194d53e6SMatthew G. Knepley @*/
19642764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetBdResidual(PetscDS prob, PetscInt f,
196530b9ff8bSMatthew G. Knepley                                     void (*f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1966194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1967194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
196897b6e6e8SMatthew G. Knepley                                                PetscReal t, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f0[]),
196930b9ff8bSMatthew G. Knepley                                     void (*f1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1970194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1971194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
197297b6e6e8SMatthew G. Knepley                                                PetscReal t, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f1[]))
19732764a2aaSMatthew G. Knepley {
19742764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
19752764a2aaSMatthew G. Knepley 
19762764a2aaSMatthew G. Knepley   PetscFunctionBegin;
19772764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
19782764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
19792764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
19802764a2aaSMatthew G. Knepley   if (f0) {PetscValidFunction(f0, 3); prob->fBd[f*2+0] = f0;}
19812764a2aaSMatthew G. Knepley   if (f1) {PetscValidFunction(f1, 4); prob->fBd[f*2+1] = f1;}
19822764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
19832764a2aaSMatthew G. Knepley }
19842764a2aaSMatthew G. Knepley 
1985194d53e6SMatthew G. Knepley /*@C
1986194d53e6SMatthew G. Knepley   PetscDSGetBdJacobian - Get the pointwise boundary Jacobian function for given test and basis field
1987194d53e6SMatthew G. Knepley 
1988194d53e6SMatthew G. Knepley   Not collective
1989194d53e6SMatthew G. Knepley 
1990194d53e6SMatthew G. Knepley   Input Parameters:
1991194d53e6SMatthew G. Knepley + prob - The PetscDS
1992194d53e6SMatthew G. Knepley . f    - The test field number
1993194d53e6SMatthew G. Knepley - g    - The field number
1994194d53e6SMatthew G. Knepley 
1995194d53e6SMatthew G. Knepley   Output Parameters:
1996194d53e6SMatthew G. Knepley + g0 - integrand for the test and basis function term
1997194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1998194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1999194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
2000194d53e6SMatthew G. Knepley 
2001194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
2002194d53e6SMatthew G. Knepley 
2003194d53e6SMatthew 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
2004194d53e6SMatthew G. Knepley 
2005194d53e6SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
2006194d53e6SMatthew G. Knepley 
200730b9ff8bSMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2008194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2009194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
201030b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar g0[])
2011194d53e6SMatthew G. Knepley 
2012194d53e6SMatthew G. Knepley + dim - the spatial dimension
2013194d53e6SMatthew G. Knepley . Nf - the number of fields
2014194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
2015194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
2016194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
2017194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
2018194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
2019194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
2020194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
2021194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
2022194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
2023194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
2024194d53e6SMatthew G. Knepley . t - current time
20252aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
2026194d53e6SMatthew G. Knepley . x - coordinates of the current point
2027194d53e6SMatthew G. Knepley . n - normal at the current point
202897b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
202997b6e6e8SMatthew G. Knepley . constants - constant parameters
2030194d53e6SMatthew G. Knepley - g0 - output values at the current point
2031194d53e6SMatthew G. Knepley 
2032194d53e6SMatthew G. Knepley   Level: intermediate
2033194d53e6SMatthew G. Knepley 
2034194d53e6SMatthew G. Knepley .seealso: PetscDSSetBdJacobian()
2035194d53e6SMatthew G. Knepley @*/
20362764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetBdJacobian(PetscDS prob, PetscInt f, PetscInt g,
203730b9ff8bSMatthew G. Knepley                                     void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2038194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2039194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
204097b6e6e8SMatthew G. Knepley                                                 PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
204130b9ff8bSMatthew G. Knepley                                     void (**g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2042194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2043194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
204497b6e6e8SMatthew G. Knepley                                                 PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
204530b9ff8bSMatthew G. Knepley                                     void (**g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2046194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2047194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
204897b6e6e8SMatthew G. Knepley                                                 PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
204930b9ff8bSMatthew G. Knepley                                     void (**g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2050194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2051194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
205297b6e6e8SMatthew G. Knepley                                                 PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
20532764a2aaSMatthew G. Knepley {
20542764a2aaSMatthew G. Knepley   PetscFunctionBegin;
20552764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
20562764a2aaSMatthew 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);
20572764a2aaSMatthew 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);
20582764a2aaSMatthew G. Knepley   if (g0) {PetscValidPointer(g0, 4); *g0 = prob->gBd[(f*prob->Nf + g)*4+0];}
20592764a2aaSMatthew G. Knepley   if (g1) {PetscValidPointer(g1, 5); *g1 = prob->gBd[(f*prob->Nf + g)*4+1];}
20602764a2aaSMatthew G. Knepley   if (g2) {PetscValidPointer(g2, 6); *g2 = prob->gBd[(f*prob->Nf + g)*4+2];}
20612764a2aaSMatthew G. Knepley   if (g3) {PetscValidPointer(g3, 7); *g3 = prob->gBd[(f*prob->Nf + g)*4+3];}
20622764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
20632764a2aaSMatthew G. Knepley }
20642764a2aaSMatthew G. Knepley 
2065194d53e6SMatthew G. Knepley /*@C
2066194d53e6SMatthew G. Knepley   PetscDSSetBdJacobian - Set the pointwise boundary Jacobian function for given test and basis field
2067194d53e6SMatthew G. Knepley 
2068194d53e6SMatthew G. Knepley   Not collective
2069194d53e6SMatthew G. Knepley 
2070194d53e6SMatthew G. Knepley   Input Parameters:
2071194d53e6SMatthew G. Knepley + prob - The PetscDS
2072194d53e6SMatthew G. Knepley . f    - The test field number
2073194d53e6SMatthew G. Knepley . g    - The field number
2074194d53e6SMatthew G. Knepley . g0 - integrand for the test and basis function term
2075194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
2076194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
2077194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
2078194d53e6SMatthew G. Knepley 
2079194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
2080194d53e6SMatthew G. Knepley 
2081194d53e6SMatthew 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
2082194d53e6SMatthew G. Knepley 
2083194d53e6SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
2084194d53e6SMatthew G. Knepley 
208530b9ff8bSMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2086194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2087194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
208830b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar g0[])
2089194d53e6SMatthew G. Knepley 
2090194d53e6SMatthew G. Knepley + dim - the spatial dimension
2091194d53e6SMatthew G. Knepley . Nf - the number of fields
2092194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
2093194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
2094194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
2095194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
2096194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
2097194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
2098194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
2099194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
2100194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
2101194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
2102194d53e6SMatthew G. Knepley . t - current time
21032aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
2104194d53e6SMatthew G. Knepley . x - coordinates of the current point
2105194d53e6SMatthew G. Knepley . n - normal at the current point
210697b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
210797b6e6e8SMatthew G. Knepley . constants - constant parameters
2108194d53e6SMatthew G. Knepley - g0 - output values at the current point
2109194d53e6SMatthew G. Knepley 
2110194d53e6SMatthew G. Knepley   Level: intermediate
2111194d53e6SMatthew G. Knepley 
2112194d53e6SMatthew G. Knepley .seealso: PetscDSGetBdJacobian()
2113194d53e6SMatthew G. Knepley @*/
21142764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetBdJacobian(PetscDS prob, PetscInt f, PetscInt g,
211530b9ff8bSMatthew G. Knepley                                     void (*g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2116194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2117194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
211897b6e6e8SMatthew G. Knepley                                                PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
211930b9ff8bSMatthew G. Knepley                                     void (*g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2120194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2121194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
212297b6e6e8SMatthew G. Knepley                                                PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
212330b9ff8bSMatthew G. Knepley                                     void (*g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2124194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2125194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
212697b6e6e8SMatthew G. Knepley                                                PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
212730b9ff8bSMatthew G. Knepley                                     void (*g3)(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 g3[]))
21312764a2aaSMatthew G. Knepley {
21322764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
21332764a2aaSMatthew G. Knepley 
21342764a2aaSMatthew G. Knepley   PetscFunctionBegin;
21352764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
21362764a2aaSMatthew G. Knepley   if (g0) PetscValidFunction(g0, 4);
21372764a2aaSMatthew G. Knepley   if (g1) PetscValidFunction(g1, 5);
21382764a2aaSMatthew G. Knepley   if (g2) PetscValidFunction(g2, 6);
21392764a2aaSMatthew G. Knepley   if (g3) PetscValidFunction(g3, 7);
21402764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
21412764a2aaSMatthew G. Knepley   if (g < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", g);
21422764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, PetscMax(f, g)+1);CHKERRQ(ierr);
21432764a2aaSMatthew G. Knepley   prob->gBd[(f*prob->Nf + g)*4+0] = g0;
21442764a2aaSMatthew G. Knepley   prob->gBd[(f*prob->Nf + g)*4+1] = g1;
21452764a2aaSMatthew G. Knepley   prob->gBd[(f*prob->Nf + g)*4+2] = g2;
21462764a2aaSMatthew G. Knepley   prob->gBd[(f*prob->Nf + g)*4+3] = g3;
21472764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
21482764a2aaSMatthew G. Knepley }
21492764a2aaSMatthew G. Knepley 
21500d3e9b51SMatthew G. Knepley /*@C
2151c371a6d1SMatthew G. Knepley   PetscDSGetExactSolution - Get the pointwise exact solution function for a given test field
2152c371a6d1SMatthew G. Knepley 
2153c371a6d1SMatthew G. Knepley   Not collective
2154c371a6d1SMatthew G. Knepley 
2155c371a6d1SMatthew G. Knepley   Input Parameters:
2156c371a6d1SMatthew G. Knepley + prob - The PetscDS
2157c371a6d1SMatthew G. Knepley - f    - The test field number
2158c371a6d1SMatthew G. Knepley 
2159c371a6d1SMatthew G. Knepley   Output Parameter:
2160c371a6d1SMatthew G. Knepley . exactSol - exact solution for the test field
2161c371a6d1SMatthew G. Knepley 
2162c371a6d1SMatthew G. Knepley   Note: The calling sequence for the solution functions is given by:
2163c371a6d1SMatthew G. Knepley 
2164c371a6d1SMatthew G. Knepley $ sol(PetscInt dim, PetscReal t, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx)
2165c371a6d1SMatthew G. Knepley 
2166c371a6d1SMatthew G. Knepley + dim - the spatial dimension
2167c371a6d1SMatthew G. Knepley . t - current time
2168c371a6d1SMatthew G. Knepley . x - coordinates of the current point
2169c371a6d1SMatthew G. Knepley . Nc - the number of field components
2170c371a6d1SMatthew G. Knepley . u - the solution field evaluated at the current point
2171c371a6d1SMatthew G. Knepley - ctx - a user context
2172c371a6d1SMatthew G. Knepley 
2173c371a6d1SMatthew G. Knepley   Level: intermediate
2174c371a6d1SMatthew G. Knepley 
2175c371a6d1SMatthew G. Knepley .seealso: PetscDSSetExactSolution()
2176c371a6d1SMatthew G. Knepley @*/
2177c371a6d1SMatthew G. Knepley PetscErrorCode PetscDSGetExactSolution(PetscDS prob, PetscInt f, PetscErrorCode (**sol)(PetscInt dim, PetscReal t, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx))
2178c371a6d1SMatthew G. Knepley {
2179c371a6d1SMatthew G. Knepley   PetscFunctionBegin;
2180c371a6d1SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2181c371a6d1SMatthew 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);
2182c371a6d1SMatthew G. Knepley   if (sol) {PetscValidPointer(sol, 3); *sol = prob->exactSol[f];}
2183c371a6d1SMatthew G. Knepley   PetscFunctionReturn(0);
2184c371a6d1SMatthew G. Knepley }
2185c371a6d1SMatthew G. Knepley 
2186c371a6d1SMatthew G. Knepley /*@C
2187c371a6d1SMatthew G. Knepley   PetscDSSetExactSolution - Get the pointwise exact solution function for a given test field
2188c371a6d1SMatthew G. Knepley 
2189c371a6d1SMatthew G. Knepley   Not collective
2190c371a6d1SMatthew G. Knepley 
2191c371a6d1SMatthew G. Knepley   Input Parameters:
2192c371a6d1SMatthew G. Knepley + prob - The PetscDS
2193c371a6d1SMatthew G. Knepley . f    - The test field number
2194c371a6d1SMatthew G. Knepley - sol  - solution function for the test fields
2195c371a6d1SMatthew G. Knepley 
2196c371a6d1SMatthew G. Knepley   Note: The calling sequence for solution functions is given by:
2197c371a6d1SMatthew G. Knepley 
2198c371a6d1SMatthew G. Knepley $ sol(PetscInt dim, PetscReal t, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx)
2199c371a6d1SMatthew G. Knepley 
2200c371a6d1SMatthew G. Knepley + dim - the spatial dimension
2201c371a6d1SMatthew G. Knepley . t - current time
2202c371a6d1SMatthew G. Knepley . x - coordinates of the current point
2203c371a6d1SMatthew G. Knepley . Nc - the number of field components
2204c371a6d1SMatthew G. Knepley . u - the solution field evaluated at the current point
2205c371a6d1SMatthew G. Knepley - ctx - a user context
2206c371a6d1SMatthew G. Knepley 
2207c371a6d1SMatthew G. Knepley   Level: intermediate
2208c371a6d1SMatthew G. Knepley 
2209c371a6d1SMatthew G. Knepley .seealso: PetscDSGetExactSolution()
2210c371a6d1SMatthew G. Knepley @*/
2211c371a6d1SMatthew G. Knepley PetscErrorCode PetscDSSetExactSolution(PetscDS prob, PetscInt f, PetscErrorCode (*sol)(PetscInt dim, PetscReal t, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx))
2212c371a6d1SMatthew G. Knepley {
2213c371a6d1SMatthew G. Knepley   PetscErrorCode ierr;
2214c371a6d1SMatthew G. Knepley 
2215c371a6d1SMatthew G. Knepley   PetscFunctionBegin;
2216c371a6d1SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2217c371a6d1SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
2218c371a6d1SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
2219c371a6d1SMatthew G. Knepley   if (sol) {PetscValidFunction(sol, 3); prob->exactSol[f] = sol;}
2220c371a6d1SMatthew G. Knepley   PetscFunctionReturn(0);
2221c371a6d1SMatthew G. Knepley }
2222c371a6d1SMatthew G. Knepley 
22235638fd0eSMatthew G. Knepley /*@C
222497b6e6e8SMatthew G. Knepley   PetscDSGetConstants - Returns the array of constants passed to point functions
222597b6e6e8SMatthew G. Knepley 
222697b6e6e8SMatthew G. Knepley   Not collective
222797b6e6e8SMatthew G. Knepley 
222897b6e6e8SMatthew G. Knepley   Input Parameter:
222997b6e6e8SMatthew G. Knepley . prob - The PetscDS object
223097b6e6e8SMatthew G. Knepley 
223197b6e6e8SMatthew G. Knepley   Output Parameters:
223297b6e6e8SMatthew G. Knepley + numConstants - The number of constants
223397b6e6e8SMatthew G. Knepley - constants    - The array of constants, NULL if there are none
223497b6e6e8SMatthew G. Knepley 
223597b6e6e8SMatthew G. Knepley   Level: intermediate
223697b6e6e8SMatthew G. Knepley 
223797b6e6e8SMatthew G. Knepley .seealso: PetscDSSetConstants(), PetscDSCreate()
223897b6e6e8SMatthew G. Knepley @*/
223997b6e6e8SMatthew G. Knepley PetscErrorCode PetscDSGetConstants(PetscDS prob, PetscInt *numConstants, const PetscScalar *constants[])
224097b6e6e8SMatthew G. Knepley {
224197b6e6e8SMatthew G. Knepley   PetscFunctionBegin;
224297b6e6e8SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
224397b6e6e8SMatthew G. Knepley   if (numConstants) {PetscValidPointer(numConstants, 2); *numConstants = prob->numConstants;}
224497b6e6e8SMatthew G. Knepley   if (constants)    {PetscValidPointer(constants, 3);    *constants    = prob->constants;}
224597b6e6e8SMatthew G. Knepley   PetscFunctionReturn(0);
224697b6e6e8SMatthew G. Knepley }
224797b6e6e8SMatthew G. Knepley 
22480d3e9b51SMatthew G. Knepley /*@C
224997b6e6e8SMatthew G. Knepley   PetscDSSetConstants - Set the array of constants passed to point functions
225097b6e6e8SMatthew G. Knepley 
225197b6e6e8SMatthew G. Knepley   Not collective
225297b6e6e8SMatthew G. Knepley 
225397b6e6e8SMatthew G. Knepley   Input Parameters:
225497b6e6e8SMatthew G. Knepley + prob         - The PetscDS object
225597b6e6e8SMatthew G. Knepley . numConstants - The number of constants
225697b6e6e8SMatthew G. Knepley - constants    - The array of constants, NULL if there are none
225797b6e6e8SMatthew G. Knepley 
225897b6e6e8SMatthew G. Knepley   Level: intermediate
225997b6e6e8SMatthew G. Knepley 
226097b6e6e8SMatthew G. Knepley .seealso: PetscDSGetConstants(), PetscDSCreate()
226197b6e6e8SMatthew G. Knepley @*/
226297b6e6e8SMatthew G. Knepley PetscErrorCode PetscDSSetConstants(PetscDS prob, PetscInt numConstants, PetscScalar constants[])
226397b6e6e8SMatthew G. Knepley {
226497b6e6e8SMatthew G. Knepley   PetscErrorCode ierr;
226597b6e6e8SMatthew G. Knepley 
226697b6e6e8SMatthew G. Knepley   PetscFunctionBegin;
226797b6e6e8SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
226897b6e6e8SMatthew G. Knepley   if (numConstants != prob->numConstants) {
226997b6e6e8SMatthew G. Knepley     ierr = PetscFree(prob->constants);CHKERRQ(ierr);
227097b6e6e8SMatthew G. Knepley     prob->numConstants = numConstants;
227197b6e6e8SMatthew G. Knepley     if (prob->numConstants) {
227297b6e6e8SMatthew G. Knepley       ierr = PetscMalloc1(prob->numConstants, &prob->constants);CHKERRQ(ierr);
227320be0f5bSMatthew G. Knepley     } else {
227420be0f5bSMatthew G. Knepley       prob->constants = NULL;
227520be0f5bSMatthew G. Knepley     }
227620be0f5bSMatthew G. Knepley   }
227720be0f5bSMatthew G. Knepley   if (prob->numConstants) {
227820be0f5bSMatthew G. Knepley     PetscValidPointer(constants, 3);
227997b6e6e8SMatthew G. Knepley     ierr = PetscMemcpy(prob->constants, constants, prob->numConstants * sizeof(PetscScalar));CHKERRQ(ierr);
228097b6e6e8SMatthew G. Knepley   }
228197b6e6e8SMatthew G. Knepley   PetscFunctionReturn(0);
228297b6e6e8SMatthew G. Knepley }
228397b6e6e8SMatthew G. Knepley 
22844cd1e086SMatthew G. Knepley /*@
22854cd1e086SMatthew G. Knepley   PetscDSGetFieldIndex - Returns the index of the given field
22864cd1e086SMatthew G. Knepley 
22874cd1e086SMatthew G. Knepley   Not collective
22884cd1e086SMatthew G. Knepley 
22894cd1e086SMatthew G. Knepley   Input Parameters:
22904cd1e086SMatthew G. Knepley + prob - The PetscDS object
22914cd1e086SMatthew G. Knepley - disc - The discretization object
22924cd1e086SMatthew G. Knepley 
22934cd1e086SMatthew G. Knepley   Output Parameter:
22944cd1e086SMatthew G. Knepley . f - The field number
22954cd1e086SMatthew G. Knepley 
22964cd1e086SMatthew G. Knepley   Level: beginner
22974cd1e086SMatthew G. Knepley 
2298f744cafaSSander Arens .seealso: PetscGetDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
22994cd1e086SMatthew G. Knepley @*/
23004cd1e086SMatthew G. Knepley PetscErrorCode PetscDSGetFieldIndex(PetscDS prob, PetscObject disc, PetscInt *f)
23014cd1e086SMatthew G. Knepley {
23024cd1e086SMatthew G. Knepley   PetscInt g;
23034cd1e086SMatthew G. Knepley 
23044cd1e086SMatthew G. Knepley   PetscFunctionBegin;
23054cd1e086SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
23064cd1e086SMatthew G. Knepley   PetscValidPointer(f, 3);
23074cd1e086SMatthew G. Knepley   *f = -1;
23084cd1e086SMatthew G. Knepley   for (g = 0; g < prob->Nf; ++g) {if (disc == prob->disc[g]) break;}
23094cd1e086SMatthew G. Knepley   if (g == prob->Nf) SETERRQ(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Field not found in PetscDS.");
23104cd1e086SMatthew G. Knepley   *f = g;
23114cd1e086SMatthew G. Knepley   PetscFunctionReturn(0);
23124cd1e086SMatthew G. Knepley }
23134cd1e086SMatthew G. Knepley 
23144cd1e086SMatthew G. Knepley /*@
23154cd1e086SMatthew G. Knepley   PetscDSGetFieldSize - Returns the size of the given field in the full space basis
23164cd1e086SMatthew G. Knepley 
23174cd1e086SMatthew G. Knepley   Not collective
23184cd1e086SMatthew G. Knepley 
23194cd1e086SMatthew G. Knepley   Input Parameters:
23204cd1e086SMatthew G. Knepley + prob - The PetscDS object
23214cd1e086SMatthew G. Knepley - f - The field number
23224cd1e086SMatthew G. Knepley 
23234cd1e086SMatthew G. Knepley   Output Parameter:
23244cd1e086SMatthew G. Knepley . size - The size
23254cd1e086SMatthew G. Knepley 
23264cd1e086SMatthew G. Knepley   Level: beginner
23274cd1e086SMatthew G. Knepley 
2328f744cafaSSander Arens .seealso: PetscDSGetFieldOffset(), PetscDSGetNumFields(), PetscDSCreate()
23294cd1e086SMatthew G. Knepley @*/
23304cd1e086SMatthew G. Knepley PetscErrorCode PetscDSGetFieldSize(PetscDS prob, PetscInt f, PetscInt *size)
23314cd1e086SMatthew G. Knepley {
23322166fd64SMatthew G. Knepley   PetscErrorCode ierr;
23332166fd64SMatthew G. Knepley 
23344cd1e086SMatthew G. Knepley   PetscFunctionBegin;
23354cd1e086SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
23364cd1e086SMatthew G. Knepley   PetscValidPointer(size, 3);
23374cd1e086SMatthew 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);
23382166fd64SMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
2339d4742ddaSMatthew G. Knepley   *size = prob->Nb[f];
23404cd1e086SMatthew G. Knepley   PetscFunctionReturn(0);
23414cd1e086SMatthew G. Knepley }
23424cd1e086SMatthew G. Knepley 
2343bc4ae4beSMatthew G. Knepley /*@
2344bc4ae4beSMatthew G. Knepley   PetscDSGetFieldOffset - Returns the offset of the given field in the full space basis
2345bc4ae4beSMatthew G. Knepley 
2346bc4ae4beSMatthew G. Knepley   Not collective
2347bc4ae4beSMatthew G. Knepley 
2348bc4ae4beSMatthew G. Knepley   Input Parameters:
2349bc4ae4beSMatthew G. Knepley + prob - The PetscDS object
2350bc4ae4beSMatthew G. Knepley - f - The field number
2351bc4ae4beSMatthew G. Knepley 
2352bc4ae4beSMatthew G. Knepley   Output Parameter:
2353bc4ae4beSMatthew G. Knepley . off - The offset
2354bc4ae4beSMatthew G. Knepley 
2355bc4ae4beSMatthew G. Knepley   Level: beginner
2356bc4ae4beSMatthew G. Knepley 
2357f744cafaSSander Arens .seealso: PetscDSGetFieldSize(), PetscDSGetNumFields(), PetscDSCreate()
2358bc4ae4beSMatthew G. Knepley @*/
23592764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetFieldOffset(PetscDS prob, PetscInt f, PetscInt *off)
23602764a2aaSMatthew G. Knepley {
23614cd1e086SMatthew G. Knepley   PetscInt       size, g;
23622764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
23632764a2aaSMatthew G. Knepley 
23642764a2aaSMatthew G. Knepley   PetscFunctionBegin;
23652764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
23662764a2aaSMatthew G. Knepley   PetscValidPointer(off, 3);
23672764a2aaSMatthew 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);
23682764a2aaSMatthew G. Knepley   *off = 0;
23692764a2aaSMatthew G. Knepley   for (g = 0; g < f; ++g) {
23704cd1e086SMatthew G. Knepley     ierr = PetscDSGetFieldSize(prob, g, &size);CHKERRQ(ierr);
23714cd1e086SMatthew G. Knepley     *off += size;
23722764a2aaSMatthew G. Knepley   }
23732764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
23742764a2aaSMatthew G. Knepley }
23752764a2aaSMatthew G. Knepley 
2376bc4ae4beSMatthew G. Knepley /*@
237747e57110SSander Arens   PetscDSGetDimensions - Returns the size of the approximation space for each field on an evaluation point
2378bc4ae4beSMatthew G. Knepley 
2379bc4ae4beSMatthew G. Knepley   Not collective
2380bc4ae4beSMatthew G. Knepley 
238147e57110SSander Arens   Input Parameter:
238247e57110SSander Arens . prob - The PetscDS object
2383bc4ae4beSMatthew G. Knepley 
2384bc4ae4beSMatthew G. Knepley   Output Parameter:
238547e57110SSander Arens . dimensions - The number of dimensions
2386bc4ae4beSMatthew G. Knepley 
2387bc4ae4beSMatthew G. Knepley   Level: beginner
2388bc4ae4beSMatthew G. Knepley 
238947e57110SSander Arens .seealso: PetscDSGetComponentOffsets(), PetscDSGetNumFields(), PetscDSCreate()
2390bc4ae4beSMatthew G. Knepley @*/
239147e57110SSander Arens PetscErrorCode PetscDSGetDimensions(PetscDS prob, PetscInt *dimensions[])
23922764a2aaSMatthew G. Knepley {
23932764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
23942764a2aaSMatthew G. Knepley 
23952764a2aaSMatthew G. Knepley   PetscFunctionBegin;
23962764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
239747e57110SSander Arens   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
239847e57110SSander Arens   PetscValidPointer(dimensions, 2);
239947e57110SSander Arens   *dimensions = prob->Nb;
240047e57110SSander Arens   PetscFunctionReturn(0);
24016ce16762SMatthew G. Knepley }
240247e57110SSander Arens 
240347e57110SSander Arens /*@
240447e57110SSander Arens   PetscDSGetComponents - Returns the number of components for each field on an evaluation point
240547e57110SSander Arens 
240647e57110SSander Arens   Not collective
240747e57110SSander Arens 
240847e57110SSander Arens   Input Parameter:
240947e57110SSander Arens . prob - The PetscDS object
241047e57110SSander Arens 
241147e57110SSander Arens   Output Parameter:
241247e57110SSander Arens . components - The number of components
241347e57110SSander Arens 
241447e57110SSander Arens   Level: beginner
241547e57110SSander Arens 
241647e57110SSander Arens .seealso: PetscDSGetComponentOffsets(), PetscDSGetNumFields(), PetscDSCreate()
241747e57110SSander Arens @*/
241847e57110SSander Arens PetscErrorCode PetscDSGetComponents(PetscDS prob, PetscInt *components[])
241947e57110SSander Arens {
242047e57110SSander Arens   PetscErrorCode ierr;
242147e57110SSander Arens 
242247e57110SSander Arens   PetscFunctionBegin;
242347e57110SSander Arens   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
242447e57110SSander Arens   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
242547e57110SSander Arens   PetscValidPointer(components, 2);
242647e57110SSander Arens   *components = prob->Nc;
24276ce16762SMatthew G. Knepley   PetscFunctionReturn(0);
24286ce16762SMatthew G. Knepley }
24296ce16762SMatthew G. Knepley 
24306ce16762SMatthew G. Knepley /*@
24316ce16762SMatthew G. Knepley   PetscDSGetComponentOffset - Returns the offset of the given field on an evaluation point
24326ce16762SMatthew G. Knepley 
24336ce16762SMatthew G. Knepley   Not collective
24346ce16762SMatthew G. Knepley 
24356ce16762SMatthew G. Knepley   Input Parameters:
24366ce16762SMatthew G. Knepley + prob - The PetscDS object
24376ce16762SMatthew G. Knepley - f - The field number
24386ce16762SMatthew G. Knepley 
24396ce16762SMatthew G. Knepley   Output Parameter:
24406ce16762SMatthew G. Knepley . off - The offset
24416ce16762SMatthew G. Knepley 
24426ce16762SMatthew G. Knepley   Level: beginner
24436ce16762SMatthew G. Knepley 
2444f744cafaSSander Arens .seealso: PetscDSGetNumFields(), PetscDSCreate()
24456ce16762SMatthew G. Knepley @*/
24466ce16762SMatthew G. Knepley PetscErrorCode PetscDSGetComponentOffset(PetscDS prob, PetscInt f, PetscInt *off)
24476ce16762SMatthew G. Knepley {
24486ce16762SMatthew G. Knepley   PetscFunctionBegin;
24496ce16762SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
24506ce16762SMatthew G. Knepley   PetscValidPointer(off, 3);
24516ce16762SMatthew 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);
245247e57110SSander Arens   *off = prob->off[f];
24532764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
24542764a2aaSMatthew G. Knepley }
24552764a2aaSMatthew G. Knepley 
2456194d53e6SMatthew G. Knepley /*@
2457194d53e6SMatthew G. Knepley   PetscDSGetComponentOffsets - Returns the offset of each field on an evaluation point
2458194d53e6SMatthew G. Knepley 
2459194d53e6SMatthew G. Knepley   Not collective
2460194d53e6SMatthew G. Knepley 
2461194d53e6SMatthew G. Knepley   Input Parameter:
2462194d53e6SMatthew G. Knepley . prob - The PetscDS object
2463194d53e6SMatthew G. Knepley 
2464194d53e6SMatthew G. Knepley   Output Parameter:
2465194d53e6SMatthew G. Knepley . offsets - The offsets
2466194d53e6SMatthew G. Knepley 
2467194d53e6SMatthew G. Knepley   Level: beginner
2468194d53e6SMatthew G. Knepley 
2469f744cafaSSander Arens .seealso: PetscDSGetNumFields(), PetscDSCreate()
2470194d53e6SMatthew G. Knepley @*/
2471194d53e6SMatthew G. Knepley PetscErrorCode PetscDSGetComponentOffsets(PetscDS prob, PetscInt *offsets[])
2472194d53e6SMatthew G. Knepley {
2473194d53e6SMatthew G. Knepley   PetscFunctionBegin;
2474194d53e6SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2475194d53e6SMatthew G. Knepley   PetscValidPointer(offsets, 2);
2476194d53e6SMatthew G. Knepley   *offsets = prob->off;
2477194d53e6SMatthew G. Knepley   PetscFunctionReturn(0);
2478194d53e6SMatthew G. Knepley }
2479194d53e6SMatthew G. Knepley 
2480194d53e6SMatthew G. Knepley /*@
2481194d53e6SMatthew G. Knepley   PetscDSGetComponentDerivativeOffsets - Returns the offset of each field derivative on an evaluation point
2482194d53e6SMatthew G. Knepley 
2483194d53e6SMatthew G. Knepley   Not collective
2484194d53e6SMatthew G. Knepley 
2485194d53e6SMatthew G. Knepley   Input Parameter:
2486194d53e6SMatthew G. Knepley . prob - The PetscDS object
2487194d53e6SMatthew G. Knepley 
2488194d53e6SMatthew G. Knepley   Output Parameter:
2489194d53e6SMatthew G. Knepley . offsets - The offsets
2490194d53e6SMatthew G. Knepley 
2491194d53e6SMatthew G. Knepley   Level: beginner
2492194d53e6SMatthew G. Knepley 
2493f744cafaSSander Arens .seealso: PetscDSGetNumFields(), PetscDSCreate()
2494194d53e6SMatthew G. Knepley @*/
2495194d53e6SMatthew G. Knepley PetscErrorCode PetscDSGetComponentDerivativeOffsets(PetscDS prob, PetscInt *offsets[])
2496194d53e6SMatthew G. Knepley {
2497194d53e6SMatthew G. Knepley   PetscFunctionBegin;
2498194d53e6SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2499194d53e6SMatthew G. Knepley   PetscValidPointer(offsets, 2);
2500194d53e6SMatthew G. Knepley   *offsets = prob->offDer;
2501194d53e6SMatthew G. Knepley   PetscFunctionReturn(0);
2502194d53e6SMatthew G. Knepley }
2503194d53e6SMatthew G. Knepley 
250468c9edb9SMatthew G. Knepley /*@C
250568c9edb9SMatthew G. Knepley   PetscDSGetTabulation - Return the basis tabulation at quadrature points for the volume discretization
250668c9edb9SMatthew G. Knepley 
250768c9edb9SMatthew G. Knepley   Not collective
250868c9edb9SMatthew G. Knepley 
250968c9edb9SMatthew G. Knepley   Input Parameter:
251068c9edb9SMatthew G. Knepley . prob - The PetscDS object
251168c9edb9SMatthew G. Knepley 
251268c9edb9SMatthew G. Knepley   Output Parameters:
251368c9edb9SMatthew G. Knepley + basis - The basis function tabulation at quadrature points
251468c9edb9SMatthew G. Knepley - basisDer - The basis function derivative tabulation at quadrature points
251568c9edb9SMatthew G. Knepley 
251668c9edb9SMatthew G. Knepley   Level: intermediate
251768c9edb9SMatthew G. Knepley 
2518f744cafaSSander Arens .seealso: PetscDSCreate()
251968c9edb9SMatthew G. Knepley @*/
25202764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetTabulation(PetscDS prob, PetscReal ***basis, PetscReal ***basisDer)
25212764a2aaSMatthew G. Knepley {
25222764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
25232764a2aaSMatthew G. Knepley 
25242764a2aaSMatthew G. Knepley   PetscFunctionBegin;
25252764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
25262764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
25272764a2aaSMatthew G. Knepley   if (basis)    {PetscValidPointer(basis, 2);    *basis    = prob->basis;}
25282764a2aaSMatthew G. Knepley   if (basisDer) {PetscValidPointer(basisDer, 3); *basisDer = prob->basisDer;}
25292764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
25302764a2aaSMatthew G. Knepley }
25312764a2aaSMatthew G. Knepley 
253268c9edb9SMatthew G. Knepley /*@C
25334d0b9603SSander Arens   PetscDSGetFaceTabulation - Return the basis tabulation at quadrature points on the faces
253468c9edb9SMatthew G. Knepley 
253568c9edb9SMatthew G. Knepley   Not collective
253668c9edb9SMatthew G. Knepley 
253768c9edb9SMatthew G. Knepley   Input Parameter:
253868c9edb9SMatthew G. Knepley . prob - The PetscDS object
253968c9edb9SMatthew G. Knepley 
254068c9edb9SMatthew G. Knepley   Output Parameters:
25414d0b9603SSander Arens + basisFace - The basis function tabulation at quadrature points
25424d0b9603SSander Arens - basisDerFace - The basis function derivative tabulation at quadrature points
254368c9edb9SMatthew G. Knepley 
254468c9edb9SMatthew G. Knepley   Level: intermediate
254568c9edb9SMatthew G. Knepley 
254668c9edb9SMatthew G. Knepley .seealso: PetscDSGetTabulation(), PetscDSCreate()
254768c9edb9SMatthew G. Knepley @*/
25484d0b9603SSander Arens PetscErrorCode PetscDSGetFaceTabulation(PetscDS prob, PetscReal ***basis, PetscReal ***basisDer)
25492764a2aaSMatthew G. Knepley {
25502764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
25512764a2aaSMatthew G. Knepley 
25522764a2aaSMatthew G. Knepley   PetscFunctionBegin;
25532764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
25542764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
25554d0b9603SSander Arens   if (basis)    {PetscValidPointer(basis, 2);    *basis    = prob->basisFace;}
25564d0b9603SSander Arens   if (basisDer) {PetscValidPointer(basisDer, 3); *basisDer = prob->basisDerFace;}
25572764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
25582764a2aaSMatthew G. Knepley }
25592764a2aaSMatthew G. Knepley 
25602764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetEvaluationArrays(PetscDS prob, PetscScalar **u, PetscScalar **u_t, PetscScalar **u_x)
25612764a2aaSMatthew G. Knepley {
25622764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
25632764a2aaSMatthew G. Knepley 
25642764a2aaSMatthew G. Knepley   PetscFunctionBegin;
25652764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
25662764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
25672764a2aaSMatthew G. Knepley   if (u)   {PetscValidPointer(u, 2);   *u   = prob->u;}
25682764a2aaSMatthew G. Knepley   if (u_t) {PetscValidPointer(u_t, 3); *u_t = prob->u_t;}
25692764a2aaSMatthew G. Knepley   if (u_x) {PetscValidPointer(u_x, 4); *u_x = prob->u_x;}
25702764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
25712764a2aaSMatthew G. Knepley }
25722764a2aaSMatthew G. Knepley 
25732764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetWeakFormArrays(PetscDS prob, PetscScalar **f0, PetscScalar **f1, PetscScalar **g0, PetscScalar **g1, PetscScalar **g2, PetscScalar **g3)
25742764a2aaSMatthew G. Knepley {
25752764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
25762764a2aaSMatthew G. Knepley 
25772764a2aaSMatthew G. Knepley   PetscFunctionBegin;
25782764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
25792764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
25802764a2aaSMatthew G. Knepley   if (f0) {PetscValidPointer(f0, 2); *f0 = prob->f0;}
25812764a2aaSMatthew G. Knepley   if (f1) {PetscValidPointer(f1, 3); *f1 = prob->f1;}
25822764a2aaSMatthew G. Knepley   if (g0) {PetscValidPointer(g0, 4); *g0 = prob->g0;}
25832764a2aaSMatthew G. Knepley   if (g1) {PetscValidPointer(g1, 5); *g1 = prob->g1;}
25842764a2aaSMatthew G. Knepley   if (g2) {PetscValidPointer(g2, 6); *g2 = prob->g2;}
25852764a2aaSMatthew G. Knepley   if (g3) {PetscValidPointer(g3, 7); *g3 = prob->g3;}
25862764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
25872764a2aaSMatthew G. Knepley }
25882764a2aaSMatthew G. Knepley 
25892764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetRefCoordArrays(PetscDS prob, PetscReal **x, PetscScalar **refSpaceDer)
25902764a2aaSMatthew G. Knepley {
25912764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
25922764a2aaSMatthew G. Knepley 
25932764a2aaSMatthew G. Knepley   PetscFunctionBegin;
25942764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
25952764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
25962764a2aaSMatthew G. Knepley   if (x)           {PetscValidPointer(x, 2);           *x           = prob->x;}
25972764a2aaSMatthew G. Knepley   if (refSpaceDer) {PetscValidPointer(refSpaceDer, 3); *refSpaceDer = prob->refSpaceDer;}
25982764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
25992764a2aaSMatthew G. Knepley }
26002764a2aaSMatthew G. Knepley 
260158ebd649SToby Isaac /*@C
260258ebd649SToby Isaac   PetscDSAddBoundary - Add a boundary condition to the model
260358ebd649SToby Isaac 
260458ebd649SToby Isaac   Input Parameters:
260558ebd649SToby Isaac + ds          - The PetscDS object
26062d47a189SJulian Andrej . type        - The type of condition, e.g. DM_BC_ESSENTIAL/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann)
260758ebd649SToby Isaac . name        - The BC name
260858ebd649SToby Isaac . labelname   - The label defining constrained points
260958ebd649SToby Isaac . field       - The field to constrain
261058ebd649SToby Isaac . numcomps    - The number of constrained field components
261158ebd649SToby Isaac . comps       - An array of constrained component numbers
261258ebd649SToby Isaac . bcFunc      - A pointwise function giving boundary values
261358ebd649SToby Isaac . numids      - The number of DMLabel ids for constrained points
261458ebd649SToby Isaac . ids         - An array of ids for constrained points
261558ebd649SToby Isaac - ctx         - An optional user context for bcFunc
261658ebd649SToby Isaac 
261758ebd649SToby Isaac   Options Database Keys:
261858ebd649SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids
261958ebd649SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components
262058ebd649SToby Isaac 
262158ebd649SToby Isaac   Level: developer
262258ebd649SToby Isaac 
262358ebd649SToby Isaac .seealso: PetscDSGetBoundary()
262458ebd649SToby Isaac @*/
2625a30ec4eaSSatish 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)
262658ebd649SToby Isaac {
262758ebd649SToby Isaac   DSBoundary     b;
262858ebd649SToby Isaac   PetscErrorCode ierr;
262958ebd649SToby Isaac 
263058ebd649SToby Isaac   PetscFunctionBegin;
263158ebd649SToby Isaac   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1);
263258ebd649SToby Isaac   ierr = PetscNew(&b);CHKERRQ(ierr);
263358ebd649SToby Isaac   ierr = PetscStrallocpy(name, (char **) &b->name);CHKERRQ(ierr);
263458ebd649SToby Isaac   ierr = PetscStrallocpy(labelname, (char **) &b->labelname);CHKERRQ(ierr);
263558ebd649SToby Isaac   ierr = PetscMalloc1(numcomps, &b->comps);CHKERRQ(ierr);
263658ebd649SToby Isaac   if (numcomps) {ierr = PetscMemcpy(b->comps, comps, numcomps*sizeof(PetscInt));CHKERRQ(ierr);}
263758ebd649SToby Isaac   ierr = PetscMalloc1(numids, &b->ids);CHKERRQ(ierr);
263858ebd649SToby Isaac   if (numids) {ierr = PetscMemcpy(b->ids, ids, numids*sizeof(PetscInt));CHKERRQ(ierr);}
2639f971fd6bSMatthew G. Knepley   b->type            = type;
264058ebd649SToby Isaac   b->field           = field;
264158ebd649SToby Isaac   b->numcomps        = numcomps;
264258ebd649SToby Isaac   b->func            = bcFunc;
264358ebd649SToby Isaac   b->numids          = numids;
264458ebd649SToby Isaac   b->ctx             = ctx;
264558ebd649SToby Isaac   b->next            = ds->boundary;
264658ebd649SToby Isaac   ds->boundary       = b;
264758ebd649SToby Isaac   PetscFunctionReturn(0);
264858ebd649SToby Isaac }
264958ebd649SToby Isaac 
265058ebd649SToby Isaac /*@
265158ebd649SToby Isaac   PetscDSGetNumBoundary - Get the number of registered BC
265258ebd649SToby Isaac 
265358ebd649SToby Isaac   Input Parameters:
265458ebd649SToby Isaac . ds - The PetscDS object
265558ebd649SToby Isaac 
265658ebd649SToby Isaac   Output Parameters:
265758ebd649SToby Isaac . numBd - The number of BC
265858ebd649SToby Isaac 
265958ebd649SToby Isaac   Level: intermediate
266058ebd649SToby Isaac 
266158ebd649SToby Isaac .seealso: PetscDSAddBoundary(), PetscDSGetBoundary()
266258ebd649SToby Isaac @*/
266358ebd649SToby Isaac PetscErrorCode PetscDSGetNumBoundary(PetscDS ds, PetscInt *numBd)
266458ebd649SToby Isaac {
266558ebd649SToby Isaac   DSBoundary b = ds->boundary;
266658ebd649SToby Isaac 
266758ebd649SToby Isaac   PetscFunctionBegin;
266858ebd649SToby Isaac   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1);
266958ebd649SToby Isaac   PetscValidPointer(numBd, 2);
267058ebd649SToby Isaac   *numBd = 0;
267158ebd649SToby Isaac   while (b) {++(*numBd); b = b->next;}
267258ebd649SToby Isaac   PetscFunctionReturn(0);
267358ebd649SToby Isaac }
267458ebd649SToby Isaac 
267558ebd649SToby Isaac /*@C
267658ebd649SToby Isaac   PetscDSGetBoundary - Add a boundary condition to the model
267758ebd649SToby Isaac 
267858ebd649SToby Isaac   Input Parameters:
267958ebd649SToby Isaac + ds          - The PetscDS object
268058ebd649SToby Isaac - bd          - The BC number
268158ebd649SToby Isaac 
268258ebd649SToby Isaac   Output Parameters:
26832d47a189SJulian Andrej + type        - The type of condition, e.g. DM_BC_ESSENTIAL/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann)
268458ebd649SToby Isaac . name        - The BC name
268558ebd649SToby Isaac . labelname   - The label defining constrained points
268658ebd649SToby Isaac . field       - The field to constrain
268758ebd649SToby Isaac . numcomps    - The number of constrained field components
268858ebd649SToby Isaac . comps       - An array of constrained component numbers
268958ebd649SToby Isaac . bcFunc      - A pointwise function giving boundary values
269058ebd649SToby Isaac . numids      - The number of DMLabel ids for constrained points
269158ebd649SToby Isaac . ids         - An array of ids for constrained points
269258ebd649SToby Isaac - ctx         - An optional user context for bcFunc
269358ebd649SToby Isaac 
269458ebd649SToby Isaac   Options Database Keys:
269558ebd649SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids
269658ebd649SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components
269758ebd649SToby Isaac 
269858ebd649SToby Isaac   Level: developer
269958ebd649SToby Isaac 
270058ebd649SToby Isaac .seealso: PetscDSAddBoundary()
270158ebd649SToby Isaac @*/
2702a30ec4eaSSatish 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)
270358ebd649SToby Isaac {
270458ebd649SToby Isaac   DSBoundary b    = ds->boundary;
270558ebd649SToby Isaac   PetscInt   n    = 0;
270658ebd649SToby Isaac 
270758ebd649SToby Isaac   PetscFunctionBegin;
270858ebd649SToby Isaac   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1);
270958ebd649SToby Isaac   while (b) {
271058ebd649SToby Isaac     if (n == bd) break;
271158ebd649SToby Isaac     b = b->next;
271258ebd649SToby Isaac     ++n;
271358ebd649SToby Isaac   }
271458ebd649SToby Isaac   if (!b) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Boundary %d is not in [0, %d)", bd, n);
2715f971fd6bSMatthew G. Knepley   if (type) {
2716f971fd6bSMatthew G. Knepley     PetscValidPointer(type, 3);
2717f971fd6bSMatthew G. Knepley     *type = b->type;
271858ebd649SToby Isaac   }
271958ebd649SToby Isaac   if (name) {
272058ebd649SToby Isaac     PetscValidPointer(name, 4);
272158ebd649SToby Isaac     *name = b->name;
272258ebd649SToby Isaac   }
272358ebd649SToby Isaac   if (labelname) {
272458ebd649SToby Isaac     PetscValidPointer(labelname, 5);
272558ebd649SToby Isaac     *labelname = b->labelname;
272658ebd649SToby Isaac   }
272758ebd649SToby Isaac   if (field) {
272858ebd649SToby Isaac     PetscValidPointer(field, 6);
272958ebd649SToby Isaac     *field = b->field;
273058ebd649SToby Isaac   }
273158ebd649SToby Isaac   if (numcomps) {
273258ebd649SToby Isaac     PetscValidPointer(numcomps, 7);
273358ebd649SToby Isaac     *numcomps = b->numcomps;
273458ebd649SToby Isaac   }
273558ebd649SToby Isaac   if (comps) {
273658ebd649SToby Isaac     PetscValidPointer(comps, 8);
273758ebd649SToby Isaac     *comps = b->comps;
273858ebd649SToby Isaac   }
273958ebd649SToby Isaac   if (func) {
274058ebd649SToby Isaac     PetscValidPointer(func, 9);
274158ebd649SToby Isaac     *func = b->func;
274258ebd649SToby Isaac   }
274358ebd649SToby Isaac   if (numids) {
274458ebd649SToby Isaac     PetscValidPointer(numids, 10);
274558ebd649SToby Isaac     *numids = b->numids;
274658ebd649SToby Isaac   }
274758ebd649SToby Isaac   if (ids) {
274858ebd649SToby Isaac     PetscValidPointer(ids, 11);
274958ebd649SToby Isaac     *ids = b->ids;
275058ebd649SToby Isaac   }
275158ebd649SToby Isaac   if (ctx) {
275258ebd649SToby Isaac     PetscValidPointer(ctx, 12);
275358ebd649SToby Isaac     *ctx = b->ctx;
275458ebd649SToby Isaac   }
275558ebd649SToby Isaac   PetscFunctionReturn(0);
275658ebd649SToby Isaac }
275758ebd649SToby Isaac 
2758dff059c6SToby Isaac PetscErrorCode PetscDSCopyBoundary(PetscDS probA, PetscDS probB)
2759dff059c6SToby Isaac {
2760dff059c6SToby Isaac   DSBoundary     b, next, *lastnext;
2761dff059c6SToby Isaac   PetscErrorCode ierr;
2762dff059c6SToby Isaac 
2763dff059c6SToby Isaac   PetscFunctionBegin;
2764dff059c6SToby Isaac   PetscValidHeaderSpecific(probA, PETSCDS_CLASSID, 1);
2765dff059c6SToby Isaac   PetscValidHeaderSpecific(probB, PETSCDS_CLASSID, 2);
2766dff059c6SToby Isaac   if (probA == probB) PetscFunctionReturn(0);
2767dff059c6SToby Isaac   next = probB->boundary;
2768dff059c6SToby Isaac   while (next) {
2769dff059c6SToby Isaac     DSBoundary b = next;
2770dff059c6SToby Isaac 
2771dff059c6SToby Isaac     next = b->next;
2772dff059c6SToby Isaac     ierr = PetscFree(b->comps);CHKERRQ(ierr);
2773dff059c6SToby Isaac     ierr = PetscFree(b->ids);CHKERRQ(ierr);
2774dff059c6SToby Isaac     ierr = PetscFree(b->name);CHKERRQ(ierr);
2775dff059c6SToby Isaac     ierr = PetscFree(b->labelname);CHKERRQ(ierr);
2776dff059c6SToby Isaac     ierr = PetscFree(b);CHKERRQ(ierr);
2777dff059c6SToby Isaac   }
2778dff059c6SToby Isaac   lastnext = &(probB->boundary);
2779dff059c6SToby Isaac   for (b = probA->boundary; b; b = b->next) {
2780dff059c6SToby Isaac     DSBoundary bNew;
2781dff059c6SToby Isaac 
2782459726d8SSatish Balay     ierr = PetscNew(&bNew);CHKERRQ(ierr);
2783dff059c6SToby Isaac     bNew->numcomps = b->numcomps;
2784dff059c6SToby Isaac     ierr = PetscMalloc1(bNew->numcomps, &bNew->comps);CHKERRQ(ierr);
2785dff059c6SToby Isaac     ierr = PetscMemcpy(bNew->comps, b->comps, bNew->numcomps*sizeof(PetscInt));CHKERRQ(ierr);
2786dff059c6SToby Isaac     bNew->numids = b->numids;
2787dff059c6SToby Isaac     ierr = PetscMalloc1(bNew->numids, &bNew->ids);CHKERRQ(ierr);
2788dff059c6SToby Isaac     ierr = PetscMemcpy(bNew->ids, b->ids, bNew->numids*sizeof(PetscInt));CHKERRQ(ierr);
2789dff059c6SToby Isaac     ierr = PetscStrallocpy(b->labelname,(char **) &(bNew->labelname));CHKERRQ(ierr);
2790dff059c6SToby Isaac     ierr = PetscStrallocpy(b->name,(char **) &(bNew->name));CHKERRQ(ierr);
2791dff059c6SToby Isaac     bNew->ctx   = b->ctx;
2792f971fd6bSMatthew G. Knepley     bNew->type  = b->type;
2793dff059c6SToby Isaac     bNew->field = b->field;
2794dff059c6SToby Isaac     bNew->func  = b->func;
2795dff059c6SToby Isaac 
2796dff059c6SToby Isaac     *lastnext = bNew;
2797dff059c6SToby Isaac     lastnext = &(bNew->next);
2798dff059c6SToby Isaac   }
2799dff059c6SToby Isaac   PetscFunctionReturn(0);
2800dff059c6SToby Isaac }
2801dff059c6SToby Isaac 
2802da51fcedSMatthew G. Knepley /*@
2803da51fcedSMatthew G. Knepley   PetscDSCopyEquations - Copy all pointwise function pointers to the new problem
2804da51fcedSMatthew G. Knepley 
2805da51fcedSMatthew G. Knepley   Not collective
2806da51fcedSMatthew G. Knepley 
2807da51fcedSMatthew G. Knepley   Input Parameter:
2808da51fcedSMatthew G. Knepley . prob - The PetscDS object
2809da51fcedSMatthew G. Knepley 
2810da51fcedSMatthew G. Knepley   Output Parameter:
2811da51fcedSMatthew G. Knepley . newprob - The PetscDS copy
2812da51fcedSMatthew G. Knepley 
2813da51fcedSMatthew G. Knepley   Level: intermediate
2814da51fcedSMatthew G. Knepley 
2815da51fcedSMatthew G. Knepley .seealso: PetscDSSetResidual(), PetscDSSetJacobian(), PetscDSSetRiemannSolver(), PetscDSSetBdResidual(), PetscDSSetBdJacobian(), PetscDSCreate()
2816da51fcedSMatthew G. Knepley @*/
2817da51fcedSMatthew G. Knepley PetscErrorCode PetscDSCopyEquations(PetscDS prob, PetscDS newprob)
2818da51fcedSMatthew G. Knepley {
2819da51fcedSMatthew G. Knepley   PetscInt       Nf, Ng, f, g;
2820da51fcedSMatthew G. Knepley   PetscErrorCode ierr;
2821da51fcedSMatthew G. Knepley 
2822da51fcedSMatthew G. Knepley   PetscFunctionBegin;
2823da51fcedSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2824da51fcedSMatthew G. Knepley   PetscValidHeaderSpecific(newprob, PETSCDS_CLASSID, 2);
2825da51fcedSMatthew G. Knepley   ierr = PetscDSGetNumFields(prob, &Nf);CHKERRQ(ierr);
2826da51fcedSMatthew G. Knepley   ierr = PetscDSGetNumFields(newprob, &Ng);CHKERRQ(ierr);
282713903a91SSatish Balay   if (Nf != Ng) SETERRQ2(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_SIZ, "Number of fields must match %D != %D", Nf, Ng);
2828da51fcedSMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
2829da51fcedSMatthew G. Knepley     PetscPointFunc   obj;
2830da51fcedSMatthew G. Knepley     PetscPointFunc   f0, f1;
2831da51fcedSMatthew G. Knepley     PetscPointJac    g0, g1, g2, g3;
2832da51fcedSMatthew G. Knepley     PetscBdPointFunc f0Bd, f1Bd;
2833da51fcedSMatthew G. Knepley     PetscBdPointJac  g0Bd, g1Bd, g2Bd, g3Bd;
2834da51fcedSMatthew G. Knepley     PetscRiemannFunc r;
2835da51fcedSMatthew G. Knepley 
2836da51fcedSMatthew G. Knepley     ierr = PetscDSGetObjective(prob, f, &obj);CHKERRQ(ierr);
2837da51fcedSMatthew G. Knepley     ierr = PetscDSGetResidual(prob, f, &f0, &f1);CHKERRQ(ierr);
2838da51fcedSMatthew G. Knepley     ierr = PetscDSGetBdResidual(prob, f, &f0Bd, &f1Bd);CHKERRQ(ierr);
2839da51fcedSMatthew G. Knepley     ierr = PetscDSGetRiemannSolver(prob, f, &r);CHKERRQ(ierr);
2840da51fcedSMatthew G. Knepley     ierr = PetscDSSetObjective(newprob, f, obj);CHKERRQ(ierr);
2841da51fcedSMatthew G. Knepley     ierr = PetscDSSetResidual(newprob, f, f0, f1);CHKERRQ(ierr);
2842da51fcedSMatthew G. Knepley     ierr = PetscDSSetBdResidual(newprob, f, f0Bd, f1Bd);CHKERRQ(ierr);
2843da51fcedSMatthew G. Knepley     ierr = PetscDSSetRiemannSolver(newprob, f, r);CHKERRQ(ierr);
2844da51fcedSMatthew G. Knepley     for (g = 0; g < Nf; ++g) {
2845da51fcedSMatthew G. Knepley       ierr = PetscDSGetJacobian(prob, f, g, &g0, &g1, &g2, &g3);CHKERRQ(ierr);
2846da51fcedSMatthew G. Knepley       ierr = PetscDSGetBdJacobian(prob, f, g, &g0Bd, &g1Bd, &g2Bd, &g3Bd);CHKERRQ(ierr);
2847da51fcedSMatthew G. Knepley       ierr = PetscDSSetJacobian(newprob, f, g, g0, g1, g2, g3);CHKERRQ(ierr);
2848da51fcedSMatthew G. Knepley       ierr = PetscDSSetBdJacobian(newprob, f, g, g0Bd, g1Bd, g2Bd, g3Bd);CHKERRQ(ierr);
2849da51fcedSMatthew G. Knepley     }
2850da51fcedSMatthew G. Knepley   }
2851da51fcedSMatthew G. Knepley   PetscFunctionReturn(0);
2852da51fcedSMatthew G. Knepley }
2853da51fcedSMatthew G. Knepley 
2854b1353e8eSMatthew G. Knepley PetscErrorCode PetscDSGetHeightSubspace(PetscDS prob, PetscInt height, PetscDS *subprob)
2855b1353e8eSMatthew G. Knepley {
2856df3a45bdSMatthew G. Knepley   PetscInt       dim, Nf, f;
2857b1353e8eSMatthew G. Knepley   PetscErrorCode ierr;
2858b1353e8eSMatthew G. Knepley 
2859b1353e8eSMatthew G. Knepley   PetscFunctionBegin;
2860b1353e8eSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2861b1353e8eSMatthew G. Knepley   PetscValidPointer(subprob, 3);
2862b1353e8eSMatthew G. Knepley   if (height == 0) {*subprob = prob; PetscFunctionReturn(0);}
2863b1353e8eSMatthew G. Knepley   ierr = PetscDSGetNumFields(prob, &Nf);CHKERRQ(ierr);
2864df3a45bdSMatthew G. Knepley   ierr = PetscDSGetSpatialDimension(prob, &dim);CHKERRQ(ierr);
2865df3a45bdSMatthew 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);
2866df3a45bdSMatthew G. Knepley   if (!prob->subprobs) {ierr = PetscCalloc1(dim, &prob->subprobs);CHKERRQ(ierr);}
2867df3a45bdSMatthew G. Knepley   if (!prob->subprobs[height-1]) {
2868b1353e8eSMatthew G. Knepley     PetscInt cdim;
2869b1353e8eSMatthew G. Knepley 
2870df3a45bdSMatthew G. Knepley     ierr = PetscDSCreate(PetscObjectComm((PetscObject) prob), &prob->subprobs[height-1]);CHKERRQ(ierr);
2871b1353e8eSMatthew G. Knepley     ierr = PetscDSGetCoordinateDimension(prob, &cdim);CHKERRQ(ierr);
2872df3a45bdSMatthew G. Knepley     ierr = PetscDSSetCoordinateDimension(prob->subprobs[height-1], cdim);CHKERRQ(ierr);
2873b1353e8eSMatthew G. Knepley     for (f = 0; f < Nf; ++f) {
2874b1353e8eSMatthew G. Knepley       PetscFE      subfe;
2875b1353e8eSMatthew G. Knepley       PetscObject  obj;
2876b1353e8eSMatthew G. Knepley       PetscClassId id;
2877b1353e8eSMatthew G. Knepley 
2878b1353e8eSMatthew G. Knepley       ierr = PetscDSGetDiscretization(prob, f, &obj);CHKERRQ(ierr);
2879b1353e8eSMatthew G. Knepley       ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr);
2880b1353e8eSMatthew G. Knepley       if (id == PETSCFE_CLASSID) {ierr = PetscFEGetHeightSubspace((PetscFE) obj, height, &subfe);CHKERRQ(ierr);}
2881b1353e8eSMatthew G. Knepley       else SETERRQ1(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Unsupported discretization type for field %d", f);
2882df3a45bdSMatthew G. Knepley       ierr = PetscDSSetDiscretization(prob->subprobs[height-1], f, (PetscObject) subfe);CHKERRQ(ierr);
2883b1353e8eSMatthew G. Knepley     }
2884b1353e8eSMatthew G. Knepley   }
2885df3a45bdSMatthew G. Knepley   *subprob = prob->subprobs[height-1];
2886b1353e8eSMatthew G. Knepley   PetscFunctionReturn(0);
2887b1353e8eSMatthew G. Knepley }
2888b1353e8eSMatthew G. Knepley 
2889bc4ae4beSMatthew G. Knepley static PetscErrorCode PetscDSDestroy_Basic(PetscDS prob)
28902764a2aaSMatthew G. Knepley {
2891931fb3b8SToby Isaac   PetscErrorCode      ierr;
2892931fb3b8SToby Isaac 
28932764a2aaSMatthew G. Knepley   PetscFunctionBegin;
2894931fb3b8SToby Isaac   ierr = PetscFree(prob->data);CHKERRQ(ierr);
28952764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
28962764a2aaSMatthew G. Knepley }
28972764a2aaSMatthew G. Knepley 
2898bc4ae4beSMatthew G. Knepley static PetscErrorCode PetscDSInitialize_Basic(PetscDS prob)
28992764a2aaSMatthew G. Knepley {
29002764a2aaSMatthew G. Knepley   PetscFunctionBegin;
29012764a2aaSMatthew G. Knepley   prob->ops->setfromoptions = NULL;
29022764a2aaSMatthew G. Knepley   prob->ops->setup          = NULL;
29032764a2aaSMatthew G. Knepley   prob->ops->view           = NULL;
29042764a2aaSMatthew G. Knepley   prob->ops->destroy        = PetscDSDestroy_Basic;
29052764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
29062764a2aaSMatthew G. Knepley }
29072764a2aaSMatthew G. Knepley 
29082764a2aaSMatthew G. Knepley /*MC
29092764a2aaSMatthew G. Knepley   PETSCDSBASIC = "basic" - A discrete system with pointwise residual and boundary residual functions
29102764a2aaSMatthew G. Knepley 
29112764a2aaSMatthew G. Knepley   Level: intermediate
29122764a2aaSMatthew G. Knepley 
29132764a2aaSMatthew G. Knepley .seealso: PetscDSType, PetscDSCreate(), PetscDSSetType()
29142764a2aaSMatthew G. Knepley M*/
29152764a2aaSMatthew G. Knepley 
29162764a2aaSMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscDSCreate_Basic(PetscDS prob)
29172764a2aaSMatthew G. Knepley {
29182764a2aaSMatthew G. Knepley   PetscDS_Basic *b;
29192764a2aaSMatthew G. Knepley   PetscErrorCode      ierr;
29202764a2aaSMatthew G. Knepley 
29212764a2aaSMatthew G. Knepley   PetscFunctionBegin;
2922931fb3b8SToby Isaac   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
29232764a2aaSMatthew G. Knepley   ierr       = PetscNewLog(prob, &b);CHKERRQ(ierr);
29242764a2aaSMatthew G. Knepley   prob->data = b;
29252764a2aaSMatthew G. Knepley 
29262764a2aaSMatthew G. Knepley   ierr = PetscDSInitialize_Basic(prob);CHKERRQ(ierr);
29272764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
29282764a2aaSMatthew G. Knepley }
2929