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 894dcdc3fSMatthew G. Knepley /* A PetscDS (Discrete System) encodes a set of equations posed in a discrete space, which represents a set of 994dcdc3fSMatthew G. Knepley nonlinear continuum equations. The equations can have multiple fields, each field having a different 1094dcdc3fSMatthew G. Knepley discretization. In addition, different pieces of the domain can have different field combinations and equations. 1194dcdc3fSMatthew G. Knepley 1294dcdc3fSMatthew G. Knepley The DS provides the user a description of the approximation space on any given cell. It also gives pointwise 1394dcdc3fSMatthew G. Knepley functions representing the equations. 1494dcdc3fSMatthew G. Knepley 1594dcdc3fSMatthew G. Knepley Each field is associated with a label, marking the cells on which it is supported. Note that a field can be 1694dcdc3fSMatthew G. Knepley supported on the closure of a cell not in the label due to overlap of the boundary of neighboring cells. The DM 1794dcdc3fSMatthew G. Knepley then creates a DS for each set of cells with identical approximation spaces. When assembling, the user asks for 1894dcdc3fSMatthew G. Knepley the space associated with a given cell. DMPlex uses the labels associated with each DS in the default integration loop. 1994dcdc3fSMatthew G. Knepley */ 2094dcdc3fSMatthew G. Knepley 212764a2aaSMatthew G. Knepley /*@C 22dce8aebaSBarry Smith PetscDSRegister - Adds a new `PetscDS` implementation 232764a2aaSMatthew G. Knepley 2420f4b53cSBarry Smith Not Collective; No Fortran Support 252764a2aaSMatthew G. Knepley 262764a2aaSMatthew G. Knepley Input Parameters: 2720f4b53cSBarry Smith + sname - The name of a new user-defined creation routine 2820f4b53cSBarry Smith - function - The creation routine itself 292764a2aaSMatthew G. Knepley 3060225df5SJacob Faibussowitsch Example Usage: 312764a2aaSMatthew G. Knepley .vb 322764a2aaSMatthew G. Knepley PetscDSRegister("my_ds", MyPetscDSCreate); 332764a2aaSMatthew G. Knepley .ve 342764a2aaSMatthew G. Knepley 352764a2aaSMatthew G. Knepley Then, your PetscDS type can be chosen with the procedural interface via 362764a2aaSMatthew G. Knepley .vb 372764a2aaSMatthew G. Knepley PetscDSCreate(MPI_Comm, PetscDS *); 382764a2aaSMatthew G. Knepley PetscDSSetType(PetscDS, "my_ds"); 392764a2aaSMatthew G. Knepley .ve 402764a2aaSMatthew G. Knepley or at runtime via the option 412764a2aaSMatthew G. Knepley .vb 422764a2aaSMatthew G. Knepley -petscds_type my_ds 432764a2aaSMatthew G. Knepley .ve 442764a2aaSMatthew G. Knepley 452764a2aaSMatthew G. Knepley Level: advanced 462764a2aaSMatthew G. Knepley 47dce8aebaSBarry Smith Note: 48dce8aebaSBarry Smith `PetscDSRegister()` may be called multiple times to add several user-defined `PetscDSs` 49dce8aebaSBarry Smith 50dce8aebaSBarry Smith .seealso: `PetscDSType`, `PetscDS`, `PetscDSRegisterAll()`, `PetscDSRegisterDestroy()` 512764a2aaSMatthew G. Knepley @*/ 52d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSRegister(const char sname[], PetscErrorCode (*function)(PetscDS)) 53d71ae5a4SJacob Faibussowitsch { 542764a2aaSMatthew G. Knepley PetscFunctionBegin; 559566063dSJacob Faibussowitsch PetscCall(PetscFunctionListAdd(&PetscDSList, sname, function)); 563ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 572764a2aaSMatthew G. Knepley } 582764a2aaSMatthew G. Knepley 59cc4c1da9SBarry Smith /*@ 60dce8aebaSBarry Smith PetscDSSetType - Builds a particular `PetscDS` 612764a2aaSMatthew G. Knepley 6220f4b53cSBarry Smith Collective; No Fortran Support 632764a2aaSMatthew G. Knepley 642764a2aaSMatthew G. Knepley Input Parameters: 65dce8aebaSBarry Smith + prob - The `PetscDS` object 66dce8aebaSBarry Smith - name - The `PetscDSType` 672764a2aaSMatthew G. Knepley 682764a2aaSMatthew G. Knepley Options Database Key: 692764a2aaSMatthew G. Knepley . -petscds_type <type> - Sets the PetscDS type; use -help for a list of available types 702764a2aaSMatthew G. Knepley 712764a2aaSMatthew G. Knepley Level: intermediate 722764a2aaSMatthew G. Knepley 73dce8aebaSBarry Smith .seealso: `PetscDSType`, `PetscDS`, `PetscDSGetType()`, `PetscDSCreate()` 742764a2aaSMatthew G. Knepley @*/ 75d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSSetType(PetscDS prob, PetscDSType name) 76d71ae5a4SJacob Faibussowitsch { 772764a2aaSMatthew G. Knepley PetscErrorCode (*r)(PetscDS); 782764a2aaSMatthew G. Knepley PetscBool match; 792764a2aaSMatthew G. Knepley 802764a2aaSMatthew G. Knepley PetscFunctionBegin; 812764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 829566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)prob, name, &match)); 833ba16761SJacob Faibussowitsch if (match) PetscFunctionReturn(PETSC_SUCCESS); 842764a2aaSMatthew G. Knepley 859566063dSJacob Faibussowitsch PetscCall(PetscDSRegisterAll()); 869566063dSJacob Faibussowitsch PetscCall(PetscFunctionListFind(PetscDSList, name, &r)); 8728b400f6SJacob Faibussowitsch PetscCheck(r, PetscObjectComm((PetscObject)prob), PETSC_ERR_ARG_UNKNOWN_TYPE, "Unknown PetscDS type: %s", name); 882764a2aaSMatthew G. Knepley 89dbbe0bcdSBarry Smith PetscTryTypeMethod(prob, destroy); 902764a2aaSMatthew G. Knepley prob->ops->destroy = NULL; 91dbbe0bcdSBarry Smith 929566063dSJacob Faibussowitsch PetscCall((*r)(prob)); 939566063dSJacob Faibussowitsch PetscCall(PetscObjectChangeTypeName((PetscObject)prob, name)); 943ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 952764a2aaSMatthew G. Knepley } 962764a2aaSMatthew G. Knepley 97cc4c1da9SBarry Smith /*@ 98dce8aebaSBarry Smith PetscDSGetType - Gets the `PetscDSType` name (as a string) from the `PetscDS` 992764a2aaSMatthew G. Knepley 10020f4b53cSBarry Smith Not Collective; No Fortran Support 1012764a2aaSMatthew G. Knepley 1022764a2aaSMatthew G. Knepley Input Parameter: 103dce8aebaSBarry Smith . prob - The `PetscDS` 1042764a2aaSMatthew G. Knepley 1052764a2aaSMatthew G. Knepley Output Parameter: 106dce8aebaSBarry Smith . name - The `PetscDSType` name 1072764a2aaSMatthew G. Knepley 1082764a2aaSMatthew G. Knepley Level: intermediate 1092764a2aaSMatthew G. Knepley 110dce8aebaSBarry Smith .seealso: `PetscDSType`, `PetscDS`, `PetscDSSetType()`, `PetscDSCreate()` 1112764a2aaSMatthew G. Knepley @*/ 112d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSGetType(PetscDS prob, PetscDSType *name) 113d71ae5a4SJacob Faibussowitsch { 1142764a2aaSMatthew G. Knepley PetscFunctionBegin; 1152764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 1164f572ea9SToby Isaac PetscAssertPointer(name, 2); 1179566063dSJacob Faibussowitsch PetscCall(PetscDSRegisterAll()); 1182764a2aaSMatthew G. Knepley *name = ((PetscObject)prob)->type_name; 1193ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1202764a2aaSMatthew G. Knepley } 1212764a2aaSMatthew G. Knepley 122d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscDSView_Ascii(PetscDS ds, PetscViewer viewer) 123d71ae5a4SJacob Faibussowitsch { 1247d8a60eaSMatthew G. Knepley PetscViewerFormat format; 12597b6e6e8SMatthew G. Knepley const PetscScalar *constants; 1265fedec97SMatthew G. Knepley PetscInt Nf, numConstants, f; 1277d8a60eaSMatthew G. Knepley 1287d8a60eaSMatthew G. Knepley PetscFunctionBegin; 1299566063dSJacob Faibussowitsch PetscCall(PetscDSGetNumFields(ds, &Nf)); 1309566063dSJacob Faibussowitsch PetscCall(PetscViewerGetFormat(viewer, &format)); 13163a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "Discrete System with %" PetscInt_FMT " fields\n", Nf)); 1329566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPushTab(viewer)); 13363a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " cell total dim %" PetscInt_FMT " total comp %" PetscInt_FMT "\n", ds->totDim, ds->totComp)); 1349566063dSJacob Faibussowitsch if (ds->isCohesive) PetscCall(PetscViewerASCIIPrintf(viewer, " cohesive cell\n")); 1355fedec97SMatthew G. Knepley for (f = 0; f < Nf; ++f) { 13640967b3bSMatthew G. Knepley DSBoundary b; 1377d8a60eaSMatthew G. Knepley PetscObject obj; 1387d8a60eaSMatthew G. Knepley PetscClassId id; 139f35450b9SMatthew G. Knepley PetscQuadrature q; 1407d8a60eaSMatthew G. Knepley const char *name; 141f35450b9SMatthew G. Knepley PetscInt Nc, Nq, Nqc; 1427d8a60eaSMatthew G. Knepley 1439566063dSJacob Faibussowitsch PetscCall(PetscDSGetDiscretization(ds, f, &obj)); 1449566063dSJacob Faibussowitsch PetscCall(PetscObjectGetClassId(obj, &id)); 1459566063dSJacob Faibussowitsch PetscCall(PetscObjectGetName(obj, &name)); 1469566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "Field %s", name ? name : "<unknown>")); 1479566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_FALSE)); 1487d8a60eaSMatthew G. Knepley if (id == PETSCFE_CLASSID) { 1499566063dSJacob Faibussowitsch PetscCall(PetscFEGetNumComponents((PetscFE)obj, &Nc)); 1509566063dSJacob Faibussowitsch PetscCall(PetscFEGetQuadrature((PetscFE)obj, &q)); 1519566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " FEM")); 1527d8a60eaSMatthew G. Knepley } else if (id == PETSCFV_CLASSID) { 1539566063dSJacob Faibussowitsch PetscCall(PetscFVGetNumComponents((PetscFV)obj, &Nc)); 1549566063dSJacob Faibussowitsch PetscCall(PetscFVGetQuadrature((PetscFV)obj, &q)); 1559566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " FVM")); 1569371c9d4SSatish Balay } else SETERRQ(PetscObjectComm((PetscObject)ds), PETSC_ERR_ARG_WRONG, "Unknown discretization type for field %" PetscInt_FMT, f); 15763a3b9bcSJacob Faibussowitsch if (Nc > 1) PetscCall(PetscViewerASCIIPrintf(viewer, " %" PetscInt_FMT " components", Nc)); 15863a3b9bcSJacob Faibussowitsch else PetscCall(PetscViewerASCIIPrintf(viewer, " %" PetscInt_FMT " component ", Nc)); 1599566063dSJacob Faibussowitsch if (ds->implicit[f]) PetscCall(PetscViewerASCIIPrintf(viewer, " (implicit)")); 1609566063dSJacob Faibussowitsch else PetscCall(PetscViewerASCIIPrintf(viewer, " (explicit)")); 1613e60c2a6SMatthew G. Knepley if (q) { 1629566063dSJacob Faibussowitsch PetscCall(PetscQuadratureGetData(q, NULL, &Nqc, &Nq, NULL, NULL)); 16363a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " (Nq %" PetscInt_FMT " Nqc %" PetscInt_FMT ")", Nq, Nqc)); 1643e60c2a6SMatthew G. Knepley } 16563a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " %" PetscInt_FMT "-jet", ds->jetDegree[f])); 1669566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "\n")); 1679566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_TRUE)); 1689566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPushTab(viewer)); 1699566063dSJacob Faibussowitsch if (id == PETSCFE_CLASSID) PetscCall(PetscFEView((PetscFE)obj, viewer)); 1709566063dSJacob Faibussowitsch else if (id == PETSCFV_CLASSID) PetscCall(PetscFVView((PetscFV)obj, viewer)); 1719566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPopTab(viewer)); 17240967b3bSMatthew G. Knepley 1735fedec97SMatthew G. Knepley for (b = ds->boundary; b; b = b->next) { 17406ad1575SMatthew G. Knepley char *name; 17540967b3bSMatthew G. Knepley PetscInt c, i; 17640967b3bSMatthew G. Knepley 17740967b3bSMatthew G. Knepley if (b->field != f) continue; 1789566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPushTab(viewer)); 1799566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "Boundary %s (%s) %s\n", b->name, b->lname, DMBoundaryConditionTypes[b->type])); 18045480ffeSMatthew G. Knepley if (!b->Nc) { 1819566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " all components\n")); 18240967b3bSMatthew G. Knepley } else { 1839566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " components: ")); 1849566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_FALSE)); 18545480ffeSMatthew G. Knepley for (c = 0; c < b->Nc; ++c) { 1869566063dSJacob Faibussowitsch if (c > 0) PetscCall(PetscViewerASCIIPrintf(viewer, ", ")); 18763a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "%" PetscInt_FMT, b->comps[c])); 18840967b3bSMatthew G. Knepley } 1899566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "\n")); 1909566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_TRUE)); 19140967b3bSMatthew G. Knepley } 1929566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " values: ")); 1939566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_FALSE)); 19445480ffeSMatthew G. Knepley for (i = 0; i < b->Nv; ++i) { 1959566063dSJacob Faibussowitsch if (i > 0) PetscCall(PetscViewerASCIIPrintf(viewer, ", ")); 19663a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "%" PetscInt_FMT, b->values[i])); 19740967b3bSMatthew G. Knepley } 1989566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "\n")); 1999566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_TRUE)); 20015943bb8SPierre Jolivet #if defined(__clang__) 201a8f51744SPierre Jolivet PETSC_PRAGMA_DIAGNOSTIC_IGNORED_BEGIN("-Wformat-pedantic") 20215943bb8SPierre Jolivet #elif defined(__GNUC__) || defined(__GNUG__) 203a8f51744SPierre Jolivet PETSC_PRAGMA_DIAGNOSTIC_IGNORED_BEGIN("-Wformat") 20415943bb8SPierre Jolivet #endif 2058e0d8d9cSMatthew G. Knepley if (b->func) { 2069566063dSJacob Faibussowitsch PetscCall(PetscDLAddr(b->func, &name)); 2079566063dSJacob Faibussowitsch if (name) PetscCall(PetscViewerASCIIPrintf(viewer, " func: %s\n", name)); 2089566063dSJacob Faibussowitsch else PetscCall(PetscViewerASCIIPrintf(viewer, " func: %p\n", b->func)); 2099566063dSJacob Faibussowitsch PetscCall(PetscFree(name)); 2108e0d8d9cSMatthew G. Knepley } 2118e0d8d9cSMatthew G. Knepley if (b->func_t) { 2129566063dSJacob Faibussowitsch PetscCall(PetscDLAddr(b->func_t, &name)); 2139566063dSJacob Faibussowitsch if (name) PetscCall(PetscViewerASCIIPrintf(viewer, " func_t: %s\n", name)); 2149566063dSJacob Faibussowitsch else PetscCall(PetscViewerASCIIPrintf(viewer, " func_t: %p\n", b->func_t)); 2159566063dSJacob Faibussowitsch PetscCall(PetscFree(name)); 2168e0d8d9cSMatthew G. Knepley } 217a8f51744SPierre Jolivet PETSC_PRAGMA_DIAGNOSTIC_IGNORED_END() 2189566063dSJacob Faibussowitsch PetscCall(PetscWeakFormView(b->wf, viewer)); 2199566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPopTab(viewer)); 22040967b3bSMatthew G. Knepley } 2217d8a60eaSMatthew G. Knepley } 2229566063dSJacob Faibussowitsch PetscCall(PetscDSGetConstants(ds, &numConstants, &constants)); 22397b6e6e8SMatthew G. Knepley if (numConstants) { 22463a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "%" PetscInt_FMT " constants\n", numConstants)); 2259566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPushTab(viewer)); 2269566063dSJacob Faibussowitsch for (f = 0; f < numConstants; ++f) PetscCall(PetscViewerASCIIPrintf(viewer, "%g\n", (double)PetscRealPart(constants[f]))); 2279566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPopTab(viewer)); 22897b6e6e8SMatthew G. Knepley } 2299566063dSJacob Faibussowitsch PetscCall(PetscWeakFormView(ds->wf, viewer)); 2309566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPopTab(viewer)); 2313ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2327d8a60eaSMatthew G. Knepley } 2337d8a60eaSMatthew G. Knepley 234ffeef943SBarry Smith /*@ 235dce8aebaSBarry Smith PetscDSViewFromOptions - View a `PetscDS` based on values in the options database 236fe2efc57SMark 23720f4b53cSBarry Smith Collective 238fe2efc57SMark 239fe2efc57SMark Input Parameters: 240dce8aebaSBarry Smith + A - the `PetscDS` object 24120f4b53cSBarry Smith . obj - Optional object that provides the options prefix used in the search 242736c3998SJose E. Roman - name - command line option 243fe2efc57SMark 244fe2efc57SMark Level: intermediate 245dce8aebaSBarry Smith 246dce8aebaSBarry Smith .seealso: `PetscDSType`, `PetscDS`, `PetscDSView()`, `PetscObjectViewFromOptions()`, `PetscDSCreate()` 247fe2efc57SMark @*/ 248d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSViewFromOptions(PetscDS A, PetscObject obj, const char name[]) 249d71ae5a4SJacob Faibussowitsch { 250fe2efc57SMark PetscFunctionBegin; 251fe2efc57SMark PetscValidHeaderSpecific(A, PETSCDS_CLASSID, 1); 2529566063dSJacob Faibussowitsch PetscCall(PetscObjectViewFromOptions((PetscObject)A, obj, name)); 2533ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 254fe2efc57SMark } 255fe2efc57SMark 256ffeef943SBarry Smith /*@ 257dce8aebaSBarry Smith PetscDSView - Views a `PetscDS` 2582764a2aaSMatthew G. Knepley 25920f4b53cSBarry Smith Collective 2602764a2aaSMatthew G. Knepley 261d8d19677SJose E. Roman Input Parameters: 262dce8aebaSBarry Smith + prob - the `PetscDS` object to view 2632764a2aaSMatthew G. Knepley - v - the viewer 2642764a2aaSMatthew G. Knepley 2652764a2aaSMatthew G. Knepley Level: developer 2662764a2aaSMatthew G. Knepley 26720f4b53cSBarry Smith .seealso: `PetscDSType`, `PetscDS`, `PetscViewer`, `PetscDSDestroy()`, `PetscDSViewFromOptions()` 2682764a2aaSMatthew G. Knepley @*/ 269d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSView(PetscDS prob, PetscViewer v) 270d71ae5a4SJacob Faibussowitsch { 2717d8a60eaSMatthew G. Knepley PetscBool iascii; 2722764a2aaSMatthew G. Knepley 2732764a2aaSMatthew G. Knepley PetscFunctionBegin; 2742764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 2759566063dSJacob Faibussowitsch if (!v) PetscCall(PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)prob), &v)); 276ad540459SPierre Jolivet else PetscValidHeaderSpecific(v, PETSC_VIEWER_CLASSID, 2); 2779566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)v, PETSCVIEWERASCII, &iascii)); 2789566063dSJacob Faibussowitsch if (iascii) PetscCall(PetscDSView_Ascii(prob, v)); 279dbbe0bcdSBarry Smith PetscTryTypeMethod(prob, view, v); 2803ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2812764a2aaSMatthew G. Knepley } 2822764a2aaSMatthew G. Knepley 2832764a2aaSMatthew G. Knepley /*@ 284dce8aebaSBarry Smith PetscDSSetFromOptions - sets parameters in a `PetscDS` from the options database 2852764a2aaSMatthew G. Knepley 28620f4b53cSBarry Smith Collective 2872764a2aaSMatthew G. Knepley 2882764a2aaSMatthew G. Knepley Input Parameter: 289dce8aebaSBarry Smith . prob - the `PetscDS` object to set options for 2902764a2aaSMatthew G. Knepley 291dce8aebaSBarry Smith Options Database Keys: 292dce8aebaSBarry Smith + -petscds_type <type> - Set the `PetscDS` type 293dce8aebaSBarry Smith . -petscds_view <view opt> - View the `PetscDS` 294147403d9SBarry Smith . -petscds_jac_pre - Turn formation of a separate Jacobian preconditioner on or off 295147403d9SBarry Smith . -bc_<name> <ids> - Specify a list of label ids for a boundary condition 296147403d9SBarry Smith - -bc_<name>_comp <comps> - Specify a list of field components to constrain for a boundary condition 2972764a2aaSMatthew G. Knepley 298dce8aebaSBarry Smith Level: intermediate 2992764a2aaSMatthew G. Knepley 300dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSView()` 3012764a2aaSMatthew G. Knepley @*/ 302d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSSetFromOptions(PetscDS prob) 303d71ae5a4SJacob Faibussowitsch { 304f1fd5e65SToby Isaac DSBoundary b; 3052764a2aaSMatthew G. Knepley const char *defaultType; 3062764a2aaSMatthew G. Knepley char name[256]; 3072764a2aaSMatthew G. Knepley PetscBool flg; 3082764a2aaSMatthew G. Knepley 3092764a2aaSMatthew G. Knepley PetscFunctionBegin; 3102764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 3112764a2aaSMatthew G. Knepley if (!((PetscObject)prob)->type_name) { 3122764a2aaSMatthew G. Knepley defaultType = PETSCDSBASIC; 3132764a2aaSMatthew G. Knepley } else { 3142764a2aaSMatthew G. Knepley defaultType = ((PetscObject)prob)->type_name; 3152764a2aaSMatthew G. Knepley } 3169566063dSJacob Faibussowitsch PetscCall(PetscDSRegisterAll()); 3172764a2aaSMatthew G. Knepley 318d0609cedSBarry Smith PetscObjectOptionsBegin((PetscObject)prob); 319f1fd5e65SToby Isaac for (b = prob->boundary; b; b = b->next) { 320f1fd5e65SToby Isaac char optname[1024]; 321f1fd5e65SToby Isaac PetscInt ids[1024], len = 1024; 322f1fd5e65SToby Isaac PetscBool flg; 323f1fd5e65SToby Isaac 3249566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(optname, sizeof(optname), "-bc_%s", b->name)); 3259566063dSJacob Faibussowitsch PetscCall(PetscMemzero(ids, sizeof(ids))); 3269566063dSJacob Faibussowitsch PetscCall(PetscOptionsIntArray(optname, "List of boundary IDs", "", ids, &len, &flg)); 327f1fd5e65SToby Isaac if (flg) { 32845480ffeSMatthew G. Knepley b->Nv = len; 3299566063dSJacob Faibussowitsch PetscCall(PetscFree(b->values)); 3309566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(len, &b->values)); 3319566063dSJacob Faibussowitsch PetscCall(PetscArraycpy(b->values, ids, len)); 3329566063dSJacob Faibussowitsch PetscCall(PetscWeakFormRewriteKeys(b->wf, b->label, len, b->values)); 333f1fd5e65SToby Isaac } 334e7b0402cSSander Arens len = 1024; 3359566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(optname, sizeof(optname), "-bc_%s_comp", b->name)); 3369566063dSJacob Faibussowitsch PetscCall(PetscMemzero(ids, sizeof(ids))); 3379566063dSJacob Faibussowitsch PetscCall(PetscOptionsIntArray(optname, "List of boundary field components", "", ids, &len, &flg)); 338f1fd5e65SToby Isaac if (flg) { 33945480ffeSMatthew G. Knepley b->Nc = len; 3409566063dSJacob Faibussowitsch PetscCall(PetscFree(b->comps)); 3419566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(len, &b->comps)); 3429566063dSJacob Faibussowitsch PetscCall(PetscArraycpy(b->comps, ids, len)); 343f1fd5e65SToby Isaac } 344f1fd5e65SToby Isaac } 3459566063dSJacob Faibussowitsch PetscCall(PetscOptionsFList("-petscds_type", "Discrete System", "PetscDSSetType", PetscDSList, defaultType, name, 256, &flg)); 3462764a2aaSMatthew G. Knepley if (flg) { 3479566063dSJacob Faibussowitsch PetscCall(PetscDSSetType(prob, name)); 3482764a2aaSMatthew G. Knepley } else if (!((PetscObject)prob)->type_name) { 3499566063dSJacob Faibussowitsch PetscCall(PetscDSSetType(prob, defaultType)); 3502764a2aaSMatthew G. Knepley } 3519566063dSJacob Faibussowitsch PetscCall(PetscOptionsBool("-petscds_jac_pre", "Discrete System", "PetscDSUseJacobianPreconditioner", prob->useJacPre, &prob->useJacPre, &flg)); 35212fc5b22SMatthew G. Knepley PetscCall(PetscOptionsBool("-petscds_force_quad", "Discrete System", "PetscDSSetForceQuad", prob->forceQuad, &prob->forceQuad, &flg)); 353b2deab97SMatthew G. Knepley PetscCall(PetscOptionsInt("-petscds_print_integrate", "Discrete System", "", prob->printIntegrate, &prob->printIntegrate, NULL)); 354dbbe0bcdSBarry Smith PetscTryTypeMethod(prob, setfromoptions); 3552764a2aaSMatthew G. Knepley /* process any options handlers added with PetscObjectAddOptionsHandler() */ 356dbbe0bcdSBarry Smith PetscCall(PetscObjectProcessOptionsHandlers((PetscObject)prob, PetscOptionsObject)); 357d0609cedSBarry Smith PetscOptionsEnd(); 3589566063dSJacob Faibussowitsch if (prob->Nf) PetscCall(PetscDSViewFromOptions(prob, NULL, "-petscds_view")); 3593ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 3602764a2aaSMatthew G. Knepley } 3612764a2aaSMatthew G. Knepley 362cc4c1da9SBarry Smith /*@ 363dce8aebaSBarry Smith PetscDSSetUp - Construct data structures for the `PetscDS` 3642764a2aaSMatthew G. Knepley 36520f4b53cSBarry Smith Collective 3662764a2aaSMatthew G. Knepley 3672764a2aaSMatthew G. Knepley Input Parameter: 368dce8aebaSBarry Smith . prob - the `PetscDS` object to setup 3692764a2aaSMatthew G. Knepley 3702764a2aaSMatthew G. Knepley Level: developer 3712764a2aaSMatthew G. Knepley 372dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSView()`, `PetscDSDestroy()` 3732764a2aaSMatthew G. Knepley @*/ 374d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSSetUp(PetscDS prob) 375d71ae5a4SJacob Faibussowitsch { 3762764a2aaSMatthew G. Knepley const PetscInt Nf = prob->Nf; 377f9244615SMatthew G. Knepley PetscBool hasH = PETSC_FALSE; 378e59ddd55SMatthew G. Knepley PetscInt maxOrder[4] = {-2, -2, -2, -2}; 3794bee2e38SMatthew G. Knepley PetscInt dim, dimEmbed, NbMax = 0, NcMax = 0, NqMax = 0, NsMax = 1, f; 3802764a2aaSMatthew G. Knepley 3812764a2aaSMatthew G. Knepley PetscFunctionBegin; 3822764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 3833ba16761SJacob Faibussowitsch if (prob->setup) PetscFunctionReturn(PETSC_SUCCESS); 3842764a2aaSMatthew G. Knepley /* Calculate sizes */ 3859566063dSJacob Faibussowitsch PetscCall(PetscDSGetSpatialDimension(prob, &dim)); 3869566063dSJacob Faibussowitsch PetscCall(PetscDSGetCoordinateDimension(prob, &dimEmbed)); 387f744cafaSSander Arens prob->totDim = prob->totComp = 0; 3889566063dSJacob Faibussowitsch PetscCall(PetscMalloc2(Nf, &prob->Nc, Nf, &prob->Nb)); 3899566063dSJacob Faibussowitsch PetscCall(PetscCalloc2(Nf + 1, &prob->off, Nf + 1, &prob->offDer)); 3909566063dSJacob Faibussowitsch PetscCall(PetscCalloc6(Nf + 1, &prob->offCohesive[0], Nf + 1, &prob->offCohesive[1], Nf + 1, &prob->offCohesive[2], Nf + 1, &prob->offDerCohesive[0], Nf + 1, &prob->offDerCohesive[1], Nf + 1, &prob->offDerCohesive[2])); 3919566063dSJacob Faibussowitsch PetscCall(PetscMalloc2(Nf, &prob->T, Nf, &prob->Tf)); 39212fc5b22SMatthew G. Knepley if (prob->forceQuad) { 39307218a29SMatthew G. Knepley // Note: This assumes we have one kind of cell at each dimension. 39407218a29SMatthew G. Knepley // We can fix this by having quadrature hold the celltype 39507218a29SMatthew G. Knepley PetscQuadrature maxQuad[4] = {NULL, NULL, NULL, NULL}; 39612fc5b22SMatthew G. Knepley 39712fc5b22SMatthew G. Knepley for (f = 0; f < Nf; ++f) { 39812fc5b22SMatthew G. Knepley PetscObject obj; 39912fc5b22SMatthew G. Knepley PetscClassId id; 40012fc5b22SMatthew G. Knepley PetscQuadrature q = NULL, fq = NULL; 40107218a29SMatthew G. Knepley PetscInt dim = -1, order = -1, forder = -1; 40212fc5b22SMatthew G. Knepley 40312fc5b22SMatthew G. Knepley PetscCall(PetscDSGetDiscretization(prob, f, &obj)); 40412fc5b22SMatthew G. Knepley if (!obj) continue; 40512fc5b22SMatthew G. Knepley PetscCall(PetscObjectGetClassId(obj, &id)); 40612fc5b22SMatthew G. Knepley if (id == PETSCFE_CLASSID) { 40712fc5b22SMatthew G. Knepley PetscFE fe = (PetscFE)obj; 40812fc5b22SMatthew G. Knepley 40912fc5b22SMatthew G. Knepley PetscCall(PetscFEGetQuadrature(fe, &q)); 41012fc5b22SMatthew G. Knepley PetscCall(PetscFEGetFaceQuadrature(fe, &fq)); 41112fc5b22SMatthew G. Knepley } else if (id == PETSCFV_CLASSID) { 41212fc5b22SMatthew G. Knepley PetscFV fv = (PetscFV)obj; 41312fc5b22SMatthew G. Knepley 41412fc5b22SMatthew G. Knepley PetscCall(PetscFVGetQuadrature(fv, &q)); 41512fc5b22SMatthew G. Knepley } 41607218a29SMatthew G. Knepley if (q) { 41707218a29SMatthew G. Knepley PetscCall(PetscQuadratureGetData(q, &dim, NULL, NULL, NULL, NULL)); 41807218a29SMatthew G. Knepley PetscCall(PetscQuadratureGetOrder(q, &order)); 41907218a29SMatthew G. Knepley if (order > maxOrder[dim]) { 42007218a29SMatthew G. Knepley maxOrder[dim] = order; 42107218a29SMatthew G. Knepley maxQuad[dim] = q; 42212fc5b22SMatthew G. Knepley } 42307218a29SMatthew G. Knepley } 42407218a29SMatthew G. Knepley if (fq) { 42507218a29SMatthew G. Knepley PetscCall(PetscQuadratureGetData(fq, &dim, NULL, NULL, NULL, NULL)); 42607218a29SMatthew G. Knepley PetscCall(PetscQuadratureGetOrder(fq, &forder)); 42707218a29SMatthew G. Knepley if (forder > maxOrder[dim]) { 42807218a29SMatthew G. Knepley maxOrder[dim] = forder; 42907218a29SMatthew G. Knepley maxQuad[dim] = fq; 43007218a29SMatthew G. Knepley } 43112fc5b22SMatthew G. Knepley } 43212fc5b22SMatthew G. Knepley } 43312fc5b22SMatthew G. Knepley for (f = 0; f < Nf; ++f) { 43412fc5b22SMatthew G. Knepley PetscObject obj; 43512fc5b22SMatthew G. Knepley PetscClassId id; 43607218a29SMatthew G. Knepley PetscQuadrature q; 43707218a29SMatthew G. Knepley PetscInt dim; 43812fc5b22SMatthew G. Knepley 43912fc5b22SMatthew G. Knepley PetscCall(PetscDSGetDiscretization(prob, f, &obj)); 44012fc5b22SMatthew G. Knepley if (!obj) continue; 44112fc5b22SMatthew G. Knepley PetscCall(PetscObjectGetClassId(obj, &id)); 44212fc5b22SMatthew G. Knepley if (id == PETSCFE_CLASSID) { 44312fc5b22SMatthew G. Knepley PetscFE fe = (PetscFE)obj; 44412fc5b22SMatthew G. Knepley 44507218a29SMatthew G. Knepley PetscCall(PetscFEGetQuadrature(fe, &q)); 44607218a29SMatthew G. Knepley PetscCall(PetscQuadratureGetData(q, &dim, NULL, NULL, NULL, NULL)); 44707218a29SMatthew G. Knepley PetscCall(PetscFESetQuadrature(fe, maxQuad[dim])); 448aa9788aaSMatthew G. Knepley PetscCall(PetscFESetFaceQuadrature(fe, dim ? maxQuad[dim - 1] : NULL)); 44912fc5b22SMatthew G. Knepley } else if (id == PETSCFV_CLASSID) { 45012fc5b22SMatthew G. Knepley PetscFV fv = (PetscFV)obj; 45112fc5b22SMatthew G. Knepley 45207218a29SMatthew G. Knepley PetscCall(PetscFVGetQuadrature(fv, &q)); 45307218a29SMatthew G. Knepley PetscCall(PetscQuadratureGetData(q, &dim, NULL, NULL, NULL, NULL)); 45407218a29SMatthew G. Knepley PetscCall(PetscFVSetQuadrature(fv, maxQuad[dim])); 45512fc5b22SMatthew G. Knepley } 45612fc5b22SMatthew G. Knepley } 45712fc5b22SMatthew G. Knepley } 4582764a2aaSMatthew G. Knepley for (f = 0; f < Nf; ++f) { 4599de99aefSMatthew G. Knepley PetscObject obj; 4609de99aefSMatthew G. Knepley PetscClassId id; 461665f567fSMatthew G. Knepley PetscQuadrature q = NULL; 4629de99aefSMatthew G. Knepley PetscInt Nq = 0, Nb, Nc; 4632764a2aaSMatthew G. Knepley 4649566063dSJacob Faibussowitsch PetscCall(PetscDSGetDiscretization(prob, f, &obj)); 465f9244615SMatthew G. Knepley if (prob->jetDegree[f] > 1) hasH = PETSC_TRUE; 466665f567fSMatthew G. Knepley if (!obj) { 467665f567fSMatthew G. Knepley /* Empty mesh */ 468665f567fSMatthew G. Knepley Nb = Nc = 0; 469665f567fSMatthew G. Knepley prob->T[f] = prob->Tf[f] = NULL; 470665f567fSMatthew G. Knepley } else { 4719566063dSJacob Faibussowitsch PetscCall(PetscObjectGetClassId(obj, &id)); 4729de99aefSMatthew G. Knepley if (id == PETSCFE_CLASSID) { 4739de99aefSMatthew G. Knepley PetscFE fe = (PetscFE)obj; 4749de99aefSMatthew G. Knepley 4759566063dSJacob Faibussowitsch PetscCall(PetscFEGetQuadrature(fe, &q)); 47649ae0b56SMatthew G. Knepley { 47749ae0b56SMatthew G. Knepley PetscQuadrature fq; 47807218a29SMatthew G. Knepley PetscInt dim, order; 47949ae0b56SMatthew G. Knepley 48007218a29SMatthew G. Knepley PetscCall(PetscQuadratureGetData(q, &dim, NULL, NULL, NULL, NULL)); 48149ae0b56SMatthew G. Knepley PetscCall(PetscQuadratureGetOrder(q, &order)); 48207218a29SMatthew G. Knepley if (maxOrder[dim] < 0) maxOrder[dim] = order; 48307218a29SMatthew G. Knepley PetscCheck(order == maxOrder[dim], PETSC_COMM_SELF, PETSC_ERR_ARG_INCOMP, "Field %" PetscInt_FMT " cell quadrature order %" PetscInt_FMT " != %" PetscInt_FMT " DS cell quadrature order", f, order, maxOrder[dim]); 48449ae0b56SMatthew G. Knepley PetscCall(PetscFEGetFaceQuadrature(fe, &fq)); 48549ae0b56SMatthew G. Knepley if (fq) { 48607218a29SMatthew G. Knepley PetscCall(PetscQuadratureGetData(fq, &dim, NULL, NULL, NULL, NULL)); 48707218a29SMatthew G. Knepley PetscCall(PetscQuadratureGetOrder(fq, &order)); 48807218a29SMatthew G. Knepley if (maxOrder[dim] < 0) maxOrder[dim] = order; 48907218a29SMatthew G. Knepley PetscCheck(order == maxOrder[dim], PETSC_COMM_SELF, PETSC_ERR_ARG_INCOMP, "Field %" PetscInt_FMT " face quadrature order %" PetscInt_FMT " != %" PetscInt_FMT " DS face quadrature order", f, order, maxOrder[dim]); 49049ae0b56SMatthew G. Knepley } 49149ae0b56SMatthew G. Knepley } 4929566063dSJacob Faibussowitsch PetscCall(PetscFEGetDimension(fe, &Nb)); 4939566063dSJacob Faibussowitsch PetscCall(PetscFEGetNumComponents(fe, &Nc)); 4949566063dSJacob Faibussowitsch PetscCall(PetscFEGetCellTabulation(fe, prob->jetDegree[f], &prob->T[f])); 4959566063dSJacob Faibussowitsch PetscCall(PetscFEGetFaceTabulation(fe, prob->jetDegree[f], &prob->Tf[f])); 4969de99aefSMatthew G. Knepley } else if (id == PETSCFV_CLASSID) { 4979de99aefSMatthew G. Knepley PetscFV fv = (PetscFV)obj; 4989de99aefSMatthew G. Knepley 4999566063dSJacob Faibussowitsch PetscCall(PetscFVGetQuadrature(fv, &q)); 5009566063dSJacob Faibussowitsch PetscCall(PetscFVGetNumComponents(fv, &Nc)); 5019c3cf19fSMatthew G. Knepley Nb = Nc; 5029566063dSJacob Faibussowitsch PetscCall(PetscFVGetCellTabulation(fv, &prob->T[f])); 5034d0b9603SSander Arens /* TODO: should PetscFV also have face tabulation? Otherwise there will be a null pointer in prob->basisFace */ 50463a3b9bcSJacob Faibussowitsch } else SETERRQ(PetscObjectComm((PetscObject)prob), PETSC_ERR_ARG_WRONG, "Unknown discretization type for field %" PetscInt_FMT, f); 505665f567fSMatthew G. Knepley } 50647e57110SSander Arens prob->Nc[f] = Nc; 50747e57110SSander Arens prob->Nb[f] = Nb; 508194d53e6SMatthew G. Knepley prob->off[f + 1] = Nc + prob->off[f]; 509194d53e6SMatthew G. Knepley prob->offDer[f + 1] = Nc * dim + prob->offDer[f]; 5109ee2af8cSMatthew G. Knepley prob->offCohesive[0][f + 1] = (prob->cohesive[f] ? Nc : Nc * 2) + prob->offCohesive[0][f]; 5119ee2af8cSMatthew G. Knepley prob->offDerCohesive[0][f + 1] = (prob->cohesive[f] ? Nc : Nc * 2) * dimEmbed + prob->offDerCohesive[0][f]; 5129ee2af8cSMatthew G. Knepley prob->offCohesive[1][f] = (prob->cohesive[f] ? 0 : Nc) + prob->offCohesive[0][f]; 5139ee2af8cSMatthew G. Knepley prob->offDerCohesive[1][f] = (prob->cohesive[f] ? 0 : Nc) * dimEmbed + prob->offDerCohesive[0][f]; 5149ee2af8cSMatthew G. Knepley prob->offCohesive[2][f + 1] = (prob->cohesive[f] ? Nc : Nc * 2) + prob->offCohesive[2][f]; 5159ee2af8cSMatthew G. Knepley prob->offDerCohesive[2][f + 1] = (prob->cohesive[f] ? Nc : Nc * 2) * dimEmbed + prob->offDerCohesive[2][f]; 5169566063dSJacob Faibussowitsch if (q) PetscCall(PetscQuadratureGetData(q, NULL, NULL, &Nq, NULL, NULL)); 5172764a2aaSMatthew G. Knepley NqMax = PetscMax(NqMax, Nq); 5184bee2e38SMatthew G. Knepley NbMax = PetscMax(NbMax, Nb); 5192764a2aaSMatthew G. Knepley NcMax = PetscMax(NcMax, Nc); 5209c3cf19fSMatthew G. Knepley prob->totDim += Nb; 5212764a2aaSMatthew G. Knepley prob->totComp += Nc; 5225fedec97SMatthew G. Knepley /* There are two faces for all fields on a cohesive cell, except for cohesive fields */ 5235fedec97SMatthew G. Knepley if (prob->isCohesive && !prob->cohesive[f]) prob->totDim += Nb; 5242764a2aaSMatthew G. Knepley } 5259ee2af8cSMatthew G. Knepley prob->offCohesive[1][Nf] = prob->offCohesive[0][Nf]; 5269ee2af8cSMatthew G. Knepley prob->offDerCohesive[1][Nf] = prob->offDerCohesive[0][Nf]; 5272764a2aaSMatthew G. Knepley /* Allocate works space */ 5285fedec97SMatthew G. Knepley NsMax = 2; /* A non-cohesive discretizations can be used on a cohesive cell, so we need this extra workspace for all DS */ 5299566063dSJacob Faibussowitsch PetscCall(PetscMalloc3(NsMax * prob->totComp, &prob->u, NsMax * prob->totComp, &prob->u_t, NsMax * prob->totComp * dimEmbed + (hasH ? NsMax * prob->totComp * dimEmbed * dimEmbed : 0), &prob->u_x)); 5309566063dSJacob Faibussowitsch PetscCall(PetscMalloc5(dimEmbed, &prob->x, NbMax * NcMax, &prob->basisReal, NbMax * NcMax * dimEmbed, &prob->basisDerReal, NbMax * NcMax, &prob->testReal, NbMax * NcMax * dimEmbed, &prob->testDerReal)); 5319371c9d4SSatish Balay PetscCall(PetscMalloc6(NsMax * NqMax * NcMax, &prob->f0, NsMax * NqMax * NcMax * dimEmbed, &prob->f1, NsMax * NsMax * NqMax * NcMax * NcMax, &prob->g0, NsMax * NsMax * NqMax * NcMax * NcMax * dimEmbed, &prob->g1, NsMax * NsMax * NqMax * NcMax * NcMax * dimEmbed, 5329371c9d4SSatish Balay &prob->g2, NsMax * NsMax * NqMax * NcMax * NcMax * dimEmbed * dimEmbed, &prob->g3)); 533dbbe0bcdSBarry Smith PetscTryTypeMethod(prob, setup); 5342764a2aaSMatthew G. Knepley prob->setup = PETSC_TRUE; 5353ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 5362764a2aaSMatthew G. Knepley } 5372764a2aaSMatthew G. Knepley 538d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscDSDestroyStructs_Static(PetscDS prob) 539d71ae5a4SJacob Faibussowitsch { 5402764a2aaSMatthew G. Knepley PetscFunctionBegin; 5419566063dSJacob Faibussowitsch PetscCall(PetscFree2(prob->Nc, prob->Nb)); 5429566063dSJacob Faibussowitsch PetscCall(PetscFree2(prob->off, prob->offDer)); 5439566063dSJacob Faibussowitsch PetscCall(PetscFree6(prob->offCohesive[0], prob->offCohesive[1], prob->offCohesive[2], prob->offDerCohesive[0], prob->offDerCohesive[1], prob->offDerCohesive[2])); 5449566063dSJacob Faibussowitsch PetscCall(PetscFree2(prob->T, prob->Tf)); 5459566063dSJacob Faibussowitsch PetscCall(PetscFree3(prob->u, prob->u_t, prob->u_x)); 5469566063dSJacob Faibussowitsch PetscCall(PetscFree5(prob->x, prob->basisReal, prob->basisDerReal, prob->testReal, prob->testDerReal)); 5479566063dSJacob Faibussowitsch PetscCall(PetscFree6(prob->f0, prob->f1, prob->g0, prob->g1, prob->g2, prob->g3)); 5483ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 5492764a2aaSMatthew G. Knepley } 5502764a2aaSMatthew G. Knepley 551d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscDSEnlarge_Static(PetscDS prob, PetscInt NfNew) 552d71ae5a4SJacob Faibussowitsch { 553f744cafaSSander Arens PetscObject *tmpd; 55434aa8a36SMatthew G. Knepley PetscBool *tmpi; 555f9244615SMatthew G. Knepley PetscInt *tmpk; 5565fedec97SMatthew G. Knepley PetscBool *tmpc; 5576528b96dSMatthew G. Knepley PetscPointFunc *tmpup; 5588434afd1SBarry Smith PetscSimplePointFn **tmpexactSol, **tmpexactSol_t; 559f2cacb80SMatthew G. Knepley void **tmpexactCtx, **tmpexactCtx_t; 5600c2f2876SMatthew G. Knepley void **tmpctx; 56134aa8a36SMatthew G. Knepley PetscInt Nf = prob->Nf, f; 5622764a2aaSMatthew G. Knepley 5632764a2aaSMatthew G. Knepley PetscFunctionBegin; 5643ba16761SJacob Faibussowitsch if (Nf >= NfNew) PetscFunctionReturn(PETSC_SUCCESS); 5652764a2aaSMatthew G. Knepley prob->setup = PETSC_FALSE; 5669566063dSJacob Faibussowitsch PetscCall(PetscDSDestroyStructs_Static(prob)); 5679566063dSJacob Faibussowitsch PetscCall(PetscMalloc4(NfNew, &tmpd, NfNew, &tmpi, NfNew, &tmpc, NfNew, &tmpk)); 5689371c9d4SSatish Balay for (f = 0; f < Nf; ++f) { 5699371c9d4SSatish Balay tmpd[f] = prob->disc[f]; 5709371c9d4SSatish Balay tmpi[f] = prob->implicit[f]; 5719371c9d4SSatish Balay tmpc[f] = prob->cohesive[f]; 5729371c9d4SSatish Balay tmpk[f] = prob->jetDegree[f]; 5739371c9d4SSatish Balay } 5749371c9d4SSatish Balay for (f = Nf; f < NfNew; ++f) { 5759371c9d4SSatish Balay tmpd[f] = NULL; 5769371c9d4SSatish Balay tmpi[f] = PETSC_TRUE, tmpc[f] = PETSC_FALSE; 5779371c9d4SSatish Balay tmpk[f] = 1; 5789371c9d4SSatish Balay } 5799566063dSJacob Faibussowitsch PetscCall(PetscFree4(prob->disc, prob->implicit, prob->cohesive, prob->jetDegree)); 5809566063dSJacob Faibussowitsch PetscCall(PetscWeakFormSetNumFields(prob->wf, NfNew)); 5812764a2aaSMatthew G. Knepley prob->Nf = NfNew; 5822764a2aaSMatthew G. Knepley prob->disc = tmpd; 583249df284SMatthew G. Knepley prob->implicit = tmpi; 5845fedec97SMatthew G. Knepley prob->cohesive = tmpc; 585f9244615SMatthew G. Knepley prob->jetDegree = tmpk; 5869566063dSJacob Faibussowitsch PetscCall(PetscCalloc2(NfNew, &tmpup, NfNew, &tmpctx)); 58732d2bbc9SMatthew G. Knepley for (f = 0; f < Nf; ++f) tmpup[f] = prob->update[f]; 5880c2f2876SMatthew G. Knepley for (f = 0; f < Nf; ++f) tmpctx[f] = prob->ctx[f]; 58932d2bbc9SMatthew G. Knepley for (f = Nf; f < NfNew; ++f) tmpup[f] = NULL; 5900c2f2876SMatthew G. Knepley for (f = Nf; f < NfNew; ++f) tmpctx[f] = NULL; 5919566063dSJacob Faibussowitsch PetscCall(PetscFree2(prob->update, prob->ctx)); 59232d2bbc9SMatthew G. Knepley prob->update = tmpup; 5930c2f2876SMatthew G. Knepley prob->ctx = tmpctx; 5949566063dSJacob Faibussowitsch PetscCall(PetscCalloc4(NfNew, &tmpexactSol, NfNew, &tmpexactCtx, NfNew, &tmpexactSol_t, NfNew, &tmpexactCtx_t)); 595c371a6d1SMatthew G. Knepley for (f = 0; f < Nf; ++f) tmpexactSol[f] = prob->exactSol[f]; 59695cbbfd3SMatthew G. Knepley for (f = 0; f < Nf; ++f) tmpexactCtx[f] = prob->exactCtx[f]; 597f2cacb80SMatthew G. Knepley for (f = 0; f < Nf; ++f) tmpexactSol_t[f] = prob->exactSol_t[f]; 598f2cacb80SMatthew G. Knepley for (f = 0; f < Nf; ++f) tmpexactCtx_t[f] = prob->exactCtx_t[f]; 599c371a6d1SMatthew G. Knepley for (f = Nf; f < NfNew; ++f) tmpexactSol[f] = NULL; 60095cbbfd3SMatthew G. Knepley for (f = Nf; f < NfNew; ++f) tmpexactCtx[f] = NULL; 601f2cacb80SMatthew G. Knepley for (f = Nf; f < NfNew; ++f) tmpexactSol_t[f] = NULL; 602f2cacb80SMatthew G. Knepley for (f = Nf; f < NfNew; ++f) tmpexactCtx_t[f] = NULL; 6039566063dSJacob Faibussowitsch PetscCall(PetscFree4(prob->exactSol, prob->exactCtx, prob->exactSol_t, prob->exactCtx_t)); 604c371a6d1SMatthew G. Knepley prob->exactSol = tmpexactSol; 60595cbbfd3SMatthew G. Knepley prob->exactCtx = tmpexactCtx; 606f2cacb80SMatthew G. Knepley prob->exactSol_t = tmpexactSol_t; 607f2cacb80SMatthew G. Knepley prob->exactCtx_t = tmpexactCtx_t; 6083ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 6092764a2aaSMatthew G. Knepley } 6102764a2aaSMatthew G. Knepley 6112764a2aaSMatthew G. Knepley /*@ 61220f4b53cSBarry Smith PetscDSDestroy - Destroys a `PetscDS` object 6132764a2aaSMatthew G. Knepley 61420f4b53cSBarry Smith Collective 6152764a2aaSMatthew G. Knepley 6162764a2aaSMatthew G. Knepley Input Parameter: 61760225df5SJacob Faibussowitsch . ds - the `PetscDS` object to destroy 6182764a2aaSMatthew G. Knepley 6192764a2aaSMatthew G. Knepley Level: developer 6202764a2aaSMatthew G. Knepley 621dce8aebaSBarry Smith .seealso: `PetscDSView()` 6222764a2aaSMatthew G. Knepley @*/ 623d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSDestroy(PetscDS *ds) 624d71ae5a4SJacob Faibussowitsch { 6252764a2aaSMatthew G. Knepley PetscInt f; 6262764a2aaSMatthew G. Knepley 6272764a2aaSMatthew G. Knepley PetscFunctionBegin; 6283ba16761SJacob Faibussowitsch if (!*ds) PetscFunctionReturn(PETSC_SUCCESS); 629f4f49eeaSPierre Jolivet PetscValidHeaderSpecific(*ds, PETSCDS_CLASSID, 1); 6302764a2aaSMatthew G. Knepley 631f4f49eeaSPierre Jolivet if (--((PetscObject)*ds)->refct > 0) { 6329371c9d4SSatish Balay *ds = NULL; 6333ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 6349371c9d4SSatish Balay } 635f4f49eeaSPierre Jolivet ((PetscObject)*ds)->refct = 0; 6366528b96dSMatthew G. Knepley if ((*ds)->subprobs) { 637df3a45bdSMatthew G. Knepley PetscInt dim, d; 638df3a45bdSMatthew G. Knepley 6399566063dSJacob Faibussowitsch PetscCall(PetscDSGetSpatialDimension(*ds, &dim)); 6409566063dSJacob Faibussowitsch for (d = 0; d < dim; ++d) PetscCall(PetscDSDestroy(&(*ds)->subprobs[d])); 641df3a45bdSMatthew G. Knepley } 6429566063dSJacob Faibussowitsch PetscCall(PetscFree((*ds)->subprobs)); 6439566063dSJacob Faibussowitsch PetscCall(PetscDSDestroyStructs_Static(*ds)); 64448a46eb9SPierre Jolivet for (f = 0; f < (*ds)->Nf; ++f) PetscCall(PetscObjectDereference((*ds)->disc[f])); 6459566063dSJacob Faibussowitsch PetscCall(PetscFree4((*ds)->disc, (*ds)->implicit, (*ds)->cohesive, (*ds)->jetDegree)); 6469566063dSJacob Faibussowitsch PetscCall(PetscWeakFormDestroy(&(*ds)->wf)); 6479566063dSJacob Faibussowitsch PetscCall(PetscFree2((*ds)->update, (*ds)->ctx)); 6489566063dSJacob Faibussowitsch PetscCall(PetscFree4((*ds)->exactSol, (*ds)->exactCtx, (*ds)->exactSol_t, (*ds)->exactCtx_t)); 649f4f49eeaSPierre Jolivet PetscTryTypeMethod(*ds, destroy); 6509566063dSJacob Faibussowitsch PetscCall(PetscDSDestroyBoundary(*ds)); 6519566063dSJacob Faibussowitsch PetscCall(PetscFree((*ds)->constants)); 6524366bac7SMatthew G. Knepley for (PetscInt c = 0; c < DM_NUM_POLYTOPES; ++c) { 65385036b15SMatthew G. Knepley const PetscInt Na = DMPolytopeTypeGetNumArrangements((DMPolytopeType)c); 6544366bac7SMatthew G. Knepley if ((*ds)->quadPerm[c]) 6554366bac7SMatthew G. Knepley for (PetscInt o = 0; o < Na; ++o) PetscCall(ISDestroy(&(*ds)->quadPerm[c][o])); 6564366bac7SMatthew G. Knepley PetscCall(PetscFree((*ds)->quadPerm[c])); 6574366bac7SMatthew G. Knepley (*ds)->quadPerm[c] = NULL; 6584366bac7SMatthew G. Knepley } 6599566063dSJacob Faibussowitsch PetscCall(PetscHeaderDestroy(ds)); 6603ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 6612764a2aaSMatthew G. Knepley } 6622764a2aaSMatthew G. Knepley 6632764a2aaSMatthew G. Knepley /*@ 664dce8aebaSBarry Smith PetscDSCreate - Creates an empty `PetscDS` object. The type can then be set with `PetscDSSetType()`. 6652764a2aaSMatthew G. Knepley 666d083f849SBarry Smith Collective 6672764a2aaSMatthew G. Knepley 6682764a2aaSMatthew G. Knepley Input Parameter: 669dce8aebaSBarry Smith . comm - The communicator for the `PetscDS` object 6702764a2aaSMatthew G. Knepley 6712764a2aaSMatthew G. Knepley Output Parameter: 672dce8aebaSBarry Smith . ds - The `PetscDS` object 6732764a2aaSMatthew G. Knepley 6742764a2aaSMatthew G. Knepley Level: beginner 6752764a2aaSMatthew G. Knepley 676dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSSetType()`, `PETSCDSBASIC`, `PetscDSType` 6772764a2aaSMatthew G. Knepley @*/ 678d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSCreate(MPI_Comm comm, PetscDS *ds) 679d71ae5a4SJacob Faibussowitsch { 6802764a2aaSMatthew G. Knepley PetscDS p; 6812764a2aaSMatthew G. Knepley 6822764a2aaSMatthew G. Knepley PetscFunctionBegin; 6834f572ea9SToby Isaac PetscAssertPointer(ds, 2); 6849566063dSJacob Faibussowitsch PetscCall(PetscDSInitializePackage()); 6852764a2aaSMatthew G. Knepley 6869566063dSJacob Faibussowitsch PetscCall(PetscHeaderCreate(p, PETSCDS_CLASSID, "PetscDS", "Discrete System", "PetscDS", comm, PetscDSDestroy, PetscDSView)); 6872764a2aaSMatthew G. Knepley p->Nf = 0; 6882764a2aaSMatthew G. Knepley p->setup = PETSC_FALSE; 68997b6e6e8SMatthew G. Knepley p->numConstants = 0; 690*a102dd69SStefano Zampini p->numFuncConstants = 2; // Row and col fields 691a859676bSMatthew G. Knepley p->dimEmbed = -1; 69255c1f793SMatthew G. Knepley p->useJacPre = PETSC_TRUE; 69312fc5b22SMatthew G. Knepley p->forceQuad = PETSC_TRUE; 694*a102dd69SStefano Zampini PetscCall(PetscMalloc1(p->numConstants + p->numFuncConstants, &p->constants)); 6959566063dSJacob Faibussowitsch PetscCall(PetscWeakFormCreate(comm, &p->wf)); 6964366bac7SMatthew G. Knepley PetscCall(PetscArrayzero(p->quadPerm, DM_NUM_POLYTOPES)); 6976528b96dSMatthew G. Knepley *ds = p; 6983ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 6992764a2aaSMatthew G. Knepley } 7002764a2aaSMatthew G. Knepley 701bc4ae4beSMatthew G. Knepley /*@ 702dce8aebaSBarry Smith PetscDSGetNumFields - Returns the number of fields in the `PetscDS` 703bc4ae4beSMatthew G. Knepley 70420f4b53cSBarry Smith Not Collective 705bc4ae4beSMatthew G. Knepley 706bc4ae4beSMatthew G. Knepley Input Parameter: 70720f4b53cSBarry Smith . prob - The `PetscDS` object 708bc4ae4beSMatthew G. Knepley 709bc4ae4beSMatthew G. Knepley Output Parameter: 710bc4ae4beSMatthew G. Knepley . Nf - The number of fields 711bc4ae4beSMatthew G. Knepley 712bc4ae4beSMatthew G. Knepley Level: beginner 713bc4ae4beSMatthew G. Knepley 714dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSGetSpatialDimension()`, `PetscDSCreate()` 715bc4ae4beSMatthew G. Knepley @*/ 716d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSGetNumFields(PetscDS prob, PetscInt *Nf) 717d71ae5a4SJacob Faibussowitsch { 7182764a2aaSMatthew G. Knepley PetscFunctionBegin; 7192764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 7204f572ea9SToby Isaac PetscAssertPointer(Nf, 2); 7212764a2aaSMatthew G. Knepley *Nf = prob->Nf; 7223ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 7232764a2aaSMatthew G. Knepley } 7242764a2aaSMatthew G. Knepley 725bc4ae4beSMatthew G. Knepley /*@ 726dce8aebaSBarry Smith PetscDSGetSpatialDimension - Returns the spatial dimension of the `PetscDS`, meaning the topological dimension of the discretizations 727bc4ae4beSMatthew G. Knepley 72820f4b53cSBarry Smith Not Collective 729bc4ae4beSMatthew G. Knepley 730bc4ae4beSMatthew G. Knepley Input Parameter: 731dce8aebaSBarry Smith . prob - The `PetscDS` object 732bc4ae4beSMatthew G. Knepley 733bc4ae4beSMatthew G. Knepley Output Parameter: 734bc4ae4beSMatthew G. Knepley . dim - The spatial dimension 735bc4ae4beSMatthew G. Knepley 736bc4ae4beSMatthew G. Knepley Level: beginner 737bc4ae4beSMatthew G. Knepley 738dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSGetCoordinateDimension()`, `PetscDSGetNumFields()`, `PetscDSCreate()` 739bc4ae4beSMatthew G. Knepley @*/ 740d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSGetSpatialDimension(PetscDS prob, PetscInt *dim) 741d71ae5a4SJacob Faibussowitsch { 7422764a2aaSMatthew G. Knepley PetscFunctionBegin; 7432764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 7444f572ea9SToby Isaac PetscAssertPointer(dim, 2); 7452764a2aaSMatthew G. Knepley *dim = 0; 7469de99aefSMatthew G. Knepley if (prob->Nf) { 7479de99aefSMatthew G. Knepley PetscObject obj; 7489de99aefSMatthew G. Knepley PetscClassId id; 7499de99aefSMatthew G. Knepley 7509566063dSJacob Faibussowitsch PetscCall(PetscDSGetDiscretization(prob, 0, &obj)); 751665f567fSMatthew G. Knepley if (obj) { 7529566063dSJacob Faibussowitsch PetscCall(PetscObjectGetClassId(obj, &id)); 7539566063dSJacob Faibussowitsch if (id == PETSCFE_CLASSID) PetscCall(PetscFEGetSpatialDimension((PetscFE)obj, dim)); 7549566063dSJacob Faibussowitsch else if (id == PETSCFV_CLASSID) PetscCall(PetscFVGetSpatialDimension((PetscFV)obj, dim)); 75598921bdaSJacob Faibussowitsch else SETERRQ(PetscObjectComm((PetscObject)prob), PETSC_ERR_ARG_WRONG, "Unknown discretization type for field %d", 0); 7569de99aefSMatthew G. Knepley } 757665f567fSMatthew G. Knepley } 7583ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 7592764a2aaSMatthew G. Knepley } 7602764a2aaSMatthew G. Knepley 761bc4ae4beSMatthew G. Knepley /*@ 762dce8aebaSBarry Smith PetscDSGetCoordinateDimension - Returns the coordinate dimension of the `PetscDS`, meaning the dimension of the space into which the discretiaztions are embedded 763a859676bSMatthew G. Knepley 76420f4b53cSBarry Smith Not Collective 765a859676bSMatthew G. Knepley 766a859676bSMatthew G. Knepley Input Parameter: 767dce8aebaSBarry Smith . prob - The `PetscDS` object 768a859676bSMatthew G. Knepley 769a859676bSMatthew G. Knepley Output Parameter: 770a859676bSMatthew G. Knepley . dimEmbed - The coordinate dimension 771a859676bSMatthew G. Knepley 772a859676bSMatthew G. Knepley Level: beginner 773a859676bSMatthew G. Knepley 774dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSSetCoordinateDimension()`, `PetscDSGetSpatialDimension()`, `PetscDSGetNumFields()`, `PetscDSCreate()` 775a859676bSMatthew G. Knepley @*/ 776d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSGetCoordinateDimension(PetscDS prob, PetscInt *dimEmbed) 777d71ae5a4SJacob Faibussowitsch { 778a859676bSMatthew G. Knepley PetscFunctionBegin; 779a859676bSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 7804f572ea9SToby Isaac PetscAssertPointer(dimEmbed, 2); 78108401ef6SPierre Jolivet PetscCheck(prob->dimEmbed >= 0, PetscObjectComm((PetscObject)prob), PETSC_ERR_ARG_WRONGSTATE, "No coordinate dimension set for this DS"); 782a859676bSMatthew G. Knepley *dimEmbed = prob->dimEmbed; 7833ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 784a859676bSMatthew G. Knepley } 785a859676bSMatthew G. Knepley 786a859676bSMatthew G. Knepley /*@ 787dce8aebaSBarry Smith PetscDSSetCoordinateDimension - Set the coordinate dimension of the `PetscDS`, meaning the dimension of the space into which the discretiaztions are embedded 788a859676bSMatthew G. Knepley 78920f4b53cSBarry Smith Logically Collective 790a859676bSMatthew G. Knepley 791a859676bSMatthew G. Knepley Input Parameters: 792dce8aebaSBarry Smith + prob - The `PetscDS` object 793a859676bSMatthew G. Knepley - dimEmbed - The coordinate dimension 794a859676bSMatthew G. Knepley 795a859676bSMatthew G. Knepley Level: beginner 796a859676bSMatthew G. Knepley 797dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSGetCoordinateDimension()`, `PetscDSGetSpatialDimension()`, `PetscDSGetNumFields()`, `PetscDSCreate()` 798a859676bSMatthew G. Knepley @*/ 799d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSSetCoordinateDimension(PetscDS prob, PetscInt dimEmbed) 800d71ae5a4SJacob Faibussowitsch { 801a859676bSMatthew G. Knepley PetscFunctionBegin; 802a859676bSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 80363a3b9bcSJacob Faibussowitsch PetscCheck(dimEmbed >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Coordinate dimension must be non-negative, not %" PetscInt_FMT, dimEmbed); 804a859676bSMatthew G. Knepley prob->dimEmbed = dimEmbed; 8053ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 806a859676bSMatthew G. Knepley } 807a859676bSMatthew G. Knepley 808a859676bSMatthew G. Knepley /*@ 80912fc5b22SMatthew G. Knepley PetscDSGetForceQuad - Returns the flag to force matching quadratures among the field discretizations 81012fc5b22SMatthew G. Knepley 81112fc5b22SMatthew G. Knepley Not collective 81212fc5b22SMatthew G. Knepley 81312fc5b22SMatthew G. Knepley Input Parameter: 81460225df5SJacob Faibussowitsch . ds - The `PetscDS` object 81512fc5b22SMatthew G. Knepley 81612fc5b22SMatthew G. Knepley Output Parameter: 81712fc5b22SMatthew G. Knepley . forceQuad - The flag 81812fc5b22SMatthew G. Knepley 81912fc5b22SMatthew G. Knepley Level: intermediate 82012fc5b22SMatthew G. Knepley 82112fc5b22SMatthew G. Knepley .seealso: `PetscDS`, `PetscDSSetForceQuad()`, `PetscDSGetDiscretization()`, `PetscDSGetNumFields()`, `PetscDSCreate()` 82212fc5b22SMatthew G. Knepley @*/ 82312fc5b22SMatthew G. Knepley PetscErrorCode PetscDSGetForceQuad(PetscDS ds, PetscBool *forceQuad) 82412fc5b22SMatthew G. Knepley { 82512fc5b22SMatthew G. Knepley PetscFunctionBegin; 82612fc5b22SMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 8274f572ea9SToby Isaac PetscAssertPointer(forceQuad, 2); 82812fc5b22SMatthew G. Knepley *forceQuad = ds->forceQuad; 82912fc5b22SMatthew G. Knepley PetscFunctionReturn(PETSC_SUCCESS); 83012fc5b22SMatthew G. Knepley } 83112fc5b22SMatthew G. Knepley 83212fc5b22SMatthew G. Knepley /*@ 83312fc5b22SMatthew G. Knepley PetscDSSetForceQuad - Set the flag to force matching quadratures among the field discretizations 83412fc5b22SMatthew G. Knepley 83512fc5b22SMatthew G. Knepley Logically collective on ds 83612fc5b22SMatthew G. Knepley 83712fc5b22SMatthew G. Knepley Input Parameters: 83812fc5b22SMatthew G. Knepley + ds - The `PetscDS` object 83912fc5b22SMatthew G. Knepley - forceQuad - The flag 84012fc5b22SMatthew G. Knepley 84112fc5b22SMatthew G. Knepley Level: intermediate 84212fc5b22SMatthew G. Knepley 84312fc5b22SMatthew G. Knepley .seealso: `PetscDS`, `PetscDSGetForceQuad()`, `PetscDSGetDiscretization()`, `PetscDSGetNumFields()`, `PetscDSCreate()` 84412fc5b22SMatthew G. Knepley @*/ 84512fc5b22SMatthew G. Knepley PetscErrorCode PetscDSSetForceQuad(PetscDS ds, PetscBool forceQuad) 84612fc5b22SMatthew G. Knepley { 84712fc5b22SMatthew G. Knepley PetscFunctionBegin; 84812fc5b22SMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 84912fc5b22SMatthew G. Knepley ds->forceQuad = forceQuad; 85012fc5b22SMatthew G. Knepley PetscFunctionReturn(PETSC_SUCCESS); 85112fc5b22SMatthew G. Knepley } 85212fc5b22SMatthew G. Knepley 85312fc5b22SMatthew G. Knepley /*@ 854dce8aebaSBarry Smith PetscDSIsCohesive - Returns the flag indicating that this `PetscDS` is for a cohesive cell 8558edf6225SMatthew G. Knepley 85620f4b53cSBarry Smith Not Collective 8578edf6225SMatthew G. Knepley 8588edf6225SMatthew G. Knepley Input Parameter: 859dce8aebaSBarry Smith . ds - The `PetscDS` object 8608edf6225SMatthew G. Knepley 8618edf6225SMatthew G. Knepley Output Parameter: 8625fedec97SMatthew G. Knepley . isCohesive - The flag 8638edf6225SMatthew G. Knepley 8648edf6225SMatthew G. Knepley Level: developer 8658edf6225SMatthew G. Knepley 866dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSGetNumCohesive()`, `PetscDSGetCohesive()`, `PetscDSSetCohesive()`, `PetscDSCreate()` 8678edf6225SMatthew G. Knepley @*/ 868d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSIsCohesive(PetscDS ds, PetscBool *isCohesive) 869d71ae5a4SJacob Faibussowitsch { 8708edf6225SMatthew G. Knepley PetscFunctionBegin; 8715fedec97SMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 8724f572ea9SToby Isaac PetscAssertPointer(isCohesive, 2); 8735fedec97SMatthew G. Knepley *isCohesive = ds->isCohesive; 8743ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 8758edf6225SMatthew G. Knepley } 8768edf6225SMatthew G. Knepley 8778edf6225SMatthew G. Knepley /*@ 878be87f6c0SPierre Jolivet PetscDSGetNumCohesive - Returns the number of cohesive fields, meaning those defined on the interior of a cohesive cell 8795fedec97SMatthew G. Knepley 88020f4b53cSBarry Smith Not Collective 8815fedec97SMatthew G. Knepley 8825fedec97SMatthew G. Knepley Input Parameter: 883dce8aebaSBarry Smith . ds - The `PetscDS` object 8845fedec97SMatthew G. Knepley 8855fedec97SMatthew G. Knepley Output Parameter: 8865fedec97SMatthew G. Knepley . numCohesive - The number of cohesive fields 8875fedec97SMatthew G. Knepley 8885fedec97SMatthew G. Knepley Level: developer 8895fedec97SMatthew G. Knepley 890dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSSetCohesive()`, `PetscDSCreate()` 8915fedec97SMatthew G. Knepley @*/ 892d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSGetNumCohesive(PetscDS ds, PetscInt *numCohesive) 893d71ae5a4SJacob Faibussowitsch { 8945fedec97SMatthew G. Knepley PetscInt f; 8955fedec97SMatthew G. Knepley 8965fedec97SMatthew G. Knepley PetscFunctionBegin; 8975fedec97SMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 8984f572ea9SToby Isaac PetscAssertPointer(numCohesive, 2); 8995fedec97SMatthew G. Knepley *numCohesive = 0; 9005fedec97SMatthew G. Knepley for (f = 0; f < ds->Nf; ++f) *numCohesive += ds->cohesive[f] ? 1 : 0; 9013ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 9025fedec97SMatthew G. Knepley } 9035fedec97SMatthew G. Knepley 9045fedec97SMatthew G. Knepley /*@ 9055fedec97SMatthew G. Knepley PetscDSGetCohesive - Returns the flag indicating that a field is cohesive, meaning it is defined on the interior of a cohesive cell 9065fedec97SMatthew G. Knepley 90720f4b53cSBarry Smith Not Collective 9085fedec97SMatthew G. Knepley 909f1a722f8SMatthew G. Knepley Input Parameters: 910dce8aebaSBarry Smith + ds - The `PetscDS` object 9115fedec97SMatthew G. Knepley - f - The field index 9125fedec97SMatthew G. Knepley 9135fedec97SMatthew G. Knepley Output Parameter: 9145fedec97SMatthew G. Knepley . isCohesive - The flag 9155fedec97SMatthew G. Knepley 9165fedec97SMatthew G. Knepley Level: developer 9175fedec97SMatthew G. Knepley 918dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSSetCohesive()`, `PetscDSIsCohesive()`, `PetscDSCreate()` 9195fedec97SMatthew G. Knepley @*/ 920d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSGetCohesive(PetscDS ds, PetscInt f, PetscBool *isCohesive) 921d71ae5a4SJacob Faibussowitsch { 9225fedec97SMatthew G. Knepley PetscFunctionBegin; 9235fedec97SMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 9244f572ea9SToby Isaac PetscAssertPointer(isCohesive, 3); 92563a3b9bcSJacob Faibussowitsch PetscCheck(!(f < 0) && !(f >= ds->Nf), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be in [0, %" PetscInt_FMT ")", f, ds->Nf); 9265fedec97SMatthew G. Knepley *isCohesive = ds->cohesive[f]; 9273ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 9285fedec97SMatthew G. Knepley } 9295fedec97SMatthew G. Knepley 9305fedec97SMatthew G. Knepley /*@ 9315fedec97SMatthew G. Knepley PetscDSSetCohesive - Set the flag indicating that a field is cohesive, meaning it is defined on the interior of a cohesive cell 9328edf6225SMatthew G. Knepley 93320f4b53cSBarry Smith Not Collective 9348edf6225SMatthew G. Knepley 9358edf6225SMatthew G. Knepley Input Parameters: 936dce8aebaSBarry Smith + ds - The `PetscDS` object 9375fedec97SMatthew G. Knepley . f - The field index 9385fedec97SMatthew G. Knepley - isCohesive - The flag for a cohesive field 9398edf6225SMatthew G. Knepley 9408edf6225SMatthew G. Knepley Level: developer 9418edf6225SMatthew G. Knepley 942dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSGetCohesive()`, `PetscDSIsCohesive()`, `PetscDSCreate()` 9438edf6225SMatthew G. Knepley @*/ 944d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSSetCohesive(PetscDS ds, PetscInt f, PetscBool isCohesive) 945d71ae5a4SJacob Faibussowitsch { 9465fedec97SMatthew G. Knepley PetscInt i; 9475fedec97SMatthew G. Knepley 9488edf6225SMatthew G. Knepley PetscFunctionBegin; 9495fedec97SMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 95063a3b9bcSJacob Faibussowitsch PetscCheck(!(f < 0) && !(f >= ds->Nf), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be in [0, %" PetscInt_FMT ")", f, ds->Nf); 9515fedec97SMatthew G. Knepley ds->cohesive[f] = isCohesive; 9525fedec97SMatthew G. Knepley ds->isCohesive = PETSC_FALSE; 9535fedec97SMatthew G. Knepley for (i = 0; i < ds->Nf; ++i) ds->isCohesive = ds->isCohesive || ds->cohesive[f] ? PETSC_TRUE : PETSC_FALSE; 9543ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 9558edf6225SMatthew G. Knepley } 9568edf6225SMatthew G. Knepley 9578edf6225SMatthew G. Knepley /*@ 958bc4ae4beSMatthew G. Knepley PetscDSGetTotalDimension - Returns the total size of the approximation space for this system 959bc4ae4beSMatthew G. Knepley 96020f4b53cSBarry Smith Not Collective 961bc4ae4beSMatthew G. Knepley 962bc4ae4beSMatthew G. Knepley Input Parameter: 963dce8aebaSBarry Smith . prob - The `PetscDS` object 964bc4ae4beSMatthew G. Knepley 965bc4ae4beSMatthew G. Knepley Output Parameter: 966bc4ae4beSMatthew G. Knepley . dim - The total problem dimension 967bc4ae4beSMatthew G. Knepley 968bc4ae4beSMatthew G. Knepley Level: beginner 969bc4ae4beSMatthew G. Knepley 970dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSGetNumFields()`, `PetscDSCreate()` 971bc4ae4beSMatthew G. Knepley @*/ 972d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSGetTotalDimension(PetscDS prob, PetscInt *dim) 973d71ae5a4SJacob Faibussowitsch { 9742764a2aaSMatthew G. Knepley PetscFunctionBegin; 9752764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 9769566063dSJacob Faibussowitsch PetscCall(PetscDSSetUp(prob)); 9774f572ea9SToby Isaac PetscAssertPointer(dim, 2); 9782764a2aaSMatthew G. Knepley *dim = prob->totDim; 9793ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 9802764a2aaSMatthew G. Knepley } 9812764a2aaSMatthew G. Knepley 982bc4ae4beSMatthew G. Knepley /*@ 983bc4ae4beSMatthew G. Knepley PetscDSGetTotalComponents - Returns the total number of components in this system 984bc4ae4beSMatthew G. Knepley 98520f4b53cSBarry Smith Not Collective 986bc4ae4beSMatthew G. Knepley 987bc4ae4beSMatthew G. Knepley Input Parameter: 988dce8aebaSBarry Smith . prob - The `PetscDS` object 989bc4ae4beSMatthew G. Knepley 990bc4ae4beSMatthew G. Knepley Output Parameter: 99160225df5SJacob Faibussowitsch . Nc - The total number of components 992bc4ae4beSMatthew G. Knepley 993bc4ae4beSMatthew G. Knepley Level: beginner 994bc4ae4beSMatthew G. Knepley 995dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSGetNumFields()`, `PetscDSCreate()` 996bc4ae4beSMatthew G. Knepley @*/ 997d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSGetTotalComponents(PetscDS prob, PetscInt *Nc) 998d71ae5a4SJacob Faibussowitsch { 9992764a2aaSMatthew G. Knepley PetscFunctionBegin; 10002764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 10019566063dSJacob Faibussowitsch PetscCall(PetscDSSetUp(prob)); 10024f572ea9SToby Isaac PetscAssertPointer(Nc, 2); 10032764a2aaSMatthew G. Knepley *Nc = prob->totComp; 10043ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 10052764a2aaSMatthew G. Knepley } 10062764a2aaSMatthew G. Knepley 1007bc4ae4beSMatthew G. Knepley /*@ 1008bc4ae4beSMatthew G. Knepley PetscDSGetDiscretization - Returns the discretization object for the given field 1009bc4ae4beSMatthew G. Knepley 101020f4b53cSBarry Smith Not Collective 1011bc4ae4beSMatthew G. Knepley 1012bc4ae4beSMatthew G. Knepley Input Parameters: 1013dce8aebaSBarry Smith + prob - The `PetscDS` object 1014bc4ae4beSMatthew G. Knepley - f - The field number 1015bc4ae4beSMatthew G. Knepley 1016bc4ae4beSMatthew G. Knepley Output Parameter: 1017bc4ae4beSMatthew G. Knepley . disc - The discretization object 1018bc4ae4beSMatthew G. Knepley 1019bc4ae4beSMatthew G. Knepley Level: beginner 1020bc4ae4beSMatthew G. Knepley 1021dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscFE`, `PetscFV`, `PetscDSSetDiscretization()`, `PetscDSAddDiscretization()`, `PetscDSGetNumFields()`, `PetscDSCreate()` 1022bc4ae4beSMatthew G. Knepley @*/ 1023d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSGetDiscretization(PetscDS prob, PetscInt f, PetscObject *disc) 1024d71ae5a4SJacob Faibussowitsch { 10256528b96dSMatthew G. Knepley PetscFunctionBeginHot; 10262764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 10274f572ea9SToby Isaac PetscAssertPointer(disc, 3); 102863a3b9bcSJacob Faibussowitsch PetscCheck(!(f < 0) && !(f >= prob->Nf), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be in [0, %" PetscInt_FMT ")", f, prob->Nf); 10292764a2aaSMatthew G. Knepley *disc = prob->disc[f]; 10303ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 10312764a2aaSMatthew G. Knepley } 10322764a2aaSMatthew G. Knepley 1033bc4ae4beSMatthew G. Knepley /*@ 1034bc4ae4beSMatthew G. Knepley PetscDSSetDiscretization - Sets the discretization object for the given field 1035bc4ae4beSMatthew G. Knepley 103620f4b53cSBarry Smith Not Collective 1037bc4ae4beSMatthew G. Knepley 1038bc4ae4beSMatthew G. Knepley Input Parameters: 1039dce8aebaSBarry Smith + prob - The `PetscDS` object 1040bc4ae4beSMatthew G. Knepley . f - The field number 1041bc4ae4beSMatthew G. Knepley - disc - The discretization object 1042bc4ae4beSMatthew G. Knepley 1043bc4ae4beSMatthew G. Knepley Level: beginner 1044bc4ae4beSMatthew G. Knepley 1045dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscFE`, `PetscFV`, `PetscDSGetDiscretization()`, `PetscDSAddDiscretization()`, `PetscDSGetNumFields()`, `PetscDSCreate()` 1046bc4ae4beSMatthew G. Knepley @*/ 1047d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSSetDiscretization(PetscDS prob, PetscInt f, PetscObject disc) 1048d71ae5a4SJacob Faibussowitsch { 10492764a2aaSMatthew G. Knepley PetscFunctionBegin; 10502764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 10514f572ea9SToby Isaac if (disc) PetscAssertPointer(disc, 3); 105263a3b9bcSJacob Faibussowitsch PetscCheck(f >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be non-negative", f); 10539566063dSJacob Faibussowitsch PetscCall(PetscDSEnlarge_Static(prob, f + 1)); 10549566063dSJacob Faibussowitsch PetscCall(PetscObjectDereference(prob->disc[f])); 10552764a2aaSMatthew G. Knepley prob->disc[f] = disc; 10569566063dSJacob Faibussowitsch PetscCall(PetscObjectReference(disc)); 1057665f567fSMatthew G. Knepley if (disc) { 1058249df284SMatthew G. Knepley PetscClassId id; 1059249df284SMatthew G. Knepley 10609566063dSJacob Faibussowitsch PetscCall(PetscObjectGetClassId(disc, &id)); 10611cf84007SMatthew G. Knepley if (id == PETSCFE_CLASSID) { 10629566063dSJacob Faibussowitsch PetscCall(PetscDSSetImplicit(prob, f, PETSC_TRUE)); 10631cf84007SMatthew G. Knepley } else if (id == PETSCFV_CLASSID) { 10649566063dSJacob Faibussowitsch PetscCall(PetscDSSetImplicit(prob, f, PETSC_FALSE)); 1065a6cbbb48SMatthew G. Knepley } 10669566063dSJacob Faibussowitsch PetscCall(PetscDSSetJetDegree(prob, f, 1)); 1067249df284SMatthew G. Knepley } 10683ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 10692764a2aaSMatthew G. Knepley } 10702764a2aaSMatthew G. Knepley 1071bc4ae4beSMatthew G. Knepley /*@ 10726528b96dSMatthew G. Knepley PetscDSGetWeakForm - Returns the weak form object 10736528b96dSMatthew G. Knepley 107420f4b53cSBarry Smith Not Collective 10756528b96dSMatthew G. Knepley 10766528b96dSMatthew G. Knepley Input Parameter: 1077dce8aebaSBarry Smith . ds - The `PetscDS` object 10786528b96dSMatthew G. Knepley 10796528b96dSMatthew G. Knepley Output Parameter: 10806528b96dSMatthew G. Knepley . wf - The weak form object 10816528b96dSMatthew G. Knepley 10826528b96dSMatthew G. Knepley Level: beginner 10836528b96dSMatthew G. Knepley 1084dce8aebaSBarry Smith .seealso: `PetscWeakForm`, `PetscDSSetWeakForm()`, `PetscDSGetNumFields()`, `PetscDSCreate()` 10856528b96dSMatthew G. Knepley @*/ 1086d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSGetWeakForm(PetscDS ds, PetscWeakForm *wf) 1087d71ae5a4SJacob Faibussowitsch { 10886528b96dSMatthew G. Knepley PetscFunctionBegin; 10896528b96dSMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 10904f572ea9SToby Isaac PetscAssertPointer(wf, 2); 10916528b96dSMatthew G. Knepley *wf = ds->wf; 10923ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 10936528b96dSMatthew G. Knepley } 10946528b96dSMatthew G. Knepley 10956528b96dSMatthew G. Knepley /*@ 10966528b96dSMatthew G. Knepley PetscDSSetWeakForm - Sets the weak form object 10976528b96dSMatthew G. Knepley 109820f4b53cSBarry Smith Not Collective 10996528b96dSMatthew G. Knepley 11006528b96dSMatthew G. Knepley Input Parameters: 1101dce8aebaSBarry Smith + ds - The `PetscDS` object 11026528b96dSMatthew G. Knepley - wf - The weak form object 11036528b96dSMatthew G. Knepley 11046528b96dSMatthew G. Knepley Level: beginner 11056528b96dSMatthew G. Knepley 1106dce8aebaSBarry Smith .seealso: `PetscWeakForm`, `PetscDSGetWeakForm()`, `PetscDSGetNumFields()`, `PetscDSCreate()` 11076528b96dSMatthew G. Knepley @*/ 1108d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSSetWeakForm(PetscDS ds, PetscWeakForm wf) 1109d71ae5a4SJacob Faibussowitsch { 11106528b96dSMatthew G. Knepley PetscFunctionBegin; 11116528b96dSMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 11126528b96dSMatthew G. Knepley PetscValidHeaderSpecific(wf, PETSCWEAKFORM_CLASSID, 2); 11139566063dSJacob Faibussowitsch PetscCall(PetscObjectDereference((PetscObject)ds->wf)); 11146528b96dSMatthew G. Knepley ds->wf = wf; 11159566063dSJacob Faibussowitsch PetscCall(PetscObjectReference((PetscObject)wf)); 11169566063dSJacob Faibussowitsch PetscCall(PetscWeakFormSetNumFields(wf, ds->Nf)); 11173ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 11186528b96dSMatthew G. Knepley } 11196528b96dSMatthew G. Knepley 11206528b96dSMatthew G. Knepley /*@ 1121bc4ae4beSMatthew G. Knepley PetscDSAddDiscretization - Adds a discretization object 1122bc4ae4beSMatthew G. Knepley 112320f4b53cSBarry Smith Not Collective 1124bc4ae4beSMatthew G. Knepley 1125bc4ae4beSMatthew G. Knepley Input Parameters: 1126dce8aebaSBarry Smith + prob - The `PetscDS` object 1127bc4ae4beSMatthew G. Knepley - disc - The boundary discretization object 1128bc4ae4beSMatthew G. Knepley 1129bc4ae4beSMatthew G. Knepley Level: beginner 1130bc4ae4beSMatthew G. Knepley 1131dce8aebaSBarry Smith .seealso: `PetscWeakForm`, `PetscDSGetDiscretization()`, `PetscDSSetDiscretization()`, `PetscDSGetNumFields()`, `PetscDSCreate()` 1132bc4ae4beSMatthew G. Knepley @*/ 1133d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSAddDiscretization(PetscDS prob, PetscObject disc) 1134d71ae5a4SJacob Faibussowitsch { 11352764a2aaSMatthew G. Knepley PetscFunctionBegin; 11369566063dSJacob Faibussowitsch PetscCall(PetscDSSetDiscretization(prob, prob->Nf, disc)); 11373ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 11382764a2aaSMatthew G. Knepley } 11392764a2aaSMatthew G. Knepley 1140249df284SMatthew G. Knepley /*@ 1141dce8aebaSBarry Smith PetscDSGetQuadrature - Returns the quadrature, which must agree for all fields in the `PetscDS` 1142083401c6SMatthew G. Knepley 114320f4b53cSBarry Smith Not Collective 1144083401c6SMatthew G. Knepley 1145083401c6SMatthew G. Knepley Input Parameter: 1146dce8aebaSBarry Smith . prob - The `PetscDS` object 1147083401c6SMatthew G. Knepley 1148083401c6SMatthew G. Knepley Output Parameter: 1149083401c6SMatthew G. Knepley . q - The quadrature object 1150083401c6SMatthew G. Knepley 1151083401c6SMatthew G. Knepley Level: intermediate 1152083401c6SMatthew G. Knepley 1153dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscQuadrature`, `PetscDSSetImplicit()`, `PetscDSSetDiscretization()`, `PetscDSAddDiscretization()`, `PetscDSGetNumFields()`, `PetscDSCreate()` 1154083401c6SMatthew G. Knepley @*/ 1155d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSGetQuadrature(PetscDS prob, PetscQuadrature *q) 1156d71ae5a4SJacob Faibussowitsch { 1157083401c6SMatthew G. Knepley PetscObject obj; 1158083401c6SMatthew G. Knepley PetscClassId id; 1159083401c6SMatthew G. Knepley 1160083401c6SMatthew G. Knepley PetscFunctionBegin; 1161083401c6SMatthew G. Knepley *q = NULL; 11623ba16761SJacob Faibussowitsch if (!prob->Nf) PetscFunctionReturn(PETSC_SUCCESS); 11639566063dSJacob Faibussowitsch PetscCall(PetscDSGetDiscretization(prob, 0, &obj)); 11649566063dSJacob Faibussowitsch PetscCall(PetscObjectGetClassId(obj, &id)); 11659566063dSJacob Faibussowitsch if (id == PETSCFE_CLASSID) PetscCall(PetscFEGetQuadrature((PetscFE)obj, q)); 11669566063dSJacob Faibussowitsch else if (id == PETSCFV_CLASSID) PetscCall(PetscFVGetQuadrature((PetscFV)obj, q)); 116798921bdaSJacob Faibussowitsch else SETERRQ(PetscObjectComm((PetscObject)prob), PETSC_ERR_ARG_WRONG, "Unknown discretization type for field %d", 0); 11683ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1169083401c6SMatthew G. Knepley } 1170083401c6SMatthew G. Knepley 1171083401c6SMatthew G. Knepley /*@ 1172dce8aebaSBarry Smith PetscDSGetImplicit - Returns the flag for implicit solve for this field. This is just a guide for `TSIMEX` 1173249df284SMatthew G. Knepley 117420f4b53cSBarry Smith Not Collective 1175249df284SMatthew G. Knepley 1176249df284SMatthew G. Knepley Input Parameters: 1177dce8aebaSBarry Smith + prob - The `PetscDS` object 1178249df284SMatthew G. Knepley - f - The field number 1179249df284SMatthew G. Knepley 1180249df284SMatthew G. Knepley Output Parameter: 1181249df284SMatthew G. Knepley . implicit - The flag indicating what kind of solve to use for this field 1182249df284SMatthew G. Knepley 1183249df284SMatthew G. Knepley Level: developer 1184249df284SMatthew G. Knepley 1185dce8aebaSBarry Smith .seealso: `TSIMEX`, `PetscDS`, `PetscDSSetImplicit()`, `PetscDSSetDiscretization()`, `PetscDSAddDiscretization()`, `PetscDSGetNumFields()`, `PetscDSCreate()` 1186249df284SMatthew G. Knepley @*/ 1187d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSGetImplicit(PetscDS prob, PetscInt f, PetscBool *implicit) 1188d71ae5a4SJacob Faibussowitsch { 1189249df284SMatthew G. Knepley PetscFunctionBegin; 1190249df284SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 11914f572ea9SToby Isaac PetscAssertPointer(implicit, 3); 119263a3b9bcSJacob Faibussowitsch PetscCheck(!(f < 0) && !(f >= prob->Nf), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be in [0, %" PetscInt_FMT ")", f, prob->Nf); 1193249df284SMatthew G. Knepley *implicit = prob->implicit[f]; 11943ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1195249df284SMatthew G. Knepley } 1196249df284SMatthew G. Knepley 1197249df284SMatthew G. Knepley /*@ 1198dce8aebaSBarry Smith PetscDSSetImplicit - Set the flag for implicit solve for this field. This is just a guide for `TSIMEX` 1199249df284SMatthew G. Knepley 120020f4b53cSBarry Smith Not Collective 1201249df284SMatthew G. Knepley 1202249df284SMatthew G. Knepley Input Parameters: 1203dce8aebaSBarry Smith + prob - The `PetscDS` object 1204249df284SMatthew G. Knepley . f - The field number 1205249df284SMatthew G. Knepley - implicit - The flag indicating what kind of solve to use for this field 1206249df284SMatthew G. Knepley 1207249df284SMatthew G. Knepley Level: developer 1208249df284SMatthew G. Knepley 1209dce8aebaSBarry Smith .seealso: `TSIMEX`, `PetscDSGetImplicit()`, `PetscDSSetDiscretization()`, `PetscDSAddDiscretization()`, `PetscDSGetNumFields()`, `PetscDSCreate()` 1210249df284SMatthew G. Knepley @*/ 1211d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSSetImplicit(PetscDS prob, PetscInt f, PetscBool implicit) 1212d71ae5a4SJacob Faibussowitsch { 1213249df284SMatthew G. Knepley PetscFunctionBegin; 1214249df284SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 121563a3b9bcSJacob Faibussowitsch PetscCheck(!(f < 0) && !(f >= prob->Nf), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be in [0, %" PetscInt_FMT ")", f, prob->Nf); 1216249df284SMatthew G. Knepley prob->implicit[f] = implicit; 12173ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1218249df284SMatthew G. Knepley } 1219249df284SMatthew G. Knepley 1220f9244615SMatthew G. Knepley /*@ 1221f9244615SMatthew G. Knepley PetscDSGetJetDegree - Returns the highest derivative for this field equation, or the k-jet that the discretization needs to tabulate. 1222f9244615SMatthew G. Knepley 122320f4b53cSBarry Smith Not Collective 1224f9244615SMatthew G. Knepley 1225f9244615SMatthew G. Knepley Input Parameters: 1226dce8aebaSBarry Smith + ds - The `PetscDS` object 1227f9244615SMatthew G. Knepley - f - The field number 1228f9244615SMatthew G. Knepley 1229f9244615SMatthew G. Knepley Output Parameter: 1230f9244615SMatthew G. Knepley . k - The highest derivative we need to tabulate 1231f9244615SMatthew G. Knepley 1232f9244615SMatthew G. Knepley Level: developer 1233f9244615SMatthew G. Knepley 1234dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSSetJetDegree()`, `PetscDSSetDiscretization()`, `PetscDSAddDiscretization()`, `PetscDSGetNumFields()`, `PetscDSCreate()` 1235f9244615SMatthew G. Knepley @*/ 1236d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSGetJetDegree(PetscDS ds, PetscInt f, PetscInt *k) 1237d71ae5a4SJacob Faibussowitsch { 1238f9244615SMatthew G. Knepley PetscFunctionBegin; 1239f9244615SMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 12404f572ea9SToby Isaac PetscAssertPointer(k, 3); 124163a3b9bcSJacob Faibussowitsch PetscCheck(!(f < 0) && !(f >= ds->Nf), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be in [0, %" PetscInt_FMT ")", f, ds->Nf); 1242f9244615SMatthew G. Knepley *k = ds->jetDegree[f]; 12433ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1244f9244615SMatthew G. Knepley } 1245f9244615SMatthew G. Knepley 1246f9244615SMatthew G. Knepley /*@ 1247f9244615SMatthew G. Knepley PetscDSSetJetDegree - Set the highest derivative for this field equation, or the k-jet that the discretization needs to tabulate. 1248f9244615SMatthew G. Knepley 124920f4b53cSBarry Smith Not Collective 1250f9244615SMatthew G. Knepley 1251f9244615SMatthew G. Knepley Input Parameters: 1252dce8aebaSBarry Smith + ds - The `PetscDS` object 1253f9244615SMatthew G. Knepley . f - The field number 1254f9244615SMatthew G. Knepley - k - The highest derivative we need to tabulate 1255f9244615SMatthew G. Knepley 1256f9244615SMatthew G. Knepley Level: developer 1257f9244615SMatthew G. Knepley 1258a94f484eSPierre Jolivet .seealso: `PetscDS`, `PetscDSGetJetDegree()`, `PetscDSSetDiscretization()`, `PetscDSAddDiscretization()`, `PetscDSGetNumFields()`, `PetscDSCreate()` 1259f9244615SMatthew G. Knepley @*/ 1260d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSSetJetDegree(PetscDS ds, PetscInt f, PetscInt k) 1261d71ae5a4SJacob Faibussowitsch { 1262f9244615SMatthew G. Knepley PetscFunctionBegin; 1263f9244615SMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 126463a3b9bcSJacob Faibussowitsch PetscCheck(!(f < 0) && !(f >= ds->Nf), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be in [0, %" PetscInt_FMT ")", f, ds->Nf); 1265f9244615SMatthew G. Knepley ds->jetDegree[f] = k; 12663ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1267f9244615SMatthew G. Knepley } 1268f9244615SMatthew G. Knepley 1269c8943706SMatthew G. Knepley /*@C 1270c8943706SMatthew G. Knepley PetscDSGetObjective - Get the pointwise objective function for a given test field 1271c8943706SMatthew G. Knepley 1272c8943706SMatthew G. Knepley Not Collective 1273c8943706SMatthew G. Knepley 1274c8943706SMatthew G. Knepley Input Parameters: 1275c8943706SMatthew G. Knepley + ds - The `PetscDS` 1276c8943706SMatthew G. Knepley - f - The test field number 1277c8943706SMatthew G. Knepley 1278a4e35b19SJacob Faibussowitsch Output Parameter: 1279c8943706SMatthew G. Knepley . obj - integrand for the test function term 1280c8943706SMatthew G. Knepley 1281c8943706SMatthew G. Knepley Calling sequence of `obj`: 1282c8943706SMatthew G. Knepley + dim - the spatial dimension 1283c8943706SMatthew G. Knepley . Nf - the number of fields 1284a4e35b19SJacob Faibussowitsch . NfAux - the number of auxiliary fields 1285c8943706SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 1286c8943706SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 1287c8943706SMatthew G. Knepley . u - each field evaluated at the current point 1288c8943706SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 1289c8943706SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 1290c8943706SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 1291c8943706SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 1292c8943706SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 1293c8943706SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 1294c8943706SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 1295c8943706SMatthew G. Knepley . t - current time 1296c8943706SMatthew G. Knepley . x - coordinates of the current point 1297c8943706SMatthew G. Knepley . numConstants - number of constant parameters 1298c8943706SMatthew G. Knepley . constants - constant parameters 1299c8943706SMatthew G. Knepley - obj - output values at the current point 1300c8943706SMatthew G. Knepley 1301c8943706SMatthew G. Knepley Level: intermediate 1302c8943706SMatthew G. Knepley 1303c8943706SMatthew G. Knepley Note: 13041d27aa22SBarry Smith We are using a first order FEM model for the weak form\: $ \int_\Omega \phi obj(u, u_t, \nabla u, x, t)$ 1305c8943706SMatthew G. Knepley 1306c8943706SMatthew G. Knepley .seealso: `PetscDS`, `PetscDSSetObjective()`, `PetscDSGetResidual()` 1307c8943706SMatthew G. Knepley @*/ 1308d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSGetObjective(PetscDS ds, PetscInt f, void (**obj)(PetscInt dim, PetscInt Nf, PetscInt NfAux, const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar obj[])) 1309d71ae5a4SJacob Faibussowitsch { 13106528b96dSMatthew G. Knepley PetscPointFunc *tmp; 13116528b96dSMatthew G. Knepley PetscInt n; 13126528b96dSMatthew G. Knepley 13132764a2aaSMatthew G. Knepley PetscFunctionBegin; 13146528b96dSMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 13154f572ea9SToby Isaac PetscAssertPointer(obj, 3); 131663a3b9bcSJacob Faibussowitsch PetscCheck(!(f < 0) && !(f >= ds->Nf), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be in [0, %" PetscInt_FMT ")", f, ds->Nf); 13179566063dSJacob Faibussowitsch PetscCall(PetscWeakFormGetObjective(ds->wf, NULL, 0, f, 0, &n, &tmp)); 13186528b96dSMatthew G. Knepley *obj = tmp ? tmp[0] : NULL; 13193ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 13202764a2aaSMatthew G. Knepley } 13212764a2aaSMatthew G. Knepley 1322c8943706SMatthew G. Knepley /*@C 1323c8943706SMatthew G. Knepley PetscDSSetObjective - Set the pointwise objective function for a given test field 1324c8943706SMatthew G. Knepley 1325c8943706SMatthew G. Knepley Not Collective 1326c8943706SMatthew G. Knepley 1327c8943706SMatthew G. Knepley Input Parameters: 1328c8943706SMatthew G. Knepley + ds - The `PetscDS` 1329c8943706SMatthew G. Knepley . f - The test field number 1330c8943706SMatthew G. Knepley - obj - integrand for the test function term 1331c8943706SMatthew G. Knepley 1332c8943706SMatthew G. Knepley Calling sequence of `obj`: 1333c8943706SMatthew G. Knepley + dim - the spatial dimension 1334c8943706SMatthew G. Knepley . Nf - the number of fields 1335a4e35b19SJacob Faibussowitsch . NfAux - the number of auxiliary fields 1336c8943706SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 1337c8943706SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 1338c8943706SMatthew G. Knepley . u - each field evaluated at the current point 1339c8943706SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 1340c8943706SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 1341c8943706SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 1342c8943706SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 1343c8943706SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 1344c8943706SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 1345c8943706SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 1346c8943706SMatthew G. Knepley . t - current time 1347c8943706SMatthew G. Knepley . x - coordinates of the current point 1348c8943706SMatthew G. Knepley . numConstants - number of constant parameters 1349c8943706SMatthew G. Knepley . constants - constant parameters 1350c8943706SMatthew G. Knepley - obj - output values at the current point 1351c8943706SMatthew G. Knepley 1352c8943706SMatthew G. Knepley Level: intermediate 1353c8943706SMatthew G. Knepley 1354c8943706SMatthew G. Knepley Note: 13551d27aa22SBarry Smith We are using a first order FEM model for the weak form\: $ \int_\Omega \phi obj(u, u_t, \nabla u, x, t)$ 1356c8943706SMatthew G. Knepley 1357c8943706SMatthew G. Knepley .seealso: `PetscDS`, `PetscDSGetObjective()`, `PetscDSSetResidual()` 1358c8943706SMatthew G. Knepley @*/ 1359d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSSetObjective(PetscDS ds, PetscInt f, void (*obj)(PetscInt dim, PetscInt Nf, PetscInt NfAux, const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar obj[])) 1360d71ae5a4SJacob Faibussowitsch { 13612764a2aaSMatthew G. Knepley PetscFunctionBegin; 13626528b96dSMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 13636528b96dSMatthew G. Knepley if (obj) PetscValidFunction(obj, 3); 136463a3b9bcSJacob Faibussowitsch PetscCheck(f >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be non-negative", f); 13659566063dSJacob Faibussowitsch PetscCall(PetscWeakFormSetIndexObjective(ds->wf, NULL, 0, f, 0, 0, obj)); 13663ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 13672764a2aaSMatthew G. Knepley } 13682764a2aaSMatthew G. Knepley 1369194d53e6SMatthew G. Knepley /*@C 1370194d53e6SMatthew G. Knepley PetscDSGetResidual - Get the pointwise residual function for a given test field 1371194d53e6SMatthew G. Knepley 137220f4b53cSBarry Smith Not Collective 1373194d53e6SMatthew G. Knepley 1374194d53e6SMatthew G. Knepley Input Parameters: 1375dce8aebaSBarry Smith + ds - The `PetscDS` 1376194d53e6SMatthew G. Knepley - f - The test field number 1377194d53e6SMatthew G. Knepley 1378194d53e6SMatthew G. Knepley Output Parameters: 1379194d53e6SMatthew G. Knepley + f0 - integrand for the test function term 1380194d53e6SMatthew G. Knepley - f1 - integrand for the test function gradient term 1381194d53e6SMatthew G. Knepley 1382a4e35b19SJacob Faibussowitsch Calling sequence of `f0`: 1383194d53e6SMatthew G. Knepley + dim - the spatial dimension 1384194d53e6SMatthew G. Knepley . Nf - the number of fields 1385a4e35b19SJacob Faibussowitsch . NfAux - the number of auxiliary fields 1386194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 1387194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 1388194d53e6SMatthew G. Knepley . u - each field evaluated at the current point 1389194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 1390194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 1391194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 1392194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 1393194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 1394194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 1395194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 1396194d53e6SMatthew G. Knepley . t - current time 1397194d53e6SMatthew G. Knepley . x - coordinates of the current point 139897b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters 139997b6e6e8SMatthew G. Knepley . constants - constant parameters 1400194d53e6SMatthew G. Knepley - f0 - output values at the current point 1401194d53e6SMatthew G. Knepley 1402194d53e6SMatthew G. Knepley Level: intermediate 1403194d53e6SMatthew G. Knepley 1404dce8aebaSBarry Smith Note: 1405a4e35b19SJacob Faibussowitsch `f1` has an identical form and is omitted for brevity. 1406a4e35b19SJacob Faibussowitsch 14071d27aa22SBarry Smith We are using a first order FEM model for the weak form\: $ \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)$ 1408dce8aebaSBarry Smith 1409dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSSetResidual()` 1410194d53e6SMatthew G. Knepley @*/ 1411a4e35b19SJacob Faibussowitsch PetscErrorCode PetscDSGetResidual(PetscDS ds, PetscInt f, void (**f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux, const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f0[]), void (**f1)(PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[])) 1412d71ae5a4SJacob Faibussowitsch { 14136528b96dSMatthew G. Knepley PetscPointFunc *tmp0, *tmp1; 14146528b96dSMatthew G. Knepley PetscInt n0, n1; 14156528b96dSMatthew G. Knepley 14162764a2aaSMatthew G. Knepley PetscFunctionBegin; 14176528b96dSMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 141863a3b9bcSJacob Faibussowitsch PetscCheck(!(f < 0) && !(f >= ds->Nf), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be in [0, %" PetscInt_FMT ")", f, ds->Nf); 14199566063dSJacob Faibussowitsch PetscCall(PetscWeakFormGetResidual(ds->wf, NULL, 0, f, 0, &n0, &tmp0, &n1, &tmp1)); 14206528b96dSMatthew G. Knepley *f0 = tmp0 ? tmp0[0] : NULL; 14216528b96dSMatthew G. Knepley *f1 = tmp1 ? tmp1[0] : NULL; 14223ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 14232764a2aaSMatthew G. Knepley } 14242764a2aaSMatthew G. Knepley 1425194d53e6SMatthew G. Knepley /*@C 1426194d53e6SMatthew G. Knepley PetscDSSetResidual - Set the pointwise residual function for a given test field 1427194d53e6SMatthew G. Knepley 142820f4b53cSBarry Smith Not Collective 1429194d53e6SMatthew G. Knepley 1430194d53e6SMatthew G. Knepley Input Parameters: 1431dce8aebaSBarry Smith + ds - The `PetscDS` 1432194d53e6SMatthew G. Knepley . f - The test field number 1433194d53e6SMatthew G. Knepley . f0 - integrand for the test function term 1434194d53e6SMatthew G. Knepley - f1 - integrand for the test function gradient term 1435194d53e6SMatthew G. Knepley 1436a4e35b19SJacob Faibussowitsch Calling sequence of `f0`: 1437194d53e6SMatthew G. Knepley + dim - the spatial dimension 1438194d53e6SMatthew G. Knepley . Nf - the number of fields 1439a4e35b19SJacob Faibussowitsch . NfAux - the number of auxiliary fields 1440194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 1441194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 1442194d53e6SMatthew G. Knepley . u - each field evaluated at the current point 1443194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 1444194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 1445194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 1446194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 1447194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 1448194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 1449194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 1450194d53e6SMatthew G. Knepley . t - current time 1451194d53e6SMatthew G. Knepley . x - coordinates of the current point 145297b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters 145397b6e6e8SMatthew G. Knepley . constants - constant parameters 1454194d53e6SMatthew G. Knepley - f0 - output values at the current point 1455194d53e6SMatthew G. Knepley 1456194d53e6SMatthew G. Knepley Level: intermediate 1457194d53e6SMatthew G. Knepley 1458dce8aebaSBarry Smith Note: 1459a4e35b19SJacob Faibussowitsch `f1` has an identical form and is omitted for brevity. 1460a4e35b19SJacob Faibussowitsch 14611d27aa22SBarry Smith We are using a first order FEM model for the weak form\: $ \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)$ 1462dce8aebaSBarry Smith 1463dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSGetResidual()` 1464194d53e6SMatthew G. Knepley @*/ 1465a4e35b19SJacob Faibussowitsch PetscErrorCode PetscDSSetResidual(PetscDS ds, PetscInt f, void (*f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux, const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f0[]), void (*f1)(PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[])) 1466d71ae5a4SJacob Faibussowitsch { 14672764a2aaSMatthew G. Knepley PetscFunctionBegin; 14686528b96dSMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 1469f866a1d0SMatthew G. Knepley if (f0) PetscValidFunction(f0, 3); 1470f866a1d0SMatthew G. Knepley if (f1) PetscValidFunction(f1, 4); 147163a3b9bcSJacob Faibussowitsch PetscCheck(f >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be non-negative", f); 14729566063dSJacob Faibussowitsch PetscCall(PetscWeakFormSetIndexResidual(ds->wf, NULL, 0, f, 0, 0, f0, 0, f1)); 14733ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 14742764a2aaSMatthew G. Knepley } 14752764a2aaSMatthew G. Knepley 14763e75805dSMatthew G. Knepley /*@C 1477cb36c0f9SMatthew G. Knepley PetscDSGetRHSResidual - Get the pointwise RHS residual function for explicit timestepping for a given test field 1478cb36c0f9SMatthew G. Knepley 147920f4b53cSBarry Smith Not Collective 1480cb36c0f9SMatthew G. Knepley 1481cb36c0f9SMatthew G. Knepley Input Parameters: 1482dce8aebaSBarry Smith + ds - The `PetscDS` 1483cb36c0f9SMatthew G. Knepley - f - The test field number 1484cb36c0f9SMatthew G. Knepley 1485cb36c0f9SMatthew G. Knepley Output Parameters: 1486cb36c0f9SMatthew G. Knepley + f0 - integrand for the test function term 1487cb36c0f9SMatthew G. Knepley - f1 - integrand for the test function gradient term 1488cb36c0f9SMatthew G. Knepley 1489a4e35b19SJacob Faibussowitsch Calling sequence of `f0`: 1490cb36c0f9SMatthew G. Knepley + dim - the spatial dimension 1491cb36c0f9SMatthew G. Knepley . Nf - the number of fields 1492a4e35b19SJacob Faibussowitsch . NfAux - the number of auxiliary fields 1493cb36c0f9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 1494cb36c0f9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 1495cb36c0f9SMatthew G. Knepley . u - each field evaluated at the current point 1496cb36c0f9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 1497cb36c0f9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 1498cb36c0f9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 1499cb36c0f9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 1500cb36c0f9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 1501cb36c0f9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 1502cb36c0f9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 1503cb36c0f9SMatthew G. Knepley . t - current time 1504cb36c0f9SMatthew G. Knepley . x - coordinates of the current point 1505cb36c0f9SMatthew G. Knepley . numConstants - number of constant parameters 1506cb36c0f9SMatthew G. Knepley . constants - constant parameters 1507cb36c0f9SMatthew G. Knepley - f0 - output values at the current point 1508cb36c0f9SMatthew G. Knepley 1509cb36c0f9SMatthew G. Knepley Level: intermediate 1510cb36c0f9SMatthew G. Knepley 1511dce8aebaSBarry Smith Note: 1512a4e35b19SJacob Faibussowitsch `f1` has an identical form and is omitted for brevity. 1513a4e35b19SJacob Faibussowitsch 15141d27aa22SBarry Smith We are using a first order FEM model for the weak form\: $ \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)$ 1515dce8aebaSBarry Smith 1516dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSSetRHSResidual()` 1517cb36c0f9SMatthew G. Knepley @*/ 1518a4e35b19SJacob Faibussowitsch PetscErrorCode PetscDSGetRHSResidual(PetscDS ds, PetscInt f, void (**f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux, const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f0[]), void (**f1)(PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[])) 1519d71ae5a4SJacob Faibussowitsch { 1520cb36c0f9SMatthew G. Knepley PetscPointFunc *tmp0, *tmp1; 1521cb36c0f9SMatthew G. Knepley PetscInt n0, n1; 1522cb36c0f9SMatthew G. Knepley 1523cb36c0f9SMatthew G. Knepley PetscFunctionBegin; 1524cb36c0f9SMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 152563a3b9bcSJacob Faibussowitsch PetscCheck(!(f < 0) && !(f >= ds->Nf), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be in [0, %" PetscInt_FMT ")", f, ds->Nf); 15269566063dSJacob Faibussowitsch PetscCall(PetscWeakFormGetResidual(ds->wf, NULL, 0, f, 100, &n0, &tmp0, &n1, &tmp1)); 1527cb36c0f9SMatthew G. Knepley *f0 = tmp0 ? tmp0[0] : NULL; 1528cb36c0f9SMatthew G. Knepley *f1 = tmp1 ? tmp1[0] : NULL; 15293ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1530cb36c0f9SMatthew G. Knepley } 1531cb36c0f9SMatthew G. Knepley 1532cb36c0f9SMatthew G. Knepley /*@C 1533cb36c0f9SMatthew G. Knepley PetscDSSetRHSResidual - Set the pointwise residual function for explicit timestepping for a given test field 1534cb36c0f9SMatthew G. Knepley 153520f4b53cSBarry Smith Not Collective 1536cb36c0f9SMatthew G. Knepley 1537cb36c0f9SMatthew G. Knepley Input Parameters: 1538dce8aebaSBarry Smith + ds - The `PetscDS` 1539cb36c0f9SMatthew G. Knepley . f - The test field number 1540cb36c0f9SMatthew G. Knepley . f0 - integrand for the test function term 1541cb36c0f9SMatthew G. Knepley - f1 - integrand for the test function gradient term 1542cb36c0f9SMatthew G. Knepley 1543a4e35b19SJacob Faibussowitsch Calling sequence for the callbacks `f0`: 1544cb36c0f9SMatthew G. Knepley + dim - the spatial dimension 1545cb36c0f9SMatthew G. Knepley . Nf - the number of fields 1546a4e35b19SJacob Faibussowitsch . NfAux - the number of auxiliary fields 1547cb36c0f9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 1548cb36c0f9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 1549cb36c0f9SMatthew G. Knepley . u - each field evaluated at the current point 1550cb36c0f9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 1551cb36c0f9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 1552cb36c0f9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 1553cb36c0f9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 1554cb36c0f9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 1555cb36c0f9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 1556cb36c0f9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 1557cb36c0f9SMatthew G. Knepley . t - current time 1558cb36c0f9SMatthew G. Knepley . x - coordinates of the current point 1559cb36c0f9SMatthew G. Knepley . numConstants - number of constant parameters 1560cb36c0f9SMatthew G. Knepley . constants - constant parameters 1561cb36c0f9SMatthew G. Knepley - f0 - output values at the current point 1562cb36c0f9SMatthew G. Knepley 1563cb36c0f9SMatthew G. Knepley Level: intermediate 1564cb36c0f9SMatthew G. Knepley 1565dce8aebaSBarry Smith Note: 1566a4e35b19SJacob Faibussowitsch `f1` has an identical form and is omitted for brevity. 1567a4e35b19SJacob Faibussowitsch 15681d27aa22SBarry Smith We are using a first order FEM model for the weak form\: $ \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)$ 1569dce8aebaSBarry Smith 1570dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSGetResidual()` 1571cb36c0f9SMatthew G. Knepley @*/ 1572a4e35b19SJacob Faibussowitsch PetscErrorCode PetscDSSetRHSResidual(PetscDS ds, PetscInt f, void (*f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux, const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f0[]), void (*f1)(PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[])) 1573d71ae5a4SJacob Faibussowitsch { 1574cb36c0f9SMatthew G. Knepley PetscFunctionBegin; 1575cb36c0f9SMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 1576cb36c0f9SMatthew G. Knepley if (f0) PetscValidFunction(f0, 3); 1577cb36c0f9SMatthew G. Knepley if (f1) PetscValidFunction(f1, 4); 157863a3b9bcSJacob Faibussowitsch PetscCheck(f >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be non-negative", f); 15799566063dSJacob Faibussowitsch PetscCall(PetscWeakFormSetIndexResidual(ds->wf, NULL, 0, f, 100, 0, f0, 0, f1)); 15803ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1581cb36c0f9SMatthew G. Knepley } 1582cb36c0f9SMatthew G. Knepley 1583cc4c1da9SBarry Smith /*@ 1584dce8aebaSBarry Smith PetscDSHasJacobian - Checks that the Jacobian functions have been set 15853e75805dSMatthew G. Knepley 158620f4b53cSBarry Smith Not Collective 15873e75805dSMatthew G. Knepley 15883e75805dSMatthew G. Knepley Input Parameter: 158960225df5SJacob Faibussowitsch . ds - The `PetscDS` 15903e75805dSMatthew G. Knepley 15913e75805dSMatthew G. Knepley Output Parameter: 15923e75805dSMatthew G. Knepley . hasJac - flag that pointwise function for the Jacobian has been set 15933e75805dSMatthew G. Knepley 15943e75805dSMatthew G. Knepley Level: intermediate 15953e75805dSMatthew G. Knepley 1596dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSGetJacobianPreconditioner()`, `PetscDSSetJacobianPreconditioner()`, `PetscDSGetJacobian()` 15973e75805dSMatthew G. Knepley @*/ 1598d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSHasJacobian(PetscDS ds, PetscBool *hasJac) 1599d71ae5a4SJacob Faibussowitsch { 16003e75805dSMatthew G. Knepley PetscFunctionBegin; 16016528b96dSMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 16029566063dSJacob Faibussowitsch PetscCall(PetscWeakFormHasJacobian(ds->wf, hasJac)); 16033ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 16043e75805dSMatthew G. Knepley } 16053e75805dSMatthew G. Knepley 1606194d53e6SMatthew G. Knepley /*@C 1607194d53e6SMatthew G. Knepley PetscDSGetJacobian - Get the pointwise Jacobian function for given test and basis field 1608194d53e6SMatthew G. Knepley 160920f4b53cSBarry Smith Not Collective 1610194d53e6SMatthew G. Knepley 1611194d53e6SMatthew G. Knepley Input Parameters: 1612dce8aebaSBarry Smith + ds - The `PetscDS` 1613194d53e6SMatthew G. Knepley . f - The test field number 1614194d53e6SMatthew G. Knepley - g - The field number 1615194d53e6SMatthew G. Knepley 1616194d53e6SMatthew G. Knepley Output Parameters: 1617194d53e6SMatthew G. Knepley + g0 - integrand for the test and basis function term 1618194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term 1619194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term 1620194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term 1621194d53e6SMatthew G. Knepley 1622a4e35b19SJacob Faibussowitsch Calling sequence of `g0`: 1623194d53e6SMatthew G. Knepley + dim - the spatial dimension 1624194d53e6SMatthew G. Knepley . Nf - the number of fields 1625a4e35b19SJacob Faibussowitsch . NfAux - the number of auxiliary fields 1626194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 1627194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 1628194d53e6SMatthew G. Knepley . u - each field evaluated at the current point 1629194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 1630194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 1631194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 1632194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 1633194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 1634194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 1635194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 1636194d53e6SMatthew G. Knepley . t - current time 16372aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t 1638194d53e6SMatthew G. Knepley . x - coordinates of the current point 163997b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters 164097b6e6e8SMatthew G. Knepley . constants - constant parameters 1641194d53e6SMatthew G. Knepley - g0 - output values at the current point 1642194d53e6SMatthew G. Knepley 1643194d53e6SMatthew G. Knepley Level: intermediate 1644194d53e6SMatthew G. Knepley 1645dce8aebaSBarry Smith Note: 1646a4e35b19SJacob Faibussowitsch `g1`, `g2`, and `g3` have identical calling sequences to `g0` and are omitted for brevity. 164760225df5SJacob Faibussowitsch 1648a4e35b19SJacob Faibussowitsch We are using a first order FEM model for the weak form\: 16491d27aa22SBarry Smith 16501d27aa22SBarry Smith $$ 1651dce8aebaSBarry Smith \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 16521d27aa22SBarry Smith $$ 1653dce8aebaSBarry Smith 1654dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSSetJacobian()` 1655194d53e6SMatthew G. Knepley @*/ 1656a4e35b19SJacob Faibussowitsch PetscErrorCode PetscDSGetJacobian(PetscDS ds, PetscInt f, PetscInt g, void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux, const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]), void (**g1)(PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], PetscReal, PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]), void (**g2)(PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], PetscReal, PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]), void (**g3)(PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], PetscReal, PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[])) 1657d71ae5a4SJacob Faibussowitsch { 16586528b96dSMatthew G. Knepley PetscPointJac *tmp0, *tmp1, *tmp2, *tmp3; 16596528b96dSMatthew G. Knepley PetscInt n0, n1, n2, n3; 16606528b96dSMatthew G. Knepley 16612764a2aaSMatthew G. Knepley PetscFunctionBegin; 16626528b96dSMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 166363a3b9bcSJacob Faibussowitsch PetscCheck(!(f < 0) && !(f >= ds->Nf), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be in [0, %" PetscInt_FMT ")", f, ds->Nf); 166463a3b9bcSJacob Faibussowitsch PetscCheck(!(g < 0) && !(g >= ds->Nf), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be in [0, %" PetscInt_FMT ")", g, ds->Nf); 16659566063dSJacob Faibussowitsch PetscCall(PetscWeakFormGetJacobian(ds->wf, NULL, 0, f, g, 0, &n0, &tmp0, &n1, &tmp1, &n2, &tmp2, &n3, &tmp3)); 16666528b96dSMatthew G. Knepley *g0 = tmp0 ? tmp0[0] : NULL; 16676528b96dSMatthew G. Knepley *g1 = tmp1 ? tmp1[0] : NULL; 16686528b96dSMatthew G. Knepley *g2 = tmp2 ? tmp2[0] : NULL; 16696528b96dSMatthew G. Knepley *g3 = tmp3 ? tmp3[0] : NULL; 16703ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 16712764a2aaSMatthew G. Knepley } 16722764a2aaSMatthew G. Knepley 1673194d53e6SMatthew G. Knepley /*@C 1674194d53e6SMatthew G. Knepley PetscDSSetJacobian - Set the pointwise Jacobian function for given test and basis fields 1675194d53e6SMatthew G. Knepley 167620f4b53cSBarry Smith Not Collective 1677194d53e6SMatthew G. Knepley 1678194d53e6SMatthew G. Knepley Input Parameters: 1679dce8aebaSBarry Smith + ds - The `PetscDS` 1680194d53e6SMatthew G. Knepley . f - The test field number 1681194d53e6SMatthew G. Knepley . g - The field number 1682194d53e6SMatthew G. Knepley . g0 - integrand for the test and basis function term 1683194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term 1684194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term 1685194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term 1686194d53e6SMatthew G. Knepley 1687a4e35b19SJacob Faibussowitsch Calling sequence of `g0`: 1688194d53e6SMatthew G. Knepley + dim - the spatial dimension 1689194d53e6SMatthew G. Knepley . Nf - the number of fields 1690a4e35b19SJacob Faibussowitsch . NfAux - the number of auxiliary fields 1691194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 1692194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 1693194d53e6SMatthew G. Knepley . u - each field evaluated at the current point 1694194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 1695194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 1696194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 1697194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 1698194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 1699194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 1700194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 1701194d53e6SMatthew G. Knepley . t - current time 17022aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t 1703194d53e6SMatthew G. Knepley . x - coordinates of the current point 170497b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters 170597b6e6e8SMatthew G. Knepley . constants - constant parameters 1706194d53e6SMatthew G. Knepley - g0 - output values at the current point 1707194d53e6SMatthew G. Knepley 1708194d53e6SMatthew G. Knepley Level: intermediate 1709194d53e6SMatthew G. Knepley 1710dce8aebaSBarry Smith Note: 1711a4e35b19SJacob Faibussowitsch `g1`, `g2`, and `g3` have identical calling sequences to `g0` and are omitted for brevity. 171260225df5SJacob Faibussowitsch 1713a4e35b19SJacob Faibussowitsch We are using a first order FEM model for the weak form\: 1714dce8aebaSBarry Smith \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 1715dce8aebaSBarry Smith 1716dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSGetJacobian()` 1717194d53e6SMatthew G. Knepley @*/ 1718a4e35b19SJacob Faibussowitsch PetscErrorCode PetscDSSetJacobian(PetscDS ds, PetscInt f, PetscInt g, void (*g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux, const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]), void (*g1)(PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], PetscReal, PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]), void (*g2)(PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], PetscReal, PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]), void (*g3)(PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], PetscReal, PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[])) 1719d71ae5a4SJacob Faibussowitsch { 17202764a2aaSMatthew G. Knepley PetscFunctionBegin; 17216528b96dSMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 17222764a2aaSMatthew G. Knepley if (g0) PetscValidFunction(g0, 4); 17232764a2aaSMatthew G. Knepley if (g1) PetscValidFunction(g1, 5); 17242764a2aaSMatthew G. Knepley if (g2) PetscValidFunction(g2, 6); 17252764a2aaSMatthew G. Knepley if (g3) PetscValidFunction(g3, 7); 172663a3b9bcSJacob Faibussowitsch PetscCheck(f >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be non-negative", f); 172763a3b9bcSJacob Faibussowitsch PetscCheck(g >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be non-negative", g); 17289566063dSJacob Faibussowitsch PetscCall(PetscWeakFormSetIndexJacobian(ds->wf, NULL, 0, f, g, 0, 0, g0, 0, g1, 0, g2, 0, g3)); 17293ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 17302764a2aaSMatthew G. Knepley } 17312764a2aaSMatthew G. Knepley 1732cc4c1da9SBarry Smith /*@ 1733dce8aebaSBarry Smith PetscDSUseJacobianPreconditioner - Set whether to construct a Jacobian preconditioner 173455c1f793SMatthew G. Knepley 173520f4b53cSBarry Smith Not Collective 173655c1f793SMatthew G. Knepley 173755c1f793SMatthew G. Knepley Input Parameters: 1738dce8aebaSBarry Smith + prob - The `PetscDS` 173955c1f793SMatthew G. Knepley - useJacPre - flag that enables construction of a Jacobian preconditioner 174055c1f793SMatthew G. Knepley 174155c1f793SMatthew G. Knepley Level: intermediate 174255c1f793SMatthew G. Knepley 1743cc4c1da9SBarry Smith Developer Note: 1744cc4c1da9SBarry Smith Should be called `PetscDSSetUseJacobianPreconditioner()` 1745cc4c1da9SBarry Smith 1746dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSGetJacobianPreconditioner()`, `PetscDSSetJacobianPreconditioner()`, `PetscDSGetJacobian()` 174755c1f793SMatthew G. Knepley @*/ 1748d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSUseJacobianPreconditioner(PetscDS prob, PetscBool useJacPre) 1749d71ae5a4SJacob Faibussowitsch { 175055c1f793SMatthew G. Knepley PetscFunctionBegin; 175155c1f793SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 175255c1f793SMatthew G. Knepley prob->useJacPre = useJacPre; 17533ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 175455c1f793SMatthew G. Knepley } 175555c1f793SMatthew G. Knepley 1756cc4c1da9SBarry Smith /*@ 1757dce8aebaSBarry Smith PetscDSHasJacobianPreconditioner - Checks if a Jacobian preconditioner matrix has been set 1758475e0ac9SMatthew G. Knepley 175920f4b53cSBarry Smith Not Collective 1760475e0ac9SMatthew G. Knepley 1761475e0ac9SMatthew G. Knepley Input Parameter: 176260225df5SJacob Faibussowitsch . ds - The `PetscDS` 1763475e0ac9SMatthew G. Knepley 1764475e0ac9SMatthew G. Knepley Output Parameter: 1765475e0ac9SMatthew G. Knepley . hasJacPre - flag that pointwise function for Jacobian preconditioner matrix has been set 1766475e0ac9SMatthew G. Knepley 1767475e0ac9SMatthew G. Knepley Level: intermediate 1768475e0ac9SMatthew G. Knepley 1769dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSGetJacobianPreconditioner()`, `PetscDSSetJacobianPreconditioner()`, `PetscDSGetJacobian()` 1770475e0ac9SMatthew G. Knepley @*/ 1771d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSHasJacobianPreconditioner(PetscDS ds, PetscBool *hasJacPre) 1772d71ae5a4SJacob Faibussowitsch { 1773475e0ac9SMatthew G. Knepley PetscFunctionBegin; 17746528b96dSMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 1775475e0ac9SMatthew G. Knepley *hasJacPre = PETSC_FALSE; 17763ba16761SJacob Faibussowitsch if (!ds->useJacPre) PetscFunctionReturn(PETSC_SUCCESS); 17779566063dSJacob Faibussowitsch PetscCall(PetscWeakFormHasJacobianPreconditioner(ds->wf, hasJacPre)); 17783ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1779475e0ac9SMatthew G. Knepley } 1780475e0ac9SMatthew G. Knepley 1781475e0ac9SMatthew G. Knepley /*@C 1782dce8aebaSBarry Smith PetscDSGetJacobianPreconditioner - Get the pointwise Jacobian preconditioner function for given test and basis field. If this is missing, 1783dce8aebaSBarry Smith the system matrix is used to build the preconditioner. 1784475e0ac9SMatthew G. Knepley 178520f4b53cSBarry Smith Not Collective 1786475e0ac9SMatthew G. Knepley 1787475e0ac9SMatthew G. Knepley Input Parameters: 1788dce8aebaSBarry Smith + ds - The `PetscDS` 1789475e0ac9SMatthew G. Knepley . f - The test field number 1790475e0ac9SMatthew G. Knepley - g - The field number 1791475e0ac9SMatthew G. Knepley 1792475e0ac9SMatthew G. Knepley Output Parameters: 1793475e0ac9SMatthew G. Knepley + g0 - integrand for the test and basis function term 1794475e0ac9SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term 1795475e0ac9SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term 1796475e0ac9SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term 1797475e0ac9SMatthew G. Knepley 1798a4e35b19SJacob Faibussowitsch Calling sequence of `g0`: 1799475e0ac9SMatthew G. Knepley + dim - the spatial dimension 1800475e0ac9SMatthew G. Knepley . Nf - the number of fields 1801a4e35b19SJacob Faibussowitsch . NfAux - the number of auxiliary fields 1802475e0ac9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 1803475e0ac9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 1804475e0ac9SMatthew G. Knepley . u - each field evaluated at the current point 1805475e0ac9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 1806475e0ac9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 1807475e0ac9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 1808475e0ac9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 1809475e0ac9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 1810475e0ac9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 1811475e0ac9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 1812475e0ac9SMatthew G. Knepley . t - current time 1813475e0ac9SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t 1814475e0ac9SMatthew G. Knepley . x - coordinates of the current point 181597b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters 181697b6e6e8SMatthew G. Knepley . constants - constant parameters 1817475e0ac9SMatthew G. Knepley - g0 - output values at the current point 1818475e0ac9SMatthew G. Knepley 1819475e0ac9SMatthew G. Knepley Level: intermediate 1820475e0ac9SMatthew G. Knepley 1821dce8aebaSBarry Smith Note: 1822a4e35b19SJacob Faibussowitsch `g1`, `g2`, and `g3` have identical calling sequences to `g0` and are omitted for brevity. 1823a4e35b19SJacob Faibussowitsch We are using a first order FEM model for the weak form\: 1824dce8aebaSBarry Smith \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 1825dce8aebaSBarry Smith 1826dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSSetJacobianPreconditioner()`, `PetscDSGetJacobian()` 1827475e0ac9SMatthew G. Knepley @*/ 1828a4e35b19SJacob Faibussowitsch PetscErrorCode PetscDSGetJacobianPreconditioner(PetscDS ds, PetscInt f, PetscInt g, void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux, const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]), void (**g1)(PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], PetscReal, PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]), void (**g2)(PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], PetscReal, PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]), void (**g3)(PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], PetscReal, PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[])) 1829d71ae5a4SJacob Faibussowitsch { 18306528b96dSMatthew G. Knepley PetscPointJac *tmp0, *tmp1, *tmp2, *tmp3; 18316528b96dSMatthew G. Knepley PetscInt n0, n1, n2, n3; 18326528b96dSMatthew G. Knepley 1833475e0ac9SMatthew G. Knepley PetscFunctionBegin; 18346528b96dSMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 183563a3b9bcSJacob Faibussowitsch PetscCheck(!(f < 0) && !(f >= ds->Nf), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be in [0, %" PetscInt_FMT ")", f, ds->Nf); 183663a3b9bcSJacob Faibussowitsch PetscCheck(!(g < 0) && !(g >= ds->Nf), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be in [0, %" PetscInt_FMT ")", g, ds->Nf); 18379566063dSJacob Faibussowitsch PetscCall(PetscWeakFormGetJacobianPreconditioner(ds->wf, NULL, 0, f, g, 0, &n0, &tmp0, &n1, &tmp1, &n2, &tmp2, &n3, &tmp3)); 18386528b96dSMatthew G. Knepley *g0 = tmp0 ? tmp0[0] : NULL; 18396528b96dSMatthew G. Knepley *g1 = tmp1 ? tmp1[0] : NULL; 18406528b96dSMatthew G. Knepley *g2 = tmp2 ? tmp2[0] : NULL; 18416528b96dSMatthew G. Knepley *g3 = tmp3 ? tmp3[0] : NULL; 18423ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1843475e0ac9SMatthew G. Knepley } 1844475e0ac9SMatthew G. Knepley 1845475e0ac9SMatthew G. Knepley /*@C 1846dce8aebaSBarry Smith PetscDSSetJacobianPreconditioner - Set the pointwise Jacobian preconditioner function for given test and basis fields. 1847dce8aebaSBarry Smith If this is missing, the system matrix is used to build the preconditioner. 1848475e0ac9SMatthew G. Knepley 184920f4b53cSBarry Smith Not Collective 1850475e0ac9SMatthew G. Knepley 1851475e0ac9SMatthew G. Knepley Input Parameters: 1852dce8aebaSBarry Smith + ds - The `PetscDS` 1853475e0ac9SMatthew G. Knepley . f - The test field number 1854475e0ac9SMatthew G. Knepley . g - The field number 1855475e0ac9SMatthew G. Knepley . g0 - integrand for the test and basis function term 1856475e0ac9SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term 1857475e0ac9SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term 1858475e0ac9SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term 1859475e0ac9SMatthew G. Knepley 1860a4e35b19SJacob Faibussowitsch Calling sequence of `g0`: 1861475e0ac9SMatthew G. Knepley + dim - the spatial dimension 1862475e0ac9SMatthew G. Knepley . Nf - the number of fields 1863a4e35b19SJacob Faibussowitsch . NfAux - the number of auxiliary fields 1864475e0ac9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 1865475e0ac9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 1866475e0ac9SMatthew G. Knepley . u - each field evaluated at the current point 1867475e0ac9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 1868475e0ac9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 1869475e0ac9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 1870475e0ac9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 1871475e0ac9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 1872475e0ac9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 1873475e0ac9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 1874475e0ac9SMatthew G. Knepley . t - current time 1875475e0ac9SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t 1876475e0ac9SMatthew G. Knepley . x - coordinates of the current point 187797b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters 187897b6e6e8SMatthew G. Knepley . constants - constant parameters 1879475e0ac9SMatthew G. Knepley - g0 - output values at the current point 1880475e0ac9SMatthew G. Knepley 1881475e0ac9SMatthew G. Knepley Level: intermediate 1882475e0ac9SMatthew G. Knepley 1883dce8aebaSBarry Smith Note: 1884a4e35b19SJacob Faibussowitsch `g1`, `g2`, and `g3` have identical calling sequences to `g0` and are omitted for brevity. 188560225df5SJacob Faibussowitsch 1886a4e35b19SJacob Faibussowitsch We are using a first order FEM model for the weak form\: 1887dce8aebaSBarry Smith \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 1888dce8aebaSBarry Smith 1889dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSGetJacobianPreconditioner()`, `PetscDSSetJacobian()` 1890475e0ac9SMatthew G. Knepley @*/ 1891a4e35b19SJacob Faibussowitsch PetscErrorCode PetscDSSetJacobianPreconditioner(PetscDS ds, PetscInt f, PetscInt g, void (*g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux, const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]), void (*g1)(PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], PetscReal, PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]), void (*g2)(PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], PetscReal, PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]), void (*g3)(PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], PetscReal, PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[])) 1892d71ae5a4SJacob Faibussowitsch { 1893475e0ac9SMatthew G. Knepley PetscFunctionBegin; 18946528b96dSMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 1895475e0ac9SMatthew G. Knepley if (g0) PetscValidFunction(g0, 4); 1896475e0ac9SMatthew G. Knepley if (g1) PetscValidFunction(g1, 5); 1897475e0ac9SMatthew G. Knepley if (g2) PetscValidFunction(g2, 6); 1898475e0ac9SMatthew G. Knepley if (g3) PetscValidFunction(g3, 7); 189963a3b9bcSJacob Faibussowitsch PetscCheck(f >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be non-negative", f); 190063a3b9bcSJacob Faibussowitsch PetscCheck(g >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be non-negative", g); 19019566063dSJacob Faibussowitsch PetscCall(PetscWeakFormSetIndexJacobianPreconditioner(ds->wf, NULL, 0, f, g, 0, 0, g0, 0, g1, 0, g2, 0, g3)); 19023ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1903475e0ac9SMatthew G. Knepley } 1904475e0ac9SMatthew G. Knepley 1905cc4c1da9SBarry Smith /*@ 1906b7e05686SMatthew G. Knepley PetscDSHasDynamicJacobian - Signals that a dynamic Jacobian, dF/du_t, has been set 1907b7e05686SMatthew G. Knepley 190820f4b53cSBarry Smith Not Collective 1909b7e05686SMatthew G. Knepley 1910b7e05686SMatthew G. Knepley Input Parameter: 1911dce8aebaSBarry Smith . ds - The `PetscDS` 1912b7e05686SMatthew G. Knepley 1913b7e05686SMatthew G. Knepley Output Parameter: 1914b7e05686SMatthew G. Knepley . hasDynJac - flag that pointwise function for dynamic Jacobian has been set 1915b7e05686SMatthew G. Knepley 1916b7e05686SMatthew G. Knepley Level: intermediate 1917b7e05686SMatthew G. Knepley 1918dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSGetDynamicJacobian()`, `PetscDSSetDynamicJacobian()`, `PetscDSGetJacobian()` 1919b7e05686SMatthew G. Knepley @*/ 1920d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSHasDynamicJacobian(PetscDS ds, PetscBool *hasDynJac) 1921d71ae5a4SJacob Faibussowitsch { 1922b7e05686SMatthew G. Knepley PetscFunctionBegin; 19236528b96dSMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 19249566063dSJacob Faibussowitsch PetscCall(PetscWeakFormHasDynamicJacobian(ds->wf, hasDynJac)); 19253ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1926b7e05686SMatthew G. Knepley } 1927b7e05686SMatthew G. Knepley 1928b7e05686SMatthew G. Knepley /*@C 1929b7e05686SMatthew G. Knepley PetscDSGetDynamicJacobian - Get the pointwise dynamic Jacobian, dF/du_t, function for given test and basis field 1930b7e05686SMatthew G. Knepley 193120f4b53cSBarry Smith Not Collective 1932b7e05686SMatthew G. Knepley 1933b7e05686SMatthew G. Knepley Input Parameters: 1934dce8aebaSBarry Smith + ds - The `PetscDS` 1935b7e05686SMatthew G. Knepley . f - The test field number 1936b7e05686SMatthew G. Knepley - g - The field number 1937b7e05686SMatthew G. Knepley 1938b7e05686SMatthew G. Knepley Output Parameters: 1939b7e05686SMatthew G. Knepley + g0 - integrand for the test and basis function term 1940b7e05686SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term 1941b7e05686SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term 1942b7e05686SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term 1943b7e05686SMatthew G. Knepley 1944a4e35b19SJacob Faibussowitsch Calling sequence of `g0`: 1945b7e05686SMatthew G. Knepley + dim - the spatial dimension 1946b7e05686SMatthew G. Knepley . Nf - the number of fields 1947a4e35b19SJacob Faibussowitsch . NfAux - the number of auxiliary fields 1948b7e05686SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 1949b7e05686SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 1950b7e05686SMatthew G. Knepley . u - each field evaluated at the current point 1951b7e05686SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 1952b7e05686SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 1953b7e05686SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 1954b7e05686SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 1955b7e05686SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 1956b7e05686SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 1957b7e05686SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 1958b7e05686SMatthew G. Knepley . t - current time 1959b7e05686SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t 1960b7e05686SMatthew G. Knepley . x - coordinates of the current point 196197b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters 196297b6e6e8SMatthew G. Knepley . constants - constant parameters 1963b7e05686SMatthew G. Knepley - g0 - output values at the current point 1964b7e05686SMatthew G. Knepley 1965b7e05686SMatthew G. Knepley Level: intermediate 1966b7e05686SMatthew G. Knepley 1967dce8aebaSBarry Smith Note: 1968a4e35b19SJacob Faibussowitsch `g1`, `g2`, and `g3` have identical calling sequences to `g0` and are omitted for brevity. 196960225df5SJacob Faibussowitsch 1970a4e35b19SJacob Faibussowitsch We are using a first order FEM model for the weak form\: 1971dce8aebaSBarry Smith \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 1972dce8aebaSBarry Smith 1973dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSSetJacobian()` 1974b7e05686SMatthew G. Knepley @*/ 1975a4e35b19SJacob Faibussowitsch PetscErrorCode PetscDSGetDynamicJacobian(PetscDS ds, PetscInt f, PetscInt g, void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux, const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]), void (**g1)(PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], PetscReal, PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]), void (**g2)(PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], PetscReal, PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]), void (**g3)(PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], PetscReal, PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[])) 1976d71ae5a4SJacob Faibussowitsch { 19776528b96dSMatthew G. Knepley PetscPointJac *tmp0, *tmp1, *tmp2, *tmp3; 19786528b96dSMatthew G. Knepley PetscInt n0, n1, n2, n3; 19796528b96dSMatthew G. Knepley 1980b7e05686SMatthew G. Knepley PetscFunctionBegin; 19816528b96dSMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 198263a3b9bcSJacob Faibussowitsch PetscCheck(!(f < 0) && !(f >= ds->Nf), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be in [0, %" PetscInt_FMT ")", f, ds->Nf); 198363a3b9bcSJacob Faibussowitsch PetscCheck(!(g < 0) && !(g >= ds->Nf), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be in [0, %" PetscInt_FMT ")", g, ds->Nf); 19849566063dSJacob Faibussowitsch PetscCall(PetscWeakFormGetDynamicJacobian(ds->wf, NULL, 0, f, g, 0, &n0, &tmp0, &n1, &tmp1, &n2, &tmp2, &n3, &tmp3)); 19856528b96dSMatthew G. Knepley *g0 = tmp0 ? tmp0[0] : NULL; 19866528b96dSMatthew G. Knepley *g1 = tmp1 ? tmp1[0] : NULL; 19876528b96dSMatthew G. Knepley *g2 = tmp2 ? tmp2[0] : NULL; 19886528b96dSMatthew G. Knepley *g3 = tmp3 ? tmp3[0] : NULL; 19893ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1990b7e05686SMatthew G. Knepley } 1991b7e05686SMatthew G. Knepley 1992b7e05686SMatthew G. Knepley /*@C 1993b7e05686SMatthew G. Knepley PetscDSSetDynamicJacobian - Set the pointwise dynamic Jacobian, dF/du_t, function for given test and basis fields 1994b7e05686SMatthew G. Knepley 199520f4b53cSBarry Smith Not Collective 1996b7e05686SMatthew G. Knepley 1997b7e05686SMatthew G. Knepley Input Parameters: 1998dce8aebaSBarry Smith + ds - The `PetscDS` 1999b7e05686SMatthew G. Knepley . f - The test field number 2000b7e05686SMatthew G. Knepley . g - The field number 2001b7e05686SMatthew G. Knepley . g0 - integrand for the test and basis function term 2002b7e05686SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term 2003b7e05686SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term 2004b7e05686SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term 2005b7e05686SMatthew G. Knepley 2006a4e35b19SJacob Faibussowitsch Calling sequence of `g0`: 2007b7e05686SMatthew G. Knepley + dim - the spatial dimension 2008b7e05686SMatthew G. Knepley . Nf - the number of fields 2009a4e35b19SJacob Faibussowitsch . NfAux - the number of auxiliary fields 2010b7e05686SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 2011b7e05686SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 2012b7e05686SMatthew G. Knepley . u - each field evaluated at the current point 2013b7e05686SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 2014b7e05686SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 2015b7e05686SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 2016b7e05686SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 2017b7e05686SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 2018b7e05686SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 2019b7e05686SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 2020b7e05686SMatthew G. Knepley . t - current time 2021b7e05686SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t 2022b7e05686SMatthew G. Knepley . x - coordinates of the current point 202397b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters 202497b6e6e8SMatthew G. Knepley . constants - constant parameters 2025b7e05686SMatthew G. Knepley - g0 - output values at the current point 2026b7e05686SMatthew G. Knepley 2027b7e05686SMatthew G. Knepley Level: intermediate 2028b7e05686SMatthew G. Knepley 2029dce8aebaSBarry Smith Note: 2030a4e35b19SJacob Faibussowitsch `g1`, `g2`, and `g3` have identical calling sequences to `g0` and are omitted for brevity. 203160225df5SJacob Faibussowitsch 2032a4e35b19SJacob Faibussowitsch We are using a first order FEM model for the weak form\: 2033dce8aebaSBarry Smith \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 2034dce8aebaSBarry Smith 2035dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSGetJacobian()` 2036b7e05686SMatthew G. Knepley @*/ 2037a4e35b19SJacob Faibussowitsch PetscErrorCode PetscDSSetDynamicJacobian(PetscDS ds, PetscInt f, PetscInt g, void (*g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux, const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], PetscReal t, PetscReal u_tShift, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]), void (*g1)(PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], PetscReal, PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]), void (*g2)(PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], PetscReal, PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]), void (*g3)(PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], PetscReal, PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[])) 2038d71ae5a4SJacob Faibussowitsch { 2039b7e05686SMatthew G. Knepley PetscFunctionBegin; 20406528b96dSMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 2041b7e05686SMatthew G. Knepley if (g0) PetscValidFunction(g0, 4); 2042b7e05686SMatthew G. Knepley if (g1) PetscValidFunction(g1, 5); 2043b7e05686SMatthew G. Knepley if (g2) PetscValidFunction(g2, 6); 2044b7e05686SMatthew G. Knepley if (g3) PetscValidFunction(g3, 7); 204563a3b9bcSJacob Faibussowitsch PetscCheck(f >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be non-negative", f); 204663a3b9bcSJacob Faibussowitsch PetscCheck(g >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be non-negative", g); 20479566063dSJacob Faibussowitsch PetscCall(PetscWeakFormSetIndexDynamicJacobian(ds->wf, NULL, 0, f, g, 0, 0, g0, 0, g1, 0, g2, 0, g3)); 20483ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2049b7e05686SMatthew G. Knepley } 2050b7e05686SMatthew G. Knepley 20510c2f2876SMatthew G. Knepley /*@C 20520c2f2876SMatthew G. Knepley PetscDSGetRiemannSolver - Returns the Riemann solver for the given field 20530c2f2876SMatthew G. Knepley 205420f4b53cSBarry Smith Not Collective 20550c2f2876SMatthew G. Knepley 20564165533cSJose E. Roman Input Parameters: 2057dce8aebaSBarry Smith + ds - The `PetscDS` object 20580c2f2876SMatthew G. Knepley - f - The field number 20590c2f2876SMatthew G. Knepley 20604165533cSJose E. Roman Output Parameter: 20610c2f2876SMatthew G. Knepley . r - Riemann solver 20620c2f2876SMatthew G. Knepley 206320f4b53cSBarry Smith Calling sequence of `r`: 20645db36cf9SMatthew G. Knepley + dim - The spatial dimension 20655db36cf9SMatthew G. Knepley . Nf - The number of fields 20665db36cf9SMatthew G. Knepley . x - The coordinates at a point on the interface 20670c2f2876SMatthew G. Knepley . n - The normal vector to the interface 20680c2f2876SMatthew G. Knepley . uL - The state vector to the left of the interface 20690c2f2876SMatthew G. Knepley . uR - The state vector to the right of the interface 20700c2f2876SMatthew G. Knepley . flux - output array of flux through the interface 207197b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters 207297b6e6e8SMatthew G. Knepley . constants - constant parameters 20730c2f2876SMatthew G. Knepley - ctx - optional user context 20740c2f2876SMatthew G. Knepley 20750c2f2876SMatthew G. Knepley Level: intermediate 20760c2f2876SMatthew G. Knepley 2077dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSSetRiemannSolver()` 20780c2f2876SMatthew G. Knepley @*/ 2079d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSGetRiemannSolver(PetscDS ds, PetscInt f, 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)) 2080d71ae5a4SJacob Faibussowitsch { 20816528b96dSMatthew G. Knepley PetscRiemannFunc *tmp; 20826528b96dSMatthew G. Knepley PetscInt n; 20836528b96dSMatthew G. Knepley 20840c2f2876SMatthew G. Knepley PetscFunctionBegin; 20856528b96dSMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 20864f572ea9SToby Isaac PetscAssertPointer(r, 3); 208763a3b9bcSJacob Faibussowitsch PetscCheck(!(f < 0) && !(f >= ds->Nf), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be in [0, %" PetscInt_FMT ")", f, ds->Nf); 20889566063dSJacob Faibussowitsch PetscCall(PetscWeakFormGetRiemannSolver(ds->wf, NULL, 0, f, 0, &n, &tmp)); 20896528b96dSMatthew G. Knepley *r = tmp ? tmp[0] : NULL; 20903ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 20910c2f2876SMatthew G. Knepley } 20920c2f2876SMatthew G. Knepley 20930c2f2876SMatthew G. Knepley /*@C 20940c2f2876SMatthew G. Knepley PetscDSSetRiemannSolver - Sets the Riemann solver for the given field 20950c2f2876SMatthew G. Knepley 209620f4b53cSBarry Smith Not Collective 20970c2f2876SMatthew G. Knepley 20984165533cSJose E. Roman Input Parameters: 2099dce8aebaSBarry Smith + ds - The `PetscDS` object 21000c2f2876SMatthew G. Knepley . f - The field number 21010c2f2876SMatthew G. Knepley - r - Riemann solver 21020c2f2876SMatthew G. Knepley 210320f4b53cSBarry Smith Calling sequence of `r`: 21045db36cf9SMatthew G. Knepley + dim - The spatial dimension 21055db36cf9SMatthew G. Knepley . Nf - The number of fields 21065db36cf9SMatthew G. Knepley . x - The coordinates at a point on the interface 21070c2f2876SMatthew G. Knepley . n - The normal vector to the interface 21080c2f2876SMatthew G. Knepley . uL - The state vector to the left of the interface 21090c2f2876SMatthew G. Knepley . uR - The state vector to the right of the interface 21100c2f2876SMatthew G. Knepley . flux - output array of flux through the interface 211197b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters 211297b6e6e8SMatthew G. Knepley . constants - constant parameters 21130c2f2876SMatthew G. Knepley - ctx - optional user context 21140c2f2876SMatthew G. Knepley 21150c2f2876SMatthew G. Knepley Level: intermediate 21160c2f2876SMatthew G. Knepley 2117dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSGetRiemannSolver()` 21180c2f2876SMatthew G. Knepley @*/ 2119d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSSetRiemannSolver(PetscDS ds, PetscInt f, 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)) 2120d71ae5a4SJacob Faibussowitsch { 21210c2f2876SMatthew G. Knepley PetscFunctionBegin; 21226528b96dSMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 2123de716cbcSToby Isaac if (r) PetscValidFunction(r, 3); 212463a3b9bcSJacob Faibussowitsch PetscCheck(f >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be non-negative", f); 21259566063dSJacob Faibussowitsch PetscCall(PetscWeakFormSetIndexRiemannSolver(ds->wf, NULL, 0, f, 0, 0, r)); 21263ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 21270c2f2876SMatthew G. Knepley } 21280c2f2876SMatthew G. Knepley 212932d2bbc9SMatthew G. Knepley /*@C 213032d2bbc9SMatthew G. Knepley PetscDSGetUpdate - Get the pointwise update function for a given field 213132d2bbc9SMatthew G. Knepley 213220f4b53cSBarry Smith Not Collective 213332d2bbc9SMatthew G. Knepley 213432d2bbc9SMatthew G. Knepley Input Parameters: 2135dce8aebaSBarry Smith + ds - The `PetscDS` 213632d2bbc9SMatthew G. Knepley - f - The field number 213732d2bbc9SMatthew G. Knepley 2138f899ff85SJose E. Roman Output Parameter: 2139a2b725a8SWilliam Gropp . update - update function 214032d2bbc9SMatthew G. Knepley 214120f4b53cSBarry Smith Calling sequence of `update`: 214232d2bbc9SMatthew G. Knepley + dim - the spatial dimension 214332d2bbc9SMatthew G. Knepley . Nf - the number of fields 2144a4e35b19SJacob Faibussowitsch . NfAux - the number of auxiliary fields 214532d2bbc9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 214632d2bbc9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 214732d2bbc9SMatthew G. Knepley . u - each field evaluated at the current point 214832d2bbc9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 214932d2bbc9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 215032d2bbc9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 215132d2bbc9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 215232d2bbc9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 215332d2bbc9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 215432d2bbc9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 215532d2bbc9SMatthew G. Knepley . t - current time 215632d2bbc9SMatthew G. Knepley . x - coordinates of the current point 2157a4e35b19SJacob Faibussowitsch . numConstants - number of constant parameters 2158a4e35b19SJacob Faibussowitsch . constants - constant parameters 215932d2bbc9SMatthew G. Knepley - uNew - new value for field at the current point 216032d2bbc9SMatthew G. Knepley 216132d2bbc9SMatthew G. Knepley Level: intermediate 216232d2bbc9SMatthew G. Knepley 2163dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSSetUpdate()`, `PetscDSSetResidual()` 216432d2bbc9SMatthew G. Knepley @*/ 2165d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSGetUpdate(PetscDS ds, PetscInt f, void (**update)(PetscInt dim, PetscInt Nf, PetscInt NfAux, const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar uNew[])) 2166d71ae5a4SJacob Faibussowitsch { 216732d2bbc9SMatthew G. Knepley PetscFunctionBegin; 21686528b96dSMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 216963a3b9bcSJacob Faibussowitsch PetscCheck(!(f < 0) && !(f >= ds->Nf), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be in [0, %" PetscInt_FMT ")", f, ds->Nf); 21709371c9d4SSatish Balay if (update) { 21714f572ea9SToby Isaac PetscAssertPointer(update, 3); 21729371c9d4SSatish Balay *update = ds->update[f]; 21739371c9d4SSatish Balay } 21743ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 217532d2bbc9SMatthew G. Knepley } 217632d2bbc9SMatthew G. Knepley 217732d2bbc9SMatthew G. Knepley /*@C 21783fa77dffSMatthew G. Knepley PetscDSSetUpdate - Set the pointwise update function for a given field 217932d2bbc9SMatthew G. Knepley 218020f4b53cSBarry Smith Not Collective 218132d2bbc9SMatthew G. Knepley 218232d2bbc9SMatthew G. Knepley Input Parameters: 2183dce8aebaSBarry Smith + ds - The `PetscDS` 218432d2bbc9SMatthew G. Knepley . f - The field number 218532d2bbc9SMatthew G. Knepley - update - update function 218632d2bbc9SMatthew G. Knepley 218720f4b53cSBarry Smith Calling sequence of `update`: 218832d2bbc9SMatthew G. Knepley + dim - the spatial dimension 218932d2bbc9SMatthew G. Knepley . Nf - the number of fields 2190a4e35b19SJacob Faibussowitsch . NfAux - the number of auxiliary fields 219132d2bbc9SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 219232d2bbc9SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 219332d2bbc9SMatthew G. Knepley . u - each field evaluated at the current point 219432d2bbc9SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 219532d2bbc9SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 219632d2bbc9SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 219732d2bbc9SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 219832d2bbc9SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 219932d2bbc9SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 220032d2bbc9SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 220132d2bbc9SMatthew G. Knepley . t - current time 220232d2bbc9SMatthew G. Knepley . x - coordinates of the current point 2203a4e35b19SJacob Faibussowitsch . numConstants - number of constant parameters 2204a4e35b19SJacob Faibussowitsch . constants - constant parameters 220532d2bbc9SMatthew G. Knepley - uNew - new field values at the current point 220632d2bbc9SMatthew G. Knepley 220732d2bbc9SMatthew G. Knepley Level: intermediate 220832d2bbc9SMatthew G. Knepley 2209dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSGetResidual()` 221032d2bbc9SMatthew G. Knepley @*/ 2211d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSSetUpdate(PetscDS ds, PetscInt f, void (*update)(PetscInt dim, PetscInt Nf, PetscInt NfAux, const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar uNew[])) 2212d71ae5a4SJacob Faibussowitsch { 221332d2bbc9SMatthew G. Knepley PetscFunctionBegin; 22146528b96dSMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 221532d2bbc9SMatthew G. Knepley if (update) PetscValidFunction(update, 3); 221663a3b9bcSJacob Faibussowitsch PetscCheck(f >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be non-negative", f); 22179566063dSJacob Faibussowitsch PetscCall(PetscDSEnlarge_Static(ds, f + 1)); 22186528b96dSMatthew G. Knepley ds->update[f] = update; 22193ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 222032d2bbc9SMatthew G. Knepley } 222132d2bbc9SMatthew G. Knepley 2222d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSGetContext(PetscDS ds, PetscInt f, void *ctx) 2223d71ae5a4SJacob Faibussowitsch { 22240c2f2876SMatthew G. Knepley PetscFunctionBegin; 22256528b96dSMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 222663a3b9bcSJacob Faibussowitsch PetscCheck(!(f < 0) && !(f >= ds->Nf), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be in [0, %" PetscInt_FMT ")", f, ds->Nf); 22274f572ea9SToby Isaac PetscAssertPointer(ctx, 3); 22283ec1f749SStefano Zampini *(void **)ctx = ds->ctx[f]; 22293ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 22300c2f2876SMatthew G. Knepley } 22310c2f2876SMatthew G. Knepley 2232d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSSetContext(PetscDS ds, PetscInt f, void *ctx) 2233d71ae5a4SJacob Faibussowitsch { 22340c2f2876SMatthew G. Knepley PetscFunctionBegin; 22356528b96dSMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 223663a3b9bcSJacob Faibussowitsch PetscCheck(f >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be non-negative", f); 22379566063dSJacob Faibussowitsch PetscCall(PetscDSEnlarge_Static(ds, f + 1)); 22386528b96dSMatthew G. Knepley ds->ctx[f] = ctx; 22393ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 22400c2f2876SMatthew G. Knepley } 22410c2f2876SMatthew G. Knepley 2242194d53e6SMatthew G. Knepley /*@C 2243194d53e6SMatthew G. Knepley PetscDSGetBdResidual - Get the pointwise boundary residual function for a given test field 2244194d53e6SMatthew G. Knepley 224520f4b53cSBarry Smith Not Collective 2246194d53e6SMatthew G. Knepley 2247194d53e6SMatthew G. Knepley Input Parameters: 22486528b96dSMatthew G. Knepley + ds - The PetscDS 2249194d53e6SMatthew G. Knepley - f - The test field number 2250194d53e6SMatthew G. Knepley 2251194d53e6SMatthew G. Knepley Output Parameters: 2252194d53e6SMatthew G. Knepley + f0 - boundary integrand for the test function term 2253194d53e6SMatthew G. Knepley - f1 - boundary integrand for the test function gradient term 2254194d53e6SMatthew G. Knepley 2255a4e35b19SJacob Faibussowitsch Calling sequence of `f0`: 2256194d53e6SMatthew G. Knepley + dim - the spatial dimension 2257194d53e6SMatthew G. Knepley . Nf - the number of fields 2258a4e35b19SJacob Faibussowitsch . NfAux - the number of auxiliary fields 2259194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 2260194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 2261194d53e6SMatthew G. Knepley . u - each field evaluated at the current point 2262194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 2263194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 2264194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 2265194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 2266194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 2267194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 2268194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 2269194d53e6SMatthew G. Knepley . t - current time 2270194d53e6SMatthew G. Knepley . x - coordinates of the current point 2271194d53e6SMatthew G. Knepley . n - unit normal at the current point 227297b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters 227397b6e6e8SMatthew G. Knepley . constants - constant parameters 2274194d53e6SMatthew G. Knepley - f0 - output values at the current point 2275194d53e6SMatthew G. Knepley 2276194d53e6SMatthew G. Knepley Level: intermediate 2277194d53e6SMatthew G. Knepley 2278dce8aebaSBarry Smith Note: 2279a4e35b19SJacob Faibussowitsch The calling sequence of `f1` is identical, and therefore omitted for brevity. 228060225df5SJacob Faibussowitsch 2281a4e35b19SJacob Faibussowitsch We are using a first order FEM model for the weak form\: 2282dce8aebaSBarry Smith \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 2283dce8aebaSBarry Smith 2284dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSSetBdResidual()` 2285194d53e6SMatthew G. Knepley @*/ 2286a4e35b19SJacob Faibussowitsch PetscErrorCode PetscDSGetBdResidual(PetscDS ds, PetscInt f, void (**f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux, const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], PetscReal t, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f0[]), void (**f1)(PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], PetscReal, const PetscReal[], const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[])) 2287d71ae5a4SJacob Faibussowitsch { 22886528b96dSMatthew G. Knepley PetscBdPointFunc *tmp0, *tmp1; 22896528b96dSMatthew G. Knepley PetscInt n0, n1; 22906528b96dSMatthew G. Knepley 22912764a2aaSMatthew G. Knepley PetscFunctionBegin; 22926528b96dSMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 229363a3b9bcSJacob Faibussowitsch PetscCheck(!(f < 0) && !(f >= ds->Nf), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be in [0, %" PetscInt_FMT ")", f, ds->Nf); 22949566063dSJacob Faibussowitsch PetscCall(PetscWeakFormGetBdResidual(ds->wf, NULL, 0, f, 0, &n0, &tmp0, &n1, &tmp1)); 22956528b96dSMatthew G. Knepley *f0 = tmp0 ? tmp0[0] : NULL; 22966528b96dSMatthew G. Knepley *f1 = tmp1 ? tmp1[0] : NULL; 22973ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 22982764a2aaSMatthew G. Knepley } 22992764a2aaSMatthew G. Knepley 2300194d53e6SMatthew G. Knepley /*@C 2301194d53e6SMatthew G. Knepley PetscDSSetBdResidual - Get the pointwise boundary residual function for a given test field 2302194d53e6SMatthew G. Knepley 230320f4b53cSBarry Smith Not Collective 2304194d53e6SMatthew G. Knepley 2305194d53e6SMatthew G. Knepley Input Parameters: 2306dce8aebaSBarry Smith + ds - The `PetscDS` 2307194d53e6SMatthew G. Knepley . f - The test field number 2308194d53e6SMatthew G. Knepley . f0 - boundary integrand for the test function term 2309194d53e6SMatthew G. Knepley - f1 - boundary integrand for the test function gradient term 2310194d53e6SMatthew G. Knepley 2311a4e35b19SJacob Faibussowitsch Calling sequence of `f0`: 2312194d53e6SMatthew G. Knepley + dim - the spatial dimension 2313194d53e6SMatthew G. Knepley . Nf - the number of fields 2314a4e35b19SJacob Faibussowitsch . NfAux - the number of auxiliary fields 2315194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 2316194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 2317194d53e6SMatthew G. Knepley . u - each field evaluated at the current point 2318194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 2319194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 2320194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 2321194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 2322194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 2323194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 2324194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 2325194d53e6SMatthew G. Knepley . t - current time 2326194d53e6SMatthew G. Knepley . x - coordinates of the current point 2327194d53e6SMatthew G. Knepley . n - unit normal at the current point 232897b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters 232997b6e6e8SMatthew G. Knepley . constants - constant parameters 2330194d53e6SMatthew G. Knepley - f0 - output values at the current point 2331194d53e6SMatthew G. Knepley 2332194d53e6SMatthew G. Knepley Level: intermediate 2333194d53e6SMatthew G. Knepley 2334dce8aebaSBarry Smith Note: 2335a4e35b19SJacob Faibussowitsch The calling sequence of `f1` is identical, and therefore omitted for brevity. 233660225df5SJacob Faibussowitsch 2337a4e35b19SJacob Faibussowitsch We are using a first order FEM model for the weak form\: 2338dce8aebaSBarry Smith \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 2339dce8aebaSBarry Smith 2340dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSGetBdResidual()` 2341194d53e6SMatthew G. Knepley @*/ 2342a4e35b19SJacob Faibussowitsch PetscErrorCode PetscDSSetBdResidual(PetscDS ds, PetscInt f, void (*f0)(PetscInt dim, PetscInt Nf, PetscInt NfAux, const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], PetscReal t, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f0[]), void (*f1)(PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], PetscReal, const PetscReal[], const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[])) 2343d71ae5a4SJacob Faibussowitsch { 23442764a2aaSMatthew G. Knepley PetscFunctionBegin; 23456528b96dSMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 234663a3b9bcSJacob Faibussowitsch PetscCheck(f >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be non-negative", f); 23479566063dSJacob Faibussowitsch PetscCall(PetscWeakFormSetIndexBdResidual(ds->wf, NULL, 0, f, 0, 0, f0, 0, f1)); 23483ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 23492764a2aaSMatthew G. Knepley } 23502764a2aaSMatthew G. Knepley 235127f02ce8SMatthew G. Knepley /*@ 2352dce8aebaSBarry Smith PetscDSHasBdJacobian - Indicates that boundary Jacobian functions have been set 235327f02ce8SMatthew G. Knepley 235420f4b53cSBarry Smith Not Collective 235527f02ce8SMatthew G. Knepley 235627f02ce8SMatthew G. Knepley Input Parameter: 2357dce8aebaSBarry Smith . ds - The `PetscDS` 235827f02ce8SMatthew G. Knepley 235927f02ce8SMatthew G. Knepley Output Parameter: 236027f02ce8SMatthew G. Knepley . hasBdJac - flag that pointwise function for the boundary Jacobian has been set 236127f02ce8SMatthew G. Knepley 236227f02ce8SMatthew G. Knepley Level: intermediate 236327f02ce8SMatthew G. Knepley 2364dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSHasJacobian()`, `PetscDSSetBdJacobian()`, `PetscDSGetBdJacobian()` 236527f02ce8SMatthew G. Knepley @*/ 2366d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSHasBdJacobian(PetscDS ds, PetscBool *hasBdJac) 2367d71ae5a4SJacob Faibussowitsch { 236827f02ce8SMatthew G. Knepley PetscFunctionBegin; 23696528b96dSMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 23704f572ea9SToby Isaac PetscAssertPointer(hasBdJac, 2); 23719566063dSJacob Faibussowitsch PetscCall(PetscWeakFormHasBdJacobian(ds->wf, hasBdJac)); 23723ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 237327f02ce8SMatthew G. Knepley } 237427f02ce8SMatthew G. Knepley 2375194d53e6SMatthew G. Knepley /*@C 2376194d53e6SMatthew G. Knepley PetscDSGetBdJacobian - Get the pointwise boundary Jacobian function for given test and basis field 2377194d53e6SMatthew G. Knepley 237820f4b53cSBarry Smith Not Collective 2379194d53e6SMatthew G. Knepley 2380194d53e6SMatthew G. Knepley Input Parameters: 2381dce8aebaSBarry Smith + ds - The `PetscDS` 2382194d53e6SMatthew G. Knepley . f - The test field number 2383194d53e6SMatthew G. Knepley - g - The field number 2384194d53e6SMatthew G. Knepley 2385194d53e6SMatthew G. Knepley Output Parameters: 2386194d53e6SMatthew G. Knepley + g0 - integrand for the test and basis function term 2387194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term 2388194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term 2389194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term 2390194d53e6SMatthew G. Knepley 2391a4e35b19SJacob Faibussowitsch Calling sequence of `g0`: 2392194d53e6SMatthew G. Knepley + dim - the spatial dimension 2393194d53e6SMatthew G. Knepley . Nf - the number of fields 2394a4e35b19SJacob Faibussowitsch . NfAux - the number of auxiliary fields 2395194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 2396194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 2397194d53e6SMatthew G. Knepley . u - each field evaluated at the current point 2398194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 2399194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 2400194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 2401194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 2402194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 2403194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 2404194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 2405194d53e6SMatthew G. Knepley . t - current time 24062aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t 2407194d53e6SMatthew G. Knepley . x - coordinates of the current point 2408194d53e6SMatthew G. Knepley . n - normal at the current point 240997b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters 241097b6e6e8SMatthew G. Knepley . constants - constant parameters 2411194d53e6SMatthew G. Knepley - g0 - output values at the current point 2412194d53e6SMatthew G. Knepley 2413194d53e6SMatthew G. Knepley Level: intermediate 2414194d53e6SMatthew G. Knepley 2415dce8aebaSBarry Smith Note: 2416a4e35b19SJacob Faibussowitsch `g1`, `g2`, and `g3` have identical calling sequences to `g0` and are omitted for brevity. 241760225df5SJacob Faibussowitsch 2418a4e35b19SJacob Faibussowitsch We are using a first order FEM model for the weak form\: 2419dce8aebaSBarry Smith \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 2420dce8aebaSBarry Smith 2421dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSSetBdJacobian()` 2422194d53e6SMatthew G. Knepley @*/ 2423a4e35b19SJacob Faibussowitsch PetscErrorCode PetscDSGetBdJacobian(PetscDS ds, PetscInt f, PetscInt g, void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux, const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]), void (**g1)(PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], PetscReal, PetscReal, const PetscReal[], const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]), void (**g2)(PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], PetscReal, PetscReal, const PetscReal[], const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]), void (**g3)(PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], PetscReal, PetscReal, const PetscReal[], const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[])) 2424d71ae5a4SJacob Faibussowitsch { 24256528b96dSMatthew G. Knepley PetscBdPointJac *tmp0, *tmp1, *tmp2, *tmp3; 24266528b96dSMatthew G. Knepley PetscInt n0, n1, n2, n3; 24276528b96dSMatthew G. Knepley 24282764a2aaSMatthew G. Knepley PetscFunctionBegin; 24296528b96dSMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 243063a3b9bcSJacob Faibussowitsch PetscCheck(!(f < 0) && !(f >= ds->Nf), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be in [0, %" PetscInt_FMT ")", f, ds->Nf); 243163a3b9bcSJacob Faibussowitsch PetscCheck(!(g < 0) && !(g >= ds->Nf), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be in [0, %" PetscInt_FMT ")", g, ds->Nf); 24329566063dSJacob Faibussowitsch PetscCall(PetscWeakFormGetBdJacobian(ds->wf, NULL, 0, f, g, 0, &n0, &tmp0, &n1, &tmp1, &n2, &tmp2, &n3, &tmp3)); 24336528b96dSMatthew G. Knepley *g0 = tmp0 ? tmp0[0] : NULL; 24346528b96dSMatthew G. Knepley *g1 = tmp1 ? tmp1[0] : NULL; 24356528b96dSMatthew G. Knepley *g2 = tmp2 ? tmp2[0] : NULL; 24366528b96dSMatthew G. Knepley *g3 = tmp3 ? tmp3[0] : NULL; 24373ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 24382764a2aaSMatthew G. Knepley } 24392764a2aaSMatthew G. Knepley 2440194d53e6SMatthew G. Knepley /*@C 2441194d53e6SMatthew G. Knepley PetscDSSetBdJacobian - Set the pointwise boundary Jacobian function for given test and basis field 2442194d53e6SMatthew G. Knepley 244320f4b53cSBarry Smith Not Collective 2444194d53e6SMatthew G. Knepley 2445194d53e6SMatthew G. Knepley Input Parameters: 24466528b96dSMatthew G. Knepley + ds - The PetscDS 2447194d53e6SMatthew G. Knepley . f - The test field number 2448194d53e6SMatthew G. Knepley . g - The field number 2449194d53e6SMatthew G. Knepley . g0 - integrand for the test and basis function term 2450194d53e6SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term 2451194d53e6SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term 2452194d53e6SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term 2453194d53e6SMatthew G. Knepley 2454a4e35b19SJacob Faibussowitsch Calling sequence of `g0`: 2455194d53e6SMatthew G. Knepley + dim - the spatial dimension 2456194d53e6SMatthew G. Knepley . Nf - the number of fields 2457a4e35b19SJacob Faibussowitsch . NfAux - the number of auxiliary fields 2458194d53e6SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 2459194d53e6SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 2460194d53e6SMatthew G. Knepley . u - each field evaluated at the current point 2461194d53e6SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 2462194d53e6SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 2463194d53e6SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 2464194d53e6SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 2465194d53e6SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 2466194d53e6SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 2467194d53e6SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 2468194d53e6SMatthew G. Knepley . t - current time 24692aa1fc23SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t 2470194d53e6SMatthew G. Knepley . x - coordinates of the current point 2471194d53e6SMatthew G. Knepley . n - normal at the current point 247297b6e6e8SMatthew G. Knepley . numConstants - number of constant parameters 247397b6e6e8SMatthew G. Knepley . constants - constant parameters 2474194d53e6SMatthew G. Knepley - g0 - output values at the current point 2475194d53e6SMatthew G. Knepley 2476194d53e6SMatthew G. Knepley Level: intermediate 2477194d53e6SMatthew G. Knepley 2478dce8aebaSBarry Smith Note: 2479a4e35b19SJacob Faibussowitsch `g1`, `g2`, and `g3` have identical calling sequences to `g0` and are omitted for brevity. 248060225df5SJacob Faibussowitsch 2481a4e35b19SJacob Faibussowitsch We are using a first order FEM model for the weak form\: 2482dce8aebaSBarry Smith \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 2483dce8aebaSBarry Smith 2484dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSGetBdJacobian()` 2485194d53e6SMatthew G. Knepley @*/ 2486a4e35b19SJacob Faibussowitsch PetscErrorCode PetscDSSetBdJacobian(PetscDS ds, PetscInt f, PetscInt g, void (*g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux, const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]), void (*g1)(PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], PetscReal, PetscReal, const PetscReal[], const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]), void (*g2)(PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], PetscReal, PetscReal, const PetscReal[], const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]), void (*g3)(PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], PetscReal, PetscReal, const PetscReal[], const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[])) 2487d71ae5a4SJacob Faibussowitsch { 24882764a2aaSMatthew G. Knepley PetscFunctionBegin; 24896528b96dSMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 24902764a2aaSMatthew G. Knepley if (g0) PetscValidFunction(g0, 4); 24912764a2aaSMatthew G. Knepley if (g1) PetscValidFunction(g1, 5); 24922764a2aaSMatthew G. Knepley if (g2) PetscValidFunction(g2, 6); 24932764a2aaSMatthew G. Knepley if (g3) PetscValidFunction(g3, 7); 249463a3b9bcSJacob Faibussowitsch PetscCheck(f >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be non-negative", f); 249563a3b9bcSJacob Faibussowitsch PetscCheck(g >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be non-negative", g); 24969566063dSJacob Faibussowitsch PetscCall(PetscWeakFormSetIndexBdJacobian(ds->wf, NULL, 0, f, g, 0, 0, g0, 0, g1, 0, g2, 0, g3)); 24973ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 24982764a2aaSMatthew G. Knepley } 24992764a2aaSMatthew G. Knepley 250027f02ce8SMatthew G. Knepley /*@ 250127f02ce8SMatthew G. Knepley PetscDSHasBdJacobianPreconditioner - Signals that boundary Jacobian preconditioner functions have been set 250227f02ce8SMatthew G. Knepley 250320f4b53cSBarry Smith Not Collective 250427f02ce8SMatthew G. Knepley 250527f02ce8SMatthew G. Knepley Input Parameter: 2506dce8aebaSBarry Smith . ds - The `PetscDS` 250727f02ce8SMatthew G. Knepley 250827f02ce8SMatthew G. Knepley Output Parameter: 250960225df5SJacob Faibussowitsch . hasBdJacPre - flag that pointwise function for the boundary Jacobian preconditioner has been set 251027f02ce8SMatthew G. Knepley 251127f02ce8SMatthew G. Knepley Level: intermediate 251227f02ce8SMatthew G. Knepley 2513dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSHasJacobian()`, `PetscDSSetBdJacobian()`, `PetscDSGetBdJacobian()` 251427f02ce8SMatthew G. Knepley @*/ 2515d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSHasBdJacobianPreconditioner(PetscDS ds, PetscBool *hasBdJacPre) 2516d71ae5a4SJacob Faibussowitsch { 251727f02ce8SMatthew G. Knepley PetscFunctionBegin; 25186528b96dSMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 25194f572ea9SToby Isaac PetscAssertPointer(hasBdJacPre, 2); 25209566063dSJacob Faibussowitsch PetscCall(PetscWeakFormHasBdJacobianPreconditioner(ds->wf, hasBdJacPre)); 25213ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 252227f02ce8SMatthew G. Knepley } 252327f02ce8SMatthew G. Knepley 252427f02ce8SMatthew G. Knepley /*@C 252527f02ce8SMatthew G. Knepley PetscDSGetBdJacobianPreconditioner - Get the pointwise boundary Jacobian preconditioner function for given test and basis field 252627f02ce8SMatthew G. Knepley 252720f4b53cSBarry Smith Not Collective; No Fortran Support 252827f02ce8SMatthew G. Knepley 252927f02ce8SMatthew G. Knepley Input Parameters: 2530dce8aebaSBarry Smith + ds - The `PetscDS` 253127f02ce8SMatthew G. Knepley . f - The test field number 253227f02ce8SMatthew G. Knepley - g - The field number 253327f02ce8SMatthew G. Knepley 253427f02ce8SMatthew G. Knepley Output Parameters: 253527f02ce8SMatthew G. Knepley + g0 - integrand for the test and basis function term 253627f02ce8SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term 253727f02ce8SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term 253827f02ce8SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term 253927f02ce8SMatthew G. Knepley 2540a4e35b19SJacob Faibussowitsch Calling sequence of `g0`: 254127f02ce8SMatthew G. Knepley + dim - the spatial dimension 254227f02ce8SMatthew G. Knepley . Nf - the number of fields 254327f02ce8SMatthew G. Knepley . NfAux - the number of auxiliary fields 254427f02ce8SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 254527f02ce8SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 254627f02ce8SMatthew G. Knepley . u - each field evaluated at the current point 254727f02ce8SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 254827f02ce8SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 254927f02ce8SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 255027f02ce8SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 255127f02ce8SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 255227f02ce8SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 255327f02ce8SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 255427f02ce8SMatthew G. Knepley . t - current time 255527f02ce8SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t 255627f02ce8SMatthew G. Knepley . x - coordinates of the current point 255727f02ce8SMatthew G. Knepley . n - normal at the current point 255827f02ce8SMatthew G. Knepley . numConstants - number of constant parameters 255927f02ce8SMatthew G. Knepley . constants - constant parameters 256027f02ce8SMatthew G. Knepley - g0 - output values at the current point 256127f02ce8SMatthew G. Knepley 256227f02ce8SMatthew G. Knepley Level: intermediate 256327f02ce8SMatthew G. Knepley 2564dce8aebaSBarry Smith Note: 2565a4e35b19SJacob Faibussowitsch `g1`, `g2`, and `g3` have identical calling sequences to `g0` and are omitted for brevity. 256660225df5SJacob Faibussowitsch 2567a4e35b19SJacob Faibussowitsch We are using a first order FEM model for the weak form\: 2568dce8aebaSBarry Smith \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 2569dce8aebaSBarry Smith 2570dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSSetBdJacobianPreconditioner()` 257127f02ce8SMatthew G. Knepley @*/ 2572a4e35b19SJacob Faibussowitsch PetscErrorCode PetscDSGetBdJacobianPreconditioner(PetscDS ds, PetscInt f, PetscInt g, void (**g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux, const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]), void (**g1)(PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], PetscReal, PetscReal, const PetscReal[], const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]), void (**g2)(PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], PetscReal, PetscReal, const PetscReal[], const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]), void (**g3)(PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], PetscReal, PetscReal, const PetscReal[], const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[])) 2573d71ae5a4SJacob Faibussowitsch { 25746528b96dSMatthew G. Knepley PetscBdPointJac *tmp0, *tmp1, *tmp2, *tmp3; 25756528b96dSMatthew G. Knepley PetscInt n0, n1, n2, n3; 25766528b96dSMatthew G. Knepley 257727f02ce8SMatthew G. Knepley PetscFunctionBegin; 25786528b96dSMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 257963a3b9bcSJacob Faibussowitsch PetscCheck(!(f < 0) && !(f >= ds->Nf), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be in [0, %" PetscInt_FMT ")", f, ds->Nf); 258063a3b9bcSJacob Faibussowitsch PetscCheck(!(g < 0) && !(g >= ds->Nf), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be in [0, %" PetscInt_FMT ")", g, ds->Nf); 25819566063dSJacob Faibussowitsch PetscCall(PetscWeakFormGetBdJacobianPreconditioner(ds->wf, NULL, 0, f, g, 0, &n0, &tmp0, &n1, &tmp1, &n2, &tmp2, &n3, &tmp3)); 25826528b96dSMatthew G. Knepley *g0 = tmp0 ? tmp0[0] : NULL; 25836528b96dSMatthew G. Knepley *g1 = tmp1 ? tmp1[0] : NULL; 25846528b96dSMatthew G. Knepley *g2 = tmp2 ? tmp2[0] : NULL; 25856528b96dSMatthew G. Knepley *g3 = tmp3 ? tmp3[0] : NULL; 25863ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 258727f02ce8SMatthew G. Knepley } 258827f02ce8SMatthew G. Knepley 258927f02ce8SMatthew G. Knepley /*@C 259027f02ce8SMatthew G. Knepley PetscDSSetBdJacobianPreconditioner - Set the pointwise boundary Jacobian preconditioner function for given test and basis field 259127f02ce8SMatthew G. Knepley 259220f4b53cSBarry Smith Not Collective; No Fortran Support 259327f02ce8SMatthew G. Knepley 259427f02ce8SMatthew G. Knepley Input Parameters: 2595dce8aebaSBarry Smith + ds - The `PetscDS` 259627f02ce8SMatthew G. Knepley . f - The test field number 259727f02ce8SMatthew G. Knepley . g - The field number 259827f02ce8SMatthew G. Knepley . g0 - integrand for the test and basis function term 259927f02ce8SMatthew G. Knepley . g1 - integrand for the test function and basis function gradient term 260027f02ce8SMatthew G. Knepley . g2 - integrand for the test function gradient and basis function term 260127f02ce8SMatthew G. Knepley - g3 - integrand for the test function gradient and basis function gradient term 260227f02ce8SMatthew G. Knepley 2603a4e35b19SJacob Faibussowitsch Calling sequence of `g0': 260427f02ce8SMatthew G. Knepley + dim - the spatial dimension 260527f02ce8SMatthew G. Knepley . Nf - the number of fields 260627f02ce8SMatthew G. Knepley . NfAux - the number of auxiliary fields 260727f02ce8SMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 260827f02ce8SMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 260927f02ce8SMatthew G. Knepley . u - each field evaluated at the current point 261027f02ce8SMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 261127f02ce8SMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 261227f02ce8SMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 261327f02ce8SMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 261427f02ce8SMatthew G. Knepley . a - each auxiliary field evaluated at the current point 261527f02ce8SMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 261627f02ce8SMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 261727f02ce8SMatthew G. Knepley . t - current time 261827f02ce8SMatthew G. Knepley . u_tShift - the multiplier a for dF/dU_t 261927f02ce8SMatthew G. Knepley . x - coordinates of the current point 262027f02ce8SMatthew G. Knepley . n - normal at the current point 262127f02ce8SMatthew G. Knepley . numConstants - number of constant parameters 262227f02ce8SMatthew G. Knepley . constants - constant parameters 262327f02ce8SMatthew G. Knepley - g0 - output values at the current point 262427f02ce8SMatthew G. Knepley 262527f02ce8SMatthew G. Knepley Level: intermediate 262627f02ce8SMatthew G. Knepley 2627dce8aebaSBarry Smith Note: 2628a4e35b19SJacob Faibussowitsch `g1`, `g2`, and `g3` have identical calling sequences to `g0` and are omitted for brevity. 262960225df5SJacob Faibussowitsch 2630a4e35b19SJacob Faibussowitsch We are using a first order FEM model for the weak form\: 2631dce8aebaSBarry Smith \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 2632dce8aebaSBarry Smith 2633dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSGetBdJacobianPreconditioner()` 263427f02ce8SMatthew G. Knepley @*/ 2635a4e35b19SJacob Faibussowitsch PetscErrorCode PetscDSSetBdJacobianPreconditioner(PetscDS ds, PetscInt f, PetscInt g, void (*g0)(PetscInt dim, PetscInt Nf, PetscInt NfAux, const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], PetscReal t, PetscReal u_tShift, const PetscReal x[], const PetscReal n[], PetscInt numConstants, const PetscScalar constants[], PetscScalar g0[]), void (*g1)(PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], PetscReal, PetscReal, const PetscReal[], const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]), void (*g2)(PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], PetscReal, PetscReal, const PetscReal[], const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]), void (*g3)(PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], PetscReal, PetscReal, const PetscReal[], const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[])) 2636d71ae5a4SJacob Faibussowitsch { 263727f02ce8SMatthew G. Knepley PetscFunctionBegin; 26386528b96dSMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 263927f02ce8SMatthew G. Knepley if (g0) PetscValidFunction(g0, 4); 264027f02ce8SMatthew G. Knepley if (g1) PetscValidFunction(g1, 5); 264127f02ce8SMatthew G. Knepley if (g2) PetscValidFunction(g2, 6); 264227f02ce8SMatthew G. Knepley if (g3) PetscValidFunction(g3, 7); 264363a3b9bcSJacob Faibussowitsch PetscCheck(f >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be non-negative", f); 264463a3b9bcSJacob Faibussowitsch PetscCheck(g >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be non-negative", g); 26459566063dSJacob Faibussowitsch PetscCall(PetscWeakFormSetIndexBdJacobianPreconditioner(ds->wf, NULL, 0, f, g, 0, 0, g0, 0, g1, 0, g2, 0, g3)); 26463ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 264727f02ce8SMatthew G. Knepley } 264827f02ce8SMatthew G. Knepley 26490d3e9b51SMatthew G. Knepley /*@C 2650c371a6d1SMatthew G. Knepley PetscDSGetExactSolution - Get the pointwise exact solution function for a given test field 2651c371a6d1SMatthew G. Knepley 265220f4b53cSBarry Smith Not Collective 2653c371a6d1SMatthew G. Knepley 2654c371a6d1SMatthew G. Knepley Input Parameters: 2655c371a6d1SMatthew G. Knepley + prob - The PetscDS 2656c371a6d1SMatthew G. Knepley - f - The test field number 2657c371a6d1SMatthew G. Knepley 2658d8d19677SJose E. Roman Output Parameters: 2659a4e35b19SJacob Faibussowitsch + sol - exact solution for the test field 2660a4e35b19SJacob Faibussowitsch - ctx - exact solution context 2661c371a6d1SMatthew G. Knepley 266220f4b53cSBarry Smith Calling sequence of `exactSol`: 2663c371a6d1SMatthew G. Knepley + dim - the spatial dimension 2664c371a6d1SMatthew G. Knepley . t - current time 2665c371a6d1SMatthew G. Knepley . x - coordinates of the current point 2666c371a6d1SMatthew G. Knepley . Nc - the number of field components 2667a4e35b19SJacob Faibussowitsch . u - the solution field evaluated at the current point 2668c371a6d1SMatthew G. Knepley - ctx - a user context 2669c371a6d1SMatthew G. Knepley 2670c371a6d1SMatthew G. Knepley Level: intermediate 2671c371a6d1SMatthew G. Knepley 2672dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSSetExactSolution()`, `PetscDSGetExactSolutionTimeDerivative()` 2673c371a6d1SMatthew G. Knepley @*/ 2674d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSGetExactSolution(PetscDS prob, PetscInt f, PetscErrorCode (**sol)(PetscInt dim, PetscReal t, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx), void **ctx) 2675d71ae5a4SJacob Faibussowitsch { 2676c371a6d1SMatthew G. Knepley PetscFunctionBegin; 2677c371a6d1SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 267863a3b9bcSJacob Faibussowitsch PetscCheck(!(f < 0) && !(f >= prob->Nf), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be in [0, %" PetscInt_FMT ")", f, prob->Nf); 26799371c9d4SSatish Balay if (sol) { 26804f572ea9SToby Isaac PetscAssertPointer(sol, 3); 26819371c9d4SSatish Balay *sol = prob->exactSol[f]; 26829371c9d4SSatish Balay } 26839371c9d4SSatish Balay if (ctx) { 26844f572ea9SToby Isaac PetscAssertPointer(ctx, 4); 26859371c9d4SSatish Balay *ctx = prob->exactCtx[f]; 26869371c9d4SSatish Balay } 26873ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2688c371a6d1SMatthew G. Knepley } 2689c371a6d1SMatthew G. Knepley 2690c371a6d1SMatthew G. Knepley /*@C 2691578a5ef5SMatthew Knepley PetscDSSetExactSolution - Set the pointwise exact solution function for a given test field 2692c371a6d1SMatthew G. Knepley 269320f4b53cSBarry Smith Not Collective 2694c371a6d1SMatthew G. Knepley 2695c371a6d1SMatthew G. Knepley Input Parameters: 2696dce8aebaSBarry Smith + prob - The `PetscDS` 2697c371a6d1SMatthew G. Knepley . f - The test field number 269895cbbfd3SMatthew G. Knepley . sol - solution function for the test fields 269920f4b53cSBarry Smith - ctx - solution context or `NULL` 2700c371a6d1SMatthew G. Knepley 270120f4b53cSBarry Smith Calling sequence of `sol`: 2702c371a6d1SMatthew G. Knepley + dim - the spatial dimension 2703c371a6d1SMatthew G. Knepley . t - current time 2704c371a6d1SMatthew G. Knepley . x - coordinates of the current point 2705c371a6d1SMatthew G. Knepley . Nc - the number of field components 2706c371a6d1SMatthew G. Knepley . u - the solution field evaluated at the current point 2707c371a6d1SMatthew G. Knepley - ctx - a user context 2708c371a6d1SMatthew G. Knepley 2709c371a6d1SMatthew G. Knepley Level: intermediate 2710c371a6d1SMatthew G. Knepley 2711dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSGetExactSolution()` 2712c371a6d1SMatthew G. Knepley @*/ 2713d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSSetExactSolution(PetscDS prob, PetscInt f, PetscErrorCode (*sol)(PetscInt dim, PetscReal t, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx), void *ctx) 2714d71ae5a4SJacob Faibussowitsch { 2715c371a6d1SMatthew G. Knepley PetscFunctionBegin; 2716c371a6d1SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 271763a3b9bcSJacob Faibussowitsch PetscCheck(f >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be non-negative", f); 27189566063dSJacob Faibussowitsch PetscCall(PetscDSEnlarge_Static(prob, f + 1)); 27199371c9d4SSatish Balay if (sol) { 27209371c9d4SSatish Balay PetscValidFunction(sol, 3); 27219371c9d4SSatish Balay prob->exactSol[f] = sol; 27229371c9d4SSatish Balay } 27239371c9d4SSatish Balay if (ctx) { 27249371c9d4SSatish Balay PetscValidFunction(ctx, 4); 27259371c9d4SSatish Balay prob->exactCtx[f] = ctx; 27269371c9d4SSatish Balay } 27273ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2728c371a6d1SMatthew G. Knepley } 2729c371a6d1SMatthew G. Knepley 27305638fd0eSMatthew G. Knepley /*@C 2731f2cacb80SMatthew G. Knepley PetscDSGetExactSolutionTimeDerivative - Get the pointwise time derivative of the exact solution function for a given test field 2732f2cacb80SMatthew G. Knepley 273320f4b53cSBarry Smith Not Collective 2734f2cacb80SMatthew G. Knepley 2735f2cacb80SMatthew G. Knepley Input Parameters: 2736dce8aebaSBarry Smith + prob - The `PetscDS` 2737f2cacb80SMatthew G. Knepley - f - The test field number 2738f2cacb80SMatthew G. Knepley 2739d8d19677SJose E. Roman Output Parameters: 2740a4e35b19SJacob Faibussowitsch + sol - time derivative of the exact solution for the test field 2741a4e35b19SJacob Faibussowitsch - ctx - time derivative of the exact solution context 2742f2cacb80SMatthew G. Knepley 274320f4b53cSBarry Smith Calling sequence of `exactSol`: 2744f2cacb80SMatthew G. Knepley + dim - the spatial dimension 2745f2cacb80SMatthew G. Knepley . t - current time 2746f2cacb80SMatthew G. Knepley . x - coordinates of the current point 2747f2cacb80SMatthew G. Knepley . Nc - the number of field components 2748a4e35b19SJacob Faibussowitsch . u - the solution field evaluated at the current point 2749f2cacb80SMatthew G. Knepley - ctx - a user context 2750f2cacb80SMatthew G. Knepley 2751f2cacb80SMatthew G. Knepley Level: intermediate 2752f2cacb80SMatthew G. Knepley 2753dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSSetExactSolutionTimeDerivative()`, `PetscDSGetExactSolution()` 2754f2cacb80SMatthew G. Knepley @*/ 2755d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSGetExactSolutionTimeDerivative(PetscDS prob, PetscInt f, PetscErrorCode (**sol)(PetscInt dim, PetscReal t, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx), void **ctx) 2756d71ae5a4SJacob Faibussowitsch { 2757f2cacb80SMatthew G. Knepley PetscFunctionBegin; 2758f2cacb80SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 275963a3b9bcSJacob Faibussowitsch PetscCheck(!(f < 0) && !(f >= prob->Nf), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be in [0, %" PetscInt_FMT ")", f, prob->Nf); 27609371c9d4SSatish Balay if (sol) { 27614f572ea9SToby Isaac PetscAssertPointer(sol, 3); 27629371c9d4SSatish Balay *sol = prob->exactSol_t[f]; 27639371c9d4SSatish Balay } 27649371c9d4SSatish Balay if (ctx) { 27654f572ea9SToby Isaac PetscAssertPointer(ctx, 4); 27669371c9d4SSatish Balay *ctx = prob->exactCtx_t[f]; 27679371c9d4SSatish Balay } 27683ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2769f2cacb80SMatthew G. Knepley } 2770f2cacb80SMatthew G. Knepley 2771f2cacb80SMatthew G. Knepley /*@C 2772f2cacb80SMatthew G. Knepley PetscDSSetExactSolutionTimeDerivative - Set the pointwise time derivative of the exact solution function for a given test field 2773f2cacb80SMatthew G. Knepley 277420f4b53cSBarry Smith Not Collective 2775f2cacb80SMatthew G. Knepley 2776f2cacb80SMatthew G. Knepley Input Parameters: 2777dce8aebaSBarry Smith + prob - The `PetscDS` 2778f2cacb80SMatthew G. Knepley . f - The test field number 2779f2cacb80SMatthew G. Knepley . sol - time derivative of the solution function for the test fields 278020f4b53cSBarry Smith - ctx - time derivative of the solution context or `NULL` 2781f2cacb80SMatthew G. Knepley 278220f4b53cSBarry Smith Calling sequence of `sol`: 2783f2cacb80SMatthew G. Knepley + dim - the spatial dimension 2784f2cacb80SMatthew G. Knepley . t - current time 2785f2cacb80SMatthew G. Knepley . x - coordinates of the current point 2786f2cacb80SMatthew G. Knepley . Nc - the number of field components 2787f2cacb80SMatthew G. Knepley . u - the solution field evaluated at the current point 2788f2cacb80SMatthew G. Knepley - ctx - a user context 2789f2cacb80SMatthew G. Knepley 2790f2cacb80SMatthew G. Knepley Level: intermediate 2791f2cacb80SMatthew G. Knepley 2792dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSGetExactSolutionTimeDerivative()`, `PetscDSSetExactSolution()` 2793f2cacb80SMatthew G. Knepley @*/ 2794d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSSetExactSolutionTimeDerivative(PetscDS prob, PetscInt f, PetscErrorCode (*sol)(PetscInt dim, PetscReal t, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx), void *ctx) 2795d71ae5a4SJacob Faibussowitsch { 2796f2cacb80SMatthew G. Knepley PetscFunctionBegin; 2797f2cacb80SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 279863a3b9bcSJacob Faibussowitsch PetscCheck(f >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be non-negative", f); 27999566063dSJacob Faibussowitsch PetscCall(PetscDSEnlarge_Static(prob, f + 1)); 28009371c9d4SSatish Balay if (sol) { 28019371c9d4SSatish Balay PetscValidFunction(sol, 3); 28029371c9d4SSatish Balay prob->exactSol_t[f] = sol; 28039371c9d4SSatish Balay } 28049371c9d4SSatish Balay if (ctx) { 28059371c9d4SSatish Balay PetscValidFunction(ctx, 4); 28069371c9d4SSatish Balay prob->exactCtx_t[f] = ctx; 28079371c9d4SSatish Balay } 28083ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2809f2cacb80SMatthew G. Knepley } 2810f2cacb80SMatthew G. Knepley 2811f2cacb80SMatthew G. Knepley /*@C 281297b6e6e8SMatthew G. Knepley PetscDSGetConstants - Returns the array of constants passed to point functions 281397b6e6e8SMatthew G. Knepley 281420f4b53cSBarry Smith Not Collective 281597b6e6e8SMatthew G. Knepley 281697b6e6e8SMatthew G. Knepley Input Parameter: 2817*a102dd69SStefano Zampini . ds - The `PetscDS` object 281897b6e6e8SMatthew G. Knepley 281997b6e6e8SMatthew G. Knepley Output Parameters: 282097b6e6e8SMatthew G. Knepley + numConstants - The number of constants 282197b6e6e8SMatthew G. Knepley - constants - The array of constants, NULL if there are none 282297b6e6e8SMatthew G. Knepley 282397b6e6e8SMatthew G. Knepley Level: intermediate 282497b6e6e8SMatthew G. Knepley 2825dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSSetConstants()`, `PetscDSCreate()` 282697b6e6e8SMatthew G. Knepley @*/ 2827*a102dd69SStefano Zampini PetscErrorCode PetscDSGetConstants(PetscDS ds, PetscInt *numConstants, const PetscScalar *constants[]) 2828d71ae5a4SJacob Faibussowitsch { 282997b6e6e8SMatthew G. Knepley PetscFunctionBegin; 2830*a102dd69SStefano Zampini PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 28319371c9d4SSatish Balay if (numConstants) { 28324f572ea9SToby Isaac PetscAssertPointer(numConstants, 2); 2833*a102dd69SStefano Zampini *numConstants = ds->numConstants; 28349371c9d4SSatish Balay } 28359371c9d4SSatish Balay if (constants) { 28364f572ea9SToby Isaac PetscAssertPointer(constants, 3); 2837*a102dd69SStefano Zampini *constants = ds->constants; 28389371c9d4SSatish Balay } 28393ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 284097b6e6e8SMatthew G. Knepley } 284197b6e6e8SMatthew G. Knepley 28420d3e9b51SMatthew G. Knepley /*@C 284397b6e6e8SMatthew G. Knepley PetscDSSetConstants - Set the array of constants passed to point functions 284497b6e6e8SMatthew G. Knepley 284520f4b53cSBarry Smith Not Collective 284697b6e6e8SMatthew G. Knepley 284797b6e6e8SMatthew G. Knepley Input Parameters: 2848*a102dd69SStefano Zampini + ds - The `PetscDS` object 284997b6e6e8SMatthew G. Knepley . numConstants - The number of constants 2850a3b724e8SBarry Smith - constants - The array of constants, `NULL` if there are none 285197b6e6e8SMatthew G. Knepley 285297b6e6e8SMatthew G. Knepley Level: intermediate 285397b6e6e8SMatthew G. Knepley 2854dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSGetConstants()`, `PetscDSCreate()` 285597b6e6e8SMatthew G. Knepley @*/ 2856*a102dd69SStefano Zampini PetscErrorCode PetscDSSetConstants(PetscDS ds, PetscInt numConstants, PetscScalar constants[]) 2857d71ae5a4SJacob Faibussowitsch { 285897b6e6e8SMatthew G. Knepley PetscFunctionBegin; 2859*a102dd69SStefano Zampini PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 2860*a102dd69SStefano Zampini if (numConstants != ds->numConstants) { 2861*a102dd69SStefano Zampini PetscCall(PetscFree(ds->constants)); 2862*a102dd69SStefano Zampini ds->numConstants = numConstants; 2863*a102dd69SStefano Zampini if (ds->numConstants) { 2864*a102dd69SStefano Zampini PetscCall(PetscMalloc1(ds->numConstants + ds->numFuncConstants, &ds->constants)); 286520be0f5bSMatthew G. Knepley } else { 2866*a102dd69SStefano Zampini ds->constants = NULL; 286720be0f5bSMatthew G. Knepley } 286820be0f5bSMatthew G. Knepley } 2869*a102dd69SStefano Zampini if (ds->numConstants) { 28704f572ea9SToby Isaac PetscAssertPointer(constants, 3); 2871*a102dd69SStefano Zampini PetscCall(PetscArraycpy(ds->constants, constants, ds->numConstants)); 287297b6e6e8SMatthew G. Knepley } 28733ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 287497b6e6e8SMatthew G. Knepley } 287597b6e6e8SMatthew G. Knepley 2876*a102dd69SStefano Zampini /*@C 2877*a102dd69SStefano Zampini PetscDSSetIntegrationParameters - Set the parameters for a particular integration 2878*a102dd69SStefano Zampini 2879*a102dd69SStefano Zampini Not Collective 2880*a102dd69SStefano Zampini 2881*a102dd69SStefano Zampini Input Parameters: 2882*a102dd69SStefano Zampini + ds - The `PetscDS` object 2883*a102dd69SStefano Zampini . fieldI - The test field for a given point function, or PETSC_DETERMINE 2884*a102dd69SStefano Zampini - fieldJ - The basis field for a given point function, or PETSC_DETERMINE 2885*a102dd69SStefano Zampini 2886*a102dd69SStefano Zampini Level: intermediate 2887*a102dd69SStefano Zampini 2888*a102dd69SStefano Zampini .seealso: `PetscDS`, `PetscDSSetConstants()`, `PetscDSGetConstants()`, `PetscDSCreate()` 2889*a102dd69SStefano Zampini @*/ 2890*a102dd69SStefano Zampini PetscErrorCode PetscDSSetIntegrationParameters(PetscDS ds, PetscInt fieldI, PetscInt fieldJ) 2891*a102dd69SStefano Zampini { 2892*a102dd69SStefano Zampini PetscFunctionBegin; 2893*a102dd69SStefano Zampini PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 2894*a102dd69SStefano Zampini ds->constants[ds->numConstants] = fieldI; 2895*a102dd69SStefano Zampini ds->constants[ds->numConstants + 1] = fieldJ; 2896*a102dd69SStefano Zampini PetscFunctionReturn(PETSC_SUCCESS); 2897*a102dd69SStefano Zampini } 2898*a102dd69SStefano Zampini 28994cd1e086SMatthew G. Knepley /*@ 29004cd1e086SMatthew G. Knepley PetscDSGetFieldIndex - Returns the index of the given field 29014cd1e086SMatthew G. Knepley 290220f4b53cSBarry Smith Not Collective 29034cd1e086SMatthew G. Knepley 29044cd1e086SMatthew G. Knepley Input Parameters: 2905dce8aebaSBarry Smith + prob - The `PetscDS` object 29064cd1e086SMatthew G. Knepley - disc - The discretization object 29074cd1e086SMatthew G. Knepley 29084cd1e086SMatthew G. Knepley Output Parameter: 29094cd1e086SMatthew G. Knepley . f - The field number 29104cd1e086SMatthew G. Knepley 29114cd1e086SMatthew G. Knepley Level: beginner 29124cd1e086SMatthew G. Knepley 2913dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscGetDiscretization()`, `PetscDSGetNumFields()`, `PetscDSCreate()` 29144cd1e086SMatthew G. Knepley @*/ 2915d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSGetFieldIndex(PetscDS prob, PetscObject disc, PetscInt *f) 2916d71ae5a4SJacob Faibussowitsch { 29174cd1e086SMatthew G. Knepley PetscInt g; 29184cd1e086SMatthew G. Knepley 29194cd1e086SMatthew G. Knepley PetscFunctionBegin; 29204cd1e086SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 29214f572ea9SToby Isaac PetscAssertPointer(f, 3); 29224cd1e086SMatthew G. Knepley *f = -1; 29239371c9d4SSatish Balay for (g = 0; g < prob->Nf; ++g) { 29249371c9d4SSatish Balay if (disc == prob->disc[g]) break; 29259371c9d4SSatish Balay } 292608401ef6SPierre Jolivet PetscCheck(g != prob->Nf, PetscObjectComm((PetscObject)prob), PETSC_ERR_ARG_WRONG, "Field not found in PetscDS."); 29274cd1e086SMatthew G. Knepley *f = g; 29283ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 29294cd1e086SMatthew G. Knepley } 29304cd1e086SMatthew G. Knepley 29314cd1e086SMatthew G. Knepley /*@ 29324cd1e086SMatthew G. Knepley PetscDSGetFieldSize - Returns the size of the given field in the full space basis 29334cd1e086SMatthew G. Knepley 293420f4b53cSBarry Smith Not Collective 29354cd1e086SMatthew G. Knepley 29364cd1e086SMatthew G. Knepley Input Parameters: 2937dce8aebaSBarry Smith + prob - The `PetscDS` object 29384cd1e086SMatthew G. Knepley - f - The field number 29394cd1e086SMatthew G. Knepley 29404cd1e086SMatthew G. Knepley Output Parameter: 29414cd1e086SMatthew G. Knepley . size - The size 29424cd1e086SMatthew G. Knepley 29434cd1e086SMatthew G. Knepley Level: beginner 29444cd1e086SMatthew G. Knepley 2945dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSGetFieldOffset()`, `PetscDSGetNumFields()`, `PetscDSCreate()` 29464cd1e086SMatthew G. Knepley @*/ 2947d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSGetFieldSize(PetscDS prob, PetscInt f, PetscInt *size) 2948d71ae5a4SJacob Faibussowitsch { 29494cd1e086SMatthew G. Knepley PetscFunctionBegin; 29504cd1e086SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 29514f572ea9SToby Isaac PetscAssertPointer(size, 3); 295263a3b9bcSJacob Faibussowitsch PetscCheck(!(f < 0) && !(f >= prob->Nf), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be in [0, %" PetscInt_FMT ")", f, prob->Nf); 29539566063dSJacob Faibussowitsch PetscCall(PetscDSSetUp(prob)); 2954d4742ddaSMatthew G. Knepley *size = prob->Nb[f]; 29553ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 29564cd1e086SMatthew G. Knepley } 29574cd1e086SMatthew G. Knepley 2958bc4ae4beSMatthew G. Knepley /*@ 2959bc4ae4beSMatthew G. Knepley PetscDSGetFieldOffset - Returns the offset of the given field in the full space basis 2960bc4ae4beSMatthew G. Knepley 296120f4b53cSBarry Smith Not Collective 2962bc4ae4beSMatthew G. Knepley 2963bc4ae4beSMatthew G. Knepley Input Parameters: 2964dce8aebaSBarry Smith + prob - The `PetscDS` object 2965bc4ae4beSMatthew G. Knepley - f - The field number 2966bc4ae4beSMatthew G. Knepley 2967bc4ae4beSMatthew G. Knepley Output Parameter: 2968bc4ae4beSMatthew G. Knepley . off - The offset 2969bc4ae4beSMatthew G. Knepley 2970bc4ae4beSMatthew G. Knepley Level: beginner 2971bc4ae4beSMatthew G. Knepley 2972dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSGetFieldSize()`, `PetscDSGetNumFields()`, `PetscDSCreate()` 2973bc4ae4beSMatthew G. Knepley @*/ 2974d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSGetFieldOffset(PetscDS prob, PetscInt f, PetscInt *off) 2975d71ae5a4SJacob Faibussowitsch { 29764cd1e086SMatthew G. Knepley PetscInt size, g; 29772764a2aaSMatthew G. Knepley 29782764a2aaSMatthew G. Knepley PetscFunctionBegin; 29792764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 29804f572ea9SToby Isaac PetscAssertPointer(off, 3); 298163a3b9bcSJacob Faibussowitsch PetscCheck(!(f < 0) && !(f >= prob->Nf), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be in [0, %" PetscInt_FMT ")", f, prob->Nf); 29822764a2aaSMatthew G. Knepley *off = 0; 29832764a2aaSMatthew G. Knepley for (g = 0; g < f; ++g) { 29849566063dSJacob Faibussowitsch PetscCall(PetscDSGetFieldSize(prob, g, &size)); 29854cd1e086SMatthew G. Knepley *off += size; 29862764a2aaSMatthew G. Knepley } 29873ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 29882764a2aaSMatthew G. Knepley } 29892764a2aaSMatthew G. Knepley 2990bc4ae4beSMatthew G. Knepley /*@ 29915fedec97SMatthew G. Knepley PetscDSGetFieldOffsetCohesive - Returns the offset of the given field in the full space basis on a cohesive cell 29925fedec97SMatthew G. Knepley 299320f4b53cSBarry Smith Not Collective 29945fedec97SMatthew G. Knepley 29955fedec97SMatthew G. Knepley Input Parameters: 299660225df5SJacob Faibussowitsch + ds - The `PetscDS` object 29975fedec97SMatthew G. Knepley - f - The field number 29985fedec97SMatthew G. Knepley 29995fedec97SMatthew G. Knepley Output Parameter: 30005fedec97SMatthew G. Knepley . off - The offset 30015fedec97SMatthew G. Knepley 30025fedec97SMatthew G. Knepley Level: beginner 30035fedec97SMatthew G. Knepley 3004dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSGetFieldSize()`, `PetscDSGetNumFields()`, `PetscDSCreate()` 30055fedec97SMatthew G. Knepley @*/ 3006d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSGetFieldOffsetCohesive(PetscDS ds, PetscInt f, PetscInt *off) 3007d71ae5a4SJacob Faibussowitsch { 30085fedec97SMatthew G. Knepley PetscInt size, g; 30095fedec97SMatthew G. Knepley 30105fedec97SMatthew G. Knepley PetscFunctionBegin; 30115fedec97SMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 30124f572ea9SToby Isaac PetscAssertPointer(off, 3); 301363a3b9bcSJacob Faibussowitsch PetscCheck(!(f < 0) && !(f >= ds->Nf), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be in [0, %" PetscInt_FMT ")", f, ds->Nf); 30145fedec97SMatthew G. Knepley *off = 0; 30155fedec97SMatthew G. Knepley for (g = 0; g < f; ++g) { 30165fedec97SMatthew G. Knepley PetscBool cohesive; 30175fedec97SMatthew G. Knepley 30189566063dSJacob Faibussowitsch PetscCall(PetscDSGetCohesive(ds, g, &cohesive)); 30199566063dSJacob Faibussowitsch PetscCall(PetscDSGetFieldSize(ds, g, &size)); 30205fedec97SMatthew G. Knepley *off += cohesive ? size : size * 2; 30215fedec97SMatthew G. Knepley } 30223ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 30235fedec97SMatthew G. Knepley } 30245fedec97SMatthew G. Knepley 30255fedec97SMatthew G. Knepley /*@ 302647e57110SSander Arens PetscDSGetDimensions - Returns the size of the approximation space for each field on an evaluation point 3027bc4ae4beSMatthew G. Knepley 302820f4b53cSBarry Smith Not Collective 3029bc4ae4beSMatthew G. Knepley 303047e57110SSander Arens Input Parameter: 3031dce8aebaSBarry Smith . prob - The `PetscDS` object 3032bc4ae4beSMatthew G. Knepley 3033bc4ae4beSMatthew G. Knepley Output Parameter: 303447e57110SSander Arens . dimensions - The number of dimensions 3035bc4ae4beSMatthew G. Knepley 3036bc4ae4beSMatthew G. Knepley Level: beginner 3037bc4ae4beSMatthew G. Knepley 3038dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSGetComponentOffsets()`, `PetscDSGetNumFields()`, `PetscDSCreate()` 3039bc4ae4beSMatthew G. Knepley @*/ 3040d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSGetDimensions(PetscDS prob, PetscInt *dimensions[]) 3041d71ae5a4SJacob Faibussowitsch { 30422764a2aaSMatthew G. Knepley PetscFunctionBegin; 30432764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 30449566063dSJacob Faibussowitsch PetscCall(PetscDSSetUp(prob)); 30454f572ea9SToby Isaac PetscAssertPointer(dimensions, 2); 304647e57110SSander Arens *dimensions = prob->Nb; 30473ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 30486ce16762SMatthew G. Knepley } 304947e57110SSander Arens 305047e57110SSander Arens /*@ 305147e57110SSander Arens PetscDSGetComponents - Returns the number of components for each field on an evaluation point 305247e57110SSander Arens 305320f4b53cSBarry Smith Not Collective 305447e57110SSander Arens 305547e57110SSander Arens Input Parameter: 3056dce8aebaSBarry Smith . prob - The `PetscDS` object 305747e57110SSander Arens 305847e57110SSander Arens Output Parameter: 305947e57110SSander Arens . components - The number of components 306047e57110SSander Arens 306147e57110SSander Arens Level: beginner 306247e57110SSander Arens 3063dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSGetComponentOffsets()`, `PetscDSGetNumFields()`, `PetscDSCreate()` 306447e57110SSander Arens @*/ 3065d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSGetComponents(PetscDS prob, PetscInt *components[]) 3066d71ae5a4SJacob Faibussowitsch { 306747e57110SSander Arens PetscFunctionBegin; 306847e57110SSander Arens PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 30699566063dSJacob Faibussowitsch PetscCall(PetscDSSetUp(prob)); 30704f572ea9SToby Isaac PetscAssertPointer(components, 2); 307147e57110SSander Arens *components = prob->Nc; 30723ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 30736ce16762SMatthew G. Knepley } 30746ce16762SMatthew G. Knepley 30756ce16762SMatthew G. Knepley /*@ 30766ce16762SMatthew G. Knepley PetscDSGetComponentOffset - Returns the offset of the given field on an evaluation point 30776ce16762SMatthew G. Knepley 307820f4b53cSBarry Smith Not Collective 30796ce16762SMatthew G. Knepley 30806ce16762SMatthew G. Knepley Input Parameters: 3081dce8aebaSBarry Smith + prob - The `PetscDS` object 30826ce16762SMatthew G. Knepley - f - The field number 30836ce16762SMatthew G. Knepley 30846ce16762SMatthew G. Knepley Output Parameter: 30856ce16762SMatthew G. Knepley . off - The offset 30866ce16762SMatthew G. Knepley 30876ce16762SMatthew G. Knepley Level: beginner 30886ce16762SMatthew G. Knepley 3089dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSGetNumFields()`, `PetscDSCreate()` 30906ce16762SMatthew G. Knepley @*/ 3091d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSGetComponentOffset(PetscDS prob, PetscInt f, PetscInt *off) 3092d71ae5a4SJacob Faibussowitsch { 30936ce16762SMatthew G. Knepley PetscFunctionBegin; 30946ce16762SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 30954f572ea9SToby Isaac PetscAssertPointer(off, 3); 309663a3b9bcSJacob Faibussowitsch PetscCheck(!(f < 0) && !(f >= prob->Nf), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be in [0, %" PetscInt_FMT ")", f, prob->Nf); 30979566063dSJacob Faibussowitsch PetscCall(PetscDSSetUp(prob)); 309847e57110SSander Arens *off = prob->off[f]; 30993ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 31002764a2aaSMatthew G. Knepley } 31012764a2aaSMatthew G. Knepley 3102194d53e6SMatthew G. Knepley /*@ 3103194d53e6SMatthew G. Knepley PetscDSGetComponentOffsets - Returns the offset of each field on an evaluation point 3104194d53e6SMatthew G. Knepley 310520f4b53cSBarry Smith Not Collective 3106194d53e6SMatthew G. Knepley 3107194d53e6SMatthew G. Knepley Input Parameter: 3108dce8aebaSBarry Smith . prob - The `PetscDS` object 3109194d53e6SMatthew G. Knepley 3110194d53e6SMatthew G. Knepley Output Parameter: 3111194d53e6SMatthew G. Knepley . offsets - The offsets 3112194d53e6SMatthew G. Knepley 3113194d53e6SMatthew G. Knepley Level: beginner 3114194d53e6SMatthew G. Knepley 3115dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSGetNumFields()`, `PetscDSCreate()` 3116194d53e6SMatthew G. Knepley @*/ 3117d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSGetComponentOffsets(PetscDS prob, PetscInt *offsets[]) 3118d71ae5a4SJacob Faibussowitsch { 3119194d53e6SMatthew G. Knepley PetscFunctionBegin; 3120194d53e6SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 31214f572ea9SToby Isaac PetscAssertPointer(offsets, 2); 31229566063dSJacob Faibussowitsch PetscCall(PetscDSSetUp(prob)); 3123194d53e6SMatthew G. Knepley *offsets = prob->off; 31243ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 3125194d53e6SMatthew G. Knepley } 3126194d53e6SMatthew G. Knepley 3127194d53e6SMatthew G. Knepley /*@ 3128194d53e6SMatthew G. Knepley PetscDSGetComponentDerivativeOffsets - Returns the offset of each field derivative on an evaluation point 3129194d53e6SMatthew G. Knepley 313020f4b53cSBarry Smith Not Collective 3131194d53e6SMatthew G. Knepley 3132194d53e6SMatthew G. Knepley Input Parameter: 3133dce8aebaSBarry Smith . prob - The `PetscDS` object 3134194d53e6SMatthew G. Knepley 3135194d53e6SMatthew G. Knepley Output Parameter: 3136194d53e6SMatthew G. Knepley . offsets - The offsets 3137194d53e6SMatthew G. Knepley 3138194d53e6SMatthew G. Knepley Level: beginner 3139194d53e6SMatthew G. Knepley 3140dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSGetNumFields()`, `PetscDSCreate()` 3141194d53e6SMatthew G. Knepley @*/ 3142d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSGetComponentDerivativeOffsets(PetscDS prob, PetscInt *offsets[]) 3143d71ae5a4SJacob Faibussowitsch { 3144194d53e6SMatthew G. Knepley PetscFunctionBegin; 3145194d53e6SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 31464f572ea9SToby Isaac PetscAssertPointer(offsets, 2); 31479566063dSJacob Faibussowitsch PetscCall(PetscDSSetUp(prob)); 3148194d53e6SMatthew G. Knepley *offsets = prob->offDer; 31493ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 3150194d53e6SMatthew G. Knepley } 3151194d53e6SMatthew G. Knepley 31529ee2af8cSMatthew G. Knepley /*@ 31539ee2af8cSMatthew G. Knepley PetscDSGetComponentOffsetsCohesive - Returns the offset of each field on an evaluation point 31549ee2af8cSMatthew G. Knepley 315520f4b53cSBarry Smith Not Collective 31569ee2af8cSMatthew G. Knepley 31579ee2af8cSMatthew G. Knepley Input Parameters: 3158dce8aebaSBarry Smith + ds - The `PetscDS` object 31599ee2af8cSMatthew G. Knepley - s - The cohesive side, 0 for negative, 1 for positive, 2 for cohesive 31609ee2af8cSMatthew G. Knepley 31619ee2af8cSMatthew G. Knepley Output Parameter: 31629ee2af8cSMatthew G. Knepley . offsets - The offsets 31639ee2af8cSMatthew G. Knepley 31649ee2af8cSMatthew G. Knepley Level: beginner 31659ee2af8cSMatthew G. Knepley 3166dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSGetNumFields()`, `PetscDSCreate()` 31679ee2af8cSMatthew G. Knepley @*/ 3168d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSGetComponentOffsetsCohesive(PetscDS ds, PetscInt s, PetscInt *offsets[]) 3169d71ae5a4SJacob Faibussowitsch { 31709ee2af8cSMatthew G. Knepley PetscFunctionBegin; 31719ee2af8cSMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 31724f572ea9SToby Isaac PetscAssertPointer(offsets, 3); 317328b400f6SJacob Faibussowitsch PetscCheck(ds->isCohesive, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, "Cohesive offsets are only valid for a cohesive DS"); 317463a3b9bcSJacob Faibussowitsch PetscCheck(!(s < 0) && !(s > 2), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Cohesive side %" PetscInt_FMT " is not in [0, 2]", s); 31759566063dSJacob Faibussowitsch PetscCall(PetscDSSetUp(ds)); 31769ee2af8cSMatthew G. Knepley *offsets = ds->offCohesive[s]; 31773ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 31789ee2af8cSMatthew G. Knepley } 31799ee2af8cSMatthew G. Knepley 31809ee2af8cSMatthew G. Knepley /*@ 31819ee2af8cSMatthew G. Knepley PetscDSGetComponentDerivativeOffsetsCohesive - Returns the offset of each field derivative on an evaluation point 31829ee2af8cSMatthew G. Knepley 318320f4b53cSBarry Smith Not Collective 31849ee2af8cSMatthew G. Knepley 31859ee2af8cSMatthew G. Knepley Input Parameters: 3186dce8aebaSBarry Smith + ds - The `PetscDS` object 31879ee2af8cSMatthew G. Knepley - s - The cohesive side, 0 for negative, 1 for positive, 2 for cohesive 31889ee2af8cSMatthew G. Knepley 31899ee2af8cSMatthew G. Knepley Output Parameter: 31909ee2af8cSMatthew G. Knepley . offsets - The offsets 31919ee2af8cSMatthew G. Knepley 31929ee2af8cSMatthew G. Knepley Level: beginner 31939ee2af8cSMatthew G. Knepley 3194dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSGetNumFields()`, `PetscDSCreate()` 31959ee2af8cSMatthew G. Knepley @*/ 3196d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSGetComponentDerivativeOffsetsCohesive(PetscDS ds, PetscInt s, PetscInt *offsets[]) 3197d71ae5a4SJacob Faibussowitsch { 31989ee2af8cSMatthew G. Knepley PetscFunctionBegin; 31999ee2af8cSMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 32004f572ea9SToby Isaac PetscAssertPointer(offsets, 3); 320128b400f6SJacob Faibussowitsch PetscCheck(ds->isCohesive, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, "Cohesive offsets are only valid for a cohesive DS"); 320263a3b9bcSJacob Faibussowitsch PetscCheck(!(s < 0) && !(s > 2), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Cohesive side %" PetscInt_FMT " is not in [0, 2]", s); 32039566063dSJacob Faibussowitsch PetscCall(PetscDSSetUp(ds)); 32049ee2af8cSMatthew G. Knepley *offsets = ds->offDerCohesive[s]; 32053ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 32069ee2af8cSMatthew G. Knepley } 32079ee2af8cSMatthew G. Knepley 320868c9edb9SMatthew G. Knepley /*@C 320968c9edb9SMatthew G. Knepley PetscDSGetTabulation - Return the basis tabulation at quadrature points for the volume discretization 321068c9edb9SMatthew G. Knepley 321120f4b53cSBarry Smith Not Collective 321268c9edb9SMatthew G. Knepley 321368c9edb9SMatthew G. Knepley Input Parameter: 3214dce8aebaSBarry Smith . prob - The `PetscDS` object 321568c9edb9SMatthew G. Knepley 3216ef0bb6c7SMatthew G. Knepley Output Parameter: 3217ef0bb6c7SMatthew G. Knepley . T - The basis function and derivatives tabulation at quadrature points for each field 321868c9edb9SMatthew G. Knepley 321968c9edb9SMatthew G. Knepley Level: intermediate 322068c9edb9SMatthew G. Knepley 3221dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscTabulation`, `PetscDSCreate()` 322268c9edb9SMatthew G. Knepley @*/ 3223d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSGetTabulation(PetscDS prob, PetscTabulation *T[]) 3224d71ae5a4SJacob Faibussowitsch { 32252764a2aaSMatthew G. Knepley PetscFunctionBegin; 32262764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 32274f572ea9SToby Isaac PetscAssertPointer(T, 2); 32289566063dSJacob Faibussowitsch PetscCall(PetscDSSetUp(prob)); 3229ef0bb6c7SMatthew G. Knepley *T = prob->T; 32303ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 32312764a2aaSMatthew G. Knepley } 32322764a2aaSMatthew G. Knepley 323368c9edb9SMatthew G. Knepley /*@C 32344d0b9603SSander Arens PetscDSGetFaceTabulation - Return the basis tabulation at quadrature points on the faces 323568c9edb9SMatthew G. Knepley 323620f4b53cSBarry Smith Not Collective 323768c9edb9SMatthew G. Knepley 323868c9edb9SMatthew G. Knepley Input Parameter: 3239dce8aebaSBarry Smith . prob - The `PetscDS` object 324068c9edb9SMatthew G. Knepley 3241ef0bb6c7SMatthew G. Knepley Output Parameter: 3242a5b23f4aSJose E. Roman . Tf - The basis function and derivative tabulation on each local face at quadrature points for each and field 324368c9edb9SMatthew G. Knepley 324468c9edb9SMatthew G. Knepley Level: intermediate 324568c9edb9SMatthew G. Knepley 3246dce8aebaSBarry Smith .seealso: `PetscTabulation`, `PetscDS`, `PetscDSGetTabulation()`, `PetscDSCreate()` 324768c9edb9SMatthew G. Knepley @*/ 3248d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSGetFaceTabulation(PetscDS prob, PetscTabulation *Tf[]) 3249d71ae5a4SJacob Faibussowitsch { 32502764a2aaSMatthew G. Knepley PetscFunctionBegin; 32512764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 32524f572ea9SToby Isaac PetscAssertPointer(Tf, 2); 32539566063dSJacob Faibussowitsch PetscCall(PetscDSSetUp(prob)); 3254ef0bb6c7SMatthew G. Knepley *Tf = prob->Tf; 32553ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 32562764a2aaSMatthew G. Knepley } 32572764a2aaSMatthew G. Knepley 3258d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSGetEvaluationArrays(PetscDS prob, PetscScalar **u, PetscScalar **u_t, PetscScalar **u_x) 3259d71ae5a4SJacob Faibussowitsch { 32602764a2aaSMatthew G. Knepley PetscFunctionBegin; 32612764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 32629566063dSJacob Faibussowitsch PetscCall(PetscDSSetUp(prob)); 32639371c9d4SSatish Balay if (u) { 32644f572ea9SToby Isaac PetscAssertPointer(u, 2); 32659371c9d4SSatish Balay *u = prob->u; 32669371c9d4SSatish Balay } 32679371c9d4SSatish Balay if (u_t) { 32684f572ea9SToby Isaac PetscAssertPointer(u_t, 3); 32699371c9d4SSatish Balay *u_t = prob->u_t; 32709371c9d4SSatish Balay } 32719371c9d4SSatish Balay if (u_x) { 32724f572ea9SToby Isaac PetscAssertPointer(u_x, 4); 32739371c9d4SSatish Balay *u_x = prob->u_x; 32749371c9d4SSatish Balay } 32753ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 32762764a2aaSMatthew G. Knepley } 32772764a2aaSMatthew G. Knepley 3278d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSGetWeakFormArrays(PetscDS prob, PetscScalar **f0, PetscScalar **f1, PetscScalar **g0, PetscScalar **g1, PetscScalar **g2, PetscScalar **g3) 3279d71ae5a4SJacob Faibussowitsch { 32802764a2aaSMatthew G. Knepley PetscFunctionBegin; 32812764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 32829566063dSJacob Faibussowitsch PetscCall(PetscDSSetUp(prob)); 32839371c9d4SSatish Balay if (f0) { 32844f572ea9SToby Isaac PetscAssertPointer(f0, 2); 32859371c9d4SSatish Balay *f0 = prob->f0; 32869371c9d4SSatish Balay } 32879371c9d4SSatish Balay if (f1) { 32884f572ea9SToby Isaac PetscAssertPointer(f1, 3); 32899371c9d4SSatish Balay *f1 = prob->f1; 32909371c9d4SSatish Balay } 32919371c9d4SSatish Balay if (g0) { 32924f572ea9SToby Isaac PetscAssertPointer(g0, 4); 32939371c9d4SSatish Balay *g0 = prob->g0; 32949371c9d4SSatish Balay } 32959371c9d4SSatish Balay if (g1) { 32964f572ea9SToby Isaac PetscAssertPointer(g1, 5); 32979371c9d4SSatish Balay *g1 = prob->g1; 32989371c9d4SSatish Balay } 32999371c9d4SSatish Balay if (g2) { 33004f572ea9SToby Isaac PetscAssertPointer(g2, 6); 33019371c9d4SSatish Balay *g2 = prob->g2; 33029371c9d4SSatish Balay } 33039371c9d4SSatish Balay if (g3) { 33044f572ea9SToby Isaac PetscAssertPointer(g3, 7); 33059371c9d4SSatish Balay *g3 = prob->g3; 33069371c9d4SSatish Balay } 33073ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 33082764a2aaSMatthew G. Knepley } 33092764a2aaSMatthew G. Knepley 3310d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSGetWorkspace(PetscDS prob, PetscReal **x, PetscScalar **basisReal, PetscScalar **basisDerReal, PetscScalar **testReal, PetscScalar **testDerReal) 3311d71ae5a4SJacob Faibussowitsch { 33122764a2aaSMatthew G. Knepley PetscFunctionBegin; 33132764a2aaSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 33149566063dSJacob Faibussowitsch PetscCall(PetscDSSetUp(prob)); 33159371c9d4SSatish Balay if (x) { 33164f572ea9SToby Isaac PetscAssertPointer(x, 2); 33179371c9d4SSatish Balay *x = prob->x; 33189371c9d4SSatish Balay } 33199371c9d4SSatish Balay if (basisReal) { 33204f572ea9SToby Isaac PetscAssertPointer(basisReal, 3); 33219371c9d4SSatish Balay *basisReal = prob->basisReal; 33229371c9d4SSatish Balay } 33239371c9d4SSatish Balay if (basisDerReal) { 33244f572ea9SToby Isaac PetscAssertPointer(basisDerReal, 4); 33259371c9d4SSatish Balay *basisDerReal = prob->basisDerReal; 33269371c9d4SSatish Balay } 33279371c9d4SSatish Balay if (testReal) { 33284f572ea9SToby Isaac PetscAssertPointer(testReal, 5); 33299371c9d4SSatish Balay *testReal = prob->testReal; 33309371c9d4SSatish Balay } 33319371c9d4SSatish Balay if (testDerReal) { 33324f572ea9SToby Isaac PetscAssertPointer(testDerReal, 6); 33339371c9d4SSatish Balay *testDerReal = prob->testDerReal; 33349371c9d4SSatish Balay } 33353ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 33362764a2aaSMatthew G. Knepley } 33372764a2aaSMatthew G. Knepley 333858ebd649SToby Isaac /*@C 3339a4e35b19SJacob Faibussowitsch PetscDSAddBoundary - Add a boundary condition to the model. 334058ebd649SToby Isaac 334120f4b53cSBarry Smith Collective 3342783e2ec8SMatthew G. Knepley 334358ebd649SToby Isaac Input Parameters: 334458ebd649SToby Isaac + ds - The PetscDS object 3345dce8aebaSBarry Smith . type - The type of condition, e.g. `DM_BC_ESSENTIAL`/`DM_BC_ESSENTIAL_FIELD` (Dirichlet), or `DM_BC_NATURAL` (Neumann) 334658ebd649SToby Isaac . name - The BC name 334745480ffeSMatthew G. Knepley . label - The label defining constrained points 3348dce8aebaSBarry Smith . Nv - The number of `DMLabel` values for constrained points 334945480ffeSMatthew G. Knepley . values - An array of label values for constrained points 335058ebd649SToby Isaac . field - The field to constrain 335145480ffeSMatthew G. Knepley . Nc - The number of constrained field components (0 will constrain all fields) 335258ebd649SToby Isaac . comps - An array of constrained component numbers 335358ebd649SToby Isaac . bcFunc - A pointwise function giving boundary values 3354a5b23f4aSJose E. Roman . bcFunc_t - A pointwise function giving the time derivative of the boundary values, or NULL 335558ebd649SToby Isaac - ctx - An optional user context for bcFunc 335658ebd649SToby Isaac 33572fe279fdSBarry Smith Output Parameter: 335860225df5SJacob Faibussowitsch . bd - The boundary number 335945480ffeSMatthew G. Knepley 336058ebd649SToby Isaac Options Database Keys: 336158ebd649SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids 336258ebd649SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components 336358ebd649SToby Isaac 3364dce8aebaSBarry Smith Level: developer 3365dce8aebaSBarry Smith 336656cf3b9cSMatthew G. Knepley Note: 3367a4e35b19SJacob Faibussowitsch Both `bcFunc` and `bcFunc_t` will depend on the boundary condition type. If the type if `DM_BC_ESSENTIAL`, then the calling sequence is\: 336856cf3b9cSMatthew G. Knepley 336920f4b53cSBarry Smith $ void bcFunc(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nc, PetscScalar bcval[]) 337056cf3b9cSMatthew G. Knepley 3371a4e35b19SJacob Faibussowitsch If the type is `DM_BC_ESSENTIAL_FIELD` or other _FIELD value, then the calling sequence is\: 3372dce8aebaSBarry Smith .vb 337320f4b53cSBarry Smith void bcFunc(PetscInt dim, PetscInt Nf, PetscInt NfAux, 3374dce8aebaSBarry Smith const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 3375dce8aebaSBarry Smith const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 3376dce8aebaSBarry Smith PetscReal time, const PetscReal x[], PetscScalar bcval[]) 3377dce8aebaSBarry Smith .ve 337856cf3b9cSMatthew G. Knepley + dim - the spatial dimension 337956cf3b9cSMatthew G. Knepley . Nf - the number of fields 338056cf3b9cSMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 338156cf3b9cSMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 338256cf3b9cSMatthew G. Knepley . u - each field evaluated at the current point 338356cf3b9cSMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 338456cf3b9cSMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 338556cf3b9cSMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 338656cf3b9cSMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 338756cf3b9cSMatthew G. Knepley . a - each auxiliary field evaluated at the current point 338856cf3b9cSMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 338956cf3b9cSMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 339056cf3b9cSMatthew G. Knepley . t - current time 339156cf3b9cSMatthew G. Knepley . x - coordinates of the current point 339256cf3b9cSMatthew G. Knepley . numConstants - number of constant parameters 339356cf3b9cSMatthew G. Knepley . constants - constant parameters 339456cf3b9cSMatthew G. Knepley - bcval - output values at the current point 339556cf3b9cSMatthew G. Knepley 3396a4e35b19SJacob Faibussowitsch Notes: 3397a4e35b19SJacob Faibussowitsch The pointwise functions are used to provide boundary values for essential boundary 3398a4e35b19SJacob Faibussowitsch conditions. In FEM, they are acting upon by dual basis functionals to generate FEM 3399a4e35b19SJacob Faibussowitsch coefficients which are fixed. Natural boundary conditions signal to PETSc that boundary 3400a4e35b19SJacob Faibussowitsch integrals should be performed, using the kernels from `PetscDSSetBdResidual()`. 3401a4e35b19SJacob Faibussowitsch 3402dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscWeakForm`, `DMLabel`, `DMBoundaryConditionType`, `PetscDSAddBoundaryByName()`, `PetscDSGetBoundary()`, `PetscDSSetResidual()`, `PetscDSSetBdResidual()` 340358ebd649SToby Isaac @*/ 3404d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSAddBoundary(PetscDS ds, DMBoundaryConditionType type, const char name[], DMLabel label, PetscInt Nv, const PetscInt values[], PetscInt field, PetscInt Nc, const PetscInt comps[], void (*bcFunc)(void), void (*bcFunc_t)(void), void *ctx, PetscInt *bd) 3405d71ae5a4SJacob Faibussowitsch { 340645480ffeSMatthew G. Knepley DSBoundary head = ds->boundary, b; 340745480ffeSMatthew G. Knepley PetscInt n = 0; 340845480ffeSMatthew G. Knepley const char *lname; 340958ebd649SToby Isaac 341058ebd649SToby Isaac PetscFunctionBegin; 341158ebd649SToby Isaac PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 3412783e2ec8SMatthew G. Knepley PetscValidLogicalCollectiveEnum(ds, type, 2); 34134f572ea9SToby Isaac PetscAssertPointer(name, 3); 341445480ffeSMatthew G. Knepley PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 4); 341545480ffeSMatthew G. Knepley PetscValidLogicalCollectiveInt(ds, Nv, 5); 341645480ffeSMatthew G. Knepley PetscValidLogicalCollectiveInt(ds, field, 7); 341745480ffeSMatthew G. Knepley PetscValidLogicalCollectiveInt(ds, Nc, 8); 3418dce9da9cSMatthew G. Knepley PetscCheck(field >= 0 && field < ds->Nf, PetscObjectComm((PetscObject)ds), PETSC_ERR_ARG_OUTOFRANGE, "Field %" PetscInt_FMT " is not in [0, %" PetscInt_FMT ")", field, ds->Nf); 3419d57bb9dbSMatthew G. Knepley if (Nc > 0) { 3420d57bb9dbSMatthew G. Knepley PetscInt *fcomps; 3421d57bb9dbSMatthew G. Knepley PetscInt c; 3422d57bb9dbSMatthew G. Knepley 34239566063dSJacob Faibussowitsch PetscCall(PetscDSGetComponents(ds, &fcomps)); 342463a3b9bcSJacob Faibussowitsch PetscCheck(Nc <= fcomps[field], PetscObjectComm((PetscObject)ds), PETSC_ERR_ARG_OUTOFRANGE, "Number of constrained components %" PetscInt_FMT " > %" PetscInt_FMT " components for field %" PetscInt_FMT, Nc, fcomps[field], field); 3425d57bb9dbSMatthew G. Knepley for (c = 0; c < Nc; ++c) { 34261dca8a05SBarry Smith PetscCheck(comps[c] >= 0 && comps[c] < fcomps[field], PetscObjectComm((PetscObject)ds), PETSC_ERR_ARG_OUTOFRANGE, "Constrained component[%" PetscInt_FMT "] %" PetscInt_FMT " not in [0, %" PetscInt_FMT ") components for field %" PetscInt_FMT, c, comps[c], fcomps[field], field); 3427d57bb9dbSMatthew G. Knepley } 3428d57bb9dbSMatthew G. Knepley } 34299566063dSJacob Faibussowitsch PetscCall(PetscNew(&b)); 34309566063dSJacob Faibussowitsch PetscCall(PetscStrallocpy(name, (char **)&b->name)); 34319566063dSJacob Faibussowitsch PetscCall(PetscWeakFormCreate(PETSC_COMM_SELF, &b->wf)); 34329566063dSJacob Faibussowitsch PetscCall(PetscWeakFormSetNumFields(b->wf, ds->Nf)); 34339566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(Nv, &b->values)); 34349566063dSJacob Faibussowitsch if (Nv) PetscCall(PetscArraycpy(b->values, values, Nv)); 34359566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(Nc, &b->comps)); 34369566063dSJacob Faibussowitsch if (Nc) PetscCall(PetscArraycpy(b->comps, comps, Nc)); 34379566063dSJacob Faibussowitsch PetscCall(PetscObjectGetName((PetscObject)label, &lname)); 34389566063dSJacob Faibussowitsch PetscCall(PetscStrallocpy(lname, (char **)&b->lname)); 3439f971fd6bSMatthew G. Knepley b->type = type; 344045480ffeSMatthew G. Knepley b->label = label; 344145480ffeSMatthew G. Knepley b->Nv = Nv; 344258ebd649SToby Isaac b->field = field; 344345480ffeSMatthew G. Knepley b->Nc = Nc; 344458ebd649SToby Isaac b->func = bcFunc; 344556cf3b9cSMatthew G. Knepley b->func_t = bcFunc_t; 344658ebd649SToby Isaac b->ctx = ctx; 344745480ffeSMatthew G. Knepley b->next = NULL; 344845480ffeSMatthew G. Knepley /* Append to linked list so that we can preserve the order */ 344945480ffeSMatthew G. Knepley if (!head) ds->boundary = b; 345045480ffeSMatthew G. Knepley while (head) { 345145480ffeSMatthew G. Knepley if (!head->next) { 345245480ffeSMatthew G. Knepley head->next = b; 345345480ffeSMatthew G. Knepley head = b; 345445480ffeSMatthew G. Knepley } 345545480ffeSMatthew G. Knepley head = head->next; 345645480ffeSMatthew G. Knepley ++n; 345745480ffeSMatthew G. Knepley } 34589371c9d4SSatish Balay if (bd) { 34594f572ea9SToby Isaac PetscAssertPointer(bd, 13); 34609371c9d4SSatish Balay *bd = n; 34619371c9d4SSatish Balay } 34623ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 346345480ffeSMatthew G. Knepley } 346445480ffeSMatthew G. Knepley 3465a4e35b19SJacob Faibussowitsch // PetscClangLinter pragma ignore: -fdoc-section-header-unknown 346645480ffeSMatthew G. Knepley /*@C 3467a4e35b19SJacob Faibussowitsch PetscDSAddBoundaryByName - Add a boundary condition to the model. 346845480ffeSMatthew G. Knepley 346920f4b53cSBarry Smith Collective 347045480ffeSMatthew G. Knepley 347145480ffeSMatthew G. Knepley Input Parameters: 3472dce8aebaSBarry Smith + ds - The `PetscDS` object 3473dce8aebaSBarry Smith . type - The type of condition, e.g. `DM_BC_ESSENTIAL`/`DM_BC_ESSENTIAL_FIELD` (Dirichlet), or `DM_BC_NATURAL` (Neumann) 347445480ffeSMatthew G. Knepley . name - The BC name 347545480ffeSMatthew G. Knepley . lname - The naem of the label defining constrained points 3476dce8aebaSBarry Smith . Nv - The number of `DMLabel` values for constrained points 347745480ffeSMatthew G. Knepley . values - An array of label values for constrained points 347845480ffeSMatthew G. Knepley . field - The field to constrain 347945480ffeSMatthew G. Knepley . Nc - The number of constrained field components (0 will constrain all fields) 348045480ffeSMatthew G. Knepley . comps - An array of constrained component numbers 348145480ffeSMatthew G. Knepley . bcFunc - A pointwise function giving boundary values 3482a5b23f4aSJose E. Roman . bcFunc_t - A pointwise function giving the time derivative of the boundary values, or NULL 348345480ffeSMatthew G. Knepley - ctx - An optional user context for bcFunc 348445480ffeSMatthew G. Knepley 34852fe279fdSBarry Smith Output Parameter: 348660225df5SJacob Faibussowitsch . bd - The boundary number 348745480ffeSMatthew G. Knepley 348845480ffeSMatthew G. Knepley Options Database Keys: 348945480ffeSMatthew G. Knepley + -bc_<boundary name> <num> - Overrides the boundary ids 349045480ffeSMatthew G. Knepley - -bc_<boundary name>_comp <num> - Overrides the boundary components 349145480ffeSMatthew G. Knepley 349220f4b53cSBarry Smith Calling Sequence of `bcFunc` and `bcFunc_t`: 3493dce8aebaSBarry Smith If the type is `DM_BC_ESSENTIAL` 3494dce8aebaSBarry Smith .vb 349520f4b53cSBarry Smith void bcFunc(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nc, PetscScalar bcval[]) 3496dce8aebaSBarry Smith .ve 3497dce8aebaSBarry Smith If the type is `DM_BC_ESSENTIAL_FIELD` or other _FIELD value, 3498dce8aebaSBarry Smith .vb 349920f4b53cSBarry Smith void bcFunc(PetscInt dim, PetscInt Nf, PetscInt NfAux, 3500dce8aebaSBarry Smith const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[], 3501dce8aebaSBarry Smith const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[], 3502dce8aebaSBarry Smith PetscReal time, const PetscReal x[], PetscScalar bcval[]) 3503dce8aebaSBarry Smith .ve 350445480ffeSMatthew G. Knepley + dim - the spatial dimension 350545480ffeSMatthew G. Knepley . Nf - the number of fields 350645480ffeSMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field 350745480ffeSMatthew G. Knepley . uOff_x - the offset into u_x[] for each field 350845480ffeSMatthew G. Knepley . u - each field evaluated at the current point 350945480ffeSMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point 351045480ffeSMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point 351145480ffeSMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field 351245480ffeSMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field 351345480ffeSMatthew G. Knepley . a - each auxiliary field evaluated at the current point 351445480ffeSMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point 351545480ffeSMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point 351645480ffeSMatthew G. Knepley . t - current time 351745480ffeSMatthew G. Knepley . x - coordinates of the current point 351845480ffeSMatthew G. Knepley . numConstants - number of constant parameters 351945480ffeSMatthew G. Knepley . constants - constant parameters 352045480ffeSMatthew G. Knepley - bcval - output values at the current point 352145480ffeSMatthew G. Knepley 352245480ffeSMatthew G. Knepley Level: developer 352345480ffeSMatthew G. Knepley 3524a4e35b19SJacob Faibussowitsch Notes: 3525a4e35b19SJacob Faibussowitsch The pointwise functions are used to provide boundary values for essential boundary 3526a4e35b19SJacob Faibussowitsch conditions. In FEM, they are acting upon by dual basis functionals to generate FEM 3527a4e35b19SJacob Faibussowitsch coefficients which are fixed. Natural boundary conditions signal to PETSc that boundary 3528a4e35b19SJacob Faibussowitsch integrals should be performed, using the kernels from `PetscDSSetBdResidual()`. 3529a4e35b19SJacob Faibussowitsch 3530dce8aebaSBarry Smith This function should only be used with `DMFOREST` currently, since labels cannot be defined before the underlying `DMPLEX` is built. 3531dce8aebaSBarry Smith 3532dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscWeakForm`, `DMLabel`, `DMBoundaryConditionType`, `PetscDSAddBoundary()`, `PetscDSGetBoundary()`, `PetscDSSetResidual()`, `PetscDSSetBdResidual()` 353345480ffeSMatthew G. Knepley @*/ 3534d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSAddBoundaryByName(PetscDS ds, DMBoundaryConditionType type, const char name[], const char lname[], PetscInt Nv, const PetscInt values[], PetscInt field, PetscInt Nc, const PetscInt comps[], void (*bcFunc)(void), void (*bcFunc_t)(void), void *ctx, PetscInt *bd) 3535d71ae5a4SJacob Faibussowitsch { 353645480ffeSMatthew G. Knepley DSBoundary head = ds->boundary, b; 353745480ffeSMatthew G. Knepley PetscInt n = 0; 353845480ffeSMatthew G. Knepley 353945480ffeSMatthew G. Knepley PetscFunctionBegin; 354045480ffeSMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 354145480ffeSMatthew G. Knepley PetscValidLogicalCollectiveEnum(ds, type, 2); 35424f572ea9SToby Isaac PetscAssertPointer(name, 3); 35434f572ea9SToby Isaac PetscAssertPointer(lname, 4); 354445480ffeSMatthew G. Knepley PetscValidLogicalCollectiveInt(ds, Nv, 5); 354545480ffeSMatthew G. Knepley PetscValidLogicalCollectiveInt(ds, field, 7); 354645480ffeSMatthew G. Knepley PetscValidLogicalCollectiveInt(ds, Nc, 8); 35479566063dSJacob Faibussowitsch PetscCall(PetscNew(&b)); 35489566063dSJacob Faibussowitsch PetscCall(PetscStrallocpy(name, (char **)&b->name)); 35499566063dSJacob Faibussowitsch PetscCall(PetscWeakFormCreate(PETSC_COMM_SELF, &b->wf)); 35509566063dSJacob Faibussowitsch PetscCall(PetscWeakFormSetNumFields(b->wf, ds->Nf)); 35519566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(Nv, &b->values)); 35529566063dSJacob Faibussowitsch if (Nv) PetscCall(PetscArraycpy(b->values, values, Nv)); 35539566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(Nc, &b->comps)); 35549566063dSJacob Faibussowitsch if (Nc) PetscCall(PetscArraycpy(b->comps, comps, Nc)); 35559566063dSJacob Faibussowitsch PetscCall(PetscStrallocpy(lname, (char **)&b->lname)); 355645480ffeSMatthew G. Knepley b->type = type; 355745480ffeSMatthew G. Knepley b->label = NULL; 355845480ffeSMatthew G. Knepley b->Nv = Nv; 355945480ffeSMatthew G. Knepley b->field = field; 356045480ffeSMatthew G. Knepley b->Nc = Nc; 356145480ffeSMatthew G. Knepley b->func = bcFunc; 356245480ffeSMatthew G. Knepley b->func_t = bcFunc_t; 356345480ffeSMatthew G. Knepley b->ctx = ctx; 356445480ffeSMatthew G. Knepley b->next = NULL; 356545480ffeSMatthew G. Knepley /* Append to linked list so that we can preserve the order */ 356645480ffeSMatthew G. Knepley if (!head) ds->boundary = b; 356745480ffeSMatthew G. Knepley while (head) { 356845480ffeSMatthew G. Knepley if (!head->next) { 356945480ffeSMatthew G. Knepley head->next = b; 357045480ffeSMatthew G. Knepley head = b; 357145480ffeSMatthew G. Knepley } 357245480ffeSMatthew G. Knepley head = head->next; 357345480ffeSMatthew G. Knepley ++n; 357445480ffeSMatthew G. Knepley } 35759371c9d4SSatish Balay if (bd) { 35764f572ea9SToby Isaac PetscAssertPointer(bd, 13); 35779371c9d4SSatish Balay *bd = n; 35789371c9d4SSatish Balay } 35793ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 358058ebd649SToby Isaac } 358158ebd649SToby Isaac 3582b67eacb3SMatthew G. Knepley /*@C 3583a4e35b19SJacob Faibussowitsch PetscDSUpdateBoundary - Change a boundary condition for the model. 3584b67eacb3SMatthew G. Knepley 3585b67eacb3SMatthew G. Knepley Input Parameters: 3586dce8aebaSBarry Smith + ds - The `PetscDS` object 3587b67eacb3SMatthew G. Knepley . bd - The boundary condition number 3588dce8aebaSBarry Smith . type - The type of condition, e.g. `DM_BC_ESSENTIAL`/`DM_BC_ESSENTIAL_FIELD` (Dirichlet), or `DM_BC_NATURAL` (Neumann) 3589b67eacb3SMatthew G. Knepley . name - The BC name 359045480ffeSMatthew G. Knepley . label - The label defining constrained points 3591dce8aebaSBarry Smith . Nv - The number of `DMLabel` ids for constrained points 359245480ffeSMatthew G. Knepley . values - An array of ids for constrained points 3593b67eacb3SMatthew G. Knepley . field - The field to constrain 359445480ffeSMatthew G. Knepley . Nc - The number of constrained field components 3595b67eacb3SMatthew G. Knepley . comps - An array of constrained component numbers 3596b67eacb3SMatthew G. Knepley . bcFunc - A pointwise function giving boundary values 3597a5b23f4aSJose E. Roman . bcFunc_t - A pointwise function giving the time derivative of the boundary values, or NULL 3598b67eacb3SMatthew G. Knepley - ctx - An optional user context for bcFunc 3599b67eacb3SMatthew G. Knepley 3600b67eacb3SMatthew G. Knepley Level: developer 3601b67eacb3SMatthew G. Knepley 3602a4e35b19SJacob Faibussowitsch Notes: 3603a4e35b19SJacob Faibussowitsch The pointwise functions are used to provide boundary values for essential boundary 3604a4e35b19SJacob Faibussowitsch conditions. In FEM, they are acting upon by dual basis functionals to generate FEM 3605a4e35b19SJacob Faibussowitsch coefficients which are fixed. Natural boundary conditions signal to PETSc that boundary 3606a4e35b19SJacob Faibussowitsch integrals should be performed, using the kernels from `PetscDSSetBdResidual()`. 3607a4e35b19SJacob Faibussowitsch 3608dce8aebaSBarry Smith The boundary condition number is the order in which it was registered. The user can get the number of boundary conditions from `PetscDSGetNumBoundary()`. 3609dce8aebaSBarry Smith See `PetscDSAddBoundary()` for a description of the calling sequences for the callbacks. 3610dce8aebaSBarry Smith 3611dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscWeakForm`, `DMBoundaryConditionType`, `PetscDSAddBoundary()`, `PetscDSGetBoundary()`, `PetscDSGetNumBoundary()`, `DMLabel` 3612b67eacb3SMatthew G. Knepley @*/ 3613d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSUpdateBoundary(PetscDS ds, PetscInt bd, DMBoundaryConditionType type, const char name[], DMLabel label, PetscInt Nv, const PetscInt values[], PetscInt field, PetscInt Nc, const PetscInt comps[], void (*bcFunc)(void), void (*bcFunc_t)(void), void *ctx) 3614d71ae5a4SJacob Faibussowitsch { 3615b67eacb3SMatthew G. Knepley DSBoundary b = ds->boundary; 3616b67eacb3SMatthew G. Knepley PetscInt n = 0; 3617b67eacb3SMatthew G. Knepley 3618b67eacb3SMatthew G. Knepley PetscFunctionBegin; 3619b67eacb3SMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 3620b67eacb3SMatthew G. Knepley while (b) { 3621b67eacb3SMatthew G. Knepley if (n == bd) break; 3622b67eacb3SMatthew G. Knepley b = b->next; 3623b67eacb3SMatthew G. Knepley ++n; 3624b67eacb3SMatthew G. Knepley } 362563a3b9bcSJacob Faibussowitsch PetscCheck(b, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Boundary %" PetscInt_FMT " is not in [0, %" PetscInt_FMT ")", bd, n); 3626b67eacb3SMatthew G. Knepley if (name) { 36279566063dSJacob Faibussowitsch PetscCall(PetscFree(b->name)); 36289566063dSJacob Faibussowitsch PetscCall(PetscStrallocpy(name, (char **)&b->name)); 3629b67eacb3SMatthew G. Knepley } 3630b67eacb3SMatthew G. Knepley b->type = type; 363145480ffeSMatthew G. Knepley if (label) { 363245480ffeSMatthew G. Knepley const char *name; 363345480ffeSMatthew G. Knepley 363445480ffeSMatthew G. Knepley b->label = label; 36359566063dSJacob Faibussowitsch PetscCall(PetscFree(b->lname)); 36369566063dSJacob Faibussowitsch PetscCall(PetscObjectGetName((PetscObject)label, &name)); 36379566063dSJacob Faibussowitsch PetscCall(PetscStrallocpy(name, (char **)&b->lname)); 363845480ffeSMatthew G. Knepley } 363945480ffeSMatthew G. Knepley if (Nv >= 0) { 364045480ffeSMatthew G. Knepley b->Nv = Nv; 36419566063dSJacob Faibussowitsch PetscCall(PetscFree(b->values)); 36429566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(Nv, &b->values)); 36439566063dSJacob Faibussowitsch if (Nv) PetscCall(PetscArraycpy(b->values, values, Nv)); 364445480ffeSMatthew G. Knepley } 364545480ffeSMatthew G. Knepley if (field >= 0) b->field = field; 364645480ffeSMatthew G. Knepley if (Nc >= 0) { 364745480ffeSMatthew G. Knepley b->Nc = Nc; 36489566063dSJacob Faibussowitsch PetscCall(PetscFree(b->comps)); 36499566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(Nc, &b->comps)); 36509566063dSJacob Faibussowitsch if (Nc) PetscCall(PetscArraycpy(b->comps, comps, Nc)); 365145480ffeSMatthew G. Knepley } 365245480ffeSMatthew G. Knepley if (bcFunc) b->func = bcFunc; 365345480ffeSMatthew G. Knepley if (bcFunc_t) b->func_t = bcFunc_t; 365445480ffeSMatthew G. Knepley if (ctx) b->ctx = ctx; 36553ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 3656b67eacb3SMatthew G. Knepley } 3657b67eacb3SMatthew G. Knepley 365858ebd649SToby Isaac /*@ 365958ebd649SToby Isaac PetscDSGetNumBoundary - Get the number of registered BC 366058ebd649SToby Isaac 36612fe279fdSBarry Smith Input Parameter: 3662dce8aebaSBarry Smith . ds - The `PetscDS` object 366358ebd649SToby Isaac 36642fe279fdSBarry Smith Output Parameter: 366558ebd649SToby Isaac . numBd - The number of BC 366658ebd649SToby Isaac 366758ebd649SToby Isaac Level: intermediate 366858ebd649SToby Isaac 3669dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSAddBoundary()`, `PetscDSGetBoundary()` 367058ebd649SToby Isaac @*/ 3671d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSGetNumBoundary(PetscDS ds, PetscInt *numBd) 3672d71ae5a4SJacob Faibussowitsch { 367358ebd649SToby Isaac DSBoundary b = ds->boundary; 367458ebd649SToby Isaac 367558ebd649SToby Isaac PetscFunctionBegin; 367658ebd649SToby Isaac PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 36774f572ea9SToby Isaac PetscAssertPointer(numBd, 2); 367858ebd649SToby Isaac *numBd = 0; 36799371c9d4SSatish Balay while (b) { 36809371c9d4SSatish Balay ++(*numBd); 36819371c9d4SSatish Balay b = b->next; 36829371c9d4SSatish Balay } 36833ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 368458ebd649SToby Isaac } 368558ebd649SToby Isaac 368658ebd649SToby Isaac /*@C 36879a6efb6aSMatthew G. Knepley PetscDSGetBoundary - Gets a boundary condition to the model 368858ebd649SToby Isaac 368958ebd649SToby Isaac Input Parameters: 3690dce8aebaSBarry Smith + ds - The `PetscDS` object 369158ebd649SToby Isaac - bd - The BC number 369258ebd649SToby Isaac 369358ebd649SToby Isaac Output Parameters: 3694dce8aebaSBarry Smith + wf - The `PetscWeakForm` holding the pointwise functions 3695dce8aebaSBarry Smith . type - The type of condition, e.g. `DM_BC_ESSENTIAL`/`DM_BC_ESSENTIAL_FIELD` (Dirichlet), or `DM_BC_NATURAL` (Neumann) 369658ebd649SToby Isaac . name - The BC name 369745480ffeSMatthew G. Knepley . label - The label defining constrained points 3698dce8aebaSBarry Smith . Nv - The number of `DMLabel` ids for constrained points 369945480ffeSMatthew G. Knepley . values - An array of ids for constrained points 370058ebd649SToby Isaac . field - The field to constrain 370145480ffeSMatthew G. Knepley . Nc - The number of constrained field components 370258ebd649SToby Isaac . comps - An array of constrained component numbers 370360225df5SJacob Faibussowitsch . func - A pointwise function giving boundary values 370460225df5SJacob Faibussowitsch . func_t - A pointwise function giving the time derivative of the boundary values 370558ebd649SToby Isaac - ctx - An optional user context for bcFunc 370658ebd649SToby Isaac 370758ebd649SToby Isaac Options Database Keys: 370858ebd649SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids 370958ebd649SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components 371058ebd649SToby Isaac 371158ebd649SToby Isaac Level: developer 371258ebd649SToby Isaac 3713dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscWeakForm`, `DMBoundaryConditionType`, `PetscDSAddBoundary()`, `DMLabel` 371458ebd649SToby Isaac @*/ 3715d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSGetBoundary(PetscDS ds, PetscInt bd, PetscWeakForm *wf, DMBoundaryConditionType *type, const char *name[], DMLabel *label, PetscInt *Nv, const PetscInt *values[], PetscInt *field, PetscInt *Nc, const PetscInt *comps[], void (**func)(void), void (**func_t)(void), void **ctx) 3716d71ae5a4SJacob Faibussowitsch { 371758ebd649SToby Isaac DSBoundary b = ds->boundary; 371858ebd649SToby Isaac PetscInt n = 0; 371958ebd649SToby Isaac 372058ebd649SToby Isaac PetscFunctionBegin; 372158ebd649SToby Isaac PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 372258ebd649SToby Isaac while (b) { 372358ebd649SToby Isaac if (n == bd) break; 372458ebd649SToby Isaac b = b->next; 372558ebd649SToby Isaac ++n; 372658ebd649SToby Isaac } 372763a3b9bcSJacob Faibussowitsch PetscCheck(b, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Boundary %" PetscInt_FMT " is not in [0, %" PetscInt_FMT ")", bd, n); 372845480ffeSMatthew G. Knepley if (wf) { 37294f572ea9SToby Isaac PetscAssertPointer(wf, 3); 373045480ffeSMatthew G. Knepley *wf = b->wf; 373145480ffeSMatthew G. Knepley } 3732f971fd6bSMatthew G. Knepley if (type) { 37334f572ea9SToby Isaac PetscAssertPointer(type, 4); 3734f971fd6bSMatthew G. Knepley *type = b->type; 373558ebd649SToby Isaac } 373658ebd649SToby Isaac if (name) { 37374f572ea9SToby Isaac PetscAssertPointer(name, 5); 373858ebd649SToby Isaac *name = b->name; 373958ebd649SToby Isaac } 374045480ffeSMatthew G. Knepley if (label) { 37414f572ea9SToby Isaac PetscAssertPointer(label, 6); 374245480ffeSMatthew G. Knepley *label = b->label; 374345480ffeSMatthew G. Knepley } 374445480ffeSMatthew G. Knepley if (Nv) { 37454f572ea9SToby Isaac PetscAssertPointer(Nv, 7); 374645480ffeSMatthew G. Knepley *Nv = b->Nv; 374745480ffeSMatthew G. Knepley } 374845480ffeSMatthew G. Knepley if (values) { 37494f572ea9SToby Isaac PetscAssertPointer(values, 8); 375045480ffeSMatthew G. Knepley *values = b->values; 375158ebd649SToby Isaac } 375258ebd649SToby Isaac if (field) { 37534f572ea9SToby Isaac PetscAssertPointer(field, 9); 375458ebd649SToby Isaac *field = b->field; 375558ebd649SToby Isaac } 375645480ffeSMatthew G. Knepley if (Nc) { 37574f572ea9SToby Isaac PetscAssertPointer(Nc, 10); 375845480ffeSMatthew G. Knepley *Nc = b->Nc; 375958ebd649SToby Isaac } 376058ebd649SToby Isaac if (comps) { 37614f572ea9SToby Isaac PetscAssertPointer(comps, 11); 376258ebd649SToby Isaac *comps = b->comps; 376358ebd649SToby Isaac } 376458ebd649SToby Isaac if (func) { 37654f572ea9SToby Isaac PetscAssertPointer(func, 12); 376658ebd649SToby Isaac *func = b->func; 376758ebd649SToby Isaac } 376856cf3b9cSMatthew G. Knepley if (func_t) { 37694f572ea9SToby Isaac PetscAssertPointer(func_t, 13); 377056cf3b9cSMatthew G. Knepley *func_t = b->func_t; 377156cf3b9cSMatthew G. Knepley } 377258ebd649SToby Isaac if (ctx) { 37734f572ea9SToby Isaac PetscAssertPointer(ctx, 14); 377458ebd649SToby Isaac *ctx = b->ctx; 377558ebd649SToby Isaac } 37763ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 377758ebd649SToby Isaac } 377858ebd649SToby Isaac 377910af620dSMatthew G. Knepley /*@ 378010af620dSMatthew G. Knepley PetscDSUpdateBoundaryLabels - Update `DMLabel` in each boundary condition using the label name and the input `DM` 378110af620dSMatthew G. Knepley 378210af620dSMatthew G. Knepley Not Collective 378310af620dSMatthew G. Knepley 378410af620dSMatthew G. Knepley Input Parameters: 378510af620dSMatthew G. Knepley + ds - The source `PetscDS` object 378610af620dSMatthew G. Knepley - dm - The `DM` holding labels 378710af620dSMatthew G. Knepley 378810af620dSMatthew G. Knepley Level: intermediate 378910af620dSMatthew G. Knepley 379010af620dSMatthew G. Knepley .seealso: `PetscDS`, `DMBoundary`, `DM`, `PetscDSCopyBoundary()`, `PetscDSCreate()`, `DMGetLabel()` 379110af620dSMatthew G. Knepley @*/ 379210af620dSMatthew G. Knepley PetscErrorCode PetscDSUpdateBoundaryLabels(PetscDS ds, DM dm) 379310af620dSMatthew G. Knepley { 379410af620dSMatthew G. Knepley DSBoundary b; 379510af620dSMatthew G. Knepley 379610af620dSMatthew G. Knepley PetscFunctionBegin; 379710af620dSMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 379810af620dSMatthew G. Knepley PetscValidHeaderSpecific(dm, DM_CLASSID, 2); 379910af620dSMatthew G. Knepley for (b = ds->boundary; b; b = b->next) { 380010af620dSMatthew G. Knepley if (b->lname) PetscCall(DMGetLabel(dm, b->lname, &b->label)); 380110af620dSMatthew G. Knepley } 380210af620dSMatthew G. Knepley PetscFunctionReturn(PETSC_SUCCESS); 380310af620dSMatthew G. Knepley } 380410af620dSMatthew G. Knepley 3805d71ae5a4SJacob Faibussowitsch static PetscErrorCode DSBoundaryDuplicate_Internal(DSBoundary b, DSBoundary *bNew) 3806d71ae5a4SJacob Faibussowitsch { 380745480ffeSMatthew G. Knepley PetscFunctionBegin; 38089566063dSJacob Faibussowitsch PetscCall(PetscNew(bNew)); 38099566063dSJacob Faibussowitsch PetscCall(PetscWeakFormCreate(PETSC_COMM_SELF, &(*bNew)->wf)); 38109566063dSJacob Faibussowitsch PetscCall(PetscWeakFormCopy(b->wf, (*bNew)->wf)); 38119566063dSJacob Faibussowitsch PetscCall(PetscStrallocpy(b->name, (char **)&((*bNew)->name))); 38129566063dSJacob Faibussowitsch PetscCall(PetscStrallocpy(b->lname, (char **)&((*bNew)->lname))); 381345480ffeSMatthew G. Knepley (*bNew)->type = b->type; 381445480ffeSMatthew G. Knepley (*bNew)->label = b->label; 381545480ffeSMatthew G. Knepley (*bNew)->Nv = b->Nv; 38169566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(b->Nv, &(*bNew)->values)); 38179566063dSJacob Faibussowitsch PetscCall(PetscArraycpy((*bNew)->values, b->values, b->Nv)); 381845480ffeSMatthew G. Knepley (*bNew)->field = b->field; 381945480ffeSMatthew G. Knepley (*bNew)->Nc = b->Nc; 38209566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(b->Nc, &(*bNew)->comps)); 38219566063dSJacob Faibussowitsch PetscCall(PetscArraycpy((*bNew)->comps, b->comps, b->Nc)); 382245480ffeSMatthew G. Knepley (*bNew)->func = b->func; 382345480ffeSMatthew G. Knepley (*bNew)->func_t = b->func_t; 382445480ffeSMatthew G. Knepley (*bNew)->ctx = b->ctx; 38253ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 382645480ffeSMatthew G. Knepley } 382745480ffeSMatthew G. Knepley 38289252d075SMatthew G. Knepley /*@ 38299252d075SMatthew G. Knepley PetscDSCopyBoundary - Copy all boundary condition objects to the new problem 38309252d075SMatthew G. Knepley 383120f4b53cSBarry Smith Not Collective 38329252d075SMatthew G. Knepley 383336951cb5SMatthew G. Knepley Input Parameters: 3834dce8aebaSBarry Smith + ds - The source `PetscDS` object 3835dce8aebaSBarry Smith . numFields - The number of selected fields, or `PETSC_DEFAULT` for all fields 383636951cb5SMatthew G. Knepley - fields - The selected fields, or NULL for all fields 38379252d075SMatthew G. Knepley 38389252d075SMatthew G. Knepley Output Parameter: 3839dce8aebaSBarry Smith . newds - The target `PetscDS`, now with a copy of the boundary conditions 38409252d075SMatthew G. Knepley 38419252d075SMatthew G. Knepley Level: intermediate 38429252d075SMatthew G. Knepley 3843dce8aebaSBarry Smith .seealso: `PetscDS`, `DMBoundary`, `PetscDSCopyEquations()`, `PetscDSSetResidual()`, `PetscDSSetJacobian()`, `PetscDSSetRiemannSolver()`, `PetscDSSetBdResidual()`, `PetscDSSetBdJacobian()`, `PetscDSCreate()` 38449252d075SMatthew G. Knepley @*/ 3845d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSCopyBoundary(PetscDS ds, PetscInt numFields, const PetscInt fields[], PetscDS newds) 3846d71ae5a4SJacob Faibussowitsch { 384745480ffeSMatthew G. Knepley DSBoundary b, *lastnext; 3848dff059c6SToby Isaac 3849dff059c6SToby Isaac PetscFunctionBegin; 385036951cb5SMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 385136951cb5SMatthew G. Knepley PetscValidHeaderSpecific(newds, PETSCDS_CLASSID, 4); 38523ba16761SJacob Faibussowitsch if (ds == newds) PetscFunctionReturn(PETSC_SUCCESS); 38539566063dSJacob Faibussowitsch PetscCall(PetscDSDestroyBoundary(newds)); 3854f4f49eeaSPierre Jolivet lastnext = &newds->boundary; 385536951cb5SMatthew G. Knepley for (b = ds->boundary; b; b = b->next) { 3856dff059c6SToby Isaac DSBoundary bNew; 385736951cb5SMatthew G. Knepley PetscInt fieldNew = -1; 3858dff059c6SToby Isaac 385936951cb5SMatthew G. Knepley if (numFields > 0 && fields) { 386036951cb5SMatthew G. Knepley PetscInt f; 386136951cb5SMatthew G. Knepley 38629371c9d4SSatish Balay for (f = 0; f < numFields; ++f) 38639371c9d4SSatish Balay if (b->field == fields[f]) break; 386436951cb5SMatthew G. Knepley if (f == numFields) continue; 386536951cb5SMatthew G. Knepley fieldNew = f; 386636951cb5SMatthew G. Knepley } 38679566063dSJacob Faibussowitsch PetscCall(DSBoundaryDuplicate_Internal(b, &bNew)); 386836951cb5SMatthew G. Knepley bNew->field = fieldNew < 0 ? b->field : fieldNew; 3869dff059c6SToby Isaac *lastnext = bNew; 3870f4f49eeaSPierre Jolivet lastnext = &bNew->next; 3871dff059c6SToby Isaac } 38723ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 3873dff059c6SToby Isaac } 3874dff059c6SToby Isaac 38756c1eb96dSMatthew G. Knepley /*@ 3876dce8aebaSBarry Smith PetscDSDestroyBoundary - Remove all `DMBoundary` objects from the `PetscDS` 387745480ffeSMatthew G. Knepley 387820f4b53cSBarry Smith Not Collective 387945480ffeSMatthew G. Knepley 388045480ffeSMatthew G. Knepley Input Parameter: 3881dce8aebaSBarry Smith . ds - The `PetscDS` object 388245480ffeSMatthew G. Knepley 388345480ffeSMatthew G. Knepley Level: intermediate 388445480ffeSMatthew G. Knepley 3885dce8aebaSBarry Smith .seealso: `PetscDS`, `DMBoundary`, `PetscDSCopyBoundary()`, `PetscDSCopyEquations()` 388645480ffeSMatthew G. Knepley @*/ 3887d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSDestroyBoundary(PetscDS ds) 3888d71ae5a4SJacob Faibussowitsch { 388945480ffeSMatthew G. Knepley DSBoundary next = ds->boundary; 389045480ffeSMatthew G. Knepley 389145480ffeSMatthew G. Knepley PetscFunctionBegin; 389245480ffeSMatthew G. Knepley while (next) { 389345480ffeSMatthew G. Knepley DSBoundary b = next; 389445480ffeSMatthew G. Knepley 389545480ffeSMatthew G. Knepley next = b->next; 38969566063dSJacob Faibussowitsch PetscCall(PetscWeakFormDestroy(&b->wf)); 38979566063dSJacob Faibussowitsch PetscCall(PetscFree(b->name)); 38989566063dSJacob Faibussowitsch PetscCall(PetscFree(b->lname)); 38999566063dSJacob Faibussowitsch PetscCall(PetscFree(b->values)); 39009566063dSJacob Faibussowitsch PetscCall(PetscFree(b->comps)); 39019566063dSJacob Faibussowitsch PetscCall(PetscFree(b)); 390245480ffeSMatthew G. Knepley } 39033ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 390445480ffeSMatthew G. Knepley } 390545480ffeSMatthew G. Knepley 390645480ffeSMatthew G. Knepley /*@ 39076c1eb96dSMatthew G. Knepley PetscDSSelectDiscretizations - Copy discretizations to the new problem with different field layout 39086c1eb96dSMatthew G. Knepley 390920f4b53cSBarry Smith Not Collective 39106c1eb96dSMatthew G. Knepley 3911d8d19677SJose E. Roman Input Parameters: 3912dce8aebaSBarry Smith + prob - The `PetscDS` object 39136c1eb96dSMatthew G. Knepley . numFields - Number of new fields 39146c1eb96dSMatthew G. Knepley - fields - Old field number for each new field 39156c1eb96dSMatthew G. Knepley 39166c1eb96dSMatthew G. Knepley Output Parameter: 3917dce8aebaSBarry Smith . newprob - The `PetscDS` copy 39186c1eb96dSMatthew G. Knepley 39196c1eb96dSMatthew G. Knepley Level: intermediate 39206c1eb96dSMatthew G. Knepley 3921dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSSelectEquations()`, `PetscDSCopyBoundary()`, `PetscDSSetResidual()`, `PetscDSSetJacobian()`, `PetscDSSetRiemannSolver()`, `PetscDSSetBdResidual()`, `PetscDSSetBdJacobian()`, `PetscDSCreate()` 39226c1eb96dSMatthew G. Knepley @*/ 3923d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSSelectDiscretizations(PetscDS prob, PetscInt numFields, const PetscInt fields[], PetscDS newprob) 3924d71ae5a4SJacob Faibussowitsch { 39256c1eb96dSMatthew G. Knepley PetscInt Nf, Nfn, fn; 39266c1eb96dSMatthew G. Knepley 39276c1eb96dSMatthew G. Knepley PetscFunctionBegin; 39286c1eb96dSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 39294f572ea9SToby Isaac if (fields) PetscAssertPointer(fields, 3); 39306c1eb96dSMatthew G. Knepley PetscValidHeaderSpecific(newprob, PETSCDS_CLASSID, 4); 39319566063dSJacob Faibussowitsch PetscCall(PetscDSGetNumFields(prob, &Nf)); 39329566063dSJacob Faibussowitsch PetscCall(PetscDSGetNumFields(newprob, &Nfn)); 393345480ffeSMatthew G. Knepley numFields = numFields < 0 ? Nf : numFields; 39346c1eb96dSMatthew G. Knepley for (fn = 0; fn < numFields; ++fn) { 39356c1eb96dSMatthew G. Knepley const PetscInt f = fields ? fields[fn] : fn; 39366c1eb96dSMatthew G. Knepley PetscObject disc; 39376c1eb96dSMatthew G. Knepley 39386c1eb96dSMatthew G. Knepley if (f >= Nf) continue; 39399566063dSJacob Faibussowitsch PetscCall(PetscDSGetDiscretization(prob, f, &disc)); 39409566063dSJacob Faibussowitsch PetscCall(PetscDSSetDiscretization(newprob, fn, disc)); 39416c1eb96dSMatthew G. Knepley } 39423ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 39436c1eb96dSMatthew G. Knepley } 39446c1eb96dSMatthew G. Knepley 39456c1eb96dSMatthew G. Knepley /*@ 39469252d075SMatthew G. Knepley PetscDSSelectEquations - Copy pointwise function pointers to the new problem with different field layout 39479252d075SMatthew G. Knepley 394820f4b53cSBarry Smith Not Collective 39499252d075SMatthew G. Knepley 3950d8d19677SJose E. Roman Input Parameters: 3951dce8aebaSBarry Smith + prob - The `PetscDS` object 39529252d075SMatthew G. Knepley . numFields - Number of new fields 39539252d075SMatthew G. Knepley - fields - Old field number for each new field 39549252d075SMatthew G. Knepley 39559252d075SMatthew G. Knepley Output Parameter: 3956dce8aebaSBarry Smith . newprob - The `PetscDS` copy 39579252d075SMatthew G. Knepley 39589252d075SMatthew G. Knepley Level: intermediate 39599252d075SMatthew G. Knepley 3960dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSSelectDiscretizations()`, `PetscDSCopyBoundary()`, `PetscDSSetResidual()`, `PetscDSSetJacobian()`, `PetscDSSetRiemannSolver()`, `PetscDSSetBdResidual()`, `PetscDSSetBdJacobian()`, `PetscDSCreate()` 39619252d075SMatthew G. Knepley @*/ 3962d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSSelectEquations(PetscDS prob, PetscInt numFields, const PetscInt fields[], PetscDS newprob) 3963d71ae5a4SJacob Faibussowitsch { 39649252d075SMatthew G. Knepley PetscInt Nf, Nfn, fn, gn; 39659252d075SMatthew G. Knepley 39669252d075SMatthew G. Knepley PetscFunctionBegin; 39679252d075SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 39684f572ea9SToby Isaac if (fields) PetscAssertPointer(fields, 3); 39699252d075SMatthew G. Knepley PetscValidHeaderSpecific(newprob, PETSCDS_CLASSID, 4); 39709566063dSJacob Faibussowitsch PetscCall(PetscDSGetNumFields(prob, &Nf)); 39719566063dSJacob Faibussowitsch PetscCall(PetscDSGetNumFields(newprob, &Nfn)); 397263a3b9bcSJacob Faibussowitsch PetscCheck(numFields <= Nfn, PetscObjectComm((PetscObject)prob), PETSC_ERR_ARG_SIZ, "Number of fields %" PetscInt_FMT " to transfer must not be greater then the total number of fields %" PetscInt_FMT, numFields, Nfn); 39739252d075SMatthew G. Knepley for (fn = 0; fn < numFields; ++fn) { 39749252d075SMatthew G. Knepley const PetscInt f = fields ? fields[fn] : fn; 39759252d075SMatthew G. Knepley PetscPointFunc obj; 39769252d075SMatthew G. Knepley PetscPointFunc f0, f1; 39779252d075SMatthew G. Knepley PetscBdPointFunc f0Bd, f1Bd; 39789252d075SMatthew G. Knepley PetscRiemannFunc r; 39799252d075SMatthew G. Knepley 3980c52f1e13SMatthew G. Knepley if (f >= Nf) continue; 39819566063dSJacob Faibussowitsch PetscCall(PetscDSGetObjective(prob, f, &obj)); 39829566063dSJacob Faibussowitsch PetscCall(PetscDSGetResidual(prob, f, &f0, &f1)); 39839566063dSJacob Faibussowitsch PetscCall(PetscDSGetBdResidual(prob, f, &f0Bd, &f1Bd)); 39849566063dSJacob Faibussowitsch PetscCall(PetscDSGetRiemannSolver(prob, f, &r)); 39859566063dSJacob Faibussowitsch PetscCall(PetscDSSetObjective(newprob, fn, obj)); 39869566063dSJacob Faibussowitsch PetscCall(PetscDSSetResidual(newprob, fn, f0, f1)); 39879566063dSJacob Faibussowitsch PetscCall(PetscDSSetBdResidual(newprob, fn, f0Bd, f1Bd)); 39889566063dSJacob Faibussowitsch PetscCall(PetscDSSetRiemannSolver(newprob, fn, r)); 39899252d075SMatthew G. Knepley for (gn = 0; gn < numFields; ++gn) { 39909252d075SMatthew G. Knepley const PetscInt g = fields ? fields[gn] : gn; 39919252d075SMatthew G. Knepley PetscPointJac g0, g1, g2, g3; 39929252d075SMatthew G. Knepley PetscPointJac g0p, g1p, g2p, g3p; 39939252d075SMatthew G. Knepley PetscBdPointJac g0Bd, g1Bd, g2Bd, g3Bd; 39949252d075SMatthew G. Knepley 3995c52f1e13SMatthew G. Knepley if (g >= Nf) continue; 39969566063dSJacob Faibussowitsch PetscCall(PetscDSGetJacobian(prob, f, g, &g0, &g1, &g2, &g3)); 39979566063dSJacob Faibussowitsch PetscCall(PetscDSGetJacobianPreconditioner(prob, f, g, &g0p, &g1p, &g2p, &g3p)); 39989566063dSJacob Faibussowitsch PetscCall(PetscDSGetBdJacobian(prob, f, g, &g0Bd, &g1Bd, &g2Bd, &g3Bd)); 39999566063dSJacob Faibussowitsch PetscCall(PetscDSSetJacobian(newprob, fn, gn, g0, g1, g2, g3)); 40009566063dSJacob Faibussowitsch PetscCall(PetscDSSetJacobianPreconditioner(newprob, fn, gn, g0p, g1p, g2p, g3p)); 40019566063dSJacob Faibussowitsch PetscCall(PetscDSSetBdJacobian(newprob, fn, gn, g0Bd, g1Bd, g2Bd, g3Bd)); 40029252d075SMatthew G. Knepley } 40039252d075SMatthew G. Knepley } 40043ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 40059252d075SMatthew G. Knepley } 40069252d075SMatthew G. Knepley 4007da51fcedSMatthew G. Knepley /*@ 4008dce8aebaSBarry Smith PetscDSCopyEquations - Copy all pointwise function pointers to another `PetscDS` 4009da51fcedSMatthew G. Knepley 401020f4b53cSBarry Smith Not Collective 4011da51fcedSMatthew G. Knepley 4012da51fcedSMatthew G. Knepley Input Parameter: 4013dce8aebaSBarry Smith . prob - The `PetscDS` object 4014da51fcedSMatthew G. Knepley 4015da51fcedSMatthew G. Knepley Output Parameter: 4016dce8aebaSBarry Smith . newprob - The `PetscDS` copy 4017da51fcedSMatthew G. Knepley 4018da51fcedSMatthew G. Knepley Level: intermediate 4019da51fcedSMatthew G. Knepley 4020dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSCopyBoundary()`, `PetscDSSetResidual()`, `PetscDSSetJacobian()`, `PetscDSSetRiemannSolver()`, `PetscDSSetBdResidual()`, `PetscDSSetBdJacobian()`, `PetscDSCreate()` 4021da51fcedSMatthew G. Knepley @*/ 4022d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSCopyEquations(PetscDS prob, PetscDS newprob) 4023d71ae5a4SJacob Faibussowitsch { 4024b8025e53SMatthew G. Knepley PetscWeakForm wf, newwf; 40259252d075SMatthew G. Knepley PetscInt Nf, Ng; 4026da51fcedSMatthew G. Knepley 4027da51fcedSMatthew G. Knepley PetscFunctionBegin; 4028da51fcedSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 4029da51fcedSMatthew G. Knepley PetscValidHeaderSpecific(newprob, PETSCDS_CLASSID, 2); 40309566063dSJacob Faibussowitsch PetscCall(PetscDSGetNumFields(prob, &Nf)); 40319566063dSJacob Faibussowitsch PetscCall(PetscDSGetNumFields(newprob, &Ng)); 403263a3b9bcSJacob Faibussowitsch PetscCheck(Nf == Ng, PetscObjectComm((PetscObject)prob), PETSC_ERR_ARG_SIZ, "Number of fields must match %" PetscInt_FMT " != %" PetscInt_FMT, Nf, Ng); 40339566063dSJacob Faibussowitsch PetscCall(PetscDSGetWeakForm(prob, &wf)); 40349566063dSJacob Faibussowitsch PetscCall(PetscDSGetWeakForm(newprob, &newwf)); 40359566063dSJacob Faibussowitsch PetscCall(PetscWeakFormCopy(wf, newwf)); 40363ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 40379252d075SMatthew G. Knepley } 403845480ffeSMatthew G. Knepley 40399252d075SMatthew G. Knepley /*@ 4040dce8aebaSBarry Smith PetscDSCopyConstants - Copy all constants to another `PetscDS` 4041da51fcedSMatthew G. Knepley 404220f4b53cSBarry Smith Not Collective 40439252d075SMatthew G. Knepley 40449252d075SMatthew G. Knepley Input Parameter: 4045dce8aebaSBarry Smith . prob - The `PetscDS` object 40469252d075SMatthew G. Knepley 40479252d075SMatthew G. Knepley Output Parameter: 4048dce8aebaSBarry Smith . newprob - The `PetscDS` copy 40499252d075SMatthew G. Knepley 40509252d075SMatthew G. Knepley Level: intermediate 40519252d075SMatthew G. Knepley 4052dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSCopyBoundary()`, `PetscDSCopyEquations()`, `PetscDSSetResidual()`, `PetscDSSetJacobian()`, `PetscDSSetRiemannSolver()`, `PetscDSSetBdResidual()`, `PetscDSSetBdJacobian()`, `PetscDSCreate()` 40539252d075SMatthew G. Knepley @*/ 4054d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSCopyConstants(PetscDS prob, PetscDS newprob) 4055d71ae5a4SJacob Faibussowitsch { 40569252d075SMatthew G. Knepley PetscInt Nc; 40579252d075SMatthew G. Knepley const PetscScalar *constants; 40589252d075SMatthew G. Knepley 40599252d075SMatthew G. Knepley PetscFunctionBegin; 40609252d075SMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 40619252d075SMatthew G. Knepley PetscValidHeaderSpecific(newprob, PETSCDS_CLASSID, 2); 40629566063dSJacob Faibussowitsch PetscCall(PetscDSGetConstants(prob, &Nc, &constants)); 40639566063dSJacob Faibussowitsch PetscCall(PetscDSSetConstants(newprob, Nc, (PetscScalar *)constants)); 40643ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 4065da51fcedSMatthew G. Knepley } 4066da51fcedSMatthew G. Knepley 406745480ffeSMatthew G. Knepley /*@ 4068dce8aebaSBarry Smith PetscDSCopyExactSolutions - Copy all exact solutions to another `PetscDS` 406945480ffeSMatthew G. Knepley 407020f4b53cSBarry Smith Not Collective 407145480ffeSMatthew G. Knepley 407245480ffeSMatthew G. Knepley Input Parameter: 4073dce8aebaSBarry Smith . ds - The `PetscDS` object 407445480ffeSMatthew G. Knepley 407545480ffeSMatthew G. Knepley Output Parameter: 4076dce8aebaSBarry Smith . newds - The `PetscDS` copy 407745480ffeSMatthew G. Knepley 407845480ffeSMatthew G. Knepley Level: intermediate 407945480ffeSMatthew G. Knepley 4080dce8aebaSBarry Smith .seealso: `PetscDS`, `PetscDSCopyBoundary()`, `PetscDSCopyEquations()`, `PetscDSSetResidual()`, `PetscDSSetJacobian()`, `PetscDSSetRiemannSolver()`, `PetscDSSetBdResidual()`, `PetscDSSetBdJacobian()`, `PetscDSCreate()` 408145480ffeSMatthew G. Knepley @*/ 4082d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSCopyExactSolutions(PetscDS ds, PetscDS newds) 4083d71ae5a4SJacob Faibussowitsch { 40848434afd1SBarry Smith PetscSimplePointFn *sol; 408545480ffeSMatthew G. Knepley void *ctx; 408645480ffeSMatthew G. Knepley PetscInt Nf, f; 408745480ffeSMatthew G. Knepley 408845480ffeSMatthew G. Knepley PetscFunctionBegin; 408945480ffeSMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 409045480ffeSMatthew G. Knepley PetscValidHeaderSpecific(newds, PETSCDS_CLASSID, 2); 40919566063dSJacob Faibussowitsch PetscCall(PetscDSGetNumFields(ds, &Nf)); 409245480ffeSMatthew G. Knepley for (f = 0; f < Nf; ++f) { 40939566063dSJacob Faibussowitsch PetscCall(PetscDSGetExactSolution(ds, f, &sol, &ctx)); 40949566063dSJacob Faibussowitsch PetscCall(PetscDSSetExactSolution(newds, f, sol, ctx)); 40959566063dSJacob Faibussowitsch PetscCall(PetscDSGetExactSolutionTimeDerivative(ds, f, &sol, &ctx)); 40969566063dSJacob Faibussowitsch PetscCall(PetscDSSetExactSolutionTimeDerivative(newds, f, sol, ctx)); 409745480ffeSMatthew G. Knepley } 40983ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 409945480ffeSMatthew G. Knepley } 410045480ffeSMatthew G. Knepley 410107218a29SMatthew G. Knepley PetscErrorCode PetscDSCopy(PetscDS ds, DM dmNew, PetscDS dsNew) 410207218a29SMatthew G. Knepley { 410307218a29SMatthew G. Knepley DSBoundary b; 410407218a29SMatthew G. Knepley PetscInt cdim, Nf, f, d; 410507218a29SMatthew G. Knepley PetscBool isCohesive; 410607218a29SMatthew G. Knepley void *ctx; 410707218a29SMatthew G. Knepley 410807218a29SMatthew G. Knepley PetscFunctionBegin; 410907218a29SMatthew G. Knepley PetscCall(PetscDSCopyConstants(ds, dsNew)); 411007218a29SMatthew G. Knepley PetscCall(PetscDSCopyExactSolutions(ds, dsNew)); 411107218a29SMatthew G. Knepley PetscCall(PetscDSSelectDiscretizations(ds, PETSC_DETERMINE, NULL, dsNew)); 411207218a29SMatthew G. Knepley PetscCall(PetscDSCopyEquations(ds, dsNew)); 411307218a29SMatthew G. Knepley PetscCall(PetscDSGetNumFields(ds, &Nf)); 411407218a29SMatthew G. Knepley for (f = 0; f < Nf; ++f) { 411507218a29SMatthew G. Knepley PetscCall(PetscDSGetContext(ds, f, &ctx)); 411607218a29SMatthew G. Knepley PetscCall(PetscDSSetContext(dsNew, f, ctx)); 411707218a29SMatthew G. Knepley PetscCall(PetscDSGetCohesive(ds, f, &isCohesive)); 411807218a29SMatthew G. Knepley PetscCall(PetscDSSetCohesive(dsNew, f, isCohesive)); 411907218a29SMatthew G. Knepley PetscCall(PetscDSGetJetDegree(ds, f, &d)); 412007218a29SMatthew G. Knepley PetscCall(PetscDSSetJetDegree(dsNew, f, d)); 412107218a29SMatthew G. Knepley } 412207218a29SMatthew G. Knepley if (Nf) { 412307218a29SMatthew G. Knepley PetscCall(PetscDSGetCoordinateDimension(ds, &cdim)); 412407218a29SMatthew G. Knepley PetscCall(PetscDSSetCoordinateDimension(dsNew, cdim)); 412507218a29SMatthew G. Knepley } 412607218a29SMatthew G. Knepley PetscCall(PetscDSCopyBoundary(ds, PETSC_DETERMINE, NULL, dsNew)); 412707218a29SMatthew G. Knepley for (b = dsNew->boundary; b; b = b->next) { 412807218a29SMatthew G. Knepley PetscCall(DMGetLabel(dmNew, b->lname, &b->label)); 412907218a29SMatthew G. Knepley /* Do not check if label exists here, since p4est calls this for the reference tree which does not have the labels */ 413007218a29SMatthew G. Knepley //PetscCheck(b->label,PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Label %s missing in new DM", name); 413107218a29SMatthew G. Knepley } 413207218a29SMatthew G. Knepley PetscFunctionReturn(PETSC_SUCCESS); 413307218a29SMatthew G. Knepley } 413407218a29SMatthew G. Knepley 4135d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSGetHeightSubspace(PetscDS prob, PetscInt height, PetscDS *subprob) 4136d71ae5a4SJacob Faibussowitsch { 4137df3a45bdSMatthew G. Knepley PetscInt dim, Nf, f; 4138b1353e8eSMatthew G. Knepley 4139b1353e8eSMatthew G. Knepley PetscFunctionBegin; 4140b1353e8eSMatthew G. Knepley PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 1); 41414f572ea9SToby Isaac PetscAssertPointer(subprob, 3); 41429371c9d4SSatish Balay if (height == 0) { 41439371c9d4SSatish Balay *subprob = prob; 41443ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 41459371c9d4SSatish Balay } 41469566063dSJacob Faibussowitsch PetscCall(PetscDSGetNumFields(prob, &Nf)); 41479566063dSJacob Faibussowitsch PetscCall(PetscDSGetSpatialDimension(prob, &dim)); 414863a3b9bcSJacob Faibussowitsch PetscCheck(height <= dim, PetscObjectComm((PetscObject)prob), PETSC_ERR_ARG_OUTOFRANGE, "DS can only handle height in [0, %" PetscInt_FMT "], not %" PetscInt_FMT, dim, height); 41499566063dSJacob Faibussowitsch if (!prob->subprobs) PetscCall(PetscCalloc1(dim, &prob->subprobs)); 4150df3a45bdSMatthew G. Knepley if (!prob->subprobs[height - 1]) { 4151b1353e8eSMatthew G. Knepley PetscInt cdim; 4152b1353e8eSMatthew G. Knepley 41539566063dSJacob Faibussowitsch PetscCall(PetscDSCreate(PetscObjectComm((PetscObject)prob), &prob->subprobs[height - 1])); 41549566063dSJacob Faibussowitsch PetscCall(PetscDSGetCoordinateDimension(prob, &cdim)); 41559566063dSJacob Faibussowitsch PetscCall(PetscDSSetCoordinateDimension(prob->subprobs[height - 1], cdim)); 4156b1353e8eSMatthew G. Knepley for (f = 0; f < Nf; ++f) { 4157b1353e8eSMatthew G. Knepley PetscFE subfe; 4158b1353e8eSMatthew G. Knepley PetscObject obj; 4159b1353e8eSMatthew G. Knepley PetscClassId id; 4160b1353e8eSMatthew G. Knepley 41619566063dSJacob Faibussowitsch PetscCall(PetscDSGetDiscretization(prob, f, &obj)); 41629566063dSJacob Faibussowitsch PetscCall(PetscObjectGetClassId(obj, &id)); 41639566063dSJacob Faibussowitsch if (id == PETSCFE_CLASSID) PetscCall(PetscFEGetHeightSubspace((PetscFE)obj, height, &subfe)); 416463a3b9bcSJacob Faibussowitsch else SETERRQ(PetscObjectComm((PetscObject)prob), PETSC_ERR_ARG_WRONG, "Unsupported discretization type for field %" PetscInt_FMT, f); 41659566063dSJacob Faibussowitsch PetscCall(PetscDSSetDiscretization(prob->subprobs[height - 1], f, (PetscObject)subfe)); 4166b1353e8eSMatthew G. Knepley } 4167b1353e8eSMatthew G. Knepley } 4168df3a45bdSMatthew G. Knepley *subprob = prob->subprobs[height - 1]; 41693ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 4170b1353e8eSMatthew G. Knepley } 4171b1353e8eSMatthew G. Knepley 41724366bac7SMatthew G. Knepley PetscErrorCode PetscDSPermuteQuadPoint(PetscDS ds, PetscInt ornt, PetscInt field, PetscInt q, PetscInt *qperm) 41734366bac7SMatthew G. Knepley { 41744366bac7SMatthew G. Knepley IS permIS; 41754366bac7SMatthew G. Knepley PetscQuadrature quad; 41764366bac7SMatthew G. Knepley DMPolytopeType ct; 41774366bac7SMatthew G. Knepley const PetscInt *perm; 41784366bac7SMatthew G. Knepley PetscInt Na, Nq; 41794366bac7SMatthew G. Knepley 41804366bac7SMatthew G. Knepley PetscFunctionBeginHot; 41814366bac7SMatthew G. Knepley PetscCall(PetscFEGetQuadrature((PetscFE)ds->disc[field], &quad)); 41824366bac7SMatthew G. Knepley PetscCall(PetscQuadratureGetData(quad, NULL, NULL, &Nq, NULL, NULL)); 41834366bac7SMatthew G. Knepley PetscCall(PetscQuadratureGetCellType(quad, &ct)); 41844366bac7SMatthew G. Knepley PetscCheck(q >= 0 && q < Nq, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Quadrature point %" PetscInt_FMT " is not in [0, %" PetscInt_FMT ")", q, Nq); 418585036b15SMatthew G. Knepley Na = DMPolytopeTypeGetNumArrangements(ct) / 2; 41864366bac7SMatthew G. Knepley PetscCheck(ornt >= -Na && ornt < Na, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Orientation %" PetscInt_FMT " of %s is not in [%" PetscInt_FMT ", %" PetscInt_FMT ")", ornt, DMPolytopeTypes[ct], -Na, Na); 41874366bac7SMatthew G. Knepley if (!ds->quadPerm[(PetscInt)ct]) PetscCall(PetscQuadratureComputePermutations(quad, NULL, &ds->quadPerm[(PetscInt)ct])); 41884366bac7SMatthew G. Knepley permIS = ds->quadPerm[(PetscInt)ct][ornt + Na]; 41894366bac7SMatthew G. Knepley PetscCall(ISGetIndices(permIS, &perm)); 41904366bac7SMatthew G. Knepley *qperm = perm[q]; 41914366bac7SMatthew G. Knepley PetscCall(ISRestoreIndices(permIS, &perm)); 41924366bac7SMatthew G. Knepley PetscFunctionReturn(PETSC_SUCCESS); 41934366bac7SMatthew G. Knepley } 41944366bac7SMatthew G. Knepley 4195d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDSGetDiscType_Internal(PetscDS ds, PetscInt f, PetscDiscType *disctype) 4196d71ae5a4SJacob Faibussowitsch { 4197c7bd5f0bSMatthew G. Knepley PetscObject obj; 4198c7bd5f0bSMatthew G. Knepley PetscClassId id; 4199c7bd5f0bSMatthew G. Knepley PetscInt Nf; 4200c7bd5f0bSMatthew G. Knepley 4201c7bd5f0bSMatthew G. Knepley PetscFunctionBegin; 4202c7bd5f0bSMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 42034f572ea9SToby Isaac PetscAssertPointer(disctype, 3); 4204665f567fSMatthew G. Knepley *disctype = PETSC_DISC_NONE; 42059566063dSJacob Faibussowitsch PetscCall(PetscDSGetNumFields(ds, &Nf)); 420663a3b9bcSJacob Faibussowitsch PetscCheck(f < Nf, PetscObjectComm((PetscObject)ds), PETSC_ERR_ARG_SIZ, "Field %" PetscInt_FMT " must be in [0, %" PetscInt_FMT ")", f, Nf); 42079566063dSJacob Faibussowitsch PetscCall(PetscDSGetDiscretization(ds, f, &obj)); 4208665f567fSMatthew G. Knepley if (obj) { 42099566063dSJacob Faibussowitsch PetscCall(PetscObjectGetClassId(obj, &id)); 4210665f567fSMatthew G. Knepley if (id == PETSCFE_CLASSID) *disctype = PETSC_DISC_FE; 4211665f567fSMatthew G. Knepley else *disctype = PETSC_DISC_FV; 4212665f567fSMatthew G. Knepley } 42133ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 4214c7bd5f0bSMatthew G. Knepley } 4215c7bd5f0bSMatthew G. Knepley 4216d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscDSDestroy_Basic(PetscDS ds) 4217d71ae5a4SJacob Faibussowitsch { 42182764a2aaSMatthew G. Knepley PetscFunctionBegin; 42199566063dSJacob Faibussowitsch PetscCall(PetscFree(ds->data)); 42203ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 42212764a2aaSMatthew G. Knepley } 42222764a2aaSMatthew G. Knepley 4223d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscDSInitialize_Basic(PetscDS ds) 4224d71ae5a4SJacob Faibussowitsch { 42252764a2aaSMatthew G. Knepley PetscFunctionBegin; 42266528b96dSMatthew G. Knepley ds->ops->setfromoptions = NULL; 42276528b96dSMatthew G. Knepley ds->ops->setup = NULL; 42286528b96dSMatthew G. Knepley ds->ops->view = NULL; 42296528b96dSMatthew G. Knepley ds->ops->destroy = PetscDSDestroy_Basic; 42303ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 42312764a2aaSMatthew G. Knepley } 42322764a2aaSMatthew G. Knepley 42332764a2aaSMatthew G. Knepley /*MC 42342764a2aaSMatthew G. Knepley PETSCDSBASIC = "basic" - A discrete system with pointwise residual and boundary residual functions 42352764a2aaSMatthew G. Knepley 42362764a2aaSMatthew G. Knepley Level: intermediate 42372764a2aaSMatthew G. Knepley 4238db781477SPatrick Sanan .seealso: `PetscDSType`, `PetscDSCreate()`, `PetscDSSetType()` 42392764a2aaSMatthew G. Knepley M*/ 42402764a2aaSMatthew G. Knepley 4241d71ae5a4SJacob Faibussowitsch PETSC_EXTERN PetscErrorCode PetscDSCreate_Basic(PetscDS ds) 4242d71ae5a4SJacob Faibussowitsch { 42432764a2aaSMatthew G. Knepley PetscDS_Basic *b; 42442764a2aaSMatthew G. Knepley 42452764a2aaSMatthew G. Knepley PetscFunctionBegin; 42466528b96dSMatthew G. Knepley PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 1); 42474dfa11a4SJacob Faibussowitsch PetscCall(PetscNew(&b)); 42486528b96dSMatthew G. Knepley ds->data = b; 42492764a2aaSMatthew G. Knepley 42509566063dSJacob Faibussowitsch PetscCall(PetscDSInitialize_Basic(ds)); 42513ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 42522764a2aaSMatthew G. Knepley } 4253