xref: /petsc/src/dm/dt/interface/dtds.c (revision a30ec4eab21047868b4ea34d315622f953eb6ffa)
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       Nb   = 1;
3159de99aefSMatthew G. Knepley       ierr = PetscFVGetNumComponents(fv, &Nc);CHKERRQ(ierr);
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];
3239de99aefSMatthew G. Knepley     if (q) {ierr = PetscQuadratureGetData(q, NULL, &Nq, NULL, NULL);CHKERRQ(ierr);}
3242764a2aaSMatthew G. Knepley     NqMax          = PetscMax(NqMax, Nq);
3252764a2aaSMatthew G. Knepley     NcMax          = PetscMax(NcMax, Nc);
3262764a2aaSMatthew G. Knepley     prob->totDim  += Nb*Nc;
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;
3552aa1fc23SMatthew G. Knepley   PetscPointFunc   *tmpobj, *tmpf;
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);
3772764a2aaSMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpobj[f] = prob->obj[f];
3782764a2aaSMatthew G. Knepley   for (f = 0; f < Nf*2; ++f) tmpf[f] = prob->f[f];
3792764a2aaSMatthew G. Knepley   for (f = 0; f < Nf*Nf*4; ++f) tmpg[f] = prob->g[f];
380475e0ac9SMatthew G. Knepley   for (f = 0; f < Nf*Nf*4; ++f) tmpgp[f] = prob->gp[f];
3810c2f2876SMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpr[f] = prob->r[f];
3820c2f2876SMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpctx[f] = prob->ctx[f];
3832764a2aaSMatthew G. Knepley   for (f = Nf; f < NfNew; ++f) tmpobj[f] = NULL;
3842764a2aaSMatthew G. Knepley   for (f = Nf*2; f < NfNew*2; ++f) tmpf[f] = NULL;
3852764a2aaSMatthew G. Knepley   for (f = Nf*Nf*4; f < NfNew*NfNew*4; ++f) tmpg[f] = NULL;
386475e0ac9SMatthew G. Knepley   for (f = Nf*Nf*4; f < NfNew*NfNew*4; ++f) tmpgp[f] = NULL;
387b7e05686SMatthew G. Knepley   for (f = Nf*Nf*4; f < NfNew*NfNew*4; ++f) tmpgt[f] = NULL;
3880c2f2876SMatthew G. Knepley   for (f = Nf; f < NfNew; ++f) tmpr[f] = NULL;
3890c2f2876SMatthew G. Knepley   for (f = Nf; f < NfNew; ++f) tmpctx[f] = NULL;
390b7e05686SMatthew G. Knepley   ierr = PetscFree7(prob->obj, prob->f, prob->g, prob->gp, prob->gt, prob->r, prob->ctx);CHKERRQ(ierr);
3912764a2aaSMatthew G. Knepley   prob->obj = tmpobj;
3922764a2aaSMatthew G. Knepley   prob->f   = tmpf;
3932764a2aaSMatthew G. Knepley   prob->g   = tmpg;
394475e0ac9SMatthew G. Knepley   prob->gp  = tmpgp;
395b7e05686SMatthew G. Knepley   prob->gt  = tmpgt;
3960c2f2876SMatthew G. Knepley   prob->r   = tmpr;
3970c2f2876SMatthew G. Knepley   prob->ctx = tmpctx;
3982764a2aaSMatthew G. Knepley   ierr = PetscCalloc2(NfNew*2, &tmpfbd, NfNew*NfNew*4, &tmpgbd);CHKERRQ(ierr);
3992764a2aaSMatthew G. Knepley   for (f = 0; f < Nf*2; ++f) tmpfbd[f] = prob->fBd[f];
4002764a2aaSMatthew G. Knepley   for (f = 0; f < Nf*Nf*4; ++f) tmpgbd[f] = prob->gBd[f];
4012764a2aaSMatthew G. Knepley   for (f = Nf*2; f < NfNew*2; ++f) tmpfbd[f] = NULL;
4022764a2aaSMatthew G. Knepley   for (f = Nf*Nf*4; f < NfNew*NfNew*4; ++f) tmpgbd[f] = NULL;
4032764a2aaSMatthew G. Knepley   ierr = PetscFree2(prob->fBd, prob->gBd);CHKERRQ(ierr);
4042764a2aaSMatthew G. Knepley   prob->fBd = tmpfbd;
4052764a2aaSMatthew G. Knepley   prob->gBd = tmpgbd;
4062764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
4072764a2aaSMatthew G. Knepley }
4082764a2aaSMatthew G. Knepley 
4092764a2aaSMatthew G. Knepley /*@
4102764a2aaSMatthew G. Knepley   PetscDSDestroy - Destroys a PetscDS object
4112764a2aaSMatthew G. Knepley 
4122764a2aaSMatthew G. Knepley   Collective on PetscDS
4132764a2aaSMatthew G. Knepley 
4142764a2aaSMatthew G. Knepley   Input Parameter:
4152764a2aaSMatthew G. Knepley . prob - the PetscDS object to destroy
4162764a2aaSMatthew G. Knepley 
4172764a2aaSMatthew G. Knepley   Level: developer
4182764a2aaSMatthew G. Knepley 
4192764a2aaSMatthew G. Knepley .seealso PetscDSView()
4202764a2aaSMatthew G. Knepley @*/
4212764a2aaSMatthew G. Knepley PetscErrorCode PetscDSDestroy(PetscDS *prob)
4222764a2aaSMatthew G. Knepley {
4232764a2aaSMatthew G. Knepley   PetscInt       f;
42458ebd649SToby Isaac   DSBoundary     next;
4252764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
4262764a2aaSMatthew G. Knepley 
4272764a2aaSMatthew G. Knepley   PetscFunctionBegin;
4282764a2aaSMatthew G. Knepley   if (!*prob) PetscFunctionReturn(0);
4292764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific((*prob), PETSCDS_CLASSID, 1);
4302764a2aaSMatthew G. Knepley 
4312764a2aaSMatthew G. Knepley   if (--((PetscObject)(*prob))->refct > 0) {*prob = 0; PetscFunctionReturn(0);}
4322764a2aaSMatthew G. Knepley   ((PetscObject) (*prob))->refct = 0;
4332764a2aaSMatthew G. Knepley   ierr = PetscDSDestroyStructs_Static(*prob);CHKERRQ(ierr);
4342764a2aaSMatthew G. Knepley   for (f = 0; f < (*prob)->Nf; ++f) {
4352764a2aaSMatthew G. Knepley     ierr = PetscObjectDereference((*prob)->disc[f]);CHKERRQ(ierr);
4362764a2aaSMatthew G. Knepley   }
437f744cafaSSander Arens   ierr = PetscFree3((*prob)->disc, (*prob)->implicit, (*prob)->adjacency);CHKERRQ(ierr);
438b7e05686SMatthew G. Knepley   ierr = PetscFree7((*prob)->obj,(*prob)->f,(*prob)->g,(*prob)->gp,(*prob)->gt,(*prob)->r,(*prob)->ctx);CHKERRQ(ierr);
4392764a2aaSMatthew G. Knepley   ierr = PetscFree2((*prob)->fBd,(*prob)->gBd);CHKERRQ(ierr);
4402764a2aaSMatthew G. Knepley   if ((*prob)->ops->destroy) {ierr = (*(*prob)->ops->destroy)(*prob);CHKERRQ(ierr);}
44158ebd649SToby Isaac   next = (*prob)->boundary;
44258ebd649SToby Isaac   while (next) {
44358ebd649SToby Isaac     DSBoundary b = next;
44458ebd649SToby Isaac 
44558ebd649SToby Isaac     next = b->next;
44658ebd649SToby Isaac     ierr = PetscFree(b->comps);CHKERRQ(ierr);
44758ebd649SToby Isaac     ierr = PetscFree(b->ids);CHKERRQ(ierr);
44858ebd649SToby Isaac     ierr = PetscFree(b->name);CHKERRQ(ierr);
44958ebd649SToby Isaac     ierr = PetscFree(b->labelname);CHKERRQ(ierr);
45058ebd649SToby Isaac     ierr = PetscFree(b);CHKERRQ(ierr);
45158ebd649SToby Isaac   }
4522764a2aaSMatthew G. Knepley   ierr = PetscHeaderDestroy(prob);CHKERRQ(ierr);
4532764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
4542764a2aaSMatthew G. Knepley }
4552764a2aaSMatthew G. Knepley 
4562764a2aaSMatthew G. Knepley /*@
4572764a2aaSMatthew G. Knepley   PetscDSCreate - Creates an empty PetscDS object. The type can then be set with PetscDSSetType().
4582764a2aaSMatthew G. Knepley 
4592764a2aaSMatthew G. Knepley   Collective on MPI_Comm
4602764a2aaSMatthew G. Knepley 
4612764a2aaSMatthew G. Knepley   Input Parameter:
4622764a2aaSMatthew G. Knepley . comm - The communicator for the PetscDS object
4632764a2aaSMatthew G. Knepley 
4642764a2aaSMatthew G. Knepley   Output Parameter:
4652764a2aaSMatthew G. Knepley . prob - The PetscDS object
4662764a2aaSMatthew G. Knepley 
4672764a2aaSMatthew G. Knepley   Level: beginner
4682764a2aaSMatthew G. Knepley 
4692764a2aaSMatthew G. Knepley .seealso: PetscDSSetType(), PETSCDSBASIC
4702764a2aaSMatthew G. Knepley @*/
4712764a2aaSMatthew G. Knepley PetscErrorCode PetscDSCreate(MPI_Comm comm, PetscDS *prob)
4722764a2aaSMatthew G. Knepley {
4732764a2aaSMatthew G. Knepley   PetscDS   p;
4742764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
4752764a2aaSMatthew G. Knepley 
4762764a2aaSMatthew G. Knepley   PetscFunctionBegin;
4772764a2aaSMatthew G. Knepley   PetscValidPointer(prob, 2);
4782764a2aaSMatthew G. Knepley   *prob  = NULL;
4792764a2aaSMatthew G. Knepley   ierr = PetscDSInitializePackage();CHKERRQ(ierr);
4802764a2aaSMatthew G. Knepley 
48173107ff1SLisandro Dalcin   ierr = PetscHeaderCreate(p, PETSCDS_CLASSID, "PetscDS", "Discrete System", "PetscDS", comm, PetscDSDestroy, PetscDSView);CHKERRQ(ierr);
4822764a2aaSMatthew G. Knepley 
4832764a2aaSMatthew G. Knepley   p->Nf    = 0;
4842764a2aaSMatthew G. Knepley   p->setup = PETSC_FALSE;
4852764a2aaSMatthew G. Knepley 
4862764a2aaSMatthew G. Knepley   *prob = p;
4872764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
4882764a2aaSMatthew G. Knepley }
4892764a2aaSMatthew G. Knepley 
490bc4ae4beSMatthew G. Knepley /*@
491bc4ae4beSMatthew G. Knepley   PetscDSGetNumFields - Returns the number of fields in the DS
492bc4ae4beSMatthew G. Knepley 
493bc4ae4beSMatthew G. Knepley   Not collective
494bc4ae4beSMatthew G. Knepley 
495bc4ae4beSMatthew G. Knepley   Input Parameter:
496bc4ae4beSMatthew G. Knepley . prob - The PetscDS object
497bc4ae4beSMatthew G. Knepley 
498bc4ae4beSMatthew G. Knepley   Output Parameter:
499bc4ae4beSMatthew G. Knepley . Nf - The number of fields
500bc4ae4beSMatthew G. Knepley 
501bc4ae4beSMatthew G. Knepley   Level: beginner
502bc4ae4beSMatthew G. Knepley 
503bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetSpatialDimension(), PetscDSCreate()
504bc4ae4beSMatthew G. Knepley @*/
5052764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetNumFields(PetscDS prob, PetscInt *Nf)
5062764a2aaSMatthew G. Knepley {
5072764a2aaSMatthew G. Knepley   PetscFunctionBegin;
5082764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
5092764a2aaSMatthew G. Knepley   PetscValidPointer(Nf, 2);
5102764a2aaSMatthew G. Knepley   *Nf = prob->Nf;
5112764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
5122764a2aaSMatthew G. Knepley }
5132764a2aaSMatthew G. Knepley 
514bc4ae4beSMatthew G. Knepley /*@
515bc4ae4beSMatthew G. Knepley   PetscDSGetSpatialDimension - Returns the spatial dimension of the DS
516bc4ae4beSMatthew G. Knepley 
517bc4ae4beSMatthew G. Knepley   Not collective
518bc4ae4beSMatthew G. Knepley 
519bc4ae4beSMatthew G. Knepley   Input Parameter:
520bc4ae4beSMatthew G. Knepley . prob - The PetscDS object
521bc4ae4beSMatthew G. Knepley 
522bc4ae4beSMatthew G. Knepley   Output Parameter:
523bc4ae4beSMatthew G. Knepley . dim - The spatial dimension
524bc4ae4beSMatthew G. Knepley 
525bc4ae4beSMatthew G. Knepley   Level: beginner
526bc4ae4beSMatthew G. Knepley 
527bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetNumFields(), PetscDSCreate()
528bc4ae4beSMatthew G. Knepley @*/
5292764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetSpatialDimension(PetscDS prob, PetscInt *dim)
5302764a2aaSMatthew G. Knepley {
5312764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
5322764a2aaSMatthew G. Knepley 
5332764a2aaSMatthew G. Knepley   PetscFunctionBegin;
5342764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
5352764a2aaSMatthew G. Knepley   PetscValidPointer(dim, 2);
5362764a2aaSMatthew G. Knepley   *dim = 0;
5379de99aefSMatthew G. Knepley   if (prob->Nf) {
5389de99aefSMatthew G. Knepley     PetscObject  obj;
5399de99aefSMatthew G. Knepley     PetscClassId id;
5409de99aefSMatthew G. Knepley 
5419de99aefSMatthew G. Knepley     ierr = PetscDSGetDiscretization(prob, 0, &obj);CHKERRQ(ierr);
5429de99aefSMatthew G. Knepley     ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr);
5439de99aefSMatthew G. Knepley     if (id == PETSCFE_CLASSID)      {ierr = PetscFEGetSpatialDimension((PetscFE) obj, dim);CHKERRQ(ierr);}
5449de99aefSMatthew G. Knepley     else if (id == PETSCFV_CLASSID) {ierr = PetscFVGetSpatialDimension((PetscFV) obj, dim);CHKERRQ(ierr);}
5459de99aefSMatthew G. Knepley     else SETERRQ1(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Unknown discretization type for field %d", 0);
5469de99aefSMatthew G. Knepley   }
5472764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
5482764a2aaSMatthew G. Knepley }
5492764a2aaSMatthew G. Knepley 
550bc4ae4beSMatthew G. Knepley /*@
551bc4ae4beSMatthew G. Knepley   PetscDSGetTotalDimension - Returns the total size of the approximation space for this system
552bc4ae4beSMatthew G. Knepley 
553bc4ae4beSMatthew G. Knepley   Not collective
554bc4ae4beSMatthew G. Knepley 
555bc4ae4beSMatthew G. Knepley   Input Parameter:
556bc4ae4beSMatthew G. Knepley . prob - The PetscDS object
557bc4ae4beSMatthew G. Knepley 
558bc4ae4beSMatthew G. Knepley   Output Parameter:
559bc4ae4beSMatthew G. Knepley . dim - The total problem dimension
560bc4ae4beSMatthew G. Knepley 
561bc4ae4beSMatthew G. Knepley   Level: beginner
562bc4ae4beSMatthew G. Knepley 
563bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetNumFields(), PetscDSCreate()
564bc4ae4beSMatthew G. Knepley @*/
5652764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetTotalDimension(PetscDS prob, PetscInt *dim)
5662764a2aaSMatthew G. Knepley {
5672764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
5682764a2aaSMatthew G. Knepley 
5692764a2aaSMatthew G. Knepley   PetscFunctionBegin;
5702764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
5712764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
5722764a2aaSMatthew G. Knepley   PetscValidPointer(dim, 2);
5732764a2aaSMatthew G. Knepley   *dim = prob->totDim;
5742764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
5752764a2aaSMatthew G. Knepley }
5762764a2aaSMatthew G. Knepley 
577bc4ae4beSMatthew G. Knepley /*@
578bc4ae4beSMatthew G. Knepley   PetscDSGetTotalComponents - Returns the total number of components in this system
579bc4ae4beSMatthew G. Knepley 
580bc4ae4beSMatthew G. Knepley   Not collective
581bc4ae4beSMatthew G. Knepley 
582bc4ae4beSMatthew G. Knepley   Input Parameter:
583bc4ae4beSMatthew G. Knepley . prob - The PetscDS object
584bc4ae4beSMatthew G. Knepley 
585bc4ae4beSMatthew G. Knepley   Output Parameter:
586bc4ae4beSMatthew G. Knepley . dim - The total number of components
587bc4ae4beSMatthew G. Knepley 
588bc4ae4beSMatthew G. Knepley   Level: beginner
589bc4ae4beSMatthew G. Knepley 
590bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetNumFields(), PetscDSCreate()
591bc4ae4beSMatthew G. Knepley @*/
5922764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetTotalComponents(PetscDS prob, PetscInt *Nc)
5932764a2aaSMatthew G. Knepley {
5942764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
5952764a2aaSMatthew G. Knepley 
5962764a2aaSMatthew G. Knepley   PetscFunctionBegin;
5972764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
5982764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
5992764a2aaSMatthew G. Knepley   PetscValidPointer(Nc, 2);
6002764a2aaSMatthew G. Knepley   *Nc = prob->totComp;
6012764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
6022764a2aaSMatthew G. Knepley }
6032764a2aaSMatthew G. Knepley 
604bc4ae4beSMatthew G. Knepley /*@
605bc4ae4beSMatthew G. Knepley   PetscDSGetDiscretization - Returns the discretization object for the given field
606bc4ae4beSMatthew G. Knepley 
607bc4ae4beSMatthew G. Knepley   Not collective
608bc4ae4beSMatthew G. Knepley 
609bc4ae4beSMatthew G. Knepley   Input Parameters:
610bc4ae4beSMatthew G. Knepley + prob - The PetscDS object
611bc4ae4beSMatthew G. Knepley - f - The field number
612bc4ae4beSMatthew G. Knepley 
613bc4ae4beSMatthew G. Knepley   Output Parameter:
614bc4ae4beSMatthew G. Knepley . disc - The discretization object
615bc4ae4beSMatthew G. Knepley 
616bc4ae4beSMatthew G. Knepley   Level: beginner
617bc4ae4beSMatthew G. Knepley 
618f744cafaSSander Arens .seealso: PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
619bc4ae4beSMatthew G. Knepley @*/
6202764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetDiscretization(PetscDS prob, PetscInt f, PetscObject *disc)
6212764a2aaSMatthew G. Knepley {
6222764a2aaSMatthew G. Knepley   PetscFunctionBegin;
6232764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
6242764a2aaSMatthew G. Knepley   PetscValidPointer(disc, 3);
6252764a2aaSMatthew 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);
6262764a2aaSMatthew G. Knepley   *disc = prob->disc[f];
6272764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
6282764a2aaSMatthew G. Knepley }
6292764a2aaSMatthew G. Knepley 
630bc4ae4beSMatthew G. Knepley /*@
631bc4ae4beSMatthew G. Knepley   PetscDSSetDiscretization - Sets the discretization object for the given field
632bc4ae4beSMatthew G. Knepley 
633bc4ae4beSMatthew G. Knepley   Not collective
634bc4ae4beSMatthew G. Knepley 
635bc4ae4beSMatthew G. Knepley   Input Parameters:
636bc4ae4beSMatthew G. Knepley + prob - The PetscDS object
637bc4ae4beSMatthew G. Knepley . f - The field number
638bc4ae4beSMatthew G. Knepley - disc - The discretization object
639bc4ae4beSMatthew G. Knepley 
640bc4ae4beSMatthew G. Knepley   Level: beginner
641bc4ae4beSMatthew G. Knepley 
642bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
643bc4ae4beSMatthew G. Knepley @*/
6442764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetDiscretization(PetscDS prob, PetscInt f, PetscObject disc)
6452764a2aaSMatthew G. Knepley {
6462764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
6472764a2aaSMatthew G. Knepley 
6482764a2aaSMatthew G. Knepley   PetscFunctionBegin;
6492764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
6502764a2aaSMatthew G. Knepley   PetscValidPointer(disc, 3);
6512764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
6522764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
6532764a2aaSMatthew G. Knepley   if (prob->disc[f]) {ierr = PetscObjectDereference(prob->disc[f]);CHKERRQ(ierr);}
6542764a2aaSMatthew G. Knepley   prob->disc[f] = disc;
6552764a2aaSMatthew G. Knepley   ierr = PetscObjectReference(disc);CHKERRQ(ierr);
656249df284SMatthew G. Knepley   {
657249df284SMatthew G. Knepley     PetscClassId id;
658249df284SMatthew G. Knepley 
659249df284SMatthew G. Knepley     ierr = PetscObjectGetClassId(disc, &id);CHKERRQ(ierr);
660a6cbbb48SMatthew G. Knepley     if (id == PETSCFV_CLASSID) {
661a6cbbb48SMatthew G. Knepley       prob->implicit[f]      = PETSC_FALSE;
662a6cbbb48SMatthew G. Knepley       prob->adjacency[f*2+0] = PETSC_TRUE;
663a6cbbb48SMatthew G. Knepley       prob->adjacency[f*2+1] = PETSC_FALSE;
664a6cbbb48SMatthew G. Knepley     }
665249df284SMatthew G. Knepley   }
6662764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
6672764a2aaSMatthew G. Knepley }
6682764a2aaSMatthew G. Knepley 
669bc4ae4beSMatthew G. Knepley /*@
670bc4ae4beSMatthew G. Knepley   PetscDSAddDiscretization - Adds a discretization object
671bc4ae4beSMatthew G. Knepley 
672bc4ae4beSMatthew G. Knepley   Not collective
673bc4ae4beSMatthew G. Knepley 
674bc4ae4beSMatthew G. Knepley   Input Parameters:
675bc4ae4beSMatthew G. Knepley + prob - The PetscDS object
676bc4ae4beSMatthew G. Knepley - disc - The boundary discretization object
677bc4ae4beSMatthew G. Knepley 
678bc4ae4beSMatthew G. Knepley   Level: beginner
679bc4ae4beSMatthew G. Knepley 
680bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetDiscretization(), PetscDSSetDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
681bc4ae4beSMatthew G. Knepley @*/
6822764a2aaSMatthew G. Knepley PetscErrorCode PetscDSAddDiscretization(PetscDS prob, PetscObject disc)
6832764a2aaSMatthew G. Knepley {
6842764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
6852764a2aaSMatthew G. Knepley 
6862764a2aaSMatthew G. Knepley   PetscFunctionBegin;
6872764a2aaSMatthew G. Knepley   ierr = PetscDSSetDiscretization(prob, prob->Nf, disc);CHKERRQ(ierr);
6882764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
6892764a2aaSMatthew G. Knepley }
6902764a2aaSMatthew G. Knepley 
691249df284SMatthew G. Knepley /*@
692249df284SMatthew G. Knepley   PetscDSGetImplicit - Returns the flag for implicit solve for this field. This is just a guide for IMEX
693249df284SMatthew G. Knepley 
694249df284SMatthew G. Knepley   Not collective
695249df284SMatthew G. Knepley 
696249df284SMatthew G. Knepley   Input Parameters:
697249df284SMatthew G. Knepley + prob - The PetscDS object
698249df284SMatthew G. Knepley - f - The field number
699249df284SMatthew G. Knepley 
700249df284SMatthew G. Knepley   Output Parameter:
701249df284SMatthew G. Knepley . implicit - The flag indicating what kind of solve to use for this field
702249df284SMatthew G. Knepley 
703249df284SMatthew G. Knepley   Level: developer
704249df284SMatthew G. Knepley 
705f744cafaSSander Arens .seealso: PetscDSSetImplicit(), PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
706249df284SMatthew G. Knepley @*/
707249df284SMatthew G. Knepley PetscErrorCode PetscDSGetImplicit(PetscDS prob, PetscInt f, PetscBool *implicit)
708249df284SMatthew G. Knepley {
709249df284SMatthew G. Knepley   PetscFunctionBegin;
710249df284SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
711249df284SMatthew G. Knepley   PetscValidPointer(implicit, 3);
712249df284SMatthew 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);
713249df284SMatthew G. Knepley   *implicit = prob->implicit[f];
714249df284SMatthew G. Knepley   PetscFunctionReturn(0);
715249df284SMatthew G. Knepley }
716249df284SMatthew G. Knepley 
717249df284SMatthew G. Knepley /*@
718249df284SMatthew G. Knepley   PetscDSSetImplicit - Set the flag for implicit solve for this field. This is just a guide for IMEX
719249df284SMatthew G. Knepley 
720249df284SMatthew G. Knepley   Not collective
721249df284SMatthew G. Knepley 
722249df284SMatthew G. Knepley   Input Parameters:
723249df284SMatthew G. Knepley + prob - The PetscDS object
724249df284SMatthew G. Knepley . f - The field number
725249df284SMatthew G. Knepley - implicit - The flag indicating what kind of solve to use for this field
726249df284SMatthew G. Knepley 
727249df284SMatthew G. Knepley   Level: developer
728249df284SMatthew G. Knepley 
729f744cafaSSander Arens .seealso: PetscDSGetImplicit(), PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
730249df284SMatthew G. Knepley @*/
731249df284SMatthew G. Knepley PetscErrorCode PetscDSSetImplicit(PetscDS prob, PetscInt f, PetscBool implicit)
732249df284SMatthew G. Knepley {
733249df284SMatthew G. Knepley   PetscFunctionBegin;
734249df284SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
735249df284SMatthew 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);
736249df284SMatthew G. Knepley   prob->implicit[f] = implicit;
737249df284SMatthew G. Knepley   PetscFunctionReturn(0);
738249df284SMatthew G. Knepley }
739249df284SMatthew G. Knepley 
740a6cbbb48SMatthew G. Knepley /*@
741a6cbbb48SMatthew G. Knepley   PetscDSGetAdjacency - Returns the flags for determining variable influence
742a6cbbb48SMatthew G. Knepley 
743a6cbbb48SMatthew G. Knepley   Not collective
744a6cbbb48SMatthew G. Knepley 
745a6cbbb48SMatthew G. Knepley   Input Parameters:
746a6cbbb48SMatthew G. Knepley + prob - The PetscDS object
747a6cbbb48SMatthew G. Knepley - f - The field number
748a6cbbb48SMatthew G. Knepley 
749a6cbbb48SMatthew G. Knepley   Output Parameter:
750a6cbbb48SMatthew G. Knepley + useCone    - Flag for variable influence starting with the cone operation
751a6cbbb48SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
752a6cbbb48SMatthew G. Knepley 
753a6cbbb48SMatthew G. Knepley   Note: See the discussion in DMPlexGetAdjacencyUseCone() and DMPlexGetAdjacencyUseClosure()
754a6cbbb48SMatthew G. Knepley 
755a6cbbb48SMatthew G. Knepley   Level: developer
756a6cbbb48SMatthew G. Knepley 
757f744cafaSSander Arens .seealso: PetscDSSetAdjacency(), DMPlexGetAdjacencyUseCone(), DMPlexGetAdjacencyUseClosure(), PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
758a6cbbb48SMatthew G. Knepley @*/
759a6cbbb48SMatthew G. Knepley PetscErrorCode PetscDSGetAdjacency(PetscDS prob, PetscInt f, PetscBool *useCone, PetscBool *useClosure)
760a6cbbb48SMatthew G. Knepley {
761a6cbbb48SMatthew G. Knepley   PetscFunctionBegin;
762a6cbbb48SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
763a6cbbb48SMatthew G. Knepley   PetscValidPointer(useCone, 3);
764a6cbbb48SMatthew G. Knepley   PetscValidPointer(useClosure, 4);
765a6cbbb48SMatthew 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);
766a6cbbb48SMatthew G. Knepley   *useCone    = prob->adjacency[f*2+0];
767a6cbbb48SMatthew G. Knepley   *useClosure = prob->adjacency[f*2+1];
768a6cbbb48SMatthew G. Knepley   PetscFunctionReturn(0);
769a6cbbb48SMatthew G. Knepley }
770a6cbbb48SMatthew G. Knepley 
771a6cbbb48SMatthew G. Knepley /*@
772a6cbbb48SMatthew G. Knepley   PetscDSSetAdjacency - Set the flags for determining variable influence
773a6cbbb48SMatthew G. Knepley 
774a6cbbb48SMatthew G. Knepley   Not collective
775a6cbbb48SMatthew G. Knepley 
776a6cbbb48SMatthew G. Knepley   Input Parameters:
777a6cbbb48SMatthew G. Knepley + prob - The PetscDS object
778a6cbbb48SMatthew G. Knepley . f - The field number
779a6cbbb48SMatthew G. Knepley . useCone    - Flag for variable influence starting with the cone operation
780a6cbbb48SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
781a6cbbb48SMatthew G. Knepley 
782a6cbbb48SMatthew G. Knepley   Note: See the discussion in DMPlexGetAdjacencyUseCone() and DMPlexGetAdjacencyUseClosure()
783a6cbbb48SMatthew G. Knepley 
784a6cbbb48SMatthew G. Knepley   Level: developer
785a6cbbb48SMatthew G. Knepley 
786f744cafaSSander Arens .seealso: PetscDSGetAdjacency(), DMPlexGetAdjacencyUseCone(), DMPlexGetAdjacencyUseClosure(), PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
787a6cbbb48SMatthew G. Knepley @*/
788a6cbbb48SMatthew G. Knepley PetscErrorCode PetscDSSetAdjacency(PetscDS prob, PetscInt f, PetscBool useCone, PetscBool useClosure)
789a6cbbb48SMatthew G. Knepley {
790a6cbbb48SMatthew G. Knepley   PetscFunctionBegin;
791a6cbbb48SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
792a6cbbb48SMatthew 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);
793a6cbbb48SMatthew G. Knepley   prob->adjacency[f*2+0] = useCone;
794a6cbbb48SMatthew G. Knepley   prob->adjacency[f*2+1] = useClosure;
795a6cbbb48SMatthew G. Knepley   PetscFunctionReturn(0);
796a6cbbb48SMatthew G. Knepley }
797a6cbbb48SMatthew G. Knepley 
7982764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetObjective(PetscDS prob, PetscInt f,
79930b9ff8bSMatthew G. Knepley                                    void (**obj)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
800194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
801194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
80230b9ff8bSMatthew G. Knepley                                                 PetscReal t, const PetscReal x[], PetscScalar obj[]))
8032764a2aaSMatthew G. Knepley {
8042764a2aaSMatthew G. Knepley   PetscFunctionBegin;
8052764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
8062764a2aaSMatthew G. Knepley   PetscValidPointer(obj, 2);
8072764a2aaSMatthew 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);
8082764a2aaSMatthew G. Knepley   *obj = prob->obj[f];
8092764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
8102764a2aaSMatthew G. Knepley }
8112764a2aaSMatthew G. Knepley 
8122764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetObjective(PetscDS prob, PetscInt f,
81330b9ff8bSMatthew G. Knepley                                    void (*obj)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
814194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
815194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
81630b9ff8bSMatthew G. Knepley                                                PetscReal t, const PetscReal x[], PetscScalar obj[]))
8172764a2aaSMatthew G. Knepley {
8182764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
8192764a2aaSMatthew G. Knepley 
8202764a2aaSMatthew G. Knepley   PetscFunctionBegin;
8212764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
822de716cbcSToby Isaac   if (obj) PetscValidFunction(obj, 2);
8232764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
8242764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
8252764a2aaSMatthew G. Knepley   prob->obj[f] = obj;
8262764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
8272764a2aaSMatthew G. Knepley }
8282764a2aaSMatthew G. Knepley 
829194d53e6SMatthew G. Knepley /*@C
830194d53e6SMatthew G. Knepley   PetscDSGetResidual - Get the pointwise residual function for a given test field
831194d53e6SMatthew G. Knepley 
832194d53e6SMatthew G. Knepley   Not collective
833194d53e6SMatthew G. Knepley 
834194d53e6SMatthew G. Knepley   Input Parameters:
835194d53e6SMatthew G. Knepley + prob - The PetscDS
836194d53e6SMatthew G. Knepley - f    - The test field number
837194d53e6SMatthew G. Knepley 
838194d53e6SMatthew G. Knepley   Output Parameters:
839194d53e6SMatthew G. Knepley + f0 - integrand for the test function term
840194d53e6SMatthew G. Knepley - f1 - integrand for the test function gradient term
841194d53e6SMatthew G. Knepley 
842194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
843194d53e6SMatthew G. Knepley 
844194d53e6SMatthew 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)
845194d53e6SMatthew G. Knepley 
846194d53e6SMatthew G. Knepley The calling sequence for the callbacks f0 and f1 is given by:
847194d53e6SMatthew G. Knepley 
84830b9ff8bSMatthew G. Knepley $ f0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
849194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
850194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
85130b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], PetscScalar f0[])
852194d53e6SMatthew G. Knepley 
853194d53e6SMatthew G. Knepley + dim - the spatial dimension
854194d53e6SMatthew G. Knepley . Nf - the number of fields
855194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
856194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
857194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
858194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
859194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
860194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
861194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
862194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
863194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
864194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
865194d53e6SMatthew G. Knepley . t - current time
866194d53e6SMatthew G. Knepley . x - coordinates of the current point
867194d53e6SMatthew G. Knepley - f0 - output values at the current point
868194d53e6SMatthew G. Knepley 
869194d53e6SMatthew G. Knepley   Level: intermediate
870194d53e6SMatthew G. Knepley 
871194d53e6SMatthew G. Knepley .seealso: PetscDSSetResidual()
872194d53e6SMatthew G. Knepley @*/
8732764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetResidual(PetscDS prob, PetscInt f,
87430b9ff8bSMatthew G. Knepley                                   void (**f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
875194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
876194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
87730b9ff8bSMatthew G. Knepley                                               PetscReal t, const PetscReal x[], PetscScalar f0[]),
87830b9ff8bSMatthew G. Knepley                                   void (**f1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
879194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
880194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
88130b9ff8bSMatthew G. Knepley                                               PetscReal t, const PetscReal x[], PetscScalar f1[]))
8822764a2aaSMatthew G. Knepley {
8832764a2aaSMatthew G. Knepley   PetscFunctionBegin;
8842764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
8852764a2aaSMatthew 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);
8862764a2aaSMatthew G. Knepley   if (f0) {PetscValidPointer(f0, 3); *f0 = prob->f[f*2+0];}
8872764a2aaSMatthew G. Knepley   if (f1) {PetscValidPointer(f1, 4); *f1 = prob->f[f*2+1];}
8882764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
8892764a2aaSMatthew G. Knepley }
8902764a2aaSMatthew G. Knepley 
891194d53e6SMatthew G. Knepley /*@C
892194d53e6SMatthew G. Knepley   PetscDSSetResidual - Set the pointwise residual function for a given test field
893194d53e6SMatthew G. Knepley 
894194d53e6SMatthew G. Knepley   Not collective
895194d53e6SMatthew G. Knepley 
896194d53e6SMatthew G. Knepley   Input Parameters:
897194d53e6SMatthew G. Knepley + prob - The PetscDS
898194d53e6SMatthew G. Knepley . f    - The test field number
899194d53e6SMatthew G. Knepley . f0 - integrand for the test function term
900194d53e6SMatthew G. Knepley - f1 - integrand for the test function gradient term
901194d53e6SMatthew G. Knepley 
902194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
903194d53e6SMatthew G. Knepley 
904194d53e6SMatthew 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)
905194d53e6SMatthew G. Knepley 
906194d53e6SMatthew G. Knepley The calling sequence for the callbacks f0 and f1 is given by:
907194d53e6SMatthew G. Knepley 
90830b9ff8bSMatthew G. Knepley $ f0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
909194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
910194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
91130b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], PetscScalar f0[])
912194d53e6SMatthew G. Knepley 
913194d53e6SMatthew G. Knepley + dim - the spatial dimension
914194d53e6SMatthew G. Knepley . Nf - the number of fields
915194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
916194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
917194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
918194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
919194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
920194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
921194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
922194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
923194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
924194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
925194d53e6SMatthew G. Knepley . t - current time
926194d53e6SMatthew G. Knepley . x - coordinates of the current point
927194d53e6SMatthew G. Knepley - f0 - output values at the current point
928194d53e6SMatthew G. Knepley 
929194d53e6SMatthew G. Knepley   Level: intermediate
930194d53e6SMatthew G. Knepley 
931194d53e6SMatthew G. Knepley .seealso: PetscDSGetResidual()
932194d53e6SMatthew G. Knepley @*/
9332764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetResidual(PetscDS prob, PetscInt f,
93430b9ff8bSMatthew G. Knepley                                   void (*f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
935194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
936194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
93730b9ff8bSMatthew G. Knepley                                              PetscReal t, const PetscReal x[], PetscScalar f0[]),
93830b9ff8bSMatthew G. Knepley                                   void (*f1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
939194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
940194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
94130b9ff8bSMatthew G. Knepley                                              PetscReal t, const PetscReal x[], PetscScalar f1[]))
9422764a2aaSMatthew G. Knepley {
9432764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
9442764a2aaSMatthew G. Knepley 
9452764a2aaSMatthew G. Knepley   PetscFunctionBegin;
9462764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
947f866a1d0SMatthew G. Knepley   if (f0) PetscValidFunction(f0, 3);
948f866a1d0SMatthew G. Knepley   if (f1) PetscValidFunction(f1, 4);
9492764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
9502764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
9512764a2aaSMatthew G. Knepley   prob->f[f*2+0] = f0;
9522764a2aaSMatthew G. Knepley   prob->f[f*2+1] = f1;
9532764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
9542764a2aaSMatthew G. Knepley }
9552764a2aaSMatthew G. Knepley 
9563e75805dSMatthew G. Knepley /*@C
9573e75805dSMatthew G. Knepley   PetscDSHasJacobian - Signals that Jacobian functions have been set
9583e75805dSMatthew G. Knepley 
9593e75805dSMatthew G. Knepley   Not collective
9603e75805dSMatthew G. Knepley 
9613e75805dSMatthew G. Knepley   Input Parameter:
9623e75805dSMatthew G. Knepley . prob - The PetscDS
9633e75805dSMatthew G. Knepley 
9643e75805dSMatthew G. Knepley   Output Parameter:
9653e75805dSMatthew G. Knepley . hasJac - flag that pointwise function for the Jacobian has been set
9663e75805dSMatthew G. Knepley 
9673e75805dSMatthew G. Knepley   Level: intermediate
9683e75805dSMatthew G. Knepley 
9693e75805dSMatthew G. Knepley .seealso: PetscDSGetJacobianPreconditioner(), PetscDSSetJacobianPreconditioner(), PetscDSGetJacobian()
9703e75805dSMatthew G. Knepley @*/
9713e75805dSMatthew G. Knepley PetscErrorCode PetscDSHasJacobian(PetscDS prob, PetscBool *hasJac)
9723e75805dSMatthew G. Knepley {
9733e75805dSMatthew G. Knepley   PetscInt f, g, h;
9743e75805dSMatthew G. Knepley 
9753e75805dSMatthew G. Knepley   PetscFunctionBegin;
9763e75805dSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
9773e75805dSMatthew G. Knepley   *hasJac = PETSC_FALSE;
9783e75805dSMatthew G. Knepley   for (f = 0; f < prob->Nf; ++f) {
9793e75805dSMatthew G. Knepley     for (g = 0; g < prob->Nf; ++g) {
9803e75805dSMatthew G. Knepley       for (h = 0; h < 4; ++h) {
9813e75805dSMatthew G. Knepley         if (prob->g[(f*prob->Nf + g)*4+h]) *hasJac = PETSC_TRUE;
9823e75805dSMatthew G. Knepley       }
9833e75805dSMatthew G. Knepley     }
9843e75805dSMatthew G. Knepley   }
9853e75805dSMatthew G. Knepley   PetscFunctionReturn(0);
9863e75805dSMatthew G. Knepley }
9873e75805dSMatthew G. Knepley 
988194d53e6SMatthew G. Knepley /*@C
989194d53e6SMatthew G. Knepley   PetscDSGetJacobian - Get the pointwise Jacobian function for given test and basis field
990194d53e6SMatthew G. Knepley 
991194d53e6SMatthew G. Knepley   Not collective
992194d53e6SMatthew G. Knepley 
993194d53e6SMatthew G. Knepley   Input Parameters:
994194d53e6SMatthew G. Knepley + prob - The PetscDS
995194d53e6SMatthew G. Knepley . f    - The test field number
996194d53e6SMatthew G. Knepley - g    - The field number
997194d53e6SMatthew G. Knepley 
998194d53e6SMatthew G. Knepley   Output Parameters:
999194d53e6SMatthew G. Knepley + g0 - integrand for the test and basis function term
1000194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1001194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1002194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1003194d53e6SMatthew G. Knepley 
1004194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1005194d53e6SMatthew G. Knepley 
1006194d53e6SMatthew 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
1007194d53e6SMatthew G. Knepley 
1008194d53e6SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1009194d53e6SMatthew G. Knepley 
101030b9ff8bSMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1011194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1012194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
101330b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal u_tShift, const PetscReal x[], PetscScalar g0[])
1014194d53e6SMatthew G. Knepley 
1015194d53e6SMatthew G. Knepley + dim - the spatial dimension
1016194d53e6SMatthew G. Knepley . Nf - the number of fields
1017194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1018194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1019194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
1020194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1021194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1022194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1023194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1024194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1025194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1026194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1027194d53e6SMatthew G. Knepley . t - current time
10282aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1029194d53e6SMatthew G. Knepley . x - coordinates of the current point
1030194d53e6SMatthew G. Knepley - g0 - output values at the current point
1031194d53e6SMatthew G. Knepley 
1032194d53e6SMatthew G. Knepley   Level: intermediate
1033194d53e6SMatthew G. Knepley 
1034194d53e6SMatthew G. Knepley .seealso: PetscDSSetJacobian()
1035194d53e6SMatthew G. Knepley @*/
10362764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetJacobian(PetscDS prob, PetscInt f, PetscInt g,
103730b9ff8bSMatthew G. Knepley                                   void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1038194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1039194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
10402aa1fc23SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g0[]),
104130b9ff8bSMatthew G. Knepley                                   void (**g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1042194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1043194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
10442aa1fc23SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g1[]),
104530b9ff8bSMatthew G. Knepley                                   void (**g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1046194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1047194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
10482aa1fc23SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g2[]),
104930b9ff8bSMatthew G. Knepley                                   void (**g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1050194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1051194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
10522aa1fc23SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g3[]))
10532764a2aaSMatthew G. Knepley {
10542764a2aaSMatthew G. Knepley   PetscFunctionBegin;
10552764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
10562764a2aaSMatthew 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);
10572764a2aaSMatthew 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);
10582764a2aaSMatthew G. Knepley   if (g0) {PetscValidPointer(g0, 4); *g0 = prob->g[(f*prob->Nf + g)*4+0];}
10592764a2aaSMatthew G. Knepley   if (g1) {PetscValidPointer(g1, 5); *g1 = prob->g[(f*prob->Nf + g)*4+1];}
10602764a2aaSMatthew G. Knepley   if (g2) {PetscValidPointer(g2, 6); *g2 = prob->g[(f*prob->Nf + g)*4+2];}
10612764a2aaSMatthew G. Knepley   if (g3) {PetscValidPointer(g3, 7); *g3 = prob->g[(f*prob->Nf + g)*4+3];}
10622764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
10632764a2aaSMatthew G. Knepley }
10642764a2aaSMatthew G. Knepley 
1065194d53e6SMatthew G. Knepley /*@C
1066194d53e6SMatthew G. Knepley   PetscDSSetJacobian - Set the pointwise Jacobian function for given test and basis fields
1067194d53e6SMatthew G. Knepley 
1068194d53e6SMatthew G. Knepley   Not collective
1069194d53e6SMatthew G. Knepley 
1070194d53e6SMatthew G. Knepley   Input Parameters:
1071194d53e6SMatthew G. Knepley + prob - The PetscDS
1072194d53e6SMatthew G. Knepley . f    - The test field number
1073194d53e6SMatthew G. Knepley . g    - The field number
1074194d53e6SMatthew G. Knepley . g0 - integrand for the test and basis function term
1075194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1076194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1077194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1078194d53e6SMatthew G. Knepley 
1079194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1080194d53e6SMatthew G. Knepley 
1081194d53e6SMatthew 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
1082194d53e6SMatthew G. Knepley 
1083194d53e6SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1084194d53e6SMatthew G. Knepley 
108530b9ff8bSMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1086194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1087194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
108830b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], PetscScalar g0[])
1089194d53e6SMatthew G. Knepley 
1090194d53e6SMatthew G. Knepley + dim - the spatial dimension
1091194d53e6SMatthew G. Knepley . Nf - the number of fields
1092194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1093194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1094194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
1095194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1096194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1097194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1098194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1099194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1100194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1101194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1102194d53e6SMatthew G. Knepley . t - current time
11032aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1104194d53e6SMatthew G. Knepley . x - coordinates of the current point
1105194d53e6SMatthew G. Knepley - g0 - output values at the current point
1106194d53e6SMatthew G. Knepley 
1107194d53e6SMatthew G. Knepley   Level: intermediate
1108194d53e6SMatthew G. Knepley 
1109194d53e6SMatthew G. Knepley .seealso: PetscDSGetJacobian()
1110194d53e6SMatthew G. Knepley @*/
11112764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetJacobian(PetscDS prob, PetscInt f, PetscInt g,
111230b9ff8bSMatthew G. Knepley                                   void (*g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1113194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1114194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
111530b9ff8bSMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g0[]),
111630b9ff8bSMatthew G. Knepley                                   void (*g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1117194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1118194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
111930b9ff8bSMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g1[]),
112030b9ff8bSMatthew G. Knepley                                   void (*g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1121194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1122194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
112330b9ff8bSMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g2[]),
112430b9ff8bSMatthew G. Knepley                                   void (*g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1125194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1126194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
112730b9ff8bSMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g3[]))
11282764a2aaSMatthew G. Knepley {
11292764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
11302764a2aaSMatthew G. Knepley 
11312764a2aaSMatthew G. Knepley   PetscFunctionBegin;
11322764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
11332764a2aaSMatthew G. Knepley   if (g0) PetscValidFunction(g0, 4);
11342764a2aaSMatthew G. Knepley   if (g1) PetscValidFunction(g1, 5);
11352764a2aaSMatthew G. Knepley   if (g2) PetscValidFunction(g2, 6);
11362764a2aaSMatthew G. Knepley   if (g3) PetscValidFunction(g3, 7);
11372764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
11382764a2aaSMatthew G. Knepley   if (g < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", g);
11392764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, PetscMax(f, g)+1);CHKERRQ(ierr);
11402764a2aaSMatthew G. Knepley   prob->g[(f*prob->Nf + g)*4+0] = g0;
11412764a2aaSMatthew G. Knepley   prob->g[(f*prob->Nf + g)*4+1] = g1;
11422764a2aaSMatthew G. Knepley   prob->g[(f*prob->Nf + g)*4+2] = g2;
11432764a2aaSMatthew G. Knepley   prob->g[(f*prob->Nf + g)*4+3] = g3;
11442764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
11452764a2aaSMatthew G. Knepley }
11462764a2aaSMatthew G. Knepley 
1147475e0ac9SMatthew G. Knepley /*@C
1148475e0ac9SMatthew G. Knepley   PetscDSHasJacobianPreconditioner - Signals that a Jacobian preconditioner matrix has been set
1149475e0ac9SMatthew G. Knepley 
1150475e0ac9SMatthew G. Knepley   Not collective
1151475e0ac9SMatthew G. Knepley 
1152475e0ac9SMatthew G. Knepley   Input Parameter:
1153475e0ac9SMatthew G. Knepley . prob - The PetscDS
1154475e0ac9SMatthew G. Knepley 
1155475e0ac9SMatthew G. Knepley   Output Parameter:
1156475e0ac9SMatthew G. Knepley . hasJacPre - flag that pointwise function for Jacobian preconditioner matrix has been set
1157475e0ac9SMatthew G. Knepley 
1158475e0ac9SMatthew G. Knepley   Level: intermediate
1159475e0ac9SMatthew G. Knepley 
1160475e0ac9SMatthew G. Knepley .seealso: PetscDSGetJacobianPreconditioner(), PetscDSSetJacobianPreconditioner(), PetscDSGetJacobian()
1161475e0ac9SMatthew G. Knepley @*/
1162475e0ac9SMatthew G. Knepley PetscErrorCode PetscDSHasJacobianPreconditioner(PetscDS prob, PetscBool *hasJacPre)
1163475e0ac9SMatthew G. Knepley {
1164475e0ac9SMatthew G. Knepley   PetscInt f, g, h;
1165475e0ac9SMatthew G. Knepley 
1166475e0ac9SMatthew G. Knepley   PetscFunctionBegin;
1167475e0ac9SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1168475e0ac9SMatthew G. Knepley   *hasJacPre = PETSC_FALSE;
1169475e0ac9SMatthew G. Knepley   for (f = 0; f < prob->Nf; ++f) {
1170475e0ac9SMatthew G. Knepley     for (g = 0; g < prob->Nf; ++g) {
1171475e0ac9SMatthew G. Knepley       for (h = 0; h < 4; ++h) {
1172475e0ac9SMatthew G. Knepley         if (prob->gp[(f*prob->Nf + g)*4+h]) *hasJacPre = PETSC_TRUE;
1173475e0ac9SMatthew G. Knepley       }
1174475e0ac9SMatthew G. Knepley     }
1175475e0ac9SMatthew G. Knepley   }
1176475e0ac9SMatthew G. Knepley   PetscFunctionReturn(0);
1177475e0ac9SMatthew G. Knepley }
1178475e0ac9SMatthew G. Knepley 
1179475e0ac9SMatthew G. Knepley /*@C
1180475e0ac9SMatthew 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.
1181475e0ac9SMatthew G. Knepley 
1182475e0ac9SMatthew G. Knepley   Not collective
1183475e0ac9SMatthew G. Knepley 
1184475e0ac9SMatthew G. Knepley   Input Parameters:
1185475e0ac9SMatthew G. Knepley + prob - The PetscDS
1186475e0ac9SMatthew G. Knepley . f    - The test field number
1187475e0ac9SMatthew G. Knepley - g    - The field number
1188475e0ac9SMatthew G. Knepley 
1189475e0ac9SMatthew G. Knepley   Output Parameters:
1190475e0ac9SMatthew G. Knepley + g0 - integrand for the test and basis function term
1191475e0ac9SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1192475e0ac9SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1193475e0ac9SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1194475e0ac9SMatthew G. Knepley 
1195475e0ac9SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1196475e0ac9SMatthew G. Knepley 
1197475e0ac9SMatthew 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
1198475e0ac9SMatthew G. Knepley 
1199475e0ac9SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1200475e0ac9SMatthew G. Knepley 
1201475e0ac9SMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1202475e0ac9SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1203475e0ac9SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1204475e0ac9SMatthew G. Knepley $    PetscReal t, const PetscReal u_tShift, const PetscReal x[], PetscScalar g0[])
1205475e0ac9SMatthew G. Knepley 
1206475e0ac9SMatthew G. Knepley + dim - the spatial dimension
1207475e0ac9SMatthew G. Knepley . Nf - the number of fields
1208475e0ac9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1209475e0ac9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1210475e0ac9SMatthew G. Knepley . u - each field evaluated at the current point
1211475e0ac9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1212475e0ac9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1213475e0ac9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1214475e0ac9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1215475e0ac9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1216475e0ac9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1217475e0ac9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1218475e0ac9SMatthew G. Knepley . t - current time
1219475e0ac9SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1220475e0ac9SMatthew G. Knepley . x - coordinates of the current point
1221475e0ac9SMatthew G. Knepley - g0 - output values at the current point
1222475e0ac9SMatthew G. Knepley 
1223475e0ac9SMatthew G. Knepley   Level: intermediate
1224475e0ac9SMatthew G. Knepley 
1225475e0ac9SMatthew G. Knepley .seealso: PetscDSSetJacobianPreconditioner(), PetscDSGetJacobian()
1226475e0ac9SMatthew G. Knepley @*/
1227475e0ac9SMatthew G. Knepley PetscErrorCode PetscDSGetJacobianPreconditioner(PetscDS prob, PetscInt f, PetscInt g,
1228475e0ac9SMatthew G. Knepley                                   void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1229475e0ac9SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1230475e0ac9SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1231475e0ac9SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g0[]),
1232475e0ac9SMatthew G. Knepley                                   void (**g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1233475e0ac9SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1234475e0ac9SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1235475e0ac9SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g1[]),
1236475e0ac9SMatthew G. Knepley                                   void (**g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1237475e0ac9SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1238475e0ac9SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1239475e0ac9SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g2[]),
1240475e0ac9SMatthew G. Knepley                                   void (**g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1241475e0ac9SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1242475e0ac9SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1243475e0ac9SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g3[]))
1244475e0ac9SMatthew G. Knepley {
1245475e0ac9SMatthew G. Knepley   PetscFunctionBegin;
1246475e0ac9SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1247475e0ac9SMatthew 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);
1248475e0ac9SMatthew 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);
1249475e0ac9SMatthew G. Knepley   if (g0) {PetscValidPointer(g0, 4); *g0 = prob->gp[(f*prob->Nf + g)*4+0];}
1250475e0ac9SMatthew G. Knepley   if (g1) {PetscValidPointer(g1, 5); *g1 = prob->gp[(f*prob->Nf + g)*4+1];}
1251475e0ac9SMatthew G. Knepley   if (g2) {PetscValidPointer(g2, 6); *g2 = prob->gp[(f*prob->Nf + g)*4+2];}
1252475e0ac9SMatthew G. Knepley   if (g3) {PetscValidPointer(g3, 7); *g3 = prob->gp[(f*prob->Nf + g)*4+3];}
1253475e0ac9SMatthew G. Knepley   PetscFunctionReturn(0);
1254475e0ac9SMatthew G. Knepley }
1255475e0ac9SMatthew G. Knepley 
1256475e0ac9SMatthew G. Knepley /*@C
1257475e0ac9SMatthew 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.
1258475e0ac9SMatthew G. Knepley 
1259475e0ac9SMatthew G. Knepley   Not collective
1260475e0ac9SMatthew G. Knepley 
1261475e0ac9SMatthew G. Knepley   Input Parameters:
1262475e0ac9SMatthew G. Knepley + prob - The PetscDS
1263475e0ac9SMatthew G. Knepley . f    - The test field number
1264475e0ac9SMatthew G. Knepley . g    - The field number
1265475e0ac9SMatthew G. Knepley . g0 - integrand for the test and basis function term
1266475e0ac9SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1267475e0ac9SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1268475e0ac9SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1269475e0ac9SMatthew G. Knepley 
1270475e0ac9SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1271475e0ac9SMatthew G. Knepley 
1272475e0ac9SMatthew 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
1273475e0ac9SMatthew G. Knepley 
1274475e0ac9SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1275475e0ac9SMatthew G. Knepley 
1276475e0ac9SMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1277475e0ac9SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1278475e0ac9SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1279475e0ac9SMatthew G. Knepley $    PetscReal t, const PetscReal x[], PetscScalar g0[])
1280475e0ac9SMatthew G. Knepley 
1281475e0ac9SMatthew G. Knepley + dim - the spatial dimension
1282475e0ac9SMatthew G. Knepley . Nf - the number of fields
1283475e0ac9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1284475e0ac9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1285475e0ac9SMatthew G. Knepley . u - each field evaluated at the current point
1286475e0ac9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1287475e0ac9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1288475e0ac9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1289475e0ac9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1290475e0ac9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1291475e0ac9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1292475e0ac9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1293475e0ac9SMatthew G. Knepley . t - current time
1294475e0ac9SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1295475e0ac9SMatthew G. Knepley . x - coordinates of the current point
1296475e0ac9SMatthew G. Knepley - g0 - output values at the current point
1297475e0ac9SMatthew G. Knepley 
1298475e0ac9SMatthew G. Knepley   Level: intermediate
1299475e0ac9SMatthew G. Knepley 
1300475e0ac9SMatthew G. Knepley .seealso: PetscDSGetJacobianPreconditioner(), PetscDSSetJacobian()
1301475e0ac9SMatthew G. Knepley @*/
1302475e0ac9SMatthew G. Knepley PetscErrorCode PetscDSSetJacobianPreconditioner(PetscDS prob, PetscInt f, PetscInt g,
1303475e0ac9SMatthew G. Knepley                                   void (*g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1304475e0ac9SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1305475e0ac9SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1306475e0ac9SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g0[]),
1307475e0ac9SMatthew G. Knepley                                   void (*g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1308475e0ac9SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1309475e0ac9SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1310475e0ac9SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g1[]),
1311475e0ac9SMatthew G. Knepley                                   void (*g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1312475e0ac9SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1313475e0ac9SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1314475e0ac9SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g2[]),
1315475e0ac9SMatthew G. Knepley                                   void (*g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1316475e0ac9SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1317475e0ac9SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1318475e0ac9SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g3[]))
1319475e0ac9SMatthew G. Knepley {
1320475e0ac9SMatthew G. Knepley   PetscErrorCode ierr;
1321475e0ac9SMatthew G. Knepley 
1322475e0ac9SMatthew G. Knepley   PetscFunctionBegin;
1323475e0ac9SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1324475e0ac9SMatthew G. Knepley   if (g0) PetscValidFunction(g0, 4);
1325475e0ac9SMatthew G. Knepley   if (g1) PetscValidFunction(g1, 5);
1326475e0ac9SMatthew G. Knepley   if (g2) PetscValidFunction(g2, 6);
1327475e0ac9SMatthew G. Knepley   if (g3) PetscValidFunction(g3, 7);
1328475e0ac9SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
1329475e0ac9SMatthew G. Knepley   if (g < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", g);
1330475e0ac9SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, PetscMax(f, g)+1);CHKERRQ(ierr);
1331475e0ac9SMatthew G. Knepley   prob->gp[(f*prob->Nf + g)*4+0] = g0;
1332475e0ac9SMatthew G. Knepley   prob->gp[(f*prob->Nf + g)*4+1] = g1;
1333475e0ac9SMatthew G. Knepley   prob->gp[(f*prob->Nf + g)*4+2] = g2;
1334475e0ac9SMatthew G. Knepley   prob->gp[(f*prob->Nf + g)*4+3] = g3;
1335475e0ac9SMatthew G. Knepley   PetscFunctionReturn(0);
1336475e0ac9SMatthew G. Knepley }
1337475e0ac9SMatthew G. Knepley 
1338b7e05686SMatthew G. Knepley /*@C
1339b7e05686SMatthew G. Knepley   PetscDSHasDynamicJacobian - Signals that a dynamic Jacobian, dF/du_t, has been set
1340b7e05686SMatthew G. Knepley 
1341b7e05686SMatthew G. Knepley   Not collective
1342b7e05686SMatthew G. Knepley 
1343b7e05686SMatthew G. Knepley   Input Parameter:
1344b7e05686SMatthew G. Knepley . prob - The PetscDS
1345b7e05686SMatthew G. Knepley 
1346b7e05686SMatthew G. Knepley   Output Parameter:
1347b7e05686SMatthew G. Knepley . hasDynJac - flag that pointwise function for dynamic Jacobian has been set
1348b7e05686SMatthew G. Knepley 
1349b7e05686SMatthew G. Knepley   Level: intermediate
1350b7e05686SMatthew G. Knepley 
1351b7e05686SMatthew G. Knepley .seealso: PetscDSGetDynamicJacobian(), PetscDSSetDynamicJacobian(), PetscDSGetJacobian()
1352b7e05686SMatthew G. Knepley @*/
1353b7e05686SMatthew G. Knepley PetscErrorCode PetscDSHasDynamicJacobian(PetscDS prob, PetscBool *hasDynJac)
1354b7e05686SMatthew G. Knepley {
1355b7e05686SMatthew G. Knepley   PetscInt f, g, h;
1356b7e05686SMatthew G. Knepley 
1357b7e05686SMatthew G. Knepley   PetscFunctionBegin;
1358b7e05686SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1359b7e05686SMatthew G. Knepley   *hasDynJac = PETSC_FALSE;
1360b7e05686SMatthew G. Knepley   for (f = 0; f < prob->Nf; ++f) {
1361b7e05686SMatthew G. Knepley     for (g = 0; g < prob->Nf; ++g) {
1362b7e05686SMatthew G. Knepley       for (h = 0; h < 4; ++h) {
1363b7e05686SMatthew G. Knepley         if (prob->gt[(f*prob->Nf + g)*4+h]) *hasDynJac = PETSC_TRUE;
1364b7e05686SMatthew G. Knepley       }
1365b7e05686SMatthew G. Knepley     }
1366b7e05686SMatthew G. Knepley   }
1367b7e05686SMatthew G. Knepley   PetscFunctionReturn(0);
1368b7e05686SMatthew G. Knepley }
1369b7e05686SMatthew G. Knepley 
1370b7e05686SMatthew G. Knepley /*@C
1371b7e05686SMatthew G. Knepley   PetscDSGetDynamicJacobian - Get the pointwise dynamic Jacobian, dF/du_t, function for given test and basis field
1372b7e05686SMatthew G. Knepley 
1373b7e05686SMatthew G. Knepley   Not collective
1374b7e05686SMatthew G. Knepley 
1375b7e05686SMatthew G. Knepley   Input Parameters:
1376b7e05686SMatthew G. Knepley + prob - The PetscDS
1377b7e05686SMatthew G. Knepley . f    - The test field number
1378b7e05686SMatthew G. Knepley - g    - The field number
1379b7e05686SMatthew G. Knepley 
1380b7e05686SMatthew G. Knepley   Output Parameters:
1381b7e05686SMatthew G. Knepley + g0 - integrand for the test and basis function term
1382b7e05686SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1383b7e05686SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1384b7e05686SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1385b7e05686SMatthew G. Knepley 
1386b7e05686SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1387b7e05686SMatthew G. Knepley 
1388b7e05686SMatthew 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
1389b7e05686SMatthew G. Knepley 
1390b7e05686SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1391b7e05686SMatthew G. Knepley 
1392b7e05686SMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1393b7e05686SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1394b7e05686SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1395b7e05686SMatthew G. Knepley $    PetscReal t, const PetscReal u_tShift, const PetscReal x[], PetscScalar g0[])
1396b7e05686SMatthew G. Knepley 
1397b7e05686SMatthew G. Knepley + dim - the spatial dimension
1398b7e05686SMatthew G. Knepley . Nf - the number of fields
1399b7e05686SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1400b7e05686SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1401b7e05686SMatthew G. Knepley . u - each field evaluated at the current point
1402b7e05686SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1403b7e05686SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1404b7e05686SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1405b7e05686SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1406b7e05686SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1407b7e05686SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1408b7e05686SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1409b7e05686SMatthew G. Knepley . t - current time
1410b7e05686SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1411b7e05686SMatthew G. Knepley . x - coordinates of the current point
1412b7e05686SMatthew G. Knepley - g0 - output values at the current point
1413b7e05686SMatthew G. Knepley 
1414b7e05686SMatthew G. Knepley   Level: intermediate
1415b7e05686SMatthew G. Knepley 
1416b7e05686SMatthew G. Knepley .seealso: PetscDSSetJacobian()
1417b7e05686SMatthew G. Knepley @*/
1418b7e05686SMatthew G. Knepley PetscErrorCode PetscDSGetDynamicJacobian(PetscDS prob, PetscInt f, PetscInt g,
1419b7e05686SMatthew G. Knepley                                          void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1420b7e05686SMatthew G. Knepley                                                      const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1421b7e05686SMatthew G. Knepley                                                      const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1422b7e05686SMatthew G. Knepley                                                      PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g0[]),
1423b7e05686SMatthew G. Knepley                                          void (**g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1424b7e05686SMatthew G. Knepley                                                      const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1425b7e05686SMatthew G. Knepley                                                      const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1426b7e05686SMatthew G. Knepley                                                      PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g1[]),
1427b7e05686SMatthew G. Knepley                                          void (**g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1428b7e05686SMatthew G. Knepley                                                      const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1429b7e05686SMatthew G. Knepley                                                      const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1430b7e05686SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g2[]),
1431b7e05686SMatthew G. Knepley                                          void (**g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1432b7e05686SMatthew G. Knepley                                                      const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1433b7e05686SMatthew G. Knepley                                                      const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1434b7e05686SMatthew G. Knepley                                                      PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g3[]))
1435b7e05686SMatthew G. Knepley {
1436b7e05686SMatthew G. Knepley   PetscFunctionBegin;
1437b7e05686SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1438b7e05686SMatthew 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);
1439b7e05686SMatthew 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);
1440b7e05686SMatthew G. Knepley   if (g0) {PetscValidPointer(g0, 4); *g0 = prob->gt[(f*prob->Nf + g)*4+0];}
1441b7e05686SMatthew G. Knepley   if (g1) {PetscValidPointer(g1, 5); *g1 = prob->gt[(f*prob->Nf + g)*4+1];}
1442b7e05686SMatthew G. Knepley   if (g2) {PetscValidPointer(g2, 6); *g2 = prob->gt[(f*prob->Nf + g)*4+2];}
1443b7e05686SMatthew G. Knepley   if (g3) {PetscValidPointer(g3, 7); *g3 = prob->gt[(f*prob->Nf + g)*4+3];}
1444b7e05686SMatthew G. Knepley   PetscFunctionReturn(0);
1445b7e05686SMatthew G. Knepley }
1446b7e05686SMatthew G. Knepley 
1447b7e05686SMatthew G. Knepley /*@C
1448b7e05686SMatthew G. Knepley   PetscDSSetDynamicJacobian - Set the pointwise dynamic Jacobian, dF/du_t, function for given test and basis fields
1449b7e05686SMatthew G. Knepley 
1450b7e05686SMatthew G. Knepley   Not collective
1451b7e05686SMatthew G. Knepley 
1452b7e05686SMatthew G. Knepley   Input Parameters:
1453b7e05686SMatthew G. Knepley + prob - The PetscDS
1454b7e05686SMatthew G. Knepley . f    - The test field number
1455b7e05686SMatthew G. Knepley . g    - The field number
1456b7e05686SMatthew G. Knepley . g0 - integrand for the test and basis function term
1457b7e05686SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1458b7e05686SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1459b7e05686SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1460b7e05686SMatthew G. Knepley 
1461b7e05686SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1462b7e05686SMatthew G. Knepley 
1463b7e05686SMatthew 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
1464b7e05686SMatthew G. Knepley 
1465b7e05686SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1466b7e05686SMatthew G. Knepley 
1467b7e05686SMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1468b7e05686SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1469b7e05686SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1470b7e05686SMatthew G. Knepley $    PetscReal t, const PetscReal x[], PetscScalar g0[])
1471b7e05686SMatthew G. Knepley 
1472b7e05686SMatthew G. Knepley + dim - the spatial dimension
1473b7e05686SMatthew G. Knepley . Nf - the number of fields
1474b7e05686SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1475b7e05686SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1476b7e05686SMatthew G. Knepley . u - each field evaluated at the current point
1477b7e05686SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1478b7e05686SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1479b7e05686SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1480b7e05686SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1481b7e05686SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1482b7e05686SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1483b7e05686SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1484b7e05686SMatthew G. Knepley . t - current time
1485b7e05686SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1486b7e05686SMatthew G. Knepley . x - coordinates of the current point
1487b7e05686SMatthew G. Knepley - g0 - output values at the current point
1488b7e05686SMatthew G. Knepley 
1489b7e05686SMatthew G. Knepley   Level: intermediate
1490b7e05686SMatthew G. Knepley 
1491b7e05686SMatthew G. Knepley .seealso: PetscDSGetJacobian()
1492b7e05686SMatthew G. Knepley @*/
1493b7e05686SMatthew G. Knepley PetscErrorCode PetscDSSetDynamicJacobian(PetscDS prob, PetscInt f, PetscInt g,
1494b7e05686SMatthew G. Knepley                                          void (*g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1495b7e05686SMatthew G. Knepley                                                     const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1496b7e05686SMatthew G. Knepley                                                     const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1497b7e05686SMatthew G. Knepley                                                     PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g0[]),
1498b7e05686SMatthew G. Knepley                                          void (*g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1499b7e05686SMatthew G. Knepley                                                     const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1500b7e05686SMatthew G. Knepley                                                     const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1501b7e05686SMatthew G. Knepley                                                     PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g1[]),
1502b7e05686SMatthew G. Knepley                                          void (*g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1503b7e05686SMatthew G. Knepley                                                     const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1504b7e05686SMatthew G. Knepley                                                     const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1505b7e05686SMatthew G. Knepley                                                     PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g2[]),
1506b7e05686SMatthew G. Knepley                                          void (*g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1507b7e05686SMatthew G. Knepley                                                     const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1508b7e05686SMatthew G. Knepley                                                     const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1509b7e05686SMatthew G. Knepley                                                     PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscScalar g3[]))
1510b7e05686SMatthew G. Knepley {
1511b7e05686SMatthew G. Knepley   PetscErrorCode ierr;
1512b7e05686SMatthew G. Knepley 
1513b7e05686SMatthew G. Knepley   PetscFunctionBegin;
1514b7e05686SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1515b7e05686SMatthew G. Knepley   if (g0) PetscValidFunction(g0, 4);
1516b7e05686SMatthew G. Knepley   if (g1) PetscValidFunction(g1, 5);
1517b7e05686SMatthew G. Knepley   if (g2) PetscValidFunction(g2, 6);
1518b7e05686SMatthew G. Knepley   if (g3) PetscValidFunction(g3, 7);
1519b7e05686SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
1520b7e05686SMatthew G. Knepley   if (g < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", g);
1521b7e05686SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, PetscMax(f, g)+1);CHKERRQ(ierr);
1522b7e05686SMatthew G. Knepley   prob->gt[(f*prob->Nf + g)*4+0] = g0;
1523b7e05686SMatthew G. Knepley   prob->gt[(f*prob->Nf + g)*4+1] = g1;
1524b7e05686SMatthew G. Knepley   prob->gt[(f*prob->Nf + g)*4+2] = g2;
1525b7e05686SMatthew G. Knepley   prob->gt[(f*prob->Nf + g)*4+3] = g3;
1526b7e05686SMatthew G. Knepley   PetscFunctionReturn(0);
1527b7e05686SMatthew G. Knepley }
1528b7e05686SMatthew G. Knepley 
15290c2f2876SMatthew G. Knepley /*@C
15300c2f2876SMatthew G. Knepley   PetscDSGetRiemannSolver - Returns the Riemann solver for the given field
15310c2f2876SMatthew G. Knepley 
15320c2f2876SMatthew G. Knepley   Not collective
15330c2f2876SMatthew G. Knepley 
15340c2f2876SMatthew G. Knepley   Input Arguments:
15350c2f2876SMatthew G. Knepley + prob - The PetscDS object
15360c2f2876SMatthew G. Knepley - f    - The field number
15370c2f2876SMatthew G. Knepley 
15380c2f2876SMatthew G. Knepley   Output Argument:
15390c2f2876SMatthew G. Knepley . r    - Riemann solver
15400c2f2876SMatthew G. Knepley 
15410c2f2876SMatthew G. Knepley   Calling sequence for r:
15420c2f2876SMatthew G. Knepley 
15435db36cf9SMatthew G. Knepley $ r(PetscInt dim, PetscInt Nf, const PetscReal x[], const PetscReal n[], const PetscScalar uL[], const PetscScalar uR[], PetscScalar flux[], void *ctx)
15440c2f2876SMatthew G. Knepley 
15455db36cf9SMatthew G. Knepley + dim  - The spatial dimension
15465db36cf9SMatthew G. Knepley . Nf   - The number of fields
15475db36cf9SMatthew G. Knepley . x    - The coordinates at a point on the interface
15480c2f2876SMatthew G. Knepley . n    - The normal vector to the interface
15490c2f2876SMatthew G. Knepley . uL   - The state vector to the left of the interface
15500c2f2876SMatthew G. Knepley . uR   - The state vector to the right of the interface
15510c2f2876SMatthew G. Knepley . flux - output array of flux through the interface
15520c2f2876SMatthew G. Knepley - ctx  - optional user context
15530c2f2876SMatthew G. Knepley 
15540c2f2876SMatthew G. Knepley   Level: intermediate
15550c2f2876SMatthew G. Knepley 
15560c2f2876SMatthew G. Knepley .seealso: PetscDSSetRiemannSolver()
15570c2f2876SMatthew G. Knepley @*/
15580c2f2876SMatthew G. Knepley PetscErrorCode PetscDSGetRiemannSolver(PetscDS prob, PetscInt f,
15595db36cf9SMatthew G. Knepley                                        void (**r)(PetscInt dim, PetscInt Nf, const PetscReal x[], const PetscReal n[], const PetscScalar uL[], const PetscScalar uR[], PetscScalar flux[], void *ctx))
15600c2f2876SMatthew G. Knepley {
15610c2f2876SMatthew G. Knepley   PetscFunctionBegin;
15620c2f2876SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
15630c2f2876SMatthew 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);
15640c2f2876SMatthew G. Knepley   PetscValidPointer(r, 3);
15650c2f2876SMatthew G. Knepley   *r = prob->r[f];
15660c2f2876SMatthew G. Knepley   PetscFunctionReturn(0);
15670c2f2876SMatthew G. Knepley }
15680c2f2876SMatthew G. Knepley 
15690c2f2876SMatthew G. Knepley /*@C
15700c2f2876SMatthew G. Knepley   PetscDSSetRiemannSolver - Sets the Riemann solver for the given field
15710c2f2876SMatthew G. Knepley 
15720c2f2876SMatthew G. Knepley   Not collective
15730c2f2876SMatthew G. Knepley 
15740c2f2876SMatthew G. Knepley   Input Arguments:
15750c2f2876SMatthew G. Knepley + prob - The PetscDS object
15760c2f2876SMatthew G. Knepley . f    - The field number
15770c2f2876SMatthew G. Knepley - r    - Riemann solver
15780c2f2876SMatthew G. Knepley 
15790c2f2876SMatthew G. Knepley   Calling sequence for r:
15800c2f2876SMatthew G. Knepley 
15815db36cf9SMatthew G. Knepley $ r(PetscInt dim, PetscInt Nf, const PetscReal x[], const PetscReal n[], const PetscScalar uL[], const PetscScalar uR[], PetscScalar flux[], void *ctx)
15820c2f2876SMatthew G. Knepley 
15835db36cf9SMatthew G. Knepley + dim  - The spatial dimension
15845db36cf9SMatthew G. Knepley . Nf   - The number of fields
15855db36cf9SMatthew G. Knepley . x    - The coordinates at a point on the interface
15860c2f2876SMatthew G. Knepley . n    - The normal vector to the interface
15870c2f2876SMatthew G. Knepley . uL   - The state vector to the left of the interface
15880c2f2876SMatthew G. Knepley . uR   - The state vector to the right of the interface
15890c2f2876SMatthew G. Knepley . flux - output array of flux through the interface
15900c2f2876SMatthew G. Knepley - ctx  - optional user context
15910c2f2876SMatthew G. Knepley 
15920c2f2876SMatthew G. Knepley   Level: intermediate
15930c2f2876SMatthew G. Knepley 
15940c2f2876SMatthew G. Knepley .seealso: PetscDSGetRiemannSolver()
15950c2f2876SMatthew G. Knepley @*/
15960c2f2876SMatthew G. Knepley PetscErrorCode PetscDSSetRiemannSolver(PetscDS prob, PetscInt f,
15975db36cf9SMatthew G. Knepley                                        void (*r)(PetscInt dim, PetscInt Nf, const PetscReal x[], const PetscReal n[], const PetscScalar uL[], const PetscScalar uR[], PetscScalar flux[], void *ctx))
15980c2f2876SMatthew G. Knepley {
15990c2f2876SMatthew G. Knepley   PetscErrorCode ierr;
16000c2f2876SMatthew G. Knepley 
16010c2f2876SMatthew G. Knepley   PetscFunctionBegin;
16020c2f2876SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1603de716cbcSToby Isaac   if (r) PetscValidFunction(r, 3);
16040c2f2876SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
16050c2f2876SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
16060c2f2876SMatthew G. Knepley   prob->r[f] = r;
16070c2f2876SMatthew G. Knepley   PetscFunctionReturn(0);
16080c2f2876SMatthew G. Knepley }
16090c2f2876SMatthew G. Knepley 
16100c2f2876SMatthew G. Knepley PetscErrorCode PetscDSGetContext(PetscDS prob, PetscInt f, void **ctx)
16110c2f2876SMatthew G. Knepley {
16120c2f2876SMatthew G. Knepley   PetscFunctionBegin;
16130c2f2876SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
16140c2f2876SMatthew 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);
16150c2f2876SMatthew G. Knepley   PetscValidPointer(ctx, 3);
16160c2f2876SMatthew G. Knepley   *ctx = prob->ctx[f];
16170c2f2876SMatthew G. Knepley   PetscFunctionReturn(0);
16180c2f2876SMatthew G. Knepley }
16190c2f2876SMatthew G. Knepley 
16200c2f2876SMatthew G. Knepley PetscErrorCode PetscDSSetContext(PetscDS prob, PetscInt f, void *ctx)
16210c2f2876SMatthew G. Knepley {
16220c2f2876SMatthew G. Knepley   PetscErrorCode ierr;
16230c2f2876SMatthew G. Knepley 
16240c2f2876SMatthew G. Knepley   PetscFunctionBegin;
16250c2f2876SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
16260c2f2876SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
16270c2f2876SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
16280c2f2876SMatthew G. Knepley   prob->ctx[f] = ctx;
16290c2f2876SMatthew G. Knepley   PetscFunctionReturn(0);
16300c2f2876SMatthew G. Knepley }
16310c2f2876SMatthew G. Knepley 
1632194d53e6SMatthew G. Knepley /*@C
1633194d53e6SMatthew G. Knepley   PetscDSGetBdResidual - Get the pointwise boundary residual function for a given test field
1634194d53e6SMatthew G. Knepley 
1635194d53e6SMatthew G. Knepley   Not collective
1636194d53e6SMatthew G. Knepley 
1637194d53e6SMatthew G. Knepley   Input Parameters:
1638194d53e6SMatthew G. Knepley + prob - The PetscDS
1639194d53e6SMatthew G. Knepley - f    - The test field number
1640194d53e6SMatthew G. Knepley 
1641194d53e6SMatthew G. Knepley   Output Parameters:
1642194d53e6SMatthew G. Knepley + f0 - boundary integrand for the test function term
1643194d53e6SMatthew G. Knepley - f1 - boundary integrand for the test function gradient term
1644194d53e6SMatthew G. Knepley 
1645194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1646194d53e6SMatthew G. Knepley 
1647194d53e6SMatthew 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
1648194d53e6SMatthew G. Knepley 
1649194d53e6SMatthew G. Knepley The calling sequence for the callbacks f0 and f1 is given by:
1650194d53e6SMatthew G. Knepley 
165130b9ff8bSMatthew G. Knepley $ f0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1652194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1653194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
165430b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar f0[])
1655194d53e6SMatthew G. Knepley 
1656194d53e6SMatthew G. Knepley + dim - the spatial dimension
1657194d53e6SMatthew G. Knepley . Nf - the number of fields
1658194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1659194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1660194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
1661194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1662194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1663194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1664194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1665194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1666194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1667194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1668194d53e6SMatthew G. Knepley . t - current time
1669194d53e6SMatthew G. Knepley . x - coordinates of the current point
1670194d53e6SMatthew G. Knepley . n - unit normal at the current point
1671194d53e6SMatthew G. Knepley - f0 - output values at the current point
1672194d53e6SMatthew G. Knepley 
1673194d53e6SMatthew G. Knepley   Level: intermediate
1674194d53e6SMatthew G. Knepley 
1675194d53e6SMatthew G. Knepley .seealso: PetscDSSetBdResidual()
1676194d53e6SMatthew G. Knepley @*/
16772764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetBdResidual(PetscDS prob, PetscInt f,
167830b9ff8bSMatthew G. Knepley                                     void (**f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1679194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1680194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
168130b9ff8bSMatthew G. Knepley                                                 PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar f0[]),
168230b9ff8bSMatthew G. Knepley                                     void (**f1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1683194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1684194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
168530b9ff8bSMatthew G. Knepley                                                 PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar f1[]))
16862764a2aaSMatthew G. Knepley {
16872764a2aaSMatthew G. Knepley   PetscFunctionBegin;
16882764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
16892764a2aaSMatthew 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);
16902764a2aaSMatthew G. Knepley   if (f0) {PetscValidPointer(f0, 3); *f0 = prob->fBd[f*2+0];}
16912764a2aaSMatthew G. Knepley   if (f1) {PetscValidPointer(f1, 4); *f1 = prob->fBd[f*2+1];}
16922764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
16932764a2aaSMatthew G. Knepley }
16942764a2aaSMatthew G. Knepley 
1695194d53e6SMatthew G. Knepley /*@C
1696194d53e6SMatthew G. Knepley   PetscDSSetBdResidual - Get the pointwise boundary residual function for a given test field
1697194d53e6SMatthew G. Knepley 
1698194d53e6SMatthew G. Knepley   Not collective
1699194d53e6SMatthew G. Knepley 
1700194d53e6SMatthew G. Knepley   Input Parameters:
1701194d53e6SMatthew G. Knepley + prob - The PetscDS
1702194d53e6SMatthew G. Knepley . f    - The test field number
1703194d53e6SMatthew G. Knepley . f0 - boundary integrand for the test function term
1704194d53e6SMatthew G. Knepley - f1 - boundary integrand for the test function gradient term
1705194d53e6SMatthew G. Knepley 
1706194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1707194d53e6SMatthew G. Knepley 
1708194d53e6SMatthew 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
1709194d53e6SMatthew G. Knepley 
1710194d53e6SMatthew G. Knepley The calling sequence for the callbacks f0 and f1 is given by:
1711194d53e6SMatthew G. Knepley 
171230b9ff8bSMatthew G. Knepley $ f0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1713194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1714194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
171530b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar f0[])
1716194d53e6SMatthew G. Knepley 
1717194d53e6SMatthew G. Knepley + dim - the spatial dimension
1718194d53e6SMatthew G. Knepley . Nf - the number of fields
1719194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1720194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1721194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
1722194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1723194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1724194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1725194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1726194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1727194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1728194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1729194d53e6SMatthew G. Knepley . t - current time
1730194d53e6SMatthew G. Knepley . x - coordinates of the current point
1731194d53e6SMatthew G. Knepley . n - unit normal at the current point
1732194d53e6SMatthew G. Knepley - f0 - output values at the current point
1733194d53e6SMatthew G. Knepley 
1734194d53e6SMatthew G. Knepley   Level: intermediate
1735194d53e6SMatthew G. Knepley 
1736194d53e6SMatthew G. Knepley .seealso: PetscDSGetBdResidual()
1737194d53e6SMatthew G. Knepley @*/
17382764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetBdResidual(PetscDS prob, PetscInt f,
173930b9ff8bSMatthew G. Knepley                                     void (*f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1740194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1741194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
174230b9ff8bSMatthew G. Knepley                                                PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar f0[]),
174330b9ff8bSMatthew G. Knepley                                     void (*f1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1744194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1745194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
174630b9ff8bSMatthew G. Knepley                                                PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar f1[]))
17472764a2aaSMatthew G. Knepley {
17482764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
17492764a2aaSMatthew G. Knepley 
17502764a2aaSMatthew G. Knepley   PetscFunctionBegin;
17512764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
17522764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
17532764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
17542764a2aaSMatthew G. Knepley   if (f0) {PetscValidFunction(f0, 3); prob->fBd[f*2+0] = f0;}
17552764a2aaSMatthew G. Knepley   if (f1) {PetscValidFunction(f1, 4); prob->fBd[f*2+1] = f1;}
17562764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
17572764a2aaSMatthew G. Knepley }
17582764a2aaSMatthew G. Knepley 
1759194d53e6SMatthew G. Knepley /*@C
1760194d53e6SMatthew G. Knepley   PetscDSGetBdJacobian - Get the pointwise boundary Jacobian function for given test and basis field
1761194d53e6SMatthew G. Knepley 
1762194d53e6SMatthew G. Knepley   Not collective
1763194d53e6SMatthew G. Knepley 
1764194d53e6SMatthew G. Knepley   Input Parameters:
1765194d53e6SMatthew G. Knepley + prob - The PetscDS
1766194d53e6SMatthew G. Knepley . f    - The test field number
1767194d53e6SMatthew G. Knepley - g    - The field number
1768194d53e6SMatthew G. Knepley 
1769194d53e6SMatthew G. Knepley   Output Parameters:
1770194d53e6SMatthew G. Knepley + g0 - integrand for the test and basis function term
1771194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1772194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1773194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1774194d53e6SMatthew G. Knepley 
1775194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1776194d53e6SMatthew G. Knepley 
1777194d53e6SMatthew 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
1778194d53e6SMatthew G. Knepley 
1779194d53e6SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1780194d53e6SMatthew G. Knepley 
178130b9ff8bSMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1782194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1783194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
178430b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar g0[])
1785194d53e6SMatthew G. Knepley 
1786194d53e6SMatthew G. Knepley + dim - the spatial dimension
1787194d53e6SMatthew G. Knepley . Nf - the number of fields
1788194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1789194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1790194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
1791194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1792194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1793194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1794194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1795194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1796194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1797194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1798194d53e6SMatthew G. Knepley . t - current time
17992aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1800194d53e6SMatthew G. Knepley . x - coordinates of the current point
1801194d53e6SMatthew G. Knepley . n - normal at the current point
1802194d53e6SMatthew G. Knepley - g0 - output values at the current point
1803194d53e6SMatthew G. Knepley 
1804194d53e6SMatthew G. Knepley   Level: intermediate
1805194d53e6SMatthew G. Knepley 
1806194d53e6SMatthew G. Knepley .seealso: PetscDSSetBdJacobian()
1807194d53e6SMatthew G. Knepley @*/
18082764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetBdJacobian(PetscDS prob, PetscInt f, PetscInt g,
180930b9ff8bSMatthew G. Knepley                                     void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1810194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1811194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
18122aa1fc23SMatthew G. Knepley                                                 PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscScalar g0[]),
181330b9ff8bSMatthew G. Knepley                                     void (**g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1814194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1815194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
18162aa1fc23SMatthew G. Knepley                                                 PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscScalar g1[]),
181730b9ff8bSMatthew G. Knepley                                     void (**g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1818194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1819194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
18202aa1fc23SMatthew G. Knepley                                                 PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscScalar g2[]),
182130b9ff8bSMatthew G. Knepley                                     void (**g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1822194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1823194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
18242aa1fc23SMatthew G. Knepley                                                 PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscScalar g3[]))
18252764a2aaSMatthew G. Knepley {
18262764a2aaSMatthew G. Knepley   PetscFunctionBegin;
18272764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
18282764a2aaSMatthew 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);
18292764a2aaSMatthew 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);
18302764a2aaSMatthew G. Knepley   if (g0) {PetscValidPointer(g0, 4); *g0 = prob->gBd[(f*prob->Nf + g)*4+0];}
18312764a2aaSMatthew G. Knepley   if (g1) {PetscValidPointer(g1, 5); *g1 = prob->gBd[(f*prob->Nf + g)*4+1];}
18322764a2aaSMatthew G. Knepley   if (g2) {PetscValidPointer(g2, 6); *g2 = prob->gBd[(f*prob->Nf + g)*4+2];}
18332764a2aaSMatthew G. Knepley   if (g3) {PetscValidPointer(g3, 7); *g3 = prob->gBd[(f*prob->Nf + g)*4+3];}
18342764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
18352764a2aaSMatthew G. Knepley }
18362764a2aaSMatthew G. Knepley 
1837194d53e6SMatthew G. Knepley /*@C
1838194d53e6SMatthew G. Knepley   PetscDSSetBdJacobian - Set the pointwise boundary Jacobian function for given test and basis field
1839194d53e6SMatthew G. Knepley 
1840194d53e6SMatthew G. Knepley   Not collective
1841194d53e6SMatthew G. Knepley 
1842194d53e6SMatthew G. Knepley   Input Parameters:
1843194d53e6SMatthew G. Knepley + prob - The PetscDS
1844194d53e6SMatthew G. Knepley . f    - The test field number
1845194d53e6SMatthew G. Knepley . g    - The field number
1846194d53e6SMatthew G. Knepley . g0 - integrand for the test and basis function term
1847194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1848194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1849194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1850194d53e6SMatthew G. Knepley 
1851194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1852194d53e6SMatthew G. Knepley 
1853194d53e6SMatthew 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
1854194d53e6SMatthew G. Knepley 
1855194d53e6SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1856194d53e6SMatthew G. Knepley 
185730b9ff8bSMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1858194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1859194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
186030b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar g0[])
1861194d53e6SMatthew G. Knepley 
1862194d53e6SMatthew G. Knepley + dim - the spatial dimension
1863194d53e6SMatthew G. Knepley . Nf - the number of fields
1864194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1865194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1866194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
1867194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1868194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1869194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1870194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1871194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1872194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1873194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1874194d53e6SMatthew G. Knepley . t - current time
18752aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1876194d53e6SMatthew G. Knepley . x - coordinates of the current point
1877194d53e6SMatthew G. Knepley . n - normal at the current point
1878194d53e6SMatthew G. Knepley - g0 - output values at the current point
1879194d53e6SMatthew G. Knepley 
1880194d53e6SMatthew G. Knepley   Level: intermediate
1881194d53e6SMatthew G. Knepley 
1882194d53e6SMatthew G. Knepley .seealso: PetscDSGetBdJacobian()
1883194d53e6SMatthew G. Knepley @*/
18842764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetBdJacobian(PetscDS prob, PetscInt f, PetscInt g,
188530b9ff8bSMatthew G. Knepley                                     void (*g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1886194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1887194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
18882aa1fc23SMatthew G. Knepley                                                PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscScalar g0[]),
188930b9ff8bSMatthew G. Knepley                                     void (*g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1890194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1891194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
18922aa1fc23SMatthew G. Knepley                                                PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscScalar g1[]),
189330b9ff8bSMatthew G. Knepley                                     void (*g2)(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[],
18962aa1fc23SMatthew G. Knepley                                                PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscScalar g2[]),
189730b9ff8bSMatthew G. Knepley                                     void (*g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1898194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1899194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
19002aa1fc23SMatthew G. Knepley                                                PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscScalar g3[]))
19012764a2aaSMatthew G. Knepley {
19022764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
19032764a2aaSMatthew G. Knepley 
19042764a2aaSMatthew G. Knepley   PetscFunctionBegin;
19052764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
19062764a2aaSMatthew G. Knepley   if (g0) PetscValidFunction(g0, 4);
19072764a2aaSMatthew G. Knepley   if (g1) PetscValidFunction(g1, 5);
19082764a2aaSMatthew G. Knepley   if (g2) PetscValidFunction(g2, 6);
19092764a2aaSMatthew G. Knepley   if (g3) PetscValidFunction(g3, 7);
19102764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
19112764a2aaSMatthew G. Knepley   if (g < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", g);
19122764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, PetscMax(f, g)+1);CHKERRQ(ierr);
19132764a2aaSMatthew G. Knepley   prob->gBd[(f*prob->Nf + g)*4+0] = g0;
19142764a2aaSMatthew G. Knepley   prob->gBd[(f*prob->Nf + g)*4+1] = g1;
19152764a2aaSMatthew G. Knepley   prob->gBd[(f*prob->Nf + g)*4+2] = g2;
19162764a2aaSMatthew G. Knepley   prob->gBd[(f*prob->Nf + g)*4+3] = g3;
19172764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
19182764a2aaSMatthew G. Knepley }
19192764a2aaSMatthew G. Knepley 
19204cd1e086SMatthew G. Knepley /*@
19214cd1e086SMatthew G. Knepley   PetscDSGetFieldIndex - Returns the index of the given field
19224cd1e086SMatthew G. Knepley 
19234cd1e086SMatthew G. Knepley   Not collective
19244cd1e086SMatthew G. Knepley 
19254cd1e086SMatthew G. Knepley   Input Parameters:
19264cd1e086SMatthew G. Knepley + prob - The PetscDS object
19274cd1e086SMatthew G. Knepley - disc - The discretization object
19284cd1e086SMatthew G. Knepley 
19294cd1e086SMatthew G. Knepley   Output Parameter:
19304cd1e086SMatthew G. Knepley . f - The field number
19314cd1e086SMatthew G. Knepley 
19324cd1e086SMatthew G. Knepley   Level: beginner
19334cd1e086SMatthew G. Knepley 
1934f744cafaSSander Arens .seealso: PetscGetDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
19354cd1e086SMatthew G. Knepley @*/
19364cd1e086SMatthew G. Knepley PetscErrorCode PetscDSGetFieldIndex(PetscDS prob, PetscObject disc, PetscInt *f)
19374cd1e086SMatthew G. Knepley {
19384cd1e086SMatthew G. Knepley   PetscInt g;
19394cd1e086SMatthew G. Knepley 
19404cd1e086SMatthew G. Knepley   PetscFunctionBegin;
19414cd1e086SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
19424cd1e086SMatthew G. Knepley   PetscValidPointer(f, 3);
19434cd1e086SMatthew G. Knepley   *f = -1;
19444cd1e086SMatthew G. Knepley   for (g = 0; g < prob->Nf; ++g) {if (disc == prob->disc[g]) break;}
19454cd1e086SMatthew G. Knepley   if (g == prob->Nf) SETERRQ(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Field not found in PetscDS.");
19464cd1e086SMatthew G. Knepley   *f = g;
19474cd1e086SMatthew G. Knepley   PetscFunctionReturn(0);
19484cd1e086SMatthew G. Knepley }
19494cd1e086SMatthew G. Knepley 
19504cd1e086SMatthew G. Knepley /*@
19514cd1e086SMatthew G. Knepley   PetscDSGetFieldSize - Returns the size of the given field in the full space basis
19524cd1e086SMatthew G. Knepley 
19534cd1e086SMatthew G. Knepley   Not collective
19544cd1e086SMatthew G. Knepley 
19554cd1e086SMatthew G. Knepley   Input Parameters:
19564cd1e086SMatthew G. Knepley + prob - The PetscDS object
19574cd1e086SMatthew G. Knepley - f - The field number
19584cd1e086SMatthew G. Knepley 
19594cd1e086SMatthew G. Knepley   Output Parameter:
19604cd1e086SMatthew G. Knepley . size - The size
19614cd1e086SMatthew G. Knepley 
19624cd1e086SMatthew G. Knepley   Level: beginner
19634cd1e086SMatthew G. Knepley 
1964f744cafaSSander Arens .seealso: PetscDSGetFieldOffset(), PetscDSGetNumFields(), PetscDSCreate()
19654cd1e086SMatthew G. Knepley @*/
19664cd1e086SMatthew G. Knepley PetscErrorCode PetscDSGetFieldSize(PetscDS prob, PetscInt f, PetscInt *size)
19674cd1e086SMatthew G. Knepley {
19682166fd64SMatthew G. Knepley   PetscErrorCode ierr;
19692166fd64SMatthew G. Knepley 
19704cd1e086SMatthew G. Knepley   PetscFunctionBegin;
19714cd1e086SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
19724cd1e086SMatthew G. Knepley   PetscValidPointer(size, 3);
19734cd1e086SMatthew 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);
19742166fd64SMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
197547e57110SSander Arens   *size = prob->Nc[f] * prob->Nb[f];
19764cd1e086SMatthew G. Knepley   PetscFunctionReturn(0);
19774cd1e086SMatthew G. Knepley }
19784cd1e086SMatthew G. Knepley 
1979bc4ae4beSMatthew G. Knepley /*@
1980bc4ae4beSMatthew G. Knepley   PetscDSGetFieldOffset - Returns the offset of the given field in the full space basis
1981bc4ae4beSMatthew G. Knepley 
1982bc4ae4beSMatthew G. Knepley   Not collective
1983bc4ae4beSMatthew G. Knepley 
1984bc4ae4beSMatthew G. Knepley   Input Parameters:
1985bc4ae4beSMatthew G. Knepley + prob - The PetscDS object
1986bc4ae4beSMatthew G. Knepley - f - The field number
1987bc4ae4beSMatthew G. Knepley 
1988bc4ae4beSMatthew G. Knepley   Output Parameter:
1989bc4ae4beSMatthew G. Knepley . off - The offset
1990bc4ae4beSMatthew G. Knepley 
1991bc4ae4beSMatthew G. Knepley   Level: beginner
1992bc4ae4beSMatthew G. Knepley 
1993f744cafaSSander Arens .seealso: PetscDSGetFieldSize(), PetscDSGetNumFields(), PetscDSCreate()
1994bc4ae4beSMatthew G. Knepley @*/
19952764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetFieldOffset(PetscDS prob, PetscInt f, PetscInt *off)
19962764a2aaSMatthew G. Knepley {
19974cd1e086SMatthew G. Knepley   PetscInt       size, g;
19982764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
19992764a2aaSMatthew G. Knepley 
20002764a2aaSMatthew G. Knepley   PetscFunctionBegin;
20012764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
20022764a2aaSMatthew G. Knepley   PetscValidPointer(off, 3);
20032764a2aaSMatthew G. Knepley   if ((f < 0) || (f >= prob->Nf)) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, prob->Nf);
20042764a2aaSMatthew G. Knepley   *off = 0;
20052764a2aaSMatthew G. Knepley   for (g = 0; g < f; ++g) {
20064cd1e086SMatthew G. Knepley     ierr = PetscDSGetFieldSize(prob, g, &size);CHKERRQ(ierr);
20074cd1e086SMatthew G. Knepley     *off += size;
20082764a2aaSMatthew G. Knepley   }
20092764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
20102764a2aaSMatthew G. Knepley }
20112764a2aaSMatthew G. Knepley 
2012bc4ae4beSMatthew G. Knepley /*@
201347e57110SSander Arens   PetscDSGetDimensions - Returns the size of the approximation space for each field on an evaluation point
2014bc4ae4beSMatthew G. Knepley 
2015bc4ae4beSMatthew G. Knepley   Not collective
2016bc4ae4beSMatthew G. Knepley 
201747e57110SSander Arens   Input Parameter:
201847e57110SSander Arens . prob - The PetscDS object
2019bc4ae4beSMatthew G. Knepley 
2020bc4ae4beSMatthew G. Knepley   Output Parameter:
202147e57110SSander Arens . dimensions - The number of dimensions
2022bc4ae4beSMatthew G. Knepley 
2023bc4ae4beSMatthew G. Knepley   Level: beginner
2024bc4ae4beSMatthew G. Knepley 
202547e57110SSander Arens .seealso: PetscDSGetComponentOffsets(), PetscDSGetNumFields(), PetscDSCreate()
2026bc4ae4beSMatthew G. Knepley @*/
202747e57110SSander Arens PetscErrorCode PetscDSGetDimensions(PetscDS prob, PetscInt *dimensions[])
20282764a2aaSMatthew G. Knepley {
20292764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
20302764a2aaSMatthew G. Knepley 
20312764a2aaSMatthew G. Knepley   PetscFunctionBegin;
20322764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
203347e57110SSander Arens   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
203447e57110SSander Arens   PetscValidPointer(dimensions, 2);
203547e57110SSander Arens   *dimensions = prob->Nb;
203647e57110SSander Arens   PetscFunctionReturn(0);
20376ce16762SMatthew G. Knepley }
203847e57110SSander Arens 
203947e57110SSander Arens /*@
204047e57110SSander Arens   PetscDSGetComponents - Returns the number of components for each field on an evaluation point
204147e57110SSander Arens 
204247e57110SSander Arens   Not collective
204347e57110SSander Arens 
204447e57110SSander Arens   Input Parameter:
204547e57110SSander Arens . prob - The PetscDS object
204647e57110SSander Arens 
204747e57110SSander Arens   Output Parameter:
204847e57110SSander Arens . components - The number of components
204947e57110SSander Arens 
205047e57110SSander Arens   Level: beginner
205147e57110SSander Arens 
205247e57110SSander Arens .seealso: PetscDSGetComponentOffsets(), PetscDSGetNumFields(), PetscDSCreate()
205347e57110SSander Arens @*/
205447e57110SSander Arens PetscErrorCode PetscDSGetComponents(PetscDS prob, PetscInt *components[])
205547e57110SSander Arens {
205647e57110SSander Arens   PetscErrorCode ierr;
205747e57110SSander Arens 
205847e57110SSander Arens   PetscFunctionBegin;
205947e57110SSander Arens   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
206047e57110SSander Arens   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
206147e57110SSander Arens   PetscValidPointer(components, 2);
206247e57110SSander Arens   *components = prob->Nc;
20636ce16762SMatthew G. Knepley   PetscFunctionReturn(0);
20646ce16762SMatthew G. Knepley }
20656ce16762SMatthew G. Knepley 
20666ce16762SMatthew G. Knepley /*@
20676ce16762SMatthew G. Knepley   PetscDSGetComponentOffset - Returns the offset of the given field on an evaluation point
20686ce16762SMatthew G. Knepley 
20696ce16762SMatthew G. Knepley   Not collective
20706ce16762SMatthew G. Knepley 
20716ce16762SMatthew G. Knepley   Input Parameters:
20726ce16762SMatthew G. Knepley + prob - The PetscDS object
20736ce16762SMatthew G. Knepley - f - The field number
20746ce16762SMatthew G. Knepley 
20756ce16762SMatthew G. Knepley   Output Parameter:
20766ce16762SMatthew G. Knepley . off - The offset
20776ce16762SMatthew G. Knepley 
20786ce16762SMatthew G. Knepley   Level: beginner
20796ce16762SMatthew G. Knepley 
2080f744cafaSSander Arens .seealso: PetscDSGetNumFields(), PetscDSCreate()
20816ce16762SMatthew G. Knepley @*/
20826ce16762SMatthew G. Knepley PetscErrorCode PetscDSGetComponentOffset(PetscDS prob, PetscInt f, PetscInt *off)
20836ce16762SMatthew G. Knepley {
20846ce16762SMatthew G. Knepley   PetscFunctionBegin;
20856ce16762SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
20866ce16762SMatthew G. Knepley   PetscValidPointer(off, 3);
20876ce16762SMatthew 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);
208847e57110SSander Arens   *off = prob->off[f];
20892764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
20902764a2aaSMatthew G. Knepley }
20912764a2aaSMatthew G. Knepley 
2092194d53e6SMatthew G. Knepley /*@
2093194d53e6SMatthew G. Knepley   PetscDSGetComponentOffsets - Returns the offset of each field on an evaluation point
2094194d53e6SMatthew G. Knepley 
2095194d53e6SMatthew G. Knepley   Not collective
2096194d53e6SMatthew G. Knepley 
2097194d53e6SMatthew G. Knepley   Input Parameter:
2098194d53e6SMatthew G. Knepley . prob - The PetscDS object
2099194d53e6SMatthew G. Knepley 
2100194d53e6SMatthew G. Knepley   Output Parameter:
2101194d53e6SMatthew G. Knepley . offsets - The offsets
2102194d53e6SMatthew G. Knepley 
2103194d53e6SMatthew G. Knepley   Level: beginner
2104194d53e6SMatthew G. Knepley 
2105f744cafaSSander Arens .seealso: PetscDSGetNumFields(), PetscDSCreate()
2106194d53e6SMatthew G. Knepley @*/
2107194d53e6SMatthew G. Knepley PetscErrorCode PetscDSGetComponentOffsets(PetscDS prob, PetscInt *offsets[])
2108194d53e6SMatthew G. Knepley {
2109194d53e6SMatthew G. Knepley   PetscFunctionBegin;
2110194d53e6SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2111194d53e6SMatthew G. Knepley   PetscValidPointer(offsets, 2);
2112194d53e6SMatthew G. Knepley   *offsets = prob->off;
2113194d53e6SMatthew G. Knepley   PetscFunctionReturn(0);
2114194d53e6SMatthew G. Knepley }
2115194d53e6SMatthew G. Knepley 
2116194d53e6SMatthew G. Knepley /*@
2117194d53e6SMatthew G. Knepley   PetscDSGetComponentDerivativeOffsets - Returns the offset of each field derivative on an evaluation point
2118194d53e6SMatthew G. Knepley 
2119194d53e6SMatthew G. Knepley   Not collective
2120194d53e6SMatthew G. Knepley 
2121194d53e6SMatthew G. Knepley   Input Parameter:
2122194d53e6SMatthew G. Knepley . prob - The PetscDS object
2123194d53e6SMatthew G. Knepley 
2124194d53e6SMatthew G. Knepley   Output Parameter:
2125194d53e6SMatthew G. Knepley . offsets - The offsets
2126194d53e6SMatthew G. Knepley 
2127194d53e6SMatthew G. Knepley   Level: beginner
2128194d53e6SMatthew G. Knepley 
2129f744cafaSSander Arens .seealso: PetscDSGetNumFields(), PetscDSCreate()
2130194d53e6SMatthew G. Knepley @*/
2131194d53e6SMatthew G. Knepley PetscErrorCode PetscDSGetComponentDerivativeOffsets(PetscDS prob, PetscInt *offsets[])
2132194d53e6SMatthew G. Knepley {
2133194d53e6SMatthew G. Knepley   PetscFunctionBegin;
2134194d53e6SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2135194d53e6SMatthew G. Knepley   PetscValidPointer(offsets, 2);
2136194d53e6SMatthew G. Knepley   *offsets = prob->offDer;
2137194d53e6SMatthew G. Knepley   PetscFunctionReturn(0);
2138194d53e6SMatthew G. Knepley }
2139194d53e6SMatthew G. Knepley 
214068c9edb9SMatthew G. Knepley /*@C
214168c9edb9SMatthew G. Knepley   PetscDSGetTabulation - Return the basis tabulation at quadrature points for the volume discretization
214268c9edb9SMatthew G. Knepley 
214368c9edb9SMatthew G. Knepley   Not collective
214468c9edb9SMatthew G. Knepley 
214568c9edb9SMatthew G. Knepley   Input Parameter:
214668c9edb9SMatthew G. Knepley . prob - The PetscDS object
214768c9edb9SMatthew G. Knepley 
214868c9edb9SMatthew G. Knepley   Output Parameters:
214968c9edb9SMatthew G. Knepley + basis - The basis function tabulation at quadrature points
215068c9edb9SMatthew G. Knepley - basisDer - The basis function derivative tabulation at quadrature points
215168c9edb9SMatthew G. Knepley 
215268c9edb9SMatthew G. Knepley   Level: intermediate
215368c9edb9SMatthew G. Knepley 
2154f744cafaSSander Arens .seealso: PetscDSCreate()
215568c9edb9SMatthew G. Knepley @*/
21562764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetTabulation(PetscDS prob, PetscReal ***basis, PetscReal ***basisDer)
21572764a2aaSMatthew G. Knepley {
21582764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
21592764a2aaSMatthew G. Knepley 
21602764a2aaSMatthew G. Knepley   PetscFunctionBegin;
21612764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
21622764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
21632764a2aaSMatthew G. Knepley   if (basis)    {PetscValidPointer(basis, 2);    *basis    = prob->basis;}
21642764a2aaSMatthew G. Knepley   if (basisDer) {PetscValidPointer(basisDer, 3); *basisDer = prob->basisDer;}
21652764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
21662764a2aaSMatthew G. Knepley }
21672764a2aaSMatthew G. Knepley 
216868c9edb9SMatthew G. Knepley /*@C
21694d0b9603SSander Arens   PetscDSGetFaceTabulation - Return the basis tabulation at quadrature points on the faces
217068c9edb9SMatthew G. Knepley 
217168c9edb9SMatthew G. Knepley   Not collective
217268c9edb9SMatthew G. Knepley 
217368c9edb9SMatthew G. Knepley   Input Parameter:
217468c9edb9SMatthew G. Knepley . prob - The PetscDS object
217568c9edb9SMatthew G. Knepley 
217668c9edb9SMatthew G. Knepley   Output Parameters:
21774d0b9603SSander Arens + basisFace - The basis function tabulation at quadrature points
21784d0b9603SSander Arens - basisDerFace - The basis function derivative tabulation at quadrature points
217968c9edb9SMatthew G. Knepley 
218068c9edb9SMatthew G. Knepley   Level: intermediate
218168c9edb9SMatthew G. Knepley 
218268c9edb9SMatthew G. Knepley .seealso: PetscDSGetTabulation(), PetscDSCreate()
218368c9edb9SMatthew G. Knepley @*/
21844d0b9603SSander Arens PetscErrorCode PetscDSGetFaceTabulation(PetscDS prob, PetscReal ***basis, PetscReal ***basisDer)
21852764a2aaSMatthew G. Knepley {
21862764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
21872764a2aaSMatthew G. Knepley 
21882764a2aaSMatthew G. Knepley   PetscFunctionBegin;
21892764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
21902764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
21914d0b9603SSander Arens   if (basis)    {PetscValidPointer(basis, 2);    *basis    = prob->basisFace;}
21924d0b9603SSander Arens   if (basisDer) {PetscValidPointer(basisDer, 3); *basisDer = prob->basisDerFace;}
21932764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
21942764a2aaSMatthew G. Knepley }
21952764a2aaSMatthew G. Knepley 
21962764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetEvaluationArrays(PetscDS prob, PetscScalar **u, PetscScalar **u_t, PetscScalar **u_x)
21972764a2aaSMatthew G. Knepley {
21982764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
21992764a2aaSMatthew G. Knepley 
22002764a2aaSMatthew G. Knepley   PetscFunctionBegin;
22012764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
22022764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
22032764a2aaSMatthew G. Knepley   if (u)   {PetscValidPointer(u, 2);   *u   = prob->u;}
22042764a2aaSMatthew G. Knepley   if (u_t) {PetscValidPointer(u_t, 3); *u_t = prob->u_t;}
22052764a2aaSMatthew G. Knepley   if (u_x) {PetscValidPointer(u_x, 4); *u_x = prob->u_x;}
22062764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
22072764a2aaSMatthew G. Knepley }
22082764a2aaSMatthew G. Knepley 
22092764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetWeakFormArrays(PetscDS prob, PetscScalar **f0, PetscScalar **f1, PetscScalar **g0, PetscScalar **g1, PetscScalar **g2, PetscScalar **g3)
22102764a2aaSMatthew G. Knepley {
22112764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
22122764a2aaSMatthew G. Knepley 
22132764a2aaSMatthew G. Knepley   PetscFunctionBegin;
22142764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
22152764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
22162764a2aaSMatthew G. Knepley   if (f0) {PetscValidPointer(f0, 2); *f0 = prob->f0;}
22172764a2aaSMatthew G. Knepley   if (f1) {PetscValidPointer(f1, 3); *f1 = prob->f1;}
22182764a2aaSMatthew G. Knepley   if (g0) {PetscValidPointer(g0, 4); *g0 = prob->g0;}
22192764a2aaSMatthew G. Knepley   if (g1) {PetscValidPointer(g1, 5); *g1 = prob->g1;}
22202764a2aaSMatthew G. Knepley   if (g2) {PetscValidPointer(g2, 6); *g2 = prob->g2;}
22212764a2aaSMatthew G. Knepley   if (g3) {PetscValidPointer(g3, 7); *g3 = prob->g3;}
22222764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
22232764a2aaSMatthew G. Knepley }
22242764a2aaSMatthew G. Knepley 
22252764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetRefCoordArrays(PetscDS prob, PetscReal **x, PetscScalar **refSpaceDer)
22262764a2aaSMatthew G. Knepley {
22272764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
22282764a2aaSMatthew G. Knepley 
22292764a2aaSMatthew G. Knepley   PetscFunctionBegin;
22302764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
22312764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
22322764a2aaSMatthew G. Knepley   if (x)           {PetscValidPointer(x, 2);           *x           = prob->x;}
22332764a2aaSMatthew G. Knepley   if (refSpaceDer) {PetscValidPointer(refSpaceDer, 3); *refSpaceDer = prob->refSpaceDer;}
22342764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
22352764a2aaSMatthew G. Knepley }
22362764a2aaSMatthew G. Knepley 
223758ebd649SToby Isaac /*@C
223858ebd649SToby Isaac   PetscDSAddBoundary - Add a boundary condition to the model
223958ebd649SToby Isaac 
224058ebd649SToby Isaac   Input Parameters:
224158ebd649SToby Isaac + ds          - The PetscDS object
22422d47a189SJulian Andrej . type        - The type of condition, e.g. DM_BC_ESSENTIAL/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann)
224358ebd649SToby Isaac . name        - The BC name
224458ebd649SToby Isaac . labelname   - The label defining constrained points
224558ebd649SToby Isaac . field       - The field to constrain
224658ebd649SToby Isaac . numcomps    - The number of constrained field components
224758ebd649SToby Isaac . comps       - An array of constrained component numbers
224858ebd649SToby Isaac . bcFunc      - A pointwise function giving boundary values
224958ebd649SToby Isaac . numids      - The number of DMLabel ids for constrained points
225058ebd649SToby Isaac . ids         - An array of ids for constrained points
225158ebd649SToby Isaac - ctx         - An optional user context for bcFunc
225258ebd649SToby Isaac 
225358ebd649SToby Isaac   Options Database Keys:
225458ebd649SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids
225558ebd649SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components
225658ebd649SToby Isaac 
225758ebd649SToby Isaac   Level: developer
225858ebd649SToby Isaac 
225958ebd649SToby Isaac .seealso: PetscDSGetBoundary()
226058ebd649SToby Isaac @*/
2261*a30ec4eaSSatish 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)
226258ebd649SToby Isaac {
226358ebd649SToby Isaac   DSBoundary     b;
226458ebd649SToby Isaac   PetscErrorCode ierr;
226558ebd649SToby Isaac 
226658ebd649SToby Isaac   PetscFunctionBegin;
226758ebd649SToby Isaac   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1);
226858ebd649SToby Isaac   ierr = PetscNew(&b);CHKERRQ(ierr);
226958ebd649SToby Isaac   ierr = PetscStrallocpy(name, (char **) &b->name);CHKERRQ(ierr);
227058ebd649SToby Isaac   ierr = PetscStrallocpy(labelname, (char **) &b->labelname);CHKERRQ(ierr);
227158ebd649SToby Isaac   ierr = PetscMalloc1(numcomps, &b->comps);CHKERRQ(ierr);
227258ebd649SToby Isaac   if (numcomps) {ierr = PetscMemcpy(b->comps, comps, numcomps*sizeof(PetscInt));CHKERRQ(ierr);}
227358ebd649SToby Isaac   ierr = PetscMalloc1(numids, &b->ids);CHKERRQ(ierr);
227458ebd649SToby Isaac   if (numids) {ierr = PetscMemcpy(b->ids, ids, numids*sizeof(PetscInt));CHKERRQ(ierr);}
2275f971fd6bSMatthew G. Knepley   b->type            = type;
227658ebd649SToby Isaac   b->field           = field;
227758ebd649SToby Isaac   b->numcomps        = numcomps;
227858ebd649SToby Isaac   b->func            = bcFunc;
227958ebd649SToby Isaac   b->numids          = numids;
228058ebd649SToby Isaac   b->ctx             = ctx;
228158ebd649SToby Isaac   b->next            = ds->boundary;
228258ebd649SToby Isaac   ds->boundary       = b;
228358ebd649SToby Isaac   PetscFunctionReturn(0);
228458ebd649SToby Isaac }
228558ebd649SToby Isaac 
228658ebd649SToby Isaac /*@
228758ebd649SToby Isaac   PetscDSGetNumBoundary - Get the number of registered BC
228858ebd649SToby Isaac 
228958ebd649SToby Isaac   Input Parameters:
229058ebd649SToby Isaac . ds - The PetscDS object
229158ebd649SToby Isaac 
229258ebd649SToby Isaac   Output Parameters:
229358ebd649SToby Isaac . numBd - The number of BC
229458ebd649SToby Isaac 
229558ebd649SToby Isaac   Level: intermediate
229658ebd649SToby Isaac 
229758ebd649SToby Isaac .seealso: PetscDSAddBoundary(), PetscDSGetBoundary()
229858ebd649SToby Isaac @*/
229958ebd649SToby Isaac PetscErrorCode PetscDSGetNumBoundary(PetscDS ds, PetscInt *numBd)
230058ebd649SToby Isaac {
230158ebd649SToby Isaac   DSBoundary b = ds->boundary;
230258ebd649SToby Isaac 
230358ebd649SToby Isaac   PetscFunctionBegin;
230458ebd649SToby Isaac   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1);
230558ebd649SToby Isaac   PetscValidPointer(numBd, 2);
230658ebd649SToby Isaac   *numBd = 0;
230758ebd649SToby Isaac   while (b) {++(*numBd); b = b->next;}
230858ebd649SToby Isaac   PetscFunctionReturn(0);
230958ebd649SToby Isaac }
231058ebd649SToby Isaac 
231158ebd649SToby Isaac /*@C
231258ebd649SToby Isaac   PetscDSGetBoundary - Add a boundary condition to the model
231358ebd649SToby Isaac 
231458ebd649SToby Isaac   Input Parameters:
231558ebd649SToby Isaac + ds          - The PetscDS object
231658ebd649SToby Isaac - bd          - The BC number
231758ebd649SToby Isaac 
231858ebd649SToby Isaac   Output Parameters:
23192d47a189SJulian Andrej + type        - The type of condition, e.g. DM_BC_ESSENTIAL/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann)
232058ebd649SToby Isaac . name        - The BC name
232158ebd649SToby Isaac . labelname   - The label defining constrained points
232258ebd649SToby Isaac . field       - The field to constrain
232358ebd649SToby Isaac . numcomps    - The number of constrained field components
232458ebd649SToby Isaac . comps       - An array of constrained component numbers
232558ebd649SToby Isaac . bcFunc      - A pointwise function giving boundary values
232658ebd649SToby Isaac . numids      - The number of DMLabel ids for constrained points
232758ebd649SToby Isaac . ids         - An array of ids for constrained points
232858ebd649SToby Isaac - ctx         - An optional user context for bcFunc
232958ebd649SToby Isaac 
233058ebd649SToby Isaac   Options Database Keys:
233158ebd649SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids
233258ebd649SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components
233358ebd649SToby Isaac 
233458ebd649SToby Isaac   Level: developer
233558ebd649SToby Isaac 
233658ebd649SToby Isaac .seealso: PetscDSAddBoundary()
233758ebd649SToby Isaac @*/
2338*a30ec4eaSSatish 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)
233958ebd649SToby Isaac {
234058ebd649SToby Isaac   DSBoundary b    = ds->boundary;
234158ebd649SToby Isaac   PetscInt   n    = 0;
234258ebd649SToby Isaac 
234358ebd649SToby Isaac   PetscFunctionBegin;
234458ebd649SToby Isaac   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1);
234558ebd649SToby Isaac   while (b) {
234658ebd649SToby Isaac     if (n == bd) break;
234758ebd649SToby Isaac     b = b->next;
234858ebd649SToby Isaac     ++n;
234958ebd649SToby Isaac   }
235058ebd649SToby Isaac   if (!b) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Boundary %d is not in [0, %d)", bd, n);
2351f971fd6bSMatthew G. Knepley   if (type) {
2352f971fd6bSMatthew G. Knepley     PetscValidPointer(type, 3);
2353f971fd6bSMatthew G. Knepley     *type = b->type;
235458ebd649SToby Isaac   }
235558ebd649SToby Isaac   if (name) {
235658ebd649SToby Isaac     PetscValidPointer(name, 4);
235758ebd649SToby Isaac     *name = b->name;
235858ebd649SToby Isaac   }
235958ebd649SToby Isaac   if (labelname) {
236058ebd649SToby Isaac     PetscValidPointer(labelname, 5);
236158ebd649SToby Isaac     *labelname = b->labelname;
236258ebd649SToby Isaac   }
236358ebd649SToby Isaac   if (field) {
236458ebd649SToby Isaac     PetscValidPointer(field, 6);
236558ebd649SToby Isaac     *field = b->field;
236658ebd649SToby Isaac   }
236758ebd649SToby Isaac   if (numcomps) {
236858ebd649SToby Isaac     PetscValidPointer(numcomps, 7);
236958ebd649SToby Isaac     *numcomps = b->numcomps;
237058ebd649SToby Isaac   }
237158ebd649SToby Isaac   if (comps) {
237258ebd649SToby Isaac     PetscValidPointer(comps, 8);
237358ebd649SToby Isaac     *comps = b->comps;
237458ebd649SToby Isaac   }
237558ebd649SToby Isaac   if (func) {
237658ebd649SToby Isaac     PetscValidPointer(func, 9);
237758ebd649SToby Isaac     *func = b->func;
237858ebd649SToby Isaac   }
237958ebd649SToby Isaac   if (numids) {
238058ebd649SToby Isaac     PetscValidPointer(numids, 10);
238158ebd649SToby Isaac     *numids = b->numids;
238258ebd649SToby Isaac   }
238358ebd649SToby Isaac   if (ids) {
238458ebd649SToby Isaac     PetscValidPointer(ids, 11);
238558ebd649SToby Isaac     *ids = b->ids;
238658ebd649SToby Isaac   }
238758ebd649SToby Isaac   if (ctx) {
238858ebd649SToby Isaac     PetscValidPointer(ctx, 12);
238958ebd649SToby Isaac     *ctx = b->ctx;
239058ebd649SToby Isaac   }
239158ebd649SToby Isaac   PetscFunctionReturn(0);
239258ebd649SToby Isaac }
239358ebd649SToby Isaac 
2394dff059c6SToby Isaac PetscErrorCode PetscDSCopyBoundary(PetscDS probA, PetscDS probB)
2395dff059c6SToby Isaac {
2396dff059c6SToby Isaac   DSBoundary     b, next, *lastnext;
2397dff059c6SToby Isaac   PetscErrorCode ierr;
2398dff059c6SToby Isaac 
2399dff059c6SToby Isaac   PetscFunctionBegin;
2400dff059c6SToby Isaac   PetscValidHeaderSpecific(probA, PETSCDS_CLASSID, 1);
2401dff059c6SToby Isaac   PetscValidHeaderSpecific(probB, PETSCDS_CLASSID, 2);
2402dff059c6SToby Isaac   if (probA == probB) PetscFunctionReturn(0);
2403dff059c6SToby Isaac   next = probB->boundary;
2404dff059c6SToby Isaac   while (next) {
2405dff059c6SToby Isaac     DSBoundary b = next;
2406dff059c6SToby Isaac 
2407dff059c6SToby Isaac     next = b->next;
2408dff059c6SToby Isaac     ierr = PetscFree(b->comps);CHKERRQ(ierr);
2409dff059c6SToby Isaac     ierr = PetscFree(b->ids);CHKERRQ(ierr);
2410dff059c6SToby Isaac     ierr = PetscFree(b->name);CHKERRQ(ierr);
2411dff059c6SToby Isaac     ierr = PetscFree(b->labelname);CHKERRQ(ierr);
2412dff059c6SToby Isaac     ierr = PetscFree(b);CHKERRQ(ierr);
2413dff059c6SToby Isaac   }
2414dff059c6SToby Isaac   lastnext = &(probB->boundary);
2415dff059c6SToby Isaac   for (b = probA->boundary; b; b = b->next) {
2416dff059c6SToby Isaac     DSBoundary bNew;
2417dff059c6SToby Isaac 
2418459726d8SSatish Balay     ierr = PetscNew(&bNew);CHKERRQ(ierr);
2419dff059c6SToby Isaac     bNew->numcomps = b->numcomps;
2420dff059c6SToby Isaac     ierr = PetscMalloc1(bNew->numcomps, &bNew->comps);CHKERRQ(ierr);
2421dff059c6SToby Isaac     ierr = PetscMemcpy(bNew->comps, b->comps, bNew->numcomps*sizeof(PetscInt));CHKERRQ(ierr);
2422dff059c6SToby Isaac     bNew->numids = b->numids;
2423dff059c6SToby Isaac     ierr = PetscMalloc1(bNew->numids, &bNew->ids);CHKERRQ(ierr);
2424dff059c6SToby Isaac     ierr = PetscMemcpy(bNew->ids, b->ids, bNew->numids*sizeof(PetscInt));CHKERRQ(ierr);
2425dff059c6SToby Isaac     ierr = PetscStrallocpy(b->labelname,(char **) &(bNew->labelname));CHKERRQ(ierr);
2426dff059c6SToby Isaac     ierr = PetscStrallocpy(b->name,(char **) &(bNew->name));CHKERRQ(ierr);
2427dff059c6SToby Isaac     bNew->ctx   = b->ctx;
2428f971fd6bSMatthew G. Knepley     bNew->type  = b->type;
2429dff059c6SToby Isaac     bNew->field = b->field;
2430dff059c6SToby Isaac     bNew->func  = b->func;
2431dff059c6SToby Isaac 
2432dff059c6SToby Isaac     *lastnext = bNew;
2433dff059c6SToby Isaac     lastnext = &(bNew->next);
2434dff059c6SToby Isaac   }
2435dff059c6SToby Isaac   PetscFunctionReturn(0);
2436dff059c6SToby Isaac }
2437dff059c6SToby Isaac 
2438da51fcedSMatthew G. Knepley /*@
2439da51fcedSMatthew G. Knepley   PetscDSCopyEquations - Copy all pointwise function pointers to the new problem
2440da51fcedSMatthew G. Knepley 
2441da51fcedSMatthew G. Knepley   Not collective
2442da51fcedSMatthew G. Knepley 
2443da51fcedSMatthew G. Knepley   Input Parameter:
2444da51fcedSMatthew G. Knepley . prob - The PetscDS object
2445da51fcedSMatthew G. Knepley 
2446da51fcedSMatthew G. Knepley   Output Parameter:
2447da51fcedSMatthew G. Knepley . newprob - The PetscDS copy
2448da51fcedSMatthew G. Knepley 
2449da51fcedSMatthew G. Knepley   Level: intermediate
2450da51fcedSMatthew G. Knepley 
2451da51fcedSMatthew G. Knepley .seealso: PetscDSSetResidual(), PetscDSSetJacobian(), PetscDSSetRiemannSolver(), PetscDSSetBdResidual(), PetscDSSetBdJacobian(), PetscDSCreate()
2452da51fcedSMatthew G. Knepley @*/
2453da51fcedSMatthew G. Knepley PetscErrorCode PetscDSCopyEquations(PetscDS prob, PetscDS newprob)
2454da51fcedSMatthew G. Knepley {
2455da51fcedSMatthew G. Knepley   PetscInt       Nf, Ng, f, g;
2456da51fcedSMatthew G. Knepley   PetscErrorCode ierr;
2457da51fcedSMatthew G. Knepley 
2458da51fcedSMatthew G. Knepley   PetscFunctionBegin;
2459da51fcedSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2460da51fcedSMatthew G. Knepley   PetscValidHeaderSpecific(newprob, PETSCDS_CLASSID, 2);
2461da51fcedSMatthew G. Knepley   ierr = PetscDSGetNumFields(prob, &Nf);CHKERRQ(ierr);
2462da51fcedSMatthew G. Knepley   ierr = PetscDSGetNumFields(newprob, &Ng);CHKERRQ(ierr);
2463da51fcedSMatthew G. Knepley   if (Nf != Ng) SETERRQ2(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_SIZ, "Number of fields must match %D != %D", Nf, Ng);CHKERRQ(ierr);
2464da51fcedSMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
2465da51fcedSMatthew G. Knepley     PetscPointFunc   obj;
2466da51fcedSMatthew G. Knepley     PetscPointFunc   f0, f1;
2467da51fcedSMatthew G. Knepley     PetscPointJac    g0, g1, g2, g3;
2468da51fcedSMatthew G. Knepley     PetscBdPointFunc f0Bd, f1Bd;
2469da51fcedSMatthew G. Knepley     PetscBdPointJac  g0Bd, g1Bd, g2Bd, g3Bd;
2470da51fcedSMatthew G. Knepley     PetscRiemannFunc r;
2471da51fcedSMatthew G. Knepley 
2472da51fcedSMatthew G. Knepley     ierr = PetscDSGetObjective(prob, f, &obj);CHKERRQ(ierr);
2473da51fcedSMatthew G. Knepley     ierr = PetscDSGetResidual(prob, f, &f0, &f1);CHKERRQ(ierr);
2474da51fcedSMatthew G. Knepley     ierr = PetscDSGetBdResidual(prob, f, &f0Bd, &f1Bd);CHKERRQ(ierr);
2475da51fcedSMatthew G. Knepley     ierr = PetscDSGetRiemannSolver(prob, f, &r);CHKERRQ(ierr);
2476da51fcedSMatthew G. Knepley     ierr = PetscDSSetObjective(newprob, f, obj);CHKERRQ(ierr);
2477da51fcedSMatthew G. Knepley     ierr = PetscDSSetResidual(newprob, f, f0, f1);CHKERRQ(ierr);
2478da51fcedSMatthew G. Knepley     ierr = PetscDSSetBdResidual(newprob, f, f0Bd, f1Bd);CHKERRQ(ierr);
2479da51fcedSMatthew G. Knepley     ierr = PetscDSSetRiemannSolver(newprob, f, r);CHKERRQ(ierr);
2480da51fcedSMatthew G. Knepley     for (g = 0; g < Nf; ++g) {
2481da51fcedSMatthew G. Knepley       ierr = PetscDSGetJacobian(prob, f, g, &g0, &g1, &g2, &g3);CHKERRQ(ierr);
2482da51fcedSMatthew G. Knepley       ierr = PetscDSGetBdJacobian(prob, f, g, &g0Bd, &g1Bd, &g2Bd, &g3Bd);CHKERRQ(ierr);
2483da51fcedSMatthew G. Knepley       ierr = PetscDSSetJacobian(newprob, f, g, g0, g1, g2, g3);CHKERRQ(ierr);
2484da51fcedSMatthew G. Knepley       ierr = PetscDSSetBdJacobian(newprob, f, g, g0Bd, g1Bd, g2Bd, g3Bd);CHKERRQ(ierr);
2485da51fcedSMatthew G. Knepley     }
2486da51fcedSMatthew G. Knepley   }
2487da51fcedSMatthew G. Knepley   PetscFunctionReturn(0);
2488da51fcedSMatthew G. Knepley }
2489da51fcedSMatthew G. Knepley 
2490bc4ae4beSMatthew G. Knepley static PetscErrorCode PetscDSDestroy_Basic(PetscDS prob)
24912764a2aaSMatthew G. Knepley {
2492931fb3b8SToby Isaac   PetscErrorCode      ierr;
2493931fb3b8SToby Isaac 
24942764a2aaSMatthew G. Knepley   PetscFunctionBegin;
2495931fb3b8SToby Isaac   ierr = PetscFree(prob->data);CHKERRQ(ierr);
24962764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
24972764a2aaSMatthew G. Knepley }
24982764a2aaSMatthew G. Knepley 
2499bc4ae4beSMatthew G. Knepley static PetscErrorCode PetscDSInitialize_Basic(PetscDS prob)
25002764a2aaSMatthew G. Knepley {
25012764a2aaSMatthew G. Knepley   PetscFunctionBegin;
25022764a2aaSMatthew G. Knepley   prob->ops->setfromoptions = NULL;
25032764a2aaSMatthew G. Knepley   prob->ops->setup          = NULL;
25042764a2aaSMatthew G. Knepley   prob->ops->view           = NULL;
25052764a2aaSMatthew G. Knepley   prob->ops->destroy        = PetscDSDestroy_Basic;
25062764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
25072764a2aaSMatthew G. Knepley }
25082764a2aaSMatthew G. Knepley 
25092764a2aaSMatthew G. Knepley /*MC
25102764a2aaSMatthew G. Knepley   PETSCDSBASIC = "basic" - A discrete system with pointwise residual and boundary residual functions
25112764a2aaSMatthew G. Knepley 
25122764a2aaSMatthew G. Knepley   Level: intermediate
25132764a2aaSMatthew G. Knepley 
25142764a2aaSMatthew G. Knepley .seealso: PetscDSType, PetscDSCreate(), PetscDSSetType()
25152764a2aaSMatthew G. Knepley M*/
25162764a2aaSMatthew G. Knepley 
25172764a2aaSMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscDSCreate_Basic(PetscDS prob)
25182764a2aaSMatthew G. Knepley {
25192764a2aaSMatthew G. Knepley   PetscDS_Basic *b;
25202764a2aaSMatthew G. Knepley   PetscErrorCode      ierr;
25212764a2aaSMatthew G. Knepley 
25222764a2aaSMatthew G. Knepley   PetscFunctionBegin;
2523931fb3b8SToby Isaac   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
25242764a2aaSMatthew G. Knepley   ierr       = PetscNewLog(prob, &b);CHKERRQ(ierr);
25252764a2aaSMatthew G. Knepley   prob->data = b;
25262764a2aaSMatthew G. Knepley 
25272764a2aaSMatthew G. Knepley   ierr = PetscDSInitialize_Basic(prob);CHKERRQ(ierr);
25282764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
25292764a2aaSMatthew G. Knepley }
2530