xref: /petsc/src/dm/interface/dm.c (revision f60917d29fbbc6afdb3ae8720797db74f192db03)
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;
7cea54e9dSPatrick Farrell PetscLogEvent DM_Convert, DM_GlobalToLocal, DM_LocalToGlobal, DM_LocalToLocal, DM_LocatePoints, DM_Coarsen, DM_CreateInterpolation;
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;
128be4c1c3eSMatthew G. Knepley     PetscInt     pEnd = -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);}
132be4c1c3eSMatthew G. Knepley     if (pEnd >= 0) {
133be4c1c3eSMatthew G. Knepley       ierr = DMClone(dm->coordinateDM, &ncdm);CHKERRQ(ierr);
13413bffc4cSMatthew G. Knepley       ierr = DMSetDefaultSection(ncdm, cs);CHKERRQ(ierr);
135a61e840bSMatthew G. Knepley       ierr = DMSetCoordinateDM(*newdm, ncdm);CHKERRQ(ierr);
136be4c1c3eSMatthew G. Knepley       ierr = DMDestroy(&ncdm);CHKERRQ(ierr);
137be4c1c3eSMatthew G. Knepley     }
138be4c1c3eSMatthew G. Knepley   }
13938221697SMatthew G. Knepley   ierr = DMGetCoordinatesLocal(dm, &coords);CHKERRQ(ierr);
14038221697SMatthew G. Knepley   if (coords) {
14138221697SMatthew G. Knepley     ierr = DMSetCoordinatesLocal(*newdm, coords);CHKERRQ(ierr);
14238221697SMatthew G. Knepley   } else {
14338221697SMatthew G. Knepley     ierr = DMGetCoordinates(dm, &coords);CHKERRQ(ierr);
14438221697SMatthew G. Knepley     if (coords) {ierr = DMSetCoordinates(*newdm, coords);CHKERRQ(ierr);}
14538221697SMatthew G. Knepley   }
146c6b900c6SMatthew G. Knepley   if (dm->maxCell) {
147c6b900c6SMatthew G. Knepley     const PetscReal *maxCell, *L;
1485dc8c3f7SMatthew G. Knepley     const DMBoundaryType *bd;
1495dc8c3f7SMatthew G. Knepley     ierr = DMGetPeriodicity(dm,     &maxCell, &L, &bd);CHKERRQ(ierr);
1505dc8c3f7SMatthew G. Knepley     ierr = DMSetPeriodicity(*newdm,  maxCell,  L,  bd);CHKERRQ(ierr);
151c6b900c6SMatthew G. Knepley   }
15238221697SMatthew G. Knepley   PetscFunctionReturn(0);
15338221697SMatthew G. Knepley }
15438221697SMatthew G. Knepley 
15538221697SMatthew G. Knepley #undef __FUNCT__
1569a42bb27SBarry Smith #define __FUNCT__ "DMSetVecType"
1579a42bb27SBarry Smith /*@C
158564755cdSBarry Smith        DMSetVecType - Sets the type of vector created with DMCreateLocalVector() and DMCreateGlobalVector()
1599a42bb27SBarry Smith 
1608472ad0fSDave May    Logically Collective on DM
1619a42bb27SBarry Smith 
1629a42bb27SBarry Smith    Input Parameter:
1639a42bb27SBarry Smith +  da - initial distributed array
1648154be41SBarry Smith .  ctype - the vector type, currently either VECSTANDARD or VECCUSP
1659a42bb27SBarry Smith 
1669a42bb27SBarry Smith    Options Database:
167dd85299cSBarry Smith .   -dm_vec_type ctype
1689a42bb27SBarry Smith 
1699a42bb27SBarry Smith    Level: intermediate
1709a42bb27SBarry Smith 
1718472ad0fSDave May .seealso: DMCreate(), DMDestroy(), DM, DMDAInterpolationType, VecType, DMGetVecType()
1729a42bb27SBarry Smith @*/
17319fd82e9SBarry Smith PetscErrorCode  DMSetVecType(DM da,VecType ctype)
1749a42bb27SBarry Smith {
1759a42bb27SBarry Smith   PetscErrorCode ierr;
1769a42bb27SBarry Smith 
1779a42bb27SBarry Smith   PetscFunctionBegin;
1789a42bb27SBarry Smith   PetscValidHeaderSpecific(da,DM_CLASSID,1);
1799a42bb27SBarry Smith   ierr = PetscFree(da->vectype);CHKERRQ(ierr);
18019fd82e9SBarry Smith   ierr = PetscStrallocpy(ctype,(char**)&da->vectype);CHKERRQ(ierr);
1819a42bb27SBarry Smith   PetscFunctionReturn(0);
1829a42bb27SBarry Smith }
1839a42bb27SBarry Smith 
1849a42bb27SBarry Smith #undef __FUNCT__
185c0dedaeaSBarry Smith #define __FUNCT__ "DMGetVecType"
186c0dedaeaSBarry Smith /*@C
187c0dedaeaSBarry Smith        DMGetVecType - Gets the type of vector created with DMCreateLocalVector() and DMCreateGlobalVector()
188c0dedaeaSBarry Smith 
1898472ad0fSDave May    Logically Collective on DM
190c0dedaeaSBarry Smith 
191c0dedaeaSBarry Smith    Input Parameter:
192c0dedaeaSBarry Smith .  da - initial distributed array
193c0dedaeaSBarry Smith 
194c0dedaeaSBarry Smith    Output Parameter:
195c0dedaeaSBarry Smith .  ctype - the vector type
196c0dedaeaSBarry Smith 
197c0dedaeaSBarry Smith    Level: intermediate
198c0dedaeaSBarry Smith 
1998472ad0fSDave May .seealso: DMCreate(), DMDestroy(), DM, DMDAInterpolationType, VecType
200c0dedaeaSBarry Smith @*/
201c0dedaeaSBarry Smith PetscErrorCode  DMGetVecType(DM da,VecType *ctype)
202c0dedaeaSBarry Smith {
203c0dedaeaSBarry Smith   PetscFunctionBegin;
204c0dedaeaSBarry Smith   PetscValidHeaderSpecific(da,DM_CLASSID,1);
205c0dedaeaSBarry Smith   *ctype = da->vectype;
206c0dedaeaSBarry Smith   PetscFunctionReturn(0);
207c0dedaeaSBarry Smith }
208c0dedaeaSBarry Smith 
209c0dedaeaSBarry Smith #undef __FUNCT__
2105f1ad066SMatthew G Knepley #define __FUNCT__ "VecGetDM"
2115f1ad066SMatthew G Knepley /*@
21234f98d34SBarry Smith   VecGetDM - Gets the DM defining the data layout of the vector
2135f1ad066SMatthew G Knepley 
2145f1ad066SMatthew G Knepley   Not collective
2155f1ad066SMatthew G Knepley 
2165f1ad066SMatthew G Knepley   Input Parameter:
2175f1ad066SMatthew G Knepley . v - The Vec
2185f1ad066SMatthew G Knepley 
2195f1ad066SMatthew G Knepley   Output Parameter:
2205f1ad066SMatthew G Knepley . dm - The DM
2215f1ad066SMatthew G Knepley 
2225f1ad066SMatthew G Knepley   Level: intermediate
2235f1ad066SMatthew G Knepley 
2245f1ad066SMatthew G Knepley .seealso: VecSetDM(), DMGetLocalVector(), DMGetGlobalVector(), DMSetVecType()
2255f1ad066SMatthew G Knepley @*/
2265f1ad066SMatthew G Knepley PetscErrorCode VecGetDM(Vec v, DM *dm)
2275f1ad066SMatthew G Knepley {
2285f1ad066SMatthew G Knepley   PetscErrorCode ierr;
2295f1ad066SMatthew G Knepley 
2305f1ad066SMatthew G Knepley   PetscFunctionBegin;
2315f1ad066SMatthew G Knepley   PetscValidHeaderSpecific(v,VEC_CLASSID,1);
2325f1ad066SMatthew G Knepley   PetscValidPointer(dm,2);
2335f1ad066SMatthew G Knepley   ierr = PetscObjectQuery((PetscObject) v, "__PETSc_dm", (PetscObject*) dm);CHKERRQ(ierr);
2345f1ad066SMatthew G Knepley   PetscFunctionReturn(0);
2355f1ad066SMatthew G Knepley }
2365f1ad066SMatthew G Knepley 
2375f1ad066SMatthew G Knepley #undef __FUNCT__
2385f1ad066SMatthew G Knepley #define __FUNCT__ "VecSetDM"
2395f1ad066SMatthew G Knepley /*@
240d9805387SMatthew G. Knepley   VecSetDM - Sets the DM defining the data layout of the vector.
2415f1ad066SMatthew G Knepley 
2425f1ad066SMatthew G Knepley   Not collective
2435f1ad066SMatthew G Knepley 
2445f1ad066SMatthew G Knepley   Input Parameters:
2455f1ad066SMatthew G Knepley + v - The Vec
2465f1ad066SMatthew G Knepley - dm - The DM
2475f1ad066SMatthew G Knepley 
248d9805387SMatthew 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.
249d9805387SMatthew G. Knepley 
2505f1ad066SMatthew G Knepley   Level: intermediate
2515f1ad066SMatthew G Knepley 
2525f1ad066SMatthew G Knepley .seealso: VecGetDM(), DMGetLocalVector(), DMGetGlobalVector(), DMSetVecType()
2535f1ad066SMatthew G Knepley @*/
2545f1ad066SMatthew G Knepley PetscErrorCode VecSetDM(Vec v, DM dm)
2555f1ad066SMatthew G Knepley {
2565f1ad066SMatthew G Knepley   PetscErrorCode ierr;
2575f1ad066SMatthew G Knepley 
2585f1ad066SMatthew G Knepley   PetscFunctionBegin;
2595f1ad066SMatthew G Knepley   PetscValidHeaderSpecific(v,VEC_CLASSID,1);
260d7f50e27SLisandro Dalcin   if (dm) PetscValidHeaderSpecific(dm,DM_CLASSID,2);
2615f1ad066SMatthew G Knepley   ierr = PetscObjectCompose((PetscObject) v, "__PETSc_dm", (PetscObject) dm);CHKERRQ(ierr);
2625f1ad066SMatthew G Knepley   PetscFunctionReturn(0);
2635f1ad066SMatthew G Knepley }
2645f1ad066SMatthew G Knepley 
2655f1ad066SMatthew G Knepley #undef __FUNCT__
266521d9a4cSLisandro Dalcin #define __FUNCT__ "DMSetMatType"
267521d9a4cSLisandro Dalcin /*@C
268521d9a4cSLisandro Dalcin        DMSetMatType - Sets the type of matrix created with DMCreateMatrix()
269521d9a4cSLisandro Dalcin 
270521d9a4cSLisandro Dalcin    Logically Collective on DM
271521d9a4cSLisandro Dalcin 
272521d9a4cSLisandro Dalcin    Input Parameter:
273521d9a4cSLisandro Dalcin +  dm - the DM context
274521d9a4cSLisandro Dalcin .  ctype - the matrix type
275521d9a4cSLisandro Dalcin 
276521d9a4cSLisandro Dalcin    Options Database:
277521d9a4cSLisandro Dalcin .   -dm_mat_type ctype
278521d9a4cSLisandro Dalcin 
279521d9a4cSLisandro Dalcin    Level: intermediate
280521d9a4cSLisandro Dalcin 
281c0dedaeaSBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMGetMatType()
282521d9a4cSLisandro Dalcin @*/
28319fd82e9SBarry Smith PetscErrorCode  DMSetMatType(DM dm,MatType ctype)
284521d9a4cSLisandro Dalcin {
285521d9a4cSLisandro Dalcin   PetscErrorCode ierr;
28688f0584fSBarry Smith 
287521d9a4cSLisandro Dalcin   PetscFunctionBegin;
288521d9a4cSLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
289521d9a4cSLisandro Dalcin   ierr = PetscFree(dm->mattype);CHKERRQ(ierr);
29019fd82e9SBarry Smith   ierr = PetscStrallocpy(ctype,(char**)&dm->mattype);CHKERRQ(ierr);
291521d9a4cSLisandro Dalcin   PetscFunctionReturn(0);
292521d9a4cSLisandro Dalcin }
293521d9a4cSLisandro Dalcin 
294521d9a4cSLisandro Dalcin #undef __FUNCT__
295c0dedaeaSBarry Smith #define __FUNCT__ "DMGetMatType"
296c0dedaeaSBarry Smith /*@C
297c0dedaeaSBarry Smith        DMGetMatType - Gets the type of matrix created with DMCreateMatrix()
298c0dedaeaSBarry Smith 
299c0dedaeaSBarry Smith    Logically Collective on DM
300c0dedaeaSBarry Smith 
301c0dedaeaSBarry Smith    Input Parameter:
302c0dedaeaSBarry Smith .  dm - the DM context
303c0dedaeaSBarry Smith 
304c0dedaeaSBarry Smith    Output Parameter:
305c0dedaeaSBarry Smith .  ctype - the matrix type
306c0dedaeaSBarry Smith 
307c0dedaeaSBarry Smith    Options Database:
308c0dedaeaSBarry Smith .   -dm_mat_type ctype
309c0dedaeaSBarry Smith 
310c0dedaeaSBarry Smith    Level: intermediate
311c0dedaeaSBarry Smith 
312c0dedaeaSBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMSetMatType()
313c0dedaeaSBarry Smith @*/
314c0dedaeaSBarry Smith PetscErrorCode  DMGetMatType(DM dm,MatType *ctype)
315c0dedaeaSBarry Smith {
316c0dedaeaSBarry Smith   PetscFunctionBegin;
317c0dedaeaSBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
318c0dedaeaSBarry Smith   *ctype = dm->mattype;
319c0dedaeaSBarry Smith   PetscFunctionReturn(0);
320c0dedaeaSBarry Smith }
321c0dedaeaSBarry Smith 
322c0dedaeaSBarry Smith #undef __FUNCT__
323c688c046SMatthew G Knepley #define __FUNCT__ "MatGetDM"
324c688c046SMatthew G Knepley /*@
32534f98d34SBarry Smith   MatGetDM - Gets the DM defining the data layout of the matrix
326c688c046SMatthew G Knepley 
327c688c046SMatthew G Knepley   Not collective
328c688c046SMatthew G Knepley 
329c688c046SMatthew G Knepley   Input Parameter:
330c688c046SMatthew G Knepley . A - The Mat
331c688c046SMatthew G Knepley 
332c688c046SMatthew G Knepley   Output Parameter:
333c688c046SMatthew G Knepley . dm - The DM
334c688c046SMatthew G Knepley 
335c688c046SMatthew G Knepley   Level: intermediate
336c688c046SMatthew G Knepley 
337c688c046SMatthew G Knepley .seealso: MatSetDM(), DMCreateMatrix(), DMSetMatType()
338c688c046SMatthew G Knepley @*/
339c688c046SMatthew G Knepley PetscErrorCode MatGetDM(Mat A, DM *dm)
340c688c046SMatthew G Knepley {
341c688c046SMatthew G Knepley   PetscErrorCode ierr;
342c688c046SMatthew G Knepley 
343c688c046SMatthew G Knepley   PetscFunctionBegin;
344c688c046SMatthew G Knepley   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
345c688c046SMatthew G Knepley   PetscValidPointer(dm,2);
346c688c046SMatthew G Knepley   ierr = PetscObjectQuery((PetscObject) A, "__PETSc_dm", (PetscObject*) dm);CHKERRQ(ierr);
347c688c046SMatthew G Knepley   PetscFunctionReturn(0);
348c688c046SMatthew G Knepley }
349c688c046SMatthew G Knepley 
350c688c046SMatthew G Knepley #undef __FUNCT__
351c688c046SMatthew G Knepley #define __FUNCT__ "MatSetDM"
352c688c046SMatthew G Knepley /*@
353c688c046SMatthew G Knepley   MatSetDM - Sets the DM defining the data layout of the matrix
354c688c046SMatthew G Knepley 
355c688c046SMatthew G Knepley   Not collective
356c688c046SMatthew G Knepley 
357c688c046SMatthew G Knepley   Input Parameters:
358c688c046SMatthew G Knepley + A - The Mat
359c688c046SMatthew G Knepley - dm - The DM
360c688c046SMatthew G Knepley 
361c688c046SMatthew G Knepley   Level: intermediate
362c688c046SMatthew G Knepley 
363c688c046SMatthew G Knepley .seealso: MatGetDM(), DMCreateMatrix(), DMSetMatType()
364c688c046SMatthew G Knepley @*/
365c688c046SMatthew G Knepley PetscErrorCode MatSetDM(Mat A, DM dm)
366c688c046SMatthew G Knepley {
367c688c046SMatthew G Knepley   PetscErrorCode ierr;
368c688c046SMatthew G Knepley 
369c688c046SMatthew G Knepley   PetscFunctionBegin;
370c688c046SMatthew G Knepley   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
3718865f1eaSKarl Rupp   if (dm) PetscValidHeaderSpecific(dm,DM_CLASSID,2);
372c688c046SMatthew G Knepley   ierr = PetscObjectCompose((PetscObject) A, "__PETSc_dm", (PetscObject) dm);CHKERRQ(ierr);
373c688c046SMatthew G Knepley   PetscFunctionReturn(0);
374c688c046SMatthew G Knepley }
375c688c046SMatthew G Knepley 
376c688c046SMatthew G Knepley #undef __FUNCT__
3779a42bb27SBarry Smith #define __FUNCT__ "DMSetOptionsPrefix"
3789a42bb27SBarry Smith /*@C
3799a42bb27SBarry Smith    DMSetOptionsPrefix - Sets the prefix used for searching for all
3806757b960SDave May    DM options in the database.
3819a42bb27SBarry Smith 
3828353ddbbSDave May    Logically Collective on DM
3839a42bb27SBarry Smith 
3849a42bb27SBarry Smith    Input Parameter:
3858353ddbbSDave May +  da - the DM context
3869a42bb27SBarry Smith -  prefix - the prefix to prepend to all option names
3879a42bb27SBarry Smith 
3889a42bb27SBarry Smith    Notes:
3899a42bb27SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
3909a42bb27SBarry Smith    The first character of all runtime options is AUTOMATICALLY the hyphen.
3919a42bb27SBarry Smith 
3929a42bb27SBarry Smith    Level: advanced
3939a42bb27SBarry Smith 
3948353ddbbSDave May .keywords: DM, set, options, prefix, database
3959a42bb27SBarry Smith 
3969a42bb27SBarry Smith .seealso: DMSetFromOptions()
3979a42bb27SBarry Smith @*/
3987087cfbeSBarry Smith PetscErrorCode  DMSetOptionsPrefix(DM dm,const char prefix[])
3999a42bb27SBarry Smith {
4009a42bb27SBarry Smith   PetscErrorCode ierr;
4019a42bb27SBarry Smith 
4029a42bb27SBarry Smith   PetscFunctionBegin;
4039a42bb27SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
4049a42bb27SBarry Smith   ierr = PetscObjectSetOptionsPrefix((PetscObject)dm,prefix);CHKERRQ(ierr);
405691be533SLawrence Mitchell   if (dm->sf) {
406691be533SLawrence Mitchell     ierr = PetscObjectSetOptionsPrefix((PetscObject)dm->sf,prefix);CHKERRQ(ierr);
407691be533SLawrence Mitchell   }
408691be533SLawrence Mitchell   if (dm->defaultSF) {
409691be533SLawrence Mitchell     ierr = PetscObjectSetOptionsPrefix((PetscObject)dm->defaultSF,prefix);CHKERRQ(ierr);
410691be533SLawrence Mitchell   }
4119a42bb27SBarry Smith   PetscFunctionReturn(0);
4129a42bb27SBarry Smith }
4139a42bb27SBarry Smith 
4149a42bb27SBarry Smith #undef __FUNCT__
41531697293SDave May #define __FUNCT__ "DMAppendOptionsPrefix"
41631697293SDave May /*@C
41731697293SDave May    DMAppendOptionsPrefix - Appends to the prefix used for searching for all
41831697293SDave May    DM options in the database.
41931697293SDave May 
42031697293SDave May    Logically Collective on DM
42131697293SDave May 
42231697293SDave May    Input Parameters:
42331697293SDave May +  dm - the DM context
42431697293SDave May -  prefix - the prefix string to prepend to all DM option requests
42531697293SDave May 
42631697293SDave May    Notes:
42731697293SDave May    A hyphen (-) must NOT be given at the beginning of the prefix name.
42831697293SDave May    The first character of all runtime options is AUTOMATICALLY the hyphen.
42931697293SDave May 
43031697293SDave May    Level: advanced
43131697293SDave May 
43231697293SDave May .keywords: DM, append, options, prefix, database
43331697293SDave May 
43431697293SDave May .seealso: DMSetOptionsPrefix(), DMGetOptionsPrefix()
43531697293SDave May @*/
43631697293SDave May PetscErrorCode  DMAppendOptionsPrefix(DM dm,const char prefix[])
43731697293SDave May {
43831697293SDave May   PetscErrorCode ierr;
43931697293SDave May 
44031697293SDave May   PetscFunctionBegin;
44131697293SDave May   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
44231697293SDave May   ierr = PetscObjectAppendOptionsPrefix((PetscObject)dm,prefix);CHKERRQ(ierr);
44331697293SDave May   PetscFunctionReturn(0);
44431697293SDave May }
44531697293SDave May 
44631697293SDave May #undef __FUNCT__
44731697293SDave May #define __FUNCT__ "DMGetOptionsPrefix"
44831697293SDave May /*@C
44931697293SDave May    DMGetOptionsPrefix - Gets the prefix used for searching for all
45031697293SDave May    DM options in the database.
45131697293SDave May 
45231697293SDave May    Not Collective
45331697293SDave May 
45431697293SDave May    Input Parameters:
45531697293SDave May .  dm - the DM context
45631697293SDave May 
45731697293SDave May    Output Parameters:
45831697293SDave May .  prefix - pointer to the prefix string used is returned
45931697293SDave May 
46031697293SDave May    Notes: On the fortran side, the user should pass in a string 'prefix' of
46131697293SDave May    sufficient length to hold the prefix.
46231697293SDave May 
46331697293SDave May    Level: advanced
46431697293SDave May 
46531697293SDave May .keywords: DM, set, options, prefix, database
46631697293SDave May 
46731697293SDave May .seealso: DMSetOptionsPrefix(), DMAppendOptionsPrefix()
46831697293SDave May @*/
46931697293SDave May PetscErrorCode  DMGetOptionsPrefix(DM dm,const char *prefix[])
47031697293SDave May {
47131697293SDave May   PetscErrorCode ierr;
47231697293SDave May 
47331697293SDave May   PetscFunctionBegin;
47431697293SDave May   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
47531697293SDave May   ierr = PetscObjectGetOptionsPrefix((PetscObject)dm,prefix);CHKERRQ(ierr);
47631697293SDave May   PetscFunctionReturn(0);
47731697293SDave May }
47831697293SDave May 
47931697293SDave May #undef __FUNCT__
48088bdff64SToby Isaac #define __FUNCT__ "DMCountNonCyclicReferences"
48188bdff64SToby Isaac static PetscErrorCode DMCountNonCyclicReferences(DM dm, PetscBool recurseCoarse, PetscBool recurseFine, PetscInt *ncrefct)
48288bdff64SToby Isaac {
48388bdff64SToby Isaac   PetscInt i, refct = ((PetscObject) dm)->refct;
48488bdff64SToby Isaac   DMNamedVecLink nlink;
48588bdff64SToby Isaac   PetscErrorCode ierr;
48688bdff64SToby Isaac 
48788bdff64SToby Isaac   PetscFunctionBegin;
48888bdff64SToby Isaac   /* count all the circular references of DM and its contained Vecs */
48988bdff64SToby Isaac   for (i=0; i<DM_MAX_WORK_VECTORS; i++) {
49088bdff64SToby Isaac     if (dm->localin[i])  refct--;
49188bdff64SToby Isaac     if (dm->globalin[i]) refct--;
49288bdff64SToby Isaac   }
49388bdff64SToby Isaac   for (nlink=dm->namedglobal; nlink; nlink=nlink->next) refct--;
49488bdff64SToby Isaac   for (nlink=dm->namedlocal; nlink; nlink=nlink->next) refct--;
49588bdff64SToby Isaac   if (dm->x) {
49688bdff64SToby Isaac     DM obj;
49788bdff64SToby Isaac     ierr = VecGetDM(dm->x, &obj);CHKERRQ(ierr);
49888bdff64SToby Isaac     if (obj == dm) refct--;
49988bdff64SToby Isaac   }
50088bdff64SToby Isaac   if (dm->coarseMesh && dm->coarseMesh->fineMesh == dm) {
50188bdff64SToby Isaac     refct--;
50288bdff64SToby Isaac     if (recurseCoarse) {
50388bdff64SToby Isaac       PetscInt coarseCount;
50488bdff64SToby Isaac 
50588bdff64SToby Isaac       ierr = DMCountNonCyclicReferences(dm->coarseMesh, PETSC_TRUE, PETSC_FALSE,&coarseCount);CHKERRQ(ierr);
50688bdff64SToby Isaac       refct += coarseCount;
50788bdff64SToby Isaac     }
50888bdff64SToby Isaac   }
50988bdff64SToby Isaac   if (dm->fineMesh && dm->fineMesh->coarseMesh == dm) {
51088bdff64SToby Isaac     refct--;
51188bdff64SToby Isaac     if (recurseFine) {
51288bdff64SToby Isaac       PetscInt fineCount;
51388bdff64SToby Isaac 
51488bdff64SToby Isaac       ierr = DMCountNonCyclicReferences(dm->fineMesh, PETSC_FALSE, PETSC_TRUE,&fineCount);CHKERRQ(ierr);
51588bdff64SToby Isaac       refct += fineCount;
51688bdff64SToby Isaac     }
51788bdff64SToby Isaac   }
51888bdff64SToby Isaac   *ncrefct = refct;
51988bdff64SToby Isaac   PetscFunctionReturn(0);
52088bdff64SToby Isaac }
52188bdff64SToby Isaac 
522bcc5ffd9SToby Isaac PetscErrorCode DMBoundaryDestroy(DMBoundaryLinkList *boundary);
523a6ba4734SToby Isaac 
52488bdff64SToby Isaac #undef __FUNCT__
525354557abSToby Isaac #define __FUNCT__ "DMDestroyLabelLinkList"
526354557abSToby Isaac PetscErrorCode DMDestroyLabelLinkList(DM dm)
527354557abSToby Isaac {
528354557abSToby Isaac   PetscErrorCode ierr;
529354557abSToby Isaac 
530354557abSToby Isaac   PetscFunctionBegin;
531354557abSToby Isaac   if (!--(dm->labels->refct)) {
532354557abSToby Isaac     DMLabelLink next = dm->labels->next;
533354557abSToby Isaac 
534354557abSToby Isaac     /* destroy the labels */
535354557abSToby Isaac     while (next) {
536354557abSToby Isaac       DMLabelLink tmp = next->next;
537354557abSToby Isaac 
538354557abSToby Isaac       ierr = DMLabelDestroy(&next->label);CHKERRQ(ierr);
539354557abSToby Isaac       ierr = PetscFree(next);CHKERRQ(ierr);
540354557abSToby Isaac       next = tmp;
541354557abSToby Isaac     }
542354557abSToby Isaac     ierr = PetscFree(dm->labels);CHKERRQ(ierr);
543354557abSToby Isaac   }
544354557abSToby Isaac   PetscFunctionReturn(0);
545354557abSToby Isaac }
546354557abSToby Isaac 
547354557abSToby Isaac #undef __FUNCT__
54847c6ae99SBarry Smith #define __FUNCT__ "DMDestroy"
54947c6ae99SBarry Smith /*@
5508472ad0fSDave May     DMDestroy - Destroys a vector packer or DM.
55147c6ae99SBarry Smith 
55247c6ae99SBarry Smith     Collective on DM
55347c6ae99SBarry Smith 
55447c6ae99SBarry Smith     Input Parameter:
55547c6ae99SBarry Smith .   dm - the DM object to destroy
55647c6ae99SBarry Smith 
55747c6ae99SBarry Smith     Level: developer
55847c6ae99SBarry Smith 
559e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
56047c6ae99SBarry Smith 
56147c6ae99SBarry Smith @*/
562fcfd50ebSBarry Smith PetscErrorCode  DMDestroy(DM *dm)
56347c6ae99SBarry Smith {
56488bdff64SToby Isaac   PetscInt       i, cnt;
565dfe15315SJed Brown   DMNamedVecLink nlink,nnext;
56647c6ae99SBarry Smith   PetscErrorCode ierr;
56747c6ae99SBarry Smith 
56847c6ae99SBarry Smith   PetscFunctionBegin;
5696bf464f9SBarry Smith   if (!*dm) PetscFunctionReturn(0);
5706bf464f9SBarry Smith   PetscValidHeaderSpecific((*dm),DM_CLASSID,1);
57187e657c6SBarry Smith 
57288bdff64SToby Isaac   /* count all non-cyclic references in the doubly-linked list of coarse<->fine meshes */
57388bdff64SToby Isaac   ierr = DMCountNonCyclicReferences(*dm,PETSC_TRUE,PETSC_TRUE,&cnt);CHKERRQ(ierr);
57488bdff64SToby Isaac   --((PetscObject)(*dm))->refct;
57588bdff64SToby Isaac   if (--cnt > 0) {*dm = 0; PetscFunctionReturn(0);}
576732e2eb9SMatthew G Knepley   /*
577732e2eb9SMatthew G Knepley      Need this test because the dm references the vectors that
578732e2eb9SMatthew G Knepley      reference the dm, so destroying the dm calls destroy on the
579732e2eb9SMatthew G Knepley      vectors that cause another destroy on the dm
580732e2eb9SMatthew G Knepley   */
5816bf464f9SBarry Smith   if (((PetscObject)(*dm))->refct < 0) PetscFunctionReturn(0);
5826bf464f9SBarry Smith   ((PetscObject) (*dm))->refct = 0;
583732e2eb9SMatthew G Knepley   for (i=0; i<DM_MAX_WORK_VECTORS; i++) {
5846bf464f9SBarry Smith     if ((*dm)->localout[i]) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Destroying a DM that has a local vector obtained with DMGetLocalVector()");
5856bf464f9SBarry Smith     ierr = VecDestroy(&(*dm)->localin[i]);CHKERRQ(ierr);
586732e2eb9SMatthew G Knepley   }
587f490541aSPeter Brune   nnext=(*dm)->namedglobal;
5880298fd71SBarry Smith   (*dm)->namedglobal = NULL;
589f490541aSPeter Brune   for (nlink=nnext; nlink; nlink=nnext) { /* Destroy the named vectors */
5902348bcf4SPeter Brune     nnext = nlink->next;
5912348bcf4SPeter 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);
5922348bcf4SPeter Brune     ierr = PetscFree(nlink->name);CHKERRQ(ierr);
5932348bcf4SPeter Brune     ierr = VecDestroy(&nlink->X);CHKERRQ(ierr);
5942348bcf4SPeter Brune     ierr = PetscFree(nlink);CHKERRQ(ierr);
5952348bcf4SPeter Brune   }
596f490541aSPeter Brune   nnext=(*dm)->namedlocal;
5970298fd71SBarry Smith   (*dm)->namedlocal = NULL;
598f490541aSPeter Brune   for (nlink=nnext; nlink; nlink=nnext) { /* Destroy the named local vectors */
599f490541aSPeter Brune     nnext = nlink->next;
600f490541aSPeter 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);
601f490541aSPeter Brune     ierr = PetscFree(nlink->name);CHKERRQ(ierr);
602f490541aSPeter Brune     ierr = VecDestroy(&nlink->X);CHKERRQ(ierr);
603f490541aSPeter Brune     ierr = PetscFree(nlink);CHKERRQ(ierr);
604f490541aSPeter Brune   }
6052348bcf4SPeter Brune 
606b17ce1afSJed Brown   /* Destroy the list of hooks */
607c833c3b5SJed Brown   {
608c833c3b5SJed Brown     DMCoarsenHookLink link,next;
609b17ce1afSJed Brown     for (link=(*dm)->coarsenhook; link; link=next) {
610b17ce1afSJed Brown       next = link->next;
611b17ce1afSJed Brown       ierr = PetscFree(link);CHKERRQ(ierr);
612b17ce1afSJed Brown     }
6130298fd71SBarry Smith     (*dm)->coarsenhook = NULL;
614c833c3b5SJed Brown   }
615c833c3b5SJed Brown   {
616c833c3b5SJed Brown     DMRefineHookLink link,next;
617c833c3b5SJed Brown     for (link=(*dm)->refinehook; link; link=next) {
618c833c3b5SJed Brown       next = link->next;
619c833c3b5SJed Brown       ierr = PetscFree(link);CHKERRQ(ierr);
620c833c3b5SJed Brown     }
6210298fd71SBarry Smith     (*dm)->refinehook = NULL;
622c833c3b5SJed Brown   }
623be081cd6SPeter Brune   {
624be081cd6SPeter Brune     DMSubDomainHookLink link,next;
625be081cd6SPeter Brune     for (link=(*dm)->subdomainhook; link; link=next) {
626be081cd6SPeter Brune       next = link->next;
627be081cd6SPeter Brune       ierr = PetscFree(link);CHKERRQ(ierr);
628be081cd6SPeter Brune     }
6290298fd71SBarry Smith     (*dm)->subdomainhook = NULL;
630be081cd6SPeter Brune   }
631baf369e7SPeter Brune   {
632baf369e7SPeter Brune     DMGlobalToLocalHookLink link,next;
633baf369e7SPeter Brune     for (link=(*dm)->gtolhook; link; link=next) {
634baf369e7SPeter Brune       next = link->next;
635baf369e7SPeter Brune       ierr = PetscFree(link);CHKERRQ(ierr);
636baf369e7SPeter Brune     }
6370298fd71SBarry Smith     (*dm)->gtolhook = NULL;
638baf369e7SPeter Brune   }
639d4d07f1eSToby Isaac   {
640d4d07f1eSToby Isaac     DMLocalToGlobalHookLink link,next;
641d4d07f1eSToby Isaac     for (link=(*dm)->ltoghook; link; link=next) {
642d4d07f1eSToby Isaac       next = link->next;
643d4d07f1eSToby Isaac       ierr = PetscFree(link);CHKERRQ(ierr);
644d4d07f1eSToby Isaac     }
645d4d07f1eSToby Isaac     (*dm)->ltoghook = NULL;
646d4d07f1eSToby Isaac   }
647aa1993deSMatthew G Knepley   /* Destroy the work arrays */
648aa1993deSMatthew G Knepley   {
649aa1993deSMatthew G Knepley     DMWorkLink link,next;
650aa1993deSMatthew G Knepley     if ((*dm)->workout) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Work array still checked out");
651aa1993deSMatthew G Knepley     for (link=(*dm)->workin; link; link=next) {
652aa1993deSMatthew G Knepley       next = link->next;
653aa1993deSMatthew G Knepley       ierr = PetscFree(link->mem);CHKERRQ(ierr);
654aa1993deSMatthew G Knepley       ierr = PetscFree(link);CHKERRQ(ierr);
655aa1993deSMatthew G Knepley     }
6560298fd71SBarry Smith     (*dm)->workin = NULL;
657aa1993deSMatthew G Knepley   }
658c58f1c22SToby Isaac   if (!--((*dm)->labels->refct)) {
659c58f1c22SToby Isaac     DMLabelLink next = (*dm)->labels->next;
660c58f1c22SToby Isaac 
661c58f1c22SToby Isaac     /* destroy the labels */
662c58f1c22SToby Isaac     while (next) {
663c58f1c22SToby Isaac       DMLabelLink tmp = next->next;
664c58f1c22SToby Isaac 
665c58f1c22SToby Isaac       ierr = DMLabelDestroy(&next->label);CHKERRQ(ierr);
666c58f1c22SToby Isaac       ierr = PetscFree(next);CHKERRQ(ierr);
667c58f1c22SToby Isaac       next = tmp;
668c58f1c22SToby Isaac     }
669c58f1c22SToby Isaac     ierr = PetscFree((*dm)->labels);CHKERRQ(ierr);
670c58f1c22SToby Isaac   }
671bcc5ffd9SToby Isaac   ierr = DMBoundaryDestroy(&(*dm)->boundary);CHKERRQ(ierr);
672b17ce1afSJed Brown 
67352536dc3SBarry Smith   ierr = PetscObjectDestroy(&(*dm)->dmksp);CHKERRQ(ierr);
67452536dc3SBarry Smith   ierr = PetscObjectDestroy(&(*dm)->dmsnes);CHKERRQ(ierr);
67552536dc3SBarry Smith   ierr = PetscObjectDestroy(&(*dm)->dmts);CHKERRQ(ierr);
67652536dc3SBarry Smith 
6771a266240SBarry Smith   if ((*dm)->ctx && (*dm)->ctxdestroy) {
6781a266240SBarry Smith     ierr = (*(*dm)->ctxdestroy)(&(*dm)->ctx);CHKERRQ(ierr);
6791a266240SBarry Smith   }
68087e657c6SBarry Smith   ierr = VecDestroy(&(*dm)->x);CHKERRQ(ierr);
68171cd77b2SBarry Smith   ierr = MatFDColoringDestroy(&(*dm)->fd);CHKERRQ(ierr);
6824dcab191SBarry Smith   ierr = DMClearGlobalVectors(*dm);CHKERRQ(ierr);
6836bf464f9SBarry Smith   ierr = ISLocalToGlobalMappingDestroy(&(*dm)->ltogmap);CHKERRQ(ierr);
6846bf464f9SBarry Smith   ierr = PetscFree((*dm)->vectype);CHKERRQ(ierr);
685073dac72SJed Brown   ierr = PetscFree((*dm)->mattype);CHKERRQ(ierr);
68688ed4aceSMatthew G Knepley 
68788ed4aceSMatthew G Knepley   ierr = PetscSectionDestroy(&(*dm)->defaultSection);CHKERRQ(ierr);
68888ed4aceSMatthew G Knepley   ierr = PetscSectionDestroy(&(*dm)->defaultGlobalSection);CHKERRQ(ierr);
6898b1ab98fSJed Brown   ierr = PetscLayoutDestroy(&(*dm)->map);CHKERRQ(ierr);
690fba222abSToby Isaac   ierr = PetscSectionDestroy(&(*dm)->defaultConstraintSection);CHKERRQ(ierr);
691fba222abSToby Isaac   ierr = MatDestroy(&(*dm)->defaultConstraintMat);CHKERRQ(ierr);
69288ed4aceSMatthew G Knepley   ierr = PetscSFDestroy(&(*dm)->sf);CHKERRQ(ierr);
69388ed4aceSMatthew G Knepley   ierr = PetscSFDestroy(&(*dm)->defaultSF);CHKERRQ(ierr);
6948e4ac7eaSMatthew G. Knepley   ierr = PetscSFDestroy(&(*dm)->sfNatural);CHKERRQ(ierr);
695af122d2aSMatthew G Knepley 
69688bdff64SToby Isaac   if ((*dm)->coarseMesh && (*dm)->coarseMesh->fineMesh == *dm) {
69788bdff64SToby Isaac     ierr = DMSetFineDM((*dm)->coarseMesh,NULL);CHKERRQ(ierr);
69888bdff64SToby Isaac   }
699a8fb8f29SToby Isaac   ierr = DMDestroy(&(*dm)->coarseMesh);CHKERRQ(ierr);
70088bdff64SToby Isaac   if ((*dm)->fineMesh && (*dm)->fineMesh->coarseMesh == *dm) {
70188bdff64SToby Isaac     ierr = DMSetCoarseDM((*dm)->fineMesh,NULL);CHKERRQ(ierr);
70288bdff64SToby Isaac   }
70388bdff64SToby Isaac   ierr = DMDestroy(&(*dm)->fineMesh);CHKERRQ(ierr);
7046636e97aSMatthew G Knepley   ierr = DMDestroy(&(*dm)->coordinateDM);CHKERRQ(ierr);
7056636e97aSMatthew G Knepley   ierr = VecDestroy(&(*dm)->coordinates);CHKERRQ(ierr);
7066636e97aSMatthew G Knepley   ierr = VecDestroy(&(*dm)->coordinatesLocal);CHKERRQ(ierr);
7075dc8c3f7SMatthew G. Knepley   ierr = PetscFree3((*dm)->L,(*dm)->maxCell,(*dm)->bdtype);CHKERRQ(ierr);
7086636e97aSMatthew G Knepley 
7092764a2aaSMatthew G. Knepley   ierr = PetscDSDestroy(&(*dm)->prob);CHKERRQ(ierr);
71014f150ffSMatthew G. Knepley   ierr = DMDestroy(&(*dm)->dmBC);CHKERRQ(ierr);
711e04113cfSBarry Smith   /* if memory was published with SAWs then destroy it */
712e04113cfSBarry Smith   ierr = PetscObjectSAWsViewOff((PetscObject)*dm);CHKERRQ(ierr);
713732e2eb9SMatthew G Knepley 
7146bf464f9SBarry Smith   ierr = (*(*dm)->ops->destroy)(*dm);CHKERRQ(ierr);
715435a35e8SMatthew G Knepley   /* We do not destroy (*dm)->data here so that we can reference count backend objects */
716732e2eb9SMatthew G Knepley   ierr = PetscHeaderDestroy(dm);CHKERRQ(ierr);
71747c6ae99SBarry Smith   PetscFunctionReturn(0);
71847c6ae99SBarry Smith }
71947c6ae99SBarry Smith 
72047c6ae99SBarry Smith #undef __FUNCT__
721d7bf68aeSBarry Smith #define __FUNCT__ "DMSetUp"
722d7bf68aeSBarry Smith /*@
723d7bf68aeSBarry Smith     DMSetUp - sets up the data structures inside a DM object
724d7bf68aeSBarry Smith 
725d7bf68aeSBarry Smith     Collective on DM
726d7bf68aeSBarry Smith 
727d7bf68aeSBarry Smith     Input Parameter:
728d7bf68aeSBarry Smith .   dm - the DM object to setup
729d7bf68aeSBarry Smith 
730d7bf68aeSBarry Smith     Level: developer
731d7bf68aeSBarry Smith 
732e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
733d7bf68aeSBarry Smith 
734d7bf68aeSBarry Smith @*/
7357087cfbeSBarry Smith PetscErrorCode  DMSetUp(DM dm)
736d7bf68aeSBarry Smith {
737d7bf68aeSBarry Smith   PetscErrorCode ierr;
738d7bf68aeSBarry Smith 
739d7bf68aeSBarry Smith   PetscFunctionBegin;
740171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
7418387afaaSJed Brown   if (dm->setupcalled) PetscFunctionReturn(0);
742d7bf68aeSBarry Smith   if (dm->ops->setup) {
743d7bf68aeSBarry Smith     ierr = (*dm->ops->setup)(dm);CHKERRQ(ierr);
744d7bf68aeSBarry Smith   }
7458387afaaSJed Brown   dm->setupcalled = PETSC_TRUE;
746d7bf68aeSBarry Smith   PetscFunctionReturn(0);
747d7bf68aeSBarry Smith }
748d7bf68aeSBarry Smith 
749d7bf68aeSBarry Smith #undef __FUNCT__
750d7bf68aeSBarry Smith #define __FUNCT__ "DMSetFromOptions"
751d7bf68aeSBarry Smith /*@
752d7bf68aeSBarry Smith     DMSetFromOptions - sets parameters in a DM from the options database
753d7bf68aeSBarry Smith 
754d7bf68aeSBarry Smith     Collective on DM
755d7bf68aeSBarry Smith 
756d7bf68aeSBarry Smith     Input Parameter:
757d7bf68aeSBarry Smith .   dm - the DM object to set options for
758d7bf68aeSBarry Smith 
759732e2eb9SMatthew G Knepley     Options Database:
7604164ae61SDominic Meiser +   -dm_preallocate_only - Only preallocate the matrix for DMCreateMatrix(), but do not fill it with zeros
7614164ae61SDominic Meiser .   -dm_vec_type <type>  - type of vector to create inside DM
7624164ae61SDominic Meiser .   -dm_mat_type <type>  - type of matrix to create inside DM
7634164ae61SDominic Meiser -   -dm_coloring_type    - <global or ghosted>
764732e2eb9SMatthew G Knepley 
765d7bf68aeSBarry Smith     Level: developer
766d7bf68aeSBarry Smith 
767e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
768d7bf68aeSBarry Smith 
769d7bf68aeSBarry Smith @*/
7707087cfbeSBarry Smith PetscErrorCode  DMSetFromOptions(DM dm)
771d7bf68aeSBarry Smith {
7727781c08eSBarry Smith   char           typeName[256];
773ca266f36SBarry Smith   PetscBool      flg;
774d7bf68aeSBarry Smith   PetscErrorCode ierr;
775d7bf68aeSBarry Smith 
776d7bf68aeSBarry Smith   PetscFunctionBegin;
777171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
778691be533SLawrence Mitchell   if (dm->sf) {
779691be533SLawrence Mitchell     ierr = PetscSFSetFromOptions(dm->sf);CHKERRQ(ierr);
780691be533SLawrence Mitchell   }
781691be533SLawrence Mitchell   if (dm->defaultSF) {
782691be533SLawrence Mitchell     ierr = PetscSFSetFromOptions(dm->defaultSF);CHKERRQ(ierr);
783691be533SLawrence Mitchell   }
7843194b578SJed Brown   ierr = PetscObjectOptionsBegin((PetscObject)dm);CHKERRQ(ierr);
7850298fd71SBarry 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);
786a264d7a6SBarry Smith   ierr = PetscOptionsFList("-dm_vec_type","Vector type used for created vectors","DMSetVecType",VecList,dm->vectype,typeName,256,&flg);CHKERRQ(ierr);
787f9ba7244SBarry Smith   if (flg) {
788f9ba7244SBarry Smith     ierr = DMSetVecType(dm,typeName);CHKERRQ(ierr);
789f9ba7244SBarry Smith   }
790a264d7a6SBarry 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);
791073dac72SJed Brown   if (flg) {
792521d9a4cSLisandro Dalcin     ierr = DMSetMatType(dm,typeName);CHKERRQ(ierr);
793073dac72SJed Brown   }
7940298fd71SBarry Smith   ierr = PetscOptionsEnum("-dm_is_coloring_type","Global or local coloring of Jacobian","ISColoringType",ISColoringTypes,(PetscEnum)dm->coloringtype,(PetscEnum*)&dm->coloringtype,NULL);CHKERRQ(ierr);
795f9ba7244SBarry Smith   if (dm->ops->setfromoptions) {
796e55864a3SBarry Smith     ierr = (*dm->ops->setfromoptions)(PetscOptionsObject,dm);CHKERRQ(ierr);
797f9ba7244SBarry Smith   }
798f9ba7244SBarry Smith   /* process any options handlers added with PetscObjectAddOptionsHandler() */
7990633abcbSJed Brown   ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject) dm);CHKERRQ(ierr);
80082fcb398SMatthew G Knepley   ierr = PetscOptionsEnd();CHKERRQ(ierr);
801d7bf68aeSBarry Smith   PetscFunctionReturn(0);
802d7bf68aeSBarry Smith }
803d7bf68aeSBarry Smith 
804d7bf68aeSBarry Smith #undef __FUNCT__
80547c6ae99SBarry Smith #define __FUNCT__ "DMView"
806fc9bc008SSatish Balay /*@C
807224748a4SBarry Smith     DMView - Views a DM
80847c6ae99SBarry Smith 
80947c6ae99SBarry Smith     Collective on DM
81047c6ae99SBarry Smith 
81147c6ae99SBarry Smith     Input Parameter:
81247c6ae99SBarry Smith +   dm - the DM object to view
81347c6ae99SBarry Smith -   v - the viewer
81447c6ae99SBarry Smith 
815224748a4SBarry Smith     Level: beginner
81647c6ae99SBarry Smith 
817e727c939SJed Brown .seealso DMDestroy(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
81847c6ae99SBarry Smith 
81947c6ae99SBarry Smith @*/
8207087cfbeSBarry Smith PetscErrorCode  DMView(DM dm,PetscViewer v)
82147c6ae99SBarry Smith {
82247c6ae99SBarry Smith   PetscErrorCode ierr;
82332c0f0efSBarry Smith   PetscBool      isbinary;
82447c6ae99SBarry Smith 
82547c6ae99SBarry Smith   PetscFunctionBegin;
826171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
8273014e516SBarry Smith   if (!v) {
828ce94432eSBarry Smith     ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)dm),&v);CHKERRQ(ierr);
8293014e516SBarry Smith   }
83098c3331eSBarry Smith   ierr = PetscObjectPrintClassNamePrefixType((PetscObject)dm,v);CHKERRQ(ierr);
83132c0f0efSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)v,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
83232c0f0efSBarry Smith   if (isbinary) {
83355849f57SBarry Smith     PetscInt classid = DM_FILE_CLASSID;
83432c0f0efSBarry Smith     char     type[256];
83532c0f0efSBarry Smith 
83632c0f0efSBarry Smith     ierr = PetscViewerBinaryWrite(v,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
83732c0f0efSBarry Smith     ierr = PetscStrncpy(type,((PetscObject)dm)->type_name,256);CHKERRQ(ierr);
83832c0f0efSBarry Smith     ierr = PetscViewerBinaryWrite(v,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr);
83932c0f0efSBarry Smith   }
8400c010503SBarry Smith   if (dm->ops->view) {
8410c010503SBarry Smith     ierr = (*dm->ops->view)(dm,v);CHKERRQ(ierr);
84247c6ae99SBarry Smith   }
84347c6ae99SBarry Smith   PetscFunctionReturn(0);
84447c6ae99SBarry Smith }
84547c6ae99SBarry Smith 
84647c6ae99SBarry Smith #undef __FUNCT__
84747c6ae99SBarry Smith #define __FUNCT__ "DMCreateGlobalVector"
84847c6ae99SBarry Smith /*@
8498472ad0fSDave May     DMCreateGlobalVector - Creates a global vector from a DM object
85047c6ae99SBarry Smith 
85147c6ae99SBarry Smith     Collective on DM
85247c6ae99SBarry Smith 
85347c6ae99SBarry Smith     Input Parameter:
85447c6ae99SBarry Smith .   dm - the DM object
85547c6ae99SBarry Smith 
85647c6ae99SBarry Smith     Output Parameter:
85747c6ae99SBarry Smith .   vec - the global vector
85847c6ae99SBarry Smith 
859073dac72SJed Brown     Level: beginner
86047c6ae99SBarry Smith 
861e727c939SJed Brown .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
86247c6ae99SBarry Smith 
86347c6ae99SBarry Smith @*/
8647087cfbeSBarry Smith PetscErrorCode  DMCreateGlobalVector(DM dm,Vec *vec)
86547c6ae99SBarry Smith {
86647c6ae99SBarry Smith   PetscErrorCode ierr;
86747c6ae99SBarry Smith 
86847c6ae99SBarry Smith   PetscFunctionBegin;
869171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
87047c6ae99SBarry Smith   ierr = (*dm->ops->createglobalvector)(dm,vec);CHKERRQ(ierr);
87147c6ae99SBarry Smith   PetscFunctionReturn(0);
87247c6ae99SBarry Smith }
87347c6ae99SBarry Smith 
87447c6ae99SBarry Smith #undef __FUNCT__
87547c6ae99SBarry Smith #define __FUNCT__ "DMCreateLocalVector"
87647c6ae99SBarry Smith /*@
8778472ad0fSDave May     DMCreateLocalVector - Creates a local vector from a DM object
87847c6ae99SBarry Smith 
87947c6ae99SBarry Smith     Not Collective
88047c6ae99SBarry Smith 
88147c6ae99SBarry Smith     Input Parameter:
88247c6ae99SBarry Smith .   dm - the DM object
88347c6ae99SBarry Smith 
88447c6ae99SBarry Smith     Output Parameter:
88547c6ae99SBarry Smith .   vec - the local vector
88647c6ae99SBarry Smith 
887073dac72SJed Brown     Level: beginner
88847c6ae99SBarry Smith 
889e727c939SJed Brown .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
89047c6ae99SBarry Smith 
89147c6ae99SBarry Smith @*/
8927087cfbeSBarry Smith PetscErrorCode  DMCreateLocalVector(DM dm,Vec *vec)
89347c6ae99SBarry Smith {
89447c6ae99SBarry Smith   PetscErrorCode ierr;
89547c6ae99SBarry Smith 
89647c6ae99SBarry Smith   PetscFunctionBegin;
897171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
89847c6ae99SBarry Smith   ierr = (*dm->ops->createlocalvector)(dm,vec);CHKERRQ(ierr);
89947c6ae99SBarry Smith   PetscFunctionReturn(0);
90047c6ae99SBarry Smith }
90147c6ae99SBarry Smith 
90247c6ae99SBarry Smith #undef __FUNCT__
9031411c6eeSJed Brown #define __FUNCT__ "DMGetLocalToGlobalMapping"
9041411c6eeSJed Brown /*@
9051411c6eeSJed Brown    DMGetLocalToGlobalMapping - Accesses the local-to-global mapping in a DM.
9061411c6eeSJed Brown 
9071411c6eeSJed Brown    Collective on DM
9081411c6eeSJed Brown 
9091411c6eeSJed Brown    Input Parameter:
9101411c6eeSJed Brown .  dm - the DM that provides the mapping
9111411c6eeSJed Brown 
9121411c6eeSJed Brown    Output Parameter:
9131411c6eeSJed Brown .  ltog - the mapping
9141411c6eeSJed Brown 
9151411c6eeSJed Brown    Level: intermediate
9161411c6eeSJed Brown 
9171411c6eeSJed Brown    Notes:
9181411c6eeSJed Brown    This mapping can then be used by VecSetLocalToGlobalMapping() or
9191411c6eeSJed Brown    MatSetLocalToGlobalMapping().
9201411c6eeSJed Brown 
921fc31e74dSBarry Smith .seealso: DMCreateLocalVector()
9221411c6eeSJed Brown @*/
9237087cfbeSBarry Smith PetscErrorCode  DMGetLocalToGlobalMapping(DM dm,ISLocalToGlobalMapping *ltog)
9241411c6eeSJed Brown {
9251411c6eeSJed Brown   PetscErrorCode ierr;
9261411c6eeSJed Brown 
9271411c6eeSJed Brown   PetscFunctionBegin;
9281411c6eeSJed Brown   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
9291411c6eeSJed Brown   PetscValidPointer(ltog,2);
9301411c6eeSJed Brown   if (!dm->ltogmap) {
93137d0c07bSMatthew G Knepley     PetscSection section, sectionGlobal;
93237d0c07bSMatthew G Knepley 
93337d0c07bSMatthew G Knepley     ierr = DMGetDefaultSection(dm, &section);CHKERRQ(ierr);
93437d0c07bSMatthew G Knepley     if (section) {
93537d0c07bSMatthew G Knepley       PetscInt *ltog;
93637d0c07bSMatthew G Knepley       PetscInt pStart, pEnd, size, p, l;
93737d0c07bSMatthew G Knepley 
93837d0c07bSMatthew G Knepley       ierr = DMGetDefaultGlobalSection(dm, &sectionGlobal);CHKERRQ(ierr);
93937d0c07bSMatthew G Knepley       ierr = PetscSectionGetChart(section, &pStart, &pEnd);CHKERRQ(ierr);
94037d0c07bSMatthew G Knepley       ierr = PetscSectionGetStorageSize(section, &size);CHKERRQ(ierr);
941785e854fSJed Brown       ierr = PetscMalloc1(size, &ltog);CHKERRQ(ierr); /* We want the local+overlap size */
94237d0c07bSMatthew G Knepley       for (p = pStart, l = 0; p < pEnd; ++p) {
94337d0c07bSMatthew G Knepley         PetscInt dof, off, c;
94437d0c07bSMatthew G Knepley 
94537d0c07bSMatthew G Knepley         /* Should probably use constrained dofs */
94637d0c07bSMatthew G Knepley         ierr = PetscSectionGetDof(section, p, &dof);CHKERRQ(ierr);
94737d0c07bSMatthew G Knepley         ierr = PetscSectionGetOffset(sectionGlobal, p, &off);CHKERRQ(ierr);
94837d0c07bSMatthew G Knepley         for (c = 0; c < dof; ++c, ++l) {
94937d0c07bSMatthew G Knepley           ltog[l] = off+c;
95037d0c07bSMatthew G Knepley         }
95137d0c07bSMatthew G Knepley       }
952f0413b6fSBarry Smith       ierr = ISLocalToGlobalMappingCreate(PETSC_COMM_SELF, 1,size, ltog, PETSC_OWN_POINTER, &dm->ltogmap);CHKERRQ(ierr);
9533bb1ff40SBarry Smith       ierr = PetscLogObjectParent((PetscObject)dm, (PetscObject)dm->ltogmap);CHKERRQ(ierr);
95437d0c07bSMatthew G Knepley     } else {
955184d77edSJed Brown       if (!dm->ops->getlocaltoglobalmapping) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM can not create LocalToGlobalMapping");
956184d77edSJed Brown       ierr = (*dm->ops->getlocaltoglobalmapping)(dm);CHKERRQ(ierr);
9571411c6eeSJed Brown     }
95837d0c07bSMatthew G Knepley   }
9591411c6eeSJed Brown   *ltog = dm->ltogmap;
9601411c6eeSJed Brown   PetscFunctionReturn(0);
9611411c6eeSJed Brown }
9621411c6eeSJed Brown 
9631411c6eeSJed Brown #undef __FUNCT__
9641411c6eeSJed Brown #define __FUNCT__ "DMGetBlockSize"
9651411c6eeSJed Brown /*@
9661411c6eeSJed Brown    DMGetBlockSize - Gets the inherent block size associated with a DM
9671411c6eeSJed Brown 
9681411c6eeSJed Brown    Not Collective
9691411c6eeSJed Brown 
9701411c6eeSJed Brown    Input Parameter:
9711411c6eeSJed Brown .  dm - the DM with block structure
9721411c6eeSJed Brown 
9731411c6eeSJed Brown    Output Parameter:
9741411c6eeSJed Brown .  bs - the block size, 1 implies no exploitable block structure
9751411c6eeSJed Brown 
9761411c6eeSJed Brown    Level: intermediate
9771411c6eeSJed Brown 
978fc31e74dSBarry Smith .seealso: ISCreateBlock(), VecSetBlockSize(), MatSetBlockSize(), DMGetLocalToGlobalMapping()
9791411c6eeSJed Brown @*/
9807087cfbeSBarry Smith PetscErrorCode  DMGetBlockSize(DM dm,PetscInt *bs)
9811411c6eeSJed Brown {
9821411c6eeSJed Brown   PetscFunctionBegin;
9831411c6eeSJed Brown   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
9841411c6eeSJed Brown   PetscValidPointer(bs,2);
9851411c6eeSJed 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");
9861411c6eeSJed Brown   *bs = dm->bs;
9871411c6eeSJed Brown   PetscFunctionReturn(0);
9881411c6eeSJed Brown }
9891411c6eeSJed Brown 
9901411c6eeSJed Brown #undef __FUNCT__
991e727c939SJed Brown #define __FUNCT__ "DMCreateInterpolation"
99247c6ae99SBarry Smith /*@
9938472ad0fSDave May     DMCreateInterpolation - Gets interpolation matrix between two DM objects
99447c6ae99SBarry Smith 
99547c6ae99SBarry Smith     Collective on DM
99647c6ae99SBarry Smith 
99747c6ae99SBarry Smith     Input Parameter:
99847c6ae99SBarry Smith +   dm1 - the DM object
99947c6ae99SBarry Smith -   dm2 - the second, finer DM object
100047c6ae99SBarry Smith 
100147c6ae99SBarry Smith     Output Parameter:
100247c6ae99SBarry Smith +  mat - the interpolation
100347c6ae99SBarry Smith -  vec - the scaling (optional)
100447c6ae99SBarry Smith 
100547c6ae99SBarry Smith     Level: developer
100647c6ae99SBarry Smith 
100785afcc9aSBarry 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
100885afcc9aSBarry Smith         DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the interpolation.
1009d52bd9f3SBarry Smith 
10101f588964SMatthew G Knepley         For DMDA objects you can use this interpolation (more precisely the interpolation from the DMGetCoordinateDM()) to interpolate the mesh coordinate vectors
1011d52bd9f3SBarry Smith         EXCEPT in the periodic case where it does not make sense since the coordinate vectors are not periodic.
101285afcc9aSBarry Smith 
101385afcc9aSBarry Smith 
1014e727c939SJed Brown .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMRefine(), DMCoarsen()
101547c6ae99SBarry Smith 
101647c6ae99SBarry Smith @*/
1017e727c939SJed Brown PetscErrorCode  DMCreateInterpolation(DM dm1,DM dm2,Mat *mat,Vec *vec)
101847c6ae99SBarry Smith {
101947c6ae99SBarry Smith   PetscErrorCode ierr;
102047c6ae99SBarry Smith 
102147c6ae99SBarry Smith   PetscFunctionBegin;
1022171400e9SBarry Smith   PetscValidHeaderSpecific(dm1,DM_CLASSID,1);
1023171400e9SBarry Smith   PetscValidHeaderSpecific(dm2,DM_CLASSID,2);
1024cea54e9dSPatrick Farrell   ierr = PetscLogEventBegin(DM_CreateInterpolation,dm1,dm2,0,0);CHKERRQ(ierr);
102525296bd5SBarry Smith   ierr = (*dm1->ops->createinterpolation)(dm1,dm2,mat,vec);CHKERRQ(ierr);
1026cea54e9dSPatrick Farrell   ierr = PetscLogEventEnd(DM_CreateInterpolation,dm1,dm2,0,0);CHKERRQ(ierr);
102747c6ae99SBarry Smith   PetscFunctionReturn(0);
102847c6ae99SBarry Smith }
102947c6ae99SBarry Smith 
103047c6ae99SBarry Smith #undef __FUNCT__
1031e727c939SJed Brown #define __FUNCT__ "DMCreateInjection"
103247c6ae99SBarry Smith /*@
10338472ad0fSDave May     DMCreateInjection - Gets injection matrix between two DM objects
103447c6ae99SBarry Smith 
103547c6ae99SBarry Smith     Collective on DM
103647c6ae99SBarry Smith 
103747c6ae99SBarry Smith     Input Parameter:
103847c6ae99SBarry Smith +   dm1 - the DM object
103947c6ae99SBarry Smith -   dm2 - the second, finer DM object
104047c6ae99SBarry Smith 
104147c6ae99SBarry Smith     Output Parameter:
10426dbf9973SLawrence Mitchell .   mat - the injection
104347c6ae99SBarry Smith 
104447c6ae99SBarry Smith     Level: developer
104547c6ae99SBarry Smith 
104685afcc9aSBarry 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
104785afcc9aSBarry Smith         DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the injection.
104885afcc9aSBarry Smith 
1049e727c939SJed Brown .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMCreateInterpolation()
105047c6ae99SBarry Smith 
105147c6ae99SBarry Smith @*/
10526dbf9973SLawrence Mitchell PetscErrorCode  DMCreateInjection(DM dm1,DM dm2,Mat *mat)
105347c6ae99SBarry Smith {
105447c6ae99SBarry Smith   PetscErrorCode ierr;
105547c6ae99SBarry Smith 
105647c6ae99SBarry Smith   PetscFunctionBegin;
1057171400e9SBarry Smith   PetscValidHeaderSpecific(dm1,DM_CLASSID,1);
1058171400e9SBarry Smith   PetscValidHeaderSpecific(dm2,DM_CLASSID,2);
10596dbf9973SLawrence Mitchell   ierr = (*dm1->ops->getinjection)(dm1,dm2,mat);CHKERRQ(ierr);
106047c6ae99SBarry Smith   PetscFunctionReturn(0);
106147c6ae99SBarry Smith }
106247c6ae99SBarry Smith 
106347c6ae99SBarry Smith #undef __FUNCT__
1064e727c939SJed Brown #define __FUNCT__ "DMCreateColoring"
1065b412c318SBarry Smith /*@
1066b412c318SBarry Smith     DMCreateColoring - Gets coloring for a DM
106747c6ae99SBarry Smith 
106847c6ae99SBarry Smith     Collective on DM
106947c6ae99SBarry Smith 
107047c6ae99SBarry Smith     Input Parameter:
107147c6ae99SBarry Smith +   dm - the DM object
1072b412c318SBarry Smith -   ctype - IS_COLORING_GHOSTED or IS_COLORING_GLOBAL
107347c6ae99SBarry Smith 
107447c6ae99SBarry Smith     Output Parameter:
107547c6ae99SBarry Smith .   coloring - the coloring
107647c6ae99SBarry Smith 
107747c6ae99SBarry Smith     Level: developer
107847c6ae99SBarry Smith 
1079b412c318SBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateMatrix(), DMSetMatType()
108047c6ae99SBarry Smith 
1081aab9d709SJed Brown @*/
1082b412c318SBarry Smith PetscErrorCode  DMCreateColoring(DM dm,ISColoringType ctype,ISColoring *coloring)
108347c6ae99SBarry Smith {
108447c6ae99SBarry Smith   PetscErrorCode ierr;
108547c6ae99SBarry Smith 
108647c6ae99SBarry Smith   PetscFunctionBegin;
1087171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1088ce94432eSBarry Smith   if (!dm->ops->getcoloring) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"No coloring for this type of DM yet");
1089b412c318SBarry Smith   ierr = (*dm->ops->getcoloring)(dm,ctype,coloring);CHKERRQ(ierr);
109047c6ae99SBarry Smith   PetscFunctionReturn(0);
109147c6ae99SBarry Smith }
109247c6ae99SBarry Smith 
109347c6ae99SBarry Smith #undef __FUNCT__
1094950540a4SJed Brown #define __FUNCT__ "DMCreateMatrix"
1095b412c318SBarry Smith /*@
10968472ad0fSDave May     DMCreateMatrix - Gets empty Jacobian for a DM
109747c6ae99SBarry Smith 
109847c6ae99SBarry Smith     Collective on DM
109947c6ae99SBarry Smith 
110047c6ae99SBarry Smith     Input Parameter:
1101b412c318SBarry Smith .   dm - the DM object
110247c6ae99SBarry Smith 
110347c6ae99SBarry Smith     Output Parameter:
110447c6ae99SBarry Smith .   mat - the empty Jacobian
110547c6ae99SBarry Smith 
1106073dac72SJed Brown     Level: beginner
110747c6ae99SBarry Smith 
110894013140SBarry Smith     Notes: This properly preallocates the number of nonzeros in the sparse matrix so you
110994013140SBarry Smith        do not need to do it yourself.
111094013140SBarry Smith 
111194013140SBarry Smith        By default it also sets the nonzero structure and puts in the zero entries. To prevent setting
1112aa219208SBarry Smith        the nonzero pattern call DMDASetMatPreallocateOnly()
111394013140SBarry Smith 
111494013140SBarry 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
111594013140SBarry Smith        internally by PETSc.
111694013140SBarry Smith 
111794013140SBarry Smith        For structured grid problems, in general it is easiest to use MatSetValuesStencil() or MatSetValuesLocal() to put values into the matrix because MatSetValues() requires
1118aa219208SBarry Smith        the indices for the global numbering for DMDAs which is complicated.
111994013140SBarry Smith 
1120b412c318SBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMSetMatType()
112147c6ae99SBarry Smith 
1122aab9d709SJed Brown @*/
1123b412c318SBarry Smith PetscErrorCode  DMCreateMatrix(DM dm,Mat *mat)
112447c6ae99SBarry Smith {
112547c6ae99SBarry Smith   PetscErrorCode ierr;
112647c6ae99SBarry Smith 
112747c6ae99SBarry Smith   PetscFunctionBegin;
1128171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1129607a6623SBarry Smith   ierr = MatInitializePackage();CHKERRQ(ierr);
1130c7b7c8a4SJed Brown   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1131c7b7c8a4SJed Brown   PetscValidPointer(mat,3);
1132b412c318SBarry Smith   ierr = (*dm->ops->creatematrix)(dm,mat);CHKERRQ(ierr);
113347c6ae99SBarry Smith   PetscFunctionReturn(0);
113447c6ae99SBarry Smith }
113547c6ae99SBarry Smith 
113647c6ae99SBarry Smith #undef __FUNCT__
1137732e2eb9SMatthew G Knepley #define __FUNCT__ "DMSetMatrixPreallocateOnly"
1138732e2eb9SMatthew G Knepley /*@
1139950540a4SJed Brown   DMSetMatrixPreallocateOnly - When DMCreateMatrix() is called the matrix will be properly
1140732e2eb9SMatthew G Knepley     preallocated but the nonzero structure and zero values will not be set.
1141732e2eb9SMatthew G Knepley 
11428472ad0fSDave May   Logically Collective on DM
1143732e2eb9SMatthew G Knepley 
1144732e2eb9SMatthew G Knepley   Input Parameter:
1145732e2eb9SMatthew G Knepley + dm - the DM
1146732e2eb9SMatthew G Knepley - only - PETSC_TRUE if only want preallocation
1147732e2eb9SMatthew G Knepley 
1148732e2eb9SMatthew G Knepley   Level: developer
1149950540a4SJed Brown .seealso DMCreateMatrix()
1150732e2eb9SMatthew G Knepley @*/
1151732e2eb9SMatthew G Knepley PetscErrorCode DMSetMatrixPreallocateOnly(DM dm, PetscBool only)
1152732e2eb9SMatthew G Knepley {
1153732e2eb9SMatthew G Knepley   PetscFunctionBegin;
1154732e2eb9SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1155732e2eb9SMatthew G Knepley   dm->prealloc_only = only;
1156732e2eb9SMatthew G Knepley   PetscFunctionReturn(0);
1157732e2eb9SMatthew G Knepley }
1158732e2eb9SMatthew G Knepley 
1159732e2eb9SMatthew G Knepley #undef __FUNCT__
1160a89ea682SMatthew G Knepley #define __FUNCT__ "DMGetWorkArray"
1161a89ea682SMatthew G Knepley /*@C
1162aa1993deSMatthew G Knepley   DMGetWorkArray - Gets a work array guaranteed to be at least the input size, restore with DMRestoreWorkArray()
1163a89ea682SMatthew G Knepley 
1164a89ea682SMatthew G Knepley   Not Collective
1165a89ea682SMatthew G Knepley 
1166a89ea682SMatthew G Knepley   Input Parameters:
1167a89ea682SMatthew G Knepley + dm - the DM object
1168aa1993deSMatthew G Knepley . count - The minium size
1169aa1993deSMatthew G Knepley - dtype - data type (PETSC_REAL, PETSC_SCALAR, PETSC_INT)
1170a89ea682SMatthew G Knepley 
1171a89ea682SMatthew G Knepley   Output Parameter:
1172a89ea682SMatthew G Knepley . array - the work array
1173a89ea682SMatthew G Knepley 
1174a89ea682SMatthew G Knepley   Level: developer
1175a89ea682SMatthew G Knepley 
1176a89ea682SMatthew G Knepley .seealso DMDestroy(), DMCreate()
1177a89ea682SMatthew G Knepley @*/
1178aa1993deSMatthew G Knepley PetscErrorCode DMGetWorkArray(DM dm,PetscInt count,PetscDataType dtype,void *mem)
1179a89ea682SMatthew G Knepley {
1180a89ea682SMatthew G Knepley   PetscErrorCode ierr;
1181aa1993deSMatthew G Knepley   DMWorkLink     link;
1182854ce69bSBarry Smith   size_t         dsize;
1183a89ea682SMatthew G Knepley 
1184a89ea682SMatthew G Knepley   PetscFunctionBegin;
1185a89ea682SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1186aa1993deSMatthew G Knepley   PetscValidPointer(mem,4);
1187aa1993deSMatthew G Knepley   if (dm->workin) {
1188aa1993deSMatthew G Knepley     link       = dm->workin;
1189aa1993deSMatthew G Knepley     dm->workin = dm->workin->next;
1190aa1993deSMatthew G Knepley   } else {
1191b00a9115SJed Brown     ierr = PetscNewLog(dm,&link);CHKERRQ(ierr);
1192a89ea682SMatthew G Knepley   }
1193854ce69bSBarry Smith   ierr = PetscDataTypeGetSize(dtype,&dsize);CHKERRQ(ierr);
1194854ce69bSBarry Smith   if (dsize*count > link->bytes) {
1195aa1993deSMatthew G Knepley     ierr        = PetscFree(link->mem);CHKERRQ(ierr);
1196854ce69bSBarry Smith     ierr        = PetscMalloc(dsize*count,&link->mem);CHKERRQ(ierr);
1197854ce69bSBarry Smith     link->bytes = dsize*count;
1198aa1993deSMatthew G Knepley   }
1199aa1993deSMatthew G Knepley   link->next   = dm->workout;
1200aa1993deSMatthew G Knepley   dm->workout  = link;
1201aa1993deSMatthew G Knepley   *(void**)mem = link->mem;
1202a89ea682SMatthew G Knepley   PetscFunctionReturn(0);
1203a89ea682SMatthew G Knepley }
1204a89ea682SMatthew G Knepley 
1205aa1993deSMatthew G Knepley #undef __FUNCT__
1206aa1993deSMatthew G Knepley #define __FUNCT__ "DMRestoreWorkArray"
1207aa1993deSMatthew G Knepley /*@C
1208aa1993deSMatthew G Knepley   DMRestoreWorkArray - Restores a work array guaranteed to be at least the input size, restore with DMRestoreWorkArray()
1209aa1993deSMatthew G Knepley 
1210aa1993deSMatthew G Knepley   Not Collective
1211aa1993deSMatthew G Knepley 
1212aa1993deSMatthew G Knepley   Input Parameters:
1213aa1993deSMatthew G Knepley + dm - the DM object
1214aa1993deSMatthew G Knepley . count - The minium size
1215aa1993deSMatthew G Knepley - dtype - data type (PETSC_REAL, PETSC_SCALAR, PETSC_INT)
1216aa1993deSMatthew G Knepley 
1217aa1993deSMatthew G Knepley   Output Parameter:
1218aa1993deSMatthew G Knepley . array - the work array
1219aa1993deSMatthew G Knepley 
1220aa1993deSMatthew G Knepley   Level: developer
1221aa1993deSMatthew G Knepley 
1222aa1993deSMatthew G Knepley .seealso DMDestroy(), DMCreate()
1223aa1993deSMatthew G Knepley @*/
1224aa1993deSMatthew G Knepley PetscErrorCode DMRestoreWorkArray(DM dm,PetscInt count,PetscDataType dtype,void *mem)
1225aa1993deSMatthew G Knepley {
1226aa1993deSMatthew G Knepley   DMWorkLink *p,link;
1227aa1993deSMatthew G Knepley 
1228aa1993deSMatthew G Knepley   PetscFunctionBegin;
1229aa1993deSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1230aa1993deSMatthew G Knepley   PetscValidPointer(mem,4);
1231aa1993deSMatthew G Knepley   for (p=&dm->workout; (link=*p); p=&link->next) {
1232aa1993deSMatthew G Knepley     if (link->mem == *(void**)mem) {
1233aa1993deSMatthew G Knepley       *p           = link->next;
1234aa1993deSMatthew G Knepley       link->next   = dm->workin;
1235aa1993deSMatthew G Knepley       dm->workin   = link;
12360298fd71SBarry Smith       *(void**)mem = NULL;
1237aa1993deSMatthew G Knepley       PetscFunctionReturn(0);
1238aa1993deSMatthew G Knepley     }
1239aa1993deSMatthew G Knepley   }
1240aa1993deSMatthew G Knepley   SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Array was not checked out");
1241aa1993deSMatthew G Knepley }
1242e7c4fc90SDmitry Karpeev 
1243e7c4fc90SDmitry Karpeev #undef __FUNCT__
1244435a35e8SMatthew G Knepley #define __FUNCT__ "DMSetNullSpaceConstructor"
1245435a35e8SMatthew G Knepley PetscErrorCode DMSetNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (*nullsp)(DM dm, PetscInt field, MatNullSpace *nullSpace))
1246435a35e8SMatthew G Knepley {
1247435a35e8SMatthew G Knepley   PetscFunctionBegin;
1248435a35e8SMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
124982f516ccSBarry Smith   if (field >= 10) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field);
1250435a35e8SMatthew G Knepley   dm->nullspaceConstructors[field] = nullsp;
1251435a35e8SMatthew G Knepley   PetscFunctionReturn(0);
1252435a35e8SMatthew G Knepley }
1253435a35e8SMatthew G Knepley 
1254435a35e8SMatthew G Knepley #undef __FUNCT__
12554d343eeaSMatthew G Knepley #define __FUNCT__ "DMCreateFieldIS"
12564f3b5142SJed Brown /*@C
12574d343eeaSMatthew G Knepley   DMCreateFieldIS - Creates a set of IS objects with the global indices of dofs for each field
12584d343eeaSMatthew G Knepley 
12594d343eeaSMatthew G Knepley   Not collective
12604d343eeaSMatthew G Knepley 
12614d343eeaSMatthew G Knepley   Input Parameter:
12624d343eeaSMatthew G Knepley . dm - the DM object
12634d343eeaSMatthew G Knepley 
12644d343eeaSMatthew G Knepley   Output Parameters:
12650298fd71SBarry Smith + numFields  - The number of fields (or NULL if not requested)
12660298fd71SBarry Smith . fieldNames - The name for each field (or NULL if not requested)
12670298fd71SBarry Smith - fields     - The global indices for each field (or NULL if not requested)
12684d343eeaSMatthew G Knepley 
12694d343eeaSMatthew G Knepley   Level: intermediate
12704d343eeaSMatthew G Knepley 
127121c9b008SJed Brown   Notes:
127221c9b008SJed Brown   The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with
127321c9b008SJed Brown   PetscFree(), every entry of fields should be destroyed with ISDestroy(), and both arrays should be freed with
127421c9b008SJed Brown   PetscFree().
127521c9b008SJed Brown 
12764d343eeaSMatthew G Knepley .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
12774d343eeaSMatthew G Knepley @*/
127837d0c07bSMatthew G Knepley PetscErrorCode DMCreateFieldIS(DM dm, PetscInt *numFields, char ***fieldNames, IS **fields)
12794d343eeaSMatthew G Knepley {
128037d0c07bSMatthew G Knepley   PetscSection   section, sectionGlobal;
12814d343eeaSMatthew G Knepley   PetscErrorCode ierr;
12824d343eeaSMatthew G Knepley 
12834d343eeaSMatthew G Knepley   PetscFunctionBegin;
12844d343eeaSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
128569ca1f37SDmitry Karpeev   if (numFields) {
128669ca1f37SDmitry Karpeev     PetscValidPointer(numFields,2);
128769ca1f37SDmitry Karpeev     *numFields = 0;
128869ca1f37SDmitry Karpeev   }
128937d0c07bSMatthew G Knepley   if (fieldNames) {
129037d0c07bSMatthew G Knepley     PetscValidPointer(fieldNames,3);
12910298fd71SBarry Smith     *fieldNames = NULL;
129269ca1f37SDmitry Karpeev   }
129369ca1f37SDmitry Karpeev   if (fields) {
129469ca1f37SDmitry Karpeev     PetscValidPointer(fields,4);
12950298fd71SBarry Smith     *fields = NULL;
129669ca1f37SDmitry Karpeev   }
129737d0c07bSMatthew G Knepley   ierr = DMGetDefaultSection(dm, &section);CHKERRQ(ierr);
129837d0c07bSMatthew G Knepley   if (section) {
129937d0c07bSMatthew G Knepley     PetscInt *fieldSizes, **fieldIndices;
130037d0c07bSMatthew G Knepley     PetscInt nF, f, pStart, pEnd, p;
130137d0c07bSMatthew G Knepley 
130237d0c07bSMatthew G Knepley     ierr = DMGetDefaultGlobalSection(dm, &sectionGlobal);CHKERRQ(ierr);
130337d0c07bSMatthew G Knepley     ierr = PetscSectionGetNumFields(section, &nF);CHKERRQ(ierr);
1304dcca6d9dSJed Brown     ierr = PetscMalloc2(nF,&fieldSizes,nF,&fieldIndices);CHKERRQ(ierr);
130537d0c07bSMatthew G Knepley     ierr = PetscSectionGetChart(sectionGlobal, &pStart, &pEnd);CHKERRQ(ierr);
130637d0c07bSMatthew G Knepley     for (f = 0; f < nF; ++f) {
130737d0c07bSMatthew G Knepley       fieldSizes[f] = 0;
130837d0c07bSMatthew G Knepley     }
130937d0c07bSMatthew G Knepley     for (p = pStart; p < pEnd; ++p) {
131037d0c07bSMatthew G Knepley       PetscInt gdof;
131137d0c07bSMatthew G Knepley 
131237d0c07bSMatthew G Knepley       ierr = PetscSectionGetDof(sectionGlobal, p, &gdof);CHKERRQ(ierr);
131337d0c07bSMatthew G Knepley       if (gdof > 0) {
131437d0c07bSMatthew G Knepley         for (f = 0; f < nF; ++f) {
131537d0c07bSMatthew G Knepley           PetscInt fdof, fcdof;
131637d0c07bSMatthew G Knepley 
131737d0c07bSMatthew G Knepley           ierr           = PetscSectionGetFieldDof(section, p, f, &fdof);CHKERRQ(ierr);
131837d0c07bSMatthew G Knepley           ierr           = PetscSectionGetFieldConstraintDof(section, p, f, &fcdof);CHKERRQ(ierr);
131937d0c07bSMatthew G Knepley           fieldSizes[f] += fdof-fcdof;
132037d0c07bSMatthew G Knepley         }
132137d0c07bSMatthew G Knepley       }
132237d0c07bSMatthew G Knepley     }
132337d0c07bSMatthew G Knepley     for (f = 0; f < nF; ++f) {
1324785e854fSJed Brown       ierr          = PetscMalloc1(fieldSizes[f], &fieldIndices[f]);CHKERRQ(ierr);
132537d0c07bSMatthew G Knepley       fieldSizes[f] = 0;
132637d0c07bSMatthew G Knepley     }
132737d0c07bSMatthew G Knepley     for (p = pStart; p < pEnd; ++p) {
132837d0c07bSMatthew G Knepley       PetscInt gdof, goff;
132937d0c07bSMatthew G Knepley 
133037d0c07bSMatthew G Knepley       ierr = PetscSectionGetDof(sectionGlobal, p, &gdof);CHKERRQ(ierr);
133137d0c07bSMatthew G Knepley       if (gdof > 0) {
133237d0c07bSMatthew G Knepley         ierr = PetscSectionGetOffset(sectionGlobal, p, &goff);CHKERRQ(ierr);
133337d0c07bSMatthew G Knepley         for (f = 0; f < nF; ++f) {
133437d0c07bSMatthew G Knepley           PetscInt fdof, fcdof, fc;
133537d0c07bSMatthew G Knepley 
133637d0c07bSMatthew G Knepley           ierr = PetscSectionGetFieldDof(section, p, f, &fdof);CHKERRQ(ierr);
133737d0c07bSMatthew G Knepley           ierr = PetscSectionGetFieldConstraintDof(section, p, f, &fcdof);CHKERRQ(ierr);
133837d0c07bSMatthew G Knepley           for (fc = 0; fc < fdof-fcdof; ++fc, ++fieldSizes[f]) {
133937d0c07bSMatthew G Knepley             fieldIndices[f][fieldSizes[f]] = goff++;
134037d0c07bSMatthew G Knepley           }
134137d0c07bSMatthew G Knepley         }
134237d0c07bSMatthew G Knepley       }
134337d0c07bSMatthew G Knepley     }
13448865f1eaSKarl Rupp     if (numFields) *numFields = nF;
134537d0c07bSMatthew G Knepley     if (fieldNames) {
1346785e854fSJed Brown       ierr = PetscMalloc1(nF, fieldNames);CHKERRQ(ierr);
134737d0c07bSMatthew G Knepley       for (f = 0; f < nF; ++f) {
134837d0c07bSMatthew G Knepley         const char *fieldName;
134937d0c07bSMatthew G Knepley 
135037d0c07bSMatthew G Knepley         ierr = PetscSectionGetFieldName(section, f, &fieldName);CHKERRQ(ierr);
135137d0c07bSMatthew G Knepley         ierr = PetscStrallocpy(fieldName, (char**) &(*fieldNames)[f]);CHKERRQ(ierr);
135237d0c07bSMatthew G Knepley       }
135337d0c07bSMatthew G Knepley     }
135437d0c07bSMatthew G Knepley     if (fields) {
1355785e854fSJed Brown       ierr = PetscMalloc1(nF, fields);CHKERRQ(ierr);
135637d0c07bSMatthew G Knepley       for (f = 0; f < nF; ++f) {
135782f516ccSBarry Smith         ierr = ISCreateGeneral(PetscObjectComm((PetscObject)dm), fieldSizes[f], fieldIndices[f], PETSC_OWN_POINTER, &(*fields)[f]);CHKERRQ(ierr);
135837d0c07bSMatthew G Knepley       }
135937d0c07bSMatthew G Knepley     }
136037d0c07bSMatthew G Knepley     ierr = PetscFree2(fieldSizes,fieldIndices);CHKERRQ(ierr);
13618865f1eaSKarl Rupp   } else if (dm->ops->createfieldis) {
13628865f1eaSKarl Rupp     ierr = (*dm->ops->createfieldis)(dm, numFields, fieldNames, fields);CHKERRQ(ierr);
136369ca1f37SDmitry Karpeev   }
13644d343eeaSMatthew G Knepley   PetscFunctionReturn(0);
13654d343eeaSMatthew G Knepley }
13664d343eeaSMatthew G Knepley 
136716621825SDmitry Karpeev 
136816621825SDmitry Karpeev #undef __FUNCT__
136916621825SDmitry Karpeev #define __FUNCT__ "DMCreateFieldDecomposition"
137016621825SDmitry Karpeev /*@C
137116621825SDmitry Karpeev   DMCreateFieldDecomposition - Returns a list of IS objects defining a decomposition of a problem into subproblems
137216621825SDmitry Karpeev                           corresponding to different fields: each IS contains the global indices of the dofs of the
137316621825SDmitry Karpeev                           corresponding field. The optional list of DMs define the DM for each subproblem.
1374e7c4fc90SDmitry Karpeev                           Generalizes DMCreateFieldIS().
1375e7c4fc90SDmitry Karpeev 
1376e7c4fc90SDmitry Karpeev   Not collective
1377e7c4fc90SDmitry Karpeev 
1378e7c4fc90SDmitry Karpeev   Input Parameter:
1379e7c4fc90SDmitry Karpeev . dm - the DM object
1380e7c4fc90SDmitry Karpeev 
1381e7c4fc90SDmitry Karpeev   Output Parameters:
13820298fd71SBarry Smith + len       - The number of subproblems in the field decomposition (or NULL if not requested)
13830298fd71SBarry Smith . namelist  - The name for each field (or NULL if not requested)
13840298fd71SBarry Smith . islist    - The global indices for each field (or NULL if not requested)
13850298fd71SBarry Smith - dmlist    - The DMs for each field subproblem (or NULL, if not requested; if NULL is returned, no DMs are defined)
1386e7c4fc90SDmitry Karpeev 
1387e7c4fc90SDmitry Karpeev   Level: intermediate
1388e7c4fc90SDmitry Karpeev 
1389e7c4fc90SDmitry Karpeev   Notes:
1390e7c4fc90SDmitry Karpeev   The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with
1391e7c4fc90SDmitry Karpeev   PetscFree(), every entry of is should be destroyed with ISDestroy(), every entry of dm should be destroyed with DMDestroy(),
1392e7c4fc90SDmitry Karpeev   and all of the arrays should be freed with PetscFree().
1393e7c4fc90SDmitry Karpeev 
1394e7c4fc90SDmitry Karpeev .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS()
1395e7c4fc90SDmitry Karpeev @*/
139616621825SDmitry Karpeev PetscErrorCode DMCreateFieldDecomposition(DM dm, PetscInt *len, char ***namelist, IS **islist, DM **dmlist)
1397e7c4fc90SDmitry Karpeev {
1398e7c4fc90SDmitry Karpeev   PetscErrorCode ierr;
1399e7c4fc90SDmitry Karpeev 
1400e7c4fc90SDmitry Karpeev   PetscFunctionBegin;
1401e7c4fc90SDmitry Karpeev   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
14028865f1eaSKarl Rupp   if (len) {
14038865f1eaSKarl Rupp     PetscValidPointer(len,2);
14048865f1eaSKarl Rupp     *len = 0;
14058865f1eaSKarl Rupp   }
14068865f1eaSKarl Rupp   if (namelist) {
14078865f1eaSKarl Rupp     PetscValidPointer(namelist,3);
14088865f1eaSKarl Rupp     *namelist = 0;
14098865f1eaSKarl Rupp   }
14108865f1eaSKarl Rupp   if (islist) {
14118865f1eaSKarl Rupp     PetscValidPointer(islist,4);
14128865f1eaSKarl Rupp     *islist = 0;
14138865f1eaSKarl Rupp   }
14148865f1eaSKarl Rupp   if (dmlist) {
14158865f1eaSKarl Rupp     PetscValidPointer(dmlist,5);
14168865f1eaSKarl Rupp     *dmlist = 0;
14178865f1eaSKarl Rupp   }
1418f3f0edfdSDmitry Karpeev   /*
1419f3f0edfdSDmitry Karpeev    Is it a good idea to apply the following check across all impls?
1420f3f0edfdSDmitry Karpeev    Perhaps some impls can have a well-defined decomposition before DMSetUp?
1421f3f0edfdSDmitry Karpeev    This, however, follows the general principle that accessors are not well-behaved until the object is set up.
1422f3f0edfdSDmitry Karpeev    */
1423ce94432eSBarry Smith   if (!dm->setupcalled) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_WRONGSTATE, "Decomposition defined only after DMSetUp");
142416621825SDmitry Karpeev   if (!dm->ops->createfielddecomposition) {
1425435a35e8SMatthew G Knepley     PetscSection section;
1426435a35e8SMatthew G Knepley     PetscInt     numFields, f;
1427435a35e8SMatthew G Knepley 
1428435a35e8SMatthew G Knepley     ierr = DMGetDefaultSection(dm, &section);CHKERRQ(ierr);
1429435a35e8SMatthew G Knepley     if (section) {ierr = PetscSectionGetNumFields(section, &numFields);CHKERRQ(ierr);}
1430435a35e8SMatthew G Knepley     if (section && numFields && dm->ops->createsubdm) {
1431435a35e8SMatthew G Knepley       *len = numFields;
143203dc3394SMatthew G. Knepley       if (namelist) {ierr = PetscMalloc1(numFields,namelist);CHKERRQ(ierr);}
143303dc3394SMatthew G. Knepley       if (islist)   {ierr = PetscMalloc1(numFields,islist);CHKERRQ(ierr);}
143403dc3394SMatthew G. Knepley       if (dmlist)   {ierr = PetscMalloc1(numFields,dmlist);CHKERRQ(ierr);}
1435435a35e8SMatthew G Knepley       for (f = 0; f < numFields; ++f) {
1436435a35e8SMatthew G Knepley         const char *fieldName;
1437435a35e8SMatthew G Knepley 
143803dc3394SMatthew G. Knepley         ierr = DMCreateSubDM(dm, 1, &f, islist ? &(*islist)[f] : NULL, dmlist ? &(*dmlist)[f] : NULL);CHKERRQ(ierr);
143903dc3394SMatthew G. Knepley         if (namelist) {
1440435a35e8SMatthew G Knepley           ierr = PetscSectionGetFieldName(section, f, &fieldName);CHKERRQ(ierr);
1441435a35e8SMatthew G Knepley           ierr = PetscStrallocpy(fieldName, (char**) &(*namelist)[f]);CHKERRQ(ierr);
1442435a35e8SMatthew G Knepley         }
144303dc3394SMatthew G. Knepley       }
1444435a35e8SMatthew G Knepley     } else {
144569ca1f37SDmitry Karpeev       ierr = DMCreateFieldIS(dm, len, namelist, islist);CHKERRQ(ierr);
1446e7c4fc90SDmitry Karpeev       /* By default there are no DMs associated with subproblems. */
14470298fd71SBarry Smith       if (dmlist) *dmlist = NULL;
1448e7c4fc90SDmitry Karpeev     }
14498865f1eaSKarl Rupp   } else {
145016621825SDmitry Karpeev     ierr = (*dm->ops->createfielddecomposition)(dm,len,namelist,islist,dmlist);CHKERRQ(ierr);
145116621825SDmitry Karpeev   }
145216621825SDmitry Karpeev   PetscFunctionReturn(0);
145316621825SDmitry Karpeev }
145416621825SDmitry Karpeev 
145516621825SDmitry Karpeev #undef __FUNCT__
1456435a35e8SMatthew G Knepley #define __FUNCT__ "DMCreateSubDM"
1457564cec59SMatthew G. Knepley /*@
1458435a35e8SMatthew G Knepley   DMCreateSubDM - Returns an IS and DM encapsulating a subproblem defined by the fields passed in.
1459435a35e8SMatthew G Knepley                   The fields are defined by DMCreateFieldIS().
1460435a35e8SMatthew G Knepley 
1461435a35e8SMatthew G Knepley   Not collective
1462435a35e8SMatthew G Knepley 
1463435a35e8SMatthew G Knepley   Input Parameters:
1464435a35e8SMatthew G Knepley + dm - the DM object
1465435a35e8SMatthew G Knepley . numFields - number of fields in this subproblem
14660298fd71SBarry Smith - len       - The number of subproblems in the decomposition (or NULL if not requested)
1467435a35e8SMatthew G Knepley 
1468435a35e8SMatthew G Knepley   Output Parameters:
1469435a35e8SMatthew G Knepley . is - The global indices for the subproblem
1470435a35e8SMatthew G Knepley - dm - The DM for the subproblem
1471435a35e8SMatthew G Knepley 
1472435a35e8SMatthew G Knepley   Level: intermediate
1473435a35e8SMatthew G Knepley 
1474435a35e8SMatthew G Knepley .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS()
1475435a35e8SMatthew G Knepley @*/
1476435a35e8SMatthew G Knepley PetscErrorCode DMCreateSubDM(DM dm, PetscInt numFields, PetscInt fields[], IS *is, DM *subdm)
1477435a35e8SMatthew G Knepley {
1478435a35e8SMatthew G Knepley   PetscErrorCode ierr;
1479435a35e8SMatthew G Knepley 
1480435a35e8SMatthew G Knepley   PetscFunctionBegin;
1481435a35e8SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1482435a35e8SMatthew G Knepley   PetscValidPointer(fields,3);
14838865f1eaSKarl Rupp   if (is) PetscValidPointer(is,4);
14848865f1eaSKarl Rupp   if (subdm) PetscValidPointer(subdm,5);
1485435a35e8SMatthew G Knepley   if (dm->ops->createsubdm) {
1486435a35e8SMatthew G Knepley     ierr = (*dm->ops->createsubdm)(dm, numFields, fields, is, subdm);CHKERRQ(ierr);
148782f516ccSBarry Smith   } else SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "This type has no DMCreateSubDM implementation defined");
1488435a35e8SMatthew G Knepley   PetscFunctionReturn(0);
1489435a35e8SMatthew G Knepley }
1490435a35e8SMatthew G Knepley 
149116621825SDmitry Karpeev 
149216621825SDmitry Karpeev #undef __FUNCT__
149316621825SDmitry Karpeev #define __FUNCT__ "DMCreateDomainDecomposition"
149416621825SDmitry Karpeev /*@C
14958d4ac253SDmitry Karpeev   DMCreateDomainDecomposition - Returns lists of IS objects defining a decomposition of a problem into subproblems
14968d4ac253SDmitry Karpeev                           corresponding to restrictions to pairs nested subdomains: each IS contains the global
14978d4ac253SDmitry Karpeev                           indices of the dofs of the corresponding subdomains.  The inner subdomains conceptually
14988d4ac253SDmitry Karpeev                           define a nonoverlapping covering, while outer subdomains can overlap.
14998d4ac253SDmitry Karpeev                           The optional list of DMs define the DM for each subproblem.
150016621825SDmitry Karpeev 
150116621825SDmitry Karpeev   Not collective
150216621825SDmitry Karpeev 
150316621825SDmitry Karpeev   Input Parameter:
150416621825SDmitry Karpeev . dm - the DM object
150516621825SDmitry Karpeev 
150616621825SDmitry Karpeev   Output Parameters:
15070298fd71SBarry Smith + len         - The number of subproblems in the domain decomposition (or NULL if not requested)
15080298fd71SBarry Smith . namelist    - The name for each subdomain (or NULL if not requested)
15090298fd71SBarry Smith . innerislist - The global indices for each inner subdomain (or NULL, if not requested)
15100298fd71SBarry Smith . outerislist - The global indices for each outer subdomain (or NULL, if not requested)
15110298fd71SBarry Smith - dmlist      - The DMs for each subdomain subproblem (or NULL, if not requested; if NULL is returned, no DMs are defined)
151216621825SDmitry Karpeev 
151316621825SDmitry Karpeev   Level: intermediate
151416621825SDmitry Karpeev 
151516621825SDmitry Karpeev   Notes:
151616621825SDmitry Karpeev   The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with
151716621825SDmitry Karpeev   PetscFree(), every entry of is should be destroyed with ISDestroy(), every entry of dm should be destroyed with DMDestroy(),
151816621825SDmitry Karpeev   and all of the arrays should be freed with PetscFree().
151916621825SDmitry Karpeev 
15208d4ac253SDmitry Karpeev .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateDomainDecompositionDM(), DMCreateFieldDecomposition()
152116621825SDmitry Karpeev @*/
15228d4ac253SDmitry Karpeev PetscErrorCode DMCreateDomainDecomposition(DM dm, PetscInt *len, char ***namelist, IS **innerislist, IS **outerislist, DM **dmlist)
152316621825SDmitry Karpeev {
152416621825SDmitry Karpeev   PetscErrorCode      ierr;
1525be081cd6SPeter Brune   DMSubDomainHookLink link;
1526be081cd6SPeter Brune   PetscInt            i,l;
152716621825SDmitry Karpeev 
152816621825SDmitry Karpeev   PetscFunctionBegin;
152916621825SDmitry Karpeev   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
153014a18fd3SPeter Brune   if (len)           {PetscValidPointer(len,2);            *len         = 0;}
15310298fd71SBarry Smith   if (namelist)      {PetscValidPointer(namelist,3);       *namelist    = NULL;}
15320298fd71SBarry Smith   if (innerislist)   {PetscValidPointer(innerislist,4);    *innerislist = NULL;}
15330298fd71SBarry Smith   if (outerislist)   {PetscValidPointer(outerislist,5);    *outerislist = NULL;}
15340298fd71SBarry Smith   if (dmlist)        {PetscValidPointer(dmlist,6);         *dmlist      = NULL;}
1535f3f0edfdSDmitry Karpeev   /*
1536f3f0edfdSDmitry Karpeev    Is it a good idea to apply the following check across all impls?
1537f3f0edfdSDmitry Karpeev    Perhaps some impls can have a well-defined decomposition before DMSetUp?
1538f3f0edfdSDmitry Karpeev    This, however, follows the general principle that accessors are not well-behaved until the object is set up.
1539f3f0edfdSDmitry Karpeev    */
1540ce94432eSBarry Smith   if (!dm->setupcalled) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_WRONGSTATE, "Decomposition defined only after DMSetUp");
154116621825SDmitry Karpeev   if (dm->ops->createdomaindecomposition) {
1542be081cd6SPeter Brune     ierr = (*dm->ops->createdomaindecomposition)(dm,&l,namelist,innerislist,outerislist,dmlist);CHKERRQ(ierr);
154314a18fd3SPeter Brune     /* copy subdomain hooks and context over to the subdomain DMs */
154414a18fd3SPeter Brune     if (dmlist) {
1545be081cd6SPeter Brune       for (i = 0; i < l; i++) {
1546be081cd6SPeter Brune         for (link=dm->subdomainhook; link; link=link->next) {
1547be081cd6SPeter Brune           if (link->ddhook) {ierr = (*link->ddhook)(dm,(*dmlist)[i],link->ctx);CHKERRQ(ierr);}
1548be081cd6SPeter Brune         }
1549d425c654SPeter Brune         (*dmlist)[i]->ctx = dm->ctx;
1550e7c4fc90SDmitry Karpeev       }
155114a18fd3SPeter Brune     }
155214a18fd3SPeter Brune     if (len) *len = l;
155314a18fd3SPeter Brune   }
1554e30e807fSPeter Brune   PetscFunctionReturn(0);
1555e30e807fSPeter Brune }
1556e30e807fSPeter Brune 
1557e30e807fSPeter Brune 
1558e30e807fSPeter Brune #undef __FUNCT__
1559e30e807fSPeter Brune #define __FUNCT__ "DMCreateDomainDecompositionScatters"
1560e30e807fSPeter Brune /*@C
1561e30e807fSPeter Brune   DMCreateDomainDecompositionScatters - Returns scatters to the subdomain vectors from the global vector
1562e30e807fSPeter Brune 
1563e30e807fSPeter Brune   Not collective
1564e30e807fSPeter Brune 
1565e30e807fSPeter Brune   Input Parameters:
1566e30e807fSPeter Brune + dm - the DM object
1567e30e807fSPeter Brune . n  - the number of subdomain scatters
1568e30e807fSPeter Brune - subdms - the local subdomains
1569e30e807fSPeter Brune 
1570e30e807fSPeter Brune   Output Parameters:
1571e30e807fSPeter Brune + n     - the number of scatters returned
1572e30e807fSPeter Brune . iscat - scatter from global vector to nonoverlapping global vector entries on subdomain
1573e30e807fSPeter Brune . oscat - scatter from global vector to overlapping global vector entries on subdomain
1574e30e807fSPeter Brune - gscat - scatter from global vector to local vector on subdomain (fills in ghosts)
1575e30e807fSPeter Brune 
1576e30e807fSPeter Brune   Notes: This is an alternative to the iis and ois arguments in DMCreateDomainDecomposition that allow for the solution
1577e30e807fSPeter Brune   of general nonlinear problems with overlapping subdomain methods.  While merely having index sets that enable subsets
1578e30e807fSPeter Brune   of the residual equations to be created is fine for linear problems, nonlinear problems require local assembly of
1579e30e807fSPeter Brune   solution and residual data.
1580e30e807fSPeter Brune 
1581e30e807fSPeter Brune   Level: developer
1582e30e807fSPeter Brune 
1583e30e807fSPeter Brune .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS()
1584e30e807fSPeter Brune @*/
1585e30e807fSPeter Brune PetscErrorCode DMCreateDomainDecompositionScatters(DM dm,PetscInt n,DM *subdms,VecScatter **iscat,VecScatter **oscat,VecScatter **gscat)
1586e30e807fSPeter Brune {
1587e30e807fSPeter Brune   PetscErrorCode ierr;
1588e30e807fSPeter Brune 
1589e30e807fSPeter Brune   PetscFunctionBegin;
1590e30e807fSPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1591e30e807fSPeter Brune   PetscValidPointer(subdms,3);
1592e30e807fSPeter Brune   if (dm->ops->createddscatters) {
1593e30e807fSPeter Brune     ierr = (*dm->ops->createddscatters)(dm,n,subdms,iscat,oscat,gscat);CHKERRQ(ierr);
159482f516ccSBarry Smith   } else SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "This type has no DMCreateDomainDecompositionLocalScatter implementation defined");
1595e7c4fc90SDmitry Karpeev   PetscFunctionReturn(0);
1596e7c4fc90SDmitry Karpeev }
1597e7c4fc90SDmitry Karpeev 
1598731c8d9eSDmitry Karpeev #undef __FUNCT__
159947c6ae99SBarry Smith #define __FUNCT__ "DMRefine"
160047c6ae99SBarry Smith /*@
160147c6ae99SBarry Smith   DMRefine - Refines a DM object
160247c6ae99SBarry Smith 
160347c6ae99SBarry Smith   Collective on DM
160447c6ae99SBarry Smith 
160547c6ae99SBarry Smith   Input Parameter:
160647c6ae99SBarry Smith + dm   - the DM object
160791d95f02SJed Brown - comm - the communicator to contain the new DM object (or MPI_COMM_NULL)
160847c6ae99SBarry Smith 
160947c6ae99SBarry Smith   Output Parameter:
16100298fd71SBarry Smith . dmf - the refined DM, or NULL
1611ae0a1c52SMatthew G Knepley 
16120298fd71SBarry Smith   Note: If no refinement was done, the return value is NULL
161347c6ae99SBarry Smith 
161447c6ae99SBarry Smith   Level: developer
161547c6ae99SBarry Smith 
1616e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
161747c6ae99SBarry Smith @*/
16187087cfbeSBarry Smith PetscErrorCode  DMRefine(DM dm,MPI_Comm comm,DM *dmf)
161947c6ae99SBarry Smith {
162047c6ae99SBarry Smith   PetscErrorCode   ierr;
1621c833c3b5SJed Brown   DMRefineHookLink link;
162247c6ae99SBarry Smith 
162347c6ae99SBarry Smith   PetscFunctionBegin;
1624732e2eb9SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
162547c6ae99SBarry Smith   ierr = (*dm->ops->refine)(dm,comm,dmf);CHKERRQ(ierr);
16264057135bSMatthew G Knepley   if (*dmf) {
162743842a1eSJed Brown     (*dmf)->ops->creatematrix = dm->ops->creatematrix;
16288865f1eaSKarl Rupp 
16298cd211a4SJed Brown     ierr = PetscObjectCopyFortranFunctionPointers((PetscObject)dm,(PetscObject)*dmf);CHKERRQ(ierr);
16308865f1eaSKarl Rupp 
1631644e2e5bSBarry Smith     (*dmf)->ctx       = dm->ctx;
16320598a293SJed Brown     (*dmf)->leveldown = dm->leveldown;
1633656b349aSBarry Smith     (*dmf)->levelup   = dm->levelup + 1;
16348865f1eaSKarl Rupp 
1635e4b4b23bSJed Brown     ierr = DMSetMatType(*dmf,dm->mattype);CHKERRQ(ierr);
1636c833c3b5SJed Brown     for (link=dm->refinehook; link; link=link->next) {
16378865f1eaSKarl Rupp       if (link->refinehook) {
16388865f1eaSKarl Rupp         ierr = (*link->refinehook)(dm,*dmf,link->ctx);CHKERRQ(ierr);
16398865f1eaSKarl Rupp       }
1640c833c3b5SJed Brown     }
1641c833c3b5SJed Brown   }
1642c833c3b5SJed Brown   PetscFunctionReturn(0);
1643c833c3b5SJed Brown }
1644c833c3b5SJed Brown 
1645c833c3b5SJed Brown #undef __FUNCT__
1646c833c3b5SJed Brown #define __FUNCT__ "DMRefineHookAdd"
1647bb9467b5SJed Brown /*@C
1648c833c3b5SJed Brown    DMRefineHookAdd - adds a callback to be run when interpolating a nonlinear problem to a finer grid
1649c833c3b5SJed Brown 
1650c833c3b5SJed Brown    Logically Collective
1651c833c3b5SJed Brown 
1652c833c3b5SJed Brown    Input Arguments:
1653c833c3b5SJed Brown +  coarse - nonlinear solver context on which to run a hook when restricting to a coarser level
1654c833c3b5SJed Brown .  refinehook - function to run when setting up a coarser level
1655c833c3b5SJed Brown .  interphook - function to run to update data on finer levels (once per SNESSolve())
16560298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
1657c833c3b5SJed Brown 
1658c833c3b5SJed Brown    Calling sequence of refinehook:
1659c833c3b5SJed Brown $    refinehook(DM coarse,DM fine,void *ctx);
1660c833c3b5SJed Brown 
1661c833c3b5SJed Brown +  coarse - coarse level DM
1662c833c3b5SJed Brown .  fine - fine level DM to interpolate problem to
1663c833c3b5SJed Brown -  ctx - optional user-defined function context
1664c833c3b5SJed Brown 
1665c833c3b5SJed Brown    Calling sequence for interphook:
1666c833c3b5SJed Brown $    interphook(DM coarse,Mat interp,DM fine,void *ctx)
1667c833c3b5SJed Brown 
1668c833c3b5SJed Brown +  coarse - coarse level DM
1669c833c3b5SJed Brown .  interp - matrix interpolating a coarse-level solution to the finer grid
1670c833c3b5SJed Brown .  fine - fine level DM to update
1671c833c3b5SJed Brown -  ctx - optional user-defined function context
1672c833c3b5SJed Brown 
1673c833c3b5SJed Brown    Level: advanced
1674c833c3b5SJed Brown 
1675c833c3b5SJed Brown    Notes:
1676c833c3b5SJed Brown    This function is only needed if auxiliary data needs to be passed to fine grids while grid sequencing
1677c833c3b5SJed Brown 
1678c833c3b5SJed Brown    If this function is called multiple times, the hooks will be run in the order they are added.
1679c833c3b5SJed Brown 
1680bb9467b5SJed Brown    This function is currently not available from Fortran.
1681bb9467b5SJed Brown 
1682c833c3b5SJed Brown .seealso: DMCoarsenHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
1683c833c3b5SJed Brown @*/
1684c833c3b5SJed Brown PetscErrorCode DMRefineHookAdd(DM coarse,PetscErrorCode (*refinehook)(DM,DM,void*),PetscErrorCode (*interphook)(DM,Mat,DM,void*),void *ctx)
1685c833c3b5SJed Brown {
1686c833c3b5SJed Brown   PetscErrorCode   ierr;
1687c833c3b5SJed Brown   DMRefineHookLink link,*p;
1688c833c3b5SJed Brown 
1689c833c3b5SJed Brown   PetscFunctionBegin;
1690c833c3b5SJed Brown   PetscValidHeaderSpecific(coarse,DM_CLASSID,1);
1691c833c3b5SJed Brown   for (p=&coarse->refinehook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */
1692c833c3b5SJed Brown   ierr             = PetscMalloc(sizeof(struct _DMRefineHookLink),&link);CHKERRQ(ierr);
1693c833c3b5SJed Brown   link->refinehook = refinehook;
1694c833c3b5SJed Brown   link->interphook = interphook;
1695c833c3b5SJed Brown   link->ctx        = ctx;
16960298fd71SBarry Smith   link->next       = NULL;
1697c833c3b5SJed Brown   *p               = link;
1698c833c3b5SJed Brown   PetscFunctionReturn(0);
1699c833c3b5SJed Brown }
1700c833c3b5SJed Brown 
1701c833c3b5SJed Brown #undef __FUNCT__
1702c833c3b5SJed Brown #define __FUNCT__ "DMInterpolate"
1703c833c3b5SJed Brown /*@
1704c833c3b5SJed Brown    DMInterpolate - interpolates user-defined problem data to a finer DM by running hooks registered by DMRefineHookAdd()
1705c833c3b5SJed Brown 
1706c833c3b5SJed Brown    Collective if any hooks are
1707c833c3b5SJed Brown 
1708c833c3b5SJed Brown    Input Arguments:
1709c833c3b5SJed Brown +  coarse - coarser DM to use as a base
1710c833c3b5SJed Brown .  restrct - interpolation matrix, apply using MatInterpolate()
1711c833c3b5SJed Brown -  fine - finer DM to update
1712c833c3b5SJed Brown 
1713c833c3b5SJed Brown    Level: developer
1714c833c3b5SJed Brown 
1715c833c3b5SJed Brown .seealso: DMRefineHookAdd(), MatInterpolate()
1716c833c3b5SJed Brown @*/
1717c833c3b5SJed Brown PetscErrorCode DMInterpolate(DM coarse,Mat interp,DM fine)
1718c833c3b5SJed Brown {
1719c833c3b5SJed Brown   PetscErrorCode   ierr;
1720c833c3b5SJed Brown   DMRefineHookLink link;
1721c833c3b5SJed Brown 
1722c833c3b5SJed Brown   PetscFunctionBegin;
1723c833c3b5SJed Brown   for (link=fine->refinehook; link; link=link->next) {
17248865f1eaSKarl Rupp     if (link->interphook) {
17258865f1eaSKarl Rupp       ierr = (*link->interphook)(coarse,interp,fine,link->ctx);CHKERRQ(ierr);
17268865f1eaSKarl Rupp     }
17274057135bSMatthew G Knepley   }
172847c6ae99SBarry Smith   PetscFunctionReturn(0);
172947c6ae99SBarry Smith }
173047c6ae99SBarry Smith 
173147c6ae99SBarry Smith #undef __FUNCT__
1732eb3f98d2SBarry Smith #define __FUNCT__ "DMGetRefineLevel"
1733eb3f98d2SBarry Smith /*@
1734eb3f98d2SBarry Smith     DMGetRefineLevel - Get's the number of refinements that have generated this DM.
1735eb3f98d2SBarry Smith 
1736eb3f98d2SBarry Smith     Not Collective
1737eb3f98d2SBarry Smith 
1738eb3f98d2SBarry Smith     Input Parameter:
1739eb3f98d2SBarry Smith .   dm - the DM object
1740eb3f98d2SBarry Smith 
1741eb3f98d2SBarry Smith     Output Parameter:
1742eb3f98d2SBarry Smith .   level - number of refinements
1743eb3f98d2SBarry Smith 
1744eb3f98d2SBarry Smith     Level: developer
1745eb3f98d2SBarry Smith 
17466a7d9d85SPeter Brune .seealso DMCoarsen(), DMGetCoarsenLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
1747eb3f98d2SBarry Smith 
1748eb3f98d2SBarry Smith @*/
1749eb3f98d2SBarry Smith PetscErrorCode  DMGetRefineLevel(DM dm,PetscInt *level)
1750eb3f98d2SBarry Smith {
1751eb3f98d2SBarry Smith   PetscFunctionBegin;
1752eb3f98d2SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1753eb3f98d2SBarry Smith   *level = dm->levelup;
1754eb3f98d2SBarry Smith   PetscFunctionReturn(0);
1755eb3f98d2SBarry Smith }
1756eb3f98d2SBarry Smith 
1757eb3f98d2SBarry Smith #undef __FUNCT__
1758baf369e7SPeter Brune #define __FUNCT__ "DMGlobalToLocalHookAdd"
1759bb9467b5SJed Brown /*@C
1760baf369e7SPeter Brune    DMGlobalToLocalHookAdd - adds a callback to be run when global to local is called
1761baf369e7SPeter Brune 
1762baf369e7SPeter Brune    Logically Collective
1763baf369e7SPeter Brune 
1764baf369e7SPeter Brune    Input Arguments:
1765baf369e7SPeter Brune +  dm - the DM
1766baf369e7SPeter Brune .  beginhook - function to run at the beginning of DMGlobalToLocalBegin()
1767baf369e7SPeter Brune .  endhook - function to run after DMGlobalToLocalEnd() has completed
17680298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
1769baf369e7SPeter Brune 
1770baf369e7SPeter Brune    Calling sequence for beginhook:
1771baf369e7SPeter Brune $    beginhook(DM fine,VecScatter out,VecScatter in,DM coarse,void *ctx)
1772baf369e7SPeter Brune 
1773baf369e7SPeter Brune +  dm - global DM
1774baf369e7SPeter Brune .  g - global vector
1775baf369e7SPeter Brune .  mode - mode
1776baf369e7SPeter Brune .  l - local vector
1777baf369e7SPeter Brune -  ctx - optional user-defined function context
1778baf369e7SPeter Brune 
1779baf369e7SPeter Brune 
1780baf369e7SPeter Brune    Calling sequence for endhook:
1781ec4806b8SPeter Brune $    endhook(DM fine,VecScatter out,VecScatter in,DM coarse,void *ctx)
1782baf369e7SPeter Brune 
1783baf369e7SPeter Brune +  global - global DM
1784baf369e7SPeter Brune -  ctx - optional user-defined function context
1785baf369e7SPeter Brune 
1786baf369e7SPeter Brune    Level: advanced
1787baf369e7SPeter Brune 
1788baf369e7SPeter Brune .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
1789baf369e7SPeter Brune @*/
1790baf369e7SPeter Brune PetscErrorCode DMGlobalToLocalHookAdd(DM dm,PetscErrorCode (*beginhook)(DM,Vec,InsertMode,Vec,void*),PetscErrorCode (*endhook)(DM,Vec,InsertMode,Vec,void*),void *ctx)
1791baf369e7SPeter Brune {
1792baf369e7SPeter Brune   PetscErrorCode          ierr;
1793baf369e7SPeter Brune   DMGlobalToLocalHookLink link,*p;
1794baf369e7SPeter Brune 
1795baf369e7SPeter Brune   PetscFunctionBegin;
1796baf369e7SPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1797baf369e7SPeter Brune   for (p=&dm->gtolhook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */
1798baf369e7SPeter Brune   ierr            = PetscMalloc(sizeof(struct _DMGlobalToLocalHookLink),&link);CHKERRQ(ierr);
1799baf369e7SPeter Brune   link->beginhook = beginhook;
1800baf369e7SPeter Brune   link->endhook   = endhook;
1801baf369e7SPeter Brune   link->ctx       = ctx;
18020298fd71SBarry Smith   link->next      = NULL;
1803baf369e7SPeter Brune   *p              = link;
1804baf369e7SPeter Brune   PetscFunctionReturn(0);
1805baf369e7SPeter Brune }
1806baf369e7SPeter Brune 
1807baf369e7SPeter Brune #undef __FUNCT__
18084c274da1SToby Isaac #define __FUNCT__ "DMGlobalToLocalHook_Constraints"
18094c274da1SToby Isaac static PetscErrorCode DMGlobalToLocalHook_Constraints(DM dm, Vec g, InsertMode mode, Vec l, void *ctx)
18104c274da1SToby Isaac {
18114c274da1SToby Isaac   Mat cMat;
18124c274da1SToby Isaac   Vec cVec;
18134c274da1SToby Isaac   PetscSection section, cSec;
18144c274da1SToby Isaac   PetscInt pStart, pEnd, p, dof;
18154c274da1SToby Isaac   PetscErrorCode ierr;
18164c274da1SToby Isaac 
18174c274da1SToby Isaac   PetscFunctionBegin;
18184c274da1SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
18194c274da1SToby Isaac   ierr = DMGetDefaultConstraints(dm,&cSec,&cMat);CHKERRQ(ierr);
18204c274da1SToby Isaac   if (cMat && (mode == INSERT_VALUES || mode == INSERT_ALL_VALUES || mode == INSERT_BC_VALUES)) {
18214c274da1SToby Isaac     ierr = DMGetDefaultSection(dm,&section);CHKERRQ(ierr);
18227711e48fSToby Isaac     ierr = MatCreateVecs(cMat,NULL,&cVec);CHKERRQ(ierr);
18234c274da1SToby Isaac     ierr = MatMult(cMat,l,cVec);CHKERRQ(ierr);
18244c274da1SToby Isaac     ierr = PetscSectionGetChart(cSec,&pStart,&pEnd);CHKERRQ(ierr);
18254c274da1SToby Isaac     for (p = pStart; p < pEnd; p++) {
18264c274da1SToby Isaac       ierr = PetscSectionGetDof(cSec,p,&dof);CHKERRQ(ierr);
18274c274da1SToby Isaac       if (dof) {
18284c274da1SToby Isaac         PetscScalar *vals;
18294c274da1SToby Isaac         ierr = VecGetValuesSection(cVec,cSec,p,&vals);CHKERRQ(ierr);
18304c274da1SToby Isaac         ierr = VecSetValuesSection(l,section,p,vals,INSERT_ALL_VALUES);CHKERRQ(ierr);
18314c274da1SToby Isaac       }
18324c274da1SToby Isaac     }
18334c274da1SToby Isaac     ierr = VecDestroy(&cVec);CHKERRQ(ierr);
18344c274da1SToby Isaac   }
18354c274da1SToby Isaac   PetscFunctionReturn(0);
18364c274da1SToby Isaac }
18374c274da1SToby Isaac 
18384c274da1SToby Isaac #undef __FUNCT__
183947c6ae99SBarry Smith #define __FUNCT__ "DMGlobalToLocalBegin"
184047c6ae99SBarry Smith /*@
184147c6ae99SBarry Smith     DMGlobalToLocalBegin - Begins updating local vectors from global vector
184247c6ae99SBarry Smith 
184347c6ae99SBarry Smith     Neighbor-wise Collective on DM
184447c6ae99SBarry Smith 
184547c6ae99SBarry Smith     Input Parameters:
184647c6ae99SBarry Smith +   dm - the DM object
184747c6ae99SBarry Smith .   g - the global vector
184847c6ae99SBarry Smith .   mode - INSERT_VALUES or ADD_VALUES
184947c6ae99SBarry Smith -   l - the local vector
185047c6ae99SBarry Smith 
185147c6ae99SBarry Smith 
185247c6ae99SBarry Smith     Level: beginner
185347c6ae99SBarry Smith 
1854e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin()
185547c6ae99SBarry Smith 
185647c6ae99SBarry Smith @*/
18577087cfbeSBarry Smith PetscErrorCode  DMGlobalToLocalBegin(DM dm,Vec g,InsertMode mode,Vec l)
185847c6ae99SBarry Smith {
18597128ae9fSMatthew G Knepley   PetscSF                 sf;
186047c6ae99SBarry Smith   PetscErrorCode          ierr;
1861baf369e7SPeter Brune   DMGlobalToLocalHookLink link;
186247c6ae99SBarry Smith 
186347c6ae99SBarry Smith   PetscFunctionBegin;
1864171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1865baf369e7SPeter Brune   for (link=dm->gtolhook; link; link=link->next) {
18668865f1eaSKarl Rupp     if (link->beginhook) {
18678865f1eaSKarl Rupp       ierr = (*link->beginhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);
18688865f1eaSKarl Rupp     }
1869baf369e7SPeter Brune   }
18707128ae9fSMatthew G Knepley   ierr = DMGetDefaultSF(dm, &sf);CHKERRQ(ierr);
18717128ae9fSMatthew G Knepley   if (sf) {
1872ae5cfb4aSMatthew G. Knepley     const PetscScalar *gArray;
1873ae5cfb4aSMatthew G. Knepley     PetscScalar       *lArray;
18747128ae9fSMatthew G Knepley 
187582f516ccSBarry Smith     if (mode == ADD_VALUES) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
18767128ae9fSMatthew G Knepley     ierr = VecGetArray(l, &lArray);CHKERRQ(ierr);
1877ae5cfb4aSMatthew G. Knepley     ierr = VecGetArrayRead(g, &gArray);CHKERRQ(ierr);
18787128ae9fSMatthew G Knepley     ierr = PetscSFBcastBegin(sf, MPIU_SCALAR, gArray, lArray);CHKERRQ(ierr);
18797128ae9fSMatthew G Knepley     ierr = VecRestoreArray(l, &lArray);CHKERRQ(ierr);
1880ae5cfb4aSMatthew G. Knepley     ierr = VecRestoreArrayRead(g, &gArray);CHKERRQ(ierr);
18817128ae9fSMatthew G Knepley   } else {
1882843c4018SMatthew G Knepley     ierr = (*dm->ops->globaltolocalbegin)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
18837128ae9fSMatthew G Knepley   }
188447c6ae99SBarry Smith   PetscFunctionReturn(0);
188547c6ae99SBarry Smith }
188647c6ae99SBarry Smith 
188747c6ae99SBarry Smith #undef __FUNCT__
188847c6ae99SBarry Smith #define __FUNCT__ "DMGlobalToLocalEnd"
188947c6ae99SBarry Smith /*@
189047c6ae99SBarry Smith     DMGlobalToLocalEnd - Ends updating local vectors from global vector
189147c6ae99SBarry Smith 
189247c6ae99SBarry Smith     Neighbor-wise Collective on DM
189347c6ae99SBarry Smith 
189447c6ae99SBarry Smith     Input Parameters:
189547c6ae99SBarry Smith +   dm - the DM object
189647c6ae99SBarry Smith .   g - the global vector
189747c6ae99SBarry Smith .   mode - INSERT_VALUES or ADD_VALUES
189847c6ae99SBarry Smith -   l - the local vector
189947c6ae99SBarry Smith 
190047c6ae99SBarry Smith 
190147c6ae99SBarry Smith     Level: beginner
190247c6ae99SBarry Smith 
1903e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin()
190447c6ae99SBarry Smith 
190547c6ae99SBarry Smith @*/
19067087cfbeSBarry Smith PetscErrorCode  DMGlobalToLocalEnd(DM dm,Vec g,InsertMode mode,Vec l)
190747c6ae99SBarry Smith {
19087128ae9fSMatthew G Knepley   PetscSF                 sf;
190947c6ae99SBarry Smith   PetscErrorCode          ierr;
1910ae5cfb4aSMatthew G. Knepley   const PetscScalar      *gArray;
1911ae5cfb4aSMatthew G. Knepley   PetscScalar            *lArray;
1912baf369e7SPeter Brune   DMGlobalToLocalHookLink link;
191347c6ae99SBarry Smith 
191447c6ae99SBarry Smith   PetscFunctionBegin;
1915171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
19167128ae9fSMatthew G Knepley   ierr = DMGetDefaultSF(dm, &sf);CHKERRQ(ierr);
19177128ae9fSMatthew G Knepley   if (sf) {
191882f516ccSBarry Smith     if (mode == ADD_VALUES) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
19197128ae9fSMatthew G Knepley 
19207128ae9fSMatthew G Knepley     ierr = VecGetArray(l, &lArray);CHKERRQ(ierr);
1921ae5cfb4aSMatthew G. Knepley     ierr = VecGetArrayRead(g, &gArray);CHKERRQ(ierr);
19227128ae9fSMatthew G Knepley     ierr = PetscSFBcastEnd(sf, MPIU_SCALAR, gArray, lArray);CHKERRQ(ierr);
19237128ae9fSMatthew G Knepley     ierr = VecRestoreArray(l, &lArray);CHKERRQ(ierr);
1924ae5cfb4aSMatthew G. Knepley     ierr = VecRestoreArrayRead(g, &gArray);CHKERRQ(ierr);
19257128ae9fSMatthew G Knepley   } else {
1926843c4018SMatthew G Knepley     ierr = (*dm->ops->globaltolocalend)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
19277128ae9fSMatthew G Knepley   }
19284c274da1SToby Isaac   ierr = DMGlobalToLocalHook_Constraints(dm,g,mode,l,NULL);CHKERRQ(ierr);
1929baf369e7SPeter Brune   for (link=dm->gtolhook; link; link=link->next) {
1930baf369e7SPeter Brune     if (link->endhook) {ierr = (*link->endhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);}
1931baf369e7SPeter Brune   }
193247c6ae99SBarry Smith   PetscFunctionReturn(0);
193347c6ae99SBarry Smith }
193447c6ae99SBarry Smith 
193547c6ae99SBarry Smith #undef __FUNCT__
1936d4d07f1eSToby Isaac #define __FUNCT__ "DMLocalToGlobalHookAdd"
1937d4d07f1eSToby Isaac /*@C
1938d4d07f1eSToby Isaac    DMLocalToGlobalHookAdd - adds a callback to be run when a local to global is called
1939d4d07f1eSToby Isaac 
1940d4d07f1eSToby Isaac    Logically Collective
1941d4d07f1eSToby Isaac 
1942d4d07f1eSToby Isaac    Input Arguments:
1943d4d07f1eSToby Isaac +  dm - the DM
1944d4d07f1eSToby Isaac .  beginhook - function to run at the beginning of DMLocalToGlobalBegin()
1945d4d07f1eSToby Isaac .  endhook - function to run after DMLocalToGlobalEnd() has completed
1946d4d07f1eSToby Isaac -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
1947d4d07f1eSToby Isaac 
1948d4d07f1eSToby Isaac    Calling sequence for beginhook:
1949d4d07f1eSToby Isaac $    beginhook(DM fine,Vec l,InsertMode mode,Vec g,void *ctx)
1950d4d07f1eSToby Isaac 
1951d4d07f1eSToby Isaac +  dm - global DM
1952d4d07f1eSToby Isaac .  l - local vector
1953d4d07f1eSToby Isaac .  mode - mode
1954d4d07f1eSToby Isaac .  g - global vector
1955d4d07f1eSToby Isaac -  ctx - optional user-defined function context
1956d4d07f1eSToby Isaac 
1957d4d07f1eSToby Isaac 
1958d4d07f1eSToby Isaac    Calling sequence for endhook:
1959d4d07f1eSToby Isaac $    endhook(DM fine,Vec l,InsertMode mode,Vec g,void *ctx)
1960d4d07f1eSToby Isaac 
1961d4d07f1eSToby Isaac +  global - global DM
1962d4d07f1eSToby Isaac .  l - local vector
1963d4d07f1eSToby Isaac .  mode - mode
1964d4d07f1eSToby Isaac .  g - global vector
1965d4d07f1eSToby Isaac -  ctx - optional user-defined function context
1966d4d07f1eSToby Isaac 
1967d4d07f1eSToby Isaac    Level: advanced
1968d4d07f1eSToby Isaac 
1969d4d07f1eSToby Isaac .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
1970d4d07f1eSToby Isaac @*/
1971d4d07f1eSToby Isaac PetscErrorCode DMLocalToGlobalHookAdd(DM dm,PetscErrorCode (*beginhook)(DM,Vec,InsertMode,Vec,void*),PetscErrorCode (*endhook)(DM,Vec,InsertMode,Vec,void*),void *ctx)
1972d4d07f1eSToby Isaac {
1973d4d07f1eSToby Isaac   PetscErrorCode          ierr;
1974d4d07f1eSToby Isaac   DMLocalToGlobalHookLink link,*p;
1975d4d07f1eSToby Isaac 
1976d4d07f1eSToby Isaac   PetscFunctionBegin;
1977d4d07f1eSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1978d4d07f1eSToby Isaac   for (p=&dm->ltoghook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */
1979d4d07f1eSToby Isaac   ierr            = PetscMalloc(sizeof(struct _DMLocalToGlobalHookLink),&link);CHKERRQ(ierr);
1980d4d07f1eSToby Isaac   link->beginhook = beginhook;
1981d4d07f1eSToby Isaac   link->endhook   = endhook;
1982d4d07f1eSToby Isaac   link->ctx       = ctx;
1983d4d07f1eSToby Isaac   link->next      = NULL;
1984d4d07f1eSToby Isaac   *p              = link;
1985d4d07f1eSToby Isaac   PetscFunctionReturn(0);
1986d4d07f1eSToby Isaac }
1987d4d07f1eSToby Isaac 
1988d4d07f1eSToby Isaac #undef __FUNCT__
19894c274da1SToby Isaac #define __FUNCT__ "DMLocalToGlobalHook_Constraints"
19904c274da1SToby Isaac static PetscErrorCode DMLocalToGlobalHook_Constraints(DM dm, Vec l, InsertMode mode, Vec g, void *ctx)
19914c274da1SToby Isaac {
19924c274da1SToby Isaac   Mat cMat;
19934c274da1SToby Isaac   Vec cVec;
19944c274da1SToby Isaac   PetscSection section, cSec;
19954c274da1SToby Isaac   PetscInt pStart, pEnd, p, dof;
19964c274da1SToby Isaac   PetscErrorCode ierr;
19974c274da1SToby Isaac 
19984c274da1SToby Isaac   PetscFunctionBegin;
19994c274da1SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
20004c274da1SToby Isaac   ierr = DMGetDefaultConstraints(dm,&cSec,&cMat);CHKERRQ(ierr);
20014c274da1SToby Isaac   if (cMat && (mode == ADD_VALUES || mode == ADD_ALL_VALUES || mode == ADD_BC_VALUES)) {
20024c274da1SToby Isaac     ierr = DMGetDefaultSection(dm,&section);CHKERRQ(ierr);
20037711e48fSToby Isaac     ierr = MatCreateVecs(cMat,NULL,&cVec);CHKERRQ(ierr);
20044c274da1SToby Isaac     ierr = PetscSectionGetChart(cSec,&pStart,&pEnd);CHKERRQ(ierr);
20054c274da1SToby Isaac     for (p = pStart; p < pEnd; p++) {
20064c274da1SToby Isaac       ierr = PetscSectionGetDof(cSec,p,&dof);CHKERRQ(ierr);
20074c274da1SToby Isaac       if (dof) {
20084c274da1SToby Isaac         PetscInt d;
20094c274da1SToby Isaac         PetscScalar *vals;
20104c274da1SToby Isaac         ierr = VecGetValuesSection(l,section,p,&vals);CHKERRQ(ierr);
20114c274da1SToby Isaac         ierr = VecSetValuesSection(cVec,cSec,p,vals,mode);CHKERRQ(ierr);
20124c274da1SToby Isaac         /* for this to be the true transpose, we have to zero the values that
20134c274da1SToby Isaac          * we just extracted */
20144c274da1SToby Isaac         for (d = 0; d < dof; d++) {
20154c274da1SToby Isaac           vals[d] = 0.;
20164c274da1SToby Isaac         }
20174c274da1SToby Isaac       }
20184c274da1SToby Isaac     }
20194c274da1SToby Isaac     ierr = MatMultTransposeAdd(cMat,cVec,l,l);CHKERRQ(ierr);
20204c274da1SToby Isaac     ierr = VecDestroy(&cVec);CHKERRQ(ierr);
20214c274da1SToby Isaac   }
20224c274da1SToby Isaac   PetscFunctionReturn(0);
20234c274da1SToby Isaac }
20244c274da1SToby Isaac 
20254c274da1SToby Isaac #undef __FUNCT__
20269a42bb27SBarry Smith #define __FUNCT__ "DMLocalToGlobalBegin"
202747c6ae99SBarry Smith /*@
20289a42bb27SBarry Smith     DMLocalToGlobalBegin - updates global vectors from local vectors
20299a42bb27SBarry Smith 
20309a42bb27SBarry Smith     Neighbor-wise Collective on DM
20319a42bb27SBarry Smith 
20329a42bb27SBarry Smith     Input Parameters:
20339a42bb27SBarry Smith +   dm - the DM object
2034f6813fd5SJed Brown .   l - the local vector
20351eb28f2eSBarry 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.
20361eb28f2eSBarry Smith -   g - the global vector
20379a42bb27SBarry Smith 
2038d96308ebSBarry Smith     Notes: In the ADD_VALUES case you normally would zero the receiving vector before beginning this operation.
203984330215SMatthew 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.
20409a42bb27SBarry Smith 
20419a42bb27SBarry Smith     Level: beginner
20429a42bb27SBarry Smith 
2043e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMGlobalToLocalBegin()
20449a42bb27SBarry Smith 
20459a42bb27SBarry Smith @*/
20467087cfbeSBarry Smith PetscErrorCode  DMLocalToGlobalBegin(DM dm,Vec l,InsertMode mode,Vec g)
20479a42bb27SBarry Smith {
20487128ae9fSMatthew G Knepley   PetscSF                 sf;
204984330215SMatthew G. Knepley   PetscSection            s, gs;
2050d4d07f1eSToby Isaac   DMLocalToGlobalHookLink link;
2051ae5cfb4aSMatthew G. Knepley   const PetscScalar      *lArray;
2052ae5cfb4aSMatthew G. Knepley   PetscScalar            *gArray;
205384330215SMatthew G. Knepley   PetscBool               isInsert;
205484330215SMatthew G. Knepley   PetscErrorCode          ierr;
20559a42bb27SBarry Smith 
20569a42bb27SBarry Smith   PetscFunctionBegin;
2057171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2058d4d07f1eSToby Isaac   for (link=dm->ltoghook; link; link=link->next) {
2059d4d07f1eSToby Isaac     if (link->beginhook) {
2060d4d07f1eSToby Isaac       ierr = (*link->beginhook)(dm,l,mode,g,link->ctx);CHKERRQ(ierr);
2061d4d07f1eSToby Isaac     }
2062d4d07f1eSToby Isaac   }
20634c274da1SToby Isaac   ierr = DMLocalToGlobalHook_Constraints(dm,l,mode,g,NULL);CHKERRQ(ierr);
20647128ae9fSMatthew G Knepley   ierr = DMGetDefaultSF(dm, &sf);CHKERRQ(ierr);
206584330215SMatthew G. Knepley   ierr = DMGetDefaultSection(dm, &s);CHKERRQ(ierr);
20667128ae9fSMatthew G Knepley   switch (mode) {
20677128ae9fSMatthew G Knepley   case INSERT_VALUES:
20687128ae9fSMatthew G Knepley   case INSERT_ALL_VALUES:
206984330215SMatthew G. Knepley     isInsert = PETSC_TRUE; break;
20707128ae9fSMatthew G Knepley   case ADD_VALUES:
20717128ae9fSMatthew G Knepley   case ADD_ALL_VALUES:
207284330215SMatthew G. Knepley     isInsert = PETSC_FALSE; break;
20737128ae9fSMatthew G Knepley   default:
207482f516ccSBarry Smith     SETERRQ1(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
20757128ae9fSMatthew G Knepley   }
207684330215SMatthew G. Knepley   if (sf && !isInsert) {
2077ae5cfb4aSMatthew G. Knepley     ierr = VecGetArrayRead(l, &lArray);CHKERRQ(ierr);
20787128ae9fSMatthew G Knepley     ierr = VecGetArray(g, &gArray);CHKERRQ(ierr);
2079a9b180a6SBarry Smith     ierr = PetscSFReduceBegin(sf, MPIU_SCALAR, lArray, gArray, MPIU_SUM);CHKERRQ(ierr);
2080ae5cfb4aSMatthew G. Knepley     ierr = VecRestoreArrayRead(l, &lArray);CHKERRQ(ierr);
208184330215SMatthew G. Knepley     ierr = VecRestoreArray(g, &gArray);CHKERRQ(ierr);
208284330215SMatthew G. Knepley   } else if (s && isInsert) {
208384330215SMatthew G. Knepley     PetscInt gStart, pStart, pEnd, p;
208484330215SMatthew G. Knepley 
208584330215SMatthew G. Knepley     ierr = DMGetDefaultGlobalSection(dm, &gs);CHKERRQ(ierr);
208684330215SMatthew G. Knepley     ierr = PetscSectionGetChart(s, &pStart, &pEnd);CHKERRQ(ierr);
208784330215SMatthew G. Knepley     ierr = VecGetOwnershipRange(g, &gStart, NULL);CHKERRQ(ierr);
2088ae5cfb4aSMatthew G. Knepley     ierr = VecGetArrayRead(l, &lArray);CHKERRQ(ierr);
208984330215SMatthew G. Knepley     ierr = VecGetArray(g, &gArray);CHKERRQ(ierr);
209084330215SMatthew G. Knepley     for (p = pStart; p < pEnd; ++p) {
2091b3b16f48SMatthew G. Knepley       PetscInt dof, gdof, cdof, gcdof, off, goff, d, e;
209284330215SMatthew G. Knepley 
209384330215SMatthew G. Knepley       ierr = PetscSectionGetDof(s, p, &dof);CHKERRQ(ierr);
209403442857SMatthew G. Knepley       ierr = PetscSectionGetDof(gs, p, &gdof);CHKERRQ(ierr);
209584330215SMatthew G. Knepley       ierr = PetscSectionGetConstraintDof(s, p, &cdof);CHKERRQ(ierr);
2096b3b16f48SMatthew G. Knepley       ierr = PetscSectionGetConstraintDof(gs, p, &gcdof);CHKERRQ(ierr);
209784330215SMatthew G. Knepley       ierr = PetscSectionGetOffset(s, p, &off);CHKERRQ(ierr);
209884330215SMatthew G. Knepley       ierr = PetscSectionGetOffset(gs, p, &goff);CHKERRQ(ierr);
2099b3b16f48SMatthew G. Knepley       /* Ignore off-process data and points with no global data */
210003442857SMatthew G. Knepley       if (!gdof || goff < 0) continue;
2101b3b16f48SMatthew 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);
2102b3b16f48SMatthew G. Knepley       /* If no constraints are enforced in the global vector */
2103b3b16f48SMatthew G. Knepley       if (!gcdof) {
210484330215SMatthew G. Knepley         for (d = 0; d < dof; ++d) gArray[goff-gStart+d] = lArray[off+d];
2105b3b16f48SMatthew G. Knepley       /* If constraints are enforced in the global vector */
2106b3b16f48SMatthew G. Knepley       } else if (cdof == gcdof) {
210784330215SMatthew G. Knepley         const PetscInt *cdofs;
210884330215SMatthew G. Knepley         PetscInt        cind = 0;
210984330215SMatthew G. Knepley 
211084330215SMatthew G. Knepley         ierr = PetscSectionGetConstraintIndices(s, p, &cdofs);CHKERRQ(ierr);
2111b3b16f48SMatthew G. Knepley         for (d = 0, e = 0; d < dof; ++d) {
211284330215SMatthew G. Knepley           if ((cind < cdof) && (d == cdofs[cind])) {++cind; continue;}
2113b3b16f48SMatthew G. Knepley           gArray[goff-gStart+e++] = lArray[off+d];
211484330215SMatthew G. Knepley         }
2115b3b16f48SMatthew 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);
211684330215SMatthew G. Knepley     }
2117ae5cfb4aSMatthew G. Knepley     ierr = VecRestoreArrayRead(l, &lArray);CHKERRQ(ierr);
21187128ae9fSMatthew G Knepley     ierr = VecRestoreArray(g, &gArray);CHKERRQ(ierr);
21197128ae9fSMatthew G Knepley   } else {
2120843c4018SMatthew G Knepley     ierr = (*dm->ops->localtoglobalbegin)(dm,l,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),g);CHKERRQ(ierr);
21217128ae9fSMatthew G Knepley   }
21229a42bb27SBarry Smith   PetscFunctionReturn(0);
21239a42bb27SBarry Smith }
21249a42bb27SBarry Smith 
21259a42bb27SBarry Smith #undef __FUNCT__
21269a42bb27SBarry Smith #define __FUNCT__ "DMLocalToGlobalEnd"
21279a42bb27SBarry Smith /*@
21289a42bb27SBarry Smith     DMLocalToGlobalEnd - updates global vectors from local vectors
212947c6ae99SBarry Smith 
213047c6ae99SBarry Smith     Neighbor-wise Collective on DM
213147c6ae99SBarry Smith 
213247c6ae99SBarry Smith     Input Parameters:
213347c6ae99SBarry Smith +   dm - the DM object
2134f6813fd5SJed Brown .   l - the local vector
213547c6ae99SBarry Smith .   mode - INSERT_VALUES or ADD_VALUES
2136f6813fd5SJed Brown -   g - the global vector
213747c6ae99SBarry Smith 
213847c6ae99SBarry Smith 
213947c6ae99SBarry Smith     Level: beginner
214047c6ae99SBarry Smith 
2141e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMGlobalToLocalEnd()
214247c6ae99SBarry Smith 
214347c6ae99SBarry Smith @*/
21447087cfbeSBarry Smith PetscErrorCode  DMLocalToGlobalEnd(DM dm,Vec l,InsertMode mode,Vec g)
214547c6ae99SBarry Smith {
21467128ae9fSMatthew G Knepley   PetscSF                 sf;
214784330215SMatthew G. Knepley   PetscSection            s;
2148d4d07f1eSToby Isaac   DMLocalToGlobalHookLink link;
214984330215SMatthew G. Knepley   PetscBool               isInsert;
215084330215SMatthew G. Knepley   PetscErrorCode          ierr;
215147c6ae99SBarry Smith 
215247c6ae99SBarry Smith   PetscFunctionBegin;
2153171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
21547128ae9fSMatthew G Knepley   ierr = DMGetDefaultSF(dm, &sf);CHKERRQ(ierr);
215584330215SMatthew G. Knepley   ierr = DMGetDefaultSection(dm, &s);CHKERRQ(ierr);
21567128ae9fSMatthew G Knepley   switch (mode) {
21577128ae9fSMatthew G Knepley   case INSERT_VALUES:
21587128ae9fSMatthew G Knepley   case INSERT_ALL_VALUES:
215984330215SMatthew G. Knepley     isInsert = PETSC_TRUE; break;
21607128ae9fSMatthew G Knepley   case ADD_VALUES:
21617128ae9fSMatthew G Knepley   case ADD_ALL_VALUES:
216284330215SMatthew G. Knepley     isInsert = PETSC_FALSE; break;
21637128ae9fSMatthew G Knepley   default:
216482f516ccSBarry Smith     SETERRQ1(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
21657128ae9fSMatthew G Knepley   }
216684330215SMatthew G. Knepley   if (sf && !isInsert) {
2167ae5cfb4aSMatthew G. Knepley     const PetscScalar *lArray;
2168ae5cfb4aSMatthew G. Knepley     PetscScalar       *gArray;
216984330215SMatthew G. Knepley 
2170ae5cfb4aSMatthew G. Knepley     ierr = VecGetArrayRead(l, &lArray);CHKERRQ(ierr);
21717128ae9fSMatthew G Knepley     ierr = VecGetArray(g, &gArray);CHKERRQ(ierr);
2172a9b180a6SBarry Smith     ierr = PetscSFReduceEnd(sf, MPIU_SCALAR, lArray, gArray, MPIU_SUM);CHKERRQ(ierr);
2173ae5cfb4aSMatthew G. Knepley     ierr = VecRestoreArrayRead(l, &lArray);CHKERRQ(ierr);
21747128ae9fSMatthew G Knepley     ierr = VecRestoreArray(g, &gArray);CHKERRQ(ierr);
217584330215SMatthew G. Knepley   } else if (s && isInsert) {
21767128ae9fSMatthew G Knepley   } else {
2177843c4018SMatthew G Knepley     ierr = (*dm->ops->localtoglobalend)(dm,l,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),g);CHKERRQ(ierr);
21787128ae9fSMatthew G Knepley   }
2179d4d07f1eSToby Isaac   for (link=dm->ltoghook; link; link=link->next) {
2180d4d07f1eSToby Isaac     if (link->endhook) {ierr = (*link->endhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);}
2181d4d07f1eSToby Isaac   }
218247c6ae99SBarry Smith   PetscFunctionReturn(0);
218347c6ae99SBarry Smith }
218447c6ae99SBarry Smith 
218547c6ae99SBarry Smith #undef __FUNCT__
2186f089877aSRichard Tran Mills #define __FUNCT__ "DMLocalToLocalBegin"
2187f089877aSRichard Tran Mills /*@
2188bc0a1609SRichard Tran Mills    DMLocalToLocalBegin - Maps from a local vector (including ghost points
2189bc0a1609SRichard Tran Mills    that contain irrelevant values) to another local vector where the ghost
2190d78e899eSRichard Tran Mills    points in the second are set correctly. Must be followed by DMLocalToLocalEnd().
2191f089877aSRichard Tran Mills 
2192bc0a1609SRichard Tran Mills    Neighbor-wise Collective on DM and Vec
2193f089877aSRichard Tran Mills 
2194f089877aSRichard Tran Mills    Input Parameters:
2195f089877aSRichard Tran Mills +  dm - the DM object
2196bc0a1609SRichard Tran Mills .  g - the original local vector
2197bc0a1609SRichard Tran Mills -  mode - one of INSERT_VALUES or ADD_VALUES
2198f089877aSRichard Tran Mills 
2199bc0a1609SRichard Tran Mills    Output Parameter:
2200bc0a1609SRichard Tran Mills .  l  - the local vector with correct ghost values
2201f089877aSRichard Tran Mills 
2202f089877aSRichard Tran Mills    Level: intermediate
2203f089877aSRichard Tran Mills 
2204bc0a1609SRichard Tran Mills    Notes:
2205bc0a1609SRichard Tran Mills    The local vectors used here need not be the same as those
2206bc0a1609SRichard Tran Mills    obtained from DMCreateLocalVector(), BUT they
2207bc0a1609SRichard Tran Mills    must have the same parallel data layout; they could, for example, be
2208bc0a1609SRichard Tran Mills    obtained with VecDuplicate() from the DM originating vectors.
2209bc0a1609SRichard Tran Mills 
2210bc0a1609SRichard Tran Mills .keywords: DM, local-to-local, begin
2211bc0a1609SRichard Tran Mills .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateLocalVector(), DMCreateGlobalVector(), DMCreateInterpolation(), DMLocalToLocalEnd(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin()
2212f089877aSRichard Tran Mills 
2213f089877aSRichard Tran Mills @*/
2214f089877aSRichard Tran Mills PetscErrorCode  DMLocalToLocalBegin(DM dm,Vec g,InsertMode mode,Vec l)
2215f089877aSRichard Tran Mills {
2216f089877aSRichard Tran Mills   PetscErrorCode          ierr;
2217f089877aSRichard Tran Mills 
2218f089877aSRichard Tran Mills   PetscFunctionBegin;
2219f089877aSRichard Tran Mills   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2220f089877aSRichard Tran Mills   ierr = (*dm->ops->localtolocalbegin)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
2221f089877aSRichard Tran Mills   PetscFunctionReturn(0);
2222f089877aSRichard Tran Mills }
2223f089877aSRichard Tran Mills 
2224f089877aSRichard Tran Mills #undef __FUNCT__
2225f089877aSRichard Tran Mills #define __FUNCT__ "DMLocalToLocalEnd"
2226f089877aSRichard Tran Mills /*@
2227bc0a1609SRichard Tran Mills    DMLocalToLocalEnd - Maps from a local vector (including ghost points
2228bc0a1609SRichard Tran Mills    that contain irrelevant values) to another local vector where the ghost
2229d78e899eSRichard Tran Mills    points in the second are set correctly. Must be preceded by DMLocalToLocalBegin().
2230f089877aSRichard Tran Mills 
2231bc0a1609SRichard Tran Mills    Neighbor-wise Collective on DM and Vec
2232f089877aSRichard Tran Mills 
2233f089877aSRichard Tran Mills    Input Parameters:
2234bc0a1609SRichard Tran Mills +  da - the DM object
2235bc0a1609SRichard Tran Mills .  g - the original local vector
2236bc0a1609SRichard Tran Mills -  mode - one of INSERT_VALUES or ADD_VALUES
2237f089877aSRichard Tran Mills 
2238bc0a1609SRichard Tran Mills    Output Parameter:
2239bc0a1609SRichard Tran Mills .  l  - the local vector with correct ghost values
2240f089877aSRichard Tran Mills 
2241f089877aSRichard Tran Mills    Level: intermediate
2242f089877aSRichard Tran Mills 
2243bc0a1609SRichard Tran Mills    Notes:
2244bc0a1609SRichard Tran Mills    The local vectors used here need not be the same as those
2245bc0a1609SRichard Tran Mills    obtained from DMCreateLocalVector(), BUT they
2246bc0a1609SRichard Tran Mills    must have the same parallel data layout; they could, for example, be
2247bc0a1609SRichard Tran Mills    obtained with VecDuplicate() from the DM originating vectors.
2248bc0a1609SRichard Tran Mills 
2249bc0a1609SRichard Tran Mills .keywords: DM, local-to-local, end
2250bc0a1609SRichard Tran Mills .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateLocalVector(), DMCreateGlobalVector(), DMCreateInterpolation(), DMLocalToLocalBegin(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin()
2251f089877aSRichard Tran Mills 
2252f089877aSRichard Tran Mills @*/
2253f089877aSRichard Tran Mills PetscErrorCode  DMLocalToLocalEnd(DM dm,Vec g,InsertMode mode,Vec l)
2254f089877aSRichard Tran Mills {
2255f089877aSRichard Tran Mills   PetscErrorCode          ierr;
2256f089877aSRichard Tran Mills 
2257f089877aSRichard Tran Mills   PetscFunctionBegin;
2258f089877aSRichard Tran Mills   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2259f089877aSRichard Tran Mills   ierr = (*dm->ops->localtolocalend)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
2260f089877aSRichard Tran Mills   PetscFunctionReturn(0);
2261f089877aSRichard Tran Mills }
2262f089877aSRichard Tran Mills 
2263f089877aSRichard Tran Mills 
2264f089877aSRichard Tran Mills #undef __FUNCT__
226547c6ae99SBarry Smith #define __FUNCT__ "DMCoarsen"
226647c6ae99SBarry Smith /*@
226747c6ae99SBarry Smith     DMCoarsen - Coarsens a DM object
226847c6ae99SBarry Smith 
226947c6ae99SBarry Smith     Collective on DM
227047c6ae99SBarry Smith 
227147c6ae99SBarry Smith     Input Parameter:
227247c6ae99SBarry Smith +   dm - the DM object
227391d95f02SJed Brown -   comm - the communicator to contain the new DM object (or MPI_COMM_NULL)
227447c6ae99SBarry Smith 
227547c6ae99SBarry Smith     Output Parameter:
227647c6ae99SBarry Smith .   dmc - the coarsened DM
227747c6ae99SBarry Smith 
227847c6ae99SBarry Smith     Level: developer
227947c6ae99SBarry Smith 
2280e727c939SJed Brown .seealso DMRefine(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
228147c6ae99SBarry Smith 
228247c6ae99SBarry Smith @*/
22837087cfbeSBarry Smith PetscErrorCode DMCoarsen(DM dm, MPI_Comm comm, DM *dmc)
228447c6ae99SBarry Smith {
228547c6ae99SBarry Smith   PetscErrorCode    ierr;
2286b17ce1afSJed Brown   DMCoarsenHookLink link;
228747c6ae99SBarry Smith 
228847c6ae99SBarry Smith   PetscFunctionBegin;
2289171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
229047a35634SPatrick Farrell   ierr = PetscLogEventBegin(DM_Coarsen,dm,0,0,0);CHKERRQ(ierr);
229147c6ae99SBarry Smith   ierr                      = (*dm->ops->coarsen)(dm, comm, dmc);CHKERRQ(ierr);
22928892b4c3SMatthew G. Knepley   if (!(*dmc)) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "NULL coarse mesh produced");
2293a8fb8f29SToby Isaac   ierr = DMSetCoarseDM(dm,*dmc);CHKERRQ(ierr);
229443842a1eSJed Brown   (*dmc)->ops->creatematrix = dm->ops->creatematrix;
22958cd211a4SJed Brown   ierr                      = PetscObjectCopyFortranFunctionPointers((PetscObject)dm,(PetscObject)*dmc);CHKERRQ(ierr);
2296644e2e5bSBarry Smith   (*dmc)->ctx               = dm->ctx;
22970598a293SJed Brown   (*dmc)->levelup           = dm->levelup;
2298656b349aSBarry Smith   (*dmc)->leveldown         = dm->leveldown + 1;
2299e4b4b23bSJed Brown   ierr                      = DMSetMatType(*dmc,dm->mattype);CHKERRQ(ierr);
2300b17ce1afSJed Brown   for (link=dm->coarsenhook; link; link=link->next) {
2301b17ce1afSJed Brown     if (link->coarsenhook) {ierr = (*link->coarsenhook)(dm,*dmc,link->ctx);CHKERRQ(ierr);}
2302b17ce1afSJed Brown   }
230347a35634SPatrick Farrell   ierr = PetscLogEventEnd(DM_Coarsen,dm,0,0,0);CHKERRQ(ierr);
2304b17ce1afSJed Brown   PetscFunctionReturn(0);
2305b17ce1afSJed Brown }
2306b17ce1afSJed Brown 
2307b17ce1afSJed Brown #undef __FUNCT__
2308b17ce1afSJed Brown #define __FUNCT__ "DMCoarsenHookAdd"
2309bb9467b5SJed Brown /*@C
2310b17ce1afSJed Brown    DMCoarsenHookAdd - adds a callback to be run when restricting a nonlinear problem to the coarse grid
2311b17ce1afSJed Brown 
2312b17ce1afSJed Brown    Logically Collective
2313b17ce1afSJed Brown 
2314b17ce1afSJed Brown    Input Arguments:
2315b17ce1afSJed Brown +  fine - nonlinear solver context on which to run a hook when restricting to a coarser level
2316b17ce1afSJed Brown .  coarsenhook - function to run when setting up a coarser level
2317b17ce1afSJed Brown .  restricthook - function to run to update data on coarser levels (once per SNESSolve())
23180298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
2319b17ce1afSJed Brown 
2320b17ce1afSJed Brown    Calling sequence of coarsenhook:
2321b17ce1afSJed Brown $    coarsenhook(DM fine,DM coarse,void *ctx);
2322b17ce1afSJed Brown 
2323b17ce1afSJed Brown +  fine - fine level DM
2324b17ce1afSJed Brown .  coarse - coarse level DM to restrict problem to
2325b17ce1afSJed Brown -  ctx - optional user-defined function context
2326b17ce1afSJed Brown 
2327b17ce1afSJed Brown    Calling sequence for restricthook:
2328c833c3b5SJed Brown $    restricthook(DM fine,Mat mrestrict,Vec rscale,Mat inject,DM coarse,void *ctx)
2329b17ce1afSJed Brown 
2330b17ce1afSJed Brown +  fine - fine level DM
2331b17ce1afSJed Brown .  mrestrict - matrix restricting a fine-level solution to the coarse grid
2332c833c3b5SJed Brown .  rscale - scaling vector for restriction
2333c833c3b5SJed Brown .  inject - matrix restricting by injection
2334b17ce1afSJed Brown .  coarse - coarse level DM to update
2335b17ce1afSJed Brown -  ctx - optional user-defined function context
2336b17ce1afSJed Brown 
2337b17ce1afSJed Brown    Level: advanced
2338b17ce1afSJed Brown 
2339b17ce1afSJed Brown    Notes:
2340b17ce1afSJed Brown    This function is only needed if auxiliary data needs to be set up on coarse grids.
2341b17ce1afSJed Brown 
2342b17ce1afSJed Brown    If this function is called multiple times, the hooks will be run in the order they are added.
2343b17ce1afSJed Brown 
2344b17ce1afSJed Brown    In order to compose with nonlinear preconditioning without duplicating storage, the hook should be implemented to
2345b17ce1afSJed Brown    extract the finest level information from its context (instead of from the SNES).
2346b17ce1afSJed Brown 
2347bb9467b5SJed Brown    This function is currently not available from Fortran.
2348bb9467b5SJed Brown 
2349c833c3b5SJed Brown .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
2350b17ce1afSJed Brown @*/
2351b17ce1afSJed Brown PetscErrorCode DMCoarsenHookAdd(DM fine,PetscErrorCode (*coarsenhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,Mat,Vec,Mat,DM,void*),void *ctx)
2352b17ce1afSJed Brown {
2353b17ce1afSJed Brown   PetscErrorCode    ierr;
2354b17ce1afSJed Brown   DMCoarsenHookLink link,*p;
2355b17ce1afSJed Brown 
2356b17ce1afSJed Brown   PetscFunctionBegin;
2357b17ce1afSJed Brown   PetscValidHeaderSpecific(fine,DM_CLASSID,1);
23586bfea28cSJed Brown   for (p=&fine->coarsenhook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */
2359b17ce1afSJed Brown   ierr               = PetscMalloc(sizeof(struct _DMCoarsenHookLink),&link);CHKERRQ(ierr);
2360b17ce1afSJed Brown   link->coarsenhook  = coarsenhook;
2361b17ce1afSJed Brown   link->restricthook = restricthook;
2362b17ce1afSJed Brown   link->ctx          = ctx;
23630298fd71SBarry Smith   link->next         = NULL;
2364b17ce1afSJed Brown   *p                 = link;
2365b17ce1afSJed Brown   PetscFunctionReturn(0);
2366b17ce1afSJed Brown }
2367b17ce1afSJed Brown 
2368b17ce1afSJed Brown #undef __FUNCT__
2369b17ce1afSJed Brown #define __FUNCT__ "DMRestrict"
2370b17ce1afSJed Brown /*@
2371b17ce1afSJed Brown    DMRestrict - restricts user-defined problem data to a coarser DM by running hooks registered by DMCoarsenHookAdd()
2372b17ce1afSJed Brown 
2373b17ce1afSJed Brown    Collective if any hooks are
2374b17ce1afSJed Brown 
2375b17ce1afSJed Brown    Input Arguments:
2376b17ce1afSJed Brown +  fine - finer DM to use as a base
2377b17ce1afSJed Brown .  restrct - restriction matrix, apply using MatRestrict()
2378b17ce1afSJed Brown .  inject - injection matrix, also use MatRestrict()
2379b17ce1afSJed Brown -  coarse - coarer DM to update
2380b17ce1afSJed Brown 
2381b17ce1afSJed Brown    Level: developer
2382b17ce1afSJed Brown 
2383b17ce1afSJed Brown .seealso: DMCoarsenHookAdd(), MatRestrict()
2384b17ce1afSJed Brown @*/
2385b17ce1afSJed Brown PetscErrorCode DMRestrict(DM fine,Mat restrct,Vec rscale,Mat inject,DM coarse)
2386b17ce1afSJed Brown {
2387b17ce1afSJed Brown   PetscErrorCode    ierr;
2388b17ce1afSJed Brown   DMCoarsenHookLink link;
2389b17ce1afSJed Brown 
2390b17ce1afSJed Brown   PetscFunctionBegin;
2391b17ce1afSJed Brown   for (link=fine->coarsenhook; link; link=link->next) {
23928865f1eaSKarl Rupp     if (link->restricthook) {
23938865f1eaSKarl Rupp       ierr = (*link->restricthook)(fine,restrct,rscale,inject,coarse,link->ctx);CHKERRQ(ierr);
23948865f1eaSKarl Rupp     }
2395b17ce1afSJed Brown   }
239647c6ae99SBarry Smith   PetscFunctionReturn(0);
239747c6ae99SBarry Smith }
239847c6ae99SBarry Smith 
239947c6ae99SBarry Smith #undef __FUNCT__
2400be081cd6SPeter Brune #define __FUNCT__ "DMSubDomainHookAdd"
2401bb9467b5SJed Brown /*@C
2402be081cd6SPeter Brune    DMSubDomainHookAdd - adds a callback to be run when restricting a problem to the coarse grid
24035dbd56e3SPeter Brune 
24045dbd56e3SPeter Brune    Logically Collective
24055dbd56e3SPeter Brune 
24065dbd56e3SPeter Brune    Input Arguments:
24075dbd56e3SPeter Brune +  global - global DM
2408ec4806b8SPeter Brune .  ddhook - function to run to pass data to the decomposition DM upon its creation
24095dbd56e3SPeter Brune .  restricthook - function to run to update data on block solve (at the beginning of the block solve)
24100298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
24115dbd56e3SPeter Brune 
2412ec4806b8SPeter Brune 
2413ec4806b8SPeter Brune    Calling sequence for ddhook:
2414ec4806b8SPeter Brune $    ddhook(DM global,DM block,void *ctx)
2415ec4806b8SPeter Brune 
2416ec4806b8SPeter Brune +  global - global DM
2417ec4806b8SPeter Brune .  block  - block DM
2418ec4806b8SPeter Brune -  ctx - optional user-defined function context
2419ec4806b8SPeter Brune 
24205dbd56e3SPeter Brune    Calling sequence for restricthook:
2421ec4806b8SPeter Brune $    restricthook(DM global,VecScatter out,VecScatter in,DM block,void *ctx)
24225dbd56e3SPeter Brune 
24235dbd56e3SPeter Brune +  global - global DM
24245dbd56e3SPeter Brune .  out    - scatter to the outer (with ghost and overlap points) block vector
24255dbd56e3SPeter Brune .  in     - scatter to block vector values only owned locally
2426ec4806b8SPeter Brune .  block  - block DM
24275dbd56e3SPeter Brune -  ctx - optional user-defined function context
24285dbd56e3SPeter Brune 
24295dbd56e3SPeter Brune    Level: advanced
24305dbd56e3SPeter Brune 
24315dbd56e3SPeter Brune    Notes:
2432ec4806b8SPeter Brune    This function is only needed if auxiliary data needs to be set up on subdomain DMs.
24335dbd56e3SPeter Brune 
24345dbd56e3SPeter Brune    If this function is called multiple times, the hooks will be run in the order they are added.
24355dbd56e3SPeter Brune 
24365dbd56e3SPeter Brune    In order to compose with nonlinear preconditioning without duplicating storage, the hook should be implemented to
2437ec4806b8SPeter Brune    extract the global information from its context (instead of from the SNES).
24385dbd56e3SPeter Brune 
2439bb9467b5SJed Brown    This function is currently not available from Fortran.
2440bb9467b5SJed Brown 
24415dbd56e3SPeter Brune .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
24425dbd56e3SPeter Brune @*/
2443be081cd6SPeter Brune PetscErrorCode DMSubDomainHookAdd(DM global,PetscErrorCode (*ddhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,VecScatter,VecScatter,DM,void*),void *ctx)
24445dbd56e3SPeter Brune {
24455dbd56e3SPeter Brune   PetscErrorCode      ierr;
2446be081cd6SPeter Brune   DMSubDomainHookLink link,*p;
24475dbd56e3SPeter Brune 
24485dbd56e3SPeter Brune   PetscFunctionBegin;
24495dbd56e3SPeter Brune   PetscValidHeaderSpecific(global,DM_CLASSID,1);
2450be081cd6SPeter Brune   for (p=&global->subdomainhook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */
2451be081cd6SPeter Brune   ierr               = PetscMalloc(sizeof(struct _DMSubDomainHookLink),&link);CHKERRQ(ierr);
24525dbd56e3SPeter Brune   link->restricthook = restricthook;
2453be081cd6SPeter Brune   link->ddhook       = ddhook;
24545dbd56e3SPeter Brune   link->ctx          = ctx;
24550298fd71SBarry Smith   link->next         = NULL;
24565dbd56e3SPeter Brune   *p                 = link;
24575dbd56e3SPeter Brune   PetscFunctionReturn(0);
24585dbd56e3SPeter Brune }
24595dbd56e3SPeter Brune 
24605dbd56e3SPeter Brune #undef __FUNCT__
2461be081cd6SPeter Brune #define __FUNCT__ "DMSubDomainRestrict"
24625dbd56e3SPeter Brune /*@
2463be081cd6SPeter Brune    DMSubDomainRestrict - restricts user-defined problem data to a block DM by running hooks registered by DMSubDomainHookAdd()
24645dbd56e3SPeter Brune 
24655dbd56e3SPeter Brune    Collective if any hooks are
24665dbd56e3SPeter Brune 
24675dbd56e3SPeter Brune    Input Arguments:
24685dbd56e3SPeter Brune +  fine - finer DM to use as a base
2469be081cd6SPeter Brune .  oscatter - scatter from domain global vector filling subdomain global vector with overlap
2470be081cd6SPeter Brune .  gscatter - scatter from domain global vector filling subdomain local vector with ghosts
24715dbd56e3SPeter Brune -  coarse - coarer DM to update
24725dbd56e3SPeter Brune 
24735dbd56e3SPeter Brune    Level: developer
24745dbd56e3SPeter Brune 
24755dbd56e3SPeter Brune .seealso: DMCoarsenHookAdd(), MatRestrict()
24765dbd56e3SPeter Brune @*/
2477be081cd6SPeter Brune PetscErrorCode DMSubDomainRestrict(DM global,VecScatter oscatter,VecScatter gscatter,DM subdm)
24785dbd56e3SPeter Brune {
24795dbd56e3SPeter Brune   PetscErrorCode      ierr;
2480be081cd6SPeter Brune   DMSubDomainHookLink link;
24815dbd56e3SPeter Brune 
24825dbd56e3SPeter Brune   PetscFunctionBegin;
2483be081cd6SPeter Brune   for (link=global->subdomainhook; link; link=link->next) {
24848865f1eaSKarl Rupp     if (link->restricthook) {
24858865f1eaSKarl Rupp       ierr = (*link->restricthook)(global,oscatter,gscatter,subdm,link->ctx);CHKERRQ(ierr);
24868865f1eaSKarl Rupp     }
24875dbd56e3SPeter Brune   }
24885dbd56e3SPeter Brune   PetscFunctionReturn(0);
24895dbd56e3SPeter Brune }
24905dbd56e3SPeter Brune 
24915dbd56e3SPeter Brune #undef __FUNCT__
24925fe1f584SPeter Brune #define __FUNCT__ "DMGetCoarsenLevel"
24935fe1f584SPeter Brune /*@
24946a7d9d85SPeter Brune     DMGetCoarsenLevel - Get's the number of coarsenings that have generated this DM.
24955fe1f584SPeter Brune 
24965fe1f584SPeter Brune     Not Collective
24975fe1f584SPeter Brune 
24985fe1f584SPeter Brune     Input Parameter:
24995fe1f584SPeter Brune .   dm - the DM object
25005fe1f584SPeter Brune 
25015fe1f584SPeter Brune     Output Parameter:
25026a7d9d85SPeter Brune .   level - number of coarsenings
25035fe1f584SPeter Brune 
25045fe1f584SPeter Brune     Level: developer
25055fe1f584SPeter Brune 
25066a7d9d85SPeter Brune .seealso DMCoarsen(), DMGetRefineLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
25075fe1f584SPeter Brune 
25085fe1f584SPeter Brune @*/
25095fe1f584SPeter Brune PetscErrorCode  DMGetCoarsenLevel(DM dm,PetscInt *level)
25105fe1f584SPeter Brune {
25115fe1f584SPeter Brune   PetscFunctionBegin;
25125fe1f584SPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
25135fe1f584SPeter Brune   *level = dm->leveldown;
25145fe1f584SPeter Brune   PetscFunctionReturn(0);
25155fe1f584SPeter Brune }
25165fe1f584SPeter Brune 
25175fe1f584SPeter Brune 
25185fe1f584SPeter Brune 
25195fe1f584SPeter Brune #undef __FUNCT__
252047c6ae99SBarry Smith #define __FUNCT__ "DMRefineHierarchy"
252147c6ae99SBarry Smith /*@C
252247c6ae99SBarry Smith     DMRefineHierarchy - Refines a DM object, all levels at once
252347c6ae99SBarry Smith 
252447c6ae99SBarry Smith     Collective on DM
252547c6ae99SBarry Smith 
252647c6ae99SBarry Smith     Input Parameter:
252747c6ae99SBarry Smith +   dm - the DM object
252847c6ae99SBarry Smith -   nlevels - the number of levels of refinement
252947c6ae99SBarry Smith 
253047c6ae99SBarry Smith     Output Parameter:
253147c6ae99SBarry Smith .   dmf - the refined DM hierarchy
253247c6ae99SBarry Smith 
253347c6ae99SBarry Smith     Level: developer
253447c6ae99SBarry Smith 
2535e727c939SJed Brown .seealso DMCoarsenHierarchy(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
253647c6ae99SBarry Smith 
253747c6ae99SBarry Smith @*/
25387087cfbeSBarry Smith PetscErrorCode  DMRefineHierarchy(DM dm,PetscInt nlevels,DM dmf[])
253947c6ae99SBarry Smith {
254047c6ae99SBarry Smith   PetscErrorCode ierr;
254147c6ae99SBarry Smith 
254247c6ae99SBarry Smith   PetscFunctionBegin;
2543171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2544ce94432eSBarry Smith   if (nlevels < 0) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_OUTOFRANGE,"nlevels cannot be negative");
254547c6ae99SBarry Smith   if (nlevels == 0) PetscFunctionReturn(0);
254647c6ae99SBarry Smith   if (dm->ops->refinehierarchy) {
254747c6ae99SBarry Smith     ierr = (*dm->ops->refinehierarchy)(dm,nlevels,dmf);CHKERRQ(ierr);
254847c6ae99SBarry Smith   } else if (dm->ops->refine) {
254947c6ae99SBarry Smith     PetscInt i;
255047c6ae99SBarry Smith 
2551ce94432eSBarry Smith     ierr = DMRefine(dm,PetscObjectComm((PetscObject)dm),&dmf[0]);CHKERRQ(ierr);
255247c6ae99SBarry Smith     for (i=1; i<nlevels; i++) {
2553ce94432eSBarry Smith       ierr = DMRefine(dmf[i-1],PetscObjectComm((PetscObject)dm),&dmf[i]);CHKERRQ(ierr);
255447c6ae99SBarry Smith     }
2555ce94432eSBarry Smith   } else SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"No RefineHierarchy for this DM yet");
255647c6ae99SBarry Smith   PetscFunctionReturn(0);
255747c6ae99SBarry Smith }
255847c6ae99SBarry Smith 
255947c6ae99SBarry Smith #undef __FUNCT__
256047c6ae99SBarry Smith #define __FUNCT__ "DMCoarsenHierarchy"
256147c6ae99SBarry Smith /*@C
256247c6ae99SBarry Smith     DMCoarsenHierarchy - Coarsens a DM object, all levels at once
256347c6ae99SBarry Smith 
256447c6ae99SBarry Smith     Collective on DM
256547c6ae99SBarry Smith 
256647c6ae99SBarry Smith     Input Parameter:
256747c6ae99SBarry Smith +   dm - the DM object
256847c6ae99SBarry Smith -   nlevels - the number of levels of coarsening
256947c6ae99SBarry Smith 
257047c6ae99SBarry Smith     Output Parameter:
257147c6ae99SBarry Smith .   dmc - the coarsened DM hierarchy
257247c6ae99SBarry Smith 
257347c6ae99SBarry Smith     Level: developer
257447c6ae99SBarry Smith 
2575e727c939SJed Brown .seealso DMRefineHierarchy(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
257647c6ae99SBarry Smith 
257747c6ae99SBarry Smith @*/
25787087cfbeSBarry Smith PetscErrorCode  DMCoarsenHierarchy(DM dm, PetscInt nlevels, DM dmc[])
257947c6ae99SBarry Smith {
258047c6ae99SBarry Smith   PetscErrorCode ierr;
258147c6ae99SBarry Smith 
258247c6ae99SBarry Smith   PetscFunctionBegin;
2583171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2584ce94432eSBarry Smith   if (nlevels < 0) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_OUTOFRANGE,"nlevels cannot be negative");
258547c6ae99SBarry Smith   if (nlevels == 0) PetscFunctionReturn(0);
258647c6ae99SBarry Smith   PetscValidPointer(dmc,3);
258747c6ae99SBarry Smith   if (dm->ops->coarsenhierarchy) {
258847c6ae99SBarry Smith     ierr = (*dm->ops->coarsenhierarchy)(dm, nlevels, dmc);CHKERRQ(ierr);
258947c6ae99SBarry Smith   } else if (dm->ops->coarsen) {
259047c6ae99SBarry Smith     PetscInt i;
259147c6ae99SBarry Smith 
2592ce94432eSBarry Smith     ierr = DMCoarsen(dm,PetscObjectComm((PetscObject)dm),&dmc[0]);CHKERRQ(ierr);
259347c6ae99SBarry Smith     for (i=1; i<nlevels; i++) {
2594ce94432eSBarry Smith       ierr = DMCoarsen(dmc[i-1],PetscObjectComm((PetscObject)dm),&dmc[i]);CHKERRQ(ierr);
259547c6ae99SBarry Smith     }
2596ce94432eSBarry Smith   } else SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"No CoarsenHierarchy for this DM yet");
259747c6ae99SBarry Smith   PetscFunctionReturn(0);
259847c6ae99SBarry Smith }
259947c6ae99SBarry Smith 
260047c6ae99SBarry Smith #undef __FUNCT__
2601e727c939SJed Brown #define __FUNCT__ "DMCreateAggregates"
260247c6ae99SBarry Smith /*@
2603e727c939SJed Brown    DMCreateAggregates - Gets the aggregates that map between
260447c6ae99SBarry Smith    grids associated with two DMs.
260547c6ae99SBarry Smith 
260647c6ae99SBarry Smith    Collective on DM
260747c6ae99SBarry Smith 
260847c6ae99SBarry Smith    Input Parameters:
260947c6ae99SBarry Smith +  dmc - the coarse grid DM
261047c6ae99SBarry Smith -  dmf - the fine grid DM
261147c6ae99SBarry Smith 
261247c6ae99SBarry Smith    Output Parameters:
261347c6ae99SBarry Smith .  rest - the restriction matrix (transpose of the projection matrix)
261447c6ae99SBarry Smith 
261547c6ae99SBarry Smith    Level: intermediate
261647c6ae99SBarry Smith 
261747c6ae99SBarry Smith .keywords: interpolation, restriction, multigrid
261847c6ae99SBarry Smith 
2619e727c939SJed Brown .seealso: DMRefine(), DMCreateInjection(), DMCreateInterpolation()
262047c6ae99SBarry Smith @*/
2621e727c939SJed Brown PetscErrorCode  DMCreateAggregates(DM dmc, DM dmf, Mat *rest)
262247c6ae99SBarry Smith {
262347c6ae99SBarry Smith   PetscErrorCode ierr;
262447c6ae99SBarry Smith 
262547c6ae99SBarry Smith   PetscFunctionBegin;
2626171400e9SBarry Smith   PetscValidHeaderSpecific(dmc,DM_CLASSID,1);
2627171400e9SBarry Smith   PetscValidHeaderSpecific(dmf,DM_CLASSID,2);
262847c6ae99SBarry Smith   ierr = (*dmc->ops->getaggregates)(dmc, dmf, rest);CHKERRQ(ierr);
262947c6ae99SBarry Smith   PetscFunctionReturn(0);
263047c6ae99SBarry Smith }
263147c6ae99SBarry Smith 
263247c6ae99SBarry Smith #undef __FUNCT__
26331a266240SBarry Smith #define __FUNCT__ "DMSetApplicationContextDestroy"
26341a266240SBarry Smith /*@C
26351a266240SBarry Smith     DMSetApplicationContextDestroy - Sets a user function that will be called to destroy the application context when the DM is destroyed
26361a266240SBarry Smith 
26371a266240SBarry Smith     Not Collective
26381a266240SBarry Smith 
26391a266240SBarry Smith     Input Parameters:
26401a266240SBarry Smith +   dm - the DM object
26411a266240SBarry Smith -   destroy - the destroy function
26421a266240SBarry Smith 
26431a266240SBarry Smith     Level: intermediate
26441a266240SBarry Smith 
2645e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
26461a266240SBarry Smith 
2647f07f9ceaSJed Brown @*/
26481a266240SBarry Smith PetscErrorCode  DMSetApplicationContextDestroy(DM dm,PetscErrorCode (*destroy)(void**))
26491a266240SBarry Smith {
26501a266240SBarry Smith   PetscFunctionBegin;
2651171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
26521a266240SBarry Smith   dm->ctxdestroy = destroy;
26531a266240SBarry Smith   PetscFunctionReturn(0);
26541a266240SBarry Smith }
26551a266240SBarry Smith 
26561a266240SBarry Smith #undef __FUNCT__
26571b2093e4SBarry Smith #define __FUNCT__ "DMSetApplicationContext"
2658b07ff414SBarry Smith /*@
26591b2093e4SBarry Smith     DMSetApplicationContext - Set a user context into a DM object
266047c6ae99SBarry Smith 
266147c6ae99SBarry Smith     Not Collective
266247c6ae99SBarry Smith 
266347c6ae99SBarry Smith     Input Parameters:
266447c6ae99SBarry Smith +   dm - the DM object
266547c6ae99SBarry Smith -   ctx - the user context
266647c6ae99SBarry Smith 
266747c6ae99SBarry Smith     Level: intermediate
266847c6ae99SBarry Smith 
2669e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
267047c6ae99SBarry Smith 
267147c6ae99SBarry Smith @*/
26721b2093e4SBarry Smith PetscErrorCode  DMSetApplicationContext(DM dm,void *ctx)
267347c6ae99SBarry Smith {
267447c6ae99SBarry Smith   PetscFunctionBegin;
2675171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
267647c6ae99SBarry Smith   dm->ctx = ctx;
267747c6ae99SBarry Smith   PetscFunctionReturn(0);
267847c6ae99SBarry Smith }
267947c6ae99SBarry Smith 
268047c6ae99SBarry Smith #undef __FUNCT__
26811b2093e4SBarry Smith #define __FUNCT__ "DMGetApplicationContext"
268247c6ae99SBarry Smith /*@
26831b2093e4SBarry Smith     DMGetApplicationContext - Gets a user context from a DM object
268447c6ae99SBarry Smith 
268547c6ae99SBarry Smith     Not Collective
268647c6ae99SBarry Smith 
268747c6ae99SBarry Smith     Input Parameter:
268847c6ae99SBarry Smith .   dm - the DM object
268947c6ae99SBarry Smith 
269047c6ae99SBarry Smith     Output Parameter:
269147c6ae99SBarry Smith .   ctx - the user context
269247c6ae99SBarry Smith 
269347c6ae99SBarry Smith     Level: intermediate
269447c6ae99SBarry Smith 
2695e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
269647c6ae99SBarry Smith 
269747c6ae99SBarry Smith @*/
26981b2093e4SBarry Smith PetscErrorCode  DMGetApplicationContext(DM dm,void *ctx)
269947c6ae99SBarry Smith {
270047c6ae99SBarry Smith   PetscFunctionBegin;
2701171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
27021b2093e4SBarry Smith   *(void**)ctx = dm->ctx;
270347c6ae99SBarry Smith   PetscFunctionReturn(0);
270447c6ae99SBarry Smith }
270547c6ae99SBarry Smith 
270647c6ae99SBarry Smith #undef __FUNCT__
270708da532bSDmitry Karpeev #define __FUNCT__ "DMSetVariableBounds"
270808da532bSDmitry Karpeev /*@C
2709df3898eeSBarry Smith     DMSetVariableBounds - sets a function to compute the lower and upper bound vectors for SNESVI.
271008da532bSDmitry Karpeev 
271108da532bSDmitry Karpeev     Logically Collective on DM
271208da532bSDmitry Karpeev 
271308da532bSDmitry Karpeev     Input Parameter:
271408da532bSDmitry Karpeev +   dm - the DM object
27150298fd71SBarry Smith -   f - the function that computes variable bounds used by SNESVI (use NULL to cancel a previous function that was set)
271608da532bSDmitry Karpeev 
271708da532bSDmitry Karpeev     Level: intermediate
271808da532bSDmitry Karpeev 
2719835c3ec7SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext(),
272008da532bSDmitry Karpeev          DMSetJacobian()
272108da532bSDmitry Karpeev 
272208da532bSDmitry Karpeev @*/
272308da532bSDmitry Karpeev PetscErrorCode  DMSetVariableBounds(DM dm,PetscErrorCode (*f)(DM,Vec,Vec))
272408da532bSDmitry Karpeev {
272508da532bSDmitry Karpeev   PetscFunctionBegin;
272608da532bSDmitry Karpeev   dm->ops->computevariablebounds = f;
272708da532bSDmitry Karpeev   PetscFunctionReturn(0);
272808da532bSDmitry Karpeev }
272908da532bSDmitry Karpeev 
273008da532bSDmitry Karpeev #undef __FUNCT__
273108da532bSDmitry Karpeev #define __FUNCT__ "DMHasVariableBounds"
273208da532bSDmitry Karpeev /*@
273308da532bSDmitry Karpeev     DMHasVariableBounds - does the DM object have a variable bounds function?
273408da532bSDmitry Karpeev 
273508da532bSDmitry Karpeev     Not Collective
273608da532bSDmitry Karpeev 
273708da532bSDmitry Karpeev     Input Parameter:
273808da532bSDmitry Karpeev .   dm - the DM object to destroy
273908da532bSDmitry Karpeev 
274008da532bSDmitry Karpeev     Output Parameter:
274108da532bSDmitry Karpeev .   flg - PETSC_TRUE if the variable bounds function exists
274208da532bSDmitry Karpeev 
274308da532bSDmitry Karpeev     Level: developer
274408da532bSDmitry Karpeev 
274574e1e8c1SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
274608da532bSDmitry Karpeev 
274708da532bSDmitry Karpeev @*/
274808da532bSDmitry Karpeev PetscErrorCode  DMHasVariableBounds(DM dm,PetscBool  *flg)
274908da532bSDmitry Karpeev {
275008da532bSDmitry Karpeev   PetscFunctionBegin;
275108da532bSDmitry Karpeev   *flg =  (dm->ops->computevariablebounds) ? PETSC_TRUE : PETSC_FALSE;
275208da532bSDmitry Karpeev   PetscFunctionReturn(0);
275308da532bSDmitry Karpeev }
275408da532bSDmitry Karpeev 
275508da532bSDmitry Karpeev #undef __FUNCT__
275608da532bSDmitry Karpeev #define __FUNCT__ "DMComputeVariableBounds"
275708da532bSDmitry Karpeev /*@C
275808da532bSDmitry Karpeev     DMComputeVariableBounds - compute variable bounds used by SNESVI.
275908da532bSDmitry Karpeev 
276008da532bSDmitry Karpeev     Logically Collective on DM
276108da532bSDmitry Karpeev 
276208da532bSDmitry Karpeev     Input Parameters:
2763907376e6SBarry Smith .   dm - the DM object
276408da532bSDmitry Karpeev 
276508da532bSDmitry Karpeev     Output parameters:
276608da532bSDmitry Karpeev +   xl - lower bound
276708da532bSDmitry Karpeev -   xu - upper bound
276808da532bSDmitry Karpeev 
2769907376e6SBarry Smith     Level: advanced
2770907376e6SBarry Smith 
2771907376e6SBarry Smith     Notes: This is generally not called by users. It calls the function provided by the user with DMSetVariableBounds()
277208da532bSDmitry Karpeev 
277374e1e8c1SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
277408da532bSDmitry Karpeev 
277508da532bSDmitry Karpeev @*/
277608da532bSDmitry Karpeev PetscErrorCode  DMComputeVariableBounds(DM dm, Vec xl, Vec xu)
277708da532bSDmitry Karpeev {
277808da532bSDmitry Karpeev   PetscErrorCode ierr;
27795fd66863SKarl Rupp 
278008da532bSDmitry Karpeev   PetscFunctionBegin;
278108da532bSDmitry Karpeev   PetscValidHeaderSpecific(xl,VEC_CLASSID,2);
278208da532bSDmitry Karpeev   PetscValidHeaderSpecific(xu,VEC_CLASSID,2);
278308da532bSDmitry Karpeev   if (dm->ops->computevariablebounds) {
278408da532bSDmitry Karpeev     ierr = (*dm->ops->computevariablebounds)(dm, xl,xu);CHKERRQ(ierr);
27858865f1eaSKarl Rupp   } else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, "This DM is incapable of computing variable bounds.");
278608da532bSDmitry Karpeev   PetscFunctionReturn(0);
278708da532bSDmitry Karpeev }
278808da532bSDmitry Karpeev 
278908da532bSDmitry Karpeev #undef __FUNCT__
2790b0ae01b7SPeter Brune #define __FUNCT__ "DMHasColoring"
2791b0ae01b7SPeter Brune /*@
2792b0ae01b7SPeter Brune     DMHasColoring - does the DM object have a method of providing a coloring?
2793b0ae01b7SPeter Brune 
2794b0ae01b7SPeter Brune     Not Collective
2795b0ae01b7SPeter Brune 
2796b0ae01b7SPeter Brune     Input Parameter:
2797b0ae01b7SPeter Brune .   dm - the DM object
2798b0ae01b7SPeter Brune 
2799b0ae01b7SPeter Brune     Output Parameter:
2800b0ae01b7SPeter Brune .   flg - PETSC_TRUE if the DM has facilities for DMCreateColoring().
2801b0ae01b7SPeter Brune 
2802b0ae01b7SPeter Brune     Level: developer
2803b0ae01b7SPeter Brune 
2804b0ae01b7SPeter Brune .seealso DMHasFunction(), DMCreateColoring()
2805b0ae01b7SPeter Brune 
2806b0ae01b7SPeter Brune @*/
2807b0ae01b7SPeter Brune PetscErrorCode  DMHasColoring(DM dm,PetscBool  *flg)
2808b0ae01b7SPeter Brune {
2809b0ae01b7SPeter Brune   PetscFunctionBegin;
2810b0ae01b7SPeter Brune   *flg =  (dm->ops->getcoloring) ? PETSC_TRUE : PETSC_FALSE;
2811b0ae01b7SPeter Brune   PetscFunctionReturn(0);
2812b0ae01b7SPeter Brune }
2813b0ae01b7SPeter Brune 
2814b0ae01b7SPeter Brune #undef  __FUNCT__
281508da532bSDmitry Karpeev #define __FUNCT__ "DMSetVec"
2816748fac09SDmitry Karpeev /*@C
281708da532bSDmitry Karpeev     DMSetVec - set the vector at which to compute residual, Jacobian and VI bounds, if the problem is nonlinear.
281808da532bSDmitry Karpeev 
281908da532bSDmitry Karpeev     Collective on DM
282008da532bSDmitry Karpeev 
282108da532bSDmitry Karpeev     Input Parameter:
282208da532bSDmitry Karpeev +   dm - the DM object
28230298fd71SBarry Smith -   x - location to compute residual and Jacobian, if NULL is passed to those routines; will be NULL for linear problems.
282408da532bSDmitry Karpeev 
282508da532bSDmitry Karpeev     Level: developer
282608da532bSDmitry Karpeev 
282774e1e8c1SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
282808da532bSDmitry Karpeev 
282908da532bSDmitry Karpeev @*/
283008da532bSDmitry Karpeev PetscErrorCode  DMSetVec(DM dm,Vec x)
283108da532bSDmitry Karpeev {
283208da532bSDmitry Karpeev   PetscErrorCode ierr;
28335fd66863SKarl Rupp 
283408da532bSDmitry Karpeev   PetscFunctionBegin;
283508da532bSDmitry Karpeev   if (x) {
283608da532bSDmitry Karpeev     if (!dm->x) {
283708da532bSDmitry Karpeev       ierr = DMCreateGlobalVector(dm,&dm->x);CHKERRQ(ierr);
283808da532bSDmitry Karpeev     }
283908da532bSDmitry Karpeev     ierr = VecCopy(x,dm->x);CHKERRQ(ierr);
28408865f1eaSKarl Rupp   } else if (dm->x) {
284108da532bSDmitry Karpeev     ierr = VecDestroy(&dm->x);CHKERRQ(ierr);
284208da532bSDmitry Karpeev   }
284308da532bSDmitry Karpeev   PetscFunctionReturn(0);
284408da532bSDmitry Karpeev }
284508da532bSDmitry Karpeev 
28460298fd71SBarry Smith PetscFunctionList DMList              = NULL;
2847264ace61SBarry Smith PetscBool         DMRegisterAllCalled = PETSC_FALSE;
2848264ace61SBarry Smith 
2849264ace61SBarry Smith #undef __FUNCT__
2850264ace61SBarry Smith #define __FUNCT__ "DMSetType"
2851264ace61SBarry Smith /*@C
2852264ace61SBarry Smith   DMSetType - Builds a DM, for a particular DM implementation.
2853264ace61SBarry Smith 
2854264ace61SBarry Smith   Collective on DM
2855264ace61SBarry Smith 
2856264ace61SBarry Smith   Input Parameters:
2857264ace61SBarry Smith + dm     - The DM object
2858264ace61SBarry Smith - method - The name of the DM type
2859264ace61SBarry Smith 
2860264ace61SBarry Smith   Options Database Key:
2861264ace61SBarry Smith . -dm_type <type> - Sets the DM type; use -help for a list of available types
2862264ace61SBarry Smith 
2863264ace61SBarry Smith   Notes:
2864e1589f56SBarry Smith   See "petsc/include/petscdm.h" for available DM types (for instance, DM1D, DM2D, or DM3D).
2865264ace61SBarry Smith 
2866264ace61SBarry Smith   Level: intermediate
2867264ace61SBarry Smith 
2868264ace61SBarry Smith .keywords: DM, set, type
2869264ace61SBarry Smith .seealso: DMGetType(), DMCreate()
2870264ace61SBarry Smith @*/
287119fd82e9SBarry Smith PetscErrorCode  DMSetType(DM dm, DMType method)
2872264ace61SBarry Smith {
2873264ace61SBarry Smith   PetscErrorCode (*r)(DM);
2874264ace61SBarry Smith   PetscBool      match;
2875264ace61SBarry Smith   PetscErrorCode ierr;
2876264ace61SBarry Smith 
2877264ace61SBarry Smith   PetscFunctionBegin;
2878264ace61SBarry Smith   PetscValidHeaderSpecific(dm, DM_CLASSID,1);
2879251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject) dm, method, &match);CHKERRQ(ierr);
2880264ace61SBarry Smith   if (match) PetscFunctionReturn(0);
2881264ace61SBarry Smith 
28820f51fdf8SToby Isaac   ierr = DMRegisterAll();CHKERRQ(ierr);
28831c9cd337SJed Brown   ierr = PetscFunctionListFind(DMList,method,&r);CHKERRQ(ierr);
2884ce94432eSBarry Smith   if (!r) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_UNKNOWN_TYPE, "Unknown DM type: %s", method);
2885264ace61SBarry Smith 
2886264ace61SBarry Smith   if (dm->ops->destroy) {
2887264ace61SBarry Smith     ierr             = (*dm->ops->destroy)(dm);CHKERRQ(ierr);
28880298fd71SBarry Smith     dm->ops->destroy = NULL;
2889264ace61SBarry Smith   }
2890264ace61SBarry Smith   ierr = (*r)(dm);CHKERRQ(ierr);
2891264ace61SBarry Smith   ierr = PetscObjectChangeTypeName((PetscObject)dm,method);CHKERRQ(ierr);
2892264ace61SBarry Smith   PetscFunctionReturn(0);
2893264ace61SBarry Smith }
2894264ace61SBarry Smith 
2895264ace61SBarry Smith #undef __FUNCT__
2896264ace61SBarry Smith #define __FUNCT__ "DMGetType"
2897264ace61SBarry Smith /*@C
2898264ace61SBarry Smith   DMGetType - Gets the DM type name (as a string) from the DM.
2899264ace61SBarry Smith 
2900264ace61SBarry Smith   Not Collective
2901264ace61SBarry Smith 
2902264ace61SBarry Smith   Input Parameter:
2903264ace61SBarry Smith . dm  - The DM
2904264ace61SBarry Smith 
2905264ace61SBarry Smith   Output Parameter:
2906264ace61SBarry Smith . type - The DM type name
2907264ace61SBarry Smith 
2908264ace61SBarry Smith   Level: intermediate
2909264ace61SBarry Smith 
2910264ace61SBarry Smith .keywords: DM, get, type, name
2911264ace61SBarry Smith .seealso: DMSetType(), DMCreate()
2912264ace61SBarry Smith @*/
291319fd82e9SBarry Smith PetscErrorCode  DMGetType(DM dm, DMType *type)
2914264ace61SBarry Smith {
2915264ace61SBarry Smith   PetscErrorCode ierr;
2916264ace61SBarry Smith 
2917264ace61SBarry Smith   PetscFunctionBegin;
2918264ace61SBarry Smith   PetscValidHeaderSpecific(dm, DM_CLASSID,1);
2919c959eef4SJed Brown   PetscValidPointer(type,2);
2920607a6623SBarry Smith   ierr = DMRegisterAll();CHKERRQ(ierr);
2921264ace61SBarry Smith   *type = ((PetscObject)dm)->type_name;
2922264ace61SBarry Smith   PetscFunctionReturn(0);
2923264ace61SBarry Smith }
2924264ace61SBarry Smith 
292567a56275SMatthew G Knepley #undef __FUNCT__
292667a56275SMatthew G Knepley #define __FUNCT__ "DMConvert"
292767a56275SMatthew G Knepley /*@C
292867a56275SMatthew G Knepley   DMConvert - Converts a DM to another DM, either of the same or different type.
292967a56275SMatthew G Knepley 
293067a56275SMatthew G Knepley   Collective on DM
293167a56275SMatthew G Knepley 
293267a56275SMatthew G Knepley   Input Parameters:
293367a56275SMatthew G Knepley + dm - the DM
293467a56275SMatthew G Knepley - newtype - new DM type (use "same" for the same type)
293567a56275SMatthew G Knepley 
293667a56275SMatthew G Knepley   Output Parameter:
293767a56275SMatthew G Knepley . M - pointer to new DM
293867a56275SMatthew G Knepley 
293967a56275SMatthew G Knepley   Notes:
294067a56275SMatthew G Knepley   Cannot be used to convert a sequential DM to parallel or parallel to sequential,
294167a56275SMatthew G Knepley   the MPI communicator of the generated DM is always the same as the communicator
294267a56275SMatthew G Knepley   of the input DM.
294367a56275SMatthew G Knepley 
294467a56275SMatthew G Knepley   Level: intermediate
294567a56275SMatthew G Knepley 
294667a56275SMatthew G Knepley .seealso: DMCreate()
294767a56275SMatthew G Knepley @*/
294819fd82e9SBarry Smith PetscErrorCode DMConvert(DM dm, DMType newtype, DM *M)
294967a56275SMatthew G Knepley {
295067a56275SMatthew G Knepley   DM             B;
295167a56275SMatthew G Knepley   char           convname[256];
2952c067b6caSMatthew G. Knepley   PetscBool      sametype/*, issame */;
295367a56275SMatthew G Knepley   PetscErrorCode ierr;
295467a56275SMatthew G Knepley 
295567a56275SMatthew G Knepley   PetscFunctionBegin;
295667a56275SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
295767a56275SMatthew G Knepley   PetscValidType(dm,1);
295867a56275SMatthew G Knepley   PetscValidPointer(M,3);
2959251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject) dm, newtype, &sametype);CHKERRQ(ierr);
2960c067b6caSMatthew G. Knepley   /* ierr = PetscStrcmp(newtype, "same", &issame);CHKERRQ(ierr); */
2961c067b6caSMatthew G. Knepley   if (sametype) {
2962c067b6caSMatthew G. Knepley     *M   = dm;
2963c067b6caSMatthew G. Knepley     ierr = PetscObjectReference((PetscObject) dm);CHKERRQ(ierr);
2964c067b6caSMatthew G. Knepley     PetscFunctionReturn(0);
2965c067b6caSMatthew G. Knepley   } else {
29660298fd71SBarry Smith     PetscErrorCode (*conv)(DM, DMType, DM*) = NULL;
296767a56275SMatthew G Knepley 
296867a56275SMatthew G Knepley     /*
296967a56275SMatthew G Knepley        Order of precedence:
297067a56275SMatthew G Knepley        1) See if a specialized converter is known to the current DM.
297167a56275SMatthew G Knepley        2) See if a specialized converter is known to the desired DM class.
297267a56275SMatthew G Knepley        3) See if a good general converter is registered for the desired class
297367a56275SMatthew G Knepley        4) See if a good general converter is known for the current matrix.
297467a56275SMatthew G Knepley        5) Use a really basic converter.
297567a56275SMatthew G Knepley     */
297667a56275SMatthew G Knepley 
297767a56275SMatthew G Knepley     /* 1) See if a specialized converter is known to the current DM and the desired class */
297867a56275SMatthew G Knepley     ierr = PetscStrcpy(convname,"DMConvert_");CHKERRQ(ierr);
297967a56275SMatthew G Knepley     ierr = PetscStrcat(convname,((PetscObject) dm)->type_name);CHKERRQ(ierr);
298067a56275SMatthew G Knepley     ierr = PetscStrcat(convname,"_");CHKERRQ(ierr);
298167a56275SMatthew G Knepley     ierr = PetscStrcat(convname,newtype);CHKERRQ(ierr);
298267a56275SMatthew G Knepley     ierr = PetscStrcat(convname,"_C");CHKERRQ(ierr);
29830005d66cSJed Brown     ierr = PetscObjectQueryFunction((PetscObject)dm,convname,&conv);CHKERRQ(ierr);
298467a56275SMatthew G Knepley     if (conv) goto foundconv;
298567a56275SMatthew G Knepley 
298667a56275SMatthew G Knepley     /* 2)  See if a specialized converter is known to the desired DM class. */
298782f516ccSBarry Smith     ierr = DMCreate(PetscObjectComm((PetscObject)dm), &B);CHKERRQ(ierr);
298867a56275SMatthew G Knepley     ierr = DMSetType(B, newtype);CHKERRQ(ierr);
298967a56275SMatthew G Knepley     ierr = PetscStrcpy(convname,"DMConvert_");CHKERRQ(ierr);
299067a56275SMatthew G Knepley     ierr = PetscStrcat(convname,((PetscObject) dm)->type_name);CHKERRQ(ierr);
299167a56275SMatthew G Knepley     ierr = PetscStrcat(convname,"_");CHKERRQ(ierr);
299267a56275SMatthew G Knepley     ierr = PetscStrcat(convname,newtype);CHKERRQ(ierr);
299367a56275SMatthew G Knepley     ierr = PetscStrcat(convname,"_C");CHKERRQ(ierr);
29940005d66cSJed Brown     ierr = PetscObjectQueryFunction((PetscObject)B,convname,&conv);CHKERRQ(ierr);
299567a56275SMatthew G Knepley     if (conv) {
2996fcfd50ebSBarry Smith       ierr = DMDestroy(&B);CHKERRQ(ierr);
299767a56275SMatthew G Knepley       goto foundconv;
299867a56275SMatthew G Knepley     }
299967a56275SMatthew G Knepley 
300067a56275SMatthew G Knepley #if 0
300167a56275SMatthew G Knepley     /* 3) See if a good general converter is registered for the desired class */
300267a56275SMatthew G Knepley     conv = B->ops->convertfrom;
3003fcfd50ebSBarry Smith     ierr = DMDestroy(&B);CHKERRQ(ierr);
300467a56275SMatthew G Knepley     if (conv) goto foundconv;
300567a56275SMatthew G Knepley 
300667a56275SMatthew G Knepley     /* 4) See if a good general converter is known for the current matrix */
300767a56275SMatthew G Knepley     if (dm->ops->convert) {
300867a56275SMatthew G Knepley       conv = dm->ops->convert;
300967a56275SMatthew G Knepley     }
301067a56275SMatthew G Knepley     if (conv) goto foundconv;
301167a56275SMatthew G Knepley #endif
301267a56275SMatthew G Knepley 
301367a56275SMatthew G Knepley     /* 5) Use a really basic converter. */
301482f516ccSBarry Smith     SETERRQ2(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "No conversion possible between DM types %s and %s", ((PetscObject) dm)->type_name, newtype);
301567a56275SMatthew G Knepley 
301667a56275SMatthew G Knepley foundconv:
301767a56275SMatthew G Knepley     ierr = PetscLogEventBegin(DM_Convert,dm,0,0,0);CHKERRQ(ierr);
301867a56275SMatthew G Knepley     ierr = (*conv)(dm,newtype,M);CHKERRQ(ierr);
301912fa691eSMatthew G. Knepley     /* Things that are independent of DM type: We should consult DMClone() here */
302012fa691eSMatthew G. Knepley     if (dm->maxCell) {
302112fa691eSMatthew G. Knepley       const PetscReal *maxCell, *L;
302212fa691eSMatthew G. Knepley       const DMBoundaryType *bd;
302312fa691eSMatthew G. Knepley       ierr = DMGetPeriodicity(dm, &maxCell, &L, &bd);CHKERRQ(ierr);
302412fa691eSMatthew G. Knepley       ierr = DMSetPeriodicity(*M,  maxCell,  L,  bd);CHKERRQ(ierr);
302512fa691eSMatthew G. Knepley     }
302667a56275SMatthew G Knepley     ierr = PetscLogEventEnd(DM_Convert,dm,0,0,0);CHKERRQ(ierr);
302767a56275SMatthew G Knepley   }
302867a56275SMatthew G Knepley   ierr = PetscObjectStateIncrease((PetscObject) *M);CHKERRQ(ierr);
302967a56275SMatthew G Knepley   PetscFunctionReturn(0);
303067a56275SMatthew G Knepley }
3031264ace61SBarry Smith 
3032264ace61SBarry Smith /*--------------------------------------------------------------------------------------------------------------------*/
3033264ace61SBarry Smith 
3034264ace61SBarry Smith #undef __FUNCT__
3035264ace61SBarry Smith #define __FUNCT__ "DMRegister"
3036264ace61SBarry Smith /*@C
30371c84c290SBarry Smith   DMRegister -  Adds a new DM component implementation
30381c84c290SBarry Smith 
30391c84c290SBarry Smith   Not Collective
30401c84c290SBarry Smith 
30411c84c290SBarry Smith   Input Parameters:
30421c84c290SBarry Smith + name        - The name of a new user-defined creation routine
30431c84c290SBarry Smith - create_func - The creation routine itself
30441c84c290SBarry Smith 
30451c84c290SBarry Smith   Notes:
30461c84c290SBarry Smith   DMRegister() may be called multiple times to add several user-defined DMs
30471c84c290SBarry Smith 
30481c84c290SBarry Smith 
30491c84c290SBarry Smith   Sample usage:
30501c84c290SBarry Smith .vb
3051bdf89e91SBarry Smith     DMRegister("my_da", MyDMCreate);
30521c84c290SBarry Smith .ve
30531c84c290SBarry Smith 
30541c84c290SBarry Smith   Then, your DM type can be chosen with the procedural interface via
30551c84c290SBarry Smith .vb
30561c84c290SBarry Smith     DMCreate(MPI_Comm, DM *);
30571c84c290SBarry Smith     DMSetType(DM,"my_da");
30581c84c290SBarry Smith .ve
30591c84c290SBarry Smith    or at runtime via the option
30601c84c290SBarry Smith .vb
30611c84c290SBarry Smith     -da_type my_da
30621c84c290SBarry Smith .ve
3063264ace61SBarry Smith 
3064264ace61SBarry Smith   Level: advanced
30651c84c290SBarry Smith 
30661c84c290SBarry Smith .keywords: DM, register
3067bdf89e91SBarry Smith .seealso: DMRegisterAll(), DMRegisterDestroy()
30681c84c290SBarry Smith 
3069264ace61SBarry Smith @*/
3070bdf89e91SBarry Smith PetscErrorCode  DMRegister(const char sname[],PetscErrorCode (*function)(DM))
3071264ace61SBarry Smith {
3072264ace61SBarry Smith   PetscErrorCode ierr;
3073264ace61SBarry Smith 
3074264ace61SBarry Smith   PetscFunctionBegin;
3075a240a19fSJed Brown   ierr = PetscFunctionListAdd(&DMList,sname,function);CHKERRQ(ierr);
3076264ace61SBarry Smith   PetscFunctionReturn(0);
3077264ace61SBarry Smith }
3078264ace61SBarry Smith 
3079b859378eSBarry Smith #undef __FUNCT__
3080b859378eSBarry Smith #define __FUNCT__ "DMLoad"
3081b859378eSBarry Smith /*@C
308255849f57SBarry Smith   DMLoad - Loads a DM that has been stored in binary  with DMView().
3083b859378eSBarry Smith 
3084b859378eSBarry Smith   Collective on PetscViewer
3085b859378eSBarry Smith 
3086b859378eSBarry Smith   Input Parameters:
3087b859378eSBarry Smith + newdm - the newly loaded DM, this needs to have been created with DMCreate() or
3088b859378eSBarry Smith            some related function before a call to DMLoad().
3089b859378eSBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen() or
3090b859378eSBarry Smith            HDF5 file viewer, obtained from PetscViewerHDF5Open()
3091b859378eSBarry Smith 
3092b859378eSBarry Smith    Level: intermediate
3093b859378eSBarry Smith 
3094b859378eSBarry Smith   Notes:
309555849f57SBarry Smith    The type is determined by the data in the file, any type set into the DM before this call is ignored.
3096b859378eSBarry Smith 
3097b859378eSBarry Smith   Notes for advanced users:
3098b859378eSBarry Smith   Most users should not need to know the details of the binary storage
3099b859378eSBarry Smith   format, since DMLoad() and DMView() completely hide these details.
3100b859378eSBarry Smith   But for anyone who's interested, the standard binary matrix storage
3101b859378eSBarry Smith   format is
3102b859378eSBarry Smith .vb
3103b859378eSBarry Smith      has not yet been determined
3104b859378eSBarry Smith .ve
3105b859378eSBarry Smith 
3106b859378eSBarry Smith .seealso: PetscViewerBinaryOpen(), DMView(), MatLoad(), VecLoad()
3107b859378eSBarry Smith @*/
3108b859378eSBarry Smith PetscErrorCode  DMLoad(DM newdm, PetscViewer viewer)
3109b859378eSBarry Smith {
31109331c7a4SMatthew G. Knepley   PetscBool      isbinary, ishdf5;
3111b859378eSBarry Smith   PetscErrorCode ierr;
3112b859378eSBarry Smith 
3113b859378eSBarry Smith   PetscFunctionBegin;
3114b859378eSBarry Smith   PetscValidHeaderSpecific(newdm,DM_CLASSID,1);
3115b859378eSBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
311632c0f0efSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
31179331c7a4SMatthew G. Knepley   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERHDF5,&ishdf5);CHKERRQ(ierr);
31189331c7a4SMatthew G. Knepley   if (isbinary) {
31199331c7a4SMatthew G. Knepley     PetscInt classid;
31209331c7a4SMatthew G. Knepley     char     type[256];
3121b859378eSBarry Smith 
3122060da220SMatthew G. Knepley     ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr);
31239200755eSBarry Smith     if (classid != DM_FILE_CLASSID) SETERRQ1(PetscObjectComm((PetscObject)newdm),PETSC_ERR_ARG_WRONG,"Not DM next in file, classid found %d",(int)classid);
3124060da220SMatthew G. Knepley     ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr);
312532c0f0efSBarry Smith     ierr = DMSetType(newdm, type);CHKERRQ(ierr);
31269331c7a4SMatthew G. Knepley     if (newdm->ops->load) {ierr = (*newdm->ops->load)(newdm,viewer);CHKERRQ(ierr);}
31279331c7a4SMatthew G. Knepley   } else if (ishdf5) {
31289331c7a4SMatthew G. Knepley     if (newdm->ops->load) {ierr = (*newdm->ops->load)(newdm,viewer);CHKERRQ(ierr);}
31299331c7a4SMatthew G. Knepley   } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen() or PetscViewerHDF5Open()");
3130b859378eSBarry Smith   PetscFunctionReturn(0);
3131b859378eSBarry Smith }
3132b859378eSBarry Smith 
31337da65231SMatthew G Knepley /******************************** FEM Support **********************************/
31347da65231SMatthew G Knepley 
31357da65231SMatthew G Knepley #undef __FUNCT__
31367da65231SMatthew G Knepley #define __FUNCT__ "DMPrintCellVector"
3137a6dfd86eSKarl Rupp PetscErrorCode DMPrintCellVector(PetscInt c, const char name[], PetscInt len, const PetscScalar x[])
3138a6dfd86eSKarl Rupp {
31391d47ebbbSSatish Balay   PetscInt       f;
31401b30c384SMatthew G Knepley   PetscErrorCode ierr;
31411b30c384SMatthew G Knepley 
31427da65231SMatthew G Knepley   PetscFunctionBegin;
314374778d6cSJed Brown   ierr = PetscPrintf(PETSC_COMM_SELF, "Cell %D Element %s\n", c, name);CHKERRQ(ierr);
31441d47ebbbSSatish Balay   for (f = 0; f < len; ++f) {
314557622a8eSBarry Smith     ierr = PetscPrintf(PETSC_COMM_SELF, "  | %g |\n", (double)PetscRealPart(x[f]));CHKERRQ(ierr);
31467da65231SMatthew G Knepley   }
31477da65231SMatthew G Knepley   PetscFunctionReturn(0);
31487da65231SMatthew G Knepley }
31497da65231SMatthew G Knepley 
31507da65231SMatthew G Knepley #undef __FUNCT__
31517da65231SMatthew G Knepley #define __FUNCT__ "DMPrintCellMatrix"
3152a6dfd86eSKarl Rupp PetscErrorCode DMPrintCellMatrix(PetscInt c, const char name[], PetscInt rows, PetscInt cols, const PetscScalar A[])
3153a6dfd86eSKarl Rupp {
31541b30c384SMatthew G Knepley   PetscInt       f, g;
31557da65231SMatthew G Knepley   PetscErrorCode ierr;
31567da65231SMatthew G Knepley 
31577da65231SMatthew G Knepley   PetscFunctionBegin;
315874778d6cSJed Brown   ierr = PetscPrintf(PETSC_COMM_SELF, "Cell %D Element %s\n", c, name);CHKERRQ(ierr);
31591d47ebbbSSatish Balay   for (f = 0; f < rows; ++f) {
316074778d6cSJed Brown     ierr = PetscPrintf(PETSC_COMM_SELF, "  |");CHKERRQ(ierr);
31611d47ebbbSSatish Balay     for (g = 0; g < cols; ++g) {
3162e3556bceSMatthew G. Knepley       ierr = PetscPrintf(PETSC_COMM_SELF, " % 9.5g", PetscRealPart(A[f*cols+g]));CHKERRQ(ierr);
31637da65231SMatthew G Knepley     }
316474778d6cSJed Brown     ierr = PetscPrintf(PETSC_COMM_SELF, " |\n");CHKERRQ(ierr);
31657da65231SMatthew G Knepley   }
31667da65231SMatthew G Knepley   PetscFunctionReturn(0);
31677da65231SMatthew G Knepley }
3168e7c4fc90SDmitry Karpeev 
3169970e74d5SMatthew G Knepley #undef __FUNCT__
3170e759306cSMatthew G. Knepley #define __FUNCT__ "DMPrintLocalVec"
31716113b454SMatthew G. Knepley PetscErrorCode DMPrintLocalVec(DM dm, const char name[], PetscReal tol, Vec X)
3172e759306cSMatthew G. Knepley {
3173e759306cSMatthew G. Knepley   PetscMPIInt    rank, numProcs;
3174e759306cSMatthew G. Knepley   PetscInt       p;
3175e759306cSMatthew G. Knepley   PetscErrorCode ierr;
3176e759306cSMatthew G. Knepley 
3177e759306cSMatthew G. Knepley   PetscFunctionBegin;
3178e759306cSMatthew G. Knepley   ierr = MPI_Comm_rank(PetscObjectComm((PetscObject) dm), &rank);CHKERRQ(ierr);
3179e759306cSMatthew G. Knepley   ierr = MPI_Comm_size(PetscObjectComm((PetscObject) dm), &numProcs);CHKERRQ(ierr);
3180e759306cSMatthew G. Knepley   ierr = PetscPrintf(PetscObjectComm((PetscObject) dm), "%s:\n", name);CHKERRQ(ierr);
3181e759306cSMatthew G. Knepley   for (p = 0; p < numProcs; ++p) {
3182e759306cSMatthew G. Knepley     if (p == rank) {
3183e759306cSMatthew G. Knepley       Vec x;
3184e759306cSMatthew G. Knepley 
3185e759306cSMatthew G. Knepley       ierr = VecDuplicate(X, &x);CHKERRQ(ierr);
3186e759306cSMatthew G. Knepley       ierr = VecCopy(X, x);CHKERRQ(ierr);
31876113b454SMatthew G. Knepley       ierr = VecChop(x, tol);CHKERRQ(ierr);
3188e759306cSMatthew G. Knepley       ierr = VecView(x, PETSC_VIEWER_STDOUT_SELF);CHKERRQ(ierr);
3189e759306cSMatthew G. Knepley       ierr = VecDestroy(&x);CHKERRQ(ierr);
3190e759306cSMatthew G. Knepley       ierr = PetscViewerFlush(PETSC_VIEWER_STDOUT_SELF);CHKERRQ(ierr);
3191e759306cSMatthew G. Knepley     }
3192e759306cSMatthew G. Knepley     ierr = PetscBarrier((PetscObject) dm);CHKERRQ(ierr);
3193e759306cSMatthew G. Knepley   }
3194e759306cSMatthew G. Knepley   PetscFunctionReturn(0);
3195e759306cSMatthew G. Knepley }
3196e759306cSMatthew G. Knepley 
3197e759306cSMatthew G. Knepley #undef __FUNCT__
319888ed4aceSMatthew G Knepley #define __FUNCT__ "DMGetDefaultSection"
319988ed4aceSMatthew G Knepley /*@
320088ed4aceSMatthew G Knepley   DMGetDefaultSection - Get the PetscSection encoding the local data layout for the DM.
320188ed4aceSMatthew G Knepley 
320288ed4aceSMatthew G Knepley   Input Parameter:
320388ed4aceSMatthew G Knepley . dm - The DM
320488ed4aceSMatthew G Knepley 
320588ed4aceSMatthew G Knepley   Output Parameter:
320688ed4aceSMatthew G Knepley . section - The PetscSection
320788ed4aceSMatthew G Knepley 
320888ed4aceSMatthew G Knepley   Level: intermediate
320988ed4aceSMatthew G Knepley 
321088ed4aceSMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSection.
321188ed4aceSMatthew G Knepley 
321288ed4aceSMatthew G Knepley .seealso: DMSetDefaultSection(), DMGetDefaultGlobalSection()
321388ed4aceSMatthew G Knepley @*/
32140adebc6cSBarry Smith PetscErrorCode DMGetDefaultSection(DM dm, PetscSection *section)
32150adebc6cSBarry Smith {
3216fd59a867SMatthew G. Knepley   PetscErrorCode ierr;
3217fd59a867SMatthew G. Knepley 
321888ed4aceSMatthew G Knepley   PetscFunctionBegin;
321988ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
322088ed4aceSMatthew G Knepley   PetscValidPointer(section, 2);
32212f0f8703SMatthew G. Knepley   if (!dm->defaultSection && dm->ops->createdefaultsection) {
32222f0f8703SMatthew G. Knepley     ierr = (*dm->ops->createdefaultsection)(dm);CHKERRQ(ierr);
3223ae71db08SMatthew G. Knepley     if (dm->defaultSection) {ierr = PetscObjectViewFromOptions((PetscObject) dm->defaultSection, NULL, "-dm_petscsection_view");CHKERRQ(ierr);}
32242f0f8703SMatthew G. Knepley   }
322588ed4aceSMatthew G Knepley   *section = dm->defaultSection;
322688ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
322788ed4aceSMatthew G Knepley }
322888ed4aceSMatthew G Knepley 
322988ed4aceSMatthew G Knepley #undef __FUNCT__
323088ed4aceSMatthew G Knepley #define __FUNCT__ "DMSetDefaultSection"
323188ed4aceSMatthew G Knepley /*@
323288ed4aceSMatthew G Knepley   DMSetDefaultSection - Set the PetscSection encoding the local data layout for the DM.
323388ed4aceSMatthew G Knepley 
323488ed4aceSMatthew G Knepley   Input Parameters:
323588ed4aceSMatthew G Knepley + dm - The DM
323688ed4aceSMatthew G Knepley - section - The PetscSection
323788ed4aceSMatthew G Knepley 
323888ed4aceSMatthew G Knepley   Level: intermediate
323988ed4aceSMatthew G Knepley 
324088ed4aceSMatthew G Knepley   Note: Any existing Section will be destroyed
324188ed4aceSMatthew G Knepley 
324288ed4aceSMatthew G Knepley .seealso: DMSetDefaultSection(), DMGetDefaultGlobalSection()
324388ed4aceSMatthew G Knepley @*/
32440adebc6cSBarry Smith PetscErrorCode DMSetDefaultSection(DM dm, PetscSection section)
32450adebc6cSBarry Smith {
3246c473ab19SMatthew G. Knepley   PetscInt       numFields = 0;
3247af122d2aSMatthew G Knepley   PetscInt       f;
324888ed4aceSMatthew G Knepley   PetscErrorCode ierr;
324988ed4aceSMatthew G Knepley 
325088ed4aceSMatthew G Knepley   PetscFunctionBegin;
325188ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
3252c473ab19SMatthew G. Knepley   if (section) {
32531d799100SJed Brown     PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2);
32541d799100SJed Brown     ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr);
3255c473ab19SMatthew G. Knepley   }
325688ed4aceSMatthew G Knepley   ierr = PetscSectionDestroy(&dm->defaultSection);CHKERRQ(ierr);
325788ed4aceSMatthew G Knepley   dm->defaultSection = section;
3258c473ab19SMatthew G. Knepley   if (section) {ierr = PetscSectionGetNumFields(dm->defaultSection, &numFields);CHKERRQ(ierr);}
3259af122d2aSMatthew G Knepley   if (numFields) {
3260af122d2aSMatthew G Knepley     ierr = DMSetNumFields(dm, numFields);CHKERRQ(ierr);
3261af122d2aSMatthew G Knepley     for (f = 0; f < numFields; ++f) {
32620f21e855SMatthew G. Knepley       PetscObject disc;
3263af122d2aSMatthew G Knepley       const char *name;
3264af122d2aSMatthew G Knepley 
3265af122d2aSMatthew G Knepley       ierr = PetscSectionGetFieldName(dm->defaultSection, f, &name);CHKERRQ(ierr);
32660f21e855SMatthew G. Knepley       ierr = DMGetField(dm, f, &disc);CHKERRQ(ierr);
32670f21e855SMatthew G. Knepley       ierr = PetscObjectSetName(disc, name);CHKERRQ(ierr);
3268af122d2aSMatthew G Knepley     }
3269af122d2aSMatthew G Knepley   }
32701d799100SJed Brown   /* The global section will be rebuilt in the next call to DMGetDefaultGlobalSection(). */
32711d799100SJed Brown   ierr = PetscSectionDestroy(&dm->defaultGlobalSection);CHKERRQ(ierr);
327288ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
327388ed4aceSMatthew G Knepley }
327488ed4aceSMatthew G Knepley 
327588ed4aceSMatthew G Knepley #undef __FUNCT__
32769435951eSToby Isaac #define __FUNCT__ "DMGetDefaultConstraints"
32779435951eSToby Isaac /*@
32789435951eSToby Isaac   DMGetDefaultConstraints - Get the PetscSection and Mat the specify the local constraint interpolation. See DMSetDefaultConstraints() for a description of the purpose of constraint interpolation.
32799435951eSToby Isaac 
3280e228b242SToby Isaac   not collective
3281e228b242SToby Isaac 
32829435951eSToby Isaac   Input Parameter:
32839435951eSToby Isaac . dm - The DM
32849435951eSToby Isaac 
32859435951eSToby Isaac   Output Parameter:
32869435951eSToby 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.
32879435951eSToby 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.
32889435951eSToby Isaac 
32899435951eSToby Isaac   Level: advanced
32909435951eSToby Isaac 
32919435951eSToby Isaac   Note: This gets borrowed references, so the user should not destroy the PetscSection or the Mat.
32929435951eSToby Isaac 
32939435951eSToby Isaac .seealso: DMSetDefaultConstraints()
32949435951eSToby Isaac @*/
32959435951eSToby Isaac PetscErrorCode DMGetDefaultConstraints(DM dm, PetscSection *section, Mat *mat)
32969435951eSToby Isaac {
32979435951eSToby Isaac   PetscErrorCode ierr;
32989435951eSToby Isaac 
32999435951eSToby Isaac   PetscFunctionBegin;
33009435951eSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
33019435951eSToby Isaac   if (!dm->defaultConstraintSection && !dm->defaultConstraintMat && dm->ops->createdefaultconstraints) {ierr = (*dm->ops->createdefaultconstraints)(dm);CHKERRQ(ierr);}
330245a75d81SToby Isaac   if (section) {*section = dm->defaultConstraintSection;}
330345a75d81SToby Isaac   if (mat) {*mat = dm->defaultConstraintMat;}
33049435951eSToby Isaac   PetscFunctionReturn(0);
33059435951eSToby Isaac }
33069435951eSToby Isaac 
33079435951eSToby Isaac #undef __FUNCT__
33089435951eSToby Isaac #define __FUNCT__ "DMSetDefaultConstraints"
33099435951eSToby Isaac /*@
33109435951eSToby Isaac   DMSetDefaultConstraints - Set the PetscSection and Mat the specify the local constraint interpolation.
33119435951eSToby Isaac 
33129435951eSToby 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().
33139435951eSToby Isaac 
33149435951eSToby 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.
33159435951eSToby Isaac 
3316e228b242SToby Isaac   collective on dm
3317e228b242SToby Isaac 
33189435951eSToby Isaac   Input Parameters:
33199435951eSToby Isaac + dm - The DM
3320e228b242SToby 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).
3321e228b242SToby 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).
33229435951eSToby Isaac 
33239435951eSToby Isaac   Level: advanced
33249435951eSToby Isaac 
33259435951eSToby Isaac   Note: This increments the references of the PetscSection and the Mat, so they user can destroy them
33269435951eSToby Isaac 
33279435951eSToby Isaac .seealso: DMGetDefaultConstraints()
33289435951eSToby Isaac @*/
33299435951eSToby Isaac PetscErrorCode DMSetDefaultConstraints(DM dm, PetscSection section, Mat mat)
33309435951eSToby Isaac {
3331e228b242SToby Isaac   PetscMPIInt result;
33329435951eSToby Isaac   PetscErrorCode ierr;
33339435951eSToby Isaac 
33349435951eSToby Isaac   PetscFunctionBegin;
33359435951eSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
3336e228b242SToby Isaac   if (section) {
3337e228b242SToby Isaac     PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2);
3338e228b242SToby Isaac     ierr = MPI_Comm_compare(PETSC_COMM_SELF,PetscObjectComm((PetscObject)section),&result);CHKERRQ(ierr);
3339*f60917d2SBarry Smith     if (result != MPI_CONGRUENT && result != MPI_IDENT) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NOTSAMECOMM,"constraint section must have local communicator");
3340e228b242SToby Isaac   }
3341e228b242SToby Isaac   if (mat) {
3342e228b242SToby Isaac     PetscValidHeaderSpecific(mat,MAT_CLASSID,3);
3343e228b242SToby Isaac     ierr = MPI_Comm_compare(PETSC_COMM_SELF,PetscObjectComm((PetscObject)mat),&result);CHKERRQ(ierr);
3344*f60917d2SBarry Smith     if (result != MPI_CONGRUENT && result != MPI_IDENT) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NOTSAMECOMM,"constraint matrix must have local communicator");
3345e228b242SToby Isaac   }
33469435951eSToby Isaac   ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr);
33479435951eSToby Isaac   ierr = PetscSectionDestroy(&dm->defaultConstraintSection);CHKERRQ(ierr);
33489435951eSToby Isaac   dm->defaultConstraintSection = section;
33499435951eSToby Isaac   ierr = PetscObjectReference((PetscObject)mat);CHKERRQ(ierr);
33509435951eSToby Isaac   ierr = MatDestroy(&dm->defaultConstraintMat);CHKERRQ(ierr);
33519435951eSToby Isaac   dm->defaultConstraintMat = mat;
33529435951eSToby Isaac   PetscFunctionReturn(0);
33539435951eSToby Isaac }
33549435951eSToby Isaac 
3355f741bcd2SMatthew G. Knepley #ifdef PETSC_USE_DEBUG
33569435951eSToby Isaac #undef __FUNCT__
3357284f5c8fSMatthew G. Knepley #define __FUNCT__ "DMDefaultSectionCheckConsistency_Internal"
3358507e4973SMatthew G. Knepley /*
3359507e4973SMatthew G. Knepley   DMDefaultSectionCheckConsistency - Check the consistentcy of the global and local sections.
3360507e4973SMatthew G. Knepley 
3361507e4973SMatthew G. Knepley   Input Parameters:
3362507e4973SMatthew G. Knepley + dm - The DM
3363507e4973SMatthew G. Knepley . localSection - PetscSection describing the local data layout
3364507e4973SMatthew G. Knepley - globalSection - PetscSection describing the global data layout
3365507e4973SMatthew G. Knepley 
3366507e4973SMatthew G. Knepley   Level: intermediate
3367507e4973SMatthew G. Knepley 
3368507e4973SMatthew G. Knepley .seealso: DMGetDefaultSF(), DMSetDefaultSF()
3369507e4973SMatthew G. Knepley */
3370f741bcd2SMatthew G. Knepley static PetscErrorCode DMDefaultSectionCheckConsistency_Internal(DM dm, PetscSection localSection, PetscSection globalSection)
3371507e4973SMatthew G. Knepley {
3372507e4973SMatthew G. Knepley   MPI_Comm        comm;
3373507e4973SMatthew G. Knepley   PetscLayout     layout;
3374507e4973SMatthew G. Knepley   const PetscInt *ranges;
3375507e4973SMatthew G. Knepley   PetscInt        pStart, pEnd, p, nroots;
3376507e4973SMatthew G. Knepley   PetscMPIInt     size, rank;
3377507e4973SMatthew G. Knepley   PetscBool       valid = PETSC_TRUE, gvalid;
3378507e4973SMatthew G. Knepley   PetscErrorCode  ierr;
3379507e4973SMatthew G. Knepley 
3380507e4973SMatthew G. Knepley   PetscFunctionBegin;
3381507e4973SMatthew G. Knepley   ierr = PetscObjectGetComm((PetscObject)dm,&comm);CHKERRQ(ierr);
3382507e4973SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
3383507e4973SMatthew G. Knepley   ierr = MPI_Comm_size(comm, &size);CHKERRQ(ierr);
3384507e4973SMatthew G. Knepley   ierr = MPI_Comm_rank(comm, &rank);CHKERRQ(ierr);
3385507e4973SMatthew G. Knepley   ierr = PetscSectionGetChart(globalSection, &pStart, &pEnd);CHKERRQ(ierr);
3386507e4973SMatthew G. Knepley   ierr = PetscSectionGetConstrainedStorageSize(globalSection, &nroots);CHKERRQ(ierr);
3387507e4973SMatthew G. Knepley   ierr = PetscLayoutCreate(comm, &layout);CHKERRQ(ierr);
3388507e4973SMatthew G. Knepley   ierr = PetscLayoutSetBlockSize(layout, 1);CHKERRQ(ierr);
3389507e4973SMatthew G. Knepley   ierr = PetscLayoutSetLocalSize(layout, nroots);CHKERRQ(ierr);
3390507e4973SMatthew G. Knepley   ierr = PetscLayoutSetUp(layout);CHKERRQ(ierr);
3391507e4973SMatthew G. Knepley   ierr = PetscLayoutGetRanges(layout, &ranges);CHKERRQ(ierr);
3392507e4973SMatthew G. Knepley   for (p = pStart; p < pEnd; ++p) {
3393f741bcd2SMatthew G. Knepley     PetscInt       dof, cdof, off, gdof, gcdof, goff, gsize, d;
3394507e4973SMatthew G. Knepley 
3395507e4973SMatthew G. Knepley     ierr = PetscSectionGetDof(localSection, p, &dof);CHKERRQ(ierr);
3396507e4973SMatthew G. Knepley     ierr = PetscSectionGetOffset(localSection, p, &off);CHKERRQ(ierr);
3397507e4973SMatthew G. Knepley     ierr = PetscSectionGetConstraintDof(localSection, p, &cdof);CHKERRQ(ierr);
3398507e4973SMatthew G. Knepley     ierr = PetscSectionGetDof(globalSection, p, &gdof);CHKERRQ(ierr);
3399507e4973SMatthew G. Knepley     ierr = PetscSectionGetConstraintDof(globalSection, p, &gcdof);CHKERRQ(ierr);
3400507e4973SMatthew G. Knepley     ierr = PetscSectionGetOffset(globalSection, p, &goff);CHKERRQ(ierr);
3401507e4973SMatthew G. Knepley     if (!gdof) continue; /* Censored point */
3402507e4973SMatthew 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;}
3403507e4973SMatthew 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;}
3404507e4973SMatthew G. Knepley     if (gdof < 0) {
3405507e4973SMatthew G. Knepley       gsize = gdof < 0 ? -(gdof+1)-gcdof : gdof-gcdof;
3406507e4973SMatthew G. Knepley       for (d = 0; d < gsize; ++d) {
3407507e4973SMatthew G. Knepley         PetscInt offset = -(goff+1) + d, r;
3408507e4973SMatthew G. Knepley 
3409507e4973SMatthew G. Knepley         ierr = PetscFindInt(offset,size+1,ranges,&r);CHKERRQ(ierr);
3410507e4973SMatthew G. Knepley         if (r < 0) r = -(r+2);
3411507e4973SMatthew 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;}
3412507e4973SMatthew G. Knepley       }
3413507e4973SMatthew G. Knepley     }
3414507e4973SMatthew G. Knepley   }
3415507e4973SMatthew G. Knepley   ierr = PetscLayoutDestroy(&layout);CHKERRQ(ierr);
3416507e4973SMatthew G. Knepley   ierr = PetscSynchronizedFlush(comm, NULL);CHKERRQ(ierr);
3417b2566f29SBarry Smith   ierr = MPIU_Allreduce(&valid, &gvalid, 1, MPIU_BOOL, MPI_LAND, comm);CHKERRQ(ierr);
3418507e4973SMatthew G. Knepley   if (!gvalid) {
3419507e4973SMatthew G. Knepley     ierr = DMView(dm, NULL);CHKERRQ(ierr);
3420507e4973SMatthew G. Knepley     SETERRQ(comm, PETSC_ERR_ARG_WRONG, "Inconsistent local and global sections");
3421507e4973SMatthew G. Knepley   }
3422507e4973SMatthew G. Knepley   PetscFunctionReturn(0);
3423507e4973SMatthew G. Knepley }
3424f741bcd2SMatthew G. Knepley #endif
3425507e4973SMatthew G. Knepley 
3426507e4973SMatthew G. Knepley #undef __FUNCT__
342788ed4aceSMatthew G Knepley #define __FUNCT__ "DMGetDefaultGlobalSection"
342888ed4aceSMatthew G Knepley /*@
342988ed4aceSMatthew G Knepley   DMGetDefaultGlobalSection - Get the PetscSection encoding the global data layout for the DM.
343088ed4aceSMatthew G Knepley 
34318b1ab98fSJed Brown   Collective on DM
34328b1ab98fSJed Brown 
343388ed4aceSMatthew G Knepley   Input Parameter:
343488ed4aceSMatthew G Knepley . dm - The DM
343588ed4aceSMatthew G Knepley 
343688ed4aceSMatthew G Knepley   Output Parameter:
343788ed4aceSMatthew G Knepley . section - The PetscSection
343888ed4aceSMatthew G Knepley 
343988ed4aceSMatthew G Knepley   Level: intermediate
344088ed4aceSMatthew G Knepley 
344188ed4aceSMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSection.
344288ed4aceSMatthew G Knepley 
344388ed4aceSMatthew G Knepley .seealso: DMSetDefaultSection(), DMGetDefaultSection()
344488ed4aceSMatthew G Knepley @*/
34450adebc6cSBarry Smith PetscErrorCode DMGetDefaultGlobalSection(DM dm, PetscSection *section)
34460adebc6cSBarry Smith {
344788ed4aceSMatthew G Knepley   PetscErrorCode ierr;
344888ed4aceSMatthew G Knepley 
344988ed4aceSMatthew G Knepley   PetscFunctionBegin;
345088ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
345188ed4aceSMatthew G Knepley   PetscValidPointer(section, 2);
345288ed4aceSMatthew G Knepley   if (!dm->defaultGlobalSection) {
3453fd59a867SMatthew G. Knepley     PetscSection s;
3454fd59a867SMatthew G. Knepley 
3455fd59a867SMatthew G. Knepley     ierr = DMGetDefaultSection(dm, &s);CHKERRQ(ierr);
3456fd59a867SMatthew 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");
3457fd59a867SMatthew 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");
345815b58121SMatthew G. Knepley     ierr = PetscSectionCreateGlobalSection(s, dm->sf, PETSC_FALSE, PETSC_FALSE, &dm->defaultGlobalSection);CHKERRQ(ierr);
3459cf06b437SMatthew G. Knepley     ierr = PetscLayoutDestroy(&dm->map);CHKERRQ(ierr);
3460ce94432eSBarry Smith     ierr = PetscSectionGetValueLayout(PetscObjectComm((PetscObject)dm), dm->defaultGlobalSection, &dm->map);CHKERRQ(ierr);
3461685405a1SBarry Smith     ierr = PetscSectionViewFromOptions(dm->defaultGlobalSection, NULL, "-global_section_view");CHKERRQ(ierr);
346288ed4aceSMatthew G Knepley   }
346388ed4aceSMatthew G Knepley   *section = dm->defaultGlobalSection;
346488ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
346588ed4aceSMatthew G Knepley }
346688ed4aceSMatthew G Knepley 
346788ed4aceSMatthew G Knepley #undef __FUNCT__
3468b21d0597SMatthew G Knepley #define __FUNCT__ "DMSetDefaultGlobalSection"
3469b21d0597SMatthew G Knepley /*@
3470b21d0597SMatthew G Knepley   DMSetDefaultGlobalSection - Set the PetscSection encoding the global data layout for the DM.
3471b21d0597SMatthew G Knepley 
3472b21d0597SMatthew G Knepley   Input Parameters:
3473b21d0597SMatthew G Knepley + dm - The DM
34745080bbdbSMatthew G Knepley - section - The PetscSection, or NULL
3475b21d0597SMatthew G Knepley 
3476b21d0597SMatthew G Knepley   Level: intermediate
3477b21d0597SMatthew G Knepley 
3478b21d0597SMatthew G Knepley   Note: Any existing Section will be destroyed
3479b21d0597SMatthew G Knepley 
3480b21d0597SMatthew G Knepley .seealso: DMGetDefaultGlobalSection(), DMSetDefaultSection()
3481b21d0597SMatthew G Knepley @*/
34820adebc6cSBarry Smith PetscErrorCode DMSetDefaultGlobalSection(DM dm, PetscSection section)
34830adebc6cSBarry Smith {
3484b21d0597SMatthew G Knepley   PetscErrorCode ierr;
3485b21d0597SMatthew G Knepley 
3486b21d0597SMatthew G Knepley   PetscFunctionBegin;
3487b21d0597SMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
34885080bbdbSMatthew G Knepley   if (section) PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2);
34891d799100SJed Brown   ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr);
3490b21d0597SMatthew G Knepley   ierr = PetscSectionDestroy(&dm->defaultGlobalSection);CHKERRQ(ierr);
3491b21d0597SMatthew G Knepley   dm->defaultGlobalSection = section;
3492507e4973SMatthew G. Knepley #ifdef PETSC_USE_DEBUG
3493f741bcd2SMatthew G. Knepley   if (section) {ierr = DMDefaultSectionCheckConsistency_Internal(dm, dm->defaultSection, section);CHKERRQ(ierr);}
3494507e4973SMatthew G. Knepley #endif
3495b21d0597SMatthew G Knepley   PetscFunctionReturn(0);
3496b21d0597SMatthew G Knepley }
3497b21d0597SMatthew G Knepley 
3498b21d0597SMatthew G Knepley #undef __FUNCT__
349988ed4aceSMatthew G Knepley #define __FUNCT__ "DMGetDefaultSF"
350088ed4aceSMatthew G Knepley /*@
350188ed4aceSMatthew G Knepley   DMGetDefaultSF - Get the PetscSF encoding the parallel dof overlap for the DM. If it has not been set,
350288ed4aceSMatthew G Knepley   it is created from the default PetscSection layouts in the DM.
350388ed4aceSMatthew G Knepley 
350488ed4aceSMatthew G Knepley   Input Parameter:
350588ed4aceSMatthew G Knepley . dm - The DM
350688ed4aceSMatthew G Knepley 
350788ed4aceSMatthew G Knepley   Output Parameter:
350888ed4aceSMatthew G Knepley . sf - The PetscSF
350988ed4aceSMatthew G Knepley 
351088ed4aceSMatthew G Knepley   Level: intermediate
351188ed4aceSMatthew G Knepley 
351288ed4aceSMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSF.
351388ed4aceSMatthew G Knepley 
351488ed4aceSMatthew G Knepley .seealso: DMSetDefaultSF(), DMCreateDefaultSF()
351588ed4aceSMatthew G Knepley @*/
35160adebc6cSBarry Smith PetscErrorCode DMGetDefaultSF(DM dm, PetscSF *sf)
35170adebc6cSBarry Smith {
351888ed4aceSMatthew G Knepley   PetscInt       nroots;
351988ed4aceSMatthew G Knepley   PetscErrorCode ierr;
352088ed4aceSMatthew G Knepley 
352188ed4aceSMatthew G Knepley   PetscFunctionBegin;
352288ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
352388ed4aceSMatthew G Knepley   PetscValidPointer(sf, 2);
35240298fd71SBarry Smith   ierr = PetscSFGetGraph(dm->defaultSF, &nroots, NULL, NULL, NULL);CHKERRQ(ierr);
352588ed4aceSMatthew G Knepley   if (nroots < 0) {
352688ed4aceSMatthew G Knepley     PetscSection section, gSection;
352788ed4aceSMatthew G Knepley 
352888ed4aceSMatthew G Knepley     ierr = DMGetDefaultSection(dm, &section);CHKERRQ(ierr);
352931ea6d37SMatthew G Knepley     if (section) {
353088ed4aceSMatthew G Knepley       ierr = DMGetDefaultGlobalSection(dm, &gSection);CHKERRQ(ierr);
353188ed4aceSMatthew G Knepley       ierr = DMCreateDefaultSF(dm, section, gSection);CHKERRQ(ierr);
353231ea6d37SMatthew G Knepley     } else {
35330298fd71SBarry Smith       *sf = NULL;
353431ea6d37SMatthew G Knepley       PetscFunctionReturn(0);
353531ea6d37SMatthew G Knepley     }
353688ed4aceSMatthew G Knepley   }
353788ed4aceSMatthew G Knepley   *sf = dm->defaultSF;
353888ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
353988ed4aceSMatthew G Knepley }
354088ed4aceSMatthew G Knepley 
354188ed4aceSMatthew G Knepley #undef __FUNCT__
354288ed4aceSMatthew G Knepley #define __FUNCT__ "DMSetDefaultSF"
354388ed4aceSMatthew G Knepley /*@
354488ed4aceSMatthew G Knepley   DMSetDefaultSF - Set the PetscSF encoding the parallel dof overlap for the DM
354588ed4aceSMatthew G Knepley 
354688ed4aceSMatthew G Knepley   Input Parameters:
354788ed4aceSMatthew G Knepley + dm - The DM
354888ed4aceSMatthew G Knepley - sf - The PetscSF
354988ed4aceSMatthew G Knepley 
355088ed4aceSMatthew G Knepley   Level: intermediate
355188ed4aceSMatthew G Knepley 
355288ed4aceSMatthew G Knepley   Note: Any previous SF is destroyed
355388ed4aceSMatthew G Knepley 
355488ed4aceSMatthew G Knepley .seealso: DMGetDefaultSF(), DMCreateDefaultSF()
355588ed4aceSMatthew G Knepley @*/
35560adebc6cSBarry Smith PetscErrorCode DMSetDefaultSF(DM dm, PetscSF sf)
35570adebc6cSBarry Smith {
355888ed4aceSMatthew G Knepley   PetscErrorCode ierr;
355988ed4aceSMatthew G Knepley 
356088ed4aceSMatthew G Knepley   PetscFunctionBegin;
356188ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
356288ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
356388ed4aceSMatthew G Knepley   ierr          = PetscSFDestroy(&dm->defaultSF);CHKERRQ(ierr);
356488ed4aceSMatthew G Knepley   dm->defaultSF = sf;
356588ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
356688ed4aceSMatthew G Knepley }
356788ed4aceSMatthew G Knepley 
356888ed4aceSMatthew G Knepley #undef __FUNCT__
356988ed4aceSMatthew G Knepley #define __FUNCT__ "DMCreateDefaultSF"
357088ed4aceSMatthew G Knepley /*@C
357188ed4aceSMatthew G Knepley   DMCreateDefaultSF - Create the PetscSF encoding the parallel dof overlap for the DM based upon the PetscSections
357288ed4aceSMatthew G Knepley   describing the data layout.
357388ed4aceSMatthew G Knepley 
357488ed4aceSMatthew G Knepley   Input Parameters:
357588ed4aceSMatthew G Knepley + dm - The DM
357688ed4aceSMatthew G Knepley . localSection - PetscSection describing the local data layout
357788ed4aceSMatthew G Knepley - globalSection - PetscSection describing the global data layout
357888ed4aceSMatthew G Knepley 
357988ed4aceSMatthew G Knepley   Level: intermediate
358088ed4aceSMatthew G Knepley 
358188ed4aceSMatthew G Knepley .seealso: DMGetDefaultSF(), DMSetDefaultSF()
358288ed4aceSMatthew G Knepley @*/
358388ed4aceSMatthew G Knepley PetscErrorCode DMCreateDefaultSF(DM dm, PetscSection localSection, PetscSection globalSection)
358488ed4aceSMatthew G Knepley {
358582f516ccSBarry Smith   MPI_Comm       comm;
358688ed4aceSMatthew G Knepley   PetscLayout    layout;
358788ed4aceSMatthew G Knepley   const PetscInt *ranges;
358888ed4aceSMatthew G Knepley   PetscInt       *local;
358988ed4aceSMatthew G Knepley   PetscSFNode    *remote;
3590ecd73843SMatthew G. Knepley   PetscInt       pStart, pEnd, p, nroots, nleaves = 0, l;
359188ed4aceSMatthew G Knepley   PetscMPIInt    size, rank;
359288ed4aceSMatthew G Knepley   PetscErrorCode ierr;
359388ed4aceSMatthew G Knepley 
359488ed4aceSMatthew G Knepley   PetscFunctionBegin;
359582f516ccSBarry Smith   ierr = PetscObjectGetComm((PetscObject)dm,&comm);CHKERRQ(ierr);
359688ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
359788ed4aceSMatthew G Knepley   ierr = MPI_Comm_size(comm, &size);CHKERRQ(ierr);
359888ed4aceSMatthew G Knepley   ierr = MPI_Comm_rank(comm, &rank);CHKERRQ(ierr);
359988ed4aceSMatthew G Knepley   ierr = PetscSectionGetChart(globalSection, &pStart, &pEnd);CHKERRQ(ierr);
360088ed4aceSMatthew G Knepley   ierr = PetscSectionGetConstrainedStorageSize(globalSection, &nroots);CHKERRQ(ierr);
360188ed4aceSMatthew G Knepley   ierr = PetscLayoutCreate(comm, &layout);CHKERRQ(ierr);
360288ed4aceSMatthew G Knepley   ierr = PetscLayoutSetBlockSize(layout, 1);CHKERRQ(ierr);
360388ed4aceSMatthew G Knepley   ierr = PetscLayoutSetLocalSize(layout, nroots);CHKERRQ(ierr);
360488ed4aceSMatthew G Knepley   ierr = PetscLayoutSetUp(layout);CHKERRQ(ierr);
360588ed4aceSMatthew G Knepley   ierr = PetscLayoutGetRanges(layout, &ranges);CHKERRQ(ierr);
3606ecd73843SMatthew G. Knepley   for (p = pStart; p < pEnd; ++p) {
36076636e97aSMatthew G Knepley     PetscInt gdof, gcdof;
360888ed4aceSMatthew G Knepley 
36096636e97aSMatthew G Knepley     ierr     = PetscSectionGetDof(globalSection, p, &gdof);CHKERRQ(ierr);
36106636e97aSMatthew G Knepley     ierr     = PetscSectionGetConstraintDof(globalSection, p, &gcdof);CHKERRQ(ierr);
3611235fbf56SMatthew 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));
36126636e97aSMatthew G Knepley     nleaves += gdof < 0 ? -(gdof+1)-gcdof : gdof-gcdof;
361388ed4aceSMatthew G Knepley   }
3614785e854fSJed Brown   ierr = PetscMalloc1(nleaves, &local);CHKERRQ(ierr);
3615785e854fSJed Brown   ierr = PetscMalloc1(nleaves, &remote);CHKERRQ(ierr);
361688ed4aceSMatthew G Knepley   for (p = pStart, l = 0; p < pEnd; ++p) {
36171f588964SMatthew G Knepley     const PetscInt *cind;
36186636e97aSMatthew G Knepley     PetscInt       dof, cdof, off, gdof, gcdof, goff, gsize, d, c;
361988ed4aceSMatthew G Knepley 
362088ed4aceSMatthew G Knepley     ierr = PetscSectionGetDof(localSection, p, &dof);CHKERRQ(ierr);
362188ed4aceSMatthew G Knepley     ierr = PetscSectionGetOffset(localSection, p, &off);CHKERRQ(ierr);
362288ed4aceSMatthew G Knepley     ierr = PetscSectionGetConstraintDof(localSection, p, &cdof);CHKERRQ(ierr);
362388ed4aceSMatthew G Knepley     ierr = PetscSectionGetConstraintIndices(localSection, p, &cind);CHKERRQ(ierr);
362488ed4aceSMatthew G Knepley     ierr = PetscSectionGetDof(globalSection, p, &gdof);CHKERRQ(ierr);
36256636e97aSMatthew G Knepley     ierr = PetscSectionGetConstraintDof(globalSection, p, &gcdof);CHKERRQ(ierr);
362688ed4aceSMatthew G Knepley     ierr = PetscSectionGetOffset(globalSection, p, &goff);CHKERRQ(ierr);
36276636e97aSMatthew G Knepley     if (!gdof) continue; /* Censored point */
36286636e97aSMatthew G Knepley     gsize = gdof < 0 ? -(gdof+1)-gcdof : gdof-gcdof;
36296636e97aSMatthew G Knepley     if (gsize != dof-cdof) {
3630057b4bcdSMatthew 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);
36316636e97aSMatthew G Knepley       cdof = 0; /* Ignore constraints */
36326636e97aSMatthew G Knepley     }
363388ed4aceSMatthew G Knepley     for (d = 0, c = 0; d < dof; ++d) {
363488ed4aceSMatthew G Knepley       if ((c < cdof) && (cind[c] == d)) {++c; continue;}
363588ed4aceSMatthew G Knepley       local[l+d-c] = off+d;
363688ed4aceSMatthew G Knepley     }
363788ed4aceSMatthew G Knepley     if (gdof < 0) {
36386636e97aSMatthew G Knepley       for (d = 0; d < gsize; ++d, ++l) {
363988ed4aceSMatthew G Knepley         PetscInt offset = -(goff+1) + d, r;
364088ed4aceSMatthew G Knepley 
364105376888SMatthew G. Knepley         ierr = PetscFindInt(offset,size+1,ranges,&r);CHKERRQ(ierr);
364231d3f06eSJed Brown         if (r < 0) r = -(r+2);
364305376888SMatthew 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);
364488ed4aceSMatthew G Knepley         remote[l].rank  = r;
364588ed4aceSMatthew G Knepley         remote[l].index = offset - ranges[r];
364688ed4aceSMatthew G Knepley       }
364788ed4aceSMatthew G Knepley     } else {
36486636e97aSMatthew G Knepley       for (d = 0; d < gsize; ++d, ++l) {
364988ed4aceSMatthew G Knepley         remote[l].rank  = rank;
365088ed4aceSMatthew G Knepley         remote[l].index = goff+d - ranges[rank];
365188ed4aceSMatthew G Knepley       }
365288ed4aceSMatthew G Knepley     }
365388ed4aceSMatthew G Knepley   }
36546636e97aSMatthew G Knepley   if (l != nleaves) SETERRQ2(comm, PETSC_ERR_PLIB, "Iteration error, l %d != nleaves %d", l, nleaves);
365588ed4aceSMatthew G Knepley   ierr = PetscLayoutDestroy(&layout);CHKERRQ(ierr);
365688ed4aceSMatthew G Knepley   ierr = PetscSFSetGraph(dm->defaultSF, nroots, nleaves, local, PETSC_OWN_POINTER, remote, PETSC_OWN_POINTER);CHKERRQ(ierr);
365788ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
365888ed4aceSMatthew G Knepley }
3659af122d2aSMatthew G Knepley 
3660af122d2aSMatthew G Knepley #undef __FUNCT__
3661b21d0597SMatthew G Knepley #define __FUNCT__ "DMGetPointSF"
3662b21d0597SMatthew G Knepley /*@
3663b21d0597SMatthew G Knepley   DMGetPointSF - Get the PetscSF encoding the parallel section point overlap for the DM.
3664b21d0597SMatthew G Knepley 
3665b21d0597SMatthew G Knepley   Input Parameter:
3666b21d0597SMatthew G Knepley . dm - The DM
3667b21d0597SMatthew G Knepley 
3668b21d0597SMatthew G Knepley   Output Parameter:
3669b21d0597SMatthew G Knepley . sf - The PetscSF
3670b21d0597SMatthew G Knepley 
3671b21d0597SMatthew G Knepley   Level: intermediate
3672b21d0597SMatthew G Knepley 
3673b21d0597SMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSF.
3674b21d0597SMatthew G Knepley 
3675057b4bcdSMatthew G Knepley .seealso: DMSetPointSF(), DMGetDefaultSF(), DMSetDefaultSF(), DMCreateDefaultSF()
3676b21d0597SMatthew G Knepley @*/
36770adebc6cSBarry Smith PetscErrorCode DMGetPointSF(DM dm, PetscSF *sf)
36780adebc6cSBarry Smith {
3679b21d0597SMatthew G Knepley   PetscFunctionBegin;
3680b21d0597SMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
3681b21d0597SMatthew G Knepley   PetscValidPointer(sf, 2);
3682b21d0597SMatthew G Knepley   *sf = dm->sf;
3683b21d0597SMatthew G Knepley   PetscFunctionReturn(0);
3684b21d0597SMatthew G Knepley }
3685b21d0597SMatthew G Knepley 
3686b21d0597SMatthew G Knepley #undef __FUNCT__
3687057b4bcdSMatthew G Knepley #define __FUNCT__ "DMSetPointSF"
3688057b4bcdSMatthew G Knepley /*@
3689057b4bcdSMatthew G Knepley   DMSetPointSF - Set the PetscSF encoding the parallel section point overlap for the DM.
3690057b4bcdSMatthew G Knepley 
3691057b4bcdSMatthew G Knepley   Input Parameters:
3692057b4bcdSMatthew G Knepley + dm - The DM
3693057b4bcdSMatthew G Knepley - sf - The PetscSF
3694057b4bcdSMatthew G Knepley 
3695057b4bcdSMatthew G Knepley   Level: intermediate
3696057b4bcdSMatthew G Knepley 
3697057b4bcdSMatthew G Knepley .seealso: DMGetPointSF(), DMGetDefaultSF(), DMSetDefaultSF(), DMCreateDefaultSF()
3698057b4bcdSMatthew G Knepley @*/
36990adebc6cSBarry Smith PetscErrorCode DMSetPointSF(DM dm, PetscSF sf)
37000adebc6cSBarry Smith {
3701057b4bcdSMatthew G Knepley   PetscErrorCode ierr;
3702057b4bcdSMatthew G Knepley 
3703057b4bcdSMatthew G Knepley   PetscFunctionBegin;
3704057b4bcdSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
3705057b4bcdSMatthew G Knepley   PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 1);
3706057b4bcdSMatthew G Knepley   ierr   = PetscSFDestroy(&dm->sf);CHKERRQ(ierr);
3707057b4bcdSMatthew G Knepley   ierr   = PetscObjectReference((PetscObject) sf);CHKERRQ(ierr);
3708057b4bcdSMatthew G Knepley   dm->sf = sf;
3709057b4bcdSMatthew G Knepley   PetscFunctionReturn(0);
3710057b4bcdSMatthew G Knepley }
3711057b4bcdSMatthew G Knepley 
3712057b4bcdSMatthew G Knepley #undef __FUNCT__
37132764a2aaSMatthew G. Knepley #define __FUNCT__ "DMGetDS"
37142764a2aaSMatthew G. Knepley /*@
37152764a2aaSMatthew G. Knepley   DMGetDS - Get the PetscDS
37162764a2aaSMatthew G. Knepley 
37172764a2aaSMatthew G. Knepley   Input Parameter:
37182764a2aaSMatthew G. Knepley . dm - The DM
37192764a2aaSMatthew G. Knepley 
37202764a2aaSMatthew G. Knepley   Output Parameter:
37212764a2aaSMatthew G. Knepley . prob - The PetscDS
37222764a2aaSMatthew G. Knepley 
37232764a2aaSMatthew G. Knepley   Level: developer
37242764a2aaSMatthew G. Knepley 
37252764a2aaSMatthew G. Knepley .seealso: DMSetDS()
37262764a2aaSMatthew G. Knepley @*/
37272764a2aaSMatthew G. Knepley PetscErrorCode DMGetDS(DM dm, PetscDS *prob)
3728af122d2aSMatthew G Knepley {
3729af122d2aSMatthew G Knepley   PetscFunctionBegin;
3730af122d2aSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
37310f21e855SMatthew G. Knepley   PetscValidPointer(prob, 2);
37320f21e855SMatthew G. Knepley   *prob = dm->prob;
37330f21e855SMatthew G. Knepley   PetscFunctionReturn(0);
37340f21e855SMatthew G. Knepley }
37350f21e855SMatthew G. Knepley 
37360f21e855SMatthew G. Knepley #undef __FUNCT__
37372764a2aaSMatthew G. Knepley #define __FUNCT__ "DMSetDS"
37382764a2aaSMatthew G. Knepley /*@
37392764a2aaSMatthew G. Knepley   DMSetDS - Set the PetscDS
37402764a2aaSMatthew G. Knepley 
37412764a2aaSMatthew G. Knepley   Input Parameters:
37422764a2aaSMatthew G. Knepley + dm - The DM
37432764a2aaSMatthew G. Knepley - prob - The PetscDS
37442764a2aaSMatthew G. Knepley 
37452764a2aaSMatthew G. Knepley   Level: developer
37462764a2aaSMatthew G. Knepley 
37472764a2aaSMatthew G. Knepley .seealso: DMGetDS()
37482764a2aaSMatthew G. Knepley @*/
37492764a2aaSMatthew G. Knepley PetscErrorCode DMSetDS(DM dm, PetscDS prob)
37500f21e855SMatthew G. Knepley {
37510f21e855SMatthew G. Knepley   PetscErrorCode ierr;
37520f21e855SMatthew G. Knepley 
37530f21e855SMatthew G. Knepley   PetscFunctionBegin;
37540f21e855SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
37552764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 2);
37562764a2aaSMatthew G. Knepley   ierr = PetscDSDestroy(&dm->prob);CHKERRQ(ierr);
37570f21e855SMatthew G. Knepley   dm->prob = prob;
37580f21e855SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) dm->prob);CHKERRQ(ierr);
37590f21e855SMatthew G. Knepley   PetscFunctionReturn(0);
37600f21e855SMatthew G. Knepley }
37610f21e855SMatthew G. Knepley 
37620f21e855SMatthew G. Knepley #undef __FUNCT__
37630f21e855SMatthew G. Knepley #define __FUNCT__ "DMGetNumFields"
37640f21e855SMatthew G. Knepley PetscErrorCode DMGetNumFields(DM dm, PetscInt *numFields)
37650f21e855SMatthew G. Knepley {
37660f21e855SMatthew G. Knepley   PetscErrorCode ierr;
37670f21e855SMatthew G. Knepley 
37680f21e855SMatthew G. Knepley   PetscFunctionBegin;
37690f21e855SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
37702764a2aaSMatthew G. Knepley   ierr = PetscDSGetNumFields(dm->prob, numFields);CHKERRQ(ierr);
3771af122d2aSMatthew G Knepley   PetscFunctionReturn(0);
3772af122d2aSMatthew G Knepley }
3773af122d2aSMatthew G Knepley 
3774af122d2aSMatthew G Knepley #undef __FUNCT__
3775af122d2aSMatthew G Knepley #define __FUNCT__ "DMSetNumFields"
3776af122d2aSMatthew G Knepley PetscErrorCode DMSetNumFields(DM dm, PetscInt numFields)
3777af122d2aSMatthew G Knepley {
37780f21e855SMatthew G. Knepley   PetscInt       Nf, f;
3779af122d2aSMatthew G Knepley   PetscErrorCode ierr;
3780af122d2aSMatthew G Knepley 
3781af122d2aSMatthew G Knepley   PetscFunctionBegin;
3782af122d2aSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
37832764a2aaSMatthew G. Knepley   ierr = PetscDSGetNumFields(dm->prob, &Nf);CHKERRQ(ierr);
37840f21e855SMatthew G. Knepley   for (f = Nf; f < numFields; ++f) {
37850f21e855SMatthew G. Knepley     PetscContainer obj;
37860f21e855SMatthew G. Knepley 
37870f21e855SMatthew G. Knepley     ierr = PetscContainerCreate(PetscObjectComm((PetscObject) dm), &obj);CHKERRQ(ierr);
37882764a2aaSMatthew G. Knepley     ierr = PetscDSSetDiscretization(dm->prob, f, (PetscObject) obj);CHKERRQ(ierr);
37890f21e855SMatthew G. Knepley     ierr = PetscContainerDestroy(&obj);CHKERRQ(ierr);
3790af122d2aSMatthew G Knepley   }
3791af122d2aSMatthew G Knepley   PetscFunctionReturn(0);
3792af122d2aSMatthew G Knepley }
3793af122d2aSMatthew G Knepley 
3794af122d2aSMatthew G Knepley #undef __FUNCT__
3795af122d2aSMatthew G Knepley #define __FUNCT__ "DMGetField"
3796c1929be8SMatthew G. Knepley /*@
3797c1929be8SMatthew G. Knepley   DMGetField - Return the discretization object for a given DM field
3798c1929be8SMatthew G. Knepley 
3799c1929be8SMatthew G. Knepley   Not collective
3800c1929be8SMatthew G. Knepley 
3801c1929be8SMatthew G. Knepley   Input Parameters:
3802c1929be8SMatthew G. Knepley + dm - The DM
3803c1929be8SMatthew G. Knepley - f  - The field number
3804c1929be8SMatthew G. Knepley 
3805c1929be8SMatthew G. Knepley   Output Parameter:
3806c1929be8SMatthew G. Knepley . field - The discretization object
3807c1929be8SMatthew G. Knepley 
3808c1929be8SMatthew G. Knepley   Level: developer
3809c1929be8SMatthew G. Knepley 
3810c1929be8SMatthew G. Knepley .seealso: DMSetField()
3811c1929be8SMatthew G. Knepley @*/
3812af122d2aSMatthew G Knepley PetscErrorCode DMGetField(DM dm, PetscInt f, PetscObject *field)
3813af122d2aSMatthew G Knepley {
38140f21e855SMatthew G. Knepley   PetscErrorCode ierr;
38150f21e855SMatthew G. Knepley 
3816af122d2aSMatthew G Knepley   PetscFunctionBegin;
3817af122d2aSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
38182764a2aaSMatthew G. Knepley   ierr = PetscDSGetDiscretization(dm->prob, f, field);CHKERRQ(ierr);
3819decb47aaSMatthew G. Knepley   PetscFunctionReturn(0);
3820decb47aaSMatthew G. Knepley }
3821decb47aaSMatthew G. Knepley 
3822decb47aaSMatthew G. Knepley #undef __FUNCT__
3823decb47aaSMatthew G. Knepley #define __FUNCT__ "DMSetField"
3824c1929be8SMatthew G. Knepley /*@
3825c1929be8SMatthew G. Knepley   DMSetField - Set the discretization object for a given DM field
3826c1929be8SMatthew G. Knepley 
3827c1929be8SMatthew G. Knepley   Logically collective on DM
3828c1929be8SMatthew G. Knepley 
3829c1929be8SMatthew G. Knepley   Input Parameters:
3830c1929be8SMatthew G. Knepley + dm - The DM
3831c1929be8SMatthew G. Knepley . f  - The field number
3832c1929be8SMatthew G. Knepley - field - The discretization object
3833c1929be8SMatthew G. Knepley 
3834c1929be8SMatthew G. Knepley   Level: developer
3835c1929be8SMatthew G. Knepley 
3836c1929be8SMatthew G. Knepley .seealso: DMGetField()
3837c1929be8SMatthew G. Knepley @*/
3838decb47aaSMatthew G. Knepley PetscErrorCode DMSetField(DM dm, PetscInt f, PetscObject field)
3839decb47aaSMatthew G. Knepley {
3840decb47aaSMatthew G. Knepley   PetscErrorCode ierr;
3841decb47aaSMatthew G. Knepley 
3842decb47aaSMatthew G. Knepley   PetscFunctionBegin;
3843decb47aaSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
38442764a2aaSMatthew G. Knepley   ierr = PetscDSSetDiscretization(dm->prob, f, field);CHKERRQ(ierr);
3845af122d2aSMatthew G Knepley   PetscFunctionReturn(0);
3846af122d2aSMatthew G Knepley }
38476636e97aSMatthew G Knepley 
38486636e97aSMatthew G Knepley #undef __FUNCT__
3849b64e0483SPeter Brune #define __FUNCT__ "DMRestrictHook_Coordinates"
3850b64e0483SPeter Brune PetscErrorCode DMRestrictHook_Coordinates(DM dm,DM dmc,void *ctx)
3851b64e0483SPeter Brune {
3852b64e0483SPeter Brune   DM dm_coord,dmc_coord;
3853b64e0483SPeter Brune   PetscErrorCode ierr;
3854b64e0483SPeter Brune   Vec coords,ccoords;
38556dbf9973SLawrence Mitchell   Mat inject;
3856b64e0483SPeter Brune   PetscFunctionBegin;
3857b64e0483SPeter Brune   ierr = DMGetCoordinateDM(dm,&dm_coord);CHKERRQ(ierr);
3858b64e0483SPeter Brune   ierr = DMGetCoordinateDM(dmc,&dmc_coord);CHKERRQ(ierr);
3859b64e0483SPeter Brune   ierr = DMGetCoordinates(dm,&coords);CHKERRQ(ierr);
3860b64e0483SPeter Brune   ierr = DMGetCoordinates(dmc,&ccoords);CHKERRQ(ierr);
3861b64e0483SPeter Brune   if (coords && !ccoords) {
3862b64e0483SPeter Brune     ierr = DMCreateGlobalVector(dmc_coord,&ccoords);CHKERRQ(ierr);
38636dbf9973SLawrence Mitchell     ierr = DMCreateInjection(dmc_coord,dm_coord,&inject);CHKERRQ(ierr);
38642adcf181SLawrence Mitchell     ierr = MatRestrict(inject,coords,ccoords);CHKERRQ(ierr);
38656dbf9973SLawrence Mitchell     ierr = MatDestroy(&inject);CHKERRQ(ierr);
3866b64e0483SPeter Brune     ierr = DMSetCoordinates(dmc,ccoords);CHKERRQ(ierr);
3867b64e0483SPeter Brune     ierr = VecDestroy(&ccoords);CHKERRQ(ierr);
3868b64e0483SPeter Brune   }
3869b64e0483SPeter Brune   PetscFunctionReturn(0);
3870b64e0483SPeter Brune }
3871b64e0483SPeter Brune 
3872b64e0483SPeter Brune #undef __FUNCT__
387303dadc2fSPeter Brune #define __FUNCT__ "DMSubDomainHook_Coordinates"
387403dadc2fSPeter Brune static PetscErrorCode DMSubDomainHook_Coordinates(DM dm,DM subdm,void *ctx)
387503dadc2fSPeter Brune {
387603dadc2fSPeter Brune   DM dm_coord,subdm_coord;
387703dadc2fSPeter Brune   PetscErrorCode ierr;
387803dadc2fSPeter Brune   Vec coords,ccoords,clcoords;
387903dadc2fSPeter Brune   VecScatter *scat_i,*scat_g;
388003dadc2fSPeter Brune   PetscFunctionBegin;
388103dadc2fSPeter Brune   ierr = DMGetCoordinateDM(dm,&dm_coord);CHKERRQ(ierr);
388203dadc2fSPeter Brune   ierr = DMGetCoordinateDM(subdm,&subdm_coord);CHKERRQ(ierr);
388303dadc2fSPeter Brune   ierr = DMGetCoordinates(dm,&coords);CHKERRQ(ierr);
388403dadc2fSPeter Brune   ierr = DMGetCoordinates(subdm,&ccoords);CHKERRQ(ierr);
388503dadc2fSPeter Brune   if (coords && !ccoords) {
388603dadc2fSPeter Brune     ierr = DMCreateGlobalVector(subdm_coord,&ccoords);CHKERRQ(ierr);
388703dadc2fSPeter Brune     ierr = DMCreateLocalVector(subdm_coord,&clcoords);CHKERRQ(ierr);
388824640c55SToby Isaac     ierr = PetscObjectSetName((PetscObject)clcoords,"coordinates");CHKERRQ(ierr);
388903dadc2fSPeter Brune     ierr = DMCreateDomainDecompositionScatters(dm_coord,1,&subdm_coord,NULL,&scat_i,&scat_g);CHKERRQ(ierr);
389003dadc2fSPeter Brune     ierr = VecScatterBegin(scat_i[0],coords,ccoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
389103dadc2fSPeter Brune     ierr = VecScatterBegin(scat_g[0],coords,clcoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
389203dadc2fSPeter Brune     ierr = VecScatterEnd(scat_i[0],coords,ccoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
389303dadc2fSPeter Brune     ierr = VecScatterEnd(scat_g[0],coords,clcoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
389403dadc2fSPeter Brune     ierr = DMSetCoordinates(subdm,ccoords);CHKERRQ(ierr);
389503dadc2fSPeter Brune     ierr = DMSetCoordinatesLocal(subdm,clcoords);CHKERRQ(ierr);
389603dadc2fSPeter Brune     ierr = VecScatterDestroy(&scat_i[0]);CHKERRQ(ierr);
389703dadc2fSPeter Brune     ierr = VecScatterDestroy(&scat_g[0]);CHKERRQ(ierr);
389803dadc2fSPeter Brune     ierr = VecDestroy(&ccoords);CHKERRQ(ierr);
389903dadc2fSPeter Brune     ierr = VecDestroy(&clcoords);CHKERRQ(ierr);
390003dadc2fSPeter Brune     ierr = PetscFree(scat_i);CHKERRQ(ierr);
390103dadc2fSPeter Brune     ierr = PetscFree(scat_g);CHKERRQ(ierr);
390203dadc2fSPeter Brune   }
390303dadc2fSPeter Brune   PetscFunctionReturn(0);
390403dadc2fSPeter Brune }
390503dadc2fSPeter Brune 
390603dadc2fSPeter Brune #undef __FUNCT__
3907c73cfb54SMatthew G. Knepley #define __FUNCT__ "DMGetDimension"
3908c73cfb54SMatthew G. Knepley /*@
3909c73cfb54SMatthew G. Knepley   DMGetDimension - Return the topological dimension of the DM
3910c73cfb54SMatthew G. Knepley 
3911c73cfb54SMatthew G. Knepley   Not collective
3912c73cfb54SMatthew G. Knepley 
3913c73cfb54SMatthew G. Knepley   Input Parameter:
3914c73cfb54SMatthew G. Knepley . dm - The DM
3915c73cfb54SMatthew G. Knepley 
3916c73cfb54SMatthew G. Knepley   Output Parameter:
3917c73cfb54SMatthew G. Knepley . dim - The topological dimension
3918c73cfb54SMatthew G. Knepley 
3919c73cfb54SMatthew G. Knepley   Level: beginner
3920c73cfb54SMatthew G. Knepley 
3921c73cfb54SMatthew G. Knepley .seealso: DMSetDimension(), DMCreate()
3922c73cfb54SMatthew G. Knepley @*/
3923c73cfb54SMatthew G. Knepley PetscErrorCode DMGetDimension(DM dm, PetscInt *dim)
3924c73cfb54SMatthew G. Knepley {
3925c73cfb54SMatthew G. Knepley   PetscFunctionBegin;
3926c73cfb54SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
3927c73cfb54SMatthew G. Knepley   PetscValidPointer(dim, 2);
3928c73cfb54SMatthew G. Knepley   *dim = dm->dim;
3929c73cfb54SMatthew G. Knepley   PetscFunctionReturn(0);
3930c73cfb54SMatthew G. Knepley }
3931c73cfb54SMatthew G. Knepley 
3932c73cfb54SMatthew G. Knepley #undef __FUNCT__
3933c73cfb54SMatthew G. Knepley #define __FUNCT__ "DMSetDimension"
3934c73cfb54SMatthew G. Knepley /*@
3935c73cfb54SMatthew G. Knepley   DMSetDimension - Set the topological dimension of the DM
3936c73cfb54SMatthew G. Knepley 
3937c73cfb54SMatthew G. Knepley   Collective on dm
3938c73cfb54SMatthew G. Knepley 
3939c73cfb54SMatthew G. Knepley   Input Parameters:
3940c73cfb54SMatthew G. Knepley + dm - The DM
3941c73cfb54SMatthew G. Knepley - dim - The topological dimension
3942c73cfb54SMatthew G. Knepley 
3943c73cfb54SMatthew G. Knepley   Level: beginner
3944c73cfb54SMatthew G. Knepley 
3945c73cfb54SMatthew G. Knepley .seealso: DMGetDimension(), DMCreate()
3946c73cfb54SMatthew G. Knepley @*/
3947c73cfb54SMatthew G. Knepley PetscErrorCode DMSetDimension(DM dm, PetscInt dim)
3948c73cfb54SMatthew G. Knepley {
3949c73cfb54SMatthew G. Knepley   PetscFunctionBegin;
3950c73cfb54SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
3951c73cfb54SMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, dim, 2);
3952c73cfb54SMatthew G. Knepley   dm->dim = dim;
3953c73cfb54SMatthew G. Knepley   PetscFunctionReturn(0);
3954c73cfb54SMatthew G. Knepley }
3955c73cfb54SMatthew G. Knepley 
3956793f3fe5SMatthew G. Knepley #undef __FUNCT__
3957793f3fe5SMatthew G. Knepley #define __FUNCT__ "DMGetDimPoints"
3958793f3fe5SMatthew G. Knepley /*@
3959793f3fe5SMatthew G. Knepley   DMGetDimPoints - Get the half-open interval for all points of a given dimension
3960793f3fe5SMatthew G. Knepley 
3961793f3fe5SMatthew G. Knepley   Collective on DM
3962793f3fe5SMatthew G. Knepley 
3963793f3fe5SMatthew G. Knepley   Input Parameters:
3964793f3fe5SMatthew G. Knepley + dm - the DM
3965793f3fe5SMatthew G. Knepley - dim - the dimension
3966793f3fe5SMatthew G. Knepley 
3967793f3fe5SMatthew G. Knepley   Output Parameters:
3968793f3fe5SMatthew G. Knepley + pStart - The first point of the given dimension
3969793f3fe5SMatthew G. Knepley . pEnd - The first point following points of the given dimension
3970793f3fe5SMatthew G. Knepley 
3971793f3fe5SMatthew G. Knepley   Note:
3972793f3fe5SMatthew G. Knepley   The points are vertices in the Hasse diagram encoding the topology. This is explained in
3973793f3fe5SMatthew G. Knepley   http://arxiv.org/abs/0908.4427. If not points exist of this dimension in the storage scheme,
3974793f3fe5SMatthew G. Knepley   then the interval is empty.
3975793f3fe5SMatthew G. Knepley 
3976793f3fe5SMatthew G. Knepley   Level: intermediate
3977793f3fe5SMatthew G. Knepley 
3978793f3fe5SMatthew G. Knepley .keywords: point, Hasse Diagram, dimension
3979793f3fe5SMatthew G. Knepley .seealso: DMPLEX, DMPlexGetDepthStratum(), DMPlexGetHeightStratum()
3980793f3fe5SMatthew G. Knepley @*/
3981793f3fe5SMatthew G. Knepley PetscErrorCode DMGetDimPoints(DM dm, PetscInt dim, PetscInt *pStart, PetscInt *pEnd)
3982793f3fe5SMatthew G. Knepley {
3983793f3fe5SMatthew G. Knepley   PetscInt       d;
3984793f3fe5SMatthew G. Knepley   PetscErrorCode ierr;
3985793f3fe5SMatthew G. Knepley 
3986793f3fe5SMatthew G. Knepley   PetscFunctionBegin;
3987793f3fe5SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3988793f3fe5SMatthew G. Knepley   ierr = DMGetDimension(dm, &d);CHKERRQ(ierr);
3989793f3fe5SMatthew G. Knepley   if ((dim < 0) || (dim > d)) SETERRQ2(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid dimension %d 1", dim, d);
3990793f3fe5SMatthew G. Knepley   ierr = (*dm->ops->getdimpoints)(dm, dim, pStart, pEnd);CHKERRQ(ierr);
3991793f3fe5SMatthew G. Knepley   PetscFunctionReturn(0);
3992793f3fe5SMatthew G. Knepley }
3993793f3fe5SMatthew G. Knepley 
3994793f3fe5SMatthew G. Knepley #undef __FUNCT__
39956636e97aSMatthew G Knepley #define __FUNCT__ "DMSetCoordinates"
39966636e97aSMatthew G Knepley /*@
39976636e97aSMatthew G Knepley   DMSetCoordinates - Sets into the DM a global vector that holds the coordinates
39986636e97aSMatthew G Knepley 
39996636e97aSMatthew G Knepley   Collective on DM
40006636e97aSMatthew G Knepley 
40016636e97aSMatthew G Knepley   Input Parameters:
40026636e97aSMatthew G Knepley + dm - the DM
40036636e97aSMatthew G Knepley - c - coordinate vector
40046636e97aSMatthew G Knepley 
40056636e97aSMatthew G Knepley   Note:
40066636e97aSMatthew G Knepley   The coordinates do include those for ghost points, which are in the local vector
40076636e97aSMatthew G Knepley 
40086636e97aSMatthew G Knepley   Level: intermediate
40096636e97aSMatthew G Knepley 
40106636e97aSMatthew G Knepley .keywords: distributed array, get, corners, nodes, local indices, coordinates
40116636e97aSMatthew G Knepley .seealso: DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLoca(), DMGetCoordinateDM()
40126636e97aSMatthew G Knepley @*/
40136636e97aSMatthew G Knepley PetscErrorCode DMSetCoordinates(DM dm, Vec c)
40146636e97aSMatthew G Knepley {
40156636e97aSMatthew G Knepley   PetscErrorCode ierr;
40166636e97aSMatthew G Knepley 
40176636e97aSMatthew G Knepley   PetscFunctionBegin;
40186636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
40196636e97aSMatthew G Knepley   PetscValidHeaderSpecific(c,VEC_CLASSID,2);
40206636e97aSMatthew G Knepley   ierr            = PetscObjectReference((PetscObject) c);CHKERRQ(ierr);
40216636e97aSMatthew G Knepley   ierr            = VecDestroy(&dm->coordinates);CHKERRQ(ierr);
40226636e97aSMatthew G Knepley   dm->coordinates = c;
40236636e97aSMatthew G Knepley   ierr            = VecDestroy(&dm->coordinatesLocal);CHKERRQ(ierr);
4024b64e0483SPeter Brune   ierr            = DMCoarsenHookAdd(dm,DMRestrictHook_Coordinates,NULL,NULL);CHKERRQ(ierr);
402503dadc2fSPeter Brune   ierr            = DMSubDomainHookAdd(dm,DMSubDomainHook_Coordinates,NULL,NULL);CHKERRQ(ierr);
40266636e97aSMatthew G Knepley   PetscFunctionReturn(0);
40276636e97aSMatthew G Knepley }
40286636e97aSMatthew G Knepley 
40296636e97aSMatthew G Knepley #undef __FUNCT__
40306636e97aSMatthew G Knepley #define __FUNCT__ "DMSetCoordinatesLocal"
40316636e97aSMatthew G Knepley /*@
40326636e97aSMatthew G Knepley   DMSetCoordinatesLocal - Sets into the DM a local vector that holds the coordinates
40336636e97aSMatthew G Knepley 
40346636e97aSMatthew G Knepley   Collective on DM
40356636e97aSMatthew G Knepley 
40366636e97aSMatthew G Knepley    Input Parameters:
40376636e97aSMatthew G Knepley +  dm - the DM
40386636e97aSMatthew G Knepley -  c - coordinate vector
40396636e97aSMatthew G Knepley 
40406636e97aSMatthew G Knepley   Note:
40416636e97aSMatthew G Knepley   The coordinates of ghost points can be set using DMSetCoordinates()
40426636e97aSMatthew G Knepley   followed by DMGetCoordinatesLocal(). This is intended to enable the
40436636e97aSMatthew G Knepley   setting of ghost coordinates outside of the domain.
40446636e97aSMatthew G Knepley 
40456636e97aSMatthew G Knepley   Level: intermediate
40466636e97aSMatthew G Knepley 
40476636e97aSMatthew G Knepley .keywords: distributed array, get, corners, nodes, local indices, coordinates
40486636e97aSMatthew G Knepley .seealso: DMGetCoordinatesLocal(), DMSetCoordinates(), DMGetCoordinates(), DMGetCoordinateDM()
40496636e97aSMatthew G Knepley @*/
40506636e97aSMatthew G Knepley PetscErrorCode DMSetCoordinatesLocal(DM dm, Vec c)
40516636e97aSMatthew G Knepley {
40526636e97aSMatthew G Knepley   PetscErrorCode ierr;
40536636e97aSMatthew G Knepley 
40546636e97aSMatthew G Knepley   PetscFunctionBegin;
40556636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
40566636e97aSMatthew G Knepley   PetscValidHeaderSpecific(c,VEC_CLASSID,2);
40576636e97aSMatthew G Knepley   ierr = PetscObjectReference((PetscObject) c);CHKERRQ(ierr);
40586636e97aSMatthew G Knepley   ierr = VecDestroy(&dm->coordinatesLocal);CHKERRQ(ierr);
40598865f1eaSKarl Rupp 
40606636e97aSMatthew G Knepley   dm->coordinatesLocal = c;
40618865f1eaSKarl Rupp 
40626636e97aSMatthew G Knepley   ierr = VecDestroy(&dm->coordinates);CHKERRQ(ierr);
40636636e97aSMatthew G Knepley   PetscFunctionReturn(0);
40646636e97aSMatthew G Knepley }
40656636e97aSMatthew G Knepley 
40666636e97aSMatthew G Knepley #undef __FUNCT__
40676636e97aSMatthew G Knepley #define __FUNCT__ "DMGetCoordinates"
40686636e97aSMatthew G Knepley /*@
40696636e97aSMatthew G Knepley   DMGetCoordinates - Gets a global vector with the coordinates associated with the DM.
40706636e97aSMatthew G Knepley 
40716636e97aSMatthew G Knepley   Not Collective
40726636e97aSMatthew G Knepley 
40736636e97aSMatthew G Knepley   Input Parameter:
40746636e97aSMatthew G Knepley . dm - the DM
40756636e97aSMatthew G Knepley 
40766636e97aSMatthew G Knepley   Output Parameter:
40776636e97aSMatthew G Knepley . c - global coordinate vector
40786636e97aSMatthew G Knepley 
40796636e97aSMatthew G Knepley   Note:
40806636e97aSMatthew G Knepley   This is a borrowed reference, so the user should NOT destroy this vector
40816636e97aSMatthew G Knepley 
40826636e97aSMatthew G Knepley   Each process has only the local coordinates (does NOT have the ghost coordinates).
40836636e97aSMatthew G Knepley 
40846636e97aSMatthew G Knepley   For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...)
40856636e97aSMatthew G Knepley   and (x_0,y_0,z_0,x_1,y_1,z_1...)
40866636e97aSMatthew G Knepley 
40876636e97aSMatthew G Knepley   Level: intermediate
40886636e97aSMatthew G Knepley 
40896636e97aSMatthew G Knepley .keywords: distributed array, get, corners, nodes, local indices, coordinates
40906636e97aSMatthew G Knepley .seealso: DMSetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM()
40916636e97aSMatthew G Knepley @*/
40926636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinates(DM dm, Vec *c)
40936636e97aSMatthew G Knepley {
40946636e97aSMatthew G Knepley   PetscErrorCode ierr;
40956636e97aSMatthew G Knepley 
40966636e97aSMatthew G Knepley   PetscFunctionBegin;
40976636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
40986636e97aSMatthew G Knepley   PetscValidPointer(c,2);
40991f588964SMatthew G Knepley   if (!dm->coordinates && dm->coordinatesLocal) {
41000298fd71SBarry Smith     DM cdm = NULL;
41016636e97aSMatthew G Knepley 
41026636e97aSMatthew G Knepley     ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
41036636e97aSMatthew G Knepley     ierr = DMCreateGlobalVector(cdm, &dm->coordinates);CHKERRQ(ierr);
41046636e97aSMatthew G Knepley     ierr = PetscObjectSetName((PetscObject) dm->coordinates, "coordinates");CHKERRQ(ierr);
41056636e97aSMatthew G Knepley     ierr = DMLocalToGlobalBegin(cdm, dm->coordinatesLocal, INSERT_VALUES, dm->coordinates);CHKERRQ(ierr);
41066636e97aSMatthew G Knepley     ierr = DMLocalToGlobalEnd(cdm, dm->coordinatesLocal, INSERT_VALUES, dm->coordinates);CHKERRQ(ierr);
41076636e97aSMatthew G Knepley   }
41086636e97aSMatthew G Knepley   *c = dm->coordinates;
41096636e97aSMatthew G Knepley   PetscFunctionReturn(0);
41106636e97aSMatthew G Knepley }
41116636e97aSMatthew G Knepley 
41126636e97aSMatthew G Knepley #undef __FUNCT__
41136636e97aSMatthew G Knepley #define __FUNCT__ "DMGetCoordinatesLocal"
41146636e97aSMatthew G Knepley /*@
41156636e97aSMatthew G Knepley   DMGetCoordinatesLocal - Gets a local vector with the coordinates associated with the DM.
41166636e97aSMatthew G Knepley 
41176636e97aSMatthew G Knepley   Collective on DM
41186636e97aSMatthew G Knepley 
41196636e97aSMatthew G Knepley   Input Parameter:
41206636e97aSMatthew G Knepley . dm - the DM
41216636e97aSMatthew G Knepley 
41226636e97aSMatthew G Knepley   Output Parameter:
41236636e97aSMatthew G Knepley . c - coordinate vector
41246636e97aSMatthew G Knepley 
41256636e97aSMatthew G Knepley   Note:
41266636e97aSMatthew G Knepley   This is a borrowed reference, so the user should NOT destroy this vector
41276636e97aSMatthew G Knepley 
41286636e97aSMatthew G Knepley   Each process has the local and ghost coordinates
41296636e97aSMatthew G Knepley 
41306636e97aSMatthew G Knepley   For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...)
41316636e97aSMatthew G Knepley   and (x_0,y_0,z_0,x_1,y_1,z_1...)
41326636e97aSMatthew G Knepley 
41336636e97aSMatthew G Knepley   Level: intermediate
41346636e97aSMatthew G Knepley 
41356636e97aSMatthew G Knepley .keywords: distributed array, get, corners, nodes, local indices, coordinates
41366636e97aSMatthew G Knepley .seealso: DMSetCoordinatesLocal(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM()
41376636e97aSMatthew G Knepley @*/
41386636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinatesLocal(DM dm, Vec *c)
41396636e97aSMatthew G Knepley {
41406636e97aSMatthew G Knepley   PetscErrorCode ierr;
41416636e97aSMatthew G Knepley 
41426636e97aSMatthew G Knepley   PetscFunctionBegin;
41436636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
41446636e97aSMatthew G Knepley   PetscValidPointer(c,2);
41451f588964SMatthew G Knepley   if (!dm->coordinatesLocal && dm->coordinates) {
41460298fd71SBarry Smith     DM cdm = NULL;
41476636e97aSMatthew G Knepley 
41486636e97aSMatthew G Knepley     ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
41496636e97aSMatthew G Knepley     ierr = DMCreateLocalVector(cdm, &dm->coordinatesLocal);CHKERRQ(ierr);
41506636e97aSMatthew G Knepley     ierr = PetscObjectSetName((PetscObject) dm->coordinatesLocal, "coordinates");CHKERRQ(ierr);
41516636e97aSMatthew G Knepley     ierr = DMGlobalToLocalBegin(cdm, dm->coordinates, INSERT_VALUES, dm->coordinatesLocal);CHKERRQ(ierr);
41526636e97aSMatthew G Knepley     ierr = DMGlobalToLocalEnd(cdm, dm->coordinates, INSERT_VALUES, dm->coordinatesLocal);CHKERRQ(ierr);
41536636e97aSMatthew G Knepley   }
41546636e97aSMatthew G Knepley   *c = dm->coordinatesLocal;
41556636e97aSMatthew G Knepley   PetscFunctionReturn(0);
41566636e97aSMatthew G Knepley }
41576636e97aSMatthew G Knepley 
41586636e97aSMatthew G Knepley #undef __FUNCT__
41596636e97aSMatthew G Knepley #define __FUNCT__ "DMGetCoordinateDM"
41606636e97aSMatthew G Knepley /*@
41611cfe2091SMatthew G. Knepley   DMGetCoordinateDM - Gets the DM that prescribes coordinate layout and scatters between global and local coordinates
41626636e97aSMatthew G Knepley 
41636636e97aSMatthew G Knepley   Collective on DM
41646636e97aSMatthew G Knepley 
41656636e97aSMatthew G Knepley   Input Parameter:
41666636e97aSMatthew G Knepley . dm - the DM
41676636e97aSMatthew G Knepley 
41686636e97aSMatthew G Knepley   Output Parameter:
41696636e97aSMatthew G Knepley . cdm - coordinate DM
41706636e97aSMatthew G Knepley 
41716636e97aSMatthew G Knepley   Level: intermediate
41726636e97aSMatthew G Knepley 
41736636e97aSMatthew G Knepley .keywords: distributed array, get, corners, nodes, local indices, coordinates
41741cfe2091SMatthew G. Knepley .seealso: DMSetCoordinateDM(), DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal()
41756636e97aSMatthew G Knepley @*/
41766636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinateDM(DM dm, DM *cdm)
41776636e97aSMatthew G Knepley {
41786636e97aSMatthew G Knepley   PetscErrorCode ierr;
41796636e97aSMatthew G Knepley 
41806636e97aSMatthew G Knepley   PetscFunctionBegin;
41816636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
41826636e97aSMatthew G Knepley   PetscValidPointer(cdm,2);
41836636e97aSMatthew G Knepley   if (!dm->coordinateDM) {
418482f516ccSBarry Smith     if (!dm->ops->createcoordinatedm) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Unable to create coordinates for this DM");
41856636e97aSMatthew G Knepley     ierr = (*dm->ops->createcoordinatedm)(dm, &dm->coordinateDM);CHKERRQ(ierr);
41866636e97aSMatthew G Knepley   }
41876636e97aSMatthew G Knepley   *cdm = dm->coordinateDM;
41886636e97aSMatthew G Knepley   PetscFunctionReturn(0);
41896636e97aSMatthew G Knepley }
4190e87bb0d3SMatthew G Knepley 
4191e87bb0d3SMatthew G Knepley #undef __FUNCT__
41921cfe2091SMatthew G. Knepley #define __FUNCT__ "DMSetCoordinateDM"
41931cfe2091SMatthew G. Knepley /*@
41941cfe2091SMatthew G. Knepley   DMSetCoordinateDM - Sets the DM that prescribes coordinate layout and scatters between global and local coordinates
41951cfe2091SMatthew G. Knepley 
41961cfe2091SMatthew G. Knepley   Logically Collective on DM
41971cfe2091SMatthew G. Knepley 
41981cfe2091SMatthew G. Knepley   Input Parameters:
41991cfe2091SMatthew G. Knepley + dm - the DM
42001cfe2091SMatthew G. Knepley - cdm - coordinate DM
42011cfe2091SMatthew G. Knepley 
42021cfe2091SMatthew G. Knepley   Level: intermediate
42031cfe2091SMatthew G. Knepley 
42041cfe2091SMatthew G. Knepley .keywords: distributed array, get, corners, nodes, local indices, coordinates
42051cfe2091SMatthew G. Knepley .seealso: DMGetCoordinateDM(), DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal()
42061cfe2091SMatthew G. Knepley @*/
42071cfe2091SMatthew G. Knepley PetscErrorCode DMSetCoordinateDM(DM dm, DM cdm)
42081cfe2091SMatthew G. Knepley {
42091cfe2091SMatthew G. Knepley   PetscErrorCode ierr;
42101cfe2091SMatthew G. Knepley 
42111cfe2091SMatthew G. Knepley   PetscFunctionBegin;
42121cfe2091SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
42131cfe2091SMatthew G. Knepley   PetscValidHeaderSpecific(cdm,DM_CLASSID,2);
42141cfe2091SMatthew G. Knepley   ierr = DMDestroy(&dm->coordinateDM);CHKERRQ(ierr);
42151cfe2091SMatthew G. Knepley   dm->coordinateDM = cdm;
42161cfe2091SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) dm->coordinateDM);CHKERRQ(ierr);
42171cfe2091SMatthew G. Knepley   PetscFunctionReturn(0);
42181cfe2091SMatthew G. Knepley }
42191cfe2091SMatthew G. Knepley 
42201cfe2091SMatthew G. Knepley #undef __FUNCT__
422146e270d4SMatthew G. Knepley #define __FUNCT__ "DMGetCoordinateDim"
422246e270d4SMatthew G. Knepley /*@
422346e270d4SMatthew G. Knepley   DMGetCoordinateDim - Retrieve the dimension of embedding space for coordinate values.
422446e270d4SMatthew G. Knepley 
422546e270d4SMatthew G. Knepley   Not Collective
422646e270d4SMatthew G. Knepley 
422746e270d4SMatthew G. Knepley   Input Parameter:
422846e270d4SMatthew G. Knepley . dm - The DM object
422946e270d4SMatthew G. Knepley 
423046e270d4SMatthew G. Knepley   Output Parameter:
423146e270d4SMatthew G. Knepley . dim - The embedding dimension
423246e270d4SMatthew G. Knepley 
423346e270d4SMatthew G. Knepley   Level: intermediate
423446e270d4SMatthew G. Knepley 
423546e270d4SMatthew G. Knepley .keywords: mesh, coordinates
423646e270d4SMatthew G. Knepley .seealso: DMSetCoordinateDim(), DMGetCoordinateSection(), DMGetCoordinateDM(), DMGetDefaultSection(), DMSetDefaultSection()
423746e270d4SMatthew G. Knepley @*/
423846e270d4SMatthew G. Knepley PetscErrorCode DMGetCoordinateDim(DM dm, PetscInt *dim)
423946e270d4SMatthew G. Knepley {
424046e270d4SMatthew G. Knepley   PetscFunctionBegin;
424146e270d4SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
424246e270d4SMatthew G. Knepley   PetscValidPointer(dim, 2);
42439a9a41abSToby Isaac   if (dm->dimEmbed == PETSC_DEFAULT) {
42449a9a41abSToby Isaac     dm->dimEmbed = dm->dim;
42459a9a41abSToby Isaac   }
424646e270d4SMatthew G. Knepley   *dim = dm->dimEmbed;
424746e270d4SMatthew G. Knepley   PetscFunctionReturn(0);
424846e270d4SMatthew G. Knepley }
424946e270d4SMatthew G. Knepley 
425046e270d4SMatthew G. Knepley #undef __FUNCT__
425146e270d4SMatthew G. Knepley #define __FUNCT__ "DMSetCoordinateDim"
425246e270d4SMatthew G. Knepley /*@
425346e270d4SMatthew G. Knepley   DMSetCoordinateDim - Set the dimension of the embedding space for coordinate values.
425446e270d4SMatthew G. Knepley 
425546e270d4SMatthew G. Knepley   Not Collective
425646e270d4SMatthew G. Knepley 
425746e270d4SMatthew G. Knepley   Input Parameters:
425846e270d4SMatthew G. Knepley + dm  - The DM object
425946e270d4SMatthew G. Knepley - dim - The embedding dimension
426046e270d4SMatthew G. Knepley 
426146e270d4SMatthew G. Knepley   Level: intermediate
426246e270d4SMatthew G. Knepley 
426346e270d4SMatthew G. Knepley .keywords: mesh, coordinates
426446e270d4SMatthew G. Knepley .seealso: DMGetCoordinateDim(), DMSetCoordinateSection(), DMGetCoordinateSection(), DMGetDefaultSection(), DMSetDefaultSection()
426546e270d4SMatthew G. Knepley @*/
426646e270d4SMatthew G. Knepley PetscErrorCode DMSetCoordinateDim(DM dm, PetscInt dim)
426746e270d4SMatthew G. Knepley {
426846e270d4SMatthew G. Knepley   PetscFunctionBegin;
426946e270d4SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
427046e270d4SMatthew G. Knepley   dm->dimEmbed = dim;
427146e270d4SMatthew G. Knepley   PetscFunctionReturn(0);
427246e270d4SMatthew G. Knepley }
427346e270d4SMatthew G. Knepley 
427446e270d4SMatthew G. Knepley #undef __FUNCT__
4275e8abe2deSMatthew G. Knepley #define __FUNCT__ "DMGetCoordinateSection"
4276e8abe2deSMatthew G. Knepley /*@
4277e8abe2deSMatthew G. Knepley   DMGetCoordinateSection - Retrieve the layout of coordinate values over the mesh.
4278e8abe2deSMatthew G. Knepley 
4279e8abe2deSMatthew G. Knepley   Not Collective
4280e8abe2deSMatthew G. Knepley 
4281e8abe2deSMatthew G. Knepley   Input Parameter:
4282e8abe2deSMatthew G. Knepley . dm - The DM object
4283e8abe2deSMatthew G. Knepley 
4284e8abe2deSMatthew G. Knepley   Output Parameter:
4285e8abe2deSMatthew G. Knepley . section - The PetscSection object
4286e8abe2deSMatthew G. Knepley 
4287e8abe2deSMatthew G. Knepley   Level: intermediate
4288e8abe2deSMatthew G. Knepley 
4289e8abe2deSMatthew G. Knepley .keywords: mesh, coordinates
4290e8abe2deSMatthew G. Knepley .seealso: DMGetCoordinateDM(), DMGetDefaultSection(), DMSetDefaultSection()
4291e8abe2deSMatthew G. Knepley @*/
4292e8abe2deSMatthew G. Knepley PetscErrorCode DMGetCoordinateSection(DM dm, PetscSection *section)
4293e8abe2deSMatthew G. Knepley {
4294e8abe2deSMatthew G. Knepley   DM             cdm;
4295e8abe2deSMatthew G. Knepley   PetscErrorCode ierr;
4296e8abe2deSMatthew G. Knepley 
4297e8abe2deSMatthew G. Knepley   PetscFunctionBegin;
4298e8abe2deSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4299e8abe2deSMatthew G. Knepley   PetscValidPointer(section, 2);
4300e8abe2deSMatthew G. Knepley   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
4301e8abe2deSMatthew G. Knepley   ierr = DMGetDefaultSection(cdm, section);CHKERRQ(ierr);
4302e8abe2deSMatthew G. Knepley   PetscFunctionReturn(0);
4303e8abe2deSMatthew G. Knepley }
4304e8abe2deSMatthew G. Knepley 
4305e8abe2deSMatthew G. Knepley #undef __FUNCT__
4306e8abe2deSMatthew G. Knepley #define __FUNCT__ "DMSetCoordinateSection"
4307e8abe2deSMatthew G. Knepley /*@
4308e8abe2deSMatthew G. Knepley   DMSetCoordinateSection - Set the layout of coordinate values over the mesh.
4309e8abe2deSMatthew G. Knepley 
4310e8abe2deSMatthew G. Knepley   Not Collective
4311e8abe2deSMatthew G. Knepley 
4312e8abe2deSMatthew G. Knepley   Input Parameters:
4313e8abe2deSMatthew G. Knepley + dm      - The DM object
431446e270d4SMatthew G. Knepley . dim     - The embedding dimension, or PETSC_DETERMINE
4315e8abe2deSMatthew G. Knepley - section - The PetscSection object
4316e8abe2deSMatthew G. Knepley 
4317e8abe2deSMatthew G. Knepley   Level: intermediate
4318e8abe2deSMatthew G. Knepley 
4319e8abe2deSMatthew G. Knepley .keywords: mesh, coordinates
4320e8abe2deSMatthew G. Knepley .seealso: DMGetCoordinateSection(), DMGetDefaultSection(), DMSetDefaultSection()
4321e8abe2deSMatthew G. Knepley @*/
432246e270d4SMatthew G. Knepley PetscErrorCode DMSetCoordinateSection(DM dm, PetscInt dim, PetscSection section)
4323e8abe2deSMatthew G. Knepley {
4324e8abe2deSMatthew G. Knepley   DM             cdm;
4325e8abe2deSMatthew G. Knepley   PetscErrorCode ierr;
4326e8abe2deSMatthew G. Knepley 
4327e8abe2deSMatthew G. Knepley   PetscFunctionBegin;
4328e8abe2deSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
432946e270d4SMatthew G. Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,3);
4330e8abe2deSMatthew G. Knepley   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
4331e8abe2deSMatthew G. Knepley   ierr = DMSetDefaultSection(cdm, section);CHKERRQ(ierr);
433246e270d4SMatthew G. Knepley   if (dim == PETSC_DETERMINE) {
433346e270d4SMatthew G. Knepley     PetscInt d = dim;
433446e270d4SMatthew G. Knepley     PetscInt pStart, pEnd, vStart, vEnd, v, dd;
433546e270d4SMatthew G. Knepley 
433646e270d4SMatthew G. Knepley     ierr = PetscSectionGetChart(section, &pStart, &pEnd);CHKERRQ(ierr);
433746e270d4SMatthew G. Knepley     ierr = DMGetDimPoints(dm, 0, &vStart, &vEnd);CHKERRQ(ierr);
433846e270d4SMatthew G. Knepley     pStart = PetscMax(vStart, pStart);
433946e270d4SMatthew G. Knepley     pEnd   = PetscMin(vEnd, pEnd);
434046e270d4SMatthew G. Knepley     for (v = pStart; v < pEnd; ++v) {
434146e270d4SMatthew G. Knepley       ierr = PetscSectionGetDof(section, v, &dd);CHKERRQ(ierr);
434246e270d4SMatthew G. Knepley       if (dd) {d = dd; break;}
434346e270d4SMatthew G. Knepley     }
434446e270d4SMatthew G. Knepley     ierr = DMSetCoordinateDim(dm, d);CHKERRQ(ierr);
434546e270d4SMatthew G. Knepley   }
4346e8abe2deSMatthew G. Knepley   PetscFunctionReturn(0);
4347e8abe2deSMatthew G. Knepley }
4348e8abe2deSMatthew G. Knepley 
4349e8abe2deSMatthew G. Knepley #undef __FUNCT__
4350c6b900c6SMatthew G. Knepley #define __FUNCT__ "DMGetPeriodicity"
43515dc8c3f7SMatthew G. Knepley /*@C
43525dc8c3f7SMatthew G. Knepley   DMSetPeriodicity - Set the description of mesh periodicity
43535dc8c3f7SMatthew G. Knepley 
43545dc8c3f7SMatthew G. Knepley   Input Parameters:
43555dc8c3f7SMatthew G. Knepley + dm      - The DM object
43565dc8c3f7SMatthew 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
43575dc8c3f7SMatthew G. Knepley . L       - If we assume the mesh is a torus, this is the length of each coordinate
43585dc8c3f7SMatthew G. Knepley - bd      - This describes the type of periodicity in each topological dimension
43595dc8c3f7SMatthew G. Knepley 
43605dc8c3f7SMatthew G. Knepley   Level: developer
43615dc8c3f7SMatthew G. Knepley 
43625dc8c3f7SMatthew G. Knepley .seealso: DMGetPeriodicity()
43635dc8c3f7SMatthew G. Knepley @*/
43645dc8c3f7SMatthew G. Knepley PetscErrorCode DMGetPeriodicity(DM dm, const PetscReal **maxCell, const PetscReal **L, const DMBoundaryType **bd)
4365c6b900c6SMatthew G. Knepley {
4366c6b900c6SMatthew G. Knepley   PetscFunctionBegin;
4367c6b900c6SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
4368c6b900c6SMatthew G. Knepley   if (L)       *L       = dm->L;
4369c6b900c6SMatthew G. Knepley   if (maxCell) *maxCell = dm->maxCell;
43705dc8c3f7SMatthew G. Knepley   if (bd)      *bd      = dm->bdtype;
4371c6b900c6SMatthew G. Knepley   PetscFunctionReturn(0);
4372c6b900c6SMatthew G. Knepley }
4373c6b900c6SMatthew G. Knepley 
4374c6b900c6SMatthew G. Knepley #undef __FUNCT__
4375c6b900c6SMatthew G. Knepley #define __FUNCT__ "DMSetPeriodicity"
43765dc8c3f7SMatthew G. Knepley /*@C
43775dc8c3f7SMatthew G. Knepley   DMSetPeriodicity - Set the description of mesh periodicity
43785dc8c3f7SMatthew G. Knepley 
43795dc8c3f7SMatthew G. Knepley   Input Parameters:
43805dc8c3f7SMatthew G. Knepley + dm      - The DM object
43815dc8c3f7SMatthew 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
43825dc8c3f7SMatthew G. Knepley . L       - If we assume the mesh is a torus, this is the length of each coordinate
43835dc8c3f7SMatthew G. Knepley - bd      - This describes the type of periodicity in each topological dimension
43845dc8c3f7SMatthew G. Knepley 
43855dc8c3f7SMatthew G. Knepley   Level: developer
43865dc8c3f7SMatthew G. Knepley 
43875dc8c3f7SMatthew G. Knepley .seealso: DMGetPeriodicity()
43885dc8c3f7SMatthew G. Knepley @*/
43895dc8c3f7SMatthew G. Knepley PetscErrorCode DMSetPeriodicity(DM dm, const PetscReal maxCell[], const PetscReal L[], const DMBoundaryType bd[])
4390c6b900c6SMatthew G. Knepley {
4391c6b900c6SMatthew G. Knepley   PetscInt       dim, d;
4392c6b900c6SMatthew G. Knepley   PetscErrorCode ierr;
4393c6b900c6SMatthew G. Knepley 
4394c6b900c6SMatthew G. Knepley   PetscFunctionBegin;
4395c6b900c6SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
43965dc8c3f7SMatthew G. Knepley   PetscValidPointer(L,3);PetscValidPointer(maxCell,2);PetscValidPointer(bd,4);
43975dc8c3f7SMatthew G. Knepley   ierr = PetscFree3(dm->L,dm->maxCell,dm->bdtype);CHKERRQ(ierr);
43985dc8c3f7SMatthew G. Knepley   ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr);
43995dc8c3f7SMatthew G. Knepley   ierr = PetscMalloc3(dim,&dm->L,dim,&dm->maxCell,dim,&dm->bdtype);CHKERRQ(ierr);
44005dc8c3f7SMatthew G. Knepley   for (d = 0; d < dim; ++d) {dm->L[d] = L[d]; dm->maxCell[d] = maxCell[d]; dm->bdtype[d] = bd[d];}
4401c6b900c6SMatthew G. Knepley   PetscFunctionReturn(0);
4402c6b900c6SMatthew G. Knepley }
4403c6b900c6SMatthew G. Knepley 
4404c6b900c6SMatthew G. Knepley #undef __FUNCT__
44052e17dfb7SMatthew G. Knepley #define __FUNCT__ "DMLocalizeCoordinate"
44062e17dfb7SMatthew G. Knepley /*@
44072e17dfb7SMatthew 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.
44082e17dfb7SMatthew G. Knepley 
44092e17dfb7SMatthew G. Knepley   Input Parameters:
44102e17dfb7SMatthew G. Knepley + dm     - The DM
44112e17dfb7SMatthew G. Knepley - in     - The input coordinate point (dim numbers)
44122e17dfb7SMatthew G. Knepley 
44132e17dfb7SMatthew G. Knepley   Output Parameter:
44142e17dfb7SMatthew G. Knepley . out - The localized coordinate point
44152e17dfb7SMatthew G. Knepley 
44162e17dfb7SMatthew G. Knepley   Level: developer
44172e17dfb7SMatthew G. Knepley 
44182e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeAddCoordinate()
44192e17dfb7SMatthew G. Knepley @*/
44202e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinate(DM dm, const PetscScalar in[], PetscScalar out[])
44212e17dfb7SMatthew G. Knepley {
44222e17dfb7SMatthew G. Knepley   PetscInt       dim, d;
44232e17dfb7SMatthew G. Knepley   PetscErrorCode ierr;
44242e17dfb7SMatthew G. Knepley 
44252e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
44262e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &dim);CHKERRQ(ierr);
44272e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
44282e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] = in[d];
44292e17dfb7SMatthew G. Knepley   } else {
44302e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) {
44312e17dfb7SMatthew G. Knepley       out[d] = in[d] - dm->L[d]*floor(PetscRealPart(in[d])/dm->L[d]);
44322e17dfb7SMatthew G. Knepley     }
44332e17dfb7SMatthew G. Knepley   }
44342e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
44352e17dfb7SMatthew G. Knepley }
44362e17dfb7SMatthew G. Knepley 
44372e17dfb7SMatthew G. Knepley #undef __FUNCT__
44382e17dfb7SMatthew G. Knepley #define __FUNCT__ "DMLocalizeCoordinate_Internal"
44392e17dfb7SMatthew G. Knepley /*
44402e17dfb7SMatthew 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.
44412e17dfb7SMatthew G. Knepley 
44422e17dfb7SMatthew G. Knepley   Input Parameters:
44432e17dfb7SMatthew G. Knepley + dm     - The DM
44442e17dfb7SMatthew G. Knepley . dim    - The spatial dimension
44452e17dfb7SMatthew G. Knepley . anchor - The anchor point, the input point can be no more than maxCell away from it
44462e17dfb7SMatthew G. Knepley - in     - The input coordinate point (dim numbers)
44472e17dfb7SMatthew G. Knepley 
44482e17dfb7SMatthew G. Knepley   Output Parameter:
44492e17dfb7SMatthew G. Knepley . out - The localized coordinate point
44502e17dfb7SMatthew G. Knepley 
44512e17dfb7SMatthew G. Knepley   Level: developer
44522e17dfb7SMatthew G. Knepley 
44532e17dfb7SMatthew 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
44542e17dfb7SMatthew G. Knepley 
44552e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeAddCoordinate()
44562e17dfb7SMatthew G. Knepley */
44572e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinate_Internal(DM dm, PetscInt dim, const PetscScalar anchor[], const PetscScalar in[], PetscScalar out[])
44582e17dfb7SMatthew G. Knepley {
44592e17dfb7SMatthew G. Knepley   PetscInt d;
44602e17dfb7SMatthew G. Knepley 
44612e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
44622e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
44632e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] = in[d];
44642e17dfb7SMatthew G. Knepley   } else {
44652e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) {
44662e17dfb7SMatthew G. Knepley       if (PetscAbsScalar(anchor[d] - in[d]) > dm->maxCell[d]) {
44672e17dfb7SMatthew G. Knepley         out[d] = PetscRealPart(anchor[d]) > PetscRealPart(in[d]) ? dm->L[d] + in[d] : in[d] - dm->L[d];
44682e17dfb7SMatthew G. Knepley       } else {
44692e17dfb7SMatthew G. Knepley         out[d] = in[d];
44702e17dfb7SMatthew G. Knepley       }
44712e17dfb7SMatthew G. Knepley     }
44722e17dfb7SMatthew G. Knepley   }
44732e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
44742e17dfb7SMatthew G. Knepley }
44752e17dfb7SMatthew G. Knepley #undef __FUNCT__
44762e17dfb7SMatthew G. Knepley #define __FUNCT__ "DMLocalizeCoordinateReal_Internal"
44772e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinateReal_Internal(DM dm, PetscInt dim, const PetscReal anchor[], const PetscReal in[], PetscReal out[])
44782e17dfb7SMatthew G. Knepley {
44792e17dfb7SMatthew G. Knepley   PetscInt d;
44802e17dfb7SMatthew G. Knepley 
44812e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
44822e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
44832e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] = in[d];
44842e17dfb7SMatthew G. Knepley   } else {
44852e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) {
44862e17dfb7SMatthew G. Knepley       if (PetscAbsReal(anchor[d] - in[d]) > dm->maxCell[d]) {
44872e17dfb7SMatthew G. Knepley         out[d] = anchor[d] > in[d] ? dm->L[d] + in[d] : in[d] - dm->L[d];
44882e17dfb7SMatthew G. Knepley       } else {
44892e17dfb7SMatthew G. Knepley         out[d] = in[d];
44902e17dfb7SMatthew G. Knepley       }
44912e17dfb7SMatthew G. Knepley     }
44922e17dfb7SMatthew G. Knepley   }
44932e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
44942e17dfb7SMatthew G. Knepley }
44952e17dfb7SMatthew G. Knepley 
44962e17dfb7SMatthew G. Knepley #undef __FUNCT__
44972e17dfb7SMatthew G. Knepley #define __FUNCT__ "DMLocalizeAddCoordinate_Internal"
44982e17dfb7SMatthew G. Knepley /*
44992e17dfb7SMatthew 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.
45002e17dfb7SMatthew G. Knepley 
45012e17dfb7SMatthew G. Knepley   Input Parameters:
45022e17dfb7SMatthew G. Knepley + dm     - The DM
45032e17dfb7SMatthew G. Knepley . dim    - The spatial dimension
45042e17dfb7SMatthew G. Knepley . anchor - The anchor point, the input point can be no more than maxCell away from it
45052e17dfb7SMatthew G. Knepley . in     - The input coordinate delta (dim numbers)
45062e17dfb7SMatthew G. Knepley - out    - The input coordinate point (dim numbers)
45072e17dfb7SMatthew G. Knepley 
45082e17dfb7SMatthew G. Knepley   Output Parameter:
45092e17dfb7SMatthew G. Knepley . out    - The localized coordinate in + out
45102e17dfb7SMatthew G. Knepley 
45112e17dfb7SMatthew G. Knepley   Level: developer
45122e17dfb7SMatthew G. Knepley 
45132e17dfb7SMatthew 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
45142e17dfb7SMatthew G. Knepley 
45152e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeCoordinate()
45162e17dfb7SMatthew G. Knepley */
45172e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeAddCoordinate_Internal(DM dm, PetscInt dim, const PetscScalar anchor[], const PetscScalar in[], PetscScalar out[])
45182e17dfb7SMatthew G. Knepley {
45192e17dfb7SMatthew G. Knepley   PetscInt d;
45202e17dfb7SMatthew G. Knepley 
45212e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
45222e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
45232e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] += in[d];
45242e17dfb7SMatthew G. Knepley   } else {
45252e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) {
45262e17dfb7SMatthew G. Knepley       if (PetscAbsScalar(anchor[d] - in[d]) > dm->maxCell[d]) {
45272e17dfb7SMatthew G. Knepley         out[d] += PetscRealPart(anchor[d]) > PetscRealPart(in[d]) ? dm->L[d] + in[d] : in[d] - dm->L[d];
45282e17dfb7SMatthew G. Knepley       } else {
45292e17dfb7SMatthew G. Knepley         out[d] += in[d];
45302e17dfb7SMatthew G. Knepley       }
45312e17dfb7SMatthew G. Knepley     }
45322e17dfb7SMatthew G. Knepley   }
45332e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
45342e17dfb7SMatthew G. Knepley }
45352e17dfb7SMatthew G. Knepley 
45362e17dfb7SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMPlexGetDepthStratum(DM, PetscInt, PetscInt *, PetscInt *);
45372e17dfb7SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMPlexGetHeightStratum(DM, PetscInt, PetscInt *, PetscInt *);
45382e17dfb7SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMPlexVecGetClosure(DM, PetscSection, Vec, PetscInt, PetscInt *, PetscScalar *[]);
45392e17dfb7SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMPlexVecRestoreClosure(DM, PetscSection, Vec, PetscInt, PetscInt *, PetscScalar *[]);
45402e17dfb7SMatthew G. Knepley 
45412e17dfb7SMatthew G. Knepley #undef __FUNCT__
454236447a5eSToby Isaac #define __FUNCT__ "DMGetCoordinatesLocalized"
454336447a5eSToby Isaac /*@
454436447a5eSToby Isaac   DMGetCoordinatesLocalized - Check if the DM coordinates have been localized for cells
454536447a5eSToby Isaac 
454636447a5eSToby Isaac   Input Parameter:
454736447a5eSToby Isaac . dm - The DM
454836447a5eSToby Isaac 
454936447a5eSToby Isaac   Output Parameter:
455036447a5eSToby Isaac   areLocalized - True if localized
455136447a5eSToby Isaac 
455236447a5eSToby Isaac   Level: developer
455336447a5eSToby Isaac 
455436447a5eSToby Isaac .seealso: DMLocalizeCoordinates()
455536447a5eSToby Isaac @*/
455636447a5eSToby Isaac PetscErrorCode DMGetCoordinatesLocalized(DM dm,PetscBool *areLocalized)
455736447a5eSToby Isaac {
455836447a5eSToby Isaac   DM             cdm;
455936447a5eSToby Isaac   PetscSection   coordSection;
456036447a5eSToby Isaac   PetscInt       cStart, cEnd, c, sStart, sEnd, dof;
456136447a5eSToby Isaac   PetscBool      alreadyLocalized, alreadyLocalizedGlobal;
456236447a5eSToby Isaac   PetscErrorCode ierr;
456336447a5eSToby Isaac 
456436447a5eSToby Isaac   PetscFunctionBegin;
456536447a5eSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
45668b09590cSToby Isaac   if (!dm->maxCell) {
45678b09590cSToby Isaac     *areLocalized = PETSC_FALSE;
45688b09590cSToby Isaac     PetscFunctionReturn(0);
45698b09590cSToby Isaac   }
457036447a5eSToby Isaac   /* We need some generic way of refering to cells/vertices */
457136447a5eSToby Isaac   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
457236447a5eSToby Isaac   {
457336447a5eSToby Isaac     PetscBool isplex;
457436447a5eSToby Isaac 
457536447a5eSToby Isaac     ierr = PetscObjectTypeCompare((PetscObject) cdm, DMPLEX, &isplex);CHKERRQ(ierr);
457636447a5eSToby Isaac     if (isplex) {
457736447a5eSToby Isaac       ierr = DMPlexGetHeightStratum(cdm, 0, &cStart, &cEnd);CHKERRQ(ierr);
457836447a5eSToby Isaac     } else SETERRQ(PetscObjectComm((PetscObject) cdm), PETSC_ERR_ARG_WRONG, "Coordinate localization requires a DMPLEX coordinate DM");
457936447a5eSToby Isaac   }
458036447a5eSToby Isaac   ierr = DMGetCoordinateSection(dm, &coordSection);CHKERRQ(ierr);
458136447a5eSToby Isaac   ierr = PetscSectionGetChart(coordSection,&sStart,&sEnd);CHKERRQ(ierr);
458236447a5eSToby Isaac   alreadyLocalized = alreadyLocalizedGlobal = PETSC_TRUE;
458336447a5eSToby Isaac   for (c = cStart; c < cEnd; ++c) {
458436447a5eSToby Isaac     if (c < sStart || c >= sEnd) {
458536447a5eSToby Isaac       alreadyLocalized = PETSC_FALSE;
458636447a5eSToby Isaac       break;
458736447a5eSToby Isaac     }
458836447a5eSToby Isaac     ierr = PetscSectionGetDof(coordSection, c, &dof);CHKERRQ(ierr);
458936447a5eSToby Isaac     if (!dof) {
459036447a5eSToby Isaac       alreadyLocalized = PETSC_FALSE;
459136447a5eSToby Isaac       break;
459236447a5eSToby Isaac     }
459336447a5eSToby Isaac   }
459436447a5eSToby Isaac   ierr = MPI_Allreduce(&alreadyLocalized,&alreadyLocalizedGlobal,1,MPIU_BOOL,MPI_LAND,PetscObjectComm((PetscObject)dm));CHKERRQ(ierr);
459536447a5eSToby Isaac   *areLocalized = alreadyLocalizedGlobal;
459636447a5eSToby Isaac   PetscFunctionReturn(0);
459736447a5eSToby Isaac }
459836447a5eSToby Isaac 
459936447a5eSToby Isaac 
460036447a5eSToby Isaac #undef __FUNCT__
46012e17dfb7SMatthew G. Knepley #define __FUNCT__ "DMLocalizeCoordinates"
46022e17dfb7SMatthew G. Knepley /*@
46032e17dfb7SMatthew G. Knepley   DMLocalizeCoordinates - If a mesh is periodic, create local coordinates for each cell
46042e17dfb7SMatthew G. Knepley 
46052e17dfb7SMatthew G. Knepley   Input Parameter:
46062e17dfb7SMatthew G. Knepley . dm - The DM
46072e17dfb7SMatthew G. Knepley 
46082e17dfb7SMatthew G. Knepley   Level: developer
46092e17dfb7SMatthew G. Knepley 
46102e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinate(), DMLocalizeAddCoordinate()
46112e17dfb7SMatthew G. Knepley @*/
46122e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinates(DM dm)
46132e17dfb7SMatthew G. Knepley {
46142e17dfb7SMatthew G. Knepley   DM             cdm;
46152e17dfb7SMatthew G. Knepley   PetscSection   coordSection, cSection;
46162e17dfb7SMatthew G. Knepley   Vec            coordinates,  cVec;
46172e17dfb7SMatthew G. Knepley   PetscScalar   *coords, *coords2, *anchor;
4618e0ae35bbSToby Isaac   PetscInt       Nc, cStart, cEnd, c, vStart, vEnd, v, sStart, sEnd, dof, d, off, off2, bs, coordSize;
4619e0ae35bbSToby Isaac   PetscBool      alreadyLocalized, alreadyLocalizedGlobal;
46202e17dfb7SMatthew G. Knepley   PetscErrorCode ierr;
46212e17dfb7SMatthew G. Knepley 
46222e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
46232e17dfb7SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
46242e17dfb7SMatthew G. Knepley   if (!dm->maxCell) PetscFunctionReturn(0);
46252e17dfb7SMatthew G. Knepley   /* We need some generic way of refering to cells/vertices */
46262e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
46272e17dfb7SMatthew G. Knepley   {
46282e17dfb7SMatthew G. Knepley     PetscBool isplex;
46292e17dfb7SMatthew G. Knepley 
46302e17dfb7SMatthew G. Knepley     ierr = PetscObjectTypeCompare((PetscObject) cdm, DMPLEX, &isplex);CHKERRQ(ierr);
46312e17dfb7SMatthew G. Knepley     if (isplex) {
46322e17dfb7SMatthew G. Knepley       ierr = DMPlexGetHeightStratum(cdm, 0, &cStart, &cEnd);CHKERRQ(ierr);
46332e17dfb7SMatthew G. Knepley       ierr = DMPlexGetDepthStratum(cdm, 0, &vStart, &vEnd);CHKERRQ(ierr);
46342e17dfb7SMatthew G. Knepley     } else SETERRQ(PetscObjectComm((PetscObject) cdm), PETSC_ERR_ARG_WRONG, "Coordinate localization requires a DMPLEX coordinate DM");
46352e17dfb7SMatthew G. Knepley   }
46362e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinatesLocal(dm, &coordinates);CHKERRQ(ierr);
46372e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinateSection(dm, &coordSection);CHKERRQ(ierr);
4638e0ae35bbSToby Isaac   ierr = PetscSectionGetChart(coordSection,&sStart,&sEnd);CHKERRQ(ierr);
4639e0ae35bbSToby Isaac   alreadyLocalized = alreadyLocalizedGlobal = PETSC_TRUE;
4640e0ae35bbSToby Isaac   for (c = cStart; c < cEnd; ++c) {
4641e0ae35bbSToby Isaac     if (c < sStart || c >= sEnd) {
4642e0ae35bbSToby Isaac       alreadyLocalized = PETSC_FALSE;
4643e0ae35bbSToby Isaac       break;
4644e0ae35bbSToby Isaac     }
4645e0ae35bbSToby Isaac     ierr = PetscSectionGetDof(coordSection, c, &dof);CHKERRQ(ierr);
4646e0ae35bbSToby Isaac     if (!dof) {
4647e0ae35bbSToby Isaac       alreadyLocalized = PETSC_FALSE;
4648e0ae35bbSToby Isaac       break;
4649e0ae35bbSToby Isaac     }
4650e0ae35bbSToby Isaac   }
4651e0ae35bbSToby Isaac   ierr = MPI_Allreduce(&alreadyLocalized,&alreadyLocalizedGlobal,1,MPIU_BOOL,MPI_LAND,PetscObjectComm((PetscObject)dm));CHKERRQ(ierr);
4652e0ae35bbSToby Isaac   if (alreadyLocalizedGlobal) PetscFunctionReturn(0);
46532e17dfb7SMatthew G. Knepley   ierr = PetscSectionCreate(PetscObjectComm((PetscObject) dm), &cSection);CHKERRQ(ierr);
46542e17dfb7SMatthew G. Knepley   ierr = PetscSectionSetNumFields(cSection, 1);CHKERRQ(ierr);
46552e17dfb7SMatthew G. Knepley   ierr = PetscSectionGetFieldComponents(coordSection, 0, &Nc);CHKERRQ(ierr);
46562e17dfb7SMatthew G. Knepley   ierr = PetscSectionSetFieldComponents(cSection, 0, Nc);CHKERRQ(ierr);
46572e17dfb7SMatthew G. Knepley   ierr = PetscSectionSetChart(cSection, cStart, vEnd);CHKERRQ(ierr);
46582e17dfb7SMatthew G. Knepley   for (v = vStart; v < vEnd; ++v) {
46592e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetDof(coordSection, v, &dof);CHKERRQ(ierr);
46602e17dfb7SMatthew G. Knepley     ierr = PetscSectionSetDof(cSection,     v,  dof);CHKERRQ(ierr);
46612e17dfb7SMatthew G. Knepley     ierr = PetscSectionSetFieldDof(cSection, v, 0, dof);CHKERRQ(ierr);
46622e17dfb7SMatthew G. Knepley   }
46632e17dfb7SMatthew G. Knepley   for (c = cStart; c < cEnd; ++c) {
46642e17dfb7SMatthew G. Knepley     ierr = DMPlexVecGetClosure(cdm, coordSection, coordinates, c, &dof, NULL);CHKERRQ(ierr);
46652e17dfb7SMatthew G. Knepley     ierr = PetscSectionSetDof(cSection, c, dof);CHKERRQ(ierr);
46662e17dfb7SMatthew G. Knepley     ierr = PetscSectionSetFieldDof(cSection, c, 0, dof);CHKERRQ(ierr);
46672e17dfb7SMatthew G. Knepley   }
46682e17dfb7SMatthew G. Knepley   ierr = PetscSectionSetUp(cSection);CHKERRQ(ierr);
46692e17dfb7SMatthew G. Knepley   ierr = PetscSectionGetStorageSize(cSection, &coordSize);CHKERRQ(ierr);
46702e17dfb7SMatthew G. Knepley   ierr = VecCreate(PetscObjectComm((PetscObject) dm), &cVec);CHKERRQ(ierr);
46712e17dfb7SMatthew G. Knepley   ierr = PetscObjectSetName((PetscObject)cVec,"coordinates");CHKERRQ(ierr);
46722e17dfb7SMatthew G. Knepley   ierr = VecGetBlockSize(coordinates, &bs);CHKERRQ(ierr);
46732e17dfb7SMatthew G. Knepley   ierr = VecSetBlockSize(cVec,         bs);CHKERRQ(ierr);
46742e17dfb7SMatthew G. Knepley   ierr = VecSetSizes(cVec, coordSize, PETSC_DETERMINE);CHKERRQ(ierr);
46752e17dfb7SMatthew G. Knepley   ierr = VecSetType(cVec,VECSTANDARD);CHKERRQ(ierr);
46762e17dfb7SMatthew G. Knepley   ierr = VecGetArray(coordinates, &coords);CHKERRQ(ierr);
46772e17dfb7SMatthew G. Knepley   ierr = VecGetArray(cVec,        &coords2);CHKERRQ(ierr);
46782e17dfb7SMatthew G. Knepley   for (v = vStart; v < vEnd; ++v) {
46792e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetDof(coordSection, v, &dof);CHKERRQ(ierr);
46802e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetOffset(coordSection, v, &off);CHKERRQ(ierr);
46812e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetOffset(cSection,     v, &off2);CHKERRQ(ierr);
46822e17dfb7SMatthew G. Knepley     for (d = 0; d < dof; ++d) coords2[off2+d] = coords[off+d];
46832e17dfb7SMatthew G. Knepley   }
46842e17dfb7SMatthew G. Knepley   ierr = DMGetWorkArray(dm, 3, PETSC_SCALAR, &anchor);CHKERRQ(ierr);
46852e17dfb7SMatthew G. Knepley   for (c = cStart; c < cEnd; ++c) {
46862e17dfb7SMatthew G. Knepley     PetscScalar *cellCoords = NULL;
46872e17dfb7SMatthew G. Knepley     PetscInt     b;
46882e17dfb7SMatthew G. Knepley 
46892e17dfb7SMatthew G. Knepley     ierr = DMPlexVecGetClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
46902e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetOffset(cSection, c, &off2);CHKERRQ(ierr);
46912e17dfb7SMatthew G. Knepley     for (b = 0; b < bs; ++b) anchor[b] = cellCoords[b];
46922e17dfb7SMatthew G. Knepley     for (d = 0; d < dof/bs; ++d) {ierr = DMLocalizeCoordinate_Internal(dm, bs, anchor, &cellCoords[d*bs], &coords2[off2+d*bs]);CHKERRQ(ierr);}
46932e17dfb7SMatthew G. Knepley     ierr = DMPlexVecRestoreClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
46942e17dfb7SMatthew G. Knepley   }
46952e17dfb7SMatthew G. Knepley   ierr = DMRestoreWorkArray(dm, 3, PETSC_SCALAR, &anchor);CHKERRQ(ierr);
46962e17dfb7SMatthew G. Knepley   ierr = VecRestoreArray(coordinates, &coords);CHKERRQ(ierr);
46972e17dfb7SMatthew G. Knepley   ierr = VecRestoreArray(cVec,        &coords2);CHKERRQ(ierr);
46982e17dfb7SMatthew G. Knepley   ierr = DMSetCoordinateSection(dm, PETSC_DETERMINE, cSection);CHKERRQ(ierr);
46992e17dfb7SMatthew G. Knepley   ierr = DMSetCoordinatesLocal(dm, cVec);CHKERRQ(ierr);
47002e17dfb7SMatthew G. Knepley   ierr = VecDestroy(&cVec);CHKERRQ(ierr);
47012e17dfb7SMatthew G. Knepley   ierr = PetscSectionDestroy(&cSection);CHKERRQ(ierr);
47022e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
47032e17dfb7SMatthew G. Knepley }
47042e17dfb7SMatthew G. Knepley 
47052e17dfb7SMatthew G. Knepley #undef __FUNCT__
4706e87bb0d3SMatthew G Knepley #define __FUNCT__ "DMLocatePoints"
4707e87bb0d3SMatthew G Knepley /*@
4708e87bb0d3SMatthew G Knepley   DMLocatePoints - Locate the points in v in the mesh and return an IS of the containing cells
4709e87bb0d3SMatthew G Knepley 
4710e87bb0d3SMatthew G Knepley   Not collective
4711e87bb0d3SMatthew G Knepley 
4712e87bb0d3SMatthew G Knepley   Input Parameters:
4713e87bb0d3SMatthew G Knepley + dm - The DM
4714e87bb0d3SMatthew G Knepley - v - The Vec of points
4715e87bb0d3SMatthew G Knepley 
471661e3bb9bSMatthew G Knepley   Output Parameter:
4717e87bb0d3SMatthew G Knepley . cells - The local cell numbers for cells which contain the points
4718e87bb0d3SMatthew G Knepley 
4719e87bb0d3SMatthew G Knepley   Level: developer
472061e3bb9bSMatthew G Knepley 
472161e3bb9bSMatthew G Knepley .keywords: point location, mesh
472261e3bb9bSMatthew G Knepley .seealso: DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal()
472361e3bb9bSMatthew G Knepley @*/
4724e87bb0d3SMatthew G Knepley PetscErrorCode DMLocatePoints(DM dm, Vec v, IS *cells)
4725e87bb0d3SMatthew G Knepley {
4726735aa83eSMatthew G Knepley   PetscErrorCode ierr;
4727735aa83eSMatthew G Knepley 
4728e87bb0d3SMatthew G Knepley   PetscFunctionBegin;
4729e87bb0d3SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
4730e87bb0d3SMatthew G Knepley   PetscValidHeaderSpecific(v,VEC_CLASSID,2);
4731e87bb0d3SMatthew G Knepley   PetscValidPointer(cells,3);
473247a35634SPatrick Farrell   ierr = PetscLogEventBegin(DM_LocatePoints,dm,0,0,0);CHKERRQ(ierr);
4733735aa83eSMatthew G Knepley   if (dm->ops->locatepoints) {
4734735aa83eSMatthew G Knepley     ierr = (*dm->ops->locatepoints)(dm,v,cells);CHKERRQ(ierr);
473582f516ccSBarry Smith   } else SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Point location not available for this DM");
473647a35634SPatrick Farrell   ierr = PetscLogEventEnd(DM_LocatePoints,dm,0,0,0);CHKERRQ(ierr);
4737e87bb0d3SMatthew G Knepley   PetscFunctionReturn(0);
4738e87bb0d3SMatthew G Knepley }
473914f150ffSMatthew G. Knepley 
474014f150ffSMatthew G. Knepley #undef __FUNCT__
474114f150ffSMatthew G. Knepley #define __FUNCT__ "DMGetOutputDM"
4742f4d763aaSMatthew G. Knepley /*@
4743f4d763aaSMatthew G. Knepley   DMGetOutputDM - Retrieve the DM associated with the layout for output
4744f4d763aaSMatthew G. Knepley 
4745f4d763aaSMatthew G. Knepley   Input Parameter:
4746f4d763aaSMatthew G. Knepley . dm - The original DM
4747f4d763aaSMatthew G. Knepley 
4748f4d763aaSMatthew G. Knepley   Output Parameter:
4749f4d763aaSMatthew G. Knepley . odm - The DM which provides the layout for output
4750f4d763aaSMatthew G. Knepley 
4751f4d763aaSMatthew G. Knepley   Level: intermediate
4752f4d763aaSMatthew G. Knepley 
4753f4d763aaSMatthew G. Knepley .seealso: VecView(), DMGetDefaultGlobalSection()
4754f4d763aaSMatthew G. Knepley @*/
475514f150ffSMatthew G. Knepley PetscErrorCode DMGetOutputDM(DM dm, DM *odm)
475614f150ffSMatthew G. Knepley {
4757c26acbdeSMatthew G. Knepley   PetscSection   section;
4758c26acbdeSMatthew G. Knepley   PetscBool      hasConstraints;
475914f150ffSMatthew G. Knepley   PetscErrorCode ierr;
476014f150ffSMatthew G. Knepley 
476114f150ffSMatthew G. Knepley   PetscFunctionBegin;
476214f150ffSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
476314f150ffSMatthew G. Knepley   PetscValidPointer(odm,2);
4764c26acbdeSMatthew G. Knepley   ierr = DMGetDefaultSection(dm, &section);CHKERRQ(ierr);
4765c26acbdeSMatthew G. Knepley   ierr = PetscSectionHasConstraints(section, &hasConstraints);CHKERRQ(ierr);
4766c26acbdeSMatthew G. Knepley   if (!hasConstraints) {
4767c26acbdeSMatthew G. Knepley     *odm = dm;
4768c26acbdeSMatthew G. Knepley     PetscFunctionReturn(0);
4769c26acbdeSMatthew G. Knepley   }
477014f150ffSMatthew G. Knepley   if (!dm->dmBC) {
47710305aff6SMatthew G. Knepley     PetscDS      ds;
4772c26acbdeSMatthew G. Knepley     PetscSection newSection, gsection;
477314f150ffSMatthew G. Knepley     PetscSF      sf;
477414f150ffSMatthew G. Knepley 
477514f150ffSMatthew G. Knepley     ierr = DMClone(dm, &dm->dmBC);CHKERRQ(ierr);
47760305aff6SMatthew G. Knepley     ierr = DMGetDS(dm, &ds);CHKERRQ(ierr);
47770305aff6SMatthew G. Knepley     ierr = DMSetDS(dm->dmBC, ds);CHKERRQ(ierr);
477814f150ffSMatthew G. Knepley     ierr = PetscSectionClone(section, &newSection);CHKERRQ(ierr);
477914f150ffSMatthew G. Knepley     ierr = DMSetDefaultSection(dm->dmBC, newSection);CHKERRQ(ierr);
478014f150ffSMatthew G. Knepley     ierr = PetscSectionDestroy(&newSection);CHKERRQ(ierr);
478114f150ffSMatthew G. Knepley     ierr = DMGetPointSF(dm->dmBC, &sf);CHKERRQ(ierr);
478215b58121SMatthew G. Knepley     ierr = PetscSectionCreateGlobalSection(section, sf, PETSC_TRUE, PETSC_FALSE, &gsection);CHKERRQ(ierr);
478314f150ffSMatthew G. Knepley     ierr = DMSetDefaultGlobalSection(dm->dmBC, gsection);CHKERRQ(ierr);
478414f150ffSMatthew G. Knepley     ierr = PetscSectionDestroy(&gsection);CHKERRQ(ierr);
478514f150ffSMatthew G. Knepley   }
478614f150ffSMatthew G. Knepley   *odm = dm->dmBC;
478714f150ffSMatthew G. Knepley   PetscFunctionReturn(0);
478814f150ffSMatthew G. Knepley }
4789f4d763aaSMatthew G. Knepley 
4790f4d763aaSMatthew G. Knepley #undef __FUNCT__
4791f4d763aaSMatthew G. Knepley #define __FUNCT__ "DMGetOutputSequenceNumber"
4792f4d763aaSMatthew G. Knepley /*@
4793cdb7a50dSMatthew G. Knepley   DMGetOutputSequenceNumber - Retrieve the sequence number/value for output
4794f4d763aaSMatthew G. Knepley 
4795f4d763aaSMatthew G. Knepley   Input Parameter:
4796f4d763aaSMatthew G. Knepley . dm - The original DM
4797f4d763aaSMatthew G. Knepley 
4798cdb7a50dSMatthew G. Knepley   Output Parameters:
4799cdb7a50dSMatthew G. Knepley + num - The output sequence number
4800cdb7a50dSMatthew G. Knepley - val - The output sequence value
4801f4d763aaSMatthew G. Knepley 
4802f4d763aaSMatthew G. Knepley   Level: intermediate
4803f4d763aaSMatthew G. Knepley 
4804f4d763aaSMatthew G. Knepley   Note: This is intended for output that should appear in sequence, for instance
4805f4d763aaSMatthew G. Knepley   a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system.
4806f4d763aaSMatthew G. Knepley 
4807f4d763aaSMatthew G. Knepley .seealso: VecView()
4808f4d763aaSMatthew G. Knepley @*/
4809cdb7a50dSMatthew G. Knepley PetscErrorCode DMGetOutputSequenceNumber(DM dm, PetscInt *num, PetscReal *val)
4810f4d763aaSMatthew G. Knepley {
4811f4d763aaSMatthew G. Knepley   PetscFunctionBegin;
4812f4d763aaSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
4813cdb7a50dSMatthew G. Knepley   if (num) {PetscValidPointer(num,2); *num = dm->outputSequenceNum;}
4814cdb7a50dSMatthew G. Knepley   if (val) {PetscValidPointer(val,3);*val = dm->outputSequenceVal;}
4815f4d763aaSMatthew G. Knepley   PetscFunctionReturn(0);
4816f4d763aaSMatthew G. Knepley }
4817f4d763aaSMatthew G. Knepley 
4818f4d763aaSMatthew G. Knepley #undef __FUNCT__
4819f4d763aaSMatthew G. Knepley #define __FUNCT__ "DMSetOutputSequenceNumber"
4820f4d763aaSMatthew G. Knepley /*@
4821cdb7a50dSMatthew G. Knepley   DMSetOutputSequenceNumber - Set the sequence number/value for output
4822f4d763aaSMatthew G. Knepley 
4823f4d763aaSMatthew G. Knepley   Input Parameters:
4824f4d763aaSMatthew G. Knepley + dm - The original DM
4825cdb7a50dSMatthew G. Knepley . num - The output sequence number
4826cdb7a50dSMatthew G. Knepley - val - The output sequence value
4827f4d763aaSMatthew G. Knepley 
4828f4d763aaSMatthew G. Knepley   Level: intermediate
4829f4d763aaSMatthew G. Knepley 
4830f4d763aaSMatthew G. Knepley   Note: This is intended for output that should appear in sequence, for instance
4831f4d763aaSMatthew G. Knepley   a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system.
4832f4d763aaSMatthew G. Knepley 
4833f4d763aaSMatthew G. Knepley .seealso: VecView()
4834f4d763aaSMatthew G. Knepley @*/
4835cdb7a50dSMatthew G. Knepley PetscErrorCode DMSetOutputSequenceNumber(DM dm, PetscInt num, PetscReal val)
4836f4d763aaSMatthew G. Knepley {
4837f4d763aaSMatthew G. Knepley   PetscFunctionBegin;
4838f4d763aaSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
4839f4d763aaSMatthew G. Knepley   dm->outputSequenceNum = num;
4840cdb7a50dSMatthew G. Knepley   dm->outputSequenceVal = val;
4841cdb7a50dSMatthew G. Knepley   PetscFunctionReturn(0);
4842cdb7a50dSMatthew G. Knepley }
4843cdb7a50dSMatthew G. Knepley 
4844cdb7a50dSMatthew G. Knepley #undef __FUNCT__
4845cdb7a50dSMatthew G. Knepley #define __FUNCT__ "DMOutputSequenceLoad"
4846cdb7a50dSMatthew G. Knepley /*@C
4847cdb7a50dSMatthew G. Knepley   DMOutputSequenceLoad - Retrieve the sequence value from a Viewer
4848cdb7a50dSMatthew G. Knepley 
4849cdb7a50dSMatthew G. Knepley   Input Parameters:
4850cdb7a50dSMatthew G. Knepley + dm   - The original DM
4851cdb7a50dSMatthew G. Knepley . name - The sequence name
4852cdb7a50dSMatthew G. Knepley - num  - The output sequence number
4853cdb7a50dSMatthew G. Knepley 
4854cdb7a50dSMatthew G. Knepley   Output Parameter:
4855cdb7a50dSMatthew G. Knepley . val  - The output sequence value
4856cdb7a50dSMatthew G. Knepley 
4857cdb7a50dSMatthew G. Knepley   Level: intermediate
4858cdb7a50dSMatthew G. Knepley 
4859cdb7a50dSMatthew G. Knepley   Note: This is intended for output that should appear in sequence, for instance
4860cdb7a50dSMatthew G. Knepley   a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system.
4861cdb7a50dSMatthew G. Knepley 
4862cdb7a50dSMatthew G. Knepley .seealso: DMGetOutputSequenceNumber(), DMSetOutputSequenceNumber(), VecView()
4863cdb7a50dSMatthew G. Knepley @*/
4864cdb7a50dSMatthew G. Knepley PetscErrorCode DMOutputSequenceLoad(DM dm, PetscViewer viewer, const char *name, PetscInt num, PetscReal *val)
4865cdb7a50dSMatthew G. Knepley {
4866cdb7a50dSMatthew G. Knepley   PetscBool      ishdf5;
4867cdb7a50dSMatthew G. Knepley   PetscErrorCode ierr;
4868cdb7a50dSMatthew G. Knepley 
4869cdb7a50dSMatthew G. Knepley   PetscFunctionBegin;
4870cdb7a50dSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
4871cdb7a50dSMatthew G. Knepley   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
4872cdb7a50dSMatthew G. Knepley   PetscValidPointer(val,4);
4873cdb7a50dSMatthew G. Knepley   ierr = PetscObjectTypeCompare((PetscObject) viewer, PETSCVIEWERHDF5, &ishdf5);CHKERRQ(ierr);
4874cdb7a50dSMatthew G. Knepley   if (ishdf5) {
4875cdb7a50dSMatthew G. Knepley #if defined(PETSC_HAVE_HDF5)
4876cdb7a50dSMatthew G. Knepley     PetscScalar value;
4877cdb7a50dSMatthew G. Knepley 
4878cdb7a50dSMatthew G. Knepley     ierr = DMSequenceLoad_HDF5(dm, name, num, &value, viewer);CHKERRQ(ierr);
48794aeb217fSMatthew G. Knepley     *val = PetscRealPart(value);
4880cdb7a50dSMatthew G. Knepley #endif
4881cdb7a50dSMatthew G. Knepley   } else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Invalid viewer; open viewer with PetscViewerHDF5Open()");
4882f4d763aaSMatthew G. Knepley   PetscFunctionReturn(0);
4883f4d763aaSMatthew G. Knepley }
48848e4ac7eaSMatthew G. Knepley 
48858e4ac7eaSMatthew G. Knepley #undef __FUNCT__
48868e4ac7eaSMatthew G. Knepley #define __FUNCT__ "DMGetUseNatural"
48878e4ac7eaSMatthew G. Knepley /*@
48888e4ac7eaSMatthew G. Knepley   DMGetUseNatural - Get the flag for creating a mapping to the natural order on distribution
48898e4ac7eaSMatthew G. Knepley 
48908e4ac7eaSMatthew G. Knepley   Not collective
48918e4ac7eaSMatthew G. Knepley 
48928e4ac7eaSMatthew G. Knepley   Input Parameter:
48938e4ac7eaSMatthew G. Knepley . dm - The DM
48948e4ac7eaSMatthew G. Knepley 
48958e4ac7eaSMatthew G. Knepley   Output Parameter:
48968e4ac7eaSMatthew G. Knepley . useNatural - The flag to build the mapping to a natural order during distribution
48978e4ac7eaSMatthew G. Knepley 
48988e4ac7eaSMatthew G. Knepley   Level: beginner
48998e4ac7eaSMatthew G. Knepley 
49008e4ac7eaSMatthew G. Knepley .seealso: DMSetUseNatural(), DMCreate()
49018e4ac7eaSMatthew G. Knepley @*/
49028e4ac7eaSMatthew G. Knepley PetscErrorCode DMGetUseNatural(DM dm, PetscBool *useNatural)
49038e4ac7eaSMatthew G. Knepley {
49048e4ac7eaSMatthew G. Knepley   PetscFunctionBegin;
49058e4ac7eaSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
49068e4ac7eaSMatthew G. Knepley   PetscValidPointer(useNatural, 2);
49078e4ac7eaSMatthew G. Knepley   *useNatural = dm->useNatural;
49088e4ac7eaSMatthew G. Knepley   PetscFunctionReturn(0);
49098e4ac7eaSMatthew G. Knepley }
49108e4ac7eaSMatthew G. Knepley 
49118e4ac7eaSMatthew G. Knepley #undef __FUNCT__
49128e4ac7eaSMatthew G. Knepley #define __FUNCT__ "DMSetUseNatural"
49138e4ac7eaSMatthew G. Knepley /*@
49148e4ac7eaSMatthew G. Knepley   DMSetUseNatural - Set the flag for creating a mapping to the natural order on distribution
49158e4ac7eaSMatthew G. Knepley 
49168e4ac7eaSMatthew G. Knepley   Collective on dm
49178e4ac7eaSMatthew G. Knepley 
49188e4ac7eaSMatthew G. Knepley   Input Parameters:
49198e4ac7eaSMatthew G. Knepley + dm - The DM
49208e4ac7eaSMatthew G. Knepley - useNatural - The flag to build the mapping to a natural order during distribution
49218e4ac7eaSMatthew G. Knepley 
49228e4ac7eaSMatthew G. Knepley   Level: beginner
49238e4ac7eaSMatthew G. Knepley 
49248e4ac7eaSMatthew G. Knepley .seealso: DMGetUseNatural(), DMCreate()
49258e4ac7eaSMatthew G. Knepley @*/
49268e4ac7eaSMatthew G. Knepley PetscErrorCode DMSetUseNatural(DM dm, PetscBool useNatural)
49278e4ac7eaSMatthew G. Knepley {
49288e4ac7eaSMatthew G. Knepley   PetscFunctionBegin;
49298e4ac7eaSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
49308e4ac7eaSMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, useNatural, 2);
49318e4ac7eaSMatthew G. Knepley   dm->useNatural = useNatural;
49328e4ac7eaSMatthew G. Knepley   PetscFunctionReturn(0);
49338e4ac7eaSMatthew G. Knepley }
4934c58f1c22SToby Isaac 
4935c58f1c22SToby Isaac #undef __FUNCT__
4936c58f1c22SToby Isaac #define __FUNCT__
4937c58f1c22SToby Isaac 
4938c58f1c22SToby Isaac #undef __FUNCT__
4939c58f1c22SToby Isaac #define __FUNCT__ "DMCreateLabel"
4940c58f1c22SToby Isaac /*@C
4941c58f1c22SToby Isaac   DMCreateLabel - Create a label of the given name if it does not already exist
4942c58f1c22SToby Isaac 
4943c58f1c22SToby Isaac   Not Collective
4944c58f1c22SToby Isaac 
4945c58f1c22SToby Isaac   Input Parameters:
4946c58f1c22SToby Isaac + dm   - The DM object
4947c58f1c22SToby Isaac - name - The label name
4948c58f1c22SToby Isaac 
4949c58f1c22SToby Isaac   Level: intermediate
4950c58f1c22SToby Isaac 
4951c58f1c22SToby Isaac .keywords: mesh
4952c58f1c22SToby Isaac .seealso: DMLabelCreate(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
4953c58f1c22SToby Isaac @*/
4954c58f1c22SToby Isaac PetscErrorCode DMCreateLabel(DM dm, const char name[])
4955c58f1c22SToby Isaac {
4956c58f1c22SToby Isaac   DMLabelLink    next  = dm->labels->next;
4957c58f1c22SToby Isaac   PetscBool      flg   = PETSC_FALSE;
4958c58f1c22SToby Isaac   PetscErrorCode ierr;
4959c58f1c22SToby Isaac 
4960c58f1c22SToby Isaac   PetscFunctionBegin;
4961c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4962c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
4963c58f1c22SToby Isaac   while (next) {
4964c58f1c22SToby Isaac     ierr = PetscStrcmp(name, next->label->name, &flg);CHKERRQ(ierr);
4965c58f1c22SToby Isaac     if (flg) break;
4966c58f1c22SToby Isaac     next = next->next;
4967c58f1c22SToby Isaac   }
4968c58f1c22SToby Isaac   if (!flg) {
4969c58f1c22SToby Isaac     DMLabelLink tmpLabel;
4970c58f1c22SToby Isaac 
4971c58f1c22SToby Isaac     ierr = PetscCalloc1(1, &tmpLabel);CHKERRQ(ierr);
4972c58f1c22SToby Isaac     ierr = DMLabelCreate(name, &tmpLabel->label);CHKERRQ(ierr);
4973c58f1c22SToby Isaac     tmpLabel->output = PETSC_TRUE;
4974c58f1c22SToby Isaac     tmpLabel->next   = dm->labels->next;
4975c58f1c22SToby Isaac     dm->labels->next = tmpLabel;
4976c58f1c22SToby Isaac   }
4977c58f1c22SToby Isaac   PetscFunctionReturn(0);
4978c58f1c22SToby Isaac }
4979c58f1c22SToby Isaac 
4980c58f1c22SToby Isaac #undef __FUNCT__
4981c58f1c22SToby Isaac #define __FUNCT__ "DMGetLabelValue"
4982c58f1c22SToby Isaac /*@C
4983c58f1c22SToby Isaac   DMGetLabelValue - Get the value in a Sieve Label for the given point, with 0 as the default
4984c58f1c22SToby Isaac 
4985c58f1c22SToby Isaac   Not Collective
4986c58f1c22SToby Isaac 
4987c58f1c22SToby Isaac   Input Parameters:
4988c58f1c22SToby Isaac + dm   - The DM object
4989c58f1c22SToby Isaac . name - The label name
4990c58f1c22SToby Isaac - point - The mesh point
4991c58f1c22SToby Isaac 
4992c58f1c22SToby Isaac   Output Parameter:
4993c58f1c22SToby Isaac . value - The label value for this point, or -1 if the point is not in the label
4994c58f1c22SToby Isaac 
4995c58f1c22SToby Isaac   Level: beginner
4996c58f1c22SToby Isaac 
4997c58f1c22SToby Isaac .keywords: mesh
4998c58f1c22SToby Isaac .seealso: DMLabelGetValue(), DMSetLabelValue(), DMGetStratumIS()
4999c58f1c22SToby Isaac @*/
5000c58f1c22SToby Isaac PetscErrorCode DMGetLabelValue(DM dm, const char name[], PetscInt point, PetscInt *value)
5001c58f1c22SToby Isaac {
5002c58f1c22SToby Isaac   DMLabel        label;
5003c58f1c22SToby Isaac   PetscErrorCode ierr;
5004c58f1c22SToby Isaac 
5005c58f1c22SToby Isaac   PetscFunctionBegin;
5006c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5007c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
5008c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
5009c58f1c22SToby Isaac   if (!label) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "No label named %s was found", name);CHKERRQ(ierr);
5010c58f1c22SToby Isaac   ierr = DMLabelGetValue(label, point, value);CHKERRQ(ierr);
5011c58f1c22SToby Isaac   PetscFunctionReturn(0);
5012c58f1c22SToby Isaac }
5013c58f1c22SToby Isaac 
5014c58f1c22SToby Isaac #undef __FUNCT__
5015c58f1c22SToby Isaac #define __FUNCT__ "DMSetLabelValue"
5016c58f1c22SToby Isaac /*@C
5017c58f1c22SToby Isaac   DMSetLabelValue - Add a point to a Sieve Label with given value
5018c58f1c22SToby Isaac 
5019c58f1c22SToby Isaac   Not Collective
5020c58f1c22SToby Isaac 
5021c58f1c22SToby Isaac   Input Parameters:
5022c58f1c22SToby Isaac + dm   - The DM object
5023c58f1c22SToby Isaac . name - The label name
5024c58f1c22SToby Isaac . point - The mesh point
5025c58f1c22SToby Isaac - value - The label value for this point
5026c58f1c22SToby Isaac 
5027c58f1c22SToby Isaac   Output Parameter:
5028c58f1c22SToby Isaac 
5029c58f1c22SToby Isaac   Level: beginner
5030c58f1c22SToby Isaac 
5031c58f1c22SToby Isaac .keywords: mesh
5032c58f1c22SToby Isaac .seealso: DMLabelSetValue(), DMGetStratumIS(), DMClearLabelValue()
5033c58f1c22SToby Isaac @*/
5034c58f1c22SToby Isaac PetscErrorCode DMSetLabelValue(DM dm, const char name[], PetscInt point, PetscInt value)
5035c58f1c22SToby Isaac {
5036c58f1c22SToby Isaac   DMLabel        label;
5037c58f1c22SToby Isaac   PetscErrorCode ierr;
5038c58f1c22SToby Isaac 
5039c58f1c22SToby Isaac   PetscFunctionBegin;
5040c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5041c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
5042c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
5043c58f1c22SToby Isaac   if (!label) {
5044c58f1c22SToby Isaac     ierr = DMCreateLabel(dm, name);CHKERRQ(ierr);
5045c58f1c22SToby Isaac     ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
5046c58f1c22SToby Isaac   }
5047c58f1c22SToby Isaac   ierr = DMLabelSetValue(label, point, value);CHKERRQ(ierr);
5048c58f1c22SToby Isaac   PetscFunctionReturn(0);
5049c58f1c22SToby Isaac }
5050c58f1c22SToby Isaac 
5051c58f1c22SToby Isaac #undef __FUNCT__
5052c58f1c22SToby Isaac #define __FUNCT__ "DMClearLabelValue"
5053c58f1c22SToby Isaac /*@C
5054c58f1c22SToby Isaac   DMClearLabelValue - Remove a point from a Sieve Label with given value
5055c58f1c22SToby Isaac 
5056c58f1c22SToby Isaac   Not Collective
5057c58f1c22SToby Isaac 
5058c58f1c22SToby Isaac   Input Parameters:
5059c58f1c22SToby Isaac + dm   - The DM object
5060c58f1c22SToby Isaac . name - The label name
5061c58f1c22SToby Isaac . point - The mesh point
5062c58f1c22SToby Isaac - value - The label value for this point
5063c58f1c22SToby Isaac 
5064c58f1c22SToby Isaac   Output Parameter:
5065c58f1c22SToby Isaac 
5066c58f1c22SToby Isaac   Level: beginner
5067c58f1c22SToby Isaac 
5068c58f1c22SToby Isaac .keywords: mesh
5069c58f1c22SToby Isaac .seealso: DMLabelClearValue(), DMSetLabelValue(), DMGetStratumIS()
5070c58f1c22SToby Isaac @*/
5071c58f1c22SToby Isaac PetscErrorCode DMClearLabelValue(DM dm, const char name[], PetscInt point, PetscInt value)
5072c58f1c22SToby Isaac {
5073c58f1c22SToby Isaac   DMLabel        label;
5074c58f1c22SToby Isaac   PetscErrorCode ierr;
5075c58f1c22SToby Isaac 
5076c58f1c22SToby Isaac   PetscFunctionBegin;
5077c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5078c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
5079c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
5080c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
5081c58f1c22SToby Isaac   ierr = DMLabelClearValue(label, point, value);CHKERRQ(ierr);
5082c58f1c22SToby Isaac   PetscFunctionReturn(0);
5083c58f1c22SToby Isaac }
5084c58f1c22SToby Isaac 
5085c58f1c22SToby Isaac #undef __FUNCT__
5086c58f1c22SToby Isaac #define __FUNCT__ "DMGetLabelSize"
5087c58f1c22SToby Isaac /*@C
5088c58f1c22SToby Isaac   DMGetLabelSize - Get the number of different integer ids in a Label
5089c58f1c22SToby Isaac 
5090c58f1c22SToby Isaac   Not Collective
5091c58f1c22SToby Isaac 
5092c58f1c22SToby Isaac   Input Parameters:
5093c58f1c22SToby Isaac + dm   - The DM object
5094c58f1c22SToby Isaac - name - The label name
5095c58f1c22SToby Isaac 
5096c58f1c22SToby Isaac   Output Parameter:
5097c58f1c22SToby Isaac . size - The number of different integer ids, or 0 if the label does not exist
5098c58f1c22SToby Isaac 
5099c58f1c22SToby Isaac   Level: beginner
5100c58f1c22SToby Isaac 
5101c58f1c22SToby Isaac .keywords: mesh
5102c58f1c22SToby Isaac .seealso: DMLabeGetNumValues(), DMSetLabelValue()
5103c58f1c22SToby Isaac @*/
5104c58f1c22SToby Isaac PetscErrorCode DMGetLabelSize(DM dm, const char name[], PetscInt *size)
5105c58f1c22SToby Isaac {
5106c58f1c22SToby Isaac   DMLabel        label;
5107c58f1c22SToby Isaac   PetscErrorCode ierr;
5108c58f1c22SToby Isaac 
5109c58f1c22SToby Isaac   PetscFunctionBegin;
5110c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5111c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
5112c58f1c22SToby Isaac   PetscValidPointer(size, 3);
5113c58f1c22SToby Isaac   ierr  = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
5114c58f1c22SToby Isaac   *size = 0;
5115c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
5116c58f1c22SToby Isaac   ierr = DMLabelGetNumValues(label, size);CHKERRQ(ierr);
5117c58f1c22SToby Isaac   PetscFunctionReturn(0);
5118c58f1c22SToby Isaac }
5119c58f1c22SToby Isaac 
5120c58f1c22SToby Isaac #undef __FUNCT__
5121c58f1c22SToby Isaac #define __FUNCT__ "DMGetLabelIdIS"
5122c58f1c22SToby Isaac /*@C
5123c58f1c22SToby Isaac   DMGetLabelIdIS - Get the integer ids in a label
5124c58f1c22SToby Isaac 
5125c58f1c22SToby Isaac   Not Collective
5126c58f1c22SToby Isaac 
5127c58f1c22SToby Isaac   Input Parameters:
5128c58f1c22SToby Isaac + mesh - The DM object
5129c58f1c22SToby Isaac - name - The label name
5130c58f1c22SToby Isaac 
5131c58f1c22SToby Isaac   Output Parameter:
5132c58f1c22SToby Isaac . ids - The integer ids, or NULL if the label does not exist
5133c58f1c22SToby Isaac 
5134c58f1c22SToby Isaac   Level: beginner
5135c58f1c22SToby Isaac 
5136c58f1c22SToby Isaac .keywords: mesh
5137c58f1c22SToby Isaac .seealso: DMLabelGetValueIS(), DMGetLabelSize()
5138c58f1c22SToby Isaac @*/
5139c58f1c22SToby Isaac PetscErrorCode DMGetLabelIdIS(DM dm, const char name[], IS *ids)
5140c58f1c22SToby Isaac {
5141c58f1c22SToby Isaac   DMLabel        label;
5142c58f1c22SToby Isaac   PetscErrorCode ierr;
5143c58f1c22SToby Isaac 
5144c58f1c22SToby Isaac   PetscFunctionBegin;
5145c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5146c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
5147c58f1c22SToby Isaac   PetscValidPointer(ids, 3);
5148c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
5149c58f1c22SToby Isaac   *ids = NULL;
5150c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
5151c58f1c22SToby Isaac   ierr = DMLabelGetValueIS(label, ids);CHKERRQ(ierr);
5152c58f1c22SToby Isaac   PetscFunctionReturn(0);
5153c58f1c22SToby Isaac }
5154c58f1c22SToby Isaac 
5155c58f1c22SToby Isaac #undef __FUNCT__
5156c58f1c22SToby Isaac #define __FUNCT__ "DMGetStratumSize"
5157c58f1c22SToby Isaac /*@C
5158c58f1c22SToby Isaac   DMGetStratumSize - Get the number of points in a label stratum
5159c58f1c22SToby Isaac 
5160c58f1c22SToby Isaac   Not Collective
5161c58f1c22SToby Isaac 
5162c58f1c22SToby Isaac   Input Parameters:
5163c58f1c22SToby Isaac + dm - The DM object
5164c58f1c22SToby Isaac . name - The label name
5165c58f1c22SToby Isaac - value - The stratum value
5166c58f1c22SToby Isaac 
5167c58f1c22SToby Isaac   Output Parameter:
5168c58f1c22SToby Isaac . size - The stratum size
5169c58f1c22SToby Isaac 
5170c58f1c22SToby Isaac   Level: beginner
5171c58f1c22SToby Isaac 
5172c58f1c22SToby Isaac .keywords: mesh
5173c58f1c22SToby Isaac .seealso: DMLabelGetStratumSize(), DMGetLabelSize(), DMGetLabelIds()
5174c58f1c22SToby Isaac @*/
5175c58f1c22SToby Isaac PetscErrorCode DMGetStratumSize(DM dm, const char name[], PetscInt value, PetscInt *size)
5176c58f1c22SToby Isaac {
5177c58f1c22SToby Isaac   DMLabel        label;
5178c58f1c22SToby Isaac   PetscErrorCode ierr;
5179c58f1c22SToby Isaac 
5180c58f1c22SToby Isaac   PetscFunctionBegin;
5181c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5182c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
5183c58f1c22SToby Isaac   PetscValidPointer(size, 4);
5184c58f1c22SToby Isaac   ierr  = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
5185c58f1c22SToby Isaac   *size = 0;
5186c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
5187c58f1c22SToby Isaac   ierr = DMLabelGetStratumSize(label, value, size);CHKERRQ(ierr);
5188c58f1c22SToby Isaac   PetscFunctionReturn(0);
5189c58f1c22SToby Isaac }
5190c58f1c22SToby Isaac 
5191c58f1c22SToby Isaac #undef __FUNCT__
5192c58f1c22SToby Isaac #define __FUNCT__ "DMGetStratumIS"
5193c58f1c22SToby Isaac /*@C
5194c58f1c22SToby Isaac   DMGetStratumIS - Get the points in a label stratum
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 - value - The stratum value
5202c58f1c22SToby Isaac 
5203c58f1c22SToby Isaac   Output Parameter:
5204c58f1c22SToby Isaac . points - The stratum points, or NULL if the label does not exist or does not have that value
5205c58f1c22SToby Isaac 
5206c58f1c22SToby Isaac   Level: beginner
5207c58f1c22SToby Isaac 
5208c58f1c22SToby Isaac .keywords: mesh
5209c58f1c22SToby Isaac .seealso: DMLabelGetStratumIS(), DMGetStratumSize()
5210c58f1c22SToby Isaac @*/
5211c58f1c22SToby Isaac PetscErrorCode DMGetStratumIS(DM dm, const char name[], PetscInt value, IS *points)
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   PetscValidPointer(points, 4);
5220c58f1c22SToby Isaac   ierr    = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
5221c58f1c22SToby Isaac   *points = NULL;
5222c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
5223c58f1c22SToby Isaac   ierr = DMLabelGetStratumIS(label, value, points);CHKERRQ(ierr);
5224c58f1c22SToby Isaac   PetscFunctionReturn(0);
5225c58f1c22SToby Isaac }
5226c58f1c22SToby Isaac 
5227c58f1c22SToby Isaac #undef __FUNCT__
5228c58f1c22SToby Isaac #define __FUNCT__ "DMClearLabelStratum"
5229c58f1c22SToby Isaac /*@C
5230c58f1c22SToby Isaac   DMClearLabelStratum - Remove all points from a stratum from a Sieve Label
5231c58f1c22SToby Isaac 
5232c58f1c22SToby Isaac   Not Collective
5233c58f1c22SToby Isaac 
5234c58f1c22SToby Isaac   Input Parameters:
5235c58f1c22SToby Isaac + dm   - The DM object
5236c58f1c22SToby Isaac . name - The label name
5237c58f1c22SToby Isaac - value - The label value for this point
5238c58f1c22SToby Isaac 
5239c58f1c22SToby Isaac   Output Parameter:
5240c58f1c22SToby Isaac 
5241c58f1c22SToby Isaac   Level: beginner
5242c58f1c22SToby Isaac 
5243c58f1c22SToby Isaac .keywords: mesh
5244c58f1c22SToby Isaac .seealso: DMLabelClearStratum(), DMSetLabelValue(), DMGetStratumIS(), DMClearLabelValue()
5245c58f1c22SToby Isaac @*/
5246c58f1c22SToby Isaac PetscErrorCode DMClearLabelStratum(DM dm, const char name[], PetscInt value)
5247c58f1c22SToby Isaac {
5248c58f1c22SToby Isaac   DMLabel        label;
5249c58f1c22SToby Isaac   PetscErrorCode ierr;
5250c58f1c22SToby Isaac 
5251c58f1c22SToby Isaac   PetscFunctionBegin;
5252c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5253c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
5254c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
5255c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
5256c58f1c22SToby Isaac   ierr = DMLabelClearStratum(label, value);CHKERRQ(ierr);
5257c58f1c22SToby Isaac   PetscFunctionReturn(0);
5258c58f1c22SToby Isaac }
5259c58f1c22SToby Isaac 
5260c58f1c22SToby Isaac #undef __FUNCT__
5261c58f1c22SToby Isaac #define __FUNCT__ "DMGetNumLabels"
5262c58f1c22SToby Isaac /*@
5263c58f1c22SToby Isaac   DMGetNumLabels - Return the number of labels defined by the mesh
5264c58f1c22SToby Isaac 
5265c58f1c22SToby Isaac   Not Collective
5266c58f1c22SToby Isaac 
5267c58f1c22SToby Isaac   Input Parameter:
5268c58f1c22SToby Isaac . dm   - The DM object
5269c58f1c22SToby Isaac 
5270c58f1c22SToby Isaac   Output Parameter:
5271c58f1c22SToby Isaac . numLabels - the number of Labels
5272c58f1c22SToby Isaac 
5273c58f1c22SToby Isaac   Level: intermediate
5274c58f1c22SToby Isaac 
5275c58f1c22SToby Isaac .keywords: mesh
5276c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
5277c58f1c22SToby Isaac @*/
5278c58f1c22SToby Isaac PetscErrorCode DMGetNumLabels(DM dm, PetscInt *numLabels)
5279c58f1c22SToby Isaac {
5280c58f1c22SToby Isaac   DMLabelLink next = dm->labels->next;
5281c58f1c22SToby Isaac   PetscInt  n    = 0;
5282c58f1c22SToby Isaac 
5283c58f1c22SToby Isaac   PetscFunctionBegin;
5284c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5285c58f1c22SToby Isaac   PetscValidPointer(numLabels, 2);
5286c58f1c22SToby Isaac   while (next) {++n; next = next->next;}
5287c58f1c22SToby Isaac   *numLabels = n;
5288c58f1c22SToby Isaac   PetscFunctionReturn(0);
5289c58f1c22SToby Isaac }
5290c58f1c22SToby Isaac 
5291c58f1c22SToby Isaac #undef __FUNCT__
5292c58f1c22SToby Isaac #define __FUNCT__ "DMGetLabelName"
5293c58f1c22SToby Isaac /*@C
5294c58f1c22SToby Isaac   DMGetLabelName - Return the name of nth label
5295c58f1c22SToby Isaac 
5296c58f1c22SToby Isaac   Not Collective
5297c58f1c22SToby Isaac 
5298c58f1c22SToby Isaac   Input Parameters:
5299c58f1c22SToby Isaac + dm - The DM object
5300c58f1c22SToby Isaac - n  - the label number
5301c58f1c22SToby Isaac 
5302c58f1c22SToby Isaac   Output Parameter:
5303c58f1c22SToby Isaac . name - the label name
5304c58f1c22SToby Isaac 
5305c58f1c22SToby Isaac   Level: intermediate
5306c58f1c22SToby Isaac 
5307c58f1c22SToby Isaac .keywords: mesh
5308c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
5309c58f1c22SToby Isaac @*/
5310c58f1c22SToby Isaac PetscErrorCode DMGetLabelName(DM dm, PetscInt n, const char **name)
5311c58f1c22SToby Isaac {
5312c58f1c22SToby Isaac   DMLabelLink next = dm->labels->next;
5313c58f1c22SToby Isaac   PetscInt  l    = 0;
5314c58f1c22SToby Isaac 
5315c58f1c22SToby Isaac   PetscFunctionBegin;
5316c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5317c58f1c22SToby Isaac   PetscValidPointer(name, 3);
5318c58f1c22SToby Isaac   while (next) {
5319c58f1c22SToby Isaac     if (l == n) {
5320c58f1c22SToby Isaac       *name = next->label->name;
5321c58f1c22SToby Isaac       PetscFunctionReturn(0);
5322c58f1c22SToby Isaac     }
5323c58f1c22SToby Isaac     ++l;
5324c58f1c22SToby Isaac     next = next->next;
5325c58f1c22SToby Isaac   }
5326c58f1c22SToby Isaac   SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %D does not exist in this DM", n);
5327c58f1c22SToby Isaac }
5328c58f1c22SToby Isaac 
5329c58f1c22SToby Isaac #undef __FUNCT__
5330c58f1c22SToby Isaac #define __FUNCT__ "DMHasLabel"
5331c58f1c22SToby Isaac /*@C
5332c58f1c22SToby Isaac   DMHasLabel - Determine whether the mesh has a label of a given name
5333c58f1c22SToby Isaac 
5334c58f1c22SToby Isaac   Not Collective
5335c58f1c22SToby Isaac 
5336c58f1c22SToby Isaac   Input Parameters:
5337c58f1c22SToby Isaac + dm   - The DM object
5338c58f1c22SToby Isaac - name - The label name
5339c58f1c22SToby Isaac 
5340c58f1c22SToby Isaac   Output Parameter:
5341c58f1c22SToby Isaac . hasLabel - PETSC_TRUE if the label is present
5342c58f1c22SToby Isaac 
5343c58f1c22SToby Isaac   Level: intermediate
5344c58f1c22SToby Isaac 
5345c58f1c22SToby Isaac .keywords: mesh
5346c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
5347c58f1c22SToby Isaac @*/
5348c58f1c22SToby Isaac PetscErrorCode DMHasLabel(DM dm, const char name[], PetscBool *hasLabel)
5349c58f1c22SToby Isaac {
5350c58f1c22SToby Isaac   DMLabelLink    next = dm->labels->next;
5351c58f1c22SToby Isaac   PetscErrorCode ierr;
5352c58f1c22SToby Isaac 
5353c58f1c22SToby Isaac   PetscFunctionBegin;
5354c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5355c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
5356c58f1c22SToby Isaac   PetscValidPointer(hasLabel, 3);
5357c58f1c22SToby Isaac   *hasLabel = PETSC_FALSE;
5358c58f1c22SToby Isaac   while (next) {
5359c58f1c22SToby Isaac     ierr = PetscStrcmp(name, next->label->name, hasLabel);CHKERRQ(ierr);
5360c58f1c22SToby Isaac     if (*hasLabel) break;
5361c58f1c22SToby Isaac     next = next->next;
5362c58f1c22SToby Isaac   }
5363c58f1c22SToby Isaac   PetscFunctionReturn(0);
5364c58f1c22SToby Isaac }
5365c58f1c22SToby Isaac 
5366c58f1c22SToby Isaac #undef __FUNCT__
5367c58f1c22SToby Isaac #define __FUNCT__ "DMGetLabel"
5368c58f1c22SToby Isaac /*@C
5369c58f1c22SToby Isaac   DMGetLabel - Return the label of a given name, or NULL
5370c58f1c22SToby Isaac 
5371c58f1c22SToby Isaac   Not Collective
5372c58f1c22SToby Isaac 
5373c58f1c22SToby Isaac   Input Parameters:
5374c58f1c22SToby Isaac + dm   - The DM object
5375c58f1c22SToby Isaac - name - The label name
5376c58f1c22SToby Isaac 
5377c58f1c22SToby Isaac   Output Parameter:
5378c58f1c22SToby Isaac . label - The DMLabel, or NULL if the label is absent
5379c58f1c22SToby Isaac 
5380c58f1c22SToby Isaac   Level: intermediate
5381c58f1c22SToby Isaac 
5382c58f1c22SToby Isaac .keywords: mesh
5383c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
5384c58f1c22SToby Isaac @*/
5385c58f1c22SToby Isaac PetscErrorCode DMGetLabel(DM dm, const char name[], DMLabel *label)
5386c58f1c22SToby Isaac {
5387c58f1c22SToby Isaac   DMLabelLink    next = dm->labels->next;
5388c58f1c22SToby Isaac   PetscBool      hasLabel;
5389c58f1c22SToby Isaac   PetscErrorCode ierr;
5390c58f1c22SToby Isaac 
5391c58f1c22SToby Isaac   PetscFunctionBegin;
5392c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5393c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
5394c58f1c22SToby Isaac   PetscValidPointer(label, 3);
5395c58f1c22SToby Isaac   *label = NULL;
5396c58f1c22SToby Isaac   while (next) {
5397c58f1c22SToby Isaac     ierr = PetscStrcmp(name, next->label->name, &hasLabel);CHKERRQ(ierr);
5398c58f1c22SToby Isaac     if (hasLabel) {
5399c58f1c22SToby Isaac       *label = next->label;
5400c58f1c22SToby Isaac       break;
5401c58f1c22SToby Isaac     }
5402c58f1c22SToby Isaac     next = next->next;
5403c58f1c22SToby Isaac   }
5404c58f1c22SToby Isaac   PetscFunctionReturn(0);
5405c58f1c22SToby Isaac }
5406c58f1c22SToby Isaac 
5407c58f1c22SToby Isaac #undef __FUNCT__
5408c58f1c22SToby Isaac #define __FUNCT__ "DMGetLabelByNum"
5409c58f1c22SToby Isaac /*@C
5410c58f1c22SToby Isaac   DMGetLabelByNum - Return the nth label
5411c58f1c22SToby Isaac 
5412c58f1c22SToby Isaac   Not Collective
5413c58f1c22SToby Isaac 
5414c58f1c22SToby Isaac   Input Parameters:
5415c58f1c22SToby Isaac + dm - The DM object
5416c58f1c22SToby Isaac - n  - the label number
5417c58f1c22SToby Isaac 
5418c58f1c22SToby Isaac   Output Parameter:
5419c58f1c22SToby Isaac . label - the label
5420c58f1c22SToby Isaac 
5421c58f1c22SToby Isaac   Level: intermediate
5422c58f1c22SToby Isaac 
5423c58f1c22SToby Isaac .keywords: mesh
5424c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
5425c58f1c22SToby Isaac @*/
5426c58f1c22SToby Isaac PetscErrorCode DMGetLabelByNum(DM dm, PetscInt n, DMLabel *label)
5427c58f1c22SToby Isaac {
5428c58f1c22SToby Isaac   DMLabelLink next = dm->labels->next;
5429c58f1c22SToby Isaac   PetscInt    l    = 0;
5430c58f1c22SToby Isaac 
5431c58f1c22SToby Isaac   PetscFunctionBegin;
5432c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5433c58f1c22SToby Isaac   PetscValidPointer(label, 3);
5434c58f1c22SToby Isaac   while (next) {
5435c58f1c22SToby Isaac     if (l == n) {
5436c58f1c22SToby Isaac       *label = next->label;
5437c58f1c22SToby Isaac       PetscFunctionReturn(0);
5438c58f1c22SToby Isaac     }
5439c58f1c22SToby Isaac     ++l;
5440c58f1c22SToby Isaac     next = next->next;
5441c58f1c22SToby Isaac   }
5442c58f1c22SToby Isaac   SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %D does not exist in this DM", n);
5443c58f1c22SToby Isaac }
5444c58f1c22SToby Isaac 
5445c58f1c22SToby Isaac #undef __FUNCT__
5446c58f1c22SToby Isaac #define __FUNCT__ "DMAddLabel"
5447c58f1c22SToby Isaac /*@C
5448c58f1c22SToby Isaac   DMAddLabel - Add the label to this mesh
5449c58f1c22SToby Isaac 
5450c58f1c22SToby Isaac   Not Collective
5451c58f1c22SToby Isaac 
5452c58f1c22SToby Isaac   Input Parameters:
5453c58f1c22SToby Isaac + dm   - The DM object
5454c58f1c22SToby Isaac - label - The DMLabel
5455c58f1c22SToby Isaac 
5456c58f1c22SToby Isaac   Level: developer
5457c58f1c22SToby Isaac 
5458c58f1c22SToby Isaac .keywords: mesh
5459c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
5460c58f1c22SToby Isaac @*/
5461c58f1c22SToby Isaac PetscErrorCode DMAddLabel(DM dm, DMLabel label)
5462c58f1c22SToby Isaac {
5463c58f1c22SToby Isaac   DMLabelLink    tmpLabel;
5464c58f1c22SToby Isaac   PetscBool      hasLabel;
5465c58f1c22SToby Isaac   PetscErrorCode ierr;
5466c58f1c22SToby Isaac 
5467c58f1c22SToby Isaac   PetscFunctionBegin;
5468c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5469c58f1c22SToby Isaac   ierr = DMHasLabel(dm, label->name, &hasLabel);CHKERRQ(ierr);
5470c58f1c22SToby Isaac   if (hasLabel) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %s already exists in this DM", label->name);
5471c58f1c22SToby Isaac   ierr = PetscCalloc1(1, &tmpLabel);CHKERRQ(ierr);
5472c58f1c22SToby Isaac   tmpLabel->label  = label;
5473c58f1c22SToby Isaac   tmpLabel->output = PETSC_TRUE;
5474c58f1c22SToby Isaac   tmpLabel->next   = dm->labels->next;
5475c58f1c22SToby Isaac   dm->labels->next = tmpLabel;
5476c58f1c22SToby Isaac   PetscFunctionReturn(0);
5477c58f1c22SToby Isaac }
5478c58f1c22SToby Isaac 
5479c58f1c22SToby Isaac #undef __FUNCT__
5480c58f1c22SToby Isaac #define __FUNCT__ "DMRemoveLabel"
5481c58f1c22SToby Isaac /*@C
5482c58f1c22SToby Isaac   DMRemoveLabel - Remove the label from this mesh
5483c58f1c22SToby Isaac 
5484c58f1c22SToby Isaac   Not Collective
5485c58f1c22SToby Isaac 
5486c58f1c22SToby Isaac   Input Parameters:
5487c58f1c22SToby Isaac + dm   - The DM object
5488c58f1c22SToby Isaac - name - The label name
5489c58f1c22SToby Isaac 
5490c58f1c22SToby Isaac   Output Parameter:
5491c58f1c22SToby Isaac . label - The DMLabel, or NULL if the label is absent
5492c58f1c22SToby Isaac 
5493c58f1c22SToby Isaac   Level: developer
5494c58f1c22SToby Isaac 
5495c58f1c22SToby Isaac .keywords: mesh
5496c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
5497c58f1c22SToby Isaac @*/
5498c58f1c22SToby Isaac PetscErrorCode DMRemoveLabel(DM dm, const char name[], DMLabel *label)
5499c58f1c22SToby Isaac {
5500c58f1c22SToby Isaac   DMLabelLink    next = dm->labels->next;
5501c58f1c22SToby Isaac   DMLabelLink    last = NULL;
5502c58f1c22SToby Isaac   PetscBool      hasLabel;
5503c58f1c22SToby Isaac   PetscErrorCode ierr;
5504c58f1c22SToby Isaac 
5505c58f1c22SToby Isaac   PetscFunctionBegin;
5506c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5507c58f1c22SToby Isaac   ierr   = DMHasLabel(dm, name, &hasLabel);CHKERRQ(ierr);
5508c58f1c22SToby Isaac   *label = NULL;
5509c58f1c22SToby Isaac   if (!hasLabel) PetscFunctionReturn(0);
5510c58f1c22SToby Isaac   while (next) {
5511c58f1c22SToby Isaac     ierr = PetscStrcmp(name, next->label->name, &hasLabel);CHKERRQ(ierr);
5512c58f1c22SToby Isaac     if (hasLabel) {
5513c58f1c22SToby Isaac       if (last) last->next       = next->next;
5514c58f1c22SToby Isaac       else      dm->labels->next = next->next;
5515c58f1c22SToby Isaac       next->next = NULL;
5516c58f1c22SToby Isaac       *label     = next->label;
5517c58f1c22SToby Isaac       ierr = PetscStrcmp(name, "depth", &hasLabel);CHKERRQ(ierr);
5518c58f1c22SToby Isaac       if (hasLabel) {
5519c58f1c22SToby Isaac         dm->depthLabel = NULL;
5520c58f1c22SToby Isaac       }
5521c58f1c22SToby Isaac       ierr = PetscFree(next);CHKERRQ(ierr);
5522c58f1c22SToby Isaac       break;
5523c58f1c22SToby Isaac     }
5524c58f1c22SToby Isaac     last = next;
5525c58f1c22SToby Isaac     next = next->next;
5526c58f1c22SToby Isaac   }
5527c58f1c22SToby Isaac   PetscFunctionReturn(0);
5528c58f1c22SToby Isaac }
5529c58f1c22SToby Isaac 
5530c58f1c22SToby Isaac #undef __FUNCT__
5531c58f1c22SToby Isaac #define __FUNCT__ "DMGetLabelOutput"
5532c58f1c22SToby Isaac /*@C
5533c58f1c22SToby Isaac   DMGetLabelOutput - Get the output flag for a given label
5534c58f1c22SToby Isaac 
5535c58f1c22SToby Isaac   Not Collective
5536c58f1c22SToby Isaac 
5537c58f1c22SToby Isaac   Input Parameters:
5538c58f1c22SToby Isaac + dm   - The DM object
5539c58f1c22SToby Isaac - name - The label name
5540c58f1c22SToby Isaac 
5541c58f1c22SToby Isaac   Output Parameter:
5542c58f1c22SToby Isaac . output - The flag for output
5543c58f1c22SToby Isaac 
5544c58f1c22SToby Isaac   Level: developer
5545c58f1c22SToby Isaac 
5546c58f1c22SToby Isaac .keywords: mesh
5547c58f1c22SToby Isaac .seealso: DMSetLabelOutput(), DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
5548c58f1c22SToby Isaac @*/
5549c58f1c22SToby Isaac PetscErrorCode DMGetLabelOutput(DM dm, const char name[], PetscBool *output)
5550c58f1c22SToby Isaac {
5551c58f1c22SToby Isaac   DMLabelLink    next = dm->labels->next;
5552c58f1c22SToby Isaac   PetscErrorCode ierr;
5553c58f1c22SToby Isaac 
5554c58f1c22SToby Isaac   PetscFunctionBegin;
5555c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5556c58f1c22SToby Isaac   PetscValidPointer(name, 2);
5557c58f1c22SToby Isaac   PetscValidPointer(output, 3);
5558c58f1c22SToby Isaac   while (next) {
5559c58f1c22SToby Isaac     PetscBool flg;
5560c58f1c22SToby Isaac 
5561c58f1c22SToby Isaac     ierr = PetscStrcmp(name, next->label->name, &flg);CHKERRQ(ierr);
5562c58f1c22SToby Isaac     if (flg) {*output = next->output; PetscFunctionReturn(0);}
5563c58f1c22SToby Isaac     next = next->next;
5564c58f1c22SToby Isaac   }
5565c58f1c22SToby Isaac   SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "No label named %s was present in this dm", name);
5566c58f1c22SToby Isaac }
5567c58f1c22SToby Isaac 
5568c58f1c22SToby Isaac #undef __FUNCT__
5569c58f1c22SToby Isaac #define __FUNCT__ "DMSetLabelOutput"
5570c58f1c22SToby Isaac /*@C
5571c58f1c22SToby Isaac   DMSetLabelOutput - Set the output flag for a given label
5572c58f1c22SToby Isaac 
5573c58f1c22SToby Isaac   Not Collective
5574c58f1c22SToby Isaac 
5575c58f1c22SToby Isaac   Input Parameters:
5576c58f1c22SToby Isaac + dm     - The DM object
5577c58f1c22SToby Isaac . name   - The label name
5578c58f1c22SToby Isaac - output - The flag for output
5579c58f1c22SToby Isaac 
5580c58f1c22SToby Isaac   Level: developer
5581c58f1c22SToby Isaac 
5582c58f1c22SToby Isaac .keywords: mesh
5583c58f1c22SToby Isaac .seealso: DMGetLabelOutput(), DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
5584c58f1c22SToby Isaac @*/
5585c58f1c22SToby Isaac PetscErrorCode DMSetLabelOutput(DM dm, const char name[], PetscBool output)
5586c58f1c22SToby Isaac {
5587c58f1c22SToby Isaac   DMLabelLink    next = dm->labels->next;
5588c58f1c22SToby Isaac   PetscErrorCode ierr;
5589c58f1c22SToby Isaac 
5590c58f1c22SToby Isaac   PetscFunctionBegin;
5591c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5592c58f1c22SToby Isaac   PetscValidPointer(name, 2);
5593c58f1c22SToby Isaac   while (next) {
5594c58f1c22SToby Isaac     PetscBool flg;
5595c58f1c22SToby Isaac 
5596c58f1c22SToby Isaac     ierr = PetscStrcmp(name, next->label->name, &flg);CHKERRQ(ierr);
5597c58f1c22SToby Isaac     if (flg) {next->output = output; PetscFunctionReturn(0);}
5598c58f1c22SToby Isaac     next = next->next;
5599c58f1c22SToby Isaac   }
5600c58f1c22SToby Isaac   SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "No label named %s was present in this dm", name);
5601c58f1c22SToby Isaac }
5602c58f1c22SToby Isaac 
5603c58f1c22SToby Isaac 
5604c58f1c22SToby Isaac #undef __FUNCT__
5605c58f1c22SToby Isaac #define __FUNCT__ "DMCopyLabels"
5606c58f1c22SToby Isaac /*@
5607c58f1c22SToby Isaac   DMCopyLabels - Copy labels from one mesh to another with a superset of the points
5608c58f1c22SToby Isaac 
5609c58f1c22SToby Isaac   Collective on DM
5610c58f1c22SToby Isaac 
5611c58f1c22SToby Isaac   Input Parameter:
56122e17dfb7SMatthew G. Knepley . dmA - The DM object with initial labels
5613c58f1c22SToby Isaac 
5614c58f1c22SToby Isaac   Output Parameter:
56152e17dfb7SMatthew G. Knepley . dmB - The DM object with copied labels
5616c58f1c22SToby Isaac 
5617c58f1c22SToby Isaac   Level: intermediate
5618c58f1c22SToby Isaac 
5619c58f1c22SToby Isaac   Note: This is typically used when interpolating or otherwise adding to a mesh
5620c58f1c22SToby Isaac 
5621c58f1c22SToby Isaac .keywords: mesh
5622c58f1c22SToby Isaac .seealso: DMCopyCoordinates(), DMGetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM(), DMGetCoordinateSection()
5623c58f1c22SToby Isaac @*/
5624c58f1c22SToby Isaac PetscErrorCode DMCopyLabels(DM dmA, DM dmB)
5625c58f1c22SToby Isaac {
5626c58f1c22SToby Isaac   PetscInt       numLabels, l;
5627c58f1c22SToby Isaac   PetscErrorCode ierr;
5628c58f1c22SToby Isaac 
5629c58f1c22SToby Isaac   PetscFunctionBegin;
5630c58f1c22SToby Isaac   if (dmA == dmB) PetscFunctionReturn(0);
5631c58f1c22SToby Isaac   ierr = DMGetNumLabels(dmA, &numLabels);CHKERRQ(ierr);
5632c58f1c22SToby Isaac   for (l = 0; l < numLabels; ++l) {
5633c58f1c22SToby Isaac     DMLabel     label, labelNew;
5634c58f1c22SToby Isaac     const char *name;
5635c58f1c22SToby Isaac     PetscBool   flg;
5636c58f1c22SToby Isaac 
5637c58f1c22SToby Isaac     ierr = DMGetLabelName(dmA, l, &name);CHKERRQ(ierr);
5638c58f1c22SToby Isaac     ierr = PetscStrcmp(name, "depth", &flg);CHKERRQ(ierr);
5639c58f1c22SToby Isaac     if (flg) continue;
5640c58f1c22SToby Isaac     ierr = DMGetLabel(dmA, name, &label);CHKERRQ(ierr);
5641c58f1c22SToby Isaac     ierr = DMLabelDuplicate(label, &labelNew);CHKERRQ(ierr);
5642c58f1c22SToby Isaac     ierr = DMAddLabel(dmB, labelNew);CHKERRQ(ierr);
5643c58f1c22SToby Isaac   }
5644c58f1c22SToby Isaac   PetscFunctionReturn(0);
5645c58f1c22SToby Isaac }
5646a8fb8f29SToby Isaac 
5647a8fb8f29SToby Isaac #undef __FUNCT__
5648a8fb8f29SToby Isaac #define __FUNCT__ "DMGetCoarseDM"
5649a8fb8f29SToby Isaac /*@
5650a8fb8f29SToby Isaac   DMGetCoarseDM - Get the coarse mesh from which this was obtained by refinement
5651a8fb8f29SToby Isaac 
5652a8fb8f29SToby Isaac   Input Parameter:
5653a8fb8f29SToby Isaac . dm - The DM object
5654a8fb8f29SToby Isaac 
5655a8fb8f29SToby Isaac   Output Parameter:
5656a8fb8f29SToby Isaac . cdm - The coarse DM
5657a8fb8f29SToby Isaac 
5658a8fb8f29SToby Isaac   Level: intermediate
5659a8fb8f29SToby Isaac 
5660a8fb8f29SToby Isaac .seealso: DMSetCoarseDM()
5661a8fb8f29SToby Isaac @*/
5662a8fb8f29SToby Isaac PetscErrorCode DMGetCoarseDM(DM dm, DM *cdm)
5663a8fb8f29SToby Isaac {
5664a8fb8f29SToby Isaac   PetscFunctionBegin;
5665a8fb8f29SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5666a8fb8f29SToby Isaac   PetscValidPointer(cdm, 2);
5667a8fb8f29SToby Isaac   *cdm = dm->coarseMesh;
5668a8fb8f29SToby Isaac   PetscFunctionReturn(0);
5669a8fb8f29SToby Isaac }
5670a8fb8f29SToby Isaac 
5671a8fb8f29SToby Isaac #undef __FUNCT__
5672a8fb8f29SToby Isaac #define __FUNCT__ "DMSetCoarseDM"
5673a8fb8f29SToby Isaac /*@
5674a8fb8f29SToby Isaac   DMSetCoarseDM - Set the coarse mesh from which this was obtained by refinement
5675a8fb8f29SToby Isaac 
5676a8fb8f29SToby Isaac   Input Parameters:
5677a8fb8f29SToby Isaac + dm - The DM object
5678a8fb8f29SToby Isaac - cdm - The coarse DM
5679a8fb8f29SToby Isaac 
5680a8fb8f29SToby Isaac   Level: intermediate
5681a8fb8f29SToby Isaac 
5682a8fb8f29SToby Isaac .seealso: DMGetCoarseDM()
5683a8fb8f29SToby Isaac @*/
5684a8fb8f29SToby Isaac PetscErrorCode DMSetCoarseDM(DM dm, DM cdm)
5685a8fb8f29SToby Isaac {
5686a8fb8f29SToby Isaac   PetscErrorCode ierr;
5687a8fb8f29SToby Isaac 
5688a8fb8f29SToby Isaac   PetscFunctionBegin;
5689a8fb8f29SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5690a8fb8f29SToby Isaac   if (cdm) PetscValidHeaderSpecific(cdm, DM_CLASSID, 2);
5691a8fb8f29SToby Isaac   ierr = PetscObjectReference((PetscObject)cdm);CHKERRQ(ierr);
5692a8fb8f29SToby Isaac   ierr = DMDestroy(&dm->coarseMesh);CHKERRQ(ierr);
5693a8fb8f29SToby Isaac   dm->coarseMesh = cdm;
5694a8fb8f29SToby Isaac   PetscFunctionReturn(0);
5695a8fb8f29SToby Isaac }
5696a8fb8f29SToby Isaac 
569788bdff64SToby Isaac #undef __FUNCT__
569888bdff64SToby Isaac #define __FUNCT__ "DMGetFineDM"
569988bdff64SToby Isaac /*@
570088bdff64SToby Isaac   DMGetFineDM - Get the fine mesh from which this was obtained by refinement
570188bdff64SToby Isaac 
570288bdff64SToby Isaac   Input Parameter:
570388bdff64SToby Isaac . dm - The DM object
570488bdff64SToby Isaac 
570588bdff64SToby Isaac   Output Parameter:
570688bdff64SToby Isaac . fdm - The fine DM
570788bdff64SToby Isaac 
570888bdff64SToby Isaac   Level: intermediate
570988bdff64SToby Isaac 
571088bdff64SToby Isaac .seealso: DMSetFineDM()
571188bdff64SToby Isaac @*/
571288bdff64SToby Isaac PetscErrorCode DMGetFineDM(DM dm, DM *fdm)
571388bdff64SToby Isaac {
571488bdff64SToby Isaac   PetscFunctionBegin;
571588bdff64SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
571688bdff64SToby Isaac   PetscValidPointer(fdm, 2);
571788bdff64SToby Isaac   *fdm = dm->fineMesh;
571888bdff64SToby Isaac   PetscFunctionReturn(0);
571988bdff64SToby Isaac }
572088bdff64SToby Isaac 
572188bdff64SToby Isaac #undef __FUNCT__
572288bdff64SToby Isaac #define __FUNCT__ "DMSetFineDM"
572388bdff64SToby Isaac /*@
572488bdff64SToby Isaac   DMSetFineDM - Set the fine mesh from which this was obtained by refinement
572588bdff64SToby Isaac 
572688bdff64SToby Isaac   Input Parameters:
572788bdff64SToby Isaac + dm - The DM object
572888bdff64SToby Isaac - fdm - The fine DM
572988bdff64SToby Isaac 
573088bdff64SToby Isaac   Level: intermediate
573188bdff64SToby Isaac 
573288bdff64SToby Isaac .seealso: DMGetFineDM()
573388bdff64SToby Isaac @*/
573488bdff64SToby Isaac PetscErrorCode DMSetFineDM(DM dm, DM fdm)
573588bdff64SToby Isaac {
573688bdff64SToby Isaac   PetscErrorCode ierr;
573788bdff64SToby Isaac 
573888bdff64SToby Isaac   PetscFunctionBegin;
573988bdff64SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
574088bdff64SToby Isaac   if (fdm) PetscValidHeaderSpecific(fdm, DM_CLASSID, 2);
574188bdff64SToby Isaac   ierr = PetscObjectReference((PetscObject)fdm);CHKERRQ(ierr);
574288bdff64SToby Isaac   ierr = DMDestroy(&dm->fineMesh);CHKERRQ(ierr);
574388bdff64SToby Isaac   dm->fineMesh = fdm;
574488bdff64SToby Isaac   PetscFunctionReturn(0);
574588bdff64SToby Isaac }
574688bdff64SToby Isaac 
5747a6ba4734SToby Isaac /*=== DMBoundary code ===*/
5748a6ba4734SToby Isaac 
5749a6ba4734SToby Isaac #undef __FUNCT__
5750bcc5ffd9SToby Isaac #define __FUNCT__ "DMBoundaryDuplicate"
5751354557abSToby Isaac PetscErrorCode DMBoundaryDuplicate(DMBoundaryLinkList bd, DMBoundaryLinkList *boundary)
5752a6ba4734SToby Isaac {
5753bcc5ffd9SToby Isaac   DMBoundary     b = bd->next, b2, bold = NULL;
5754a6ba4734SToby Isaac   PetscErrorCode ierr;
5755a6ba4734SToby Isaac 
5756a6ba4734SToby Isaac   PetscFunctionBegin;
5757bcc5ffd9SToby Isaac   ierr = PetscNew(boundary);CHKERRQ(ierr);
5758bcc5ffd9SToby Isaac   (*boundary)->refct = 1;
5759bcc5ffd9SToby Isaac   (*boundary)->next = NULL;
5760a6ba4734SToby Isaac   for (; b; b = b->next, bold = b2) {
5761a6ba4734SToby Isaac     ierr = PetscNew(&b2);CHKERRQ(ierr);
5762a6ba4734SToby Isaac     ierr = PetscStrallocpy(b->name, (char **) &b2->name);CHKERRQ(ierr);
5763a6ba4734SToby Isaac     ierr = PetscStrallocpy(b->labelname, (char **) &b2->labelname);CHKERRQ(ierr);
5764a6ba4734SToby Isaac     ierr = PetscMalloc1(b->numids, &b2->ids);CHKERRQ(ierr);
5765a6ba4734SToby Isaac     ierr = PetscMemcpy(b2->ids, b->ids, b->numids*sizeof(PetscInt));CHKERRQ(ierr);
5766a6ba4734SToby Isaac     ierr = PetscMalloc1(b->numcomps, &b2->comps);CHKERRQ(ierr);
5767a6ba4734SToby Isaac     ierr = PetscMemcpy(b2->comps, b->comps, b->numcomps*sizeof(PetscInt));CHKERRQ(ierr);
5768a6ba4734SToby Isaac     b2->label     = NULL;
5769a6ba4734SToby Isaac     b2->essential = b->essential;
5770a6ba4734SToby Isaac     b2->field     = b->field;
5771a6ba4734SToby Isaac     b2->numcomps  = b->numcomps;
5772a6ba4734SToby Isaac     b2->func      = b->func;
5773a6ba4734SToby Isaac     b2->numids    = b->numids;
5774a6ba4734SToby Isaac     b2->ctx       = b->ctx;
5775a6ba4734SToby Isaac     b2->next      = NULL;
5776bcc5ffd9SToby Isaac     if (!(*boundary)->next) (*boundary)->next   = b2;
5777a6ba4734SToby Isaac     if (bold)        bold->next = b2;
5778a6ba4734SToby Isaac   }
5779a6ba4734SToby Isaac   PetscFunctionReturn(0);
5780a6ba4734SToby Isaac }
5781a6ba4734SToby Isaac 
5782a6ba4734SToby Isaac #undef __FUNCT__
5783bcc5ffd9SToby Isaac #define __FUNCT__ "DMBoundaryDestroy"
5784bcc5ffd9SToby Isaac PetscErrorCode DMBoundaryDestroy(DMBoundaryLinkList *boundary)
5785a6ba4734SToby Isaac {
5786a6ba4734SToby Isaac   DMBoundary     b, next;
5787a6ba4734SToby Isaac   PetscErrorCode ierr;
5788a6ba4734SToby Isaac 
5789a6ba4734SToby Isaac   PetscFunctionBegin;
5790a6ba4734SToby Isaac   if (!boundary) PetscFunctionReturn(0);
5791bcc5ffd9SToby Isaac   if (--((*boundary)->refct)) {
5792a6ba4734SToby Isaac     *boundary = NULL;
5793bcc5ffd9SToby Isaac     PetscFunctionReturn(0);
5794bcc5ffd9SToby Isaac   }
5795bcc5ffd9SToby Isaac   b = (*boundary)->next;
5796a6ba4734SToby Isaac   for (; b; b = next) {
5797a6ba4734SToby Isaac     next = b->next;
5798a6ba4734SToby Isaac     ierr = PetscFree(b->comps);CHKERRQ(ierr);
5799a6ba4734SToby Isaac     ierr = PetscFree(b->ids);CHKERRQ(ierr);
5800a6ba4734SToby Isaac     ierr = PetscFree(b->name);CHKERRQ(ierr);
5801a6ba4734SToby Isaac     ierr = PetscFree(b->labelname);CHKERRQ(ierr);
5802a6ba4734SToby Isaac     ierr = PetscFree(b);CHKERRQ(ierr);
5803a6ba4734SToby Isaac   }
5804bcc5ffd9SToby Isaac   ierr = PetscFree(*boundary);CHKERRQ(ierr);
5805a6ba4734SToby Isaac   PetscFunctionReturn(0);
5806a6ba4734SToby Isaac }
5807a6ba4734SToby Isaac 
5808a6ba4734SToby Isaac #undef __FUNCT__
5809a6ba4734SToby Isaac #define __FUNCT__ "DMCopyBoundary"
5810a6ba4734SToby Isaac PetscErrorCode DMCopyBoundary(DM dm, DM dmNew)
5811a6ba4734SToby Isaac {
5812a6ba4734SToby Isaac   DMBoundary     b;
5813a6ba4734SToby Isaac   PetscErrorCode ierr;
5814a6ba4734SToby Isaac 
5815a6ba4734SToby Isaac   PetscFunctionBegin;
5816bcc5ffd9SToby Isaac   ierr = DMBoundaryDestroy(&dmNew->boundary);CHKERRQ(ierr);
5817bcc5ffd9SToby Isaac   ierr = DMBoundaryDuplicate(dm->boundary, &dmNew->boundary);CHKERRQ(ierr);
5818bcc5ffd9SToby Isaac   for (b = dmNew->boundary->next; b; b = b->next) {
5819a6ba4734SToby Isaac     if (b->labelname) {
5820a6ba4734SToby Isaac       ierr = DMGetLabel(dmNew, b->labelname, &b->label);CHKERRQ(ierr);
5821a6ba4734SToby Isaac       if (!b->label) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Label %s does not exist in this DM", b->labelname);
5822a6ba4734SToby Isaac     }
5823a6ba4734SToby Isaac   }
5824a6ba4734SToby Isaac   PetscFunctionReturn(0);
5825a6ba4734SToby Isaac }
5826a6ba4734SToby Isaac 
5827a6ba4734SToby Isaac #undef __FUNCT__
5828a6ba4734SToby Isaac #define __FUNCT__ "DMAddBoundary"
5829a6ba4734SToby Isaac /*@C
5830a6ba4734SToby Isaac   DMAddBoundary - Add a boundary condition to the model
5831a6ba4734SToby Isaac 
5832a6ba4734SToby Isaac   Input Parameters:
5833a6ba4734SToby Isaac + dm          - The mesh object
5834a6ba4734SToby Isaac . isEssential - Flag for an essential (Dirichlet) condition, as opposed to a natural (Neumann) condition
5835a6ba4734SToby Isaac . name        - The BC name
5836a6ba4734SToby Isaac . labelname   - The label defining constrained points
5837a6ba4734SToby Isaac . field       - The field to constrain
5838a6ba4734SToby Isaac . numcomps    - The number of constrained field components
5839a6ba4734SToby Isaac . comps       - An array of constrained component numbers
5840a6ba4734SToby Isaac . bcFunc      - A pointwise function giving boundary values
5841a6ba4734SToby Isaac . numids      - The number of DMLabel ids for constrained points
5842a6ba4734SToby Isaac . ids         - An array of ids for constrained points
5843a6ba4734SToby Isaac - ctx         - An optional user context for bcFunc
5844a6ba4734SToby Isaac 
5845a6ba4734SToby Isaac   Options Database Keys:
5846a6ba4734SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids
5847a6ba4734SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components
5848a6ba4734SToby Isaac 
5849a6ba4734SToby Isaac   Level: developer
5850a6ba4734SToby Isaac 
5851a6ba4734SToby Isaac .seealso: DMGetBoundary()
5852a6ba4734SToby Isaac @*/
5853a6ba4734SToby 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)
5854a6ba4734SToby Isaac {
5855a6ba4734SToby Isaac   DMBoundary     b;
5856a6ba4734SToby Isaac   PetscErrorCode ierr;
5857a6ba4734SToby Isaac 
5858a6ba4734SToby Isaac   PetscFunctionBegin;
5859a6ba4734SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5860a6ba4734SToby Isaac   ierr = PetscNew(&b);CHKERRQ(ierr);
5861a6ba4734SToby Isaac   ierr = PetscStrallocpy(name, (char **) &b->name);CHKERRQ(ierr);
5862a6ba4734SToby Isaac   ierr = PetscStrallocpy(labelname, (char **) &b->labelname);CHKERRQ(ierr);
5863a6ba4734SToby Isaac   ierr = PetscMalloc1(numcomps, &b->comps);CHKERRQ(ierr);
5864a6ba4734SToby Isaac   if (numcomps) {ierr = PetscMemcpy(b->comps, comps, numcomps*sizeof(PetscInt));CHKERRQ(ierr);}
5865a6ba4734SToby Isaac   ierr = PetscMalloc1(numids, &b->ids);CHKERRQ(ierr);
5866a6ba4734SToby Isaac   if (numids) {ierr = PetscMemcpy(b->ids, ids, numids*sizeof(PetscInt));CHKERRQ(ierr);}
5867a6ba4734SToby Isaac   if (b->labelname) {
5868a6ba4734SToby Isaac     ierr = DMGetLabel(dm, b->labelname, &b->label);CHKERRQ(ierr);
5869a6ba4734SToby Isaac     if (!b->label) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Label %s does not exist in this DM", b->labelname);
5870a6ba4734SToby Isaac   }
5871a6ba4734SToby Isaac   b->essential       = isEssential;
5872a6ba4734SToby Isaac   b->field           = field;
5873a6ba4734SToby Isaac   b->numcomps        = numcomps;
5874a6ba4734SToby Isaac   b->func            = bcFunc;
5875a6ba4734SToby Isaac   b->numids          = numids;
5876a6ba4734SToby Isaac   b->ctx             = ctx;
5877bcc5ffd9SToby Isaac   b->next            = dm->boundary->next;
5878bcc5ffd9SToby Isaac   dm->boundary->next = b;
5879a6ba4734SToby Isaac   PetscFunctionReturn(0);
5880a6ba4734SToby Isaac }
5881a6ba4734SToby Isaac 
5882a6ba4734SToby Isaac #undef __FUNCT__
5883a6ba4734SToby Isaac #define __FUNCT__ "DMGetNumBoundary"
5884a6ba4734SToby Isaac /*@
5885a6ba4734SToby Isaac   DMGetNumBoundary - Get the number of registered BC
5886a6ba4734SToby Isaac 
5887a6ba4734SToby Isaac   Input Parameters:
5888a6ba4734SToby Isaac . dm - The mesh object
5889a6ba4734SToby Isaac 
5890a6ba4734SToby Isaac   Output Parameters:
5891a6ba4734SToby Isaac . numBd - The number of BC
5892a6ba4734SToby Isaac 
5893a6ba4734SToby Isaac   Level: intermediate
5894a6ba4734SToby Isaac 
5895a6ba4734SToby Isaac .seealso: DMAddBoundary(), DMGetBoundary()
5896a6ba4734SToby Isaac @*/
5897a6ba4734SToby Isaac PetscErrorCode DMGetNumBoundary(DM dm, PetscInt *numBd)
5898a6ba4734SToby Isaac {
5899bcc5ffd9SToby Isaac   DMBoundary b = dm->boundary->next;
5900a6ba4734SToby Isaac 
5901a6ba4734SToby Isaac   PetscFunctionBegin;
5902a6ba4734SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5903a6ba4734SToby Isaac   PetscValidPointer(numBd, 2);
5904a6ba4734SToby Isaac   *numBd = 0;
5905a6ba4734SToby Isaac   while (b) {++(*numBd); b = b->next;}
5906a6ba4734SToby Isaac   PetscFunctionReturn(0);
5907a6ba4734SToby Isaac }
5908a6ba4734SToby Isaac 
5909a6ba4734SToby Isaac #undef __FUNCT__
5910a6ba4734SToby Isaac #define __FUNCT__ "DMGetBoundary"
5911a6ba4734SToby Isaac /*@C
5912a6ba4734SToby Isaac   DMGetBoundary - Add a boundary condition to the model
5913a6ba4734SToby Isaac 
5914a6ba4734SToby Isaac   Input Parameters:
5915a6ba4734SToby Isaac + dm          - The mesh object
5916a6ba4734SToby Isaac - bd          - The BC number
5917a6ba4734SToby Isaac 
5918a6ba4734SToby Isaac   Output Parameters:
5919a6ba4734SToby Isaac + isEssential - Flag for an essential (Dirichlet) condition, as opposed to a natural (Neumann) condition
5920a6ba4734SToby Isaac . name        - The BC name
5921a6ba4734SToby Isaac . labelname   - The label defining constrained points
5922a6ba4734SToby Isaac . field       - The field to constrain
5923a6ba4734SToby Isaac . numcomps    - The number of constrained field components
5924a6ba4734SToby Isaac . comps       - An array of constrained component numbers
5925a6ba4734SToby Isaac . bcFunc      - A pointwise function giving boundary values
5926a6ba4734SToby Isaac . numids      - The number of DMLabel ids for constrained points
5927a6ba4734SToby Isaac . ids         - An array of ids for constrained points
5928a6ba4734SToby Isaac - ctx         - An optional user context for bcFunc
5929a6ba4734SToby Isaac 
5930a6ba4734SToby Isaac   Options Database Keys:
5931a6ba4734SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids
5932a6ba4734SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components
5933a6ba4734SToby Isaac 
5934a6ba4734SToby Isaac   Level: developer
5935a6ba4734SToby Isaac 
5936a6ba4734SToby Isaac .seealso: DMAddBoundary()
5937a6ba4734SToby Isaac @*/
5938a6ba4734SToby 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)
5939a6ba4734SToby Isaac {
5940bcc5ffd9SToby Isaac   DMBoundary b    = dm->boundary->next;
5941a6ba4734SToby Isaac   PetscInt   n    = 0;
5942a6ba4734SToby Isaac 
5943a6ba4734SToby Isaac   PetscFunctionBegin;
5944a6ba4734SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5945a6ba4734SToby Isaac   while (b) {
5946a6ba4734SToby Isaac     if (n == bd) break;
5947a6ba4734SToby Isaac     b = b->next;
5948a6ba4734SToby Isaac     ++n;
5949a6ba4734SToby Isaac   }
5950a6ba4734SToby Isaac   if (n != bd) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Boundary %d is not in [0, %d)", bd, n);
5951a6ba4734SToby Isaac   if (isEssential) {
5952a6ba4734SToby Isaac     PetscValidPointer(isEssential, 3);
5953a6ba4734SToby Isaac     *isEssential = b->essential;
5954a6ba4734SToby Isaac   }
5955a6ba4734SToby Isaac   if (name) {
5956a6ba4734SToby Isaac     PetscValidPointer(name, 4);
5957a6ba4734SToby Isaac     *name = b->name;
5958a6ba4734SToby Isaac   }
5959a6ba4734SToby Isaac   if (labelname) {
5960a6ba4734SToby Isaac     PetscValidPointer(labelname, 5);
5961a6ba4734SToby Isaac     *labelname = b->labelname;
5962a6ba4734SToby Isaac   }
5963a6ba4734SToby Isaac   if (field) {
5964a6ba4734SToby Isaac     PetscValidPointer(field, 6);
5965a6ba4734SToby Isaac     *field = b->field;
5966a6ba4734SToby Isaac   }
5967a6ba4734SToby Isaac   if (numcomps) {
5968a6ba4734SToby Isaac     PetscValidPointer(numcomps, 7);
5969a6ba4734SToby Isaac     *numcomps = b->numcomps;
5970a6ba4734SToby Isaac   }
5971a6ba4734SToby Isaac   if (comps) {
5972a6ba4734SToby Isaac     PetscValidPointer(comps, 8);
5973a6ba4734SToby Isaac     *comps = b->comps;
5974a6ba4734SToby Isaac   }
5975a6ba4734SToby Isaac   if (func) {
5976a6ba4734SToby Isaac     PetscValidPointer(func, 9);
5977a6ba4734SToby Isaac     *func = b->func;
5978a6ba4734SToby Isaac   }
5979a6ba4734SToby Isaac   if (numids) {
5980a6ba4734SToby Isaac     PetscValidPointer(numids, 10);
5981a6ba4734SToby Isaac     *numids = b->numids;
5982a6ba4734SToby Isaac   }
5983a6ba4734SToby Isaac   if (ids) {
5984a6ba4734SToby Isaac     PetscValidPointer(ids, 11);
5985a6ba4734SToby Isaac     *ids = b->ids;
5986a6ba4734SToby Isaac   }
5987a6ba4734SToby Isaac   if (ctx) {
5988a6ba4734SToby Isaac     PetscValidPointer(ctx, 12);
5989a6ba4734SToby Isaac     *ctx = b->ctx;
5990a6ba4734SToby Isaac   }
5991a6ba4734SToby Isaac   PetscFunctionReturn(0);
5992a6ba4734SToby Isaac }
5993a6ba4734SToby Isaac 
5994a6ba4734SToby Isaac #undef __FUNCT__
5995a6ba4734SToby Isaac #define __FUNCT__ "DMIsBoundaryPoint"
5996a6ba4734SToby Isaac PetscErrorCode DMIsBoundaryPoint(DM dm, PetscInt point, PetscBool *isBd)
5997a6ba4734SToby Isaac {
5998bcc5ffd9SToby Isaac   DMBoundary     b    = dm->boundary->next;
5999a6ba4734SToby Isaac   PetscErrorCode ierr;
6000a6ba4734SToby Isaac 
6001a6ba4734SToby Isaac   PetscFunctionBegin;
6002a6ba4734SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6003a6ba4734SToby Isaac   PetscValidPointer(isBd, 3);
6004a6ba4734SToby Isaac   *isBd = PETSC_FALSE;
6005a6ba4734SToby Isaac   while (b && !(*isBd)) {
6006a6ba4734SToby Isaac     if (b->label) {
6007a6ba4734SToby Isaac       PetscInt i;
6008a6ba4734SToby Isaac 
6009a6ba4734SToby Isaac       for (i = 0; i < b->numids && !(*isBd); ++i) {
6010a6ba4734SToby Isaac         ierr = DMLabelStratumHasPoint(b->label, b->ids[i], point, isBd);CHKERRQ(ierr);
6011a6ba4734SToby Isaac       }
6012a6ba4734SToby Isaac     }
6013a6ba4734SToby Isaac     b = b->next;
6014a6ba4734SToby Isaac   }
6015a6ba4734SToby Isaac   PetscFunctionReturn(0);
6016a6ba4734SToby Isaac }
60174d6f44ffSToby Isaac 
60184d6f44ffSToby Isaac #undef __FUNCT__
60194d6f44ffSToby Isaac #define __FUNCT__ "DMProjectFunction"
60204d6f44ffSToby Isaac /*@C
60214d6f44ffSToby Isaac   DMProjectFunction - This projects the given function into the function space provided.
60224d6f44ffSToby Isaac 
60234d6f44ffSToby Isaac   Input Parameters:
60244d6f44ffSToby Isaac + dm      - The DM
60250709b2feSToby Isaac . time    - The time
60264d6f44ffSToby Isaac . funcs   - The coordinate functions to evaluate, one per field
60274d6f44ffSToby Isaac . ctxs    - Optional array of contexts to pass to each coordinate function.  ctxs itself may be null.
60284d6f44ffSToby Isaac - mode    - The insertion mode for values
60294d6f44ffSToby Isaac 
60304d6f44ffSToby Isaac   Output Parameter:
60314d6f44ffSToby Isaac . X - vector
60324d6f44ffSToby Isaac 
60334d6f44ffSToby Isaac    Calling sequence of func:
60340709b2feSToby Isaac $    func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nf, PetscScalar u[], void *ctx);
60354d6f44ffSToby Isaac 
60364d6f44ffSToby Isaac +  dim - The spatial dimension
60374d6f44ffSToby Isaac .  x   - The coordinates
60384d6f44ffSToby Isaac .  Nf  - The number of fields
60394d6f44ffSToby Isaac .  u   - The output field values
60404d6f44ffSToby Isaac -  ctx - optional user-defined function context
60414d6f44ffSToby Isaac 
60424d6f44ffSToby Isaac   Level: developer
60434d6f44ffSToby Isaac 
60442716604bSToby Isaac .seealso: DMComputeL2Diff()
60454d6f44ffSToby Isaac @*/
60460709b2feSToby Isaac PetscErrorCode DMProjectFunction(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec X)
60474d6f44ffSToby Isaac {
60484d6f44ffSToby Isaac   Vec            localX;
60494d6f44ffSToby Isaac   PetscErrorCode ierr;
60504d6f44ffSToby Isaac 
60514d6f44ffSToby Isaac   PetscFunctionBegin;
60524d6f44ffSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
60534d6f44ffSToby Isaac   ierr = DMGetLocalVector(dm, &localX);CHKERRQ(ierr);
60540709b2feSToby Isaac   ierr = DMProjectFunctionLocal(dm, time, funcs, ctxs, mode, localX);CHKERRQ(ierr);
60554d6f44ffSToby Isaac   ierr = DMLocalToGlobalBegin(dm, localX, mode, X);CHKERRQ(ierr);
60564d6f44ffSToby Isaac   ierr = DMLocalToGlobalEnd(dm, localX, mode, X);CHKERRQ(ierr);
60574d6f44ffSToby Isaac   ierr = DMRestoreLocalVector(dm, &localX);CHKERRQ(ierr);
60584d6f44ffSToby Isaac   PetscFunctionReturn(0);
60594d6f44ffSToby Isaac }
60604d6f44ffSToby Isaac 
60614d6f44ffSToby Isaac #undef __FUNCT__
60624d6f44ffSToby Isaac #define __FUNCT__ "DMProjectFunctionLocal"
60630709b2feSToby Isaac PetscErrorCode DMProjectFunctionLocal(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec localX)
60644d6f44ffSToby Isaac {
60654d6f44ffSToby Isaac   PetscErrorCode ierr;
60664d6f44ffSToby Isaac 
60674d6f44ffSToby Isaac   PetscFunctionBegin;
60684d6f44ffSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
60694d6f44ffSToby Isaac   PetscValidHeaderSpecific(localX,VEC_CLASSID,5);
60704d6f44ffSToby Isaac   if (!dm->ops->projectfunctionlocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implemnt DMProjectFunctionLocal",((PetscObject)dm)->type_name);
60710709b2feSToby Isaac   ierr = (dm->ops->projectfunctionlocal) (dm, time, funcs, ctxs, mode, localX);CHKERRQ(ierr);
60724d6f44ffSToby Isaac   PetscFunctionReturn(0);
60734d6f44ffSToby Isaac }
60744d6f44ffSToby Isaac 
60754d6f44ffSToby Isaac #undef __FUNCT__
6076bfc4295aSToby Isaac #define __FUNCT__ "DMProjectFieldLocal"
6077bfc4295aSToby Isaac PetscErrorCode DMProjectFieldLocal(DM dm, Vec localU,
6078bfc4295aSToby Isaac                                    void (**funcs)(PetscInt, PetscInt, PetscInt,
6079bfc4295aSToby Isaac                                                   const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
6080bfc4295aSToby Isaac                                                   const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
6081bfc4295aSToby Isaac                                                   PetscReal, const PetscReal[], PetscScalar[]),
6082bfc4295aSToby Isaac                                    InsertMode mode, Vec localX)
6083bfc4295aSToby Isaac {
6084bfc4295aSToby Isaac   PetscErrorCode ierr;
6085bfc4295aSToby Isaac 
6086bfc4295aSToby Isaac   PetscFunctionBegin;
6087bfc4295aSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6088bfc4295aSToby Isaac   PetscValidHeaderSpecific(localU,VEC_CLASSID,2);
6089bfc4295aSToby Isaac   PetscValidHeaderSpecific(localX,VEC_CLASSID,5);
6090bfc4295aSToby Isaac   if (!dm->ops->projectfieldlocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implemnt DMProjectFieldLocal",((PetscObject)dm)->type_name);
6091bfc4295aSToby Isaac   ierr = (dm->ops->projectfieldlocal) (dm, localU, funcs, mode, localX);CHKERRQ(ierr);
6092bfc4295aSToby Isaac   PetscFunctionReturn(0);
6093bfc4295aSToby Isaac }
6094bfc4295aSToby Isaac 
6095bfc4295aSToby Isaac #undef __FUNCT__
60964d6f44ffSToby Isaac #define __FUNCT__ "DMProjectFunctionLabelLocal"
60970709b2feSToby 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)
60984d6f44ffSToby Isaac {
60994d6f44ffSToby Isaac   PetscErrorCode ierr;
61004d6f44ffSToby Isaac 
61014d6f44ffSToby Isaac   PetscFunctionBegin;
61024d6f44ffSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
61034d6f44ffSToby Isaac   PetscValidHeaderSpecific(localX,VEC_CLASSID,5);
61044d6f44ffSToby Isaac   if (!dm->ops->projectfunctionlabellocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implemnt DMProjectFunctionLabelLocal",((PetscObject)dm)->type_name);
61050709b2feSToby Isaac   ierr = (dm->ops->projectfunctionlabellocal) (dm, time, label, numIds, ids, funcs, ctxs, mode, localX);CHKERRQ(ierr);
61064d6f44ffSToby Isaac   PetscFunctionReturn(0);
61074d6f44ffSToby Isaac }
61082716604bSToby Isaac 
61092716604bSToby Isaac #undef __FUNCT__
61102716604bSToby Isaac #define __FUNCT__ "DMComputeL2Diff"
61112716604bSToby Isaac /*@C
61122716604bSToby Isaac   DMComputeL2Diff - This function computes the L_2 difference between a function u and an FEM interpolant solution u_h.
61132716604bSToby Isaac 
61142716604bSToby Isaac   Input Parameters:
61152716604bSToby Isaac + dm    - The DM
61160709b2feSToby Isaac . time  - The time
61172716604bSToby Isaac . funcs - The functions to evaluate for each field component
61182716604bSToby Isaac . ctxs  - Optional array of contexts to pass to each function, or NULL.
61192716604bSToby Isaac - X     - The coefficient vector u_h
61202716604bSToby Isaac 
61212716604bSToby Isaac   Output Parameter:
61222716604bSToby Isaac . diff - The diff ||u - u_h||_2
61232716604bSToby Isaac 
61242716604bSToby Isaac   Level: developer
61252716604bSToby Isaac 
61261189c1efSToby Isaac .seealso: DMProjectFunction(), DMComputeL2FieldDiff(), DMComputeL2GradientDiff()
61272716604bSToby Isaac @*/
61280709b2feSToby Isaac PetscErrorCode DMComputeL2Diff(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, Vec X, PetscReal *diff)
61292716604bSToby Isaac {
61302716604bSToby Isaac   PetscErrorCode ierr;
61312716604bSToby Isaac 
61322716604bSToby Isaac   PetscFunctionBegin;
61332716604bSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6134b698f381SToby Isaac   PetscValidHeaderSpecific(X,VEC_CLASSID,5);
61352716604bSToby Isaac   if (!dm->ops->computel2diff) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implemnt DMComputeL2Diff",((PetscObject)dm)->type_name);
61360709b2feSToby Isaac   ierr = (dm->ops->computel2diff)(dm,time,funcs,ctxs,X,diff);CHKERRQ(ierr);
61372716604bSToby Isaac   PetscFunctionReturn(0);
61382716604bSToby Isaac }
6139b698f381SToby Isaac 
6140b698f381SToby Isaac #undef __FUNCT__
6141b698f381SToby Isaac #define __FUNCT__ "DMComputeL2GradientDiff"
6142b698f381SToby Isaac /*@C
6143b698f381SToby Isaac   DMComputeL2GradientDiff - This function computes the L_2 difference between the gradient of a function u and an FEM interpolant solution grad u_h.
6144b698f381SToby Isaac 
6145b698f381SToby Isaac   Input Parameters:
6146b698f381SToby Isaac + dm    - The DM
6147b698f381SToby Isaac , time  - The time
6148b698f381SToby Isaac . funcs - The gradient functions to evaluate for each field component
6149b698f381SToby Isaac . ctxs  - Optional array of contexts to pass to each function, or NULL.
6150b698f381SToby Isaac . X     - The coefficient vector u_h
6151b698f381SToby Isaac - n     - The vector to project along
6152b698f381SToby Isaac 
6153b698f381SToby Isaac   Output Parameter:
6154b698f381SToby Isaac . diff - The diff ||(grad u - grad u_h) . n||_2
6155b698f381SToby Isaac 
6156b698f381SToby Isaac   Level: developer
6157b698f381SToby Isaac 
6158b698f381SToby Isaac .seealso: DMProjectFunction(), DMComputeL2Diff()
6159b698f381SToby Isaac @*/
6160b698f381SToby 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)
6161b698f381SToby Isaac {
6162b698f381SToby Isaac   PetscErrorCode ierr;
6163b698f381SToby Isaac 
6164b698f381SToby Isaac   PetscFunctionBegin;
6165b698f381SToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6166b698f381SToby Isaac   PetscValidHeaderSpecific(X,VEC_CLASSID,5);
6167b698f381SToby Isaac   if (!dm->ops->computel2gradientdiff) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2GradientDiff",((PetscObject)dm)->type_name);
6168b698f381SToby Isaac   ierr = (dm->ops->computel2gradientdiff)(dm,time,funcs,ctxs,X,n,diff);CHKERRQ(ierr);
6169b698f381SToby Isaac   PetscFunctionReturn(0);
6170b698f381SToby Isaac }
6171b698f381SToby Isaac 
61722a16baeaSToby Isaac #undef __FUNCT__
61732a16baeaSToby Isaac #define __FUNCT__ "DMComputeL2FieldDiff"
61742a16baeaSToby Isaac /*@C
61752a16baeaSToby Isaac   DMComputeL2FieldDiff - This function computes the L_2 difference between a function u and an FEM interpolant solution u_h, separated into field components.
61762a16baeaSToby Isaac 
61772a16baeaSToby Isaac   Input Parameters:
61782a16baeaSToby Isaac + dm    - The DM
61792a16baeaSToby Isaac . time  - The time
61802a16baeaSToby Isaac . funcs - The functions to evaluate for each field component
61812a16baeaSToby Isaac . ctxs  - Optional array of contexts to pass to each function, or NULL.
61822a16baeaSToby Isaac - X     - The coefficient vector u_h
61832a16baeaSToby Isaac 
61842a16baeaSToby Isaac   Output Parameter:
61852a16baeaSToby Isaac . diff - The array of differences, ||u^f - u^f_h||_2
61862a16baeaSToby Isaac 
61872a16baeaSToby Isaac   Level: developer
61882a16baeaSToby Isaac 
61891189c1efSToby Isaac .seealso: DMProjectFunction(), DMComputeL2FieldDiff(), DMComputeL2GradientDiff()
61902a16baeaSToby Isaac @*/
61911189c1efSToby Isaac PetscErrorCode DMComputeL2FieldDiff(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, Vec X, PetscReal diff[])
61922a16baeaSToby Isaac {
61932a16baeaSToby Isaac   PetscErrorCode ierr;
61942a16baeaSToby Isaac 
61952a16baeaSToby Isaac   PetscFunctionBegin;
61962a16baeaSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
61972a16baeaSToby Isaac   PetscValidHeaderSpecific(X,VEC_CLASSID,5);
61982a16baeaSToby Isaac   if (!dm->ops->computel2fielddiff) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implemnt DMComputeL2FieldDiff",((PetscObject)dm)->type_name);
61992a16baeaSToby Isaac   ierr = (dm->ops->computel2fielddiff)(dm,time,funcs,ctxs,X,diff);CHKERRQ(ierr);
62002a16baeaSToby Isaac   PetscFunctionReturn(0);
62012a16baeaSToby Isaac }
62022a16baeaSToby Isaac 
6203