xref: /petsc/src/dm/interface/dm.c (revision 4c1069a6f7e44f78d90b41175756006e76a04441)
1af0996ceSBarry Smith #include <petsc/private/dmimpl.h>           /*I      "petscdm.h"          I*/
2c58f1c22SToby Isaac #include <petsc/private/dmlabelimpl.h>      /*I      "petscdmlabel.h"     I*/
30c312b8eSJed Brown #include <petscsf.h>
42764a2aaSMatthew G. Knepley #include <petscds.h>
547c6ae99SBarry Smith 
6732e2eb9SMatthew G Knepley PetscClassId  DM_CLASSID;
73ad4599aSBarry Smith PetscLogEvent DM_Convert, DM_GlobalToLocal, DM_LocalToGlobal, DM_LocalToLocal, DM_LocatePoints, DM_Coarsen, DM_CreateInterpolation, DM_CreateRestriction;
867a56275SMatthew G Knepley 
9bff4a2f0SMatthew G. Knepley const char *const DMBoundaryTypes[] = {"NONE","GHOSTED","MIRROR","PERIODIC","TWIST","DM_BOUNDARY_",0};
10bff4a2f0SMatthew G. Knepley 
1147c6ae99SBarry Smith #undef __FUNCT__
12a4121054SBarry Smith #define __FUNCT__ "DMCreate"
13a4121054SBarry Smith /*@
14de043629SMatthew G Knepley   DMCreate - Creates an empty DM object. The type can then be set with DMSetType().
15a4121054SBarry Smith 
16a4121054SBarry Smith    If you never  call DMSetType()  it will generate an
17a4121054SBarry Smith    error when you try to use the vector.
18a4121054SBarry Smith 
19a4121054SBarry Smith   Collective on MPI_Comm
20a4121054SBarry Smith 
21a4121054SBarry Smith   Input Parameter:
22a4121054SBarry Smith . comm - The communicator for the DM object
23a4121054SBarry Smith 
24a4121054SBarry Smith   Output Parameter:
25a4121054SBarry Smith . dm - The DM object
26a4121054SBarry Smith 
27a4121054SBarry Smith   Level: beginner
28a4121054SBarry Smith 
298472ad0fSDave May .seealso: DMSetType(), DMDA, DMSLICED, DMCOMPOSITE, DMPLEX, DMMOAB, DMNETWORK
30a4121054SBarry Smith @*/
317087cfbeSBarry Smith PetscErrorCode  DMCreate(MPI_Comm comm,DM *dm)
32a4121054SBarry Smith {
33a4121054SBarry Smith   DM             v;
34a4121054SBarry Smith   PetscErrorCode ierr;
35a4121054SBarry Smith 
36a4121054SBarry Smith   PetscFunctionBegin;
371411c6eeSJed Brown   PetscValidPointer(dm,2);
380298fd71SBarry Smith   *dm = NULL;
398b984314SMatthew G. Knepley   ierr = PetscSysInitializePackage();CHKERRQ(ierr);
40607a6623SBarry Smith   ierr = VecInitializePackage();CHKERRQ(ierr);
41607a6623SBarry Smith   ierr = MatInitializePackage();CHKERRQ(ierr);
42607a6623SBarry Smith   ierr = DMInitializePackage();CHKERRQ(ierr);
43a4121054SBarry Smith 
4473107ff1SLisandro Dalcin   ierr = PetscHeaderCreate(v, DM_CLASSID, "DM", "Distribution Manager", "DM", comm, DMDestroy, DMView);CHKERRQ(ierr);
45e7c4fc90SDmitry Karpeev 
460298fd71SBarry Smith   v->ltogmap                  = NULL;
471411c6eeSJed Brown   v->bs                       = 1;
48171400e9SBarry Smith   v->coloringtype             = IS_COLORING_GLOBAL;
4988ed4aceSMatthew G Knepley   ierr                        = PetscSFCreate(comm, &v->sf);CHKERRQ(ierr);
5088ed4aceSMatthew G Knepley   ierr                        = PetscSFCreate(comm, &v->defaultSF);CHKERRQ(ierr);
51c58f1c22SToby Isaac   v->labels                   = NULL;
52c58f1c22SToby Isaac   v->depthLabel               = NULL;
530298fd71SBarry Smith   v->defaultSection           = NULL;
540298fd71SBarry Smith   v->defaultGlobalSection     = NULL;
55fba222abSToby Isaac   v->defaultConstraintSection = NULL;
56fba222abSToby Isaac   v->defaultConstraintMat     = NULL;
57c6b900c6SMatthew G. Knepley   v->L                        = NULL;
58c6b900c6SMatthew G. Knepley   v->maxCell                  = NULL;
595dc8c3f7SMatthew G. Knepley   v->bdtype                   = NULL;
609a9a41abSToby Isaac   v->dimEmbed                 = PETSC_DEFAULT;
61435a35e8SMatthew G Knepley   {
62435a35e8SMatthew G Knepley     PetscInt i;
63435a35e8SMatthew G Knepley     for (i = 0; i < 10; ++i) {
640298fd71SBarry Smith       v->nullspaceConstructors[i] = NULL;
65435a35e8SMatthew G Knepley     }
66435a35e8SMatthew G Knepley   }
672764a2aaSMatthew G. Knepley   ierr = PetscDSCreate(comm, &v->prob);CHKERRQ(ierr);
6814f150ffSMatthew G. Knepley   v->dmBC = NULL;
69a8fb8f29SToby Isaac   v->coarseMesh = NULL;
70f4d763aaSMatthew G. Knepley   v->outputSequenceNum = -1;
71cdb7a50dSMatthew G. Knepley   v->outputSequenceVal = 0.0;
72c0dedaeaSBarry Smith   ierr = DMSetVecType(v,VECSTANDARD);CHKERRQ(ierr);
73b412c318SBarry Smith   ierr = DMSetMatType(v,MATAIJ);CHKERRQ(ierr);
74bcc5ffd9SToby Isaac   ierr = PetscNew(&(v->labels));CHKERRQ(ierr);
75c58f1c22SToby Isaac   v->labels->refct = 1;
76bcc5ffd9SToby Isaac   ierr = PetscNew(&(v->boundary));CHKERRQ(ierr);
77bcc5ffd9SToby Isaac   v->boundary->refct = 1;
781411c6eeSJed Brown   *dm = v;
79a4121054SBarry Smith   PetscFunctionReturn(0);
80a4121054SBarry Smith }
81a4121054SBarry Smith 
82a4121054SBarry Smith #undef __FUNCT__
8338221697SMatthew G. Knepley #define __FUNCT__ "DMClone"
8438221697SMatthew G. Knepley /*@
8538221697SMatthew G. Knepley   DMClone - Creates a DM object with the same topology as the original.
8638221697SMatthew G. Knepley 
8738221697SMatthew G. Knepley   Collective on MPI_Comm
8838221697SMatthew G. Knepley 
8938221697SMatthew G. Knepley   Input Parameter:
9038221697SMatthew G. Knepley . dm - The original DM object
9138221697SMatthew G. Knepley 
9238221697SMatthew G. Knepley   Output Parameter:
9338221697SMatthew G. Knepley . newdm  - The new DM object
9438221697SMatthew G. Knepley 
9538221697SMatthew G. Knepley   Level: beginner
9638221697SMatthew G. Knepley 
9738221697SMatthew G. Knepley .keywords: DM, topology, create
9838221697SMatthew G. Knepley @*/
9938221697SMatthew G. Knepley PetscErrorCode DMClone(DM dm, DM *newdm)
10038221697SMatthew G. Knepley {
10138221697SMatthew G. Knepley   PetscSF        sf;
10238221697SMatthew G. Knepley   Vec            coords;
10338221697SMatthew G. Knepley   void          *ctx;
1041de53e9aSMatthew G. Knepley   PetscInt       dim;
10538221697SMatthew G. Knepley   PetscErrorCode ierr;
10638221697SMatthew G. Knepley 
10738221697SMatthew G. Knepley   PetscFunctionBegin;
10838221697SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
10938221697SMatthew G. Knepley   PetscValidPointer(newdm,2);
11038221697SMatthew G. Knepley   ierr = DMCreate(PetscObjectComm((PetscObject) dm), newdm);CHKERRQ(ierr);
111c58f1c22SToby Isaac   ierr = PetscFree((*newdm)->labels);CHKERRQ(ierr);
112c58f1c22SToby Isaac   dm->labels->refct++;
113c58f1c22SToby Isaac   (*newdm)->labels = dm->labels;
114c58f1c22SToby Isaac   (*newdm)->depthLabel = dm->depthLabel;
1151de53e9aSMatthew G. Knepley   ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr);
1161de53e9aSMatthew G. Knepley   ierr = DMSetDimension(*newdm, dim);CHKERRQ(ierr);
11738221697SMatthew G. Knepley   if (dm->ops->clone) {
11838221697SMatthew G. Knepley     ierr = (*dm->ops->clone)(dm, newdm);CHKERRQ(ierr);
11938221697SMatthew G. Knepley   }
1203f22bcbcSToby Isaac   (*newdm)->setupcalled = dm->setupcalled;
12138221697SMatthew G. Knepley   ierr = DMGetPointSF(dm, &sf);CHKERRQ(ierr);
12238221697SMatthew G. Knepley   ierr = DMSetPointSF(*newdm, sf);CHKERRQ(ierr);
12338221697SMatthew G. Knepley   ierr = DMGetApplicationContext(dm, &ctx);CHKERRQ(ierr);
12438221697SMatthew G. Knepley   ierr = DMSetApplicationContext(*newdm, ctx);CHKERRQ(ierr);
125be4c1c3eSMatthew G. Knepley   if (dm->coordinateDM) {
126be4c1c3eSMatthew G. Knepley     DM           ncdm;
127be4c1c3eSMatthew G. Knepley     PetscSection cs;
1285a0206caSToby Isaac     PetscInt     pEnd = -1, pEndMax = -1;
129be4c1c3eSMatthew G. Knepley 
130be4c1c3eSMatthew G. Knepley     ierr = DMGetDefaultSection(dm->coordinateDM, &cs);CHKERRQ(ierr);
131be4c1c3eSMatthew G. Knepley     if (cs) {ierr = PetscSectionGetChart(cs, NULL, &pEnd);CHKERRQ(ierr);}
1325a0206caSToby Isaac     ierr = MPI_Allreduce(&pEnd,&pEndMax,1,MPIU_INT,MPI_MAX,PetscObjectComm((PetscObject)dm));CHKERRQ(ierr);
1335a0206caSToby Isaac     if (pEndMax >= 0) {
134be4c1c3eSMatthew G. Knepley       ierr = DMClone(dm->coordinateDM, &ncdm);CHKERRQ(ierr);
13513bffc4cSMatthew G. Knepley       ierr = DMSetDefaultSection(ncdm, cs);CHKERRQ(ierr);
136a61e840bSMatthew G. Knepley       ierr = DMSetCoordinateDM(*newdm, ncdm);CHKERRQ(ierr);
137be4c1c3eSMatthew G. Knepley       ierr = DMDestroy(&ncdm);CHKERRQ(ierr);
138be4c1c3eSMatthew G. Knepley     }
139be4c1c3eSMatthew G. Knepley   }
14038221697SMatthew G. Knepley   ierr = DMGetCoordinatesLocal(dm, &coords);CHKERRQ(ierr);
14138221697SMatthew G. Knepley   if (coords) {
14238221697SMatthew G. Knepley     ierr = DMSetCoordinatesLocal(*newdm, coords);CHKERRQ(ierr);
14338221697SMatthew G. Knepley   } else {
14438221697SMatthew G. Knepley     ierr = DMGetCoordinates(dm, &coords);CHKERRQ(ierr);
14538221697SMatthew G. Knepley     if (coords) {ierr = DMSetCoordinates(*newdm, coords);CHKERRQ(ierr);}
14638221697SMatthew G. Knepley   }
147c6b900c6SMatthew G. Knepley   if (dm->maxCell) {
148c6b900c6SMatthew G. Knepley     const PetscReal *maxCell, *L;
1495dc8c3f7SMatthew G. Knepley     const DMBoundaryType *bd;
1505dc8c3f7SMatthew G. Knepley     ierr = DMGetPeriodicity(dm,     &maxCell, &L, &bd);CHKERRQ(ierr);
1515dc8c3f7SMatthew G. Knepley     ierr = DMSetPeriodicity(*newdm,  maxCell,  L,  bd);CHKERRQ(ierr);
152c6b900c6SMatthew G. Knepley   }
15338221697SMatthew G. Knepley   PetscFunctionReturn(0);
15438221697SMatthew G. Knepley }
15538221697SMatthew G. Knepley 
15638221697SMatthew G. Knepley #undef __FUNCT__
1579a42bb27SBarry Smith #define __FUNCT__ "DMSetVecType"
1589a42bb27SBarry Smith /*@C
159564755cdSBarry Smith        DMSetVecType - Sets the type of vector created with DMCreateLocalVector() and DMCreateGlobalVector()
1609a42bb27SBarry Smith 
1618472ad0fSDave May    Logically Collective on DM
1629a42bb27SBarry Smith 
1639a42bb27SBarry Smith    Input Parameter:
1649a42bb27SBarry Smith +  da - initial distributed array
1658154be41SBarry Smith .  ctype - the vector type, currently either VECSTANDARD or VECCUSP
1669a42bb27SBarry Smith 
1679a42bb27SBarry Smith    Options Database:
168dd85299cSBarry Smith .   -dm_vec_type ctype
1699a42bb27SBarry Smith 
1709a42bb27SBarry Smith    Level: intermediate
1719a42bb27SBarry Smith 
1728472ad0fSDave May .seealso: DMCreate(), DMDestroy(), DM, DMDAInterpolationType, VecType, DMGetVecType()
1739a42bb27SBarry Smith @*/
17419fd82e9SBarry Smith PetscErrorCode  DMSetVecType(DM da,VecType ctype)
1759a42bb27SBarry Smith {
1769a42bb27SBarry Smith   PetscErrorCode ierr;
1779a42bb27SBarry Smith 
1789a42bb27SBarry Smith   PetscFunctionBegin;
1799a42bb27SBarry Smith   PetscValidHeaderSpecific(da,DM_CLASSID,1);
1809a42bb27SBarry Smith   ierr = PetscFree(da->vectype);CHKERRQ(ierr);
18119fd82e9SBarry Smith   ierr = PetscStrallocpy(ctype,(char**)&da->vectype);CHKERRQ(ierr);
1829a42bb27SBarry Smith   PetscFunctionReturn(0);
1839a42bb27SBarry Smith }
1849a42bb27SBarry Smith 
1859a42bb27SBarry Smith #undef __FUNCT__
186c0dedaeaSBarry Smith #define __FUNCT__ "DMGetVecType"
187c0dedaeaSBarry Smith /*@C
188c0dedaeaSBarry Smith        DMGetVecType - Gets the type of vector created with DMCreateLocalVector() and DMCreateGlobalVector()
189c0dedaeaSBarry Smith 
1908472ad0fSDave May    Logically Collective on DM
191c0dedaeaSBarry Smith 
192c0dedaeaSBarry Smith    Input Parameter:
193c0dedaeaSBarry Smith .  da - initial distributed array
194c0dedaeaSBarry Smith 
195c0dedaeaSBarry Smith    Output Parameter:
196c0dedaeaSBarry Smith .  ctype - the vector type
197c0dedaeaSBarry Smith 
198c0dedaeaSBarry Smith    Level: intermediate
199c0dedaeaSBarry Smith 
2008472ad0fSDave May .seealso: DMCreate(), DMDestroy(), DM, DMDAInterpolationType, VecType
201c0dedaeaSBarry Smith @*/
202c0dedaeaSBarry Smith PetscErrorCode  DMGetVecType(DM da,VecType *ctype)
203c0dedaeaSBarry Smith {
204c0dedaeaSBarry Smith   PetscFunctionBegin;
205c0dedaeaSBarry Smith   PetscValidHeaderSpecific(da,DM_CLASSID,1);
206c0dedaeaSBarry Smith   *ctype = da->vectype;
207c0dedaeaSBarry Smith   PetscFunctionReturn(0);
208c0dedaeaSBarry Smith }
209c0dedaeaSBarry Smith 
210c0dedaeaSBarry Smith #undef __FUNCT__
2115f1ad066SMatthew G Knepley #define __FUNCT__ "VecGetDM"
2125f1ad066SMatthew G Knepley /*@
21334f98d34SBarry Smith   VecGetDM - Gets the DM defining the data layout of the vector
2145f1ad066SMatthew G Knepley 
2155f1ad066SMatthew G Knepley   Not collective
2165f1ad066SMatthew G Knepley 
2175f1ad066SMatthew G Knepley   Input Parameter:
2185f1ad066SMatthew G Knepley . v - The Vec
2195f1ad066SMatthew G Knepley 
2205f1ad066SMatthew G Knepley   Output Parameter:
2215f1ad066SMatthew G Knepley . dm - The DM
2225f1ad066SMatthew G Knepley 
2235f1ad066SMatthew G Knepley   Level: intermediate
2245f1ad066SMatthew G Knepley 
2255f1ad066SMatthew G Knepley .seealso: VecSetDM(), DMGetLocalVector(), DMGetGlobalVector(), DMSetVecType()
2265f1ad066SMatthew G Knepley @*/
2275f1ad066SMatthew G Knepley PetscErrorCode VecGetDM(Vec v, DM *dm)
2285f1ad066SMatthew G Knepley {
2295f1ad066SMatthew G Knepley   PetscErrorCode ierr;
2305f1ad066SMatthew G Knepley 
2315f1ad066SMatthew G Knepley   PetscFunctionBegin;
2325f1ad066SMatthew G Knepley   PetscValidHeaderSpecific(v,VEC_CLASSID,1);
2335f1ad066SMatthew G Knepley   PetscValidPointer(dm,2);
2345f1ad066SMatthew G Knepley   ierr = PetscObjectQuery((PetscObject) v, "__PETSc_dm", (PetscObject*) dm);CHKERRQ(ierr);
2355f1ad066SMatthew G Knepley   PetscFunctionReturn(0);
2365f1ad066SMatthew G Knepley }
2375f1ad066SMatthew G Knepley 
2385f1ad066SMatthew G Knepley #undef __FUNCT__
2395f1ad066SMatthew G Knepley #define __FUNCT__ "VecSetDM"
2405f1ad066SMatthew G Knepley /*@
241d9805387SMatthew G. Knepley   VecSetDM - Sets the DM defining the data layout of the vector.
2425f1ad066SMatthew G Knepley 
2435f1ad066SMatthew G Knepley   Not collective
2445f1ad066SMatthew G Knepley 
2455f1ad066SMatthew G Knepley   Input Parameters:
2465f1ad066SMatthew G Knepley + v - The Vec
2475f1ad066SMatthew G Knepley - dm - The DM
2485f1ad066SMatthew G Knepley 
249d9805387SMatthew G. Knepley   Note: This is NOT the same as DMCreateGlobalVector() since it does not change the view methods or perform other customization, but merely sets the DM member.
250d9805387SMatthew G. Knepley 
2515f1ad066SMatthew G Knepley   Level: intermediate
2525f1ad066SMatthew G Knepley 
2535f1ad066SMatthew G Knepley .seealso: VecGetDM(), DMGetLocalVector(), DMGetGlobalVector(), DMSetVecType()
2545f1ad066SMatthew G Knepley @*/
2555f1ad066SMatthew G Knepley PetscErrorCode VecSetDM(Vec v, DM dm)
2565f1ad066SMatthew G Knepley {
2575f1ad066SMatthew G Knepley   PetscErrorCode ierr;
2585f1ad066SMatthew G Knepley 
2595f1ad066SMatthew G Knepley   PetscFunctionBegin;
2605f1ad066SMatthew G Knepley   PetscValidHeaderSpecific(v,VEC_CLASSID,1);
261d7f50e27SLisandro Dalcin   if (dm) PetscValidHeaderSpecific(dm,DM_CLASSID,2);
2625f1ad066SMatthew G Knepley   ierr = PetscObjectCompose((PetscObject) v, "__PETSc_dm", (PetscObject) dm);CHKERRQ(ierr);
2635f1ad066SMatthew G Knepley   PetscFunctionReturn(0);
2645f1ad066SMatthew G Knepley }
2655f1ad066SMatthew G Knepley 
2665f1ad066SMatthew G Knepley #undef __FUNCT__
267521d9a4cSLisandro Dalcin #define __FUNCT__ "DMSetMatType"
268521d9a4cSLisandro Dalcin /*@C
269521d9a4cSLisandro Dalcin        DMSetMatType - Sets the type of matrix created with DMCreateMatrix()
270521d9a4cSLisandro Dalcin 
271521d9a4cSLisandro Dalcin    Logically Collective on DM
272521d9a4cSLisandro Dalcin 
273521d9a4cSLisandro Dalcin    Input Parameter:
274521d9a4cSLisandro Dalcin +  dm - the DM context
275521d9a4cSLisandro Dalcin .  ctype - the matrix type
276521d9a4cSLisandro Dalcin 
277521d9a4cSLisandro Dalcin    Options Database:
278521d9a4cSLisandro Dalcin .   -dm_mat_type ctype
279521d9a4cSLisandro Dalcin 
280521d9a4cSLisandro Dalcin    Level: intermediate
281521d9a4cSLisandro Dalcin 
282c0dedaeaSBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMGetMatType()
283521d9a4cSLisandro Dalcin @*/
28419fd82e9SBarry Smith PetscErrorCode  DMSetMatType(DM dm,MatType ctype)
285521d9a4cSLisandro Dalcin {
286521d9a4cSLisandro Dalcin   PetscErrorCode ierr;
28788f0584fSBarry Smith 
288521d9a4cSLisandro Dalcin   PetscFunctionBegin;
289521d9a4cSLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
290521d9a4cSLisandro Dalcin   ierr = PetscFree(dm->mattype);CHKERRQ(ierr);
29119fd82e9SBarry Smith   ierr = PetscStrallocpy(ctype,(char**)&dm->mattype);CHKERRQ(ierr);
292521d9a4cSLisandro Dalcin   PetscFunctionReturn(0);
293521d9a4cSLisandro Dalcin }
294521d9a4cSLisandro Dalcin 
295521d9a4cSLisandro Dalcin #undef __FUNCT__
296c0dedaeaSBarry Smith #define __FUNCT__ "DMGetMatType"
297c0dedaeaSBarry Smith /*@C
298c0dedaeaSBarry Smith        DMGetMatType - Gets the type of matrix created with DMCreateMatrix()
299c0dedaeaSBarry Smith 
300c0dedaeaSBarry Smith    Logically Collective on DM
301c0dedaeaSBarry Smith 
302c0dedaeaSBarry Smith    Input Parameter:
303c0dedaeaSBarry Smith .  dm - the DM context
304c0dedaeaSBarry Smith 
305c0dedaeaSBarry Smith    Output Parameter:
306c0dedaeaSBarry Smith .  ctype - the matrix type
307c0dedaeaSBarry Smith 
308c0dedaeaSBarry Smith    Options Database:
309c0dedaeaSBarry Smith .   -dm_mat_type ctype
310c0dedaeaSBarry Smith 
311c0dedaeaSBarry Smith    Level: intermediate
312c0dedaeaSBarry Smith 
313c0dedaeaSBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMSetMatType()
314c0dedaeaSBarry Smith @*/
315c0dedaeaSBarry Smith PetscErrorCode  DMGetMatType(DM dm,MatType *ctype)
316c0dedaeaSBarry Smith {
317c0dedaeaSBarry Smith   PetscFunctionBegin;
318c0dedaeaSBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
319c0dedaeaSBarry Smith   *ctype = dm->mattype;
320c0dedaeaSBarry Smith   PetscFunctionReturn(0);
321c0dedaeaSBarry Smith }
322c0dedaeaSBarry Smith 
323c0dedaeaSBarry Smith #undef __FUNCT__
324c688c046SMatthew G Knepley #define __FUNCT__ "MatGetDM"
325c688c046SMatthew G Knepley /*@
32634f98d34SBarry Smith   MatGetDM - Gets the DM defining the data layout of the matrix
327c688c046SMatthew G Knepley 
328c688c046SMatthew G Knepley   Not collective
329c688c046SMatthew G Knepley 
330c688c046SMatthew G Knepley   Input Parameter:
331c688c046SMatthew G Knepley . A - The Mat
332c688c046SMatthew G Knepley 
333c688c046SMatthew G Knepley   Output Parameter:
334c688c046SMatthew G Knepley . dm - The DM
335c688c046SMatthew G Knepley 
336c688c046SMatthew G Knepley   Level: intermediate
337c688c046SMatthew G Knepley 
338c688c046SMatthew G Knepley .seealso: MatSetDM(), DMCreateMatrix(), DMSetMatType()
339c688c046SMatthew G Knepley @*/
340c688c046SMatthew G Knepley PetscErrorCode MatGetDM(Mat A, DM *dm)
341c688c046SMatthew G Knepley {
342c688c046SMatthew G Knepley   PetscErrorCode ierr;
343c688c046SMatthew G Knepley 
344c688c046SMatthew G Knepley   PetscFunctionBegin;
345c688c046SMatthew G Knepley   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
346c688c046SMatthew G Knepley   PetscValidPointer(dm,2);
347c688c046SMatthew G Knepley   ierr = PetscObjectQuery((PetscObject) A, "__PETSc_dm", (PetscObject*) dm);CHKERRQ(ierr);
348c688c046SMatthew G Knepley   PetscFunctionReturn(0);
349c688c046SMatthew G Knepley }
350c688c046SMatthew G Knepley 
351c688c046SMatthew G Knepley #undef __FUNCT__
352c688c046SMatthew G Knepley #define __FUNCT__ "MatSetDM"
353c688c046SMatthew G Knepley /*@
354c688c046SMatthew G Knepley   MatSetDM - Sets the DM defining the data layout of the matrix
355c688c046SMatthew G Knepley 
356c688c046SMatthew G Knepley   Not collective
357c688c046SMatthew G Knepley 
358c688c046SMatthew G Knepley   Input Parameters:
359c688c046SMatthew G Knepley + A - The Mat
360c688c046SMatthew G Knepley - dm - The DM
361c688c046SMatthew G Knepley 
362c688c046SMatthew G Knepley   Level: intermediate
363c688c046SMatthew G Knepley 
364c688c046SMatthew G Knepley .seealso: MatGetDM(), DMCreateMatrix(), DMSetMatType()
365c688c046SMatthew G Knepley @*/
366c688c046SMatthew G Knepley PetscErrorCode MatSetDM(Mat A, DM dm)
367c688c046SMatthew G Knepley {
368c688c046SMatthew G Knepley   PetscErrorCode ierr;
369c688c046SMatthew G Knepley 
370c688c046SMatthew G Knepley   PetscFunctionBegin;
371c688c046SMatthew G Knepley   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
3728865f1eaSKarl Rupp   if (dm) PetscValidHeaderSpecific(dm,DM_CLASSID,2);
373c688c046SMatthew G Knepley   ierr = PetscObjectCompose((PetscObject) A, "__PETSc_dm", (PetscObject) dm);CHKERRQ(ierr);
374c688c046SMatthew G Knepley   PetscFunctionReturn(0);
375c688c046SMatthew G Knepley }
376c688c046SMatthew G Knepley 
377c688c046SMatthew G Knepley #undef __FUNCT__
3789a42bb27SBarry Smith #define __FUNCT__ "DMSetOptionsPrefix"
3799a42bb27SBarry Smith /*@C
3809a42bb27SBarry Smith    DMSetOptionsPrefix - Sets the prefix used for searching for all
3816757b960SDave May    DM options in the database.
3829a42bb27SBarry Smith 
3838353ddbbSDave May    Logically Collective on DM
3849a42bb27SBarry Smith 
3859a42bb27SBarry Smith    Input Parameter:
3868353ddbbSDave May +  da - the DM context
3879a42bb27SBarry Smith -  prefix - the prefix to prepend to all option names
3889a42bb27SBarry Smith 
3899a42bb27SBarry Smith    Notes:
3909a42bb27SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
3919a42bb27SBarry Smith    The first character of all runtime options is AUTOMATICALLY the hyphen.
3929a42bb27SBarry Smith 
3939a42bb27SBarry Smith    Level: advanced
3949a42bb27SBarry Smith 
3958353ddbbSDave May .keywords: DM, set, options, prefix, database
3969a42bb27SBarry Smith 
3979a42bb27SBarry Smith .seealso: DMSetFromOptions()
3989a42bb27SBarry Smith @*/
3997087cfbeSBarry Smith PetscErrorCode  DMSetOptionsPrefix(DM dm,const char prefix[])
4009a42bb27SBarry Smith {
4019a42bb27SBarry Smith   PetscErrorCode ierr;
4029a42bb27SBarry Smith 
4039a42bb27SBarry Smith   PetscFunctionBegin;
4049a42bb27SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
4059a42bb27SBarry Smith   ierr = PetscObjectSetOptionsPrefix((PetscObject)dm,prefix);CHKERRQ(ierr);
406691be533SLawrence Mitchell   if (dm->sf) {
407691be533SLawrence Mitchell     ierr = PetscObjectSetOptionsPrefix((PetscObject)dm->sf,prefix);CHKERRQ(ierr);
408691be533SLawrence Mitchell   }
409691be533SLawrence Mitchell   if (dm->defaultSF) {
410691be533SLawrence Mitchell     ierr = PetscObjectSetOptionsPrefix((PetscObject)dm->defaultSF,prefix);CHKERRQ(ierr);
411691be533SLawrence Mitchell   }
4129a42bb27SBarry Smith   PetscFunctionReturn(0);
4139a42bb27SBarry Smith }
4149a42bb27SBarry Smith 
4159a42bb27SBarry Smith #undef __FUNCT__
41631697293SDave May #define __FUNCT__ "DMAppendOptionsPrefix"
41731697293SDave May /*@C
41831697293SDave May    DMAppendOptionsPrefix - Appends to the prefix used for searching for all
41931697293SDave May    DM options in the database.
42031697293SDave May 
42131697293SDave May    Logically Collective on DM
42231697293SDave May 
42331697293SDave May    Input Parameters:
42431697293SDave May +  dm - the DM context
42531697293SDave May -  prefix - the prefix string to prepend to all DM option requests
42631697293SDave May 
42731697293SDave May    Notes:
42831697293SDave May    A hyphen (-) must NOT be given at the beginning of the prefix name.
42931697293SDave May    The first character of all runtime options is AUTOMATICALLY the hyphen.
43031697293SDave May 
43131697293SDave May    Level: advanced
43231697293SDave May 
43331697293SDave May .keywords: DM, append, options, prefix, database
43431697293SDave May 
43531697293SDave May .seealso: DMSetOptionsPrefix(), DMGetOptionsPrefix()
43631697293SDave May @*/
43731697293SDave May PetscErrorCode  DMAppendOptionsPrefix(DM dm,const char prefix[])
43831697293SDave May {
43931697293SDave May   PetscErrorCode ierr;
44031697293SDave May 
44131697293SDave May   PetscFunctionBegin;
44231697293SDave May   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
44331697293SDave May   ierr = PetscObjectAppendOptionsPrefix((PetscObject)dm,prefix);CHKERRQ(ierr);
44431697293SDave May   PetscFunctionReturn(0);
44531697293SDave May }
44631697293SDave May 
44731697293SDave May #undef __FUNCT__
44831697293SDave May #define __FUNCT__ "DMGetOptionsPrefix"
44931697293SDave May /*@C
45031697293SDave May    DMGetOptionsPrefix - Gets the prefix used for searching for all
45131697293SDave May    DM options in the database.
45231697293SDave May 
45331697293SDave May    Not Collective
45431697293SDave May 
45531697293SDave May    Input Parameters:
45631697293SDave May .  dm - the DM context
45731697293SDave May 
45831697293SDave May    Output Parameters:
45931697293SDave May .  prefix - pointer to the prefix string used is returned
46031697293SDave May 
46131697293SDave May    Notes: On the fortran side, the user should pass in a string 'prefix' of
46231697293SDave May    sufficient length to hold the prefix.
46331697293SDave May 
46431697293SDave May    Level: advanced
46531697293SDave May 
46631697293SDave May .keywords: DM, set, options, prefix, database
46731697293SDave May 
46831697293SDave May .seealso: DMSetOptionsPrefix(), DMAppendOptionsPrefix()
46931697293SDave May @*/
47031697293SDave May PetscErrorCode  DMGetOptionsPrefix(DM dm,const char *prefix[])
47131697293SDave May {
47231697293SDave May   PetscErrorCode ierr;
47331697293SDave May 
47431697293SDave May   PetscFunctionBegin;
47531697293SDave May   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
47631697293SDave May   ierr = PetscObjectGetOptionsPrefix((PetscObject)dm,prefix);CHKERRQ(ierr);
47731697293SDave May   PetscFunctionReturn(0);
47831697293SDave May }
47931697293SDave May 
48031697293SDave May #undef __FUNCT__
48188bdff64SToby Isaac #define __FUNCT__ "DMCountNonCyclicReferences"
48288bdff64SToby Isaac static PetscErrorCode DMCountNonCyclicReferences(DM dm, PetscBool recurseCoarse, PetscBool recurseFine, PetscInt *ncrefct)
48388bdff64SToby Isaac {
48488bdff64SToby Isaac   PetscInt i, refct = ((PetscObject) dm)->refct;
48588bdff64SToby Isaac   DMNamedVecLink nlink;
48688bdff64SToby Isaac   PetscErrorCode ierr;
48788bdff64SToby Isaac 
48888bdff64SToby Isaac   PetscFunctionBegin;
48988bdff64SToby Isaac   /* count all the circular references of DM and its contained Vecs */
49088bdff64SToby Isaac   for (i=0; i<DM_MAX_WORK_VECTORS; i++) {
49188bdff64SToby Isaac     if (dm->localin[i])  refct--;
49288bdff64SToby Isaac     if (dm->globalin[i]) refct--;
49388bdff64SToby Isaac   }
49488bdff64SToby Isaac   for (nlink=dm->namedglobal; nlink; nlink=nlink->next) refct--;
49588bdff64SToby Isaac   for (nlink=dm->namedlocal; nlink; nlink=nlink->next) refct--;
49688bdff64SToby Isaac   if (dm->x) {
49788bdff64SToby Isaac     DM obj;
49888bdff64SToby Isaac     ierr = VecGetDM(dm->x, &obj);CHKERRQ(ierr);
49988bdff64SToby Isaac     if (obj == dm) refct--;
50088bdff64SToby Isaac   }
50188bdff64SToby Isaac   if (dm->coarseMesh && dm->coarseMesh->fineMesh == dm) {
50288bdff64SToby Isaac     refct--;
50388bdff64SToby Isaac     if (recurseCoarse) {
50488bdff64SToby Isaac       PetscInt coarseCount;
50588bdff64SToby Isaac 
50688bdff64SToby Isaac       ierr = DMCountNonCyclicReferences(dm->coarseMesh, PETSC_TRUE, PETSC_FALSE,&coarseCount);CHKERRQ(ierr);
50788bdff64SToby Isaac       refct += coarseCount;
50888bdff64SToby Isaac     }
50988bdff64SToby Isaac   }
51088bdff64SToby Isaac   if (dm->fineMesh && dm->fineMesh->coarseMesh == dm) {
51188bdff64SToby Isaac     refct--;
51288bdff64SToby Isaac     if (recurseFine) {
51388bdff64SToby Isaac       PetscInt fineCount;
51488bdff64SToby Isaac 
51588bdff64SToby Isaac       ierr = DMCountNonCyclicReferences(dm->fineMesh, PETSC_FALSE, PETSC_TRUE,&fineCount);CHKERRQ(ierr);
51688bdff64SToby Isaac       refct += fineCount;
51788bdff64SToby Isaac     }
51888bdff64SToby Isaac   }
51988bdff64SToby Isaac   *ncrefct = refct;
52088bdff64SToby Isaac   PetscFunctionReturn(0);
52188bdff64SToby Isaac }
52288bdff64SToby Isaac 
523bcc5ffd9SToby Isaac PetscErrorCode DMBoundaryDestroy(DMBoundaryLinkList *boundary);
524a6ba4734SToby Isaac 
52588bdff64SToby Isaac #undef __FUNCT__
526354557abSToby Isaac #define __FUNCT__ "DMDestroyLabelLinkList"
527354557abSToby Isaac PetscErrorCode DMDestroyLabelLinkList(DM dm)
528354557abSToby Isaac {
529354557abSToby Isaac   PetscErrorCode ierr;
530354557abSToby Isaac 
531354557abSToby Isaac   PetscFunctionBegin;
532354557abSToby Isaac   if (!--(dm->labels->refct)) {
533354557abSToby Isaac     DMLabelLink next = dm->labels->next;
534354557abSToby Isaac 
535354557abSToby Isaac     /* destroy the labels */
536354557abSToby Isaac     while (next) {
537354557abSToby Isaac       DMLabelLink tmp = next->next;
538354557abSToby Isaac 
539354557abSToby Isaac       ierr = DMLabelDestroy(&next->label);CHKERRQ(ierr);
540354557abSToby Isaac       ierr = PetscFree(next);CHKERRQ(ierr);
541354557abSToby Isaac       next = tmp;
542354557abSToby Isaac     }
543354557abSToby Isaac     ierr = PetscFree(dm->labels);CHKERRQ(ierr);
544354557abSToby Isaac   }
545354557abSToby Isaac   PetscFunctionReturn(0);
546354557abSToby Isaac }
547354557abSToby Isaac 
548354557abSToby Isaac #undef __FUNCT__
54947c6ae99SBarry Smith #define __FUNCT__ "DMDestroy"
55047c6ae99SBarry Smith /*@
5518472ad0fSDave May     DMDestroy - Destroys a vector packer or DM.
55247c6ae99SBarry Smith 
55347c6ae99SBarry Smith     Collective on DM
55447c6ae99SBarry Smith 
55547c6ae99SBarry Smith     Input Parameter:
55647c6ae99SBarry Smith .   dm - the DM object to destroy
55747c6ae99SBarry Smith 
55847c6ae99SBarry Smith     Level: developer
55947c6ae99SBarry Smith 
560e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
56147c6ae99SBarry Smith 
56247c6ae99SBarry Smith @*/
563fcfd50ebSBarry Smith PetscErrorCode  DMDestroy(DM *dm)
56447c6ae99SBarry Smith {
56588bdff64SToby Isaac   PetscInt       i, cnt;
566dfe15315SJed Brown   DMNamedVecLink nlink,nnext;
56747c6ae99SBarry Smith   PetscErrorCode ierr;
56847c6ae99SBarry Smith 
56947c6ae99SBarry Smith   PetscFunctionBegin;
5706bf464f9SBarry Smith   if (!*dm) PetscFunctionReturn(0);
5716bf464f9SBarry Smith   PetscValidHeaderSpecific((*dm),DM_CLASSID,1);
57287e657c6SBarry Smith 
57388bdff64SToby Isaac   /* count all non-cyclic references in the doubly-linked list of coarse<->fine meshes */
57488bdff64SToby Isaac   ierr = DMCountNonCyclicReferences(*dm,PETSC_TRUE,PETSC_TRUE,&cnt);CHKERRQ(ierr);
57588bdff64SToby Isaac   --((PetscObject)(*dm))->refct;
57688bdff64SToby Isaac   if (--cnt > 0) {*dm = 0; PetscFunctionReturn(0);}
577732e2eb9SMatthew G Knepley   /*
578732e2eb9SMatthew G Knepley      Need this test because the dm references the vectors that
579732e2eb9SMatthew G Knepley      reference the dm, so destroying the dm calls destroy on the
580732e2eb9SMatthew G Knepley      vectors that cause another destroy on the dm
581732e2eb9SMatthew G Knepley   */
5826bf464f9SBarry Smith   if (((PetscObject)(*dm))->refct < 0) PetscFunctionReturn(0);
5836bf464f9SBarry Smith   ((PetscObject) (*dm))->refct = 0;
584732e2eb9SMatthew G Knepley   for (i=0; i<DM_MAX_WORK_VECTORS; i++) {
5856bf464f9SBarry Smith     if ((*dm)->localout[i]) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Destroying a DM that has a local vector obtained with DMGetLocalVector()");
5866bf464f9SBarry Smith     ierr = VecDestroy(&(*dm)->localin[i]);CHKERRQ(ierr);
587732e2eb9SMatthew G Knepley   }
588f490541aSPeter Brune   nnext=(*dm)->namedglobal;
5890298fd71SBarry Smith   (*dm)->namedglobal = NULL;
590f490541aSPeter Brune   for (nlink=nnext; nlink; nlink=nnext) { /* Destroy the named vectors */
5912348bcf4SPeter Brune     nnext = nlink->next;
5922348bcf4SPeter Brune     if (nlink->status != DMVEC_STATUS_IN) SETERRQ1(((PetscObject)*dm)->comm,PETSC_ERR_ARG_WRONGSTATE,"DM still has Vec named '%s' checked out",nlink->name);
5932348bcf4SPeter Brune     ierr = PetscFree(nlink->name);CHKERRQ(ierr);
5942348bcf4SPeter Brune     ierr = VecDestroy(&nlink->X);CHKERRQ(ierr);
5952348bcf4SPeter Brune     ierr = PetscFree(nlink);CHKERRQ(ierr);
5962348bcf4SPeter Brune   }
597f490541aSPeter Brune   nnext=(*dm)->namedlocal;
5980298fd71SBarry Smith   (*dm)->namedlocal = NULL;
599f490541aSPeter Brune   for (nlink=nnext; nlink; nlink=nnext) { /* Destroy the named local vectors */
600f490541aSPeter Brune     nnext = nlink->next;
601f490541aSPeter Brune     if (nlink->status != DMVEC_STATUS_IN) SETERRQ1(((PetscObject)*dm)->comm,PETSC_ERR_ARG_WRONGSTATE,"DM still has Vec named '%s' checked out",nlink->name);
602f490541aSPeter Brune     ierr = PetscFree(nlink->name);CHKERRQ(ierr);
603f490541aSPeter Brune     ierr = VecDestroy(&nlink->X);CHKERRQ(ierr);
604f490541aSPeter Brune     ierr = PetscFree(nlink);CHKERRQ(ierr);
605f490541aSPeter Brune   }
6062348bcf4SPeter Brune 
607b17ce1afSJed Brown   /* Destroy the list of hooks */
608c833c3b5SJed Brown   {
609c833c3b5SJed Brown     DMCoarsenHookLink link,next;
610b17ce1afSJed Brown     for (link=(*dm)->coarsenhook; link; link=next) {
611b17ce1afSJed Brown       next = link->next;
612b17ce1afSJed Brown       ierr = PetscFree(link);CHKERRQ(ierr);
613b17ce1afSJed Brown     }
6140298fd71SBarry Smith     (*dm)->coarsenhook = NULL;
615c833c3b5SJed Brown   }
616c833c3b5SJed Brown   {
617c833c3b5SJed Brown     DMRefineHookLink link,next;
618c833c3b5SJed Brown     for (link=(*dm)->refinehook; link; link=next) {
619c833c3b5SJed Brown       next = link->next;
620c833c3b5SJed Brown       ierr = PetscFree(link);CHKERRQ(ierr);
621c833c3b5SJed Brown     }
6220298fd71SBarry Smith     (*dm)->refinehook = NULL;
623c833c3b5SJed Brown   }
624be081cd6SPeter Brune   {
625be081cd6SPeter Brune     DMSubDomainHookLink link,next;
626be081cd6SPeter Brune     for (link=(*dm)->subdomainhook; link; link=next) {
627be081cd6SPeter Brune       next = link->next;
628be081cd6SPeter Brune       ierr = PetscFree(link);CHKERRQ(ierr);
629be081cd6SPeter Brune     }
6300298fd71SBarry Smith     (*dm)->subdomainhook = NULL;
631be081cd6SPeter Brune   }
632baf369e7SPeter Brune   {
633baf369e7SPeter Brune     DMGlobalToLocalHookLink link,next;
634baf369e7SPeter Brune     for (link=(*dm)->gtolhook; link; link=next) {
635baf369e7SPeter Brune       next = link->next;
636baf369e7SPeter Brune       ierr = PetscFree(link);CHKERRQ(ierr);
637baf369e7SPeter Brune     }
6380298fd71SBarry Smith     (*dm)->gtolhook = NULL;
639baf369e7SPeter Brune   }
640d4d07f1eSToby Isaac   {
641d4d07f1eSToby Isaac     DMLocalToGlobalHookLink link,next;
642d4d07f1eSToby Isaac     for (link=(*dm)->ltoghook; link; link=next) {
643d4d07f1eSToby Isaac       next = link->next;
644d4d07f1eSToby Isaac       ierr = PetscFree(link);CHKERRQ(ierr);
645d4d07f1eSToby Isaac     }
646d4d07f1eSToby Isaac     (*dm)->ltoghook = NULL;
647d4d07f1eSToby Isaac   }
648aa1993deSMatthew G Knepley   /* Destroy the work arrays */
649aa1993deSMatthew G Knepley   {
650aa1993deSMatthew G Knepley     DMWorkLink link,next;
651aa1993deSMatthew G Knepley     if ((*dm)->workout) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Work array still checked out");
652aa1993deSMatthew G Knepley     for (link=(*dm)->workin; link; link=next) {
653aa1993deSMatthew G Knepley       next = link->next;
654aa1993deSMatthew G Knepley       ierr = PetscFree(link->mem);CHKERRQ(ierr);
655aa1993deSMatthew G Knepley       ierr = PetscFree(link);CHKERRQ(ierr);
656aa1993deSMatthew G Knepley     }
6570298fd71SBarry Smith     (*dm)->workin = NULL;
658aa1993deSMatthew G Knepley   }
659c58f1c22SToby Isaac   if (!--((*dm)->labels->refct)) {
660c58f1c22SToby Isaac     DMLabelLink next = (*dm)->labels->next;
661c58f1c22SToby Isaac 
662c58f1c22SToby Isaac     /* destroy the labels */
663c58f1c22SToby Isaac     while (next) {
664c58f1c22SToby Isaac       DMLabelLink tmp = next->next;
665c58f1c22SToby Isaac 
666c58f1c22SToby Isaac       ierr = DMLabelDestroy(&next->label);CHKERRQ(ierr);
667c58f1c22SToby Isaac       ierr = PetscFree(next);CHKERRQ(ierr);
668c58f1c22SToby Isaac       next = tmp;
669c58f1c22SToby Isaac     }
670c58f1c22SToby Isaac     ierr = PetscFree((*dm)->labels);CHKERRQ(ierr);
671c58f1c22SToby Isaac   }
672bcc5ffd9SToby Isaac   ierr = DMBoundaryDestroy(&(*dm)->boundary);CHKERRQ(ierr);
673b17ce1afSJed Brown 
67452536dc3SBarry Smith   ierr = PetscObjectDestroy(&(*dm)->dmksp);CHKERRQ(ierr);
67552536dc3SBarry Smith   ierr = PetscObjectDestroy(&(*dm)->dmsnes);CHKERRQ(ierr);
67652536dc3SBarry Smith   ierr = PetscObjectDestroy(&(*dm)->dmts);CHKERRQ(ierr);
67752536dc3SBarry Smith 
6781a266240SBarry Smith   if ((*dm)->ctx && (*dm)->ctxdestroy) {
6791a266240SBarry Smith     ierr = (*(*dm)->ctxdestroy)(&(*dm)->ctx);CHKERRQ(ierr);
6801a266240SBarry Smith   }
68187e657c6SBarry Smith   ierr = VecDestroy(&(*dm)->x);CHKERRQ(ierr);
68271cd77b2SBarry Smith   ierr = MatFDColoringDestroy(&(*dm)->fd);CHKERRQ(ierr);
6834dcab191SBarry Smith   ierr = DMClearGlobalVectors(*dm);CHKERRQ(ierr);
6846bf464f9SBarry Smith   ierr = ISLocalToGlobalMappingDestroy(&(*dm)->ltogmap);CHKERRQ(ierr);
6856bf464f9SBarry Smith   ierr = PetscFree((*dm)->vectype);CHKERRQ(ierr);
686073dac72SJed Brown   ierr = PetscFree((*dm)->mattype);CHKERRQ(ierr);
68788ed4aceSMatthew G Knepley 
68888ed4aceSMatthew G Knepley   ierr = PetscSectionDestroy(&(*dm)->defaultSection);CHKERRQ(ierr);
68988ed4aceSMatthew G Knepley   ierr = PetscSectionDestroy(&(*dm)->defaultGlobalSection);CHKERRQ(ierr);
6908b1ab98fSJed Brown   ierr = PetscLayoutDestroy(&(*dm)->map);CHKERRQ(ierr);
691fba222abSToby Isaac   ierr = PetscSectionDestroy(&(*dm)->defaultConstraintSection);CHKERRQ(ierr);
692fba222abSToby Isaac   ierr = MatDestroy(&(*dm)->defaultConstraintMat);CHKERRQ(ierr);
69388ed4aceSMatthew G Knepley   ierr = PetscSFDestroy(&(*dm)->sf);CHKERRQ(ierr);
69488ed4aceSMatthew G Knepley   ierr = PetscSFDestroy(&(*dm)->defaultSF);CHKERRQ(ierr);
6958e4ac7eaSMatthew G. Knepley   ierr = PetscSFDestroy(&(*dm)->sfNatural);CHKERRQ(ierr);
696af122d2aSMatthew G Knepley 
69788bdff64SToby Isaac   if ((*dm)->coarseMesh && (*dm)->coarseMesh->fineMesh == *dm) {
69888bdff64SToby Isaac     ierr = DMSetFineDM((*dm)->coarseMesh,NULL);CHKERRQ(ierr);
69988bdff64SToby Isaac   }
700a8fb8f29SToby Isaac   ierr = DMDestroy(&(*dm)->coarseMesh);CHKERRQ(ierr);
70188bdff64SToby Isaac   if ((*dm)->fineMesh && (*dm)->fineMesh->coarseMesh == *dm) {
70288bdff64SToby Isaac     ierr = DMSetCoarseDM((*dm)->fineMesh,NULL);CHKERRQ(ierr);
70388bdff64SToby Isaac   }
70488bdff64SToby Isaac   ierr = DMDestroy(&(*dm)->fineMesh);CHKERRQ(ierr);
7056636e97aSMatthew G Knepley   ierr = DMDestroy(&(*dm)->coordinateDM);CHKERRQ(ierr);
7066636e97aSMatthew G Knepley   ierr = VecDestroy(&(*dm)->coordinates);CHKERRQ(ierr);
7076636e97aSMatthew G Knepley   ierr = VecDestroy(&(*dm)->coordinatesLocal);CHKERRQ(ierr);
7085dc8c3f7SMatthew G. Knepley   ierr = PetscFree3((*dm)->L,(*dm)->maxCell,(*dm)->bdtype);CHKERRQ(ierr);
7096636e97aSMatthew G Knepley 
7102764a2aaSMatthew G. Knepley   ierr = PetscDSDestroy(&(*dm)->prob);CHKERRQ(ierr);
71114f150ffSMatthew G. Knepley   ierr = DMDestroy(&(*dm)->dmBC);CHKERRQ(ierr);
712e04113cfSBarry Smith   /* if memory was published with SAWs then destroy it */
713e04113cfSBarry Smith   ierr = PetscObjectSAWsViewOff((PetscObject)*dm);CHKERRQ(ierr);
714732e2eb9SMatthew G Knepley 
7156bf464f9SBarry Smith   ierr = (*(*dm)->ops->destroy)(*dm);CHKERRQ(ierr);
716435a35e8SMatthew G Knepley   /* We do not destroy (*dm)->data here so that we can reference count backend objects */
717732e2eb9SMatthew G Knepley   ierr = PetscHeaderDestroy(dm);CHKERRQ(ierr);
71847c6ae99SBarry Smith   PetscFunctionReturn(0);
71947c6ae99SBarry Smith }
72047c6ae99SBarry Smith 
72147c6ae99SBarry Smith #undef __FUNCT__
722d7bf68aeSBarry Smith #define __FUNCT__ "DMSetUp"
723d7bf68aeSBarry Smith /*@
724d7bf68aeSBarry Smith     DMSetUp - sets up the data structures inside a DM object
725d7bf68aeSBarry Smith 
726d7bf68aeSBarry Smith     Collective on DM
727d7bf68aeSBarry Smith 
728d7bf68aeSBarry Smith     Input Parameter:
729d7bf68aeSBarry Smith .   dm - the DM object to setup
730d7bf68aeSBarry Smith 
731d7bf68aeSBarry Smith     Level: developer
732d7bf68aeSBarry Smith 
733e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
734d7bf68aeSBarry Smith 
735d7bf68aeSBarry Smith @*/
7367087cfbeSBarry Smith PetscErrorCode  DMSetUp(DM dm)
737d7bf68aeSBarry Smith {
738d7bf68aeSBarry Smith   PetscErrorCode ierr;
739d7bf68aeSBarry Smith 
740d7bf68aeSBarry Smith   PetscFunctionBegin;
741171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
7428387afaaSJed Brown   if (dm->setupcalled) PetscFunctionReturn(0);
743d7bf68aeSBarry Smith   if (dm->ops->setup) {
744d7bf68aeSBarry Smith     ierr = (*dm->ops->setup)(dm);CHKERRQ(ierr);
745d7bf68aeSBarry Smith   }
7468387afaaSJed Brown   dm->setupcalled = PETSC_TRUE;
747d7bf68aeSBarry Smith   PetscFunctionReturn(0);
748d7bf68aeSBarry Smith }
749d7bf68aeSBarry Smith 
750d7bf68aeSBarry Smith #undef __FUNCT__
751d7bf68aeSBarry Smith #define __FUNCT__ "DMSetFromOptions"
752d7bf68aeSBarry Smith /*@
753d7bf68aeSBarry Smith     DMSetFromOptions - sets parameters in a DM from the options database
754d7bf68aeSBarry Smith 
755d7bf68aeSBarry Smith     Collective on DM
756d7bf68aeSBarry Smith 
757d7bf68aeSBarry Smith     Input Parameter:
758d7bf68aeSBarry Smith .   dm - the DM object to set options for
759d7bf68aeSBarry Smith 
760732e2eb9SMatthew G Knepley     Options Database:
7614164ae61SDominic Meiser +   -dm_preallocate_only - Only preallocate the matrix for DMCreateMatrix(), but do not fill it with zeros
7624164ae61SDominic Meiser .   -dm_vec_type <type>  - type of vector to create inside DM
7634164ae61SDominic Meiser .   -dm_mat_type <type>  - type of matrix to create inside DM
7644164ae61SDominic Meiser -   -dm_coloring_type    - <global or ghosted>
765732e2eb9SMatthew G Knepley 
766d7bf68aeSBarry Smith     Level: developer
767d7bf68aeSBarry Smith 
768e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
769d7bf68aeSBarry Smith 
770d7bf68aeSBarry Smith @*/
7717087cfbeSBarry Smith PetscErrorCode  DMSetFromOptions(DM dm)
772d7bf68aeSBarry Smith {
7737781c08eSBarry Smith   char           typeName[256];
774ca266f36SBarry Smith   PetscBool      flg;
775d7bf68aeSBarry Smith   PetscErrorCode ierr;
776d7bf68aeSBarry Smith 
777d7bf68aeSBarry Smith   PetscFunctionBegin;
778171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
779691be533SLawrence Mitchell   if (dm->sf) {
780691be533SLawrence Mitchell     ierr = PetscSFSetFromOptions(dm->sf);CHKERRQ(ierr);
781691be533SLawrence Mitchell   }
782691be533SLawrence Mitchell   if (dm->defaultSF) {
783691be533SLawrence Mitchell     ierr = PetscSFSetFromOptions(dm->defaultSF);CHKERRQ(ierr);
784691be533SLawrence Mitchell   }
7853194b578SJed Brown   ierr = PetscObjectOptionsBegin((PetscObject)dm);CHKERRQ(ierr);
7860298fd71SBarry Smith   ierr = PetscOptionsBool("-dm_preallocate_only","only preallocate matrix, but do not set column indices","DMSetMatrixPreallocateOnly",dm->prealloc_only,&dm->prealloc_only,NULL);CHKERRQ(ierr);
787a264d7a6SBarry Smith   ierr = PetscOptionsFList("-dm_vec_type","Vector type used for created vectors","DMSetVecType",VecList,dm->vectype,typeName,256,&flg);CHKERRQ(ierr);
788f9ba7244SBarry Smith   if (flg) {
789f9ba7244SBarry Smith     ierr = DMSetVecType(dm,typeName);CHKERRQ(ierr);
790f9ba7244SBarry Smith   }
791a264d7a6SBarry Smith   ierr = PetscOptionsFList("-dm_mat_type","Matrix type used for created matrices","DMSetMatType",MatList,dm->mattype ? dm->mattype : typeName,typeName,sizeof(typeName),&flg);CHKERRQ(ierr);
792073dac72SJed Brown   if (flg) {
793521d9a4cSLisandro Dalcin     ierr = DMSetMatType(dm,typeName);CHKERRQ(ierr);
794073dac72SJed Brown   }
7950298fd71SBarry Smith   ierr = PetscOptionsEnum("-dm_is_coloring_type","Global or local coloring of Jacobian","ISColoringType",ISColoringTypes,(PetscEnum)dm->coloringtype,(PetscEnum*)&dm->coloringtype,NULL);CHKERRQ(ierr);
796f9ba7244SBarry Smith   if (dm->ops->setfromoptions) {
797e55864a3SBarry Smith     ierr = (*dm->ops->setfromoptions)(PetscOptionsObject,dm);CHKERRQ(ierr);
798f9ba7244SBarry Smith   }
799f9ba7244SBarry Smith   /* process any options handlers added with PetscObjectAddOptionsHandler() */
8000633abcbSJed Brown   ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject) dm);CHKERRQ(ierr);
80182fcb398SMatthew G Knepley   ierr = PetscOptionsEnd();CHKERRQ(ierr);
802d7bf68aeSBarry Smith   PetscFunctionReturn(0);
803d7bf68aeSBarry Smith }
804d7bf68aeSBarry Smith 
805d7bf68aeSBarry Smith #undef __FUNCT__
80647c6ae99SBarry Smith #define __FUNCT__ "DMView"
807fc9bc008SSatish Balay /*@C
808224748a4SBarry Smith     DMView - Views a DM
80947c6ae99SBarry Smith 
81047c6ae99SBarry Smith     Collective on DM
81147c6ae99SBarry Smith 
81247c6ae99SBarry Smith     Input Parameter:
81347c6ae99SBarry Smith +   dm - the DM object to view
81447c6ae99SBarry Smith -   v - the viewer
81547c6ae99SBarry Smith 
816224748a4SBarry Smith     Level: beginner
81747c6ae99SBarry Smith 
818e727c939SJed Brown .seealso DMDestroy(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
81947c6ae99SBarry Smith 
82047c6ae99SBarry Smith @*/
8217087cfbeSBarry Smith PetscErrorCode  DMView(DM dm,PetscViewer v)
82247c6ae99SBarry Smith {
82347c6ae99SBarry Smith   PetscErrorCode ierr;
82432c0f0efSBarry Smith   PetscBool      isbinary;
82547c6ae99SBarry Smith 
82647c6ae99SBarry Smith   PetscFunctionBegin;
827171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
8283014e516SBarry Smith   if (!v) {
829ce94432eSBarry Smith     ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)dm),&v);CHKERRQ(ierr);
8303014e516SBarry Smith   }
83198c3331eSBarry Smith   ierr = PetscObjectPrintClassNamePrefixType((PetscObject)dm,v);CHKERRQ(ierr);
83232c0f0efSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)v,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
83332c0f0efSBarry Smith   if (isbinary) {
83455849f57SBarry Smith     PetscInt classid = DM_FILE_CLASSID;
83532c0f0efSBarry Smith     char     type[256];
83632c0f0efSBarry Smith 
83732c0f0efSBarry Smith     ierr = PetscViewerBinaryWrite(v,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
83832c0f0efSBarry Smith     ierr = PetscStrncpy(type,((PetscObject)dm)->type_name,256);CHKERRQ(ierr);
83932c0f0efSBarry Smith     ierr = PetscViewerBinaryWrite(v,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr);
84032c0f0efSBarry Smith   }
8410c010503SBarry Smith   if (dm->ops->view) {
8420c010503SBarry Smith     ierr = (*dm->ops->view)(dm,v);CHKERRQ(ierr);
84347c6ae99SBarry Smith   }
84447c6ae99SBarry Smith   PetscFunctionReturn(0);
84547c6ae99SBarry Smith }
84647c6ae99SBarry Smith 
84747c6ae99SBarry Smith #undef __FUNCT__
84847c6ae99SBarry Smith #define __FUNCT__ "DMCreateGlobalVector"
84947c6ae99SBarry Smith /*@
8508472ad0fSDave May     DMCreateGlobalVector - Creates a global vector from a DM object
85147c6ae99SBarry Smith 
85247c6ae99SBarry Smith     Collective on DM
85347c6ae99SBarry Smith 
85447c6ae99SBarry Smith     Input Parameter:
85547c6ae99SBarry Smith .   dm - the DM object
85647c6ae99SBarry Smith 
85747c6ae99SBarry Smith     Output Parameter:
85847c6ae99SBarry Smith .   vec - the global vector
85947c6ae99SBarry Smith 
860073dac72SJed Brown     Level: beginner
86147c6ae99SBarry Smith 
862e727c939SJed Brown .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
86347c6ae99SBarry Smith 
86447c6ae99SBarry Smith @*/
8657087cfbeSBarry Smith PetscErrorCode  DMCreateGlobalVector(DM dm,Vec *vec)
86647c6ae99SBarry Smith {
86747c6ae99SBarry Smith   PetscErrorCode ierr;
86847c6ae99SBarry Smith 
86947c6ae99SBarry Smith   PetscFunctionBegin;
870171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
87147c6ae99SBarry Smith   ierr = (*dm->ops->createglobalvector)(dm,vec);CHKERRQ(ierr);
87247c6ae99SBarry Smith   PetscFunctionReturn(0);
87347c6ae99SBarry Smith }
87447c6ae99SBarry Smith 
87547c6ae99SBarry Smith #undef __FUNCT__
87647c6ae99SBarry Smith #define __FUNCT__ "DMCreateLocalVector"
87747c6ae99SBarry Smith /*@
8788472ad0fSDave May     DMCreateLocalVector - Creates a local vector from a DM object
87947c6ae99SBarry Smith 
88047c6ae99SBarry Smith     Not Collective
88147c6ae99SBarry Smith 
88247c6ae99SBarry Smith     Input Parameter:
88347c6ae99SBarry Smith .   dm - the DM object
88447c6ae99SBarry Smith 
88547c6ae99SBarry Smith     Output Parameter:
88647c6ae99SBarry Smith .   vec - the local vector
88747c6ae99SBarry Smith 
888073dac72SJed Brown     Level: beginner
88947c6ae99SBarry Smith 
890e727c939SJed Brown .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
89147c6ae99SBarry Smith 
89247c6ae99SBarry Smith @*/
8937087cfbeSBarry Smith PetscErrorCode  DMCreateLocalVector(DM dm,Vec *vec)
89447c6ae99SBarry Smith {
89547c6ae99SBarry Smith   PetscErrorCode ierr;
89647c6ae99SBarry Smith 
89747c6ae99SBarry Smith   PetscFunctionBegin;
898171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
89947c6ae99SBarry Smith   ierr = (*dm->ops->createlocalvector)(dm,vec);CHKERRQ(ierr);
90047c6ae99SBarry Smith   PetscFunctionReturn(0);
90147c6ae99SBarry Smith }
90247c6ae99SBarry Smith 
90347c6ae99SBarry Smith #undef __FUNCT__
9041411c6eeSJed Brown #define __FUNCT__ "DMGetLocalToGlobalMapping"
9051411c6eeSJed Brown /*@
9061411c6eeSJed Brown    DMGetLocalToGlobalMapping - Accesses the local-to-global mapping in a DM.
9071411c6eeSJed Brown 
9081411c6eeSJed Brown    Collective on DM
9091411c6eeSJed Brown 
9101411c6eeSJed Brown    Input Parameter:
9111411c6eeSJed Brown .  dm - the DM that provides the mapping
9121411c6eeSJed Brown 
9131411c6eeSJed Brown    Output Parameter:
9141411c6eeSJed Brown .  ltog - the mapping
9151411c6eeSJed Brown 
9161411c6eeSJed Brown    Level: intermediate
9171411c6eeSJed Brown 
9181411c6eeSJed Brown    Notes:
9191411c6eeSJed Brown    This mapping can then be used by VecSetLocalToGlobalMapping() or
9201411c6eeSJed Brown    MatSetLocalToGlobalMapping().
9211411c6eeSJed Brown 
922fc31e74dSBarry Smith .seealso: DMCreateLocalVector()
9231411c6eeSJed Brown @*/
9247087cfbeSBarry Smith PetscErrorCode  DMGetLocalToGlobalMapping(DM dm,ISLocalToGlobalMapping *ltog)
9251411c6eeSJed Brown {
926b190aa46SMatthew G. Knepley   PetscInt       bs = -1;
9271411c6eeSJed Brown   PetscErrorCode ierr;
9281411c6eeSJed Brown 
9291411c6eeSJed Brown   PetscFunctionBegin;
9301411c6eeSJed Brown   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
9311411c6eeSJed Brown   PetscValidPointer(ltog,2);
9321411c6eeSJed Brown   if (!dm->ltogmap) {
93337d0c07bSMatthew G Knepley     PetscSection section, sectionGlobal;
93437d0c07bSMatthew G Knepley 
93537d0c07bSMatthew G Knepley     ierr = DMGetDefaultSection(dm, &section);CHKERRQ(ierr);
93637d0c07bSMatthew G Knepley     if (section) {
93737d0c07bSMatthew G Knepley       PetscInt *ltog;
93837d0c07bSMatthew G Knepley       PetscInt pStart, pEnd, size, p, l;
93937d0c07bSMatthew G Knepley 
94037d0c07bSMatthew G Knepley       ierr = DMGetDefaultGlobalSection(dm, &sectionGlobal);CHKERRQ(ierr);
94137d0c07bSMatthew G Knepley       ierr = PetscSectionGetChart(section, &pStart, &pEnd);CHKERRQ(ierr);
94237d0c07bSMatthew G Knepley       ierr = PetscSectionGetStorageSize(section, &size);CHKERRQ(ierr);
943785e854fSJed Brown       ierr = PetscMalloc1(size, &ltog);CHKERRQ(ierr); /* We want the local+overlap size */
94437d0c07bSMatthew G Knepley       for (p = pStart, l = 0; p < pEnd; ++p) {
945b190aa46SMatthew G. Knepley         PetscInt bdof, cdof, dof, off, c;
94637d0c07bSMatthew G Knepley 
94737d0c07bSMatthew G Knepley         /* Should probably use constrained dofs */
94837d0c07bSMatthew G Knepley         ierr = PetscSectionGetDof(section, p, &dof);CHKERRQ(ierr);
94937d0c07bSMatthew G Knepley         ierr = PetscSectionGetOffset(sectionGlobal, p, &off);CHKERRQ(ierr);
950b190aa46SMatthew G. Knepley         ierr = PetscSectionGetConstraintDof(sectionGlobal, p, &cdof);CHKERRQ(ierr);
951b190aa46SMatthew G. Knepley         bdof = cdof ? 1 : dof;
952b190aa46SMatthew G. Knepley         if (bs < 0)          {bs = bdof;}
953b190aa46SMatthew G. Knepley         else if (bs != bdof) {bs = 1;}
95437d0c07bSMatthew G Knepley         for (c = 0; c < dof; ++c, ++l) {
95537d0c07bSMatthew G Knepley           ltog[l] = off+c;
95637d0c07bSMatthew G Knepley         }
95737d0c07bSMatthew G Knepley       }
958b190aa46SMatthew G. Knepley       ierr = ISLocalToGlobalMappingCreate(PETSC_COMM_SELF, bs < 0 ? 1 : bs, size, ltog, PETSC_OWN_POINTER, &dm->ltogmap);CHKERRQ(ierr);
9593bb1ff40SBarry Smith       ierr = PetscLogObjectParent((PetscObject)dm, (PetscObject)dm->ltogmap);CHKERRQ(ierr);
96037d0c07bSMatthew G Knepley     } else {
961184d77edSJed Brown       if (!dm->ops->getlocaltoglobalmapping) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM can not create LocalToGlobalMapping");
962184d77edSJed Brown       ierr = (*dm->ops->getlocaltoglobalmapping)(dm);CHKERRQ(ierr);
9631411c6eeSJed Brown     }
96437d0c07bSMatthew G Knepley   }
9651411c6eeSJed Brown   *ltog = dm->ltogmap;
9661411c6eeSJed Brown   PetscFunctionReturn(0);
9671411c6eeSJed Brown }
9681411c6eeSJed Brown 
9691411c6eeSJed Brown #undef __FUNCT__
9701411c6eeSJed Brown #define __FUNCT__ "DMGetBlockSize"
9711411c6eeSJed Brown /*@
9721411c6eeSJed Brown    DMGetBlockSize - Gets the inherent block size associated with a DM
9731411c6eeSJed Brown 
9741411c6eeSJed Brown    Not Collective
9751411c6eeSJed Brown 
9761411c6eeSJed Brown    Input Parameter:
9771411c6eeSJed Brown .  dm - the DM with block structure
9781411c6eeSJed Brown 
9791411c6eeSJed Brown    Output Parameter:
9801411c6eeSJed Brown .  bs - the block size, 1 implies no exploitable block structure
9811411c6eeSJed Brown 
9821411c6eeSJed Brown    Level: intermediate
9831411c6eeSJed Brown 
984fc31e74dSBarry Smith .seealso: ISCreateBlock(), VecSetBlockSize(), MatSetBlockSize(), DMGetLocalToGlobalMapping()
9851411c6eeSJed Brown @*/
9867087cfbeSBarry Smith PetscErrorCode  DMGetBlockSize(DM dm,PetscInt *bs)
9871411c6eeSJed Brown {
9881411c6eeSJed Brown   PetscFunctionBegin;
9891411c6eeSJed Brown   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
9901411c6eeSJed Brown   PetscValidPointer(bs,2);
9911411c6eeSJed Brown   if (dm->bs < 1) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"DM does not have enough information to provide a block size yet");
9921411c6eeSJed Brown   *bs = dm->bs;
9931411c6eeSJed Brown   PetscFunctionReturn(0);
9941411c6eeSJed Brown }
9951411c6eeSJed Brown 
9961411c6eeSJed Brown #undef __FUNCT__
997e727c939SJed Brown #define __FUNCT__ "DMCreateInterpolation"
99847c6ae99SBarry Smith /*@
9998472ad0fSDave May     DMCreateInterpolation - Gets interpolation matrix between two DM objects
100047c6ae99SBarry Smith 
100147c6ae99SBarry Smith     Collective on DM
100247c6ae99SBarry Smith 
100347c6ae99SBarry Smith     Input Parameter:
100447c6ae99SBarry Smith +   dm1 - the DM object
100547c6ae99SBarry Smith -   dm2 - the second, finer DM object
100647c6ae99SBarry Smith 
100747c6ae99SBarry Smith     Output Parameter:
100847c6ae99SBarry Smith +  mat - the interpolation
100947c6ae99SBarry Smith -  vec - the scaling (optional)
101047c6ae99SBarry Smith 
101147c6ae99SBarry Smith     Level: developer
101247c6ae99SBarry Smith 
101385afcc9aSBarry Smith     Notes:  For DMDA objects this only works for "uniform refinement", that is the refined mesh was obtained DMRefine() or the coarse mesh was obtained by
101485afcc9aSBarry Smith         DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the interpolation.
1015d52bd9f3SBarry Smith 
10161f588964SMatthew G Knepley         For DMDA objects you can use this interpolation (more precisely the interpolation from the DMGetCoordinateDM()) to interpolate the mesh coordinate vectors
1017d52bd9f3SBarry Smith         EXCEPT in the periodic case where it does not make sense since the coordinate vectors are not periodic.
101885afcc9aSBarry Smith 
101985afcc9aSBarry Smith 
10203ad4599aSBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateRestriction()
102147c6ae99SBarry Smith 
102247c6ae99SBarry Smith @*/
1023e727c939SJed Brown PetscErrorCode  DMCreateInterpolation(DM dm1,DM dm2,Mat *mat,Vec *vec)
102447c6ae99SBarry Smith {
102547c6ae99SBarry Smith   PetscErrorCode ierr;
102647c6ae99SBarry Smith 
102747c6ae99SBarry Smith   PetscFunctionBegin;
1028171400e9SBarry Smith   PetscValidHeaderSpecific(dm1,DM_CLASSID,1);
1029171400e9SBarry Smith   PetscValidHeaderSpecific(dm2,DM_CLASSID,2);
1030cea54e9dSPatrick Farrell   ierr = PetscLogEventBegin(DM_CreateInterpolation,dm1,dm2,0,0);CHKERRQ(ierr);
103125296bd5SBarry Smith   ierr = (*dm1->ops->createinterpolation)(dm1,dm2,mat,vec);CHKERRQ(ierr);
1032cea54e9dSPatrick Farrell   ierr = PetscLogEventEnd(DM_CreateInterpolation,dm1,dm2,0,0);CHKERRQ(ierr);
103347c6ae99SBarry Smith   PetscFunctionReturn(0);
103447c6ae99SBarry Smith }
103547c6ae99SBarry Smith 
103647c6ae99SBarry Smith #undef __FUNCT__
10373ad4599aSBarry Smith #define __FUNCT__ "DMCreateRestriction"
10383ad4599aSBarry Smith /*@
10393ad4599aSBarry Smith     DMCreateRestriction - Gets restriction matrix between two DM objects
10403ad4599aSBarry Smith 
10413ad4599aSBarry Smith     Collective on DM
10423ad4599aSBarry Smith 
10433ad4599aSBarry Smith     Input Parameter:
10443ad4599aSBarry Smith +   dm1 - the DM object
10453ad4599aSBarry Smith -   dm2 - the second, finer DM object
10463ad4599aSBarry Smith 
10473ad4599aSBarry Smith     Output Parameter:
10483ad4599aSBarry Smith .  mat - the restriction
10493ad4599aSBarry Smith 
10503ad4599aSBarry Smith 
10513ad4599aSBarry Smith     Level: developer
10523ad4599aSBarry Smith 
10533ad4599aSBarry Smith     Notes:  For DMDA objects this only works for "uniform refinement", that is the refined mesh was obtained DMRefine() or the coarse mesh was obtained by
10543ad4599aSBarry Smith         DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the interpolation.
10553ad4599aSBarry Smith 
10563ad4599aSBarry Smith 
10573ad4599aSBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateInterpolation()
10583ad4599aSBarry Smith 
10593ad4599aSBarry Smith @*/
10603ad4599aSBarry Smith PetscErrorCode  DMCreateRestriction(DM dm1,DM dm2,Mat *mat)
10613ad4599aSBarry Smith {
10623ad4599aSBarry Smith   PetscErrorCode ierr;
10633ad4599aSBarry Smith 
10643ad4599aSBarry Smith   PetscFunctionBegin;
10653ad4599aSBarry Smith   PetscValidHeaderSpecific(dm1,DM_CLASSID,1);
10663ad4599aSBarry Smith   PetscValidHeaderSpecific(dm2,DM_CLASSID,2);
10673ad4599aSBarry Smith   ierr = PetscLogEventBegin(DM_CreateRestriction,dm1,dm2,0,0);CHKERRQ(ierr);
10683ad4599aSBarry Smith   ierr = (*dm1->ops->createrestriction)(dm1,dm2,mat);CHKERRQ(ierr);
10693ad4599aSBarry Smith   ierr = PetscLogEventEnd(DM_CreateRestriction,dm1,dm2,0,0);CHKERRQ(ierr);
10703ad4599aSBarry Smith   PetscFunctionReturn(0);
10713ad4599aSBarry Smith }
10723ad4599aSBarry Smith 
10733ad4599aSBarry Smith #undef __FUNCT__
1074e727c939SJed Brown #define __FUNCT__ "DMCreateInjection"
107547c6ae99SBarry Smith /*@
10768472ad0fSDave May     DMCreateInjection - Gets injection matrix between two DM objects
107747c6ae99SBarry Smith 
107847c6ae99SBarry Smith     Collective on DM
107947c6ae99SBarry Smith 
108047c6ae99SBarry Smith     Input Parameter:
108147c6ae99SBarry Smith +   dm1 - the DM object
108247c6ae99SBarry Smith -   dm2 - the second, finer DM object
108347c6ae99SBarry Smith 
108447c6ae99SBarry Smith     Output Parameter:
10856dbf9973SLawrence Mitchell .   mat - the injection
108647c6ae99SBarry Smith 
108747c6ae99SBarry Smith     Level: developer
108847c6ae99SBarry Smith 
108985afcc9aSBarry Smith    Notes:  For DMDA objects this only works for "uniform refinement", that is the refined mesh was obtained DMRefine() or the coarse mesh was obtained by
109085afcc9aSBarry Smith         DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the injection.
109185afcc9aSBarry Smith 
1092e727c939SJed Brown .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMCreateInterpolation()
109347c6ae99SBarry Smith 
109447c6ae99SBarry Smith @*/
10956dbf9973SLawrence Mitchell PetscErrorCode  DMCreateInjection(DM dm1,DM dm2,Mat *mat)
109647c6ae99SBarry Smith {
109747c6ae99SBarry Smith   PetscErrorCode ierr;
109847c6ae99SBarry Smith 
109947c6ae99SBarry Smith   PetscFunctionBegin;
1100171400e9SBarry Smith   PetscValidHeaderSpecific(dm1,DM_CLASSID,1);
1101171400e9SBarry Smith   PetscValidHeaderSpecific(dm2,DM_CLASSID,2);
110223384938SToby Isaac   if (!*dm1->ops->getinjection) SETERRQ(PetscObjectComm((PetscObject)dm1),PETSC_ERR_SUP,"DMCreateInjection not implemented for this type");
11036dbf9973SLawrence Mitchell   ierr = (*dm1->ops->getinjection)(dm1,dm2,mat);CHKERRQ(ierr);
110447c6ae99SBarry Smith   PetscFunctionReturn(0);
110547c6ae99SBarry Smith }
110647c6ae99SBarry Smith 
110747c6ae99SBarry Smith #undef __FUNCT__
1108e727c939SJed Brown #define __FUNCT__ "DMCreateColoring"
1109b412c318SBarry Smith /*@
1110b412c318SBarry Smith     DMCreateColoring - Gets coloring for a DM
111147c6ae99SBarry Smith 
111247c6ae99SBarry Smith     Collective on DM
111347c6ae99SBarry Smith 
111447c6ae99SBarry Smith     Input Parameter:
111547c6ae99SBarry Smith +   dm - the DM object
1116b412c318SBarry Smith -   ctype - IS_COLORING_GHOSTED or IS_COLORING_GLOBAL
111747c6ae99SBarry Smith 
111847c6ae99SBarry Smith     Output Parameter:
111947c6ae99SBarry Smith .   coloring - the coloring
112047c6ae99SBarry Smith 
112147c6ae99SBarry Smith     Level: developer
112247c6ae99SBarry Smith 
1123b412c318SBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateMatrix(), DMSetMatType()
112447c6ae99SBarry Smith 
1125aab9d709SJed Brown @*/
1126b412c318SBarry Smith PetscErrorCode  DMCreateColoring(DM dm,ISColoringType ctype,ISColoring *coloring)
112747c6ae99SBarry Smith {
112847c6ae99SBarry Smith   PetscErrorCode ierr;
112947c6ae99SBarry Smith 
113047c6ae99SBarry Smith   PetscFunctionBegin;
1131171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1132ce94432eSBarry Smith   if (!dm->ops->getcoloring) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"No coloring for this type of DM yet");
1133b412c318SBarry Smith   ierr = (*dm->ops->getcoloring)(dm,ctype,coloring);CHKERRQ(ierr);
113447c6ae99SBarry Smith   PetscFunctionReturn(0);
113547c6ae99SBarry Smith }
113647c6ae99SBarry Smith 
113747c6ae99SBarry Smith #undef __FUNCT__
1138950540a4SJed Brown #define __FUNCT__ "DMCreateMatrix"
1139b412c318SBarry Smith /*@
11408472ad0fSDave May     DMCreateMatrix - Gets empty Jacobian for a DM
114147c6ae99SBarry Smith 
114247c6ae99SBarry Smith     Collective on DM
114347c6ae99SBarry Smith 
114447c6ae99SBarry Smith     Input Parameter:
1145b412c318SBarry Smith .   dm - the DM object
114647c6ae99SBarry Smith 
114747c6ae99SBarry Smith     Output Parameter:
114847c6ae99SBarry Smith .   mat - the empty Jacobian
114947c6ae99SBarry Smith 
1150073dac72SJed Brown     Level: beginner
115147c6ae99SBarry Smith 
115294013140SBarry Smith     Notes: This properly preallocates the number of nonzeros in the sparse matrix so you
115394013140SBarry Smith        do not need to do it yourself.
115494013140SBarry Smith 
115594013140SBarry Smith        By default it also sets the nonzero structure and puts in the zero entries. To prevent setting
1156aa219208SBarry Smith        the nonzero pattern call DMDASetMatPreallocateOnly()
115794013140SBarry Smith 
115894013140SBarry Smith        For structured grid problems, when you call MatView() on this matrix it is displayed using the global natural ordering, NOT in the ordering used
115994013140SBarry Smith        internally by PETSc.
116094013140SBarry Smith 
116194013140SBarry Smith        For structured grid problems, in general it is easiest to use MatSetValuesStencil() or MatSetValuesLocal() to put values into the matrix because MatSetValues() requires
1162aa219208SBarry Smith        the indices for the global numbering for DMDAs which is complicated.
116394013140SBarry Smith 
1164b412c318SBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMSetMatType()
116547c6ae99SBarry Smith 
1166aab9d709SJed Brown @*/
1167b412c318SBarry Smith PetscErrorCode  DMCreateMatrix(DM dm,Mat *mat)
116847c6ae99SBarry Smith {
116947c6ae99SBarry Smith   PetscErrorCode ierr;
117047c6ae99SBarry Smith 
117147c6ae99SBarry Smith   PetscFunctionBegin;
1172171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1173607a6623SBarry Smith   ierr = MatInitializePackage();CHKERRQ(ierr);
1174c7b7c8a4SJed Brown   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1175c7b7c8a4SJed Brown   PetscValidPointer(mat,3);
1176b412c318SBarry Smith   ierr = (*dm->ops->creatematrix)(dm,mat);CHKERRQ(ierr);
117747c6ae99SBarry Smith   PetscFunctionReturn(0);
117847c6ae99SBarry Smith }
117947c6ae99SBarry Smith 
118047c6ae99SBarry Smith #undef __FUNCT__
1181732e2eb9SMatthew G Knepley #define __FUNCT__ "DMSetMatrixPreallocateOnly"
1182732e2eb9SMatthew G Knepley /*@
1183950540a4SJed Brown   DMSetMatrixPreallocateOnly - When DMCreateMatrix() is called the matrix will be properly
1184732e2eb9SMatthew G Knepley     preallocated but the nonzero structure and zero values will not be set.
1185732e2eb9SMatthew G Knepley 
11868472ad0fSDave May   Logically Collective on DM
1187732e2eb9SMatthew G Knepley 
1188732e2eb9SMatthew G Knepley   Input Parameter:
1189732e2eb9SMatthew G Knepley + dm - the DM
1190732e2eb9SMatthew G Knepley - only - PETSC_TRUE if only want preallocation
1191732e2eb9SMatthew G Knepley 
1192732e2eb9SMatthew G Knepley   Level: developer
1193950540a4SJed Brown .seealso DMCreateMatrix()
1194732e2eb9SMatthew G Knepley @*/
1195732e2eb9SMatthew G Knepley PetscErrorCode DMSetMatrixPreallocateOnly(DM dm, PetscBool only)
1196732e2eb9SMatthew G Knepley {
1197732e2eb9SMatthew G Knepley   PetscFunctionBegin;
1198732e2eb9SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1199732e2eb9SMatthew G Knepley   dm->prealloc_only = only;
1200732e2eb9SMatthew G Knepley   PetscFunctionReturn(0);
1201732e2eb9SMatthew G Knepley }
1202732e2eb9SMatthew G Knepley 
1203732e2eb9SMatthew G Knepley #undef __FUNCT__
1204a89ea682SMatthew G Knepley #define __FUNCT__ "DMGetWorkArray"
1205a89ea682SMatthew G Knepley /*@C
1206aa1993deSMatthew G Knepley   DMGetWorkArray - Gets a work array guaranteed to be at least the input size, restore with DMRestoreWorkArray()
1207a89ea682SMatthew G Knepley 
1208a89ea682SMatthew G Knepley   Not Collective
1209a89ea682SMatthew G Knepley 
1210a89ea682SMatthew G Knepley   Input Parameters:
1211a89ea682SMatthew G Knepley + dm - the DM object
1212aa1993deSMatthew G Knepley . count - The minium size
1213aa1993deSMatthew G Knepley - dtype - data type (PETSC_REAL, PETSC_SCALAR, PETSC_INT)
1214a89ea682SMatthew G Knepley 
1215a89ea682SMatthew G Knepley   Output Parameter:
1216a89ea682SMatthew G Knepley . array - the work array
1217a89ea682SMatthew G Knepley 
1218a89ea682SMatthew G Knepley   Level: developer
1219a89ea682SMatthew G Knepley 
1220a89ea682SMatthew G Knepley .seealso DMDestroy(), DMCreate()
1221a89ea682SMatthew G Knepley @*/
1222aa1993deSMatthew G Knepley PetscErrorCode DMGetWorkArray(DM dm,PetscInt count,PetscDataType dtype,void *mem)
1223a89ea682SMatthew G Knepley {
1224a89ea682SMatthew G Knepley   PetscErrorCode ierr;
1225aa1993deSMatthew G Knepley   DMWorkLink     link;
1226854ce69bSBarry Smith   size_t         dsize;
1227a89ea682SMatthew G Knepley 
1228a89ea682SMatthew G Knepley   PetscFunctionBegin;
1229a89ea682SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1230aa1993deSMatthew G Knepley   PetscValidPointer(mem,4);
1231aa1993deSMatthew G Knepley   if (dm->workin) {
1232aa1993deSMatthew G Knepley     link       = dm->workin;
1233aa1993deSMatthew G Knepley     dm->workin = dm->workin->next;
1234aa1993deSMatthew G Knepley   } else {
1235b00a9115SJed Brown     ierr = PetscNewLog(dm,&link);CHKERRQ(ierr);
1236a89ea682SMatthew G Knepley   }
1237854ce69bSBarry Smith   ierr = PetscDataTypeGetSize(dtype,&dsize);CHKERRQ(ierr);
1238854ce69bSBarry Smith   if (dsize*count > link->bytes) {
1239aa1993deSMatthew G Knepley     ierr        = PetscFree(link->mem);CHKERRQ(ierr);
1240854ce69bSBarry Smith     ierr        = PetscMalloc(dsize*count,&link->mem);CHKERRQ(ierr);
1241854ce69bSBarry Smith     link->bytes = dsize*count;
1242aa1993deSMatthew G Knepley   }
1243aa1993deSMatthew G Knepley   link->next   = dm->workout;
1244aa1993deSMatthew G Knepley   dm->workout  = link;
1245aa1993deSMatthew G Knepley   *(void**)mem = link->mem;
1246a89ea682SMatthew G Knepley   PetscFunctionReturn(0);
1247a89ea682SMatthew G Knepley }
1248a89ea682SMatthew G Knepley 
1249aa1993deSMatthew G Knepley #undef __FUNCT__
1250aa1993deSMatthew G Knepley #define __FUNCT__ "DMRestoreWorkArray"
1251aa1993deSMatthew G Knepley /*@C
1252aa1993deSMatthew G Knepley   DMRestoreWorkArray - Restores a work array guaranteed to be at least the input size, restore with DMRestoreWorkArray()
1253aa1993deSMatthew G Knepley 
1254aa1993deSMatthew G Knepley   Not Collective
1255aa1993deSMatthew G Knepley 
1256aa1993deSMatthew G Knepley   Input Parameters:
1257aa1993deSMatthew G Knepley + dm - the DM object
1258aa1993deSMatthew G Knepley . count - The minium size
1259aa1993deSMatthew G Knepley - dtype - data type (PETSC_REAL, PETSC_SCALAR, PETSC_INT)
1260aa1993deSMatthew G Knepley 
1261aa1993deSMatthew G Knepley   Output Parameter:
1262aa1993deSMatthew G Knepley . array - the work array
1263aa1993deSMatthew G Knepley 
1264aa1993deSMatthew G Knepley   Level: developer
1265aa1993deSMatthew G Knepley 
1266aa1993deSMatthew G Knepley .seealso DMDestroy(), DMCreate()
1267aa1993deSMatthew G Knepley @*/
1268aa1993deSMatthew G Knepley PetscErrorCode DMRestoreWorkArray(DM dm,PetscInt count,PetscDataType dtype,void *mem)
1269aa1993deSMatthew G Knepley {
1270aa1993deSMatthew G Knepley   DMWorkLink *p,link;
1271aa1993deSMatthew G Knepley 
1272aa1993deSMatthew G Knepley   PetscFunctionBegin;
1273aa1993deSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1274aa1993deSMatthew G Knepley   PetscValidPointer(mem,4);
1275aa1993deSMatthew G Knepley   for (p=&dm->workout; (link=*p); p=&link->next) {
1276aa1993deSMatthew G Knepley     if (link->mem == *(void**)mem) {
1277aa1993deSMatthew G Knepley       *p           = link->next;
1278aa1993deSMatthew G Knepley       link->next   = dm->workin;
1279aa1993deSMatthew G Knepley       dm->workin   = link;
12800298fd71SBarry Smith       *(void**)mem = NULL;
1281aa1993deSMatthew G Knepley       PetscFunctionReturn(0);
1282aa1993deSMatthew G Knepley     }
1283aa1993deSMatthew G Knepley   }
1284aa1993deSMatthew G Knepley   SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Array was not checked out");
1285aa1993deSMatthew G Knepley }
1286e7c4fc90SDmitry Karpeev 
1287e7c4fc90SDmitry Karpeev #undef __FUNCT__
1288435a35e8SMatthew G Knepley #define __FUNCT__ "DMSetNullSpaceConstructor"
1289435a35e8SMatthew G Knepley PetscErrorCode DMSetNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (*nullsp)(DM dm, PetscInt field, MatNullSpace *nullSpace))
1290435a35e8SMatthew G Knepley {
1291435a35e8SMatthew G Knepley   PetscFunctionBegin;
1292435a35e8SMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
129382f516ccSBarry Smith   if (field >= 10) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field);
1294435a35e8SMatthew G Knepley   dm->nullspaceConstructors[field] = nullsp;
1295435a35e8SMatthew G Knepley   PetscFunctionReturn(0);
1296435a35e8SMatthew G Knepley }
1297435a35e8SMatthew G Knepley 
1298435a35e8SMatthew G Knepley #undef __FUNCT__
12994d343eeaSMatthew G Knepley #define __FUNCT__ "DMCreateFieldIS"
13004f3b5142SJed Brown /*@C
13014d343eeaSMatthew G Knepley   DMCreateFieldIS - Creates a set of IS objects with the global indices of dofs for each field
13024d343eeaSMatthew G Knepley 
13034d343eeaSMatthew G Knepley   Not collective
13044d343eeaSMatthew G Knepley 
13054d343eeaSMatthew G Knepley   Input Parameter:
13064d343eeaSMatthew G Knepley . dm - the DM object
13074d343eeaSMatthew G Knepley 
13084d343eeaSMatthew G Knepley   Output Parameters:
13090298fd71SBarry Smith + numFields  - The number of fields (or NULL if not requested)
13100298fd71SBarry Smith . fieldNames - The name for each field (or NULL if not requested)
13110298fd71SBarry Smith - fields     - The global indices for each field (or NULL if not requested)
13124d343eeaSMatthew G Knepley 
13134d343eeaSMatthew G Knepley   Level: intermediate
13144d343eeaSMatthew G Knepley 
131521c9b008SJed Brown   Notes:
131621c9b008SJed Brown   The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with
131721c9b008SJed Brown   PetscFree(), every entry of fields should be destroyed with ISDestroy(), and both arrays should be freed with
131821c9b008SJed Brown   PetscFree().
131921c9b008SJed Brown 
13204d343eeaSMatthew G Knepley .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
13214d343eeaSMatthew G Knepley @*/
132237d0c07bSMatthew G Knepley PetscErrorCode DMCreateFieldIS(DM dm, PetscInt *numFields, char ***fieldNames, IS **fields)
13234d343eeaSMatthew G Knepley {
132437d0c07bSMatthew G Knepley   PetscSection   section, sectionGlobal;
13254d343eeaSMatthew G Knepley   PetscErrorCode ierr;
13264d343eeaSMatthew G Knepley 
13274d343eeaSMatthew G Knepley   PetscFunctionBegin;
13284d343eeaSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
132969ca1f37SDmitry Karpeev   if (numFields) {
133069ca1f37SDmitry Karpeev     PetscValidPointer(numFields,2);
133169ca1f37SDmitry Karpeev     *numFields = 0;
133269ca1f37SDmitry Karpeev   }
133337d0c07bSMatthew G Knepley   if (fieldNames) {
133437d0c07bSMatthew G Knepley     PetscValidPointer(fieldNames,3);
13350298fd71SBarry Smith     *fieldNames = NULL;
133669ca1f37SDmitry Karpeev   }
133769ca1f37SDmitry Karpeev   if (fields) {
133869ca1f37SDmitry Karpeev     PetscValidPointer(fields,4);
13390298fd71SBarry Smith     *fields = NULL;
134069ca1f37SDmitry Karpeev   }
134137d0c07bSMatthew G Knepley   ierr = DMGetDefaultSection(dm, &section);CHKERRQ(ierr);
134237d0c07bSMatthew G Knepley   if (section) {
134337d0c07bSMatthew G Knepley     PetscInt *fieldSizes, **fieldIndices;
134437d0c07bSMatthew G Knepley     PetscInt nF, f, pStart, pEnd, p;
134537d0c07bSMatthew G Knepley 
134637d0c07bSMatthew G Knepley     ierr = DMGetDefaultGlobalSection(dm, &sectionGlobal);CHKERRQ(ierr);
134737d0c07bSMatthew G Knepley     ierr = PetscSectionGetNumFields(section, &nF);CHKERRQ(ierr);
1348dcca6d9dSJed Brown     ierr = PetscMalloc2(nF,&fieldSizes,nF,&fieldIndices);CHKERRQ(ierr);
134937d0c07bSMatthew G Knepley     ierr = PetscSectionGetChart(sectionGlobal, &pStart, &pEnd);CHKERRQ(ierr);
135037d0c07bSMatthew G Knepley     for (f = 0; f < nF; ++f) {
135137d0c07bSMatthew G Knepley       fieldSizes[f] = 0;
135237d0c07bSMatthew G Knepley     }
135337d0c07bSMatthew G Knepley     for (p = pStart; p < pEnd; ++p) {
135437d0c07bSMatthew G Knepley       PetscInt gdof;
135537d0c07bSMatthew G Knepley 
135637d0c07bSMatthew G Knepley       ierr = PetscSectionGetDof(sectionGlobal, p, &gdof);CHKERRQ(ierr);
135737d0c07bSMatthew G Knepley       if (gdof > 0) {
135837d0c07bSMatthew G Knepley         for (f = 0; f < nF; ++f) {
135937d0c07bSMatthew G Knepley           PetscInt fdof, fcdof;
136037d0c07bSMatthew G Knepley 
136137d0c07bSMatthew G Knepley           ierr           = PetscSectionGetFieldDof(section, p, f, &fdof);CHKERRQ(ierr);
136237d0c07bSMatthew G Knepley           ierr           = PetscSectionGetFieldConstraintDof(section, p, f, &fcdof);CHKERRQ(ierr);
136337d0c07bSMatthew G Knepley           fieldSizes[f] += fdof-fcdof;
136437d0c07bSMatthew G Knepley         }
136537d0c07bSMatthew G Knepley       }
136637d0c07bSMatthew G Knepley     }
136737d0c07bSMatthew G Knepley     for (f = 0; f < nF; ++f) {
1368785e854fSJed Brown       ierr          = PetscMalloc1(fieldSizes[f], &fieldIndices[f]);CHKERRQ(ierr);
136937d0c07bSMatthew G Knepley       fieldSizes[f] = 0;
137037d0c07bSMatthew G Knepley     }
137137d0c07bSMatthew G Knepley     for (p = pStart; p < pEnd; ++p) {
137237d0c07bSMatthew G Knepley       PetscInt gdof, goff;
137337d0c07bSMatthew G Knepley 
137437d0c07bSMatthew G Knepley       ierr = PetscSectionGetDof(sectionGlobal, p, &gdof);CHKERRQ(ierr);
137537d0c07bSMatthew G Knepley       if (gdof > 0) {
137637d0c07bSMatthew G Knepley         ierr = PetscSectionGetOffset(sectionGlobal, p, &goff);CHKERRQ(ierr);
137737d0c07bSMatthew G Knepley         for (f = 0; f < nF; ++f) {
137837d0c07bSMatthew G Knepley           PetscInt fdof, fcdof, fc;
137937d0c07bSMatthew G Knepley 
138037d0c07bSMatthew G Knepley           ierr = PetscSectionGetFieldDof(section, p, f, &fdof);CHKERRQ(ierr);
138137d0c07bSMatthew G Knepley           ierr = PetscSectionGetFieldConstraintDof(section, p, f, &fcdof);CHKERRQ(ierr);
138237d0c07bSMatthew G Knepley           for (fc = 0; fc < fdof-fcdof; ++fc, ++fieldSizes[f]) {
138337d0c07bSMatthew G Knepley             fieldIndices[f][fieldSizes[f]] = goff++;
138437d0c07bSMatthew G Knepley           }
138537d0c07bSMatthew G Knepley         }
138637d0c07bSMatthew G Knepley       }
138737d0c07bSMatthew G Knepley     }
13888865f1eaSKarl Rupp     if (numFields) *numFields = nF;
138937d0c07bSMatthew G Knepley     if (fieldNames) {
1390785e854fSJed Brown       ierr = PetscMalloc1(nF, fieldNames);CHKERRQ(ierr);
139137d0c07bSMatthew G Knepley       for (f = 0; f < nF; ++f) {
139237d0c07bSMatthew G Knepley         const char *fieldName;
139337d0c07bSMatthew G Knepley 
139437d0c07bSMatthew G Knepley         ierr = PetscSectionGetFieldName(section, f, &fieldName);CHKERRQ(ierr);
139537d0c07bSMatthew G Knepley         ierr = PetscStrallocpy(fieldName, (char**) &(*fieldNames)[f]);CHKERRQ(ierr);
139637d0c07bSMatthew G Knepley       }
139737d0c07bSMatthew G Knepley     }
139837d0c07bSMatthew G Knepley     if (fields) {
1399785e854fSJed Brown       ierr = PetscMalloc1(nF, fields);CHKERRQ(ierr);
140037d0c07bSMatthew G Knepley       for (f = 0; f < nF; ++f) {
140182f516ccSBarry Smith         ierr = ISCreateGeneral(PetscObjectComm((PetscObject)dm), fieldSizes[f], fieldIndices[f], PETSC_OWN_POINTER, &(*fields)[f]);CHKERRQ(ierr);
140237d0c07bSMatthew G Knepley       }
140337d0c07bSMatthew G Knepley     }
140437d0c07bSMatthew G Knepley     ierr = PetscFree2(fieldSizes,fieldIndices);CHKERRQ(ierr);
14058865f1eaSKarl Rupp   } else if (dm->ops->createfieldis) {
14068865f1eaSKarl Rupp     ierr = (*dm->ops->createfieldis)(dm, numFields, fieldNames, fields);CHKERRQ(ierr);
140769ca1f37SDmitry Karpeev   }
14084d343eeaSMatthew G Knepley   PetscFunctionReturn(0);
14094d343eeaSMatthew G Knepley }
14104d343eeaSMatthew G Knepley 
141116621825SDmitry Karpeev 
141216621825SDmitry Karpeev #undef __FUNCT__
141316621825SDmitry Karpeev #define __FUNCT__ "DMCreateFieldDecomposition"
141416621825SDmitry Karpeev /*@C
141516621825SDmitry Karpeev   DMCreateFieldDecomposition - Returns a list of IS objects defining a decomposition of a problem into subproblems
141616621825SDmitry Karpeev                           corresponding to different fields: each IS contains the global indices of the dofs of the
141716621825SDmitry Karpeev                           corresponding field. The optional list of DMs define the DM for each subproblem.
1418e7c4fc90SDmitry Karpeev                           Generalizes DMCreateFieldIS().
1419e7c4fc90SDmitry Karpeev 
1420e7c4fc90SDmitry Karpeev   Not collective
1421e7c4fc90SDmitry Karpeev 
1422e7c4fc90SDmitry Karpeev   Input Parameter:
1423e7c4fc90SDmitry Karpeev . dm - the DM object
1424e7c4fc90SDmitry Karpeev 
1425e7c4fc90SDmitry Karpeev   Output Parameters:
14260298fd71SBarry Smith + len       - The number of subproblems in the field decomposition (or NULL if not requested)
14270298fd71SBarry Smith . namelist  - The name for each field (or NULL if not requested)
14280298fd71SBarry Smith . islist    - The global indices for each field (or NULL if not requested)
14290298fd71SBarry Smith - dmlist    - The DMs for each field subproblem (or NULL, if not requested; if NULL is returned, no DMs are defined)
1430e7c4fc90SDmitry Karpeev 
1431e7c4fc90SDmitry Karpeev   Level: intermediate
1432e7c4fc90SDmitry Karpeev 
1433e7c4fc90SDmitry Karpeev   Notes:
1434e7c4fc90SDmitry Karpeev   The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with
1435e7c4fc90SDmitry Karpeev   PetscFree(), every entry of is should be destroyed with ISDestroy(), every entry of dm should be destroyed with DMDestroy(),
1436e7c4fc90SDmitry Karpeev   and all of the arrays should be freed with PetscFree().
1437e7c4fc90SDmitry Karpeev 
1438e7c4fc90SDmitry Karpeev .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS()
1439e7c4fc90SDmitry Karpeev @*/
144016621825SDmitry Karpeev PetscErrorCode DMCreateFieldDecomposition(DM dm, PetscInt *len, char ***namelist, IS **islist, DM **dmlist)
1441e7c4fc90SDmitry Karpeev {
1442e7c4fc90SDmitry Karpeev   PetscErrorCode ierr;
1443e7c4fc90SDmitry Karpeev 
1444e7c4fc90SDmitry Karpeev   PetscFunctionBegin;
1445e7c4fc90SDmitry Karpeev   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
14468865f1eaSKarl Rupp   if (len) {
14478865f1eaSKarl Rupp     PetscValidPointer(len,2);
14488865f1eaSKarl Rupp     *len = 0;
14498865f1eaSKarl Rupp   }
14508865f1eaSKarl Rupp   if (namelist) {
14518865f1eaSKarl Rupp     PetscValidPointer(namelist,3);
14528865f1eaSKarl Rupp     *namelist = 0;
14538865f1eaSKarl Rupp   }
14548865f1eaSKarl Rupp   if (islist) {
14558865f1eaSKarl Rupp     PetscValidPointer(islist,4);
14568865f1eaSKarl Rupp     *islist = 0;
14578865f1eaSKarl Rupp   }
14588865f1eaSKarl Rupp   if (dmlist) {
14598865f1eaSKarl Rupp     PetscValidPointer(dmlist,5);
14608865f1eaSKarl Rupp     *dmlist = 0;
14618865f1eaSKarl Rupp   }
1462f3f0edfdSDmitry Karpeev   /*
1463f3f0edfdSDmitry Karpeev    Is it a good idea to apply the following check across all impls?
1464f3f0edfdSDmitry Karpeev    Perhaps some impls can have a well-defined decomposition before DMSetUp?
1465f3f0edfdSDmitry Karpeev    This, however, follows the general principle that accessors are not well-behaved until the object is set up.
1466f3f0edfdSDmitry Karpeev    */
1467ce94432eSBarry Smith   if (!dm->setupcalled) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_WRONGSTATE, "Decomposition defined only after DMSetUp");
146816621825SDmitry Karpeev   if (!dm->ops->createfielddecomposition) {
1469435a35e8SMatthew G Knepley     PetscSection section;
1470435a35e8SMatthew G Knepley     PetscInt     numFields, f;
1471435a35e8SMatthew G Knepley 
1472435a35e8SMatthew G Knepley     ierr = DMGetDefaultSection(dm, &section);CHKERRQ(ierr);
1473435a35e8SMatthew G Knepley     if (section) {ierr = PetscSectionGetNumFields(section, &numFields);CHKERRQ(ierr);}
1474435a35e8SMatthew G Knepley     if (section && numFields && dm->ops->createsubdm) {
1475f25d98f1SMatthew G. Knepley       if (len) *len = numFields;
147603dc3394SMatthew G. Knepley       if (namelist) {ierr = PetscMalloc1(numFields,namelist);CHKERRQ(ierr);}
147703dc3394SMatthew G. Knepley       if (islist)   {ierr = PetscMalloc1(numFields,islist);CHKERRQ(ierr);}
147803dc3394SMatthew G. Knepley       if (dmlist)   {ierr = PetscMalloc1(numFields,dmlist);CHKERRQ(ierr);}
1479435a35e8SMatthew G Knepley       for (f = 0; f < numFields; ++f) {
1480435a35e8SMatthew G Knepley         const char *fieldName;
1481435a35e8SMatthew G Knepley 
148203dc3394SMatthew G. Knepley         ierr = DMCreateSubDM(dm, 1, &f, islist ? &(*islist)[f] : NULL, dmlist ? &(*dmlist)[f] : NULL);CHKERRQ(ierr);
148303dc3394SMatthew G. Knepley         if (namelist) {
1484435a35e8SMatthew G Knepley           ierr = PetscSectionGetFieldName(section, f, &fieldName);CHKERRQ(ierr);
1485435a35e8SMatthew G Knepley           ierr = PetscStrallocpy(fieldName, (char**) &(*namelist)[f]);CHKERRQ(ierr);
1486435a35e8SMatthew G Knepley         }
148703dc3394SMatthew G. Knepley       }
1488435a35e8SMatthew G Knepley     } else {
148969ca1f37SDmitry Karpeev       ierr = DMCreateFieldIS(dm, len, namelist, islist);CHKERRQ(ierr);
1490e7c4fc90SDmitry Karpeev       /* By default there are no DMs associated with subproblems. */
14910298fd71SBarry Smith       if (dmlist) *dmlist = NULL;
1492e7c4fc90SDmitry Karpeev     }
14938865f1eaSKarl Rupp   } else {
149416621825SDmitry Karpeev     ierr = (*dm->ops->createfielddecomposition)(dm,len,namelist,islist,dmlist);CHKERRQ(ierr);
149516621825SDmitry Karpeev   }
149616621825SDmitry Karpeev   PetscFunctionReturn(0);
149716621825SDmitry Karpeev }
149816621825SDmitry Karpeev 
149916621825SDmitry Karpeev #undef __FUNCT__
1500435a35e8SMatthew G Knepley #define __FUNCT__ "DMCreateSubDM"
1501564cec59SMatthew G. Knepley /*@
1502435a35e8SMatthew G Knepley   DMCreateSubDM - Returns an IS and DM encapsulating a subproblem defined by the fields passed in.
1503435a35e8SMatthew G Knepley                   The fields are defined by DMCreateFieldIS().
1504435a35e8SMatthew G Knepley 
1505435a35e8SMatthew G Knepley   Not collective
1506435a35e8SMatthew G Knepley 
1507435a35e8SMatthew G Knepley   Input Parameters:
1508435a35e8SMatthew G Knepley + dm - the DM object
1509435a35e8SMatthew G Knepley . numFields - number of fields in this subproblem
15100298fd71SBarry Smith - len       - The number of subproblems in the decomposition (or NULL if not requested)
1511435a35e8SMatthew G Knepley 
1512435a35e8SMatthew G Knepley   Output Parameters:
1513435a35e8SMatthew G Knepley . is - The global indices for the subproblem
1514435a35e8SMatthew G Knepley - dm - The DM for the subproblem
1515435a35e8SMatthew G Knepley 
1516435a35e8SMatthew G Knepley   Level: intermediate
1517435a35e8SMatthew G Knepley 
1518435a35e8SMatthew G Knepley .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS()
1519435a35e8SMatthew G Knepley @*/
1520435a35e8SMatthew G Knepley PetscErrorCode DMCreateSubDM(DM dm, PetscInt numFields, PetscInt fields[], IS *is, DM *subdm)
1521435a35e8SMatthew G Knepley {
1522435a35e8SMatthew G Knepley   PetscErrorCode ierr;
1523435a35e8SMatthew G Knepley 
1524435a35e8SMatthew G Knepley   PetscFunctionBegin;
1525435a35e8SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1526435a35e8SMatthew G Knepley   PetscValidPointer(fields,3);
15278865f1eaSKarl Rupp   if (is) PetscValidPointer(is,4);
15288865f1eaSKarl Rupp   if (subdm) PetscValidPointer(subdm,5);
1529435a35e8SMatthew G Knepley   if (dm->ops->createsubdm) {
1530435a35e8SMatthew G Knepley     ierr = (*dm->ops->createsubdm)(dm, numFields, fields, is, subdm);CHKERRQ(ierr);
153182f516ccSBarry Smith   } else SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "This type has no DMCreateSubDM implementation defined");
1532435a35e8SMatthew G Knepley   PetscFunctionReturn(0);
1533435a35e8SMatthew G Knepley }
1534435a35e8SMatthew G Knepley 
153516621825SDmitry Karpeev 
153616621825SDmitry Karpeev #undef __FUNCT__
153716621825SDmitry Karpeev #define __FUNCT__ "DMCreateDomainDecomposition"
153816621825SDmitry Karpeev /*@C
15398d4ac253SDmitry Karpeev   DMCreateDomainDecomposition - Returns lists of IS objects defining a decomposition of a problem into subproblems
15408d4ac253SDmitry Karpeev                           corresponding to restrictions to pairs nested subdomains: each IS contains the global
15418d4ac253SDmitry Karpeev                           indices of the dofs of the corresponding subdomains.  The inner subdomains conceptually
15428d4ac253SDmitry Karpeev                           define a nonoverlapping covering, while outer subdomains can overlap.
15438d4ac253SDmitry Karpeev                           The optional list of DMs define the DM for each subproblem.
154416621825SDmitry Karpeev 
154516621825SDmitry Karpeev   Not collective
154616621825SDmitry Karpeev 
154716621825SDmitry Karpeev   Input Parameter:
154816621825SDmitry Karpeev . dm - the DM object
154916621825SDmitry Karpeev 
155016621825SDmitry Karpeev   Output Parameters:
15510298fd71SBarry Smith + len         - The number of subproblems in the domain decomposition (or NULL if not requested)
15520298fd71SBarry Smith . namelist    - The name for each subdomain (or NULL if not requested)
15530298fd71SBarry Smith . innerislist - The global indices for each inner subdomain (or NULL, if not requested)
15540298fd71SBarry Smith . outerislist - The global indices for each outer subdomain (or NULL, if not requested)
15550298fd71SBarry Smith - dmlist      - The DMs for each subdomain subproblem (or NULL, if not requested; if NULL is returned, no DMs are defined)
155616621825SDmitry Karpeev 
155716621825SDmitry Karpeev   Level: intermediate
155816621825SDmitry Karpeev 
155916621825SDmitry Karpeev   Notes:
156016621825SDmitry Karpeev   The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with
156116621825SDmitry Karpeev   PetscFree(), every entry of is should be destroyed with ISDestroy(), every entry of dm should be destroyed with DMDestroy(),
156216621825SDmitry Karpeev   and all of the arrays should be freed with PetscFree().
156316621825SDmitry Karpeev 
15648d4ac253SDmitry Karpeev .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateDomainDecompositionDM(), DMCreateFieldDecomposition()
156516621825SDmitry Karpeev @*/
15668d4ac253SDmitry Karpeev PetscErrorCode DMCreateDomainDecomposition(DM dm, PetscInt *len, char ***namelist, IS **innerislist, IS **outerislist, DM **dmlist)
156716621825SDmitry Karpeev {
156816621825SDmitry Karpeev   PetscErrorCode      ierr;
1569be081cd6SPeter Brune   DMSubDomainHookLink link;
1570be081cd6SPeter Brune   PetscInt            i,l;
157116621825SDmitry Karpeev 
157216621825SDmitry Karpeev   PetscFunctionBegin;
157316621825SDmitry Karpeev   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
157414a18fd3SPeter Brune   if (len)           {PetscValidPointer(len,2);            *len         = 0;}
15750298fd71SBarry Smith   if (namelist)      {PetscValidPointer(namelist,3);       *namelist    = NULL;}
15760298fd71SBarry Smith   if (innerislist)   {PetscValidPointer(innerislist,4);    *innerislist = NULL;}
15770298fd71SBarry Smith   if (outerislist)   {PetscValidPointer(outerislist,5);    *outerislist = NULL;}
15780298fd71SBarry Smith   if (dmlist)        {PetscValidPointer(dmlist,6);         *dmlist      = NULL;}
1579f3f0edfdSDmitry Karpeev   /*
1580f3f0edfdSDmitry Karpeev    Is it a good idea to apply the following check across all impls?
1581f3f0edfdSDmitry Karpeev    Perhaps some impls can have a well-defined decomposition before DMSetUp?
1582f3f0edfdSDmitry Karpeev    This, however, follows the general principle that accessors are not well-behaved until the object is set up.
1583f3f0edfdSDmitry Karpeev    */
1584ce94432eSBarry Smith   if (!dm->setupcalled) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_WRONGSTATE, "Decomposition defined only after DMSetUp");
158516621825SDmitry Karpeev   if (dm->ops->createdomaindecomposition) {
1586be081cd6SPeter Brune     ierr = (*dm->ops->createdomaindecomposition)(dm,&l,namelist,innerislist,outerislist,dmlist);CHKERRQ(ierr);
158714a18fd3SPeter Brune     /* copy subdomain hooks and context over to the subdomain DMs */
1588f891f5b9SPatrick Sanan     if (dmlist && *dmlist) {
1589be081cd6SPeter Brune       for (i = 0; i < l; i++) {
1590be081cd6SPeter Brune         for (link=dm->subdomainhook; link; link=link->next) {
1591be081cd6SPeter Brune           if (link->ddhook) {ierr = (*link->ddhook)(dm,(*dmlist)[i],link->ctx);CHKERRQ(ierr);}
1592be081cd6SPeter Brune         }
1593d425c654SPeter Brune         (*dmlist)[i]->ctx = dm->ctx;
1594e7c4fc90SDmitry Karpeev       }
159514a18fd3SPeter Brune     }
159614a18fd3SPeter Brune     if (len) *len = l;
159714a18fd3SPeter Brune   }
1598e30e807fSPeter Brune   PetscFunctionReturn(0);
1599e30e807fSPeter Brune }
1600e30e807fSPeter Brune 
1601e30e807fSPeter Brune 
1602e30e807fSPeter Brune #undef __FUNCT__
1603e30e807fSPeter Brune #define __FUNCT__ "DMCreateDomainDecompositionScatters"
1604e30e807fSPeter Brune /*@C
1605e30e807fSPeter Brune   DMCreateDomainDecompositionScatters - Returns scatters to the subdomain vectors from the global vector
1606e30e807fSPeter Brune 
1607e30e807fSPeter Brune   Not collective
1608e30e807fSPeter Brune 
1609e30e807fSPeter Brune   Input Parameters:
1610e30e807fSPeter Brune + dm - the DM object
1611e30e807fSPeter Brune . n  - the number of subdomain scatters
1612e30e807fSPeter Brune - subdms - the local subdomains
1613e30e807fSPeter Brune 
1614e30e807fSPeter Brune   Output Parameters:
1615e30e807fSPeter Brune + n     - the number of scatters returned
1616e30e807fSPeter Brune . iscat - scatter from global vector to nonoverlapping global vector entries on subdomain
1617e30e807fSPeter Brune . oscat - scatter from global vector to overlapping global vector entries on subdomain
1618e30e807fSPeter Brune - gscat - scatter from global vector to local vector on subdomain (fills in ghosts)
1619e30e807fSPeter Brune 
1620e30e807fSPeter Brune   Notes: This is an alternative to the iis and ois arguments in DMCreateDomainDecomposition that allow for the solution
1621e30e807fSPeter Brune   of general nonlinear problems with overlapping subdomain methods.  While merely having index sets that enable subsets
1622e30e807fSPeter Brune   of the residual equations to be created is fine for linear problems, nonlinear problems require local assembly of
1623e30e807fSPeter Brune   solution and residual data.
1624e30e807fSPeter Brune 
1625e30e807fSPeter Brune   Level: developer
1626e30e807fSPeter Brune 
1627e30e807fSPeter Brune .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS()
1628e30e807fSPeter Brune @*/
1629e30e807fSPeter Brune PetscErrorCode DMCreateDomainDecompositionScatters(DM dm,PetscInt n,DM *subdms,VecScatter **iscat,VecScatter **oscat,VecScatter **gscat)
1630e30e807fSPeter Brune {
1631e30e807fSPeter Brune   PetscErrorCode ierr;
1632e30e807fSPeter Brune 
1633e30e807fSPeter Brune   PetscFunctionBegin;
1634e30e807fSPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1635e30e807fSPeter Brune   PetscValidPointer(subdms,3);
1636e30e807fSPeter Brune   if (dm->ops->createddscatters) {
1637e30e807fSPeter Brune     ierr = (*dm->ops->createddscatters)(dm,n,subdms,iscat,oscat,gscat);CHKERRQ(ierr);
16386668ed41SLisandro Dalcin   } else SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "This type has no DMCreateDomainDecompositionScatter implementation defined");
1639e7c4fc90SDmitry Karpeev   PetscFunctionReturn(0);
1640e7c4fc90SDmitry Karpeev }
1641e7c4fc90SDmitry Karpeev 
1642731c8d9eSDmitry Karpeev #undef __FUNCT__
164347c6ae99SBarry Smith #define __FUNCT__ "DMRefine"
164447c6ae99SBarry Smith /*@
164547c6ae99SBarry Smith   DMRefine - Refines a DM object
164647c6ae99SBarry Smith 
164747c6ae99SBarry Smith   Collective on DM
164847c6ae99SBarry Smith 
164947c6ae99SBarry Smith   Input Parameter:
165047c6ae99SBarry Smith + dm   - the DM object
165191d95f02SJed Brown - comm - the communicator to contain the new DM object (or MPI_COMM_NULL)
165247c6ae99SBarry Smith 
165347c6ae99SBarry Smith   Output Parameter:
16540298fd71SBarry Smith . dmf - the refined DM, or NULL
1655ae0a1c52SMatthew G Knepley 
16560298fd71SBarry Smith   Note: If no refinement was done, the return value is NULL
165747c6ae99SBarry Smith 
165847c6ae99SBarry Smith   Level: developer
165947c6ae99SBarry Smith 
1660e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
166147c6ae99SBarry Smith @*/
16627087cfbeSBarry Smith PetscErrorCode  DMRefine(DM dm,MPI_Comm comm,DM *dmf)
166347c6ae99SBarry Smith {
166447c6ae99SBarry Smith   PetscErrorCode   ierr;
1665c833c3b5SJed Brown   DMRefineHookLink link;
166647c6ae99SBarry Smith 
166747c6ae99SBarry Smith   PetscFunctionBegin;
1668732e2eb9SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1669fef3a512SBarry Smith   if (!dm->ops->refine) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"This DM cannot refine");
167047c6ae99SBarry Smith   ierr = (*dm->ops->refine)(dm,comm,dmf);CHKERRQ(ierr);
16714057135bSMatthew G Knepley   if (*dmf) {
167243842a1eSJed Brown     (*dmf)->ops->creatematrix = dm->ops->creatematrix;
16738865f1eaSKarl Rupp 
16748cd211a4SJed Brown     ierr = PetscObjectCopyFortranFunctionPointers((PetscObject)dm,(PetscObject)*dmf);CHKERRQ(ierr);
16758865f1eaSKarl Rupp 
1676644e2e5bSBarry Smith     (*dmf)->ctx       = dm->ctx;
16770598a293SJed Brown     (*dmf)->leveldown = dm->leveldown;
1678656b349aSBarry Smith     (*dmf)->levelup   = dm->levelup + 1;
16798865f1eaSKarl Rupp 
1680e4b4b23bSJed Brown     ierr = DMSetMatType(*dmf,dm->mattype);CHKERRQ(ierr);
1681c833c3b5SJed Brown     for (link=dm->refinehook; link; link=link->next) {
16828865f1eaSKarl Rupp       if (link->refinehook) {
16838865f1eaSKarl Rupp         ierr = (*link->refinehook)(dm,*dmf,link->ctx);CHKERRQ(ierr);
16848865f1eaSKarl Rupp       }
1685c833c3b5SJed Brown     }
1686c833c3b5SJed Brown   }
1687c833c3b5SJed Brown   PetscFunctionReturn(0);
1688c833c3b5SJed Brown }
1689c833c3b5SJed Brown 
1690c833c3b5SJed Brown #undef __FUNCT__
1691c833c3b5SJed Brown #define __FUNCT__ "DMRefineHookAdd"
1692bb9467b5SJed Brown /*@C
1693c833c3b5SJed Brown    DMRefineHookAdd - adds a callback to be run when interpolating a nonlinear problem to a finer grid
1694c833c3b5SJed Brown 
1695c833c3b5SJed Brown    Logically Collective
1696c833c3b5SJed Brown 
1697c833c3b5SJed Brown    Input Arguments:
1698c833c3b5SJed Brown +  coarse - nonlinear solver context on which to run a hook when restricting to a coarser level
1699c833c3b5SJed Brown .  refinehook - function to run when setting up a coarser level
1700c833c3b5SJed Brown .  interphook - function to run to update data on finer levels (once per SNESSolve())
17010298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
1702c833c3b5SJed Brown 
1703c833c3b5SJed Brown    Calling sequence of refinehook:
1704c833c3b5SJed Brown $    refinehook(DM coarse,DM fine,void *ctx);
1705c833c3b5SJed Brown 
1706c833c3b5SJed Brown +  coarse - coarse level DM
1707c833c3b5SJed Brown .  fine - fine level DM to interpolate problem to
1708c833c3b5SJed Brown -  ctx - optional user-defined function context
1709c833c3b5SJed Brown 
1710c833c3b5SJed Brown    Calling sequence for interphook:
1711c833c3b5SJed Brown $    interphook(DM coarse,Mat interp,DM fine,void *ctx)
1712c833c3b5SJed Brown 
1713c833c3b5SJed Brown +  coarse - coarse level DM
1714c833c3b5SJed Brown .  interp - matrix interpolating a coarse-level solution to the finer grid
1715c833c3b5SJed Brown .  fine - fine level DM to update
1716c833c3b5SJed Brown -  ctx - optional user-defined function context
1717c833c3b5SJed Brown 
1718c833c3b5SJed Brown    Level: advanced
1719c833c3b5SJed Brown 
1720c833c3b5SJed Brown    Notes:
1721c833c3b5SJed Brown    This function is only needed if auxiliary data needs to be passed to fine grids while grid sequencing
1722c833c3b5SJed Brown 
1723c833c3b5SJed Brown    If this function is called multiple times, the hooks will be run in the order they are added.
1724c833c3b5SJed Brown 
1725bb9467b5SJed Brown    This function is currently not available from Fortran.
1726bb9467b5SJed Brown 
1727c833c3b5SJed Brown .seealso: DMCoarsenHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
1728c833c3b5SJed Brown @*/
1729c833c3b5SJed Brown PetscErrorCode DMRefineHookAdd(DM coarse,PetscErrorCode (*refinehook)(DM,DM,void*),PetscErrorCode (*interphook)(DM,Mat,DM,void*),void *ctx)
1730c833c3b5SJed Brown {
1731c833c3b5SJed Brown   PetscErrorCode   ierr;
1732c833c3b5SJed Brown   DMRefineHookLink link,*p;
1733c833c3b5SJed Brown 
1734c833c3b5SJed Brown   PetscFunctionBegin;
1735c833c3b5SJed Brown   PetscValidHeaderSpecific(coarse,DM_CLASSID,1);
1736c833c3b5SJed Brown   for (p=&coarse->refinehook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */
1737c833c3b5SJed Brown   ierr             = PetscMalloc(sizeof(struct _DMRefineHookLink),&link);CHKERRQ(ierr);
1738c833c3b5SJed Brown   link->refinehook = refinehook;
1739c833c3b5SJed Brown   link->interphook = interphook;
1740c833c3b5SJed Brown   link->ctx        = ctx;
17410298fd71SBarry Smith   link->next       = NULL;
1742c833c3b5SJed Brown   *p               = link;
1743c833c3b5SJed Brown   PetscFunctionReturn(0);
1744c833c3b5SJed Brown }
1745c833c3b5SJed Brown 
1746c833c3b5SJed Brown #undef __FUNCT__
1747c833c3b5SJed Brown #define __FUNCT__ "DMInterpolate"
1748c833c3b5SJed Brown /*@
1749c833c3b5SJed Brown    DMInterpolate - interpolates user-defined problem data to a finer DM by running hooks registered by DMRefineHookAdd()
1750c833c3b5SJed Brown 
1751c833c3b5SJed Brown    Collective if any hooks are
1752c833c3b5SJed Brown 
1753c833c3b5SJed Brown    Input Arguments:
1754c833c3b5SJed Brown +  coarse - coarser DM to use as a base
1755c833c3b5SJed Brown .  restrct - interpolation matrix, apply using MatInterpolate()
1756c833c3b5SJed Brown -  fine - finer DM to update
1757c833c3b5SJed Brown 
1758c833c3b5SJed Brown    Level: developer
1759c833c3b5SJed Brown 
1760c833c3b5SJed Brown .seealso: DMRefineHookAdd(), MatInterpolate()
1761c833c3b5SJed Brown @*/
1762c833c3b5SJed Brown PetscErrorCode DMInterpolate(DM coarse,Mat interp,DM fine)
1763c833c3b5SJed Brown {
1764c833c3b5SJed Brown   PetscErrorCode   ierr;
1765c833c3b5SJed Brown   DMRefineHookLink link;
1766c833c3b5SJed Brown 
1767c833c3b5SJed Brown   PetscFunctionBegin;
1768c833c3b5SJed Brown   for (link=fine->refinehook; link; link=link->next) {
17698865f1eaSKarl Rupp     if (link->interphook) {
17708865f1eaSKarl Rupp       ierr = (*link->interphook)(coarse,interp,fine,link->ctx);CHKERRQ(ierr);
17718865f1eaSKarl Rupp     }
17724057135bSMatthew G Knepley   }
177347c6ae99SBarry Smith   PetscFunctionReturn(0);
177447c6ae99SBarry Smith }
177547c6ae99SBarry Smith 
177647c6ae99SBarry Smith #undef __FUNCT__
1777eb3f98d2SBarry Smith #define __FUNCT__ "DMGetRefineLevel"
1778eb3f98d2SBarry Smith /*@
1779eb3f98d2SBarry Smith     DMGetRefineLevel - Get's the number of refinements that have generated this DM.
1780eb3f98d2SBarry Smith 
1781eb3f98d2SBarry Smith     Not Collective
1782eb3f98d2SBarry Smith 
1783eb3f98d2SBarry Smith     Input Parameter:
1784eb3f98d2SBarry Smith .   dm - the DM object
1785eb3f98d2SBarry Smith 
1786eb3f98d2SBarry Smith     Output Parameter:
1787eb3f98d2SBarry Smith .   level - number of refinements
1788eb3f98d2SBarry Smith 
1789eb3f98d2SBarry Smith     Level: developer
1790eb3f98d2SBarry Smith 
17916a7d9d85SPeter Brune .seealso DMCoarsen(), DMGetCoarsenLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
1792eb3f98d2SBarry Smith 
1793eb3f98d2SBarry Smith @*/
1794eb3f98d2SBarry Smith PetscErrorCode  DMGetRefineLevel(DM dm,PetscInt *level)
1795eb3f98d2SBarry Smith {
1796eb3f98d2SBarry Smith   PetscFunctionBegin;
1797eb3f98d2SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1798eb3f98d2SBarry Smith   *level = dm->levelup;
1799eb3f98d2SBarry Smith   PetscFunctionReturn(0);
1800eb3f98d2SBarry Smith }
1801eb3f98d2SBarry Smith 
1802eb3f98d2SBarry Smith #undef __FUNCT__
1803fef3a512SBarry Smith #define __FUNCT__ "DMSetRefineLevel"
1804fef3a512SBarry Smith /*@
1805fef3a512SBarry Smith     DMSetRefineLevel - Set's the number of refinements that have generated this DM.
1806fef3a512SBarry Smith 
1807fef3a512SBarry Smith     Not Collective
1808fef3a512SBarry Smith 
1809fef3a512SBarry Smith     Input Parameter:
1810fef3a512SBarry Smith +   dm - the DM object
1811fef3a512SBarry Smith -   level - number of refinements
1812fef3a512SBarry Smith 
1813fef3a512SBarry Smith     Level: advanced
1814fef3a512SBarry Smith 
1815fef3a512SBarry Smith     Notes: This value is used by PCMG to determine how many multigrid levels to use
1816fef3a512SBarry Smith 
1817fef3a512SBarry Smith .seealso DMCoarsen(), DMGetCoarsenLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
1818fef3a512SBarry Smith 
1819fef3a512SBarry Smith @*/
1820fef3a512SBarry Smith PetscErrorCode  DMSetRefineLevel(DM dm,PetscInt level)
1821fef3a512SBarry Smith {
1822fef3a512SBarry Smith   PetscFunctionBegin;
1823fef3a512SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1824fef3a512SBarry Smith   dm->levelup = level;
1825fef3a512SBarry Smith   PetscFunctionReturn(0);
1826fef3a512SBarry Smith }
1827fef3a512SBarry Smith 
1828fef3a512SBarry Smith #undef __FUNCT__
1829baf369e7SPeter Brune #define __FUNCT__ "DMGlobalToLocalHookAdd"
1830bb9467b5SJed Brown /*@C
1831baf369e7SPeter Brune    DMGlobalToLocalHookAdd - adds a callback to be run when global to local is called
1832baf369e7SPeter Brune 
1833baf369e7SPeter Brune    Logically Collective
1834baf369e7SPeter Brune 
1835baf369e7SPeter Brune    Input Arguments:
1836baf369e7SPeter Brune +  dm - the DM
1837baf369e7SPeter Brune .  beginhook - function to run at the beginning of DMGlobalToLocalBegin()
1838baf369e7SPeter Brune .  endhook - function to run after DMGlobalToLocalEnd() has completed
18390298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
1840baf369e7SPeter Brune 
1841baf369e7SPeter Brune    Calling sequence for beginhook:
1842baf369e7SPeter Brune $    beginhook(DM fine,VecScatter out,VecScatter in,DM coarse,void *ctx)
1843baf369e7SPeter Brune 
1844baf369e7SPeter Brune +  dm - global DM
1845baf369e7SPeter Brune .  g - global vector
1846baf369e7SPeter Brune .  mode - mode
1847baf369e7SPeter Brune .  l - local vector
1848baf369e7SPeter Brune -  ctx - optional user-defined function context
1849baf369e7SPeter Brune 
1850baf369e7SPeter Brune 
1851baf369e7SPeter Brune    Calling sequence for endhook:
1852ec4806b8SPeter Brune $    endhook(DM fine,VecScatter out,VecScatter in,DM coarse,void *ctx)
1853baf369e7SPeter Brune 
1854baf369e7SPeter Brune +  global - global DM
1855baf369e7SPeter Brune -  ctx - optional user-defined function context
1856baf369e7SPeter Brune 
1857baf369e7SPeter Brune    Level: advanced
1858baf369e7SPeter Brune 
1859baf369e7SPeter Brune .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
1860baf369e7SPeter Brune @*/
1861baf369e7SPeter Brune PetscErrorCode DMGlobalToLocalHookAdd(DM dm,PetscErrorCode (*beginhook)(DM,Vec,InsertMode,Vec,void*),PetscErrorCode (*endhook)(DM,Vec,InsertMode,Vec,void*),void *ctx)
1862baf369e7SPeter Brune {
1863baf369e7SPeter Brune   PetscErrorCode          ierr;
1864baf369e7SPeter Brune   DMGlobalToLocalHookLink link,*p;
1865baf369e7SPeter Brune 
1866baf369e7SPeter Brune   PetscFunctionBegin;
1867baf369e7SPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1868baf369e7SPeter Brune   for (p=&dm->gtolhook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */
1869baf369e7SPeter Brune   ierr            = PetscMalloc(sizeof(struct _DMGlobalToLocalHookLink),&link);CHKERRQ(ierr);
1870baf369e7SPeter Brune   link->beginhook = beginhook;
1871baf369e7SPeter Brune   link->endhook   = endhook;
1872baf369e7SPeter Brune   link->ctx       = ctx;
18730298fd71SBarry Smith   link->next      = NULL;
1874baf369e7SPeter Brune   *p              = link;
1875baf369e7SPeter Brune   PetscFunctionReturn(0);
1876baf369e7SPeter Brune }
1877baf369e7SPeter Brune 
1878baf369e7SPeter Brune #undef __FUNCT__
18794c274da1SToby Isaac #define __FUNCT__ "DMGlobalToLocalHook_Constraints"
18804c274da1SToby Isaac static PetscErrorCode DMGlobalToLocalHook_Constraints(DM dm, Vec g, InsertMode mode, Vec l, void *ctx)
18814c274da1SToby Isaac {
18824c274da1SToby Isaac   Mat cMat;
18834c274da1SToby Isaac   Vec cVec;
18844c274da1SToby Isaac   PetscSection section, cSec;
18854c274da1SToby Isaac   PetscInt pStart, pEnd, p, dof;
18864c274da1SToby Isaac   PetscErrorCode ierr;
18874c274da1SToby Isaac 
18884c274da1SToby Isaac   PetscFunctionBegin;
18894c274da1SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
18904c274da1SToby Isaac   ierr = DMGetDefaultConstraints(dm,&cSec,&cMat);CHKERRQ(ierr);
18914c274da1SToby Isaac   if (cMat && (mode == INSERT_VALUES || mode == INSERT_ALL_VALUES || mode == INSERT_BC_VALUES)) {
18925db9a05bSToby Isaac     PetscInt nRows;
18935db9a05bSToby Isaac 
18945db9a05bSToby Isaac     ierr = MatGetSize(cMat,&nRows,NULL);CHKERRQ(ierr);
18955db9a05bSToby Isaac     if (nRows <= 0) PetscFunctionReturn(0);
18964c274da1SToby Isaac     ierr = DMGetDefaultSection(dm,&section);CHKERRQ(ierr);
18977711e48fSToby Isaac     ierr = MatCreateVecs(cMat,NULL,&cVec);CHKERRQ(ierr);
18984c274da1SToby Isaac     ierr = MatMult(cMat,l,cVec);CHKERRQ(ierr);
18994c274da1SToby Isaac     ierr = PetscSectionGetChart(cSec,&pStart,&pEnd);CHKERRQ(ierr);
19004c274da1SToby Isaac     for (p = pStart; p < pEnd; p++) {
19014c274da1SToby Isaac       ierr = PetscSectionGetDof(cSec,p,&dof);CHKERRQ(ierr);
19024c274da1SToby Isaac       if (dof) {
19034c274da1SToby Isaac         PetscScalar *vals;
19044c274da1SToby Isaac         ierr = VecGetValuesSection(cVec,cSec,p,&vals);CHKERRQ(ierr);
19054c274da1SToby Isaac         ierr = VecSetValuesSection(l,section,p,vals,INSERT_ALL_VALUES);CHKERRQ(ierr);
19064c274da1SToby Isaac       }
19074c274da1SToby Isaac     }
19084c274da1SToby Isaac     ierr = VecDestroy(&cVec);CHKERRQ(ierr);
19094c274da1SToby Isaac   }
19104c274da1SToby Isaac   PetscFunctionReturn(0);
19114c274da1SToby Isaac }
19124c274da1SToby Isaac 
19134c274da1SToby Isaac #undef __FUNCT__
191447c6ae99SBarry Smith #define __FUNCT__ "DMGlobalToLocalBegin"
191547c6ae99SBarry Smith /*@
191647c6ae99SBarry Smith     DMGlobalToLocalBegin - Begins updating local vectors from global vector
191747c6ae99SBarry Smith 
191847c6ae99SBarry Smith     Neighbor-wise Collective on DM
191947c6ae99SBarry Smith 
192047c6ae99SBarry Smith     Input Parameters:
192147c6ae99SBarry Smith +   dm - the DM object
192247c6ae99SBarry Smith .   g - the global vector
192347c6ae99SBarry Smith .   mode - INSERT_VALUES or ADD_VALUES
192447c6ae99SBarry Smith -   l - the local vector
192547c6ae99SBarry Smith 
192647c6ae99SBarry Smith 
192747c6ae99SBarry Smith     Level: beginner
192847c6ae99SBarry Smith 
1929e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin()
193047c6ae99SBarry Smith 
193147c6ae99SBarry Smith @*/
19327087cfbeSBarry Smith PetscErrorCode  DMGlobalToLocalBegin(DM dm,Vec g,InsertMode mode,Vec l)
193347c6ae99SBarry Smith {
19347128ae9fSMatthew G Knepley   PetscSF                 sf;
193547c6ae99SBarry Smith   PetscErrorCode          ierr;
1936baf369e7SPeter Brune   DMGlobalToLocalHookLink link;
193747c6ae99SBarry Smith 
193847c6ae99SBarry Smith   PetscFunctionBegin;
1939171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1940baf369e7SPeter Brune   for (link=dm->gtolhook; link; link=link->next) {
19418865f1eaSKarl Rupp     if (link->beginhook) {
19428865f1eaSKarl Rupp       ierr = (*link->beginhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);
19438865f1eaSKarl Rupp     }
1944baf369e7SPeter Brune   }
19457128ae9fSMatthew G Knepley   ierr = DMGetDefaultSF(dm, &sf);CHKERRQ(ierr);
19467128ae9fSMatthew G Knepley   if (sf) {
1947ae5cfb4aSMatthew G. Knepley     const PetscScalar *gArray;
1948ae5cfb4aSMatthew G. Knepley     PetscScalar       *lArray;
19497128ae9fSMatthew G Knepley 
195082f516ccSBarry Smith     if (mode == ADD_VALUES) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
19517128ae9fSMatthew G Knepley     ierr = VecGetArray(l, &lArray);CHKERRQ(ierr);
1952ae5cfb4aSMatthew G. Knepley     ierr = VecGetArrayRead(g, &gArray);CHKERRQ(ierr);
19537128ae9fSMatthew G Knepley     ierr = PetscSFBcastBegin(sf, MPIU_SCALAR, gArray, lArray);CHKERRQ(ierr);
19547128ae9fSMatthew G Knepley     ierr = VecRestoreArray(l, &lArray);CHKERRQ(ierr);
1955ae5cfb4aSMatthew G. Knepley     ierr = VecRestoreArrayRead(g, &gArray);CHKERRQ(ierr);
19567128ae9fSMatthew G Knepley   } else {
1957843c4018SMatthew G Knepley     ierr = (*dm->ops->globaltolocalbegin)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
19587128ae9fSMatthew G Knepley   }
195947c6ae99SBarry Smith   PetscFunctionReturn(0);
196047c6ae99SBarry Smith }
196147c6ae99SBarry Smith 
196247c6ae99SBarry Smith #undef __FUNCT__
196347c6ae99SBarry Smith #define __FUNCT__ "DMGlobalToLocalEnd"
196447c6ae99SBarry Smith /*@
196547c6ae99SBarry Smith     DMGlobalToLocalEnd - Ends updating local vectors from global vector
196647c6ae99SBarry Smith 
196747c6ae99SBarry Smith     Neighbor-wise Collective on DM
196847c6ae99SBarry Smith 
196947c6ae99SBarry Smith     Input Parameters:
197047c6ae99SBarry Smith +   dm - the DM object
197147c6ae99SBarry Smith .   g - the global vector
197247c6ae99SBarry Smith .   mode - INSERT_VALUES or ADD_VALUES
197347c6ae99SBarry Smith -   l - the local vector
197447c6ae99SBarry Smith 
197547c6ae99SBarry Smith 
197647c6ae99SBarry Smith     Level: beginner
197747c6ae99SBarry Smith 
1978e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin()
197947c6ae99SBarry Smith 
198047c6ae99SBarry Smith @*/
19817087cfbeSBarry Smith PetscErrorCode  DMGlobalToLocalEnd(DM dm,Vec g,InsertMode mode,Vec l)
198247c6ae99SBarry Smith {
19837128ae9fSMatthew G Knepley   PetscSF                 sf;
198447c6ae99SBarry Smith   PetscErrorCode          ierr;
1985ae5cfb4aSMatthew G. Knepley   const PetscScalar      *gArray;
1986ae5cfb4aSMatthew G. Knepley   PetscScalar            *lArray;
1987baf369e7SPeter Brune   DMGlobalToLocalHookLink link;
198847c6ae99SBarry Smith 
198947c6ae99SBarry Smith   PetscFunctionBegin;
1990171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
19917128ae9fSMatthew G Knepley   ierr = DMGetDefaultSF(dm, &sf);CHKERRQ(ierr);
19927128ae9fSMatthew G Knepley   if (sf) {
199382f516ccSBarry Smith     if (mode == ADD_VALUES) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
19947128ae9fSMatthew G Knepley 
19957128ae9fSMatthew G Knepley     ierr = VecGetArray(l, &lArray);CHKERRQ(ierr);
1996ae5cfb4aSMatthew G. Knepley     ierr = VecGetArrayRead(g, &gArray);CHKERRQ(ierr);
19977128ae9fSMatthew G Knepley     ierr = PetscSFBcastEnd(sf, MPIU_SCALAR, gArray, lArray);CHKERRQ(ierr);
19987128ae9fSMatthew G Knepley     ierr = VecRestoreArray(l, &lArray);CHKERRQ(ierr);
1999ae5cfb4aSMatthew G. Knepley     ierr = VecRestoreArrayRead(g, &gArray);CHKERRQ(ierr);
20007128ae9fSMatthew G Knepley   } else {
2001843c4018SMatthew G Knepley     ierr = (*dm->ops->globaltolocalend)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
20027128ae9fSMatthew G Knepley   }
20034c274da1SToby Isaac   ierr = DMGlobalToLocalHook_Constraints(dm,g,mode,l,NULL);CHKERRQ(ierr);
2004baf369e7SPeter Brune   for (link=dm->gtolhook; link; link=link->next) {
2005baf369e7SPeter Brune     if (link->endhook) {ierr = (*link->endhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);}
2006baf369e7SPeter Brune   }
200747c6ae99SBarry Smith   PetscFunctionReturn(0);
200847c6ae99SBarry Smith }
200947c6ae99SBarry Smith 
201047c6ae99SBarry Smith #undef __FUNCT__
2011d4d07f1eSToby Isaac #define __FUNCT__ "DMLocalToGlobalHookAdd"
2012d4d07f1eSToby Isaac /*@C
2013d4d07f1eSToby Isaac    DMLocalToGlobalHookAdd - adds a callback to be run when a local to global is called
2014d4d07f1eSToby Isaac 
2015d4d07f1eSToby Isaac    Logically Collective
2016d4d07f1eSToby Isaac 
2017d4d07f1eSToby Isaac    Input Arguments:
2018d4d07f1eSToby Isaac +  dm - the DM
2019d4d07f1eSToby Isaac .  beginhook - function to run at the beginning of DMLocalToGlobalBegin()
2020d4d07f1eSToby Isaac .  endhook - function to run after DMLocalToGlobalEnd() has completed
2021d4d07f1eSToby Isaac -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
2022d4d07f1eSToby Isaac 
2023d4d07f1eSToby Isaac    Calling sequence for beginhook:
2024d4d07f1eSToby Isaac $    beginhook(DM fine,Vec l,InsertMode mode,Vec g,void *ctx)
2025d4d07f1eSToby Isaac 
2026d4d07f1eSToby Isaac +  dm - global DM
2027d4d07f1eSToby Isaac .  l - local vector
2028d4d07f1eSToby Isaac .  mode - mode
2029d4d07f1eSToby Isaac .  g - global vector
2030d4d07f1eSToby Isaac -  ctx - optional user-defined function context
2031d4d07f1eSToby Isaac 
2032d4d07f1eSToby Isaac 
2033d4d07f1eSToby Isaac    Calling sequence for endhook:
2034d4d07f1eSToby Isaac $    endhook(DM fine,Vec l,InsertMode mode,Vec g,void *ctx)
2035d4d07f1eSToby Isaac 
2036d4d07f1eSToby Isaac +  global - global DM
2037d4d07f1eSToby Isaac .  l - local vector
2038d4d07f1eSToby Isaac .  mode - mode
2039d4d07f1eSToby Isaac .  g - global vector
2040d4d07f1eSToby Isaac -  ctx - optional user-defined function context
2041d4d07f1eSToby Isaac 
2042d4d07f1eSToby Isaac    Level: advanced
2043d4d07f1eSToby Isaac 
2044d4d07f1eSToby Isaac .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
2045d4d07f1eSToby Isaac @*/
2046d4d07f1eSToby Isaac PetscErrorCode DMLocalToGlobalHookAdd(DM dm,PetscErrorCode (*beginhook)(DM,Vec,InsertMode,Vec,void*),PetscErrorCode (*endhook)(DM,Vec,InsertMode,Vec,void*),void *ctx)
2047d4d07f1eSToby Isaac {
2048d4d07f1eSToby Isaac   PetscErrorCode          ierr;
2049d4d07f1eSToby Isaac   DMLocalToGlobalHookLink link,*p;
2050d4d07f1eSToby Isaac 
2051d4d07f1eSToby Isaac   PetscFunctionBegin;
2052d4d07f1eSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2053d4d07f1eSToby Isaac   for (p=&dm->ltoghook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */
2054d4d07f1eSToby Isaac   ierr            = PetscMalloc(sizeof(struct _DMLocalToGlobalHookLink),&link);CHKERRQ(ierr);
2055d4d07f1eSToby Isaac   link->beginhook = beginhook;
2056d4d07f1eSToby Isaac   link->endhook   = endhook;
2057d4d07f1eSToby Isaac   link->ctx       = ctx;
2058d4d07f1eSToby Isaac   link->next      = NULL;
2059d4d07f1eSToby Isaac   *p              = link;
2060d4d07f1eSToby Isaac   PetscFunctionReturn(0);
2061d4d07f1eSToby Isaac }
2062d4d07f1eSToby Isaac 
2063d4d07f1eSToby Isaac #undef __FUNCT__
20644c274da1SToby Isaac #define __FUNCT__ "DMLocalToGlobalHook_Constraints"
20654c274da1SToby Isaac static PetscErrorCode DMLocalToGlobalHook_Constraints(DM dm, Vec l, InsertMode mode, Vec g, void *ctx)
20664c274da1SToby Isaac {
20674c274da1SToby Isaac   Mat cMat;
20684c274da1SToby Isaac   Vec cVec;
20694c274da1SToby Isaac   PetscSection section, cSec;
20704c274da1SToby Isaac   PetscInt pStart, pEnd, p, dof;
20714c274da1SToby Isaac   PetscErrorCode ierr;
20724c274da1SToby Isaac 
20734c274da1SToby Isaac   PetscFunctionBegin;
20744c274da1SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
20754c274da1SToby Isaac   ierr = DMGetDefaultConstraints(dm,&cSec,&cMat);CHKERRQ(ierr);
20764c274da1SToby Isaac   if (cMat && (mode == ADD_VALUES || mode == ADD_ALL_VALUES || mode == ADD_BC_VALUES)) {
20775db9a05bSToby Isaac     PetscInt nRows;
20785db9a05bSToby Isaac 
20795db9a05bSToby Isaac     ierr = MatGetSize(cMat,&nRows,NULL);CHKERRQ(ierr);
20805db9a05bSToby Isaac     if (nRows <= 0) PetscFunctionReturn(0);
20814c274da1SToby Isaac     ierr = DMGetDefaultSection(dm,&section);CHKERRQ(ierr);
20827711e48fSToby Isaac     ierr = MatCreateVecs(cMat,NULL,&cVec);CHKERRQ(ierr);
20834c274da1SToby Isaac     ierr = PetscSectionGetChart(cSec,&pStart,&pEnd);CHKERRQ(ierr);
20844c274da1SToby Isaac     for (p = pStart; p < pEnd; p++) {
20854c274da1SToby Isaac       ierr = PetscSectionGetDof(cSec,p,&dof);CHKERRQ(ierr);
20864c274da1SToby Isaac       if (dof) {
20874c274da1SToby Isaac         PetscInt d;
20884c274da1SToby Isaac         PetscScalar *vals;
20894c274da1SToby Isaac         ierr = VecGetValuesSection(l,section,p,&vals);CHKERRQ(ierr);
20904c274da1SToby Isaac         ierr = VecSetValuesSection(cVec,cSec,p,vals,mode);CHKERRQ(ierr);
20914c274da1SToby Isaac         /* for this to be the true transpose, we have to zero the values that
20924c274da1SToby Isaac          * we just extracted */
20934c274da1SToby Isaac         for (d = 0; d < dof; d++) {
20944c274da1SToby Isaac           vals[d] = 0.;
20954c274da1SToby Isaac         }
20964c274da1SToby Isaac       }
20974c274da1SToby Isaac     }
20984c274da1SToby Isaac     ierr = MatMultTransposeAdd(cMat,cVec,l,l);CHKERRQ(ierr);
20994c274da1SToby Isaac     ierr = VecDestroy(&cVec);CHKERRQ(ierr);
21004c274da1SToby Isaac   }
21014c274da1SToby Isaac   PetscFunctionReturn(0);
21024c274da1SToby Isaac }
21034c274da1SToby Isaac 
21044c274da1SToby Isaac #undef __FUNCT__
21059a42bb27SBarry Smith #define __FUNCT__ "DMLocalToGlobalBegin"
210647c6ae99SBarry Smith /*@
21079a42bb27SBarry Smith     DMLocalToGlobalBegin - updates global vectors from local vectors
21089a42bb27SBarry Smith 
21099a42bb27SBarry Smith     Neighbor-wise Collective on DM
21109a42bb27SBarry Smith 
21119a42bb27SBarry Smith     Input Parameters:
21129a42bb27SBarry Smith +   dm - the DM object
2113f6813fd5SJed Brown .   l - the local vector
21141eb28f2eSBarry Smith .   mode - if INSERT_VALUES then no parallel communication is used, if ADD_VALUES then all ghost points from the same base point accumulate into that base point.
21151eb28f2eSBarry Smith -   g - the global vector
21169a42bb27SBarry Smith 
2117d96308ebSBarry Smith     Notes: In the ADD_VALUES case you normally would zero the receiving vector before beginning this operation.
211884330215SMatthew G. Knepley            INSERT_VALUES is not supported for DMDA, in that case simply compute the values directly into a global vector instead of a local one.
21199a42bb27SBarry Smith 
21209a42bb27SBarry Smith     Level: beginner
21219a42bb27SBarry Smith 
2122e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMGlobalToLocalBegin()
21239a42bb27SBarry Smith 
21249a42bb27SBarry Smith @*/
21257087cfbeSBarry Smith PetscErrorCode  DMLocalToGlobalBegin(DM dm,Vec l,InsertMode mode,Vec g)
21269a42bb27SBarry Smith {
21277128ae9fSMatthew G Knepley   PetscSF                 sf;
212884330215SMatthew G. Knepley   PetscSection            s, gs;
2129d4d07f1eSToby Isaac   DMLocalToGlobalHookLink link;
2130ae5cfb4aSMatthew G. Knepley   const PetscScalar      *lArray;
2131ae5cfb4aSMatthew G. Knepley   PetscScalar            *gArray;
213284330215SMatthew G. Knepley   PetscBool               isInsert;
213384330215SMatthew G. Knepley   PetscErrorCode          ierr;
21349a42bb27SBarry Smith 
21359a42bb27SBarry Smith   PetscFunctionBegin;
2136171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2137d4d07f1eSToby Isaac   for (link=dm->ltoghook; link; link=link->next) {
2138d4d07f1eSToby Isaac     if (link->beginhook) {
2139d4d07f1eSToby Isaac       ierr = (*link->beginhook)(dm,l,mode,g,link->ctx);CHKERRQ(ierr);
2140d4d07f1eSToby Isaac     }
2141d4d07f1eSToby Isaac   }
21424c274da1SToby Isaac   ierr = DMLocalToGlobalHook_Constraints(dm,l,mode,g,NULL);CHKERRQ(ierr);
21437128ae9fSMatthew G Knepley   ierr = DMGetDefaultSF(dm, &sf);CHKERRQ(ierr);
214484330215SMatthew G. Knepley   ierr = DMGetDefaultSection(dm, &s);CHKERRQ(ierr);
21457128ae9fSMatthew G Knepley   switch (mode) {
21467128ae9fSMatthew G Knepley   case INSERT_VALUES:
21477128ae9fSMatthew G Knepley   case INSERT_ALL_VALUES:
214884330215SMatthew G. Knepley     isInsert = PETSC_TRUE; break;
21497128ae9fSMatthew G Knepley   case ADD_VALUES:
21507128ae9fSMatthew G Knepley   case ADD_ALL_VALUES:
215184330215SMatthew G. Knepley     isInsert = PETSC_FALSE; break;
21527128ae9fSMatthew G Knepley   default:
215382f516ccSBarry Smith     SETERRQ1(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
21547128ae9fSMatthew G Knepley   }
215584330215SMatthew G. Knepley   if (sf && !isInsert) {
2156ae5cfb4aSMatthew G. Knepley     ierr = VecGetArrayRead(l, &lArray);CHKERRQ(ierr);
21577128ae9fSMatthew G Knepley     ierr = VecGetArray(g, &gArray);CHKERRQ(ierr);
2158a9b180a6SBarry Smith     ierr = PetscSFReduceBegin(sf, MPIU_SCALAR, lArray, gArray, MPIU_SUM);CHKERRQ(ierr);
2159ae5cfb4aSMatthew G. Knepley     ierr = VecRestoreArrayRead(l, &lArray);CHKERRQ(ierr);
216084330215SMatthew G. Knepley     ierr = VecRestoreArray(g, &gArray);CHKERRQ(ierr);
216184330215SMatthew G. Knepley   } else if (s && isInsert) {
216284330215SMatthew G. Knepley     PetscInt gStart, pStart, pEnd, p;
216384330215SMatthew G. Knepley 
216484330215SMatthew G. Knepley     ierr = DMGetDefaultGlobalSection(dm, &gs);CHKERRQ(ierr);
216584330215SMatthew G. Knepley     ierr = PetscSectionGetChart(s, &pStart, &pEnd);CHKERRQ(ierr);
216684330215SMatthew G. Knepley     ierr = VecGetOwnershipRange(g, &gStart, NULL);CHKERRQ(ierr);
2167ae5cfb4aSMatthew G. Knepley     ierr = VecGetArrayRead(l, &lArray);CHKERRQ(ierr);
216884330215SMatthew G. Knepley     ierr = VecGetArray(g, &gArray);CHKERRQ(ierr);
216984330215SMatthew G. Knepley     for (p = pStart; p < pEnd; ++p) {
2170b3b16f48SMatthew G. Knepley       PetscInt dof, gdof, cdof, gcdof, off, goff, d, e;
217184330215SMatthew G. Knepley 
217284330215SMatthew G. Knepley       ierr = PetscSectionGetDof(s, p, &dof);CHKERRQ(ierr);
217303442857SMatthew G. Knepley       ierr = PetscSectionGetDof(gs, p, &gdof);CHKERRQ(ierr);
217484330215SMatthew G. Knepley       ierr = PetscSectionGetConstraintDof(s, p, &cdof);CHKERRQ(ierr);
2175b3b16f48SMatthew G. Knepley       ierr = PetscSectionGetConstraintDof(gs, p, &gcdof);CHKERRQ(ierr);
217684330215SMatthew G. Knepley       ierr = PetscSectionGetOffset(s, p, &off);CHKERRQ(ierr);
217784330215SMatthew G. Knepley       ierr = PetscSectionGetOffset(gs, p, &goff);CHKERRQ(ierr);
2178b3b16f48SMatthew G. Knepley       /* Ignore off-process data and points with no global data */
217903442857SMatthew G. Knepley       if (!gdof || goff < 0) continue;
2180b3b16f48SMatthew G. Knepley       if (dof != gdof) SETERRQ5(PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "Inconsistent sizes, p: %d dof: %d gdof: %d cdof: %d gcdof: %d", p, dof, gdof, cdof, gcdof);
2181b3b16f48SMatthew G. Knepley       /* If no constraints are enforced in the global vector */
2182b3b16f48SMatthew G. Knepley       if (!gcdof) {
218384330215SMatthew G. Knepley         for (d = 0; d < dof; ++d) gArray[goff-gStart+d] = lArray[off+d];
2184b3b16f48SMatthew G. Knepley       /* If constraints are enforced in the global vector */
2185b3b16f48SMatthew G. Knepley       } else if (cdof == gcdof) {
218684330215SMatthew G. Knepley         const PetscInt *cdofs;
218784330215SMatthew G. Knepley         PetscInt        cind = 0;
218884330215SMatthew G. Knepley 
218984330215SMatthew G. Knepley         ierr = PetscSectionGetConstraintIndices(s, p, &cdofs);CHKERRQ(ierr);
2190b3b16f48SMatthew G. Knepley         for (d = 0, e = 0; d < dof; ++d) {
219184330215SMatthew G. Knepley           if ((cind < cdof) && (d == cdofs[cind])) {++cind; continue;}
2192b3b16f48SMatthew G. Knepley           gArray[goff-gStart+e++] = lArray[off+d];
219384330215SMatthew G. Knepley         }
2194b3b16f48SMatthew G. Knepley       } else SETERRQ5(PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "Inconsistent sizes, p: %d dof: %d gdof: %d cdof: %d gcdof: %d", p, dof, gdof, cdof, gcdof);
219584330215SMatthew G. Knepley     }
2196ae5cfb4aSMatthew G. Knepley     ierr = VecRestoreArrayRead(l, &lArray);CHKERRQ(ierr);
21977128ae9fSMatthew G Knepley     ierr = VecRestoreArray(g, &gArray);CHKERRQ(ierr);
21987128ae9fSMatthew G Knepley   } else {
2199843c4018SMatthew G Knepley     ierr = (*dm->ops->localtoglobalbegin)(dm,l,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),g);CHKERRQ(ierr);
22007128ae9fSMatthew G Knepley   }
22019a42bb27SBarry Smith   PetscFunctionReturn(0);
22029a42bb27SBarry Smith }
22039a42bb27SBarry Smith 
22049a42bb27SBarry Smith #undef __FUNCT__
22059a42bb27SBarry Smith #define __FUNCT__ "DMLocalToGlobalEnd"
22069a42bb27SBarry Smith /*@
22079a42bb27SBarry Smith     DMLocalToGlobalEnd - updates global vectors from local vectors
220847c6ae99SBarry Smith 
220947c6ae99SBarry Smith     Neighbor-wise Collective on DM
221047c6ae99SBarry Smith 
221147c6ae99SBarry Smith     Input Parameters:
221247c6ae99SBarry Smith +   dm - the DM object
2213f6813fd5SJed Brown .   l - the local vector
221447c6ae99SBarry Smith .   mode - INSERT_VALUES or ADD_VALUES
2215f6813fd5SJed Brown -   g - the global vector
221647c6ae99SBarry Smith 
221747c6ae99SBarry Smith 
221847c6ae99SBarry Smith     Level: beginner
221947c6ae99SBarry Smith 
2220e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMGlobalToLocalEnd()
222147c6ae99SBarry Smith 
222247c6ae99SBarry Smith @*/
22237087cfbeSBarry Smith PetscErrorCode  DMLocalToGlobalEnd(DM dm,Vec l,InsertMode mode,Vec g)
222447c6ae99SBarry Smith {
22257128ae9fSMatthew G Knepley   PetscSF                 sf;
222684330215SMatthew G. Knepley   PetscSection            s;
2227d4d07f1eSToby Isaac   DMLocalToGlobalHookLink link;
222884330215SMatthew G. Knepley   PetscBool               isInsert;
222984330215SMatthew G. Knepley   PetscErrorCode          ierr;
223047c6ae99SBarry Smith 
223147c6ae99SBarry Smith   PetscFunctionBegin;
2232171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
22337128ae9fSMatthew G Knepley   ierr = DMGetDefaultSF(dm, &sf);CHKERRQ(ierr);
223484330215SMatthew G. Knepley   ierr = DMGetDefaultSection(dm, &s);CHKERRQ(ierr);
22357128ae9fSMatthew G Knepley   switch (mode) {
22367128ae9fSMatthew G Knepley   case INSERT_VALUES:
22377128ae9fSMatthew G Knepley   case INSERT_ALL_VALUES:
223884330215SMatthew G. Knepley     isInsert = PETSC_TRUE; break;
22397128ae9fSMatthew G Knepley   case ADD_VALUES:
22407128ae9fSMatthew G Knepley   case ADD_ALL_VALUES:
224184330215SMatthew G. Knepley     isInsert = PETSC_FALSE; break;
22427128ae9fSMatthew G Knepley   default:
224382f516ccSBarry Smith     SETERRQ1(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
22447128ae9fSMatthew G Knepley   }
224584330215SMatthew G. Knepley   if (sf && !isInsert) {
2246ae5cfb4aSMatthew G. Knepley     const PetscScalar *lArray;
2247ae5cfb4aSMatthew G. Knepley     PetscScalar       *gArray;
224884330215SMatthew G. Knepley 
2249ae5cfb4aSMatthew G. Knepley     ierr = VecGetArrayRead(l, &lArray);CHKERRQ(ierr);
22507128ae9fSMatthew G Knepley     ierr = VecGetArray(g, &gArray);CHKERRQ(ierr);
2251a9b180a6SBarry Smith     ierr = PetscSFReduceEnd(sf, MPIU_SCALAR, lArray, gArray, MPIU_SUM);CHKERRQ(ierr);
2252ae5cfb4aSMatthew G. Knepley     ierr = VecRestoreArrayRead(l, &lArray);CHKERRQ(ierr);
22537128ae9fSMatthew G Knepley     ierr = VecRestoreArray(g, &gArray);CHKERRQ(ierr);
225484330215SMatthew G. Knepley   } else if (s && isInsert) {
22557128ae9fSMatthew G Knepley   } else {
2256843c4018SMatthew G Knepley     ierr = (*dm->ops->localtoglobalend)(dm,l,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),g);CHKERRQ(ierr);
22577128ae9fSMatthew G Knepley   }
2258d4d07f1eSToby Isaac   for (link=dm->ltoghook; link; link=link->next) {
2259d4d07f1eSToby Isaac     if (link->endhook) {ierr = (*link->endhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);}
2260d4d07f1eSToby Isaac   }
226147c6ae99SBarry Smith   PetscFunctionReturn(0);
226247c6ae99SBarry Smith }
226347c6ae99SBarry Smith 
226447c6ae99SBarry Smith #undef __FUNCT__
2265f089877aSRichard Tran Mills #define __FUNCT__ "DMLocalToLocalBegin"
2266f089877aSRichard Tran Mills /*@
2267bc0a1609SRichard Tran Mills    DMLocalToLocalBegin - Maps from a local vector (including ghost points
2268bc0a1609SRichard Tran Mills    that contain irrelevant values) to another local vector where the ghost
2269d78e899eSRichard Tran Mills    points in the second are set correctly. Must be followed by DMLocalToLocalEnd().
2270f089877aSRichard Tran Mills 
2271bc0a1609SRichard Tran Mills    Neighbor-wise Collective on DM and Vec
2272f089877aSRichard Tran Mills 
2273f089877aSRichard Tran Mills    Input Parameters:
2274f089877aSRichard Tran Mills +  dm - the DM object
2275bc0a1609SRichard Tran Mills .  g - the original local vector
2276bc0a1609SRichard Tran Mills -  mode - one of INSERT_VALUES or ADD_VALUES
2277f089877aSRichard Tran Mills 
2278bc0a1609SRichard Tran Mills    Output Parameter:
2279bc0a1609SRichard Tran Mills .  l  - the local vector with correct ghost values
2280f089877aSRichard Tran Mills 
2281f089877aSRichard Tran Mills    Level: intermediate
2282f089877aSRichard Tran Mills 
2283bc0a1609SRichard Tran Mills    Notes:
2284bc0a1609SRichard Tran Mills    The local vectors used here need not be the same as those
2285bc0a1609SRichard Tran Mills    obtained from DMCreateLocalVector(), BUT they
2286bc0a1609SRichard Tran Mills    must have the same parallel data layout; they could, for example, be
2287bc0a1609SRichard Tran Mills    obtained with VecDuplicate() from the DM originating vectors.
2288bc0a1609SRichard Tran Mills 
2289bc0a1609SRichard Tran Mills .keywords: DM, local-to-local, begin
2290bc0a1609SRichard Tran Mills .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateLocalVector(), DMCreateGlobalVector(), DMCreateInterpolation(), DMLocalToLocalEnd(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin()
2291f089877aSRichard Tran Mills 
2292f089877aSRichard Tran Mills @*/
2293f089877aSRichard Tran Mills PetscErrorCode  DMLocalToLocalBegin(DM dm,Vec g,InsertMode mode,Vec l)
2294f089877aSRichard Tran Mills {
2295f089877aSRichard Tran Mills   PetscErrorCode          ierr;
2296f089877aSRichard Tran Mills 
2297f089877aSRichard Tran Mills   PetscFunctionBegin;
2298f089877aSRichard Tran Mills   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2299f089877aSRichard Tran Mills   ierr = (*dm->ops->localtolocalbegin)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
2300f089877aSRichard Tran Mills   PetscFunctionReturn(0);
2301f089877aSRichard Tran Mills }
2302f089877aSRichard Tran Mills 
2303f089877aSRichard Tran Mills #undef __FUNCT__
2304f089877aSRichard Tran Mills #define __FUNCT__ "DMLocalToLocalEnd"
2305f089877aSRichard Tran Mills /*@
2306bc0a1609SRichard Tran Mills    DMLocalToLocalEnd - Maps from a local vector (including ghost points
2307bc0a1609SRichard Tran Mills    that contain irrelevant values) to another local vector where the ghost
2308d78e899eSRichard Tran Mills    points in the second are set correctly. Must be preceded by DMLocalToLocalBegin().
2309f089877aSRichard Tran Mills 
2310bc0a1609SRichard Tran Mills    Neighbor-wise Collective on DM and Vec
2311f089877aSRichard Tran Mills 
2312f089877aSRichard Tran Mills    Input Parameters:
2313bc0a1609SRichard Tran Mills +  da - the DM object
2314bc0a1609SRichard Tran Mills .  g - the original local vector
2315bc0a1609SRichard Tran Mills -  mode - one of INSERT_VALUES or ADD_VALUES
2316f089877aSRichard Tran Mills 
2317bc0a1609SRichard Tran Mills    Output Parameter:
2318bc0a1609SRichard Tran Mills .  l  - the local vector with correct ghost values
2319f089877aSRichard Tran Mills 
2320f089877aSRichard Tran Mills    Level: intermediate
2321f089877aSRichard Tran Mills 
2322bc0a1609SRichard Tran Mills    Notes:
2323bc0a1609SRichard Tran Mills    The local vectors used here need not be the same as those
2324bc0a1609SRichard Tran Mills    obtained from DMCreateLocalVector(), BUT they
2325bc0a1609SRichard Tran Mills    must have the same parallel data layout; they could, for example, be
2326bc0a1609SRichard Tran Mills    obtained with VecDuplicate() from the DM originating vectors.
2327bc0a1609SRichard Tran Mills 
2328bc0a1609SRichard Tran Mills .keywords: DM, local-to-local, end
2329bc0a1609SRichard Tran Mills .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateLocalVector(), DMCreateGlobalVector(), DMCreateInterpolation(), DMLocalToLocalBegin(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin()
2330f089877aSRichard Tran Mills 
2331f089877aSRichard Tran Mills @*/
2332f089877aSRichard Tran Mills PetscErrorCode  DMLocalToLocalEnd(DM dm,Vec g,InsertMode mode,Vec l)
2333f089877aSRichard Tran Mills {
2334f089877aSRichard Tran Mills   PetscErrorCode          ierr;
2335f089877aSRichard Tran Mills 
2336f089877aSRichard Tran Mills   PetscFunctionBegin;
2337f089877aSRichard Tran Mills   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2338f089877aSRichard Tran Mills   ierr = (*dm->ops->localtolocalend)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
2339f089877aSRichard Tran Mills   PetscFunctionReturn(0);
2340f089877aSRichard Tran Mills }
2341f089877aSRichard Tran Mills 
2342f089877aSRichard Tran Mills 
2343f089877aSRichard Tran Mills #undef __FUNCT__
234447c6ae99SBarry Smith #define __FUNCT__ "DMCoarsen"
234547c6ae99SBarry Smith /*@
234647c6ae99SBarry Smith     DMCoarsen - Coarsens a DM object
234747c6ae99SBarry Smith 
234847c6ae99SBarry Smith     Collective on DM
234947c6ae99SBarry Smith 
235047c6ae99SBarry Smith     Input Parameter:
235147c6ae99SBarry Smith +   dm - the DM object
235291d95f02SJed Brown -   comm - the communicator to contain the new DM object (or MPI_COMM_NULL)
235347c6ae99SBarry Smith 
235447c6ae99SBarry Smith     Output Parameter:
235547c6ae99SBarry Smith .   dmc - the coarsened DM
235647c6ae99SBarry Smith 
235747c6ae99SBarry Smith     Level: developer
235847c6ae99SBarry Smith 
2359e727c939SJed Brown .seealso DMRefine(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
236047c6ae99SBarry Smith 
236147c6ae99SBarry Smith @*/
23627087cfbeSBarry Smith PetscErrorCode DMCoarsen(DM dm, MPI_Comm comm, DM *dmc)
236347c6ae99SBarry Smith {
236447c6ae99SBarry Smith   PetscErrorCode    ierr;
2365b17ce1afSJed Brown   DMCoarsenHookLink link;
236647c6ae99SBarry Smith 
236747c6ae99SBarry Smith   PetscFunctionBegin;
2368171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2369fef3a512SBarry Smith   if (!dm->ops->coarsen) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"This DM cannot coarsen");
237047a35634SPatrick Farrell   ierr = PetscLogEventBegin(DM_Coarsen,dm,0,0,0);CHKERRQ(ierr);
237147c6ae99SBarry Smith   ierr                      = (*dm->ops->coarsen)(dm, comm, dmc);CHKERRQ(ierr);
23728892b4c3SMatthew G. Knepley   if (!(*dmc)) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "NULL coarse mesh produced");
2373a8fb8f29SToby Isaac   ierr = DMSetCoarseDM(dm,*dmc);CHKERRQ(ierr);
237443842a1eSJed Brown   (*dmc)->ops->creatematrix = dm->ops->creatematrix;
23758cd211a4SJed Brown   ierr                      = PetscObjectCopyFortranFunctionPointers((PetscObject)dm,(PetscObject)*dmc);CHKERRQ(ierr);
2376644e2e5bSBarry Smith   (*dmc)->ctx               = dm->ctx;
23770598a293SJed Brown   (*dmc)->levelup           = dm->levelup;
2378656b349aSBarry Smith   (*dmc)->leveldown         = dm->leveldown + 1;
2379e4b4b23bSJed Brown   ierr                      = DMSetMatType(*dmc,dm->mattype);CHKERRQ(ierr);
2380b17ce1afSJed Brown   for (link=dm->coarsenhook; link; link=link->next) {
2381b17ce1afSJed Brown     if (link->coarsenhook) {ierr = (*link->coarsenhook)(dm,*dmc,link->ctx);CHKERRQ(ierr);}
2382b17ce1afSJed Brown   }
238347a35634SPatrick Farrell   ierr = PetscLogEventEnd(DM_Coarsen,dm,0,0,0);CHKERRQ(ierr);
2384b17ce1afSJed Brown   PetscFunctionReturn(0);
2385b17ce1afSJed Brown }
2386b17ce1afSJed Brown 
2387b17ce1afSJed Brown #undef __FUNCT__
2388b17ce1afSJed Brown #define __FUNCT__ "DMCoarsenHookAdd"
2389bb9467b5SJed Brown /*@C
2390b17ce1afSJed Brown    DMCoarsenHookAdd - adds a callback to be run when restricting a nonlinear problem to the coarse grid
2391b17ce1afSJed Brown 
2392b17ce1afSJed Brown    Logically Collective
2393b17ce1afSJed Brown 
2394b17ce1afSJed Brown    Input Arguments:
2395b17ce1afSJed Brown +  fine - nonlinear solver context on which to run a hook when restricting to a coarser level
2396b17ce1afSJed Brown .  coarsenhook - function to run when setting up a coarser level
2397b17ce1afSJed Brown .  restricthook - function to run to update data on coarser levels (once per SNESSolve())
23980298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
2399b17ce1afSJed Brown 
2400b17ce1afSJed Brown    Calling sequence of coarsenhook:
2401b17ce1afSJed Brown $    coarsenhook(DM fine,DM coarse,void *ctx);
2402b17ce1afSJed Brown 
2403b17ce1afSJed Brown +  fine - fine level DM
2404b17ce1afSJed Brown .  coarse - coarse level DM to restrict problem to
2405b17ce1afSJed Brown -  ctx - optional user-defined function context
2406b17ce1afSJed Brown 
2407b17ce1afSJed Brown    Calling sequence for restricthook:
2408c833c3b5SJed Brown $    restricthook(DM fine,Mat mrestrict,Vec rscale,Mat inject,DM coarse,void *ctx)
2409b17ce1afSJed Brown 
2410b17ce1afSJed Brown +  fine - fine level DM
2411b17ce1afSJed Brown .  mrestrict - matrix restricting a fine-level solution to the coarse grid
2412c833c3b5SJed Brown .  rscale - scaling vector for restriction
2413c833c3b5SJed Brown .  inject - matrix restricting by injection
2414b17ce1afSJed Brown .  coarse - coarse level DM to update
2415b17ce1afSJed Brown -  ctx - optional user-defined function context
2416b17ce1afSJed Brown 
2417b17ce1afSJed Brown    Level: advanced
2418b17ce1afSJed Brown 
2419b17ce1afSJed Brown    Notes:
2420b17ce1afSJed Brown    This function is only needed if auxiliary data needs to be set up on coarse grids.
2421b17ce1afSJed Brown 
2422b17ce1afSJed Brown    If this function is called multiple times, the hooks will be run in the order they are added.
2423b17ce1afSJed Brown 
2424b17ce1afSJed Brown    In order to compose with nonlinear preconditioning without duplicating storage, the hook should be implemented to
2425b17ce1afSJed Brown    extract the finest level information from its context (instead of from the SNES).
2426b17ce1afSJed Brown 
2427bb9467b5SJed Brown    This function is currently not available from Fortran.
2428bb9467b5SJed Brown 
2429c833c3b5SJed Brown .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
2430b17ce1afSJed Brown @*/
2431b17ce1afSJed Brown PetscErrorCode DMCoarsenHookAdd(DM fine,PetscErrorCode (*coarsenhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,Mat,Vec,Mat,DM,void*),void *ctx)
2432b17ce1afSJed Brown {
2433b17ce1afSJed Brown   PetscErrorCode    ierr;
2434b17ce1afSJed Brown   DMCoarsenHookLink link,*p;
2435b17ce1afSJed Brown 
2436b17ce1afSJed Brown   PetscFunctionBegin;
2437b17ce1afSJed Brown   PetscValidHeaderSpecific(fine,DM_CLASSID,1);
24386bfea28cSJed Brown   for (p=&fine->coarsenhook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */
2439b17ce1afSJed Brown   ierr               = PetscMalloc(sizeof(struct _DMCoarsenHookLink),&link);CHKERRQ(ierr);
2440b17ce1afSJed Brown   link->coarsenhook  = coarsenhook;
2441b17ce1afSJed Brown   link->restricthook = restricthook;
2442b17ce1afSJed Brown   link->ctx          = ctx;
24430298fd71SBarry Smith   link->next         = NULL;
2444b17ce1afSJed Brown   *p                 = link;
2445b17ce1afSJed Brown   PetscFunctionReturn(0);
2446b17ce1afSJed Brown }
2447b17ce1afSJed Brown 
2448b17ce1afSJed Brown #undef __FUNCT__
2449b17ce1afSJed Brown #define __FUNCT__ "DMRestrict"
2450b17ce1afSJed Brown /*@
2451b17ce1afSJed Brown    DMRestrict - restricts user-defined problem data to a coarser DM by running hooks registered by DMCoarsenHookAdd()
2452b17ce1afSJed Brown 
2453b17ce1afSJed Brown    Collective if any hooks are
2454b17ce1afSJed Brown 
2455b17ce1afSJed Brown    Input Arguments:
2456b17ce1afSJed Brown +  fine - finer DM to use as a base
2457b17ce1afSJed Brown .  restrct - restriction matrix, apply using MatRestrict()
2458b17ce1afSJed Brown .  inject - injection matrix, also use MatRestrict()
2459b17ce1afSJed Brown -  coarse - coarer DM to update
2460b17ce1afSJed Brown 
2461b17ce1afSJed Brown    Level: developer
2462b17ce1afSJed Brown 
2463b17ce1afSJed Brown .seealso: DMCoarsenHookAdd(), MatRestrict()
2464b17ce1afSJed Brown @*/
2465b17ce1afSJed Brown PetscErrorCode DMRestrict(DM fine,Mat restrct,Vec rscale,Mat inject,DM coarse)
2466b17ce1afSJed Brown {
2467b17ce1afSJed Brown   PetscErrorCode    ierr;
2468b17ce1afSJed Brown   DMCoarsenHookLink link;
2469b17ce1afSJed Brown 
2470b17ce1afSJed Brown   PetscFunctionBegin;
2471b17ce1afSJed Brown   for (link=fine->coarsenhook; link; link=link->next) {
24728865f1eaSKarl Rupp     if (link->restricthook) {
24738865f1eaSKarl Rupp       ierr = (*link->restricthook)(fine,restrct,rscale,inject,coarse,link->ctx);CHKERRQ(ierr);
24748865f1eaSKarl Rupp     }
2475b17ce1afSJed Brown   }
247647c6ae99SBarry Smith   PetscFunctionReturn(0);
247747c6ae99SBarry Smith }
247847c6ae99SBarry Smith 
247947c6ae99SBarry Smith #undef __FUNCT__
2480be081cd6SPeter Brune #define __FUNCT__ "DMSubDomainHookAdd"
2481bb9467b5SJed Brown /*@C
2482be081cd6SPeter Brune    DMSubDomainHookAdd - adds a callback to be run when restricting a problem to the coarse grid
24835dbd56e3SPeter Brune 
24845dbd56e3SPeter Brune    Logically Collective
24855dbd56e3SPeter Brune 
24865dbd56e3SPeter Brune    Input Arguments:
24875dbd56e3SPeter Brune +  global - global DM
2488ec4806b8SPeter Brune .  ddhook - function to run to pass data to the decomposition DM upon its creation
24895dbd56e3SPeter Brune .  restricthook - function to run to update data on block solve (at the beginning of the block solve)
24900298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
24915dbd56e3SPeter Brune 
2492ec4806b8SPeter Brune 
2493ec4806b8SPeter Brune    Calling sequence for ddhook:
2494ec4806b8SPeter Brune $    ddhook(DM global,DM block,void *ctx)
2495ec4806b8SPeter Brune 
2496ec4806b8SPeter Brune +  global - global DM
2497ec4806b8SPeter Brune .  block  - block DM
2498ec4806b8SPeter Brune -  ctx - optional user-defined function context
2499ec4806b8SPeter Brune 
25005dbd56e3SPeter Brune    Calling sequence for restricthook:
2501ec4806b8SPeter Brune $    restricthook(DM global,VecScatter out,VecScatter in,DM block,void *ctx)
25025dbd56e3SPeter Brune 
25035dbd56e3SPeter Brune +  global - global DM
25045dbd56e3SPeter Brune .  out    - scatter to the outer (with ghost and overlap points) block vector
25055dbd56e3SPeter Brune .  in     - scatter to block vector values only owned locally
2506ec4806b8SPeter Brune .  block  - block DM
25075dbd56e3SPeter Brune -  ctx - optional user-defined function context
25085dbd56e3SPeter Brune 
25095dbd56e3SPeter Brune    Level: advanced
25105dbd56e3SPeter Brune 
25115dbd56e3SPeter Brune    Notes:
2512ec4806b8SPeter Brune    This function is only needed if auxiliary data needs to be set up on subdomain DMs.
25135dbd56e3SPeter Brune 
25145dbd56e3SPeter Brune    If this function is called multiple times, the hooks will be run in the order they are added.
25155dbd56e3SPeter Brune 
25165dbd56e3SPeter Brune    In order to compose with nonlinear preconditioning without duplicating storage, the hook should be implemented to
2517ec4806b8SPeter Brune    extract the global information from its context (instead of from the SNES).
25185dbd56e3SPeter Brune 
2519bb9467b5SJed Brown    This function is currently not available from Fortran.
2520bb9467b5SJed Brown 
25215dbd56e3SPeter Brune .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
25225dbd56e3SPeter Brune @*/
2523be081cd6SPeter Brune PetscErrorCode DMSubDomainHookAdd(DM global,PetscErrorCode (*ddhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,VecScatter,VecScatter,DM,void*),void *ctx)
25245dbd56e3SPeter Brune {
25255dbd56e3SPeter Brune   PetscErrorCode      ierr;
2526be081cd6SPeter Brune   DMSubDomainHookLink link,*p;
25275dbd56e3SPeter Brune 
25285dbd56e3SPeter Brune   PetscFunctionBegin;
25295dbd56e3SPeter Brune   PetscValidHeaderSpecific(global,DM_CLASSID,1);
2530be081cd6SPeter Brune   for (p=&global->subdomainhook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */
2531be081cd6SPeter Brune   ierr               = PetscMalloc(sizeof(struct _DMSubDomainHookLink),&link);CHKERRQ(ierr);
25325dbd56e3SPeter Brune   link->restricthook = restricthook;
2533be081cd6SPeter Brune   link->ddhook       = ddhook;
25345dbd56e3SPeter Brune   link->ctx          = ctx;
25350298fd71SBarry Smith   link->next         = NULL;
25365dbd56e3SPeter Brune   *p                 = link;
25375dbd56e3SPeter Brune   PetscFunctionReturn(0);
25385dbd56e3SPeter Brune }
25395dbd56e3SPeter Brune 
25405dbd56e3SPeter Brune #undef __FUNCT__
2541be081cd6SPeter Brune #define __FUNCT__ "DMSubDomainRestrict"
25425dbd56e3SPeter Brune /*@
2543be081cd6SPeter Brune    DMSubDomainRestrict - restricts user-defined problem data to a block DM by running hooks registered by DMSubDomainHookAdd()
25445dbd56e3SPeter Brune 
25455dbd56e3SPeter Brune    Collective if any hooks are
25465dbd56e3SPeter Brune 
25475dbd56e3SPeter Brune    Input Arguments:
25485dbd56e3SPeter Brune +  fine - finer DM to use as a base
2549be081cd6SPeter Brune .  oscatter - scatter from domain global vector filling subdomain global vector with overlap
2550be081cd6SPeter Brune .  gscatter - scatter from domain global vector filling subdomain local vector with ghosts
25515dbd56e3SPeter Brune -  coarse - coarer DM to update
25525dbd56e3SPeter Brune 
25535dbd56e3SPeter Brune    Level: developer
25545dbd56e3SPeter Brune 
25555dbd56e3SPeter Brune .seealso: DMCoarsenHookAdd(), MatRestrict()
25565dbd56e3SPeter Brune @*/
2557be081cd6SPeter Brune PetscErrorCode DMSubDomainRestrict(DM global,VecScatter oscatter,VecScatter gscatter,DM subdm)
25585dbd56e3SPeter Brune {
25595dbd56e3SPeter Brune   PetscErrorCode      ierr;
2560be081cd6SPeter Brune   DMSubDomainHookLink link;
25615dbd56e3SPeter Brune 
25625dbd56e3SPeter Brune   PetscFunctionBegin;
2563be081cd6SPeter Brune   for (link=global->subdomainhook; link; link=link->next) {
25648865f1eaSKarl Rupp     if (link->restricthook) {
25658865f1eaSKarl Rupp       ierr = (*link->restricthook)(global,oscatter,gscatter,subdm,link->ctx);CHKERRQ(ierr);
25668865f1eaSKarl Rupp     }
25675dbd56e3SPeter Brune   }
25685dbd56e3SPeter Brune   PetscFunctionReturn(0);
25695dbd56e3SPeter Brune }
25705dbd56e3SPeter Brune 
25715dbd56e3SPeter Brune #undef __FUNCT__
25725fe1f584SPeter Brune #define __FUNCT__ "DMGetCoarsenLevel"
25735fe1f584SPeter Brune /*@
25746a7d9d85SPeter Brune     DMGetCoarsenLevel - Get's the number of coarsenings that have generated this DM.
25755fe1f584SPeter Brune 
25765fe1f584SPeter Brune     Not Collective
25775fe1f584SPeter Brune 
25785fe1f584SPeter Brune     Input Parameter:
25795fe1f584SPeter Brune .   dm - the DM object
25805fe1f584SPeter Brune 
25815fe1f584SPeter Brune     Output Parameter:
25826a7d9d85SPeter Brune .   level - number of coarsenings
25835fe1f584SPeter Brune 
25845fe1f584SPeter Brune     Level: developer
25855fe1f584SPeter Brune 
25866a7d9d85SPeter Brune .seealso DMCoarsen(), DMGetRefineLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
25875fe1f584SPeter Brune 
25885fe1f584SPeter Brune @*/
25895fe1f584SPeter Brune PetscErrorCode  DMGetCoarsenLevel(DM dm,PetscInt *level)
25905fe1f584SPeter Brune {
25915fe1f584SPeter Brune   PetscFunctionBegin;
25925fe1f584SPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
25935fe1f584SPeter Brune   *level = dm->leveldown;
25945fe1f584SPeter Brune   PetscFunctionReturn(0);
25955fe1f584SPeter Brune }
25965fe1f584SPeter Brune 
25975fe1f584SPeter Brune 
25985fe1f584SPeter Brune 
25995fe1f584SPeter Brune #undef __FUNCT__
260047c6ae99SBarry Smith #define __FUNCT__ "DMRefineHierarchy"
260147c6ae99SBarry Smith /*@C
260247c6ae99SBarry Smith     DMRefineHierarchy - Refines a DM object, all levels at once
260347c6ae99SBarry Smith 
260447c6ae99SBarry Smith     Collective on DM
260547c6ae99SBarry Smith 
260647c6ae99SBarry Smith     Input Parameter:
260747c6ae99SBarry Smith +   dm - the DM object
260847c6ae99SBarry Smith -   nlevels - the number of levels of refinement
260947c6ae99SBarry Smith 
261047c6ae99SBarry Smith     Output Parameter:
261147c6ae99SBarry Smith .   dmf - the refined DM hierarchy
261247c6ae99SBarry Smith 
261347c6ae99SBarry Smith     Level: developer
261447c6ae99SBarry Smith 
2615e727c939SJed Brown .seealso DMCoarsenHierarchy(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
261647c6ae99SBarry Smith 
261747c6ae99SBarry Smith @*/
26187087cfbeSBarry Smith PetscErrorCode  DMRefineHierarchy(DM dm,PetscInt nlevels,DM dmf[])
261947c6ae99SBarry Smith {
262047c6ae99SBarry Smith   PetscErrorCode ierr;
262147c6ae99SBarry Smith 
262247c6ae99SBarry Smith   PetscFunctionBegin;
2623171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2624ce94432eSBarry Smith   if (nlevels < 0) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_OUTOFRANGE,"nlevels cannot be negative");
262547c6ae99SBarry Smith   if (nlevels == 0) PetscFunctionReturn(0);
262647c6ae99SBarry Smith   if (dm->ops->refinehierarchy) {
262747c6ae99SBarry Smith     ierr = (*dm->ops->refinehierarchy)(dm,nlevels,dmf);CHKERRQ(ierr);
262847c6ae99SBarry Smith   } else if (dm->ops->refine) {
262947c6ae99SBarry Smith     PetscInt i;
263047c6ae99SBarry Smith 
2631ce94432eSBarry Smith     ierr = DMRefine(dm,PetscObjectComm((PetscObject)dm),&dmf[0]);CHKERRQ(ierr);
263247c6ae99SBarry Smith     for (i=1; i<nlevels; i++) {
2633ce94432eSBarry Smith       ierr = DMRefine(dmf[i-1],PetscObjectComm((PetscObject)dm),&dmf[i]);CHKERRQ(ierr);
263447c6ae99SBarry Smith     }
2635ce94432eSBarry Smith   } else SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"No RefineHierarchy for this DM yet");
263647c6ae99SBarry Smith   PetscFunctionReturn(0);
263747c6ae99SBarry Smith }
263847c6ae99SBarry Smith 
263947c6ae99SBarry Smith #undef __FUNCT__
264047c6ae99SBarry Smith #define __FUNCT__ "DMCoarsenHierarchy"
264147c6ae99SBarry Smith /*@C
264247c6ae99SBarry Smith     DMCoarsenHierarchy - Coarsens a DM object, all levels at once
264347c6ae99SBarry Smith 
264447c6ae99SBarry Smith     Collective on DM
264547c6ae99SBarry Smith 
264647c6ae99SBarry Smith     Input Parameter:
264747c6ae99SBarry Smith +   dm - the DM object
264847c6ae99SBarry Smith -   nlevels - the number of levels of coarsening
264947c6ae99SBarry Smith 
265047c6ae99SBarry Smith     Output Parameter:
265147c6ae99SBarry Smith .   dmc - the coarsened DM hierarchy
265247c6ae99SBarry Smith 
265347c6ae99SBarry Smith     Level: developer
265447c6ae99SBarry Smith 
2655e727c939SJed Brown .seealso DMRefineHierarchy(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
265647c6ae99SBarry Smith 
265747c6ae99SBarry Smith @*/
26587087cfbeSBarry Smith PetscErrorCode  DMCoarsenHierarchy(DM dm, PetscInt nlevels, DM dmc[])
265947c6ae99SBarry Smith {
266047c6ae99SBarry Smith   PetscErrorCode ierr;
266147c6ae99SBarry Smith 
266247c6ae99SBarry Smith   PetscFunctionBegin;
2663171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2664ce94432eSBarry Smith   if (nlevels < 0) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_OUTOFRANGE,"nlevels cannot be negative");
266547c6ae99SBarry Smith   if (nlevels == 0) PetscFunctionReturn(0);
266647c6ae99SBarry Smith   PetscValidPointer(dmc,3);
266747c6ae99SBarry Smith   if (dm->ops->coarsenhierarchy) {
266847c6ae99SBarry Smith     ierr = (*dm->ops->coarsenhierarchy)(dm, nlevels, dmc);CHKERRQ(ierr);
266947c6ae99SBarry Smith   } else if (dm->ops->coarsen) {
267047c6ae99SBarry Smith     PetscInt i;
267147c6ae99SBarry Smith 
2672ce94432eSBarry Smith     ierr = DMCoarsen(dm,PetscObjectComm((PetscObject)dm),&dmc[0]);CHKERRQ(ierr);
267347c6ae99SBarry Smith     for (i=1; i<nlevels; i++) {
2674ce94432eSBarry Smith       ierr = DMCoarsen(dmc[i-1],PetscObjectComm((PetscObject)dm),&dmc[i]);CHKERRQ(ierr);
267547c6ae99SBarry Smith     }
2676ce94432eSBarry Smith   } else SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"No CoarsenHierarchy for this DM yet");
267747c6ae99SBarry Smith   PetscFunctionReturn(0);
267847c6ae99SBarry Smith }
267947c6ae99SBarry Smith 
268047c6ae99SBarry Smith #undef __FUNCT__
2681e727c939SJed Brown #define __FUNCT__ "DMCreateAggregates"
268247c6ae99SBarry Smith /*@
2683e727c939SJed Brown    DMCreateAggregates - Gets the aggregates that map between
268447c6ae99SBarry Smith    grids associated with two DMs.
268547c6ae99SBarry Smith 
268647c6ae99SBarry Smith    Collective on DM
268747c6ae99SBarry Smith 
268847c6ae99SBarry Smith    Input Parameters:
268947c6ae99SBarry Smith +  dmc - the coarse grid DM
269047c6ae99SBarry Smith -  dmf - the fine grid DM
269147c6ae99SBarry Smith 
269247c6ae99SBarry Smith    Output Parameters:
269347c6ae99SBarry Smith .  rest - the restriction matrix (transpose of the projection matrix)
269447c6ae99SBarry Smith 
269547c6ae99SBarry Smith    Level: intermediate
269647c6ae99SBarry Smith 
269747c6ae99SBarry Smith .keywords: interpolation, restriction, multigrid
269847c6ae99SBarry Smith 
2699e727c939SJed Brown .seealso: DMRefine(), DMCreateInjection(), DMCreateInterpolation()
270047c6ae99SBarry Smith @*/
2701e727c939SJed Brown PetscErrorCode  DMCreateAggregates(DM dmc, DM dmf, Mat *rest)
270247c6ae99SBarry Smith {
270347c6ae99SBarry Smith   PetscErrorCode ierr;
270447c6ae99SBarry Smith 
270547c6ae99SBarry Smith   PetscFunctionBegin;
2706171400e9SBarry Smith   PetscValidHeaderSpecific(dmc,DM_CLASSID,1);
2707171400e9SBarry Smith   PetscValidHeaderSpecific(dmf,DM_CLASSID,2);
270847c6ae99SBarry Smith   ierr = (*dmc->ops->getaggregates)(dmc, dmf, rest);CHKERRQ(ierr);
270947c6ae99SBarry Smith   PetscFunctionReturn(0);
271047c6ae99SBarry Smith }
271147c6ae99SBarry Smith 
271247c6ae99SBarry Smith #undef __FUNCT__
27131a266240SBarry Smith #define __FUNCT__ "DMSetApplicationContextDestroy"
27141a266240SBarry Smith /*@C
27151a266240SBarry Smith     DMSetApplicationContextDestroy - Sets a user function that will be called to destroy the application context when the DM is destroyed
27161a266240SBarry Smith 
27171a266240SBarry Smith     Not Collective
27181a266240SBarry Smith 
27191a266240SBarry Smith     Input Parameters:
27201a266240SBarry Smith +   dm - the DM object
27211a266240SBarry Smith -   destroy - the destroy function
27221a266240SBarry Smith 
27231a266240SBarry Smith     Level: intermediate
27241a266240SBarry Smith 
2725e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
27261a266240SBarry Smith 
2727f07f9ceaSJed Brown @*/
27281a266240SBarry Smith PetscErrorCode  DMSetApplicationContextDestroy(DM dm,PetscErrorCode (*destroy)(void**))
27291a266240SBarry Smith {
27301a266240SBarry Smith   PetscFunctionBegin;
2731171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
27321a266240SBarry Smith   dm->ctxdestroy = destroy;
27331a266240SBarry Smith   PetscFunctionReturn(0);
27341a266240SBarry Smith }
27351a266240SBarry Smith 
27361a266240SBarry Smith #undef __FUNCT__
27371b2093e4SBarry Smith #define __FUNCT__ "DMSetApplicationContext"
2738b07ff414SBarry Smith /*@
27391b2093e4SBarry Smith     DMSetApplicationContext - Set a user context into a DM object
274047c6ae99SBarry Smith 
274147c6ae99SBarry Smith     Not Collective
274247c6ae99SBarry Smith 
274347c6ae99SBarry Smith     Input Parameters:
274447c6ae99SBarry Smith +   dm - the DM object
274547c6ae99SBarry Smith -   ctx - the user context
274647c6ae99SBarry Smith 
274747c6ae99SBarry Smith     Level: intermediate
274847c6ae99SBarry Smith 
2749e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
275047c6ae99SBarry Smith 
275147c6ae99SBarry Smith @*/
27521b2093e4SBarry Smith PetscErrorCode  DMSetApplicationContext(DM dm,void *ctx)
275347c6ae99SBarry Smith {
275447c6ae99SBarry Smith   PetscFunctionBegin;
2755171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
275647c6ae99SBarry Smith   dm->ctx = ctx;
275747c6ae99SBarry Smith   PetscFunctionReturn(0);
275847c6ae99SBarry Smith }
275947c6ae99SBarry Smith 
276047c6ae99SBarry Smith #undef __FUNCT__
27611b2093e4SBarry Smith #define __FUNCT__ "DMGetApplicationContext"
276247c6ae99SBarry Smith /*@
27631b2093e4SBarry Smith     DMGetApplicationContext - Gets a user context from a DM object
276447c6ae99SBarry Smith 
276547c6ae99SBarry Smith     Not Collective
276647c6ae99SBarry Smith 
276747c6ae99SBarry Smith     Input Parameter:
276847c6ae99SBarry Smith .   dm - the DM object
276947c6ae99SBarry Smith 
277047c6ae99SBarry Smith     Output Parameter:
277147c6ae99SBarry Smith .   ctx - the user context
277247c6ae99SBarry Smith 
277347c6ae99SBarry Smith     Level: intermediate
277447c6ae99SBarry Smith 
2775e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
277647c6ae99SBarry Smith 
277747c6ae99SBarry Smith @*/
27781b2093e4SBarry Smith PetscErrorCode  DMGetApplicationContext(DM dm,void *ctx)
277947c6ae99SBarry Smith {
278047c6ae99SBarry Smith   PetscFunctionBegin;
2781171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
27821b2093e4SBarry Smith   *(void**)ctx = dm->ctx;
278347c6ae99SBarry Smith   PetscFunctionReturn(0);
278447c6ae99SBarry Smith }
278547c6ae99SBarry Smith 
278647c6ae99SBarry Smith #undef __FUNCT__
278708da532bSDmitry Karpeev #define __FUNCT__ "DMSetVariableBounds"
278808da532bSDmitry Karpeev /*@C
2789df3898eeSBarry Smith     DMSetVariableBounds - sets a function to compute the lower and upper bound vectors for SNESVI.
279008da532bSDmitry Karpeev 
279108da532bSDmitry Karpeev     Logically Collective on DM
279208da532bSDmitry Karpeev 
279308da532bSDmitry Karpeev     Input Parameter:
279408da532bSDmitry Karpeev +   dm - the DM object
27950298fd71SBarry Smith -   f - the function that computes variable bounds used by SNESVI (use NULL to cancel a previous function that was set)
279608da532bSDmitry Karpeev 
279708da532bSDmitry Karpeev     Level: intermediate
279808da532bSDmitry Karpeev 
2799835c3ec7SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext(),
280008da532bSDmitry Karpeev          DMSetJacobian()
280108da532bSDmitry Karpeev 
280208da532bSDmitry Karpeev @*/
280308da532bSDmitry Karpeev PetscErrorCode  DMSetVariableBounds(DM dm,PetscErrorCode (*f)(DM,Vec,Vec))
280408da532bSDmitry Karpeev {
280508da532bSDmitry Karpeev   PetscFunctionBegin;
280608da532bSDmitry Karpeev   dm->ops->computevariablebounds = f;
280708da532bSDmitry Karpeev   PetscFunctionReturn(0);
280808da532bSDmitry Karpeev }
280908da532bSDmitry Karpeev 
281008da532bSDmitry Karpeev #undef __FUNCT__
281108da532bSDmitry Karpeev #define __FUNCT__ "DMHasVariableBounds"
281208da532bSDmitry Karpeev /*@
281308da532bSDmitry Karpeev     DMHasVariableBounds - does the DM object have a variable bounds function?
281408da532bSDmitry Karpeev 
281508da532bSDmitry Karpeev     Not Collective
281608da532bSDmitry Karpeev 
281708da532bSDmitry Karpeev     Input Parameter:
281808da532bSDmitry Karpeev .   dm - the DM object to destroy
281908da532bSDmitry Karpeev 
282008da532bSDmitry Karpeev     Output Parameter:
282108da532bSDmitry Karpeev .   flg - PETSC_TRUE if the variable bounds function exists
282208da532bSDmitry Karpeev 
282308da532bSDmitry Karpeev     Level: developer
282408da532bSDmitry Karpeev 
282574e1e8c1SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
282608da532bSDmitry Karpeev 
282708da532bSDmitry Karpeev @*/
282808da532bSDmitry Karpeev PetscErrorCode  DMHasVariableBounds(DM dm,PetscBool  *flg)
282908da532bSDmitry Karpeev {
283008da532bSDmitry Karpeev   PetscFunctionBegin;
283108da532bSDmitry Karpeev   *flg =  (dm->ops->computevariablebounds) ? PETSC_TRUE : PETSC_FALSE;
283208da532bSDmitry Karpeev   PetscFunctionReturn(0);
283308da532bSDmitry Karpeev }
283408da532bSDmitry Karpeev 
283508da532bSDmitry Karpeev #undef __FUNCT__
283608da532bSDmitry Karpeev #define __FUNCT__ "DMComputeVariableBounds"
283708da532bSDmitry Karpeev /*@C
283808da532bSDmitry Karpeev     DMComputeVariableBounds - compute variable bounds used by SNESVI.
283908da532bSDmitry Karpeev 
284008da532bSDmitry Karpeev     Logically Collective on DM
284108da532bSDmitry Karpeev 
284208da532bSDmitry Karpeev     Input Parameters:
2843907376e6SBarry Smith .   dm - the DM object
284408da532bSDmitry Karpeev 
284508da532bSDmitry Karpeev     Output parameters:
284608da532bSDmitry Karpeev +   xl - lower bound
284708da532bSDmitry Karpeev -   xu - upper bound
284808da532bSDmitry Karpeev 
2849907376e6SBarry Smith     Level: advanced
2850907376e6SBarry Smith 
2851907376e6SBarry Smith     Notes: This is generally not called by users. It calls the function provided by the user with DMSetVariableBounds()
285208da532bSDmitry Karpeev 
285374e1e8c1SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
285408da532bSDmitry Karpeev 
285508da532bSDmitry Karpeev @*/
285608da532bSDmitry Karpeev PetscErrorCode  DMComputeVariableBounds(DM dm, Vec xl, Vec xu)
285708da532bSDmitry Karpeev {
285808da532bSDmitry Karpeev   PetscErrorCode ierr;
28595fd66863SKarl Rupp 
286008da532bSDmitry Karpeev   PetscFunctionBegin;
286108da532bSDmitry Karpeev   PetscValidHeaderSpecific(xl,VEC_CLASSID,2);
286208da532bSDmitry Karpeev   PetscValidHeaderSpecific(xu,VEC_CLASSID,2);
286308da532bSDmitry Karpeev   if (dm->ops->computevariablebounds) {
286408da532bSDmitry Karpeev     ierr = (*dm->ops->computevariablebounds)(dm, xl,xu);CHKERRQ(ierr);
28658865f1eaSKarl Rupp   } else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, "This DM is incapable of computing variable bounds.");
286608da532bSDmitry Karpeev   PetscFunctionReturn(0);
286708da532bSDmitry Karpeev }
286808da532bSDmitry Karpeev 
286908da532bSDmitry Karpeev #undef __FUNCT__
2870b0ae01b7SPeter Brune #define __FUNCT__ "DMHasColoring"
2871b0ae01b7SPeter Brune /*@
2872b0ae01b7SPeter Brune     DMHasColoring - does the DM object have a method of providing a coloring?
2873b0ae01b7SPeter Brune 
2874b0ae01b7SPeter Brune     Not Collective
2875b0ae01b7SPeter Brune 
2876b0ae01b7SPeter Brune     Input Parameter:
2877b0ae01b7SPeter Brune .   dm - the DM object
2878b0ae01b7SPeter Brune 
2879b0ae01b7SPeter Brune     Output Parameter:
2880b0ae01b7SPeter Brune .   flg - PETSC_TRUE if the DM has facilities for DMCreateColoring().
2881b0ae01b7SPeter Brune 
2882b0ae01b7SPeter Brune     Level: developer
2883b0ae01b7SPeter Brune 
2884b0ae01b7SPeter Brune .seealso DMHasFunction(), DMCreateColoring()
2885b0ae01b7SPeter Brune 
2886b0ae01b7SPeter Brune @*/
2887b0ae01b7SPeter Brune PetscErrorCode  DMHasColoring(DM dm,PetscBool  *flg)
2888b0ae01b7SPeter Brune {
2889b0ae01b7SPeter Brune   PetscFunctionBegin;
2890b0ae01b7SPeter Brune   *flg =  (dm->ops->getcoloring) ? PETSC_TRUE : PETSC_FALSE;
2891b0ae01b7SPeter Brune   PetscFunctionReturn(0);
2892b0ae01b7SPeter Brune }
2893b0ae01b7SPeter Brune 
2894b0ae01b7SPeter Brune #undef __FUNCT__
28953ad4599aSBarry Smith #define __FUNCT__ "DMHasCreateRestriction"
28963ad4599aSBarry Smith /*@
28973ad4599aSBarry Smith     DMHasCreateRestriction - does the DM object have a method of providing a restriction?
28983ad4599aSBarry Smith 
28993ad4599aSBarry Smith     Not Collective
29003ad4599aSBarry Smith 
29013ad4599aSBarry Smith     Input Parameter:
29023ad4599aSBarry Smith .   dm - the DM object
29033ad4599aSBarry Smith 
29043ad4599aSBarry Smith     Output Parameter:
29053ad4599aSBarry Smith .   flg - PETSC_TRUE if the DM has facilities for DMCreateRestriction().
29063ad4599aSBarry Smith 
29073ad4599aSBarry Smith     Level: developer
29083ad4599aSBarry Smith 
29093ad4599aSBarry Smith .seealso DMHasFunction(), DMCreateRestriction()
29103ad4599aSBarry Smith 
29113ad4599aSBarry Smith @*/
29123ad4599aSBarry Smith PetscErrorCode  DMHasCreateRestriction(DM dm,PetscBool  *flg)
29133ad4599aSBarry Smith {
29143ad4599aSBarry Smith   PetscFunctionBegin;
29153ad4599aSBarry Smith   *flg =  (dm->ops->createrestriction) ? PETSC_TRUE : PETSC_FALSE;
29163ad4599aSBarry Smith   PetscFunctionReturn(0);
29173ad4599aSBarry Smith }
29183ad4599aSBarry Smith 
29193ad4599aSBarry Smith #undef  __FUNCT__
292008da532bSDmitry Karpeev #define __FUNCT__ "DMSetVec"
2921748fac09SDmitry Karpeev /*@C
292208da532bSDmitry Karpeev     DMSetVec - set the vector at which to compute residual, Jacobian and VI bounds, if the problem is nonlinear.
292308da532bSDmitry Karpeev 
292408da532bSDmitry Karpeev     Collective on DM
292508da532bSDmitry Karpeev 
292608da532bSDmitry Karpeev     Input Parameter:
292708da532bSDmitry Karpeev +   dm - the DM object
29280298fd71SBarry Smith -   x - location to compute residual and Jacobian, if NULL is passed to those routines; will be NULL for linear problems.
292908da532bSDmitry Karpeev 
293008da532bSDmitry Karpeev     Level: developer
293108da532bSDmitry Karpeev 
293274e1e8c1SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
293308da532bSDmitry Karpeev 
293408da532bSDmitry Karpeev @*/
293508da532bSDmitry Karpeev PetscErrorCode  DMSetVec(DM dm,Vec x)
293608da532bSDmitry Karpeev {
293708da532bSDmitry Karpeev   PetscErrorCode ierr;
29385fd66863SKarl Rupp 
293908da532bSDmitry Karpeev   PetscFunctionBegin;
294008da532bSDmitry Karpeev   if (x) {
294108da532bSDmitry Karpeev     if (!dm->x) {
294208da532bSDmitry Karpeev       ierr = DMCreateGlobalVector(dm,&dm->x);CHKERRQ(ierr);
294308da532bSDmitry Karpeev     }
294408da532bSDmitry Karpeev     ierr = VecCopy(x,dm->x);CHKERRQ(ierr);
29458865f1eaSKarl Rupp   } else if (dm->x) {
294608da532bSDmitry Karpeev     ierr = VecDestroy(&dm->x);CHKERRQ(ierr);
294708da532bSDmitry Karpeev   }
294808da532bSDmitry Karpeev   PetscFunctionReturn(0);
294908da532bSDmitry Karpeev }
295008da532bSDmitry Karpeev 
29510298fd71SBarry Smith PetscFunctionList DMList              = NULL;
2952264ace61SBarry Smith PetscBool         DMRegisterAllCalled = PETSC_FALSE;
2953264ace61SBarry Smith 
2954264ace61SBarry Smith #undef __FUNCT__
2955264ace61SBarry Smith #define __FUNCT__ "DMSetType"
2956264ace61SBarry Smith /*@C
2957264ace61SBarry Smith   DMSetType - Builds a DM, for a particular DM implementation.
2958264ace61SBarry Smith 
2959264ace61SBarry Smith   Collective on DM
2960264ace61SBarry Smith 
2961264ace61SBarry Smith   Input Parameters:
2962264ace61SBarry Smith + dm     - The DM object
2963264ace61SBarry Smith - method - The name of the DM type
2964264ace61SBarry Smith 
2965264ace61SBarry Smith   Options Database Key:
2966264ace61SBarry Smith . -dm_type <type> - Sets the DM type; use -help for a list of available types
2967264ace61SBarry Smith 
2968264ace61SBarry Smith   Notes:
2969e1589f56SBarry Smith   See "petsc/include/petscdm.h" for available DM types (for instance, DM1D, DM2D, or DM3D).
2970264ace61SBarry Smith 
2971264ace61SBarry Smith   Level: intermediate
2972264ace61SBarry Smith 
2973264ace61SBarry Smith .keywords: DM, set, type
2974264ace61SBarry Smith .seealso: DMGetType(), DMCreate()
2975264ace61SBarry Smith @*/
297619fd82e9SBarry Smith PetscErrorCode  DMSetType(DM dm, DMType method)
2977264ace61SBarry Smith {
2978264ace61SBarry Smith   PetscErrorCode (*r)(DM);
2979264ace61SBarry Smith   PetscBool      match;
2980264ace61SBarry Smith   PetscErrorCode ierr;
2981264ace61SBarry Smith 
2982264ace61SBarry Smith   PetscFunctionBegin;
2983264ace61SBarry Smith   PetscValidHeaderSpecific(dm, DM_CLASSID,1);
2984251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject) dm, method, &match);CHKERRQ(ierr);
2985264ace61SBarry Smith   if (match) PetscFunctionReturn(0);
2986264ace61SBarry Smith 
29870f51fdf8SToby Isaac   ierr = DMRegisterAll();CHKERRQ(ierr);
29881c9cd337SJed Brown   ierr = PetscFunctionListFind(DMList,method,&r);CHKERRQ(ierr);
2989ce94432eSBarry Smith   if (!r) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_UNKNOWN_TYPE, "Unknown DM type: %s", method);
2990264ace61SBarry Smith 
2991264ace61SBarry Smith   if (dm->ops->destroy) {
2992264ace61SBarry Smith     ierr             = (*dm->ops->destroy)(dm);CHKERRQ(ierr);
29930298fd71SBarry Smith     dm->ops->destroy = NULL;
2994264ace61SBarry Smith   }
2995264ace61SBarry Smith   ierr = (*r)(dm);CHKERRQ(ierr);
2996264ace61SBarry Smith   ierr = PetscObjectChangeTypeName((PetscObject)dm,method);CHKERRQ(ierr);
2997264ace61SBarry Smith   PetscFunctionReturn(0);
2998264ace61SBarry Smith }
2999264ace61SBarry Smith 
3000264ace61SBarry Smith #undef __FUNCT__
3001264ace61SBarry Smith #define __FUNCT__ "DMGetType"
3002264ace61SBarry Smith /*@C
3003264ace61SBarry Smith   DMGetType - Gets the DM type name (as a string) from the DM.
3004264ace61SBarry Smith 
3005264ace61SBarry Smith   Not Collective
3006264ace61SBarry Smith 
3007264ace61SBarry Smith   Input Parameter:
3008264ace61SBarry Smith . dm  - The DM
3009264ace61SBarry Smith 
3010264ace61SBarry Smith   Output Parameter:
3011264ace61SBarry Smith . type - The DM type name
3012264ace61SBarry Smith 
3013264ace61SBarry Smith   Level: intermediate
3014264ace61SBarry Smith 
3015264ace61SBarry Smith .keywords: DM, get, type, name
3016264ace61SBarry Smith .seealso: DMSetType(), DMCreate()
3017264ace61SBarry Smith @*/
301819fd82e9SBarry Smith PetscErrorCode  DMGetType(DM dm, DMType *type)
3019264ace61SBarry Smith {
3020264ace61SBarry Smith   PetscErrorCode ierr;
3021264ace61SBarry Smith 
3022264ace61SBarry Smith   PetscFunctionBegin;
3023264ace61SBarry Smith   PetscValidHeaderSpecific(dm, DM_CLASSID,1);
3024c959eef4SJed Brown   PetscValidPointer(type,2);
3025607a6623SBarry Smith   ierr = DMRegisterAll();CHKERRQ(ierr);
3026264ace61SBarry Smith   *type = ((PetscObject)dm)->type_name;
3027264ace61SBarry Smith   PetscFunctionReturn(0);
3028264ace61SBarry Smith }
3029264ace61SBarry Smith 
303067a56275SMatthew G Knepley #undef __FUNCT__
303167a56275SMatthew G Knepley #define __FUNCT__ "DMConvert"
303267a56275SMatthew G Knepley /*@C
303367a56275SMatthew G Knepley   DMConvert - Converts a DM to another DM, either of the same or different type.
303467a56275SMatthew G Knepley 
303567a56275SMatthew G Knepley   Collective on DM
303667a56275SMatthew G Knepley 
303767a56275SMatthew G Knepley   Input Parameters:
303867a56275SMatthew G Knepley + dm - the DM
303967a56275SMatthew G Knepley - newtype - new DM type (use "same" for the same type)
304067a56275SMatthew G Knepley 
304167a56275SMatthew G Knepley   Output Parameter:
304267a56275SMatthew G Knepley . M - pointer to new DM
304367a56275SMatthew G Knepley 
304467a56275SMatthew G Knepley   Notes:
304567a56275SMatthew G Knepley   Cannot be used to convert a sequential DM to parallel or parallel to sequential,
304667a56275SMatthew G Knepley   the MPI communicator of the generated DM is always the same as the communicator
304767a56275SMatthew G Knepley   of the input DM.
304867a56275SMatthew G Knepley 
304967a56275SMatthew G Knepley   Level: intermediate
305067a56275SMatthew G Knepley 
305167a56275SMatthew G Knepley .seealso: DMCreate()
305267a56275SMatthew G Knepley @*/
305319fd82e9SBarry Smith PetscErrorCode DMConvert(DM dm, DMType newtype, DM *M)
305467a56275SMatthew G Knepley {
305567a56275SMatthew G Knepley   DM             B;
305667a56275SMatthew G Knepley   char           convname[256];
3057c067b6caSMatthew G. Knepley   PetscBool      sametype/*, issame */;
305867a56275SMatthew G Knepley   PetscErrorCode ierr;
305967a56275SMatthew G Knepley 
306067a56275SMatthew G Knepley   PetscFunctionBegin;
306167a56275SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
306267a56275SMatthew G Knepley   PetscValidType(dm,1);
306367a56275SMatthew G Knepley   PetscValidPointer(M,3);
3064251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject) dm, newtype, &sametype);CHKERRQ(ierr);
3065c067b6caSMatthew G. Knepley   /* ierr = PetscStrcmp(newtype, "same", &issame);CHKERRQ(ierr); */
3066c067b6caSMatthew G. Knepley   if (sametype) {
3067c067b6caSMatthew G. Knepley     *M   = dm;
3068c067b6caSMatthew G. Knepley     ierr = PetscObjectReference((PetscObject) dm);CHKERRQ(ierr);
3069c067b6caSMatthew G. Knepley     PetscFunctionReturn(0);
3070c067b6caSMatthew G. Knepley   } else {
30710298fd71SBarry Smith     PetscErrorCode (*conv)(DM, DMType, DM*) = NULL;
307267a56275SMatthew G Knepley 
307367a56275SMatthew G Knepley     /*
307467a56275SMatthew G Knepley        Order of precedence:
307567a56275SMatthew G Knepley        1) See if a specialized converter is known to the current DM.
307667a56275SMatthew G Knepley        2) See if a specialized converter is known to the desired DM class.
307767a56275SMatthew G Knepley        3) See if a good general converter is registered for the desired class
307867a56275SMatthew G Knepley        4) See if a good general converter is known for the current matrix.
307967a56275SMatthew G Knepley        5) Use a really basic converter.
308067a56275SMatthew G Knepley     */
308167a56275SMatthew G Knepley 
308267a56275SMatthew G Knepley     /* 1) See if a specialized converter is known to the current DM and the desired class */
308367a56275SMatthew G Knepley     ierr = PetscStrcpy(convname,"DMConvert_");CHKERRQ(ierr);
308467a56275SMatthew G Knepley     ierr = PetscStrcat(convname,((PetscObject) dm)->type_name);CHKERRQ(ierr);
308567a56275SMatthew G Knepley     ierr = PetscStrcat(convname,"_");CHKERRQ(ierr);
308667a56275SMatthew G Knepley     ierr = PetscStrcat(convname,newtype);CHKERRQ(ierr);
308767a56275SMatthew G Knepley     ierr = PetscStrcat(convname,"_C");CHKERRQ(ierr);
30880005d66cSJed Brown     ierr = PetscObjectQueryFunction((PetscObject)dm,convname,&conv);CHKERRQ(ierr);
308967a56275SMatthew G Knepley     if (conv) goto foundconv;
309067a56275SMatthew G Knepley 
309167a56275SMatthew G Knepley     /* 2)  See if a specialized converter is known to the desired DM class. */
309282f516ccSBarry Smith     ierr = DMCreate(PetscObjectComm((PetscObject)dm), &B);CHKERRQ(ierr);
309367a56275SMatthew G Knepley     ierr = DMSetType(B, newtype);CHKERRQ(ierr);
309467a56275SMatthew G Knepley     ierr = PetscStrcpy(convname,"DMConvert_");CHKERRQ(ierr);
309567a56275SMatthew G Knepley     ierr = PetscStrcat(convname,((PetscObject) dm)->type_name);CHKERRQ(ierr);
309667a56275SMatthew G Knepley     ierr = PetscStrcat(convname,"_");CHKERRQ(ierr);
309767a56275SMatthew G Knepley     ierr = PetscStrcat(convname,newtype);CHKERRQ(ierr);
309867a56275SMatthew G Knepley     ierr = PetscStrcat(convname,"_C");CHKERRQ(ierr);
30990005d66cSJed Brown     ierr = PetscObjectQueryFunction((PetscObject)B,convname,&conv);CHKERRQ(ierr);
310067a56275SMatthew G Knepley     if (conv) {
3101fcfd50ebSBarry Smith       ierr = DMDestroy(&B);CHKERRQ(ierr);
310267a56275SMatthew G Knepley       goto foundconv;
310367a56275SMatthew G Knepley     }
310467a56275SMatthew G Knepley 
310567a56275SMatthew G Knepley #if 0
310667a56275SMatthew G Knepley     /* 3) See if a good general converter is registered for the desired class */
310767a56275SMatthew G Knepley     conv = B->ops->convertfrom;
3108fcfd50ebSBarry Smith     ierr = DMDestroy(&B);CHKERRQ(ierr);
310967a56275SMatthew G Knepley     if (conv) goto foundconv;
311067a56275SMatthew G Knepley 
311167a56275SMatthew G Knepley     /* 4) See if a good general converter is known for the current matrix */
311267a56275SMatthew G Knepley     if (dm->ops->convert) {
311367a56275SMatthew G Knepley       conv = dm->ops->convert;
311467a56275SMatthew G Knepley     }
311567a56275SMatthew G Knepley     if (conv) goto foundconv;
311667a56275SMatthew G Knepley #endif
311767a56275SMatthew G Knepley 
311867a56275SMatthew G Knepley     /* 5) Use a really basic converter. */
311982f516ccSBarry Smith     SETERRQ2(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "No conversion possible between DM types %s and %s", ((PetscObject) dm)->type_name, newtype);
312067a56275SMatthew G Knepley 
312167a56275SMatthew G Knepley foundconv:
312267a56275SMatthew G Knepley     ierr = PetscLogEventBegin(DM_Convert,dm,0,0,0);CHKERRQ(ierr);
312367a56275SMatthew G Knepley     ierr = (*conv)(dm,newtype,M);CHKERRQ(ierr);
312412fa691eSMatthew G. Knepley     /* Things that are independent of DM type: We should consult DMClone() here */
312512fa691eSMatthew G. Knepley     if (dm->maxCell) {
312612fa691eSMatthew G. Knepley       const PetscReal *maxCell, *L;
312712fa691eSMatthew G. Knepley       const DMBoundaryType *bd;
312812fa691eSMatthew G. Knepley       ierr = DMGetPeriodicity(dm, &maxCell, &L, &bd);CHKERRQ(ierr);
312912fa691eSMatthew G. Knepley       ierr = DMSetPeriodicity(*M,  maxCell,  L,  bd);CHKERRQ(ierr);
313012fa691eSMatthew G. Knepley     }
313167a56275SMatthew G Knepley     ierr = PetscLogEventEnd(DM_Convert,dm,0,0,0);CHKERRQ(ierr);
313267a56275SMatthew G Knepley   }
313367a56275SMatthew G Knepley   ierr = PetscObjectStateIncrease((PetscObject) *M);CHKERRQ(ierr);
313467a56275SMatthew G Knepley   PetscFunctionReturn(0);
313567a56275SMatthew G Knepley }
3136264ace61SBarry Smith 
3137264ace61SBarry Smith /*--------------------------------------------------------------------------------------------------------------------*/
3138264ace61SBarry Smith 
3139264ace61SBarry Smith #undef __FUNCT__
3140264ace61SBarry Smith #define __FUNCT__ "DMRegister"
3141264ace61SBarry Smith /*@C
31421c84c290SBarry Smith   DMRegister -  Adds a new DM component implementation
31431c84c290SBarry Smith 
31441c84c290SBarry Smith   Not Collective
31451c84c290SBarry Smith 
31461c84c290SBarry Smith   Input Parameters:
31471c84c290SBarry Smith + name        - The name of a new user-defined creation routine
31481c84c290SBarry Smith - create_func - The creation routine itself
31491c84c290SBarry Smith 
31501c84c290SBarry Smith   Notes:
31511c84c290SBarry Smith   DMRegister() may be called multiple times to add several user-defined DMs
31521c84c290SBarry Smith 
31531c84c290SBarry Smith 
31541c84c290SBarry Smith   Sample usage:
31551c84c290SBarry Smith .vb
3156bdf89e91SBarry Smith     DMRegister("my_da", MyDMCreate);
31571c84c290SBarry Smith .ve
31581c84c290SBarry Smith 
31591c84c290SBarry Smith   Then, your DM type can be chosen with the procedural interface via
31601c84c290SBarry Smith .vb
31611c84c290SBarry Smith     DMCreate(MPI_Comm, DM *);
31621c84c290SBarry Smith     DMSetType(DM,"my_da");
31631c84c290SBarry Smith .ve
31641c84c290SBarry Smith    or at runtime via the option
31651c84c290SBarry Smith .vb
31661c84c290SBarry Smith     -da_type my_da
31671c84c290SBarry Smith .ve
3168264ace61SBarry Smith 
3169264ace61SBarry Smith   Level: advanced
31701c84c290SBarry Smith 
31711c84c290SBarry Smith .keywords: DM, register
3172bdf89e91SBarry Smith .seealso: DMRegisterAll(), DMRegisterDestroy()
31731c84c290SBarry Smith 
3174264ace61SBarry Smith @*/
3175bdf89e91SBarry Smith PetscErrorCode  DMRegister(const char sname[],PetscErrorCode (*function)(DM))
3176264ace61SBarry Smith {
3177264ace61SBarry Smith   PetscErrorCode ierr;
3178264ace61SBarry Smith 
3179264ace61SBarry Smith   PetscFunctionBegin;
3180a240a19fSJed Brown   ierr = PetscFunctionListAdd(&DMList,sname,function);CHKERRQ(ierr);
3181264ace61SBarry Smith   PetscFunctionReturn(0);
3182264ace61SBarry Smith }
3183264ace61SBarry Smith 
3184b859378eSBarry Smith #undef __FUNCT__
3185b859378eSBarry Smith #define __FUNCT__ "DMLoad"
3186b859378eSBarry Smith /*@C
318755849f57SBarry Smith   DMLoad - Loads a DM that has been stored in binary  with DMView().
3188b859378eSBarry Smith 
3189b859378eSBarry Smith   Collective on PetscViewer
3190b859378eSBarry Smith 
3191b859378eSBarry Smith   Input Parameters:
3192b859378eSBarry Smith + newdm - the newly loaded DM, this needs to have been created with DMCreate() or
3193b859378eSBarry Smith            some related function before a call to DMLoad().
3194b859378eSBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen() or
3195b859378eSBarry Smith            HDF5 file viewer, obtained from PetscViewerHDF5Open()
3196b859378eSBarry Smith 
3197b859378eSBarry Smith    Level: intermediate
3198b859378eSBarry Smith 
3199b859378eSBarry Smith   Notes:
320055849f57SBarry Smith    The type is determined by the data in the file, any type set into the DM before this call is ignored.
3201b859378eSBarry Smith 
3202b859378eSBarry Smith   Notes for advanced users:
3203b859378eSBarry Smith   Most users should not need to know the details of the binary storage
3204b859378eSBarry Smith   format, since DMLoad() and DMView() completely hide these details.
3205b859378eSBarry Smith   But for anyone who's interested, the standard binary matrix storage
3206b859378eSBarry Smith   format is
3207b859378eSBarry Smith .vb
3208b859378eSBarry Smith      has not yet been determined
3209b859378eSBarry Smith .ve
3210b859378eSBarry Smith 
3211b859378eSBarry Smith .seealso: PetscViewerBinaryOpen(), DMView(), MatLoad(), VecLoad()
3212b859378eSBarry Smith @*/
3213b859378eSBarry Smith PetscErrorCode  DMLoad(DM newdm, PetscViewer viewer)
3214b859378eSBarry Smith {
32159331c7a4SMatthew G. Knepley   PetscBool      isbinary, ishdf5;
3216b859378eSBarry Smith   PetscErrorCode ierr;
3217b859378eSBarry Smith 
3218b859378eSBarry Smith   PetscFunctionBegin;
3219b859378eSBarry Smith   PetscValidHeaderSpecific(newdm,DM_CLASSID,1);
3220b859378eSBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
322132c0f0efSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
32229331c7a4SMatthew G. Knepley   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERHDF5,&ishdf5);CHKERRQ(ierr);
32239331c7a4SMatthew G. Knepley   if (isbinary) {
32249331c7a4SMatthew G. Knepley     PetscInt classid;
32259331c7a4SMatthew G. Knepley     char     type[256];
3226b859378eSBarry Smith 
3227060da220SMatthew G. Knepley     ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr);
32289200755eSBarry Smith     if (classid != DM_FILE_CLASSID) SETERRQ1(PetscObjectComm((PetscObject)newdm),PETSC_ERR_ARG_WRONG,"Not DM next in file, classid found %d",(int)classid);
3229060da220SMatthew G. Knepley     ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr);
323032c0f0efSBarry Smith     ierr = DMSetType(newdm, type);CHKERRQ(ierr);
32319331c7a4SMatthew G. Knepley     if (newdm->ops->load) {ierr = (*newdm->ops->load)(newdm,viewer);CHKERRQ(ierr);}
32329331c7a4SMatthew G. Knepley   } else if (ishdf5) {
32339331c7a4SMatthew G. Knepley     if (newdm->ops->load) {ierr = (*newdm->ops->load)(newdm,viewer);CHKERRQ(ierr);}
32349331c7a4SMatthew G. Knepley   } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen() or PetscViewerHDF5Open()");
3235b859378eSBarry Smith   PetscFunctionReturn(0);
3236b859378eSBarry Smith }
3237b859378eSBarry Smith 
32387da65231SMatthew G Knepley /******************************** FEM Support **********************************/
32397da65231SMatthew G Knepley 
32407da65231SMatthew G Knepley #undef __FUNCT__
32417da65231SMatthew G Knepley #define __FUNCT__ "DMPrintCellVector"
3242a6dfd86eSKarl Rupp PetscErrorCode DMPrintCellVector(PetscInt c, const char name[], PetscInt len, const PetscScalar x[])
3243a6dfd86eSKarl Rupp {
32441d47ebbbSSatish Balay   PetscInt       f;
32451b30c384SMatthew G Knepley   PetscErrorCode ierr;
32461b30c384SMatthew G Knepley 
32477da65231SMatthew G Knepley   PetscFunctionBegin;
324874778d6cSJed Brown   ierr = PetscPrintf(PETSC_COMM_SELF, "Cell %D Element %s\n", c, name);CHKERRQ(ierr);
32491d47ebbbSSatish Balay   for (f = 0; f < len; ++f) {
325057622a8eSBarry Smith     ierr = PetscPrintf(PETSC_COMM_SELF, "  | %g |\n", (double)PetscRealPart(x[f]));CHKERRQ(ierr);
32517da65231SMatthew G Knepley   }
32527da65231SMatthew G Knepley   PetscFunctionReturn(0);
32537da65231SMatthew G Knepley }
32547da65231SMatthew G Knepley 
32557da65231SMatthew G Knepley #undef __FUNCT__
32567da65231SMatthew G Knepley #define __FUNCT__ "DMPrintCellMatrix"
3257a6dfd86eSKarl Rupp PetscErrorCode DMPrintCellMatrix(PetscInt c, const char name[], PetscInt rows, PetscInt cols, const PetscScalar A[])
3258a6dfd86eSKarl Rupp {
32591b30c384SMatthew G Knepley   PetscInt       f, g;
32607da65231SMatthew G Knepley   PetscErrorCode ierr;
32617da65231SMatthew G Knepley 
32627da65231SMatthew G Knepley   PetscFunctionBegin;
326374778d6cSJed Brown   ierr = PetscPrintf(PETSC_COMM_SELF, "Cell %D Element %s\n", c, name);CHKERRQ(ierr);
32641d47ebbbSSatish Balay   for (f = 0; f < rows; ++f) {
326574778d6cSJed Brown     ierr = PetscPrintf(PETSC_COMM_SELF, "  |");CHKERRQ(ierr);
32661d47ebbbSSatish Balay     for (g = 0; g < cols; ++g) {
3267e3556bceSMatthew G. Knepley       ierr = PetscPrintf(PETSC_COMM_SELF, " % 9.5g", PetscRealPart(A[f*cols+g]));CHKERRQ(ierr);
32687da65231SMatthew G Knepley     }
326974778d6cSJed Brown     ierr = PetscPrintf(PETSC_COMM_SELF, " |\n");CHKERRQ(ierr);
32707da65231SMatthew G Knepley   }
32717da65231SMatthew G Knepley   PetscFunctionReturn(0);
32727da65231SMatthew G Knepley }
3273e7c4fc90SDmitry Karpeev 
3274970e74d5SMatthew G Knepley #undef __FUNCT__
3275e759306cSMatthew G. Knepley #define __FUNCT__ "DMPrintLocalVec"
32766113b454SMatthew G. Knepley PetscErrorCode DMPrintLocalVec(DM dm, const char name[], PetscReal tol, Vec X)
3277e759306cSMatthew G. Knepley {
3278e759306cSMatthew G. Knepley   PetscMPIInt    rank, numProcs;
3279e759306cSMatthew G. Knepley   PetscInt       p;
3280e759306cSMatthew G. Knepley   PetscErrorCode ierr;
3281e759306cSMatthew G. Knepley 
3282e759306cSMatthew G. Knepley   PetscFunctionBegin;
3283e759306cSMatthew G. Knepley   ierr = MPI_Comm_rank(PetscObjectComm((PetscObject) dm), &rank);CHKERRQ(ierr);
3284e759306cSMatthew G. Knepley   ierr = MPI_Comm_size(PetscObjectComm((PetscObject) dm), &numProcs);CHKERRQ(ierr);
3285e759306cSMatthew G. Knepley   ierr = PetscPrintf(PetscObjectComm((PetscObject) dm), "%s:\n", name);CHKERRQ(ierr);
3286e759306cSMatthew G. Knepley   for (p = 0; p < numProcs; ++p) {
3287e759306cSMatthew G. Knepley     if (p == rank) {
3288e759306cSMatthew G. Knepley       Vec x;
3289e759306cSMatthew G. Knepley 
3290e759306cSMatthew G. Knepley       ierr = VecDuplicate(X, &x);CHKERRQ(ierr);
3291e759306cSMatthew G. Knepley       ierr = VecCopy(X, x);CHKERRQ(ierr);
32926113b454SMatthew G. Knepley       ierr = VecChop(x, tol);CHKERRQ(ierr);
3293e759306cSMatthew G. Knepley       ierr = VecView(x, PETSC_VIEWER_STDOUT_SELF);CHKERRQ(ierr);
3294e759306cSMatthew G. Knepley       ierr = VecDestroy(&x);CHKERRQ(ierr);
3295e759306cSMatthew G. Knepley       ierr = PetscViewerFlush(PETSC_VIEWER_STDOUT_SELF);CHKERRQ(ierr);
3296e759306cSMatthew G. Knepley     }
3297e759306cSMatthew G. Knepley     ierr = PetscBarrier((PetscObject) dm);CHKERRQ(ierr);
3298e759306cSMatthew G. Knepley   }
3299e759306cSMatthew G. Knepley   PetscFunctionReturn(0);
3300e759306cSMatthew G. Knepley }
3301e759306cSMatthew G. Knepley 
3302e759306cSMatthew G. Knepley #undef __FUNCT__
330388ed4aceSMatthew G Knepley #define __FUNCT__ "DMGetDefaultSection"
330488ed4aceSMatthew G Knepley /*@
330588ed4aceSMatthew G Knepley   DMGetDefaultSection - Get the PetscSection encoding the local data layout for the DM.
330688ed4aceSMatthew G Knepley 
330788ed4aceSMatthew G Knepley   Input Parameter:
330888ed4aceSMatthew G Knepley . dm - The DM
330988ed4aceSMatthew G Knepley 
331088ed4aceSMatthew G Knepley   Output Parameter:
331188ed4aceSMatthew G Knepley . section - The PetscSection
331288ed4aceSMatthew G Knepley 
331388ed4aceSMatthew G Knepley   Level: intermediate
331488ed4aceSMatthew G Knepley 
331588ed4aceSMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSection.
331688ed4aceSMatthew G Knepley 
331788ed4aceSMatthew G Knepley .seealso: DMSetDefaultSection(), DMGetDefaultGlobalSection()
331888ed4aceSMatthew G Knepley @*/
33190adebc6cSBarry Smith PetscErrorCode DMGetDefaultSection(DM dm, PetscSection *section)
33200adebc6cSBarry Smith {
3321fd59a867SMatthew G. Knepley   PetscErrorCode ierr;
3322fd59a867SMatthew G. Knepley 
332388ed4aceSMatthew G Knepley   PetscFunctionBegin;
332488ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
332588ed4aceSMatthew G Knepley   PetscValidPointer(section, 2);
33262f0f8703SMatthew G. Knepley   if (!dm->defaultSection && dm->ops->createdefaultsection) {
33272f0f8703SMatthew G. Knepley     ierr = (*dm->ops->createdefaultsection)(dm);CHKERRQ(ierr);
3328ae71db08SMatthew G. Knepley     if (dm->defaultSection) {ierr = PetscObjectViewFromOptions((PetscObject) dm->defaultSection, NULL, "-dm_petscsection_view");CHKERRQ(ierr);}
33292f0f8703SMatthew G. Knepley   }
333088ed4aceSMatthew G Knepley   *section = dm->defaultSection;
333188ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
333288ed4aceSMatthew G Knepley }
333388ed4aceSMatthew G Knepley 
333488ed4aceSMatthew G Knepley #undef __FUNCT__
333588ed4aceSMatthew G Knepley #define __FUNCT__ "DMSetDefaultSection"
333688ed4aceSMatthew G Knepley /*@
333788ed4aceSMatthew G Knepley   DMSetDefaultSection - Set the PetscSection encoding the local data layout for the DM.
333888ed4aceSMatthew G Knepley 
333988ed4aceSMatthew G Knepley   Input Parameters:
334088ed4aceSMatthew G Knepley + dm - The DM
334188ed4aceSMatthew G Knepley - section - The PetscSection
334288ed4aceSMatthew G Knepley 
334388ed4aceSMatthew G Knepley   Level: intermediate
334488ed4aceSMatthew G Knepley 
334588ed4aceSMatthew G Knepley   Note: Any existing Section will be destroyed
334688ed4aceSMatthew G Knepley 
334788ed4aceSMatthew G Knepley .seealso: DMSetDefaultSection(), DMGetDefaultGlobalSection()
334888ed4aceSMatthew G Knepley @*/
33490adebc6cSBarry Smith PetscErrorCode DMSetDefaultSection(DM dm, PetscSection section)
33500adebc6cSBarry Smith {
3351c473ab19SMatthew G. Knepley   PetscInt       numFields = 0;
3352af122d2aSMatthew G Knepley   PetscInt       f;
335388ed4aceSMatthew G Knepley   PetscErrorCode ierr;
335488ed4aceSMatthew G Knepley 
335588ed4aceSMatthew G Knepley   PetscFunctionBegin;
335688ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
3357c473ab19SMatthew G. Knepley   if (section) {
33581d799100SJed Brown     PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2);
33591d799100SJed Brown     ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr);
3360c473ab19SMatthew G. Knepley   }
336188ed4aceSMatthew G Knepley   ierr = PetscSectionDestroy(&dm->defaultSection);CHKERRQ(ierr);
336288ed4aceSMatthew G Knepley   dm->defaultSection = section;
3363c473ab19SMatthew G. Knepley   if (section) {ierr = PetscSectionGetNumFields(dm->defaultSection, &numFields);CHKERRQ(ierr);}
3364af122d2aSMatthew G Knepley   if (numFields) {
3365af122d2aSMatthew G Knepley     ierr = DMSetNumFields(dm, numFields);CHKERRQ(ierr);
3366af122d2aSMatthew G Knepley     for (f = 0; f < numFields; ++f) {
33670f21e855SMatthew G. Knepley       PetscObject disc;
3368af122d2aSMatthew G Knepley       const char *name;
3369af122d2aSMatthew G Knepley 
3370af122d2aSMatthew G Knepley       ierr = PetscSectionGetFieldName(dm->defaultSection, f, &name);CHKERRQ(ierr);
33710f21e855SMatthew G. Knepley       ierr = DMGetField(dm, f, &disc);CHKERRQ(ierr);
33720f21e855SMatthew G. Knepley       ierr = PetscObjectSetName(disc, name);CHKERRQ(ierr);
3373af122d2aSMatthew G Knepley     }
3374af122d2aSMatthew G Knepley   }
33751d799100SJed Brown   /* The global section will be rebuilt in the next call to DMGetDefaultGlobalSection(). */
33761d799100SJed Brown   ierr = PetscSectionDestroy(&dm->defaultGlobalSection);CHKERRQ(ierr);
337788ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
337888ed4aceSMatthew G Knepley }
337988ed4aceSMatthew G Knepley 
338088ed4aceSMatthew G Knepley #undef __FUNCT__
33819435951eSToby Isaac #define __FUNCT__ "DMGetDefaultConstraints"
33829435951eSToby Isaac /*@
33839435951eSToby Isaac   DMGetDefaultConstraints - Get the PetscSection and Mat the specify the local constraint interpolation. See DMSetDefaultConstraints() for a description of the purpose of constraint interpolation.
33849435951eSToby Isaac 
3385e228b242SToby Isaac   not collective
3386e228b242SToby Isaac 
33879435951eSToby Isaac   Input Parameter:
33889435951eSToby Isaac . dm - The DM
33899435951eSToby Isaac 
33909435951eSToby Isaac   Output Parameter:
33919435951eSToby Isaac + section - The PetscSection describing the range of the constraint matrix: relates rows of the constraint matrix to dofs of the default section.  Returns NULL if there are no local constraints.
33929435951eSToby Isaac - mat - The Mat that interpolates local constraints: its width should be the layout size of the default section.  Returns NULL if there are no local constraints.
33939435951eSToby Isaac 
33949435951eSToby Isaac   Level: advanced
33959435951eSToby Isaac 
33969435951eSToby Isaac   Note: This gets borrowed references, so the user should not destroy the PetscSection or the Mat.
33979435951eSToby Isaac 
33989435951eSToby Isaac .seealso: DMSetDefaultConstraints()
33999435951eSToby Isaac @*/
34009435951eSToby Isaac PetscErrorCode DMGetDefaultConstraints(DM dm, PetscSection *section, Mat *mat)
34019435951eSToby Isaac {
34029435951eSToby Isaac   PetscErrorCode ierr;
34039435951eSToby Isaac 
34049435951eSToby Isaac   PetscFunctionBegin;
34059435951eSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
34069435951eSToby Isaac   if (!dm->defaultConstraintSection && !dm->defaultConstraintMat && dm->ops->createdefaultconstraints) {ierr = (*dm->ops->createdefaultconstraints)(dm);CHKERRQ(ierr);}
340745a75d81SToby Isaac   if (section) {*section = dm->defaultConstraintSection;}
340845a75d81SToby Isaac   if (mat) {*mat = dm->defaultConstraintMat;}
34099435951eSToby Isaac   PetscFunctionReturn(0);
34109435951eSToby Isaac }
34119435951eSToby Isaac 
34129435951eSToby Isaac #undef __FUNCT__
34139435951eSToby Isaac #define __FUNCT__ "DMSetDefaultConstraints"
34149435951eSToby Isaac /*@
34159435951eSToby Isaac   DMSetDefaultConstraints - Set the PetscSection and Mat the specify the local constraint interpolation.
34169435951eSToby Isaac 
34179435951eSToby Isaac   If a constraint matrix is specified, then it is applied during DMGlobalToLocalEnd() when mode is INSERT_VALUES, INSERT_BC_VALUES, or INSERT_ALL_VALUES.  Without a constraint matrix, the local vector l returned by DMGlobalToLocalEnd() contains values that have been scattered from a global vector without modification; with a constraint matrix A, l is modified by computing c = A * l, l[s[i]] = c[i], where the scatter s is defined by the PetscSection returned by DMGetDefaultConstraintMatrix().
34189435951eSToby Isaac 
34199435951eSToby Isaac   If a constraint matrix is specified, then its adjoint is applied during DMLocalToGlobalBegin() when mode is ADD_VALUES, ADD_BC_VALUES, or ADD_ALL_VALUES.  Without a constraint matrix, the local vector l is accumulated into a global vector without modification; with a constraint matrix A, l is first modified by computing c[i] = l[s[i]], l[s[i]] = 0, l = l + A'*c, which is the adjoint of the operation described above.
34209435951eSToby Isaac 
3421e228b242SToby Isaac   collective on dm
3422e228b242SToby Isaac 
34239435951eSToby Isaac   Input Parameters:
34249435951eSToby Isaac + dm - The DM
3425e228b242SToby Isaac + section - The PetscSection describing the range of the constraint matrix: relates rows of the constraint matrix to dofs of the default section.  Must have a local communicator (PETSC_COMM_SELF or derivative).
3426e228b242SToby Isaac - mat - The Mat that interpolates local constraints: its width should be the layout size of the default section:  NULL indicates no constraints.  Must have a local communicator (PETSC_COMM_SELF or derivative).
34279435951eSToby Isaac 
34289435951eSToby Isaac   Level: advanced
34299435951eSToby Isaac 
34309435951eSToby Isaac   Note: This increments the references of the PetscSection and the Mat, so they user can destroy them
34319435951eSToby Isaac 
34329435951eSToby Isaac .seealso: DMGetDefaultConstraints()
34339435951eSToby Isaac @*/
34349435951eSToby Isaac PetscErrorCode DMSetDefaultConstraints(DM dm, PetscSection section, Mat mat)
34359435951eSToby Isaac {
3436e228b242SToby Isaac   PetscMPIInt result;
34379435951eSToby Isaac   PetscErrorCode ierr;
34389435951eSToby Isaac 
34399435951eSToby Isaac   PetscFunctionBegin;
34409435951eSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
3441e228b242SToby Isaac   if (section) {
3442e228b242SToby Isaac     PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2);
3443e228b242SToby Isaac     ierr = MPI_Comm_compare(PETSC_COMM_SELF,PetscObjectComm((PetscObject)section),&result);CHKERRQ(ierr);
3444f60917d2SBarry Smith     if (result != MPI_CONGRUENT && result != MPI_IDENT) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NOTSAMECOMM,"constraint section must have local communicator");
3445e228b242SToby Isaac   }
3446e228b242SToby Isaac   if (mat) {
3447e228b242SToby Isaac     PetscValidHeaderSpecific(mat,MAT_CLASSID,3);
3448e228b242SToby Isaac     ierr = MPI_Comm_compare(PETSC_COMM_SELF,PetscObjectComm((PetscObject)mat),&result);CHKERRQ(ierr);
3449f60917d2SBarry Smith     if (result != MPI_CONGRUENT && result != MPI_IDENT) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NOTSAMECOMM,"constraint matrix must have local communicator");
3450e228b242SToby Isaac   }
34519435951eSToby Isaac   ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr);
34529435951eSToby Isaac   ierr = PetscSectionDestroy(&dm->defaultConstraintSection);CHKERRQ(ierr);
34539435951eSToby Isaac   dm->defaultConstraintSection = section;
34549435951eSToby Isaac   ierr = PetscObjectReference((PetscObject)mat);CHKERRQ(ierr);
34559435951eSToby Isaac   ierr = MatDestroy(&dm->defaultConstraintMat);CHKERRQ(ierr);
34569435951eSToby Isaac   dm->defaultConstraintMat = mat;
34579435951eSToby Isaac   PetscFunctionReturn(0);
34589435951eSToby Isaac }
34599435951eSToby Isaac 
3460f741bcd2SMatthew G. Knepley #ifdef PETSC_USE_DEBUG
34619435951eSToby Isaac #undef __FUNCT__
3462284f5c8fSMatthew G. Knepley #define __FUNCT__ "DMDefaultSectionCheckConsistency_Internal"
3463507e4973SMatthew G. Knepley /*
3464507e4973SMatthew G. Knepley   DMDefaultSectionCheckConsistency - Check the consistentcy of the global and local sections.
3465507e4973SMatthew G. Knepley 
3466507e4973SMatthew G. Knepley   Input Parameters:
3467507e4973SMatthew G. Knepley + dm - The DM
3468507e4973SMatthew G. Knepley . localSection - PetscSection describing the local data layout
3469507e4973SMatthew G. Knepley - globalSection - PetscSection describing the global data layout
3470507e4973SMatthew G. Knepley 
3471507e4973SMatthew G. Knepley   Level: intermediate
3472507e4973SMatthew G. Knepley 
3473507e4973SMatthew G. Knepley .seealso: DMGetDefaultSF(), DMSetDefaultSF()
3474507e4973SMatthew G. Knepley */
3475f741bcd2SMatthew G. Knepley static PetscErrorCode DMDefaultSectionCheckConsistency_Internal(DM dm, PetscSection localSection, PetscSection globalSection)
3476507e4973SMatthew G. Knepley {
3477507e4973SMatthew G. Knepley   MPI_Comm        comm;
3478507e4973SMatthew G. Knepley   PetscLayout     layout;
3479507e4973SMatthew G. Knepley   const PetscInt *ranges;
3480507e4973SMatthew G. Knepley   PetscInt        pStart, pEnd, p, nroots;
3481507e4973SMatthew G. Knepley   PetscMPIInt     size, rank;
3482507e4973SMatthew G. Knepley   PetscBool       valid = PETSC_TRUE, gvalid;
3483507e4973SMatthew G. Knepley   PetscErrorCode  ierr;
3484507e4973SMatthew G. Knepley 
3485507e4973SMatthew G. Knepley   PetscFunctionBegin;
3486507e4973SMatthew G. Knepley   ierr = PetscObjectGetComm((PetscObject)dm,&comm);CHKERRQ(ierr);
3487507e4973SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
3488507e4973SMatthew G. Knepley   ierr = MPI_Comm_size(comm, &size);CHKERRQ(ierr);
3489507e4973SMatthew G. Knepley   ierr = MPI_Comm_rank(comm, &rank);CHKERRQ(ierr);
3490507e4973SMatthew G. Knepley   ierr = PetscSectionGetChart(globalSection, &pStart, &pEnd);CHKERRQ(ierr);
3491507e4973SMatthew G. Knepley   ierr = PetscSectionGetConstrainedStorageSize(globalSection, &nroots);CHKERRQ(ierr);
3492507e4973SMatthew G. Knepley   ierr = PetscLayoutCreate(comm, &layout);CHKERRQ(ierr);
3493507e4973SMatthew G. Knepley   ierr = PetscLayoutSetBlockSize(layout, 1);CHKERRQ(ierr);
3494507e4973SMatthew G. Knepley   ierr = PetscLayoutSetLocalSize(layout, nroots);CHKERRQ(ierr);
3495507e4973SMatthew G. Knepley   ierr = PetscLayoutSetUp(layout);CHKERRQ(ierr);
3496507e4973SMatthew G. Knepley   ierr = PetscLayoutGetRanges(layout, &ranges);CHKERRQ(ierr);
3497507e4973SMatthew G. Knepley   for (p = pStart; p < pEnd; ++p) {
3498f741bcd2SMatthew G. Knepley     PetscInt       dof, cdof, off, gdof, gcdof, goff, gsize, d;
3499507e4973SMatthew G. Knepley 
3500507e4973SMatthew G. Knepley     ierr = PetscSectionGetDof(localSection, p, &dof);CHKERRQ(ierr);
3501507e4973SMatthew G. Knepley     ierr = PetscSectionGetOffset(localSection, p, &off);CHKERRQ(ierr);
3502507e4973SMatthew G. Knepley     ierr = PetscSectionGetConstraintDof(localSection, p, &cdof);CHKERRQ(ierr);
3503507e4973SMatthew G. Knepley     ierr = PetscSectionGetDof(globalSection, p, &gdof);CHKERRQ(ierr);
3504507e4973SMatthew G. Knepley     ierr = PetscSectionGetConstraintDof(globalSection, p, &gcdof);CHKERRQ(ierr);
3505507e4973SMatthew G. Knepley     ierr = PetscSectionGetOffset(globalSection, p, &goff);CHKERRQ(ierr);
3506507e4973SMatthew G. Knepley     if (!gdof) continue; /* Censored point */
3507507e4973SMatthew G. Knepley     if ((gdof < 0 ? -(gdof+1) : gdof) != dof) {ierr = PetscSynchronizedPrintf(comm, "[%d]Global dof %d for point %d not equal to local dof %d\n", rank, gdof, p, dof);CHKERRQ(ierr); valid = PETSC_FALSE;}
3508507e4973SMatthew G. Knepley     if (gcdof && (gcdof != cdof)) {ierr = PetscSynchronizedPrintf(comm, "[%d]Global constraints %d for point %d not equal to local constraints %d\n", rank, gcdof, p, cdof);CHKERRQ(ierr); valid = PETSC_FALSE;}
3509507e4973SMatthew G. Knepley     if (gdof < 0) {
3510507e4973SMatthew G. Knepley       gsize = gdof < 0 ? -(gdof+1)-gcdof : gdof-gcdof;
3511507e4973SMatthew G. Knepley       for (d = 0; d < gsize; ++d) {
3512507e4973SMatthew G. Knepley         PetscInt offset = -(goff+1) + d, r;
3513507e4973SMatthew G. Knepley 
3514507e4973SMatthew G. Knepley         ierr = PetscFindInt(offset,size+1,ranges,&r);CHKERRQ(ierr);
3515507e4973SMatthew G. Knepley         if (r < 0) r = -(r+2);
3516507e4973SMatthew G. Knepley         if ((r < 0) || (r >= size)) {ierr = PetscSynchronizedPrintf(comm, "[%d]Point %d mapped to invalid process %d (%d, %d)\n", rank, p, r, gdof, goff);CHKERRQ(ierr); valid = PETSC_FALSE;break;}
3517507e4973SMatthew G. Knepley       }
3518507e4973SMatthew G. Knepley     }
3519507e4973SMatthew G. Knepley   }
3520507e4973SMatthew G. Knepley   ierr = PetscLayoutDestroy(&layout);CHKERRQ(ierr);
3521507e4973SMatthew G. Knepley   ierr = PetscSynchronizedFlush(comm, NULL);CHKERRQ(ierr);
3522b2566f29SBarry Smith   ierr = MPIU_Allreduce(&valid, &gvalid, 1, MPIU_BOOL, MPI_LAND, comm);CHKERRQ(ierr);
3523507e4973SMatthew G. Knepley   if (!gvalid) {
3524507e4973SMatthew G. Knepley     ierr = DMView(dm, NULL);CHKERRQ(ierr);
3525507e4973SMatthew G. Knepley     SETERRQ(comm, PETSC_ERR_ARG_WRONG, "Inconsistent local and global sections");
3526507e4973SMatthew G. Knepley   }
3527507e4973SMatthew G. Knepley   PetscFunctionReturn(0);
3528507e4973SMatthew G. Knepley }
3529f741bcd2SMatthew G. Knepley #endif
3530507e4973SMatthew G. Knepley 
3531507e4973SMatthew G. Knepley #undef __FUNCT__
353288ed4aceSMatthew G Knepley #define __FUNCT__ "DMGetDefaultGlobalSection"
353388ed4aceSMatthew G Knepley /*@
353488ed4aceSMatthew G Knepley   DMGetDefaultGlobalSection - Get the PetscSection encoding the global data layout for the DM.
353588ed4aceSMatthew G Knepley 
35368b1ab98fSJed Brown   Collective on DM
35378b1ab98fSJed Brown 
353888ed4aceSMatthew G Knepley   Input Parameter:
353988ed4aceSMatthew G Knepley . dm - The DM
354088ed4aceSMatthew G Knepley 
354188ed4aceSMatthew G Knepley   Output Parameter:
354288ed4aceSMatthew G Knepley . section - The PetscSection
354388ed4aceSMatthew G Knepley 
354488ed4aceSMatthew G Knepley   Level: intermediate
354588ed4aceSMatthew G Knepley 
354688ed4aceSMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSection.
354788ed4aceSMatthew G Knepley 
354888ed4aceSMatthew G Knepley .seealso: DMSetDefaultSection(), DMGetDefaultSection()
354988ed4aceSMatthew G Knepley @*/
35500adebc6cSBarry Smith PetscErrorCode DMGetDefaultGlobalSection(DM dm, PetscSection *section)
35510adebc6cSBarry Smith {
355288ed4aceSMatthew G Knepley   PetscErrorCode ierr;
355388ed4aceSMatthew G Knepley 
355488ed4aceSMatthew G Knepley   PetscFunctionBegin;
355588ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
355688ed4aceSMatthew G Knepley   PetscValidPointer(section, 2);
355788ed4aceSMatthew G Knepley   if (!dm->defaultGlobalSection) {
3558fd59a867SMatthew G. Knepley     PetscSection s;
3559fd59a867SMatthew G. Knepley 
3560fd59a867SMatthew G. Knepley     ierr = DMGetDefaultSection(dm, &s);CHKERRQ(ierr);
3561fd59a867SMatthew G. Knepley     if (!s)  SETERRQ(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_WRONGSTATE, "DM must have a default PetscSection in order to create a global PetscSection");
3562fd59a867SMatthew G. Knepley     if (!dm->sf) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DM must have a default PetscSF in order to create a global PetscSection");
356315b58121SMatthew G. Knepley     ierr = PetscSectionCreateGlobalSection(s, dm->sf, PETSC_FALSE, PETSC_FALSE, &dm->defaultGlobalSection);CHKERRQ(ierr);
3564cf06b437SMatthew G. Knepley     ierr = PetscLayoutDestroy(&dm->map);CHKERRQ(ierr);
3565ce94432eSBarry Smith     ierr = PetscSectionGetValueLayout(PetscObjectComm((PetscObject)dm), dm->defaultGlobalSection, &dm->map);CHKERRQ(ierr);
3566685405a1SBarry Smith     ierr = PetscSectionViewFromOptions(dm->defaultGlobalSection, NULL, "-global_section_view");CHKERRQ(ierr);
356788ed4aceSMatthew G Knepley   }
356888ed4aceSMatthew G Knepley   *section = dm->defaultGlobalSection;
356988ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
357088ed4aceSMatthew G Knepley }
357188ed4aceSMatthew G Knepley 
357288ed4aceSMatthew G Knepley #undef __FUNCT__
3573b21d0597SMatthew G Knepley #define __FUNCT__ "DMSetDefaultGlobalSection"
3574b21d0597SMatthew G Knepley /*@
3575b21d0597SMatthew G Knepley   DMSetDefaultGlobalSection - Set the PetscSection encoding the global data layout for the DM.
3576b21d0597SMatthew G Knepley 
3577b21d0597SMatthew G Knepley   Input Parameters:
3578b21d0597SMatthew G Knepley + dm - The DM
35795080bbdbSMatthew G Knepley - section - The PetscSection, or NULL
3580b21d0597SMatthew G Knepley 
3581b21d0597SMatthew G Knepley   Level: intermediate
3582b21d0597SMatthew G Knepley 
3583b21d0597SMatthew G Knepley   Note: Any existing Section will be destroyed
3584b21d0597SMatthew G Knepley 
3585b21d0597SMatthew G Knepley .seealso: DMGetDefaultGlobalSection(), DMSetDefaultSection()
3586b21d0597SMatthew G Knepley @*/
35870adebc6cSBarry Smith PetscErrorCode DMSetDefaultGlobalSection(DM dm, PetscSection section)
35880adebc6cSBarry Smith {
3589b21d0597SMatthew G Knepley   PetscErrorCode ierr;
3590b21d0597SMatthew G Knepley 
3591b21d0597SMatthew G Knepley   PetscFunctionBegin;
3592b21d0597SMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
35935080bbdbSMatthew G Knepley   if (section) PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2);
35941d799100SJed Brown   ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr);
3595b21d0597SMatthew G Knepley   ierr = PetscSectionDestroy(&dm->defaultGlobalSection);CHKERRQ(ierr);
3596b21d0597SMatthew G Knepley   dm->defaultGlobalSection = section;
3597507e4973SMatthew G. Knepley #ifdef PETSC_USE_DEBUG
3598f741bcd2SMatthew G. Knepley   if (section) {ierr = DMDefaultSectionCheckConsistency_Internal(dm, dm->defaultSection, section);CHKERRQ(ierr);}
3599507e4973SMatthew G. Knepley #endif
3600b21d0597SMatthew G Knepley   PetscFunctionReturn(0);
3601b21d0597SMatthew G Knepley }
3602b21d0597SMatthew G Knepley 
3603b21d0597SMatthew G Knepley #undef __FUNCT__
360488ed4aceSMatthew G Knepley #define __FUNCT__ "DMGetDefaultSF"
360588ed4aceSMatthew G Knepley /*@
360688ed4aceSMatthew G Knepley   DMGetDefaultSF - Get the PetscSF encoding the parallel dof overlap for the DM. If it has not been set,
360788ed4aceSMatthew G Knepley   it is created from the default PetscSection layouts in the DM.
360888ed4aceSMatthew G Knepley 
360988ed4aceSMatthew G Knepley   Input Parameter:
361088ed4aceSMatthew G Knepley . dm - The DM
361188ed4aceSMatthew G Knepley 
361288ed4aceSMatthew G Knepley   Output Parameter:
361388ed4aceSMatthew G Knepley . sf - The PetscSF
361488ed4aceSMatthew G Knepley 
361588ed4aceSMatthew G Knepley   Level: intermediate
361688ed4aceSMatthew G Knepley 
361788ed4aceSMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSF.
361888ed4aceSMatthew G Knepley 
361988ed4aceSMatthew G Knepley .seealso: DMSetDefaultSF(), DMCreateDefaultSF()
362088ed4aceSMatthew G Knepley @*/
36210adebc6cSBarry Smith PetscErrorCode DMGetDefaultSF(DM dm, PetscSF *sf)
36220adebc6cSBarry Smith {
362388ed4aceSMatthew G Knepley   PetscInt       nroots;
362488ed4aceSMatthew G Knepley   PetscErrorCode ierr;
362588ed4aceSMatthew G Knepley 
362688ed4aceSMatthew G Knepley   PetscFunctionBegin;
362788ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
362888ed4aceSMatthew G Knepley   PetscValidPointer(sf, 2);
36290298fd71SBarry Smith   ierr = PetscSFGetGraph(dm->defaultSF, &nroots, NULL, NULL, NULL);CHKERRQ(ierr);
363088ed4aceSMatthew G Knepley   if (nroots < 0) {
363188ed4aceSMatthew G Knepley     PetscSection section, gSection;
363288ed4aceSMatthew G Knepley 
363388ed4aceSMatthew G Knepley     ierr = DMGetDefaultSection(dm, &section);CHKERRQ(ierr);
363431ea6d37SMatthew G Knepley     if (section) {
363588ed4aceSMatthew G Knepley       ierr = DMGetDefaultGlobalSection(dm, &gSection);CHKERRQ(ierr);
363688ed4aceSMatthew G Knepley       ierr = DMCreateDefaultSF(dm, section, gSection);CHKERRQ(ierr);
363731ea6d37SMatthew G Knepley     } else {
36380298fd71SBarry Smith       *sf = NULL;
363931ea6d37SMatthew G Knepley       PetscFunctionReturn(0);
364031ea6d37SMatthew G Knepley     }
364188ed4aceSMatthew G Knepley   }
364288ed4aceSMatthew G Knepley   *sf = dm->defaultSF;
364388ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
364488ed4aceSMatthew G Knepley }
364588ed4aceSMatthew G Knepley 
364688ed4aceSMatthew G Knepley #undef __FUNCT__
364788ed4aceSMatthew G Knepley #define __FUNCT__ "DMSetDefaultSF"
364888ed4aceSMatthew G Knepley /*@
364988ed4aceSMatthew G Knepley   DMSetDefaultSF - Set the PetscSF encoding the parallel dof overlap for the DM
365088ed4aceSMatthew G Knepley 
365188ed4aceSMatthew G Knepley   Input Parameters:
365288ed4aceSMatthew G Knepley + dm - The DM
365388ed4aceSMatthew G Knepley - sf - The PetscSF
365488ed4aceSMatthew G Knepley 
365588ed4aceSMatthew G Knepley   Level: intermediate
365688ed4aceSMatthew G Knepley 
365788ed4aceSMatthew G Knepley   Note: Any previous SF is destroyed
365888ed4aceSMatthew G Knepley 
365988ed4aceSMatthew G Knepley .seealso: DMGetDefaultSF(), DMCreateDefaultSF()
366088ed4aceSMatthew G Knepley @*/
36610adebc6cSBarry Smith PetscErrorCode DMSetDefaultSF(DM dm, PetscSF sf)
36620adebc6cSBarry Smith {
366388ed4aceSMatthew G Knepley   PetscErrorCode ierr;
366488ed4aceSMatthew G Knepley 
366588ed4aceSMatthew G Knepley   PetscFunctionBegin;
366688ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
366788ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
366888ed4aceSMatthew G Knepley   ierr          = PetscSFDestroy(&dm->defaultSF);CHKERRQ(ierr);
366988ed4aceSMatthew G Knepley   dm->defaultSF = sf;
367088ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
367188ed4aceSMatthew G Knepley }
367288ed4aceSMatthew G Knepley 
367388ed4aceSMatthew G Knepley #undef __FUNCT__
367488ed4aceSMatthew G Knepley #define __FUNCT__ "DMCreateDefaultSF"
367588ed4aceSMatthew G Knepley /*@C
367688ed4aceSMatthew G Knepley   DMCreateDefaultSF - Create the PetscSF encoding the parallel dof overlap for the DM based upon the PetscSections
367788ed4aceSMatthew G Knepley   describing the data layout.
367888ed4aceSMatthew G Knepley 
367988ed4aceSMatthew G Knepley   Input Parameters:
368088ed4aceSMatthew G Knepley + dm - The DM
368188ed4aceSMatthew G Knepley . localSection - PetscSection describing the local data layout
368288ed4aceSMatthew G Knepley - globalSection - PetscSection describing the global data layout
368388ed4aceSMatthew G Knepley 
368488ed4aceSMatthew G Knepley   Level: intermediate
368588ed4aceSMatthew G Knepley 
368688ed4aceSMatthew G Knepley .seealso: DMGetDefaultSF(), DMSetDefaultSF()
368788ed4aceSMatthew G Knepley @*/
368888ed4aceSMatthew G Knepley PetscErrorCode DMCreateDefaultSF(DM dm, PetscSection localSection, PetscSection globalSection)
368988ed4aceSMatthew G Knepley {
369082f516ccSBarry Smith   MPI_Comm       comm;
369188ed4aceSMatthew G Knepley   PetscLayout    layout;
369288ed4aceSMatthew G Knepley   const PetscInt *ranges;
369388ed4aceSMatthew G Knepley   PetscInt       *local;
369488ed4aceSMatthew G Knepley   PetscSFNode    *remote;
3695ecd73843SMatthew G. Knepley   PetscInt       pStart, pEnd, p, nroots, nleaves = 0, l;
369688ed4aceSMatthew G Knepley   PetscMPIInt    size, rank;
369788ed4aceSMatthew G Knepley   PetscErrorCode ierr;
369888ed4aceSMatthew G Knepley 
369988ed4aceSMatthew G Knepley   PetscFunctionBegin;
370082f516ccSBarry Smith   ierr = PetscObjectGetComm((PetscObject)dm,&comm);CHKERRQ(ierr);
370188ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
370288ed4aceSMatthew G Knepley   ierr = MPI_Comm_size(comm, &size);CHKERRQ(ierr);
370388ed4aceSMatthew G Knepley   ierr = MPI_Comm_rank(comm, &rank);CHKERRQ(ierr);
370488ed4aceSMatthew G Knepley   ierr = PetscSectionGetChart(globalSection, &pStart, &pEnd);CHKERRQ(ierr);
370588ed4aceSMatthew G Knepley   ierr = PetscSectionGetConstrainedStorageSize(globalSection, &nroots);CHKERRQ(ierr);
370688ed4aceSMatthew G Knepley   ierr = PetscLayoutCreate(comm, &layout);CHKERRQ(ierr);
370788ed4aceSMatthew G Knepley   ierr = PetscLayoutSetBlockSize(layout, 1);CHKERRQ(ierr);
370888ed4aceSMatthew G Knepley   ierr = PetscLayoutSetLocalSize(layout, nroots);CHKERRQ(ierr);
370988ed4aceSMatthew G Knepley   ierr = PetscLayoutSetUp(layout);CHKERRQ(ierr);
371088ed4aceSMatthew G Knepley   ierr = PetscLayoutGetRanges(layout, &ranges);CHKERRQ(ierr);
3711ecd73843SMatthew G. Knepley   for (p = pStart; p < pEnd; ++p) {
37126636e97aSMatthew G Knepley     PetscInt gdof, gcdof;
371388ed4aceSMatthew G Knepley 
37146636e97aSMatthew G Knepley     ierr     = PetscSectionGetDof(globalSection, p, &gdof);CHKERRQ(ierr);
37156636e97aSMatthew G Knepley     ierr     = PetscSectionGetConstraintDof(globalSection, p, &gcdof);CHKERRQ(ierr);
3716235fbf56SMatthew G. Knepley     if (gcdof > (gdof < 0 ? -(gdof+1) : gdof)) SETERRQ3(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Point %d has %d constraints > %d dof", p, gcdof, (gdof < 0 ? -(gdof+1) : gdof));
37176636e97aSMatthew G Knepley     nleaves += gdof < 0 ? -(gdof+1)-gcdof : gdof-gcdof;
371888ed4aceSMatthew G Knepley   }
3719785e854fSJed Brown   ierr = PetscMalloc1(nleaves, &local);CHKERRQ(ierr);
3720785e854fSJed Brown   ierr = PetscMalloc1(nleaves, &remote);CHKERRQ(ierr);
372188ed4aceSMatthew G Knepley   for (p = pStart, l = 0; p < pEnd; ++p) {
37221f588964SMatthew G Knepley     const PetscInt *cind;
37236636e97aSMatthew G Knepley     PetscInt       dof, cdof, off, gdof, gcdof, goff, gsize, d, c;
372488ed4aceSMatthew G Knepley 
372588ed4aceSMatthew G Knepley     ierr = PetscSectionGetDof(localSection, p, &dof);CHKERRQ(ierr);
372688ed4aceSMatthew G Knepley     ierr = PetscSectionGetOffset(localSection, p, &off);CHKERRQ(ierr);
372788ed4aceSMatthew G Knepley     ierr = PetscSectionGetConstraintDof(localSection, p, &cdof);CHKERRQ(ierr);
372888ed4aceSMatthew G Knepley     ierr = PetscSectionGetConstraintIndices(localSection, p, &cind);CHKERRQ(ierr);
372988ed4aceSMatthew G Knepley     ierr = PetscSectionGetDof(globalSection, p, &gdof);CHKERRQ(ierr);
37306636e97aSMatthew G Knepley     ierr = PetscSectionGetConstraintDof(globalSection, p, &gcdof);CHKERRQ(ierr);
373188ed4aceSMatthew G Knepley     ierr = PetscSectionGetOffset(globalSection, p, &goff);CHKERRQ(ierr);
37326636e97aSMatthew G Knepley     if (!gdof) continue; /* Censored point */
37336636e97aSMatthew G Knepley     gsize = gdof < 0 ? -(gdof+1)-gcdof : gdof-gcdof;
37346636e97aSMatthew G Knepley     if (gsize != dof-cdof) {
3735057b4bcdSMatthew G Knepley       if (gsize != dof) SETERRQ4(comm, PETSC_ERR_ARG_WRONG, "Global dof %d for point %d is neither the constrained size %d, nor the unconstrained %d", gsize, p, dof-cdof, dof);
37366636e97aSMatthew G Knepley       cdof = 0; /* Ignore constraints */
37376636e97aSMatthew G Knepley     }
373888ed4aceSMatthew G Knepley     for (d = 0, c = 0; d < dof; ++d) {
373988ed4aceSMatthew G Knepley       if ((c < cdof) && (cind[c] == d)) {++c; continue;}
374088ed4aceSMatthew G Knepley       local[l+d-c] = off+d;
374188ed4aceSMatthew G Knepley     }
374288ed4aceSMatthew G Knepley     if (gdof < 0) {
37436636e97aSMatthew G Knepley       for (d = 0; d < gsize; ++d, ++l) {
374488ed4aceSMatthew G Knepley         PetscInt offset = -(goff+1) + d, r;
374588ed4aceSMatthew G Knepley 
374605376888SMatthew G. Knepley         ierr = PetscFindInt(offset,size+1,ranges,&r);CHKERRQ(ierr);
374731d3f06eSJed Brown         if (r < 0) r = -(r+2);
374805376888SMatthew G. Knepley         if ((r < 0) || (r >= size)) SETERRQ4(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Point %d mapped to invalid process %d (%d, %d)", p, r, gdof, goff);
374988ed4aceSMatthew G Knepley         remote[l].rank  = r;
375088ed4aceSMatthew G Knepley         remote[l].index = offset - ranges[r];
375188ed4aceSMatthew G Knepley       }
375288ed4aceSMatthew G Knepley     } else {
37536636e97aSMatthew G Knepley       for (d = 0; d < gsize; ++d, ++l) {
375488ed4aceSMatthew G Knepley         remote[l].rank  = rank;
375588ed4aceSMatthew G Knepley         remote[l].index = goff+d - ranges[rank];
375688ed4aceSMatthew G Knepley       }
375788ed4aceSMatthew G Knepley     }
375888ed4aceSMatthew G Knepley   }
37596636e97aSMatthew G Knepley   if (l != nleaves) SETERRQ2(comm, PETSC_ERR_PLIB, "Iteration error, l %d != nleaves %d", l, nleaves);
376088ed4aceSMatthew G Knepley   ierr = PetscLayoutDestroy(&layout);CHKERRQ(ierr);
376188ed4aceSMatthew G Knepley   ierr = PetscSFSetGraph(dm->defaultSF, nroots, nleaves, local, PETSC_OWN_POINTER, remote, PETSC_OWN_POINTER);CHKERRQ(ierr);
376288ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
376388ed4aceSMatthew G Knepley }
3764af122d2aSMatthew G Knepley 
3765af122d2aSMatthew G Knepley #undef __FUNCT__
3766b21d0597SMatthew G Knepley #define __FUNCT__ "DMGetPointSF"
3767b21d0597SMatthew G Knepley /*@
3768b21d0597SMatthew G Knepley   DMGetPointSF - Get the PetscSF encoding the parallel section point overlap for the DM.
3769b21d0597SMatthew G Knepley 
3770b21d0597SMatthew G Knepley   Input Parameter:
3771b21d0597SMatthew G Knepley . dm - The DM
3772b21d0597SMatthew G Knepley 
3773b21d0597SMatthew G Knepley   Output Parameter:
3774b21d0597SMatthew G Knepley . sf - The PetscSF
3775b21d0597SMatthew G Knepley 
3776b21d0597SMatthew G Knepley   Level: intermediate
3777b21d0597SMatthew G Knepley 
3778b21d0597SMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSF.
3779b21d0597SMatthew G Knepley 
3780057b4bcdSMatthew G Knepley .seealso: DMSetPointSF(), DMGetDefaultSF(), DMSetDefaultSF(), DMCreateDefaultSF()
3781b21d0597SMatthew G Knepley @*/
37820adebc6cSBarry Smith PetscErrorCode DMGetPointSF(DM dm, PetscSF *sf)
37830adebc6cSBarry Smith {
3784b21d0597SMatthew G Knepley   PetscFunctionBegin;
3785b21d0597SMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
3786b21d0597SMatthew G Knepley   PetscValidPointer(sf, 2);
3787b21d0597SMatthew G Knepley   *sf = dm->sf;
3788b21d0597SMatthew G Knepley   PetscFunctionReturn(0);
3789b21d0597SMatthew G Knepley }
3790b21d0597SMatthew G Knepley 
3791b21d0597SMatthew G Knepley #undef __FUNCT__
3792057b4bcdSMatthew G Knepley #define __FUNCT__ "DMSetPointSF"
3793057b4bcdSMatthew G Knepley /*@
3794057b4bcdSMatthew G Knepley   DMSetPointSF - Set the PetscSF encoding the parallel section point overlap for the DM.
3795057b4bcdSMatthew G Knepley 
3796057b4bcdSMatthew G Knepley   Input Parameters:
3797057b4bcdSMatthew G Knepley + dm - The DM
3798057b4bcdSMatthew G Knepley - sf - The PetscSF
3799057b4bcdSMatthew G Knepley 
3800057b4bcdSMatthew G Knepley   Level: intermediate
3801057b4bcdSMatthew G Knepley 
3802057b4bcdSMatthew G Knepley .seealso: DMGetPointSF(), DMGetDefaultSF(), DMSetDefaultSF(), DMCreateDefaultSF()
3803057b4bcdSMatthew G Knepley @*/
38040adebc6cSBarry Smith PetscErrorCode DMSetPointSF(DM dm, PetscSF sf)
38050adebc6cSBarry Smith {
3806057b4bcdSMatthew G Knepley   PetscErrorCode ierr;
3807057b4bcdSMatthew G Knepley 
3808057b4bcdSMatthew G Knepley   PetscFunctionBegin;
3809057b4bcdSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
3810057b4bcdSMatthew G Knepley   PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 1);
3811057b4bcdSMatthew G Knepley   ierr   = PetscSFDestroy(&dm->sf);CHKERRQ(ierr);
3812057b4bcdSMatthew G Knepley   ierr   = PetscObjectReference((PetscObject) sf);CHKERRQ(ierr);
3813057b4bcdSMatthew G Knepley   dm->sf = sf;
3814057b4bcdSMatthew G Knepley   PetscFunctionReturn(0);
3815057b4bcdSMatthew G Knepley }
3816057b4bcdSMatthew G Knepley 
3817057b4bcdSMatthew G Knepley #undef __FUNCT__
38182764a2aaSMatthew G. Knepley #define __FUNCT__ "DMGetDS"
38192764a2aaSMatthew G. Knepley /*@
38202764a2aaSMatthew G. Knepley   DMGetDS - Get the PetscDS
38212764a2aaSMatthew G. Knepley 
38222764a2aaSMatthew G. Knepley   Input Parameter:
38232764a2aaSMatthew G. Knepley . dm - The DM
38242764a2aaSMatthew G. Knepley 
38252764a2aaSMatthew G. Knepley   Output Parameter:
38262764a2aaSMatthew G. Knepley . prob - The PetscDS
38272764a2aaSMatthew G. Knepley 
38282764a2aaSMatthew G. Knepley   Level: developer
38292764a2aaSMatthew G. Knepley 
38302764a2aaSMatthew G. Knepley .seealso: DMSetDS()
38312764a2aaSMatthew G. Knepley @*/
38322764a2aaSMatthew G. Knepley PetscErrorCode DMGetDS(DM dm, PetscDS *prob)
3833af122d2aSMatthew G Knepley {
3834af122d2aSMatthew G Knepley   PetscFunctionBegin;
3835af122d2aSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
38360f21e855SMatthew G. Knepley   PetscValidPointer(prob, 2);
38370f21e855SMatthew G. Knepley   *prob = dm->prob;
38380f21e855SMatthew G. Knepley   PetscFunctionReturn(0);
38390f21e855SMatthew G. Knepley }
38400f21e855SMatthew G. Knepley 
38410f21e855SMatthew G. Knepley #undef __FUNCT__
38422764a2aaSMatthew G. Knepley #define __FUNCT__ "DMSetDS"
38432764a2aaSMatthew G. Knepley /*@
38442764a2aaSMatthew G. Knepley   DMSetDS - Set the PetscDS
38452764a2aaSMatthew G. Knepley 
38462764a2aaSMatthew G. Knepley   Input Parameters:
38472764a2aaSMatthew G. Knepley + dm - The DM
38482764a2aaSMatthew G. Knepley - prob - The PetscDS
38492764a2aaSMatthew G. Knepley 
38502764a2aaSMatthew G. Knepley   Level: developer
38512764a2aaSMatthew G. Knepley 
38522764a2aaSMatthew G. Knepley .seealso: DMGetDS()
38532764a2aaSMatthew G. Knepley @*/
38542764a2aaSMatthew G. Knepley PetscErrorCode DMSetDS(DM dm, PetscDS prob)
38550f21e855SMatthew G. Knepley {
38560f21e855SMatthew G. Knepley   PetscErrorCode ierr;
38570f21e855SMatthew G. Knepley 
38580f21e855SMatthew G. Knepley   PetscFunctionBegin;
38590f21e855SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
38602764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 2);
38612764a2aaSMatthew G. Knepley   ierr = PetscDSDestroy(&dm->prob);CHKERRQ(ierr);
38620f21e855SMatthew G. Knepley   dm->prob = prob;
38630f21e855SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) dm->prob);CHKERRQ(ierr);
38640f21e855SMatthew G. Knepley   PetscFunctionReturn(0);
38650f21e855SMatthew G. Knepley }
38660f21e855SMatthew G. Knepley 
38670f21e855SMatthew G. Knepley #undef __FUNCT__
38680f21e855SMatthew G. Knepley #define __FUNCT__ "DMGetNumFields"
38690f21e855SMatthew G. Knepley PetscErrorCode DMGetNumFields(DM dm, PetscInt *numFields)
38700f21e855SMatthew G. Knepley {
38710f21e855SMatthew G. Knepley   PetscErrorCode ierr;
38720f21e855SMatthew G. Knepley 
38730f21e855SMatthew G. Knepley   PetscFunctionBegin;
38740f21e855SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
38752764a2aaSMatthew G. Knepley   ierr = PetscDSGetNumFields(dm->prob, numFields);CHKERRQ(ierr);
3876af122d2aSMatthew G Knepley   PetscFunctionReturn(0);
3877af122d2aSMatthew G Knepley }
3878af122d2aSMatthew G Knepley 
3879af122d2aSMatthew G Knepley #undef __FUNCT__
3880af122d2aSMatthew G Knepley #define __FUNCT__ "DMSetNumFields"
3881af122d2aSMatthew G Knepley PetscErrorCode DMSetNumFields(DM dm, PetscInt numFields)
3882af122d2aSMatthew G Knepley {
38830f21e855SMatthew G. Knepley   PetscInt       Nf, f;
3884af122d2aSMatthew G Knepley   PetscErrorCode ierr;
3885af122d2aSMatthew G Knepley 
3886af122d2aSMatthew G Knepley   PetscFunctionBegin;
3887af122d2aSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
38882764a2aaSMatthew G. Knepley   ierr = PetscDSGetNumFields(dm->prob, &Nf);CHKERRQ(ierr);
38890f21e855SMatthew G. Knepley   for (f = Nf; f < numFields; ++f) {
38900f21e855SMatthew G. Knepley     PetscContainer obj;
38910f21e855SMatthew G. Knepley 
38920f21e855SMatthew G. Knepley     ierr = PetscContainerCreate(PetscObjectComm((PetscObject) dm), &obj);CHKERRQ(ierr);
38932764a2aaSMatthew G. Knepley     ierr = PetscDSSetDiscretization(dm->prob, f, (PetscObject) obj);CHKERRQ(ierr);
38940f21e855SMatthew G. Knepley     ierr = PetscContainerDestroy(&obj);CHKERRQ(ierr);
3895af122d2aSMatthew G Knepley   }
3896af122d2aSMatthew G Knepley   PetscFunctionReturn(0);
3897af122d2aSMatthew G Knepley }
3898af122d2aSMatthew G Knepley 
3899af122d2aSMatthew G Knepley #undef __FUNCT__
3900af122d2aSMatthew G Knepley #define __FUNCT__ "DMGetField"
3901c1929be8SMatthew G. Knepley /*@
3902c1929be8SMatthew G. Knepley   DMGetField - Return the discretization object for a given DM field
3903c1929be8SMatthew G. Knepley 
3904c1929be8SMatthew G. Knepley   Not collective
3905c1929be8SMatthew G. Knepley 
3906c1929be8SMatthew G. Knepley   Input Parameters:
3907c1929be8SMatthew G. Knepley + dm - The DM
3908c1929be8SMatthew G. Knepley - f  - The field number
3909c1929be8SMatthew G. Knepley 
3910c1929be8SMatthew G. Knepley   Output Parameter:
3911c1929be8SMatthew G. Knepley . field - The discretization object
3912c1929be8SMatthew G. Knepley 
3913c1929be8SMatthew G. Knepley   Level: developer
3914c1929be8SMatthew G. Knepley 
3915c1929be8SMatthew G. Knepley .seealso: DMSetField()
3916c1929be8SMatthew G. Knepley @*/
3917af122d2aSMatthew G Knepley PetscErrorCode DMGetField(DM dm, PetscInt f, PetscObject *field)
3918af122d2aSMatthew G Knepley {
39190f21e855SMatthew G. Knepley   PetscErrorCode ierr;
39200f21e855SMatthew G. Knepley 
3921af122d2aSMatthew G Knepley   PetscFunctionBegin;
3922af122d2aSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
39232764a2aaSMatthew G. Knepley   ierr = PetscDSGetDiscretization(dm->prob, f, field);CHKERRQ(ierr);
3924decb47aaSMatthew G. Knepley   PetscFunctionReturn(0);
3925decb47aaSMatthew G. Knepley }
3926decb47aaSMatthew G. Knepley 
3927decb47aaSMatthew G. Knepley #undef __FUNCT__
3928decb47aaSMatthew G. Knepley #define __FUNCT__ "DMSetField"
3929c1929be8SMatthew G. Knepley /*@
3930c1929be8SMatthew G. Knepley   DMSetField - Set the discretization object for a given DM field
3931c1929be8SMatthew G. Knepley 
3932c1929be8SMatthew G. Knepley   Logically collective on DM
3933c1929be8SMatthew G. Knepley 
3934c1929be8SMatthew G. Knepley   Input Parameters:
3935c1929be8SMatthew G. Knepley + dm - The DM
3936c1929be8SMatthew G. Knepley . f  - The field number
3937c1929be8SMatthew G. Knepley - field - The discretization object
3938c1929be8SMatthew G. Knepley 
3939c1929be8SMatthew G. Knepley   Level: developer
3940c1929be8SMatthew G. Knepley 
3941c1929be8SMatthew G. Knepley .seealso: DMGetField()
3942c1929be8SMatthew G. Knepley @*/
3943decb47aaSMatthew G. Knepley PetscErrorCode DMSetField(DM dm, PetscInt f, PetscObject field)
3944decb47aaSMatthew G. Knepley {
3945decb47aaSMatthew G. Knepley   PetscErrorCode ierr;
3946decb47aaSMatthew G. Knepley 
3947decb47aaSMatthew G. Knepley   PetscFunctionBegin;
3948decb47aaSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
39492764a2aaSMatthew G. Knepley   ierr = PetscDSSetDiscretization(dm->prob, f, field);CHKERRQ(ierr);
3950af122d2aSMatthew G Knepley   PetscFunctionReturn(0);
3951af122d2aSMatthew G Knepley }
39526636e97aSMatthew G Knepley 
39536636e97aSMatthew G Knepley #undef __FUNCT__
3954b64e0483SPeter Brune #define __FUNCT__ "DMRestrictHook_Coordinates"
3955b64e0483SPeter Brune PetscErrorCode DMRestrictHook_Coordinates(DM dm,DM dmc,void *ctx)
3956b64e0483SPeter Brune {
3957b64e0483SPeter Brune   DM dm_coord,dmc_coord;
3958b64e0483SPeter Brune   PetscErrorCode ierr;
3959b64e0483SPeter Brune   Vec coords,ccoords;
39606dbf9973SLawrence Mitchell   Mat inject;
3961b64e0483SPeter Brune   PetscFunctionBegin;
3962b64e0483SPeter Brune   ierr = DMGetCoordinateDM(dm,&dm_coord);CHKERRQ(ierr);
3963b64e0483SPeter Brune   ierr = DMGetCoordinateDM(dmc,&dmc_coord);CHKERRQ(ierr);
3964b64e0483SPeter Brune   ierr = DMGetCoordinates(dm,&coords);CHKERRQ(ierr);
3965b64e0483SPeter Brune   ierr = DMGetCoordinates(dmc,&ccoords);CHKERRQ(ierr);
3966b64e0483SPeter Brune   if (coords && !ccoords) {
3967b64e0483SPeter Brune     ierr = DMCreateGlobalVector(dmc_coord,&ccoords);CHKERRQ(ierr);
39686668ed41SLisandro Dalcin     ierr = PetscObjectSetName((PetscObject)ccoords,"coordinates");CHKERRQ(ierr);
39696dbf9973SLawrence Mitchell     ierr = DMCreateInjection(dmc_coord,dm_coord,&inject);CHKERRQ(ierr);
39702adcf181SLawrence Mitchell     ierr = MatRestrict(inject,coords,ccoords);CHKERRQ(ierr);
39716dbf9973SLawrence Mitchell     ierr = MatDestroy(&inject);CHKERRQ(ierr);
3972b64e0483SPeter Brune     ierr = DMSetCoordinates(dmc,ccoords);CHKERRQ(ierr);
3973b64e0483SPeter Brune     ierr = VecDestroy(&ccoords);CHKERRQ(ierr);
3974b64e0483SPeter Brune   }
3975b64e0483SPeter Brune   PetscFunctionReturn(0);
3976b64e0483SPeter Brune }
3977b64e0483SPeter Brune 
3978b64e0483SPeter Brune #undef __FUNCT__
397903dadc2fSPeter Brune #define __FUNCT__ "DMSubDomainHook_Coordinates"
398003dadc2fSPeter Brune static PetscErrorCode DMSubDomainHook_Coordinates(DM dm,DM subdm,void *ctx)
398103dadc2fSPeter Brune {
398203dadc2fSPeter Brune   DM dm_coord,subdm_coord;
398303dadc2fSPeter Brune   PetscErrorCode ierr;
398403dadc2fSPeter Brune   Vec coords,ccoords,clcoords;
398503dadc2fSPeter Brune   VecScatter *scat_i,*scat_g;
398603dadc2fSPeter Brune   PetscFunctionBegin;
398703dadc2fSPeter Brune   ierr = DMGetCoordinateDM(dm,&dm_coord);CHKERRQ(ierr);
398803dadc2fSPeter Brune   ierr = DMGetCoordinateDM(subdm,&subdm_coord);CHKERRQ(ierr);
398903dadc2fSPeter Brune   ierr = DMGetCoordinates(dm,&coords);CHKERRQ(ierr);
399003dadc2fSPeter Brune   ierr = DMGetCoordinates(subdm,&ccoords);CHKERRQ(ierr);
399103dadc2fSPeter Brune   if (coords && !ccoords) {
399203dadc2fSPeter Brune     ierr = DMCreateGlobalVector(subdm_coord,&ccoords);CHKERRQ(ierr);
39936668ed41SLisandro Dalcin     ierr = PetscObjectSetName((PetscObject)ccoords,"coordinates");CHKERRQ(ierr);
399403dadc2fSPeter Brune     ierr = DMCreateLocalVector(subdm_coord,&clcoords);CHKERRQ(ierr);
399524640c55SToby Isaac     ierr = PetscObjectSetName((PetscObject)clcoords,"coordinates");CHKERRQ(ierr);
399603dadc2fSPeter Brune     ierr = DMCreateDomainDecompositionScatters(dm_coord,1,&subdm_coord,NULL,&scat_i,&scat_g);CHKERRQ(ierr);
399703dadc2fSPeter Brune     ierr = VecScatterBegin(scat_i[0],coords,ccoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
399803dadc2fSPeter Brune     ierr = VecScatterBegin(scat_g[0],coords,clcoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
399903dadc2fSPeter Brune     ierr = VecScatterEnd(scat_i[0],coords,ccoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
400003dadc2fSPeter Brune     ierr = VecScatterEnd(scat_g[0],coords,clcoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
400103dadc2fSPeter Brune     ierr = DMSetCoordinates(subdm,ccoords);CHKERRQ(ierr);
400203dadc2fSPeter Brune     ierr = DMSetCoordinatesLocal(subdm,clcoords);CHKERRQ(ierr);
400303dadc2fSPeter Brune     ierr = VecScatterDestroy(&scat_i[0]);CHKERRQ(ierr);
400403dadc2fSPeter Brune     ierr = VecScatterDestroy(&scat_g[0]);CHKERRQ(ierr);
400503dadc2fSPeter Brune     ierr = VecDestroy(&ccoords);CHKERRQ(ierr);
400603dadc2fSPeter Brune     ierr = VecDestroy(&clcoords);CHKERRQ(ierr);
400703dadc2fSPeter Brune     ierr = PetscFree(scat_i);CHKERRQ(ierr);
400803dadc2fSPeter Brune     ierr = PetscFree(scat_g);CHKERRQ(ierr);
400903dadc2fSPeter Brune   }
401003dadc2fSPeter Brune   PetscFunctionReturn(0);
401103dadc2fSPeter Brune }
401203dadc2fSPeter Brune 
401303dadc2fSPeter Brune #undef __FUNCT__
4014c73cfb54SMatthew G. Knepley #define __FUNCT__ "DMGetDimension"
4015c73cfb54SMatthew G. Knepley /*@
4016c73cfb54SMatthew G. Knepley   DMGetDimension - Return the topological dimension of the DM
4017c73cfb54SMatthew G. Knepley 
4018c73cfb54SMatthew G. Knepley   Not collective
4019c73cfb54SMatthew G. Knepley 
4020c73cfb54SMatthew G. Knepley   Input Parameter:
4021c73cfb54SMatthew G. Knepley . dm - The DM
4022c73cfb54SMatthew G. Knepley 
4023c73cfb54SMatthew G. Knepley   Output Parameter:
4024c73cfb54SMatthew G. Knepley . dim - The topological dimension
4025c73cfb54SMatthew G. Knepley 
4026c73cfb54SMatthew G. Knepley   Level: beginner
4027c73cfb54SMatthew G. Knepley 
4028c73cfb54SMatthew G. Knepley .seealso: DMSetDimension(), DMCreate()
4029c73cfb54SMatthew G. Knepley @*/
4030c73cfb54SMatthew G. Knepley PetscErrorCode DMGetDimension(DM dm, PetscInt *dim)
4031c73cfb54SMatthew G. Knepley {
4032c73cfb54SMatthew G. Knepley   PetscFunctionBegin;
4033c73cfb54SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4034c73cfb54SMatthew G. Knepley   PetscValidPointer(dim, 2);
4035c73cfb54SMatthew G. Knepley   *dim = dm->dim;
4036c73cfb54SMatthew G. Knepley   PetscFunctionReturn(0);
4037c73cfb54SMatthew G. Knepley }
4038c73cfb54SMatthew G. Knepley 
4039c73cfb54SMatthew G. Knepley #undef __FUNCT__
4040c73cfb54SMatthew G. Knepley #define __FUNCT__ "DMSetDimension"
4041c73cfb54SMatthew G. Knepley /*@
4042c73cfb54SMatthew G. Knepley   DMSetDimension - Set the topological dimension of the DM
4043c73cfb54SMatthew G. Knepley 
4044c73cfb54SMatthew G. Knepley   Collective on dm
4045c73cfb54SMatthew G. Knepley 
4046c73cfb54SMatthew G. Knepley   Input Parameters:
4047c73cfb54SMatthew G. Knepley + dm - The DM
4048c73cfb54SMatthew G. Knepley - dim - The topological dimension
4049c73cfb54SMatthew G. Knepley 
4050c73cfb54SMatthew G. Knepley   Level: beginner
4051c73cfb54SMatthew G. Knepley 
4052c73cfb54SMatthew G. Knepley .seealso: DMGetDimension(), DMCreate()
4053c73cfb54SMatthew G. Knepley @*/
4054c73cfb54SMatthew G. Knepley PetscErrorCode DMSetDimension(DM dm, PetscInt dim)
4055c73cfb54SMatthew G. Knepley {
4056c73cfb54SMatthew G. Knepley   PetscFunctionBegin;
4057c73cfb54SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4058c73cfb54SMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, dim, 2);
4059c73cfb54SMatthew G. Knepley   dm->dim = dim;
4060c73cfb54SMatthew G. Knepley   PetscFunctionReturn(0);
4061c73cfb54SMatthew G. Knepley }
4062c73cfb54SMatthew G. Knepley 
4063793f3fe5SMatthew G. Knepley #undef __FUNCT__
4064793f3fe5SMatthew G. Knepley #define __FUNCT__ "DMGetDimPoints"
4065793f3fe5SMatthew G. Knepley /*@
4066793f3fe5SMatthew G. Knepley   DMGetDimPoints - Get the half-open interval for all points of a given dimension
4067793f3fe5SMatthew G. Knepley 
4068793f3fe5SMatthew G. Knepley   Collective on DM
4069793f3fe5SMatthew G. Knepley 
4070793f3fe5SMatthew G. Knepley   Input Parameters:
4071793f3fe5SMatthew G. Knepley + dm - the DM
4072793f3fe5SMatthew G. Knepley - dim - the dimension
4073793f3fe5SMatthew G. Knepley 
4074793f3fe5SMatthew G. Knepley   Output Parameters:
4075793f3fe5SMatthew G. Knepley + pStart - The first point of the given dimension
4076793f3fe5SMatthew G. Knepley . pEnd - The first point following points of the given dimension
4077793f3fe5SMatthew G. Knepley 
4078793f3fe5SMatthew G. Knepley   Note:
4079793f3fe5SMatthew G. Knepley   The points are vertices in the Hasse diagram encoding the topology. This is explained in
4080793f3fe5SMatthew G. Knepley   http://arxiv.org/abs/0908.4427. If not points exist of this dimension in the storage scheme,
4081793f3fe5SMatthew G. Knepley   then the interval is empty.
4082793f3fe5SMatthew G. Knepley 
4083793f3fe5SMatthew G. Knepley   Level: intermediate
4084793f3fe5SMatthew G. Knepley 
4085793f3fe5SMatthew G. Knepley .keywords: point, Hasse Diagram, dimension
4086793f3fe5SMatthew G. Knepley .seealso: DMPLEX, DMPlexGetDepthStratum(), DMPlexGetHeightStratum()
4087793f3fe5SMatthew G. Knepley @*/
4088793f3fe5SMatthew G. Knepley PetscErrorCode DMGetDimPoints(DM dm, PetscInt dim, PetscInt *pStart, PetscInt *pEnd)
4089793f3fe5SMatthew G. Knepley {
4090793f3fe5SMatthew G. Knepley   PetscInt       d;
4091793f3fe5SMatthew G. Knepley   PetscErrorCode ierr;
4092793f3fe5SMatthew G. Knepley 
4093793f3fe5SMatthew G. Knepley   PetscFunctionBegin;
4094793f3fe5SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
4095793f3fe5SMatthew G. Knepley   ierr = DMGetDimension(dm, &d);CHKERRQ(ierr);
4096793f3fe5SMatthew G. Knepley   if ((dim < 0) || (dim > d)) SETERRQ2(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid dimension %d 1", dim, d);
4097793f3fe5SMatthew G. Knepley   ierr = (*dm->ops->getdimpoints)(dm, dim, pStart, pEnd);CHKERRQ(ierr);
4098793f3fe5SMatthew G. Knepley   PetscFunctionReturn(0);
4099793f3fe5SMatthew G. Knepley }
4100793f3fe5SMatthew G. Knepley 
4101793f3fe5SMatthew G. Knepley #undef __FUNCT__
41026636e97aSMatthew G Knepley #define __FUNCT__ "DMSetCoordinates"
41036636e97aSMatthew G Knepley /*@
41046636e97aSMatthew G Knepley   DMSetCoordinates - Sets into the DM a global vector that holds the coordinates
41056636e97aSMatthew G Knepley 
41066636e97aSMatthew G Knepley   Collective on DM
41076636e97aSMatthew G Knepley 
41086636e97aSMatthew G Knepley   Input Parameters:
41096636e97aSMatthew G Knepley + dm - the DM
41106636e97aSMatthew G Knepley - c - coordinate vector
41116636e97aSMatthew G Knepley 
41126636e97aSMatthew G Knepley   Note:
41136636e97aSMatthew G Knepley   The coordinates do include those for ghost points, which are in the local vector
41146636e97aSMatthew G Knepley 
41156636e97aSMatthew G Knepley   Level: intermediate
41166636e97aSMatthew G Knepley 
41176636e97aSMatthew G Knepley .keywords: distributed array, get, corners, nodes, local indices, coordinates
41186636e97aSMatthew G Knepley .seealso: DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLoca(), DMGetCoordinateDM()
41196636e97aSMatthew G Knepley @*/
41206636e97aSMatthew G Knepley PetscErrorCode DMSetCoordinates(DM dm, Vec c)
41216636e97aSMatthew G Knepley {
41226636e97aSMatthew G Knepley   PetscErrorCode ierr;
41236636e97aSMatthew G Knepley 
41246636e97aSMatthew G Knepley   PetscFunctionBegin;
41256636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
41266636e97aSMatthew G Knepley   PetscValidHeaderSpecific(c,VEC_CLASSID,2);
41276636e97aSMatthew G Knepley   ierr            = PetscObjectReference((PetscObject) c);CHKERRQ(ierr);
41286636e97aSMatthew G Knepley   ierr            = VecDestroy(&dm->coordinates);CHKERRQ(ierr);
41296636e97aSMatthew G Knepley   dm->coordinates = c;
41306636e97aSMatthew G Knepley   ierr            = VecDestroy(&dm->coordinatesLocal);CHKERRQ(ierr);
4131b64e0483SPeter Brune   ierr            = DMCoarsenHookAdd(dm,DMRestrictHook_Coordinates,NULL,NULL);CHKERRQ(ierr);
413203dadc2fSPeter Brune   ierr            = DMSubDomainHookAdd(dm,DMSubDomainHook_Coordinates,NULL,NULL);CHKERRQ(ierr);
41336636e97aSMatthew G Knepley   PetscFunctionReturn(0);
41346636e97aSMatthew G Knepley }
41356636e97aSMatthew G Knepley 
41366636e97aSMatthew G Knepley #undef __FUNCT__
41376636e97aSMatthew G Knepley #define __FUNCT__ "DMSetCoordinatesLocal"
41386636e97aSMatthew G Knepley /*@
41396636e97aSMatthew G Knepley   DMSetCoordinatesLocal - Sets into the DM a local vector that holds the coordinates
41406636e97aSMatthew G Knepley 
41416636e97aSMatthew G Knepley   Collective on DM
41426636e97aSMatthew G Knepley 
41436636e97aSMatthew G Knepley    Input Parameters:
41446636e97aSMatthew G Knepley +  dm - the DM
41456636e97aSMatthew G Knepley -  c - coordinate vector
41466636e97aSMatthew G Knepley 
41476636e97aSMatthew G Knepley   Note:
41486636e97aSMatthew G Knepley   The coordinates of ghost points can be set using DMSetCoordinates()
41496636e97aSMatthew G Knepley   followed by DMGetCoordinatesLocal(). This is intended to enable the
41506636e97aSMatthew G Knepley   setting of ghost coordinates outside of the domain.
41516636e97aSMatthew G Knepley 
41526636e97aSMatthew G Knepley   Level: intermediate
41536636e97aSMatthew G Knepley 
41546636e97aSMatthew G Knepley .keywords: distributed array, get, corners, nodes, local indices, coordinates
41556636e97aSMatthew G Knepley .seealso: DMGetCoordinatesLocal(), DMSetCoordinates(), DMGetCoordinates(), DMGetCoordinateDM()
41566636e97aSMatthew G Knepley @*/
41576636e97aSMatthew G Knepley PetscErrorCode DMSetCoordinatesLocal(DM dm, Vec c)
41586636e97aSMatthew G Knepley {
41596636e97aSMatthew G Knepley   PetscErrorCode ierr;
41606636e97aSMatthew G Knepley 
41616636e97aSMatthew G Knepley   PetscFunctionBegin;
41626636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
41636636e97aSMatthew G Knepley   PetscValidHeaderSpecific(c,VEC_CLASSID,2);
41646636e97aSMatthew G Knepley   ierr = PetscObjectReference((PetscObject) c);CHKERRQ(ierr);
41656636e97aSMatthew G Knepley   ierr = VecDestroy(&dm->coordinatesLocal);CHKERRQ(ierr);
41668865f1eaSKarl Rupp 
41676636e97aSMatthew G Knepley   dm->coordinatesLocal = c;
41688865f1eaSKarl Rupp 
41696636e97aSMatthew G Knepley   ierr = VecDestroy(&dm->coordinates);CHKERRQ(ierr);
41706636e97aSMatthew G Knepley   PetscFunctionReturn(0);
41716636e97aSMatthew G Knepley }
41726636e97aSMatthew G Knepley 
41736636e97aSMatthew G Knepley #undef __FUNCT__
41746636e97aSMatthew G Knepley #define __FUNCT__ "DMGetCoordinates"
41756636e97aSMatthew G Knepley /*@
41766636e97aSMatthew G Knepley   DMGetCoordinates - Gets a global vector with the coordinates associated with the DM.
41776636e97aSMatthew G Knepley 
41786636e97aSMatthew G Knepley   Not Collective
41796636e97aSMatthew G Knepley 
41806636e97aSMatthew G Knepley   Input Parameter:
41816636e97aSMatthew G Knepley . dm - the DM
41826636e97aSMatthew G Knepley 
41836636e97aSMatthew G Knepley   Output Parameter:
41846636e97aSMatthew G Knepley . c - global coordinate vector
41856636e97aSMatthew G Knepley 
41866636e97aSMatthew G Knepley   Note:
41876636e97aSMatthew G Knepley   This is a borrowed reference, so the user should NOT destroy this vector
41886636e97aSMatthew G Knepley 
41896636e97aSMatthew G Knepley   Each process has only the local coordinates (does NOT have the ghost coordinates).
41906636e97aSMatthew G Knepley 
41916636e97aSMatthew G Knepley   For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...)
41926636e97aSMatthew G Knepley   and (x_0,y_0,z_0,x_1,y_1,z_1...)
41936636e97aSMatthew G Knepley 
41946636e97aSMatthew G Knepley   Level: intermediate
41956636e97aSMatthew G Knepley 
41966636e97aSMatthew G Knepley .keywords: distributed array, get, corners, nodes, local indices, coordinates
41976636e97aSMatthew G Knepley .seealso: DMSetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM()
41986636e97aSMatthew G Knepley @*/
41996636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinates(DM dm, Vec *c)
42006636e97aSMatthew G Knepley {
42016636e97aSMatthew G Knepley   PetscErrorCode ierr;
42026636e97aSMatthew G Knepley 
42036636e97aSMatthew G Knepley   PetscFunctionBegin;
42046636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
42056636e97aSMatthew G Knepley   PetscValidPointer(c,2);
42061f588964SMatthew G Knepley   if (!dm->coordinates && dm->coordinatesLocal) {
42070298fd71SBarry Smith     DM cdm = NULL;
42086636e97aSMatthew G Knepley 
42096636e97aSMatthew G Knepley     ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
42106636e97aSMatthew G Knepley     ierr = DMCreateGlobalVector(cdm, &dm->coordinates);CHKERRQ(ierr);
42116636e97aSMatthew G Knepley     ierr = PetscObjectSetName((PetscObject) dm->coordinates, "coordinates");CHKERRQ(ierr);
42126636e97aSMatthew G Knepley     ierr = DMLocalToGlobalBegin(cdm, dm->coordinatesLocal, INSERT_VALUES, dm->coordinates);CHKERRQ(ierr);
42136636e97aSMatthew G Knepley     ierr = DMLocalToGlobalEnd(cdm, dm->coordinatesLocal, INSERT_VALUES, dm->coordinates);CHKERRQ(ierr);
42146636e97aSMatthew G Knepley   }
42156636e97aSMatthew G Knepley   *c = dm->coordinates;
42166636e97aSMatthew G Knepley   PetscFunctionReturn(0);
42176636e97aSMatthew G Knepley }
42186636e97aSMatthew G Knepley 
42196636e97aSMatthew G Knepley #undef __FUNCT__
42206636e97aSMatthew G Knepley #define __FUNCT__ "DMGetCoordinatesLocal"
42216636e97aSMatthew G Knepley /*@
42226636e97aSMatthew G Knepley   DMGetCoordinatesLocal - Gets a local vector with the coordinates associated with the DM.
42236636e97aSMatthew G Knepley 
42246636e97aSMatthew G Knepley   Collective on DM
42256636e97aSMatthew G Knepley 
42266636e97aSMatthew G Knepley   Input Parameter:
42276636e97aSMatthew G Knepley . dm - the DM
42286636e97aSMatthew G Knepley 
42296636e97aSMatthew G Knepley   Output Parameter:
42306636e97aSMatthew G Knepley . c - coordinate vector
42316636e97aSMatthew G Knepley 
42326636e97aSMatthew G Knepley   Note:
42336636e97aSMatthew G Knepley   This is a borrowed reference, so the user should NOT destroy this vector
42346636e97aSMatthew G Knepley 
42356636e97aSMatthew G Knepley   Each process has the local and ghost coordinates
42366636e97aSMatthew G Knepley 
42376636e97aSMatthew G Knepley   For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...)
42386636e97aSMatthew G Knepley   and (x_0,y_0,z_0,x_1,y_1,z_1...)
42396636e97aSMatthew G Knepley 
42406636e97aSMatthew G Knepley   Level: intermediate
42416636e97aSMatthew G Knepley 
42426636e97aSMatthew G Knepley .keywords: distributed array, get, corners, nodes, local indices, coordinates
42436636e97aSMatthew G Knepley .seealso: DMSetCoordinatesLocal(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM()
42446636e97aSMatthew G Knepley @*/
42456636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinatesLocal(DM dm, Vec *c)
42466636e97aSMatthew G Knepley {
42476636e97aSMatthew G Knepley   PetscErrorCode ierr;
42486636e97aSMatthew G Knepley 
42496636e97aSMatthew G Knepley   PetscFunctionBegin;
42506636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
42516636e97aSMatthew G Knepley   PetscValidPointer(c,2);
42521f588964SMatthew G Knepley   if (!dm->coordinatesLocal && dm->coordinates) {
42530298fd71SBarry Smith     DM cdm = NULL;
42546636e97aSMatthew G Knepley 
42556636e97aSMatthew G Knepley     ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
42566636e97aSMatthew G Knepley     ierr = DMCreateLocalVector(cdm, &dm->coordinatesLocal);CHKERRQ(ierr);
42576636e97aSMatthew G Knepley     ierr = PetscObjectSetName((PetscObject) dm->coordinatesLocal, "coordinates");CHKERRQ(ierr);
42586636e97aSMatthew G Knepley     ierr = DMGlobalToLocalBegin(cdm, dm->coordinates, INSERT_VALUES, dm->coordinatesLocal);CHKERRQ(ierr);
42596636e97aSMatthew G Knepley     ierr = DMGlobalToLocalEnd(cdm, dm->coordinates, INSERT_VALUES, dm->coordinatesLocal);CHKERRQ(ierr);
42606636e97aSMatthew G Knepley   }
42616636e97aSMatthew G Knepley   *c = dm->coordinatesLocal;
42626636e97aSMatthew G Knepley   PetscFunctionReturn(0);
42636636e97aSMatthew G Knepley }
42646636e97aSMatthew G Knepley 
42656636e97aSMatthew G Knepley #undef __FUNCT__
42666636e97aSMatthew G Knepley #define __FUNCT__ "DMGetCoordinateDM"
42676636e97aSMatthew G Knepley /*@
42681cfe2091SMatthew G. Knepley   DMGetCoordinateDM - Gets the DM that prescribes coordinate layout and scatters between global and local coordinates
42696636e97aSMatthew G Knepley 
42706636e97aSMatthew G Knepley   Collective on DM
42716636e97aSMatthew G Knepley 
42726636e97aSMatthew G Knepley   Input Parameter:
42736636e97aSMatthew G Knepley . dm - the DM
42746636e97aSMatthew G Knepley 
42756636e97aSMatthew G Knepley   Output Parameter:
42766636e97aSMatthew G Knepley . cdm - coordinate DM
42776636e97aSMatthew G Knepley 
42786636e97aSMatthew G Knepley   Level: intermediate
42796636e97aSMatthew G Knepley 
42806636e97aSMatthew G Knepley .keywords: distributed array, get, corners, nodes, local indices, coordinates
42811cfe2091SMatthew G. Knepley .seealso: DMSetCoordinateDM(), DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal()
42826636e97aSMatthew G Knepley @*/
42836636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinateDM(DM dm, DM *cdm)
42846636e97aSMatthew G Knepley {
42856636e97aSMatthew G Knepley   PetscErrorCode ierr;
42866636e97aSMatthew G Knepley 
42876636e97aSMatthew G Knepley   PetscFunctionBegin;
42886636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
42896636e97aSMatthew G Knepley   PetscValidPointer(cdm,2);
42906636e97aSMatthew G Knepley   if (!dm->coordinateDM) {
429182f516ccSBarry Smith     if (!dm->ops->createcoordinatedm) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Unable to create coordinates for this DM");
42926636e97aSMatthew G Knepley     ierr = (*dm->ops->createcoordinatedm)(dm, &dm->coordinateDM);CHKERRQ(ierr);
42936636e97aSMatthew G Knepley   }
42946636e97aSMatthew G Knepley   *cdm = dm->coordinateDM;
42956636e97aSMatthew G Knepley   PetscFunctionReturn(0);
42966636e97aSMatthew G Knepley }
4297e87bb0d3SMatthew G Knepley 
4298e87bb0d3SMatthew G Knepley #undef __FUNCT__
42991cfe2091SMatthew G. Knepley #define __FUNCT__ "DMSetCoordinateDM"
43001cfe2091SMatthew G. Knepley /*@
43011cfe2091SMatthew G. Knepley   DMSetCoordinateDM - Sets the DM that prescribes coordinate layout and scatters between global and local coordinates
43021cfe2091SMatthew G. Knepley 
43031cfe2091SMatthew G. Knepley   Logically Collective on DM
43041cfe2091SMatthew G. Knepley 
43051cfe2091SMatthew G. Knepley   Input Parameters:
43061cfe2091SMatthew G. Knepley + dm - the DM
43071cfe2091SMatthew G. Knepley - cdm - coordinate DM
43081cfe2091SMatthew G. Knepley 
43091cfe2091SMatthew G. Knepley   Level: intermediate
43101cfe2091SMatthew G. Knepley 
43111cfe2091SMatthew G. Knepley .keywords: distributed array, get, corners, nodes, local indices, coordinates
43121cfe2091SMatthew G. Knepley .seealso: DMGetCoordinateDM(), DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal()
43131cfe2091SMatthew G. Knepley @*/
43141cfe2091SMatthew G. Knepley PetscErrorCode DMSetCoordinateDM(DM dm, DM cdm)
43151cfe2091SMatthew G. Knepley {
43161cfe2091SMatthew G. Knepley   PetscErrorCode ierr;
43171cfe2091SMatthew G. Knepley 
43181cfe2091SMatthew G. Knepley   PetscFunctionBegin;
43191cfe2091SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
43201cfe2091SMatthew G. Knepley   PetscValidHeaderSpecific(cdm,DM_CLASSID,2);
43211cfe2091SMatthew G. Knepley   ierr = DMDestroy(&dm->coordinateDM);CHKERRQ(ierr);
43221cfe2091SMatthew G. Knepley   dm->coordinateDM = cdm;
43231cfe2091SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) dm->coordinateDM);CHKERRQ(ierr);
43241cfe2091SMatthew G. Knepley   PetscFunctionReturn(0);
43251cfe2091SMatthew G. Knepley }
43261cfe2091SMatthew G. Knepley 
43271cfe2091SMatthew G. Knepley #undef __FUNCT__
432846e270d4SMatthew G. Knepley #define __FUNCT__ "DMGetCoordinateDim"
432946e270d4SMatthew G. Knepley /*@
433046e270d4SMatthew G. Knepley   DMGetCoordinateDim - Retrieve the dimension of embedding space for coordinate values.
433146e270d4SMatthew G. Knepley 
433246e270d4SMatthew G. Knepley   Not Collective
433346e270d4SMatthew G. Knepley 
433446e270d4SMatthew G. Knepley   Input Parameter:
433546e270d4SMatthew G. Knepley . dm - The DM object
433646e270d4SMatthew G. Knepley 
433746e270d4SMatthew G. Knepley   Output Parameter:
433846e270d4SMatthew G. Knepley . dim - The embedding dimension
433946e270d4SMatthew G. Knepley 
434046e270d4SMatthew G. Knepley   Level: intermediate
434146e270d4SMatthew G. Knepley 
434246e270d4SMatthew G. Knepley .keywords: mesh, coordinates
434346e270d4SMatthew G. Knepley .seealso: DMSetCoordinateDim(), DMGetCoordinateSection(), DMGetCoordinateDM(), DMGetDefaultSection(), DMSetDefaultSection()
434446e270d4SMatthew G. Knepley @*/
434546e270d4SMatthew G. Knepley PetscErrorCode DMGetCoordinateDim(DM dm, PetscInt *dim)
434646e270d4SMatthew G. Knepley {
434746e270d4SMatthew G. Knepley   PetscFunctionBegin;
434846e270d4SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
434946e270d4SMatthew G. Knepley   PetscValidPointer(dim, 2);
43509a9a41abSToby Isaac   if (dm->dimEmbed == PETSC_DEFAULT) {
43519a9a41abSToby Isaac     dm->dimEmbed = dm->dim;
43529a9a41abSToby Isaac   }
435346e270d4SMatthew G. Knepley   *dim = dm->dimEmbed;
435446e270d4SMatthew G. Knepley   PetscFunctionReturn(0);
435546e270d4SMatthew G. Knepley }
435646e270d4SMatthew G. Knepley 
435746e270d4SMatthew G. Knepley #undef __FUNCT__
435846e270d4SMatthew G. Knepley #define __FUNCT__ "DMSetCoordinateDim"
435946e270d4SMatthew G. Knepley /*@
436046e270d4SMatthew G. Knepley   DMSetCoordinateDim - Set the dimension of the embedding space for coordinate values.
436146e270d4SMatthew G. Knepley 
436246e270d4SMatthew G. Knepley   Not Collective
436346e270d4SMatthew G. Knepley 
436446e270d4SMatthew G. Knepley   Input Parameters:
436546e270d4SMatthew G. Knepley + dm  - The DM object
436646e270d4SMatthew G. Knepley - dim - The embedding dimension
436746e270d4SMatthew G. Knepley 
436846e270d4SMatthew G. Knepley   Level: intermediate
436946e270d4SMatthew G. Knepley 
437046e270d4SMatthew G. Knepley .keywords: mesh, coordinates
437146e270d4SMatthew G. Knepley .seealso: DMGetCoordinateDim(), DMSetCoordinateSection(), DMGetCoordinateSection(), DMGetDefaultSection(), DMSetDefaultSection()
437246e270d4SMatthew G. Knepley @*/
437346e270d4SMatthew G. Knepley PetscErrorCode DMSetCoordinateDim(DM dm, PetscInt dim)
437446e270d4SMatthew G. Knepley {
437546e270d4SMatthew G. Knepley   PetscFunctionBegin;
437646e270d4SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
437746e270d4SMatthew G. Knepley   dm->dimEmbed = dim;
437846e270d4SMatthew G. Knepley   PetscFunctionReturn(0);
437946e270d4SMatthew G. Knepley }
438046e270d4SMatthew G. Knepley 
438146e270d4SMatthew G. Knepley #undef __FUNCT__
4382e8abe2deSMatthew G. Knepley #define __FUNCT__ "DMGetCoordinateSection"
4383e8abe2deSMatthew G. Knepley /*@
4384e8abe2deSMatthew G. Knepley   DMGetCoordinateSection - Retrieve the layout of coordinate values over the mesh.
4385e8abe2deSMatthew G. Knepley 
4386e8abe2deSMatthew G. Knepley   Not Collective
4387e8abe2deSMatthew G. Knepley 
4388e8abe2deSMatthew G. Knepley   Input Parameter:
4389e8abe2deSMatthew G. Knepley . dm - The DM object
4390e8abe2deSMatthew G. Knepley 
4391e8abe2deSMatthew G. Knepley   Output Parameter:
4392e8abe2deSMatthew G. Knepley . section - The PetscSection object
4393e8abe2deSMatthew G. Knepley 
4394e8abe2deSMatthew G. Knepley   Level: intermediate
4395e8abe2deSMatthew G. Knepley 
4396e8abe2deSMatthew G. Knepley .keywords: mesh, coordinates
4397e8abe2deSMatthew G. Knepley .seealso: DMGetCoordinateDM(), DMGetDefaultSection(), DMSetDefaultSection()
4398e8abe2deSMatthew G. Knepley @*/
4399e8abe2deSMatthew G. Knepley PetscErrorCode DMGetCoordinateSection(DM dm, PetscSection *section)
4400e8abe2deSMatthew G. Knepley {
4401e8abe2deSMatthew G. Knepley   DM             cdm;
4402e8abe2deSMatthew G. Knepley   PetscErrorCode ierr;
4403e8abe2deSMatthew G. Knepley 
4404e8abe2deSMatthew G. Knepley   PetscFunctionBegin;
4405e8abe2deSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4406e8abe2deSMatthew G. Knepley   PetscValidPointer(section, 2);
4407e8abe2deSMatthew G. Knepley   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
4408e8abe2deSMatthew G. Knepley   ierr = DMGetDefaultSection(cdm, section);CHKERRQ(ierr);
4409e8abe2deSMatthew G. Knepley   PetscFunctionReturn(0);
4410e8abe2deSMatthew G. Knepley }
4411e8abe2deSMatthew G. Knepley 
4412e8abe2deSMatthew G. Knepley #undef __FUNCT__
4413e8abe2deSMatthew G. Knepley #define __FUNCT__ "DMSetCoordinateSection"
4414e8abe2deSMatthew G. Knepley /*@
4415e8abe2deSMatthew G. Knepley   DMSetCoordinateSection - Set the layout of coordinate values over the mesh.
4416e8abe2deSMatthew G. Knepley 
4417e8abe2deSMatthew G. Knepley   Not Collective
4418e8abe2deSMatthew G. Knepley 
4419e8abe2deSMatthew G. Knepley   Input Parameters:
4420e8abe2deSMatthew G. Knepley + dm      - The DM object
442146e270d4SMatthew G. Knepley . dim     - The embedding dimension, or PETSC_DETERMINE
4422e8abe2deSMatthew G. Knepley - section - The PetscSection object
4423e8abe2deSMatthew G. Knepley 
4424e8abe2deSMatthew G. Knepley   Level: intermediate
4425e8abe2deSMatthew G. Knepley 
4426e8abe2deSMatthew G. Knepley .keywords: mesh, coordinates
4427e8abe2deSMatthew G. Knepley .seealso: DMGetCoordinateSection(), DMGetDefaultSection(), DMSetDefaultSection()
4428e8abe2deSMatthew G. Knepley @*/
442946e270d4SMatthew G. Knepley PetscErrorCode DMSetCoordinateSection(DM dm, PetscInt dim, PetscSection section)
4430e8abe2deSMatthew G. Knepley {
4431e8abe2deSMatthew G. Knepley   DM             cdm;
4432e8abe2deSMatthew G. Knepley   PetscErrorCode ierr;
4433e8abe2deSMatthew G. Knepley 
4434e8abe2deSMatthew G. Knepley   PetscFunctionBegin;
4435e8abe2deSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
443646e270d4SMatthew G. Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,3);
4437e8abe2deSMatthew G. Knepley   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
4438e8abe2deSMatthew G. Knepley   ierr = DMSetDefaultSection(cdm, section);CHKERRQ(ierr);
443946e270d4SMatthew G. Knepley   if (dim == PETSC_DETERMINE) {
4440*4c1069a6SMatthew G. Knepley     PetscInt d = PETSC_DEFAULT;
444146e270d4SMatthew G. Knepley     PetscInt pStart, pEnd, vStart, vEnd, v, dd;
444246e270d4SMatthew G. Knepley 
444346e270d4SMatthew G. Knepley     ierr = PetscSectionGetChart(section, &pStart, &pEnd);CHKERRQ(ierr);
444446e270d4SMatthew G. Knepley     ierr = DMGetDimPoints(dm, 0, &vStart, &vEnd);CHKERRQ(ierr);
444546e270d4SMatthew G. Knepley     pStart = PetscMax(vStart, pStart);
444646e270d4SMatthew G. Knepley     pEnd   = PetscMin(vEnd, pEnd);
444746e270d4SMatthew G. Knepley     for (v = pStart; v < pEnd; ++v) {
444846e270d4SMatthew G. Knepley       ierr = PetscSectionGetDof(section, v, &dd);CHKERRQ(ierr);
444946e270d4SMatthew G. Knepley       if (dd) {d = dd; break;}
445046e270d4SMatthew G. Knepley     }
445146e270d4SMatthew G. Knepley     ierr = DMSetCoordinateDim(dm, d);CHKERRQ(ierr);
445246e270d4SMatthew G. Knepley   }
4453e8abe2deSMatthew G. Knepley   PetscFunctionReturn(0);
4454e8abe2deSMatthew G. Knepley }
4455e8abe2deSMatthew G. Knepley 
4456e8abe2deSMatthew G. Knepley #undef __FUNCT__
4457c6b900c6SMatthew G. Knepley #define __FUNCT__ "DMGetPeriodicity"
44585dc8c3f7SMatthew G. Knepley /*@C
44595dc8c3f7SMatthew G. Knepley   DMSetPeriodicity - Set the description of mesh periodicity
44605dc8c3f7SMatthew G. Knepley 
44615dc8c3f7SMatthew G. Knepley   Input Parameters:
44625dc8c3f7SMatthew G. Knepley + dm      - The DM object
44635dc8c3f7SMatthew G. Knepley . maxCell - Over distances greater than this, we can assume a point has crossed over to another sheet, when trying to localize cell coordinates
44645dc8c3f7SMatthew G. Knepley . L       - If we assume the mesh is a torus, this is the length of each coordinate
44655dc8c3f7SMatthew G. Knepley - bd      - This describes the type of periodicity in each topological dimension
44665dc8c3f7SMatthew G. Knepley 
44675dc8c3f7SMatthew G. Knepley   Level: developer
44685dc8c3f7SMatthew G. Knepley 
44695dc8c3f7SMatthew G. Knepley .seealso: DMGetPeriodicity()
44705dc8c3f7SMatthew G. Knepley @*/
44715dc8c3f7SMatthew G. Knepley PetscErrorCode DMGetPeriodicity(DM dm, const PetscReal **maxCell, const PetscReal **L, const DMBoundaryType **bd)
4472c6b900c6SMatthew G. Knepley {
4473c6b900c6SMatthew G. Knepley   PetscFunctionBegin;
4474c6b900c6SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
4475c6b900c6SMatthew G. Knepley   if (L)       *L       = dm->L;
4476c6b900c6SMatthew G. Knepley   if (maxCell) *maxCell = dm->maxCell;
44775dc8c3f7SMatthew G. Knepley   if (bd)      *bd      = dm->bdtype;
4478c6b900c6SMatthew G. Knepley   PetscFunctionReturn(0);
4479c6b900c6SMatthew G. Knepley }
4480c6b900c6SMatthew G. Knepley 
4481c6b900c6SMatthew G. Knepley #undef __FUNCT__
4482c6b900c6SMatthew G. Knepley #define __FUNCT__ "DMSetPeriodicity"
44835dc8c3f7SMatthew G. Knepley /*@C
44845dc8c3f7SMatthew G. Knepley   DMSetPeriodicity - Set the description of mesh periodicity
44855dc8c3f7SMatthew G. Knepley 
44865dc8c3f7SMatthew G. Knepley   Input Parameters:
44875dc8c3f7SMatthew G. Knepley + dm      - The DM object
44885dc8c3f7SMatthew G. Knepley . maxCell - Over distances greater than this, we can assume a point has crossed over to another sheet, when trying to localize cell coordinates
44895dc8c3f7SMatthew G. Knepley . L       - If we assume the mesh is a torus, this is the length of each coordinate
44905dc8c3f7SMatthew G. Knepley - bd      - This describes the type of periodicity in each topological dimension
44915dc8c3f7SMatthew G. Knepley 
44925dc8c3f7SMatthew G. Knepley   Level: developer
44935dc8c3f7SMatthew G. Knepley 
44945dc8c3f7SMatthew G. Knepley .seealso: DMGetPeriodicity()
44955dc8c3f7SMatthew G. Knepley @*/
44965dc8c3f7SMatthew G. Knepley PetscErrorCode DMSetPeriodicity(DM dm, const PetscReal maxCell[], const PetscReal L[], const DMBoundaryType bd[])
4497c6b900c6SMatthew G. Knepley {
4498c6b900c6SMatthew G. Knepley   PetscInt       dim, d;
4499c6b900c6SMatthew G. Knepley   PetscErrorCode ierr;
4500c6b900c6SMatthew G. Knepley 
4501c6b900c6SMatthew G. Knepley   PetscFunctionBegin;
4502c6b900c6SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
45035dc8c3f7SMatthew G. Knepley   PetscValidPointer(L,3);PetscValidPointer(maxCell,2);PetscValidPointer(bd,4);
45045dc8c3f7SMatthew G. Knepley   ierr = PetscFree3(dm->L,dm->maxCell,dm->bdtype);CHKERRQ(ierr);
45055dc8c3f7SMatthew G. Knepley   ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr);
45065dc8c3f7SMatthew G. Knepley   ierr = PetscMalloc3(dim,&dm->L,dim,&dm->maxCell,dim,&dm->bdtype);CHKERRQ(ierr);
45075dc8c3f7SMatthew G. Knepley   for (d = 0; d < dim; ++d) {dm->L[d] = L[d]; dm->maxCell[d] = maxCell[d]; dm->bdtype[d] = bd[d];}
4508c6b900c6SMatthew G. Knepley   PetscFunctionReturn(0);
4509c6b900c6SMatthew G. Knepley }
4510c6b900c6SMatthew G. Knepley 
4511c6b900c6SMatthew G. Knepley #undef __FUNCT__
45122e17dfb7SMatthew G. Knepley #define __FUNCT__ "DMLocalizeCoordinate"
45132e17dfb7SMatthew G. Knepley /*@
45142e17dfb7SMatthew G. Knepley   DMLocalizeCoordinate - If a mesh is periodic (a torus with lengths L_i, some of which can be infinite), project the coordinate onto [0, L_i) in each dimension.
45152e17dfb7SMatthew G. Knepley 
45162e17dfb7SMatthew G. Knepley   Input Parameters:
45172e17dfb7SMatthew G. Knepley + dm     - The DM
45182e17dfb7SMatthew G. Knepley - in     - The input coordinate point (dim numbers)
45192e17dfb7SMatthew G. Knepley 
45202e17dfb7SMatthew G. Knepley   Output Parameter:
45212e17dfb7SMatthew G. Knepley . out - The localized coordinate point
45222e17dfb7SMatthew G. Knepley 
45232e17dfb7SMatthew G. Knepley   Level: developer
45242e17dfb7SMatthew G. Knepley 
45252e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeAddCoordinate()
45262e17dfb7SMatthew G. Knepley @*/
45272e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinate(DM dm, const PetscScalar in[], PetscScalar out[])
45282e17dfb7SMatthew G. Knepley {
45292e17dfb7SMatthew G. Knepley   PetscInt       dim, d;
45302e17dfb7SMatthew G. Knepley   PetscErrorCode ierr;
45312e17dfb7SMatthew G. Knepley 
45322e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
45332e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &dim);CHKERRQ(ierr);
45342e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
45352e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] = in[d];
45362e17dfb7SMatthew G. Knepley   } else {
45372e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) {
45382e17dfb7SMatthew G. Knepley       out[d] = in[d] - dm->L[d]*floor(PetscRealPart(in[d])/dm->L[d]);
45392e17dfb7SMatthew G. Knepley     }
45402e17dfb7SMatthew G. Knepley   }
45412e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
45422e17dfb7SMatthew G. Knepley }
45432e17dfb7SMatthew G. Knepley 
45442e17dfb7SMatthew G. Knepley #undef __FUNCT__
45452e17dfb7SMatthew G. Knepley #define __FUNCT__ "DMLocalizeCoordinate_Internal"
45462e17dfb7SMatthew G. Knepley /*
45472e17dfb7SMatthew G. Knepley   DMLocalizeCoordinate_Internal - If a mesh is periodic, and the input point is far from the anchor, pick the coordinate sheet of the torus which moves it closer.
45482e17dfb7SMatthew G. Knepley 
45492e17dfb7SMatthew G. Knepley   Input Parameters:
45502e17dfb7SMatthew G. Knepley + dm     - The DM
45512e17dfb7SMatthew G. Knepley . dim    - The spatial dimension
45522e17dfb7SMatthew G. Knepley . anchor - The anchor point, the input point can be no more than maxCell away from it
45532e17dfb7SMatthew G. Knepley - in     - The input coordinate point (dim numbers)
45542e17dfb7SMatthew G. Knepley 
45552e17dfb7SMatthew G. Knepley   Output Parameter:
45562e17dfb7SMatthew G. Knepley . out - The localized coordinate point
45572e17dfb7SMatthew G. Knepley 
45582e17dfb7SMatthew G. Knepley   Level: developer
45592e17dfb7SMatthew G. Knepley 
45602e17dfb7SMatthew G. Knepley   Note: This is meant to get a set of coordinates close to each other, as in a cell. The anchor is usually the one of the vertices on a containing cell
45612e17dfb7SMatthew G. Knepley 
45622e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeAddCoordinate()
45632e17dfb7SMatthew G. Knepley */
45642e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinate_Internal(DM dm, PetscInt dim, const PetscScalar anchor[], const PetscScalar in[], PetscScalar out[])
45652e17dfb7SMatthew G. Knepley {
45662e17dfb7SMatthew G. Knepley   PetscInt d;
45672e17dfb7SMatthew G. Knepley 
45682e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
45692e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
45702e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] = in[d];
45712e17dfb7SMatthew G. Knepley   } else {
45722e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) {
45732e17dfb7SMatthew G. Knepley       if (PetscAbsScalar(anchor[d] - in[d]) > dm->maxCell[d]) {
45742e17dfb7SMatthew G. Knepley         out[d] = PetscRealPart(anchor[d]) > PetscRealPart(in[d]) ? dm->L[d] + in[d] : in[d] - dm->L[d];
45752e17dfb7SMatthew G. Knepley       } else {
45762e17dfb7SMatthew G. Knepley         out[d] = in[d];
45772e17dfb7SMatthew G. Knepley       }
45782e17dfb7SMatthew G. Knepley     }
45792e17dfb7SMatthew G. Knepley   }
45802e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
45812e17dfb7SMatthew G. Knepley }
45822e17dfb7SMatthew G. Knepley #undef __FUNCT__
45832e17dfb7SMatthew G. Knepley #define __FUNCT__ "DMLocalizeCoordinateReal_Internal"
45842e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinateReal_Internal(DM dm, PetscInt dim, const PetscReal anchor[], const PetscReal in[], PetscReal out[])
45852e17dfb7SMatthew G. Knepley {
45862e17dfb7SMatthew G. Knepley   PetscInt d;
45872e17dfb7SMatthew G. Knepley 
45882e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
45892e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
45902e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] = in[d];
45912e17dfb7SMatthew G. Knepley   } else {
45922e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) {
45932e17dfb7SMatthew G. Knepley       if (PetscAbsReal(anchor[d] - in[d]) > dm->maxCell[d]) {
45942e17dfb7SMatthew G. Knepley         out[d] = anchor[d] > in[d] ? dm->L[d] + in[d] : in[d] - dm->L[d];
45952e17dfb7SMatthew G. Knepley       } else {
45962e17dfb7SMatthew G. Knepley         out[d] = in[d];
45972e17dfb7SMatthew G. Knepley       }
45982e17dfb7SMatthew G. Knepley     }
45992e17dfb7SMatthew G. Knepley   }
46002e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
46012e17dfb7SMatthew G. Knepley }
46022e17dfb7SMatthew G. Knepley 
46032e17dfb7SMatthew G. Knepley #undef __FUNCT__
46042e17dfb7SMatthew G. Knepley #define __FUNCT__ "DMLocalizeAddCoordinate_Internal"
46052e17dfb7SMatthew G. Knepley /*
46062e17dfb7SMatthew G. Knepley   DMLocalizeAddCoordinate_Internal - If a mesh is periodic, and the input point is far from the anchor, pick the coordinate sheet of the torus which moves it closer.
46072e17dfb7SMatthew G. Knepley 
46082e17dfb7SMatthew G. Knepley   Input Parameters:
46092e17dfb7SMatthew G. Knepley + dm     - The DM
46102e17dfb7SMatthew G. Knepley . dim    - The spatial dimension
46112e17dfb7SMatthew G. Knepley . anchor - The anchor point, the input point can be no more than maxCell away from it
46122e17dfb7SMatthew G. Knepley . in     - The input coordinate delta (dim numbers)
46132e17dfb7SMatthew G. Knepley - out    - The input coordinate point (dim numbers)
46142e17dfb7SMatthew G. Knepley 
46152e17dfb7SMatthew G. Knepley   Output Parameter:
46162e17dfb7SMatthew G. Knepley . out    - The localized coordinate in + out
46172e17dfb7SMatthew G. Knepley 
46182e17dfb7SMatthew G. Knepley   Level: developer
46192e17dfb7SMatthew G. Knepley 
46202e17dfb7SMatthew G. Knepley   Note: This is meant to get a set of coordinates close to each other, as in a cell. The anchor is usually the one of the vertices on a containing cell
46212e17dfb7SMatthew G. Knepley 
46222e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeCoordinate()
46232e17dfb7SMatthew G. Knepley */
46242e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeAddCoordinate_Internal(DM dm, PetscInt dim, const PetscScalar anchor[], const PetscScalar in[], PetscScalar out[])
46252e17dfb7SMatthew G. Knepley {
46262e17dfb7SMatthew G. Knepley   PetscInt d;
46272e17dfb7SMatthew G. Knepley 
46282e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
46292e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
46302e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] += in[d];
46312e17dfb7SMatthew G. Knepley   } else {
46322e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) {
46332e17dfb7SMatthew G. Knepley       if (PetscAbsScalar(anchor[d] - in[d]) > dm->maxCell[d]) {
46342e17dfb7SMatthew G. Knepley         out[d] += PetscRealPart(anchor[d]) > PetscRealPart(in[d]) ? dm->L[d] + in[d] : in[d] - dm->L[d];
46352e17dfb7SMatthew G. Knepley       } else {
46362e17dfb7SMatthew G. Knepley         out[d] += in[d];
46372e17dfb7SMatthew G. Knepley       }
46382e17dfb7SMatthew G. Knepley     }
46392e17dfb7SMatthew G. Knepley   }
46402e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
46412e17dfb7SMatthew G. Knepley }
46422e17dfb7SMatthew G. Knepley 
46432e17dfb7SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMPlexGetDepthStratum(DM, PetscInt, PetscInt *, PetscInt *);
46442e17dfb7SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMPlexGetHeightStratum(DM, PetscInt, PetscInt *, PetscInt *);
46452e17dfb7SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMPlexVecGetClosure(DM, PetscSection, Vec, PetscInt, PetscInt *, PetscScalar *[]);
46462e17dfb7SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMPlexVecRestoreClosure(DM, PetscSection, Vec, PetscInt, PetscInt *, PetscScalar *[]);
46472e17dfb7SMatthew G. Knepley 
46482e17dfb7SMatthew G. Knepley #undef __FUNCT__
464936447a5eSToby Isaac #define __FUNCT__ "DMGetCoordinatesLocalized"
465036447a5eSToby Isaac /*@
465136447a5eSToby Isaac   DMGetCoordinatesLocalized - Check if the DM coordinates have been localized for cells
465236447a5eSToby Isaac 
465336447a5eSToby Isaac   Input Parameter:
465436447a5eSToby Isaac . dm - The DM
465536447a5eSToby Isaac 
465636447a5eSToby Isaac   Output Parameter:
465736447a5eSToby Isaac   areLocalized - True if localized
465836447a5eSToby Isaac 
465936447a5eSToby Isaac   Level: developer
466036447a5eSToby Isaac 
466136447a5eSToby Isaac .seealso: DMLocalizeCoordinates()
466236447a5eSToby Isaac @*/
466336447a5eSToby Isaac PetscErrorCode DMGetCoordinatesLocalized(DM dm,PetscBool *areLocalized)
466436447a5eSToby Isaac {
466536447a5eSToby Isaac   DM             cdm;
466636447a5eSToby Isaac   PetscSection   coordSection;
466736447a5eSToby Isaac   PetscInt       cStart, cEnd, c, sStart, sEnd, dof;
466836447a5eSToby Isaac   PetscBool      alreadyLocalized, alreadyLocalizedGlobal;
466936447a5eSToby Isaac   PetscErrorCode ierr;
467036447a5eSToby Isaac 
467136447a5eSToby Isaac   PetscFunctionBegin;
467236447a5eSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
46738b09590cSToby Isaac   if (!dm->maxCell) {
46748b09590cSToby Isaac     *areLocalized = PETSC_FALSE;
46758b09590cSToby Isaac     PetscFunctionReturn(0);
46768b09590cSToby Isaac   }
467736447a5eSToby Isaac   /* We need some generic way of refering to cells/vertices */
467836447a5eSToby Isaac   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
467936447a5eSToby Isaac   {
468036447a5eSToby Isaac     PetscBool isplex;
468136447a5eSToby Isaac 
468236447a5eSToby Isaac     ierr = PetscObjectTypeCompare((PetscObject) cdm, DMPLEX, &isplex);CHKERRQ(ierr);
468336447a5eSToby Isaac     if (isplex) {
468436447a5eSToby Isaac       ierr = DMPlexGetHeightStratum(cdm, 0, &cStart, &cEnd);CHKERRQ(ierr);
468536447a5eSToby Isaac     } else SETERRQ(PetscObjectComm((PetscObject) cdm), PETSC_ERR_ARG_WRONG, "Coordinate localization requires a DMPLEX coordinate DM");
468636447a5eSToby Isaac   }
468736447a5eSToby Isaac   ierr = DMGetCoordinateSection(dm, &coordSection);CHKERRQ(ierr);
468836447a5eSToby Isaac   ierr = PetscSectionGetChart(coordSection,&sStart,&sEnd);CHKERRQ(ierr);
468936447a5eSToby Isaac   alreadyLocalized = alreadyLocalizedGlobal = PETSC_TRUE;
469036447a5eSToby Isaac   for (c = cStart; c < cEnd; ++c) {
469136447a5eSToby Isaac     if (c < sStart || c >= sEnd) {
469236447a5eSToby Isaac       alreadyLocalized = PETSC_FALSE;
469336447a5eSToby Isaac       break;
469436447a5eSToby Isaac     }
469536447a5eSToby Isaac     ierr = PetscSectionGetDof(coordSection, c, &dof);CHKERRQ(ierr);
469636447a5eSToby Isaac     if (!dof) {
469736447a5eSToby Isaac       alreadyLocalized = PETSC_FALSE;
469836447a5eSToby Isaac       break;
469936447a5eSToby Isaac     }
470036447a5eSToby Isaac   }
470136447a5eSToby Isaac   ierr = MPI_Allreduce(&alreadyLocalized,&alreadyLocalizedGlobal,1,MPIU_BOOL,MPI_LAND,PetscObjectComm((PetscObject)dm));CHKERRQ(ierr);
470236447a5eSToby Isaac   *areLocalized = alreadyLocalizedGlobal;
470336447a5eSToby Isaac   PetscFunctionReturn(0);
470436447a5eSToby Isaac }
470536447a5eSToby Isaac 
470636447a5eSToby Isaac 
470736447a5eSToby Isaac #undef __FUNCT__
47082e17dfb7SMatthew G. Knepley #define __FUNCT__ "DMLocalizeCoordinates"
47092e17dfb7SMatthew G. Knepley /*@
47102e17dfb7SMatthew G. Knepley   DMLocalizeCoordinates - If a mesh is periodic, create local coordinates for each cell
47112e17dfb7SMatthew G. Knepley 
47122e17dfb7SMatthew G. Knepley   Input Parameter:
47132e17dfb7SMatthew G. Knepley . dm - The DM
47142e17dfb7SMatthew G. Knepley 
47152e17dfb7SMatthew G. Knepley   Level: developer
47162e17dfb7SMatthew G. Knepley 
47172e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinate(), DMLocalizeAddCoordinate()
47182e17dfb7SMatthew G. Knepley @*/
47192e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinates(DM dm)
47202e17dfb7SMatthew G. Knepley {
47212e17dfb7SMatthew G. Knepley   DM             cdm;
47222e17dfb7SMatthew G. Knepley   PetscSection   coordSection, cSection;
47232e17dfb7SMatthew G. Knepley   Vec            coordinates,  cVec;
47242e17dfb7SMatthew G. Knepley   PetscScalar   *coords, *coords2, *anchor;
4725e0ae35bbSToby Isaac   PetscInt       Nc, cStart, cEnd, c, vStart, vEnd, v, sStart, sEnd, dof, d, off, off2, bs, coordSize;
4726e0ae35bbSToby Isaac   PetscBool      alreadyLocalized, alreadyLocalizedGlobal;
47272e17dfb7SMatthew G. Knepley   PetscErrorCode ierr;
47282e17dfb7SMatthew G. Knepley 
47292e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
47302e17dfb7SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
47312e17dfb7SMatthew G. Knepley   if (!dm->maxCell) PetscFunctionReturn(0);
47322e17dfb7SMatthew G. Knepley   /* We need some generic way of refering to cells/vertices */
47332e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
47342e17dfb7SMatthew G. Knepley   {
47352e17dfb7SMatthew G. Knepley     PetscBool isplex;
47362e17dfb7SMatthew G. Knepley 
47372e17dfb7SMatthew G. Knepley     ierr = PetscObjectTypeCompare((PetscObject) cdm, DMPLEX, &isplex);CHKERRQ(ierr);
47382e17dfb7SMatthew G. Knepley     if (isplex) {
47392e17dfb7SMatthew G. Knepley       ierr = DMPlexGetHeightStratum(cdm, 0, &cStart, &cEnd);CHKERRQ(ierr);
47402e17dfb7SMatthew G. Knepley       ierr = DMPlexGetDepthStratum(cdm, 0, &vStart, &vEnd);CHKERRQ(ierr);
47412e17dfb7SMatthew G. Knepley     } else SETERRQ(PetscObjectComm((PetscObject) cdm), PETSC_ERR_ARG_WRONG, "Coordinate localization requires a DMPLEX coordinate DM");
47422e17dfb7SMatthew G. Knepley   }
47432e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinatesLocal(dm, &coordinates);CHKERRQ(ierr);
47442e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinateSection(dm, &coordSection);CHKERRQ(ierr);
4745e0ae35bbSToby Isaac   ierr = PetscSectionGetChart(coordSection,&sStart,&sEnd);CHKERRQ(ierr);
4746e0ae35bbSToby Isaac   alreadyLocalized = alreadyLocalizedGlobal = PETSC_TRUE;
4747e0ae35bbSToby Isaac   for (c = cStart; c < cEnd; ++c) {
4748e0ae35bbSToby Isaac     if (c < sStart || c >= sEnd) {
4749e0ae35bbSToby Isaac       alreadyLocalized = PETSC_FALSE;
4750e0ae35bbSToby Isaac       break;
4751e0ae35bbSToby Isaac     }
4752e0ae35bbSToby Isaac     ierr = PetscSectionGetDof(coordSection, c, &dof);CHKERRQ(ierr);
4753e0ae35bbSToby Isaac     if (!dof) {
4754e0ae35bbSToby Isaac       alreadyLocalized = PETSC_FALSE;
4755e0ae35bbSToby Isaac       break;
4756e0ae35bbSToby Isaac     }
4757e0ae35bbSToby Isaac   }
4758e0ae35bbSToby Isaac   ierr = MPI_Allreduce(&alreadyLocalized,&alreadyLocalizedGlobal,1,MPIU_BOOL,MPI_LAND,PetscObjectComm((PetscObject)dm));CHKERRQ(ierr);
4759e0ae35bbSToby Isaac   if (alreadyLocalizedGlobal) PetscFunctionReturn(0);
47602e17dfb7SMatthew G. Knepley   ierr = PetscSectionCreate(PetscObjectComm((PetscObject) dm), &cSection);CHKERRQ(ierr);
47612e17dfb7SMatthew G. Knepley   ierr = PetscSectionSetNumFields(cSection, 1);CHKERRQ(ierr);
47622e17dfb7SMatthew G. Knepley   ierr = PetscSectionGetFieldComponents(coordSection, 0, &Nc);CHKERRQ(ierr);
47632e17dfb7SMatthew G. Knepley   ierr = PetscSectionSetFieldComponents(cSection, 0, Nc);CHKERRQ(ierr);
47642e17dfb7SMatthew G. Knepley   ierr = PetscSectionSetChart(cSection, cStart, vEnd);CHKERRQ(ierr);
47652e17dfb7SMatthew G. Knepley   for (v = vStart; v < vEnd; ++v) {
47662e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetDof(coordSection, v, &dof);CHKERRQ(ierr);
47672e17dfb7SMatthew G. Knepley     ierr = PetscSectionSetDof(cSection,     v,  dof);CHKERRQ(ierr);
47682e17dfb7SMatthew G. Knepley     ierr = PetscSectionSetFieldDof(cSection, v, 0, dof);CHKERRQ(ierr);
47692e17dfb7SMatthew G. Knepley   }
47702e17dfb7SMatthew G. Knepley   for (c = cStart; c < cEnd; ++c) {
47712e17dfb7SMatthew G. Knepley     ierr = DMPlexVecGetClosure(cdm, coordSection, coordinates, c, &dof, NULL);CHKERRQ(ierr);
47722e17dfb7SMatthew G. Knepley     ierr = PetscSectionSetDof(cSection, c, dof);CHKERRQ(ierr);
47732e17dfb7SMatthew G. Knepley     ierr = PetscSectionSetFieldDof(cSection, c, 0, dof);CHKERRQ(ierr);
47742e17dfb7SMatthew G. Knepley   }
47752e17dfb7SMatthew G. Knepley   ierr = PetscSectionSetUp(cSection);CHKERRQ(ierr);
47762e17dfb7SMatthew G. Knepley   ierr = PetscSectionGetStorageSize(cSection, &coordSize);CHKERRQ(ierr);
4777c2be7e5eSLisandro Dalcin   ierr = VecCreate(PETSC_COMM_SELF, &cVec);CHKERRQ(ierr);
47782e17dfb7SMatthew G. Knepley   ierr = PetscObjectSetName((PetscObject)cVec,"coordinates");CHKERRQ(ierr);
47792e17dfb7SMatthew G. Knepley   ierr = VecGetBlockSize(coordinates, &bs);CHKERRQ(ierr);
47802e17dfb7SMatthew G. Knepley   ierr = VecSetBlockSize(cVec,         bs);CHKERRQ(ierr);
47812e17dfb7SMatthew G. Knepley   ierr = VecSetSizes(cVec, coordSize, PETSC_DETERMINE);CHKERRQ(ierr);
47822e17dfb7SMatthew G. Knepley   ierr = VecSetType(cVec, VECSTANDARD);CHKERRQ(ierr);
4783c2be7e5eSLisandro Dalcin   ierr = VecGetArrayRead(coordinates, (const PetscScalar**)&coords);CHKERRQ(ierr);
47842e17dfb7SMatthew G. Knepley   ierr = VecGetArray(cVec, &coords2);CHKERRQ(ierr);
47852e17dfb7SMatthew G. Knepley   for (v = vStart; v < vEnd; ++v) {
47862e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetDof(coordSection, v, &dof);CHKERRQ(ierr);
47872e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetOffset(coordSection, v, &off);CHKERRQ(ierr);
47882e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetOffset(cSection,     v, &off2);CHKERRQ(ierr);
47892e17dfb7SMatthew G. Knepley     for (d = 0; d < dof; ++d) coords2[off2+d] = coords[off+d];
47902e17dfb7SMatthew G. Knepley   }
47912e17dfb7SMatthew G. Knepley   ierr = DMGetWorkArray(dm, 3, PETSC_SCALAR, &anchor);CHKERRQ(ierr);
47922e17dfb7SMatthew G. Knepley   for (c = cStart; c < cEnd; ++c) {
47932e17dfb7SMatthew G. Knepley     PetscScalar *cellCoords = NULL;
47942e17dfb7SMatthew G. Knepley     PetscInt     b;
47952e17dfb7SMatthew G. Knepley 
47962e17dfb7SMatthew G. Knepley     ierr = DMPlexVecGetClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
47972e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetOffset(cSection, c, &off2);CHKERRQ(ierr);
47982e17dfb7SMatthew G. Knepley     for (b = 0; b < bs; ++b) anchor[b] = cellCoords[b];
47992e17dfb7SMatthew G. Knepley     for (d = 0; d < dof/bs; ++d) {ierr = DMLocalizeCoordinate_Internal(dm, bs, anchor, &cellCoords[d*bs], &coords2[off2+d*bs]);CHKERRQ(ierr);}
48002e17dfb7SMatthew G. Knepley     ierr = DMPlexVecRestoreClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
48012e17dfb7SMatthew G. Knepley   }
48022e17dfb7SMatthew G. Knepley   ierr = DMRestoreWorkArray(dm, 3, PETSC_SCALAR, &anchor);CHKERRQ(ierr);
4803c2be7e5eSLisandro Dalcin   ierr = VecRestoreArrayRead(coordinates, (const PetscScalar**)&coords);CHKERRQ(ierr);
48042e17dfb7SMatthew G. Knepley   ierr = VecRestoreArray(cVec, &coords2);CHKERRQ(ierr);
48052e17dfb7SMatthew G. Knepley   ierr = DMSetCoordinateSection(dm, PETSC_DETERMINE, cSection);CHKERRQ(ierr);
48062e17dfb7SMatthew G. Knepley   ierr = DMSetCoordinatesLocal(dm, cVec);CHKERRQ(ierr);
48072e17dfb7SMatthew G. Knepley   ierr = VecDestroy(&cVec);CHKERRQ(ierr);
48082e17dfb7SMatthew G. Knepley   ierr = PetscSectionDestroy(&cSection);CHKERRQ(ierr);
48092e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
48102e17dfb7SMatthew G. Knepley }
48112e17dfb7SMatthew G. Knepley 
48122e17dfb7SMatthew G. Knepley #undef __FUNCT__
4813e87bb0d3SMatthew G Knepley #define __FUNCT__ "DMLocatePoints"
4814e87bb0d3SMatthew G Knepley /*@
48153a93e3b7SToby Isaac   DMLocatePoints - Locate the points in v in the mesh and return a PetscSF of the containing cells
4816e87bb0d3SMatthew G Knepley 
48173a93e3b7SToby Isaac   Collective on Vec v (see explanation below)
4818e87bb0d3SMatthew G Knepley 
4819e87bb0d3SMatthew G Knepley   Input Parameters:
4820e87bb0d3SMatthew G Knepley + dm - The DM
48213a93e3b7SToby Isaac . v - The Vec of points
48223a93e3b7SToby Isaac - cells - Points to either NULL, or a PetscSF with guesses for which cells contain each point.
4823e87bb0d3SMatthew G Knepley 
482461e3bb9bSMatthew G Knepley   Output Parameter:
48253a93e3b7SToby Isaac . cells - The PetscSF containing the ranks and local indices of the containing points.
48263a93e3b7SToby Isaac 
4827e87bb0d3SMatthew G Knepley 
4828e87bb0d3SMatthew G Knepley   Level: developer
482961e3bb9bSMatthew G Knepley 
48303a93e3b7SToby Isaac   To do a search of the local cells of the mesh, v should have PETSC_COMM_SELF as its communicator.
48313a93e3b7SToby Isaac 
48323a93e3b7SToby Isaac   To do a search of all the cells in the distributed mesh, v should have the same communicator as
48333a93e3b7SToby Isaac   dm.
48343a93e3b7SToby Isaac 
48353a93e3b7SToby Isaac   If *cellSF is NULL on input, a PetscSF will be created.
48363a93e3b7SToby Isaac 
48373a93e3b7SToby Isaac   If *cellSF is not NULL on input, it should point to an existing PetscSF, whose graph will be used as initial
48383a93e3b7SToby Isaac   guesses.
48393a93e3b7SToby Isaac 
48403a93e3b7SToby Isaac   An array that maps each point to its containing cell can be obtained with
48413a93e3b7SToby Isaac 
48423a93e3b7SToby Isaac     const PetscSFNode *cells;
48433a93e3b7SToby Isaac     PetscInt           nFound;
48443a93e3b7SToby Isaac     const PetscSFNode *found;
48453a93e3b7SToby Isaac 
48463a93e3b7SToby Isaac     PetscSFGetGraph(cells,NULL,&nFound,&found,&cells);
48473a93e3b7SToby Isaac 
48483a93e3b7SToby Isaac   Where cells[i].rank is the rank of the cell containing point found[i] (or i if found == NULL), and cells[i].index is
48493a93e3b7SToby Isaac   the index of the cell in its rank's local numbering.
48503a93e3b7SToby Isaac 
485161e3bb9bSMatthew G Knepley .keywords: point location, mesh
485261e3bb9bSMatthew G Knepley .seealso: DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal()
485361e3bb9bSMatthew G Knepley @*/
48543a93e3b7SToby Isaac PetscErrorCode DMLocatePoints(DM dm, Vec v, PetscSF *cellSF)
4855e87bb0d3SMatthew G Knepley {
4856735aa83eSMatthew G Knepley   PetscErrorCode ierr;
4857735aa83eSMatthew G Knepley 
4858e87bb0d3SMatthew G Knepley   PetscFunctionBegin;
4859e87bb0d3SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
4860e87bb0d3SMatthew G Knepley   PetscValidHeaderSpecific(v,VEC_CLASSID,2);
48613a93e3b7SToby Isaac   PetscValidPointer(cellSF,3);
48623a93e3b7SToby Isaac   if (*cellSF) {
48633a93e3b7SToby Isaac     PetscMPIInt result;
48643a93e3b7SToby Isaac 
48653a93e3b7SToby Isaac     PetscValidHeaderSpecific(cellSF,PETSCSF_CLASSID,3);
48663a93e3b7SToby Isaac     ierr = MPI_Comm_compare(PetscObjectComm((PetscObject)v),PetscObjectComm((PetscObject)cellSF),&result);CHKERRQ(ierr);
48673a93e3b7SToby Isaac     if (result != MPI_IDENT && result != MPI_CONGRUENT) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_INCOMP,"cellSF must have a communicator congruent to v's");
48683a93e3b7SToby Isaac   }
48693a93e3b7SToby Isaac   else {
48703a93e3b7SToby Isaac     ierr = PetscSFCreate(PetscObjectComm((PetscObject)v),cellSF);CHKERRQ(ierr);
48713a93e3b7SToby Isaac   }
487247a35634SPatrick Farrell   ierr = PetscLogEventBegin(DM_LocatePoints,dm,0,0,0);CHKERRQ(ierr);
4873735aa83eSMatthew G Knepley   if (dm->ops->locatepoints) {
48743a93e3b7SToby Isaac     ierr = (*dm->ops->locatepoints)(dm,v,*cellSF);CHKERRQ(ierr);
487582f516ccSBarry Smith   } else SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Point location not available for this DM");
487647a35634SPatrick Farrell   ierr = PetscLogEventEnd(DM_LocatePoints,dm,0,0,0);CHKERRQ(ierr);
4877e87bb0d3SMatthew G Knepley   PetscFunctionReturn(0);
4878e87bb0d3SMatthew G Knepley }
487914f150ffSMatthew G. Knepley 
488014f150ffSMatthew G. Knepley #undef __FUNCT__
488114f150ffSMatthew G. Knepley #define __FUNCT__ "DMGetOutputDM"
4882f4d763aaSMatthew G. Knepley /*@
4883f4d763aaSMatthew G. Knepley   DMGetOutputDM - Retrieve the DM associated with the layout for output
4884f4d763aaSMatthew G. Knepley 
4885f4d763aaSMatthew G. Knepley   Input Parameter:
4886f4d763aaSMatthew G. Knepley . dm - The original DM
4887f4d763aaSMatthew G. Knepley 
4888f4d763aaSMatthew G. Knepley   Output Parameter:
4889f4d763aaSMatthew G. Knepley . odm - The DM which provides the layout for output
4890f4d763aaSMatthew G. Knepley 
4891f4d763aaSMatthew G. Knepley   Level: intermediate
4892f4d763aaSMatthew G. Knepley 
4893f4d763aaSMatthew G. Knepley .seealso: VecView(), DMGetDefaultGlobalSection()
4894f4d763aaSMatthew G. Knepley @*/
489514f150ffSMatthew G. Knepley PetscErrorCode DMGetOutputDM(DM dm, DM *odm)
489614f150ffSMatthew G. Knepley {
4897c26acbdeSMatthew G. Knepley   PetscSection   section;
4898c26acbdeSMatthew G. Knepley   PetscBool      hasConstraints;
489914f150ffSMatthew G. Knepley   PetscErrorCode ierr;
490014f150ffSMatthew G. Knepley 
490114f150ffSMatthew G. Knepley   PetscFunctionBegin;
490214f150ffSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
490314f150ffSMatthew G. Knepley   PetscValidPointer(odm,2);
4904c26acbdeSMatthew G. Knepley   ierr = DMGetDefaultSection(dm, &section);CHKERRQ(ierr);
4905c26acbdeSMatthew G. Knepley   ierr = PetscSectionHasConstraints(section, &hasConstraints);CHKERRQ(ierr);
4906c26acbdeSMatthew G. Knepley   if (!hasConstraints) {
4907c26acbdeSMatthew G. Knepley     *odm = dm;
4908c26acbdeSMatthew G. Knepley     PetscFunctionReturn(0);
4909c26acbdeSMatthew G. Knepley   }
491014f150ffSMatthew G. Knepley   if (!dm->dmBC) {
49110305aff6SMatthew G. Knepley     PetscDS      ds;
4912c26acbdeSMatthew G. Knepley     PetscSection newSection, gsection;
491314f150ffSMatthew G. Knepley     PetscSF      sf;
491414f150ffSMatthew G. Knepley 
491514f150ffSMatthew G. Knepley     ierr = DMClone(dm, &dm->dmBC);CHKERRQ(ierr);
49160305aff6SMatthew G. Knepley     ierr = DMGetDS(dm, &ds);CHKERRQ(ierr);
49170305aff6SMatthew G. Knepley     ierr = DMSetDS(dm->dmBC, ds);CHKERRQ(ierr);
491814f150ffSMatthew G. Knepley     ierr = PetscSectionClone(section, &newSection);CHKERRQ(ierr);
491914f150ffSMatthew G. Knepley     ierr = DMSetDefaultSection(dm->dmBC, newSection);CHKERRQ(ierr);
492014f150ffSMatthew G. Knepley     ierr = PetscSectionDestroy(&newSection);CHKERRQ(ierr);
492114f150ffSMatthew G. Knepley     ierr = DMGetPointSF(dm->dmBC, &sf);CHKERRQ(ierr);
492215b58121SMatthew G. Knepley     ierr = PetscSectionCreateGlobalSection(section, sf, PETSC_TRUE, PETSC_FALSE, &gsection);CHKERRQ(ierr);
492314f150ffSMatthew G. Knepley     ierr = DMSetDefaultGlobalSection(dm->dmBC, gsection);CHKERRQ(ierr);
492414f150ffSMatthew G. Knepley     ierr = PetscSectionDestroy(&gsection);CHKERRQ(ierr);
492514f150ffSMatthew G. Knepley   }
492614f150ffSMatthew G. Knepley   *odm = dm->dmBC;
492714f150ffSMatthew G. Knepley   PetscFunctionReturn(0);
492814f150ffSMatthew G. Knepley }
4929f4d763aaSMatthew G. Knepley 
4930f4d763aaSMatthew G. Knepley #undef __FUNCT__
4931f4d763aaSMatthew G. Knepley #define __FUNCT__ "DMGetOutputSequenceNumber"
4932f4d763aaSMatthew G. Knepley /*@
4933cdb7a50dSMatthew G. Knepley   DMGetOutputSequenceNumber - Retrieve the sequence number/value for output
4934f4d763aaSMatthew G. Knepley 
4935f4d763aaSMatthew G. Knepley   Input Parameter:
4936f4d763aaSMatthew G. Knepley . dm - The original DM
4937f4d763aaSMatthew G. Knepley 
4938cdb7a50dSMatthew G. Knepley   Output Parameters:
4939cdb7a50dSMatthew G. Knepley + num - The output sequence number
4940cdb7a50dSMatthew G. Knepley - val - The output sequence value
4941f4d763aaSMatthew G. Knepley 
4942f4d763aaSMatthew G. Knepley   Level: intermediate
4943f4d763aaSMatthew G. Knepley 
4944f4d763aaSMatthew G. Knepley   Note: This is intended for output that should appear in sequence, for instance
4945f4d763aaSMatthew G. Knepley   a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system.
4946f4d763aaSMatthew G. Knepley 
4947f4d763aaSMatthew G. Knepley .seealso: VecView()
4948f4d763aaSMatthew G. Knepley @*/
4949cdb7a50dSMatthew G. Knepley PetscErrorCode DMGetOutputSequenceNumber(DM dm, PetscInt *num, PetscReal *val)
4950f4d763aaSMatthew G. Knepley {
4951f4d763aaSMatthew G. Knepley   PetscFunctionBegin;
4952f4d763aaSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
4953cdb7a50dSMatthew G. Knepley   if (num) {PetscValidPointer(num,2); *num = dm->outputSequenceNum;}
4954cdb7a50dSMatthew G. Knepley   if (val) {PetscValidPointer(val,3);*val = dm->outputSequenceVal;}
4955f4d763aaSMatthew G. Knepley   PetscFunctionReturn(0);
4956f4d763aaSMatthew G. Knepley }
4957f4d763aaSMatthew G. Knepley 
4958f4d763aaSMatthew G. Knepley #undef __FUNCT__
4959f4d763aaSMatthew G. Knepley #define __FUNCT__ "DMSetOutputSequenceNumber"
4960f4d763aaSMatthew G. Knepley /*@
4961cdb7a50dSMatthew G. Knepley   DMSetOutputSequenceNumber - Set the sequence number/value for output
4962f4d763aaSMatthew G. Knepley 
4963f4d763aaSMatthew G. Knepley   Input Parameters:
4964f4d763aaSMatthew G. Knepley + dm - The original DM
4965cdb7a50dSMatthew G. Knepley . num - The output sequence number
4966cdb7a50dSMatthew G. Knepley - val - The output sequence value
4967f4d763aaSMatthew G. Knepley 
4968f4d763aaSMatthew G. Knepley   Level: intermediate
4969f4d763aaSMatthew G. Knepley 
4970f4d763aaSMatthew G. Knepley   Note: This is intended for output that should appear in sequence, for instance
4971f4d763aaSMatthew G. Knepley   a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system.
4972f4d763aaSMatthew G. Knepley 
4973f4d763aaSMatthew G. Knepley .seealso: VecView()
4974f4d763aaSMatthew G. Knepley @*/
4975cdb7a50dSMatthew G. Knepley PetscErrorCode DMSetOutputSequenceNumber(DM dm, PetscInt num, PetscReal val)
4976f4d763aaSMatthew G. Knepley {
4977f4d763aaSMatthew G. Knepley   PetscFunctionBegin;
4978f4d763aaSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
4979f4d763aaSMatthew G. Knepley   dm->outputSequenceNum = num;
4980cdb7a50dSMatthew G. Knepley   dm->outputSequenceVal = val;
4981cdb7a50dSMatthew G. Knepley   PetscFunctionReturn(0);
4982cdb7a50dSMatthew G. Knepley }
4983cdb7a50dSMatthew G. Knepley 
4984cdb7a50dSMatthew G. Knepley #undef __FUNCT__
4985cdb7a50dSMatthew G. Knepley #define __FUNCT__ "DMOutputSequenceLoad"
4986cdb7a50dSMatthew G. Knepley /*@C
4987cdb7a50dSMatthew G. Knepley   DMOutputSequenceLoad - Retrieve the sequence value from a Viewer
4988cdb7a50dSMatthew G. Knepley 
4989cdb7a50dSMatthew G. Knepley   Input Parameters:
4990cdb7a50dSMatthew G. Knepley + dm   - The original DM
4991cdb7a50dSMatthew G. Knepley . name - The sequence name
4992cdb7a50dSMatthew G. Knepley - num  - The output sequence number
4993cdb7a50dSMatthew G. Knepley 
4994cdb7a50dSMatthew G. Knepley   Output Parameter:
4995cdb7a50dSMatthew G. Knepley . val  - The output sequence value
4996cdb7a50dSMatthew G. Knepley 
4997cdb7a50dSMatthew G. Knepley   Level: intermediate
4998cdb7a50dSMatthew G. Knepley 
4999cdb7a50dSMatthew G. Knepley   Note: This is intended for output that should appear in sequence, for instance
5000cdb7a50dSMatthew G. Knepley   a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system.
5001cdb7a50dSMatthew G. Knepley 
5002cdb7a50dSMatthew G. Knepley .seealso: DMGetOutputSequenceNumber(), DMSetOutputSequenceNumber(), VecView()
5003cdb7a50dSMatthew G. Knepley @*/
5004cdb7a50dSMatthew G. Knepley PetscErrorCode DMOutputSequenceLoad(DM dm, PetscViewer viewer, const char *name, PetscInt num, PetscReal *val)
5005cdb7a50dSMatthew G. Knepley {
5006cdb7a50dSMatthew G. Knepley   PetscBool      ishdf5;
5007cdb7a50dSMatthew G. Knepley   PetscErrorCode ierr;
5008cdb7a50dSMatthew G. Knepley 
5009cdb7a50dSMatthew G. Knepley   PetscFunctionBegin;
5010cdb7a50dSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
5011cdb7a50dSMatthew G. Knepley   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
5012cdb7a50dSMatthew G. Knepley   PetscValidPointer(val,4);
5013cdb7a50dSMatthew G. Knepley   ierr = PetscObjectTypeCompare((PetscObject) viewer, PETSCVIEWERHDF5, &ishdf5);CHKERRQ(ierr);
5014cdb7a50dSMatthew G. Knepley   if (ishdf5) {
5015cdb7a50dSMatthew G. Knepley #if defined(PETSC_HAVE_HDF5)
5016cdb7a50dSMatthew G. Knepley     PetscScalar value;
5017cdb7a50dSMatthew G. Knepley 
5018cdb7a50dSMatthew G. Knepley     ierr = DMSequenceLoad_HDF5(dm, name, num, &value, viewer);CHKERRQ(ierr);
50194aeb217fSMatthew G. Knepley     *val = PetscRealPart(value);
5020cdb7a50dSMatthew G. Knepley #endif
5021cdb7a50dSMatthew G. Knepley   } else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Invalid viewer; open viewer with PetscViewerHDF5Open()");
5022f4d763aaSMatthew G. Knepley   PetscFunctionReturn(0);
5023f4d763aaSMatthew G. Knepley }
50248e4ac7eaSMatthew G. Knepley 
50258e4ac7eaSMatthew G. Knepley #undef __FUNCT__
50268e4ac7eaSMatthew G. Knepley #define __FUNCT__ "DMGetUseNatural"
50278e4ac7eaSMatthew G. Knepley /*@
50288e4ac7eaSMatthew G. Knepley   DMGetUseNatural - Get the flag for creating a mapping to the natural order on distribution
50298e4ac7eaSMatthew G. Knepley 
50308e4ac7eaSMatthew G. Knepley   Not collective
50318e4ac7eaSMatthew G. Knepley 
50328e4ac7eaSMatthew G. Knepley   Input Parameter:
50338e4ac7eaSMatthew G. Knepley . dm - The DM
50348e4ac7eaSMatthew G. Knepley 
50358e4ac7eaSMatthew G. Knepley   Output Parameter:
50368e4ac7eaSMatthew G. Knepley . useNatural - The flag to build the mapping to a natural order during distribution
50378e4ac7eaSMatthew G. Knepley 
50388e4ac7eaSMatthew G. Knepley   Level: beginner
50398e4ac7eaSMatthew G. Knepley 
50408e4ac7eaSMatthew G. Knepley .seealso: DMSetUseNatural(), DMCreate()
50418e4ac7eaSMatthew G. Knepley @*/
50428e4ac7eaSMatthew G. Knepley PetscErrorCode DMGetUseNatural(DM dm, PetscBool *useNatural)
50438e4ac7eaSMatthew G. Knepley {
50448e4ac7eaSMatthew G. Knepley   PetscFunctionBegin;
50458e4ac7eaSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
50468e4ac7eaSMatthew G. Knepley   PetscValidPointer(useNatural, 2);
50478e4ac7eaSMatthew G. Knepley   *useNatural = dm->useNatural;
50488e4ac7eaSMatthew G. Knepley   PetscFunctionReturn(0);
50498e4ac7eaSMatthew G. Knepley }
50508e4ac7eaSMatthew G. Knepley 
50518e4ac7eaSMatthew G. Knepley #undef __FUNCT__
50528e4ac7eaSMatthew G. Knepley #define __FUNCT__ "DMSetUseNatural"
50538e4ac7eaSMatthew G. Knepley /*@
50548e4ac7eaSMatthew G. Knepley   DMSetUseNatural - Set the flag for creating a mapping to the natural order on distribution
50558e4ac7eaSMatthew G. Knepley 
50568e4ac7eaSMatthew G. Knepley   Collective on dm
50578e4ac7eaSMatthew G. Knepley 
50588e4ac7eaSMatthew G. Knepley   Input Parameters:
50598e4ac7eaSMatthew G. Knepley + dm - The DM
50608e4ac7eaSMatthew G. Knepley - useNatural - The flag to build the mapping to a natural order during distribution
50618e4ac7eaSMatthew G. Knepley 
50628e4ac7eaSMatthew G. Knepley   Level: beginner
50638e4ac7eaSMatthew G. Knepley 
50648e4ac7eaSMatthew G. Knepley .seealso: DMGetUseNatural(), DMCreate()
50658e4ac7eaSMatthew G. Knepley @*/
50668e4ac7eaSMatthew G. Knepley PetscErrorCode DMSetUseNatural(DM dm, PetscBool useNatural)
50678e4ac7eaSMatthew G. Knepley {
50688e4ac7eaSMatthew G. Knepley   PetscFunctionBegin;
50698e4ac7eaSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
50708e4ac7eaSMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, useNatural, 2);
50718e4ac7eaSMatthew G. Knepley   dm->useNatural = useNatural;
50728e4ac7eaSMatthew G. Knepley   PetscFunctionReturn(0);
50738e4ac7eaSMatthew G. Knepley }
5074c58f1c22SToby Isaac 
5075c58f1c22SToby Isaac #undef __FUNCT__
5076c58f1c22SToby Isaac #define __FUNCT__
5077c58f1c22SToby Isaac 
5078c58f1c22SToby Isaac #undef __FUNCT__
5079c58f1c22SToby Isaac #define __FUNCT__ "DMCreateLabel"
5080c58f1c22SToby Isaac /*@C
5081c58f1c22SToby Isaac   DMCreateLabel - Create a label of the given name if it does not already exist
5082c58f1c22SToby Isaac 
5083c58f1c22SToby Isaac   Not Collective
5084c58f1c22SToby Isaac 
5085c58f1c22SToby Isaac   Input Parameters:
5086c58f1c22SToby Isaac + dm   - The DM object
5087c58f1c22SToby Isaac - name - The label name
5088c58f1c22SToby Isaac 
5089c58f1c22SToby Isaac   Level: intermediate
5090c58f1c22SToby Isaac 
5091c58f1c22SToby Isaac .keywords: mesh
5092c58f1c22SToby Isaac .seealso: DMLabelCreate(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
5093c58f1c22SToby Isaac @*/
5094c58f1c22SToby Isaac PetscErrorCode DMCreateLabel(DM dm, const char name[])
5095c58f1c22SToby Isaac {
5096c58f1c22SToby Isaac   DMLabelLink    next  = dm->labels->next;
5097c58f1c22SToby Isaac   PetscBool      flg   = PETSC_FALSE;
5098c58f1c22SToby Isaac   PetscErrorCode ierr;
5099c58f1c22SToby Isaac 
5100c58f1c22SToby Isaac   PetscFunctionBegin;
5101c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5102c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
5103c58f1c22SToby Isaac   while (next) {
5104c58f1c22SToby Isaac     ierr = PetscStrcmp(name, next->label->name, &flg);CHKERRQ(ierr);
5105c58f1c22SToby Isaac     if (flg) break;
5106c58f1c22SToby Isaac     next = next->next;
5107c58f1c22SToby Isaac   }
5108c58f1c22SToby Isaac   if (!flg) {
5109c58f1c22SToby Isaac     DMLabelLink tmpLabel;
5110c58f1c22SToby Isaac 
5111c58f1c22SToby Isaac     ierr = PetscCalloc1(1, &tmpLabel);CHKERRQ(ierr);
5112c58f1c22SToby Isaac     ierr = DMLabelCreate(name, &tmpLabel->label);CHKERRQ(ierr);
5113c58f1c22SToby Isaac     tmpLabel->output = PETSC_TRUE;
5114c58f1c22SToby Isaac     tmpLabel->next   = dm->labels->next;
5115c58f1c22SToby Isaac     dm->labels->next = tmpLabel;
5116c58f1c22SToby Isaac   }
5117c58f1c22SToby Isaac   PetscFunctionReturn(0);
5118c58f1c22SToby Isaac }
5119c58f1c22SToby Isaac 
5120c58f1c22SToby Isaac #undef __FUNCT__
5121c58f1c22SToby Isaac #define __FUNCT__ "DMGetLabelValue"
5122c58f1c22SToby Isaac /*@C
5123c58f1c22SToby Isaac   DMGetLabelValue - Get the value in a Sieve Label for the given point, with 0 as the default
5124c58f1c22SToby Isaac 
5125c58f1c22SToby Isaac   Not Collective
5126c58f1c22SToby Isaac 
5127c58f1c22SToby Isaac   Input Parameters:
5128c58f1c22SToby Isaac + dm   - The DM object
5129c58f1c22SToby Isaac . name - The label name
5130c58f1c22SToby Isaac - point - The mesh point
5131c58f1c22SToby Isaac 
5132c58f1c22SToby Isaac   Output Parameter:
5133c58f1c22SToby Isaac . value - The label value for this point, or -1 if the point is not in the label
5134c58f1c22SToby Isaac 
5135c58f1c22SToby Isaac   Level: beginner
5136c58f1c22SToby Isaac 
5137c58f1c22SToby Isaac .keywords: mesh
5138c58f1c22SToby Isaac .seealso: DMLabelGetValue(), DMSetLabelValue(), DMGetStratumIS()
5139c58f1c22SToby Isaac @*/
5140c58f1c22SToby Isaac PetscErrorCode DMGetLabelValue(DM dm, const char name[], PetscInt point, PetscInt *value)
5141c58f1c22SToby Isaac {
5142c58f1c22SToby Isaac   DMLabel        label;
5143c58f1c22SToby Isaac   PetscErrorCode ierr;
5144c58f1c22SToby Isaac 
5145c58f1c22SToby Isaac   PetscFunctionBegin;
5146c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5147c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
5148c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
5149c58f1c22SToby Isaac   if (!label) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "No label named %s was found", name);CHKERRQ(ierr);
5150c58f1c22SToby Isaac   ierr = DMLabelGetValue(label, point, value);CHKERRQ(ierr);
5151c58f1c22SToby Isaac   PetscFunctionReturn(0);
5152c58f1c22SToby Isaac }
5153c58f1c22SToby Isaac 
5154c58f1c22SToby Isaac #undef __FUNCT__
5155c58f1c22SToby Isaac #define __FUNCT__ "DMSetLabelValue"
5156c58f1c22SToby Isaac /*@C
5157c58f1c22SToby Isaac   DMSetLabelValue - Add a point to a Sieve Label with given value
5158c58f1c22SToby Isaac 
5159c58f1c22SToby Isaac   Not Collective
5160c58f1c22SToby Isaac 
5161c58f1c22SToby Isaac   Input Parameters:
5162c58f1c22SToby Isaac + dm   - The DM object
5163c58f1c22SToby Isaac . name - The label name
5164c58f1c22SToby Isaac . point - The mesh point
5165c58f1c22SToby Isaac - value - The label value for this point
5166c58f1c22SToby Isaac 
5167c58f1c22SToby Isaac   Output Parameter:
5168c58f1c22SToby Isaac 
5169c58f1c22SToby Isaac   Level: beginner
5170c58f1c22SToby Isaac 
5171c58f1c22SToby Isaac .keywords: mesh
5172c58f1c22SToby Isaac .seealso: DMLabelSetValue(), DMGetStratumIS(), DMClearLabelValue()
5173c58f1c22SToby Isaac @*/
5174c58f1c22SToby Isaac PetscErrorCode DMSetLabelValue(DM dm, const char name[], PetscInt point, PetscInt value)
5175c58f1c22SToby Isaac {
5176c58f1c22SToby Isaac   DMLabel        label;
5177c58f1c22SToby Isaac   PetscErrorCode ierr;
5178c58f1c22SToby Isaac 
5179c58f1c22SToby Isaac   PetscFunctionBegin;
5180c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5181c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
5182c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
5183c58f1c22SToby Isaac   if (!label) {
5184c58f1c22SToby Isaac     ierr = DMCreateLabel(dm, name);CHKERRQ(ierr);
5185c58f1c22SToby Isaac     ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
5186c58f1c22SToby Isaac   }
5187c58f1c22SToby Isaac   ierr = DMLabelSetValue(label, point, value);CHKERRQ(ierr);
5188c58f1c22SToby Isaac   PetscFunctionReturn(0);
5189c58f1c22SToby Isaac }
5190c58f1c22SToby Isaac 
5191c58f1c22SToby Isaac #undef __FUNCT__
5192c58f1c22SToby Isaac #define __FUNCT__ "DMClearLabelValue"
5193c58f1c22SToby Isaac /*@C
5194c58f1c22SToby Isaac   DMClearLabelValue - Remove a point from a Sieve Label with given value
5195c58f1c22SToby Isaac 
5196c58f1c22SToby Isaac   Not Collective
5197c58f1c22SToby Isaac 
5198c58f1c22SToby Isaac   Input Parameters:
5199c58f1c22SToby Isaac + dm   - The DM object
5200c58f1c22SToby Isaac . name - The label name
5201c58f1c22SToby Isaac . point - The mesh point
5202c58f1c22SToby Isaac - value - The label value for this point
5203c58f1c22SToby Isaac 
5204c58f1c22SToby Isaac   Output Parameter:
5205c58f1c22SToby Isaac 
5206c58f1c22SToby Isaac   Level: beginner
5207c58f1c22SToby Isaac 
5208c58f1c22SToby Isaac .keywords: mesh
5209c58f1c22SToby Isaac .seealso: DMLabelClearValue(), DMSetLabelValue(), DMGetStratumIS()
5210c58f1c22SToby Isaac @*/
5211c58f1c22SToby Isaac PetscErrorCode DMClearLabelValue(DM dm, const char name[], PetscInt point, PetscInt value)
5212c58f1c22SToby Isaac {
5213c58f1c22SToby Isaac   DMLabel        label;
5214c58f1c22SToby Isaac   PetscErrorCode ierr;
5215c58f1c22SToby Isaac 
5216c58f1c22SToby Isaac   PetscFunctionBegin;
5217c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5218c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
5219c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
5220c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
5221c58f1c22SToby Isaac   ierr = DMLabelClearValue(label, point, value);CHKERRQ(ierr);
5222c58f1c22SToby Isaac   PetscFunctionReturn(0);
5223c58f1c22SToby Isaac }
5224c58f1c22SToby Isaac 
5225c58f1c22SToby Isaac #undef __FUNCT__
5226c58f1c22SToby Isaac #define __FUNCT__ "DMGetLabelSize"
5227c58f1c22SToby Isaac /*@C
5228c58f1c22SToby Isaac   DMGetLabelSize - Get the number of different integer ids in a Label
5229c58f1c22SToby Isaac 
5230c58f1c22SToby Isaac   Not Collective
5231c58f1c22SToby Isaac 
5232c58f1c22SToby Isaac   Input Parameters:
5233c58f1c22SToby Isaac + dm   - The DM object
5234c58f1c22SToby Isaac - name - The label name
5235c58f1c22SToby Isaac 
5236c58f1c22SToby Isaac   Output Parameter:
5237c58f1c22SToby Isaac . size - The number of different integer ids, or 0 if the label does not exist
5238c58f1c22SToby Isaac 
5239c58f1c22SToby Isaac   Level: beginner
5240c58f1c22SToby Isaac 
5241c58f1c22SToby Isaac .keywords: mesh
5242c58f1c22SToby Isaac .seealso: DMLabeGetNumValues(), DMSetLabelValue()
5243c58f1c22SToby Isaac @*/
5244c58f1c22SToby Isaac PetscErrorCode DMGetLabelSize(DM dm, const char name[], PetscInt *size)
5245c58f1c22SToby Isaac {
5246c58f1c22SToby Isaac   DMLabel        label;
5247c58f1c22SToby Isaac   PetscErrorCode ierr;
5248c58f1c22SToby Isaac 
5249c58f1c22SToby Isaac   PetscFunctionBegin;
5250c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5251c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
5252c58f1c22SToby Isaac   PetscValidPointer(size, 3);
5253c58f1c22SToby Isaac   ierr  = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
5254c58f1c22SToby Isaac   *size = 0;
5255c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
5256c58f1c22SToby Isaac   ierr = DMLabelGetNumValues(label, size);CHKERRQ(ierr);
5257c58f1c22SToby Isaac   PetscFunctionReturn(0);
5258c58f1c22SToby Isaac }
5259c58f1c22SToby Isaac 
5260c58f1c22SToby Isaac #undef __FUNCT__
5261c58f1c22SToby Isaac #define __FUNCT__ "DMGetLabelIdIS"
5262c58f1c22SToby Isaac /*@C
5263c58f1c22SToby Isaac   DMGetLabelIdIS - Get the integer ids in a label
5264c58f1c22SToby Isaac 
5265c58f1c22SToby Isaac   Not Collective
5266c58f1c22SToby Isaac 
5267c58f1c22SToby Isaac   Input Parameters:
5268c58f1c22SToby Isaac + mesh - The DM object
5269c58f1c22SToby Isaac - name - The label name
5270c58f1c22SToby Isaac 
5271c58f1c22SToby Isaac   Output Parameter:
5272c58f1c22SToby Isaac . ids - The integer ids, or NULL if the label does not exist
5273c58f1c22SToby Isaac 
5274c58f1c22SToby Isaac   Level: beginner
5275c58f1c22SToby Isaac 
5276c58f1c22SToby Isaac .keywords: mesh
5277c58f1c22SToby Isaac .seealso: DMLabelGetValueIS(), DMGetLabelSize()
5278c58f1c22SToby Isaac @*/
5279c58f1c22SToby Isaac PetscErrorCode DMGetLabelIdIS(DM dm, const char name[], IS *ids)
5280c58f1c22SToby Isaac {
5281c58f1c22SToby Isaac   DMLabel        label;
5282c58f1c22SToby Isaac   PetscErrorCode ierr;
5283c58f1c22SToby Isaac 
5284c58f1c22SToby Isaac   PetscFunctionBegin;
5285c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5286c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
5287c58f1c22SToby Isaac   PetscValidPointer(ids, 3);
5288c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
5289c58f1c22SToby Isaac   *ids = NULL;
5290c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
5291c58f1c22SToby Isaac   ierr = DMLabelGetValueIS(label, ids);CHKERRQ(ierr);
5292c58f1c22SToby Isaac   PetscFunctionReturn(0);
5293c58f1c22SToby Isaac }
5294c58f1c22SToby Isaac 
5295c58f1c22SToby Isaac #undef __FUNCT__
5296c58f1c22SToby Isaac #define __FUNCT__ "DMGetStratumSize"
5297c58f1c22SToby Isaac /*@C
5298c58f1c22SToby Isaac   DMGetStratumSize - Get the number of points in a label stratum
5299c58f1c22SToby Isaac 
5300c58f1c22SToby Isaac   Not Collective
5301c58f1c22SToby Isaac 
5302c58f1c22SToby Isaac   Input Parameters:
5303c58f1c22SToby Isaac + dm - The DM object
5304c58f1c22SToby Isaac . name - The label name
5305c58f1c22SToby Isaac - value - The stratum value
5306c58f1c22SToby Isaac 
5307c58f1c22SToby Isaac   Output Parameter:
5308c58f1c22SToby Isaac . size - The stratum size
5309c58f1c22SToby Isaac 
5310c58f1c22SToby Isaac   Level: beginner
5311c58f1c22SToby Isaac 
5312c58f1c22SToby Isaac .keywords: mesh
5313c58f1c22SToby Isaac .seealso: DMLabelGetStratumSize(), DMGetLabelSize(), DMGetLabelIds()
5314c58f1c22SToby Isaac @*/
5315c58f1c22SToby Isaac PetscErrorCode DMGetStratumSize(DM dm, const char name[], PetscInt value, PetscInt *size)
5316c58f1c22SToby Isaac {
5317c58f1c22SToby Isaac   DMLabel        label;
5318c58f1c22SToby Isaac   PetscErrorCode ierr;
5319c58f1c22SToby Isaac 
5320c58f1c22SToby Isaac   PetscFunctionBegin;
5321c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5322c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
5323c58f1c22SToby Isaac   PetscValidPointer(size, 4);
5324c58f1c22SToby Isaac   ierr  = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
5325c58f1c22SToby Isaac   *size = 0;
5326c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
5327c58f1c22SToby Isaac   ierr = DMLabelGetStratumSize(label, value, size);CHKERRQ(ierr);
5328c58f1c22SToby Isaac   PetscFunctionReturn(0);
5329c58f1c22SToby Isaac }
5330c58f1c22SToby Isaac 
5331c58f1c22SToby Isaac #undef __FUNCT__
5332c58f1c22SToby Isaac #define __FUNCT__ "DMGetStratumIS"
5333c58f1c22SToby Isaac /*@C
5334c58f1c22SToby Isaac   DMGetStratumIS - Get the points in a label stratum
5335c58f1c22SToby Isaac 
5336c58f1c22SToby Isaac   Not Collective
5337c58f1c22SToby Isaac 
5338c58f1c22SToby Isaac   Input Parameters:
5339c58f1c22SToby Isaac + dm - The DM object
5340c58f1c22SToby Isaac . name - The label name
5341c58f1c22SToby Isaac - value - The stratum value
5342c58f1c22SToby Isaac 
5343c58f1c22SToby Isaac   Output Parameter:
5344c58f1c22SToby Isaac . points - The stratum points, or NULL if the label does not exist or does not have that value
5345c58f1c22SToby Isaac 
5346c58f1c22SToby Isaac   Level: beginner
5347c58f1c22SToby Isaac 
5348c58f1c22SToby Isaac .keywords: mesh
5349c58f1c22SToby Isaac .seealso: DMLabelGetStratumIS(), DMGetStratumSize()
5350c58f1c22SToby Isaac @*/
5351c58f1c22SToby Isaac PetscErrorCode DMGetStratumIS(DM dm, const char name[], PetscInt value, IS *points)
5352c58f1c22SToby Isaac {
5353c58f1c22SToby Isaac   DMLabel        label;
5354c58f1c22SToby Isaac   PetscErrorCode ierr;
5355c58f1c22SToby Isaac 
5356c58f1c22SToby Isaac   PetscFunctionBegin;
5357c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5358c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
5359c58f1c22SToby Isaac   PetscValidPointer(points, 4);
5360c58f1c22SToby Isaac   ierr    = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
5361c58f1c22SToby Isaac   *points = NULL;
5362c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
5363c58f1c22SToby Isaac   ierr = DMLabelGetStratumIS(label, value, points);CHKERRQ(ierr);
5364c58f1c22SToby Isaac   PetscFunctionReturn(0);
5365c58f1c22SToby Isaac }
5366c58f1c22SToby Isaac 
5367c58f1c22SToby Isaac #undef __FUNCT__
5368c58f1c22SToby Isaac #define __FUNCT__ "DMClearLabelStratum"
5369c58f1c22SToby Isaac /*@C
5370c58f1c22SToby Isaac   DMClearLabelStratum - Remove all points from a stratum from a Sieve Label
5371c58f1c22SToby Isaac 
5372c58f1c22SToby Isaac   Not Collective
5373c58f1c22SToby Isaac 
5374c58f1c22SToby Isaac   Input Parameters:
5375c58f1c22SToby Isaac + dm   - The DM object
5376c58f1c22SToby Isaac . name - The label name
5377c58f1c22SToby Isaac - value - The label value for this point
5378c58f1c22SToby Isaac 
5379c58f1c22SToby Isaac   Output Parameter:
5380c58f1c22SToby Isaac 
5381c58f1c22SToby Isaac   Level: beginner
5382c58f1c22SToby Isaac 
5383c58f1c22SToby Isaac .keywords: mesh
5384c58f1c22SToby Isaac .seealso: DMLabelClearStratum(), DMSetLabelValue(), DMGetStratumIS(), DMClearLabelValue()
5385c58f1c22SToby Isaac @*/
5386c58f1c22SToby Isaac PetscErrorCode DMClearLabelStratum(DM dm, const char name[], PetscInt value)
5387c58f1c22SToby Isaac {
5388c58f1c22SToby Isaac   DMLabel        label;
5389c58f1c22SToby Isaac   PetscErrorCode ierr;
5390c58f1c22SToby Isaac 
5391c58f1c22SToby Isaac   PetscFunctionBegin;
5392c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5393c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
5394c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
5395c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
5396c58f1c22SToby Isaac   ierr = DMLabelClearStratum(label, value);CHKERRQ(ierr);
5397c58f1c22SToby Isaac   PetscFunctionReturn(0);
5398c58f1c22SToby Isaac }
5399c58f1c22SToby Isaac 
5400c58f1c22SToby Isaac #undef __FUNCT__
5401c58f1c22SToby Isaac #define __FUNCT__ "DMGetNumLabels"
5402c58f1c22SToby Isaac /*@
5403c58f1c22SToby Isaac   DMGetNumLabels - Return the number of labels defined by the mesh
5404c58f1c22SToby Isaac 
5405c58f1c22SToby Isaac   Not Collective
5406c58f1c22SToby Isaac 
5407c58f1c22SToby Isaac   Input Parameter:
5408c58f1c22SToby Isaac . dm   - The DM object
5409c58f1c22SToby Isaac 
5410c58f1c22SToby Isaac   Output Parameter:
5411c58f1c22SToby Isaac . numLabels - the number of Labels
5412c58f1c22SToby Isaac 
5413c58f1c22SToby Isaac   Level: intermediate
5414c58f1c22SToby Isaac 
5415c58f1c22SToby Isaac .keywords: mesh
5416c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
5417c58f1c22SToby Isaac @*/
5418c58f1c22SToby Isaac PetscErrorCode DMGetNumLabels(DM dm, PetscInt *numLabels)
5419c58f1c22SToby Isaac {
5420c58f1c22SToby Isaac   DMLabelLink next = dm->labels->next;
5421c58f1c22SToby Isaac   PetscInt  n    = 0;
5422c58f1c22SToby Isaac 
5423c58f1c22SToby Isaac   PetscFunctionBegin;
5424c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5425c58f1c22SToby Isaac   PetscValidPointer(numLabels, 2);
5426c58f1c22SToby Isaac   while (next) {++n; next = next->next;}
5427c58f1c22SToby Isaac   *numLabels = n;
5428c58f1c22SToby Isaac   PetscFunctionReturn(0);
5429c58f1c22SToby Isaac }
5430c58f1c22SToby Isaac 
5431c58f1c22SToby Isaac #undef __FUNCT__
5432c58f1c22SToby Isaac #define __FUNCT__ "DMGetLabelName"
5433c58f1c22SToby Isaac /*@C
5434c58f1c22SToby Isaac   DMGetLabelName - Return the name of nth label
5435c58f1c22SToby Isaac 
5436c58f1c22SToby Isaac   Not Collective
5437c58f1c22SToby Isaac 
5438c58f1c22SToby Isaac   Input Parameters:
5439c58f1c22SToby Isaac + dm - The DM object
5440c58f1c22SToby Isaac - n  - the label number
5441c58f1c22SToby Isaac 
5442c58f1c22SToby Isaac   Output Parameter:
5443c58f1c22SToby Isaac . name - the label name
5444c58f1c22SToby Isaac 
5445c58f1c22SToby Isaac   Level: intermediate
5446c58f1c22SToby Isaac 
5447c58f1c22SToby Isaac .keywords: mesh
5448c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
5449c58f1c22SToby Isaac @*/
5450c58f1c22SToby Isaac PetscErrorCode DMGetLabelName(DM dm, PetscInt n, const char **name)
5451c58f1c22SToby Isaac {
5452c58f1c22SToby Isaac   DMLabelLink next = dm->labels->next;
5453c58f1c22SToby Isaac   PetscInt  l    = 0;
5454c58f1c22SToby Isaac 
5455c58f1c22SToby Isaac   PetscFunctionBegin;
5456c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5457c58f1c22SToby Isaac   PetscValidPointer(name, 3);
5458c58f1c22SToby Isaac   while (next) {
5459c58f1c22SToby Isaac     if (l == n) {
5460c58f1c22SToby Isaac       *name = next->label->name;
5461c58f1c22SToby Isaac       PetscFunctionReturn(0);
5462c58f1c22SToby Isaac     }
5463c58f1c22SToby Isaac     ++l;
5464c58f1c22SToby Isaac     next = next->next;
5465c58f1c22SToby Isaac   }
5466c58f1c22SToby Isaac   SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %D does not exist in this DM", n);
5467c58f1c22SToby Isaac }
5468c58f1c22SToby Isaac 
5469c58f1c22SToby Isaac #undef __FUNCT__
5470c58f1c22SToby Isaac #define __FUNCT__ "DMHasLabel"
5471c58f1c22SToby Isaac /*@C
5472c58f1c22SToby Isaac   DMHasLabel - Determine whether the mesh has a label of a given name
5473c58f1c22SToby Isaac 
5474c58f1c22SToby Isaac   Not Collective
5475c58f1c22SToby Isaac 
5476c58f1c22SToby Isaac   Input Parameters:
5477c58f1c22SToby Isaac + dm   - The DM object
5478c58f1c22SToby Isaac - name - The label name
5479c58f1c22SToby Isaac 
5480c58f1c22SToby Isaac   Output Parameter:
5481c58f1c22SToby Isaac . hasLabel - PETSC_TRUE if the label is present
5482c58f1c22SToby Isaac 
5483c58f1c22SToby Isaac   Level: intermediate
5484c58f1c22SToby Isaac 
5485c58f1c22SToby Isaac .keywords: mesh
5486c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
5487c58f1c22SToby Isaac @*/
5488c58f1c22SToby Isaac PetscErrorCode DMHasLabel(DM dm, const char name[], PetscBool *hasLabel)
5489c58f1c22SToby Isaac {
5490c58f1c22SToby Isaac   DMLabelLink    next = dm->labels->next;
5491c58f1c22SToby Isaac   PetscErrorCode ierr;
5492c58f1c22SToby Isaac 
5493c58f1c22SToby Isaac   PetscFunctionBegin;
5494c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5495c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
5496c58f1c22SToby Isaac   PetscValidPointer(hasLabel, 3);
5497c58f1c22SToby Isaac   *hasLabel = PETSC_FALSE;
5498c58f1c22SToby Isaac   while (next) {
5499c58f1c22SToby Isaac     ierr = PetscStrcmp(name, next->label->name, hasLabel);CHKERRQ(ierr);
5500c58f1c22SToby Isaac     if (*hasLabel) break;
5501c58f1c22SToby Isaac     next = next->next;
5502c58f1c22SToby Isaac   }
5503c58f1c22SToby Isaac   PetscFunctionReturn(0);
5504c58f1c22SToby Isaac }
5505c58f1c22SToby Isaac 
5506c58f1c22SToby Isaac #undef __FUNCT__
5507c58f1c22SToby Isaac #define __FUNCT__ "DMGetLabel"
5508c58f1c22SToby Isaac /*@C
5509c58f1c22SToby Isaac   DMGetLabel - Return the label of a given name, or NULL
5510c58f1c22SToby Isaac 
5511c58f1c22SToby Isaac   Not Collective
5512c58f1c22SToby Isaac 
5513c58f1c22SToby Isaac   Input Parameters:
5514c58f1c22SToby Isaac + dm   - The DM object
5515c58f1c22SToby Isaac - name - The label name
5516c58f1c22SToby Isaac 
5517c58f1c22SToby Isaac   Output Parameter:
5518c58f1c22SToby Isaac . label - The DMLabel, or NULL if the label is absent
5519c58f1c22SToby Isaac 
5520c58f1c22SToby Isaac   Level: intermediate
5521c58f1c22SToby Isaac 
5522c58f1c22SToby Isaac .keywords: mesh
5523c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
5524c58f1c22SToby Isaac @*/
5525c58f1c22SToby Isaac PetscErrorCode DMGetLabel(DM dm, const char name[], DMLabel *label)
5526c58f1c22SToby Isaac {
5527c58f1c22SToby Isaac   DMLabelLink    next = dm->labels->next;
5528c58f1c22SToby Isaac   PetscBool      hasLabel;
5529c58f1c22SToby Isaac   PetscErrorCode ierr;
5530c58f1c22SToby Isaac 
5531c58f1c22SToby Isaac   PetscFunctionBegin;
5532c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5533c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
5534c58f1c22SToby Isaac   PetscValidPointer(label, 3);
5535c58f1c22SToby Isaac   *label = NULL;
5536c58f1c22SToby Isaac   while (next) {
5537c58f1c22SToby Isaac     ierr = PetscStrcmp(name, next->label->name, &hasLabel);CHKERRQ(ierr);
5538c58f1c22SToby Isaac     if (hasLabel) {
5539c58f1c22SToby Isaac       *label = next->label;
5540c58f1c22SToby Isaac       break;
5541c58f1c22SToby Isaac     }
5542c58f1c22SToby Isaac     next = next->next;
5543c58f1c22SToby Isaac   }
5544c58f1c22SToby Isaac   PetscFunctionReturn(0);
5545c58f1c22SToby Isaac }
5546c58f1c22SToby Isaac 
5547c58f1c22SToby Isaac #undef __FUNCT__
5548c58f1c22SToby Isaac #define __FUNCT__ "DMGetLabelByNum"
5549c58f1c22SToby Isaac /*@C
5550c58f1c22SToby Isaac   DMGetLabelByNum - Return the nth label
5551c58f1c22SToby Isaac 
5552c58f1c22SToby Isaac   Not Collective
5553c58f1c22SToby Isaac 
5554c58f1c22SToby Isaac   Input Parameters:
5555c58f1c22SToby Isaac + dm - The DM object
5556c58f1c22SToby Isaac - n  - the label number
5557c58f1c22SToby Isaac 
5558c58f1c22SToby Isaac   Output Parameter:
5559c58f1c22SToby Isaac . label - the label
5560c58f1c22SToby Isaac 
5561c58f1c22SToby Isaac   Level: intermediate
5562c58f1c22SToby Isaac 
5563c58f1c22SToby Isaac .keywords: mesh
5564c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
5565c58f1c22SToby Isaac @*/
5566c58f1c22SToby Isaac PetscErrorCode DMGetLabelByNum(DM dm, PetscInt n, DMLabel *label)
5567c58f1c22SToby Isaac {
5568c58f1c22SToby Isaac   DMLabelLink next = dm->labels->next;
5569c58f1c22SToby Isaac   PetscInt    l    = 0;
5570c58f1c22SToby Isaac 
5571c58f1c22SToby Isaac   PetscFunctionBegin;
5572c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5573c58f1c22SToby Isaac   PetscValidPointer(label, 3);
5574c58f1c22SToby Isaac   while (next) {
5575c58f1c22SToby Isaac     if (l == n) {
5576c58f1c22SToby Isaac       *label = next->label;
5577c58f1c22SToby Isaac       PetscFunctionReturn(0);
5578c58f1c22SToby Isaac     }
5579c58f1c22SToby Isaac     ++l;
5580c58f1c22SToby Isaac     next = next->next;
5581c58f1c22SToby Isaac   }
5582c58f1c22SToby Isaac   SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %D does not exist in this DM", n);
5583c58f1c22SToby Isaac }
5584c58f1c22SToby Isaac 
5585c58f1c22SToby Isaac #undef __FUNCT__
5586c58f1c22SToby Isaac #define __FUNCT__ "DMAddLabel"
5587c58f1c22SToby Isaac /*@C
5588c58f1c22SToby Isaac   DMAddLabel - Add the label to this mesh
5589c58f1c22SToby Isaac 
5590c58f1c22SToby Isaac   Not Collective
5591c58f1c22SToby Isaac 
5592c58f1c22SToby Isaac   Input Parameters:
5593c58f1c22SToby Isaac + dm   - The DM object
5594c58f1c22SToby Isaac - label - The DMLabel
5595c58f1c22SToby Isaac 
5596c58f1c22SToby Isaac   Level: developer
5597c58f1c22SToby Isaac 
5598c58f1c22SToby Isaac .keywords: mesh
5599c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
5600c58f1c22SToby Isaac @*/
5601c58f1c22SToby Isaac PetscErrorCode DMAddLabel(DM dm, DMLabel label)
5602c58f1c22SToby Isaac {
5603c58f1c22SToby Isaac   DMLabelLink    tmpLabel;
5604c58f1c22SToby Isaac   PetscBool      hasLabel;
5605c58f1c22SToby Isaac   PetscErrorCode ierr;
5606c58f1c22SToby Isaac 
5607c58f1c22SToby Isaac   PetscFunctionBegin;
5608c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5609c58f1c22SToby Isaac   ierr = DMHasLabel(dm, label->name, &hasLabel);CHKERRQ(ierr);
5610c58f1c22SToby Isaac   if (hasLabel) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %s already exists in this DM", label->name);
5611c58f1c22SToby Isaac   ierr = PetscCalloc1(1, &tmpLabel);CHKERRQ(ierr);
5612c58f1c22SToby Isaac   tmpLabel->label  = label;
5613c58f1c22SToby Isaac   tmpLabel->output = PETSC_TRUE;
5614c58f1c22SToby Isaac   tmpLabel->next   = dm->labels->next;
5615c58f1c22SToby Isaac   dm->labels->next = tmpLabel;
5616c58f1c22SToby Isaac   PetscFunctionReturn(0);
5617c58f1c22SToby Isaac }
5618c58f1c22SToby Isaac 
5619c58f1c22SToby Isaac #undef __FUNCT__
5620c58f1c22SToby Isaac #define __FUNCT__ "DMRemoveLabel"
5621c58f1c22SToby Isaac /*@C
5622c58f1c22SToby Isaac   DMRemoveLabel - Remove the label from this mesh
5623c58f1c22SToby Isaac 
5624c58f1c22SToby Isaac   Not Collective
5625c58f1c22SToby Isaac 
5626c58f1c22SToby Isaac   Input Parameters:
5627c58f1c22SToby Isaac + dm   - The DM object
5628c58f1c22SToby Isaac - name - The label name
5629c58f1c22SToby Isaac 
5630c58f1c22SToby Isaac   Output Parameter:
5631c58f1c22SToby Isaac . label - The DMLabel, or NULL if the label is absent
5632c58f1c22SToby Isaac 
5633c58f1c22SToby Isaac   Level: developer
5634c58f1c22SToby Isaac 
5635c58f1c22SToby Isaac .keywords: mesh
5636c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
5637c58f1c22SToby Isaac @*/
5638c58f1c22SToby Isaac PetscErrorCode DMRemoveLabel(DM dm, const char name[], DMLabel *label)
5639c58f1c22SToby Isaac {
5640c58f1c22SToby Isaac   DMLabelLink    next = dm->labels->next;
5641c58f1c22SToby Isaac   DMLabelLink    last = NULL;
5642c58f1c22SToby Isaac   PetscBool      hasLabel;
5643c58f1c22SToby Isaac   PetscErrorCode ierr;
5644c58f1c22SToby Isaac 
5645c58f1c22SToby Isaac   PetscFunctionBegin;
5646c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5647c58f1c22SToby Isaac   ierr   = DMHasLabel(dm, name, &hasLabel);CHKERRQ(ierr);
5648c58f1c22SToby Isaac   *label = NULL;
5649c58f1c22SToby Isaac   if (!hasLabel) PetscFunctionReturn(0);
5650c58f1c22SToby Isaac   while (next) {
5651c58f1c22SToby Isaac     ierr = PetscStrcmp(name, next->label->name, &hasLabel);CHKERRQ(ierr);
5652c58f1c22SToby Isaac     if (hasLabel) {
5653c58f1c22SToby Isaac       if (last) last->next       = next->next;
5654c58f1c22SToby Isaac       else      dm->labels->next = next->next;
5655c58f1c22SToby Isaac       next->next = NULL;
5656c58f1c22SToby Isaac       *label     = next->label;
5657c58f1c22SToby Isaac       ierr = PetscStrcmp(name, "depth", &hasLabel);CHKERRQ(ierr);
5658c58f1c22SToby Isaac       if (hasLabel) {
5659c58f1c22SToby Isaac         dm->depthLabel = NULL;
5660c58f1c22SToby Isaac       }
5661c58f1c22SToby Isaac       ierr = PetscFree(next);CHKERRQ(ierr);
5662c58f1c22SToby Isaac       break;
5663c58f1c22SToby Isaac     }
5664c58f1c22SToby Isaac     last = next;
5665c58f1c22SToby Isaac     next = next->next;
5666c58f1c22SToby Isaac   }
5667c58f1c22SToby Isaac   PetscFunctionReturn(0);
5668c58f1c22SToby Isaac }
5669c58f1c22SToby Isaac 
5670c58f1c22SToby Isaac #undef __FUNCT__
5671c58f1c22SToby Isaac #define __FUNCT__ "DMGetLabelOutput"
5672c58f1c22SToby Isaac /*@C
5673c58f1c22SToby Isaac   DMGetLabelOutput - Get the output flag for a given label
5674c58f1c22SToby Isaac 
5675c58f1c22SToby Isaac   Not Collective
5676c58f1c22SToby Isaac 
5677c58f1c22SToby Isaac   Input Parameters:
5678c58f1c22SToby Isaac + dm   - The DM object
5679c58f1c22SToby Isaac - name - The label name
5680c58f1c22SToby Isaac 
5681c58f1c22SToby Isaac   Output Parameter:
5682c58f1c22SToby Isaac . output - The flag for output
5683c58f1c22SToby Isaac 
5684c58f1c22SToby Isaac   Level: developer
5685c58f1c22SToby Isaac 
5686c58f1c22SToby Isaac .keywords: mesh
5687c58f1c22SToby Isaac .seealso: DMSetLabelOutput(), DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
5688c58f1c22SToby Isaac @*/
5689c58f1c22SToby Isaac PetscErrorCode DMGetLabelOutput(DM dm, const char name[], PetscBool *output)
5690c58f1c22SToby Isaac {
5691c58f1c22SToby Isaac   DMLabelLink    next = dm->labels->next;
5692c58f1c22SToby Isaac   PetscErrorCode ierr;
5693c58f1c22SToby Isaac 
5694c58f1c22SToby Isaac   PetscFunctionBegin;
5695c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5696c58f1c22SToby Isaac   PetscValidPointer(name, 2);
5697c58f1c22SToby Isaac   PetscValidPointer(output, 3);
5698c58f1c22SToby Isaac   while (next) {
5699c58f1c22SToby Isaac     PetscBool flg;
5700c58f1c22SToby Isaac 
5701c58f1c22SToby Isaac     ierr = PetscStrcmp(name, next->label->name, &flg);CHKERRQ(ierr);
5702c58f1c22SToby Isaac     if (flg) {*output = next->output; PetscFunctionReturn(0);}
5703c58f1c22SToby Isaac     next = next->next;
5704c58f1c22SToby Isaac   }
5705c58f1c22SToby Isaac   SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "No label named %s was present in this dm", name);
5706c58f1c22SToby Isaac }
5707c58f1c22SToby Isaac 
5708c58f1c22SToby Isaac #undef __FUNCT__
5709c58f1c22SToby Isaac #define __FUNCT__ "DMSetLabelOutput"
5710c58f1c22SToby Isaac /*@C
5711c58f1c22SToby Isaac   DMSetLabelOutput - Set the output flag for a given label
5712c58f1c22SToby Isaac 
5713c58f1c22SToby Isaac   Not Collective
5714c58f1c22SToby Isaac 
5715c58f1c22SToby Isaac   Input Parameters:
5716c58f1c22SToby Isaac + dm     - The DM object
5717c58f1c22SToby Isaac . name   - The label name
5718c58f1c22SToby Isaac - output - The flag for output
5719c58f1c22SToby Isaac 
5720c58f1c22SToby Isaac   Level: developer
5721c58f1c22SToby Isaac 
5722c58f1c22SToby Isaac .keywords: mesh
5723c58f1c22SToby Isaac .seealso: DMGetLabelOutput(), DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
5724c58f1c22SToby Isaac @*/
5725c58f1c22SToby Isaac PetscErrorCode DMSetLabelOutput(DM dm, const char name[], PetscBool output)
5726c58f1c22SToby Isaac {
5727c58f1c22SToby Isaac   DMLabelLink    next = dm->labels->next;
5728c58f1c22SToby Isaac   PetscErrorCode ierr;
5729c58f1c22SToby Isaac 
5730c58f1c22SToby Isaac   PetscFunctionBegin;
5731c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5732c58f1c22SToby Isaac   PetscValidPointer(name, 2);
5733c58f1c22SToby Isaac   while (next) {
5734c58f1c22SToby Isaac     PetscBool flg;
5735c58f1c22SToby Isaac 
5736c58f1c22SToby Isaac     ierr = PetscStrcmp(name, next->label->name, &flg);CHKERRQ(ierr);
5737c58f1c22SToby Isaac     if (flg) {next->output = output; PetscFunctionReturn(0);}
5738c58f1c22SToby Isaac     next = next->next;
5739c58f1c22SToby Isaac   }
5740c58f1c22SToby Isaac   SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "No label named %s was present in this dm", name);
5741c58f1c22SToby Isaac }
5742c58f1c22SToby Isaac 
5743c58f1c22SToby Isaac 
5744c58f1c22SToby Isaac #undef __FUNCT__
5745c58f1c22SToby Isaac #define __FUNCT__ "DMCopyLabels"
5746c58f1c22SToby Isaac /*@
5747c58f1c22SToby Isaac   DMCopyLabels - Copy labels from one mesh to another with a superset of the points
5748c58f1c22SToby Isaac 
5749c58f1c22SToby Isaac   Collective on DM
5750c58f1c22SToby Isaac 
5751c58f1c22SToby Isaac   Input Parameter:
57522e17dfb7SMatthew G. Knepley . dmA - The DM object with initial labels
5753c58f1c22SToby Isaac 
5754c58f1c22SToby Isaac   Output Parameter:
57552e17dfb7SMatthew G. Knepley . dmB - The DM object with copied labels
5756c58f1c22SToby Isaac 
5757c58f1c22SToby Isaac   Level: intermediate
5758c58f1c22SToby Isaac 
5759c58f1c22SToby Isaac   Note: This is typically used when interpolating or otherwise adding to a mesh
5760c58f1c22SToby Isaac 
5761c58f1c22SToby Isaac .keywords: mesh
5762c58f1c22SToby Isaac .seealso: DMCopyCoordinates(), DMGetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM(), DMGetCoordinateSection()
5763c58f1c22SToby Isaac @*/
5764c58f1c22SToby Isaac PetscErrorCode DMCopyLabels(DM dmA, DM dmB)
5765c58f1c22SToby Isaac {
5766c58f1c22SToby Isaac   PetscInt       numLabels, l;
5767c58f1c22SToby Isaac   PetscErrorCode ierr;
5768c58f1c22SToby Isaac 
5769c58f1c22SToby Isaac   PetscFunctionBegin;
5770c58f1c22SToby Isaac   if (dmA == dmB) PetscFunctionReturn(0);
5771c58f1c22SToby Isaac   ierr = DMGetNumLabels(dmA, &numLabels);CHKERRQ(ierr);
5772c58f1c22SToby Isaac   for (l = 0; l < numLabels; ++l) {
5773c58f1c22SToby Isaac     DMLabel     label, labelNew;
5774c58f1c22SToby Isaac     const char *name;
5775c58f1c22SToby Isaac     PetscBool   flg;
5776c58f1c22SToby Isaac 
5777c58f1c22SToby Isaac     ierr = DMGetLabelName(dmA, l, &name);CHKERRQ(ierr);
5778c58f1c22SToby Isaac     ierr = PetscStrcmp(name, "depth", &flg);CHKERRQ(ierr);
5779c58f1c22SToby Isaac     if (flg) continue;
5780c58f1c22SToby Isaac     ierr = DMGetLabel(dmA, name, &label);CHKERRQ(ierr);
5781c58f1c22SToby Isaac     ierr = DMLabelDuplicate(label, &labelNew);CHKERRQ(ierr);
5782c58f1c22SToby Isaac     ierr = DMAddLabel(dmB, labelNew);CHKERRQ(ierr);
5783c58f1c22SToby Isaac   }
5784c58f1c22SToby Isaac   PetscFunctionReturn(0);
5785c58f1c22SToby Isaac }
5786a8fb8f29SToby Isaac 
5787a8fb8f29SToby Isaac #undef __FUNCT__
5788a8fb8f29SToby Isaac #define __FUNCT__ "DMGetCoarseDM"
5789a8fb8f29SToby Isaac /*@
5790a8fb8f29SToby Isaac   DMGetCoarseDM - Get the coarse mesh from which this was obtained by refinement
5791a8fb8f29SToby Isaac 
5792a8fb8f29SToby Isaac   Input Parameter:
5793a8fb8f29SToby Isaac . dm - The DM object
5794a8fb8f29SToby Isaac 
5795a8fb8f29SToby Isaac   Output Parameter:
5796a8fb8f29SToby Isaac . cdm - The coarse DM
5797a8fb8f29SToby Isaac 
5798a8fb8f29SToby Isaac   Level: intermediate
5799a8fb8f29SToby Isaac 
5800a8fb8f29SToby Isaac .seealso: DMSetCoarseDM()
5801a8fb8f29SToby Isaac @*/
5802a8fb8f29SToby Isaac PetscErrorCode DMGetCoarseDM(DM dm, DM *cdm)
5803a8fb8f29SToby Isaac {
5804a8fb8f29SToby Isaac   PetscFunctionBegin;
5805a8fb8f29SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5806a8fb8f29SToby Isaac   PetscValidPointer(cdm, 2);
5807a8fb8f29SToby Isaac   *cdm = dm->coarseMesh;
5808a8fb8f29SToby Isaac   PetscFunctionReturn(0);
5809a8fb8f29SToby Isaac }
5810a8fb8f29SToby Isaac 
5811a8fb8f29SToby Isaac #undef __FUNCT__
5812a8fb8f29SToby Isaac #define __FUNCT__ "DMSetCoarseDM"
5813a8fb8f29SToby Isaac /*@
5814a8fb8f29SToby Isaac   DMSetCoarseDM - Set the coarse mesh from which this was obtained by refinement
5815a8fb8f29SToby Isaac 
5816a8fb8f29SToby Isaac   Input Parameters:
5817a8fb8f29SToby Isaac + dm - The DM object
5818a8fb8f29SToby Isaac - cdm - The coarse DM
5819a8fb8f29SToby Isaac 
5820a8fb8f29SToby Isaac   Level: intermediate
5821a8fb8f29SToby Isaac 
5822a8fb8f29SToby Isaac .seealso: DMGetCoarseDM()
5823a8fb8f29SToby Isaac @*/
5824a8fb8f29SToby Isaac PetscErrorCode DMSetCoarseDM(DM dm, DM cdm)
5825a8fb8f29SToby Isaac {
5826a8fb8f29SToby Isaac   PetscErrorCode ierr;
5827a8fb8f29SToby Isaac 
5828a8fb8f29SToby Isaac   PetscFunctionBegin;
5829a8fb8f29SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5830a8fb8f29SToby Isaac   if (cdm) PetscValidHeaderSpecific(cdm, DM_CLASSID, 2);
5831a8fb8f29SToby Isaac   ierr = PetscObjectReference((PetscObject)cdm);CHKERRQ(ierr);
5832a8fb8f29SToby Isaac   ierr = DMDestroy(&dm->coarseMesh);CHKERRQ(ierr);
5833a8fb8f29SToby Isaac   dm->coarseMesh = cdm;
5834a8fb8f29SToby Isaac   PetscFunctionReturn(0);
5835a8fb8f29SToby Isaac }
5836a8fb8f29SToby Isaac 
583788bdff64SToby Isaac #undef __FUNCT__
583888bdff64SToby Isaac #define __FUNCT__ "DMGetFineDM"
583988bdff64SToby Isaac /*@
584088bdff64SToby Isaac   DMGetFineDM - Get the fine mesh from which this was obtained by refinement
584188bdff64SToby Isaac 
584288bdff64SToby Isaac   Input Parameter:
584388bdff64SToby Isaac . dm - The DM object
584488bdff64SToby Isaac 
584588bdff64SToby Isaac   Output Parameter:
584688bdff64SToby Isaac . fdm - The fine DM
584788bdff64SToby Isaac 
584888bdff64SToby Isaac   Level: intermediate
584988bdff64SToby Isaac 
585088bdff64SToby Isaac .seealso: DMSetFineDM()
585188bdff64SToby Isaac @*/
585288bdff64SToby Isaac PetscErrorCode DMGetFineDM(DM dm, DM *fdm)
585388bdff64SToby Isaac {
585488bdff64SToby Isaac   PetscFunctionBegin;
585588bdff64SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
585688bdff64SToby Isaac   PetscValidPointer(fdm, 2);
585788bdff64SToby Isaac   *fdm = dm->fineMesh;
585888bdff64SToby Isaac   PetscFunctionReturn(0);
585988bdff64SToby Isaac }
586088bdff64SToby Isaac 
586188bdff64SToby Isaac #undef __FUNCT__
586288bdff64SToby Isaac #define __FUNCT__ "DMSetFineDM"
586388bdff64SToby Isaac /*@
586488bdff64SToby Isaac   DMSetFineDM - Set the fine mesh from which this was obtained by refinement
586588bdff64SToby Isaac 
586688bdff64SToby Isaac   Input Parameters:
586788bdff64SToby Isaac + dm - The DM object
586888bdff64SToby Isaac - fdm - The fine DM
586988bdff64SToby Isaac 
587088bdff64SToby Isaac   Level: intermediate
587188bdff64SToby Isaac 
587288bdff64SToby Isaac .seealso: DMGetFineDM()
587388bdff64SToby Isaac @*/
587488bdff64SToby Isaac PetscErrorCode DMSetFineDM(DM dm, DM fdm)
587588bdff64SToby Isaac {
587688bdff64SToby Isaac   PetscErrorCode ierr;
587788bdff64SToby Isaac 
587888bdff64SToby Isaac   PetscFunctionBegin;
587988bdff64SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
588088bdff64SToby Isaac   if (fdm) PetscValidHeaderSpecific(fdm, DM_CLASSID, 2);
588188bdff64SToby Isaac   ierr = PetscObjectReference((PetscObject)fdm);CHKERRQ(ierr);
588288bdff64SToby Isaac   ierr = DMDestroy(&dm->fineMesh);CHKERRQ(ierr);
588388bdff64SToby Isaac   dm->fineMesh = fdm;
588488bdff64SToby Isaac   PetscFunctionReturn(0);
588588bdff64SToby Isaac }
588688bdff64SToby Isaac 
5887a6ba4734SToby Isaac /*=== DMBoundary code ===*/
5888a6ba4734SToby Isaac 
5889a6ba4734SToby Isaac #undef __FUNCT__
5890bcc5ffd9SToby Isaac #define __FUNCT__ "DMBoundaryDuplicate"
5891354557abSToby Isaac PetscErrorCode DMBoundaryDuplicate(DMBoundaryLinkList bd, DMBoundaryLinkList *boundary)
5892a6ba4734SToby Isaac {
5893bcc5ffd9SToby Isaac   DMBoundary     b = bd->next, b2, bold = NULL;
5894a6ba4734SToby Isaac   PetscErrorCode ierr;
5895a6ba4734SToby Isaac 
5896a6ba4734SToby Isaac   PetscFunctionBegin;
5897bcc5ffd9SToby Isaac   ierr = PetscNew(boundary);CHKERRQ(ierr);
5898bcc5ffd9SToby Isaac   (*boundary)->refct = 1;
5899bcc5ffd9SToby Isaac   (*boundary)->next = NULL;
5900a6ba4734SToby Isaac   for (; b; b = b->next, bold = b2) {
5901a6ba4734SToby Isaac     ierr = PetscNew(&b2);CHKERRQ(ierr);
5902a6ba4734SToby Isaac     ierr = PetscStrallocpy(b->name, (char **) &b2->name);CHKERRQ(ierr);
5903a6ba4734SToby Isaac     ierr = PetscStrallocpy(b->labelname, (char **) &b2->labelname);CHKERRQ(ierr);
5904a6ba4734SToby Isaac     ierr = PetscMalloc1(b->numids, &b2->ids);CHKERRQ(ierr);
5905a6ba4734SToby Isaac     ierr = PetscMemcpy(b2->ids, b->ids, b->numids*sizeof(PetscInt));CHKERRQ(ierr);
5906a6ba4734SToby Isaac     ierr = PetscMalloc1(b->numcomps, &b2->comps);CHKERRQ(ierr);
5907a6ba4734SToby Isaac     ierr = PetscMemcpy(b2->comps, b->comps, b->numcomps*sizeof(PetscInt));CHKERRQ(ierr);
5908a6ba4734SToby Isaac     b2->label     = NULL;
5909a6ba4734SToby Isaac     b2->essential = b->essential;
5910a6ba4734SToby Isaac     b2->field     = b->field;
5911a6ba4734SToby Isaac     b2->numcomps  = b->numcomps;
5912a6ba4734SToby Isaac     b2->func      = b->func;
5913a6ba4734SToby Isaac     b2->numids    = b->numids;
5914a6ba4734SToby Isaac     b2->ctx       = b->ctx;
5915a6ba4734SToby Isaac     b2->next      = NULL;
5916bcc5ffd9SToby Isaac     if (!(*boundary)->next) (*boundary)->next   = b2;
5917a6ba4734SToby Isaac     if (bold)        bold->next = b2;
5918a6ba4734SToby Isaac   }
5919a6ba4734SToby Isaac   PetscFunctionReturn(0);
5920a6ba4734SToby Isaac }
5921a6ba4734SToby Isaac 
5922a6ba4734SToby Isaac #undef __FUNCT__
5923bcc5ffd9SToby Isaac #define __FUNCT__ "DMBoundaryDestroy"
5924bcc5ffd9SToby Isaac PetscErrorCode DMBoundaryDestroy(DMBoundaryLinkList *boundary)
5925a6ba4734SToby Isaac {
5926a6ba4734SToby Isaac   DMBoundary     b, next;
5927a6ba4734SToby Isaac   PetscErrorCode ierr;
5928a6ba4734SToby Isaac 
5929a6ba4734SToby Isaac   PetscFunctionBegin;
5930a6ba4734SToby Isaac   if (!boundary) PetscFunctionReturn(0);
5931bcc5ffd9SToby Isaac   if (--((*boundary)->refct)) {
5932a6ba4734SToby Isaac     *boundary = NULL;
5933bcc5ffd9SToby Isaac     PetscFunctionReturn(0);
5934bcc5ffd9SToby Isaac   }
5935bcc5ffd9SToby Isaac   b = (*boundary)->next;
5936a6ba4734SToby Isaac   for (; b; b = next) {
5937a6ba4734SToby Isaac     next = b->next;
5938a6ba4734SToby Isaac     ierr = PetscFree(b->comps);CHKERRQ(ierr);
5939a6ba4734SToby Isaac     ierr = PetscFree(b->ids);CHKERRQ(ierr);
5940a6ba4734SToby Isaac     ierr = PetscFree(b->name);CHKERRQ(ierr);
5941a6ba4734SToby Isaac     ierr = PetscFree(b->labelname);CHKERRQ(ierr);
5942a6ba4734SToby Isaac     ierr = PetscFree(b);CHKERRQ(ierr);
5943a6ba4734SToby Isaac   }
5944bcc5ffd9SToby Isaac   ierr = PetscFree(*boundary);CHKERRQ(ierr);
5945a6ba4734SToby Isaac   PetscFunctionReturn(0);
5946a6ba4734SToby Isaac }
5947a6ba4734SToby Isaac 
5948a6ba4734SToby Isaac #undef __FUNCT__
5949a6ba4734SToby Isaac #define __FUNCT__ "DMCopyBoundary"
5950a6ba4734SToby Isaac PetscErrorCode DMCopyBoundary(DM dm, DM dmNew)
5951a6ba4734SToby Isaac {
5952a6ba4734SToby Isaac   DMBoundary     b;
5953a6ba4734SToby Isaac   PetscErrorCode ierr;
5954a6ba4734SToby Isaac 
5955a6ba4734SToby Isaac   PetscFunctionBegin;
5956bcc5ffd9SToby Isaac   ierr = DMBoundaryDestroy(&dmNew->boundary);CHKERRQ(ierr);
5957bcc5ffd9SToby Isaac   ierr = DMBoundaryDuplicate(dm->boundary, &dmNew->boundary);CHKERRQ(ierr);
5958bcc5ffd9SToby Isaac   for (b = dmNew->boundary->next; b; b = b->next) {
5959a6ba4734SToby Isaac     if (b->labelname) {
5960a6ba4734SToby Isaac       ierr = DMGetLabel(dmNew, b->labelname, &b->label);CHKERRQ(ierr);
5961a6ba4734SToby Isaac       if (!b->label) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Label %s does not exist in this DM", b->labelname);
5962a6ba4734SToby Isaac     }
5963a6ba4734SToby Isaac   }
5964a6ba4734SToby Isaac   PetscFunctionReturn(0);
5965a6ba4734SToby Isaac }
5966a6ba4734SToby Isaac 
5967a6ba4734SToby Isaac #undef __FUNCT__
5968a6ba4734SToby Isaac #define __FUNCT__ "DMAddBoundary"
5969a6ba4734SToby Isaac /*@C
5970a6ba4734SToby Isaac   DMAddBoundary - Add a boundary condition to the model
5971a6ba4734SToby Isaac 
5972a6ba4734SToby Isaac   Input Parameters:
5973a6ba4734SToby Isaac + dm          - The mesh object
5974a6ba4734SToby Isaac . isEssential - Flag for an essential (Dirichlet) condition, as opposed to a natural (Neumann) condition
5975a6ba4734SToby Isaac . name        - The BC name
5976a6ba4734SToby Isaac . labelname   - The label defining constrained points
5977a6ba4734SToby Isaac . field       - The field to constrain
5978a6ba4734SToby Isaac . numcomps    - The number of constrained field components
5979a6ba4734SToby Isaac . comps       - An array of constrained component numbers
5980a6ba4734SToby Isaac . bcFunc      - A pointwise function giving boundary values
5981a6ba4734SToby Isaac . numids      - The number of DMLabel ids for constrained points
5982a6ba4734SToby Isaac . ids         - An array of ids for constrained points
5983a6ba4734SToby Isaac - ctx         - An optional user context for bcFunc
5984a6ba4734SToby Isaac 
5985a6ba4734SToby Isaac   Options Database Keys:
5986a6ba4734SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids
5987a6ba4734SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components
5988a6ba4734SToby Isaac 
5989a6ba4734SToby Isaac   Level: developer
5990a6ba4734SToby Isaac 
5991a6ba4734SToby Isaac .seealso: DMGetBoundary()
5992a6ba4734SToby Isaac @*/
5993a6ba4734SToby Isaac PetscErrorCode DMAddBoundary(DM dm, PetscBool isEssential, const char name[], const char labelname[], PetscInt field, PetscInt numcomps, const PetscInt *comps, void (*bcFunc)(), PetscInt numids, const PetscInt *ids, void *ctx)
5994a6ba4734SToby Isaac {
5995a6ba4734SToby Isaac   DMBoundary     b;
5996a6ba4734SToby Isaac   PetscErrorCode ierr;
5997a6ba4734SToby Isaac 
5998a6ba4734SToby Isaac   PetscFunctionBegin;
5999a6ba4734SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6000a6ba4734SToby Isaac   ierr = PetscNew(&b);CHKERRQ(ierr);
6001a6ba4734SToby Isaac   ierr = PetscStrallocpy(name, (char **) &b->name);CHKERRQ(ierr);
6002a6ba4734SToby Isaac   ierr = PetscStrallocpy(labelname, (char **) &b->labelname);CHKERRQ(ierr);
6003a6ba4734SToby Isaac   ierr = PetscMalloc1(numcomps, &b->comps);CHKERRQ(ierr);
6004a6ba4734SToby Isaac   if (numcomps) {ierr = PetscMemcpy(b->comps, comps, numcomps*sizeof(PetscInt));CHKERRQ(ierr);}
6005a6ba4734SToby Isaac   ierr = PetscMalloc1(numids, &b->ids);CHKERRQ(ierr);
6006a6ba4734SToby Isaac   if (numids) {ierr = PetscMemcpy(b->ids, ids, numids*sizeof(PetscInt));CHKERRQ(ierr);}
6007a6ba4734SToby Isaac   if (b->labelname) {
6008a6ba4734SToby Isaac     ierr = DMGetLabel(dm, b->labelname, &b->label);CHKERRQ(ierr);
6009a6ba4734SToby Isaac     if (!b->label) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Label %s does not exist in this DM", b->labelname);
6010a6ba4734SToby Isaac   }
6011a6ba4734SToby Isaac   b->essential       = isEssential;
6012a6ba4734SToby Isaac   b->field           = field;
6013a6ba4734SToby Isaac   b->numcomps        = numcomps;
6014a6ba4734SToby Isaac   b->func            = bcFunc;
6015a6ba4734SToby Isaac   b->numids          = numids;
6016a6ba4734SToby Isaac   b->ctx             = ctx;
6017bcc5ffd9SToby Isaac   b->next            = dm->boundary->next;
6018bcc5ffd9SToby Isaac   dm->boundary->next = b;
6019a6ba4734SToby Isaac   PetscFunctionReturn(0);
6020a6ba4734SToby Isaac }
6021a6ba4734SToby Isaac 
6022a6ba4734SToby Isaac #undef __FUNCT__
6023a6ba4734SToby Isaac #define __FUNCT__ "DMGetNumBoundary"
6024a6ba4734SToby Isaac /*@
6025a6ba4734SToby Isaac   DMGetNumBoundary - Get the number of registered BC
6026a6ba4734SToby Isaac 
6027a6ba4734SToby Isaac   Input Parameters:
6028a6ba4734SToby Isaac . dm - The mesh object
6029a6ba4734SToby Isaac 
6030a6ba4734SToby Isaac   Output Parameters:
6031a6ba4734SToby Isaac . numBd - The number of BC
6032a6ba4734SToby Isaac 
6033a6ba4734SToby Isaac   Level: intermediate
6034a6ba4734SToby Isaac 
6035a6ba4734SToby Isaac .seealso: DMAddBoundary(), DMGetBoundary()
6036a6ba4734SToby Isaac @*/
6037a6ba4734SToby Isaac PetscErrorCode DMGetNumBoundary(DM dm, PetscInt *numBd)
6038a6ba4734SToby Isaac {
6039bcc5ffd9SToby Isaac   DMBoundary b = dm->boundary->next;
6040a6ba4734SToby Isaac 
6041a6ba4734SToby Isaac   PetscFunctionBegin;
6042a6ba4734SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6043a6ba4734SToby Isaac   PetscValidPointer(numBd, 2);
6044a6ba4734SToby Isaac   *numBd = 0;
6045a6ba4734SToby Isaac   while (b) {++(*numBd); b = b->next;}
6046a6ba4734SToby Isaac   PetscFunctionReturn(0);
6047a6ba4734SToby Isaac }
6048a6ba4734SToby Isaac 
6049a6ba4734SToby Isaac #undef __FUNCT__
6050a6ba4734SToby Isaac #define __FUNCT__ "DMGetBoundary"
6051a6ba4734SToby Isaac /*@C
6052a6ba4734SToby Isaac   DMGetBoundary - Add a boundary condition to the model
6053a6ba4734SToby Isaac 
6054a6ba4734SToby Isaac   Input Parameters:
6055a6ba4734SToby Isaac + dm          - The mesh object
6056a6ba4734SToby Isaac - bd          - The BC number
6057a6ba4734SToby Isaac 
6058a6ba4734SToby Isaac   Output Parameters:
6059a6ba4734SToby Isaac + isEssential - Flag for an essential (Dirichlet) condition, as opposed to a natural (Neumann) condition
6060a6ba4734SToby Isaac . name        - The BC name
6061a6ba4734SToby Isaac . labelname   - The label defining constrained points
6062a6ba4734SToby Isaac . field       - The field to constrain
6063a6ba4734SToby Isaac . numcomps    - The number of constrained field components
6064a6ba4734SToby Isaac . comps       - An array of constrained component numbers
6065a6ba4734SToby Isaac . bcFunc      - A pointwise function giving boundary values
6066a6ba4734SToby Isaac . numids      - The number of DMLabel ids for constrained points
6067a6ba4734SToby Isaac . ids         - An array of ids for constrained points
6068a6ba4734SToby Isaac - ctx         - An optional user context for bcFunc
6069a6ba4734SToby Isaac 
6070a6ba4734SToby Isaac   Options Database Keys:
6071a6ba4734SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids
6072a6ba4734SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components
6073a6ba4734SToby Isaac 
6074a6ba4734SToby Isaac   Level: developer
6075a6ba4734SToby Isaac 
6076a6ba4734SToby Isaac .seealso: DMAddBoundary()
6077a6ba4734SToby Isaac @*/
6078a6ba4734SToby Isaac PetscErrorCode DMGetBoundary(DM dm, PetscInt bd, PetscBool *isEssential, const char **name, const char **labelname, PetscInt *field, PetscInt *numcomps, const PetscInt **comps, void (**func)(), PetscInt *numids, const PetscInt **ids, void **ctx)
6079a6ba4734SToby Isaac {
6080bcc5ffd9SToby Isaac   DMBoundary b    = dm->boundary->next;
6081a6ba4734SToby Isaac   PetscInt   n    = 0;
6082a6ba4734SToby Isaac 
6083a6ba4734SToby Isaac   PetscFunctionBegin;
6084a6ba4734SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6085a6ba4734SToby Isaac   while (b) {
6086a6ba4734SToby Isaac     if (n == bd) break;
6087a6ba4734SToby Isaac     b = b->next;
6088a6ba4734SToby Isaac     ++n;
6089a6ba4734SToby Isaac   }
60909fc93327SToby Isaac   if (!b) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Boundary %d is not in [0, %d)", bd, n);
6091a6ba4734SToby Isaac   if (isEssential) {
6092a6ba4734SToby Isaac     PetscValidPointer(isEssential, 3);
6093a6ba4734SToby Isaac     *isEssential = b->essential;
6094a6ba4734SToby Isaac   }
6095a6ba4734SToby Isaac   if (name) {
6096a6ba4734SToby Isaac     PetscValidPointer(name, 4);
6097a6ba4734SToby Isaac     *name = b->name;
6098a6ba4734SToby Isaac   }
6099a6ba4734SToby Isaac   if (labelname) {
6100a6ba4734SToby Isaac     PetscValidPointer(labelname, 5);
6101a6ba4734SToby Isaac     *labelname = b->labelname;
6102a6ba4734SToby Isaac   }
6103a6ba4734SToby Isaac   if (field) {
6104a6ba4734SToby Isaac     PetscValidPointer(field, 6);
6105a6ba4734SToby Isaac     *field = b->field;
6106a6ba4734SToby Isaac   }
6107a6ba4734SToby Isaac   if (numcomps) {
6108a6ba4734SToby Isaac     PetscValidPointer(numcomps, 7);
6109a6ba4734SToby Isaac     *numcomps = b->numcomps;
6110a6ba4734SToby Isaac   }
6111a6ba4734SToby Isaac   if (comps) {
6112a6ba4734SToby Isaac     PetscValidPointer(comps, 8);
6113a6ba4734SToby Isaac     *comps = b->comps;
6114a6ba4734SToby Isaac   }
6115a6ba4734SToby Isaac   if (func) {
6116a6ba4734SToby Isaac     PetscValidPointer(func, 9);
6117a6ba4734SToby Isaac     *func = b->func;
6118a6ba4734SToby Isaac   }
6119a6ba4734SToby Isaac   if (numids) {
6120a6ba4734SToby Isaac     PetscValidPointer(numids, 10);
6121a6ba4734SToby Isaac     *numids = b->numids;
6122a6ba4734SToby Isaac   }
6123a6ba4734SToby Isaac   if (ids) {
6124a6ba4734SToby Isaac     PetscValidPointer(ids, 11);
6125a6ba4734SToby Isaac     *ids = b->ids;
6126a6ba4734SToby Isaac   }
6127a6ba4734SToby Isaac   if (ctx) {
6128a6ba4734SToby Isaac     PetscValidPointer(ctx, 12);
6129a6ba4734SToby Isaac     *ctx = b->ctx;
6130a6ba4734SToby Isaac   }
6131a6ba4734SToby Isaac   PetscFunctionReturn(0);
6132a6ba4734SToby Isaac }
6133a6ba4734SToby Isaac 
6134a6ba4734SToby Isaac #undef __FUNCT__
6135a6ba4734SToby Isaac #define __FUNCT__ "DMIsBoundaryPoint"
6136a6ba4734SToby Isaac PetscErrorCode DMIsBoundaryPoint(DM dm, PetscInt point, PetscBool *isBd)
6137a6ba4734SToby Isaac {
6138bcc5ffd9SToby Isaac   DMBoundary     b    = dm->boundary->next;
6139a6ba4734SToby Isaac   PetscErrorCode ierr;
6140a6ba4734SToby Isaac 
6141a6ba4734SToby Isaac   PetscFunctionBegin;
6142a6ba4734SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6143a6ba4734SToby Isaac   PetscValidPointer(isBd, 3);
6144a6ba4734SToby Isaac   *isBd = PETSC_FALSE;
6145a6ba4734SToby Isaac   while (b && !(*isBd)) {
6146a6ba4734SToby Isaac     if (b->label) {
6147a6ba4734SToby Isaac       PetscInt i;
6148a6ba4734SToby Isaac 
6149a6ba4734SToby Isaac       for (i = 0; i < b->numids && !(*isBd); ++i) {
6150a6ba4734SToby Isaac         ierr = DMLabelStratumHasPoint(b->label, b->ids[i], point, isBd);CHKERRQ(ierr);
6151a6ba4734SToby Isaac       }
6152a6ba4734SToby Isaac     }
6153a6ba4734SToby Isaac     b = b->next;
6154a6ba4734SToby Isaac   }
6155a6ba4734SToby Isaac   PetscFunctionReturn(0);
6156a6ba4734SToby Isaac }
61574d6f44ffSToby Isaac 
61584d6f44ffSToby Isaac #undef __FUNCT__
61594d6f44ffSToby Isaac #define __FUNCT__ "DMProjectFunction"
61604d6f44ffSToby Isaac /*@C
61614d6f44ffSToby Isaac   DMProjectFunction - This projects the given function into the function space provided.
61624d6f44ffSToby Isaac 
61634d6f44ffSToby Isaac   Input Parameters:
61644d6f44ffSToby Isaac + dm      - The DM
61650709b2feSToby Isaac . time    - The time
61664d6f44ffSToby Isaac . funcs   - The coordinate functions to evaluate, one per field
61674d6f44ffSToby Isaac . ctxs    - Optional array of contexts to pass to each coordinate function.  ctxs itself may be null.
61684d6f44ffSToby Isaac - mode    - The insertion mode for values
61694d6f44ffSToby Isaac 
61704d6f44ffSToby Isaac   Output Parameter:
61714d6f44ffSToby Isaac . X - vector
61724d6f44ffSToby Isaac 
61734d6f44ffSToby Isaac    Calling sequence of func:
61740709b2feSToby Isaac $    func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nf, PetscScalar u[], void *ctx);
61754d6f44ffSToby Isaac 
61764d6f44ffSToby Isaac +  dim - The spatial dimension
61774d6f44ffSToby Isaac .  x   - The coordinates
61784d6f44ffSToby Isaac .  Nf  - The number of fields
61794d6f44ffSToby Isaac .  u   - The output field values
61804d6f44ffSToby Isaac -  ctx - optional user-defined function context
61814d6f44ffSToby Isaac 
61824d6f44ffSToby Isaac   Level: developer
61834d6f44ffSToby Isaac 
61842716604bSToby Isaac .seealso: DMComputeL2Diff()
61854d6f44ffSToby Isaac @*/
61860709b2feSToby Isaac PetscErrorCode DMProjectFunction(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec X)
61874d6f44ffSToby Isaac {
61884d6f44ffSToby Isaac   Vec            localX;
61894d6f44ffSToby Isaac   PetscErrorCode ierr;
61904d6f44ffSToby Isaac 
61914d6f44ffSToby Isaac   PetscFunctionBegin;
61924d6f44ffSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
61934d6f44ffSToby Isaac   ierr = DMGetLocalVector(dm, &localX);CHKERRQ(ierr);
61940709b2feSToby Isaac   ierr = DMProjectFunctionLocal(dm, time, funcs, ctxs, mode, localX);CHKERRQ(ierr);
61954d6f44ffSToby Isaac   ierr = DMLocalToGlobalBegin(dm, localX, mode, X);CHKERRQ(ierr);
61964d6f44ffSToby Isaac   ierr = DMLocalToGlobalEnd(dm, localX, mode, X);CHKERRQ(ierr);
61974d6f44ffSToby Isaac   ierr = DMRestoreLocalVector(dm, &localX);CHKERRQ(ierr);
61984d6f44ffSToby Isaac   PetscFunctionReturn(0);
61994d6f44ffSToby Isaac }
62004d6f44ffSToby Isaac 
62014d6f44ffSToby Isaac #undef __FUNCT__
62024d6f44ffSToby Isaac #define __FUNCT__ "DMProjectFunctionLocal"
62030709b2feSToby Isaac PetscErrorCode DMProjectFunctionLocal(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec localX)
62044d6f44ffSToby Isaac {
62054d6f44ffSToby Isaac   PetscErrorCode ierr;
62064d6f44ffSToby Isaac 
62074d6f44ffSToby Isaac   PetscFunctionBegin;
62084d6f44ffSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
62094d6f44ffSToby Isaac   PetscValidHeaderSpecific(localX,VEC_CLASSID,5);
62104d6f44ffSToby Isaac   if (!dm->ops->projectfunctionlocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implemnt DMProjectFunctionLocal",((PetscObject)dm)->type_name);
62110709b2feSToby Isaac   ierr = (dm->ops->projectfunctionlocal) (dm, time, funcs, ctxs, mode, localX);CHKERRQ(ierr);
62124d6f44ffSToby Isaac   PetscFunctionReturn(0);
62134d6f44ffSToby Isaac }
62144d6f44ffSToby Isaac 
62154d6f44ffSToby Isaac #undef __FUNCT__
6216bfc4295aSToby Isaac #define __FUNCT__ "DMProjectFieldLocal"
6217bfc4295aSToby Isaac PetscErrorCode DMProjectFieldLocal(DM dm, Vec localU,
6218bfc4295aSToby Isaac                                    void (**funcs)(PetscInt, PetscInt, PetscInt,
6219bfc4295aSToby Isaac                                                   const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
6220bfc4295aSToby Isaac                                                   const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
6221bfc4295aSToby Isaac                                                   PetscReal, const PetscReal[], PetscScalar[]),
6222bfc4295aSToby Isaac                                    InsertMode mode, Vec localX)
6223bfc4295aSToby Isaac {
6224bfc4295aSToby Isaac   PetscErrorCode ierr;
6225bfc4295aSToby Isaac 
6226bfc4295aSToby Isaac   PetscFunctionBegin;
6227bfc4295aSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6228bfc4295aSToby Isaac   PetscValidHeaderSpecific(localU,VEC_CLASSID,2);
6229bfc4295aSToby Isaac   PetscValidHeaderSpecific(localX,VEC_CLASSID,5);
6230bfc4295aSToby Isaac   if (!dm->ops->projectfieldlocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implemnt DMProjectFieldLocal",((PetscObject)dm)->type_name);
6231bfc4295aSToby Isaac   ierr = (dm->ops->projectfieldlocal) (dm, localU, funcs, mode, localX);CHKERRQ(ierr);
6232bfc4295aSToby Isaac   PetscFunctionReturn(0);
6233bfc4295aSToby Isaac }
6234bfc4295aSToby Isaac 
6235bfc4295aSToby Isaac #undef __FUNCT__
62364d6f44ffSToby Isaac #define __FUNCT__ "DMProjectFunctionLabelLocal"
62370709b2feSToby Isaac PetscErrorCode DMProjectFunctionLabelLocal(DM dm, PetscReal time, DMLabel label, PetscInt numIds, const PetscInt ids[], PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec localX)
62384d6f44ffSToby Isaac {
62394d6f44ffSToby Isaac   PetscErrorCode ierr;
62404d6f44ffSToby Isaac 
62414d6f44ffSToby Isaac   PetscFunctionBegin;
62424d6f44ffSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
62434d6f44ffSToby Isaac   PetscValidHeaderSpecific(localX,VEC_CLASSID,5);
62444d6f44ffSToby Isaac   if (!dm->ops->projectfunctionlabellocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implemnt DMProjectFunctionLabelLocal",((PetscObject)dm)->type_name);
62450709b2feSToby Isaac   ierr = (dm->ops->projectfunctionlabellocal) (dm, time, label, numIds, ids, funcs, ctxs, mode, localX);CHKERRQ(ierr);
62464d6f44ffSToby Isaac   PetscFunctionReturn(0);
62474d6f44ffSToby Isaac }
62482716604bSToby Isaac 
62492716604bSToby Isaac #undef __FUNCT__
62502716604bSToby Isaac #define __FUNCT__ "DMComputeL2Diff"
62512716604bSToby Isaac /*@C
62522716604bSToby Isaac   DMComputeL2Diff - This function computes the L_2 difference between a function u and an FEM interpolant solution u_h.
62532716604bSToby Isaac 
62542716604bSToby Isaac   Input Parameters:
62552716604bSToby Isaac + dm    - The DM
62560709b2feSToby Isaac . time  - The time
62572716604bSToby Isaac . funcs - The functions to evaluate for each field component
62582716604bSToby Isaac . ctxs  - Optional array of contexts to pass to each function, or NULL.
62592716604bSToby Isaac - X     - The coefficient vector u_h
62602716604bSToby Isaac 
62612716604bSToby Isaac   Output Parameter:
62622716604bSToby Isaac . diff - The diff ||u - u_h||_2
62632716604bSToby Isaac 
62642716604bSToby Isaac   Level: developer
62652716604bSToby Isaac 
62661189c1efSToby Isaac .seealso: DMProjectFunction(), DMComputeL2FieldDiff(), DMComputeL2GradientDiff()
62672716604bSToby Isaac @*/
62680709b2feSToby Isaac PetscErrorCode DMComputeL2Diff(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, Vec X, PetscReal *diff)
62692716604bSToby Isaac {
62702716604bSToby Isaac   PetscErrorCode ierr;
62712716604bSToby Isaac 
62722716604bSToby Isaac   PetscFunctionBegin;
62732716604bSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6274b698f381SToby Isaac   PetscValidHeaderSpecific(X,VEC_CLASSID,5);
62752716604bSToby Isaac   if (!dm->ops->computel2diff) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implemnt DMComputeL2Diff",((PetscObject)dm)->type_name);
62760709b2feSToby Isaac   ierr = (dm->ops->computel2diff)(dm,time,funcs,ctxs,X,diff);CHKERRQ(ierr);
62772716604bSToby Isaac   PetscFunctionReturn(0);
62782716604bSToby Isaac }
6279b698f381SToby Isaac 
6280b698f381SToby Isaac #undef __FUNCT__
6281b698f381SToby Isaac #define __FUNCT__ "DMComputeL2GradientDiff"
6282b698f381SToby Isaac /*@C
6283b698f381SToby Isaac   DMComputeL2GradientDiff - This function computes the L_2 difference between the gradient of a function u and an FEM interpolant solution grad u_h.
6284b698f381SToby Isaac 
6285b698f381SToby Isaac   Input Parameters:
6286b698f381SToby Isaac + dm    - The DM
6287b698f381SToby Isaac , time  - The time
6288b698f381SToby Isaac . funcs - The gradient functions to evaluate for each field component
6289b698f381SToby Isaac . ctxs  - Optional array of contexts to pass to each function, or NULL.
6290b698f381SToby Isaac . X     - The coefficient vector u_h
6291b698f381SToby Isaac - n     - The vector to project along
6292b698f381SToby Isaac 
6293b698f381SToby Isaac   Output Parameter:
6294b698f381SToby Isaac . diff - The diff ||(grad u - grad u_h) . n||_2
6295b698f381SToby Isaac 
6296b698f381SToby Isaac   Level: developer
6297b698f381SToby Isaac 
6298b698f381SToby Isaac .seealso: DMProjectFunction(), DMComputeL2Diff()
6299b698f381SToby Isaac @*/
6300b698f381SToby Isaac PetscErrorCode DMComputeL2GradientDiff(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], const PetscReal[], PetscInt, PetscScalar *, void *), void **ctxs, Vec X, const PetscReal n[], PetscReal *diff)
6301b698f381SToby Isaac {
6302b698f381SToby Isaac   PetscErrorCode ierr;
6303b698f381SToby Isaac 
6304b698f381SToby Isaac   PetscFunctionBegin;
6305b698f381SToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6306b698f381SToby Isaac   PetscValidHeaderSpecific(X,VEC_CLASSID,5);
6307b698f381SToby Isaac   if (!dm->ops->computel2gradientdiff) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2GradientDiff",((PetscObject)dm)->type_name);
6308b698f381SToby Isaac   ierr = (dm->ops->computel2gradientdiff)(dm,time,funcs,ctxs,X,n,diff);CHKERRQ(ierr);
6309b698f381SToby Isaac   PetscFunctionReturn(0);
6310b698f381SToby Isaac }
6311b698f381SToby Isaac 
63122a16baeaSToby Isaac #undef __FUNCT__
63132a16baeaSToby Isaac #define __FUNCT__ "DMComputeL2FieldDiff"
63142a16baeaSToby Isaac /*@C
63152a16baeaSToby Isaac   DMComputeL2FieldDiff - This function computes the L_2 difference between a function u and an FEM interpolant solution u_h, separated into field components.
63162a16baeaSToby Isaac 
63172a16baeaSToby Isaac   Input Parameters:
63182a16baeaSToby Isaac + dm    - The DM
63192a16baeaSToby Isaac . time  - The time
63202a16baeaSToby Isaac . funcs - The functions to evaluate for each field component
63212a16baeaSToby Isaac . ctxs  - Optional array of contexts to pass to each function, or NULL.
63222a16baeaSToby Isaac - X     - The coefficient vector u_h
63232a16baeaSToby Isaac 
63242a16baeaSToby Isaac   Output Parameter:
63252a16baeaSToby Isaac . diff - The array of differences, ||u^f - u^f_h||_2
63262a16baeaSToby Isaac 
63272a16baeaSToby Isaac   Level: developer
63282a16baeaSToby Isaac 
63291189c1efSToby Isaac .seealso: DMProjectFunction(), DMComputeL2FieldDiff(), DMComputeL2GradientDiff()
63302a16baeaSToby Isaac @*/
63311189c1efSToby Isaac PetscErrorCode DMComputeL2FieldDiff(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, Vec X, PetscReal diff[])
63322a16baeaSToby Isaac {
63332a16baeaSToby Isaac   PetscErrorCode ierr;
63342a16baeaSToby Isaac 
63352a16baeaSToby Isaac   PetscFunctionBegin;
63362a16baeaSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
63372a16baeaSToby Isaac   PetscValidHeaderSpecific(X,VEC_CLASSID,5);
63382a16baeaSToby Isaac   if (!dm->ops->computel2fielddiff) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implemnt DMComputeL2FieldDiff",((PetscObject)dm)->type_name);
63392a16baeaSToby Isaac   ierr = (dm->ops->computel2fielddiff)(dm,time,funcs,ctxs,X,diff);CHKERRQ(ierr);
63402a16baeaSToby Isaac   PetscFunctionReturn(0);
63412a16baeaSToby Isaac }
63422a16baeaSToby Isaac 
6343