1af0996ceSBarry Smith #include <petsc/private/petscdsimpl.h> /*I "petscds.h" I*/ 22764a2aaSMatthew G. Knepley 32764a2aaSMatthew G. Knepley PetscClassId PETSCDS_CLASSID = 0; 42764a2aaSMatthew G. Knepley 52764a2aaSMatthew G. Knepley PetscFunctionList PetscDSList = NULL; 62764a2aaSMatthew G. Knepley PetscBool PetscDSRegisterAllCalled = PETSC_FALSE; 72764a2aaSMatthew G. Knepley 82764a2aaSMatthew G. Knepley /*@C 92764a2aaSMatthew G. Knepley PetscDSRegister - Adds a new PetscDS implementation 102764a2aaSMatthew G. Knepley 112764a2aaSMatthew G. Knepley Not Collective 122764a2aaSMatthew G. Knepley 132764a2aaSMatthew G. Knepley Input Parameters: 142764a2aaSMatthew G. Knepley + name - The name of a new user-defined creation routine 152764a2aaSMatthew G. Knepley - create_func - The creation routine itself 162764a2aaSMatthew G. Knepley 172764a2aaSMatthew G. Knepley Notes: 182764a2aaSMatthew G. Knepley PetscDSRegister() may be called multiple times to add several user-defined PetscDSs 192764a2aaSMatthew G. Knepley 202764a2aaSMatthew G. Knepley Sample usage: 212764a2aaSMatthew G. Knepley .vb 222764a2aaSMatthew G. Knepley PetscDSRegister("my_ds", MyPetscDSCreate); 232764a2aaSMatthew G. Knepley .ve 242764a2aaSMatthew G. Knepley 252764a2aaSMatthew G. Knepley Then, your PetscDS type can be chosen with the procedural interface via 262764a2aaSMatthew G. Knepley .vb 272764a2aaSMatthew G. Knepley PetscDSCreate(MPI_Comm, PetscDS *); 282764a2aaSMatthew G. Knepley PetscDSSetType(PetscDS, "my_ds"); 292764a2aaSMatthew G. Knepley .ve 302764a2aaSMatthew G. Knepley or at runtime via the option 312764a2aaSMatthew G. Knepley .vb 322764a2aaSMatthew G. Knepley -petscds_type my_ds 332764a2aaSMatthew G. Knepley .ve 342764a2aaSMatthew G. Knepley 352764a2aaSMatthew G. Knepley Level: advanced 362764a2aaSMatthew G. Knepley 372764a2aaSMatthew G. Knepley .keywords: PetscDS, register 382764a2aaSMatthew G. Knepley .seealso: PetscDSRegisterAll(), PetscDSRegisterDestroy() 392764a2aaSMatthew G. Knepley 402764a2aaSMatthew G. Knepley @*/ 412764a2aaSMatthew G. Knepley PetscErrorCode PetscDSRegister(const char sname[], PetscErrorCode (*function)(PetscDS)) 422764a2aaSMatthew G. Knepley { 432764a2aaSMatthew G. Knepley PetscErrorCode ierr; 442764a2aaSMatthew G. Knepley 452764a2aaSMatthew G. Knepley PetscFunctionBegin; 462764a2aaSMatthew G. Knepley ierr = PetscFunctionListAdd(&PetscDSList, sname, function);CHKERRQ(ierr); 472764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 482764a2aaSMatthew G. Knepley } 492764a2aaSMatthew G. Knepley 502764a2aaSMatthew G. Knepley /*@C 512764a2aaSMatthew G. Knepley PetscDSSetType - Builds a particular PetscDS 522764a2aaSMatthew G. Knepley 532764a2aaSMatthew G. Knepley Collective on PetscDS 542764a2aaSMatthew G. Knepley 552764a2aaSMatthew G. Knepley Input Parameters: 562764a2aaSMatthew G. Knepley + prob - The PetscDS object 572764a2aaSMatthew G. Knepley - name - The kind of system 582764a2aaSMatthew G. Knepley 592764a2aaSMatthew G. Knepley Options Database Key: 602764a2aaSMatthew G. Knepley . -petscds_type <type> - Sets the PetscDS type; use -help for a list of available types 612764a2aaSMatthew G. Knepley 622764a2aaSMatthew G. Knepley Level: intermediate 632764a2aaSMatthew G. Knepley 642764a2aaSMatthew G. Knepley .keywords: PetscDS, set, type 652764a2aaSMatthew G. Knepley .seealso: PetscDSGetType(), PetscDSCreate() 662764a2aaSMatthew G. Knepley @*/ 672764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetType(PetscDS prob, PetscDSType name) 682764a2aaSMatthew G. Knepley { 692764a2aaSMatthew G. Knepley PetscErrorCode (*r)(PetscDS); 702764a2aaSMatthew G. Knepley PetscBool match; 712764a2aaSMatthew G. Knepley PetscErrorCode ierr; 722764a2aaSMatthew G. Knepley 732764a2aaSMatthew G. Knepley PetscFunctionBegin; 742764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 752764a2aaSMatthew G. Knepley ierr = PetscObjectTypeCompare((PetscObject) prob, name, &match);CHKERRQ(ierr); 762764a2aaSMatthew G. Knepley if (match) PetscFunctionReturn(0); 772764a2aaSMatthew G. Knepley 780f51fdf8SToby Isaac ierr = PetscDSRegisterAll();CHKERRQ(ierr); 792764a2aaSMatthew G. Knepley ierr = PetscFunctionListFind(PetscDSList, name, &r);CHKERRQ(ierr); 802764a2aaSMatthew G. Knepley if (!r) SETERRQ1(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_UNKNOWN_TYPE, "Unknown PetscDS type: %s", name); 812764a2aaSMatthew G. Knepley 822764a2aaSMatthew G. Knepley if (prob->ops->destroy) { 832764a2aaSMatthew G. Knepley ierr = (*prob->ops->destroy)(prob);CHKERRQ(ierr); 842764a2aaSMatthew G. Knepley prob->ops->destroy = NULL; 852764a2aaSMatthew G. Knepley } 862764a2aaSMatthew G. Knepley ierr = (*r)(prob);CHKERRQ(ierr); 872764a2aaSMatthew G. Knepley ierr = PetscObjectChangeTypeName((PetscObject) prob, name);CHKERRQ(ierr); 882764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 892764a2aaSMatthew G. Knepley } 902764a2aaSMatthew G. Knepley 912764a2aaSMatthew G. Knepley /*@C 922764a2aaSMatthew G. Knepley PetscDSGetType - Gets the PetscDS type name (as a string) from the object. 932764a2aaSMatthew G. Knepley 942764a2aaSMatthew G. Knepley Not Collective 952764a2aaSMatthew G. Knepley 962764a2aaSMatthew G. Knepley Input Parameter: 972764a2aaSMatthew G. Knepley . prob - The PetscDS 982764a2aaSMatthew G. Knepley 992764a2aaSMatthew G. Knepley Output Parameter: 1002764a2aaSMatthew G. Knepley . name - The PetscDS type name 1012764a2aaSMatthew G. Knepley 1022764a2aaSMatthew G. Knepley Level: intermediate 1032764a2aaSMatthew G. Knepley 1042764a2aaSMatthew G. Knepley .keywords: PetscDS, get, type, name 1052764a2aaSMatthew G. Knepley .seealso: PetscDSSetType(), PetscDSCreate() 1062764a2aaSMatthew G. Knepley @*/ 1072764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetType(PetscDS prob, PetscDSType *name) 1082764a2aaSMatthew G. Knepley { 1092764a2aaSMatthew G. Knepley PetscErrorCode ierr; 1102764a2aaSMatthew G. Knepley 1112764a2aaSMatthew G. Knepley PetscFunctionBegin; 1122764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 113c959eef4SJed Brown PetscValidPointer(name, 2); 1140f51fdf8SToby Isaac ierr = PetscDSRegisterAll();CHKERRQ(ierr); 1152764a2aaSMatthew G. Knepley *name = ((PetscObject) prob)->type_name; 1162764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 1172764a2aaSMatthew G. Knepley } 1182764a2aaSMatthew G. Knepley 1197d8a60eaSMatthew G. Knepley static PetscErrorCode PetscDSView_Ascii(PetscDS prob, PetscViewer viewer) 1207d8a60eaSMatthew G. Knepley { 1217d8a60eaSMatthew G. Knepley PetscViewerFormat format; 12297b6e6e8SMatthew G. Knepley const PetscScalar *constants; 12397b6e6e8SMatthew G. Knepley PetscInt numConstants, f; 1247d8a60eaSMatthew G. Knepley PetscErrorCode ierr; 1257d8a60eaSMatthew G. Knepley 1267d8a60eaSMatthew G. Knepley PetscFunctionBegin; 1277d8a60eaSMatthew G. Knepley ierr = PetscViewerGetFormat(viewer, &format);CHKERRQ(ierr); 1287d8a60eaSMatthew G. Knepley ierr = PetscViewerASCIIPrintf(viewer, "Discrete System with %d fields\n", prob->Nf);CHKERRQ(ierr); 1297d8a60eaSMatthew G. Knepley ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 1307d8a60eaSMatthew G. Knepley for (f = 0; f < prob->Nf; ++f) { 1317d8a60eaSMatthew G. Knepley PetscObject obj; 1327d8a60eaSMatthew G. Knepley PetscClassId id; 1337d8a60eaSMatthew G. Knepley const char *name; 1347d8a60eaSMatthew G. Knepley PetscInt Nc; 1357d8a60eaSMatthew G. Knepley 1367d8a60eaSMatthew G. Knepley ierr = PetscDSGetDiscretization(prob, f, &obj);CHKERRQ(ierr); 1377d8a60eaSMatthew G. Knepley ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr); 1387d8a60eaSMatthew G. Knepley ierr = PetscObjectGetName(obj, &name);CHKERRQ(ierr); 1397d8a60eaSMatthew G. Knepley ierr = PetscViewerASCIIPrintf(viewer, "Field %s", name ? name : "<unknown>");CHKERRQ(ierr); 1407d8a60eaSMatthew G. Knepley if (id == PETSCFE_CLASSID) { 1417d8a60eaSMatthew G. Knepley ierr = PetscFEGetNumComponents((PetscFE) obj, &Nc);CHKERRQ(ierr); 1427d8a60eaSMatthew G. Knepley ierr = PetscViewerASCIIPrintf(viewer, " FEM");CHKERRQ(ierr); 1437d8a60eaSMatthew G. Knepley } else if (id == PETSCFV_CLASSID) { 1447d8a60eaSMatthew G. Knepley ierr = PetscFVGetNumComponents((PetscFV) obj, &Nc);CHKERRQ(ierr); 1457d8a60eaSMatthew G. Knepley ierr = PetscViewerASCIIPrintf(viewer, " FVM");CHKERRQ(ierr); 1467d8a60eaSMatthew G. Knepley } 14797b6e6e8SMatthew G. Knepley else SETERRQ1(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Unknown discretization type for field %D", f); 14897b6e6e8SMatthew G. Knepley if (Nc > 1) {ierr = PetscViewerASCIIPrintf(viewer, "%D components", Nc);CHKERRQ(ierr);} 14997b6e6e8SMatthew G. Knepley else {ierr = PetscViewerASCIIPrintf(viewer, "%D component ", Nc);CHKERRQ(ierr);} 150249df284SMatthew G. Knepley if (prob->implicit[f]) {ierr = PetscViewerASCIIPrintf(viewer, " (implicit)");CHKERRQ(ierr);} 151249df284SMatthew G. Knepley else {ierr = PetscViewerASCIIPrintf(viewer, " (explicit)");CHKERRQ(ierr);} 152a6cbbb48SMatthew G. Knepley if (prob->adjacency[f*2+0]) { 153a6cbbb48SMatthew G. Knepley if (prob->adjacency[f*2+1]) {ierr = PetscViewerASCIIPrintf(viewer, " (adj FVM++)");CHKERRQ(ierr);} 154a6cbbb48SMatthew G. Knepley else {ierr = PetscViewerASCIIPrintf(viewer, " (adj FVM)");CHKERRQ(ierr);} 155a6cbbb48SMatthew G. Knepley } else { 156a6cbbb48SMatthew G. Knepley if (prob->adjacency[f*2+1]) {ierr = PetscViewerASCIIPrintf(viewer, " (adj FEM)");CHKERRQ(ierr);} 157a6cbbb48SMatthew G. Knepley else {ierr = PetscViewerASCIIPrintf(viewer, " (adj FUNKY)");CHKERRQ(ierr);} 158a6cbbb48SMatthew G. Knepley } 1597d8a60eaSMatthew G. Knepley ierr = PetscViewerASCIIPrintf(viewer, "\n");CHKERRQ(ierr); 160*5d160056SMatthew G. Knepley ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 1617d8a60eaSMatthew G. Knepley if (id == PETSCFE_CLASSID) {ierr = PetscFEView((PetscFE) obj, viewer);CHKERRQ(ierr);} 1627d8a60eaSMatthew G. Knepley else if (id == PETSCFV_CLASSID) {ierr = PetscFVView((PetscFV) obj, viewer);CHKERRQ(ierr);} 163*5d160056SMatthew G. Knepley ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 1647d8a60eaSMatthew G. Knepley } 16597b6e6e8SMatthew G. Knepley ierr = PetscDSGetConstants(prob, &numConstants, &constants);CHKERRQ(ierr); 16697b6e6e8SMatthew G. Knepley if (numConstants) { 16797b6e6e8SMatthew G. Knepley ierr = PetscViewerASCIIPrintf(viewer, "%D constants\n", numConstants);CHKERRQ(ierr); 16897b6e6e8SMatthew G. Knepley ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 16957fc01e9SMatthew G. Knepley for (f = 0; f < numConstants; ++f) {ierr = PetscViewerASCIIPrintf(viewer, "%g\n", (double) PetscRealPart(constants[f]));CHKERRQ(ierr);} 17097b6e6e8SMatthew G. Knepley ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 17197b6e6e8SMatthew G. Knepley } 1727d8a60eaSMatthew G. Knepley ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 1737d8a60eaSMatthew G. Knepley PetscFunctionReturn(0); 1747d8a60eaSMatthew G. Knepley } 1757d8a60eaSMatthew G. Knepley 1762764a2aaSMatthew G. Knepley /*@C 1772764a2aaSMatthew G. Knepley PetscDSView - Views a PetscDS 1782764a2aaSMatthew G. Knepley 1792764a2aaSMatthew G. Knepley Collective on PetscDS 1802764a2aaSMatthew G. Knepley 1812764a2aaSMatthew G. Knepley Input Parameter: 1822764a2aaSMatthew G. Knepley + prob - the PetscDS object to view 1832764a2aaSMatthew G. Knepley - v - the viewer 1842764a2aaSMatthew G. Knepley 1852764a2aaSMatthew G. Knepley Level: developer 1862764a2aaSMatthew G. Knepley 1872764a2aaSMatthew G. Knepley .seealso PetscDSDestroy() 1882764a2aaSMatthew G. Knepley @*/ 1892764a2aaSMatthew G. Knepley PetscErrorCode PetscDSView(PetscDS prob, PetscViewer v) 1902764a2aaSMatthew G. Knepley { 1917d8a60eaSMatthew G. Knepley PetscBool iascii; 1922764a2aaSMatthew G. Knepley PetscErrorCode ierr; 1932764a2aaSMatthew G. Knepley 1942764a2aaSMatthew G. Knepley PetscFunctionBegin; 1952764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 1962764a2aaSMatthew G. Knepley if (!v) {ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject) prob), &v);CHKERRQ(ierr);} 1977d8a60eaSMatthew G. Knepley else {PetscValidHeaderSpecific(v, PETSC_VIEWER_CLASSID, 2);} 1987d8a60eaSMatthew G. Knepley ierr = PetscObjectTypeCompare((PetscObject) v, PETSCVIEWERASCII, &iascii);CHKERRQ(ierr); 1997d8a60eaSMatthew G. Knepley if (iascii) {ierr = PetscDSView_Ascii(prob, v);CHKERRQ(ierr);} 2002764a2aaSMatthew G. Knepley if (prob->ops->view) {ierr = (*prob->ops->view)(prob, v);CHKERRQ(ierr);} 2012764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 2022764a2aaSMatthew G. Knepley } 2032764a2aaSMatthew G. Knepley 2042764a2aaSMatthew G. Knepley /*@ 2052764a2aaSMatthew G. Knepley PetscDSSetFromOptions - sets parameters in a PetscDS from the options database 2062764a2aaSMatthew G. Knepley 2072764a2aaSMatthew G. Knepley Collective on PetscDS 2082764a2aaSMatthew G. Knepley 2092764a2aaSMatthew G. Knepley Input Parameter: 2102764a2aaSMatthew G. Knepley . prob - the PetscDS object to set options for 2112764a2aaSMatthew G. Knepley 2122764a2aaSMatthew G. Knepley Options Database: 2132764a2aaSMatthew G. Knepley 2142764a2aaSMatthew G. Knepley Level: developer 2152764a2aaSMatthew G. Knepley 2162764a2aaSMatthew G. Knepley .seealso PetscDSView() 2172764a2aaSMatthew G. Knepley @*/ 2182764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetFromOptions(PetscDS prob) 2192764a2aaSMatthew G. Knepley { 220f1fd5e65SToby Isaac DSBoundary b; 2212764a2aaSMatthew G. Knepley const char *defaultType; 2222764a2aaSMatthew G. Knepley char name[256]; 2232764a2aaSMatthew G. Knepley PetscBool flg; 2242764a2aaSMatthew G. Knepley PetscErrorCode ierr; 2252764a2aaSMatthew G. Knepley 2262764a2aaSMatthew G. Knepley PetscFunctionBegin; 2272764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 2282764a2aaSMatthew G. Knepley if (!((PetscObject) prob)->type_name) { 2292764a2aaSMatthew G. Knepley defaultType = PETSCDSBASIC; 2302764a2aaSMatthew G. Knepley } else { 2312764a2aaSMatthew G. Knepley defaultType = ((PetscObject) prob)->type_name; 2322764a2aaSMatthew G. Knepley } 2330f51fdf8SToby Isaac ierr = PetscDSRegisterAll();CHKERRQ(ierr); 2342764a2aaSMatthew G. Knepley 2352764a2aaSMatthew G. Knepley ierr = PetscObjectOptionsBegin((PetscObject) prob);CHKERRQ(ierr); 236f1fd5e65SToby Isaac for (b = prob->boundary; b; b = b->next) { 237f1fd5e65SToby Isaac char optname[1024]; 238f1fd5e65SToby Isaac PetscInt ids[1024], len = 1024; 239f1fd5e65SToby Isaac PetscBool flg; 240f1fd5e65SToby Isaac 241f1fd5e65SToby Isaac ierr = PetscSNPrintf(optname, sizeof(optname), "-bc_%s", b->name);CHKERRQ(ierr); 242f1fd5e65SToby Isaac ierr = PetscMemzero(ids, sizeof(ids));CHKERRQ(ierr); 243f1fd5e65SToby Isaac ierr = PetscOptionsIntArray(optname, "List of boundary IDs", "", ids, &len, &flg);CHKERRQ(ierr); 244f1fd5e65SToby Isaac if (flg) { 245f1fd5e65SToby Isaac b->numids = len; 246f1fd5e65SToby Isaac ierr = PetscFree(b->ids);CHKERRQ(ierr); 247f1fd5e65SToby Isaac ierr = PetscMalloc1(len, &b->ids);CHKERRQ(ierr); 248f1fd5e65SToby Isaac ierr = PetscMemcpy(b->ids, ids, len*sizeof(PetscInt));CHKERRQ(ierr); 249f1fd5e65SToby Isaac } 250e7b0402cSSander Arens len = 1024; 251f1fd5e65SToby Isaac ierr = PetscSNPrintf(optname, sizeof(optname), "-bc_%s_comp", b->name);CHKERRQ(ierr); 252f1fd5e65SToby Isaac ierr = PetscMemzero(ids, sizeof(ids));CHKERRQ(ierr); 253f1fd5e65SToby Isaac ierr = PetscOptionsIntArray(optname, "List of boundary field components", "", ids, &len, &flg);CHKERRQ(ierr); 254f1fd5e65SToby Isaac if (flg) { 255f1fd5e65SToby Isaac b->numcomps = len; 256f1fd5e65SToby Isaac ierr = PetscFree(b->comps);CHKERRQ(ierr); 257f1fd5e65SToby Isaac ierr = PetscMalloc1(len, &b->comps);CHKERRQ(ierr); 258f1fd5e65SToby Isaac ierr = PetscMemcpy(b->comps, ids, len*sizeof(PetscInt));CHKERRQ(ierr); 259f1fd5e65SToby Isaac } 260f1fd5e65SToby Isaac } 2612764a2aaSMatthew G. Knepley ierr = PetscOptionsFList("-petscds_type", "Discrete System", "PetscDSSetType", PetscDSList, defaultType, name, 256, &flg);CHKERRQ(ierr); 2622764a2aaSMatthew G. Knepley if (flg) { 2632764a2aaSMatthew G. Knepley ierr = PetscDSSetType(prob, name);CHKERRQ(ierr); 2642764a2aaSMatthew G. Knepley } else if (!((PetscObject) prob)->type_name) { 2652764a2aaSMatthew G. Knepley ierr = PetscDSSetType(prob, defaultType);CHKERRQ(ierr); 2662764a2aaSMatthew G. Knepley } 2672764a2aaSMatthew G. Knepley if (prob->ops->setfromoptions) {ierr = (*prob->ops->setfromoptions)(prob);CHKERRQ(ierr);} 2682764a2aaSMatthew G. Knepley /* process any options handlers added with PetscObjectAddOptionsHandler() */ 2690633abcbSJed Brown ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject) prob);CHKERRQ(ierr); 2702764a2aaSMatthew G. Knepley ierr = PetscOptionsEnd();CHKERRQ(ierr); 271*5d160056SMatthew G. Knepley if (prob->Nf) {ierr = PetscDSViewFromOptions(prob, NULL, "-petscds_view");CHKERRQ(ierr);} 2722764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 2732764a2aaSMatthew G. Knepley } 2742764a2aaSMatthew G. Knepley 2752764a2aaSMatthew G. Knepley /*@C 2762764a2aaSMatthew G. Knepley PetscDSSetUp - Construct data structures for the PetscDS 2772764a2aaSMatthew G. Knepley 2782764a2aaSMatthew G. Knepley Collective on PetscDS 2792764a2aaSMatthew G. Knepley 2802764a2aaSMatthew G. Knepley Input Parameter: 2812764a2aaSMatthew G. Knepley . prob - the PetscDS object to setup 2822764a2aaSMatthew G. Knepley 2832764a2aaSMatthew G. Knepley Level: developer 2842764a2aaSMatthew G. Knepley 2852764a2aaSMatthew G. Knepley .seealso PetscDSView(), PetscDSDestroy() 2862764a2aaSMatthew G. Knepley @*/ 2872764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetUp(PetscDS prob) 2882764a2aaSMatthew G. Knepley { 2892764a2aaSMatthew G. Knepley const PetscInt Nf = prob->Nf; 290d1506c7cSMatthew G. Knepley PetscInt dim, dimEmbed, work, NcMax = 0, NqMax = 0, f; 2912764a2aaSMatthew G. Knepley PetscErrorCode ierr; 2922764a2aaSMatthew G. Knepley 2932764a2aaSMatthew G. Knepley PetscFunctionBegin; 2942764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 2952764a2aaSMatthew G. Knepley if (prob->setup) PetscFunctionReturn(0); 2962764a2aaSMatthew G. Knepley /* Calculate sizes */ 2972764a2aaSMatthew G. Knepley ierr = PetscDSGetSpatialDimension(prob, &dim);CHKERRQ(ierr); 298d1506c7cSMatthew G. Knepley ierr = PetscDSGetCoordinateDimension(prob, &dimEmbed);CHKERRQ(ierr); 299f744cafaSSander Arens prob->totDim = prob->totComp = 0; 30047e57110SSander Arens ierr = PetscMalloc2(Nf,&prob->Nc,Nf,&prob->Nb);CHKERRQ(ierr); 301f744cafaSSander Arens ierr = PetscCalloc2(Nf+1,&prob->off,Nf+1,&prob->offDer);CHKERRQ(ierr); 302f744cafaSSander Arens ierr = PetscMalloc4(Nf,&prob->basis,Nf,&prob->basisDer,Nf,&prob->basisFace,Nf,&prob->basisDerFace);CHKERRQ(ierr); 3032764a2aaSMatthew G. Knepley for (f = 0; f < Nf; ++f) { 3049de99aefSMatthew G. Knepley PetscObject obj; 3059de99aefSMatthew G. Knepley PetscClassId id; 3062764a2aaSMatthew G. Knepley PetscQuadrature q; 3079de99aefSMatthew G. Knepley PetscInt Nq = 0, Nb, Nc; 3082764a2aaSMatthew G. Knepley 3099de99aefSMatthew G. Knepley ierr = PetscDSGetDiscretization(prob, f, &obj);CHKERRQ(ierr); 3109de99aefSMatthew G. Knepley ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr); 3119de99aefSMatthew G. Knepley if (id == PETSCFE_CLASSID) { 3129de99aefSMatthew G. Knepley PetscFE fe = (PetscFE) obj; 3139de99aefSMatthew G. Knepley 3142764a2aaSMatthew G. Knepley ierr = PetscFEGetQuadrature(fe, &q);CHKERRQ(ierr); 3152764a2aaSMatthew G. Knepley ierr = PetscFEGetDimension(fe, &Nb);CHKERRQ(ierr); 3162764a2aaSMatthew G. Knepley ierr = PetscFEGetNumComponents(fe, &Nc);CHKERRQ(ierr); 3172764a2aaSMatthew G. Knepley ierr = PetscFEGetDefaultTabulation(fe, &prob->basis[f], &prob->basisDer[f], NULL);CHKERRQ(ierr); 3184d0b9603SSander Arens ierr = PetscFEGetFaceTabulation(fe, &prob->basisFace[f], &prob->basisDerFace[f], NULL);CHKERRQ(ierr); 3199de99aefSMatthew G. Knepley } else if (id == PETSCFV_CLASSID) { 3209de99aefSMatthew G. Knepley PetscFV fv = (PetscFV) obj; 3219de99aefSMatthew G. Knepley 3229de99aefSMatthew G. Knepley ierr = PetscFVGetQuadrature(fv, &q);CHKERRQ(ierr); 3239de99aefSMatthew G. Knepley ierr = PetscFVGetNumComponents(fv, &Nc);CHKERRQ(ierr); 3249c3cf19fSMatthew G. Knepley Nb = Nc; 3256c1a3d01SMatthew G. Knepley ierr = PetscFVGetDefaultTabulation(fv, &prob->basis[f], &prob->basisDer[f], NULL);CHKERRQ(ierr); 3264d0b9603SSander Arens /* TODO: should PetscFV also have face tabulation? Otherwise there will be a null pointer in prob->basisFace */ 327abac5ca0SMatthew G. Knepley } else SETERRQ1(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Unknown discretization type for field %d", f); 32847e57110SSander Arens prob->Nc[f] = Nc; 32947e57110SSander Arens prob->Nb[f] = Nb; 330194d53e6SMatthew G. Knepley prob->off[f+1] = Nc + prob->off[f]; 331194d53e6SMatthew G. Knepley prob->offDer[f+1] = Nc*dim + prob->offDer[f]; 332a6b92713SMatthew G. Knepley if (q) {ierr = PetscQuadratureGetData(q, NULL, NULL, &Nq, NULL, NULL);CHKERRQ(ierr);} 3332764a2aaSMatthew G. Knepley NqMax = PetscMax(NqMax, Nq); 3342764a2aaSMatthew G. Knepley NcMax = PetscMax(NcMax, Nc); 3359c3cf19fSMatthew G. Knepley prob->totDim += Nb; 3362764a2aaSMatthew G. Knepley prob->totComp += Nc; 3372764a2aaSMatthew G. Knepley } 3382764a2aaSMatthew G. Knepley work = PetscMax(prob->totComp*dim, PetscSqr(NcMax*dim)); 3392764a2aaSMatthew G. Knepley /* Allocate works space */ 340d1506c7cSMatthew G. Knepley ierr = PetscMalloc5(prob->totComp,&prob->u,prob->totComp,&prob->u_t,prob->totComp*dim,&prob->u_x,dimEmbed,&prob->x,work,&prob->refSpaceDer);CHKERRQ(ierr); 3412764a2aaSMatthew G. Knepley ierr = PetscMalloc6(NqMax*NcMax,&prob->f0,NqMax*NcMax*dim,&prob->f1,NqMax*NcMax*NcMax,&prob->g0,NqMax*NcMax*NcMax*dim,&prob->g1,NqMax*NcMax*NcMax*dim,&prob->g2,NqMax*NcMax*NcMax*dim*dim,&prob->g3);CHKERRQ(ierr); 3422764a2aaSMatthew G. Knepley if (prob->ops->setup) {ierr = (*prob->ops->setup)(prob);CHKERRQ(ierr);} 3432764a2aaSMatthew G. Knepley prob->setup = PETSC_TRUE; 3442764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 3452764a2aaSMatthew G. Knepley } 3462764a2aaSMatthew G. Knepley 3472764a2aaSMatthew G. Knepley static PetscErrorCode PetscDSDestroyStructs_Static(PetscDS prob) 3482764a2aaSMatthew G. Knepley { 3492764a2aaSMatthew G. Knepley PetscErrorCode ierr; 3502764a2aaSMatthew G. Knepley 3512764a2aaSMatthew G. Knepley PetscFunctionBegin; 35247e57110SSander Arens ierr = PetscFree2(prob->Nc,prob->Nb);CHKERRQ(ierr); 353f744cafaSSander Arens ierr = PetscFree2(prob->off,prob->offDer);CHKERRQ(ierr); 354f744cafaSSander Arens ierr = PetscFree4(prob->basis,prob->basisDer,prob->basisFace,prob->basisDerFace);CHKERRQ(ierr); 3552764a2aaSMatthew G. Knepley ierr = PetscFree5(prob->u,prob->u_t,prob->u_x,prob->x,prob->refSpaceDer);CHKERRQ(ierr); 3562764a2aaSMatthew G. Knepley ierr = PetscFree6(prob->f0,prob->f1,prob->g0,prob->g1,prob->g2,prob->g3);CHKERRQ(ierr); 3572764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 3582764a2aaSMatthew G. Knepley } 3592764a2aaSMatthew G. Knepley 3602764a2aaSMatthew G. Knepley static PetscErrorCode PetscDSEnlarge_Static(PetscDS prob, PetscInt NfNew) 3612764a2aaSMatthew G. Knepley { 362f744cafaSSander Arens PetscObject *tmpd; 363a6cbbb48SMatthew G. Knepley PetscBool *tmpi, *tmpa; 36432d2bbc9SMatthew G. Knepley PetscPointFunc *tmpobj, *tmpf, *tmpup; 365b7e05686SMatthew G. Knepley PetscPointJac *tmpg, *tmpgp, *tmpgt; 3662aa1fc23SMatthew G. Knepley PetscBdPointFunc *tmpfbd; 3672aa1fc23SMatthew G. Knepley PetscBdPointJac *tmpgbd; 368194d53e6SMatthew G. Knepley PetscRiemannFunc *tmpr; 369c371a6d1SMatthew G. Knepley PetscSimplePointFunc *tmpexactSol; 3700c2f2876SMatthew G. Knepley void **tmpctx; 371a6cbbb48SMatthew G. Knepley PetscInt Nf = prob->Nf, f, i; 3722764a2aaSMatthew G. Knepley PetscErrorCode ierr; 3732764a2aaSMatthew G. Knepley 3742764a2aaSMatthew G. Knepley PetscFunctionBegin; 3752764a2aaSMatthew G. Knepley if (Nf >= NfNew) PetscFunctionReturn(0); 3762764a2aaSMatthew G. Knepley prob->setup = PETSC_FALSE; 3772764a2aaSMatthew G. Knepley ierr = PetscDSDestroyStructs_Static(prob);CHKERRQ(ierr); 378f744cafaSSander Arens ierr = PetscMalloc3(NfNew, &tmpd, NfNew, &tmpi, NfNew*2, &tmpa);CHKERRQ(ierr); 379f744cafaSSander Arens for (f = 0; f < Nf; ++f) {tmpd[f] = prob->disc[f]; tmpi[f] = prob->implicit[f]; for (i = 0; i < 2; ++i) tmpa[f*2+i] = prob->adjacency[f*2+i];} 380f744cafaSSander Arens for (f = Nf; f < NfNew; ++f) {tmpd[f] = NULL; tmpi[f] = PETSC_TRUE; tmpa[f*2+0] = PETSC_FALSE; tmpa[f*2+1] = PETSC_TRUE;} 381f744cafaSSander Arens ierr = PetscFree3(prob->disc, prob->implicit, prob->adjacency);CHKERRQ(ierr); 3822764a2aaSMatthew G. Knepley prob->Nf = NfNew; 3832764a2aaSMatthew G. Knepley prob->disc = tmpd; 384249df284SMatthew G. Knepley prob->implicit = tmpi; 385a6cbbb48SMatthew G. Knepley prob->adjacency = tmpa; 386b7e05686SMatthew G. Knepley ierr = PetscCalloc7(NfNew, &tmpobj, NfNew*2, &tmpf, NfNew*NfNew*4, &tmpg, NfNew*NfNew*4, &tmpgp, NfNew*NfNew*4, &tmpgt, NfNew, &tmpr, NfNew, &tmpctx);CHKERRQ(ierr); 38732d2bbc9SMatthew G. Knepley ierr = PetscCalloc1(NfNew, &tmpup);CHKERRQ(ierr); 3882764a2aaSMatthew G. Knepley for (f = 0; f < Nf; ++f) tmpobj[f] = prob->obj[f]; 3892764a2aaSMatthew G. Knepley for (f = 0; f < Nf*2; ++f) tmpf[f] = prob->f[f]; 3902764a2aaSMatthew G. Knepley for (f = 0; f < Nf*Nf*4; ++f) tmpg[f] = prob->g[f]; 391475e0ac9SMatthew G. Knepley for (f = 0; f < Nf*Nf*4; ++f) tmpgp[f] = prob->gp[f]; 3920c2f2876SMatthew G. Knepley for (f = 0; f < Nf; ++f) tmpr[f] = prob->r[f]; 39332d2bbc9SMatthew G. Knepley for (f = 0; f < Nf; ++f) tmpup[f] = prob->update[f]; 3940c2f2876SMatthew G. Knepley for (f = 0; f < Nf; ++f) tmpctx[f] = prob->ctx[f]; 3952764a2aaSMatthew G. Knepley for (f = Nf; f < NfNew; ++f) tmpobj[f] = NULL; 3962764a2aaSMatthew G. Knepley for (f = Nf*2; f < NfNew*2; ++f) tmpf[f] = NULL; 3972764a2aaSMatthew G. Knepley for (f = Nf*Nf*4; f < NfNew*NfNew*4; ++f) tmpg[f] = NULL; 398475e0ac9SMatthew G. Knepley for (f = Nf*Nf*4; f < NfNew*NfNew*4; ++f) tmpgp[f] = NULL; 399b7e05686SMatthew G. Knepley for (f = Nf*Nf*4; f < NfNew*NfNew*4; ++f) tmpgt[f] = NULL; 4000c2f2876SMatthew G. Knepley for (f = Nf; f < NfNew; ++f) tmpr[f] = NULL; 40132d2bbc9SMatthew G. Knepley for (f = Nf; f < NfNew; ++f) tmpup[f] = NULL; 4020c2f2876SMatthew G. Knepley for (f = Nf; f < NfNew; ++f) tmpctx[f] = NULL; 403b7e05686SMatthew G. Knepley ierr = PetscFree7(prob->obj, prob->f, prob->g, prob->gp, prob->gt, prob->r, prob->ctx);CHKERRQ(ierr); 40432d2bbc9SMatthew G. Knepley ierr = PetscFree(prob->update);CHKERRQ(ierr); 4052764a2aaSMatthew G. Knepley prob->obj = tmpobj; 4062764a2aaSMatthew G. Knepley prob->f = tmpf; 4072764a2aaSMatthew G. Knepley prob->g = tmpg; 408475e0ac9SMatthew G. Knepley prob->gp = tmpgp; 409b7e05686SMatthew G. Knepley prob->gt = tmpgt; 4100c2f2876SMatthew G. Knepley prob->r = tmpr; 41132d2bbc9SMatthew G. Knepley prob->update = tmpup; 4120c2f2876SMatthew G. Knepley prob->ctx = tmpctx; 413c371a6d1SMatthew G. Knepley ierr = PetscCalloc3(NfNew*2, &tmpfbd, NfNew*NfNew*4, &tmpgbd, NfNew, &tmpexactSol);CHKERRQ(ierr); 4142764a2aaSMatthew G. Knepley for (f = 0; f < Nf*2; ++f) tmpfbd[f] = prob->fBd[f]; 4152764a2aaSMatthew G. Knepley for (f = 0; f < Nf*Nf*4; ++f) tmpgbd[f] = prob->gBd[f]; 416c371a6d1SMatthew G. Knepley for (f = 0; f < Nf; ++f) tmpexactSol[f] = prob->exactSol[f]; 4172764a2aaSMatthew G. Knepley for (f = Nf*2; f < NfNew*2; ++f) tmpfbd[f] = NULL; 4182764a2aaSMatthew G. Knepley for (f = Nf*Nf*4; f < NfNew*NfNew*4; ++f) tmpgbd[f] = NULL; 419c371a6d1SMatthew G. Knepley for (f = Nf; f < NfNew; ++f) tmpexactSol[f] = NULL; 420c371a6d1SMatthew G. Knepley ierr = PetscFree3(prob->fBd, prob->gBd, prob->exactSol);CHKERRQ(ierr); 4212764a2aaSMatthew G. Knepley prob->fBd = tmpfbd; 4222764a2aaSMatthew G. Knepley prob->gBd = tmpgbd; 423c371a6d1SMatthew G. Knepley prob->exactSol = tmpexactSol; 4242764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 4252764a2aaSMatthew G. Knepley } 4262764a2aaSMatthew G. Knepley 4272764a2aaSMatthew G. Knepley /*@ 4282764a2aaSMatthew G. Knepley PetscDSDestroy - Destroys a PetscDS object 4292764a2aaSMatthew G. Knepley 4302764a2aaSMatthew G. Knepley Collective on PetscDS 4312764a2aaSMatthew G. Knepley 4322764a2aaSMatthew G. Knepley Input Parameter: 4332764a2aaSMatthew G. Knepley . prob - the PetscDS object to destroy 4342764a2aaSMatthew G. Knepley 4352764a2aaSMatthew G. Knepley Level: developer 4362764a2aaSMatthew G. Knepley 4372764a2aaSMatthew G. Knepley .seealso PetscDSView() 4382764a2aaSMatthew G. Knepley @*/ 4392764a2aaSMatthew G. Knepley PetscErrorCode PetscDSDestroy(PetscDS *prob) 4402764a2aaSMatthew G. Knepley { 4412764a2aaSMatthew G. Knepley PetscInt f; 44258ebd649SToby Isaac DSBoundary next; 4432764a2aaSMatthew G. Knepley PetscErrorCode ierr; 4442764a2aaSMatthew G. Knepley 4452764a2aaSMatthew G. Knepley PetscFunctionBegin; 4462764a2aaSMatthew G. Knepley if (!*prob) PetscFunctionReturn(0); 4472764a2aaSMatthew G. Knepley PetscValidHeaderSpecific((*prob), PETSCDS_CLASSID, 1); 4482764a2aaSMatthew G. Knepley 4492764a2aaSMatthew G. Knepley if (--((PetscObject)(*prob))->refct > 0) {*prob = 0; PetscFunctionReturn(0);} 4502764a2aaSMatthew G. Knepley ((PetscObject) (*prob))->refct = 0; 451df3a45bdSMatthew G. Knepley if ((*prob)->subprobs) { 452df3a45bdSMatthew G. Knepley PetscInt dim, d; 453df3a45bdSMatthew G. Knepley 454df3a45bdSMatthew G. Knepley ierr = PetscDSGetSpatialDimension(*prob, &dim);CHKERRQ(ierr); 455df3a45bdSMatthew G. Knepley for (d = 0; d < dim; ++d) {ierr = PetscDSDestroy(&(*prob)->subprobs[d]);CHKERRQ(ierr);} 456df3a45bdSMatthew G. Knepley } 457df3a45bdSMatthew G. Knepley ierr = PetscFree((*prob)->subprobs);CHKERRQ(ierr); 4582764a2aaSMatthew G. Knepley ierr = PetscDSDestroyStructs_Static(*prob);CHKERRQ(ierr); 4592764a2aaSMatthew G. Knepley for (f = 0; f < (*prob)->Nf; ++f) { 4602764a2aaSMatthew G. Knepley ierr = PetscObjectDereference((*prob)->disc[f]);CHKERRQ(ierr); 4612764a2aaSMatthew G. Knepley } 462f744cafaSSander Arens ierr = PetscFree3((*prob)->disc, (*prob)->implicit, (*prob)->adjacency);CHKERRQ(ierr); 463b7e05686SMatthew G. Knepley ierr = PetscFree7((*prob)->obj,(*prob)->f,(*prob)->g,(*prob)->gp,(*prob)->gt,(*prob)->r,(*prob)->ctx);CHKERRQ(ierr); 46432d2bbc9SMatthew G. Knepley ierr = PetscFree((*prob)->update);CHKERRQ(ierr); 465c371a6d1SMatthew G. Knepley ierr = PetscFree3((*prob)->fBd,(*prob)->gBd,(*prob)->exactSol);CHKERRQ(ierr); 4662764a2aaSMatthew G. Knepley if ((*prob)->ops->destroy) {ierr = (*(*prob)->ops->destroy)(*prob);CHKERRQ(ierr);} 46758ebd649SToby Isaac next = (*prob)->boundary; 46858ebd649SToby Isaac while (next) { 46958ebd649SToby Isaac DSBoundary b = next; 47058ebd649SToby Isaac 47158ebd649SToby Isaac next = b->next; 47258ebd649SToby Isaac ierr = PetscFree(b->comps);CHKERRQ(ierr); 47358ebd649SToby Isaac ierr = PetscFree(b->ids);CHKERRQ(ierr); 47458ebd649SToby Isaac ierr = PetscFree(b->name);CHKERRQ(ierr); 47558ebd649SToby Isaac ierr = PetscFree(b->labelname);CHKERRQ(ierr); 47658ebd649SToby Isaac ierr = PetscFree(b);CHKERRQ(ierr); 47758ebd649SToby Isaac } 47897b6e6e8SMatthew G. Knepley ierr = PetscFree((*prob)->constants);CHKERRQ(ierr); 4792764a2aaSMatthew G. Knepley ierr = PetscHeaderDestroy(prob);CHKERRQ(ierr); 4802764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 4812764a2aaSMatthew G. Knepley } 4822764a2aaSMatthew G. Knepley 4832764a2aaSMatthew G. Knepley /*@ 4842764a2aaSMatthew G. Knepley PetscDSCreate - Creates an empty PetscDS object. The type can then be set with PetscDSSetType(). 4852764a2aaSMatthew G. Knepley 4862764a2aaSMatthew G. Knepley Collective on MPI_Comm 4872764a2aaSMatthew G. Knepley 4882764a2aaSMatthew G. Knepley Input Parameter: 4892764a2aaSMatthew G. Knepley . comm - The communicator for the PetscDS object 4902764a2aaSMatthew G. Knepley 4912764a2aaSMatthew G. Knepley Output Parameter: 4922764a2aaSMatthew G. Knepley . prob - The PetscDS object 4932764a2aaSMatthew G. Knepley 4942764a2aaSMatthew G. Knepley Level: beginner 4952764a2aaSMatthew G. Knepley 4962764a2aaSMatthew G. Knepley .seealso: PetscDSSetType(), PETSCDSBASIC 4972764a2aaSMatthew G. Knepley @*/ 4982764a2aaSMatthew G. Knepley PetscErrorCode PetscDSCreate(MPI_Comm comm, PetscDS *prob) 4992764a2aaSMatthew G. Knepley { 5002764a2aaSMatthew G. Knepley PetscDS p; 5012764a2aaSMatthew G. Knepley PetscErrorCode ierr; 5022764a2aaSMatthew G. Knepley 5032764a2aaSMatthew G. Knepley PetscFunctionBegin; 5042764a2aaSMatthew G. Knepley PetscValidPointer(prob, 2); 5052764a2aaSMatthew G. Knepley *prob = NULL; 5062764a2aaSMatthew G. Knepley ierr = PetscDSInitializePackage();CHKERRQ(ierr); 5072764a2aaSMatthew G. Knepley 50873107ff1SLisandro Dalcin ierr = PetscHeaderCreate(p, PETSCDS_CLASSID, "PetscDS", "Discrete System", "PetscDS", comm, PetscDSDestroy, PetscDSView);CHKERRQ(ierr); 5092764a2aaSMatthew G. Knepley 5102764a2aaSMatthew G. Knepley p->Nf = 0; 5112764a2aaSMatthew G. Knepley p->setup = PETSC_FALSE; 51297b6e6e8SMatthew G. Knepley p->numConstants = 0; 51397b6e6e8SMatthew G. Knepley p->constants = NULL; 514a859676bSMatthew G. Knepley p->dimEmbed = -1; 51503d90f89SMatthew G. Knepley p->defaultAdj[0] = PETSC_FALSE; 51603d90f89SMatthew G. Knepley p->defaultAdj[1] = PETSC_TRUE; 5172764a2aaSMatthew G. Knepley 5182764a2aaSMatthew G. Knepley *prob = p; 5192764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 5202764a2aaSMatthew G. Knepley } 5212764a2aaSMatthew G. Knepley 522bc4ae4beSMatthew G. Knepley /*@ 523bc4ae4beSMatthew G. Knepley PetscDSGetNumFields - Returns the number of fields in the DS 524bc4ae4beSMatthew G. Knepley 525bc4ae4beSMatthew G. Knepley Not collective 526bc4ae4beSMatthew G. Knepley 527bc4ae4beSMatthew G. Knepley Input Parameter: 528bc4ae4beSMatthew G. Knepley . prob - The PetscDS object 529bc4ae4beSMatthew G. Knepley 530bc4ae4beSMatthew G. Knepley Output Parameter: 531bc4ae4beSMatthew G. Knepley . Nf - The number of fields 532bc4ae4beSMatthew G. Knepley 533bc4ae4beSMatthew G. Knepley Level: beginner 534bc4ae4beSMatthew G. Knepley 535bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetSpatialDimension(), PetscDSCreate() 536bc4ae4beSMatthew G. Knepley @*/ 5372764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetNumFields(PetscDS prob, PetscInt *Nf) 5382764a2aaSMatthew G. Knepley { 5392764a2aaSMatthew G. Knepley PetscFunctionBegin; 5402764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 5412764a2aaSMatthew G. Knepley PetscValidPointer(Nf, 2); 5422764a2aaSMatthew G. Knepley *Nf = prob->Nf; 5432764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 5442764a2aaSMatthew G. Knepley } 5452764a2aaSMatthew G. Knepley 546bc4ae4beSMatthew G. Knepley /*@ 547a859676bSMatthew G. Knepley PetscDSGetSpatialDimension - Returns the spatial dimension of the DS, meaning the topological dimension of the discretizations 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 . dim - The spatial dimension 556bc4ae4beSMatthew G. Knepley 557bc4ae4beSMatthew G. Knepley Level: beginner 558bc4ae4beSMatthew G. Knepley 559a859676bSMatthew G. Knepley .seealso: PetscDSGetCoordinateDimension(), PetscDSGetNumFields(), PetscDSCreate() 560bc4ae4beSMatthew G. Knepley @*/ 5612764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetSpatialDimension(PetscDS prob, PetscInt *dim) 5622764a2aaSMatthew G. Knepley { 5632764a2aaSMatthew G. Knepley PetscErrorCode ierr; 5642764a2aaSMatthew G. Knepley 5652764a2aaSMatthew G. Knepley PetscFunctionBegin; 5662764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 5672764a2aaSMatthew G. Knepley PetscValidPointer(dim, 2); 5682764a2aaSMatthew G. Knepley *dim = 0; 5699de99aefSMatthew G. Knepley if (prob->Nf) { 5709de99aefSMatthew G. Knepley PetscObject obj; 5719de99aefSMatthew G. Knepley PetscClassId id; 5729de99aefSMatthew G. Knepley 5739de99aefSMatthew G. Knepley ierr = PetscDSGetDiscretization(prob, 0, &obj);CHKERRQ(ierr); 5749de99aefSMatthew G. Knepley ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr); 5759de99aefSMatthew G. Knepley if (id == PETSCFE_CLASSID) {ierr = PetscFEGetSpatialDimension((PetscFE) obj, dim);CHKERRQ(ierr);} 5769de99aefSMatthew G. Knepley else if (id == PETSCFV_CLASSID) {ierr = PetscFVGetSpatialDimension((PetscFV) obj, dim);CHKERRQ(ierr);} 5779de99aefSMatthew G. Knepley else SETERRQ1(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Unknown discretization type for field %d", 0); 5789de99aefSMatthew G. Knepley } 5792764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 5802764a2aaSMatthew G. Knepley } 5812764a2aaSMatthew G. Knepley 582bc4ae4beSMatthew G. Knepley /*@ 583a859676bSMatthew G. Knepley PetscDSGetCoordinateDimension - Returns the coordinate dimension of the DS, meaning the dimension of the space into which the discretiaztions are embedded 584a859676bSMatthew G. Knepley 585a859676bSMatthew G. Knepley Not collective 586a859676bSMatthew G. Knepley 587a859676bSMatthew G. Knepley Input Parameter: 588a859676bSMatthew G. Knepley . prob - The PetscDS object 589a859676bSMatthew G. Knepley 590a859676bSMatthew G. Knepley Output Parameter: 591a859676bSMatthew G. Knepley . dimEmbed - The coordinate dimension 592a859676bSMatthew G. Knepley 593a859676bSMatthew G. Knepley Level: beginner 594a859676bSMatthew G. Knepley 595a859676bSMatthew G. Knepley .seealso: PetscDSSetCoordinateDimension(), PetscDSGetSpatialDimension(), PetscDSGetNumFields(), PetscDSCreate() 596a859676bSMatthew G. Knepley @*/ 597a859676bSMatthew G. Knepley PetscErrorCode PetscDSGetCoordinateDimension(PetscDS prob, PetscInt *dimEmbed) 598a859676bSMatthew G. Knepley { 599a859676bSMatthew G. Knepley PetscFunctionBegin; 600a859676bSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 601a859676bSMatthew G. Knepley PetscValidPointer(dimEmbed, 2); 602a859676bSMatthew G. Knepley if (prob->dimEmbed < 0) SETERRQ(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONGSTATE, "No coordinate dimension set for this DS"); 603a859676bSMatthew G. Knepley *dimEmbed = prob->dimEmbed; 604a859676bSMatthew G. Knepley PetscFunctionReturn(0); 605a859676bSMatthew G. Knepley } 606a859676bSMatthew G. Knepley 607a859676bSMatthew G. Knepley /*@ 608a859676bSMatthew G. Knepley PetscDSSetCoordinateDimension - Set the coordinate dimension of the DS, meaning the dimension of the space into which the discretiaztions are embedded 609a859676bSMatthew G. Knepley 610a859676bSMatthew G. Knepley Not collective 611a859676bSMatthew G. Knepley 612a859676bSMatthew G. Knepley Input Parameters: 613a859676bSMatthew G. Knepley + prob - The PetscDS object 614a859676bSMatthew G. Knepley - dimEmbed - The coordinate dimension 615a859676bSMatthew G. Knepley 616a859676bSMatthew G. Knepley Level: beginner 617a859676bSMatthew G. Knepley 618a859676bSMatthew G. Knepley .seealso: PetscDSGetCoordinateDimension(), PetscDSGetSpatialDimension(), PetscDSGetNumFields(), PetscDSCreate() 619a859676bSMatthew G. Knepley @*/ 620a859676bSMatthew G. Knepley PetscErrorCode PetscDSSetCoordinateDimension(PetscDS prob, PetscInt dimEmbed) 621a859676bSMatthew G. Knepley { 622a859676bSMatthew G. Knepley PetscFunctionBegin; 623a859676bSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 624a859676bSMatthew G. Knepley prob->dimEmbed = dimEmbed; 625a859676bSMatthew G. Knepley PetscFunctionReturn(0); 626a859676bSMatthew G. Knepley } 627a859676bSMatthew G. Knepley 628a859676bSMatthew G. Knepley /*@ 629bc4ae4beSMatthew G. Knepley PetscDSGetTotalDimension - Returns the total size of the approximation space for this system 630bc4ae4beSMatthew G. Knepley 631bc4ae4beSMatthew G. Knepley Not collective 632bc4ae4beSMatthew G. Knepley 633bc4ae4beSMatthew G. Knepley Input Parameter: 634bc4ae4beSMatthew G. Knepley . prob - The PetscDS object 635bc4ae4beSMatthew G. Knepley 636bc4ae4beSMatthew G. Knepley Output Parameter: 637bc4ae4beSMatthew G. Knepley . dim - The total problem dimension 638bc4ae4beSMatthew G. Knepley 639bc4ae4beSMatthew G. Knepley Level: beginner 640bc4ae4beSMatthew G. Knepley 641bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetNumFields(), PetscDSCreate() 642bc4ae4beSMatthew G. Knepley @*/ 6432764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetTotalDimension(PetscDS prob, PetscInt *dim) 6442764a2aaSMatthew G. Knepley { 6452764a2aaSMatthew G. Knepley PetscErrorCode ierr; 6462764a2aaSMatthew G. Knepley 6472764a2aaSMatthew G. Knepley PetscFunctionBegin; 6482764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 6492764a2aaSMatthew G. Knepley ierr = PetscDSSetUp(prob);CHKERRQ(ierr); 6502764a2aaSMatthew G. Knepley PetscValidPointer(dim, 2); 6512764a2aaSMatthew G. Knepley *dim = prob->totDim; 6522764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 6532764a2aaSMatthew G. Knepley } 6542764a2aaSMatthew G. Knepley 655bc4ae4beSMatthew G. Knepley /*@ 656bc4ae4beSMatthew G. Knepley PetscDSGetTotalComponents - Returns the total number of components in this system 657bc4ae4beSMatthew G. Knepley 658bc4ae4beSMatthew G. Knepley Not collective 659bc4ae4beSMatthew G. Knepley 660bc4ae4beSMatthew G. Knepley Input Parameter: 661bc4ae4beSMatthew G. Knepley . prob - The PetscDS object 662bc4ae4beSMatthew G. Knepley 663bc4ae4beSMatthew G. Knepley Output Parameter: 664bc4ae4beSMatthew G. Knepley . dim - The total number of components 665bc4ae4beSMatthew G. Knepley 666bc4ae4beSMatthew G. Knepley Level: beginner 667bc4ae4beSMatthew G. Knepley 668bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetNumFields(), PetscDSCreate() 669bc4ae4beSMatthew G. Knepley @*/ 6702764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetTotalComponents(PetscDS prob, PetscInt *Nc) 6712764a2aaSMatthew G. Knepley { 6722764a2aaSMatthew G. Knepley PetscErrorCode ierr; 6732764a2aaSMatthew G. Knepley 6742764a2aaSMatthew G. Knepley PetscFunctionBegin; 6752764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 6762764a2aaSMatthew G. Knepley ierr = PetscDSSetUp(prob);CHKERRQ(ierr); 6772764a2aaSMatthew G. Knepley PetscValidPointer(Nc, 2); 6782764a2aaSMatthew G. Knepley *Nc = prob->totComp; 6792764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 6802764a2aaSMatthew G. Knepley } 6812764a2aaSMatthew G. Knepley 682bc4ae4beSMatthew G. Knepley /*@ 683bc4ae4beSMatthew G. Knepley PetscDSGetDiscretization - Returns the discretization object for the given field 684bc4ae4beSMatthew G. Knepley 685bc4ae4beSMatthew G. Knepley Not collective 686bc4ae4beSMatthew G. Knepley 687bc4ae4beSMatthew G. Knepley Input Parameters: 688bc4ae4beSMatthew G. Knepley + prob - The PetscDS object 689bc4ae4beSMatthew G. Knepley - f - The field number 690bc4ae4beSMatthew G. Knepley 691bc4ae4beSMatthew G. Knepley Output Parameter: 692bc4ae4beSMatthew G. Knepley . disc - The discretization object 693bc4ae4beSMatthew G. Knepley 694bc4ae4beSMatthew G. Knepley Level: beginner 695bc4ae4beSMatthew G. Knepley 696f744cafaSSander Arens .seealso: PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate() 697bc4ae4beSMatthew G. Knepley @*/ 6982764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetDiscretization(PetscDS prob, PetscInt f, PetscObject *disc) 6992764a2aaSMatthew G. Knepley { 7002764a2aaSMatthew G. Knepley PetscFunctionBegin; 7012764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 7022764a2aaSMatthew G. Knepley PetscValidPointer(disc, 3); 7032764a2aaSMatthew 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); 7042764a2aaSMatthew G. Knepley *disc = prob->disc[f]; 7052764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 7062764a2aaSMatthew G. Knepley } 7072764a2aaSMatthew G. Knepley 708bc4ae4beSMatthew G. Knepley /*@ 709bc4ae4beSMatthew G. Knepley PetscDSSetDiscretization - Sets the discretization object for the given field 710bc4ae4beSMatthew G. Knepley 711bc4ae4beSMatthew G. Knepley Not collective 712bc4ae4beSMatthew G. Knepley 713bc4ae4beSMatthew G. Knepley Input Parameters: 714bc4ae4beSMatthew G. Knepley + prob - The PetscDS object 715bc4ae4beSMatthew G. Knepley . f - The field number 716bc4ae4beSMatthew G. Knepley - disc - The discretization object 717bc4ae4beSMatthew G. Knepley 718bc4ae4beSMatthew G. Knepley Level: beginner 719bc4ae4beSMatthew G. Knepley 720bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate() 721bc4ae4beSMatthew G. Knepley @*/ 7222764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetDiscretization(PetscDS prob, PetscInt f, PetscObject disc) 7232764a2aaSMatthew G. Knepley { 7242764a2aaSMatthew G. Knepley PetscErrorCode ierr; 7252764a2aaSMatthew G. Knepley 7262764a2aaSMatthew G. Knepley PetscFunctionBegin; 7272764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 7282764a2aaSMatthew G. Knepley PetscValidPointer(disc, 3); 7292764a2aaSMatthew G. Knepley if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f); 7302764a2aaSMatthew G. Knepley ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr); 7312764a2aaSMatthew G. Knepley if (prob->disc[f]) {ierr = PetscObjectDereference(prob->disc[f]);CHKERRQ(ierr);} 7322764a2aaSMatthew G. Knepley prob->disc[f] = disc; 7332764a2aaSMatthew G. Knepley ierr = PetscObjectReference(disc);CHKERRQ(ierr); 734249df284SMatthew G. Knepley { 735249df284SMatthew G. Knepley PetscClassId id; 736249df284SMatthew G. Knepley 737249df284SMatthew G. Knepley ierr = PetscObjectGetClassId(disc, &id);CHKERRQ(ierr); 7381cf84007SMatthew G. Knepley if (id == PETSCFE_CLASSID) { 7391cf84007SMatthew G. Knepley ierr = PetscDSSetImplicit(prob, f, PETSC_TRUE);CHKERRQ(ierr); 7401cf84007SMatthew G. Knepley ierr = PetscDSSetAdjacency(prob, f, PETSC_FALSE, PETSC_TRUE);CHKERRQ(ierr); 7411cf84007SMatthew G. Knepley } else if (id == PETSCFV_CLASSID) { 7421cf84007SMatthew G. Knepley ierr = PetscDSSetImplicit(prob, f, PETSC_FALSE);CHKERRQ(ierr); 7431cf84007SMatthew G. Knepley ierr = PetscDSSetAdjacency(prob, f, PETSC_TRUE, PETSC_FALSE);CHKERRQ(ierr); 744a6cbbb48SMatthew G. Knepley } 745249df284SMatthew G. Knepley } 7462764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 7472764a2aaSMatthew G. Knepley } 7482764a2aaSMatthew G. Knepley 749bc4ae4beSMatthew G. Knepley /*@ 750bc4ae4beSMatthew G. Knepley PetscDSAddDiscretization - Adds a discretization object 751bc4ae4beSMatthew G. Knepley 752bc4ae4beSMatthew G. Knepley Not collective 753bc4ae4beSMatthew G. Knepley 754bc4ae4beSMatthew G. Knepley Input Parameters: 755bc4ae4beSMatthew G. Knepley + prob - The PetscDS object 756bc4ae4beSMatthew G. Knepley - disc - The boundary discretization object 757bc4ae4beSMatthew G. Knepley 758bc4ae4beSMatthew G. Knepley Level: beginner 759bc4ae4beSMatthew G. Knepley 760bc4ae4beSMatthew G. Knepley .seealso: PetscDSGetDiscretization(), PetscDSSetDiscretization(), PetscDSGetNumFields(), PetscDSCreate() 761bc4ae4beSMatthew G. Knepley @*/ 7622764a2aaSMatthew G. Knepley PetscErrorCode PetscDSAddDiscretization(PetscDS prob, PetscObject disc) 7632764a2aaSMatthew G. Knepley { 7642764a2aaSMatthew G. Knepley PetscErrorCode ierr; 7652764a2aaSMatthew G. Knepley 7662764a2aaSMatthew G. Knepley PetscFunctionBegin; 7672764a2aaSMatthew G. Knepley ierr = PetscDSSetDiscretization(prob, prob->Nf, disc);CHKERRQ(ierr); 7682764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 7692764a2aaSMatthew G. Knepley } 7702764a2aaSMatthew G. Knepley 771249df284SMatthew G. Knepley /*@ 772249df284SMatthew G. Knepley PetscDSGetImplicit - Returns the flag for implicit solve for this field. This is just a guide for IMEX 773249df284SMatthew G. Knepley 774249df284SMatthew G. Knepley Not collective 775249df284SMatthew G. Knepley 776249df284SMatthew G. Knepley Input Parameters: 777249df284SMatthew G. Knepley + prob - The PetscDS object 778249df284SMatthew G. Knepley - f - The field number 779249df284SMatthew G. Knepley 780249df284SMatthew G. Knepley Output Parameter: 781249df284SMatthew G. Knepley . implicit - The flag indicating what kind of solve to use for this field 782249df284SMatthew G. Knepley 783249df284SMatthew G. Knepley Level: developer 784249df284SMatthew G. Knepley 785f744cafaSSander Arens .seealso: PetscDSSetImplicit(), PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate() 786249df284SMatthew G. Knepley @*/ 787249df284SMatthew G. Knepley PetscErrorCode PetscDSGetImplicit(PetscDS prob, PetscInt f, PetscBool *implicit) 788249df284SMatthew G. Knepley { 789249df284SMatthew G. Knepley PetscFunctionBegin; 790249df284SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 791249df284SMatthew G. Knepley PetscValidPointer(implicit, 3); 792249df284SMatthew 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); 793249df284SMatthew G. Knepley *implicit = prob->implicit[f]; 794249df284SMatthew G. Knepley PetscFunctionReturn(0); 795249df284SMatthew G. Knepley } 796249df284SMatthew G. Knepley 797249df284SMatthew G. Knepley /*@ 798249df284SMatthew G. Knepley PetscDSSetImplicit - Set the flag for implicit solve for this field. This is just a guide for IMEX 799249df284SMatthew G. Knepley 800249df284SMatthew G. Knepley Not collective 801249df284SMatthew G. Knepley 802249df284SMatthew G. Knepley Input Parameters: 803249df284SMatthew G. Knepley + prob - The PetscDS object 804249df284SMatthew G. Knepley . f - The field number 805249df284SMatthew G. Knepley - implicit - The flag indicating what kind of solve to use for this field 806249df284SMatthew G. Knepley 807249df284SMatthew G. Knepley Level: developer 808249df284SMatthew G. Knepley 809f744cafaSSander Arens .seealso: PetscDSGetImplicit(), PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate() 810249df284SMatthew G. Knepley @*/ 811249df284SMatthew G. Knepley PetscErrorCode PetscDSSetImplicit(PetscDS prob, PetscInt f, PetscBool implicit) 812249df284SMatthew G. Knepley { 813249df284SMatthew G. Knepley PetscFunctionBegin; 814249df284SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 815249df284SMatthew 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); 816249df284SMatthew G. Knepley prob->implicit[f] = implicit; 817249df284SMatthew G. Knepley PetscFunctionReturn(0); 818249df284SMatthew G. Knepley } 819249df284SMatthew G. Knepley 820a6cbbb48SMatthew G. Knepley /*@ 821a6cbbb48SMatthew G. Knepley PetscDSGetAdjacency - Returns the flags for determining variable influence 822a6cbbb48SMatthew G. Knepley 823a6cbbb48SMatthew G. Knepley Not collective 824a6cbbb48SMatthew G. Knepley 825a6cbbb48SMatthew G. Knepley Input Parameters: 826a6cbbb48SMatthew G. Knepley + prob - The PetscDS object 827a6cbbb48SMatthew G. Knepley - f - The field number 828a6cbbb48SMatthew G. Knepley 829a6cbbb48SMatthew G. Knepley Output Parameter: 830a6cbbb48SMatthew G. Knepley + useCone - Flag for variable influence starting with the cone operation 831a6cbbb48SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure 832a6cbbb48SMatthew G. Knepley 833a6cbbb48SMatthew G. Knepley Note: See the discussion in DMPlexGetAdjacencyUseCone() and DMPlexGetAdjacencyUseClosure() 834a6cbbb48SMatthew G. Knepley 835a6cbbb48SMatthew G. Knepley Level: developer 836a6cbbb48SMatthew G. Knepley 837f744cafaSSander Arens .seealso: PetscDSSetAdjacency(), DMPlexGetAdjacencyUseCone(), DMPlexGetAdjacencyUseClosure(), PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate() 838a6cbbb48SMatthew G. Knepley @*/ 839a6cbbb48SMatthew G. Knepley PetscErrorCode PetscDSGetAdjacency(PetscDS prob, PetscInt f, PetscBool *useCone, PetscBool *useClosure) 840a6cbbb48SMatthew G. Knepley { 841a6cbbb48SMatthew G. Knepley PetscFunctionBegin; 842a6cbbb48SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 8431cf84007SMatthew G. Knepley if (useCone) PetscValidPointer(useCone, 3); 8441cf84007SMatthew G. Knepley if (useClosure) PetscValidPointer(useClosure, 4); 84506cc46feSMatthew G. Knepley if (f < 0) { 84606cc46feSMatthew G. Knepley if (useCone) *useCone = prob->defaultAdj[0]; 84706cc46feSMatthew G. Knepley if (useClosure) *useClosure = prob->defaultAdj[1]; 84806cc46feSMatthew G. Knepley } else { 84906cc46feSMatthew 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); 8501cf84007SMatthew G. Knepley if (useCone) *useCone = prob->adjacency[f*2+0]; 8511cf84007SMatthew G. Knepley if (useClosure) *useClosure = prob->adjacency[f*2+1]; 85206cc46feSMatthew G. Knepley } 853a6cbbb48SMatthew G. Knepley PetscFunctionReturn(0); 854a6cbbb48SMatthew G. Knepley } 855a6cbbb48SMatthew G. Knepley 856a6cbbb48SMatthew G. Knepley /*@ 857a6cbbb48SMatthew G. Knepley PetscDSSetAdjacency - Set the flags for determining variable influence 858a6cbbb48SMatthew G. Knepley 859a6cbbb48SMatthew G. Knepley Not collective 860a6cbbb48SMatthew G. Knepley 861a6cbbb48SMatthew G. Knepley Input Parameters: 862a6cbbb48SMatthew G. Knepley + prob - The PetscDS object 863a6cbbb48SMatthew G. Knepley . f - The field number 864a6cbbb48SMatthew G. Knepley . useCone - Flag for variable influence starting with the cone operation 865a6cbbb48SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure 866a6cbbb48SMatthew G. Knepley 867a6cbbb48SMatthew G. Knepley Note: See the discussion in DMPlexGetAdjacencyUseCone() and DMPlexGetAdjacencyUseClosure() 868a6cbbb48SMatthew G. Knepley 869a6cbbb48SMatthew G. Knepley Level: developer 870a6cbbb48SMatthew G. Knepley 871f744cafaSSander Arens .seealso: PetscDSGetAdjacency(), DMPlexGetAdjacencyUseCone(), DMPlexGetAdjacencyUseClosure(), PetscDSSetDiscretization(), PetscDSAddDiscretization(), PetscDSGetNumFields(), PetscDSCreate() 872a6cbbb48SMatthew G. Knepley @*/ 873a6cbbb48SMatthew G. Knepley PetscErrorCode PetscDSSetAdjacency(PetscDS prob, PetscInt f, PetscBool useCone, PetscBool useClosure) 874a6cbbb48SMatthew G. Knepley { 875a6cbbb48SMatthew G. Knepley PetscFunctionBegin; 876a6cbbb48SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 87706cc46feSMatthew G. Knepley if (f < 0) { 87806cc46feSMatthew G. Knepley prob->defaultAdj[0] = useCone; 87906cc46feSMatthew G. Knepley prob->defaultAdj[1] = useClosure; 88006cc46feSMatthew G. Knepley } else { 88106cc46feSMatthew 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); 882a6cbbb48SMatthew G. Knepley prob->adjacency[f*2+0] = useCone; 883a6cbbb48SMatthew G. Knepley prob->adjacency[f*2+1] = useClosure; 88406cc46feSMatthew G. Knepley } 885a6cbbb48SMatthew G. Knepley PetscFunctionReturn(0); 886a6cbbb48SMatthew G. Knepley } 887a6cbbb48SMatthew G. Knepley 8882764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetObjective(PetscDS prob, PetscInt f, 88930b9ff8bSMatthew G. Knepley void (**obj)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 890194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 891194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 89297b6e6e8SMatthew G. Knepley PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar obj[])) 8932764a2aaSMatthew G. Knepley { 8942764a2aaSMatthew G. Knepley PetscFunctionBegin; 8952764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 8962764a2aaSMatthew G. Knepley PetscValidPointer(obj, 2); 8972764a2aaSMatthew 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); 8982764a2aaSMatthew G. Knepley *obj = prob->obj[f]; 8992764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 9002764a2aaSMatthew G. Knepley } 9012764a2aaSMatthew G. Knepley 9022764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetObjective(PetscDS prob, PetscInt f, 90330b9ff8bSMatthew G. Knepley void (*obj)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 904194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 905194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 90697b6e6e8SMatthew G. Knepley PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar obj[])) 9072764a2aaSMatthew G. Knepley { 9082764a2aaSMatthew G. Knepley PetscErrorCode ierr; 9092764a2aaSMatthew G. Knepley 9102764a2aaSMatthew G. Knepley PetscFunctionBegin; 9112764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 912de716cbcSToby Isaac if (obj) PetscValidFunction(obj, 2); 9132764a2aaSMatthew G. Knepley if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f); 9142764a2aaSMatthew G. Knepley ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr); 9152764a2aaSMatthew G. Knepley prob->obj[f] = obj; 9162764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 9172764a2aaSMatthew G. Knepley } 9182764a2aaSMatthew G. Knepley 919194d53e6SMatthew G. Knepley /*@C 920194d53e6SMatthew G. Knepley PetscDSGetResidual - Get the pointwise residual function for a given test field 921194d53e6SMatthew G. Knepley 922194d53e6SMatthew G. Knepley Not collective 923194d53e6SMatthew G. Knepley 924194d53e6SMatthew G. Knepley Input Parameters: 925194d53e6SMatthew G. Knepley + prob - The PetscDS 926194d53e6SMatthew G. Knepley - f - The test field number 927194d53e6SMatthew G. Knepley 928194d53e6SMatthew G. Knepley Output Parameters: 929194d53e6SMatthew G. Knepley + f0 - integrand for the test function term 930194d53e6SMatthew G. Knepley - f1 - integrand for the test function gradient term 931194d53e6SMatthew G. Knepley 932194d53e6SMatthew G. Knepley Note: We are using a first order FEM model for the weak form: 933194d53e6SMatthew G. Knepley 934194d53e6SMatthew 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) 935194d53e6SMatthew G. Knepley 936194d53e6SMatthew G. Knepley The calling sequence for the callbacks f0 and f1 is given by: 937194d53e6SMatthew G. Knepley 93830b9ff8bSMatthew G. Knepley $ f0(PetscInt dim, PetscInt Nf, PetscInt NfAux, 939194d53e6SMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 940194d53e6SMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 94130b9ff8bSMatthew G. Knepley $ PetscReal t, const PetscReal x[], PetscScalar f0[]) 942194d53e6SMatthew G. Knepley 943194d53e6SMatthew G. Knepley + dim - the spatial dimension 944194d53e6SMatthew G. Knepley . Nf - the number of fields 945194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 946194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 947194d53e6SMatthew G. Knepley . u - each field evaluated at the current point 948194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 949194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 950194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 951194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 952194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 953194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 954194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 955194d53e6SMatthew G. Knepley . t - current time 956194d53e6SMatthew G. Knepley . x - coordinates of the current point 95797b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters 95897b6e6e8SMatthew G. Knepley . constants - constant parameters 959194d53e6SMatthew G. Knepley - f0 - output values at the current point 960194d53e6SMatthew G. Knepley 961194d53e6SMatthew G. Knepley Level: intermediate 962194d53e6SMatthew G. Knepley 963194d53e6SMatthew G. Knepley .seealso: PetscDSSetResidual() 964194d53e6SMatthew G. Knepley @*/ 9652764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetResidual(PetscDS prob, PetscInt f, 96630b9ff8bSMatthew G. Knepley void (**f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 967194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 968194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 96997b6e6e8SMatthew G. Knepley PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f0[]), 97030b9ff8bSMatthew G. Knepley void (**f1)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 971194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 972194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 97397b6e6e8SMatthew G. Knepley PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f1[])) 9742764a2aaSMatthew G. Knepley { 9752764a2aaSMatthew G. Knepley PetscFunctionBegin; 9762764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 9772764a2aaSMatthew 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); 9782764a2aaSMatthew G. Knepley if (f0) {PetscValidPointer(f0, 3); *f0 = prob->f[f*2+0];} 9792764a2aaSMatthew G. Knepley if (f1) {PetscValidPointer(f1, 4); *f1 = prob->f[f*2+1];} 9802764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 9812764a2aaSMatthew G. Knepley } 9822764a2aaSMatthew G. Knepley 983194d53e6SMatthew G. Knepley /*@C 984194d53e6SMatthew G. Knepley PetscDSSetResidual - Set the pointwise residual function for a given test field 985194d53e6SMatthew G. Knepley 986194d53e6SMatthew G. Knepley Not collective 987194d53e6SMatthew G. Knepley 988194d53e6SMatthew G. Knepley Input Parameters: 989194d53e6SMatthew G. Knepley + prob - The PetscDS 990194d53e6SMatthew G. Knepley . f - The test field number 991194d53e6SMatthew G. Knepley . f0 - integrand for the test function term 992194d53e6SMatthew G. Knepley - f1 - integrand for the test function gradient term 993194d53e6SMatthew G. Knepley 994194d53e6SMatthew G. Knepley Note: We are using a first order FEM model for the weak form: 995194d53e6SMatthew G. Knepley 996194d53e6SMatthew 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) 997194d53e6SMatthew G. Knepley 998194d53e6SMatthew G. Knepley The calling sequence for the callbacks f0 and f1 is given by: 999194d53e6SMatthew G. Knepley 100030b9ff8bSMatthew G. Knepley $ f0(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1001194d53e6SMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1002194d53e6SMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 100330b9ff8bSMatthew G. Knepley $ PetscReal t, const PetscReal x[], PetscScalar f0[]) 1004194d53e6SMatthew G. Knepley 1005194d53e6SMatthew G. Knepley + dim - the spatial dimension 1006194d53e6SMatthew G. Knepley . Nf - the number of fields 1007194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 1008194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 1009194d53e6SMatthew G. Knepley . u - each field evaluated at the current point 1010194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 1011194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 1012194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 1013194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 1014194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 1015194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 1016194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 1017194d53e6SMatthew G. Knepley . t - current time 1018194d53e6SMatthew G. Knepley . x - coordinates of the current point 101997b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters 102097b6e6e8SMatthew G. Knepley . constants - constant parameters 1021194d53e6SMatthew G. Knepley - f0 - output values at the current point 1022194d53e6SMatthew G. Knepley 1023194d53e6SMatthew G. Knepley Level: intermediate 1024194d53e6SMatthew G. Knepley 1025194d53e6SMatthew G. Knepley .seealso: PetscDSGetResidual() 1026194d53e6SMatthew G. Knepley @*/ 10272764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetResidual(PetscDS prob, PetscInt f, 102830b9ff8bSMatthew G. Knepley void (*f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1029194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1030194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 103197b6e6e8SMatthew G. Knepley PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f0[]), 103230b9ff8bSMatthew G. Knepley void (*f1)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1033194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1034194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 103597b6e6e8SMatthew G. Knepley PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f1[])) 10362764a2aaSMatthew G. Knepley { 10372764a2aaSMatthew G. Knepley PetscErrorCode ierr; 10382764a2aaSMatthew G. Knepley 10392764a2aaSMatthew G. Knepley PetscFunctionBegin; 10402764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 1041f866a1d0SMatthew G. Knepley if (f0) PetscValidFunction(f0, 3); 1042f866a1d0SMatthew G. Knepley if (f1) PetscValidFunction(f1, 4); 10432764a2aaSMatthew G. Knepley if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f); 10442764a2aaSMatthew G. Knepley ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr); 10452764a2aaSMatthew G. Knepley prob->f[f*2+0] = f0; 10462764a2aaSMatthew G. Knepley prob->f[f*2+1] = f1; 10472764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 10482764a2aaSMatthew G. Knepley } 10492764a2aaSMatthew G. Knepley 10503e75805dSMatthew G. Knepley /*@C 10513e75805dSMatthew G. Knepley PetscDSHasJacobian - Signals that Jacobian functions have been set 10523e75805dSMatthew G. Knepley 10533e75805dSMatthew G. Knepley Not collective 10543e75805dSMatthew G. Knepley 10553e75805dSMatthew G. Knepley Input Parameter: 10563e75805dSMatthew G. Knepley . prob - The PetscDS 10573e75805dSMatthew G. Knepley 10583e75805dSMatthew G. Knepley Output Parameter: 10593e75805dSMatthew G. Knepley . hasJac - flag that pointwise function for the Jacobian has been set 10603e75805dSMatthew G. Knepley 10613e75805dSMatthew G. Knepley Level: intermediate 10623e75805dSMatthew G. Knepley 10633e75805dSMatthew G. Knepley .seealso: PetscDSGetJacobianPreconditioner(), PetscDSSetJacobianPreconditioner(), PetscDSGetJacobian() 10643e75805dSMatthew G. Knepley @*/ 10653e75805dSMatthew G. Knepley PetscErrorCode PetscDSHasJacobian(PetscDS prob, PetscBool *hasJac) 10663e75805dSMatthew G. Knepley { 10673e75805dSMatthew G. Knepley PetscInt f, g, h; 10683e75805dSMatthew G. Knepley 10693e75805dSMatthew G. Knepley PetscFunctionBegin; 10703e75805dSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 10713e75805dSMatthew G. Knepley *hasJac = PETSC_FALSE; 10723e75805dSMatthew G. Knepley for (f = 0; f < prob->Nf; ++f) { 10733e75805dSMatthew G. Knepley for (g = 0; g < prob->Nf; ++g) { 10743e75805dSMatthew G. Knepley for (h = 0; h < 4; ++h) { 10753e75805dSMatthew G. Knepley if (prob->g[(f*prob->Nf + g)*4+h]) *hasJac = PETSC_TRUE; 10763e75805dSMatthew G. Knepley } 10773e75805dSMatthew G. Knepley } 10783e75805dSMatthew G. Knepley } 10793e75805dSMatthew G. Knepley PetscFunctionReturn(0); 10803e75805dSMatthew G. Knepley } 10813e75805dSMatthew G. Knepley 1082194d53e6SMatthew G. Knepley /*@C 1083194d53e6SMatthew G. Knepley PetscDSGetJacobian - Get the pointwise Jacobian function for given test and basis field 1084194d53e6SMatthew G. Knepley 1085194d53e6SMatthew G. Knepley Not collective 1086194d53e6SMatthew G. Knepley 1087194d53e6SMatthew G. Knepley Input Parameters: 1088194d53e6SMatthew G. Knepley + prob - The PetscDS 1089194d53e6SMatthew G. Knepley . f - The test field number 1090194d53e6SMatthew G. Knepley - g - The field number 1091194d53e6SMatthew G. Knepley 1092194d53e6SMatthew G. Knepley Output Parameters: 1093194d53e6SMatthew G. Knepley + g0 - integrand for the test and basis function term 1094194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term 1095194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term 1096194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term 1097194d53e6SMatthew G. Knepley 1098194d53e6SMatthew G. Knepley Note: We are using a first order FEM model for the weak form: 1099194d53e6SMatthew G. Knepley 1100194d53e6SMatthew 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 1101194d53e6SMatthew G. Knepley 1102194d53e6SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by: 1103194d53e6SMatthew G. Knepley 110430b9ff8bSMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1105194d53e6SMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1106194d53e6SMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 110730b9ff8bSMatthew G. Knepley $ PetscReal t, const PetscReal u_tShift, const PetscReal x[], PetscScalar g0[]) 1108194d53e6SMatthew G. Knepley 1109194d53e6SMatthew G. Knepley + dim - the spatial dimension 1110194d53e6SMatthew G. Knepley . Nf - the number of fields 1111194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 1112194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 1113194d53e6SMatthew G. Knepley . u - each field evaluated at the current point 1114194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 1115194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 1116194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 1117194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 1118194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 1119194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 1120194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 1121194d53e6SMatthew G. Knepley . t - current time 11222aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t 1123194d53e6SMatthew G. Knepley . x - coordinates of the current point 112497b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters 112597b6e6e8SMatthew G. Knepley . constants - constant parameters 1126194d53e6SMatthew G. Knepley - g0 - output values at the current point 1127194d53e6SMatthew G. Knepley 1128194d53e6SMatthew G. Knepley Level: intermediate 1129194d53e6SMatthew G. Knepley 1130194d53e6SMatthew G. Knepley .seealso: PetscDSSetJacobian() 1131194d53e6SMatthew G. Knepley @*/ 11322764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetJacobian(PetscDS prob, PetscInt f, PetscInt g, 113330b9ff8bSMatthew G. Knepley void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1134194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1135194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 113697b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]), 113730b9ff8bSMatthew G. Knepley void (**g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1138194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1139194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 114097b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]), 114130b9ff8bSMatthew G. Knepley void (**g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1142194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1143194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 114497b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]), 114530b9ff8bSMatthew G. Knepley void (**g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1146194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1147194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 114897b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[])) 11492764a2aaSMatthew G. Knepley { 11502764a2aaSMatthew G. Knepley PetscFunctionBegin; 11512764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 11522764a2aaSMatthew 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); 11532764a2aaSMatthew 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); 11542764a2aaSMatthew G. Knepley if (g0) {PetscValidPointer(g0, 4); *g0 = prob->g[(f*prob->Nf + g)*4+0];} 11552764a2aaSMatthew G. Knepley if (g1) {PetscValidPointer(g1, 5); *g1 = prob->g[(f*prob->Nf + g)*4+1];} 11562764a2aaSMatthew G. Knepley if (g2) {PetscValidPointer(g2, 6); *g2 = prob->g[(f*prob->Nf + g)*4+2];} 11572764a2aaSMatthew G. Knepley if (g3) {PetscValidPointer(g3, 7); *g3 = prob->g[(f*prob->Nf + g)*4+3];} 11582764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 11592764a2aaSMatthew G. Knepley } 11602764a2aaSMatthew G. Knepley 1161194d53e6SMatthew G. Knepley /*@C 1162194d53e6SMatthew G. Knepley PetscDSSetJacobian - Set the pointwise Jacobian function for given test and basis fields 1163194d53e6SMatthew G. Knepley 1164194d53e6SMatthew G. Knepley Not collective 1165194d53e6SMatthew G. Knepley 1166194d53e6SMatthew G. Knepley Input Parameters: 1167194d53e6SMatthew G. Knepley + prob - The PetscDS 1168194d53e6SMatthew G. Knepley . f - The test field number 1169194d53e6SMatthew G. Knepley . g - The field number 1170194d53e6SMatthew G. Knepley . g0 - integrand for the test and basis function term 1171194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term 1172194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term 1173194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term 1174194d53e6SMatthew G. Knepley 1175194d53e6SMatthew G. Knepley Note: We are using a first order FEM model for the weak form: 1176194d53e6SMatthew G. Knepley 1177194d53e6SMatthew 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 1178194d53e6SMatthew G. Knepley 1179194d53e6SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by: 1180194d53e6SMatthew G. Knepley 118130b9ff8bSMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1182194d53e6SMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1183194d53e6SMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 118430b9ff8bSMatthew G. Knepley $ PetscReal t, const PetscReal x[], PetscScalar g0[]) 1185194d53e6SMatthew G. Knepley 1186194d53e6SMatthew G. Knepley + dim - the spatial dimension 1187194d53e6SMatthew G. Knepley . Nf - the number of fields 1188194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 1189194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 1190194d53e6SMatthew G. Knepley . u - each field evaluated at the current point 1191194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 1192194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 1193194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 1194194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 1195194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 1196194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 1197194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 1198194d53e6SMatthew G. Knepley . t - current time 11992aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t 1200194d53e6SMatthew G. Knepley . x - coordinates of the current point 120197b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters 120297b6e6e8SMatthew G. Knepley . constants - constant parameters 1203194d53e6SMatthew G. Knepley - g0 - output values at the current point 1204194d53e6SMatthew G. Knepley 1205194d53e6SMatthew G. Knepley Level: intermediate 1206194d53e6SMatthew G. Knepley 1207194d53e6SMatthew G. Knepley .seealso: PetscDSGetJacobian() 1208194d53e6SMatthew G. Knepley @*/ 12092764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetJacobian(PetscDS prob, PetscInt f, PetscInt g, 121030b9ff8bSMatthew G. Knepley void (*g0)(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 g0[]), 121430b9ff8bSMatthew G. Knepley void (*g1)(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 g1[]), 121830b9ff8bSMatthew G. Knepley void (*g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1219194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1220194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 122197b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]), 122230b9ff8bSMatthew G. Knepley void (*g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1223194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1224194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 122597b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[])) 12262764a2aaSMatthew G. Knepley { 12272764a2aaSMatthew G. Knepley PetscErrorCode ierr; 12282764a2aaSMatthew G. Knepley 12292764a2aaSMatthew G. Knepley PetscFunctionBegin; 12302764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 12312764a2aaSMatthew G. Knepley if (g0) PetscValidFunction(g0, 4); 12322764a2aaSMatthew G. Knepley if (g1) PetscValidFunction(g1, 5); 12332764a2aaSMatthew G. Knepley if (g2) PetscValidFunction(g2, 6); 12342764a2aaSMatthew G. Knepley if (g3) PetscValidFunction(g3, 7); 12352764a2aaSMatthew G. Knepley if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f); 12362764a2aaSMatthew G. Knepley if (g < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", g); 12372764a2aaSMatthew G. Knepley ierr = PetscDSEnlarge_Static(prob, PetscMax(f, g)+1);CHKERRQ(ierr); 12382764a2aaSMatthew G. Knepley prob->g[(f*prob->Nf + g)*4+0] = g0; 12392764a2aaSMatthew G. Knepley prob->g[(f*prob->Nf + g)*4+1] = g1; 12402764a2aaSMatthew G. Knepley prob->g[(f*prob->Nf + g)*4+2] = g2; 12412764a2aaSMatthew G. Knepley prob->g[(f*prob->Nf + g)*4+3] = g3; 12422764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 12432764a2aaSMatthew G. Knepley } 12442764a2aaSMatthew G. Knepley 1245475e0ac9SMatthew G. Knepley /*@C 1246475e0ac9SMatthew G. Knepley PetscDSHasJacobianPreconditioner - Signals that a Jacobian preconditioner matrix has been set 1247475e0ac9SMatthew G. Knepley 1248475e0ac9SMatthew G. Knepley Not collective 1249475e0ac9SMatthew G. Knepley 1250475e0ac9SMatthew G. Knepley Input Parameter: 1251475e0ac9SMatthew G. Knepley . prob - The PetscDS 1252475e0ac9SMatthew G. Knepley 1253475e0ac9SMatthew G. Knepley Output Parameter: 1254475e0ac9SMatthew G. Knepley . hasJacPre - flag that pointwise function for Jacobian preconditioner matrix has been set 1255475e0ac9SMatthew G. Knepley 1256475e0ac9SMatthew G. Knepley Level: intermediate 1257475e0ac9SMatthew G. Knepley 1258475e0ac9SMatthew G. Knepley .seealso: PetscDSGetJacobianPreconditioner(), PetscDSSetJacobianPreconditioner(), PetscDSGetJacobian() 1259475e0ac9SMatthew G. Knepley @*/ 1260475e0ac9SMatthew G. Knepley PetscErrorCode PetscDSHasJacobianPreconditioner(PetscDS prob, PetscBool *hasJacPre) 1261475e0ac9SMatthew G. Knepley { 1262475e0ac9SMatthew G. Knepley PetscInt f, g, h; 1263475e0ac9SMatthew G. Knepley 1264475e0ac9SMatthew G. Knepley PetscFunctionBegin; 1265475e0ac9SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 1266475e0ac9SMatthew G. Knepley *hasJacPre = PETSC_FALSE; 1267475e0ac9SMatthew G. Knepley for (f = 0; f < prob->Nf; ++f) { 1268475e0ac9SMatthew G. Knepley for (g = 0; g < prob->Nf; ++g) { 1269475e0ac9SMatthew G. Knepley for (h = 0; h < 4; ++h) { 1270475e0ac9SMatthew G. Knepley if (prob->gp[(f*prob->Nf + g)*4+h]) *hasJacPre = PETSC_TRUE; 1271475e0ac9SMatthew G. Knepley } 1272475e0ac9SMatthew G. Knepley } 1273475e0ac9SMatthew G. Knepley } 1274475e0ac9SMatthew G. Knepley PetscFunctionReturn(0); 1275475e0ac9SMatthew G. Knepley } 1276475e0ac9SMatthew G. Knepley 1277475e0ac9SMatthew G. Knepley /*@C 1278475e0ac9SMatthew 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. 1279475e0ac9SMatthew G. Knepley 1280475e0ac9SMatthew G. Knepley Not collective 1281475e0ac9SMatthew G. Knepley 1282475e0ac9SMatthew G. Knepley Input Parameters: 1283475e0ac9SMatthew G. Knepley + prob - The PetscDS 1284475e0ac9SMatthew G. Knepley . f - The test field number 1285475e0ac9SMatthew G. Knepley - g - The field number 1286475e0ac9SMatthew G. Knepley 1287475e0ac9SMatthew G. Knepley Output Parameters: 1288475e0ac9SMatthew G. Knepley + g0 - integrand for the test and basis function term 1289475e0ac9SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term 1290475e0ac9SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term 1291475e0ac9SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term 1292475e0ac9SMatthew G. Knepley 1293475e0ac9SMatthew G. Knepley Note: We are using a first order FEM model for the weak form: 1294475e0ac9SMatthew G. Knepley 1295475e0ac9SMatthew 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 1296475e0ac9SMatthew G. Knepley 1297475e0ac9SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by: 1298475e0ac9SMatthew G. Knepley 1299475e0ac9SMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1300475e0ac9SMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1301475e0ac9SMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 1302475e0ac9SMatthew G. Knepley $ PetscReal t, const PetscReal u_tShift, const PetscReal x[], PetscScalar g0[]) 1303475e0ac9SMatthew G. Knepley 1304475e0ac9SMatthew G. Knepley + dim - the spatial dimension 1305475e0ac9SMatthew G. Knepley . Nf - the number of fields 1306475e0ac9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 1307475e0ac9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 1308475e0ac9SMatthew G. Knepley . u - each field evaluated at the current point 1309475e0ac9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 1310475e0ac9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 1311475e0ac9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 1312475e0ac9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 1313475e0ac9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 1314475e0ac9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 1315475e0ac9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 1316475e0ac9SMatthew G. Knepley . t - current time 1317475e0ac9SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t 1318475e0ac9SMatthew G. Knepley . x - coordinates of the current point 131997b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters 132097b6e6e8SMatthew G. Knepley . constants - constant parameters 1321475e0ac9SMatthew G. Knepley - g0 - output values at the current point 1322475e0ac9SMatthew G. Knepley 1323475e0ac9SMatthew G. Knepley Level: intermediate 1324475e0ac9SMatthew G. Knepley 1325475e0ac9SMatthew G. Knepley .seealso: PetscDSSetJacobianPreconditioner(), PetscDSGetJacobian() 1326475e0ac9SMatthew G. Knepley @*/ 1327475e0ac9SMatthew G. Knepley PetscErrorCode PetscDSGetJacobianPreconditioner(PetscDS prob, PetscInt f, PetscInt g, 1328475e0ac9SMatthew G. Knepley void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1329475e0ac9SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1330475e0ac9SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 133197b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]), 1332475e0ac9SMatthew G. Knepley void (**g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1333475e0ac9SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1334475e0ac9SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 133597b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]), 1336475e0ac9SMatthew G. Knepley void (**g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1337475e0ac9SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1338475e0ac9SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 133997b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]), 1340475e0ac9SMatthew G. Knepley void (**g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1341475e0ac9SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1342475e0ac9SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 134397b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[])) 1344475e0ac9SMatthew G. Knepley { 1345475e0ac9SMatthew G. Knepley PetscFunctionBegin; 1346475e0ac9SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 1347475e0ac9SMatthew 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); 1348475e0ac9SMatthew 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); 1349475e0ac9SMatthew G. Knepley if (g0) {PetscValidPointer(g0, 4); *g0 = prob->gp[(f*prob->Nf + g)*4+0];} 1350475e0ac9SMatthew G. Knepley if (g1) {PetscValidPointer(g1, 5); *g1 = prob->gp[(f*prob->Nf + g)*4+1];} 1351475e0ac9SMatthew G. Knepley if (g2) {PetscValidPointer(g2, 6); *g2 = prob->gp[(f*prob->Nf + g)*4+2];} 1352475e0ac9SMatthew G. Knepley if (g3) {PetscValidPointer(g3, 7); *g3 = prob->gp[(f*prob->Nf + g)*4+3];} 1353475e0ac9SMatthew G. Knepley PetscFunctionReturn(0); 1354475e0ac9SMatthew G. Knepley } 1355475e0ac9SMatthew G. Knepley 1356475e0ac9SMatthew G. Knepley /*@C 1357475e0ac9SMatthew 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. 1358475e0ac9SMatthew G. Knepley 1359475e0ac9SMatthew G. Knepley Not collective 1360475e0ac9SMatthew G. Knepley 1361475e0ac9SMatthew G. Knepley Input Parameters: 1362475e0ac9SMatthew G. Knepley + prob - The PetscDS 1363475e0ac9SMatthew G. Knepley . f - The test field number 1364475e0ac9SMatthew G. Knepley . g - The field number 1365475e0ac9SMatthew G. Knepley . g0 - integrand for the test and basis function term 1366475e0ac9SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term 1367475e0ac9SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term 1368475e0ac9SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term 1369475e0ac9SMatthew G. Knepley 1370475e0ac9SMatthew G. Knepley Note: We are using a first order FEM model for the weak form: 1371475e0ac9SMatthew G. Knepley 1372475e0ac9SMatthew 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 1373475e0ac9SMatthew G. Knepley 1374475e0ac9SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by: 1375475e0ac9SMatthew G. Knepley 1376475e0ac9SMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1377475e0ac9SMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1378475e0ac9SMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 1379475e0ac9SMatthew G. Knepley $ PetscReal t, const PetscReal x[], PetscScalar g0[]) 1380475e0ac9SMatthew G. Knepley 1381475e0ac9SMatthew G. Knepley + dim - the spatial dimension 1382475e0ac9SMatthew G. Knepley . Nf - the number of fields 1383475e0ac9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 1384475e0ac9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 1385475e0ac9SMatthew G. Knepley . u - each field evaluated at the current point 1386475e0ac9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 1387475e0ac9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 1388475e0ac9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 1389475e0ac9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 1390475e0ac9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 1391475e0ac9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 1392475e0ac9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 1393475e0ac9SMatthew G. Knepley . t - current time 1394475e0ac9SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t 1395475e0ac9SMatthew G. Knepley . x - coordinates of the current point 139697b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters 139797b6e6e8SMatthew G. Knepley . constants - constant parameters 1398475e0ac9SMatthew G. Knepley - g0 - output values at the current point 1399475e0ac9SMatthew G. Knepley 1400475e0ac9SMatthew G. Knepley Level: intermediate 1401475e0ac9SMatthew G. Knepley 1402475e0ac9SMatthew G. Knepley .seealso: PetscDSGetJacobianPreconditioner(), PetscDSSetJacobian() 1403475e0ac9SMatthew G. Knepley @*/ 1404475e0ac9SMatthew G. Knepley PetscErrorCode PetscDSSetJacobianPreconditioner(PetscDS prob, PetscInt f, PetscInt g, 1405475e0ac9SMatthew G. Knepley void (*g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1406475e0ac9SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1407475e0ac9SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 140897b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]), 1409475e0ac9SMatthew G. Knepley void (*g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1410475e0ac9SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1411475e0ac9SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 141297b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]), 1413475e0ac9SMatthew G. Knepley void (*g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1414475e0ac9SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1415475e0ac9SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 141697b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]), 1417475e0ac9SMatthew G. Knepley void (*g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1418475e0ac9SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1419475e0ac9SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 142097b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[])) 1421475e0ac9SMatthew G. Knepley { 1422475e0ac9SMatthew G. Knepley PetscErrorCode ierr; 1423475e0ac9SMatthew G. Knepley 1424475e0ac9SMatthew G. Knepley PetscFunctionBegin; 1425475e0ac9SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 1426475e0ac9SMatthew G. Knepley if (g0) PetscValidFunction(g0, 4); 1427475e0ac9SMatthew G. Knepley if (g1) PetscValidFunction(g1, 5); 1428475e0ac9SMatthew G. Knepley if (g2) PetscValidFunction(g2, 6); 1429475e0ac9SMatthew G. Knepley if (g3) PetscValidFunction(g3, 7); 1430475e0ac9SMatthew G. Knepley if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f); 1431475e0ac9SMatthew G. Knepley if (g < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", g); 1432475e0ac9SMatthew G. Knepley ierr = PetscDSEnlarge_Static(prob, PetscMax(f, g)+1);CHKERRQ(ierr); 1433475e0ac9SMatthew G. Knepley prob->gp[(f*prob->Nf + g)*4+0] = g0; 1434475e0ac9SMatthew G. Knepley prob->gp[(f*prob->Nf + g)*4+1] = g1; 1435475e0ac9SMatthew G. Knepley prob->gp[(f*prob->Nf + g)*4+2] = g2; 1436475e0ac9SMatthew G. Knepley prob->gp[(f*prob->Nf + g)*4+3] = g3; 1437475e0ac9SMatthew G. Knepley PetscFunctionReturn(0); 1438475e0ac9SMatthew G. Knepley } 1439475e0ac9SMatthew G. Knepley 1440b7e05686SMatthew G. Knepley /*@C 1441b7e05686SMatthew G. Knepley PetscDSHasDynamicJacobian - Signals that a dynamic Jacobian, dF/du_t, has been set 1442b7e05686SMatthew G. Knepley 1443b7e05686SMatthew G. Knepley Not collective 1444b7e05686SMatthew G. Knepley 1445b7e05686SMatthew G. Knepley Input Parameter: 1446b7e05686SMatthew G. Knepley . prob - The PetscDS 1447b7e05686SMatthew G. Knepley 1448b7e05686SMatthew G. Knepley Output Parameter: 1449b7e05686SMatthew G. Knepley . hasDynJac - flag that pointwise function for dynamic Jacobian has been set 1450b7e05686SMatthew G. Knepley 1451b7e05686SMatthew G. Knepley Level: intermediate 1452b7e05686SMatthew G. Knepley 1453b7e05686SMatthew G. Knepley .seealso: PetscDSGetDynamicJacobian(), PetscDSSetDynamicJacobian(), PetscDSGetJacobian() 1454b7e05686SMatthew G. Knepley @*/ 1455b7e05686SMatthew G. Knepley PetscErrorCode PetscDSHasDynamicJacobian(PetscDS prob, PetscBool *hasDynJac) 1456b7e05686SMatthew G. Knepley { 1457b7e05686SMatthew G. Knepley PetscInt f, g, h; 1458b7e05686SMatthew G. Knepley 1459b7e05686SMatthew G. Knepley PetscFunctionBegin; 1460b7e05686SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 1461b7e05686SMatthew G. Knepley *hasDynJac = PETSC_FALSE; 1462b7e05686SMatthew G. Knepley for (f = 0; f < prob->Nf; ++f) { 1463b7e05686SMatthew G. Knepley for (g = 0; g < prob->Nf; ++g) { 1464b7e05686SMatthew G. Knepley for (h = 0; h < 4; ++h) { 1465b7e05686SMatthew G. Knepley if (prob->gt[(f*prob->Nf + g)*4+h]) *hasDynJac = PETSC_TRUE; 1466b7e05686SMatthew G. Knepley } 1467b7e05686SMatthew G. Knepley } 1468b7e05686SMatthew G. Knepley } 1469b7e05686SMatthew G. Knepley PetscFunctionReturn(0); 1470b7e05686SMatthew G. Knepley } 1471b7e05686SMatthew G. Knepley 1472b7e05686SMatthew G. Knepley /*@C 1473b7e05686SMatthew G. Knepley PetscDSGetDynamicJacobian - Get the pointwise dynamic Jacobian, dF/du_t, function for given test and basis field 1474b7e05686SMatthew G. Knepley 1475b7e05686SMatthew G. Knepley Not collective 1476b7e05686SMatthew G. Knepley 1477b7e05686SMatthew G. Knepley Input Parameters: 1478b7e05686SMatthew G. Knepley + prob - The PetscDS 1479b7e05686SMatthew G. Knepley . f - The test field number 1480b7e05686SMatthew G. Knepley - g - The field number 1481b7e05686SMatthew G. Knepley 1482b7e05686SMatthew G. Knepley Output Parameters: 1483b7e05686SMatthew G. Knepley + g0 - integrand for the test and basis function term 1484b7e05686SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term 1485b7e05686SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term 1486b7e05686SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term 1487b7e05686SMatthew G. Knepley 1488b7e05686SMatthew G. Knepley Note: We are using a first order FEM model for the weak form: 1489b7e05686SMatthew G. Knepley 1490b7e05686SMatthew 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 1491b7e05686SMatthew G. Knepley 1492b7e05686SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by: 1493b7e05686SMatthew G. Knepley 1494b7e05686SMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1495b7e05686SMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1496b7e05686SMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 1497b7e05686SMatthew G. Knepley $ PetscReal t, const PetscReal u_tShift, const PetscReal x[], PetscScalar g0[]) 1498b7e05686SMatthew G. Knepley 1499b7e05686SMatthew G. Knepley + dim - the spatial dimension 1500b7e05686SMatthew G. Knepley . Nf - the number of fields 1501b7e05686SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 1502b7e05686SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 1503b7e05686SMatthew G. Knepley . u - each field evaluated at the current point 1504b7e05686SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 1505b7e05686SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 1506b7e05686SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 1507b7e05686SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 1508b7e05686SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 1509b7e05686SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 1510b7e05686SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 1511b7e05686SMatthew G. Knepley . t - current time 1512b7e05686SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t 1513b7e05686SMatthew G. Knepley . x - coordinates of the current point 151497b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters 151597b6e6e8SMatthew G. Knepley . constants - constant parameters 1516b7e05686SMatthew G. Knepley - g0 - output values at the current point 1517b7e05686SMatthew G. Knepley 1518b7e05686SMatthew G. Knepley Level: intermediate 1519b7e05686SMatthew G. Knepley 1520b7e05686SMatthew G. Knepley .seealso: PetscDSSetJacobian() 1521b7e05686SMatthew G. Knepley @*/ 1522b7e05686SMatthew G. Knepley PetscErrorCode PetscDSGetDynamicJacobian(PetscDS prob, PetscInt f, PetscInt g, 1523b7e05686SMatthew G. Knepley void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1524b7e05686SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1525b7e05686SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 152697b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]), 1527b7e05686SMatthew G. Knepley void (**g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1528b7e05686SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1529b7e05686SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 153097b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]), 1531b7e05686SMatthew G. Knepley void (**g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1532b7e05686SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1533b7e05686SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 153497b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]), 1535b7e05686SMatthew G. Knepley void (**g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1536b7e05686SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1537b7e05686SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 153897b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[])) 1539b7e05686SMatthew G. Knepley { 1540b7e05686SMatthew G. Knepley PetscFunctionBegin; 1541b7e05686SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 1542b7e05686SMatthew 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); 1543b7e05686SMatthew 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); 1544b7e05686SMatthew G. Knepley if (g0) {PetscValidPointer(g0, 4); *g0 = prob->gt[(f*prob->Nf + g)*4+0];} 1545b7e05686SMatthew G. Knepley if (g1) {PetscValidPointer(g1, 5); *g1 = prob->gt[(f*prob->Nf + g)*4+1];} 1546b7e05686SMatthew G. Knepley if (g2) {PetscValidPointer(g2, 6); *g2 = prob->gt[(f*prob->Nf + g)*4+2];} 1547b7e05686SMatthew G. Knepley if (g3) {PetscValidPointer(g3, 7); *g3 = prob->gt[(f*prob->Nf + g)*4+3];} 1548b7e05686SMatthew G. Knepley PetscFunctionReturn(0); 1549b7e05686SMatthew G. Knepley } 1550b7e05686SMatthew G. Knepley 1551b7e05686SMatthew G. Knepley /*@C 1552b7e05686SMatthew G. Knepley PetscDSSetDynamicJacobian - Set the pointwise dynamic Jacobian, dF/du_t, function for given test and basis fields 1553b7e05686SMatthew G. Knepley 1554b7e05686SMatthew G. Knepley Not collective 1555b7e05686SMatthew G. Knepley 1556b7e05686SMatthew G. Knepley Input Parameters: 1557b7e05686SMatthew G. Knepley + prob - The PetscDS 1558b7e05686SMatthew G. Knepley . f - The test field number 1559b7e05686SMatthew G. Knepley . g - The field number 1560b7e05686SMatthew G. Knepley . g0 - integrand for the test and basis function term 1561b7e05686SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term 1562b7e05686SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term 1563b7e05686SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term 1564b7e05686SMatthew G. Knepley 1565b7e05686SMatthew G. Knepley Note: We are using a first order FEM model for the weak form: 1566b7e05686SMatthew G. Knepley 1567b7e05686SMatthew 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 1568b7e05686SMatthew G. Knepley 1569b7e05686SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by: 1570b7e05686SMatthew G. Knepley 1571b7e05686SMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1572b7e05686SMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1573b7e05686SMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 1574b7e05686SMatthew G. Knepley $ PetscReal t, const PetscReal x[], PetscScalar g0[]) 1575b7e05686SMatthew G. Knepley 1576b7e05686SMatthew G. Knepley + dim - the spatial dimension 1577b7e05686SMatthew G. Knepley . Nf - the number of fields 1578b7e05686SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 1579b7e05686SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 1580b7e05686SMatthew G. Knepley . u - each field evaluated at the current point 1581b7e05686SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 1582b7e05686SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 1583b7e05686SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 1584b7e05686SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 1585b7e05686SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 1586b7e05686SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 1587b7e05686SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 1588b7e05686SMatthew G. Knepley . t - current time 1589b7e05686SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t 1590b7e05686SMatthew G. Knepley . x - coordinates of the current point 159197b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters 159297b6e6e8SMatthew G. Knepley . constants - constant parameters 1593b7e05686SMatthew G. Knepley - g0 - output values at the current point 1594b7e05686SMatthew G. Knepley 1595b7e05686SMatthew G. Knepley Level: intermediate 1596b7e05686SMatthew G. Knepley 1597b7e05686SMatthew G. Knepley .seealso: PetscDSGetJacobian() 1598b7e05686SMatthew G. Knepley @*/ 1599b7e05686SMatthew G. Knepley PetscErrorCode PetscDSSetDynamicJacobian(PetscDS prob, PetscInt f, PetscInt g, 1600b7e05686SMatthew G. Knepley void (*g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1601b7e05686SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1602b7e05686SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 160397b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]), 1604b7e05686SMatthew G. Knepley void (*g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1605b7e05686SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1606b7e05686SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 160797b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]), 1608b7e05686SMatthew G. Knepley void (*g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1609b7e05686SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1610b7e05686SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 161197b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]), 1612b7e05686SMatthew G. Knepley void (*g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1613b7e05686SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1614b7e05686SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 161597b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[])) 1616b7e05686SMatthew G. Knepley { 1617b7e05686SMatthew G. Knepley PetscErrorCode ierr; 1618b7e05686SMatthew G. Knepley 1619b7e05686SMatthew G. Knepley PetscFunctionBegin; 1620b7e05686SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 1621b7e05686SMatthew G. Knepley if (g0) PetscValidFunction(g0, 4); 1622b7e05686SMatthew G. Knepley if (g1) PetscValidFunction(g1, 5); 1623b7e05686SMatthew G. Knepley if (g2) PetscValidFunction(g2, 6); 1624b7e05686SMatthew G. Knepley if (g3) PetscValidFunction(g3, 7); 1625b7e05686SMatthew G. Knepley if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f); 1626b7e05686SMatthew G. Knepley if (g < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", g); 1627b7e05686SMatthew G. Knepley ierr = PetscDSEnlarge_Static(prob, PetscMax(f, g)+1);CHKERRQ(ierr); 1628b7e05686SMatthew G. Knepley prob->gt[(f*prob->Nf + g)*4+0] = g0; 1629b7e05686SMatthew G. Knepley prob->gt[(f*prob->Nf + g)*4+1] = g1; 1630b7e05686SMatthew G. Knepley prob->gt[(f*prob->Nf + g)*4+2] = g2; 1631b7e05686SMatthew G. Knepley prob->gt[(f*prob->Nf + g)*4+3] = g3; 1632b7e05686SMatthew G. Knepley PetscFunctionReturn(0); 1633b7e05686SMatthew G. Knepley } 1634b7e05686SMatthew G. Knepley 16350c2f2876SMatthew G. Knepley /*@C 16360c2f2876SMatthew G. Knepley PetscDSGetRiemannSolver - Returns the Riemann solver for the given field 16370c2f2876SMatthew G. Knepley 16380c2f2876SMatthew G. Knepley Not collective 16390c2f2876SMatthew G. Knepley 16400c2f2876SMatthew G. Knepley Input Arguments: 16410c2f2876SMatthew G. Knepley + prob - The PetscDS object 16420c2f2876SMatthew G. Knepley - f - The field number 16430c2f2876SMatthew G. Knepley 16440c2f2876SMatthew G. Knepley Output Argument: 16450c2f2876SMatthew G. Knepley . r - Riemann solver 16460c2f2876SMatthew G. Knepley 16470c2f2876SMatthew G. Knepley Calling sequence for r: 16480c2f2876SMatthew G. Knepley 16495db36cf9SMatthew G. Knepley $ r(PetscInt dim, PetscInt Nf, const PetscReal x[], const PetscReal n[], const PetscScalar uL[], const PetscScalar uR[], PetscScalar flux[], void *ctx) 16500c2f2876SMatthew G. Knepley 16515db36cf9SMatthew G. Knepley + dim - The spatial dimension 16525db36cf9SMatthew G. Knepley . Nf - The number of fields 16535db36cf9SMatthew G. Knepley . x - The coordinates at a point on the interface 16540c2f2876SMatthew G. Knepley . n - The normal vector to the interface 16550c2f2876SMatthew G. Knepley . uL - The state vector to the left of the interface 16560c2f2876SMatthew G. Knepley . uR - The state vector to the right of the interface 16570c2f2876SMatthew G. Knepley . flux - output array of flux through the interface 165897b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters 165997b6e6e8SMatthew G. Knepley . constants - constant parameters 16600c2f2876SMatthew G. Knepley - ctx - optional user context 16610c2f2876SMatthew G. Knepley 16620c2f2876SMatthew G. Knepley Level: intermediate 16630c2f2876SMatthew G. Knepley 16640c2f2876SMatthew G. Knepley .seealso: PetscDSSetRiemannSolver() 16650c2f2876SMatthew G. Knepley @*/ 16660c2f2876SMatthew G. Knepley PetscErrorCode PetscDSGetRiemannSolver(PetscDS prob, PetscInt f, 166797b6e6e8SMatthew 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)) 16680c2f2876SMatthew G. Knepley { 16690c2f2876SMatthew G. Knepley PetscFunctionBegin; 16700c2f2876SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 16710c2f2876SMatthew 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); 16720c2f2876SMatthew G. Knepley PetscValidPointer(r, 3); 16730c2f2876SMatthew G. Knepley *r = prob->r[f]; 16740c2f2876SMatthew G. Knepley PetscFunctionReturn(0); 16750c2f2876SMatthew G. Knepley } 16760c2f2876SMatthew G. Knepley 16770c2f2876SMatthew G. Knepley /*@C 16780c2f2876SMatthew G. Knepley PetscDSSetRiemannSolver - Sets the Riemann solver for the given field 16790c2f2876SMatthew G. Knepley 16800c2f2876SMatthew G. Knepley Not collective 16810c2f2876SMatthew G. Knepley 16820c2f2876SMatthew G. Knepley Input Arguments: 16830c2f2876SMatthew G. Knepley + prob - The PetscDS object 16840c2f2876SMatthew G. Knepley . f - The field number 16850c2f2876SMatthew G. Knepley - r - Riemann solver 16860c2f2876SMatthew G. Knepley 16870c2f2876SMatthew G. Knepley Calling sequence for r: 16880c2f2876SMatthew G. Knepley 16895db36cf9SMatthew G. Knepley $ r(PetscInt dim, PetscInt Nf, const PetscReal x[], const PetscReal n[], const PetscScalar uL[], const PetscScalar uR[], PetscScalar flux[], void *ctx) 16900c2f2876SMatthew G. Knepley 16915db36cf9SMatthew G. Knepley + dim - The spatial dimension 16925db36cf9SMatthew G. Knepley . Nf - The number of fields 16935db36cf9SMatthew G. Knepley . x - The coordinates at a point on the interface 16940c2f2876SMatthew G. Knepley . n - The normal vector to the interface 16950c2f2876SMatthew G. Knepley . uL - The state vector to the left of the interface 16960c2f2876SMatthew G. Knepley . uR - The state vector to the right of the interface 16970c2f2876SMatthew G. Knepley . flux - output array of flux through the interface 169897b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters 169997b6e6e8SMatthew G. Knepley . constants - constant parameters 17000c2f2876SMatthew G. Knepley - ctx - optional user context 17010c2f2876SMatthew G. Knepley 17020c2f2876SMatthew G. Knepley Level: intermediate 17030c2f2876SMatthew G. Knepley 17040c2f2876SMatthew G. Knepley .seealso: PetscDSGetRiemannSolver() 17050c2f2876SMatthew G. Knepley @*/ 17060c2f2876SMatthew G. Knepley PetscErrorCode PetscDSSetRiemannSolver(PetscDS prob, PetscInt f, 170797b6e6e8SMatthew 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)) 17080c2f2876SMatthew G. Knepley { 17090c2f2876SMatthew G. Knepley PetscErrorCode ierr; 17100c2f2876SMatthew G. Knepley 17110c2f2876SMatthew G. Knepley PetscFunctionBegin; 17120c2f2876SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 1713de716cbcSToby Isaac if (r) PetscValidFunction(r, 3); 17140c2f2876SMatthew G. Knepley if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f); 17150c2f2876SMatthew G. Knepley ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr); 17160c2f2876SMatthew G. Knepley prob->r[f] = r; 17170c2f2876SMatthew G. Knepley PetscFunctionReturn(0); 17180c2f2876SMatthew G. Knepley } 17190c2f2876SMatthew G. Knepley 172032d2bbc9SMatthew G. Knepley /*@C 172132d2bbc9SMatthew G. Knepley PetscDSGetUpdate - Get the pointwise update function for a given field 172232d2bbc9SMatthew G. Knepley 172332d2bbc9SMatthew G. Knepley Not collective 172432d2bbc9SMatthew G. Knepley 172532d2bbc9SMatthew G. Knepley Input Parameters: 172632d2bbc9SMatthew G. Knepley + prob - The PetscDS 172732d2bbc9SMatthew G. Knepley - f - The field number 172832d2bbc9SMatthew G. Knepley 172932d2bbc9SMatthew G. Knepley Output Parameters: 173032d2bbc9SMatthew G. Knepley + update - update function 173132d2bbc9SMatthew G. Knepley 173232d2bbc9SMatthew G. Knepley Note: The calling sequence for the callback update is given by: 173332d2bbc9SMatthew G. Knepley 173432d2bbc9SMatthew G. Knepley $ update(PetscInt dim, PetscInt Nf, PetscInt NfAux, 173532d2bbc9SMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 173632d2bbc9SMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 173732d2bbc9SMatthew G. Knepley $ PetscReal t, const PetscReal x[], PetscScalar uNew[]) 173832d2bbc9SMatthew G. Knepley 173932d2bbc9SMatthew G. Knepley + dim - the spatial dimension 174032d2bbc9SMatthew G. Knepley . Nf - the number of fields 174132d2bbc9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 174232d2bbc9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 174332d2bbc9SMatthew G. Knepley . u - each field evaluated at the current point 174432d2bbc9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 174532d2bbc9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 174632d2bbc9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 174732d2bbc9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 174832d2bbc9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 174932d2bbc9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 175032d2bbc9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 175132d2bbc9SMatthew G. Knepley . t - current time 175232d2bbc9SMatthew G. Knepley . x - coordinates of the current point 175332d2bbc9SMatthew G. Knepley - uNew - new value for field at the current point 175432d2bbc9SMatthew G. Knepley 175532d2bbc9SMatthew G. Knepley Level: intermediate 175632d2bbc9SMatthew G. Knepley 175732d2bbc9SMatthew G. Knepley .seealso: PetscDSSetUpdate(), PetscDSSetResidual() 175832d2bbc9SMatthew G. Knepley @*/ 175932d2bbc9SMatthew G. Knepley PetscErrorCode PetscDSGetUpdate(PetscDS prob, PetscInt f, 176032d2bbc9SMatthew G. Knepley void (**update)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 176132d2bbc9SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 176232d2bbc9SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 17633fa77dffSMatthew G. Knepley PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar uNew[])) 176432d2bbc9SMatthew G. Knepley { 176532d2bbc9SMatthew G. Knepley PetscFunctionBegin; 176632d2bbc9SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 176732d2bbc9SMatthew 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); 176832d2bbc9SMatthew G. Knepley if (update) {PetscValidPointer(update, 3); *update = prob->update[f];} 176932d2bbc9SMatthew G. Knepley PetscFunctionReturn(0); 177032d2bbc9SMatthew G. Knepley } 177132d2bbc9SMatthew G. Knepley 177232d2bbc9SMatthew G. Knepley /*@C 17733fa77dffSMatthew G. Knepley PetscDSSetUpdate - Set the pointwise update function for a given field 177432d2bbc9SMatthew G. Knepley 177532d2bbc9SMatthew G. Knepley Not collective 177632d2bbc9SMatthew G. Knepley 177732d2bbc9SMatthew G. Knepley Input Parameters: 177832d2bbc9SMatthew G. Knepley + prob - The PetscDS 177932d2bbc9SMatthew G. Knepley . f - The field number 178032d2bbc9SMatthew G. Knepley - update - update function 178132d2bbc9SMatthew G. Knepley 178232d2bbc9SMatthew G. Knepley Note: The calling sequence for the callback update is given by: 178332d2bbc9SMatthew G. Knepley 178432d2bbc9SMatthew G. Knepley $ update(PetscInt dim, PetscInt Nf, PetscInt NfAux, 178532d2bbc9SMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 178632d2bbc9SMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 178732d2bbc9SMatthew G. Knepley $ PetscReal t, const PetscReal x[], PetscScalar uNew[]) 178832d2bbc9SMatthew G. Knepley 178932d2bbc9SMatthew G. Knepley + dim - the spatial dimension 179032d2bbc9SMatthew G. Knepley . Nf - the number of fields 179132d2bbc9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 179232d2bbc9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 179332d2bbc9SMatthew G. Knepley . u - each field evaluated at the current point 179432d2bbc9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 179532d2bbc9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 179632d2bbc9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 179732d2bbc9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 179832d2bbc9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 179932d2bbc9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 180032d2bbc9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 180132d2bbc9SMatthew G. Knepley . t - current time 180232d2bbc9SMatthew G. Knepley . x - coordinates of the current point 180332d2bbc9SMatthew G. Knepley - uNew - new field values at the current point 180432d2bbc9SMatthew G. Knepley 180532d2bbc9SMatthew G. Knepley Level: intermediate 180632d2bbc9SMatthew G. Knepley 180732d2bbc9SMatthew G. Knepley .seealso: PetscDSGetResidual() 180832d2bbc9SMatthew G. Knepley @*/ 180932d2bbc9SMatthew G. Knepley PetscErrorCode PetscDSSetUpdate(PetscDS prob, PetscInt f, 181032d2bbc9SMatthew G. Knepley void (*update)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 181132d2bbc9SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 181232d2bbc9SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 18133fa77dffSMatthew G. Knepley PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar uNew[])) 181432d2bbc9SMatthew G. Knepley { 181532d2bbc9SMatthew G. Knepley PetscErrorCode ierr; 181632d2bbc9SMatthew G. Knepley 181732d2bbc9SMatthew G. Knepley PetscFunctionBegin; 181832d2bbc9SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 181932d2bbc9SMatthew G. Knepley if (update) PetscValidFunction(update, 3); 182032d2bbc9SMatthew G. Knepley if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f); 182132d2bbc9SMatthew G. Knepley ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr); 182232d2bbc9SMatthew G. Knepley prob->update[f] = update; 182332d2bbc9SMatthew G. Knepley PetscFunctionReturn(0); 182432d2bbc9SMatthew G. Knepley } 182532d2bbc9SMatthew G. Knepley 18260c2f2876SMatthew G. Knepley PetscErrorCode PetscDSGetContext(PetscDS prob, PetscInt f, void **ctx) 18270c2f2876SMatthew G. Knepley { 18280c2f2876SMatthew G. Knepley PetscFunctionBegin; 18290c2f2876SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 18300c2f2876SMatthew 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); 18310c2f2876SMatthew G. Knepley PetscValidPointer(ctx, 3); 18320c2f2876SMatthew G. Knepley *ctx = prob->ctx[f]; 18330c2f2876SMatthew G. Knepley PetscFunctionReturn(0); 18340c2f2876SMatthew G. Knepley } 18350c2f2876SMatthew G. Knepley 18360c2f2876SMatthew G. Knepley PetscErrorCode PetscDSSetContext(PetscDS prob, PetscInt f, void *ctx) 18370c2f2876SMatthew G. Knepley { 18380c2f2876SMatthew G. Knepley PetscErrorCode ierr; 18390c2f2876SMatthew G. Knepley 18400c2f2876SMatthew G. Knepley PetscFunctionBegin; 18410c2f2876SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 18420c2f2876SMatthew G. Knepley if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f); 18430c2f2876SMatthew G. Knepley ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr); 18440c2f2876SMatthew G. Knepley prob->ctx[f] = ctx; 18450c2f2876SMatthew G. Knepley PetscFunctionReturn(0); 18460c2f2876SMatthew G. Knepley } 18470c2f2876SMatthew G. Knepley 1848194d53e6SMatthew G. Knepley /*@C 1849194d53e6SMatthew G. Knepley PetscDSGetBdResidual - Get the pointwise boundary residual function for a given test field 1850194d53e6SMatthew G. Knepley 1851194d53e6SMatthew G. Knepley Not collective 1852194d53e6SMatthew G. Knepley 1853194d53e6SMatthew G. Knepley Input Parameters: 1854194d53e6SMatthew G. Knepley + prob - The PetscDS 1855194d53e6SMatthew G. Knepley - f - The test field number 1856194d53e6SMatthew G. Knepley 1857194d53e6SMatthew G. Knepley Output Parameters: 1858194d53e6SMatthew G. Knepley + f0 - boundary integrand for the test function term 1859194d53e6SMatthew G. Knepley - f1 - boundary integrand for the test function gradient term 1860194d53e6SMatthew G. Knepley 1861194d53e6SMatthew G. Knepley Note: We are using a first order FEM model for the weak form: 1862194d53e6SMatthew G. Knepley 1863194d53e6SMatthew 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 1864194d53e6SMatthew G. Knepley 1865194d53e6SMatthew G. Knepley The calling sequence for the callbacks f0 and f1 is given by: 1866194d53e6SMatthew G. Knepley 186730b9ff8bSMatthew G. Knepley $ f0(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1868194d53e6SMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1869194d53e6SMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 187030b9ff8bSMatthew G. Knepley $ PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar f0[]) 1871194d53e6SMatthew G. Knepley 1872194d53e6SMatthew G. Knepley + dim - the spatial dimension 1873194d53e6SMatthew G. Knepley . Nf - the number of fields 1874194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 1875194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 1876194d53e6SMatthew G. Knepley . u - each field evaluated at the current point 1877194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 1878194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 1879194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 1880194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 1881194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 1882194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 1883194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 1884194d53e6SMatthew G. Knepley . t - current time 1885194d53e6SMatthew G. Knepley . x - coordinates of the current point 1886194d53e6SMatthew G. Knepley . n - unit normal at the current point 188797b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters 188897b6e6e8SMatthew G. Knepley . constants - constant parameters 1889194d53e6SMatthew G. Knepley - f0 - output values at the current point 1890194d53e6SMatthew G. Knepley 1891194d53e6SMatthew G. Knepley Level: intermediate 1892194d53e6SMatthew G. Knepley 1893194d53e6SMatthew G. Knepley .seealso: PetscDSSetBdResidual() 1894194d53e6SMatthew G. Knepley @*/ 18952764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetBdResidual(PetscDS prob, PetscInt f, 189630b9ff8bSMatthew G. Knepley void (**f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1897194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1898194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 189997b6e6e8SMatthew G. Knepley PetscReal t, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f0[]), 190030b9ff8bSMatthew G. Knepley void (**f1)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1901194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1902194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 190397b6e6e8SMatthew G. Knepley PetscReal t, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f1[])) 19042764a2aaSMatthew G. Knepley { 19052764a2aaSMatthew G. Knepley PetscFunctionBegin; 19062764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 19072764a2aaSMatthew 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); 19082764a2aaSMatthew G. Knepley if (f0) {PetscValidPointer(f0, 3); *f0 = prob->fBd[f*2+0];} 19092764a2aaSMatthew G. Knepley if (f1) {PetscValidPointer(f1, 4); *f1 = prob->fBd[f*2+1];} 19102764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 19112764a2aaSMatthew G. Knepley } 19122764a2aaSMatthew G. Knepley 1913194d53e6SMatthew G. Knepley /*@C 1914194d53e6SMatthew G. Knepley PetscDSSetBdResidual - Get the pointwise boundary residual function for a given test field 1915194d53e6SMatthew G. Knepley 1916194d53e6SMatthew G. Knepley Not collective 1917194d53e6SMatthew G. Knepley 1918194d53e6SMatthew G. Knepley Input Parameters: 1919194d53e6SMatthew G. Knepley + prob - The PetscDS 1920194d53e6SMatthew G. Knepley . f - The test field number 1921194d53e6SMatthew G. Knepley . f0 - boundary integrand for the test function term 1922194d53e6SMatthew G. Knepley - f1 - boundary integrand for the test function gradient term 1923194d53e6SMatthew G. Knepley 1924194d53e6SMatthew G. Knepley Note: We are using a first order FEM model for the weak form: 1925194d53e6SMatthew G. Knepley 1926194d53e6SMatthew 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 1927194d53e6SMatthew G. Knepley 1928194d53e6SMatthew G. Knepley The calling sequence for the callbacks f0 and f1 is given by: 1929194d53e6SMatthew G. Knepley 193030b9ff8bSMatthew G. Knepley $ f0(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1931194d53e6SMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1932194d53e6SMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 193330b9ff8bSMatthew G. Knepley $ PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar f0[]) 1934194d53e6SMatthew G. Knepley 1935194d53e6SMatthew G. Knepley + dim - the spatial dimension 1936194d53e6SMatthew G. Knepley . Nf - the number of fields 1937194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 1938194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 1939194d53e6SMatthew G. Knepley . u - each field evaluated at the current point 1940194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 1941194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 1942194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 1943194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 1944194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 1945194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 1946194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 1947194d53e6SMatthew G. Knepley . t - current time 1948194d53e6SMatthew G. Knepley . x - coordinates of the current point 1949194d53e6SMatthew G. Knepley . n - unit normal at the current point 195097b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters 195197b6e6e8SMatthew G. Knepley . constants - constant parameters 1952194d53e6SMatthew G. Knepley - f0 - output values at the current point 1953194d53e6SMatthew G. Knepley 1954194d53e6SMatthew G. Knepley Level: intermediate 1955194d53e6SMatthew G. Knepley 1956194d53e6SMatthew G. Knepley .seealso: PetscDSGetBdResidual() 1957194d53e6SMatthew G. Knepley @*/ 19582764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetBdResidual(PetscDS prob, PetscInt f, 195930b9ff8bSMatthew G. Knepley void (*f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1960194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1961194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 196297b6e6e8SMatthew G. Knepley PetscReal t, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f0[]), 196330b9ff8bSMatthew G. Knepley void (*f1)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 1964194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 1965194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 196697b6e6e8SMatthew G. Knepley PetscReal t, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f1[])) 19672764a2aaSMatthew G. Knepley { 19682764a2aaSMatthew G. Knepley PetscErrorCode ierr; 19692764a2aaSMatthew G. Knepley 19702764a2aaSMatthew G. Knepley PetscFunctionBegin; 19712764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 19722764a2aaSMatthew G. Knepley if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f); 19732764a2aaSMatthew G. Knepley ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr); 19742764a2aaSMatthew G. Knepley if (f0) {PetscValidFunction(f0, 3); prob->fBd[f*2+0] = f0;} 19752764a2aaSMatthew G. Knepley if (f1) {PetscValidFunction(f1, 4); prob->fBd[f*2+1] = f1;} 19762764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 19772764a2aaSMatthew G. Knepley } 19782764a2aaSMatthew G. Knepley 1979194d53e6SMatthew G. Knepley /*@C 1980194d53e6SMatthew G. Knepley PetscDSGetBdJacobian - Get the pointwise boundary Jacobian function for given test and basis field 1981194d53e6SMatthew G. Knepley 1982194d53e6SMatthew G. Knepley Not collective 1983194d53e6SMatthew G. Knepley 1984194d53e6SMatthew G. Knepley Input Parameters: 1985194d53e6SMatthew G. Knepley + prob - The PetscDS 1986194d53e6SMatthew G. Knepley . f - The test field number 1987194d53e6SMatthew G. Knepley - g - The field number 1988194d53e6SMatthew G. Knepley 1989194d53e6SMatthew G. Knepley Output Parameters: 1990194d53e6SMatthew G. Knepley + g0 - integrand for the test and basis function term 1991194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term 1992194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term 1993194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term 1994194d53e6SMatthew G. Knepley 1995194d53e6SMatthew G. Knepley Note: We are using a first order FEM model for the weak form: 1996194d53e6SMatthew G. Knepley 1997194d53e6SMatthew 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 1998194d53e6SMatthew G. Knepley 1999194d53e6SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by: 2000194d53e6SMatthew G. Knepley 200130b9ff8bSMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux, 2002194d53e6SMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 2003194d53e6SMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 200430b9ff8bSMatthew G. Knepley $ PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar g0[]) 2005194d53e6SMatthew G. Knepley 2006194d53e6SMatthew G. Knepley + dim - the spatial dimension 2007194d53e6SMatthew G. Knepley . Nf - the number of fields 2008194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 2009194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 2010194d53e6SMatthew G. Knepley . u - each field evaluated at the current point 2011194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 2012194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 2013194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 2014194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 2015194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 2016194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 2017194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 2018194d53e6SMatthew G. Knepley . t - current time 20192aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t 2020194d53e6SMatthew G. Knepley . x - coordinates of the current point 2021194d53e6SMatthew G. Knepley . n - normal at the current point 202297b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters 202397b6e6e8SMatthew G. Knepley . constants - constant parameters 2024194d53e6SMatthew G. Knepley - g0 - output values at the current point 2025194d53e6SMatthew G. Knepley 2026194d53e6SMatthew G. Knepley Level: intermediate 2027194d53e6SMatthew G. Knepley 2028194d53e6SMatthew G. Knepley .seealso: PetscDSSetBdJacobian() 2029194d53e6SMatthew G. Knepley @*/ 20302764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetBdJacobian(PetscDS prob, PetscInt f, PetscInt g, 203130b9ff8bSMatthew G. Knepley void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 2032194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 2033194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 203497b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]), 203530b9ff8bSMatthew G. Knepley void (**g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 2036194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 2037194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 203897b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]), 203930b9ff8bSMatthew G. Knepley void (**g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 2040194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 2041194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 204297b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]), 204330b9ff8bSMatthew G. Knepley void (**g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 2044194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 2045194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 204697b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[])) 20472764a2aaSMatthew G. Knepley { 20482764a2aaSMatthew G. Knepley PetscFunctionBegin; 20492764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 20502764a2aaSMatthew 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); 20512764a2aaSMatthew 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); 20522764a2aaSMatthew G. Knepley if (g0) {PetscValidPointer(g0, 4); *g0 = prob->gBd[(f*prob->Nf + g)*4+0];} 20532764a2aaSMatthew G. Knepley if (g1) {PetscValidPointer(g1, 5); *g1 = prob->gBd[(f*prob->Nf + g)*4+1];} 20542764a2aaSMatthew G. Knepley if (g2) {PetscValidPointer(g2, 6); *g2 = prob->gBd[(f*prob->Nf + g)*4+2];} 20552764a2aaSMatthew G. Knepley if (g3) {PetscValidPointer(g3, 7); *g3 = prob->gBd[(f*prob->Nf + g)*4+3];} 20562764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 20572764a2aaSMatthew G. Knepley } 20582764a2aaSMatthew G. Knepley 2059194d53e6SMatthew G. Knepley /*@C 2060194d53e6SMatthew G. Knepley PetscDSSetBdJacobian - Set the pointwise boundary Jacobian function for given test and basis field 2061194d53e6SMatthew G. Knepley 2062194d53e6SMatthew G. Knepley Not collective 2063194d53e6SMatthew G. Knepley 2064194d53e6SMatthew G. Knepley Input Parameters: 2065194d53e6SMatthew G. Knepley + prob - The PetscDS 2066194d53e6SMatthew G. Knepley . f - The test field number 2067194d53e6SMatthew G. Knepley . g - The field number 2068194d53e6SMatthew G. Knepley . g0 - integrand for the test and basis function term 2069194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term 2070194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term 2071194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term 2072194d53e6SMatthew G. Knepley 2073194d53e6SMatthew G. Knepley Note: We are using a first order FEM model for the weak form: 2074194d53e6SMatthew G. Knepley 2075194d53e6SMatthew 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 2076194d53e6SMatthew G. Knepley 2077194d53e6SMatthew G. Knepley The calling sequence for the callbacks g0, g1, g2 and g3 is given by: 2078194d53e6SMatthew G. Knepley 207930b9ff8bSMatthew G. Knepley $ g0(PetscInt dim, PetscInt Nf, PetscInt NfAux, 2080194d53e6SMatthew G. Knepley $ const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 2081194d53e6SMatthew G. Knepley $ const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 208230b9ff8bSMatthew G. Knepley $ PetscReal t, const PetscReal x[], const PetscReal n[], PetscScalar g0[]) 2083194d53e6SMatthew G. Knepley 2084194d53e6SMatthew G. Knepley + dim - the spatial dimension 2085194d53e6SMatthew G. Knepley . Nf - the number of fields 2086194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 2087194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 2088194d53e6SMatthew G. Knepley . u - each field evaluated at the current point 2089194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 2090194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 2091194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 2092194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 2093194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 2094194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 2095194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 2096194d53e6SMatthew G. Knepley . t - current time 20972aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t 2098194d53e6SMatthew G. Knepley . x - coordinates of the current point 2099194d53e6SMatthew G. Knepley . n - normal at the current point 210097b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters 210197b6e6e8SMatthew G. Knepley . constants - constant parameters 2102194d53e6SMatthew G. Knepley - g0 - output values at the current point 2103194d53e6SMatthew G. Knepley 2104194d53e6SMatthew G. Knepley Level: intermediate 2105194d53e6SMatthew G. Knepley 2106194d53e6SMatthew G. Knepley .seealso: PetscDSGetBdJacobian() 2107194d53e6SMatthew G. Knepley @*/ 21082764a2aaSMatthew G. Knepley PetscErrorCode PetscDSSetBdJacobian(PetscDS prob, PetscInt f, PetscInt g, 210930b9ff8bSMatthew G. Knepley void (*g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 2110194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 2111194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 211297b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]), 211330b9ff8bSMatthew G. Knepley void (*g1)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 2114194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 2115194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 211697b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g1[]), 211730b9ff8bSMatthew G. Knepley void (*g2)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 2118194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 2119194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 212097b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g2[]), 212130b9ff8bSMatthew G. Knepley void (*g3)(PetscInt dim, PetscInt Nf, PetscInt NfAux, 2122194d53e6SMatthew G. Knepley const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 2123194d53e6SMatthew G. Knepley const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 212497b6e6e8SMatthew G. Knepley PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g3[])) 21252764a2aaSMatthew G. Knepley { 21262764a2aaSMatthew G. Knepley PetscErrorCode ierr; 21272764a2aaSMatthew G. Knepley 21282764a2aaSMatthew G. Knepley PetscFunctionBegin; 21292764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 21302764a2aaSMatthew G. Knepley if (g0) PetscValidFunction(g0, 4); 21312764a2aaSMatthew G. Knepley if (g1) PetscValidFunction(g1, 5); 21322764a2aaSMatthew G. Knepley if (g2) PetscValidFunction(g2, 6); 21332764a2aaSMatthew G. Knepley if (g3) PetscValidFunction(g3, 7); 21342764a2aaSMatthew G. Knepley if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f); 21352764a2aaSMatthew G. Knepley if (g < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", g); 21362764a2aaSMatthew G. Knepley ierr = PetscDSEnlarge_Static(prob, PetscMax(f, g)+1);CHKERRQ(ierr); 21372764a2aaSMatthew G. Knepley prob->gBd[(f*prob->Nf + g)*4+0] = g0; 21382764a2aaSMatthew G. Knepley prob->gBd[(f*prob->Nf + g)*4+1] = g1; 21392764a2aaSMatthew G. Knepley prob->gBd[(f*prob->Nf + g)*4+2] = g2; 21402764a2aaSMatthew G. Knepley prob->gBd[(f*prob->Nf + g)*4+3] = g3; 21412764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 21422764a2aaSMatthew G. Knepley } 21432764a2aaSMatthew G. Knepley 21440d3e9b51SMatthew G. Knepley /*@C 2145c371a6d1SMatthew G. Knepley PetscDSGetExactSolution - Get the pointwise exact solution function for a given test field 2146c371a6d1SMatthew G. Knepley 2147c371a6d1SMatthew G. Knepley Not collective 2148c371a6d1SMatthew G. Knepley 2149c371a6d1SMatthew G. Knepley Input Parameters: 2150c371a6d1SMatthew G. Knepley + prob - The PetscDS 2151c371a6d1SMatthew G. Knepley - f - The test field number 2152c371a6d1SMatthew G. Knepley 2153c371a6d1SMatthew G. Knepley Output Parameter: 2154c371a6d1SMatthew G. Knepley . exactSol - exact solution for the test field 2155c371a6d1SMatthew G. Knepley 2156c371a6d1SMatthew G. Knepley Note: The calling sequence for the solution functions is given by: 2157c371a6d1SMatthew G. Knepley 2158c371a6d1SMatthew G. Knepley $ sol(PetscInt dim, PetscReal t, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx) 2159c371a6d1SMatthew G. Knepley 2160c371a6d1SMatthew G. Knepley + dim - the spatial dimension 2161c371a6d1SMatthew G. Knepley . t - current time 2162c371a6d1SMatthew G. Knepley . x - coordinates of the current point 2163c371a6d1SMatthew G. Knepley . Nc - the number of field components 2164c371a6d1SMatthew G. Knepley . u - the solution field evaluated at the current point 2165c371a6d1SMatthew G. Knepley - ctx - a user context 2166c371a6d1SMatthew G. Knepley 2167c371a6d1SMatthew G. Knepley Level: intermediate 2168c371a6d1SMatthew G. Knepley 2169c371a6d1SMatthew G. Knepley .seealso: PetscDSSetExactSolution() 2170c371a6d1SMatthew G. Knepley @*/ 2171c371a6d1SMatthew G. Knepley PetscErrorCode PetscDSGetExactSolution(PetscDS prob, PetscInt f, PetscErrorCode (**sol)(PetscInt dim, PetscReal t, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx)) 2172c371a6d1SMatthew G. Knepley { 2173c371a6d1SMatthew G. Knepley PetscFunctionBegin; 2174c371a6d1SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 2175c371a6d1SMatthew 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); 2176c371a6d1SMatthew G. Knepley if (sol) {PetscValidPointer(sol, 3); *sol = prob->exactSol[f];} 2177c371a6d1SMatthew G. Knepley PetscFunctionReturn(0); 2178c371a6d1SMatthew G. Knepley } 2179c371a6d1SMatthew G. Knepley 2180c371a6d1SMatthew G. Knepley /*@C 2181c371a6d1SMatthew G. Knepley PetscDSSetExactSolution - Get the pointwise exact solution function for a given test field 2182c371a6d1SMatthew G. Knepley 2183c371a6d1SMatthew G. Knepley Not collective 2184c371a6d1SMatthew G. Knepley 2185c371a6d1SMatthew G. Knepley Input Parameters: 2186c371a6d1SMatthew G. Knepley + prob - The PetscDS 2187c371a6d1SMatthew G. Knepley . f - The test field number 2188c371a6d1SMatthew G. Knepley - sol - solution function for the test fields 2189c371a6d1SMatthew G. Knepley 2190c371a6d1SMatthew G. Knepley Note: The calling sequence for solution functions is given by: 2191c371a6d1SMatthew G. Knepley 2192c371a6d1SMatthew G. Knepley $ sol(PetscInt dim, PetscReal t, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx) 2193c371a6d1SMatthew G. Knepley 2194c371a6d1SMatthew G. Knepley + dim - the spatial dimension 2195c371a6d1SMatthew G. Knepley . t - current time 2196c371a6d1SMatthew G. Knepley . x - coordinates of the current point 2197c371a6d1SMatthew G. Knepley . Nc - the number of field components 2198c371a6d1SMatthew G. Knepley . u - the solution field evaluated at the current point 2199c371a6d1SMatthew G. Knepley - ctx - a user context 2200c371a6d1SMatthew G. Knepley 2201c371a6d1SMatthew G. Knepley Level: intermediate 2202c371a6d1SMatthew G. Knepley 2203c371a6d1SMatthew G. Knepley .seealso: PetscDSGetExactSolution() 2204c371a6d1SMatthew G. Knepley @*/ 2205c371a6d1SMatthew G. Knepley PetscErrorCode PetscDSSetExactSolution(PetscDS prob, PetscInt f, PetscErrorCode (*sol)(PetscInt dim, PetscReal t, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx)) 2206c371a6d1SMatthew G. Knepley { 2207c371a6d1SMatthew G. Knepley PetscErrorCode ierr; 2208c371a6d1SMatthew G. Knepley 2209c371a6d1SMatthew G. Knepley PetscFunctionBegin; 2210c371a6d1SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 2211c371a6d1SMatthew G. Knepley if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f); 2212c371a6d1SMatthew G. Knepley ierr = PetscDSEnlarge_Static(prob, f+1);CHKERRQ(ierr); 2213c371a6d1SMatthew G. Knepley if (sol) {PetscValidFunction(sol, 3); prob->exactSol[f] = sol;} 2214c371a6d1SMatthew G. Knepley PetscFunctionReturn(0); 2215c371a6d1SMatthew G. Knepley } 2216c371a6d1SMatthew G. Knepley 22175638fd0eSMatthew G. Knepley /*@C 221897b6e6e8SMatthew G. Knepley PetscDSGetConstants - Returns the array of constants passed to point functions 221997b6e6e8SMatthew G. Knepley 222097b6e6e8SMatthew G. Knepley Not collective 222197b6e6e8SMatthew G. Knepley 222297b6e6e8SMatthew G. Knepley Input Parameter: 222397b6e6e8SMatthew G. Knepley . prob - The PetscDS object 222497b6e6e8SMatthew G. Knepley 222597b6e6e8SMatthew G. Knepley Output Parameters: 222697b6e6e8SMatthew G. Knepley + numConstants - The number of constants 222797b6e6e8SMatthew G. Knepley - constants - The array of constants, NULL if there are none 222897b6e6e8SMatthew G. Knepley 222997b6e6e8SMatthew G. Knepley Level: intermediate 223097b6e6e8SMatthew G. Knepley 223197b6e6e8SMatthew G. Knepley .seealso: PetscDSSetConstants(), PetscDSCreate() 223297b6e6e8SMatthew G. Knepley @*/ 223397b6e6e8SMatthew G. Knepley PetscErrorCode PetscDSGetConstants(PetscDS prob, PetscInt *numConstants, const PetscScalar *constants[]) 223497b6e6e8SMatthew G. Knepley { 223597b6e6e8SMatthew G. Knepley PetscFunctionBegin; 223697b6e6e8SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 223797b6e6e8SMatthew G. Knepley if (numConstants) {PetscValidPointer(numConstants, 2); *numConstants = prob->numConstants;} 223897b6e6e8SMatthew G. Knepley if (constants) {PetscValidPointer(constants, 3); *constants = prob->constants;} 223997b6e6e8SMatthew G. Knepley PetscFunctionReturn(0); 224097b6e6e8SMatthew G. Knepley } 224197b6e6e8SMatthew G. Knepley 22420d3e9b51SMatthew G. Knepley /*@C 224397b6e6e8SMatthew G. Knepley PetscDSSetConstants - Set the array of constants passed to point functions 224497b6e6e8SMatthew G. Knepley 224597b6e6e8SMatthew G. Knepley Not collective 224697b6e6e8SMatthew G. Knepley 224797b6e6e8SMatthew G. Knepley Input Parameters: 224897b6e6e8SMatthew G. Knepley + prob - The PetscDS object 224997b6e6e8SMatthew G. Knepley . numConstants - The number of constants 225097b6e6e8SMatthew G. Knepley - constants - The array of constants, NULL if there are none 225197b6e6e8SMatthew G. Knepley 225297b6e6e8SMatthew G. Knepley Level: intermediate 225397b6e6e8SMatthew G. Knepley 225497b6e6e8SMatthew G. Knepley .seealso: PetscDSGetConstants(), PetscDSCreate() 225597b6e6e8SMatthew G. Knepley @*/ 225697b6e6e8SMatthew G. Knepley PetscErrorCode PetscDSSetConstants(PetscDS prob, PetscInt numConstants, PetscScalar constants[]) 225797b6e6e8SMatthew G. Knepley { 225897b6e6e8SMatthew G. Knepley PetscErrorCode ierr; 225997b6e6e8SMatthew G. Knepley 226097b6e6e8SMatthew G. Knepley PetscFunctionBegin; 226197b6e6e8SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 226297b6e6e8SMatthew G. Knepley if (numConstants != prob->numConstants) { 226397b6e6e8SMatthew G. Knepley ierr = PetscFree(prob->constants);CHKERRQ(ierr); 226497b6e6e8SMatthew G. Knepley prob->numConstants = numConstants; 226597b6e6e8SMatthew G. Knepley if (prob->numConstants) { 226697b6e6e8SMatthew G. Knepley ierr = PetscMalloc1(prob->numConstants, &prob->constants);CHKERRQ(ierr); 226720be0f5bSMatthew G. Knepley } else { 226820be0f5bSMatthew G. Knepley prob->constants = NULL; 226920be0f5bSMatthew G. Knepley } 227020be0f5bSMatthew G. Knepley } 227120be0f5bSMatthew G. Knepley if (prob->numConstants) { 227220be0f5bSMatthew G. Knepley PetscValidPointer(constants, 3); 227397b6e6e8SMatthew G. Knepley ierr = PetscMemcpy(prob->constants, constants, prob->numConstants * sizeof(PetscScalar));CHKERRQ(ierr); 227497b6e6e8SMatthew G. Knepley } 227597b6e6e8SMatthew G. Knepley PetscFunctionReturn(0); 227697b6e6e8SMatthew G. Knepley } 227797b6e6e8SMatthew G. Knepley 22784cd1e086SMatthew G. Knepley /*@ 22794cd1e086SMatthew G. Knepley PetscDSGetFieldIndex - Returns the index of the given field 22804cd1e086SMatthew G. Knepley 22814cd1e086SMatthew G. Knepley Not collective 22824cd1e086SMatthew G. Knepley 22834cd1e086SMatthew G. Knepley Input Parameters: 22844cd1e086SMatthew G. Knepley + prob - The PetscDS object 22854cd1e086SMatthew G. Knepley - disc - The discretization object 22864cd1e086SMatthew G. Knepley 22874cd1e086SMatthew G. Knepley Output Parameter: 22884cd1e086SMatthew G. Knepley . f - The field number 22894cd1e086SMatthew G. Knepley 22904cd1e086SMatthew G. Knepley Level: beginner 22914cd1e086SMatthew G. Knepley 2292f744cafaSSander Arens .seealso: PetscGetDiscretization(), PetscDSGetNumFields(), PetscDSCreate() 22934cd1e086SMatthew G. Knepley @*/ 22944cd1e086SMatthew G. Knepley PetscErrorCode PetscDSGetFieldIndex(PetscDS prob, PetscObject disc, PetscInt *f) 22954cd1e086SMatthew G. Knepley { 22964cd1e086SMatthew G. Knepley PetscInt g; 22974cd1e086SMatthew G. Knepley 22984cd1e086SMatthew G. Knepley PetscFunctionBegin; 22994cd1e086SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 23004cd1e086SMatthew G. Knepley PetscValidPointer(f, 3); 23014cd1e086SMatthew G. Knepley *f = -1; 23024cd1e086SMatthew G. Knepley for (g = 0; g < prob->Nf; ++g) {if (disc == prob->disc[g]) break;} 23034cd1e086SMatthew G. Knepley if (g == prob->Nf) SETERRQ(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Field not found in PetscDS."); 23044cd1e086SMatthew G. Knepley *f = g; 23054cd1e086SMatthew G. Knepley PetscFunctionReturn(0); 23064cd1e086SMatthew G. Knepley } 23074cd1e086SMatthew G. Knepley 23084cd1e086SMatthew G. Knepley /*@ 23094cd1e086SMatthew G. Knepley PetscDSGetFieldSize - Returns the size of the given field in the full space basis 23104cd1e086SMatthew G. Knepley 23114cd1e086SMatthew G. Knepley Not collective 23124cd1e086SMatthew G. Knepley 23134cd1e086SMatthew G. Knepley Input Parameters: 23144cd1e086SMatthew G. Knepley + prob - The PetscDS object 23154cd1e086SMatthew G. Knepley - f - The field number 23164cd1e086SMatthew G. Knepley 23174cd1e086SMatthew G. Knepley Output Parameter: 23184cd1e086SMatthew G. Knepley . size - The size 23194cd1e086SMatthew G. Knepley 23204cd1e086SMatthew G. Knepley Level: beginner 23214cd1e086SMatthew G. Knepley 2322f744cafaSSander Arens .seealso: PetscDSGetFieldOffset(), PetscDSGetNumFields(), PetscDSCreate() 23234cd1e086SMatthew G. Knepley @*/ 23244cd1e086SMatthew G. Knepley PetscErrorCode PetscDSGetFieldSize(PetscDS prob, PetscInt f, PetscInt *size) 23254cd1e086SMatthew G. Knepley { 23262166fd64SMatthew G. Knepley PetscErrorCode ierr; 23272166fd64SMatthew G. Knepley 23284cd1e086SMatthew G. Knepley PetscFunctionBegin; 23294cd1e086SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 23304cd1e086SMatthew G. Knepley PetscValidPointer(size, 3); 23314cd1e086SMatthew 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); 23322166fd64SMatthew G. Knepley ierr = PetscDSSetUp(prob);CHKERRQ(ierr); 2333d4742ddaSMatthew G. Knepley *size = prob->Nb[f]; 23344cd1e086SMatthew G. Knepley PetscFunctionReturn(0); 23354cd1e086SMatthew G. Knepley } 23364cd1e086SMatthew G. Knepley 2337bc4ae4beSMatthew G. Knepley /*@ 2338bc4ae4beSMatthew G. Knepley PetscDSGetFieldOffset - Returns the offset of the given field in the full space basis 2339bc4ae4beSMatthew G. Knepley 2340bc4ae4beSMatthew G. Knepley Not collective 2341bc4ae4beSMatthew G. Knepley 2342bc4ae4beSMatthew G. Knepley Input Parameters: 2343bc4ae4beSMatthew G. Knepley + prob - The PetscDS object 2344bc4ae4beSMatthew G. Knepley - f - The field number 2345bc4ae4beSMatthew G. Knepley 2346bc4ae4beSMatthew G. Knepley Output Parameter: 2347bc4ae4beSMatthew G. Knepley . off - The offset 2348bc4ae4beSMatthew G. Knepley 2349bc4ae4beSMatthew G. Knepley Level: beginner 2350bc4ae4beSMatthew G. Knepley 2351f744cafaSSander Arens .seealso: PetscDSGetFieldSize(), PetscDSGetNumFields(), PetscDSCreate() 2352bc4ae4beSMatthew G. Knepley @*/ 23532764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetFieldOffset(PetscDS prob, PetscInt f, PetscInt *off) 23542764a2aaSMatthew G. Knepley { 23554cd1e086SMatthew G. Knepley PetscInt size, g; 23562764a2aaSMatthew G. Knepley PetscErrorCode ierr; 23572764a2aaSMatthew G. Knepley 23582764a2aaSMatthew G. Knepley PetscFunctionBegin; 23592764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 23602764a2aaSMatthew G. Knepley PetscValidPointer(off, 3); 23612764a2aaSMatthew 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); 23622764a2aaSMatthew G. Knepley *off = 0; 23632764a2aaSMatthew G. Knepley for (g = 0; g < f; ++g) { 23644cd1e086SMatthew G. Knepley ierr = PetscDSGetFieldSize(prob, g, &size);CHKERRQ(ierr); 23654cd1e086SMatthew G. Knepley *off += size; 23662764a2aaSMatthew G. Knepley } 23672764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 23682764a2aaSMatthew G. Knepley } 23692764a2aaSMatthew G. Knepley 2370bc4ae4beSMatthew G. Knepley /*@ 237147e57110SSander Arens PetscDSGetDimensions - Returns the size of the approximation space for each field on an evaluation point 2372bc4ae4beSMatthew G. Knepley 2373bc4ae4beSMatthew G. Knepley Not collective 2374bc4ae4beSMatthew G. Knepley 237547e57110SSander Arens Input Parameter: 237647e57110SSander Arens . prob - The PetscDS object 2377bc4ae4beSMatthew G. Knepley 2378bc4ae4beSMatthew G. Knepley Output Parameter: 237947e57110SSander Arens . dimensions - The number of dimensions 2380bc4ae4beSMatthew G. Knepley 2381bc4ae4beSMatthew G. Knepley Level: beginner 2382bc4ae4beSMatthew G. Knepley 238347e57110SSander Arens .seealso: PetscDSGetComponentOffsets(), PetscDSGetNumFields(), PetscDSCreate() 2384bc4ae4beSMatthew G. Knepley @*/ 238547e57110SSander Arens PetscErrorCode PetscDSGetDimensions(PetscDS prob, PetscInt *dimensions[]) 23862764a2aaSMatthew G. Knepley { 23872764a2aaSMatthew G. Knepley PetscErrorCode ierr; 23882764a2aaSMatthew G. Knepley 23892764a2aaSMatthew G. Knepley PetscFunctionBegin; 23902764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 239147e57110SSander Arens ierr = PetscDSSetUp(prob);CHKERRQ(ierr); 239247e57110SSander Arens PetscValidPointer(dimensions, 2); 239347e57110SSander Arens *dimensions = prob->Nb; 239447e57110SSander Arens PetscFunctionReturn(0); 23956ce16762SMatthew G. Knepley } 239647e57110SSander Arens 239747e57110SSander Arens /*@ 239847e57110SSander Arens PetscDSGetComponents - Returns the number of components for each field on an evaluation point 239947e57110SSander Arens 240047e57110SSander Arens Not collective 240147e57110SSander Arens 240247e57110SSander Arens Input Parameter: 240347e57110SSander Arens . prob - The PetscDS object 240447e57110SSander Arens 240547e57110SSander Arens Output Parameter: 240647e57110SSander Arens . components - The number of components 240747e57110SSander Arens 240847e57110SSander Arens Level: beginner 240947e57110SSander Arens 241047e57110SSander Arens .seealso: PetscDSGetComponentOffsets(), PetscDSGetNumFields(), PetscDSCreate() 241147e57110SSander Arens @*/ 241247e57110SSander Arens PetscErrorCode PetscDSGetComponents(PetscDS prob, PetscInt *components[]) 241347e57110SSander Arens { 241447e57110SSander Arens PetscErrorCode ierr; 241547e57110SSander Arens 241647e57110SSander Arens PetscFunctionBegin; 241747e57110SSander Arens PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 241847e57110SSander Arens ierr = PetscDSSetUp(prob);CHKERRQ(ierr); 241947e57110SSander Arens PetscValidPointer(components, 2); 242047e57110SSander Arens *components = prob->Nc; 24216ce16762SMatthew G. Knepley PetscFunctionReturn(0); 24226ce16762SMatthew G. Knepley } 24236ce16762SMatthew G. Knepley 24246ce16762SMatthew G. Knepley /*@ 24256ce16762SMatthew G. Knepley PetscDSGetComponentOffset - Returns the offset of the given field on an evaluation point 24266ce16762SMatthew G. Knepley 24276ce16762SMatthew G. Knepley Not collective 24286ce16762SMatthew G. Knepley 24296ce16762SMatthew G. Knepley Input Parameters: 24306ce16762SMatthew G. Knepley + prob - The PetscDS object 24316ce16762SMatthew G. Knepley - f - The field number 24326ce16762SMatthew G. Knepley 24336ce16762SMatthew G. Knepley Output Parameter: 24346ce16762SMatthew G. Knepley . off - The offset 24356ce16762SMatthew G. Knepley 24366ce16762SMatthew G. Knepley Level: beginner 24376ce16762SMatthew G. Knepley 2438f744cafaSSander Arens .seealso: PetscDSGetNumFields(), PetscDSCreate() 24396ce16762SMatthew G. Knepley @*/ 24406ce16762SMatthew G. Knepley PetscErrorCode PetscDSGetComponentOffset(PetscDS prob, PetscInt f, PetscInt *off) 24416ce16762SMatthew G. Knepley { 24426ce16762SMatthew G. Knepley PetscFunctionBegin; 24436ce16762SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 24446ce16762SMatthew G. Knepley PetscValidPointer(off, 3); 24456ce16762SMatthew 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); 244647e57110SSander Arens *off = prob->off[f]; 24472764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 24482764a2aaSMatthew G. Knepley } 24492764a2aaSMatthew G. Knepley 2450194d53e6SMatthew G. Knepley /*@ 2451194d53e6SMatthew G. Knepley PetscDSGetComponentOffsets - Returns the offset of each field on an evaluation point 2452194d53e6SMatthew G. Knepley 2453194d53e6SMatthew G. Knepley Not collective 2454194d53e6SMatthew G. Knepley 2455194d53e6SMatthew G. Knepley Input Parameter: 2456194d53e6SMatthew G. Knepley . prob - The PetscDS object 2457194d53e6SMatthew G. Knepley 2458194d53e6SMatthew G. Knepley Output Parameter: 2459194d53e6SMatthew G. Knepley . offsets - The offsets 2460194d53e6SMatthew G. Knepley 2461194d53e6SMatthew G. Knepley Level: beginner 2462194d53e6SMatthew G. Knepley 2463f744cafaSSander Arens .seealso: PetscDSGetNumFields(), PetscDSCreate() 2464194d53e6SMatthew G. Knepley @*/ 2465194d53e6SMatthew G. Knepley PetscErrorCode PetscDSGetComponentOffsets(PetscDS prob, PetscInt *offsets[]) 2466194d53e6SMatthew G. Knepley { 2467194d53e6SMatthew G. Knepley PetscFunctionBegin; 2468194d53e6SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 2469194d53e6SMatthew G. Knepley PetscValidPointer(offsets, 2); 2470194d53e6SMatthew G. Knepley *offsets = prob->off; 2471194d53e6SMatthew G. Knepley PetscFunctionReturn(0); 2472194d53e6SMatthew G. Knepley } 2473194d53e6SMatthew G. Knepley 2474194d53e6SMatthew G. Knepley /*@ 2475194d53e6SMatthew G. Knepley PetscDSGetComponentDerivativeOffsets - Returns the offset of each field derivative on an evaluation point 2476194d53e6SMatthew G. Knepley 2477194d53e6SMatthew G. Knepley Not collective 2478194d53e6SMatthew G. Knepley 2479194d53e6SMatthew G. Knepley Input Parameter: 2480194d53e6SMatthew G. Knepley . prob - The PetscDS object 2481194d53e6SMatthew G. Knepley 2482194d53e6SMatthew G. Knepley Output Parameter: 2483194d53e6SMatthew G. Knepley . offsets - The offsets 2484194d53e6SMatthew G. Knepley 2485194d53e6SMatthew G. Knepley Level: beginner 2486194d53e6SMatthew G. Knepley 2487f744cafaSSander Arens .seealso: PetscDSGetNumFields(), PetscDSCreate() 2488194d53e6SMatthew G. Knepley @*/ 2489194d53e6SMatthew G. Knepley PetscErrorCode PetscDSGetComponentDerivativeOffsets(PetscDS prob, PetscInt *offsets[]) 2490194d53e6SMatthew G. Knepley { 2491194d53e6SMatthew G. Knepley PetscFunctionBegin; 2492194d53e6SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 2493194d53e6SMatthew G. Knepley PetscValidPointer(offsets, 2); 2494194d53e6SMatthew G. Knepley *offsets = prob->offDer; 2495194d53e6SMatthew G. Knepley PetscFunctionReturn(0); 2496194d53e6SMatthew G. Knepley } 2497194d53e6SMatthew G. Knepley 249868c9edb9SMatthew G. Knepley /*@C 249968c9edb9SMatthew G. Knepley PetscDSGetTabulation - Return the basis tabulation at quadrature points for the volume discretization 250068c9edb9SMatthew G. Knepley 250168c9edb9SMatthew G. Knepley Not collective 250268c9edb9SMatthew G. Knepley 250368c9edb9SMatthew G. Knepley Input Parameter: 250468c9edb9SMatthew G. Knepley . prob - The PetscDS object 250568c9edb9SMatthew G. Knepley 250668c9edb9SMatthew G. Knepley Output Parameters: 250768c9edb9SMatthew G. Knepley + basis - The basis function tabulation at quadrature points 250868c9edb9SMatthew G. Knepley - basisDer - The basis function derivative tabulation at quadrature points 250968c9edb9SMatthew G. Knepley 251068c9edb9SMatthew G. Knepley Level: intermediate 251168c9edb9SMatthew G. Knepley 2512f744cafaSSander Arens .seealso: PetscDSCreate() 251368c9edb9SMatthew G. Knepley @*/ 25142764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetTabulation(PetscDS prob, PetscReal ***basis, PetscReal ***basisDer) 25152764a2aaSMatthew G. Knepley { 25162764a2aaSMatthew G. Knepley PetscErrorCode ierr; 25172764a2aaSMatthew G. Knepley 25182764a2aaSMatthew G. Knepley PetscFunctionBegin; 25192764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 25202764a2aaSMatthew G. Knepley ierr = PetscDSSetUp(prob);CHKERRQ(ierr); 25212764a2aaSMatthew G. Knepley if (basis) {PetscValidPointer(basis, 2); *basis = prob->basis;} 25222764a2aaSMatthew G. Knepley if (basisDer) {PetscValidPointer(basisDer, 3); *basisDer = prob->basisDer;} 25232764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 25242764a2aaSMatthew G. Knepley } 25252764a2aaSMatthew G. Knepley 252668c9edb9SMatthew G. Knepley /*@C 25274d0b9603SSander Arens PetscDSGetFaceTabulation - Return the basis tabulation at quadrature points on the faces 252868c9edb9SMatthew G. Knepley 252968c9edb9SMatthew G. Knepley Not collective 253068c9edb9SMatthew G. Knepley 253168c9edb9SMatthew G. Knepley Input Parameter: 253268c9edb9SMatthew G. Knepley . prob - The PetscDS object 253368c9edb9SMatthew G. Knepley 253468c9edb9SMatthew G. Knepley Output Parameters: 25354d0b9603SSander Arens + basisFace - The basis function tabulation at quadrature points 25364d0b9603SSander Arens - basisDerFace - The basis function derivative tabulation at quadrature points 253768c9edb9SMatthew G. Knepley 253868c9edb9SMatthew G. Knepley Level: intermediate 253968c9edb9SMatthew G. Knepley 254068c9edb9SMatthew G. Knepley .seealso: PetscDSGetTabulation(), PetscDSCreate() 254168c9edb9SMatthew G. Knepley @*/ 25424d0b9603SSander Arens PetscErrorCode PetscDSGetFaceTabulation(PetscDS prob, PetscReal ***basis, PetscReal ***basisDer) 25432764a2aaSMatthew G. Knepley { 25442764a2aaSMatthew G. Knepley PetscErrorCode ierr; 25452764a2aaSMatthew G. Knepley 25462764a2aaSMatthew G. Knepley PetscFunctionBegin; 25472764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 25482764a2aaSMatthew G. Knepley ierr = PetscDSSetUp(prob);CHKERRQ(ierr); 25494d0b9603SSander Arens if (basis) {PetscValidPointer(basis, 2); *basis = prob->basisFace;} 25504d0b9603SSander Arens if (basisDer) {PetscValidPointer(basisDer, 3); *basisDer = prob->basisDerFace;} 25512764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 25522764a2aaSMatthew G. Knepley } 25532764a2aaSMatthew G. Knepley 25542764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetEvaluationArrays(PetscDS prob, PetscScalar **u, PetscScalar **u_t, PetscScalar **u_x) 25552764a2aaSMatthew G. Knepley { 25562764a2aaSMatthew G. Knepley PetscErrorCode ierr; 25572764a2aaSMatthew G. Knepley 25582764a2aaSMatthew G. Knepley PetscFunctionBegin; 25592764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 25602764a2aaSMatthew G. Knepley ierr = PetscDSSetUp(prob);CHKERRQ(ierr); 25612764a2aaSMatthew G. Knepley if (u) {PetscValidPointer(u, 2); *u = prob->u;} 25622764a2aaSMatthew G. Knepley if (u_t) {PetscValidPointer(u_t, 3); *u_t = prob->u_t;} 25632764a2aaSMatthew G. Knepley if (u_x) {PetscValidPointer(u_x, 4); *u_x = prob->u_x;} 25642764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 25652764a2aaSMatthew G. Knepley } 25662764a2aaSMatthew G. Knepley 25672764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetWeakFormArrays(PetscDS prob, PetscScalar **f0, PetscScalar **f1, PetscScalar **g0, PetscScalar **g1, PetscScalar **g2, PetscScalar **g3) 25682764a2aaSMatthew G. Knepley { 25692764a2aaSMatthew G. Knepley PetscErrorCode ierr; 25702764a2aaSMatthew G. Knepley 25712764a2aaSMatthew G. Knepley PetscFunctionBegin; 25722764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 25732764a2aaSMatthew G. Knepley ierr = PetscDSSetUp(prob);CHKERRQ(ierr); 25742764a2aaSMatthew G. Knepley if (f0) {PetscValidPointer(f0, 2); *f0 = prob->f0;} 25752764a2aaSMatthew G. Knepley if (f1) {PetscValidPointer(f1, 3); *f1 = prob->f1;} 25762764a2aaSMatthew G. Knepley if (g0) {PetscValidPointer(g0, 4); *g0 = prob->g0;} 25772764a2aaSMatthew G. Knepley if (g1) {PetscValidPointer(g1, 5); *g1 = prob->g1;} 25782764a2aaSMatthew G. Knepley if (g2) {PetscValidPointer(g2, 6); *g2 = prob->g2;} 25792764a2aaSMatthew G. Knepley if (g3) {PetscValidPointer(g3, 7); *g3 = prob->g3;} 25802764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 25812764a2aaSMatthew G. Knepley } 25822764a2aaSMatthew G. Knepley 25832764a2aaSMatthew G. Knepley PetscErrorCode PetscDSGetRefCoordArrays(PetscDS prob, PetscReal **x, PetscScalar **refSpaceDer) 25842764a2aaSMatthew G. Knepley { 25852764a2aaSMatthew G. Knepley PetscErrorCode ierr; 25862764a2aaSMatthew G. Knepley 25872764a2aaSMatthew G. Knepley PetscFunctionBegin; 25882764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 25892764a2aaSMatthew G. Knepley ierr = PetscDSSetUp(prob);CHKERRQ(ierr); 25902764a2aaSMatthew G. Knepley if (x) {PetscValidPointer(x, 2); *x = prob->x;} 25912764a2aaSMatthew G. Knepley if (refSpaceDer) {PetscValidPointer(refSpaceDer, 3); *refSpaceDer = prob->refSpaceDer;} 25922764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 25932764a2aaSMatthew G. Knepley } 25942764a2aaSMatthew G. Knepley 259558ebd649SToby Isaac /*@C 259658ebd649SToby Isaac PetscDSAddBoundary - Add a boundary condition to the model 259758ebd649SToby Isaac 259858ebd649SToby Isaac Input Parameters: 259958ebd649SToby Isaac + ds - The PetscDS object 26002d47a189SJulian Andrej . type - The type of condition, e.g. DM_BC_ESSENTIAL/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann) 260158ebd649SToby Isaac . name - The BC name 260258ebd649SToby Isaac . labelname - The label defining constrained points 260358ebd649SToby Isaac . field - The field to constrain 260458ebd649SToby Isaac . numcomps - The number of constrained field components 260558ebd649SToby Isaac . comps - An array of constrained component numbers 260658ebd649SToby Isaac . bcFunc - A pointwise function giving boundary values 260758ebd649SToby Isaac . numids - The number of DMLabel ids for constrained points 260858ebd649SToby Isaac . ids - An array of ids for constrained points 260958ebd649SToby Isaac - ctx - An optional user context for bcFunc 261058ebd649SToby Isaac 261158ebd649SToby Isaac Options Database Keys: 261258ebd649SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids 261358ebd649SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components 261458ebd649SToby Isaac 261558ebd649SToby Isaac Level: developer 261658ebd649SToby Isaac 261758ebd649SToby Isaac .seealso: PetscDSGetBoundary() 261858ebd649SToby Isaac @*/ 2619a30ec4eaSSatish 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) 262058ebd649SToby Isaac { 262158ebd649SToby Isaac DSBoundary b; 262258ebd649SToby Isaac PetscErrorCode ierr; 262358ebd649SToby Isaac 262458ebd649SToby Isaac PetscFunctionBegin; 262558ebd649SToby Isaac PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 262658ebd649SToby Isaac ierr = PetscNew(&b);CHKERRQ(ierr); 262758ebd649SToby Isaac ierr = PetscStrallocpy(name, (char **) &b->name);CHKERRQ(ierr); 262858ebd649SToby Isaac ierr = PetscStrallocpy(labelname, (char **) &b->labelname);CHKERRQ(ierr); 262958ebd649SToby Isaac ierr = PetscMalloc1(numcomps, &b->comps);CHKERRQ(ierr); 263058ebd649SToby Isaac if (numcomps) {ierr = PetscMemcpy(b->comps, comps, numcomps*sizeof(PetscInt));CHKERRQ(ierr);} 263158ebd649SToby Isaac ierr = PetscMalloc1(numids, &b->ids);CHKERRQ(ierr); 263258ebd649SToby Isaac if (numids) {ierr = PetscMemcpy(b->ids, ids, numids*sizeof(PetscInt));CHKERRQ(ierr);} 2633f971fd6bSMatthew G. Knepley b->type = type; 263458ebd649SToby Isaac b->field = field; 263558ebd649SToby Isaac b->numcomps = numcomps; 263658ebd649SToby Isaac b->func = bcFunc; 263758ebd649SToby Isaac b->numids = numids; 263858ebd649SToby Isaac b->ctx = ctx; 263958ebd649SToby Isaac b->next = ds->boundary; 264058ebd649SToby Isaac ds->boundary = b; 264158ebd649SToby Isaac PetscFunctionReturn(0); 264258ebd649SToby Isaac } 264358ebd649SToby Isaac 264458ebd649SToby Isaac /*@ 264558ebd649SToby Isaac PetscDSGetNumBoundary - Get the number of registered BC 264658ebd649SToby Isaac 264758ebd649SToby Isaac Input Parameters: 264858ebd649SToby Isaac . ds - The PetscDS object 264958ebd649SToby Isaac 265058ebd649SToby Isaac Output Parameters: 265158ebd649SToby Isaac . numBd - The number of BC 265258ebd649SToby Isaac 265358ebd649SToby Isaac Level: intermediate 265458ebd649SToby Isaac 265558ebd649SToby Isaac .seealso: PetscDSAddBoundary(), PetscDSGetBoundary() 265658ebd649SToby Isaac @*/ 265758ebd649SToby Isaac PetscErrorCode PetscDSGetNumBoundary(PetscDS ds, PetscInt *numBd) 265858ebd649SToby Isaac { 265958ebd649SToby Isaac DSBoundary b = ds->boundary; 266058ebd649SToby Isaac 266158ebd649SToby Isaac PetscFunctionBegin; 266258ebd649SToby Isaac PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 266358ebd649SToby Isaac PetscValidPointer(numBd, 2); 266458ebd649SToby Isaac *numBd = 0; 266558ebd649SToby Isaac while (b) {++(*numBd); b = b->next;} 266658ebd649SToby Isaac PetscFunctionReturn(0); 266758ebd649SToby Isaac } 266858ebd649SToby Isaac 266958ebd649SToby Isaac /*@C 267058ebd649SToby Isaac PetscDSGetBoundary - Add a boundary condition to the model 267158ebd649SToby Isaac 267258ebd649SToby Isaac Input Parameters: 267358ebd649SToby Isaac + ds - The PetscDS object 267458ebd649SToby Isaac - bd - The BC number 267558ebd649SToby Isaac 267658ebd649SToby Isaac Output Parameters: 26772d47a189SJulian Andrej + type - The type of condition, e.g. DM_BC_ESSENTIAL/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann) 267858ebd649SToby Isaac . name - The BC name 267958ebd649SToby Isaac . labelname - The label defining constrained points 268058ebd649SToby Isaac . field - The field to constrain 268158ebd649SToby Isaac . numcomps - The number of constrained field components 268258ebd649SToby Isaac . comps - An array of constrained component numbers 268358ebd649SToby Isaac . bcFunc - A pointwise function giving boundary values 268458ebd649SToby Isaac . numids - The number of DMLabel ids for constrained points 268558ebd649SToby Isaac . ids - An array of ids for constrained points 268658ebd649SToby Isaac - ctx - An optional user context for bcFunc 268758ebd649SToby Isaac 268858ebd649SToby Isaac Options Database Keys: 268958ebd649SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids 269058ebd649SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components 269158ebd649SToby Isaac 269258ebd649SToby Isaac Level: developer 269358ebd649SToby Isaac 269458ebd649SToby Isaac .seealso: PetscDSAddBoundary() 269558ebd649SToby Isaac @*/ 2696a30ec4eaSSatish 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) 269758ebd649SToby Isaac { 269858ebd649SToby Isaac DSBoundary b = ds->boundary; 269958ebd649SToby Isaac PetscInt n = 0; 270058ebd649SToby Isaac 270158ebd649SToby Isaac PetscFunctionBegin; 270258ebd649SToby Isaac PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 270358ebd649SToby Isaac while (b) { 270458ebd649SToby Isaac if (n == bd) break; 270558ebd649SToby Isaac b = b->next; 270658ebd649SToby Isaac ++n; 270758ebd649SToby Isaac } 270858ebd649SToby Isaac if (!b) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Boundary %d is not in [0, %d)", bd, n); 2709f971fd6bSMatthew G. Knepley if (type) { 2710f971fd6bSMatthew G. Knepley PetscValidPointer(type, 3); 2711f971fd6bSMatthew G. Knepley *type = b->type; 271258ebd649SToby Isaac } 271358ebd649SToby Isaac if (name) { 271458ebd649SToby Isaac PetscValidPointer(name, 4); 271558ebd649SToby Isaac *name = b->name; 271658ebd649SToby Isaac } 271758ebd649SToby Isaac if (labelname) { 271858ebd649SToby Isaac PetscValidPointer(labelname, 5); 271958ebd649SToby Isaac *labelname = b->labelname; 272058ebd649SToby Isaac } 272158ebd649SToby Isaac if (field) { 272258ebd649SToby Isaac PetscValidPointer(field, 6); 272358ebd649SToby Isaac *field = b->field; 272458ebd649SToby Isaac } 272558ebd649SToby Isaac if (numcomps) { 272658ebd649SToby Isaac PetscValidPointer(numcomps, 7); 272758ebd649SToby Isaac *numcomps = b->numcomps; 272858ebd649SToby Isaac } 272958ebd649SToby Isaac if (comps) { 273058ebd649SToby Isaac PetscValidPointer(comps, 8); 273158ebd649SToby Isaac *comps = b->comps; 273258ebd649SToby Isaac } 273358ebd649SToby Isaac if (func) { 273458ebd649SToby Isaac PetscValidPointer(func, 9); 273558ebd649SToby Isaac *func = b->func; 273658ebd649SToby Isaac } 273758ebd649SToby Isaac if (numids) { 273858ebd649SToby Isaac PetscValidPointer(numids, 10); 273958ebd649SToby Isaac *numids = b->numids; 274058ebd649SToby Isaac } 274158ebd649SToby Isaac if (ids) { 274258ebd649SToby Isaac PetscValidPointer(ids, 11); 274358ebd649SToby Isaac *ids = b->ids; 274458ebd649SToby Isaac } 274558ebd649SToby Isaac if (ctx) { 274658ebd649SToby Isaac PetscValidPointer(ctx, 12); 274758ebd649SToby Isaac *ctx = b->ctx; 274858ebd649SToby Isaac } 274958ebd649SToby Isaac PetscFunctionReturn(0); 275058ebd649SToby Isaac } 275158ebd649SToby Isaac 2752dff059c6SToby Isaac PetscErrorCode PetscDSCopyBoundary(PetscDS probA, PetscDS probB) 2753dff059c6SToby Isaac { 2754dff059c6SToby Isaac DSBoundary b, next, *lastnext; 2755dff059c6SToby Isaac PetscErrorCode ierr; 2756dff059c6SToby Isaac 2757dff059c6SToby Isaac PetscFunctionBegin; 2758dff059c6SToby Isaac PetscValidHeaderSpecific(probA, PETSCDS_CLASSID, 1); 2759dff059c6SToby Isaac PetscValidHeaderSpecific(probB, PETSCDS_CLASSID, 2); 2760dff059c6SToby Isaac if (probA == probB) PetscFunctionReturn(0); 2761dff059c6SToby Isaac next = probB->boundary; 2762dff059c6SToby Isaac while (next) { 2763dff059c6SToby Isaac DSBoundary b = next; 2764dff059c6SToby Isaac 2765dff059c6SToby Isaac next = b->next; 2766dff059c6SToby Isaac ierr = PetscFree(b->comps);CHKERRQ(ierr); 2767dff059c6SToby Isaac ierr = PetscFree(b->ids);CHKERRQ(ierr); 2768dff059c6SToby Isaac ierr = PetscFree(b->name);CHKERRQ(ierr); 2769dff059c6SToby Isaac ierr = PetscFree(b->labelname);CHKERRQ(ierr); 2770dff059c6SToby Isaac ierr = PetscFree(b);CHKERRQ(ierr); 2771dff059c6SToby Isaac } 2772dff059c6SToby Isaac lastnext = &(probB->boundary); 2773dff059c6SToby Isaac for (b = probA->boundary; b; b = b->next) { 2774dff059c6SToby Isaac DSBoundary bNew; 2775dff059c6SToby Isaac 2776459726d8SSatish Balay ierr = PetscNew(&bNew);CHKERRQ(ierr); 2777dff059c6SToby Isaac bNew->numcomps = b->numcomps; 2778dff059c6SToby Isaac ierr = PetscMalloc1(bNew->numcomps, &bNew->comps);CHKERRQ(ierr); 2779dff059c6SToby Isaac ierr = PetscMemcpy(bNew->comps, b->comps, bNew->numcomps*sizeof(PetscInt));CHKERRQ(ierr); 2780dff059c6SToby Isaac bNew->numids = b->numids; 2781dff059c6SToby Isaac ierr = PetscMalloc1(bNew->numids, &bNew->ids);CHKERRQ(ierr); 2782dff059c6SToby Isaac ierr = PetscMemcpy(bNew->ids, b->ids, bNew->numids*sizeof(PetscInt));CHKERRQ(ierr); 2783dff059c6SToby Isaac ierr = PetscStrallocpy(b->labelname,(char **) &(bNew->labelname));CHKERRQ(ierr); 2784dff059c6SToby Isaac ierr = PetscStrallocpy(b->name,(char **) &(bNew->name));CHKERRQ(ierr); 2785dff059c6SToby Isaac bNew->ctx = b->ctx; 2786f971fd6bSMatthew G. Knepley bNew->type = b->type; 2787dff059c6SToby Isaac bNew->field = b->field; 2788dff059c6SToby Isaac bNew->func = b->func; 2789dff059c6SToby Isaac 2790dff059c6SToby Isaac *lastnext = bNew; 2791dff059c6SToby Isaac lastnext = &(bNew->next); 2792dff059c6SToby Isaac } 2793dff059c6SToby Isaac PetscFunctionReturn(0); 2794dff059c6SToby Isaac } 2795dff059c6SToby Isaac 2796da51fcedSMatthew G. Knepley /*@ 2797da51fcedSMatthew G. Knepley PetscDSCopyEquations - Copy all pointwise function pointers to the new problem 2798da51fcedSMatthew G. Knepley 2799da51fcedSMatthew G. Knepley Not collective 2800da51fcedSMatthew G. Knepley 2801da51fcedSMatthew G. Knepley Input Parameter: 2802da51fcedSMatthew G. Knepley . prob - The PetscDS object 2803da51fcedSMatthew G. Knepley 2804da51fcedSMatthew G. Knepley Output Parameter: 2805da51fcedSMatthew G. Knepley . newprob - The PetscDS copy 2806da51fcedSMatthew G. Knepley 2807da51fcedSMatthew G. Knepley Level: intermediate 2808da51fcedSMatthew G. Knepley 2809da51fcedSMatthew G. Knepley .seealso: PetscDSSetResidual(), PetscDSSetJacobian(), PetscDSSetRiemannSolver(), PetscDSSetBdResidual(), PetscDSSetBdJacobian(), PetscDSCreate() 2810da51fcedSMatthew G. Knepley @*/ 2811da51fcedSMatthew G. Knepley PetscErrorCode PetscDSCopyEquations(PetscDS prob, PetscDS newprob) 2812da51fcedSMatthew G. Knepley { 2813da51fcedSMatthew G. Knepley PetscInt Nf, Ng, f, g; 2814da51fcedSMatthew G. Knepley PetscErrorCode ierr; 2815da51fcedSMatthew G. Knepley 2816da51fcedSMatthew G. Knepley PetscFunctionBegin; 2817da51fcedSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 2818da51fcedSMatthew G. Knepley PetscValidHeaderSpecific(newprob, PETSCDS_CLASSID, 2); 2819da51fcedSMatthew G. Knepley ierr = PetscDSGetNumFields(prob, &Nf);CHKERRQ(ierr); 2820da51fcedSMatthew G. Knepley ierr = PetscDSGetNumFields(newprob, &Ng);CHKERRQ(ierr); 282113903a91SSatish Balay if (Nf != Ng) SETERRQ2(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_SIZ, "Number of fields must match %D != %D", Nf, Ng); 2822da51fcedSMatthew G. Knepley for (f = 0; f < Nf; ++f) { 2823da51fcedSMatthew G. Knepley PetscPointFunc obj; 2824da51fcedSMatthew G. Knepley PetscPointFunc f0, f1; 2825da51fcedSMatthew G. Knepley PetscPointJac g0, g1, g2, g3; 2826da51fcedSMatthew G. Knepley PetscBdPointFunc f0Bd, f1Bd; 2827da51fcedSMatthew G. Knepley PetscBdPointJac g0Bd, g1Bd, g2Bd, g3Bd; 2828da51fcedSMatthew G. Knepley PetscRiemannFunc r; 2829da51fcedSMatthew G. Knepley 2830da51fcedSMatthew G. Knepley ierr = PetscDSGetObjective(prob, f, &obj);CHKERRQ(ierr); 2831da51fcedSMatthew G. Knepley ierr = PetscDSGetResidual(prob, f, &f0, &f1);CHKERRQ(ierr); 2832da51fcedSMatthew G. Knepley ierr = PetscDSGetBdResidual(prob, f, &f0Bd, &f1Bd);CHKERRQ(ierr); 2833da51fcedSMatthew G. Knepley ierr = PetscDSGetRiemannSolver(prob, f, &r);CHKERRQ(ierr); 2834da51fcedSMatthew G. Knepley ierr = PetscDSSetObjective(newprob, f, obj);CHKERRQ(ierr); 2835da51fcedSMatthew G. Knepley ierr = PetscDSSetResidual(newprob, f, f0, f1);CHKERRQ(ierr); 2836da51fcedSMatthew G. Knepley ierr = PetscDSSetBdResidual(newprob, f, f0Bd, f1Bd);CHKERRQ(ierr); 2837da51fcedSMatthew G. Knepley ierr = PetscDSSetRiemannSolver(newprob, f, r);CHKERRQ(ierr); 2838da51fcedSMatthew G. Knepley for (g = 0; g < Nf; ++g) { 2839da51fcedSMatthew G. Knepley ierr = PetscDSGetJacobian(prob, f, g, &g0, &g1, &g2, &g3);CHKERRQ(ierr); 2840da51fcedSMatthew G. Knepley ierr = PetscDSGetBdJacobian(prob, f, g, &g0Bd, &g1Bd, &g2Bd, &g3Bd);CHKERRQ(ierr); 2841da51fcedSMatthew G. Knepley ierr = PetscDSSetJacobian(newprob, f, g, g0, g1, g2, g3);CHKERRQ(ierr); 2842da51fcedSMatthew G. Knepley ierr = PetscDSSetBdJacobian(newprob, f, g, g0Bd, g1Bd, g2Bd, g3Bd);CHKERRQ(ierr); 2843da51fcedSMatthew G. Knepley } 2844da51fcedSMatthew G. Knepley } 2845da51fcedSMatthew G. Knepley PetscFunctionReturn(0); 2846da51fcedSMatthew G. Knepley } 2847da51fcedSMatthew G. Knepley 2848b1353e8eSMatthew G. Knepley PetscErrorCode PetscDSGetHeightSubspace(PetscDS prob, PetscInt height, PetscDS *subprob) 2849b1353e8eSMatthew G. Knepley { 2850df3a45bdSMatthew G. Knepley PetscInt dim, Nf, f; 2851b1353e8eSMatthew G. Knepley PetscErrorCode ierr; 2852b1353e8eSMatthew G. Knepley 2853b1353e8eSMatthew G. Knepley PetscFunctionBegin; 2854b1353e8eSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 2855b1353e8eSMatthew G. Knepley PetscValidPointer(subprob, 3); 2856b1353e8eSMatthew G. Knepley if (height == 0) {*subprob = prob; PetscFunctionReturn(0);} 2857b1353e8eSMatthew G. Knepley ierr = PetscDSGetNumFields(prob, &Nf);CHKERRQ(ierr); 2858df3a45bdSMatthew G. Knepley ierr = PetscDSGetSpatialDimension(prob, &dim);CHKERRQ(ierr); 2859df3a45bdSMatthew 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); 2860df3a45bdSMatthew G. Knepley if (!prob->subprobs) {ierr = PetscCalloc1(dim, &prob->subprobs);CHKERRQ(ierr);} 2861df3a45bdSMatthew G. Knepley if (!prob->subprobs[height-1]) { 2862b1353e8eSMatthew G. Knepley PetscInt cdim; 2863b1353e8eSMatthew G. Knepley 2864df3a45bdSMatthew G. Knepley ierr = PetscDSCreate(PetscObjectComm((PetscObject) prob), &prob->subprobs[height-1]);CHKERRQ(ierr); 2865b1353e8eSMatthew G. Knepley ierr = PetscDSGetCoordinateDimension(prob, &cdim);CHKERRQ(ierr); 2866df3a45bdSMatthew G. Knepley ierr = PetscDSSetCoordinateDimension(prob->subprobs[height-1], cdim);CHKERRQ(ierr); 2867b1353e8eSMatthew G. Knepley for (f = 0; f < Nf; ++f) { 2868b1353e8eSMatthew G. Knepley PetscFE subfe; 2869b1353e8eSMatthew G. Knepley PetscObject obj; 2870b1353e8eSMatthew G. Knepley PetscClassId id; 2871b1353e8eSMatthew G. Knepley 2872b1353e8eSMatthew G. Knepley ierr = PetscDSGetDiscretization(prob, f, &obj);CHKERRQ(ierr); 2873b1353e8eSMatthew G. Knepley ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr); 2874b1353e8eSMatthew G. Knepley if (id == PETSCFE_CLASSID) {ierr = PetscFEGetHeightSubspace((PetscFE) obj, height, &subfe);CHKERRQ(ierr);} 2875b1353e8eSMatthew G. Knepley else SETERRQ1(PetscObjectComm((PetscObject) prob), PETSC_ERR_ARG_WRONG, "Unsupported discretization type for field %d", f); 2876df3a45bdSMatthew G. Knepley ierr = PetscDSSetDiscretization(prob->subprobs[height-1], f, (PetscObject) subfe);CHKERRQ(ierr); 2877b1353e8eSMatthew G. Knepley } 2878b1353e8eSMatthew G. Knepley } 2879df3a45bdSMatthew G. Knepley *subprob = prob->subprobs[height-1]; 2880b1353e8eSMatthew G. Knepley PetscFunctionReturn(0); 2881b1353e8eSMatthew G. Knepley } 2882b1353e8eSMatthew G. Knepley 2883bc4ae4beSMatthew G. Knepley static PetscErrorCode PetscDSDestroy_Basic(PetscDS prob) 28842764a2aaSMatthew G. Knepley { 2885931fb3b8SToby Isaac PetscErrorCode ierr; 2886931fb3b8SToby Isaac 28872764a2aaSMatthew G. Knepley PetscFunctionBegin; 2888931fb3b8SToby Isaac ierr = PetscFree(prob->data);CHKERRQ(ierr); 28892764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 28902764a2aaSMatthew G. Knepley } 28912764a2aaSMatthew G. Knepley 2892bc4ae4beSMatthew G. Knepley static PetscErrorCode PetscDSInitialize_Basic(PetscDS prob) 28932764a2aaSMatthew G. Knepley { 28942764a2aaSMatthew G. Knepley PetscFunctionBegin; 28952764a2aaSMatthew G. Knepley prob->ops->setfromoptions = NULL; 28962764a2aaSMatthew G. Knepley prob->ops->setup = NULL; 28972764a2aaSMatthew G. Knepley prob->ops->view = NULL; 28982764a2aaSMatthew G. Knepley prob->ops->destroy = PetscDSDestroy_Basic; 28992764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 29002764a2aaSMatthew G. Knepley } 29012764a2aaSMatthew G. Knepley 29022764a2aaSMatthew G. Knepley /*MC 29032764a2aaSMatthew G. Knepley PETSCDSBASIC = "basic" - A discrete system with pointwise residual and boundary residual functions 29042764a2aaSMatthew G. Knepley 29052764a2aaSMatthew G. Knepley Level: intermediate 29062764a2aaSMatthew G. Knepley 29072764a2aaSMatthew G. Knepley .seealso: PetscDSType, PetscDSCreate(), PetscDSSetType() 29082764a2aaSMatthew G. Knepley M*/ 29092764a2aaSMatthew G. Knepley 29102764a2aaSMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscDSCreate_Basic(PetscDS prob) 29112764a2aaSMatthew G. Knepley { 29122764a2aaSMatthew G. Knepley PetscDS_Basic *b; 29132764a2aaSMatthew G. Knepley PetscErrorCode ierr; 29142764a2aaSMatthew G. Knepley 29152764a2aaSMatthew G. Knepley PetscFunctionBegin; 2916931fb3b8SToby Isaac PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 29172764a2aaSMatthew G. Knepley ierr = PetscNewLog(prob, &b);CHKERRQ(ierr); 29182764a2aaSMatthew G. Knepley prob->data = b; 29192764a2aaSMatthew G. Knepley 29202764a2aaSMatthew G. Knepley ierr = PetscDSInitialize_Basic(prob);CHKERRQ(ierr); 29212764a2aaSMatthew G. Knepley PetscFunctionReturn(0); 29222764a2aaSMatthew G. Knepley } 2923