1ea844a1aSMatthew Knepley /* 2ea844a1aSMatthew Knepley This file contains routines for basic section object implementation. 3ea844a1aSMatthew Knepley */ 4ea844a1aSMatthew Knepley 5ea844a1aSMatthew Knepley #include <petsc/private/sectionimpl.h> /*I "petscsection.h" I*/ 6ea844a1aSMatthew Knepley #include <petscsf.h> 7ea844a1aSMatthew Knepley 8ea844a1aSMatthew Knepley PetscClassId PETSC_SECTION_CLASSID; 9ea844a1aSMatthew Knepley 10ea844a1aSMatthew Knepley /*@ 1120662ed9SBarry Smith PetscSectionCreate - Allocates a `PetscSection` and sets the map contents to the default. 12ea844a1aSMatthew Knepley 13ea844a1aSMatthew Knepley Collective 14ea844a1aSMatthew Knepley 15ea844a1aSMatthew Knepley Input Parameters: 16ea844a1aSMatthew Knepley + comm - the MPI communicator 17ea844a1aSMatthew Knepley - s - pointer to the section 18ea844a1aSMatthew Knepley 19ea844a1aSMatthew Knepley Level: beginner 20ea844a1aSMatthew Knepley 21ea844a1aSMatthew Knepley Notes: 22ea844a1aSMatthew Knepley Typical calling sequence 23cab54364SBarry Smith .vb 24cab54364SBarry Smith PetscSectionCreate(MPI_Comm,PetscSection *);! 25cab54364SBarry Smith PetscSectionSetNumFields(PetscSection, numFields); 26cab54364SBarry Smith PetscSectionSetChart(PetscSection,low,high); 27cab54364SBarry Smith PetscSectionSetDof(PetscSection,point,numdof); 28cab54364SBarry Smith PetscSectionSetUp(PetscSection); 29cab54364SBarry Smith PetscSectionGetOffset(PetscSection,point,PetscInt *); 30cab54364SBarry Smith PetscSectionDestroy(PetscSection); 31cab54364SBarry Smith .ve 32ea844a1aSMatthew Knepley 3335cb6cd3SPierre Jolivet The `PetscSection` object and methods are intended to be used in the PETSc `Vec` and `Mat` implementations. The indices returned by the `PetscSection` are appropriate for the kind of `Vec` it is associated with. For example, if the vector being indexed is a local vector, we call the section a local section. If the section indexes a global vector, we call it a global section. For parallel vectors, like global vectors, we use negative indices to indicate dofs owned by other processes. 34ea844a1aSMatthew Knepley 35583308b6SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionSetChart()`, `PetscSectionDestroy()`, `PetscSectionCreateGlobalSection()` 36ea844a1aSMatthew Knepley @*/ 37d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionCreate(MPI_Comm comm, PetscSection *s) 38d71ae5a4SJacob Faibussowitsch { 39ea844a1aSMatthew Knepley PetscFunctionBegin; 404f572ea9SToby Isaac PetscAssertPointer(s, 2); 419566063dSJacob Faibussowitsch PetscCall(ISInitializePackage()); 42ea844a1aSMatthew Knepley 439566063dSJacob Faibussowitsch PetscCall(PetscHeaderCreate(*s, PETSC_SECTION_CLASSID, "PetscSection", "Section", "IS", comm, PetscSectionDestroy, PetscSectionView)); 44ea844a1aSMatthew Knepley 45ea844a1aSMatthew Knepley (*s)->pStart = -1; 46ea844a1aSMatthew Knepley (*s)->pEnd = -1; 47ea844a1aSMatthew Knepley (*s)->perm = NULL; 48ea844a1aSMatthew Knepley (*s)->pointMajor = PETSC_TRUE; 4987e637c6Sksagiyam (*s)->includesConstraints = PETSC_TRUE; 50ea844a1aSMatthew Knepley (*s)->atlasDof = NULL; 51ea844a1aSMatthew Knepley (*s)->atlasOff = NULL; 52ea844a1aSMatthew Knepley (*s)->bc = NULL; 53ea844a1aSMatthew Knepley (*s)->bcIndices = NULL; 54ea844a1aSMatthew Knepley (*s)->setup = PETSC_FALSE; 55ea844a1aSMatthew Knepley (*s)->numFields = 0; 56ea844a1aSMatthew Knepley (*s)->fieldNames = NULL; 57ea844a1aSMatthew Knepley (*s)->field = NULL; 58ea844a1aSMatthew Knepley (*s)->useFieldOff = PETSC_FALSE; 59b778fa18SValeria Barra (*s)->compNames = NULL; 60ea844a1aSMatthew Knepley (*s)->clObj = NULL; 61c459fbc1SJed Brown (*s)->clHash = NULL; 62ea844a1aSMatthew Knepley (*s)->clSection = NULL; 63ea844a1aSMatthew Knepley (*s)->clPoints = NULL; 6469c11d05SVaclav Hapla PetscCall(PetscSectionInvalidateMaxDof_Internal(*s)); 653ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 66ea844a1aSMatthew Knepley } 67ea844a1aSMatthew Knepley 68ea844a1aSMatthew Knepley /*@ 69cab54364SBarry Smith PetscSectionCopy - Creates a shallow (if possible) copy of the `PetscSection` 70ea844a1aSMatthew Knepley 71ea844a1aSMatthew Knepley Collective 72ea844a1aSMatthew Knepley 73ea844a1aSMatthew Knepley Input Parameter: 74cab54364SBarry Smith . section - the `PetscSection` 75ea844a1aSMatthew Knepley 76ea844a1aSMatthew Knepley Output Parameter: 77ea844a1aSMatthew Knepley . newSection - the copy 78ea844a1aSMatthew Knepley 79ea844a1aSMatthew Knepley Level: intermediate 80ea844a1aSMatthew Knepley 8138b5cf2dSJacob Faibussowitsch Developer Notes: 82cab54364SBarry Smith What exactly does shallow mean in this context? 83cab54364SBarry Smith 84cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionCreate()`, `PetscSectionDestroy()` 85ea844a1aSMatthew Knepley @*/ 86d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionCopy(PetscSection section, PetscSection newSection) 87d71ae5a4SJacob Faibussowitsch { 883857f682SStefano Zampini PetscFunctionBegin; 893857f682SStefano Zampini PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1); 903857f682SStefano Zampini PetscValidHeaderSpecific(newSection, PETSC_SECTION_CLASSID, 2); 913857f682SStefano Zampini PetscCall(PetscSectionCopy_Internal(section, newSection, NULL)); 923857f682SStefano Zampini PetscFunctionReturn(PETSC_SUCCESS); 933857f682SStefano Zampini } 943857f682SStefano Zampini 953857f682SStefano Zampini PetscErrorCode PetscSectionCopy_Internal(PetscSection section, PetscSection newSection, PetscBT constrained_dofs) 963857f682SStefano Zampini { 97ea844a1aSMatthew Knepley PetscSectionSym sym; 98ea844a1aSMatthew Knepley IS perm; 99b778fa18SValeria Barra PetscInt numFields, f, c, pStart, pEnd, p; 100ea844a1aSMatthew Knepley 101ea844a1aSMatthew Knepley PetscFunctionBegin; 102ea844a1aSMatthew Knepley PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1); 103ea844a1aSMatthew Knepley PetscValidHeaderSpecific(newSection, PETSC_SECTION_CLASSID, 2); 1049566063dSJacob Faibussowitsch PetscCall(PetscSectionReset(newSection)); 1059566063dSJacob Faibussowitsch PetscCall(PetscSectionGetNumFields(section, &numFields)); 1069566063dSJacob Faibussowitsch if (numFields) PetscCall(PetscSectionSetNumFields(newSection, numFields)); 107ea844a1aSMatthew Knepley for (f = 0; f < numFields; ++f) { 108b778fa18SValeria Barra const char *fieldName = NULL, *compName = NULL; 109ea844a1aSMatthew Knepley PetscInt numComp = 0; 110ea844a1aSMatthew Knepley 1119566063dSJacob Faibussowitsch PetscCall(PetscSectionGetFieldName(section, f, &fieldName)); 1129566063dSJacob Faibussowitsch PetscCall(PetscSectionSetFieldName(newSection, f, fieldName)); 1139566063dSJacob Faibussowitsch PetscCall(PetscSectionGetFieldComponents(section, f, &numComp)); 1149566063dSJacob Faibussowitsch PetscCall(PetscSectionSetFieldComponents(newSection, f, numComp)); 115b778fa18SValeria Barra for (c = 0; c < numComp; ++c) { 1169566063dSJacob Faibussowitsch PetscCall(PetscSectionGetComponentName(section, f, c, &compName)); 1179566063dSJacob Faibussowitsch PetscCall(PetscSectionSetComponentName(newSection, f, c, compName)); 118b778fa18SValeria Barra } 1199566063dSJacob Faibussowitsch PetscCall(PetscSectionGetFieldSym(section, f, &sym)); 1209566063dSJacob Faibussowitsch PetscCall(PetscSectionSetFieldSym(newSection, f, sym)); 121ea844a1aSMatthew Knepley } 1229566063dSJacob Faibussowitsch PetscCall(PetscSectionGetChart(section, &pStart, &pEnd)); 1239566063dSJacob Faibussowitsch PetscCall(PetscSectionSetChart(newSection, pStart, pEnd)); 1249566063dSJacob Faibussowitsch PetscCall(PetscSectionGetPermutation(section, &perm)); 1259566063dSJacob Faibussowitsch PetscCall(PetscSectionSetPermutation(newSection, perm)); 1269566063dSJacob Faibussowitsch PetscCall(PetscSectionGetSym(section, &sym)); 1279566063dSJacob Faibussowitsch PetscCall(PetscSectionSetSym(newSection, sym)); 128ea844a1aSMatthew Knepley for (p = pStart; p < pEnd; ++p) { 129ea844a1aSMatthew Knepley PetscInt dof, cdof, fcdof = 0; 1303857f682SStefano Zampini PetscBool force_constrained = (PetscBool)(constrained_dofs && PetscBTLookup(constrained_dofs, p - pStart)); 131ea844a1aSMatthew Knepley 1329566063dSJacob Faibussowitsch PetscCall(PetscSectionGetDof(section, p, &dof)); 1339566063dSJacob Faibussowitsch PetscCall(PetscSectionSetDof(newSection, p, dof)); 1343857f682SStefano Zampini if (force_constrained) cdof = dof; 1353857f682SStefano Zampini else PetscCall(PetscSectionGetConstraintDof(section, p, &cdof)); 1369566063dSJacob Faibussowitsch if (cdof) PetscCall(PetscSectionSetConstraintDof(newSection, p, cdof)); 137ea844a1aSMatthew Knepley for (f = 0; f < numFields; ++f) { 1389566063dSJacob Faibussowitsch PetscCall(PetscSectionGetFieldDof(section, p, f, &dof)); 1399566063dSJacob Faibussowitsch PetscCall(PetscSectionSetFieldDof(newSection, p, f, dof)); 140ea844a1aSMatthew Knepley if (cdof) { 1413857f682SStefano Zampini if (force_constrained) fcdof = dof; 1423857f682SStefano Zampini else PetscCall(PetscSectionGetFieldConstraintDof(section, p, f, &fcdof)); 1439566063dSJacob Faibussowitsch if (fcdof) PetscCall(PetscSectionSetFieldConstraintDof(newSection, p, f, fcdof)); 144ea844a1aSMatthew Knepley } 145ea844a1aSMatthew Knepley } 146ea844a1aSMatthew Knepley } 1479566063dSJacob Faibussowitsch PetscCall(PetscSectionSetUp(newSection)); 148ea844a1aSMatthew Knepley for (p = pStart; p < pEnd; ++p) { 149ea844a1aSMatthew Knepley PetscInt off, cdof, fcdof = 0; 150ea844a1aSMatthew Knepley const PetscInt *cInd; 1513857f682SStefano Zampini PetscBool force_constrained = (PetscBool)(constrained_dofs && PetscBTLookup(constrained_dofs, p - pStart)); 152ea844a1aSMatthew Knepley 153ea844a1aSMatthew Knepley /* Must set offsets in case they do not agree with the prefix sums */ 1549566063dSJacob Faibussowitsch PetscCall(PetscSectionGetOffset(section, p, &off)); 1559566063dSJacob Faibussowitsch PetscCall(PetscSectionSetOffset(newSection, p, off)); 1563857f682SStefano Zampini PetscCall(PetscSectionGetConstraintDof(newSection, p, &cdof)); 157ea844a1aSMatthew Knepley if (cdof) { 1583857f682SStefano Zampini if (force_constrained) cInd = NULL; 1593857f682SStefano Zampini else PetscCall(PetscSectionGetConstraintIndices(section, p, &cInd)); 1609566063dSJacob Faibussowitsch PetscCall(PetscSectionSetConstraintIndices(newSection, p, cInd)); 161ea844a1aSMatthew Knepley for (f = 0; f < numFields; ++f) { 1623857f682SStefano Zampini PetscCall(PetscSectionGetFieldOffset(section, p, f, &off)); 1633857f682SStefano Zampini PetscCall(PetscSectionSetFieldOffset(newSection, p, f, off)); 1643857f682SStefano Zampini PetscCall(PetscSectionGetFieldConstraintDof(newSection, p, f, &fcdof)); 165ea844a1aSMatthew Knepley if (fcdof) { 1663857f682SStefano Zampini if (force_constrained) cInd = NULL; 1673857f682SStefano Zampini else PetscCall(PetscSectionGetFieldConstraintIndices(section, p, f, &cInd)); 1689566063dSJacob Faibussowitsch PetscCall(PetscSectionSetFieldConstraintIndices(newSection, p, f, cInd)); 169ea844a1aSMatthew Knepley } 170ea844a1aSMatthew Knepley } 171ea844a1aSMatthew Knepley } 172ea844a1aSMatthew Knepley } 1733ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 174ea844a1aSMatthew Knepley } 175ea844a1aSMatthew Knepley 176ea844a1aSMatthew Knepley /*@ 177cab54364SBarry Smith PetscSectionClone - Creates a shallow (if possible) copy of the `PetscSection` 178ea844a1aSMatthew Knepley 179ea844a1aSMatthew Knepley Collective 180ea844a1aSMatthew Knepley 181ea844a1aSMatthew Knepley Input Parameter: 182cab54364SBarry Smith . section - the `PetscSection` 183ea844a1aSMatthew Knepley 184ea844a1aSMatthew Knepley Output Parameter: 185ea844a1aSMatthew Knepley . newSection - the copy 186ea844a1aSMatthew Knepley 187ea844a1aSMatthew Knepley Level: beginner 188ea844a1aSMatthew Knepley 18938b5cf2dSJacob Faibussowitsch Developer Notes: 190cab54364SBarry Smith With standard PETSc terminology this should be called `PetscSectionDuplicate()` 191cab54364SBarry Smith 192cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionCreate()`, `PetscSectionDestroy()`, `PetscSectionCopy()` 193ea844a1aSMatthew Knepley @*/ 194d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionClone(PetscSection section, PetscSection *newSection) 195d71ae5a4SJacob Faibussowitsch { 196ea844a1aSMatthew Knepley PetscFunctionBegin; 197ea844a1aSMatthew Knepley PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1); 1984f572ea9SToby Isaac PetscAssertPointer(newSection, 2); 1999566063dSJacob Faibussowitsch PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject)section), newSection)); 2009566063dSJacob Faibussowitsch PetscCall(PetscSectionCopy(section, *newSection)); 2013ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 202ea844a1aSMatthew Knepley } 203ea844a1aSMatthew Knepley 204ea844a1aSMatthew Knepley /*@ 205cab54364SBarry Smith PetscSectionSetFromOptions - sets parameters in a `PetscSection` from the options database 206ea844a1aSMatthew Knepley 20740750d41SVaclav Hapla Collective 208ea844a1aSMatthew Knepley 209ea844a1aSMatthew Knepley Input Parameter: 21038b5cf2dSJacob Faibussowitsch . s - the `PetscSection` 211ea844a1aSMatthew Knepley 21220662ed9SBarry Smith Options Database Key: 213cab54364SBarry Smith . -petscsection_point_major - `PETSC_TRUE` for point-major order 214ea844a1aSMatthew Knepley 215ea844a1aSMatthew Knepley Level: intermediate 216ea844a1aSMatthew Knepley 217cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionCreate()`, `PetscSectionDestroy()` 218ea844a1aSMatthew Knepley @*/ 219d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetFromOptions(PetscSection s) 220d71ae5a4SJacob Faibussowitsch { 221ea844a1aSMatthew Knepley PetscFunctionBegin; 222ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 223d0609cedSBarry Smith PetscObjectOptionsBegin((PetscObject)s); 2249566063dSJacob Faibussowitsch PetscCall(PetscOptionsBool("-petscsection_point_major", "The for ordering, either point major or field major", "PetscSectionSetPointMajor", s->pointMajor, &s->pointMajor, NULL)); 225ea844a1aSMatthew Knepley /* process any options handlers added with PetscObjectAddOptionsHandler() */ 226dbbe0bcdSBarry Smith PetscCall(PetscObjectProcessOptionsHandlers((PetscObject)s, PetscOptionsObject)); 227d0609cedSBarry Smith PetscOptionsEnd(); 2289566063dSJacob Faibussowitsch PetscCall(PetscObjectViewFromOptions((PetscObject)s, NULL, "-petscsection_view")); 2293ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 230ea844a1aSMatthew Knepley } 231ea844a1aSMatthew Knepley 232ea844a1aSMatthew Knepley /*@ 233ea844a1aSMatthew Knepley PetscSectionCompare - Compares two sections 234ea844a1aSMatthew Knepley 23540750d41SVaclav Hapla Collective 236ea844a1aSMatthew Knepley 2377a7aea1fSJed Brown Input Parameters: 238cab54364SBarry Smith + s1 - the first `PetscSection` 239cab54364SBarry Smith - s2 - the second `PetscSection` 240ea844a1aSMatthew Knepley 241ea844a1aSMatthew Knepley Output Parameter: 242cab54364SBarry Smith . congruent - `PETSC_TRUE` if the two sections are congruent, `PETSC_FALSE` otherwise 243ea844a1aSMatthew Knepley 244ea844a1aSMatthew Knepley Level: intermediate 245ea844a1aSMatthew Knepley 246cab54364SBarry Smith Note: 247ea844a1aSMatthew Knepley Field names are disregarded. 248ea844a1aSMatthew Knepley 249cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionCreate()`, `PetscSectionCopy()`, `PetscSectionClone()` 250ea844a1aSMatthew Knepley @*/ 251d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionCompare(PetscSection s1, PetscSection s2, PetscBool *congruent) 252d71ae5a4SJacob Faibussowitsch { 253ea844a1aSMatthew Knepley PetscInt pStart, pEnd, nfields, ncdof, nfcdof, p, f, n1, n2; 254ea844a1aSMatthew Knepley const PetscInt *idx1, *idx2; 255ea844a1aSMatthew Knepley IS perm1, perm2; 256ea844a1aSMatthew Knepley PetscBool flg; 257ea844a1aSMatthew Knepley PetscMPIInt mflg; 258ea844a1aSMatthew Knepley 259ea844a1aSMatthew Knepley PetscFunctionBegin; 260ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s1, PETSC_SECTION_CLASSID, 1); 261ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s2, PETSC_SECTION_CLASSID, 2); 2624f572ea9SToby Isaac PetscAssertPointer(congruent, 3); 263ea844a1aSMatthew Knepley flg = PETSC_FALSE; 264ea844a1aSMatthew Knepley 2659566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_compare(PetscObjectComm((PetscObject)s1), PetscObjectComm((PetscObject)s2), &mflg)); 266ea844a1aSMatthew Knepley if (mflg != MPI_CONGRUENT && mflg != MPI_IDENT) { 267ea844a1aSMatthew Knepley *congruent = PETSC_FALSE; 2683ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 269ea844a1aSMatthew Knepley } 270ea844a1aSMatthew Knepley 2719566063dSJacob Faibussowitsch PetscCall(PetscSectionGetChart(s1, &pStart, &pEnd)); 2729566063dSJacob Faibussowitsch PetscCall(PetscSectionGetChart(s2, &n1, &n2)); 273ea844a1aSMatthew Knepley if (pStart != n1 || pEnd != n2) goto not_congruent; 274ea844a1aSMatthew Knepley 2759566063dSJacob Faibussowitsch PetscCall(PetscSectionGetPermutation(s1, &perm1)); 2769566063dSJacob Faibussowitsch PetscCall(PetscSectionGetPermutation(s2, &perm2)); 277ea844a1aSMatthew Knepley if (perm1 && perm2) { 2789566063dSJacob Faibussowitsch PetscCall(ISEqual(perm1, perm2, congruent)); 279ea844a1aSMatthew Knepley if (!(*congruent)) goto not_congruent; 280ea844a1aSMatthew Knepley } else if (perm1 != perm2) goto not_congruent; 281ea844a1aSMatthew Knepley 282ea844a1aSMatthew Knepley for (p = pStart; p < pEnd; ++p) { 2839566063dSJacob Faibussowitsch PetscCall(PetscSectionGetOffset(s1, p, &n1)); 2849566063dSJacob Faibussowitsch PetscCall(PetscSectionGetOffset(s2, p, &n2)); 285ea844a1aSMatthew Knepley if (n1 != n2) goto not_congruent; 286ea844a1aSMatthew Knepley 2879566063dSJacob Faibussowitsch PetscCall(PetscSectionGetDof(s1, p, &n1)); 2889566063dSJacob Faibussowitsch PetscCall(PetscSectionGetDof(s2, p, &n2)); 289ea844a1aSMatthew Knepley if (n1 != n2) goto not_congruent; 290ea844a1aSMatthew Knepley 2919566063dSJacob Faibussowitsch PetscCall(PetscSectionGetConstraintDof(s1, p, &ncdof)); 2929566063dSJacob Faibussowitsch PetscCall(PetscSectionGetConstraintDof(s2, p, &n2)); 293ea844a1aSMatthew Knepley if (ncdof != n2) goto not_congruent; 294ea844a1aSMatthew Knepley 2959566063dSJacob Faibussowitsch PetscCall(PetscSectionGetConstraintIndices(s1, p, &idx1)); 2969566063dSJacob Faibussowitsch PetscCall(PetscSectionGetConstraintIndices(s2, p, &idx2)); 2979566063dSJacob Faibussowitsch PetscCall(PetscArraycmp(idx1, idx2, ncdof, congruent)); 298ea844a1aSMatthew Knepley if (!(*congruent)) goto not_congruent; 299ea844a1aSMatthew Knepley } 300ea844a1aSMatthew Knepley 3019566063dSJacob Faibussowitsch PetscCall(PetscSectionGetNumFields(s1, &nfields)); 3029566063dSJacob Faibussowitsch PetscCall(PetscSectionGetNumFields(s2, &n2)); 303ea844a1aSMatthew Knepley if (nfields != n2) goto not_congruent; 304ea844a1aSMatthew Knepley 305ea844a1aSMatthew Knepley for (f = 0; f < nfields; ++f) { 3069566063dSJacob Faibussowitsch PetscCall(PetscSectionGetFieldComponents(s1, f, &n1)); 3079566063dSJacob Faibussowitsch PetscCall(PetscSectionGetFieldComponents(s2, f, &n2)); 308ea844a1aSMatthew Knepley if (n1 != n2) goto not_congruent; 309ea844a1aSMatthew Knepley 310ea844a1aSMatthew Knepley for (p = pStart; p < pEnd; ++p) { 3119566063dSJacob Faibussowitsch PetscCall(PetscSectionGetFieldOffset(s1, p, f, &n1)); 3129566063dSJacob Faibussowitsch PetscCall(PetscSectionGetFieldOffset(s2, p, f, &n2)); 313ea844a1aSMatthew Knepley if (n1 != n2) goto not_congruent; 314ea844a1aSMatthew Knepley 3159566063dSJacob Faibussowitsch PetscCall(PetscSectionGetFieldDof(s1, p, f, &n1)); 3169566063dSJacob Faibussowitsch PetscCall(PetscSectionGetFieldDof(s2, p, f, &n2)); 317ea844a1aSMatthew Knepley if (n1 != n2) goto not_congruent; 318ea844a1aSMatthew Knepley 3199566063dSJacob Faibussowitsch PetscCall(PetscSectionGetFieldConstraintDof(s1, p, f, &nfcdof)); 3209566063dSJacob Faibussowitsch PetscCall(PetscSectionGetFieldConstraintDof(s2, p, f, &n2)); 321ea844a1aSMatthew Knepley if (nfcdof != n2) goto not_congruent; 322ea844a1aSMatthew Knepley 3239566063dSJacob Faibussowitsch PetscCall(PetscSectionGetFieldConstraintIndices(s1, p, f, &idx1)); 3249566063dSJacob Faibussowitsch PetscCall(PetscSectionGetFieldConstraintIndices(s2, p, f, &idx2)); 3259566063dSJacob Faibussowitsch PetscCall(PetscArraycmp(idx1, idx2, nfcdof, congruent)); 326ea844a1aSMatthew Knepley if (!(*congruent)) goto not_congruent; 327ea844a1aSMatthew Knepley } 328ea844a1aSMatthew Knepley } 329ea844a1aSMatthew Knepley 330ea844a1aSMatthew Knepley flg = PETSC_TRUE; 331ea844a1aSMatthew Knepley not_congruent: 3321c2dc1cbSBarry Smith PetscCall(MPIU_Allreduce(&flg, congruent, 1, MPIU_BOOL, MPI_LAND, PetscObjectComm((PetscObject)s1))); 3333ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 334ea844a1aSMatthew Knepley } 335ea844a1aSMatthew Knepley 336ea844a1aSMatthew Knepley /*@ 337cab54364SBarry Smith PetscSectionGetNumFields - Returns the number of fields in a `PetscSection`, or 0 if no fields were defined. 338ea844a1aSMatthew Knepley 33940750d41SVaclav Hapla Not Collective 340ea844a1aSMatthew Knepley 341ea844a1aSMatthew Knepley Input Parameter: 342cab54364SBarry Smith . s - the `PetscSection` 343ea844a1aSMatthew Knepley 344ea844a1aSMatthew Knepley Output Parameter: 345ea844a1aSMatthew Knepley . numFields - the number of fields defined, or 0 if none were defined 346ea844a1aSMatthew Knepley 347ea844a1aSMatthew Knepley Level: intermediate 348ea844a1aSMatthew Knepley 349cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionSetNumFields()` 350ea844a1aSMatthew Knepley @*/ 351d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetNumFields(PetscSection s, PetscInt *numFields) 352d71ae5a4SJacob Faibussowitsch { 353ea844a1aSMatthew Knepley PetscFunctionBegin; 354ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 3554f572ea9SToby Isaac PetscAssertPointer(numFields, 2); 356ea844a1aSMatthew Knepley *numFields = s->numFields; 3573ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 358ea844a1aSMatthew Knepley } 359ea844a1aSMatthew Knepley 360ea844a1aSMatthew Knepley /*@ 361cab54364SBarry Smith PetscSectionSetNumFields - Sets the number of fields in a `PetscSection` 362ea844a1aSMatthew Knepley 36340750d41SVaclav Hapla Not Collective 364ea844a1aSMatthew Knepley 365ea844a1aSMatthew Knepley Input Parameters: 36620662ed9SBarry Smith + s - the `PetscSection` 367ea844a1aSMatthew Knepley - numFields - the number of fields 368ea844a1aSMatthew Knepley 369ea844a1aSMatthew Knepley Level: intermediate 370ea844a1aSMatthew Knepley 371583308b6SBarry Smith Notes: 372583308b6SBarry Smith Calling this destroys all the information in the `PetscSection` including the chart. 373583308b6SBarry Smith 374583308b6SBarry Smith You must call `PetscSectionSetChart()` after calling this. 375583308b6SBarry Smith 376583308b6SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetNumFields()`, `PetscSectionSetChart()`, `PetscSectionReset()` 377ea844a1aSMatthew Knepley @*/ 378d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetNumFields(PetscSection s, PetscInt numFields) 379d71ae5a4SJacob Faibussowitsch { 380ea844a1aSMatthew Knepley PetscInt f; 381ea844a1aSMatthew Knepley 382ea844a1aSMatthew Knepley PetscFunctionBegin; 383ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 38408401ef6SPierre Jolivet PetscCheck(numFields > 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "The number of fields %" PetscInt_FMT " must be positive", numFields); 3859566063dSJacob Faibussowitsch PetscCall(PetscSectionReset(s)); 386ea844a1aSMatthew Knepley 387ea844a1aSMatthew Knepley s->numFields = numFields; 3889566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(s->numFields, &s->numFieldComponents)); 3899566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(s->numFields, &s->fieldNames)); 3909566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(s->numFields, &s->compNames)); 3919566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(s->numFields, &s->field)); 392ea844a1aSMatthew Knepley for (f = 0; f < s->numFields; ++f) { 393ea844a1aSMatthew Knepley char name[64]; 394ea844a1aSMatthew Knepley 395ea844a1aSMatthew Knepley s->numFieldComponents[f] = 1; 396ea844a1aSMatthew Knepley 3979566063dSJacob Faibussowitsch PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject)s), &s->field[f])); 3989566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(name, 64, "Field_%" PetscInt_FMT, f)); 3999566063dSJacob Faibussowitsch PetscCall(PetscStrallocpy(name, (char **)&s->fieldNames[f])); 4009566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(name, 64, "Component_0")); 4019566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(s->numFieldComponents[f], &s->compNames[f])); 4029566063dSJacob Faibussowitsch PetscCall(PetscStrallocpy(name, (char **)&s->compNames[f][0])); 403ea844a1aSMatthew Knepley } 4043ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 405ea844a1aSMatthew Knepley } 406ea844a1aSMatthew Knepley 407ea844a1aSMatthew Knepley /*@C 408cab54364SBarry Smith PetscSectionGetFieldName - Returns the name of a field in the `PetscSection` 409ea844a1aSMatthew Knepley 410ea844a1aSMatthew Knepley Not Collective 411ea844a1aSMatthew Knepley 412ea844a1aSMatthew Knepley Input Parameters: 413cab54364SBarry Smith + s - the `PetscSection` 414ea844a1aSMatthew Knepley - field - the field number 415ea844a1aSMatthew Knepley 416ea844a1aSMatthew Knepley Output Parameter: 417ea844a1aSMatthew Knepley . fieldName - the field name 418ea844a1aSMatthew Knepley 419ea844a1aSMatthew Knepley Level: intermediate 420ea844a1aSMatthew Knepley 421cab54364SBarry Smith Note: 422cab54364SBarry Smith Will error if the field number is out of range 423cab54364SBarry Smith 424cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionSetFieldName()`, `PetscSectionSetNumFields()`, `PetscSectionGetNumFields()` 425ea844a1aSMatthew Knepley @*/ 426d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetFieldName(PetscSection s, PetscInt field, const char *fieldName[]) 427d71ae5a4SJacob Faibussowitsch { 428ea844a1aSMatthew Knepley PetscFunctionBegin; 429ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 4304f572ea9SToby Isaac PetscAssertPointer(fieldName, 3); 4312abc8c78SJacob Faibussowitsch PetscSectionCheckValidField(field, s->numFields); 432ea844a1aSMatthew Knepley *fieldName = s->fieldNames[field]; 4333ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 434ea844a1aSMatthew Knepley } 435ea844a1aSMatthew Knepley 436ea844a1aSMatthew Knepley /*@C 437cab54364SBarry Smith PetscSectionSetFieldName - Sets the name of a field in the `PetscSection` 438ea844a1aSMatthew Knepley 439ea844a1aSMatthew Knepley Not Collective 440ea844a1aSMatthew Knepley 441ea844a1aSMatthew Knepley Input Parameters: 442cab54364SBarry Smith + s - the `PetscSection` 443ea844a1aSMatthew Knepley . field - the field number 444ea844a1aSMatthew Knepley - fieldName - the field name 445ea844a1aSMatthew Knepley 446ea844a1aSMatthew Knepley Level: intermediate 447ea844a1aSMatthew Knepley 448cab54364SBarry Smith Note: 449cab54364SBarry Smith Will error if the field number is out of range 450cab54364SBarry Smith 451cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionGetFieldName()`, `PetscSectionSetNumFields()`, `PetscSectionGetNumFields()` 452ea844a1aSMatthew Knepley @*/ 453d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetFieldName(PetscSection s, PetscInt field, const char fieldName[]) 454d71ae5a4SJacob Faibussowitsch { 455ea844a1aSMatthew Knepley PetscFunctionBegin; 456ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 4574f572ea9SToby Isaac if (fieldName) PetscAssertPointer(fieldName, 3); 4582abc8c78SJacob Faibussowitsch PetscSectionCheckValidField(field, s->numFields); 4599566063dSJacob Faibussowitsch PetscCall(PetscFree(s->fieldNames[field])); 4609566063dSJacob Faibussowitsch PetscCall(PetscStrallocpy(fieldName, (char **)&s->fieldNames[field])); 4613ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 462ea844a1aSMatthew Knepley } 463ea844a1aSMatthew Knepley 464b778fa18SValeria Barra /*@C 465cab54364SBarry Smith PetscSectionGetComponentName - Gets the name of a field component in the `PetscSection` 466b778fa18SValeria Barra 467b778fa18SValeria Barra Not Collective 468b778fa18SValeria Barra 469b778fa18SValeria Barra Input Parameters: 470cab54364SBarry Smith + s - the `PetscSection` 471b778fa18SValeria Barra . field - the field number 472cab54364SBarry Smith - comp - the component number 473cab54364SBarry Smith 474d5b43468SJose E. Roman Output Parameter: 475cab54364SBarry Smith . compName - the component name 476b778fa18SValeria Barra 477b778fa18SValeria Barra Level: intermediate 478b778fa18SValeria Barra 479cab54364SBarry Smith Note: 480cab54364SBarry Smith Will error if the field or component number do not exist 481cab54364SBarry Smith 48238b5cf2dSJacob Faibussowitsch Developer Notes: 483583308b6SBarry Smith The function name should have Field in it since they are field components. 484583308b6SBarry Smith 485cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetFieldName()`, `PetscSectionSetNumFields()`, `PetscSectionGetNumFields()`, 486cab54364SBarry Smith `PetscSectionSetComponentName()`, `PetscSectionSetFieldName()`, `PetscSectionGetFieldComponents()`, `PetscSectionSetFieldComponents()` 487b778fa18SValeria Barra @*/ 488d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetComponentName(PetscSection s, PetscInt field, PetscInt comp, const char *compName[]) 489d71ae5a4SJacob Faibussowitsch { 490b778fa18SValeria Barra PetscFunctionBegin; 491b778fa18SValeria Barra PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 4924f572ea9SToby Isaac PetscAssertPointer(compName, 4); 4932abc8c78SJacob Faibussowitsch PetscSectionCheckValidField(field, s->numFields); 4942abc8c78SJacob Faibussowitsch PetscSectionCheckValidFieldComponent(comp, s->numFieldComponents[field]); 495b778fa18SValeria Barra *compName = s->compNames[field][comp]; 4963ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 497b778fa18SValeria Barra } 498b778fa18SValeria Barra 499b778fa18SValeria Barra /*@C 500cab54364SBarry Smith PetscSectionSetComponentName - Sets the name of a field component in the `PetscSection` 501b778fa18SValeria Barra 502b778fa18SValeria Barra Not Collective 503b778fa18SValeria Barra 504b778fa18SValeria Barra Input Parameters: 50520662ed9SBarry Smith + s - the `PetscSection` 506b778fa18SValeria Barra . field - the field number 507b778fa18SValeria Barra . comp - the component number 508b778fa18SValeria Barra - compName - the component name 509b778fa18SValeria Barra 510583308b6SBarry Smith Level: advanced 511b778fa18SValeria Barra 512cab54364SBarry Smith Note: 513cab54364SBarry Smith Will error if the field or component number do not exist 514cab54364SBarry Smith 51538b5cf2dSJacob Faibussowitsch Developer Notes: 516583308b6SBarry Smith The function name should have Field in it since they are field components. 517583308b6SBarry Smith 518cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetComponentName()`, `PetscSectionSetNumFields()`, `PetscSectionGetNumFields()`, 51942747ad1SJacob Faibussowitsch `PetscSectionSetFieldName()`, `PetscSectionGetFieldComponents()`, `PetscSectionSetFieldComponents()` 520b778fa18SValeria Barra @*/ 521d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetComponentName(PetscSection s, PetscInt field, PetscInt comp, const char compName[]) 522d71ae5a4SJacob Faibussowitsch { 523b778fa18SValeria Barra PetscFunctionBegin; 524b778fa18SValeria Barra PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 5254f572ea9SToby Isaac if (compName) PetscAssertPointer(compName, 4); 5262abc8c78SJacob Faibussowitsch PetscSectionCheckValidField(field, s->numFields); 5272abc8c78SJacob Faibussowitsch PetscSectionCheckValidFieldComponent(comp, s->numFieldComponents[field]); 5289566063dSJacob Faibussowitsch PetscCall(PetscFree(s->compNames[field][comp])); 5299566063dSJacob Faibussowitsch PetscCall(PetscStrallocpy(compName, (char **)&s->compNames[field][comp])); 5303ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 531b778fa18SValeria Barra } 532b778fa18SValeria Barra 533ea844a1aSMatthew Knepley /*@ 534ea844a1aSMatthew Knepley PetscSectionGetFieldComponents - Returns the number of field components for the given field. 535ea844a1aSMatthew Knepley 53640750d41SVaclav Hapla Not Collective 537ea844a1aSMatthew Knepley 538ea844a1aSMatthew Knepley Input Parameters: 539cab54364SBarry Smith + s - the `PetscSection` 540ea844a1aSMatthew Knepley - field - the field number 541ea844a1aSMatthew Knepley 542ea844a1aSMatthew Knepley Output Parameter: 543ea844a1aSMatthew Knepley . numComp - the number of field components 544ea844a1aSMatthew Knepley 545583308b6SBarry Smith Level: advanced 546ea844a1aSMatthew Knepley 54738b5cf2dSJacob Faibussowitsch Developer Notes: 548cab54364SBarry Smith This function is misnamed. There is a Num in `PetscSectionGetNumFields()` but not in this name 549cab54364SBarry Smith 550583308b6SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionSetFieldComponents()`, `PetscSectionGetNumFields()`, 551583308b6SBarry Smith `PetscSectionSetComponentName()`, `PetscSectionGetComponentName()` 552ea844a1aSMatthew Knepley @*/ 553d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetFieldComponents(PetscSection s, PetscInt field, PetscInt *numComp) 554d71ae5a4SJacob Faibussowitsch { 555ea844a1aSMatthew Knepley PetscFunctionBegin; 556ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 5574f572ea9SToby Isaac PetscAssertPointer(numComp, 3); 5582abc8c78SJacob Faibussowitsch PetscSectionCheckValidField(field, s->numFields); 559ea844a1aSMatthew Knepley *numComp = s->numFieldComponents[field]; 5603ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 561ea844a1aSMatthew Knepley } 562ea844a1aSMatthew Knepley 563ea844a1aSMatthew Knepley /*@ 564ea844a1aSMatthew Knepley PetscSectionSetFieldComponents - Sets the number of field components for the given field. 565ea844a1aSMatthew Knepley 56640750d41SVaclav Hapla Not Collective 567ea844a1aSMatthew Knepley 568ea844a1aSMatthew Knepley Input Parameters: 56920662ed9SBarry Smith + s - the `PetscSection` 570ea844a1aSMatthew Knepley . field - the field number 571ea844a1aSMatthew Knepley - numComp - the number of field components 572ea844a1aSMatthew Knepley 573583308b6SBarry Smith Level: advanced 574ea844a1aSMatthew Knepley 575583308b6SBarry Smith Note: 576583308b6SBarry Smith This number can be different than the values set with `PetscSectionSetFieldDof()`. It can be used to indicate the number of 577583308b6SBarry Smith components in the field of the underlying physical model which may be different than the number of degrees of freedom needed 578583308b6SBarry Smith at a point in a discretization. For example, if in three dimensions the field is velocity, it will have 3 components, u, v, and w but 579583308b6SBarry Smith an face based model for velocity (where the velocity normal to the face is stored) there is only 1 dof for each face point. 580583308b6SBarry Smith 581583308b6SBarry Smith The value set with this function are not needed or used in `PetscSectionSetUp()`. 582583308b6SBarry Smith 58338b5cf2dSJacob Faibussowitsch Developer Notes: 584583308b6SBarry Smith This function is misnamed. There is a Num in `PetscSectionSetNumFields()` but not in this name 585583308b6SBarry Smith 586583308b6SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetFieldComponents()`, `PetscSectionSetComponentName()`, 587583308b6SBarry Smith `PetscSectionGetComponentName()`, `PetscSectionGetNumFields()` 588ea844a1aSMatthew Knepley @*/ 589d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetFieldComponents(PetscSection s, PetscInt field, PetscInt numComp) 590d71ae5a4SJacob Faibussowitsch { 591b778fa18SValeria Barra PetscInt c; 592b778fa18SValeria Barra 593ea844a1aSMatthew Knepley PetscFunctionBegin; 594ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 5952abc8c78SJacob Faibussowitsch PetscSectionCheckValidField(field, s->numFields); 596b778fa18SValeria Barra if (s->compNames) { 59748a46eb9SPierre Jolivet for (c = 0; c < s->numFieldComponents[field]; ++c) PetscCall(PetscFree(s->compNames[field][c])); 5989566063dSJacob Faibussowitsch PetscCall(PetscFree(s->compNames[field])); 599b778fa18SValeria Barra } 600b778fa18SValeria Barra 601ea844a1aSMatthew Knepley s->numFieldComponents[field] = numComp; 602b778fa18SValeria Barra if (numComp) { 6039566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(numComp, (char ***)&s->compNames[field])); 604b778fa18SValeria Barra for (c = 0; c < numComp; ++c) { 6052abc8c78SJacob Faibussowitsch char name[64]; 6062abc8c78SJacob Faibussowitsch 6079566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(name, 64, "%" PetscInt_FMT, c)); 6089566063dSJacob Faibussowitsch PetscCall(PetscStrallocpy(name, (char **)&s->compNames[field][c])); 609b778fa18SValeria Barra } 610b778fa18SValeria Barra } 6113ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 612ea844a1aSMatthew Knepley } 613ea844a1aSMatthew Knepley 614ea844a1aSMatthew Knepley /*@ 615583308b6SBarry Smith PetscSectionGetChart - Returns the range [`pStart`, `pEnd`) in which points (indices) lie for this `PetscSection` on this MPI process 616ea844a1aSMatthew Knepley 61740750d41SVaclav Hapla Not Collective 618ea844a1aSMatthew Knepley 619ea844a1aSMatthew Knepley Input Parameter: 620cab54364SBarry Smith . s - the `PetscSection` 621ea844a1aSMatthew Knepley 622ea844a1aSMatthew Knepley Output Parameters: 623ea844a1aSMatthew Knepley + pStart - the first point 624ea844a1aSMatthew Knepley - pEnd - one past the last point 625ea844a1aSMatthew Knepley 626ea844a1aSMatthew Knepley Level: intermediate 627ea844a1aSMatthew Knepley 628cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionSetChart()`, `PetscSectionCreate()` 629ea844a1aSMatthew Knepley @*/ 630d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetChart(PetscSection s, PetscInt *pStart, PetscInt *pEnd) 631d71ae5a4SJacob Faibussowitsch { 632ea844a1aSMatthew Knepley PetscFunctionBegin; 633ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 634ea844a1aSMatthew Knepley if (pStart) *pStart = s->pStart; 635ea844a1aSMatthew Knepley if (pEnd) *pEnd = s->pEnd; 6363ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 637ea844a1aSMatthew Knepley } 638ea844a1aSMatthew Knepley 639ea844a1aSMatthew Knepley /*@ 640583308b6SBarry Smith PetscSectionSetChart - Sets the range [`pStart`, `pEnd`) in which points (indices) lie for this `PetscSection` on this MPI process 641ea844a1aSMatthew Knepley 64240750d41SVaclav Hapla Not Collective 643ea844a1aSMatthew Knepley 644ea844a1aSMatthew Knepley Input Parameters: 64520662ed9SBarry Smith + s - the `PetscSection` 646ea844a1aSMatthew Knepley . pStart - the first point 647376335faSBarry Smith - pEnd - one past the last point, `pStart` $ \le $ `pEnd` 648ea844a1aSMatthew Knepley 649ea844a1aSMatthew Knepley Level: intermediate 650ea844a1aSMatthew Knepley 651583308b6SBarry Smith Notes: 652583308b6SBarry Smith The charts on different MPI processes may (and often do) overlap 653583308b6SBarry Smith 654583308b6SBarry Smith If you intend to use `PetscSectionSetNumFields()` it must be called before this call. 655583308b6SBarry Smith 656583308b6SBarry Smith The chart for all fields created with `PetscSectionSetNumFields()` is the same as this chart. 657583308b6SBarry Smith 658583308b6SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetChart()`, `PetscSectionCreate()`, `PetscSectionSetNumFields()` 659ea844a1aSMatthew Knepley @*/ 660d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetChart(PetscSection s, PetscInt pStart, PetscInt pEnd) 661d71ae5a4SJacob Faibussowitsch { 662ea844a1aSMatthew Knepley PetscInt f; 663ea844a1aSMatthew Knepley 664ea844a1aSMatthew Knepley PetscFunctionBegin; 665ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 66640196513SBarry Smith PetscCheck(pEnd >= pStart, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Chart pEnd %" PetscInt_FMT " cannot be smaller than chart pStart %" PetscInt_FMT, pEnd, pStart); 6673ba16761SJacob Faibussowitsch if (pStart == s->pStart && pEnd == s->pEnd) PetscFunctionReturn(PETSC_SUCCESS); 668ea844a1aSMatthew Knepley /* Cannot Reset() because it destroys field information */ 669ea844a1aSMatthew Knepley s->setup = PETSC_FALSE; 6709566063dSJacob Faibussowitsch PetscCall(PetscSectionDestroy(&s->bc)); 6719566063dSJacob Faibussowitsch PetscCall(PetscFree(s->bcIndices)); 6729566063dSJacob Faibussowitsch PetscCall(PetscFree2(s->atlasDof, s->atlasOff)); 673ea844a1aSMatthew Knepley 674ea844a1aSMatthew Knepley s->pStart = pStart; 675ea844a1aSMatthew Knepley s->pEnd = pEnd; 6769566063dSJacob Faibussowitsch PetscCall(PetscMalloc2((pEnd - pStart), &s->atlasDof, (pEnd - pStart), &s->atlasOff)); 6779566063dSJacob Faibussowitsch PetscCall(PetscArrayzero(s->atlasDof, pEnd - pStart)); 67848a46eb9SPierre Jolivet for (f = 0; f < s->numFields; ++f) PetscCall(PetscSectionSetChart(s->field[f], pStart, pEnd)); 6793ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 680ea844a1aSMatthew Knepley } 681ea844a1aSMatthew Knepley 682ea844a1aSMatthew Knepley /*@ 68320662ed9SBarry Smith PetscSectionGetPermutation - Returns the permutation of [0, `pEnd` - `pStart`) or `NULL` that was set with `PetscSectionSetPermutation()` 684ea844a1aSMatthew Knepley 68540750d41SVaclav Hapla Not Collective 686ea844a1aSMatthew Knepley 687ea844a1aSMatthew Knepley Input Parameter: 688cab54364SBarry Smith . s - the `PetscSection` 689ea844a1aSMatthew Knepley 6902fe279fdSBarry Smith Output Parameter: 691cab54364SBarry Smith . perm - The permutation as an `IS` 692ea844a1aSMatthew Knepley 693ea844a1aSMatthew Knepley Level: intermediate 694ea844a1aSMatthew Knepley 695cab54364SBarry Smith .seealso: [](sec_scatter), `IS`, `PetscSection`, `PetscSectionSetPermutation()`, `PetscSectionCreate()` 696ea844a1aSMatthew Knepley @*/ 697d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetPermutation(PetscSection s, IS *perm) 698d71ae5a4SJacob Faibussowitsch { 699ea844a1aSMatthew Knepley PetscFunctionBegin; 700ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 7019371c9d4SSatish Balay if (perm) { 7024f572ea9SToby Isaac PetscAssertPointer(perm, 2); 7039371c9d4SSatish Balay *perm = s->perm; 7049371c9d4SSatish Balay } 7053ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 706ea844a1aSMatthew Knepley } 707ea844a1aSMatthew Knepley 708ea844a1aSMatthew Knepley /*@ 709583308b6SBarry Smith PetscSectionSetPermutation - Sets a permutation of the chart for this section, [0, `pEnd` - `pStart`), which determines the order to store the `PetscSection` information 710ea844a1aSMatthew Knepley 71140750d41SVaclav Hapla Not Collective 712ea844a1aSMatthew Knepley 713ea844a1aSMatthew Knepley Input Parameters: 71420662ed9SBarry Smith + s - the `PetscSection` 715ea844a1aSMatthew Knepley - perm - the permutation of points 716ea844a1aSMatthew Knepley 717ea844a1aSMatthew Knepley Level: intermediate 718ea844a1aSMatthew Knepley 719583308b6SBarry Smith Notes: 720583308b6SBarry Smith The permutation must be provided before `PetscSectionSetUp()`. 721cab54364SBarry Smith 722583308b6SBarry Smith The data in the `PetscSection` are permuted but the access via `PetscSectionGetFieldOffset()` and `PetscSectionGetOffset()` is not changed 723583308b6SBarry Smith 724583308b6SBarry Smith Compart to `PetscSectionPermute()` 725583308b6SBarry Smith 726583308b6SBarry Smith .seealso: [](sec_scatter), `IS`, `PetscSection`, `PetscSectionSetUp()`, `PetscSectionGetPermutation()`, `PetscSectionPermute()`, `PetscSectionCreate()` 727ea844a1aSMatthew Knepley @*/ 728d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetPermutation(PetscSection s, IS perm) 729d71ae5a4SJacob Faibussowitsch { 730ea844a1aSMatthew Knepley PetscFunctionBegin; 731ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 732ea844a1aSMatthew Knepley if (perm) PetscValidHeaderSpecific(perm, IS_CLASSID, 2); 73328b400f6SJacob Faibussowitsch PetscCheck(!s->setup, PetscObjectComm((PetscObject)s), PETSC_ERR_ARG_WRONGSTATE, "Cannot set a permutation after the section is setup"); 734ea844a1aSMatthew Knepley if (s->perm != perm) { 7359566063dSJacob Faibussowitsch PetscCall(ISDestroy(&s->perm)); 736ea844a1aSMatthew Knepley if (perm) { 737ea844a1aSMatthew Knepley s->perm = perm; 7389566063dSJacob Faibussowitsch PetscCall(PetscObjectReference((PetscObject)s->perm)); 739ea844a1aSMatthew Knepley } 740ea844a1aSMatthew Knepley } 7413ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 742ea844a1aSMatthew Knepley } 743ea844a1aSMatthew Knepley 744ea844a1aSMatthew Knepley /*@ 745cab54364SBarry Smith PetscSectionGetPointMajor - Returns the flag for dof ordering, `PETSC_TRUE` if it is point major, `PETSC_FALSE` if it is field major 746ea844a1aSMatthew Knepley 74740750d41SVaclav Hapla Not Collective 748ea844a1aSMatthew Knepley 749ea844a1aSMatthew Knepley Input Parameter: 750cab54364SBarry Smith . s - the `PetscSection` 751ea844a1aSMatthew Knepley 752ea844a1aSMatthew Knepley Output Parameter: 753ea844a1aSMatthew Knepley . pm - the flag for point major ordering 754ea844a1aSMatthew Knepley 755ea844a1aSMatthew Knepley Level: intermediate 756ea844a1aSMatthew Knepley 75738b5cf2dSJacob Faibussowitsch .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionSetPointMajor()` 758ea844a1aSMatthew Knepley @*/ 759d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetPointMajor(PetscSection s, PetscBool *pm) 760d71ae5a4SJacob Faibussowitsch { 761ea844a1aSMatthew Knepley PetscFunctionBegin; 762ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 7634f572ea9SToby Isaac PetscAssertPointer(pm, 2); 764ea844a1aSMatthew Knepley *pm = s->pointMajor; 7653ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 766ea844a1aSMatthew Knepley } 767ea844a1aSMatthew Knepley 768ea844a1aSMatthew Knepley /*@ 769cab54364SBarry Smith PetscSectionSetPointMajor - Sets the flag for dof ordering, `PETSC_TRUE` for point major, otherwise it will be field major 770ea844a1aSMatthew Knepley 77140750d41SVaclav Hapla Not Collective 772ea844a1aSMatthew Knepley 773ea844a1aSMatthew Knepley Input Parameters: 774cab54364SBarry Smith + s - the `PetscSection` 775ea844a1aSMatthew Knepley - pm - the flag for point major ordering 776ea844a1aSMatthew Knepley 777ea844a1aSMatthew Knepley Level: intermediate 778ea844a1aSMatthew Knepley 779583308b6SBarry Smith Note: 780583308b6SBarry Smith Field-major order is not recommended unless you are managing the entire problem yourself, since many higher-level functions in PETSc depend on point-major order. 781583308b6SBarry Smith 782583308b6SBarry Smith Point major order means the degrees of freedom are stored as follows 783583308b6SBarry Smith .vb 78411e840c0SPierre Jolivet all the degrees of freedom for each point are stored contiguously, one point after another (respecting a permutation set with `PetscSectionSetPermutation()`) 785583308b6SBarry Smith for each point 786583308b6SBarry Smith the degrees of freedom for each field (starting with the unnamed default field) are listed in order by field 787583308b6SBarry Smith .ve 788583308b6SBarry Smith 789583308b6SBarry Smith Field major order means the degrees of freedom are stored as follows 790583308b6SBarry Smith .vb 79111e840c0SPierre Jolivet all degrees of freedom for each field (including the unnamed default field) are stored contiguously, one field after another 792583308b6SBarry Smith for each field (started with unnamed default field) 793583308b6SBarry Smith the degrees of freedom for each point are listed in order by point (respecting a permutation set with `PetscSectionSetPermutation()`) 794583308b6SBarry Smith .ve 795583308b6SBarry Smith 796583308b6SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetPointMajor()`, `PetscSectionSetPermutation()` 797ea844a1aSMatthew Knepley @*/ 798d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetPointMajor(PetscSection s, PetscBool pm) 799d71ae5a4SJacob Faibussowitsch { 800ea844a1aSMatthew Knepley PetscFunctionBegin; 801ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 80228b400f6SJacob Faibussowitsch PetscCheck(!s->setup, PetscObjectComm((PetscObject)s), PETSC_ERR_ARG_WRONGSTATE, "Cannot set the dof ordering after the section is setup"); 803ea844a1aSMatthew Knepley s->pointMajor = pm; 8043ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 805ea844a1aSMatthew Knepley } 806ea844a1aSMatthew Knepley 807ea844a1aSMatthew Knepley /*@ 808cab54364SBarry Smith PetscSectionGetIncludesConstraints - Returns the flag indicating if constrained dofs were included when computing offsets in the `PetscSection`. 809cab54364SBarry Smith The value is set with `PetscSectionSetIncludesConstraints()` 81087e637c6Sksagiyam 81140750d41SVaclav Hapla Not Collective 81287e637c6Sksagiyam 81387e637c6Sksagiyam Input Parameter: 814cab54364SBarry Smith . s - the `PetscSection` 81587e637c6Sksagiyam 81687e637c6Sksagiyam Output Parameter: 81787e637c6Sksagiyam . includesConstraints - the flag indicating if constrained dofs were included when computing offsets 81887e637c6Sksagiyam 81987e637c6Sksagiyam Level: intermediate 82087e637c6Sksagiyam 821cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionSetIncludesConstraints()` 82287e637c6Sksagiyam @*/ 823d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetIncludesConstraints(PetscSection s, PetscBool *includesConstraints) 824d71ae5a4SJacob Faibussowitsch { 82587e637c6Sksagiyam PetscFunctionBegin; 82687e637c6Sksagiyam PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 8274f572ea9SToby Isaac PetscAssertPointer(includesConstraints, 2); 82887e637c6Sksagiyam *includesConstraints = s->includesConstraints; 8293ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 83087e637c6Sksagiyam } 83187e637c6Sksagiyam 83287e637c6Sksagiyam /*@ 83387e637c6Sksagiyam PetscSectionSetIncludesConstraints - Sets the flag indicating if constrained dofs are to be included when computing offsets 83487e637c6Sksagiyam 83540750d41SVaclav Hapla Not Collective 83687e637c6Sksagiyam 83787e637c6Sksagiyam Input Parameters: 83820662ed9SBarry Smith + s - the `PetscSection` 83987e637c6Sksagiyam - includesConstraints - the flag indicating if constrained dofs are to be included when computing offsets 84087e637c6Sksagiyam 84187e637c6Sksagiyam Level: intermediate 84287e637c6Sksagiyam 843cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetIncludesConstraints()` 84487e637c6Sksagiyam @*/ 845d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetIncludesConstraints(PetscSection s, PetscBool includesConstraints) 846d71ae5a4SJacob Faibussowitsch { 84787e637c6Sksagiyam PetscFunctionBegin; 84887e637c6Sksagiyam PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 84928b400f6SJacob Faibussowitsch PetscCheck(!s->setup, PetscObjectComm((PetscObject)s), PETSC_ERR_ARG_WRONGSTATE, "Cannot set includesConstraints after the section is set up"); 85087e637c6Sksagiyam s->includesConstraints = includesConstraints; 8513ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 85287e637c6Sksagiyam } 85387e637c6Sksagiyam 85487e637c6Sksagiyam /*@ 855583308b6SBarry Smith PetscSectionGetDof - Return the total number of degrees of freedom associated with a given point. 856ea844a1aSMatthew Knepley 85740750d41SVaclav Hapla Not Collective 858ea844a1aSMatthew Knepley 859ea844a1aSMatthew Knepley Input Parameters: 860cab54364SBarry Smith + s - the `PetscSection` 861ea844a1aSMatthew Knepley - point - the point 862ea844a1aSMatthew Knepley 863ea844a1aSMatthew Knepley Output Parameter: 864ea844a1aSMatthew Knepley . numDof - the number of dof 865ea844a1aSMatthew Knepley 866583308b6SBarry Smith Level: intermediate 867583308b6SBarry Smith 868583308b6SBarry Smith Notes: 869db527f05SMatthew G. Knepley In a global section, this size will be negative for points not owned by this process. 870db527f05SMatthew G. Knepley 871583308b6SBarry Smith This number is for the unnamed default field at the given point plus all degrees of freedom associated with all fields at that point 872ea844a1aSMatthew Knepley 873cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionSetDof()`, `PetscSectionCreate()` 874ea844a1aSMatthew Knepley @*/ 875d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetDof(PetscSection s, PetscInt point, PetscInt *numDof) 876d71ae5a4SJacob Faibussowitsch { 87776bd3646SJed Brown PetscFunctionBeginHot; 878ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 8794f572ea9SToby Isaac PetscAssertPointer(numDof, 3); 880b498ca8aSPierre Jolivet PetscAssert(point >= s->pStart && point < s->pEnd, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Section point %" PetscInt_FMT " should be in [%" PetscInt_FMT ", %" PetscInt_FMT ")", point, s->pStart, s->pEnd); 881ea844a1aSMatthew Knepley *numDof = s->atlasDof[point - s->pStart]; 8823ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 883ea844a1aSMatthew Knepley } 884ea844a1aSMatthew Knepley 885ea844a1aSMatthew Knepley /*@ 886583308b6SBarry Smith PetscSectionSetDof - Sets the total number of degrees of freedom associated with a given point. 887ea844a1aSMatthew Knepley 88840750d41SVaclav Hapla Not Collective 889ea844a1aSMatthew Knepley 890ea844a1aSMatthew Knepley Input Parameters: 891cab54364SBarry Smith + s - the `PetscSection` 892ea844a1aSMatthew Knepley . point - the point 893376335faSBarry Smith - numDof - the number of dof, these values may be negative -(dof+1) to indicate they are off process 894ea844a1aSMatthew Knepley 895ea844a1aSMatthew Knepley Level: intermediate 896ea844a1aSMatthew Knepley 897583308b6SBarry Smith Note: 898583308b6SBarry Smith This number is for the unnamed default field at the given point plus all degrees of freedom associated with all fields at that point 899583308b6SBarry Smith 900cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetDof()`, `PetscSectionAddDof()`, `PetscSectionCreate()` 901ea844a1aSMatthew Knepley @*/ 902d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetDof(PetscSection s, PetscInt point, PetscInt numDof) 903d71ae5a4SJacob Faibussowitsch { 904ea844a1aSMatthew Knepley PetscFunctionBegin; 905ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 906c8bf3acbSVaclav Hapla PetscAssert(point >= s->pStart && point < s->pEnd, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Section point %" PetscInt_FMT " should be in [%" PetscInt_FMT ", %" PetscInt_FMT ")", point, s->pStart, s->pEnd); 907ea844a1aSMatthew Knepley s->atlasDof[point - s->pStart] = numDof; 90869c11d05SVaclav Hapla PetscCall(PetscSectionInvalidateMaxDof_Internal(s)); 9093ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 910ea844a1aSMatthew Knepley } 911ea844a1aSMatthew Knepley 912ea844a1aSMatthew Knepley /*@ 913583308b6SBarry Smith PetscSectionAddDof - Adds to the total number of degrees of freedom associated with a given point. 914ea844a1aSMatthew Knepley 91540750d41SVaclav Hapla Not Collective 916ea844a1aSMatthew Knepley 917ea844a1aSMatthew Knepley Input Parameters: 918cab54364SBarry Smith + s - the `PetscSection` 919ea844a1aSMatthew Knepley . point - the point 920ea844a1aSMatthew Knepley - numDof - the number of additional dof 921ea844a1aSMatthew Knepley 922ea844a1aSMatthew Knepley Level: intermediate 923ea844a1aSMatthew Knepley 924583308b6SBarry Smith Note: 925583308b6SBarry Smith This number is for the unnamed default field at the given point plus all degrees of freedom associated with all fields at that point 926583308b6SBarry Smith 927cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetDof()`, `PetscSectionSetDof()`, `PetscSectionCreate()` 928ea844a1aSMatthew Knepley @*/ 929d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionAddDof(PetscSection s, PetscInt point, PetscInt numDof) 930d71ae5a4SJacob Faibussowitsch { 93176bd3646SJed Brown PetscFunctionBeginHot; 932ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 933b498ca8aSPierre Jolivet PetscAssert(point >= s->pStart && point < s->pEnd, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Section point %" PetscInt_FMT " should be in [%" PetscInt_FMT ", %" PetscInt_FMT ")", point, s->pStart, s->pEnd); 93440196513SBarry Smith PetscCheck(numDof >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "numDof %" PetscInt_FMT " should not be negative", numDof); 935ea844a1aSMatthew Knepley s->atlasDof[point - s->pStart] += numDof; 93669c11d05SVaclav Hapla PetscCall(PetscSectionInvalidateMaxDof_Internal(s)); 9373ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 938ea844a1aSMatthew Knepley } 939ea844a1aSMatthew Knepley 940ea844a1aSMatthew Knepley /*@ 941ea844a1aSMatthew Knepley PetscSectionGetFieldDof - Return the number of degrees of freedom associated with a field on a given point. 942ea844a1aSMatthew Knepley 94340750d41SVaclav Hapla Not Collective 944ea844a1aSMatthew Knepley 945ea844a1aSMatthew Knepley Input Parameters: 946cab54364SBarry Smith + s - the `PetscSection` 947ea844a1aSMatthew Knepley . point - the point 948ea844a1aSMatthew Knepley - field - the field 949ea844a1aSMatthew Knepley 950ea844a1aSMatthew Knepley Output Parameter: 951ea844a1aSMatthew Knepley . numDof - the number of dof 952ea844a1aSMatthew Knepley 953ea844a1aSMatthew Knepley Level: intermediate 954ea844a1aSMatthew Knepley 955cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionSetFieldDof()`, `PetscSectionCreate()` 956ea844a1aSMatthew Knepley @*/ 957d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetFieldDof(PetscSection s, PetscInt point, PetscInt field, PetscInt *numDof) 958d71ae5a4SJacob Faibussowitsch { 959ea844a1aSMatthew Knepley PetscFunctionBegin; 960ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 9614f572ea9SToby Isaac PetscAssertPointer(numDof, 4); 9622abc8c78SJacob Faibussowitsch PetscSectionCheckValidField(field, s->numFields); 9639566063dSJacob Faibussowitsch PetscCall(PetscSectionGetDof(s->field[field], point, numDof)); 9643ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 965ea844a1aSMatthew Knepley } 966ea844a1aSMatthew Knepley 967ea844a1aSMatthew Knepley /*@ 968ea844a1aSMatthew Knepley PetscSectionSetFieldDof - Sets the number of degrees of freedom associated with a field on a given point. 969ea844a1aSMatthew Knepley 97040750d41SVaclav Hapla Not Collective 971ea844a1aSMatthew Knepley 972ea844a1aSMatthew Knepley Input Parameters: 973cab54364SBarry Smith + s - the `PetscSection` 974ea844a1aSMatthew Knepley . point - the point 975ea844a1aSMatthew Knepley . field - the field 976376335faSBarry Smith - numDof - the number of dof, these values may be negative -(dof+1) to indicate they are off process 977ea844a1aSMatthew Knepley 978ea844a1aSMatthew Knepley Level: intermediate 979ea844a1aSMatthew Knepley 980583308b6SBarry Smith Note: 981583308b6SBarry Smith When setting the number of dof for a field at a point one must also ensure the count of the total number of dof at the point (summed over 982583308b6SBarry Smith the fields and the unnamed default field) is correct by also calling `PetscSectionAddDof()` or `PetscSectionSetDof()` 983583308b6SBarry Smith 984583308b6SBarry Smith This is equivalent to 985583308b6SBarry Smith .vb 986583308b6SBarry Smith PetscSection fs; 987583308b6SBarry Smith PetscSectionGetField(s,field,&fs) 988583308b6SBarry Smith PetscSectionSetDof(fs,numDof) 989583308b6SBarry Smith .ve 990583308b6SBarry Smith 991583308b6SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetFieldDof()`, `PetscSectionCreate()`, `PetscSectionAddDof()`, `PetscSectionSetDof()` 992ea844a1aSMatthew Knepley @*/ 993d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetFieldDof(PetscSection s, PetscInt point, PetscInt field, PetscInt numDof) 994d71ae5a4SJacob Faibussowitsch { 995ea844a1aSMatthew Knepley PetscFunctionBegin; 996ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 9972abc8c78SJacob Faibussowitsch PetscSectionCheckValidField(field, s->numFields); 9989566063dSJacob Faibussowitsch PetscCall(PetscSectionSetDof(s->field[field], point, numDof)); 9993ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1000ea844a1aSMatthew Knepley } 1001ea844a1aSMatthew Knepley 1002ea844a1aSMatthew Knepley /*@ 1003ea844a1aSMatthew Knepley PetscSectionAddFieldDof - Adds a number of degrees of freedom associated with a field on a given point. 1004ea844a1aSMatthew Knepley 100540750d41SVaclav Hapla Not Collective 1006ea844a1aSMatthew Knepley 1007ea844a1aSMatthew Knepley Input Parameters: 1008cab54364SBarry Smith + s - the `PetscSection` 1009ea844a1aSMatthew Knepley . point - the point 1010ea844a1aSMatthew Knepley . field - the field 1011ea844a1aSMatthew Knepley - numDof - the number of dof 1012ea844a1aSMatthew Knepley 1013ea844a1aSMatthew Knepley Level: intermediate 1014ea844a1aSMatthew Knepley 1015583308b6SBarry Smith Notes: 1016583308b6SBarry Smith When adding to the number of dof for a field at a point one must also ensure the count of the total number of dof at the point (summed over 1017583308b6SBarry Smith the fields and the unnamed default field) is correct by also calling `PetscSectionAddDof()` or `PetscSectionSetDof()` 1018583308b6SBarry Smith 1019583308b6SBarry Smith This is equivalent to 1020583308b6SBarry Smith .vb 1021583308b6SBarry Smith PetscSection fs; 1022583308b6SBarry Smith PetscSectionGetField(s,field,&fs) 1023583308b6SBarry Smith PetscSectionAddDof(fs,numDof) 1024583308b6SBarry Smith .ve 1025583308b6SBarry Smith 1026cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionSetFieldDof()`, `PetscSectionGetFieldDof()`, `PetscSectionCreate()` 1027ea844a1aSMatthew Knepley @*/ 1028d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionAddFieldDof(PetscSection s, PetscInt point, PetscInt field, PetscInt numDof) 1029d71ae5a4SJacob Faibussowitsch { 1030ea844a1aSMatthew Knepley PetscFunctionBegin; 1031ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 10322abc8c78SJacob Faibussowitsch PetscSectionCheckValidField(field, s->numFields); 10339566063dSJacob Faibussowitsch PetscCall(PetscSectionAddDof(s->field[field], point, numDof)); 10343ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1035ea844a1aSMatthew Knepley } 1036ea844a1aSMatthew Knepley 1037ea844a1aSMatthew Knepley /*@ 1038ea844a1aSMatthew Knepley PetscSectionGetConstraintDof - Return the number of constrained degrees of freedom associated with a given point. 1039ea844a1aSMatthew Knepley 104040750d41SVaclav Hapla Not Collective 1041ea844a1aSMatthew Knepley 1042ea844a1aSMatthew Knepley Input Parameters: 1043cab54364SBarry Smith + s - the `PetscSection` 1044ea844a1aSMatthew Knepley - point - the point 1045ea844a1aSMatthew Knepley 1046ea844a1aSMatthew Knepley Output Parameter: 1047ea844a1aSMatthew Knepley . numDof - the number of dof which are fixed by constraints 1048ea844a1aSMatthew Knepley 1049ea844a1aSMatthew Knepley Level: intermediate 1050ea844a1aSMatthew Knepley 1051cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetDof()`, `PetscSectionSetConstraintDof()`, `PetscSectionCreate()` 1052ea844a1aSMatthew Knepley @*/ 1053d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetConstraintDof(PetscSection s, PetscInt point, PetscInt *numDof) 1054d71ae5a4SJacob Faibussowitsch { 1055ea844a1aSMatthew Knepley PetscFunctionBegin; 1056ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 10574f572ea9SToby Isaac PetscAssertPointer(numDof, 3); 1058ea844a1aSMatthew Knepley if (s->bc) { 10599566063dSJacob Faibussowitsch PetscCall(PetscSectionGetDof(s->bc, point, numDof)); 1060ea844a1aSMatthew Knepley } else *numDof = 0; 10613ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1062ea844a1aSMatthew Knepley } 1063ea844a1aSMatthew Knepley 1064ea844a1aSMatthew Knepley /*@ 1065ea844a1aSMatthew Knepley PetscSectionSetConstraintDof - Set the number of constrained degrees of freedom associated with a given point. 1066ea844a1aSMatthew Knepley 106740750d41SVaclav Hapla Not Collective 1068ea844a1aSMatthew Knepley 1069ea844a1aSMatthew Knepley Input Parameters: 1070cab54364SBarry Smith + s - the `PetscSection` 1071ea844a1aSMatthew Knepley . point - the point 1072ea844a1aSMatthew Knepley - numDof - the number of dof which are fixed by constraints 1073ea844a1aSMatthew Knepley 1074ea844a1aSMatthew Knepley Level: intermediate 1075ea844a1aSMatthew Knepley 1076cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionSetDof()`, `PetscSectionGetConstraintDof()`, `PetscSectionCreate()` 1077ea844a1aSMatthew Knepley @*/ 1078d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetConstraintDof(PetscSection s, PetscInt point, PetscInt numDof) 1079d71ae5a4SJacob Faibussowitsch { 1080ea844a1aSMatthew Knepley PetscFunctionBegin; 1081ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 1082ea844a1aSMatthew Knepley if (numDof) { 10837c0883d5SVaclav Hapla PetscCall(PetscSectionCheckConstraints_Private(s)); 10849566063dSJacob Faibussowitsch PetscCall(PetscSectionSetDof(s->bc, point, numDof)); 1085ea844a1aSMatthew Knepley } 10863ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1087ea844a1aSMatthew Knepley } 1088ea844a1aSMatthew Knepley 1089ea844a1aSMatthew Knepley /*@ 1090ea844a1aSMatthew Knepley PetscSectionAddConstraintDof - Increment the number of constrained degrees of freedom associated with a given point. 1091ea844a1aSMatthew Knepley 109240750d41SVaclav Hapla Not Collective 1093ea844a1aSMatthew Knepley 1094ea844a1aSMatthew Knepley Input Parameters: 1095cab54364SBarry Smith + s - the `PetscSection` 1096ea844a1aSMatthew Knepley . point - the point 1097ea844a1aSMatthew Knepley - numDof - the number of additional dof which are fixed by constraints 1098ea844a1aSMatthew Knepley 1099ea844a1aSMatthew Knepley Level: intermediate 1100ea844a1aSMatthew Knepley 1101cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionAddDof()`, `PetscSectionGetConstraintDof()`, `PetscSectionCreate()` 1102ea844a1aSMatthew Knepley @*/ 1103d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionAddConstraintDof(PetscSection s, PetscInt point, PetscInt numDof) 1104d71ae5a4SJacob Faibussowitsch { 1105ea844a1aSMatthew Knepley PetscFunctionBegin; 1106ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 1107ea844a1aSMatthew Knepley if (numDof) { 11087c0883d5SVaclav Hapla PetscCall(PetscSectionCheckConstraints_Private(s)); 11099566063dSJacob Faibussowitsch PetscCall(PetscSectionAddDof(s->bc, point, numDof)); 1110ea844a1aSMatthew Knepley } 11113ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1112ea844a1aSMatthew Knepley } 1113ea844a1aSMatthew Knepley 1114ea844a1aSMatthew Knepley /*@ 1115ea844a1aSMatthew Knepley PetscSectionGetFieldConstraintDof - Return the number of constrained degrees of freedom associated with a given field on a point. 1116ea844a1aSMatthew Knepley 111740750d41SVaclav Hapla Not Collective 1118ea844a1aSMatthew Knepley 1119ea844a1aSMatthew Knepley Input Parameters: 1120cab54364SBarry Smith + s - the `PetscSection` 1121ea844a1aSMatthew Knepley . point - the point 1122ea844a1aSMatthew Knepley - field - the field 1123ea844a1aSMatthew Knepley 1124ea844a1aSMatthew Knepley Output Parameter: 1125ea844a1aSMatthew Knepley . numDof - the number of dof which are fixed by constraints 1126ea844a1aSMatthew Knepley 1127ea844a1aSMatthew Knepley Level: intermediate 1128ea844a1aSMatthew Knepley 1129cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetDof()`, `PetscSectionSetFieldConstraintDof()`, `PetscSectionCreate()` 1130ea844a1aSMatthew Knepley @*/ 1131d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetFieldConstraintDof(PetscSection s, PetscInt point, PetscInt field, PetscInt *numDof) 1132d71ae5a4SJacob Faibussowitsch { 1133ea844a1aSMatthew Knepley PetscFunctionBegin; 1134ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 11354f572ea9SToby Isaac PetscAssertPointer(numDof, 4); 11362abc8c78SJacob Faibussowitsch PetscSectionCheckValidField(field, s->numFields); 11379566063dSJacob Faibussowitsch PetscCall(PetscSectionGetConstraintDof(s->field[field], point, numDof)); 11383ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1139ea844a1aSMatthew Knepley } 1140ea844a1aSMatthew Knepley 1141ea844a1aSMatthew Knepley /*@ 1142ea844a1aSMatthew Knepley PetscSectionSetFieldConstraintDof - Set the number of constrained degrees of freedom associated with a given field on a point. 1143ea844a1aSMatthew Knepley 114440750d41SVaclav Hapla Not Collective 1145ea844a1aSMatthew Knepley 1146ea844a1aSMatthew Knepley Input Parameters: 1147cab54364SBarry Smith + s - the `PetscSection` 1148ea844a1aSMatthew Knepley . point - the point 1149ea844a1aSMatthew Knepley . field - the field 1150ea844a1aSMatthew Knepley - numDof - the number of dof which are fixed by constraints 1151ea844a1aSMatthew Knepley 1152ea844a1aSMatthew Knepley Level: intermediate 1153ea844a1aSMatthew Knepley 1154cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionSetDof()`, `PetscSectionGetFieldConstraintDof()`, `PetscSectionCreate()` 1155ea844a1aSMatthew Knepley @*/ 1156d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetFieldConstraintDof(PetscSection s, PetscInt point, PetscInt field, PetscInt numDof) 1157d71ae5a4SJacob Faibussowitsch { 1158ea844a1aSMatthew Knepley PetscFunctionBegin; 1159ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 11602abc8c78SJacob Faibussowitsch PetscSectionCheckValidField(field, s->numFields); 11619566063dSJacob Faibussowitsch PetscCall(PetscSectionSetConstraintDof(s->field[field], point, numDof)); 11623ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1163ea844a1aSMatthew Knepley } 1164ea844a1aSMatthew Knepley 1165ea844a1aSMatthew Knepley /*@ 1166ea844a1aSMatthew Knepley PetscSectionAddFieldConstraintDof - Increment the number of constrained degrees of freedom associated with a given field on a point. 1167ea844a1aSMatthew Knepley 116840750d41SVaclav Hapla Not Collective 1169ea844a1aSMatthew Knepley 1170ea844a1aSMatthew Knepley Input Parameters: 1171cab54364SBarry Smith + s - the `PetscSection` 1172ea844a1aSMatthew Knepley . point - the point 1173ea844a1aSMatthew Knepley . field - the field 1174ea844a1aSMatthew Knepley - numDof - the number of additional dof which are fixed by constraints 1175ea844a1aSMatthew Knepley 1176ea844a1aSMatthew Knepley Level: intermediate 1177ea844a1aSMatthew Knepley 1178cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionAddDof()`, `PetscSectionGetFieldConstraintDof()`, `PetscSectionCreate()` 1179ea844a1aSMatthew Knepley @*/ 1180d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionAddFieldConstraintDof(PetscSection s, PetscInt point, PetscInt field, PetscInt numDof) 1181d71ae5a4SJacob Faibussowitsch { 1182ea844a1aSMatthew Knepley PetscFunctionBegin; 1183ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 11842abc8c78SJacob Faibussowitsch PetscSectionCheckValidField(field, s->numFields); 11859566063dSJacob Faibussowitsch PetscCall(PetscSectionAddConstraintDof(s->field[field], point, numDof)); 11863ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1187ea844a1aSMatthew Knepley } 1188ea844a1aSMatthew Knepley 1189ea844a1aSMatthew Knepley /*@ 1190ea844a1aSMatthew Knepley PetscSectionSetUpBC - Setup the subsections describing boundary conditions. 1191ea844a1aSMatthew Knepley 119240750d41SVaclav Hapla Not Collective 1193ea844a1aSMatthew Knepley 1194ea844a1aSMatthew Knepley Input Parameter: 1195cab54364SBarry Smith . s - the `PetscSection` 1196ea844a1aSMatthew Knepley 1197ea844a1aSMatthew Knepley Level: advanced 1198ea844a1aSMatthew Knepley 1199cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionSetUp()`, `PetscSectionCreate()` 1200ea844a1aSMatthew Knepley @*/ 1201d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetUpBC(PetscSection s) 1202d71ae5a4SJacob Faibussowitsch { 1203ea844a1aSMatthew Knepley PetscFunctionBegin; 1204ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 1205ea844a1aSMatthew Knepley if (s->bc) { 1206ea844a1aSMatthew Knepley const PetscInt last = (s->bc->pEnd - s->bc->pStart) - 1; 1207ea844a1aSMatthew Knepley 12089566063dSJacob Faibussowitsch PetscCall(PetscSectionSetUp(s->bc)); 12098da24d32SBarry Smith PetscCall(PetscMalloc1((last >= 0 ? s->bc->atlasOff[last] + s->bc->atlasDof[last] : 0), &s->bcIndices)); 1210ea844a1aSMatthew Knepley } 12113ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1212ea844a1aSMatthew Knepley } 1213ea844a1aSMatthew Knepley 1214ea844a1aSMatthew Knepley /*@ 1215583308b6SBarry Smith PetscSectionSetUp - Calculate offsets based upon the number of degrees of freedom for each point in preparation for use of the `PetscSection` 1216ea844a1aSMatthew Knepley 121740750d41SVaclav Hapla Not Collective 1218ea844a1aSMatthew Knepley 1219ea844a1aSMatthew Knepley Input Parameter: 1220cab54364SBarry Smith . s - the `PetscSection` 1221ea844a1aSMatthew Knepley 1222ea844a1aSMatthew Knepley Level: intermediate 1223ea844a1aSMatthew Knepley 1224583308b6SBarry Smith Notes: 1225583308b6SBarry Smith If used, `PetscSectionSetPermutation()` must be called before this routine. 1226583308b6SBarry Smith 1227583308b6SBarry Smith `PetscSectionSetPointMajor()`, cannot be called after this routine. 1228583308b6SBarry Smith 1229583308b6SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionCreate()`, `PetscSectionSetPermutation()` 1230ea844a1aSMatthew Knepley @*/ 1231d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetUp(PetscSection s) 1232d71ae5a4SJacob Faibussowitsch { 1233ea844a1aSMatthew Knepley const PetscInt *pind = NULL; 1234ea844a1aSMatthew Knepley PetscInt offset = 0, foff, p, f; 1235ea844a1aSMatthew Knepley 1236ea844a1aSMatthew Knepley PetscFunctionBegin; 1237ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 12383ba16761SJacob Faibussowitsch if (s->setup) PetscFunctionReturn(PETSC_SUCCESS); 1239ea844a1aSMatthew Knepley s->setup = PETSC_TRUE; 1240ea844a1aSMatthew Knepley /* Set offsets and field offsets for all points */ 1241ea844a1aSMatthew Knepley /* Assume that all fields have the same chart */ 124228b400f6SJacob Faibussowitsch PetscCheck(s->includesConstraints, PETSC_COMM_SELF, PETSC_ERR_SUP, "PetscSectionSetUp is currently unsupported for includesConstraints = PETSC_TRUE"); 12439566063dSJacob Faibussowitsch if (s->perm) PetscCall(ISGetIndices(s->perm, &pind)); 1244ea844a1aSMatthew Knepley if (s->pointMajor) { 1245ea844a1aSMatthew Knepley for (p = 0; p < s->pEnd - s->pStart; ++p) { 1246ea844a1aSMatthew Knepley const PetscInt q = pind ? pind[p] : p; 1247ea844a1aSMatthew Knepley 1248ea844a1aSMatthew Knepley /* Set point offset */ 1249ea844a1aSMatthew Knepley s->atlasOff[q] = offset; 1250ea844a1aSMatthew Knepley offset += s->atlasDof[q]; 1251ea844a1aSMatthew Knepley /* Set field offset */ 1252ea844a1aSMatthew Knepley for (f = 0, foff = s->atlasOff[q]; f < s->numFields; ++f) { 1253ea844a1aSMatthew Knepley PetscSection sf = s->field[f]; 1254ea844a1aSMatthew Knepley 1255ea844a1aSMatthew Knepley sf->atlasOff[q] = foff; 1256ea844a1aSMatthew Knepley foff += sf->atlasDof[q]; 1257ea844a1aSMatthew Knepley } 1258ea844a1aSMatthew Knepley } 1259ea844a1aSMatthew Knepley } else { 1260ea844a1aSMatthew Knepley /* Set field offsets for all points */ 1261ea844a1aSMatthew Knepley for (f = 0; f < s->numFields; ++f) { 1262ea844a1aSMatthew Knepley PetscSection sf = s->field[f]; 1263ea844a1aSMatthew Knepley 1264ea844a1aSMatthew Knepley for (p = 0; p < s->pEnd - s->pStart; ++p) { 1265ea844a1aSMatthew Knepley const PetscInt q = pind ? pind[p] : p; 1266ea844a1aSMatthew Knepley 1267ea844a1aSMatthew Knepley sf->atlasOff[q] = offset; 1268ea844a1aSMatthew Knepley offset += sf->atlasDof[q]; 1269ea844a1aSMatthew Knepley } 1270ea844a1aSMatthew Knepley } 1271ea844a1aSMatthew Knepley /* Disable point offsets since these are unused */ 1272ad540459SPierre Jolivet for (p = 0; p < s->pEnd - s->pStart; ++p) s->atlasOff[p] = -1; 1273ea844a1aSMatthew Knepley } 12749566063dSJacob Faibussowitsch if (s->perm) PetscCall(ISRestoreIndices(s->perm, &pind)); 1275ea844a1aSMatthew Knepley /* Setup BC sections */ 12769566063dSJacob Faibussowitsch PetscCall(PetscSectionSetUpBC(s)); 12779566063dSJacob Faibussowitsch for (f = 0; f < s->numFields; ++f) PetscCall(PetscSectionSetUpBC(s->field[f])); 12783ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1279ea844a1aSMatthew Knepley } 1280ea844a1aSMatthew Knepley 1281ea844a1aSMatthew Knepley /*@ 128220662ed9SBarry Smith PetscSectionGetMaxDof - Return the maximum number of degrees of freedom on any point in the `PetscSection` 1283ea844a1aSMatthew Knepley 128440750d41SVaclav Hapla Not Collective 1285ea844a1aSMatthew Knepley 12862fe279fdSBarry Smith Input Parameter: 1287cab54364SBarry Smith . s - the `PetscSection` 1288ea844a1aSMatthew Knepley 1289ea844a1aSMatthew Knepley Output Parameter: 1290ea844a1aSMatthew Knepley . maxDof - the maximum dof 1291ea844a1aSMatthew Knepley 1292ea844a1aSMatthew Knepley Level: intermediate 1293ea844a1aSMatthew Knepley 1294583308b6SBarry Smith Notes: 1295cab54364SBarry Smith The returned number is up-to-date without need for `PetscSectionSetUp()`. 129669c11d05SVaclav Hapla 1297583308b6SBarry Smith This is the maximum over all points of the sum of the number of dof in the unnamed default field plus all named fields. This is equivalent to 1298583308b6SBarry Smith the maximum over all points of the value returned by `PetscSectionGetDof()` on this MPI process 1299583308b6SBarry Smith 1300583308b6SBarry Smith Developer Notes: 130169c11d05SVaclav Hapla The returned number is calculated lazily and stashed. 1302cab54364SBarry Smith 1303cab54364SBarry Smith A call to `PetscSectionInvalidateMaxDof_Internal()` invalidates the stashed value. 1304cab54364SBarry Smith 1305cab54364SBarry Smith `PetscSectionInvalidateMaxDof_Internal()` is called in `PetscSectionSetDof()`, `PetscSectionAddDof()` and `PetscSectionReset()` 1306cab54364SBarry Smith 130720662ed9SBarry Smith It should also be called every time `atlasDof` is modified directly. 130869c11d05SVaclav Hapla 1309cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetDof()`, `PetscSectionSetDof()`, `PetscSectionAddDof()`, `PetscSectionCreate()` 1310ea844a1aSMatthew Knepley @*/ 1311d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetMaxDof(PetscSection s, PetscInt *maxDof) 1312d71ae5a4SJacob Faibussowitsch { 131369c11d05SVaclav Hapla PetscInt p; 131469c11d05SVaclav Hapla 1315ea844a1aSMatthew Knepley PetscFunctionBegin; 1316ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 13174f572ea9SToby Isaac PetscAssertPointer(maxDof, 2); 131869c11d05SVaclav Hapla if (s->maxDof == PETSC_MIN_INT) { 131969c11d05SVaclav Hapla s->maxDof = 0; 1320ad540459SPierre Jolivet for (p = 0; p < s->pEnd - s->pStart; ++p) s->maxDof = PetscMax(s->maxDof, s->atlasDof[p]); 132169c11d05SVaclav Hapla } 1322ea844a1aSMatthew Knepley *maxDof = s->maxDof; 13233ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1324ea844a1aSMatthew Knepley } 1325ea844a1aSMatthew Knepley 1326ea844a1aSMatthew Knepley /*@ 132720662ed9SBarry Smith PetscSectionGetStorageSize - Return the size of an array or local `Vec` capable of holding all the degrees of freedom defined in a `PetscSection` 1328ea844a1aSMatthew Knepley 132940750d41SVaclav Hapla Not Collective 1330ea844a1aSMatthew Knepley 1331ea844a1aSMatthew Knepley Input Parameter: 1332cab54364SBarry Smith . s - the `PetscSection` 1333ea844a1aSMatthew Knepley 1334ea844a1aSMatthew Knepley Output Parameter: 1335ea844a1aSMatthew Knepley . size - the size of an array which can hold all the dofs 1336ea844a1aSMatthew Knepley 1337ea844a1aSMatthew Knepley Level: intermediate 1338ea844a1aSMatthew Knepley 1339cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetOffset()`, `PetscSectionGetConstrainedStorageSize()`, `PetscSectionCreate()` 1340ea844a1aSMatthew Knepley @*/ 1341d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetStorageSize(PetscSection s, PetscInt *size) 1342d71ae5a4SJacob Faibussowitsch { 1343ea844a1aSMatthew Knepley PetscInt p, n = 0; 1344ea844a1aSMatthew Knepley 1345ea844a1aSMatthew Knepley PetscFunctionBegin; 1346ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 13474f572ea9SToby Isaac PetscAssertPointer(size, 2); 1348ea844a1aSMatthew Knepley for (p = 0; p < s->pEnd - s->pStart; ++p) n += s->atlasDof[p] > 0 ? s->atlasDof[p] : 0; 1349ea844a1aSMatthew Knepley *size = n; 13503ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1351ea844a1aSMatthew Knepley } 1352ea844a1aSMatthew Knepley 1353ea844a1aSMatthew Knepley /*@ 135420662ed9SBarry Smith PetscSectionGetConstrainedStorageSize - Return the size of an array or local `Vec` capable of holding all unconstrained degrees of freedom in a `PetscSection` 1355ea844a1aSMatthew Knepley 135640750d41SVaclav Hapla Not Collective 1357ea844a1aSMatthew Knepley 1358064ec1f3Sprj- Input Parameter: 1359cab54364SBarry Smith . s - the `PetscSection` 1360ea844a1aSMatthew Knepley 1361ea844a1aSMatthew Knepley Output Parameter: 1362ea844a1aSMatthew Knepley . size - the size of an array which can hold all unconstrained dofs 1363ea844a1aSMatthew Knepley 1364ea844a1aSMatthew Knepley Level: intermediate 1365ea844a1aSMatthew Knepley 1366cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetStorageSize()`, `PetscSectionGetOffset()`, `PetscSectionCreate()` 1367ea844a1aSMatthew Knepley @*/ 1368d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetConstrainedStorageSize(PetscSection s, PetscInt *size) 1369d71ae5a4SJacob Faibussowitsch { 1370ea844a1aSMatthew Knepley PetscInt p, n = 0; 1371ea844a1aSMatthew Knepley 1372ea844a1aSMatthew Knepley PetscFunctionBegin; 1373ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 13744f572ea9SToby Isaac PetscAssertPointer(size, 2); 1375ea844a1aSMatthew Knepley for (p = 0; p < s->pEnd - s->pStart; ++p) { 1376ea844a1aSMatthew Knepley const PetscInt cdof = s->bc ? s->bc->atlasDof[p] : 0; 1377ea844a1aSMatthew Knepley n += s->atlasDof[p] > 0 ? s->atlasDof[p] - cdof : 0; 1378ea844a1aSMatthew Knepley } 1379ea844a1aSMatthew Knepley *size = n; 13803ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1381ea844a1aSMatthew Knepley } 1382ea844a1aSMatthew Knepley 1383ea844a1aSMatthew Knepley /*@ 1384583308b6SBarry Smith PetscSectionCreateGlobalSection - Create a parallel section describing the global layout using 1385583308b6SBarry Smith a local (sequential) `PetscSection` on each MPI process and a `PetscSF` describing the section point overlap. 1386ea844a1aSMatthew Knepley 1387ea844a1aSMatthew Knepley Input Parameters: 1388cab54364SBarry Smith + s - The `PetscSection` for the local field layout 1389cab54364SBarry Smith . sf - The `PetscSF` describing parallel layout of the section points (leaves are unowned local points) 1390cab54364SBarry Smith . includeConstraints - By default this is `PETSC_FALSE`, meaning that the global field vector will not possess constrained dofs 1391cab54364SBarry Smith - localOffsets - If `PETSC_TRUE`, use local rather than global offsets for the points 1392ea844a1aSMatthew Knepley 1393ea844a1aSMatthew Knepley Output Parameter: 1394cab54364SBarry Smith . gsection - The `PetscSection` for the global field layout 1395ea844a1aSMatthew Knepley 1396ea844a1aSMatthew Knepley Level: intermediate 1397ea844a1aSMatthew Knepley 1398db527f05SMatthew G. Knepley Notes: 1399583308b6SBarry Smith On each MPI process `gsection` inherits the chart of the `s` on that process. 1400db527f05SMatthew G. Knepley 1401583308b6SBarry Smith This sets negative sizes and offsets to points not owned by this process as defined by `sf` but that are within the local value of the chart of `gsection`. 1402583308b6SBarry Smith In those locations the value of size is -(size+1) and the value of the offset on the remote process is -(off+1). 1403cab54364SBarry Smith 140420662ed9SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionCreate()`, `PetscSectionCreateGlobalSectionCensored()` 1405ea844a1aSMatthew Knepley @*/ 1406d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionCreateGlobalSection(PetscSection s, PetscSF sf, PetscBool includeConstraints, PetscBool localOffsets, PetscSection *gsection) 1407d71ae5a4SJacob Faibussowitsch { 1408ea844a1aSMatthew Knepley PetscSection gs; 1409ea844a1aSMatthew Knepley const PetscInt *pind = NULL; 1410ea844a1aSMatthew Knepley PetscInt *recv = NULL, *neg = NULL; 1411046d2115Sksagiyam PetscInt pStart, pEnd, p, dof, cdof, off, foff, globalOff = 0, nroots, nlocal, maxleaf; 1412046d2115Sksagiyam PetscInt numFields, f, numComponents; 1413ea844a1aSMatthew Knepley 1414ea844a1aSMatthew Knepley PetscFunctionBegin; 1415ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 1416ea844a1aSMatthew Knepley PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2); 1417ea844a1aSMatthew Knepley PetscValidLogicalCollectiveBool(s, includeConstraints, 3); 1418ea844a1aSMatthew Knepley PetscValidLogicalCollectiveBool(s, localOffsets, 4); 14194f572ea9SToby Isaac PetscAssertPointer(gsection, 5); 142028b400f6SJacob Faibussowitsch PetscCheck(s->pointMajor, PETSC_COMM_SELF, PETSC_ERR_SUP, "No support for field major ordering"); 14219566063dSJacob Faibussowitsch PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject)s), &gs)); 14229566063dSJacob Faibussowitsch PetscCall(PetscSectionGetNumFields(s, &numFields)); 14239566063dSJacob Faibussowitsch if (numFields > 0) PetscCall(PetscSectionSetNumFields(gs, numFields)); 14249566063dSJacob Faibussowitsch PetscCall(PetscSectionGetChart(s, &pStart, &pEnd)); 14259566063dSJacob Faibussowitsch PetscCall(PetscSectionSetChart(gs, pStart, pEnd)); 142687e637c6Sksagiyam gs->includesConstraints = includeConstraints; 14279566063dSJacob Faibussowitsch PetscCall(PetscSFGetGraph(sf, &nroots, NULL, NULL, NULL)); 1428ea844a1aSMatthew Knepley nlocal = nroots; /* The local/leaf space matches global/root space */ 1429ea844a1aSMatthew Knepley /* Must allocate for all points visible to SF, which may be more than this section */ 1430ea844a1aSMatthew Knepley if (nroots >= 0) { /* nroots < 0 means that the graph has not been set, only happens in serial */ 14319566063dSJacob Faibussowitsch PetscCall(PetscSFGetLeafRange(sf, NULL, &maxleaf)); 143208401ef6SPierre Jolivet PetscCheck(nroots >= pEnd, PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "SF roots %" PetscInt_FMT " < pEnd %" PetscInt_FMT, nroots, pEnd); 143308401ef6SPierre Jolivet PetscCheck(maxleaf < nroots, PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "Max local leaf %" PetscInt_FMT " >= nroots %" PetscInt_FMT, maxleaf, nroots); 14349566063dSJacob Faibussowitsch PetscCall(PetscMalloc2(nroots, &neg, nlocal, &recv)); 14359566063dSJacob Faibussowitsch PetscCall(PetscArrayzero(neg, nroots)); 1436ea844a1aSMatthew Knepley } 1437ea844a1aSMatthew Knepley /* Mark all local points with negative dof */ 1438ea844a1aSMatthew Knepley for (p = pStart; p < pEnd; ++p) { 14399566063dSJacob Faibussowitsch PetscCall(PetscSectionGetDof(s, p, &dof)); 14409566063dSJacob Faibussowitsch PetscCall(PetscSectionSetDof(gs, p, dof)); 14419566063dSJacob Faibussowitsch PetscCall(PetscSectionGetConstraintDof(s, p, &cdof)); 14429566063dSJacob Faibussowitsch if (!includeConstraints && cdof > 0) PetscCall(PetscSectionSetConstraintDof(gs, p, cdof)); 1443ea844a1aSMatthew Knepley if (neg) neg[p] = -(dof + 1); 1444ea844a1aSMatthew Knepley } 14459566063dSJacob Faibussowitsch PetscCall(PetscSectionSetUpBC(gs)); 14469566063dSJacob Faibussowitsch if (gs->bcIndices) PetscCall(PetscArraycpy(gs->bcIndices, s->bcIndices, gs->bc->atlasOff[gs->bc->pEnd - gs->bc->pStart - 1] + gs->bc->atlasDof[gs->bc->pEnd - gs->bc->pStart - 1])); 1447ea844a1aSMatthew Knepley if (nroots >= 0) { 14489566063dSJacob Faibussowitsch PetscCall(PetscArrayzero(recv, nlocal)); 14499566063dSJacob Faibussowitsch PetscCall(PetscSFBcastBegin(sf, MPIU_INT, neg, recv, MPI_REPLACE)); 14509566063dSJacob Faibussowitsch PetscCall(PetscSFBcastEnd(sf, MPIU_INT, neg, recv, MPI_REPLACE)); 1451ea844a1aSMatthew Knepley for (p = pStart; p < pEnd; ++p) { 1452ea844a1aSMatthew Knepley if (recv[p] < 0) { 1453ea844a1aSMatthew Knepley gs->atlasDof[p - pStart] = recv[p]; 14549566063dSJacob Faibussowitsch PetscCall(PetscSectionGetDof(s, p, &dof)); 145508401ef6SPierre Jolivet PetscCheck(-(recv[p] + 1) == dof, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Global dof %" PetscInt_FMT " for point %" PetscInt_FMT " is not the unconstrained %" PetscInt_FMT, -(recv[p] + 1), p, dof); 1456ea844a1aSMatthew Knepley } 1457ea844a1aSMatthew Knepley } 1458ea844a1aSMatthew Knepley } 1459ea844a1aSMatthew Knepley /* Calculate new sizes, get process offset, and calculate point offsets */ 14609566063dSJacob Faibussowitsch if (s->perm) PetscCall(ISGetIndices(s->perm, &pind)); 1461ea844a1aSMatthew Knepley for (p = 0, off = 0; p < pEnd - pStart; ++p) { 1462ea844a1aSMatthew Knepley const PetscInt q = pind ? pind[p] : p; 1463ea844a1aSMatthew Knepley 1464ea844a1aSMatthew Knepley cdof = (!includeConstraints && s->bc) ? s->bc->atlasDof[q] : 0; 1465ea844a1aSMatthew Knepley gs->atlasOff[q] = off; 1466ea844a1aSMatthew Knepley off += gs->atlasDof[q] > 0 ? gs->atlasDof[q] - cdof : 0; 1467ea844a1aSMatthew Knepley } 1468ea844a1aSMatthew Knepley if (!localOffsets) { 14699566063dSJacob Faibussowitsch PetscCallMPI(MPI_Scan(&off, &globalOff, 1, MPIU_INT, MPI_SUM, PetscObjectComm((PetscObject)s))); 1470ea844a1aSMatthew Knepley globalOff -= off; 1471ea844a1aSMatthew Knepley } 1472ea844a1aSMatthew Knepley for (p = pStart, off = 0; p < pEnd; ++p) { 1473ea844a1aSMatthew Knepley gs->atlasOff[p - pStart] += globalOff; 1474ea844a1aSMatthew Knepley if (neg) neg[p] = -(gs->atlasOff[p - pStart] + 1); 1475ea844a1aSMatthew Knepley } 14769566063dSJacob Faibussowitsch if (s->perm) PetscCall(ISRestoreIndices(s->perm, &pind)); 1477ea844a1aSMatthew Knepley /* Put in negative offsets for ghost points */ 1478ea844a1aSMatthew Knepley if (nroots >= 0) { 14799566063dSJacob Faibussowitsch PetscCall(PetscArrayzero(recv, nlocal)); 14809566063dSJacob Faibussowitsch PetscCall(PetscSFBcastBegin(sf, MPIU_INT, neg, recv, MPI_REPLACE)); 14819566063dSJacob Faibussowitsch PetscCall(PetscSFBcastEnd(sf, MPIU_INT, neg, recv, MPI_REPLACE)); 1482ea844a1aSMatthew Knepley for (p = pStart; p < pEnd; ++p) { 1483ea844a1aSMatthew Knepley if (recv[p] < 0) gs->atlasOff[p - pStart] = recv[p]; 1484ea844a1aSMatthew Knepley } 1485ea844a1aSMatthew Knepley } 14869566063dSJacob Faibussowitsch PetscCall(PetscFree2(neg, recv)); 1487046d2115Sksagiyam /* Set field dofs/offsets/constraints */ 1488046d2115Sksagiyam for (f = 0; f < numFields; ++f) { 1489046d2115Sksagiyam gs->field[f]->includesConstraints = includeConstraints; 14909566063dSJacob Faibussowitsch PetscCall(PetscSectionGetFieldComponents(s, f, &numComponents)); 14919566063dSJacob Faibussowitsch PetscCall(PetscSectionSetFieldComponents(gs, f, numComponents)); 1492046d2115Sksagiyam } 1493046d2115Sksagiyam for (p = pStart; p < pEnd; ++p) { 14949566063dSJacob Faibussowitsch PetscCall(PetscSectionGetOffset(gs, p, &off)); 1495046d2115Sksagiyam for (f = 0, foff = off; f < numFields; ++f) { 14969566063dSJacob Faibussowitsch PetscCall(PetscSectionGetFieldConstraintDof(s, p, f, &cdof)); 14979566063dSJacob Faibussowitsch if (!includeConstraints && cdof > 0) PetscCall(PetscSectionSetFieldConstraintDof(gs, p, f, cdof)); 14989566063dSJacob Faibussowitsch PetscCall(PetscSectionGetFieldDof(s, p, f, &dof)); 14999566063dSJacob Faibussowitsch PetscCall(PetscSectionSetFieldDof(gs, p, f, off < 0 ? -(dof + 1) : dof)); 15009566063dSJacob Faibussowitsch PetscCall(PetscSectionSetFieldOffset(gs, p, f, foff)); 15019566063dSJacob Faibussowitsch PetscCall(PetscSectionGetFieldConstraintDof(gs, p, f, &cdof)); 1502046d2115Sksagiyam foff = off < 0 ? foff - (dof - cdof) : foff + (dof - cdof); 1503046d2115Sksagiyam } 1504046d2115Sksagiyam } 1505046d2115Sksagiyam for (f = 0; f < numFields; ++f) { 1506046d2115Sksagiyam PetscSection gfs = gs->field[f]; 1507046d2115Sksagiyam 15089566063dSJacob Faibussowitsch PetscCall(PetscSectionSetUpBC(gfs)); 15099566063dSJacob Faibussowitsch if (gfs->bcIndices) PetscCall(PetscArraycpy(gfs->bcIndices, s->field[f]->bcIndices, gfs->bc->atlasOff[gfs->bc->pEnd - gfs->bc->pStart - 1] + gfs->bc->atlasDof[gfs->bc->pEnd - gfs->bc->pStart - 1])); 1510046d2115Sksagiyam } 1511046d2115Sksagiyam gs->setup = PETSC_TRUE; 15129566063dSJacob Faibussowitsch PetscCall(PetscSectionViewFromOptions(gs, NULL, "-global_section_view")); 1513ea844a1aSMatthew Knepley *gsection = gs; 15143ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1515ea844a1aSMatthew Knepley } 1516ea844a1aSMatthew Knepley 1517ea844a1aSMatthew Knepley /*@ 1518583308b6SBarry Smith PetscSectionCreateGlobalSectionCensored - Create a `PetscSection` describing the globallayout using 1519583308b6SBarry Smith a local (sequential) `PetscSection` on each MPI process and an `PetscSF` describing the section point overlap. 1520ea844a1aSMatthew Knepley 1521ea844a1aSMatthew Knepley Input Parameters: 1522cab54364SBarry Smith + s - The `PetscSection` for the local field layout 1523cab54364SBarry Smith . sf - The `PetscSF` describing parallel layout of the section points 1524583308b6SBarry Smith . includeConstraints - By default this is `PETSC_FALSE`, meaning that the global vector will not possess constrained dofs 1525583308b6SBarry Smith . numExcludes - The number of exclusion ranges, this must have the same value on all MPI processes 1526583308b6SBarry Smith - excludes - An array [start_0, end_0, start_1, end_1, ...] where there are `numExcludes` pairs and must have the same values on all MPI processes 1527ea844a1aSMatthew Knepley 1528ea844a1aSMatthew Knepley Output Parameter: 1529cab54364SBarry Smith . gsection - The `PetscSection` for the global field layout 1530ea844a1aSMatthew Knepley 1531ea844a1aSMatthew Knepley Level: advanced 1532ea844a1aSMatthew Knepley 1533583308b6SBarry Smith Notes: 1534583308b6SBarry Smith On each MPI process `gsection` inherits the chart of the `s` on that process. 153520662ed9SBarry Smith 1536583308b6SBarry Smith This sets negative sizes and offsets to points not owned by this process as defined by `sf` but that are within the local value of the chart of `gsection`. 1537583308b6SBarry Smith In those locations the value of size is -(size+1) and the value of the offset on the remote process is -(off+1). 1538583308b6SBarry Smith 1539583308b6SBarry Smith This routine augments `PetscSectionCreateGlobalSection()` by allowing one to exclude certain ranges in the chart of the `PetscSection` 1540cab54364SBarry Smith 154138b5cf2dSJacob Faibussowitsch Developer Notes: 154220662ed9SBarry Smith This is a terrible function name 154320662ed9SBarry Smith 154442747ad1SJacob Faibussowitsch .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionCreate()` 1545ea844a1aSMatthew Knepley @*/ 1546d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionCreateGlobalSectionCensored(PetscSection s, PetscSF sf, PetscBool includeConstraints, PetscInt numExcludes, const PetscInt excludes[], PetscSection *gsection) 1547d71ae5a4SJacob Faibussowitsch { 1548ea844a1aSMatthew Knepley const PetscInt *pind = NULL; 1549ea844a1aSMatthew Knepley PetscInt *neg = NULL, *tmpOff = NULL; 1550ea844a1aSMatthew Knepley PetscInt pStart, pEnd, p, e, dof, cdof, off, globalOff = 0, nroots; 1551ea844a1aSMatthew Knepley 1552ea844a1aSMatthew Knepley PetscFunctionBegin; 1553ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 1554ea844a1aSMatthew Knepley PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2); 15554f572ea9SToby Isaac PetscAssertPointer(gsection, 6); 15569566063dSJacob Faibussowitsch PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject)s), gsection)); 15579566063dSJacob Faibussowitsch PetscCall(PetscSectionGetChart(s, &pStart, &pEnd)); 15589566063dSJacob Faibussowitsch PetscCall(PetscSectionSetChart(*gsection, pStart, pEnd)); 15599566063dSJacob Faibussowitsch PetscCall(PetscSFGetGraph(sf, &nroots, NULL, NULL, NULL)); 1560ea844a1aSMatthew Knepley if (nroots >= 0) { 156108401ef6SPierre Jolivet PetscCheck(nroots >= pEnd - pStart, PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "PetscSF nroots %" PetscInt_FMT " < %" PetscInt_FMT " section size", nroots, pEnd - pStart); 15629566063dSJacob Faibussowitsch PetscCall(PetscCalloc1(nroots, &neg)); 1563ea844a1aSMatthew Knepley if (nroots > pEnd - pStart) { 15649566063dSJacob Faibussowitsch PetscCall(PetscCalloc1(nroots, &tmpOff)); 1565ea844a1aSMatthew Knepley } else { 1566ea844a1aSMatthew Knepley tmpOff = &(*gsection)->atlasDof[-pStart]; 1567ea844a1aSMatthew Knepley } 1568ea844a1aSMatthew Knepley } 1569ea844a1aSMatthew Knepley /* Mark ghost points with negative dof */ 1570ea844a1aSMatthew Knepley for (p = pStart; p < pEnd; ++p) { 1571ea844a1aSMatthew Knepley for (e = 0; e < numExcludes; ++e) { 1572ea844a1aSMatthew Knepley if ((p >= excludes[e * 2 + 0]) && (p < excludes[e * 2 + 1])) { 15739566063dSJacob Faibussowitsch PetscCall(PetscSectionSetDof(*gsection, p, 0)); 1574ea844a1aSMatthew Knepley break; 1575ea844a1aSMatthew Knepley } 1576ea844a1aSMatthew Knepley } 1577ea844a1aSMatthew Knepley if (e < numExcludes) continue; 15789566063dSJacob Faibussowitsch PetscCall(PetscSectionGetDof(s, p, &dof)); 15799566063dSJacob Faibussowitsch PetscCall(PetscSectionSetDof(*gsection, p, dof)); 15809566063dSJacob Faibussowitsch PetscCall(PetscSectionGetConstraintDof(s, p, &cdof)); 15819566063dSJacob Faibussowitsch if (!includeConstraints && cdof > 0) PetscCall(PetscSectionSetConstraintDof(*gsection, p, cdof)); 1582ea844a1aSMatthew Knepley if (neg) neg[p] = -(dof + 1); 1583ea844a1aSMatthew Knepley } 15849566063dSJacob Faibussowitsch PetscCall(PetscSectionSetUpBC(*gsection)); 1585ea844a1aSMatthew Knepley if (nroots >= 0) { 15869566063dSJacob Faibussowitsch PetscCall(PetscSFBcastBegin(sf, MPIU_INT, neg, tmpOff, MPI_REPLACE)); 15879566063dSJacob Faibussowitsch PetscCall(PetscSFBcastEnd(sf, MPIU_INT, neg, tmpOff, MPI_REPLACE)); 1588ea844a1aSMatthew Knepley if (nroots > pEnd - pStart) { 15899371c9d4SSatish Balay for (p = pStart; p < pEnd; ++p) { 15909371c9d4SSatish Balay if (tmpOff[p] < 0) (*gsection)->atlasDof[p - pStart] = tmpOff[p]; 15919371c9d4SSatish Balay } 1592ea844a1aSMatthew Knepley } 1593ea844a1aSMatthew Knepley } 159435cb6cd3SPierre Jolivet /* Calculate new sizes, get process offset, and calculate point offsets */ 15959566063dSJacob Faibussowitsch if (s->perm) PetscCall(ISGetIndices(s->perm, &pind)); 1596ea844a1aSMatthew Knepley for (p = 0, off = 0; p < pEnd - pStart; ++p) { 1597ea844a1aSMatthew Knepley const PetscInt q = pind ? pind[p] : p; 1598ea844a1aSMatthew Knepley 1599ea844a1aSMatthew Knepley cdof = (!includeConstraints && s->bc) ? s->bc->atlasDof[q] : 0; 1600ea844a1aSMatthew Knepley (*gsection)->atlasOff[q] = off; 1601ea844a1aSMatthew Knepley off += (*gsection)->atlasDof[q] > 0 ? (*gsection)->atlasDof[q] - cdof : 0; 1602ea844a1aSMatthew Knepley } 16039566063dSJacob Faibussowitsch PetscCallMPI(MPI_Scan(&off, &globalOff, 1, MPIU_INT, MPI_SUM, PetscObjectComm((PetscObject)s))); 1604ea844a1aSMatthew Knepley globalOff -= off; 1605ea844a1aSMatthew Knepley for (p = 0, off = 0; p < pEnd - pStart; ++p) { 1606ea844a1aSMatthew Knepley (*gsection)->atlasOff[p] += globalOff; 1607ea844a1aSMatthew Knepley if (neg) neg[p + pStart] = -((*gsection)->atlasOff[p] + 1); 1608ea844a1aSMatthew Knepley } 16099566063dSJacob Faibussowitsch if (s->perm) PetscCall(ISRestoreIndices(s->perm, &pind)); 1610ea844a1aSMatthew Knepley /* Put in negative offsets for ghost points */ 1611ea844a1aSMatthew Knepley if (nroots >= 0) { 1612ea844a1aSMatthew Knepley if (nroots == pEnd - pStart) tmpOff = &(*gsection)->atlasOff[-pStart]; 16139566063dSJacob Faibussowitsch PetscCall(PetscSFBcastBegin(sf, MPIU_INT, neg, tmpOff, MPI_REPLACE)); 16149566063dSJacob Faibussowitsch PetscCall(PetscSFBcastEnd(sf, MPIU_INT, neg, tmpOff, MPI_REPLACE)); 1615ea844a1aSMatthew Knepley if (nroots > pEnd - pStart) { 16169371c9d4SSatish Balay for (p = pStart; p < pEnd; ++p) { 16179371c9d4SSatish Balay if (tmpOff[p] < 0) (*gsection)->atlasOff[p - pStart] = tmpOff[p]; 16189371c9d4SSatish Balay } 1619ea844a1aSMatthew Knepley } 1620ea844a1aSMatthew Knepley } 16219566063dSJacob Faibussowitsch if (nroots >= 0 && nroots > pEnd - pStart) PetscCall(PetscFree(tmpOff)); 16229566063dSJacob Faibussowitsch PetscCall(PetscFree(neg)); 16233ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1624ea844a1aSMatthew Knepley } 1625ea844a1aSMatthew Knepley 1626ea844a1aSMatthew Knepley /*@ 1627583308b6SBarry Smith PetscSectionGetPointLayout - Get a `PetscLayout` for the points with nonzero dof counts of the unnamed default field within this `PetscSection`s local chart 1628ea844a1aSMatthew Knepley 1629cab54364SBarry Smith Collective 1630ea844a1aSMatthew Knepley 1631ea844a1aSMatthew Knepley Input Parameters: 1632cab54364SBarry Smith + comm - The `MPI_Comm` 1633cab54364SBarry Smith - s - The `PetscSection` 1634ea844a1aSMatthew Knepley 1635ea844a1aSMatthew Knepley Output Parameter: 163620662ed9SBarry Smith . layout - The point layout for the data that defines the section 1637ea844a1aSMatthew Knepley 1638ea844a1aSMatthew Knepley Level: advanced 1639ea844a1aSMatthew Knepley 164020662ed9SBarry Smith Notes: 1641583308b6SBarry Smith `PetscSectionGetValueLayout()` provides similar information but counting the total number of degrees of freedom on the MPI process (excluding constrained 1642583308b6SBarry Smith degrees of freedom). 164320662ed9SBarry Smith 1644583308b6SBarry Smith This count includes constrained degrees of freedom 1645583308b6SBarry Smith 1646583308b6SBarry Smith This is usually called on the default global section. 1647583308b6SBarry Smith 1648583308b6SBarry Smith Example: 1649583308b6SBarry Smith .vb 1650583308b6SBarry Smith The chart is [2,5), point 2 has 2 dof, point 3 has 0 dof, point 4 has 1 dof 1651583308b6SBarry Smith The local size of the `PetscLayout` is 2 since 2 points have a non-zero number of dof 1652583308b6SBarry Smith .ve 1653583308b6SBarry Smith 165438b5cf2dSJacob Faibussowitsch Developer Notes: 1655583308b6SBarry Smith I find the names of these two functions extremely non-informative 1656cab54364SBarry Smith 1657cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetValueLayout()`, `PetscSectionCreate()` 1658ea844a1aSMatthew Knepley @*/ 1659d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetPointLayout(MPI_Comm comm, PetscSection s, PetscLayout *layout) 1660d71ae5a4SJacob Faibussowitsch { 1661ea844a1aSMatthew Knepley PetscInt pStart, pEnd, p, localSize = 0; 1662ea844a1aSMatthew Knepley 1663ea844a1aSMatthew Knepley PetscFunctionBegin; 16649566063dSJacob Faibussowitsch PetscCall(PetscSectionGetChart(s, &pStart, &pEnd)); 1665ea844a1aSMatthew Knepley for (p = pStart; p < pEnd; ++p) { 1666ea844a1aSMatthew Knepley PetscInt dof; 1667ea844a1aSMatthew Knepley 16689566063dSJacob Faibussowitsch PetscCall(PetscSectionGetDof(s, p, &dof)); 16699120ba30SVaclav Hapla if (dof >= 0) ++localSize; 1670ea844a1aSMatthew Knepley } 16719566063dSJacob Faibussowitsch PetscCall(PetscLayoutCreate(comm, layout)); 16729566063dSJacob Faibussowitsch PetscCall(PetscLayoutSetLocalSize(*layout, localSize)); 16739566063dSJacob Faibussowitsch PetscCall(PetscLayoutSetBlockSize(*layout, 1)); 16749566063dSJacob Faibussowitsch PetscCall(PetscLayoutSetUp(*layout)); 16753ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1676ea844a1aSMatthew Knepley } 1677ea844a1aSMatthew Knepley 1678ea844a1aSMatthew Knepley /*@ 167920662ed9SBarry Smith PetscSectionGetValueLayout - Get the `PetscLayout` associated with the section dofs of a `PetscSection` 1680ea844a1aSMatthew Knepley 1681cab54364SBarry Smith Collective 1682ea844a1aSMatthew Knepley 1683ea844a1aSMatthew Knepley Input Parameters: 1684cab54364SBarry Smith + comm - The `MPI_Comm` 1685cab54364SBarry Smith - s - The `PetscSection` 1686ea844a1aSMatthew Knepley 1687ea844a1aSMatthew Knepley Output Parameter: 1688ea844a1aSMatthew Knepley . layout - The dof layout for the section 1689ea844a1aSMatthew Knepley 1690ea844a1aSMatthew Knepley Level: advanced 1691ea844a1aSMatthew Knepley 169220662ed9SBarry Smith Notes: 1693583308b6SBarry Smith `PetscSectionGetPointLayout()` provides similar information but only counting the number of points with nonzero degrees of freedom and 1694583308b6SBarry Smith including the constrained degrees of freedom 169520662ed9SBarry Smith 1696cab54364SBarry Smith This is usually called for the default global section. 1697cab54364SBarry Smith 1698583308b6SBarry Smith Example: 1699583308b6SBarry Smith .vb 1700583308b6SBarry Smith The chart is [2,5), point 2 has 4 dof (2 constrained), point 3 has 0 dof, point 4 has 1 dof (not constrained) 1701583308b6SBarry Smith The local size of the `PetscLayout` is 3 since there are 3 unconstrained degrees of freedom on this MPI process 1702583308b6SBarry Smith .ve 1703583308b6SBarry Smith 1704cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetPointLayout()`, `PetscSectionCreate()` 1705ea844a1aSMatthew Knepley @*/ 1706d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetValueLayout(MPI_Comm comm, PetscSection s, PetscLayout *layout) 1707d71ae5a4SJacob Faibussowitsch { 1708ea844a1aSMatthew Knepley PetscInt pStart, pEnd, p, localSize = 0; 1709ea844a1aSMatthew Knepley 1710ea844a1aSMatthew Knepley PetscFunctionBegin; 1711ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 2); 17124f572ea9SToby Isaac PetscAssertPointer(layout, 3); 17139566063dSJacob Faibussowitsch PetscCall(PetscSectionGetChart(s, &pStart, &pEnd)); 1714ea844a1aSMatthew Knepley for (p = pStart; p < pEnd; ++p) { 1715ea844a1aSMatthew Knepley PetscInt dof, cdof; 1716ea844a1aSMatthew Knepley 17179566063dSJacob Faibussowitsch PetscCall(PetscSectionGetDof(s, p, &dof)); 17189566063dSJacob Faibussowitsch PetscCall(PetscSectionGetConstraintDof(s, p, &cdof)); 1719ea844a1aSMatthew Knepley if (dof - cdof > 0) localSize += dof - cdof; 1720ea844a1aSMatthew Knepley } 17219566063dSJacob Faibussowitsch PetscCall(PetscLayoutCreate(comm, layout)); 17229566063dSJacob Faibussowitsch PetscCall(PetscLayoutSetLocalSize(*layout, localSize)); 17239566063dSJacob Faibussowitsch PetscCall(PetscLayoutSetBlockSize(*layout, 1)); 17249566063dSJacob Faibussowitsch PetscCall(PetscLayoutSetUp(*layout)); 17253ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1726ea844a1aSMatthew Knepley } 1727ea844a1aSMatthew Knepley 1728ea844a1aSMatthew Knepley /*@ 1729db527f05SMatthew G. Knepley PetscSectionGetOffset - Return the offset into an array or `Vec` for the dof associated with the given point. 1730ea844a1aSMatthew Knepley 173140750d41SVaclav Hapla Not Collective 1732ea844a1aSMatthew Knepley 1733ea844a1aSMatthew Knepley Input Parameters: 1734cab54364SBarry Smith + s - the `PetscSection` 1735ea844a1aSMatthew Knepley - point - the point 1736ea844a1aSMatthew Knepley 1737ea844a1aSMatthew Knepley Output Parameter: 1738ea844a1aSMatthew Knepley . offset - the offset 1739ea844a1aSMatthew Knepley 1740ea844a1aSMatthew Knepley Level: intermediate 1741ea844a1aSMatthew Knepley 1742583308b6SBarry Smith Notes: 1743376335faSBarry Smith In a global section, `offset` will be negative for points not owned by this process. 1744583308b6SBarry Smith 1745583308b6SBarry Smith This is for the unnamed default field in the `PetscSection` not the named fields 1746583308b6SBarry Smith 1747583308b6SBarry Smith The `offset` values are different depending on a value set with `PetscSectionSetPointMajor()` 1748583308b6SBarry Smith 1749583308b6SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetFieldOffset()`, `PetscSectionCreate()`, `PetscSectionSetPointMajor()` 1750ea844a1aSMatthew Knepley @*/ 1751d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetOffset(PetscSection s, PetscInt point, PetscInt *offset) 1752d71ae5a4SJacob Faibussowitsch { 1753ea844a1aSMatthew Knepley PetscFunctionBegin; 1754ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 17554f572ea9SToby Isaac PetscAssertPointer(offset, 3); 1756b498ca8aSPierre Jolivet PetscAssert(!(point < s->pStart) && !(point >= s->pEnd), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Section point %" PetscInt_FMT " should be in [%" PetscInt_FMT ", %" PetscInt_FMT ")", point, s->pStart, s->pEnd); 1757ea844a1aSMatthew Knepley *offset = s->atlasOff[point - s->pStart]; 17583ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1759ea844a1aSMatthew Knepley } 1760ea844a1aSMatthew Knepley 1761ea844a1aSMatthew Knepley /*@ 1762db527f05SMatthew G. Knepley PetscSectionSetOffset - Set the offset into an array or `Vec` for the dof associated with the given point. 1763ea844a1aSMatthew Knepley 176440750d41SVaclav Hapla Not Collective 1765ea844a1aSMatthew Knepley 1766ea844a1aSMatthew Knepley Input Parameters: 1767cab54364SBarry Smith + s - the `PetscSection` 1768ea844a1aSMatthew Knepley . point - the point 1769376335faSBarry Smith - offset - the offset, these values may be negative indicating the values are off process 1770ea844a1aSMatthew Knepley 1771583308b6SBarry Smith Level: developer 1772ea844a1aSMatthew Knepley 1773cab54364SBarry Smith Note: 1774cab54364SBarry Smith The user usually does not call this function, but uses `PetscSectionSetUp()` 1775cab54364SBarry Smith 1776cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetFieldOffset()`, `PetscSectionCreate()`, `PetscSectionSetUp()` 1777ea844a1aSMatthew Knepley @*/ 1778d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetOffset(PetscSection s, PetscInt point, PetscInt offset) 1779d71ae5a4SJacob Faibussowitsch { 1780ea844a1aSMatthew Knepley PetscFunctionBegin; 1781ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 178208401ef6SPierre Jolivet PetscCheck(!(point < s->pStart) && !(point >= s->pEnd), PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Section point %" PetscInt_FMT " should be in [%" PetscInt_FMT ", %" PetscInt_FMT ")", point, s->pStart, s->pEnd); 1783ea844a1aSMatthew Knepley s->atlasOff[point - s->pStart] = offset; 17843ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1785ea844a1aSMatthew Knepley } 1786ea844a1aSMatthew Knepley 1787ea844a1aSMatthew Knepley /*@ 1788db527f05SMatthew G. Knepley PetscSectionGetFieldOffset - Return the offset into an array or `Vec` for the field dof associated with the given point. 1789ea844a1aSMatthew Knepley 179040750d41SVaclav Hapla Not Collective 1791ea844a1aSMatthew Knepley 1792ea844a1aSMatthew Knepley Input Parameters: 1793cab54364SBarry Smith + s - the `PetscSection` 1794ea844a1aSMatthew Knepley . point - the point 1795ea844a1aSMatthew Knepley - field - the field 1796ea844a1aSMatthew Knepley 1797ea844a1aSMatthew Knepley Output Parameter: 1798ea844a1aSMatthew Knepley . offset - the offset 1799ea844a1aSMatthew Knepley 1800ea844a1aSMatthew Knepley Level: intermediate 1801ea844a1aSMatthew Knepley 1802583308b6SBarry Smith Notes: 1803376335faSBarry Smith In a global section, `offset` will be negative for points not owned by this process. 1804583308b6SBarry Smith 1805583308b6SBarry Smith The `offset` values are different depending on a value set with `PetscSectionSetPointMajor()` 1806583308b6SBarry Smith 1807583308b6SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetOffset()`, `PetscSectionCreate()`, `PetscSectionGetFieldPointOffset()` 1808ea844a1aSMatthew Knepley @*/ 1809d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetFieldOffset(PetscSection s, PetscInt point, PetscInt field, PetscInt *offset) 1810d71ae5a4SJacob Faibussowitsch { 1811ea844a1aSMatthew Knepley PetscFunctionBegin; 1812ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 18134f572ea9SToby Isaac PetscAssertPointer(offset, 4); 18142abc8c78SJacob Faibussowitsch PetscSectionCheckValidField(field, s->numFields); 18159566063dSJacob Faibussowitsch PetscCall(PetscSectionGetOffset(s->field[field], point, offset)); 18163ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1817ea844a1aSMatthew Knepley } 1818ea844a1aSMatthew Knepley 1819ea844a1aSMatthew Knepley /*@ 1820db527f05SMatthew G. Knepley PetscSectionSetFieldOffset - Set the offset into an array or `Vec` for the dof associated with the given field at a point. 1821ea844a1aSMatthew Knepley 182240750d41SVaclav Hapla Not Collective 1823ea844a1aSMatthew Knepley 1824ea844a1aSMatthew Knepley Input Parameters: 182520662ed9SBarry Smith + s - the `PetscSection` 1826ea844a1aSMatthew Knepley . point - the point 1827ea844a1aSMatthew Knepley . field - the field 1828376335faSBarry Smith - offset - the offset, these values may be negative indicating the values are off process 1829ea844a1aSMatthew Knepley 1830cab54364SBarry Smith Level: developer 1831ea844a1aSMatthew Knepley 1832cab54364SBarry Smith Note: 1833cab54364SBarry Smith The user usually does not call this function, but uses `PetscSectionSetUp()` 1834ea844a1aSMatthew Knepley 1835cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetFieldOffset()`, `PetscSectionSetOffset()`, `PetscSectionCreate()`, `PetscSectionSetUp()` 1836ea844a1aSMatthew Knepley @*/ 1837d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetFieldOffset(PetscSection s, PetscInt point, PetscInt field, PetscInt offset) 1838d71ae5a4SJacob Faibussowitsch { 1839ea844a1aSMatthew Knepley PetscFunctionBegin; 1840ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 18412abc8c78SJacob Faibussowitsch PetscSectionCheckValidField(field, s->numFields); 18429566063dSJacob Faibussowitsch PetscCall(PetscSectionSetOffset(s->field[field], point, offset)); 18433ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1844ea844a1aSMatthew Knepley } 1845ea844a1aSMatthew Knepley 1846ea844a1aSMatthew Knepley /*@ 1847583308b6SBarry Smith PetscSectionGetFieldPointOffset - Return the offset for the first field dof associated with the given point relative to the offset for that point for the 1848583308b6SBarry Smith unnamed default field's first dof 1849ea844a1aSMatthew Knepley 185040750d41SVaclav Hapla Not Collective 1851ea844a1aSMatthew Knepley 1852ea844a1aSMatthew Knepley Input Parameters: 1853cab54364SBarry Smith + s - the `PetscSection` 1854ea844a1aSMatthew Knepley . point - the point 1855ea844a1aSMatthew Knepley - field - the field 1856ea844a1aSMatthew Knepley 1857ea844a1aSMatthew Knepley Output Parameter: 1858ea844a1aSMatthew Knepley . offset - the offset 1859ea844a1aSMatthew Knepley 1860ea844a1aSMatthew Knepley Level: advanced 1861ea844a1aSMatthew Knepley 1862cab54364SBarry Smith Note: 1863583308b6SBarry Smith This ignores constraints 1864cab54364SBarry Smith 1865583308b6SBarry Smith Example: 1866583308b6SBarry Smith .vb 1867583308b6SBarry Smith if PetscSectionSetPointMajor(s,PETSC_TRUE) 1868583308b6SBarry Smith The unnamed default field has 3 dof at `point` 1869583308b6SBarry Smith Field 0 has 2 dof at `point` 1870583308b6SBarry Smith Then PetscSectionGetFieldPointOffset(s,point,1,&offset) returns and offset of 5 1871583308b6SBarry Smith .ve 1872583308b6SBarry Smith 1873583308b6SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetOffset()`, `PetscSectionCreate()`, `PetscSectionGetFieldOffset()` 1874ea844a1aSMatthew Knepley @*/ 1875d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetFieldPointOffset(PetscSection s, PetscInt point, PetscInt field, PetscInt *offset) 1876d71ae5a4SJacob Faibussowitsch { 1877ea844a1aSMatthew Knepley PetscInt off, foff; 1878ea844a1aSMatthew Knepley 1879ea844a1aSMatthew Knepley PetscFunctionBegin; 1880ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 18814f572ea9SToby Isaac PetscAssertPointer(offset, 4); 18822abc8c78SJacob Faibussowitsch PetscSectionCheckValidField(field, s->numFields); 18839566063dSJacob Faibussowitsch PetscCall(PetscSectionGetOffset(s, point, &off)); 18849566063dSJacob Faibussowitsch PetscCall(PetscSectionGetOffset(s->field[field], point, &foff)); 1885ea844a1aSMatthew Knepley *offset = foff - off; 18863ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1887ea844a1aSMatthew Knepley } 1888ea844a1aSMatthew Knepley 1889ea844a1aSMatthew Knepley /*@ 189020662ed9SBarry Smith PetscSectionGetOffsetRange - Return the full range of offsets [`start`, `end`) for a `PetscSection` 1891ea844a1aSMatthew Knepley 189240750d41SVaclav Hapla Not Collective 1893ea844a1aSMatthew Knepley 1894ea844a1aSMatthew Knepley Input Parameter: 1895cab54364SBarry Smith . s - the `PetscSection` 1896ea844a1aSMatthew Knepley 1897ea844a1aSMatthew Knepley Output Parameters: 1898ea844a1aSMatthew Knepley + start - the minimum offset 1899ea844a1aSMatthew Knepley - end - one more than the maximum offset 1900ea844a1aSMatthew Knepley 1901ea844a1aSMatthew Knepley Level: intermediate 1902ea844a1aSMatthew Knepley 1903cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetOffset()`, `PetscSectionCreate()` 1904ea844a1aSMatthew Knepley @*/ 1905d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetOffsetRange(PetscSection s, PetscInt *start, PetscInt *end) 1906d71ae5a4SJacob Faibussowitsch { 1907ea844a1aSMatthew Knepley PetscInt os = 0, oe = 0, pStart, pEnd, p; 1908ea844a1aSMatthew Knepley 1909ea844a1aSMatthew Knepley PetscFunctionBegin; 1910ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 19119371c9d4SSatish Balay if (s->atlasOff) { 19129371c9d4SSatish Balay os = s->atlasOff[0]; 19139371c9d4SSatish Balay oe = s->atlasOff[0]; 19149371c9d4SSatish Balay } 19159566063dSJacob Faibussowitsch PetscCall(PetscSectionGetChart(s, &pStart, &pEnd)); 1916ea844a1aSMatthew Knepley for (p = 0; p < pEnd - pStart; ++p) { 1917ea844a1aSMatthew Knepley PetscInt dof = s->atlasDof[p], off = s->atlasOff[p]; 1918ea844a1aSMatthew Knepley 1919ea844a1aSMatthew Knepley if (off >= 0) { 1920ea844a1aSMatthew Knepley os = PetscMin(os, off); 1921ea844a1aSMatthew Knepley oe = PetscMax(oe, off + dof); 1922ea844a1aSMatthew Knepley } 1923ea844a1aSMatthew Knepley } 1924ea844a1aSMatthew Knepley if (start) *start = os; 1925ea844a1aSMatthew Knepley if (end) *end = oe; 19263ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1927ea844a1aSMatthew Knepley } 1928ea844a1aSMatthew Knepley 1929ea844a1aSMatthew Knepley /*@ 1930583308b6SBarry Smith PetscSectionCreateSubsection - Create a new, smaller `PetscSection` composed of only selected fields 1931ea844a1aSMatthew Knepley 193240750d41SVaclav Hapla Collective 1933ea844a1aSMatthew Knepley 1934d8d19677SJose E. Roman Input Parameters: 1935cab54364SBarry Smith + s - the `PetscSection` 1936ea844a1aSMatthew Knepley . len - the number of subfields 1937ea844a1aSMatthew Knepley - fields - the subfield numbers 1938ea844a1aSMatthew Knepley 1939ea844a1aSMatthew Knepley Output Parameter: 1940ea844a1aSMatthew Knepley . subs - the subsection 1941ea844a1aSMatthew Knepley 1942ea844a1aSMatthew Knepley Level: advanced 1943ea844a1aSMatthew Knepley 1944cab54364SBarry Smith Notes: 1945583308b6SBarry Smith The chart of `subs` is the same as the chart of `s` 1946cab54364SBarry Smith 1947cab54364SBarry Smith This will error if a fieldnumber is out of range 1948cab54364SBarry Smith 1949cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionCreateSupersection()`, `PetscSectionCreate()` 1950ea844a1aSMatthew Knepley @*/ 1951d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionCreateSubsection(PetscSection s, PetscInt len, const PetscInt fields[], PetscSection *subs) 1952d71ae5a4SJacob Faibussowitsch { 1953b778fa18SValeria Barra PetscInt nF, f, c, pStart, pEnd, p, maxCdof = 0; 1954ea844a1aSMatthew Knepley 1955ea844a1aSMatthew Knepley PetscFunctionBegin; 19563ba16761SJacob Faibussowitsch if (!len) PetscFunctionReturn(PETSC_SUCCESS); 1957ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 19584f572ea9SToby Isaac PetscAssertPointer(fields, 3); 19594f572ea9SToby Isaac PetscAssertPointer(subs, 4); 19609566063dSJacob Faibussowitsch PetscCall(PetscSectionGetNumFields(s, &nF)); 196108401ef6SPierre Jolivet PetscCheck(len <= nF, PetscObjectComm((PetscObject)s), PETSC_ERR_ARG_WRONG, "Number of requested fields %" PetscInt_FMT " greater than number of fields %" PetscInt_FMT, len, nF); 19629566063dSJacob Faibussowitsch PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject)s), subs)); 19639566063dSJacob Faibussowitsch PetscCall(PetscSectionSetNumFields(*subs, len)); 1964ea844a1aSMatthew Knepley for (f = 0; f < len; ++f) { 1965ea844a1aSMatthew Knepley const char *name = NULL; 1966ea844a1aSMatthew Knepley PetscInt numComp = 0; 196742a52479SJed Brown PetscSectionSym sym; 1968ea844a1aSMatthew Knepley 19699566063dSJacob Faibussowitsch PetscCall(PetscSectionGetFieldName(s, fields[f], &name)); 19709566063dSJacob Faibussowitsch PetscCall(PetscSectionSetFieldName(*subs, f, name)); 19719566063dSJacob Faibussowitsch PetscCall(PetscSectionGetFieldComponents(s, fields[f], &numComp)); 19729566063dSJacob Faibussowitsch PetscCall(PetscSectionSetFieldComponents(*subs, f, numComp)); 1973b778fa18SValeria Barra for (c = 0; c < s->numFieldComponents[fields[f]]; ++c) { 19749566063dSJacob Faibussowitsch PetscCall(PetscSectionGetComponentName(s, fields[f], c, &name)); 19759566063dSJacob Faibussowitsch PetscCall(PetscSectionSetComponentName(*subs, f, c, name)); 1976b778fa18SValeria Barra } 197742a52479SJed Brown PetscCall(PetscSectionGetFieldSym(s, fields[f], &sym)); 197842a52479SJed Brown PetscCall(PetscSectionSetFieldSym(*subs, f, sym)); 1979ea844a1aSMatthew Knepley } 19809566063dSJacob Faibussowitsch PetscCall(PetscSectionGetChart(s, &pStart, &pEnd)); 19819566063dSJacob Faibussowitsch PetscCall(PetscSectionSetChart(*subs, pStart, pEnd)); 1982ea844a1aSMatthew Knepley for (p = pStart; p < pEnd; ++p) { 1983ea844a1aSMatthew Knepley PetscInt dof = 0, cdof = 0, fdof = 0, cfdof = 0; 1984ea844a1aSMatthew Knepley 1985ea844a1aSMatthew Knepley for (f = 0; f < len; ++f) { 19869566063dSJacob Faibussowitsch PetscCall(PetscSectionGetFieldDof(s, p, fields[f], &fdof)); 19879566063dSJacob Faibussowitsch PetscCall(PetscSectionSetFieldDof(*subs, p, f, fdof)); 19889566063dSJacob Faibussowitsch PetscCall(PetscSectionGetFieldConstraintDof(s, p, fields[f], &cfdof)); 19899566063dSJacob Faibussowitsch if (cfdof) PetscCall(PetscSectionSetFieldConstraintDof(*subs, p, f, cfdof)); 1990ea844a1aSMatthew Knepley dof += fdof; 1991ea844a1aSMatthew Knepley cdof += cfdof; 1992ea844a1aSMatthew Knepley } 19939566063dSJacob Faibussowitsch PetscCall(PetscSectionSetDof(*subs, p, dof)); 19949566063dSJacob Faibussowitsch if (cdof) PetscCall(PetscSectionSetConstraintDof(*subs, p, cdof)); 1995ea844a1aSMatthew Knepley maxCdof = PetscMax(cdof, maxCdof); 1996ea844a1aSMatthew Knepley } 19979566063dSJacob Faibussowitsch PetscCall(PetscSectionSetUp(*subs)); 1998ea844a1aSMatthew Knepley if (maxCdof) { 1999ea844a1aSMatthew Knepley PetscInt *indices; 2000ea844a1aSMatthew Knepley 20019566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(maxCdof, &indices)); 2002ea844a1aSMatthew Knepley for (p = pStart; p < pEnd; ++p) { 2003ea844a1aSMatthew Knepley PetscInt cdof; 2004ea844a1aSMatthew Knepley 20059566063dSJacob Faibussowitsch PetscCall(PetscSectionGetConstraintDof(*subs, p, &cdof)); 2006ea844a1aSMatthew Knepley if (cdof) { 2007ea844a1aSMatthew Knepley const PetscInt *oldIndices = NULL; 2008ea844a1aSMatthew Knepley PetscInt fdof = 0, cfdof = 0, fc, numConst = 0, fOff = 0; 2009ea844a1aSMatthew Knepley 2010ea844a1aSMatthew Knepley for (f = 0; f < len; ++f) { 20119566063dSJacob Faibussowitsch PetscCall(PetscSectionGetFieldDof(s, p, fields[f], &fdof)); 20129566063dSJacob Faibussowitsch PetscCall(PetscSectionGetFieldConstraintDof(s, p, fields[f], &cfdof)); 20139566063dSJacob Faibussowitsch PetscCall(PetscSectionGetFieldConstraintIndices(s, p, fields[f], &oldIndices)); 20149566063dSJacob Faibussowitsch PetscCall(PetscSectionSetFieldConstraintIndices(*subs, p, f, oldIndices)); 20159574d0f0SMatthew G. Knepley for (fc = 0; fc < cfdof; ++fc) indices[numConst + fc] = oldIndices[fc] + fOff; 2016ea844a1aSMatthew Knepley numConst += cfdof; 2017ea844a1aSMatthew Knepley fOff += fdof; 2018ea844a1aSMatthew Knepley } 20199566063dSJacob Faibussowitsch PetscCall(PetscSectionSetConstraintIndices(*subs, p, indices)); 2020ea844a1aSMatthew Knepley } 2021ea844a1aSMatthew Knepley } 20229566063dSJacob Faibussowitsch PetscCall(PetscFree(indices)); 2023ea844a1aSMatthew Knepley } 20243ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2025ea844a1aSMatthew Knepley } 2026ea844a1aSMatthew Knepley 2027ea844a1aSMatthew Knepley /*@ 2028583308b6SBarry Smith PetscSectionCreateSupersection - Create a new, larger section composed of multiple `PetscSection`s 2029ea844a1aSMatthew Knepley 203040750d41SVaclav Hapla Collective 2031ea844a1aSMatthew Knepley 2032ea844a1aSMatthew Knepley Input Parameters: 2033ea844a1aSMatthew Knepley + s - the input sections 2034ea844a1aSMatthew Knepley - len - the number of input sections 2035ea844a1aSMatthew Knepley 2036ea844a1aSMatthew Knepley Output Parameter: 2037ea844a1aSMatthew Knepley . supers - the supersection 2038ea844a1aSMatthew Knepley 2039ea844a1aSMatthew Knepley Level: advanced 2040ea844a1aSMatthew Knepley 2041583308b6SBarry Smith Notes: 2042cab54364SBarry Smith The section offsets now refer to a new, larger vector. 2043cab54364SBarry Smith 204438b5cf2dSJacob Faibussowitsch Developer Notes: 2045cab54364SBarry Smith Needs to explain how the sections are composed 2046cab54364SBarry Smith 2047cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionCreateSubsection()`, `PetscSectionCreate()` 2048ea844a1aSMatthew Knepley @*/ 2049d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionCreateSupersection(PetscSection s[], PetscInt len, PetscSection *supers) 2050d71ae5a4SJacob Faibussowitsch { 2051ea844a1aSMatthew Knepley PetscInt Nf = 0, f, pStart = PETSC_MAX_INT, pEnd = 0, p, maxCdof = 0, i; 2052ea844a1aSMatthew Knepley 2053ea844a1aSMatthew Knepley PetscFunctionBegin; 20543ba16761SJacob Faibussowitsch if (!len) PetscFunctionReturn(PETSC_SUCCESS); 2055ea844a1aSMatthew Knepley for (i = 0; i < len; ++i) { 2056ea844a1aSMatthew Knepley PetscInt nf, pStarti, pEndi; 2057ea844a1aSMatthew Knepley 20589566063dSJacob Faibussowitsch PetscCall(PetscSectionGetNumFields(s[i], &nf)); 20599566063dSJacob Faibussowitsch PetscCall(PetscSectionGetChart(s[i], &pStarti, &pEndi)); 2060ea844a1aSMatthew Knepley pStart = PetscMin(pStart, pStarti); 2061ea844a1aSMatthew Knepley pEnd = PetscMax(pEnd, pEndi); 2062ea844a1aSMatthew Knepley Nf += nf; 2063ea844a1aSMatthew Knepley } 20649566063dSJacob Faibussowitsch PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject)s[0]), supers)); 20659566063dSJacob Faibussowitsch PetscCall(PetscSectionSetNumFields(*supers, Nf)); 2066ea844a1aSMatthew Knepley for (i = 0, f = 0; i < len; ++i) { 2067b778fa18SValeria Barra PetscInt nf, fi, ci; 2068ea844a1aSMatthew Knepley 20699566063dSJacob Faibussowitsch PetscCall(PetscSectionGetNumFields(s[i], &nf)); 2070ea844a1aSMatthew Knepley for (fi = 0; fi < nf; ++fi, ++f) { 2071ea844a1aSMatthew Knepley const char *name = NULL; 2072ea844a1aSMatthew Knepley PetscInt numComp = 0; 2073ea844a1aSMatthew Knepley 20749566063dSJacob Faibussowitsch PetscCall(PetscSectionGetFieldName(s[i], fi, &name)); 20759566063dSJacob Faibussowitsch PetscCall(PetscSectionSetFieldName(*supers, f, name)); 20769566063dSJacob Faibussowitsch PetscCall(PetscSectionGetFieldComponents(s[i], fi, &numComp)); 20779566063dSJacob Faibussowitsch PetscCall(PetscSectionSetFieldComponents(*supers, f, numComp)); 2078b778fa18SValeria Barra for (ci = 0; ci < s[i]->numFieldComponents[fi]; ++ci) { 20799566063dSJacob Faibussowitsch PetscCall(PetscSectionGetComponentName(s[i], fi, ci, &name)); 20809566063dSJacob Faibussowitsch PetscCall(PetscSectionSetComponentName(*supers, f, ci, name)); 2081b778fa18SValeria Barra } 2082ea844a1aSMatthew Knepley } 2083ea844a1aSMatthew Knepley } 20849566063dSJacob Faibussowitsch PetscCall(PetscSectionSetChart(*supers, pStart, pEnd)); 2085ea844a1aSMatthew Knepley for (p = pStart; p < pEnd; ++p) { 2086ea844a1aSMatthew Knepley PetscInt dof = 0, cdof = 0; 2087ea844a1aSMatthew Knepley 2088ea844a1aSMatthew Knepley for (i = 0, f = 0; i < len; ++i) { 2089ea844a1aSMatthew Knepley PetscInt nf, fi, pStarti, pEndi; 2090ea844a1aSMatthew Knepley PetscInt fdof = 0, cfdof = 0; 2091ea844a1aSMatthew Knepley 20929566063dSJacob Faibussowitsch PetscCall(PetscSectionGetNumFields(s[i], &nf)); 20939566063dSJacob Faibussowitsch PetscCall(PetscSectionGetChart(s[i], &pStarti, &pEndi)); 2094ea844a1aSMatthew Knepley if ((p < pStarti) || (p >= pEndi)) continue; 2095ea844a1aSMatthew Knepley for (fi = 0; fi < nf; ++fi, ++f) { 20969566063dSJacob Faibussowitsch PetscCall(PetscSectionGetFieldDof(s[i], p, fi, &fdof)); 20979566063dSJacob Faibussowitsch PetscCall(PetscSectionAddFieldDof(*supers, p, f, fdof)); 20989566063dSJacob Faibussowitsch PetscCall(PetscSectionGetFieldConstraintDof(s[i], p, fi, &cfdof)); 20999566063dSJacob Faibussowitsch if (cfdof) PetscCall(PetscSectionAddFieldConstraintDof(*supers, p, f, cfdof)); 2100ea844a1aSMatthew Knepley dof += fdof; 2101ea844a1aSMatthew Knepley cdof += cfdof; 2102ea844a1aSMatthew Knepley } 2103ea844a1aSMatthew Knepley } 21049566063dSJacob Faibussowitsch PetscCall(PetscSectionSetDof(*supers, p, dof)); 21059566063dSJacob Faibussowitsch if (cdof) PetscCall(PetscSectionSetConstraintDof(*supers, p, cdof)); 2106ea844a1aSMatthew Knepley maxCdof = PetscMax(cdof, maxCdof); 2107ea844a1aSMatthew Knepley } 21089566063dSJacob Faibussowitsch PetscCall(PetscSectionSetUp(*supers)); 2109ea844a1aSMatthew Knepley if (maxCdof) { 2110ea844a1aSMatthew Knepley PetscInt *indices; 2111ea844a1aSMatthew Knepley 21129566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(maxCdof, &indices)); 2113ea844a1aSMatthew Knepley for (p = pStart; p < pEnd; ++p) { 2114ea844a1aSMatthew Knepley PetscInt cdof; 2115ea844a1aSMatthew Knepley 21169566063dSJacob Faibussowitsch PetscCall(PetscSectionGetConstraintDof(*supers, p, &cdof)); 2117ea844a1aSMatthew Knepley if (cdof) { 2118ea844a1aSMatthew Knepley PetscInt dof, numConst = 0, fOff = 0; 2119ea844a1aSMatthew Knepley 2120ea844a1aSMatthew Knepley for (i = 0, f = 0; i < len; ++i) { 2121ea844a1aSMatthew Knepley const PetscInt *oldIndices = NULL; 2122ea844a1aSMatthew Knepley PetscInt nf, fi, pStarti, pEndi, fdof, cfdof, fc; 2123ea844a1aSMatthew Knepley 21249566063dSJacob Faibussowitsch PetscCall(PetscSectionGetNumFields(s[i], &nf)); 21259566063dSJacob Faibussowitsch PetscCall(PetscSectionGetChart(s[i], &pStarti, &pEndi)); 2126ea844a1aSMatthew Knepley if ((p < pStarti) || (p >= pEndi)) continue; 2127ea844a1aSMatthew Knepley for (fi = 0; fi < nf; ++fi, ++f) { 21289566063dSJacob Faibussowitsch PetscCall(PetscSectionGetFieldDof(s[i], p, fi, &fdof)); 21299566063dSJacob Faibussowitsch PetscCall(PetscSectionGetFieldConstraintDof(s[i], p, fi, &cfdof)); 21309566063dSJacob Faibussowitsch PetscCall(PetscSectionGetFieldConstraintIndices(s[i], p, fi, &oldIndices)); 2131fcd2503dSMatthew G. Knepley for (fc = 0; fc < cfdof; ++fc) indices[numConst + fc] = oldIndices[fc]; 21329566063dSJacob Faibussowitsch PetscCall(PetscSectionSetFieldConstraintIndices(*supers, p, f, &indices[numConst])); 2133fcd2503dSMatthew G. Knepley for (fc = 0; fc < cfdof; ++fc) indices[numConst + fc] += fOff; 2134ea844a1aSMatthew Knepley numConst += cfdof; 2135ea844a1aSMatthew Knepley } 21369566063dSJacob Faibussowitsch PetscCall(PetscSectionGetDof(s[i], p, &dof)); 2137ea844a1aSMatthew Knepley fOff += dof; 2138ea844a1aSMatthew Knepley } 21399566063dSJacob Faibussowitsch PetscCall(PetscSectionSetConstraintIndices(*supers, p, indices)); 2140ea844a1aSMatthew Knepley } 2141ea844a1aSMatthew Knepley } 21429566063dSJacob Faibussowitsch PetscCall(PetscFree(indices)); 2143ea844a1aSMatthew Knepley } 21443ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2145ea844a1aSMatthew Knepley } 2146ea844a1aSMatthew Knepley 2147da8c939bSJacob Faibussowitsch static PetscErrorCode PetscSectionCreateSubplexSection_Private(PetscSection s, IS subpointMap, PetscBool renumberPoints, PetscSection *subs) 2148d71ae5a4SJacob Faibussowitsch { 2149ea844a1aSMatthew Knepley const PetscInt *points = NULL, *indices = NULL; 215041f23ed0SMatthew G. Knepley PetscInt numFields, f, c, numSubpoints = 0, pStart, pEnd, p, spStart, spEnd, subp; 2151ea844a1aSMatthew Knepley 2152ea844a1aSMatthew Knepley PetscFunctionBegin; 2153ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 2154ea844a1aSMatthew Knepley PetscValidHeaderSpecific(subpointMap, IS_CLASSID, 2); 21554f572ea9SToby Isaac PetscAssertPointer(subs, 4); 21569566063dSJacob Faibussowitsch PetscCall(PetscSectionGetNumFields(s, &numFields)); 21579566063dSJacob Faibussowitsch PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject)s), subs)); 21589566063dSJacob Faibussowitsch if (numFields) PetscCall(PetscSectionSetNumFields(*subs, numFields)); 2159ea844a1aSMatthew Knepley for (f = 0; f < numFields; ++f) { 2160ea844a1aSMatthew Knepley const char *name = NULL; 2161ea844a1aSMatthew Knepley PetscInt numComp = 0; 2162ea844a1aSMatthew Knepley 21639566063dSJacob Faibussowitsch PetscCall(PetscSectionGetFieldName(s, f, &name)); 21649566063dSJacob Faibussowitsch PetscCall(PetscSectionSetFieldName(*subs, f, name)); 21659566063dSJacob Faibussowitsch PetscCall(PetscSectionGetFieldComponents(s, f, &numComp)); 21669566063dSJacob Faibussowitsch PetscCall(PetscSectionSetFieldComponents(*subs, f, numComp)); 2167b778fa18SValeria Barra for (c = 0; c < s->numFieldComponents[f]; ++c) { 21689566063dSJacob Faibussowitsch PetscCall(PetscSectionGetComponentName(s, f, c, &name)); 21699566063dSJacob Faibussowitsch PetscCall(PetscSectionSetComponentName(*subs, f, c, name)); 2170b778fa18SValeria Barra } 2171ea844a1aSMatthew Knepley } 2172ea844a1aSMatthew Knepley /* For right now, we do not try to squeeze the subchart */ 2173ea844a1aSMatthew Knepley if (subpointMap) { 21749566063dSJacob Faibussowitsch PetscCall(ISGetSize(subpointMap, &numSubpoints)); 21759566063dSJacob Faibussowitsch PetscCall(ISGetIndices(subpointMap, &points)); 2176ea844a1aSMatthew Knepley } 21779566063dSJacob Faibussowitsch PetscCall(PetscSectionGetChart(s, &pStart, &pEnd)); 217841f23ed0SMatthew G. Knepley if (renumberPoints) { 217941f23ed0SMatthew G. Knepley spStart = 0; 218041f23ed0SMatthew G. Knepley spEnd = numSubpoints; 218141f23ed0SMatthew G. Knepley } else { 218241f23ed0SMatthew G. Knepley PetscCall(ISGetMinMax(subpointMap, &spStart, &spEnd)); 218341f23ed0SMatthew G. Knepley ++spEnd; 218441f23ed0SMatthew G. Knepley } 218541f23ed0SMatthew G. Knepley PetscCall(PetscSectionSetChart(*subs, spStart, spEnd)); 2186ea844a1aSMatthew Knepley for (p = pStart; p < pEnd; ++p) { 2187ea844a1aSMatthew Knepley PetscInt dof, cdof, fdof = 0, cfdof = 0; 2188ea844a1aSMatthew Knepley 21899566063dSJacob Faibussowitsch PetscCall(PetscFindInt(p, numSubpoints, points, &subp)); 2190ea844a1aSMatthew Knepley if (subp < 0) continue; 219141f23ed0SMatthew G. Knepley if (!renumberPoints) subp = p; 2192ea844a1aSMatthew Knepley for (f = 0; f < numFields; ++f) { 21939566063dSJacob Faibussowitsch PetscCall(PetscSectionGetFieldDof(s, p, f, &fdof)); 21949566063dSJacob Faibussowitsch PetscCall(PetscSectionSetFieldDof(*subs, subp, f, fdof)); 21959566063dSJacob Faibussowitsch PetscCall(PetscSectionGetFieldConstraintDof(s, p, f, &cfdof)); 21969566063dSJacob Faibussowitsch if (cfdof) PetscCall(PetscSectionSetFieldConstraintDof(*subs, subp, f, cfdof)); 2197ea844a1aSMatthew Knepley } 21989566063dSJacob Faibussowitsch PetscCall(PetscSectionGetDof(s, p, &dof)); 21999566063dSJacob Faibussowitsch PetscCall(PetscSectionSetDof(*subs, subp, dof)); 22009566063dSJacob Faibussowitsch PetscCall(PetscSectionGetConstraintDof(s, p, &cdof)); 22019566063dSJacob Faibussowitsch if (cdof) PetscCall(PetscSectionSetConstraintDof(*subs, subp, cdof)); 2202ea844a1aSMatthew Knepley } 22039566063dSJacob Faibussowitsch PetscCall(PetscSectionSetUp(*subs)); 2204ea844a1aSMatthew Knepley /* Change offsets to original offsets */ 2205ea844a1aSMatthew Knepley for (p = pStart; p < pEnd; ++p) { 2206ea844a1aSMatthew Knepley PetscInt off, foff = 0; 2207ea844a1aSMatthew Knepley 22089566063dSJacob Faibussowitsch PetscCall(PetscFindInt(p, numSubpoints, points, &subp)); 2209ea844a1aSMatthew Knepley if (subp < 0) continue; 221041f23ed0SMatthew G. Knepley if (!renumberPoints) subp = p; 2211ea844a1aSMatthew Knepley for (f = 0; f < numFields; ++f) { 22129566063dSJacob Faibussowitsch PetscCall(PetscSectionGetFieldOffset(s, p, f, &foff)); 22139566063dSJacob Faibussowitsch PetscCall(PetscSectionSetFieldOffset(*subs, subp, f, foff)); 2214ea844a1aSMatthew Knepley } 22159566063dSJacob Faibussowitsch PetscCall(PetscSectionGetOffset(s, p, &off)); 22169566063dSJacob Faibussowitsch PetscCall(PetscSectionSetOffset(*subs, subp, off)); 2217ea844a1aSMatthew Knepley } 2218ea844a1aSMatthew Knepley /* Copy constraint indices */ 221941f23ed0SMatthew G. Knepley for (subp = spStart; subp < spEnd; ++subp) { 2220ea844a1aSMatthew Knepley PetscInt cdof; 2221ea844a1aSMatthew Knepley 22229566063dSJacob Faibussowitsch PetscCall(PetscSectionGetConstraintDof(*subs, subp, &cdof)); 2223ea844a1aSMatthew Knepley if (cdof) { 2224ea844a1aSMatthew Knepley for (f = 0; f < numFields; ++f) { 222541f23ed0SMatthew G. Knepley PetscCall(PetscSectionGetFieldConstraintIndices(s, points[subp - spStart], f, &indices)); 22269566063dSJacob Faibussowitsch PetscCall(PetscSectionSetFieldConstraintIndices(*subs, subp, f, indices)); 2227ea844a1aSMatthew Knepley } 222841f23ed0SMatthew G. Knepley PetscCall(PetscSectionGetConstraintIndices(s, points[subp - spStart], &indices)); 22299566063dSJacob Faibussowitsch PetscCall(PetscSectionSetConstraintIndices(*subs, subp, indices)); 2230ea844a1aSMatthew Knepley } 2231ea844a1aSMatthew Knepley } 22329566063dSJacob Faibussowitsch if (subpointMap) PetscCall(ISRestoreIndices(subpointMap, &points)); 22333ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2234ea844a1aSMatthew Knepley } 2235ea844a1aSMatthew Knepley 223641f23ed0SMatthew G. Knepley /*@ 223741f23ed0SMatthew G. Knepley PetscSectionCreateSubmeshSection - Create a new, smaller section with support on the submesh 223841f23ed0SMatthew G. Knepley 2239c3339decSBarry Smith Collective 224041f23ed0SMatthew G. Knepley 224141f23ed0SMatthew G. Knepley Input Parameters: 2242cab54364SBarry Smith + s - the `PetscSection` 224341f23ed0SMatthew G. Knepley - subpointMap - a sorted list of points in the original mesh which are in the submesh 224441f23ed0SMatthew G. Knepley 224541f23ed0SMatthew G. Knepley Output Parameter: 224641f23ed0SMatthew G. Knepley . subs - the subsection 224741f23ed0SMatthew G. Knepley 2248cab54364SBarry Smith Level: advanced 2249cab54364SBarry Smith 2250583308b6SBarry Smith Notes: 2251583308b6SBarry Smith The points are renumbered from 0, and the section offsets now refer to a new, smaller vector. That is the chart of `subs` is `[0,sizeof(subpointmap))` 2252583308b6SBarry Smith 225320662ed9SBarry Smith Compare this with `PetscSectionCreateSubdomainSection()` that does not map the points numbers to start at zero but leaves them as before 225441f23ed0SMatthew G. Knepley 225538b5cf2dSJacob Faibussowitsch Developer Notes: 225620662ed9SBarry Smith The use of the term Submesh is confusing and needs clarification, it is not specific to meshes. It appears to be just a subset of the chart of the original `PetscSection` 225741f23ed0SMatthew G. Knepley 2258cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionCreateSubdomainSection()`, `PetscSectionCreateSubsection()`, `DMPlexGetSubpointMap()`, `PetscSectionCreate()` 225941f23ed0SMatthew G. Knepley @*/ 2260d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionCreateSubmeshSection(PetscSection s, IS subpointMap, PetscSection *subs) 2261d71ae5a4SJacob Faibussowitsch { 226241f23ed0SMatthew G. Knepley PetscFunctionBegin; 2263da8c939bSJacob Faibussowitsch PetscCall(PetscSectionCreateSubplexSection_Private(s, subpointMap, PETSC_TRUE, subs)); 22643ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 226541f23ed0SMatthew G. Knepley } 226641f23ed0SMatthew G. Knepley 226741f23ed0SMatthew G. Knepley /*@ 226841f23ed0SMatthew G. Knepley PetscSectionCreateSubdomainSection - Create a new, smaller section with support on a subdomain of the mesh 226941f23ed0SMatthew G. Knepley 2270c3339decSBarry Smith Collective 227141f23ed0SMatthew G. Knepley 227241f23ed0SMatthew G. Knepley Input Parameters: 2273cab54364SBarry Smith + s - the `PetscSection` 227441f23ed0SMatthew G. Knepley - subpointMap - a sorted list of points in the original mesh which are in the subdomain 227541f23ed0SMatthew G. Knepley 227641f23ed0SMatthew G. Knepley Output Parameter: 227741f23ed0SMatthew G. Knepley . subs - the subsection 227841f23ed0SMatthew G. Knepley 2279cab54364SBarry Smith Level: advanced 2280cab54364SBarry Smith 2281583308b6SBarry Smith Notes: 2282583308b6SBarry Smith The point numbers remain the same as in the larger `PetscSection`, but the section offsets now refer to a new, smaller vector. The chart of `subs` 2283583308b6SBarry Smith is `[min(subpointMap),max(subpointMap)+1)` 2284583308b6SBarry Smith 228520662ed9SBarry Smith Compare this with `PetscSectionCreateSubmeshSection()` that maps the point numbers to start at zero 228641f23ed0SMatthew G. Knepley 2287cab54364SBarry Smith Developer Notes: 228820662ed9SBarry Smith The use of the term Subdomain is unneeded and needs clarification, it is not specific to meshes. It appears to be just a subset of the chart of the original `PetscSection` 2289cab54364SBarry Smith 2290cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionCreateSubmeshSection()`, `PetscSectionCreateSubsection()`, `DMPlexGetSubpointMap()`, `PetscSectionCreate()` 229141f23ed0SMatthew G. Knepley @*/ 2292d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionCreateSubdomainSection(PetscSection s, IS subpointMap, PetscSection *subs) 2293d71ae5a4SJacob Faibussowitsch { 229441f23ed0SMatthew G. Knepley PetscFunctionBegin; 2295da8c939bSJacob Faibussowitsch PetscCall(PetscSectionCreateSubplexSection_Private(s, subpointMap, PETSC_FALSE, subs)); 22963ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 229741f23ed0SMatthew G. Knepley } 229841f23ed0SMatthew G. Knepley 2299d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscSectionView_ASCII(PetscSection s, PetscViewer viewer) 2300d71ae5a4SJacob Faibussowitsch { 2301ea844a1aSMatthew Knepley PetscInt p; 2302ea844a1aSMatthew Knepley PetscMPIInt rank; 2303ea844a1aSMatthew Knepley 2304ea844a1aSMatthew Knepley PetscFunctionBegin; 23059566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_rank(PetscObjectComm((PetscObject)viewer), &rank)); 23069566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPushSynchronized(viewer)); 23079566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "Process %d:\n", rank)); 2308ea844a1aSMatthew Knepley for (p = 0; p < s->pEnd - s->pStart; ++p) { 23093857f682SStefano Zampini if (s->bc && s->bc->atlasDof[p] > 0) { 2310ea844a1aSMatthew Knepley PetscInt b; 23119566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, " (%4" PetscInt_FMT ") dim %2" PetscInt_FMT " offset %3" PetscInt_FMT " constrained", p + s->pStart, s->atlasDof[p], s->atlasOff[p])); 2312083401c6SMatthew G. Knepley if (s->bcIndices) { 231348a46eb9SPierre Jolivet for (b = 0; b < s->bc->atlasDof[p]; ++b) PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, " %" PetscInt_FMT, s->bcIndices[s->bc->atlasOff[p] + b])); 2314083401c6SMatthew G. Knepley } 23159566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "\n")); 2316ea844a1aSMatthew Knepley } else { 23179566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, " (%4" PetscInt_FMT ") dim %2" PetscInt_FMT " offset %3" PetscInt_FMT "\n", p + s->pStart, s->atlasDof[p], s->atlasOff[p])); 2318ea844a1aSMatthew Knepley } 2319ea844a1aSMatthew Knepley } 23209566063dSJacob Faibussowitsch PetscCall(PetscViewerFlush(viewer)); 23219566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPopSynchronized(viewer)); 2322ea844a1aSMatthew Knepley if (s->sym) { 23239566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPushTab(viewer)); 23249566063dSJacob Faibussowitsch PetscCall(PetscSectionSymView(s->sym, viewer)); 23259566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPopTab(viewer)); 2326ea844a1aSMatthew Knepley } 23273ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2328ea844a1aSMatthew Knepley } 2329ea844a1aSMatthew Knepley 2330ea844a1aSMatthew Knepley /*@C 2331cab54364SBarry Smith PetscSectionViewFromOptions - View the `PetscSection` based on values in the options database 2332fe2efc57SMark 233340750d41SVaclav Hapla Collective 2334fe2efc57SMark 2335fe2efc57SMark Input Parameters: 233620662ed9SBarry Smith + A - the `PetscSection` object to view 2337cab54364SBarry Smith . obj - Optional object that provides the options prefix used for the options 2338736c3998SJose E. Roman - name - command line option 2339fe2efc57SMark 2340fe2efc57SMark Level: intermediate 2341cab54364SBarry Smith 234220662ed9SBarry Smith Note: 234320662ed9SBarry Smith See `PetscObjectViewFromOptions()` for available values of `PetscViewer` and `PetscViewerFormat` 234420662ed9SBarry Smith 2345cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionView`, `PetscObjectViewFromOptions()`, `PetscSectionCreate()`, `PetscSectionView()` 2346fe2efc57SMark @*/ 2347d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionViewFromOptions(PetscSection A, PetscObject obj, const char name[]) 2348d71ae5a4SJacob Faibussowitsch { 2349fe2efc57SMark PetscFunctionBegin; 2350fe2efc57SMark PetscValidHeaderSpecific(A, PETSC_SECTION_CLASSID, 1); 23519566063dSJacob Faibussowitsch PetscCall(PetscObjectViewFromOptions((PetscObject)A, obj, name)); 23523ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2353fe2efc57SMark } 2354fe2efc57SMark 2355fe2efc57SMark /*@C 2356cab54364SBarry Smith PetscSectionView - Views a `PetscSection` 2357ea844a1aSMatthew Knepley 235840750d41SVaclav Hapla Collective 2359ea844a1aSMatthew Knepley 2360ea844a1aSMatthew Knepley Input Parameters: 2361cab54364SBarry Smith + s - the `PetscSection` object to view 236238b5cf2dSJacob Faibussowitsch - viewer - the viewer 2363ea844a1aSMatthew Knepley 2364cab54364SBarry Smith Level: beginner 2365cab54364SBarry Smith 23661ddd528eSksagiyam Note: 2367cab54364SBarry Smith `PetscSectionView()`, when viewer is of type `PETSCVIEWERHDF5`, only saves 23681ddd528eSksagiyam distribution independent data, such as dofs, offsets, constraint dofs, 23691ddd528eSksagiyam and constraint indices. Points that have negative dofs, for instance, 23701ddd528eSksagiyam are not saved as they represent points owned by other processes. 23711ddd528eSksagiyam Point numbering and rank assignment is currently not stored. 2372cab54364SBarry Smith The saved section can be loaded with `PetscSectionLoad()`. 23731ddd528eSksagiyam 2374cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionCreate()`, `PetscSectionDestroy()`, `PetscSectionLoad()`, `PetscViewer` 2375ea844a1aSMatthew Knepley @*/ 2376d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionView(PetscSection s, PetscViewer viewer) 2377d71ae5a4SJacob Faibussowitsch { 23781ddd528eSksagiyam PetscBool isascii, ishdf5; 2379ea844a1aSMatthew Knepley PetscInt f; 2380ea844a1aSMatthew Knepley 2381ea844a1aSMatthew Knepley PetscFunctionBegin; 2382ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 23839566063dSJacob Faibussowitsch if (!viewer) PetscCall(PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)s), &viewer)); 2384ea844a1aSMatthew Knepley PetscValidHeaderSpecific(viewer, PETSC_VIEWER_CLASSID, 2); 23859566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &isascii)); 23869566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERHDF5, &ishdf5)); 2387ea844a1aSMatthew Knepley if (isascii) { 23889566063dSJacob Faibussowitsch PetscCall(PetscObjectPrintClassNamePrefixType((PetscObject)s, viewer)); 2389ea844a1aSMatthew Knepley if (s->numFields) { 23909566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "%" PetscInt_FMT " fields\n", s->numFields)); 2391ea844a1aSMatthew Knepley for (f = 0; f < s->numFields; ++f) { 23929566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " field %" PetscInt_FMT " with %" PetscInt_FMT " components\n", f, s->numFieldComponents[f])); 23939566063dSJacob Faibussowitsch PetscCall(PetscSectionView_ASCII(s->field[f], viewer)); 2394ea844a1aSMatthew Knepley } 2395ea844a1aSMatthew Knepley } else { 23969566063dSJacob Faibussowitsch PetscCall(PetscSectionView_ASCII(s, viewer)); 2397ea844a1aSMatthew Knepley } 23981ddd528eSksagiyam } else if (ishdf5) { 23991ddd528eSksagiyam #if PetscDefined(HAVE_HDF5) 24009566063dSJacob Faibussowitsch PetscCall(PetscSectionView_HDF5_Internal(s, viewer)); 24011ddd528eSksagiyam #else 24021ddd528eSksagiyam SETERRQ(PetscObjectComm((PetscObject)s), PETSC_ERR_SUP, "HDF5 not supported in this build.\nPlease reconfigure using --download-hdf5"); 24031ddd528eSksagiyam #endif 2404ea844a1aSMatthew Knepley } 24053ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2406ea844a1aSMatthew Knepley } 2407ea844a1aSMatthew Knepley 2408fde5e3acSksagiyam /*@C 2409cab54364SBarry Smith PetscSectionLoad - Loads a `PetscSection` 2410fde5e3acSksagiyam 241140750d41SVaclav Hapla Collective 2412fde5e3acSksagiyam 2413fde5e3acSksagiyam Input Parameters: 2414cab54364SBarry Smith + s - the `PetscSection` object to load 241538b5cf2dSJacob Faibussowitsch - viewer - the viewer 2416fde5e3acSksagiyam 2417cab54364SBarry Smith Level: beginner 2418cab54364SBarry Smith 2419fde5e3acSksagiyam Note: 2420cab54364SBarry Smith `PetscSectionLoad()`, when viewer is of type `PETSCVIEWERHDF5`, loads 2421cab54364SBarry Smith a section saved with `PetscSectionView()`. The number of processes 2422fde5e3acSksagiyam used here (N) does not need to be the same as that used when saving. 2423fde5e3acSksagiyam After calling this function, the chart of s on rank i will be set 2424fde5e3acSksagiyam to [0, E_i), where \sum_{i=0}^{N-1}E_i equals to the total number of 2425fde5e3acSksagiyam saved section points. 2426fde5e3acSksagiyam 2427cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionCreate()`, `PetscSectionDestroy()`, `PetscSectionView()` 2428fde5e3acSksagiyam @*/ 2429d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionLoad(PetscSection s, PetscViewer viewer) 2430d71ae5a4SJacob Faibussowitsch { 2431fde5e3acSksagiyam PetscBool ishdf5; 2432fde5e3acSksagiyam 2433fde5e3acSksagiyam PetscFunctionBegin; 2434fde5e3acSksagiyam PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 2435fde5e3acSksagiyam PetscValidHeaderSpecific(viewer, PETSC_VIEWER_CLASSID, 2); 24369566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERHDF5, &ishdf5)); 2437fde5e3acSksagiyam if (ishdf5) { 2438fde5e3acSksagiyam #if PetscDefined(HAVE_HDF5) 24399566063dSJacob Faibussowitsch PetscCall(PetscSectionLoad_HDF5_Internal(s, viewer)); 24403ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2441fde5e3acSksagiyam #else 2442fde5e3acSksagiyam SETERRQ(PetscObjectComm((PetscObject)s), PETSC_ERR_SUP, "HDF5 not supported in this build.\nPlease reconfigure using --download-hdf5"); 2443fde5e3acSksagiyam #endif 244498921bdaSJacob Faibussowitsch } else SETERRQ(PetscObjectComm((PetscObject)s), PETSC_ERR_SUP, "Viewer type %s not yet supported for PetscSection loading", ((PetscObject)viewer)->type_name); 2445fde5e3acSksagiyam } 2446fde5e3acSksagiyam 2447d4a1ad33SMatthew G. Knepley /*@ 2448d4a1ad33SMatthew G. Knepley PetscSectionResetClosurePermutation - Remove any existing closure permutation 2449d4a1ad33SMatthew G. Knepley 2450d4a1ad33SMatthew G. Knepley Input Parameter: 2451e8e188d2SZach Atkins . section - The `PetscSection` 2452d4a1ad33SMatthew G. Knepley 2453d4a1ad33SMatthew G. Knepley Level: intermediate 2454d4a1ad33SMatthew G. Knepley 2455e8e188d2SZach Atkins .seealso: `PetscSectionSetClosurePermutation()`, `PetscSectionSetClosureIndex()`, `PetscSectionReset()` 2456d4a1ad33SMatthew G. Knepley @*/ 2457d4a1ad33SMatthew G. Knepley PetscErrorCode PetscSectionResetClosurePermutation(PetscSection section) 2458d71ae5a4SJacob Faibussowitsch { 2459c459fbc1SJed Brown PetscSectionClosurePermVal clVal; 2460c459fbc1SJed Brown 2461c459fbc1SJed Brown PetscFunctionBegin; 24623ba16761SJacob Faibussowitsch if (!section->clHash) PetscFunctionReturn(PETSC_SUCCESS); 2463c459fbc1SJed Brown kh_foreach_value(section->clHash, clVal, { 24649566063dSJacob Faibussowitsch PetscCall(PetscFree(clVal.perm)); 24659566063dSJacob Faibussowitsch PetscCall(PetscFree(clVal.invPerm)); 2466c459fbc1SJed Brown }); 2467c459fbc1SJed Brown kh_destroy(ClPerm, section->clHash); 2468c459fbc1SJed Brown section->clHash = NULL; 24693ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2470c459fbc1SJed Brown } 2471c459fbc1SJed Brown 2472ea844a1aSMatthew Knepley /*@ 2473583308b6SBarry Smith PetscSectionReset - Frees all section data, the section is then as if `PetscSectionCreate()` had just been called. 2474ea844a1aSMatthew Knepley 247540750d41SVaclav Hapla Not Collective 2476ea844a1aSMatthew Knepley 24772fe279fdSBarry Smith Input Parameter: 2478cab54364SBarry Smith . s - the `PetscSection` 2479ea844a1aSMatthew Knepley 2480ea844a1aSMatthew Knepley Level: beginner 2481ea844a1aSMatthew Knepley 2482cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionCreate()` 2483ea844a1aSMatthew Knepley @*/ 2484d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionReset(PetscSection s) 2485d71ae5a4SJacob Faibussowitsch { 2486b778fa18SValeria Barra PetscInt f, c; 2487ea844a1aSMatthew Knepley 2488ea844a1aSMatthew Knepley PetscFunctionBegin; 2489ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 2490ea844a1aSMatthew Knepley for (f = 0; f < s->numFields; ++f) { 24919566063dSJacob Faibussowitsch PetscCall(PetscSectionDestroy(&s->field[f])); 24929566063dSJacob Faibussowitsch PetscCall(PetscFree(s->fieldNames[f])); 249348a46eb9SPierre Jolivet for (c = 0; c < s->numFieldComponents[f]; ++c) PetscCall(PetscFree(s->compNames[f][c])); 24949566063dSJacob Faibussowitsch PetscCall(PetscFree(s->compNames[f])); 2495ea844a1aSMatthew Knepley } 24969566063dSJacob Faibussowitsch PetscCall(PetscFree(s->numFieldComponents)); 24979566063dSJacob Faibussowitsch PetscCall(PetscFree(s->fieldNames)); 24989566063dSJacob Faibussowitsch PetscCall(PetscFree(s->compNames)); 24999566063dSJacob Faibussowitsch PetscCall(PetscFree(s->field)); 25009566063dSJacob Faibussowitsch PetscCall(PetscSectionDestroy(&s->bc)); 25019566063dSJacob Faibussowitsch PetscCall(PetscFree(s->bcIndices)); 25029566063dSJacob Faibussowitsch PetscCall(PetscFree2(s->atlasDof, s->atlasOff)); 25039566063dSJacob Faibussowitsch PetscCall(PetscSectionDestroy(&s->clSection)); 25049566063dSJacob Faibussowitsch PetscCall(ISDestroy(&s->clPoints)); 25059566063dSJacob Faibussowitsch PetscCall(ISDestroy(&s->perm)); 2506d4a1ad33SMatthew G. Knepley PetscCall(PetscSectionResetClosurePermutation(s)); 25079566063dSJacob Faibussowitsch PetscCall(PetscSectionSymDestroy(&s->sym)); 25089566063dSJacob Faibussowitsch PetscCall(PetscSectionDestroy(&s->clSection)); 25099566063dSJacob Faibussowitsch PetscCall(ISDestroy(&s->clPoints)); 251069c11d05SVaclav Hapla PetscCall(PetscSectionInvalidateMaxDof_Internal(s)); 2511ea844a1aSMatthew Knepley s->pStart = -1; 2512ea844a1aSMatthew Knepley s->pEnd = -1; 2513ea844a1aSMatthew Knepley s->maxDof = 0; 2514ea844a1aSMatthew Knepley s->setup = PETSC_FALSE; 2515ea844a1aSMatthew Knepley s->numFields = 0; 2516ea844a1aSMatthew Knepley s->clObj = NULL; 25173ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2518ea844a1aSMatthew Knepley } 2519ea844a1aSMatthew Knepley 2520ea844a1aSMatthew Knepley /*@ 2521583308b6SBarry Smith PetscSectionDestroy - Frees a `PetscSection` 2522ea844a1aSMatthew Knepley 252340750d41SVaclav Hapla Not Collective 2524ea844a1aSMatthew Knepley 25252fe279fdSBarry Smith Input Parameter: 2526cab54364SBarry Smith . s - the `PetscSection` 2527ea844a1aSMatthew Knepley 2528ea844a1aSMatthew Knepley Level: beginner 2529ea844a1aSMatthew Knepley 2530cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionCreate()`, `PetscSectionReset()` 2531ea844a1aSMatthew Knepley @*/ 2532d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionDestroy(PetscSection *s) 2533d71ae5a4SJacob Faibussowitsch { 2534ea844a1aSMatthew Knepley PetscFunctionBegin; 25353ba16761SJacob Faibussowitsch if (!*s) PetscFunctionReturn(PETSC_SUCCESS); 253662f17a49SStefano Zampini PetscValidHeaderSpecific(*s, PETSC_SECTION_CLASSID, 1); 2537ea844a1aSMatthew Knepley if (--((PetscObject)(*s))->refct > 0) { 2538ea844a1aSMatthew Knepley *s = NULL; 25393ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2540ea844a1aSMatthew Knepley } 25419566063dSJacob Faibussowitsch PetscCall(PetscSectionReset(*s)); 25429566063dSJacob Faibussowitsch PetscCall(PetscHeaderDestroy(s)); 25433ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2544ea844a1aSMatthew Knepley } 2545ea844a1aSMatthew Knepley 2546da8c939bSJacob Faibussowitsch static PetscErrorCode VecIntGetValuesSection_Private(const PetscInt *baseArray, PetscSection s, PetscInt point, const PetscInt **values) 2547d71ae5a4SJacob Faibussowitsch { 2548ea844a1aSMatthew Knepley const PetscInt p = point - s->pStart; 2549ea844a1aSMatthew Knepley 2550ea844a1aSMatthew Knepley PetscFunctionBegin; 2551ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 2); 2552ea844a1aSMatthew Knepley *values = &baseArray[s->atlasOff[p]]; 25533ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2554ea844a1aSMatthew Knepley } 2555ea844a1aSMatthew Knepley 2556da8c939bSJacob Faibussowitsch static PetscErrorCode VecIntSetValuesSection_Private(PetscInt *baseArray, PetscSection s, PetscInt point, const PetscInt values[], InsertMode mode) 2557d71ae5a4SJacob Faibussowitsch { 2558ea844a1aSMatthew Knepley PetscInt *array; 2559ea844a1aSMatthew Knepley const PetscInt p = point - s->pStart; 2560ea844a1aSMatthew Knepley const PetscInt orientation = 0; /* Needs to be included for use in closure operations */ 2561ea844a1aSMatthew Knepley PetscInt cDim = 0; 2562ea844a1aSMatthew Knepley 2563ea844a1aSMatthew Knepley PetscFunctionBegin; 2564ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 2); 25659566063dSJacob Faibussowitsch PetscCall(PetscSectionGetConstraintDof(s, p, &cDim)); 2566ea844a1aSMatthew Knepley array = &baseArray[s->atlasOff[p]]; 2567ea844a1aSMatthew Knepley if (!cDim) { 2568ea844a1aSMatthew Knepley if (orientation >= 0) { 2569ea844a1aSMatthew Knepley const PetscInt dim = s->atlasDof[p]; 2570ea844a1aSMatthew Knepley PetscInt i; 2571ea844a1aSMatthew Knepley 2572ea844a1aSMatthew Knepley if (mode == INSERT_VALUES) { 2573ad716f99SStefano Zampini for (i = 0; i < dim; ++i) array[i] = values ? values[i] : i; 2574ea844a1aSMatthew Knepley } else { 2575ea844a1aSMatthew Knepley for (i = 0; i < dim; ++i) array[i] += values[i]; 2576ea844a1aSMatthew Knepley } 2577ea844a1aSMatthew Knepley } else { 2578ea844a1aSMatthew Knepley PetscInt offset = 0; 2579ea844a1aSMatthew Knepley PetscInt j = -1, field, i; 2580ea844a1aSMatthew Knepley 2581ea844a1aSMatthew Knepley for (field = 0; field < s->numFields; ++field) { 2582ea844a1aSMatthew Knepley const PetscInt dim = s->field[field]->atlasDof[p]; 2583ea844a1aSMatthew Knepley 2584ad716f99SStefano Zampini for (i = dim - 1; i >= 0; --i) array[++j] = values ? values[i + offset] : i + offset; 2585ea844a1aSMatthew Knepley offset += dim; 2586ea844a1aSMatthew Knepley } 2587ea844a1aSMatthew Knepley } 2588ea844a1aSMatthew Knepley } else { 2589ea844a1aSMatthew Knepley if (orientation >= 0) { 2590ea844a1aSMatthew Knepley const PetscInt dim = s->atlasDof[p]; 2591ea844a1aSMatthew Knepley PetscInt cInd = 0, i; 2592ea844a1aSMatthew Knepley const PetscInt *cDof; 2593ea844a1aSMatthew Knepley 25949566063dSJacob Faibussowitsch PetscCall(PetscSectionGetConstraintIndices(s, point, &cDof)); 2595ea844a1aSMatthew Knepley if (mode == INSERT_VALUES) { 2596ea844a1aSMatthew Knepley for (i = 0; i < dim; ++i) { 25979371c9d4SSatish Balay if ((cInd < cDim) && (i == cDof[cInd])) { 25989371c9d4SSatish Balay ++cInd; 25999371c9d4SSatish Balay continue; 26009371c9d4SSatish Balay } 2601ad716f99SStefano Zampini array[i] = values ? values[i] : i; 2602ea844a1aSMatthew Knepley } 2603ea844a1aSMatthew Knepley } else { 2604ea844a1aSMatthew Knepley for (i = 0; i < dim; ++i) { 26059371c9d4SSatish Balay if ((cInd < cDim) && (i == cDof[cInd])) { 26069371c9d4SSatish Balay ++cInd; 26079371c9d4SSatish Balay continue; 26089371c9d4SSatish Balay } 2609ea844a1aSMatthew Knepley array[i] += values[i]; 2610ea844a1aSMatthew Knepley } 2611ea844a1aSMatthew Knepley } 2612ea844a1aSMatthew Knepley } else { 2613ea844a1aSMatthew Knepley const PetscInt *cDof; 2614ea844a1aSMatthew Knepley PetscInt offset = 0; 2615ea844a1aSMatthew Knepley PetscInt cOffset = 0; 2616ea844a1aSMatthew Knepley PetscInt j = 0, field; 2617ea844a1aSMatthew Knepley 26189566063dSJacob Faibussowitsch PetscCall(PetscSectionGetConstraintIndices(s, point, &cDof)); 2619ea844a1aSMatthew Knepley for (field = 0; field < s->numFields; ++field) { 2620ea844a1aSMatthew Knepley const PetscInt dim = s->field[field]->atlasDof[p]; /* PetscSectionGetFieldDof() */ 2621ea844a1aSMatthew Knepley const PetscInt tDim = s->field[field]->bc->atlasDof[p]; /* PetscSectionGetFieldConstraintDof() */ 2622ea844a1aSMatthew Knepley const PetscInt sDim = dim - tDim; 2623ea844a1aSMatthew Knepley PetscInt cInd = 0, i, k; 2624ea844a1aSMatthew Knepley 2625ea844a1aSMatthew Knepley for (i = 0, k = dim + offset - 1; i < dim; ++i, ++j, --k) { 26269371c9d4SSatish Balay if ((cInd < sDim) && (j == cDof[cInd + cOffset])) { 26279371c9d4SSatish Balay ++cInd; 26289371c9d4SSatish Balay continue; 26299371c9d4SSatish Balay } 2630ad716f99SStefano Zampini array[j] = values ? values[k] : k; 2631ea844a1aSMatthew Knepley } 2632ea844a1aSMatthew Knepley offset += dim; 2633ea844a1aSMatthew Knepley cOffset += dim - tDim; 2634ea844a1aSMatthew Knepley } 2635ea844a1aSMatthew Knepley } 2636ea844a1aSMatthew Knepley } 26373ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2638ea844a1aSMatthew Knepley } 2639ea844a1aSMatthew Knepley 2640ea844a1aSMatthew Knepley /*@C 264120662ed9SBarry Smith PetscSectionHasConstraints - Determine whether a `PetscSection` has constrained dofs 2642ea844a1aSMatthew Knepley 264340750d41SVaclav Hapla Not Collective 2644ea844a1aSMatthew Knepley 2645ea844a1aSMatthew Knepley Input Parameter: 2646cab54364SBarry Smith . s - The `PetscSection` 2647ea844a1aSMatthew Knepley 2648ea844a1aSMatthew Knepley Output Parameter: 2649ea844a1aSMatthew Knepley . hasConstraints - flag indicating that the section has constrained dofs 2650ea844a1aSMatthew Knepley 2651ea844a1aSMatthew Knepley Level: intermediate 2652ea844a1aSMatthew Knepley 2653cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSetConstraintIndices()`, `PetscSectionGetConstraintDof()`, `PetscSection` 2654ea844a1aSMatthew Knepley @*/ 2655d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionHasConstraints(PetscSection s, PetscBool *hasConstraints) 2656d71ae5a4SJacob Faibussowitsch { 2657ea844a1aSMatthew Knepley PetscFunctionBegin; 2658ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 26594f572ea9SToby Isaac PetscAssertPointer(hasConstraints, 2); 2660ea844a1aSMatthew Knepley *hasConstraints = s->bc ? PETSC_TRUE : PETSC_FALSE; 26613ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2662ea844a1aSMatthew Knepley } 2663ea844a1aSMatthew Knepley 2664ea844a1aSMatthew Knepley /*@C 266520662ed9SBarry Smith PetscSectionGetConstraintIndices - Get the point dof numbers, in [0, dof), which are constrained for a given point 2666ea844a1aSMatthew Knepley 266740750d41SVaclav Hapla Not Collective 2668ea844a1aSMatthew Knepley 2669ea844a1aSMatthew Knepley Input Parameters: 2670cab54364SBarry Smith + s - The `PetscSection` 2671ea844a1aSMatthew Knepley - point - The point 2672ea844a1aSMatthew Knepley 2673ea844a1aSMatthew Knepley Output Parameter: 2674ea844a1aSMatthew Knepley . indices - The constrained dofs 2675ea844a1aSMatthew Knepley 2676ea844a1aSMatthew Knepley Level: intermediate 2677ea844a1aSMatthew Knepley 267838b5cf2dSJacob Faibussowitsch Fortran Notes: 267920662ed9SBarry Smith Use `PetscSectionGetConstraintIndicesF90()` and `PetscSectionRestoreConstraintIndicesF90()` 2680cab54364SBarry Smith 2681cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSetConstraintIndices()`, `PetscSectionGetConstraintDof()`, `PetscSection` 2682ea844a1aSMatthew Knepley @*/ 2683d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetConstraintIndices(PetscSection s, PetscInt point, const PetscInt **indices) 2684d71ae5a4SJacob Faibussowitsch { 2685ea844a1aSMatthew Knepley PetscFunctionBegin; 2686ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 2687ea844a1aSMatthew Knepley if (s->bc) { 2688da8c939bSJacob Faibussowitsch PetscCall(VecIntGetValuesSection_Private(s->bcIndices, s->bc, point, indices)); 2689ea844a1aSMatthew Knepley } else *indices = NULL; 26903ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2691ea844a1aSMatthew Knepley } 2692ea844a1aSMatthew Knepley 2693ea844a1aSMatthew Knepley /*@C 2694ea844a1aSMatthew Knepley PetscSectionSetConstraintIndices - Set the point dof numbers, in [0, dof), which are constrained 2695ea844a1aSMatthew Knepley 269640750d41SVaclav Hapla Not Collective 2697ea844a1aSMatthew Knepley 2698ea844a1aSMatthew Knepley Input Parameters: 2699cab54364SBarry Smith + s - The `PetscSection` 2700ea844a1aSMatthew Knepley . point - The point 2701ea844a1aSMatthew Knepley - indices - The constrained dofs 2702ea844a1aSMatthew Knepley 2703ea844a1aSMatthew Knepley Level: intermediate 2704ea844a1aSMatthew Knepley 270538b5cf2dSJacob Faibussowitsch Fortran Notes: 2706cab54364SBarry Smith Use `PetscSectionSetConstraintIndicesF90()` 2707cab54364SBarry Smith 2708cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionGetConstraintIndices()`, `PetscSectionGetConstraintDof()`, `PetscSection` 2709ea844a1aSMatthew Knepley @*/ 2710d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetConstraintIndices(PetscSection s, PetscInt point, const PetscInt indices[]) 2711d71ae5a4SJacob Faibussowitsch { 2712ea844a1aSMatthew Knepley PetscFunctionBegin; 2713ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 2714ea844a1aSMatthew Knepley if (s->bc) { 2715d57bb9dbSMatthew G. Knepley const PetscInt dof = s->atlasDof[point]; 2716d57bb9dbSMatthew G. Knepley const PetscInt cdof = s->bc->atlasDof[point]; 2717d57bb9dbSMatthew G. Knepley PetscInt d; 2718d57bb9dbSMatthew G. Knepley 2719ad716f99SStefano Zampini if (indices) 2720ad540459SPierre Jolivet for (d = 0; d < cdof; ++d) PetscCheck(indices[d] < dof, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Point %" PetscInt_FMT " dof %" PetscInt_FMT ", invalid constraint index[%" PetscInt_FMT "]: %" PetscInt_FMT, point, dof, d, indices[d]); 2721da8c939bSJacob Faibussowitsch PetscCall(VecIntSetValuesSection_Private(s->bcIndices, s->bc, point, indices, INSERT_VALUES)); 2722ea844a1aSMatthew Knepley } 27233ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2724ea844a1aSMatthew Knepley } 2725ea844a1aSMatthew Knepley 2726ea844a1aSMatthew Knepley /*@C 2727ea844a1aSMatthew Knepley PetscSectionGetFieldConstraintIndices - Get the field dof numbers, in [0, fdof), which are constrained 2728ea844a1aSMatthew Knepley 272940750d41SVaclav Hapla Not Collective 2730ea844a1aSMatthew Knepley 2731ea844a1aSMatthew Knepley Input Parameters: 2732cab54364SBarry Smith + s - The `PetscSection` 2733ea844a1aSMatthew Knepley . field - The field number 2734ea844a1aSMatthew Knepley - point - The point 2735ea844a1aSMatthew Knepley 2736ea844a1aSMatthew Knepley Output Parameter: 27379759eb26SJed Brown . indices - The constrained dofs sorted in ascending order 2738ea844a1aSMatthew Knepley 2739ea844a1aSMatthew Knepley Level: intermediate 2740ea844a1aSMatthew Knepley 2741cab54364SBarry Smith Note: 2742cab54364SBarry Smith The indices array, which is provided by the caller, must have capacity to hold the number of constrained dofs, e.g., as returned by `PetscSectionGetConstraintDof()`. 2743cab54364SBarry Smith 274438b5cf2dSJacob Faibussowitsch Fortran Notes: 274520662ed9SBarry Smith Use `PetscSectionGetFieldConstraintIndicesF90()` and `PetscSectionRestoreFieldConstraintIndicesF90()` 2746cab54364SBarry Smith 2747cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSetFieldConstraintIndices()`, `PetscSectionGetConstraintIndices()`, `PetscSectionGetConstraintDof()`, `PetscSection` 2748ea844a1aSMatthew Knepley @*/ 2749d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetFieldConstraintIndices(PetscSection s, PetscInt point, PetscInt field, const PetscInt **indices) 2750d71ae5a4SJacob Faibussowitsch { 2751ea844a1aSMatthew Knepley PetscFunctionBegin; 2752ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 27534f572ea9SToby Isaac PetscAssertPointer(indices, 4); 27542abc8c78SJacob Faibussowitsch PetscSectionCheckValidField(field, s->numFields); 27559566063dSJacob Faibussowitsch PetscCall(PetscSectionGetConstraintIndices(s->field[field], point, indices)); 27563ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2757ea844a1aSMatthew Knepley } 2758ea844a1aSMatthew Knepley 2759ea844a1aSMatthew Knepley /*@C 2760ea844a1aSMatthew Knepley PetscSectionSetFieldConstraintIndices - Set the field dof numbers, in [0, fdof), which are constrained 2761ea844a1aSMatthew Knepley 276240750d41SVaclav Hapla Not Collective 2763ea844a1aSMatthew Knepley 2764ea844a1aSMatthew Knepley Input Parameters: 2765cab54364SBarry Smith + s - The `PetscSection` 2766ea844a1aSMatthew Knepley . point - The point 2767ea844a1aSMatthew Knepley . field - The field number 2768ea844a1aSMatthew Knepley - indices - The constrained dofs 2769ea844a1aSMatthew Knepley 2770ea844a1aSMatthew Knepley Level: intermediate 2771ea844a1aSMatthew Knepley 277238b5cf2dSJacob Faibussowitsch Fortran Notes: 2773cab54364SBarry Smith Use `PetscSectionSetFieldConstraintIndicesF90()` 2774cab54364SBarry Smith 2775cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSetConstraintIndices()`, `PetscSectionGetFieldConstraintIndices()`, `PetscSectionGetConstraintDof()`, `PetscSection` 2776ea844a1aSMatthew Knepley @*/ 2777d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetFieldConstraintIndices(PetscSection s, PetscInt point, PetscInt field, const PetscInt indices[]) 2778d71ae5a4SJacob Faibussowitsch { 2779ea844a1aSMatthew Knepley PetscFunctionBegin; 2780ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 27812abc8c78SJacob Faibussowitsch PetscSectionCheckValidField(field, s->numFields); 27829566063dSJacob Faibussowitsch PetscCall(PetscSectionSetConstraintIndices(s->field[field], point, indices)); 27833ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2784ea844a1aSMatthew Knepley } 2785ea844a1aSMatthew Knepley 2786ea844a1aSMatthew Knepley /*@ 2787ea844a1aSMatthew Knepley PetscSectionPermute - Reorder the section according to the input point permutation 2788ea844a1aSMatthew Knepley 278940750d41SVaclav Hapla Collective 2790ea844a1aSMatthew Knepley 2791d8d19677SJose E. Roman Input Parameters: 2792cab54364SBarry Smith + section - The `PetscSection` object 279338b5cf2dSJacob Faibussowitsch - permutation - The point permutation, old point p becomes new point perm[p] 2794ea844a1aSMatthew Knepley 2795ea844a1aSMatthew Knepley Output Parameter: 2796cab54364SBarry Smith . sectionNew - The permuted `PetscSection` 2797ea844a1aSMatthew Knepley 2798ea844a1aSMatthew Knepley Level: intermediate 2799ea844a1aSMatthew Knepley 2800583308b6SBarry Smith Note: 2801583308b6SBarry Smith The data and the access to the data via `PetscSectionGetFieldOffset()` and `PetscSectionGetOffset()` are both changed in `sectionNew` 2802583308b6SBarry Smith 2803583308b6SBarry Smith Compare to `PetscSectionSetPermutation()` 2804583308b6SBarry Smith 2805583308b6SBarry Smith .seealso: [PetscSection](sec_petscsection), `IS`, `PetscSection`, `MatPermute()`, `PetscSectionSetPermutation()` 2806ea844a1aSMatthew Knepley @*/ 2807d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionPermute(PetscSection section, IS permutation, PetscSection *sectionNew) 2808d71ae5a4SJacob Faibussowitsch { 2809ea844a1aSMatthew Knepley PetscSection s = section, sNew; 2810ea844a1aSMatthew Knepley const PetscInt *perm; 2811b778fa18SValeria Barra PetscInt numFields, f, c, numPoints, pStart, pEnd, p; 2812ea844a1aSMatthew Knepley 2813ea844a1aSMatthew Knepley PetscFunctionBegin; 2814ea844a1aSMatthew Knepley PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1); 2815ea844a1aSMatthew Knepley PetscValidHeaderSpecific(permutation, IS_CLASSID, 2); 28164f572ea9SToby Isaac PetscAssertPointer(sectionNew, 3); 28179566063dSJacob Faibussowitsch PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject)s), &sNew)); 28189566063dSJacob Faibussowitsch PetscCall(PetscSectionGetNumFields(s, &numFields)); 28199566063dSJacob Faibussowitsch if (numFields) PetscCall(PetscSectionSetNumFields(sNew, numFields)); 2820ea844a1aSMatthew Knepley for (f = 0; f < numFields; ++f) { 2821ea844a1aSMatthew Knepley const char *name; 2822ea844a1aSMatthew Knepley PetscInt numComp; 2823ea844a1aSMatthew Knepley 28249566063dSJacob Faibussowitsch PetscCall(PetscSectionGetFieldName(s, f, &name)); 28259566063dSJacob Faibussowitsch PetscCall(PetscSectionSetFieldName(sNew, f, name)); 28269566063dSJacob Faibussowitsch PetscCall(PetscSectionGetFieldComponents(s, f, &numComp)); 28279566063dSJacob Faibussowitsch PetscCall(PetscSectionSetFieldComponents(sNew, f, numComp)); 2828b778fa18SValeria Barra for (c = 0; c < s->numFieldComponents[f]; ++c) { 28299566063dSJacob Faibussowitsch PetscCall(PetscSectionGetComponentName(s, f, c, &name)); 28309566063dSJacob Faibussowitsch PetscCall(PetscSectionSetComponentName(sNew, f, c, name)); 2831b778fa18SValeria Barra } 2832ea844a1aSMatthew Knepley } 28339566063dSJacob Faibussowitsch PetscCall(ISGetLocalSize(permutation, &numPoints)); 28349566063dSJacob Faibussowitsch PetscCall(ISGetIndices(permutation, &perm)); 28359566063dSJacob Faibussowitsch PetscCall(PetscSectionGetChart(s, &pStart, &pEnd)); 28369566063dSJacob Faibussowitsch PetscCall(PetscSectionSetChart(sNew, pStart, pEnd)); 283708401ef6SPierre Jolivet PetscCheck(numPoints >= pEnd, PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "Permutation size %" PetscInt_FMT " is less than largest Section point %" PetscInt_FMT, numPoints, pEnd); 2838ea844a1aSMatthew Knepley for (p = pStart; p < pEnd; ++p) { 2839ea844a1aSMatthew Knepley PetscInt dof, cdof; 2840ea844a1aSMatthew Knepley 28419566063dSJacob Faibussowitsch PetscCall(PetscSectionGetDof(s, p, &dof)); 28429566063dSJacob Faibussowitsch PetscCall(PetscSectionSetDof(sNew, perm[p], dof)); 28439566063dSJacob Faibussowitsch PetscCall(PetscSectionGetConstraintDof(s, p, &cdof)); 28449566063dSJacob Faibussowitsch if (cdof) PetscCall(PetscSectionSetConstraintDof(sNew, perm[p], cdof)); 2845ea844a1aSMatthew Knepley for (f = 0; f < numFields; ++f) { 28469566063dSJacob Faibussowitsch PetscCall(PetscSectionGetFieldDof(s, p, f, &dof)); 28479566063dSJacob Faibussowitsch PetscCall(PetscSectionSetFieldDof(sNew, perm[p], f, dof)); 28489566063dSJacob Faibussowitsch PetscCall(PetscSectionGetFieldConstraintDof(s, p, f, &cdof)); 28499566063dSJacob Faibussowitsch if (cdof) PetscCall(PetscSectionSetFieldConstraintDof(sNew, perm[p], f, cdof)); 2850ea844a1aSMatthew Knepley } 2851ea844a1aSMatthew Knepley } 28529566063dSJacob Faibussowitsch PetscCall(PetscSectionSetUp(sNew)); 2853ea844a1aSMatthew Knepley for (p = pStart; p < pEnd; ++p) { 2854ea844a1aSMatthew Knepley const PetscInt *cind; 2855ea844a1aSMatthew Knepley PetscInt cdof; 2856ea844a1aSMatthew Knepley 28579566063dSJacob Faibussowitsch PetscCall(PetscSectionGetConstraintDof(s, p, &cdof)); 2858ea844a1aSMatthew Knepley if (cdof) { 28599566063dSJacob Faibussowitsch PetscCall(PetscSectionGetConstraintIndices(s, p, &cind)); 28609566063dSJacob Faibussowitsch PetscCall(PetscSectionSetConstraintIndices(sNew, perm[p], cind)); 2861ea844a1aSMatthew Knepley } 2862ea844a1aSMatthew Knepley for (f = 0; f < numFields; ++f) { 28639566063dSJacob Faibussowitsch PetscCall(PetscSectionGetFieldConstraintDof(s, p, f, &cdof)); 2864ea844a1aSMatthew Knepley if (cdof) { 28659566063dSJacob Faibussowitsch PetscCall(PetscSectionGetFieldConstraintIndices(s, p, f, &cind)); 28669566063dSJacob Faibussowitsch PetscCall(PetscSectionSetFieldConstraintIndices(sNew, perm[p], f, cind)); 2867ea844a1aSMatthew Knepley } 2868ea844a1aSMatthew Knepley } 2869ea844a1aSMatthew Knepley } 28709566063dSJacob Faibussowitsch PetscCall(ISRestoreIndices(permutation, &perm)); 2871ea844a1aSMatthew Knepley *sectionNew = sNew; 28723ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2873ea844a1aSMatthew Knepley } 2874ea844a1aSMatthew Knepley 2875ea844a1aSMatthew Knepley /*@ 287620662ed9SBarry Smith PetscSectionSetClosureIndex - Create an internal data structure to speed up closure queries. 2877ea844a1aSMatthew Knepley 287840750d41SVaclav Hapla Collective 2879ea844a1aSMatthew Knepley 2880ea844a1aSMatthew Knepley Input Parameters: 2881cab54364SBarry Smith + section - The `PetscSection` 2882cab54364SBarry Smith . obj - A `PetscObject` which serves as the key for this index 2883cab54364SBarry Smith . clSection - `PetscSection` giving the size of the closure of each point 2884cab54364SBarry Smith - clPoints - `IS` giving the points in each closure 2885ea844a1aSMatthew Knepley 2886ea844a1aSMatthew Knepley Level: advanced 2887ea844a1aSMatthew Knepley 2888cab54364SBarry Smith Note: 288920662ed9SBarry Smith This function creates an internal map from each point to its closure. We compress out closure points with no dofs in this section. 289020662ed9SBarry Smith 289138b5cf2dSJacob Faibussowitsch Developer Notes: 289220662ed9SBarry Smith The information provided here is completely opaque 2893cab54364SBarry Smith 2894cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionGetClosureIndex()`, `DMPlexCreateClosureIndex()` 2895ea844a1aSMatthew Knepley @*/ 2896d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetClosureIndex(PetscSection section, PetscObject obj, PetscSection clSection, IS clPoints) 2897d71ae5a4SJacob Faibussowitsch { 2898ea844a1aSMatthew Knepley PetscFunctionBegin; 28993e03ebd8SStefano Zampini PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1); 29003e03ebd8SStefano Zampini PetscValidHeaderSpecific(clSection, PETSC_SECTION_CLASSID, 3); 29013e03ebd8SStefano Zampini PetscValidHeaderSpecific(clPoints, IS_CLASSID, 4); 2902d4a1ad33SMatthew G. Knepley if (section->clObj != obj) PetscCall(PetscSectionResetClosurePermutation(section)); 2903ea844a1aSMatthew Knepley section->clObj = obj; 29049566063dSJacob Faibussowitsch PetscCall(PetscObjectReference((PetscObject)clSection)); 29059566063dSJacob Faibussowitsch PetscCall(PetscObjectReference((PetscObject)clPoints)); 29069566063dSJacob Faibussowitsch PetscCall(PetscSectionDestroy(§ion->clSection)); 29079566063dSJacob Faibussowitsch PetscCall(ISDestroy(§ion->clPoints)); 2908ea844a1aSMatthew Knepley section->clSection = clSection; 2909ea844a1aSMatthew Knepley section->clPoints = clPoints; 29103ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2911ea844a1aSMatthew Knepley } 2912ea844a1aSMatthew Knepley 2913ea844a1aSMatthew Knepley /*@ 2914cab54364SBarry Smith PetscSectionGetClosureIndex - Get the cache of points in the closure of each point in the section set with `PetscSectionSetClosureIndex()` 2915ea844a1aSMatthew Knepley 291640750d41SVaclav Hapla Collective 2917ea844a1aSMatthew Knepley 2918ea844a1aSMatthew Knepley Input Parameters: 2919cab54364SBarry Smith + section - The `PetscSection` 2920cab54364SBarry Smith - obj - A `PetscObject` which serves as the key for this index 2921ea844a1aSMatthew Knepley 2922ea844a1aSMatthew Knepley Output Parameters: 2923cab54364SBarry Smith + clSection - `PetscSection` giving the size of the closure of each point 2924cab54364SBarry Smith - clPoints - `IS` giving the points in each closure 2925ea844a1aSMatthew Knepley 2926ea844a1aSMatthew Knepley Level: advanced 2927ea844a1aSMatthew Knepley 2928cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSetClosureIndex()`, `DMPlexCreateClosureIndex()` 2929ea844a1aSMatthew Knepley @*/ 2930d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetClosureIndex(PetscSection section, PetscObject obj, PetscSection *clSection, IS *clPoints) 2931d71ae5a4SJacob Faibussowitsch { 2932ea844a1aSMatthew Knepley PetscFunctionBegin; 2933ea844a1aSMatthew Knepley if (section->clObj == obj) { 2934ea844a1aSMatthew Knepley if (clSection) *clSection = section->clSection; 2935ea844a1aSMatthew Knepley if (clPoints) *clPoints = section->clPoints; 2936ea844a1aSMatthew Knepley } else { 2937ea844a1aSMatthew Knepley if (clSection) *clSection = NULL; 2938ea844a1aSMatthew Knepley if (clPoints) *clPoints = NULL; 2939ea844a1aSMatthew Knepley } 29403ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2941ea844a1aSMatthew Knepley } 2942ea844a1aSMatthew Knepley 2943d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetClosurePermutation_Internal(PetscSection section, PetscObject obj, PetscInt depth, PetscInt clSize, PetscCopyMode mode, PetscInt *clPerm) 2944d71ae5a4SJacob Faibussowitsch { 2945ea844a1aSMatthew Knepley PetscInt i; 2946c459fbc1SJed Brown khiter_t iter; 2947c459fbc1SJed Brown int new_entry; 2948c459fbc1SJed Brown PetscSectionClosurePermKey key = {depth, clSize}; 2949c459fbc1SJed Brown PetscSectionClosurePermVal *val; 2950ea844a1aSMatthew Knepley 2951ea844a1aSMatthew Knepley PetscFunctionBegin; 2952ea844a1aSMatthew Knepley if (section->clObj != obj) { 29539566063dSJacob Faibussowitsch PetscCall(PetscSectionDestroy(§ion->clSection)); 29549566063dSJacob Faibussowitsch PetscCall(ISDestroy(§ion->clPoints)); 2955ea844a1aSMatthew Knepley } 2956ea844a1aSMatthew Knepley section->clObj = obj; 29579566063dSJacob Faibussowitsch if (!section->clHash) PetscCall(PetscClPermCreate(§ion->clHash)); 2958c459fbc1SJed Brown iter = kh_put(ClPerm, section->clHash, key, &new_entry); 2959c459fbc1SJed Brown val = &kh_val(section->clHash, iter); 2960c459fbc1SJed Brown if (!new_entry) { 29619566063dSJacob Faibussowitsch PetscCall(PetscFree(val->perm)); 29629566063dSJacob Faibussowitsch PetscCall(PetscFree(val->invPerm)); 2963c459fbc1SJed Brown } 2964ea844a1aSMatthew Knepley if (mode == PETSC_COPY_VALUES) { 29659566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(clSize, &val->perm)); 29669566063dSJacob Faibussowitsch PetscCall(PetscArraycpy(val->perm, clPerm, clSize)); 2967ea844a1aSMatthew Knepley } else if (mode == PETSC_OWN_POINTER) { 2968c459fbc1SJed Brown val->perm = clPerm; 2969ea844a1aSMatthew Knepley } else SETERRQ(PetscObjectComm(obj), PETSC_ERR_SUP, "Do not support borrowed arrays"); 29709566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(clSize, &val->invPerm)); 2971c459fbc1SJed Brown for (i = 0; i < clSize; ++i) val->invPerm[clPerm[i]] = i; 29723ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2973ea844a1aSMatthew Knepley } 2974ea844a1aSMatthew Knepley 2975ea844a1aSMatthew Knepley /*@ 2976c459fbc1SJed Brown PetscSectionSetClosurePermutation - Set the dof permutation for the closure of each cell in the section, meaning clPerm[newIndex] = oldIndex. 2977ea844a1aSMatthew Knepley 2978ea844a1aSMatthew Knepley Not Collective 2979ea844a1aSMatthew Knepley 2980ea844a1aSMatthew Knepley Input Parameters: 2981cab54364SBarry Smith + section - The `PetscSection` 2982cab54364SBarry Smith . obj - A `PetscObject` which serves as the key for this index (usually a `DM`) 2983c459fbc1SJed Brown . depth - Depth of points on which to apply the given permutation 2984ea844a1aSMatthew Knepley - perm - Permutation of the cell dof closure 2985ea844a1aSMatthew Knepley 2986cab54364SBarry Smith Level: intermediate 2987cab54364SBarry Smith 2988cab54364SBarry Smith Notes: 2989c459fbc1SJed Brown The specified permutation will only be applied to points at depth whose closure size matches the length of perm. In a 2990c459fbc1SJed Brown mixed-topology or variable-degree finite element space, this function can be called multiple times at each depth for 2991c459fbc1SJed Brown each topology and degree. 2992c459fbc1SJed Brown 2993c459fbc1SJed Brown This approach assumes that (depth, len(perm)) uniquely identifies the desired permutation; this might not be true for 2994c459fbc1SJed Brown exotic/enriched spaces on mixed topology meshes. 2995ea844a1aSMatthew Knepley 2996cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `IS`, `PetscSectionGetClosurePermutation()`, `PetscSectionGetClosureIndex()`, `DMPlexCreateClosureIndex()`, `PetscCopyMode` 2997ea844a1aSMatthew Knepley @*/ 2998d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetClosurePermutation(PetscSection section, PetscObject obj, PetscInt depth, IS perm) 2999d71ae5a4SJacob Faibussowitsch { 3000ea844a1aSMatthew Knepley const PetscInt *clPerm = NULL; 3001ea844a1aSMatthew Knepley PetscInt clSize = 0; 3002ea844a1aSMatthew Knepley 3003ea844a1aSMatthew Knepley PetscFunctionBegin; 3004ea844a1aSMatthew Knepley if (perm) { 30059566063dSJacob Faibussowitsch PetscCall(ISGetLocalSize(perm, &clSize)); 30069566063dSJacob Faibussowitsch PetscCall(ISGetIndices(perm, &clPerm)); 3007ea844a1aSMatthew Knepley } 30089566063dSJacob Faibussowitsch PetscCall(PetscSectionSetClosurePermutation_Internal(section, obj, depth, clSize, PETSC_COPY_VALUES, (PetscInt *)clPerm)); 30099566063dSJacob Faibussowitsch if (perm) PetscCall(ISRestoreIndices(perm, &clPerm)); 30103ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 3011ea844a1aSMatthew Knepley } 3012ea844a1aSMatthew Knepley 3013da8c939bSJacob Faibussowitsch static PetscErrorCode PetscSectionGetClosurePermutation_Private(PetscSection section, PetscObject obj, PetscInt depth, PetscInt size, const PetscInt *perm[]) 3014d71ae5a4SJacob Faibussowitsch { 3015ea844a1aSMatthew Knepley PetscFunctionBegin; 3016ea844a1aSMatthew Knepley if (section->clObj == obj) { 3017c459fbc1SJed Brown PetscSectionClosurePermKey k = {depth, size}; 3018c459fbc1SJed Brown PetscSectionClosurePermVal v; 3019da8c939bSJacob Faibussowitsch 30209566063dSJacob Faibussowitsch PetscCall(PetscClPermGet(section->clHash, k, &v)); 3021c459fbc1SJed Brown if (perm) *perm = v.perm; 3022ea844a1aSMatthew Knepley } else { 3023ea844a1aSMatthew Knepley if (perm) *perm = NULL; 3024ea844a1aSMatthew Knepley } 30253ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 3026ea844a1aSMatthew Knepley } 3027ea844a1aSMatthew Knepley 3028ea844a1aSMatthew Knepley /*@ 3029ea844a1aSMatthew Knepley PetscSectionGetClosurePermutation - Get the dof permutation for the closure of each cell in the section, meaning clPerm[newIndex] = oldIndex. 3030ea844a1aSMatthew Knepley 303140750d41SVaclav Hapla Not Collective 3032ea844a1aSMatthew Knepley 3033ea844a1aSMatthew Knepley Input Parameters: 3034cab54364SBarry Smith + section - The `PetscSection` 3035cab54364SBarry Smith . obj - A `PetscObject` which serves as the key for this index (usually a DM) 3036c459fbc1SJed Brown . depth - Depth stratum on which to obtain closure permutation 3037c459fbc1SJed Brown - clSize - Closure size to be permuted (e.g., may vary with element topology and degree) 3038ea844a1aSMatthew Knepley 3039ea844a1aSMatthew Knepley Output Parameter: 3040ea844a1aSMatthew Knepley . perm - The dof closure permutation 3041ea844a1aSMatthew Knepley 3042ea844a1aSMatthew Knepley Level: intermediate 3043ea844a1aSMatthew Knepley 3044cab54364SBarry Smith Note: 3045cab54364SBarry Smith The user must destroy the `IS` that is returned. 3046cab54364SBarry Smith 3047cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `IS`, `PetscSectionSetClosurePermutation()`, `PetscSectionGetClosureInversePermutation()`, `PetscSectionGetClosureIndex()`, `PetscSectionSetClosureIndex()`, `DMPlexCreateClosureIndex()` 3048ea844a1aSMatthew Knepley @*/ 3049d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetClosurePermutation(PetscSection section, PetscObject obj, PetscInt depth, PetscInt clSize, IS *perm) 3050d71ae5a4SJacob Faibussowitsch { 3051da8c939bSJacob Faibussowitsch const PetscInt *clPerm = NULL; 3052ea844a1aSMatthew Knepley 3053ea844a1aSMatthew Knepley PetscFunctionBegin; 3054da8c939bSJacob Faibussowitsch PetscCall(PetscSectionGetClosurePermutation_Private(section, obj, depth, clSize, &clPerm)); 3055*5f82726aSMatthew G. Knepley PetscCheck(clPerm, PetscObjectComm((PetscObject)obj), PETSC_ERR_ARG_WRONG, "There is no closure permutation associated with this object for depth %" PetscInt_FMT " of size %" PetscInt_FMT, depth, clSize); 30569566063dSJacob Faibussowitsch PetscCall(ISCreateGeneral(PETSC_COMM_SELF, clSize, clPerm, PETSC_USE_POINTER, perm)); 30573ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 3058ea844a1aSMatthew Knepley } 3059ea844a1aSMatthew Knepley 3060d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetClosureInversePermutation_Internal(PetscSection section, PetscObject obj, PetscInt depth, PetscInt size, const PetscInt *perm[]) 3061d71ae5a4SJacob Faibussowitsch { 3062ea844a1aSMatthew Knepley PetscFunctionBegin; 3063c459fbc1SJed Brown if (section->clObj == obj && section->clHash) { 3064c459fbc1SJed Brown PetscSectionClosurePermKey k = {depth, size}; 3065c459fbc1SJed Brown PetscSectionClosurePermVal v; 30669566063dSJacob Faibussowitsch PetscCall(PetscClPermGet(section->clHash, k, &v)); 3067c459fbc1SJed Brown if (perm) *perm = v.invPerm; 3068ea844a1aSMatthew Knepley } else { 3069ea844a1aSMatthew Knepley if (perm) *perm = NULL; 3070ea844a1aSMatthew Knepley } 30713ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 3072ea844a1aSMatthew Knepley } 3073ea844a1aSMatthew Knepley 3074ea844a1aSMatthew Knepley /*@ 3075ea844a1aSMatthew Knepley PetscSectionGetClosureInversePermutation - Get the inverse dof permutation for the closure of each cell in the section, meaning clPerm[oldIndex] = newIndex. 3076ea844a1aSMatthew Knepley 307740750d41SVaclav Hapla Not Collective 3078ea844a1aSMatthew Knepley 3079ea844a1aSMatthew Knepley Input Parameters: 3080cab54364SBarry Smith + section - The `PetscSection` 3081cab54364SBarry Smith . obj - A `PetscObject` which serves as the key for this index (usually a `DM`) 3082c459fbc1SJed Brown . depth - Depth stratum on which to obtain closure permutation 3083c459fbc1SJed Brown - clSize - Closure size to be permuted (e.g., may vary with element topology and degree) 3084ea844a1aSMatthew Knepley 30852fe279fdSBarry Smith Output Parameter: 3086c459fbc1SJed Brown . perm - The dof closure permutation 3087ea844a1aSMatthew Knepley 3088ea844a1aSMatthew Knepley Level: intermediate 3089ea844a1aSMatthew Knepley 3090cab54364SBarry Smith Note: 3091cab54364SBarry Smith The user must destroy the `IS` that is returned. 3092cab54364SBarry Smith 3093cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `IS`, `PetscSectionSetClosurePermutation()`, `PetscSectionGetClosureIndex()`, `PetscSectionSetClosureIndex()`, `DMPlexCreateClosureIndex()` 3094ea844a1aSMatthew Knepley @*/ 3095d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetClosureInversePermutation(PetscSection section, PetscObject obj, PetscInt depth, PetscInt clSize, IS *perm) 3096d71ae5a4SJacob Faibussowitsch { 3097da8c939bSJacob Faibussowitsch const PetscInt *clPerm = NULL; 3098ea844a1aSMatthew Knepley 3099ea844a1aSMatthew Knepley PetscFunctionBegin; 31009566063dSJacob Faibussowitsch PetscCall(PetscSectionGetClosureInversePermutation_Internal(section, obj, depth, clSize, &clPerm)); 31019566063dSJacob Faibussowitsch PetscCall(ISCreateGeneral(PETSC_COMM_SELF, clSize, clPerm, PETSC_USE_POINTER, perm)); 31023ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 3103ea844a1aSMatthew Knepley } 3104ea844a1aSMatthew Knepley 3105ea844a1aSMatthew Knepley /*@ 3106583308b6SBarry Smith PetscSectionGetField - Get the `PetscSection` associated with a single field 3107ea844a1aSMatthew Knepley 3108ea844a1aSMatthew Knepley Input Parameters: 3109cab54364SBarry Smith + s - The `PetscSection` 3110ea844a1aSMatthew Knepley - field - The field number 3111ea844a1aSMatthew Knepley 3112ea844a1aSMatthew Knepley Output Parameter: 3113583308b6SBarry Smith . subs - The `PetscSection` for the given field, note the chart of `subs` is not set 3114ea844a1aSMatthew Knepley 3115ea844a1aSMatthew Knepley Level: intermediate 3116ea844a1aSMatthew Knepley 3117cab54364SBarry Smith Note: 3118cab54364SBarry Smith Does not increase the reference count of the selected sub-section. There is no matching `PetscSectionRestoreField()` 3119cab54364SBarry Smith 3120cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `IS`, `PetscSectionSetNumFields()` 3121ea844a1aSMatthew Knepley @*/ 3122d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetField(PetscSection s, PetscInt field, PetscSection *subs) 3123d71ae5a4SJacob Faibussowitsch { 3124ea844a1aSMatthew Knepley PetscFunctionBegin; 3125ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 31264f572ea9SToby Isaac PetscAssertPointer(subs, 3); 31272abc8c78SJacob Faibussowitsch PetscSectionCheckValidField(field, s->numFields); 3128ea844a1aSMatthew Knepley *subs = s->field[field]; 31293ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 3130ea844a1aSMatthew Knepley } 3131ea844a1aSMatthew Knepley 3132ea844a1aSMatthew Knepley PetscClassId PETSC_SECTION_SYM_CLASSID; 3133ea844a1aSMatthew Knepley PetscFunctionList PetscSectionSymList = NULL; 3134ea844a1aSMatthew Knepley 3135ea844a1aSMatthew Knepley /*@ 3136cab54364SBarry Smith PetscSectionSymCreate - Creates an empty `PetscSectionSym` object. 3137ea844a1aSMatthew Knepley 3138ea844a1aSMatthew Knepley Collective 3139ea844a1aSMatthew Knepley 3140ea844a1aSMatthew Knepley Input Parameter: 3141ea844a1aSMatthew Knepley . comm - the MPI communicator 3142ea844a1aSMatthew Knepley 3143ea844a1aSMatthew Knepley Output Parameter: 3144ea844a1aSMatthew Knepley . sym - pointer to the new set of symmetries 3145ea844a1aSMatthew Knepley 3146ea844a1aSMatthew Knepley Level: developer 3147ea844a1aSMatthew Knepley 3148cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSection`, `PetscSectionSym`, `PetscSectionSymDestroy()` 3149ea844a1aSMatthew Knepley @*/ 3150d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSymCreate(MPI_Comm comm, PetscSectionSym *sym) 3151d71ae5a4SJacob Faibussowitsch { 3152ea844a1aSMatthew Knepley PetscFunctionBegin; 31534f572ea9SToby Isaac PetscAssertPointer(sym, 2); 31549566063dSJacob Faibussowitsch PetscCall(ISInitializePackage()); 31559566063dSJacob Faibussowitsch PetscCall(PetscHeaderCreate(*sym, PETSC_SECTION_SYM_CLASSID, "PetscSectionSym", "Section Symmetry", "IS", comm, PetscSectionSymDestroy, PetscSectionSymView)); 31563ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 3157ea844a1aSMatthew Knepley } 3158ea844a1aSMatthew Knepley 3159ea844a1aSMatthew Knepley /*@C 3160cab54364SBarry Smith PetscSectionSymSetType - Builds a `PetscSectionSym`, for a particular implementation. 3161ea844a1aSMatthew Knepley 316240750d41SVaclav Hapla Collective 3163ea844a1aSMatthew Knepley 3164ea844a1aSMatthew Knepley Input Parameters: 3165ea844a1aSMatthew Knepley + sym - The section symmetry object 3166ea844a1aSMatthew Knepley - method - The name of the section symmetry type 3167ea844a1aSMatthew Knepley 3168ea844a1aSMatthew Knepley Level: developer 3169ea844a1aSMatthew Knepley 3170cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionSymType`, `PetscSectionSymGetType()`, `PetscSectionSymCreate()` 3171ea844a1aSMatthew Knepley @*/ 3172d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSymSetType(PetscSectionSym sym, PetscSectionSymType method) 3173d71ae5a4SJacob Faibussowitsch { 3174ea844a1aSMatthew Knepley PetscErrorCode (*r)(PetscSectionSym); 3175ea844a1aSMatthew Knepley PetscBool match; 3176ea844a1aSMatthew Knepley 3177ea844a1aSMatthew Knepley PetscFunctionBegin; 3178ea844a1aSMatthew Knepley PetscValidHeaderSpecific(sym, PETSC_SECTION_SYM_CLASSID, 1); 31799566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)sym, method, &match)); 31803ba16761SJacob Faibussowitsch if (match) PetscFunctionReturn(PETSC_SUCCESS); 3181ea844a1aSMatthew Knepley 31829566063dSJacob Faibussowitsch PetscCall(PetscFunctionListFind(PetscSectionSymList, method, &r)); 31836adde796SStefano Zampini PetscCheck(r, PetscObjectComm((PetscObject)sym), PETSC_ERR_ARG_UNKNOWN_TYPE, "Unknown PetscSectionSym type: %s", method); 3184dbbe0bcdSBarry Smith PetscTryTypeMethod(sym, destroy); 3185ea844a1aSMatthew Knepley sym->ops->destroy = NULL; 3186dbbe0bcdSBarry Smith 31879566063dSJacob Faibussowitsch PetscCall((*r)(sym)); 31889566063dSJacob Faibussowitsch PetscCall(PetscObjectChangeTypeName((PetscObject)sym, method)); 31893ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 3190ea844a1aSMatthew Knepley } 3191ea844a1aSMatthew Knepley 3192ea844a1aSMatthew Knepley /*@C 3193cab54364SBarry Smith PetscSectionSymGetType - Gets the section symmetry type name (as a string) from the `PetscSectionSym`. 3194ea844a1aSMatthew Knepley 3195ea844a1aSMatthew Knepley Not Collective 3196ea844a1aSMatthew Knepley 3197ea844a1aSMatthew Knepley Input Parameter: 3198ea844a1aSMatthew Knepley . sym - The section symmetry 3199ea844a1aSMatthew Knepley 3200ea844a1aSMatthew Knepley Output Parameter: 3201ea844a1aSMatthew Knepley . type - The index set type name 3202ea844a1aSMatthew Knepley 3203ea844a1aSMatthew Knepley Level: developer 3204ea844a1aSMatthew Knepley 3205cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionSymType`, `PetscSectionSymSetType()`, `PetscSectionSymCreate()` 3206ea844a1aSMatthew Knepley @*/ 3207d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSymGetType(PetscSectionSym sym, PetscSectionSymType *type) 3208d71ae5a4SJacob Faibussowitsch { 3209ea844a1aSMatthew Knepley PetscFunctionBegin; 3210ea844a1aSMatthew Knepley PetscValidHeaderSpecific(sym, PETSC_SECTION_SYM_CLASSID, 1); 32114f572ea9SToby Isaac PetscAssertPointer(type, 2); 3212ea844a1aSMatthew Knepley *type = ((PetscObject)sym)->type_name; 32133ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 3214ea844a1aSMatthew Knepley } 3215ea844a1aSMatthew Knepley 3216ea844a1aSMatthew Knepley /*@C 3217cab54364SBarry Smith PetscSectionSymRegister - Registers a new section symmetry implementation 3218ea844a1aSMatthew Knepley 3219ea844a1aSMatthew Knepley Not Collective 3220ea844a1aSMatthew Knepley 3221ea844a1aSMatthew Knepley Input Parameters: 32222fe279fdSBarry Smith + sname - The name of a new user-defined creation routine 32232fe279fdSBarry Smith - function - The creation routine itself 3224ea844a1aSMatthew Knepley 3225ea844a1aSMatthew Knepley Level: developer 3226ea844a1aSMatthew Knepley 3227cab54364SBarry Smith Notes: 3228cab54364SBarry Smith `PetscSectionSymRegister()` may be called multiple times to add several user-defined vectors 3229cab54364SBarry Smith 3230cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionSymType`, `PetscSectionSymCreate()`, `PetscSectionSymSetType()` 3231ea844a1aSMatthew Knepley @*/ 3232d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSymRegister(const char sname[], PetscErrorCode (*function)(PetscSectionSym)) 3233d71ae5a4SJacob Faibussowitsch { 3234ea844a1aSMatthew Knepley PetscFunctionBegin; 32359566063dSJacob Faibussowitsch PetscCall(ISInitializePackage()); 32369566063dSJacob Faibussowitsch PetscCall(PetscFunctionListAdd(&PetscSectionSymList, sname, function)); 32373ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 3238ea844a1aSMatthew Knepley } 3239ea844a1aSMatthew Knepley 3240ea844a1aSMatthew Knepley /*@ 3241ea844a1aSMatthew Knepley PetscSectionSymDestroy - Destroys a section symmetry. 3242ea844a1aSMatthew Knepley 324340750d41SVaclav Hapla Collective 3244ea844a1aSMatthew Knepley 32452fe279fdSBarry Smith Input Parameter: 3246ea844a1aSMatthew Knepley . sym - the section symmetry 3247ea844a1aSMatthew Knepley 3248ea844a1aSMatthew Knepley Level: developer 3249ea844a1aSMatthew Knepley 325042747ad1SJacob Faibussowitsch .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionSymCreate()` 3251ea844a1aSMatthew Knepley @*/ 3252d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSymDestroy(PetscSectionSym *sym) 3253d71ae5a4SJacob Faibussowitsch { 3254ea844a1aSMatthew Knepley SymWorkLink link, next; 3255ea844a1aSMatthew Knepley 3256ea844a1aSMatthew Knepley PetscFunctionBegin; 32573ba16761SJacob Faibussowitsch if (!*sym) PetscFunctionReturn(PETSC_SUCCESS); 3258ea844a1aSMatthew Knepley PetscValidHeaderSpecific((*sym), PETSC_SECTION_SYM_CLASSID, 1); 32599371c9d4SSatish Balay if (--((PetscObject)(*sym))->refct > 0) { 32609371c9d4SSatish Balay *sym = NULL; 32613ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 3262ea844a1aSMatthew Knepley } 326348a46eb9SPierre Jolivet if ((*sym)->ops->destroy) PetscCall((*(*sym)->ops->destroy)(*sym)); 3264c9cc58a2SBarry Smith PetscCheck(!(*sym)->workout, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, "Work array still checked out"); 3265ea844a1aSMatthew Knepley for (link = (*sym)->workin; link; link = next) { 32660c99d500SBarry Smith PetscInt **perms = (PetscInt **)link->perms; 32670c99d500SBarry Smith PetscScalar **rots = (PetscScalar **)link->rots; 32680c99d500SBarry Smith PetscCall(PetscFree2(perms, rots)); 3269ea844a1aSMatthew Knepley next = link->next; 32709566063dSJacob Faibussowitsch PetscCall(PetscFree(link)); 3271ea844a1aSMatthew Knepley } 3272ea844a1aSMatthew Knepley (*sym)->workin = NULL; 32739566063dSJacob Faibussowitsch PetscCall(PetscHeaderDestroy(sym)); 32743ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 3275ea844a1aSMatthew Knepley } 3276ea844a1aSMatthew Knepley 3277ea844a1aSMatthew Knepley /*@C 3278ea844a1aSMatthew Knepley PetscSectionSymView - Displays a section symmetry 3279ea844a1aSMatthew Knepley 328040750d41SVaclav Hapla Collective 3281ea844a1aSMatthew Knepley 3282ea844a1aSMatthew Knepley Input Parameters: 3283ea844a1aSMatthew Knepley + sym - the index set 3284cab54364SBarry Smith - viewer - viewer used to display the set, for example `PETSC_VIEWER_STDOUT_SELF`. 3285ea844a1aSMatthew Knepley 3286ea844a1aSMatthew Knepley Level: developer 3287ea844a1aSMatthew Knepley 3288cab54364SBarry Smith .seealso: `PetscSectionSym`, `PetscViewer`, `PetscViewerASCIIOpen()` 3289ea844a1aSMatthew Knepley @*/ 3290d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSymView(PetscSectionSym sym, PetscViewer viewer) 3291d71ae5a4SJacob Faibussowitsch { 3292ea844a1aSMatthew Knepley PetscFunctionBegin; 3293ea844a1aSMatthew Knepley PetscValidHeaderSpecific(sym, PETSC_SECTION_SYM_CLASSID, 1); 329448a46eb9SPierre Jolivet if (!viewer) PetscCall(PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)sym), &viewer)); 3295ea844a1aSMatthew Knepley PetscValidHeaderSpecific(viewer, PETSC_VIEWER_CLASSID, 2); 3296ea844a1aSMatthew Knepley PetscCheckSameComm(sym, 1, viewer, 2); 32979566063dSJacob Faibussowitsch PetscCall(PetscObjectPrintClassNamePrefixType((PetscObject)sym, viewer)); 3298dbbe0bcdSBarry Smith PetscTryTypeMethod(sym, view, viewer); 32993ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 3300ea844a1aSMatthew Knepley } 3301ea844a1aSMatthew Knepley 3302ea844a1aSMatthew Knepley /*@ 3303ea844a1aSMatthew Knepley PetscSectionSetSym - Set the symmetries for the data referred to by the section 3304ea844a1aSMatthew Knepley 330540750d41SVaclav Hapla Collective 3306ea844a1aSMatthew Knepley 3307ea844a1aSMatthew Knepley Input Parameters: 3308ea844a1aSMatthew Knepley + section - the section describing data layout 3309ea844a1aSMatthew Knepley - sym - the symmetry describing the affect of orientation on the access of the data 3310ea844a1aSMatthew Knepley 3311ea844a1aSMatthew Knepley Level: developer 3312ea844a1aSMatthew Knepley 3313cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionGetSym()`, `PetscSectionSymCreate()` 3314ea844a1aSMatthew Knepley @*/ 3315d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetSym(PetscSection section, PetscSectionSym sym) 3316d71ae5a4SJacob Faibussowitsch { 3317ea844a1aSMatthew Knepley PetscFunctionBegin; 3318ea844a1aSMatthew Knepley PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1); 33199566063dSJacob Faibussowitsch PetscCall(PetscSectionSymDestroy(&(section->sym))); 3320ea844a1aSMatthew Knepley if (sym) { 3321ea844a1aSMatthew Knepley PetscValidHeaderSpecific(sym, PETSC_SECTION_SYM_CLASSID, 2); 3322ea844a1aSMatthew Knepley PetscCheckSameComm(section, 1, sym, 2); 33239566063dSJacob Faibussowitsch PetscCall(PetscObjectReference((PetscObject)sym)); 3324ea844a1aSMatthew Knepley } 3325ea844a1aSMatthew Knepley section->sym = sym; 33263ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 3327ea844a1aSMatthew Knepley } 3328ea844a1aSMatthew Knepley 3329ea844a1aSMatthew Knepley /*@ 3330ea844a1aSMatthew Knepley PetscSectionGetSym - Get the symmetries for the data referred to by the section 3331ea844a1aSMatthew Knepley 333240750d41SVaclav Hapla Not Collective 3333ea844a1aSMatthew Knepley 33342fe279fdSBarry Smith Input Parameter: 3335ea844a1aSMatthew Knepley . section - the section describing data layout 3336ea844a1aSMatthew Knepley 33372fe279fdSBarry Smith Output Parameter: 333820662ed9SBarry Smith . sym - the symmetry describing the affect of orientation on the access of the data, provided previously by `PetscSectionSetSym()` 3339ea844a1aSMatthew Knepley 3340ea844a1aSMatthew Knepley Level: developer 3341ea844a1aSMatthew Knepley 3342cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionSetSym()`, `PetscSectionSymCreate()` 3343ea844a1aSMatthew Knepley @*/ 3344d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetSym(PetscSection section, PetscSectionSym *sym) 3345d71ae5a4SJacob Faibussowitsch { 3346ea844a1aSMatthew Knepley PetscFunctionBegin; 3347ea844a1aSMatthew Knepley PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1); 3348ea844a1aSMatthew Knepley *sym = section->sym; 33493ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 3350ea844a1aSMatthew Knepley } 3351ea844a1aSMatthew Knepley 3352ea844a1aSMatthew Knepley /*@ 3353ea844a1aSMatthew Knepley PetscSectionSetFieldSym - Set the symmetries for the data referred to by a field of the section 3354ea844a1aSMatthew Knepley 335540750d41SVaclav Hapla Collective 3356ea844a1aSMatthew Knepley 3357ea844a1aSMatthew Knepley Input Parameters: 3358ea844a1aSMatthew Knepley + section - the section describing data layout 3359ea844a1aSMatthew Knepley . field - the field number 3360ea844a1aSMatthew Knepley - sym - the symmetry describing the affect of orientation on the access of the data 3361ea844a1aSMatthew Knepley 3362ea844a1aSMatthew Knepley Level: developer 3363ea844a1aSMatthew Knepley 3364cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionGetFieldSym()`, `PetscSectionSymCreate()` 3365ea844a1aSMatthew Knepley @*/ 3366d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetFieldSym(PetscSection section, PetscInt field, PetscSectionSym sym) 3367d71ae5a4SJacob Faibussowitsch { 3368ea844a1aSMatthew Knepley PetscFunctionBegin; 3369ea844a1aSMatthew Knepley PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1); 33702abc8c78SJacob Faibussowitsch PetscSectionCheckValidField(field, section->numFields); 33719566063dSJacob Faibussowitsch PetscCall(PetscSectionSetSym(section->field[field], sym)); 33723ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 3373ea844a1aSMatthew Knepley } 3374ea844a1aSMatthew Knepley 3375ea844a1aSMatthew Knepley /*@ 3376ea844a1aSMatthew Knepley PetscSectionGetFieldSym - Get the symmetries for the data referred to by a field of the section 3377ea844a1aSMatthew Knepley 337840750d41SVaclav Hapla Collective 3379ea844a1aSMatthew Knepley 3380ea844a1aSMatthew Knepley Input Parameters: 3381ea844a1aSMatthew Knepley + section - the section describing data layout 3382ea844a1aSMatthew Knepley - field - the field number 3383ea844a1aSMatthew Knepley 33842fe279fdSBarry Smith Output Parameter: 3385ea844a1aSMatthew Knepley . sym - the symmetry describing the affect of orientation on the access of the data 3386ea844a1aSMatthew Knepley 3387ea844a1aSMatthew Knepley Level: developer 3388ea844a1aSMatthew Knepley 3389cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionSetFieldSym()`, `PetscSectionSymCreate()` 3390ea844a1aSMatthew Knepley @*/ 3391d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetFieldSym(PetscSection section, PetscInt field, PetscSectionSym *sym) 3392d71ae5a4SJacob Faibussowitsch { 3393ea844a1aSMatthew Knepley PetscFunctionBegin; 3394ea844a1aSMatthew Knepley PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1); 33952abc8c78SJacob Faibussowitsch PetscSectionCheckValidField(field, section->numFields); 3396ea844a1aSMatthew Knepley *sym = section->field[field]->sym; 33973ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 3398ea844a1aSMatthew Knepley } 3399ea844a1aSMatthew Knepley 3400ea844a1aSMatthew Knepley /*@C 3401cab54364SBarry Smith PetscSectionGetPointSyms - Get the symmetries for a set of points in a `PetscSection` under specific orientations. 3402ea844a1aSMatthew Knepley 340340750d41SVaclav Hapla Not Collective 3404ea844a1aSMatthew Knepley 3405ea844a1aSMatthew Knepley Input Parameters: 3406ea844a1aSMatthew Knepley + section - the section 3407ea844a1aSMatthew Knepley . numPoints - the number of points 340820662ed9SBarry Smith - points - an array of size 2 * `numPoints`, containing a list of (point, orientation) pairs. (An orientation is an 340920662ed9SBarry Smith arbitrary integer: its interpretation is up to sym. Orientations are used by `DM`: for their interpretation in that 341020662ed9SBarry Smith context, see `DMPlexGetConeOrientation()`). 3411ea844a1aSMatthew Knepley 3412d8d19677SJose E. Roman Output Parameters: 341320662ed9SBarry Smith + perms - The permutations for the given orientations (or `NULL` if there is no symmetry or the permutation is the identity). 341420662ed9SBarry Smith - rots - The field rotations symmetries for the given orientations (or `NULL` if there is no symmetry or the rotations are all 3415ea844a1aSMatthew Knepley identity). 3416ea844a1aSMatthew Knepley 3417ea844a1aSMatthew Knepley Example of usage, gathering dofs into a local array (lArray) from a section array (sArray): 3418ea844a1aSMatthew Knepley .vb 3419ea844a1aSMatthew Knepley const PetscInt **perms; 3420ea844a1aSMatthew Knepley const PetscScalar **rots; 3421ea844a1aSMatthew Knepley PetscInt lOffset; 3422ea844a1aSMatthew Knepley 3423ea844a1aSMatthew Knepley PetscSectionGetPointSyms(section,numPoints,points,&perms,&rots); 3424ea844a1aSMatthew Knepley for (i = 0, lOffset = 0; i < numPoints; i++) { 3425ea844a1aSMatthew Knepley PetscInt point = points[2*i], dof, sOffset; 3426ea844a1aSMatthew Knepley const PetscInt *perm = perms ? perms[i] : NULL; 3427ea844a1aSMatthew Knepley const PetscScalar *rot = rots ? rots[i] : NULL; 3428ea844a1aSMatthew Knepley 3429ea844a1aSMatthew Knepley PetscSectionGetDof(section,point,&dof); 3430ea844a1aSMatthew Knepley PetscSectionGetOffset(section,point,&sOffset); 3431ea844a1aSMatthew Knepley 3432ea844a1aSMatthew Knepley if (perm) {for (j = 0; j < dof; j++) {lArray[lOffset + perm[j]] = sArray[sOffset + j];}} 3433ea844a1aSMatthew Knepley else {for (j = 0; j < dof; j++) {lArray[lOffset + j ] = sArray[sOffset + j];}} 3434ea844a1aSMatthew Knepley if (rot) {for (j = 0; j < dof; j++) {lArray[lOffset + j ] *= rot[j]; }} 3435ea844a1aSMatthew Knepley lOffset += dof; 3436ea844a1aSMatthew Knepley } 3437ea844a1aSMatthew Knepley PetscSectionRestorePointSyms(section,numPoints,points,&perms,&rots); 3438ea844a1aSMatthew Knepley .ve 3439ea844a1aSMatthew Knepley 3440ea844a1aSMatthew Knepley Example of usage, adding dofs into a section array (sArray) from a local array (lArray): 3441ea844a1aSMatthew Knepley .vb 3442ea844a1aSMatthew Knepley const PetscInt **perms; 3443ea844a1aSMatthew Knepley const PetscScalar **rots; 3444ea844a1aSMatthew Knepley PetscInt lOffset; 3445ea844a1aSMatthew Knepley 3446ea844a1aSMatthew Knepley PetscSectionGetPointSyms(section,numPoints,points,&perms,&rots); 3447ea844a1aSMatthew Knepley for (i = 0, lOffset = 0; i < numPoints; i++) { 3448ea844a1aSMatthew Knepley PetscInt point = points[2*i], dof, sOffset; 3449ea844a1aSMatthew Knepley const PetscInt *perm = perms ? perms[i] : NULL; 3450ea844a1aSMatthew Knepley const PetscScalar *rot = rots ? rots[i] : NULL; 3451ea844a1aSMatthew Knepley 3452ea844a1aSMatthew Knepley PetscSectionGetDof(section,point,&dof); 3453ea844a1aSMatthew Knepley PetscSectionGetOffset(section,point,&sOff); 3454ea844a1aSMatthew Knepley 3455ea844a1aSMatthew Knepley if (perm) {for (j = 0; j < dof; j++) {sArray[sOffset + j] += lArray[lOffset + perm[j]] * (rot ? PetscConj(rot[perm[j]]) : 1.);}} 3456ea844a1aSMatthew Knepley else {for (j = 0; j < dof; j++) {sArray[sOffset + j] += lArray[lOffset + j ] * (rot ? PetscConj(rot[ j ]) : 1.);}} 3457ea844a1aSMatthew Knepley offset += dof; 3458ea844a1aSMatthew Knepley } 3459ea844a1aSMatthew Knepley PetscSectionRestorePointSyms(section,numPoints,points,&perms,&rots); 3460ea844a1aSMatthew Knepley .ve 3461ea844a1aSMatthew Knepley 3462ea844a1aSMatthew Knepley Level: developer 3463ea844a1aSMatthew Knepley 3464583308b6SBarry Smith Notes: 346520662ed9SBarry Smith `PetscSectionSetSym()` must have been previously called to provide the symmetries to the `PetscSection` 346620662ed9SBarry Smith 346720662ed9SBarry Smith Use `PetscSectionRestorePointSyms()` when finished with the data 346820662ed9SBarry Smith 3469cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionRestorePointSyms()`, `PetscSectionSymCreate()`, `PetscSectionSetSym()`, `PetscSectionGetSym()` 3470ea844a1aSMatthew Knepley @*/ 3471d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetPointSyms(PetscSection section, PetscInt numPoints, const PetscInt *points, const PetscInt ***perms, const PetscScalar ***rots) 3472d71ae5a4SJacob Faibussowitsch { 3473ea844a1aSMatthew Knepley PetscSectionSym sym; 3474ea844a1aSMatthew Knepley 3475ea844a1aSMatthew Knepley PetscFunctionBegin; 3476ea844a1aSMatthew Knepley PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1); 34774f572ea9SToby Isaac if (numPoints) PetscAssertPointer(points, 3); 3478ea844a1aSMatthew Knepley if (perms) *perms = NULL; 3479ea844a1aSMatthew Knepley if (rots) *rots = NULL; 3480ea844a1aSMatthew Knepley sym = section->sym; 3481ea844a1aSMatthew Knepley if (sym && (perms || rots)) { 3482ea844a1aSMatthew Knepley SymWorkLink link; 3483ea844a1aSMatthew Knepley 3484ea844a1aSMatthew Knepley if (sym->workin) { 3485ea844a1aSMatthew Knepley link = sym->workin; 3486ea844a1aSMatthew Knepley sym->workin = sym->workin->next; 3487ea844a1aSMatthew Knepley } else { 34884dfa11a4SJacob Faibussowitsch PetscCall(PetscNew(&link)); 3489ea844a1aSMatthew Knepley } 3490ea844a1aSMatthew Knepley if (numPoints > link->numPoints) { 34910c99d500SBarry Smith PetscInt **perms = (PetscInt **)link->perms; 34920c99d500SBarry Smith PetscScalar **rots = (PetscScalar **)link->rots; 34930c99d500SBarry Smith PetscCall(PetscFree2(perms, rots)); 34940c99d500SBarry Smith PetscCall(PetscMalloc2(numPoints, (PetscInt ***)&link->perms, numPoints, (PetscScalar ***)&link->rots)); 3495ea844a1aSMatthew Knepley link->numPoints = numPoints; 3496ea844a1aSMatthew Knepley } 3497ea844a1aSMatthew Knepley link->next = sym->workout; 3498ea844a1aSMatthew Knepley sym->workout = link; 34999566063dSJacob Faibussowitsch PetscCall(PetscArrayzero((PetscInt **)link->perms, numPoints)); 35009566063dSJacob Faibussowitsch PetscCall(PetscArrayzero((PetscInt **)link->rots, numPoints)); 35019566063dSJacob Faibussowitsch PetscCall((*sym->ops->getpoints)(sym, section, numPoints, points, link->perms, link->rots)); 3502ea844a1aSMatthew Knepley if (perms) *perms = link->perms; 3503ea844a1aSMatthew Knepley if (rots) *rots = link->rots; 3504ea844a1aSMatthew Knepley } 35053ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 3506ea844a1aSMatthew Knepley } 3507ea844a1aSMatthew Knepley 3508ea844a1aSMatthew Knepley /*@C 3509cab54364SBarry Smith PetscSectionRestorePointSyms - Restore the symmetries returned by `PetscSectionGetPointSyms()` 3510ea844a1aSMatthew Knepley 351140750d41SVaclav Hapla Not Collective 3512ea844a1aSMatthew Knepley 3513ea844a1aSMatthew Knepley Input Parameters: 3514ea844a1aSMatthew Knepley + section - the section 3515ea844a1aSMatthew Knepley . numPoints - the number of points 351638b5cf2dSJacob Faibussowitsch . points - an array of size 2 * `numPoints`, containing a list of (point, orientation) pairs. (An orientation is an 3517cab54364SBarry Smith arbitrary integer: its interpretation is up to sym. Orientations are used by `DM`: for their interpretation in that 3518cab54364SBarry Smith context, see `DMPlexGetConeOrientation()`). 351920662ed9SBarry Smith . perms - The permutations for the given orientations: set to `NULL` at conclusion 352020662ed9SBarry Smith - rots - The field rotations symmetries for the given orientations: set to `NULL` at conclusion 3521ea844a1aSMatthew Knepley 3522ea844a1aSMatthew Knepley Level: developer 3523ea844a1aSMatthew Knepley 3524cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionGetPointSyms()`, `PetscSectionSymCreate()`, `PetscSectionSetSym()`, `PetscSectionGetSym()` 3525ea844a1aSMatthew Knepley @*/ 3526d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionRestorePointSyms(PetscSection section, PetscInt numPoints, const PetscInt *points, const PetscInt ***perms, const PetscScalar ***rots) 3527d71ae5a4SJacob Faibussowitsch { 3528ea844a1aSMatthew Knepley PetscSectionSym sym; 3529ea844a1aSMatthew Knepley 3530ea844a1aSMatthew Knepley PetscFunctionBegin; 3531ea844a1aSMatthew Knepley PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1); 3532ea844a1aSMatthew Knepley sym = section->sym; 3533ea844a1aSMatthew Knepley if (sym && (perms || rots)) { 3534ea844a1aSMatthew Knepley SymWorkLink *p, link; 3535ea844a1aSMatthew Knepley 3536ea844a1aSMatthew Knepley for (p = &sym->workout; (link = *p); p = &link->next) { 3537ea844a1aSMatthew Knepley if ((perms && link->perms == *perms) || (rots && link->rots == *rots)) { 3538ea844a1aSMatthew Knepley *p = link->next; 3539ea844a1aSMatthew Knepley link->next = sym->workin; 3540ea844a1aSMatthew Knepley sym->workin = link; 3541ea844a1aSMatthew Knepley if (perms) *perms = NULL; 3542ea844a1aSMatthew Knepley if (rots) *rots = NULL; 35433ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 3544ea844a1aSMatthew Knepley } 3545ea844a1aSMatthew Knepley } 3546ea844a1aSMatthew Knepley SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, "Array was not checked out"); 3547ea844a1aSMatthew Knepley } 35483ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 3549ea844a1aSMatthew Knepley } 3550ea844a1aSMatthew Knepley 3551ea844a1aSMatthew Knepley /*@C 3552cab54364SBarry Smith PetscSectionGetFieldPointSyms - Get the symmetries for a set of points in a field of a `PetscSection` under specific orientations. 3553ea844a1aSMatthew Knepley 355440750d41SVaclav Hapla Not Collective 3555ea844a1aSMatthew Knepley 3556ea844a1aSMatthew Knepley Input Parameters: 3557ea844a1aSMatthew Knepley + section - the section 3558ea844a1aSMatthew Knepley . field - the field of the section 3559ea844a1aSMatthew Knepley . numPoints - the number of points 356020662ed9SBarry Smith - points - an array of size 2 * `numPoints`, containing a list of (point, orientation) pairs. (An orientation is an 3561cab54364SBarry Smith arbitrary integer: its interpretation is up to sym. Orientations are used by `DM`: for their interpretation in that 3562cab54364SBarry Smith context, see `DMPlexGetConeOrientation()`). 3563ea844a1aSMatthew Knepley 3564d8d19677SJose E. Roman Output Parameters: 356520662ed9SBarry Smith + perms - The permutations for the given orientations (or `NULL` if there is no symmetry or the permutation is the identity). 356620662ed9SBarry Smith - rots - The field rotations symmetries for the given orientations (or `NULL` if there is no symmetry or the rotations are all 3567ea844a1aSMatthew Knepley identity). 3568ea844a1aSMatthew Knepley 3569ea844a1aSMatthew Knepley Level: developer 3570ea844a1aSMatthew Knepley 357120662ed9SBarry Smith Notes: 357220662ed9SBarry Smith `PetscSectionSetFieldSym()` must have been previously called to provide the symmetries to the `PetscSection` 357320662ed9SBarry Smith 357420662ed9SBarry Smith Use `PetscSectionRestoreFieldPointSyms()` when finished with the data 357520662ed9SBarry Smith 3576cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionGetPointSyms()`, `PetscSectionRestoreFieldPointSyms()` 3577ea844a1aSMatthew Knepley @*/ 3578d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetFieldPointSyms(PetscSection section, PetscInt field, PetscInt numPoints, const PetscInt *points, const PetscInt ***perms, const PetscScalar ***rots) 3579d71ae5a4SJacob Faibussowitsch { 3580ea844a1aSMatthew Knepley PetscFunctionBegin; 3581ea844a1aSMatthew Knepley PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1); 358208401ef6SPierre Jolivet PetscCheck(field <= section->numFields, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "field %" PetscInt_FMT " greater than number of fields (%" PetscInt_FMT ") in section", field, section->numFields); 35839566063dSJacob Faibussowitsch PetscCall(PetscSectionGetPointSyms(section->field[field], numPoints, points, perms, rots)); 35843ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 3585ea844a1aSMatthew Knepley } 3586ea844a1aSMatthew Knepley 3587ea844a1aSMatthew Knepley /*@C 3588cab54364SBarry Smith PetscSectionRestoreFieldPointSyms - Restore the symmetries returned by `PetscSectionGetFieldPointSyms()` 3589ea844a1aSMatthew Knepley 359040750d41SVaclav Hapla Not Collective 3591ea844a1aSMatthew Knepley 3592ea844a1aSMatthew Knepley Input Parameters: 3593ea844a1aSMatthew Knepley + section - the section 3594ea844a1aSMatthew Knepley . field - the field number 3595ea844a1aSMatthew Knepley . numPoints - the number of points 359638b5cf2dSJacob Faibussowitsch . points - an array of size 2 * `numPoints`, containing a list of (point, orientation) pairs. (An orientation is an 3597cab54364SBarry Smith arbitrary integer: its interpretation is up to sym. Orientations are used by `DM`: for their interpretation in that 3598cab54364SBarry Smith context, see `DMPlexGetConeOrientation()`). 359920662ed9SBarry Smith . perms - The permutations for the given orientations: set to NULL at conclusion 3600ea844a1aSMatthew Knepley - rots - The field rotations symmetries for the given orientations: set to NULL at conclusion 3601ea844a1aSMatthew Knepley 3602ea844a1aSMatthew Knepley Level: developer 3603ea844a1aSMatthew Knepley 3604cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionRestorePointSyms()`, `petscSectionGetFieldPointSyms()`, `PetscSectionSymCreate()`, `PetscSectionSetSym()`, `PetscSectionGetSym()` 3605ea844a1aSMatthew Knepley @*/ 3606d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionRestoreFieldPointSyms(PetscSection section, PetscInt field, PetscInt numPoints, const PetscInt *points, const PetscInt ***perms, const PetscScalar ***rots) 3607d71ae5a4SJacob Faibussowitsch { 3608ea844a1aSMatthew Knepley PetscFunctionBegin; 3609ea844a1aSMatthew Knepley PetscValidHeaderSpecific(section, PETSC_SECTION_CLASSID, 1); 361008401ef6SPierre Jolivet PetscCheck(field <= section->numFields, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "field %" PetscInt_FMT " greater than number of fields (%" PetscInt_FMT ") in section", field, section->numFields); 36119566063dSJacob Faibussowitsch PetscCall(PetscSectionRestorePointSyms(section->field[field], numPoints, points, perms, rots)); 36123ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 3613ea844a1aSMatthew Knepley } 3614ea844a1aSMatthew Knepley 3615ea844a1aSMatthew Knepley /*@ 3616b004864fSMatthew G. Knepley PetscSectionSymCopy - Copy the symmetries, assuming that the point structure is compatible 3617b004864fSMatthew G. Knepley 361840750d41SVaclav Hapla Not Collective 3619b004864fSMatthew G. Knepley 3620b004864fSMatthew G. Knepley Input Parameter: 3621cab54364SBarry Smith . sym - the `PetscSectionSym` 3622b004864fSMatthew G. Knepley 3623b004864fSMatthew G. Knepley Output Parameter: 3624b004864fSMatthew G. Knepley . nsym - the equivalent symmetries 3625b004864fSMatthew G. Knepley 3626b004864fSMatthew G. Knepley Level: developer 3627b004864fSMatthew G. Knepley 3628cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionSymCreate()`, `PetscSectionSetSym()`, `PetscSectionGetSym()`, `PetscSectionSymLabelSetStratum()`, `PetscSectionGetPointSyms()` 3629b004864fSMatthew G. Knepley @*/ 3630d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSymCopy(PetscSectionSym sym, PetscSectionSym nsym) 3631d71ae5a4SJacob Faibussowitsch { 3632b004864fSMatthew G. Knepley PetscFunctionBegin; 3633b004864fSMatthew G. Knepley PetscValidHeaderSpecific(sym, PETSC_SECTION_SYM_CLASSID, 1); 3634b004864fSMatthew G. Knepley PetscValidHeaderSpecific(nsym, PETSC_SECTION_SYM_CLASSID, 2); 3635dbbe0bcdSBarry Smith PetscTryTypeMethod(sym, copy, nsym); 36363ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 3637b004864fSMatthew G. Knepley } 3638b004864fSMatthew G. Knepley 3639b004864fSMatthew G. Knepley /*@ 3640cab54364SBarry Smith PetscSectionSymDistribute - Distribute the symmetries in accordance with the input `PetscSF` 3641b004864fSMatthew G. Knepley 3642b004864fSMatthew G. Knepley Collective 3643b004864fSMatthew G. Knepley 3644b004864fSMatthew G. Knepley Input Parameters: 3645cab54364SBarry Smith + sym - the `PetscSectionSym` 3646b004864fSMatthew G. Knepley - migrationSF - the distribution map from roots to leaves 3647b004864fSMatthew G. Knepley 36482fe279fdSBarry Smith Output Parameter: 3649b004864fSMatthew G. Knepley . dsym - the redistributed symmetries 3650b004864fSMatthew G. Knepley 3651b004864fSMatthew G. Knepley Level: developer 3652b004864fSMatthew G. Knepley 3653cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionSymCreate()`, `PetscSectionSetSym()`, `PetscSectionGetSym()`, `PetscSectionSymLabelSetStratum()`, `PetscSectionGetPointSyms()` 3654b004864fSMatthew G. Knepley @*/ 3655d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSymDistribute(PetscSectionSym sym, PetscSF migrationSF, PetscSectionSym *dsym) 3656d71ae5a4SJacob Faibussowitsch { 3657b004864fSMatthew G. Knepley PetscFunctionBegin; 3658b004864fSMatthew G. Knepley PetscValidHeaderSpecific(sym, PETSC_SECTION_SYM_CLASSID, 1); 3659b004864fSMatthew G. Knepley PetscValidHeaderSpecific(migrationSF, PETSCSF_CLASSID, 2); 36604f572ea9SToby Isaac PetscAssertPointer(dsym, 3); 3661dbbe0bcdSBarry Smith PetscTryTypeMethod(sym, distribute, migrationSF, dsym); 36623ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 3663b004864fSMatthew G. Knepley } 3664b004864fSMatthew G. Knepley 3665b004864fSMatthew G. Knepley /*@ 366620662ed9SBarry Smith PetscSectionGetUseFieldOffsets - Get the flag indicating if field offsets are used directly in a global section, rather than just the point offset 3667ea844a1aSMatthew Knepley 366840750d41SVaclav Hapla Not Collective 3669ea844a1aSMatthew Knepley 3670ea844a1aSMatthew Knepley Input Parameter: 3671cab54364SBarry Smith . s - the global `PetscSection` 3672ea844a1aSMatthew Knepley 36732fe279fdSBarry Smith Output Parameter: 3674ea844a1aSMatthew Knepley . flg - the flag 3675ea844a1aSMatthew Knepley 3676ea844a1aSMatthew Knepley Level: developer 3677ea844a1aSMatthew Knepley 3678cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionSetChart()`, `PetscSectionCreate()` 3679ea844a1aSMatthew Knepley @*/ 3680d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionGetUseFieldOffsets(PetscSection s, PetscBool *flg) 3681d71ae5a4SJacob Faibussowitsch { 3682ea844a1aSMatthew Knepley PetscFunctionBegin; 3683ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 3684ea844a1aSMatthew Knepley *flg = s->useFieldOff; 36853ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 3686ea844a1aSMatthew Knepley } 3687ea844a1aSMatthew Knepley 3688ea844a1aSMatthew Knepley /*@ 3689ea844a1aSMatthew Knepley PetscSectionSetUseFieldOffsets - Set the flag to use field offsets directly in a global section, rather than just the point offset 3690ea844a1aSMatthew Knepley 369140750d41SVaclav Hapla Not Collective 3692ea844a1aSMatthew Knepley 3693ea844a1aSMatthew Knepley Input Parameters: 3694cab54364SBarry Smith + s - the global `PetscSection` 3695ea844a1aSMatthew Knepley - flg - the flag 3696ea844a1aSMatthew Knepley 3697ea844a1aSMatthew Knepley Level: developer 3698ea844a1aSMatthew Knepley 3699cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionGetUseFieldOffsets()`, `PetscSectionSetChart()`, `PetscSectionCreate()` 3700ea844a1aSMatthew Knepley @*/ 3701d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionSetUseFieldOffsets(PetscSection s, PetscBool flg) 3702d71ae5a4SJacob Faibussowitsch { 3703ea844a1aSMatthew Knepley PetscFunctionBegin; 3704ea844a1aSMatthew Knepley PetscValidHeaderSpecific(s, PETSC_SECTION_CLASSID, 1); 3705ea844a1aSMatthew Knepley s->useFieldOff = flg; 37063ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 3707ea844a1aSMatthew Knepley } 3708ea844a1aSMatthew Knepley 3709ea844a1aSMatthew Knepley #define PetscSectionExpandPoints_Loop(TYPE) \ 3710a8f51744SPierre Jolivet do { \ 3711ea844a1aSMatthew Knepley PetscInt i, n, o0, o1, size; \ 3712ea844a1aSMatthew Knepley TYPE *a0 = (TYPE *)origArray, *a1; \ 37139566063dSJacob Faibussowitsch PetscCall(PetscSectionGetStorageSize(s, &size)); \ 37149566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(size, &a1)); \ 3715ea844a1aSMatthew Knepley for (i = 0; i < npoints; i++) { \ 37169566063dSJacob Faibussowitsch PetscCall(PetscSectionGetOffset(origSection, points_[i], &o0)); \ 37179566063dSJacob Faibussowitsch PetscCall(PetscSectionGetOffset(s, i, &o1)); \ 37189566063dSJacob Faibussowitsch PetscCall(PetscSectionGetDof(s, i, &n)); \ 37199566063dSJacob Faibussowitsch PetscCall(PetscMemcpy(&a1[o1], &a0[o0], n *unitsize)); \ 3720ea844a1aSMatthew Knepley } \ 3721ea844a1aSMatthew Knepley *newArray = (void *)a1; \ 3722a8f51744SPierre Jolivet } while (0) 3723ea844a1aSMatthew Knepley 3724ea844a1aSMatthew Knepley /*@ 3725ea844a1aSMatthew Knepley PetscSectionExtractDofsFromArray - Extracts elements of an array corresponding to DOFs of specified points. 3726ea844a1aSMatthew Knepley 372740750d41SVaclav Hapla Not Collective 3728ea844a1aSMatthew Knepley 3729ea844a1aSMatthew Knepley Input Parameters: 3730cab54364SBarry Smith + origSection - the `PetscSection` describing the layout of the array 3731cab54364SBarry Smith . dataType - `MPI_Datatype` describing the data type of the array (currently only `MPIU_INT`, `MPIU_SCALAR`, `MPIU_REAL`) 373220662ed9SBarry Smith . origArray - the array; its size must be equal to the storage size of `origSection` 373320662ed9SBarry Smith - points - `IS` with points to extract; its indices must lie in the chart of `origSection` 3734ea844a1aSMatthew Knepley 3735ea844a1aSMatthew Knepley Output Parameters: 3736da81f932SPierre Jolivet + newSection - the new `PetscSection` describing the layout of the new array (with points renumbered 0,1,... but preserving numbers of DOFs) 373720662ed9SBarry Smith - newArray - the array of the extracted DOFs; its size is the storage size of `newSection` 3738ea844a1aSMatthew Knepley 3739ea844a1aSMatthew Knepley Level: developer 3740ea844a1aSMatthew Knepley 3741cab54364SBarry Smith .seealso: [PetscSection](sec_petscsection), `PetscSectionSym`, `PetscSectionGetChart()`, `PetscSectionGetDof()`, `PetscSectionGetStorageSize()`, `PetscSectionCreate()` 3742ea844a1aSMatthew Knepley @*/ 3743d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSectionExtractDofsFromArray(PetscSection origSection, MPI_Datatype dataType, const void *origArray, IS points, PetscSection *newSection, void *newArray[]) 3744d71ae5a4SJacob Faibussowitsch { 3745ea844a1aSMatthew Knepley PetscSection s; 3746ea844a1aSMatthew Knepley const PetscInt *points_; 3747ea844a1aSMatthew Knepley PetscInt i, n, npoints, pStart, pEnd; 3748ea844a1aSMatthew Knepley PetscMPIInt unitsize; 3749ea844a1aSMatthew Knepley 3750ea844a1aSMatthew Knepley PetscFunctionBegin; 3751ea844a1aSMatthew Knepley PetscValidHeaderSpecific(origSection, PETSC_SECTION_CLASSID, 1); 37524f572ea9SToby Isaac PetscAssertPointer(origArray, 3); 3753ea844a1aSMatthew Knepley PetscValidHeaderSpecific(points, IS_CLASSID, 4); 37544f572ea9SToby Isaac if (newSection) PetscAssertPointer(newSection, 5); 37554f572ea9SToby Isaac if (newArray) PetscAssertPointer(newArray, 6); 37569566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_size(dataType, &unitsize)); 37579566063dSJacob Faibussowitsch PetscCall(ISGetLocalSize(points, &npoints)); 37589566063dSJacob Faibussowitsch PetscCall(ISGetIndices(points, &points_)); 37599566063dSJacob Faibussowitsch PetscCall(PetscSectionGetChart(origSection, &pStart, &pEnd)); 37609566063dSJacob Faibussowitsch PetscCall(PetscSectionCreate(PETSC_COMM_SELF, &s)); 37619566063dSJacob Faibussowitsch PetscCall(PetscSectionSetChart(s, 0, npoints)); 3762ea844a1aSMatthew Knepley for (i = 0; i < npoints; i++) { 3763c9cc58a2SBarry Smith PetscCheck(points_[i] >= pStart && points_[i] < pEnd, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "point %" PetscInt_FMT " (index %" PetscInt_FMT ") in input IS out of input section's chart", points_[i], i); 37649566063dSJacob Faibussowitsch PetscCall(PetscSectionGetDof(origSection, points_[i], &n)); 37659566063dSJacob Faibussowitsch PetscCall(PetscSectionSetDof(s, i, n)); 3766ea844a1aSMatthew Knepley } 37679566063dSJacob Faibussowitsch PetscCall(PetscSectionSetUp(s)); 3768ea844a1aSMatthew Knepley if (newArray) { 37699371c9d4SSatish Balay if (dataType == MPIU_INT) { 37709371c9d4SSatish Balay PetscSectionExpandPoints_Loop(PetscInt); 37719371c9d4SSatish Balay } else if (dataType == MPIU_SCALAR) { 37729371c9d4SSatish Balay PetscSectionExpandPoints_Loop(PetscScalar); 37739371c9d4SSatish Balay } else if (dataType == MPIU_REAL) { 37749371c9d4SSatish Balay PetscSectionExpandPoints_Loop(PetscReal); 37759371c9d4SSatish Balay } else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SUP, "not implemented for this MPI_Datatype"); 3776ea844a1aSMatthew Knepley } 3777ea844a1aSMatthew Knepley if (newSection) { 3778ea844a1aSMatthew Knepley *newSection = s; 3779ea844a1aSMatthew Knepley } else { 37809566063dSJacob Faibussowitsch PetscCall(PetscSectionDestroy(&s)); 3781ea844a1aSMatthew Knepley } 37829566063dSJacob Faibussowitsch PetscCall(ISRestoreIndices(points, &points_)); 37833ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 3784ea844a1aSMatthew Knepley } 3785