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 37f5f57ec0SBarry Smith Not available from Fortran 38f5f57ec0SBarry Smith 392764a2aaSMatthew G. Knepley .keywords: PetscDS, register 402764a2aaSMatthew G. Knepley .seealso: PetscDSRegisterAll(), PetscDSRegisterDestroy() 412764a2aaSMatthew G. Knepley 422764a2aaSMatthew G. Knepley @*/ 432764a2aaSMatthew G. Knepley PetscErrorCode PetscDSRegister(const char sname[], PetscErrorCode (*function)(PetscDS)) 442764a2aaSMatthew G. Knepley { 452764a2aaSMatthew G. Knepley PetscErrorCode ierr; 462764a2aaSMatthew G. Knepley 472764a2aaSMatthew G. Knepley PetscFunctionBegin; 482764a2aaSMatthew G. Knepley ierr = PetscFunctionListAdd(&PetscDSList, sname, function);CHKERRQ(ierr); 492764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 502764a2aaSMatthew G. Knepley } 512764a2aaSMatthew G. Knepley 522764a2aaSMatthew G. Knepley /*@C 532764a2aaSMatthew G. Knepley PetscDSSetType - Builds a particular PetscDS 542764a2aaSMatthew G. Knepley 552764a2aaSMatthew G. Knepley Collective on PetscDS 562764a2aaSMatthew G. Knepley 572764a2aaSMatthew G. Knepley Input Parameters: 582764a2aaSMatthew G. Knepley + prob - The PetscDS object 592764a2aaSMatthew G. Knepley - name - The kind of system 602764a2aaSMatthew G. Knepley 612764a2aaSMatthew G. Knepley Options Database Key: 622764a2aaSMatthew G. Knepley . -petscds_type <type> - Sets the PetscDS type; use -help for a list of available types 632764a2aaSMatthew G. Knepley 642764a2aaSMatthew G. Knepley Level: intermediate 652764a2aaSMatthew G. Knepley 66f5f57ec0SBarry Smith Not available from Fortran 67f5f57ec0SBarry Smith 682764a2aaSMatthew G. Knepley .keywords: PetscDS, set, type 692764a2aaSMatthew G. Knepley .seealso: PetscDSGetType(), PetscDSCreate() 702764a2aaSMatthew G. Knepley @*/ 712764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetType(PetscDS prob, PetscDSType name) 722764a2aaSMatthew G. Knepley { 732764a2aaSMatthew G. Knepley PetscErrorCode (*r)(PetscDS); 742764a2aaSMatthew G. Knepley PetscBool match; 752764a2aaSMatthew G. Knepley PetscErrorCode ierr; 762764a2aaSMatthew G. Knepley 772764a2aaSMatthew G. Knepley PetscFunctionBegin; 782764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 792764a2aaSMatthew G. Knepley ierr = PetscObjectTypeCompare((PetscObject) prob, name, &match);CHKERRQ(ierr); 802764a2aaSMatthew G. Knepley if (match) PetscFunctionReturn(0); 812764a2aaSMatthew G. Knepley 820f51fdf8SToby Isaac ierr = PetscDSRegisterAll();CHKERRQ(ierr); 832764a2aaSMatthew G. Knepley ierr = PetscFunctionListFind(PetscDSList, name, &r);CHKERRQ(ierr); 842764a2aaSMatthew G. Knepley if (!r) SETERRQ1(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_UNKNOWN_TYPE, "Unknown PetscDS type: %s", name); 852764a2aaSMatthew G. Knepley 862764a2aaSMatthew G. Knepley if (prob->ops->destroy) { 872764a2aaSMatthew G. Knepley ierr = (*prob->ops->destroy)(prob);CHKERRQ(ierr); 882764a2aaSMatthew G. Knepley prob->ops->destroy = NULL; 892764a2aaSMatthew G. Knepley } 902764a2aaSMatthew G. Knepley ierr = (*r)(prob);CHKERRQ(ierr); 912764a2aaSMatthew G. Knepley ierr = PetscObjectChangeTypeName((PetscObject) prob, name);CHKERRQ(ierr); 922764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 932764a2aaSMatthew G. Knepley } 942764a2aaSMatthew G. Knepley 952764a2aaSMatthew G. Knepley /*@C 962764a2aaSMatthew G. Knepley PetscDSGetType - Gets the PetscDS type name (as a string) from the object. 972764a2aaSMatthew G. Knepley 982764a2aaSMatthew G. Knepley Not Collective 992764a2aaSMatthew G. Knepley 1002764a2aaSMatthew G. Knepley Input Parameter: 1012764a2aaSMatthew G. Knepley . prob - The PetscDS 1022764a2aaSMatthew G. Knepley 1032764a2aaSMatthew G. Knepley Output Parameter: 1042764a2aaSMatthew G. Knepley . name - The PetscDS type name 1052764a2aaSMatthew G. Knepley 1062764a2aaSMatthew G. Knepley Level: intermediate 1072764a2aaSMatthew G. Knepley 108f5f57ec0SBarry Smith Not available from Fortran 109f5f57ec0SBarry Smith 1102764a2aaSMatthew G. Knepley .keywords: PetscDS, get, type, name 1112764a2aaSMatthew G. Knepley .seealso: PetscDSSetType(), PetscDSCreate() 1122764a2aaSMatthew G. Knepley @*/ 1132764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetType(PetscDS prob, PetscDSType *name) 1142764a2aaSMatthew G. Knepley { 1152764a2aaSMatthew G. Knepley PetscErrorCode ierr; 1162764a2aaSMatthew G. Knepley 1172764a2aaSMatthew G. Knepley PetscFunctionBegin; 1182764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 119c959eef4SJed Brown PetscValidPointer(name, 2); 1200f51fdf8SToby Isaac ierr = PetscDSRegisterAll();CHKERRQ(ierr); 1212764a2aaSMatthew G. Knepley *name = ((PetscObject) prob)->type_name; 1222764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 1232764a2aaSMatthew G. Knepley } 1242764a2aaSMatthew G. Knepley 1257d8a60eaSMatthew G. Knepley static PetscErrorCode PetscDSView_Ascii(PetscDS prob, PetscViewer viewer) 1267d8a60eaSMatthew G. Knepley { 1277d8a60eaSMatthew G. Knepley PetscViewerFormat format; 12897b6e6e8SMatthew G. Knepley const PetscScalar *constants; 12997b6e6e8SMatthew G. Knepley PetscInt numConstants, f; 1307d8a60eaSMatthew G. Knepley PetscErrorCode ierr; 1317d8a60eaSMatthew G. Knepley 1327d8a60eaSMatthew G. Knepley PetscFunctionBegin; 1337d8a60eaSMatthew G. Knepley ierr = PetscViewerGetFormat(viewer, &format);CHKERRQ(ierr); 1347d8a60eaSMatthew G. Knepley ierr = PetscViewerASCIIPrintf(viewer, "Discrete System with %d fields\n", prob->Nf);CHKERRQ(ierr); 1357d8a60eaSMatthew G. Knepley ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 136*4727e194SMatthew G. Knepley ierr = PetscViewerASCIIPrintf(viewer, " cell total dim %D total comp %D\n", prob->totDim, prob->totComp);CHKERRQ(ierr); 137*4727e194SMatthew G. Knepley if (prob->isHybrid) {ierr = PetscViewerASCIIPrintf(viewer, " hybrid cell\n");CHKERRQ(ierr);} 1387d8a60eaSMatthew G. Knepley for (f = 0; f < prob->Nf; ++f) { 1397d8a60eaSMatthew G. Knepley PetscObject obj; 1407d8a60eaSMatthew G. Knepley PetscClassId id; 141f35450b9SMatthew G. Knepley PetscQuadrature q; 1427d8a60eaSMatthew G. Knepley const char *name; 143f35450b9SMatthew G. Knepley PetscInt Nc, Nq, Nqc; 1447d8a60eaSMatthew G. Knepley 1457d8a60eaSMatthew G. Knepley ierr = PetscDSGetDiscretization(prob, f, &obj);CHKERRQ(ierr); 1467d8a60eaSMatthew G. Knepley ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr); 1477d8a60eaSMatthew G. Knepley ierr = PetscObjectGetName(obj, &name);CHKERRQ(ierr); 1487d8a60eaSMatthew G. Knepley ierr = PetscViewerASCIIPrintf(viewer, "Field %s", name ? name : "<unknown>");CHKERRQ(ierr); 149*4727e194SMatthew G. Knepley ierr = PetscViewerASCIIUseTabs(viewer, PETSC_FALSE);CHKERRQ(ierr); 1507d8a60eaSMatthew G. Knepley if (id == PETSCFE_CLASSID) { 1517d8a60eaSMatthew G. Knepley ierr = PetscFEGetNumComponents((PetscFE) obj, &Nc);CHKERRQ(ierr); 152f35450b9SMatthew G. Knepley ierr = PetscFEGetQuadrature((PetscFE) obj, &q);CHKERRQ(ierr); 1537d8a60eaSMatthew G. Knepley ierr = PetscViewerASCIIPrintf(viewer, " FEM");CHKERRQ(ierr); 1547d8a60eaSMatthew G. Knepley } else if (id == PETSCFV_CLASSID) { 1557d8a60eaSMatthew G. Knepley ierr = PetscFVGetNumComponents((PetscFV) obj, &Nc);CHKERRQ(ierr); 156f35450b9SMatthew G. Knepley ierr = PetscFVGetQuadrature((PetscFV) obj, &q);CHKERRQ(ierr); 1577d8a60eaSMatthew G. Knepley ierr = PetscViewerASCIIPrintf(viewer, " FVM");CHKERRQ(ierr); 1587d8a60eaSMatthew G. Knepley } 15997b6e6e8SMatthew G. Knepley else SETERRQ1(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Unknown discretization type for field %D", f); 16097b6e6e8SMatthew G. Knepley if (Nc > 1) {ierr = PetscViewerASCIIPrintf(viewer, "%D components", Nc);CHKERRQ(ierr);} 16197b6e6e8SMatthew G. Knepley else {ierr = PetscViewerASCIIPrintf(viewer, "%D component ", Nc);CHKERRQ(ierr);} 162249df284SMatthew G. Knepley if (prob->implicit[f]) {ierr = PetscViewerASCIIPrintf(viewer, " (implicit)");CHKERRQ(ierr);} 163249df284SMatthew G. Knepley else {ierr = PetscViewerASCIIPrintf(viewer, " (explicit)");CHKERRQ(ierr);} 164a6cbbb48SMatthew G. Knepley if (prob->adjacency[f*2+0]) { 165a6cbbb48SMatthew G. Knepley if (prob->adjacency[f*2+1]) {ierr = PetscViewerASCIIPrintf(viewer, " (adj FVM++)");CHKERRQ(ierr);} 166a6cbbb48SMatthew G. Knepley else {ierr = PetscViewerASCIIPrintf(viewer, " (adj FVM)");CHKERRQ(ierr);} 167a6cbbb48SMatthew G. Knepley } else { 168a6cbbb48SMatthew G. Knepley if (prob->adjacency[f*2+1]) {ierr = PetscViewerASCIIPrintf(viewer, " (adj FEM)");CHKERRQ(ierr);} 169a6cbbb48SMatthew G. Knepley else {ierr = PetscViewerASCIIPrintf(viewer, " (adj FUNKY)");CHKERRQ(ierr);} 170a6cbbb48SMatthew G. Knepley } 1713e60c2a6SMatthew G. Knepley if (q) { 172f35450b9SMatthew G. Knepley ierr = PetscQuadratureGetData(q, NULL, &Nqc, &Nq, NULL, NULL);CHKERRQ(ierr); 173f35450b9SMatthew G. Knepley ierr = PetscViewerASCIIPrintf(viewer, " (Nq %D Nqc %D)", Nq, Nqc);CHKERRQ(ierr); 1743e60c2a6SMatthew G. Knepley } 1757d8a60eaSMatthew G. Knepley ierr = PetscViewerASCIIPrintf(viewer, "\n");CHKERRQ(ierr); 176*4727e194SMatthew G. Knepley ierr = PetscViewerASCIIUseTabs(viewer, PETSC_TRUE);CHKERRQ(ierr); 1775d160056SMatthew G. Knepley ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 1787d8a60eaSMatthew G. Knepley if (id == PETSCFE_CLASSID) {ierr = PetscFEView((PetscFE) obj, viewer);CHKERRQ(ierr);} 1797d8a60eaSMatthew G. Knepley else if (id == PETSCFV_CLASSID) {ierr = PetscFVView((PetscFV) obj, viewer);CHKERRQ(ierr);} 1805d160056SMatthew G. Knepley ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 1817d8a60eaSMatthew G. Knepley } 18297b6e6e8SMatthew G. Knepley ierr = PetscDSGetConstants(prob, &numConstants, &constants);CHKERRQ(ierr); 18397b6e6e8SMatthew G. Knepley if (numConstants) { 18497b6e6e8SMatthew G. Knepley ierr = PetscViewerASCIIPrintf(viewer, "%D constants\n", numConstants);CHKERRQ(ierr); 18597b6e6e8SMatthew G. Knepley ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 18657fc01e9SMatthew G. Knepley for (f = 0; f < numConstants; ++f) {ierr = PetscViewerASCIIPrintf(viewer, "%g\n", (double) PetscRealPart(constants[f]));CHKERRQ(ierr);} 18797b6e6e8SMatthew G. Knepley ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 18897b6e6e8SMatthew G. Knepley } 1897d8a60eaSMatthew G. Knepley ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 1907d8a60eaSMatthew G. Knepley PetscFunctionReturn(0); 1917d8a60eaSMatthew G. Knepley } 1927d8a60eaSMatthew G. Knepley 1932764a2aaSMatthew G. Knepley /*@C 1942764a2aaSMatthew G. Knepley PetscDSView - Views a PetscDS 1952764a2aaSMatthew G. Knepley 1962764a2aaSMatthew G. Knepley Collective on PetscDS 1972764a2aaSMatthew G. Knepley 1982764a2aaSMatthew G. Knepley Input Parameter: 1992764a2aaSMatthew G. Knepley + prob - the PetscDS object to view 2002764a2aaSMatthew G. Knepley - v - the viewer 2012764a2aaSMatthew G. Knepley 2022764a2aaSMatthew G. Knepley Level: developer 2032764a2aaSMatthew G. Knepley 2042764a2aaSMatthew G. Knepley .seealso PetscDSDestroy() 2052764a2aaSMatthew G. Knepley @*/ 2062764a2aaSMatthew G. Knepley PetscErrorCode PetscDSView(PetscDS prob, PetscViewer v) 2072764a2aaSMatthew G. Knepley { 2087d8a60eaSMatthew G. Knepley PetscBool iascii; 2092764a2aaSMatthew G. Knepley PetscErrorCode ierr; 2102764a2aaSMatthew G. Knepley 2112764a2aaSMatthew G. Knepley PetscFunctionBegin; 2122764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 2132764a2aaSMatthew G. Knepley if (!v) {ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject) prob), &v);CHKERRQ(ierr);} 2147d8a60eaSMatthew G. Knepley else {PetscValidHeaderSpecific(v, PETSC_VIEWER_CLASSID, 2);} 2157d8a60eaSMatthew G. Knepley ierr = PetscObjectTypeCompare((PetscObject) v, PETSCVIEWERASCII, &iascii);CHKERRQ(ierr); 2167d8a60eaSMatthew G. Knepley if (iascii) {ierr = PetscDSView_Ascii(prob, v);CHKERRQ(ierr);} 2172764a2aaSMatthew G. Knepley if (prob->ops->view) {ierr = (*prob->ops->view)(prob, v);CHKERRQ(ierr);} 2182764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 2192764a2aaSMatthew G. Knepley } 2202764a2aaSMatthew G. Knepley 2212764a2aaSMatthew G. Knepley /*@ 2222764a2aaSMatthew G. Knepley PetscDSSetFromOptions - sets parameters in a PetscDS from the options database 2232764a2aaSMatthew G. Knepley 2242764a2aaSMatthew G. Knepley Collective on PetscDS 2252764a2aaSMatthew G. Knepley 2262764a2aaSMatthew G. Knepley Input Parameter: 2272764a2aaSMatthew G. Knepley . prob - the PetscDS object to set options for 2282764a2aaSMatthew G. Knepley 2292764a2aaSMatthew G. Knepley Options Database: 23055c1f793SMatthew G. Knepley + -petscds_type <type> : Set the DS type 23155c1f793SMatthew G. Knepley . -petscds_view <view opt> : View the DS 23255c1f793SMatthew G. Knepley . -petscds_jac_pre : Turn formation of a separate Jacobian preconditioner on and off 23355c1f793SMatthew G. Knepley . -bc_<name> <ids> : Specify a list of label ids for a boundary condition 23455c1f793SMatthew G. Knepley - -bc_<name>_comp <comps> : Specify a list of field components to constrain for a boundary condition 2352764a2aaSMatthew G. Knepley 2362764a2aaSMatthew G. Knepley Level: developer 2372764a2aaSMatthew G. Knepley 2382764a2aaSMatthew G. Knepley .seealso PetscDSView() 2392764a2aaSMatthew G. Knepley @*/ 2402764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetFromOptions(PetscDS prob) 2412764a2aaSMatthew G. Knepley { 242f1fd5e65SToby Isaac DSBoundary b; 2432764a2aaSMatthew G. Knepley const char *defaultType; 2442764a2aaSMatthew G. Knepley char name[256]; 2452764a2aaSMatthew G. Knepley PetscBool flg; 2462764a2aaSMatthew G. Knepley PetscErrorCode ierr; 2472764a2aaSMatthew G. Knepley 2482764a2aaSMatthew G. Knepley PetscFunctionBegin; 2492764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 2502764a2aaSMatthew G. Knepley if (!((PetscObject) prob)->type_name) { 2512764a2aaSMatthew G. Knepley defaultType = PETSCDSBASIC; 2522764a2aaSMatthew G. Knepley } else { 2532764a2aaSMatthew G. Knepley defaultType = ((PetscObject) prob)->type_name; 2542764a2aaSMatthew G. Knepley } 2550f51fdf8SToby Isaac ierr = PetscDSRegisterAll();CHKERRQ(ierr); 2562764a2aaSMatthew G. Knepley 2572764a2aaSMatthew G. Knepley ierr = PetscObjectOptionsBegin((PetscObject) prob);CHKERRQ(ierr); 258f1fd5e65SToby Isaac for (b = prob->boundary; b; b = b->next) { 259f1fd5e65SToby Isaac char optname[1024]; 260f1fd5e65SToby Isaac PetscInt ids[1024], len = 1024; 261f1fd5e65SToby Isaac PetscBool flg; 262f1fd5e65SToby Isaac 263f1fd5e65SToby Isaac ierr = PetscSNPrintf(optname, sizeof(optname), "-bc_%s", b->name);CHKERRQ(ierr); 264f1fd5e65SToby Isaac ierr = PetscMemzero(ids, sizeof(ids));CHKERRQ(ierr); 265f1fd5e65SToby Isaac ierr = PetscOptionsIntArray(optname, "List of boundary IDs", "", ids, &len, &flg);CHKERRQ(ierr); 266f1fd5e65SToby Isaac if (flg) { 267f1fd5e65SToby Isaac b->numids = len; 268f1fd5e65SToby Isaac ierr = PetscFree(b->ids);CHKERRQ(ierr); 269f1fd5e65SToby Isaac ierr = PetscMalloc1(len, &b->ids);CHKERRQ(ierr); 270f1fd5e65SToby Isaac ierr = PetscMemcpy(b->ids, ids, len*sizeof(PetscInt));CHKERRQ(ierr); 271f1fd5e65SToby Isaac } 272e7b0402cSSander Arens len = 1024; 273f1fd5e65SToby Isaac ierr = PetscSNPrintf(optname, sizeof(optname), "-bc_%s_comp", b->name);CHKERRQ(ierr); 274f1fd5e65SToby Isaac ierr = PetscMemzero(ids, sizeof(ids));CHKERRQ(ierr); 275f1fd5e65SToby Isaac ierr = PetscOptionsIntArray(optname, "List of boundary field components", "", ids, &len, &flg);CHKERRQ(ierr); 276f1fd5e65SToby Isaac if (flg) { 277f1fd5e65SToby Isaac b->numcomps = len; 278f1fd5e65SToby Isaac ierr = PetscFree(b->comps);CHKERRQ(ierr); 279f1fd5e65SToby Isaac ierr = PetscMalloc1(len, &b->comps);CHKERRQ(ierr); 280f1fd5e65SToby Isaac ierr = PetscMemcpy(b->comps, ids, len*sizeof(PetscInt));CHKERRQ(ierr); 281f1fd5e65SToby Isaac } 282f1fd5e65SToby Isaac } 2832764a2aaSMatthew G. Knepley ierr = PetscOptionsFList("-petscds_type", "Discrete System", "PetscDSSetType", PetscDSList, defaultType, name, 256, &flg);CHKERRQ(ierr); 2842764a2aaSMatthew G. Knepley if (flg) { 2852764a2aaSMatthew G. Knepley ierr = PetscDSSetType(prob, name);CHKERRQ(ierr); 2862764a2aaSMatthew G. Knepley } else if (!((PetscObject) prob)->type_name) { 2872764a2aaSMatthew G. Knepley ierr = PetscDSSetType(prob, defaultType);CHKERRQ(ierr); 2882764a2aaSMatthew G. Knepley } 28955c1f793SMatthew G. Knepley ierr = PetscOptionsBool("-petscds_jac_pre", "Discrete System", "PetscDSUseJacobianPreconditioner", prob->useJacPre, &prob->useJacPre, &flg);CHKERRQ(ierr); 2902764a2aaSMatthew G. Knepley if (prob->ops->setfromoptions) {ierr = (*prob->ops->setfromoptions)(prob);CHKERRQ(ierr);} 2912764a2aaSMatthew G. Knepley /* process any options handlers added with PetscObjectAddOptionsHandler() */ 2920633abcbSJed Brown ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject) prob);CHKERRQ(ierr); 2932764a2aaSMatthew G. Knepley ierr = PetscOptionsEnd();CHKERRQ(ierr); 2945d160056SMatthew G. Knepley if (prob->Nf) {ierr = PetscDSViewFromOptions(prob, NULL, "-petscds_view");CHKERRQ(ierr);} 2952764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 2962764a2aaSMatthew G. Knepley } 2972764a2aaSMatthew G. Knepley 2982764a2aaSMatthew G. Knepley /*@C 2992764a2aaSMatthew G. Knepley PetscDSSetUp - Construct data structures for the PetscDS 3002764a2aaSMatthew G. Knepley 3012764a2aaSMatthew G. Knepley Collective on PetscDS 3022764a2aaSMatthew G. Knepley 3032764a2aaSMatthew G. Knepley Input Parameter: 3042764a2aaSMatthew G. Knepley . prob - the PetscDS object to setup 3052764a2aaSMatthew G. Knepley 3062764a2aaSMatthew G. Knepley Level: developer 3072764a2aaSMatthew G. Knepley 3082764a2aaSMatthew G. Knepley .seealso PetscDSView(), PetscDSDestroy() 3092764a2aaSMatthew G. Knepley @*/ 3102764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetUp(PetscDS prob) 3112764a2aaSMatthew G. Knepley { 3122764a2aaSMatthew G. Knepley const PetscInt Nf = prob->Nf; 313d1506c7cSMatthew G. Knepley PetscInt dim, dimEmbed, work, NcMax = 0, NqMax = 0, f; 3142764a2aaSMatthew G. Knepley PetscErrorCode ierr; 3152764a2aaSMatthew G. Knepley 3162764a2aaSMatthew G. Knepley PetscFunctionBegin; 3172764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 3182764a2aaSMatthew G. Knepley if (prob->setup) PetscFunctionReturn(0); 3192764a2aaSMatthew G. Knepley /* Calculate sizes */ 3202764a2aaSMatthew G. Knepley ierr = PetscDSGetSpatialDimension(prob, &dim);CHKERRQ(ierr); 321d1506c7cSMatthew G. Knepley ierr = PetscDSGetCoordinateDimension(prob, &dimEmbed);CHKERRQ(ierr); 322f744cafaSSander Arens prob->totDim = prob->totComp = 0; 32347e57110SSander Arens ierr = PetscMalloc2(Nf,&prob->Nc,Nf,&prob->Nb);CHKERRQ(ierr); 324f744cafaSSander Arens ierr = PetscCalloc2(Nf+1,&prob->off,Nf+1,&prob->offDer);CHKERRQ(ierr); 325f744cafaSSander Arens ierr = PetscMalloc4(Nf,&prob->basis,Nf,&prob->basisDer,Nf,&prob->basisFace,Nf,&prob->basisDerFace);CHKERRQ(ierr); 3262764a2aaSMatthew G. Knepley for (f = 0; f < Nf; ++f) { 3279de99aefSMatthew G. Knepley PetscObject obj; 3289de99aefSMatthew G. Knepley PetscClassId id; 3292764a2aaSMatthew G. Knepley PetscQuadrature q; 3309de99aefSMatthew G. Knepley PetscInt Nq = 0, Nb, Nc; 3312764a2aaSMatthew G. Knepley 3329de99aefSMatthew G. Knepley ierr = PetscDSGetDiscretization(prob, f, &obj);CHKERRQ(ierr); 3339de99aefSMatthew G. Knepley ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr); 3349de99aefSMatthew G. Knepley if (id == PETSCFE_CLASSID) { 3359de99aefSMatthew G. Knepley PetscFE fe = (PetscFE) obj; 3369de99aefSMatthew G. Knepley 3372764a2aaSMatthew G. Knepley ierr = PetscFEGetQuadrature(fe, &q);CHKERRQ(ierr); 3382764a2aaSMatthew G. Knepley ierr = PetscFEGetDimension(fe, &Nb);CHKERRQ(ierr); 3392764a2aaSMatthew G. Knepley ierr = PetscFEGetNumComponents(fe, &Nc);CHKERRQ(ierr); 3402764a2aaSMatthew G. Knepley ierr = PetscFEGetDefaultTabulation(fe, &prob->basis[f], &prob->basisDer[f], NULL);CHKERRQ(ierr); 3414d0b9603SSander Arens ierr = PetscFEGetFaceTabulation(fe, &prob->basisFace[f], &prob->basisDerFace[f], NULL);CHKERRQ(ierr); 3429de99aefSMatthew G. Knepley } else if (id == PETSCFV_CLASSID) { 3439de99aefSMatthew G. Knepley PetscFV fv = (PetscFV) obj; 3449de99aefSMatthew G. Knepley 3459de99aefSMatthew G. Knepley ierr = PetscFVGetQuadrature(fv, &q);CHKERRQ(ierr); 3469de99aefSMatthew G. Knepley ierr = PetscFVGetNumComponents(fv, &Nc);CHKERRQ(ierr); 3479c3cf19fSMatthew G. Knepley Nb = Nc; 3486c1a3d01SMatthew G. Knepley ierr = PetscFVGetDefaultTabulation(fv, &prob->basis[f], &prob->basisDer[f], NULL);CHKERRQ(ierr); 3494d0b9603SSander Arens /* TODO: should PetscFV also have face tabulation? Otherwise there will be a null pointer in prob->basisFace */ 350abac5ca0SMatthew G. Knepley } else SETERRQ1(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Unknown discretization type for field %d", f); 35147e57110SSander Arens prob->Nc[f] = Nc; 35247e57110SSander Arens prob->Nb[f] = Nb; 353194d53e6SMatthew G. Knepley prob->off[f+1] = Nc + prob->off[f]; 354194d53e6SMatthew G. Knepley prob->offDer[f+1] = Nc*dim + prob->offDer[f]; 355a6b92713SMatthew G. Knepley if (q) {ierr = PetscQuadratureGetData(q, NULL, NULL, &Nq, NULL, NULL);CHKERRQ(ierr);} 3562764a2aaSMatthew G. Knepley NqMax = PetscMax(NqMax, Nq); 3572764a2aaSMatthew G. Knepley NcMax = PetscMax(NcMax, Nc); 3589c3cf19fSMatthew G. Knepley prob->totDim += Nb; 3592764a2aaSMatthew G. Knepley prob->totComp += Nc; 3602764a2aaSMatthew G. Knepley } 3612764a2aaSMatthew G. Knepley work = PetscMax(prob->totComp*dim, PetscSqr(NcMax*dim)); 3622764a2aaSMatthew G. Knepley /* Allocate works space */ 363fd558bbcSMatthew G. Knepley ierr = PetscMalloc5(prob->totComp,&prob->u,prob->totComp,&prob->u_t,prob->totComp*dimEmbed,&prob->u_x,dimEmbed,&prob->x,work,&prob->refSpaceDer);CHKERRQ(ierr); 3642764a2aaSMatthew 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); 3652764a2aaSMatthew G. Knepley if (prob->ops->setup) {ierr = (*prob->ops->setup)(prob);CHKERRQ(ierr);} 3662764a2aaSMatthew G. Knepley prob->setup = PETSC_TRUE; 3672764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 3682764a2aaSMatthew G. Knepley } 3692764a2aaSMatthew G. Knepley 3702764a2aaSMatthew G. Knepley static PetscErrorCode PetscDSDestroyStructs_Static(PetscDS prob) 3712764a2aaSMatthew G. Knepley { 3722764a2aaSMatthew G. Knepley PetscErrorCode ierr; 3732764a2aaSMatthew G. Knepley 3742764a2aaSMatthew G. Knepley PetscFunctionBegin; 37547e57110SSander Arens ierr = PetscFree2(prob->Nc,prob->Nb);CHKERRQ(ierr); 376f744cafaSSander Arens ierr = PetscFree2(prob->off,prob->offDer);CHKERRQ(ierr); 377f744cafaSSander Arens ierr = PetscFree4(prob->basis,prob->basisDer,prob->basisFace,prob->basisDerFace);CHKERRQ(ierr); 3782764a2aaSMatthew G. Knepley ierr = PetscFree5(prob->u,prob->u_t,prob->u_x,prob->x,prob->refSpaceDer);CHKERRQ(ierr); 3792764a2aaSMatthew G. Knepley ierr = PetscFree6(prob->f0,prob->f1,prob->g0,prob->g1,prob->g2,prob->g3);CHKERRQ(ierr); 3802764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 3812764a2aaSMatthew G. Knepley } 3822764a2aaSMatthew G. Knepley 3832764a2aaSMatthew G. Knepley static PetscErrorCode PetscDSEnlarge_Static(PetscDS prob, PetscInt NfNew) 3842764a2aaSMatthew G. Knepley { 385f744cafaSSander Arens PetscObject *tmpd; 386a6cbbb48SMatthew G. Knepley PetscBool *tmpi, *tmpa; 38732d2bbc9SMatthew G. Knepley PetscPointFunc *tmpobj, *tmpf, *tmpup; 388b7e05686SMatthew G. Knepley PetscPointJac *tmpg, *tmpgp, *tmpgt; 3892aa1fc23SMatthew G. Knepley PetscBdPointFunc *tmpfbd; 3902aa1fc23SMatthew G. Knepley PetscBdPointJac *tmpgbd; 391194d53e6SMatthew G. Knepley PetscRiemannFunc *tmpr; 392c371a6d1SMatthew G. Knepley PetscSimplePointFunc *tmpexactSol; 3930c2f2876SMatthew G. Knepley void **tmpctx; 394a6cbbb48SMatthew G. Knepley PetscInt Nf = prob->Nf, f, i; 3952764a2aaSMatthew G. Knepley PetscErrorCode ierr; 3962764a2aaSMatthew G. Knepley 3972764a2aaSMatthew G. Knepley PetscFunctionBegin; 3982764a2aaSMatthew G. Knepley if (Nf >= NfNew) PetscFunctionReturn(0); 3992764a2aaSMatthew G. Knepley prob->setup = PETSC_FALSE; 4002764a2aaSMatthew G. Knepley ierr = PetscDSDestroyStructs_Static(prob);CHKERRQ(ierr); 401f744cafaSSander Arens ierr = PetscMalloc3(NfNew, &tmpd, NfNew, &tmpi, NfNew*2, &tmpa);CHKERRQ(ierr); 402f744cafaSSander 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];} 403f744cafaSSander 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;} 404f744cafaSSander Arens ierr = PetscFree3(prob->disc, prob->implicit, prob->adjacency);CHKERRQ(ierr); 4052764a2aaSMatthew G. Knepley prob->Nf = NfNew; 4062764a2aaSMatthew G. Knepley prob->disc = tmpd; 407249df284SMatthew G. Knepley prob->implicit = tmpi; 408a6cbbb48SMatthew G. Knepley prob->adjacency = tmpa; 409b7e05686SMatthew 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); 41032d2bbc9SMatthew G. Knepley ierr = PetscCalloc1(NfNew, &tmpup);CHKERRQ(ierr); 4112764a2aaSMatthew G. Knepley for (f = 0; f < Nf; ++f) tmpobj[f] = prob->obj[f]; 4122764a2aaSMatthew G. Knepley for (f = 0; f < Nf*2; ++f) tmpf[f] = prob->f[f]; 4132764a2aaSMatthew G. Knepley for (f = 0; f < Nf*Nf*4; ++f) tmpg[f] = prob->g[f]; 414475e0ac9SMatthew G. Knepley for (f = 0; f < Nf*Nf*4; ++f) tmpgp[f] = prob->gp[f]; 4150c2f2876SMatthew G. Knepley for (f = 0; f < Nf; ++f) tmpr[f] = prob->r[f]; 41632d2bbc9SMatthew G. Knepley for (f = 0; f < Nf; ++f) tmpup[f] = prob->update[f]; 4170c2f2876SMatthew G. Knepley for (f = 0; f < Nf; ++f) tmpctx[f] = prob->ctx[f]; 4182764a2aaSMatthew G. Knepley for (f = Nf; f < NfNew; ++f) tmpobj[f] = NULL; 4192764a2aaSMatthew G. Knepley for (f = Nf*2; f < NfNew*2; ++f) tmpf[f] = NULL; 4202764a2aaSMatthew G. Knepley for (f = Nf*Nf*4; f < NfNew*NfNew*4; ++f) tmpg[f] = NULL; 421475e0ac9SMatthew G. Knepley for (f = Nf*Nf*4; f < NfNew*NfNew*4; ++f) tmpgp[f] = NULL; 422b7e05686SMatthew G. Knepley for (f = Nf*Nf*4; f < NfNew*NfNew*4; ++f) tmpgt[f] = NULL; 4230c2f2876SMatthew G. Knepley for (f = Nf; f < NfNew; ++f) tmpr[f] = NULL; 42432d2bbc9SMatthew G. Knepley for (f = Nf; f < NfNew; ++f) tmpup[f] = NULL; 4250c2f2876SMatthew G. Knepley for (f = Nf; f < NfNew; ++f) tmpctx[f] = NULL; 426b7e05686SMatthew G. Knepley ierr = PetscFree7(prob->obj, prob->f, prob->g, prob->gp, prob->gt, prob->r, prob->ctx);CHKERRQ(ierr); 42732d2bbc9SMatthew G. Knepley ierr = PetscFree(prob->update);CHKERRQ(ierr); 4282764a2aaSMatthew G. Knepley prob->obj = tmpobj; 4292764a2aaSMatthew G. Knepley prob->f = tmpf; 4302764a2aaSMatthew G. Knepley prob->g = tmpg; 431475e0ac9SMatthew G. Knepley prob->gp = tmpgp; 432b7e05686SMatthew G. Knepley prob->gt = tmpgt; 4330c2f2876SMatthew G. Knepley prob->r = tmpr; 43432d2bbc9SMatthew G. Knepley prob->update = tmpup; 4350c2f2876SMatthew G. Knepley prob->ctx = tmpctx; 436c371a6d1SMatthew G. Knepley ierr = PetscCalloc3(NfNew*2, &tmpfbd, NfNew*NfNew*4, &tmpgbd, NfNew, &tmpexactSol);CHKERRQ(ierr); 4372764a2aaSMatthew G. Knepley for (f = 0; f < Nf*2; ++f) tmpfbd[f] = prob->fBd[f]; 4382764a2aaSMatthew G. Knepley for (f = 0; f < Nf*Nf*4; ++f) tmpgbd[f] = prob->gBd[f]; 439c371a6d1SMatthew G. Knepley for (f = 0; f < Nf; ++f) tmpexactSol[f] = prob->exactSol[f]; 4402764a2aaSMatthew G. Knepley for (f = Nf*2; f < NfNew*2; ++f) tmpfbd[f] = NULL; 4412764a2aaSMatthew G. Knepley for (f = Nf*Nf*4; f < NfNew*NfNew*4; ++f) tmpgbd[f] = NULL; 442c371a6d1SMatthew G. Knepley for (f = Nf; f < NfNew; ++f) tmpexactSol[f] = NULL; 443c371a6d1SMatthew G. Knepley ierr = PetscFree3(prob->fBd, prob->gBd, prob->exactSol);CHKERRQ(ierr); 4442764a2aaSMatthew G. Knepley prob->fBd = tmpfbd; 4452764a2aaSMatthew G. Knepley prob->gBd = tmpgbd; 446c371a6d1SMatthew G. Knepley prob->exactSol = tmpexactSol; 4472764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 4482764a2aaSMatthew G. Knepley } 4492764a2aaSMatthew G. Knepley 4502764a2aaSMatthew G. Knepley /*@ 4512764a2aaSMatthew G. Knepley PetscDSDestroy - Destroys a PetscDS object 4522764a2aaSMatthew G. Knepley 4532764a2aaSMatthew G. Knepley Collective on PetscDS 4542764a2aaSMatthew G. Knepley 4552764a2aaSMatthew G. Knepley Input Parameter: 4562764a2aaSMatthew G. Knepley . prob - the PetscDS object to destroy 4572764a2aaSMatthew G. Knepley 4582764a2aaSMatthew G. Knepley Level: developer 4592764a2aaSMatthew G. Knepley 4602764a2aaSMatthew G. Knepley .seealso PetscDSView() 4612764a2aaSMatthew G. Knepley @*/ 4622764a2aaSMatthew G. Knepley PetscErrorCode PetscDSDestroy(PetscDS *prob) 4632764a2aaSMatthew G. Knepley { 4642764a2aaSMatthew G. Knepley PetscInt f; 46558ebd649SToby Isaac DSBoundary next; 4662764a2aaSMatthew G. Knepley PetscErrorCode ierr; 4672764a2aaSMatthew G. Knepley 4682764a2aaSMatthew G. Knepley PetscFunctionBegin; 4692764a2aaSMatthew G. Knepley if (!*prob) PetscFunctionReturn(0); 4702764a2aaSMatthew G. Knepley PetscValidHeaderSpecific((*prob), PETSCDS_CLASSID, 1); 4712764a2aaSMatthew G. Knepley 4722764a2aaSMatthew G. Knepley if (--((PetscObject)(*prob))->refct > 0) {*prob = 0; PetscFunctionReturn(0);} 4732764a2aaSMatthew G. Knepley ((PetscObject) (*prob))->refct = 0; 474df3a45bdSMatthew G. Knepley if ((*prob)->subprobs) { 475df3a45bdSMatthew G. Knepley PetscInt dim, d; 476df3a45bdSMatthew G. Knepley 477df3a45bdSMatthew G. Knepley ierr = PetscDSGetSpatialDimension(*prob, &dim);CHKERRQ(ierr); 478df3a45bdSMatthew G. Knepley for (d = 0; d < dim; ++d) {ierr = PetscDSDestroy(&(*prob)->subprobs[d]);CHKERRQ(ierr);} 479df3a45bdSMatthew G. Knepley } 480df3a45bdSMatthew G. Knepley ierr = PetscFree((*prob)->subprobs);CHKERRQ(ierr); 4812764a2aaSMatthew G. Knepley ierr = PetscDSDestroyStructs_Static(*prob);CHKERRQ(ierr); 4822764a2aaSMatthew G. Knepley for (f = 0; f < (*prob)->Nf; ++f) { 4832764a2aaSMatthew G. Knepley ierr = PetscObjectDereference((*prob)->disc[f]);CHKERRQ(ierr); 4842764a2aaSMatthew G. Knepley } 485f744cafaSSander Arens ierr = PetscFree3((*prob)->disc, (*prob)->implicit, (*prob)->adjacency);CHKERRQ(ierr); 486b7e05686SMatthew G. Knepley ierr = PetscFree7((*prob)->obj,(*prob)->f,(*prob)->g,(*prob)->gp,(*prob)->gt,(*prob)->r,(*prob)->ctx);CHKERRQ(ierr); 48732d2bbc9SMatthew G. Knepley ierr = PetscFree((*prob)->update);CHKERRQ(ierr); 488c371a6d1SMatthew G. Knepley ierr = PetscFree3((*prob)->fBd,(*prob)->gBd,(*prob)->exactSol);CHKERRQ(ierr); 4892764a2aaSMatthew G. Knepley if ((*prob)->ops->destroy) {ierr = (*(*prob)->ops->destroy)(*prob);CHKERRQ(ierr);} 49058ebd649SToby Isaac next = (*prob)->boundary; 49158ebd649SToby Isaac while (next) { 49258ebd649SToby Isaac DSBoundary b = next; 49358ebd649SToby Isaac 49458ebd649SToby Isaac next = b->next; 49558ebd649SToby Isaac ierr = PetscFree(b->comps);CHKERRQ(ierr); 49658ebd649SToby Isaac ierr = PetscFree(b->ids);CHKERRQ(ierr); 49758ebd649SToby Isaac ierr = PetscFree(b->name);CHKERRQ(ierr); 49858ebd649SToby Isaac ierr = PetscFree(b->labelname);CHKERRQ(ierr); 49958ebd649SToby Isaac ierr = PetscFree(b);CHKERRQ(ierr); 50058ebd649SToby Isaac } 50197b6e6e8SMatthew G. Knepley ierr = PetscFree((*prob)->constants);CHKERRQ(ierr); 5022764a2aaSMatthew G. Knepley ierr = PetscHeaderDestroy(prob);CHKERRQ(ierr); 5032764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 5042764a2aaSMatthew G. Knepley } 5052764a2aaSMatthew G. Knepley 5062764a2aaSMatthew G. Knepley /*@ 5072764a2aaSMatthew G. Knepley PetscDSCreate - Creates an empty PetscDS object. The type can then be set with PetscDSSetType(). 5082764a2aaSMatthew G. Knepley 5092764a2aaSMatthew G. Knepley Collective on MPI_Comm 5102764a2aaSMatthew G. Knepley 5112764a2aaSMatthew G. Knepley Input Parameter: 5122764a2aaSMatthew G. Knepley . comm - The communicator for the PetscDS object 5132764a2aaSMatthew G. Knepley 5142764a2aaSMatthew G. Knepley Output Parameter: 5152764a2aaSMatthew G. Knepley . prob - The PetscDS object 5162764a2aaSMatthew G. Knepley 5172764a2aaSMatthew G. Knepley Level: beginner 5182764a2aaSMatthew G. Knepley 5192764a2aaSMatthew G. Knepley .seealso: PetscDSSetType(), PETSCDSBASIC 5202764a2aaSMatthew G. Knepley @*/ 5212764a2aaSMatthew G. Knepley PetscErrorCode PetscDSCreate(MPI_Comm comm, PetscDS *prob) 5222764a2aaSMatthew G. Knepley { 5232764a2aaSMatthew G. Knepley PetscDS p; 5242764a2aaSMatthew G. Knepley PetscErrorCode ierr; 5252764a2aaSMatthew G. Knepley 5262764a2aaSMatthew G. Knepley PetscFunctionBegin; 5272764a2aaSMatthew G. Knepley PetscValidPointer(prob, 2); 5282764a2aaSMatthew G. Knepley *prob = NULL; 5292764a2aaSMatthew G. Knepley ierr = PetscDSInitializePackage();CHKERRQ(ierr); 5302764a2aaSMatthew G. Knepley 53173107ff1SLisandro Dalcin ierr = PetscHeaderCreate(p, PETSCDS_CLASSID, "PetscDS", "Discrete System", "PetscDS", comm, PetscDSDestroy, PetscDSView);CHKERRQ(ierr); 5322764a2aaSMatthew G. Knepley 5332764a2aaSMatthew G. Knepley p->Nf = 0; 5342764a2aaSMatthew G. Knepley p->setup = PETSC_FALSE; 53597b6e6e8SMatthew G. Knepley p->numConstants = 0; 53697b6e6e8SMatthew G. Knepley p->constants = NULL; 537a859676bSMatthew G. Knepley p->dimEmbed = -1; 53803d90f89SMatthew G. Knepley p->defaultAdj[0] = PETSC_FALSE; 53903d90f89SMatthew G. Knepley p->defaultAdj[1] = PETSC_TRUE; 54055c1f793SMatthew G. Knepley p->useJacPre = PETSC_TRUE; 5412764a2aaSMatthew G. Knepley 5422764a2aaSMatthew G. Knepley *prob = p; 5432764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 5442764a2aaSMatthew G. Knepley } 5452764a2aaSMatthew G. Knepley 546bc4ae4beSMatthew G. Knepley /*@ 547bc4ae4beSMatthew G. Knepley PetscDSGetNumFields - Returns the number of fields in the DS 548bc4ae4beSMatthew G. Knepley 549bc4ae4beSMatthew G. Knepley Not collective 550bc4ae4beSMatthew G. Knepley 551bc4ae4beSMatthew G. Knepley Input Parameter: 552bc4ae4beSMatthew G. Knepley . prob - The PetscDS object 553bc4ae4beSMatthew G. Knepley 554bc4ae4beSMatthew G. Knepley Output Parameter: 555bc4ae4beSMatthew G. Knepley . Nf - The number of fields 556bc4ae4beSMatthew G. Knepley 557bc4ae4beSMatthew G. Knepley Level: beginner 558bc4ae4beSMatthew G. Knepley 559bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetSpatialDimension(), PetscDSCreate() 560bc4ae4beSMatthew G. Knepley @*/ 5612764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetNumFields(PetscDS prob, PetscInt *Nf) 5622764a2aaSMatthew G. Knepley { 5632764a2aaSMatthew G. Knepley PetscFunctionBegin; 5642764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 5652764a2aaSMatthew G. Knepley PetscValidPointer(Nf, 2); 5662764a2aaSMatthew G. Knepley *Nf = prob->Nf; 5672764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 5682764a2aaSMatthew G. Knepley } 5692764a2aaSMatthew G. Knepley 570bc4ae4beSMatthew G. Knepley /*@ 571a859676bSMatthew G. Knepley PetscDSGetSpatialDimension - Returns the spatial dimension of the DS, meaning the topological dimension of the discretizations 572bc4ae4beSMatthew G. Knepley 573bc4ae4beSMatthew G. Knepley Not collective 574bc4ae4beSMatthew G. Knepley 575bc4ae4beSMatthew G. Knepley Input Parameter: 576bc4ae4beSMatthew G. Knepley . prob - The PetscDS object 577bc4ae4beSMatthew G. Knepley 578bc4ae4beSMatthew G. Knepley Output Parameter: 579bc4ae4beSMatthew G. Knepley . dim - The spatial dimension 580bc4ae4beSMatthew G. Knepley 581bc4ae4beSMatthew G. Knepley Level: beginner 582bc4ae4beSMatthew G. Knepley 583a859676bSMatthew G. Knepley .seealso: PetscDSGetCoordinateDimension(), PetscDSGetNumFields(), PetscDSCreate() 584bc4ae4beSMatthew G. Knepley @*/ 5852764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetSpatialDimension(PetscDS prob, PetscInt *dim) 5862764a2aaSMatthew G. Knepley { 5872764a2aaSMatthew G. Knepley PetscErrorCode ierr; 5882764a2aaSMatthew G. Knepley 5892764a2aaSMatthew G. Knepley PetscFunctionBegin; 5902764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 5912764a2aaSMatthew G. Knepley PetscValidPointer(dim, 2); 5922764a2aaSMatthew G. Knepley *dim = 0; 5939de99aefSMatthew G. Knepley if (prob->Nf) { 5949de99aefSMatthew G. Knepley PetscObject obj; 5959de99aefSMatthew G. Knepley PetscClassId id; 5969de99aefSMatthew G. Knepley 5979de99aefSMatthew G. Knepley ierr = PetscDSGetDiscretization(prob, 0, &obj);CHKERRQ(ierr); 5989de99aefSMatthew G. Knepley ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr); 5999de99aefSMatthew G. Knepley if (id == PETSCFE_CLASSID) {ierr = PetscFEGetSpatialDimension((PetscFE) obj, dim);CHKERRQ(ierr);} 6009de99aefSMatthew G. Knepley else if (id == PETSCFV_CLASSID) {ierr = PetscFVGetSpatialDimension((PetscFV) obj, dim);CHKERRQ(ierr);} 6019de99aefSMatthew G. Knepley else SETERRQ1(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Unknown discretization type for field %d", 0); 6029de99aefSMatthew G. Knepley } 6032764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 6042764a2aaSMatthew G. Knepley } 6052764a2aaSMatthew G. Knepley 606bc4ae4beSMatthew G. Knepley /*@ 607a859676bSMatthew G. Knepley PetscDSGetCoordinateDimension - Returns the coordinate dimension of the DS, meaning the dimension of the space into which the discretiaztions are embedded 608a859676bSMatthew G. Knepley 609a859676bSMatthew G. Knepley Not collective 610a859676bSMatthew G. Knepley 611a859676bSMatthew G. Knepley Input Parameter: 612a859676bSMatthew G. Knepley . prob - The PetscDS object 613a859676bSMatthew G. Knepley 614a859676bSMatthew G. Knepley Output Parameter: 615a859676bSMatthew G. Knepley . dimEmbed - The coordinate dimension 616a859676bSMatthew G. Knepley 617a859676bSMatthew G. Knepley Level: beginner 618a859676bSMatthew G. Knepley 619a859676bSMatthew G. Knepley .seealso: PetscDSSetCoordinateDimension(), PetscDSGetSpatialDimension(), PetscDSGetNumFields(), PetscDSCreate() 620a859676bSMatthew G. Knepley @*/ 621a859676bSMatthew G. Knepley PetscErrorCode PetscDSGetCoordinateDimension(PetscDS prob, PetscInt *dimEmbed) 622a859676bSMatthew G. Knepley { 623a859676bSMatthew G. Knepley PetscFunctionBegin; 624a859676bSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 625a859676bSMatthew G. Knepley PetscValidPointer(dimEmbed, 2); 626a859676bSMatthew G. Knepley if (prob->dimEmbed < 0) SETERRQ(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONGSTATE, "No coordinate dimension set for this DS"); 627a859676bSMatthew G. Knepley *dimEmbed = prob->dimEmbed; 628a859676bSMatthew G. Knepley PetscFunctionReturn(0); 629a859676bSMatthew G. Knepley } 630a859676bSMatthew G. Knepley 631a859676bSMatthew G. Knepley /*@ 632a859676bSMatthew G. Knepley PetscDSSetCoordinateDimension - Set the coordinate dimension of the DS, meaning the dimension of the space into which the discretiaztions are embedded 633a859676bSMatthew G. Knepley 634a859676bSMatthew G. Knepley Not collective 635a859676bSMatthew G. Knepley 636a859676bSMatthew G. Knepley Input Parameters: 637a859676bSMatthew G. Knepley + prob - The PetscDS object 638a859676bSMatthew G. Knepley - dimEmbed - The coordinate dimension 639a859676bSMatthew G. Knepley 640a859676bSMatthew G. Knepley Level: beginner 641a859676bSMatthew G. Knepley 642a859676bSMatthew G. Knepley .seealso: PetscDSGetCoordinateDimension(), PetscDSGetSpatialDimension(), PetscDSGetNumFields(), PetscDSCreate() 643a859676bSMatthew G. Knepley @*/ 644a859676bSMatthew G. Knepley PetscErrorCode PetscDSSetCoordinateDimension(PetscDS prob, PetscInt dimEmbed) 645a859676bSMatthew G. Knepley { 646a859676bSMatthew G. Knepley PetscFunctionBegin; 647a859676bSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 648a859676bSMatthew G. Knepley prob->dimEmbed = dimEmbed; 649a859676bSMatthew G. Knepley PetscFunctionReturn(0); 650a859676bSMatthew G. Knepley } 651a859676bSMatthew G. Knepley 652a859676bSMatthew G. Knepley /*@ 6538edf6225SMatthew G. Knepley PetscDSGetHybrid - Returns the flag for a hybrid (cohesive) cell 6548edf6225SMatthew G. Knepley 6558edf6225SMatthew G. Knepley Not collective 6568edf6225SMatthew G. Knepley 6578edf6225SMatthew G. Knepley Input Parameter: 6588edf6225SMatthew G. Knepley . prob - The PetscDS object 6598edf6225SMatthew G. Knepley 6608edf6225SMatthew G. Knepley Output Parameter: 6618edf6225SMatthew G. Knepley . isHybrid - The flag 6628edf6225SMatthew G. Knepley 6638edf6225SMatthew G. Knepley Level: developer 6648edf6225SMatthew G. Knepley 6658edf6225SMatthew G. Knepley .seealso: PetscDSSetHybrid(), PetscDSCreate() 6668edf6225SMatthew G. Knepley @*/ 6678edf6225SMatthew G. Knepley PetscErrorCode PetscDSGetHybrid(PetscDS prob, PetscBool *isHybrid) 6688edf6225SMatthew G. Knepley { 6698edf6225SMatthew G. Knepley PetscFunctionBegin; 6708edf6225SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 6718edf6225SMatthew G. Knepley PetscValidPointer(isHybrid, 2); 6728edf6225SMatthew G. Knepley *isHybrid = prob->isHybrid; 6738edf6225SMatthew G. Knepley PetscFunctionReturn(0); 6748edf6225SMatthew G. Knepley } 6758edf6225SMatthew G. Knepley 6768edf6225SMatthew G. Knepley /*@ 6778edf6225SMatthew G. Knepley PetscDSSetHybrid - Set the flag for a hybrid (cohesive) cell 6788edf6225SMatthew G. Knepley 6798edf6225SMatthew G. Knepley Not collective 6808edf6225SMatthew G. Knepley 6818edf6225SMatthew G. Knepley Input Parameters: 6828edf6225SMatthew G. Knepley + prob - The PetscDS object 6838edf6225SMatthew G. Knepley - isHybrid - The flag 6848edf6225SMatthew G. Knepley 6858edf6225SMatthew G. Knepley Level: developer 6868edf6225SMatthew G. Knepley 6878edf6225SMatthew G. Knepley .seealso: PetscDSGetHybrid(), PetscDSCreate() 6888edf6225SMatthew G. Knepley @*/ 6898edf6225SMatthew G. Knepley PetscErrorCode PetscDSSetHybrid(PetscDS prob, PetscBool isHybrid) 6908edf6225SMatthew G. Knepley { 6918edf6225SMatthew G. Knepley PetscFunctionBegin; 6928edf6225SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 6938edf6225SMatthew G. Knepley prob->isHybrid = isHybrid; 6948edf6225SMatthew G. Knepley PetscFunctionReturn(0); 6958edf6225SMatthew G. Knepley } 6968edf6225SMatthew G. Knepley 6978edf6225SMatthew G. Knepley /*@ 698bc4ae4beSMatthew G. Knepley PetscDSGetTotalDimension - Returns the total size of the approximation space for this system 699bc4ae4beSMatthew G. Knepley 700bc4ae4beSMatthew G. Knepley Not collective 701bc4ae4beSMatthew G. Knepley 702bc4ae4beSMatthew G. Knepley Input Parameter: 703bc4ae4beSMatthew G. Knepley . prob - The PetscDS object 704bc4ae4beSMatthew G. Knepley 705bc4ae4beSMatthew G. Knepley Output Parameter: 706bc4ae4beSMatthew G. Knepley . dim - The total problem dimension 707bc4ae4beSMatthew G. Knepley 708bc4ae4beSMatthew G. Knepley Level: beginner 709bc4ae4beSMatthew G. Knepley 710bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetNumFields(), PetscDSCreate() 711bc4ae4beSMatthew G. Knepley @*/ 7122764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetTotalDimension(PetscDS prob, PetscInt *dim) 7132764a2aaSMatthew G. Knepley { 7142764a2aaSMatthew G. Knepley PetscErrorCode ierr; 7152764a2aaSMatthew G. Knepley 7162764a2aaSMatthew G. Knepley PetscFunctionBegin; 7172764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 7182764a2aaSMatthew G. Knepley ierr = PetscDSSetUp(prob);CHKERRQ(ierr); 7192764a2aaSMatthew G. Knepley PetscValidPointer(dim, 2); 7202764a2aaSMatthew G. Knepley *dim = prob->totDim; 7212764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 7222764a2aaSMatthew G. Knepley } 7232764a2aaSMatthew G. Knepley 724bc4ae4beSMatthew G. Knepley /*@ 725bc4ae4beSMatthew G. Knepley PetscDSGetTotalComponents - Returns the total number of components in this system 726bc4ae4beSMatthew G. Knepley 727bc4ae4beSMatthew G. Knepley Not collective 728bc4ae4beSMatthew G. Knepley 729bc4ae4beSMatthew G. Knepley Input Parameter: 730bc4ae4beSMatthew G. Knepley . prob - The PetscDS object 731bc4ae4beSMatthew G. Knepley 732bc4ae4beSMatthew G. Knepley Output Parameter: 733bc4ae4beSMatthew G. Knepley . dim - The total number of components 734bc4ae4beSMatthew G. Knepley 735bc4ae4beSMatthew G. Knepley Level: beginner 736bc4ae4beSMatthew G. Knepley 737bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetNumFields(), PetscDSCreate() 738bc4ae4beSMatthew G. Knepley @*/ 7392764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetTotalComponents(PetscDS prob, PetscInt *Nc) 7402764a2aaSMatthew G. Knepley { 7412764a2aaSMatthew G. Knepley PetscErrorCode ierr; 7422764a2aaSMatthew G. Knepley 7432764a2aaSMatthew G. Knepley PetscFunctionBegin; 7442764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 7452764a2aaSMatthew G. Knepley ierr = PetscDSSetUp(prob);CHKERRQ(ierr); 7462764a2aaSMatthew G. Knepley PetscValidPointer(Nc, 2); 7472764a2aaSMatthew G. Knepley *Nc = prob->totComp; 7482764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 7492764a2aaSMatthew G. Knepley } 7502764a2aaSMatthew G. Knepley 751bc4ae4beSMatthew G. Knepley /*@ 752bc4ae4beSMatthew G. Knepley PetscDSGetDiscretization - Returns the discretization object for the given field 753bc4ae4beSMatthew G. Knepley 754bc4ae4beSMatthew G. Knepley Not collective 755bc4ae4beSMatthew G. Knepley 756bc4ae4beSMatthew G. Knepley Input Parameters: 757bc4ae4beSMatthew G. Knepley + prob - The PetscDS object 758bc4ae4beSMatthew G. Knepley - f - The field number 759bc4ae4beSMatthew G. Knepley 760bc4ae4beSMatthew G. Knepley Output Parameter: 761bc4ae4beSMatthew G. Knepley . disc - The discretization object 762bc4ae4beSMatthew G. Knepley 763bc4ae4beSMatthew G. Knepley Level: beginner 764bc4ae4beSMatthew G. Knepley 765f744cafaSSander Arens .seealso: PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate() 766bc4ae4beSMatthew G. Knepley @*/ 7672764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetDiscretization(PetscDS prob, PetscInt f, PetscObject *disc) 7682764a2aaSMatthew G. Knepley { 7692764a2aaSMatthew G. Knepley PetscFunctionBegin; 7702764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 7712764a2aaSMatthew G. Knepley PetscValidPointer(disc, 3); 7722764a2aaSMatthew 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); 7732764a2aaSMatthew G. Knepley *disc = prob->disc[f]; 7742764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 7752764a2aaSMatthew G. Knepley } 7762764a2aaSMatthew G. Knepley 777bc4ae4beSMatthew G. Knepley /*@ 778bc4ae4beSMatthew G. Knepley PetscDSSetDiscretization - Sets the discretization object for the given field 779bc4ae4beSMatthew G. Knepley 780bc4ae4beSMatthew G. Knepley Not collective 781bc4ae4beSMatthew G. Knepley 782bc4ae4beSMatthew G. Knepley Input Parameters: 783bc4ae4beSMatthew G. Knepley + prob - The PetscDS object 784bc4ae4beSMatthew G. Knepley . f - The field number 785bc4ae4beSMatthew G. Knepley - disc - The discretization object 786bc4ae4beSMatthew G. Knepley 787bc4ae4beSMatthew G. Knepley Level: beginner 788bc4ae4beSMatthew G. Knepley 789bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate() 790bc4ae4beSMatthew G. Knepley @*/ 7912764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetDiscretization(PetscDS prob, PetscInt f, PetscObject disc) 7922764a2aaSMatthew G. Knepley { 7932764a2aaSMatthew G. Knepley PetscErrorCode ierr; 7942764a2aaSMatthew G. Knepley 7952764a2aaSMatthew G. Knepley PetscFunctionBegin; 7962764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 7972764a2aaSMatthew G. Knepley PetscValidPointer(disc, 3); 7982764a2aaSMatthew G. Knepley if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f); 7992764a2aaSMatthew G. Knepley ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr); 8002764a2aaSMatthew G. Knepley if (prob->disc[f]) {ierr = PetscObjectDereference(prob->disc[f]);CHKERRQ(ierr);} 8012764a2aaSMatthew G. Knepley prob->disc[f] = disc; 8022764a2aaSMatthew G. Knepley ierr = PetscObjectReference(disc);CHKERRQ(ierr); 803249df284SMatthew G. Knepley { 804249df284SMatthew G. Knepley PetscClassId id; 805249df284SMatthew G. Knepley 806249df284SMatthew G. Knepley ierr = PetscObjectGetClassId(disc, &id);CHKERRQ(ierr); 8071cf84007SMatthew G. Knepley if (id == PETSCFE_CLASSID) { 8081cf84007SMatthew G. Knepley ierr = PetscDSSetImplicit(prob, f, PETSC_TRUE);CHKERRQ(ierr); 8091cf84007SMatthew G. Knepley ierr = PetscDSSetAdjacency(prob, f, PETSC_FALSE, PETSC_TRUE);CHKERRQ(ierr); 8101cf84007SMatthew G. Knepley } else if (id == PETSCFV_CLASSID) { 8111cf84007SMatthew G. Knepley ierr = PetscDSSetImplicit(prob, f, PETSC_FALSE);CHKERRQ(ierr); 8121cf84007SMatthew G. Knepley ierr = PetscDSSetAdjacency(prob, f, PETSC_TRUE, PETSC_FALSE);CHKERRQ(ierr); 813a6cbbb48SMatthew G. Knepley } 814249df284SMatthew G. Knepley } 8152764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 8162764a2aaSMatthew G. Knepley } 8172764a2aaSMatthew G. Knepley 818bc4ae4beSMatthew G. Knepley /*@ 819bc4ae4beSMatthew G. Knepley PetscDSAddDiscretization - Adds a discretization object 820bc4ae4beSMatthew G. Knepley 821bc4ae4beSMatthew G. Knepley Not collective 822bc4ae4beSMatthew G. Knepley 823bc4ae4beSMatthew G. Knepley Input Parameters: 824bc4ae4beSMatthew G. Knepley + prob - The PetscDS object 825bc4ae4beSMatthew G. Knepley - disc - The boundary discretization object 826bc4ae4beSMatthew G. Knepley 827bc4ae4beSMatthew G. Knepley Level: beginner 828bc4ae4beSMatthew G. Knepley 829bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetDiscretization(), PetscDSSetDiscretization(), PetscDSGetNumFields(), PetscDSCreate() 830bc4ae4beSMatthew G. Knepley @*/ 8312764a2aaSMatthew G. Knepley PetscErrorCode PetscDSAddDiscretization(PetscDS prob, PetscObject disc) 8322764a2aaSMatthew G. Knepley { 8332764a2aaSMatthew G. Knepley PetscErrorCode ierr; 8342764a2aaSMatthew G. Knepley 8352764a2aaSMatthew G. Knepley PetscFunctionBegin; 8362764a2aaSMatthew G. Knepley ierr = PetscDSSetDiscretization(prob, prob->Nf, disc);CHKERRQ(ierr); 8372764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 8382764a2aaSMatthew G. Knepley } 8392764a2aaSMatthew G. Knepley 840249df284SMatthew G. Knepley /*@ 841249df284SMatthew G. Knepley PetscDSGetImplicit - Returns the flag for implicit solve for this field. This is just a guide for IMEX 842249df284SMatthew G. Knepley 843249df284SMatthew G. Knepley Not collective 844249df284SMatthew G. Knepley 845249df284SMatthew G. Knepley Input Parameters: 846249df284SMatthew G. Knepley + prob - The PetscDS object 847249df284SMatthew G. Knepley - f - The field number 848249df284SMatthew G. Knepley 849249df284SMatthew G. Knepley Output Parameter: 850249df284SMatthew G. Knepley . implicit - The flag indicating what kind of solve to use for this field 851249df284SMatthew G. Knepley 852249df284SMatthew G. Knepley Level: developer 853249df284SMatthew G. Knepley 854f744cafaSSander Arens .seealso: PetscDSSetImplicit(), PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate() 855249df284SMatthew G. Knepley @*/ 856249df284SMatthew G. Knepley PetscErrorCode PetscDSGetImplicit(PetscDS prob, PetscInt f, PetscBool *implicit) 857249df284SMatthew G. Knepley { 858249df284SMatthew G. Knepley PetscFunctionBegin; 859249df284SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 860249df284SMatthew G. Knepley PetscValidPointer(implicit, 3); 861249df284SMatthew 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); 862249df284SMatthew G. Knepley *implicit = prob->implicit[f]; 863249df284SMatthew G. Knepley PetscFunctionReturn(0); 864249df284SMatthew G. Knepley } 865249df284SMatthew G. Knepley 866249df284SMatthew G. Knepley /*@ 867249df284SMatthew G. Knepley PetscDSSetImplicit - Set the flag for implicit solve for this field. This is just a guide for IMEX 868249df284SMatthew G. Knepley 869249df284SMatthew G. Knepley Not collective 870249df284SMatthew G. Knepley 871249df284SMatthew G. Knepley Input Parameters: 872249df284SMatthew G. Knepley + prob - The PetscDS object 873249df284SMatthew G. Knepley . f - The field number 874249df284SMatthew G. Knepley - implicit - The flag indicating what kind of solve to use for this field 875249df284SMatthew G. Knepley 876249df284SMatthew G. Knepley Level: developer 877249df284SMatthew G. Knepley 878f744cafaSSander Arens .seealso: PetscDSGetImplicit(), PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate() 879249df284SMatthew G. Knepley @*/ 880249df284SMatthew G. Knepley PetscErrorCode PetscDSSetImplicit(PetscDS prob, PetscInt f, PetscBool implicit) 881249df284SMatthew G. Knepley { 882249df284SMatthew G. Knepley PetscFunctionBegin; 883249df284SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 884249df284SMatthew 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); 885249df284SMatthew G. Knepley prob->implicit[f] = implicit; 886249df284SMatthew G. Knepley PetscFunctionReturn(0); 887249df284SMatthew G. Knepley } 888249df284SMatthew G. Knepley 889a6cbbb48SMatthew G. Knepley /*@ 890a6cbbb48SMatthew G. Knepley PetscDSGetAdjacency - Returns the flags for determining variable influence 891a6cbbb48SMatthew G. Knepley 892a6cbbb48SMatthew G. Knepley Not collective 893a6cbbb48SMatthew G. Knepley 894a6cbbb48SMatthew G. Knepley Input Parameters: 895a6cbbb48SMatthew G. Knepley + prob - The PetscDS object 896a6cbbb48SMatthew G. Knepley - f - The field number 897a6cbbb48SMatthew G. Knepley 898a6cbbb48SMatthew G. Knepley Output Parameter: 899a6cbbb48SMatthew G. Knepley + useCone - Flag for variable influence starting with the cone operation 900a6cbbb48SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure 901a6cbbb48SMatthew G. Knepley 902a6cbbb48SMatthew G. Knepley Note: See the discussion in DMPlexGetAdjacencyUseCone() and DMPlexGetAdjacencyUseClosure() 903a6cbbb48SMatthew G. Knepley 904a6cbbb48SMatthew G. Knepley Level: developer 905a6cbbb48SMatthew G. Knepley 906f744cafaSSander Arens .seealso: PetscDSSetAdjacency(), DMPlexGetAdjacencyUseCone(), DMPlexGetAdjacencyUseClosure(), PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate() 907a6cbbb48SMatthew G. Knepley @*/ 908a6cbbb48SMatthew G. Knepley PetscErrorCode PetscDSGetAdjacency(PetscDS prob, PetscInt f, PetscBool *useCone, PetscBool *useClosure) 909a6cbbb48SMatthew G. Knepley { 910a6cbbb48SMatthew G. Knepley PetscFunctionBegin; 911a6cbbb48SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 9121cf84007SMatthew G. Knepley if (useCone) PetscValidPointer(useCone, 3); 9131cf84007SMatthew G. Knepley if (useClosure) PetscValidPointer(useClosure, 4); 91406cc46feSMatthew G. Knepley if (f < 0) { 91506cc46feSMatthew G. Knepley if (useCone) *useCone = prob->defaultAdj[0]; 91606cc46feSMatthew G. Knepley if (useClosure) *useClosure = prob->defaultAdj[1]; 91706cc46feSMatthew G. Knepley } else { 91806cc46feSMatthew G. Knepley if (f >= prob->Nf) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, prob->Nf); 9191cf84007SMatthew G. Knepley if (useCone) *useCone = prob->adjacency[f*2+0]; 9201cf84007SMatthew G. Knepley if (useClosure) *useClosure = prob->adjacency[f*2+1]; 92106cc46feSMatthew G. Knepley } 922a6cbbb48SMatthew G. Knepley PetscFunctionReturn(0); 923a6cbbb48SMatthew G. Knepley } 924a6cbbb48SMatthew G. Knepley 925a6cbbb48SMatthew G. Knepley /*@ 926a6cbbb48SMatthew G. Knepley PetscDSSetAdjacency - Set the flags for determining variable influence 927a6cbbb48SMatthew G. Knepley 928a6cbbb48SMatthew G. Knepley Not collective 929a6cbbb48SMatthew G. Knepley 930a6cbbb48SMatthew G. Knepley Input Parameters: 931a6cbbb48SMatthew G. Knepley + prob - The PetscDS object 932a6cbbb48SMatthew G. Knepley . f - The field number 933a6cbbb48SMatthew G. Knepley . useCone - Flag for variable influence starting with the cone operation 934a6cbbb48SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure 935a6cbbb48SMatthew G. Knepley 936a6cbbb48SMatthew G. Knepley Note: See the discussion in DMPlexGetAdjacencyUseCone() and DMPlexGetAdjacencyUseClosure() 937a6cbbb48SMatthew G. Knepley 938a6cbbb48SMatthew G. Knepley Level: developer 939a6cbbb48SMatthew G. Knepley 940f744cafaSSander Arens .seealso: PetscDSGetAdjacency(), DMPlexGetAdjacencyUseCone(), DMPlexGetAdjacencyUseClosure(), PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate() 941a6cbbb48SMatthew G. Knepley @*/ 942a6cbbb48SMatthew G. Knepley PetscErrorCode PetscDSSetAdjacency(PetscDS prob, PetscInt f, PetscBool useCone, PetscBool useClosure) 943a6cbbb48SMatthew G. Knepley { 944a6cbbb48SMatthew G. Knepley PetscFunctionBegin; 945a6cbbb48SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 94606cc46feSMatthew G. Knepley if (f < 0) { 94706cc46feSMatthew G. Knepley prob->defaultAdj[0] = useCone; 94806cc46feSMatthew G. Knepley prob->defaultAdj[1] = useClosure; 94906cc46feSMatthew G. Knepley } else { 95006cc46feSMatthew G. Knepley if (f >= prob->Nf) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, prob->Nf); 951a6cbbb48SMatthew G. Knepley prob->adjacency[f*2+0] = useCone; 952a6cbbb48SMatthew G. Knepley prob->adjacency[f*2+1] = useClosure; 95306cc46feSMatthew G. Knepley } 954a6cbbb48SMatthew G. Knepley PetscFunctionReturn(0); 955a6cbbb48SMatthew G. Knepley } 956a6cbbb48SMatthew G. Knepley 9572764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetObjective(PetscDS prob, PetscInt f, 95830b9ff8bSMatthew G. Knepley void (**obj)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 959194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 960194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 96197b6e6e8SMatthew G. Knepley PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar obj[])) 9622764a2aaSMatthew G. Knepley { 9632764a2aaSMatthew G. Knepley PetscFunctionBegin; 9642764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 9652764a2aaSMatthew G. Knepley PetscValidPointer(obj, 2); 9662764a2aaSMatthew 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); 9672764a2aaSMatthew G. Knepley *obj = prob->obj[f]; 9682764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 9692764a2aaSMatthew G. Knepley } 9702764a2aaSMatthew G. Knepley 9712764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetObjective(PetscDS prob, PetscInt f, 97230b9ff8bSMatthew G. Knepley void (*obj)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 973194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 974194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 97597b6e6e8SMatthew G. Knepley PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar obj[])) 9762764a2aaSMatthew G. Knepley { 9772764a2aaSMatthew G. Knepley PetscErrorCode ierr; 9782764a2aaSMatthew G. Knepley 9792764a2aaSMatthew G. Knepley PetscFunctionBegin; 9802764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 981de716cbcSToby Isaac if (obj) PetscValidFunction(obj, 2); 9822764a2aaSMatthew G. Knepley if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f); 9832764a2aaSMatthew G. Knepley ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr); 9842764a2aaSMatthew G. Knepley prob->obj[f] = obj; 9852764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 9862764a2aaSMatthew G. Knepley } 9872764a2aaSMatthew G. Knepley 988194d53e6SMatthew G. Knepley /*@C 989194d53e6SMatthew G. Knepley PetscDSGetResidual - Get the pointwise residual function for a given test field 990194d53e6SMatthew G. Knepley 991194d53e6SMatthew G. Knepley Not collective 992194d53e6SMatthew G. Knepley 993194d53e6SMatthew G. Knepley Input Parameters: 994194d53e6SMatthew G. Knepley + prob - The PetscDS 995194d53e6SMatthew G. Knepley - f - The test field number 996194d53e6SMatthew G. Knepley 997194d53e6SMatthew G. Knepley Output Parameters: 998194d53e6SMatthew G. Knepley + f0 - integrand for the test function term 999194d53e6SMatthew G. Knepley - f1 - integrand for the test function gradient term 1000194d53e6SMatthew G. Knepley 1001194d53e6SMatthew G. Knepley Note: We are using a first order FEM model for the weak form: 1002194d53e6SMatthew G. Knepley 1003194d53e6SMatthew 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) 1004194d53e6SMatthew G. Knepley 1005194d53e6SMatthew G. Knepley The calling sequence for the callbacks f0 and f1 is given by: 1006194d53e6SMatthew G. Knepley 100730b9ff8bSMatthew G. Knepley $ f0(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1008194d53e6SMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1009194d53e6SMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 101030b9ff8bSMatthew G. Knepley $ PetscReal t, const PetscReal x[], PetscScalar f0[]) 1011194d53e6SMatthew G. Knepley 1012194d53e6SMatthew G. Knepley + dim - the spatial dimension 1013194d53e6SMatthew G. Knepley . Nf - the number of fields 1014194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 1015194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 1016194d53e6SMatthew G. Knepley . u - each field evaluated at the current point 1017194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 1018194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 1019194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 1020194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 1021194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 1022194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 1023194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 1024194d53e6SMatthew G. Knepley . t - current time 1025194d53e6SMatthew G. Knepley . x - coordinates of the current point 102697b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters 102797b6e6e8SMatthew G. Knepley . constants - constant parameters 1028194d53e6SMatthew G. Knepley - f0 - output values at the current point 1029194d53e6SMatthew G. Knepley 1030194d53e6SMatthew G. Knepley Level: intermediate 1031194d53e6SMatthew G. Knepley 1032194d53e6SMatthew G. Knepley .seealso: PetscDSSetResidual() 1033194d53e6SMatthew G. Knepley @*/ 10342764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetResidual(PetscDS prob, PetscInt f, 103530b9ff8bSMatthew G. Knepley void (**f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1036194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1037194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 103897b6e6e8SMatthew G. Knepley PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f0[]), 103930b9ff8bSMatthew G. Knepley void (**f1)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1040194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1041194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 104297b6e6e8SMatthew G. Knepley PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f1[])) 10432764a2aaSMatthew G. Knepley { 10442764a2aaSMatthew G. Knepley PetscFunctionBegin; 10452764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 10462764a2aaSMatthew 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); 10472764a2aaSMatthew G. Knepley if (f0) {PetscValidPointer(f0, 3); *f0 = prob->f[f*2+0];} 10482764a2aaSMatthew G. Knepley if (f1) {PetscValidPointer(f1, 4); *f1 = prob->f[f*2+1];} 10492764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 10502764a2aaSMatthew G. Knepley } 10512764a2aaSMatthew G. Knepley 1052194d53e6SMatthew G. Knepley /*@C 1053194d53e6SMatthew G. Knepley PetscDSSetResidual - Set the pointwise residual function for a given test field 1054194d53e6SMatthew G. Knepley 1055194d53e6SMatthew G. Knepley Not collective 1056194d53e6SMatthew G. Knepley 1057194d53e6SMatthew G. Knepley Input Parameters: 1058194d53e6SMatthew G. Knepley + prob - The PetscDS 1059194d53e6SMatthew G. Knepley . f - The test field number 1060194d53e6SMatthew G. Knepley . f0 - integrand for the test function term 1061194d53e6SMatthew G. Knepley - f1 - integrand for the test function gradient term 1062194d53e6SMatthew G. Knepley 1063194d53e6SMatthew G. Knepley Note: We are using a first order FEM model for the weak form: 1064194d53e6SMatthew G. Knepley 1065194d53e6SMatthew 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) 1066194d53e6SMatthew G. Knepley 1067194d53e6SMatthew G. Knepley The calling sequence for the callbacks f0 and f1 is given by: 1068194d53e6SMatthew G. Knepley 106930b9ff8bSMatthew G. Knepley $ f0(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1070194d53e6SMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1071194d53e6SMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 107230b9ff8bSMatthew G. Knepley $ PetscReal t, const PetscReal x[], PetscScalar f0[]) 1073194d53e6SMatthew G. Knepley 1074194d53e6SMatthew G. Knepley + dim - the spatial dimension 1075194d53e6SMatthew G. Knepley . Nf - the number of fields 1076194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 1077194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 1078194d53e6SMatthew G. Knepley . u - each field evaluated at the current point 1079194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 1080194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 1081194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 1082194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 1083194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 1084194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 1085194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 1086194d53e6SMatthew G. Knepley . t - current time 1087194d53e6SMatthew G. Knepley . x - coordinates of the current point 108897b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters 108997b6e6e8SMatthew G. Knepley . constants - constant parameters 1090194d53e6SMatthew G. Knepley - f0 - output values at the current point 1091194d53e6SMatthew G. Knepley 1092194d53e6SMatthew G. Knepley Level: intermediate 1093194d53e6SMatthew G. Knepley 1094194d53e6SMatthew G. Knepley .seealso: PetscDSGetResidual() 1095194d53e6SMatthew G. Knepley @*/ 10962764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetResidual(PetscDS prob, PetscInt f, 109730b9ff8bSMatthew G. Knepley void (*f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1098194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1099194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 110097b6e6e8SMatthew G. Knepley PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f0[]), 110130b9ff8bSMatthew G. Knepley void (*f1)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1102194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1103194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 110497b6e6e8SMatthew G. Knepley PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f1[])) 11052764a2aaSMatthew G. Knepley { 11062764a2aaSMatthew G. Knepley PetscErrorCode ierr; 11072764a2aaSMatthew G. Knepley 11082764a2aaSMatthew G. Knepley PetscFunctionBegin; 11092764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 1110f866a1d0SMatthew G. Knepley if (f0) PetscValidFunction(f0, 3); 1111f866a1d0SMatthew G. Knepley if (f1) PetscValidFunction(f1, 4); 11122764a2aaSMatthew G. Knepley if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f); 11132764a2aaSMatthew G. Knepley ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr); 11142764a2aaSMatthew G. Knepley prob->f[f*2+0] = f0; 11152764a2aaSMatthew G. Knepley prob->f[f*2+1] = f1; 11162764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 11172764a2aaSMatthew G. Knepley } 11182764a2aaSMatthew G. Knepley 11193e75805dSMatthew G. Knepley /*@C 11203e75805dSMatthew G. Knepley PetscDSHasJacobian - Signals that Jacobian functions have been set 11213e75805dSMatthew G. Knepley 11223e75805dSMatthew G. Knepley Not collective 11233e75805dSMatthew G. Knepley 11243e75805dSMatthew G. Knepley Input Parameter: 11253e75805dSMatthew G. Knepley . prob - The PetscDS 11263e75805dSMatthew G. Knepley 11273e75805dSMatthew G. Knepley Output Parameter: 11283e75805dSMatthew G. Knepley . hasJac - flag that pointwise function for the Jacobian has been set 11293e75805dSMatthew G. Knepley 11303e75805dSMatthew G. Knepley Level: intermediate 11313e75805dSMatthew G. Knepley 11323e75805dSMatthew G. Knepley .seealso: PetscDSGetJacobianPreconditioner(), PetscDSSetJacobianPreconditioner(), PetscDSGetJacobian() 11333e75805dSMatthew G. Knepley @*/ 11343e75805dSMatthew G. Knepley PetscErrorCode PetscDSHasJacobian(PetscDS prob, PetscBool *hasJac) 11353e75805dSMatthew G. Knepley { 11363e75805dSMatthew G. Knepley PetscInt f, g, h; 11373e75805dSMatthew G. Knepley 11383e75805dSMatthew G. Knepley PetscFunctionBegin; 11393e75805dSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 11403e75805dSMatthew G. Knepley *hasJac = PETSC_FALSE; 11413e75805dSMatthew G. Knepley for (f = 0; f < prob->Nf; ++f) { 11423e75805dSMatthew G. Knepley for (g = 0; g < prob->Nf; ++g) { 11433e75805dSMatthew G. Knepley for (h = 0; h < 4; ++h) { 11443e75805dSMatthew G. Knepley if (prob->g[(f*prob->Nf + g)*4+h]) *hasJac = PETSC_TRUE; 11453e75805dSMatthew G. Knepley } 11463e75805dSMatthew G. Knepley } 11473e75805dSMatthew G. Knepley } 11483e75805dSMatthew G. Knepley PetscFunctionReturn(0); 11493e75805dSMatthew G. Knepley } 11503e75805dSMatthew G. Knepley 1151194d53e6SMatthew G. Knepley /*@C 1152194d53e6SMatthew G. Knepley PetscDSGetJacobian - Get the pointwise Jacobian function for given test and basis field 1153194d53e6SMatthew G. Knepley 1154194d53e6SMatthew G. Knepley Not collective 1155194d53e6SMatthew G. Knepley 1156194d53e6SMatthew G. Knepley Input Parameters: 1157194d53e6SMatthew G. Knepley + prob - The PetscDS 1158194d53e6SMatthew G. Knepley . f - The test field number 1159194d53e6SMatthew G. Knepley - g - The field number 1160194d53e6SMatthew G. Knepley 1161194d53e6SMatthew G. Knepley Output Parameters: 1162194d53e6SMatthew G. Knepley + g0 - integrand for the test and basis function term 1163194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term 1164194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term 1165194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term 1166194d53e6SMatthew G. Knepley 1167194d53e6SMatthew G. Knepley Note: We are using a first order FEM model for the weak form: 1168194d53e6SMatthew G. Knepley 1169194d53e6SMatthew 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 1170194d53e6SMatthew G. Knepley 1171194d53e6SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by: 1172194d53e6SMatthew G. Knepley 117330b9ff8bSMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1174194d53e6SMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1175194d53e6SMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 117630b9ff8bSMatthew G. Knepley $ PetscReal t, const PetscReal u_tShift, const PetscReal x[], PetscScalar g0[]) 1177194d53e6SMatthew G. Knepley 1178194d53e6SMatthew G. Knepley + dim - the spatial dimension 1179194d53e6SMatthew G. Knepley . Nf - the number of fields 1180194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 1181194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 1182194d53e6SMatthew G. Knepley . u - each field evaluated at the current point 1183194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 1184194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 1185194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 1186194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 1187194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 1188194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 1189194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 1190194d53e6SMatthew G. Knepley . t - current time 11912aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t 1192194d53e6SMatthew G. Knepley . x - coordinates of the current point 119397b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters 119497b6e6e8SMatthew G. Knepley . constants - constant parameters 1195194d53e6SMatthew G. Knepley - g0 - output values at the current point 1196194d53e6SMatthew G. Knepley 1197194d53e6SMatthew G. Knepley Level: intermediate 1198194d53e6SMatthew G. Knepley 1199194d53e6SMatthew G. Knepley .seealso: PetscDSSetJacobian() 1200194d53e6SMatthew G. Knepley @*/ 12012764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetJacobian(PetscDS prob, PetscInt f, PetscInt g, 120230b9ff8bSMatthew G. Knepley void (**g0)(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 g0[]), 120630b9ff8bSMatthew G. Knepley void (**g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1207194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1208194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 120997b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]), 121030b9ff8bSMatthew G. Knepley void (**g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1211194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1212194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 121397b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]), 121430b9ff8bSMatthew G. Knepley void (**g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1215194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1216194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 121797b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[])) 12182764a2aaSMatthew G. Knepley { 12192764a2aaSMatthew G. Knepley PetscFunctionBegin; 12202764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 12212764a2aaSMatthew 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); 12222764a2aaSMatthew 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); 12232764a2aaSMatthew G. Knepley if (g0) {PetscValidPointer(g0, 4); *g0 = prob->g[(f*prob->Nf + g)*4+0];} 12242764a2aaSMatthew G. Knepley if (g1) {PetscValidPointer(g1, 5); *g1 = prob->g[(f*prob->Nf + g)*4+1];} 12252764a2aaSMatthew G. Knepley if (g2) {PetscValidPointer(g2, 6); *g2 = prob->g[(f*prob->Nf + g)*4+2];} 12262764a2aaSMatthew G. Knepley if (g3) {PetscValidPointer(g3, 7); *g3 = prob->g[(f*prob->Nf + g)*4+3];} 12272764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 12282764a2aaSMatthew G. Knepley } 12292764a2aaSMatthew G. Knepley 1230194d53e6SMatthew G. Knepley /*@C 1231194d53e6SMatthew G. Knepley PetscDSSetJacobian - Set the pointwise Jacobian function for given test and basis fields 1232194d53e6SMatthew G. Knepley 1233194d53e6SMatthew G. Knepley Not collective 1234194d53e6SMatthew G. Knepley 1235194d53e6SMatthew G. Knepley Input Parameters: 1236194d53e6SMatthew G. Knepley + prob - The PetscDS 1237194d53e6SMatthew G. Knepley . f - The test field number 1238194d53e6SMatthew G. Knepley . g - The field number 1239194d53e6SMatthew G. Knepley . g0 - integrand for the test and basis function term 1240194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term 1241194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term 1242194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term 1243194d53e6SMatthew G. Knepley 1244194d53e6SMatthew G. Knepley Note: We are using a first order FEM model for the weak form: 1245194d53e6SMatthew G. Knepley 1246194d53e6SMatthew 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 1247194d53e6SMatthew G. Knepley 1248194d53e6SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by: 1249194d53e6SMatthew G. Knepley 125030b9ff8bSMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1251194d53e6SMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1252194d53e6SMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 125330b9ff8bSMatthew G. Knepley $ PetscReal t, const PetscReal x[], PetscScalar g0[]) 1254194d53e6SMatthew G. Knepley 1255194d53e6SMatthew G. Knepley + dim - the spatial dimension 1256194d53e6SMatthew G. Knepley . Nf - the number of fields 1257194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 1258194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 1259194d53e6SMatthew G. Knepley . u - each field evaluated at the current point 1260194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 1261194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 1262194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 1263194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 1264194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 1265194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 1266194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 1267194d53e6SMatthew G. Knepley . t - current time 12682aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t 1269194d53e6SMatthew G. Knepley . x - coordinates of the current point 127097b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters 127197b6e6e8SMatthew G. Knepley . constants - constant parameters 1272194d53e6SMatthew G. Knepley - g0 - output values at the current point 1273194d53e6SMatthew G. Knepley 1274194d53e6SMatthew G. Knepley Level: intermediate 1275194d53e6SMatthew G. Knepley 1276194d53e6SMatthew G. Knepley .seealso: PetscDSGetJacobian() 1277194d53e6SMatthew G. Knepley @*/ 12782764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetJacobian(PetscDS prob, PetscInt f, PetscInt g, 127930b9ff8bSMatthew G. Knepley void (*g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1280194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1281194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 128297b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]), 128330b9ff8bSMatthew G. Knepley void (*g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1284194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1285194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 128697b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]), 128730b9ff8bSMatthew G. Knepley void (*g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1288194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1289194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 129097b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]), 129130b9ff8bSMatthew G. Knepley void (*g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1292194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1293194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 129497b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[])) 12952764a2aaSMatthew G. Knepley { 12962764a2aaSMatthew G. Knepley PetscErrorCode ierr; 12972764a2aaSMatthew G. Knepley 12982764a2aaSMatthew G. Knepley PetscFunctionBegin; 12992764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 13002764a2aaSMatthew G. Knepley if (g0) PetscValidFunction(g0, 4); 13012764a2aaSMatthew G. Knepley if (g1) PetscValidFunction(g1, 5); 13022764a2aaSMatthew G. Knepley if (g2) PetscValidFunction(g2, 6); 13032764a2aaSMatthew G. Knepley if (g3) PetscValidFunction(g3, 7); 13042764a2aaSMatthew G. Knepley if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f); 13052764a2aaSMatthew G. Knepley if (g < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", g); 13062764a2aaSMatthew G. Knepley ierr = PetscDSEnlarge_Static(prob, PetscMax(f, g)+1);CHKERRQ(ierr); 13072764a2aaSMatthew G. Knepley prob->g[(f*prob->Nf + g)*4+0] = g0; 13082764a2aaSMatthew G. Knepley prob->g[(f*prob->Nf + g)*4+1] = g1; 13092764a2aaSMatthew G. Knepley prob->g[(f*prob->Nf + g)*4+2] = g2; 13102764a2aaSMatthew G. Knepley prob->g[(f*prob->Nf + g)*4+3] = g3; 13112764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 13122764a2aaSMatthew G. Knepley } 13132764a2aaSMatthew G. Knepley 1314475e0ac9SMatthew G. Knepley /*@C 131555c1f793SMatthew G. Knepley PetscDSUseJacobianPreconditioner - Whether to construct a Jacobian preconditioner 131655c1f793SMatthew G. Knepley 131755c1f793SMatthew G. Knepley Not collective 131855c1f793SMatthew G. Knepley 131955c1f793SMatthew G. Knepley Input Parameters: 132055c1f793SMatthew G. Knepley + prob - The PetscDS 132155c1f793SMatthew G. Knepley - useJacPre - flag that enables construction of a Jacobian preconditioner 132255c1f793SMatthew G. Knepley 132355c1f793SMatthew G. Knepley Level: intermediate 132455c1f793SMatthew G. Knepley 132555c1f793SMatthew G. Knepley .seealso: PetscDSGetJacobianPreconditioner(), PetscDSSetJacobianPreconditioner(), PetscDSGetJacobian() 132655c1f793SMatthew G. Knepley @*/ 132755c1f793SMatthew G. Knepley PetscErrorCode PetscDSUseJacobianPreconditioner(PetscDS prob, PetscBool useJacPre) 132855c1f793SMatthew G. Knepley { 132955c1f793SMatthew G. Knepley PetscFunctionBegin; 133055c1f793SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 133155c1f793SMatthew G. Knepley prob->useJacPre = useJacPre; 133255c1f793SMatthew G. Knepley PetscFunctionReturn(0); 133355c1f793SMatthew G. Knepley } 133455c1f793SMatthew G. Knepley 133555c1f793SMatthew G. Knepley /*@C 1336475e0ac9SMatthew G. Knepley PetscDSHasJacobianPreconditioner - Signals that a Jacobian preconditioner matrix has been set 1337475e0ac9SMatthew G. Knepley 1338475e0ac9SMatthew G. Knepley Not collective 1339475e0ac9SMatthew G. Knepley 1340475e0ac9SMatthew G. Knepley Input Parameter: 1341475e0ac9SMatthew G. Knepley . prob - The PetscDS 1342475e0ac9SMatthew G. Knepley 1343475e0ac9SMatthew G. Knepley Output Parameter: 1344475e0ac9SMatthew G. Knepley . hasJacPre - flag that pointwise function for Jacobian preconditioner matrix has been set 1345475e0ac9SMatthew G. Knepley 1346475e0ac9SMatthew G. Knepley Level: intermediate 1347475e0ac9SMatthew G. Knepley 1348475e0ac9SMatthew G. Knepley .seealso: PetscDSGetJacobianPreconditioner(), PetscDSSetJacobianPreconditioner(), PetscDSGetJacobian() 1349475e0ac9SMatthew G. Knepley @*/ 1350475e0ac9SMatthew G. Knepley PetscErrorCode PetscDSHasJacobianPreconditioner(PetscDS prob, PetscBool *hasJacPre) 1351475e0ac9SMatthew G. Knepley { 1352475e0ac9SMatthew G. Knepley PetscInt f, g, h; 1353475e0ac9SMatthew G. Knepley 1354475e0ac9SMatthew G. Knepley PetscFunctionBegin; 1355475e0ac9SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 1356475e0ac9SMatthew G. Knepley *hasJacPre = PETSC_FALSE; 135755c1f793SMatthew G. Knepley if (!prob->useJacPre) PetscFunctionReturn(0); 1358475e0ac9SMatthew G. Knepley for (f = 0; f < prob->Nf; ++f) { 1359475e0ac9SMatthew G. Knepley for (g = 0; g < prob->Nf; ++g) { 1360475e0ac9SMatthew G. Knepley for (h = 0; h < 4; ++h) { 1361475e0ac9SMatthew G. Knepley if (prob->gp[(f*prob->Nf + g)*4+h]) *hasJacPre = PETSC_TRUE; 1362475e0ac9SMatthew G. Knepley } 1363475e0ac9SMatthew G. Knepley } 1364475e0ac9SMatthew G. Knepley } 1365475e0ac9SMatthew G. Knepley PetscFunctionReturn(0); 1366475e0ac9SMatthew G. Knepley } 1367475e0ac9SMatthew G. Knepley 1368475e0ac9SMatthew G. Knepley /*@C 1369475e0ac9SMatthew 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. 1370475e0ac9SMatthew G. Knepley 1371475e0ac9SMatthew G. Knepley Not collective 1372475e0ac9SMatthew G. Knepley 1373475e0ac9SMatthew G. Knepley Input Parameters: 1374475e0ac9SMatthew G. Knepley + prob - The PetscDS 1375475e0ac9SMatthew G. Knepley . f - The test field number 1376475e0ac9SMatthew G. Knepley - g - The field number 1377475e0ac9SMatthew G. Knepley 1378475e0ac9SMatthew G. Knepley Output Parameters: 1379475e0ac9SMatthew G. Knepley + g0 - integrand for the test and basis function term 1380475e0ac9SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term 1381475e0ac9SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term 1382475e0ac9SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term 1383475e0ac9SMatthew G. Knepley 1384475e0ac9SMatthew G. Knepley Note: We are using a first order FEM model for the weak form: 1385475e0ac9SMatthew G. Knepley 1386475e0ac9SMatthew 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 1387475e0ac9SMatthew G. Knepley 1388475e0ac9SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by: 1389475e0ac9SMatthew G. Knepley 1390475e0ac9SMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1391475e0ac9SMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1392475e0ac9SMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 1393475e0ac9SMatthew G. Knepley $ PetscReal t, const PetscReal u_tShift, const PetscReal x[], PetscScalar g0[]) 1394475e0ac9SMatthew G. Knepley 1395475e0ac9SMatthew G. Knepley + dim - the spatial dimension 1396475e0ac9SMatthew G. Knepley . Nf - the number of fields 1397475e0ac9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 1398475e0ac9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 1399475e0ac9SMatthew G. Knepley . u - each field evaluated at the current point 1400475e0ac9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 1401475e0ac9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 1402475e0ac9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 1403475e0ac9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 1404475e0ac9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 1405475e0ac9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 1406475e0ac9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 1407475e0ac9SMatthew G. Knepley . t - current time 1408475e0ac9SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t 1409475e0ac9SMatthew G. Knepley . x - coordinates of the current point 141097b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters 141197b6e6e8SMatthew G. Knepley . constants - constant parameters 1412475e0ac9SMatthew G. Knepley - g0 - output values at the current point 1413475e0ac9SMatthew G. Knepley 1414475e0ac9SMatthew G. Knepley Level: intermediate 1415475e0ac9SMatthew G. Knepley 1416475e0ac9SMatthew G. Knepley .seealso: PetscDSSetJacobianPreconditioner(), PetscDSGetJacobian() 1417475e0ac9SMatthew G. Knepley @*/ 1418475e0ac9SMatthew G. Knepley PetscErrorCode PetscDSGetJacobianPreconditioner(PetscDS prob, PetscInt f, PetscInt g, 1419475e0ac9SMatthew G. Knepley void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1420475e0ac9SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1421475e0ac9SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 142297b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]), 1423475e0ac9SMatthew G. Knepley void (**g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1424475e0ac9SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1425475e0ac9SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 142697b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]), 1427475e0ac9SMatthew G. Knepley void (**g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1428475e0ac9SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1429475e0ac9SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 143097b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]), 1431475e0ac9SMatthew G. Knepley void (**g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1432475e0ac9SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1433475e0ac9SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 143497b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[])) 1435475e0ac9SMatthew G. Knepley { 1436475e0ac9SMatthew G. Knepley PetscFunctionBegin; 1437475e0ac9SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 1438475e0ac9SMatthew 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); 1439475e0ac9SMatthew 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); 1440475e0ac9SMatthew G. Knepley if (g0) {PetscValidPointer(g0, 4); *g0 = prob->gp[(f*prob->Nf + g)*4+0];} 1441475e0ac9SMatthew G. Knepley if (g1) {PetscValidPointer(g1, 5); *g1 = prob->gp[(f*prob->Nf + g)*4+1];} 1442475e0ac9SMatthew G. Knepley if (g2) {PetscValidPointer(g2, 6); *g2 = prob->gp[(f*prob->Nf + g)*4+2];} 1443475e0ac9SMatthew G. Knepley if (g3) {PetscValidPointer(g3, 7); *g3 = prob->gp[(f*prob->Nf + g)*4+3];} 1444475e0ac9SMatthew G. Knepley PetscFunctionReturn(0); 1445475e0ac9SMatthew G. Knepley } 1446475e0ac9SMatthew G. Knepley 1447475e0ac9SMatthew G. Knepley /*@C 1448475e0ac9SMatthew 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. 1449475e0ac9SMatthew G. Knepley 1450475e0ac9SMatthew G. Knepley Not collective 1451475e0ac9SMatthew G. Knepley 1452475e0ac9SMatthew G. Knepley Input Parameters: 1453475e0ac9SMatthew G. Knepley + prob - The PetscDS 1454475e0ac9SMatthew G. Knepley . f - The test field number 1455475e0ac9SMatthew G. Knepley . g - The field number 1456475e0ac9SMatthew G. Knepley . g0 - integrand for the test and basis function term 1457475e0ac9SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term 1458475e0ac9SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term 1459475e0ac9SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term 1460475e0ac9SMatthew G. Knepley 1461475e0ac9SMatthew G. Knepley Note: We are using a first order FEM model for the weak form: 1462475e0ac9SMatthew G. Knepley 1463475e0ac9SMatthew 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 1464475e0ac9SMatthew G. Knepley 1465475e0ac9SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by: 1466475e0ac9SMatthew G. Knepley 1467475e0ac9SMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1468475e0ac9SMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1469475e0ac9SMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 1470475e0ac9SMatthew G. Knepley $ PetscReal t, const PetscReal x[], PetscScalar g0[]) 1471475e0ac9SMatthew G. Knepley 1472475e0ac9SMatthew G. Knepley + dim - the spatial dimension 1473475e0ac9SMatthew G. Knepley . Nf - the number of fields 1474475e0ac9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 1475475e0ac9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 1476475e0ac9SMatthew G. Knepley . u - each field evaluated at the current point 1477475e0ac9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 1478475e0ac9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 1479475e0ac9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 1480475e0ac9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 1481475e0ac9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 1482475e0ac9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 1483475e0ac9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 1484475e0ac9SMatthew G. Knepley . t - current time 1485475e0ac9SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t 1486475e0ac9SMatthew G. Knepley . x - coordinates of the current point 148797b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters 148897b6e6e8SMatthew G. Knepley . constants - constant parameters 1489475e0ac9SMatthew G. Knepley - g0 - output values at the current point 1490475e0ac9SMatthew G. Knepley 1491475e0ac9SMatthew G. Knepley Level: intermediate 1492475e0ac9SMatthew G. Knepley 1493475e0ac9SMatthew G. Knepley .seealso: PetscDSGetJacobianPreconditioner(), PetscDSSetJacobian() 1494475e0ac9SMatthew G. Knepley @*/ 1495475e0ac9SMatthew G. Knepley PetscErrorCode PetscDSSetJacobianPreconditioner(PetscDS prob, PetscInt f, PetscInt g, 1496475e0ac9SMatthew G. Knepley void (*g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1497475e0ac9SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1498475e0ac9SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 149997b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]), 1500475e0ac9SMatthew G. Knepley void (*g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1501475e0ac9SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1502475e0ac9SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 150397b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]), 1504475e0ac9SMatthew G. Knepley void (*g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1505475e0ac9SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1506475e0ac9SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 150797b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]), 1508475e0ac9SMatthew G. Knepley void (*g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1509475e0ac9SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1510475e0ac9SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 151197b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[])) 1512475e0ac9SMatthew G. Knepley { 1513475e0ac9SMatthew G. Knepley PetscErrorCode ierr; 1514475e0ac9SMatthew G. Knepley 1515475e0ac9SMatthew G. Knepley PetscFunctionBegin; 1516475e0ac9SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 1517475e0ac9SMatthew G. Knepley if (g0) PetscValidFunction(g0, 4); 1518475e0ac9SMatthew G. Knepley if (g1) PetscValidFunction(g1, 5); 1519475e0ac9SMatthew G. Knepley if (g2) PetscValidFunction(g2, 6); 1520475e0ac9SMatthew G. Knepley if (g3) PetscValidFunction(g3, 7); 1521475e0ac9SMatthew G. Knepley if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f); 1522475e0ac9SMatthew G. Knepley if (g < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", g); 1523475e0ac9SMatthew G. Knepley ierr = PetscDSEnlarge_Static(prob, PetscMax(f, g)+1);CHKERRQ(ierr); 1524475e0ac9SMatthew G. Knepley prob->gp[(f*prob->Nf + g)*4+0] = g0; 1525475e0ac9SMatthew G. Knepley prob->gp[(f*prob->Nf + g)*4+1] = g1; 1526475e0ac9SMatthew G. Knepley prob->gp[(f*prob->Nf + g)*4+2] = g2; 1527475e0ac9SMatthew G. Knepley prob->gp[(f*prob->Nf + g)*4+3] = g3; 1528475e0ac9SMatthew G. Knepley PetscFunctionReturn(0); 1529475e0ac9SMatthew G. Knepley } 1530475e0ac9SMatthew G. Knepley 1531b7e05686SMatthew G. Knepley /*@C 1532b7e05686SMatthew G. Knepley PetscDSHasDynamicJacobian - Signals that a dynamic Jacobian, dF/du_t, has been set 1533b7e05686SMatthew G. Knepley 1534b7e05686SMatthew G. Knepley Not collective 1535b7e05686SMatthew G. Knepley 1536b7e05686SMatthew G. Knepley Input Parameter: 1537b7e05686SMatthew G. Knepley . prob - The PetscDS 1538b7e05686SMatthew G. Knepley 1539b7e05686SMatthew G. Knepley Output Parameter: 1540b7e05686SMatthew G. Knepley . hasDynJac - flag that pointwise function for dynamic Jacobian has been set 1541b7e05686SMatthew G. Knepley 1542b7e05686SMatthew G. Knepley Level: intermediate 1543b7e05686SMatthew G. Knepley 1544b7e05686SMatthew G. Knepley .seealso: PetscDSGetDynamicJacobian(), PetscDSSetDynamicJacobian(), PetscDSGetJacobian() 1545b7e05686SMatthew G. Knepley @*/ 1546b7e05686SMatthew G. Knepley PetscErrorCode PetscDSHasDynamicJacobian(PetscDS prob, PetscBool *hasDynJac) 1547b7e05686SMatthew G. Knepley { 1548b7e05686SMatthew G. Knepley PetscInt f, g, h; 1549b7e05686SMatthew G. Knepley 1550b7e05686SMatthew G. Knepley PetscFunctionBegin; 1551b7e05686SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 1552b7e05686SMatthew G. Knepley *hasDynJac = PETSC_FALSE; 1553b7e05686SMatthew G. Knepley for (f = 0; f < prob->Nf; ++f) { 1554b7e05686SMatthew G. Knepley for (g = 0; g < prob->Nf; ++g) { 1555b7e05686SMatthew G. Knepley for (h = 0; h < 4; ++h) { 1556b7e05686SMatthew G. Knepley if (prob->gt[(f*prob->Nf + g)*4+h]) *hasDynJac = PETSC_TRUE; 1557b7e05686SMatthew G. Knepley } 1558b7e05686SMatthew G. Knepley } 1559b7e05686SMatthew G. Knepley } 1560b7e05686SMatthew G. Knepley PetscFunctionReturn(0); 1561b7e05686SMatthew G. Knepley } 1562b7e05686SMatthew G. Knepley 1563b7e05686SMatthew G. Knepley /*@C 1564b7e05686SMatthew G. Knepley PetscDSGetDynamicJacobian - Get the pointwise dynamic Jacobian, dF/du_t, function for given test and basis field 1565b7e05686SMatthew G. Knepley 1566b7e05686SMatthew G. Knepley Not collective 1567b7e05686SMatthew G. Knepley 1568b7e05686SMatthew G. Knepley Input Parameters: 1569b7e05686SMatthew G. Knepley + prob - The PetscDS 1570b7e05686SMatthew G. Knepley . f - The test field number 1571b7e05686SMatthew G. Knepley - g - The field number 1572b7e05686SMatthew G. Knepley 1573b7e05686SMatthew G. Knepley Output Parameters: 1574b7e05686SMatthew G. Knepley + g0 - integrand for the test and basis function term 1575b7e05686SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term 1576b7e05686SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term 1577b7e05686SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term 1578b7e05686SMatthew G. Knepley 1579b7e05686SMatthew G. Knepley Note: We are using a first order FEM model for the weak form: 1580b7e05686SMatthew G. Knepley 1581b7e05686SMatthew 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 1582b7e05686SMatthew G. Knepley 1583b7e05686SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by: 1584b7e05686SMatthew G. Knepley 1585b7e05686SMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1586b7e05686SMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1587b7e05686SMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 1588b7e05686SMatthew G. Knepley $ PetscReal t, const PetscReal u_tShift, const PetscReal x[], PetscScalar g0[]) 1589b7e05686SMatthew G. Knepley 1590b7e05686SMatthew G. Knepley + dim - the spatial dimension 1591b7e05686SMatthew G. Knepley . Nf - the number of fields 1592b7e05686SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 1593b7e05686SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 1594b7e05686SMatthew G. Knepley . u - each field evaluated at the current point 1595b7e05686SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 1596b7e05686SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 1597b7e05686SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 1598b7e05686SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 1599b7e05686SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 1600b7e05686SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 1601b7e05686SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 1602b7e05686SMatthew G. Knepley . t - current time 1603b7e05686SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t 1604b7e05686SMatthew G. Knepley . x - coordinates of the current point 160597b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters 160697b6e6e8SMatthew G. Knepley . constants - constant parameters 1607b7e05686SMatthew G. Knepley - g0 - output values at the current point 1608b7e05686SMatthew G. Knepley 1609b7e05686SMatthew G. Knepley Level: intermediate 1610b7e05686SMatthew G. Knepley 1611b7e05686SMatthew G. Knepley .seealso: PetscDSSetJacobian() 1612b7e05686SMatthew G. Knepley @*/ 1613b7e05686SMatthew G. Knepley PetscErrorCode PetscDSGetDynamicJacobian(PetscDS prob, PetscInt f, PetscInt g, 1614b7e05686SMatthew G. Knepley void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1615b7e05686SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1616b7e05686SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 161797b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]), 1618b7e05686SMatthew G. Knepley void (**g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1619b7e05686SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1620b7e05686SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 162197b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]), 1622b7e05686SMatthew G. Knepley void (**g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1623b7e05686SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1624b7e05686SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 162597b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]), 1626b7e05686SMatthew G. Knepley void (**g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1627b7e05686SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1628b7e05686SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 162997b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[])) 1630b7e05686SMatthew G. Knepley { 1631b7e05686SMatthew G. Knepley PetscFunctionBegin; 1632b7e05686SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 1633b7e05686SMatthew 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); 1634b7e05686SMatthew 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); 1635b7e05686SMatthew G. Knepley if (g0) {PetscValidPointer(g0, 4); *g0 = prob->gt[(f*prob->Nf + g)*4+0];} 1636b7e05686SMatthew G. Knepley if (g1) {PetscValidPointer(g1, 5); *g1 = prob->gt[(f*prob->Nf + g)*4+1];} 1637b7e05686SMatthew G. Knepley if (g2) {PetscValidPointer(g2, 6); *g2 = prob->gt[(f*prob->Nf + g)*4+2];} 1638b7e05686SMatthew G. Knepley if (g3) {PetscValidPointer(g3, 7); *g3 = prob->gt[(f*prob->Nf + g)*4+3];} 1639b7e05686SMatthew G. Knepley PetscFunctionReturn(0); 1640b7e05686SMatthew G. Knepley } 1641b7e05686SMatthew G. Knepley 1642b7e05686SMatthew G. Knepley /*@C 1643b7e05686SMatthew G. Knepley PetscDSSetDynamicJacobian - Set the pointwise dynamic Jacobian, dF/du_t, function for given test and basis fields 1644b7e05686SMatthew G. Knepley 1645b7e05686SMatthew G. Knepley Not collective 1646b7e05686SMatthew G. Knepley 1647b7e05686SMatthew G. Knepley Input Parameters: 1648b7e05686SMatthew G. Knepley + prob - The PetscDS 1649b7e05686SMatthew G. Knepley . f - The test field number 1650b7e05686SMatthew G. Knepley . g - The field number 1651b7e05686SMatthew G. Knepley . g0 - integrand for the test and basis function term 1652b7e05686SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term 1653b7e05686SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term 1654b7e05686SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term 1655b7e05686SMatthew G. Knepley 1656b7e05686SMatthew G. Knepley Note: We are using a first order FEM model for the weak form: 1657b7e05686SMatthew G. Knepley 1658b7e05686SMatthew 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 1659b7e05686SMatthew G. Knepley 1660b7e05686SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by: 1661b7e05686SMatthew G. Knepley 1662b7e05686SMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1663b7e05686SMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1664b7e05686SMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 1665b7e05686SMatthew G. Knepley $ PetscReal t, const PetscReal x[], PetscScalar g0[]) 1666b7e05686SMatthew G. Knepley 1667b7e05686SMatthew G. Knepley + dim - the spatial dimension 1668b7e05686SMatthew G. Knepley . Nf - the number of fields 1669b7e05686SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 1670b7e05686SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 1671b7e05686SMatthew G. Knepley . u - each field evaluated at the current point 1672b7e05686SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 1673b7e05686SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 1674b7e05686SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 1675b7e05686SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 1676b7e05686SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 1677b7e05686SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 1678b7e05686SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 1679b7e05686SMatthew G. Knepley . t - current time 1680b7e05686SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t 1681b7e05686SMatthew G. Knepley . x - coordinates of the current point 168297b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters 168397b6e6e8SMatthew G. Knepley . constants - constant parameters 1684b7e05686SMatthew G. Knepley - g0 - output values at the current point 1685b7e05686SMatthew G. Knepley 1686b7e05686SMatthew G. Knepley Level: intermediate 1687b7e05686SMatthew G. Knepley 1688b7e05686SMatthew G. Knepley .seealso: PetscDSGetJacobian() 1689b7e05686SMatthew G. Knepley @*/ 1690b7e05686SMatthew G. Knepley PetscErrorCode PetscDSSetDynamicJacobian(PetscDS prob, PetscInt f, PetscInt g, 1691b7e05686SMatthew G. Knepley void (*g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1692b7e05686SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1693b7e05686SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 169497b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]), 1695b7e05686SMatthew G. Knepley void (*g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1696b7e05686SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1697b7e05686SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 169897b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]), 1699b7e05686SMatthew G. Knepley void (*g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1700b7e05686SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1701b7e05686SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 170297b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]), 1703b7e05686SMatthew G. Knepley void (*g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1704b7e05686SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1705b7e05686SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 170697b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[])) 1707b7e05686SMatthew G. Knepley { 1708b7e05686SMatthew G. Knepley PetscErrorCode ierr; 1709b7e05686SMatthew G. Knepley 1710b7e05686SMatthew G. Knepley PetscFunctionBegin; 1711b7e05686SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 1712b7e05686SMatthew G. Knepley if (g0) PetscValidFunction(g0, 4); 1713b7e05686SMatthew G. Knepley if (g1) PetscValidFunction(g1, 5); 1714b7e05686SMatthew G. Knepley if (g2) PetscValidFunction(g2, 6); 1715b7e05686SMatthew G. Knepley if (g3) PetscValidFunction(g3, 7); 1716b7e05686SMatthew G. Knepley if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f); 1717b7e05686SMatthew G. Knepley if (g < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", g); 1718b7e05686SMatthew G. Knepley ierr = PetscDSEnlarge_Static(prob, PetscMax(f, g)+1);CHKERRQ(ierr); 1719b7e05686SMatthew G. Knepley prob->gt[(f*prob->Nf + g)*4+0] = g0; 1720b7e05686SMatthew G. Knepley prob->gt[(f*prob->Nf + g)*4+1] = g1; 1721b7e05686SMatthew G. Knepley prob->gt[(f*prob->Nf + g)*4+2] = g2; 1722b7e05686SMatthew G. Knepley prob->gt[(f*prob->Nf + g)*4+3] = g3; 1723b7e05686SMatthew G. Knepley PetscFunctionReturn(0); 1724b7e05686SMatthew G. Knepley } 1725b7e05686SMatthew G. Knepley 17260c2f2876SMatthew G. Knepley /*@C 17270c2f2876SMatthew G. Knepley PetscDSGetRiemannSolver - Returns the Riemann solver for the given field 17280c2f2876SMatthew G. Knepley 17290c2f2876SMatthew G. Knepley Not collective 17300c2f2876SMatthew G. Knepley 17310c2f2876SMatthew G. Knepley Input Arguments: 17320c2f2876SMatthew G. Knepley + prob - The PetscDS object 17330c2f2876SMatthew G. Knepley - f - The field number 17340c2f2876SMatthew G. Knepley 17350c2f2876SMatthew G. Knepley Output Argument: 17360c2f2876SMatthew G. Knepley . r - Riemann solver 17370c2f2876SMatthew G. Knepley 17380c2f2876SMatthew G. Knepley Calling sequence for r: 17390c2f2876SMatthew G. Knepley 17405db36cf9SMatthew G. Knepley $ r(PetscInt dim, PetscInt Nf, const PetscReal x[], const PetscReal n[], const PetscScalar uL[], const PetscScalar uR[], PetscScalar flux[], void *ctx) 17410c2f2876SMatthew G. Knepley 17425db36cf9SMatthew G. Knepley + dim - The spatial dimension 17435db36cf9SMatthew G. Knepley . Nf - The number of fields 17445db36cf9SMatthew G. Knepley . x - The coordinates at a point on the interface 17450c2f2876SMatthew G. Knepley . n - The normal vector to the interface 17460c2f2876SMatthew G. Knepley . uL - The state vector to the left of the interface 17470c2f2876SMatthew G. Knepley . uR - The state vector to the right of the interface 17480c2f2876SMatthew G. Knepley . flux - output array of flux through the interface 174997b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters 175097b6e6e8SMatthew G. Knepley . constants - constant parameters 17510c2f2876SMatthew G. Knepley - ctx - optional user context 17520c2f2876SMatthew G. Knepley 17530c2f2876SMatthew G. Knepley Level: intermediate 17540c2f2876SMatthew G. Knepley 17550c2f2876SMatthew G. Knepley .seealso: PetscDSSetRiemannSolver() 17560c2f2876SMatthew G. Knepley @*/ 17570c2f2876SMatthew G. Knepley PetscErrorCode PetscDSGetRiemannSolver(PetscDS prob, PetscInt f, 175897b6e6e8SMatthew 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)) 17590c2f2876SMatthew G. Knepley { 17600c2f2876SMatthew G. Knepley PetscFunctionBegin; 17610c2f2876SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 17620c2f2876SMatthew 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); 17630c2f2876SMatthew G. Knepley PetscValidPointer(r, 3); 17640c2f2876SMatthew G. Knepley *r = prob->r[f]; 17650c2f2876SMatthew G. Knepley PetscFunctionReturn(0); 17660c2f2876SMatthew G. Knepley } 17670c2f2876SMatthew G. Knepley 17680c2f2876SMatthew G. Knepley /*@C 17690c2f2876SMatthew G. Knepley PetscDSSetRiemannSolver - Sets the Riemann solver for the given field 17700c2f2876SMatthew G. Knepley 17710c2f2876SMatthew G. Knepley Not collective 17720c2f2876SMatthew G. Knepley 17730c2f2876SMatthew G. Knepley Input Arguments: 17740c2f2876SMatthew G. Knepley + prob - The PetscDS object 17750c2f2876SMatthew G. Knepley . f - The field number 17760c2f2876SMatthew G. Knepley - r - Riemann solver 17770c2f2876SMatthew G. Knepley 17780c2f2876SMatthew G. Knepley Calling sequence for r: 17790c2f2876SMatthew G. Knepley 17805db36cf9SMatthew G. Knepley $ r(PetscInt dim, PetscInt Nf, const PetscReal x[], const PetscReal n[], const PetscScalar uL[], const PetscScalar uR[], PetscScalar flux[], void *ctx) 17810c2f2876SMatthew G. Knepley 17825db36cf9SMatthew G. Knepley + dim - The spatial dimension 17835db36cf9SMatthew G. Knepley . Nf - The number of fields 17845db36cf9SMatthew G. Knepley . x - The coordinates at a point on the interface 17850c2f2876SMatthew G. Knepley . n - The normal vector to the interface 17860c2f2876SMatthew G. Knepley . uL - The state vector to the left of the interface 17870c2f2876SMatthew G. Knepley . uR - The state vector to the right of the interface 17880c2f2876SMatthew G. Knepley . flux - output array of flux through the interface 178997b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters 179097b6e6e8SMatthew G. Knepley . constants - constant parameters 17910c2f2876SMatthew G. Knepley - ctx - optional user context 17920c2f2876SMatthew G. Knepley 17930c2f2876SMatthew G. Knepley Level: intermediate 17940c2f2876SMatthew G. Knepley 17950c2f2876SMatthew G. Knepley .seealso: PetscDSGetRiemannSolver() 17960c2f2876SMatthew G. Knepley @*/ 17970c2f2876SMatthew G. Knepley PetscErrorCode PetscDSSetRiemannSolver(PetscDS prob, PetscInt f, 179897b6e6e8SMatthew 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)) 17990c2f2876SMatthew G. Knepley { 18000c2f2876SMatthew G. Knepley PetscErrorCode ierr; 18010c2f2876SMatthew G. Knepley 18020c2f2876SMatthew G. Knepley PetscFunctionBegin; 18030c2f2876SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 1804de716cbcSToby Isaac if (r) PetscValidFunction(r, 3); 18050c2f2876SMatthew G. Knepley if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f); 18060c2f2876SMatthew G. Knepley ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr); 18070c2f2876SMatthew G. Knepley prob->r[f] = r; 18080c2f2876SMatthew G. Knepley PetscFunctionReturn(0); 18090c2f2876SMatthew G. Knepley } 18100c2f2876SMatthew G. Knepley 181132d2bbc9SMatthew G. Knepley /*@C 181232d2bbc9SMatthew G. Knepley PetscDSGetUpdate - Get the pointwise update function for a given field 181332d2bbc9SMatthew G. Knepley 181432d2bbc9SMatthew G. Knepley Not collective 181532d2bbc9SMatthew G. Knepley 181632d2bbc9SMatthew G. Knepley Input Parameters: 181732d2bbc9SMatthew G. Knepley + prob - The PetscDS 181832d2bbc9SMatthew G. Knepley - f - The field number 181932d2bbc9SMatthew G. Knepley 182032d2bbc9SMatthew G. Knepley Output Parameters: 182132d2bbc9SMatthew G. Knepley + update - update function 182232d2bbc9SMatthew G. Knepley 182332d2bbc9SMatthew G. Knepley Note: The calling sequence for the callback update is given by: 182432d2bbc9SMatthew G. Knepley 182532d2bbc9SMatthew G. Knepley $ update(PetscInt dim, PetscInt Nf, PetscInt NfAux, 182632d2bbc9SMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 182732d2bbc9SMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 182832d2bbc9SMatthew G. Knepley $ PetscReal t, const PetscReal x[], PetscScalar uNew[]) 182932d2bbc9SMatthew G. Knepley 183032d2bbc9SMatthew G. Knepley + dim - the spatial dimension 183132d2bbc9SMatthew G. Knepley . Nf - the number of fields 183232d2bbc9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 183332d2bbc9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 183432d2bbc9SMatthew G. Knepley . u - each field evaluated at the current point 183532d2bbc9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 183632d2bbc9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 183732d2bbc9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 183832d2bbc9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 183932d2bbc9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 184032d2bbc9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 184132d2bbc9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 184232d2bbc9SMatthew G. Knepley . t - current time 184332d2bbc9SMatthew G. Knepley . x - coordinates of the current point 184432d2bbc9SMatthew G. Knepley - uNew - new value for field at the current point 184532d2bbc9SMatthew G. Knepley 184632d2bbc9SMatthew G. Knepley Level: intermediate 184732d2bbc9SMatthew G. Knepley 184832d2bbc9SMatthew G. Knepley .seealso: PetscDSSetUpdate(), PetscDSSetResidual() 184932d2bbc9SMatthew G. Knepley @*/ 185032d2bbc9SMatthew G. Knepley PetscErrorCode PetscDSGetUpdate(PetscDS prob, PetscInt f, 185132d2bbc9SMatthew G. Knepley void (**update)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 185232d2bbc9SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 185332d2bbc9SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 18543fa77dffSMatthew G. Knepley PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar uNew[])) 185532d2bbc9SMatthew G. Knepley { 185632d2bbc9SMatthew G. Knepley PetscFunctionBegin; 185732d2bbc9SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 185832d2bbc9SMatthew 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); 185932d2bbc9SMatthew G. Knepley if (update) {PetscValidPointer(update, 3); *update = prob->update[f];} 186032d2bbc9SMatthew G. Knepley PetscFunctionReturn(0); 186132d2bbc9SMatthew G. Knepley } 186232d2bbc9SMatthew G. Knepley 186332d2bbc9SMatthew G. Knepley /*@C 18643fa77dffSMatthew G. Knepley PetscDSSetUpdate - Set the pointwise update function for a given field 186532d2bbc9SMatthew G. Knepley 186632d2bbc9SMatthew G. Knepley Not collective 186732d2bbc9SMatthew G. Knepley 186832d2bbc9SMatthew G. Knepley Input Parameters: 186932d2bbc9SMatthew G. Knepley + prob - The PetscDS 187032d2bbc9SMatthew G. Knepley . f - The field number 187132d2bbc9SMatthew G. Knepley - update - update function 187232d2bbc9SMatthew G. Knepley 187332d2bbc9SMatthew G. Knepley Note: The calling sequence for the callback update is given by: 187432d2bbc9SMatthew G. Knepley 187532d2bbc9SMatthew G. Knepley $ update(PetscInt dim, PetscInt Nf, PetscInt NfAux, 187632d2bbc9SMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 187732d2bbc9SMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 187832d2bbc9SMatthew G. Knepley $ PetscReal t, const PetscReal x[], PetscScalar uNew[]) 187932d2bbc9SMatthew G. Knepley 188032d2bbc9SMatthew G. Knepley + dim - the spatial dimension 188132d2bbc9SMatthew G. Knepley . Nf - the number of fields 188232d2bbc9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 188332d2bbc9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 188432d2bbc9SMatthew G. Knepley . u - each field evaluated at the current point 188532d2bbc9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 188632d2bbc9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 188732d2bbc9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 188832d2bbc9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 188932d2bbc9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 189032d2bbc9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 189132d2bbc9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 189232d2bbc9SMatthew G. Knepley . t - current time 189332d2bbc9SMatthew G. Knepley . x - coordinates of the current point 189432d2bbc9SMatthew G. Knepley - uNew - new field values at the current point 189532d2bbc9SMatthew G. Knepley 189632d2bbc9SMatthew G. Knepley Level: intermediate 189732d2bbc9SMatthew G. Knepley 189832d2bbc9SMatthew G. Knepley .seealso: PetscDSGetResidual() 189932d2bbc9SMatthew G. Knepley @*/ 190032d2bbc9SMatthew G. Knepley PetscErrorCode PetscDSSetUpdate(PetscDS prob, PetscInt f, 190132d2bbc9SMatthew G. Knepley void (*update)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 190232d2bbc9SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 190332d2bbc9SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 19043fa77dffSMatthew G. Knepley PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar uNew[])) 190532d2bbc9SMatthew G. Knepley { 190632d2bbc9SMatthew G. Knepley PetscErrorCode ierr; 190732d2bbc9SMatthew G. Knepley 190832d2bbc9SMatthew G. Knepley PetscFunctionBegin; 190932d2bbc9SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 191032d2bbc9SMatthew G. Knepley if (update) PetscValidFunction(update, 3); 191132d2bbc9SMatthew G. Knepley if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f); 191232d2bbc9SMatthew G. Knepley ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr); 191332d2bbc9SMatthew G. Knepley prob->update[f] = update; 191432d2bbc9SMatthew G. Knepley PetscFunctionReturn(0); 191532d2bbc9SMatthew G. Knepley } 191632d2bbc9SMatthew G. Knepley 19170c2f2876SMatthew G. Knepley PetscErrorCode PetscDSGetContext(PetscDS prob, PetscInt f, void **ctx) 19180c2f2876SMatthew G. Knepley { 19190c2f2876SMatthew G. Knepley PetscFunctionBegin; 19200c2f2876SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 19210c2f2876SMatthew 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); 19220c2f2876SMatthew G. Knepley PetscValidPointer(ctx, 3); 19230c2f2876SMatthew G. Knepley *ctx = prob->ctx[f]; 19240c2f2876SMatthew G. Knepley PetscFunctionReturn(0); 19250c2f2876SMatthew G. Knepley } 19260c2f2876SMatthew G. Knepley 19270c2f2876SMatthew G. Knepley PetscErrorCode PetscDSSetContext(PetscDS prob, PetscInt f, void *ctx) 19280c2f2876SMatthew G. Knepley { 19290c2f2876SMatthew G. Knepley PetscErrorCode ierr; 19300c2f2876SMatthew G. Knepley 19310c2f2876SMatthew G. Knepley PetscFunctionBegin; 19320c2f2876SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 19330c2f2876SMatthew G. Knepley if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f); 19340c2f2876SMatthew G. Knepley ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr); 19350c2f2876SMatthew G. Knepley prob->ctx[f] = ctx; 19360c2f2876SMatthew G. Knepley PetscFunctionReturn(0); 19370c2f2876SMatthew G. Knepley } 19380c2f2876SMatthew G. Knepley 1939194d53e6SMatthew G. Knepley /*@C 1940194d53e6SMatthew G. Knepley PetscDSGetBdResidual - Get the pointwise boundary residual function for a given test field 1941194d53e6SMatthew G. Knepley 1942194d53e6SMatthew G. Knepley Not collective 1943194d53e6SMatthew G. Knepley 1944194d53e6SMatthew G. Knepley Input Parameters: 1945194d53e6SMatthew G. Knepley + prob - The PetscDS 1946194d53e6SMatthew G. Knepley - f - The test field number 1947194d53e6SMatthew G. Knepley 1948194d53e6SMatthew G. Knepley Output Parameters: 1949194d53e6SMatthew G. Knepley + f0 - boundary integrand for the test function term 1950194d53e6SMatthew G. Knepley - f1 - boundary integrand for the test function gradient term 1951194d53e6SMatthew G. Knepley 1952194d53e6SMatthew G. Knepley Note: We are using a first order FEM model for the weak form: 1953194d53e6SMatthew G. Knepley 1954194d53e6SMatthew 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 1955194d53e6SMatthew G. Knepley 1956194d53e6SMatthew G. Knepley The calling sequence for the callbacks f0 and f1 is given by: 1957194d53e6SMatthew G. Knepley 195830b9ff8bSMatthew G. Knepley $ f0(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1959194d53e6SMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1960194d53e6SMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 196130b9ff8bSMatthew G. Knepley $ PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar f0[]) 1962194d53e6SMatthew G. Knepley 1963194d53e6SMatthew G. Knepley + dim - the spatial dimension 1964194d53e6SMatthew G. Knepley . Nf - the number of fields 1965194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 1966194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 1967194d53e6SMatthew G. Knepley . u - each field evaluated at the current point 1968194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 1969194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 1970194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 1971194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 1972194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 1973194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 1974194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 1975194d53e6SMatthew G. Knepley . t - current time 1976194d53e6SMatthew G. Knepley . x - coordinates of the current point 1977194d53e6SMatthew G. Knepley . n - unit normal at the current point 197897b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters 197997b6e6e8SMatthew G. Knepley . constants - constant parameters 1980194d53e6SMatthew G. Knepley - f0 - output values at the current point 1981194d53e6SMatthew G. Knepley 1982194d53e6SMatthew G. Knepley Level: intermediate 1983194d53e6SMatthew G. Knepley 1984194d53e6SMatthew G. Knepley .seealso: PetscDSSetBdResidual() 1985194d53e6SMatthew G. Knepley @*/ 19862764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetBdResidual(PetscDS prob, PetscInt f, 198730b9ff8bSMatthew G. Knepley void (**f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1988194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1989194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 199097b6e6e8SMatthew G. Knepley PetscReal t, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f0[]), 199130b9ff8bSMatthew G. Knepley void (**f1)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1992194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1993194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 199497b6e6e8SMatthew G. Knepley PetscReal t, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f1[])) 19952764a2aaSMatthew G. Knepley { 19962764a2aaSMatthew G. Knepley PetscFunctionBegin; 19972764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 19982764a2aaSMatthew 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); 19992764a2aaSMatthew G. Knepley if (f0) {PetscValidPointer(f0, 3); *f0 = prob->fBd[f*2+0];} 20002764a2aaSMatthew G. Knepley if (f1) {PetscValidPointer(f1, 4); *f1 = prob->fBd[f*2+1];} 20012764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 20022764a2aaSMatthew G. Knepley } 20032764a2aaSMatthew G. Knepley 2004194d53e6SMatthew G. Knepley /*@C 2005194d53e6SMatthew G. Knepley PetscDSSetBdResidual - Get the pointwise boundary residual function for a given test field 2006194d53e6SMatthew G. Knepley 2007194d53e6SMatthew G. Knepley Not collective 2008194d53e6SMatthew G. Knepley 2009194d53e6SMatthew G. Knepley Input Parameters: 2010194d53e6SMatthew G. Knepley + prob - The PetscDS 2011194d53e6SMatthew G. Knepley . f - The test field number 2012194d53e6SMatthew G. Knepley . f0 - boundary integrand for the test function term 2013194d53e6SMatthew G. Knepley - f1 - boundary integrand for the test function gradient term 2014194d53e6SMatthew G. Knepley 2015194d53e6SMatthew G. Knepley Note: We are using a first order FEM model for the weak form: 2016194d53e6SMatthew G. Knepley 2017194d53e6SMatthew 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 2018194d53e6SMatthew G. Knepley 2019194d53e6SMatthew G. Knepley The calling sequence for the callbacks f0 and f1 is given by: 2020194d53e6SMatthew G. Knepley 202130b9ff8bSMatthew G. Knepley $ f0(PetscInt dim, PetscInt Nf, PetscInt NfAux, 2022194d53e6SMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 2023194d53e6SMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 202430b9ff8bSMatthew G. Knepley $ PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar f0[]) 2025194d53e6SMatthew G. Knepley 2026194d53e6SMatthew G. Knepley + dim - the spatial dimension 2027194d53e6SMatthew G. Knepley . Nf - the number of fields 2028194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 2029194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 2030194d53e6SMatthew G. Knepley . u - each field evaluated at the current point 2031194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 2032194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 2033194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 2034194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 2035194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 2036194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 2037194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 2038194d53e6SMatthew G. Knepley . t - current time 2039194d53e6SMatthew G. Knepley . x - coordinates of the current point 2040194d53e6SMatthew G. Knepley . n - unit normal at the current point 204197b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters 204297b6e6e8SMatthew G. Knepley . constants - constant parameters 2043194d53e6SMatthew G. Knepley - f0 - output values at the current point 2044194d53e6SMatthew G. Knepley 2045194d53e6SMatthew G. Knepley Level: intermediate 2046194d53e6SMatthew G. Knepley 2047194d53e6SMatthew G. Knepley .seealso: PetscDSGetBdResidual() 2048194d53e6SMatthew G. Knepley @*/ 20492764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetBdResidual(PetscDS prob, PetscInt f, 205030b9ff8bSMatthew G. Knepley void (*f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 2051194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 2052194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 205397b6e6e8SMatthew G. Knepley PetscReal t, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f0[]), 205430b9ff8bSMatthew G. Knepley void (*f1)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 2055194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 2056194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 205797b6e6e8SMatthew G. Knepley PetscReal t, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f1[])) 20582764a2aaSMatthew G. Knepley { 20592764a2aaSMatthew G. Knepley PetscErrorCode ierr; 20602764a2aaSMatthew G. Knepley 20612764a2aaSMatthew G. Knepley PetscFunctionBegin; 20622764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 20632764a2aaSMatthew G. Knepley if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f); 20642764a2aaSMatthew G. Knepley ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr); 20652764a2aaSMatthew G. Knepley if (f0) {PetscValidFunction(f0, 3); prob->fBd[f*2+0] = f0;} 20662764a2aaSMatthew G. Knepley if (f1) {PetscValidFunction(f1, 4); prob->fBd[f*2+1] = f1;} 20672764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 20682764a2aaSMatthew G. Knepley } 20692764a2aaSMatthew G. Knepley 2070194d53e6SMatthew G. Knepley /*@C 2071194d53e6SMatthew G. Knepley PetscDSGetBdJacobian - Get the pointwise boundary Jacobian function for given test and basis field 2072194d53e6SMatthew G. Knepley 2073194d53e6SMatthew G. Knepley Not collective 2074194d53e6SMatthew G. Knepley 2075194d53e6SMatthew G. Knepley Input Parameters: 2076194d53e6SMatthew G. Knepley + prob - The PetscDS 2077194d53e6SMatthew G. Knepley . f - The test field number 2078194d53e6SMatthew G. Knepley - g - The field number 2079194d53e6SMatthew G. Knepley 2080194d53e6SMatthew G. Knepley Output Parameters: 2081194d53e6SMatthew G. Knepley + g0 - integrand for the test and basis function term 2082194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term 2083194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term 2084194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term 2085194d53e6SMatthew G. Knepley 2086194d53e6SMatthew G. Knepley Note: We are using a first order FEM model for the weak form: 2087194d53e6SMatthew G. Knepley 2088194d53e6SMatthew 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 2089194d53e6SMatthew G. Knepley 2090194d53e6SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by: 2091194d53e6SMatthew G. Knepley 209230b9ff8bSMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux, 2093194d53e6SMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 2094194d53e6SMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 209530b9ff8bSMatthew G. Knepley $ PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar g0[]) 2096194d53e6SMatthew G. Knepley 2097194d53e6SMatthew G. Knepley + dim - the spatial dimension 2098194d53e6SMatthew G. Knepley . Nf - the number of fields 2099194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 2100194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 2101194d53e6SMatthew G. Knepley . u - each field evaluated at the current point 2102194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 2103194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 2104194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 2105194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 2106194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 2107194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 2108194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 2109194d53e6SMatthew G. Knepley . t - current time 21102aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t 2111194d53e6SMatthew G. Knepley . x - coordinates of the current point 2112194d53e6SMatthew G. Knepley . n - normal at the current point 211397b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters 211497b6e6e8SMatthew G. Knepley . constants - constant parameters 2115194d53e6SMatthew G. Knepley - g0 - output values at the current point 2116194d53e6SMatthew G. Knepley 2117194d53e6SMatthew G. Knepley Level: intermediate 2118194d53e6SMatthew G. Knepley 2119194d53e6SMatthew G. Knepley .seealso: PetscDSSetBdJacobian() 2120194d53e6SMatthew G. Knepley @*/ 21212764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetBdJacobian(PetscDS prob, PetscInt f, PetscInt g, 212230b9ff8bSMatthew G. Knepley void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 2123194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 2124194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 212597b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]), 212630b9ff8bSMatthew G. Knepley void (**g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 2127194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 2128194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 212997b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]), 213030b9ff8bSMatthew G. Knepley void (**g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 2131194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 2132194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 213397b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]), 213430b9ff8bSMatthew G. Knepley void (**g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 2135194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 2136194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 213797b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[])) 21382764a2aaSMatthew G. Knepley { 21392764a2aaSMatthew G. Knepley PetscFunctionBegin; 21402764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 21412764a2aaSMatthew 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); 21422764a2aaSMatthew 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); 21432764a2aaSMatthew G. Knepley if (g0) {PetscValidPointer(g0, 4); *g0 = prob->gBd[(f*prob->Nf + g)*4+0];} 21442764a2aaSMatthew G. Knepley if (g1) {PetscValidPointer(g1, 5); *g1 = prob->gBd[(f*prob->Nf + g)*4+1];} 21452764a2aaSMatthew G. Knepley if (g2) {PetscValidPointer(g2, 6); *g2 = prob->gBd[(f*prob->Nf + g)*4+2];} 21462764a2aaSMatthew G. Knepley if (g3) {PetscValidPointer(g3, 7); *g3 = prob->gBd[(f*prob->Nf + g)*4+3];} 21472764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 21482764a2aaSMatthew G. Knepley } 21492764a2aaSMatthew G. Knepley 2150194d53e6SMatthew G. Knepley /*@C 2151194d53e6SMatthew G. Knepley PetscDSSetBdJacobian - Set the pointwise boundary Jacobian function for given test and basis field 2152194d53e6SMatthew G. Knepley 2153194d53e6SMatthew G. Knepley Not collective 2154194d53e6SMatthew G. Knepley 2155194d53e6SMatthew G. Knepley Input Parameters: 2156194d53e6SMatthew G. Knepley + prob - The PetscDS 2157194d53e6SMatthew G. Knepley . f - The test field number 2158194d53e6SMatthew G. Knepley . g - The field number 2159194d53e6SMatthew G. Knepley . g0 - integrand for the test and basis function term 2160194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term 2161194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term 2162194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term 2163194d53e6SMatthew G. Knepley 2164194d53e6SMatthew G. Knepley Note: We are using a first order FEM model for the weak form: 2165194d53e6SMatthew G. Knepley 2166194d53e6SMatthew 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 2167194d53e6SMatthew G. Knepley 2168194d53e6SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by: 2169194d53e6SMatthew G. Knepley 217030b9ff8bSMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux, 2171194d53e6SMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 2172194d53e6SMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 217330b9ff8bSMatthew G. Knepley $ PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar g0[]) 2174194d53e6SMatthew G. Knepley 2175194d53e6SMatthew G. Knepley + dim - the spatial dimension 2176194d53e6SMatthew G. Knepley . Nf - the number of fields 2177194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 2178194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 2179194d53e6SMatthew G. Knepley . u - each field evaluated at the current point 2180194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 2181194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 2182194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 2183194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 2184194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 2185194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 2186194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 2187194d53e6SMatthew G. Knepley . t - current time 21882aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t 2189194d53e6SMatthew G. Knepley . x - coordinates of the current point 2190194d53e6SMatthew G. Knepley . n - normal at the current point 219197b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters 219297b6e6e8SMatthew G. Knepley . constants - constant parameters 2193194d53e6SMatthew G. Knepley - g0 - output values at the current point 2194194d53e6SMatthew G. Knepley 2195194d53e6SMatthew G. Knepley Level: intermediate 2196194d53e6SMatthew G. Knepley 2197194d53e6SMatthew G. Knepley .seealso: PetscDSGetBdJacobian() 2198194d53e6SMatthew G. Knepley @*/ 21992764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetBdJacobian(PetscDS prob, PetscInt f, PetscInt g, 220030b9ff8bSMatthew G. Knepley void (*g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 2201194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 2202194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 220397b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]), 220430b9ff8bSMatthew G. Knepley void (*g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 2205194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 2206194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 220797b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]), 220830b9ff8bSMatthew G. Knepley void (*g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 2209194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 2210194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 221197b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]), 221230b9ff8bSMatthew G. Knepley void (*g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 2213194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 2214194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 221597b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[])) 22162764a2aaSMatthew G. Knepley { 22172764a2aaSMatthew G. Knepley PetscErrorCode ierr; 22182764a2aaSMatthew G. Knepley 22192764a2aaSMatthew G. Knepley PetscFunctionBegin; 22202764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 22212764a2aaSMatthew G. Knepley if (g0) PetscValidFunction(g0, 4); 22222764a2aaSMatthew G. Knepley if (g1) PetscValidFunction(g1, 5); 22232764a2aaSMatthew G. Knepley if (g2) PetscValidFunction(g2, 6); 22242764a2aaSMatthew G. Knepley if (g3) PetscValidFunction(g3, 7); 22252764a2aaSMatthew G. Knepley if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f); 22262764a2aaSMatthew G. Knepley if (g < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", g); 22272764a2aaSMatthew G. Knepley ierr = PetscDSEnlarge_Static(prob, PetscMax(f, g)+1);CHKERRQ(ierr); 22282764a2aaSMatthew G. Knepley prob->gBd[(f*prob->Nf + g)*4+0] = g0; 22292764a2aaSMatthew G. Knepley prob->gBd[(f*prob->Nf + g)*4+1] = g1; 22302764a2aaSMatthew G. Knepley prob->gBd[(f*prob->Nf + g)*4+2] = g2; 22312764a2aaSMatthew G. Knepley prob->gBd[(f*prob->Nf + g)*4+3] = g3; 22322764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 22332764a2aaSMatthew G. Knepley } 22342764a2aaSMatthew G. Knepley 22350d3e9b51SMatthew G. Knepley /*@C 2236c371a6d1SMatthew G. Knepley PetscDSGetExactSolution - Get the pointwise exact solution function for a given test field 2237c371a6d1SMatthew G. Knepley 2238c371a6d1SMatthew G. Knepley Not collective 2239c371a6d1SMatthew G. Knepley 2240c371a6d1SMatthew G. Knepley Input Parameters: 2241c371a6d1SMatthew G. Knepley + prob - The PetscDS 2242c371a6d1SMatthew G. Knepley - f - The test field number 2243c371a6d1SMatthew G. Knepley 2244c371a6d1SMatthew G. Knepley Output Parameter: 2245c371a6d1SMatthew G. Knepley . exactSol - exact solution for the test field 2246c371a6d1SMatthew G. Knepley 2247c371a6d1SMatthew G. Knepley Note: The calling sequence for the solution functions is given by: 2248c371a6d1SMatthew G. Knepley 2249c371a6d1SMatthew G. Knepley $ sol(PetscInt dim, PetscReal t, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx) 2250c371a6d1SMatthew G. Knepley 2251c371a6d1SMatthew G. Knepley + dim - the spatial dimension 2252c371a6d1SMatthew G. Knepley . t - current time 2253c371a6d1SMatthew G. Knepley . x - coordinates of the current point 2254c371a6d1SMatthew G. Knepley . Nc - the number of field components 2255c371a6d1SMatthew G. Knepley . u - the solution field evaluated at the current point 2256c371a6d1SMatthew G. Knepley - ctx - a user context 2257c371a6d1SMatthew G. Knepley 2258c371a6d1SMatthew G. Knepley Level: intermediate 2259c371a6d1SMatthew G. Knepley 2260c371a6d1SMatthew G. Knepley .seealso: PetscDSSetExactSolution() 2261c371a6d1SMatthew G. Knepley @*/ 2262c371a6d1SMatthew G. Knepley PetscErrorCode PetscDSGetExactSolution(PetscDS prob, PetscInt f, PetscErrorCode (**sol)(PetscInt dim, PetscReal t, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx)) 2263c371a6d1SMatthew G. Knepley { 2264c371a6d1SMatthew G. Knepley PetscFunctionBegin; 2265c371a6d1SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 2266c371a6d1SMatthew 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); 2267c371a6d1SMatthew G. Knepley if (sol) {PetscValidPointer(sol, 3); *sol = prob->exactSol[f];} 2268c371a6d1SMatthew G. Knepley PetscFunctionReturn(0); 2269c371a6d1SMatthew G. Knepley } 2270c371a6d1SMatthew G. Knepley 2271c371a6d1SMatthew G. Knepley /*@C 2272c371a6d1SMatthew G. Knepley PetscDSSetExactSolution - Get the pointwise exact solution function for a given test field 2273c371a6d1SMatthew G. Knepley 2274c371a6d1SMatthew G. Knepley Not collective 2275c371a6d1SMatthew G. Knepley 2276c371a6d1SMatthew G. Knepley Input Parameters: 2277c371a6d1SMatthew G. Knepley + prob - The PetscDS 2278c371a6d1SMatthew G. Knepley . f - The test field number 2279c371a6d1SMatthew G. Knepley - sol - solution function for the test fields 2280c371a6d1SMatthew G. Knepley 2281c371a6d1SMatthew G. Knepley Note: The calling sequence for solution functions is given by: 2282c371a6d1SMatthew G. Knepley 2283c371a6d1SMatthew G. Knepley $ sol(PetscInt dim, PetscReal t, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx) 2284c371a6d1SMatthew G. Knepley 2285c371a6d1SMatthew G. Knepley + dim - the spatial dimension 2286c371a6d1SMatthew G. Knepley . t - current time 2287c371a6d1SMatthew G. Knepley . x - coordinates of the current point 2288c371a6d1SMatthew G. Knepley . Nc - the number of field components 2289c371a6d1SMatthew G. Knepley . u - the solution field evaluated at the current point 2290c371a6d1SMatthew G. Knepley - ctx - a user context 2291c371a6d1SMatthew G. Knepley 2292c371a6d1SMatthew G. Knepley Level: intermediate 2293c371a6d1SMatthew G. Knepley 2294c371a6d1SMatthew G. Knepley .seealso: PetscDSGetExactSolution() 2295c371a6d1SMatthew G. Knepley @*/ 2296c371a6d1SMatthew G. Knepley PetscErrorCode PetscDSSetExactSolution(PetscDS prob, PetscInt f, PetscErrorCode (*sol)(PetscInt dim, PetscReal t, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx)) 2297c371a6d1SMatthew G. Knepley { 2298c371a6d1SMatthew G. Knepley PetscErrorCode ierr; 2299c371a6d1SMatthew G. Knepley 2300c371a6d1SMatthew G. Knepley PetscFunctionBegin; 2301c371a6d1SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 2302c371a6d1SMatthew G. Knepley if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f); 2303c371a6d1SMatthew G. Knepley ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr); 2304c371a6d1SMatthew G. Knepley if (sol) {PetscValidFunction(sol, 3); prob->exactSol[f] = sol;} 2305c371a6d1SMatthew G. Knepley PetscFunctionReturn(0); 2306c371a6d1SMatthew G. Knepley } 2307c371a6d1SMatthew G. Knepley 23085638fd0eSMatthew G. Knepley /*@C 230997b6e6e8SMatthew G. Knepley PetscDSGetConstants - Returns the array of constants passed to point functions 231097b6e6e8SMatthew G. Knepley 231197b6e6e8SMatthew G. Knepley Not collective 231297b6e6e8SMatthew G. Knepley 231397b6e6e8SMatthew G. Knepley Input Parameter: 231497b6e6e8SMatthew G. Knepley . prob - The PetscDS object 231597b6e6e8SMatthew G. Knepley 231697b6e6e8SMatthew G. Knepley Output Parameters: 231797b6e6e8SMatthew G. Knepley + numConstants - The number of constants 231897b6e6e8SMatthew G. Knepley - constants - The array of constants, NULL if there are none 231997b6e6e8SMatthew G. Knepley 232097b6e6e8SMatthew G. Knepley Level: intermediate 232197b6e6e8SMatthew G. Knepley 232297b6e6e8SMatthew G. Knepley .seealso: PetscDSSetConstants(), PetscDSCreate() 232397b6e6e8SMatthew G. Knepley @*/ 232497b6e6e8SMatthew G. Knepley PetscErrorCode PetscDSGetConstants(PetscDS prob, PetscInt *numConstants, const PetscScalar *constants[]) 232597b6e6e8SMatthew G. Knepley { 232697b6e6e8SMatthew G. Knepley PetscFunctionBegin; 232797b6e6e8SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 232897b6e6e8SMatthew G. Knepley if (numConstants) {PetscValidPointer(numConstants, 2); *numConstants = prob->numConstants;} 232997b6e6e8SMatthew G. Knepley if (constants) {PetscValidPointer(constants, 3); *constants = prob->constants;} 233097b6e6e8SMatthew G. Knepley PetscFunctionReturn(0); 233197b6e6e8SMatthew G. Knepley } 233297b6e6e8SMatthew G. Knepley 23330d3e9b51SMatthew G. Knepley /*@C 233497b6e6e8SMatthew G. Knepley PetscDSSetConstants - Set the array of constants passed to point functions 233597b6e6e8SMatthew G. Knepley 233697b6e6e8SMatthew G. Knepley Not collective 233797b6e6e8SMatthew G. Knepley 233897b6e6e8SMatthew G. Knepley Input Parameters: 233997b6e6e8SMatthew G. Knepley + prob - The PetscDS object 234097b6e6e8SMatthew G. Knepley . numConstants - The number of constants 234197b6e6e8SMatthew G. Knepley - constants - The array of constants, NULL if there are none 234297b6e6e8SMatthew G. Knepley 234397b6e6e8SMatthew G. Knepley Level: intermediate 234497b6e6e8SMatthew G. Knepley 234597b6e6e8SMatthew G. Knepley .seealso: PetscDSGetConstants(), PetscDSCreate() 234697b6e6e8SMatthew G. Knepley @*/ 234797b6e6e8SMatthew G. Knepley PetscErrorCode PetscDSSetConstants(PetscDS prob, PetscInt numConstants, PetscScalar constants[]) 234897b6e6e8SMatthew G. Knepley { 234997b6e6e8SMatthew G. Knepley PetscErrorCode ierr; 235097b6e6e8SMatthew G. Knepley 235197b6e6e8SMatthew G. Knepley PetscFunctionBegin; 235297b6e6e8SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 235397b6e6e8SMatthew G. Knepley if (numConstants != prob->numConstants) { 235497b6e6e8SMatthew G. Knepley ierr = PetscFree(prob->constants);CHKERRQ(ierr); 235597b6e6e8SMatthew G. Knepley prob->numConstants = numConstants; 235697b6e6e8SMatthew G. Knepley if (prob->numConstants) { 235797b6e6e8SMatthew G. Knepley ierr = PetscMalloc1(prob->numConstants, &prob->constants);CHKERRQ(ierr); 235820be0f5bSMatthew G. Knepley } else { 235920be0f5bSMatthew G. Knepley prob->constants = NULL; 236020be0f5bSMatthew G. Knepley } 236120be0f5bSMatthew G. Knepley } 236220be0f5bSMatthew G. Knepley if (prob->numConstants) { 236320be0f5bSMatthew G. Knepley PetscValidPointer(constants, 3); 236497b6e6e8SMatthew G. Knepley ierr = PetscMemcpy(prob->constants, constants, prob->numConstants * sizeof(PetscScalar));CHKERRQ(ierr); 236597b6e6e8SMatthew G. Knepley } 236697b6e6e8SMatthew G. Knepley PetscFunctionReturn(0); 236797b6e6e8SMatthew G. Knepley } 236897b6e6e8SMatthew G. Knepley 23694cd1e086SMatthew G. Knepley /*@ 23704cd1e086SMatthew G. Knepley PetscDSGetFieldIndex - Returns the index of the given field 23714cd1e086SMatthew G. Knepley 23724cd1e086SMatthew G. Knepley Not collective 23734cd1e086SMatthew G. Knepley 23744cd1e086SMatthew G. Knepley Input Parameters: 23754cd1e086SMatthew G. Knepley + prob - The PetscDS object 23764cd1e086SMatthew G. Knepley - disc - The discretization object 23774cd1e086SMatthew G. Knepley 23784cd1e086SMatthew G. Knepley Output Parameter: 23794cd1e086SMatthew G. Knepley . f - The field number 23804cd1e086SMatthew G. Knepley 23814cd1e086SMatthew G. Knepley Level: beginner 23824cd1e086SMatthew G. Knepley 2383f744cafaSSander Arens .seealso: PetscGetDiscretization(), PetscDSGetNumFields(), PetscDSCreate() 23844cd1e086SMatthew G. Knepley @*/ 23854cd1e086SMatthew G. Knepley PetscErrorCode PetscDSGetFieldIndex(PetscDS prob, PetscObject disc, PetscInt *f) 23864cd1e086SMatthew G. Knepley { 23874cd1e086SMatthew G. Knepley PetscInt g; 23884cd1e086SMatthew G. Knepley 23894cd1e086SMatthew G. Knepley PetscFunctionBegin; 23904cd1e086SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 23914cd1e086SMatthew G. Knepley PetscValidPointer(f, 3); 23924cd1e086SMatthew G. Knepley *f = -1; 23934cd1e086SMatthew G. Knepley for (g = 0; g < prob->Nf; ++g) {if (disc == prob->disc[g]) break;} 23944cd1e086SMatthew G. Knepley if (g == prob->Nf) SETERRQ(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Field not found in PetscDS."); 23954cd1e086SMatthew G. Knepley *f = g; 23964cd1e086SMatthew G. Knepley PetscFunctionReturn(0); 23974cd1e086SMatthew G. Knepley } 23984cd1e086SMatthew G. Knepley 23994cd1e086SMatthew G. Knepley /*@ 24004cd1e086SMatthew G. Knepley PetscDSGetFieldSize - Returns the size of the given field in the full space basis 24014cd1e086SMatthew G. Knepley 24024cd1e086SMatthew G. Knepley Not collective 24034cd1e086SMatthew G. Knepley 24044cd1e086SMatthew G. Knepley Input Parameters: 24054cd1e086SMatthew G. Knepley + prob - The PetscDS object 24064cd1e086SMatthew G. Knepley - f - The field number 24074cd1e086SMatthew G. Knepley 24084cd1e086SMatthew G. Knepley Output Parameter: 24094cd1e086SMatthew G. Knepley . size - The size 24104cd1e086SMatthew G. Knepley 24114cd1e086SMatthew G. Knepley Level: beginner 24124cd1e086SMatthew G. Knepley 2413f744cafaSSander Arens .seealso: PetscDSGetFieldOffset(), PetscDSGetNumFields(), PetscDSCreate() 24144cd1e086SMatthew G. Knepley @*/ 24154cd1e086SMatthew G. Knepley PetscErrorCode PetscDSGetFieldSize(PetscDS prob, PetscInt f, PetscInt *size) 24164cd1e086SMatthew G. Knepley { 24172166fd64SMatthew G. Knepley PetscErrorCode ierr; 24182166fd64SMatthew G. Knepley 24194cd1e086SMatthew G. Knepley PetscFunctionBegin; 24204cd1e086SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 24214cd1e086SMatthew G. Knepley PetscValidPointer(size, 3); 24224cd1e086SMatthew 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); 24232166fd64SMatthew G. Knepley ierr = PetscDSSetUp(prob);CHKERRQ(ierr); 2424d4742ddaSMatthew G. Knepley *size = prob->Nb[f]; 24254cd1e086SMatthew G. Knepley PetscFunctionReturn(0); 24264cd1e086SMatthew G. Knepley } 24274cd1e086SMatthew G. Knepley 2428bc4ae4beSMatthew G. Knepley /*@ 2429bc4ae4beSMatthew G. Knepley PetscDSGetFieldOffset - Returns the offset of the given field in the full space basis 2430bc4ae4beSMatthew G. Knepley 2431bc4ae4beSMatthew G. Knepley Not collective 2432bc4ae4beSMatthew G. Knepley 2433bc4ae4beSMatthew G. Knepley Input Parameters: 2434bc4ae4beSMatthew G. Knepley + prob - The PetscDS object 2435bc4ae4beSMatthew G. Knepley - f - The field number 2436bc4ae4beSMatthew G. Knepley 2437bc4ae4beSMatthew G. Knepley Output Parameter: 2438bc4ae4beSMatthew G. Knepley . off - The offset 2439bc4ae4beSMatthew G. Knepley 2440bc4ae4beSMatthew G. Knepley Level: beginner 2441bc4ae4beSMatthew G. Knepley 2442f744cafaSSander Arens .seealso: PetscDSGetFieldSize(), PetscDSGetNumFields(), PetscDSCreate() 2443bc4ae4beSMatthew G. Knepley @*/ 24442764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetFieldOffset(PetscDS prob, PetscInt f, PetscInt *off) 24452764a2aaSMatthew G. Knepley { 24464cd1e086SMatthew G. Knepley PetscInt size, g; 24472764a2aaSMatthew G. Knepley PetscErrorCode ierr; 24482764a2aaSMatthew G. Knepley 24492764a2aaSMatthew G. Knepley PetscFunctionBegin; 24502764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 24512764a2aaSMatthew G. Knepley PetscValidPointer(off, 3); 24522764a2aaSMatthew 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); 24532764a2aaSMatthew G. Knepley *off = 0; 24542764a2aaSMatthew G. Knepley for (g = 0; g < f; ++g) { 24554cd1e086SMatthew G. Knepley ierr = PetscDSGetFieldSize(prob, g, &size);CHKERRQ(ierr); 24564cd1e086SMatthew G. Knepley *off += size; 24572764a2aaSMatthew G. Knepley } 24582764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 24592764a2aaSMatthew G. Knepley } 24602764a2aaSMatthew G. Knepley 2461bc4ae4beSMatthew G. Knepley /*@ 246247e57110SSander Arens PetscDSGetDimensions - Returns the size of the approximation space for each field on an evaluation point 2463bc4ae4beSMatthew G. Knepley 2464bc4ae4beSMatthew G. Knepley Not collective 2465bc4ae4beSMatthew G. Knepley 246647e57110SSander Arens Input Parameter: 246747e57110SSander Arens . prob - The PetscDS object 2468bc4ae4beSMatthew G. Knepley 2469bc4ae4beSMatthew G. Knepley Output Parameter: 247047e57110SSander Arens . dimensions - The number of dimensions 2471bc4ae4beSMatthew G. Knepley 2472bc4ae4beSMatthew G. Knepley Level: beginner 2473bc4ae4beSMatthew G. Knepley 247447e57110SSander Arens .seealso: PetscDSGetComponentOffsets(), PetscDSGetNumFields(), PetscDSCreate() 2475bc4ae4beSMatthew G. Knepley @*/ 247647e57110SSander Arens PetscErrorCode PetscDSGetDimensions(PetscDS prob, PetscInt *dimensions[]) 24772764a2aaSMatthew G. Knepley { 24782764a2aaSMatthew G. Knepley PetscErrorCode ierr; 24792764a2aaSMatthew G. Knepley 24802764a2aaSMatthew G. Knepley PetscFunctionBegin; 24812764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 248247e57110SSander Arens ierr = PetscDSSetUp(prob);CHKERRQ(ierr); 248347e57110SSander Arens PetscValidPointer(dimensions, 2); 248447e57110SSander Arens *dimensions = prob->Nb; 248547e57110SSander Arens PetscFunctionReturn(0); 24866ce16762SMatthew G. Knepley } 248747e57110SSander Arens 248847e57110SSander Arens /*@ 248947e57110SSander Arens PetscDSGetComponents - Returns the number of components for each field on an evaluation point 249047e57110SSander Arens 249147e57110SSander Arens Not collective 249247e57110SSander Arens 249347e57110SSander Arens Input Parameter: 249447e57110SSander Arens . prob - The PetscDS object 249547e57110SSander Arens 249647e57110SSander Arens Output Parameter: 249747e57110SSander Arens . components - The number of components 249847e57110SSander Arens 249947e57110SSander Arens Level: beginner 250047e57110SSander Arens 250147e57110SSander Arens .seealso: PetscDSGetComponentOffsets(), PetscDSGetNumFields(), PetscDSCreate() 250247e57110SSander Arens @*/ 250347e57110SSander Arens PetscErrorCode PetscDSGetComponents(PetscDS prob, PetscInt *components[]) 250447e57110SSander Arens { 250547e57110SSander Arens PetscErrorCode ierr; 250647e57110SSander Arens 250747e57110SSander Arens PetscFunctionBegin; 250847e57110SSander Arens PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 250947e57110SSander Arens ierr = PetscDSSetUp(prob);CHKERRQ(ierr); 251047e57110SSander Arens PetscValidPointer(components, 2); 251147e57110SSander Arens *components = prob->Nc; 25126ce16762SMatthew G. Knepley PetscFunctionReturn(0); 25136ce16762SMatthew G. Knepley } 25146ce16762SMatthew G. Knepley 25156ce16762SMatthew G. Knepley /*@ 25166ce16762SMatthew G. Knepley PetscDSGetComponentOffset - Returns the offset of the given field on an evaluation point 25176ce16762SMatthew G. Knepley 25186ce16762SMatthew G. Knepley Not collective 25196ce16762SMatthew G. Knepley 25206ce16762SMatthew G. Knepley Input Parameters: 25216ce16762SMatthew G. Knepley + prob - The PetscDS object 25226ce16762SMatthew G. Knepley - f - The field number 25236ce16762SMatthew G. Knepley 25246ce16762SMatthew G. Knepley Output Parameter: 25256ce16762SMatthew G. Knepley . off - The offset 25266ce16762SMatthew G. Knepley 25276ce16762SMatthew G. Knepley Level: beginner 25286ce16762SMatthew G. Knepley 2529f744cafaSSander Arens .seealso: PetscDSGetNumFields(), PetscDSCreate() 25306ce16762SMatthew G. Knepley @*/ 25316ce16762SMatthew G. Knepley PetscErrorCode PetscDSGetComponentOffset(PetscDS prob, PetscInt f, PetscInt *off) 25326ce16762SMatthew G. Knepley { 25336ce16762SMatthew G. Knepley PetscFunctionBegin; 25346ce16762SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 25356ce16762SMatthew G. Knepley PetscValidPointer(off, 3); 25366ce16762SMatthew 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); 253747e57110SSander Arens *off = prob->off[f]; 25382764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 25392764a2aaSMatthew G. Knepley } 25402764a2aaSMatthew G. Knepley 2541194d53e6SMatthew G. Knepley /*@ 2542194d53e6SMatthew G. Knepley PetscDSGetComponentOffsets - Returns the offset of each field on an evaluation point 2543194d53e6SMatthew G. Knepley 2544194d53e6SMatthew G. Knepley Not collective 2545194d53e6SMatthew G. Knepley 2546194d53e6SMatthew G. Knepley Input Parameter: 2547194d53e6SMatthew G. Knepley . prob - The PetscDS object 2548194d53e6SMatthew G. Knepley 2549194d53e6SMatthew G. Knepley Output Parameter: 2550194d53e6SMatthew G. Knepley . offsets - The offsets 2551194d53e6SMatthew G. Knepley 2552194d53e6SMatthew G. Knepley Level: beginner 2553194d53e6SMatthew G. Knepley 2554f744cafaSSander Arens .seealso: PetscDSGetNumFields(), PetscDSCreate() 2555194d53e6SMatthew G. Knepley @*/ 2556194d53e6SMatthew G. Knepley PetscErrorCode PetscDSGetComponentOffsets(PetscDS prob, PetscInt *offsets[]) 2557194d53e6SMatthew G. Knepley { 2558194d53e6SMatthew G. Knepley PetscFunctionBegin; 2559194d53e6SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 2560194d53e6SMatthew G. Knepley PetscValidPointer(offsets, 2); 2561194d53e6SMatthew G. Knepley *offsets = prob->off; 2562194d53e6SMatthew G. Knepley PetscFunctionReturn(0); 2563194d53e6SMatthew G. Knepley } 2564194d53e6SMatthew G. Knepley 2565194d53e6SMatthew G. Knepley /*@ 2566194d53e6SMatthew G. Knepley PetscDSGetComponentDerivativeOffsets - Returns the offset of each field derivative on an evaluation point 2567194d53e6SMatthew G. Knepley 2568194d53e6SMatthew G. Knepley Not collective 2569194d53e6SMatthew G. Knepley 2570194d53e6SMatthew G. Knepley Input Parameter: 2571194d53e6SMatthew G. Knepley . prob - The PetscDS object 2572194d53e6SMatthew G. Knepley 2573194d53e6SMatthew G. Knepley Output Parameter: 2574194d53e6SMatthew G. Knepley . offsets - The offsets 2575194d53e6SMatthew G. Knepley 2576194d53e6SMatthew G. Knepley Level: beginner 2577194d53e6SMatthew G. Knepley 2578f744cafaSSander Arens .seealso: PetscDSGetNumFields(), PetscDSCreate() 2579194d53e6SMatthew G. Knepley @*/ 2580194d53e6SMatthew G. Knepley PetscErrorCode PetscDSGetComponentDerivativeOffsets(PetscDS prob, PetscInt *offsets[]) 2581194d53e6SMatthew G. Knepley { 2582194d53e6SMatthew G. Knepley PetscFunctionBegin; 2583194d53e6SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 2584194d53e6SMatthew G. Knepley PetscValidPointer(offsets, 2); 2585194d53e6SMatthew G. Knepley *offsets = prob->offDer; 2586194d53e6SMatthew G. Knepley PetscFunctionReturn(0); 2587194d53e6SMatthew G. Knepley } 2588194d53e6SMatthew G. Knepley 258968c9edb9SMatthew G. Knepley /*@C 259068c9edb9SMatthew G. Knepley PetscDSGetTabulation - Return the basis tabulation at quadrature points for the volume discretization 259168c9edb9SMatthew G. Knepley 259268c9edb9SMatthew G. Knepley Not collective 259368c9edb9SMatthew G. Knepley 259468c9edb9SMatthew G. Knepley Input Parameter: 259568c9edb9SMatthew G. Knepley . prob - The PetscDS object 259668c9edb9SMatthew G. Knepley 259768c9edb9SMatthew G. Knepley Output Parameters: 259868c9edb9SMatthew G. Knepley + basis - The basis function tabulation at quadrature points 259968c9edb9SMatthew G. Knepley - basisDer - The basis function derivative tabulation at quadrature points 260068c9edb9SMatthew G. Knepley 260168c9edb9SMatthew G. Knepley Level: intermediate 260268c9edb9SMatthew G. Knepley 2603f744cafaSSander Arens .seealso: PetscDSCreate() 260468c9edb9SMatthew G. Knepley @*/ 26052764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetTabulation(PetscDS prob, PetscReal ***basis, PetscReal ***basisDer) 26062764a2aaSMatthew G. Knepley { 26072764a2aaSMatthew G. Knepley PetscErrorCode ierr; 26082764a2aaSMatthew G. Knepley 26092764a2aaSMatthew G. Knepley PetscFunctionBegin; 26102764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 26112764a2aaSMatthew G. Knepley ierr = PetscDSSetUp(prob);CHKERRQ(ierr); 26122764a2aaSMatthew G. Knepley if (basis) {PetscValidPointer(basis, 2); *basis = prob->basis;} 26132764a2aaSMatthew G. Knepley if (basisDer) {PetscValidPointer(basisDer, 3); *basisDer = prob->basisDer;} 26142764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 26152764a2aaSMatthew G. Knepley } 26162764a2aaSMatthew G. Knepley 261768c9edb9SMatthew G. Knepley /*@C 26184d0b9603SSander Arens PetscDSGetFaceTabulation - Return the basis tabulation at quadrature points on the faces 261968c9edb9SMatthew G. Knepley 262068c9edb9SMatthew G. Knepley Not collective 262168c9edb9SMatthew G. Knepley 262268c9edb9SMatthew G. Knepley Input Parameter: 262368c9edb9SMatthew G. Knepley . prob - The PetscDS object 262468c9edb9SMatthew G. Knepley 262568c9edb9SMatthew G. Knepley Output Parameters: 26264d0b9603SSander Arens + basisFace - The basis function tabulation at quadrature points 26274d0b9603SSander Arens - basisDerFace - The basis function derivative tabulation at quadrature points 262868c9edb9SMatthew G. Knepley 262968c9edb9SMatthew G. Knepley Level: intermediate 263068c9edb9SMatthew G. Knepley 263168c9edb9SMatthew G. Knepley .seealso: PetscDSGetTabulation(), PetscDSCreate() 263268c9edb9SMatthew G. Knepley @*/ 26334d0b9603SSander Arens PetscErrorCode PetscDSGetFaceTabulation(PetscDS prob, PetscReal ***basis, PetscReal ***basisDer) 26342764a2aaSMatthew G. Knepley { 26352764a2aaSMatthew G. Knepley PetscErrorCode ierr; 26362764a2aaSMatthew G. Knepley 26372764a2aaSMatthew G. Knepley PetscFunctionBegin; 26382764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 26392764a2aaSMatthew G. Knepley ierr = PetscDSSetUp(prob);CHKERRQ(ierr); 26404d0b9603SSander Arens if (basis) {PetscValidPointer(basis, 2); *basis = prob->basisFace;} 26414d0b9603SSander Arens if (basisDer) {PetscValidPointer(basisDer, 3); *basisDer = prob->basisDerFace;} 26422764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 26432764a2aaSMatthew G. Knepley } 26442764a2aaSMatthew G. Knepley 26452764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetEvaluationArrays(PetscDS prob, PetscScalar **u, PetscScalar **u_t, PetscScalar **u_x) 26462764a2aaSMatthew G. Knepley { 26472764a2aaSMatthew G. Knepley PetscErrorCode ierr; 26482764a2aaSMatthew G. Knepley 26492764a2aaSMatthew G. Knepley PetscFunctionBegin; 26502764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 26512764a2aaSMatthew G. Knepley ierr = PetscDSSetUp(prob);CHKERRQ(ierr); 26522764a2aaSMatthew G. Knepley if (u) {PetscValidPointer(u, 2); *u = prob->u;} 26532764a2aaSMatthew G. Knepley if (u_t) {PetscValidPointer(u_t, 3); *u_t = prob->u_t;} 26542764a2aaSMatthew G. Knepley if (u_x) {PetscValidPointer(u_x, 4); *u_x = prob->u_x;} 26552764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 26562764a2aaSMatthew G. Knepley } 26572764a2aaSMatthew G. Knepley 26582764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetWeakFormArrays(PetscDS prob, PetscScalar **f0, PetscScalar **f1, PetscScalar **g0, PetscScalar **g1, PetscScalar **g2, PetscScalar **g3) 26592764a2aaSMatthew G. Knepley { 26602764a2aaSMatthew G. Knepley PetscErrorCode ierr; 26612764a2aaSMatthew G. Knepley 26622764a2aaSMatthew G. Knepley PetscFunctionBegin; 26632764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 26642764a2aaSMatthew G. Knepley ierr = PetscDSSetUp(prob);CHKERRQ(ierr); 26652764a2aaSMatthew G. Knepley if (f0) {PetscValidPointer(f0, 2); *f0 = prob->f0;} 26662764a2aaSMatthew G. Knepley if (f1) {PetscValidPointer(f1, 3); *f1 = prob->f1;} 26672764a2aaSMatthew G. Knepley if (g0) {PetscValidPointer(g0, 4); *g0 = prob->g0;} 26682764a2aaSMatthew G. Knepley if (g1) {PetscValidPointer(g1, 5); *g1 = prob->g1;} 26692764a2aaSMatthew G. Knepley if (g2) {PetscValidPointer(g2, 6); *g2 = prob->g2;} 26702764a2aaSMatthew G. Knepley if (g3) {PetscValidPointer(g3, 7); *g3 = prob->g3;} 26712764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 26722764a2aaSMatthew G. Knepley } 26732764a2aaSMatthew G. Knepley 26742764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetRefCoordArrays(PetscDS prob, PetscReal **x, PetscScalar **refSpaceDer) 26752764a2aaSMatthew G. Knepley { 26762764a2aaSMatthew G. Knepley PetscErrorCode ierr; 26772764a2aaSMatthew G. Knepley 26782764a2aaSMatthew G. Knepley PetscFunctionBegin; 26792764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 26802764a2aaSMatthew G. Knepley ierr = PetscDSSetUp(prob);CHKERRQ(ierr); 26812764a2aaSMatthew G. Knepley if (x) {PetscValidPointer(x, 2); *x = prob->x;} 26822764a2aaSMatthew G. Knepley if (refSpaceDer) {PetscValidPointer(refSpaceDer, 3); *refSpaceDer = prob->refSpaceDer;} 26832764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 26842764a2aaSMatthew G. Knepley } 26852764a2aaSMatthew G. Knepley 268658ebd649SToby Isaac /*@C 268758ebd649SToby Isaac PetscDSAddBoundary - Add a boundary condition to the model 268858ebd649SToby Isaac 268958ebd649SToby Isaac Input Parameters: 269058ebd649SToby Isaac + ds - The PetscDS object 26912d47a189SJulian Andrej . type - The type of condition, e.g. DM_BC_ESSENTIAL/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann) 269258ebd649SToby Isaac . name - The BC name 269358ebd649SToby Isaac . labelname - The label defining constrained points 269458ebd649SToby Isaac . field - The field to constrain 2695e8ecbf3fSStefano Zampini . numcomps - The number of constrained field components (0 will constrain all fields) 269658ebd649SToby Isaac . comps - An array of constrained component numbers 269758ebd649SToby Isaac . bcFunc - A pointwise function giving boundary values 269858ebd649SToby Isaac . numids - The number of DMLabel ids for constrained points 269958ebd649SToby Isaac . ids - An array of ids for constrained points 270058ebd649SToby Isaac - ctx - An optional user context for bcFunc 270158ebd649SToby Isaac 270258ebd649SToby Isaac Options Database Keys: 270358ebd649SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids 270458ebd649SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components 270558ebd649SToby Isaac 270658ebd649SToby Isaac Level: developer 270758ebd649SToby Isaac 270858ebd649SToby Isaac .seealso: PetscDSGetBoundary() 270958ebd649SToby Isaac @*/ 2710a30ec4eaSSatish 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) 271158ebd649SToby Isaac { 271258ebd649SToby Isaac DSBoundary b; 271358ebd649SToby Isaac PetscErrorCode ierr; 271458ebd649SToby Isaac 271558ebd649SToby Isaac PetscFunctionBegin; 271658ebd649SToby Isaac PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 271758ebd649SToby Isaac ierr = PetscNew(&b);CHKERRQ(ierr); 271858ebd649SToby Isaac ierr = PetscStrallocpy(name, (char **) &b->name);CHKERRQ(ierr); 271958ebd649SToby Isaac ierr = PetscStrallocpy(labelname, (char **) &b->labelname);CHKERRQ(ierr); 272058ebd649SToby Isaac ierr = PetscMalloc1(numcomps, &b->comps);CHKERRQ(ierr); 272158ebd649SToby Isaac if (numcomps) {ierr = PetscMemcpy(b->comps, comps, numcomps*sizeof(PetscInt));CHKERRQ(ierr);} 272258ebd649SToby Isaac ierr = PetscMalloc1(numids, &b->ids);CHKERRQ(ierr); 272358ebd649SToby Isaac if (numids) {ierr = PetscMemcpy(b->ids, ids, numids*sizeof(PetscInt));CHKERRQ(ierr);} 2724f971fd6bSMatthew G. Knepley b->type = type; 272558ebd649SToby Isaac b->field = field; 272658ebd649SToby Isaac b->numcomps = numcomps; 272758ebd649SToby Isaac b->func = bcFunc; 272858ebd649SToby Isaac b->numids = numids; 272958ebd649SToby Isaac b->ctx = ctx; 273058ebd649SToby Isaac b->next = ds->boundary; 273158ebd649SToby Isaac ds->boundary = b; 273258ebd649SToby Isaac PetscFunctionReturn(0); 273358ebd649SToby Isaac } 273458ebd649SToby Isaac 2735b67eacb3SMatthew G. Knepley /*@C 2736b67eacb3SMatthew G. Knepley PetscDSUpdateBoundary - Change a boundary condition for the model 2737b67eacb3SMatthew G. Knepley 2738b67eacb3SMatthew G. Knepley Input Parameters: 2739b67eacb3SMatthew G. Knepley + ds - The PetscDS object 2740b67eacb3SMatthew G. Knepley . bd - The boundary condition number 2741b67eacb3SMatthew G. Knepley . type - The type of condition, e.g. DM_BC_ESSENTIAL/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann) 2742b67eacb3SMatthew G. Knepley . name - The BC name 2743b67eacb3SMatthew G. Knepley . labelname - The label defining constrained points 2744b67eacb3SMatthew G. Knepley . field - The field to constrain 2745b67eacb3SMatthew G. Knepley . numcomps - The number of constrained field components 2746b67eacb3SMatthew G. Knepley . comps - An array of constrained component numbers 2747b67eacb3SMatthew G. Knepley . bcFunc - A pointwise function giving boundary values 2748b67eacb3SMatthew G. Knepley . numids - The number of DMLabel ids for constrained points 2749b67eacb3SMatthew G. Knepley . ids - An array of ids for constrained points 2750b67eacb3SMatthew G. Knepley - ctx - An optional user context for bcFunc 2751b67eacb3SMatthew G. Knepley 27529a6efb6aSMatthew G. Knepley Note: The boundary condition number is the order in which it was registered. The user can get the number of boundary conditions from PetscDSGetNumBoundary(). 27539a6efb6aSMatthew G. Knepley 2754b67eacb3SMatthew G. Knepley Level: developer 2755b67eacb3SMatthew G. Knepley 27569a6efb6aSMatthew G. Knepley .seealso: PetscDSAddBoundary(), PetscDSGetBoundary(), PetscDSGetNumBoundary() 2757b67eacb3SMatthew G. Knepley @*/ 2758b67eacb3SMatthew G. Knepley PetscErrorCode PetscDSUpdateBoundary(PetscDS ds, PetscInt bd, 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) 2759b67eacb3SMatthew G. Knepley { 2760b67eacb3SMatthew G. Knepley DSBoundary b = ds->boundary; 2761b67eacb3SMatthew G. Knepley PetscInt n = 0; 2762b67eacb3SMatthew G. Knepley PetscErrorCode ierr; 2763b67eacb3SMatthew G. Knepley 2764b67eacb3SMatthew G. Knepley PetscFunctionBegin; 2765b67eacb3SMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 2766b67eacb3SMatthew G. Knepley while (b) { 2767b67eacb3SMatthew G. Knepley if (n == bd) break; 2768b67eacb3SMatthew G. Knepley b = b->next; 2769b67eacb3SMatthew G. Knepley ++n; 2770b67eacb3SMatthew G. Knepley } 2771b67eacb3SMatthew G. Knepley if (!b) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Boundary %d is not in [0, %d)", bd, n); 2772b67eacb3SMatthew G. Knepley if (name) { 2773b67eacb3SMatthew G. Knepley ierr = PetscFree(b->name);CHKERRQ(ierr); 2774b67eacb3SMatthew G. Knepley ierr = PetscStrallocpy(name, (char **) &b->name);CHKERRQ(ierr); 2775b67eacb3SMatthew G. Knepley } 2776b67eacb3SMatthew G. Knepley if (labelname) { 2777b67eacb3SMatthew G. Knepley ierr = PetscFree(b->labelname);CHKERRQ(ierr); 2778b67eacb3SMatthew G. Knepley ierr = PetscStrallocpy(labelname, (char **) &b->labelname);CHKERRQ(ierr); 2779b67eacb3SMatthew G. Knepley } 2780b67eacb3SMatthew G. Knepley if (numcomps >= 0 && numcomps != b->numcomps) { 2781b67eacb3SMatthew G. Knepley b->numcomps = numcomps; 2782b67eacb3SMatthew G. Knepley ierr = PetscFree(b->comps);CHKERRQ(ierr); 2783b67eacb3SMatthew G. Knepley ierr = PetscMalloc1(numcomps, &b->comps);CHKERRQ(ierr); 2784b67eacb3SMatthew G. Knepley if (numcomps) {ierr = PetscMemcpy(b->comps, comps, numcomps*sizeof(PetscInt));CHKERRQ(ierr);} 2785b67eacb3SMatthew G. Knepley } 2786b67eacb3SMatthew G. Knepley if (numids >= 0 && numids != b->numids) { 2787b67eacb3SMatthew G. Knepley b->numids = numids; 2788b67eacb3SMatthew G. Knepley ierr = PetscFree(b->ids);CHKERRQ(ierr); 2789b67eacb3SMatthew G. Knepley ierr = PetscMalloc1(numids, &b->ids);CHKERRQ(ierr); 2790b67eacb3SMatthew G. Knepley if (numids) {ierr = PetscMemcpy(b->ids, ids, numids*sizeof(PetscInt));CHKERRQ(ierr);} 2791b67eacb3SMatthew G. Knepley } 2792b67eacb3SMatthew G. Knepley b->type = type; 2793b67eacb3SMatthew G. Knepley if (field >= 0) {b->field = field;} 2794b67eacb3SMatthew G. Knepley if (bcFunc) {b->func = bcFunc;} 2795b67eacb3SMatthew G. Knepley if (ctx) {b->ctx = ctx;} 2796b67eacb3SMatthew G. Knepley PetscFunctionReturn(0); 2797b67eacb3SMatthew G. Knepley } 2798b67eacb3SMatthew G. Knepley 279958ebd649SToby Isaac /*@ 280058ebd649SToby Isaac PetscDSGetNumBoundary - Get the number of registered BC 280158ebd649SToby Isaac 280258ebd649SToby Isaac Input Parameters: 280358ebd649SToby Isaac . ds - The PetscDS object 280458ebd649SToby Isaac 280558ebd649SToby Isaac Output Parameters: 280658ebd649SToby Isaac . numBd - The number of BC 280758ebd649SToby Isaac 280858ebd649SToby Isaac Level: intermediate 280958ebd649SToby Isaac 281058ebd649SToby Isaac .seealso: PetscDSAddBoundary(), PetscDSGetBoundary() 281158ebd649SToby Isaac @*/ 281258ebd649SToby Isaac PetscErrorCode PetscDSGetNumBoundary(PetscDS ds, PetscInt *numBd) 281358ebd649SToby Isaac { 281458ebd649SToby Isaac DSBoundary b = ds->boundary; 281558ebd649SToby Isaac 281658ebd649SToby Isaac PetscFunctionBegin; 281758ebd649SToby Isaac PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 281858ebd649SToby Isaac PetscValidPointer(numBd, 2); 281958ebd649SToby Isaac *numBd = 0; 282058ebd649SToby Isaac while (b) {++(*numBd); b = b->next;} 282158ebd649SToby Isaac PetscFunctionReturn(0); 282258ebd649SToby Isaac } 282358ebd649SToby Isaac 282458ebd649SToby Isaac /*@C 28259a6efb6aSMatthew G. Knepley PetscDSGetBoundary - Gets a boundary condition to the model 282658ebd649SToby Isaac 282758ebd649SToby Isaac Input Parameters: 282858ebd649SToby Isaac + ds - The PetscDS object 282958ebd649SToby Isaac - bd - The BC number 283058ebd649SToby Isaac 283158ebd649SToby Isaac Output Parameters: 28322d47a189SJulian Andrej + type - The type of condition, e.g. DM_BC_ESSENTIAL/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann) 283358ebd649SToby Isaac . name - The BC name 283458ebd649SToby Isaac . labelname - The label defining constrained points 283558ebd649SToby Isaac . field - The field to constrain 283658ebd649SToby Isaac . numcomps - The number of constrained field components 283758ebd649SToby Isaac . comps - An array of constrained component numbers 283858ebd649SToby Isaac . bcFunc - A pointwise function giving boundary values 283958ebd649SToby Isaac . numids - The number of DMLabel ids for constrained points 284058ebd649SToby Isaac . ids - An array of ids for constrained points 284158ebd649SToby Isaac - ctx - An optional user context for bcFunc 284258ebd649SToby Isaac 284358ebd649SToby Isaac Options Database Keys: 284458ebd649SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids 284558ebd649SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components 284658ebd649SToby Isaac 284758ebd649SToby Isaac Level: developer 284858ebd649SToby Isaac 284958ebd649SToby Isaac .seealso: PetscDSAddBoundary() 285058ebd649SToby Isaac @*/ 2851a30ec4eaSSatish 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) 285258ebd649SToby Isaac { 285358ebd649SToby Isaac DSBoundary b = ds->boundary; 285458ebd649SToby Isaac PetscInt n = 0; 285558ebd649SToby Isaac 285658ebd649SToby Isaac PetscFunctionBegin; 285758ebd649SToby Isaac PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 285858ebd649SToby Isaac while (b) { 285958ebd649SToby Isaac if (n == bd) break; 286058ebd649SToby Isaac b = b->next; 286158ebd649SToby Isaac ++n; 286258ebd649SToby Isaac } 286358ebd649SToby Isaac if (!b) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Boundary %d is not in [0, %d)", bd, n); 2864f971fd6bSMatthew G. Knepley if (type) { 2865f971fd6bSMatthew G. Knepley PetscValidPointer(type, 3); 2866f971fd6bSMatthew G. Knepley *type = b->type; 286758ebd649SToby Isaac } 286858ebd649SToby Isaac if (name) { 286958ebd649SToby Isaac PetscValidPointer(name, 4); 287058ebd649SToby Isaac *name = b->name; 287158ebd649SToby Isaac } 287258ebd649SToby Isaac if (labelname) { 287358ebd649SToby Isaac PetscValidPointer(labelname, 5); 287458ebd649SToby Isaac *labelname = b->labelname; 287558ebd649SToby Isaac } 287658ebd649SToby Isaac if (field) { 287758ebd649SToby Isaac PetscValidPointer(field, 6); 287858ebd649SToby Isaac *field = b->field; 287958ebd649SToby Isaac } 288058ebd649SToby Isaac if (numcomps) { 288158ebd649SToby Isaac PetscValidPointer(numcomps, 7); 288258ebd649SToby Isaac *numcomps = b->numcomps; 288358ebd649SToby Isaac } 288458ebd649SToby Isaac if (comps) { 288558ebd649SToby Isaac PetscValidPointer(comps, 8); 288658ebd649SToby Isaac *comps = b->comps; 288758ebd649SToby Isaac } 288858ebd649SToby Isaac if (func) { 288958ebd649SToby Isaac PetscValidPointer(func, 9); 289058ebd649SToby Isaac *func = b->func; 289158ebd649SToby Isaac } 289258ebd649SToby Isaac if (numids) { 289358ebd649SToby Isaac PetscValidPointer(numids, 10); 289458ebd649SToby Isaac *numids = b->numids; 289558ebd649SToby Isaac } 289658ebd649SToby Isaac if (ids) { 289758ebd649SToby Isaac PetscValidPointer(ids, 11); 289858ebd649SToby Isaac *ids = b->ids; 289958ebd649SToby Isaac } 290058ebd649SToby Isaac if (ctx) { 290158ebd649SToby Isaac PetscValidPointer(ctx, 12); 290258ebd649SToby Isaac *ctx = b->ctx; 290358ebd649SToby Isaac } 290458ebd649SToby Isaac PetscFunctionReturn(0); 290558ebd649SToby Isaac } 290658ebd649SToby Isaac 29079252d075SMatthew G. Knepley /*@ 29089252d075SMatthew G. Knepley PetscDSCopyBoundary - Copy all boundary condition objects to the new problem 29099252d075SMatthew G. Knepley 29109252d075SMatthew G. Knepley Not collective 29119252d075SMatthew G. Knepley 29129252d075SMatthew G. Knepley Input Parameter: 29139252d075SMatthew G. Knepley . prob - The PetscDS object 29149252d075SMatthew G. Knepley 29159252d075SMatthew G. Knepley Output Parameter: 29169252d075SMatthew G. Knepley . newprob - The PetscDS copy 29179252d075SMatthew G. Knepley 29189252d075SMatthew G. Knepley Level: intermediate 29199252d075SMatthew G. Knepley 29209252d075SMatthew G. Knepley .seealso: PetscDSCopyEquations(), PetscDSSetResidual(), PetscDSSetJacobian(), PetscDSSetRiemannSolver(), PetscDSSetBdResidual(), PetscDSSetBdJacobian(), PetscDSCreate() 29219252d075SMatthew G. Knepley @*/ 2922dff059c6SToby Isaac PetscErrorCode PetscDSCopyBoundary(PetscDS probA, PetscDS probB) 2923dff059c6SToby Isaac { 2924dff059c6SToby Isaac DSBoundary b, next, *lastnext; 2925dff059c6SToby Isaac PetscErrorCode ierr; 2926dff059c6SToby Isaac 2927dff059c6SToby Isaac PetscFunctionBegin; 2928dff059c6SToby Isaac PetscValidHeaderSpecific(probA, PETSCDS_CLASSID, 1); 2929dff059c6SToby Isaac PetscValidHeaderSpecific(probB, PETSCDS_CLASSID, 2); 2930dff059c6SToby Isaac if (probA == probB) PetscFunctionReturn(0); 2931dff059c6SToby Isaac next = probB->boundary; 2932dff059c6SToby Isaac while (next) { 2933dff059c6SToby Isaac DSBoundary b = next; 2934dff059c6SToby Isaac 2935dff059c6SToby Isaac next = b->next; 2936dff059c6SToby Isaac ierr = PetscFree(b->comps);CHKERRQ(ierr); 2937dff059c6SToby Isaac ierr = PetscFree(b->ids);CHKERRQ(ierr); 2938dff059c6SToby Isaac ierr = PetscFree(b->name);CHKERRQ(ierr); 2939dff059c6SToby Isaac ierr = PetscFree(b->labelname);CHKERRQ(ierr); 2940dff059c6SToby Isaac ierr = PetscFree(b);CHKERRQ(ierr); 2941dff059c6SToby Isaac } 2942dff059c6SToby Isaac lastnext = &(probB->boundary); 2943dff059c6SToby Isaac for (b = probA->boundary; b; b = b->next) { 2944dff059c6SToby Isaac DSBoundary bNew; 2945dff059c6SToby Isaac 2946459726d8SSatish Balay ierr = PetscNew(&bNew);CHKERRQ(ierr); 2947dff059c6SToby Isaac bNew->numcomps = b->numcomps; 2948dff059c6SToby Isaac ierr = PetscMalloc1(bNew->numcomps, &bNew->comps);CHKERRQ(ierr); 2949dff059c6SToby Isaac ierr = PetscMemcpy(bNew->comps, b->comps, bNew->numcomps*sizeof(PetscInt));CHKERRQ(ierr); 2950dff059c6SToby Isaac bNew->numids = b->numids; 2951dff059c6SToby Isaac ierr = PetscMalloc1(bNew->numids, &bNew->ids);CHKERRQ(ierr); 2952dff059c6SToby Isaac ierr = PetscMemcpy(bNew->ids, b->ids, bNew->numids*sizeof(PetscInt));CHKERRQ(ierr); 2953dff059c6SToby Isaac ierr = PetscStrallocpy(b->labelname,(char **) &(bNew->labelname));CHKERRQ(ierr); 2954dff059c6SToby Isaac ierr = PetscStrallocpy(b->name,(char **) &(bNew->name));CHKERRQ(ierr); 2955dff059c6SToby Isaac bNew->ctx = b->ctx; 2956f971fd6bSMatthew G. Knepley bNew->type = b->type; 2957dff059c6SToby Isaac bNew->field = b->field; 2958dff059c6SToby Isaac bNew->func = b->func; 2959dff059c6SToby Isaac 2960dff059c6SToby Isaac *lastnext = bNew; 2961dff059c6SToby Isaac lastnext = &(bNew->next); 2962dff059c6SToby Isaac } 2963dff059c6SToby Isaac PetscFunctionReturn(0); 2964dff059c6SToby Isaac } 2965dff059c6SToby Isaac 29669252d075SMatthew G. Knepley /*@C 29679252d075SMatthew G. Knepley PetscDSSelectEquations - Copy pointwise function pointers to the new problem with different field layout 29689252d075SMatthew G. Knepley 29699252d075SMatthew G. Knepley Not collective 29709252d075SMatthew G. Knepley 29719252d075SMatthew G. Knepley Input Parameter: 29729252d075SMatthew G. Knepley + prob - The PetscDS object 29739252d075SMatthew G. Knepley . numFields - Number of new fields 29749252d075SMatthew G. Knepley - fields - Old field number for each new field 29759252d075SMatthew G. Knepley 29769252d075SMatthew G. Knepley Output Parameter: 29779252d075SMatthew G. Knepley . newprob - The PetscDS copy 29789252d075SMatthew G. Knepley 29799252d075SMatthew G. Knepley Level: intermediate 29809252d075SMatthew G. Knepley 29819252d075SMatthew G. Knepley .seealso: PetscDSCopyBoundary(), PetscDSSetResidual(), PetscDSSetJacobian(), PetscDSSetRiemannSolver(), PetscDSSetBdResidual(), PetscDSSetBdJacobian(), PetscDSCreate() 29829252d075SMatthew G. Knepley @*/ 29839252d075SMatthew G. Knepley PetscErrorCode PetscDSSelectEquations(PetscDS prob, PetscInt numFields, const PetscInt fields[], PetscDS newprob) 29849252d075SMatthew G. Knepley { 29859252d075SMatthew G. Knepley PetscInt Nf, Nfn, fn, gn; 29869252d075SMatthew G. Knepley PetscErrorCode ierr; 29879252d075SMatthew G. Knepley 29889252d075SMatthew G. Knepley PetscFunctionBegin; 29899252d075SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 29909252d075SMatthew G. Knepley if (fields) PetscValidPointer(fields, 3); 29919252d075SMatthew G. Knepley PetscValidHeaderSpecific(newprob, PETSCDS_CLASSID, 4); 29929252d075SMatthew G. Knepley ierr = PetscDSGetNumFields(prob, &Nf);CHKERRQ(ierr); 29939252d075SMatthew G. Knepley ierr = PetscDSGetNumFields(newprob, &Nfn);CHKERRQ(ierr); 29949252d075SMatthew G. Knepley if (numFields > Nfn) SETERRQ2(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_SIZ, "Number of fields %D to transfer must not be greater then the total number of fields %D", numFields, Nfn); 29959252d075SMatthew G. Knepley for (fn = 0; fn < numFields; ++fn) { 29969252d075SMatthew G. Knepley const PetscInt f = fields ? fields[fn] : fn; 29979252d075SMatthew G. Knepley PetscPointFunc obj; 29989252d075SMatthew G. Knepley PetscPointFunc f0, f1; 29999252d075SMatthew G. Knepley PetscBdPointFunc f0Bd, f1Bd; 30009252d075SMatthew G. Knepley PetscRiemannFunc r; 30019252d075SMatthew G. Knepley 30029252d075SMatthew G. Knepley if (f >= Nf) SETERRQ2(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_SIZ, "Field %D must be in [0, %D)", f, Nf); 30039252d075SMatthew G. Knepley ierr = PetscDSGetObjective(prob, f, &obj);CHKERRQ(ierr); 30049252d075SMatthew G. Knepley ierr = PetscDSGetResidual(prob, f, &f0, &f1);CHKERRQ(ierr); 30059252d075SMatthew G. Knepley ierr = PetscDSGetBdResidual(prob, f, &f0Bd, &f1Bd);CHKERRQ(ierr); 30069252d075SMatthew G. Knepley ierr = PetscDSGetRiemannSolver(prob, f, &r);CHKERRQ(ierr); 30079252d075SMatthew G. Knepley ierr = PetscDSSetObjective(newprob, fn, obj);CHKERRQ(ierr); 30089252d075SMatthew G. Knepley ierr = PetscDSSetResidual(newprob, fn, f0, f1);CHKERRQ(ierr); 30099252d075SMatthew G. Knepley ierr = PetscDSSetBdResidual(newprob, fn, f0Bd, f1Bd);CHKERRQ(ierr); 30109252d075SMatthew G. Knepley ierr = PetscDSSetRiemannSolver(newprob, fn, r);CHKERRQ(ierr); 30119252d075SMatthew G. Knepley for (gn = 0; gn < numFields; ++gn) { 30129252d075SMatthew G. Knepley const PetscInt g = fields ? fields[gn] : gn; 30139252d075SMatthew G. Knepley PetscPointJac g0, g1, g2, g3; 30149252d075SMatthew G. Knepley PetscPointJac g0p, g1p, g2p, g3p; 30159252d075SMatthew G. Knepley PetscBdPointJac g0Bd, g1Bd, g2Bd, g3Bd; 30169252d075SMatthew G. Knepley 30179252d075SMatthew G. Knepley if (g >= Nf) SETERRQ2(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_SIZ, "Field %D must be in [0, %D)", g, Nf); 30189252d075SMatthew G. Knepley ierr = PetscDSGetJacobian(prob, f, g, &g0, &g1, &g2, &g3);CHKERRQ(ierr); 30199252d075SMatthew G. Knepley ierr = PetscDSGetJacobianPreconditioner(prob, f, g, &g0p, &g1p, &g2p, &g3p);CHKERRQ(ierr); 30209252d075SMatthew G. Knepley ierr = PetscDSGetBdJacobian(prob, f, g, &g0Bd, &g1Bd, &g2Bd, &g3Bd);CHKERRQ(ierr); 30219252d075SMatthew G. Knepley ierr = PetscDSSetJacobian(newprob, fn, gn, g0, g1, g2, g3);CHKERRQ(ierr); 30229252d075SMatthew G. Knepley ierr = PetscDSSetJacobianPreconditioner(prob, fn, gn, g0p, g1p, g2p, g3p);CHKERRQ(ierr); 30239252d075SMatthew G. Knepley ierr = PetscDSSetBdJacobian(newprob, fn, gn, g0Bd, g1Bd, g2Bd, g3Bd);CHKERRQ(ierr); 30249252d075SMatthew G. Knepley } 30259252d075SMatthew G. Knepley } 30269252d075SMatthew G. Knepley PetscFunctionReturn(0); 30279252d075SMatthew G. Knepley } 30289252d075SMatthew G. Knepley 3029da51fcedSMatthew G. Knepley /*@ 3030da51fcedSMatthew G. Knepley PetscDSCopyEquations - Copy all pointwise function pointers to the new problem 3031da51fcedSMatthew G. Knepley 3032da51fcedSMatthew G. Knepley Not collective 3033da51fcedSMatthew G. Knepley 3034da51fcedSMatthew G. Knepley Input Parameter: 3035da51fcedSMatthew G. Knepley . prob - The PetscDS object 3036da51fcedSMatthew G. Knepley 3037da51fcedSMatthew G. Knepley Output Parameter: 3038da51fcedSMatthew G. Knepley . newprob - The PetscDS copy 3039da51fcedSMatthew G. Knepley 3040da51fcedSMatthew G. Knepley Level: intermediate 3041da51fcedSMatthew G. Knepley 30429252d075SMatthew G. Knepley .seealso: PetscDSCopyBoundary(), PetscDSSetResidual(), PetscDSSetJacobian(), PetscDSSetRiemannSolver(), PetscDSSetBdResidual(), PetscDSSetBdJacobian(), PetscDSCreate() 3043da51fcedSMatthew G. Knepley @*/ 3044da51fcedSMatthew G. Knepley PetscErrorCode PetscDSCopyEquations(PetscDS prob, PetscDS newprob) 3045da51fcedSMatthew G. Knepley { 30469252d075SMatthew G. Knepley PetscInt Nf, Ng; 3047da51fcedSMatthew G. Knepley PetscErrorCode ierr; 3048da51fcedSMatthew G. Knepley 3049da51fcedSMatthew G. Knepley PetscFunctionBegin; 3050da51fcedSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 3051da51fcedSMatthew G. Knepley PetscValidHeaderSpecific(newprob, PETSCDS_CLASSID, 2); 3052da51fcedSMatthew G. Knepley ierr = PetscDSGetNumFields(prob, &Nf);CHKERRQ(ierr); 3053da51fcedSMatthew G. Knepley ierr = PetscDSGetNumFields(newprob, &Ng);CHKERRQ(ierr); 305413903a91SSatish Balay if (Nf != Ng) SETERRQ2(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_SIZ, "Number of fields must match %D != %D", Nf, Ng); 30559252d075SMatthew G. Knepley ierr = PetscDSSelectEquations(prob, Nf, NULL, newprob);CHKERRQ(ierr); 30569252d075SMatthew G. Knepley PetscFunctionReturn(0); 30579252d075SMatthew G. Knepley } 30589252d075SMatthew G. Knepley /*@ 30599252d075SMatthew G. Knepley PetscDSCopyConstants - Copy all constants to the new problem 3060da51fcedSMatthew G. Knepley 30619252d075SMatthew G. Knepley Not collective 30629252d075SMatthew G. Knepley 30639252d075SMatthew G. Knepley Input Parameter: 30649252d075SMatthew G. Knepley . prob - The PetscDS object 30659252d075SMatthew G. Knepley 30669252d075SMatthew G. Knepley Output Parameter: 30679252d075SMatthew G. Knepley . newprob - The PetscDS copy 30689252d075SMatthew G. Knepley 30699252d075SMatthew G. Knepley Level: intermediate 30709252d075SMatthew G. Knepley 30719252d075SMatthew G. Knepley .seealso: PetscDSCopyBoundary(), PetscDSCopyEquations(), PetscDSSetResidual(), PetscDSSetJacobian(), PetscDSSetRiemannSolver(), PetscDSSetBdResidual(), PetscDSSetBdJacobian(), PetscDSCreate() 30729252d075SMatthew G. Knepley @*/ 30739252d075SMatthew G. Knepley PetscErrorCode PetscDSCopyConstants(PetscDS prob, PetscDS newprob) 30749252d075SMatthew G. Knepley { 30759252d075SMatthew G. Knepley PetscInt Nc; 30769252d075SMatthew G. Knepley const PetscScalar *constants; 30779252d075SMatthew G. Knepley PetscErrorCode ierr; 30789252d075SMatthew G. Knepley 30799252d075SMatthew G. Knepley PetscFunctionBegin; 30809252d075SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 30819252d075SMatthew G. Knepley PetscValidHeaderSpecific(newprob, PETSCDS_CLASSID, 2); 30829252d075SMatthew G. Knepley ierr = PetscDSGetConstants(prob, &Nc, &constants);CHKERRQ(ierr); 30839252d075SMatthew G. Knepley ierr = PetscDSSetConstants(newprob, Nc, (PetscScalar *) constants);CHKERRQ(ierr); 3084da51fcedSMatthew G. Knepley PetscFunctionReturn(0); 3085da51fcedSMatthew G. Knepley } 3086da51fcedSMatthew G. Knepley 3087b1353e8eSMatthew G. Knepley PetscErrorCode PetscDSGetHeightSubspace(PetscDS prob, PetscInt height, PetscDS *subprob) 3088b1353e8eSMatthew G. Knepley { 3089df3a45bdSMatthew G. Knepley PetscInt dim, Nf, f; 3090b1353e8eSMatthew G. Knepley PetscErrorCode ierr; 3091b1353e8eSMatthew G. Knepley 3092b1353e8eSMatthew G. Knepley PetscFunctionBegin; 3093b1353e8eSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 3094b1353e8eSMatthew G. Knepley PetscValidPointer(subprob, 3); 3095b1353e8eSMatthew G. Knepley if (height == 0) {*subprob = prob; PetscFunctionReturn(0);} 3096b1353e8eSMatthew G. Knepley ierr = PetscDSGetNumFields(prob, &Nf);CHKERRQ(ierr); 3097df3a45bdSMatthew G. Knepley ierr = PetscDSGetSpatialDimension(prob, &dim);CHKERRQ(ierr); 3098df3a45bdSMatthew G. Knepley if (height > dim) SETERRQ2(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_OUTOFRANGE, "DS can only handle height in [0, %D], not %D", dim, height); 3099df3a45bdSMatthew G. Knepley if (!prob->subprobs) {ierr = PetscCalloc1(dim, &prob->subprobs);CHKERRQ(ierr);} 3100df3a45bdSMatthew G. Knepley if (!prob->subprobs[height-1]) { 3101b1353e8eSMatthew G. Knepley PetscInt cdim; 3102b1353e8eSMatthew G. Knepley 3103df3a45bdSMatthew G. Knepley ierr = PetscDSCreate(PetscObjectComm((PetscObject) prob), &prob->subprobs[height-1]);CHKERRQ(ierr); 3104b1353e8eSMatthew G. Knepley ierr = PetscDSGetCoordinateDimension(prob, &cdim);CHKERRQ(ierr); 3105df3a45bdSMatthew G. Knepley ierr = PetscDSSetCoordinateDimension(prob->subprobs[height-1], cdim);CHKERRQ(ierr); 3106b1353e8eSMatthew G. Knepley for (f = 0; f < Nf; ++f) { 3107b1353e8eSMatthew G. Knepley PetscFE subfe; 3108b1353e8eSMatthew G. Knepley PetscObject obj; 3109b1353e8eSMatthew G. Knepley PetscClassId id; 3110b1353e8eSMatthew G. Knepley 3111b1353e8eSMatthew G. Knepley ierr = PetscDSGetDiscretization(prob, f, &obj);CHKERRQ(ierr); 3112b1353e8eSMatthew G. Knepley ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr); 3113b1353e8eSMatthew G. Knepley if (id == PETSCFE_CLASSID) {ierr = PetscFEGetHeightSubspace((PetscFE) obj, height, &subfe);CHKERRQ(ierr);} 3114b1353e8eSMatthew G. Knepley else SETERRQ1(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Unsupported discretization type for field %d", f); 3115df3a45bdSMatthew G. Knepley ierr = PetscDSSetDiscretization(prob->subprobs[height-1], f, (PetscObject) subfe);CHKERRQ(ierr); 3116b1353e8eSMatthew G. Knepley } 3117b1353e8eSMatthew G. Knepley } 3118df3a45bdSMatthew G. Knepley *subprob = prob->subprobs[height-1]; 3119b1353e8eSMatthew G. Knepley PetscFunctionReturn(0); 3120b1353e8eSMatthew G. Knepley } 3121b1353e8eSMatthew G. Knepley 3122bc4ae4beSMatthew G. Knepley static PetscErrorCode PetscDSDestroy_Basic(PetscDS prob) 31232764a2aaSMatthew G. Knepley { 3124931fb3b8SToby Isaac PetscErrorCode ierr; 3125931fb3b8SToby Isaac 31262764a2aaSMatthew G. Knepley PetscFunctionBegin; 3127931fb3b8SToby Isaac ierr = PetscFree(prob->data);CHKERRQ(ierr); 31282764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 31292764a2aaSMatthew G. Knepley } 31302764a2aaSMatthew G. Knepley 3131bc4ae4beSMatthew G. Knepley static PetscErrorCode PetscDSInitialize_Basic(PetscDS prob) 31322764a2aaSMatthew G. Knepley { 31332764a2aaSMatthew G. Knepley PetscFunctionBegin; 31342764a2aaSMatthew G. Knepley prob->ops->setfromoptions = NULL; 31352764a2aaSMatthew G. Knepley prob->ops->setup = NULL; 31362764a2aaSMatthew G. Knepley prob->ops->view = NULL; 31372764a2aaSMatthew G. Knepley prob->ops->destroy = PetscDSDestroy_Basic; 31382764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 31392764a2aaSMatthew G. Knepley } 31402764a2aaSMatthew G. Knepley 31412764a2aaSMatthew G. Knepley /*MC 31422764a2aaSMatthew G. Knepley PETSCDSBASIC = "basic" - A discrete system with pointwise residual and boundary residual functions 31432764a2aaSMatthew G. Knepley 31442764a2aaSMatthew G. Knepley Level: intermediate 31452764a2aaSMatthew G. Knepley 31462764a2aaSMatthew G. Knepley .seealso: PetscDSType, PetscDSCreate(), PetscDSSetType() 31472764a2aaSMatthew G. Knepley M*/ 31482764a2aaSMatthew G. Knepley 31492764a2aaSMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscDSCreate_Basic(PetscDS prob) 31502764a2aaSMatthew G. Knepley { 31512764a2aaSMatthew G. Knepley PetscDS_Basic *b; 31522764a2aaSMatthew G. Knepley PetscErrorCode ierr; 31532764a2aaSMatthew G. Knepley 31542764a2aaSMatthew G. Knepley PetscFunctionBegin; 3155931fb3b8SToby Isaac PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 31562764a2aaSMatthew G. Knepley ierr = PetscNewLog(prob, &b);CHKERRQ(ierr); 31572764a2aaSMatthew G. Knepley prob->data = b; 31582764a2aaSMatthew G. Knepley 31592764a2aaSMatthew G. Knepley ierr = PetscDSInitialize_Basic(prob);CHKERRQ(ierr); 31602764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 31612764a2aaSMatthew G. Knepley } 3162