xref: /petsc/src/dm/dt/interface/dtds.c (revision 1cf84007adf5c108639c0d32cd590b65feee66a2)
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;
12297b6e6e8SMatthew G. Knepley   const PetscScalar *constants;
12397b6e6e8SMatthew G. Knepley   PetscInt           numConstants, f;
1247d8a60eaSMatthew G. Knepley   PetscErrorCode     ierr;
1257d8a60eaSMatthew G. Knepley 
1267d8a60eaSMatthew G. Knepley   PetscFunctionBegin;
1277d8a60eaSMatthew G. Knepley   ierr = PetscViewerGetFormat(viewer, &format);CHKERRQ(ierr);
1287d8a60eaSMatthew G. Knepley   ierr = PetscViewerASCIIPrintf(viewer, "Discrete System with %d fields\n", prob->Nf);CHKERRQ(ierr);
1297d8a60eaSMatthew G. Knepley   ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1307d8a60eaSMatthew G. Knepley   for (f = 0; f < prob->Nf; ++f) {
1317d8a60eaSMatthew G. Knepley     PetscObject  obj;
1327d8a60eaSMatthew G. Knepley     PetscClassId id;
1337d8a60eaSMatthew G. Knepley     const char  *name;
1347d8a60eaSMatthew G. Knepley     PetscInt     Nc;
1357d8a60eaSMatthew G. Knepley 
1367d8a60eaSMatthew G. Knepley     ierr = PetscDSGetDiscretization(prob, f, &obj);CHKERRQ(ierr);
1377d8a60eaSMatthew G. Knepley     ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr);
1387d8a60eaSMatthew G. Knepley     ierr = PetscObjectGetName(obj, &name);CHKERRQ(ierr);
1397d8a60eaSMatthew G. Knepley     ierr = PetscViewerASCIIPrintf(viewer, "Field %s", name ? name : "<unknown>");CHKERRQ(ierr);
1407d8a60eaSMatthew G. Knepley     if (id == PETSCFE_CLASSID)      {
1417d8a60eaSMatthew G. Knepley       ierr = PetscFEGetNumComponents((PetscFE) obj, &Nc);CHKERRQ(ierr);
1427d8a60eaSMatthew G. Knepley       ierr = PetscViewerASCIIPrintf(viewer, " FEM");CHKERRQ(ierr);
1437d8a60eaSMatthew G. Knepley     } else if (id == PETSCFV_CLASSID) {
1447d8a60eaSMatthew G. Knepley       ierr = PetscFVGetNumComponents((PetscFV) obj, &Nc);CHKERRQ(ierr);
1457d8a60eaSMatthew G. Knepley       ierr = PetscViewerASCIIPrintf(viewer, " FVM");CHKERRQ(ierr);
1467d8a60eaSMatthew G. Knepley     }
14797b6e6e8SMatthew G. Knepley     else SETERRQ1(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Unknown discretization type for field %D", f);
14897b6e6e8SMatthew G. Knepley     if (Nc > 1) {ierr = PetscViewerASCIIPrintf(viewer, "%D components", Nc);CHKERRQ(ierr);}
14997b6e6e8SMatthew G. Knepley     else        {ierr = PetscViewerASCIIPrintf(viewer, "%D component ", Nc);CHKERRQ(ierr);}
150249df284SMatthew G. Knepley     if (prob->implicit[f]) {ierr = PetscViewerASCIIPrintf(viewer, " (implicit)");CHKERRQ(ierr);}
151249df284SMatthew G. Knepley     else                   {ierr = PetscViewerASCIIPrintf(viewer, " (explicit)");CHKERRQ(ierr);}
152a6cbbb48SMatthew G. Knepley     if (prob->adjacency[f*2+0]) {
153a6cbbb48SMatthew G. Knepley       if (prob->adjacency[f*2+1]) {ierr = PetscViewerASCIIPrintf(viewer, " (adj FVM++)");CHKERRQ(ierr);}
154a6cbbb48SMatthew G. Knepley       else                        {ierr = PetscViewerASCIIPrintf(viewer, " (adj FVM)");CHKERRQ(ierr);}
155a6cbbb48SMatthew G. Knepley     } else {
156a6cbbb48SMatthew G. Knepley       if (prob->adjacency[f*2+1]) {ierr = PetscViewerASCIIPrintf(viewer, " (adj FEM)");CHKERRQ(ierr);}
157a6cbbb48SMatthew G. Knepley       else                        {ierr = PetscViewerASCIIPrintf(viewer, " (adj FUNKY)");CHKERRQ(ierr);}
158a6cbbb48SMatthew G. Knepley     }
1597d8a60eaSMatthew G. Knepley     ierr = PetscViewerASCIIPrintf(viewer, "\n");CHKERRQ(ierr);
1607d8a60eaSMatthew G. Knepley     if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
1617d8a60eaSMatthew G. Knepley       if (id == PETSCFE_CLASSID)      {ierr = PetscFEView((PetscFE) obj, viewer);CHKERRQ(ierr);}
1627d8a60eaSMatthew G. Knepley       else if (id == PETSCFV_CLASSID) {ierr = PetscFVView((PetscFV) obj, viewer);CHKERRQ(ierr);}
1637d8a60eaSMatthew G. Knepley     }
1647d8a60eaSMatthew G. Knepley   }
16597b6e6e8SMatthew G. Knepley   ierr = PetscDSGetConstants(prob, &numConstants, &constants);CHKERRQ(ierr);
16697b6e6e8SMatthew G. Knepley   if (numConstants) {
16797b6e6e8SMatthew G. Knepley     ierr = PetscViewerASCIIPrintf(viewer, "%D constants\n", numConstants);CHKERRQ(ierr);
16897b6e6e8SMatthew G. Knepley     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
16957fc01e9SMatthew G. Knepley     for (f = 0; f < numConstants; ++f) {ierr = PetscViewerASCIIPrintf(viewer, "%g\n", (double) PetscRealPart(constants[f]));CHKERRQ(ierr);}
17097b6e6e8SMatthew G. Knepley     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
17197b6e6e8SMatthew G. Knepley   }
1727d8a60eaSMatthew G. Knepley   ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1737d8a60eaSMatthew G. Knepley   PetscFunctionReturn(0);
1747d8a60eaSMatthew G. Knepley }
1757d8a60eaSMatthew G. Knepley 
1762764a2aaSMatthew G. Knepley /*@C
1772764a2aaSMatthew G. Knepley   PetscDSView - Views a PetscDS
1782764a2aaSMatthew G. Knepley 
1792764a2aaSMatthew G. Knepley   Collective on PetscDS
1802764a2aaSMatthew G. Knepley 
1812764a2aaSMatthew G. Knepley   Input Parameter:
1822764a2aaSMatthew G. Knepley + prob - the PetscDS object to view
1832764a2aaSMatthew G. Knepley - v  - the viewer
1842764a2aaSMatthew G. Knepley 
1852764a2aaSMatthew G. Knepley   Level: developer
1862764a2aaSMatthew G. Knepley 
1872764a2aaSMatthew G. Knepley .seealso PetscDSDestroy()
1882764a2aaSMatthew G. Knepley @*/
1892764a2aaSMatthew G. Knepley PetscErrorCode PetscDSView(PetscDS prob, PetscViewer v)
1902764a2aaSMatthew G. Knepley {
1917d8a60eaSMatthew G. Knepley   PetscBool      iascii;
1922764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
1932764a2aaSMatthew G. Knepley 
1942764a2aaSMatthew G. Knepley   PetscFunctionBegin;
1952764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1962764a2aaSMatthew G. Knepley   if (!v) {ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject) prob), &v);CHKERRQ(ierr);}
1977d8a60eaSMatthew G. Knepley   else    {PetscValidHeaderSpecific(v, PETSC_VIEWER_CLASSID, 2);}
1987d8a60eaSMatthew G. Knepley   ierr = PetscObjectTypeCompare((PetscObject) v, PETSCVIEWERASCII, &iascii);CHKERRQ(ierr);
1997d8a60eaSMatthew G. Knepley   if (iascii) {ierr = PetscDSView_Ascii(prob, v);CHKERRQ(ierr);}
2002764a2aaSMatthew G. Knepley   if (prob->ops->view) {ierr = (*prob->ops->view)(prob, v);CHKERRQ(ierr);}
2012764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
2022764a2aaSMatthew G. Knepley }
2032764a2aaSMatthew G. Knepley 
2042764a2aaSMatthew G. Knepley /*@
2052764a2aaSMatthew G. Knepley   PetscDSSetFromOptions - sets parameters in a PetscDS from the options database
2062764a2aaSMatthew G. Knepley 
2072764a2aaSMatthew G. Knepley   Collective on PetscDS
2082764a2aaSMatthew G. Knepley 
2092764a2aaSMatthew G. Knepley   Input Parameter:
2102764a2aaSMatthew G. Knepley . prob - the PetscDS object to set options for
2112764a2aaSMatthew G. Knepley 
2122764a2aaSMatthew G. Knepley   Options Database:
2132764a2aaSMatthew G. Knepley 
2142764a2aaSMatthew G. Knepley   Level: developer
2152764a2aaSMatthew G. Knepley 
2162764a2aaSMatthew G. Knepley .seealso PetscDSView()
2172764a2aaSMatthew G. Knepley @*/
2182764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetFromOptions(PetscDS prob)
2192764a2aaSMatthew G. Knepley {
220f1fd5e65SToby Isaac   DSBoundary     b;
2212764a2aaSMatthew G. Knepley   const char    *defaultType;
2222764a2aaSMatthew G. Knepley   char           name[256];
2232764a2aaSMatthew G. Knepley   PetscBool      flg;
2242764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
2252764a2aaSMatthew G. Knepley 
2262764a2aaSMatthew G. Knepley   PetscFunctionBegin;
2272764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2282764a2aaSMatthew G. Knepley   if (!((PetscObject) prob)->type_name) {
2292764a2aaSMatthew G. Knepley     defaultType = PETSCDSBASIC;
2302764a2aaSMatthew G. Knepley   } else {
2312764a2aaSMatthew G. Knepley     defaultType = ((PetscObject) prob)->type_name;
2322764a2aaSMatthew G. Knepley   }
2330f51fdf8SToby Isaac   ierr = PetscDSRegisterAll();CHKERRQ(ierr);
2342764a2aaSMatthew G. Knepley 
2352764a2aaSMatthew G. Knepley   ierr = PetscObjectOptionsBegin((PetscObject) prob);CHKERRQ(ierr);
236f1fd5e65SToby Isaac   for (b = prob->boundary; b; b = b->next) {
237f1fd5e65SToby Isaac     char       optname[1024];
238f1fd5e65SToby Isaac     PetscInt   ids[1024], len = 1024;
239f1fd5e65SToby Isaac     PetscBool  flg;
240f1fd5e65SToby Isaac 
241f1fd5e65SToby Isaac     ierr = PetscSNPrintf(optname, sizeof(optname), "-bc_%s", b->name);CHKERRQ(ierr);
242f1fd5e65SToby Isaac     ierr = PetscMemzero(ids, sizeof(ids));CHKERRQ(ierr);
243f1fd5e65SToby Isaac     ierr = PetscOptionsIntArray(optname, "List of boundary IDs", "", ids, &len, &flg);CHKERRQ(ierr);
244f1fd5e65SToby Isaac     if (flg) {
245f1fd5e65SToby Isaac       b->numids = len;
246f1fd5e65SToby Isaac       ierr = PetscFree(b->ids);CHKERRQ(ierr);
247f1fd5e65SToby Isaac       ierr = PetscMalloc1(len, &b->ids);CHKERRQ(ierr);
248f1fd5e65SToby Isaac       ierr = PetscMemcpy(b->ids, ids, len*sizeof(PetscInt));CHKERRQ(ierr);
249f1fd5e65SToby Isaac     }
250e7b0402cSSander Arens     len = 1024;
251f1fd5e65SToby Isaac     ierr = PetscSNPrintf(optname, sizeof(optname), "-bc_%s_comp", b->name);CHKERRQ(ierr);
252f1fd5e65SToby Isaac     ierr = PetscMemzero(ids, sizeof(ids));CHKERRQ(ierr);
253f1fd5e65SToby Isaac     ierr = PetscOptionsIntArray(optname, "List of boundary field components", "", ids, &len, &flg);CHKERRQ(ierr);
254f1fd5e65SToby Isaac     if (flg) {
255f1fd5e65SToby Isaac       b->numcomps = len;
256f1fd5e65SToby Isaac       ierr = PetscFree(b->comps);CHKERRQ(ierr);
257f1fd5e65SToby Isaac       ierr = PetscMalloc1(len, &b->comps);CHKERRQ(ierr);
258f1fd5e65SToby Isaac       ierr = PetscMemcpy(b->comps, ids, len*sizeof(PetscInt));CHKERRQ(ierr);
259f1fd5e65SToby Isaac     }
260f1fd5e65SToby Isaac   }
2612764a2aaSMatthew G. Knepley   ierr = PetscOptionsFList("-petscds_type", "Discrete System", "PetscDSSetType", PetscDSList, defaultType, name, 256, &flg);CHKERRQ(ierr);
2622764a2aaSMatthew G. Knepley   if (flg) {
2632764a2aaSMatthew G. Knepley     ierr = PetscDSSetType(prob, name);CHKERRQ(ierr);
2642764a2aaSMatthew G. Knepley   } else if (!((PetscObject) prob)->type_name) {
2652764a2aaSMatthew G. Knepley     ierr = PetscDSSetType(prob, defaultType);CHKERRQ(ierr);
2662764a2aaSMatthew G. Knepley   }
2672764a2aaSMatthew G. Knepley   if (prob->ops->setfromoptions) {ierr = (*prob->ops->setfromoptions)(prob);CHKERRQ(ierr);}
2682764a2aaSMatthew G. Knepley   /* process any options handlers added with PetscObjectAddOptionsHandler() */
2690633abcbSJed Brown   ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject) prob);CHKERRQ(ierr);
2702764a2aaSMatthew G. Knepley   ierr = PetscOptionsEnd();CHKERRQ(ierr);
2712764a2aaSMatthew G. Knepley   ierr = PetscDSViewFromOptions(prob, NULL, "-petscds_view");CHKERRQ(ierr);
2722764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
2732764a2aaSMatthew G. Knepley }
2742764a2aaSMatthew G. Knepley 
2752764a2aaSMatthew G. Knepley /*@C
2762764a2aaSMatthew G. Knepley   PetscDSSetUp - Construct data structures for the PetscDS
2772764a2aaSMatthew G. Knepley 
2782764a2aaSMatthew G. Knepley   Collective on PetscDS
2792764a2aaSMatthew G. Knepley 
2802764a2aaSMatthew G. Knepley   Input Parameter:
2812764a2aaSMatthew G. Knepley . prob - the PetscDS object to setup
2822764a2aaSMatthew G. Knepley 
2832764a2aaSMatthew G. Knepley   Level: developer
2842764a2aaSMatthew G. Knepley 
2852764a2aaSMatthew G. Knepley .seealso PetscDSView(), PetscDSDestroy()
2862764a2aaSMatthew G. Knepley @*/
2872764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetUp(PetscDS prob)
2882764a2aaSMatthew G. Knepley {
2892764a2aaSMatthew G. Knepley   const PetscInt Nf = prob->Nf;
2902764a2aaSMatthew G. Knepley   PetscInt       dim, work, NcMax = 0, NqMax = 0, f;
2912764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
2922764a2aaSMatthew G. Knepley 
2932764a2aaSMatthew G. Knepley   PetscFunctionBegin;
2942764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2952764a2aaSMatthew G. Knepley   if (prob->setup) PetscFunctionReturn(0);
2962764a2aaSMatthew G. Knepley   /* Calculate sizes */
2972764a2aaSMatthew G. Knepley   ierr = PetscDSGetSpatialDimension(prob, &dim);CHKERRQ(ierr);
298f744cafaSSander Arens   prob->totDim = prob->totComp = 0;
29947e57110SSander Arens   ierr = PetscMalloc2(Nf,&prob->Nc,Nf,&prob->Nb);CHKERRQ(ierr);
300f744cafaSSander Arens   ierr = PetscCalloc2(Nf+1,&prob->off,Nf+1,&prob->offDer);CHKERRQ(ierr);
301f744cafaSSander Arens   ierr = PetscMalloc4(Nf,&prob->basis,Nf,&prob->basisDer,Nf,&prob->basisFace,Nf,&prob->basisDerFace);CHKERRQ(ierr);
3022764a2aaSMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
3039de99aefSMatthew G. Knepley     PetscObject     obj;
3049de99aefSMatthew G. Knepley     PetscClassId    id;
3052764a2aaSMatthew G. Knepley     PetscQuadrature q;
3069de99aefSMatthew G. Knepley     PetscInt        Nq = 0, Nb, Nc;
3072764a2aaSMatthew G. Knepley 
3089de99aefSMatthew G. Knepley     ierr = PetscDSGetDiscretization(prob, f, &obj);CHKERRQ(ierr);
3099de99aefSMatthew G. Knepley     ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr);
3109de99aefSMatthew G. Knepley     if (id == PETSCFE_CLASSID)      {
3119de99aefSMatthew G. Knepley       PetscFE fe = (PetscFE) obj;
3129de99aefSMatthew G. Knepley 
3132764a2aaSMatthew G. Knepley       ierr = PetscFEGetQuadrature(fe, &q);CHKERRQ(ierr);
3142764a2aaSMatthew G. Knepley       ierr = PetscFEGetDimension(fe, &Nb);CHKERRQ(ierr);
3152764a2aaSMatthew G. Knepley       ierr = PetscFEGetNumComponents(fe, &Nc);CHKERRQ(ierr);
3162764a2aaSMatthew G. Knepley       ierr = PetscFEGetDefaultTabulation(fe, &prob->basis[f], &prob->basisDer[f], NULL);CHKERRQ(ierr);
3174d0b9603SSander Arens       ierr = PetscFEGetFaceTabulation(fe, &prob->basisFace[f], &prob->basisDerFace[f], NULL);CHKERRQ(ierr);
3189de99aefSMatthew G. Knepley     } else if (id == PETSCFV_CLASSID) {
3199de99aefSMatthew G. Knepley       PetscFV fv = (PetscFV) obj;
3209de99aefSMatthew G. Knepley 
3219de99aefSMatthew G. Knepley       ierr = PetscFVGetQuadrature(fv, &q);CHKERRQ(ierr);
3229de99aefSMatthew G. Knepley       ierr = PetscFVGetNumComponents(fv, &Nc);CHKERRQ(ierr);
3239c3cf19fSMatthew G. Knepley       Nb   = Nc;
3246c1a3d01SMatthew G. Knepley       ierr = PetscFVGetDefaultTabulation(fv, &prob->basis[f], &prob->basisDer[f], NULL);CHKERRQ(ierr);
3254d0b9603SSander Arens       /* TODO: should PetscFV also have face tabulation? Otherwise there will be a null pointer in prob->basisFace */
326abac5ca0SMatthew G. Knepley     } else SETERRQ1(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Unknown discretization type for field %d", f);
32747e57110SSander Arens     prob->Nc[f]       = Nc;
32847e57110SSander Arens     prob->Nb[f]       = Nb;
329194d53e6SMatthew G. Knepley     prob->off[f+1]    = Nc     + prob->off[f];
330194d53e6SMatthew G. Knepley     prob->offDer[f+1] = Nc*dim + prob->offDer[f];
331a6b92713SMatthew G. Knepley     if (q) {ierr = PetscQuadratureGetData(q, NULL, NULL, &Nq, NULL, NULL);CHKERRQ(ierr);}
3322764a2aaSMatthew G. Knepley     NqMax          = PetscMax(NqMax, Nq);
3332764a2aaSMatthew G. Knepley     NcMax          = PetscMax(NcMax, Nc);
3349c3cf19fSMatthew G. Knepley     prob->totDim  += Nb;
3352764a2aaSMatthew G. Knepley     prob->totComp += Nc;
3362764a2aaSMatthew G. Knepley   }
3372764a2aaSMatthew G. Knepley   work = PetscMax(prob->totComp*dim, PetscSqr(NcMax*dim));
3382764a2aaSMatthew G. Knepley   /* Allocate works space */
3392764a2aaSMatthew 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);
3402764a2aaSMatthew 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);
3412764a2aaSMatthew G. Knepley   if (prob->ops->setup) {ierr = (*prob->ops->setup)(prob);CHKERRQ(ierr);}
3422764a2aaSMatthew G. Knepley   prob->setup = PETSC_TRUE;
3432764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
3442764a2aaSMatthew G. Knepley }
3452764a2aaSMatthew G. Knepley 
3462764a2aaSMatthew G. Knepley static PetscErrorCode PetscDSDestroyStructs_Static(PetscDS prob)
3472764a2aaSMatthew G. Knepley {
3482764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
3492764a2aaSMatthew G. Knepley 
3502764a2aaSMatthew G. Knepley   PetscFunctionBegin;
35147e57110SSander Arens   ierr = PetscFree2(prob->Nc,prob->Nb);CHKERRQ(ierr);
352f744cafaSSander Arens   ierr = PetscFree2(prob->off,prob->offDer);CHKERRQ(ierr);
353f744cafaSSander Arens   ierr = PetscFree4(prob->basis,prob->basisDer,prob->basisFace,prob->basisDerFace);CHKERRQ(ierr);
3542764a2aaSMatthew G. Knepley   ierr = PetscFree5(prob->u,prob->u_t,prob->u_x,prob->x,prob->refSpaceDer);CHKERRQ(ierr);
3552764a2aaSMatthew G. Knepley   ierr = PetscFree6(prob->f0,prob->f1,prob->g0,prob->g1,prob->g2,prob->g3);CHKERRQ(ierr);
3562764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
3572764a2aaSMatthew G. Knepley }
3582764a2aaSMatthew G. Knepley 
3592764a2aaSMatthew G. Knepley static PetscErrorCode PetscDSEnlarge_Static(PetscDS prob, PetscInt NfNew)
3602764a2aaSMatthew G. Knepley {
361f744cafaSSander Arens   PetscObject      *tmpd;
362a6cbbb48SMatthew G. Knepley   PetscBool        *tmpi, *tmpa;
36332d2bbc9SMatthew G. Knepley   PetscPointFunc   *tmpobj, *tmpf, *tmpup;
364b7e05686SMatthew G. Knepley   PetscPointJac    *tmpg, *tmpgp, *tmpgt;
3652aa1fc23SMatthew G. Knepley   PetscBdPointFunc *tmpfbd;
3662aa1fc23SMatthew G. Knepley   PetscBdPointJac  *tmpgbd;
367194d53e6SMatthew G. Knepley   PetscRiemannFunc *tmpr;
368c371a6d1SMatthew G. Knepley   PetscSimplePointFunc *tmpexactSol;
3690c2f2876SMatthew G. Knepley   void            **tmpctx;
370a6cbbb48SMatthew G. Knepley   PetscInt          Nf = prob->Nf, f, i;
3712764a2aaSMatthew G. Knepley   PetscErrorCode    ierr;
3722764a2aaSMatthew G. Knepley 
3732764a2aaSMatthew G. Knepley   PetscFunctionBegin;
3742764a2aaSMatthew G. Knepley   if (Nf >= NfNew) PetscFunctionReturn(0);
3752764a2aaSMatthew G. Knepley   prob->setup = PETSC_FALSE;
3762764a2aaSMatthew G. Knepley   ierr = PetscDSDestroyStructs_Static(prob);CHKERRQ(ierr);
377f744cafaSSander Arens   ierr = PetscMalloc3(NfNew, &tmpd, NfNew, &tmpi, NfNew*2, &tmpa);CHKERRQ(ierr);
378f744cafaSSander 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];}
379f744cafaSSander 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;}
380f744cafaSSander Arens   ierr = PetscFree3(prob->disc, prob->implicit, prob->adjacency);CHKERRQ(ierr);
3812764a2aaSMatthew G. Knepley   prob->Nf        = NfNew;
3822764a2aaSMatthew G. Knepley   prob->disc      = tmpd;
383249df284SMatthew G. Knepley   prob->implicit  = tmpi;
384a6cbbb48SMatthew G. Knepley   prob->adjacency = tmpa;
385b7e05686SMatthew 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);
38632d2bbc9SMatthew G. Knepley   ierr = PetscCalloc1(NfNew, &tmpup);CHKERRQ(ierr);
3872764a2aaSMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpobj[f] = prob->obj[f];
3882764a2aaSMatthew G. Knepley   for (f = 0; f < Nf*2; ++f) tmpf[f] = prob->f[f];
3892764a2aaSMatthew G. Knepley   for (f = 0; f < Nf*Nf*4; ++f) tmpg[f] = prob->g[f];
390475e0ac9SMatthew G. Knepley   for (f = 0; f < Nf*Nf*4; ++f) tmpgp[f] = prob->gp[f];
3910c2f2876SMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpr[f] = prob->r[f];
39232d2bbc9SMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpup[f] = prob->update[f];
3930c2f2876SMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpctx[f] = prob->ctx[f];
3942764a2aaSMatthew G. Knepley   for (f = Nf; f < NfNew; ++f) tmpobj[f] = NULL;
3952764a2aaSMatthew G. Knepley   for (f = Nf*2; f < NfNew*2; ++f) tmpf[f] = NULL;
3962764a2aaSMatthew G. Knepley   for (f = Nf*Nf*4; f < NfNew*NfNew*4; ++f) tmpg[f] = NULL;
397475e0ac9SMatthew G. Knepley   for (f = Nf*Nf*4; f < NfNew*NfNew*4; ++f) tmpgp[f] = NULL;
398b7e05686SMatthew G. Knepley   for (f = Nf*Nf*4; f < NfNew*NfNew*4; ++f) tmpgt[f] = NULL;
3990c2f2876SMatthew G. Knepley   for (f = Nf; f < NfNew; ++f) tmpr[f] = NULL;
40032d2bbc9SMatthew G. Knepley   for (f = Nf; f < NfNew; ++f) tmpup[f] = NULL;
4010c2f2876SMatthew G. Knepley   for (f = Nf; f < NfNew; ++f) tmpctx[f] = NULL;
402b7e05686SMatthew G. Knepley   ierr = PetscFree7(prob->obj, prob->f, prob->g, prob->gp, prob->gt, prob->r, prob->ctx);CHKERRQ(ierr);
40332d2bbc9SMatthew G. Knepley   ierr = PetscFree(prob->update);CHKERRQ(ierr);
4042764a2aaSMatthew G. Knepley   prob->obj = tmpobj;
4052764a2aaSMatthew G. Knepley   prob->f   = tmpf;
4062764a2aaSMatthew G. Knepley   prob->g   = tmpg;
407475e0ac9SMatthew G. Knepley   prob->gp  = tmpgp;
408b7e05686SMatthew G. Knepley   prob->gt  = tmpgt;
4090c2f2876SMatthew G. Knepley   prob->r   = tmpr;
41032d2bbc9SMatthew G. Knepley   prob->update = tmpup;
4110c2f2876SMatthew G. Knepley   prob->ctx = tmpctx;
412c371a6d1SMatthew G. Knepley   ierr = PetscCalloc3(NfNew*2, &tmpfbd, NfNew*NfNew*4, &tmpgbd, NfNew, &tmpexactSol);CHKERRQ(ierr);
4132764a2aaSMatthew G. Knepley   for (f = 0; f < Nf*2; ++f) tmpfbd[f] = prob->fBd[f];
4142764a2aaSMatthew G. Knepley   for (f = 0; f < Nf*Nf*4; ++f) tmpgbd[f] = prob->gBd[f];
415c371a6d1SMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpexactSol[f] = prob->exactSol[f];
4162764a2aaSMatthew G. Knepley   for (f = Nf*2; f < NfNew*2; ++f) tmpfbd[f] = NULL;
4172764a2aaSMatthew G. Knepley   for (f = Nf*Nf*4; f < NfNew*NfNew*4; ++f) tmpgbd[f] = NULL;
418c371a6d1SMatthew G. Knepley   for (f = Nf; f < NfNew; ++f) tmpexactSol[f] = NULL;
419c371a6d1SMatthew G. Knepley   ierr = PetscFree3(prob->fBd, prob->gBd, prob->exactSol);CHKERRQ(ierr);
4202764a2aaSMatthew G. Knepley   prob->fBd = tmpfbd;
4212764a2aaSMatthew G. Knepley   prob->gBd = tmpgbd;
422c371a6d1SMatthew G. Knepley   prob->exactSol = tmpexactSol;
4232764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
4242764a2aaSMatthew G. Knepley }
4252764a2aaSMatthew G. Knepley 
4262764a2aaSMatthew G. Knepley /*@
4272764a2aaSMatthew G. Knepley   PetscDSDestroy - Destroys a PetscDS object
4282764a2aaSMatthew G. Knepley 
4292764a2aaSMatthew G. Knepley   Collective on PetscDS
4302764a2aaSMatthew G. Knepley 
4312764a2aaSMatthew G. Knepley   Input Parameter:
4322764a2aaSMatthew G. Knepley . prob - the PetscDS object to destroy
4332764a2aaSMatthew G. Knepley 
4342764a2aaSMatthew G. Knepley   Level: developer
4352764a2aaSMatthew G. Knepley 
4362764a2aaSMatthew G. Knepley .seealso PetscDSView()
4372764a2aaSMatthew G. Knepley @*/
4382764a2aaSMatthew G. Knepley PetscErrorCode PetscDSDestroy(PetscDS *prob)
4392764a2aaSMatthew G. Knepley {
4402764a2aaSMatthew G. Knepley   PetscInt       f;
44158ebd649SToby Isaac   DSBoundary     next;
4422764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
4432764a2aaSMatthew G. Knepley 
4442764a2aaSMatthew G. Knepley   PetscFunctionBegin;
4452764a2aaSMatthew G. Knepley   if (!*prob) PetscFunctionReturn(0);
4462764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific((*prob), PETSCDS_CLASSID, 1);
4472764a2aaSMatthew G. Knepley 
4482764a2aaSMatthew G. Knepley   if (--((PetscObject)(*prob))->refct > 0) {*prob = 0; PetscFunctionReturn(0);}
4492764a2aaSMatthew G. Knepley   ((PetscObject) (*prob))->refct = 0;
4502764a2aaSMatthew G. Knepley   ierr = PetscDSDestroyStructs_Static(*prob);CHKERRQ(ierr);
4512764a2aaSMatthew G. Knepley   for (f = 0; f < (*prob)->Nf; ++f) {
4522764a2aaSMatthew G. Knepley     ierr = PetscObjectDereference((*prob)->disc[f]);CHKERRQ(ierr);
4532764a2aaSMatthew G. Knepley   }
454f744cafaSSander Arens   ierr = PetscFree3((*prob)->disc, (*prob)->implicit, (*prob)->adjacency);CHKERRQ(ierr);
455b7e05686SMatthew G. Knepley   ierr = PetscFree7((*prob)->obj,(*prob)->f,(*prob)->g,(*prob)->gp,(*prob)->gt,(*prob)->r,(*prob)->ctx);CHKERRQ(ierr);
45632d2bbc9SMatthew G. Knepley   ierr = PetscFree((*prob)->update);CHKERRQ(ierr);
457c371a6d1SMatthew G. Knepley   ierr = PetscFree3((*prob)->fBd,(*prob)->gBd,(*prob)->exactSol);CHKERRQ(ierr);
4582764a2aaSMatthew G. Knepley   if ((*prob)->ops->destroy) {ierr = (*(*prob)->ops->destroy)(*prob);CHKERRQ(ierr);}
45958ebd649SToby Isaac   next = (*prob)->boundary;
46058ebd649SToby Isaac   while (next) {
46158ebd649SToby Isaac     DSBoundary b = next;
46258ebd649SToby Isaac 
46358ebd649SToby Isaac     next = b->next;
46458ebd649SToby Isaac     ierr = PetscFree(b->comps);CHKERRQ(ierr);
46558ebd649SToby Isaac     ierr = PetscFree(b->ids);CHKERRQ(ierr);
46658ebd649SToby Isaac     ierr = PetscFree(b->name);CHKERRQ(ierr);
46758ebd649SToby Isaac     ierr = PetscFree(b->labelname);CHKERRQ(ierr);
46858ebd649SToby Isaac     ierr = PetscFree(b);CHKERRQ(ierr);
46958ebd649SToby Isaac   }
47097b6e6e8SMatthew G. Knepley   ierr = PetscFree((*prob)->constants);CHKERRQ(ierr);
4712764a2aaSMatthew G. Knepley   ierr = PetscHeaderDestroy(prob);CHKERRQ(ierr);
4722764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
4732764a2aaSMatthew G. Knepley }
4742764a2aaSMatthew G. Knepley 
4752764a2aaSMatthew G. Knepley /*@
4762764a2aaSMatthew G. Knepley   PetscDSCreate - Creates an empty PetscDS object. The type can then be set with PetscDSSetType().
4772764a2aaSMatthew G. Knepley 
4782764a2aaSMatthew G. Knepley   Collective on MPI_Comm
4792764a2aaSMatthew G. Knepley 
4802764a2aaSMatthew G. Knepley   Input Parameter:
4812764a2aaSMatthew G. Knepley . comm - The communicator for the PetscDS object
4822764a2aaSMatthew G. Knepley 
4832764a2aaSMatthew G. Knepley   Output Parameter:
4842764a2aaSMatthew G. Knepley . prob - The PetscDS object
4852764a2aaSMatthew G. Knepley 
4862764a2aaSMatthew G. Knepley   Level: beginner
4872764a2aaSMatthew G. Knepley 
4882764a2aaSMatthew G. Knepley .seealso: PetscDSSetType(), PETSCDSBASIC
4892764a2aaSMatthew G. Knepley @*/
4902764a2aaSMatthew G. Knepley PetscErrorCode PetscDSCreate(MPI_Comm comm, PetscDS *prob)
4912764a2aaSMatthew G. Knepley {
4922764a2aaSMatthew G. Knepley   PetscDS   p;
4932764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
4942764a2aaSMatthew G. Knepley 
4952764a2aaSMatthew G. Knepley   PetscFunctionBegin;
4962764a2aaSMatthew G. Knepley   PetscValidPointer(prob, 2);
4972764a2aaSMatthew G. Knepley   *prob  = NULL;
4982764a2aaSMatthew G. Knepley   ierr = PetscDSInitializePackage();CHKERRQ(ierr);
4992764a2aaSMatthew G. Knepley 
50073107ff1SLisandro Dalcin   ierr = PetscHeaderCreate(p, PETSCDS_CLASSID, "PetscDS", "Discrete System", "PetscDS", comm, PetscDSDestroy, PetscDSView);CHKERRQ(ierr);
5012764a2aaSMatthew G. Knepley 
5022764a2aaSMatthew G. Knepley   p->Nf    = 0;
5032764a2aaSMatthew G. Knepley   p->setup = PETSC_FALSE;
50497b6e6e8SMatthew G. Knepley   p->numConstants = 0;
50597b6e6e8SMatthew G. Knepley   p->constants    = NULL;
5062764a2aaSMatthew G. Knepley 
5072764a2aaSMatthew G. Knepley   *prob = p;
5082764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
5092764a2aaSMatthew G. Knepley }
5102764a2aaSMatthew G. Knepley 
511bc4ae4beSMatthew G. Knepley /*@
512bc4ae4beSMatthew G. Knepley   PetscDSGetNumFields - Returns the number of fields in the DS
513bc4ae4beSMatthew G. Knepley 
514bc4ae4beSMatthew G. Knepley   Not collective
515bc4ae4beSMatthew G. Knepley 
516bc4ae4beSMatthew G. Knepley   Input Parameter:
517bc4ae4beSMatthew G. Knepley . prob - The PetscDS object
518bc4ae4beSMatthew G. Knepley 
519bc4ae4beSMatthew G. Knepley   Output Parameter:
520bc4ae4beSMatthew G. Knepley . Nf - The number of fields
521bc4ae4beSMatthew G. Knepley 
522bc4ae4beSMatthew G. Knepley   Level: beginner
523bc4ae4beSMatthew G. Knepley 
524bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetSpatialDimension(), PetscDSCreate()
525bc4ae4beSMatthew G. Knepley @*/
5262764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetNumFields(PetscDS prob, PetscInt *Nf)
5272764a2aaSMatthew G. Knepley {
5282764a2aaSMatthew G. Knepley   PetscFunctionBegin;
5292764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
5302764a2aaSMatthew G. Knepley   PetscValidPointer(Nf, 2);
5312764a2aaSMatthew G. Knepley   *Nf = prob->Nf;
5322764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
5332764a2aaSMatthew G. Knepley }
5342764a2aaSMatthew G. Knepley 
535bc4ae4beSMatthew G. Knepley /*@
536bc4ae4beSMatthew G. Knepley   PetscDSGetSpatialDimension - Returns the spatial dimension of the DS
537bc4ae4beSMatthew G. Knepley 
538bc4ae4beSMatthew G. Knepley   Not collective
539bc4ae4beSMatthew G. Knepley 
540bc4ae4beSMatthew G. Knepley   Input Parameter:
541bc4ae4beSMatthew G. Knepley . prob - The PetscDS object
542bc4ae4beSMatthew G. Knepley 
543bc4ae4beSMatthew G. Knepley   Output Parameter:
544bc4ae4beSMatthew G. Knepley . dim - The spatial dimension
545bc4ae4beSMatthew G. Knepley 
546bc4ae4beSMatthew G. Knepley   Level: beginner
547bc4ae4beSMatthew G. Knepley 
548bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetNumFields(), PetscDSCreate()
549bc4ae4beSMatthew G. Knepley @*/
5502764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetSpatialDimension(PetscDS prob, PetscInt *dim)
5512764a2aaSMatthew G. Knepley {
5522764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
5532764a2aaSMatthew G. Knepley 
5542764a2aaSMatthew G. Knepley   PetscFunctionBegin;
5552764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
5562764a2aaSMatthew G. Knepley   PetscValidPointer(dim, 2);
5572764a2aaSMatthew G. Knepley   *dim = 0;
5589de99aefSMatthew G. Knepley   if (prob->Nf) {
5599de99aefSMatthew G. Knepley     PetscObject  obj;
5609de99aefSMatthew G. Knepley     PetscClassId id;
5619de99aefSMatthew G. Knepley 
5629de99aefSMatthew G. Knepley     ierr = PetscDSGetDiscretization(prob, 0, &obj);CHKERRQ(ierr);
5639de99aefSMatthew G. Knepley     ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr);
5649de99aefSMatthew G. Knepley     if (id == PETSCFE_CLASSID)      {ierr = PetscFEGetSpatialDimension((PetscFE) obj, dim);CHKERRQ(ierr);}
5659de99aefSMatthew G. Knepley     else if (id == PETSCFV_CLASSID) {ierr = PetscFVGetSpatialDimension((PetscFV) obj, dim);CHKERRQ(ierr);}
5669de99aefSMatthew G. Knepley     else SETERRQ1(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Unknown discretization type for field %d", 0);
5679de99aefSMatthew G. Knepley   }
5682764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
5692764a2aaSMatthew G. Knepley }
5702764a2aaSMatthew G. Knepley 
571bc4ae4beSMatthew G. Knepley /*@
572bc4ae4beSMatthew G. Knepley   PetscDSGetTotalDimension - Returns the total size of the approximation space for this system
573bc4ae4beSMatthew G. Knepley 
574bc4ae4beSMatthew G. Knepley   Not collective
575bc4ae4beSMatthew G. Knepley 
576bc4ae4beSMatthew G. Knepley   Input Parameter:
577bc4ae4beSMatthew G. Knepley . prob - The PetscDS object
578bc4ae4beSMatthew G. Knepley 
579bc4ae4beSMatthew G. Knepley   Output Parameter:
580bc4ae4beSMatthew G. Knepley . dim - The total problem dimension
581bc4ae4beSMatthew G. Knepley 
582bc4ae4beSMatthew G. Knepley   Level: beginner
583bc4ae4beSMatthew G. Knepley 
584bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetNumFields(), PetscDSCreate()
585bc4ae4beSMatthew G. Knepley @*/
5862764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetTotalDimension(PetscDS prob, PetscInt *dim)
5872764a2aaSMatthew G. Knepley {
5882764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
5892764a2aaSMatthew G. Knepley 
5902764a2aaSMatthew G. Knepley   PetscFunctionBegin;
5912764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
5922764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
5932764a2aaSMatthew G. Knepley   PetscValidPointer(dim, 2);
5942764a2aaSMatthew G. Knepley   *dim = prob->totDim;
5952764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
5962764a2aaSMatthew G. Knepley }
5972764a2aaSMatthew G. Knepley 
598bc4ae4beSMatthew G. Knepley /*@
599bc4ae4beSMatthew G. Knepley   PetscDSGetTotalComponents - Returns the total number of components in this system
600bc4ae4beSMatthew G. Knepley 
601bc4ae4beSMatthew G. Knepley   Not collective
602bc4ae4beSMatthew G. Knepley 
603bc4ae4beSMatthew G. Knepley   Input Parameter:
604bc4ae4beSMatthew G. Knepley . prob - The PetscDS object
605bc4ae4beSMatthew G. Knepley 
606bc4ae4beSMatthew G. Knepley   Output Parameter:
607bc4ae4beSMatthew G. Knepley . dim - The total number of components
608bc4ae4beSMatthew G. Knepley 
609bc4ae4beSMatthew G. Knepley   Level: beginner
610bc4ae4beSMatthew G. Knepley 
611bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetNumFields(), PetscDSCreate()
612bc4ae4beSMatthew G. Knepley @*/
6132764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetTotalComponents(PetscDS prob, PetscInt *Nc)
6142764a2aaSMatthew G. Knepley {
6152764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
6162764a2aaSMatthew G. Knepley 
6172764a2aaSMatthew G. Knepley   PetscFunctionBegin;
6182764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
6192764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
6202764a2aaSMatthew G. Knepley   PetscValidPointer(Nc, 2);
6212764a2aaSMatthew G. Knepley   *Nc = prob->totComp;
6222764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
6232764a2aaSMatthew G. Knepley }
6242764a2aaSMatthew G. Knepley 
625bc4ae4beSMatthew G. Knepley /*@
626bc4ae4beSMatthew G. Knepley   PetscDSGetDiscretization - Returns the discretization object for the given field
627bc4ae4beSMatthew G. Knepley 
628bc4ae4beSMatthew G. Knepley   Not collective
629bc4ae4beSMatthew G. Knepley 
630bc4ae4beSMatthew G. Knepley   Input Parameters:
631bc4ae4beSMatthew G. Knepley + prob - The PetscDS object
632bc4ae4beSMatthew G. Knepley - f - The field number
633bc4ae4beSMatthew G. Knepley 
634bc4ae4beSMatthew G. Knepley   Output Parameter:
635bc4ae4beSMatthew G. Knepley . disc - The discretization object
636bc4ae4beSMatthew G. Knepley 
637bc4ae4beSMatthew G. Knepley   Level: beginner
638bc4ae4beSMatthew G. Knepley 
639f744cafaSSander Arens .seealso: PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
640bc4ae4beSMatthew G. Knepley @*/
6412764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetDiscretization(PetscDS prob, PetscInt f, PetscObject *disc)
6422764a2aaSMatthew G. Knepley {
6432764a2aaSMatthew G. Knepley   PetscFunctionBegin;
6442764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
6452764a2aaSMatthew G. Knepley   PetscValidPointer(disc, 3);
6462764a2aaSMatthew 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);
6472764a2aaSMatthew G. Knepley   *disc = prob->disc[f];
6482764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
6492764a2aaSMatthew G. Knepley }
6502764a2aaSMatthew G. Knepley 
651bc4ae4beSMatthew G. Knepley /*@
652bc4ae4beSMatthew G. Knepley   PetscDSSetDiscretization - Sets the discretization object for the given field
653bc4ae4beSMatthew G. Knepley 
654bc4ae4beSMatthew G. Knepley   Not collective
655bc4ae4beSMatthew G. Knepley 
656bc4ae4beSMatthew G. Knepley   Input Parameters:
657bc4ae4beSMatthew G. Knepley + prob - The PetscDS object
658bc4ae4beSMatthew G. Knepley . f - The field number
659bc4ae4beSMatthew G. Knepley - disc - The discretization object
660bc4ae4beSMatthew G. Knepley 
661bc4ae4beSMatthew G. Knepley   Level: beginner
662bc4ae4beSMatthew G. Knepley 
663bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
664bc4ae4beSMatthew G. Knepley @*/
6652764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetDiscretization(PetscDS prob, PetscInt f, PetscObject disc)
6662764a2aaSMatthew G. Knepley {
6672764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
6682764a2aaSMatthew G. Knepley 
6692764a2aaSMatthew G. Knepley   PetscFunctionBegin;
6702764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
6712764a2aaSMatthew G. Knepley   PetscValidPointer(disc, 3);
6722764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
6732764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
6742764a2aaSMatthew G. Knepley   if (prob->disc[f]) {ierr = PetscObjectDereference(prob->disc[f]);CHKERRQ(ierr);}
6752764a2aaSMatthew G. Knepley   prob->disc[f] = disc;
6762764a2aaSMatthew G. Knepley   ierr = PetscObjectReference(disc);CHKERRQ(ierr);
677249df284SMatthew G. Knepley   {
678249df284SMatthew G. Knepley     PetscClassId id;
679249df284SMatthew G. Knepley 
680249df284SMatthew G. Knepley     ierr = PetscObjectGetClassId(disc, &id);CHKERRQ(ierr);
681*1cf84007SMatthew G. Knepley     if (id == PETSCFE_CLASSID) {
682*1cf84007SMatthew G. Knepley       ierr = PetscDSSetImplicit(prob, f, PETSC_TRUE);CHKERRQ(ierr);
683*1cf84007SMatthew G. Knepley       ierr = PetscDSSetAdjacency(prob, f, PETSC_FALSE, PETSC_TRUE);CHKERRQ(ierr);
684*1cf84007SMatthew G. Knepley     } else if (id == PETSCFV_CLASSID) {
685*1cf84007SMatthew G. Knepley       ierr = PetscDSSetImplicit(prob, f, PETSC_FALSE);CHKERRQ(ierr);
686*1cf84007SMatthew G. Knepley       ierr = PetscDSSetAdjacency(prob, f, PETSC_TRUE, PETSC_FALSE);CHKERRQ(ierr);
687a6cbbb48SMatthew G. Knepley     }
688249df284SMatthew G. Knepley   }
6892764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
6902764a2aaSMatthew G. Knepley }
6912764a2aaSMatthew G. Knepley 
692bc4ae4beSMatthew G. Knepley /*@
693bc4ae4beSMatthew G. Knepley   PetscDSAddDiscretization - Adds a discretization object
694bc4ae4beSMatthew G. Knepley 
695bc4ae4beSMatthew G. Knepley   Not collective
696bc4ae4beSMatthew G. Knepley 
697bc4ae4beSMatthew G. Knepley   Input Parameters:
698bc4ae4beSMatthew G. Knepley + prob - The PetscDS object
699bc4ae4beSMatthew G. Knepley - disc - The boundary discretization object
700bc4ae4beSMatthew G. Knepley 
701bc4ae4beSMatthew G. Knepley   Level: beginner
702bc4ae4beSMatthew G. Knepley 
703bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetDiscretization(), PetscDSSetDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
704bc4ae4beSMatthew G. Knepley @*/
7052764a2aaSMatthew G. Knepley PetscErrorCode PetscDSAddDiscretization(PetscDS prob, PetscObject disc)
7062764a2aaSMatthew G. Knepley {
7072764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
7082764a2aaSMatthew G. Knepley 
7092764a2aaSMatthew G. Knepley   PetscFunctionBegin;
7102764a2aaSMatthew G. Knepley   ierr = PetscDSSetDiscretization(prob, prob->Nf, disc);CHKERRQ(ierr);
7112764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
7122764a2aaSMatthew G. Knepley }
7132764a2aaSMatthew G. Knepley 
714249df284SMatthew G. Knepley /*@
715249df284SMatthew G. Knepley   PetscDSGetImplicit - Returns the flag for implicit solve for this field. This is just a guide for IMEX
716249df284SMatthew G. Knepley 
717249df284SMatthew G. Knepley   Not collective
718249df284SMatthew G. Knepley 
719249df284SMatthew G. Knepley   Input Parameters:
720249df284SMatthew G. Knepley + prob - The PetscDS object
721249df284SMatthew G. Knepley - f - The field number
722249df284SMatthew G. Knepley 
723249df284SMatthew G. Knepley   Output Parameter:
724249df284SMatthew G. Knepley . implicit - The flag indicating what kind of solve to use for this field
725249df284SMatthew G. Knepley 
726249df284SMatthew G. Knepley   Level: developer
727249df284SMatthew G. Knepley 
728f744cafaSSander Arens .seealso: PetscDSSetImplicit(), PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
729249df284SMatthew G. Knepley @*/
730249df284SMatthew G. Knepley PetscErrorCode PetscDSGetImplicit(PetscDS prob, PetscInt f, PetscBool *implicit)
731249df284SMatthew G. Knepley {
732249df284SMatthew G. Knepley   PetscFunctionBegin;
733249df284SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
734249df284SMatthew G. Knepley   PetscValidPointer(implicit, 3);
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   *implicit = prob->implicit[f];
737249df284SMatthew G. Knepley   PetscFunctionReturn(0);
738249df284SMatthew G. Knepley }
739249df284SMatthew G. Knepley 
740249df284SMatthew G. Knepley /*@
741249df284SMatthew G. Knepley   PetscDSSetImplicit - Set the flag for implicit solve for this field. This is just a guide for IMEX
742249df284SMatthew G. Knepley 
743249df284SMatthew G. Knepley   Not collective
744249df284SMatthew G. Knepley 
745249df284SMatthew G. Knepley   Input Parameters:
746249df284SMatthew G. Knepley + prob - The PetscDS object
747249df284SMatthew G. Knepley . f - The field number
748249df284SMatthew G. Knepley - implicit - The flag indicating what kind of solve to use for this field
749249df284SMatthew G. Knepley 
750249df284SMatthew G. Knepley   Level: developer
751249df284SMatthew G. Knepley 
752f744cafaSSander Arens .seealso: PetscDSGetImplicit(), PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
753249df284SMatthew G. Knepley @*/
754249df284SMatthew G. Knepley PetscErrorCode PetscDSSetImplicit(PetscDS prob, PetscInt f, PetscBool implicit)
755249df284SMatthew G. Knepley {
756249df284SMatthew G. Knepley   PetscFunctionBegin;
757249df284SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
758249df284SMatthew 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);
759249df284SMatthew G. Knepley   prob->implicit[f] = implicit;
760249df284SMatthew G. Knepley   PetscFunctionReturn(0);
761249df284SMatthew G. Knepley }
762249df284SMatthew G. Knepley 
763a6cbbb48SMatthew G. Knepley /*@
764a6cbbb48SMatthew G. Knepley   PetscDSGetAdjacency - Returns the flags for determining variable influence
765a6cbbb48SMatthew G. Knepley 
766a6cbbb48SMatthew G. Knepley   Not collective
767a6cbbb48SMatthew G. Knepley 
768a6cbbb48SMatthew G. Knepley   Input Parameters:
769a6cbbb48SMatthew G. Knepley + prob - The PetscDS object
770a6cbbb48SMatthew G. Knepley - f - The field number
771a6cbbb48SMatthew G. Knepley 
772a6cbbb48SMatthew G. Knepley   Output Parameter:
773a6cbbb48SMatthew G. Knepley + useCone    - Flag for variable influence starting with the cone operation
774a6cbbb48SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
775a6cbbb48SMatthew G. Knepley 
776a6cbbb48SMatthew G. Knepley   Note: See the discussion in DMPlexGetAdjacencyUseCone() and DMPlexGetAdjacencyUseClosure()
777a6cbbb48SMatthew G. Knepley 
778a6cbbb48SMatthew G. Knepley   Level: developer
779a6cbbb48SMatthew G. Knepley 
780f744cafaSSander Arens .seealso: PetscDSSetAdjacency(), DMPlexGetAdjacencyUseCone(), DMPlexGetAdjacencyUseClosure(), PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
781a6cbbb48SMatthew G. Knepley @*/
782a6cbbb48SMatthew G. Knepley PetscErrorCode PetscDSGetAdjacency(PetscDS prob, PetscInt f, PetscBool *useCone, PetscBool *useClosure)
783a6cbbb48SMatthew G. Knepley {
784a6cbbb48SMatthew G. Knepley   PetscFunctionBegin;
785a6cbbb48SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
786*1cf84007SMatthew G. Knepley   if (useCone) PetscValidPointer(useCone, 3);
787*1cf84007SMatthew G. Knepley   if (useClosure) PetscValidPointer(useClosure, 4);
788a6cbbb48SMatthew 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);
789*1cf84007SMatthew G. Knepley   if (useCone)    *useCone    = prob->adjacency[f*2+0];
790*1cf84007SMatthew G. Knepley   if (useClosure) *useClosure = prob->adjacency[f*2+1];
791a6cbbb48SMatthew G. Knepley   PetscFunctionReturn(0);
792a6cbbb48SMatthew G. Knepley }
793a6cbbb48SMatthew G. Knepley 
794a6cbbb48SMatthew G. Knepley /*@
795a6cbbb48SMatthew G. Knepley   PetscDSSetAdjacency - Set the flags for determining variable influence
796a6cbbb48SMatthew G. Knepley 
797a6cbbb48SMatthew G. Knepley   Not collective
798a6cbbb48SMatthew G. Knepley 
799a6cbbb48SMatthew G. Knepley   Input Parameters:
800a6cbbb48SMatthew G. Knepley + prob - The PetscDS object
801a6cbbb48SMatthew G. Knepley . f - The field number
802a6cbbb48SMatthew G. Knepley . useCone    - Flag for variable influence starting with the cone operation
803a6cbbb48SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
804a6cbbb48SMatthew G. Knepley 
805a6cbbb48SMatthew G. Knepley   Note: See the discussion in DMPlexGetAdjacencyUseCone() and DMPlexGetAdjacencyUseClosure()
806a6cbbb48SMatthew G. Knepley 
807a6cbbb48SMatthew G. Knepley   Level: developer
808a6cbbb48SMatthew G. Knepley 
809f744cafaSSander Arens .seealso: PetscDSGetAdjacency(), DMPlexGetAdjacencyUseCone(), DMPlexGetAdjacencyUseClosure(), PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
810a6cbbb48SMatthew G. Knepley @*/
811a6cbbb48SMatthew G. Knepley PetscErrorCode PetscDSSetAdjacency(PetscDS prob, PetscInt f, PetscBool useCone, PetscBool useClosure)
812a6cbbb48SMatthew G. Knepley {
813a6cbbb48SMatthew G. Knepley   PetscFunctionBegin;
814a6cbbb48SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
815a6cbbb48SMatthew 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);
816a6cbbb48SMatthew G. Knepley   prob->adjacency[f*2+0] = useCone;
817a6cbbb48SMatthew G. Knepley   prob->adjacency[f*2+1] = useClosure;
818a6cbbb48SMatthew G. Knepley   PetscFunctionReturn(0);
819a6cbbb48SMatthew G. Knepley }
820a6cbbb48SMatthew G. Knepley 
8212764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetObjective(PetscDS prob, PetscInt f,
82230b9ff8bSMatthew G. Knepley                                    void (**obj)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
823194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
824194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
82597b6e6e8SMatthew G. Knepley                                                 PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar obj[]))
8262764a2aaSMatthew G. Knepley {
8272764a2aaSMatthew G. Knepley   PetscFunctionBegin;
8282764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
8292764a2aaSMatthew G. Knepley   PetscValidPointer(obj, 2);
8302764a2aaSMatthew 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);
8312764a2aaSMatthew G. Knepley   *obj = prob->obj[f];
8322764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
8332764a2aaSMatthew G. Knepley }
8342764a2aaSMatthew G. Knepley 
8352764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetObjective(PetscDS prob, PetscInt f,
83630b9ff8bSMatthew G. Knepley                                    void (*obj)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
837194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
838194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
83997b6e6e8SMatthew G. Knepley                                                PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar obj[]))
8402764a2aaSMatthew G. Knepley {
8412764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
8422764a2aaSMatthew G. Knepley 
8432764a2aaSMatthew G. Knepley   PetscFunctionBegin;
8442764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
845de716cbcSToby Isaac   if (obj) PetscValidFunction(obj, 2);
8462764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
8472764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
8482764a2aaSMatthew G. Knepley   prob->obj[f] = obj;
8492764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
8502764a2aaSMatthew G. Knepley }
8512764a2aaSMatthew G. Knepley 
852194d53e6SMatthew G. Knepley /*@C
853194d53e6SMatthew G. Knepley   PetscDSGetResidual - Get the pointwise residual function for a given test field
854194d53e6SMatthew G. Knepley 
855194d53e6SMatthew G. Knepley   Not collective
856194d53e6SMatthew G. Knepley 
857194d53e6SMatthew G. Knepley   Input Parameters:
858194d53e6SMatthew G. Knepley + prob - The PetscDS
859194d53e6SMatthew G. Knepley - f    - The test field number
860194d53e6SMatthew G. Knepley 
861194d53e6SMatthew G. Knepley   Output Parameters:
862194d53e6SMatthew G. Knepley + f0 - integrand for the test function term
863194d53e6SMatthew G. Knepley - f1 - integrand for the test function gradient term
864194d53e6SMatthew G. Knepley 
865194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
866194d53e6SMatthew G. Knepley 
867194d53e6SMatthew 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)
868194d53e6SMatthew G. Knepley 
869194d53e6SMatthew G. Knepley The calling sequence for the callbacks f0 and f1 is given by:
870194d53e6SMatthew G. Knepley 
87130b9ff8bSMatthew G. Knepley $ f0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
872194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
873194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
87430b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], PetscScalar f0[])
875194d53e6SMatthew G. Knepley 
876194d53e6SMatthew G. Knepley + dim - the spatial dimension
877194d53e6SMatthew G. Knepley . Nf - the number of fields
878194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
879194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
880194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
881194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
882194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
883194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
884194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
885194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
886194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
887194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
888194d53e6SMatthew G. Knepley . t - current time
889194d53e6SMatthew G. Knepley . x - coordinates of the current point
89097b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
89197b6e6e8SMatthew G. Knepley . constants - constant parameters
892194d53e6SMatthew G. Knepley - f0 - output values at the current point
893194d53e6SMatthew G. Knepley 
894194d53e6SMatthew G. Knepley   Level: intermediate
895194d53e6SMatthew G. Knepley 
896194d53e6SMatthew G. Knepley .seealso: PetscDSSetResidual()
897194d53e6SMatthew G. Knepley @*/
8982764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetResidual(PetscDS prob, PetscInt f,
89930b9ff8bSMatthew G. Knepley                                   void (**f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
900194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
901194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
90297b6e6e8SMatthew G. Knepley                                               PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f0[]),
90330b9ff8bSMatthew G. Knepley                                   void (**f1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
904194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
905194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
90697b6e6e8SMatthew G. Knepley                                               PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f1[]))
9072764a2aaSMatthew G. Knepley {
9082764a2aaSMatthew G. Knepley   PetscFunctionBegin;
9092764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
9102764a2aaSMatthew 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);
9112764a2aaSMatthew G. Knepley   if (f0) {PetscValidPointer(f0, 3); *f0 = prob->f[f*2+0];}
9122764a2aaSMatthew G. Knepley   if (f1) {PetscValidPointer(f1, 4); *f1 = prob->f[f*2+1];}
9132764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
9142764a2aaSMatthew G. Knepley }
9152764a2aaSMatthew G. Knepley 
916194d53e6SMatthew G. Knepley /*@C
917194d53e6SMatthew G. Knepley   PetscDSSetResidual - Set the pointwise residual function for a given test field
918194d53e6SMatthew G. Knepley 
919194d53e6SMatthew G. Knepley   Not collective
920194d53e6SMatthew G. Knepley 
921194d53e6SMatthew G. Knepley   Input Parameters:
922194d53e6SMatthew G. Knepley + prob - The PetscDS
923194d53e6SMatthew G. Knepley . f    - The test field number
924194d53e6SMatthew G. Knepley . f0 - integrand for the test function term
925194d53e6SMatthew G. Knepley - f1 - integrand for the test function gradient term
926194d53e6SMatthew G. Knepley 
927194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
928194d53e6SMatthew G. Knepley 
929194d53e6SMatthew 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)
930194d53e6SMatthew G. Knepley 
931194d53e6SMatthew G. Knepley The calling sequence for the callbacks f0 and f1 is given by:
932194d53e6SMatthew G. Knepley 
93330b9ff8bSMatthew G. Knepley $ f0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
934194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
935194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
93630b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], PetscScalar f0[])
937194d53e6SMatthew G. Knepley 
938194d53e6SMatthew G. Knepley + dim - the spatial dimension
939194d53e6SMatthew G. Knepley . Nf - the number of fields
940194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
941194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
942194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
943194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
944194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
945194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
946194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
947194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
948194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
949194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
950194d53e6SMatthew G. Knepley . t - current time
951194d53e6SMatthew G. Knepley . x - coordinates of the current point
95297b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
95397b6e6e8SMatthew G. Knepley . constants - constant parameters
954194d53e6SMatthew G. Knepley - f0 - output values at the current point
955194d53e6SMatthew G. Knepley 
956194d53e6SMatthew G. Knepley   Level: intermediate
957194d53e6SMatthew G. Knepley 
958194d53e6SMatthew G. Knepley .seealso: PetscDSGetResidual()
959194d53e6SMatthew G. Knepley @*/
9602764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetResidual(PetscDS prob, PetscInt f,
96130b9ff8bSMatthew G. Knepley                                   void (*f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
962194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
963194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
96497b6e6e8SMatthew G. Knepley                                              PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f0[]),
96530b9ff8bSMatthew G. Knepley                                   void (*f1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
966194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
967194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
96897b6e6e8SMatthew G. Knepley                                              PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f1[]))
9692764a2aaSMatthew G. Knepley {
9702764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
9712764a2aaSMatthew G. Knepley 
9722764a2aaSMatthew G. Knepley   PetscFunctionBegin;
9732764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
974f866a1d0SMatthew G. Knepley   if (f0) PetscValidFunction(f0, 3);
975f866a1d0SMatthew G. Knepley   if (f1) PetscValidFunction(f1, 4);
9762764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
9772764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
9782764a2aaSMatthew G. Knepley   prob->f[f*2+0] = f0;
9792764a2aaSMatthew G. Knepley   prob->f[f*2+1] = f1;
9802764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
9812764a2aaSMatthew G. Knepley }
9822764a2aaSMatthew G. Knepley 
9833e75805dSMatthew G. Knepley /*@C
9843e75805dSMatthew G. Knepley   PetscDSHasJacobian - Signals that Jacobian functions have been set
9853e75805dSMatthew G. Knepley 
9863e75805dSMatthew G. Knepley   Not collective
9873e75805dSMatthew G. Knepley 
9883e75805dSMatthew G. Knepley   Input Parameter:
9893e75805dSMatthew G. Knepley . prob - The PetscDS
9903e75805dSMatthew G. Knepley 
9913e75805dSMatthew G. Knepley   Output Parameter:
9923e75805dSMatthew G. Knepley . hasJac - flag that pointwise function for the Jacobian has been set
9933e75805dSMatthew G. Knepley 
9943e75805dSMatthew G. Knepley   Level: intermediate
9953e75805dSMatthew G. Knepley 
9963e75805dSMatthew G. Knepley .seealso: PetscDSGetJacobianPreconditioner(), PetscDSSetJacobianPreconditioner(), PetscDSGetJacobian()
9973e75805dSMatthew G. Knepley @*/
9983e75805dSMatthew G. Knepley PetscErrorCode PetscDSHasJacobian(PetscDS prob, PetscBool *hasJac)
9993e75805dSMatthew G. Knepley {
10003e75805dSMatthew G. Knepley   PetscInt f, g, h;
10013e75805dSMatthew G. Knepley 
10023e75805dSMatthew G. Knepley   PetscFunctionBegin;
10033e75805dSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
10043e75805dSMatthew G. Knepley   *hasJac = PETSC_FALSE;
10053e75805dSMatthew G. Knepley   for (f = 0; f < prob->Nf; ++f) {
10063e75805dSMatthew G. Knepley     for (g = 0; g < prob->Nf; ++g) {
10073e75805dSMatthew G. Knepley       for (h = 0; h < 4; ++h) {
10083e75805dSMatthew G. Knepley         if (prob->g[(f*prob->Nf + g)*4+h]) *hasJac = PETSC_TRUE;
10093e75805dSMatthew G. Knepley       }
10103e75805dSMatthew G. Knepley     }
10113e75805dSMatthew G. Knepley   }
10123e75805dSMatthew G. Knepley   PetscFunctionReturn(0);
10133e75805dSMatthew G. Knepley }
10143e75805dSMatthew G. Knepley 
1015194d53e6SMatthew G. Knepley /*@C
1016194d53e6SMatthew G. Knepley   PetscDSGetJacobian - Get the pointwise Jacobian function for given test and basis field
1017194d53e6SMatthew G. Knepley 
1018194d53e6SMatthew G. Knepley   Not collective
1019194d53e6SMatthew G. Knepley 
1020194d53e6SMatthew G. Knepley   Input Parameters:
1021194d53e6SMatthew G. Knepley + prob - The PetscDS
1022194d53e6SMatthew G. Knepley . f    - The test field number
1023194d53e6SMatthew G. Knepley - g    - The field number
1024194d53e6SMatthew G. Knepley 
1025194d53e6SMatthew G. Knepley   Output Parameters:
1026194d53e6SMatthew G. Knepley + g0 - integrand for the test and basis function term
1027194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1028194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1029194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1030194d53e6SMatthew G. Knepley 
1031194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1032194d53e6SMatthew G. Knepley 
1033194d53e6SMatthew 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
1034194d53e6SMatthew G. Knepley 
1035194d53e6SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1036194d53e6SMatthew G. Knepley 
103730b9ff8bSMatthew G. Knepley $ 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[],
104030b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal u_tShift, const PetscReal x[], PetscScalar g0[])
1041194d53e6SMatthew G. Knepley 
1042194d53e6SMatthew G. Knepley + dim - the spatial dimension
1043194d53e6SMatthew G. Knepley . Nf - the number of fields
1044194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1045194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1046194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
1047194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1048194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1049194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1050194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1051194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1052194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1053194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1054194d53e6SMatthew G. Knepley . t - current time
10552aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1056194d53e6SMatthew G. Knepley . x - coordinates of the current point
105797b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
105897b6e6e8SMatthew G. Knepley . constants - constant parameters
1059194d53e6SMatthew G. Knepley - g0 - output values at the current point
1060194d53e6SMatthew G. Knepley 
1061194d53e6SMatthew G. Knepley   Level: intermediate
1062194d53e6SMatthew G. Knepley 
1063194d53e6SMatthew G. Knepley .seealso: PetscDSSetJacobian()
1064194d53e6SMatthew G. Knepley @*/
10652764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetJacobian(PetscDS prob, PetscInt f, PetscInt g,
106630b9ff8bSMatthew G. Knepley                                   void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1067194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1068194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
106997b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
107030b9ff8bSMatthew G. Knepley                                   void (**g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1071194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1072194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
107397b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
107430b9ff8bSMatthew G. Knepley                                   void (**g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1075194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1076194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
107797b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
107830b9ff8bSMatthew G. Knepley                                   void (**g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1079194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1080194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
108197b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
10822764a2aaSMatthew G. Knepley {
10832764a2aaSMatthew G. Knepley   PetscFunctionBegin;
10842764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
10852764a2aaSMatthew 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);
10862764a2aaSMatthew 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);
10872764a2aaSMatthew G. Knepley   if (g0) {PetscValidPointer(g0, 4); *g0 = prob->g[(f*prob->Nf + g)*4+0];}
10882764a2aaSMatthew G. Knepley   if (g1) {PetscValidPointer(g1, 5); *g1 = prob->g[(f*prob->Nf + g)*4+1];}
10892764a2aaSMatthew G. Knepley   if (g2) {PetscValidPointer(g2, 6); *g2 = prob->g[(f*prob->Nf + g)*4+2];}
10902764a2aaSMatthew G. Knepley   if (g3) {PetscValidPointer(g3, 7); *g3 = prob->g[(f*prob->Nf + g)*4+3];}
10912764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
10922764a2aaSMatthew G. Knepley }
10932764a2aaSMatthew G. Knepley 
1094194d53e6SMatthew G. Knepley /*@C
1095194d53e6SMatthew G. Knepley   PetscDSSetJacobian - Set the pointwise Jacobian function for given test and basis fields
1096194d53e6SMatthew G. Knepley 
1097194d53e6SMatthew G. Knepley   Not collective
1098194d53e6SMatthew G. Knepley 
1099194d53e6SMatthew G. Knepley   Input Parameters:
1100194d53e6SMatthew G. Knepley + prob - The PetscDS
1101194d53e6SMatthew G. Knepley . f    - The test field number
1102194d53e6SMatthew G. Knepley . g    - The field number
1103194d53e6SMatthew G. Knepley . g0 - integrand for the test and basis function term
1104194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1105194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1106194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1107194d53e6SMatthew G. Knepley 
1108194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1109194d53e6SMatthew G. Knepley 
1110194d53e6SMatthew 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
1111194d53e6SMatthew G. Knepley 
1112194d53e6SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1113194d53e6SMatthew G. Knepley 
111430b9ff8bSMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1115194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1116194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
111730b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], PetscScalar g0[])
1118194d53e6SMatthew G. Knepley 
1119194d53e6SMatthew G. Knepley + dim - the spatial dimension
1120194d53e6SMatthew G. Knepley . Nf - the number of fields
1121194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1122194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1123194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
1124194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1125194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1126194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1127194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1128194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1129194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1130194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1131194d53e6SMatthew G. Knepley . t - current time
11322aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1133194d53e6SMatthew G. Knepley . x - coordinates of the current point
113497b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
113597b6e6e8SMatthew G. Knepley . constants - constant parameters
1136194d53e6SMatthew G. Knepley - g0 - output values at the current point
1137194d53e6SMatthew G. Knepley 
1138194d53e6SMatthew G. Knepley   Level: intermediate
1139194d53e6SMatthew G. Knepley 
1140194d53e6SMatthew G. Knepley .seealso: PetscDSGetJacobian()
1141194d53e6SMatthew G. Knepley @*/
11422764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetJacobian(PetscDS prob, PetscInt f, PetscInt g,
114330b9ff8bSMatthew G. Knepley                                   void (*g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1144194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1145194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
114697b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
114730b9ff8bSMatthew G. Knepley                                   void (*g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1148194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1149194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
115097b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
115130b9ff8bSMatthew G. Knepley                                   void (*g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1152194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1153194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
115497b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
115530b9ff8bSMatthew G. Knepley                                   void (*g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1156194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1157194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
115897b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
11592764a2aaSMatthew G. Knepley {
11602764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
11612764a2aaSMatthew G. Knepley 
11622764a2aaSMatthew G. Knepley   PetscFunctionBegin;
11632764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
11642764a2aaSMatthew G. Knepley   if (g0) PetscValidFunction(g0, 4);
11652764a2aaSMatthew G. Knepley   if (g1) PetscValidFunction(g1, 5);
11662764a2aaSMatthew G. Knepley   if (g2) PetscValidFunction(g2, 6);
11672764a2aaSMatthew G. Knepley   if (g3) PetscValidFunction(g3, 7);
11682764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
11692764a2aaSMatthew G. Knepley   if (g < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", g);
11702764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, PetscMax(f, g)+1);CHKERRQ(ierr);
11712764a2aaSMatthew G. Knepley   prob->g[(f*prob->Nf + g)*4+0] = g0;
11722764a2aaSMatthew G. Knepley   prob->g[(f*prob->Nf + g)*4+1] = g1;
11732764a2aaSMatthew G. Knepley   prob->g[(f*prob->Nf + g)*4+2] = g2;
11742764a2aaSMatthew G. Knepley   prob->g[(f*prob->Nf + g)*4+3] = g3;
11752764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
11762764a2aaSMatthew G. Knepley }
11772764a2aaSMatthew G. Knepley 
1178475e0ac9SMatthew G. Knepley /*@C
1179475e0ac9SMatthew G. Knepley   PetscDSHasJacobianPreconditioner - Signals that a Jacobian preconditioner matrix has been set
1180475e0ac9SMatthew G. Knepley 
1181475e0ac9SMatthew G. Knepley   Not collective
1182475e0ac9SMatthew G. Knepley 
1183475e0ac9SMatthew G. Knepley   Input Parameter:
1184475e0ac9SMatthew G. Knepley . prob - The PetscDS
1185475e0ac9SMatthew G. Knepley 
1186475e0ac9SMatthew G. Knepley   Output Parameter:
1187475e0ac9SMatthew G. Knepley . hasJacPre - flag that pointwise function for Jacobian preconditioner matrix has been set
1188475e0ac9SMatthew G. Knepley 
1189475e0ac9SMatthew G. Knepley   Level: intermediate
1190475e0ac9SMatthew G. Knepley 
1191475e0ac9SMatthew G. Knepley .seealso: PetscDSGetJacobianPreconditioner(), PetscDSSetJacobianPreconditioner(), PetscDSGetJacobian()
1192475e0ac9SMatthew G. Knepley @*/
1193475e0ac9SMatthew G. Knepley PetscErrorCode PetscDSHasJacobianPreconditioner(PetscDS prob, PetscBool *hasJacPre)
1194475e0ac9SMatthew G. Knepley {
1195475e0ac9SMatthew G. Knepley   PetscInt f, g, h;
1196475e0ac9SMatthew G. Knepley 
1197475e0ac9SMatthew G. Knepley   PetscFunctionBegin;
1198475e0ac9SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1199475e0ac9SMatthew G. Knepley   *hasJacPre = PETSC_FALSE;
1200475e0ac9SMatthew G. Knepley   for (f = 0; f < prob->Nf; ++f) {
1201475e0ac9SMatthew G. Knepley     for (g = 0; g < prob->Nf; ++g) {
1202475e0ac9SMatthew G. Knepley       for (h = 0; h < 4; ++h) {
1203475e0ac9SMatthew G. Knepley         if (prob->gp[(f*prob->Nf + g)*4+h]) *hasJacPre = PETSC_TRUE;
1204475e0ac9SMatthew G. Knepley       }
1205475e0ac9SMatthew G. Knepley     }
1206475e0ac9SMatthew G. Knepley   }
1207475e0ac9SMatthew G. Knepley   PetscFunctionReturn(0);
1208475e0ac9SMatthew G. Knepley }
1209475e0ac9SMatthew G. Knepley 
1210475e0ac9SMatthew G. Knepley /*@C
1211475e0ac9SMatthew 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.
1212475e0ac9SMatthew G. Knepley 
1213475e0ac9SMatthew G. Knepley   Not collective
1214475e0ac9SMatthew G. Knepley 
1215475e0ac9SMatthew G. Knepley   Input Parameters:
1216475e0ac9SMatthew G. Knepley + prob - The PetscDS
1217475e0ac9SMatthew G. Knepley . f    - The test field number
1218475e0ac9SMatthew G. Knepley - g    - The field number
1219475e0ac9SMatthew G. Knepley 
1220475e0ac9SMatthew G. Knepley   Output Parameters:
1221475e0ac9SMatthew G. Knepley + g0 - integrand for the test and basis function term
1222475e0ac9SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1223475e0ac9SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1224475e0ac9SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1225475e0ac9SMatthew G. Knepley 
1226475e0ac9SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1227475e0ac9SMatthew G. Knepley 
1228475e0ac9SMatthew 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
1229475e0ac9SMatthew G. Knepley 
1230475e0ac9SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1231475e0ac9SMatthew G. Knepley 
1232475e0ac9SMatthew G. Knepley $ g0(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, const PetscReal u_tShift, const PetscReal x[], PetscScalar g0[])
1236475e0ac9SMatthew G. Knepley 
1237475e0ac9SMatthew G. Knepley + dim - the spatial dimension
1238475e0ac9SMatthew G. Knepley . Nf - the number of fields
1239475e0ac9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1240475e0ac9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1241475e0ac9SMatthew G. Knepley . u - each field evaluated at the current point
1242475e0ac9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1243475e0ac9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1244475e0ac9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1245475e0ac9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1246475e0ac9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1247475e0ac9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1248475e0ac9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1249475e0ac9SMatthew G. Knepley . t - current time
1250475e0ac9SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1251475e0ac9SMatthew G. Knepley . x - coordinates of the current point
125297b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
125397b6e6e8SMatthew G. Knepley . constants - constant parameters
1254475e0ac9SMatthew G. Knepley - g0 - output values at the current point
1255475e0ac9SMatthew G. Knepley 
1256475e0ac9SMatthew G. Knepley   Level: intermediate
1257475e0ac9SMatthew G. Knepley 
1258475e0ac9SMatthew G. Knepley .seealso: PetscDSSetJacobianPreconditioner(), PetscDSGetJacobian()
1259475e0ac9SMatthew G. Knepley @*/
1260475e0ac9SMatthew G. Knepley PetscErrorCode PetscDSGetJacobianPreconditioner(PetscDS prob, PetscInt f, PetscInt g,
1261475e0ac9SMatthew G. Knepley                                   void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1262475e0ac9SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1263475e0ac9SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
126497b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
1265475e0ac9SMatthew G. Knepley                                   void (**g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1266475e0ac9SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1267475e0ac9SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
126897b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
1269475e0ac9SMatthew G. Knepley                                   void (**g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1270475e0ac9SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1271475e0ac9SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
127297b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
1273475e0ac9SMatthew G. Knepley                                   void (**g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1274475e0ac9SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1275475e0ac9SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
127697b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
1277475e0ac9SMatthew G. Knepley {
1278475e0ac9SMatthew G. Knepley   PetscFunctionBegin;
1279475e0ac9SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1280475e0ac9SMatthew 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);
1281475e0ac9SMatthew 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);
1282475e0ac9SMatthew G. Knepley   if (g0) {PetscValidPointer(g0, 4); *g0 = prob->gp[(f*prob->Nf + g)*4+0];}
1283475e0ac9SMatthew G. Knepley   if (g1) {PetscValidPointer(g1, 5); *g1 = prob->gp[(f*prob->Nf + g)*4+1];}
1284475e0ac9SMatthew G. Knepley   if (g2) {PetscValidPointer(g2, 6); *g2 = prob->gp[(f*prob->Nf + g)*4+2];}
1285475e0ac9SMatthew G. Knepley   if (g3) {PetscValidPointer(g3, 7); *g3 = prob->gp[(f*prob->Nf + g)*4+3];}
1286475e0ac9SMatthew G. Knepley   PetscFunctionReturn(0);
1287475e0ac9SMatthew G. Knepley }
1288475e0ac9SMatthew G. Knepley 
1289475e0ac9SMatthew G. Knepley /*@C
1290475e0ac9SMatthew 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.
1291475e0ac9SMatthew G. Knepley 
1292475e0ac9SMatthew G. Knepley   Not collective
1293475e0ac9SMatthew G. Knepley 
1294475e0ac9SMatthew G. Knepley   Input Parameters:
1295475e0ac9SMatthew G. Knepley + prob - The PetscDS
1296475e0ac9SMatthew G. Knepley . f    - The test field number
1297475e0ac9SMatthew G. Knepley . g    - The field number
1298475e0ac9SMatthew G. Knepley . g0 - integrand for the test and basis function term
1299475e0ac9SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1300475e0ac9SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1301475e0ac9SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1302475e0ac9SMatthew G. Knepley 
1303475e0ac9SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1304475e0ac9SMatthew G. Knepley 
1305475e0ac9SMatthew 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
1306475e0ac9SMatthew G. Knepley 
1307475e0ac9SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1308475e0ac9SMatthew G. Knepley 
1309475e0ac9SMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1310475e0ac9SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1311475e0ac9SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1312475e0ac9SMatthew G. Knepley $    PetscReal t, const PetscReal x[], PetscScalar g0[])
1313475e0ac9SMatthew G. Knepley 
1314475e0ac9SMatthew G. Knepley + dim - the spatial dimension
1315475e0ac9SMatthew G. Knepley . Nf - the number of fields
1316475e0ac9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1317475e0ac9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1318475e0ac9SMatthew G. Knepley . u - each field evaluated at the current point
1319475e0ac9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1320475e0ac9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1321475e0ac9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1322475e0ac9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1323475e0ac9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1324475e0ac9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1325475e0ac9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1326475e0ac9SMatthew G. Knepley . t - current time
1327475e0ac9SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1328475e0ac9SMatthew G. Knepley . x - coordinates of the current point
132997b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
133097b6e6e8SMatthew G. Knepley . constants - constant parameters
1331475e0ac9SMatthew G. Knepley - g0 - output values at the current point
1332475e0ac9SMatthew G. Knepley 
1333475e0ac9SMatthew G. Knepley   Level: intermediate
1334475e0ac9SMatthew G. Knepley 
1335475e0ac9SMatthew G. Knepley .seealso: PetscDSGetJacobianPreconditioner(), PetscDSSetJacobian()
1336475e0ac9SMatthew G. Knepley @*/
1337475e0ac9SMatthew G. Knepley PetscErrorCode PetscDSSetJacobianPreconditioner(PetscDS prob, PetscInt f, PetscInt g,
1338475e0ac9SMatthew G. Knepley                                   void (*g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1339475e0ac9SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1340475e0ac9SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
134197b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
1342475e0ac9SMatthew G. Knepley                                   void (*g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1343475e0ac9SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1344475e0ac9SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
134597b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
1346475e0ac9SMatthew G. Knepley                                   void (*g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1347475e0ac9SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1348475e0ac9SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
134997b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
1350475e0ac9SMatthew G. Knepley                                   void (*g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1351475e0ac9SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1352475e0ac9SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
135397b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
1354475e0ac9SMatthew G. Knepley {
1355475e0ac9SMatthew G. Knepley   PetscErrorCode ierr;
1356475e0ac9SMatthew G. Knepley 
1357475e0ac9SMatthew G. Knepley   PetscFunctionBegin;
1358475e0ac9SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1359475e0ac9SMatthew G. Knepley   if (g0) PetscValidFunction(g0, 4);
1360475e0ac9SMatthew G. Knepley   if (g1) PetscValidFunction(g1, 5);
1361475e0ac9SMatthew G. Knepley   if (g2) PetscValidFunction(g2, 6);
1362475e0ac9SMatthew G. Knepley   if (g3) PetscValidFunction(g3, 7);
1363475e0ac9SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
1364475e0ac9SMatthew G. Knepley   if (g < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", g);
1365475e0ac9SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, PetscMax(f, g)+1);CHKERRQ(ierr);
1366475e0ac9SMatthew G. Knepley   prob->gp[(f*prob->Nf + g)*4+0] = g0;
1367475e0ac9SMatthew G. Knepley   prob->gp[(f*prob->Nf + g)*4+1] = g1;
1368475e0ac9SMatthew G. Knepley   prob->gp[(f*prob->Nf + g)*4+2] = g2;
1369475e0ac9SMatthew G. Knepley   prob->gp[(f*prob->Nf + g)*4+3] = g3;
1370475e0ac9SMatthew G. Knepley   PetscFunctionReturn(0);
1371475e0ac9SMatthew G. Knepley }
1372475e0ac9SMatthew G. Knepley 
1373b7e05686SMatthew G. Knepley /*@C
1374b7e05686SMatthew G. Knepley   PetscDSHasDynamicJacobian - Signals that a dynamic Jacobian, dF/du_t, has been set
1375b7e05686SMatthew G. Knepley 
1376b7e05686SMatthew G. Knepley   Not collective
1377b7e05686SMatthew G. Knepley 
1378b7e05686SMatthew G. Knepley   Input Parameter:
1379b7e05686SMatthew G. Knepley . prob - The PetscDS
1380b7e05686SMatthew G. Knepley 
1381b7e05686SMatthew G. Knepley   Output Parameter:
1382b7e05686SMatthew G. Knepley . hasDynJac - flag that pointwise function for dynamic Jacobian has been set
1383b7e05686SMatthew G. Knepley 
1384b7e05686SMatthew G. Knepley   Level: intermediate
1385b7e05686SMatthew G. Knepley 
1386b7e05686SMatthew G. Knepley .seealso: PetscDSGetDynamicJacobian(), PetscDSSetDynamicJacobian(), PetscDSGetJacobian()
1387b7e05686SMatthew G. Knepley @*/
1388b7e05686SMatthew G. Knepley PetscErrorCode PetscDSHasDynamicJacobian(PetscDS prob, PetscBool *hasDynJac)
1389b7e05686SMatthew G. Knepley {
1390b7e05686SMatthew G. Knepley   PetscInt f, g, h;
1391b7e05686SMatthew G. Knepley 
1392b7e05686SMatthew G. Knepley   PetscFunctionBegin;
1393b7e05686SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1394b7e05686SMatthew G. Knepley   *hasDynJac = PETSC_FALSE;
1395b7e05686SMatthew G. Knepley   for (f = 0; f < prob->Nf; ++f) {
1396b7e05686SMatthew G. Knepley     for (g = 0; g < prob->Nf; ++g) {
1397b7e05686SMatthew G. Knepley       for (h = 0; h < 4; ++h) {
1398b7e05686SMatthew G. Knepley         if (prob->gt[(f*prob->Nf + g)*4+h]) *hasDynJac = PETSC_TRUE;
1399b7e05686SMatthew G. Knepley       }
1400b7e05686SMatthew G. Knepley     }
1401b7e05686SMatthew G. Knepley   }
1402b7e05686SMatthew G. Knepley   PetscFunctionReturn(0);
1403b7e05686SMatthew G. Knepley }
1404b7e05686SMatthew G. Knepley 
1405b7e05686SMatthew G. Knepley /*@C
1406b7e05686SMatthew G. Knepley   PetscDSGetDynamicJacobian - Get the pointwise dynamic Jacobian, dF/du_t, function for given test and basis field
1407b7e05686SMatthew G. Knepley 
1408b7e05686SMatthew G. Knepley   Not collective
1409b7e05686SMatthew G. Knepley 
1410b7e05686SMatthew G. Knepley   Input Parameters:
1411b7e05686SMatthew G. Knepley + prob - The PetscDS
1412b7e05686SMatthew G. Knepley . f    - The test field number
1413b7e05686SMatthew G. Knepley - g    - The field number
1414b7e05686SMatthew G. Knepley 
1415b7e05686SMatthew G. Knepley   Output Parameters:
1416b7e05686SMatthew G. Knepley + g0 - integrand for the test and basis function term
1417b7e05686SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1418b7e05686SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1419b7e05686SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1420b7e05686SMatthew G. Knepley 
1421b7e05686SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1422b7e05686SMatthew G. Knepley 
1423b7e05686SMatthew 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
1424b7e05686SMatthew G. Knepley 
1425b7e05686SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1426b7e05686SMatthew G. Knepley 
1427b7e05686SMatthew G. Knepley $ g0(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, const PetscReal u_tShift, const PetscReal x[], PetscScalar g0[])
1431b7e05686SMatthew G. Knepley 
1432b7e05686SMatthew G. Knepley + dim - the spatial dimension
1433b7e05686SMatthew G. Knepley . Nf - the number of fields
1434b7e05686SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1435b7e05686SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1436b7e05686SMatthew G. Knepley . u - each field evaluated at the current point
1437b7e05686SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1438b7e05686SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1439b7e05686SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1440b7e05686SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1441b7e05686SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1442b7e05686SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1443b7e05686SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1444b7e05686SMatthew G. Knepley . t - current time
1445b7e05686SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1446b7e05686SMatthew G. Knepley . x - coordinates of the current point
144797b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
144897b6e6e8SMatthew G. Knepley . constants - constant parameters
1449b7e05686SMatthew G. Knepley - g0 - output values at the current point
1450b7e05686SMatthew G. Knepley 
1451b7e05686SMatthew G. Knepley   Level: intermediate
1452b7e05686SMatthew G. Knepley 
1453b7e05686SMatthew G. Knepley .seealso: PetscDSSetJacobian()
1454b7e05686SMatthew G. Knepley @*/
1455b7e05686SMatthew G. Knepley PetscErrorCode PetscDSGetDynamicJacobian(PetscDS prob, PetscInt f, PetscInt g,
1456b7e05686SMatthew G. Knepley                                          void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1457b7e05686SMatthew G. Knepley                                                      const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1458b7e05686SMatthew G. Knepley                                                      const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
145997b6e6e8SMatthew G. Knepley                                                      PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
1460b7e05686SMatthew G. Knepley                                          void (**g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1461b7e05686SMatthew G. Knepley                                                      const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1462b7e05686SMatthew G. Knepley                                                      const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
146397b6e6e8SMatthew G. Knepley                                                      PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
1464b7e05686SMatthew G. Knepley                                          void (**g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1465b7e05686SMatthew G. Knepley                                                      const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1466b7e05686SMatthew G. Knepley                                                      const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
146797b6e6e8SMatthew G. Knepley                                                      PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
1468b7e05686SMatthew G. Knepley                                          void (**g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1469b7e05686SMatthew G. Knepley                                                      const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1470b7e05686SMatthew G. Knepley                                                      const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
147197b6e6e8SMatthew G. Knepley                                                      PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
1472b7e05686SMatthew G. Knepley {
1473b7e05686SMatthew G. Knepley   PetscFunctionBegin;
1474b7e05686SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1475b7e05686SMatthew 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);
1476b7e05686SMatthew 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);
1477b7e05686SMatthew G. Knepley   if (g0) {PetscValidPointer(g0, 4); *g0 = prob->gt[(f*prob->Nf + g)*4+0];}
1478b7e05686SMatthew G. Knepley   if (g1) {PetscValidPointer(g1, 5); *g1 = prob->gt[(f*prob->Nf + g)*4+1];}
1479b7e05686SMatthew G. Knepley   if (g2) {PetscValidPointer(g2, 6); *g2 = prob->gt[(f*prob->Nf + g)*4+2];}
1480b7e05686SMatthew G. Knepley   if (g3) {PetscValidPointer(g3, 7); *g3 = prob->gt[(f*prob->Nf + g)*4+3];}
1481b7e05686SMatthew G. Knepley   PetscFunctionReturn(0);
1482b7e05686SMatthew G. Knepley }
1483b7e05686SMatthew G. Knepley 
1484b7e05686SMatthew G. Knepley /*@C
1485b7e05686SMatthew G. Knepley   PetscDSSetDynamicJacobian - Set the pointwise dynamic Jacobian, dF/du_t, function for given test and basis fields
1486b7e05686SMatthew G. Knepley 
1487b7e05686SMatthew G. Knepley   Not collective
1488b7e05686SMatthew G. Knepley 
1489b7e05686SMatthew G. Knepley   Input Parameters:
1490b7e05686SMatthew G. Knepley + prob - The PetscDS
1491b7e05686SMatthew G. Knepley . f    - The test field number
1492b7e05686SMatthew G. Knepley . g    - The field number
1493b7e05686SMatthew G. Knepley . g0 - integrand for the test and basis function term
1494b7e05686SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1495b7e05686SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1496b7e05686SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1497b7e05686SMatthew G. Knepley 
1498b7e05686SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1499b7e05686SMatthew G. Knepley 
1500b7e05686SMatthew 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
1501b7e05686SMatthew G. Knepley 
1502b7e05686SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1503b7e05686SMatthew G. Knepley 
1504b7e05686SMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1505b7e05686SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1506b7e05686SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1507b7e05686SMatthew G. Knepley $    PetscReal t, const PetscReal x[], PetscScalar g0[])
1508b7e05686SMatthew G. Knepley 
1509b7e05686SMatthew G. Knepley + dim - the spatial dimension
1510b7e05686SMatthew G. Knepley . Nf - the number of fields
1511b7e05686SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1512b7e05686SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1513b7e05686SMatthew G. Knepley . u - each field evaluated at the current point
1514b7e05686SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1515b7e05686SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1516b7e05686SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1517b7e05686SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1518b7e05686SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1519b7e05686SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1520b7e05686SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1521b7e05686SMatthew G. Knepley . t - current time
1522b7e05686SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1523b7e05686SMatthew G. Knepley . x - coordinates of the current point
152497b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
152597b6e6e8SMatthew G. Knepley . constants - constant parameters
1526b7e05686SMatthew G. Knepley - g0 - output values at the current point
1527b7e05686SMatthew G. Knepley 
1528b7e05686SMatthew G. Knepley   Level: intermediate
1529b7e05686SMatthew G. Knepley 
1530b7e05686SMatthew G. Knepley .seealso: PetscDSGetJacobian()
1531b7e05686SMatthew G. Knepley @*/
1532b7e05686SMatthew G. Knepley PetscErrorCode PetscDSSetDynamicJacobian(PetscDS prob, PetscInt f, PetscInt g,
1533b7e05686SMatthew G. Knepley                                          void (*g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1534b7e05686SMatthew G. Knepley                                                     const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1535b7e05686SMatthew G. Knepley                                                     const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
153697b6e6e8SMatthew G. Knepley                                                     PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
1537b7e05686SMatthew G. Knepley                                          void (*g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1538b7e05686SMatthew G. Knepley                                                     const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1539b7e05686SMatthew G. Knepley                                                     const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
154097b6e6e8SMatthew G. Knepley                                                     PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
1541b7e05686SMatthew G. Knepley                                          void (*g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1542b7e05686SMatthew G. Knepley                                                     const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1543b7e05686SMatthew G. Knepley                                                     const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
154497b6e6e8SMatthew G. Knepley                                                     PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
1545b7e05686SMatthew G. Knepley                                          void (*g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1546b7e05686SMatthew G. Knepley                                                     const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1547b7e05686SMatthew G. Knepley                                                     const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
154897b6e6e8SMatthew G. Knepley                                                     PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
1549b7e05686SMatthew G. Knepley {
1550b7e05686SMatthew G. Knepley   PetscErrorCode ierr;
1551b7e05686SMatthew G. Knepley 
1552b7e05686SMatthew G. Knepley   PetscFunctionBegin;
1553b7e05686SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1554b7e05686SMatthew G. Knepley   if (g0) PetscValidFunction(g0, 4);
1555b7e05686SMatthew G. Knepley   if (g1) PetscValidFunction(g1, 5);
1556b7e05686SMatthew G. Knepley   if (g2) PetscValidFunction(g2, 6);
1557b7e05686SMatthew G. Knepley   if (g3) PetscValidFunction(g3, 7);
1558b7e05686SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
1559b7e05686SMatthew G. Knepley   if (g < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", g);
1560b7e05686SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, PetscMax(f, g)+1);CHKERRQ(ierr);
1561b7e05686SMatthew G. Knepley   prob->gt[(f*prob->Nf + g)*4+0] = g0;
1562b7e05686SMatthew G. Knepley   prob->gt[(f*prob->Nf + g)*4+1] = g1;
1563b7e05686SMatthew G. Knepley   prob->gt[(f*prob->Nf + g)*4+2] = g2;
1564b7e05686SMatthew G. Knepley   prob->gt[(f*prob->Nf + g)*4+3] = g3;
1565b7e05686SMatthew G. Knepley   PetscFunctionReturn(0);
1566b7e05686SMatthew G. Knepley }
1567b7e05686SMatthew G. Knepley 
15680c2f2876SMatthew G. Knepley /*@C
15690c2f2876SMatthew G. Knepley   PetscDSGetRiemannSolver - Returns the Riemann solver for the given field
15700c2f2876SMatthew G. Knepley 
15710c2f2876SMatthew G. Knepley   Not collective
15720c2f2876SMatthew G. Knepley 
15730c2f2876SMatthew G. Knepley   Input Arguments:
15740c2f2876SMatthew G. Knepley + prob - The PetscDS object
15750c2f2876SMatthew G. Knepley - f    - The field number
15760c2f2876SMatthew G. Knepley 
15770c2f2876SMatthew G. Knepley   Output Argument:
15780c2f2876SMatthew G. Knepley . r    - Riemann solver
15790c2f2876SMatthew G. Knepley 
15800c2f2876SMatthew G. Knepley   Calling sequence for r:
15810c2f2876SMatthew G. Knepley 
15825db36cf9SMatthew G. Knepley $ r(PetscInt dim, PetscInt Nf, const PetscReal x[], const PetscReal n[], const PetscScalar uL[], const PetscScalar uR[], PetscScalar flux[], void *ctx)
15830c2f2876SMatthew G. Knepley 
15845db36cf9SMatthew G. Knepley + dim  - The spatial dimension
15855db36cf9SMatthew G. Knepley . Nf   - The number of fields
15865db36cf9SMatthew G. Knepley . x    - The coordinates at a point on the interface
15870c2f2876SMatthew G. Knepley . n    - The normal vector to the interface
15880c2f2876SMatthew G. Knepley . uL   - The state vector to the left of the interface
15890c2f2876SMatthew G. Knepley . uR   - The state vector to the right of the interface
15900c2f2876SMatthew G. Knepley . flux - output array of flux through the interface
159197b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
159297b6e6e8SMatthew G. Knepley . constants - constant parameters
15930c2f2876SMatthew G. Knepley - ctx  - optional user context
15940c2f2876SMatthew G. Knepley 
15950c2f2876SMatthew G. Knepley   Level: intermediate
15960c2f2876SMatthew G. Knepley 
15970c2f2876SMatthew G. Knepley .seealso: PetscDSSetRiemannSolver()
15980c2f2876SMatthew G. Knepley @*/
15990c2f2876SMatthew G. Knepley PetscErrorCode PetscDSGetRiemannSolver(PetscDS prob, PetscInt f,
160097b6e6e8SMatthew G. Knepley                                        void (**r)(PetscInt dim, PetscInt Nf, const PetscReal x[], const PetscReal n[], const PetscScalar uL[], const PetscScalar uR[], PetscInt numConstants, const PetscScalar constants[], PetscScalar flux[], void *ctx))
16010c2f2876SMatthew G. Knepley {
16020c2f2876SMatthew G. Knepley   PetscFunctionBegin;
16030c2f2876SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
16040c2f2876SMatthew 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);
16050c2f2876SMatthew G. Knepley   PetscValidPointer(r, 3);
16060c2f2876SMatthew G. Knepley   *r = prob->r[f];
16070c2f2876SMatthew G. Knepley   PetscFunctionReturn(0);
16080c2f2876SMatthew G. Knepley }
16090c2f2876SMatthew G. Knepley 
16100c2f2876SMatthew G. Knepley /*@C
16110c2f2876SMatthew G. Knepley   PetscDSSetRiemannSolver - Sets the Riemann solver for the given field
16120c2f2876SMatthew G. Knepley 
16130c2f2876SMatthew G. Knepley   Not collective
16140c2f2876SMatthew G. Knepley 
16150c2f2876SMatthew G. Knepley   Input Arguments:
16160c2f2876SMatthew G. Knepley + prob - The PetscDS object
16170c2f2876SMatthew G. Knepley . f    - The field number
16180c2f2876SMatthew G. Knepley - r    - Riemann solver
16190c2f2876SMatthew G. Knepley 
16200c2f2876SMatthew G. Knepley   Calling sequence for r:
16210c2f2876SMatthew G. Knepley 
16225db36cf9SMatthew G. Knepley $ r(PetscInt dim, PetscInt Nf, const PetscReal x[], const PetscReal n[], const PetscScalar uL[], const PetscScalar uR[], PetscScalar flux[], void *ctx)
16230c2f2876SMatthew G. Knepley 
16245db36cf9SMatthew G. Knepley + dim  - The spatial dimension
16255db36cf9SMatthew G. Knepley . Nf   - The number of fields
16265db36cf9SMatthew G. Knepley . x    - The coordinates at a point on the interface
16270c2f2876SMatthew G. Knepley . n    - The normal vector to the interface
16280c2f2876SMatthew G. Knepley . uL   - The state vector to the left of the interface
16290c2f2876SMatthew G. Knepley . uR   - The state vector to the right of the interface
16300c2f2876SMatthew G. Knepley . flux - output array of flux through the interface
163197b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
163297b6e6e8SMatthew G. Knepley . constants - constant parameters
16330c2f2876SMatthew G. Knepley - ctx  - optional user context
16340c2f2876SMatthew G. Knepley 
16350c2f2876SMatthew G. Knepley   Level: intermediate
16360c2f2876SMatthew G. Knepley 
16370c2f2876SMatthew G. Knepley .seealso: PetscDSGetRiemannSolver()
16380c2f2876SMatthew G. Knepley @*/
16390c2f2876SMatthew G. Knepley PetscErrorCode PetscDSSetRiemannSolver(PetscDS prob, PetscInt f,
164097b6e6e8SMatthew G. Knepley                                        void (*r)(PetscInt dim, PetscInt Nf, const PetscReal x[], const PetscReal n[], const PetscScalar uL[], const PetscScalar uR[], PetscInt numConstants, const PetscScalar constants[], PetscScalar flux[], void *ctx))
16410c2f2876SMatthew G. Knepley {
16420c2f2876SMatthew G. Knepley   PetscErrorCode ierr;
16430c2f2876SMatthew G. Knepley 
16440c2f2876SMatthew G. Knepley   PetscFunctionBegin;
16450c2f2876SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1646de716cbcSToby Isaac   if (r) PetscValidFunction(r, 3);
16470c2f2876SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
16480c2f2876SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
16490c2f2876SMatthew G. Knepley   prob->r[f] = r;
16500c2f2876SMatthew G. Knepley   PetscFunctionReturn(0);
16510c2f2876SMatthew G. Knepley }
16520c2f2876SMatthew G. Knepley 
165332d2bbc9SMatthew G. Knepley /*@C
165432d2bbc9SMatthew G. Knepley   PetscDSGetUpdate - Get the pointwise update function for a given field
165532d2bbc9SMatthew G. Knepley 
165632d2bbc9SMatthew G. Knepley   Not collective
165732d2bbc9SMatthew G. Knepley 
165832d2bbc9SMatthew G. Knepley   Input Parameters:
165932d2bbc9SMatthew G. Knepley + prob - The PetscDS
166032d2bbc9SMatthew G. Knepley - f    - The field number
166132d2bbc9SMatthew G. Knepley 
166232d2bbc9SMatthew G. Knepley   Output Parameters:
166332d2bbc9SMatthew G. Knepley + update - update function
166432d2bbc9SMatthew G. Knepley 
166532d2bbc9SMatthew G. Knepley   Note: The calling sequence for the callback update is given by:
166632d2bbc9SMatthew G. Knepley 
166732d2bbc9SMatthew G. Knepley $ update(PetscInt dim, PetscInt Nf, PetscInt NfAux,
166832d2bbc9SMatthew G. Knepley $        const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
166932d2bbc9SMatthew G. Knepley $        const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
167032d2bbc9SMatthew G. Knepley $        PetscReal t, const PetscReal x[], PetscScalar uNew[])
167132d2bbc9SMatthew G. Knepley 
167232d2bbc9SMatthew G. Knepley + dim - the spatial dimension
167332d2bbc9SMatthew G. Knepley . Nf - the number of fields
167432d2bbc9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
167532d2bbc9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
167632d2bbc9SMatthew G. Knepley . u - each field evaluated at the current point
167732d2bbc9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
167832d2bbc9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
167932d2bbc9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
168032d2bbc9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
168132d2bbc9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
168232d2bbc9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
168332d2bbc9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
168432d2bbc9SMatthew G. Knepley . t - current time
168532d2bbc9SMatthew G. Knepley . x - coordinates of the current point
168632d2bbc9SMatthew G. Knepley - uNew - new value for field at the current point
168732d2bbc9SMatthew G. Knepley 
168832d2bbc9SMatthew G. Knepley   Level: intermediate
168932d2bbc9SMatthew G. Knepley 
169032d2bbc9SMatthew G. Knepley .seealso: PetscDSSetUpdate(), PetscDSSetResidual()
169132d2bbc9SMatthew G. Knepley @*/
169232d2bbc9SMatthew G. Knepley PetscErrorCode PetscDSGetUpdate(PetscDS prob, PetscInt f,
169332d2bbc9SMatthew G. Knepley                                   void (**update)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
169432d2bbc9SMatthew G. Knepley                                                   const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
169532d2bbc9SMatthew G. Knepley                                                   const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
16963fa77dffSMatthew G. Knepley                                                   PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar uNew[]))
169732d2bbc9SMatthew G. Knepley {
169832d2bbc9SMatthew G. Knepley   PetscFunctionBegin;
169932d2bbc9SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
170032d2bbc9SMatthew 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);
170132d2bbc9SMatthew G. Knepley   if (update) {PetscValidPointer(update, 3); *update = prob->update[f];}
170232d2bbc9SMatthew G. Knepley   PetscFunctionReturn(0);
170332d2bbc9SMatthew G. Knepley }
170432d2bbc9SMatthew G. Knepley 
170532d2bbc9SMatthew G. Knepley /*@C
17063fa77dffSMatthew G. Knepley   PetscDSSetUpdate - Set the pointwise update function for a given field
170732d2bbc9SMatthew G. Knepley 
170832d2bbc9SMatthew G. Knepley   Not collective
170932d2bbc9SMatthew G. Knepley 
171032d2bbc9SMatthew G. Knepley   Input Parameters:
171132d2bbc9SMatthew G. Knepley + prob   - The PetscDS
171232d2bbc9SMatthew G. Knepley . f      - The field number
171332d2bbc9SMatthew G. Knepley - update - update function
171432d2bbc9SMatthew G. Knepley 
171532d2bbc9SMatthew G. Knepley   Note: The calling sequence for the callback update is given by:
171632d2bbc9SMatthew G. Knepley 
171732d2bbc9SMatthew G. Knepley $ update(PetscInt dim, PetscInt Nf, PetscInt NfAux,
171832d2bbc9SMatthew G. Knepley $        const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
171932d2bbc9SMatthew G. Knepley $        const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
172032d2bbc9SMatthew G. Knepley $        PetscReal t, const PetscReal x[], PetscScalar uNew[])
172132d2bbc9SMatthew G. Knepley 
172232d2bbc9SMatthew G. Knepley + dim - the spatial dimension
172332d2bbc9SMatthew G. Knepley . Nf - the number of fields
172432d2bbc9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
172532d2bbc9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
172632d2bbc9SMatthew G. Knepley . u - each field evaluated at the current point
172732d2bbc9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
172832d2bbc9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
172932d2bbc9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
173032d2bbc9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
173132d2bbc9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
173232d2bbc9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
173332d2bbc9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
173432d2bbc9SMatthew G. Knepley . t - current time
173532d2bbc9SMatthew G. Knepley . x - coordinates of the current point
173632d2bbc9SMatthew G. Knepley - uNew - new field values at the current point
173732d2bbc9SMatthew G. Knepley 
173832d2bbc9SMatthew G. Knepley   Level: intermediate
173932d2bbc9SMatthew G. Knepley 
174032d2bbc9SMatthew G. Knepley .seealso: PetscDSGetResidual()
174132d2bbc9SMatthew G. Knepley @*/
174232d2bbc9SMatthew G. Knepley PetscErrorCode PetscDSSetUpdate(PetscDS prob, PetscInt f,
174332d2bbc9SMatthew G. Knepley                                 void (*update)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
174432d2bbc9SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
174532d2bbc9SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
17463fa77dffSMatthew G. Knepley                                                PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar uNew[]))
174732d2bbc9SMatthew G. Knepley {
174832d2bbc9SMatthew G. Knepley   PetscErrorCode ierr;
174932d2bbc9SMatthew G. Knepley 
175032d2bbc9SMatthew G. Knepley   PetscFunctionBegin;
175132d2bbc9SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
175232d2bbc9SMatthew G. Knepley   if (update) PetscValidFunction(update, 3);
175332d2bbc9SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
175432d2bbc9SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
175532d2bbc9SMatthew G. Knepley   prob->update[f] = update;
175632d2bbc9SMatthew G. Knepley   PetscFunctionReturn(0);
175732d2bbc9SMatthew G. Knepley }
175832d2bbc9SMatthew G. Knepley 
17590c2f2876SMatthew G. Knepley PetscErrorCode PetscDSGetContext(PetscDS prob, PetscInt f, void **ctx)
17600c2f2876SMatthew G. Knepley {
17610c2f2876SMatthew G. Knepley   PetscFunctionBegin;
17620c2f2876SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
17630c2f2876SMatthew 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);
17640c2f2876SMatthew G. Knepley   PetscValidPointer(ctx, 3);
17650c2f2876SMatthew G. Knepley   *ctx = prob->ctx[f];
17660c2f2876SMatthew G. Knepley   PetscFunctionReturn(0);
17670c2f2876SMatthew G. Knepley }
17680c2f2876SMatthew G. Knepley 
17690c2f2876SMatthew G. Knepley PetscErrorCode PetscDSSetContext(PetscDS prob, PetscInt f, void *ctx)
17700c2f2876SMatthew G. Knepley {
17710c2f2876SMatthew G. Knepley   PetscErrorCode ierr;
17720c2f2876SMatthew G. Knepley 
17730c2f2876SMatthew G. Knepley   PetscFunctionBegin;
17740c2f2876SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
17750c2f2876SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
17760c2f2876SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
17770c2f2876SMatthew G. Knepley   prob->ctx[f] = ctx;
17780c2f2876SMatthew G. Knepley   PetscFunctionReturn(0);
17790c2f2876SMatthew G. Knepley }
17800c2f2876SMatthew G. Knepley 
1781194d53e6SMatthew G. Knepley /*@C
1782194d53e6SMatthew G. Knepley   PetscDSGetBdResidual - Get the pointwise boundary residual function for a given test field
1783194d53e6SMatthew G. Knepley 
1784194d53e6SMatthew G. Knepley   Not collective
1785194d53e6SMatthew G. Knepley 
1786194d53e6SMatthew G. Knepley   Input Parameters:
1787194d53e6SMatthew G. Knepley + prob - The PetscDS
1788194d53e6SMatthew G. Knepley - f    - The test field number
1789194d53e6SMatthew G. Knepley 
1790194d53e6SMatthew G. Knepley   Output Parameters:
1791194d53e6SMatthew G. Knepley + f0 - boundary integrand for the test function term
1792194d53e6SMatthew G. Knepley - f1 - boundary integrand for the test function gradient term
1793194d53e6SMatthew G. Knepley 
1794194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1795194d53e6SMatthew G. Knepley 
1796194d53e6SMatthew 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
1797194d53e6SMatthew G. Knepley 
1798194d53e6SMatthew G. Knepley The calling sequence for the callbacks f0 and f1 is given by:
1799194d53e6SMatthew G. Knepley 
180030b9ff8bSMatthew G. Knepley $ f0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1801194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1802194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
180330b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar f0[])
1804194d53e6SMatthew G. Knepley 
1805194d53e6SMatthew G. Knepley + dim - the spatial dimension
1806194d53e6SMatthew G. Knepley . Nf - the number of fields
1807194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1808194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1809194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
1810194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1811194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1812194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1813194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1814194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1815194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1816194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1817194d53e6SMatthew G. Knepley . t - current time
1818194d53e6SMatthew G. Knepley . x - coordinates of the current point
1819194d53e6SMatthew G. Knepley . n - unit normal at the current point
182097b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
182197b6e6e8SMatthew G. Knepley . constants - constant parameters
1822194d53e6SMatthew G. Knepley - f0 - output values at the current point
1823194d53e6SMatthew G. Knepley 
1824194d53e6SMatthew G. Knepley   Level: intermediate
1825194d53e6SMatthew G. Knepley 
1826194d53e6SMatthew G. Knepley .seealso: PetscDSSetBdResidual()
1827194d53e6SMatthew G. Knepley @*/
18282764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetBdResidual(PetscDS prob, PetscInt f,
182930b9ff8bSMatthew G. Knepley                                     void (**f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1830194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1831194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
183297b6e6e8SMatthew G. Knepley                                                 PetscReal t, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f0[]),
183330b9ff8bSMatthew G. Knepley                                     void (**f1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1834194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1835194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
183697b6e6e8SMatthew G. Knepley                                                 PetscReal t, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f1[]))
18372764a2aaSMatthew G. Knepley {
18382764a2aaSMatthew G. Knepley   PetscFunctionBegin;
18392764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
18402764a2aaSMatthew 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);
18412764a2aaSMatthew G. Knepley   if (f0) {PetscValidPointer(f0, 3); *f0 = prob->fBd[f*2+0];}
18422764a2aaSMatthew G. Knepley   if (f1) {PetscValidPointer(f1, 4); *f1 = prob->fBd[f*2+1];}
18432764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
18442764a2aaSMatthew G. Knepley }
18452764a2aaSMatthew G. Knepley 
1846194d53e6SMatthew G. Knepley /*@C
1847194d53e6SMatthew G. Knepley   PetscDSSetBdResidual - Get the pointwise boundary residual function for a given test field
1848194d53e6SMatthew G. Knepley 
1849194d53e6SMatthew G. Knepley   Not collective
1850194d53e6SMatthew G. Knepley 
1851194d53e6SMatthew G. Knepley   Input Parameters:
1852194d53e6SMatthew G. Knepley + prob - The PetscDS
1853194d53e6SMatthew G. Knepley . f    - The test field number
1854194d53e6SMatthew G. Knepley . f0 - boundary integrand for the test function term
1855194d53e6SMatthew G. Knepley - f1 - boundary integrand for the test function gradient term
1856194d53e6SMatthew G. Knepley 
1857194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1858194d53e6SMatthew G. Knepley 
1859194d53e6SMatthew 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
1860194d53e6SMatthew G. Knepley 
1861194d53e6SMatthew G. Knepley The calling sequence for the callbacks f0 and f1 is given by:
1862194d53e6SMatthew G. Knepley 
186330b9ff8bSMatthew G. Knepley $ f0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1864194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1865194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
186630b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar f0[])
1867194d53e6SMatthew G. Knepley 
1868194d53e6SMatthew G. Knepley + dim - the spatial dimension
1869194d53e6SMatthew G. Knepley . Nf - the number of fields
1870194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1871194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1872194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
1873194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1874194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1875194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1876194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1877194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1878194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1879194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1880194d53e6SMatthew G. Knepley . t - current time
1881194d53e6SMatthew G. Knepley . x - coordinates of the current point
1882194d53e6SMatthew G. Knepley . n - unit normal at the current point
188397b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
188497b6e6e8SMatthew G. Knepley . constants - constant parameters
1885194d53e6SMatthew G. Knepley - f0 - output values at the current point
1886194d53e6SMatthew G. Knepley 
1887194d53e6SMatthew G. Knepley   Level: intermediate
1888194d53e6SMatthew G. Knepley 
1889194d53e6SMatthew G. Knepley .seealso: PetscDSGetBdResidual()
1890194d53e6SMatthew G. Knepley @*/
18912764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetBdResidual(PetscDS prob, PetscInt f,
189230b9ff8bSMatthew G. Knepley                                     void (*f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1893194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1894194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
189597b6e6e8SMatthew G. Knepley                                                PetscReal t, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f0[]),
189630b9ff8bSMatthew G. Knepley                                     void (*f1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1897194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1898194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
189997b6e6e8SMatthew G. Knepley                                                PetscReal t, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f1[]))
19002764a2aaSMatthew G. Knepley {
19012764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
19022764a2aaSMatthew G. Knepley 
19032764a2aaSMatthew G. Knepley   PetscFunctionBegin;
19042764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
19052764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
19062764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
19072764a2aaSMatthew G. Knepley   if (f0) {PetscValidFunction(f0, 3); prob->fBd[f*2+0] = f0;}
19082764a2aaSMatthew G. Knepley   if (f1) {PetscValidFunction(f1, 4); prob->fBd[f*2+1] = f1;}
19092764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
19102764a2aaSMatthew G. Knepley }
19112764a2aaSMatthew G. Knepley 
1912194d53e6SMatthew G. Knepley /*@C
1913194d53e6SMatthew G. Knepley   PetscDSGetBdJacobian - Get the pointwise boundary Jacobian function for given test and basis field
1914194d53e6SMatthew G. Knepley 
1915194d53e6SMatthew G. Knepley   Not collective
1916194d53e6SMatthew G. Knepley 
1917194d53e6SMatthew G. Knepley   Input Parameters:
1918194d53e6SMatthew G. Knepley + prob - The PetscDS
1919194d53e6SMatthew G. Knepley . f    - The test field number
1920194d53e6SMatthew G. Knepley - g    - The field number
1921194d53e6SMatthew G. Knepley 
1922194d53e6SMatthew G. Knepley   Output Parameters:
1923194d53e6SMatthew G. Knepley + g0 - integrand for the test and basis function term
1924194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1925194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1926194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1927194d53e6SMatthew G. Knepley 
1928194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1929194d53e6SMatthew G. Knepley 
1930194d53e6SMatthew 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
1931194d53e6SMatthew G. Knepley 
1932194d53e6SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1933194d53e6SMatthew G. Knepley 
193430b9ff8bSMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1935194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1936194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
193730b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar g0[])
1938194d53e6SMatthew G. Knepley 
1939194d53e6SMatthew G. Knepley + dim - the spatial dimension
1940194d53e6SMatthew G. Knepley . Nf - the number of fields
1941194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1942194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1943194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
1944194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1945194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1946194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1947194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1948194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1949194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1950194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1951194d53e6SMatthew G. Knepley . t - current time
19522aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1953194d53e6SMatthew G. Knepley . x - coordinates of the current point
1954194d53e6SMatthew G. Knepley . n - normal at the current point
195597b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
195697b6e6e8SMatthew G. Knepley . constants - constant parameters
1957194d53e6SMatthew G. Knepley - g0 - output values at the current point
1958194d53e6SMatthew G. Knepley 
1959194d53e6SMatthew G. Knepley   Level: intermediate
1960194d53e6SMatthew G. Knepley 
1961194d53e6SMatthew G. Knepley .seealso: PetscDSSetBdJacobian()
1962194d53e6SMatthew G. Knepley @*/
19632764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetBdJacobian(PetscDS prob, PetscInt f, PetscInt g,
196430b9ff8bSMatthew G. Knepley                                     void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1965194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1966194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
196797b6e6e8SMatthew G. Knepley                                                 PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
196830b9ff8bSMatthew G. Knepley                                     void (**g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1969194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1970194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
197197b6e6e8SMatthew G. Knepley                                                 PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
197230b9ff8bSMatthew G. Knepley                                     void (**g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1973194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1974194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
197597b6e6e8SMatthew G. Knepley                                                 PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
197630b9ff8bSMatthew G. Knepley                                     void (**g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1977194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1978194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
197997b6e6e8SMatthew G. Knepley                                                 PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
19802764a2aaSMatthew G. Knepley {
19812764a2aaSMatthew G. Knepley   PetscFunctionBegin;
19822764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
19832764a2aaSMatthew 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);
19842764a2aaSMatthew 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);
19852764a2aaSMatthew G. Knepley   if (g0) {PetscValidPointer(g0, 4); *g0 = prob->gBd[(f*prob->Nf + g)*4+0];}
19862764a2aaSMatthew G. Knepley   if (g1) {PetscValidPointer(g1, 5); *g1 = prob->gBd[(f*prob->Nf + g)*4+1];}
19872764a2aaSMatthew G. Knepley   if (g2) {PetscValidPointer(g2, 6); *g2 = prob->gBd[(f*prob->Nf + g)*4+2];}
19882764a2aaSMatthew G. Knepley   if (g3) {PetscValidPointer(g3, 7); *g3 = prob->gBd[(f*prob->Nf + g)*4+3];}
19892764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
19902764a2aaSMatthew G. Knepley }
19912764a2aaSMatthew G. Knepley 
1992194d53e6SMatthew G. Knepley /*@C
1993194d53e6SMatthew G. Knepley   PetscDSSetBdJacobian - Set the pointwise boundary Jacobian function for given test and basis field
1994194d53e6SMatthew G. Knepley 
1995194d53e6SMatthew G. Knepley   Not collective
1996194d53e6SMatthew G. Knepley 
1997194d53e6SMatthew G. Knepley   Input Parameters:
1998194d53e6SMatthew G. Knepley + prob - The PetscDS
1999194d53e6SMatthew G. Knepley . f    - The test field number
2000194d53e6SMatthew G. Knepley . g    - The field number
2001194d53e6SMatthew G. Knepley . g0 - integrand for the test and basis function term
2002194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
2003194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
2004194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
2005194d53e6SMatthew G. Knepley 
2006194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
2007194d53e6SMatthew G. Knepley 
2008194d53e6SMatthew 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
2009194d53e6SMatthew G. Knepley 
2010194d53e6SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
2011194d53e6SMatthew G. Knepley 
201230b9ff8bSMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2013194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2014194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
201530b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar g0[])
2016194d53e6SMatthew G. Knepley 
2017194d53e6SMatthew G. Knepley + dim - the spatial dimension
2018194d53e6SMatthew G. Knepley . Nf - the number of fields
2019194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
2020194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
2021194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
2022194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
2023194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
2024194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
2025194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
2026194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
2027194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
2028194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
2029194d53e6SMatthew G. Knepley . t - current time
20302aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
2031194d53e6SMatthew G. Knepley . x - coordinates of the current point
2032194d53e6SMatthew G. Knepley . n - normal at the current point
203397b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
203497b6e6e8SMatthew G. Knepley . constants - constant parameters
2035194d53e6SMatthew G. Knepley - g0 - output values at the current point
2036194d53e6SMatthew G. Knepley 
2037194d53e6SMatthew G. Knepley   Level: intermediate
2038194d53e6SMatthew G. Knepley 
2039194d53e6SMatthew G. Knepley .seealso: PetscDSGetBdJacobian()
2040194d53e6SMatthew G. Knepley @*/
20412764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetBdJacobian(PetscDS prob, PetscInt f, PetscInt g,
204230b9ff8bSMatthew G. Knepley                                     void (*g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2043194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2044194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
204597b6e6e8SMatthew G. Knepley                                                PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
204630b9ff8bSMatthew G. Knepley                                     void (*g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2047194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2048194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
204997b6e6e8SMatthew G. Knepley                                                PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
205030b9ff8bSMatthew G. Knepley                                     void (*g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2051194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2052194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
205397b6e6e8SMatthew G. Knepley                                                PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
205430b9ff8bSMatthew G. Knepley                                     void (*g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2055194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2056194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
205797b6e6e8SMatthew G. Knepley                                                PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
20582764a2aaSMatthew G. Knepley {
20592764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
20602764a2aaSMatthew G. Knepley 
20612764a2aaSMatthew G. Knepley   PetscFunctionBegin;
20622764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
20632764a2aaSMatthew G. Knepley   if (g0) PetscValidFunction(g0, 4);
20642764a2aaSMatthew G. Knepley   if (g1) PetscValidFunction(g1, 5);
20652764a2aaSMatthew G. Knepley   if (g2) PetscValidFunction(g2, 6);
20662764a2aaSMatthew G. Knepley   if (g3) PetscValidFunction(g3, 7);
20672764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
20682764a2aaSMatthew G. Knepley   if (g < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", g);
20692764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, PetscMax(f, g)+1);CHKERRQ(ierr);
20702764a2aaSMatthew G. Knepley   prob->gBd[(f*prob->Nf + g)*4+0] = g0;
20712764a2aaSMatthew G. Knepley   prob->gBd[(f*prob->Nf + g)*4+1] = g1;
20722764a2aaSMatthew G. Knepley   prob->gBd[(f*prob->Nf + g)*4+2] = g2;
20732764a2aaSMatthew G. Knepley   prob->gBd[(f*prob->Nf + g)*4+3] = g3;
20742764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
20752764a2aaSMatthew G. Knepley }
20762764a2aaSMatthew G. Knepley 
20770d3e9b51SMatthew G. Knepley /*@C
2078c371a6d1SMatthew G. Knepley   PetscDSGetExactSolution - Get the pointwise exact solution function for a given test field
2079c371a6d1SMatthew G. Knepley 
2080c371a6d1SMatthew G. Knepley   Not collective
2081c371a6d1SMatthew G. Knepley 
2082c371a6d1SMatthew G. Knepley   Input Parameters:
2083c371a6d1SMatthew G. Knepley + prob - The PetscDS
2084c371a6d1SMatthew G. Knepley - f    - The test field number
2085c371a6d1SMatthew G. Knepley 
2086c371a6d1SMatthew G. Knepley   Output Parameter:
2087c371a6d1SMatthew G. Knepley . exactSol - exact solution for the test field
2088c371a6d1SMatthew G. Knepley 
2089c371a6d1SMatthew G. Knepley   Note: The calling sequence for the solution functions is given by:
2090c371a6d1SMatthew G. Knepley 
2091c371a6d1SMatthew G. Knepley $ sol(PetscInt dim, PetscReal t, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx)
2092c371a6d1SMatthew G. Knepley 
2093c371a6d1SMatthew G. Knepley + dim - the spatial dimension
2094c371a6d1SMatthew G. Knepley . t - current time
2095c371a6d1SMatthew G. Knepley . x - coordinates of the current point
2096c371a6d1SMatthew G. Knepley . Nc - the number of field components
2097c371a6d1SMatthew G. Knepley . u - the solution field evaluated at the current point
2098c371a6d1SMatthew G. Knepley - ctx - a user context
2099c371a6d1SMatthew G. Knepley 
2100c371a6d1SMatthew G. Knepley   Level: intermediate
2101c371a6d1SMatthew G. Knepley 
2102c371a6d1SMatthew G. Knepley .seealso: PetscDSSetExactSolution()
2103c371a6d1SMatthew G. Knepley @*/
2104c371a6d1SMatthew G. Knepley PetscErrorCode PetscDSGetExactSolution(PetscDS prob, PetscInt f, PetscErrorCode (**sol)(PetscInt dim, PetscReal t, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx))
2105c371a6d1SMatthew G. Knepley {
2106c371a6d1SMatthew G. Knepley   PetscFunctionBegin;
2107c371a6d1SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2108c371a6d1SMatthew 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);
2109c371a6d1SMatthew G. Knepley   if (sol) {PetscValidPointer(sol, 3); *sol = prob->exactSol[f];}
2110c371a6d1SMatthew G. Knepley   PetscFunctionReturn(0);
2111c371a6d1SMatthew G. Knepley }
2112c371a6d1SMatthew G. Knepley 
2113c371a6d1SMatthew G. Knepley /*@C
2114c371a6d1SMatthew G. Knepley   PetscDSSetExactSolution - Get the pointwise exact solution function for a given test field
2115c371a6d1SMatthew G. Knepley 
2116c371a6d1SMatthew G. Knepley   Not collective
2117c371a6d1SMatthew G. Knepley 
2118c371a6d1SMatthew G. Knepley   Input Parameters:
2119c371a6d1SMatthew G. Knepley + prob - The PetscDS
2120c371a6d1SMatthew G. Knepley . f    - The test field number
2121c371a6d1SMatthew G. Knepley - sol  - solution function for the test fields
2122c371a6d1SMatthew G. Knepley 
2123c371a6d1SMatthew G. Knepley   Note: The calling sequence for solution functions is given by:
2124c371a6d1SMatthew G. Knepley 
2125c371a6d1SMatthew G. Knepley $ sol(PetscInt dim, PetscReal t, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx)
2126c371a6d1SMatthew G. Knepley 
2127c371a6d1SMatthew G. Knepley + dim - the spatial dimension
2128c371a6d1SMatthew G. Knepley . t - current time
2129c371a6d1SMatthew G. Knepley . x - coordinates of the current point
2130c371a6d1SMatthew G. Knepley . Nc - the number of field components
2131c371a6d1SMatthew G. Knepley . u - the solution field evaluated at the current point
2132c371a6d1SMatthew G. Knepley - ctx - a user context
2133c371a6d1SMatthew G. Knepley 
2134c371a6d1SMatthew G. Knepley   Level: intermediate
2135c371a6d1SMatthew G. Knepley 
2136c371a6d1SMatthew G. Knepley .seealso: PetscDSGetExactSolution()
2137c371a6d1SMatthew G. Knepley @*/
2138c371a6d1SMatthew G. Knepley PetscErrorCode PetscDSSetExactSolution(PetscDS prob, PetscInt f, PetscErrorCode (*sol)(PetscInt dim, PetscReal t, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx))
2139c371a6d1SMatthew G. Knepley {
2140c371a6d1SMatthew G. Knepley   PetscErrorCode ierr;
2141c371a6d1SMatthew G. Knepley 
2142c371a6d1SMatthew G. Knepley   PetscFunctionBegin;
2143c371a6d1SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2144c371a6d1SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
2145c371a6d1SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
2146c371a6d1SMatthew G. Knepley   if (sol) {PetscValidFunction(sol, 3); prob->exactSol[f] = sol;}
2147c371a6d1SMatthew G. Knepley   PetscFunctionReturn(0);
2148c371a6d1SMatthew G. Knepley }
2149c371a6d1SMatthew G. Knepley 
21505638fd0eSMatthew G. Knepley /*@C
215197b6e6e8SMatthew G. Knepley   PetscDSGetConstants - Returns the array of constants passed to point functions
215297b6e6e8SMatthew G. Knepley 
215397b6e6e8SMatthew G. Knepley   Not collective
215497b6e6e8SMatthew G. Knepley 
215597b6e6e8SMatthew G. Knepley   Input Parameter:
215697b6e6e8SMatthew G. Knepley . prob - The PetscDS object
215797b6e6e8SMatthew G. Knepley 
215897b6e6e8SMatthew G. Knepley   Output Parameters:
215997b6e6e8SMatthew G. Knepley + numConstants - The number of constants
216097b6e6e8SMatthew G. Knepley - constants    - The array of constants, NULL if there are none
216197b6e6e8SMatthew G. Knepley 
216297b6e6e8SMatthew G. Knepley   Level: intermediate
216397b6e6e8SMatthew G. Knepley 
216497b6e6e8SMatthew G. Knepley .seealso: PetscDSSetConstants(), PetscDSCreate()
216597b6e6e8SMatthew G. Knepley @*/
216697b6e6e8SMatthew G. Knepley PetscErrorCode PetscDSGetConstants(PetscDS prob, PetscInt *numConstants, const PetscScalar *constants[])
216797b6e6e8SMatthew G. Knepley {
216897b6e6e8SMatthew G. Knepley   PetscFunctionBegin;
216997b6e6e8SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
217097b6e6e8SMatthew G. Knepley   if (numConstants) {PetscValidPointer(numConstants, 2); *numConstants = prob->numConstants;}
217197b6e6e8SMatthew G. Knepley   if (constants)    {PetscValidPointer(constants, 3);    *constants    = prob->constants;}
217297b6e6e8SMatthew G. Knepley   PetscFunctionReturn(0);
217397b6e6e8SMatthew G. Knepley }
217497b6e6e8SMatthew G. Knepley 
21750d3e9b51SMatthew G. Knepley /*@C
217697b6e6e8SMatthew G. Knepley   PetscDSSetConstants - Set the array of constants passed to point functions
217797b6e6e8SMatthew G. Knepley 
217897b6e6e8SMatthew G. Knepley   Not collective
217997b6e6e8SMatthew G. Knepley 
218097b6e6e8SMatthew G. Knepley   Input Parameters:
218197b6e6e8SMatthew G. Knepley + prob         - The PetscDS object
218297b6e6e8SMatthew G. Knepley . numConstants - The number of constants
218397b6e6e8SMatthew G. Knepley - constants    - The array of constants, NULL if there are none
218497b6e6e8SMatthew G. Knepley 
218597b6e6e8SMatthew G. Knepley   Level: intermediate
218697b6e6e8SMatthew G. Knepley 
218797b6e6e8SMatthew G. Knepley .seealso: PetscDSGetConstants(), PetscDSCreate()
218897b6e6e8SMatthew G. Knepley @*/
218997b6e6e8SMatthew G. Knepley PetscErrorCode PetscDSSetConstants(PetscDS prob, PetscInt numConstants, PetscScalar constants[])
219097b6e6e8SMatthew G. Knepley {
219197b6e6e8SMatthew G. Knepley   PetscErrorCode ierr;
219297b6e6e8SMatthew G. Knepley 
219397b6e6e8SMatthew G. Knepley   PetscFunctionBegin;
219497b6e6e8SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
219597b6e6e8SMatthew G. Knepley   if (numConstants != prob->numConstants) {
219697b6e6e8SMatthew G. Knepley     ierr = PetscFree(prob->constants);CHKERRQ(ierr);
219797b6e6e8SMatthew G. Knepley     prob->numConstants = numConstants;
219897b6e6e8SMatthew G. Knepley     if (prob->numConstants) {
219997b6e6e8SMatthew G. Knepley       ierr = PetscMalloc1(prob->numConstants, &prob->constants);CHKERRQ(ierr);
220020be0f5bSMatthew G. Knepley     } else {
220120be0f5bSMatthew G. Knepley       prob->constants = NULL;
220220be0f5bSMatthew G. Knepley     }
220320be0f5bSMatthew G. Knepley   }
220420be0f5bSMatthew G. Knepley   if (prob->numConstants) {
220520be0f5bSMatthew G. Knepley     PetscValidPointer(constants, 3);
220697b6e6e8SMatthew G. Knepley     ierr = PetscMemcpy(prob->constants, constants, prob->numConstants * sizeof(PetscScalar));CHKERRQ(ierr);
220797b6e6e8SMatthew G. Knepley   }
220897b6e6e8SMatthew G. Knepley   PetscFunctionReturn(0);
220997b6e6e8SMatthew G. Knepley }
221097b6e6e8SMatthew G. Knepley 
22114cd1e086SMatthew G. Knepley /*@
22124cd1e086SMatthew G. Knepley   PetscDSGetFieldIndex - Returns the index of the given field
22134cd1e086SMatthew G. Knepley 
22144cd1e086SMatthew G. Knepley   Not collective
22154cd1e086SMatthew G. Knepley 
22164cd1e086SMatthew G. Knepley   Input Parameters:
22174cd1e086SMatthew G. Knepley + prob - The PetscDS object
22184cd1e086SMatthew G. Knepley - disc - The discretization object
22194cd1e086SMatthew G. Knepley 
22204cd1e086SMatthew G. Knepley   Output Parameter:
22214cd1e086SMatthew G. Knepley . f - The field number
22224cd1e086SMatthew G. Knepley 
22234cd1e086SMatthew G. Knepley   Level: beginner
22244cd1e086SMatthew G. Knepley 
2225f744cafaSSander Arens .seealso: PetscGetDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
22264cd1e086SMatthew G. Knepley @*/
22274cd1e086SMatthew G. Knepley PetscErrorCode PetscDSGetFieldIndex(PetscDS prob, PetscObject disc, PetscInt *f)
22284cd1e086SMatthew G. Knepley {
22294cd1e086SMatthew G. Knepley   PetscInt g;
22304cd1e086SMatthew G. Knepley 
22314cd1e086SMatthew G. Knepley   PetscFunctionBegin;
22324cd1e086SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
22334cd1e086SMatthew G. Knepley   PetscValidPointer(f, 3);
22344cd1e086SMatthew G. Knepley   *f = -1;
22354cd1e086SMatthew G. Knepley   for (g = 0; g < prob->Nf; ++g) {if (disc == prob->disc[g]) break;}
22364cd1e086SMatthew G. Knepley   if (g == prob->Nf) SETERRQ(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Field not found in PetscDS.");
22374cd1e086SMatthew G. Knepley   *f = g;
22384cd1e086SMatthew G. Knepley   PetscFunctionReturn(0);
22394cd1e086SMatthew G. Knepley }
22404cd1e086SMatthew G. Knepley 
22414cd1e086SMatthew G. Knepley /*@
22424cd1e086SMatthew G. Knepley   PetscDSGetFieldSize - Returns the size of the given field in the full space basis
22434cd1e086SMatthew G. Knepley 
22444cd1e086SMatthew G. Knepley   Not collective
22454cd1e086SMatthew G. Knepley 
22464cd1e086SMatthew G. Knepley   Input Parameters:
22474cd1e086SMatthew G. Knepley + prob - The PetscDS object
22484cd1e086SMatthew G. Knepley - f - The field number
22494cd1e086SMatthew G. Knepley 
22504cd1e086SMatthew G. Knepley   Output Parameter:
22514cd1e086SMatthew G. Knepley . size - The size
22524cd1e086SMatthew G. Knepley 
22534cd1e086SMatthew G. Knepley   Level: beginner
22544cd1e086SMatthew G. Knepley 
2255f744cafaSSander Arens .seealso: PetscDSGetFieldOffset(), PetscDSGetNumFields(), PetscDSCreate()
22564cd1e086SMatthew G. Knepley @*/
22574cd1e086SMatthew G. Knepley PetscErrorCode PetscDSGetFieldSize(PetscDS prob, PetscInt f, PetscInt *size)
22584cd1e086SMatthew G. Knepley {
22592166fd64SMatthew G. Knepley   PetscErrorCode ierr;
22602166fd64SMatthew G. Knepley 
22614cd1e086SMatthew G. Knepley   PetscFunctionBegin;
22624cd1e086SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
22634cd1e086SMatthew G. Knepley   PetscValidPointer(size, 3);
22644cd1e086SMatthew 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);
22652166fd64SMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
2266d4742ddaSMatthew G. Knepley   *size = prob->Nb[f];
22674cd1e086SMatthew G. Knepley   PetscFunctionReturn(0);
22684cd1e086SMatthew G. Knepley }
22694cd1e086SMatthew G. Knepley 
2270bc4ae4beSMatthew G. Knepley /*@
2271bc4ae4beSMatthew G. Knepley   PetscDSGetFieldOffset - Returns the offset of the given field in the full space basis
2272bc4ae4beSMatthew G. Knepley 
2273bc4ae4beSMatthew G. Knepley   Not collective
2274bc4ae4beSMatthew G. Knepley 
2275bc4ae4beSMatthew G. Knepley   Input Parameters:
2276bc4ae4beSMatthew G. Knepley + prob - The PetscDS object
2277bc4ae4beSMatthew G. Knepley - f - The field number
2278bc4ae4beSMatthew G. Knepley 
2279bc4ae4beSMatthew G. Knepley   Output Parameter:
2280bc4ae4beSMatthew G. Knepley . off - The offset
2281bc4ae4beSMatthew G. Knepley 
2282bc4ae4beSMatthew G. Knepley   Level: beginner
2283bc4ae4beSMatthew G. Knepley 
2284f744cafaSSander Arens .seealso: PetscDSGetFieldSize(), PetscDSGetNumFields(), PetscDSCreate()
2285bc4ae4beSMatthew G. Knepley @*/
22862764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetFieldOffset(PetscDS prob, PetscInt f, PetscInt *off)
22872764a2aaSMatthew G. Knepley {
22884cd1e086SMatthew G. Knepley   PetscInt       size, g;
22892764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
22902764a2aaSMatthew G. Knepley 
22912764a2aaSMatthew G. Knepley   PetscFunctionBegin;
22922764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
22932764a2aaSMatthew G. Knepley   PetscValidPointer(off, 3);
22942764a2aaSMatthew 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);
22952764a2aaSMatthew G. Knepley   *off = 0;
22962764a2aaSMatthew G. Knepley   for (g = 0; g < f; ++g) {
22974cd1e086SMatthew G. Knepley     ierr = PetscDSGetFieldSize(prob, g, &size);CHKERRQ(ierr);
22984cd1e086SMatthew G. Knepley     *off += size;
22992764a2aaSMatthew G. Knepley   }
23002764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
23012764a2aaSMatthew G. Knepley }
23022764a2aaSMatthew G. Knepley 
2303bc4ae4beSMatthew G. Knepley /*@
230447e57110SSander Arens   PetscDSGetDimensions - Returns the size of the approximation space for each field on an evaluation point
2305bc4ae4beSMatthew G. Knepley 
2306bc4ae4beSMatthew G. Knepley   Not collective
2307bc4ae4beSMatthew G. Knepley 
230847e57110SSander Arens   Input Parameter:
230947e57110SSander Arens . prob - The PetscDS object
2310bc4ae4beSMatthew G. Knepley 
2311bc4ae4beSMatthew G. Knepley   Output Parameter:
231247e57110SSander Arens . dimensions - The number of dimensions
2313bc4ae4beSMatthew G. Knepley 
2314bc4ae4beSMatthew G. Knepley   Level: beginner
2315bc4ae4beSMatthew G. Knepley 
231647e57110SSander Arens .seealso: PetscDSGetComponentOffsets(), PetscDSGetNumFields(), PetscDSCreate()
2317bc4ae4beSMatthew G. Knepley @*/
231847e57110SSander Arens PetscErrorCode PetscDSGetDimensions(PetscDS prob, PetscInt *dimensions[])
23192764a2aaSMatthew G. Knepley {
23202764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
23212764a2aaSMatthew G. Knepley 
23222764a2aaSMatthew G. Knepley   PetscFunctionBegin;
23232764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
232447e57110SSander Arens   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
232547e57110SSander Arens   PetscValidPointer(dimensions, 2);
232647e57110SSander Arens   *dimensions = prob->Nb;
232747e57110SSander Arens   PetscFunctionReturn(0);
23286ce16762SMatthew G. Knepley }
232947e57110SSander Arens 
233047e57110SSander Arens /*@
233147e57110SSander Arens   PetscDSGetComponents - Returns the number of components for each field on an evaluation point
233247e57110SSander Arens 
233347e57110SSander Arens   Not collective
233447e57110SSander Arens 
233547e57110SSander Arens   Input Parameter:
233647e57110SSander Arens . prob - The PetscDS object
233747e57110SSander Arens 
233847e57110SSander Arens   Output Parameter:
233947e57110SSander Arens . components - The number of components
234047e57110SSander Arens 
234147e57110SSander Arens   Level: beginner
234247e57110SSander Arens 
234347e57110SSander Arens .seealso: PetscDSGetComponentOffsets(), PetscDSGetNumFields(), PetscDSCreate()
234447e57110SSander Arens @*/
234547e57110SSander Arens PetscErrorCode PetscDSGetComponents(PetscDS prob, PetscInt *components[])
234647e57110SSander Arens {
234747e57110SSander Arens   PetscErrorCode ierr;
234847e57110SSander Arens 
234947e57110SSander Arens   PetscFunctionBegin;
235047e57110SSander Arens   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
235147e57110SSander Arens   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
235247e57110SSander Arens   PetscValidPointer(components, 2);
235347e57110SSander Arens   *components = prob->Nc;
23546ce16762SMatthew G. Knepley   PetscFunctionReturn(0);
23556ce16762SMatthew G. Knepley }
23566ce16762SMatthew G. Knepley 
23576ce16762SMatthew G. Knepley /*@
23586ce16762SMatthew G. Knepley   PetscDSGetComponentOffset - Returns the offset of the given field on an evaluation point
23596ce16762SMatthew G. Knepley 
23606ce16762SMatthew G. Knepley   Not collective
23616ce16762SMatthew G. Knepley 
23626ce16762SMatthew G. Knepley   Input Parameters:
23636ce16762SMatthew G. Knepley + prob - The PetscDS object
23646ce16762SMatthew G. Knepley - f - The field number
23656ce16762SMatthew G. Knepley 
23666ce16762SMatthew G. Knepley   Output Parameter:
23676ce16762SMatthew G. Knepley . off - The offset
23686ce16762SMatthew G. Knepley 
23696ce16762SMatthew G. Knepley   Level: beginner
23706ce16762SMatthew G. Knepley 
2371f744cafaSSander Arens .seealso: PetscDSGetNumFields(), PetscDSCreate()
23726ce16762SMatthew G. Knepley @*/
23736ce16762SMatthew G. Knepley PetscErrorCode PetscDSGetComponentOffset(PetscDS prob, PetscInt f, PetscInt *off)
23746ce16762SMatthew G. Knepley {
23756ce16762SMatthew G. Knepley   PetscFunctionBegin;
23766ce16762SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
23776ce16762SMatthew G. Knepley   PetscValidPointer(off, 3);
23786ce16762SMatthew 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);
237947e57110SSander Arens   *off = prob->off[f];
23802764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
23812764a2aaSMatthew G. Knepley }
23822764a2aaSMatthew G. Knepley 
2383194d53e6SMatthew G. Knepley /*@
2384194d53e6SMatthew G. Knepley   PetscDSGetComponentOffsets - Returns the offset of each field on an evaluation point
2385194d53e6SMatthew G. Knepley 
2386194d53e6SMatthew G. Knepley   Not collective
2387194d53e6SMatthew G. Knepley 
2388194d53e6SMatthew G. Knepley   Input Parameter:
2389194d53e6SMatthew G. Knepley . prob - The PetscDS object
2390194d53e6SMatthew G. Knepley 
2391194d53e6SMatthew G. Knepley   Output Parameter:
2392194d53e6SMatthew G. Knepley . offsets - The offsets
2393194d53e6SMatthew G. Knepley 
2394194d53e6SMatthew G. Knepley   Level: beginner
2395194d53e6SMatthew G. Knepley 
2396f744cafaSSander Arens .seealso: PetscDSGetNumFields(), PetscDSCreate()
2397194d53e6SMatthew G. Knepley @*/
2398194d53e6SMatthew G. Knepley PetscErrorCode PetscDSGetComponentOffsets(PetscDS prob, PetscInt *offsets[])
2399194d53e6SMatthew G. Knepley {
2400194d53e6SMatthew G. Knepley   PetscFunctionBegin;
2401194d53e6SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2402194d53e6SMatthew G. Knepley   PetscValidPointer(offsets, 2);
2403194d53e6SMatthew G. Knepley   *offsets = prob->off;
2404194d53e6SMatthew G. Knepley   PetscFunctionReturn(0);
2405194d53e6SMatthew G. Knepley }
2406194d53e6SMatthew G. Knepley 
2407194d53e6SMatthew G. Knepley /*@
2408194d53e6SMatthew G. Knepley   PetscDSGetComponentDerivativeOffsets - Returns the offset of each field derivative on an evaluation point
2409194d53e6SMatthew G. Knepley 
2410194d53e6SMatthew G. Knepley   Not collective
2411194d53e6SMatthew G. Knepley 
2412194d53e6SMatthew G. Knepley   Input Parameter:
2413194d53e6SMatthew G. Knepley . prob - The PetscDS object
2414194d53e6SMatthew G. Knepley 
2415194d53e6SMatthew G. Knepley   Output Parameter:
2416194d53e6SMatthew G. Knepley . offsets - The offsets
2417194d53e6SMatthew G. Knepley 
2418194d53e6SMatthew G. Knepley   Level: beginner
2419194d53e6SMatthew G. Knepley 
2420f744cafaSSander Arens .seealso: PetscDSGetNumFields(), PetscDSCreate()
2421194d53e6SMatthew G. Knepley @*/
2422194d53e6SMatthew G. Knepley PetscErrorCode PetscDSGetComponentDerivativeOffsets(PetscDS prob, PetscInt *offsets[])
2423194d53e6SMatthew G. Knepley {
2424194d53e6SMatthew G. Knepley   PetscFunctionBegin;
2425194d53e6SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2426194d53e6SMatthew G. Knepley   PetscValidPointer(offsets, 2);
2427194d53e6SMatthew G. Knepley   *offsets = prob->offDer;
2428194d53e6SMatthew G. Knepley   PetscFunctionReturn(0);
2429194d53e6SMatthew G. Knepley }
2430194d53e6SMatthew G. Knepley 
243168c9edb9SMatthew G. Knepley /*@C
243268c9edb9SMatthew G. Knepley   PetscDSGetTabulation - Return the basis tabulation at quadrature points for the volume discretization
243368c9edb9SMatthew G. Knepley 
243468c9edb9SMatthew G. Knepley   Not collective
243568c9edb9SMatthew G. Knepley 
243668c9edb9SMatthew G. Knepley   Input Parameter:
243768c9edb9SMatthew G. Knepley . prob - The PetscDS object
243868c9edb9SMatthew G. Knepley 
243968c9edb9SMatthew G. Knepley   Output Parameters:
244068c9edb9SMatthew G. Knepley + basis - The basis function tabulation at quadrature points
244168c9edb9SMatthew G. Knepley - basisDer - The basis function derivative tabulation at quadrature points
244268c9edb9SMatthew G. Knepley 
244368c9edb9SMatthew G. Knepley   Level: intermediate
244468c9edb9SMatthew G. Knepley 
2445f744cafaSSander Arens .seealso: PetscDSCreate()
244668c9edb9SMatthew G. Knepley @*/
24472764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetTabulation(PetscDS prob, PetscReal ***basis, PetscReal ***basisDer)
24482764a2aaSMatthew G. Knepley {
24492764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
24502764a2aaSMatthew G. Knepley 
24512764a2aaSMatthew G. Knepley   PetscFunctionBegin;
24522764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
24532764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
24542764a2aaSMatthew G. Knepley   if (basis)    {PetscValidPointer(basis, 2);    *basis    = prob->basis;}
24552764a2aaSMatthew G. Knepley   if (basisDer) {PetscValidPointer(basisDer, 3); *basisDer = prob->basisDer;}
24562764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
24572764a2aaSMatthew G. Knepley }
24582764a2aaSMatthew G. Knepley 
245968c9edb9SMatthew G. Knepley /*@C
24604d0b9603SSander Arens   PetscDSGetFaceTabulation - Return the basis tabulation at quadrature points on the faces
246168c9edb9SMatthew G. Knepley 
246268c9edb9SMatthew G. Knepley   Not collective
246368c9edb9SMatthew G. Knepley 
246468c9edb9SMatthew G. Knepley   Input Parameter:
246568c9edb9SMatthew G. Knepley . prob - The PetscDS object
246668c9edb9SMatthew G. Knepley 
246768c9edb9SMatthew G. Knepley   Output Parameters:
24684d0b9603SSander Arens + basisFace - The basis function tabulation at quadrature points
24694d0b9603SSander Arens - basisDerFace - The basis function derivative tabulation at quadrature points
247068c9edb9SMatthew G. Knepley 
247168c9edb9SMatthew G. Knepley   Level: intermediate
247268c9edb9SMatthew G. Knepley 
247368c9edb9SMatthew G. Knepley .seealso: PetscDSGetTabulation(), PetscDSCreate()
247468c9edb9SMatthew G. Knepley @*/
24754d0b9603SSander Arens PetscErrorCode PetscDSGetFaceTabulation(PetscDS prob, PetscReal ***basis, PetscReal ***basisDer)
24762764a2aaSMatthew G. Knepley {
24772764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
24782764a2aaSMatthew G. Knepley 
24792764a2aaSMatthew G. Knepley   PetscFunctionBegin;
24802764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
24812764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
24824d0b9603SSander Arens   if (basis)    {PetscValidPointer(basis, 2);    *basis    = prob->basisFace;}
24834d0b9603SSander Arens   if (basisDer) {PetscValidPointer(basisDer, 3); *basisDer = prob->basisDerFace;}
24842764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
24852764a2aaSMatthew G. Knepley }
24862764a2aaSMatthew G. Knepley 
24872764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetEvaluationArrays(PetscDS prob, PetscScalar **u, PetscScalar **u_t, PetscScalar **u_x)
24882764a2aaSMatthew G. Knepley {
24892764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
24902764a2aaSMatthew G. Knepley 
24912764a2aaSMatthew G. Knepley   PetscFunctionBegin;
24922764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
24932764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
24942764a2aaSMatthew G. Knepley   if (u)   {PetscValidPointer(u, 2);   *u   = prob->u;}
24952764a2aaSMatthew G. Knepley   if (u_t) {PetscValidPointer(u_t, 3); *u_t = prob->u_t;}
24962764a2aaSMatthew G. Knepley   if (u_x) {PetscValidPointer(u_x, 4); *u_x = prob->u_x;}
24972764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
24982764a2aaSMatthew G. Knepley }
24992764a2aaSMatthew G. Knepley 
25002764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetWeakFormArrays(PetscDS prob, PetscScalar **f0, PetscScalar **f1, PetscScalar **g0, PetscScalar **g1, PetscScalar **g2, PetscScalar **g3)
25012764a2aaSMatthew G. Knepley {
25022764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
25032764a2aaSMatthew G. Knepley 
25042764a2aaSMatthew G. Knepley   PetscFunctionBegin;
25052764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
25062764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
25072764a2aaSMatthew G. Knepley   if (f0) {PetscValidPointer(f0, 2); *f0 = prob->f0;}
25082764a2aaSMatthew G. Knepley   if (f1) {PetscValidPointer(f1, 3); *f1 = prob->f1;}
25092764a2aaSMatthew G. Knepley   if (g0) {PetscValidPointer(g0, 4); *g0 = prob->g0;}
25102764a2aaSMatthew G. Knepley   if (g1) {PetscValidPointer(g1, 5); *g1 = prob->g1;}
25112764a2aaSMatthew G. Knepley   if (g2) {PetscValidPointer(g2, 6); *g2 = prob->g2;}
25122764a2aaSMatthew G. Knepley   if (g3) {PetscValidPointer(g3, 7); *g3 = prob->g3;}
25132764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
25142764a2aaSMatthew G. Knepley }
25152764a2aaSMatthew G. Knepley 
25162764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetRefCoordArrays(PetscDS prob, PetscReal **x, PetscScalar **refSpaceDer)
25172764a2aaSMatthew G. Knepley {
25182764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
25192764a2aaSMatthew G. Knepley 
25202764a2aaSMatthew G. Knepley   PetscFunctionBegin;
25212764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
25222764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
25232764a2aaSMatthew G. Knepley   if (x)           {PetscValidPointer(x, 2);           *x           = prob->x;}
25242764a2aaSMatthew G. Knepley   if (refSpaceDer) {PetscValidPointer(refSpaceDer, 3); *refSpaceDer = prob->refSpaceDer;}
25252764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
25262764a2aaSMatthew G. Knepley }
25272764a2aaSMatthew G. Knepley 
252858ebd649SToby Isaac /*@C
252958ebd649SToby Isaac   PetscDSAddBoundary - Add a boundary condition to the model
253058ebd649SToby Isaac 
253158ebd649SToby Isaac   Input Parameters:
253258ebd649SToby Isaac + ds          - The PetscDS object
25332d47a189SJulian Andrej . type        - The type of condition, e.g. DM_BC_ESSENTIAL/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann)
253458ebd649SToby Isaac . name        - The BC name
253558ebd649SToby Isaac . labelname   - The label defining constrained points
253658ebd649SToby Isaac . field       - The field to constrain
253758ebd649SToby Isaac . numcomps    - The number of constrained field components
253858ebd649SToby Isaac . comps       - An array of constrained component numbers
253958ebd649SToby Isaac . bcFunc      - A pointwise function giving boundary values
254058ebd649SToby Isaac . numids      - The number of DMLabel ids for constrained points
254158ebd649SToby Isaac . ids         - An array of ids for constrained points
254258ebd649SToby Isaac - ctx         - An optional user context for bcFunc
254358ebd649SToby Isaac 
254458ebd649SToby Isaac   Options Database Keys:
254558ebd649SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids
254658ebd649SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components
254758ebd649SToby Isaac 
254858ebd649SToby Isaac   Level: developer
254958ebd649SToby Isaac 
255058ebd649SToby Isaac .seealso: PetscDSGetBoundary()
255158ebd649SToby Isaac @*/
2552a30ec4eaSSatish 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)
255358ebd649SToby Isaac {
255458ebd649SToby Isaac   DSBoundary     b;
255558ebd649SToby Isaac   PetscErrorCode ierr;
255658ebd649SToby Isaac 
255758ebd649SToby Isaac   PetscFunctionBegin;
255858ebd649SToby Isaac   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1);
255958ebd649SToby Isaac   ierr = PetscNew(&b);CHKERRQ(ierr);
256058ebd649SToby Isaac   ierr = PetscStrallocpy(name, (char **) &b->name);CHKERRQ(ierr);
256158ebd649SToby Isaac   ierr = PetscStrallocpy(labelname, (char **) &b->labelname);CHKERRQ(ierr);
256258ebd649SToby Isaac   ierr = PetscMalloc1(numcomps, &b->comps);CHKERRQ(ierr);
256358ebd649SToby Isaac   if (numcomps) {ierr = PetscMemcpy(b->comps, comps, numcomps*sizeof(PetscInt));CHKERRQ(ierr);}
256458ebd649SToby Isaac   ierr = PetscMalloc1(numids, &b->ids);CHKERRQ(ierr);
256558ebd649SToby Isaac   if (numids) {ierr = PetscMemcpy(b->ids, ids, numids*sizeof(PetscInt));CHKERRQ(ierr);}
2566f971fd6bSMatthew G. Knepley   b->type            = type;
256758ebd649SToby Isaac   b->field           = field;
256858ebd649SToby Isaac   b->numcomps        = numcomps;
256958ebd649SToby Isaac   b->func            = bcFunc;
257058ebd649SToby Isaac   b->numids          = numids;
257158ebd649SToby Isaac   b->ctx             = ctx;
257258ebd649SToby Isaac   b->next            = ds->boundary;
257358ebd649SToby Isaac   ds->boundary       = b;
257458ebd649SToby Isaac   PetscFunctionReturn(0);
257558ebd649SToby Isaac }
257658ebd649SToby Isaac 
257758ebd649SToby Isaac /*@
257858ebd649SToby Isaac   PetscDSGetNumBoundary - Get the number of registered BC
257958ebd649SToby Isaac 
258058ebd649SToby Isaac   Input Parameters:
258158ebd649SToby Isaac . ds - The PetscDS object
258258ebd649SToby Isaac 
258358ebd649SToby Isaac   Output Parameters:
258458ebd649SToby Isaac . numBd - The number of BC
258558ebd649SToby Isaac 
258658ebd649SToby Isaac   Level: intermediate
258758ebd649SToby Isaac 
258858ebd649SToby Isaac .seealso: PetscDSAddBoundary(), PetscDSGetBoundary()
258958ebd649SToby Isaac @*/
259058ebd649SToby Isaac PetscErrorCode PetscDSGetNumBoundary(PetscDS ds, PetscInt *numBd)
259158ebd649SToby Isaac {
259258ebd649SToby Isaac   DSBoundary b = ds->boundary;
259358ebd649SToby Isaac 
259458ebd649SToby Isaac   PetscFunctionBegin;
259558ebd649SToby Isaac   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1);
259658ebd649SToby Isaac   PetscValidPointer(numBd, 2);
259758ebd649SToby Isaac   *numBd = 0;
259858ebd649SToby Isaac   while (b) {++(*numBd); b = b->next;}
259958ebd649SToby Isaac   PetscFunctionReturn(0);
260058ebd649SToby Isaac }
260158ebd649SToby Isaac 
260258ebd649SToby Isaac /*@C
260358ebd649SToby Isaac   PetscDSGetBoundary - Add a boundary condition to the model
260458ebd649SToby Isaac 
260558ebd649SToby Isaac   Input Parameters:
260658ebd649SToby Isaac + ds          - The PetscDS object
260758ebd649SToby Isaac - bd          - The BC number
260858ebd649SToby Isaac 
260958ebd649SToby Isaac   Output Parameters:
26102d47a189SJulian Andrej + type        - The type of condition, e.g. DM_BC_ESSENTIAL/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann)
261158ebd649SToby Isaac . name        - The BC name
261258ebd649SToby Isaac . labelname   - The label defining constrained points
261358ebd649SToby Isaac . field       - The field to constrain
261458ebd649SToby Isaac . numcomps    - The number of constrained field components
261558ebd649SToby Isaac . comps       - An array of constrained component numbers
261658ebd649SToby Isaac . bcFunc      - A pointwise function giving boundary values
261758ebd649SToby Isaac . numids      - The number of DMLabel ids for constrained points
261858ebd649SToby Isaac . ids         - An array of ids for constrained points
261958ebd649SToby Isaac - ctx         - An optional user context for bcFunc
262058ebd649SToby Isaac 
262158ebd649SToby Isaac   Options Database Keys:
262258ebd649SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids
262358ebd649SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components
262458ebd649SToby Isaac 
262558ebd649SToby Isaac   Level: developer
262658ebd649SToby Isaac 
262758ebd649SToby Isaac .seealso: PetscDSAddBoundary()
262858ebd649SToby Isaac @*/
2629a30ec4eaSSatish 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)
263058ebd649SToby Isaac {
263158ebd649SToby Isaac   DSBoundary b    = ds->boundary;
263258ebd649SToby Isaac   PetscInt   n    = 0;
263358ebd649SToby Isaac 
263458ebd649SToby Isaac   PetscFunctionBegin;
263558ebd649SToby Isaac   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1);
263658ebd649SToby Isaac   while (b) {
263758ebd649SToby Isaac     if (n == bd) break;
263858ebd649SToby Isaac     b = b->next;
263958ebd649SToby Isaac     ++n;
264058ebd649SToby Isaac   }
264158ebd649SToby Isaac   if (!b) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Boundary %d is not in [0, %d)", bd, n);
2642f971fd6bSMatthew G. Knepley   if (type) {
2643f971fd6bSMatthew G. Knepley     PetscValidPointer(type, 3);
2644f971fd6bSMatthew G. Knepley     *type = b->type;
264558ebd649SToby Isaac   }
264658ebd649SToby Isaac   if (name) {
264758ebd649SToby Isaac     PetscValidPointer(name, 4);
264858ebd649SToby Isaac     *name = b->name;
264958ebd649SToby Isaac   }
265058ebd649SToby Isaac   if (labelname) {
265158ebd649SToby Isaac     PetscValidPointer(labelname, 5);
265258ebd649SToby Isaac     *labelname = b->labelname;
265358ebd649SToby Isaac   }
265458ebd649SToby Isaac   if (field) {
265558ebd649SToby Isaac     PetscValidPointer(field, 6);
265658ebd649SToby Isaac     *field = b->field;
265758ebd649SToby Isaac   }
265858ebd649SToby Isaac   if (numcomps) {
265958ebd649SToby Isaac     PetscValidPointer(numcomps, 7);
266058ebd649SToby Isaac     *numcomps = b->numcomps;
266158ebd649SToby Isaac   }
266258ebd649SToby Isaac   if (comps) {
266358ebd649SToby Isaac     PetscValidPointer(comps, 8);
266458ebd649SToby Isaac     *comps = b->comps;
266558ebd649SToby Isaac   }
266658ebd649SToby Isaac   if (func) {
266758ebd649SToby Isaac     PetscValidPointer(func, 9);
266858ebd649SToby Isaac     *func = b->func;
266958ebd649SToby Isaac   }
267058ebd649SToby Isaac   if (numids) {
267158ebd649SToby Isaac     PetscValidPointer(numids, 10);
267258ebd649SToby Isaac     *numids = b->numids;
267358ebd649SToby Isaac   }
267458ebd649SToby Isaac   if (ids) {
267558ebd649SToby Isaac     PetscValidPointer(ids, 11);
267658ebd649SToby Isaac     *ids = b->ids;
267758ebd649SToby Isaac   }
267858ebd649SToby Isaac   if (ctx) {
267958ebd649SToby Isaac     PetscValidPointer(ctx, 12);
268058ebd649SToby Isaac     *ctx = b->ctx;
268158ebd649SToby Isaac   }
268258ebd649SToby Isaac   PetscFunctionReturn(0);
268358ebd649SToby Isaac }
268458ebd649SToby Isaac 
2685dff059c6SToby Isaac PetscErrorCode PetscDSCopyBoundary(PetscDS probA, PetscDS probB)
2686dff059c6SToby Isaac {
2687dff059c6SToby Isaac   DSBoundary     b, next, *lastnext;
2688dff059c6SToby Isaac   PetscErrorCode ierr;
2689dff059c6SToby Isaac 
2690dff059c6SToby Isaac   PetscFunctionBegin;
2691dff059c6SToby Isaac   PetscValidHeaderSpecific(probA, PETSCDS_CLASSID, 1);
2692dff059c6SToby Isaac   PetscValidHeaderSpecific(probB, PETSCDS_CLASSID, 2);
2693dff059c6SToby Isaac   if (probA == probB) PetscFunctionReturn(0);
2694dff059c6SToby Isaac   next = probB->boundary;
2695dff059c6SToby Isaac   while (next) {
2696dff059c6SToby Isaac     DSBoundary b = next;
2697dff059c6SToby Isaac 
2698dff059c6SToby Isaac     next = b->next;
2699dff059c6SToby Isaac     ierr = PetscFree(b->comps);CHKERRQ(ierr);
2700dff059c6SToby Isaac     ierr = PetscFree(b->ids);CHKERRQ(ierr);
2701dff059c6SToby Isaac     ierr = PetscFree(b->name);CHKERRQ(ierr);
2702dff059c6SToby Isaac     ierr = PetscFree(b->labelname);CHKERRQ(ierr);
2703dff059c6SToby Isaac     ierr = PetscFree(b);CHKERRQ(ierr);
2704dff059c6SToby Isaac   }
2705dff059c6SToby Isaac   lastnext = &(probB->boundary);
2706dff059c6SToby Isaac   for (b = probA->boundary; b; b = b->next) {
2707dff059c6SToby Isaac     DSBoundary bNew;
2708dff059c6SToby Isaac 
2709459726d8SSatish Balay     ierr = PetscNew(&bNew);CHKERRQ(ierr);
2710dff059c6SToby Isaac     bNew->numcomps = b->numcomps;
2711dff059c6SToby Isaac     ierr = PetscMalloc1(bNew->numcomps, &bNew->comps);CHKERRQ(ierr);
2712dff059c6SToby Isaac     ierr = PetscMemcpy(bNew->comps, b->comps, bNew->numcomps*sizeof(PetscInt));CHKERRQ(ierr);
2713dff059c6SToby Isaac     bNew->numids = b->numids;
2714dff059c6SToby Isaac     ierr = PetscMalloc1(bNew->numids, &bNew->ids);CHKERRQ(ierr);
2715dff059c6SToby Isaac     ierr = PetscMemcpy(bNew->ids, b->ids, bNew->numids*sizeof(PetscInt));CHKERRQ(ierr);
2716dff059c6SToby Isaac     ierr = PetscStrallocpy(b->labelname,(char **) &(bNew->labelname));CHKERRQ(ierr);
2717dff059c6SToby Isaac     ierr = PetscStrallocpy(b->name,(char **) &(bNew->name));CHKERRQ(ierr);
2718dff059c6SToby Isaac     bNew->ctx   = b->ctx;
2719f971fd6bSMatthew G. Knepley     bNew->type  = b->type;
2720dff059c6SToby Isaac     bNew->field = b->field;
2721dff059c6SToby Isaac     bNew->func  = b->func;
2722dff059c6SToby Isaac 
2723dff059c6SToby Isaac     *lastnext = bNew;
2724dff059c6SToby Isaac     lastnext = &(bNew->next);
2725dff059c6SToby Isaac   }
2726dff059c6SToby Isaac   PetscFunctionReturn(0);
2727dff059c6SToby Isaac }
2728dff059c6SToby Isaac 
2729da51fcedSMatthew G. Knepley /*@
2730da51fcedSMatthew G. Knepley   PetscDSCopyEquations - Copy all pointwise function pointers to the new problem
2731da51fcedSMatthew G. Knepley 
2732da51fcedSMatthew G. Knepley   Not collective
2733da51fcedSMatthew G. Knepley 
2734da51fcedSMatthew G. Knepley   Input Parameter:
2735da51fcedSMatthew G. Knepley . prob - The PetscDS object
2736da51fcedSMatthew G. Knepley 
2737da51fcedSMatthew G. Knepley   Output Parameter:
2738da51fcedSMatthew G. Knepley . newprob - The PetscDS copy
2739da51fcedSMatthew G. Knepley 
2740da51fcedSMatthew G. Knepley   Level: intermediate
2741da51fcedSMatthew G. Knepley 
2742da51fcedSMatthew G. Knepley .seealso: PetscDSSetResidual(), PetscDSSetJacobian(), PetscDSSetRiemannSolver(), PetscDSSetBdResidual(), PetscDSSetBdJacobian(), PetscDSCreate()
2743da51fcedSMatthew G. Knepley @*/
2744da51fcedSMatthew G. Knepley PetscErrorCode PetscDSCopyEquations(PetscDS prob, PetscDS newprob)
2745da51fcedSMatthew G. Knepley {
2746da51fcedSMatthew G. Knepley   PetscInt       Nf, Ng, f, g;
2747da51fcedSMatthew G. Knepley   PetscErrorCode ierr;
2748da51fcedSMatthew G. Knepley 
2749da51fcedSMatthew G. Knepley   PetscFunctionBegin;
2750da51fcedSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2751da51fcedSMatthew G. Knepley   PetscValidHeaderSpecific(newprob, PETSCDS_CLASSID, 2);
2752da51fcedSMatthew G. Knepley   ierr = PetscDSGetNumFields(prob, &Nf);CHKERRQ(ierr);
2753da51fcedSMatthew G. Knepley   ierr = PetscDSGetNumFields(newprob, &Ng);CHKERRQ(ierr);
275413903a91SSatish Balay   if (Nf != Ng) SETERRQ2(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_SIZ, "Number of fields must match %D != %D", Nf, Ng);
2755da51fcedSMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
2756da51fcedSMatthew G. Knepley     PetscPointFunc   obj;
2757da51fcedSMatthew G. Knepley     PetscPointFunc   f0, f1;
2758da51fcedSMatthew G. Knepley     PetscPointJac    g0, g1, g2, g3;
2759da51fcedSMatthew G. Knepley     PetscBdPointFunc f0Bd, f1Bd;
2760da51fcedSMatthew G. Knepley     PetscBdPointJac  g0Bd, g1Bd, g2Bd, g3Bd;
2761da51fcedSMatthew G. Knepley     PetscRiemannFunc r;
2762da51fcedSMatthew G. Knepley 
2763da51fcedSMatthew G. Knepley     ierr = PetscDSGetObjective(prob, f, &obj);CHKERRQ(ierr);
2764da51fcedSMatthew G. Knepley     ierr = PetscDSGetResidual(prob, f, &f0, &f1);CHKERRQ(ierr);
2765da51fcedSMatthew G. Knepley     ierr = PetscDSGetBdResidual(prob, f, &f0Bd, &f1Bd);CHKERRQ(ierr);
2766da51fcedSMatthew G. Knepley     ierr = PetscDSGetRiemannSolver(prob, f, &r);CHKERRQ(ierr);
2767da51fcedSMatthew G. Knepley     ierr = PetscDSSetObjective(newprob, f, obj);CHKERRQ(ierr);
2768da51fcedSMatthew G. Knepley     ierr = PetscDSSetResidual(newprob, f, f0, f1);CHKERRQ(ierr);
2769da51fcedSMatthew G. Knepley     ierr = PetscDSSetBdResidual(newprob, f, f0Bd, f1Bd);CHKERRQ(ierr);
2770da51fcedSMatthew G. Knepley     ierr = PetscDSSetRiemannSolver(newprob, f, r);CHKERRQ(ierr);
2771da51fcedSMatthew G. Knepley     for (g = 0; g < Nf; ++g) {
2772da51fcedSMatthew G. Knepley       ierr = PetscDSGetJacobian(prob, f, g, &g0, &g1, &g2, &g3);CHKERRQ(ierr);
2773da51fcedSMatthew G. Knepley       ierr = PetscDSGetBdJacobian(prob, f, g, &g0Bd, &g1Bd, &g2Bd, &g3Bd);CHKERRQ(ierr);
2774da51fcedSMatthew G. Knepley       ierr = PetscDSSetJacobian(newprob, f, g, g0, g1, g2, g3);CHKERRQ(ierr);
2775da51fcedSMatthew G. Knepley       ierr = PetscDSSetBdJacobian(newprob, f, g, g0Bd, g1Bd, g2Bd, g3Bd);CHKERRQ(ierr);
2776da51fcedSMatthew G. Knepley     }
2777da51fcedSMatthew G. Knepley   }
2778da51fcedSMatthew G. Knepley   PetscFunctionReturn(0);
2779da51fcedSMatthew G. Knepley }
2780da51fcedSMatthew G. Knepley 
2781bc4ae4beSMatthew G. Knepley static PetscErrorCode PetscDSDestroy_Basic(PetscDS prob)
27822764a2aaSMatthew G. Knepley {
2783931fb3b8SToby Isaac   PetscErrorCode      ierr;
2784931fb3b8SToby Isaac 
27852764a2aaSMatthew G. Knepley   PetscFunctionBegin;
2786931fb3b8SToby Isaac   ierr = PetscFree(prob->data);CHKERRQ(ierr);
27872764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
27882764a2aaSMatthew G. Knepley }
27892764a2aaSMatthew G. Knepley 
2790bc4ae4beSMatthew G. Knepley static PetscErrorCode PetscDSInitialize_Basic(PetscDS prob)
27912764a2aaSMatthew G. Knepley {
27922764a2aaSMatthew G. Knepley   PetscFunctionBegin;
27932764a2aaSMatthew G. Knepley   prob->ops->setfromoptions = NULL;
27942764a2aaSMatthew G. Knepley   prob->ops->setup          = NULL;
27952764a2aaSMatthew G. Knepley   prob->ops->view           = NULL;
27962764a2aaSMatthew G. Knepley   prob->ops->destroy        = PetscDSDestroy_Basic;
27972764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
27982764a2aaSMatthew G. Knepley }
27992764a2aaSMatthew G. Knepley 
28002764a2aaSMatthew G. Knepley /*MC
28012764a2aaSMatthew G. Knepley   PETSCDSBASIC = "basic" - A discrete system with pointwise residual and boundary residual functions
28022764a2aaSMatthew G. Knepley 
28032764a2aaSMatthew G. Knepley   Level: intermediate
28042764a2aaSMatthew G. Knepley 
28052764a2aaSMatthew G. Knepley .seealso: PetscDSType, PetscDSCreate(), PetscDSSetType()
28062764a2aaSMatthew G. Knepley M*/
28072764a2aaSMatthew G. Knepley 
28082764a2aaSMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscDSCreate_Basic(PetscDS prob)
28092764a2aaSMatthew G. Knepley {
28102764a2aaSMatthew G. Knepley   PetscDS_Basic *b;
28112764a2aaSMatthew G. Knepley   PetscErrorCode      ierr;
28122764a2aaSMatthew G. Knepley 
28132764a2aaSMatthew G. Knepley   PetscFunctionBegin;
2814931fb3b8SToby Isaac   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
28152764a2aaSMatthew G. Knepley   ierr       = PetscNewLog(prob, &b);CHKERRQ(ierr);
28162764a2aaSMatthew G. Knepley   prob->data = b;
28172764a2aaSMatthew G. Knepley 
28182764a2aaSMatthew G. Knepley   ierr = PetscDSInitialize_Basic(prob);CHKERRQ(ierr);
28192764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
28202764a2aaSMatthew G. Knepley }
2821