xref: /petsc/src/dm/dt/interface/dtds.c (revision b1353e8e203a5c73fff22c22703ae84b330f9bf4)
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;
290d1506c7cSMatthew G. Knepley   PetscInt       dim, dimEmbed, 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);
298d1506c7cSMatthew G. Knepley   ierr = PetscDSGetCoordinateDimension(prob, &dimEmbed);CHKERRQ(ierr);
299f744cafaSSander Arens   prob->totDim = prob->totComp = 0;
30047e57110SSander Arens   ierr = PetscMalloc2(Nf,&prob->Nc,Nf,&prob->Nb);CHKERRQ(ierr);
301f744cafaSSander Arens   ierr = PetscCalloc2(Nf+1,&prob->off,Nf+1,&prob->offDer);CHKERRQ(ierr);
302f744cafaSSander Arens   ierr = PetscMalloc4(Nf,&prob->basis,Nf,&prob->basisDer,Nf,&prob->basisFace,Nf,&prob->basisDerFace);CHKERRQ(ierr);
3032764a2aaSMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
3049de99aefSMatthew G. Knepley     PetscObject     obj;
3059de99aefSMatthew G. Knepley     PetscClassId    id;
3062764a2aaSMatthew G. Knepley     PetscQuadrature q;
3079de99aefSMatthew G. Knepley     PetscInt        Nq = 0, Nb, Nc;
3082764a2aaSMatthew G. Knepley 
3099de99aefSMatthew G. Knepley     ierr = PetscDSGetDiscretization(prob, f, &obj);CHKERRQ(ierr);
3109de99aefSMatthew G. Knepley     ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr);
3119de99aefSMatthew G. Knepley     if (id == PETSCFE_CLASSID)      {
3129de99aefSMatthew G. Knepley       PetscFE fe = (PetscFE) obj;
3139de99aefSMatthew G. Knepley 
3142764a2aaSMatthew G. Knepley       ierr = PetscFEGetQuadrature(fe, &q);CHKERRQ(ierr);
3152764a2aaSMatthew G. Knepley       ierr = PetscFEGetDimension(fe, &Nb);CHKERRQ(ierr);
3162764a2aaSMatthew G. Knepley       ierr = PetscFEGetNumComponents(fe, &Nc);CHKERRQ(ierr);
3172764a2aaSMatthew G. Knepley       ierr = PetscFEGetDefaultTabulation(fe, &prob->basis[f], &prob->basisDer[f], NULL);CHKERRQ(ierr);
3184d0b9603SSander Arens       ierr = PetscFEGetFaceTabulation(fe, &prob->basisFace[f], &prob->basisDerFace[f], NULL);CHKERRQ(ierr);
3199de99aefSMatthew G. Knepley     } else if (id == PETSCFV_CLASSID) {
3209de99aefSMatthew G. Knepley       PetscFV fv = (PetscFV) obj;
3219de99aefSMatthew G. Knepley 
3229de99aefSMatthew G. Knepley       ierr = PetscFVGetQuadrature(fv, &q);CHKERRQ(ierr);
3239de99aefSMatthew G. Knepley       ierr = PetscFVGetNumComponents(fv, &Nc);CHKERRQ(ierr);
3249c3cf19fSMatthew G. Knepley       Nb   = Nc;
3256c1a3d01SMatthew G. Knepley       ierr = PetscFVGetDefaultTabulation(fv, &prob->basis[f], &prob->basisDer[f], NULL);CHKERRQ(ierr);
3264d0b9603SSander Arens       /* TODO: should PetscFV also have face tabulation? Otherwise there will be a null pointer in prob->basisFace */
327abac5ca0SMatthew G. Knepley     } else SETERRQ1(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Unknown discretization type for field %d", f);
32847e57110SSander Arens     prob->Nc[f]       = Nc;
32947e57110SSander Arens     prob->Nb[f]       = Nb;
330194d53e6SMatthew G. Knepley     prob->off[f+1]    = Nc     + prob->off[f];
331194d53e6SMatthew G. Knepley     prob->offDer[f+1] = Nc*dim + prob->offDer[f];
332a6b92713SMatthew G. Knepley     if (q) {ierr = PetscQuadratureGetData(q, NULL, NULL, &Nq, NULL, NULL);CHKERRQ(ierr);}
3332764a2aaSMatthew G. Knepley     NqMax          = PetscMax(NqMax, Nq);
3342764a2aaSMatthew G. Knepley     NcMax          = PetscMax(NcMax, Nc);
3359c3cf19fSMatthew G. Knepley     prob->totDim  += Nb;
3362764a2aaSMatthew G. Knepley     prob->totComp += Nc;
3372764a2aaSMatthew G. Knepley   }
3382764a2aaSMatthew G. Knepley   work = PetscMax(prob->totComp*dim, PetscSqr(NcMax*dim));
3392764a2aaSMatthew G. Knepley   /* Allocate works space */
340d1506c7cSMatthew G. Knepley   ierr = PetscMalloc5(prob->totComp,&prob->u,prob->totComp,&prob->u_t,prob->totComp*dim,&prob->u_x,dimEmbed,&prob->x,work,&prob->refSpaceDer);CHKERRQ(ierr);
3412764a2aaSMatthew 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);
3422764a2aaSMatthew G. Knepley   if (prob->ops->setup) {ierr = (*prob->ops->setup)(prob);CHKERRQ(ierr);}
3432764a2aaSMatthew G. Knepley   prob->setup = PETSC_TRUE;
3442764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
3452764a2aaSMatthew G. Knepley }
3462764a2aaSMatthew G. Knepley 
3472764a2aaSMatthew G. Knepley static PetscErrorCode PetscDSDestroyStructs_Static(PetscDS prob)
3482764a2aaSMatthew G. Knepley {
3492764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
3502764a2aaSMatthew G. Knepley 
3512764a2aaSMatthew G. Knepley   PetscFunctionBegin;
35247e57110SSander Arens   ierr = PetscFree2(prob->Nc,prob->Nb);CHKERRQ(ierr);
353f744cafaSSander Arens   ierr = PetscFree2(prob->off,prob->offDer);CHKERRQ(ierr);
354f744cafaSSander Arens   ierr = PetscFree4(prob->basis,prob->basisDer,prob->basisFace,prob->basisDerFace);CHKERRQ(ierr);
3552764a2aaSMatthew G. Knepley   ierr = PetscFree5(prob->u,prob->u_t,prob->u_x,prob->x,prob->refSpaceDer);CHKERRQ(ierr);
3562764a2aaSMatthew G. Knepley   ierr = PetscFree6(prob->f0,prob->f1,prob->g0,prob->g1,prob->g2,prob->g3);CHKERRQ(ierr);
3572764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
3582764a2aaSMatthew G. Knepley }
3592764a2aaSMatthew G. Knepley 
3602764a2aaSMatthew G. Knepley static PetscErrorCode PetscDSEnlarge_Static(PetscDS prob, PetscInt NfNew)
3612764a2aaSMatthew G. Knepley {
362f744cafaSSander Arens   PetscObject      *tmpd;
363a6cbbb48SMatthew G. Knepley   PetscBool        *tmpi, *tmpa;
36432d2bbc9SMatthew G. Knepley   PetscPointFunc   *tmpobj, *tmpf, *tmpup;
365b7e05686SMatthew G. Knepley   PetscPointJac    *tmpg, *tmpgp, *tmpgt;
3662aa1fc23SMatthew G. Knepley   PetscBdPointFunc *tmpfbd;
3672aa1fc23SMatthew G. Knepley   PetscBdPointJac  *tmpgbd;
368194d53e6SMatthew G. Knepley   PetscRiemannFunc *tmpr;
369c371a6d1SMatthew G. Knepley   PetscSimplePointFunc *tmpexactSol;
3700c2f2876SMatthew G. Knepley   void            **tmpctx;
371a6cbbb48SMatthew G. Knepley   PetscInt          Nf = prob->Nf, f, i;
3722764a2aaSMatthew G. Knepley   PetscErrorCode    ierr;
3732764a2aaSMatthew G. Knepley 
3742764a2aaSMatthew G. Knepley   PetscFunctionBegin;
3752764a2aaSMatthew G. Knepley   if (Nf >= NfNew) PetscFunctionReturn(0);
3762764a2aaSMatthew G. Knepley   prob->setup = PETSC_FALSE;
3772764a2aaSMatthew G. Knepley   ierr = PetscDSDestroyStructs_Static(prob);CHKERRQ(ierr);
378f744cafaSSander Arens   ierr = PetscMalloc3(NfNew, &tmpd, NfNew, &tmpi, NfNew*2, &tmpa);CHKERRQ(ierr);
379f744cafaSSander 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];}
380f744cafaSSander 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;}
381f744cafaSSander Arens   ierr = PetscFree3(prob->disc, prob->implicit, prob->adjacency);CHKERRQ(ierr);
3822764a2aaSMatthew G. Knepley   prob->Nf        = NfNew;
3832764a2aaSMatthew G. Knepley   prob->disc      = tmpd;
384249df284SMatthew G. Knepley   prob->implicit  = tmpi;
385a6cbbb48SMatthew G. Knepley   prob->adjacency = tmpa;
386b7e05686SMatthew 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);
38732d2bbc9SMatthew G. Knepley   ierr = PetscCalloc1(NfNew, &tmpup);CHKERRQ(ierr);
3882764a2aaSMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpobj[f] = prob->obj[f];
3892764a2aaSMatthew G. Knepley   for (f = 0; f < Nf*2; ++f) tmpf[f] = prob->f[f];
3902764a2aaSMatthew G. Knepley   for (f = 0; f < Nf*Nf*4; ++f) tmpg[f] = prob->g[f];
391475e0ac9SMatthew G. Knepley   for (f = 0; f < Nf*Nf*4; ++f) tmpgp[f] = prob->gp[f];
3920c2f2876SMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpr[f] = prob->r[f];
39332d2bbc9SMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpup[f] = prob->update[f];
3940c2f2876SMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpctx[f] = prob->ctx[f];
3952764a2aaSMatthew G. Knepley   for (f = Nf; f < NfNew; ++f) tmpobj[f] = NULL;
3962764a2aaSMatthew G. Knepley   for (f = Nf*2; f < NfNew*2; ++f) tmpf[f] = NULL;
3972764a2aaSMatthew G. Knepley   for (f = Nf*Nf*4; f < NfNew*NfNew*4; ++f) tmpg[f] = NULL;
398475e0ac9SMatthew G. Knepley   for (f = Nf*Nf*4; f < NfNew*NfNew*4; ++f) tmpgp[f] = NULL;
399b7e05686SMatthew G. Knepley   for (f = Nf*Nf*4; f < NfNew*NfNew*4; ++f) tmpgt[f] = NULL;
4000c2f2876SMatthew G. Knepley   for (f = Nf; f < NfNew; ++f) tmpr[f] = NULL;
40132d2bbc9SMatthew G. Knepley   for (f = Nf; f < NfNew; ++f) tmpup[f] = NULL;
4020c2f2876SMatthew G. Knepley   for (f = Nf; f < NfNew; ++f) tmpctx[f] = NULL;
403b7e05686SMatthew G. Knepley   ierr = PetscFree7(prob->obj, prob->f, prob->g, prob->gp, prob->gt, prob->r, prob->ctx);CHKERRQ(ierr);
40432d2bbc9SMatthew G. Knepley   ierr = PetscFree(prob->update);CHKERRQ(ierr);
4052764a2aaSMatthew G. Knepley   prob->obj = tmpobj;
4062764a2aaSMatthew G. Knepley   prob->f   = tmpf;
4072764a2aaSMatthew G. Knepley   prob->g   = tmpg;
408475e0ac9SMatthew G. Knepley   prob->gp  = tmpgp;
409b7e05686SMatthew G. Knepley   prob->gt  = tmpgt;
4100c2f2876SMatthew G. Knepley   prob->r   = tmpr;
41132d2bbc9SMatthew G. Knepley   prob->update = tmpup;
4120c2f2876SMatthew G. Knepley   prob->ctx = tmpctx;
413c371a6d1SMatthew G. Knepley   ierr = PetscCalloc3(NfNew*2, &tmpfbd, NfNew*NfNew*4, &tmpgbd, NfNew, &tmpexactSol);CHKERRQ(ierr);
4142764a2aaSMatthew G. Knepley   for (f = 0; f < Nf*2; ++f) tmpfbd[f] = prob->fBd[f];
4152764a2aaSMatthew G. Knepley   for (f = 0; f < Nf*Nf*4; ++f) tmpgbd[f] = prob->gBd[f];
416c371a6d1SMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpexactSol[f] = prob->exactSol[f];
4172764a2aaSMatthew G. Knepley   for (f = Nf*2; f < NfNew*2; ++f) tmpfbd[f] = NULL;
4182764a2aaSMatthew G. Knepley   for (f = Nf*Nf*4; f < NfNew*NfNew*4; ++f) tmpgbd[f] = NULL;
419c371a6d1SMatthew G. Knepley   for (f = Nf; f < NfNew; ++f) tmpexactSol[f] = NULL;
420c371a6d1SMatthew G. Knepley   ierr = PetscFree3(prob->fBd, prob->gBd, prob->exactSol);CHKERRQ(ierr);
4212764a2aaSMatthew G. Knepley   prob->fBd = tmpfbd;
4222764a2aaSMatthew G. Knepley   prob->gBd = tmpgbd;
423c371a6d1SMatthew G. Knepley   prob->exactSol = tmpexactSol;
4242764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
4252764a2aaSMatthew G. Knepley }
4262764a2aaSMatthew G. Knepley 
4272764a2aaSMatthew G. Knepley /*@
4282764a2aaSMatthew G. Knepley   PetscDSDestroy - Destroys a PetscDS object
4292764a2aaSMatthew G. Knepley 
4302764a2aaSMatthew G. Knepley   Collective on PetscDS
4312764a2aaSMatthew G. Knepley 
4322764a2aaSMatthew G. Knepley   Input Parameter:
4332764a2aaSMatthew G. Knepley . prob - the PetscDS object to destroy
4342764a2aaSMatthew G. Knepley 
4352764a2aaSMatthew G. Knepley   Level: developer
4362764a2aaSMatthew G. Knepley 
4372764a2aaSMatthew G. Knepley .seealso PetscDSView()
4382764a2aaSMatthew G. Knepley @*/
4392764a2aaSMatthew G. Knepley PetscErrorCode PetscDSDestroy(PetscDS *prob)
4402764a2aaSMatthew G. Knepley {
4412764a2aaSMatthew G. Knepley   PetscInt       f;
44258ebd649SToby Isaac   DSBoundary     next;
4432764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
4442764a2aaSMatthew G. Knepley 
4452764a2aaSMatthew G. Knepley   PetscFunctionBegin;
4462764a2aaSMatthew G. Knepley   if (!*prob) PetscFunctionReturn(0);
4472764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific((*prob), PETSCDS_CLASSID, 1);
4482764a2aaSMatthew G. Knepley 
4492764a2aaSMatthew G. Knepley   if (--((PetscObject)(*prob))->refct > 0) {*prob = 0; PetscFunctionReturn(0);}
4502764a2aaSMatthew G. Knepley   ((PetscObject) (*prob))->refct = 0;
4512764a2aaSMatthew G. Knepley   ierr = PetscDSDestroyStructs_Static(*prob);CHKERRQ(ierr);
452*b1353e8eSMatthew G. Knepley   ierr = PetscDSDestroy(&(*prob)->bdprob);CHKERRQ(ierr);
4532764a2aaSMatthew G. Knepley   for (f = 0; f < (*prob)->Nf; ++f) {
4542764a2aaSMatthew G. Knepley     ierr = PetscObjectDereference((*prob)->disc[f]);CHKERRQ(ierr);
4552764a2aaSMatthew G. Knepley   }
456f744cafaSSander Arens   ierr = PetscFree3((*prob)->disc, (*prob)->implicit, (*prob)->adjacency);CHKERRQ(ierr);
457b7e05686SMatthew G. Knepley   ierr = PetscFree7((*prob)->obj,(*prob)->f,(*prob)->g,(*prob)->gp,(*prob)->gt,(*prob)->r,(*prob)->ctx);CHKERRQ(ierr);
45832d2bbc9SMatthew G. Knepley   ierr = PetscFree((*prob)->update);CHKERRQ(ierr);
459c371a6d1SMatthew G. Knepley   ierr = PetscFree3((*prob)->fBd,(*prob)->gBd,(*prob)->exactSol);CHKERRQ(ierr);
4602764a2aaSMatthew G. Knepley   if ((*prob)->ops->destroy) {ierr = (*(*prob)->ops->destroy)(*prob);CHKERRQ(ierr);}
46158ebd649SToby Isaac   next = (*prob)->boundary;
46258ebd649SToby Isaac   while (next) {
46358ebd649SToby Isaac     DSBoundary b = next;
46458ebd649SToby Isaac 
46558ebd649SToby Isaac     next = b->next;
46658ebd649SToby Isaac     ierr = PetscFree(b->comps);CHKERRQ(ierr);
46758ebd649SToby Isaac     ierr = PetscFree(b->ids);CHKERRQ(ierr);
46858ebd649SToby Isaac     ierr = PetscFree(b->name);CHKERRQ(ierr);
46958ebd649SToby Isaac     ierr = PetscFree(b->labelname);CHKERRQ(ierr);
47058ebd649SToby Isaac     ierr = PetscFree(b);CHKERRQ(ierr);
47158ebd649SToby Isaac   }
47297b6e6e8SMatthew G. Knepley   ierr = PetscFree((*prob)->constants);CHKERRQ(ierr);
4732764a2aaSMatthew G. Knepley   ierr = PetscHeaderDestroy(prob);CHKERRQ(ierr);
4742764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
4752764a2aaSMatthew G. Knepley }
4762764a2aaSMatthew G. Knepley 
4772764a2aaSMatthew G. Knepley /*@
4782764a2aaSMatthew G. Knepley   PetscDSCreate - Creates an empty PetscDS object. The type can then be set with PetscDSSetType().
4792764a2aaSMatthew G. Knepley 
4802764a2aaSMatthew G. Knepley   Collective on MPI_Comm
4812764a2aaSMatthew G. Knepley 
4822764a2aaSMatthew G. Knepley   Input Parameter:
4832764a2aaSMatthew G. Knepley . comm - The communicator for the PetscDS object
4842764a2aaSMatthew G. Knepley 
4852764a2aaSMatthew G. Knepley   Output Parameter:
4862764a2aaSMatthew G. Knepley . prob - The PetscDS object
4872764a2aaSMatthew G. Knepley 
4882764a2aaSMatthew G. Knepley   Level: beginner
4892764a2aaSMatthew G. Knepley 
4902764a2aaSMatthew G. Knepley .seealso: PetscDSSetType(), PETSCDSBASIC
4912764a2aaSMatthew G. Knepley @*/
4922764a2aaSMatthew G. Knepley PetscErrorCode PetscDSCreate(MPI_Comm comm, PetscDS *prob)
4932764a2aaSMatthew G. Knepley {
4942764a2aaSMatthew G. Knepley   PetscDS   p;
4952764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
4962764a2aaSMatthew G. Knepley 
4972764a2aaSMatthew G. Knepley   PetscFunctionBegin;
4982764a2aaSMatthew G. Knepley   PetscValidPointer(prob, 2);
4992764a2aaSMatthew G. Knepley   *prob  = NULL;
5002764a2aaSMatthew G. Knepley   ierr = PetscDSInitializePackage();CHKERRQ(ierr);
5012764a2aaSMatthew G. Knepley 
50273107ff1SLisandro Dalcin   ierr = PetscHeaderCreate(p, PETSCDS_CLASSID, "PetscDS", "Discrete System", "PetscDS", comm, PetscDSDestroy, PetscDSView);CHKERRQ(ierr);
5032764a2aaSMatthew G. Knepley 
5042764a2aaSMatthew G. Knepley   p->Nf    = 0;
5052764a2aaSMatthew G. Knepley   p->setup = PETSC_FALSE;
50697b6e6e8SMatthew G. Knepley   p->numConstants = 0;
50797b6e6e8SMatthew G. Knepley   p->constants    = NULL;
508a859676bSMatthew G. Knepley   p->dimEmbed     = -1;
5092764a2aaSMatthew G. Knepley 
5102764a2aaSMatthew G. Knepley   *prob = p;
5112764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
5122764a2aaSMatthew G. Knepley }
5132764a2aaSMatthew G. Knepley 
514bc4ae4beSMatthew G. Knepley /*@
515bc4ae4beSMatthew G. Knepley   PetscDSGetNumFields - Returns the number of fields in the DS
516bc4ae4beSMatthew G. Knepley 
517bc4ae4beSMatthew G. Knepley   Not collective
518bc4ae4beSMatthew G. Knepley 
519bc4ae4beSMatthew G. Knepley   Input Parameter:
520bc4ae4beSMatthew G. Knepley . prob - The PetscDS object
521bc4ae4beSMatthew G. Knepley 
522bc4ae4beSMatthew G. Knepley   Output Parameter:
523bc4ae4beSMatthew G. Knepley . Nf - The number of fields
524bc4ae4beSMatthew G. Knepley 
525bc4ae4beSMatthew G. Knepley   Level: beginner
526bc4ae4beSMatthew G. Knepley 
527bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetSpatialDimension(), PetscDSCreate()
528bc4ae4beSMatthew G. Knepley @*/
5292764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetNumFields(PetscDS prob, PetscInt *Nf)
5302764a2aaSMatthew G. Knepley {
5312764a2aaSMatthew G. Knepley   PetscFunctionBegin;
5322764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
5332764a2aaSMatthew G. Knepley   PetscValidPointer(Nf, 2);
5342764a2aaSMatthew G. Knepley   *Nf = prob->Nf;
5352764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
5362764a2aaSMatthew G. Knepley }
5372764a2aaSMatthew G. Knepley 
538bc4ae4beSMatthew G. Knepley /*@
539a859676bSMatthew G. Knepley   PetscDSGetSpatialDimension - Returns the spatial dimension of the DS, meaning the topological dimension of the discretizations
540bc4ae4beSMatthew G. Knepley 
541bc4ae4beSMatthew G. Knepley   Not collective
542bc4ae4beSMatthew G. Knepley 
543bc4ae4beSMatthew G. Knepley   Input Parameter:
544bc4ae4beSMatthew G. Knepley . prob - The PetscDS object
545bc4ae4beSMatthew G. Knepley 
546bc4ae4beSMatthew G. Knepley   Output Parameter:
547bc4ae4beSMatthew G. Knepley . dim - The spatial dimension
548bc4ae4beSMatthew G. Knepley 
549bc4ae4beSMatthew G. Knepley   Level: beginner
550bc4ae4beSMatthew G. Knepley 
551a859676bSMatthew G. Knepley .seealso: PetscDSGetCoordinateDimension(), PetscDSGetNumFields(), PetscDSCreate()
552bc4ae4beSMatthew G. Knepley @*/
5532764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetSpatialDimension(PetscDS prob, PetscInt *dim)
5542764a2aaSMatthew G. Knepley {
5552764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
5562764a2aaSMatthew G. Knepley 
5572764a2aaSMatthew G. Knepley   PetscFunctionBegin;
5582764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
5592764a2aaSMatthew G. Knepley   PetscValidPointer(dim, 2);
5602764a2aaSMatthew G. Knepley   *dim = 0;
5619de99aefSMatthew G. Knepley   if (prob->Nf) {
5629de99aefSMatthew G. Knepley     PetscObject  obj;
5639de99aefSMatthew G. Knepley     PetscClassId id;
5649de99aefSMatthew G. Knepley 
5659de99aefSMatthew G. Knepley     ierr = PetscDSGetDiscretization(prob, 0, &obj);CHKERRQ(ierr);
5669de99aefSMatthew G. Knepley     ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr);
5679de99aefSMatthew G. Knepley     if (id == PETSCFE_CLASSID)      {ierr = PetscFEGetSpatialDimension((PetscFE) obj, dim);CHKERRQ(ierr);}
5689de99aefSMatthew G. Knepley     else if (id == PETSCFV_CLASSID) {ierr = PetscFVGetSpatialDimension((PetscFV) obj, dim);CHKERRQ(ierr);}
5699de99aefSMatthew G. Knepley     else SETERRQ1(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Unknown discretization type for field %d", 0);
5709de99aefSMatthew G. Knepley   }
5712764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
5722764a2aaSMatthew G. Knepley }
5732764a2aaSMatthew G. Knepley 
574bc4ae4beSMatthew G. Knepley /*@
575a859676bSMatthew G. Knepley   PetscDSGetCoordinateDimension - Returns the coordinate dimension of the DS, meaning the dimension of the space into which the discretiaztions are embedded
576a859676bSMatthew G. Knepley 
577a859676bSMatthew G. Knepley   Not collective
578a859676bSMatthew G. Knepley 
579a859676bSMatthew G. Knepley   Input Parameter:
580a859676bSMatthew G. Knepley . prob - The PetscDS object
581a859676bSMatthew G. Knepley 
582a859676bSMatthew G. Knepley   Output Parameter:
583a859676bSMatthew G. Knepley . dimEmbed - The coordinate dimension
584a859676bSMatthew G. Knepley 
585a859676bSMatthew G. Knepley   Level: beginner
586a859676bSMatthew G. Knepley 
587a859676bSMatthew G. Knepley .seealso: PetscDSSetCoordinateDimension(), PetscDSGetSpatialDimension(), PetscDSGetNumFields(), PetscDSCreate()
588a859676bSMatthew G. Knepley @*/
589a859676bSMatthew G. Knepley PetscErrorCode PetscDSGetCoordinateDimension(PetscDS prob, PetscInt *dimEmbed)
590a859676bSMatthew G. Knepley {
591a859676bSMatthew G. Knepley   PetscFunctionBegin;
592a859676bSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
593a859676bSMatthew G. Knepley   PetscValidPointer(dimEmbed, 2);
594a859676bSMatthew G. Knepley   if (prob->dimEmbed < 0) SETERRQ(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONGSTATE, "No coordinate dimension set for this DS");
595a859676bSMatthew G. Knepley   *dimEmbed = prob->dimEmbed;
596a859676bSMatthew G. Knepley   PetscFunctionReturn(0);
597a859676bSMatthew G. Knepley }
598a859676bSMatthew G. Knepley 
599a859676bSMatthew G. Knepley /*@
600a859676bSMatthew G. Knepley   PetscDSSetCoordinateDimension - Set the coordinate dimension of the DS, meaning the dimension of the space into which the discretiaztions are embedded
601a859676bSMatthew G. Knepley 
602a859676bSMatthew G. Knepley   Not collective
603a859676bSMatthew G. Knepley 
604a859676bSMatthew G. Knepley   Input Parameters:
605a859676bSMatthew G. Knepley + prob - The PetscDS object
606a859676bSMatthew G. Knepley - dimEmbed - The coordinate dimension
607a859676bSMatthew G. Knepley 
608a859676bSMatthew G. Knepley   Level: beginner
609a859676bSMatthew G. Knepley 
610a859676bSMatthew G. Knepley .seealso: PetscDSGetCoordinateDimension(), PetscDSGetSpatialDimension(), PetscDSGetNumFields(), PetscDSCreate()
611a859676bSMatthew G. Knepley @*/
612a859676bSMatthew G. Knepley PetscErrorCode PetscDSSetCoordinateDimension(PetscDS prob, PetscInt dimEmbed)
613a859676bSMatthew G. Knepley {
614a859676bSMatthew G. Knepley   PetscFunctionBegin;
615a859676bSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
616a859676bSMatthew G. Knepley   prob->dimEmbed = dimEmbed;
617a859676bSMatthew G. Knepley   PetscFunctionReturn(0);
618a859676bSMatthew G. Knepley }
619a859676bSMatthew G. Knepley 
620a859676bSMatthew G. Knepley /*@
621bc4ae4beSMatthew G. Knepley   PetscDSGetTotalDimension - Returns the total size of the approximation space for this system
622bc4ae4beSMatthew G. Knepley 
623bc4ae4beSMatthew G. Knepley   Not collective
624bc4ae4beSMatthew G. Knepley 
625bc4ae4beSMatthew G. Knepley   Input Parameter:
626bc4ae4beSMatthew G. Knepley . prob - The PetscDS object
627bc4ae4beSMatthew G. Knepley 
628bc4ae4beSMatthew G. Knepley   Output Parameter:
629bc4ae4beSMatthew G. Knepley . dim - The total problem dimension
630bc4ae4beSMatthew G. Knepley 
631bc4ae4beSMatthew G. Knepley   Level: beginner
632bc4ae4beSMatthew G. Knepley 
633bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetNumFields(), PetscDSCreate()
634bc4ae4beSMatthew G. Knepley @*/
6352764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetTotalDimension(PetscDS prob, PetscInt *dim)
6362764a2aaSMatthew G. Knepley {
6372764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
6382764a2aaSMatthew G. Knepley 
6392764a2aaSMatthew G. Knepley   PetscFunctionBegin;
6402764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
6412764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
6422764a2aaSMatthew G. Knepley   PetscValidPointer(dim, 2);
6432764a2aaSMatthew G. Knepley   *dim = prob->totDim;
6442764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
6452764a2aaSMatthew G. Knepley }
6462764a2aaSMatthew G. Knepley 
647bc4ae4beSMatthew G. Knepley /*@
648bc4ae4beSMatthew G. Knepley   PetscDSGetTotalComponents - Returns the total number of components in this system
649bc4ae4beSMatthew G. Knepley 
650bc4ae4beSMatthew G. Knepley   Not collective
651bc4ae4beSMatthew G. Knepley 
652bc4ae4beSMatthew G. Knepley   Input Parameter:
653bc4ae4beSMatthew G. Knepley . prob - The PetscDS object
654bc4ae4beSMatthew G. Knepley 
655bc4ae4beSMatthew G. Knepley   Output Parameter:
656bc4ae4beSMatthew G. Knepley . dim - The total number of components
657bc4ae4beSMatthew G. Knepley 
658bc4ae4beSMatthew G. Knepley   Level: beginner
659bc4ae4beSMatthew G. Knepley 
660bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetNumFields(), PetscDSCreate()
661bc4ae4beSMatthew G. Knepley @*/
6622764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetTotalComponents(PetscDS prob, PetscInt *Nc)
6632764a2aaSMatthew G. Knepley {
6642764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
6652764a2aaSMatthew G. Knepley 
6662764a2aaSMatthew G. Knepley   PetscFunctionBegin;
6672764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
6682764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
6692764a2aaSMatthew G. Knepley   PetscValidPointer(Nc, 2);
6702764a2aaSMatthew G. Knepley   *Nc = prob->totComp;
6712764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
6722764a2aaSMatthew G. Knepley }
6732764a2aaSMatthew G. Knepley 
674bc4ae4beSMatthew G. Knepley /*@
675bc4ae4beSMatthew G. Knepley   PetscDSGetDiscretization - Returns the discretization object for the given field
676bc4ae4beSMatthew G. Knepley 
677bc4ae4beSMatthew G. Knepley   Not collective
678bc4ae4beSMatthew G. Knepley 
679bc4ae4beSMatthew G. Knepley   Input Parameters:
680bc4ae4beSMatthew G. Knepley + prob - The PetscDS object
681bc4ae4beSMatthew G. Knepley - f - The field number
682bc4ae4beSMatthew G. Knepley 
683bc4ae4beSMatthew G. Knepley   Output Parameter:
684bc4ae4beSMatthew G. Knepley . disc - The discretization object
685bc4ae4beSMatthew G. Knepley 
686bc4ae4beSMatthew G. Knepley   Level: beginner
687bc4ae4beSMatthew G. Knepley 
688f744cafaSSander Arens .seealso: PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
689bc4ae4beSMatthew G. Knepley @*/
6902764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetDiscretization(PetscDS prob, PetscInt f, PetscObject *disc)
6912764a2aaSMatthew G. Knepley {
6922764a2aaSMatthew G. Knepley   PetscFunctionBegin;
6932764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
6942764a2aaSMatthew G. Knepley   PetscValidPointer(disc, 3);
6952764a2aaSMatthew 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);
6962764a2aaSMatthew G. Knepley   *disc = prob->disc[f];
6972764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
6982764a2aaSMatthew G. Knepley }
6992764a2aaSMatthew G. Knepley 
700bc4ae4beSMatthew G. Knepley /*@
701bc4ae4beSMatthew G. Knepley   PetscDSSetDiscretization - Sets the discretization object for the given field
702bc4ae4beSMatthew G. Knepley 
703bc4ae4beSMatthew G. Knepley   Not collective
704bc4ae4beSMatthew G. Knepley 
705bc4ae4beSMatthew G. Knepley   Input Parameters:
706bc4ae4beSMatthew G. Knepley + prob - The PetscDS object
707bc4ae4beSMatthew G. Knepley . f - The field number
708bc4ae4beSMatthew G. Knepley - disc - The discretization object
709bc4ae4beSMatthew G. Knepley 
710bc4ae4beSMatthew G. Knepley   Level: beginner
711bc4ae4beSMatthew G. Knepley 
712bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
713bc4ae4beSMatthew G. Knepley @*/
7142764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetDiscretization(PetscDS prob, PetscInt f, PetscObject disc)
7152764a2aaSMatthew G. Knepley {
7162764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
7172764a2aaSMatthew G. Knepley 
7182764a2aaSMatthew G. Knepley   PetscFunctionBegin;
7192764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
7202764a2aaSMatthew G. Knepley   PetscValidPointer(disc, 3);
7212764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
7222764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
7232764a2aaSMatthew G. Knepley   if (prob->disc[f]) {ierr = PetscObjectDereference(prob->disc[f]);CHKERRQ(ierr);}
7242764a2aaSMatthew G. Knepley   prob->disc[f] = disc;
7252764a2aaSMatthew G. Knepley   ierr = PetscObjectReference(disc);CHKERRQ(ierr);
726249df284SMatthew G. Knepley   {
727249df284SMatthew G. Knepley     PetscClassId id;
728249df284SMatthew G. Knepley 
729249df284SMatthew G. Knepley     ierr = PetscObjectGetClassId(disc, &id);CHKERRQ(ierr);
730a6cbbb48SMatthew G. Knepley     if (id == PETSCFV_CLASSID) {
731a6cbbb48SMatthew G. Knepley       prob->implicit[f]      = PETSC_FALSE;
732a6cbbb48SMatthew G. Knepley       prob->adjacency[f*2+0] = PETSC_TRUE;
733a6cbbb48SMatthew G. Knepley       prob->adjacency[f*2+1] = PETSC_FALSE;
734a6cbbb48SMatthew G. Knepley     }
735249df284SMatthew G. Knepley   }
7362764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
7372764a2aaSMatthew G. Knepley }
7382764a2aaSMatthew G. Knepley 
739bc4ae4beSMatthew G. Knepley /*@
740bc4ae4beSMatthew G. Knepley   PetscDSAddDiscretization - Adds a discretization object
741bc4ae4beSMatthew G. Knepley 
742bc4ae4beSMatthew G. Knepley   Not collective
743bc4ae4beSMatthew G. Knepley 
744bc4ae4beSMatthew G. Knepley   Input Parameters:
745bc4ae4beSMatthew G. Knepley + prob - The PetscDS object
746bc4ae4beSMatthew G. Knepley - disc - The boundary discretization object
747bc4ae4beSMatthew G. Knepley 
748bc4ae4beSMatthew G. Knepley   Level: beginner
749bc4ae4beSMatthew G. Knepley 
750bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetDiscretization(), PetscDSSetDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
751bc4ae4beSMatthew G. Knepley @*/
7522764a2aaSMatthew G. Knepley PetscErrorCode PetscDSAddDiscretization(PetscDS prob, PetscObject disc)
7532764a2aaSMatthew G. Knepley {
7542764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
7552764a2aaSMatthew G. Knepley 
7562764a2aaSMatthew G. Knepley   PetscFunctionBegin;
7572764a2aaSMatthew G. Knepley   ierr = PetscDSSetDiscretization(prob, prob->Nf, disc);CHKERRQ(ierr);
7582764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
7592764a2aaSMatthew G. Knepley }
7602764a2aaSMatthew G. Knepley 
761249df284SMatthew G. Knepley /*@
762249df284SMatthew G. Knepley   PetscDSGetImplicit - Returns the flag for implicit solve for this field. This is just a guide for IMEX
763249df284SMatthew G. Knepley 
764249df284SMatthew G. Knepley   Not collective
765249df284SMatthew G. Knepley 
766249df284SMatthew G. Knepley   Input Parameters:
767249df284SMatthew G. Knepley + prob - The PetscDS object
768249df284SMatthew G. Knepley - f - The field number
769249df284SMatthew G. Knepley 
770249df284SMatthew G. Knepley   Output Parameter:
771249df284SMatthew G. Knepley . implicit - The flag indicating what kind of solve to use for this field
772249df284SMatthew G. Knepley 
773249df284SMatthew G. Knepley   Level: developer
774249df284SMatthew G. Knepley 
775f744cafaSSander Arens .seealso: PetscDSSetImplicit(), PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
776249df284SMatthew G. Knepley @*/
777249df284SMatthew G. Knepley PetscErrorCode PetscDSGetImplicit(PetscDS prob, PetscInt f, PetscBool *implicit)
778249df284SMatthew G. Knepley {
779249df284SMatthew G. Knepley   PetscFunctionBegin;
780249df284SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
781249df284SMatthew G. Knepley   PetscValidPointer(implicit, 3);
782249df284SMatthew 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);
783249df284SMatthew G. Knepley   *implicit = prob->implicit[f];
784249df284SMatthew G. Knepley   PetscFunctionReturn(0);
785249df284SMatthew G. Knepley }
786249df284SMatthew G. Knepley 
787249df284SMatthew G. Knepley /*@
788249df284SMatthew G. Knepley   PetscDSSetImplicit - Set the flag for implicit solve for this field. This is just a guide for IMEX
789249df284SMatthew G. Knepley 
790249df284SMatthew G. Knepley   Not collective
791249df284SMatthew G. Knepley 
792249df284SMatthew G. Knepley   Input Parameters:
793249df284SMatthew G. Knepley + prob - The PetscDS object
794249df284SMatthew G. Knepley . f - The field number
795249df284SMatthew G. Knepley - implicit - The flag indicating what kind of solve to use for this field
796249df284SMatthew G. Knepley 
797249df284SMatthew G. Knepley   Level: developer
798249df284SMatthew G. Knepley 
799f744cafaSSander Arens .seealso: PetscDSGetImplicit(), PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
800249df284SMatthew G. Knepley @*/
801249df284SMatthew G. Knepley PetscErrorCode PetscDSSetImplicit(PetscDS prob, PetscInt f, PetscBool implicit)
802249df284SMatthew G. Knepley {
803249df284SMatthew G. Knepley   PetscFunctionBegin;
804249df284SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
805249df284SMatthew 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);
806249df284SMatthew G. Knepley   prob->implicit[f] = implicit;
807249df284SMatthew G. Knepley   PetscFunctionReturn(0);
808249df284SMatthew G. Knepley }
809249df284SMatthew G. Knepley 
810a6cbbb48SMatthew G. Knepley /*@
811a6cbbb48SMatthew G. Knepley   PetscDSGetAdjacency - Returns the flags for determining variable influence
812a6cbbb48SMatthew G. Knepley 
813a6cbbb48SMatthew G. Knepley   Not collective
814a6cbbb48SMatthew G. Knepley 
815a6cbbb48SMatthew G. Knepley   Input Parameters:
816a6cbbb48SMatthew G. Knepley + prob - The PetscDS object
817a6cbbb48SMatthew G. Knepley - f - The field number
818a6cbbb48SMatthew G. Knepley 
819a6cbbb48SMatthew G. Knepley   Output Parameter:
820a6cbbb48SMatthew G. Knepley + useCone    - Flag for variable influence starting with the cone operation
821a6cbbb48SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
822a6cbbb48SMatthew G. Knepley 
823a6cbbb48SMatthew G. Knepley   Note: See the discussion in DMPlexGetAdjacencyUseCone() and DMPlexGetAdjacencyUseClosure()
824a6cbbb48SMatthew G. Knepley 
825a6cbbb48SMatthew G. Knepley   Level: developer
826a6cbbb48SMatthew G. Knepley 
827f744cafaSSander Arens .seealso: PetscDSSetAdjacency(), DMPlexGetAdjacencyUseCone(), DMPlexGetAdjacencyUseClosure(), PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
828a6cbbb48SMatthew G. Knepley @*/
829a6cbbb48SMatthew G. Knepley PetscErrorCode PetscDSGetAdjacency(PetscDS prob, PetscInt f, PetscBool *useCone, PetscBool *useClosure)
830a6cbbb48SMatthew G. Knepley {
831a6cbbb48SMatthew G. Knepley   PetscFunctionBegin;
832a6cbbb48SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
833a6cbbb48SMatthew G. Knepley   PetscValidPointer(useCone, 3);
834a6cbbb48SMatthew G. Knepley   PetscValidPointer(useClosure, 4);
835a6cbbb48SMatthew 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);
836a6cbbb48SMatthew G. Knepley   *useCone    = prob->adjacency[f*2+0];
837a6cbbb48SMatthew G. Knepley   *useClosure = prob->adjacency[f*2+1];
838a6cbbb48SMatthew G. Knepley   PetscFunctionReturn(0);
839a6cbbb48SMatthew G. Knepley }
840a6cbbb48SMatthew G. Knepley 
841a6cbbb48SMatthew G. Knepley /*@
842a6cbbb48SMatthew G. Knepley   PetscDSSetAdjacency - Set the flags for determining variable influence
843a6cbbb48SMatthew G. Knepley 
844a6cbbb48SMatthew G. Knepley   Not collective
845a6cbbb48SMatthew G. Knepley 
846a6cbbb48SMatthew G. Knepley   Input Parameters:
847a6cbbb48SMatthew G. Knepley + prob - The PetscDS object
848a6cbbb48SMatthew G. Knepley . f - The field number
849a6cbbb48SMatthew G. Knepley . useCone    - Flag for variable influence starting with the cone operation
850a6cbbb48SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
851a6cbbb48SMatthew G. Knepley 
852a6cbbb48SMatthew G. Knepley   Note: See the discussion in DMPlexGetAdjacencyUseCone() and DMPlexGetAdjacencyUseClosure()
853a6cbbb48SMatthew G. Knepley 
854a6cbbb48SMatthew G. Knepley   Level: developer
855a6cbbb48SMatthew G. Knepley 
856f744cafaSSander Arens .seealso: PetscDSGetAdjacency(), DMPlexGetAdjacencyUseCone(), DMPlexGetAdjacencyUseClosure(), PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
857a6cbbb48SMatthew G. Knepley @*/
858a6cbbb48SMatthew G. Knepley PetscErrorCode PetscDSSetAdjacency(PetscDS prob, PetscInt f, PetscBool useCone, PetscBool useClosure)
859a6cbbb48SMatthew G. Knepley {
860a6cbbb48SMatthew G. Knepley   PetscFunctionBegin;
861a6cbbb48SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
862a6cbbb48SMatthew 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);
863a6cbbb48SMatthew G. Knepley   prob->adjacency[f*2+0] = useCone;
864a6cbbb48SMatthew G. Knepley   prob->adjacency[f*2+1] = useClosure;
865a6cbbb48SMatthew G. Knepley   PetscFunctionReturn(0);
866a6cbbb48SMatthew G. Knepley }
867a6cbbb48SMatthew G. Knepley 
8682764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetObjective(PetscDS prob, PetscInt f,
86930b9ff8bSMatthew G. Knepley                                    void (**obj)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
870194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
871194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
87297b6e6e8SMatthew G. Knepley                                                 PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar obj[]))
8732764a2aaSMatthew G. Knepley {
8742764a2aaSMatthew G. Knepley   PetscFunctionBegin;
8752764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
8762764a2aaSMatthew G. Knepley   PetscValidPointer(obj, 2);
8772764a2aaSMatthew 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);
8782764a2aaSMatthew G. Knepley   *obj = prob->obj[f];
8792764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
8802764a2aaSMatthew G. Knepley }
8812764a2aaSMatthew G. Knepley 
8822764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetObjective(PetscDS prob, PetscInt f,
88330b9ff8bSMatthew G. Knepley                                    void (*obj)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
884194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
885194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
88697b6e6e8SMatthew G. Knepley                                                PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar obj[]))
8872764a2aaSMatthew G. Knepley {
8882764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
8892764a2aaSMatthew G. Knepley 
8902764a2aaSMatthew G. Knepley   PetscFunctionBegin;
8912764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
892de716cbcSToby Isaac   if (obj) PetscValidFunction(obj, 2);
8932764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
8942764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
8952764a2aaSMatthew G. Knepley   prob->obj[f] = obj;
8962764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
8972764a2aaSMatthew G. Knepley }
8982764a2aaSMatthew G. Knepley 
899194d53e6SMatthew G. Knepley /*@C
900194d53e6SMatthew G. Knepley   PetscDSGetResidual - Get the pointwise residual function for a given test field
901194d53e6SMatthew G. Knepley 
902194d53e6SMatthew G. Knepley   Not collective
903194d53e6SMatthew G. Knepley 
904194d53e6SMatthew G. Knepley   Input Parameters:
905194d53e6SMatthew G. Knepley + prob - The PetscDS
906194d53e6SMatthew G. Knepley - f    - The test field number
907194d53e6SMatthew G. Knepley 
908194d53e6SMatthew G. Knepley   Output Parameters:
909194d53e6SMatthew G. Knepley + f0 - integrand for the test function term
910194d53e6SMatthew G. Knepley - f1 - integrand for the test function gradient term
911194d53e6SMatthew G. Knepley 
912194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
913194d53e6SMatthew G. Knepley 
914194d53e6SMatthew 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)
915194d53e6SMatthew G. Knepley 
916194d53e6SMatthew G. Knepley The calling sequence for the callbacks f0 and f1 is given by:
917194d53e6SMatthew G. Knepley 
91830b9ff8bSMatthew G. Knepley $ f0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
919194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
920194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
92130b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], PetscScalar f0[])
922194d53e6SMatthew G. Knepley 
923194d53e6SMatthew G. Knepley + dim - the spatial dimension
924194d53e6SMatthew G. Knepley . Nf - the number of fields
925194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
926194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
927194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
928194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
929194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
930194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
931194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
932194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
933194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
934194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
935194d53e6SMatthew G. Knepley . t - current time
936194d53e6SMatthew G. Knepley . x - coordinates of the current point
93797b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
93897b6e6e8SMatthew G. Knepley . constants - constant parameters
939194d53e6SMatthew G. Knepley - f0 - output values at the current point
940194d53e6SMatthew G. Knepley 
941194d53e6SMatthew G. Knepley   Level: intermediate
942194d53e6SMatthew G. Knepley 
943194d53e6SMatthew G. Knepley .seealso: PetscDSSetResidual()
944194d53e6SMatthew G. Knepley @*/
9452764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetResidual(PetscDS prob, PetscInt f,
94630b9ff8bSMatthew G. Knepley                                   void (**f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
947194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
948194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
94997b6e6e8SMatthew G. Knepley                                               PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f0[]),
95030b9ff8bSMatthew G. Knepley                                   void (**f1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
951194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
952194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
95397b6e6e8SMatthew G. Knepley                                               PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f1[]))
9542764a2aaSMatthew G. Knepley {
9552764a2aaSMatthew G. Knepley   PetscFunctionBegin;
9562764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
9572764a2aaSMatthew 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);
9582764a2aaSMatthew G. Knepley   if (f0) {PetscValidPointer(f0, 3); *f0 = prob->f[f*2+0];}
9592764a2aaSMatthew G. Knepley   if (f1) {PetscValidPointer(f1, 4); *f1 = prob->f[f*2+1];}
9602764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
9612764a2aaSMatthew G. Knepley }
9622764a2aaSMatthew G. Knepley 
963194d53e6SMatthew G. Knepley /*@C
964194d53e6SMatthew G. Knepley   PetscDSSetResidual - Set the pointwise residual function for a given test field
965194d53e6SMatthew G. Knepley 
966194d53e6SMatthew G. Knepley   Not collective
967194d53e6SMatthew G. Knepley 
968194d53e6SMatthew G. Knepley   Input Parameters:
969194d53e6SMatthew G. Knepley + prob - The PetscDS
970194d53e6SMatthew G. Knepley . f    - The test field number
971194d53e6SMatthew G. Knepley . f0 - integrand for the test function term
972194d53e6SMatthew G. Knepley - f1 - integrand for the test function gradient term
973194d53e6SMatthew G. Knepley 
974194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
975194d53e6SMatthew G. Knepley 
976194d53e6SMatthew 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)
977194d53e6SMatthew G. Knepley 
978194d53e6SMatthew G. Knepley The calling sequence for the callbacks f0 and f1 is given by:
979194d53e6SMatthew G. Knepley 
98030b9ff8bSMatthew G. Knepley $ f0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
981194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
982194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
98330b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], PetscScalar f0[])
984194d53e6SMatthew G. Knepley 
985194d53e6SMatthew G. Knepley + dim - the spatial dimension
986194d53e6SMatthew G. Knepley . Nf - the number of fields
987194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
988194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
989194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
990194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
991194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
992194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
993194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
994194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
995194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
996194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
997194d53e6SMatthew G. Knepley . t - current time
998194d53e6SMatthew G. Knepley . x - coordinates of the current point
99997b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
100097b6e6e8SMatthew G. Knepley . constants - constant parameters
1001194d53e6SMatthew G. Knepley - f0 - output values at the current point
1002194d53e6SMatthew G. Knepley 
1003194d53e6SMatthew G. Knepley   Level: intermediate
1004194d53e6SMatthew G. Knepley 
1005194d53e6SMatthew G. Knepley .seealso: PetscDSGetResidual()
1006194d53e6SMatthew G. Knepley @*/
10072764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetResidual(PetscDS prob, PetscInt f,
100830b9ff8bSMatthew G. Knepley                                   void (*f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1009194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1010194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
101197b6e6e8SMatthew G. Knepley                                              PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f0[]),
101230b9ff8bSMatthew G. Knepley                                   void (*f1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1013194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1014194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
101597b6e6e8SMatthew G. Knepley                                              PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f1[]))
10162764a2aaSMatthew G. Knepley {
10172764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
10182764a2aaSMatthew G. Knepley 
10192764a2aaSMatthew G. Knepley   PetscFunctionBegin;
10202764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1021f866a1d0SMatthew G. Knepley   if (f0) PetscValidFunction(f0, 3);
1022f866a1d0SMatthew G. Knepley   if (f1) PetscValidFunction(f1, 4);
10232764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
10242764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
10252764a2aaSMatthew G. Knepley   prob->f[f*2+0] = f0;
10262764a2aaSMatthew G. Knepley   prob->f[f*2+1] = f1;
10272764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
10282764a2aaSMatthew G. Knepley }
10292764a2aaSMatthew G. Knepley 
10303e75805dSMatthew G. Knepley /*@C
10313e75805dSMatthew G. Knepley   PetscDSHasJacobian - Signals that Jacobian functions have been set
10323e75805dSMatthew G. Knepley 
10333e75805dSMatthew G. Knepley   Not collective
10343e75805dSMatthew G. Knepley 
10353e75805dSMatthew G. Knepley   Input Parameter:
10363e75805dSMatthew G. Knepley . prob - The PetscDS
10373e75805dSMatthew G. Knepley 
10383e75805dSMatthew G. Knepley   Output Parameter:
10393e75805dSMatthew G. Knepley . hasJac - flag that pointwise function for the Jacobian has been set
10403e75805dSMatthew G. Knepley 
10413e75805dSMatthew G. Knepley   Level: intermediate
10423e75805dSMatthew G. Knepley 
10433e75805dSMatthew G. Knepley .seealso: PetscDSGetJacobianPreconditioner(), PetscDSSetJacobianPreconditioner(), PetscDSGetJacobian()
10443e75805dSMatthew G. Knepley @*/
10453e75805dSMatthew G. Knepley PetscErrorCode PetscDSHasJacobian(PetscDS prob, PetscBool *hasJac)
10463e75805dSMatthew G. Knepley {
10473e75805dSMatthew G. Knepley   PetscInt f, g, h;
10483e75805dSMatthew G. Knepley 
10493e75805dSMatthew G. Knepley   PetscFunctionBegin;
10503e75805dSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
10513e75805dSMatthew G. Knepley   *hasJac = PETSC_FALSE;
10523e75805dSMatthew G. Knepley   for (f = 0; f < prob->Nf; ++f) {
10533e75805dSMatthew G. Knepley     for (g = 0; g < prob->Nf; ++g) {
10543e75805dSMatthew G. Knepley       for (h = 0; h < 4; ++h) {
10553e75805dSMatthew G. Knepley         if (prob->g[(f*prob->Nf + g)*4+h]) *hasJac = PETSC_TRUE;
10563e75805dSMatthew G. Knepley       }
10573e75805dSMatthew G. Knepley     }
10583e75805dSMatthew G. Knepley   }
10593e75805dSMatthew G. Knepley   PetscFunctionReturn(0);
10603e75805dSMatthew G. Knepley }
10613e75805dSMatthew G. Knepley 
1062194d53e6SMatthew G. Knepley /*@C
1063194d53e6SMatthew G. Knepley   PetscDSGetJacobian - Get the pointwise Jacobian function for given test and basis field
1064194d53e6SMatthew G. Knepley 
1065194d53e6SMatthew G. Knepley   Not collective
1066194d53e6SMatthew G. Knepley 
1067194d53e6SMatthew G. Knepley   Input Parameters:
1068194d53e6SMatthew G. Knepley + prob - The PetscDS
1069194d53e6SMatthew G. Knepley . f    - The test field number
1070194d53e6SMatthew G. Knepley - g    - The field number
1071194d53e6SMatthew G. Knepley 
1072194d53e6SMatthew G. Knepley   Output Parameters:
1073194d53e6SMatthew G. Knepley + g0 - integrand for the test and basis function term
1074194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1075194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1076194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1077194d53e6SMatthew G. Knepley 
1078194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1079194d53e6SMatthew G. Knepley 
1080194d53e6SMatthew 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
1081194d53e6SMatthew G. Knepley 
1082194d53e6SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1083194d53e6SMatthew G. Knepley 
108430b9ff8bSMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1085194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1086194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
108730b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal u_tShift, const PetscReal x[], PetscScalar g0[])
1088194d53e6SMatthew G. Knepley 
1089194d53e6SMatthew G. Knepley + dim - the spatial dimension
1090194d53e6SMatthew G. Knepley . Nf - the number of fields
1091194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1092194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1093194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
1094194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1095194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1096194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1097194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1098194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1099194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1100194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1101194d53e6SMatthew G. Knepley . t - current time
11022aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1103194d53e6SMatthew G. Knepley . x - coordinates of the current point
110497b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
110597b6e6e8SMatthew G. Knepley . constants - constant parameters
1106194d53e6SMatthew G. Knepley - g0 - output values at the current point
1107194d53e6SMatthew G. Knepley 
1108194d53e6SMatthew G. Knepley   Level: intermediate
1109194d53e6SMatthew G. Knepley 
1110194d53e6SMatthew G. Knepley .seealso: PetscDSSetJacobian()
1111194d53e6SMatthew G. Knepley @*/
11122764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetJacobian(PetscDS prob, PetscInt f, PetscInt g,
111330b9ff8bSMatthew G. Knepley                                   void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1114194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1115194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
111697b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
111730b9ff8bSMatthew G. Knepley                                   void (**g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1118194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1119194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
112097b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
112130b9ff8bSMatthew G. Knepley                                   void (**g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1122194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1123194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
112497b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
112530b9ff8bSMatthew G. Knepley                                   void (**g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1126194d53e6SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1127194d53e6SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
112897b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
11292764a2aaSMatthew G. Knepley {
11302764a2aaSMatthew G. Knepley   PetscFunctionBegin;
11312764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
11322764a2aaSMatthew 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);
11332764a2aaSMatthew 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);
11342764a2aaSMatthew G. Knepley   if (g0) {PetscValidPointer(g0, 4); *g0 = prob->g[(f*prob->Nf + g)*4+0];}
11352764a2aaSMatthew G. Knepley   if (g1) {PetscValidPointer(g1, 5); *g1 = prob->g[(f*prob->Nf + g)*4+1];}
11362764a2aaSMatthew G. Knepley   if (g2) {PetscValidPointer(g2, 6); *g2 = prob->g[(f*prob->Nf + g)*4+2];}
11372764a2aaSMatthew G. Knepley   if (g3) {PetscValidPointer(g3, 7); *g3 = prob->g[(f*prob->Nf + g)*4+3];}
11382764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
11392764a2aaSMatthew G. Knepley }
11402764a2aaSMatthew G. Knepley 
1141194d53e6SMatthew G. Knepley /*@C
1142194d53e6SMatthew G. Knepley   PetscDSSetJacobian - Set the pointwise Jacobian function for given test and basis fields
1143194d53e6SMatthew G. Knepley 
1144194d53e6SMatthew G. Knepley   Not collective
1145194d53e6SMatthew G. Knepley 
1146194d53e6SMatthew G. Knepley   Input Parameters:
1147194d53e6SMatthew G. Knepley + prob - The PetscDS
1148194d53e6SMatthew G. Knepley . f    - The test field number
1149194d53e6SMatthew G. Knepley . g    - The field number
1150194d53e6SMatthew G. Knepley . g0 - integrand for the test and basis function term
1151194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1152194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1153194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1154194d53e6SMatthew G. Knepley 
1155194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1156194d53e6SMatthew G. Knepley 
1157194d53e6SMatthew 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
1158194d53e6SMatthew G. Knepley 
1159194d53e6SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1160194d53e6SMatthew G. Knepley 
116130b9ff8bSMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1162194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1163194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
116430b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], PetscScalar g0[])
1165194d53e6SMatthew G. Knepley 
1166194d53e6SMatthew G. Knepley + dim - the spatial dimension
1167194d53e6SMatthew G. Knepley . Nf - the number of fields
1168194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1169194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1170194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
1171194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1172194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1173194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1174194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1175194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1176194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1177194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1178194d53e6SMatthew G. Knepley . t - current time
11792aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1180194d53e6SMatthew G. Knepley . x - coordinates of the current point
118197b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
118297b6e6e8SMatthew G. Knepley . constants - constant parameters
1183194d53e6SMatthew G. Knepley - g0 - output values at the current point
1184194d53e6SMatthew G. Knepley 
1185194d53e6SMatthew G. Knepley   Level: intermediate
1186194d53e6SMatthew G. Knepley 
1187194d53e6SMatthew G. Knepley .seealso: PetscDSGetJacobian()
1188194d53e6SMatthew G. Knepley @*/
11892764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetJacobian(PetscDS prob, PetscInt f, PetscInt g,
119030b9ff8bSMatthew G. Knepley                                   void (*g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1191194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1192194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
119397b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
119430b9ff8bSMatthew G. Knepley                                   void (*g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1195194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1196194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
119797b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
119830b9ff8bSMatthew G. Knepley                                   void (*g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1199194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1200194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
120197b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
120230b9ff8bSMatthew G. Knepley                                   void (*g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1203194d53e6SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1204194d53e6SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
120597b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
12062764a2aaSMatthew G. Knepley {
12072764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
12082764a2aaSMatthew G. Knepley 
12092764a2aaSMatthew G. Knepley   PetscFunctionBegin;
12102764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
12112764a2aaSMatthew G. Knepley   if (g0) PetscValidFunction(g0, 4);
12122764a2aaSMatthew G. Knepley   if (g1) PetscValidFunction(g1, 5);
12132764a2aaSMatthew G. Knepley   if (g2) PetscValidFunction(g2, 6);
12142764a2aaSMatthew G. Knepley   if (g3) PetscValidFunction(g3, 7);
12152764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
12162764a2aaSMatthew G. Knepley   if (g < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", g);
12172764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, PetscMax(f, g)+1);CHKERRQ(ierr);
12182764a2aaSMatthew G. Knepley   prob->g[(f*prob->Nf + g)*4+0] = g0;
12192764a2aaSMatthew G. Knepley   prob->g[(f*prob->Nf + g)*4+1] = g1;
12202764a2aaSMatthew G. Knepley   prob->g[(f*prob->Nf + g)*4+2] = g2;
12212764a2aaSMatthew G. Knepley   prob->g[(f*prob->Nf + g)*4+3] = g3;
12222764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
12232764a2aaSMatthew G. Knepley }
12242764a2aaSMatthew G. Knepley 
1225475e0ac9SMatthew G. Knepley /*@C
1226475e0ac9SMatthew G. Knepley   PetscDSHasJacobianPreconditioner - Signals that a Jacobian preconditioner matrix has been set
1227475e0ac9SMatthew G. Knepley 
1228475e0ac9SMatthew G. Knepley   Not collective
1229475e0ac9SMatthew G. Knepley 
1230475e0ac9SMatthew G. Knepley   Input Parameter:
1231475e0ac9SMatthew G. Knepley . prob - The PetscDS
1232475e0ac9SMatthew G. Knepley 
1233475e0ac9SMatthew G. Knepley   Output Parameter:
1234475e0ac9SMatthew G. Knepley . hasJacPre - flag that pointwise function for Jacobian preconditioner matrix has been set
1235475e0ac9SMatthew G. Knepley 
1236475e0ac9SMatthew G. Knepley   Level: intermediate
1237475e0ac9SMatthew G. Knepley 
1238475e0ac9SMatthew G. Knepley .seealso: PetscDSGetJacobianPreconditioner(), PetscDSSetJacobianPreconditioner(), PetscDSGetJacobian()
1239475e0ac9SMatthew G. Knepley @*/
1240475e0ac9SMatthew G. Knepley PetscErrorCode PetscDSHasJacobianPreconditioner(PetscDS prob, PetscBool *hasJacPre)
1241475e0ac9SMatthew G. Knepley {
1242475e0ac9SMatthew G. Knepley   PetscInt f, g, h;
1243475e0ac9SMatthew G. Knepley 
1244475e0ac9SMatthew G. Knepley   PetscFunctionBegin;
1245475e0ac9SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1246475e0ac9SMatthew G. Knepley   *hasJacPre = PETSC_FALSE;
1247475e0ac9SMatthew G. Knepley   for (f = 0; f < prob->Nf; ++f) {
1248475e0ac9SMatthew G. Knepley     for (g = 0; g < prob->Nf; ++g) {
1249475e0ac9SMatthew G. Knepley       for (h = 0; h < 4; ++h) {
1250475e0ac9SMatthew G. Knepley         if (prob->gp[(f*prob->Nf + g)*4+h]) *hasJacPre = PETSC_TRUE;
1251475e0ac9SMatthew G. Knepley       }
1252475e0ac9SMatthew G. Knepley     }
1253475e0ac9SMatthew G. Knepley   }
1254475e0ac9SMatthew G. Knepley   PetscFunctionReturn(0);
1255475e0ac9SMatthew G. Knepley }
1256475e0ac9SMatthew G. Knepley 
1257475e0ac9SMatthew G. Knepley /*@C
1258475e0ac9SMatthew 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.
1259475e0ac9SMatthew G. Knepley 
1260475e0ac9SMatthew G. Knepley   Not collective
1261475e0ac9SMatthew G. Knepley 
1262475e0ac9SMatthew G. Knepley   Input Parameters:
1263475e0ac9SMatthew G. Knepley + prob - The PetscDS
1264475e0ac9SMatthew G. Knepley . f    - The test field number
1265475e0ac9SMatthew G. Knepley - g    - The field number
1266475e0ac9SMatthew G. Knepley 
1267475e0ac9SMatthew G. Knepley   Output Parameters:
1268475e0ac9SMatthew G. Knepley + g0 - integrand for the test and basis function term
1269475e0ac9SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1270475e0ac9SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1271475e0ac9SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1272475e0ac9SMatthew G. Knepley 
1273475e0ac9SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1274475e0ac9SMatthew G. Knepley 
1275475e0ac9SMatthew 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
1276475e0ac9SMatthew G. Knepley 
1277475e0ac9SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1278475e0ac9SMatthew G. Knepley 
1279475e0ac9SMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1280475e0ac9SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1281475e0ac9SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1282475e0ac9SMatthew G. Knepley $    PetscReal t, const PetscReal u_tShift, const PetscReal x[], PetscScalar g0[])
1283475e0ac9SMatthew G. Knepley 
1284475e0ac9SMatthew G. Knepley + dim - the spatial dimension
1285475e0ac9SMatthew G. Knepley . Nf - the number of fields
1286475e0ac9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1287475e0ac9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1288475e0ac9SMatthew G. Knepley . u - each field evaluated at the current point
1289475e0ac9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1290475e0ac9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1291475e0ac9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1292475e0ac9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1293475e0ac9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1294475e0ac9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1295475e0ac9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1296475e0ac9SMatthew G. Knepley . t - current time
1297475e0ac9SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1298475e0ac9SMatthew G. Knepley . x - coordinates of the current point
129997b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
130097b6e6e8SMatthew G. Knepley . constants - constant parameters
1301475e0ac9SMatthew G. Knepley - g0 - output values at the current point
1302475e0ac9SMatthew G. Knepley 
1303475e0ac9SMatthew G. Knepley   Level: intermediate
1304475e0ac9SMatthew G. Knepley 
1305475e0ac9SMatthew G. Knepley .seealso: PetscDSSetJacobianPreconditioner(), PetscDSGetJacobian()
1306475e0ac9SMatthew G. Knepley @*/
1307475e0ac9SMatthew G. Knepley PetscErrorCode PetscDSGetJacobianPreconditioner(PetscDS prob, PetscInt f, PetscInt g,
1308475e0ac9SMatthew G. Knepley                                   void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1309475e0ac9SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1310475e0ac9SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
131197b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
1312475e0ac9SMatthew G. Knepley                                   void (**g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1313475e0ac9SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1314475e0ac9SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
131597b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
1316475e0ac9SMatthew G. Knepley                                   void (**g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1317475e0ac9SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1318475e0ac9SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
131997b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
1320475e0ac9SMatthew G. Knepley                                   void (**g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1321475e0ac9SMatthew G. Knepley                                               const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1322475e0ac9SMatthew G. Knepley                                               const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
132397b6e6e8SMatthew G. Knepley                                               PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
1324475e0ac9SMatthew G. Knepley {
1325475e0ac9SMatthew G. Knepley   PetscFunctionBegin;
1326475e0ac9SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1327475e0ac9SMatthew 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);
1328475e0ac9SMatthew 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);
1329475e0ac9SMatthew G. Knepley   if (g0) {PetscValidPointer(g0, 4); *g0 = prob->gp[(f*prob->Nf + g)*4+0];}
1330475e0ac9SMatthew G. Knepley   if (g1) {PetscValidPointer(g1, 5); *g1 = prob->gp[(f*prob->Nf + g)*4+1];}
1331475e0ac9SMatthew G. Knepley   if (g2) {PetscValidPointer(g2, 6); *g2 = prob->gp[(f*prob->Nf + g)*4+2];}
1332475e0ac9SMatthew G. Knepley   if (g3) {PetscValidPointer(g3, 7); *g3 = prob->gp[(f*prob->Nf + g)*4+3];}
1333475e0ac9SMatthew G. Knepley   PetscFunctionReturn(0);
1334475e0ac9SMatthew G. Knepley }
1335475e0ac9SMatthew G. Knepley 
1336475e0ac9SMatthew G. Knepley /*@C
1337475e0ac9SMatthew 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.
1338475e0ac9SMatthew G. Knepley 
1339475e0ac9SMatthew G. Knepley   Not collective
1340475e0ac9SMatthew G. Knepley 
1341475e0ac9SMatthew G. Knepley   Input Parameters:
1342475e0ac9SMatthew G. Knepley + prob - The PetscDS
1343475e0ac9SMatthew G. Knepley . f    - The test field number
1344475e0ac9SMatthew G. Knepley . g    - The field number
1345475e0ac9SMatthew G. Knepley . g0 - integrand for the test and basis function term
1346475e0ac9SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1347475e0ac9SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1348475e0ac9SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1349475e0ac9SMatthew G. Knepley 
1350475e0ac9SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1351475e0ac9SMatthew G. Knepley 
1352475e0ac9SMatthew 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
1353475e0ac9SMatthew G. Knepley 
1354475e0ac9SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1355475e0ac9SMatthew G. Knepley 
1356475e0ac9SMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1357475e0ac9SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1358475e0ac9SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1359475e0ac9SMatthew G. Knepley $    PetscReal t, const PetscReal x[], PetscScalar g0[])
1360475e0ac9SMatthew G. Knepley 
1361475e0ac9SMatthew G. Knepley + dim - the spatial dimension
1362475e0ac9SMatthew G. Knepley . Nf - the number of fields
1363475e0ac9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1364475e0ac9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1365475e0ac9SMatthew G. Knepley . u - each field evaluated at the current point
1366475e0ac9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1367475e0ac9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1368475e0ac9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1369475e0ac9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1370475e0ac9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1371475e0ac9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1372475e0ac9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1373475e0ac9SMatthew G. Knepley . t - current time
1374475e0ac9SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1375475e0ac9SMatthew G. Knepley . x - coordinates of the current point
137697b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
137797b6e6e8SMatthew G. Knepley . constants - constant parameters
1378475e0ac9SMatthew G. Knepley - g0 - output values at the current point
1379475e0ac9SMatthew G. Knepley 
1380475e0ac9SMatthew G. Knepley   Level: intermediate
1381475e0ac9SMatthew G. Knepley 
1382475e0ac9SMatthew G. Knepley .seealso: PetscDSGetJacobianPreconditioner(), PetscDSSetJacobian()
1383475e0ac9SMatthew G. Knepley @*/
1384475e0ac9SMatthew G. Knepley PetscErrorCode PetscDSSetJacobianPreconditioner(PetscDS prob, PetscInt f, PetscInt g,
1385475e0ac9SMatthew G. Knepley                                   void (*g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1386475e0ac9SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1387475e0ac9SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
138897b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
1389475e0ac9SMatthew G. Knepley                                   void (*g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1390475e0ac9SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1391475e0ac9SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
139297b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
1393475e0ac9SMatthew G. Knepley                                   void (*g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1394475e0ac9SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1395475e0ac9SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
139697b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
1397475e0ac9SMatthew G. Knepley                                   void (*g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1398475e0ac9SMatthew G. Knepley                                              const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1399475e0ac9SMatthew G. Knepley                                              const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
140097b6e6e8SMatthew G. Knepley                                              PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
1401475e0ac9SMatthew G. Knepley {
1402475e0ac9SMatthew G. Knepley   PetscErrorCode ierr;
1403475e0ac9SMatthew G. Knepley 
1404475e0ac9SMatthew G. Knepley   PetscFunctionBegin;
1405475e0ac9SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1406475e0ac9SMatthew G. Knepley   if (g0) PetscValidFunction(g0, 4);
1407475e0ac9SMatthew G. Knepley   if (g1) PetscValidFunction(g1, 5);
1408475e0ac9SMatthew G. Knepley   if (g2) PetscValidFunction(g2, 6);
1409475e0ac9SMatthew G. Knepley   if (g3) PetscValidFunction(g3, 7);
1410475e0ac9SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
1411475e0ac9SMatthew G. Knepley   if (g < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", g);
1412475e0ac9SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, PetscMax(f, g)+1);CHKERRQ(ierr);
1413475e0ac9SMatthew G. Knepley   prob->gp[(f*prob->Nf + g)*4+0] = g0;
1414475e0ac9SMatthew G. Knepley   prob->gp[(f*prob->Nf + g)*4+1] = g1;
1415475e0ac9SMatthew G. Knepley   prob->gp[(f*prob->Nf + g)*4+2] = g2;
1416475e0ac9SMatthew G. Knepley   prob->gp[(f*prob->Nf + g)*4+3] = g3;
1417475e0ac9SMatthew G. Knepley   PetscFunctionReturn(0);
1418475e0ac9SMatthew G. Knepley }
1419475e0ac9SMatthew G. Knepley 
1420b7e05686SMatthew G. Knepley /*@C
1421b7e05686SMatthew G. Knepley   PetscDSHasDynamicJacobian - Signals that a dynamic Jacobian, dF/du_t, has been set
1422b7e05686SMatthew G. Knepley 
1423b7e05686SMatthew G. Knepley   Not collective
1424b7e05686SMatthew G. Knepley 
1425b7e05686SMatthew G. Knepley   Input Parameter:
1426b7e05686SMatthew G. Knepley . prob - The PetscDS
1427b7e05686SMatthew G. Knepley 
1428b7e05686SMatthew G. Knepley   Output Parameter:
1429b7e05686SMatthew G. Knepley . hasDynJac - flag that pointwise function for dynamic Jacobian has been set
1430b7e05686SMatthew G. Knepley 
1431b7e05686SMatthew G. Knepley   Level: intermediate
1432b7e05686SMatthew G. Knepley 
1433b7e05686SMatthew G. Knepley .seealso: PetscDSGetDynamicJacobian(), PetscDSSetDynamicJacobian(), PetscDSGetJacobian()
1434b7e05686SMatthew G. Knepley @*/
1435b7e05686SMatthew G. Knepley PetscErrorCode PetscDSHasDynamicJacobian(PetscDS prob, PetscBool *hasDynJac)
1436b7e05686SMatthew G. Knepley {
1437b7e05686SMatthew G. Knepley   PetscInt f, g, h;
1438b7e05686SMatthew G. Knepley 
1439b7e05686SMatthew G. Knepley   PetscFunctionBegin;
1440b7e05686SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1441b7e05686SMatthew G. Knepley   *hasDynJac = PETSC_FALSE;
1442b7e05686SMatthew G. Knepley   for (f = 0; f < prob->Nf; ++f) {
1443b7e05686SMatthew G. Knepley     for (g = 0; g < prob->Nf; ++g) {
1444b7e05686SMatthew G. Knepley       for (h = 0; h < 4; ++h) {
1445b7e05686SMatthew G. Knepley         if (prob->gt[(f*prob->Nf + g)*4+h]) *hasDynJac = PETSC_TRUE;
1446b7e05686SMatthew G. Knepley       }
1447b7e05686SMatthew G. Knepley     }
1448b7e05686SMatthew G. Knepley   }
1449b7e05686SMatthew G. Knepley   PetscFunctionReturn(0);
1450b7e05686SMatthew G. Knepley }
1451b7e05686SMatthew G. Knepley 
1452b7e05686SMatthew G. Knepley /*@C
1453b7e05686SMatthew G. Knepley   PetscDSGetDynamicJacobian - Get the pointwise dynamic Jacobian, dF/du_t, function for given test and basis field
1454b7e05686SMatthew G. Knepley 
1455b7e05686SMatthew G. Knepley   Not collective
1456b7e05686SMatthew G. Knepley 
1457b7e05686SMatthew G. Knepley   Input Parameters:
1458b7e05686SMatthew G. Knepley + prob - The PetscDS
1459b7e05686SMatthew G. Knepley . f    - The test field number
1460b7e05686SMatthew G. Knepley - g    - The field number
1461b7e05686SMatthew G. Knepley 
1462b7e05686SMatthew G. Knepley   Output Parameters:
1463b7e05686SMatthew G. Knepley + g0 - integrand for the test and basis function term
1464b7e05686SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1465b7e05686SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1466b7e05686SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1467b7e05686SMatthew G. Knepley 
1468b7e05686SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1469b7e05686SMatthew G. Knepley 
1470b7e05686SMatthew 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
1471b7e05686SMatthew G. Knepley 
1472b7e05686SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1473b7e05686SMatthew G. Knepley 
1474b7e05686SMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1475b7e05686SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1476b7e05686SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1477b7e05686SMatthew G. Knepley $    PetscReal t, const PetscReal u_tShift, const PetscReal x[], PetscScalar g0[])
1478b7e05686SMatthew G. Knepley 
1479b7e05686SMatthew G. Knepley + dim - the spatial dimension
1480b7e05686SMatthew G. Knepley . Nf - the number of fields
1481b7e05686SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1482b7e05686SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1483b7e05686SMatthew G. Knepley . u - each field evaluated at the current point
1484b7e05686SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1485b7e05686SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1486b7e05686SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1487b7e05686SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1488b7e05686SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1489b7e05686SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1490b7e05686SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1491b7e05686SMatthew G. Knepley . t - current time
1492b7e05686SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1493b7e05686SMatthew G. Knepley . x - coordinates of the current point
149497b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
149597b6e6e8SMatthew G. Knepley . constants - constant parameters
1496b7e05686SMatthew G. Knepley - g0 - output values at the current point
1497b7e05686SMatthew G. Knepley 
1498b7e05686SMatthew G. Knepley   Level: intermediate
1499b7e05686SMatthew G. Knepley 
1500b7e05686SMatthew G. Knepley .seealso: PetscDSSetJacobian()
1501b7e05686SMatthew G. Knepley @*/
1502b7e05686SMatthew G. Knepley PetscErrorCode PetscDSGetDynamicJacobian(PetscDS prob, PetscInt f, PetscInt g,
1503b7e05686SMatthew G. Knepley                                          void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1504b7e05686SMatthew G. Knepley                                                      const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1505b7e05686SMatthew G. Knepley                                                      const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
150697b6e6e8SMatthew G. Knepley                                                      PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
1507b7e05686SMatthew G. Knepley                                          void (**g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1508b7e05686SMatthew G. Knepley                                                      const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1509b7e05686SMatthew G. Knepley                                                      const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
151097b6e6e8SMatthew G. Knepley                                                      PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
1511b7e05686SMatthew G. Knepley                                          void (**g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1512b7e05686SMatthew G. Knepley                                                      const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1513b7e05686SMatthew G. Knepley                                                      const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
151497b6e6e8SMatthew G. Knepley                                                      PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
1515b7e05686SMatthew G. Knepley                                          void (**g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1516b7e05686SMatthew G. Knepley                                                      const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1517b7e05686SMatthew G. Knepley                                                      const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
151897b6e6e8SMatthew G. Knepley                                                      PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
1519b7e05686SMatthew G. Knepley {
1520b7e05686SMatthew G. Knepley   PetscFunctionBegin;
1521b7e05686SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1522b7e05686SMatthew 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);
1523b7e05686SMatthew 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);
1524b7e05686SMatthew G. Knepley   if (g0) {PetscValidPointer(g0, 4); *g0 = prob->gt[(f*prob->Nf + g)*4+0];}
1525b7e05686SMatthew G. Knepley   if (g1) {PetscValidPointer(g1, 5); *g1 = prob->gt[(f*prob->Nf + g)*4+1];}
1526b7e05686SMatthew G. Knepley   if (g2) {PetscValidPointer(g2, 6); *g2 = prob->gt[(f*prob->Nf + g)*4+2];}
1527b7e05686SMatthew G. Knepley   if (g3) {PetscValidPointer(g3, 7); *g3 = prob->gt[(f*prob->Nf + g)*4+3];}
1528b7e05686SMatthew G. Knepley   PetscFunctionReturn(0);
1529b7e05686SMatthew G. Knepley }
1530b7e05686SMatthew G. Knepley 
1531b7e05686SMatthew G. Knepley /*@C
1532b7e05686SMatthew G. Knepley   PetscDSSetDynamicJacobian - Set the pointwise dynamic Jacobian, dF/du_t, function for given test and basis fields
1533b7e05686SMatthew G. Knepley 
1534b7e05686SMatthew G. Knepley   Not collective
1535b7e05686SMatthew G. Knepley 
1536b7e05686SMatthew G. Knepley   Input Parameters:
1537b7e05686SMatthew G. Knepley + prob - The PetscDS
1538b7e05686SMatthew G. Knepley . f    - The test field number
1539b7e05686SMatthew G. Knepley . g    - The field number
1540b7e05686SMatthew G. Knepley . g0 - integrand for the test and basis function term
1541b7e05686SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1542b7e05686SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1543b7e05686SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1544b7e05686SMatthew G. Knepley 
1545b7e05686SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1546b7e05686SMatthew G. Knepley 
1547b7e05686SMatthew 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
1548b7e05686SMatthew G. Knepley 
1549b7e05686SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1550b7e05686SMatthew G. Knepley 
1551b7e05686SMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1552b7e05686SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1553b7e05686SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
1554b7e05686SMatthew G. Knepley $    PetscReal t, const PetscReal x[], PetscScalar g0[])
1555b7e05686SMatthew G. Knepley 
1556b7e05686SMatthew G. Knepley + dim - the spatial dimension
1557b7e05686SMatthew G. Knepley . Nf - the number of fields
1558b7e05686SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1559b7e05686SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1560b7e05686SMatthew G. Knepley . u - each field evaluated at the current point
1561b7e05686SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1562b7e05686SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1563b7e05686SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1564b7e05686SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1565b7e05686SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1566b7e05686SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1567b7e05686SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1568b7e05686SMatthew G. Knepley . t - current time
1569b7e05686SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
1570b7e05686SMatthew G. Knepley . x - coordinates of the current point
157197b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
157297b6e6e8SMatthew G. Knepley . constants - constant parameters
1573b7e05686SMatthew G. Knepley - g0 - output values at the current point
1574b7e05686SMatthew G. Knepley 
1575b7e05686SMatthew G. Knepley   Level: intermediate
1576b7e05686SMatthew G. Knepley 
1577b7e05686SMatthew G. Knepley .seealso: PetscDSGetJacobian()
1578b7e05686SMatthew G. Knepley @*/
1579b7e05686SMatthew G. Knepley PetscErrorCode PetscDSSetDynamicJacobian(PetscDS prob, PetscInt f, PetscInt g,
1580b7e05686SMatthew G. Knepley                                          void (*g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1581b7e05686SMatthew G. Knepley                                                     const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1582b7e05686SMatthew G. Knepley                                                     const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
158397b6e6e8SMatthew G. Knepley                                                     PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
1584b7e05686SMatthew G. Knepley                                          void (*g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1585b7e05686SMatthew G. Knepley                                                     const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1586b7e05686SMatthew G. Knepley                                                     const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
158797b6e6e8SMatthew G. Knepley                                                     PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
1588b7e05686SMatthew G. Knepley                                          void (*g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1589b7e05686SMatthew G. Knepley                                                     const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1590b7e05686SMatthew G. Knepley                                                     const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
159197b6e6e8SMatthew G. Knepley                                                     PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
1592b7e05686SMatthew G. Knepley                                          void (*g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1593b7e05686SMatthew G. Knepley                                                     const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1594b7e05686SMatthew G. Knepley                                                     const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
159597b6e6e8SMatthew G. Knepley                                                     PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
1596b7e05686SMatthew G. Knepley {
1597b7e05686SMatthew G. Knepley   PetscErrorCode ierr;
1598b7e05686SMatthew G. Knepley 
1599b7e05686SMatthew G. Knepley   PetscFunctionBegin;
1600b7e05686SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1601b7e05686SMatthew G. Knepley   if (g0) PetscValidFunction(g0, 4);
1602b7e05686SMatthew G. Knepley   if (g1) PetscValidFunction(g1, 5);
1603b7e05686SMatthew G. Knepley   if (g2) PetscValidFunction(g2, 6);
1604b7e05686SMatthew G. Knepley   if (g3) PetscValidFunction(g3, 7);
1605b7e05686SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
1606b7e05686SMatthew G. Knepley   if (g < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", g);
1607b7e05686SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, PetscMax(f, g)+1);CHKERRQ(ierr);
1608b7e05686SMatthew G. Knepley   prob->gt[(f*prob->Nf + g)*4+0] = g0;
1609b7e05686SMatthew G. Knepley   prob->gt[(f*prob->Nf + g)*4+1] = g1;
1610b7e05686SMatthew G. Knepley   prob->gt[(f*prob->Nf + g)*4+2] = g2;
1611b7e05686SMatthew G. Knepley   prob->gt[(f*prob->Nf + g)*4+3] = g3;
1612b7e05686SMatthew G. Knepley   PetscFunctionReturn(0);
1613b7e05686SMatthew G. Knepley }
1614b7e05686SMatthew G. Knepley 
16150c2f2876SMatthew G. Knepley /*@C
16160c2f2876SMatthew G. Knepley   PetscDSGetRiemannSolver - Returns the Riemann solver for the given field
16170c2f2876SMatthew G. Knepley 
16180c2f2876SMatthew G. Knepley   Not collective
16190c2f2876SMatthew G. Knepley 
16200c2f2876SMatthew G. Knepley   Input Arguments:
16210c2f2876SMatthew G. Knepley + prob - The PetscDS object
16220c2f2876SMatthew G. Knepley - f    - The field number
16230c2f2876SMatthew G. Knepley 
16240c2f2876SMatthew G. Knepley   Output Argument:
16250c2f2876SMatthew G. Knepley . r    - Riemann solver
16260c2f2876SMatthew G. Knepley 
16270c2f2876SMatthew G. Knepley   Calling sequence for r:
16280c2f2876SMatthew G. Knepley 
16295db36cf9SMatthew G. Knepley $ r(PetscInt dim, PetscInt Nf, const PetscReal x[], const PetscReal n[], const PetscScalar uL[], const PetscScalar uR[], PetscScalar flux[], void *ctx)
16300c2f2876SMatthew G. Knepley 
16315db36cf9SMatthew G. Knepley + dim  - The spatial dimension
16325db36cf9SMatthew G. Knepley . Nf   - The number of fields
16335db36cf9SMatthew G. Knepley . x    - The coordinates at a point on the interface
16340c2f2876SMatthew G. Knepley . n    - The normal vector to the interface
16350c2f2876SMatthew G. Knepley . uL   - The state vector to the left of the interface
16360c2f2876SMatthew G. Knepley . uR   - The state vector to the right of the interface
16370c2f2876SMatthew G. Knepley . flux - output array of flux through the interface
163897b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
163997b6e6e8SMatthew G. Knepley . constants - constant parameters
16400c2f2876SMatthew G. Knepley - ctx  - optional user context
16410c2f2876SMatthew G. Knepley 
16420c2f2876SMatthew G. Knepley   Level: intermediate
16430c2f2876SMatthew G. Knepley 
16440c2f2876SMatthew G. Knepley .seealso: PetscDSSetRiemannSolver()
16450c2f2876SMatthew G. Knepley @*/
16460c2f2876SMatthew G. Knepley PetscErrorCode PetscDSGetRiemannSolver(PetscDS prob, PetscInt f,
164797b6e6e8SMatthew 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))
16480c2f2876SMatthew G. Knepley {
16490c2f2876SMatthew G. Knepley   PetscFunctionBegin;
16500c2f2876SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
16510c2f2876SMatthew 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);
16520c2f2876SMatthew G. Knepley   PetscValidPointer(r, 3);
16530c2f2876SMatthew G. Knepley   *r = prob->r[f];
16540c2f2876SMatthew G. Knepley   PetscFunctionReturn(0);
16550c2f2876SMatthew G. Knepley }
16560c2f2876SMatthew G. Knepley 
16570c2f2876SMatthew G. Knepley /*@C
16580c2f2876SMatthew G. Knepley   PetscDSSetRiemannSolver - Sets the Riemann solver for the given field
16590c2f2876SMatthew G. Knepley 
16600c2f2876SMatthew G. Knepley   Not collective
16610c2f2876SMatthew G. Knepley 
16620c2f2876SMatthew G. Knepley   Input Arguments:
16630c2f2876SMatthew G. Knepley + prob - The PetscDS object
16640c2f2876SMatthew G. Knepley . f    - The field number
16650c2f2876SMatthew G. Knepley - r    - Riemann solver
16660c2f2876SMatthew G. Knepley 
16670c2f2876SMatthew G. Knepley   Calling sequence for r:
16680c2f2876SMatthew G. Knepley 
16695db36cf9SMatthew G. Knepley $ r(PetscInt dim, PetscInt Nf, const PetscReal x[], const PetscReal n[], const PetscScalar uL[], const PetscScalar uR[], PetscScalar flux[], void *ctx)
16700c2f2876SMatthew G. Knepley 
16715db36cf9SMatthew G. Knepley + dim  - The spatial dimension
16725db36cf9SMatthew G. Knepley . Nf   - The number of fields
16735db36cf9SMatthew G. Knepley . x    - The coordinates at a point on the interface
16740c2f2876SMatthew G. Knepley . n    - The normal vector to the interface
16750c2f2876SMatthew G. Knepley . uL   - The state vector to the left of the interface
16760c2f2876SMatthew G. Knepley . uR   - The state vector to the right of the interface
16770c2f2876SMatthew G. Knepley . flux - output array of flux through the interface
167897b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
167997b6e6e8SMatthew G. Knepley . constants - constant parameters
16800c2f2876SMatthew G. Knepley - ctx  - optional user context
16810c2f2876SMatthew G. Knepley 
16820c2f2876SMatthew G. Knepley   Level: intermediate
16830c2f2876SMatthew G. Knepley 
16840c2f2876SMatthew G. Knepley .seealso: PetscDSGetRiemannSolver()
16850c2f2876SMatthew G. Knepley @*/
16860c2f2876SMatthew G. Knepley PetscErrorCode PetscDSSetRiemannSolver(PetscDS prob, PetscInt f,
168797b6e6e8SMatthew 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))
16880c2f2876SMatthew G. Knepley {
16890c2f2876SMatthew G. Knepley   PetscErrorCode ierr;
16900c2f2876SMatthew G. Knepley 
16910c2f2876SMatthew G. Knepley   PetscFunctionBegin;
16920c2f2876SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
1693de716cbcSToby Isaac   if (r) PetscValidFunction(r, 3);
16940c2f2876SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
16950c2f2876SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
16960c2f2876SMatthew G. Knepley   prob->r[f] = r;
16970c2f2876SMatthew G. Knepley   PetscFunctionReturn(0);
16980c2f2876SMatthew G. Knepley }
16990c2f2876SMatthew G. Knepley 
170032d2bbc9SMatthew G. Knepley /*@C
170132d2bbc9SMatthew G. Knepley   PetscDSGetUpdate - Get the pointwise update function for a given field
170232d2bbc9SMatthew G. Knepley 
170332d2bbc9SMatthew G. Knepley   Not collective
170432d2bbc9SMatthew G. Knepley 
170532d2bbc9SMatthew G. Knepley   Input Parameters:
170632d2bbc9SMatthew G. Knepley + prob - The PetscDS
170732d2bbc9SMatthew G. Knepley - f    - The field number
170832d2bbc9SMatthew G. Knepley 
170932d2bbc9SMatthew G. Knepley   Output Parameters:
171032d2bbc9SMatthew G. Knepley + update - update function
171132d2bbc9SMatthew G. Knepley 
171232d2bbc9SMatthew G. Knepley   Note: The calling sequence for the callback update is given by:
171332d2bbc9SMatthew G. Knepley 
171432d2bbc9SMatthew G. Knepley $ update(PetscInt dim, PetscInt Nf, PetscInt NfAux,
171532d2bbc9SMatthew G. Knepley $        const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
171632d2bbc9SMatthew G. Knepley $        const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
171732d2bbc9SMatthew G. Knepley $        PetscReal t, const PetscReal x[], PetscScalar uNew[])
171832d2bbc9SMatthew G. Knepley 
171932d2bbc9SMatthew G. Knepley + dim - the spatial dimension
172032d2bbc9SMatthew G. Knepley . Nf - the number of fields
172132d2bbc9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
172232d2bbc9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
172332d2bbc9SMatthew G. Knepley . u - each field evaluated at the current point
172432d2bbc9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
172532d2bbc9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
172632d2bbc9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
172732d2bbc9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
172832d2bbc9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
172932d2bbc9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
173032d2bbc9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
173132d2bbc9SMatthew G. Knepley . t - current time
173232d2bbc9SMatthew G. Knepley . x - coordinates of the current point
173332d2bbc9SMatthew G. Knepley - uNew - new value for field at the current point
173432d2bbc9SMatthew G. Knepley 
173532d2bbc9SMatthew G. Knepley   Level: intermediate
173632d2bbc9SMatthew G. Knepley 
173732d2bbc9SMatthew G. Knepley .seealso: PetscDSSetUpdate(), PetscDSSetResidual()
173832d2bbc9SMatthew G. Knepley @*/
173932d2bbc9SMatthew G. Knepley PetscErrorCode PetscDSGetUpdate(PetscDS prob, PetscInt f,
174032d2bbc9SMatthew G. Knepley                                   void (**update)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
174132d2bbc9SMatthew G. Knepley                                                   const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
174232d2bbc9SMatthew G. Knepley                                                   const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
17433fa77dffSMatthew G. Knepley                                                   PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar uNew[]))
174432d2bbc9SMatthew G. Knepley {
174532d2bbc9SMatthew G. Knepley   PetscFunctionBegin;
174632d2bbc9SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
174732d2bbc9SMatthew 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);
174832d2bbc9SMatthew G. Knepley   if (update) {PetscValidPointer(update, 3); *update = prob->update[f];}
174932d2bbc9SMatthew G. Knepley   PetscFunctionReturn(0);
175032d2bbc9SMatthew G. Knepley }
175132d2bbc9SMatthew G. Knepley 
175232d2bbc9SMatthew G. Knepley /*@C
17533fa77dffSMatthew G. Knepley   PetscDSSetUpdate - Set the pointwise update function for a given field
175432d2bbc9SMatthew G. Knepley 
175532d2bbc9SMatthew G. Knepley   Not collective
175632d2bbc9SMatthew G. Knepley 
175732d2bbc9SMatthew G. Knepley   Input Parameters:
175832d2bbc9SMatthew G. Knepley + prob   - The PetscDS
175932d2bbc9SMatthew G. Knepley . f      - The field number
176032d2bbc9SMatthew G. Knepley - update - update function
176132d2bbc9SMatthew G. Knepley 
176232d2bbc9SMatthew G. Knepley   Note: The calling sequence for the callback update is given by:
176332d2bbc9SMatthew G. Knepley 
176432d2bbc9SMatthew G. Knepley $ update(PetscInt dim, PetscInt Nf, PetscInt NfAux,
176532d2bbc9SMatthew G. Knepley $        const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
176632d2bbc9SMatthew G. Knepley $        const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
176732d2bbc9SMatthew G. Knepley $        PetscReal t, const PetscReal x[], PetscScalar uNew[])
176832d2bbc9SMatthew G. Knepley 
176932d2bbc9SMatthew G. Knepley + dim - the spatial dimension
177032d2bbc9SMatthew G. Knepley . Nf - the number of fields
177132d2bbc9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
177232d2bbc9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
177332d2bbc9SMatthew G. Knepley . u - each field evaluated at the current point
177432d2bbc9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
177532d2bbc9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
177632d2bbc9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
177732d2bbc9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
177832d2bbc9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
177932d2bbc9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
178032d2bbc9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
178132d2bbc9SMatthew G. Knepley . t - current time
178232d2bbc9SMatthew G. Knepley . x - coordinates of the current point
178332d2bbc9SMatthew G. Knepley - uNew - new field values at the current point
178432d2bbc9SMatthew G. Knepley 
178532d2bbc9SMatthew G. Knepley   Level: intermediate
178632d2bbc9SMatthew G. Knepley 
178732d2bbc9SMatthew G. Knepley .seealso: PetscDSGetResidual()
178832d2bbc9SMatthew G. Knepley @*/
178932d2bbc9SMatthew G. Knepley PetscErrorCode PetscDSSetUpdate(PetscDS prob, PetscInt f,
179032d2bbc9SMatthew G. Knepley                                 void (*update)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
179132d2bbc9SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
179232d2bbc9SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
17933fa77dffSMatthew G. Knepley                                                PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar uNew[]))
179432d2bbc9SMatthew G. Knepley {
179532d2bbc9SMatthew G. Knepley   PetscErrorCode ierr;
179632d2bbc9SMatthew G. Knepley 
179732d2bbc9SMatthew G. Knepley   PetscFunctionBegin;
179832d2bbc9SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
179932d2bbc9SMatthew G. Knepley   if (update) PetscValidFunction(update, 3);
180032d2bbc9SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
180132d2bbc9SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
180232d2bbc9SMatthew G. Knepley   prob->update[f] = update;
180332d2bbc9SMatthew G. Knepley   PetscFunctionReturn(0);
180432d2bbc9SMatthew G. Knepley }
180532d2bbc9SMatthew G. Knepley 
18060c2f2876SMatthew G. Knepley PetscErrorCode PetscDSGetContext(PetscDS prob, PetscInt f, void **ctx)
18070c2f2876SMatthew G. Knepley {
18080c2f2876SMatthew G. Knepley   PetscFunctionBegin;
18090c2f2876SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
18100c2f2876SMatthew 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);
18110c2f2876SMatthew G. Knepley   PetscValidPointer(ctx, 3);
18120c2f2876SMatthew G. Knepley   *ctx = prob->ctx[f];
18130c2f2876SMatthew G. Knepley   PetscFunctionReturn(0);
18140c2f2876SMatthew G. Knepley }
18150c2f2876SMatthew G. Knepley 
18160c2f2876SMatthew G. Knepley PetscErrorCode PetscDSSetContext(PetscDS prob, PetscInt f, void *ctx)
18170c2f2876SMatthew G. Knepley {
18180c2f2876SMatthew G. Knepley   PetscErrorCode ierr;
18190c2f2876SMatthew G. Knepley 
18200c2f2876SMatthew G. Knepley   PetscFunctionBegin;
18210c2f2876SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
18220c2f2876SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
18230c2f2876SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
18240c2f2876SMatthew G. Knepley   prob->ctx[f] = ctx;
18250c2f2876SMatthew G. Knepley   PetscFunctionReturn(0);
18260c2f2876SMatthew G. Knepley }
18270c2f2876SMatthew G. Knepley 
1828194d53e6SMatthew G. Knepley /*@C
1829194d53e6SMatthew G. Knepley   PetscDSGetBdResidual - Get the pointwise boundary residual function for a given test field
1830194d53e6SMatthew G. Knepley 
1831194d53e6SMatthew G. Knepley   Not collective
1832194d53e6SMatthew G. Knepley 
1833194d53e6SMatthew G. Knepley   Input Parameters:
1834194d53e6SMatthew G. Knepley + prob - The PetscDS
1835194d53e6SMatthew G. Knepley - f    - The test field number
1836194d53e6SMatthew G. Knepley 
1837194d53e6SMatthew G. Knepley   Output Parameters:
1838194d53e6SMatthew G. Knepley + f0 - boundary integrand for the test function term
1839194d53e6SMatthew G. Knepley - f1 - boundary integrand for the test function gradient term
1840194d53e6SMatthew G. Knepley 
1841194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1842194d53e6SMatthew G. Knepley 
1843194d53e6SMatthew 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
1844194d53e6SMatthew G. Knepley 
1845194d53e6SMatthew G. Knepley The calling sequence for the callbacks f0 and f1 is given by:
1846194d53e6SMatthew G. Knepley 
184730b9ff8bSMatthew G. Knepley $ f0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1848194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1849194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
185030b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar f0[])
1851194d53e6SMatthew G. Knepley 
1852194d53e6SMatthew G. Knepley + dim - the spatial dimension
1853194d53e6SMatthew G. Knepley . Nf - the number of fields
1854194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1855194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1856194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
1857194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1858194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1859194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1860194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1861194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1862194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1863194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1864194d53e6SMatthew G. Knepley . t - current time
1865194d53e6SMatthew G. Knepley . x - coordinates of the current point
1866194d53e6SMatthew G. Knepley . n - unit normal at the current point
186797b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
186897b6e6e8SMatthew G. Knepley . constants - constant parameters
1869194d53e6SMatthew G. Knepley - f0 - output values at the current point
1870194d53e6SMatthew G. Knepley 
1871194d53e6SMatthew G. Knepley   Level: intermediate
1872194d53e6SMatthew G. Knepley 
1873194d53e6SMatthew G. Knepley .seealso: PetscDSSetBdResidual()
1874194d53e6SMatthew G. Knepley @*/
18752764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetBdResidual(PetscDS prob, PetscInt f,
187630b9ff8bSMatthew G. Knepley                                     void (**f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1877194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1878194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
187997b6e6e8SMatthew G. Knepley                                                 PetscReal t, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f0[]),
188030b9ff8bSMatthew G. Knepley                                     void (**f1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1881194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1882194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
188397b6e6e8SMatthew G. Knepley                                                 PetscReal t, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f1[]))
18842764a2aaSMatthew G. Knepley {
18852764a2aaSMatthew G. Knepley   PetscFunctionBegin;
18862764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
18872764a2aaSMatthew 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);
18882764a2aaSMatthew G. Knepley   if (f0) {PetscValidPointer(f0, 3); *f0 = prob->fBd[f*2+0];}
18892764a2aaSMatthew G. Knepley   if (f1) {PetscValidPointer(f1, 4); *f1 = prob->fBd[f*2+1];}
18902764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
18912764a2aaSMatthew G. Knepley }
18922764a2aaSMatthew G. Knepley 
1893194d53e6SMatthew G. Knepley /*@C
1894194d53e6SMatthew G. Knepley   PetscDSSetBdResidual - Get the pointwise boundary residual function for a given test field
1895194d53e6SMatthew G. Knepley 
1896194d53e6SMatthew G. Knepley   Not collective
1897194d53e6SMatthew G. Knepley 
1898194d53e6SMatthew G. Knepley   Input Parameters:
1899194d53e6SMatthew G. Knepley + prob - The PetscDS
1900194d53e6SMatthew G. Knepley . f    - The test field number
1901194d53e6SMatthew G. Knepley . f0 - boundary integrand for the test function term
1902194d53e6SMatthew G. Knepley - f1 - boundary integrand for the test function gradient term
1903194d53e6SMatthew G. Knepley 
1904194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1905194d53e6SMatthew G. Knepley 
1906194d53e6SMatthew 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
1907194d53e6SMatthew G. Knepley 
1908194d53e6SMatthew G. Knepley The calling sequence for the callbacks f0 and f1 is given by:
1909194d53e6SMatthew G. Knepley 
191030b9ff8bSMatthew G. Knepley $ f0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1911194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1912194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
191330b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar f0[])
1914194d53e6SMatthew G. Knepley 
1915194d53e6SMatthew G. Knepley + dim - the spatial dimension
1916194d53e6SMatthew G. Knepley . Nf - the number of fields
1917194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1918194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1919194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
1920194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1921194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1922194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1923194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1924194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1925194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1926194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1927194d53e6SMatthew G. Knepley . t - current time
1928194d53e6SMatthew G. Knepley . x - coordinates of the current point
1929194d53e6SMatthew G. Knepley . n - unit normal at the current point
193097b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
193197b6e6e8SMatthew G. Knepley . constants - constant parameters
1932194d53e6SMatthew G. Knepley - f0 - output values at the current point
1933194d53e6SMatthew G. Knepley 
1934194d53e6SMatthew G. Knepley   Level: intermediate
1935194d53e6SMatthew G. Knepley 
1936194d53e6SMatthew G. Knepley .seealso: PetscDSGetBdResidual()
1937194d53e6SMatthew G. Knepley @*/
19382764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetBdResidual(PetscDS prob, PetscInt f,
193930b9ff8bSMatthew G. Knepley                                     void (*f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1940194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1941194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
194297b6e6e8SMatthew G. Knepley                                                PetscReal t, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f0[]),
194330b9ff8bSMatthew G. Knepley                                     void (*f1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1944194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1945194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
194697b6e6e8SMatthew G. Knepley                                                PetscReal t, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f1[]))
19472764a2aaSMatthew G. Knepley {
19482764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
19492764a2aaSMatthew G. Knepley 
19502764a2aaSMatthew G. Knepley   PetscFunctionBegin;
19512764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
19522764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
19532764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
19542764a2aaSMatthew G. Knepley   if (f0) {PetscValidFunction(f0, 3); prob->fBd[f*2+0] = f0;}
19552764a2aaSMatthew G. Knepley   if (f1) {PetscValidFunction(f1, 4); prob->fBd[f*2+1] = f1;}
19562764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
19572764a2aaSMatthew G. Knepley }
19582764a2aaSMatthew G. Knepley 
1959194d53e6SMatthew G. Knepley /*@C
1960194d53e6SMatthew G. Knepley   PetscDSGetBdJacobian - Get the pointwise boundary Jacobian function for given test and basis field
1961194d53e6SMatthew G. Knepley 
1962194d53e6SMatthew G. Knepley   Not collective
1963194d53e6SMatthew G. Knepley 
1964194d53e6SMatthew G. Knepley   Input Parameters:
1965194d53e6SMatthew G. Knepley + prob - The PetscDS
1966194d53e6SMatthew G. Knepley . f    - The test field number
1967194d53e6SMatthew G. Knepley - g    - The field number
1968194d53e6SMatthew G. Knepley 
1969194d53e6SMatthew G. Knepley   Output Parameters:
1970194d53e6SMatthew G. Knepley + g0 - integrand for the test and basis function term
1971194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
1972194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
1973194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
1974194d53e6SMatthew G. Knepley 
1975194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
1976194d53e6SMatthew G. Knepley 
1977194d53e6SMatthew 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
1978194d53e6SMatthew G. Knepley 
1979194d53e6SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
1980194d53e6SMatthew G. Knepley 
198130b9ff8bSMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
1982194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
1983194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
198430b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar g0[])
1985194d53e6SMatthew G. Knepley 
1986194d53e6SMatthew G. Knepley + dim - the spatial dimension
1987194d53e6SMatthew G. Knepley . Nf - the number of fields
1988194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
1989194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
1990194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
1991194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
1992194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
1993194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
1994194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
1995194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
1996194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
1997194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
1998194d53e6SMatthew G. Knepley . t - current time
19992aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
2000194d53e6SMatthew G. Knepley . x - coordinates of the current point
2001194d53e6SMatthew G. Knepley . n - normal at the current point
200297b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
200397b6e6e8SMatthew G. Knepley . constants - constant parameters
2004194d53e6SMatthew G. Knepley - g0 - output values at the current point
2005194d53e6SMatthew G. Knepley 
2006194d53e6SMatthew G. Knepley   Level: intermediate
2007194d53e6SMatthew G. Knepley 
2008194d53e6SMatthew G. Knepley .seealso: PetscDSSetBdJacobian()
2009194d53e6SMatthew G. Knepley @*/
20102764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetBdJacobian(PetscDS prob, PetscInt f, PetscInt g,
201130b9ff8bSMatthew G. Knepley                                     void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2012194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2013194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
201497b6e6e8SMatthew G. Knepley                                                 PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
201530b9ff8bSMatthew G. Knepley                                     void (**g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2016194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2017194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
201897b6e6e8SMatthew G. Knepley                                                 PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
201930b9ff8bSMatthew G. Knepley                                     void (**g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2020194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2021194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
202297b6e6e8SMatthew G. Knepley                                                 PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
202330b9ff8bSMatthew G. Knepley                                     void (**g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2024194d53e6SMatthew G. Knepley                                                 const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2025194d53e6SMatthew G. Knepley                                                 const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
202697b6e6e8SMatthew G. Knepley                                                 PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
20272764a2aaSMatthew G. Knepley {
20282764a2aaSMatthew G. Knepley   PetscFunctionBegin;
20292764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
20302764a2aaSMatthew 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);
20312764a2aaSMatthew 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);
20322764a2aaSMatthew G. Knepley   if (g0) {PetscValidPointer(g0, 4); *g0 = prob->gBd[(f*prob->Nf + g)*4+0];}
20332764a2aaSMatthew G. Knepley   if (g1) {PetscValidPointer(g1, 5); *g1 = prob->gBd[(f*prob->Nf + g)*4+1];}
20342764a2aaSMatthew G. Knepley   if (g2) {PetscValidPointer(g2, 6); *g2 = prob->gBd[(f*prob->Nf + g)*4+2];}
20352764a2aaSMatthew G. Knepley   if (g3) {PetscValidPointer(g3, 7); *g3 = prob->gBd[(f*prob->Nf + g)*4+3];}
20362764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
20372764a2aaSMatthew G. Knepley }
20382764a2aaSMatthew G. Knepley 
2039194d53e6SMatthew G. Knepley /*@C
2040194d53e6SMatthew G. Knepley   PetscDSSetBdJacobian - Set the pointwise boundary Jacobian function for given test and basis field
2041194d53e6SMatthew G. Knepley 
2042194d53e6SMatthew G. Knepley   Not collective
2043194d53e6SMatthew G. Knepley 
2044194d53e6SMatthew G. Knepley   Input Parameters:
2045194d53e6SMatthew G. Knepley + prob - The PetscDS
2046194d53e6SMatthew G. Knepley . f    - The test field number
2047194d53e6SMatthew G. Knepley . g    - The field number
2048194d53e6SMatthew G. Knepley . g0 - integrand for the test and basis function term
2049194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term
2050194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term
2051194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term
2052194d53e6SMatthew G. Knepley 
2053194d53e6SMatthew G. Knepley   Note: We are using a first order FEM model for the weak form:
2054194d53e6SMatthew G. Knepley 
2055194d53e6SMatthew 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
2056194d53e6SMatthew G. Knepley 
2057194d53e6SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by:
2058194d53e6SMatthew G. Knepley 
205930b9ff8bSMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2060194d53e6SMatthew G. Knepley $    const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2061194d53e6SMatthew G. Knepley $    const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
206230b9ff8bSMatthew G. Knepley $    PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar g0[])
2063194d53e6SMatthew G. Knepley 
2064194d53e6SMatthew G. Knepley + dim - the spatial dimension
2065194d53e6SMatthew G. Knepley . Nf - the number of fields
2066194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
2067194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
2068194d53e6SMatthew G. Knepley . u - each field evaluated at the current point
2069194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
2070194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
2071194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
2072194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
2073194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point
2074194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
2075194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
2076194d53e6SMatthew G. Knepley . t - current time
20772aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t
2078194d53e6SMatthew G. Knepley . x - coordinates of the current point
2079194d53e6SMatthew G. Knepley . n - normal at the current point
208097b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters
208197b6e6e8SMatthew G. Knepley . constants - constant parameters
2082194d53e6SMatthew G. Knepley - g0 - output values at the current point
2083194d53e6SMatthew G. Knepley 
2084194d53e6SMatthew G. Knepley   Level: intermediate
2085194d53e6SMatthew G. Knepley 
2086194d53e6SMatthew G. Knepley .seealso: PetscDSGetBdJacobian()
2087194d53e6SMatthew G. Knepley @*/
20882764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetBdJacobian(PetscDS prob, PetscInt f, PetscInt g,
208930b9ff8bSMatthew G. Knepley                                     void (*g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2090194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2091194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
209297b6e6e8SMatthew G. Knepley                                                PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]),
209330b9ff8bSMatthew G. Knepley                                     void (*g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2094194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2095194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
209697b6e6e8SMatthew G. Knepley                                                PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]),
209730b9ff8bSMatthew G. Knepley                                     void (*g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2098194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2099194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
210097b6e6e8SMatthew G. Knepley                                                PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]),
210130b9ff8bSMatthew G. Knepley                                     void (*g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux,
2102194d53e6SMatthew G. Knepley                                                const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
2103194d53e6SMatthew G. Knepley                                                const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
210497b6e6e8SMatthew G. Knepley                                                PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[]))
21052764a2aaSMatthew G. Knepley {
21062764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
21072764a2aaSMatthew G. Knepley 
21082764a2aaSMatthew G. Knepley   PetscFunctionBegin;
21092764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
21102764a2aaSMatthew G. Knepley   if (g0) PetscValidFunction(g0, 4);
21112764a2aaSMatthew G. Knepley   if (g1) PetscValidFunction(g1, 5);
21122764a2aaSMatthew G. Knepley   if (g2) PetscValidFunction(g2, 6);
21132764a2aaSMatthew G. Knepley   if (g3) PetscValidFunction(g3, 7);
21142764a2aaSMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
21152764a2aaSMatthew G. Knepley   if (g < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", g);
21162764a2aaSMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, PetscMax(f, g)+1);CHKERRQ(ierr);
21172764a2aaSMatthew G. Knepley   prob->gBd[(f*prob->Nf + g)*4+0] = g0;
21182764a2aaSMatthew G. Knepley   prob->gBd[(f*prob->Nf + g)*4+1] = g1;
21192764a2aaSMatthew G. Knepley   prob->gBd[(f*prob->Nf + g)*4+2] = g2;
21202764a2aaSMatthew G. Knepley   prob->gBd[(f*prob->Nf + g)*4+3] = g3;
21212764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
21222764a2aaSMatthew G. Knepley }
21232764a2aaSMatthew G. Knepley 
21240d3e9b51SMatthew G. Knepley /*@C
2125c371a6d1SMatthew G. Knepley   PetscDSGetExactSolution - Get the pointwise exact solution function for a given test field
2126c371a6d1SMatthew G. Knepley 
2127c371a6d1SMatthew G. Knepley   Not collective
2128c371a6d1SMatthew G. Knepley 
2129c371a6d1SMatthew G. Knepley   Input Parameters:
2130c371a6d1SMatthew G. Knepley + prob - The PetscDS
2131c371a6d1SMatthew G. Knepley - f    - The test field number
2132c371a6d1SMatthew G. Knepley 
2133c371a6d1SMatthew G. Knepley   Output Parameter:
2134c371a6d1SMatthew G. Knepley . exactSol - exact solution for the test field
2135c371a6d1SMatthew G. Knepley 
2136c371a6d1SMatthew G. Knepley   Note: The calling sequence for the solution functions is given by:
2137c371a6d1SMatthew G. Knepley 
2138c371a6d1SMatthew G. Knepley $ sol(PetscInt dim, PetscReal t, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx)
2139c371a6d1SMatthew G. Knepley 
2140c371a6d1SMatthew G. Knepley + dim - the spatial dimension
2141c371a6d1SMatthew G. Knepley . t - current time
2142c371a6d1SMatthew G. Knepley . x - coordinates of the current point
2143c371a6d1SMatthew G. Knepley . Nc - the number of field components
2144c371a6d1SMatthew G. Knepley . u - the solution field evaluated at the current point
2145c371a6d1SMatthew G. Knepley - ctx - a user context
2146c371a6d1SMatthew G. Knepley 
2147c371a6d1SMatthew G. Knepley   Level: intermediate
2148c371a6d1SMatthew G. Knepley 
2149c371a6d1SMatthew G. Knepley .seealso: PetscDSSetExactSolution()
2150c371a6d1SMatthew G. Knepley @*/
2151c371a6d1SMatthew G. Knepley PetscErrorCode PetscDSGetExactSolution(PetscDS prob, PetscInt f, PetscErrorCode (**sol)(PetscInt dim, PetscReal t, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx))
2152c371a6d1SMatthew G. Knepley {
2153c371a6d1SMatthew G. Knepley   PetscFunctionBegin;
2154c371a6d1SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2155c371a6d1SMatthew 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);
2156c371a6d1SMatthew G. Knepley   if (sol) {PetscValidPointer(sol, 3); *sol = prob->exactSol[f];}
2157c371a6d1SMatthew G. Knepley   PetscFunctionReturn(0);
2158c371a6d1SMatthew G. Knepley }
2159c371a6d1SMatthew G. Knepley 
2160c371a6d1SMatthew G. Knepley /*@C
2161c371a6d1SMatthew G. Knepley   PetscDSSetExactSolution - Get the pointwise exact solution function for a given test field
2162c371a6d1SMatthew G. Knepley 
2163c371a6d1SMatthew G. Knepley   Not collective
2164c371a6d1SMatthew G. Knepley 
2165c371a6d1SMatthew G. Knepley   Input Parameters:
2166c371a6d1SMatthew G. Knepley + prob - The PetscDS
2167c371a6d1SMatthew G. Knepley . f    - The test field number
2168c371a6d1SMatthew G. Knepley - sol  - solution function for the test fields
2169c371a6d1SMatthew G. Knepley 
2170c371a6d1SMatthew G. Knepley   Note: The calling sequence for solution functions is given by:
2171c371a6d1SMatthew G. Knepley 
2172c371a6d1SMatthew G. Knepley $ sol(PetscInt dim, PetscReal t, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx)
2173c371a6d1SMatthew G. Knepley 
2174c371a6d1SMatthew G. Knepley + dim - the spatial dimension
2175c371a6d1SMatthew G. Knepley . t - current time
2176c371a6d1SMatthew G. Knepley . x - coordinates of the current point
2177c371a6d1SMatthew G. Knepley . Nc - the number of field components
2178c371a6d1SMatthew G. Knepley . u - the solution field evaluated at the current point
2179c371a6d1SMatthew G. Knepley - ctx - a user context
2180c371a6d1SMatthew G. Knepley 
2181c371a6d1SMatthew G. Knepley   Level: intermediate
2182c371a6d1SMatthew G. Knepley 
2183c371a6d1SMatthew G. Knepley .seealso: PetscDSGetExactSolution()
2184c371a6d1SMatthew G. Knepley @*/
2185c371a6d1SMatthew G. Knepley PetscErrorCode PetscDSSetExactSolution(PetscDS prob, PetscInt f, PetscErrorCode (*sol)(PetscInt dim, PetscReal t, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx))
2186c371a6d1SMatthew G. Knepley {
2187c371a6d1SMatthew G. Knepley   PetscErrorCode ierr;
2188c371a6d1SMatthew G. Knepley 
2189c371a6d1SMatthew G. Knepley   PetscFunctionBegin;
2190c371a6d1SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2191c371a6d1SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
2192c371a6d1SMatthew G. Knepley   ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr);
2193c371a6d1SMatthew G. Knepley   if (sol) {PetscValidFunction(sol, 3); prob->exactSol[f] = sol;}
2194c371a6d1SMatthew G. Knepley   PetscFunctionReturn(0);
2195c371a6d1SMatthew G. Knepley }
2196c371a6d1SMatthew G. Knepley 
21975638fd0eSMatthew G. Knepley /*@C
219897b6e6e8SMatthew G. Knepley   PetscDSGetConstants - Returns the array of constants passed to point functions
219997b6e6e8SMatthew G. Knepley 
220097b6e6e8SMatthew G. Knepley   Not collective
220197b6e6e8SMatthew G. Knepley 
220297b6e6e8SMatthew G. Knepley   Input Parameter:
220397b6e6e8SMatthew G. Knepley . prob - The PetscDS object
220497b6e6e8SMatthew G. Knepley 
220597b6e6e8SMatthew G. Knepley   Output Parameters:
220697b6e6e8SMatthew G. Knepley + numConstants - The number of constants
220797b6e6e8SMatthew G. Knepley - constants    - The array of constants, NULL if there are none
220897b6e6e8SMatthew G. Knepley 
220997b6e6e8SMatthew G. Knepley   Level: intermediate
221097b6e6e8SMatthew G. Knepley 
221197b6e6e8SMatthew G. Knepley .seealso: PetscDSSetConstants(), PetscDSCreate()
221297b6e6e8SMatthew G. Knepley @*/
221397b6e6e8SMatthew G. Knepley PetscErrorCode PetscDSGetConstants(PetscDS prob, PetscInt *numConstants, const PetscScalar *constants[])
221497b6e6e8SMatthew G. Knepley {
221597b6e6e8SMatthew G. Knepley   PetscFunctionBegin;
221697b6e6e8SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
221797b6e6e8SMatthew G. Knepley   if (numConstants) {PetscValidPointer(numConstants, 2); *numConstants = prob->numConstants;}
221897b6e6e8SMatthew G. Knepley   if (constants)    {PetscValidPointer(constants, 3);    *constants    = prob->constants;}
221997b6e6e8SMatthew G. Knepley   PetscFunctionReturn(0);
222097b6e6e8SMatthew G. Knepley }
222197b6e6e8SMatthew G. Knepley 
22220d3e9b51SMatthew G. Knepley /*@C
222397b6e6e8SMatthew G. Knepley   PetscDSSetConstants - Set the array of constants passed to point functions
222497b6e6e8SMatthew G. Knepley 
222597b6e6e8SMatthew G. Knepley   Not collective
222697b6e6e8SMatthew G. Knepley 
222797b6e6e8SMatthew G. Knepley   Input Parameters:
222897b6e6e8SMatthew G. Knepley + prob         - The PetscDS object
222997b6e6e8SMatthew G. Knepley . numConstants - The number of constants
223097b6e6e8SMatthew G. Knepley - constants    - The array of constants, NULL if there are none
223197b6e6e8SMatthew G. Knepley 
223297b6e6e8SMatthew G. Knepley   Level: intermediate
223397b6e6e8SMatthew G. Knepley 
223497b6e6e8SMatthew G. Knepley .seealso: PetscDSGetConstants(), PetscDSCreate()
223597b6e6e8SMatthew G. Knepley @*/
223697b6e6e8SMatthew G. Knepley PetscErrorCode PetscDSSetConstants(PetscDS prob, PetscInt numConstants, PetscScalar constants[])
223797b6e6e8SMatthew G. Knepley {
223897b6e6e8SMatthew G. Knepley   PetscErrorCode ierr;
223997b6e6e8SMatthew G. Knepley 
224097b6e6e8SMatthew G. Knepley   PetscFunctionBegin;
224197b6e6e8SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
224297b6e6e8SMatthew G. Knepley   if (numConstants != prob->numConstants) {
224397b6e6e8SMatthew G. Knepley     ierr = PetscFree(prob->constants);CHKERRQ(ierr);
224497b6e6e8SMatthew G. Knepley     prob->numConstants = numConstants;
224597b6e6e8SMatthew G. Knepley     if (prob->numConstants) {
224697b6e6e8SMatthew G. Knepley       ierr = PetscMalloc1(prob->numConstants, &prob->constants);CHKERRQ(ierr);
224720be0f5bSMatthew G. Knepley     } else {
224820be0f5bSMatthew G. Knepley       prob->constants = NULL;
224920be0f5bSMatthew G. Knepley     }
225020be0f5bSMatthew G. Knepley   }
225120be0f5bSMatthew G. Knepley   if (prob->numConstants) {
225220be0f5bSMatthew G. Knepley     PetscValidPointer(constants, 3);
225397b6e6e8SMatthew G. Knepley     ierr = PetscMemcpy(prob->constants, constants, prob->numConstants * sizeof(PetscScalar));CHKERRQ(ierr);
225497b6e6e8SMatthew G. Knepley   }
225597b6e6e8SMatthew G. Knepley   PetscFunctionReturn(0);
225697b6e6e8SMatthew G. Knepley }
225797b6e6e8SMatthew G. Knepley 
22584cd1e086SMatthew G. Knepley /*@
22594cd1e086SMatthew G. Knepley   PetscDSGetFieldIndex - Returns the index of the given field
22604cd1e086SMatthew G. Knepley 
22614cd1e086SMatthew G. Knepley   Not collective
22624cd1e086SMatthew G. Knepley 
22634cd1e086SMatthew G. Knepley   Input Parameters:
22644cd1e086SMatthew G. Knepley + prob - The PetscDS object
22654cd1e086SMatthew G. Knepley - disc - The discretization object
22664cd1e086SMatthew G. Knepley 
22674cd1e086SMatthew G. Knepley   Output Parameter:
22684cd1e086SMatthew G. Knepley . f - The field number
22694cd1e086SMatthew G. Knepley 
22704cd1e086SMatthew G. Knepley   Level: beginner
22714cd1e086SMatthew G. Knepley 
2272f744cafaSSander Arens .seealso: PetscGetDiscretization(), PetscDSGetNumFields(), PetscDSCreate()
22734cd1e086SMatthew G. Knepley @*/
22744cd1e086SMatthew G. Knepley PetscErrorCode PetscDSGetFieldIndex(PetscDS prob, PetscObject disc, PetscInt *f)
22754cd1e086SMatthew G. Knepley {
22764cd1e086SMatthew G. Knepley   PetscInt g;
22774cd1e086SMatthew G. Knepley 
22784cd1e086SMatthew G. Knepley   PetscFunctionBegin;
22794cd1e086SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
22804cd1e086SMatthew G. Knepley   PetscValidPointer(f, 3);
22814cd1e086SMatthew G. Knepley   *f = -1;
22824cd1e086SMatthew G. Knepley   for (g = 0; g < prob->Nf; ++g) {if (disc == prob->disc[g]) break;}
22834cd1e086SMatthew G. Knepley   if (g == prob->Nf) SETERRQ(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Field not found in PetscDS.");
22844cd1e086SMatthew G. Knepley   *f = g;
22854cd1e086SMatthew G. Knepley   PetscFunctionReturn(0);
22864cd1e086SMatthew G. Knepley }
22874cd1e086SMatthew G. Knepley 
22884cd1e086SMatthew G. Knepley /*@
22894cd1e086SMatthew G. Knepley   PetscDSGetFieldSize - Returns the size of the given field in the full space basis
22904cd1e086SMatthew G. Knepley 
22914cd1e086SMatthew G. Knepley   Not collective
22924cd1e086SMatthew G. Knepley 
22934cd1e086SMatthew G. Knepley   Input Parameters:
22944cd1e086SMatthew G. Knepley + prob - The PetscDS object
22954cd1e086SMatthew G. Knepley - f - The field number
22964cd1e086SMatthew G. Knepley 
22974cd1e086SMatthew G. Knepley   Output Parameter:
22984cd1e086SMatthew G. Knepley . size - The size
22994cd1e086SMatthew G. Knepley 
23004cd1e086SMatthew G. Knepley   Level: beginner
23014cd1e086SMatthew G. Knepley 
2302f744cafaSSander Arens .seealso: PetscDSGetFieldOffset(), PetscDSGetNumFields(), PetscDSCreate()
23034cd1e086SMatthew G. Knepley @*/
23044cd1e086SMatthew G. Knepley PetscErrorCode PetscDSGetFieldSize(PetscDS prob, PetscInt f, PetscInt *size)
23054cd1e086SMatthew G. Knepley {
23062166fd64SMatthew G. Knepley   PetscErrorCode ierr;
23072166fd64SMatthew G. Knepley 
23084cd1e086SMatthew G. Knepley   PetscFunctionBegin;
23094cd1e086SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
23104cd1e086SMatthew G. Knepley   PetscValidPointer(size, 3);
23114cd1e086SMatthew 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);
23122166fd64SMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
2313d4742ddaSMatthew G. Knepley   *size = prob->Nb[f];
23144cd1e086SMatthew G. Knepley   PetscFunctionReturn(0);
23154cd1e086SMatthew G. Knepley }
23164cd1e086SMatthew G. Knepley 
2317bc4ae4beSMatthew G. Knepley /*@
2318bc4ae4beSMatthew G. Knepley   PetscDSGetFieldOffset - Returns the offset of the given field in the full space basis
2319bc4ae4beSMatthew G. Knepley 
2320bc4ae4beSMatthew G. Knepley   Not collective
2321bc4ae4beSMatthew G. Knepley 
2322bc4ae4beSMatthew G. Knepley   Input Parameters:
2323bc4ae4beSMatthew G. Knepley + prob - The PetscDS object
2324bc4ae4beSMatthew G. Knepley - f - The field number
2325bc4ae4beSMatthew G. Knepley 
2326bc4ae4beSMatthew G. Knepley   Output Parameter:
2327bc4ae4beSMatthew G. Knepley . off - The offset
2328bc4ae4beSMatthew G. Knepley 
2329bc4ae4beSMatthew G. Knepley   Level: beginner
2330bc4ae4beSMatthew G. Knepley 
2331f744cafaSSander Arens .seealso: PetscDSGetFieldSize(), PetscDSGetNumFields(), PetscDSCreate()
2332bc4ae4beSMatthew G. Knepley @*/
23332764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetFieldOffset(PetscDS prob, PetscInt f, PetscInt *off)
23342764a2aaSMatthew G. Knepley {
23354cd1e086SMatthew G. Knepley   PetscInt       size, g;
23362764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
23372764a2aaSMatthew G. Knepley 
23382764a2aaSMatthew G. Knepley   PetscFunctionBegin;
23392764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
23402764a2aaSMatthew G. Knepley   PetscValidPointer(off, 3);
23412764a2aaSMatthew 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);
23422764a2aaSMatthew G. Knepley   *off = 0;
23432764a2aaSMatthew G. Knepley   for (g = 0; g < f; ++g) {
23444cd1e086SMatthew G. Knepley     ierr = PetscDSGetFieldSize(prob, g, &size);CHKERRQ(ierr);
23454cd1e086SMatthew G. Knepley     *off += size;
23462764a2aaSMatthew G. Knepley   }
23472764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
23482764a2aaSMatthew G. Knepley }
23492764a2aaSMatthew G. Knepley 
2350bc4ae4beSMatthew G. Knepley /*@
235147e57110SSander Arens   PetscDSGetDimensions - Returns the size of the approximation space for each field on an evaluation point
2352bc4ae4beSMatthew G. Knepley 
2353bc4ae4beSMatthew G. Knepley   Not collective
2354bc4ae4beSMatthew G. Knepley 
235547e57110SSander Arens   Input Parameter:
235647e57110SSander Arens . prob - The PetscDS object
2357bc4ae4beSMatthew G. Knepley 
2358bc4ae4beSMatthew G. Knepley   Output Parameter:
235947e57110SSander Arens . dimensions - The number of dimensions
2360bc4ae4beSMatthew G. Knepley 
2361bc4ae4beSMatthew G. Knepley   Level: beginner
2362bc4ae4beSMatthew G. Knepley 
236347e57110SSander Arens .seealso: PetscDSGetComponentOffsets(), PetscDSGetNumFields(), PetscDSCreate()
2364bc4ae4beSMatthew G. Knepley @*/
236547e57110SSander Arens PetscErrorCode PetscDSGetDimensions(PetscDS prob, PetscInt *dimensions[])
23662764a2aaSMatthew G. Knepley {
23672764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
23682764a2aaSMatthew G. Knepley 
23692764a2aaSMatthew G. Knepley   PetscFunctionBegin;
23702764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
237147e57110SSander Arens   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
237247e57110SSander Arens   PetscValidPointer(dimensions, 2);
237347e57110SSander Arens   *dimensions = prob->Nb;
237447e57110SSander Arens   PetscFunctionReturn(0);
23756ce16762SMatthew G. Knepley }
237647e57110SSander Arens 
237747e57110SSander Arens /*@
237847e57110SSander Arens   PetscDSGetComponents - Returns the number of components for each field on an evaluation point
237947e57110SSander Arens 
238047e57110SSander Arens   Not collective
238147e57110SSander Arens 
238247e57110SSander Arens   Input Parameter:
238347e57110SSander Arens . prob - The PetscDS object
238447e57110SSander Arens 
238547e57110SSander Arens   Output Parameter:
238647e57110SSander Arens . components - The number of components
238747e57110SSander Arens 
238847e57110SSander Arens   Level: beginner
238947e57110SSander Arens 
239047e57110SSander Arens .seealso: PetscDSGetComponentOffsets(), PetscDSGetNumFields(), PetscDSCreate()
239147e57110SSander Arens @*/
239247e57110SSander Arens PetscErrorCode PetscDSGetComponents(PetscDS prob, PetscInt *components[])
239347e57110SSander Arens {
239447e57110SSander Arens   PetscErrorCode ierr;
239547e57110SSander Arens 
239647e57110SSander Arens   PetscFunctionBegin;
239747e57110SSander Arens   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
239847e57110SSander Arens   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
239947e57110SSander Arens   PetscValidPointer(components, 2);
240047e57110SSander Arens   *components = prob->Nc;
24016ce16762SMatthew G. Knepley   PetscFunctionReturn(0);
24026ce16762SMatthew G. Knepley }
24036ce16762SMatthew G. Knepley 
24046ce16762SMatthew G. Knepley /*@
24056ce16762SMatthew G. Knepley   PetscDSGetComponentOffset - Returns the offset of the given field on an evaluation point
24066ce16762SMatthew G. Knepley 
24076ce16762SMatthew G. Knepley   Not collective
24086ce16762SMatthew G. Knepley 
24096ce16762SMatthew G. Knepley   Input Parameters:
24106ce16762SMatthew G. Knepley + prob - The PetscDS object
24116ce16762SMatthew G. Knepley - f - The field number
24126ce16762SMatthew G. Knepley 
24136ce16762SMatthew G. Knepley   Output Parameter:
24146ce16762SMatthew G. Knepley . off - The offset
24156ce16762SMatthew G. Knepley 
24166ce16762SMatthew G. Knepley   Level: beginner
24176ce16762SMatthew G. Knepley 
2418f744cafaSSander Arens .seealso: PetscDSGetNumFields(), PetscDSCreate()
24196ce16762SMatthew G. Knepley @*/
24206ce16762SMatthew G. Knepley PetscErrorCode PetscDSGetComponentOffset(PetscDS prob, PetscInt f, PetscInt *off)
24216ce16762SMatthew G. Knepley {
24226ce16762SMatthew G. Knepley   PetscFunctionBegin;
24236ce16762SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
24246ce16762SMatthew G. Knepley   PetscValidPointer(off, 3);
24256ce16762SMatthew 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);
242647e57110SSander Arens   *off = prob->off[f];
24272764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
24282764a2aaSMatthew G. Knepley }
24292764a2aaSMatthew G. Knepley 
2430194d53e6SMatthew G. Knepley /*@
2431194d53e6SMatthew G. Knepley   PetscDSGetComponentOffsets - Returns the offset of each field on an evaluation point
2432194d53e6SMatthew G. Knepley 
2433194d53e6SMatthew G. Knepley   Not collective
2434194d53e6SMatthew G. Knepley 
2435194d53e6SMatthew G. Knepley   Input Parameter:
2436194d53e6SMatthew G. Knepley . prob - The PetscDS object
2437194d53e6SMatthew G. Knepley 
2438194d53e6SMatthew G. Knepley   Output Parameter:
2439194d53e6SMatthew G. Knepley . offsets - The offsets
2440194d53e6SMatthew G. Knepley 
2441194d53e6SMatthew G. Knepley   Level: beginner
2442194d53e6SMatthew G. Knepley 
2443f744cafaSSander Arens .seealso: PetscDSGetNumFields(), PetscDSCreate()
2444194d53e6SMatthew G. Knepley @*/
2445194d53e6SMatthew G. Knepley PetscErrorCode PetscDSGetComponentOffsets(PetscDS prob, PetscInt *offsets[])
2446194d53e6SMatthew G. Knepley {
2447194d53e6SMatthew G. Knepley   PetscFunctionBegin;
2448194d53e6SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2449194d53e6SMatthew G. Knepley   PetscValidPointer(offsets, 2);
2450194d53e6SMatthew G. Knepley   *offsets = prob->off;
2451194d53e6SMatthew G. Knepley   PetscFunctionReturn(0);
2452194d53e6SMatthew G. Knepley }
2453194d53e6SMatthew G. Knepley 
2454194d53e6SMatthew G. Knepley /*@
2455194d53e6SMatthew G. Knepley   PetscDSGetComponentDerivativeOffsets - Returns the offset of each field derivative on an evaluation point
2456194d53e6SMatthew G. Knepley 
2457194d53e6SMatthew G. Knepley   Not collective
2458194d53e6SMatthew G. Knepley 
2459194d53e6SMatthew G. Knepley   Input Parameter:
2460194d53e6SMatthew G. Knepley . prob - The PetscDS object
2461194d53e6SMatthew G. Knepley 
2462194d53e6SMatthew G. Knepley   Output Parameter:
2463194d53e6SMatthew G. Knepley . offsets - The offsets
2464194d53e6SMatthew G. Knepley 
2465194d53e6SMatthew G. Knepley   Level: beginner
2466194d53e6SMatthew G. Knepley 
2467f744cafaSSander Arens .seealso: PetscDSGetNumFields(), PetscDSCreate()
2468194d53e6SMatthew G. Knepley @*/
2469194d53e6SMatthew G. Knepley PetscErrorCode PetscDSGetComponentDerivativeOffsets(PetscDS prob, PetscInt *offsets[])
2470194d53e6SMatthew G. Knepley {
2471194d53e6SMatthew G. Knepley   PetscFunctionBegin;
2472194d53e6SMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2473194d53e6SMatthew G. Knepley   PetscValidPointer(offsets, 2);
2474194d53e6SMatthew G. Knepley   *offsets = prob->offDer;
2475194d53e6SMatthew G. Knepley   PetscFunctionReturn(0);
2476194d53e6SMatthew G. Knepley }
2477194d53e6SMatthew G. Knepley 
247868c9edb9SMatthew G. Knepley /*@C
247968c9edb9SMatthew G. Knepley   PetscDSGetTabulation - Return the basis tabulation at quadrature points for the volume discretization
248068c9edb9SMatthew G. Knepley 
248168c9edb9SMatthew G. Knepley   Not collective
248268c9edb9SMatthew G. Knepley 
248368c9edb9SMatthew G. Knepley   Input Parameter:
248468c9edb9SMatthew G. Knepley . prob - The PetscDS object
248568c9edb9SMatthew G. Knepley 
248668c9edb9SMatthew G. Knepley   Output Parameters:
248768c9edb9SMatthew G. Knepley + basis - The basis function tabulation at quadrature points
248868c9edb9SMatthew G. Knepley - basisDer - The basis function derivative tabulation at quadrature points
248968c9edb9SMatthew G. Knepley 
249068c9edb9SMatthew G. Knepley   Level: intermediate
249168c9edb9SMatthew G. Knepley 
2492f744cafaSSander Arens .seealso: PetscDSCreate()
249368c9edb9SMatthew G. Knepley @*/
24942764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetTabulation(PetscDS prob, PetscReal ***basis, PetscReal ***basisDer)
24952764a2aaSMatthew G. Knepley {
24962764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
24972764a2aaSMatthew G. Knepley 
24982764a2aaSMatthew G. Knepley   PetscFunctionBegin;
24992764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
25002764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
25012764a2aaSMatthew G. Knepley   if (basis)    {PetscValidPointer(basis, 2);    *basis    = prob->basis;}
25022764a2aaSMatthew G. Knepley   if (basisDer) {PetscValidPointer(basisDer, 3); *basisDer = prob->basisDer;}
25032764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
25042764a2aaSMatthew G. Knepley }
25052764a2aaSMatthew G. Knepley 
250668c9edb9SMatthew G. Knepley /*@C
25074d0b9603SSander Arens   PetscDSGetFaceTabulation - Return the basis tabulation at quadrature points on the faces
250868c9edb9SMatthew G. Knepley 
250968c9edb9SMatthew G. Knepley   Not collective
251068c9edb9SMatthew G. Knepley 
251168c9edb9SMatthew G. Knepley   Input Parameter:
251268c9edb9SMatthew G. Knepley . prob - The PetscDS object
251368c9edb9SMatthew G. Knepley 
251468c9edb9SMatthew G. Knepley   Output Parameters:
25154d0b9603SSander Arens + basisFace - The basis function tabulation at quadrature points
25164d0b9603SSander Arens - basisDerFace - The basis function derivative tabulation at quadrature points
251768c9edb9SMatthew G. Knepley 
251868c9edb9SMatthew G. Knepley   Level: intermediate
251968c9edb9SMatthew G. Knepley 
252068c9edb9SMatthew G. Knepley .seealso: PetscDSGetTabulation(), PetscDSCreate()
252168c9edb9SMatthew G. Knepley @*/
25224d0b9603SSander Arens PetscErrorCode PetscDSGetFaceTabulation(PetscDS prob, PetscReal ***basis, PetscReal ***basisDer)
25232764a2aaSMatthew G. Knepley {
25242764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
25252764a2aaSMatthew G. Knepley 
25262764a2aaSMatthew G. Knepley   PetscFunctionBegin;
25272764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
25282764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
25294d0b9603SSander Arens   if (basis)    {PetscValidPointer(basis, 2);    *basis    = prob->basisFace;}
25304d0b9603SSander Arens   if (basisDer) {PetscValidPointer(basisDer, 3); *basisDer = prob->basisDerFace;}
25312764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
25322764a2aaSMatthew G. Knepley }
25332764a2aaSMatthew G. Knepley 
25342764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetEvaluationArrays(PetscDS prob, PetscScalar **u, PetscScalar **u_t, PetscScalar **u_x)
25352764a2aaSMatthew G. Knepley {
25362764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
25372764a2aaSMatthew G. Knepley 
25382764a2aaSMatthew G. Knepley   PetscFunctionBegin;
25392764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
25402764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
25412764a2aaSMatthew G. Knepley   if (u)   {PetscValidPointer(u, 2);   *u   = prob->u;}
25422764a2aaSMatthew G. Knepley   if (u_t) {PetscValidPointer(u_t, 3); *u_t = prob->u_t;}
25432764a2aaSMatthew G. Knepley   if (u_x) {PetscValidPointer(u_x, 4); *u_x = prob->u_x;}
25442764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
25452764a2aaSMatthew G. Knepley }
25462764a2aaSMatthew G. Knepley 
25472764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetWeakFormArrays(PetscDS prob, PetscScalar **f0, PetscScalar **f1, PetscScalar **g0, PetscScalar **g1, PetscScalar **g2, PetscScalar **g3)
25482764a2aaSMatthew G. Knepley {
25492764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
25502764a2aaSMatthew G. Knepley 
25512764a2aaSMatthew G. Knepley   PetscFunctionBegin;
25522764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
25532764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
25542764a2aaSMatthew G. Knepley   if (f0) {PetscValidPointer(f0, 2); *f0 = prob->f0;}
25552764a2aaSMatthew G. Knepley   if (f1) {PetscValidPointer(f1, 3); *f1 = prob->f1;}
25562764a2aaSMatthew G. Knepley   if (g0) {PetscValidPointer(g0, 4); *g0 = prob->g0;}
25572764a2aaSMatthew G. Knepley   if (g1) {PetscValidPointer(g1, 5); *g1 = prob->g1;}
25582764a2aaSMatthew G. Knepley   if (g2) {PetscValidPointer(g2, 6); *g2 = prob->g2;}
25592764a2aaSMatthew G. Knepley   if (g3) {PetscValidPointer(g3, 7); *g3 = prob->g3;}
25602764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
25612764a2aaSMatthew G. Knepley }
25622764a2aaSMatthew G. Knepley 
25632764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetRefCoordArrays(PetscDS prob, PetscReal **x, PetscScalar **refSpaceDer)
25642764a2aaSMatthew G. Knepley {
25652764a2aaSMatthew G. Knepley   PetscErrorCode ierr;
25662764a2aaSMatthew G. Knepley 
25672764a2aaSMatthew G. Knepley   PetscFunctionBegin;
25682764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
25692764a2aaSMatthew G. Knepley   ierr = PetscDSSetUp(prob);CHKERRQ(ierr);
25702764a2aaSMatthew G. Knepley   if (x)           {PetscValidPointer(x, 2);           *x           = prob->x;}
25712764a2aaSMatthew G. Knepley   if (refSpaceDer) {PetscValidPointer(refSpaceDer, 3); *refSpaceDer = prob->refSpaceDer;}
25722764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
25732764a2aaSMatthew G. Knepley }
25742764a2aaSMatthew G. Knepley 
257558ebd649SToby Isaac /*@C
257658ebd649SToby Isaac   PetscDSAddBoundary - Add a boundary condition to the model
257758ebd649SToby Isaac 
257858ebd649SToby Isaac   Input Parameters:
257958ebd649SToby Isaac + ds          - The PetscDS object
25802d47a189SJulian Andrej . type        - The type of condition, e.g. DM_BC_ESSENTIAL/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann)
258158ebd649SToby Isaac . name        - The BC name
258258ebd649SToby Isaac . labelname   - The label defining constrained points
258358ebd649SToby Isaac . field       - The field to constrain
258458ebd649SToby Isaac . numcomps    - The number of constrained field components
258558ebd649SToby Isaac . comps       - An array of constrained component numbers
258658ebd649SToby Isaac . bcFunc      - A pointwise function giving boundary values
258758ebd649SToby Isaac . numids      - The number of DMLabel ids for constrained points
258858ebd649SToby Isaac . ids         - An array of ids for constrained points
258958ebd649SToby Isaac - ctx         - An optional user context for bcFunc
259058ebd649SToby Isaac 
259158ebd649SToby Isaac   Options Database Keys:
259258ebd649SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids
259358ebd649SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components
259458ebd649SToby Isaac 
259558ebd649SToby Isaac   Level: developer
259658ebd649SToby Isaac 
259758ebd649SToby Isaac .seealso: PetscDSGetBoundary()
259858ebd649SToby Isaac @*/
2599a30ec4eaSSatish 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)
260058ebd649SToby Isaac {
260158ebd649SToby Isaac   DSBoundary     b;
260258ebd649SToby Isaac   PetscErrorCode ierr;
260358ebd649SToby Isaac 
260458ebd649SToby Isaac   PetscFunctionBegin;
260558ebd649SToby Isaac   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1);
260658ebd649SToby Isaac   ierr = PetscNew(&b);CHKERRQ(ierr);
260758ebd649SToby Isaac   ierr = PetscStrallocpy(name, (char **) &b->name);CHKERRQ(ierr);
260858ebd649SToby Isaac   ierr = PetscStrallocpy(labelname, (char **) &b->labelname);CHKERRQ(ierr);
260958ebd649SToby Isaac   ierr = PetscMalloc1(numcomps, &b->comps);CHKERRQ(ierr);
261058ebd649SToby Isaac   if (numcomps) {ierr = PetscMemcpy(b->comps, comps, numcomps*sizeof(PetscInt));CHKERRQ(ierr);}
261158ebd649SToby Isaac   ierr = PetscMalloc1(numids, &b->ids);CHKERRQ(ierr);
261258ebd649SToby Isaac   if (numids) {ierr = PetscMemcpy(b->ids, ids, numids*sizeof(PetscInt));CHKERRQ(ierr);}
2613f971fd6bSMatthew G. Knepley   b->type            = type;
261458ebd649SToby Isaac   b->field           = field;
261558ebd649SToby Isaac   b->numcomps        = numcomps;
261658ebd649SToby Isaac   b->func            = bcFunc;
261758ebd649SToby Isaac   b->numids          = numids;
261858ebd649SToby Isaac   b->ctx             = ctx;
261958ebd649SToby Isaac   b->next            = ds->boundary;
262058ebd649SToby Isaac   ds->boundary       = b;
262158ebd649SToby Isaac   PetscFunctionReturn(0);
262258ebd649SToby Isaac }
262358ebd649SToby Isaac 
262458ebd649SToby Isaac /*@
262558ebd649SToby Isaac   PetscDSGetNumBoundary - Get the number of registered BC
262658ebd649SToby Isaac 
262758ebd649SToby Isaac   Input Parameters:
262858ebd649SToby Isaac . ds - The PetscDS object
262958ebd649SToby Isaac 
263058ebd649SToby Isaac   Output Parameters:
263158ebd649SToby Isaac . numBd - The number of BC
263258ebd649SToby Isaac 
263358ebd649SToby Isaac   Level: intermediate
263458ebd649SToby Isaac 
263558ebd649SToby Isaac .seealso: PetscDSAddBoundary(), PetscDSGetBoundary()
263658ebd649SToby Isaac @*/
263758ebd649SToby Isaac PetscErrorCode PetscDSGetNumBoundary(PetscDS ds, PetscInt *numBd)
263858ebd649SToby Isaac {
263958ebd649SToby Isaac   DSBoundary b = ds->boundary;
264058ebd649SToby Isaac 
264158ebd649SToby Isaac   PetscFunctionBegin;
264258ebd649SToby Isaac   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1);
264358ebd649SToby Isaac   PetscValidPointer(numBd, 2);
264458ebd649SToby Isaac   *numBd = 0;
264558ebd649SToby Isaac   while (b) {++(*numBd); b = b->next;}
264658ebd649SToby Isaac   PetscFunctionReturn(0);
264758ebd649SToby Isaac }
264858ebd649SToby Isaac 
264958ebd649SToby Isaac /*@C
265058ebd649SToby Isaac   PetscDSGetBoundary - Add a boundary condition to the model
265158ebd649SToby Isaac 
265258ebd649SToby Isaac   Input Parameters:
265358ebd649SToby Isaac + ds          - The PetscDS object
265458ebd649SToby Isaac - bd          - The BC number
265558ebd649SToby Isaac 
265658ebd649SToby Isaac   Output Parameters:
26572d47a189SJulian Andrej + type        - The type of condition, e.g. DM_BC_ESSENTIAL/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann)
265858ebd649SToby Isaac . name        - The BC name
265958ebd649SToby Isaac . labelname   - The label defining constrained points
266058ebd649SToby Isaac . field       - The field to constrain
266158ebd649SToby Isaac . numcomps    - The number of constrained field components
266258ebd649SToby Isaac . comps       - An array of constrained component numbers
266358ebd649SToby Isaac . bcFunc      - A pointwise function giving boundary values
266458ebd649SToby Isaac . numids      - The number of DMLabel ids for constrained points
266558ebd649SToby Isaac . ids         - An array of ids for constrained points
266658ebd649SToby Isaac - ctx         - An optional user context for bcFunc
266758ebd649SToby Isaac 
266858ebd649SToby Isaac   Options Database Keys:
266958ebd649SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids
267058ebd649SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components
267158ebd649SToby Isaac 
267258ebd649SToby Isaac   Level: developer
267358ebd649SToby Isaac 
267458ebd649SToby Isaac .seealso: PetscDSAddBoundary()
267558ebd649SToby Isaac @*/
2676a30ec4eaSSatish 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)
267758ebd649SToby Isaac {
267858ebd649SToby Isaac   DSBoundary b    = ds->boundary;
267958ebd649SToby Isaac   PetscInt   n    = 0;
268058ebd649SToby Isaac 
268158ebd649SToby Isaac   PetscFunctionBegin;
268258ebd649SToby Isaac   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1);
268358ebd649SToby Isaac   while (b) {
268458ebd649SToby Isaac     if (n == bd) break;
268558ebd649SToby Isaac     b = b->next;
268658ebd649SToby Isaac     ++n;
268758ebd649SToby Isaac   }
268858ebd649SToby Isaac   if (!b) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Boundary %d is not in [0, %d)", bd, n);
2689f971fd6bSMatthew G. Knepley   if (type) {
2690f971fd6bSMatthew G. Knepley     PetscValidPointer(type, 3);
2691f971fd6bSMatthew G. Knepley     *type = b->type;
269258ebd649SToby Isaac   }
269358ebd649SToby Isaac   if (name) {
269458ebd649SToby Isaac     PetscValidPointer(name, 4);
269558ebd649SToby Isaac     *name = b->name;
269658ebd649SToby Isaac   }
269758ebd649SToby Isaac   if (labelname) {
269858ebd649SToby Isaac     PetscValidPointer(labelname, 5);
269958ebd649SToby Isaac     *labelname = b->labelname;
270058ebd649SToby Isaac   }
270158ebd649SToby Isaac   if (field) {
270258ebd649SToby Isaac     PetscValidPointer(field, 6);
270358ebd649SToby Isaac     *field = b->field;
270458ebd649SToby Isaac   }
270558ebd649SToby Isaac   if (numcomps) {
270658ebd649SToby Isaac     PetscValidPointer(numcomps, 7);
270758ebd649SToby Isaac     *numcomps = b->numcomps;
270858ebd649SToby Isaac   }
270958ebd649SToby Isaac   if (comps) {
271058ebd649SToby Isaac     PetscValidPointer(comps, 8);
271158ebd649SToby Isaac     *comps = b->comps;
271258ebd649SToby Isaac   }
271358ebd649SToby Isaac   if (func) {
271458ebd649SToby Isaac     PetscValidPointer(func, 9);
271558ebd649SToby Isaac     *func = b->func;
271658ebd649SToby Isaac   }
271758ebd649SToby Isaac   if (numids) {
271858ebd649SToby Isaac     PetscValidPointer(numids, 10);
271958ebd649SToby Isaac     *numids = b->numids;
272058ebd649SToby Isaac   }
272158ebd649SToby Isaac   if (ids) {
272258ebd649SToby Isaac     PetscValidPointer(ids, 11);
272358ebd649SToby Isaac     *ids = b->ids;
272458ebd649SToby Isaac   }
272558ebd649SToby Isaac   if (ctx) {
272658ebd649SToby Isaac     PetscValidPointer(ctx, 12);
272758ebd649SToby Isaac     *ctx = b->ctx;
272858ebd649SToby Isaac   }
272958ebd649SToby Isaac   PetscFunctionReturn(0);
273058ebd649SToby Isaac }
273158ebd649SToby Isaac 
2732dff059c6SToby Isaac PetscErrorCode PetscDSCopyBoundary(PetscDS probA, PetscDS probB)
2733dff059c6SToby Isaac {
2734dff059c6SToby Isaac   DSBoundary     b, next, *lastnext;
2735dff059c6SToby Isaac   PetscErrorCode ierr;
2736dff059c6SToby Isaac 
2737dff059c6SToby Isaac   PetscFunctionBegin;
2738dff059c6SToby Isaac   PetscValidHeaderSpecific(probA, PETSCDS_CLASSID, 1);
2739dff059c6SToby Isaac   PetscValidHeaderSpecific(probB, PETSCDS_CLASSID, 2);
2740dff059c6SToby Isaac   if (probA == probB) PetscFunctionReturn(0);
2741dff059c6SToby Isaac   next = probB->boundary;
2742dff059c6SToby Isaac   while (next) {
2743dff059c6SToby Isaac     DSBoundary b = next;
2744dff059c6SToby Isaac 
2745dff059c6SToby Isaac     next = b->next;
2746dff059c6SToby Isaac     ierr = PetscFree(b->comps);CHKERRQ(ierr);
2747dff059c6SToby Isaac     ierr = PetscFree(b->ids);CHKERRQ(ierr);
2748dff059c6SToby Isaac     ierr = PetscFree(b->name);CHKERRQ(ierr);
2749dff059c6SToby Isaac     ierr = PetscFree(b->labelname);CHKERRQ(ierr);
2750dff059c6SToby Isaac     ierr = PetscFree(b);CHKERRQ(ierr);
2751dff059c6SToby Isaac   }
2752dff059c6SToby Isaac   lastnext = &(probB->boundary);
2753dff059c6SToby Isaac   for (b = probA->boundary; b; b = b->next) {
2754dff059c6SToby Isaac     DSBoundary bNew;
2755dff059c6SToby Isaac 
2756459726d8SSatish Balay     ierr = PetscNew(&bNew);CHKERRQ(ierr);
2757dff059c6SToby Isaac     bNew->numcomps = b->numcomps;
2758dff059c6SToby Isaac     ierr = PetscMalloc1(bNew->numcomps, &bNew->comps);CHKERRQ(ierr);
2759dff059c6SToby Isaac     ierr = PetscMemcpy(bNew->comps, b->comps, bNew->numcomps*sizeof(PetscInt));CHKERRQ(ierr);
2760dff059c6SToby Isaac     bNew->numids = b->numids;
2761dff059c6SToby Isaac     ierr = PetscMalloc1(bNew->numids, &bNew->ids);CHKERRQ(ierr);
2762dff059c6SToby Isaac     ierr = PetscMemcpy(bNew->ids, b->ids, bNew->numids*sizeof(PetscInt));CHKERRQ(ierr);
2763dff059c6SToby Isaac     ierr = PetscStrallocpy(b->labelname,(char **) &(bNew->labelname));CHKERRQ(ierr);
2764dff059c6SToby Isaac     ierr = PetscStrallocpy(b->name,(char **) &(bNew->name));CHKERRQ(ierr);
2765dff059c6SToby Isaac     bNew->ctx   = b->ctx;
2766f971fd6bSMatthew G. Knepley     bNew->type  = b->type;
2767dff059c6SToby Isaac     bNew->field = b->field;
2768dff059c6SToby Isaac     bNew->func  = b->func;
2769dff059c6SToby Isaac 
2770dff059c6SToby Isaac     *lastnext = bNew;
2771dff059c6SToby Isaac     lastnext = &(bNew->next);
2772dff059c6SToby Isaac   }
2773dff059c6SToby Isaac   PetscFunctionReturn(0);
2774dff059c6SToby Isaac }
2775dff059c6SToby Isaac 
2776da51fcedSMatthew G. Knepley /*@
2777da51fcedSMatthew G. Knepley   PetscDSCopyEquations - Copy all pointwise function pointers to the new problem
2778da51fcedSMatthew G. Knepley 
2779da51fcedSMatthew G. Knepley   Not collective
2780da51fcedSMatthew G. Knepley 
2781da51fcedSMatthew G. Knepley   Input Parameter:
2782da51fcedSMatthew G. Knepley . prob - The PetscDS object
2783da51fcedSMatthew G. Knepley 
2784da51fcedSMatthew G. Knepley   Output Parameter:
2785da51fcedSMatthew G. Knepley . newprob - The PetscDS copy
2786da51fcedSMatthew G. Knepley 
2787da51fcedSMatthew G. Knepley   Level: intermediate
2788da51fcedSMatthew G. Knepley 
2789da51fcedSMatthew G. Knepley .seealso: PetscDSSetResidual(), PetscDSSetJacobian(), PetscDSSetRiemannSolver(), PetscDSSetBdResidual(), PetscDSSetBdJacobian(), PetscDSCreate()
2790da51fcedSMatthew G. Knepley @*/
2791da51fcedSMatthew G. Knepley PetscErrorCode PetscDSCopyEquations(PetscDS prob, PetscDS newprob)
2792da51fcedSMatthew G. Knepley {
2793da51fcedSMatthew G. Knepley   PetscInt       Nf, Ng, f, g;
2794da51fcedSMatthew G. Knepley   PetscErrorCode ierr;
2795da51fcedSMatthew G. Knepley 
2796da51fcedSMatthew G. Knepley   PetscFunctionBegin;
2797da51fcedSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2798da51fcedSMatthew G. Knepley   PetscValidHeaderSpecific(newprob, PETSCDS_CLASSID, 2);
2799da51fcedSMatthew G. Knepley   ierr = PetscDSGetNumFields(prob, &Nf);CHKERRQ(ierr);
2800da51fcedSMatthew G. Knepley   ierr = PetscDSGetNumFields(newprob, &Ng);CHKERRQ(ierr);
280113903a91SSatish Balay   if (Nf != Ng) SETERRQ2(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_SIZ, "Number of fields must match %D != %D", Nf, Ng);
2802da51fcedSMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
2803da51fcedSMatthew G. Knepley     PetscPointFunc   obj;
2804da51fcedSMatthew G. Knepley     PetscPointFunc   f0, f1;
2805da51fcedSMatthew G. Knepley     PetscPointJac    g0, g1, g2, g3;
2806da51fcedSMatthew G. Knepley     PetscBdPointFunc f0Bd, f1Bd;
2807da51fcedSMatthew G. Knepley     PetscBdPointJac  g0Bd, g1Bd, g2Bd, g3Bd;
2808da51fcedSMatthew G. Knepley     PetscRiemannFunc r;
2809da51fcedSMatthew G. Knepley 
2810da51fcedSMatthew G. Knepley     ierr = PetscDSGetObjective(prob, f, &obj);CHKERRQ(ierr);
2811da51fcedSMatthew G. Knepley     ierr = PetscDSGetResidual(prob, f, &f0, &f1);CHKERRQ(ierr);
2812da51fcedSMatthew G. Knepley     ierr = PetscDSGetBdResidual(prob, f, &f0Bd, &f1Bd);CHKERRQ(ierr);
2813da51fcedSMatthew G. Knepley     ierr = PetscDSGetRiemannSolver(prob, f, &r);CHKERRQ(ierr);
2814da51fcedSMatthew G. Knepley     ierr = PetscDSSetObjective(newprob, f, obj);CHKERRQ(ierr);
2815da51fcedSMatthew G. Knepley     ierr = PetscDSSetResidual(newprob, f, f0, f1);CHKERRQ(ierr);
2816da51fcedSMatthew G. Knepley     ierr = PetscDSSetBdResidual(newprob, f, f0Bd, f1Bd);CHKERRQ(ierr);
2817da51fcedSMatthew G. Knepley     ierr = PetscDSSetRiemannSolver(newprob, f, r);CHKERRQ(ierr);
2818da51fcedSMatthew G. Knepley     for (g = 0; g < Nf; ++g) {
2819da51fcedSMatthew G. Knepley       ierr = PetscDSGetJacobian(prob, f, g, &g0, &g1, &g2, &g3);CHKERRQ(ierr);
2820da51fcedSMatthew G. Knepley       ierr = PetscDSGetBdJacobian(prob, f, g, &g0Bd, &g1Bd, &g2Bd, &g3Bd);CHKERRQ(ierr);
2821da51fcedSMatthew G. Knepley       ierr = PetscDSSetJacobian(newprob, f, g, g0, g1, g2, g3);CHKERRQ(ierr);
2822da51fcedSMatthew G. Knepley       ierr = PetscDSSetBdJacobian(newprob, f, g, g0Bd, g1Bd, g2Bd, g3Bd);CHKERRQ(ierr);
2823da51fcedSMatthew G. Knepley     }
2824da51fcedSMatthew G. Knepley   }
2825da51fcedSMatthew G. Knepley   PetscFunctionReturn(0);
2826da51fcedSMatthew G. Knepley }
2827da51fcedSMatthew G. Knepley 
2828*b1353e8eSMatthew G. Knepley PetscErrorCode PetscDSGetHeightSubspace(PetscDS prob, PetscInt height, PetscDS *subprob)
2829*b1353e8eSMatthew G. Knepley {
2830*b1353e8eSMatthew G. Knepley   PetscInt       Nf, f;
2831*b1353e8eSMatthew G. Knepley   PetscErrorCode ierr;
2832*b1353e8eSMatthew G. Knepley 
2833*b1353e8eSMatthew G. Knepley   PetscFunctionBegin;
2834*b1353e8eSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
2835*b1353e8eSMatthew G. Knepley   PetscValidPointer(subprob, 3);
2836*b1353e8eSMatthew G. Knepley   if (height == 0) {*subprob = prob; PetscFunctionReturn(0);}
2837*b1353e8eSMatthew G. Knepley   if (height != 1) SETERRQ1(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_OUTOFRANGE, "DS can only handle height 1, not %D", height);
2838*b1353e8eSMatthew G. Knepley   ierr = PetscDSGetNumFields(prob, &Nf);CHKERRQ(ierr);
2839*b1353e8eSMatthew G. Knepley   if (!prob->bdprob) {
2840*b1353e8eSMatthew G. Knepley     PetscInt cdim;
2841*b1353e8eSMatthew G. Knepley 
2842*b1353e8eSMatthew G. Knepley     ierr = PetscDSCreate(PetscObjectComm((PetscObject) prob), &prob->bdprob);CHKERRQ(ierr);
2843*b1353e8eSMatthew G. Knepley     ierr = PetscDSGetCoordinateDimension(prob, &cdim);CHKERRQ(ierr);
2844*b1353e8eSMatthew G. Knepley     ierr = PetscDSSetCoordinateDimension(prob->bdprob, cdim);CHKERRQ(ierr);
2845*b1353e8eSMatthew G. Knepley     for (f = 0; f < Nf; ++f) {
2846*b1353e8eSMatthew G. Knepley       PetscFE      subfe;
2847*b1353e8eSMatthew G. Knepley       PetscObject  obj;
2848*b1353e8eSMatthew G. Knepley       PetscClassId id;
2849*b1353e8eSMatthew G. Knepley 
2850*b1353e8eSMatthew G. Knepley       ierr = PetscDSGetDiscretization(prob, f, &obj);CHKERRQ(ierr);
2851*b1353e8eSMatthew G. Knepley       ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr);
2852*b1353e8eSMatthew G. Knepley       if (id == PETSCFE_CLASSID) {ierr = PetscFEGetHeightSubspace((PetscFE) obj, height, &subfe);CHKERRQ(ierr);}
2853*b1353e8eSMatthew G. Knepley       else SETERRQ1(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Unsupported discretization type for field %d", f);
2854*b1353e8eSMatthew G. Knepley       ierr = PetscDSSetDiscretization(prob->bdprob, f, (PetscObject) subfe);CHKERRQ(ierr);
2855*b1353e8eSMatthew G. Knepley     }
2856*b1353e8eSMatthew G. Knepley   }
2857*b1353e8eSMatthew G. Knepley   *subprob = prob->bdprob;
2858*b1353e8eSMatthew G. Knepley   PetscFunctionReturn(0);
2859*b1353e8eSMatthew G. Knepley }
2860*b1353e8eSMatthew G. Knepley 
2861bc4ae4beSMatthew G. Knepley static PetscErrorCode PetscDSDestroy_Basic(PetscDS prob)
28622764a2aaSMatthew G. Knepley {
2863931fb3b8SToby Isaac   PetscErrorCode      ierr;
2864931fb3b8SToby Isaac 
28652764a2aaSMatthew G. Knepley   PetscFunctionBegin;
2866931fb3b8SToby Isaac   ierr = PetscFree(prob->data);CHKERRQ(ierr);
28672764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
28682764a2aaSMatthew G. Knepley }
28692764a2aaSMatthew G. Knepley 
2870bc4ae4beSMatthew G. Knepley static PetscErrorCode PetscDSInitialize_Basic(PetscDS prob)
28712764a2aaSMatthew G. Knepley {
28722764a2aaSMatthew G. Knepley   PetscFunctionBegin;
28732764a2aaSMatthew G. Knepley   prob->ops->setfromoptions = NULL;
28742764a2aaSMatthew G. Knepley   prob->ops->setup          = NULL;
28752764a2aaSMatthew G. Knepley   prob->ops->view           = NULL;
28762764a2aaSMatthew G. Knepley   prob->ops->destroy        = PetscDSDestroy_Basic;
28772764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
28782764a2aaSMatthew G. Knepley }
28792764a2aaSMatthew G. Knepley 
28802764a2aaSMatthew G. Knepley /*MC
28812764a2aaSMatthew G. Knepley   PETSCDSBASIC = "basic" - A discrete system with pointwise residual and boundary residual functions
28822764a2aaSMatthew G. Knepley 
28832764a2aaSMatthew G. Knepley   Level: intermediate
28842764a2aaSMatthew G. Knepley 
28852764a2aaSMatthew G. Knepley .seealso: PetscDSType, PetscDSCreate(), PetscDSSetType()
28862764a2aaSMatthew G. Knepley M*/
28872764a2aaSMatthew G. Knepley 
28882764a2aaSMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscDSCreate_Basic(PetscDS prob)
28892764a2aaSMatthew G. Knepley {
28902764a2aaSMatthew G. Knepley   PetscDS_Basic *b;
28912764a2aaSMatthew G. Knepley   PetscErrorCode      ierr;
28922764a2aaSMatthew G. Knepley 
28932764a2aaSMatthew G. Knepley   PetscFunctionBegin;
2894931fb3b8SToby Isaac   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1);
28952764a2aaSMatthew G. Knepley   ierr       = PetscNewLog(prob, &b);CHKERRQ(ierr);
28962764a2aaSMatthew G. Knepley   prob->data = b;
28972764a2aaSMatthew G. Knepley 
28982764a2aaSMatthew G. Knepley   ierr = PetscDSInitialize_Basic(prob);CHKERRQ(ierr);
28992764a2aaSMatthew G. Knepley   PetscFunctionReturn(0);
29002764a2aaSMatthew G. Knepley }
2901