xref: /petsc/src/dm/interface/dm.c (revision 7889ec69ae0e44a97e08bf1c73874b7ce2f33c45)
1af0996ceSBarry Smith #include <petsc/private/dmimpl.h>           /*I      "petscdm.h"          I*/
2c58f1c22SToby Isaac #include <petsc/private/dmlabelimpl.h>      /*I      "petscdmlabel.h"     I*/
3e6f8dbb6SToby Isaac #include <petsc/private/petscdsimpl.h>      /*I      "petscds.h"     I*/
43e922f36SToby Isaac #include <petscdmplex.h>
50c312b8eSJed Brown #include <petscsf.h>
62764a2aaSMatthew G. Knepley #include <petscds.h>
747c6ae99SBarry Smith 
8732e2eb9SMatthew G Knepley PetscClassId  DM_CLASSID;
93ad4599aSBarry Smith PetscLogEvent DM_Convert, DM_GlobalToLocal, DM_LocalToGlobal, DM_LocalToLocal, DM_LocatePoints, DM_Coarsen, DM_CreateInterpolation, DM_CreateRestriction;
1067a56275SMatthew G Knepley 
11bff4a2f0SMatthew G. Knepley const char *const DMBoundaryTypes[] = {"NONE","GHOSTED","MIRROR","PERIODIC","TWIST","DM_BOUNDARY_",0};
12bff4a2f0SMatthew G. Knepley 
1347c6ae99SBarry Smith #undef __FUNCT__
14a4121054SBarry Smith #define __FUNCT__ "DMCreate"
15a4121054SBarry Smith /*@
16de043629SMatthew G Knepley   DMCreate - Creates an empty DM object. The type can then be set with DMSetType().
17a4121054SBarry Smith 
18a4121054SBarry Smith    If you never  call DMSetType()  it will generate an
19a4121054SBarry Smith    error when you try to use the vector.
20a4121054SBarry Smith 
21a4121054SBarry Smith   Collective on MPI_Comm
22a4121054SBarry Smith 
23a4121054SBarry Smith   Input Parameter:
24a4121054SBarry Smith . comm - The communicator for the DM object
25a4121054SBarry Smith 
26a4121054SBarry Smith   Output Parameter:
27a4121054SBarry Smith . dm - The DM object
28a4121054SBarry Smith 
29a4121054SBarry Smith   Level: beginner
30a4121054SBarry Smith 
318472ad0fSDave May .seealso: DMSetType(), DMDA, DMSLICED, DMCOMPOSITE, DMPLEX, DMMOAB, DMNETWORK
32a4121054SBarry Smith @*/
337087cfbeSBarry Smith PetscErrorCode  DMCreate(MPI_Comm comm,DM *dm)
34a4121054SBarry Smith {
35a4121054SBarry Smith   DM             v;
36a4121054SBarry Smith   PetscErrorCode ierr;
37a4121054SBarry Smith 
38a4121054SBarry Smith   PetscFunctionBegin;
391411c6eeSJed Brown   PetscValidPointer(dm,2);
400298fd71SBarry Smith   *dm = NULL;
418b984314SMatthew G. Knepley   ierr = PetscSysInitializePackage();CHKERRQ(ierr);
42607a6623SBarry Smith   ierr = VecInitializePackage();CHKERRQ(ierr);
43607a6623SBarry Smith   ierr = MatInitializePackage();CHKERRQ(ierr);
44607a6623SBarry Smith   ierr = DMInitializePackage();CHKERRQ(ierr);
45a4121054SBarry Smith 
4673107ff1SLisandro Dalcin   ierr = PetscHeaderCreate(v, DM_CLASSID, "DM", "Distribution Manager", "DM", comm, DMDestroy, DMView);CHKERRQ(ierr);
47e7c4fc90SDmitry Karpeev 
480298fd71SBarry Smith   v->ltogmap                  = NULL;
491411c6eeSJed Brown   v->bs                       = 1;
50171400e9SBarry Smith   v->coloringtype             = IS_COLORING_GLOBAL;
5188ed4aceSMatthew G Knepley   ierr                        = PetscSFCreate(comm, &v->sf);CHKERRQ(ierr);
5288ed4aceSMatthew G Knepley   ierr                        = PetscSFCreate(comm, &v->defaultSF);CHKERRQ(ierr);
53c58f1c22SToby Isaac   v->labels                   = NULL;
54c58f1c22SToby Isaac   v->depthLabel               = NULL;
550298fd71SBarry Smith   v->defaultSection           = NULL;
560298fd71SBarry Smith   v->defaultGlobalSection     = NULL;
57fba222abSToby Isaac   v->defaultConstraintSection = NULL;
58fba222abSToby Isaac   v->defaultConstraintMat     = NULL;
59c6b900c6SMatthew G. Knepley   v->L                        = NULL;
60c6b900c6SMatthew G. Knepley   v->maxCell                  = NULL;
615dc8c3f7SMatthew G. Knepley   v->bdtype                   = NULL;
629a9a41abSToby Isaac   v->dimEmbed                 = PETSC_DEFAULT;
63435a35e8SMatthew G Knepley   {
64435a35e8SMatthew G Knepley     PetscInt i;
65435a35e8SMatthew G Knepley     for (i = 0; i < 10; ++i) {
660298fd71SBarry Smith       v->nullspaceConstructors[i] = NULL;
67435a35e8SMatthew G Knepley     }
68435a35e8SMatthew G Knepley   }
692764a2aaSMatthew G. Knepley   ierr = PetscDSCreate(comm, &v->prob);CHKERRQ(ierr);
7014f150ffSMatthew G. Knepley   v->dmBC = NULL;
71a8fb8f29SToby Isaac   v->coarseMesh = NULL;
72f4d763aaSMatthew G. Knepley   v->outputSequenceNum = -1;
73cdb7a50dSMatthew G. Knepley   v->outputSequenceVal = 0.0;
74c0dedaeaSBarry Smith   ierr = DMSetVecType(v,VECSTANDARD);CHKERRQ(ierr);
75b412c318SBarry Smith   ierr = DMSetMatType(v,MATAIJ);CHKERRQ(ierr);
76bcc5ffd9SToby Isaac   ierr = PetscNew(&(v->labels));CHKERRQ(ierr);
77c58f1c22SToby Isaac   v->labels->refct = 1;
781411c6eeSJed Brown   *dm = v;
79a4121054SBarry Smith   PetscFunctionReturn(0);
80a4121054SBarry Smith }
81a4121054SBarry Smith 
82a4121054SBarry Smith #undef __FUNCT__
8338221697SMatthew G. Knepley #define __FUNCT__ "DMClone"
8438221697SMatthew G. Knepley /*@
8538221697SMatthew G. Knepley   DMClone - Creates a DM object with the same topology as the original.
8638221697SMatthew G. Knepley 
8738221697SMatthew G. Knepley   Collective on MPI_Comm
8838221697SMatthew G. Knepley 
8938221697SMatthew G. Knepley   Input Parameter:
9038221697SMatthew G. Knepley . dm - The original DM object
9138221697SMatthew G. Knepley 
9238221697SMatthew G. Knepley   Output Parameter:
9338221697SMatthew G. Knepley . newdm  - The new DM object
9438221697SMatthew G. Knepley 
9538221697SMatthew G. Knepley   Level: beginner
9638221697SMatthew G. Knepley 
9738221697SMatthew G. Knepley .keywords: DM, topology, create
9838221697SMatthew G. Knepley @*/
9938221697SMatthew G. Knepley PetscErrorCode DMClone(DM dm, DM *newdm)
10038221697SMatthew G. Knepley {
10138221697SMatthew G. Knepley   PetscSF        sf;
10238221697SMatthew G. Knepley   Vec            coords;
10338221697SMatthew G. Knepley   void          *ctx;
1041de53e9aSMatthew G. Knepley   PetscInt       dim;
10538221697SMatthew G. Knepley   PetscErrorCode ierr;
10638221697SMatthew G. Knepley 
10738221697SMatthew G. Knepley   PetscFunctionBegin;
10838221697SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
10938221697SMatthew G. Knepley   PetscValidPointer(newdm,2);
11038221697SMatthew G. Knepley   ierr = DMCreate(PetscObjectComm((PetscObject) dm), newdm);CHKERRQ(ierr);
111c58f1c22SToby Isaac   ierr = PetscFree((*newdm)->labels);CHKERRQ(ierr);
112c58f1c22SToby Isaac   dm->labels->refct++;
113c58f1c22SToby Isaac   (*newdm)->labels = dm->labels;
114c58f1c22SToby Isaac   (*newdm)->depthLabel = dm->depthLabel;
1151de53e9aSMatthew G. Knepley   ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr);
1161de53e9aSMatthew G. Knepley   ierr = DMSetDimension(*newdm, dim);CHKERRQ(ierr);
11738221697SMatthew G. Knepley   if (dm->ops->clone) {
11838221697SMatthew G. Knepley     ierr = (*dm->ops->clone)(dm, newdm);CHKERRQ(ierr);
11938221697SMatthew G. Knepley   }
1203f22bcbcSToby Isaac   (*newdm)->setupcalled = dm->setupcalled;
12138221697SMatthew G. Knepley   ierr = DMGetPointSF(dm, &sf);CHKERRQ(ierr);
12238221697SMatthew G. Knepley   ierr = DMSetPointSF(*newdm, sf);CHKERRQ(ierr);
12338221697SMatthew G. Knepley   ierr = DMGetApplicationContext(dm, &ctx);CHKERRQ(ierr);
12438221697SMatthew G. Knepley   ierr = DMSetApplicationContext(*newdm, ctx);CHKERRQ(ierr);
125be4c1c3eSMatthew G. Knepley   if (dm->coordinateDM) {
126be4c1c3eSMatthew G. Knepley     DM           ncdm;
127be4c1c3eSMatthew G. Knepley     PetscSection cs;
1285a0206caSToby Isaac     PetscInt     pEnd = -1, pEndMax = -1;
129be4c1c3eSMatthew G. Knepley 
130be4c1c3eSMatthew G. Knepley     ierr = DMGetDefaultSection(dm->coordinateDM, &cs);CHKERRQ(ierr);
131be4c1c3eSMatthew G. Knepley     if (cs) {ierr = PetscSectionGetChart(cs, NULL, &pEnd);CHKERRQ(ierr);}
1325a0206caSToby Isaac     ierr = MPI_Allreduce(&pEnd,&pEndMax,1,MPIU_INT,MPI_MAX,PetscObjectComm((PetscObject)dm));CHKERRQ(ierr);
1335a0206caSToby Isaac     if (pEndMax >= 0) {
134be4c1c3eSMatthew G. Knepley       ierr = DMClone(dm->coordinateDM, &ncdm);CHKERRQ(ierr);
13513bffc4cSMatthew G. Knepley       ierr = DMSetDefaultSection(ncdm, cs);CHKERRQ(ierr);
136a61e840bSMatthew G. Knepley       ierr = DMSetCoordinateDM(*newdm, ncdm);CHKERRQ(ierr);
137be4c1c3eSMatthew G. Knepley       ierr = DMDestroy(&ncdm);CHKERRQ(ierr);
138be4c1c3eSMatthew G. Knepley     }
139be4c1c3eSMatthew G. Knepley   }
14038221697SMatthew G. Knepley   ierr = DMGetCoordinatesLocal(dm, &coords);CHKERRQ(ierr);
14138221697SMatthew G. Knepley   if (coords) {
14238221697SMatthew G. Knepley     ierr = DMSetCoordinatesLocal(*newdm, coords);CHKERRQ(ierr);
14338221697SMatthew G. Knepley   } else {
14438221697SMatthew G. Knepley     ierr = DMGetCoordinates(dm, &coords);CHKERRQ(ierr);
14538221697SMatthew G. Knepley     if (coords) {ierr = DMSetCoordinates(*newdm, coords);CHKERRQ(ierr);}
14638221697SMatthew G. Knepley   }
147c6b900c6SMatthew G. Knepley   if (dm->maxCell) {
148c6b900c6SMatthew G. Knepley     const PetscReal *maxCell, *L;
1495dc8c3f7SMatthew G. Knepley     const DMBoundaryType *bd;
1505dc8c3f7SMatthew G. Knepley     ierr = DMGetPeriodicity(dm,     &maxCell, &L, &bd);CHKERRQ(ierr);
1515dc8c3f7SMatthew G. Knepley     ierr = DMSetPeriodicity(*newdm,  maxCell,  L,  bd);CHKERRQ(ierr);
152c6b900c6SMatthew G. Knepley   }
15338221697SMatthew G. Knepley   PetscFunctionReturn(0);
15438221697SMatthew G. Knepley }
15538221697SMatthew G. Knepley 
15638221697SMatthew G. Knepley #undef __FUNCT__
1579a42bb27SBarry Smith #define __FUNCT__ "DMSetVecType"
1589a42bb27SBarry Smith /*@C
159564755cdSBarry Smith        DMSetVecType - Sets the type of vector created with DMCreateLocalVector() and DMCreateGlobalVector()
1609a42bb27SBarry Smith 
1618472ad0fSDave May    Logically Collective on DM
1629a42bb27SBarry Smith 
1639a42bb27SBarry Smith    Input Parameter:
1649a42bb27SBarry Smith +  da - initial distributed array
1658154be41SBarry Smith .  ctype - the vector type, currently either VECSTANDARD or VECCUSP
1669a42bb27SBarry Smith 
1679a42bb27SBarry Smith    Options Database:
168dd85299cSBarry Smith .   -dm_vec_type ctype
1699a42bb27SBarry Smith 
1709a42bb27SBarry Smith    Level: intermediate
1719a42bb27SBarry Smith 
1728472ad0fSDave May .seealso: DMCreate(), DMDestroy(), DM, DMDAInterpolationType, VecType, DMGetVecType()
1739a42bb27SBarry Smith @*/
17419fd82e9SBarry Smith PetscErrorCode  DMSetVecType(DM da,VecType ctype)
1759a42bb27SBarry Smith {
1769a42bb27SBarry Smith   PetscErrorCode ierr;
1779a42bb27SBarry Smith 
1789a42bb27SBarry Smith   PetscFunctionBegin;
1799a42bb27SBarry Smith   PetscValidHeaderSpecific(da,DM_CLASSID,1);
1809a42bb27SBarry Smith   ierr = PetscFree(da->vectype);CHKERRQ(ierr);
18119fd82e9SBarry Smith   ierr = PetscStrallocpy(ctype,(char**)&da->vectype);CHKERRQ(ierr);
1829a42bb27SBarry Smith   PetscFunctionReturn(0);
1839a42bb27SBarry Smith }
1849a42bb27SBarry Smith 
1859a42bb27SBarry Smith #undef __FUNCT__
186c0dedaeaSBarry Smith #define __FUNCT__ "DMGetVecType"
187c0dedaeaSBarry Smith /*@C
188c0dedaeaSBarry Smith        DMGetVecType - Gets the type of vector created with DMCreateLocalVector() and DMCreateGlobalVector()
189c0dedaeaSBarry Smith 
1908472ad0fSDave May    Logically Collective on DM
191c0dedaeaSBarry Smith 
192c0dedaeaSBarry Smith    Input Parameter:
193c0dedaeaSBarry Smith .  da - initial distributed array
194c0dedaeaSBarry Smith 
195c0dedaeaSBarry Smith    Output Parameter:
196c0dedaeaSBarry Smith .  ctype - the vector type
197c0dedaeaSBarry Smith 
198c0dedaeaSBarry Smith    Level: intermediate
199c0dedaeaSBarry Smith 
2008472ad0fSDave May .seealso: DMCreate(), DMDestroy(), DM, DMDAInterpolationType, VecType
201c0dedaeaSBarry Smith @*/
202c0dedaeaSBarry Smith PetscErrorCode  DMGetVecType(DM da,VecType *ctype)
203c0dedaeaSBarry Smith {
204c0dedaeaSBarry Smith   PetscFunctionBegin;
205c0dedaeaSBarry Smith   PetscValidHeaderSpecific(da,DM_CLASSID,1);
206c0dedaeaSBarry Smith   *ctype = da->vectype;
207c0dedaeaSBarry Smith   PetscFunctionReturn(0);
208c0dedaeaSBarry Smith }
209c0dedaeaSBarry Smith 
210c0dedaeaSBarry Smith #undef __FUNCT__
2115f1ad066SMatthew G Knepley #define __FUNCT__ "VecGetDM"
2125f1ad066SMatthew G Knepley /*@
21334f98d34SBarry Smith   VecGetDM - Gets the DM defining the data layout of the vector
2145f1ad066SMatthew G Knepley 
2155f1ad066SMatthew G Knepley   Not collective
2165f1ad066SMatthew G Knepley 
2175f1ad066SMatthew G Knepley   Input Parameter:
2185f1ad066SMatthew G Knepley . v - The Vec
2195f1ad066SMatthew G Knepley 
2205f1ad066SMatthew G Knepley   Output Parameter:
2215f1ad066SMatthew G Knepley . dm - The DM
2225f1ad066SMatthew G Knepley 
2235f1ad066SMatthew G Knepley   Level: intermediate
2245f1ad066SMatthew G Knepley 
2255f1ad066SMatthew G Knepley .seealso: VecSetDM(), DMGetLocalVector(), DMGetGlobalVector(), DMSetVecType()
2265f1ad066SMatthew G Knepley @*/
2275f1ad066SMatthew G Knepley PetscErrorCode VecGetDM(Vec v, DM *dm)
2285f1ad066SMatthew G Knepley {
2295f1ad066SMatthew G Knepley   PetscErrorCode ierr;
2305f1ad066SMatthew G Knepley 
2315f1ad066SMatthew G Knepley   PetscFunctionBegin;
2325f1ad066SMatthew G Knepley   PetscValidHeaderSpecific(v,VEC_CLASSID,1);
2335f1ad066SMatthew G Knepley   PetscValidPointer(dm,2);
2345f1ad066SMatthew G Knepley   ierr = PetscObjectQuery((PetscObject) v, "__PETSc_dm", (PetscObject*) dm);CHKERRQ(ierr);
2355f1ad066SMatthew G Knepley   PetscFunctionReturn(0);
2365f1ad066SMatthew G Knepley }
2375f1ad066SMatthew G Knepley 
2385f1ad066SMatthew G Knepley #undef __FUNCT__
2395f1ad066SMatthew G Knepley #define __FUNCT__ "VecSetDM"
2405f1ad066SMatthew G Knepley /*@
241d9805387SMatthew G. Knepley   VecSetDM - Sets the DM defining the data layout of the vector.
2425f1ad066SMatthew G Knepley 
2435f1ad066SMatthew G Knepley   Not collective
2445f1ad066SMatthew G Knepley 
2455f1ad066SMatthew G Knepley   Input Parameters:
2465f1ad066SMatthew G Knepley + v - The Vec
2475f1ad066SMatthew G Knepley - dm - The DM
2485f1ad066SMatthew G Knepley 
249d9805387SMatthew G. Knepley   Note: This is NOT the same as DMCreateGlobalVector() since it does not change the view methods or perform other customization, but merely sets the DM member.
250d9805387SMatthew G. Knepley 
2515f1ad066SMatthew G Knepley   Level: intermediate
2525f1ad066SMatthew G Knepley 
2535f1ad066SMatthew G Knepley .seealso: VecGetDM(), DMGetLocalVector(), DMGetGlobalVector(), DMSetVecType()
2545f1ad066SMatthew G Knepley @*/
2555f1ad066SMatthew G Knepley PetscErrorCode VecSetDM(Vec v, DM dm)
2565f1ad066SMatthew G Knepley {
2575f1ad066SMatthew G Knepley   PetscErrorCode ierr;
2585f1ad066SMatthew G Knepley 
2595f1ad066SMatthew G Knepley   PetscFunctionBegin;
2605f1ad066SMatthew G Knepley   PetscValidHeaderSpecific(v,VEC_CLASSID,1);
261d7f50e27SLisandro Dalcin   if (dm) PetscValidHeaderSpecific(dm,DM_CLASSID,2);
2625f1ad066SMatthew G Knepley   ierr = PetscObjectCompose((PetscObject) v, "__PETSc_dm", (PetscObject) dm);CHKERRQ(ierr);
2635f1ad066SMatthew G Knepley   PetscFunctionReturn(0);
2645f1ad066SMatthew G Knepley }
2655f1ad066SMatthew G Knepley 
2665f1ad066SMatthew G Knepley #undef __FUNCT__
267521d9a4cSLisandro Dalcin #define __FUNCT__ "DMSetMatType"
268521d9a4cSLisandro Dalcin /*@C
269521d9a4cSLisandro Dalcin        DMSetMatType - Sets the type of matrix created with DMCreateMatrix()
270521d9a4cSLisandro Dalcin 
271521d9a4cSLisandro Dalcin    Logically Collective on DM
272521d9a4cSLisandro Dalcin 
273521d9a4cSLisandro Dalcin    Input Parameter:
274521d9a4cSLisandro Dalcin +  dm - the DM context
275521d9a4cSLisandro Dalcin .  ctype - the matrix type
276521d9a4cSLisandro Dalcin 
277521d9a4cSLisandro Dalcin    Options Database:
278521d9a4cSLisandro Dalcin .   -dm_mat_type ctype
279521d9a4cSLisandro Dalcin 
280521d9a4cSLisandro Dalcin    Level: intermediate
281521d9a4cSLisandro Dalcin 
282c0dedaeaSBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMGetMatType()
283521d9a4cSLisandro Dalcin @*/
28419fd82e9SBarry Smith PetscErrorCode  DMSetMatType(DM dm,MatType ctype)
285521d9a4cSLisandro Dalcin {
286521d9a4cSLisandro Dalcin   PetscErrorCode ierr;
28788f0584fSBarry Smith 
288521d9a4cSLisandro Dalcin   PetscFunctionBegin;
289521d9a4cSLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
290521d9a4cSLisandro Dalcin   ierr = PetscFree(dm->mattype);CHKERRQ(ierr);
29119fd82e9SBarry Smith   ierr = PetscStrallocpy(ctype,(char**)&dm->mattype);CHKERRQ(ierr);
292521d9a4cSLisandro Dalcin   PetscFunctionReturn(0);
293521d9a4cSLisandro Dalcin }
294521d9a4cSLisandro Dalcin 
295521d9a4cSLisandro Dalcin #undef __FUNCT__
296c0dedaeaSBarry Smith #define __FUNCT__ "DMGetMatType"
297c0dedaeaSBarry Smith /*@C
298c0dedaeaSBarry Smith        DMGetMatType - Gets the type of matrix created with DMCreateMatrix()
299c0dedaeaSBarry Smith 
300c0dedaeaSBarry Smith    Logically Collective on DM
301c0dedaeaSBarry Smith 
302c0dedaeaSBarry Smith    Input Parameter:
303c0dedaeaSBarry Smith .  dm - the DM context
304c0dedaeaSBarry Smith 
305c0dedaeaSBarry Smith    Output Parameter:
306c0dedaeaSBarry Smith .  ctype - the matrix type
307c0dedaeaSBarry Smith 
308c0dedaeaSBarry Smith    Options Database:
309c0dedaeaSBarry Smith .   -dm_mat_type ctype
310c0dedaeaSBarry Smith 
311c0dedaeaSBarry Smith    Level: intermediate
312c0dedaeaSBarry Smith 
313c0dedaeaSBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMSetMatType()
314c0dedaeaSBarry Smith @*/
315c0dedaeaSBarry Smith PetscErrorCode  DMGetMatType(DM dm,MatType *ctype)
316c0dedaeaSBarry Smith {
317c0dedaeaSBarry Smith   PetscFunctionBegin;
318c0dedaeaSBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
319c0dedaeaSBarry Smith   *ctype = dm->mattype;
320c0dedaeaSBarry Smith   PetscFunctionReturn(0);
321c0dedaeaSBarry Smith }
322c0dedaeaSBarry Smith 
323c0dedaeaSBarry Smith #undef __FUNCT__
324c688c046SMatthew G Knepley #define __FUNCT__ "MatGetDM"
325c688c046SMatthew G Knepley /*@
32634f98d34SBarry Smith   MatGetDM - Gets the DM defining the data layout of the matrix
327c688c046SMatthew G Knepley 
328c688c046SMatthew G Knepley   Not collective
329c688c046SMatthew G Knepley 
330c688c046SMatthew G Knepley   Input Parameter:
331c688c046SMatthew G Knepley . A - The Mat
332c688c046SMatthew G Knepley 
333c688c046SMatthew G Knepley   Output Parameter:
334c688c046SMatthew G Knepley . dm - The DM
335c688c046SMatthew G Knepley 
336c688c046SMatthew G Knepley   Level: intermediate
337c688c046SMatthew G Knepley 
338c688c046SMatthew G Knepley .seealso: MatSetDM(), DMCreateMatrix(), DMSetMatType()
339c688c046SMatthew G Knepley @*/
340c688c046SMatthew G Knepley PetscErrorCode MatGetDM(Mat A, DM *dm)
341c688c046SMatthew G Knepley {
342c688c046SMatthew G Knepley   PetscErrorCode ierr;
343c688c046SMatthew G Knepley 
344c688c046SMatthew G Knepley   PetscFunctionBegin;
345c688c046SMatthew G Knepley   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
346c688c046SMatthew G Knepley   PetscValidPointer(dm,2);
347c688c046SMatthew G Knepley   ierr = PetscObjectQuery((PetscObject) A, "__PETSc_dm", (PetscObject*) dm);CHKERRQ(ierr);
348c688c046SMatthew G Knepley   PetscFunctionReturn(0);
349c688c046SMatthew G Knepley }
350c688c046SMatthew G Knepley 
351c688c046SMatthew G Knepley #undef __FUNCT__
352c688c046SMatthew G Knepley #define __FUNCT__ "MatSetDM"
353c688c046SMatthew G Knepley /*@
354c688c046SMatthew G Knepley   MatSetDM - Sets the DM defining the data layout of the matrix
355c688c046SMatthew G Knepley 
356c688c046SMatthew G Knepley   Not collective
357c688c046SMatthew G Knepley 
358c688c046SMatthew G Knepley   Input Parameters:
359c688c046SMatthew G Knepley + A - The Mat
360c688c046SMatthew G Knepley - dm - The DM
361c688c046SMatthew G Knepley 
362c688c046SMatthew G Knepley   Level: intermediate
363c688c046SMatthew G Knepley 
364c688c046SMatthew G Knepley .seealso: MatGetDM(), DMCreateMatrix(), DMSetMatType()
365c688c046SMatthew G Knepley @*/
366c688c046SMatthew G Knepley PetscErrorCode MatSetDM(Mat A, DM dm)
367c688c046SMatthew G Knepley {
368c688c046SMatthew G Knepley   PetscErrorCode ierr;
369c688c046SMatthew G Knepley 
370c688c046SMatthew G Knepley   PetscFunctionBegin;
371c688c046SMatthew G Knepley   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
3728865f1eaSKarl Rupp   if (dm) PetscValidHeaderSpecific(dm,DM_CLASSID,2);
373c688c046SMatthew G Knepley   ierr = PetscObjectCompose((PetscObject) A, "__PETSc_dm", (PetscObject) dm);CHKERRQ(ierr);
374c688c046SMatthew G Knepley   PetscFunctionReturn(0);
375c688c046SMatthew G Knepley }
376c688c046SMatthew G Knepley 
377c688c046SMatthew G Knepley #undef __FUNCT__
3789a42bb27SBarry Smith #define __FUNCT__ "DMSetOptionsPrefix"
3799a42bb27SBarry Smith /*@C
3809a42bb27SBarry Smith    DMSetOptionsPrefix - Sets the prefix used for searching for all
3816757b960SDave May    DM options in the database.
3829a42bb27SBarry Smith 
3838353ddbbSDave May    Logically Collective on DM
3849a42bb27SBarry Smith 
3859a42bb27SBarry Smith    Input Parameter:
3868353ddbbSDave May +  da - the DM context
3879a42bb27SBarry Smith -  prefix - the prefix to prepend to all option names
3889a42bb27SBarry Smith 
3899a42bb27SBarry Smith    Notes:
3909a42bb27SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
3919a42bb27SBarry Smith    The first character of all runtime options is AUTOMATICALLY the hyphen.
3929a42bb27SBarry Smith 
3939a42bb27SBarry Smith    Level: advanced
3949a42bb27SBarry Smith 
3958353ddbbSDave May .keywords: DM, set, options, prefix, database
3969a42bb27SBarry Smith 
3979a42bb27SBarry Smith .seealso: DMSetFromOptions()
3989a42bb27SBarry Smith @*/
3997087cfbeSBarry Smith PetscErrorCode  DMSetOptionsPrefix(DM dm,const char prefix[])
4009a42bb27SBarry Smith {
4019a42bb27SBarry Smith   PetscErrorCode ierr;
4029a42bb27SBarry Smith 
4039a42bb27SBarry Smith   PetscFunctionBegin;
4049a42bb27SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
4059a42bb27SBarry Smith   ierr = PetscObjectSetOptionsPrefix((PetscObject)dm,prefix);CHKERRQ(ierr);
406691be533SLawrence Mitchell   if (dm->sf) {
407691be533SLawrence Mitchell     ierr = PetscObjectSetOptionsPrefix((PetscObject)dm->sf,prefix);CHKERRQ(ierr);
408691be533SLawrence Mitchell   }
409691be533SLawrence Mitchell   if (dm->defaultSF) {
410691be533SLawrence Mitchell     ierr = PetscObjectSetOptionsPrefix((PetscObject)dm->defaultSF,prefix);CHKERRQ(ierr);
411691be533SLawrence Mitchell   }
4129a42bb27SBarry Smith   PetscFunctionReturn(0);
4139a42bb27SBarry Smith }
4149a42bb27SBarry Smith 
4159a42bb27SBarry Smith #undef __FUNCT__
41631697293SDave May #define __FUNCT__ "DMAppendOptionsPrefix"
41731697293SDave May /*@C
41831697293SDave May    DMAppendOptionsPrefix - Appends to the prefix used for searching for all
41931697293SDave May    DM options in the database.
42031697293SDave May 
42131697293SDave May    Logically Collective on DM
42231697293SDave May 
42331697293SDave May    Input Parameters:
42431697293SDave May +  dm - the DM context
42531697293SDave May -  prefix - the prefix string to prepend to all DM option requests
42631697293SDave May 
42731697293SDave May    Notes:
42831697293SDave May    A hyphen (-) must NOT be given at the beginning of the prefix name.
42931697293SDave May    The first character of all runtime options is AUTOMATICALLY the hyphen.
43031697293SDave May 
43131697293SDave May    Level: advanced
43231697293SDave May 
43331697293SDave May .keywords: DM, append, options, prefix, database
43431697293SDave May 
43531697293SDave May .seealso: DMSetOptionsPrefix(), DMGetOptionsPrefix()
43631697293SDave May @*/
43731697293SDave May PetscErrorCode  DMAppendOptionsPrefix(DM dm,const char prefix[])
43831697293SDave May {
43931697293SDave May   PetscErrorCode ierr;
44031697293SDave May 
44131697293SDave May   PetscFunctionBegin;
44231697293SDave May   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
44331697293SDave May   ierr = PetscObjectAppendOptionsPrefix((PetscObject)dm,prefix);CHKERRQ(ierr);
44431697293SDave May   PetscFunctionReturn(0);
44531697293SDave May }
44631697293SDave May 
44731697293SDave May #undef __FUNCT__
44831697293SDave May #define __FUNCT__ "DMGetOptionsPrefix"
44931697293SDave May /*@C
45031697293SDave May    DMGetOptionsPrefix - Gets the prefix used for searching for all
45131697293SDave May    DM options in the database.
45231697293SDave May 
45331697293SDave May    Not Collective
45431697293SDave May 
45531697293SDave May    Input Parameters:
45631697293SDave May .  dm - the DM context
45731697293SDave May 
45831697293SDave May    Output Parameters:
45931697293SDave May .  prefix - pointer to the prefix string used is returned
46031697293SDave May 
46131697293SDave May    Notes: On the fortran side, the user should pass in a string 'prefix' of
46231697293SDave May    sufficient length to hold the prefix.
46331697293SDave May 
46431697293SDave May    Level: advanced
46531697293SDave May 
46631697293SDave May .keywords: DM, set, options, prefix, database
46731697293SDave May 
46831697293SDave May .seealso: DMSetOptionsPrefix(), DMAppendOptionsPrefix()
46931697293SDave May @*/
47031697293SDave May PetscErrorCode  DMGetOptionsPrefix(DM dm,const char *prefix[])
47131697293SDave May {
47231697293SDave May   PetscErrorCode ierr;
47331697293SDave May 
47431697293SDave May   PetscFunctionBegin;
47531697293SDave May   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
47631697293SDave May   ierr = PetscObjectGetOptionsPrefix((PetscObject)dm,prefix);CHKERRQ(ierr);
47731697293SDave May   PetscFunctionReturn(0);
47831697293SDave May }
47931697293SDave May 
48031697293SDave May #undef __FUNCT__
48188bdff64SToby Isaac #define __FUNCT__ "DMCountNonCyclicReferences"
48288bdff64SToby Isaac static PetscErrorCode DMCountNonCyclicReferences(DM dm, PetscBool recurseCoarse, PetscBool recurseFine, PetscInt *ncrefct)
48388bdff64SToby Isaac {
48488bdff64SToby Isaac   PetscInt i, refct = ((PetscObject) dm)->refct;
48588bdff64SToby Isaac   DMNamedVecLink nlink;
48688bdff64SToby Isaac   PetscErrorCode ierr;
48788bdff64SToby Isaac 
48888bdff64SToby Isaac   PetscFunctionBegin;
48988bdff64SToby Isaac   /* count all the circular references of DM and its contained Vecs */
49088bdff64SToby Isaac   for (i=0; i<DM_MAX_WORK_VECTORS; i++) {
49188bdff64SToby Isaac     if (dm->localin[i])  refct--;
49288bdff64SToby Isaac     if (dm->globalin[i]) refct--;
49388bdff64SToby Isaac   }
49488bdff64SToby Isaac   for (nlink=dm->namedglobal; nlink; nlink=nlink->next) refct--;
49588bdff64SToby Isaac   for (nlink=dm->namedlocal; nlink; nlink=nlink->next) refct--;
49688bdff64SToby Isaac   if (dm->x) {
49788bdff64SToby Isaac     DM obj;
49888bdff64SToby Isaac     ierr = VecGetDM(dm->x, &obj);CHKERRQ(ierr);
49988bdff64SToby Isaac     if (obj == dm) refct--;
50088bdff64SToby Isaac   }
50188bdff64SToby Isaac   if (dm->coarseMesh && dm->coarseMesh->fineMesh == dm) {
50288bdff64SToby Isaac     refct--;
50388bdff64SToby Isaac     if (recurseCoarse) {
50488bdff64SToby Isaac       PetscInt coarseCount;
50588bdff64SToby Isaac 
50688bdff64SToby Isaac       ierr = DMCountNonCyclicReferences(dm->coarseMesh, PETSC_TRUE, PETSC_FALSE,&coarseCount);CHKERRQ(ierr);
50788bdff64SToby Isaac       refct += coarseCount;
50888bdff64SToby Isaac     }
50988bdff64SToby Isaac   }
51088bdff64SToby Isaac   if (dm->fineMesh && dm->fineMesh->coarseMesh == dm) {
51188bdff64SToby Isaac     refct--;
51288bdff64SToby Isaac     if (recurseFine) {
51388bdff64SToby Isaac       PetscInt fineCount;
51488bdff64SToby Isaac 
51588bdff64SToby Isaac       ierr = DMCountNonCyclicReferences(dm->fineMesh, PETSC_FALSE, PETSC_TRUE,&fineCount);CHKERRQ(ierr);
51688bdff64SToby Isaac       refct += fineCount;
51788bdff64SToby Isaac     }
51888bdff64SToby Isaac   }
51988bdff64SToby Isaac   *ncrefct = refct;
52088bdff64SToby Isaac   PetscFunctionReturn(0);
52188bdff64SToby Isaac }
52288bdff64SToby Isaac 
52388bdff64SToby Isaac #undef __FUNCT__
524354557abSToby Isaac #define __FUNCT__ "DMDestroyLabelLinkList"
525354557abSToby Isaac PetscErrorCode DMDestroyLabelLinkList(DM dm)
526354557abSToby Isaac {
527354557abSToby Isaac   PetscErrorCode ierr;
528354557abSToby Isaac 
529354557abSToby Isaac   PetscFunctionBegin;
530354557abSToby Isaac   if (!--(dm->labels->refct)) {
531354557abSToby Isaac     DMLabelLink next = dm->labels->next;
532354557abSToby Isaac 
533354557abSToby Isaac     /* destroy the labels */
534354557abSToby Isaac     while (next) {
535354557abSToby Isaac       DMLabelLink tmp = next->next;
536354557abSToby Isaac 
537354557abSToby Isaac       ierr = DMLabelDestroy(&next->label);CHKERRQ(ierr);
538354557abSToby Isaac       ierr = PetscFree(next);CHKERRQ(ierr);
539354557abSToby Isaac       next = tmp;
540354557abSToby Isaac     }
541354557abSToby Isaac     ierr = PetscFree(dm->labels);CHKERRQ(ierr);
542354557abSToby Isaac   }
543354557abSToby Isaac   PetscFunctionReturn(0);
544354557abSToby Isaac }
545354557abSToby Isaac 
546354557abSToby Isaac #undef __FUNCT__
54747c6ae99SBarry Smith #define __FUNCT__ "DMDestroy"
54847c6ae99SBarry Smith /*@
5498472ad0fSDave May     DMDestroy - Destroys a vector packer or DM.
55047c6ae99SBarry Smith 
55147c6ae99SBarry Smith     Collective on DM
55247c6ae99SBarry Smith 
55347c6ae99SBarry Smith     Input Parameter:
55447c6ae99SBarry Smith .   dm - the DM object to destroy
55547c6ae99SBarry Smith 
55647c6ae99SBarry Smith     Level: developer
55747c6ae99SBarry Smith 
558e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
55947c6ae99SBarry Smith 
56047c6ae99SBarry Smith @*/
561fcfd50ebSBarry Smith PetscErrorCode  DMDestroy(DM *dm)
56247c6ae99SBarry Smith {
56388bdff64SToby Isaac   PetscInt       i, cnt;
564dfe15315SJed Brown   DMNamedVecLink nlink,nnext;
56547c6ae99SBarry Smith   PetscErrorCode ierr;
56647c6ae99SBarry Smith 
56747c6ae99SBarry Smith   PetscFunctionBegin;
5686bf464f9SBarry Smith   if (!*dm) PetscFunctionReturn(0);
5696bf464f9SBarry Smith   PetscValidHeaderSpecific((*dm),DM_CLASSID,1);
57087e657c6SBarry Smith 
57188bdff64SToby Isaac   /* count all non-cyclic references in the doubly-linked list of coarse<->fine meshes */
57288bdff64SToby Isaac   ierr = DMCountNonCyclicReferences(*dm,PETSC_TRUE,PETSC_TRUE,&cnt);CHKERRQ(ierr);
57388bdff64SToby Isaac   --((PetscObject)(*dm))->refct;
57488bdff64SToby Isaac   if (--cnt > 0) {*dm = 0; PetscFunctionReturn(0);}
575732e2eb9SMatthew G Knepley   /*
576732e2eb9SMatthew G Knepley      Need this test because the dm references the vectors that
577732e2eb9SMatthew G Knepley      reference the dm, so destroying the dm calls destroy on the
578732e2eb9SMatthew G Knepley      vectors that cause another destroy on the dm
579732e2eb9SMatthew G Knepley   */
5806bf464f9SBarry Smith   if (((PetscObject)(*dm))->refct < 0) PetscFunctionReturn(0);
5816bf464f9SBarry Smith   ((PetscObject) (*dm))->refct = 0;
582732e2eb9SMatthew G Knepley   for (i=0; i<DM_MAX_WORK_VECTORS; i++) {
5836bf464f9SBarry Smith     if ((*dm)->localout[i]) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Destroying a DM that has a local vector obtained with DMGetLocalVector()");
5846bf464f9SBarry Smith     ierr = VecDestroy(&(*dm)->localin[i]);CHKERRQ(ierr);
585732e2eb9SMatthew G Knepley   }
586f490541aSPeter Brune   nnext=(*dm)->namedglobal;
5870298fd71SBarry Smith   (*dm)->namedglobal = NULL;
588f490541aSPeter Brune   for (nlink=nnext; nlink; nlink=nnext) { /* Destroy the named vectors */
5892348bcf4SPeter Brune     nnext = nlink->next;
5902348bcf4SPeter 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);
5912348bcf4SPeter Brune     ierr = PetscFree(nlink->name);CHKERRQ(ierr);
5922348bcf4SPeter Brune     ierr = VecDestroy(&nlink->X);CHKERRQ(ierr);
5932348bcf4SPeter Brune     ierr = PetscFree(nlink);CHKERRQ(ierr);
5942348bcf4SPeter Brune   }
595f490541aSPeter Brune   nnext=(*dm)->namedlocal;
5960298fd71SBarry Smith   (*dm)->namedlocal = NULL;
597f490541aSPeter Brune   for (nlink=nnext; nlink; nlink=nnext) { /* Destroy the named local vectors */
598f490541aSPeter Brune     nnext = nlink->next;
599f490541aSPeter 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);
600f490541aSPeter Brune     ierr = PetscFree(nlink->name);CHKERRQ(ierr);
601f490541aSPeter Brune     ierr = VecDestroy(&nlink->X);CHKERRQ(ierr);
602f490541aSPeter Brune     ierr = PetscFree(nlink);CHKERRQ(ierr);
603f490541aSPeter Brune   }
6042348bcf4SPeter Brune 
605b17ce1afSJed Brown   /* Destroy the list of hooks */
606c833c3b5SJed Brown   {
607c833c3b5SJed Brown     DMCoarsenHookLink link,next;
608b17ce1afSJed Brown     for (link=(*dm)->coarsenhook; link; link=next) {
609b17ce1afSJed Brown       next = link->next;
610b17ce1afSJed Brown       ierr = PetscFree(link);CHKERRQ(ierr);
611b17ce1afSJed Brown     }
6120298fd71SBarry Smith     (*dm)->coarsenhook = NULL;
613c833c3b5SJed Brown   }
614c833c3b5SJed Brown   {
615c833c3b5SJed Brown     DMRefineHookLink link,next;
616c833c3b5SJed Brown     for (link=(*dm)->refinehook; link; link=next) {
617c833c3b5SJed Brown       next = link->next;
618c833c3b5SJed Brown       ierr = PetscFree(link);CHKERRQ(ierr);
619c833c3b5SJed Brown     }
6200298fd71SBarry Smith     (*dm)->refinehook = NULL;
621c833c3b5SJed Brown   }
622be081cd6SPeter Brune   {
623be081cd6SPeter Brune     DMSubDomainHookLink link,next;
624be081cd6SPeter Brune     for (link=(*dm)->subdomainhook; link; link=next) {
625be081cd6SPeter Brune       next = link->next;
626be081cd6SPeter Brune       ierr = PetscFree(link);CHKERRQ(ierr);
627be081cd6SPeter Brune     }
6280298fd71SBarry Smith     (*dm)->subdomainhook = NULL;
629be081cd6SPeter Brune   }
630baf369e7SPeter Brune   {
631baf369e7SPeter Brune     DMGlobalToLocalHookLink link,next;
632baf369e7SPeter Brune     for (link=(*dm)->gtolhook; link; link=next) {
633baf369e7SPeter Brune       next = link->next;
634baf369e7SPeter Brune       ierr = PetscFree(link);CHKERRQ(ierr);
635baf369e7SPeter Brune     }
6360298fd71SBarry Smith     (*dm)->gtolhook = NULL;
637baf369e7SPeter Brune   }
638d4d07f1eSToby Isaac   {
639d4d07f1eSToby Isaac     DMLocalToGlobalHookLink link,next;
640d4d07f1eSToby Isaac     for (link=(*dm)->ltoghook; link; link=next) {
641d4d07f1eSToby Isaac       next = link->next;
642d4d07f1eSToby Isaac       ierr = PetscFree(link);CHKERRQ(ierr);
643d4d07f1eSToby Isaac     }
644d4d07f1eSToby Isaac     (*dm)->ltoghook = NULL;
645d4d07f1eSToby Isaac   }
646aa1993deSMatthew G Knepley   /* Destroy the work arrays */
647aa1993deSMatthew G Knepley   {
648aa1993deSMatthew G Knepley     DMWorkLink link,next;
649aa1993deSMatthew G Knepley     if ((*dm)->workout) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Work array still checked out");
650aa1993deSMatthew G Knepley     for (link=(*dm)->workin; link; link=next) {
651aa1993deSMatthew G Knepley       next = link->next;
652aa1993deSMatthew G Knepley       ierr = PetscFree(link->mem);CHKERRQ(ierr);
653aa1993deSMatthew G Knepley       ierr = PetscFree(link);CHKERRQ(ierr);
654aa1993deSMatthew G Knepley     }
6550298fd71SBarry Smith     (*dm)->workin = NULL;
656aa1993deSMatthew G Knepley   }
657c58f1c22SToby Isaac   if (!--((*dm)->labels->refct)) {
658c58f1c22SToby Isaac     DMLabelLink next = (*dm)->labels->next;
659c58f1c22SToby Isaac 
660c58f1c22SToby Isaac     /* destroy the labels */
661c58f1c22SToby Isaac     while (next) {
662c58f1c22SToby Isaac       DMLabelLink tmp = next->next;
663c58f1c22SToby Isaac 
664c58f1c22SToby Isaac       ierr = DMLabelDestroy(&next->label);CHKERRQ(ierr);
665c58f1c22SToby Isaac       ierr = PetscFree(next);CHKERRQ(ierr);
666c58f1c22SToby Isaac       next = tmp;
667c58f1c22SToby Isaac     }
668c58f1c22SToby Isaac     ierr = PetscFree((*dm)->labels);CHKERRQ(ierr);
669c58f1c22SToby Isaac   }
670e6f8dbb6SToby Isaac   {
671e6f8dbb6SToby Isaac     DMBoundary next = (*dm)->boundary;
672e6f8dbb6SToby Isaac     while (next) {
673e6f8dbb6SToby Isaac       DMBoundary b = next;
674e6f8dbb6SToby Isaac 
675e6f8dbb6SToby Isaac       next = b->next;
676e6f8dbb6SToby Isaac       ierr = PetscFree(b);CHKERRQ(ierr);
677e6f8dbb6SToby Isaac     }
678e6f8dbb6SToby Isaac   }
679b17ce1afSJed Brown 
68052536dc3SBarry Smith   ierr = PetscObjectDestroy(&(*dm)->dmksp);CHKERRQ(ierr);
68152536dc3SBarry Smith   ierr = PetscObjectDestroy(&(*dm)->dmsnes);CHKERRQ(ierr);
68252536dc3SBarry Smith   ierr = PetscObjectDestroy(&(*dm)->dmts);CHKERRQ(ierr);
68352536dc3SBarry Smith 
6841a266240SBarry Smith   if ((*dm)->ctx && (*dm)->ctxdestroy) {
6851a266240SBarry Smith     ierr = (*(*dm)->ctxdestroy)(&(*dm)->ctx);CHKERRQ(ierr);
6861a266240SBarry Smith   }
68787e657c6SBarry Smith   ierr = VecDestroy(&(*dm)->x);CHKERRQ(ierr);
68871cd77b2SBarry Smith   ierr = MatFDColoringDestroy(&(*dm)->fd);CHKERRQ(ierr);
6894dcab191SBarry Smith   ierr = DMClearGlobalVectors(*dm);CHKERRQ(ierr);
6906bf464f9SBarry Smith   ierr = ISLocalToGlobalMappingDestroy(&(*dm)->ltogmap);CHKERRQ(ierr);
6916bf464f9SBarry Smith   ierr = PetscFree((*dm)->vectype);CHKERRQ(ierr);
692073dac72SJed Brown   ierr = PetscFree((*dm)->mattype);CHKERRQ(ierr);
69388ed4aceSMatthew G Knepley 
69488ed4aceSMatthew G Knepley   ierr = PetscSectionDestroy(&(*dm)->defaultSection);CHKERRQ(ierr);
69588ed4aceSMatthew G Knepley   ierr = PetscSectionDestroy(&(*dm)->defaultGlobalSection);CHKERRQ(ierr);
6968b1ab98fSJed Brown   ierr = PetscLayoutDestroy(&(*dm)->map);CHKERRQ(ierr);
697fba222abSToby Isaac   ierr = PetscSectionDestroy(&(*dm)->defaultConstraintSection);CHKERRQ(ierr);
698fba222abSToby Isaac   ierr = MatDestroy(&(*dm)->defaultConstraintMat);CHKERRQ(ierr);
69988ed4aceSMatthew G Knepley   ierr = PetscSFDestroy(&(*dm)->sf);CHKERRQ(ierr);
70088ed4aceSMatthew G Knepley   ierr = PetscSFDestroy(&(*dm)->defaultSF);CHKERRQ(ierr);
7018e4ac7eaSMatthew G. Knepley   ierr = PetscSFDestroy(&(*dm)->sfNatural);CHKERRQ(ierr);
702af122d2aSMatthew G Knepley 
70388bdff64SToby Isaac   if ((*dm)->coarseMesh && (*dm)->coarseMesh->fineMesh == *dm) {
70488bdff64SToby Isaac     ierr = DMSetFineDM((*dm)->coarseMesh,NULL);CHKERRQ(ierr);
70588bdff64SToby Isaac   }
706a8fb8f29SToby Isaac   ierr = DMDestroy(&(*dm)->coarseMesh);CHKERRQ(ierr);
70788bdff64SToby Isaac   if ((*dm)->fineMesh && (*dm)->fineMesh->coarseMesh == *dm) {
70888bdff64SToby Isaac     ierr = DMSetCoarseDM((*dm)->fineMesh,NULL);CHKERRQ(ierr);
70988bdff64SToby Isaac   }
71088bdff64SToby Isaac   ierr = DMDestroy(&(*dm)->fineMesh);CHKERRQ(ierr);
7116636e97aSMatthew G Knepley   ierr = DMDestroy(&(*dm)->coordinateDM);CHKERRQ(ierr);
7126636e97aSMatthew G Knepley   ierr = VecDestroy(&(*dm)->coordinates);CHKERRQ(ierr);
7136636e97aSMatthew G Knepley   ierr = VecDestroy(&(*dm)->coordinatesLocal);CHKERRQ(ierr);
7145dc8c3f7SMatthew G. Knepley   ierr = PetscFree3((*dm)->L,(*dm)->maxCell,(*dm)->bdtype);CHKERRQ(ierr);
7156636e97aSMatthew G Knepley 
7162764a2aaSMatthew G. Knepley   ierr = PetscDSDestroy(&(*dm)->prob);CHKERRQ(ierr);
71714f150ffSMatthew G. Knepley   ierr = DMDestroy(&(*dm)->dmBC);CHKERRQ(ierr);
718e04113cfSBarry Smith   /* if memory was published with SAWs then destroy it */
719e04113cfSBarry Smith   ierr = PetscObjectSAWsViewOff((PetscObject)*dm);CHKERRQ(ierr);
720732e2eb9SMatthew G Knepley 
7216bf464f9SBarry Smith   ierr = (*(*dm)->ops->destroy)(*dm);CHKERRQ(ierr);
722435a35e8SMatthew G Knepley   /* We do not destroy (*dm)->data here so that we can reference count backend objects */
723732e2eb9SMatthew G Knepley   ierr = PetscHeaderDestroy(dm);CHKERRQ(ierr);
72447c6ae99SBarry Smith   PetscFunctionReturn(0);
72547c6ae99SBarry Smith }
72647c6ae99SBarry Smith 
72747c6ae99SBarry Smith #undef __FUNCT__
728d7bf68aeSBarry Smith #define __FUNCT__ "DMSetUp"
729d7bf68aeSBarry Smith /*@
730d7bf68aeSBarry Smith     DMSetUp - sets up the data structures inside a DM object
731d7bf68aeSBarry Smith 
732d7bf68aeSBarry Smith     Collective on DM
733d7bf68aeSBarry Smith 
734d7bf68aeSBarry Smith     Input Parameter:
735d7bf68aeSBarry Smith .   dm - the DM object to setup
736d7bf68aeSBarry Smith 
737d7bf68aeSBarry Smith     Level: developer
738d7bf68aeSBarry Smith 
739e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
740d7bf68aeSBarry Smith 
741d7bf68aeSBarry Smith @*/
7427087cfbeSBarry Smith PetscErrorCode  DMSetUp(DM dm)
743d7bf68aeSBarry Smith {
744d7bf68aeSBarry Smith   PetscErrorCode ierr;
745d7bf68aeSBarry Smith 
746d7bf68aeSBarry Smith   PetscFunctionBegin;
747171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
7488387afaaSJed Brown   if (dm->setupcalled) PetscFunctionReturn(0);
749d7bf68aeSBarry Smith   if (dm->ops->setup) {
750d7bf68aeSBarry Smith     ierr = (*dm->ops->setup)(dm);CHKERRQ(ierr);
751d7bf68aeSBarry Smith   }
7528387afaaSJed Brown   dm->setupcalled = PETSC_TRUE;
753d7bf68aeSBarry Smith   PetscFunctionReturn(0);
754d7bf68aeSBarry Smith }
755d7bf68aeSBarry Smith 
756d7bf68aeSBarry Smith #undef __FUNCT__
757d7bf68aeSBarry Smith #define __FUNCT__ "DMSetFromOptions"
758d7bf68aeSBarry Smith /*@
759d7bf68aeSBarry Smith     DMSetFromOptions - sets parameters in a DM from the options database
760d7bf68aeSBarry Smith 
761d7bf68aeSBarry Smith     Collective on DM
762d7bf68aeSBarry Smith 
763d7bf68aeSBarry Smith     Input Parameter:
764d7bf68aeSBarry Smith .   dm - the DM object to set options for
765d7bf68aeSBarry Smith 
766732e2eb9SMatthew G Knepley     Options Database:
7674164ae61SDominic Meiser +   -dm_preallocate_only - Only preallocate the matrix for DMCreateMatrix(), but do not fill it with zeros
7684164ae61SDominic Meiser .   -dm_vec_type <type>  - type of vector to create inside DM
7694164ae61SDominic Meiser .   -dm_mat_type <type>  - type of matrix to create inside DM
7704164ae61SDominic Meiser -   -dm_coloring_type    - <global or ghosted>
771732e2eb9SMatthew G Knepley 
772d7bf68aeSBarry Smith     Level: developer
773d7bf68aeSBarry Smith 
774e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
775d7bf68aeSBarry Smith 
776d7bf68aeSBarry Smith @*/
7777087cfbeSBarry Smith PetscErrorCode  DMSetFromOptions(DM dm)
778d7bf68aeSBarry Smith {
7797781c08eSBarry Smith   char           typeName[256];
780ca266f36SBarry Smith   PetscBool      flg;
781d7bf68aeSBarry Smith   PetscErrorCode ierr;
782d7bf68aeSBarry Smith 
783d7bf68aeSBarry Smith   PetscFunctionBegin;
784171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
785f1fd5e65SToby Isaac   if (dm->prob) {
786f1fd5e65SToby Isaac     ierr = PetscDSSetFromOptions(dm->prob);CHKERRQ(ierr);
787f1fd5e65SToby Isaac   }
788691be533SLawrence Mitchell   if (dm->sf) {
789691be533SLawrence Mitchell     ierr = PetscSFSetFromOptions(dm->sf);CHKERRQ(ierr);
790691be533SLawrence Mitchell   }
791691be533SLawrence Mitchell   if (dm->defaultSF) {
792691be533SLawrence Mitchell     ierr = PetscSFSetFromOptions(dm->defaultSF);CHKERRQ(ierr);
793691be533SLawrence Mitchell   }
7943194b578SJed Brown   ierr = PetscObjectOptionsBegin((PetscObject)dm);CHKERRQ(ierr);
7950298fd71SBarry 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);
796a264d7a6SBarry Smith   ierr = PetscOptionsFList("-dm_vec_type","Vector type used for created vectors","DMSetVecType",VecList,dm->vectype,typeName,256,&flg);CHKERRQ(ierr);
797f9ba7244SBarry Smith   if (flg) {
798f9ba7244SBarry Smith     ierr = DMSetVecType(dm,typeName);CHKERRQ(ierr);
799f9ba7244SBarry Smith   }
800a264d7a6SBarry 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);
801073dac72SJed Brown   if (flg) {
802521d9a4cSLisandro Dalcin     ierr = DMSetMatType(dm,typeName);CHKERRQ(ierr);
803073dac72SJed Brown   }
8040298fd71SBarry Smith   ierr = PetscOptionsEnum("-dm_is_coloring_type","Global or local coloring of Jacobian","ISColoringType",ISColoringTypes,(PetscEnum)dm->coloringtype,(PetscEnum*)&dm->coloringtype,NULL);CHKERRQ(ierr);
805f9ba7244SBarry Smith   if (dm->ops->setfromoptions) {
806e55864a3SBarry Smith     ierr = (*dm->ops->setfromoptions)(PetscOptionsObject,dm);CHKERRQ(ierr);
807f9ba7244SBarry Smith   }
808f9ba7244SBarry Smith   /* process any options handlers added with PetscObjectAddOptionsHandler() */
8090633abcbSJed Brown   ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject) dm);CHKERRQ(ierr);
81082fcb398SMatthew G Knepley   ierr = PetscOptionsEnd();CHKERRQ(ierr);
811d7bf68aeSBarry Smith   PetscFunctionReturn(0);
812d7bf68aeSBarry Smith }
813d7bf68aeSBarry Smith 
814d7bf68aeSBarry Smith #undef __FUNCT__
81547c6ae99SBarry Smith #define __FUNCT__ "DMView"
816fc9bc008SSatish Balay /*@C
817224748a4SBarry Smith     DMView - Views a DM
81847c6ae99SBarry Smith 
81947c6ae99SBarry Smith     Collective on DM
82047c6ae99SBarry Smith 
82147c6ae99SBarry Smith     Input Parameter:
82247c6ae99SBarry Smith +   dm - the DM object to view
82347c6ae99SBarry Smith -   v - the viewer
82447c6ae99SBarry Smith 
825224748a4SBarry Smith     Level: beginner
82647c6ae99SBarry Smith 
827e727c939SJed Brown .seealso DMDestroy(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
82847c6ae99SBarry Smith 
82947c6ae99SBarry Smith @*/
8307087cfbeSBarry Smith PetscErrorCode  DMView(DM dm,PetscViewer v)
83147c6ae99SBarry Smith {
83247c6ae99SBarry Smith   PetscErrorCode ierr;
83332c0f0efSBarry Smith   PetscBool      isbinary;
83447c6ae99SBarry Smith 
83547c6ae99SBarry Smith   PetscFunctionBegin;
836171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
8373014e516SBarry Smith   if (!v) {
838ce94432eSBarry Smith     ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)dm),&v);CHKERRQ(ierr);
8393014e516SBarry Smith   }
84098c3331eSBarry Smith   ierr = PetscObjectPrintClassNamePrefixType((PetscObject)dm,v);CHKERRQ(ierr);
84132c0f0efSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)v,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
84232c0f0efSBarry Smith   if (isbinary) {
84355849f57SBarry Smith     PetscInt classid = DM_FILE_CLASSID;
84432c0f0efSBarry Smith     char     type[256];
84532c0f0efSBarry Smith 
84632c0f0efSBarry Smith     ierr = PetscViewerBinaryWrite(v,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
84732c0f0efSBarry Smith     ierr = PetscStrncpy(type,((PetscObject)dm)->type_name,256);CHKERRQ(ierr);
84832c0f0efSBarry Smith     ierr = PetscViewerBinaryWrite(v,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr);
84932c0f0efSBarry Smith   }
8500c010503SBarry Smith   if (dm->ops->view) {
8510c010503SBarry Smith     ierr = (*dm->ops->view)(dm,v);CHKERRQ(ierr);
85247c6ae99SBarry Smith   }
85347c6ae99SBarry Smith   PetscFunctionReturn(0);
85447c6ae99SBarry Smith }
85547c6ae99SBarry Smith 
85647c6ae99SBarry Smith #undef __FUNCT__
85747c6ae99SBarry Smith #define __FUNCT__ "DMCreateGlobalVector"
85847c6ae99SBarry Smith /*@
8598472ad0fSDave May     DMCreateGlobalVector - Creates a global vector from a DM object
86047c6ae99SBarry Smith 
86147c6ae99SBarry Smith     Collective on DM
86247c6ae99SBarry Smith 
86347c6ae99SBarry Smith     Input Parameter:
86447c6ae99SBarry Smith .   dm - the DM object
86547c6ae99SBarry Smith 
86647c6ae99SBarry Smith     Output Parameter:
86747c6ae99SBarry Smith .   vec - the global vector
86847c6ae99SBarry Smith 
869073dac72SJed Brown     Level: beginner
87047c6ae99SBarry Smith 
871e727c939SJed Brown .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
87247c6ae99SBarry Smith 
87347c6ae99SBarry Smith @*/
8747087cfbeSBarry Smith PetscErrorCode  DMCreateGlobalVector(DM dm,Vec *vec)
87547c6ae99SBarry Smith {
87647c6ae99SBarry Smith   PetscErrorCode ierr;
87747c6ae99SBarry Smith 
87847c6ae99SBarry Smith   PetscFunctionBegin;
879171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
88047c6ae99SBarry Smith   ierr = (*dm->ops->createglobalvector)(dm,vec);CHKERRQ(ierr);
88147c6ae99SBarry Smith   PetscFunctionReturn(0);
88247c6ae99SBarry Smith }
88347c6ae99SBarry Smith 
88447c6ae99SBarry Smith #undef __FUNCT__
88547c6ae99SBarry Smith #define __FUNCT__ "DMCreateLocalVector"
88647c6ae99SBarry Smith /*@
8878472ad0fSDave May     DMCreateLocalVector - Creates a local vector from a DM object
88847c6ae99SBarry Smith 
88947c6ae99SBarry Smith     Not Collective
89047c6ae99SBarry Smith 
89147c6ae99SBarry Smith     Input Parameter:
89247c6ae99SBarry Smith .   dm - the DM object
89347c6ae99SBarry Smith 
89447c6ae99SBarry Smith     Output Parameter:
89547c6ae99SBarry Smith .   vec - the local vector
89647c6ae99SBarry Smith 
897073dac72SJed Brown     Level: beginner
89847c6ae99SBarry Smith 
899e727c939SJed Brown .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
90047c6ae99SBarry Smith 
90147c6ae99SBarry Smith @*/
9027087cfbeSBarry Smith PetscErrorCode  DMCreateLocalVector(DM dm,Vec *vec)
90347c6ae99SBarry Smith {
90447c6ae99SBarry Smith   PetscErrorCode ierr;
90547c6ae99SBarry Smith 
90647c6ae99SBarry Smith   PetscFunctionBegin;
907171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
90847c6ae99SBarry Smith   ierr = (*dm->ops->createlocalvector)(dm,vec);CHKERRQ(ierr);
90947c6ae99SBarry Smith   PetscFunctionReturn(0);
91047c6ae99SBarry Smith }
91147c6ae99SBarry Smith 
91247c6ae99SBarry Smith #undef __FUNCT__
9131411c6eeSJed Brown #define __FUNCT__ "DMGetLocalToGlobalMapping"
9141411c6eeSJed Brown /*@
9151411c6eeSJed Brown    DMGetLocalToGlobalMapping - Accesses the local-to-global mapping in a DM.
9161411c6eeSJed Brown 
9171411c6eeSJed Brown    Collective on DM
9181411c6eeSJed Brown 
9191411c6eeSJed Brown    Input Parameter:
9201411c6eeSJed Brown .  dm - the DM that provides the mapping
9211411c6eeSJed Brown 
9221411c6eeSJed Brown    Output Parameter:
9231411c6eeSJed Brown .  ltog - the mapping
9241411c6eeSJed Brown 
9251411c6eeSJed Brown    Level: intermediate
9261411c6eeSJed Brown 
9271411c6eeSJed Brown    Notes:
9281411c6eeSJed Brown    This mapping can then be used by VecSetLocalToGlobalMapping() or
9291411c6eeSJed Brown    MatSetLocalToGlobalMapping().
9301411c6eeSJed Brown 
931fc31e74dSBarry Smith .seealso: DMCreateLocalVector()
9321411c6eeSJed Brown @*/
9337087cfbeSBarry Smith PetscErrorCode DMGetLocalToGlobalMapping(DM dm,ISLocalToGlobalMapping *ltog)
9341411c6eeSJed Brown {
935bff27382SMatthew G. Knepley   PetscInt       bs = -1, bsLocal, bsMin, bsMax;
9361411c6eeSJed Brown   PetscErrorCode ierr;
9371411c6eeSJed Brown 
9381411c6eeSJed Brown   PetscFunctionBegin;
9391411c6eeSJed Brown   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
9401411c6eeSJed Brown   PetscValidPointer(ltog,2);
9411411c6eeSJed Brown   if (!dm->ltogmap) {
94237d0c07bSMatthew G Knepley     PetscSection section, sectionGlobal;
94337d0c07bSMatthew G Knepley 
94437d0c07bSMatthew G Knepley     ierr = DMGetDefaultSection(dm, &section);CHKERRQ(ierr);
94537d0c07bSMatthew G Knepley     if (section) {
946a974ec88SMatthew G. Knepley       const PetscInt *cdofs;
94737d0c07bSMatthew G Knepley       PetscInt       *ltog;
94837d0c07bSMatthew G Knepley       PetscInt        pStart, pEnd, size, p, l;
94937d0c07bSMatthew G Knepley 
95037d0c07bSMatthew G Knepley       ierr = DMGetDefaultGlobalSection(dm, &sectionGlobal);CHKERRQ(ierr);
95137d0c07bSMatthew G Knepley       ierr = PetscSectionGetChart(section, &pStart, &pEnd);CHKERRQ(ierr);
95237d0c07bSMatthew G Knepley       ierr = PetscSectionGetStorageSize(section, &size);CHKERRQ(ierr);
953785e854fSJed Brown       ierr = PetscMalloc1(size, &ltog);CHKERRQ(ierr); /* We want the local+overlap size */
95437d0c07bSMatthew G Knepley       for (p = pStart, l = 0; p < pEnd; ++p) {
955a974ec88SMatthew G. Knepley         PetscInt bdof, cdof, dof, off, c, cind = 0;
95637d0c07bSMatthew G Knepley 
95737d0c07bSMatthew G Knepley         /* Should probably use constrained dofs */
95837d0c07bSMatthew G Knepley         ierr = PetscSectionGetDof(section, p, &dof);CHKERRQ(ierr);
959a974ec88SMatthew G. Knepley         ierr = PetscSectionGetConstraintDof(section, p, &cdof);CHKERRQ(ierr);
960a974ec88SMatthew G. Knepley         ierr = PetscSectionGetConstraintIndices(section, p, &cdofs);CHKERRQ(ierr);
96137d0c07bSMatthew G Knepley         ierr = PetscSectionGetOffset(sectionGlobal, p, &off);CHKERRQ(ierr);
9621a7dc684SMatthew G. Knepley         /* If you have dofs, and constraints, and they are unequal, we set the blocksize to 1 */
9631a7dc684SMatthew G. Knepley         bdof = cdof && (dof-cdof) ? 1 : dof;
9641a7dc684SMatthew G. Knepley         if (dof) {
965b190aa46SMatthew G. Knepley           if (bs < 0)          {bs = bdof;}
966b190aa46SMatthew G. Knepley           else if (bs != bdof) {bs = 1;}
9671a7dc684SMatthew G. Knepley         }
96837d0c07bSMatthew G Knepley         for (c = 0; c < dof; ++c, ++l) {
969a974ec88SMatthew G. Knepley           if ((cind < cdof) && (c == cdofs[cind])) ltog[l] = off < 0 ? off-c : off+c;
970a974ec88SMatthew G. Knepley           else                                     ltog[l] = (off < 0 ? -(off+1) : off) + c;
97137d0c07bSMatthew G Knepley         }
97237d0c07bSMatthew G Knepley       }
973bff27382SMatthew G. Knepley       /* Must have same blocksize on all procs (some might have no points) */
974bff27382SMatthew G. Knepley       bsLocal = bs;
975bff27382SMatthew G. Knepley       ierr = MPIU_Allreduce(&bsLocal, &bsMax, 1, MPIU_INT, MPI_MAX, PetscObjectComm((PetscObject)dm));CHKERRQ(ierr);
976bff27382SMatthew G. Knepley       bsLocal = bs < 0 ? bsMax : bs;
977bff27382SMatthew G. Knepley       ierr = MPIU_Allreduce(&bsLocal, &bsMin, 1, MPIU_INT, MPI_MIN, PetscObjectComm((PetscObject)dm));CHKERRQ(ierr);
978bff27382SMatthew G. Knepley       if (bsMin != bsMax) {bs = 1;}
979bff27382SMatthew G. Knepley       else                {bs = bsMax;}
98000140cc3SStefano Zampini       ierr = ISLocalToGlobalMappingCreate(PetscObjectComm((PetscObject)dm), bs < 0 ? 1 : bs, size, ltog, PETSC_OWN_POINTER, &dm->ltogmap);CHKERRQ(ierr);
9813bb1ff40SBarry Smith       ierr = PetscLogObjectParent((PetscObject)dm, (PetscObject)dm->ltogmap);CHKERRQ(ierr);
98237d0c07bSMatthew G Knepley     } else {
983184d77edSJed Brown       if (!dm->ops->getlocaltoglobalmapping) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM can not create LocalToGlobalMapping");
984184d77edSJed Brown       ierr = (*dm->ops->getlocaltoglobalmapping)(dm);CHKERRQ(ierr);
9851411c6eeSJed Brown     }
98637d0c07bSMatthew G Knepley   }
9871411c6eeSJed Brown   *ltog = dm->ltogmap;
9881411c6eeSJed Brown   PetscFunctionReturn(0);
9891411c6eeSJed Brown }
9901411c6eeSJed Brown 
9911411c6eeSJed Brown #undef __FUNCT__
9921411c6eeSJed Brown #define __FUNCT__ "DMGetBlockSize"
9931411c6eeSJed Brown /*@
9941411c6eeSJed Brown    DMGetBlockSize - Gets the inherent block size associated with a DM
9951411c6eeSJed Brown 
9961411c6eeSJed Brown    Not Collective
9971411c6eeSJed Brown 
9981411c6eeSJed Brown    Input Parameter:
9991411c6eeSJed Brown .  dm - the DM with block structure
10001411c6eeSJed Brown 
10011411c6eeSJed Brown    Output Parameter:
10021411c6eeSJed Brown .  bs - the block size, 1 implies no exploitable block structure
10031411c6eeSJed Brown 
10041411c6eeSJed Brown    Level: intermediate
10051411c6eeSJed Brown 
1006fc31e74dSBarry Smith .seealso: ISCreateBlock(), VecSetBlockSize(), MatSetBlockSize(), DMGetLocalToGlobalMapping()
10071411c6eeSJed Brown @*/
10087087cfbeSBarry Smith PetscErrorCode  DMGetBlockSize(DM dm,PetscInt *bs)
10091411c6eeSJed Brown {
10101411c6eeSJed Brown   PetscFunctionBegin;
10111411c6eeSJed Brown   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
10121411c6eeSJed Brown   PetscValidPointer(bs,2);
10131411c6eeSJed 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");
10141411c6eeSJed Brown   *bs = dm->bs;
10151411c6eeSJed Brown   PetscFunctionReturn(0);
10161411c6eeSJed Brown }
10171411c6eeSJed Brown 
10181411c6eeSJed Brown #undef __FUNCT__
1019e727c939SJed Brown #define __FUNCT__ "DMCreateInterpolation"
102047c6ae99SBarry Smith /*@
10218472ad0fSDave May     DMCreateInterpolation - Gets interpolation matrix between two DM objects
102247c6ae99SBarry Smith 
102347c6ae99SBarry Smith     Collective on DM
102447c6ae99SBarry Smith 
102547c6ae99SBarry Smith     Input Parameter:
102647c6ae99SBarry Smith +   dm1 - the DM object
102747c6ae99SBarry Smith -   dm2 - the second, finer DM object
102847c6ae99SBarry Smith 
102947c6ae99SBarry Smith     Output Parameter:
103047c6ae99SBarry Smith +  mat - the interpolation
103147c6ae99SBarry Smith -  vec - the scaling (optional)
103247c6ae99SBarry Smith 
103347c6ae99SBarry Smith     Level: developer
103447c6ae99SBarry Smith 
103585afcc9aSBarry 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
103685afcc9aSBarry Smith         DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the interpolation.
1037d52bd9f3SBarry Smith 
10381f588964SMatthew G Knepley         For DMDA objects you can use this interpolation (more precisely the interpolation from the DMGetCoordinateDM()) to interpolate the mesh coordinate vectors
1039d52bd9f3SBarry Smith         EXCEPT in the periodic case where it does not make sense since the coordinate vectors are not periodic.
104085afcc9aSBarry Smith 
104185afcc9aSBarry Smith 
10423ad4599aSBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateRestriction()
104347c6ae99SBarry Smith 
104447c6ae99SBarry Smith @*/
1045e727c939SJed Brown PetscErrorCode  DMCreateInterpolation(DM dm1,DM dm2,Mat *mat,Vec *vec)
104647c6ae99SBarry Smith {
104747c6ae99SBarry Smith   PetscErrorCode ierr;
104847c6ae99SBarry Smith 
104947c6ae99SBarry Smith   PetscFunctionBegin;
1050171400e9SBarry Smith   PetscValidHeaderSpecific(dm1,DM_CLASSID,1);
1051171400e9SBarry Smith   PetscValidHeaderSpecific(dm2,DM_CLASSID,2);
1052cea54e9dSPatrick Farrell   ierr = PetscLogEventBegin(DM_CreateInterpolation,dm1,dm2,0,0);CHKERRQ(ierr);
105325296bd5SBarry Smith   ierr = (*dm1->ops->createinterpolation)(dm1,dm2,mat,vec);CHKERRQ(ierr);
1054cea54e9dSPatrick Farrell   ierr = PetscLogEventEnd(DM_CreateInterpolation,dm1,dm2,0,0);CHKERRQ(ierr);
105547c6ae99SBarry Smith   PetscFunctionReturn(0);
105647c6ae99SBarry Smith }
105747c6ae99SBarry Smith 
105847c6ae99SBarry Smith #undef __FUNCT__
10593ad4599aSBarry Smith #define __FUNCT__ "DMCreateRestriction"
10603ad4599aSBarry Smith /*@
10613ad4599aSBarry Smith     DMCreateRestriction - Gets restriction matrix between two DM objects
10623ad4599aSBarry Smith 
10633ad4599aSBarry Smith     Collective on DM
10643ad4599aSBarry Smith 
10653ad4599aSBarry Smith     Input Parameter:
10663ad4599aSBarry Smith +   dm1 - the DM object
10673ad4599aSBarry Smith -   dm2 - the second, finer DM object
10683ad4599aSBarry Smith 
10693ad4599aSBarry Smith     Output Parameter:
10703ad4599aSBarry Smith .  mat - the restriction
10713ad4599aSBarry Smith 
10723ad4599aSBarry Smith 
10733ad4599aSBarry Smith     Level: developer
10743ad4599aSBarry Smith 
10753ad4599aSBarry 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
10763ad4599aSBarry Smith         DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the interpolation.
10773ad4599aSBarry Smith 
10783ad4599aSBarry Smith 
10793ad4599aSBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateInterpolation()
10803ad4599aSBarry Smith 
10813ad4599aSBarry Smith @*/
10823ad4599aSBarry Smith PetscErrorCode  DMCreateRestriction(DM dm1,DM dm2,Mat *mat)
10833ad4599aSBarry Smith {
10843ad4599aSBarry Smith   PetscErrorCode ierr;
10853ad4599aSBarry Smith 
10863ad4599aSBarry Smith   PetscFunctionBegin;
10873ad4599aSBarry Smith   PetscValidHeaderSpecific(dm1,DM_CLASSID,1);
10883ad4599aSBarry Smith   PetscValidHeaderSpecific(dm2,DM_CLASSID,2);
10893ad4599aSBarry Smith   ierr = PetscLogEventBegin(DM_CreateRestriction,dm1,dm2,0,0);CHKERRQ(ierr);
10903ad4599aSBarry Smith   ierr = (*dm1->ops->createrestriction)(dm1,dm2,mat);CHKERRQ(ierr);
10913ad4599aSBarry Smith   ierr = PetscLogEventEnd(DM_CreateRestriction,dm1,dm2,0,0);CHKERRQ(ierr);
10923ad4599aSBarry Smith   PetscFunctionReturn(0);
10933ad4599aSBarry Smith }
10943ad4599aSBarry Smith 
10953ad4599aSBarry Smith #undef __FUNCT__
1096e727c939SJed Brown #define __FUNCT__ "DMCreateInjection"
109747c6ae99SBarry Smith /*@
10988472ad0fSDave May     DMCreateInjection - Gets injection matrix between two DM objects
109947c6ae99SBarry Smith 
110047c6ae99SBarry Smith     Collective on DM
110147c6ae99SBarry Smith 
110247c6ae99SBarry Smith     Input Parameter:
110347c6ae99SBarry Smith +   dm1 - the DM object
110447c6ae99SBarry Smith -   dm2 - the second, finer DM object
110547c6ae99SBarry Smith 
110647c6ae99SBarry Smith     Output Parameter:
11076dbf9973SLawrence Mitchell .   mat - the injection
110847c6ae99SBarry Smith 
110947c6ae99SBarry Smith     Level: developer
111047c6ae99SBarry Smith 
111185afcc9aSBarry 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
111285afcc9aSBarry Smith         DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the injection.
111385afcc9aSBarry Smith 
1114e727c939SJed Brown .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMCreateInterpolation()
111547c6ae99SBarry Smith 
111647c6ae99SBarry Smith @*/
11176dbf9973SLawrence Mitchell PetscErrorCode  DMCreateInjection(DM dm1,DM dm2,Mat *mat)
111847c6ae99SBarry Smith {
111947c6ae99SBarry Smith   PetscErrorCode ierr;
112047c6ae99SBarry Smith 
112147c6ae99SBarry Smith   PetscFunctionBegin;
1122171400e9SBarry Smith   PetscValidHeaderSpecific(dm1,DM_CLASSID,1);
1123171400e9SBarry Smith   PetscValidHeaderSpecific(dm2,DM_CLASSID,2);
11240c4c9125SBarry Smith   if (!dm1->ops->getinjection) SETERRQ(PetscObjectComm((PetscObject)dm1),PETSC_ERR_SUP,"DMCreateInjection not implemented for this type");
11256dbf9973SLawrence Mitchell   ierr = (*dm1->ops->getinjection)(dm1,dm2,mat);CHKERRQ(ierr);
112647c6ae99SBarry Smith   PetscFunctionReturn(0);
112747c6ae99SBarry Smith }
112847c6ae99SBarry Smith 
112947c6ae99SBarry Smith #undef __FUNCT__
1130e727c939SJed Brown #define __FUNCT__ "DMCreateColoring"
1131b412c318SBarry Smith /*@
1132b412c318SBarry Smith     DMCreateColoring - Gets coloring for a DM
113347c6ae99SBarry Smith 
113447c6ae99SBarry Smith     Collective on DM
113547c6ae99SBarry Smith 
113647c6ae99SBarry Smith     Input Parameter:
113747c6ae99SBarry Smith +   dm - the DM object
11385bdb020cSBarry Smith -   ctype - IS_COLORING_LOCAL or IS_COLORING_GLOBAL
113947c6ae99SBarry Smith 
114047c6ae99SBarry Smith     Output Parameter:
114147c6ae99SBarry Smith .   coloring - the coloring
114247c6ae99SBarry Smith 
114347c6ae99SBarry Smith     Level: developer
114447c6ae99SBarry Smith 
1145b412c318SBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateMatrix(), DMSetMatType()
114647c6ae99SBarry Smith 
1147aab9d709SJed Brown @*/
1148b412c318SBarry Smith PetscErrorCode  DMCreateColoring(DM dm,ISColoringType ctype,ISColoring *coloring)
114947c6ae99SBarry Smith {
115047c6ae99SBarry Smith   PetscErrorCode ierr;
115147c6ae99SBarry Smith 
115247c6ae99SBarry Smith   PetscFunctionBegin;
1153171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1154ce94432eSBarry Smith   if (!dm->ops->getcoloring) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"No coloring for this type of DM yet");
1155b412c318SBarry Smith   ierr = (*dm->ops->getcoloring)(dm,ctype,coloring);CHKERRQ(ierr);
115647c6ae99SBarry Smith   PetscFunctionReturn(0);
115747c6ae99SBarry Smith }
115847c6ae99SBarry Smith 
115947c6ae99SBarry Smith #undef __FUNCT__
1160950540a4SJed Brown #define __FUNCT__ "DMCreateMatrix"
1161b412c318SBarry Smith /*@
11628472ad0fSDave May     DMCreateMatrix - Gets empty Jacobian for a DM
116347c6ae99SBarry Smith 
116447c6ae99SBarry Smith     Collective on DM
116547c6ae99SBarry Smith 
116647c6ae99SBarry Smith     Input Parameter:
1167b412c318SBarry Smith .   dm - the DM object
116847c6ae99SBarry Smith 
116947c6ae99SBarry Smith     Output Parameter:
117047c6ae99SBarry Smith .   mat - the empty Jacobian
117147c6ae99SBarry Smith 
1172073dac72SJed Brown     Level: beginner
117347c6ae99SBarry Smith 
117494013140SBarry Smith     Notes: This properly preallocates the number of nonzeros in the sparse matrix so you
117594013140SBarry Smith        do not need to do it yourself.
117694013140SBarry Smith 
117794013140SBarry Smith        By default it also sets the nonzero structure and puts in the zero entries. To prevent setting
1178*7889ec69SBarry Smith        the nonzero pattern call DMSetMatrixPreallocateOnly()
117994013140SBarry Smith 
118094013140SBarry 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
118194013140SBarry Smith        internally by PETSc.
118294013140SBarry Smith 
118394013140SBarry Smith        For structured grid problems, in general it is easiest to use MatSetValuesStencil() or MatSetValuesLocal() to put values into the matrix because MatSetValues() requires
1184aa219208SBarry Smith        the indices for the global numbering for DMDAs which is complicated.
118594013140SBarry Smith 
1186b412c318SBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMSetMatType()
118747c6ae99SBarry Smith 
1188aab9d709SJed Brown @*/
1189b412c318SBarry Smith PetscErrorCode  DMCreateMatrix(DM dm,Mat *mat)
119047c6ae99SBarry Smith {
119147c6ae99SBarry Smith   PetscErrorCode ierr;
119247c6ae99SBarry Smith 
119347c6ae99SBarry Smith   PetscFunctionBegin;
1194171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1195607a6623SBarry Smith   ierr = MatInitializePackage();CHKERRQ(ierr);
1196c7b7c8a4SJed Brown   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1197c7b7c8a4SJed Brown   PetscValidPointer(mat,3);
1198b412c318SBarry Smith   ierr = (*dm->ops->creatematrix)(dm,mat);CHKERRQ(ierr);
119947c6ae99SBarry Smith   PetscFunctionReturn(0);
120047c6ae99SBarry Smith }
120147c6ae99SBarry Smith 
120247c6ae99SBarry Smith #undef __FUNCT__
1203732e2eb9SMatthew G Knepley #define __FUNCT__ "DMSetMatrixPreallocateOnly"
1204732e2eb9SMatthew G Knepley /*@
1205950540a4SJed Brown   DMSetMatrixPreallocateOnly - When DMCreateMatrix() is called the matrix will be properly
1206732e2eb9SMatthew G Knepley     preallocated but the nonzero structure and zero values will not be set.
1207732e2eb9SMatthew G Knepley 
12088472ad0fSDave May   Logically Collective on DM
1209732e2eb9SMatthew G Knepley 
1210732e2eb9SMatthew G Knepley   Input Parameter:
1211732e2eb9SMatthew G Knepley + dm - the DM
1212732e2eb9SMatthew G Knepley - only - PETSC_TRUE if only want preallocation
1213732e2eb9SMatthew G Knepley 
1214732e2eb9SMatthew G Knepley   Level: developer
1215950540a4SJed Brown .seealso DMCreateMatrix()
1216732e2eb9SMatthew G Knepley @*/
1217732e2eb9SMatthew G Knepley PetscErrorCode DMSetMatrixPreallocateOnly(DM dm, PetscBool only)
1218732e2eb9SMatthew G Knepley {
1219732e2eb9SMatthew G Knepley   PetscFunctionBegin;
1220732e2eb9SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1221732e2eb9SMatthew G Knepley   dm->prealloc_only = only;
1222732e2eb9SMatthew G Knepley   PetscFunctionReturn(0);
1223732e2eb9SMatthew G Knepley }
1224732e2eb9SMatthew G Knepley 
1225732e2eb9SMatthew G Knepley #undef __FUNCT__
1226a89ea682SMatthew G Knepley #define __FUNCT__ "DMGetWorkArray"
1227a89ea682SMatthew G Knepley /*@C
1228aa1993deSMatthew G Knepley   DMGetWorkArray - Gets a work array guaranteed to be at least the input size, restore with DMRestoreWorkArray()
1229a89ea682SMatthew G Knepley 
1230a89ea682SMatthew G Knepley   Not Collective
1231a89ea682SMatthew G Knepley 
1232a89ea682SMatthew G Knepley   Input Parameters:
1233a89ea682SMatthew G Knepley + dm - the DM object
1234aa1993deSMatthew G Knepley . count - The minium size
1235aa1993deSMatthew G Knepley - dtype - data type (PETSC_REAL, PETSC_SCALAR, PETSC_INT)
1236a89ea682SMatthew G Knepley 
1237a89ea682SMatthew G Knepley   Output Parameter:
1238a89ea682SMatthew G Knepley . array - the work array
1239a89ea682SMatthew G Knepley 
1240a89ea682SMatthew G Knepley   Level: developer
1241a89ea682SMatthew G Knepley 
1242a89ea682SMatthew G Knepley .seealso DMDestroy(), DMCreate()
1243a89ea682SMatthew G Knepley @*/
1244aa1993deSMatthew G Knepley PetscErrorCode DMGetWorkArray(DM dm,PetscInt count,PetscDataType dtype,void *mem)
1245a89ea682SMatthew G Knepley {
1246a89ea682SMatthew G Knepley   PetscErrorCode ierr;
1247aa1993deSMatthew G Knepley   DMWorkLink     link;
1248854ce69bSBarry Smith   size_t         dsize;
1249a89ea682SMatthew G Knepley 
1250a89ea682SMatthew G Knepley   PetscFunctionBegin;
1251a89ea682SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1252aa1993deSMatthew G Knepley   PetscValidPointer(mem,4);
1253aa1993deSMatthew G Knepley   if (dm->workin) {
1254aa1993deSMatthew G Knepley     link       = dm->workin;
1255aa1993deSMatthew G Knepley     dm->workin = dm->workin->next;
1256aa1993deSMatthew G Knepley   } else {
1257b00a9115SJed Brown     ierr = PetscNewLog(dm,&link);CHKERRQ(ierr);
1258a89ea682SMatthew G Knepley   }
1259854ce69bSBarry Smith   ierr = PetscDataTypeGetSize(dtype,&dsize);CHKERRQ(ierr);
1260854ce69bSBarry Smith   if (dsize*count > link->bytes) {
1261aa1993deSMatthew G Knepley     ierr        = PetscFree(link->mem);CHKERRQ(ierr);
1262854ce69bSBarry Smith     ierr        = PetscMalloc(dsize*count,&link->mem);CHKERRQ(ierr);
1263854ce69bSBarry Smith     link->bytes = dsize*count;
1264aa1993deSMatthew G Knepley   }
1265aa1993deSMatthew G Knepley   link->next   = dm->workout;
1266aa1993deSMatthew G Knepley   dm->workout  = link;
1267aa1993deSMatthew G Knepley   *(void**)mem = link->mem;
1268a89ea682SMatthew G Knepley   PetscFunctionReturn(0);
1269a89ea682SMatthew G Knepley }
1270a89ea682SMatthew G Knepley 
1271aa1993deSMatthew G Knepley #undef __FUNCT__
1272aa1993deSMatthew G Knepley #define __FUNCT__ "DMRestoreWorkArray"
1273aa1993deSMatthew G Knepley /*@C
1274aa1993deSMatthew G Knepley   DMRestoreWorkArray - Restores a work array guaranteed to be at least the input size, restore with DMRestoreWorkArray()
1275aa1993deSMatthew G Knepley 
1276aa1993deSMatthew G Knepley   Not Collective
1277aa1993deSMatthew G Knepley 
1278aa1993deSMatthew G Knepley   Input Parameters:
1279aa1993deSMatthew G Knepley + dm - the DM object
1280aa1993deSMatthew G Knepley . count - The minium size
1281aa1993deSMatthew G Knepley - dtype - data type (PETSC_REAL, PETSC_SCALAR, PETSC_INT)
1282aa1993deSMatthew G Knepley 
1283aa1993deSMatthew G Knepley   Output Parameter:
1284aa1993deSMatthew G Knepley . array - the work array
1285aa1993deSMatthew G Knepley 
1286aa1993deSMatthew G Knepley   Level: developer
1287aa1993deSMatthew G Knepley 
1288aa1993deSMatthew G Knepley .seealso DMDestroy(), DMCreate()
1289aa1993deSMatthew G Knepley @*/
1290aa1993deSMatthew G Knepley PetscErrorCode DMRestoreWorkArray(DM dm,PetscInt count,PetscDataType dtype,void *mem)
1291aa1993deSMatthew G Knepley {
1292aa1993deSMatthew G Knepley   DMWorkLink *p,link;
1293aa1993deSMatthew G Knepley 
1294aa1993deSMatthew G Knepley   PetscFunctionBegin;
1295aa1993deSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1296aa1993deSMatthew G Knepley   PetscValidPointer(mem,4);
1297aa1993deSMatthew G Knepley   for (p=&dm->workout; (link=*p); p=&link->next) {
1298aa1993deSMatthew G Knepley     if (link->mem == *(void**)mem) {
1299aa1993deSMatthew G Knepley       *p           = link->next;
1300aa1993deSMatthew G Knepley       link->next   = dm->workin;
1301aa1993deSMatthew G Knepley       dm->workin   = link;
13020298fd71SBarry Smith       *(void**)mem = NULL;
1303aa1993deSMatthew G Knepley       PetscFunctionReturn(0);
1304aa1993deSMatthew G Knepley     }
1305aa1993deSMatthew G Knepley   }
1306aa1993deSMatthew G Knepley   SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Array was not checked out");
1307aa1993deSMatthew G Knepley }
1308e7c4fc90SDmitry Karpeev 
1309e7c4fc90SDmitry Karpeev #undef __FUNCT__
1310435a35e8SMatthew G Knepley #define __FUNCT__ "DMSetNullSpaceConstructor"
1311435a35e8SMatthew G Knepley PetscErrorCode DMSetNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (*nullsp)(DM dm, PetscInt field, MatNullSpace *nullSpace))
1312435a35e8SMatthew G Knepley {
1313435a35e8SMatthew G Knepley   PetscFunctionBegin;
1314435a35e8SMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
131582f516ccSBarry Smith   if (field >= 10) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field);
1316435a35e8SMatthew G Knepley   dm->nullspaceConstructors[field] = nullsp;
1317435a35e8SMatthew G Knepley   PetscFunctionReturn(0);
1318435a35e8SMatthew G Knepley }
1319435a35e8SMatthew G Knepley 
1320435a35e8SMatthew G Knepley #undef __FUNCT__
13214d343eeaSMatthew G Knepley #define __FUNCT__ "DMCreateFieldIS"
13224f3b5142SJed Brown /*@C
13234d343eeaSMatthew G Knepley   DMCreateFieldIS - Creates a set of IS objects with the global indices of dofs for each field
13244d343eeaSMatthew G Knepley 
13254d343eeaSMatthew G Knepley   Not collective
13264d343eeaSMatthew G Knepley 
13274d343eeaSMatthew G Knepley   Input Parameter:
13284d343eeaSMatthew G Knepley . dm - the DM object
13294d343eeaSMatthew G Knepley 
13304d343eeaSMatthew G Knepley   Output Parameters:
13310298fd71SBarry Smith + numFields  - The number of fields (or NULL if not requested)
13320298fd71SBarry Smith . fieldNames - The name for each field (or NULL if not requested)
13330298fd71SBarry Smith - fields     - The global indices for each field (or NULL if not requested)
13344d343eeaSMatthew G Knepley 
13354d343eeaSMatthew G Knepley   Level: intermediate
13364d343eeaSMatthew G Knepley 
133721c9b008SJed Brown   Notes:
133821c9b008SJed Brown   The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with
133921c9b008SJed Brown   PetscFree(), every entry of fields should be destroyed with ISDestroy(), and both arrays should be freed with
134021c9b008SJed Brown   PetscFree().
134121c9b008SJed Brown 
13424d343eeaSMatthew G Knepley .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
13434d343eeaSMatthew G Knepley @*/
134437d0c07bSMatthew G Knepley PetscErrorCode DMCreateFieldIS(DM dm, PetscInt *numFields, char ***fieldNames, IS **fields)
13454d343eeaSMatthew G Knepley {
134637d0c07bSMatthew G Knepley   PetscSection   section, sectionGlobal;
13474d343eeaSMatthew G Knepley   PetscErrorCode ierr;
13484d343eeaSMatthew G Knepley 
13494d343eeaSMatthew G Knepley   PetscFunctionBegin;
13504d343eeaSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
135169ca1f37SDmitry Karpeev   if (numFields) {
135269ca1f37SDmitry Karpeev     PetscValidPointer(numFields,2);
135369ca1f37SDmitry Karpeev     *numFields = 0;
135469ca1f37SDmitry Karpeev   }
135537d0c07bSMatthew G Knepley   if (fieldNames) {
135637d0c07bSMatthew G Knepley     PetscValidPointer(fieldNames,3);
13570298fd71SBarry Smith     *fieldNames = NULL;
135869ca1f37SDmitry Karpeev   }
135969ca1f37SDmitry Karpeev   if (fields) {
136069ca1f37SDmitry Karpeev     PetscValidPointer(fields,4);
13610298fd71SBarry Smith     *fields = NULL;
136269ca1f37SDmitry Karpeev   }
136337d0c07bSMatthew G Knepley   ierr = DMGetDefaultSection(dm, &section);CHKERRQ(ierr);
136437d0c07bSMatthew G Knepley   if (section) {
136537d0c07bSMatthew G Knepley     PetscInt *fieldSizes, **fieldIndices;
136637d0c07bSMatthew G Knepley     PetscInt nF, f, pStart, pEnd, p;
136737d0c07bSMatthew G Knepley 
136837d0c07bSMatthew G Knepley     ierr = DMGetDefaultGlobalSection(dm, &sectionGlobal);CHKERRQ(ierr);
136937d0c07bSMatthew G Knepley     ierr = PetscSectionGetNumFields(section, &nF);CHKERRQ(ierr);
1370dcca6d9dSJed Brown     ierr = PetscMalloc2(nF,&fieldSizes,nF,&fieldIndices);CHKERRQ(ierr);
137137d0c07bSMatthew G Knepley     ierr = PetscSectionGetChart(sectionGlobal, &pStart, &pEnd);CHKERRQ(ierr);
137237d0c07bSMatthew G Knepley     for (f = 0; f < nF; ++f) {
137337d0c07bSMatthew G Knepley       fieldSizes[f] = 0;
137437d0c07bSMatthew G Knepley     }
137537d0c07bSMatthew G Knepley     for (p = pStart; p < pEnd; ++p) {
137637d0c07bSMatthew G Knepley       PetscInt gdof;
137737d0c07bSMatthew G Knepley 
137837d0c07bSMatthew G Knepley       ierr = PetscSectionGetDof(sectionGlobal, p, &gdof);CHKERRQ(ierr);
137937d0c07bSMatthew G Knepley       if (gdof > 0) {
138037d0c07bSMatthew G Knepley         for (f = 0; f < nF; ++f) {
138137d0c07bSMatthew G Knepley           PetscInt fdof, fcdof;
138237d0c07bSMatthew G Knepley 
138337d0c07bSMatthew G Knepley           ierr           = PetscSectionGetFieldDof(section, p, f, &fdof);CHKERRQ(ierr);
138437d0c07bSMatthew G Knepley           ierr           = PetscSectionGetFieldConstraintDof(section, p, f, &fcdof);CHKERRQ(ierr);
138537d0c07bSMatthew G Knepley           fieldSizes[f] += fdof-fcdof;
138637d0c07bSMatthew G Knepley         }
138737d0c07bSMatthew G Knepley       }
138837d0c07bSMatthew G Knepley     }
138937d0c07bSMatthew G Knepley     for (f = 0; f < nF; ++f) {
1390785e854fSJed Brown       ierr          = PetscMalloc1(fieldSizes[f], &fieldIndices[f]);CHKERRQ(ierr);
139137d0c07bSMatthew G Knepley       fieldSizes[f] = 0;
139237d0c07bSMatthew G Knepley     }
139337d0c07bSMatthew G Knepley     for (p = pStart; p < pEnd; ++p) {
139437d0c07bSMatthew G Knepley       PetscInt gdof, goff;
139537d0c07bSMatthew G Knepley 
139637d0c07bSMatthew G Knepley       ierr = PetscSectionGetDof(sectionGlobal, p, &gdof);CHKERRQ(ierr);
139737d0c07bSMatthew G Knepley       if (gdof > 0) {
139837d0c07bSMatthew G Knepley         ierr = PetscSectionGetOffset(sectionGlobal, p, &goff);CHKERRQ(ierr);
139937d0c07bSMatthew G Knepley         for (f = 0; f < nF; ++f) {
140037d0c07bSMatthew G Knepley           PetscInt fdof, fcdof, fc;
140137d0c07bSMatthew G Knepley 
140237d0c07bSMatthew G Knepley           ierr = PetscSectionGetFieldDof(section, p, f, &fdof);CHKERRQ(ierr);
140337d0c07bSMatthew G Knepley           ierr = PetscSectionGetFieldConstraintDof(section, p, f, &fcdof);CHKERRQ(ierr);
140437d0c07bSMatthew G Knepley           for (fc = 0; fc < fdof-fcdof; ++fc, ++fieldSizes[f]) {
140537d0c07bSMatthew G Knepley             fieldIndices[f][fieldSizes[f]] = goff++;
140637d0c07bSMatthew G Knepley           }
140737d0c07bSMatthew G Knepley         }
140837d0c07bSMatthew G Knepley       }
140937d0c07bSMatthew G Knepley     }
14108865f1eaSKarl Rupp     if (numFields) *numFields = nF;
141137d0c07bSMatthew G Knepley     if (fieldNames) {
1412785e854fSJed Brown       ierr = PetscMalloc1(nF, fieldNames);CHKERRQ(ierr);
141337d0c07bSMatthew G Knepley       for (f = 0; f < nF; ++f) {
141437d0c07bSMatthew G Knepley         const char *fieldName;
141537d0c07bSMatthew G Knepley 
141637d0c07bSMatthew G Knepley         ierr = PetscSectionGetFieldName(section, f, &fieldName);CHKERRQ(ierr);
141737d0c07bSMatthew G Knepley         ierr = PetscStrallocpy(fieldName, (char**) &(*fieldNames)[f]);CHKERRQ(ierr);
141837d0c07bSMatthew G Knepley       }
141937d0c07bSMatthew G Knepley     }
142037d0c07bSMatthew G Knepley     if (fields) {
1421785e854fSJed Brown       ierr = PetscMalloc1(nF, fields);CHKERRQ(ierr);
142237d0c07bSMatthew G Knepley       for (f = 0; f < nF; ++f) {
142382f516ccSBarry Smith         ierr = ISCreateGeneral(PetscObjectComm((PetscObject)dm), fieldSizes[f], fieldIndices[f], PETSC_OWN_POINTER, &(*fields)[f]);CHKERRQ(ierr);
142437d0c07bSMatthew G Knepley       }
142537d0c07bSMatthew G Knepley     }
142637d0c07bSMatthew G Knepley     ierr = PetscFree2(fieldSizes,fieldIndices);CHKERRQ(ierr);
14278865f1eaSKarl Rupp   } else if (dm->ops->createfieldis) {
14288865f1eaSKarl Rupp     ierr = (*dm->ops->createfieldis)(dm, numFields, fieldNames, fields);CHKERRQ(ierr);
142969ca1f37SDmitry Karpeev   }
14304d343eeaSMatthew G Knepley   PetscFunctionReturn(0);
14314d343eeaSMatthew G Knepley }
14324d343eeaSMatthew G Knepley 
143316621825SDmitry Karpeev 
143416621825SDmitry Karpeev #undef __FUNCT__
143516621825SDmitry Karpeev #define __FUNCT__ "DMCreateFieldDecomposition"
143616621825SDmitry Karpeev /*@C
143716621825SDmitry Karpeev   DMCreateFieldDecomposition - Returns a list of IS objects defining a decomposition of a problem into subproblems
143816621825SDmitry Karpeev                           corresponding to different fields: each IS contains the global indices of the dofs of the
143916621825SDmitry Karpeev                           corresponding field. The optional list of DMs define the DM for each subproblem.
1440e7c4fc90SDmitry Karpeev                           Generalizes DMCreateFieldIS().
1441e7c4fc90SDmitry Karpeev 
1442e7c4fc90SDmitry Karpeev   Not collective
1443e7c4fc90SDmitry Karpeev 
1444e7c4fc90SDmitry Karpeev   Input Parameter:
1445e7c4fc90SDmitry Karpeev . dm - the DM object
1446e7c4fc90SDmitry Karpeev 
1447e7c4fc90SDmitry Karpeev   Output Parameters:
14480298fd71SBarry Smith + len       - The number of subproblems in the field decomposition (or NULL if not requested)
14490298fd71SBarry Smith . namelist  - The name for each field (or NULL if not requested)
14500298fd71SBarry Smith . islist    - The global indices for each field (or NULL if not requested)
14510298fd71SBarry Smith - dmlist    - The DMs for each field subproblem (or NULL, if not requested; if NULL is returned, no DMs are defined)
1452e7c4fc90SDmitry Karpeev 
1453e7c4fc90SDmitry Karpeev   Level: intermediate
1454e7c4fc90SDmitry Karpeev 
1455e7c4fc90SDmitry Karpeev   Notes:
1456e7c4fc90SDmitry Karpeev   The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with
1457e7c4fc90SDmitry Karpeev   PetscFree(), every entry of is should be destroyed with ISDestroy(), every entry of dm should be destroyed with DMDestroy(),
1458e7c4fc90SDmitry Karpeev   and all of the arrays should be freed with PetscFree().
1459e7c4fc90SDmitry Karpeev 
1460e7c4fc90SDmitry Karpeev .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS()
1461e7c4fc90SDmitry Karpeev @*/
146216621825SDmitry Karpeev PetscErrorCode DMCreateFieldDecomposition(DM dm, PetscInt *len, char ***namelist, IS **islist, DM **dmlist)
1463e7c4fc90SDmitry Karpeev {
1464e7c4fc90SDmitry Karpeev   PetscErrorCode ierr;
1465e7c4fc90SDmitry Karpeev 
1466e7c4fc90SDmitry Karpeev   PetscFunctionBegin;
1467e7c4fc90SDmitry Karpeev   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
14688865f1eaSKarl Rupp   if (len) {
14698865f1eaSKarl Rupp     PetscValidPointer(len,2);
14708865f1eaSKarl Rupp     *len = 0;
14718865f1eaSKarl Rupp   }
14728865f1eaSKarl Rupp   if (namelist) {
14738865f1eaSKarl Rupp     PetscValidPointer(namelist,3);
14748865f1eaSKarl Rupp     *namelist = 0;
14758865f1eaSKarl Rupp   }
14768865f1eaSKarl Rupp   if (islist) {
14778865f1eaSKarl Rupp     PetscValidPointer(islist,4);
14788865f1eaSKarl Rupp     *islist = 0;
14798865f1eaSKarl Rupp   }
14808865f1eaSKarl Rupp   if (dmlist) {
14818865f1eaSKarl Rupp     PetscValidPointer(dmlist,5);
14828865f1eaSKarl Rupp     *dmlist = 0;
14838865f1eaSKarl Rupp   }
1484f3f0edfdSDmitry Karpeev   /*
1485f3f0edfdSDmitry Karpeev    Is it a good idea to apply the following check across all impls?
1486f3f0edfdSDmitry Karpeev    Perhaps some impls can have a well-defined decomposition before DMSetUp?
1487f3f0edfdSDmitry Karpeev    This, however, follows the general principle that accessors are not well-behaved until the object is set up.
1488f3f0edfdSDmitry Karpeev    */
1489ce94432eSBarry Smith   if (!dm->setupcalled) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_WRONGSTATE, "Decomposition defined only after DMSetUp");
149016621825SDmitry Karpeev   if (!dm->ops->createfielddecomposition) {
1491435a35e8SMatthew G Knepley     PetscSection section;
1492435a35e8SMatthew G Knepley     PetscInt     numFields, f;
1493435a35e8SMatthew G Knepley 
1494435a35e8SMatthew G Knepley     ierr = DMGetDefaultSection(dm, &section);CHKERRQ(ierr);
1495435a35e8SMatthew G Knepley     if (section) {ierr = PetscSectionGetNumFields(section, &numFields);CHKERRQ(ierr);}
1496435a35e8SMatthew G Knepley     if (section && numFields && dm->ops->createsubdm) {
1497f25d98f1SMatthew G. Knepley       if (len) *len = numFields;
149803dc3394SMatthew G. Knepley       if (namelist) {ierr = PetscMalloc1(numFields,namelist);CHKERRQ(ierr);}
149903dc3394SMatthew G. Knepley       if (islist)   {ierr = PetscMalloc1(numFields,islist);CHKERRQ(ierr);}
150003dc3394SMatthew G. Knepley       if (dmlist)   {ierr = PetscMalloc1(numFields,dmlist);CHKERRQ(ierr);}
1501435a35e8SMatthew G Knepley       for (f = 0; f < numFields; ++f) {
1502435a35e8SMatthew G Knepley         const char *fieldName;
1503435a35e8SMatthew G Knepley 
150403dc3394SMatthew G. Knepley         ierr = DMCreateSubDM(dm, 1, &f, islist ? &(*islist)[f] : NULL, dmlist ? &(*dmlist)[f] : NULL);CHKERRQ(ierr);
150503dc3394SMatthew G. Knepley         if (namelist) {
1506435a35e8SMatthew G Knepley           ierr = PetscSectionGetFieldName(section, f, &fieldName);CHKERRQ(ierr);
1507435a35e8SMatthew G Knepley           ierr = PetscStrallocpy(fieldName, (char**) &(*namelist)[f]);CHKERRQ(ierr);
1508435a35e8SMatthew G Knepley         }
150903dc3394SMatthew G. Knepley       }
1510435a35e8SMatthew G Knepley     } else {
151169ca1f37SDmitry Karpeev       ierr = DMCreateFieldIS(dm, len, namelist, islist);CHKERRQ(ierr);
1512e7c4fc90SDmitry Karpeev       /* By default there are no DMs associated with subproblems. */
15130298fd71SBarry Smith       if (dmlist) *dmlist = NULL;
1514e7c4fc90SDmitry Karpeev     }
15158865f1eaSKarl Rupp   } else {
151616621825SDmitry Karpeev     ierr = (*dm->ops->createfielddecomposition)(dm,len,namelist,islist,dmlist);CHKERRQ(ierr);
151716621825SDmitry Karpeev   }
151816621825SDmitry Karpeev   PetscFunctionReturn(0);
151916621825SDmitry Karpeev }
152016621825SDmitry Karpeev 
152116621825SDmitry Karpeev #undef __FUNCT__
1522435a35e8SMatthew G Knepley #define __FUNCT__ "DMCreateSubDM"
1523564cec59SMatthew G. Knepley /*@
1524435a35e8SMatthew G Knepley   DMCreateSubDM - Returns an IS and DM encapsulating a subproblem defined by the fields passed in.
1525435a35e8SMatthew G Knepley                   The fields are defined by DMCreateFieldIS().
1526435a35e8SMatthew G Knepley 
1527435a35e8SMatthew G Knepley   Not collective
1528435a35e8SMatthew G Knepley 
1529435a35e8SMatthew G Knepley   Input Parameters:
1530435a35e8SMatthew G Knepley + dm - the DM object
1531435a35e8SMatthew G Knepley . numFields - number of fields in this subproblem
15320298fd71SBarry Smith - len       - The number of subproblems in the decomposition (or NULL if not requested)
1533435a35e8SMatthew G Knepley 
1534435a35e8SMatthew G Knepley   Output Parameters:
1535435a35e8SMatthew G Knepley . is - The global indices for the subproblem
1536435a35e8SMatthew G Knepley - dm - The DM for the subproblem
1537435a35e8SMatthew G Knepley 
1538435a35e8SMatthew G Knepley   Level: intermediate
1539435a35e8SMatthew G Knepley 
1540435a35e8SMatthew G Knepley .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS()
1541435a35e8SMatthew G Knepley @*/
1542435a35e8SMatthew G Knepley PetscErrorCode DMCreateSubDM(DM dm, PetscInt numFields, PetscInt fields[], IS *is, DM *subdm)
1543435a35e8SMatthew G Knepley {
1544435a35e8SMatthew G Knepley   PetscErrorCode ierr;
1545435a35e8SMatthew G Knepley 
1546435a35e8SMatthew G Knepley   PetscFunctionBegin;
1547435a35e8SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1548435a35e8SMatthew G Knepley   PetscValidPointer(fields,3);
15498865f1eaSKarl Rupp   if (is) PetscValidPointer(is,4);
15508865f1eaSKarl Rupp   if (subdm) PetscValidPointer(subdm,5);
1551435a35e8SMatthew G Knepley   if (dm->ops->createsubdm) {
1552435a35e8SMatthew G Knepley     ierr = (*dm->ops->createsubdm)(dm, numFields, fields, is, subdm);CHKERRQ(ierr);
155382f516ccSBarry Smith   } else SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "This type has no DMCreateSubDM implementation defined");
1554435a35e8SMatthew G Knepley   PetscFunctionReturn(0);
1555435a35e8SMatthew G Knepley }
1556435a35e8SMatthew G Knepley 
155716621825SDmitry Karpeev 
155816621825SDmitry Karpeev #undef __FUNCT__
155916621825SDmitry Karpeev #define __FUNCT__ "DMCreateDomainDecomposition"
156016621825SDmitry Karpeev /*@C
15618d4ac253SDmitry Karpeev   DMCreateDomainDecomposition - Returns lists of IS objects defining a decomposition of a problem into subproblems
15628d4ac253SDmitry Karpeev                           corresponding to restrictions to pairs nested subdomains: each IS contains the global
15638d4ac253SDmitry Karpeev                           indices of the dofs of the corresponding subdomains.  The inner subdomains conceptually
15648d4ac253SDmitry Karpeev                           define a nonoverlapping covering, while outer subdomains can overlap.
15658d4ac253SDmitry Karpeev                           The optional list of DMs define the DM for each subproblem.
156616621825SDmitry Karpeev 
156716621825SDmitry Karpeev   Not collective
156816621825SDmitry Karpeev 
156916621825SDmitry Karpeev   Input Parameter:
157016621825SDmitry Karpeev . dm - the DM object
157116621825SDmitry Karpeev 
157216621825SDmitry Karpeev   Output Parameters:
15730298fd71SBarry Smith + len         - The number of subproblems in the domain decomposition (or NULL if not requested)
15740298fd71SBarry Smith . namelist    - The name for each subdomain (or NULL if not requested)
15750298fd71SBarry Smith . innerislist - The global indices for each inner subdomain (or NULL, if not requested)
15760298fd71SBarry Smith . outerislist - The global indices for each outer subdomain (or NULL, if not requested)
15770298fd71SBarry Smith - dmlist      - The DMs for each subdomain subproblem (or NULL, if not requested; if NULL is returned, no DMs are defined)
157816621825SDmitry Karpeev 
157916621825SDmitry Karpeev   Level: intermediate
158016621825SDmitry Karpeev 
158116621825SDmitry Karpeev   Notes:
158216621825SDmitry Karpeev   The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with
158316621825SDmitry Karpeev   PetscFree(), every entry of is should be destroyed with ISDestroy(), every entry of dm should be destroyed with DMDestroy(),
158416621825SDmitry Karpeev   and all of the arrays should be freed with PetscFree().
158516621825SDmitry Karpeev 
15868d4ac253SDmitry Karpeev .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateDomainDecompositionDM(), DMCreateFieldDecomposition()
158716621825SDmitry Karpeev @*/
15888d4ac253SDmitry Karpeev PetscErrorCode DMCreateDomainDecomposition(DM dm, PetscInt *len, char ***namelist, IS **innerislist, IS **outerislist, DM **dmlist)
158916621825SDmitry Karpeev {
159016621825SDmitry Karpeev   PetscErrorCode      ierr;
1591be081cd6SPeter Brune   DMSubDomainHookLink link;
1592be081cd6SPeter Brune   PetscInt            i,l;
159316621825SDmitry Karpeev 
159416621825SDmitry Karpeev   PetscFunctionBegin;
159516621825SDmitry Karpeev   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
159614a18fd3SPeter Brune   if (len)           {PetscValidPointer(len,2);            *len         = 0;}
15970298fd71SBarry Smith   if (namelist)      {PetscValidPointer(namelist,3);       *namelist    = NULL;}
15980298fd71SBarry Smith   if (innerislist)   {PetscValidPointer(innerislist,4);    *innerislist = NULL;}
15990298fd71SBarry Smith   if (outerislist)   {PetscValidPointer(outerislist,5);    *outerislist = NULL;}
16000298fd71SBarry Smith   if (dmlist)        {PetscValidPointer(dmlist,6);         *dmlist      = NULL;}
1601f3f0edfdSDmitry Karpeev   /*
1602f3f0edfdSDmitry Karpeev    Is it a good idea to apply the following check across all impls?
1603f3f0edfdSDmitry Karpeev    Perhaps some impls can have a well-defined decomposition before DMSetUp?
1604f3f0edfdSDmitry Karpeev    This, however, follows the general principle that accessors are not well-behaved until the object is set up.
1605f3f0edfdSDmitry Karpeev    */
1606ce94432eSBarry Smith   if (!dm->setupcalled) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_WRONGSTATE, "Decomposition defined only after DMSetUp");
160716621825SDmitry Karpeev   if (dm->ops->createdomaindecomposition) {
1608be081cd6SPeter Brune     ierr = (*dm->ops->createdomaindecomposition)(dm,&l,namelist,innerislist,outerislist,dmlist);CHKERRQ(ierr);
160914a18fd3SPeter Brune     /* copy subdomain hooks and context over to the subdomain DMs */
1610f891f5b9SPatrick Sanan     if (dmlist && *dmlist) {
1611be081cd6SPeter Brune       for (i = 0; i < l; i++) {
1612be081cd6SPeter Brune         for (link=dm->subdomainhook; link; link=link->next) {
1613be081cd6SPeter Brune           if (link->ddhook) {ierr = (*link->ddhook)(dm,(*dmlist)[i],link->ctx);CHKERRQ(ierr);}
1614be081cd6SPeter Brune         }
1615648262bbSPatrick Sanan         if (dm->ctx) (*dmlist)[i]->ctx = dm->ctx;
1616e7c4fc90SDmitry Karpeev       }
161714a18fd3SPeter Brune     }
161814a18fd3SPeter Brune     if (len) *len = l;
161914a18fd3SPeter Brune   }
1620e30e807fSPeter Brune   PetscFunctionReturn(0);
1621e30e807fSPeter Brune }
1622e30e807fSPeter Brune 
1623e30e807fSPeter Brune 
1624e30e807fSPeter Brune #undef __FUNCT__
1625e30e807fSPeter Brune #define __FUNCT__ "DMCreateDomainDecompositionScatters"
1626e30e807fSPeter Brune /*@C
1627e30e807fSPeter Brune   DMCreateDomainDecompositionScatters - Returns scatters to the subdomain vectors from the global vector
1628e30e807fSPeter Brune 
1629e30e807fSPeter Brune   Not collective
1630e30e807fSPeter Brune 
1631e30e807fSPeter Brune   Input Parameters:
1632e30e807fSPeter Brune + dm - the DM object
1633e30e807fSPeter Brune . n  - the number of subdomain scatters
1634e30e807fSPeter Brune - subdms - the local subdomains
1635e30e807fSPeter Brune 
1636e30e807fSPeter Brune   Output Parameters:
1637e30e807fSPeter Brune + n     - the number of scatters returned
1638e30e807fSPeter Brune . iscat - scatter from global vector to nonoverlapping global vector entries on subdomain
1639e30e807fSPeter Brune . oscat - scatter from global vector to overlapping global vector entries on subdomain
1640e30e807fSPeter Brune - gscat - scatter from global vector to local vector on subdomain (fills in ghosts)
1641e30e807fSPeter Brune 
1642e30e807fSPeter Brune   Notes: This is an alternative to the iis and ois arguments in DMCreateDomainDecomposition that allow for the solution
1643e30e807fSPeter Brune   of general nonlinear problems with overlapping subdomain methods.  While merely having index sets that enable subsets
1644e30e807fSPeter Brune   of the residual equations to be created is fine for linear problems, nonlinear problems require local assembly of
1645e30e807fSPeter Brune   solution and residual data.
1646e30e807fSPeter Brune 
1647e30e807fSPeter Brune   Level: developer
1648e30e807fSPeter Brune 
1649e30e807fSPeter Brune .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS()
1650e30e807fSPeter Brune @*/
1651e30e807fSPeter Brune PetscErrorCode DMCreateDomainDecompositionScatters(DM dm,PetscInt n,DM *subdms,VecScatter **iscat,VecScatter **oscat,VecScatter **gscat)
1652e30e807fSPeter Brune {
1653e30e807fSPeter Brune   PetscErrorCode ierr;
1654e30e807fSPeter Brune 
1655e30e807fSPeter Brune   PetscFunctionBegin;
1656e30e807fSPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1657e30e807fSPeter Brune   PetscValidPointer(subdms,3);
1658e30e807fSPeter Brune   if (dm->ops->createddscatters) {
1659e30e807fSPeter Brune     ierr = (*dm->ops->createddscatters)(dm,n,subdms,iscat,oscat,gscat);CHKERRQ(ierr);
16606668ed41SLisandro Dalcin   } else SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "This type has no DMCreateDomainDecompositionScatter implementation defined");
1661e7c4fc90SDmitry Karpeev   PetscFunctionReturn(0);
1662e7c4fc90SDmitry Karpeev }
1663e7c4fc90SDmitry Karpeev 
1664731c8d9eSDmitry Karpeev #undef __FUNCT__
166547c6ae99SBarry Smith #define __FUNCT__ "DMRefine"
166647c6ae99SBarry Smith /*@
166747c6ae99SBarry Smith   DMRefine - Refines a DM object
166847c6ae99SBarry Smith 
166947c6ae99SBarry Smith   Collective on DM
167047c6ae99SBarry Smith 
167147c6ae99SBarry Smith   Input Parameter:
167247c6ae99SBarry Smith + dm   - the DM object
167391d95f02SJed Brown - comm - the communicator to contain the new DM object (or MPI_COMM_NULL)
167447c6ae99SBarry Smith 
167547c6ae99SBarry Smith   Output Parameter:
16760298fd71SBarry Smith . dmf - the refined DM, or NULL
1677ae0a1c52SMatthew G Knepley 
16780298fd71SBarry Smith   Note: If no refinement was done, the return value is NULL
167947c6ae99SBarry Smith 
168047c6ae99SBarry Smith   Level: developer
168147c6ae99SBarry Smith 
1682e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
168347c6ae99SBarry Smith @*/
16847087cfbeSBarry Smith PetscErrorCode  DMRefine(DM dm,MPI_Comm comm,DM *dmf)
168547c6ae99SBarry Smith {
168647c6ae99SBarry Smith   PetscErrorCode   ierr;
1687c833c3b5SJed Brown   DMRefineHookLink link;
168847c6ae99SBarry Smith 
168947c6ae99SBarry Smith   PetscFunctionBegin;
1690732e2eb9SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1691fef3a512SBarry Smith   if (!dm->ops->refine) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"This DM cannot refine");
169247c6ae99SBarry Smith   ierr = (*dm->ops->refine)(dm,comm,dmf);CHKERRQ(ierr);
16934057135bSMatthew G Knepley   if (*dmf) {
169443842a1eSJed Brown     (*dmf)->ops->creatematrix = dm->ops->creatematrix;
16958865f1eaSKarl Rupp 
16968cd211a4SJed Brown     ierr = PetscObjectCopyFortranFunctionPointers((PetscObject)dm,(PetscObject)*dmf);CHKERRQ(ierr);
16978865f1eaSKarl Rupp 
1698644e2e5bSBarry Smith     (*dmf)->ctx       = dm->ctx;
16990598a293SJed Brown     (*dmf)->leveldown = dm->leveldown;
1700656b349aSBarry Smith     (*dmf)->levelup   = dm->levelup + 1;
17018865f1eaSKarl Rupp 
1702e4b4b23bSJed Brown     ierr = DMSetMatType(*dmf,dm->mattype);CHKERRQ(ierr);
1703c833c3b5SJed Brown     for (link=dm->refinehook; link; link=link->next) {
17048865f1eaSKarl Rupp       if (link->refinehook) {
17058865f1eaSKarl Rupp         ierr = (*link->refinehook)(dm,*dmf,link->ctx);CHKERRQ(ierr);
17068865f1eaSKarl Rupp       }
1707c833c3b5SJed Brown     }
1708c833c3b5SJed Brown   }
1709c833c3b5SJed Brown   PetscFunctionReturn(0);
1710c833c3b5SJed Brown }
1711c833c3b5SJed Brown 
1712c833c3b5SJed Brown #undef __FUNCT__
1713c833c3b5SJed Brown #define __FUNCT__ "DMRefineHookAdd"
1714bb9467b5SJed Brown /*@C
1715c833c3b5SJed Brown    DMRefineHookAdd - adds a callback to be run when interpolating a nonlinear problem to a finer grid
1716c833c3b5SJed Brown 
1717c833c3b5SJed Brown    Logically Collective
1718c833c3b5SJed Brown 
1719c833c3b5SJed Brown    Input Arguments:
1720c833c3b5SJed Brown +  coarse - nonlinear solver context on which to run a hook when restricting to a coarser level
1721c833c3b5SJed Brown .  refinehook - function to run when setting up a coarser level
1722c833c3b5SJed Brown .  interphook - function to run to update data on finer levels (once per SNESSolve())
17230298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
1724c833c3b5SJed Brown 
1725c833c3b5SJed Brown    Calling sequence of refinehook:
1726c833c3b5SJed Brown $    refinehook(DM coarse,DM fine,void *ctx);
1727c833c3b5SJed Brown 
1728c833c3b5SJed Brown +  coarse - coarse level DM
1729c833c3b5SJed Brown .  fine - fine level DM to interpolate problem to
1730c833c3b5SJed Brown -  ctx - optional user-defined function context
1731c833c3b5SJed Brown 
1732c833c3b5SJed Brown    Calling sequence for interphook:
1733c833c3b5SJed Brown $    interphook(DM coarse,Mat interp,DM fine,void *ctx)
1734c833c3b5SJed Brown 
1735c833c3b5SJed Brown +  coarse - coarse level DM
1736c833c3b5SJed Brown .  interp - matrix interpolating a coarse-level solution to the finer grid
1737c833c3b5SJed Brown .  fine - fine level DM to update
1738c833c3b5SJed Brown -  ctx - optional user-defined function context
1739c833c3b5SJed Brown 
1740c833c3b5SJed Brown    Level: advanced
1741c833c3b5SJed Brown 
1742c833c3b5SJed Brown    Notes:
1743c833c3b5SJed Brown    This function is only needed if auxiliary data needs to be passed to fine grids while grid sequencing
1744c833c3b5SJed Brown 
1745c833c3b5SJed Brown    If this function is called multiple times, the hooks will be run in the order they are added.
1746c833c3b5SJed Brown 
1747bb9467b5SJed Brown    This function is currently not available from Fortran.
1748bb9467b5SJed Brown 
1749c833c3b5SJed Brown .seealso: DMCoarsenHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
1750c833c3b5SJed Brown @*/
1751c833c3b5SJed Brown PetscErrorCode DMRefineHookAdd(DM coarse,PetscErrorCode (*refinehook)(DM,DM,void*),PetscErrorCode (*interphook)(DM,Mat,DM,void*),void *ctx)
1752c833c3b5SJed Brown {
1753c833c3b5SJed Brown   PetscErrorCode   ierr;
1754c833c3b5SJed Brown   DMRefineHookLink link,*p;
1755c833c3b5SJed Brown 
1756c833c3b5SJed Brown   PetscFunctionBegin;
1757c833c3b5SJed Brown   PetscValidHeaderSpecific(coarse,DM_CLASSID,1);
1758c833c3b5SJed Brown   for (p=&coarse->refinehook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */
175995dccacaSBarry Smith   ierr             = PetscNew(&link);CHKERRQ(ierr);
1760c833c3b5SJed Brown   link->refinehook = refinehook;
1761c833c3b5SJed Brown   link->interphook = interphook;
1762c833c3b5SJed Brown   link->ctx        = ctx;
17630298fd71SBarry Smith   link->next       = NULL;
1764c833c3b5SJed Brown   *p               = link;
1765c833c3b5SJed Brown   PetscFunctionReturn(0);
1766c833c3b5SJed Brown }
1767c833c3b5SJed Brown 
1768c833c3b5SJed Brown #undef __FUNCT__
1769c833c3b5SJed Brown #define __FUNCT__ "DMInterpolate"
1770c833c3b5SJed Brown /*@
1771c833c3b5SJed Brown    DMInterpolate - interpolates user-defined problem data to a finer DM by running hooks registered by DMRefineHookAdd()
1772c833c3b5SJed Brown 
1773c833c3b5SJed Brown    Collective if any hooks are
1774c833c3b5SJed Brown 
1775c833c3b5SJed Brown    Input Arguments:
1776c833c3b5SJed Brown +  coarse - coarser DM to use as a base
1777c833c3b5SJed Brown .  restrct - interpolation matrix, apply using MatInterpolate()
1778c833c3b5SJed Brown -  fine - finer DM to update
1779c833c3b5SJed Brown 
1780c833c3b5SJed Brown    Level: developer
1781c833c3b5SJed Brown 
1782c833c3b5SJed Brown .seealso: DMRefineHookAdd(), MatInterpolate()
1783c833c3b5SJed Brown @*/
1784c833c3b5SJed Brown PetscErrorCode DMInterpolate(DM coarse,Mat interp,DM fine)
1785c833c3b5SJed Brown {
1786c833c3b5SJed Brown   PetscErrorCode   ierr;
1787c833c3b5SJed Brown   DMRefineHookLink link;
1788c833c3b5SJed Brown 
1789c833c3b5SJed Brown   PetscFunctionBegin;
1790c833c3b5SJed Brown   for (link=fine->refinehook; link; link=link->next) {
17918865f1eaSKarl Rupp     if (link->interphook) {
17928865f1eaSKarl Rupp       ierr = (*link->interphook)(coarse,interp,fine,link->ctx);CHKERRQ(ierr);
17938865f1eaSKarl Rupp     }
17944057135bSMatthew G Knepley   }
179547c6ae99SBarry Smith   PetscFunctionReturn(0);
179647c6ae99SBarry Smith }
179747c6ae99SBarry Smith 
179847c6ae99SBarry Smith #undef __FUNCT__
1799eb3f98d2SBarry Smith #define __FUNCT__ "DMGetRefineLevel"
1800eb3f98d2SBarry Smith /*@
1801eb3f98d2SBarry Smith     DMGetRefineLevel - Get's the number of refinements that have generated this DM.
1802eb3f98d2SBarry Smith 
1803eb3f98d2SBarry Smith     Not Collective
1804eb3f98d2SBarry Smith 
1805eb3f98d2SBarry Smith     Input Parameter:
1806eb3f98d2SBarry Smith .   dm - the DM object
1807eb3f98d2SBarry Smith 
1808eb3f98d2SBarry Smith     Output Parameter:
1809eb3f98d2SBarry Smith .   level - number of refinements
1810eb3f98d2SBarry Smith 
1811eb3f98d2SBarry Smith     Level: developer
1812eb3f98d2SBarry Smith 
18136a7d9d85SPeter Brune .seealso DMCoarsen(), DMGetCoarsenLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
1814eb3f98d2SBarry Smith 
1815eb3f98d2SBarry Smith @*/
1816eb3f98d2SBarry Smith PetscErrorCode  DMGetRefineLevel(DM dm,PetscInt *level)
1817eb3f98d2SBarry Smith {
1818eb3f98d2SBarry Smith   PetscFunctionBegin;
1819eb3f98d2SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1820eb3f98d2SBarry Smith   *level = dm->levelup;
1821eb3f98d2SBarry Smith   PetscFunctionReturn(0);
1822eb3f98d2SBarry Smith }
1823eb3f98d2SBarry Smith 
1824eb3f98d2SBarry Smith #undef __FUNCT__
1825fef3a512SBarry Smith #define __FUNCT__ "DMSetRefineLevel"
1826fef3a512SBarry Smith /*@
1827fef3a512SBarry Smith     DMSetRefineLevel - Set's the number of refinements that have generated this DM.
1828fef3a512SBarry Smith 
1829fef3a512SBarry Smith     Not Collective
1830fef3a512SBarry Smith 
1831fef3a512SBarry Smith     Input Parameter:
1832fef3a512SBarry Smith +   dm - the DM object
1833fef3a512SBarry Smith -   level - number of refinements
1834fef3a512SBarry Smith 
1835fef3a512SBarry Smith     Level: advanced
1836fef3a512SBarry Smith 
1837fef3a512SBarry Smith     Notes: This value is used by PCMG to determine how many multigrid levels to use
1838fef3a512SBarry Smith 
1839fef3a512SBarry Smith .seealso DMCoarsen(), DMGetCoarsenLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
1840fef3a512SBarry Smith 
1841fef3a512SBarry Smith @*/
1842fef3a512SBarry Smith PetscErrorCode  DMSetRefineLevel(DM dm,PetscInt level)
1843fef3a512SBarry Smith {
1844fef3a512SBarry Smith   PetscFunctionBegin;
1845fef3a512SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1846fef3a512SBarry Smith   dm->levelup = level;
1847fef3a512SBarry Smith   PetscFunctionReturn(0);
1848fef3a512SBarry Smith }
1849fef3a512SBarry Smith 
1850fef3a512SBarry Smith #undef __FUNCT__
1851baf369e7SPeter Brune #define __FUNCT__ "DMGlobalToLocalHookAdd"
1852bb9467b5SJed Brown /*@C
1853baf369e7SPeter Brune    DMGlobalToLocalHookAdd - adds a callback to be run when global to local is called
1854baf369e7SPeter Brune 
1855baf369e7SPeter Brune    Logically Collective
1856baf369e7SPeter Brune 
1857baf369e7SPeter Brune    Input Arguments:
1858baf369e7SPeter Brune +  dm - the DM
1859baf369e7SPeter Brune .  beginhook - function to run at the beginning of DMGlobalToLocalBegin()
1860baf369e7SPeter Brune .  endhook - function to run after DMGlobalToLocalEnd() has completed
18610298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
1862baf369e7SPeter Brune 
1863baf369e7SPeter Brune    Calling sequence for beginhook:
1864baf369e7SPeter Brune $    beginhook(DM fine,VecScatter out,VecScatter in,DM coarse,void *ctx)
1865baf369e7SPeter Brune 
1866baf369e7SPeter Brune +  dm - global DM
1867baf369e7SPeter Brune .  g - global vector
1868baf369e7SPeter Brune .  mode - mode
1869baf369e7SPeter Brune .  l - local vector
1870baf369e7SPeter Brune -  ctx - optional user-defined function context
1871baf369e7SPeter Brune 
1872baf369e7SPeter Brune 
1873baf369e7SPeter Brune    Calling sequence for endhook:
1874ec4806b8SPeter Brune $    endhook(DM fine,VecScatter out,VecScatter in,DM coarse,void *ctx)
1875baf369e7SPeter Brune 
1876baf369e7SPeter Brune +  global - global DM
1877baf369e7SPeter Brune -  ctx - optional user-defined function context
1878baf369e7SPeter Brune 
1879baf369e7SPeter Brune    Level: advanced
1880baf369e7SPeter Brune 
1881baf369e7SPeter Brune .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
1882baf369e7SPeter Brune @*/
1883baf369e7SPeter Brune PetscErrorCode DMGlobalToLocalHookAdd(DM dm,PetscErrorCode (*beginhook)(DM,Vec,InsertMode,Vec,void*),PetscErrorCode (*endhook)(DM,Vec,InsertMode,Vec,void*),void *ctx)
1884baf369e7SPeter Brune {
1885baf369e7SPeter Brune   PetscErrorCode          ierr;
1886baf369e7SPeter Brune   DMGlobalToLocalHookLink link,*p;
1887baf369e7SPeter Brune 
1888baf369e7SPeter Brune   PetscFunctionBegin;
1889baf369e7SPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1890baf369e7SPeter Brune   for (p=&dm->gtolhook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */
189195dccacaSBarry Smith   ierr            = PetscNew(&link);CHKERRQ(ierr);
1892baf369e7SPeter Brune   link->beginhook = beginhook;
1893baf369e7SPeter Brune   link->endhook   = endhook;
1894baf369e7SPeter Brune   link->ctx       = ctx;
18950298fd71SBarry Smith   link->next      = NULL;
1896baf369e7SPeter Brune   *p              = link;
1897baf369e7SPeter Brune   PetscFunctionReturn(0);
1898baf369e7SPeter Brune }
1899baf369e7SPeter Brune 
1900baf369e7SPeter Brune #undef __FUNCT__
19014c274da1SToby Isaac #define __FUNCT__ "DMGlobalToLocalHook_Constraints"
19024c274da1SToby Isaac static PetscErrorCode DMGlobalToLocalHook_Constraints(DM dm, Vec g, InsertMode mode, Vec l, void *ctx)
19034c274da1SToby Isaac {
19044c274da1SToby Isaac   Mat cMat;
19054c274da1SToby Isaac   Vec cVec;
19064c274da1SToby Isaac   PetscSection section, cSec;
19074c274da1SToby Isaac   PetscInt pStart, pEnd, p, dof;
19084c274da1SToby Isaac   PetscErrorCode ierr;
19094c274da1SToby Isaac 
19104c274da1SToby Isaac   PetscFunctionBegin;
19114c274da1SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
19124c274da1SToby Isaac   ierr = DMGetDefaultConstraints(dm,&cSec,&cMat);CHKERRQ(ierr);
19134c274da1SToby Isaac   if (cMat && (mode == INSERT_VALUES || mode == INSERT_ALL_VALUES || mode == INSERT_BC_VALUES)) {
19145db9a05bSToby Isaac     PetscInt nRows;
19155db9a05bSToby Isaac 
19165db9a05bSToby Isaac     ierr = MatGetSize(cMat,&nRows,NULL);CHKERRQ(ierr);
19175db9a05bSToby Isaac     if (nRows <= 0) PetscFunctionReturn(0);
19184c274da1SToby Isaac     ierr = DMGetDefaultSection(dm,&section);CHKERRQ(ierr);
19197711e48fSToby Isaac     ierr = MatCreateVecs(cMat,NULL,&cVec);CHKERRQ(ierr);
19204c274da1SToby Isaac     ierr = MatMult(cMat,l,cVec);CHKERRQ(ierr);
19214c274da1SToby Isaac     ierr = PetscSectionGetChart(cSec,&pStart,&pEnd);CHKERRQ(ierr);
19224c274da1SToby Isaac     for (p = pStart; p < pEnd; p++) {
19234c274da1SToby Isaac       ierr = PetscSectionGetDof(cSec,p,&dof);CHKERRQ(ierr);
19244c274da1SToby Isaac       if (dof) {
19254c274da1SToby Isaac         PetscScalar *vals;
19264c274da1SToby Isaac         ierr = VecGetValuesSection(cVec,cSec,p,&vals);CHKERRQ(ierr);
19274c274da1SToby Isaac         ierr = VecSetValuesSection(l,section,p,vals,INSERT_ALL_VALUES);CHKERRQ(ierr);
19284c274da1SToby Isaac       }
19294c274da1SToby Isaac     }
19304c274da1SToby Isaac     ierr = VecDestroy(&cVec);CHKERRQ(ierr);
19314c274da1SToby Isaac   }
19324c274da1SToby Isaac   PetscFunctionReturn(0);
19334c274da1SToby Isaac }
19344c274da1SToby Isaac 
19354c274da1SToby Isaac #undef __FUNCT__
193647c6ae99SBarry Smith #define __FUNCT__ "DMGlobalToLocalBegin"
193747c6ae99SBarry Smith /*@
193847c6ae99SBarry Smith     DMGlobalToLocalBegin - Begins updating local vectors from global vector
193947c6ae99SBarry Smith 
194047c6ae99SBarry Smith     Neighbor-wise Collective on DM
194147c6ae99SBarry Smith 
194247c6ae99SBarry Smith     Input Parameters:
194347c6ae99SBarry Smith +   dm - the DM object
194447c6ae99SBarry Smith .   g - the global vector
194547c6ae99SBarry Smith .   mode - INSERT_VALUES or ADD_VALUES
194647c6ae99SBarry Smith -   l - the local vector
194747c6ae99SBarry Smith 
194847c6ae99SBarry Smith 
194947c6ae99SBarry Smith     Level: beginner
195047c6ae99SBarry Smith 
1951e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin()
195247c6ae99SBarry Smith 
195347c6ae99SBarry Smith @*/
19547087cfbeSBarry Smith PetscErrorCode  DMGlobalToLocalBegin(DM dm,Vec g,InsertMode mode,Vec l)
195547c6ae99SBarry Smith {
19567128ae9fSMatthew G Knepley   PetscSF                 sf;
195747c6ae99SBarry Smith   PetscErrorCode          ierr;
1958baf369e7SPeter Brune   DMGlobalToLocalHookLink link;
195947c6ae99SBarry Smith 
196047c6ae99SBarry Smith   PetscFunctionBegin;
1961171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1962baf369e7SPeter Brune   for (link=dm->gtolhook; link; link=link->next) {
19638865f1eaSKarl Rupp     if (link->beginhook) {
19648865f1eaSKarl Rupp       ierr = (*link->beginhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);
19658865f1eaSKarl Rupp     }
1966baf369e7SPeter Brune   }
19677128ae9fSMatthew G Knepley   ierr = DMGetDefaultSF(dm, &sf);CHKERRQ(ierr);
19687128ae9fSMatthew G Knepley   if (sf) {
1969ae5cfb4aSMatthew G. Knepley     const PetscScalar *gArray;
1970ae5cfb4aSMatthew G. Knepley     PetscScalar       *lArray;
19717128ae9fSMatthew G Knepley 
197282f516ccSBarry Smith     if (mode == ADD_VALUES) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
19737128ae9fSMatthew G Knepley     ierr = VecGetArray(l, &lArray);CHKERRQ(ierr);
1974ae5cfb4aSMatthew G. Knepley     ierr = VecGetArrayRead(g, &gArray);CHKERRQ(ierr);
19757128ae9fSMatthew G Knepley     ierr = PetscSFBcastBegin(sf, MPIU_SCALAR, gArray, lArray);CHKERRQ(ierr);
19767128ae9fSMatthew G Knepley     ierr = VecRestoreArray(l, &lArray);CHKERRQ(ierr);
1977ae5cfb4aSMatthew G. Knepley     ierr = VecRestoreArrayRead(g, &gArray);CHKERRQ(ierr);
19787128ae9fSMatthew G Knepley   } else {
1979843c4018SMatthew G Knepley     ierr = (*dm->ops->globaltolocalbegin)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
19807128ae9fSMatthew G Knepley   }
198147c6ae99SBarry Smith   PetscFunctionReturn(0);
198247c6ae99SBarry Smith }
198347c6ae99SBarry Smith 
198447c6ae99SBarry Smith #undef __FUNCT__
198547c6ae99SBarry Smith #define __FUNCT__ "DMGlobalToLocalEnd"
198647c6ae99SBarry Smith /*@
198747c6ae99SBarry Smith     DMGlobalToLocalEnd - Ends updating local vectors from global vector
198847c6ae99SBarry Smith 
198947c6ae99SBarry Smith     Neighbor-wise Collective on DM
199047c6ae99SBarry Smith 
199147c6ae99SBarry Smith     Input Parameters:
199247c6ae99SBarry Smith +   dm - the DM object
199347c6ae99SBarry Smith .   g - the global vector
199447c6ae99SBarry Smith .   mode - INSERT_VALUES or ADD_VALUES
199547c6ae99SBarry Smith -   l - the local vector
199647c6ae99SBarry Smith 
199747c6ae99SBarry Smith 
199847c6ae99SBarry Smith     Level: beginner
199947c6ae99SBarry Smith 
2000e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin()
200147c6ae99SBarry Smith 
200247c6ae99SBarry Smith @*/
20037087cfbeSBarry Smith PetscErrorCode  DMGlobalToLocalEnd(DM dm,Vec g,InsertMode mode,Vec l)
200447c6ae99SBarry Smith {
20057128ae9fSMatthew G Knepley   PetscSF                 sf;
200647c6ae99SBarry Smith   PetscErrorCode          ierr;
2007ae5cfb4aSMatthew G. Knepley   const PetscScalar      *gArray;
2008ae5cfb4aSMatthew G. Knepley   PetscScalar            *lArray;
2009baf369e7SPeter Brune   DMGlobalToLocalHookLink link;
201047c6ae99SBarry Smith 
201147c6ae99SBarry Smith   PetscFunctionBegin;
2012171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
20137128ae9fSMatthew G Knepley   ierr = DMGetDefaultSF(dm, &sf);CHKERRQ(ierr);
20147128ae9fSMatthew G Knepley   if (sf) {
201582f516ccSBarry Smith     if (mode == ADD_VALUES) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
20167128ae9fSMatthew G Knepley 
20177128ae9fSMatthew G Knepley     ierr = VecGetArray(l, &lArray);CHKERRQ(ierr);
2018ae5cfb4aSMatthew G. Knepley     ierr = VecGetArrayRead(g, &gArray);CHKERRQ(ierr);
20197128ae9fSMatthew G Knepley     ierr = PetscSFBcastEnd(sf, MPIU_SCALAR, gArray, lArray);CHKERRQ(ierr);
20207128ae9fSMatthew G Knepley     ierr = VecRestoreArray(l, &lArray);CHKERRQ(ierr);
2021ae5cfb4aSMatthew G. Knepley     ierr = VecRestoreArrayRead(g, &gArray);CHKERRQ(ierr);
20227128ae9fSMatthew G Knepley   } else {
2023843c4018SMatthew G Knepley     ierr = (*dm->ops->globaltolocalend)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
20247128ae9fSMatthew G Knepley   }
20254c274da1SToby Isaac   ierr = DMGlobalToLocalHook_Constraints(dm,g,mode,l,NULL);CHKERRQ(ierr);
2026baf369e7SPeter Brune   for (link=dm->gtolhook; link; link=link->next) {
2027baf369e7SPeter Brune     if (link->endhook) {ierr = (*link->endhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);}
2028baf369e7SPeter Brune   }
202947c6ae99SBarry Smith   PetscFunctionReturn(0);
203047c6ae99SBarry Smith }
203147c6ae99SBarry Smith 
203247c6ae99SBarry Smith #undef __FUNCT__
2033d4d07f1eSToby Isaac #define __FUNCT__ "DMLocalToGlobalHookAdd"
2034d4d07f1eSToby Isaac /*@C
2035d4d07f1eSToby Isaac    DMLocalToGlobalHookAdd - adds a callback to be run when a local to global is called
2036d4d07f1eSToby Isaac 
2037d4d07f1eSToby Isaac    Logically Collective
2038d4d07f1eSToby Isaac 
2039d4d07f1eSToby Isaac    Input Arguments:
2040d4d07f1eSToby Isaac +  dm - the DM
2041d4d07f1eSToby Isaac .  beginhook - function to run at the beginning of DMLocalToGlobalBegin()
2042d4d07f1eSToby Isaac .  endhook - function to run after DMLocalToGlobalEnd() has completed
2043d4d07f1eSToby Isaac -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
2044d4d07f1eSToby Isaac 
2045d4d07f1eSToby Isaac    Calling sequence for beginhook:
2046d4d07f1eSToby Isaac $    beginhook(DM fine,Vec l,InsertMode mode,Vec g,void *ctx)
2047d4d07f1eSToby Isaac 
2048d4d07f1eSToby Isaac +  dm - global DM
2049d4d07f1eSToby Isaac .  l - local vector
2050d4d07f1eSToby Isaac .  mode - mode
2051d4d07f1eSToby Isaac .  g - global vector
2052d4d07f1eSToby Isaac -  ctx - optional user-defined function context
2053d4d07f1eSToby Isaac 
2054d4d07f1eSToby Isaac 
2055d4d07f1eSToby Isaac    Calling sequence for endhook:
2056d4d07f1eSToby Isaac $    endhook(DM fine,Vec l,InsertMode mode,Vec g,void *ctx)
2057d4d07f1eSToby Isaac 
2058d4d07f1eSToby Isaac +  global - global DM
2059d4d07f1eSToby Isaac .  l - local vector
2060d4d07f1eSToby Isaac .  mode - mode
2061d4d07f1eSToby Isaac .  g - global vector
2062d4d07f1eSToby Isaac -  ctx - optional user-defined function context
2063d4d07f1eSToby Isaac 
2064d4d07f1eSToby Isaac    Level: advanced
2065d4d07f1eSToby Isaac 
2066d4d07f1eSToby Isaac .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
2067d4d07f1eSToby Isaac @*/
2068d4d07f1eSToby Isaac PetscErrorCode DMLocalToGlobalHookAdd(DM dm,PetscErrorCode (*beginhook)(DM,Vec,InsertMode,Vec,void*),PetscErrorCode (*endhook)(DM,Vec,InsertMode,Vec,void*),void *ctx)
2069d4d07f1eSToby Isaac {
2070d4d07f1eSToby Isaac   PetscErrorCode          ierr;
2071d4d07f1eSToby Isaac   DMLocalToGlobalHookLink link,*p;
2072d4d07f1eSToby Isaac 
2073d4d07f1eSToby Isaac   PetscFunctionBegin;
2074d4d07f1eSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2075d4d07f1eSToby Isaac   for (p=&dm->ltoghook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */
207695dccacaSBarry Smith   ierr            = PetscNew(&link);CHKERRQ(ierr);
2077d4d07f1eSToby Isaac   link->beginhook = beginhook;
2078d4d07f1eSToby Isaac   link->endhook   = endhook;
2079d4d07f1eSToby Isaac   link->ctx       = ctx;
2080d4d07f1eSToby Isaac   link->next      = NULL;
2081d4d07f1eSToby Isaac   *p              = link;
2082d4d07f1eSToby Isaac   PetscFunctionReturn(0);
2083d4d07f1eSToby Isaac }
2084d4d07f1eSToby Isaac 
2085d4d07f1eSToby Isaac #undef __FUNCT__
20864c274da1SToby Isaac #define __FUNCT__ "DMLocalToGlobalHook_Constraints"
20874c274da1SToby Isaac static PetscErrorCode DMLocalToGlobalHook_Constraints(DM dm, Vec l, InsertMode mode, Vec g, void *ctx)
20884c274da1SToby Isaac {
20894c274da1SToby Isaac   Mat cMat;
20904c274da1SToby Isaac   Vec cVec;
20914c274da1SToby Isaac   PetscSection section, cSec;
20924c274da1SToby Isaac   PetscInt pStart, pEnd, p, dof;
20934c274da1SToby Isaac   PetscErrorCode ierr;
20944c274da1SToby Isaac 
20954c274da1SToby Isaac   PetscFunctionBegin;
20964c274da1SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
20974c274da1SToby Isaac   ierr = DMGetDefaultConstraints(dm,&cSec,&cMat);CHKERRQ(ierr);
20984c274da1SToby Isaac   if (cMat && (mode == ADD_VALUES || mode == ADD_ALL_VALUES || mode == ADD_BC_VALUES)) {
20995db9a05bSToby Isaac     PetscInt nRows;
21005db9a05bSToby Isaac 
21015db9a05bSToby Isaac     ierr = MatGetSize(cMat,&nRows,NULL);CHKERRQ(ierr);
21025db9a05bSToby Isaac     if (nRows <= 0) PetscFunctionReturn(0);
21034c274da1SToby Isaac     ierr = DMGetDefaultSection(dm,&section);CHKERRQ(ierr);
21047711e48fSToby Isaac     ierr = MatCreateVecs(cMat,NULL,&cVec);CHKERRQ(ierr);
21054c274da1SToby Isaac     ierr = PetscSectionGetChart(cSec,&pStart,&pEnd);CHKERRQ(ierr);
21064c274da1SToby Isaac     for (p = pStart; p < pEnd; p++) {
21074c274da1SToby Isaac       ierr = PetscSectionGetDof(cSec,p,&dof);CHKERRQ(ierr);
21084c274da1SToby Isaac       if (dof) {
21094c274da1SToby Isaac         PetscInt d;
21104c274da1SToby Isaac         PetscScalar *vals;
21114c274da1SToby Isaac         ierr = VecGetValuesSection(l,section,p,&vals);CHKERRQ(ierr);
21124c274da1SToby Isaac         ierr = VecSetValuesSection(cVec,cSec,p,vals,mode);CHKERRQ(ierr);
21134c274da1SToby Isaac         /* for this to be the true transpose, we have to zero the values that
21144c274da1SToby Isaac          * we just extracted */
21154c274da1SToby Isaac         for (d = 0; d < dof; d++) {
21164c274da1SToby Isaac           vals[d] = 0.;
21174c274da1SToby Isaac         }
21184c274da1SToby Isaac       }
21194c274da1SToby Isaac     }
21204c274da1SToby Isaac     ierr = MatMultTransposeAdd(cMat,cVec,l,l);CHKERRQ(ierr);
21214c274da1SToby Isaac     ierr = VecDestroy(&cVec);CHKERRQ(ierr);
21224c274da1SToby Isaac   }
21234c274da1SToby Isaac   PetscFunctionReturn(0);
21244c274da1SToby Isaac }
21254c274da1SToby Isaac 
21264c274da1SToby Isaac #undef __FUNCT__
21279a42bb27SBarry Smith #define __FUNCT__ "DMLocalToGlobalBegin"
212847c6ae99SBarry Smith /*@
21299a42bb27SBarry Smith     DMLocalToGlobalBegin - updates global vectors from local vectors
21309a42bb27SBarry Smith 
21319a42bb27SBarry Smith     Neighbor-wise Collective on DM
21329a42bb27SBarry Smith 
21339a42bb27SBarry Smith     Input Parameters:
21349a42bb27SBarry Smith +   dm - the DM object
2135f6813fd5SJed Brown .   l - the local vector
21361eb28f2eSBarry 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.
21371eb28f2eSBarry Smith -   g - the global vector
21389a42bb27SBarry Smith 
2139d96308ebSBarry Smith     Notes: In the ADD_VALUES case you normally would zero the receiving vector before beginning this operation.
214084330215SMatthew 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.
21419a42bb27SBarry Smith 
21429a42bb27SBarry Smith     Level: beginner
21439a42bb27SBarry Smith 
2144e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMGlobalToLocalBegin()
21459a42bb27SBarry Smith 
21469a42bb27SBarry Smith @*/
21477087cfbeSBarry Smith PetscErrorCode  DMLocalToGlobalBegin(DM dm,Vec l,InsertMode mode,Vec g)
21489a42bb27SBarry Smith {
21497128ae9fSMatthew G Knepley   PetscSF                 sf;
215084330215SMatthew G. Knepley   PetscSection            s, gs;
2151d4d07f1eSToby Isaac   DMLocalToGlobalHookLink link;
2152ae5cfb4aSMatthew G. Knepley   const PetscScalar      *lArray;
2153ae5cfb4aSMatthew G. Knepley   PetscScalar            *gArray;
215484330215SMatthew G. Knepley   PetscBool               isInsert;
215584330215SMatthew G. Knepley   PetscErrorCode          ierr;
21569a42bb27SBarry Smith 
21579a42bb27SBarry Smith   PetscFunctionBegin;
2158171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2159d4d07f1eSToby Isaac   for (link=dm->ltoghook; link; link=link->next) {
2160d4d07f1eSToby Isaac     if (link->beginhook) {
2161d4d07f1eSToby Isaac       ierr = (*link->beginhook)(dm,l,mode,g,link->ctx);CHKERRQ(ierr);
2162d4d07f1eSToby Isaac     }
2163d4d07f1eSToby Isaac   }
21644c274da1SToby Isaac   ierr = DMLocalToGlobalHook_Constraints(dm,l,mode,g,NULL);CHKERRQ(ierr);
21657128ae9fSMatthew G Knepley   ierr = DMGetDefaultSF(dm, &sf);CHKERRQ(ierr);
216684330215SMatthew G. Knepley   ierr = DMGetDefaultSection(dm, &s);CHKERRQ(ierr);
21677128ae9fSMatthew G Knepley   switch (mode) {
21687128ae9fSMatthew G Knepley   case INSERT_VALUES:
21697128ae9fSMatthew G Knepley   case INSERT_ALL_VALUES:
2170304ab55fSMatthew G. Knepley   case INSERT_BC_VALUES:
217184330215SMatthew G. Knepley     isInsert = PETSC_TRUE; break;
21727128ae9fSMatthew G Knepley   case ADD_VALUES:
21737128ae9fSMatthew G Knepley   case ADD_ALL_VALUES:
2174304ab55fSMatthew G. Knepley   case ADD_BC_VALUES:
217584330215SMatthew G. Knepley     isInsert = PETSC_FALSE; break;
21767128ae9fSMatthew G Knepley   default:
217782f516ccSBarry Smith     SETERRQ1(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
21787128ae9fSMatthew G Knepley   }
217984330215SMatthew G. Knepley   if (sf && !isInsert) {
2180ae5cfb4aSMatthew G. Knepley     ierr = VecGetArrayRead(l, &lArray);CHKERRQ(ierr);
21817128ae9fSMatthew G Knepley     ierr = VecGetArray(g, &gArray);CHKERRQ(ierr);
2182a9b180a6SBarry Smith     ierr = PetscSFReduceBegin(sf, MPIU_SCALAR, lArray, gArray, MPIU_SUM);CHKERRQ(ierr);
2183ae5cfb4aSMatthew G. Knepley     ierr = VecRestoreArrayRead(l, &lArray);CHKERRQ(ierr);
218484330215SMatthew G. Knepley     ierr = VecRestoreArray(g, &gArray);CHKERRQ(ierr);
218584330215SMatthew G. Knepley   } else if (s && isInsert) {
218684330215SMatthew G. Knepley     PetscInt gStart, pStart, pEnd, p;
218784330215SMatthew G. Knepley 
218884330215SMatthew G. Knepley     ierr = DMGetDefaultGlobalSection(dm, &gs);CHKERRQ(ierr);
218984330215SMatthew G. Knepley     ierr = PetscSectionGetChart(s, &pStart, &pEnd);CHKERRQ(ierr);
219084330215SMatthew G. Knepley     ierr = VecGetOwnershipRange(g, &gStart, NULL);CHKERRQ(ierr);
2191ae5cfb4aSMatthew G. Knepley     ierr = VecGetArrayRead(l, &lArray);CHKERRQ(ierr);
219284330215SMatthew G. Knepley     ierr = VecGetArray(g, &gArray);CHKERRQ(ierr);
219384330215SMatthew G. Knepley     for (p = pStart; p < pEnd; ++p) {
2194b3b16f48SMatthew G. Knepley       PetscInt dof, gdof, cdof, gcdof, off, goff, d, e;
219584330215SMatthew G. Knepley 
219684330215SMatthew G. Knepley       ierr = PetscSectionGetDof(s, p, &dof);CHKERRQ(ierr);
219703442857SMatthew G. Knepley       ierr = PetscSectionGetDof(gs, p, &gdof);CHKERRQ(ierr);
219884330215SMatthew G. Knepley       ierr = PetscSectionGetConstraintDof(s, p, &cdof);CHKERRQ(ierr);
2199b3b16f48SMatthew G. Knepley       ierr = PetscSectionGetConstraintDof(gs, p, &gcdof);CHKERRQ(ierr);
220084330215SMatthew G. Knepley       ierr = PetscSectionGetOffset(s, p, &off);CHKERRQ(ierr);
220184330215SMatthew G. Knepley       ierr = PetscSectionGetOffset(gs, p, &goff);CHKERRQ(ierr);
2202b3b16f48SMatthew G. Knepley       /* Ignore off-process data and points with no global data */
220303442857SMatthew G. Knepley       if (!gdof || goff < 0) continue;
2204b3b16f48SMatthew 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);
2205b3b16f48SMatthew G. Knepley       /* If no constraints are enforced in the global vector */
2206b3b16f48SMatthew G. Knepley       if (!gcdof) {
220784330215SMatthew G. Knepley         for (d = 0; d < dof; ++d) gArray[goff-gStart+d] = lArray[off+d];
2208b3b16f48SMatthew G. Knepley       /* If constraints are enforced in the global vector */
2209b3b16f48SMatthew G. Knepley       } else if (cdof == gcdof) {
221084330215SMatthew G. Knepley         const PetscInt *cdofs;
221184330215SMatthew G. Knepley         PetscInt        cind = 0;
221284330215SMatthew G. Knepley 
221384330215SMatthew G. Knepley         ierr = PetscSectionGetConstraintIndices(s, p, &cdofs);CHKERRQ(ierr);
2214b3b16f48SMatthew G. Knepley         for (d = 0, e = 0; d < dof; ++d) {
221584330215SMatthew G. Knepley           if ((cind < cdof) && (d == cdofs[cind])) {++cind; continue;}
2216b3b16f48SMatthew G. Knepley           gArray[goff-gStart+e++] = lArray[off+d];
221784330215SMatthew G. Knepley         }
2218b3b16f48SMatthew 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);
221984330215SMatthew G. Knepley     }
2220ae5cfb4aSMatthew G. Knepley     ierr = VecRestoreArrayRead(l, &lArray);CHKERRQ(ierr);
22217128ae9fSMatthew G Knepley     ierr = VecRestoreArray(g, &gArray);CHKERRQ(ierr);
22227128ae9fSMatthew G Knepley   } else {
2223843c4018SMatthew G Knepley     ierr = (*dm->ops->localtoglobalbegin)(dm,l,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),g);CHKERRQ(ierr);
22247128ae9fSMatthew G Knepley   }
22259a42bb27SBarry Smith   PetscFunctionReturn(0);
22269a42bb27SBarry Smith }
22279a42bb27SBarry Smith 
22289a42bb27SBarry Smith #undef __FUNCT__
22299a42bb27SBarry Smith #define __FUNCT__ "DMLocalToGlobalEnd"
22309a42bb27SBarry Smith /*@
22319a42bb27SBarry Smith     DMLocalToGlobalEnd - updates global vectors from local vectors
223247c6ae99SBarry Smith 
223347c6ae99SBarry Smith     Neighbor-wise Collective on DM
223447c6ae99SBarry Smith 
223547c6ae99SBarry Smith     Input Parameters:
223647c6ae99SBarry Smith +   dm - the DM object
2237f6813fd5SJed Brown .   l - the local vector
223847c6ae99SBarry Smith .   mode - INSERT_VALUES or ADD_VALUES
2239f6813fd5SJed Brown -   g - the global vector
224047c6ae99SBarry Smith 
224147c6ae99SBarry Smith 
224247c6ae99SBarry Smith     Level: beginner
224347c6ae99SBarry Smith 
2244e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMGlobalToLocalEnd()
224547c6ae99SBarry Smith 
224647c6ae99SBarry Smith @*/
22477087cfbeSBarry Smith PetscErrorCode  DMLocalToGlobalEnd(DM dm,Vec l,InsertMode mode,Vec g)
224847c6ae99SBarry Smith {
22497128ae9fSMatthew G Knepley   PetscSF                 sf;
225084330215SMatthew G. Knepley   PetscSection            s;
2251d4d07f1eSToby Isaac   DMLocalToGlobalHookLink link;
225284330215SMatthew G. Knepley   PetscBool               isInsert;
225384330215SMatthew G. Knepley   PetscErrorCode          ierr;
225447c6ae99SBarry Smith 
225547c6ae99SBarry Smith   PetscFunctionBegin;
2256171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
22577128ae9fSMatthew G Knepley   ierr = DMGetDefaultSF(dm, &sf);CHKERRQ(ierr);
225884330215SMatthew G. Knepley   ierr = DMGetDefaultSection(dm, &s);CHKERRQ(ierr);
22597128ae9fSMatthew G Knepley   switch (mode) {
22607128ae9fSMatthew G Knepley   case INSERT_VALUES:
22617128ae9fSMatthew G Knepley   case INSERT_ALL_VALUES:
226284330215SMatthew G. Knepley     isInsert = PETSC_TRUE; break;
22637128ae9fSMatthew G Knepley   case ADD_VALUES:
22647128ae9fSMatthew G Knepley   case ADD_ALL_VALUES:
226584330215SMatthew G. Knepley     isInsert = PETSC_FALSE; break;
22667128ae9fSMatthew G Knepley   default:
226782f516ccSBarry Smith     SETERRQ1(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
22687128ae9fSMatthew G Knepley   }
226984330215SMatthew G. Knepley   if (sf && !isInsert) {
2270ae5cfb4aSMatthew G. Knepley     const PetscScalar *lArray;
2271ae5cfb4aSMatthew G. Knepley     PetscScalar       *gArray;
227284330215SMatthew G. Knepley 
2273ae5cfb4aSMatthew G. Knepley     ierr = VecGetArrayRead(l, &lArray);CHKERRQ(ierr);
22747128ae9fSMatthew G Knepley     ierr = VecGetArray(g, &gArray);CHKERRQ(ierr);
2275a9b180a6SBarry Smith     ierr = PetscSFReduceEnd(sf, MPIU_SCALAR, lArray, gArray, MPIU_SUM);CHKERRQ(ierr);
2276ae5cfb4aSMatthew G. Knepley     ierr = VecRestoreArrayRead(l, &lArray);CHKERRQ(ierr);
22777128ae9fSMatthew G Knepley     ierr = VecRestoreArray(g, &gArray);CHKERRQ(ierr);
227884330215SMatthew G. Knepley   } else if (s && isInsert) {
22797128ae9fSMatthew G Knepley   } else {
2280843c4018SMatthew G Knepley     ierr = (*dm->ops->localtoglobalend)(dm,l,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),g);CHKERRQ(ierr);
22817128ae9fSMatthew G Knepley   }
2282d4d07f1eSToby Isaac   for (link=dm->ltoghook; link; link=link->next) {
2283d4d07f1eSToby Isaac     if (link->endhook) {ierr = (*link->endhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);}
2284d4d07f1eSToby Isaac   }
228547c6ae99SBarry Smith   PetscFunctionReturn(0);
228647c6ae99SBarry Smith }
228747c6ae99SBarry Smith 
228847c6ae99SBarry Smith #undef __FUNCT__
2289f089877aSRichard Tran Mills #define __FUNCT__ "DMLocalToLocalBegin"
2290f089877aSRichard Tran Mills /*@
2291bc0a1609SRichard Tran Mills    DMLocalToLocalBegin - Maps from a local vector (including ghost points
2292bc0a1609SRichard Tran Mills    that contain irrelevant values) to another local vector where the ghost
2293d78e899eSRichard Tran Mills    points in the second are set correctly. Must be followed by DMLocalToLocalEnd().
2294f089877aSRichard Tran Mills 
2295bc0a1609SRichard Tran Mills    Neighbor-wise Collective on DM and Vec
2296f089877aSRichard Tran Mills 
2297f089877aSRichard Tran Mills    Input Parameters:
2298f089877aSRichard Tran Mills +  dm - the DM object
2299bc0a1609SRichard Tran Mills .  g - the original local vector
2300bc0a1609SRichard Tran Mills -  mode - one of INSERT_VALUES or ADD_VALUES
2301f089877aSRichard Tran Mills 
2302bc0a1609SRichard Tran Mills    Output Parameter:
2303bc0a1609SRichard Tran Mills .  l  - the local vector with correct ghost values
2304f089877aSRichard Tran Mills 
2305f089877aSRichard Tran Mills    Level: intermediate
2306f089877aSRichard Tran Mills 
2307bc0a1609SRichard Tran Mills    Notes:
2308bc0a1609SRichard Tran Mills    The local vectors used here need not be the same as those
2309bc0a1609SRichard Tran Mills    obtained from DMCreateLocalVector(), BUT they
2310bc0a1609SRichard Tran Mills    must have the same parallel data layout; they could, for example, be
2311bc0a1609SRichard Tran Mills    obtained with VecDuplicate() from the DM originating vectors.
2312bc0a1609SRichard Tran Mills 
2313bc0a1609SRichard Tran Mills .keywords: DM, local-to-local, begin
2314bc0a1609SRichard Tran Mills .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateLocalVector(), DMCreateGlobalVector(), DMCreateInterpolation(), DMLocalToLocalEnd(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin()
2315f089877aSRichard Tran Mills 
2316f089877aSRichard Tran Mills @*/
2317f089877aSRichard Tran Mills PetscErrorCode  DMLocalToLocalBegin(DM dm,Vec g,InsertMode mode,Vec l)
2318f089877aSRichard Tran Mills {
2319f089877aSRichard Tran Mills   PetscErrorCode          ierr;
2320f089877aSRichard Tran Mills 
2321f089877aSRichard Tran Mills   PetscFunctionBegin;
2322f089877aSRichard Tran Mills   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2323f089877aSRichard Tran Mills   ierr = (*dm->ops->localtolocalbegin)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
2324f089877aSRichard Tran Mills   PetscFunctionReturn(0);
2325f089877aSRichard Tran Mills }
2326f089877aSRichard Tran Mills 
2327f089877aSRichard Tran Mills #undef __FUNCT__
2328f089877aSRichard Tran Mills #define __FUNCT__ "DMLocalToLocalEnd"
2329f089877aSRichard Tran Mills /*@
2330bc0a1609SRichard Tran Mills    DMLocalToLocalEnd - Maps from a local vector (including ghost points
2331bc0a1609SRichard Tran Mills    that contain irrelevant values) to another local vector where the ghost
2332d78e899eSRichard Tran Mills    points in the second are set correctly. Must be preceded by DMLocalToLocalBegin().
2333f089877aSRichard Tran Mills 
2334bc0a1609SRichard Tran Mills    Neighbor-wise Collective on DM and Vec
2335f089877aSRichard Tran Mills 
2336f089877aSRichard Tran Mills    Input Parameters:
2337bc0a1609SRichard Tran Mills +  da - the DM object
2338bc0a1609SRichard Tran Mills .  g - the original local vector
2339bc0a1609SRichard Tran Mills -  mode - one of INSERT_VALUES or ADD_VALUES
2340f089877aSRichard Tran Mills 
2341bc0a1609SRichard Tran Mills    Output Parameter:
2342bc0a1609SRichard Tran Mills .  l  - the local vector with correct ghost values
2343f089877aSRichard Tran Mills 
2344f089877aSRichard Tran Mills    Level: intermediate
2345f089877aSRichard Tran Mills 
2346bc0a1609SRichard Tran Mills    Notes:
2347bc0a1609SRichard Tran Mills    The local vectors used here need not be the same as those
2348bc0a1609SRichard Tran Mills    obtained from DMCreateLocalVector(), BUT they
2349bc0a1609SRichard Tran Mills    must have the same parallel data layout; they could, for example, be
2350bc0a1609SRichard Tran Mills    obtained with VecDuplicate() from the DM originating vectors.
2351bc0a1609SRichard Tran Mills 
2352bc0a1609SRichard Tran Mills .keywords: DM, local-to-local, end
2353bc0a1609SRichard Tran Mills .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateLocalVector(), DMCreateGlobalVector(), DMCreateInterpolation(), DMLocalToLocalBegin(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin()
2354f089877aSRichard Tran Mills 
2355f089877aSRichard Tran Mills @*/
2356f089877aSRichard Tran Mills PetscErrorCode  DMLocalToLocalEnd(DM dm,Vec g,InsertMode mode,Vec l)
2357f089877aSRichard Tran Mills {
2358f089877aSRichard Tran Mills   PetscErrorCode          ierr;
2359f089877aSRichard Tran Mills 
2360f089877aSRichard Tran Mills   PetscFunctionBegin;
2361f089877aSRichard Tran Mills   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2362f089877aSRichard Tran Mills   ierr = (*dm->ops->localtolocalend)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
2363f089877aSRichard Tran Mills   PetscFunctionReturn(0);
2364f089877aSRichard Tran Mills }
2365f089877aSRichard Tran Mills 
2366f089877aSRichard Tran Mills 
2367f089877aSRichard Tran Mills #undef __FUNCT__
236847c6ae99SBarry Smith #define __FUNCT__ "DMCoarsen"
236947c6ae99SBarry Smith /*@
237047c6ae99SBarry Smith     DMCoarsen - Coarsens a DM object
237147c6ae99SBarry Smith 
237247c6ae99SBarry Smith     Collective on DM
237347c6ae99SBarry Smith 
237447c6ae99SBarry Smith     Input Parameter:
237547c6ae99SBarry Smith +   dm - the DM object
237691d95f02SJed Brown -   comm - the communicator to contain the new DM object (or MPI_COMM_NULL)
237747c6ae99SBarry Smith 
237847c6ae99SBarry Smith     Output Parameter:
237947c6ae99SBarry Smith .   dmc - the coarsened DM
238047c6ae99SBarry Smith 
238147c6ae99SBarry Smith     Level: developer
238247c6ae99SBarry Smith 
2383e727c939SJed Brown .seealso DMRefine(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
238447c6ae99SBarry Smith 
238547c6ae99SBarry Smith @*/
23867087cfbeSBarry Smith PetscErrorCode DMCoarsen(DM dm, MPI_Comm comm, DM *dmc)
238747c6ae99SBarry Smith {
238847c6ae99SBarry Smith   PetscErrorCode    ierr;
2389b17ce1afSJed Brown   DMCoarsenHookLink link;
239047c6ae99SBarry Smith 
239147c6ae99SBarry Smith   PetscFunctionBegin;
2392171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2393fef3a512SBarry Smith   if (!dm->ops->coarsen) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"This DM cannot coarsen");
239447a35634SPatrick Farrell   ierr = PetscLogEventBegin(DM_Coarsen,dm,0,0,0);CHKERRQ(ierr);
239547c6ae99SBarry Smith   ierr                      = (*dm->ops->coarsen)(dm, comm, dmc);CHKERRQ(ierr);
23968892b4c3SMatthew G. Knepley   if (!(*dmc)) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "NULL coarse mesh produced");
2397a8fb8f29SToby Isaac   ierr = DMSetCoarseDM(dm,*dmc);CHKERRQ(ierr);
239843842a1eSJed Brown   (*dmc)->ops->creatematrix = dm->ops->creatematrix;
23998cd211a4SJed Brown   ierr                      = PetscObjectCopyFortranFunctionPointers((PetscObject)dm,(PetscObject)*dmc);CHKERRQ(ierr);
2400644e2e5bSBarry Smith   (*dmc)->ctx               = dm->ctx;
24010598a293SJed Brown   (*dmc)->levelup           = dm->levelup;
2402656b349aSBarry Smith   (*dmc)->leveldown         = dm->leveldown + 1;
2403e4b4b23bSJed Brown   ierr                      = DMSetMatType(*dmc,dm->mattype);CHKERRQ(ierr);
2404b17ce1afSJed Brown   for (link=dm->coarsenhook; link; link=link->next) {
2405b17ce1afSJed Brown     if (link->coarsenhook) {ierr = (*link->coarsenhook)(dm,*dmc,link->ctx);CHKERRQ(ierr);}
2406b17ce1afSJed Brown   }
240747a35634SPatrick Farrell   ierr = PetscLogEventEnd(DM_Coarsen,dm,0,0,0);CHKERRQ(ierr);
2408b17ce1afSJed Brown   PetscFunctionReturn(0);
2409b17ce1afSJed Brown }
2410b17ce1afSJed Brown 
2411b17ce1afSJed Brown #undef __FUNCT__
2412b17ce1afSJed Brown #define __FUNCT__ "DMCoarsenHookAdd"
2413bb9467b5SJed Brown /*@C
2414b17ce1afSJed Brown    DMCoarsenHookAdd - adds a callback to be run when restricting a nonlinear problem to the coarse grid
2415b17ce1afSJed Brown 
2416b17ce1afSJed Brown    Logically Collective
2417b17ce1afSJed Brown 
2418b17ce1afSJed Brown    Input Arguments:
2419b17ce1afSJed Brown +  fine - nonlinear solver context on which to run a hook when restricting to a coarser level
2420b17ce1afSJed Brown .  coarsenhook - function to run when setting up a coarser level
2421b17ce1afSJed Brown .  restricthook - function to run to update data on coarser levels (once per SNESSolve())
24220298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
2423b17ce1afSJed Brown 
2424b17ce1afSJed Brown    Calling sequence of coarsenhook:
2425b17ce1afSJed Brown $    coarsenhook(DM fine,DM coarse,void *ctx);
2426b17ce1afSJed Brown 
2427b17ce1afSJed Brown +  fine - fine level DM
2428b17ce1afSJed Brown .  coarse - coarse level DM to restrict problem to
2429b17ce1afSJed Brown -  ctx - optional user-defined function context
2430b17ce1afSJed Brown 
2431b17ce1afSJed Brown    Calling sequence for restricthook:
2432c833c3b5SJed Brown $    restricthook(DM fine,Mat mrestrict,Vec rscale,Mat inject,DM coarse,void *ctx)
2433b17ce1afSJed Brown 
2434b17ce1afSJed Brown +  fine - fine level DM
2435b17ce1afSJed Brown .  mrestrict - matrix restricting a fine-level solution to the coarse grid
2436c833c3b5SJed Brown .  rscale - scaling vector for restriction
2437c833c3b5SJed Brown .  inject - matrix restricting by injection
2438b17ce1afSJed Brown .  coarse - coarse level DM to update
2439b17ce1afSJed Brown -  ctx - optional user-defined function context
2440b17ce1afSJed Brown 
2441b17ce1afSJed Brown    Level: advanced
2442b17ce1afSJed Brown 
2443b17ce1afSJed Brown    Notes:
2444b17ce1afSJed Brown    This function is only needed if auxiliary data needs to be set up on coarse grids.
2445b17ce1afSJed Brown 
2446b17ce1afSJed Brown    If this function is called multiple times, the hooks will be run in the order they are added.
2447b17ce1afSJed Brown 
2448b17ce1afSJed Brown    In order to compose with nonlinear preconditioning without duplicating storage, the hook should be implemented to
2449b17ce1afSJed Brown    extract the finest level information from its context (instead of from the SNES).
2450b17ce1afSJed Brown 
2451bb9467b5SJed Brown    This function is currently not available from Fortran.
2452bb9467b5SJed Brown 
2453c833c3b5SJed Brown .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
2454b17ce1afSJed Brown @*/
2455b17ce1afSJed Brown PetscErrorCode DMCoarsenHookAdd(DM fine,PetscErrorCode (*coarsenhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,Mat,Vec,Mat,DM,void*),void *ctx)
2456b17ce1afSJed Brown {
2457b17ce1afSJed Brown   PetscErrorCode    ierr;
2458b17ce1afSJed Brown   DMCoarsenHookLink link,*p;
2459b17ce1afSJed Brown 
2460b17ce1afSJed Brown   PetscFunctionBegin;
2461b17ce1afSJed Brown   PetscValidHeaderSpecific(fine,DM_CLASSID,1);
24626bfea28cSJed Brown   for (p=&fine->coarsenhook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */
246395dccacaSBarry Smith   ierr               = PetscNew(&link);CHKERRQ(ierr);
2464b17ce1afSJed Brown   link->coarsenhook  = coarsenhook;
2465b17ce1afSJed Brown   link->restricthook = restricthook;
2466b17ce1afSJed Brown   link->ctx          = ctx;
24670298fd71SBarry Smith   link->next         = NULL;
2468b17ce1afSJed Brown   *p                 = link;
2469b17ce1afSJed Brown   PetscFunctionReturn(0);
2470b17ce1afSJed Brown }
2471b17ce1afSJed Brown 
2472b17ce1afSJed Brown #undef __FUNCT__
2473b17ce1afSJed Brown #define __FUNCT__ "DMRestrict"
2474b17ce1afSJed Brown /*@
2475b17ce1afSJed Brown    DMRestrict - restricts user-defined problem data to a coarser DM by running hooks registered by DMCoarsenHookAdd()
2476b17ce1afSJed Brown 
2477b17ce1afSJed Brown    Collective if any hooks are
2478b17ce1afSJed Brown 
2479b17ce1afSJed Brown    Input Arguments:
2480b17ce1afSJed Brown +  fine - finer DM to use as a base
2481b17ce1afSJed Brown .  restrct - restriction matrix, apply using MatRestrict()
2482b17ce1afSJed Brown .  inject - injection matrix, also use MatRestrict()
2483b17ce1afSJed Brown -  coarse - coarer DM to update
2484b17ce1afSJed Brown 
2485b17ce1afSJed Brown    Level: developer
2486b17ce1afSJed Brown 
2487b17ce1afSJed Brown .seealso: DMCoarsenHookAdd(), MatRestrict()
2488b17ce1afSJed Brown @*/
2489b17ce1afSJed Brown PetscErrorCode DMRestrict(DM fine,Mat restrct,Vec rscale,Mat inject,DM coarse)
2490b17ce1afSJed Brown {
2491b17ce1afSJed Brown   PetscErrorCode    ierr;
2492b17ce1afSJed Brown   DMCoarsenHookLink link;
2493b17ce1afSJed Brown 
2494b17ce1afSJed Brown   PetscFunctionBegin;
2495b17ce1afSJed Brown   for (link=fine->coarsenhook; link; link=link->next) {
24968865f1eaSKarl Rupp     if (link->restricthook) {
24978865f1eaSKarl Rupp       ierr = (*link->restricthook)(fine,restrct,rscale,inject,coarse,link->ctx);CHKERRQ(ierr);
24988865f1eaSKarl Rupp     }
2499b17ce1afSJed Brown   }
250047c6ae99SBarry Smith   PetscFunctionReturn(0);
250147c6ae99SBarry Smith }
250247c6ae99SBarry Smith 
250347c6ae99SBarry Smith #undef __FUNCT__
2504be081cd6SPeter Brune #define __FUNCT__ "DMSubDomainHookAdd"
2505bb9467b5SJed Brown /*@C
2506be081cd6SPeter Brune    DMSubDomainHookAdd - adds a callback to be run when restricting a problem to the coarse grid
25075dbd56e3SPeter Brune 
25085dbd56e3SPeter Brune    Logically Collective
25095dbd56e3SPeter Brune 
25105dbd56e3SPeter Brune    Input Arguments:
25115dbd56e3SPeter Brune +  global - global DM
2512ec4806b8SPeter Brune .  ddhook - function to run to pass data to the decomposition DM upon its creation
25135dbd56e3SPeter Brune .  restricthook - function to run to update data on block solve (at the beginning of the block solve)
25140298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
25155dbd56e3SPeter Brune 
2516ec4806b8SPeter Brune 
2517ec4806b8SPeter Brune    Calling sequence for ddhook:
2518ec4806b8SPeter Brune $    ddhook(DM global,DM block,void *ctx)
2519ec4806b8SPeter Brune 
2520ec4806b8SPeter Brune +  global - global DM
2521ec4806b8SPeter Brune .  block  - block DM
2522ec4806b8SPeter Brune -  ctx - optional user-defined function context
2523ec4806b8SPeter Brune 
25245dbd56e3SPeter Brune    Calling sequence for restricthook:
2525ec4806b8SPeter Brune $    restricthook(DM global,VecScatter out,VecScatter in,DM block,void *ctx)
25265dbd56e3SPeter Brune 
25275dbd56e3SPeter Brune +  global - global DM
25285dbd56e3SPeter Brune .  out    - scatter to the outer (with ghost and overlap points) block vector
25295dbd56e3SPeter Brune .  in     - scatter to block vector values only owned locally
2530ec4806b8SPeter Brune .  block  - block DM
25315dbd56e3SPeter Brune -  ctx - optional user-defined function context
25325dbd56e3SPeter Brune 
25335dbd56e3SPeter Brune    Level: advanced
25345dbd56e3SPeter Brune 
25355dbd56e3SPeter Brune    Notes:
2536ec4806b8SPeter Brune    This function is only needed if auxiliary data needs to be set up on subdomain DMs.
25375dbd56e3SPeter Brune 
25385dbd56e3SPeter Brune    If this function is called multiple times, the hooks will be run in the order they are added.
25395dbd56e3SPeter Brune 
25405dbd56e3SPeter Brune    In order to compose with nonlinear preconditioning without duplicating storage, the hook should be implemented to
2541ec4806b8SPeter Brune    extract the global information from its context (instead of from the SNES).
25425dbd56e3SPeter Brune 
2543bb9467b5SJed Brown    This function is currently not available from Fortran.
2544bb9467b5SJed Brown 
25455dbd56e3SPeter Brune .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
25465dbd56e3SPeter Brune @*/
2547be081cd6SPeter Brune PetscErrorCode DMSubDomainHookAdd(DM global,PetscErrorCode (*ddhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,VecScatter,VecScatter,DM,void*),void *ctx)
25485dbd56e3SPeter Brune {
25495dbd56e3SPeter Brune   PetscErrorCode      ierr;
2550be081cd6SPeter Brune   DMSubDomainHookLink link,*p;
25515dbd56e3SPeter Brune 
25525dbd56e3SPeter Brune   PetscFunctionBegin;
25535dbd56e3SPeter Brune   PetscValidHeaderSpecific(global,DM_CLASSID,1);
2554be081cd6SPeter Brune   for (p=&global->subdomainhook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */
255595dccacaSBarry Smith   ierr               = PetscNew(&link);CHKERRQ(ierr);
25565dbd56e3SPeter Brune   link->restricthook = restricthook;
2557be081cd6SPeter Brune   link->ddhook       = ddhook;
25585dbd56e3SPeter Brune   link->ctx          = ctx;
25590298fd71SBarry Smith   link->next         = NULL;
25605dbd56e3SPeter Brune   *p                 = link;
25615dbd56e3SPeter Brune   PetscFunctionReturn(0);
25625dbd56e3SPeter Brune }
25635dbd56e3SPeter Brune 
25645dbd56e3SPeter Brune #undef __FUNCT__
2565be081cd6SPeter Brune #define __FUNCT__ "DMSubDomainRestrict"
25665dbd56e3SPeter Brune /*@
2567be081cd6SPeter Brune    DMSubDomainRestrict - restricts user-defined problem data to a block DM by running hooks registered by DMSubDomainHookAdd()
25685dbd56e3SPeter Brune 
25695dbd56e3SPeter Brune    Collective if any hooks are
25705dbd56e3SPeter Brune 
25715dbd56e3SPeter Brune    Input Arguments:
25725dbd56e3SPeter Brune +  fine - finer DM to use as a base
2573be081cd6SPeter Brune .  oscatter - scatter from domain global vector filling subdomain global vector with overlap
2574be081cd6SPeter Brune .  gscatter - scatter from domain global vector filling subdomain local vector with ghosts
25755dbd56e3SPeter Brune -  coarse - coarer DM to update
25765dbd56e3SPeter Brune 
25775dbd56e3SPeter Brune    Level: developer
25785dbd56e3SPeter Brune 
25795dbd56e3SPeter Brune .seealso: DMCoarsenHookAdd(), MatRestrict()
25805dbd56e3SPeter Brune @*/
2581be081cd6SPeter Brune PetscErrorCode DMSubDomainRestrict(DM global,VecScatter oscatter,VecScatter gscatter,DM subdm)
25825dbd56e3SPeter Brune {
25835dbd56e3SPeter Brune   PetscErrorCode      ierr;
2584be081cd6SPeter Brune   DMSubDomainHookLink link;
25855dbd56e3SPeter Brune 
25865dbd56e3SPeter Brune   PetscFunctionBegin;
2587be081cd6SPeter Brune   for (link=global->subdomainhook; link; link=link->next) {
25888865f1eaSKarl Rupp     if (link->restricthook) {
25898865f1eaSKarl Rupp       ierr = (*link->restricthook)(global,oscatter,gscatter,subdm,link->ctx);CHKERRQ(ierr);
25908865f1eaSKarl Rupp     }
25915dbd56e3SPeter Brune   }
25925dbd56e3SPeter Brune   PetscFunctionReturn(0);
25935dbd56e3SPeter Brune }
25945dbd56e3SPeter Brune 
25955dbd56e3SPeter Brune #undef __FUNCT__
25965fe1f584SPeter Brune #define __FUNCT__ "DMGetCoarsenLevel"
25975fe1f584SPeter Brune /*@
25986a7d9d85SPeter Brune     DMGetCoarsenLevel - Get's the number of coarsenings that have generated this DM.
25995fe1f584SPeter Brune 
26005fe1f584SPeter Brune     Not Collective
26015fe1f584SPeter Brune 
26025fe1f584SPeter Brune     Input Parameter:
26035fe1f584SPeter Brune .   dm - the DM object
26045fe1f584SPeter Brune 
26055fe1f584SPeter Brune     Output Parameter:
26066a7d9d85SPeter Brune .   level - number of coarsenings
26075fe1f584SPeter Brune 
26085fe1f584SPeter Brune     Level: developer
26095fe1f584SPeter Brune 
26106a7d9d85SPeter Brune .seealso DMCoarsen(), DMGetRefineLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
26115fe1f584SPeter Brune 
26125fe1f584SPeter Brune @*/
26135fe1f584SPeter Brune PetscErrorCode  DMGetCoarsenLevel(DM dm,PetscInt *level)
26145fe1f584SPeter Brune {
26155fe1f584SPeter Brune   PetscFunctionBegin;
26165fe1f584SPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
26175fe1f584SPeter Brune   *level = dm->leveldown;
26185fe1f584SPeter Brune   PetscFunctionReturn(0);
26195fe1f584SPeter Brune }
26205fe1f584SPeter Brune 
26215fe1f584SPeter Brune 
26225fe1f584SPeter Brune 
26235fe1f584SPeter Brune #undef __FUNCT__
262447c6ae99SBarry Smith #define __FUNCT__ "DMRefineHierarchy"
262547c6ae99SBarry Smith /*@C
262647c6ae99SBarry Smith     DMRefineHierarchy - Refines a DM object, all levels at once
262747c6ae99SBarry Smith 
262847c6ae99SBarry Smith     Collective on DM
262947c6ae99SBarry Smith 
263047c6ae99SBarry Smith     Input Parameter:
263147c6ae99SBarry Smith +   dm - the DM object
263247c6ae99SBarry Smith -   nlevels - the number of levels of refinement
263347c6ae99SBarry Smith 
263447c6ae99SBarry Smith     Output Parameter:
263547c6ae99SBarry Smith .   dmf - the refined DM hierarchy
263647c6ae99SBarry Smith 
263747c6ae99SBarry Smith     Level: developer
263847c6ae99SBarry Smith 
2639e727c939SJed Brown .seealso DMCoarsenHierarchy(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
264047c6ae99SBarry Smith 
264147c6ae99SBarry Smith @*/
26427087cfbeSBarry Smith PetscErrorCode  DMRefineHierarchy(DM dm,PetscInt nlevels,DM dmf[])
264347c6ae99SBarry Smith {
264447c6ae99SBarry Smith   PetscErrorCode ierr;
264547c6ae99SBarry Smith 
264647c6ae99SBarry Smith   PetscFunctionBegin;
2647171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2648ce94432eSBarry Smith   if (nlevels < 0) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_OUTOFRANGE,"nlevels cannot be negative");
264947c6ae99SBarry Smith   if (nlevels == 0) PetscFunctionReturn(0);
265047c6ae99SBarry Smith   if (dm->ops->refinehierarchy) {
265147c6ae99SBarry Smith     ierr = (*dm->ops->refinehierarchy)(dm,nlevels,dmf);CHKERRQ(ierr);
265247c6ae99SBarry Smith   } else if (dm->ops->refine) {
265347c6ae99SBarry Smith     PetscInt i;
265447c6ae99SBarry Smith 
2655ce94432eSBarry Smith     ierr = DMRefine(dm,PetscObjectComm((PetscObject)dm),&dmf[0]);CHKERRQ(ierr);
265647c6ae99SBarry Smith     for (i=1; i<nlevels; i++) {
2657ce94432eSBarry Smith       ierr = DMRefine(dmf[i-1],PetscObjectComm((PetscObject)dm),&dmf[i]);CHKERRQ(ierr);
265847c6ae99SBarry Smith     }
2659ce94432eSBarry Smith   } else SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"No RefineHierarchy for this DM yet");
266047c6ae99SBarry Smith   PetscFunctionReturn(0);
266147c6ae99SBarry Smith }
266247c6ae99SBarry Smith 
266347c6ae99SBarry Smith #undef __FUNCT__
266447c6ae99SBarry Smith #define __FUNCT__ "DMCoarsenHierarchy"
266547c6ae99SBarry Smith /*@C
266647c6ae99SBarry Smith     DMCoarsenHierarchy - Coarsens a DM object, all levels at once
266747c6ae99SBarry Smith 
266847c6ae99SBarry Smith     Collective on DM
266947c6ae99SBarry Smith 
267047c6ae99SBarry Smith     Input Parameter:
267147c6ae99SBarry Smith +   dm - the DM object
267247c6ae99SBarry Smith -   nlevels - the number of levels of coarsening
267347c6ae99SBarry Smith 
267447c6ae99SBarry Smith     Output Parameter:
267547c6ae99SBarry Smith .   dmc - the coarsened DM hierarchy
267647c6ae99SBarry Smith 
267747c6ae99SBarry Smith     Level: developer
267847c6ae99SBarry Smith 
2679e727c939SJed Brown .seealso DMRefineHierarchy(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
268047c6ae99SBarry Smith 
268147c6ae99SBarry Smith @*/
26827087cfbeSBarry Smith PetscErrorCode  DMCoarsenHierarchy(DM dm, PetscInt nlevels, DM dmc[])
268347c6ae99SBarry Smith {
268447c6ae99SBarry Smith   PetscErrorCode ierr;
268547c6ae99SBarry Smith 
268647c6ae99SBarry Smith   PetscFunctionBegin;
2687171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2688ce94432eSBarry Smith   if (nlevels < 0) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_OUTOFRANGE,"nlevels cannot be negative");
268947c6ae99SBarry Smith   if (nlevels == 0) PetscFunctionReturn(0);
269047c6ae99SBarry Smith   PetscValidPointer(dmc,3);
269147c6ae99SBarry Smith   if (dm->ops->coarsenhierarchy) {
269247c6ae99SBarry Smith     ierr = (*dm->ops->coarsenhierarchy)(dm, nlevels, dmc);CHKERRQ(ierr);
269347c6ae99SBarry Smith   } else if (dm->ops->coarsen) {
269447c6ae99SBarry Smith     PetscInt i;
269547c6ae99SBarry Smith 
2696ce94432eSBarry Smith     ierr = DMCoarsen(dm,PetscObjectComm((PetscObject)dm),&dmc[0]);CHKERRQ(ierr);
269747c6ae99SBarry Smith     for (i=1; i<nlevels; i++) {
2698ce94432eSBarry Smith       ierr = DMCoarsen(dmc[i-1],PetscObjectComm((PetscObject)dm),&dmc[i]);CHKERRQ(ierr);
269947c6ae99SBarry Smith     }
2700ce94432eSBarry Smith   } else SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"No CoarsenHierarchy for this DM yet");
270147c6ae99SBarry Smith   PetscFunctionReturn(0);
270247c6ae99SBarry Smith }
270347c6ae99SBarry Smith 
270447c6ae99SBarry Smith #undef __FUNCT__
2705e727c939SJed Brown #define __FUNCT__ "DMCreateAggregates"
270647c6ae99SBarry Smith /*@
2707e727c939SJed Brown    DMCreateAggregates - Gets the aggregates that map between
270847c6ae99SBarry Smith    grids associated with two DMs.
270947c6ae99SBarry Smith 
271047c6ae99SBarry Smith    Collective on DM
271147c6ae99SBarry Smith 
271247c6ae99SBarry Smith    Input Parameters:
271347c6ae99SBarry Smith +  dmc - the coarse grid DM
271447c6ae99SBarry Smith -  dmf - the fine grid DM
271547c6ae99SBarry Smith 
271647c6ae99SBarry Smith    Output Parameters:
271747c6ae99SBarry Smith .  rest - the restriction matrix (transpose of the projection matrix)
271847c6ae99SBarry Smith 
271947c6ae99SBarry Smith    Level: intermediate
272047c6ae99SBarry Smith 
272147c6ae99SBarry Smith .keywords: interpolation, restriction, multigrid
272247c6ae99SBarry Smith 
2723e727c939SJed Brown .seealso: DMRefine(), DMCreateInjection(), DMCreateInterpolation()
272447c6ae99SBarry Smith @*/
2725e727c939SJed Brown PetscErrorCode  DMCreateAggregates(DM dmc, DM dmf, Mat *rest)
272647c6ae99SBarry Smith {
272747c6ae99SBarry Smith   PetscErrorCode ierr;
272847c6ae99SBarry Smith 
272947c6ae99SBarry Smith   PetscFunctionBegin;
2730171400e9SBarry Smith   PetscValidHeaderSpecific(dmc,DM_CLASSID,1);
2731171400e9SBarry Smith   PetscValidHeaderSpecific(dmf,DM_CLASSID,2);
273247c6ae99SBarry Smith   ierr = (*dmc->ops->getaggregates)(dmc, dmf, rest);CHKERRQ(ierr);
273347c6ae99SBarry Smith   PetscFunctionReturn(0);
273447c6ae99SBarry Smith }
273547c6ae99SBarry Smith 
273647c6ae99SBarry Smith #undef __FUNCT__
27371a266240SBarry Smith #define __FUNCT__ "DMSetApplicationContextDestroy"
27381a266240SBarry Smith /*@C
27391a266240SBarry Smith     DMSetApplicationContextDestroy - Sets a user function that will be called to destroy the application context when the DM is destroyed
27401a266240SBarry Smith 
27411a266240SBarry Smith     Not Collective
27421a266240SBarry Smith 
27431a266240SBarry Smith     Input Parameters:
27441a266240SBarry Smith +   dm - the DM object
27451a266240SBarry Smith -   destroy - the destroy function
27461a266240SBarry Smith 
27471a266240SBarry Smith     Level: intermediate
27481a266240SBarry Smith 
2749e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
27501a266240SBarry Smith 
2751f07f9ceaSJed Brown @*/
27521a266240SBarry Smith PetscErrorCode  DMSetApplicationContextDestroy(DM dm,PetscErrorCode (*destroy)(void**))
27531a266240SBarry Smith {
27541a266240SBarry Smith   PetscFunctionBegin;
2755171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
27561a266240SBarry Smith   dm->ctxdestroy = destroy;
27571a266240SBarry Smith   PetscFunctionReturn(0);
27581a266240SBarry Smith }
27591a266240SBarry Smith 
27601a266240SBarry Smith #undef __FUNCT__
27611b2093e4SBarry Smith #define __FUNCT__ "DMSetApplicationContext"
2762b07ff414SBarry Smith /*@
27631b2093e4SBarry Smith     DMSetApplicationContext - Set a user context into a DM object
276447c6ae99SBarry Smith 
276547c6ae99SBarry Smith     Not Collective
276647c6ae99SBarry Smith 
276747c6ae99SBarry Smith     Input Parameters:
276847c6ae99SBarry Smith +   dm - the DM object
276947c6ae99SBarry Smith -   ctx - the user context
277047c6ae99SBarry Smith 
277147c6ae99SBarry Smith     Level: intermediate
277247c6ae99SBarry Smith 
2773e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
277447c6ae99SBarry Smith 
277547c6ae99SBarry Smith @*/
27761b2093e4SBarry Smith PetscErrorCode  DMSetApplicationContext(DM dm,void *ctx)
277747c6ae99SBarry Smith {
277847c6ae99SBarry Smith   PetscFunctionBegin;
2779171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
278047c6ae99SBarry Smith   dm->ctx = ctx;
278147c6ae99SBarry Smith   PetscFunctionReturn(0);
278247c6ae99SBarry Smith }
278347c6ae99SBarry Smith 
278447c6ae99SBarry Smith #undef __FUNCT__
27851b2093e4SBarry Smith #define __FUNCT__ "DMGetApplicationContext"
278647c6ae99SBarry Smith /*@
27871b2093e4SBarry Smith     DMGetApplicationContext - Gets a user context from a DM object
278847c6ae99SBarry Smith 
278947c6ae99SBarry Smith     Not Collective
279047c6ae99SBarry Smith 
279147c6ae99SBarry Smith     Input Parameter:
279247c6ae99SBarry Smith .   dm - the DM object
279347c6ae99SBarry Smith 
279447c6ae99SBarry Smith     Output Parameter:
279547c6ae99SBarry Smith .   ctx - the user context
279647c6ae99SBarry Smith 
279747c6ae99SBarry Smith     Level: intermediate
279847c6ae99SBarry Smith 
2799e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
280047c6ae99SBarry Smith 
280147c6ae99SBarry Smith @*/
28021b2093e4SBarry Smith PetscErrorCode  DMGetApplicationContext(DM dm,void *ctx)
280347c6ae99SBarry Smith {
280447c6ae99SBarry Smith   PetscFunctionBegin;
2805171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
28061b2093e4SBarry Smith   *(void**)ctx = dm->ctx;
280747c6ae99SBarry Smith   PetscFunctionReturn(0);
280847c6ae99SBarry Smith }
280947c6ae99SBarry Smith 
281047c6ae99SBarry Smith #undef __FUNCT__
281108da532bSDmitry Karpeev #define __FUNCT__ "DMSetVariableBounds"
281208da532bSDmitry Karpeev /*@C
2813df3898eeSBarry Smith     DMSetVariableBounds - sets a function to compute the lower and upper bound vectors for SNESVI.
281408da532bSDmitry Karpeev 
281508da532bSDmitry Karpeev     Logically Collective on DM
281608da532bSDmitry Karpeev 
281708da532bSDmitry Karpeev     Input Parameter:
281808da532bSDmitry Karpeev +   dm - the DM object
28190298fd71SBarry Smith -   f - the function that computes variable bounds used by SNESVI (use NULL to cancel a previous function that was set)
282008da532bSDmitry Karpeev 
282108da532bSDmitry Karpeev     Level: intermediate
282208da532bSDmitry Karpeev 
2823835c3ec7SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext(),
282408da532bSDmitry Karpeev          DMSetJacobian()
282508da532bSDmitry Karpeev 
282608da532bSDmitry Karpeev @*/
282708da532bSDmitry Karpeev PetscErrorCode  DMSetVariableBounds(DM dm,PetscErrorCode (*f)(DM,Vec,Vec))
282808da532bSDmitry Karpeev {
282908da532bSDmitry Karpeev   PetscFunctionBegin;
283008da532bSDmitry Karpeev   dm->ops->computevariablebounds = f;
283108da532bSDmitry Karpeev   PetscFunctionReturn(0);
283208da532bSDmitry Karpeev }
283308da532bSDmitry Karpeev 
283408da532bSDmitry Karpeev #undef __FUNCT__
283508da532bSDmitry Karpeev #define __FUNCT__ "DMHasVariableBounds"
283608da532bSDmitry Karpeev /*@
283708da532bSDmitry Karpeev     DMHasVariableBounds - does the DM object have a variable bounds function?
283808da532bSDmitry Karpeev 
283908da532bSDmitry Karpeev     Not Collective
284008da532bSDmitry Karpeev 
284108da532bSDmitry Karpeev     Input Parameter:
284208da532bSDmitry Karpeev .   dm - the DM object to destroy
284308da532bSDmitry Karpeev 
284408da532bSDmitry Karpeev     Output Parameter:
284508da532bSDmitry Karpeev .   flg - PETSC_TRUE if the variable bounds function exists
284608da532bSDmitry Karpeev 
284708da532bSDmitry Karpeev     Level: developer
284808da532bSDmitry Karpeev 
284974e1e8c1SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
285008da532bSDmitry Karpeev 
285108da532bSDmitry Karpeev @*/
285208da532bSDmitry Karpeev PetscErrorCode  DMHasVariableBounds(DM dm,PetscBool  *flg)
285308da532bSDmitry Karpeev {
285408da532bSDmitry Karpeev   PetscFunctionBegin;
285508da532bSDmitry Karpeev   *flg =  (dm->ops->computevariablebounds) ? PETSC_TRUE : PETSC_FALSE;
285608da532bSDmitry Karpeev   PetscFunctionReturn(0);
285708da532bSDmitry Karpeev }
285808da532bSDmitry Karpeev 
285908da532bSDmitry Karpeev #undef __FUNCT__
286008da532bSDmitry Karpeev #define __FUNCT__ "DMComputeVariableBounds"
286108da532bSDmitry Karpeev /*@C
286208da532bSDmitry Karpeev     DMComputeVariableBounds - compute variable bounds used by SNESVI.
286308da532bSDmitry Karpeev 
286408da532bSDmitry Karpeev     Logically Collective on DM
286508da532bSDmitry Karpeev 
286608da532bSDmitry Karpeev     Input Parameters:
2867907376e6SBarry Smith .   dm - the DM object
286808da532bSDmitry Karpeev 
286908da532bSDmitry Karpeev     Output parameters:
287008da532bSDmitry Karpeev +   xl - lower bound
287108da532bSDmitry Karpeev -   xu - upper bound
287208da532bSDmitry Karpeev 
2873907376e6SBarry Smith     Level: advanced
2874907376e6SBarry Smith 
2875907376e6SBarry Smith     Notes: This is generally not called by users. It calls the function provided by the user with DMSetVariableBounds()
287608da532bSDmitry Karpeev 
287774e1e8c1SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
287808da532bSDmitry Karpeev 
287908da532bSDmitry Karpeev @*/
288008da532bSDmitry Karpeev PetscErrorCode  DMComputeVariableBounds(DM dm, Vec xl, Vec xu)
288108da532bSDmitry Karpeev {
288208da532bSDmitry Karpeev   PetscErrorCode ierr;
28835fd66863SKarl Rupp 
288408da532bSDmitry Karpeev   PetscFunctionBegin;
288508da532bSDmitry Karpeev   PetscValidHeaderSpecific(xl,VEC_CLASSID,2);
288608da532bSDmitry Karpeev   PetscValidHeaderSpecific(xu,VEC_CLASSID,2);
288708da532bSDmitry Karpeev   if (dm->ops->computevariablebounds) {
288808da532bSDmitry Karpeev     ierr = (*dm->ops->computevariablebounds)(dm, xl,xu);CHKERRQ(ierr);
28898865f1eaSKarl Rupp   } else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, "This DM is incapable of computing variable bounds.");
289008da532bSDmitry Karpeev   PetscFunctionReturn(0);
289108da532bSDmitry Karpeev }
289208da532bSDmitry Karpeev 
289308da532bSDmitry Karpeev #undef __FUNCT__
2894b0ae01b7SPeter Brune #define __FUNCT__ "DMHasColoring"
2895b0ae01b7SPeter Brune /*@
2896b0ae01b7SPeter Brune     DMHasColoring - does the DM object have a method of providing a coloring?
2897b0ae01b7SPeter Brune 
2898b0ae01b7SPeter Brune     Not Collective
2899b0ae01b7SPeter Brune 
2900b0ae01b7SPeter Brune     Input Parameter:
2901b0ae01b7SPeter Brune .   dm - the DM object
2902b0ae01b7SPeter Brune 
2903b0ae01b7SPeter Brune     Output Parameter:
2904b0ae01b7SPeter Brune .   flg - PETSC_TRUE if the DM has facilities for DMCreateColoring().
2905b0ae01b7SPeter Brune 
2906b0ae01b7SPeter Brune     Level: developer
2907b0ae01b7SPeter Brune 
2908b0ae01b7SPeter Brune .seealso DMHasFunction(), DMCreateColoring()
2909b0ae01b7SPeter Brune 
2910b0ae01b7SPeter Brune @*/
2911b0ae01b7SPeter Brune PetscErrorCode  DMHasColoring(DM dm,PetscBool  *flg)
2912b0ae01b7SPeter Brune {
2913b0ae01b7SPeter Brune   PetscFunctionBegin;
2914b0ae01b7SPeter Brune   *flg =  (dm->ops->getcoloring) ? PETSC_TRUE : PETSC_FALSE;
2915b0ae01b7SPeter Brune   PetscFunctionReturn(0);
2916b0ae01b7SPeter Brune }
2917b0ae01b7SPeter Brune 
2918b0ae01b7SPeter Brune #undef __FUNCT__
29193ad4599aSBarry Smith #define __FUNCT__ "DMHasCreateRestriction"
29203ad4599aSBarry Smith /*@
29213ad4599aSBarry Smith     DMHasCreateRestriction - does the DM object have a method of providing a restriction?
29223ad4599aSBarry Smith 
29233ad4599aSBarry Smith     Not Collective
29243ad4599aSBarry Smith 
29253ad4599aSBarry Smith     Input Parameter:
29263ad4599aSBarry Smith .   dm - the DM object
29273ad4599aSBarry Smith 
29283ad4599aSBarry Smith     Output Parameter:
29293ad4599aSBarry Smith .   flg - PETSC_TRUE if the DM has facilities for DMCreateRestriction().
29303ad4599aSBarry Smith 
29313ad4599aSBarry Smith     Level: developer
29323ad4599aSBarry Smith 
29333ad4599aSBarry Smith .seealso DMHasFunction(), DMCreateRestriction()
29343ad4599aSBarry Smith 
29353ad4599aSBarry Smith @*/
29363ad4599aSBarry Smith PetscErrorCode  DMHasCreateRestriction(DM dm,PetscBool  *flg)
29373ad4599aSBarry Smith {
29383ad4599aSBarry Smith   PetscFunctionBegin;
29393ad4599aSBarry Smith   *flg =  (dm->ops->createrestriction) ? PETSC_TRUE : PETSC_FALSE;
29403ad4599aSBarry Smith   PetscFunctionReturn(0);
29413ad4599aSBarry Smith }
29423ad4599aSBarry Smith 
29433ad4599aSBarry Smith #undef  __FUNCT__
294408da532bSDmitry Karpeev #define __FUNCT__ "DMSetVec"
2945748fac09SDmitry Karpeev /*@C
294608da532bSDmitry Karpeev     DMSetVec - set the vector at which to compute residual, Jacobian and VI bounds, if the problem is nonlinear.
294708da532bSDmitry Karpeev 
294808da532bSDmitry Karpeev     Collective on DM
294908da532bSDmitry Karpeev 
295008da532bSDmitry Karpeev     Input Parameter:
295108da532bSDmitry Karpeev +   dm - the DM object
29520298fd71SBarry Smith -   x - location to compute residual and Jacobian, if NULL is passed to those routines; will be NULL for linear problems.
295308da532bSDmitry Karpeev 
295408da532bSDmitry Karpeev     Level: developer
295508da532bSDmitry Karpeev 
295674e1e8c1SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
295708da532bSDmitry Karpeev 
295808da532bSDmitry Karpeev @*/
295908da532bSDmitry Karpeev PetscErrorCode  DMSetVec(DM dm,Vec x)
296008da532bSDmitry Karpeev {
296108da532bSDmitry Karpeev   PetscErrorCode ierr;
29625fd66863SKarl Rupp 
296308da532bSDmitry Karpeev   PetscFunctionBegin;
296408da532bSDmitry Karpeev   if (x) {
296508da532bSDmitry Karpeev     if (!dm->x) {
296608da532bSDmitry Karpeev       ierr = DMCreateGlobalVector(dm,&dm->x);CHKERRQ(ierr);
296708da532bSDmitry Karpeev     }
296808da532bSDmitry Karpeev     ierr = VecCopy(x,dm->x);CHKERRQ(ierr);
29698865f1eaSKarl Rupp   } else if (dm->x) {
297008da532bSDmitry Karpeev     ierr = VecDestroy(&dm->x);CHKERRQ(ierr);
297108da532bSDmitry Karpeev   }
297208da532bSDmitry Karpeev   PetscFunctionReturn(0);
297308da532bSDmitry Karpeev }
297408da532bSDmitry Karpeev 
29750298fd71SBarry Smith PetscFunctionList DMList              = NULL;
2976264ace61SBarry Smith PetscBool         DMRegisterAllCalled = PETSC_FALSE;
2977264ace61SBarry Smith 
2978264ace61SBarry Smith #undef __FUNCT__
2979264ace61SBarry Smith #define __FUNCT__ "DMSetType"
2980264ace61SBarry Smith /*@C
2981264ace61SBarry Smith   DMSetType - Builds a DM, for a particular DM implementation.
2982264ace61SBarry Smith 
2983264ace61SBarry Smith   Collective on DM
2984264ace61SBarry Smith 
2985264ace61SBarry Smith   Input Parameters:
2986264ace61SBarry Smith + dm     - The DM object
2987264ace61SBarry Smith - method - The name of the DM type
2988264ace61SBarry Smith 
2989264ace61SBarry Smith   Options Database Key:
2990264ace61SBarry Smith . -dm_type <type> - Sets the DM type; use -help for a list of available types
2991264ace61SBarry Smith 
2992264ace61SBarry Smith   Notes:
2993e1589f56SBarry Smith   See "petsc/include/petscdm.h" for available DM types (for instance, DM1D, DM2D, or DM3D).
2994264ace61SBarry Smith 
2995264ace61SBarry Smith   Level: intermediate
2996264ace61SBarry Smith 
2997264ace61SBarry Smith .keywords: DM, set, type
2998264ace61SBarry Smith .seealso: DMGetType(), DMCreate()
2999264ace61SBarry Smith @*/
300019fd82e9SBarry Smith PetscErrorCode  DMSetType(DM dm, DMType method)
3001264ace61SBarry Smith {
3002264ace61SBarry Smith   PetscErrorCode (*r)(DM);
3003264ace61SBarry Smith   PetscBool      match;
3004264ace61SBarry Smith   PetscErrorCode ierr;
3005264ace61SBarry Smith 
3006264ace61SBarry Smith   PetscFunctionBegin;
3007264ace61SBarry Smith   PetscValidHeaderSpecific(dm, DM_CLASSID,1);
3008251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject) dm, method, &match);CHKERRQ(ierr);
3009264ace61SBarry Smith   if (match) PetscFunctionReturn(0);
3010264ace61SBarry Smith 
30110f51fdf8SToby Isaac   ierr = DMRegisterAll();CHKERRQ(ierr);
30121c9cd337SJed Brown   ierr = PetscFunctionListFind(DMList,method,&r);CHKERRQ(ierr);
3013ce94432eSBarry Smith   if (!r) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_UNKNOWN_TYPE, "Unknown DM type: %s", method);
3014264ace61SBarry Smith 
3015264ace61SBarry Smith   if (dm->ops->destroy) {
3016264ace61SBarry Smith     ierr             = (*dm->ops->destroy)(dm);CHKERRQ(ierr);
30170298fd71SBarry Smith     dm->ops->destroy = NULL;
3018264ace61SBarry Smith   }
3019264ace61SBarry Smith   ierr = (*r)(dm);CHKERRQ(ierr);
3020264ace61SBarry Smith   ierr = PetscObjectChangeTypeName((PetscObject)dm,method);CHKERRQ(ierr);
3021264ace61SBarry Smith   PetscFunctionReturn(0);
3022264ace61SBarry Smith }
3023264ace61SBarry Smith 
3024264ace61SBarry Smith #undef __FUNCT__
3025264ace61SBarry Smith #define __FUNCT__ "DMGetType"
3026264ace61SBarry Smith /*@C
3027264ace61SBarry Smith   DMGetType - Gets the DM type name (as a string) from the DM.
3028264ace61SBarry Smith 
3029264ace61SBarry Smith   Not Collective
3030264ace61SBarry Smith 
3031264ace61SBarry Smith   Input Parameter:
3032264ace61SBarry Smith . dm  - The DM
3033264ace61SBarry Smith 
3034264ace61SBarry Smith   Output Parameter:
3035264ace61SBarry Smith . type - The DM type name
3036264ace61SBarry Smith 
3037264ace61SBarry Smith   Level: intermediate
3038264ace61SBarry Smith 
3039264ace61SBarry Smith .keywords: DM, get, type, name
3040264ace61SBarry Smith .seealso: DMSetType(), DMCreate()
3041264ace61SBarry Smith @*/
304219fd82e9SBarry Smith PetscErrorCode  DMGetType(DM dm, DMType *type)
3043264ace61SBarry Smith {
3044264ace61SBarry Smith   PetscErrorCode ierr;
3045264ace61SBarry Smith 
3046264ace61SBarry Smith   PetscFunctionBegin;
3047264ace61SBarry Smith   PetscValidHeaderSpecific(dm, DM_CLASSID,1);
3048c959eef4SJed Brown   PetscValidPointer(type,2);
3049607a6623SBarry Smith   ierr = DMRegisterAll();CHKERRQ(ierr);
3050264ace61SBarry Smith   *type = ((PetscObject)dm)->type_name;
3051264ace61SBarry Smith   PetscFunctionReturn(0);
3052264ace61SBarry Smith }
3053264ace61SBarry Smith 
305467a56275SMatthew G Knepley #undef __FUNCT__
305567a56275SMatthew G Knepley #define __FUNCT__ "DMConvert"
305667a56275SMatthew G Knepley /*@C
305767a56275SMatthew G Knepley   DMConvert - Converts a DM to another DM, either of the same or different type.
305867a56275SMatthew G Knepley 
305967a56275SMatthew G Knepley   Collective on DM
306067a56275SMatthew G Knepley 
306167a56275SMatthew G Knepley   Input Parameters:
306267a56275SMatthew G Knepley + dm - the DM
306367a56275SMatthew G Knepley - newtype - new DM type (use "same" for the same type)
306467a56275SMatthew G Knepley 
306567a56275SMatthew G Knepley   Output Parameter:
306667a56275SMatthew G Knepley . M - pointer to new DM
306767a56275SMatthew G Knepley 
306867a56275SMatthew G Knepley   Notes:
306967a56275SMatthew G Knepley   Cannot be used to convert a sequential DM to parallel or parallel to sequential,
307067a56275SMatthew G Knepley   the MPI communicator of the generated DM is always the same as the communicator
307167a56275SMatthew G Knepley   of the input DM.
307267a56275SMatthew G Knepley 
307367a56275SMatthew G Knepley   Level: intermediate
307467a56275SMatthew G Knepley 
307567a56275SMatthew G Knepley .seealso: DMCreate()
307667a56275SMatthew G Knepley @*/
307719fd82e9SBarry Smith PetscErrorCode DMConvert(DM dm, DMType newtype, DM *M)
307867a56275SMatthew G Knepley {
307967a56275SMatthew G Knepley   DM             B;
308067a56275SMatthew G Knepley   char           convname[256];
3081c067b6caSMatthew G. Knepley   PetscBool      sametype/*, issame */;
308267a56275SMatthew G Knepley   PetscErrorCode ierr;
308367a56275SMatthew G Knepley 
308467a56275SMatthew G Knepley   PetscFunctionBegin;
308567a56275SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
308667a56275SMatthew G Knepley   PetscValidType(dm,1);
308767a56275SMatthew G Knepley   PetscValidPointer(M,3);
3088251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject) dm, newtype, &sametype);CHKERRQ(ierr);
3089c067b6caSMatthew G. Knepley   /* ierr = PetscStrcmp(newtype, "same", &issame);CHKERRQ(ierr); */
3090c067b6caSMatthew G. Knepley   if (sametype) {
3091c067b6caSMatthew G. Knepley     *M   = dm;
3092c067b6caSMatthew G. Knepley     ierr = PetscObjectReference((PetscObject) dm);CHKERRQ(ierr);
3093c067b6caSMatthew G. Knepley     PetscFunctionReturn(0);
3094c067b6caSMatthew G. Knepley   } else {
30950298fd71SBarry Smith     PetscErrorCode (*conv)(DM, DMType, DM*) = NULL;
309667a56275SMatthew G Knepley 
309767a56275SMatthew G Knepley     /*
309867a56275SMatthew G Knepley        Order of precedence:
309967a56275SMatthew G Knepley        1) See if a specialized converter is known to the current DM.
310067a56275SMatthew G Knepley        2) See if a specialized converter is known to the desired DM class.
310167a56275SMatthew G Knepley        3) See if a good general converter is registered for the desired class
310267a56275SMatthew G Knepley        4) See if a good general converter is known for the current matrix.
310367a56275SMatthew G Knepley        5) Use a really basic converter.
310467a56275SMatthew G Knepley     */
310567a56275SMatthew G Knepley 
310667a56275SMatthew G Knepley     /* 1) See if a specialized converter is known to the current DM and the desired class */
310767a56275SMatthew G Knepley     ierr = PetscStrcpy(convname,"DMConvert_");CHKERRQ(ierr);
310867a56275SMatthew G Knepley     ierr = PetscStrcat(convname,((PetscObject) dm)->type_name);CHKERRQ(ierr);
310967a56275SMatthew G Knepley     ierr = PetscStrcat(convname,"_");CHKERRQ(ierr);
311067a56275SMatthew G Knepley     ierr = PetscStrcat(convname,newtype);CHKERRQ(ierr);
311167a56275SMatthew G Knepley     ierr = PetscStrcat(convname,"_C");CHKERRQ(ierr);
31120005d66cSJed Brown     ierr = PetscObjectQueryFunction((PetscObject)dm,convname,&conv);CHKERRQ(ierr);
311367a56275SMatthew G Knepley     if (conv) goto foundconv;
311467a56275SMatthew G Knepley 
311567a56275SMatthew G Knepley     /* 2)  See if a specialized converter is known to the desired DM class. */
311682f516ccSBarry Smith     ierr = DMCreate(PetscObjectComm((PetscObject)dm), &B);CHKERRQ(ierr);
311767a56275SMatthew G Knepley     ierr = DMSetType(B, newtype);CHKERRQ(ierr);
311867a56275SMatthew G Knepley     ierr = PetscStrcpy(convname,"DMConvert_");CHKERRQ(ierr);
311967a56275SMatthew G Knepley     ierr = PetscStrcat(convname,((PetscObject) dm)->type_name);CHKERRQ(ierr);
312067a56275SMatthew G Knepley     ierr = PetscStrcat(convname,"_");CHKERRQ(ierr);
312167a56275SMatthew G Knepley     ierr = PetscStrcat(convname,newtype);CHKERRQ(ierr);
312267a56275SMatthew G Knepley     ierr = PetscStrcat(convname,"_C");CHKERRQ(ierr);
31230005d66cSJed Brown     ierr = PetscObjectQueryFunction((PetscObject)B,convname,&conv);CHKERRQ(ierr);
312467a56275SMatthew G Knepley     if (conv) {
3125fcfd50ebSBarry Smith       ierr = DMDestroy(&B);CHKERRQ(ierr);
312667a56275SMatthew G Knepley       goto foundconv;
312767a56275SMatthew G Knepley     }
312867a56275SMatthew G Knepley 
312967a56275SMatthew G Knepley #if 0
313067a56275SMatthew G Knepley     /* 3) See if a good general converter is registered for the desired class */
313167a56275SMatthew G Knepley     conv = B->ops->convertfrom;
3132fcfd50ebSBarry Smith     ierr = DMDestroy(&B);CHKERRQ(ierr);
313367a56275SMatthew G Knepley     if (conv) goto foundconv;
313467a56275SMatthew G Knepley 
313567a56275SMatthew G Knepley     /* 4) See if a good general converter is known for the current matrix */
313667a56275SMatthew G Knepley     if (dm->ops->convert) {
313767a56275SMatthew G Knepley       conv = dm->ops->convert;
313867a56275SMatthew G Knepley     }
313967a56275SMatthew G Knepley     if (conv) goto foundconv;
314067a56275SMatthew G Knepley #endif
314167a56275SMatthew G Knepley 
314267a56275SMatthew G Knepley     /* 5) Use a really basic converter. */
314382f516ccSBarry Smith     SETERRQ2(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "No conversion possible between DM types %s and %s", ((PetscObject) dm)->type_name, newtype);
314467a56275SMatthew G Knepley 
314567a56275SMatthew G Knepley foundconv:
314667a56275SMatthew G Knepley     ierr = PetscLogEventBegin(DM_Convert,dm,0,0,0);CHKERRQ(ierr);
314767a56275SMatthew G Knepley     ierr = (*conv)(dm,newtype,M);CHKERRQ(ierr);
314812fa691eSMatthew G. Knepley     /* Things that are independent of DM type: We should consult DMClone() here */
314912fa691eSMatthew G. Knepley     if (dm->maxCell) {
315012fa691eSMatthew G. Knepley       const PetscReal *maxCell, *L;
315112fa691eSMatthew G. Knepley       const DMBoundaryType *bd;
315212fa691eSMatthew G. Knepley       ierr = DMGetPeriodicity(dm, &maxCell, &L, &bd);CHKERRQ(ierr);
315312fa691eSMatthew G. Knepley       ierr = DMSetPeriodicity(*M,  maxCell,  L,  bd);CHKERRQ(ierr);
315412fa691eSMatthew G. Knepley     }
315567a56275SMatthew G Knepley     ierr = PetscLogEventEnd(DM_Convert,dm,0,0,0);CHKERRQ(ierr);
315667a56275SMatthew G Knepley   }
315767a56275SMatthew G Knepley   ierr = PetscObjectStateIncrease((PetscObject) *M);CHKERRQ(ierr);
315867a56275SMatthew G Knepley   PetscFunctionReturn(0);
315967a56275SMatthew G Knepley }
3160264ace61SBarry Smith 
3161264ace61SBarry Smith /*--------------------------------------------------------------------------------------------------------------------*/
3162264ace61SBarry Smith 
3163264ace61SBarry Smith #undef __FUNCT__
3164264ace61SBarry Smith #define __FUNCT__ "DMRegister"
3165264ace61SBarry Smith /*@C
31661c84c290SBarry Smith   DMRegister -  Adds a new DM component implementation
31671c84c290SBarry Smith 
31681c84c290SBarry Smith   Not Collective
31691c84c290SBarry Smith 
31701c84c290SBarry Smith   Input Parameters:
31711c84c290SBarry Smith + name        - The name of a new user-defined creation routine
31721c84c290SBarry Smith - create_func - The creation routine itself
31731c84c290SBarry Smith 
31741c84c290SBarry Smith   Notes:
31751c84c290SBarry Smith   DMRegister() may be called multiple times to add several user-defined DMs
31761c84c290SBarry Smith 
31771c84c290SBarry Smith 
31781c84c290SBarry Smith   Sample usage:
31791c84c290SBarry Smith .vb
3180bdf89e91SBarry Smith     DMRegister("my_da", MyDMCreate);
31811c84c290SBarry Smith .ve
31821c84c290SBarry Smith 
31831c84c290SBarry Smith   Then, your DM type can be chosen with the procedural interface via
31841c84c290SBarry Smith .vb
31851c84c290SBarry Smith     DMCreate(MPI_Comm, DM *);
31861c84c290SBarry Smith     DMSetType(DM,"my_da");
31871c84c290SBarry Smith .ve
31881c84c290SBarry Smith    or at runtime via the option
31891c84c290SBarry Smith .vb
31901c84c290SBarry Smith     -da_type my_da
31911c84c290SBarry Smith .ve
3192264ace61SBarry Smith 
3193264ace61SBarry Smith   Level: advanced
31941c84c290SBarry Smith 
31951c84c290SBarry Smith .keywords: DM, register
3196bdf89e91SBarry Smith .seealso: DMRegisterAll(), DMRegisterDestroy()
31971c84c290SBarry Smith 
3198264ace61SBarry Smith @*/
3199bdf89e91SBarry Smith PetscErrorCode  DMRegister(const char sname[],PetscErrorCode (*function)(DM))
3200264ace61SBarry Smith {
3201264ace61SBarry Smith   PetscErrorCode ierr;
3202264ace61SBarry Smith 
3203264ace61SBarry Smith   PetscFunctionBegin;
3204a240a19fSJed Brown   ierr = PetscFunctionListAdd(&DMList,sname,function);CHKERRQ(ierr);
3205264ace61SBarry Smith   PetscFunctionReturn(0);
3206264ace61SBarry Smith }
3207264ace61SBarry Smith 
3208b859378eSBarry Smith #undef __FUNCT__
3209b859378eSBarry Smith #define __FUNCT__ "DMLoad"
3210b859378eSBarry Smith /*@C
321155849f57SBarry Smith   DMLoad - Loads a DM that has been stored in binary  with DMView().
3212b859378eSBarry Smith 
3213b859378eSBarry Smith   Collective on PetscViewer
3214b859378eSBarry Smith 
3215b859378eSBarry Smith   Input Parameters:
3216b859378eSBarry Smith + newdm - the newly loaded DM, this needs to have been created with DMCreate() or
3217b859378eSBarry Smith            some related function before a call to DMLoad().
3218b859378eSBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen() or
3219b859378eSBarry Smith            HDF5 file viewer, obtained from PetscViewerHDF5Open()
3220b859378eSBarry Smith 
3221b859378eSBarry Smith    Level: intermediate
3222b859378eSBarry Smith 
3223b859378eSBarry Smith   Notes:
322455849f57SBarry Smith    The type is determined by the data in the file, any type set into the DM before this call is ignored.
3225b859378eSBarry Smith 
3226b859378eSBarry Smith   Notes for advanced users:
3227b859378eSBarry Smith   Most users should not need to know the details of the binary storage
3228b859378eSBarry Smith   format, since DMLoad() and DMView() completely hide these details.
3229b859378eSBarry Smith   But for anyone who's interested, the standard binary matrix storage
3230b859378eSBarry Smith   format is
3231b859378eSBarry Smith .vb
3232b859378eSBarry Smith      has not yet been determined
3233b859378eSBarry Smith .ve
3234b859378eSBarry Smith 
3235b859378eSBarry Smith .seealso: PetscViewerBinaryOpen(), DMView(), MatLoad(), VecLoad()
3236b859378eSBarry Smith @*/
3237b859378eSBarry Smith PetscErrorCode  DMLoad(DM newdm, PetscViewer viewer)
3238b859378eSBarry Smith {
32399331c7a4SMatthew G. Knepley   PetscBool      isbinary, ishdf5;
3240b859378eSBarry Smith   PetscErrorCode ierr;
3241b859378eSBarry Smith 
3242b859378eSBarry Smith   PetscFunctionBegin;
3243b859378eSBarry Smith   PetscValidHeaderSpecific(newdm,DM_CLASSID,1);
3244b859378eSBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
324532c0f0efSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
32469331c7a4SMatthew G. Knepley   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERHDF5,&ishdf5);CHKERRQ(ierr);
32479331c7a4SMatthew G. Knepley   if (isbinary) {
32489331c7a4SMatthew G. Knepley     PetscInt classid;
32499331c7a4SMatthew G. Knepley     char     type[256];
3250b859378eSBarry Smith 
3251060da220SMatthew G. Knepley     ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr);
32529200755eSBarry Smith     if (classid != DM_FILE_CLASSID) SETERRQ1(PetscObjectComm((PetscObject)newdm),PETSC_ERR_ARG_WRONG,"Not DM next in file, classid found %d",(int)classid);
3253060da220SMatthew G. Knepley     ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr);
325432c0f0efSBarry Smith     ierr = DMSetType(newdm, type);CHKERRQ(ierr);
32559331c7a4SMatthew G. Knepley     if (newdm->ops->load) {ierr = (*newdm->ops->load)(newdm,viewer);CHKERRQ(ierr);}
32569331c7a4SMatthew G. Knepley   } else if (ishdf5) {
32579331c7a4SMatthew G. Knepley     if (newdm->ops->load) {ierr = (*newdm->ops->load)(newdm,viewer);CHKERRQ(ierr);}
32589331c7a4SMatthew G. Knepley   } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen() or PetscViewerHDF5Open()");
3259b859378eSBarry Smith   PetscFunctionReturn(0);
3260b859378eSBarry Smith }
3261b859378eSBarry Smith 
32627da65231SMatthew G Knepley /******************************** FEM Support **********************************/
32637da65231SMatthew G Knepley 
32647da65231SMatthew G Knepley #undef __FUNCT__
32657da65231SMatthew G Knepley #define __FUNCT__ "DMPrintCellVector"
3266a6dfd86eSKarl Rupp PetscErrorCode DMPrintCellVector(PetscInt c, const char name[], PetscInt len, const PetscScalar x[])
3267a6dfd86eSKarl Rupp {
32681d47ebbbSSatish Balay   PetscInt       f;
32691b30c384SMatthew G Knepley   PetscErrorCode ierr;
32701b30c384SMatthew G Knepley 
32717da65231SMatthew G Knepley   PetscFunctionBegin;
327274778d6cSJed Brown   ierr = PetscPrintf(PETSC_COMM_SELF, "Cell %D Element %s\n", c, name);CHKERRQ(ierr);
32731d47ebbbSSatish Balay   for (f = 0; f < len; ++f) {
327457622a8eSBarry Smith     ierr = PetscPrintf(PETSC_COMM_SELF, "  | %g |\n", (double)PetscRealPart(x[f]));CHKERRQ(ierr);
32757da65231SMatthew G Knepley   }
32767da65231SMatthew G Knepley   PetscFunctionReturn(0);
32777da65231SMatthew G Knepley }
32787da65231SMatthew G Knepley 
32797da65231SMatthew G Knepley #undef __FUNCT__
32807da65231SMatthew G Knepley #define __FUNCT__ "DMPrintCellMatrix"
3281a6dfd86eSKarl Rupp PetscErrorCode DMPrintCellMatrix(PetscInt c, const char name[], PetscInt rows, PetscInt cols, const PetscScalar A[])
3282a6dfd86eSKarl Rupp {
32831b30c384SMatthew G Knepley   PetscInt       f, g;
32847da65231SMatthew G Knepley   PetscErrorCode ierr;
32857da65231SMatthew G Knepley 
32867da65231SMatthew G Knepley   PetscFunctionBegin;
328774778d6cSJed Brown   ierr = PetscPrintf(PETSC_COMM_SELF, "Cell %D Element %s\n", c, name);CHKERRQ(ierr);
32881d47ebbbSSatish Balay   for (f = 0; f < rows; ++f) {
328974778d6cSJed Brown     ierr = PetscPrintf(PETSC_COMM_SELF, "  |");CHKERRQ(ierr);
32901d47ebbbSSatish Balay     for (g = 0; g < cols; ++g) {
3291e3556bceSMatthew G. Knepley       ierr = PetscPrintf(PETSC_COMM_SELF, " % 9.5g", PetscRealPart(A[f*cols+g]));CHKERRQ(ierr);
32927da65231SMatthew G Knepley     }
329374778d6cSJed Brown     ierr = PetscPrintf(PETSC_COMM_SELF, " |\n");CHKERRQ(ierr);
32947da65231SMatthew G Knepley   }
32957da65231SMatthew G Knepley   PetscFunctionReturn(0);
32967da65231SMatthew G Knepley }
3297e7c4fc90SDmitry Karpeev 
3298970e74d5SMatthew G Knepley #undef __FUNCT__
3299e759306cSMatthew G. Knepley #define __FUNCT__ "DMPrintLocalVec"
33006113b454SMatthew G. Knepley PetscErrorCode DMPrintLocalVec(DM dm, const char name[], PetscReal tol, Vec X)
3301e759306cSMatthew G. Knepley {
3302e759306cSMatthew G. Knepley   PetscMPIInt    rank, numProcs;
3303e759306cSMatthew G. Knepley   PetscInt       p;
3304e759306cSMatthew G. Knepley   PetscErrorCode ierr;
3305e759306cSMatthew G. Knepley 
3306e759306cSMatthew G. Knepley   PetscFunctionBegin;
3307e759306cSMatthew G. Knepley   ierr = MPI_Comm_rank(PetscObjectComm((PetscObject) dm), &rank);CHKERRQ(ierr);
3308e759306cSMatthew G. Knepley   ierr = MPI_Comm_size(PetscObjectComm((PetscObject) dm), &numProcs);CHKERRQ(ierr);
3309e759306cSMatthew G. Knepley   ierr = PetscPrintf(PetscObjectComm((PetscObject) dm), "%s:\n", name);CHKERRQ(ierr);
3310e759306cSMatthew G. Knepley   for (p = 0; p < numProcs; ++p) {
3311e759306cSMatthew G. Knepley     if (p == rank) {
3312e759306cSMatthew G. Knepley       Vec x;
3313e759306cSMatthew G. Knepley 
3314e759306cSMatthew G. Knepley       ierr = VecDuplicate(X, &x);CHKERRQ(ierr);
3315e759306cSMatthew G. Knepley       ierr = VecCopy(X, x);CHKERRQ(ierr);
33166113b454SMatthew G. Knepley       ierr = VecChop(x, tol);CHKERRQ(ierr);
3317e759306cSMatthew G. Knepley       ierr = VecView(x, PETSC_VIEWER_STDOUT_SELF);CHKERRQ(ierr);
3318e759306cSMatthew G. Knepley       ierr = VecDestroy(&x);CHKERRQ(ierr);
3319e759306cSMatthew G. Knepley       ierr = PetscViewerFlush(PETSC_VIEWER_STDOUT_SELF);CHKERRQ(ierr);
3320e759306cSMatthew G. Knepley     }
3321e759306cSMatthew G. Knepley     ierr = PetscBarrier((PetscObject) dm);CHKERRQ(ierr);
3322e759306cSMatthew G. Knepley   }
3323e759306cSMatthew G. Knepley   PetscFunctionReturn(0);
3324e759306cSMatthew G. Knepley }
3325e759306cSMatthew G. Knepley 
3326e759306cSMatthew G. Knepley #undef __FUNCT__
332788ed4aceSMatthew G Knepley #define __FUNCT__ "DMGetDefaultSection"
332888ed4aceSMatthew G Knepley /*@
332988ed4aceSMatthew G Knepley   DMGetDefaultSection - Get the PetscSection encoding the local data layout for the DM.
333088ed4aceSMatthew G Knepley 
333188ed4aceSMatthew G Knepley   Input Parameter:
333288ed4aceSMatthew G Knepley . dm - The DM
333388ed4aceSMatthew G Knepley 
333488ed4aceSMatthew G Knepley   Output Parameter:
333588ed4aceSMatthew G Knepley . section - The PetscSection
333688ed4aceSMatthew G Knepley 
333788ed4aceSMatthew G Knepley   Level: intermediate
333888ed4aceSMatthew G Knepley 
333988ed4aceSMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSection.
334088ed4aceSMatthew G Knepley 
334188ed4aceSMatthew G Knepley .seealso: DMSetDefaultSection(), DMGetDefaultGlobalSection()
334288ed4aceSMatthew G Knepley @*/
33430adebc6cSBarry Smith PetscErrorCode DMGetDefaultSection(DM dm, PetscSection *section)
33440adebc6cSBarry Smith {
3345fd59a867SMatthew G. Knepley   PetscErrorCode ierr;
3346fd59a867SMatthew G. Knepley 
334788ed4aceSMatthew G Knepley   PetscFunctionBegin;
334888ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
334988ed4aceSMatthew G Knepley   PetscValidPointer(section, 2);
33502f0f8703SMatthew G. Knepley   if (!dm->defaultSection && dm->ops->createdefaultsection) {
33512f0f8703SMatthew G. Knepley     ierr = (*dm->ops->createdefaultsection)(dm);CHKERRQ(ierr);
3352ae71db08SMatthew G. Knepley     if (dm->defaultSection) {ierr = PetscObjectViewFromOptions((PetscObject) dm->defaultSection, NULL, "-dm_petscsection_view");CHKERRQ(ierr);}
33532f0f8703SMatthew G. Knepley   }
335488ed4aceSMatthew G Knepley   *section = dm->defaultSection;
335588ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
335688ed4aceSMatthew G Knepley }
335788ed4aceSMatthew G Knepley 
335888ed4aceSMatthew G Knepley #undef __FUNCT__
335988ed4aceSMatthew G Knepley #define __FUNCT__ "DMSetDefaultSection"
336088ed4aceSMatthew G Knepley /*@
336188ed4aceSMatthew G Knepley   DMSetDefaultSection - Set the PetscSection encoding the local data layout for the DM.
336288ed4aceSMatthew G Knepley 
336388ed4aceSMatthew G Knepley   Input Parameters:
336488ed4aceSMatthew G Knepley + dm - The DM
336588ed4aceSMatthew G Knepley - section - The PetscSection
336688ed4aceSMatthew G Knepley 
336788ed4aceSMatthew G Knepley   Level: intermediate
336888ed4aceSMatthew G Knepley 
336988ed4aceSMatthew G Knepley   Note: Any existing Section will be destroyed
337088ed4aceSMatthew G Knepley 
337188ed4aceSMatthew G Knepley .seealso: DMSetDefaultSection(), DMGetDefaultGlobalSection()
337288ed4aceSMatthew G Knepley @*/
33730adebc6cSBarry Smith PetscErrorCode DMSetDefaultSection(DM dm, PetscSection section)
33740adebc6cSBarry Smith {
3375c473ab19SMatthew G. Knepley   PetscInt       numFields = 0;
3376af122d2aSMatthew G Knepley   PetscInt       f;
337788ed4aceSMatthew G Knepley   PetscErrorCode ierr;
337888ed4aceSMatthew G Knepley 
337988ed4aceSMatthew G Knepley   PetscFunctionBegin;
338088ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
3381c473ab19SMatthew G. Knepley   if (section) {
33821d799100SJed Brown     PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2);
33831d799100SJed Brown     ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr);
3384c473ab19SMatthew G. Knepley   }
338588ed4aceSMatthew G Knepley   ierr = PetscSectionDestroy(&dm->defaultSection);CHKERRQ(ierr);
338688ed4aceSMatthew G Knepley   dm->defaultSection = section;
3387c473ab19SMatthew G. Knepley   if (section) {ierr = PetscSectionGetNumFields(dm->defaultSection, &numFields);CHKERRQ(ierr);}
3388af122d2aSMatthew G Knepley   if (numFields) {
3389af122d2aSMatthew G Knepley     ierr = DMSetNumFields(dm, numFields);CHKERRQ(ierr);
3390af122d2aSMatthew G Knepley     for (f = 0; f < numFields; ++f) {
33910f21e855SMatthew G. Knepley       PetscObject disc;
3392af122d2aSMatthew G Knepley       const char *name;
3393af122d2aSMatthew G Knepley 
3394af122d2aSMatthew G Knepley       ierr = PetscSectionGetFieldName(dm->defaultSection, f, &name);CHKERRQ(ierr);
33950f21e855SMatthew G. Knepley       ierr = DMGetField(dm, f, &disc);CHKERRQ(ierr);
33960f21e855SMatthew G. Knepley       ierr = PetscObjectSetName(disc, name);CHKERRQ(ierr);
3397af122d2aSMatthew G Knepley     }
3398af122d2aSMatthew G Knepley   }
33991d799100SJed Brown   /* The global section will be rebuilt in the next call to DMGetDefaultGlobalSection(). */
34001d799100SJed Brown   ierr = PetscSectionDestroy(&dm->defaultGlobalSection);CHKERRQ(ierr);
340188ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
340288ed4aceSMatthew G Knepley }
340388ed4aceSMatthew G Knepley 
340488ed4aceSMatthew G Knepley #undef __FUNCT__
34059435951eSToby Isaac #define __FUNCT__ "DMGetDefaultConstraints"
34069435951eSToby Isaac /*@
34079435951eSToby Isaac   DMGetDefaultConstraints - Get the PetscSection and Mat the specify the local constraint interpolation. See DMSetDefaultConstraints() for a description of the purpose of constraint interpolation.
34089435951eSToby Isaac 
3409e228b242SToby Isaac   not collective
3410e228b242SToby Isaac 
34119435951eSToby Isaac   Input Parameter:
34129435951eSToby Isaac . dm - The DM
34139435951eSToby Isaac 
34149435951eSToby Isaac   Output Parameter:
34159435951eSToby 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.
34169435951eSToby 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.
34179435951eSToby Isaac 
34189435951eSToby Isaac   Level: advanced
34199435951eSToby Isaac 
34209435951eSToby Isaac   Note: This gets borrowed references, so the user should not destroy the PetscSection or the Mat.
34219435951eSToby Isaac 
34229435951eSToby Isaac .seealso: DMSetDefaultConstraints()
34239435951eSToby Isaac @*/
34249435951eSToby Isaac PetscErrorCode DMGetDefaultConstraints(DM dm, PetscSection *section, Mat *mat)
34259435951eSToby Isaac {
34269435951eSToby Isaac   PetscErrorCode ierr;
34279435951eSToby Isaac 
34289435951eSToby Isaac   PetscFunctionBegin;
34299435951eSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
34309435951eSToby Isaac   if (!dm->defaultConstraintSection && !dm->defaultConstraintMat && dm->ops->createdefaultconstraints) {ierr = (*dm->ops->createdefaultconstraints)(dm);CHKERRQ(ierr);}
343145a75d81SToby Isaac   if (section) {*section = dm->defaultConstraintSection;}
343245a75d81SToby Isaac   if (mat) {*mat = dm->defaultConstraintMat;}
34339435951eSToby Isaac   PetscFunctionReturn(0);
34349435951eSToby Isaac }
34359435951eSToby Isaac 
34369435951eSToby Isaac #undef __FUNCT__
34379435951eSToby Isaac #define __FUNCT__ "DMSetDefaultConstraints"
34389435951eSToby Isaac /*@
34399435951eSToby Isaac   DMSetDefaultConstraints - Set the PetscSection and Mat the specify the local constraint interpolation.
34409435951eSToby Isaac 
34419435951eSToby 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().
34429435951eSToby Isaac 
34439435951eSToby 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.
34449435951eSToby Isaac 
3445e228b242SToby Isaac   collective on dm
3446e228b242SToby Isaac 
34479435951eSToby Isaac   Input Parameters:
34489435951eSToby Isaac + dm - The DM
3449e228b242SToby 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).
3450e228b242SToby 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).
34519435951eSToby Isaac 
34529435951eSToby Isaac   Level: advanced
34539435951eSToby Isaac 
34549435951eSToby Isaac   Note: This increments the references of the PetscSection and the Mat, so they user can destroy them
34559435951eSToby Isaac 
34569435951eSToby Isaac .seealso: DMGetDefaultConstraints()
34579435951eSToby Isaac @*/
34589435951eSToby Isaac PetscErrorCode DMSetDefaultConstraints(DM dm, PetscSection section, Mat mat)
34599435951eSToby Isaac {
3460e228b242SToby Isaac   PetscMPIInt result;
34619435951eSToby Isaac   PetscErrorCode ierr;
34629435951eSToby Isaac 
34639435951eSToby Isaac   PetscFunctionBegin;
34649435951eSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
3465e228b242SToby Isaac   if (section) {
3466e228b242SToby Isaac     PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2);
3467e228b242SToby Isaac     ierr = MPI_Comm_compare(PETSC_COMM_SELF,PetscObjectComm((PetscObject)section),&result);CHKERRQ(ierr);
3468f60917d2SBarry Smith     if (result != MPI_CONGRUENT && result != MPI_IDENT) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NOTSAMECOMM,"constraint section must have local communicator");
3469e228b242SToby Isaac   }
3470e228b242SToby Isaac   if (mat) {
3471e228b242SToby Isaac     PetscValidHeaderSpecific(mat,MAT_CLASSID,3);
3472e228b242SToby Isaac     ierr = MPI_Comm_compare(PETSC_COMM_SELF,PetscObjectComm((PetscObject)mat),&result);CHKERRQ(ierr);
3473f60917d2SBarry Smith     if (result != MPI_CONGRUENT && result != MPI_IDENT) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NOTSAMECOMM,"constraint matrix must have local communicator");
3474e228b242SToby Isaac   }
34759435951eSToby Isaac   ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr);
34769435951eSToby Isaac   ierr = PetscSectionDestroy(&dm->defaultConstraintSection);CHKERRQ(ierr);
34779435951eSToby Isaac   dm->defaultConstraintSection = section;
34789435951eSToby Isaac   ierr = PetscObjectReference((PetscObject)mat);CHKERRQ(ierr);
34799435951eSToby Isaac   ierr = MatDestroy(&dm->defaultConstraintMat);CHKERRQ(ierr);
34809435951eSToby Isaac   dm->defaultConstraintMat = mat;
34819435951eSToby Isaac   PetscFunctionReturn(0);
34829435951eSToby Isaac }
34839435951eSToby Isaac 
3484f741bcd2SMatthew G. Knepley #ifdef PETSC_USE_DEBUG
34859435951eSToby Isaac #undef __FUNCT__
3486284f5c8fSMatthew G. Knepley #define __FUNCT__ "DMDefaultSectionCheckConsistency_Internal"
3487507e4973SMatthew G. Knepley /*
3488507e4973SMatthew G. Knepley   DMDefaultSectionCheckConsistency - Check the consistentcy of the global and local sections.
3489507e4973SMatthew G. Knepley 
3490507e4973SMatthew G. Knepley   Input Parameters:
3491507e4973SMatthew G. Knepley + dm - The DM
3492507e4973SMatthew G. Knepley . localSection - PetscSection describing the local data layout
3493507e4973SMatthew G. Knepley - globalSection - PetscSection describing the global data layout
3494507e4973SMatthew G. Knepley 
3495507e4973SMatthew G. Knepley   Level: intermediate
3496507e4973SMatthew G. Knepley 
3497507e4973SMatthew G. Knepley .seealso: DMGetDefaultSF(), DMSetDefaultSF()
3498507e4973SMatthew G. Knepley */
3499f741bcd2SMatthew G. Knepley static PetscErrorCode DMDefaultSectionCheckConsistency_Internal(DM dm, PetscSection localSection, PetscSection globalSection)
3500507e4973SMatthew G. Knepley {
3501507e4973SMatthew G. Knepley   MPI_Comm        comm;
3502507e4973SMatthew G. Knepley   PetscLayout     layout;
3503507e4973SMatthew G. Knepley   const PetscInt *ranges;
3504507e4973SMatthew G. Knepley   PetscInt        pStart, pEnd, p, nroots;
3505507e4973SMatthew G. Knepley   PetscMPIInt     size, rank;
3506507e4973SMatthew G. Knepley   PetscBool       valid = PETSC_TRUE, gvalid;
3507507e4973SMatthew G. Knepley   PetscErrorCode  ierr;
3508507e4973SMatthew G. Knepley 
3509507e4973SMatthew G. Knepley   PetscFunctionBegin;
3510507e4973SMatthew G. Knepley   ierr = PetscObjectGetComm((PetscObject)dm,&comm);CHKERRQ(ierr);
3511507e4973SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
3512507e4973SMatthew G. Knepley   ierr = MPI_Comm_size(comm, &size);CHKERRQ(ierr);
3513507e4973SMatthew G. Knepley   ierr = MPI_Comm_rank(comm, &rank);CHKERRQ(ierr);
3514507e4973SMatthew G. Knepley   ierr = PetscSectionGetChart(globalSection, &pStart, &pEnd);CHKERRQ(ierr);
3515507e4973SMatthew G. Knepley   ierr = PetscSectionGetConstrainedStorageSize(globalSection, &nroots);CHKERRQ(ierr);
3516507e4973SMatthew G. Knepley   ierr = PetscLayoutCreate(comm, &layout);CHKERRQ(ierr);
3517507e4973SMatthew G. Knepley   ierr = PetscLayoutSetBlockSize(layout, 1);CHKERRQ(ierr);
3518507e4973SMatthew G. Knepley   ierr = PetscLayoutSetLocalSize(layout, nroots);CHKERRQ(ierr);
3519507e4973SMatthew G. Knepley   ierr = PetscLayoutSetUp(layout);CHKERRQ(ierr);
3520507e4973SMatthew G. Knepley   ierr = PetscLayoutGetRanges(layout, &ranges);CHKERRQ(ierr);
3521507e4973SMatthew G. Knepley   for (p = pStart; p < pEnd; ++p) {
3522f741bcd2SMatthew G. Knepley     PetscInt       dof, cdof, off, gdof, gcdof, goff, gsize, d;
3523507e4973SMatthew G. Knepley 
3524507e4973SMatthew G. Knepley     ierr = PetscSectionGetDof(localSection, p, &dof);CHKERRQ(ierr);
3525507e4973SMatthew G. Knepley     ierr = PetscSectionGetOffset(localSection, p, &off);CHKERRQ(ierr);
3526507e4973SMatthew G. Knepley     ierr = PetscSectionGetConstraintDof(localSection, p, &cdof);CHKERRQ(ierr);
3527507e4973SMatthew G. Knepley     ierr = PetscSectionGetDof(globalSection, p, &gdof);CHKERRQ(ierr);
3528507e4973SMatthew G. Knepley     ierr = PetscSectionGetConstraintDof(globalSection, p, &gcdof);CHKERRQ(ierr);
3529507e4973SMatthew G. Knepley     ierr = PetscSectionGetOffset(globalSection, p, &goff);CHKERRQ(ierr);
3530507e4973SMatthew G. Knepley     if (!gdof) continue; /* Censored point */
3531507e4973SMatthew 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;}
3532507e4973SMatthew 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;}
3533507e4973SMatthew G. Knepley     if (gdof < 0) {
3534507e4973SMatthew G. Knepley       gsize = gdof < 0 ? -(gdof+1)-gcdof : gdof-gcdof;
3535507e4973SMatthew G. Knepley       for (d = 0; d < gsize; ++d) {
3536507e4973SMatthew G. Knepley         PetscInt offset = -(goff+1) + d, r;
3537507e4973SMatthew G. Knepley 
3538507e4973SMatthew G. Knepley         ierr = PetscFindInt(offset,size+1,ranges,&r);CHKERRQ(ierr);
3539507e4973SMatthew G. Knepley         if (r < 0) r = -(r+2);
3540507e4973SMatthew 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;}
3541507e4973SMatthew G. Knepley       }
3542507e4973SMatthew G. Knepley     }
3543507e4973SMatthew G. Knepley   }
3544507e4973SMatthew G. Knepley   ierr = PetscLayoutDestroy(&layout);CHKERRQ(ierr);
3545507e4973SMatthew G. Knepley   ierr = PetscSynchronizedFlush(comm, NULL);CHKERRQ(ierr);
3546b2566f29SBarry Smith   ierr = MPIU_Allreduce(&valid, &gvalid, 1, MPIU_BOOL, MPI_LAND, comm);CHKERRQ(ierr);
3547507e4973SMatthew G. Knepley   if (!gvalid) {
3548507e4973SMatthew G. Knepley     ierr = DMView(dm, NULL);CHKERRQ(ierr);
3549507e4973SMatthew G. Knepley     SETERRQ(comm, PETSC_ERR_ARG_WRONG, "Inconsistent local and global sections");
3550507e4973SMatthew G. Knepley   }
3551507e4973SMatthew G. Knepley   PetscFunctionReturn(0);
3552507e4973SMatthew G. Knepley }
3553f741bcd2SMatthew G. Knepley #endif
3554507e4973SMatthew G. Knepley 
3555507e4973SMatthew G. Knepley #undef __FUNCT__
355688ed4aceSMatthew G Knepley #define __FUNCT__ "DMGetDefaultGlobalSection"
355788ed4aceSMatthew G Knepley /*@
355888ed4aceSMatthew G Knepley   DMGetDefaultGlobalSection - Get the PetscSection encoding the global data layout for the DM.
355988ed4aceSMatthew G Knepley 
35608b1ab98fSJed Brown   Collective on DM
35618b1ab98fSJed Brown 
356288ed4aceSMatthew G Knepley   Input Parameter:
356388ed4aceSMatthew G Knepley . dm - The DM
356488ed4aceSMatthew G Knepley 
356588ed4aceSMatthew G Knepley   Output Parameter:
356688ed4aceSMatthew G Knepley . section - The PetscSection
356788ed4aceSMatthew G Knepley 
356888ed4aceSMatthew G Knepley   Level: intermediate
356988ed4aceSMatthew G Knepley 
357088ed4aceSMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSection.
357188ed4aceSMatthew G Knepley 
357288ed4aceSMatthew G Knepley .seealso: DMSetDefaultSection(), DMGetDefaultSection()
357388ed4aceSMatthew G Knepley @*/
35740adebc6cSBarry Smith PetscErrorCode DMGetDefaultGlobalSection(DM dm, PetscSection *section)
35750adebc6cSBarry Smith {
357688ed4aceSMatthew G Knepley   PetscErrorCode ierr;
357788ed4aceSMatthew G Knepley 
357888ed4aceSMatthew G Knepley   PetscFunctionBegin;
357988ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
358088ed4aceSMatthew G Knepley   PetscValidPointer(section, 2);
358188ed4aceSMatthew G Knepley   if (!dm->defaultGlobalSection) {
3582fd59a867SMatthew G. Knepley     PetscSection s;
3583fd59a867SMatthew G. Knepley 
3584fd59a867SMatthew G. Knepley     ierr = DMGetDefaultSection(dm, &s);CHKERRQ(ierr);
3585fd59a867SMatthew 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");
3586fd59a867SMatthew 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");
358715b58121SMatthew G. Knepley     ierr = PetscSectionCreateGlobalSection(s, dm->sf, PETSC_FALSE, PETSC_FALSE, &dm->defaultGlobalSection);CHKERRQ(ierr);
3588cf06b437SMatthew G. Knepley     ierr = PetscLayoutDestroy(&dm->map);CHKERRQ(ierr);
3589ce94432eSBarry Smith     ierr = PetscSectionGetValueLayout(PetscObjectComm((PetscObject)dm), dm->defaultGlobalSection, &dm->map);CHKERRQ(ierr);
3590685405a1SBarry Smith     ierr = PetscSectionViewFromOptions(dm->defaultGlobalSection, NULL, "-global_section_view");CHKERRQ(ierr);
359188ed4aceSMatthew G Knepley   }
359288ed4aceSMatthew G Knepley   *section = dm->defaultGlobalSection;
359388ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
359488ed4aceSMatthew G Knepley }
359588ed4aceSMatthew G Knepley 
359688ed4aceSMatthew G Knepley #undef __FUNCT__
3597b21d0597SMatthew G Knepley #define __FUNCT__ "DMSetDefaultGlobalSection"
3598b21d0597SMatthew G Knepley /*@
3599b21d0597SMatthew G Knepley   DMSetDefaultGlobalSection - Set the PetscSection encoding the global data layout for the DM.
3600b21d0597SMatthew G Knepley 
3601b21d0597SMatthew G Knepley   Input Parameters:
3602b21d0597SMatthew G Knepley + dm - The DM
36035080bbdbSMatthew G Knepley - section - The PetscSection, or NULL
3604b21d0597SMatthew G Knepley 
3605b21d0597SMatthew G Knepley   Level: intermediate
3606b21d0597SMatthew G Knepley 
3607b21d0597SMatthew G Knepley   Note: Any existing Section will be destroyed
3608b21d0597SMatthew G Knepley 
3609b21d0597SMatthew G Knepley .seealso: DMGetDefaultGlobalSection(), DMSetDefaultSection()
3610b21d0597SMatthew G Knepley @*/
36110adebc6cSBarry Smith PetscErrorCode DMSetDefaultGlobalSection(DM dm, PetscSection section)
36120adebc6cSBarry Smith {
3613b21d0597SMatthew G Knepley   PetscErrorCode ierr;
3614b21d0597SMatthew G Knepley 
3615b21d0597SMatthew G Knepley   PetscFunctionBegin;
3616b21d0597SMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
36175080bbdbSMatthew G Knepley   if (section) PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2);
36181d799100SJed Brown   ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr);
3619b21d0597SMatthew G Knepley   ierr = PetscSectionDestroy(&dm->defaultGlobalSection);CHKERRQ(ierr);
3620b21d0597SMatthew G Knepley   dm->defaultGlobalSection = section;
3621507e4973SMatthew G. Knepley #ifdef PETSC_USE_DEBUG
3622f741bcd2SMatthew G. Knepley   if (section) {ierr = DMDefaultSectionCheckConsistency_Internal(dm, dm->defaultSection, section);CHKERRQ(ierr);}
3623507e4973SMatthew G. Knepley #endif
3624b21d0597SMatthew G Knepley   PetscFunctionReturn(0);
3625b21d0597SMatthew G Knepley }
3626b21d0597SMatthew G Knepley 
3627b21d0597SMatthew G Knepley #undef __FUNCT__
362888ed4aceSMatthew G Knepley #define __FUNCT__ "DMGetDefaultSF"
362988ed4aceSMatthew G Knepley /*@
363088ed4aceSMatthew G Knepley   DMGetDefaultSF - Get the PetscSF encoding the parallel dof overlap for the DM. If it has not been set,
363188ed4aceSMatthew G Knepley   it is created from the default PetscSection layouts in the DM.
363288ed4aceSMatthew G Knepley 
363388ed4aceSMatthew G Knepley   Input Parameter:
363488ed4aceSMatthew G Knepley . dm - The DM
363588ed4aceSMatthew G Knepley 
363688ed4aceSMatthew G Knepley   Output Parameter:
363788ed4aceSMatthew G Knepley . sf - The PetscSF
363888ed4aceSMatthew G Knepley 
363988ed4aceSMatthew G Knepley   Level: intermediate
364088ed4aceSMatthew G Knepley 
364188ed4aceSMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSF.
364288ed4aceSMatthew G Knepley 
364388ed4aceSMatthew G Knepley .seealso: DMSetDefaultSF(), DMCreateDefaultSF()
364488ed4aceSMatthew G Knepley @*/
36450adebc6cSBarry Smith PetscErrorCode DMGetDefaultSF(DM dm, PetscSF *sf)
36460adebc6cSBarry Smith {
364788ed4aceSMatthew G Knepley   PetscInt       nroots;
364888ed4aceSMatthew G Knepley   PetscErrorCode ierr;
364988ed4aceSMatthew G Knepley 
365088ed4aceSMatthew G Knepley   PetscFunctionBegin;
365188ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
365288ed4aceSMatthew G Knepley   PetscValidPointer(sf, 2);
36530298fd71SBarry Smith   ierr = PetscSFGetGraph(dm->defaultSF, &nroots, NULL, NULL, NULL);CHKERRQ(ierr);
365488ed4aceSMatthew G Knepley   if (nroots < 0) {
365588ed4aceSMatthew G Knepley     PetscSection section, gSection;
365688ed4aceSMatthew G Knepley 
365788ed4aceSMatthew G Knepley     ierr = DMGetDefaultSection(dm, &section);CHKERRQ(ierr);
365831ea6d37SMatthew G Knepley     if (section) {
365988ed4aceSMatthew G Knepley       ierr = DMGetDefaultGlobalSection(dm, &gSection);CHKERRQ(ierr);
366088ed4aceSMatthew G Knepley       ierr = DMCreateDefaultSF(dm, section, gSection);CHKERRQ(ierr);
366131ea6d37SMatthew G Knepley     } else {
36620298fd71SBarry Smith       *sf = NULL;
366331ea6d37SMatthew G Knepley       PetscFunctionReturn(0);
366431ea6d37SMatthew G Knepley     }
366588ed4aceSMatthew G Knepley   }
366688ed4aceSMatthew G Knepley   *sf = dm->defaultSF;
366788ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
366888ed4aceSMatthew G Knepley }
366988ed4aceSMatthew G Knepley 
367088ed4aceSMatthew G Knepley #undef __FUNCT__
367188ed4aceSMatthew G Knepley #define __FUNCT__ "DMSetDefaultSF"
367288ed4aceSMatthew G Knepley /*@
367388ed4aceSMatthew G Knepley   DMSetDefaultSF - Set the PetscSF encoding the parallel dof overlap for the DM
367488ed4aceSMatthew G Knepley 
367588ed4aceSMatthew G Knepley   Input Parameters:
367688ed4aceSMatthew G Knepley + dm - The DM
367788ed4aceSMatthew G Knepley - sf - The PetscSF
367888ed4aceSMatthew G Knepley 
367988ed4aceSMatthew G Knepley   Level: intermediate
368088ed4aceSMatthew G Knepley 
368188ed4aceSMatthew G Knepley   Note: Any previous SF is destroyed
368288ed4aceSMatthew G Knepley 
368388ed4aceSMatthew G Knepley .seealso: DMGetDefaultSF(), DMCreateDefaultSF()
368488ed4aceSMatthew G Knepley @*/
36850adebc6cSBarry Smith PetscErrorCode DMSetDefaultSF(DM dm, PetscSF sf)
36860adebc6cSBarry Smith {
368788ed4aceSMatthew G Knepley   PetscErrorCode ierr;
368888ed4aceSMatthew G Knepley 
368988ed4aceSMatthew G Knepley   PetscFunctionBegin;
369088ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
369188ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
369288ed4aceSMatthew G Knepley   ierr          = PetscSFDestroy(&dm->defaultSF);CHKERRQ(ierr);
369388ed4aceSMatthew G Knepley   dm->defaultSF = sf;
369488ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
369588ed4aceSMatthew G Knepley }
369688ed4aceSMatthew G Knepley 
369788ed4aceSMatthew G Knepley #undef __FUNCT__
369888ed4aceSMatthew G Knepley #define __FUNCT__ "DMCreateDefaultSF"
369988ed4aceSMatthew G Knepley /*@C
370088ed4aceSMatthew G Knepley   DMCreateDefaultSF - Create the PetscSF encoding the parallel dof overlap for the DM based upon the PetscSections
370188ed4aceSMatthew G Knepley   describing the data layout.
370288ed4aceSMatthew G Knepley 
370388ed4aceSMatthew G Knepley   Input Parameters:
370488ed4aceSMatthew G Knepley + dm - The DM
370588ed4aceSMatthew G Knepley . localSection - PetscSection describing the local data layout
370688ed4aceSMatthew G Knepley - globalSection - PetscSection describing the global data layout
370788ed4aceSMatthew G Knepley 
370888ed4aceSMatthew G Knepley   Level: intermediate
370988ed4aceSMatthew G Knepley 
371088ed4aceSMatthew G Knepley .seealso: DMGetDefaultSF(), DMSetDefaultSF()
371188ed4aceSMatthew G Knepley @*/
371288ed4aceSMatthew G Knepley PetscErrorCode DMCreateDefaultSF(DM dm, PetscSection localSection, PetscSection globalSection)
371388ed4aceSMatthew G Knepley {
371482f516ccSBarry Smith   MPI_Comm       comm;
371588ed4aceSMatthew G Knepley   PetscLayout    layout;
371688ed4aceSMatthew G Knepley   const PetscInt *ranges;
371788ed4aceSMatthew G Knepley   PetscInt       *local;
371888ed4aceSMatthew G Knepley   PetscSFNode    *remote;
3719ecd73843SMatthew G. Knepley   PetscInt       pStart, pEnd, p, nroots, nleaves = 0, l;
372088ed4aceSMatthew G Knepley   PetscMPIInt    size, rank;
372188ed4aceSMatthew G Knepley   PetscErrorCode ierr;
372288ed4aceSMatthew G Knepley 
372388ed4aceSMatthew G Knepley   PetscFunctionBegin;
372482f516ccSBarry Smith   ierr = PetscObjectGetComm((PetscObject)dm,&comm);CHKERRQ(ierr);
372588ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
372688ed4aceSMatthew G Knepley   ierr = MPI_Comm_size(comm, &size);CHKERRQ(ierr);
372788ed4aceSMatthew G Knepley   ierr = MPI_Comm_rank(comm, &rank);CHKERRQ(ierr);
372888ed4aceSMatthew G Knepley   ierr = PetscSectionGetChart(globalSection, &pStart, &pEnd);CHKERRQ(ierr);
372988ed4aceSMatthew G Knepley   ierr = PetscSectionGetConstrainedStorageSize(globalSection, &nroots);CHKERRQ(ierr);
373088ed4aceSMatthew G Knepley   ierr = PetscLayoutCreate(comm, &layout);CHKERRQ(ierr);
373188ed4aceSMatthew G Knepley   ierr = PetscLayoutSetBlockSize(layout, 1);CHKERRQ(ierr);
373288ed4aceSMatthew G Knepley   ierr = PetscLayoutSetLocalSize(layout, nroots);CHKERRQ(ierr);
373388ed4aceSMatthew G Knepley   ierr = PetscLayoutSetUp(layout);CHKERRQ(ierr);
373488ed4aceSMatthew G Knepley   ierr = PetscLayoutGetRanges(layout, &ranges);CHKERRQ(ierr);
3735ecd73843SMatthew G. Knepley   for (p = pStart; p < pEnd; ++p) {
37366636e97aSMatthew G Knepley     PetscInt gdof, gcdof;
373788ed4aceSMatthew G Knepley 
37386636e97aSMatthew G Knepley     ierr     = PetscSectionGetDof(globalSection, p, &gdof);CHKERRQ(ierr);
37396636e97aSMatthew G Knepley     ierr     = PetscSectionGetConstraintDof(globalSection, p, &gcdof);CHKERRQ(ierr);
3740235fbf56SMatthew 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));
37416636e97aSMatthew G Knepley     nleaves += gdof < 0 ? -(gdof+1)-gcdof : gdof-gcdof;
374288ed4aceSMatthew G Knepley   }
3743785e854fSJed Brown   ierr = PetscMalloc1(nleaves, &local);CHKERRQ(ierr);
3744785e854fSJed Brown   ierr = PetscMalloc1(nleaves, &remote);CHKERRQ(ierr);
374588ed4aceSMatthew G Knepley   for (p = pStart, l = 0; p < pEnd; ++p) {
37461f588964SMatthew G Knepley     const PetscInt *cind;
37476636e97aSMatthew G Knepley     PetscInt       dof, cdof, off, gdof, gcdof, goff, gsize, d, c;
374888ed4aceSMatthew G Knepley 
374988ed4aceSMatthew G Knepley     ierr = PetscSectionGetDof(localSection, p, &dof);CHKERRQ(ierr);
375088ed4aceSMatthew G Knepley     ierr = PetscSectionGetOffset(localSection, p, &off);CHKERRQ(ierr);
375188ed4aceSMatthew G Knepley     ierr = PetscSectionGetConstraintDof(localSection, p, &cdof);CHKERRQ(ierr);
375288ed4aceSMatthew G Knepley     ierr = PetscSectionGetConstraintIndices(localSection, p, &cind);CHKERRQ(ierr);
375388ed4aceSMatthew G Knepley     ierr = PetscSectionGetDof(globalSection, p, &gdof);CHKERRQ(ierr);
37546636e97aSMatthew G Knepley     ierr = PetscSectionGetConstraintDof(globalSection, p, &gcdof);CHKERRQ(ierr);
375588ed4aceSMatthew G Knepley     ierr = PetscSectionGetOffset(globalSection, p, &goff);CHKERRQ(ierr);
37566636e97aSMatthew G Knepley     if (!gdof) continue; /* Censored point */
37576636e97aSMatthew G Knepley     gsize = gdof < 0 ? -(gdof+1)-gcdof : gdof-gcdof;
37586636e97aSMatthew G Knepley     if (gsize != dof-cdof) {
3759057b4bcdSMatthew 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);
37606636e97aSMatthew G Knepley       cdof = 0; /* Ignore constraints */
37616636e97aSMatthew G Knepley     }
376288ed4aceSMatthew G Knepley     for (d = 0, c = 0; d < dof; ++d) {
376388ed4aceSMatthew G Knepley       if ((c < cdof) && (cind[c] == d)) {++c; continue;}
376488ed4aceSMatthew G Knepley       local[l+d-c] = off+d;
376588ed4aceSMatthew G Knepley     }
376688ed4aceSMatthew G Knepley     if (gdof < 0) {
37676636e97aSMatthew G Knepley       for (d = 0; d < gsize; ++d, ++l) {
376888ed4aceSMatthew G Knepley         PetscInt offset = -(goff+1) + d, r;
376988ed4aceSMatthew G Knepley 
377005376888SMatthew G. Knepley         ierr = PetscFindInt(offset,size+1,ranges,&r);CHKERRQ(ierr);
377131d3f06eSJed Brown         if (r < 0) r = -(r+2);
377205376888SMatthew 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);
377388ed4aceSMatthew G Knepley         remote[l].rank  = r;
377488ed4aceSMatthew G Knepley         remote[l].index = offset - ranges[r];
377588ed4aceSMatthew G Knepley       }
377688ed4aceSMatthew G Knepley     } else {
37776636e97aSMatthew G Knepley       for (d = 0; d < gsize; ++d, ++l) {
377888ed4aceSMatthew G Knepley         remote[l].rank  = rank;
377988ed4aceSMatthew G Knepley         remote[l].index = goff+d - ranges[rank];
378088ed4aceSMatthew G Knepley       }
378188ed4aceSMatthew G Knepley     }
378288ed4aceSMatthew G Knepley   }
37836636e97aSMatthew G Knepley   if (l != nleaves) SETERRQ2(comm, PETSC_ERR_PLIB, "Iteration error, l %d != nleaves %d", l, nleaves);
378488ed4aceSMatthew G Knepley   ierr = PetscLayoutDestroy(&layout);CHKERRQ(ierr);
378588ed4aceSMatthew G Knepley   ierr = PetscSFSetGraph(dm->defaultSF, nroots, nleaves, local, PETSC_OWN_POINTER, remote, PETSC_OWN_POINTER);CHKERRQ(ierr);
378688ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
378788ed4aceSMatthew G Knepley }
3788af122d2aSMatthew G Knepley 
3789af122d2aSMatthew G Knepley #undef __FUNCT__
3790b21d0597SMatthew G Knepley #define __FUNCT__ "DMGetPointSF"
3791b21d0597SMatthew G Knepley /*@
3792b21d0597SMatthew G Knepley   DMGetPointSF - Get the PetscSF encoding the parallel section point overlap for the DM.
3793b21d0597SMatthew G Knepley 
3794b21d0597SMatthew G Knepley   Input Parameter:
3795b21d0597SMatthew G Knepley . dm - The DM
3796b21d0597SMatthew G Knepley 
3797b21d0597SMatthew G Knepley   Output Parameter:
3798b21d0597SMatthew G Knepley . sf - The PetscSF
3799b21d0597SMatthew G Knepley 
3800b21d0597SMatthew G Knepley   Level: intermediate
3801b21d0597SMatthew G Knepley 
3802b21d0597SMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSF.
3803b21d0597SMatthew G Knepley 
3804057b4bcdSMatthew G Knepley .seealso: DMSetPointSF(), DMGetDefaultSF(), DMSetDefaultSF(), DMCreateDefaultSF()
3805b21d0597SMatthew G Knepley @*/
38060adebc6cSBarry Smith PetscErrorCode DMGetPointSF(DM dm, PetscSF *sf)
38070adebc6cSBarry Smith {
3808b21d0597SMatthew G Knepley   PetscFunctionBegin;
3809b21d0597SMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
3810b21d0597SMatthew G Knepley   PetscValidPointer(sf, 2);
3811b21d0597SMatthew G Knepley   *sf = dm->sf;
3812b21d0597SMatthew G Knepley   PetscFunctionReturn(0);
3813b21d0597SMatthew G Knepley }
3814b21d0597SMatthew G Knepley 
3815b21d0597SMatthew G Knepley #undef __FUNCT__
3816057b4bcdSMatthew G Knepley #define __FUNCT__ "DMSetPointSF"
3817057b4bcdSMatthew G Knepley /*@
3818057b4bcdSMatthew G Knepley   DMSetPointSF - Set the PetscSF encoding the parallel section point overlap for the DM.
3819057b4bcdSMatthew G Knepley 
3820057b4bcdSMatthew G Knepley   Input Parameters:
3821057b4bcdSMatthew G Knepley + dm - The DM
3822057b4bcdSMatthew G Knepley - sf - The PetscSF
3823057b4bcdSMatthew G Knepley 
3824057b4bcdSMatthew G Knepley   Level: intermediate
3825057b4bcdSMatthew G Knepley 
3826057b4bcdSMatthew G Knepley .seealso: DMGetPointSF(), DMGetDefaultSF(), DMSetDefaultSF(), DMCreateDefaultSF()
3827057b4bcdSMatthew G Knepley @*/
38280adebc6cSBarry Smith PetscErrorCode DMSetPointSF(DM dm, PetscSF sf)
38290adebc6cSBarry Smith {
3830057b4bcdSMatthew G Knepley   PetscErrorCode ierr;
3831057b4bcdSMatthew G Knepley 
3832057b4bcdSMatthew G Knepley   PetscFunctionBegin;
3833057b4bcdSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
3834057b4bcdSMatthew G Knepley   PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 1);
3835057b4bcdSMatthew G Knepley   ierr   = PetscSFDestroy(&dm->sf);CHKERRQ(ierr);
3836057b4bcdSMatthew G Knepley   ierr   = PetscObjectReference((PetscObject) sf);CHKERRQ(ierr);
3837057b4bcdSMatthew G Knepley   dm->sf = sf;
3838057b4bcdSMatthew G Knepley   PetscFunctionReturn(0);
3839057b4bcdSMatthew G Knepley }
3840057b4bcdSMatthew G Knepley 
3841057b4bcdSMatthew G Knepley #undef __FUNCT__
38422764a2aaSMatthew G. Knepley #define __FUNCT__ "DMGetDS"
38432764a2aaSMatthew G. Knepley /*@
38442764a2aaSMatthew G. Knepley   DMGetDS - Get the PetscDS
38452764a2aaSMatthew G. Knepley 
38462764a2aaSMatthew G. Knepley   Input Parameter:
38472764a2aaSMatthew G. Knepley . dm - The DM
38482764a2aaSMatthew G. Knepley 
38492764a2aaSMatthew G. Knepley   Output Parameter:
38502764a2aaSMatthew G. Knepley . prob - The PetscDS
38512764a2aaSMatthew G. Knepley 
38522764a2aaSMatthew G. Knepley   Level: developer
38532764a2aaSMatthew G. Knepley 
38542764a2aaSMatthew G. Knepley .seealso: DMSetDS()
38552764a2aaSMatthew G. Knepley @*/
38562764a2aaSMatthew G. Knepley PetscErrorCode DMGetDS(DM dm, PetscDS *prob)
3857af122d2aSMatthew G Knepley {
3858af122d2aSMatthew G Knepley   PetscFunctionBegin;
3859af122d2aSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
38600f21e855SMatthew G. Knepley   PetscValidPointer(prob, 2);
38610f21e855SMatthew G. Knepley   *prob = dm->prob;
38620f21e855SMatthew G. Knepley   PetscFunctionReturn(0);
38630f21e855SMatthew G. Knepley }
38640f21e855SMatthew G. Knepley 
38650f21e855SMatthew G. Knepley #undef __FUNCT__
38662764a2aaSMatthew G. Knepley #define __FUNCT__ "DMSetDS"
38672764a2aaSMatthew G. Knepley /*@
38682764a2aaSMatthew G. Knepley   DMSetDS - Set the PetscDS
38692764a2aaSMatthew G. Knepley 
38702764a2aaSMatthew G. Knepley   Input Parameters:
38712764a2aaSMatthew G. Knepley + dm - The DM
38722764a2aaSMatthew G. Knepley - prob - The PetscDS
38732764a2aaSMatthew G. Knepley 
38742764a2aaSMatthew G. Knepley   Level: developer
38752764a2aaSMatthew G. Knepley 
38762764a2aaSMatthew G. Knepley .seealso: DMGetDS()
38772764a2aaSMatthew G. Knepley @*/
38782764a2aaSMatthew G. Knepley PetscErrorCode DMSetDS(DM dm, PetscDS prob)
38790f21e855SMatthew G. Knepley {
38800f21e855SMatthew G. Knepley   PetscErrorCode ierr;
38810f21e855SMatthew G. Knepley 
38820f21e855SMatthew G. Knepley   PetscFunctionBegin;
38830f21e855SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
38842764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 2);
388537316535SToby Isaac   ierr = PetscObjectReference((PetscObject) prob);CHKERRQ(ierr);
38862764a2aaSMatthew G. Knepley   ierr = PetscDSDestroy(&dm->prob);CHKERRQ(ierr);
38870f21e855SMatthew G. Knepley   dm->prob = prob;
38880f21e855SMatthew G. Knepley   PetscFunctionReturn(0);
38890f21e855SMatthew G. Knepley }
38900f21e855SMatthew G. Knepley 
38910f21e855SMatthew G. Knepley #undef __FUNCT__
38920f21e855SMatthew G. Knepley #define __FUNCT__ "DMGetNumFields"
38930f21e855SMatthew G. Knepley PetscErrorCode DMGetNumFields(DM dm, PetscInt *numFields)
38940f21e855SMatthew G. Knepley {
38950f21e855SMatthew G. Knepley   PetscErrorCode ierr;
38960f21e855SMatthew G. Knepley 
38970f21e855SMatthew G. Knepley   PetscFunctionBegin;
38980f21e855SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
38992764a2aaSMatthew G. Knepley   ierr = PetscDSGetNumFields(dm->prob, numFields);CHKERRQ(ierr);
3900af122d2aSMatthew G Knepley   PetscFunctionReturn(0);
3901af122d2aSMatthew G Knepley }
3902af122d2aSMatthew G Knepley 
3903af122d2aSMatthew G Knepley #undef __FUNCT__
3904af122d2aSMatthew G Knepley #define __FUNCT__ "DMSetNumFields"
3905af122d2aSMatthew G Knepley PetscErrorCode DMSetNumFields(DM dm, PetscInt numFields)
3906af122d2aSMatthew G Knepley {
39070f21e855SMatthew G. Knepley   PetscInt       Nf, f;
3908af122d2aSMatthew G Knepley   PetscErrorCode ierr;
3909af122d2aSMatthew G Knepley 
3910af122d2aSMatthew G Knepley   PetscFunctionBegin;
3911af122d2aSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
39122764a2aaSMatthew G. Knepley   ierr = PetscDSGetNumFields(dm->prob, &Nf);CHKERRQ(ierr);
39130f21e855SMatthew G. Knepley   for (f = Nf; f < numFields; ++f) {
39140f21e855SMatthew G. Knepley     PetscContainer obj;
39150f21e855SMatthew G. Knepley 
39160f21e855SMatthew G. Knepley     ierr = PetscContainerCreate(PetscObjectComm((PetscObject) dm), &obj);CHKERRQ(ierr);
39172764a2aaSMatthew G. Knepley     ierr = PetscDSSetDiscretization(dm->prob, f, (PetscObject) obj);CHKERRQ(ierr);
39180f21e855SMatthew G. Knepley     ierr = PetscContainerDestroy(&obj);CHKERRQ(ierr);
3919af122d2aSMatthew G Knepley   }
3920af122d2aSMatthew G Knepley   PetscFunctionReturn(0);
3921af122d2aSMatthew G Knepley }
3922af122d2aSMatthew G Knepley 
3923af122d2aSMatthew G Knepley #undef __FUNCT__
3924af122d2aSMatthew G Knepley #define __FUNCT__ "DMGetField"
3925c1929be8SMatthew G. Knepley /*@
3926c1929be8SMatthew G. Knepley   DMGetField - Return the discretization object for a given DM field
3927c1929be8SMatthew G. Knepley 
3928c1929be8SMatthew G. Knepley   Not collective
3929c1929be8SMatthew G. Knepley 
3930c1929be8SMatthew G. Knepley   Input Parameters:
3931c1929be8SMatthew G. Knepley + dm - The DM
3932c1929be8SMatthew G. Knepley - f  - The field number
3933c1929be8SMatthew G. Knepley 
3934c1929be8SMatthew G. Knepley   Output Parameter:
3935c1929be8SMatthew G. Knepley . field - The discretization object
3936c1929be8SMatthew G. Knepley 
3937c1929be8SMatthew G. Knepley   Level: developer
3938c1929be8SMatthew G. Knepley 
3939c1929be8SMatthew G. Knepley .seealso: DMSetField()
3940c1929be8SMatthew G. Knepley @*/
3941af122d2aSMatthew G Knepley PetscErrorCode DMGetField(DM dm, PetscInt f, PetscObject *field)
3942af122d2aSMatthew G Knepley {
39430f21e855SMatthew G. Knepley   PetscErrorCode ierr;
39440f21e855SMatthew G. Knepley 
3945af122d2aSMatthew G Knepley   PetscFunctionBegin;
3946af122d2aSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
39472764a2aaSMatthew G. Knepley   ierr = PetscDSGetDiscretization(dm->prob, f, field);CHKERRQ(ierr);
3948decb47aaSMatthew G. Knepley   PetscFunctionReturn(0);
3949decb47aaSMatthew G. Knepley }
3950decb47aaSMatthew G. Knepley 
3951decb47aaSMatthew G. Knepley #undef __FUNCT__
3952decb47aaSMatthew G. Knepley #define __FUNCT__ "DMSetField"
3953c1929be8SMatthew G. Knepley /*@
3954c1929be8SMatthew G. Knepley   DMSetField - Set the discretization object for a given DM field
3955c1929be8SMatthew G. Knepley 
3956c1929be8SMatthew G. Knepley   Logically collective on DM
3957c1929be8SMatthew G. Knepley 
3958c1929be8SMatthew G. Knepley   Input Parameters:
3959c1929be8SMatthew G. Knepley + dm - The DM
3960c1929be8SMatthew G. Knepley . f  - The field number
3961c1929be8SMatthew G. Knepley - field - The discretization object
3962c1929be8SMatthew G. Knepley 
3963c1929be8SMatthew G. Knepley   Level: developer
3964c1929be8SMatthew G. Knepley 
3965c1929be8SMatthew G. Knepley .seealso: DMGetField()
3966c1929be8SMatthew G. Knepley @*/
3967decb47aaSMatthew G. Knepley PetscErrorCode DMSetField(DM dm, PetscInt f, PetscObject field)
3968decb47aaSMatthew G. Knepley {
3969decb47aaSMatthew G. Knepley   PetscErrorCode ierr;
3970decb47aaSMatthew G. Knepley 
3971decb47aaSMatthew G. Knepley   PetscFunctionBegin;
3972decb47aaSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
39732764a2aaSMatthew G. Knepley   ierr = PetscDSSetDiscretization(dm->prob, f, field);CHKERRQ(ierr);
3974af122d2aSMatthew G Knepley   PetscFunctionReturn(0);
3975af122d2aSMatthew G Knepley }
39766636e97aSMatthew G Knepley 
39776636e97aSMatthew G Knepley #undef __FUNCT__
3978b64e0483SPeter Brune #define __FUNCT__ "DMRestrictHook_Coordinates"
3979b64e0483SPeter Brune PetscErrorCode DMRestrictHook_Coordinates(DM dm,DM dmc,void *ctx)
3980b64e0483SPeter Brune {
3981b64e0483SPeter Brune   DM dm_coord,dmc_coord;
3982b64e0483SPeter Brune   PetscErrorCode ierr;
3983b64e0483SPeter Brune   Vec coords,ccoords;
39846dbf9973SLawrence Mitchell   Mat inject;
3985b64e0483SPeter Brune   PetscFunctionBegin;
3986b64e0483SPeter Brune   ierr = DMGetCoordinateDM(dm,&dm_coord);CHKERRQ(ierr);
3987b64e0483SPeter Brune   ierr = DMGetCoordinateDM(dmc,&dmc_coord);CHKERRQ(ierr);
3988b64e0483SPeter Brune   ierr = DMGetCoordinates(dm,&coords);CHKERRQ(ierr);
3989b64e0483SPeter Brune   ierr = DMGetCoordinates(dmc,&ccoords);CHKERRQ(ierr);
3990b64e0483SPeter Brune   if (coords && !ccoords) {
3991b64e0483SPeter Brune     ierr = DMCreateGlobalVector(dmc_coord,&ccoords);CHKERRQ(ierr);
39926668ed41SLisandro Dalcin     ierr = PetscObjectSetName((PetscObject)ccoords,"coordinates");CHKERRQ(ierr);
39936dbf9973SLawrence Mitchell     ierr = DMCreateInjection(dmc_coord,dm_coord,&inject);CHKERRQ(ierr);
39942adcf181SLawrence Mitchell     ierr = MatRestrict(inject,coords,ccoords);CHKERRQ(ierr);
39956dbf9973SLawrence Mitchell     ierr = MatDestroy(&inject);CHKERRQ(ierr);
3996b64e0483SPeter Brune     ierr = DMSetCoordinates(dmc,ccoords);CHKERRQ(ierr);
3997b64e0483SPeter Brune     ierr = VecDestroy(&ccoords);CHKERRQ(ierr);
3998b64e0483SPeter Brune   }
3999b64e0483SPeter Brune   PetscFunctionReturn(0);
4000b64e0483SPeter Brune }
4001b64e0483SPeter Brune 
4002b64e0483SPeter Brune #undef __FUNCT__
400303dadc2fSPeter Brune #define __FUNCT__ "DMSubDomainHook_Coordinates"
400403dadc2fSPeter Brune static PetscErrorCode DMSubDomainHook_Coordinates(DM dm,DM subdm,void *ctx)
400503dadc2fSPeter Brune {
400603dadc2fSPeter Brune   DM dm_coord,subdm_coord;
400703dadc2fSPeter Brune   PetscErrorCode ierr;
400803dadc2fSPeter Brune   Vec coords,ccoords,clcoords;
400903dadc2fSPeter Brune   VecScatter *scat_i,*scat_g;
401003dadc2fSPeter Brune   PetscFunctionBegin;
401103dadc2fSPeter Brune   ierr = DMGetCoordinateDM(dm,&dm_coord);CHKERRQ(ierr);
401203dadc2fSPeter Brune   ierr = DMGetCoordinateDM(subdm,&subdm_coord);CHKERRQ(ierr);
401303dadc2fSPeter Brune   ierr = DMGetCoordinates(dm,&coords);CHKERRQ(ierr);
401403dadc2fSPeter Brune   ierr = DMGetCoordinates(subdm,&ccoords);CHKERRQ(ierr);
401503dadc2fSPeter Brune   if (coords && !ccoords) {
401603dadc2fSPeter Brune     ierr = DMCreateGlobalVector(subdm_coord,&ccoords);CHKERRQ(ierr);
40176668ed41SLisandro Dalcin     ierr = PetscObjectSetName((PetscObject)ccoords,"coordinates");CHKERRQ(ierr);
401803dadc2fSPeter Brune     ierr = DMCreateLocalVector(subdm_coord,&clcoords);CHKERRQ(ierr);
401924640c55SToby Isaac     ierr = PetscObjectSetName((PetscObject)clcoords,"coordinates");CHKERRQ(ierr);
402003dadc2fSPeter Brune     ierr = DMCreateDomainDecompositionScatters(dm_coord,1,&subdm_coord,NULL,&scat_i,&scat_g);CHKERRQ(ierr);
402103dadc2fSPeter Brune     ierr = VecScatterBegin(scat_i[0],coords,ccoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
402203dadc2fSPeter Brune     ierr = VecScatterBegin(scat_g[0],coords,clcoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
402303dadc2fSPeter Brune     ierr = VecScatterEnd(scat_i[0],coords,ccoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
402403dadc2fSPeter Brune     ierr = VecScatterEnd(scat_g[0],coords,clcoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
402503dadc2fSPeter Brune     ierr = DMSetCoordinates(subdm,ccoords);CHKERRQ(ierr);
402603dadc2fSPeter Brune     ierr = DMSetCoordinatesLocal(subdm,clcoords);CHKERRQ(ierr);
402703dadc2fSPeter Brune     ierr = VecScatterDestroy(&scat_i[0]);CHKERRQ(ierr);
402803dadc2fSPeter Brune     ierr = VecScatterDestroy(&scat_g[0]);CHKERRQ(ierr);
402903dadc2fSPeter Brune     ierr = VecDestroy(&ccoords);CHKERRQ(ierr);
403003dadc2fSPeter Brune     ierr = VecDestroy(&clcoords);CHKERRQ(ierr);
403103dadc2fSPeter Brune     ierr = PetscFree(scat_i);CHKERRQ(ierr);
403203dadc2fSPeter Brune     ierr = PetscFree(scat_g);CHKERRQ(ierr);
403303dadc2fSPeter Brune   }
403403dadc2fSPeter Brune   PetscFunctionReturn(0);
403503dadc2fSPeter Brune }
403603dadc2fSPeter Brune 
403703dadc2fSPeter Brune #undef __FUNCT__
4038c73cfb54SMatthew G. Knepley #define __FUNCT__ "DMGetDimension"
4039c73cfb54SMatthew G. Knepley /*@
4040c73cfb54SMatthew G. Knepley   DMGetDimension - Return the topological dimension of the DM
4041c73cfb54SMatthew G. Knepley 
4042c73cfb54SMatthew G. Knepley   Not collective
4043c73cfb54SMatthew G. Knepley 
4044c73cfb54SMatthew G. Knepley   Input Parameter:
4045c73cfb54SMatthew G. Knepley . dm - The DM
4046c73cfb54SMatthew G. Knepley 
4047c73cfb54SMatthew G. Knepley   Output Parameter:
4048c73cfb54SMatthew G. Knepley . dim - The topological dimension
4049c73cfb54SMatthew G. Knepley 
4050c73cfb54SMatthew G. Knepley   Level: beginner
4051c73cfb54SMatthew G. Knepley 
4052c73cfb54SMatthew G. Knepley .seealso: DMSetDimension(), DMCreate()
4053c73cfb54SMatthew G. Knepley @*/
4054c73cfb54SMatthew G. Knepley PetscErrorCode DMGetDimension(DM dm, PetscInt *dim)
4055c73cfb54SMatthew G. Knepley {
4056c73cfb54SMatthew G. Knepley   PetscFunctionBegin;
4057c73cfb54SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4058c73cfb54SMatthew G. Knepley   PetscValidPointer(dim, 2);
4059c73cfb54SMatthew G. Knepley   *dim = dm->dim;
4060c73cfb54SMatthew G. Knepley   PetscFunctionReturn(0);
4061c73cfb54SMatthew G. Knepley }
4062c73cfb54SMatthew G. Knepley 
4063c73cfb54SMatthew G. Knepley #undef __FUNCT__
4064c73cfb54SMatthew G. Knepley #define __FUNCT__ "DMSetDimension"
4065c73cfb54SMatthew G. Knepley /*@
4066c73cfb54SMatthew G. Knepley   DMSetDimension - Set the topological dimension of the DM
4067c73cfb54SMatthew G. Knepley 
4068c73cfb54SMatthew G. Knepley   Collective on dm
4069c73cfb54SMatthew G. Knepley 
4070c73cfb54SMatthew G. Knepley   Input Parameters:
4071c73cfb54SMatthew G. Knepley + dm - The DM
4072c73cfb54SMatthew G. Knepley - dim - The topological dimension
4073c73cfb54SMatthew G. Knepley 
4074c73cfb54SMatthew G. Knepley   Level: beginner
4075c73cfb54SMatthew G. Knepley 
4076c73cfb54SMatthew G. Knepley .seealso: DMGetDimension(), DMCreate()
4077c73cfb54SMatthew G. Knepley @*/
4078c73cfb54SMatthew G. Knepley PetscErrorCode DMSetDimension(DM dm, PetscInt dim)
4079c73cfb54SMatthew G. Knepley {
4080c73cfb54SMatthew G. Knepley   PetscFunctionBegin;
4081c73cfb54SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4082c73cfb54SMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, dim, 2);
4083c73cfb54SMatthew G. Knepley   dm->dim = dim;
4084c73cfb54SMatthew G. Knepley   PetscFunctionReturn(0);
4085c73cfb54SMatthew G. Knepley }
4086c73cfb54SMatthew G. Knepley 
4087793f3fe5SMatthew G. Knepley #undef __FUNCT__
4088793f3fe5SMatthew G. Knepley #define __FUNCT__ "DMGetDimPoints"
4089793f3fe5SMatthew G. Knepley /*@
4090793f3fe5SMatthew G. Knepley   DMGetDimPoints - Get the half-open interval for all points of a given dimension
4091793f3fe5SMatthew G. Knepley 
4092793f3fe5SMatthew G. Knepley   Collective on DM
4093793f3fe5SMatthew G. Knepley 
4094793f3fe5SMatthew G. Knepley   Input Parameters:
4095793f3fe5SMatthew G. Knepley + dm - the DM
4096793f3fe5SMatthew G. Knepley - dim - the dimension
4097793f3fe5SMatthew G. Knepley 
4098793f3fe5SMatthew G. Knepley   Output Parameters:
4099793f3fe5SMatthew G. Knepley + pStart - The first point of the given dimension
4100793f3fe5SMatthew G. Knepley . pEnd - The first point following points of the given dimension
4101793f3fe5SMatthew G. Knepley 
4102793f3fe5SMatthew G. Knepley   Note:
4103793f3fe5SMatthew G. Knepley   The points are vertices in the Hasse diagram encoding the topology. This is explained in
4104793f3fe5SMatthew G. Knepley   http://arxiv.org/abs/0908.4427. If not points exist of this dimension in the storage scheme,
4105793f3fe5SMatthew G. Knepley   then the interval is empty.
4106793f3fe5SMatthew G. Knepley 
4107793f3fe5SMatthew G. Knepley   Level: intermediate
4108793f3fe5SMatthew G. Knepley 
4109793f3fe5SMatthew G. Knepley .keywords: point, Hasse Diagram, dimension
4110793f3fe5SMatthew G. Knepley .seealso: DMPLEX, DMPlexGetDepthStratum(), DMPlexGetHeightStratum()
4111793f3fe5SMatthew G. Knepley @*/
4112793f3fe5SMatthew G. Knepley PetscErrorCode DMGetDimPoints(DM dm, PetscInt dim, PetscInt *pStart, PetscInt *pEnd)
4113793f3fe5SMatthew G. Knepley {
4114793f3fe5SMatthew G. Knepley   PetscInt       d;
4115793f3fe5SMatthew G. Knepley   PetscErrorCode ierr;
4116793f3fe5SMatthew G. Knepley 
4117793f3fe5SMatthew G. Knepley   PetscFunctionBegin;
4118793f3fe5SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
4119793f3fe5SMatthew G. Knepley   ierr = DMGetDimension(dm, &d);CHKERRQ(ierr);
4120793f3fe5SMatthew G. Knepley   if ((dim < 0) || (dim > d)) SETERRQ2(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid dimension %d 1", dim, d);
4121793f3fe5SMatthew G. Knepley   ierr = (*dm->ops->getdimpoints)(dm, dim, pStart, pEnd);CHKERRQ(ierr);
4122793f3fe5SMatthew G. Knepley   PetscFunctionReturn(0);
4123793f3fe5SMatthew G. Knepley }
4124793f3fe5SMatthew G. Knepley 
4125793f3fe5SMatthew G. Knepley #undef __FUNCT__
41266636e97aSMatthew G Knepley #define __FUNCT__ "DMSetCoordinates"
41276636e97aSMatthew G Knepley /*@
41286636e97aSMatthew G Knepley   DMSetCoordinates - Sets into the DM a global vector that holds the coordinates
41296636e97aSMatthew G Knepley 
41306636e97aSMatthew G Knepley   Collective on DM
41316636e97aSMatthew G Knepley 
41326636e97aSMatthew G Knepley   Input Parameters:
41336636e97aSMatthew G Knepley + dm - the DM
41346636e97aSMatthew G Knepley - c - coordinate vector
41356636e97aSMatthew G Knepley 
41366636e97aSMatthew G Knepley   Note:
41376636e97aSMatthew G Knepley   The coordinates do include those for ghost points, which are in the local vector
41386636e97aSMatthew G Knepley 
41396636e97aSMatthew G Knepley   Level: intermediate
41406636e97aSMatthew G Knepley 
41416636e97aSMatthew G Knepley .keywords: distributed array, get, corners, nodes, local indices, coordinates
41426636e97aSMatthew G Knepley .seealso: DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLoca(), DMGetCoordinateDM()
41436636e97aSMatthew G Knepley @*/
41446636e97aSMatthew G Knepley PetscErrorCode DMSetCoordinates(DM dm, Vec c)
41456636e97aSMatthew G Knepley {
41466636e97aSMatthew G Knepley   PetscErrorCode ierr;
41476636e97aSMatthew G Knepley 
41486636e97aSMatthew G Knepley   PetscFunctionBegin;
41496636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
41506636e97aSMatthew G Knepley   PetscValidHeaderSpecific(c,VEC_CLASSID,2);
41516636e97aSMatthew G Knepley   ierr            = PetscObjectReference((PetscObject) c);CHKERRQ(ierr);
41526636e97aSMatthew G Knepley   ierr            = VecDestroy(&dm->coordinates);CHKERRQ(ierr);
41536636e97aSMatthew G Knepley   dm->coordinates = c;
41546636e97aSMatthew G Knepley   ierr            = VecDestroy(&dm->coordinatesLocal);CHKERRQ(ierr);
4155b64e0483SPeter Brune   ierr            = DMCoarsenHookAdd(dm,DMRestrictHook_Coordinates,NULL,NULL);CHKERRQ(ierr);
415603dadc2fSPeter Brune   ierr            = DMSubDomainHookAdd(dm,DMSubDomainHook_Coordinates,NULL,NULL);CHKERRQ(ierr);
41576636e97aSMatthew G Knepley   PetscFunctionReturn(0);
41586636e97aSMatthew G Knepley }
41596636e97aSMatthew G Knepley 
41606636e97aSMatthew G Knepley #undef __FUNCT__
41616636e97aSMatthew G Knepley #define __FUNCT__ "DMSetCoordinatesLocal"
41626636e97aSMatthew G Knepley /*@
41636636e97aSMatthew G Knepley   DMSetCoordinatesLocal - Sets into the DM a local vector that holds the coordinates
41646636e97aSMatthew G Knepley 
41656636e97aSMatthew G Knepley   Collective on DM
41666636e97aSMatthew G Knepley 
41676636e97aSMatthew G Knepley    Input Parameters:
41686636e97aSMatthew G Knepley +  dm - the DM
41696636e97aSMatthew G Knepley -  c - coordinate vector
41706636e97aSMatthew G Knepley 
41716636e97aSMatthew G Knepley   Note:
41726636e97aSMatthew G Knepley   The coordinates of ghost points can be set using DMSetCoordinates()
41736636e97aSMatthew G Knepley   followed by DMGetCoordinatesLocal(). This is intended to enable the
41746636e97aSMatthew G Knepley   setting of ghost coordinates outside of the domain.
41756636e97aSMatthew G Knepley 
41766636e97aSMatthew G Knepley   Level: intermediate
41776636e97aSMatthew G Knepley 
41786636e97aSMatthew G Knepley .keywords: distributed array, get, corners, nodes, local indices, coordinates
41796636e97aSMatthew G Knepley .seealso: DMGetCoordinatesLocal(), DMSetCoordinates(), DMGetCoordinates(), DMGetCoordinateDM()
41806636e97aSMatthew G Knepley @*/
41816636e97aSMatthew G Knepley PetscErrorCode DMSetCoordinatesLocal(DM dm, Vec c)
41826636e97aSMatthew G Knepley {
41836636e97aSMatthew G Knepley   PetscErrorCode ierr;
41846636e97aSMatthew G Knepley 
41856636e97aSMatthew G Knepley   PetscFunctionBegin;
41866636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
41876636e97aSMatthew G Knepley   PetscValidHeaderSpecific(c,VEC_CLASSID,2);
41886636e97aSMatthew G Knepley   ierr = PetscObjectReference((PetscObject) c);CHKERRQ(ierr);
41896636e97aSMatthew G Knepley   ierr = VecDestroy(&dm->coordinatesLocal);CHKERRQ(ierr);
41908865f1eaSKarl Rupp 
41916636e97aSMatthew G Knepley   dm->coordinatesLocal = c;
41928865f1eaSKarl Rupp 
41936636e97aSMatthew G Knepley   ierr = VecDestroy(&dm->coordinates);CHKERRQ(ierr);
41946636e97aSMatthew G Knepley   PetscFunctionReturn(0);
41956636e97aSMatthew G Knepley }
41966636e97aSMatthew G Knepley 
41976636e97aSMatthew G Knepley #undef __FUNCT__
41986636e97aSMatthew G Knepley #define __FUNCT__ "DMGetCoordinates"
41996636e97aSMatthew G Knepley /*@
42006636e97aSMatthew G Knepley   DMGetCoordinates - Gets a global vector with the coordinates associated with the DM.
42016636e97aSMatthew G Knepley 
42026636e97aSMatthew G Knepley   Not Collective
42036636e97aSMatthew G Knepley 
42046636e97aSMatthew G Knepley   Input Parameter:
42056636e97aSMatthew G Knepley . dm - the DM
42066636e97aSMatthew G Knepley 
42076636e97aSMatthew G Knepley   Output Parameter:
42086636e97aSMatthew G Knepley . c - global coordinate vector
42096636e97aSMatthew G Knepley 
42106636e97aSMatthew G Knepley   Note:
42116636e97aSMatthew G Knepley   This is a borrowed reference, so the user should NOT destroy this vector
42126636e97aSMatthew G Knepley 
42136636e97aSMatthew G Knepley   Each process has only the local coordinates (does NOT have the ghost coordinates).
42146636e97aSMatthew G Knepley 
42156636e97aSMatthew G Knepley   For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...)
42166636e97aSMatthew G Knepley   and (x_0,y_0,z_0,x_1,y_1,z_1...)
42176636e97aSMatthew G Knepley 
42186636e97aSMatthew G Knepley   Level: intermediate
42196636e97aSMatthew G Knepley 
42206636e97aSMatthew G Knepley .keywords: distributed array, get, corners, nodes, local indices, coordinates
42216636e97aSMatthew G Knepley .seealso: DMSetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM()
42226636e97aSMatthew G Knepley @*/
42236636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinates(DM dm, Vec *c)
42246636e97aSMatthew G Knepley {
42256636e97aSMatthew G Knepley   PetscErrorCode ierr;
42266636e97aSMatthew G Knepley 
42276636e97aSMatthew G Knepley   PetscFunctionBegin;
42286636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
42296636e97aSMatthew G Knepley   PetscValidPointer(c,2);
42301f588964SMatthew G Knepley   if (!dm->coordinates && dm->coordinatesLocal) {
42310298fd71SBarry Smith     DM cdm = NULL;
42326636e97aSMatthew G Knepley 
42336636e97aSMatthew G Knepley     ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
42346636e97aSMatthew G Knepley     ierr = DMCreateGlobalVector(cdm, &dm->coordinates);CHKERRQ(ierr);
42356636e97aSMatthew G Knepley     ierr = PetscObjectSetName((PetscObject) dm->coordinates, "coordinates");CHKERRQ(ierr);
42366636e97aSMatthew G Knepley     ierr = DMLocalToGlobalBegin(cdm, dm->coordinatesLocal, INSERT_VALUES, dm->coordinates);CHKERRQ(ierr);
42376636e97aSMatthew G Knepley     ierr = DMLocalToGlobalEnd(cdm, dm->coordinatesLocal, INSERT_VALUES, dm->coordinates);CHKERRQ(ierr);
42386636e97aSMatthew G Knepley   }
42396636e97aSMatthew G Knepley   *c = dm->coordinates;
42406636e97aSMatthew G Knepley   PetscFunctionReturn(0);
42416636e97aSMatthew G Knepley }
42426636e97aSMatthew G Knepley 
42436636e97aSMatthew G Knepley #undef __FUNCT__
42446636e97aSMatthew G Knepley #define __FUNCT__ "DMGetCoordinatesLocal"
42456636e97aSMatthew G Knepley /*@
42466636e97aSMatthew G Knepley   DMGetCoordinatesLocal - Gets a local vector with the coordinates associated with the DM.
42476636e97aSMatthew G Knepley 
42486636e97aSMatthew G Knepley   Collective on DM
42496636e97aSMatthew G Knepley 
42506636e97aSMatthew G Knepley   Input Parameter:
42516636e97aSMatthew G Knepley . dm - the DM
42526636e97aSMatthew G Knepley 
42536636e97aSMatthew G Knepley   Output Parameter:
42546636e97aSMatthew G Knepley . c - coordinate vector
42556636e97aSMatthew G Knepley 
42566636e97aSMatthew G Knepley   Note:
42576636e97aSMatthew G Knepley   This is a borrowed reference, so the user should NOT destroy this vector
42586636e97aSMatthew G Knepley 
42596636e97aSMatthew G Knepley   Each process has the local and ghost coordinates
42606636e97aSMatthew G Knepley 
42616636e97aSMatthew G Knepley   For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...)
42626636e97aSMatthew G Knepley   and (x_0,y_0,z_0,x_1,y_1,z_1...)
42636636e97aSMatthew G Knepley 
42646636e97aSMatthew G Knepley   Level: intermediate
42656636e97aSMatthew G Knepley 
42666636e97aSMatthew G Knepley .keywords: distributed array, get, corners, nodes, local indices, coordinates
42676636e97aSMatthew G Knepley .seealso: DMSetCoordinatesLocal(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM()
42686636e97aSMatthew G Knepley @*/
42696636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinatesLocal(DM dm, Vec *c)
42706636e97aSMatthew G Knepley {
42716636e97aSMatthew G Knepley   PetscErrorCode ierr;
42726636e97aSMatthew G Knepley 
42736636e97aSMatthew G Knepley   PetscFunctionBegin;
42746636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
42756636e97aSMatthew G Knepley   PetscValidPointer(c,2);
42761f588964SMatthew G Knepley   if (!dm->coordinatesLocal && dm->coordinates) {
42770298fd71SBarry Smith     DM cdm = NULL;
42786636e97aSMatthew G Knepley 
42796636e97aSMatthew G Knepley     ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
42806636e97aSMatthew G Knepley     ierr = DMCreateLocalVector(cdm, &dm->coordinatesLocal);CHKERRQ(ierr);
42816636e97aSMatthew G Knepley     ierr = PetscObjectSetName((PetscObject) dm->coordinatesLocal, "coordinates");CHKERRQ(ierr);
42826636e97aSMatthew G Knepley     ierr = DMGlobalToLocalBegin(cdm, dm->coordinates, INSERT_VALUES, dm->coordinatesLocal);CHKERRQ(ierr);
42836636e97aSMatthew G Knepley     ierr = DMGlobalToLocalEnd(cdm, dm->coordinates, INSERT_VALUES, dm->coordinatesLocal);CHKERRQ(ierr);
42846636e97aSMatthew G Knepley   }
42856636e97aSMatthew G Knepley   *c = dm->coordinatesLocal;
42866636e97aSMatthew G Knepley   PetscFunctionReturn(0);
42876636e97aSMatthew G Knepley }
42886636e97aSMatthew G Knepley 
42896636e97aSMatthew G Knepley #undef __FUNCT__
42906636e97aSMatthew G Knepley #define __FUNCT__ "DMGetCoordinateDM"
42916636e97aSMatthew G Knepley /*@
42921cfe2091SMatthew G. Knepley   DMGetCoordinateDM - Gets the DM that prescribes coordinate layout and scatters between global and local coordinates
42936636e97aSMatthew G Knepley 
42946636e97aSMatthew G Knepley   Collective on DM
42956636e97aSMatthew G Knepley 
42966636e97aSMatthew G Knepley   Input Parameter:
42976636e97aSMatthew G Knepley . dm - the DM
42986636e97aSMatthew G Knepley 
42996636e97aSMatthew G Knepley   Output Parameter:
43006636e97aSMatthew G Knepley . cdm - coordinate DM
43016636e97aSMatthew G Knepley 
43026636e97aSMatthew G Knepley   Level: intermediate
43036636e97aSMatthew G Knepley 
43046636e97aSMatthew G Knepley .keywords: distributed array, get, corners, nodes, local indices, coordinates
43051cfe2091SMatthew G. Knepley .seealso: DMSetCoordinateDM(), DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal()
43066636e97aSMatthew G Knepley @*/
43076636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinateDM(DM dm, DM *cdm)
43086636e97aSMatthew G Knepley {
43096636e97aSMatthew G Knepley   PetscErrorCode ierr;
43106636e97aSMatthew G Knepley 
43116636e97aSMatthew G Knepley   PetscFunctionBegin;
43126636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
43136636e97aSMatthew G Knepley   PetscValidPointer(cdm,2);
43146636e97aSMatthew G Knepley   if (!dm->coordinateDM) {
431582f516ccSBarry Smith     if (!dm->ops->createcoordinatedm) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Unable to create coordinates for this DM");
43166636e97aSMatthew G Knepley     ierr = (*dm->ops->createcoordinatedm)(dm, &dm->coordinateDM);CHKERRQ(ierr);
43176636e97aSMatthew G Knepley   }
43186636e97aSMatthew G Knepley   *cdm = dm->coordinateDM;
43196636e97aSMatthew G Knepley   PetscFunctionReturn(0);
43206636e97aSMatthew G Knepley }
4321e87bb0d3SMatthew G Knepley 
4322e87bb0d3SMatthew G Knepley #undef __FUNCT__
43231cfe2091SMatthew G. Knepley #define __FUNCT__ "DMSetCoordinateDM"
43241cfe2091SMatthew G. Knepley /*@
43251cfe2091SMatthew G. Knepley   DMSetCoordinateDM - Sets the DM that prescribes coordinate layout and scatters between global and local coordinates
43261cfe2091SMatthew G. Knepley 
43271cfe2091SMatthew G. Knepley   Logically Collective on DM
43281cfe2091SMatthew G. Knepley 
43291cfe2091SMatthew G. Knepley   Input Parameters:
43301cfe2091SMatthew G. Knepley + dm - the DM
43311cfe2091SMatthew G. Knepley - cdm - coordinate DM
43321cfe2091SMatthew G. Knepley 
43331cfe2091SMatthew G. Knepley   Level: intermediate
43341cfe2091SMatthew G. Knepley 
43351cfe2091SMatthew G. Knepley .keywords: distributed array, get, corners, nodes, local indices, coordinates
43361cfe2091SMatthew G. Knepley .seealso: DMGetCoordinateDM(), DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal()
43371cfe2091SMatthew G. Knepley @*/
43381cfe2091SMatthew G. Knepley PetscErrorCode DMSetCoordinateDM(DM dm, DM cdm)
43391cfe2091SMatthew G. Knepley {
43401cfe2091SMatthew G. Knepley   PetscErrorCode ierr;
43411cfe2091SMatthew G. Knepley 
43421cfe2091SMatthew G. Knepley   PetscFunctionBegin;
43431cfe2091SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
43441cfe2091SMatthew G. Knepley   PetscValidHeaderSpecific(cdm,DM_CLASSID,2);
43451cfe2091SMatthew G. Knepley   ierr = DMDestroy(&dm->coordinateDM);CHKERRQ(ierr);
43461cfe2091SMatthew G. Knepley   dm->coordinateDM = cdm;
43471cfe2091SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) dm->coordinateDM);CHKERRQ(ierr);
43481cfe2091SMatthew G. Knepley   PetscFunctionReturn(0);
43491cfe2091SMatthew G. Knepley }
43501cfe2091SMatthew G. Knepley 
43511cfe2091SMatthew G. Knepley #undef __FUNCT__
435246e270d4SMatthew G. Knepley #define __FUNCT__ "DMGetCoordinateDim"
435346e270d4SMatthew G. Knepley /*@
435446e270d4SMatthew G. Knepley   DMGetCoordinateDim - Retrieve the dimension of embedding space for coordinate values.
435546e270d4SMatthew G. Knepley 
435646e270d4SMatthew G. Knepley   Not Collective
435746e270d4SMatthew G. Knepley 
435846e270d4SMatthew G. Knepley   Input Parameter:
435946e270d4SMatthew G. Knepley . dm - The DM object
436046e270d4SMatthew G. Knepley 
436146e270d4SMatthew G. Knepley   Output Parameter:
436246e270d4SMatthew G. Knepley . dim - The embedding dimension
436346e270d4SMatthew G. Knepley 
436446e270d4SMatthew G. Knepley   Level: intermediate
436546e270d4SMatthew G. Knepley 
436646e270d4SMatthew G. Knepley .keywords: mesh, coordinates
436746e270d4SMatthew G. Knepley .seealso: DMSetCoordinateDim(), DMGetCoordinateSection(), DMGetCoordinateDM(), DMGetDefaultSection(), DMSetDefaultSection()
436846e270d4SMatthew G. Knepley @*/
436946e270d4SMatthew G. Knepley PetscErrorCode DMGetCoordinateDim(DM dm, PetscInt *dim)
437046e270d4SMatthew G. Knepley {
437146e270d4SMatthew G. Knepley   PetscFunctionBegin;
437246e270d4SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
437346e270d4SMatthew G. Knepley   PetscValidPointer(dim, 2);
43749a9a41abSToby Isaac   if (dm->dimEmbed == PETSC_DEFAULT) {
43759a9a41abSToby Isaac     dm->dimEmbed = dm->dim;
43769a9a41abSToby Isaac   }
437746e270d4SMatthew G. Knepley   *dim = dm->dimEmbed;
437846e270d4SMatthew G. Knepley   PetscFunctionReturn(0);
437946e270d4SMatthew G. Knepley }
438046e270d4SMatthew G. Knepley 
438146e270d4SMatthew G. Knepley #undef __FUNCT__
438246e270d4SMatthew G. Knepley #define __FUNCT__ "DMSetCoordinateDim"
438346e270d4SMatthew G. Knepley /*@
438446e270d4SMatthew G. Knepley   DMSetCoordinateDim - Set the dimension of the embedding space for coordinate values.
438546e270d4SMatthew G. Knepley 
438646e270d4SMatthew G. Knepley   Not Collective
438746e270d4SMatthew G. Knepley 
438846e270d4SMatthew G. Knepley   Input Parameters:
438946e270d4SMatthew G. Knepley + dm  - The DM object
439046e270d4SMatthew G. Knepley - dim - The embedding dimension
439146e270d4SMatthew G. Knepley 
439246e270d4SMatthew G. Knepley   Level: intermediate
439346e270d4SMatthew G. Knepley 
439446e270d4SMatthew G. Knepley .keywords: mesh, coordinates
439546e270d4SMatthew G. Knepley .seealso: DMGetCoordinateDim(), DMSetCoordinateSection(), DMGetCoordinateSection(), DMGetDefaultSection(), DMSetDefaultSection()
439646e270d4SMatthew G. Knepley @*/
439746e270d4SMatthew G. Knepley PetscErrorCode DMSetCoordinateDim(DM dm, PetscInt dim)
439846e270d4SMatthew G. Knepley {
439946e270d4SMatthew G. Knepley   PetscFunctionBegin;
440046e270d4SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
440146e270d4SMatthew G. Knepley   dm->dimEmbed = dim;
440246e270d4SMatthew G. Knepley   PetscFunctionReturn(0);
440346e270d4SMatthew G. Knepley }
440446e270d4SMatthew G. Knepley 
440546e270d4SMatthew G. Knepley #undef __FUNCT__
4406e8abe2deSMatthew G. Knepley #define __FUNCT__ "DMGetCoordinateSection"
4407e8abe2deSMatthew G. Knepley /*@
4408e8abe2deSMatthew G. Knepley   DMGetCoordinateSection - Retrieve the layout of coordinate values over the mesh.
4409e8abe2deSMatthew G. Knepley 
4410e8abe2deSMatthew G. Knepley   Not Collective
4411e8abe2deSMatthew G. Knepley 
4412e8abe2deSMatthew G. Knepley   Input Parameter:
4413e8abe2deSMatthew G. Knepley . dm - The DM object
4414e8abe2deSMatthew G. Knepley 
4415e8abe2deSMatthew G. Knepley   Output Parameter:
4416e8abe2deSMatthew G. Knepley . section - The PetscSection object
4417e8abe2deSMatthew G. Knepley 
4418e8abe2deSMatthew G. Knepley   Level: intermediate
4419e8abe2deSMatthew G. Knepley 
4420e8abe2deSMatthew G. Knepley .keywords: mesh, coordinates
4421e8abe2deSMatthew G. Knepley .seealso: DMGetCoordinateDM(), DMGetDefaultSection(), DMSetDefaultSection()
4422e8abe2deSMatthew G. Knepley @*/
4423e8abe2deSMatthew G. Knepley PetscErrorCode DMGetCoordinateSection(DM dm, PetscSection *section)
4424e8abe2deSMatthew G. Knepley {
4425e8abe2deSMatthew G. Knepley   DM             cdm;
4426e8abe2deSMatthew G. Knepley   PetscErrorCode ierr;
4427e8abe2deSMatthew G. Knepley 
4428e8abe2deSMatthew G. Knepley   PetscFunctionBegin;
4429e8abe2deSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4430e8abe2deSMatthew G. Knepley   PetscValidPointer(section, 2);
4431e8abe2deSMatthew G. Knepley   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
4432e8abe2deSMatthew G. Knepley   ierr = DMGetDefaultSection(cdm, section);CHKERRQ(ierr);
4433e8abe2deSMatthew G. Knepley   PetscFunctionReturn(0);
4434e8abe2deSMatthew G. Knepley }
4435e8abe2deSMatthew G. Knepley 
4436e8abe2deSMatthew G. Knepley #undef __FUNCT__
4437e8abe2deSMatthew G. Knepley #define __FUNCT__ "DMSetCoordinateSection"
4438e8abe2deSMatthew G. Knepley /*@
4439e8abe2deSMatthew G. Knepley   DMSetCoordinateSection - Set the layout of coordinate values over the mesh.
4440e8abe2deSMatthew G. Knepley 
4441e8abe2deSMatthew G. Knepley   Not Collective
4442e8abe2deSMatthew G. Knepley 
4443e8abe2deSMatthew G. Knepley   Input Parameters:
4444e8abe2deSMatthew G. Knepley + dm      - The DM object
444546e270d4SMatthew G. Knepley . dim     - The embedding dimension, or PETSC_DETERMINE
4446e8abe2deSMatthew G. Knepley - section - The PetscSection object
4447e8abe2deSMatthew G. Knepley 
4448e8abe2deSMatthew G. Knepley   Level: intermediate
4449e8abe2deSMatthew G. Knepley 
4450e8abe2deSMatthew G. Knepley .keywords: mesh, coordinates
4451e8abe2deSMatthew G. Knepley .seealso: DMGetCoordinateSection(), DMGetDefaultSection(), DMSetDefaultSection()
4452e8abe2deSMatthew G. Knepley @*/
445346e270d4SMatthew G. Knepley PetscErrorCode DMSetCoordinateSection(DM dm, PetscInt dim, PetscSection section)
4454e8abe2deSMatthew G. Knepley {
4455e8abe2deSMatthew G. Knepley   DM             cdm;
4456e8abe2deSMatthew G. Knepley   PetscErrorCode ierr;
4457e8abe2deSMatthew G. Knepley 
4458e8abe2deSMatthew G. Knepley   PetscFunctionBegin;
4459e8abe2deSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
446046e270d4SMatthew G. Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,3);
4461e8abe2deSMatthew G. Knepley   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
4462e8abe2deSMatthew G. Knepley   ierr = DMSetDefaultSection(cdm, section);CHKERRQ(ierr);
446346e270d4SMatthew G. Knepley   if (dim == PETSC_DETERMINE) {
446446e270d4SMatthew G. Knepley     PetscInt d = dim;
446546e270d4SMatthew G. Knepley     PetscInt pStart, pEnd, vStart, vEnd, v, dd;
446646e270d4SMatthew G. Knepley 
446746e270d4SMatthew G. Knepley     ierr = PetscSectionGetChart(section, &pStart, &pEnd);CHKERRQ(ierr);
446846e270d4SMatthew G. Knepley     ierr = DMGetDimPoints(dm, 0, &vStart, &vEnd);CHKERRQ(ierr);
446946e270d4SMatthew G. Knepley     pStart = PetscMax(vStart, pStart);
447046e270d4SMatthew G. Knepley     pEnd   = PetscMin(vEnd, pEnd);
447146e270d4SMatthew G. Knepley     for (v = pStart; v < pEnd; ++v) {
447246e270d4SMatthew G. Knepley       ierr = PetscSectionGetDof(section, v, &dd);CHKERRQ(ierr);
447346e270d4SMatthew G. Knepley       if (dd) {d = dd; break;}
447446e270d4SMatthew G. Knepley     }
44756be882deSMatthew G. Knepley     if (d < 0) d = PETSC_DEFAULT;
447646e270d4SMatthew G. Knepley     ierr = DMSetCoordinateDim(dm, d);CHKERRQ(ierr);
447746e270d4SMatthew G. Knepley   }
4478e8abe2deSMatthew G. Knepley   PetscFunctionReturn(0);
4479e8abe2deSMatthew G. Knepley }
4480e8abe2deSMatthew G. Knepley 
4481e8abe2deSMatthew G. Knepley #undef __FUNCT__
4482c6b900c6SMatthew G. Knepley #define __FUNCT__ "DMGetPeriodicity"
44835dc8c3f7SMatthew G. Knepley /*@C
44845dc8c3f7SMatthew G. Knepley   DMSetPeriodicity - Set the description of mesh periodicity
44855dc8c3f7SMatthew G. Knepley 
44865dc8c3f7SMatthew G. Knepley   Input Parameters:
44875dc8c3f7SMatthew G. Knepley + dm      - The DM object
44885dc8c3f7SMatthew G. Knepley . maxCell - Over distances greater than this, we can assume a point has crossed over to another sheet, when trying to localize cell coordinates
44895dc8c3f7SMatthew G. Knepley . L       - If we assume the mesh is a torus, this is the length of each coordinate
44905dc8c3f7SMatthew G. Knepley - bd      - This describes the type of periodicity in each topological dimension
44915dc8c3f7SMatthew G. Knepley 
44925dc8c3f7SMatthew G. Knepley   Level: developer
44935dc8c3f7SMatthew G. Knepley 
44945dc8c3f7SMatthew G. Knepley .seealso: DMGetPeriodicity()
44955dc8c3f7SMatthew G. Knepley @*/
44965dc8c3f7SMatthew G. Knepley PetscErrorCode DMGetPeriodicity(DM dm, const PetscReal **maxCell, const PetscReal **L, const DMBoundaryType **bd)
4497c6b900c6SMatthew G. Knepley {
4498c6b900c6SMatthew G. Knepley   PetscFunctionBegin;
4499c6b900c6SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
4500c6b900c6SMatthew G. Knepley   if (L)       *L       = dm->L;
4501c6b900c6SMatthew G. Knepley   if (maxCell) *maxCell = dm->maxCell;
45025dc8c3f7SMatthew G. Knepley   if (bd)      *bd      = dm->bdtype;
4503c6b900c6SMatthew G. Knepley   PetscFunctionReturn(0);
4504c6b900c6SMatthew G. Knepley }
4505c6b900c6SMatthew G. Knepley 
4506c6b900c6SMatthew G. Knepley #undef __FUNCT__
4507c6b900c6SMatthew G. Knepley #define __FUNCT__ "DMSetPeriodicity"
45085dc8c3f7SMatthew G. Knepley /*@C
45095dc8c3f7SMatthew G. Knepley   DMSetPeriodicity - Set the description of mesh periodicity
45105dc8c3f7SMatthew G. Knepley 
45115dc8c3f7SMatthew G. Knepley   Input Parameters:
45125dc8c3f7SMatthew G. Knepley + dm      - The DM object
45135dc8c3f7SMatthew 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
45145dc8c3f7SMatthew G. Knepley . L       - If we assume the mesh is a torus, this is the length of each coordinate
45155dc8c3f7SMatthew G. Knepley - bd      - This describes the type of periodicity in each topological dimension
45165dc8c3f7SMatthew G. Knepley 
45175dc8c3f7SMatthew G. Knepley   Level: developer
45185dc8c3f7SMatthew G. Knepley 
45195dc8c3f7SMatthew G. Knepley .seealso: DMGetPeriodicity()
45205dc8c3f7SMatthew G. Knepley @*/
45215dc8c3f7SMatthew G. Knepley PetscErrorCode DMSetPeriodicity(DM dm, const PetscReal maxCell[], const PetscReal L[], const DMBoundaryType bd[])
4522c6b900c6SMatthew G. Knepley {
4523c6b900c6SMatthew G. Knepley   PetscInt       dim, d;
4524c6b900c6SMatthew G. Knepley   PetscErrorCode ierr;
4525c6b900c6SMatthew G. Knepley 
4526c6b900c6SMatthew G. Knepley   PetscFunctionBegin;
4527c6b900c6SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
45285dc8c3f7SMatthew G. Knepley   PetscValidPointer(L,3);PetscValidPointer(maxCell,2);PetscValidPointer(bd,4);
45295dc8c3f7SMatthew G. Knepley   ierr = PetscFree3(dm->L,dm->maxCell,dm->bdtype);CHKERRQ(ierr);
45305dc8c3f7SMatthew G. Knepley   ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr);
45315dc8c3f7SMatthew G. Knepley   ierr = PetscMalloc3(dim,&dm->L,dim,&dm->maxCell,dim,&dm->bdtype);CHKERRQ(ierr);
45325dc8c3f7SMatthew G. Knepley   for (d = 0; d < dim; ++d) {dm->L[d] = L[d]; dm->maxCell[d] = maxCell[d]; dm->bdtype[d] = bd[d];}
4533c6b900c6SMatthew G. Knepley   PetscFunctionReturn(0);
4534c6b900c6SMatthew G. Knepley }
4535c6b900c6SMatthew G. Knepley 
4536c6b900c6SMatthew G. Knepley #undef __FUNCT__
45372e17dfb7SMatthew G. Knepley #define __FUNCT__ "DMLocalizeCoordinate"
45382e17dfb7SMatthew G. Knepley /*@
45392e17dfb7SMatthew 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.
45402e17dfb7SMatthew G. Knepley 
45412e17dfb7SMatthew G. Knepley   Input Parameters:
45422e17dfb7SMatthew G. Knepley + dm     - The DM
45432e17dfb7SMatthew G. Knepley - in     - The input coordinate point (dim numbers)
45442e17dfb7SMatthew G. Knepley 
45452e17dfb7SMatthew G. Knepley   Output Parameter:
45462e17dfb7SMatthew G. Knepley . out - The localized coordinate point
45472e17dfb7SMatthew G. Knepley 
45482e17dfb7SMatthew G. Knepley   Level: developer
45492e17dfb7SMatthew G. Knepley 
45502e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeAddCoordinate()
45512e17dfb7SMatthew G. Knepley @*/
45522e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinate(DM dm, const PetscScalar in[], PetscScalar out[])
45532e17dfb7SMatthew G. Knepley {
45542e17dfb7SMatthew G. Knepley   PetscInt       dim, d;
45552e17dfb7SMatthew G. Knepley   PetscErrorCode ierr;
45562e17dfb7SMatthew G. Knepley 
45572e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
45582e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &dim);CHKERRQ(ierr);
45592e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
45602e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] = in[d];
45612e17dfb7SMatthew G. Knepley   } else {
45622e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) {
45632e17dfb7SMatthew G. Knepley       out[d] = in[d] - dm->L[d]*floor(PetscRealPart(in[d])/dm->L[d]);
45642e17dfb7SMatthew G. Knepley     }
45652e17dfb7SMatthew G. Knepley   }
45662e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
45672e17dfb7SMatthew G. Knepley }
45682e17dfb7SMatthew G. Knepley 
45692e17dfb7SMatthew G. Knepley #undef __FUNCT__
45702e17dfb7SMatthew G. Knepley #define __FUNCT__ "DMLocalizeCoordinate_Internal"
45712e17dfb7SMatthew G. Knepley /*
45722e17dfb7SMatthew 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.
45732e17dfb7SMatthew G. Knepley 
45742e17dfb7SMatthew G. Knepley   Input Parameters:
45752e17dfb7SMatthew G. Knepley + dm     - The DM
45762e17dfb7SMatthew G. Knepley . dim    - The spatial dimension
45772e17dfb7SMatthew G. Knepley . anchor - The anchor point, the input point can be no more than maxCell away from it
45782e17dfb7SMatthew G. Knepley - in     - The input coordinate point (dim numbers)
45792e17dfb7SMatthew G. Knepley 
45802e17dfb7SMatthew G. Knepley   Output Parameter:
45812e17dfb7SMatthew G. Knepley . out - The localized coordinate point
45822e17dfb7SMatthew G. Knepley 
45832e17dfb7SMatthew G. Knepley   Level: developer
45842e17dfb7SMatthew G. Knepley 
45852e17dfb7SMatthew 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
45862e17dfb7SMatthew G. Knepley 
45872e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeAddCoordinate()
45882e17dfb7SMatthew G. Knepley */
45892e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinate_Internal(DM dm, PetscInt dim, const PetscScalar anchor[], const PetscScalar in[], PetscScalar out[])
45902e17dfb7SMatthew G. Knepley {
45912e17dfb7SMatthew G. Knepley   PetscInt d;
45922e17dfb7SMatthew G. Knepley 
45932e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
45942e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
45952e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] = in[d];
45962e17dfb7SMatthew G. Knepley   } else {
45972e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) {
45982e17dfb7SMatthew G. Knepley       if (PetscAbsScalar(anchor[d] - in[d]) > dm->maxCell[d]) {
45992e17dfb7SMatthew G. Knepley         out[d] = PetscRealPart(anchor[d]) > PetscRealPart(in[d]) ? dm->L[d] + in[d] : in[d] - dm->L[d];
46002e17dfb7SMatthew G. Knepley       } else {
46012e17dfb7SMatthew G. Knepley         out[d] = in[d];
46022e17dfb7SMatthew G. Knepley       }
46032e17dfb7SMatthew G. Knepley     }
46042e17dfb7SMatthew G. Knepley   }
46052e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
46062e17dfb7SMatthew G. Knepley }
46072e17dfb7SMatthew G. Knepley #undef __FUNCT__
46082e17dfb7SMatthew G. Knepley #define __FUNCT__ "DMLocalizeCoordinateReal_Internal"
46092e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinateReal_Internal(DM dm, PetscInt dim, const PetscReal anchor[], const PetscReal in[], PetscReal out[])
46102e17dfb7SMatthew G. Knepley {
46112e17dfb7SMatthew G. Knepley   PetscInt d;
46122e17dfb7SMatthew G. Knepley 
46132e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
46142e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
46152e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] = in[d];
46162e17dfb7SMatthew G. Knepley   } else {
46172e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) {
46182e17dfb7SMatthew G. Knepley       if (PetscAbsReal(anchor[d] - in[d]) > dm->maxCell[d]) {
46192e17dfb7SMatthew G. Knepley         out[d] = anchor[d] > in[d] ? dm->L[d] + in[d] : in[d] - dm->L[d];
46202e17dfb7SMatthew G. Knepley       } else {
46212e17dfb7SMatthew G. Knepley         out[d] = in[d];
46222e17dfb7SMatthew G. Knepley       }
46232e17dfb7SMatthew G. Knepley     }
46242e17dfb7SMatthew G. Knepley   }
46252e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
46262e17dfb7SMatthew G. Knepley }
46272e17dfb7SMatthew G. Knepley 
46282e17dfb7SMatthew G. Knepley #undef __FUNCT__
46292e17dfb7SMatthew G. Knepley #define __FUNCT__ "DMLocalizeAddCoordinate_Internal"
46302e17dfb7SMatthew G. Knepley /*
46312e17dfb7SMatthew 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.
46322e17dfb7SMatthew G. Knepley 
46332e17dfb7SMatthew G. Knepley   Input Parameters:
46342e17dfb7SMatthew G. Knepley + dm     - The DM
46352e17dfb7SMatthew G. Knepley . dim    - The spatial dimension
46362e17dfb7SMatthew G. Knepley . anchor - The anchor point, the input point can be no more than maxCell away from it
46372e17dfb7SMatthew G. Knepley . in     - The input coordinate delta (dim numbers)
46382e17dfb7SMatthew G. Knepley - out    - The input coordinate point (dim numbers)
46392e17dfb7SMatthew G. Knepley 
46402e17dfb7SMatthew G. Knepley   Output Parameter:
46412e17dfb7SMatthew G. Knepley . out    - The localized coordinate in + out
46422e17dfb7SMatthew G. Knepley 
46432e17dfb7SMatthew G. Knepley   Level: developer
46442e17dfb7SMatthew G. Knepley 
46452e17dfb7SMatthew 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
46462e17dfb7SMatthew G. Knepley 
46472e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeCoordinate()
46482e17dfb7SMatthew G. Knepley */
46492e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeAddCoordinate_Internal(DM dm, PetscInt dim, const PetscScalar anchor[], const PetscScalar in[], PetscScalar out[])
46502e17dfb7SMatthew G. Knepley {
46512e17dfb7SMatthew G. Knepley   PetscInt d;
46522e17dfb7SMatthew G. Knepley 
46532e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
46542e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
46552e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] += in[d];
46562e17dfb7SMatthew G. Knepley   } else {
46572e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) {
46582e17dfb7SMatthew G. Knepley       if (PetscAbsScalar(anchor[d] - in[d]) > dm->maxCell[d]) {
46592e17dfb7SMatthew G. Knepley         out[d] += PetscRealPart(anchor[d]) > PetscRealPart(in[d]) ? dm->L[d] + in[d] : in[d] - dm->L[d];
46602e17dfb7SMatthew G. Knepley       } else {
46612e17dfb7SMatthew G. Knepley         out[d] += in[d];
46622e17dfb7SMatthew G. Knepley       }
46632e17dfb7SMatthew G. Knepley     }
46642e17dfb7SMatthew G. Knepley   }
46652e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
46662e17dfb7SMatthew G. Knepley }
46672e17dfb7SMatthew G. Knepley 
46682e17dfb7SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMPlexGetDepthStratum(DM, PetscInt, PetscInt *, PetscInt *);
46692e17dfb7SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMPlexGetHeightStratum(DM, PetscInt, PetscInt *, PetscInt *);
46702e17dfb7SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMPlexVecGetClosure(DM, PetscSection, Vec, PetscInt, PetscInt *, PetscScalar *[]);
46712e17dfb7SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMPlexVecRestoreClosure(DM, PetscSection, Vec, PetscInt, PetscInt *, PetscScalar *[]);
46722e17dfb7SMatthew G. Knepley 
46732e17dfb7SMatthew G. Knepley #undef __FUNCT__
467436447a5eSToby Isaac #define __FUNCT__ "DMGetCoordinatesLocalized"
467536447a5eSToby Isaac /*@
467636447a5eSToby Isaac   DMGetCoordinatesLocalized - Check if the DM coordinates have been localized for cells
467736447a5eSToby Isaac 
467836447a5eSToby Isaac   Input Parameter:
467936447a5eSToby Isaac . dm - The DM
468036447a5eSToby Isaac 
468136447a5eSToby Isaac   Output Parameter:
468236447a5eSToby Isaac   areLocalized - True if localized
468336447a5eSToby Isaac 
468436447a5eSToby Isaac   Level: developer
468536447a5eSToby Isaac 
468636447a5eSToby Isaac .seealso: DMLocalizeCoordinates()
468736447a5eSToby Isaac @*/
468836447a5eSToby Isaac PetscErrorCode DMGetCoordinatesLocalized(DM dm,PetscBool *areLocalized)
468936447a5eSToby Isaac {
469036447a5eSToby Isaac   DM             cdm;
469136447a5eSToby Isaac   PetscSection   coordSection;
469236447a5eSToby Isaac   PetscInt       cStart, cEnd, c, sStart, sEnd, dof;
469336447a5eSToby Isaac   PetscBool      alreadyLocalized, alreadyLocalizedGlobal;
469436447a5eSToby Isaac   PetscErrorCode ierr;
469536447a5eSToby Isaac 
469636447a5eSToby Isaac   PetscFunctionBegin;
469736447a5eSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
46988b09590cSToby Isaac   if (!dm->maxCell) {
46998b09590cSToby Isaac     *areLocalized = PETSC_FALSE;
47008b09590cSToby Isaac     PetscFunctionReturn(0);
47018b09590cSToby Isaac   }
470236447a5eSToby Isaac   /* We need some generic way of refering to cells/vertices */
470336447a5eSToby Isaac   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
470436447a5eSToby Isaac   {
470536447a5eSToby Isaac     PetscBool isplex;
470636447a5eSToby Isaac 
470736447a5eSToby Isaac     ierr = PetscObjectTypeCompare((PetscObject) cdm, DMPLEX, &isplex);CHKERRQ(ierr);
470836447a5eSToby Isaac     if (isplex) {
470936447a5eSToby Isaac       ierr = DMPlexGetHeightStratum(cdm, 0, &cStart, &cEnd);CHKERRQ(ierr);
471036447a5eSToby Isaac     } else SETERRQ(PetscObjectComm((PetscObject) cdm), PETSC_ERR_ARG_WRONG, "Coordinate localization requires a DMPLEX coordinate DM");
471136447a5eSToby Isaac   }
471236447a5eSToby Isaac   ierr = DMGetCoordinateSection(dm, &coordSection);CHKERRQ(ierr);
471336447a5eSToby Isaac   ierr = PetscSectionGetChart(coordSection,&sStart,&sEnd);CHKERRQ(ierr);
471436447a5eSToby Isaac   alreadyLocalized = alreadyLocalizedGlobal = PETSC_TRUE;
471536447a5eSToby Isaac   for (c = cStart; c < cEnd; ++c) {
471636447a5eSToby Isaac     if (c < sStart || c >= sEnd) {
471736447a5eSToby Isaac       alreadyLocalized = PETSC_FALSE;
471836447a5eSToby Isaac       break;
471936447a5eSToby Isaac     }
472036447a5eSToby Isaac     ierr = PetscSectionGetDof(coordSection, c, &dof);CHKERRQ(ierr);
472136447a5eSToby Isaac     if (!dof) {
472236447a5eSToby Isaac       alreadyLocalized = PETSC_FALSE;
472336447a5eSToby Isaac       break;
472436447a5eSToby Isaac     }
472536447a5eSToby Isaac   }
472636447a5eSToby Isaac   ierr = MPI_Allreduce(&alreadyLocalized,&alreadyLocalizedGlobal,1,MPIU_BOOL,MPI_LAND,PetscObjectComm((PetscObject)dm));CHKERRQ(ierr);
472736447a5eSToby Isaac   *areLocalized = alreadyLocalizedGlobal;
472836447a5eSToby Isaac   PetscFunctionReturn(0);
472936447a5eSToby Isaac }
473036447a5eSToby Isaac 
473136447a5eSToby Isaac 
473236447a5eSToby Isaac #undef __FUNCT__
47332e17dfb7SMatthew G. Knepley #define __FUNCT__ "DMLocalizeCoordinates"
47342e17dfb7SMatthew G. Knepley /*@
47352e17dfb7SMatthew G. Knepley   DMLocalizeCoordinates - If a mesh is periodic, create local coordinates for each cell
47362e17dfb7SMatthew G. Knepley 
47372e17dfb7SMatthew G. Knepley   Input Parameter:
47382e17dfb7SMatthew G. Knepley . dm - The DM
47392e17dfb7SMatthew G. Knepley 
47402e17dfb7SMatthew G. Knepley   Level: developer
47412e17dfb7SMatthew G. Knepley 
47422e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinate(), DMLocalizeAddCoordinate()
47432e17dfb7SMatthew G. Knepley @*/
47442e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinates(DM dm)
47452e17dfb7SMatthew G. Knepley {
47462e17dfb7SMatthew G. Knepley   DM             cdm;
47472e17dfb7SMatthew G. Knepley   PetscSection   coordSection, cSection;
47482e17dfb7SMatthew G. Knepley   Vec            coordinates,  cVec;
47493e922f36SToby Isaac   PetscScalar   *coords, *coords2, *anchor, *localized;
47503e922f36SToby Isaac   PetscInt       Nc, vStart, vEnd, v, sStart, sEnd, newStart = PETSC_MAX_INT, newEnd = PETSC_MIN_INT, dof, d, off, off2, bs, coordSize;
4751e0ae35bbSToby Isaac   PetscBool      alreadyLocalized, alreadyLocalizedGlobal;
47523e922f36SToby Isaac   PetscInt       maxHeight = 0, h;
47533e922f36SToby Isaac   PetscInt       *pStart = NULL, *pEnd = NULL;
47542e17dfb7SMatthew G. Knepley   PetscErrorCode ierr;
47552e17dfb7SMatthew G. Knepley 
47562e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
47572e17dfb7SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
47582e17dfb7SMatthew G. Knepley   if (!dm->maxCell) PetscFunctionReturn(0);
47592e17dfb7SMatthew G. Knepley   /* We need some generic way of refering to cells/vertices */
47602e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
47612e17dfb7SMatthew G. Knepley   {
47622e17dfb7SMatthew G. Knepley     PetscBool isplex;
47632e17dfb7SMatthew G. Knepley 
47642e17dfb7SMatthew G. Knepley     ierr = PetscObjectTypeCompare((PetscObject) cdm, DMPLEX, &isplex);CHKERRQ(ierr);
47652e17dfb7SMatthew G. Knepley     if (isplex) {
47662e17dfb7SMatthew G. Knepley       ierr = DMPlexGetDepthStratum(cdm, 0, &vStart, &vEnd);CHKERRQ(ierr);
47673e922f36SToby Isaac       ierr = DMPlexGetMaxProjectionHeight(cdm,&maxHeight);CHKERRQ(ierr);
47683e922f36SToby Isaac       ierr = DMGetWorkArray(dm,2*(maxHeight + 1),PETSC_INT,&pStart);CHKERRQ(ierr);
47693e922f36SToby Isaac       pEnd = &pStart[maxHeight + 1];
47703e922f36SToby Isaac       newStart = vStart;
47713e922f36SToby Isaac       newEnd   = vEnd;
47723e922f36SToby Isaac       for (h = 0; h <= maxHeight; h++) {
47733e922f36SToby Isaac         ierr = DMPlexGetHeightStratum(cdm, h, &pStart[h], &pEnd[h]);CHKERRQ(ierr);
47743e922f36SToby Isaac         newStart = PetscMin(newStart,pStart[h]);
47753e922f36SToby Isaac         newEnd   = PetscMax(newEnd,pEnd[h]);
47763e922f36SToby Isaac       }
47772e17dfb7SMatthew G. Knepley     } else SETERRQ(PetscObjectComm((PetscObject) cdm), PETSC_ERR_ARG_WRONG, "Coordinate localization requires a DMPLEX coordinate DM");
47782e17dfb7SMatthew G. Knepley   }
47792e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinatesLocal(dm, &coordinates);CHKERRQ(ierr);
47802e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinateSection(dm, &coordSection);CHKERRQ(ierr);
47813e922f36SToby Isaac   ierr = VecGetBlockSize(coordinates, &bs);CHKERRQ(ierr);
4782e0ae35bbSToby Isaac   ierr = PetscSectionGetChart(coordSection,&sStart,&sEnd);CHKERRQ(ierr);
47833e922f36SToby Isaac 
47842e17dfb7SMatthew G. Knepley   ierr = PetscSectionCreate(PetscObjectComm((PetscObject) dm), &cSection);CHKERRQ(ierr);
47852e17dfb7SMatthew G. Knepley   ierr = PetscSectionSetNumFields(cSection, 1);CHKERRQ(ierr);
47862e17dfb7SMatthew G. Knepley   ierr = PetscSectionGetFieldComponents(coordSection, 0, &Nc);CHKERRQ(ierr);
47872e17dfb7SMatthew G. Knepley   ierr = PetscSectionSetFieldComponents(cSection, 0, Nc);CHKERRQ(ierr);
47883e922f36SToby Isaac   ierr = PetscSectionSetChart(cSection, newStart, newEnd);CHKERRQ(ierr);
47893e922f36SToby Isaac 
47903e922f36SToby Isaac   ierr = DMGetWorkArray(dm, 2 * bs, PETSC_SCALAR, &anchor);CHKERRQ(ierr);
47913e922f36SToby Isaac   localized = &anchor[bs];
47923e922f36SToby Isaac   alreadyLocalized = alreadyLocalizedGlobal = PETSC_TRUE;
47933e922f36SToby Isaac   for (h = 0; h <= maxHeight; h++) {
47943e922f36SToby Isaac     PetscInt cStart = pStart[h], cEnd = pEnd[h], c;
47953e922f36SToby Isaac 
47963e922f36SToby Isaac     for (c = cStart; c < cEnd; ++c) {
47973e922f36SToby Isaac       PetscScalar *cellCoords = NULL;
47983e922f36SToby Isaac       PetscInt     b;
47993e922f36SToby Isaac 
48003e922f36SToby Isaac       if (c < sStart || c >= sEnd) alreadyLocalized = PETSC_FALSE;
48013e922f36SToby Isaac       ierr = DMPlexVecGetClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
48023e922f36SToby Isaac       for (b = 0; b < bs; ++b) anchor[b] = cellCoords[b];
48033e922f36SToby Isaac       for (d = 0; d < dof/bs; ++d) {
48043e922f36SToby Isaac         ierr = DMLocalizeCoordinate_Internal(dm, bs, anchor, &cellCoords[d*bs], localized);CHKERRQ(ierr);
48053e922f36SToby Isaac         for (b = 0; b < bs; b++) {
48063e922f36SToby Isaac           if (cellCoords[d*bs + b] != localized[b]) break;
48073e922f36SToby Isaac         }
48083e922f36SToby Isaac         if (b < bs) break;
48093e922f36SToby Isaac       }
48103e922f36SToby Isaac       if (d < dof/bs) {
48113e922f36SToby Isaac         if (c >= sStart && c < sEnd) {
48123e922f36SToby Isaac           PetscInt cdof;
48133e922f36SToby Isaac 
48143e922f36SToby Isaac           ierr = PetscSectionGetDof(coordSection, c, &cdof);CHKERRQ(ierr);
48153e922f36SToby Isaac           if (cdof != dof) alreadyLocalized = PETSC_FALSE;
48163e922f36SToby Isaac         }
48173e922f36SToby Isaac         ierr = PetscSectionSetDof(cSection, c, dof);CHKERRQ(ierr);
48183e922f36SToby Isaac         ierr = PetscSectionSetFieldDof(cSection, c, 0, dof);CHKERRQ(ierr);
48193e922f36SToby Isaac       }
48203e922f36SToby Isaac       ierr = DMPlexVecRestoreClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
48213e922f36SToby Isaac     }
48223e922f36SToby Isaac   }
48233e922f36SToby Isaac   ierr = MPI_Allreduce(&alreadyLocalized,&alreadyLocalizedGlobal,1,MPIU_BOOL,MPI_LAND,PetscObjectComm((PetscObject)dm));CHKERRQ(ierr);
48243e922f36SToby Isaac   if (alreadyLocalizedGlobal) {
48253e922f36SToby Isaac     ierr = DMRestoreWorkArray(dm, 2 * bs, PETSC_SCALAR, &anchor);CHKERRQ(ierr);
48263e922f36SToby Isaac     ierr = PetscSectionDestroy(&cSection);CHKERRQ(ierr);
48273e922f36SToby Isaac     ierr = DMRestoreWorkArray(dm,2*(maxHeight + 1),PETSC_INT,&pStart);CHKERRQ(ierr);
48283e922f36SToby Isaac     PetscFunctionReturn(0);
48293e922f36SToby Isaac   }
48302e17dfb7SMatthew G. Knepley   for (v = vStart; v < vEnd; ++v) {
48312e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetDof(coordSection, v, &dof);CHKERRQ(ierr);
48322e17dfb7SMatthew G. Knepley     ierr = PetscSectionSetDof(cSection,     v,  dof);CHKERRQ(ierr);
48332e17dfb7SMatthew G. Knepley     ierr = PetscSectionSetFieldDof(cSection, v, 0, dof);CHKERRQ(ierr);
48342e17dfb7SMatthew G. Knepley   }
48352e17dfb7SMatthew G. Knepley   ierr = PetscSectionSetUp(cSection);CHKERRQ(ierr);
48362e17dfb7SMatthew G. Knepley   ierr = PetscSectionGetStorageSize(cSection, &coordSize);CHKERRQ(ierr);
48372e17dfb7SMatthew G. Knepley   ierr = VecCreate(PetscObjectComm((PetscObject) dm), &cVec);CHKERRQ(ierr);
48382e17dfb7SMatthew G. Knepley   ierr = PetscObjectSetName((PetscObject)cVec,"coordinates");CHKERRQ(ierr);
48392e17dfb7SMatthew G. Knepley   ierr = VecSetBlockSize(cVec,         bs);CHKERRQ(ierr);
48402e17dfb7SMatthew G. Knepley   ierr = VecSetSizes(cVec, coordSize, PETSC_DETERMINE);CHKERRQ(ierr);
48412e17dfb7SMatthew G. Knepley   ierr = VecSetType(cVec,VECSTANDARD);CHKERRQ(ierr);
48422e17dfb7SMatthew G. Knepley   ierr = VecGetArray(coordinates, &coords);CHKERRQ(ierr);
48432e17dfb7SMatthew G. Knepley   ierr = VecGetArray(cVec,        &coords2);CHKERRQ(ierr);
48442e17dfb7SMatthew G. Knepley   for (v = vStart; v < vEnd; ++v) {
48452e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetDof(coordSection, v, &dof);CHKERRQ(ierr);
48462e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetOffset(coordSection, v, &off);CHKERRQ(ierr);
48472e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetOffset(cSection,     v, &off2);CHKERRQ(ierr);
48482e17dfb7SMatthew G. Knepley     for (d = 0; d < dof; ++d) coords2[off2+d] = coords[off+d];
48492e17dfb7SMatthew G. Knepley   }
48503e922f36SToby Isaac   for (h = 0; h <= maxHeight; h++) {
48513e922f36SToby Isaac     PetscInt cStart = pStart[h], cEnd = pEnd[h], c;
48523e922f36SToby Isaac 
48532e17dfb7SMatthew G. Knepley     for (c = cStart; c < cEnd; ++c) {
48542e17dfb7SMatthew G. Knepley       PetscScalar *cellCoords = NULL;
48553e922f36SToby Isaac       PetscInt     b, cdof;
48562e17dfb7SMatthew G. Knepley 
48573e922f36SToby Isaac       ierr = PetscSectionGetDof(cSection,c,&cdof);CHKERRQ(ierr);
48583e922f36SToby Isaac       if (!cdof) continue;
48592e17dfb7SMatthew G. Knepley       ierr = DMPlexVecGetClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
48602e17dfb7SMatthew G. Knepley       ierr = PetscSectionGetOffset(cSection, c, &off2);CHKERRQ(ierr);
48612e17dfb7SMatthew G. Knepley       for (b = 0; b < bs; ++b) anchor[b] = cellCoords[b];
48622e17dfb7SMatthew G. Knepley       for (d = 0; d < dof/bs; ++d) {ierr = DMLocalizeCoordinate_Internal(dm, bs, anchor, &cellCoords[d*bs], &coords2[off2+d*bs]);CHKERRQ(ierr);}
48632e17dfb7SMatthew G. Knepley       ierr = DMPlexVecRestoreClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
48642e17dfb7SMatthew G. Knepley     }
48653e922f36SToby Isaac   }
48663e922f36SToby Isaac   ierr = DMRestoreWorkArray(dm, 2 * bs, PETSC_SCALAR, &anchor);CHKERRQ(ierr);
48673e922f36SToby Isaac   ierr = DMRestoreWorkArray(dm,2*(maxHeight + 1),PETSC_INT,&pStart);CHKERRQ(ierr);
48682e17dfb7SMatthew G. Knepley   ierr = VecRestoreArray(coordinates, &coords);CHKERRQ(ierr);
48692e17dfb7SMatthew G. Knepley   ierr = VecRestoreArray(cVec,        &coords2);CHKERRQ(ierr);
48702e17dfb7SMatthew G. Knepley   ierr = DMSetCoordinateSection(dm, PETSC_DETERMINE, cSection);CHKERRQ(ierr);
48712e17dfb7SMatthew G. Knepley   ierr = DMSetCoordinatesLocal(dm, cVec);CHKERRQ(ierr);
48722e17dfb7SMatthew G. Knepley   ierr = VecDestroy(&cVec);CHKERRQ(ierr);
48732e17dfb7SMatthew G. Knepley   ierr = PetscSectionDestroy(&cSection);CHKERRQ(ierr);
48742e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
48752e17dfb7SMatthew G. Knepley }
48762e17dfb7SMatthew G. Knepley 
48772e17dfb7SMatthew G. Knepley #undef __FUNCT__
4878e87bb0d3SMatthew G Knepley #define __FUNCT__ "DMLocatePoints"
4879e87bb0d3SMatthew G Knepley /*@
48803a93e3b7SToby Isaac   DMLocatePoints - Locate the points in v in the mesh and return a PetscSF of the containing cells
4881e87bb0d3SMatthew G Knepley 
48823a93e3b7SToby Isaac   Collective on Vec v (see explanation below)
4883e87bb0d3SMatthew G Knepley 
4884e87bb0d3SMatthew G Knepley   Input Parameters:
4885e87bb0d3SMatthew G Knepley + dm - The DM
48863a93e3b7SToby Isaac . v - The Vec of points
488762a38674SMatthew G. Knepley . ltype - The type of point location, e.g. DM_POINTLOCATION_NONE or DM_POINTLOCATION_NEAREST
48883a93e3b7SToby Isaac - cells - Points to either NULL, or a PetscSF with guesses for which cells contain each point.
4889e87bb0d3SMatthew G Knepley 
489061e3bb9bSMatthew G Knepley   Output Parameter:
489162a38674SMatthew G. Knepley + v - The Vec of points, which now contains the nearest mesh points to the given points if DM_POINTLOCATION_NEAREST is used
489262a38674SMatthew G. Knepley - cells - The PetscSF containing the ranks and local indices of the containing points.
48933a93e3b7SToby Isaac 
4894e87bb0d3SMatthew G Knepley 
4895e87bb0d3SMatthew G Knepley   Level: developer
489661e3bb9bSMatthew G Knepley 
489762a38674SMatthew G. Knepley   Notes:
48983a93e3b7SToby Isaac   To do a search of the local cells of the mesh, v should have PETSC_COMM_SELF as its communicator.
489962a38674SMatthew G. Knepley   To do a search of all the cells in the distributed mesh, v should have the same communicator as dm.
49003a93e3b7SToby Isaac 
49013a93e3b7SToby Isaac   If *cellSF is NULL on input, a PetscSF will be created.
490262a38674SMatthew G. Knepley   If *cellSF is not NULL on input, it should point to an existing PetscSF, whose graph will be used as initial guesses.
49033a93e3b7SToby Isaac 
49043a93e3b7SToby Isaac   An array that maps each point to its containing cell can be obtained with
49053a93e3b7SToby Isaac 
490662a38674SMatthew G. Knepley $    const PetscSFNode *cells;
490762a38674SMatthew G. Knepley $    PetscInt           nFound;
490862a38674SMatthew G. Knepley $    const PetscSFNode *found;
490962a38674SMatthew G. Knepley $
491062a38674SMatthew G. Knepley $    PetscSFGetGraph(cells,NULL,&nFound,&found,&cells);
49113a93e3b7SToby Isaac 
49123a93e3b7SToby Isaac   Where cells[i].rank is the rank of the cell containing point found[i] (or i if found == NULL), and cells[i].index is
49133a93e3b7SToby Isaac   the index of the cell in its rank's local numbering.
49143a93e3b7SToby Isaac 
491561e3bb9bSMatthew G Knepley .keywords: point location, mesh
491662a38674SMatthew G. Knepley .seealso: DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal(), DMPointLocationType
491761e3bb9bSMatthew G Knepley @*/
491862a38674SMatthew G. Knepley PetscErrorCode DMLocatePoints(DM dm, Vec v, DMPointLocationType ltype, PetscSF *cellSF)
4919e87bb0d3SMatthew G Knepley {
4920735aa83eSMatthew G Knepley   PetscErrorCode ierr;
4921735aa83eSMatthew G Knepley 
4922e87bb0d3SMatthew G Knepley   PetscFunctionBegin;
4923e87bb0d3SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
4924e87bb0d3SMatthew G Knepley   PetscValidHeaderSpecific(v,VEC_CLASSID,2);
4925e0fc9d1bSMatthew G. Knepley   PetscValidPointer(cellSF,4);
49263a93e3b7SToby Isaac   if (*cellSF) {
49273a93e3b7SToby Isaac     PetscMPIInt result;
49283a93e3b7SToby Isaac 
4929e0fc9d1bSMatthew G. Knepley     PetscValidHeaderSpecific(*cellSF,PETSCSF_CLASSID,4);
49303a93e3b7SToby Isaac     ierr = MPI_Comm_compare(PetscObjectComm((PetscObject)v),PetscObjectComm((PetscObject)cellSF),&result);CHKERRQ(ierr);
49313a93e3b7SToby Isaac     if (result != MPI_IDENT && result != MPI_CONGRUENT) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_INCOMP,"cellSF must have a communicator congruent to v's");
4932e0fc9d1bSMatthew G. Knepley   } else {
49333a93e3b7SToby Isaac     ierr = PetscSFCreate(PetscObjectComm((PetscObject)v),cellSF);CHKERRQ(ierr);
49343a93e3b7SToby Isaac   }
493547a35634SPatrick Farrell   ierr = PetscLogEventBegin(DM_LocatePoints,dm,0,0,0);CHKERRQ(ierr);
4936735aa83eSMatthew G Knepley   if (dm->ops->locatepoints) {
493762a38674SMatthew G. Knepley     ierr = (*dm->ops->locatepoints)(dm,v,ltype,*cellSF);CHKERRQ(ierr);
493882f516ccSBarry Smith   } else SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Point location not available for this DM");
493947a35634SPatrick Farrell   ierr = PetscLogEventEnd(DM_LocatePoints,dm,0,0,0);CHKERRQ(ierr);
4940e87bb0d3SMatthew G Knepley   PetscFunctionReturn(0);
4941e87bb0d3SMatthew G Knepley }
494214f150ffSMatthew G. Knepley 
494314f150ffSMatthew G. Knepley #undef __FUNCT__
494414f150ffSMatthew G. Knepley #define __FUNCT__ "DMGetOutputDM"
4945f4d763aaSMatthew G. Knepley /*@
4946f4d763aaSMatthew G. Knepley   DMGetOutputDM - Retrieve the DM associated with the layout for output
4947f4d763aaSMatthew G. Knepley 
4948f4d763aaSMatthew G. Knepley   Input Parameter:
4949f4d763aaSMatthew G. Knepley . dm - The original DM
4950f4d763aaSMatthew G. Knepley 
4951f4d763aaSMatthew G. Knepley   Output Parameter:
4952f4d763aaSMatthew G. Knepley . odm - The DM which provides the layout for output
4953f4d763aaSMatthew G. Knepley 
4954f4d763aaSMatthew G. Knepley   Level: intermediate
4955f4d763aaSMatthew G. Knepley 
4956f4d763aaSMatthew G. Knepley .seealso: VecView(), DMGetDefaultGlobalSection()
4957f4d763aaSMatthew G. Knepley @*/
495814f150ffSMatthew G. Knepley PetscErrorCode DMGetOutputDM(DM dm, DM *odm)
495914f150ffSMatthew G. Knepley {
4960c26acbdeSMatthew G. Knepley   PetscSection   section;
49612d4e4a49SMatthew G. Knepley   PetscBool      hasConstraints, ghasConstraints;
496214f150ffSMatthew G. Knepley   PetscErrorCode ierr;
496314f150ffSMatthew G. Knepley 
496414f150ffSMatthew G. Knepley   PetscFunctionBegin;
496514f150ffSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
496614f150ffSMatthew G. Knepley   PetscValidPointer(odm,2);
4967c26acbdeSMatthew G. Knepley   ierr = DMGetDefaultSection(dm, &section);CHKERRQ(ierr);
4968c26acbdeSMatthew G. Knepley   ierr = PetscSectionHasConstraints(section, &hasConstraints);CHKERRQ(ierr);
4969127fe6b9SMatthew G. Knepley   ierr = MPI_Allreduce(&hasConstraints, &ghasConstraints, 1, MPIU_BOOL, MPI_LOR, PetscObjectComm((PetscObject) dm));CHKERRQ(ierr);
49702d4e4a49SMatthew G. Knepley   if (!ghasConstraints) {
4971c26acbdeSMatthew G. Knepley     *odm = dm;
4972c26acbdeSMatthew G. Knepley     PetscFunctionReturn(0);
4973c26acbdeSMatthew G. Knepley   }
497414f150ffSMatthew G. Knepley   if (!dm->dmBC) {
49750305aff6SMatthew G. Knepley     PetscDS      ds;
4976c26acbdeSMatthew G. Knepley     PetscSection newSection, gsection;
497714f150ffSMatthew G. Knepley     PetscSF      sf;
497814f150ffSMatthew G. Knepley 
497914f150ffSMatthew G. Knepley     ierr = DMClone(dm, &dm->dmBC);CHKERRQ(ierr);
49800305aff6SMatthew G. Knepley     ierr = DMGetDS(dm, &ds);CHKERRQ(ierr);
49810305aff6SMatthew G. Knepley     ierr = DMSetDS(dm->dmBC, ds);CHKERRQ(ierr);
498214f150ffSMatthew G. Knepley     ierr = PetscSectionClone(section, &newSection);CHKERRQ(ierr);
498314f150ffSMatthew G. Knepley     ierr = DMSetDefaultSection(dm->dmBC, newSection);CHKERRQ(ierr);
498414f150ffSMatthew G. Knepley     ierr = PetscSectionDestroy(&newSection);CHKERRQ(ierr);
498514f150ffSMatthew G. Knepley     ierr = DMGetPointSF(dm->dmBC, &sf);CHKERRQ(ierr);
498615b58121SMatthew G. Knepley     ierr = PetscSectionCreateGlobalSection(section, sf, PETSC_TRUE, PETSC_FALSE, &gsection);CHKERRQ(ierr);
498714f150ffSMatthew G. Knepley     ierr = DMSetDefaultGlobalSection(dm->dmBC, gsection);CHKERRQ(ierr);
498814f150ffSMatthew G. Knepley     ierr = PetscSectionDestroy(&gsection);CHKERRQ(ierr);
498914f150ffSMatthew G. Knepley   }
499014f150ffSMatthew G. Knepley   *odm = dm->dmBC;
499114f150ffSMatthew G. Knepley   PetscFunctionReturn(0);
499214f150ffSMatthew G. Knepley }
4993f4d763aaSMatthew G. Knepley 
4994f4d763aaSMatthew G. Knepley #undef __FUNCT__
4995f4d763aaSMatthew G. Knepley #define __FUNCT__ "DMGetOutputSequenceNumber"
4996f4d763aaSMatthew G. Knepley /*@
4997cdb7a50dSMatthew G. Knepley   DMGetOutputSequenceNumber - Retrieve the sequence number/value for output
4998f4d763aaSMatthew G. Knepley 
4999f4d763aaSMatthew G. Knepley   Input Parameter:
5000f4d763aaSMatthew G. Knepley . dm - The original DM
5001f4d763aaSMatthew G. Knepley 
5002cdb7a50dSMatthew G. Knepley   Output Parameters:
5003cdb7a50dSMatthew G. Knepley + num - The output sequence number
5004cdb7a50dSMatthew G. Knepley - val - The output sequence value
5005f4d763aaSMatthew G. Knepley 
5006f4d763aaSMatthew G. Knepley   Level: intermediate
5007f4d763aaSMatthew G. Knepley 
5008f4d763aaSMatthew G. Knepley   Note: This is intended for output that should appear in sequence, for instance
5009f4d763aaSMatthew G. Knepley   a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system.
5010f4d763aaSMatthew G. Knepley 
5011f4d763aaSMatthew G. Knepley .seealso: VecView()
5012f4d763aaSMatthew G. Knepley @*/
5013cdb7a50dSMatthew G. Knepley PetscErrorCode DMGetOutputSequenceNumber(DM dm, PetscInt *num, PetscReal *val)
5014f4d763aaSMatthew G. Knepley {
5015f4d763aaSMatthew G. Knepley   PetscFunctionBegin;
5016f4d763aaSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
5017cdb7a50dSMatthew G. Knepley   if (num) {PetscValidPointer(num,2); *num = dm->outputSequenceNum;}
5018cdb7a50dSMatthew G. Knepley   if (val) {PetscValidPointer(val,3);*val = dm->outputSequenceVal;}
5019f4d763aaSMatthew G. Knepley   PetscFunctionReturn(0);
5020f4d763aaSMatthew G. Knepley }
5021f4d763aaSMatthew G. Knepley 
5022f4d763aaSMatthew G. Knepley #undef __FUNCT__
5023f4d763aaSMatthew G. Knepley #define __FUNCT__ "DMSetOutputSequenceNumber"
5024f4d763aaSMatthew G. Knepley /*@
5025cdb7a50dSMatthew G. Knepley   DMSetOutputSequenceNumber - Set the sequence number/value for output
5026f4d763aaSMatthew G. Knepley 
5027f4d763aaSMatthew G. Knepley   Input Parameters:
5028f4d763aaSMatthew G. Knepley + dm - The original DM
5029cdb7a50dSMatthew G. Knepley . num - The output sequence number
5030cdb7a50dSMatthew G. Knepley - val - The output sequence value
5031f4d763aaSMatthew G. Knepley 
5032f4d763aaSMatthew G. Knepley   Level: intermediate
5033f4d763aaSMatthew G. Knepley 
5034f4d763aaSMatthew G. Knepley   Note: This is intended for output that should appear in sequence, for instance
5035f4d763aaSMatthew G. Knepley   a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system.
5036f4d763aaSMatthew G. Knepley 
5037f4d763aaSMatthew G. Knepley .seealso: VecView()
5038f4d763aaSMatthew G. Knepley @*/
5039cdb7a50dSMatthew G. Knepley PetscErrorCode DMSetOutputSequenceNumber(DM dm, PetscInt num, PetscReal val)
5040f4d763aaSMatthew G. Knepley {
5041f4d763aaSMatthew G. Knepley   PetscFunctionBegin;
5042f4d763aaSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
5043f4d763aaSMatthew G. Knepley   dm->outputSequenceNum = num;
5044cdb7a50dSMatthew G. Knepley   dm->outputSequenceVal = val;
5045cdb7a50dSMatthew G. Knepley   PetscFunctionReturn(0);
5046cdb7a50dSMatthew G. Knepley }
5047cdb7a50dSMatthew G. Knepley 
5048cdb7a50dSMatthew G. Knepley #undef __FUNCT__
5049cdb7a50dSMatthew G. Knepley #define __FUNCT__ "DMOutputSequenceLoad"
5050cdb7a50dSMatthew G. Knepley /*@C
5051cdb7a50dSMatthew G. Knepley   DMOutputSequenceLoad - Retrieve the sequence value from a Viewer
5052cdb7a50dSMatthew G. Knepley 
5053cdb7a50dSMatthew G. Knepley   Input Parameters:
5054cdb7a50dSMatthew G. Knepley + dm   - The original DM
5055cdb7a50dSMatthew G. Knepley . name - The sequence name
5056cdb7a50dSMatthew G. Knepley - num  - The output sequence number
5057cdb7a50dSMatthew G. Knepley 
5058cdb7a50dSMatthew G. Knepley   Output Parameter:
5059cdb7a50dSMatthew G. Knepley . val  - The output sequence value
5060cdb7a50dSMatthew G. Knepley 
5061cdb7a50dSMatthew G. Knepley   Level: intermediate
5062cdb7a50dSMatthew G. Knepley 
5063cdb7a50dSMatthew G. Knepley   Note: This is intended for output that should appear in sequence, for instance
5064cdb7a50dSMatthew G. Knepley   a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system.
5065cdb7a50dSMatthew G. Knepley 
5066cdb7a50dSMatthew G. Knepley .seealso: DMGetOutputSequenceNumber(), DMSetOutputSequenceNumber(), VecView()
5067cdb7a50dSMatthew G. Knepley @*/
5068cdb7a50dSMatthew G. Knepley PetscErrorCode DMOutputSequenceLoad(DM dm, PetscViewer viewer, const char *name, PetscInt num, PetscReal *val)
5069cdb7a50dSMatthew G. Knepley {
5070cdb7a50dSMatthew G. Knepley   PetscBool      ishdf5;
5071cdb7a50dSMatthew G. Knepley   PetscErrorCode ierr;
5072cdb7a50dSMatthew G. Knepley 
5073cdb7a50dSMatthew G. Knepley   PetscFunctionBegin;
5074cdb7a50dSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
5075cdb7a50dSMatthew G. Knepley   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
5076cdb7a50dSMatthew G. Knepley   PetscValidPointer(val,4);
5077cdb7a50dSMatthew G. Knepley   ierr = PetscObjectTypeCompare((PetscObject) viewer, PETSCVIEWERHDF5, &ishdf5);CHKERRQ(ierr);
5078cdb7a50dSMatthew G. Knepley   if (ishdf5) {
5079cdb7a50dSMatthew G. Knepley #if defined(PETSC_HAVE_HDF5)
5080cdb7a50dSMatthew G. Knepley     PetscScalar value;
5081cdb7a50dSMatthew G. Knepley 
5082cdb7a50dSMatthew G. Knepley     ierr = DMSequenceLoad_HDF5(dm, name, num, &value, viewer);CHKERRQ(ierr);
50834aeb217fSMatthew G. Knepley     *val = PetscRealPart(value);
5084cdb7a50dSMatthew G. Knepley #endif
5085cdb7a50dSMatthew G. Knepley   } else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Invalid viewer; open viewer with PetscViewerHDF5Open()");
5086f4d763aaSMatthew G. Knepley   PetscFunctionReturn(0);
5087f4d763aaSMatthew G. Knepley }
50888e4ac7eaSMatthew G. Knepley 
50898e4ac7eaSMatthew G. Knepley #undef __FUNCT__
50908e4ac7eaSMatthew G. Knepley #define __FUNCT__ "DMGetUseNatural"
50918e4ac7eaSMatthew G. Knepley /*@
50928e4ac7eaSMatthew G. Knepley   DMGetUseNatural - Get the flag for creating a mapping to the natural order on distribution
50938e4ac7eaSMatthew G. Knepley 
50948e4ac7eaSMatthew G. Knepley   Not collective
50958e4ac7eaSMatthew G. Knepley 
50968e4ac7eaSMatthew G. Knepley   Input Parameter:
50978e4ac7eaSMatthew G. Knepley . dm - The DM
50988e4ac7eaSMatthew G. Knepley 
50998e4ac7eaSMatthew G. Knepley   Output Parameter:
51008e4ac7eaSMatthew G. Knepley . useNatural - The flag to build the mapping to a natural order during distribution
51018e4ac7eaSMatthew G. Knepley 
51028e4ac7eaSMatthew G. Knepley   Level: beginner
51038e4ac7eaSMatthew G. Knepley 
51048e4ac7eaSMatthew G. Knepley .seealso: DMSetUseNatural(), DMCreate()
51058e4ac7eaSMatthew G. Knepley @*/
51068e4ac7eaSMatthew G. Knepley PetscErrorCode DMGetUseNatural(DM dm, PetscBool *useNatural)
51078e4ac7eaSMatthew G. Knepley {
51088e4ac7eaSMatthew G. Knepley   PetscFunctionBegin;
51098e4ac7eaSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
51108e4ac7eaSMatthew G. Knepley   PetscValidPointer(useNatural, 2);
51118e4ac7eaSMatthew G. Knepley   *useNatural = dm->useNatural;
51128e4ac7eaSMatthew G. Knepley   PetscFunctionReturn(0);
51138e4ac7eaSMatthew G. Knepley }
51148e4ac7eaSMatthew G. Knepley 
51158e4ac7eaSMatthew G. Knepley #undef __FUNCT__
51168e4ac7eaSMatthew G. Knepley #define __FUNCT__ "DMSetUseNatural"
51178e4ac7eaSMatthew G. Knepley /*@
51188e4ac7eaSMatthew G. Knepley   DMSetUseNatural - Set the flag for creating a mapping to the natural order on distribution
51198e4ac7eaSMatthew G. Knepley 
51208e4ac7eaSMatthew G. Knepley   Collective on dm
51218e4ac7eaSMatthew G. Knepley 
51228e4ac7eaSMatthew G. Knepley   Input Parameters:
51238e4ac7eaSMatthew G. Knepley + dm - The DM
51248e4ac7eaSMatthew G. Knepley - useNatural - The flag to build the mapping to a natural order during distribution
51258e4ac7eaSMatthew G. Knepley 
51268e4ac7eaSMatthew G. Knepley   Level: beginner
51278e4ac7eaSMatthew G. Knepley 
51288e4ac7eaSMatthew G. Knepley .seealso: DMGetUseNatural(), DMCreate()
51298e4ac7eaSMatthew G. Knepley @*/
51308e4ac7eaSMatthew G. Knepley PetscErrorCode DMSetUseNatural(DM dm, PetscBool useNatural)
51318e4ac7eaSMatthew G. Knepley {
51328e4ac7eaSMatthew G. Knepley   PetscFunctionBegin;
51338e4ac7eaSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
51348e4ac7eaSMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, useNatural, 2);
51358e4ac7eaSMatthew G. Knepley   dm->useNatural = useNatural;
51368e4ac7eaSMatthew G. Knepley   PetscFunctionReturn(0);
51378e4ac7eaSMatthew G. Knepley }
5138c58f1c22SToby Isaac 
5139c58f1c22SToby Isaac #undef __FUNCT__
5140c58f1c22SToby Isaac #define __FUNCT__
5141c58f1c22SToby Isaac 
5142c58f1c22SToby Isaac #undef __FUNCT__
5143c58f1c22SToby Isaac #define __FUNCT__ "DMCreateLabel"
5144c58f1c22SToby Isaac /*@C
5145c58f1c22SToby Isaac   DMCreateLabel - Create a label of the given name if it does not already exist
5146c58f1c22SToby Isaac 
5147c58f1c22SToby Isaac   Not Collective
5148c58f1c22SToby Isaac 
5149c58f1c22SToby Isaac   Input Parameters:
5150c58f1c22SToby Isaac + dm   - The DM object
5151c58f1c22SToby Isaac - name - The label name
5152c58f1c22SToby Isaac 
5153c58f1c22SToby Isaac   Level: intermediate
5154c58f1c22SToby Isaac 
5155c58f1c22SToby Isaac .keywords: mesh
5156c58f1c22SToby Isaac .seealso: DMLabelCreate(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
5157c58f1c22SToby Isaac @*/
5158c58f1c22SToby Isaac PetscErrorCode DMCreateLabel(DM dm, const char name[])
5159c58f1c22SToby Isaac {
5160c58f1c22SToby Isaac   DMLabelLink    next  = dm->labels->next;
5161c58f1c22SToby Isaac   PetscBool      flg   = PETSC_FALSE;
5162c58f1c22SToby Isaac   PetscErrorCode ierr;
5163c58f1c22SToby Isaac 
5164c58f1c22SToby Isaac   PetscFunctionBegin;
5165c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5166c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
5167c58f1c22SToby Isaac   while (next) {
5168c58f1c22SToby Isaac     ierr = PetscStrcmp(name, next->label->name, &flg);CHKERRQ(ierr);
5169c58f1c22SToby Isaac     if (flg) break;
5170c58f1c22SToby Isaac     next = next->next;
5171c58f1c22SToby Isaac   }
5172c58f1c22SToby Isaac   if (!flg) {
5173c58f1c22SToby Isaac     DMLabelLink tmpLabel;
5174c58f1c22SToby Isaac 
5175c58f1c22SToby Isaac     ierr = PetscCalloc1(1, &tmpLabel);CHKERRQ(ierr);
5176c58f1c22SToby Isaac     ierr = DMLabelCreate(name, &tmpLabel->label);CHKERRQ(ierr);
5177c58f1c22SToby Isaac     tmpLabel->output = PETSC_TRUE;
5178c58f1c22SToby Isaac     tmpLabel->next   = dm->labels->next;
5179c58f1c22SToby Isaac     dm->labels->next = tmpLabel;
5180c58f1c22SToby Isaac   }
5181c58f1c22SToby Isaac   PetscFunctionReturn(0);
5182c58f1c22SToby Isaac }
5183c58f1c22SToby Isaac 
5184c58f1c22SToby Isaac #undef __FUNCT__
5185c58f1c22SToby Isaac #define __FUNCT__ "DMGetLabelValue"
5186c58f1c22SToby Isaac /*@C
5187c58f1c22SToby Isaac   DMGetLabelValue - Get the value in a Sieve Label for the given point, with 0 as the default
5188c58f1c22SToby Isaac 
5189c58f1c22SToby Isaac   Not Collective
5190c58f1c22SToby Isaac 
5191c58f1c22SToby Isaac   Input Parameters:
5192c58f1c22SToby Isaac + dm   - The DM object
5193c58f1c22SToby Isaac . name - The label name
5194c58f1c22SToby Isaac - point - The mesh point
5195c58f1c22SToby Isaac 
5196c58f1c22SToby Isaac   Output Parameter:
5197c58f1c22SToby Isaac . value - The label value for this point, or -1 if the point is not in the label
5198c58f1c22SToby Isaac 
5199c58f1c22SToby Isaac   Level: beginner
5200c58f1c22SToby Isaac 
5201c58f1c22SToby Isaac .keywords: mesh
5202c58f1c22SToby Isaac .seealso: DMLabelGetValue(), DMSetLabelValue(), DMGetStratumIS()
5203c58f1c22SToby Isaac @*/
5204c58f1c22SToby Isaac PetscErrorCode DMGetLabelValue(DM dm, const char name[], PetscInt point, PetscInt *value)
5205c58f1c22SToby Isaac {
5206c58f1c22SToby Isaac   DMLabel        label;
5207c58f1c22SToby Isaac   PetscErrorCode ierr;
5208c58f1c22SToby Isaac 
5209c58f1c22SToby Isaac   PetscFunctionBegin;
5210c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5211c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
5212c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
5213c58f1c22SToby Isaac   if (!label) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "No label named %s was found", name);CHKERRQ(ierr);
5214c58f1c22SToby Isaac   ierr = DMLabelGetValue(label, point, value);CHKERRQ(ierr);
5215c58f1c22SToby Isaac   PetscFunctionReturn(0);
5216c58f1c22SToby Isaac }
5217c58f1c22SToby Isaac 
5218c58f1c22SToby Isaac #undef __FUNCT__
5219c58f1c22SToby Isaac #define __FUNCT__ "DMSetLabelValue"
5220c58f1c22SToby Isaac /*@C
5221c58f1c22SToby Isaac   DMSetLabelValue - Add a point to a Sieve Label with given value
5222c58f1c22SToby Isaac 
5223c58f1c22SToby Isaac   Not Collective
5224c58f1c22SToby Isaac 
5225c58f1c22SToby Isaac   Input Parameters:
5226c58f1c22SToby Isaac + dm   - The DM object
5227c58f1c22SToby Isaac . name - The label name
5228c58f1c22SToby Isaac . point - The mesh point
5229c58f1c22SToby Isaac - value - The label value for this point
5230c58f1c22SToby Isaac 
5231c58f1c22SToby Isaac   Output Parameter:
5232c58f1c22SToby Isaac 
5233c58f1c22SToby Isaac   Level: beginner
5234c58f1c22SToby Isaac 
5235c58f1c22SToby Isaac .keywords: mesh
5236c58f1c22SToby Isaac .seealso: DMLabelSetValue(), DMGetStratumIS(), DMClearLabelValue()
5237c58f1c22SToby Isaac @*/
5238c58f1c22SToby Isaac PetscErrorCode DMSetLabelValue(DM dm, const char name[], PetscInt point, PetscInt value)
5239c58f1c22SToby Isaac {
5240c58f1c22SToby Isaac   DMLabel        label;
5241c58f1c22SToby Isaac   PetscErrorCode ierr;
5242c58f1c22SToby Isaac 
5243c58f1c22SToby Isaac   PetscFunctionBegin;
5244c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5245c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
5246c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
5247c58f1c22SToby Isaac   if (!label) {
5248c58f1c22SToby Isaac     ierr = DMCreateLabel(dm, name);CHKERRQ(ierr);
5249c58f1c22SToby Isaac     ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
5250c58f1c22SToby Isaac   }
5251c58f1c22SToby Isaac   ierr = DMLabelSetValue(label, point, value);CHKERRQ(ierr);
5252c58f1c22SToby Isaac   PetscFunctionReturn(0);
5253c58f1c22SToby Isaac }
5254c58f1c22SToby Isaac 
5255c58f1c22SToby Isaac #undef __FUNCT__
5256c58f1c22SToby Isaac #define __FUNCT__ "DMClearLabelValue"
5257c58f1c22SToby Isaac /*@C
5258c58f1c22SToby Isaac   DMClearLabelValue - Remove a point from a Sieve Label with given value
5259c58f1c22SToby Isaac 
5260c58f1c22SToby Isaac   Not Collective
5261c58f1c22SToby Isaac 
5262c58f1c22SToby Isaac   Input Parameters:
5263c58f1c22SToby Isaac + dm   - The DM object
5264c58f1c22SToby Isaac . name - The label name
5265c58f1c22SToby Isaac . point - The mesh point
5266c58f1c22SToby Isaac - value - The label value for this point
5267c58f1c22SToby Isaac 
5268c58f1c22SToby Isaac   Output Parameter:
5269c58f1c22SToby Isaac 
5270c58f1c22SToby Isaac   Level: beginner
5271c58f1c22SToby Isaac 
5272c58f1c22SToby Isaac .keywords: mesh
5273c58f1c22SToby Isaac .seealso: DMLabelClearValue(), DMSetLabelValue(), DMGetStratumIS()
5274c58f1c22SToby Isaac @*/
5275c58f1c22SToby Isaac PetscErrorCode DMClearLabelValue(DM dm, const char name[], PetscInt point, PetscInt value)
5276c58f1c22SToby Isaac {
5277c58f1c22SToby Isaac   DMLabel        label;
5278c58f1c22SToby Isaac   PetscErrorCode ierr;
5279c58f1c22SToby Isaac 
5280c58f1c22SToby Isaac   PetscFunctionBegin;
5281c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5282c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
5283c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
5284c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
5285c58f1c22SToby Isaac   ierr = DMLabelClearValue(label, point, value);CHKERRQ(ierr);
5286c58f1c22SToby Isaac   PetscFunctionReturn(0);
5287c58f1c22SToby Isaac }
5288c58f1c22SToby Isaac 
5289c58f1c22SToby Isaac #undef __FUNCT__
5290c58f1c22SToby Isaac #define __FUNCT__ "DMGetLabelSize"
5291c58f1c22SToby Isaac /*@C
5292c58f1c22SToby Isaac   DMGetLabelSize - Get the number of different integer ids in a Label
5293c58f1c22SToby Isaac 
5294c58f1c22SToby Isaac   Not Collective
5295c58f1c22SToby Isaac 
5296c58f1c22SToby Isaac   Input Parameters:
5297c58f1c22SToby Isaac + dm   - The DM object
5298c58f1c22SToby Isaac - name - The label name
5299c58f1c22SToby Isaac 
5300c58f1c22SToby Isaac   Output Parameter:
5301c58f1c22SToby Isaac . size - The number of different integer ids, or 0 if the label does not exist
5302c58f1c22SToby Isaac 
5303c58f1c22SToby Isaac   Level: beginner
5304c58f1c22SToby Isaac 
5305c58f1c22SToby Isaac .keywords: mesh
5306c58f1c22SToby Isaac .seealso: DMLabeGetNumValues(), DMSetLabelValue()
5307c58f1c22SToby Isaac @*/
5308c58f1c22SToby Isaac PetscErrorCode DMGetLabelSize(DM dm, const char name[], PetscInt *size)
5309c58f1c22SToby Isaac {
5310c58f1c22SToby Isaac   DMLabel        label;
5311c58f1c22SToby Isaac   PetscErrorCode ierr;
5312c58f1c22SToby Isaac 
5313c58f1c22SToby Isaac   PetscFunctionBegin;
5314c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5315c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
5316c58f1c22SToby Isaac   PetscValidPointer(size, 3);
5317c58f1c22SToby Isaac   ierr  = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
5318c58f1c22SToby Isaac   *size = 0;
5319c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
5320c58f1c22SToby Isaac   ierr = DMLabelGetNumValues(label, size);CHKERRQ(ierr);
5321c58f1c22SToby Isaac   PetscFunctionReturn(0);
5322c58f1c22SToby Isaac }
5323c58f1c22SToby Isaac 
5324c58f1c22SToby Isaac #undef __FUNCT__
5325c58f1c22SToby Isaac #define __FUNCT__ "DMGetLabelIdIS"
5326c58f1c22SToby Isaac /*@C
5327c58f1c22SToby Isaac   DMGetLabelIdIS - Get the integer ids in a label
5328c58f1c22SToby Isaac 
5329c58f1c22SToby Isaac   Not Collective
5330c58f1c22SToby Isaac 
5331c58f1c22SToby Isaac   Input Parameters:
5332c58f1c22SToby Isaac + mesh - The DM object
5333c58f1c22SToby Isaac - name - The label name
5334c58f1c22SToby Isaac 
5335c58f1c22SToby Isaac   Output Parameter:
5336c58f1c22SToby Isaac . ids - The integer ids, or NULL if the label does not exist
5337c58f1c22SToby Isaac 
5338c58f1c22SToby Isaac   Level: beginner
5339c58f1c22SToby Isaac 
5340c58f1c22SToby Isaac .keywords: mesh
5341c58f1c22SToby Isaac .seealso: DMLabelGetValueIS(), DMGetLabelSize()
5342c58f1c22SToby Isaac @*/
5343c58f1c22SToby Isaac PetscErrorCode DMGetLabelIdIS(DM dm, const char name[], IS *ids)
5344c58f1c22SToby Isaac {
5345c58f1c22SToby Isaac   DMLabel        label;
5346c58f1c22SToby Isaac   PetscErrorCode ierr;
5347c58f1c22SToby Isaac 
5348c58f1c22SToby Isaac   PetscFunctionBegin;
5349c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5350c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
5351c58f1c22SToby Isaac   PetscValidPointer(ids, 3);
5352c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
5353c58f1c22SToby Isaac   *ids = NULL;
5354c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
5355c58f1c22SToby Isaac   ierr = DMLabelGetValueIS(label, ids);CHKERRQ(ierr);
5356c58f1c22SToby Isaac   PetscFunctionReturn(0);
5357c58f1c22SToby Isaac }
5358c58f1c22SToby Isaac 
5359c58f1c22SToby Isaac #undef __FUNCT__
5360c58f1c22SToby Isaac #define __FUNCT__ "DMGetStratumSize"
5361c58f1c22SToby Isaac /*@C
5362c58f1c22SToby Isaac   DMGetStratumSize - Get the number of points in a label stratum
5363c58f1c22SToby Isaac 
5364c58f1c22SToby Isaac   Not Collective
5365c58f1c22SToby Isaac 
5366c58f1c22SToby Isaac   Input Parameters:
5367c58f1c22SToby Isaac + dm - The DM object
5368c58f1c22SToby Isaac . name - The label name
5369c58f1c22SToby Isaac - value - The stratum value
5370c58f1c22SToby Isaac 
5371c58f1c22SToby Isaac   Output Parameter:
5372c58f1c22SToby Isaac . size - The stratum size
5373c58f1c22SToby Isaac 
5374c58f1c22SToby Isaac   Level: beginner
5375c58f1c22SToby Isaac 
5376c58f1c22SToby Isaac .keywords: mesh
5377c58f1c22SToby Isaac .seealso: DMLabelGetStratumSize(), DMGetLabelSize(), DMGetLabelIds()
5378c58f1c22SToby Isaac @*/
5379c58f1c22SToby Isaac PetscErrorCode DMGetStratumSize(DM dm, const char name[], PetscInt value, PetscInt *size)
5380c58f1c22SToby Isaac {
5381c58f1c22SToby Isaac   DMLabel        label;
5382c58f1c22SToby Isaac   PetscErrorCode ierr;
5383c58f1c22SToby Isaac 
5384c58f1c22SToby Isaac   PetscFunctionBegin;
5385c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5386c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
5387c58f1c22SToby Isaac   PetscValidPointer(size, 4);
5388c58f1c22SToby Isaac   ierr  = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
5389c58f1c22SToby Isaac   *size = 0;
5390c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
5391c58f1c22SToby Isaac   ierr = DMLabelGetStratumSize(label, value, size);CHKERRQ(ierr);
5392c58f1c22SToby Isaac   PetscFunctionReturn(0);
5393c58f1c22SToby Isaac }
5394c58f1c22SToby Isaac 
5395c58f1c22SToby Isaac #undef __FUNCT__
5396c58f1c22SToby Isaac #define __FUNCT__ "DMGetStratumIS"
5397c58f1c22SToby Isaac /*@C
5398c58f1c22SToby Isaac   DMGetStratumIS - Get the points in a label stratum
5399c58f1c22SToby Isaac 
5400c58f1c22SToby Isaac   Not Collective
5401c58f1c22SToby Isaac 
5402c58f1c22SToby Isaac   Input Parameters:
5403c58f1c22SToby Isaac + dm - The DM object
5404c58f1c22SToby Isaac . name - The label name
5405c58f1c22SToby Isaac - value - The stratum value
5406c58f1c22SToby Isaac 
5407c58f1c22SToby Isaac   Output Parameter:
5408c58f1c22SToby Isaac . points - The stratum points, or NULL if the label does not exist or does not have that value
5409c58f1c22SToby Isaac 
5410c58f1c22SToby Isaac   Level: beginner
5411c58f1c22SToby Isaac 
5412c58f1c22SToby Isaac .keywords: mesh
5413c58f1c22SToby Isaac .seealso: DMLabelGetStratumIS(), DMGetStratumSize()
5414c58f1c22SToby Isaac @*/
5415c58f1c22SToby Isaac PetscErrorCode DMGetStratumIS(DM dm, const char name[], PetscInt value, IS *points)
5416c58f1c22SToby Isaac {
5417c58f1c22SToby Isaac   DMLabel        label;
5418c58f1c22SToby Isaac   PetscErrorCode ierr;
5419c58f1c22SToby Isaac 
5420c58f1c22SToby Isaac   PetscFunctionBegin;
5421c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5422c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
5423c58f1c22SToby Isaac   PetscValidPointer(points, 4);
5424c58f1c22SToby Isaac   ierr    = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
5425c58f1c22SToby Isaac   *points = NULL;
5426c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
5427c58f1c22SToby Isaac   ierr = DMLabelGetStratumIS(label, value, points);CHKERRQ(ierr);
5428c58f1c22SToby Isaac   PetscFunctionReturn(0);
5429c58f1c22SToby Isaac }
5430c58f1c22SToby Isaac 
5431c58f1c22SToby Isaac #undef __FUNCT__
54324de306b1SToby Isaac #define __FUNCT__ "DMSetStratumIS"
54334de306b1SToby Isaac /*@C
54344de306b1SToby Isaac   DMGetStratumIS - Set the points in a label stratum
54354de306b1SToby Isaac 
54364de306b1SToby Isaac   Not Collective
54374de306b1SToby Isaac 
54384de306b1SToby Isaac   Input Parameters:
54394de306b1SToby Isaac + dm - The DM object
54404de306b1SToby Isaac . name - The label name
54414de306b1SToby Isaac . value - The stratum value
54424de306b1SToby Isaac - points - The stratum points
54434de306b1SToby Isaac 
54444de306b1SToby Isaac   Level: beginner
54454de306b1SToby Isaac 
54464de306b1SToby Isaac .keywords: mesh
54474de306b1SToby Isaac .seealso: DMLabelSetStratumIS(), DMGetStratumSize()
54484de306b1SToby Isaac @*/
54494de306b1SToby Isaac PetscErrorCode DMSetStratumIS(DM dm, const char name[], PetscInt value, IS points)
54504de306b1SToby Isaac {
54514de306b1SToby Isaac   DMLabel        label;
54524de306b1SToby Isaac   PetscErrorCode ierr;
54534de306b1SToby Isaac 
54544de306b1SToby Isaac   PetscFunctionBegin;
54554de306b1SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
54564de306b1SToby Isaac   PetscValidCharPointer(name, 2);
54574de306b1SToby Isaac   PetscValidPointer(points, 4);
54584de306b1SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
54594de306b1SToby Isaac   if (!label) PetscFunctionReturn(0);
54604de306b1SToby Isaac   ierr = DMLabelSetStratumIS(label, value, points);CHKERRQ(ierr);
54614de306b1SToby Isaac   PetscFunctionReturn(0);
54624de306b1SToby Isaac }
54634de306b1SToby Isaac 
54644de306b1SToby Isaac #undef __FUNCT__
5465c58f1c22SToby Isaac #define __FUNCT__ "DMClearLabelStratum"
5466c58f1c22SToby Isaac /*@C
5467c58f1c22SToby Isaac   DMClearLabelStratum - Remove all points from a stratum from a Sieve Label
5468c58f1c22SToby Isaac 
5469c58f1c22SToby Isaac   Not Collective
5470c58f1c22SToby Isaac 
5471c58f1c22SToby Isaac   Input Parameters:
5472c58f1c22SToby Isaac + dm   - The DM object
5473c58f1c22SToby Isaac . name - The label name
5474c58f1c22SToby Isaac - value - The label value for this point
5475c58f1c22SToby Isaac 
5476c58f1c22SToby Isaac   Output Parameter:
5477c58f1c22SToby Isaac 
5478c58f1c22SToby Isaac   Level: beginner
5479c58f1c22SToby Isaac 
5480c58f1c22SToby Isaac .keywords: mesh
5481c58f1c22SToby Isaac .seealso: DMLabelClearStratum(), DMSetLabelValue(), DMGetStratumIS(), DMClearLabelValue()
5482c58f1c22SToby Isaac @*/
5483c58f1c22SToby Isaac PetscErrorCode DMClearLabelStratum(DM dm, const char name[], PetscInt value)
5484c58f1c22SToby Isaac {
5485c58f1c22SToby Isaac   DMLabel        label;
5486c58f1c22SToby Isaac   PetscErrorCode ierr;
5487c58f1c22SToby Isaac 
5488c58f1c22SToby Isaac   PetscFunctionBegin;
5489c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5490c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
5491c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
5492c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
5493c58f1c22SToby Isaac   ierr = DMLabelClearStratum(label, value);CHKERRQ(ierr);
5494c58f1c22SToby Isaac   PetscFunctionReturn(0);
5495c58f1c22SToby Isaac }
5496c58f1c22SToby Isaac 
5497c58f1c22SToby Isaac #undef __FUNCT__
5498c58f1c22SToby Isaac #define __FUNCT__ "DMGetNumLabels"
5499c58f1c22SToby Isaac /*@
5500c58f1c22SToby Isaac   DMGetNumLabels - Return the number of labels defined by the mesh
5501c58f1c22SToby Isaac 
5502c58f1c22SToby Isaac   Not Collective
5503c58f1c22SToby Isaac 
5504c58f1c22SToby Isaac   Input Parameter:
5505c58f1c22SToby Isaac . dm   - The DM object
5506c58f1c22SToby Isaac 
5507c58f1c22SToby Isaac   Output Parameter:
5508c58f1c22SToby Isaac . numLabels - the number of Labels
5509c58f1c22SToby Isaac 
5510c58f1c22SToby Isaac   Level: intermediate
5511c58f1c22SToby Isaac 
5512c58f1c22SToby Isaac .keywords: mesh
5513c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
5514c58f1c22SToby Isaac @*/
5515c58f1c22SToby Isaac PetscErrorCode DMGetNumLabels(DM dm, PetscInt *numLabels)
5516c58f1c22SToby Isaac {
5517c58f1c22SToby Isaac   DMLabelLink next = dm->labels->next;
5518c58f1c22SToby Isaac   PetscInt  n    = 0;
5519c58f1c22SToby Isaac 
5520c58f1c22SToby Isaac   PetscFunctionBegin;
5521c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5522c58f1c22SToby Isaac   PetscValidPointer(numLabels, 2);
5523c58f1c22SToby Isaac   while (next) {++n; next = next->next;}
5524c58f1c22SToby Isaac   *numLabels = n;
5525c58f1c22SToby Isaac   PetscFunctionReturn(0);
5526c58f1c22SToby Isaac }
5527c58f1c22SToby Isaac 
5528c58f1c22SToby Isaac #undef __FUNCT__
5529c58f1c22SToby Isaac #define __FUNCT__ "DMGetLabelName"
5530c58f1c22SToby Isaac /*@C
5531c58f1c22SToby Isaac   DMGetLabelName - Return the name of nth label
5532c58f1c22SToby Isaac 
5533c58f1c22SToby Isaac   Not Collective
5534c58f1c22SToby Isaac 
5535c58f1c22SToby Isaac   Input Parameters:
5536c58f1c22SToby Isaac + dm - The DM object
5537c58f1c22SToby Isaac - n  - the label number
5538c58f1c22SToby Isaac 
5539c58f1c22SToby Isaac   Output Parameter:
5540c58f1c22SToby Isaac . name - the label name
5541c58f1c22SToby Isaac 
5542c58f1c22SToby Isaac   Level: intermediate
5543c58f1c22SToby Isaac 
5544c58f1c22SToby Isaac .keywords: mesh
5545c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
5546c58f1c22SToby Isaac @*/
5547c58f1c22SToby Isaac PetscErrorCode DMGetLabelName(DM dm, PetscInt n, const char **name)
5548c58f1c22SToby Isaac {
5549c58f1c22SToby Isaac   DMLabelLink next = dm->labels->next;
5550c58f1c22SToby Isaac   PetscInt  l    = 0;
5551c58f1c22SToby Isaac 
5552c58f1c22SToby Isaac   PetscFunctionBegin;
5553c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5554c58f1c22SToby Isaac   PetscValidPointer(name, 3);
5555c58f1c22SToby Isaac   while (next) {
5556c58f1c22SToby Isaac     if (l == n) {
5557c58f1c22SToby Isaac       *name = next->label->name;
5558c58f1c22SToby Isaac       PetscFunctionReturn(0);
5559c58f1c22SToby Isaac     }
5560c58f1c22SToby Isaac     ++l;
5561c58f1c22SToby Isaac     next = next->next;
5562c58f1c22SToby Isaac   }
5563c58f1c22SToby Isaac   SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %D does not exist in this DM", n);
5564c58f1c22SToby Isaac }
5565c58f1c22SToby Isaac 
5566c58f1c22SToby Isaac #undef __FUNCT__
5567c58f1c22SToby Isaac #define __FUNCT__ "DMHasLabel"
5568c58f1c22SToby Isaac /*@C
5569c58f1c22SToby Isaac   DMHasLabel - Determine whether the mesh has a label of a given name
5570c58f1c22SToby Isaac 
5571c58f1c22SToby Isaac   Not Collective
5572c58f1c22SToby Isaac 
5573c58f1c22SToby Isaac   Input Parameters:
5574c58f1c22SToby Isaac + dm   - The DM object
5575c58f1c22SToby Isaac - name - The label name
5576c58f1c22SToby Isaac 
5577c58f1c22SToby Isaac   Output Parameter:
5578c58f1c22SToby Isaac . hasLabel - PETSC_TRUE if the label is present
5579c58f1c22SToby Isaac 
5580c58f1c22SToby Isaac   Level: intermediate
5581c58f1c22SToby Isaac 
5582c58f1c22SToby Isaac .keywords: mesh
5583c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
5584c58f1c22SToby Isaac @*/
5585c58f1c22SToby Isaac PetscErrorCode DMHasLabel(DM dm, const char name[], PetscBool *hasLabel)
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   PetscValidCharPointer(name, 2);
5593c58f1c22SToby Isaac   PetscValidPointer(hasLabel, 3);
5594c58f1c22SToby Isaac   *hasLabel = PETSC_FALSE;
5595c58f1c22SToby Isaac   while (next) {
5596c58f1c22SToby Isaac     ierr = PetscStrcmp(name, next->label->name, hasLabel);CHKERRQ(ierr);
5597c58f1c22SToby Isaac     if (*hasLabel) break;
5598c58f1c22SToby Isaac     next = next->next;
5599c58f1c22SToby Isaac   }
5600c58f1c22SToby Isaac   PetscFunctionReturn(0);
5601c58f1c22SToby Isaac }
5602c58f1c22SToby Isaac 
5603c58f1c22SToby Isaac #undef __FUNCT__
5604c58f1c22SToby Isaac #define __FUNCT__ "DMGetLabel"
5605c58f1c22SToby Isaac /*@C
5606c58f1c22SToby Isaac   DMGetLabel - Return the label of a given name, or NULL
5607c58f1c22SToby Isaac 
5608c58f1c22SToby Isaac   Not Collective
5609c58f1c22SToby Isaac 
5610c58f1c22SToby Isaac   Input Parameters:
5611c58f1c22SToby Isaac + dm   - The DM object
5612c58f1c22SToby Isaac - name - The label name
5613c58f1c22SToby Isaac 
5614c58f1c22SToby Isaac   Output Parameter:
5615c58f1c22SToby Isaac . label - The DMLabel, or NULL if the label is absent
5616c58f1c22SToby Isaac 
5617c58f1c22SToby Isaac   Level: intermediate
5618c58f1c22SToby Isaac 
5619c58f1c22SToby Isaac .keywords: mesh
5620c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
5621c58f1c22SToby Isaac @*/
5622c58f1c22SToby Isaac PetscErrorCode DMGetLabel(DM dm, const char name[], DMLabel *label)
5623c58f1c22SToby Isaac {
5624c58f1c22SToby Isaac   DMLabelLink    next = dm->labels->next;
5625c58f1c22SToby Isaac   PetscBool      hasLabel;
5626c58f1c22SToby Isaac   PetscErrorCode ierr;
5627c58f1c22SToby Isaac 
5628c58f1c22SToby Isaac   PetscFunctionBegin;
5629c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5630c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
5631c58f1c22SToby Isaac   PetscValidPointer(label, 3);
5632c58f1c22SToby Isaac   *label = NULL;
5633c58f1c22SToby Isaac   while (next) {
5634c58f1c22SToby Isaac     ierr = PetscStrcmp(name, next->label->name, &hasLabel);CHKERRQ(ierr);
5635c58f1c22SToby Isaac     if (hasLabel) {
5636c58f1c22SToby Isaac       *label = next->label;
5637c58f1c22SToby Isaac       break;
5638c58f1c22SToby Isaac     }
5639c58f1c22SToby Isaac     next = next->next;
5640c58f1c22SToby Isaac   }
5641c58f1c22SToby Isaac   PetscFunctionReturn(0);
5642c58f1c22SToby Isaac }
5643c58f1c22SToby Isaac 
5644c58f1c22SToby Isaac #undef __FUNCT__
5645c58f1c22SToby Isaac #define __FUNCT__ "DMGetLabelByNum"
5646c58f1c22SToby Isaac /*@C
5647c58f1c22SToby Isaac   DMGetLabelByNum - Return the nth label
5648c58f1c22SToby Isaac 
5649c58f1c22SToby Isaac   Not Collective
5650c58f1c22SToby Isaac 
5651c58f1c22SToby Isaac   Input Parameters:
5652c58f1c22SToby Isaac + dm - The DM object
5653c58f1c22SToby Isaac - n  - the label number
5654c58f1c22SToby Isaac 
5655c58f1c22SToby Isaac   Output Parameter:
5656c58f1c22SToby Isaac . label - the label
5657c58f1c22SToby Isaac 
5658c58f1c22SToby Isaac   Level: intermediate
5659c58f1c22SToby Isaac 
5660c58f1c22SToby Isaac .keywords: mesh
5661c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
5662c58f1c22SToby Isaac @*/
5663c58f1c22SToby Isaac PetscErrorCode DMGetLabelByNum(DM dm, PetscInt n, DMLabel *label)
5664c58f1c22SToby Isaac {
5665c58f1c22SToby Isaac   DMLabelLink next = dm->labels->next;
5666c58f1c22SToby Isaac   PetscInt    l    = 0;
5667c58f1c22SToby Isaac 
5668c58f1c22SToby Isaac   PetscFunctionBegin;
5669c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5670c58f1c22SToby Isaac   PetscValidPointer(label, 3);
5671c58f1c22SToby Isaac   while (next) {
5672c58f1c22SToby Isaac     if (l == n) {
5673c58f1c22SToby Isaac       *label = next->label;
5674c58f1c22SToby Isaac       PetscFunctionReturn(0);
5675c58f1c22SToby Isaac     }
5676c58f1c22SToby Isaac     ++l;
5677c58f1c22SToby Isaac     next = next->next;
5678c58f1c22SToby Isaac   }
5679c58f1c22SToby Isaac   SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %D does not exist in this DM", n);
5680c58f1c22SToby Isaac }
5681c58f1c22SToby Isaac 
5682c58f1c22SToby Isaac #undef __FUNCT__
5683c58f1c22SToby Isaac #define __FUNCT__ "DMAddLabel"
5684c58f1c22SToby Isaac /*@C
5685c58f1c22SToby Isaac   DMAddLabel - Add the label to this mesh
5686c58f1c22SToby Isaac 
5687c58f1c22SToby Isaac   Not Collective
5688c58f1c22SToby Isaac 
5689c58f1c22SToby Isaac   Input Parameters:
5690c58f1c22SToby Isaac + dm   - The DM object
5691c58f1c22SToby Isaac - label - The DMLabel
5692c58f1c22SToby Isaac 
5693c58f1c22SToby Isaac   Level: developer
5694c58f1c22SToby Isaac 
5695c58f1c22SToby Isaac .keywords: mesh
5696c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
5697c58f1c22SToby Isaac @*/
5698c58f1c22SToby Isaac PetscErrorCode DMAddLabel(DM dm, DMLabel label)
5699c58f1c22SToby Isaac {
5700c58f1c22SToby Isaac   DMLabelLink    tmpLabel;
5701c58f1c22SToby Isaac   PetscBool      hasLabel;
5702c58f1c22SToby Isaac   PetscErrorCode ierr;
5703c58f1c22SToby Isaac 
5704c58f1c22SToby Isaac   PetscFunctionBegin;
5705c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5706c58f1c22SToby Isaac   ierr = DMHasLabel(dm, label->name, &hasLabel);CHKERRQ(ierr);
5707c58f1c22SToby Isaac   if (hasLabel) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %s already exists in this DM", label->name);
5708c58f1c22SToby Isaac   ierr = PetscCalloc1(1, &tmpLabel);CHKERRQ(ierr);
5709c58f1c22SToby Isaac   tmpLabel->label  = label;
5710c58f1c22SToby Isaac   tmpLabel->output = PETSC_TRUE;
5711c58f1c22SToby Isaac   tmpLabel->next   = dm->labels->next;
5712c58f1c22SToby Isaac   dm->labels->next = tmpLabel;
5713c58f1c22SToby Isaac   PetscFunctionReturn(0);
5714c58f1c22SToby Isaac }
5715c58f1c22SToby Isaac 
5716c58f1c22SToby Isaac #undef __FUNCT__
5717c58f1c22SToby Isaac #define __FUNCT__ "DMRemoveLabel"
5718c58f1c22SToby Isaac /*@C
5719c58f1c22SToby Isaac   DMRemoveLabel - Remove the label from this mesh
5720c58f1c22SToby Isaac 
5721c58f1c22SToby Isaac   Not Collective
5722c58f1c22SToby Isaac 
5723c58f1c22SToby Isaac   Input Parameters:
5724c58f1c22SToby Isaac + dm   - The DM object
5725c58f1c22SToby Isaac - name - The label name
5726c58f1c22SToby Isaac 
5727c58f1c22SToby Isaac   Output Parameter:
5728c58f1c22SToby Isaac . label - The DMLabel, or NULL if the label is absent
5729c58f1c22SToby Isaac 
5730c58f1c22SToby Isaac   Level: developer
5731c58f1c22SToby Isaac 
5732c58f1c22SToby Isaac .keywords: mesh
5733c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
5734c58f1c22SToby Isaac @*/
5735c58f1c22SToby Isaac PetscErrorCode DMRemoveLabel(DM dm, const char name[], DMLabel *label)
5736c58f1c22SToby Isaac {
5737c58f1c22SToby Isaac   DMLabelLink    next = dm->labels->next;
5738c58f1c22SToby Isaac   DMLabelLink    last = NULL;
5739c58f1c22SToby Isaac   PetscBool      hasLabel;
5740c58f1c22SToby Isaac   PetscErrorCode ierr;
5741c58f1c22SToby Isaac 
5742c58f1c22SToby Isaac   PetscFunctionBegin;
5743c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5744c58f1c22SToby Isaac   ierr   = DMHasLabel(dm, name, &hasLabel);CHKERRQ(ierr);
5745c58f1c22SToby Isaac   *label = NULL;
5746c58f1c22SToby Isaac   if (!hasLabel) PetscFunctionReturn(0);
5747c58f1c22SToby Isaac   while (next) {
5748c58f1c22SToby Isaac     ierr = PetscStrcmp(name, next->label->name, &hasLabel);CHKERRQ(ierr);
5749c58f1c22SToby Isaac     if (hasLabel) {
5750c58f1c22SToby Isaac       if (last) last->next       = next->next;
5751c58f1c22SToby Isaac       else      dm->labels->next = next->next;
5752c58f1c22SToby Isaac       next->next = NULL;
5753c58f1c22SToby Isaac       *label     = next->label;
5754c58f1c22SToby Isaac       ierr = PetscStrcmp(name, "depth", &hasLabel);CHKERRQ(ierr);
5755c58f1c22SToby Isaac       if (hasLabel) {
5756c58f1c22SToby Isaac         dm->depthLabel = NULL;
5757c58f1c22SToby Isaac       }
5758c58f1c22SToby Isaac       ierr = PetscFree(next);CHKERRQ(ierr);
5759c58f1c22SToby Isaac       break;
5760c58f1c22SToby Isaac     }
5761c58f1c22SToby Isaac     last = next;
5762c58f1c22SToby Isaac     next = next->next;
5763c58f1c22SToby Isaac   }
5764c58f1c22SToby Isaac   PetscFunctionReturn(0);
5765c58f1c22SToby Isaac }
5766c58f1c22SToby Isaac 
5767c58f1c22SToby Isaac #undef __FUNCT__
5768c58f1c22SToby Isaac #define __FUNCT__ "DMGetLabelOutput"
5769c58f1c22SToby Isaac /*@C
5770c58f1c22SToby Isaac   DMGetLabelOutput - Get the output flag for a given label
5771c58f1c22SToby Isaac 
5772c58f1c22SToby Isaac   Not Collective
5773c58f1c22SToby Isaac 
5774c58f1c22SToby Isaac   Input Parameters:
5775c58f1c22SToby Isaac + dm   - The DM object
5776c58f1c22SToby Isaac - name - The label name
5777c58f1c22SToby Isaac 
5778c58f1c22SToby Isaac   Output Parameter:
5779c58f1c22SToby Isaac . output - The flag for output
5780c58f1c22SToby Isaac 
5781c58f1c22SToby Isaac   Level: developer
5782c58f1c22SToby Isaac 
5783c58f1c22SToby Isaac .keywords: mesh
5784c58f1c22SToby Isaac .seealso: DMSetLabelOutput(), DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
5785c58f1c22SToby Isaac @*/
5786c58f1c22SToby Isaac PetscErrorCode DMGetLabelOutput(DM dm, const char name[], PetscBool *output)
5787c58f1c22SToby Isaac {
5788c58f1c22SToby Isaac   DMLabelLink    next = dm->labels->next;
5789c58f1c22SToby Isaac   PetscErrorCode ierr;
5790c58f1c22SToby Isaac 
5791c58f1c22SToby Isaac   PetscFunctionBegin;
5792c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5793c58f1c22SToby Isaac   PetscValidPointer(name, 2);
5794c58f1c22SToby Isaac   PetscValidPointer(output, 3);
5795c58f1c22SToby Isaac   while (next) {
5796c58f1c22SToby Isaac     PetscBool flg;
5797c58f1c22SToby Isaac 
5798c58f1c22SToby Isaac     ierr = PetscStrcmp(name, next->label->name, &flg);CHKERRQ(ierr);
5799c58f1c22SToby Isaac     if (flg) {*output = next->output; PetscFunctionReturn(0);}
5800c58f1c22SToby Isaac     next = next->next;
5801c58f1c22SToby Isaac   }
5802c58f1c22SToby Isaac   SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "No label named %s was present in this dm", name);
5803c58f1c22SToby Isaac }
5804c58f1c22SToby Isaac 
5805c58f1c22SToby Isaac #undef __FUNCT__
5806c58f1c22SToby Isaac #define __FUNCT__ "DMSetLabelOutput"
5807c58f1c22SToby Isaac /*@C
5808c58f1c22SToby Isaac   DMSetLabelOutput - Set the output flag for a given label
5809c58f1c22SToby Isaac 
5810c58f1c22SToby Isaac   Not Collective
5811c58f1c22SToby Isaac 
5812c58f1c22SToby Isaac   Input Parameters:
5813c58f1c22SToby Isaac + dm     - The DM object
5814c58f1c22SToby Isaac . name   - The label name
5815c58f1c22SToby Isaac - output - The flag for output
5816c58f1c22SToby Isaac 
5817c58f1c22SToby Isaac   Level: developer
5818c58f1c22SToby Isaac 
5819c58f1c22SToby Isaac .keywords: mesh
5820c58f1c22SToby Isaac .seealso: DMGetLabelOutput(), DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
5821c58f1c22SToby Isaac @*/
5822c58f1c22SToby Isaac PetscErrorCode DMSetLabelOutput(DM dm, const char name[], PetscBool output)
5823c58f1c22SToby Isaac {
5824c58f1c22SToby Isaac   DMLabelLink    next = dm->labels->next;
5825c58f1c22SToby Isaac   PetscErrorCode ierr;
5826c58f1c22SToby Isaac 
5827c58f1c22SToby Isaac   PetscFunctionBegin;
5828c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5829c58f1c22SToby Isaac   PetscValidPointer(name, 2);
5830c58f1c22SToby Isaac   while (next) {
5831c58f1c22SToby Isaac     PetscBool flg;
5832c58f1c22SToby Isaac 
5833c58f1c22SToby Isaac     ierr = PetscStrcmp(name, next->label->name, &flg);CHKERRQ(ierr);
5834c58f1c22SToby Isaac     if (flg) {next->output = output; PetscFunctionReturn(0);}
5835c58f1c22SToby Isaac     next = next->next;
5836c58f1c22SToby Isaac   }
5837c58f1c22SToby Isaac   SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "No label named %s was present in this dm", name);
5838c58f1c22SToby Isaac }
5839c58f1c22SToby Isaac 
5840c58f1c22SToby Isaac 
5841c58f1c22SToby Isaac #undef __FUNCT__
5842c58f1c22SToby Isaac #define __FUNCT__ "DMCopyLabels"
5843c58f1c22SToby Isaac /*@
5844c58f1c22SToby Isaac   DMCopyLabels - Copy labels from one mesh to another with a superset of the points
5845c58f1c22SToby Isaac 
5846c58f1c22SToby Isaac   Collective on DM
5847c58f1c22SToby Isaac 
5848c58f1c22SToby Isaac   Input Parameter:
58492e17dfb7SMatthew G. Knepley . dmA - The DM object with initial labels
5850c58f1c22SToby Isaac 
5851c58f1c22SToby Isaac   Output Parameter:
58522e17dfb7SMatthew G. Knepley . dmB - The DM object with copied labels
5853c58f1c22SToby Isaac 
5854c58f1c22SToby Isaac   Level: intermediate
5855c58f1c22SToby Isaac 
5856c58f1c22SToby Isaac   Note: This is typically used when interpolating or otherwise adding to a mesh
5857c58f1c22SToby Isaac 
5858c58f1c22SToby Isaac .keywords: mesh
5859c58f1c22SToby Isaac .seealso: DMCopyCoordinates(), DMGetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM(), DMGetCoordinateSection()
5860c58f1c22SToby Isaac @*/
5861c58f1c22SToby Isaac PetscErrorCode DMCopyLabels(DM dmA, DM dmB)
5862c58f1c22SToby Isaac {
5863c58f1c22SToby Isaac   PetscInt       numLabels, l;
5864c58f1c22SToby Isaac   PetscErrorCode ierr;
5865c58f1c22SToby Isaac 
5866c58f1c22SToby Isaac   PetscFunctionBegin;
5867c58f1c22SToby Isaac   if (dmA == dmB) PetscFunctionReturn(0);
5868c58f1c22SToby Isaac   ierr = DMGetNumLabels(dmA, &numLabels);CHKERRQ(ierr);
5869c58f1c22SToby Isaac   for (l = 0; l < numLabels; ++l) {
5870c58f1c22SToby Isaac     DMLabel     label, labelNew;
5871c58f1c22SToby Isaac     const char *name;
5872c58f1c22SToby Isaac     PetscBool   flg;
5873c58f1c22SToby Isaac 
5874c58f1c22SToby Isaac     ierr = DMGetLabelName(dmA, l, &name);CHKERRQ(ierr);
5875c58f1c22SToby Isaac     ierr = PetscStrcmp(name, "depth", &flg);CHKERRQ(ierr);
5876c58f1c22SToby Isaac     if (flg) continue;
5877c58f1c22SToby Isaac     ierr = DMGetLabel(dmA, name, &label);CHKERRQ(ierr);
5878c58f1c22SToby Isaac     ierr = DMLabelDuplicate(label, &labelNew);CHKERRQ(ierr);
5879c58f1c22SToby Isaac     ierr = DMAddLabel(dmB, labelNew);CHKERRQ(ierr);
5880c58f1c22SToby Isaac   }
5881c58f1c22SToby Isaac   PetscFunctionReturn(0);
5882c58f1c22SToby Isaac }
5883a8fb8f29SToby Isaac 
5884a8fb8f29SToby Isaac #undef __FUNCT__
5885a8fb8f29SToby Isaac #define __FUNCT__ "DMGetCoarseDM"
5886a8fb8f29SToby Isaac /*@
5887a8fb8f29SToby Isaac   DMGetCoarseDM - Get the coarse mesh from which this was obtained by refinement
5888a8fb8f29SToby Isaac 
5889a8fb8f29SToby Isaac   Input Parameter:
5890a8fb8f29SToby Isaac . dm - The DM object
5891a8fb8f29SToby Isaac 
5892a8fb8f29SToby Isaac   Output Parameter:
5893a8fb8f29SToby Isaac . cdm - The coarse DM
5894a8fb8f29SToby Isaac 
5895a8fb8f29SToby Isaac   Level: intermediate
5896a8fb8f29SToby Isaac 
5897a8fb8f29SToby Isaac .seealso: DMSetCoarseDM()
5898a8fb8f29SToby Isaac @*/
5899a8fb8f29SToby Isaac PetscErrorCode DMGetCoarseDM(DM dm, DM *cdm)
5900a8fb8f29SToby Isaac {
5901a8fb8f29SToby Isaac   PetscFunctionBegin;
5902a8fb8f29SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5903a8fb8f29SToby Isaac   PetscValidPointer(cdm, 2);
5904a8fb8f29SToby Isaac   *cdm = dm->coarseMesh;
5905a8fb8f29SToby Isaac   PetscFunctionReturn(0);
5906a8fb8f29SToby Isaac }
5907a8fb8f29SToby Isaac 
5908a8fb8f29SToby Isaac #undef __FUNCT__
5909a8fb8f29SToby Isaac #define __FUNCT__ "DMSetCoarseDM"
5910a8fb8f29SToby Isaac /*@
5911a8fb8f29SToby Isaac   DMSetCoarseDM - Set the coarse mesh from which this was obtained by refinement
5912a8fb8f29SToby Isaac 
5913a8fb8f29SToby Isaac   Input Parameters:
5914a8fb8f29SToby Isaac + dm - The DM object
5915a8fb8f29SToby Isaac - cdm - The coarse DM
5916a8fb8f29SToby Isaac 
5917a8fb8f29SToby Isaac   Level: intermediate
5918a8fb8f29SToby Isaac 
5919a8fb8f29SToby Isaac .seealso: DMGetCoarseDM()
5920a8fb8f29SToby Isaac @*/
5921a8fb8f29SToby Isaac PetscErrorCode DMSetCoarseDM(DM dm, DM cdm)
5922a8fb8f29SToby Isaac {
5923a8fb8f29SToby Isaac   PetscErrorCode ierr;
5924a8fb8f29SToby Isaac 
5925a8fb8f29SToby Isaac   PetscFunctionBegin;
5926a8fb8f29SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5927a8fb8f29SToby Isaac   if (cdm) PetscValidHeaderSpecific(cdm, DM_CLASSID, 2);
5928a8fb8f29SToby Isaac   ierr = PetscObjectReference((PetscObject)cdm);CHKERRQ(ierr);
5929a8fb8f29SToby Isaac   ierr = DMDestroy(&dm->coarseMesh);CHKERRQ(ierr);
5930a8fb8f29SToby Isaac   dm->coarseMesh = cdm;
5931a8fb8f29SToby Isaac   PetscFunctionReturn(0);
5932a8fb8f29SToby Isaac }
5933a8fb8f29SToby Isaac 
593488bdff64SToby Isaac #undef __FUNCT__
593588bdff64SToby Isaac #define __FUNCT__ "DMGetFineDM"
593688bdff64SToby Isaac /*@
593788bdff64SToby Isaac   DMGetFineDM - Get the fine mesh from which this was obtained by refinement
593888bdff64SToby Isaac 
593988bdff64SToby Isaac   Input Parameter:
594088bdff64SToby Isaac . dm - The DM object
594188bdff64SToby Isaac 
594288bdff64SToby Isaac   Output Parameter:
594388bdff64SToby Isaac . fdm - The fine DM
594488bdff64SToby Isaac 
594588bdff64SToby Isaac   Level: intermediate
594688bdff64SToby Isaac 
594788bdff64SToby Isaac .seealso: DMSetFineDM()
594888bdff64SToby Isaac @*/
594988bdff64SToby Isaac PetscErrorCode DMGetFineDM(DM dm, DM *fdm)
595088bdff64SToby Isaac {
595188bdff64SToby Isaac   PetscFunctionBegin;
595288bdff64SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
595388bdff64SToby Isaac   PetscValidPointer(fdm, 2);
595488bdff64SToby Isaac   *fdm = dm->fineMesh;
595588bdff64SToby Isaac   PetscFunctionReturn(0);
595688bdff64SToby Isaac }
595788bdff64SToby Isaac 
595888bdff64SToby Isaac #undef __FUNCT__
595988bdff64SToby Isaac #define __FUNCT__ "DMSetFineDM"
596088bdff64SToby Isaac /*@
596188bdff64SToby Isaac   DMSetFineDM - Set the fine mesh from which this was obtained by refinement
596288bdff64SToby Isaac 
596388bdff64SToby Isaac   Input Parameters:
596488bdff64SToby Isaac + dm - The DM object
596588bdff64SToby Isaac - fdm - The fine DM
596688bdff64SToby Isaac 
596788bdff64SToby Isaac   Level: intermediate
596888bdff64SToby Isaac 
596988bdff64SToby Isaac .seealso: DMGetFineDM()
597088bdff64SToby Isaac @*/
597188bdff64SToby Isaac PetscErrorCode DMSetFineDM(DM dm, DM fdm)
597288bdff64SToby Isaac {
597388bdff64SToby Isaac   PetscErrorCode ierr;
597488bdff64SToby Isaac 
597588bdff64SToby Isaac   PetscFunctionBegin;
597688bdff64SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
597788bdff64SToby Isaac   if (fdm) PetscValidHeaderSpecific(fdm, DM_CLASSID, 2);
597888bdff64SToby Isaac   ierr = PetscObjectReference((PetscObject)fdm);CHKERRQ(ierr);
597988bdff64SToby Isaac   ierr = DMDestroy(&dm->fineMesh);CHKERRQ(ierr);
598088bdff64SToby Isaac   dm->fineMesh = fdm;
598188bdff64SToby Isaac   PetscFunctionReturn(0);
598288bdff64SToby Isaac }
598388bdff64SToby Isaac 
5984a6ba4734SToby Isaac /*=== DMBoundary code ===*/
5985a6ba4734SToby Isaac 
5986a6ba4734SToby Isaac #undef __FUNCT__
5987a6ba4734SToby Isaac #define __FUNCT__ "DMCopyBoundary"
5988a6ba4734SToby Isaac PetscErrorCode DMCopyBoundary(DM dm, DM dmNew)
5989a6ba4734SToby Isaac {
5990a6ba4734SToby Isaac   PetscErrorCode ierr;
5991a6ba4734SToby Isaac 
5992a6ba4734SToby Isaac   PetscFunctionBegin;
5993e6f8dbb6SToby Isaac   ierr = PetscDSCopyBoundary(dm->prob,dmNew->prob);CHKERRQ(ierr);
5994a6ba4734SToby Isaac   PetscFunctionReturn(0);
5995a6ba4734SToby Isaac }
5996a6ba4734SToby Isaac 
5997a6ba4734SToby Isaac #undef __FUNCT__
5998a6ba4734SToby Isaac #define __FUNCT__ "DMAddBoundary"
5999a6ba4734SToby Isaac /*@C
6000a6ba4734SToby Isaac   DMAddBoundary - Add a boundary condition to the model
6001a6ba4734SToby Isaac 
6002a6ba4734SToby Isaac   Input Parameters:
60034c258f51SMatthew G. Knepley + dm          - The DM, with a PetscDS that matches the problem being constrained
6004a6ba4734SToby Isaac . isEssential - Flag for an essential (Dirichlet) condition, as opposed to a natural (Neumann) condition
6005a6ba4734SToby Isaac . name        - The BC name
6006a6ba4734SToby Isaac . labelname   - The label defining constrained points
6007a6ba4734SToby Isaac . field       - The field to constrain
6008a6ba4734SToby Isaac . numcomps    - The number of constrained field components
6009a6ba4734SToby Isaac . comps       - An array of constrained component numbers
6010a6ba4734SToby Isaac . bcFunc      - A pointwise function giving boundary values
6011a6ba4734SToby Isaac . numids      - The number of DMLabel ids for constrained points
6012a6ba4734SToby Isaac . ids         - An array of ids for constrained points
6013a6ba4734SToby Isaac - ctx         - An optional user context for bcFunc
6014a6ba4734SToby Isaac 
6015a6ba4734SToby Isaac   Options Database Keys:
6016a6ba4734SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids
6017a6ba4734SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components
6018a6ba4734SToby Isaac 
6019a6ba4734SToby Isaac   Level: developer
6020a6ba4734SToby Isaac 
6021a6ba4734SToby Isaac .seealso: DMGetBoundary()
6022a6ba4734SToby Isaac @*/
6023a6ba4734SToby 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)
6024a6ba4734SToby Isaac {
6025a6ba4734SToby Isaac   PetscErrorCode ierr;
6026a6ba4734SToby Isaac 
6027a6ba4734SToby Isaac   PetscFunctionBegin;
6028a6ba4734SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
602958ebd649SToby Isaac   ierr = PetscDSAddBoundary(dm->prob,isEssential,name,labelname,field,numcomps,comps,bcFunc,numids,ids,ctx);CHKERRQ(ierr);
6030a6ba4734SToby Isaac   PetscFunctionReturn(0);
6031a6ba4734SToby Isaac }
6032a6ba4734SToby Isaac 
6033a6ba4734SToby Isaac #undef __FUNCT__
6034a6ba4734SToby Isaac #define __FUNCT__ "DMGetNumBoundary"
6035a6ba4734SToby Isaac /*@
6036a6ba4734SToby Isaac   DMGetNumBoundary - Get the number of registered BC
6037a6ba4734SToby Isaac 
6038a6ba4734SToby Isaac   Input Parameters:
6039a6ba4734SToby Isaac . dm - The mesh object
6040a6ba4734SToby Isaac 
6041a6ba4734SToby Isaac   Output Parameters:
6042a6ba4734SToby Isaac . numBd - The number of BC
6043a6ba4734SToby Isaac 
6044a6ba4734SToby Isaac   Level: intermediate
6045a6ba4734SToby Isaac 
6046a6ba4734SToby Isaac .seealso: DMAddBoundary(), DMGetBoundary()
6047a6ba4734SToby Isaac @*/
6048a6ba4734SToby Isaac PetscErrorCode DMGetNumBoundary(DM dm, PetscInt *numBd)
6049a6ba4734SToby Isaac {
605058ebd649SToby Isaac   PetscErrorCode ierr;
6051a6ba4734SToby Isaac 
6052a6ba4734SToby Isaac   PetscFunctionBegin;
6053a6ba4734SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
605458ebd649SToby Isaac   ierr = PetscDSGetNumBoundary(dm->prob,numBd);CHKERRQ(ierr);
6055a6ba4734SToby Isaac   PetscFunctionReturn(0);
6056a6ba4734SToby Isaac }
6057a6ba4734SToby Isaac 
6058a6ba4734SToby Isaac #undef __FUNCT__
6059a6ba4734SToby Isaac #define __FUNCT__ "DMGetBoundary"
6060a6ba4734SToby Isaac /*@C
6061a6ba4734SToby Isaac   DMGetBoundary - Add a boundary condition to the model
6062a6ba4734SToby Isaac 
6063a6ba4734SToby Isaac   Input Parameters:
6064a6ba4734SToby Isaac + dm          - The mesh object
6065a6ba4734SToby Isaac - bd          - The BC number
6066a6ba4734SToby Isaac 
6067a6ba4734SToby Isaac   Output Parameters:
6068a6ba4734SToby Isaac + isEssential - Flag for an essential (Dirichlet) condition, as opposed to a natural (Neumann) condition
6069a6ba4734SToby Isaac . name        - The BC name
6070a6ba4734SToby Isaac . labelname   - The label defining constrained points
6071a6ba4734SToby Isaac . field       - The field to constrain
6072a6ba4734SToby Isaac . numcomps    - The number of constrained field components
6073a6ba4734SToby Isaac . comps       - An array of constrained component numbers
6074a6ba4734SToby Isaac . bcFunc      - A pointwise function giving boundary values
6075a6ba4734SToby Isaac . numids      - The number of DMLabel ids for constrained points
6076a6ba4734SToby Isaac . ids         - An array of ids for constrained points
6077a6ba4734SToby Isaac - ctx         - An optional user context for bcFunc
6078a6ba4734SToby Isaac 
6079a6ba4734SToby Isaac   Options Database Keys:
6080a6ba4734SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids
6081a6ba4734SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components
6082a6ba4734SToby Isaac 
6083a6ba4734SToby Isaac   Level: developer
6084a6ba4734SToby Isaac 
6085a6ba4734SToby Isaac .seealso: DMAddBoundary()
6086a6ba4734SToby Isaac @*/
6087a6ba4734SToby 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)
6088a6ba4734SToby Isaac {
608958ebd649SToby Isaac   PetscErrorCode ierr;
6090a6ba4734SToby Isaac 
6091a6ba4734SToby Isaac   PetscFunctionBegin;
6092a6ba4734SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
609358ebd649SToby Isaac   ierr = PetscDSGetBoundary(dm->prob,bd,isEssential,name,labelname,field,numcomps,comps,func,numids,ids,ctx);CHKERRQ(ierr);
6094a6ba4734SToby Isaac   PetscFunctionReturn(0);
6095a6ba4734SToby Isaac }
6096a6ba4734SToby Isaac 
6097a6ba4734SToby Isaac #undef __FUNCT__
6098e6f8dbb6SToby Isaac #define __FUNCT__ "DMPopulateBoundary"
6099e6f8dbb6SToby Isaac static PetscErrorCode DMPopulateBoundary(DM dm)
6100e6f8dbb6SToby Isaac {
6101dff059c6SToby Isaac   DMBoundary *lastnext;
6102e6f8dbb6SToby Isaac   DSBoundary dsbound;
6103e6f8dbb6SToby Isaac   PetscErrorCode ierr;
6104e6f8dbb6SToby Isaac 
6105e6f8dbb6SToby Isaac   PetscFunctionBegin;
6106e6f8dbb6SToby Isaac   dsbound = dm->prob->boundary;
610747a1f5adSToby Isaac   if (dm->boundary) {
610847a1f5adSToby Isaac     DMBoundary next = dm->boundary;
610947a1f5adSToby Isaac 
611047a1f5adSToby Isaac     /* quick check to see if the PetscDS has changed */
611147a1f5adSToby Isaac     if (next->dsboundary == dsbound) PetscFunctionReturn(0);
611247a1f5adSToby Isaac     /* the PetscDS has changed: tear down and rebuild */
611347a1f5adSToby Isaac     while (next) {
611447a1f5adSToby Isaac       DMBoundary b = next;
611547a1f5adSToby Isaac 
611647a1f5adSToby Isaac       next = b->next;
611747a1f5adSToby Isaac       ierr = PetscFree(b);CHKERRQ(ierr);
6118a6ba4734SToby Isaac     }
611947a1f5adSToby Isaac     dm->boundary = NULL;
6120a6ba4734SToby Isaac   }
612147a1f5adSToby Isaac 
6122dff059c6SToby Isaac   lastnext = &(dm->boundary);
6123e6f8dbb6SToby Isaac   while (dsbound) {
6124e6f8dbb6SToby Isaac     DMBoundary dmbound;
6125e6f8dbb6SToby Isaac 
6126e6f8dbb6SToby Isaac     ierr = PetscNew(&dmbound);CHKERRQ(ierr);
6127e6f8dbb6SToby Isaac     dmbound->dsboundary = dsbound;
6128e6f8dbb6SToby Isaac     ierr = DMGetLabel(dm, dsbound->labelname, &(dmbound->label));CHKERRQ(ierr);
6129e6f8dbb6SToby Isaac     if (!dmbound->label) PetscInfo2(dm, "DSBoundary %s wants label %s, which is not in this dm.\n",dsbound->name,dsbound->labelname);CHKERRQ(ierr);
613047a1f5adSToby Isaac     /* push on the back instead of the front so that it is in the same order as in the PetscDS */
6131dff059c6SToby Isaac     *lastnext = dmbound;
6132dff059c6SToby Isaac     lastnext = &(dmbound->next);
6133dff059c6SToby Isaac     dsbound = dsbound->next;
6134a6ba4734SToby Isaac   }
6135a6ba4734SToby Isaac   PetscFunctionReturn(0);
6136a6ba4734SToby Isaac }
6137a6ba4734SToby Isaac 
6138a6ba4734SToby Isaac #undef __FUNCT__
6139a6ba4734SToby Isaac #define __FUNCT__ "DMIsBoundaryPoint"
6140a6ba4734SToby Isaac PetscErrorCode DMIsBoundaryPoint(DM dm, PetscInt point, PetscBool *isBd)
6141a6ba4734SToby Isaac {
6142b95f2879SToby Isaac   DMBoundary     b;
6143a6ba4734SToby Isaac   PetscErrorCode ierr;
6144a6ba4734SToby Isaac 
6145a6ba4734SToby Isaac   PetscFunctionBegin;
6146a6ba4734SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6147a6ba4734SToby Isaac   PetscValidPointer(isBd, 3);
6148a6ba4734SToby Isaac   *isBd = PETSC_FALSE;
6149e6f8dbb6SToby Isaac   ierr = DMPopulateBoundary(dm);CHKERRQ(ierr);
6150b95f2879SToby Isaac   b = dm->boundary;
6151a6ba4734SToby Isaac   while (b && !(*isBd)) {
6152e6f8dbb6SToby Isaac     DMLabel    label = b->label;
6153e6f8dbb6SToby Isaac     DSBoundary dsb = b->dsboundary;
61543424c85cSToby Isaac 
61553424c85cSToby Isaac     if (label) {
6156a6ba4734SToby Isaac       PetscInt i;
6157a6ba4734SToby Isaac 
6158e6f8dbb6SToby Isaac       for (i = 0; i < dsb->numids && !(*isBd); ++i) {
6159e6f8dbb6SToby Isaac         ierr = DMLabelStratumHasPoint(label, dsb->ids[i], point, isBd);CHKERRQ(ierr);
6160a6ba4734SToby Isaac       }
6161a6ba4734SToby Isaac     }
6162a6ba4734SToby Isaac     b = b->next;
6163a6ba4734SToby Isaac   }
6164a6ba4734SToby Isaac   PetscFunctionReturn(0);
6165a6ba4734SToby Isaac }
61664d6f44ffSToby Isaac 
61674d6f44ffSToby Isaac #undef __FUNCT__
61684d6f44ffSToby Isaac #define __FUNCT__ "DMProjectFunction"
61694d6f44ffSToby Isaac /*@C
61704d6f44ffSToby Isaac   DMProjectFunction - This projects the given function into the function space provided.
61714d6f44ffSToby Isaac 
61724d6f44ffSToby Isaac   Input Parameters:
61734d6f44ffSToby Isaac + dm      - The DM
61740709b2feSToby Isaac . time    - The time
61754d6f44ffSToby Isaac . funcs   - The coordinate functions to evaluate, one per field
61764d6f44ffSToby Isaac . ctxs    - Optional array of contexts to pass to each coordinate function.  ctxs itself may be null.
61774d6f44ffSToby Isaac - mode    - The insertion mode for values
61784d6f44ffSToby Isaac 
61794d6f44ffSToby Isaac   Output Parameter:
61804d6f44ffSToby Isaac . X - vector
61814d6f44ffSToby Isaac 
61824d6f44ffSToby Isaac    Calling sequence of func:
61830709b2feSToby Isaac $    func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nf, PetscScalar u[], void *ctx);
61844d6f44ffSToby Isaac 
61854d6f44ffSToby Isaac +  dim - The spatial dimension
61864d6f44ffSToby Isaac .  x   - The coordinates
61874d6f44ffSToby Isaac .  Nf  - The number of fields
61884d6f44ffSToby Isaac .  u   - The output field values
61894d6f44ffSToby Isaac -  ctx - optional user-defined function context
61904d6f44ffSToby Isaac 
61914d6f44ffSToby Isaac   Level: developer
61924d6f44ffSToby Isaac 
61932716604bSToby Isaac .seealso: DMComputeL2Diff()
61944d6f44ffSToby Isaac @*/
61950709b2feSToby Isaac PetscErrorCode DMProjectFunction(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec X)
61964d6f44ffSToby Isaac {
61974d6f44ffSToby Isaac   Vec            localX;
61984d6f44ffSToby Isaac   PetscErrorCode ierr;
61994d6f44ffSToby Isaac 
62004d6f44ffSToby Isaac   PetscFunctionBegin;
62014d6f44ffSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
62024d6f44ffSToby Isaac   ierr = DMGetLocalVector(dm, &localX);CHKERRQ(ierr);
62030709b2feSToby Isaac   ierr = DMProjectFunctionLocal(dm, time, funcs, ctxs, mode, localX);CHKERRQ(ierr);
62044d6f44ffSToby Isaac   ierr = DMLocalToGlobalBegin(dm, localX, mode, X);CHKERRQ(ierr);
62054d6f44ffSToby Isaac   ierr = DMLocalToGlobalEnd(dm, localX, mode, X);CHKERRQ(ierr);
62064d6f44ffSToby Isaac   ierr = DMRestoreLocalVector(dm, &localX);CHKERRQ(ierr);
62074d6f44ffSToby Isaac   PetscFunctionReturn(0);
62084d6f44ffSToby Isaac }
62094d6f44ffSToby Isaac 
62104d6f44ffSToby Isaac #undef __FUNCT__
62114d6f44ffSToby Isaac #define __FUNCT__ "DMProjectFunctionLocal"
62120709b2feSToby Isaac PetscErrorCode DMProjectFunctionLocal(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec localX)
62134d6f44ffSToby Isaac {
62144d6f44ffSToby Isaac   PetscErrorCode ierr;
62154d6f44ffSToby Isaac 
62164d6f44ffSToby Isaac   PetscFunctionBegin;
62174d6f44ffSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
62184d6f44ffSToby Isaac   PetscValidHeaderSpecific(localX,VEC_CLASSID,5);
62194d6f44ffSToby Isaac   if (!dm->ops->projectfunctionlocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implemnt DMProjectFunctionLocal",((PetscObject)dm)->type_name);
62200709b2feSToby Isaac   ierr = (dm->ops->projectfunctionlocal) (dm, time, funcs, ctxs, mode, localX);CHKERRQ(ierr);
62214d6f44ffSToby Isaac   PetscFunctionReturn(0);
62224d6f44ffSToby Isaac }
62234d6f44ffSToby Isaac 
62244d6f44ffSToby Isaac #undef __FUNCT__
6225bfc4295aSToby Isaac #define __FUNCT__ "DMProjectFieldLocal"
6226bfc4295aSToby Isaac PetscErrorCode DMProjectFieldLocal(DM dm, Vec localU,
6227bfc4295aSToby Isaac                                    void (**funcs)(PetscInt, PetscInt, PetscInt,
6228bfc4295aSToby Isaac                                                   const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
6229bfc4295aSToby Isaac                                                   const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
6230bfc4295aSToby Isaac                                                   PetscReal, const PetscReal[], PetscScalar[]),
6231bfc4295aSToby Isaac                                    InsertMode mode, Vec localX)
6232bfc4295aSToby Isaac {
6233bfc4295aSToby Isaac   PetscErrorCode ierr;
6234bfc4295aSToby Isaac 
6235bfc4295aSToby Isaac   PetscFunctionBegin;
6236bfc4295aSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6237bfc4295aSToby Isaac   PetscValidHeaderSpecific(localU,VEC_CLASSID,2);
6238bfc4295aSToby Isaac   PetscValidHeaderSpecific(localX,VEC_CLASSID,5);
6239bfc4295aSToby Isaac   if (!dm->ops->projectfieldlocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implemnt DMProjectFieldLocal",((PetscObject)dm)->type_name);
6240bfc4295aSToby Isaac   ierr = (dm->ops->projectfieldlocal) (dm, localU, funcs, mode, localX);CHKERRQ(ierr);
6241bfc4295aSToby Isaac   PetscFunctionReturn(0);
6242bfc4295aSToby Isaac }
6243bfc4295aSToby Isaac 
6244bfc4295aSToby Isaac #undef __FUNCT__
62454d6f44ffSToby Isaac #define __FUNCT__ "DMProjectFunctionLabelLocal"
62460709b2feSToby 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)
62474d6f44ffSToby Isaac {
62484d6f44ffSToby Isaac   PetscErrorCode ierr;
62494d6f44ffSToby Isaac 
62504d6f44ffSToby Isaac   PetscFunctionBegin;
62514d6f44ffSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
62524d6f44ffSToby Isaac   PetscValidHeaderSpecific(localX,VEC_CLASSID,5);
62534d6f44ffSToby Isaac   if (!dm->ops->projectfunctionlabellocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implemnt DMProjectFunctionLabelLocal",((PetscObject)dm)->type_name);
62540709b2feSToby Isaac   ierr = (dm->ops->projectfunctionlabellocal) (dm, time, label, numIds, ids, funcs, ctxs, mode, localX);CHKERRQ(ierr);
62554d6f44ffSToby Isaac   PetscFunctionReturn(0);
62564d6f44ffSToby Isaac }
62572716604bSToby Isaac 
62582716604bSToby Isaac #undef __FUNCT__
62592716604bSToby Isaac #define __FUNCT__ "DMComputeL2Diff"
62602716604bSToby Isaac /*@C
62612716604bSToby Isaac   DMComputeL2Diff - This function computes the L_2 difference between a function u and an FEM interpolant solution u_h.
62622716604bSToby Isaac 
62632716604bSToby Isaac   Input Parameters:
62642716604bSToby Isaac + dm    - The DM
62650709b2feSToby Isaac . time  - The time
62662716604bSToby Isaac . funcs - The functions to evaluate for each field component
62672716604bSToby Isaac . ctxs  - Optional array of contexts to pass to each function, or NULL.
62682716604bSToby Isaac - X     - The coefficient vector u_h
62692716604bSToby Isaac 
62702716604bSToby Isaac   Output Parameter:
62712716604bSToby Isaac . diff - The diff ||u - u_h||_2
62722716604bSToby Isaac 
62732716604bSToby Isaac   Level: developer
62742716604bSToby Isaac 
62751189c1efSToby Isaac .seealso: DMProjectFunction(), DMComputeL2FieldDiff(), DMComputeL2GradientDiff()
62762716604bSToby Isaac @*/
62770709b2feSToby Isaac PetscErrorCode DMComputeL2Diff(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, Vec X, PetscReal *diff)
62782716604bSToby Isaac {
62792716604bSToby Isaac   PetscErrorCode ierr;
62802716604bSToby Isaac 
62812716604bSToby Isaac   PetscFunctionBegin;
62822716604bSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6283b698f381SToby Isaac   PetscValidHeaderSpecific(X,VEC_CLASSID,5);
62842716604bSToby Isaac   if (!dm->ops->computel2diff) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implemnt DMComputeL2Diff",((PetscObject)dm)->type_name);
62850709b2feSToby Isaac   ierr = (dm->ops->computel2diff)(dm,time,funcs,ctxs,X,diff);CHKERRQ(ierr);
62862716604bSToby Isaac   PetscFunctionReturn(0);
62872716604bSToby Isaac }
6288b698f381SToby Isaac 
6289b698f381SToby Isaac #undef __FUNCT__
6290b698f381SToby Isaac #define __FUNCT__ "DMComputeL2GradientDiff"
6291b698f381SToby Isaac /*@C
6292b698f381SToby Isaac   DMComputeL2GradientDiff - This function computes the L_2 difference between the gradient of a function u and an FEM interpolant solution grad u_h.
6293b698f381SToby Isaac 
6294b698f381SToby Isaac   Input Parameters:
6295b698f381SToby Isaac + dm    - The DM
6296b698f381SToby Isaac , time  - The time
6297b698f381SToby Isaac . funcs - The gradient functions to evaluate for each field component
6298b698f381SToby Isaac . ctxs  - Optional array of contexts to pass to each function, or NULL.
6299b698f381SToby Isaac . X     - The coefficient vector u_h
6300b698f381SToby Isaac - n     - The vector to project along
6301b698f381SToby Isaac 
6302b698f381SToby Isaac   Output Parameter:
6303b698f381SToby Isaac . diff - The diff ||(grad u - grad u_h) . n||_2
6304b698f381SToby Isaac 
6305b698f381SToby Isaac   Level: developer
6306b698f381SToby Isaac 
6307b698f381SToby Isaac .seealso: DMProjectFunction(), DMComputeL2Diff()
6308b698f381SToby Isaac @*/
6309b698f381SToby 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)
6310b698f381SToby Isaac {
6311b698f381SToby Isaac   PetscErrorCode ierr;
6312b698f381SToby Isaac 
6313b698f381SToby Isaac   PetscFunctionBegin;
6314b698f381SToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6315b698f381SToby Isaac   PetscValidHeaderSpecific(X,VEC_CLASSID,5);
6316b698f381SToby Isaac   if (!dm->ops->computel2gradientdiff) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2GradientDiff",((PetscObject)dm)->type_name);
6317b698f381SToby Isaac   ierr = (dm->ops->computel2gradientdiff)(dm,time,funcs,ctxs,X,n,diff);CHKERRQ(ierr);
6318b698f381SToby Isaac   PetscFunctionReturn(0);
6319b698f381SToby Isaac }
6320b698f381SToby Isaac 
63212a16baeaSToby Isaac #undef __FUNCT__
63222a16baeaSToby Isaac #define __FUNCT__ "DMComputeL2FieldDiff"
63232a16baeaSToby Isaac /*@C
63242a16baeaSToby Isaac   DMComputeL2FieldDiff - This function computes the L_2 difference between a function u and an FEM interpolant solution u_h, separated into field components.
63252a16baeaSToby Isaac 
63262a16baeaSToby Isaac   Input Parameters:
63272a16baeaSToby Isaac + dm    - The DM
63282a16baeaSToby Isaac . time  - The time
63292a16baeaSToby Isaac . funcs - The functions to evaluate for each field component
63302a16baeaSToby Isaac . ctxs  - Optional array of contexts to pass to each function, or NULL.
63312a16baeaSToby Isaac - X     - The coefficient vector u_h
63322a16baeaSToby Isaac 
63332a16baeaSToby Isaac   Output Parameter:
63342a16baeaSToby Isaac . diff - The array of differences, ||u^f - u^f_h||_2
63352a16baeaSToby Isaac 
63362a16baeaSToby Isaac   Level: developer
63372a16baeaSToby Isaac 
63381189c1efSToby Isaac .seealso: DMProjectFunction(), DMComputeL2FieldDiff(), DMComputeL2GradientDiff()
63392a16baeaSToby Isaac @*/
63401189c1efSToby Isaac PetscErrorCode DMComputeL2FieldDiff(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, Vec X, PetscReal diff[])
63412a16baeaSToby Isaac {
63422a16baeaSToby Isaac   PetscErrorCode ierr;
63432a16baeaSToby Isaac 
63442a16baeaSToby Isaac   PetscFunctionBegin;
63452a16baeaSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
63462a16baeaSToby Isaac   PetscValidHeaderSpecific(X,VEC_CLASSID,5);
63472a16baeaSToby Isaac   if (!dm->ops->computel2fielddiff) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implemnt DMComputeL2FieldDiff",((PetscObject)dm)->type_name);
63482a16baeaSToby Isaac   ierr = (dm->ops->computel2fielddiff)(dm,time,funcs,ctxs,X,diff);CHKERRQ(ierr);
63492a16baeaSToby Isaac   PetscFunctionReturn(0);
63502a16baeaSToby Isaac }
63512a16baeaSToby Isaac 
6352df0b854cSToby Isaac #undef __FUNCT__
6353df0b854cSToby Isaac #define __FUNCT__ "DMAdaptLabel"
6354df0b854cSToby Isaac /*@C
6355df0b854cSToby Isaac   DMAdaptLabel - Adapt a dm based on a label with values interpreted as coarsening and refining flags.  Specific implementations of DM maybe have
6356cd3c525cSToby Isaac                  specialized flags, but all implementations should accept flag values DM_ADAPT_DETERMINE, DM_ADAPT_KEEP, DM_ADAPT_REFINE, and DM_ADAPT_COARSEN.
6357df0b854cSToby Isaac 
6358df0b854cSToby Isaac   Collective on dm
6359df0b854cSToby Isaac 
6360df0b854cSToby Isaac   Input parameters:
6361df0b854cSToby Isaac + dm - the pre-adaptation DM object
6362a1b0c543SToby Isaac - label - label with the flags
6363df0b854cSToby Isaac 
6364df0b854cSToby Isaac   Output parameters:
6365df0b854cSToby Isaac . adaptedDM - the adapted DM object: may be NULL if an adapted DM could not be produced.
6366df0b854cSToby Isaac 
6367df0b854cSToby Isaac   Level: intermediate
6368df0b854cSToby Isaac @*/
6369a1b0c543SToby Isaac PetscErrorCode DMAdaptLabel(DM dm, DMLabel label, DM *adaptedDM)
6370df0b854cSToby Isaac {
6371df0b854cSToby Isaac   PetscErrorCode ierr;
6372df0b854cSToby Isaac 
6373df0b854cSToby Isaac   PetscFunctionBegin;
6374df0b854cSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6375a1b0c543SToby Isaac   PetscValidPointer(label,2);
6376df0b854cSToby Isaac   PetscValidPointer(adaptedDM,3);
6377df0b854cSToby Isaac   *adaptedDM = NULL;
6378a1b0c543SToby Isaac   ierr = PetscTryMethod((PetscObject)dm,"DMAdaptLabel_C",(DM,DMLabel, DM*),(dm,label,adaptedDM));CHKERRQ(ierr);
6379df0b854cSToby Isaac   PetscFunctionReturn(0);
6380df0b854cSToby Isaac }
6381c4088d22SMatthew G. Knepley 
6382c4088d22SMatthew G. Knepley #undef __FUNCT__
6383502a2867SDave May #define __FUNCT__ "DMGetNeighbors"
6384502a2867SDave May /*@C
6385502a2867SDave May  DMGetNeighbors - Gets an array containing the MPI rank of all the processes neighbors
6386502a2867SDave May 
6387502a2867SDave May  Not Collective
6388502a2867SDave May 
6389502a2867SDave May  Input Parameter:
6390502a2867SDave May  . dm    - The DM
6391502a2867SDave May 
6392502a2867SDave May  Output Parameter:
6393502a2867SDave May  . nranks - the number of neighbours
6394502a2867SDave May  . ranks - the neighbors ranks
6395502a2867SDave May 
6396502a2867SDave May  Notes:
6397502a2867SDave May  Do not free the array, it is freed when the DM is destroyed.
6398502a2867SDave May 
6399502a2867SDave May  Level: beginner
6400502a2867SDave May 
6401dee935c1SDave May  .seealso: DMDAGetNeighbors(), PetscSFGetRanks()
6402502a2867SDave May @*/
6403502a2867SDave May PetscErrorCode DMGetNeighbors(DM dm,PetscInt *nranks,const PetscMPIInt *ranks[])
6404502a2867SDave May {
6405502a2867SDave May   PetscErrorCode ierr;
6406502a2867SDave May 
6407502a2867SDave May   PetscFunctionBegin;
6408502a2867SDave May   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6409502a2867SDave May   if (!dm->ops->getneighbors) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implemnt DMGetNeighbors",((PetscObject)dm)->type_name);
6410502a2867SDave May   ierr = (dm->ops->getneighbors)(dm,nranks,ranks);CHKERRQ(ierr);
6411502a2867SDave May   PetscFunctionReturn(0);
6412502a2867SDave May }
6413502a2867SDave May 
6414531c7667SBarry Smith #include <petsc/private/matimpl.h> /* Needed because of coloring->ctype below */
6415531c7667SBarry Smith 
6416531c7667SBarry Smith #undef __FUNCT__
6417531c7667SBarry Smith #define __FUNCT__ "MatFDColoringApply_AIJDM"
6418531c7667SBarry Smith /*
6419531c7667SBarry Smith     Converts the input vector to a ghosted vector and then calls the standard coloring code.
6420531c7667SBarry Smith     This has be a different function because it requires DM which is not defined in the Mat library
6421531c7667SBarry Smith */
6422531c7667SBarry Smith PetscErrorCode  MatFDColoringApply_AIJDM(Mat J,MatFDColoring coloring,Vec x1,void *sctx)
6423531c7667SBarry Smith {
6424531c7667SBarry Smith   PetscErrorCode ierr;
6425531c7667SBarry Smith 
6426531c7667SBarry Smith   PetscFunctionBegin;
6427531c7667SBarry Smith   if (coloring->ctype == IS_COLORING_LOCAL) {
6428531c7667SBarry Smith     Vec x1local;
6429531c7667SBarry Smith     DM  dm;
6430531c7667SBarry Smith     ierr = MatGetDM(J,&dm);CHKERRQ(ierr);
6431531c7667SBarry Smith     if (!dm) SETERRQ(PetscObjectComm((PetscObject)J),PETSC_ERR_ARG_INCOMP,"IS_COLORING_LOCAL requires a DM");
6432531c7667SBarry Smith     ierr = DMGetLocalVector(dm,&x1local);CHKERRQ(ierr);
6433531c7667SBarry Smith     ierr = DMGlobalToLocalBegin(dm,x1,INSERT_VALUES,x1local);CHKERRQ(ierr);
6434531c7667SBarry Smith     ierr = DMGlobalToLocalEnd(dm,x1,INSERT_VALUES,x1local);CHKERRQ(ierr);
6435531c7667SBarry Smith     x1   = x1local;
6436531c7667SBarry Smith   }
6437531c7667SBarry Smith   ierr = MatFDColoringApply_AIJ(J,coloring,x1,sctx);CHKERRQ(ierr);
6438531c7667SBarry Smith   if (coloring->ctype == IS_COLORING_LOCAL) {
6439531c7667SBarry Smith     DM  dm;
6440531c7667SBarry Smith     ierr = MatGetDM(J,&dm);CHKERRQ(ierr);
6441531c7667SBarry Smith     ierr = DMRestoreLocalVector(dm,&x1);CHKERRQ(ierr);
6442531c7667SBarry Smith   }
6443531c7667SBarry Smith   PetscFunctionReturn(0);
6444531c7667SBarry Smith }
6445531c7667SBarry Smith 
6446531c7667SBarry Smith #undef __FUNCT__
6447531c7667SBarry Smith #define __FUNCT__ "MatFDColoringUseDM"
6448531c7667SBarry Smith /*@
6449531c7667SBarry Smith     MatFDColoringUseDM - allows a MatFDColoring object to use the DM associated with the matrix to use a IS_COLORING_LOCAL coloring
6450531c7667SBarry Smith 
6451531c7667SBarry Smith     Input Parameter:
6452531c7667SBarry Smith .    coloring - the MatFDColoring object
6453531c7667SBarry Smith 
6454531c7667SBarry Smith     Developer Notes: this routine exists because the PETSc Mat library does not know about the DM objects
6455531c7667SBarry Smith 
6456531c7667SBarry Smith .seealso: MatFDColoring, MatFDColoringCreate(), ISColoringType
6457531c7667SBarry Smith @*/
6458531c7667SBarry Smith PetscErrorCode  MatFDColoringUseDM(Mat coloring,MatFDColoring fdcoloring)
6459531c7667SBarry Smith {
6460531c7667SBarry Smith   PetscFunctionBegin;
6461531c7667SBarry Smith   coloring->ops->fdcoloringapply = MatFDColoringApply_AIJDM;
6462531c7667SBarry Smith   PetscFunctionReturn(0);
6463531c7667SBarry Smith }
6464