xref: /petsc/src/dm/dt/interface/dtds.c (revision 3fa77dff6d5ade6c66b9f2acf370e64dcf7f0bc4)
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 
372764a2aaSMatthew G. Knepley .keywords: PetscDS, register
382764a2aaSMatthew G. Knepley .seealso: PetscDSRegisterAll(), PetscDSRegisterDestroy()
392764a2aaSMatthew G. Knepley 
402764a2aaSMatthew G. Knepley @*/
412764a2aaSMatthew G. Knepley PetscErrorCode PetscDSRegister(const char sname[], PetscErrorCode (*function)(PetscDS))
422764a2aaSMatthew G. Knepley {
432764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
442764a2aaSMatthew G. Knepley 
452764a2aaSMatthew G. Knepley   PetscFunctionBegin;
462764a2aaSMatthew G. Knepley   ierr = PetscFunctionListAdd(&PetscDSList, sname, function);CHKERRQ(ierr);
472764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
482764a2aaSMatthew G. Knepley }
492764a2aaSMatthew G. Knepley 
502764a2aaSMatthew G. Knepley /*@C
512764a2aaSMatthew G. Knepley   PetscDSSetType - Builds a particular PetscDS
522764a2aaSMatthew G. Knepley 
532764a2aaSMatthew G. Knepley   Collective on PetscDS
542764a2aaSMatthew G. Knepley 
552764a2aaSMatthew G. Knepley   Input Parameters:
562764a2aaSMatthew G. Knepley + prob - The PetscDS object
572764a2aaSMatthew G. Knepley - name - The kind of system
582764a2aaSMatthew G. Knepley 
592764a2aaSMatthew G. Knepley   Options Database Key:
602764a2aaSMatthew G. Knepley . -petscds_type <type> - Sets the PetscDS type; use -help for a list of available types
612764a2aaSMatthew G. Knepley 
622764a2aaSMatthew G. Knepley   Level: intermediate
632764a2aaSMatthew G. Knepley 
642764a2aaSMatthew G. Knepley .keywords: PetscDS, set, type
652764a2aaSMatthew G. Knepley .seealso: PetscDSGetType(), PetscDSCreate()
662764a2aaSMatthew G. Knepley @*/
672764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetType(PetscDS prob, PetscDSType name)
682764a2aaSMatthew G. Knepley {
692764a2aaSMatthew G. Knepley   PetscErrorCode (*r)(PetscDS);
702764a2aaSMatthew G. Knepley   PetscBool      match;
712764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
722764a2aaSMatthew G. Knepley 
732764a2aaSMatthew G. Knepley   PetscFunctionBegin;
742764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
752764a2aaSMatthew G. Knepley   ierr = PetscObjectTypeCompare((PetscObject) prob, name, &match);CHKERRQ(ierr);
762764a2aaSMatthew G. Knepley   if (match) PetscFunctionReturn(0);
772764a2aaSMatthew G. Knepley 
780f51fdf8SToby Isaac   ierr = PetscDSRegisterAll();CHKERRQ(ierr);
792764a2aaSMatthew G. Knepley   ierr = PetscFunctionListFind(PetscDSList, name, &r);CHKERRQ(ierr);
802764a2aaSMatthew G. Knepley   if (!r) SETERRQ1(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_UNKNOWN_TYPE, "Unknown PetscDS type: %s", name);
812764a2aaSMatthew G. Knepley 
822764a2aaSMatthew G. Knepley   if (prob->ops->destroy) {
832764a2aaSMatthew G. Knepley     ierr             = (*prob->ops->destroy)(prob);CHKERRQ(ierr);
842764a2aaSMatthew G. Knepley     prob->ops->destroy = NULL;
852764a2aaSMatthew G. Knepley   }
862764a2aaSMatthew G. Knepley   ierr = (*r)(prob);CHKERRQ(ierr);
872764a2aaSMatthew G. Knepley   ierr = PetscObjectChangeTypeName((PetscObject) prob, name);CHKERRQ(ierr);
882764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
892764a2aaSMatthew G. Knepley }
902764a2aaSMatthew G. Knepley 
912764a2aaSMatthew G. Knepley /*@C
922764a2aaSMatthew G. Knepley   PetscDSGetType - Gets the PetscDS type name (as a string) from the object.
932764a2aaSMatthew G. Knepley 
942764a2aaSMatthew G. Knepley   Not Collective
952764a2aaSMatthew G. Knepley 
962764a2aaSMatthew G. Knepley   Input Parameter:
972764a2aaSMatthew G. Knepley . prob  - The PetscDS
982764a2aaSMatthew G. Knepley 
992764a2aaSMatthew G. Knepley   Output Parameter:
1002764a2aaSMatthew G. Knepley . name - The PetscDS type name
1012764a2aaSMatthew G. Knepley 
1022764a2aaSMatthew G. Knepley   Level: intermediate
1032764a2aaSMatthew G. Knepley 
1042764a2aaSMatthew G. Knepley .keywords: PetscDS, get, type, name
1052764a2aaSMatthew G. Knepley .seealso: PetscDSSetType(), PetscDSCreate()
1062764a2aaSMatthew G. Knepley @*/
1072764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetType(PetscDS prob, PetscDSType *name)
1082764a2aaSMatthew G. Knepley {
1092764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
1102764a2aaSMatthew G. Knepley 
1112764a2aaSMatthew G. Knepley   PetscFunctionBegin;
1122764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
113c959eef4SJed Brown   PetscValidPointer(name, 2);
1140f51fdf8SToby Isaac   ierr = PetscDSRegisterAll();CHKERRQ(ierr);
1152764a2aaSMatthew G. Knepley   *name = ((PetscObject) prob)->type_name;
1162764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
1172764a2aaSMatthew G. Knepley }
1182764a2aaSMatthew G. Knepley 
1197d8a60eaSMatthew G. Knepley static PetscErrorCode PetscDSView_Ascii(PetscDS prob, PetscViewer viewer)
1207d8a60eaSMatthew G. Knepley {
1217d8a60eaSMatthew G. Knepley   PetscViewerFormat format;
1227d8a60eaSMatthew G. Knepley   PetscInt          f;
1237d8a60eaSMatthew G. Knepley   PetscErrorCode    ierr;
1247d8a60eaSMatthew G. Knepley 
1257d8a60eaSMatthew G. Knepley   PetscFunctionBegin;
1267d8a60eaSMatthew G. Knepley   ierr = PetscViewerGetFormat(viewer, &format);CHKERRQ(ierr);
1277d8a60eaSMatthew G. Knepley   ierr = PetscViewerASCIIPrintf(viewer, "Discrete System with %d fields\n", prob->Nf);CHKERRQ(ierr);
1287d8a60eaSMatthew G. Knepley   ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1297d8a60eaSMatthew G. Knepley   for (f = 0; f < prob->Nf; ++f) {
1307d8a60eaSMatthew G. Knepley     PetscObject  obj;
1317d8a60eaSMatthew G. Knepley     PetscClassId id;
1327d8a60eaSMatthew G. Knepley     const char  *name;
1337d8a60eaSMatthew G. Knepley     PetscInt     Nc;
1347d8a60eaSMatthew G. Knepley 
1357d8a60eaSMatthew G. Knepley     ierr = PetscDSGetDiscretization(prob, f, &obj);CHKERRQ(ierr);
1367d8a60eaSMatthew G. Knepley     ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr);
1377d8a60eaSMatthew G. Knepley     ierr = PetscObjectGetName(obj, &name);CHKERRQ(ierr);
1387d8a60eaSMatthew G. Knepley     ierr = PetscViewerASCIIPrintf(viewer, "Field %s", name ? name : "<unknown>");CHKERRQ(ierr);
1397d8a60eaSMatthew G. Knepley     if (id == PETSCFE_CLASSID)      {
1407d8a60eaSMatthew G. Knepley       ierr = PetscFEGetNumComponents((PetscFE) obj, &Nc);CHKERRQ(ierr);
1417d8a60eaSMatthew G. Knepley       ierr = PetscViewerASCIIPrintf(viewer, " FEM");CHKERRQ(ierr);
1427d8a60eaSMatthew G. Knepley     } else if (id == PETSCFV_CLASSID) {
1437d8a60eaSMatthew G. Knepley       ierr = PetscFVGetNumComponents((PetscFV) obj, &Nc);CHKERRQ(ierr);
1447d8a60eaSMatthew G. Knepley       ierr = PetscViewerASCIIPrintf(viewer, " FVM");CHKERRQ(ierr);
1457d8a60eaSMatthew G. Knepley     }
1467d8a60eaSMatthew G. Knepley     else SETERRQ1(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Unknown discretization type for field %d", f);
1477d8a60eaSMatthew G. Knepley     if (Nc > 1) {ierr = PetscViewerASCIIPrintf(viewer, "%d components", Nc);CHKERRQ(ierr);}
1487d8a60eaSMatthew G. Knepley     else        {ierr = PetscViewerASCIIPrintf(viewer, "%d component ", Nc);CHKERRQ(ierr);}
149249df284SMatthew G. Knepley     if (prob->implicit[f]) {ierr = PetscViewerASCIIPrintf(viewer, " (implicit)");CHKERRQ(ierr);}
150249df284SMatthew G. Knepley     else                   {ierr = PetscViewerASCIIPrintf(viewer, " (explicit)");CHKERRQ(ierr);}
151a6cbbb48SMatthew G. Knepley     if (prob->adjacency[f*2+0]) {
152a6cbbb48SMatthew G. Knepley       if (prob->adjacency[f*2+1]) {ierr = PetscViewerASCIIPrintf(viewer, " (adj FVM++)");CHKERRQ(ierr);}
153a6cbbb48SMatthew G. Knepley       else                        {ierr = PetscViewerASCIIPrintf(viewer, " (adj FVM)");CHKERRQ(ierr);}
154a6cbbb48SMatthew G. Knepley     } else {
155a6cbbb48SMatthew G. Knepley       if (prob->adjacency[f*2+1]) {ierr = PetscViewerASCIIPrintf(viewer, " (adj FEM)");CHKERRQ(ierr);}
156a6cbbb48SMatthew G. Knepley       else                        {ierr = PetscViewerASCIIPrintf(viewer, " (adj FUNKY)");CHKERRQ(ierr);}
157a6cbbb48SMatthew G. Knepley     }
1587d8a60eaSMatthew G. Knepley     ierr = PetscViewerASCIIPrintf(viewer, "\n");CHKERRQ(ierr);
1597d8a60eaSMatthew G. Knepley     if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
1607d8a60eaSMatthew G. Knepley       if (id == PETSCFE_CLASSID)      {ierr = PetscFEView((PetscFE) obj, viewer);CHKERRQ(ierr);}
1617d8a60eaSMatthew G. Knepley       else if (id == PETSCFV_CLASSID) {ierr = PetscFVView((PetscFV) obj, viewer);CHKERRQ(ierr);}
1627d8a60eaSMatthew G. Knepley     }
1637d8a60eaSMatthew G. Knepley   }
1647d8a60eaSMatthew G. Knepley   ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1657d8a60eaSMatthew G. Knepley   PetscFunctionReturn(0);
1667d8a60eaSMatthew G. Knepley }
1677d8a60eaSMatthew G. Knepley 
1682764a2aaSMatthew G. Knepley /*@C
1692764a2aaSMatthew G. Knepley   PetscDSView - Views a PetscDS
1702764a2aaSMatthew G. Knepley 
1712764a2aaSMatthew G. Knepley   Collective on PetscDS
1722764a2aaSMatthew G. Knepley 
1732764a2aaSMatthew G. Knepley   Input Parameter:
1742764a2aaSMatthew G. Knepley + prob - the PetscDS object to view
1752764a2aaSMatthew G. Knepley - v  - the viewer
1762764a2aaSMatthew G. Knepley 
1772764a2aaSMatthew G. Knepley   Level: developer
1782764a2aaSMatthew G. Knepley 
1792764a2aaSMatthew G. Knepley .seealso PetscDSDestroy()
1802764a2aaSMatthew G. Knepley @*/
1812764a2aaSMatthew G. Knepley PetscErrorCode PetscDSView(PetscDS prob, PetscViewer v)
1822764a2aaSMatthew G. Knepley {
1837d8a60eaSMatthew G. Knepley   PetscBool      iascii;
1842764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
1852764a2aaSMatthew G. Knepley 
1862764a2aaSMatthew G. Knepley   PetscFunctionBegin;
1872764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1882764a2aaSMatthew G. Knepley   if (!v) {ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject) prob), &v);CHKERRQ(ierr);}
1897d8a60eaSMatthew G. Knepley   else    {PetscValidHeaderSpecific(v, PETSC_VIEWER_CLASSID, 2);}
1907d8a60eaSMatthew G. Knepley   ierr = PetscObjectTypeCompare((PetscObject) v, PETSCVIEWERASCII, &iascii);CHKERRQ(ierr);
1917d8a60eaSMatthew G. Knepley   if (iascii) {ierr = PetscDSView_Ascii(prob, v);CHKERRQ(ierr);}
1922764a2aaSMatthew G. Knepley   if (prob->ops->view) {ierr = (*prob->ops->view)(prob, v);CHKERRQ(ierr);}
1932764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
1942764a2aaSMatthew G. Knepley }
1952764a2aaSMatthew G. Knepley 
1962764a2aaSMatthew G. Knepley /*@
1972764a2aaSMatthew G. Knepley   PetscDSSetFromOptions - sets parameters in a PetscDS from the options database
1982764a2aaSMatthew G. Knepley 
1992764a2aaSMatthew G. Knepley   Collective on PetscDS
2002764a2aaSMatthew G. Knepley 
2012764a2aaSMatthew G. Knepley   Input Parameter:
2022764a2aaSMatthew G. Knepley . prob - the PetscDS object to set options for
2032764a2aaSMatthew G. Knepley 
2042764a2aaSMatthew G. Knepley   Options Database:
2052764a2aaSMatthew G. Knepley 
2062764a2aaSMatthew G. Knepley   Level: developer
2072764a2aaSMatthew G. Knepley 
2082764a2aaSMatthew G. Knepley .seealso PetscDSView()
2092764a2aaSMatthew G. Knepley @*/
2102764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetFromOptions(PetscDS prob)
2112764a2aaSMatthew G. Knepley {
212f1fd5e65SToby Isaac   DSBoundary     b;
2132764a2aaSMatthew G. Knepley   const char    *defaultType;
2142764a2aaSMatthew G. Knepley   char           name[256];
2152764a2aaSMatthew G. Knepley   PetscBool      flg;
2162764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
2172764a2aaSMatthew G. Knepley 
2182764a2aaSMatthew G. Knepley   PetscFunctionBegin;
2192764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2202764a2aaSMatthew G. Knepley   if (!((PetscObject) prob)->type_name) {
2212764a2aaSMatthew G. Knepley     defaultType = PETSCDSBASIC;
2222764a2aaSMatthew G. Knepley   } else {
2232764a2aaSMatthew G. Knepley     defaultType = ((PetscObject) prob)->type_name;
2242764a2aaSMatthew G. Knepley   }
2250f51fdf8SToby Isaac   ierr = PetscDSRegisterAll();CHKERRQ(ierr);
2262764a2aaSMatthew G. Knepley 
2272764a2aaSMatthew G. Knepley   ierr = PetscObjectOptionsBegin((PetscObject) prob);CHKERRQ(ierr);
228f1fd5e65SToby Isaac   for (b = prob->boundary; b; b = b->next) {
229f1fd5e65SToby Isaac     char       optname[1024];
230f1fd5e65SToby Isaac     PetscInt   ids[1024], len = 1024;
231f1fd5e65SToby Isaac     PetscBool  flg;
232f1fd5e65SToby Isaac 
233f1fd5e65SToby Isaac     ierr = PetscSNPrintf(optname, sizeof(optname), "-bc_%s", b->name);CHKERRQ(ierr);
234f1fd5e65SToby Isaac     ierr = PetscMemzero(ids, sizeof(ids));CHKERRQ(ierr);
235f1fd5e65SToby Isaac     ierr = PetscOptionsIntArray(optname, "List of boundary IDs", "", ids, &len, &flg);CHKERRQ(ierr);
236f1fd5e65SToby Isaac     if (flg) {
237f1fd5e65SToby Isaac       b->numids = len;
238f1fd5e65SToby Isaac       ierr = PetscFree(b->ids);CHKERRQ(ierr);
239f1fd5e65SToby Isaac       ierr = PetscMalloc1(len, &b->ids);CHKERRQ(ierr);
240f1fd5e65SToby Isaac       ierr = PetscMemcpy(b->ids, ids, len*sizeof(PetscInt));CHKERRQ(ierr);
241f1fd5e65SToby Isaac     }
242e7b0402cSSander Arens     len = 1024;
243f1fd5e65SToby Isaac     ierr = PetscSNPrintf(optname, sizeof(optname), "-bc_%s_comp", b->name);CHKERRQ(ierr);
244f1fd5e65SToby Isaac     ierr = PetscMemzero(ids, sizeof(ids));CHKERRQ(ierr);
245f1fd5e65SToby Isaac     ierr = PetscOptionsIntArray(optname, "List of boundary field components", "", ids, &len, &flg);CHKERRQ(ierr);
246f1fd5e65SToby Isaac     if (flg) {
247f1fd5e65SToby Isaac       b->numcomps = len;
248f1fd5e65SToby Isaac       ierr = PetscFree(b->comps);CHKERRQ(ierr);
249f1fd5e65SToby Isaac       ierr = PetscMalloc1(len, &b->comps);CHKERRQ(ierr);
250f1fd5e65SToby Isaac       ierr = PetscMemcpy(b->comps, ids, len*sizeof(PetscInt));CHKERRQ(ierr);
251f1fd5e65SToby Isaac     }
252f1fd5e65SToby Isaac   }
2532764a2aaSMatthew G. Knepley   ierr = PetscOptionsFList("-petscds_type", "Discrete System", "PetscDSSetType", PetscDSList, defaultType, name, 256, &flg);CHKERRQ(ierr);
2542764a2aaSMatthew G. Knepley   if (flg) {
2552764a2aaSMatthew G. Knepley     ierr = PetscDSSetType(prob, name);CHKERRQ(ierr);
2562764a2aaSMatthew G. Knepley   } else if (!((PetscObject) prob)->type_name) {
2572764a2aaSMatthew G. Knepley     ierr = PetscDSSetType(prob, defaultType);CHKERRQ(ierr);
2582764a2aaSMatthew G. Knepley   }
2592764a2aaSMatthew G. Knepley   if (prob->ops->setfromoptions) {ierr = (*prob->ops->setfromoptions)(prob);CHKERRQ(ierr);}
2602764a2aaSMatthew G. Knepley   /* process any options handlers added with PetscObjectAddOptionsHandler() */
2610633abcbSJed Brown   ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject) prob);CHKERRQ(ierr);
2622764a2aaSMatthew G. Knepley   ierr = PetscOptionsEnd();CHKERRQ(ierr);
2632764a2aaSMatthew G. Knepley   ierr = PetscDSViewFromOptions(prob, NULL, "-petscds_view");CHKERRQ(ierr);
2642764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
2652764a2aaSMatthew G. Knepley }
2662764a2aaSMatthew G. Knepley 
2672764a2aaSMatthew G. Knepley /*@C
2682764a2aaSMatthew G. Knepley   PetscDSSetUp - Construct data structures for the PetscDS
2692764a2aaSMatthew G. Knepley 
2702764a2aaSMatthew G. Knepley   Collective on PetscDS
2712764a2aaSMatthew G. Knepley 
2722764a2aaSMatthew G. Knepley   Input Parameter:
2732764a2aaSMatthew G. Knepley . prob - the PetscDS object to setup
2742764a2aaSMatthew G. Knepley 
2752764a2aaSMatthew G. Knepley   Level: developer
2762764a2aaSMatthew G. Knepley 
2772764a2aaSMatthew G. Knepley .seealso PetscDSView(), PetscDSDestroy()
2782764a2aaSMatthew G. Knepley @*/
2792764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetUp(PetscDS prob)
2802764a2aaSMatthew G. Knepley {
2812764a2aaSMatthew G. Knepley   const PetscInt Nf = prob->Nf;
2822764a2aaSMatthew G. Knepley   PetscInt       dim, work, NcMax = 0, NqMax = 0, f;
2832764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
2842764a2aaSMatthew G. Knepley 
2852764a2aaSMatthew G. Knepley   PetscFunctionBegin;
2862764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2872764a2aaSMatthew G. Knepley   if (prob->setup) PetscFunctionReturn(0);
2882764a2aaSMatthew G. Knepley   /* Calculate sizes */
2892764a2aaSMatthew G. Knepley   ierr = PetscDSGetSpatialDimension(prob, &dim);CHKERRQ(ierr);
290f744cafaSSander Arens   prob->totDim = prob->totComp = 0;
29147e57110SSander Arens   ierr = PetscMalloc2(Nf,&prob->Nc,Nf,&prob->Nb);CHKERRQ(ierr);
292f744cafaSSander Arens   ierr = PetscCalloc2(Nf+1,&prob->off,Nf+1,&prob->offDer);CHKERRQ(ierr);
293f744cafaSSander Arens   ierr = PetscMalloc4(Nf,&prob->basis,Nf,&prob->basisDer,Nf,&prob->basisFace,Nf,&prob->basisDerFace);CHKERRQ(ierr);
2942764a2aaSMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
2959de99aefSMatthew G. Knepley     PetscObject     obj;
2969de99aefSMatthew G. Knepley     PetscClassId    id;
2972764a2aaSMatthew G. Knepley     PetscQuadrature q;
2989de99aefSMatthew G. Knepley     PetscInt        Nq = 0, Nb, Nc;
2992764a2aaSMatthew G. Knepley 
3009de99aefSMatthew G. Knepley     ierr = PetscDSGetDiscretization(prob, f, &obj);CHKERRQ(ierr);
3019de99aefSMatthew G. Knepley     ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr);
3029de99aefSMatthew G. Knepley     if (id == PETSCFE_CLASSID)      {
3039de99aefSMatthew G. Knepley       PetscFE fe = (PetscFE) obj;
3049de99aefSMatthew G. Knepley 
3052764a2aaSMatthew G. Knepley       ierr = PetscFEGetQuadrature(fe, &q);CHKERRQ(ierr);
3062764a2aaSMatthew G. Knepley       ierr = PetscFEGetDimension(fe, &Nb);CHKERRQ(ierr);
3072764a2aaSMatthew G. Knepley       ierr = PetscFEGetNumComponents(fe, &Nc);CHKERRQ(ierr);
3082764a2aaSMatthew G. Knepley       ierr = PetscFEGetDefaultTabulation(fe, &prob->basis[f], &prob->basisDer[f], NULL);CHKERRQ(ierr);
3094d0b9603SSander Arens       ierr = PetscFEGetFaceTabulation(fe, &prob->basisFace[f], &prob->basisDerFace[f], NULL);CHKERRQ(ierr);
3109de99aefSMatthew G. Knepley     } else if (id == PETSCFV_CLASSID) {
3119de99aefSMatthew G. Knepley       PetscFV fv = (PetscFV) obj;
3129de99aefSMatthew G. Knepley 
3139de99aefSMatthew G. Knepley       ierr = PetscFVGetQuadrature(fv, &q);CHKERRQ(ierr);
3149de99aefSMatthew G. Knepley       ierr = PetscFVGetNumComponents(fv, &Nc);CHKERRQ(ierr);
3159c3cf19fSMatthew G. Knepley       Nb   = Nc;
3166c1a3d01SMatthew G. Knepley       ierr = PetscFVGetDefaultTabulation(fv, &prob->basis[f], &prob->basisDer[f], NULL);CHKERRQ(ierr);
3174d0b9603SSander Arens       /* TODO: should PetscFV also have face tabulation? Otherwise there will be a null pointer in prob->basisFace */
318abac5ca0SMatthew G. Knepley     } else SETERRQ1(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Unknown discretization type for field %d", f);
31947e57110SSander Arens     prob->Nc[f]       = Nc;
32047e57110SSander Arens     prob->Nb[f]       = Nb;
321194d53e6SMatthew G. Knepley     prob->off[f+1]    = Nc     + prob->off[f];
322194d53e6SMatthew G. Knepley     prob->offDer[f+1] = Nc*dim + prob->offDer[f];
323a6b92713SMatthew G. Knepley     if (q) {ierr = PetscQuadratureGetData(q, NULL, NULL, &Nq, NULL, NULL);CHKERRQ(ierr);}
3242764a2aaSMatthew G. Knepley     NqMax          = PetscMax(NqMax, Nq);
3252764a2aaSMatthew G. Knepley     NcMax          = PetscMax(NcMax, Nc);
3269c3cf19fSMatthew G. Knepley     prob->totDim  += Nb;
3272764a2aaSMatthew G. Knepley     prob->totComp += Nc;
3282764a2aaSMatthew G. Knepley   }
3292764a2aaSMatthew G. Knepley   work = PetscMax(prob->totComp*dim, PetscSqr(NcMax*dim));
3302764a2aaSMatthew G. Knepley   /* Allocate works space */
3312764a2aaSMatthew G. Knepley   ierr = PetscMalloc5(prob->totComp,&prob->u,prob->totComp,&prob->u_t,prob->totComp*dim,&prob->u_x,dim,&prob->x,work,&prob->refSpaceDer);CHKERRQ(ierr);
3322764a2aaSMatthew 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);
3332764a2aaSMatthew G. Knepley   if (prob->ops->setup) {ierr = (*prob->ops->setup)(prob);CHKERRQ(ierr);}
3342764a2aaSMatthew G. Knepley   prob->setup = PETSC_TRUE;
3352764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
3362764a2aaSMatthew G. Knepley }
3372764a2aaSMatthew G. Knepley 
3382764a2aaSMatthew G. Knepley static PetscErrorCode PetscDSDestroyStructs_Static(PetscDS prob)
3392764a2aaSMatthew G. Knepley {
3402764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
3412764a2aaSMatthew G. Knepley 
3422764a2aaSMatthew G. Knepley   PetscFunctionBegin;
34347e57110SSander Arens   ierr = PetscFree2(prob->Nc,prob->Nb);CHKERRQ(ierr);
344f744cafaSSander Arens   ierr = PetscFree2(prob->off,prob->offDer);CHKERRQ(ierr);
345f744cafaSSander Arens   ierr = PetscFree4(prob->basis,prob->basisDer,prob->basisFace,prob->basisDerFace);CHKERRQ(ierr);
3462764a2aaSMatthew G. Knepley   ierr = PetscFree5(prob->u,prob->u_t,prob->u_x,prob->x,prob->refSpaceDer);CHKERRQ(ierr);
3472764a2aaSMatthew G. Knepley   ierr = PetscFree6(prob->f0,prob->f1,prob->g0,prob->g1,prob->g2,prob->g3);CHKERRQ(ierr);
3482764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
3492764a2aaSMatthew G. Knepley }
3502764a2aaSMatthew G. Knepley 
3512764a2aaSMatthew G. Knepley static PetscErrorCode PetscDSEnlarge_Static(PetscDS prob, PetscInt NfNew)
3522764a2aaSMatthew G. Knepley {
353f744cafaSSander Arens   PetscObject      *tmpd;
354a6cbbb48SMatthew G. Knepley   PetscBool        *tmpi, *tmpa;
35532d2bbc9SMatthew G. Knepley   PetscPointFunc   *tmpobj, *tmpf, *tmpup;
356b7e05686SMatthew G. Knepley   PetscPointJac    *tmpg, *tmpgp, *tmpgt;
3572aa1fc23SMatthew G. Knepley   PetscBdPointFunc *tmpfbd;
3582aa1fc23SMatthew G. Knepley   PetscBdPointJac  *tmpgbd;
359194d53e6SMatthew G. Knepley   PetscRiemannFunc *tmpr;
3600c2f2876SMatthew G. Knepley   void            **tmpctx;
361a6cbbb48SMatthew G. Knepley   PetscInt          Nf = prob->Nf, f, i;
3622764a2aaSMatthew G. Knepley   PetscErrorCode    ierr;
3632764a2aaSMatthew G. Knepley 
3642764a2aaSMatthew G. Knepley   PetscFunctionBegin;
3652764a2aaSMatthew G. Knepley   if (Nf >= NfNew) PetscFunctionReturn(0);
3662764a2aaSMatthew G. Knepley   prob->setup = PETSC_FALSE;
3672764a2aaSMatthew G. Knepley   ierr = PetscDSDestroyStructs_Static(prob);CHKERRQ(ierr);
368f744cafaSSander Arens   ierr = PetscMalloc3(NfNew, &tmpd, NfNew, &tmpi, NfNew*2, &tmpa);CHKERRQ(ierr);
369f744cafaSSander 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];}
370f744cafaSSander 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;}
371f744cafaSSander Arens   ierr = PetscFree3(prob->disc, prob->implicit, prob->adjacency);CHKERRQ(ierr);
3722764a2aaSMatthew G. Knepley   prob->Nf        = NfNew;
3732764a2aaSMatthew G. Knepley   prob->disc      = tmpd;
374249df284SMatthew G. Knepley   prob->implicit  = tmpi;
375a6cbbb48SMatthew G. Knepley   prob->adjacency = tmpa;
376b7e05686SMatthew 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);
37732d2bbc9SMatthew G. Knepley   ierr = PetscCalloc1(NfNew, &tmpup);CHKERRQ(ierr);
3782764a2aaSMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpobj[f] = prob->obj[f];
3792764a2aaSMatthew G. Knepley   for (f = 0; f < Nf*2; ++f) tmpf[f] = prob->f[f];
3802764a2aaSMatthew G. Knepley   for (f = 0; f < Nf*Nf*4; ++f) tmpg[f] = prob->g[f];
381475e0ac9SMatthew G. Knepley   for (f = 0; f < Nf*Nf*4; ++f) tmpgp[f] = prob->gp[f];
3820c2f2876SMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpr[f] = prob->r[f];
38332d2bbc9SMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpup[f] = prob->update[f];
3840c2f2876SMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpctx[f] = prob->ctx[f];
3852764a2aaSMatthew G. Knepley   for (f = Nf; f < NfNew; ++f) tmpobj[f] = NULL;
3862764a2aaSMatthew G. Knepley   for (f = Nf*2; f < NfNew*2; ++f) tmpf[f] = NULL;
3872764a2aaSMatthew G. Knepley   for (f = Nf*Nf*4; f < NfNew*NfNew*4; ++f) tmpg[f] = NULL;
388475e0ac9SMatthew G. Knepley   for (f = Nf*Nf*4; f < NfNew*NfNew*4; ++f) tmpgp[f] = NULL;
389b7e05686SMatthew G. Knepley   for (f = Nf*Nf*4; f < NfNew*NfNew*4; ++f) tmpgt[f] = NULL;
3900c2f2876SMatthew G. Knepley   for (f = Nf; f < NfNew; ++f) tmpr[f] = NULL;
39132d2bbc9SMatthew G. Knepley   for (f = Nf; f < NfNew; ++f) tmpup[f] = NULL;
3920c2f2876SMatthew G. Knepley   for (f = Nf; f < NfNew; ++f) tmpctx[f] = NULL;
393b7e05686SMatthew G. Knepley   ierr = PetscFree7(prob->obj, prob->f, prob->g, prob->gp, prob->gt, prob->r, prob->ctx);CHKERRQ(ierr);
39432d2bbc9SMatthew G. Knepley   ierr = PetscFree(prob->update);CHKERRQ(ierr);
3952764a2aaSMatthew G. Knepley   prob->obj = tmpobj;
3962764a2aaSMatthew G. Knepley   prob->f   = tmpf;
3972764a2aaSMatthew G. Knepley   prob->g   = tmpg;
398475e0ac9SMatthew G. Knepley   prob->gp  = tmpgp;
399b7e05686SMatthew G. Knepley   prob->gt  = tmpgt;
4000c2f2876SMatthew G. Knepley   prob->r   = tmpr;
40132d2bbc9SMatthew G. Knepley   prob->update = tmpup;
4020c2f2876SMatthew G. Knepley   prob->ctx = tmpctx;
4032764a2aaSMatthew G. Knepley   ierr = PetscCalloc2(NfNew*2, &tmpfbd, NfNew*NfNew*4, &tmpgbd);CHKERRQ(ierr);
4042764a2aaSMatthew G. Knepley   for (f = 0; f < Nf*2; ++f) tmpfbd[f] = prob->fBd[f];
4052764a2aaSMatthew G. Knepley   for (f = 0; f < Nf*Nf*4; ++f) tmpgbd[f] = prob->gBd[f];
4062764a2aaSMatthew G. Knepley   for (f = Nf*2; f < NfNew*2; ++f) tmpfbd[f] = NULL;
4072764a2aaSMatthew G. Knepley   for (f = Nf*Nf*4; f < NfNew*NfNew*4; ++f) tmpgbd[f] = NULL;
4082764a2aaSMatthew G. Knepley   ierr = PetscFree2(prob->fBd, prob->gBd);CHKERRQ(ierr);
4092764a2aaSMatthew G. Knepley   prob->fBd = tmpfbd;
4102764a2aaSMatthew G. Knepley   prob->gBd = tmpgbd;
4112764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
4122764a2aaSMatthew G. Knepley }
4132764a2aaSMatthew G. Knepley 
4142764a2aaSMatthew G. Knepley /*@
4152764a2aaSMatthew G. Knepley   PetscDSDestroy - Destroys a PetscDS object
4162764a2aaSMatthew G. Knepley 
4172764a2aaSMatthew G. Knepley   Collective on PetscDS
4182764a2aaSMatthew G. Knepley 
4192764a2aaSMatthew G. Knepley   Input Parameter:
4202764a2aaSMatthew G. Knepley . prob - the PetscDS object to destroy
4212764a2aaSMatthew G. Knepley 
4222764a2aaSMatthew G. Knepley   Level: developer
4232764a2aaSMatthew G. Knepley 
4242764a2aaSMatthew G. Knepley .seealso PetscDSView()
4252764a2aaSMatthew G. Knepley @*/
4262764a2aaSMatthew G. Knepley PetscErrorCode PetscDSDestroy(PetscDS *prob)
4272764a2aaSMatthew G. Knepley {
4282764a2aaSMatthew G. Knepley   PetscInt       f;
42958ebd649SToby Isaac   DSBoundary     next;
4302764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
4312764a2aaSMatthew G. Knepley 
4322764a2aaSMatthew G. Knepley   PetscFunctionBegin;
4332764a2aaSMatthew G. Knepley   if (!*prob) PetscFunctionReturn(0);
4342764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific((*prob), PETSCDS_CLASSID, 1);
4352764a2aaSMatthew G. Knepley 
4362764a2aaSMatthew G. Knepley   if (--((PetscObject)(*prob))->refct > 0) {*prob = 0; PetscFunctionReturn(0);}
4372764a2aaSMatthew G. Knepley   ((PetscObject) (*prob))->refct = 0;
4382764a2aaSMatthew G. Knepley   ierr = PetscDSDestroyStructs_Static(*prob);CHKERRQ(ierr);
4392764a2aaSMatthew G. Knepley   for (f = 0; f < (*prob)->Nf; ++f) {
4402764a2aaSMatthew G. Knepley     ierr = PetscObjectDereference((*prob)->disc[f]);CHKERRQ(ierr);
4412764a2aaSMatthew G. Knepley   }
442f744cafaSSander Arens   ierr = PetscFree3((*prob)->disc, (*prob)->implicit, (*prob)->adjacency);CHKERRQ(ierr);
443b7e05686SMatthew G. Knepley   ierr = PetscFree7((*prob)->obj,(*prob)->f,(*prob)->g,(*prob)->gp,(*prob)->gt,(*prob)->r,(*prob)->ctx);CHKERRQ(ierr);
44432d2bbc9SMatthew G. Knepley   ierr = PetscFree((*prob)->update);CHKERRQ(ierr);
4452764a2aaSMatthew G. Knepley   ierr = PetscFree2((*prob)->fBd,(*prob)->gBd);CHKERRQ(ierr);
4462764a2aaSMatthew G. Knepley   if ((*prob)->ops->destroy) {ierr = (*(*prob)->ops->destroy)(*prob);CHKERRQ(ierr);}
44758ebd649SToby Isaac   next = (*prob)->boundary;
44858ebd649SToby Isaac   while (next) {
44958ebd649SToby Isaac     DSBoundary b = next;
45058ebd649SToby Isaac 
45158ebd649SToby Isaac     next = b->next;
45258ebd649SToby Isaac     ierr = PetscFree(b->comps);CHKERRQ(ierr);
45358ebd649SToby Isaac     ierr = PetscFree(b->ids);CHKERRQ(ierr);
45458ebd649SToby Isaac     ierr = PetscFree(b->name);CHKERRQ(ierr);
45558ebd649SToby Isaac     ierr = PetscFree(b->labelname);CHKERRQ(ierr);
45658ebd649SToby Isaac     ierr = PetscFree(b);CHKERRQ(ierr);
45758ebd649SToby Isaac   }
4582764a2aaSMatthew G. Knepley   ierr = PetscHeaderDestroy(prob);CHKERRQ(ierr);
4592764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
4602764a2aaSMatthew G. Knepley }
4612764a2aaSMatthew G. Knepley 
4622764a2aaSMatthew G. Knepley /*@
4632764a2aaSMatthew G. Knepley   PetscDSCreate - Creates an empty PetscDS object. The type can then be set with PetscDSSetType().
4642764a2aaSMatthew G. Knepley 
4652764a2aaSMatthew G. Knepley   Collective on MPI_Comm
4662764a2aaSMatthew G. Knepley 
4672764a2aaSMatthew G. Knepley   Input Parameter:
4682764a2aaSMatthew G. Knepley . comm - The communicator for the PetscDS object
4692764a2aaSMatthew G. Knepley 
4702764a2aaSMatthew G. Knepley   Output Parameter:
4712764a2aaSMatthew G. Knepley . prob - The PetscDS object
4722764a2aaSMatthew G. Knepley 
4732764a2aaSMatthew G. Knepley   Level: beginner
4742764a2aaSMatthew G. Knepley 
4752764a2aaSMatthew G. Knepley .seealso: PetscDSSetType(), PETSCDSBASIC
4762764a2aaSMatthew G. Knepley @*/
4772764a2aaSMatthew G. Knepley PetscErrorCode PetscDSCreate(MPI_Comm comm, PetscDS *prob)
4782764a2aaSMatthew G. Knepley {
4792764a2aaSMatthew G. Knepley   PetscDS   p;
4802764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
4812764a2aaSMatthew G. Knepley 
4822764a2aaSMatthew G. Knepley   PetscFunctionBegin;
4832764a2aaSMatthew G. Knepley   PetscValidPointer(prob, 2);
4842764a2aaSMatthew G. Knepley   *prob  = NULL;
4852764a2aaSMatthew G. Knepley   ierr = PetscDSInitializePackage();CHKERRQ(ierr);
4862764a2aaSMatthew G. Knepley 
48773107ff1SLisandro Dalcin   ierr = PetscHeaderCreate(p, PETSCDS_CLASSID, "PetscDS", "Discrete System", "PetscDS", comm, PetscDSDestroy, PetscDSView);CHKERRQ(ierr);
4882764a2aaSMatthew G. Knepley 
4892764a2aaSMatthew G. Knepley   p->Nf    = 0;
4902764a2aaSMatthew G. Knepley   p->setup = PETSC_FALSE;
4912764a2aaSMatthew G. Knepley 
4922764a2aaSMatthew G. Knepley   *prob = p;
4932764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
4942764a2aaSMatthew G. Knepley }
4952764a2aaSMatthew G. Knepley 
496bc4ae4beSMatthew G. Knepley /*@
497bc4ae4beSMatthew G. Knepley   PetscDSGetNumFields - Returns the number of fields in the DS
498bc4ae4beSMatthew G. Knepley 
499bc4ae4beSMatthew G. Knepley   Not collective
500bc4ae4beSMatthew G. Knepley 
501bc4ae4beSMatthew G. Knepley   Input Parameter:
502bc4ae4beSMatthew G. Knepley . prob - The PetscDS object
503bc4ae4beSMatthew G. Knepley 
504bc4ae4beSMatthew G. Knepley   Output Parameter:
505bc4ae4beSMatthew G. Knepley . Nf - The number of fields
506bc4ae4beSMatthew G. Knepley 
507bc4ae4beSMatthew G. Knepley   Level: beginner
508bc4ae4beSMatthew G. Knepley 
509bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetSpatialDimension(), PetscDSCreate()
510bc4ae4beSMatthew G. Knepley @*/
5112764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetNumFields(PetscDS prob, PetscInt *Nf)
5122764a2aaSMatthew G. Knepley {
5132764a2aaSMatthew G. Knepley   PetscFunctionBegin;
5142764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
5152764a2aaSMatthew G. Knepley   PetscValidPointer(Nf, 2);
5162764a2aaSMatthew G. Knepley   *Nf = prob->Nf;
5172764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
5182764a2aaSMatthew G. Knepley }
5192764a2aaSMatthew G. Knepley 
520bc4ae4beSMatthew G. Knepley /*@
521bc4ae4beSMatthew G. Knepley   PetscDSGetSpatialDimension - Returns the spatial dimension of the DS
522bc4ae4beSMatthew G. Knepley 
523bc4ae4beSMatthew G. Knepley   Not collective
524bc4ae4beSMatthew G. Knepley 
525bc4ae4beSMatthew G. Knepley   Input Parameter:
526bc4ae4beSMatthew G. Knepley . prob - The PetscDS object
527bc4ae4beSMatthew G. Knepley 
528bc4ae4beSMatthew G. Knepley   Output Parameter:
529bc4ae4beSMatthew G. Knepley . dim - The spatial dimension
530bc4ae4beSMatthew G. Knepley 
531bc4ae4beSMatthew G. Knepley   Level: beginner
532bc4ae4beSMatthew G. Knepley 
533bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetNumFields(), PetscDSCreate()
534bc4ae4beSMatthew G. Knepley @*/
5352764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetSpatialDimension(PetscDS prob, PetscInt *dim)
5362764a2aaSMatthew G. Knepley {
5372764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
5382764a2aaSMatthew G. Knepley 
5392764a2aaSMatthew G. Knepley   PetscFunctionBegin;
5402764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
5412764a2aaSMatthew G. Knepley   PetscValidPointer(dim, 2);
5422764a2aaSMatthew G. Knepley   *dim = 0;
5439de99aefSMatthew G. Knepley   if (prob->Nf) {
5449de99aefSMatthew G. Knepley     PetscObject  obj;
5459de99aefSMatthew G. Knepley     PetscClassId id;
5469de99aefSMatthew G. Knepley 
5479de99aefSMatthew G. Knepley     ierr = PetscDSGetDiscretization(prob, 0, &obj);CHKERRQ(ierr);
5489de99aefSMatthew G. Knepley     ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr);
5499de99aefSMatthew G. Knepley     if (id == PETSCFE_CLASSID)      {ierr = PetscFEGetSpatialDimension((PetscFE) obj, dim);CHKERRQ(ierr);}
5509de99aefSMatthew G. Knepley     else if (id == PETSCFV_CLASSID) {ierr = PetscFVGetSpatialDimension((PetscFV) obj, dim);CHKERRQ(ierr);}
5519de99aefSMatthew G. Knepley     else SETERRQ1(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Unknown discretization type for field %d", 0);
5529de99aefSMatthew G. Knepley   }
5532764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
5542764a2aaSMatthew G. Knepley }
5552764a2aaSMatthew G. Knepley 
556bc4ae4beSMatthew G. Knepley /*@
557bc4ae4beSMatthew G. Knepley   PetscDSGetTotalDimension - Returns the total size of the approximation space for this system
558bc4ae4beSMatthew G. Knepley 
559bc4ae4beSMatthew G. Knepley   Not collective
560bc4ae4beSMatthew G. Knepley 
561bc4ae4beSMatthew G. Knepley   Input Parameter:
562bc4ae4beSMatthew G. Knepley . prob - The PetscDS object
563bc4ae4beSMatthew G. Knepley 
564bc4ae4beSMatthew G. Knepley   Output Parameter:
565bc4ae4beSMatthew G. Knepley . dim - The total problem dimension
566bc4ae4beSMatthew G. Knepley 
567bc4ae4beSMatthew G. Knepley   Level: beginner
568bc4ae4beSMatthew G. Knepley 
569bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetNumFields(), PetscDSCreate()
570bc4ae4beSMatthew G. Knepley @*/
5712764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetTotalDimension(PetscDS prob, PetscInt *dim)
5722764a2aaSMatthew G. Knepley {
5732764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
5742764a2aaSMatthew G. Knepley 
5752764a2aaSMatthew G. Knepley   PetscFunctionBegin;
5762764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
5772764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
5782764a2aaSMatthew G. Knepley   PetscValidPointer(dim, 2);
5792764a2aaSMatthew G. Knepley   *dim = prob->totDim;
5802764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
5812764a2aaSMatthew G. Knepley }
5822764a2aaSMatthew G. Knepley 
583bc4ae4beSMatthew G. Knepley /*@
584bc4ae4beSMatthew G. Knepley   PetscDSGetTotalComponents - Returns the total number of components in this system
585bc4ae4beSMatthew G. Knepley 
586bc4ae4beSMatthew G. Knepley   Not collective
587bc4ae4beSMatthew G. Knepley 
588bc4ae4beSMatthew G. Knepley   Input Parameter:
589bc4ae4beSMatthew G. Knepley . prob - The PetscDS object
590bc4ae4beSMatthew G. Knepley 
591bc4ae4beSMatthew G. Knepley   Output Parameter:
592bc4ae4beSMatthew G. Knepley . dim - The total number of components
593bc4ae4beSMatthew G. Knepley 
594bc4ae4beSMatthew G. Knepley   Level: beginner
595bc4ae4beSMatthew G. Knepley 
596bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetNumFields(), PetscDSCreate()
597bc4ae4beSMatthew G. Knepley @*/
5982764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetTotalComponents(PetscDS prob, PetscInt *Nc)
5992764a2aaSMatthew G. Knepley {
6002764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
6012764a2aaSMatthew G. Knepley 
6022764a2aaSMatthew G. Knepley   PetscFunctionBegin;
6032764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
6042764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
6052764a2aaSMatthew G. Knepley   PetscValidPointer(Nc, 2);
6062764a2aaSMatthew G. Knepley   *Nc = prob->totComp;
6072764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
6082764a2aaSMatthew G. Knepley }
6092764a2aaSMatthew G. Knepley 
610bc4ae4beSMatthew G. Knepley /*@
611bc4ae4beSMatthew G. Knepley   PetscDSGetDiscretization - Returns the discretization object for the given field
612bc4ae4beSMatthew G. Knepley 
613bc4ae4beSMatthew G. Knepley   Not collective
614bc4ae4beSMatthew G. Knepley 
615bc4ae4beSMatthew G. Knepley   Input Parameters:
616bc4ae4beSMatthew G. Knepley + prob - The PetscDS object
617bc4ae4beSMatthew G. Knepley - f - The field number
618bc4ae4beSMatthew G. Knepley 
619bc4ae4beSMatthew G. Knepley   Output Parameter:
620bc4ae4beSMatthew G. Knepley . disc - The discretization object
621bc4ae4beSMatthew G. Knepley 
622bc4ae4beSMatthew G. Knepley   Level: beginner
623bc4ae4beSMatthew G. Knepley 
624f744cafaSSander Arens .seealso: PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
625bc4ae4beSMatthew G. Knepley @*/
6262764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetDiscretization(PetscDS prob, PetscInt f, PetscObject *disc)
6272764a2aaSMatthew G. Knepley {
6282764a2aaSMatthew G. Knepley   PetscFunctionBegin;
6292764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
6302764a2aaSMatthew G. Knepley   PetscValidPointer(disc, 3);
6312764a2aaSMatthew 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);
6322764a2aaSMatthew G. Knepley   *disc = prob->disc[f];
6332764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
6342764a2aaSMatthew G. Knepley }
6352764a2aaSMatthew G. Knepley 
636bc4ae4beSMatthew G. Knepley /*@
637bc4ae4beSMatthew G. Knepley   PetscDSSetDiscretization - Sets the discretization object for the given field
638bc4ae4beSMatthew G. Knepley 
639bc4ae4beSMatthew G. Knepley   Not collective
640bc4ae4beSMatthew G. Knepley 
641bc4ae4beSMatthew G. Knepley   Input Parameters:
642bc4ae4beSMatthew G. Knepley + prob - The PetscDS object
643bc4ae4beSMatthew G. Knepley . f - The field number
644bc4ae4beSMatthew G. Knepley - disc - The discretization object
645bc4ae4beSMatthew G. Knepley 
646bc4ae4beSMatthew G. Knepley   Level: beginner
647bc4ae4beSMatthew G. Knepley 
648bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
649bc4ae4beSMatthew G. Knepley @*/
6502764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetDiscretization(PetscDS prob, PetscInt f, PetscObject disc)
6512764a2aaSMatthew G. Knepley {
6522764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
6532764a2aaSMatthew G. Knepley 
6542764a2aaSMatthew G. Knepley   PetscFunctionBegin;
6552764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
6562764a2aaSMatthew G. Knepley   PetscValidPointer(disc, 3);
6572764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
6582764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
6592764a2aaSMatthew G. Knepley   if (prob->disc[f]) {ierr = PetscObjectDereference(prob->disc[f]);CHKERRQ(ierr);}
6602764a2aaSMatthew G. Knepley   prob->disc[f] = disc;
6612764a2aaSMatthew G. Knepley   ierr = PetscObjectReference(disc);CHKERRQ(ierr);
662249df284SMatthew G. Knepley   {
663249df284SMatthew G. Knepley     PetscClassId id;
664249df284SMatthew G. Knepley 
665249df284SMatthew G. Knepley     ierr = PetscObjectGetClassId(disc, &id);CHKERRQ(ierr);
666a6cbbb48SMatthew G. Knepley     if (id == PETSCFV_CLASSID) {
667a6cbbb48SMatthew G. Knepley       prob->implicit[f]      = PETSC_FALSE;
668a6cbbb48SMatthew G. Knepley       prob->adjacency[f*2+0] = PETSC_TRUE;
669a6cbbb48SMatthew G. Knepley       prob->adjacency[f*2+1] = PETSC_FALSE;
670a6cbbb48SMatthew G. Knepley     }
671249df284SMatthew G. Knepley   }
6722764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
6732764a2aaSMatthew G. Knepley }
6742764a2aaSMatthew G. Knepley 
675bc4ae4beSMatthew G. Knepley /*@
676bc4ae4beSMatthew G. Knepley   PetscDSAddDiscretization - Adds a discretization object
677bc4ae4beSMatthew G. Knepley 
678bc4ae4beSMatthew G. Knepley   Not collective
679bc4ae4beSMatthew G. Knepley 
680bc4ae4beSMatthew G. Knepley   Input Parameters:
681bc4ae4beSMatthew G. Knepley + prob - The PetscDS object
682bc4ae4beSMatthew G. Knepley - disc - The boundary discretization object
683bc4ae4beSMatthew G. Knepley 
684bc4ae4beSMatthew G. Knepley   Level: beginner
685bc4ae4beSMatthew G. Knepley 
686bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetDiscretization(), PetscDSSetDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
687bc4ae4beSMatthew G. Knepley @*/
6882764a2aaSMatthew G. Knepley PetscErrorCode PetscDSAddDiscretization(PetscDS prob, PetscObject disc)
6892764a2aaSMatthew G. Knepley {
6902764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
6912764a2aaSMatthew G. Knepley 
6922764a2aaSMatthew G. Knepley   PetscFunctionBegin;
6932764a2aaSMatthew G. Knepley   ierr = PetscDSSetDiscretization(prob, prob->Nf, disc);CHKERRQ(ierr);
6942764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
6952764a2aaSMatthew G. Knepley }
6962764a2aaSMatthew G. Knepley 
697249df284SMatthew G. Knepley /*@
698249df284SMatthew G. Knepley   PetscDSGetImplicit - Returns the flag for implicit solve for this field. This is just a guide for IMEX
699249df284SMatthew G. Knepley 
700249df284SMatthew G. Knepley   Not collective
701249df284SMatthew G. Knepley 
702249df284SMatthew G. Knepley   Input Parameters:
703249df284SMatthew G. Knepley + prob - The PetscDS object
704249df284SMatthew G. Knepley - f - The field number
705249df284SMatthew G. Knepley 
706249df284SMatthew G. Knepley   Output Parameter:
707249df284SMatthew G. Knepley . implicit - The flag indicating what kind of solve to use for this field
708249df284SMatthew G. Knepley 
709249df284SMatthew G. Knepley   Level: developer
710249df284SMatthew G. Knepley 
711f744cafaSSander Arens .seealso: PetscDSSetImplicit(), PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
712249df284SMatthew G. Knepley @*/
713249df284SMatthew G. Knepley PetscErrorCode PetscDSGetImplicit(PetscDS prob, PetscInt f, PetscBool *implicit)
714249df284SMatthew G. Knepley {
715249df284SMatthew G. Knepley   PetscFunctionBegin;
716249df284SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
717249df284SMatthew G. Knepley   PetscValidPointer(implicit, 3);
718249df284SMatthew 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);
719249df284SMatthew G. Knepley   *implicit = prob->implicit[f];
720249df284SMatthew G. Knepley   PetscFunctionReturn(0);
721249df284SMatthew G. Knepley }
722249df284SMatthew G. Knepley 
723249df284SMatthew G. Knepley /*@
724249df284SMatthew G. Knepley   PetscDSSetImplicit - Set the flag for implicit solve for this field. This is just a guide for IMEX
725249df284SMatthew G. Knepley 
726249df284SMatthew G. Knepley   Not collective
727249df284SMatthew G. Knepley 
728249df284SMatthew G. Knepley   Input Parameters:
729249df284SMatthew G. Knepley + prob - The PetscDS object
730249df284SMatthew G. Knepley . f - The field number
731249df284SMatthew G. Knepley - implicit - The flag indicating what kind of solve to use for this field
732249df284SMatthew G. Knepley 
733249df284SMatthew G. Knepley   Level: developer
734249df284SMatthew G. Knepley 
735f744cafaSSander Arens .seealso: PetscDSGetImplicit(), PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
736249df284SMatthew G. Knepley @*/
737249df284SMatthew G. Knepley PetscErrorCode PetscDSSetImplicit(PetscDS prob, PetscInt f, PetscBool implicit)
738249df284SMatthew G. Knepley {
739249df284SMatthew G. Knepley   PetscFunctionBegin;
740249df284SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
741249df284SMatthew 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);
742249df284SMatthew G. Knepley   prob->implicit[f] = implicit;
743249df284SMatthew G. Knepley   PetscFunctionReturn(0);
744249df284SMatthew G. Knepley }
745249df284SMatthew G. Knepley 
746a6cbbb48SMatthew G. Knepley /*@
747a6cbbb48SMatthew G. Knepley   PetscDSGetAdjacency - Returns the flags for determining variable influence
748a6cbbb48SMatthew G. Knepley 
749a6cbbb48SMatthew G. Knepley   Not collective
750a6cbbb48SMatthew G. Knepley 
751a6cbbb48SMatthew G. Knepley   Input Parameters:
752a6cbbb48SMatthew G. Knepley + prob - The PetscDS object
753a6cbbb48SMatthew G. Knepley - f - The field number
754a6cbbb48SMatthew G. Knepley 
755a6cbbb48SMatthew G. Knepley   Output Parameter:
756a6cbbb48SMatthew G. Knepley + useCone    - Flag for variable influence starting with the cone operation
757a6cbbb48SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
758a6cbbb48SMatthew G. Knepley 
759a6cbbb48SMatthew G. Knepley   Note: See the discussion in DMPlexGetAdjacencyUseCone() and DMPlexGetAdjacencyUseClosure()
760a6cbbb48SMatthew G. Knepley 
761a6cbbb48SMatthew G. Knepley   Level: developer
762a6cbbb48SMatthew G. Knepley 
763f744cafaSSander Arens .seealso: PetscDSSetAdjacency(), DMPlexGetAdjacencyUseCone(), DMPlexGetAdjacencyUseClosure(), PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
764a6cbbb48SMatthew G. Knepley @*/
765a6cbbb48SMatthew G. Knepley PetscErrorCode PetscDSGetAdjacency(PetscDS prob, PetscInt f, PetscBool *useCone, PetscBool *useClosure)
766a6cbbb48SMatthew G. Knepley {
767a6cbbb48SMatthew G. Knepley   PetscFunctionBegin;
768a6cbbb48SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
769a6cbbb48SMatthew G. Knepley   PetscValidPointer(useCone, 3);
770a6cbbb48SMatthew G. Knepley   PetscValidPointer(useClosure, 4);
771a6cbbb48SMatthew 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);
772a6cbbb48SMatthew G. Knepley   *useCone    = prob->adjacency[f*2+0];
773a6cbbb48SMatthew G. Knepley   *useClosure = prob->adjacency[f*2+1];
774a6cbbb48SMatthew G. Knepley   PetscFunctionReturn(0);
775a6cbbb48SMatthew G. Knepley }
776a6cbbb48SMatthew G. Knepley 
777a6cbbb48SMatthew G. Knepley /*@
778a6cbbb48SMatthew G. Knepley   PetscDSSetAdjacency - Set the flags for determining variable influence
779a6cbbb48SMatthew G. Knepley 
780a6cbbb48SMatthew G. Knepley   Not collective
781a6cbbb48SMatthew G. Knepley 
782a6cbbb48SMatthew G. Knepley   Input Parameters:
783a6cbbb48SMatthew G. Knepley + prob - The PetscDS object
784a6cbbb48SMatthew G. Knepley . f - The field number
785a6cbbb48SMatthew G. Knepley . useCone    - Flag for variable influence starting with the cone operation
786a6cbbb48SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
787a6cbbb48SMatthew G. Knepley 
788a6cbbb48SMatthew G. Knepley   Note: See the discussion in DMPlexGetAdjacencyUseCone() and DMPlexGetAdjacencyUseClosure()
789a6cbbb48SMatthew G. Knepley 
790a6cbbb48SMatthew G. Knepley   Level: developer
791a6cbbb48SMatthew G. Knepley 
792f744cafaSSander Arens .seealso: PetscDSGetAdjacency(), DMPlexGetAdjacencyUseCone(), DMPlexGetAdjacencyUseClosure(), PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
793a6cbbb48SMatthew G. Knepley @*/
794a6cbbb48SMatthew G. Knepley PetscErrorCode PetscDSSetAdjacency(PetscDS prob, PetscInt f, PetscBool useCone, PetscBool useClosure)
795a6cbbb48SMatthew G. Knepley {
796a6cbbb48SMatthew G. Knepley   PetscFunctionBegin;
797a6cbbb48SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
798a6cbbb48SMatthew 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);
799a6cbbb48SMatthew G. Knepley   prob->adjacency[f*2+0] = useCone;
800a6cbbb48SMatthew G. Knepley   prob->adjacency[f*2+1] = useClosure;
801a6cbbb48SMatthew G. Knepley   PetscFunctionReturn(0);
802a6cbbb48SMatthew G. Knepley }
803a6cbbb48SMatthew G. Knepley 
8042764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetObjective(PetscDS prob, PetscInt f,
80530b9ff8bSMatthew G. Knepley                                    void (**obj)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
806194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
807194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
80830b9ff8bSMatthew G. Knepley                                                 PetscReal t, const PetscReal x[], PetscScalar obj[]))
8092764a2aaSMatthew G. Knepley {
8102764a2aaSMatthew G. Knepley   PetscFunctionBegin;
8112764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
8122764a2aaSMatthew G. Knepley   PetscValidPointer(obj, 2);
8132764a2aaSMatthew 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);
8142764a2aaSMatthew G. Knepley   *obj = prob->obj[f];
8152764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
8162764a2aaSMatthew G. Knepley }
8172764a2aaSMatthew G. Knepley 
8182764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetObjective(PetscDS prob, PetscInt f,
81930b9ff8bSMatthew G. Knepley                                    void (*obj)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
820194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
821194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
82230b9ff8bSMatthew G. Knepley                                                PetscReal t, const PetscReal x[], PetscScalar obj[]))
8232764a2aaSMatthew G. Knepley {
8242764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
8252764a2aaSMatthew G. Knepley 
8262764a2aaSMatthew G. Knepley   PetscFunctionBegin;
8272764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
828de716cbcSToby Isaac   if (obj) PetscValidFunction(obj, 2);
8292764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
8302764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
8312764a2aaSMatthew G. Knepley   prob->obj[f] = obj;
8322764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
8332764a2aaSMatthew G. Knepley }
8342764a2aaSMatthew G. Knepley 
835194d53e6SMatthew G. Knepley /*@C
836194d53e6SMatthew G. Knepley   PetscDSGetResidual - Get the pointwise residual function for a given test field
837194d53e6SMatthew G. Knepley 
838194d53e6SMatthew G. Knepley   Not collective
839194d53e6SMatthew G. Knepley 
840194d53e6SMatthew G. Knepley   Input Parameters:
841194d53e6SMatthew G. Knepley + prob - The PetscDS
842194d53e6SMatthew G. Knepley - f    - The test field number
843194d53e6SMatthew G. Knepley 
844194d53e6SMatthew G. Knepley   Output Parameters:
845194d53e6SMatthew G. Knepley + f0 - integrand for the test function term
846194d53e6SMatthew G. Knepley - f1 - integrand for the test function gradient term
847194d53e6SMatthew G. Knepley 
848194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
849194d53e6SMatthew G. Knepley 
850194d53e6SMatthew 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)
851194d53e6SMatthew G. Knepley 
852194d53e6SMatthew G. Knepley The calling sequence for the callbacks f0 and f1 is given by:
853194d53e6SMatthew G. Knepley 
85430b9ff8bSMatthew G. Knepley $ f0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
855194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
856194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
85730b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], PetscScalar f0[])
858194d53e6SMatthew G. Knepley 
859194d53e6SMatthew G. Knepley + dim - the spatial dimension
860194d53e6SMatthew G. Knepley . Nf - the number of fields
861194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
862194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
863194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
864194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
865194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
866194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
867194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
868194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
869194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
870194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
871194d53e6SMatthew G. Knepley . t - current time
872194d53e6SMatthew G. Knepley . x - coordinates of the current point
873194d53e6SMatthew G. Knepley - f0 - output values at the current point
874194d53e6SMatthew G. Knepley 
875194d53e6SMatthew G. Knepley   Level: intermediate
876194d53e6SMatthew G. Knepley 
877194d53e6SMatthew G. Knepley .seealso: PetscDSSetResidual()
878194d53e6SMatthew G. Knepley @*/
8792764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetResidual(PetscDS prob, PetscInt f,
88030b9ff8bSMatthew G. Knepley                                   void (**f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
881194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
882194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
88330b9ff8bSMatthew G. Knepley                                               PetscReal t, const PetscReal x[], PetscScalar f0[]),
88430b9ff8bSMatthew G. Knepley                                   void (**f1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
885194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
886194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
88730b9ff8bSMatthew G. Knepley                                               PetscReal t, const PetscReal x[], PetscScalar f1[]))
8882764a2aaSMatthew G. Knepley {
8892764a2aaSMatthew G. Knepley   PetscFunctionBegin;
8902764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
8912764a2aaSMatthew 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);
8922764a2aaSMatthew G. Knepley   if (f0) {PetscValidPointer(f0, 3); *f0 = prob->f[f*2+0];}
8932764a2aaSMatthew G. Knepley   if (f1) {PetscValidPointer(f1, 4); *f1 = prob->f[f*2+1];}
8942764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
8952764a2aaSMatthew G. Knepley }
8962764a2aaSMatthew G. Knepley 
897194d53e6SMatthew G. Knepley /*@C
898194d53e6SMatthew G. Knepley   PetscDSSetResidual - Set the pointwise residual function for a given test field
899194d53e6SMatthew G. Knepley 
900194d53e6SMatthew G. Knepley   Not collective
901194d53e6SMatthew G. Knepley 
902194d53e6SMatthew G. Knepley   Input Parameters:
903194d53e6SMatthew G. Knepley + prob - The PetscDS
904194d53e6SMatthew G. Knepley . f    - The test field number
905194d53e6SMatthew G. Knepley . f0 - integrand for the test function term
906194d53e6SMatthew G. Knepley - f1 - integrand for the test function gradient term
907194d53e6SMatthew G. Knepley 
908194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
909194d53e6SMatthew G. Knepley 
910194d53e6SMatthew 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)
911194d53e6SMatthew G. Knepley 
912194d53e6SMatthew G. Knepley The calling sequence for the callbacks f0 and f1 is given by:
913194d53e6SMatthew G. Knepley 
91430b9ff8bSMatthew G. Knepley $ f0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
915194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
916194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
91730b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], PetscScalar f0[])
918194d53e6SMatthew G. Knepley 
919194d53e6SMatthew G. Knepley + dim - the spatial dimension
920194d53e6SMatthew G. Knepley . Nf - the number of fields
921194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
922194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
923194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
924194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
925194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
926194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
927194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
928194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
929194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
930194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
931194d53e6SMatthew G. Knepley . t - current time
932194d53e6SMatthew G. Knepley . x - coordinates of the current point
933194d53e6SMatthew G. Knepley - f0 - output values at the current point
934194d53e6SMatthew G. Knepley 
935194d53e6SMatthew G. Knepley   Level: intermediate
936194d53e6SMatthew G. Knepley 
937194d53e6SMatthew G. Knepley .seealso: PetscDSGetResidual()
938194d53e6SMatthew G. Knepley @*/
9392764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetResidual(PetscDS prob, PetscInt f,
94030b9ff8bSMatthew G. Knepley                                   void (*f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
941194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
942194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
94330b9ff8bSMatthew G. Knepley                                              PetscReal t, const PetscReal x[], PetscScalar f0[]),
94430b9ff8bSMatthew G. Knepley                                   void (*f1)(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 f1[]))
9482764a2aaSMatthew G. Knepley {
9492764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
9502764a2aaSMatthew G. Knepley 
9512764a2aaSMatthew G. Knepley   PetscFunctionBegin;
9522764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
953f866a1d0SMatthew G. Knepley   if (f0) PetscValidFunction(f0, 3);
954f866a1d0SMatthew G. Knepley   if (f1) PetscValidFunction(f1, 4);
9552764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
9562764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
9572764a2aaSMatthew G. Knepley   prob->f[f*2+0] = f0;
9582764a2aaSMatthew G. Knepley   prob->f[f*2+1] = f1;
9592764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
9602764a2aaSMatthew G. Knepley }
9612764a2aaSMatthew G. Knepley 
9623e75805dSMatthew G. Knepley /*@C
9633e75805dSMatthew G. Knepley   PetscDSHasJacobian - Signals that Jacobian functions have been set
9643e75805dSMatthew G. Knepley 
9653e75805dSMatthew G. Knepley   Not collective
9663e75805dSMatthew G. Knepley 
9673e75805dSMatthew G. Knepley   Input Parameter:
9683e75805dSMatthew G. Knepley . prob - The PetscDS
9693e75805dSMatthew G. Knepley 
9703e75805dSMatthew G. Knepley   Output Parameter:
9713e75805dSMatthew G. Knepley . hasJac - flag that pointwise function for the Jacobian has been set
9723e75805dSMatthew G. Knepley 
9733e75805dSMatthew G. Knepley   Level: intermediate
9743e75805dSMatthew G. Knepley 
9753e75805dSMatthew G. Knepley .seealso: PetscDSGetJacobianPreconditioner(), PetscDSSetJacobianPreconditioner(), PetscDSGetJacobian()
9763e75805dSMatthew G. Knepley @*/
9773e75805dSMatthew G. Knepley PetscErrorCode PetscDSHasJacobian(PetscDS prob, PetscBool *hasJac)
9783e75805dSMatthew G. Knepley {
9793e75805dSMatthew G. Knepley   PetscInt f, g, h;
9803e75805dSMatthew G. Knepley 
9813e75805dSMatthew G. Knepley   PetscFunctionBegin;
9823e75805dSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
9833e75805dSMatthew G. Knepley   *hasJac = PETSC_FALSE;
9843e75805dSMatthew G. Knepley   for (f = 0; f < prob->Nf; ++f) {
9853e75805dSMatthew G. Knepley     for (g = 0; g < prob->Nf; ++g) {
9863e75805dSMatthew G. Knepley       for (h = 0; h < 4; ++h) {
9873e75805dSMatthew G. Knepley         if (prob->g[(f*prob->Nf + g)*4+h]) *hasJac = PETSC_TRUE;
9883e75805dSMatthew G. Knepley       }
9893e75805dSMatthew G. Knepley     }
9903e75805dSMatthew G. Knepley   }
9913e75805dSMatthew G. Knepley   PetscFunctionReturn(0);
9923e75805dSMatthew G. Knepley }
9933e75805dSMatthew G. Knepley 
994194d53e6SMatthew G. Knepley /*@C
995194d53e6SMatthew G. Knepley   PetscDSGetJacobian - Get the pointwise Jacobian function for given test and basis field
996194d53e6SMatthew G. Knepley 
997194d53e6SMatthew G. Knepley   Not collective
998194d53e6SMatthew G. Knepley 
999194d53e6SMatthew G. Knepley   Input Parameters:
1000194d53e6SMatthew G. Knepley + prob - The PetscDS
1001194d53e6SMatthew G. Knepley . f    - The test field number
1002194d53e6SMatthew G. Knepley - g    - The field number
1003194d53e6SMatthew G. Knepley 
1004194d53e6SMatthew G. Knepley   Output Parameters:
1005194d53e6SMatthew G. Knepley + g0 - integrand for the test and basis function term
1006194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1007194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1008194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1009194d53e6SMatthew G. Knepley 
1010194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1011194d53e6SMatthew G. Knepley 
1012194d53e6SMatthew 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
1013194d53e6SMatthew G. Knepley 
1014194d53e6SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1015194d53e6SMatthew G. Knepley 
101630b9ff8bSMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1017194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1018194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
101930b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal u_tShift, const PetscReal x[], PetscScalar g0[])
1020194d53e6SMatthew G. Knepley 
1021194d53e6SMatthew G. Knepley + dim - the spatial dimension
1022194d53e6SMatthew G. Knepley . Nf - the number of fields
1023194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1024194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1025194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
1026194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1027194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1028194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1029194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1030194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1031194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1032194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1033194d53e6SMatthew G. Knepley . t - current time
10342aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1035194d53e6SMatthew G. Knepley . x - coordinates of the current point
1036194d53e6SMatthew G. Knepley - g0 - output values at the current point
1037194d53e6SMatthew G. Knepley 
1038194d53e6SMatthew G. Knepley   Level: intermediate
1039194d53e6SMatthew G. Knepley 
1040194d53e6SMatthew G. Knepley .seealso: PetscDSSetJacobian()
1041194d53e6SMatthew G. Knepley @*/
10422764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetJacobian(PetscDS prob, PetscInt f, PetscInt g,
104330b9ff8bSMatthew G. Knepley                                   void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1044194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1045194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
10462aa1fc23SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g0[]),
104730b9ff8bSMatthew G. Knepley                                   void (**g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1048194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1049194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
10502aa1fc23SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g1[]),
105130b9ff8bSMatthew G. Knepley                                   void (**g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1052194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1053194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
10542aa1fc23SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g2[]),
105530b9ff8bSMatthew G. Knepley                                   void (**g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1056194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1057194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
10582aa1fc23SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g3[]))
10592764a2aaSMatthew G. Knepley {
10602764a2aaSMatthew G. Knepley   PetscFunctionBegin;
10612764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
10622764a2aaSMatthew 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);
10632764a2aaSMatthew 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);
10642764a2aaSMatthew G. Knepley   if (g0) {PetscValidPointer(g0, 4); *g0 = prob->g[(f*prob->Nf + g)*4+0];}
10652764a2aaSMatthew G. Knepley   if (g1) {PetscValidPointer(g1, 5); *g1 = prob->g[(f*prob->Nf + g)*4+1];}
10662764a2aaSMatthew G. Knepley   if (g2) {PetscValidPointer(g2, 6); *g2 = prob->g[(f*prob->Nf + g)*4+2];}
10672764a2aaSMatthew G. Knepley   if (g3) {PetscValidPointer(g3, 7); *g3 = prob->g[(f*prob->Nf + g)*4+3];}
10682764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
10692764a2aaSMatthew G. Knepley }
10702764a2aaSMatthew G. Knepley 
1071194d53e6SMatthew G. Knepley /*@C
1072194d53e6SMatthew G. Knepley   PetscDSSetJacobian - Set the pointwise Jacobian function for given test and basis fields
1073194d53e6SMatthew G. Knepley 
1074194d53e6SMatthew G. Knepley   Not collective
1075194d53e6SMatthew G. Knepley 
1076194d53e6SMatthew G. Knepley   Input Parameters:
1077194d53e6SMatthew G. Knepley + prob - The PetscDS
1078194d53e6SMatthew G. Knepley . f    - The test field number
1079194d53e6SMatthew G. Knepley . g    - The field number
1080194d53e6SMatthew G. Knepley . g0 - integrand for the test and basis function term
1081194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1082194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1083194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1084194d53e6SMatthew G. Knepley 
1085194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1086194d53e6SMatthew G. Knepley 
1087194d53e6SMatthew 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
1088194d53e6SMatthew G. Knepley 
1089194d53e6SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1090194d53e6SMatthew G. Knepley 
109130b9ff8bSMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1092194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1093194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
109430b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], PetscScalar g0[])
1095194d53e6SMatthew G. Knepley 
1096194d53e6SMatthew G. Knepley + dim - the spatial dimension
1097194d53e6SMatthew G. Knepley . Nf - the number of fields
1098194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1099194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1100194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
1101194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1102194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1103194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1104194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1105194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1106194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1107194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1108194d53e6SMatthew G. Knepley . t - current time
11092aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1110194d53e6SMatthew G. Knepley . x - coordinates of the current point
1111194d53e6SMatthew G. Knepley - g0 - output values at the current point
1112194d53e6SMatthew G. Knepley 
1113194d53e6SMatthew G. Knepley   Level: intermediate
1114194d53e6SMatthew G. Knepley 
1115194d53e6SMatthew G. Knepley .seealso: PetscDSGetJacobian()
1116194d53e6SMatthew G. Knepley @*/
11172764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetJacobian(PetscDS prob, PetscInt f, PetscInt g,
111830b9ff8bSMatthew G. Knepley                                   void (*g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1119194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1120194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
112130b9ff8bSMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g0[]),
112230b9ff8bSMatthew G. Knepley                                   void (*g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1123194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1124194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
112530b9ff8bSMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g1[]),
112630b9ff8bSMatthew G. Knepley                                   void (*g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1127194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1128194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
112930b9ff8bSMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g2[]),
113030b9ff8bSMatthew G. Knepley                                   void (*g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1131194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1132194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
113330b9ff8bSMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g3[]))
11342764a2aaSMatthew G. Knepley {
11352764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
11362764a2aaSMatthew G. Knepley 
11372764a2aaSMatthew G. Knepley   PetscFunctionBegin;
11382764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
11392764a2aaSMatthew G. Knepley   if (g0) PetscValidFunction(g0, 4);
11402764a2aaSMatthew G. Knepley   if (g1) PetscValidFunction(g1, 5);
11412764a2aaSMatthew G. Knepley   if (g2) PetscValidFunction(g2, 6);
11422764a2aaSMatthew G. Knepley   if (g3) PetscValidFunction(g3, 7);
11432764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
11442764a2aaSMatthew G. Knepley   if (g < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", g);
11452764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, PetscMax(f, g)+1);CHKERRQ(ierr);
11462764a2aaSMatthew G. Knepley   prob->g[(f*prob->Nf + g)*4+0] = g0;
11472764a2aaSMatthew G. Knepley   prob->g[(f*prob->Nf + g)*4+1] = g1;
11482764a2aaSMatthew G. Knepley   prob->g[(f*prob->Nf + g)*4+2] = g2;
11492764a2aaSMatthew G. Knepley   prob->g[(f*prob->Nf + g)*4+3] = g3;
11502764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
11512764a2aaSMatthew G. Knepley }
11522764a2aaSMatthew G. Knepley 
1153475e0ac9SMatthew G. Knepley /*@C
1154475e0ac9SMatthew G. Knepley   PetscDSHasJacobianPreconditioner - Signals that a Jacobian preconditioner matrix has been set
1155475e0ac9SMatthew G. Knepley 
1156475e0ac9SMatthew G. Knepley   Not collective
1157475e0ac9SMatthew G. Knepley 
1158475e0ac9SMatthew G. Knepley   Input Parameter:
1159475e0ac9SMatthew G. Knepley . prob - The PetscDS
1160475e0ac9SMatthew G. Knepley 
1161475e0ac9SMatthew G. Knepley   Output Parameter:
1162475e0ac9SMatthew G. Knepley . hasJacPre - flag that pointwise function for Jacobian preconditioner matrix has been set
1163475e0ac9SMatthew G. Knepley 
1164475e0ac9SMatthew G. Knepley   Level: intermediate
1165475e0ac9SMatthew G. Knepley 
1166475e0ac9SMatthew G. Knepley .seealso: PetscDSGetJacobianPreconditioner(), PetscDSSetJacobianPreconditioner(), PetscDSGetJacobian()
1167475e0ac9SMatthew G. Knepley @*/
1168475e0ac9SMatthew G. Knepley PetscErrorCode PetscDSHasJacobianPreconditioner(PetscDS prob, PetscBool *hasJacPre)
1169475e0ac9SMatthew G. Knepley {
1170475e0ac9SMatthew G. Knepley   PetscInt f, g, h;
1171475e0ac9SMatthew G. Knepley 
1172475e0ac9SMatthew G. Knepley   PetscFunctionBegin;
1173475e0ac9SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1174475e0ac9SMatthew G. Knepley   *hasJacPre = PETSC_FALSE;
1175475e0ac9SMatthew G. Knepley   for (f = 0; f < prob->Nf; ++f) {
1176475e0ac9SMatthew G. Knepley     for (g = 0; g < prob->Nf; ++g) {
1177475e0ac9SMatthew G. Knepley       for (h = 0; h < 4; ++h) {
1178475e0ac9SMatthew G. Knepley         if (prob->gp[(f*prob->Nf + g)*4+h]) *hasJacPre = PETSC_TRUE;
1179475e0ac9SMatthew G. Knepley       }
1180475e0ac9SMatthew G. Knepley     }
1181475e0ac9SMatthew G. Knepley   }
1182475e0ac9SMatthew G. Knepley   PetscFunctionReturn(0);
1183475e0ac9SMatthew G. Knepley }
1184475e0ac9SMatthew G. Knepley 
1185475e0ac9SMatthew G. Knepley /*@C
1186475e0ac9SMatthew 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.
1187475e0ac9SMatthew G. Knepley 
1188475e0ac9SMatthew G. Knepley   Not collective
1189475e0ac9SMatthew G. Knepley 
1190475e0ac9SMatthew G. Knepley   Input Parameters:
1191475e0ac9SMatthew G. Knepley + prob - The PetscDS
1192475e0ac9SMatthew G. Knepley . f    - The test field number
1193475e0ac9SMatthew G. Knepley - g    - The field number
1194475e0ac9SMatthew G. Knepley 
1195475e0ac9SMatthew G. Knepley   Output Parameters:
1196475e0ac9SMatthew G. Knepley + g0 - integrand for the test and basis function term
1197475e0ac9SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1198475e0ac9SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1199475e0ac9SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1200475e0ac9SMatthew G. Knepley 
1201475e0ac9SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1202475e0ac9SMatthew G. Knepley 
1203475e0ac9SMatthew 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
1204475e0ac9SMatthew G. Knepley 
1205475e0ac9SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1206475e0ac9SMatthew G. Knepley 
1207475e0ac9SMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1208475e0ac9SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1209475e0ac9SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1210475e0ac9SMatthew G. Knepley $    PetscReal t, const PetscReal u_tShift, const PetscReal x[], PetscScalar g0[])
1211475e0ac9SMatthew G. Knepley 
1212475e0ac9SMatthew G. Knepley + dim - the spatial dimension
1213475e0ac9SMatthew G. Knepley . Nf - the number of fields
1214475e0ac9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1215475e0ac9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1216475e0ac9SMatthew G. Knepley . u - each field evaluated at the current point
1217475e0ac9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1218475e0ac9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1219475e0ac9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1220475e0ac9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1221475e0ac9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1222475e0ac9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1223475e0ac9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1224475e0ac9SMatthew G. Knepley . t - current time
1225475e0ac9SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1226475e0ac9SMatthew G. Knepley . x - coordinates of the current point
1227475e0ac9SMatthew G. Knepley - g0 - output values at the current point
1228475e0ac9SMatthew G. Knepley 
1229475e0ac9SMatthew G. Knepley   Level: intermediate
1230475e0ac9SMatthew G. Knepley 
1231475e0ac9SMatthew G. Knepley .seealso: PetscDSSetJacobianPreconditioner(), PetscDSGetJacobian()
1232475e0ac9SMatthew G. Knepley @*/
1233475e0ac9SMatthew G. Knepley PetscErrorCode PetscDSGetJacobianPreconditioner(PetscDS prob, PetscInt f, PetscInt g,
1234475e0ac9SMatthew G. Knepley                                   void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1235475e0ac9SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1236475e0ac9SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1237475e0ac9SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g0[]),
1238475e0ac9SMatthew G. Knepley                                   void (**g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1239475e0ac9SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1240475e0ac9SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1241475e0ac9SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g1[]),
1242475e0ac9SMatthew G. Knepley                                   void (**g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1243475e0ac9SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1244475e0ac9SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1245475e0ac9SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g2[]),
1246475e0ac9SMatthew G. Knepley                                   void (**g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1247475e0ac9SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1248475e0ac9SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1249475e0ac9SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g3[]))
1250475e0ac9SMatthew G. Knepley {
1251475e0ac9SMatthew G. Knepley   PetscFunctionBegin;
1252475e0ac9SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1253475e0ac9SMatthew 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);
1254475e0ac9SMatthew 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);
1255475e0ac9SMatthew G. Knepley   if (g0) {PetscValidPointer(g0, 4); *g0 = prob->gp[(f*prob->Nf + g)*4+0];}
1256475e0ac9SMatthew G. Knepley   if (g1) {PetscValidPointer(g1, 5); *g1 = prob->gp[(f*prob->Nf + g)*4+1];}
1257475e0ac9SMatthew G. Knepley   if (g2) {PetscValidPointer(g2, 6); *g2 = prob->gp[(f*prob->Nf + g)*4+2];}
1258475e0ac9SMatthew G. Knepley   if (g3) {PetscValidPointer(g3, 7); *g3 = prob->gp[(f*prob->Nf + g)*4+3];}
1259475e0ac9SMatthew G. Knepley   PetscFunctionReturn(0);
1260475e0ac9SMatthew G. Knepley }
1261475e0ac9SMatthew G. Knepley 
1262475e0ac9SMatthew G. Knepley /*@C
1263475e0ac9SMatthew 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.
1264475e0ac9SMatthew G. Knepley 
1265475e0ac9SMatthew G. Knepley   Not collective
1266475e0ac9SMatthew G. Knepley 
1267475e0ac9SMatthew G. Knepley   Input Parameters:
1268475e0ac9SMatthew G. Knepley + prob - The PetscDS
1269475e0ac9SMatthew G. Knepley . f    - The test field number
1270475e0ac9SMatthew G. Knepley . g    - The field number
1271475e0ac9SMatthew G. Knepley . g0 - integrand for the test and basis function term
1272475e0ac9SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1273475e0ac9SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1274475e0ac9SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1275475e0ac9SMatthew G. Knepley 
1276475e0ac9SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1277475e0ac9SMatthew G. Knepley 
1278475e0ac9SMatthew 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
1279475e0ac9SMatthew G. Knepley 
1280475e0ac9SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1281475e0ac9SMatthew G. Knepley 
1282475e0ac9SMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1283475e0ac9SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1284475e0ac9SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1285475e0ac9SMatthew G. Knepley $    PetscReal t, const PetscReal x[], PetscScalar g0[])
1286475e0ac9SMatthew G. Knepley 
1287475e0ac9SMatthew G. Knepley + dim - the spatial dimension
1288475e0ac9SMatthew G. Knepley . Nf - the number of fields
1289475e0ac9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1290475e0ac9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1291475e0ac9SMatthew G. Knepley . u - each field evaluated at the current point
1292475e0ac9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1293475e0ac9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1294475e0ac9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1295475e0ac9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1296475e0ac9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1297475e0ac9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1298475e0ac9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1299475e0ac9SMatthew G. Knepley . t - current time
1300475e0ac9SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1301475e0ac9SMatthew G. Knepley . x - coordinates of the current point
1302475e0ac9SMatthew G. Knepley - g0 - output values at the current point
1303475e0ac9SMatthew G. Knepley 
1304475e0ac9SMatthew G. Knepley   Level: intermediate
1305475e0ac9SMatthew G. Knepley 
1306475e0ac9SMatthew G. Knepley .seealso: PetscDSGetJacobianPreconditioner(), PetscDSSetJacobian()
1307475e0ac9SMatthew G. Knepley @*/
1308475e0ac9SMatthew G. Knepley PetscErrorCode PetscDSSetJacobianPreconditioner(PetscDS prob, PetscInt f, PetscInt g,
1309475e0ac9SMatthew G. Knepley                                   void (*g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1310475e0ac9SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1311475e0ac9SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1312475e0ac9SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g0[]),
1313475e0ac9SMatthew G. Knepley                                   void (*g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1314475e0ac9SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1315475e0ac9SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1316475e0ac9SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g1[]),
1317475e0ac9SMatthew G. Knepley                                   void (*g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1318475e0ac9SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1319475e0ac9SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1320475e0ac9SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g2[]),
1321475e0ac9SMatthew G. Knepley                                   void (*g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1322475e0ac9SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1323475e0ac9SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1324475e0ac9SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g3[]))
1325475e0ac9SMatthew G. Knepley {
1326475e0ac9SMatthew G. Knepley   PetscErrorCode ierr;
1327475e0ac9SMatthew G. Knepley 
1328475e0ac9SMatthew G. Knepley   PetscFunctionBegin;
1329475e0ac9SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1330475e0ac9SMatthew G. Knepley   if (g0) PetscValidFunction(g0, 4);
1331475e0ac9SMatthew G. Knepley   if (g1) PetscValidFunction(g1, 5);
1332475e0ac9SMatthew G. Knepley   if (g2) PetscValidFunction(g2, 6);
1333475e0ac9SMatthew G. Knepley   if (g3) PetscValidFunction(g3, 7);
1334475e0ac9SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
1335475e0ac9SMatthew G. Knepley   if (g < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", g);
1336475e0ac9SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, PetscMax(f, g)+1);CHKERRQ(ierr);
1337475e0ac9SMatthew G. Knepley   prob->gp[(f*prob->Nf + g)*4+0] = g0;
1338475e0ac9SMatthew G. Knepley   prob->gp[(f*prob->Nf + g)*4+1] = g1;
1339475e0ac9SMatthew G. Knepley   prob->gp[(f*prob->Nf + g)*4+2] = g2;
1340475e0ac9SMatthew G. Knepley   prob->gp[(f*prob->Nf + g)*4+3] = g3;
1341475e0ac9SMatthew G. Knepley   PetscFunctionReturn(0);
1342475e0ac9SMatthew G. Knepley }
1343475e0ac9SMatthew G. Knepley 
1344b7e05686SMatthew G. Knepley /*@C
1345b7e05686SMatthew G. Knepley   PetscDSHasDynamicJacobian - Signals that a dynamic Jacobian, dF/du_t, has been set
1346b7e05686SMatthew G. Knepley 
1347b7e05686SMatthew G. Knepley   Not collective
1348b7e05686SMatthew G. Knepley 
1349b7e05686SMatthew G. Knepley   Input Parameter:
1350b7e05686SMatthew G. Knepley . prob - The PetscDS
1351b7e05686SMatthew G. Knepley 
1352b7e05686SMatthew G. Knepley   Output Parameter:
1353b7e05686SMatthew G. Knepley . hasDynJac - flag that pointwise function for dynamic Jacobian has been set
1354b7e05686SMatthew G. Knepley 
1355b7e05686SMatthew G. Knepley   Level: intermediate
1356b7e05686SMatthew G. Knepley 
1357b7e05686SMatthew G. Knepley .seealso: PetscDSGetDynamicJacobian(), PetscDSSetDynamicJacobian(), PetscDSGetJacobian()
1358b7e05686SMatthew G. Knepley @*/
1359b7e05686SMatthew G. Knepley PetscErrorCode PetscDSHasDynamicJacobian(PetscDS prob, PetscBool *hasDynJac)
1360b7e05686SMatthew G. Knepley {
1361b7e05686SMatthew G. Knepley   PetscInt f, g, h;
1362b7e05686SMatthew G. Knepley 
1363b7e05686SMatthew G. Knepley   PetscFunctionBegin;
1364b7e05686SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1365b7e05686SMatthew G. Knepley   *hasDynJac = PETSC_FALSE;
1366b7e05686SMatthew G. Knepley   for (f = 0; f < prob->Nf; ++f) {
1367b7e05686SMatthew G. Knepley     for (g = 0; g < prob->Nf; ++g) {
1368b7e05686SMatthew G. Knepley       for (h = 0; h < 4; ++h) {
1369b7e05686SMatthew G. Knepley         if (prob->gt[(f*prob->Nf + g)*4+h]) *hasDynJac = PETSC_TRUE;
1370b7e05686SMatthew G. Knepley       }
1371b7e05686SMatthew G. Knepley     }
1372b7e05686SMatthew G. Knepley   }
1373b7e05686SMatthew G. Knepley   PetscFunctionReturn(0);
1374b7e05686SMatthew G. Knepley }
1375b7e05686SMatthew G. Knepley 
1376b7e05686SMatthew G. Knepley /*@C
1377b7e05686SMatthew G. Knepley   PetscDSGetDynamicJacobian - Get the pointwise dynamic Jacobian, dF/du_t, function for given test and basis field
1378b7e05686SMatthew G. Knepley 
1379b7e05686SMatthew G. Knepley   Not collective
1380b7e05686SMatthew G. Knepley 
1381b7e05686SMatthew G. Knepley   Input Parameters:
1382b7e05686SMatthew G. Knepley + prob - The PetscDS
1383b7e05686SMatthew G. Knepley . f    - The test field number
1384b7e05686SMatthew G. Knepley - g    - The field number
1385b7e05686SMatthew G. Knepley 
1386b7e05686SMatthew G. Knepley   Output Parameters:
1387b7e05686SMatthew G. Knepley + g0 - integrand for the test and basis function term
1388b7e05686SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1389b7e05686SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1390b7e05686SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1391b7e05686SMatthew G. Knepley 
1392b7e05686SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1393b7e05686SMatthew G. Knepley 
1394b7e05686SMatthew 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
1395b7e05686SMatthew G. Knepley 
1396b7e05686SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1397b7e05686SMatthew G. Knepley 
1398b7e05686SMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1399b7e05686SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1400b7e05686SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1401b7e05686SMatthew G. Knepley $    PetscReal t, const PetscReal u_tShift, const PetscReal x[], PetscScalar g0[])
1402b7e05686SMatthew G. Knepley 
1403b7e05686SMatthew G. Knepley + dim - the spatial dimension
1404b7e05686SMatthew G. Knepley . Nf - the number of fields
1405b7e05686SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1406b7e05686SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1407b7e05686SMatthew G. Knepley . u - each field evaluated at the current point
1408b7e05686SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1409b7e05686SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1410b7e05686SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1411b7e05686SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1412b7e05686SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1413b7e05686SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1414b7e05686SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1415b7e05686SMatthew G. Knepley . t - current time
1416b7e05686SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1417b7e05686SMatthew G. Knepley . x - coordinates of the current point
1418b7e05686SMatthew G. Knepley - g0 - output values at the current point
1419b7e05686SMatthew G. Knepley 
1420b7e05686SMatthew G. Knepley   Level: intermediate
1421b7e05686SMatthew G. Knepley 
1422b7e05686SMatthew G. Knepley .seealso: PetscDSSetJacobian()
1423b7e05686SMatthew G. Knepley @*/
1424b7e05686SMatthew G. Knepley PetscErrorCode PetscDSGetDynamicJacobian(PetscDS prob, PetscInt f, PetscInt g,
1425b7e05686SMatthew G. Knepley                                          void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1426b7e05686SMatthew G. Knepley                                                      const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1427b7e05686SMatthew G. Knepley                                                      const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1428b7e05686SMatthew G. Knepley                                                      PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g0[]),
1429b7e05686SMatthew G. Knepley                                          void (**g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1430b7e05686SMatthew G. Knepley                                                      const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1431b7e05686SMatthew G. Knepley                                                      const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1432b7e05686SMatthew G. Knepley                                                      PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g1[]),
1433b7e05686SMatthew G. Knepley                                          void (**g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1434b7e05686SMatthew G. Knepley                                                      const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1435b7e05686SMatthew G. Knepley                                                      const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1436b7e05686SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g2[]),
1437b7e05686SMatthew G. Knepley                                          void (**g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1438b7e05686SMatthew G. Knepley                                                      const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1439b7e05686SMatthew G. Knepley                                                      const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1440b7e05686SMatthew G. Knepley                                                      PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g3[]))
1441b7e05686SMatthew G. Knepley {
1442b7e05686SMatthew G. Knepley   PetscFunctionBegin;
1443b7e05686SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1444b7e05686SMatthew 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);
1445b7e05686SMatthew 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);
1446b7e05686SMatthew G. Knepley   if (g0) {PetscValidPointer(g0, 4); *g0 = prob->gt[(f*prob->Nf + g)*4+0];}
1447b7e05686SMatthew G. Knepley   if (g1) {PetscValidPointer(g1, 5); *g1 = prob->gt[(f*prob->Nf + g)*4+1];}
1448b7e05686SMatthew G. Knepley   if (g2) {PetscValidPointer(g2, 6); *g2 = prob->gt[(f*prob->Nf + g)*4+2];}
1449b7e05686SMatthew G. Knepley   if (g3) {PetscValidPointer(g3, 7); *g3 = prob->gt[(f*prob->Nf + g)*4+3];}
1450b7e05686SMatthew G. Knepley   PetscFunctionReturn(0);
1451b7e05686SMatthew G. Knepley }
1452b7e05686SMatthew G. Knepley 
1453b7e05686SMatthew G. Knepley /*@C
1454b7e05686SMatthew G. Knepley   PetscDSSetDynamicJacobian - Set the pointwise dynamic Jacobian, dF/du_t, function for given test and basis fields
1455b7e05686SMatthew G. Knepley 
1456b7e05686SMatthew G. Knepley   Not collective
1457b7e05686SMatthew G. Knepley 
1458b7e05686SMatthew G. Knepley   Input Parameters:
1459b7e05686SMatthew G. Knepley + prob - The PetscDS
1460b7e05686SMatthew G. Knepley . f    - The test field number
1461b7e05686SMatthew G. Knepley . g    - The field number
1462b7e05686SMatthew G. Knepley . g0 - integrand for the test and basis function term
1463b7e05686SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1464b7e05686SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1465b7e05686SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1466b7e05686SMatthew G. Knepley 
1467b7e05686SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1468b7e05686SMatthew G. Knepley 
1469b7e05686SMatthew 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
1470b7e05686SMatthew G. Knepley 
1471b7e05686SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1472b7e05686SMatthew G. Knepley 
1473b7e05686SMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1474b7e05686SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1475b7e05686SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1476b7e05686SMatthew G. Knepley $    PetscReal t, const PetscReal x[], PetscScalar g0[])
1477b7e05686SMatthew G. Knepley 
1478b7e05686SMatthew G. Knepley + dim - the spatial dimension
1479b7e05686SMatthew G. Knepley . Nf - the number of fields
1480b7e05686SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1481b7e05686SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1482b7e05686SMatthew G. Knepley . u - each field evaluated at the current point
1483b7e05686SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1484b7e05686SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1485b7e05686SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1486b7e05686SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1487b7e05686SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1488b7e05686SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1489b7e05686SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1490b7e05686SMatthew G. Knepley . t - current time
1491b7e05686SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1492b7e05686SMatthew G. Knepley . x - coordinates of the current point
1493b7e05686SMatthew G. Knepley - g0 - output values at the current point
1494b7e05686SMatthew G. Knepley 
1495b7e05686SMatthew G. Knepley   Level: intermediate
1496b7e05686SMatthew G. Knepley 
1497b7e05686SMatthew G. Knepley .seealso: PetscDSGetJacobian()
1498b7e05686SMatthew G. Knepley @*/
1499b7e05686SMatthew G. Knepley PetscErrorCode PetscDSSetDynamicJacobian(PetscDS prob, PetscInt f, PetscInt g,
1500b7e05686SMatthew G. Knepley                                          void (*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, PetscReal u_tShift, const PetscReal x[], PetscScalar g0[]),
1504b7e05686SMatthew G. Knepley                                          void (*g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1505b7e05686SMatthew G. Knepley                                                     const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1506b7e05686SMatthew G. Knepley                                                     const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1507b7e05686SMatthew G. Knepley                                                     PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g1[]),
1508b7e05686SMatthew G. Knepley                                          void (*g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1509b7e05686SMatthew G. Knepley                                                     const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1510b7e05686SMatthew G. Knepley                                                     const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1511b7e05686SMatthew G. Knepley                                                     PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g2[]),
1512b7e05686SMatthew G. Knepley                                          void (*g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1513b7e05686SMatthew G. Knepley                                                     const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1514b7e05686SMatthew G. Knepley                                                     const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1515b7e05686SMatthew G. Knepley                                                     PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g3[]))
1516b7e05686SMatthew G. Knepley {
1517b7e05686SMatthew G. Knepley   PetscErrorCode ierr;
1518b7e05686SMatthew G. Knepley 
1519b7e05686SMatthew G. Knepley   PetscFunctionBegin;
1520b7e05686SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1521b7e05686SMatthew G. Knepley   if (g0) PetscValidFunction(g0, 4);
1522b7e05686SMatthew G. Knepley   if (g1) PetscValidFunction(g1, 5);
1523b7e05686SMatthew G. Knepley   if (g2) PetscValidFunction(g2, 6);
1524b7e05686SMatthew G. Knepley   if (g3) PetscValidFunction(g3, 7);
1525b7e05686SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
1526b7e05686SMatthew G. Knepley   if (g < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", g);
1527b7e05686SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, PetscMax(f, g)+1);CHKERRQ(ierr);
1528b7e05686SMatthew G. Knepley   prob->gt[(f*prob->Nf + g)*4+0] = g0;
1529b7e05686SMatthew G. Knepley   prob->gt[(f*prob->Nf + g)*4+1] = g1;
1530b7e05686SMatthew G. Knepley   prob->gt[(f*prob->Nf + g)*4+2] = g2;
1531b7e05686SMatthew G. Knepley   prob->gt[(f*prob->Nf + g)*4+3] = g3;
1532b7e05686SMatthew G. Knepley   PetscFunctionReturn(0);
1533b7e05686SMatthew G. Knepley }
1534b7e05686SMatthew G. Knepley 
15350c2f2876SMatthew G. Knepley /*@C
15360c2f2876SMatthew G. Knepley   PetscDSGetRiemannSolver - Returns the Riemann solver for the given field
15370c2f2876SMatthew G. Knepley 
15380c2f2876SMatthew G. Knepley   Not collective
15390c2f2876SMatthew G. Knepley 
15400c2f2876SMatthew G. Knepley   Input Arguments:
15410c2f2876SMatthew G. Knepley + prob - The PetscDS object
15420c2f2876SMatthew G. Knepley - f    - The field number
15430c2f2876SMatthew G. Knepley 
15440c2f2876SMatthew G. Knepley   Output Argument:
15450c2f2876SMatthew G. Knepley . r    - Riemann solver
15460c2f2876SMatthew G. Knepley 
15470c2f2876SMatthew G. Knepley   Calling sequence for r:
15480c2f2876SMatthew G. Knepley 
15495db36cf9SMatthew G. Knepley $ r(PetscInt dim, PetscInt Nf, const PetscReal x[], const PetscReal n[], const PetscScalar uL[], const PetscScalar uR[], PetscScalar flux[], void *ctx)
15500c2f2876SMatthew G. Knepley 
15515db36cf9SMatthew G. Knepley + dim  - The spatial dimension
15525db36cf9SMatthew G. Knepley . Nf   - The number of fields
15535db36cf9SMatthew G. Knepley . x    - The coordinates at a point on the interface
15540c2f2876SMatthew G. Knepley . n    - The normal vector to the interface
15550c2f2876SMatthew G. Knepley . uL   - The state vector to the left of the interface
15560c2f2876SMatthew G. Knepley . uR   - The state vector to the right of the interface
15570c2f2876SMatthew G. Knepley . flux - output array of flux through the interface
15580c2f2876SMatthew G. Knepley - ctx  - optional user context
15590c2f2876SMatthew G. Knepley 
15600c2f2876SMatthew G. Knepley   Level: intermediate
15610c2f2876SMatthew G. Knepley 
15620c2f2876SMatthew G. Knepley .seealso: PetscDSSetRiemannSolver()
15630c2f2876SMatthew G. Knepley @*/
15640c2f2876SMatthew G. Knepley PetscErrorCode PetscDSGetRiemannSolver(PetscDS prob, PetscInt f,
15655db36cf9SMatthew G. Knepley                                        void (**r)(PetscInt dim, PetscInt Nf, const PetscReal x[], const PetscReal n[], const PetscScalar uL[], const PetscScalar uR[], PetscScalar flux[], void *ctx))
15660c2f2876SMatthew G. Knepley {
15670c2f2876SMatthew G. Knepley   PetscFunctionBegin;
15680c2f2876SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
15690c2f2876SMatthew 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);
15700c2f2876SMatthew G. Knepley   PetscValidPointer(r, 3);
15710c2f2876SMatthew G. Knepley   *r = prob->r[f];
15720c2f2876SMatthew G. Knepley   PetscFunctionReturn(0);
15730c2f2876SMatthew G. Knepley }
15740c2f2876SMatthew G. Knepley 
15750c2f2876SMatthew G. Knepley /*@C
15760c2f2876SMatthew G. Knepley   PetscDSSetRiemannSolver - Sets the Riemann solver for the given field
15770c2f2876SMatthew G. Knepley 
15780c2f2876SMatthew G. Knepley   Not collective
15790c2f2876SMatthew G. Knepley 
15800c2f2876SMatthew G. Knepley   Input Arguments:
15810c2f2876SMatthew G. Knepley + prob - The PetscDS object
15820c2f2876SMatthew G. Knepley . f    - The field number
15830c2f2876SMatthew G. Knepley - r    - Riemann solver
15840c2f2876SMatthew G. Knepley 
15850c2f2876SMatthew G. Knepley   Calling sequence for r:
15860c2f2876SMatthew G. Knepley 
15875db36cf9SMatthew G. Knepley $ r(PetscInt dim, PetscInt Nf, const PetscReal x[], const PetscReal n[], const PetscScalar uL[], const PetscScalar uR[], PetscScalar flux[], void *ctx)
15880c2f2876SMatthew G. Knepley 
15895db36cf9SMatthew G. Knepley + dim  - The spatial dimension
15905db36cf9SMatthew G. Knepley . Nf   - The number of fields
15915db36cf9SMatthew G. Knepley . x    - The coordinates at a point on the interface
15920c2f2876SMatthew G. Knepley . n    - The normal vector to the interface
15930c2f2876SMatthew G. Knepley . uL   - The state vector to the left of the interface
15940c2f2876SMatthew G. Knepley . uR   - The state vector to the right of the interface
15950c2f2876SMatthew G. Knepley . flux - output array of flux through the interface
15960c2f2876SMatthew G. Knepley - ctx  - optional user context
15970c2f2876SMatthew G. Knepley 
15980c2f2876SMatthew G. Knepley   Level: intermediate
15990c2f2876SMatthew G. Knepley 
16000c2f2876SMatthew G. Knepley .seealso: PetscDSGetRiemannSolver()
16010c2f2876SMatthew G. Knepley @*/
16020c2f2876SMatthew G. Knepley PetscErrorCode PetscDSSetRiemannSolver(PetscDS prob, PetscInt f,
16035db36cf9SMatthew G. Knepley                                        void (*r)(PetscInt dim, PetscInt Nf, const PetscReal x[], const PetscReal n[], const PetscScalar uL[], const PetscScalar uR[], PetscScalar flux[], void *ctx))
16040c2f2876SMatthew G. Knepley {
16050c2f2876SMatthew G. Knepley   PetscErrorCode ierr;
16060c2f2876SMatthew G. Knepley 
16070c2f2876SMatthew G. Knepley   PetscFunctionBegin;
16080c2f2876SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1609de716cbcSToby Isaac   if (r) PetscValidFunction(r, 3);
16100c2f2876SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
16110c2f2876SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
16120c2f2876SMatthew G. Knepley   prob->r[f] = r;
16130c2f2876SMatthew G. Knepley   PetscFunctionReturn(0);
16140c2f2876SMatthew G. Knepley }
16150c2f2876SMatthew G. Knepley 
161632d2bbc9SMatthew G. Knepley /*@C
161732d2bbc9SMatthew G. Knepley   PetscDSGetUpdate - Get the pointwise update function for a given field
161832d2bbc9SMatthew G. Knepley 
161932d2bbc9SMatthew G. Knepley   Not collective
162032d2bbc9SMatthew G. Knepley 
162132d2bbc9SMatthew G. Knepley   Input Parameters:
162232d2bbc9SMatthew G. Knepley + prob - The PetscDS
162332d2bbc9SMatthew G. Knepley - f    - The field number
162432d2bbc9SMatthew G. Knepley 
162532d2bbc9SMatthew G. Knepley   Output Parameters:
162632d2bbc9SMatthew G. Knepley + update - update function
162732d2bbc9SMatthew G. Knepley 
162832d2bbc9SMatthew G. Knepley   Note: The calling sequence for the callback update is given by:
162932d2bbc9SMatthew G. Knepley 
163032d2bbc9SMatthew G. Knepley $ update(PetscInt dim, PetscInt Nf, PetscInt NfAux,
163132d2bbc9SMatthew G. Knepley $        const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
163232d2bbc9SMatthew G. Knepley $        const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
163332d2bbc9SMatthew G. Knepley $        PetscReal t, const PetscReal x[], PetscScalar uNew[])
163432d2bbc9SMatthew G. Knepley 
163532d2bbc9SMatthew G. Knepley + dim - the spatial dimension
163632d2bbc9SMatthew G. Knepley . Nf - the number of fields
163732d2bbc9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
163832d2bbc9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
163932d2bbc9SMatthew G. Knepley . u - each field evaluated at the current point
164032d2bbc9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
164132d2bbc9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
164232d2bbc9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
164332d2bbc9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
164432d2bbc9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
164532d2bbc9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
164632d2bbc9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
164732d2bbc9SMatthew G. Knepley . t - current time
164832d2bbc9SMatthew G. Knepley . x - coordinates of the current point
164932d2bbc9SMatthew G. Knepley - uNew - new value for field at the current point
165032d2bbc9SMatthew G. Knepley 
165132d2bbc9SMatthew G. Knepley   Level: intermediate
165232d2bbc9SMatthew G. Knepley 
165332d2bbc9SMatthew G. Knepley .seealso: PetscDSSetUpdate(), PetscDSSetResidual()
165432d2bbc9SMatthew G. Knepley @*/
165532d2bbc9SMatthew G. Knepley PetscErrorCode PetscDSGetUpdate(PetscDS prob, PetscInt f,
165632d2bbc9SMatthew G. Knepley                                   void (**update)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
165732d2bbc9SMatthew G. Knepley                                                   const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
165832d2bbc9SMatthew G. Knepley                                                   const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1659*3fa77dffSMatthew G. Knepley                                                   PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar uNew[]))
166032d2bbc9SMatthew G. Knepley {
166132d2bbc9SMatthew G. Knepley   PetscFunctionBegin;
166232d2bbc9SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
166332d2bbc9SMatthew 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);
166432d2bbc9SMatthew G. Knepley   if (update) {PetscValidPointer(update, 3); *update = prob->update[f];}
166532d2bbc9SMatthew G. Knepley   PetscFunctionReturn(0);
166632d2bbc9SMatthew G. Knepley }
166732d2bbc9SMatthew G. Knepley 
166832d2bbc9SMatthew G. Knepley /*@C
1669*3fa77dffSMatthew G. Knepley   PetscDSSetUpdate - Set the pointwise update function for a given field
167032d2bbc9SMatthew G. Knepley 
167132d2bbc9SMatthew G. Knepley   Not collective
167232d2bbc9SMatthew G. Knepley 
167332d2bbc9SMatthew G. Knepley   Input Parameters:
167432d2bbc9SMatthew G. Knepley + prob   - The PetscDS
167532d2bbc9SMatthew G. Knepley . f      - The field number
167632d2bbc9SMatthew G. Knepley - update - update function
167732d2bbc9SMatthew G. Knepley 
167832d2bbc9SMatthew G. Knepley   Note: The calling sequence for the callback update is given by:
167932d2bbc9SMatthew G. Knepley 
168032d2bbc9SMatthew G. Knepley $ update(PetscInt dim, PetscInt Nf, PetscInt NfAux,
168132d2bbc9SMatthew G. Knepley $        const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
168232d2bbc9SMatthew G. Knepley $        const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
168332d2bbc9SMatthew G. Knepley $        PetscReal t, const PetscReal x[], PetscScalar uNew[])
168432d2bbc9SMatthew G. Knepley 
168532d2bbc9SMatthew G. Knepley + dim - the spatial dimension
168632d2bbc9SMatthew G. Knepley . Nf - the number of fields
168732d2bbc9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
168832d2bbc9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
168932d2bbc9SMatthew G. Knepley . u - each field evaluated at the current point
169032d2bbc9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
169132d2bbc9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
169232d2bbc9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
169332d2bbc9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
169432d2bbc9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
169532d2bbc9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
169632d2bbc9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
169732d2bbc9SMatthew G. Knepley . t - current time
169832d2bbc9SMatthew G. Knepley . x - coordinates of the current point
169932d2bbc9SMatthew G. Knepley - uNew - new field values at the current point
170032d2bbc9SMatthew G. Knepley 
170132d2bbc9SMatthew G. Knepley   Level: intermediate
170232d2bbc9SMatthew G. Knepley 
170332d2bbc9SMatthew G. Knepley .seealso: PetscDSGetResidual()
170432d2bbc9SMatthew G. Knepley @*/
170532d2bbc9SMatthew G. Knepley PetscErrorCode PetscDSSetUpdate(PetscDS prob, PetscInt f,
170632d2bbc9SMatthew G. Knepley                                 void (*update)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
170732d2bbc9SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
170832d2bbc9SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1709*3fa77dffSMatthew G. Knepley                                                PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar uNew[]))
171032d2bbc9SMatthew G. Knepley {
171132d2bbc9SMatthew G. Knepley   PetscErrorCode ierr;
171232d2bbc9SMatthew G. Knepley 
171332d2bbc9SMatthew G. Knepley   PetscFunctionBegin;
171432d2bbc9SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
171532d2bbc9SMatthew G. Knepley   if (update) PetscValidFunction(update, 3);
171632d2bbc9SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
171732d2bbc9SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
171832d2bbc9SMatthew G. Knepley   prob->update[f] = update;
171932d2bbc9SMatthew G. Knepley   PetscFunctionReturn(0);
172032d2bbc9SMatthew G. Knepley }
172132d2bbc9SMatthew G. Knepley 
17220c2f2876SMatthew G. Knepley PetscErrorCode PetscDSGetContext(PetscDS prob, PetscInt f, void **ctx)
17230c2f2876SMatthew G. Knepley {
17240c2f2876SMatthew G. Knepley   PetscFunctionBegin;
17250c2f2876SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
17260c2f2876SMatthew 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);
17270c2f2876SMatthew G. Knepley   PetscValidPointer(ctx, 3);
17280c2f2876SMatthew G. Knepley   *ctx = prob->ctx[f];
17290c2f2876SMatthew G. Knepley   PetscFunctionReturn(0);
17300c2f2876SMatthew G. Knepley }
17310c2f2876SMatthew G. Knepley 
17320c2f2876SMatthew G. Knepley PetscErrorCode PetscDSSetContext(PetscDS prob, PetscInt f, void *ctx)
17330c2f2876SMatthew G. Knepley {
17340c2f2876SMatthew G. Knepley   PetscErrorCode ierr;
17350c2f2876SMatthew G. Knepley 
17360c2f2876SMatthew G. Knepley   PetscFunctionBegin;
17370c2f2876SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
17380c2f2876SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
17390c2f2876SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
17400c2f2876SMatthew G. Knepley   prob->ctx[f] = ctx;
17410c2f2876SMatthew G. Knepley   PetscFunctionReturn(0);
17420c2f2876SMatthew G. Knepley }
17430c2f2876SMatthew G. Knepley 
1744194d53e6SMatthew G. Knepley /*@C
1745194d53e6SMatthew G. Knepley   PetscDSGetBdResidual - Get the pointwise boundary residual function for a given test field
1746194d53e6SMatthew G. Knepley 
1747194d53e6SMatthew G. Knepley   Not collective
1748194d53e6SMatthew G. Knepley 
1749194d53e6SMatthew G. Knepley   Input Parameters:
1750194d53e6SMatthew G. Knepley + prob - The PetscDS
1751194d53e6SMatthew G. Knepley - f    - The test field number
1752194d53e6SMatthew G. Knepley 
1753194d53e6SMatthew G. Knepley   Output Parameters:
1754194d53e6SMatthew G. Knepley + f0 - boundary integrand for the test function term
1755194d53e6SMatthew G. Knepley - f1 - boundary integrand for the test function gradient term
1756194d53e6SMatthew G. Knepley 
1757194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1758194d53e6SMatthew G. Knepley 
1759194d53e6SMatthew 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
1760194d53e6SMatthew G. Knepley 
1761194d53e6SMatthew G. Knepley The calling sequence for the callbacks f0 and f1 is given by:
1762194d53e6SMatthew G. Knepley 
176330b9ff8bSMatthew G. Knepley $ f0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1764194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1765194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
176630b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar f0[])
1767194d53e6SMatthew G. Knepley 
1768194d53e6SMatthew G. Knepley + dim - the spatial dimension
1769194d53e6SMatthew G. Knepley . Nf - the number of fields
1770194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1771194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1772194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
1773194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1774194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1775194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1776194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1777194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1778194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1779194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1780194d53e6SMatthew G. Knepley . t - current time
1781194d53e6SMatthew G. Knepley . x - coordinates of the current point
1782194d53e6SMatthew G. Knepley . n - unit normal at the current point
1783194d53e6SMatthew G. Knepley - f0 - output values at the current point
1784194d53e6SMatthew G. Knepley 
1785194d53e6SMatthew G. Knepley   Level: intermediate
1786194d53e6SMatthew G. Knepley 
1787194d53e6SMatthew G. Knepley .seealso: PetscDSSetBdResidual()
1788194d53e6SMatthew G. Knepley @*/
17892764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetBdResidual(PetscDS prob, PetscInt f,
179030b9ff8bSMatthew G. Knepley                                     void (**f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1791194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1792194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
179330b9ff8bSMatthew G. Knepley                                                 PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar f0[]),
179430b9ff8bSMatthew G. Knepley                                     void (**f1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1795194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1796194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
179730b9ff8bSMatthew G. Knepley                                                 PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar f1[]))
17982764a2aaSMatthew G. Knepley {
17992764a2aaSMatthew G. Knepley   PetscFunctionBegin;
18002764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
18012764a2aaSMatthew 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);
18022764a2aaSMatthew G. Knepley   if (f0) {PetscValidPointer(f0, 3); *f0 = prob->fBd[f*2+0];}
18032764a2aaSMatthew G. Knepley   if (f1) {PetscValidPointer(f1, 4); *f1 = prob->fBd[f*2+1];}
18042764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
18052764a2aaSMatthew G. Knepley }
18062764a2aaSMatthew G. Knepley 
1807194d53e6SMatthew G. Knepley /*@C
1808194d53e6SMatthew G. Knepley   PetscDSSetBdResidual - Get the pointwise boundary residual function for a given test field
1809194d53e6SMatthew G. Knepley 
1810194d53e6SMatthew G. Knepley   Not collective
1811194d53e6SMatthew G. Knepley 
1812194d53e6SMatthew G. Knepley   Input Parameters:
1813194d53e6SMatthew G. Knepley + prob - The PetscDS
1814194d53e6SMatthew G. Knepley . f    - The test field number
1815194d53e6SMatthew G. Knepley . f0 - boundary integrand for the test function term
1816194d53e6SMatthew G. Knepley - f1 - boundary integrand for the test function gradient term
1817194d53e6SMatthew G. Knepley 
1818194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1819194d53e6SMatthew G. Knepley 
1820194d53e6SMatthew 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
1821194d53e6SMatthew G. Knepley 
1822194d53e6SMatthew G. Knepley The calling sequence for the callbacks f0 and f1 is given by:
1823194d53e6SMatthew G. Knepley 
182430b9ff8bSMatthew G. Knepley $ f0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1825194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1826194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
182730b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar f0[])
1828194d53e6SMatthew G. Knepley 
1829194d53e6SMatthew G. Knepley + dim - the spatial dimension
1830194d53e6SMatthew G. Knepley . Nf - the number of fields
1831194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1832194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1833194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
1834194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1835194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1836194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1837194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1838194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1839194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1840194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1841194d53e6SMatthew G. Knepley . t - current time
1842194d53e6SMatthew G. Knepley . x - coordinates of the current point
1843194d53e6SMatthew G. Knepley . n - unit normal at the current point
1844194d53e6SMatthew G. Knepley - f0 - output values at the current point
1845194d53e6SMatthew G. Knepley 
1846194d53e6SMatthew G. Knepley   Level: intermediate
1847194d53e6SMatthew G. Knepley 
1848194d53e6SMatthew G. Knepley .seealso: PetscDSGetBdResidual()
1849194d53e6SMatthew G. Knepley @*/
18502764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetBdResidual(PetscDS prob, PetscInt f,
185130b9ff8bSMatthew G. Knepley                                     void (*f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1852194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1853194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
185430b9ff8bSMatthew G. Knepley                                                PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar f0[]),
185530b9ff8bSMatthew G. Knepley                                     void (*f1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1856194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1857194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
185830b9ff8bSMatthew G. Knepley                                                PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar f1[]))
18592764a2aaSMatthew G. Knepley {
18602764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
18612764a2aaSMatthew G. Knepley 
18622764a2aaSMatthew G. Knepley   PetscFunctionBegin;
18632764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
18642764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
18652764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
18662764a2aaSMatthew G. Knepley   if (f0) {PetscValidFunction(f0, 3); prob->fBd[f*2+0] = f0;}
18672764a2aaSMatthew G. Knepley   if (f1) {PetscValidFunction(f1, 4); prob->fBd[f*2+1] = f1;}
18682764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
18692764a2aaSMatthew G. Knepley }
18702764a2aaSMatthew G. Knepley 
1871194d53e6SMatthew G. Knepley /*@C
1872194d53e6SMatthew G. Knepley   PetscDSGetBdJacobian - Get the pointwise boundary Jacobian function for given test and basis field
1873194d53e6SMatthew G. Knepley 
1874194d53e6SMatthew G. Knepley   Not collective
1875194d53e6SMatthew G. Knepley 
1876194d53e6SMatthew G. Knepley   Input Parameters:
1877194d53e6SMatthew G. Knepley + prob - The PetscDS
1878194d53e6SMatthew G. Knepley . f    - The test field number
1879194d53e6SMatthew G. Knepley - g    - The field number
1880194d53e6SMatthew G. Knepley 
1881194d53e6SMatthew G. Knepley   Output Parameters:
1882194d53e6SMatthew G. Knepley + g0 - integrand for the test and basis function term
1883194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1884194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1885194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1886194d53e6SMatthew G. Knepley 
1887194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1888194d53e6SMatthew G. Knepley 
1889194d53e6SMatthew 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
1890194d53e6SMatthew G. Knepley 
1891194d53e6SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1892194d53e6SMatthew G. Knepley 
189330b9ff8bSMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1894194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1895194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
189630b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar g0[])
1897194d53e6SMatthew G. Knepley 
1898194d53e6SMatthew G. Knepley + dim - the spatial dimension
1899194d53e6SMatthew G. Knepley . Nf - the number of fields
1900194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1901194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1902194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
1903194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1904194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1905194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1906194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1907194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1908194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1909194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1910194d53e6SMatthew G. Knepley . t - current time
19112aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1912194d53e6SMatthew G. Knepley . x - coordinates of the current point
1913194d53e6SMatthew G. Knepley . n - normal at the current point
1914194d53e6SMatthew G. Knepley - g0 - output values at the current point
1915194d53e6SMatthew G. Knepley 
1916194d53e6SMatthew G. Knepley   Level: intermediate
1917194d53e6SMatthew G. Knepley 
1918194d53e6SMatthew G. Knepley .seealso: PetscDSSetBdJacobian()
1919194d53e6SMatthew G. Knepley @*/
19202764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetBdJacobian(PetscDS prob, PetscInt f, PetscInt g,
192130b9ff8bSMatthew G. Knepley                                     void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1922194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1923194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
19242aa1fc23SMatthew G. Knepley                                                 PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscScalar g0[]),
192530b9ff8bSMatthew G. Knepley                                     void (**g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1926194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1927194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
19282aa1fc23SMatthew G. Knepley                                                 PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscScalar g1[]),
192930b9ff8bSMatthew G. Knepley                                     void (**g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1930194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1931194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
19322aa1fc23SMatthew G. Knepley                                                 PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscScalar g2[]),
193330b9ff8bSMatthew G. Knepley                                     void (**g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1934194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1935194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
19362aa1fc23SMatthew G. Knepley                                                 PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscScalar g3[]))
19372764a2aaSMatthew G. Knepley {
19382764a2aaSMatthew G. Knepley   PetscFunctionBegin;
19392764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
19402764a2aaSMatthew 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);
19412764a2aaSMatthew 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);
19422764a2aaSMatthew G. Knepley   if (g0) {PetscValidPointer(g0, 4); *g0 = prob->gBd[(f*prob->Nf + g)*4+0];}
19432764a2aaSMatthew G. Knepley   if (g1) {PetscValidPointer(g1, 5); *g1 = prob->gBd[(f*prob->Nf + g)*4+1];}
19442764a2aaSMatthew G. Knepley   if (g2) {PetscValidPointer(g2, 6); *g2 = prob->gBd[(f*prob->Nf + g)*4+2];}
19452764a2aaSMatthew G. Knepley   if (g3) {PetscValidPointer(g3, 7); *g3 = prob->gBd[(f*prob->Nf + g)*4+3];}
19462764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
19472764a2aaSMatthew G. Knepley }
19482764a2aaSMatthew G. Knepley 
1949194d53e6SMatthew G. Knepley /*@C
1950194d53e6SMatthew G. Knepley   PetscDSSetBdJacobian - Set the pointwise boundary Jacobian function for given test and basis field
1951194d53e6SMatthew G. Knepley 
1952194d53e6SMatthew G. Knepley   Not collective
1953194d53e6SMatthew G. Knepley 
1954194d53e6SMatthew G. Knepley   Input Parameters:
1955194d53e6SMatthew G. Knepley + prob - The PetscDS
1956194d53e6SMatthew G. Knepley . f    - The test field number
1957194d53e6SMatthew G. Knepley . g    - The field number
1958194d53e6SMatthew G. Knepley . g0 - integrand for the test and basis function term
1959194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1960194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1961194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1962194d53e6SMatthew G. Knepley 
1963194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1964194d53e6SMatthew G. Knepley 
1965194d53e6SMatthew 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
1966194d53e6SMatthew G. Knepley 
1967194d53e6SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1968194d53e6SMatthew G. Knepley 
196930b9ff8bSMatthew G. Knepley $ g0(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[],
197230b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar g0[])
1973194d53e6SMatthew G. Knepley 
1974194d53e6SMatthew G. Knepley + dim - the spatial dimension
1975194d53e6SMatthew G. Knepley . Nf - the number of fields
1976194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1977194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1978194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
1979194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1980194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1981194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1982194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1983194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1984194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1985194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1986194d53e6SMatthew G. Knepley . t - current time
19872aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1988194d53e6SMatthew G. Knepley . x - coordinates of the current point
1989194d53e6SMatthew G. Knepley . n - normal at the current point
1990194d53e6SMatthew G. Knepley - g0 - output values at the current point
1991194d53e6SMatthew G. Knepley 
1992194d53e6SMatthew G. Knepley   Level: intermediate
1993194d53e6SMatthew G. Knepley 
1994194d53e6SMatthew G. Knepley .seealso: PetscDSGetBdJacobian()
1995194d53e6SMatthew G. Knepley @*/
19962764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetBdJacobian(PetscDS prob, PetscInt f, PetscInt g,
199730b9ff8bSMatthew G. Knepley                                     void (*g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1998194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1999194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
20002aa1fc23SMatthew G. Knepley                                                PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscScalar g0[]),
200130b9ff8bSMatthew G. Knepley                                     void (*g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2002194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2003194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
20042aa1fc23SMatthew G. Knepley                                                PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscScalar g1[]),
200530b9ff8bSMatthew G. Knepley                                     void (*g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2006194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2007194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
20082aa1fc23SMatthew G. Knepley                                                PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscScalar g2[]),
200930b9ff8bSMatthew G. Knepley                                     void (*g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2010194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2011194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
20122aa1fc23SMatthew G. Knepley                                                PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscScalar g3[]))
20132764a2aaSMatthew G. Knepley {
20142764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
20152764a2aaSMatthew G. Knepley 
20162764a2aaSMatthew G. Knepley   PetscFunctionBegin;
20172764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
20182764a2aaSMatthew G. Knepley   if (g0) PetscValidFunction(g0, 4);
20192764a2aaSMatthew G. Knepley   if (g1) PetscValidFunction(g1, 5);
20202764a2aaSMatthew G. Knepley   if (g2) PetscValidFunction(g2, 6);
20212764a2aaSMatthew G. Knepley   if (g3) PetscValidFunction(g3, 7);
20222764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
20232764a2aaSMatthew G. Knepley   if (g < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", g);
20242764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, PetscMax(f, g)+1);CHKERRQ(ierr);
20252764a2aaSMatthew G. Knepley   prob->gBd[(f*prob->Nf + g)*4+0] = g0;
20262764a2aaSMatthew G. Knepley   prob->gBd[(f*prob->Nf + g)*4+1] = g1;
20272764a2aaSMatthew G. Knepley   prob->gBd[(f*prob->Nf + g)*4+2] = g2;
20282764a2aaSMatthew G. Knepley   prob->gBd[(f*prob->Nf + g)*4+3] = g3;
20292764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
20302764a2aaSMatthew G. Knepley }
20312764a2aaSMatthew G. Knepley 
20324cd1e086SMatthew G. Knepley /*@
20334cd1e086SMatthew G. Knepley   PetscDSGetFieldIndex - Returns the index of the given field
20344cd1e086SMatthew G. Knepley 
20354cd1e086SMatthew G. Knepley   Not collective
20364cd1e086SMatthew G. Knepley 
20374cd1e086SMatthew G. Knepley   Input Parameters:
20384cd1e086SMatthew G. Knepley + prob - The PetscDS object
20394cd1e086SMatthew G. Knepley - disc - The discretization object
20404cd1e086SMatthew G. Knepley 
20414cd1e086SMatthew G. Knepley   Output Parameter:
20424cd1e086SMatthew G. Knepley . f - The field number
20434cd1e086SMatthew G. Knepley 
20444cd1e086SMatthew G. Knepley   Level: beginner
20454cd1e086SMatthew G. Knepley 
2046f744cafaSSander Arens .seealso: PetscGetDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
20474cd1e086SMatthew G. Knepley @*/
20484cd1e086SMatthew G. Knepley PetscErrorCode PetscDSGetFieldIndex(PetscDS prob, PetscObject disc, PetscInt *f)
20494cd1e086SMatthew G. Knepley {
20504cd1e086SMatthew G. Knepley   PetscInt g;
20514cd1e086SMatthew G. Knepley 
20524cd1e086SMatthew G. Knepley   PetscFunctionBegin;
20534cd1e086SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
20544cd1e086SMatthew G. Knepley   PetscValidPointer(f, 3);
20554cd1e086SMatthew G. Knepley   *f = -1;
20564cd1e086SMatthew G. Knepley   for (g = 0; g < prob->Nf; ++g) {if (disc == prob->disc[g]) break;}
20574cd1e086SMatthew G. Knepley   if (g == prob->Nf) SETERRQ(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Field not found in PetscDS.");
20584cd1e086SMatthew G. Knepley   *f = g;
20594cd1e086SMatthew G. Knepley   PetscFunctionReturn(0);
20604cd1e086SMatthew G. Knepley }
20614cd1e086SMatthew G. Knepley 
20624cd1e086SMatthew G. Knepley /*@
20634cd1e086SMatthew G. Knepley   PetscDSGetFieldSize - Returns the size of the given field in the full space basis
20644cd1e086SMatthew G. Knepley 
20654cd1e086SMatthew G. Knepley   Not collective
20664cd1e086SMatthew G. Knepley 
20674cd1e086SMatthew G. Knepley   Input Parameters:
20684cd1e086SMatthew G. Knepley + prob - The PetscDS object
20694cd1e086SMatthew G. Knepley - f - The field number
20704cd1e086SMatthew G. Knepley 
20714cd1e086SMatthew G. Knepley   Output Parameter:
20724cd1e086SMatthew G. Knepley . size - The size
20734cd1e086SMatthew G. Knepley 
20744cd1e086SMatthew G. Knepley   Level: beginner
20754cd1e086SMatthew G. Knepley 
2076f744cafaSSander Arens .seealso: PetscDSGetFieldOffset(), PetscDSGetNumFields(), PetscDSCreate()
20774cd1e086SMatthew G. Knepley @*/
20784cd1e086SMatthew G. Knepley PetscErrorCode PetscDSGetFieldSize(PetscDS prob, PetscInt f, PetscInt *size)
20794cd1e086SMatthew G. Knepley {
20802166fd64SMatthew G. Knepley   PetscErrorCode ierr;
20812166fd64SMatthew G. Knepley 
20824cd1e086SMatthew G. Knepley   PetscFunctionBegin;
20834cd1e086SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
20844cd1e086SMatthew G. Knepley   PetscValidPointer(size, 3);
20854cd1e086SMatthew 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);
20862166fd64SMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
2087d4742ddaSMatthew G. Knepley   *size = prob->Nb[f];
20884cd1e086SMatthew G. Knepley   PetscFunctionReturn(0);
20894cd1e086SMatthew G. Knepley }
20904cd1e086SMatthew G. Knepley 
2091bc4ae4beSMatthew G. Knepley /*@
2092bc4ae4beSMatthew G. Knepley   PetscDSGetFieldOffset - Returns the offset of the given field in the full space basis
2093bc4ae4beSMatthew G. Knepley 
2094bc4ae4beSMatthew G. Knepley   Not collective
2095bc4ae4beSMatthew G. Knepley 
2096bc4ae4beSMatthew G. Knepley   Input Parameters:
2097bc4ae4beSMatthew G. Knepley + prob - The PetscDS object
2098bc4ae4beSMatthew G. Knepley - f - The field number
2099bc4ae4beSMatthew G. Knepley 
2100bc4ae4beSMatthew G. Knepley   Output Parameter:
2101bc4ae4beSMatthew G. Knepley . off - The offset
2102bc4ae4beSMatthew G. Knepley 
2103bc4ae4beSMatthew G. Knepley   Level: beginner
2104bc4ae4beSMatthew G. Knepley 
2105f744cafaSSander Arens .seealso: PetscDSGetFieldSize(), PetscDSGetNumFields(), PetscDSCreate()
2106bc4ae4beSMatthew G. Knepley @*/
21072764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetFieldOffset(PetscDS prob, PetscInt f, PetscInt *off)
21082764a2aaSMatthew G. Knepley {
21094cd1e086SMatthew G. Knepley   PetscInt       size, g;
21102764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
21112764a2aaSMatthew G. Knepley 
21122764a2aaSMatthew G. Knepley   PetscFunctionBegin;
21132764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
21142764a2aaSMatthew G. Knepley   PetscValidPointer(off, 3);
21152764a2aaSMatthew 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);
21162764a2aaSMatthew G. Knepley   *off = 0;
21172764a2aaSMatthew G. Knepley   for (g = 0; g < f; ++g) {
21184cd1e086SMatthew G. Knepley     ierr = PetscDSGetFieldSize(prob, g, &size);CHKERRQ(ierr);
21194cd1e086SMatthew G. Knepley     *off += size;
21202764a2aaSMatthew G. Knepley   }
21212764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
21222764a2aaSMatthew G. Knepley }
21232764a2aaSMatthew G. Knepley 
2124bc4ae4beSMatthew G. Knepley /*@
212547e57110SSander Arens   PetscDSGetDimensions - Returns the size of the approximation space for each field on an evaluation point
2126bc4ae4beSMatthew G. Knepley 
2127bc4ae4beSMatthew G. Knepley   Not collective
2128bc4ae4beSMatthew G. Knepley 
212947e57110SSander Arens   Input Parameter:
213047e57110SSander Arens . prob - The PetscDS object
2131bc4ae4beSMatthew G. Knepley 
2132bc4ae4beSMatthew G. Knepley   Output Parameter:
213347e57110SSander Arens . dimensions - The number of dimensions
2134bc4ae4beSMatthew G. Knepley 
2135bc4ae4beSMatthew G. Knepley   Level: beginner
2136bc4ae4beSMatthew G. Knepley 
213747e57110SSander Arens .seealso: PetscDSGetComponentOffsets(), PetscDSGetNumFields(), PetscDSCreate()
2138bc4ae4beSMatthew G. Knepley @*/
213947e57110SSander Arens PetscErrorCode PetscDSGetDimensions(PetscDS prob, PetscInt *dimensions[])
21402764a2aaSMatthew G. Knepley {
21412764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
21422764a2aaSMatthew G. Knepley 
21432764a2aaSMatthew G. Knepley   PetscFunctionBegin;
21442764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
214547e57110SSander Arens   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
214647e57110SSander Arens   PetscValidPointer(dimensions, 2);
214747e57110SSander Arens   *dimensions = prob->Nb;
214847e57110SSander Arens   PetscFunctionReturn(0);
21496ce16762SMatthew G. Knepley }
215047e57110SSander Arens 
215147e57110SSander Arens /*@
215247e57110SSander Arens   PetscDSGetComponents - Returns the number of components for each field on an evaluation point
215347e57110SSander Arens 
215447e57110SSander Arens   Not collective
215547e57110SSander Arens 
215647e57110SSander Arens   Input Parameter:
215747e57110SSander Arens . prob - The PetscDS object
215847e57110SSander Arens 
215947e57110SSander Arens   Output Parameter:
216047e57110SSander Arens . components - The number of components
216147e57110SSander Arens 
216247e57110SSander Arens   Level: beginner
216347e57110SSander Arens 
216447e57110SSander Arens .seealso: PetscDSGetComponentOffsets(), PetscDSGetNumFields(), PetscDSCreate()
216547e57110SSander Arens @*/
216647e57110SSander Arens PetscErrorCode PetscDSGetComponents(PetscDS prob, PetscInt *components[])
216747e57110SSander Arens {
216847e57110SSander Arens   PetscErrorCode ierr;
216947e57110SSander Arens 
217047e57110SSander Arens   PetscFunctionBegin;
217147e57110SSander Arens   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
217247e57110SSander Arens   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
217347e57110SSander Arens   PetscValidPointer(components, 2);
217447e57110SSander Arens   *components = prob->Nc;
21756ce16762SMatthew G. Knepley   PetscFunctionReturn(0);
21766ce16762SMatthew G. Knepley }
21776ce16762SMatthew G. Knepley 
21786ce16762SMatthew G. Knepley /*@
21796ce16762SMatthew G. Knepley   PetscDSGetComponentOffset - Returns the offset of the given field on an evaluation point
21806ce16762SMatthew G. Knepley 
21816ce16762SMatthew G. Knepley   Not collective
21826ce16762SMatthew G. Knepley 
21836ce16762SMatthew G. Knepley   Input Parameters:
21846ce16762SMatthew G. Knepley + prob - The PetscDS object
21856ce16762SMatthew G. Knepley - f - The field number
21866ce16762SMatthew G. Knepley 
21876ce16762SMatthew G. Knepley   Output Parameter:
21886ce16762SMatthew G. Knepley . off - The offset
21896ce16762SMatthew G. Knepley 
21906ce16762SMatthew G. Knepley   Level: beginner
21916ce16762SMatthew G. Knepley 
2192f744cafaSSander Arens .seealso: PetscDSGetNumFields(), PetscDSCreate()
21936ce16762SMatthew G. Knepley @*/
21946ce16762SMatthew G. Knepley PetscErrorCode PetscDSGetComponentOffset(PetscDS prob, PetscInt f, PetscInt *off)
21956ce16762SMatthew G. Knepley {
21966ce16762SMatthew G. Knepley   PetscFunctionBegin;
21976ce16762SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
21986ce16762SMatthew G. Knepley   PetscValidPointer(off, 3);
21996ce16762SMatthew 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);
220047e57110SSander Arens   *off = prob->off[f];
22012764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
22022764a2aaSMatthew G. Knepley }
22032764a2aaSMatthew G. Knepley 
2204194d53e6SMatthew G. Knepley /*@
2205194d53e6SMatthew G. Knepley   PetscDSGetComponentOffsets - Returns the offset of each field on an evaluation point
2206194d53e6SMatthew G. Knepley 
2207194d53e6SMatthew G. Knepley   Not collective
2208194d53e6SMatthew G. Knepley 
2209194d53e6SMatthew G. Knepley   Input Parameter:
2210194d53e6SMatthew G. Knepley . prob - The PetscDS object
2211194d53e6SMatthew G. Knepley 
2212194d53e6SMatthew G. Knepley   Output Parameter:
2213194d53e6SMatthew G. Knepley . offsets - The offsets
2214194d53e6SMatthew G. Knepley 
2215194d53e6SMatthew G. Knepley   Level: beginner
2216194d53e6SMatthew G. Knepley 
2217f744cafaSSander Arens .seealso: PetscDSGetNumFields(), PetscDSCreate()
2218194d53e6SMatthew G. Knepley @*/
2219194d53e6SMatthew G. Knepley PetscErrorCode PetscDSGetComponentOffsets(PetscDS prob, PetscInt *offsets[])
2220194d53e6SMatthew G. Knepley {
2221194d53e6SMatthew G. Knepley   PetscFunctionBegin;
2222194d53e6SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2223194d53e6SMatthew G. Knepley   PetscValidPointer(offsets, 2);
2224194d53e6SMatthew G. Knepley   *offsets = prob->off;
2225194d53e6SMatthew G. Knepley   PetscFunctionReturn(0);
2226194d53e6SMatthew G. Knepley }
2227194d53e6SMatthew G. Knepley 
2228194d53e6SMatthew G. Knepley /*@
2229194d53e6SMatthew G. Knepley   PetscDSGetComponentDerivativeOffsets - Returns the offset of each field derivative on an evaluation point
2230194d53e6SMatthew G. Knepley 
2231194d53e6SMatthew G. Knepley   Not collective
2232194d53e6SMatthew G. Knepley 
2233194d53e6SMatthew G. Knepley   Input Parameter:
2234194d53e6SMatthew G. Knepley . prob - The PetscDS object
2235194d53e6SMatthew G. Knepley 
2236194d53e6SMatthew G. Knepley   Output Parameter:
2237194d53e6SMatthew G. Knepley . offsets - The offsets
2238194d53e6SMatthew G. Knepley 
2239194d53e6SMatthew G. Knepley   Level: beginner
2240194d53e6SMatthew G. Knepley 
2241f744cafaSSander Arens .seealso: PetscDSGetNumFields(), PetscDSCreate()
2242194d53e6SMatthew G. Knepley @*/
2243194d53e6SMatthew G. Knepley PetscErrorCode PetscDSGetComponentDerivativeOffsets(PetscDS prob, PetscInt *offsets[])
2244194d53e6SMatthew G. Knepley {
2245194d53e6SMatthew G. Knepley   PetscFunctionBegin;
2246194d53e6SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2247194d53e6SMatthew G. Knepley   PetscValidPointer(offsets, 2);
2248194d53e6SMatthew G. Knepley   *offsets = prob->offDer;
2249194d53e6SMatthew G. Knepley   PetscFunctionReturn(0);
2250194d53e6SMatthew G. Knepley }
2251194d53e6SMatthew G. Knepley 
225268c9edb9SMatthew G. Knepley /*@C
225368c9edb9SMatthew G. Knepley   PetscDSGetTabulation - Return the basis tabulation at quadrature points for the volume discretization
225468c9edb9SMatthew G. Knepley 
225568c9edb9SMatthew G. Knepley   Not collective
225668c9edb9SMatthew G. Knepley 
225768c9edb9SMatthew G. Knepley   Input Parameter:
225868c9edb9SMatthew G. Knepley . prob - The PetscDS object
225968c9edb9SMatthew G. Knepley 
226068c9edb9SMatthew G. Knepley   Output Parameters:
226168c9edb9SMatthew G. Knepley + basis - The basis function tabulation at quadrature points
226268c9edb9SMatthew G. Knepley - basisDer - The basis function derivative tabulation at quadrature points
226368c9edb9SMatthew G. Knepley 
226468c9edb9SMatthew G. Knepley   Level: intermediate
226568c9edb9SMatthew G. Knepley 
2266f744cafaSSander Arens .seealso: PetscDSCreate()
226768c9edb9SMatthew G. Knepley @*/
22682764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetTabulation(PetscDS prob, PetscReal ***basis, PetscReal ***basisDer)
22692764a2aaSMatthew G. Knepley {
22702764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
22712764a2aaSMatthew G. Knepley 
22722764a2aaSMatthew G. Knepley   PetscFunctionBegin;
22732764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
22742764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
22752764a2aaSMatthew G. Knepley   if (basis)    {PetscValidPointer(basis, 2);    *basis    = prob->basis;}
22762764a2aaSMatthew G. Knepley   if (basisDer) {PetscValidPointer(basisDer, 3); *basisDer = prob->basisDer;}
22772764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
22782764a2aaSMatthew G. Knepley }
22792764a2aaSMatthew G. Knepley 
228068c9edb9SMatthew G. Knepley /*@C
22814d0b9603SSander Arens   PetscDSGetFaceTabulation - Return the basis tabulation at quadrature points on the faces
228268c9edb9SMatthew G. Knepley 
228368c9edb9SMatthew G. Knepley   Not collective
228468c9edb9SMatthew G. Knepley 
228568c9edb9SMatthew G. Knepley   Input Parameter:
228668c9edb9SMatthew G. Knepley . prob - The PetscDS object
228768c9edb9SMatthew G. Knepley 
228868c9edb9SMatthew G. Knepley   Output Parameters:
22894d0b9603SSander Arens + basisFace - The basis function tabulation at quadrature points
22904d0b9603SSander Arens - basisDerFace - The basis function derivative tabulation at quadrature points
229168c9edb9SMatthew G. Knepley 
229268c9edb9SMatthew G. Knepley   Level: intermediate
229368c9edb9SMatthew G. Knepley 
229468c9edb9SMatthew G. Knepley .seealso: PetscDSGetTabulation(), PetscDSCreate()
229568c9edb9SMatthew G. Knepley @*/
22964d0b9603SSander Arens PetscErrorCode PetscDSGetFaceTabulation(PetscDS prob, PetscReal ***basis, PetscReal ***basisDer)
22972764a2aaSMatthew G. Knepley {
22982764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
22992764a2aaSMatthew G. Knepley 
23002764a2aaSMatthew G. Knepley   PetscFunctionBegin;
23012764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
23022764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
23034d0b9603SSander Arens   if (basis)    {PetscValidPointer(basis, 2);    *basis    = prob->basisFace;}
23044d0b9603SSander Arens   if (basisDer) {PetscValidPointer(basisDer, 3); *basisDer = prob->basisDerFace;}
23052764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
23062764a2aaSMatthew G. Knepley }
23072764a2aaSMatthew G. Knepley 
23082764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetEvaluationArrays(PetscDS prob, PetscScalar **u, PetscScalar **u_t, PetscScalar **u_x)
23092764a2aaSMatthew G. Knepley {
23102764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
23112764a2aaSMatthew G. Knepley 
23122764a2aaSMatthew G. Knepley   PetscFunctionBegin;
23132764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
23142764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
23152764a2aaSMatthew G. Knepley   if (u)   {PetscValidPointer(u, 2);   *u   = prob->u;}
23162764a2aaSMatthew G. Knepley   if (u_t) {PetscValidPointer(u_t, 3); *u_t = prob->u_t;}
23172764a2aaSMatthew G. Knepley   if (u_x) {PetscValidPointer(u_x, 4); *u_x = prob->u_x;}
23182764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
23192764a2aaSMatthew G. Knepley }
23202764a2aaSMatthew G. Knepley 
23212764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetWeakFormArrays(PetscDS prob, PetscScalar **f0, PetscScalar **f1, PetscScalar **g0, PetscScalar **g1, PetscScalar **g2, PetscScalar **g3)
23222764a2aaSMatthew G. Knepley {
23232764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
23242764a2aaSMatthew G. Knepley 
23252764a2aaSMatthew G. Knepley   PetscFunctionBegin;
23262764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
23272764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
23282764a2aaSMatthew G. Knepley   if (f0) {PetscValidPointer(f0, 2); *f0 = prob->f0;}
23292764a2aaSMatthew G. Knepley   if (f1) {PetscValidPointer(f1, 3); *f1 = prob->f1;}
23302764a2aaSMatthew G. Knepley   if (g0) {PetscValidPointer(g0, 4); *g0 = prob->g0;}
23312764a2aaSMatthew G. Knepley   if (g1) {PetscValidPointer(g1, 5); *g1 = prob->g1;}
23322764a2aaSMatthew G. Knepley   if (g2) {PetscValidPointer(g2, 6); *g2 = prob->g2;}
23332764a2aaSMatthew G. Knepley   if (g3) {PetscValidPointer(g3, 7); *g3 = prob->g3;}
23342764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
23352764a2aaSMatthew G. Knepley }
23362764a2aaSMatthew G. Knepley 
23372764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetRefCoordArrays(PetscDS prob, PetscReal **x, PetscScalar **refSpaceDer)
23382764a2aaSMatthew G. Knepley {
23392764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
23402764a2aaSMatthew G. Knepley 
23412764a2aaSMatthew G. Knepley   PetscFunctionBegin;
23422764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
23432764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
23442764a2aaSMatthew G. Knepley   if (x)           {PetscValidPointer(x, 2);           *x           = prob->x;}
23452764a2aaSMatthew G. Knepley   if (refSpaceDer) {PetscValidPointer(refSpaceDer, 3); *refSpaceDer = prob->refSpaceDer;}
23462764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
23472764a2aaSMatthew G. Knepley }
23482764a2aaSMatthew G. Knepley 
234958ebd649SToby Isaac /*@C
235058ebd649SToby Isaac   PetscDSAddBoundary - Add a boundary condition to the model
235158ebd649SToby Isaac 
235258ebd649SToby Isaac   Input Parameters:
235358ebd649SToby Isaac + ds          - The PetscDS object
23542d47a189SJulian Andrej . type        - The type of condition, e.g. DM_BC_ESSENTIAL/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann)
235558ebd649SToby Isaac . name        - The BC name
235658ebd649SToby Isaac . labelname   - The label defining constrained points
235758ebd649SToby Isaac . field       - The field to constrain
235858ebd649SToby Isaac . numcomps    - The number of constrained field components
235958ebd649SToby Isaac . comps       - An array of constrained component numbers
236058ebd649SToby Isaac . bcFunc      - A pointwise function giving boundary values
236158ebd649SToby Isaac . numids      - The number of DMLabel ids for constrained points
236258ebd649SToby Isaac . ids         - An array of ids for constrained points
236358ebd649SToby Isaac - ctx         - An optional user context for bcFunc
236458ebd649SToby Isaac 
236558ebd649SToby Isaac   Options Database Keys:
236658ebd649SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids
236758ebd649SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components
236858ebd649SToby Isaac 
236958ebd649SToby Isaac   Level: developer
237058ebd649SToby Isaac 
237158ebd649SToby Isaac .seealso: PetscDSGetBoundary()
237258ebd649SToby Isaac @*/
2373a30ec4eaSSatish 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)
237458ebd649SToby Isaac {
237558ebd649SToby Isaac   DSBoundary     b;
237658ebd649SToby Isaac   PetscErrorCode ierr;
237758ebd649SToby Isaac 
237858ebd649SToby Isaac   PetscFunctionBegin;
237958ebd649SToby Isaac   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1);
238058ebd649SToby Isaac   ierr = PetscNew(&b);CHKERRQ(ierr);
238158ebd649SToby Isaac   ierr = PetscStrallocpy(name, (char **) &b->name);CHKERRQ(ierr);
238258ebd649SToby Isaac   ierr = PetscStrallocpy(labelname, (char **) &b->labelname);CHKERRQ(ierr);
238358ebd649SToby Isaac   ierr = PetscMalloc1(numcomps, &b->comps);CHKERRQ(ierr);
238458ebd649SToby Isaac   if (numcomps) {ierr = PetscMemcpy(b->comps, comps, numcomps*sizeof(PetscInt));CHKERRQ(ierr);}
238558ebd649SToby Isaac   ierr = PetscMalloc1(numids, &b->ids);CHKERRQ(ierr);
238658ebd649SToby Isaac   if (numids) {ierr = PetscMemcpy(b->ids, ids, numids*sizeof(PetscInt));CHKERRQ(ierr);}
2387f971fd6bSMatthew G. Knepley   b->type            = type;
238858ebd649SToby Isaac   b->field           = field;
238958ebd649SToby Isaac   b->numcomps        = numcomps;
239058ebd649SToby Isaac   b->func            = bcFunc;
239158ebd649SToby Isaac   b->numids          = numids;
239258ebd649SToby Isaac   b->ctx             = ctx;
239358ebd649SToby Isaac   b->next            = ds->boundary;
239458ebd649SToby Isaac   ds->boundary       = b;
239558ebd649SToby Isaac   PetscFunctionReturn(0);
239658ebd649SToby Isaac }
239758ebd649SToby Isaac 
239858ebd649SToby Isaac /*@
239958ebd649SToby Isaac   PetscDSGetNumBoundary - Get the number of registered BC
240058ebd649SToby Isaac 
240158ebd649SToby Isaac   Input Parameters:
240258ebd649SToby Isaac . ds - The PetscDS object
240358ebd649SToby Isaac 
240458ebd649SToby Isaac   Output Parameters:
240558ebd649SToby Isaac . numBd - The number of BC
240658ebd649SToby Isaac 
240758ebd649SToby Isaac   Level: intermediate
240858ebd649SToby Isaac 
240958ebd649SToby Isaac .seealso: PetscDSAddBoundary(), PetscDSGetBoundary()
241058ebd649SToby Isaac @*/
241158ebd649SToby Isaac PetscErrorCode PetscDSGetNumBoundary(PetscDS ds, PetscInt *numBd)
241258ebd649SToby Isaac {
241358ebd649SToby Isaac   DSBoundary b = ds->boundary;
241458ebd649SToby Isaac 
241558ebd649SToby Isaac   PetscFunctionBegin;
241658ebd649SToby Isaac   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1);
241758ebd649SToby Isaac   PetscValidPointer(numBd, 2);
241858ebd649SToby Isaac   *numBd = 0;
241958ebd649SToby Isaac   while (b) {++(*numBd); b = b->next;}
242058ebd649SToby Isaac   PetscFunctionReturn(0);
242158ebd649SToby Isaac }
242258ebd649SToby Isaac 
242358ebd649SToby Isaac /*@C
242458ebd649SToby Isaac   PetscDSGetBoundary - Add a boundary condition to the model
242558ebd649SToby Isaac 
242658ebd649SToby Isaac   Input Parameters:
242758ebd649SToby Isaac + ds          - The PetscDS object
242858ebd649SToby Isaac - bd          - The BC number
242958ebd649SToby Isaac 
243058ebd649SToby Isaac   Output Parameters:
24312d47a189SJulian Andrej + type        - The type of condition, e.g. DM_BC_ESSENTIAL/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann)
243258ebd649SToby Isaac . name        - The BC name
243358ebd649SToby Isaac . labelname   - The label defining constrained points
243458ebd649SToby Isaac . field       - The field to constrain
243558ebd649SToby Isaac . numcomps    - The number of constrained field components
243658ebd649SToby Isaac . comps       - An array of constrained component numbers
243758ebd649SToby Isaac . bcFunc      - A pointwise function giving boundary values
243858ebd649SToby Isaac . numids      - The number of DMLabel ids for constrained points
243958ebd649SToby Isaac . ids         - An array of ids for constrained points
244058ebd649SToby Isaac - ctx         - An optional user context for bcFunc
244158ebd649SToby Isaac 
244258ebd649SToby Isaac   Options Database Keys:
244358ebd649SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids
244458ebd649SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components
244558ebd649SToby Isaac 
244658ebd649SToby Isaac   Level: developer
244758ebd649SToby Isaac 
244858ebd649SToby Isaac .seealso: PetscDSAddBoundary()
244958ebd649SToby Isaac @*/
2450a30ec4eaSSatish 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)
245158ebd649SToby Isaac {
245258ebd649SToby Isaac   DSBoundary b    = ds->boundary;
245358ebd649SToby Isaac   PetscInt   n    = 0;
245458ebd649SToby Isaac 
245558ebd649SToby Isaac   PetscFunctionBegin;
245658ebd649SToby Isaac   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1);
245758ebd649SToby Isaac   while (b) {
245858ebd649SToby Isaac     if (n == bd) break;
245958ebd649SToby Isaac     b = b->next;
246058ebd649SToby Isaac     ++n;
246158ebd649SToby Isaac   }
246258ebd649SToby Isaac   if (!b) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Boundary %d is not in [0, %d)", bd, n);
2463f971fd6bSMatthew G. Knepley   if (type) {
2464f971fd6bSMatthew G. Knepley     PetscValidPointer(type, 3);
2465f971fd6bSMatthew G. Knepley     *type = b->type;
246658ebd649SToby Isaac   }
246758ebd649SToby Isaac   if (name) {
246858ebd649SToby Isaac     PetscValidPointer(name, 4);
246958ebd649SToby Isaac     *name = b->name;
247058ebd649SToby Isaac   }
247158ebd649SToby Isaac   if (labelname) {
247258ebd649SToby Isaac     PetscValidPointer(labelname, 5);
247358ebd649SToby Isaac     *labelname = b->labelname;
247458ebd649SToby Isaac   }
247558ebd649SToby Isaac   if (field) {
247658ebd649SToby Isaac     PetscValidPointer(field, 6);
247758ebd649SToby Isaac     *field = b->field;
247858ebd649SToby Isaac   }
247958ebd649SToby Isaac   if (numcomps) {
248058ebd649SToby Isaac     PetscValidPointer(numcomps, 7);
248158ebd649SToby Isaac     *numcomps = b->numcomps;
248258ebd649SToby Isaac   }
248358ebd649SToby Isaac   if (comps) {
248458ebd649SToby Isaac     PetscValidPointer(comps, 8);
248558ebd649SToby Isaac     *comps = b->comps;
248658ebd649SToby Isaac   }
248758ebd649SToby Isaac   if (func) {
248858ebd649SToby Isaac     PetscValidPointer(func, 9);
248958ebd649SToby Isaac     *func = b->func;
249058ebd649SToby Isaac   }
249158ebd649SToby Isaac   if (numids) {
249258ebd649SToby Isaac     PetscValidPointer(numids, 10);
249358ebd649SToby Isaac     *numids = b->numids;
249458ebd649SToby Isaac   }
249558ebd649SToby Isaac   if (ids) {
249658ebd649SToby Isaac     PetscValidPointer(ids, 11);
249758ebd649SToby Isaac     *ids = b->ids;
249858ebd649SToby Isaac   }
249958ebd649SToby Isaac   if (ctx) {
250058ebd649SToby Isaac     PetscValidPointer(ctx, 12);
250158ebd649SToby Isaac     *ctx = b->ctx;
250258ebd649SToby Isaac   }
250358ebd649SToby Isaac   PetscFunctionReturn(0);
250458ebd649SToby Isaac }
250558ebd649SToby Isaac 
2506dff059c6SToby Isaac PetscErrorCode PetscDSCopyBoundary(PetscDS probA, PetscDS probB)
2507dff059c6SToby Isaac {
2508dff059c6SToby Isaac   DSBoundary     b, next, *lastnext;
2509dff059c6SToby Isaac   PetscErrorCode ierr;
2510dff059c6SToby Isaac 
2511dff059c6SToby Isaac   PetscFunctionBegin;
2512dff059c6SToby Isaac   PetscValidHeaderSpecific(probA, PETSCDS_CLASSID, 1);
2513dff059c6SToby Isaac   PetscValidHeaderSpecific(probB, PETSCDS_CLASSID, 2);
2514dff059c6SToby Isaac   if (probA == probB) PetscFunctionReturn(0);
2515dff059c6SToby Isaac   next = probB->boundary;
2516dff059c6SToby Isaac   while (next) {
2517dff059c6SToby Isaac     DSBoundary b = next;
2518dff059c6SToby Isaac 
2519dff059c6SToby Isaac     next = b->next;
2520dff059c6SToby Isaac     ierr = PetscFree(b->comps);CHKERRQ(ierr);
2521dff059c6SToby Isaac     ierr = PetscFree(b->ids);CHKERRQ(ierr);
2522dff059c6SToby Isaac     ierr = PetscFree(b->name);CHKERRQ(ierr);
2523dff059c6SToby Isaac     ierr = PetscFree(b->labelname);CHKERRQ(ierr);
2524dff059c6SToby Isaac     ierr = PetscFree(b);CHKERRQ(ierr);
2525dff059c6SToby Isaac   }
2526dff059c6SToby Isaac   lastnext = &(probB->boundary);
2527dff059c6SToby Isaac   for (b = probA->boundary; b; b = b->next) {
2528dff059c6SToby Isaac     DSBoundary bNew;
2529dff059c6SToby Isaac 
2530459726d8SSatish Balay     ierr = PetscNew(&bNew);CHKERRQ(ierr);
2531dff059c6SToby Isaac     bNew->numcomps = b->numcomps;
2532dff059c6SToby Isaac     ierr = PetscMalloc1(bNew->numcomps, &bNew->comps);CHKERRQ(ierr);
2533dff059c6SToby Isaac     ierr = PetscMemcpy(bNew->comps, b->comps, bNew->numcomps*sizeof(PetscInt));CHKERRQ(ierr);
2534dff059c6SToby Isaac     bNew->numids = b->numids;
2535dff059c6SToby Isaac     ierr = PetscMalloc1(bNew->numids, &bNew->ids);CHKERRQ(ierr);
2536dff059c6SToby Isaac     ierr = PetscMemcpy(bNew->ids, b->ids, bNew->numids*sizeof(PetscInt));CHKERRQ(ierr);
2537dff059c6SToby Isaac     ierr = PetscStrallocpy(b->labelname,(char **) &(bNew->labelname));CHKERRQ(ierr);
2538dff059c6SToby Isaac     ierr = PetscStrallocpy(b->name,(char **) &(bNew->name));CHKERRQ(ierr);
2539dff059c6SToby Isaac     bNew->ctx   = b->ctx;
2540f971fd6bSMatthew G. Knepley     bNew->type  = b->type;
2541dff059c6SToby Isaac     bNew->field = b->field;
2542dff059c6SToby Isaac     bNew->func  = b->func;
2543dff059c6SToby Isaac 
2544dff059c6SToby Isaac     *lastnext = bNew;
2545dff059c6SToby Isaac     lastnext = &(bNew->next);
2546dff059c6SToby Isaac   }
2547dff059c6SToby Isaac   PetscFunctionReturn(0);
2548dff059c6SToby Isaac }
2549dff059c6SToby Isaac 
2550da51fcedSMatthew G. Knepley /*@
2551da51fcedSMatthew G. Knepley   PetscDSCopyEquations - Copy all pointwise function pointers to the new problem
2552da51fcedSMatthew G. Knepley 
2553da51fcedSMatthew G. Knepley   Not collective
2554da51fcedSMatthew G. Knepley 
2555da51fcedSMatthew G. Knepley   Input Parameter:
2556da51fcedSMatthew G. Knepley . prob - The PetscDS object
2557da51fcedSMatthew G. Knepley 
2558da51fcedSMatthew G. Knepley   Output Parameter:
2559da51fcedSMatthew G. Knepley . newprob - The PetscDS copy
2560da51fcedSMatthew G. Knepley 
2561da51fcedSMatthew G. Knepley   Level: intermediate
2562da51fcedSMatthew G. Knepley 
2563da51fcedSMatthew G. Knepley .seealso: PetscDSSetResidual(), PetscDSSetJacobian(), PetscDSSetRiemannSolver(), PetscDSSetBdResidual(), PetscDSSetBdJacobian(), PetscDSCreate()
2564da51fcedSMatthew G. Knepley @*/
2565da51fcedSMatthew G. Knepley PetscErrorCode PetscDSCopyEquations(PetscDS prob, PetscDS newprob)
2566da51fcedSMatthew G. Knepley {
2567da51fcedSMatthew G. Knepley   PetscInt       Nf, Ng, f, g;
2568da51fcedSMatthew G. Knepley   PetscErrorCode ierr;
2569da51fcedSMatthew G. Knepley 
2570da51fcedSMatthew G. Knepley   PetscFunctionBegin;
2571da51fcedSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2572da51fcedSMatthew G. Knepley   PetscValidHeaderSpecific(newprob, PETSCDS_CLASSID, 2);
2573da51fcedSMatthew G. Knepley   ierr = PetscDSGetNumFields(prob, &Nf);CHKERRQ(ierr);
2574da51fcedSMatthew G. Knepley   ierr = PetscDSGetNumFields(newprob, &Ng);CHKERRQ(ierr);
2575da51fcedSMatthew G. Knepley   if (Nf != Ng) SETERRQ2(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_SIZ, "Number of fields must match %D != %D", Nf, Ng);CHKERRQ(ierr);
2576da51fcedSMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
2577da51fcedSMatthew G. Knepley     PetscPointFunc   obj;
2578da51fcedSMatthew G. Knepley     PetscPointFunc   f0, f1;
2579da51fcedSMatthew G. Knepley     PetscPointJac    g0, g1, g2, g3;
2580da51fcedSMatthew G. Knepley     PetscBdPointFunc f0Bd, f1Bd;
2581da51fcedSMatthew G. Knepley     PetscBdPointJac  g0Bd, g1Bd, g2Bd, g3Bd;
2582da51fcedSMatthew G. Knepley     PetscRiemannFunc r;
2583da51fcedSMatthew G. Knepley 
2584da51fcedSMatthew G. Knepley     ierr = PetscDSGetObjective(prob, f, &obj);CHKERRQ(ierr);
2585da51fcedSMatthew G. Knepley     ierr = PetscDSGetResidual(prob, f, &f0, &f1);CHKERRQ(ierr);
2586da51fcedSMatthew G. Knepley     ierr = PetscDSGetBdResidual(prob, f, &f0Bd, &f1Bd);CHKERRQ(ierr);
2587da51fcedSMatthew G. Knepley     ierr = PetscDSGetRiemannSolver(prob, f, &r);CHKERRQ(ierr);
2588da51fcedSMatthew G. Knepley     ierr = PetscDSSetObjective(newprob, f, obj);CHKERRQ(ierr);
2589da51fcedSMatthew G. Knepley     ierr = PetscDSSetResidual(newprob, f, f0, f1);CHKERRQ(ierr);
2590da51fcedSMatthew G. Knepley     ierr = PetscDSSetBdResidual(newprob, f, f0Bd, f1Bd);CHKERRQ(ierr);
2591da51fcedSMatthew G. Knepley     ierr = PetscDSSetRiemannSolver(newprob, f, r);CHKERRQ(ierr);
2592da51fcedSMatthew G. Knepley     for (g = 0; g < Nf; ++g) {
2593da51fcedSMatthew G. Knepley       ierr = PetscDSGetJacobian(prob, f, g, &g0, &g1, &g2, &g3);CHKERRQ(ierr);
2594da51fcedSMatthew G. Knepley       ierr = PetscDSGetBdJacobian(prob, f, g, &g0Bd, &g1Bd, &g2Bd, &g3Bd);CHKERRQ(ierr);
2595da51fcedSMatthew G. Knepley       ierr = PetscDSSetJacobian(newprob, f, g, g0, g1, g2, g3);CHKERRQ(ierr);
2596da51fcedSMatthew G. Knepley       ierr = PetscDSSetBdJacobian(newprob, f, g, g0Bd, g1Bd, g2Bd, g3Bd);CHKERRQ(ierr);
2597da51fcedSMatthew G. Knepley     }
2598da51fcedSMatthew G. Knepley   }
2599da51fcedSMatthew G. Knepley   PetscFunctionReturn(0);
2600da51fcedSMatthew G. Knepley }
2601da51fcedSMatthew G. Knepley 
2602bc4ae4beSMatthew G. Knepley static PetscErrorCode PetscDSDestroy_Basic(PetscDS prob)
26032764a2aaSMatthew G. Knepley {
2604931fb3b8SToby Isaac   PetscErrorCode      ierr;
2605931fb3b8SToby Isaac 
26062764a2aaSMatthew G. Knepley   PetscFunctionBegin;
2607931fb3b8SToby Isaac   ierr = PetscFree(prob->data);CHKERRQ(ierr);
26082764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
26092764a2aaSMatthew G. Knepley }
26102764a2aaSMatthew G. Knepley 
2611bc4ae4beSMatthew G. Knepley static PetscErrorCode PetscDSInitialize_Basic(PetscDS prob)
26122764a2aaSMatthew G. Knepley {
26132764a2aaSMatthew G. Knepley   PetscFunctionBegin;
26142764a2aaSMatthew G. Knepley   prob->ops->setfromoptions = NULL;
26152764a2aaSMatthew G. Knepley   prob->ops->setup          = NULL;
26162764a2aaSMatthew G. Knepley   prob->ops->view           = NULL;
26172764a2aaSMatthew G. Knepley   prob->ops->destroy        = PetscDSDestroy_Basic;
26182764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
26192764a2aaSMatthew G. Knepley }
26202764a2aaSMatthew G. Knepley 
26212764a2aaSMatthew G. Knepley /*MC
26222764a2aaSMatthew G. Knepley   PETSCDSBASIC = "basic" - A discrete system with pointwise residual and boundary residual functions
26232764a2aaSMatthew G. Knepley 
26242764a2aaSMatthew G. Knepley   Level: intermediate
26252764a2aaSMatthew G. Knepley 
26262764a2aaSMatthew G. Knepley .seealso: PetscDSType, PetscDSCreate(), PetscDSSetType()
26272764a2aaSMatthew G. Knepley M*/
26282764a2aaSMatthew G. Knepley 
26292764a2aaSMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscDSCreate_Basic(PetscDS prob)
26302764a2aaSMatthew G. Knepley {
26312764a2aaSMatthew G. Knepley   PetscDS_Basic *b;
26322764a2aaSMatthew G. Knepley   PetscErrorCode      ierr;
26332764a2aaSMatthew G. Knepley 
26342764a2aaSMatthew G. Knepley   PetscFunctionBegin;
2635931fb3b8SToby Isaac   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
26362764a2aaSMatthew G. Knepley   ierr       = PetscNewLog(prob, &b);CHKERRQ(ierr);
26372764a2aaSMatthew G. Knepley   prob->data = b;
26382764a2aaSMatthew G. Knepley 
26392764a2aaSMatthew G. Knepley   ierr = PetscDSInitialize_Basic(prob);CHKERRQ(ierr);
26402764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
26412764a2aaSMatthew G. Knepley }
2642