xref: /petsc/src/dm/interface/dm.c (revision a321983730cd9ba4826693292344828a5e31b6d3)
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;
91ac00216SMatthew G. Knepley PetscLogEvent DM_Convert, DM_GlobalToLocal, DM_LocalToGlobal, DM_LocalToLocal, DM_LocatePoints, DM_Coarsen, DM_Refine, 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 
13a4121054SBarry Smith /*@
14de043629SMatthew G Knepley   DMCreate - Creates an empty DM object. The type can then be set with DMSetType().
15a4121054SBarry Smith 
16a4121054SBarry Smith    If you never  call DMSetType()  it will generate an
17a4121054SBarry Smith    error when you try to use the vector.
18a4121054SBarry Smith 
19a4121054SBarry Smith   Collective on MPI_Comm
20a4121054SBarry Smith 
21a4121054SBarry Smith   Input Parameter:
22a4121054SBarry Smith . comm - The communicator for the DM object
23a4121054SBarry Smith 
24a4121054SBarry Smith   Output Parameter:
25a4121054SBarry Smith . dm - The DM object
26a4121054SBarry Smith 
27a4121054SBarry Smith   Level: beginner
28a4121054SBarry Smith 
298472ad0fSDave May .seealso: DMSetType(), DMDA, DMSLICED, DMCOMPOSITE, DMPLEX, DMMOAB, DMNETWORK
30a4121054SBarry Smith @*/
317087cfbeSBarry Smith PetscErrorCode  DMCreate(MPI_Comm comm,DM *dm)
32a4121054SBarry Smith {
33a4121054SBarry Smith   DM             v;
34a4121054SBarry Smith   PetscErrorCode ierr;
35a4121054SBarry Smith 
36a4121054SBarry Smith   PetscFunctionBegin;
371411c6eeSJed Brown   PetscValidPointer(dm,2);
380298fd71SBarry Smith   *dm = NULL;
398b984314SMatthew G. Knepley   ierr = PetscSysInitializePackage();CHKERRQ(ierr);
40607a6623SBarry Smith   ierr = VecInitializePackage();CHKERRQ(ierr);
41607a6623SBarry Smith   ierr = MatInitializePackage();CHKERRQ(ierr);
42607a6623SBarry Smith   ierr = DMInitializePackage();CHKERRQ(ierr);
43a4121054SBarry Smith 
4473107ff1SLisandro Dalcin   ierr = PetscHeaderCreate(v, DM_CLASSID, "DM", "Distribution Manager", "DM", comm, DMDestroy, DMView);CHKERRQ(ierr);
45e7c4fc90SDmitry Karpeev 
460298fd71SBarry Smith   v->ltogmap                  = NULL;
471411c6eeSJed Brown   v->bs                       = 1;
48171400e9SBarry Smith   v->coloringtype             = IS_COLORING_GLOBAL;
4988ed4aceSMatthew G Knepley   ierr                        = PetscSFCreate(comm, &v->sf);CHKERRQ(ierr);
5088ed4aceSMatthew G Knepley   ierr                        = PetscSFCreate(comm, &v->defaultSF);CHKERRQ(ierr);
51c58f1c22SToby Isaac   v->labels                   = NULL;
52c58f1c22SToby Isaac   v->depthLabel               = NULL;
530298fd71SBarry Smith   v->defaultSection           = NULL;
540298fd71SBarry Smith   v->defaultGlobalSection     = NULL;
55fba222abSToby Isaac   v->defaultConstraintSection = NULL;
56fba222abSToby Isaac   v->defaultConstraintMat     = NULL;
57c6b900c6SMatthew G. Knepley   v->L                        = NULL;
58c6b900c6SMatthew G. Knepley   v->maxCell                  = NULL;
595dc8c3f7SMatthew G. Knepley   v->bdtype                   = NULL;
609a9a41abSToby Isaac   v->dimEmbed                 = PETSC_DEFAULT;
61435a35e8SMatthew G Knepley   {
62435a35e8SMatthew G Knepley     PetscInt i;
63435a35e8SMatthew G Knepley     for (i = 0; i < 10; ++i) {
640298fd71SBarry Smith       v->nullspaceConstructors[i] = NULL;
65435a35e8SMatthew G Knepley     }
66435a35e8SMatthew G Knepley   }
672764a2aaSMatthew G. Knepley   ierr = PetscDSCreate(comm, &v->prob);CHKERRQ(ierr);
6814f150ffSMatthew G. Knepley   v->dmBC = NULL;
69a8fb8f29SToby Isaac   v->coarseMesh = NULL;
70f4d763aaSMatthew G. Knepley   v->outputSequenceNum = -1;
71cdb7a50dSMatthew G. Knepley   v->outputSequenceVal = 0.0;
72c0dedaeaSBarry Smith   ierr = DMSetVecType(v,VECSTANDARD);CHKERRQ(ierr);
73b412c318SBarry Smith   ierr = DMSetMatType(v,MATAIJ);CHKERRQ(ierr);
74bcc5ffd9SToby Isaac   ierr = PetscNew(&(v->labels));CHKERRQ(ierr);
75c58f1c22SToby Isaac   v->labels->refct = 1;
761411c6eeSJed Brown   *dm = v;
77a4121054SBarry Smith   PetscFunctionReturn(0);
78a4121054SBarry Smith }
79a4121054SBarry Smith 
8038221697SMatthew G. Knepley /*@
8138221697SMatthew G. Knepley   DMClone - Creates a DM object with the same topology as the original.
8238221697SMatthew G. Knepley 
8338221697SMatthew G. Knepley   Collective on MPI_Comm
8438221697SMatthew G. Knepley 
8538221697SMatthew G. Knepley   Input Parameter:
8638221697SMatthew G. Knepley . dm - The original DM object
8738221697SMatthew G. Knepley 
8838221697SMatthew G. Knepley   Output Parameter:
8938221697SMatthew G. Knepley . newdm  - The new DM object
9038221697SMatthew G. Knepley 
9138221697SMatthew G. Knepley   Level: beginner
9238221697SMatthew G. Knepley 
9338221697SMatthew G. Knepley .keywords: DM, topology, create
9438221697SMatthew G. Knepley @*/
9538221697SMatthew G. Knepley PetscErrorCode DMClone(DM dm, DM *newdm)
9638221697SMatthew G. Knepley {
9738221697SMatthew G. Knepley   PetscSF        sf;
9838221697SMatthew G. Knepley   Vec            coords;
9938221697SMatthew G. Knepley   void          *ctx;
100*a3219837SMatthew G. Knepley   PetscInt       dim, cdim;
10138221697SMatthew G. Knepley   PetscErrorCode ierr;
10238221697SMatthew G. Knepley 
10338221697SMatthew G. Knepley   PetscFunctionBegin;
10438221697SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
10538221697SMatthew G. Knepley   PetscValidPointer(newdm,2);
10638221697SMatthew G. Knepley   ierr = DMCreate(PetscObjectComm((PetscObject) dm), newdm);CHKERRQ(ierr);
107c58f1c22SToby Isaac   ierr = PetscFree((*newdm)->labels);CHKERRQ(ierr);
108c58f1c22SToby Isaac   dm->labels->refct++;
109c58f1c22SToby Isaac   (*newdm)->labels = dm->labels;
110c58f1c22SToby Isaac   (*newdm)->depthLabel = dm->depthLabel;
1111de53e9aSMatthew G. Knepley   ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr);
1121de53e9aSMatthew G. Knepley   ierr = DMSetDimension(*newdm, dim);CHKERRQ(ierr);
11338221697SMatthew G. Knepley   if (dm->ops->clone) {
11438221697SMatthew G. Knepley     ierr = (*dm->ops->clone)(dm, newdm);CHKERRQ(ierr);
11538221697SMatthew G. Knepley   }
1163f22bcbcSToby Isaac   (*newdm)->setupcalled = dm->setupcalled;
11738221697SMatthew G. Knepley   ierr = DMGetPointSF(dm, &sf);CHKERRQ(ierr);
11838221697SMatthew G. Knepley   ierr = DMSetPointSF(*newdm, sf);CHKERRQ(ierr);
11938221697SMatthew G. Knepley   ierr = DMGetApplicationContext(dm, &ctx);CHKERRQ(ierr);
12038221697SMatthew G. Knepley   ierr = DMSetApplicationContext(*newdm, ctx);CHKERRQ(ierr);
121be4c1c3eSMatthew G. Knepley   if (dm->coordinateDM) {
122be4c1c3eSMatthew G. Knepley     DM           ncdm;
123be4c1c3eSMatthew G. Knepley     PetscSection cs;
1245a0206caSToby Isaac     PetscInt     pEnd = -1, pEndMax = -1;
125be4c1c3eSMatthew G. Knepley 
126be4c1c3eSMatthew G. Knepley     ierr = DMGetDefaultSection(dm->coordinateDM, &cs);CHKERRQ(ierr);
127be4c1c3eSMatthew G. Knepley     if (cs) {ierr = PetscSectionGetChart(cs, NULL, &pEnd);CHKERRQ(ierr);}
1285a0206caSToby Isaac     ierr = MPI_Allreduce(&pEnd,&pEndMax,1,MPIU_INT,MPI_MAX,PetscObjectComm((PetscObject)dm));CHKERRQ(ierr);
1295a0206caSToby Isaac     if (pEndMax >= 0) {
130be4c1c3eSMatthew G. Knepley       ierr = DMClone(dm->coordinateDM, &ncdm);CHKERRQ(ierr);
13113bffc4cSMatthew G. Knepley       ierr = DMSetDefaultSection(ncdm, cs);CHKERRQ(ierr);
132a61e840bSMatthew G. Knepley       ierr = DMSetCoordinateDM(*newdm, ncdm);CHKERRQ(ierr);
133be4c1c3eSMatthew G. Knepley       ierr = DMDestroy(&ncdm);CHKERRQ(ierr);
134be4c1c3eSMatthew G. Knepley     }
135be4c1c3eSMatthew G. Knepley   }
136*a3219837SMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
137*a3219837SMatthew G. Knepley   ierr = DMSetCoordinateDim(*newdm, cdim);CHKERRQ(ierr);
13838221697SMatthew G. Knepley   ierr = DMGetCoordinatesLocal(dm, &coords);CHKERRQ(ierr);
13938221697SMatthew G. Knepley   if (coords) {
14038221697SMatthew G. Knepley     ierr = DMSetCoordinatesLocal(*newdm, coords);CHKERRQ(ierr);
14138221697SMatthew G. Knepley   } else {
14238221697SMatthew G. Knepley     ierr = DMGetCoordinates(dm, &coords);CHKERRQ(ierr);
14338221697SMatthew G. Knepley     if (coords) {ierr = DMSetCoordinates(*newdm, coords);CHKERRQ(ierr);}
14438221697SMatthew G. Knepley   }
145c6b900c6SMatthew G. Knepley   if (dm->maxCell) {
146c6b900c6SMatthew G. Knepley     const PetscReal *maxCell, *L;
1475dc8c3f7SMatthew G. Knepley     const DMBoundaryType *bd;
1485dc8c3f7SMatthew G. Knepley     ierr = DMGetPeriodicity(dm,     &maxCell, &L, &bd);CHKERRQ(ierr);
1495dc8c3f7SMatthew G. Knepley     ierr = DMSetPeriodicity(*newdm,  maxCell,  L,  bd);CHKERRQ(ierr);
150c6b900c6SMatthew G. Knepley   }
15138221697SMatthew G. Knepley   PetscFunctionReturn(0);
15238221697SMatthew G. Knepley }
15338221697SMatthew G. Knepley 
1549a42bb27SBarry Smith /*@C
155564755cdSBarry Smith        DMSetVecType - Sets the type of vector created with DMCreateLocalVector() and DMCreateGlobalVector()
1569a42bb27SBarry Smith 
1578472ad0fSDave May    Logically Collective on DM
1589a42bb27SBarry Smith 
1599a42bb27SBarry Smith    Input Parameter:
1609a42bb27SBarry Smith +  da - initial distributed array
1618154be41SBarry Smith .  ctype - the vector type, currently either VECSTANDARD or VECCUSP
1629a42bb27SBarry Smith 
1639a42bb27SBarry Smith    Options Database:
164dd85299cSBarry Smith .   -dm_vec_type ctype
1659a42bb27SBarry Smith 
1669a42bb27SBarry Smith    Level: intermediate
1679a42bb27SBarry Smith 
1688472ad0fSDave May .seealso: DMCreate(), DMDestroy(), DM, DMDAInterpolationType, VecType, DMGetVecType()
1699a42bb27SBarry Smith @*/
17019fd82e9SBarry Smith PetscErrorCode  DMSetVecType(DM da,VecType ctype)
1719a42bb27SBarry Smith {
1729a42bb27SBarry Smith   PetscErrorCode ierr;
1739a42bb27SBarry Smith 
1749a42bb27SBarry Smith   PetscFunctionBegin;
1759a42bb27SBarry Smith   PetscValidHeaderSpecific(da,DM_CLASSID,1);
1769a42bb27SBarry Smith   ierr = PetscFree(da->vectype);CHKERRQ(ierr);
17719fd82e9SBarry Smith   ierr = PetscStrallocpy(ctype,(char**)&da->vectype);CHKERRQ(ierr);
1789a42bb27SBarry Smith   PetscFunctionReturn(0);
1799a42bb27SBarry Smith }
1809a42bb27SBarry Smith 
181c0dedaeaSBarry Smith /*@C
182c0dedaeaSBarry Smith        DMGetVecType - Gets the type of vector created with DMCreateLocalVector() and DMCreateGlobalVector()
183c0dedaeaSBarry Smith 
1848472ad0fSDave May    Logically Collective on DM
185c0dedaeaSBarry Smith 
186c0dedaeaSBarry Smith    Input Parameter:
187c0dedaeaSBarry Smith .  da - initial distributed array
188c0dedaeaSBarry Smith 
189c0dedaeaSBarry Smith    Output Parameter:
190c0dedaeaSBarry Smith .  ctype - the vector type
191c0dedaeaSBarry Smith 
192c0dedaeaSBarry Smith    Level: intermediate
193c0dedaeaSBarry Smith 
1948472ad0fSDave May .seealso: DMCreate(), DMDestroy(), DM, DMDAInterpolationType, VecType
195c0dedaeaSBarry Smith @*/
196c0dedaeaSBarry Smith PetscErrorCode  DMGetVecType(DM da,VecType *ctype)
197c0dedaeaSBarry Smith {
198c0dedaeaSBarry Smith   PetscFunctionBegin;
199c0dedaeaSBarry Smith   PetscValidHeaderSpecific(da,DM_CLASSID,1);
200c0dedaeaSBarry Smith   *ctype = da->vectype;
201c0dedaeaSBarry Smith   PetscFunctionReturn(0);
202c0dedaeaSBarry Smith }
203c0dedaeaSBarry Smith 
2045f1ad066SMatthew G Knepley /*@
20534f98d34SBarry Smith   VecGetDM - Gets the DM defining the data layout of the vector
2065f1ad066SMatthew G Knepley 
2075f1ad066SMatthew G Knepley   Not collective
2085f1ad066SMatthew G Knepley 
2095f1ad066SMatthew G Knepley   Input Parameter:
2105f1ad066SMatthew G Knepley . v - The Vec
2115f1ad066SMatthew G Knepley 
2125f1ad066SMatthew G Knepley   Output Parameter:
2135f1ad066SMatthew G Knepley . dm - The DM
2145f1ad066SMatthew G Knepley 
2155f1ad066SMatthew G Knepley   Level: intermediate
2165f1ad066SMatthew G Knepley 
2175f1ad066SMatthew G Knepley .seealso: VecSetDM(), DMGetLocalVector(), DMGetGlobalVector(), DMSetVecType()
2185f1ad066SMatthew G Knepley @*/
2195f1ad066SMatthew G Knepley PetscErrorCode VecGetDM(Vec v, DM *dm)
2205f1ad066SMatthew G Knepley {
2215f1ad066SMatthew G Knepley   PetscErrorCode ierr;
2225f1ad066SMatthew G Knepley 
2235f1ad066SMatthew G Knepley   PetscFunctionBegin;
2245f1ad066SMatthew G Knepley   PetscValidHeaderSpecific(v,VEC_CLASSID,1);
2255f1ad066SMatthew G Knepley   PetscValidPointer(dm,2);
2265f1ad066SMatthew G Knepley   ierr = PetscObjectQuery((PetscObject) v, "__PETSc_dm", (PetscObject*) dm);CHKERRQ(ierr);
2275f1ad066SMatthew G Knepley   PetscFunctionReturn(0);
2285f1ad066SMatthew G Knepley }
2295f1ad066SMatthew G Knepley 
2305f1ad066SMatthew G Knepley /*@
231d9805387SMatthew G. Knepley   VecSetDM - Sets the DM defining the data layout of the vector.
2325f1ad066SMatthew G Knepley 
2335f1ad066SMatthew G Knepley   Not collective
2345f1ad066SMatthew G Knepley 
2355f1ad066SMatthew G Knepley   Input Parameters:
2365f1ad066SMatthew G Knepley + v - The Vec
2375f1ad066SMatthew G Knepley - dm - The DM
2385f1ad066SMatthew G Knepley 
239d9805387SMatthew 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.
240d9805387SMatthew G. Knepley 
2415f1ad066SMatthew G Knepley   Level: intermediate
2425f1ad066SMatthew G Knepley 
2435f1ad066SMatthew G Knepley .seealso: VecGetDM(), DMGetLocalVector(), DMGetGlobalVector(), DMSetVecType()
2445f1ad066SMatthew G Knepley @*/
2455f1ad066SMatthew G Knepley PetscErrorCode VecSetDM(Vec v, DM dm)
2465f1ad066SMatthew G Knepley {
2475f1ad066SMatthew G Knepley   PetscErrorCode ierr;
2485f1ad066SMatthew G Knepley 
2495f1ad066SMatthew G Knepley   PetscFunctionBegin;
2505f1ad066SMatthew G Knepley   PetscValidHeaderSpecific(v,VEC_CLASSID,1);
251d7f50e27SLisandro Dalcin   if (dm) PetscValidHeaderSpecific(dm,DM_CLASSID,2);
2525f1ad066SMatthew G Knepley   ierr = PetscObjectCompose((PetscObject) v, "__PETSc_dm", (PetscObject) dm);CHKERRQ(ierr);
2535f1ad066SMatthew G Knepley   PetscFunctionReturn(0);
2545f1ad066SMatthew G Knepley }
2555f1ad066SMatthew G Knepley 
256521d9a4cSLisandro Dalcin /*@C
257521d9a4cSLisandro Dalcin        DMSetMatType - Sets the type of matrix created with DMCreateMatrix()
258521d9a4cSLisandro Dalcin 
259521d9a4cSLisandro Dalcin    Logically Collective on DM
260521d9a4cSLisandro Dalcin 
261521d9a4cSLisandro Dalcin    Input Parameter:
262521d9a4cSLisandro Dalcin +  dm - the DM context
263a2b5a043SBarry Smith -  ctype - the matrix type
264521d9a4cSLisandro Dalcin 
265521d9a4cSLisandro Dalcin    Options Database:
266521d9a4cSLisandro Dalcin .   -dm_mat_type ctype
267521d9a4cSLisandro Dalcin 
268521d9a4cSLisandro Dalcin    Level: intermediate
269521d9a4cSLisandro Dalcin 
270c0dedaeaSBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMGetMatType()
271521d9a4cSLisandro Dalcin @*/
27219fd82e9SBarry Smith PetscErrorCode  DMSetMatType(DM dm,MatType ctype)
273521d9a4cSLisandro Dalcin {
274521d9a4cSLisandro Dalcin   PetscErrorCode ierr;
27588f0584fSBarry Smith 
276521d9a4cSLisandro Dalcin   PetscFunctionBegin;
277521d9a4cSLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
278521d9a4cSLisandro Dalcin   ierr = PetscFree(dm->mattype);CHKERRQ(ierr);
27919fd82e9SBarry Smith   ierr = PetscStrallocpy(ctype,(char**)&dm->mattype);CHKERRQ(ierr);
280521d9a4cSLisandro Dalcin   PetscFunctionReturn(0);
281521d9a4cSLisandro Dalcin }
282521d9a4cSLisandro Dalcin 
283c0dedaeaSBarry Smith /*@C
284c0dedaeaSBarry Smith        DMGetMatType - Gets the type of matrix created with DMCreateMatrix()
285c0dedaeaSBarry Smith 
286c0dedaeaSBarry Smith    Logically Collective on DM
287c0dedaeaSBarry Smith 
288c0dedaeaSBarry Smith    Input Parameter:
289c0dedaeaSBarry Smith .  dm - the DM context
290c0dedaeaSBarry Smith 
291c0dedaeaSBarry Smith    Output Parameter:
292c0dedaeaSBarry Smith .  ctype - the matrix type
293c0dedaeaSBarry Smith 
294c0dedaeaSBarry Smith    Options Database:
295c0dedaeaSBarry Smith .   -dm_mat_type ctype
296c0dedaeaSBarry Smith 
297c0dedaeaSBarry Smith    Level: intermediate
298c0dedaeaSBarry Smith 
299c0dedaeaSBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMSetMatType()
300c0dedaeaSBarry Smith @*/
301c0dedaeaSBarry Smith PetscErrorCode  DMGetMatType(DM dm,MatType *ctype)
302c0dedaeaSBarry Smith {
303c0dedaeaSBarry Smith   PetscFunctionBegin;
304c0dedaeaSBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
305c0dedaeaSBarry Smith   *ctype = dm->mattype;
306c0dedaeaSBarry Smith   PetscFunctionReturn(0);
307c0dedaeaSBarry Smith }
308c0dedaeaSBarry Smith 
309c688c046SMatthew G Knepley /*@
31034f98d34SBarry Smith   MatGetDM - Gets the DM defining the data layout of the matrix
311c688c046SMatthew G Knepley 
312c688c046SMatthew G Knepley   Not collective
313c688c046SMatthew G Knepley 
314c688c046SMatthew G Knepley   Input Parameter:
315c688c046SMatthew G Knepley . A - The Mat
316c688c046SMatthew G Knepley 
317c688c046SMatthew G Knepley   Output Parameter:
318c688c046SMatthew G Knepley . dm - The DM
319c688c046SMatthew G Knepley 
320c688c046SMatthew G Knepley   Level: intermediate
321c688c046SMatthew G Knepley 
322c688c046SMatthew G Knepley .seealso: MatSetDM(), DMCreateMatrix(), DMSetMatType()
323c688c046SMatthew G Knepley @*/
324c688c046SMatthew G Knepley PetscErrorCode MatGetDM(Mat A, DM *dm)
325c688c046SMatthew G Knepley {
326c688c046SMatthew G Knepley   PetscErrorCode ierr;
327c688c046SMatthew G Knepley 
328c688c046SMatthew G Knepley   PetscFunctionBegin;
329c688c046SMatthew G Knepley   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
330c688c046SMatthew G Knepley   PetscValidPointer(dm,2);
331c688c046SMatthew G Knepley   ierr = PetscObjectQuery((PetscObject) A, "__PETSc_dm", (PetscObject*) dm);CHKERRQ(ierr);
332c688c046SMatthew G Knepley   PetscFunctionReturn(0);
333c688c046SMatthew G Knepley }
334c688c046SMatthew G Knepley 
335c688c046SMatthew G Knepley /*@
336c688c046SMatthew G Knepley   MatSetDM - Sets the DM defining the data layout of the matrix
337c688c046SMatthew G Knepley 
338c688c046SMatthew G Knepley   Not collective
339c688c046SMatthew G Knepley 
340c688c046SMatthew G Knepley   Input Parameters:
341c688c046SMatthew G Knepley + A - The Mat
342c688c046SMatthew G Knepley - dm - The DM
343c688c046SMatthew G Knepley 
344c688c046SMatthew G Knepley   Level: intermediate
345c688c046SMatthew G Knepley 
346c688c046SMatthew G Knepley .seealso: MatGetDM(), DMCreateMatrix(), DMSetMatType()
347c688c046SMatthew G Knepley @*/
348c688c046SMatthew G Knepley PetscErrorCode MatSetDM(Mat A, DM dm)
349c688c046SMatthew G Knepley {
350c688c046SMatthew G Knepley   PetscErrorCode ierr;
351c688c046SMatthew G Knepley 
352c688c046SMatthew G Knepley   PetscFunctionBegin;
353c688c046SMatthew G Knepley   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
3548865f1eaSKarl Rupp   if (dm) PetscValidHeaderSpecific(dm,DM_CLASSID,2);
355c688c046SMatthew G Knepley   ierr = PetscObjectCompose((PetscObject) A, "__PETSc_dm", (PetscObject) dm);CHKERRQ(ierr);
356c688c046SMatthew G Knepley   PetscFunctionReturn(0);
357c688c046SMatthew G Knepley }
358c688c046SMatthew G Knepley 
3599a42bb27SBarry Smith /*@C
3609a42bb27SBarry Smith    DMSetOptionsPrefix - Sets the prefix used for searching for all
3616757b960SDave May    DM options in the database.
3629a42bb27SBarry Smith 
3638353ddbbSDave May    Logically Collective on DM
3649a42bb27SBarry Smith 
3659a42bb27SBarry Smith    Input Parameter:
3668353ddbbSDave May +  da - the DM context
3679a42bb27SBarry Smith -  prefix - the prefix to prepend to all option names
3689a42bb27SBarry Smith 
3699a42bb27SBarry Smith    Notes:
3709a42bb27SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
3719a42bb27SBarry Smith    The first character of all runtime options is AUTOMATICALLY the hyphen.
3729a42bb27SBarry Smith 
3739a42bb27SBarry Smith    Level: advanced
3749a42bb27SBarry Smith 
3758353ddbbSDave May .keywords: DM, set, options, prefix, database
3769a42bb27SBarry Smith 
3779a42bb27SBarry Smith .seealso: DMSetFromOptions()
3789a42bb27SBarry Smith @*/
3797087cfbeSBarry Smith PetscErrorCode  DMSetOptionsPrefix(DM dm,const char prefix[])
3809a42bb27SBarry Smith {
3819a42bb27SBarry Smith   PetscErrorCode ierr;
3829a42bb27SBarry Smith 
3839a42bb27SBarry Smith   PetscFunctionBegin;
3849a42bb27SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3859a42bb27SBarry Smith   ierr = PetscObjectSetOptionsPrefix((PetscObject)dm,prefix);CHKERRQ(ierr);
386691be533SLawrence Mitchell   if (dm->sf) {
387691be533SLawrence Mitchell     ierr = PetscObjectSetOptionsPrefix((PetscObject)dm->sf,prefix);CHKERRQ(ierr);
388691be533SLawrence Mitchell   }
389691be533SLawrence Mitchell   if (dm->defaultSF) {
390691be533SLawrence Mitchell     ierr = PetscObjectSetOptionsPrefix((PetscObject)dm->defaultSF,prefix);CHKERRQ(ierr);
391691be533SLawrence Mitchell   }
3929a42bb27SBarry Smith   PetscFunctionReturn(0);
3939a42bb27SBarry Smith }
3949a42bb27SBarry Smith 
39531697293SDave May /*@C
39631697293SDave May    DMAppendOptionsPrefix - Appends to the prefix used for searching for all
39731697293SDave May    DM options in the database.
39831697293SDave May 
39931697293SDave May    Logically Collective on DM
40031697293SDave May 
40131697293SDave May    Input Parameters:
40231697293SDave May +  dm - the DM context
40331697293SDave May -  prefix - the prefix string to prepend to all DM option requests
40431697293SDave May 
40531697293SDave May    Notes:
40631697293SDave May    A hyphen (-) must NOT be given at the beginning of the prefix name.
40731697293SDave May    The first character of all runtime options is AUTOMATICALLY the hyphen.
40831697293SDave May 
40931697293SDave May    Level: advanced
41031697293SDave May 
41131697293SDave May .keywords: DM, append, options, prefix, database
41231697293SDave May 
41331697293SDave May .seealso: DMSetOptionsPrefix(), DMGetOptionsPrefix()
41431697293SDave May @*/
41531697293SDave May PetscErrorCode  DMAppendOptionsPrefix(DM dm,const char prefix[])
41631697293SDave May {
41731697293SDave May   PetscErrorCode ierr;
41831697293SDave May 
41931697293SDave May   PetscFunctionBegin;
42031697293SDave May   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
42131697293SDave May   ierr = PetscObjectAppendOptionsPrefix((PetscObject)dm,prefix);CHKERRQ(ierr);
42231697293SDave May   PetscFunctionReturn(0);
42331697293SDave May }
42431697293SDave May 
42531697293SDave May /*@C
42631697293SDave May    DMGetOptionsPrefix - Gets the prefix used for searching for all
42731697293SDave May    DM options in the database.
42831697293SDave May 
42931697293SDave May    Not Collective
43031697293SDave May 
43131697293SDave May    Input Parameters:
43231697293SDave May .  dm - the DM context
43331697293SDave May 
43431697293SDave May    Output Parameters:
43531697293SDave May .  prefix - pointer to the prefix string used is returned
43631697293SDave May 
43731697293SDave May    Notes: On the fortran side, the user should pass in a string 'prefix' of
43831697293SDave May    sufficient length to hold the prefix.
43931697293SDave May 
44031697293SDave May    Level: advanced
44131697293SDave May 
44231697293SDave May .keywords: DM, set, options, prefix, database
44331697293SDave May 
44431697293SDave May .seealso: DMSetOptionsPrefix(), DMAppendOptionsPrefix()
44531697293SDave May @*/
44631697293SDave May PetscErrorCode  DMGetOptionsPrefix(DM dm,const char *prefix[])
44731697293SDave May {
44831697293SDave May   PetscErrorCode ierr;
44931697293SDave May 
45031697293SDave May   PetscFunctionBegin;
45131697293SDave May   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
45231697293SDave May   ierr = PetscObjectGetOptionsPrefix((PetscObject)dm,prefix);CHKERRQ(ierr);
45331697293SDave May   PetscFunctionReturn(0);
45431697293SDave May }
45531697293SDave May 
45688bdff64SToby Isaac static PetscErrorCode DMCountNonCyclicReferences(DM dm, PetscBool recurseCoarse, PetscBool recurseFine, PetscInt *ncrefct)
45788bdff64SToby Isaac {
45888bdff64SToby Isaac   PetscInt i, refct = ((PetscObject) dm)->refct;
45988bdff64SToby Isaac   DMNamedVecLink nlink;
46088bdff64SToby Isaac   PetscErrorCode ierr;
46188bdff64SToby Isaac 
46288bdff64SToby Isaac   PetscFunctionBegin;
46388bdff64SToby Isaac   /* count all the circular references of DM and its contained Vecs */
46488bdff64SToby Isaac   for (i=0; i<DM_MAX_WORK_VECTORS; i++) {
46588bdff64SToby Isaac     if (dm->localin[i])  refct--;
46688bdff64SToby Isaac     if (dm->globalin[i]) refct--;
46788bdff64SToby Isaac   }
46888bdff64SToby Isaac   for (nlink=dm->namedglobal; nlink; nlink=nlink->next) refct--;
46988bdff64SToby Isaac   for (nlink=dm->namedlocal; nlink; nlink=nlink->next) refct--;
47088bdff64SToby Isaac   if (dm->x) {
47188bdff64SToby Isaac     DM obj;
47288bdff64SToby Isaac     ierr = VecGetDM(dm->x, &obj);CHKERRQ(ierr);
47388bdff64SToby Isaac     if (obj == dm) refct--;
47488bdff64SToby Isaac   }
47588bdff64SToby Isaac   if (dm->coarseMesh && dm->coarseMesh->fineMesh == dm) {
47688bdff64SToby Isaac     refct--;
47788bdff64SToby Isaac     if (recurseCoarse) {
47888bdff64SToby Isaac       PetscInt coarseCount;
47988bdff64SToby Isaac 
48088bdff64SToby Isaac       ierr = DMCountNonCyclicReferences(dm->coarseMesh, PETSC_TRUE, PETSC_FALSE,&coarseCount);CHKERRQ(ierr);
48188bdff64SToby Isaac       refct += coarseCount;
48288bdff64SToby Isaac     }
48388bdff64SToby Isaac   }
48488bdff64SToby Isaac   if (dm->fineMesh && dm->fineMesh->coarseMesh == dm) {
48588bdff64SToby Isaac     refct--;
48688bdff64SToby Isaac     if (recurseFine) {
48788bdff64SToby Isaac       PetscInt fineCount;
48888bdff64SToby Isaac 
48988bdff64SToby Isaac       ierr = DMCountNonCyclicReferences(dm->fineMesh, PETSC_FALSE, PETSC_TRUE,&fineCount);CHKERRQ(ierr);
49088bdff64SToby Isaac       refct += fineCount;
49188bdff64SToby Isaac     }
49288bdff64SToby Isaac   }
49388bdff64SToby Isaac   *ncrefct = refct;
49488bdff64SToby Isaac   PetscFunctionReturn(0);
49588bdff64SToby Isaac }
49688bdff64SToby Isaac 
497354557abSToby Isaac PetscErrorCode DMDestroyLabelLinkList(DM dm)
498354557abSToby Isaac {
499354557abSToby Isaac   PetscErrorCode ierr;
500354557abSToby Isaac 
501354557abSToby Isaac   PetscFunctionBegin;
502354557abSToby Isaac   if (!--(dm->labels->refct)) {
503354557abSToby Isaac     DMLabelLink next = dm->labels->next;
504354557abSToby Isaac 
505354557abSToby Isaac     /* destroy the labels */
506354557abSToby Isaac     while (next) {
507354557abSToby Isaac       DMLabelLink tmp = next->next;
508354557abSToby Isaac 
509354557abSToby Isaac       ierr = DMLabelDestroy(&next->label);CHKERRQ(ierr);
510354557abSToby Isaac       ierr = PetscFree(next);CHKERRQ(ierr);
511354557abSToby Isaac       next = tmp;
512354557abSToby Isaac     }
513354557abSToby Isaac     ierr = PetscFree(dm->labels);CHKERRQ(ierr);
514354557abSToby Isaac   }
515354557abSToby Isaac   PetscFunctionReturn(0);
516354557abSToby Isaac }
517354557abSToby Isaac 
51847c6ae99SBarry Smith /*@
5198472ad0fSDave May     DMDestroy - Destroys a vector packer or DM.
52047c6ae99SBarry Smith 
52147c6ae99SBarry Smith     Collective on DM
52247c6ae99SBarry Smith 
52347c6ae99SBarry Smith     Input Parameter:
52447c6ae99SBarry Smith .   dm - the DM object to destroy
52547c6ae99SBarry Smith 
52647c6ae99SBarry Smith     Level: developer
52747c6ae99SBarry Smith 
528e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
52947c6ae99SBarry Smith 
53047c6ae99SBarry Smith @*/
531fcfd50ebSBarry Smith PetscErrorCode  DMDestroy(DM *dm)
53247c6ae99SBarry Smith {
53388bdff64SToby Isaac   PetscInt       i, cnt;
534dfe15315SJed Brown   DMNamedVecLink nlink,nnext;
53547c6ae99SBarry Smith   PetscErrorCode ierr;
53647c6ae99SBarry Smith 
53747c6ae99SBarry Smith   PetscFunctionBegin;
5386bf464f9SBarry Smith   if (!*dm) PetscFunctionReturn(0);
5396bf464f9SBarry Smith   PetscValidHeaderSpecific((*dm),DM_CLASSID,1);
54087e657c6SBarry Smith 
54188bdff64SToby Isaac   /* count all non-cyclic references in the doubly-linked list of coarse<->fine meshes */
54288bdff64SToby Isaac   ierr = DMCountNonCyclicReferences(*dm,PETSC_TRUE,PETSC_TRUE,&cnt);CHKERRQ(ierr);
54388bdff64SToby Isaac   --((PetscObject)(*dm))->refct;
54488bdff64SToby Isaac   if (--cnt > 0) {*dm = 0; PetscFunctionReturn(0);}
545732e2eb9SMatthew G Knepley   /*
546732e2eb9SMatthew G Knepley      Need this test because the dm references the vectors that
547732e2eb9SMatthew G Knepley      reference the dm, so destroying the dm calls destroy on the
548732e2eb9SMatthew G Knepley      vectors that cause another destroy on the dm
549732e2eb9SMatthew G Knepley   */
5506bf464f9SBarry Smith   if (((PetscObject)(*dm))->refct < 0) PetscFunctionReturn(0);
5516bf464f9SBarry Smith   ((PetscObject) (*dm))->refct = 0;
552732e2eb9SMatthew G Knepley   for (i=0; i<DM_MAX_WORK_VECTORS; i++) {
5536bf464f9SBarry Smith     if ((*dm)->localout[i]) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Destroying a DM that has a local vector obtained with DMGetLocalVector()");
5546bf464f9SBarry Smith     ierr = VecDestroy(&(*dm)->localin[i]);CHKERRQ(ierr);
555732e2eb9SMatthew G Knepley   }
556f490541aSPeter Brune   nnext=(*dm)->namedglobal;
5570298fd71SBarry Smith   (*dm)->namedglobal = NULL;
558f490541aSPeter Brune   for (nlink=nnext; nlink; nlink=nnext) { /* Destroy the named vectors */
5592348bcf4SPeter Brune     nnext = nlink->next;
5602348bcf4SPeter 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);
5612348bcf4SPeter Brune     ierr = PetscFree(nlink->name);CHKERRQ(ierr);
5622348bcf4SPeter Brune     ierr = VecDestroy(&nlink->X);CHKERRQ(ierr);
5632348bcf4SPeter Brune     ierr = PetscFree(nlink);CHKERRQ(ierr);
5642348bcf4SPeter Brune   }
565f490541aSPeter Brune   nnext=(*dm)->namedlocal;
5660298fd71SBarry Smith   (*dm)->namedlocal = NULL;
567f490541aSPeter Brune   for (nlink=nnext; nlink; nlink=nnext) { /* Destroy the named local vectors */
568f490541aSPeter Brune     nnext = nlink->next;
569f490541aSPeter 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);
570f490541aSPeter Brune     ierr = PetscFree(nlink->name);CHKERRQ(ierr);
571f490541aSPeter Brune     ierr = VecDestroy(&nlink->X);CHKERRQ(ierr);
572f490541aSPeter Brune     ierr = PetscFree(nlink);CHKERRQ(ierr);
573f490541aSPeter Brune   }
5742348bcf4SPeter Brune 
575b17ce1afSJed Brown   /* Destroy the list of hooks */
576c833c3b5SJed Brown   {
577c833c3b5SJed Brown     DMCoarsenHookLink link,next;
578b17ce1afSJed Brown     for (link=(*dm)->coarsenhook; link; link=next) {
579b17ce1afSJed Brown       next = link->next;
580b17ce1afSJed Brown       ierr = PetscFree(link);CHKERRQ(ierr);
581b17ce1afSJed Brown     }
5820298fd71SBarry Smith     (*dm)->coarsenhook = NULL;
583c833c3b5SJed Brown   }
584c833c3b5SJed Brown   {
585c833c3b5SJed Brown     DMRefineHookLink link,next;
586c833c3b5SJed Brown     for (link=(*dm)->refinehook; link; link=next) {
587c833c3b5SJed Brown       next = link->next;
588c833c3b5SJed Brown       ierr = PetscFree(link);CHKERRQ(ierr);
589c833c3b5SJed Brown     }
5900298fd71SBarry Smith     (*dm)->refinehook = NULL;
591c833c3b5SJed Brown   }
592be081cd6SPeter Brune   {
593be081cd6SPeter Brune     DMSubDomainHookLink link,next;
594be081cd6SPeter Brune     for (link=(*dm)->subdomainhook; link; link=next) {
595be081cd6SPeter Brune       next = link->next;
596be081cd6SPeter Brune       ierr = PetscFree(link);CHKERRQ(ierr);
597be081cd6SPeter Brune     }
5980298fd71SBarry Smith     (*dm)->subdomainhook = NULL;
599be081cd6SPeter Brune   }
600baf369e7SPeter Brune   {
601baf369e7SPeter Brune     DMGlobalToLocalHookLink link,next;
602baf369e7SPeter Brune     for (link=(*dm)->gtolhook; link; link=next) {
603baf369e7SPeter Brune       next = link->next;
604baf369e7SPeter Brune       ierr = PetscFree(link);CHKERRQ(ierr);
605baf369e7SPeter Brune     }
6060298fd71SBarry Smith     (*dm)->gtolhook = NULL;
607baf369e7SPeter Brune   }
608d4d07f1eSToby Isaac   {
609d4d07f1eSToby Isaac     DMLocalToGlobalHookLink link,next;
610d4d07f1eSToby Isaac     for (link=(*dm)->ltoghook; link; link=next) {
611d4d07f1eSToby Isaac       next = link->next;
612d4d07f1eSToby Isaac       ierr = PetscFree(link);CHKERRQ(ierr);
613d4d07f1eSToby Isaac     }
614d4d07f1eSToby Isaac     (*dm)->ltoghook = NULL;
615d4d07f1eSToby Isaac   }
616aa1993deSMatthew G Knepley   /* Destroy the work arrays */
617aa1993deSMatthew G Knepley   {
618aa1993deSMatthew G Knepley     DMWorkLink link,next;
619aa1993deSMatthew G Knepley     if ((*dm)->workout) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Work array still checked out");
620aa1993deSMatthew G Knepley     for (link=(*dm)->workin; link; link=next) {
621aa1993deSMatthew G Knepley       next = link->next;
622aa1993deSMatthew G Knepley       ierr = PetscFree(link->mem);CHKERRQ(ierr);
623aa1993deSMatthew G Knepley       ierr = PetscFree(link);CHKERRQ(ierr);
624aa1993deSMatthew G Knepley     }
6250298fd71SBarry Smith     (*dm)->workin = NULL;
626aa1993deSMatthew G Knepley   }
627c58f1c22SToby Isaac   if (!--((*dm)->labels->refct)) {
628c58f1c22SToby Isaac     DMLabelLink next = (*dm)->labels->next;
629c58f1c22SToby Isaac 
630c58f1c22SToby Isaac     /* destroy the labels */
631c58f1c22SToby Isaac     while (next) {
632c58f1c22SToby Isaac       DMLabelLink tmp = next->next;
633c58f1c22SToby Isaac 
634c58f1c22SToby Isaac       ierr = DMLabelDestroy(&next->label);CHKERRQ(ierr);
635c58f1c22SToby Isaac       ierr = PetscFree(next);CHKERRQ(ierr);
636c58f1c22SToby Isaac       next = tmp;
637c58f1c22SToby Isaac     }
638c58f1c22SToby Isaac     ierr = PetscFree((*dm)->labels);CHKERRQ(ierr);
639c58f1c22SToby Isaac   }
640e6f8dbb6SToby Isaac   {
641e6f8dbb6SToby Isaac     DMBoundary next = (*dm)->boundary;
642e6f8dbb6SToby Isaac     while (next) {
643e6f8dbb6SToby Isaac       DMBoundary b = next;
644e6f8dbb6SToby Isaac 
645e6f8dbb6SToby Isaac       next = b->next;
646e6f8dbb6SToby Isaac       ierr = PetscFree(b);CHKERRQ(ierr);
647e6f8dbb6SToby Isaac     }
648e6f8dbb6SToby Isaac   }
649b17ce1afSJed Brown 
65052536dc3SBarry Smith   ierr = PetscObjectDestroy(&(*dm)->dmksp);CHKERRQ(ierr);
65152536dc3SBarry Smith   ierr = PetscObjectDestroy(&(*dm)->dmsnes);CHKERRQ(ierr);
65252536dc3SBarry Smith   ierr = PetscObjectDestroy(&(*dm)->dmts);CHKERRQ(ierr);
65352536dc3SBarry Smith 
6541a266240SBarry Smith   if ((*dm)->ctx && (*dm)->ctxdestroy) {
6551a266240SBarry Smith     ierr = (*(*dm)->ctxdestroy)(&(*dm)->ctx);CHKERRQ(ierr);
6561a266240SBarry Smith   }
65787e657c6SBarry Smith   ierr = VecDestroy(&(*dm)->x);CHKERRQ(ierr);
65871cd77b2SBarry Smith   ierr = MatFDColoringDestroy(&(*dm)->fd);CHKERRQ(ierr);
6594dcab191SBarry Smith   ierr = DMClearGlobalVectors(*dm);CHKERRQ(ierr);
6606bf464f9SBarry Smith   ierr = ISLocalToGlobalMappingDestroy(&(*dm)->ltogmap);CHKERRQ(ierr);
6616bf464f9SBarry Smith   ierr = PetscFree((*dm)->vectype);CHKERRQ(ierr);
662073dac72SJed Brown   ierr = PetscFree((*dm)->mattype);CHKERRQ(ierr);
66388ed4aceSMatthew G Knepley 
66488ed4aceSMatthew G Knepley   ierr = PetscSectionDestroy(&(*dm)->defaultSection);CHKERRQ(ierr);
66588ed4aceSMatthew G Knepley   ierr = PetscSectionDestroy(&(*dm)->defaultGlobalSection);CHKERRQ(ierr);
6668b1ab98fSJed Brown   ierr = PetscLayoutDestroy(&(*dm)->map);CHKERRQ(ierr);
667fba222abSToby Isaac   ierr = PetscSectionDestroy(&(*dm)->defaultConstraintSection);CHKERRQ(ierr);
668fba222abSToby Isaac   ierr = MatDestroy(&(*dm)->defaultConstraintMat);CHKERRQ(ierr);
66988ed4aceSMatthew G Knepley   ierr = PetscSFDestroy(&(*dm)->sf);CHKERRQ(ierr);
67088ed4aceSMatthew G Knepley   ierr = PetscSFDestroy(&(*dm)->defaultSF);CHKERRQ(ierr);
6718e4ac7eaSMatthew G. Knepley   ierr = PetscSFDestroy(&(*dm)->sfNatural);CHKERRQ(ierr);
672af122d2aSMatthew G Knepley 
67388bdff64SToby Isaac   if ((*dm)->coarseMesh && (*dm)->coarseMesh->fineMesh == *dm) {
67488bdff64SToby Isaac     ierr = DMSetFineDM((*dm)->coarseMesh,NULL);CHKERRQ(ierr);
67588bdff64SToby Isaac   }
676a8fb8f29SToby Isaac   ierr = DMDestroy(&(*dm)->coarseMesh);CHKERRQ(ierr);
67788bdff64SToby Isaac   if ((*dm)->fineMesh && (*dm)->fineMesh->coarseMesh == *dm) {
67888bdff64SToby Isaac     ierr = DMSetCoarseDM((*dm)->fineMesh,NULL);CHKERRQ(ierr);
67988bdff64SToby Isaac   }
68088bdff64SToby Isaac   ierr = DMDestroy(&(*dm)->fineMesh);CHKERRQ(ierr);
6816636e97aSMatthew G Knepley   ierr = DMDestroy(&(*dm)->coordinateDM);CHKERRQ(ierr);
6826636e97aSMatthew G Knepley   ierr = VecDestroy(&(*dm)->coordinates);CHKERRQ(ierr);
6836636e97aSMatthew G Knepley   ierr = VecDestroy(&(*dm)->coordinatesLocal);CHKERRQ(ierr);
6845dc8c3f7SMatthew G. Knepley   ierr = PetscFree3((*dm)->L,(*dm)->maxCell,(*dm)->bdtype);CHKERRQ(ierr);
6856636e97aSMatthew G Knepley 
6862764a2aaSMatthew G. Knepley   ierr = PetscDSDestroy(&(*dm)->prob);CHKERRQ(ierr);
68714f150ffSMatthew G. Knepley   ierr = DMDestroy(&(*dm)->dmBC);CHKERRQ(ierr);
688e04113cfSBarry Smith   /* if memory was published with SAWs then destroy it */
689e04113cfSBarry Smith   ierr = PetscObjectSAWsViewOff((PetscObject)*dm);CHKERRQ(ierr);
690732e2eb9SMatthew G Knepley 
6916bf464f9SBarry Smith   ierr = (*(*dm)->ops->destroy)(*dm);CHKERRQ(ierr);
692435a35e8SMatthew G Knepley   /* We do not destroy (*dm)->data here so that we can reference count backend objects */
693732e2eb9SMatthew G Knepley   ierr = PetscHeaderDestroy(dm);CHKERRQ(ierr);
69447c6ae99SBarry Smith   PetscFunctionReturn(0);
69547c6ae99SBarry Smith }
69647c6ae99SBarry Smith 
697d7bf68aeSBarry Smith /*@
698d7bf68aeSBarry Smith     DMSetUp - sets up the data structures inside a DM object
699d7bf68aeSBarry Smith 
700d7bf68aeSBarry Smith     Collective on DM
701d7bf68aeSBarry Smith 
702d7bf68aeSBarry Smith     Input Parameter:
703d7bf68aeSBarry Smith .   dm - the DM object to setup
704d7bf68aeSBarry Smith 
705d7bf68aeSBarry Smith     Level: developer
706d7bf68aeSBarry Smith 
707e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
708d7bf68aeSBarry Smith 
709d7bf68aeSBarry Smith @*/
7107087cfbeSBarry Smith PetscErrorCode  DMSetUp(DM dm)
711d7bf68aeSBarry Smith {
712d7bf68aeSBarry Smith   PetscErrorCode ierr;
713d7bf68aeSBarry Smith 
714d7bf68aeSBarry Smith   PetscFunctionBegin;
715171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
7168387afaaSJed Brown   if (dm->setupcalled) PetscFunctionReturn(0);
717d7bf68aeSBarry Smith   if (dm->ops->setup) {
718d7bf68aeSBarry Smith     ierr = (*dm->ops->setup)(dm);CHKERRQ(ierr);
719d7bf68aeSBarry Smith   }
7208387afaaSJed Brown   dm->setupcalled = PETSC_TRUE;
721d7bf68aeSBarry Smith   PetscFunctionReturn(0);
722d7bf68aeSBarry Smith }
723d7bf68aeSBarry Smith 
724d7bf68aeSBarry Smith /*@
725d7bf68aeSBarry Smith     DMSetFromOptions - sets parameters in a DM from the options database
726d7bf68aeSBarry Smith 
727d7bf68aeSBarry Smith     Collective on DM
728d7bf68aeSBarry Smith 
729d7bf68aeSBarry Smith     Input Parameter:
730d7bf68aeSBarry Smith .   dm - the DM object to set options for
731d7bf68aeSBarry Smith 
732732e2eb9SMatthew G Knepley     Options Database:
7334164ae61SDominic Meiser +   -dm_preallocate_only - Only preallocate the matrix for DMCreateMatrix(), but do not fill it with zeros
7344164ae61SDominic Meiser .   -dm_vec_type <type>  - type of vector to create inside DM
7354164ae61SDominic Meiser .   -dm_mat_type <type>  - type of matrix to create inside DM
7364164ae61SDominic Meiser -   -dm_coloring_type    - <global or ghosted>
737732e2eb9SMatthew G Knepley 
738d7bf68aeSBarry Smith     Level: developer
739d7bf68aeSBarry Smith 
740e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
741d7bf68aeSBarry Smith 
742d7bf68aeSBarry Smith @*/
7437087cfbeSBarry Smith PetscErrorCode  DMSetFromOptions(DM dm)
744d7bf68aeSBarry Smith {
7457781c08eSBarry Smith   char           typeName[256];
746ca266f36SBarry Smith   PetscBool      flg;
747d7bf68aeSBarry Smith   PetscErrorCode ierr;
748d7bf68aeSBarry Smith 
749d7bf68aeSBarry Smith   PetscFunctionBegin;
750171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
751f1fd5e65SToby Isaac   if (dm->prob) {
752f1fd5e65SToby Isaac     ierr = PetscDSSetFromOptions(dm->prob);CHKERRQ(ierr);
753f1fd5e65SToby Isaac   }
754691be533SLawrence Mitchell   if (dm->sf) {
755691be533SLawrence Mitchell     ierr = PetscSFSetFromOptions(dm->sf);CHKERRQ(ierr);
756691be533SLawrence Mitchell   }
757691be533SLawrence Mitchell   if (dm->defaultSF) {
758691be533SLawrence Mitchell     ierr = PetscSFSetFromOptions(dm->defaultSF);CHKERRQ(ierr);
759691be533SLawrence Mitchell   }
7603194b578SJed Brown   ierr = PetscObjectOptionsBegin((PetscObject)dm);CHKERRQ(ierr);
7610298fd71SBarry 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);
762a264d7a6SBarry Smith   ierr = PetscOptionsFList("-dm_vec_type","Vector type used for created vectors","DMSetVecType",VecList,dm->vectype,typeName,256,&flg);CHKERRQ(ierr);
763f9ba7244SBarry Smith   if (flg) {
764f9ba7244SBarry Smith     ierr = DMSetVecType(dm,typeName);CHKERRQ(ierr);
765f9ba7244SBarry Smith   }
766a264d7a6SBarry 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);
767073dac72SJed Brown   if (flg) {
768521d9a4cSLisandro Dalcin     ierr = DMSetMatType(dm,typeName);CHKERRQ(ierr);
769073dac72SJed Brown   }
7700298fd71SBarry Smith   ierr = PetscOptionsEnum("-dm_is_coloring_type","Global or local coloring of Jacobian","ISColoringType",ISColoringTypes,(PetscEnum)dm->coloringtype,(PetscEnum*)&dm->coloringtype,NULL);CHKERRQ(ierr);
771f9ba7244SBarry Smith   if (dm->ops->setfromoptions) {
772e55864a3SBarry Smith     ierr = (*dm->ops->setfromoptions)(PetscOptionsObject,dm);CHKERRQ(ierr);
773f9ba7244SBarry Smith   }
774f9ba7244SBarry Smith   /* process any options handlers added with PetscObjectAddOptionsHandler() */
7750633abcbSJed Brown   ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject) dm);CHKERRQ(ierr);
77682fcb398SMatthew G Knepley   ierr = PetscOptionsEnd();CHKERRQ(ierr);
777d7bf68aeSBarry Smith   PetscFunctionReturn(0);
778d7bf68aeSBarry Smith }
779d7bf68aeSBarry Smith 
780fc9bc008SSatish Balay /*@C
781224748a4SBarry Smith     DMView - Views a DM
78247c6ae99SBarry Smith 
78347c6ae99SBarry Smith     Collective on DM
78447c6ae99SBarry Smith 
78547c6ae99SBarry Smith     Input Parameter:
78647c6ae99SBarry Smith +   dm - the DM object to view
78747c6ae99SBarry Smith -   v - the viewer
78847c6ae99SBarry Smith 
789224748a4SBarry Smith     Level: beginner
79047c6ae99SBarry Smith 
791e727c939SJed Brown .seealso DMDestroy(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
79247c6ae99SBarry Smith 
79347c6ae99SBarry Smith @*/
7947087cfbeSBarry Smith PetscErrorCode  DMView(DM dm,PetscViewer v)
79547c6ae99SBarry Smith {
79647c6ae99SBarry Smith   PetscErrorCode ierr;
79732c0f0efSBarry Smith   PetscBool      isbinary;
79847c6ae99SBarry Smith 
79947c6ae99SBarry Smith   PetscFunctionBegin;
800171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
8013014e516SBarry Smith   if (!v) {
802ce94432eSBarry Smith     ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)dm),&v);CHKERRQ(ierr);
8033014e516SBarry Smith   }
80498c3331eSBarry Smith   ierr = PetscObjectPrintClassNamePrefixType((PetscObject)dm,v);CHKERRQ(ierr);
80532c0f0efSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)v,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
80632c0f0efSBarry Smith   if (isbinary) {
80755849f57SBarry Smith     PetscInt classid = DM_FILE_CLASSID;
80832c0f0efSBarry Smith     char     type[256];
80932c0f0efSBarry Smith 
81032c0f0efSBarry Smith     ierr = PetscViewerBinaryWrite(v,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
81132c0f0efSBarry Smith     ierr = PetscStrncpy(type,((PetscObject)dm)->type_name,256);CHKERRQ(ierr);
81232c0f0efSBarry Smith     ierr = PetscViewerBinaryWrite(v,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr);
81332c0f0efSBarry Smith   }
8140c010503SBarry Smith   if (dm->ops->view) {
8150c010503SBarry Smith     ierr = (*dm->ops->view)(dm,v);CHKERRQ(ierr);
81647c6ae99SBarry Smith   }
81747c6ae99SBarry Smith   PetscFunctionReturn(0);
81847c6ae99SBarry Smith }
81947c6ae99SBarry Smith 
82047c6ae99SBarry Smith /*@
8218472ad0fSDave May     DMCreateGlobalVector - Creates a global vector from a DM object
82247c6ae99SBarry Smith 
82347c6ae99SBarry Smith     Collective on DM
82447c6ae99SBarry Smith 
82547c6ae99SBarry Smith     Input Parameter:
82647c6ae99SBarry Smith .   dm - the DM object
82747c6ae99SBarry Smith 
82847c6ae99SBarry Smith     Output Parameter:
82947c6ae99SBarry Smith .   vec - the global vector
83047c6ae99SBarry Smith 
831073dac72SJed Brown     Level: beginner
83247c6ae99SBarry Smith 
833e727c939SJed Brown .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
83447c6ae99SBarry Smith 
83547c6ae99SBarry Smith @*/
8367087cfbeSBarry Smith PetscErrorCode  DMCreateGlobalVector(DM dm,Vec *vec)
83747c6ae99SBarry Smith {
83847c6ae99SBarry Smith   PetscErrorCode ierr;
83947c6ae99SBarry Smith 
84047c6ae99SBarry Smith   PetscFunctionBegin;
841171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
84247c6ae99SBarry Smith   ierr = (*dm->ops->createglobalvector)(dm,vec);CHKERRQ(ierr);
84347c6ae99SBarry Smith   PetscFunctionReturn(0);
84447c6ae99SBarry Smith }
84547c6ae99SBarry Smith 
84647c6ae99SBarry Smith /*@
8478472ad0fSDave May     DMCreateLocalVector - Creates a local vector from a DM object
84847c6ae99SBarry Smith 
84947c6ae99SBarry Smith     Not Collective
85047c6ae99SBarry Smith 
85147c6ae99SBarry Smith     Input Parameter:
85247c6ae99SBarry Smith .   dm - the DM object
85347c6ae99SBarry Smith 
85447c6ae99SBarry Smith     Output Parameter:
85547c6ae99SBarry Smith .   vec - the local vector
85647c6ae99SBarry Smith 
857073dac72SJed Brown     Level: beginner
85847c6ae99SBarry Smith 
859e727c939SJed Brown .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
86047c6ae99SBarry Smith 
86147c6ae99SBarry Smith @*/
8627087cfbeSBarry Smith PetscErrorCode  DMCreateLocalVector(DM dm,Vec *vec)
86347c6ae99SBarry Smith {
86447c6ae99SBarry Smith   PetscErrorCode ierr;
86547c6ae99SBarry Smith 
86647c6ae99SBarry Smith   PetscFunctionBegin;
867171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
86847c6ae99SBarry Smith   ierr = (*dm->ops->createlocalvector)(dm,vec);CHKERRQ(ierr);
86947c6ae99SBarry Smith   PetscFunctionReturn(0);
87047c6ae99SBarry Smith }
87147c6ae99SBarry Smith 
8721411c6eeSJed Brown /*@
8731411c6eeSJed Brown    DMGetLocalToGlobalMapping - Accesses the local-to-global mapping in a DM.
8741411c6eeSJed Brown 
8751411c6eeSJed Brown    Collective on DM
8761411c6eeSJed Brown 
8771411c6eeSJed Brown    Input Parameter:
8781411c6eeSJed Brown .  dm - the DM that provides the mapping
8791411c6eeSJed Brown 
8801411c6eeSJed Brown    Output Parameter:
8811411c6eeSJed Brown .  ltog - the mapping
8821411c6eeSJed Brown 
8831411c6eeSJed Brown    Level: intermediate
8841411c6eeSJed Brown 
8851411c6eeSJed Brown    Notes:
8861411c6eeSJed Brown    This mapping can then be used by VecSetLocalToGlobalMapping() or
8871411c6eeSJed Brown    MatSetLocalToGlobalMapping().
8881411c6eeSJed Brown 
889fc31e74dSBarry Smith .seealso: DMCreateLocalVector()
8901411c6eeSJed Brown @*/
8917087cfbeSBarry Smith PetscErrorCode DMGetLocalToGlobalMapping(DM dm,ISLocalToGlobalMapping *ltog)
8921411c6eeSJed Brown {
893bff27382SMatthew G. Knepley   PetscInt       bs = -1, bsLocal, bsMin, bsMax;
8941411c6eeSJed Brown   PetscErrorCode ierr;
8951411c6eeSJed Brown 
8961411c6eeSJed Brown   PetscFunctionBegin;
8971411c6eeSJed Brown   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
8981411c6eeSJed Brown   PetscValidPointer(ltog,2);
8991411c6eeSJed Brown   if (!dm->ltogmap) {
90037d0c07bSMatthew G Knepley     PetscSection section, sectionGlobal;
90137d0c07bSMatthew G Knepley 
90237d0c07bSMatthew G Knepley     ierr = DMGetDefaultSection(dm, &section);CHKERRQ(ierr);
90337d0c07bSMatthew G Knepley     if (section) {
904a974ec88SMatthew G. Knepley       const PetscInt *cdofs;
90537d0c07bSMatthew G Knepley       PetscInt       *ltog;
90637d0c07bSMatthew G Knepley       PetscInt        pStart, pEnd, size, p, l;
90737d0c07bSMatthew G Knepley 
90837d0c07bSMatthew G Knepley       ierr = DMGetDefaultGlobalSection(dm, &sectionGlobal);CHKERRQ(ierr);
90937d0c07bSMatthew G Knepley       ierr = PetscSectionGetChart(section, &pStart, &pEnd);CHKERRQ(ierr);
91037d0c07bSMatthew G Knepley       ierr = PetscSectionGetStorageSize(section, &size);CHKERRQ(ierr);
911785e854fSJed Brown       ierr = PetscMalloc1(size, &ltog);CHKERRQ(ierr); /* We want the local+overlap size */
91237d0c07bSMatthew G Knepley       for (p = pStart, l = 0; p < pEnd; ++p) {
913a974ec88SMatthew G. Knepley         PetscInt bdof, cdof, dof, off, c, cind = 0;
91437d0c07bSMatthew G Knepley 
91537d0c07bSMatthew G Knepley         /* Should probably use constrained dofs */
91637d0c07bSMatthew G Knepley         ierr = PetscSectionGetDof(section, p, &dof);CHKERRQ(ierr);
917a974ec88SMatthew G. Knepley         ierr = PetscSectionGetConstraintDof(section, p, &cdof);CHKERRQ(ierr);
918a974ec88SMatthew G. Knepley         ierr = PetscSectionGetConstraintIndices(section, p, &cdofs);CHKERRQ(ierr);
91937d0c07bSMatthew G Knepley         ierr = PetscSectionGetOffset(sectionGlobal, p, &off);CHKERRQ(ierr);
9201a7dc684SMatthew G. Knepley         /* If you have dofs, and constraints, and they are unequal, we set the blocksize to 1 */
9211a7dc684SMatthew G. Knepley         bdof = cdof && (dof-cdof) ? 1 : dof;
9221a7dc684SMatthew G. Knepley         if (dof) {
923b190aa46SMatthew G. Knepley           if (bs < 0)          {bs = bdof;}
924b190aa46SMatthew G. Knepley           else if (bs != bdof) {bs = 1;}
9251a7dc684SMatthew G. Knepley         }
92637d0c07bSMatthew G Knepley         for (c = 0; c < dof; ++c, ++l) {
927a974ec88SMatthew G. Knepley           if ((cind < cdof) && (c == cdofs[cind])) ltog[l] = off < 0 ? off-c : off+c;
928a974ec88SMatthew G. Knepley           else                                     ltog[l] = (off < 0 ? -(off+1) : off) + c;
92937d0c07bSMatthew G Knepley         }
93037d0c07bSMatthew G Knepley       }
931bff27382SMatthew G. Knepley       /* Must have same blocksize on all procs (some might have no points) */
932bff27382SMatthew G. Knepley       bsLocal = bs;
933bff27382SMatthew G. Knepley       ierr = MPIU_Allreduce(&bsLocal, &bsMax, 1, MPIU_INT, MPI_MAX, PetscObjectComm((PetscObject)dm));CHKERRQ(ierr);
934bff27382SMatthew G. Knepley       bsLocal = bs < 0 ? bsMax : bs;
935bff27382SMatthew G. Knepley       ierr = MPIU_Allreduce(&bsLocal, &bsMin, 1, MPIU_INT, MPI_MIN, PetscObjectComm((PetscObject)dm));CHKERRQ(ierr);
936bff27382SMatthew G. Knepley       if (bsMin != bsMax) {bs = 1;}
937bff27382SMatthew G. Knepley       else                {bs = bsMax;}
9387591dbb2SMatthew G. Knepley       bs   = bs < 0 ? 1 : bs;
9397591dbb2SMatthew G. Knepley       /* Must reduce indices by blocksize */
9407591dbb2SMatthew G. Knepley       if (bs > 1) for (l = 0; l < size; ++l) ltog[l] /= bs;
9417591dbb2SMatthew G. Knepley       ierr = ISLocalToGlobalMappingCreate(PetscObjectComm((PetscObject)dm), bs, size, ltog, PETSC_OWN_POINTER, &dm->ltogmap);CHKERRQ(ierr);
9423bb1ff40SBarry Smith       ierr = PetscLogObjectParent((PetscObject)dm, (PetscObject)dm->ltogmap);CHKERRQ(ierr);
94337d0c07bSMatthew G Knepley     } else {
944184d77edSJed Brown       if (!dm->ops->getlocaltoglobalmapping) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM can not create LocalToGlobalMapping");
945184d77edSJed Brown       ierr = (*dm->ops->getlocaltoglobalmapping)(dm);CHKERRQ(ierr);
9461411c6eeSJed Brown     }
94737d0c07bSMatthew G Knepley   }
9481411c6eeSJed Brown   *ltog = dm->ltogmap;
9491411c6eeSJed Brown   PetscFunctionReturn(0);
9501411c6eeSJed Brown }
9511411c6eeSJed Brown 
9521411c6eeSJed Brown /*@
9531411c6eeSJed Brown    DMGetBlockSize - Gets the inherent block size associated with a DM
9541411c6eeSJed Brown 
9551411c6eeSJed Brown    Not Collective
9561411c6eeSJed Brown 
9571411c6eeSJed Brown    Input Parameter:
9581411c6eeSJed Brown .  dm - the DM with block structure
9591411c6eeSJed Brown 
9601411c6eeSJed Brown    Output Parameter:
9611411c6eeSJed Brown .  bs - the block size, 1 implies no exploitable block structure
9621411c6eeSJed Brown 
9631411c6eeSJed Brown    Level: intermediate
9641411c6eeSJed Brown 
965fc31e74dSBarry Smith .seealso: ISCreateBlock(), VecSetBlockSize(), MatSetBlockSize(), DMGetLocalToGlobalMapping()
9661411c6eeSJed Brown @*/
9677087cfbeSBarry Smith PetscErrorCode  DMGetBlockSize(DM dm,PetscInt *bs)
9681411c6eeSJed Brown {
9691411c6eeSJed Brown   PetscFunctionBegin;
9701411c6eeSJed Brown   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
9711411c6eeSJed Brown   PetscValidPointer(bs,2);
9721411c6eeSJed 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");
9731411c6eeSJed Brown   *bs = dm->bs;
9741411c6eeSJed Brown   PetscFunctionReturn(0);
9751411c6eeSJed Brown }
9761411c6eeSJed Brown 
97747c6ae99SBarry Smith /*@
9788472ad0fSDave May     DMCreateInterpolation - Gets interpolation matrix between two DM objects
97947c6ae99SBarry Smith 
98047c6ae99SBarry Smith     Collective on DM
98147c6ae99SBarry Smith 
98247c6ae99SBarry Smith     Input Parameter:
98347c6ae99SBarry Smith +   dm1 - the DM object
98447c6ae99SBarry Smith -   dm2 - the second, finer DM object
98547c6ae99SBarry Smith 
98647c6ae99SBarry Smith     Output Parameter:
98747c6ae99SBarry Smith +  mat - the interpolation
98847c6ae99SBarry Smith -  vec - the scaling (optional)
98947c6ae99SBarry Smith 
99047c6ae99SBarry Smith     Level: developer
99147c6ae99SBarry Smith 
99285afcc9aSBarry 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
99385afcc9aSBarry Smith         DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the interpolation.
994d52bd9f3SBarry Smith 
9951f588964SMatthew G Knepley         For DMDA objects you can use this interpolation (more precisely the interpolation from the DMGetCoordinateDM()) to interpolate the mesh coordinate vectors
996d52bd9f3SBarry Smith         EXCEPT in the periodic case where it does not make sense since the coordinate vectors are not periodic.
99785afcc9aSBarry Smith 
99885afcc9aSBarry Smith 
9993ad4599aSBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateRestriction()
100047c6ae99SBarry Smith 
100147c6ae99SBarry Smith @*/
1002e727c939SJed Brown PetscErrorCode  DMCreateInterpolation(DM dm1,DM dm2,Mat *mat,Vec *vec)
100347c6ae99SBarry Smith {
100447c6ae99SBarry Smith   PetscErrorCode ierr;
100547c6ae99SBarry Smith 
100647c6ae99SBarry Smith   PetscFunctionBegin;
1007171400e9SBarry Smith   PetscValidHeaderSpecific(dm1,DM_CLASSID,1);
1008171400e9SBarry Smith   PetscValidHeaderSpecific(dm2,DM_CLASSID,2);
1009cea54e9dSPatrick Farrell   ierr = PetscLogEventBegin(DM_CreateInterpolation,dm1,dm2,0,0);CHKERRQ(ierr);
101025296bd5SBarry Smith   ierr = (*dm1->ops->createinterpolation)(dm1,dm2,mat,vec);CHKERRQ(ierr);
1011cea54e9dSPatrick Farrell   ierr = PetscLogEventEnd(DM_CreateInterpolation,dm1,dm2,0,0);CHKERRQ(ierr);
101247c6ae99SBarry Smith   PetscFunctionReturn(0);
101347c6ae99SBarry Smith }
101447c6ae99SBarry Smith 
10153ad4599aSBarry Smith /*@
10163ad4599aSBarry Smith     DMCreateRestriction - Gets restriction matrix between two DM objects
10173ad4599aSBarry Smith 
10183ad4599aSBarry Smith     Collective on DM
10193ad4599aSBarry Smith 
10203ad4599aSBarry Smith     Input Parameter:
10213ad4599aSBarry Smith +   dm1 - the DM object
10223ad4599aSBarry Smith -   dm2 - the second, finer DM object
10233ad4599aSBarry Smith 
10243ad4599aSBarry Smith     Output Parameter:
10253ad4599aSBarry Smith .  mat - the restriction
10263ad4599aSBarry Smith 
10273ad4599aSBarry Smith 
10283ad4599aSBarry Smith     Level: developer
10293ad4599aSBarry Smith 
10303ad4599aSBarry 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
10313ad4599aSBarry Smith         DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the interpolation.
10323ad4599aSBarry Smith 
10333ad4599aSBarry Smith 
10343ad4599aSBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateInterpolation()
10353ad4599aSBarry Smith 
10363ad4599aSBarry Smith @*/
10373ad4599aSBarry Smith PetscErrorCode  DMCreateRestriction(DM dm1,DM dm2,Mat *mat)
10383ad4599aSBarry Smith {
10393ad4599aSBarry Smith   PetscErrorCode ierr;
10403ad4599aSBarry Smith 
10413ad4599aSBarry Smith   PetscFunctionBegin;
10423ad4599aSBarry Smith   PetscValidHeaderSpecific(dm1,DM_CLASSID,1);
10433ad4599aSBarry Smith   PetscValidHeaderSpecific(dm2,DM_CLASSID,2);
10443ad4599aSBarry Smith   ierr = PetscLogEventBegin(DM_CreateRestriction,dm1,dm2,0,0);CHKERRQ(ierr);
10457294143fSBarry Smith   if (!dm1->ops->createrestriction) SETERRQ(PetscObjectComm((PetscObject)dm1),PETSC_ERR_SUP,"DMCreateRestriction not implemented for this type");
10463ad4599aSBarry Smith   ierr = (*dm1->ops->createrestriction)(dm1,dm2,mat);CHKERRQ(ierr);
10473ad4599aSBarry Smith   ierr = PetscLogEventEnd(DM_CreateRestriction,dm1,dm2,0,0);CHKERRQ(ierr);
10483ad4599aSBarry Smith   PetscFunctionReturn(0);
10493ad4599aSBarry Smith }
10503ad4599aSBarry Smith 
105147c6ae99SBarry Smith /*@
10528472ad0fSDave May     DMCreateInjection - Gets injection matrix between two DM objects
105347c6ae99SBarry Smith 
105447c6ae99SBarry Smith     Collective on DM
105547c6ae99SBarry Smith 
105647c6ae99SBarry Smith     Input Parameter:
105747c6ae99SBarry Smith +   dm1 - the DM object
105847c6ae99SBarry Smith -   dm2 - the second, finer DM object
105947c6ae99SBarry Smith 
106047c6ae99SBarry Smith     Output Parameter:
10616dbf9973SLawrence Mitchell .   mat - the injection
106247c6ae99SBarry Smith 
106347c6ae99SBarry Smith     Level: developer
106447c6ae99SBarry Smith 
106585afcc9aSBarry 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
106685afcc9aSBarry Smith         DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the injection.
106785afcc9aSBarry Smith 
1068e727c939SJed Brown .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMCreateInterpolation()
106947c6ae99SBarry Smith 
107047c6ae99SBarry Smith @*/
10716dbf9973SLawrence Mitchell PetscErrorCode  DMCreateInjection(DM dm1,DM dm2,Mat *mat)
107247c6ae99SBarry Smith {
107347c6ae99SBarry Smith   PetscErrorCode ierr;
107447c6ae99SBarry Smith 
107547c6ae99SBarry Smith   PetscFunctionBegin;
1076171400e9SBarry Smith   PetscValidHeaderSpecific(dm1,DM_CLASSID,1);
1077171400e9SBarry Smith   PetscValidHeaderSpecific(dm2,DM_CLASSID,2);
10780c4c9125SBarry Smith   if (!dm1->ops->getinjection) SETERRQ(PetscObjectComm((PetscObject)dm1),PETSC_ERR_SUP,"DMCreateInjection not implemented for this type");
10796dbf9973SLawrence Mitchell   ierr = (*dm1->ops->getinjection)(dm1,dm2,mat);CHKERRQ(ierr);
108047c6ae99SBarry Smith   PetscFunctionReturn(0);
108147c6ae99SBarry Smith }
108247c6ae99SBarry Smith 
1083b412c318SBarry Smith /*@
1084b412c318SBarry Smith     DMCreateColoring - Gets coloring for a DM
108547c6ae99SBarry Smith 
108647c6ae99SBarry Smith     Collective on DM
108747c6ae99SBarry Smith 
108847c6ae99SBarry Smith     Input Parameter:
108947c6ae99SBarry Smith +   dm - the DM object
10905bdb020cSBarry Smith -   ctype - IS_COLORING_LOCAL or IS_COLORING_GLOBAL
109147c6ae99SBarry Smith 
109247c6ae99SBarry Smith     Output Parameter:
109347c6ae99SBarry Smith .   coloring - the coloring
109447c6ae99SBarry Smith 
109547c6ae99SBarry Smith     Level: developer
109647c6ae99SBarry Smith 
1097b412c318SBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateMatrix(), DMSetMatType()
109847c6ae99SBarry Smith 
1099aab9d709SJed Brown @*/
1100b412c318SBarry Smith PetscErrorCode  DMCreateColoring(DM dm,ISColoringType ctype,ISColoring *coloring)
110147c6ae99SBarry Smith {
110247c6ae99SBarry Smith   PetscErrorCode ierr;
110347c6ae99SBarry Smith 
110447c6ae99SBarry Smith   PetscFunctionBegin;
1105171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1106ce94432eSBarry Smith   if (!dm->ops->getcoloring) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"No coloring for this type of DM yet");
1107b412c318SBarry Smith   ierr = (*dm->ops->getcoloring)(dm,ctype,coloring);CHKERRQ(ierr);
110847c6ae99SBarry Smith   PetscFunctionReturn(0);
110947c6ae99SBarry Smith }
111047c6ae99SBarry Smith 
1111b412c318SBarry Smith /*@
11128472ad0fSDave May     DMCreateMatrix - Gets empty Jacobian for a DM
111347c6ae99SBarry Smith 
111447c6ae99SBarry Smith     Collective on DM
111547c6ae99SBarry Smith 
111647c6ae99SBarry Smith     Input Parameter:
1117b412c318SBarry Smith .   dm - the DM object
111847c6ae99SBarry Smith 
111947c6ae99SBarry Smith     Output Parameter:
112047c6ae99SBarry Smith .   mat - the empty Jacobian
112147c6ae99SBarry Smith 
1122073dac72SJed Brown     Level: beginner
112347c6ae99SBarry Smith 
112494013140SBarry Smith     Notes: This properly preallocates the number of nonzeros in the sparse matrix so you
112594013140SBarry Smith        do not need to do it yourself.
112694013140SBarry Smith 
112794013140SBarry Smith        By default it also sets the nonzero structure and puts in the zero entries. To prevent setting
11287889ec69SBarry Smith        the nonzero pattern call DMSetMatrixPreallocateOnly()
112994013140SBarry Smith 
113094013140SBarry 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
113194013140SBarry Smith        internally by PETSc.
113294013140SBarry Smith 
113394013140SBarry Smith        For structured grid problems, in general it is easiest to use MatSetValuesStencil() or MatSetValuesLocal() to put values into the matrix because MatSetValues() requires
1134aa219208SBarry Smith        the indices for the global numbering for DMDAs which is complicated.
113594013140SBarry Smith 
1136b412c318SBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMSetMatType()
113747c6ae99SBarry Smith 
1138aab9d709SJed Brown @*/
1139b412c318SBarry Smith PetscErrorCode  DMCreateMatrix(DM dm,Mat *mat)
114047c6ae99SBarry Smith {
114147c6ae99SBarry Smith   PetscErrorCode ierr;
114247c6ae99SBarry Smith 
114347c6ae99SBarry Smith   PetscFunctionBegin;
1144171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1145607a6623SBarry Smith   ierr = MatInitializePackage();CHKERRQ(ierr);
1146c7b7c8a4SJed Brown   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1147c7b7c8a4SJed Brown   PetscValidPointer(mat,3);
1148b412c318SBarry Smith   ierr = (*dm->ops->creatematrix)(dm,mat);CHKERRQ(ierr);
114947c6ae99SBarry Smith   PetscFunctionReturn(0);
115047c6ae99SBarry Smith }
115147c6ae99SBarry Smith 
1152732e2eb9SMatthew G Knepley /*@
1153950540a4SJed Brown   DMSetMatrixPreallocateOnly - When DMCreateMatrix() is called the matrix will be properly
1154732e2eb9SMatthew G Knepley     preallocated but the nonzero structure and zero values will not be set.
1155732e2eb9SMatthew G Knepley 
11568472ad0fSDave May   Logically Collective on DM
1157732e2eb9SMatthew G Knepley 
1158732e2eb9SMatthew G Knepley   Input Parameter:
1159732e2eb9SMatthew G Knepley + dm - the DM
1160732e2eb9SMatthew G Knepley - only - PETSC_TRUE if only want preallocation
1161732e2eb9SMatthew G Knepley 
1162732e2eb9SMatthew G Knepley   Level: developer
1163950540a4SJed Brown .seealso DMCreateMatrix()
1164732e2eb9SMatthew G Knepley @*/
1165732e2eb9SMatthew G Knepley PetscErrorCode DMSetMatrixPreallocateOnly(DM dm, PetscBool only)
1166732e2eb9SMatthew G Knepley {
1167732e2eb9SMatthew G Knepley   PetscFunctionBegin;
1168732e2eb9SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1169732e2eb9SMatthew G Knepley   dm->prealloc_only = only;
1170732e2eb9SMatthew G Knepley   PetscFunctionReturn(0);
1171732e2eb9SMatthew G Knepley }
1172732e2eb9SMatthew G Knepley 
1173a89ea682SMatthew G Knepley /*@C
1174aa1993deSMatthew G Knepley   DMGetWorkArray - Gets a work array guaranteed to be at least the input size, restore with DMRestoreWorkArray()
1175a89ea682SMatthew G Knepley 
1176a89ea682SMatthew G Knepley   Not Collective
1177a89ea682SMatthew G Knepley 
1178a89ea682SMatthew G Knepley   Input Parameters:
1179a89ea682SMatthew G Knepley + dm - the DM object
1180aa1993deSMatthew G Knepley . count - The minium size
1181aa1993deSMatthew G Knepley - dtype - data type (PETSC_REAL, PETSC_SCALAR, PETSC_INT)
1182a89ea682SMatthew G Knepley 
1183a89ea682SMatthew G Knepley   Output Parameter:
1184a89ea682SMatthew G Knepley . array - the work array
1185a89ea682SMatthew G Knepley 
1186a89ea682SMatthew G Knepley   Level: developer
1187a89ea682SMatthew G Knepley 
1188a89ea682SMatthew G Knepley .seealso DMDestroy(), DMCreate()
1189a89ea682SMatthew G Knepley @*/
1190aa1993deSMatthew G Knepley PetscErrorCode DMGetWorkArray(DM dm,PetscInt count,PetscDataType dtype,void *mem)
1191a89ea682SMatthew G Knepley {
1192a89ea682SMatthew G Knepley   PetscErrorCode ierr;
1193aa1993deSMatthew G Knepley   DMWorkLink     link;
1194854ce69bSBarry Smith   size_t         dsize;
1195a89ea682SMatthew G Knepley 
1196a89ea682SMatthew G Knepley   PetscFunctionBegin;
1197a89ea682SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1198aa1993deSMatthew G Knepley   PetscValidPointer(mem,4);
1199aa1993deSMatthew G Knepley   if (dm->workin) {
1200aa1993deSMatthew G Knepley     link       = dm->workin;
1201aa1993deSMatthew G Knepley     dm->workin = dm->workin->next;
1202aa1993deSMatthew G Knepley   } else {
1203b00a9115SJed Brown     ierr = PetscNewLog(dm,&link);CHKERRQ(ierr);
1204a89ea682SMatthew G Knepley   }
1205854ce69bSBarry Smith   ierr = PetscDataTypeGetSize(dtype,&dsize);CHKERRQ(ierr);
1206854ce69bSBarry Smith   if (dsize*count > link->bytes) {
1207aa1993deSMatthew G Knepley     ierr        = PetscFree(link->mem);CHKERRQ(ierr);
1208854ce69bSBarry Smith     ierr        = PetscMalloc(dsize*count,&link->mem);CHKERRQ(ierr);
1209854ce69bSBarry Smith     link->bytes = dsize*count;
1210aa1993deSMatthew G Knepley   }
1211aa1993deSMatthew G Knepley   link->next   = dm->workout;
1212aa1993deSMatthew G Knepley   dm->workout  = link;
1213aa1993deSMatthew G Knepley   *(void**)mem = link->mem;
1214a89ea682SMatthew G Knepley   PetscFunctionReturn(0);
1215a89ea682SMatthew G Knepley }
1216a89ea682SMatthew G Knepley 
1217aa1993deSMatthew G Knepley /*@C
1218aa1993deSMatthew G Knepley   DMRestoreWorkArray - Restores a work array guaranteed to be at least the input size, restore with DMRestoreWorkArray()
1219aa1993deSMatthew G Knepley 
1220aa1993deSMatthew G Knepley   Not Collective
1221aa1993deSMatthew G Knepley 
1222aa1993deSMatthew G Knepley   Input Parameters:
1223aa1993deSMatthew G Knepley + dm - the DM object
1224aa1993deSMatthew G Knepley . count - The minium size
1225aa1993deSMatthew G Knepley - dtype - data type (PETSC_REAL, PETSC_SCALAR, PETSC_INT)
1226aa1993deSMatthew G Knepley 
1227aa1993deSMatthew G Knepley   Output Parameter:
1228aa1993deSMatthew G Knepley . array - the work array
1229aa1993deSMatthew G Knepley 
1230aa1993deSMatthew G Knepley   Level: developer
1231aa1993deSMatthew G Knepley 
1232aa1993deSMatthew G Knepley .seealso DMDestroy(), DMCreate()
1233aa1993deSMatthew G Knepley @*/
1234aa1993deSMatthew G Knepley PetscErrorCode DMRestoreWorkArray(DM dm,PetscInt count,PetscDataType dtype,void *mem)
1235aa1993deSMatthew G Knepley {
1236aa1993deSMatthew G Knepley   DMWorkLink *p,link;
1237aa1993deSMatthew G Knepley 
1238aa1993deSMatthew G Knepley   PetscFunctionBegin;
1239aa1993deSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1240aa1993deSMatthew G Knepley   PetscValidPointer(mem,4);
1241aa1993deSMatthew G Knepley   for (p=&dm->workout; (link=*p); p=&link->next) {
1242aa1993deSMatthew G Knepley     if (link->mem == *(void**)mem) {
1243aa1993deSMatthew G Knepley       *p           = link->next;
1244aa1993deSMatthew G Knepley       link->next   = dm->workin;
1245aa1993deSMatthew G Knepley       dm->workin   = link;
12460298fd71SBarry Smith       *(void**)mem = NULL;
1247aa1993deSMatthew G Knepley       PetscFunctionReturn(0);
1248aa1993deSMatthew G Knepley     }
1249aa1993deSMatthew G Knepley   }
1250aa1993deSMatthew G Knepley   SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Array was not checked out");
1251aa1993deSMatthew G Knepley }
1252e7c4fc90SDmitry Karpeev 
1253435a35e8SMatthew G Knepley PetscErrorCode DMSetNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (*nullsp)(DM dm, PetscInt field, MatNullSpace *nullSpace))
1254435a35e8SMatthew G Knepley {
1255435a35e8SMatthew G Knepley   PetscFunctionBegin;
1256435a35e8SMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
125782f516ccSBarry Smith   if (field >= 10) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field);
1258435a35e8SMatthew G Knepley   dm->nullspaceConstructors[field] = nullsp;
1259435a35e8SMatthew G Knepley   PetscFunctionReturn(0);
1260435a35e8SMatthew G Knepley }
1261435a35e8SMatthew G Knepley 
12624f3b5142SJed Brown /*@C
12634d343eeaSMatthew G Knepley   DMCreateFieldIS - Creates a set of IS objects with the global indices of dofs for each field
12644d343eeaSMatthew G Knepley 
12654d343eeaSMatthew G Knepley   Not collective
12664d343eeaSMatthew G Knepley 
12674d343eeaSMatthew G Knepley   Input Parameter:
12684d343eeaSMatthew G Knepley . dm - the DM object
12694d343eeaSMatthew G Knepley 
12704d343eeaSMatthew G Knepley   Output Parameters:
12710298fd71SBarry Smith + numFields  - The number of fields (or NULL if not requested)
12720298fd71SBarry Smith . fieldNames - The name for each field (or NULL if not requested)
12730298fd71SBarry Smith - fields     - The global indices for each field (or NULL if not requested)
12744d343eeaSMatthew G Knepley 
12754d343eeaSMatthew G Knepley   Level: intermediate
12764d343eeaSMatthew G Knepley 
127721c9b008SJed Brown   Notes:
127821c9b008SJed Brown   The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with
127921c9b008SJed Brown   PetscFree(), every entry of fields should be destroyed with ISDestroy(), and both arrays should be freed with
128021c9b008SJed Brown   PetscFree().
128121c9b008SJed Brown 
12824d343eeaSMatthew G Knepley .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
12834d343eeaSMatthew G Knepley @*/
128437d0c07bSMatthew G Knepley PetscErrorCode DMCreateFieldIS(DM dm, PetscInt *numFields, char ***fieldNames, IS **fields)
12854d343eeaSMatthew G Knepley {
128637d0c07bSMatthew G Knepley   PetscSection   section, sectionGlobal;
12874d343eeaSMatthew G Knepley   PetscErrorCode ierr;
12884d343eeaSMatthew G Knepley 
12894d343eeaSMatthew G Knepley   PetscFunctionBegin;
12904d343eeaSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
129169ca1f37SDmitry Karpeev   if (numFields) {
129269ca1f37SDmitry Karpeev     PetscValidPointer(numFields,2);
129369ca1f37SDmitry Karpeev     *numFields = 0;
129469ca1f37SDmitry Karpeev   }
129537d0c07bSMatthew G Knepley   if (fieldNames) {
129637d0c07bSMatthew G Knepley     PetscValidPointer(fieldNames,3);
12970298fd71SBarry Smith     *fieldNames = NULL;
129869ca1f37SDmitry Karpeev   }
129969ca1f37SDmitry Karpeev   if (fields) {
130069ca1f37SDmitry Karpeev     PetscValidPointer(fields,4);
13010298fd71SBarry Smith     *fields = NULL;
130269ca1f37SDmitry Karpeev   }
130337d0c07bSMatthew G Knepley   ierr = DMGetDefaultSection(dm, &section);CHKERRQ(ierr);
130437d0c07bSMatthew G Knepley   if (section) {
130537d0c07bSMatthew G Knepley     PetscInt *fieldSizes, **fieldIndices;
130637d0c07bSMatthew G Knepley     PetscInt nF, f, pStart, pEnd, p;
130737d0c07bSMatthew G Knepley 
130837d0c07bSMatthew G Knepley     ierr = DMGetDefaultGlobalSection(dm, &sectionGlobal);CHKERRQ(ierr);
130937d0c07bSMatthew G Knepley     ierr = PetscSectionGetNumFields(section, &nF);CHKERRQ(ierr);
1310dcca6d9dSJed Brown     ierr = PetscMalloc2(nF,&fieldSizes,nF,&fieldIndices);CHKERRQ(ierr);
131137d0c07bSMatthew G Knepley     ierr = PetscSectionGetChart(sectionGlobal, &pStart, &pEnd);CHKERRQ(ierr);
131237d0c07bSMatthew G Knepley     for (f = 0; f < nF; ++f) {
131337d0c07bSMatthew G Knepley       fieldSizes[f] = 0;
131437d0c07bSMatthew G Knepley     }
131537d0c07bSMatthew G Knepley     for (p = pStart; p < pEnd; ++p) {
131637d0c07bSMatthew G Knepley       PetscInt gdof;
131737d0c07bSMatthew G Knepley 
131837d0c07bSMatthew G Knepley       ierr = PetscSectionGetDof(sectionGlobal, p, &gdof);CHKERRQ(ierr);
131937d0c07bSMatthew G Knepley       if (gdof > 0) {
132037d0c07bSMatthew G Knepley         for (f = 0; f < nF; ++f) {
132137d0c07bSMatthew G Knepley           PetscInt fdof, fcdof;
132237d0c07bSMatthew G Knepley 
132337d0c07bSMatthew G Knepley           ierr           = PetscSectionGetFieldDof(section, p, f, &fdof);CHKERRQ(ierr);
132437d0c07bSMatthew G Knepley           ierr           = PetscSectionGetFieldConstraintDof(section, p, f, &fcdof);CHKERRQ(ierr);
132537d0c07bSMatthew G Knepley           fieldSizes[f] += fdof-fcdof;
132637d0c07bSMatthew G Knepley         }
132737d0c07bSMatthew G Knepley       }
132837d0c07bSMatthew G Knepley     }
132937d0c07bSMatthew G Knepley     for (f = 0; f < nF; ++f) {
1330785e854fSJed Brown       ierr          = PetscMalloc1(fieldSizes[f], &fieldIndices[f]);CHKERRQ(ierr);
133137d0c07bSMatthew G Knepley       fieldSizes[f] = 0;
133237d0c07bSMatthew G Knepley     }
133337d0c07bSMatthew G Knepley     for (p = pStart; p < pEnd; ++p) {
133437d0c07bSMatthew G Knepley       PetscInt gdof, goff;
133537d0c07bSMatthew G Knepley 
133637d0c07bSMatthew G Knepley       ierr = PetscSectionGetDof(sectionGlobal, p, &gdof);CHKERRQ(ierr);
133737d0c07bSMatthew G Knepley       if (gdof > 0) {
133837d0c07bSMatthew G Knepley         ierr = PetscSectionGetOffset(sectionGlobal, p, &goff);CHKERRQ(ierr);
133937d0c07bSMatthew G Knepley         for (f = 0; f < nF; ++f) {
134037d0c07bSMatthew G Knepley           PetscInt fdof, fcdof, fc;
134137d0c07bSMatthew G Knepley 
134237d0c07bSMatthew G Knepley           ierr = PetscSectionGetFieldDof(section, p, f, &fdof);CHKERRQ(ierr);
134337d0c07bSMatthew G Knepley           ierr = PetscSectionGetFieldConstraintDof(section, p, f, &fcdof);CHKERRQ(ierr);
134437d0c07bSMatthew G Knepley           for (fc = 0; fc < fdof-fcdof; ++fc, ++fieldSizes[f]) {
134537d0c07bSMatthew G Knepley             fieldIndices[f][fieldSizes[f]] = goff++;
134637d0c07bSMatthew G Knepley           }
134737d0c07bSMatthew G Knepley         }
134837d0c07bSMatthew G Knepley       }
134937d0c07bSMatthew G Knepley     }
13508865f1eaSKarl Rupp     if (numFields) *numFields = nF;
135137d0c07bSMatthew G Knepley     if (fieldNames) {
1352785e854fSJed Brown       ierr = PetscMalloc1(nF, fieldNames);CHKERRQ(ierr);
135337d0c07bSMatthew G Knepley       for (f = 0; f < nF; ++f) {
135437d0c07bSMatthew G Knepley         const char *fieldName;
135537d0c07bSMatthew G Knepley 
135637d0c07bSMatthew G Knepley         ierr = PetscSectionGetFieldName(section, f, &fieldName);CHKERRQ(ierr);
135737d0c07bSMatthew G Knepley         ierr = PetscStrallocpy(fieldName, (char**) &(*fieldNames)[f]);CHKERRQ(ierr);
135837d0c07bSMatthew G Knepley       }
135937d0c07bSMatthew G Knepley     }
136037d0c07bSMatthew G Knepley     if (fields) {
1361785e854fSJed Brown       ierr = PetscMalloc1(nF, fields);CHKERRQ(ierr);
136237d0c07bSMatthew G Knepley       for (f = 0; f < nF; ++f) {
136382f516ccSBarry Smith         ierr = ISCreateGeneral(PetscObjectComm((PetscObject)dm), fieldSizes[f], fieldIndices[f], PETSC_OWN_POINTER, &(*fields)[f]);CHKERRQ(ierr);
136437d0c07bSMatthew G Knepley       }
136537d0c07bSMatthew G Knepley     }
136637d0c07bSMatthew G Knepley     ierr = PetscFree2(fieldSizes,fieldIndices);CHKERRQ(ierr);
13678865f1eaSKarl Rupp   } else if (dm->ops->createfieldis) {
13688865f1eaSKarl Rupp     ierr = (*dm->ops->createfieldis)(dm, numFields, fieldNames, fields);CHKERRQ(ierr);
136969ca1f37SDmitry Karpeev   }
13704d343eeaSMatthew G Knepley   PetscFunctionReturn(0);
13714d343eeaSMatthew G Knepley }
13724d343eeaSMatthew G Knepley 
137316621825SDmitry Karpeev 
137416621825SDmitry Karpeev /*@C
137516621825SDmitry Karpeev   DMCreateFieldDecomposition - Returns a list of IS objects defining a decomposition of a problem into subproblems
137616621825SDmitry Karpeev                           corresponding to different fields: each IS contains the global indices of the dofs of the
137716621825SDmitry Karpeev                           corresponding field. The optional list of DMs define the DM for each subproblem.
1378e7c4fc90SDmitry Karpeev                           Generalizes DMCreateFieldIS().
1379e7c4fc90SDmitry Karpeev 
1380e7c4fc90SDmitry Karpeev   Not collective
1381e7c4fc90SDmitry Karpeev 
1382e7c4fc90SDmitry Karpeev   Input Parameter:
1383e7c4fc90SDmitry Karpeev . dm - the DM object
1384e7c4fc90SDmitry Karpeev 
1385e7c4fc90SDmitry Karpeev   Output Parameters:
13860298fd71SBarry Smith + len       - The number of subproblems in the field decomposition (or NULL if not requested)
13870298fd71SBarry Smith . namelist  - The name for each field (or NULL if not requested)
13880298fd71SBarry Smith . islist    - The global indices for each field (or NULL if not requested)
13890298fd71SBarry Smith - dmlist    - The DMs for each field subproblem (or NULL, if not requested; if NULL is returned, no DMs are defined)
1390e7c4fc90SDmitry Karpeev 
1391e7c4fc90SDmitry Karpeev   Level: intermediate
1392e7c4fc90SDmitry Karpeev 
1393e7c4fc90SDmitry Karpeev   Notes:
1394e7c4fc90SDmitry Karpeev   The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with
1395e7c4fc90SDmitry Karpeev   PetscFree(), every entry of is should be destroyed with ISDestroy(), every entry of dm should be destroyed with DMDestroy(),
1396e7c4fc90SDmitry Karpeev   and all of the arrays should be freed with PetscFree().
1397e7c4fc90SDmitry Karpeev 
1398e7c4fc90SDmitry Karpeev .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS()
1399e7c4fc90SDmitry Karpeev @*/
140016621825SDmitry Karpeev PetscErrorCode DMCreateFieldDecomposition(DM dm, PetscInt *len, char ***namelist, IS **islist, DM **dmlist)
1401e7c4fc90SDmitry Karpeev {
1402e7c4fc90SDmitry Karpeev   PetscErrorCode ierr;
1403e7c4fc90SDmitry Karpeev 
1404e7c4fc90SDmitry Karpeev   PetscFunctionBegin;
1405e7c4fc90SDmitry Karpeev   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
14068865f1eaSKarl Rupp   if (len) {
14078865f1eaSKarl Rupp     PetscValidPointer(len,2);
14088865f1eaSKarl Rupp     *len = 0;
14098865f1eaSKarl Rupp   }
14108865f1eaSKarl Rupp   if (namelist) {
14118865f1eaSKarl Rupp     PetscValidPointer(namelist,3);
14128865f1eaSKarl Rupp     *namelist = 0;
14138865f1eaSKarl Rupp   }
14148865f1eaSKarl Rupp   if (islist) {
14158865f1eaSKarl Rupp     PetscValidPointer(islist,4);
14168865f1eaSKarl Rupp     *islist = 0;
14178865f1eaSKarl Rupp   }
14188865f1eaSKarl Rupp   if (dmlist) {
14198865f1eaSKarl Rupp     PetscValidPointer(dmlist,5);
14208865f1eaSKarl Rupp     *dmlist = 0;
14218865f1eaSKarl Rupp   }
1422f3f0edfdSDmitry Karpeev   /*
1423f3f0edfdSDmitry Karpeev    Is it a good idea to apply the following check across all impls?
1424f3f0edfdSDmitry Karpeev    Perhaps some impls can have a well-defined decomposition before DMSetUp?
1425f3f0edfdSDmitry Karpeev    This, however, follows the general principle that accessors are not well-behaved until the object is set up.
1426f3f0edfdSDmitry Karpeev    */
1427ce94432eSBarry Smith   if (!dm->setupcalled) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_WRONGSTATE, "Decomposition defined only after DMSetUp");
142816621825SDmitry Karpeev   if (!dm->ops->createfielddecomposition) {
1429435a35e8SMatthew G Knepley     PetscSection section;
1430435a35e8SMatthew G Knepley     PetscInt     numFields, f;
1431435a35e8SMatthew G Knepley 
1432435a35e8SMatthew G Knepley     ierr = DMGetDefaultSection(dm, &section);CHKERRQ(ierr);
1433435a35e8SMatthew G Knepley     if (section) {ierr = PetscSectionGetNumFields(section, &numFields);CHKERRQ(ierr);}
1434435a35e8SMatthew G Knepley     if (section && numFields && dm->ops->createsubdm) {
1435f25d98f1SMatthew G. Knepley       if (len) *len = numFields;
143603dc3394SMatthew G. Knepley       if (namelist) {ierr = PetscMalloc1(numFields,namelist);CHKERRQ(ierr);}
143703dc3394SMatthew G. Knepley       if (islist)   {ierr = PetscMalloc1(numFields,islist);CHKERRQ(ierr);}
143803dc3394SMatthew G. Knepley       if (dmlist)   {ierr = PetscMalloc1(numFields,dmlist);CHKERRQ(ierr);}
1439435a35e8SMatthew G Knepley       for (f = 0; f < numFields; ++f) {
1440435a35e8SMatthew G Knepley         const char *fieldName;
1441435a35e8SMatthew G Knepley 
144203dc3394SMatthew G. Knepley         ierr = DMCreateSubDM(dm, 1, &f, islist ? &(*islist)[f] : NULL, dmlist ? &(*dmlist)[f] : NULL);CHKERRQ(ierr);
144303dc3394SMatthew G. Knepley         if (namelist) {
1444435a35e8SMatthew G Knepley           ierr = PetscSectionGetFieldName(section, f, &fieldName);CHKERRQ(ierr);
1445435a35e8SMatthew G Knepley           ierr = PetscStrallocpy(fieldName, (char**) &(*namelist)[f]);CHKERRQ(ierr);
1446435a35e8SMatthew G Knepley         }
144703dc3394SMatthew G. Knepley       }
1448435a35e8SMatthew G Knepley     } else {
144969ca1f37SDmitry Karpeev       ierr = DMCreateFieldIS(dm, len, namelist, islist);CHKERRQ(ierr);
1450e7c4fc90SDmitry Karpeev       /* By default there are no DMs associated with subproblems. */
14510298fd71SBarry Smith       if (dmlist) *dmlist = NULL;
1452e7c4fc90SDmitry Karpeev     }
14538865f1eaSKarl Rupp   } else {
145416621825SDmitry Karpeev     ierr = (*dm->ops->createfielddecomposition)(dm,len,namelist,islist,dmlist);CHKERRQ(ierr);
145516621825SDmitry Karpeev   }
145616621825SDmitry Karpeev   PetscFunctionReturn(0);
145716621825SDmitry Karpeev }
145816621825SDmitry Karpeev 
1459564cec59SMatthew G. Knepley /*@
1460435a35e8SMatthew G Knepley   DMCreateSubDM - Returns an IS and DM encapsulating a subproblem defined by the fields passed in.
1461435a35e8SMatthew G Knepley                   The fields are defined by DMCreateFieldIS().
1462435a35e8SMatthew G Knepley 
1463435a35e8SMatthew G Knepley   Not collective
1464435a35e8SMatthew G Knepley 
1465435a35e8SMatthew G Knepley   Input Parameters:
1466435a35e8SMatthew G Knepley + dm - the DM object
1467435a35e8SMatthew G Knepley . numFields - number of fields in this subproblem
14680298fd71SBarry Smith - len       - The number of subproblems in the decomposition (or NULL if not requested)
1469435a35e8SMatthew G Knepley 
1470435a35e8SMatthew G Knepley   Output Parameters:
1471435a35e8SMatthew G Knepley . is - The global indices for the subproblem
1472435a35e8SMatthew G Knepley - dm - The DM for the subproblem
1473435a35e8SMatthew G Knepley 
1474435a35e8SMatthew G Knepley   Level: intermediate
1475435a35e8SMatthew G Knepley 
1476435a35e8SMatthew G Knepley .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS()
1477435a35e8SMatthew G Knepley @*/
1478435a35e8SMatthew G Knepley PetscErrorCode DMCreateSubDM(DM dm, PetscInt numFields, PetscInt fields[], IS *is, DM *subdm)
1479435a35e8SMatthew G Knepley {
1480435a35e8SMatthew G Knepley   PetscErrorCode ierr;
1481435a35e8SMatthew G Knepley 
1482435a35e8SMatthew G Knepley   PetscFunctionBegin;
1483435a35e8SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1484435a35e8SMatthew G Knepley   PetscValidPointer(fields,3);
14858865f1eaSKarl Rupp   if (is) PetscValidPointer(is,4);
14868865f1eaSKarl Rupp   if (subdm) PetscValidPointer(subdm,5);
1487435a35e8SMatthew G Knepley   if (dm->ops->createsubdm) {
1488435a35e8SMatthew G Knepley     ierr = (*dm->ops->createsubdm)(dm, numFields, fields, is, subdm);CHKERRQ(ierr);
148982f516ccSBarry Smith   } else SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "This type has no DMCreateSubDM implementation defined");
1490435a35e8SMatthew G Knepley   PetscFunctionReturn(0);
1491435a35e8SMatthew G Knepley }
1492435a35e8SMatthew G Knepley 
149316621825SDmitry Karpeev 
149416621825SDmitry Karpeev /*@C
14958d4ac253SDmitry Karpeev   DMCreateDomainDecomposition - Returns lists of IS objects defining a decomposition of a problem into subproblems
14968d4ac253SDmitry Karpeev                           corresponding to restrictions to pairs nested subdomains: each IS contains the global
14978d4ac253SDmitry Karpeev                           indices of the dofs of the corresponding subdomains.  The inner subdomains conceptually
14988d4ac253SDmitry Karpeev                           define a nonoverlapping covering, while outer subdomains can overlap.
14998d4ac253SDmitry Karpeev                           The optional list of DMs define the DM for each subproblem.
150016621825SDmitry Karpeev 
150116621825SDmitry Karpeev   Not collective
150216621825SDmitry Karpeev 
150316621825SDmitry Karpeev   Input Parameter:
150416621825SDmitry Karpeev . dm - the DM object
150516621825SDmitry Karpeev 
150616621825SDmitry Karpeev   Output Parameters:
15070298fd71SBarry Smith + len         - The number of subproblems in the domain decomposition (or NULL if not requested)
15080298fd71SBarry Smith . namelist    - The name for each subdomain (or NULL if not requested)
15090298fd71SBarry Smith . innerislist - The global indices for each inner subdomain (or NULL, if not requested)
15100298fd71SBarry Smith . outerislist - The global indices for each outer subdomain (or NULL, if not requested)
15110298fd71SBarry Smith - dmlist      - The DMs for each subdomain subproblem (or NULL, if not requested; if NULL is returned, no DMs are defined)
151216621825SDmitry Karpeev 
151316621825SDmitry Karpeev   Level: intermediate
151416621825SDmitry Karpeev 
151516621825SDmitry Karpeev   Notes:
151616621825SDmitry Karpeev   The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with
151716621825SDmitry Karpeev   PetscFree(), every entry of is should be destroyed with ISDestroy(), every entry of dm should be destroyed with DMDestroy(),
151816621825SDmitry Karpeev   and all of the arrays should be freed with PetscFree().
151916621825SDmitry Karpeev 
15208d4ac253SDmitry Karpeev .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateDomainDecompositionDM(), DMCreateFieldDecomposition()
152116621825SDmitry Karpeev @*/
15228d4ac253SDmitry Karpeev PetscErrorCode DMCreateDomainDecomposition(DM dm, PetscInt *len, char ***namelist, IS **innerislist, IS **outerislist, DM **dmlist)
152316621825SDmitry Karpeev {
152416621825SDmitry Karpeev   PetscErrorCode      ierr;
1525be081cd6SPeter Brune   DMSubDomainHookLink link;
1526be081cd6SPeter Brune   PetscInt            i,l;
152716621825SDmitry Karpeev 
152816621825SDmitry Karpeev   PetscFunctionBegin;
152916621825SDmitry Karpeev   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
153014a18fd3SPeter Brune   if (len)           {PetscValidPointer(len,2);            *len         = 0;}
15310298fd71SBarry Smith   if (namelist)      {PetscValidPointer(namelist,3);       *namelist    = NULL;}
15320298fd71SBarry Smith   if (innerislist)   {PetscValidPointer(innerislist,4);    *innerislist = NULL;}
15330298fd71SBarry Smith   if (outerislist)   {PetscValidPointer(outerislist,5);    *outerislist = NULL;}
15340298fd71SBarry Smith   if (dmlist)        {PetscValidPointer(dmlist,6);         *dmlist      = NULL;}
1535f3f0edfdSDmitry Karpeev   /*
1536f3f0edfdSDmitry Karpeev    Is it a good idea to apply the following check across all impls?
1537f3f0edfdSDmitry Karpeev    Perhaps some impls can have a well-defined decomposition before DMSetUp?
1538f3f0edfdSDmitry Karpeev    This, however, follows the general principle that accessors are not well-behaved until the object is set up.
1539f3f0edfdSDmitry Karpeev    */
1540ce94432eSBarry Smith   if (!dm->setupcalled) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_WRONGSTATE, "Decomposition defined only after DMSetUp");
154116621825SDmitry Karpeev   if (dm->ops->createdomaindecomposition) {
1542be081cd6SPeter Brune     ierr = (*dm->ops->createdomaindecomposition)(dm,&l,namelist,innerislist,outerislist,dmlist);CHKERRQ(ierr);
154314a18fd3SPeter Brune     /* copy subdomain hooks and context over to the subdomain DMs */
1544f891f5b9SPatrick Sanan     if (dmlist && *dmlist) {
1545be081cd6SPeter Brune       for (i = 0; i < l; i++) {
1546be081cd6SPeter Brune         for (link=dm->subdomainhook; link; link=link->next) {
1547be081cd6SPeter Brune           if (link->ddhook) {ierr = (*link->ddhook)(dm,(*dmlist)[i],link->ctx);CHKERRQ(ierr);}
1548be081cd6SPeter Brune         }
1549648262bbSPatrick Sanan         if (dm->ctx) (*dmlist)[i]->ctx = dm->ctx;
1550e7c4fc90SDmitry Karpeev       }
155114a18fd3SPeter Brune     }
155214a18fd3SPeter Brune     if (len) *len = l;
155314a18fd3SPeter Brune   }
1554e30e807fSPeter Brune   PetscFunctionReturn(0);
1555e30e807fSPeter Brune }
1556e30e807fSPeter Brune 
1557e30e807fSPeter Brune 
1558e30e807fSPeter Brune /*@C
1559e30e807fSPeter Brune   DMCreateDomainDecompositionScatters - Returns scatters to the subdomain vectors from the global vector
1560e30e807fSPeter Brune 
1561e30e807fSPeter Brune   Not collective
1562e30e807fSPeter Brune 
1563e30e807fSPeter Brune   Input Parameters:
1564e30e807fSPeter Brune + dm - the DM object
1565e30e807fSPeter Brune . n  - the number of subdomain scatters
1566e30e807fSPeter Brune - subdms - the local subdomains
1567e30e807fSPeter Brune 
1568e30e807fSPeter Brune   Output Parameters:
1569e30e807fSPeter Brune + n     - the number of scatters returned
1570e30e807fSPeter Brune . iscat - scatter from global vector to nonoverlapping global vector entries on subdomain
1571e30e807fSPeter Brune . oscat - scatter from global vector to overlapping global vector entries on subdomain
1572e30e807fSPeter Brune - gscat - scatter from global vector to local vector on subdomain (fills in ghosts)
1573e30e807fSPeter Brune 
1574e30e807fSPeter Brune   Notes: This is an alternative to the iis and ois arguments in DMCreateDomainDecomposition that allow for the solution
1575e30e807fSPeter Brune   of general nonlinear problems with overlapping subdomain methods.  While merely having index sets that enable subsets
1576e30e807fSPeter Brune   of the residual equations to be created is fine for linear problems, nonlinear problems require local assembly of
1577e30e807fSPeter Brune   solution and residual data.
1578e30e807fSPeter Brune 
1579e30e807fSPeter Brune   Level: developer
1580e30e807fSPeter Brune 
1581e30e807fSPeter Brune .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS()
1582e30e807fSPeter Brune @*/
1583e30e807fSPeter Brune PetscErrorCode DMCreateDomainDecompositionScatters(DM dm,PetscInt n,DM *subdms,VecScatter **iscat,VecScatter **oscat,VecScatter **gscat)
1584e30e807fSPeter Brune {
1585e30e807fSPeter Brune   PetscErrorCode ierr;
1586e30e807fSPeter Brune 
1587e30e807fSPeter Brune   PetscFunctionBegin;
1588e30e807fSPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1589e30e807fSPeter Brune   PetscValidPointer(subdms,3);
1590e30e807fSPeter Brune   if (dm->ops->createddscatters) {
1591e30e807fSPeter Brune     ierr = (*dm->ops->createddscatters)(dm,n,subdms,iscat,oscat,gscat);CHKERRQ(ierr);
15926668ed41SLisandro Dalcin   } else SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "This type has no DMCreateDomainDecompositionScatter implementation defined");
1593e7c4fc90SDmitry Karpeev   PetscFunctionReturn(0);
1594e7c4fc90SDmitry Karpeev }
1595e7c4fc90SDmitry Karpeev 
159647c6ae99SBarry Smith /*@
159747c6ae99SBarry Smith   DMRefine - Refines a DM object
159847c6ae99SBarry Smith 
159947c6ae99SBarry Smith   Collective on DM
160047c6ae99SBarry Smith 
160147c6ae99SBarry Smith   Input Parameter:
160247c6ae99SBarry Smith + dm   - the DM object
160391d95f02SJed Brown - comm - the communicator to contain the new DM object (or MPI_COMM_NULL)
160447c6ae99SBarry Smith 
160547c6ae99SBarry Smith   Output Parameter:
16060298fd71SBarry Smith . dmf - the refined DM, or NULL
1607ae0a1c52SMatthew G Knepley 
16080298fd71SBarry Smith   Note: If no refinement was done, the return value is NULL
160947c6ae99SBarry Smith 
161047c6ae99SBarry Smith   Level: developer
161147c6ae99SBarry Smith 
1612e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
161347c6ae99SBarry Smith @*/
16147087cfbeSBarry Smith PetscErrorCode  DMRefine(DM dm,MPI_Comm comm,DM *dmf)
161547c6ae99SBarry Smith {
161647c6ae99SBarry Smith   PetscErrorCode   ierr;
1617c833c3b5SJed Brown   DMRefineHookLink link;
161847c6ae99SBarry Smith 
161947c6ae99SBarry Smith   PetscFunctionBegin;
1620732e2eb9SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
16211ac00216SMatthew G. Knepley   ierr = PetscLogEventBegin(DM_Refine,dm,0,0,0);CHKERRQ(ierr);
1622fef3a512SBarry Smith   if (!dm->ops->refine) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"This DM cannot refine");
162347c6ae99SBarry Smith   ierr = (*dm->ops->refine)(dm,comm,dmf);CHKERRQ(ierr);
16244057135bSMatthew G Knepley   if (*dmf) {
162543842a1eSJed Brown     (*dmf)->ops->creatematrix = dm->ops->creatematrix;
16268865f1eaSKarl Rupp 
16278cd211a4SJed Brown     ierr = PetscObjectCopyFortranFunctionPointers((PetscObject)dm,(PetscObject)*dmf);CHKERRQ(ierr);
16288865f1eaSKarl Rupp 
1629644e2e5bSBarry Smith     (*dmf)->ctx       = dm->ctx;
16300598a293SJed Brown     (*dmf)->leveldown = dm->leveldown;
1631656b349aSBarry Smith     (*dmf)->levelup   = dm->levelup + 1;
16328865f1eaSKarl Rupp 
1633e4b4b23bSJed Brown     ierr = DMSetMatType(*dmf,dm->mattype);CHKERRQ(ierr);
1634c833c3b5SJed Brown     for (link=dm->refinehook; link; link=link->next) {
16358865f1eaSKarl Rupp       if (link->refinehook) {
16368865f1eaSKarl Rupp         ierr = (*link->refinehook)(dm,*dmf,link->ctx);CHKERRQ(ierr);
16378865f1eaSKarl Rupp       }
1638c833c3b5SJed Brown     }
1639c833c3b5SJed Brown   }
16401ac00216SMatthew G. Knepley   ierr = PetscLogEventEnd(DM_Refine,dm,0,0,0);CHKERRQ(ierr);
1641c833c3b5SJed Brown   PetscFunctionReturn(0);
1642c833c3b5SJed Brown }
1643c833c3b5SJed Brown 
1644bb9467b5SJed Brown /*@C
1645c833c3b5SJed Brown    DMRefineHookAdd - adds a callback to be run when interpolating a nonlinear problem to a finer grid
1646c833c3b5SJed Brown 
1647c833c3b5SJed Brown    Logically Collective
1648c833c3b5SJed Brown 
1649c833c3b5SJed Brown    Input Arguments:
1650c833c3b5SJed Brown +  coarse - nonlinear solver context on which to run a hook when restricting to a coarser level
1651c833c3b5SJed Brown .  refinehook - function to run when setting up a coarser level
1652c833c3b5SJed Brown .  interphook - function to run to update data on finer levels (once per SNESSolve())
16530298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
1654c833c3b5SJed Brown 
1655c833c3b5SJed Brown    Calling sequence of refinehook:
1656c833c3b5SJed Brown $    refinehook(DM coarse,DM fine,void *ctx);
1657c833c3b5SJed Brown 
1658c833c3b5SJed Brown +  coarse - coarse level DM
1659c833c3b5SJed Brown .  fine - fine level DM to interpolate problem to
1660c833c3b5SJed Brown -  ctx - optional user-defined function context
1661c833c3b5SJed Brown 
1662c833c3b5SJed Brown    Calling sequence for interphook:
1663c833c3b5SJed Brown $    interphook(DM coarse,Mat interp,DM fine,void *ctx)
1664c833c3b5SJed Brown 
1665c833c3b5SJed Brown +  coarse - coarse level DM
1666c833c3b5SJed Brown .  interp - matrix interpolating a coarse-level solution to the finer grid
1667c833c3b5SJed Brown .  fine - fine level DM to update
1668c833c3b5SJed Brown -  ctx - optional user-defined function context
1669c833c3b5SJed Brown 
1670c833c3b5SJed Brown    Level: advanced
1671c833c3b5SJed Brown 
1672c833c3b5SJed Brown    Notes:
1673c833c3b5SJed Brown    This function is only needed if auxiliary data needs to be passed to fine grids while grid sequencing
1674c833c3b5SJed Brown 
1675c833c3b5SJed Brown    If this function is called multiple times, the hooks will be run in the order they are added.
1676c833c3b5SJed Brown 
1677bb9467b5SJed Brown    This function is currently not available from Fortran.
1678bb9467b5SJed Brown 
1679c833c3b5SJed Brown .seealso: DMCoarsenHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
1680c833c3b5SJed Brown @*/
1681c833c3b5SJed Brown PetscErrorCode DMRefineHookAdd(DM coarse,PetscErrorCode (*refinehook)(DM,DM,void*),PetscErrorCode (*interphook)(DM,Mat,DM,void*),void *ctx)
1682c833c3b5SJed Brown {
1683c833c3b5SJed Brown   PetscErrorCode   ierr;
1684c833c3b5SJed Brown   DMRefineHookLink link,*p;
1685c833c3b5SJed Brown 
1686c833c3b5SJed Brown   PetscFunctionBegin;
1687c833c3b5SJed Brown   PetscValidHeaderSpecific(coarse,DM_CLASSID,1);
1688c833c3b5SJed Brown   for (p=&coarse->refinehook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */
168995dccacaSBarry Smith   ierr             = PetscNew(&link);CHKERRQ(ierr);
1690c833c3b5SJed Brown   link->refinehook = refinehook;
1691c833c3b5SJed Brown   link->interphook = interphook;
1692c833c3b5SJed Brown   link->ctx        = ctx;
16930298fd71SBarry Smith   link->next       = NULL;
1694c833c3b5SJed Brown   *p               = link;
1695c833c3b5SJed Brown   PetscFunctionReturn(0);
1696c833c3b5SJed Brown }
1697c833c3b5SJed Brown 
1698c833c3b5SJed Brown /*@
1699c833c3b5SJed Brown    DMInterpolate - interpolates user-defined problem data to a finer DM by running hooks registered by DMRefineHookAdd()
1700c833c3b5SJed Brown 
1701c833c3b5SJed Brown    Collective if any hooks are
1702c833c3b5SJed Brown 
1703c833c3b5SJed Brown    Input Arguments:
1704c833c3b5SJed Brown +  coarse - coarser DM to use as a base
1705c833c3b5SJed Brown .  restrct - interpolation matrix, apply using MatInterpolate()
1706c833c3b5SJed Brown -  fine - finer DM to update
1707c833c3b5SJed Brown 
1708c833c3b5SJed Brown    Level: developer
1709c833c3b5SJed Brown 
1710c833c3b5SJed Brown .seealso: DMRefineHookAdd(), MatInterpolate()
1711c833c3b5SJed Brown @*/
1712c833c3b5SJed Brown PetscErrorCode DMInterpolate(DM coarse,Mat interp,DM fine)
1713c833c3b5SJed Brown {
1714c833c3b5SJed Brown   PetscErrorCode   ierr;
1715c833c3b5SJed Brown   DMRefineHookLink link;
1716c833c3b5SJed Brown 
1717c833c3b5SJed Brown   PetscFunctionBegin;
1718c833c3b5SJed Brown   for (link=fine->refinehook; link; link=link->next) {
17198865f1eaSKarl Rupp     if (link->interphook) {
17208865f1eaSKarl Rupp       ierr = (*link->interphook)(coarse,interp,fine,link->ctx);CHKERRQ(ierr);
17218865f1eaSKarl Rupp     }
17224057135bSMatthew G Knepley   }
172347c6ae99SBarry Smith   PetscFunctionReturn(0);
172447c6ae99SBarry Smith }
172547c6ae99SBarry Smith 
1726eb3f98d2SBarry Smith /*@
1727eb3f98d2SBarry Smith     DMGetRefineLevel - Get's the number of refinements that have generated this DM.
1728eb3f98d2SBarry Smith 
1729eb3f98d2SBarry Smith     Not Collective
1730eb3f98d2SBarry Smith 
1731eb3f98d2SBarry Smith     Input Parameter:
1732eb3f98d2SBarry Smith .   dm - the DM object
1733eb3f98d2SBarry Smith 
1734eb3f98d2SBarry Smith     Output Parameter:
1735eb3f98d2SBarry Smith .   level - number of refinements
1736eb3f98d2SBarry Smith 
1737eb3f98d2SBarry Smith     Level: developer
1738eb3f98d2SBarry Smith 
17396a7d9d85SPeter Brune .seealso DMCoarsen(), DMGetCoarsenLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
1740eb3f98d2SBarry Smith 
1741eb3f98d2SBarry Smith @*/
1742eb3f98d2SBarry Smith PetscErrorCode  DMGetRefineLevel(DM dm,PetscInt *level)
1743eb3f98d2SBarry Smith {
1744eb3f98d2SBarry Smith   PetscFunctionBegin;
1745eb3f98d2SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1746eb3f98d2SBarry Smith   *level = dm->levelup;
1747eb3f98d2SBarry Smith   PetscFunctionReturn(0);
1748eb3f98d2SBarry Smith }
1749eb3f98d2SBarry Smith 
1750fef3a512SBarry Smith /*@
1751fef3a512SBarry Smith     DMSetRefineLevel - Set's the number of refinements that have generated this DM.
1752fef3a512SBarry Smith 
1753fef3a512SBarry Smith     Not Collective
1754fef3a512SBarry Smith 
1755fef3a512SBarry Smith     Input Parameter:
1756fef3a512SBarry Smith +   dm - the DM object
1757fef3a512SBarry Smith -   level - number of refinements
1758fef3a512SBarry Smith 
1759fef3a512SBarry Smith     Level: advanced
1760fef3a512SBarry Smith 
1761fef3a512SBarry Smith     Notes: This value is used by PCMG to determine how many multigrid levels to use
1762fef3a512SBarry Smith 
1763fef3a512SBarry Smith .seealso DMCoarsen(), DMGetCoarsenLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
1764fef3a512SBarry Smith 
1765fef3a512SBarry Smith @*/
1766fef3a512SBarry Smith PetscErrorCode  DMSetRefineLevel(DM dm,PetscInt level)
1767fef3a512SBarry Smith {
1768fef3a512SBarry Smith   PetscFunctionBegin;
1769fef3a512SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1770fef3a512SBarry Smith   dm->levelup = level;
1771fef3a512SBarry Smith   PetscFunctionReturn(0);
1772fef3a512SBarry Smith }
1773fef3a512SBarry Smith 
1774bb9467b5SJed Brown /*@C
1775baf369e7SPeter Brune    DMGlobalToLocalHookAdd - adds a callback to be run when global to local is called
1776baf369e7SPeter Brune 
1777baf369e7SPeter Brune    Logically Collective
1778baf369e7SPeter Brune 
1779baf369e7SPeter Brune    Input Arguments:
1780baf369e7SPeter Brune +  dm - the DM
1781baf369e7SPeter Brune .  beginhook - function to run at the beginning of DMGlobalToLocalBegin()
1782baf369e7SPeter Brune .  endhook - function to run after DMGlobalToLocalEnd() has completed
17830298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
1784baf369e7SPeter Brune 
1785baf369e7SPeter Brune    Calling sequence for beginhook:
1786baf369e7SPeter Brune $    beginhook(DM fine,VecScatter out,VecScatter in,DM coarse,void *ctx)
1787baf369e7SPeter Brune 
1788baf369e7SPeter Brune +  dm - global DM
1789baf369e7SPeter Brune .  g - global vector
1790baf369e7SPeter Brune .  mode - mode
1791baf369e7SPeter Brune .  l - local vector
1792baf369e7SPeter Brune -  ctx - optional user-defined function context
1793baf369e7SPeter Brune 
1794baf369e7SPeter Brune 
1795baf369e7SPeter Brune    Calling sequence for endhook:
1796ec4806b8SPeter Brune $    endhook(DM fine,VecScatter out,VecScatter in,DM coarse,void *ctx)
1797baf369e7SPeter Brune 
1798baf369e7SPeter Brune +  global - global DM
1799baf369e7SPeter Brune -  ctx - optional user-defined function context
1800baf369e7SPeter Brune 
1801baf369e7SPeter Brune    Level: advanced
1802baf369e7SPeter Brune 
1803baf369e7SPeter Brune .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
1804baf369e7SPeter Brune @*/
1805baf369e7SPeter Brune PetscErrorCode DMGlobalToLocalHookAdd(DM dm,PetscErrorCode (*beginhook)(DM,Vec,InsertMode,Vec,void*),PetscErrorCode (*endhook)(DM,Vec,InsertMode,Vec,void*),void *ctx)
1806baf369e7SPeter Brune {
1807baf369e7SPeter Brune   PetscErrorCode          ierr;
1808baf369e7SPeter Brune   DMGlobalToLocalHookLink link,*p;
1809baf369e7SPeter Brune 
1810baf369e7SPeter Brune   PetscFunctionBegin;
1811baf369e7SPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1812baf369e7SPeter Brune   for (p=&dm->gtolhook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */
181395dccacaSBarry Smith   ierr            = PetscNew(&link);CHKERRQ(ierr);
1814baf369e7SPeter Brune   link->beginhook = beginhook;
1815baf369e7SPeter Brune   link->endhook   = endhook;
1816baf369e7SPeter Brune   link->ctx       = ctx;
18170298fd71SBarry Smith   link->next      = NULL;
1818baf369e7SPeter Brune   *p              = link;
1819baf369e7SPeter Brune   PetscFunctionReturn(0);
1820baf369e7SPeter Brune }
1821baf369e7SPeter Brune 
18224c274da1SToby Isaac static PetscErrorCode DMGlobalToLocalHook_Constraints(DM dm, Vec g, InsertMode mode, Vec l, void *ctx)
18234c274da1SToby Isaac {
18244c274da1SToby Isaac   Mat cMat;
18254c274da1SToby Isaac   Vec cVec;
18264c274da1SToby Isaac   PetscSection section, cSec;
18274c274da1SToby Isaac   PetscInt pStart, pEnd, p, dof;
18284c274da1SToby Isaac   PetscErrorCode ierr;
18294c274da1SToby Isaac 
18304c274da1SToby Isaac   PetscFunctionBegin;
18314c274da1SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
18324c274da1SToby Isaac   ierr = DMGetDefaultConstraints(dm,&cSec,&cMat);CHKERRQ(ierr);
18334c274da1SToby Isaac   if (cMat && (mode == INSERT_VALUES || mode == INSERT_ALL_VALUES || mode == INSERT_BC_VALUES)) {
18345db9a05bSToby Isaac     PetscInt nRows;
18355db9a05bSToby Isaac 
18365db9a05bSToby Isaac     ierr = MatGetSize(cMat,&nRows,NULL);CHKERRQ(ierr);
18375db9a05bSToby Isaac     if (nRows <= 0) PetscFunctionReturn(0);
18384c274da1SToby Isaac     ierr = DMGetDefaultSection(dm,&section);CHKERRQ(ierr);
18397711e48fSToby Isaac     ierr = MatCreateVecs(cMat,NULL,&cVec);CHKERRQ(ierr);
18404c274da1SToby Isaac     ierr = MatMult(cMat,l,cVec);CHKERRQ(ierr);
18414c274da1SToby Isaac     ierr = PetscSectionGetChart(cSec,&pStart,&pEnd);CHKERRQ(ierr);
18424c274da1SToby Isaac     for (p = pStart; p < pEnd; p++) {
18434c274da1SToby Isaac       ierr = PetscSectionGetDof(cSec,p,&dof);CHKERRQ(ierr);
18444c274da1SToby Isaac       if (dof) {
18454c274da1SToby Isaac         PetscScalar *vals;
18464c274da1SToby Isaac         ierr = VecGetValuesSection(cVec,cSec,p,&vals);CHKERRQ(ierr);
18474c274da1SToby Isaac         ierr = VecSetValuesSection(l,section,p,vals,INSERT_ALL_VALUES);CHKERRQ(ierr);
18484c274da1SToby Isaac       }
18494c274da1SToby Isaac     }
18504c274da1SToby Isaac     ierr = VecDestroy(&cVec);CHKERRQ(ierr);
18514c274da1SToby Isaac   }
18524c274da1SToby Isaac   PetscFunctionReturn(0);
18534c274da1SToby Isaac }
18544c274da1SToby Isaac 
185547c6ae99SBarry Smith /*@
185647c6ae99SBarry Smith     DMGlobalToLocalBegin - Begins updating local vectors from global vector
185747c6ae99SBarry Smith 
185847c6ae99SBarry Smith     Neighbor-wise Collective on DM
185947c6ae99SBarry Smith 
186047c6ae99SBarry Smith     Input Parameters:
186147c6ae99SBarry Smith +   dm - the DM object
186247c6ae99SBarry Smith .   g - the global vector
186347c6ae99SBarry Smith .   mode - INSERT_VALUES or ADD_VALUES
186447c6ae99SBarry Smith -   l - the local vector
186547c6ae99SBarry Smith 
186647c6ae99SBarry Smith 
186747c6ae99SBarry Smith     Level: beginner
186847c6ae99SBarry Smith 
1869e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin()
187047c6ae99SBarry Smith 
187147c6ae99SBarry Smith @*/
18727087cfbeSBarry Smith PetscErrorCode  DMGlobalToLocalBegin(DM dm,Vec g,InsertMode mode,Vec l)
187347c6ae99SBarry Smith {
18747128ae9fSMatthew G Knepley   PetscSF                 sf;
187547c6ae99SBarry Smith   PetscErrorCode          ierr;
1876baf369e7SPeter Brune   DMGlobalToLocalHookLink link;
187747c6ae99SBarry Smith 
187847c6ae99SBarry Smith   PetscFunctionBegin;
1879171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1880baf369e7SPeter Brune   for (link=dm->gtolhook; link; link=link->next) {
18818865f1eaSKarl Rupp     if (link->beginhook) {
18828865f1eaSKarl Rupp       ierr = (*link->beginhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);
18838865f1eaSKarl Rupp     }
1884baf369e7SPeter Brune   }
18857128ae9fSMatthew G Knepley   ierr = DMGetDefaultSF(dm, &sf);CHKERRQ(ierr);
18867128ae9fSMatthew G Knepley   if (sf) {
1887ae5cfb4aSMatthew G. Knepley     const PetscScalar *gArray;
1888ae5cfb4aSMatthew G. Knepley     PetscScalar       *lArray;
18897128ae9fSMatthew G Knepley 
189082f516ccSBarry Smith     if (mode == ADD_VALUES) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
18917128ae9fSMatthew G Knepley     ierr = VecGetArray(l, &lArray);CHKERRQ(ierr);
1892ae5cfb4aSMatthew G. Knepley     ierr = VecGetArrayRead(g, &gArray);CHKERRQ(ierr);
18937128ae9fSMatthew G Knepley     ierr = PetscSFBcastBegin(sf, MPIU_SCALAR, gArray, lArray);CHKERRQ(ierr);
18947128ae9fSMatthew G Knepley     ierr = VecRestoreArray(l, &lArray);CHKERRQ(ierr);
1895ae5cfb4aSMatthew G. Knepley     ierr = VecRestoreArrayRead(g, &gArray);CHKERRQ(ierr);
18967128ae9fSMatthew G Knepley   } else {
1897843c4018SMatthew G Knepley     ierr = (*dm->ops->globaltolocalbegin)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
18987128ae9fSMatthew G Knepley   }
189947c6ae99SBarry Smith   PetscFunctionReturn(0);
190047c6ae99SBarry Smith }
190147c6ae99SBarry Smith 
190247c6ae99SBarry Smith /*@
190347c6ae99SBarry Smith     DMGlobalToLocalEnd - Ends updating local vectors from global vector
190447c6ae99SBarry Smith 
190547c6ae99SBarry Smith     Neighbor-wise Collective on DM
190647c6ae99SBarry Smith 
190747c6ae99SBarry Smith     Input Parameters:
190847c6ae99SBarry Smith +   dm - the DM object
190947c6ae99SBarry Smith .   g - the global vector
191047c6ae99SBarry Smith .   mode - INSERT_VALUES or ADD_VALUES
191147c6ae99SBarry Smith -   l - the local vector
191247c6ae99SBarry Smith 
191347c6ae99SBarry Smith 
191447c6ae99SBarry Smith     Level: beginner
191547c6ae99SBarry Smith 
1916e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin()
191747c6ae99SBarry Smith 
191847c6ae99SBarry Smith @*/
19197087cfbeSBarry Smith PetscErrorCode  DMGlobalToLocalEnd(DM dm,Vec g,InsertMode mode,Vec l)
192047c6ae99SBarry Smith {
19217128ae9fSMatthew G Knepley   PetscSF                 sf;
192247c6ae99SBarry Smith   PetscErrorCode          ierr;
1923ae5cfb4aSMatthew G. Knepley   const PetscScalar      *gArray;
1924ae5cfb4aSMatthew G. Knepley   PetscScalar            *lArray;
1925baf369e7SPeter Brune   DMGlobalToLocalHookLink link;
192647c6ae99SBarry Smith 
192747c6ae99SBarry Smith   PetscFunctionBegin;
1928171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
19297128ae9fSMatthew G Knepley   ierr = DMGetDefaultSF(dm, &sf);CHKERRQ(ierr);
19307128ae9fSMatthew G Knepley   if (sf) {
193182f516ccSBarry Smith     if (mode == ADD_VALUES) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
19327128ae9fSMatthew G Knepley 
19337128ae9fSMatthew G Knepley     ierr = VecGetArray(l, &lArray);CHKERRQ(ierr);
1934ae5cfb4aSMatthew G. Knepley     ierr = VecGetArrayRead(g, &gArray);CHKERRQ(ierr);
19357128ae9fSMatthew G Knepley     ierr = PetscSFBcastEnd(sf, MPIU_SCALAR, gArray, lArray);CHKERRQ(ierr);
19367128ae9fSMatthew G Knepley     ierr = VecRestoreArray(l, &lArray);CHKERRQ(ierr);
1937ae5cfb4aSMatthew G. Knepley     ierr = VecRestoreArrayRead(g, &gArray);CHKERRQ(ierr);
19387128ae9fSMatthew G Knepley   } else {
1939843c4018SMatthew G Knepley     ierr = (*dm->ops->globaltolocalend)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
19407128ae9fSMatthew G Knepley   }
19414c274da1SToby Isaac   ierr = DMGlobalToLocalHook_Constraints(dm,g,mode,l,NULL);CHKERRQ(ierr);
1942baf369e7SPeter Brune   for (link=dm->gtolhook; link; link=link->next) {
1943baf369e7SPeter Brune     if (link->endhook) {ierr = (*link->endhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);}
1944baf369e7SPeter Brune   }
194547c6ae99SBarry Smith   PetscFunctionReturn(0);
194647c6ae99SBarry Smith }
194747c6ae99SBarry Smith 
1948d4d07f1eSToby Isaac /*@C
1949d4d07f1eSToby Isaac    DMLocalToGlobalHookAdd - adds a callback to be run when a local to global is called
1950d4d07f1eSToby Isaac 
1951d4d07f1eSToby Isaac    Logically Collective
1952d4d07f1eSToby Isaac 
1953d4d07f1eSToby Isaac    Input Arguments:
1954d4d07f1eSToby Isaac +  dm - the DM
1955d4d07f1eSToby Isaac .  beginhook - function to run at the beginning of DMLocalToGlobalBegin()
1956d4d07f1eSToby Isaac .  endhook - function to run after DMLocalToGlobalEnd() has completed
1957d4d07f1eSToby Isaac -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
1958d4d07f1eSToby Isaac 
1959d4d07f1eSToby Isaac    Calling sequence for beginhook:
1960d4d07f1eSToby Isaac $    beginhook(DM fine,Vec l,InsertMode mode,Vec g,void *ctx)
1961d4d07f1eSToby Isaac 
1962d4d07f1eSToby Isaac +  dm - global DM
1963d4d07f1eSToby Isaac .  l - local vector
1964d4d07f1eSToby Isaac .  mode - mode
1965d4d07f1eSToby Isaac .  g - global vector
1966d4d07f1eSToby Isaac -  ctx - optional user-defined function context
1967d4d07f1eSToby Isaac 
1968d4d07f1eSToby Isaac 
1969d4d07f1eSToby Isaac    Calling sequence for endhook:
1970d4d07f1eSToby Isaac $    endhook(DM fine,Vec l,InsertMode mode,Vec g,void *ctx)
1971d4d07f1eSToby Isaac 
1972d4d07f1eSToby Isaac +  global - global DM
1973d4d07f1eSToby Isaac .  l - local vector
1974d4d07f1eSToby Isaac .  mode - mode
1975d4d07f1eSToby Isaac .  g - global vector
1976d4d07f1eSToby Isaac -  ctx - optional user-defined function context
1977d4d07f1eSToby Isaac 
1978d4d07f1eSToby Isaac    Level: advanced
1979d4d07f1eSToby Isaac 
1980d4d07f1eSToby Isaac .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
1981d4d07f1eSToby Isaac @*/
1982d4d07f1eSToby Isaac PetscErrorCode DMLocalToGlobalHookAdd(DM dm,PetscErrorCode (*beginhook)(DM,Vec,InsertMode,Vec,void*),PetscErrorCode (*endhook)(DM,Vec,InsertMode,Vec,void*),void *ctx)
1983d4d07f1eSToby Isaac {
1984d4d07f1eSToby Isaac   PetscErrorCode          ierr;
1985d4d07f1eSToby Isaac   DMLocalToGlobalHookLink link,*p;
1986d4d07f1eSToby Isaac 
1987d4d07f1eSToby Isaac   PetscFunctionBegin;
1988d4d07f1eSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1989d4d07f1eSToby Isaac   for (p=&dm->ltoghook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */
199095dccacaSBarry Smith   ierr            = PetscNew(&link);CHKERRQ(ierr);
1991d4d07f1eSToby Isaac   link->beginhook = beginhook;
1992d4d07f1eSToby Isaac   link->endhook   = endhook;
1993d4d07f1eSToby Isaac   link->ctx       = ctx;
1994d4d07f1eSToby Isaac   link->next      = NULL;
1995d4d07f1eSToby Isaac   *p              = link;
1996d4d07f1eSToby Isaac   PetscFunctionReturn(0);
1997d4d07f1eSToby Isaac }
1998d4d07f1eSToby Isaac 
19994c274da1SToby Isaac static PetscErrorCode DMLocalToGlobalHook_Constraints(DM dm, Vec l, InsertMode mode, Vec g, void *ctx)
20004c274da1SToby Isaac {
20014c274da1SToby Isaac   Mat cMat;
20024c274da1SToby Isaac   Vec cVec;
20034c274da1SToby Isaac   PetscSection section, cSec;
20044c274da1SToby Isaac   PetscInt pStart, pEnd, p, dof;
20054c274da1SToby Isaac   PetscErrorCode ierr;
20064c274da1SToby Isaac 
20074c274da1SToby Isaac   PetscFunctionBegin;
20084c274da1SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
20094c274da1SToby Isaac   ierr = DMGetDefaultConstraints(dm,&cSec,&cMat);CHKERRQ(ierr);
20104c274da1SToby Isaac   if (cMat && (mode == ADD_VALUES || mode == ADD_ALL_VALUES || mode == ADD_BC_VALUES)) {
20115db9a05bSToby Isaac     PetscInt nRows;
20125db9a05bSToby Isaac 
20135db9a05bSToby Isaac     ierr = MatGetSize(cMat,&nRows,NULL);CHKERRQ(ierr);
20145db9a05bSToby Isaac     if (nRows <= 0) PetscFunctionReturn(0);
20154c274da1SToby Isaac     ierr = DMGetDefaultSection(dm,&section);CHKERRQ(ierr);
20167711e48fSToby Isaac     ierr = MatCreateVecs(cMat,NULL,&cVec);CHKERRQ(ierr);
20174c274da1SToby Isaac     ierr = PetscSectionGetChart(cSec,&pStart,&pEnd);CHKERRQ(ierr);
20184c274da1SToby Isaac     for (p = pStart; p < pEnd; p++) {
20194c274da1SToby Isaac       ierr = PetscSectionGetDof(cSec,p,&dof);CHKERRQ(ierr);
20204c274da1SToby Isaac       if (dof) {
20214c274da1SToby Isaac         PetscInt d;
20224c274da1SToby Isaac         PetscScalar *vals;
20234c274da1SToby Isaac         ierr = VecGetValuesSection(l,section,p,&vals);CHKERRQ(ierr);
20244c274da1SToby Isaac         ierr = VecSetValuesSection(cVec,cSec,p,vals,mode);CHKERRQ(ierr);
20254c274da1SToby Isaac         /* for this to be the true transpose, we have to zero the values that
20264c274da1SToby Isaac          * we just extracted */
20274c274da1SToby Isaac         for (d = 0; d < dof; d++) {
20284c274da1SToby Isaac           vals[d] = 0.;
20294c274da1SToby Isaac         }
20304c274da1SToby Isaac       }
20314c274da1SToby Isaac     }
20324c274da1SToby Isaac     ierr = MatMultTransposeAdd(cMat,cVec,l,l);CHKERRQ(ierr);
20334c274da1SToby Isaac     ierr = VecDestroy(&cVec);CHKERRQ(ierr);
20344c274da1SToby Isaac   }
20354c274da1SToby Isaac   PetscFunctionReturn(0);
20364c274da1SToby Isaac }
20374c274da1SToby Isaac 
203847c6ae99SBarry Smith /*@
20399a42bb27SBarry Smith     DMLocalToGlobalBegin - updates global vectors from local vectors
20409a42bb27SBarry Smith 
20419a42bb27SBarry Smith     Neighbor-wise Collective on DM
20429a42bb27SBarry Smith 
20439a42bb27SBarry Smith     Input Parameters:
20449a42bb27SBarry Smith +   dm - the DM object
2045f6813fd5SJed Brown .   l - the local vector
20461eb28f2eSBarry 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.
20471eb28f2eSBarry Smith -   g - the global vector
20489a42bb27SBarry Smith 
2049d96308ebSBarry Smith     Notes: In the ADD_VALUES case you normally would zero the receiving vector before beginning this operation.
205084330215SMatthew 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.
20519a42bb27SBarry Smith 
20529a42bb27SBarry Smith     Level: beginner
20539a42bb27SBarry Smith 
2054e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMGlobalToLocalBegin()
20559a42bb27SBarry Smith 
20569a42bb27SBarry Smith @*/
20577087cfbeSBarry Smith PetscErrorCode  DMLocalToGlobalBegin(DM dm,Vec l,InsertMode mode,Vec g)
20589a42bb27SBarry Smith {
20597128ae9fSMatthew G Knepley   PetscSF                 sf;
206084330215SMatthew G. Knepley   PetscSection            s, gs;
2061d4d07f1eSToby Isaac   DMLocalToGlobalHookLink link;
2062ae5cfb4aSMatthew G. Knepley   const PetscScalar      *lArray;
2063ae5cfb4aSMatthew G. Knepley   PetscScalar            *gArray;
206484330215SMatthew G. Knepley   PetscBool               isInsert;
206584330215SMatthew G. Knepley   PetscErrorCode          ierr;
20669a42bb27SBarry Smith 
20679a42bb27SBarry Smith   PetscFunctionBegin;
2068171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2069d4d07f1eSToby Isaac   for (link=dm->ltoghook; link; link=link->next) {
2070d4d07f1eSToby Isaac     if (link->beginhook) {
2071d4d07f1eSToby Isaac       ierr = (*link->beginhook)(dm,l,mode,g,link->ctx);CHKERRQ(ierr);
2072d4d07f1eSToby Isaac     }
2073d4d07f1eSToby Isaac   }
20744c274da1SToby Isaac   ierr = DMLocalToGlobalHook_Constraints(dm,l,mode,g,NULL);CHKERRQ(ierr);
20757128ae9fSMatthew G Knepley   ierr = DMGetDefaultSF(dm, &sf);CHKERRQ(ierr);
207684330215SMatthew G. Knepley   ierr = DMGetDefaultSection(dm, &s);CHKERRQ(ierr);
20777128ae9fSMatthew G Knepley   switch (mode) {
20787128ae9fSMatthew G Knepley   case INSERT_VALUES:
20797128ae9fSMatthew G Knepley   case INSERT_ALL_VALUES:
2080304ab55fSMatthew G. Knepley   case INSERT_BC_VALUES:
208184330215SMatthew G. Knepley     isInsert = PETSC_TRUE; break;
20827128ae9fSMatthew G Knepley   case ADD_VALUES:
20837128ae9fSMatthew G Knepley   case ADD_ALL_VALUES:
2084304ab55fSMatthew G. Knepley   case ADD_BC_VALUES:
208584330215SMatthew G. Knepley     isInsert = PETSC_FALSE; break;
20867128ae9fSMatthew G Knepley   default:
208782f516ccSBarry Smith     SETERRQ1(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
20887128ae9fSMatthew G Knepley   }
208984330215SMatthew G. Knepley   if (sf && !isInsert) {
2090ae5cfb4aSMatthew G. Knepley     ierr = VecGetArrayRead(l, &lArray);CHKERRQ(ierr);
20917128ae9fSMatthew G Knepley     ierr = VecGetArray(g, &gArray);CHKERRQ(ierr);
2092a9b180a6SBarry Smith     ierr = PetscSFReduceBegin(sf, MPIU_SCALAR, lArray, gArray, MPIU_SUM);CHKERRQ(ierr);
2093ae5cfb4aSMatthew G. Knepley     ierr = VecRestoreArrayRead(l, &lArray);CHKERRQ(ierr);
209484330215SMatthew G. Knepley     ierr = VecRestoreArray(g, &gArray);CHKERRQ(ierr);
209584330215SMatthew G. Knepley   } else if (s && isInsert) {
209684330215SMatthew G. Knepley     PetscInt gStart, pStart, pEnd, p;
209784330215SMatthew G. Knepley 
209884330215SMatthew G. Knepley     ierr = DMGetDefaultGlobalSection(dm, &gs);CHKERRQ(ierr);
209984330215SMatthew G. Knepley     ierr = PetscSectionGetChart(s, &pStart, &pEnd);CHKERRQ(ierr);
210084330215SMatthew G. Knepley     ierr = VecGetOwnershipRange(g, &gStart, NULL);CHKERRQ(ierr);
2101ae5cfb4aSMatthew G. Knepley     ierr = VecGetArrayRead(l, &lArray);CHKERRQ(ierr);
210284330215SMatthew G. Knepley     ierr = VecGetArray(g, &gArray);CHKERRQ(ierr);
210384330215SMatthew G. Knepley     for (p = pStart; p < pEnd; ++p) {
2104b3b16f48SMatthew G. Knepley       PetscInt dof, gdof, cdof, gcdof, off, goff, d, e;
210584330215SMatthew G. Knepley 
210684330215SMatthew G. Knepley       ierr = PetscSectionGetDof(s, p, &dof);CHKERRQ(ierr);
210703442857SMatthew G. Knepley       ierr = PetscSectionGetDof(gs, p, &gdof);CHKERRQ(ierr);
210884330215SMatthew G. Knepley       ierr = PetscSectionGetConstraintDof(s, p, &cdof);CHKERRQ(ierr);
2109b3b16f48SMatthew G. Knepley       ierr = PetscSectionGetConstraintDof(gs, p, &gcdof);CHKERRQ(ierr);
211084330215SMatthew G. Knepley       ierr = PetscSectionGetOffset(s, p, &off);CHKERRQ(ierr);
211184330215SMatthew G. Knepley       ierr = PetscSectionGetOffset(gs, p, &goff);CHKERRQ(ierr);
2112b3b16f48SMatthew G. Knepley       /* Ignore off-process data and points with no global data */
211303442857SMatthew G. Knepley       if (!gdof || goff < 0) continue;
2114b3b16f48SMatthew 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);
2115b3b16f48SMatthew G. Knepley       /* If no constraints are enforced in the global vector */
2116b3b16f48SMatthew G. Knepley       if (!gcdof) {
211784330215SMatthew G. Knepley         for (d = 0; d < dof; ++d) gArray[goff-gStart+d] = lArray[off+d];
2118b3b16f48SMatthew G. Knepley       /* If constraints are enforced in the global vector */
2119b3b16f48SMatthew G. Knepley       } else if (cdof == gcdof) {
212084330215SMatthew G. Knepley         const PetscInt *cdofs;
212184330215SMatthew G. Knepley         PetscInt        cind = 0;
212284330215SMatthew G. Knepley 
212384330215SMatthew G. Knepley         ierr = PetscSectionGetConstraintIndices(s, p, &cdofs);CHKERRQ(ierr);
2124b3b16f48SMatthew G. Knepley         for (d = 0, e = 0; d < dof; ++d) {
212584330215SMatthew G. Knepley           if ((cind < cdof) && (d == cdofs[cind])) {++cind; continue;}
2126b3b16f48SMatthew G. Knepley           gArray[goff-gStart+e++] = lArray[off+d];
212784330215SMatthew G. Knepley         }
2128b3b16f48SMatthew 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);
212984330215SMatthew G. Knepley     }
2130ae5cfb4aSMatthew G. Knepley     ierr = VecRestoreArrayRead(l, &lArray);CHKERRQ(ierr);
21317128ae9fSMatthew G Knepley     ierr = VecRestoreArray(g, &gArray);CHKERRQ(ierr);
21327128ae9fSMatthew G Knepley   } else {
2133843c4018SMatthew G Knepley     ierr = (*dm->ops->localtoglobalbegin)(dm,l,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),g);CHKERRQ(ierr);
21347128ae9fSMatthew G Knepley   }
21359a42bb27SBarry Smith   PetscFunctionReturn(0);
21369a42bb27SBarry Smith }
21379a42bb27SBarry Smith 
21389a42bb27SBarry Smith /*@
21399a42bb27SBarry Smith     DMLocalToGlobalEnd - updates global vectors from local vectors
214047c6ae99SBarry Smith 
214147c6ae99SBarry Smith     Neighbor-wise Collective on DM
214247c6ae99SBarry Smith 
214347c6ae99SBarry Smith     Input Parameters:
214447c6ae99SBarry Smith +   dm - the DM object
2145f6813fd5SJed Brown .   l - the local vector
214647c6ae99SBarry Smith .   mode - INSERT_VALUES or ADD_VALUES
2147f6813fd5SJed Brown -   g - the global vector
214847c6ae99SBarry Smith 
214947c6ae99SBarry Smith 
215047c6ae99SBarry Smith     Level: beginner
215147c6ae99SBarry Smith 
2152e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMGlobalToLocalEnd()
215347c6ae99SBarry Smith 
215447c6ae99SBarry Smith @*/
21557087cfbeSBarry Smith PetscErrorCode  DMLocalToGlobalEnd(DM dm,Vec l,InsertMode mode,Vec g)
215647c6ae99SBarry Smith {
21577128ae9fSMatthew G Knepley   PetscSF                 sf;
215884330215SMatthew G. Knepley   PetscSection            s;
2159d4d07f1eSToby Isaac   DMLocalToGlobalHookLink link;
216084330215SMatthew G. Knepley   PetscBool               isInsert;
216184330215SMatthew G. Knepley   PetscErrorCode          ierr;
216247c6ae99SBarry Smith 
216347c6ae99SBarry Smith   PetscFunctionBegin;
2164171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
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:
217084330215SMatthew G. Knepley     isInsert = PETSC_TRUE; break;
21717128ae9fSMatthew G Knepley   case ADD_VALUES:
21727128ae9fSMatthew G Knepley   case ADD_ALL_VALUES:
217384330215SMatthew G. Knepley     isInsert = PETSC_FALSE; break;
21747128ae9fSMatthew G Knepley   default:
217582f516ccSBarry Smith     SETERRQ1(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
21767128ae9fSMatthew G Knepley   }
217784330215SMatthew G. Knepley   if (sf && !isInsert) {
2178ae5cfb4aSMatthew G. Knepley     const PetscScalar *lArray;
2179ae5cfb4aSMatthew G. Knepley     PetscScalar       *gArray;
218084330215SMatthew G. Knepley 
2181ae5cfb4aSMatthew G. Knepley     ierr = VecGetArrayRead(l, &lArray);CHKERRQ(ierr);
21827128ae9fSMatthew G Knepley     ierr = VecGetArray(g, &gArray);CHKERRQ(ierr);
2183a9b180a6SBarry Smith     ierr = PetscSFReduceEnd(sf, MPIU_SCALAR, lArray, gArray, MPIU_SUM);CHKERRQ(ierr);
2184ae5cfb4aSMatthew G. Knepley     ierr = VecRestoreArrayRead(l, &lArray);CHKERRQ(ierr);
21857128ae9fSMatthew G Knepley     ierr = VecRestoreArray(g, &gArray);CHKERRQ(ierr);
218684330215SMatthew G. Knepley   } else if (s && isInsert) {
21877128ae9fSMatthew G Knepley   } else {
2188843c4018SMatthew G Knepley     ierr = (*dm->ops->localtoglobalend)(dm,l,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),g);CHKERRQ(ierr);
21897128ae9fSMatthew G Knepley   }
2190d4d07f1eSToby Isaac   for (link=dm->ltoghook; link; link=link->next) {
2191d4d07f1eSToby Isaac     if (link->endhook) {ierr = (*link->endhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);}
2192d4d07f1eSToby Isaac   }
219347c6ae99SBarry Smith   PetscFunctionReturn(0);
219447c6ae99SBarry Smith }
219547c6ae99SBarry Smith 
2196f089877aSRichard Tran Mills /*@
2197bc0a1609SRichard Tran Mills    DMLocalToLocalBegin - Maps from a local vector (including ghost points
2198bc0a1609SRichard Tran Mills    that contain irrelevant values) to another local vector where the ghost
2199d78e899eSRichard Tran Mills    points in the second are set correctly. Must be followed by DMLocalToLocalEnd().
2200f089877aSRichard Tran Mills 
2201bc0a1609SRichard Tran Mills    Neighbor-wise Collective on DM and Vec
2202f089877aSRichard Tran Mills 
2203f089877aSRichard Tran Mills    Input Parameters:
2204f089877aSRichard Tran Mills +  dm - the DM object
2205bc0a1609SRichard Tran Mills .  g - the original local vector
2206bc0a1609SRichard Tran Mills -  mode - one of INSERT_VALUES or ADD_VALUES
2207f089877aSRichard Tran Mills 
2208bc0a1609SRichard Tran Mills    Output Parameter:
2209bc0a1609SRichard Tran Mills .  l  - the local vector with correct ghost values
2210f089877aSRichard Tran Mills 
2211f089877aSRichard Tran Mills    Level: intermediate
2212f089877aSRichard Tran Mills 
2213bc0a1609SRichard Tran Mills    Notes:
2214bc0a1609SRichard Tran Mills    The local vectors used here need not be the same as those
2215bc0a1609SRichard Tran Mills    obtained from DMCreateLocalVector(), BUT they
2216bc0a1609SRichard Tran Mills    must have the same parallel data layout; they could, for example, be
2217bc0a1609SRichard Tran Mills    obtained with VecDuplicate() from the DM originating vectors.
2218bc0a1609SRichard Tran Mills 
2219bc0a1609SRichard Tran Mills .keywords: DM, local-to-local, begin
2220bc0a1609SRichard Tran Mills .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateLocalVector(), DMCreateGlobalVector(), DMCreateInterpolation(), DMLocalToLocalEnd(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin()
2221f089877aSRichard Tran Mills 
2222f089877aSRichard Tran Mills @*/
2223f089877aSRichard Tran Mills PetscErrorCode  DMLocalToLocalBegin(DM dm,Vec g,InsertMode mode,Vec l)
2224f089877aSRichard Tran Mills {
2225f089877aSRichard Tran Mills   PetscErrorCode          ierr;
2226f089877aSRichard Tran Mills 
2227f089877aSRichard Tran Mills   PetscFunctionBegin;
2228f089877aSRichard Tran Mills   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2229f089877aSRichard Tran Mills   ierr = (*dm->ops->localtolocalbegin)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
2230f089877aSRichard Tran Mills   PetscFunctionReturn(0);
2231f089877aSRichard Tran Mills }
2232f089877aSRichard Tran Mills 
2233f089877aSRichard Tran Mills /*@
2234bc0a1609SRichard Tran Mills    DMLocalToLocalEnd - Maps from a local vector (including ghost points
2235bc0a1609SRichard Tran Mills    that contain irrelevant values) to another local vector where the ghost
2236d78e899eSRichard Tran Mills    points in the second are set correctly. Must be preceded by DMLocalToLocalBegin().
2237f089877aSRichard Tran Mills 
2238bc0a1609SRichard Tran Mills    Neighbor-wise Collective on DM and Vec
2239f089877aSRichard Tran Mills 
2240f089877aSRichard Tran Mills    Input Parameters:
2241bc0a1609SRichard Tran Mills +  da - the DM object
2242bc0a1609SRichard Tran Mills .  g - the original local vector
2243bc0a1609SRichard Tran Mills -  mode - one of INSERT_VALUES or ADD_VALUES
2244f089877aSRichard Tran Mills 
2245bc0a1609SRichard Tran Mills    Output Parameter:
2246bc0a1609SRichard Tran Mills .  l  - the local vector with correct ghost values
2247f089877aSRichard Tran Mills 
2248f089877aSRichard Tran Mills    Level: intermediate
2249f089877aSRichard Tran Mills 
2250bc0a1609SRichard Tran Mills    Notes:
2251bc0a1609SRichard Tran Mills    The local vectors used here need not be the same as those
2252bc0a1609SRichard Tran Mills    obtained from DMCreateLocalVector(), BUT they
2253bc0a1609SRichard Tran Mills    must have the same parallel data layout; they could, for example, be
2254bc0a1609SRichard Tran Mills    obtained with VecDuplicate() from the DM originating vectors.
2255bc0a1609SRichard Tran Mills 
2256bc0a1609SRichard Tran Mills .keywords: DM, local-to-local, end
2257bc0a1609SRichard Tran Mills .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateLocalVector(), DMCreateGlobalVector(), DMCreateInterpolation(), DMLocalToLocalBegin(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin()
2258f089877aSRichard Tran Mills 
2259f089877aSRichard Tran Mills @*/
2260f089877aSRichard Tran Mills PetscErrorCode  DMLocalToLocalEnd(DM dm,Vec g,InsertMode mode,Vec l)
2261f089877aSRichard Tran Mills {
2262f089877aSRichard Tran Mills   PetscErrorCode          ierr;
2263f089877aSRichard Tran Mills 
2264f089877aSRichard Tran Mills   PetscFunctionBegin;
2265f089877aSRichard Tran Mills   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2266f089877aSRichard Tran Mills   ierr = (*dm->ops->localtolocalend)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
2267f089877aSRichard Tran Mills   PetscFunctionReturn(0);
2268f089877aSRichard Tran Mills }
2269f089877aSRichard Tran Mills 
2270f089877aSRichard Tran Mills 
227147c6ae99SBarry Smith /*@
227247c6ae99SBarry Smith     DMCoarsen - Coarsens a DM object
227347c6ae99SBarry Smith 
227447c6ae99SBarry Smith     Collective on DM
227547c6ae99SBarry Smith 
227647c6ae99SBarry Smith     Input Parameter:
227747c6ae99SBarry Smith +   dm - the DM object
227891d95f02SJed Brown -   comm - the communicator to contain the new DM object (or MPI_COMM_NULL)
227947c6ae99SBarry Smith 
228047c6ae99SBarry Smith     Output Parameter:
228147c6ae99SBarry Smith .   dmc - the coarsened DM
228247c6ae99SBarry Smith 
228347c6ae99SBarry Smith     Level: developer
228447c6ae99SBarry Smith 
2285e727c939SJed Brown .seealso DMRefine(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
228647c6ae99SBarry Smith 
228747c6ae99SBarry Smith @*/
22887087cfbeSBarry Smith PetscErrorCode DMCoarsen(DM dm, MPI_Comm comm, DM *dmc)
228947c6ae99SBarry Smith {
229047c6ae99SBarry Smith   PetscErrorCode    ierr;
2291b17ce1afSJed Brown   DMCoarsenHookLink link;
229247c6ae99SBarry Smith 
229347c6ae99SBarry Smith   PetscFunctionBegin;
2294171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2295fef3a512SBarry Smith   if (!dm->ops->coarsen) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"This DM cannot coarsen");
229647a35634SPatrick Farrell   ierr = PetscLogEventBegin(DM_Coarsen,dm,0,0,0);CHKERRQ(ierr);
229747c6ae99SBarry Smith   ierr                      = (*dm->ops->coarsen)(dm, comm, dmc);CHKERRQ(ierr);
22988892b4c3SMatthew G. Knepley   if (!(*dmc)) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "NULL coarse mesh produced");
2299a8fb8f29SToby Isaac   ierr = DMSetCoarseDM(dm,*dmc);CHKERRQ(ierr);
230043842a1eSJed Brown   (*dmc)->ops->creatematrix = dm->ops->creatematrix;
23018cd211a4SJed Brown   ierr                      = PetscObjectCopyFortranFunctionPointers((PetscObject)dm,(PetscObject)*dmc);CHKERRQ(ierr);
2302644e2e5bSBarry Smith   (*dmc)->ctx               = dm->ctx;
23030598a293SJed Brown   (*dmc)->levelup           = dm->levelup;
2304656b349aSBarry Smith   (*dmc)->leveldown         = dm->leveldown + 1;
2305e4b4b23bSJed Brown   ierr                      = DMSetMatType(*dmc,dm->mattype);CHKERRQ(ierr);
2306b17ce1afSJed Brown   for (link=dm->coarsenhook; link; link=link->next) {
2307b17ce1afSJed Brown     if (link->coarsenhook) {ierr = (*link->coarsenhook)(dm,*dmc,link->ctx);CHKERRQ(ierr);}
2308b17ce1afSJed Brown   }
230947a35634SPatrick Farrell   ierr = PetscLogEventEnd(DM_Coarsen,dm,0,0,0);CHKERRQ(ierr);
2310b17ce1afSJed Brown   PetscFunctionReturn(0);
2311b17ce1afSJed Brown }
2312b17ce1afSJed Brown 
2313bb9467b5SJed Brown /*@C
2314b17ce1afSJed Brown    DMCoarsenHookAdd - adds a callback to be run when restricting a nonlinear problem to the coarse grid
2315b17ce1afSJed Brown 
2316b17ce1afSJed Brown    Logically Collective
2317b17ce1afSJed Brown 
2318b17ce1afSJed Brown    Input Arguments:
2319b17ce1afSJed Brown +  fine - nonlinear solver context on which to run a hook when restricting to a coarser level
2320b17ce1afSJed Brown .  coarsenhook - function to run when setting up a coarser level
2321b17ce1afSJed Brown .  restricthook - function to run to update data on coarser levels (once per SNESSolve())
23220298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
2323b17ce1afSJed Brown 
2324b17ce1afSJed Brown    Calling sequence of coarsenhook:
2325b17ce1afSJed Brown $    coarsenhook(DM fine,DM coarse,void *ctx);
2326b17ce1afSJed Brown 
2327b17ce1afSJed Brown +  fine - fine level DM
2328b17ce1afSJed Brown .  coarse - coarse level DM to restrict problem to
2329b17ce1afSJed Brown -  ctx - optional user-defined function context
2330b17ce1afSJed Brown 
2331b17ce1afSJed Brown    Calling sequence for restricthook:
2332c833c3b5SJed Brown $    restricthook(DM fine,Mat mrestrict,Vec rscale,Mat inject,DM coarse,void *ctx)
2333b17ce1afSJed Brown 
2334b17ce1afSJed Brown +  fine - fine level DM
2335b17ce1afSJed Brown .  mrestrict - matrix restricting a fine-level solution to the coarse grid
2336c833c3b5SJed Brown .  rscale - scaling vector for restriction
2337c833c3b5SJed Brown .  inject - matrix restricting by injection
2338b17ce1afSJed Brown .  coarse - coarse level DM to update
2339b17ce1afSJed Brown -  ctx - optional user-defined function context
2340b17ce1afSJed Brown 
2341b17ce1afSJed Brown    Level: advanced
2342b17ce1afSJed Brown 
2343b17ce1afSJed Brown    Notes:
2344b17ce1afSJed Brown    This function is only needed if auxiliary data needs to be set up on coarse grids.
2345b17ce1afSJed Brown 
2346b17ce1afSJed Brown    If this function is called multiple times, the hooks will be run in the order they are added.
2347b17ce1afSJed Brown 
2348b17ce1afSJed Brown    In order to compose with nonlinear preconditioning without duplicating storage, the hook should be implemented to
2349b17ce1afSJed Brown    extract the finest level information from its context (instead of from the SNES).
2350b17ce1afSJed Brown 
2351bb9467b5SJed Brown    This function is currently not available from Fortran.
2352bb9467b5SJed Brown 
2353c833c3b5SJed Brown .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
2354b17ce1afSJed Brown @*/
2355b17ce1afSJed Brown PetscErrorCode DMCoarsenHookAdd(DM fine,PetscErrorCode (*coarsenhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,Mat,Vec,Mat,DM,void*),void *ctx)
2356b17ce1afSJed Brown {
2357b17ce1afSJed Brown   PetscErrorCode    ierr;
2358b17ce1afSJed Brown   DMCoarsenHookLink link,*p;
2359b17ce1afSJed Brown 
2360b17ce1afSJed Brown   PetscFunctionBegin;
2361b17ce1afSJed Brown   PetscValidHeaderSpecific(fine,DM_CLASSID,1);
23626bfea28cSJed Brown   for (p=&fine->coarsenhook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */
236395dccacaSBarry Smith   ierr               = PetscNew(&link);CHKERRQ(ierr);
2364b17ce1afSJed Brown   link->coarsenhook  = coarsenhook;
2365b17ce1afSJed Brown   link->restricthook = restricthook;
2366b17ce1afSJed Brown   link->ctx          = ctx;
23670298fd71SBarry Smith   link->next         = NULL;
2368b17ce1afSJed Brown   *p                 = link;
2369b17ce1afSJed Brown   PetscFunctionReturn(0);
2370b17ce1afSJed Brown }
2371b17ce1afSJed Brown 
2372b17ce1afSJed Brown /*@
2373b17ce1afSJed Brown    DMRestrict - restricts user-defined problem data to a coarser DM by running hooks registered by DMCoarsenHookAdd()
2374b17ce1afSJed Brown 
2375b17ce1afSJed Brown    Collective if any hooks are
2376b17ce1afSJed Brown 
2377b17ce1afSJed Brown    Input Arguments:
2378b17ce1afSJed Brown +  fine - finer DM to use as a base
2379b17ce1afSJed Brown .  restrct - restriction matrix, apply using MatRestrict()
2380b17ce1afSJed Brown .  inject - injection matrix, also use MatRestrict()
2381b17ce1afSJed Brown -  coarse - coarer DM to update
2382b17ce1afSJed Brown 
2383b17ce1afSJed Brown    Level: developer
2384b17ce1afSJed Brown 
2385b17ce1afSJed Brown .seealso: DMCoarsenHookAdd(), MatRestrict()
2386b17ce1afSJed Brown @*/
2387b17ce1afSJed Brown PetscErrorCode DMRestrict(DM fine,Mat restrct,Vec rscale,Mat inject,DM coarse)
2388b17ce1afSJed Brown {
2389b17ce1afSJed Brown   PetscErrorCode    ierr;
2390b17ce1afSJed Brown   DMCoarsenHookLink link;
2391b17ce1afSJed Brown 
2392b17ce1afSJed Brown   PetscFunctionBegin;
2393b17ce1afSJed Brown   for (link=fine->coarsenhook; link; link=link->next) {
23948865f1eaSKarl Rupp     if (link->restricthook) {
23958865f1eaSKarl Rupp       ierr = (*link->restricthook)(fine,restrct,rscale,inject,coarse,link->ctx);CHKERRQ(ierr);
23968865f1eaSKarl Rupp     }
2397b17ce1afSJed Brown   }
239847c6ae99SBarry Smith   PetscFunctionReturn(0);
239947c6ae99SBarry Smith }
240047c6ae99SBarry Smith 
2401bb9467b5SJed Brown /*@C
2402be081cd6SPeter Brune    DMSubDomainHookAdd - adds a callback to be run when restricting a problem to the coarse grid
24035dbd56e3SPeter Brune 
24045dbd56e3SPeter Brune    Logically Collective
24055dbd56e3SPeter Brune 
24065dbd56e3SPeter Brune    Input Arguments:
24075dbd56e3SPeter Brune +  global - global DM
2408ec4806b8SPeter Brune .  ddhook - function to run to pass data to the decomposition DM upon its creation
24095dbd56e3SPeter Brune .  restricthook - function to run to update data on block solve (at the beginning of the block solve)
24100298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
24115dbd56e3SPeter Brune 
2412ec4806b8SPeter Brune 
2413ec4806b8SPeter Brune    Calling sequence for ddhook:
2414ec4806b8SPeter Brune $    ddhook(DM global,DM block,void *ctx)
2415ec4806b8SPeter Brune 
2416ec4806b8SPeter Brune +  global - global DM
2417ec4806b8SPeter Brune .  block  - block DM
2418ec4806b8SPeter Brune -  ctx - optional user-defined function context
2419ec4806b8SPeter Brune 
24205dbd56e3SPeter Brune    Calling sequence for restricthook:
2421ec4806b8SPeter Brune $    restricthook(DM global,VecScatter out,VecScatter in,DM block,void *ctx)
24225dbd56e3SPeter Brune 
24235dbd56e3SPeter Brune +  global - global DM
24245dbd56e3SPeter Brune .  out    - scatter to the outer (with ghost and overlap points) block vector
24255dbd56e3SPeter Brune .  in     - scatter to block vector values only owned locally
2426ec4806b8SPeter Brune .  block  - block DM
24275dbd56e3SPeter Brune -  ctx - optional user-defined function context
24285dbd56e3SPeter Brune 
24295dbd56e3SPeter Brune    Level: advanced
24305dbd56e3SPeter Brune 
24315dbd56e3SPeter Brune    Notes:
2432ec4806b8SPeter Brune    This function is only needed if auxiliary data needs to be set up on subdomain DMs.
24335dbd56e3SPeter Brune 
24345dbd56e3SPeter Brune    If this function is called multiple times, the hooks will be run in the order they are added.
24355dbd56e3SPeter Brune 
24365dbd56e3SPeter Brune    In order to compose with nonlinear preconditioning without duplicating storage, the hook should be implemented to
2437ec4806b8SPeter Brune    extract the global information from its context (instead of from the SNES).
24385dbd56e3SPeter Brune 
2439bb9467b5SJed Brown    This function is currently not available from Fortran.
2440bb9467b5SJed Brown 
24415dbd56e3SPeter Brune .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
24425dbd56e3SPeter Brune @*/
2443be081cd6SPeter Brune PetscErrorCode DMSubDomainHookAdd(DM global,PetscErrorCode (*ddhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,VecScatter,VecScatter,DM,void*),void *ctx)
24445dbd56e3SPeter Brune {
24455dbd56e3SPeter Brune   PetscErrorCode      ierr;
2446be081cd6SPeter Brune   DMSubDomainHookLink link,*p;
24475dbd56e3SPeter Brune 
24485dbd56e3SPeter Brune   PetscFunctionBegin;
24495dbd56e3SPeter Brune   PetscValidHeaderSpecific(global,DM_CLASSID,1);
2450be081cd6SPeter Brune   for (p=&global->subdomainhook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */
245195dccacaSBarry Smith   ierr               = PetscNew(&link);CHKERRQ(ierr);
24525dbd56e3SPeter Brune   link->restricthook = restricthook;
2453be081cd6SPeter Brune   link->ddhook       = ddhook;
24545dbd56e3SPeter Brune   link->ctx          = ctx;
24550298fd71SBarry Smith   link->next         = NULL;
24565dbd56e3SPeter Brune   *p                 = link;
24575dbd56e3SPeter Brune   PetscFunctionReturn(0);
24585dbd56e3SPeter Brune }
24595dbd56e3SPeter Brune 
24605dbd56e3SPeter Brune /*@
2461be081cd6SPeter Brune    DMSubDomainRestrict - restricts user-defined problem data to a block DM by running hooks registered by DMSubDomainHookAdd()
24625dbd56e3SPeter Brune 
24635dbd56e3SPeter Brune    Collective if any hooks are
24645dbd56e3SPeter Brune 
24655dbd56e3SPeter Brune    Input Arguments:
24665dbd56e3SPeter Brune +  fine - finer DM to use as a base
2467be081cd6SPeter Brune .  oscatter - scatter from domain global vector filling subdomain global vector with overlap
2468be081cd6SPeter Brune .  gscatter - scatter from domain global vector filling subdomain local vector with ghosts
24695dbd56e3SPeter Brune -  coarse - coarer DM to update
24705dbd56e3SPeter Brune 
24715dbd56e3SPeter Brune    Level: developer
24725dbd56e3SPeter Brune 
24735dbd56e3SPeter Brune .seealso: DMCoarsenHookAdd(), MatRestrict()
24745dbd56e3SPeter Brune @*/
2475be081cd6SPeter Brune PetscErrorCode DMSubDomainRestrict(DM global,VecScatter oscatter,VecScatter gscatter,DM subdm)
24765dbd56e3SPeter Brune {
24775dbd56e3SPeter Brune   PetscErrorCode      ierr;
2478be081cd6SPeter Brune   DMSubDomainHookLink link;
24795dbd56e3SPeter Brune 
24805dbd56e3SPeter Brune   PetscFunctionBegin;
2481be081cd6SPeter Brune   for (link=global->subdomainhook; link; link=link->next) {
24828865f1eaSKarl Rupp     if (link->restricthook) {
24838865f1eaSKarl Rupp       ierr = (*link->restricthook)(global,oscatter,gscatter,subdm,link->ctx);CHKERRQ(ierr);
24848865f1eaSKarl Rupp     }
24855dbd56e3SPeter Brune   }
24865dbd56e3SPeter Brune   PetscFunctionReturn(0);
24875dbd56e3SPeter Brune }
24885dbd56e3SPeter Brune 
24895fe1f584SPeter Brune /*@
24906a7d9d85SPeter Brune     DMGetCoarsenLevel - Get's the number of coarsenings that have generated this DM.
24915fe1f584SPeter Brune 
24925fe1f584SPeter Brune     Not Collective
24935fe1f584SPeter Brune 
24945fe1f584SPeter Brune     Input Parameter:
24955fe1f584SPeter Brune .   dm - the DM object
24965fe1f584SPeter Brune 
24975fe1f584SPeter Brune     Output Parameter:
24986a7d9d85SPeter Brune .   level - number of coarsenings
24995fe1f584SPeter Brune 
25005fe1f584SPeter Brune     Level: developer
25015fe1f584SPeter Brune 
25026a7d9d85SPeter Brune .seealso DMCoarsen(), DMGetRefineLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
25035fe1f584SPeter Brune 
25045fe1f584SPeter Brune @*/
25055fe1f584SPeter Brune PetscErrorCode  DMGetCoarsenLevel(DM dm,PetscInt *level)
25065fe1f584SPeter Brune {
25075fe1f584SPeter Brune   PetscFunctionBegin;
25085fe1f584SPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
25095fe1f584SPeter Brune   *level = dm->leveldown;
25105fe1f584SPeter Brune   PetscFunctionReturn(0);
25115fe1f584SPeter Brune }
25125fe1f584SPeter Brune 
25135fe1f584SPeter Brune 
25145fe1f584SPeter Brune 
251547c6ae99SBarry Smith /*@C
251647c6ae99SBarry Smith     DMRefineHierarchy - Refines a DM object, all levels at once
251747c6ae99SBarry Smith 
251847c6ae99SBarry Smith     Collective on DM
251947c6ae99SBarry Smith 
252047c6ae99SBarry Smith     Input Parameter:
252147c6ae99SBarry Smith +   dm - the DM object
252247c6ae99SBarry Smith -   nlevels - the number of levels of refinement
252347c6ae99SBarry Smith 
252447c6ae99SBarry Smith     Output Parameter:
252547c6ae99SBarry Smith .   dmf - the refined DM hierarchy
252647c6ae99SBarry Smith 
252747c6ae99SBarry Smith     Level: developer
252847c6ae99SBarry Smith 
2529e727c939SJed Brown .seealso DMCoarsenHierarchy(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
253047c6ae99SBarry Smith 
253147c6ae99SBarry Smith @*/
25327087cfbeSBarry Smith PetscErrorCode  DMRefineHierarchy(DM dm,PetscInt nlevels,DM dmf[])
253347c6ae99SBarry Smith {
253447c6ae99SBarry Smith   PetscErrorCode ierr;
253547c6ae99SBarry Smith 
253647c6ae99SBarry Smith   PetscFunctionBegin;
2537171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2538ce94432eSBarry Smith   if (nlevels < 0) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_OUTOFRANGE,"nlevels cannot be negative");
253947c6ae99SBarry Smith   if (nlevels == 0) PetscFunctionReturn(0);
254047c6ae99SBarry Smith   if (dm->ops->refinehierarchy) {
254147c6ae99SBarry Smith     ierr = (*dm->ops->refinehierarchy)(dm,nlevels,dmf);CHKERRQ(ierr);
254247c6ae99SBarry Smith   } else if (dm->ops->refine) {
254347c6ae99SBarry Smith     PetscInt i;
254447c6ae99SBarry Smith 
2545ce94432eSBarry Smith     ierr = DMRefine(dm,PetscObjectComm((PetscObject)dm),&dmf[0]);CHKERRQ(ierr);
254647c6ae99SBarry Smith     for (i=1; i<nlevels; i++) {
2547ce94432eSBarry Smith       ierr = DMRefine(dmf[i-1],PetscObjectComm((PetscObject)dm),&dmf[i]);CHKERRQ(ierr);
254847c6ae99SBarry Smith     }
2549ce94432eSBarry Smith   } else SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"No RefineHierarchy for this DM yet");
255047c6ae99SBarry Smith   PetscFunctionReturn(0);
255147c6ae99SBarry Smith }
255247c6ae99SBarry Smith 
255347c6ae99SBarry Smith /*@C
255447c6ae99SBarry Smith     DMCoarsenHierarchy - Coarsens a DM object, all levels at once
255547c6ae99SBarry Smith 
255647c6ae99SBarry Smith     Collective on DM
255747c6ae99SBarry Smith 
255847c6ae99SBarry Smith     Input Parameter:
255947c6ae99SBarry Smith +   dm - the DM object
256047c6ae99SBarry Smith -   nlevels - the number of levels of coarsening
256147c6ae99SBarry Smith 
256247c6ae99SBarry Smith     Output Parameter:
256347c6ae99SBarry Smith .   dmc - the coarsened DM hierarchy
256447c6ae99SBarry Smith 
256547c6ae99SBarry Smith     Level: developer
256647c6ae99SBarry Smith 
2567e727c939SJed Brown .seealso DMRefineHierarchy(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
256847c6ae99SBarry Smith 
256947c6ae99SBarry Smith @*/
25707087cfbeSBarry Smith PetscErrorCode  DMCoarsenHierarchy(DM dm, PetscInt nlevels, DM dmc[])
257147c6ae99SBarry Smith {
257247c6ae99SBarry Smith   PetscErrorCode ierr;
257347c6ae99SBarry Smith 
257447c6ae99SBarry Smith   PetscFunctionBegin;
2575171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2576ce94432eSBarry Smith   if (nlevels < 0) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_OUTOFRANGE,"nlevels cannot be negative");
257747c6ae99SBarry Smith   if (nlevels == 0) PetscFunctionReturn(0);
257847c6ae99SBarry Smith   PetscValidPointer(dmc,3);
257947c6ae99SBarry Smith   if (dm->ops->coarsenhierarchy) {
258047c6ae99SBarry Smith     ierr = (*dm->ops->coarsenhierarchy)(dm, nlevels, dmc);CHKERRQ(ierr);
258147c6ae99SBarry Smith   } else if (dm->ops->coarsen) {
258247c6ae99SBarry Smith     PetscInt i;
258347c6ae99SBarry Smith 
2584ce94432eSBarry Smith     ierr = DMCoarsen(dm,PetscObjectComm((PetscObject)dm),&dmc[0]);CHKERRQ(ierr);
258547c6ae99SBarry Smith     for (i=1; i<nlevels; i++) {
2586ce94432eSBarry Smith       ierr = DMCoarsen(dmc[i-1],PetscObjectComm((PetscObject)dm),&dmc[i]);CHKERRQ(ierr);
258747c6ae99SBarry Smith     }
2588ce94432eSBarry Smith   } else SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"No CoarsenHierarchy for this DM yet");
258947c6ae99SBarry Smith   PetscFunctionReturn(0);
259047c6ae99SBarry Smith }
259147c6ae99SBarry Smith 
259247c6ae99SBarry Smith /*@
2593e727c939SJed Brown    DMCreateAggregates - Gets the aggregates that map between
259447c6ae99SBarry Smith    grids associated with two DMs.
259547c6ae99SBarry Smith 
259647c6ae99SBarry Smith    Collective on DM
259747c6ae99SBarry Smith 
259847c6ae99SBarry Smith    Input Parameters:
259947c6ae99SBarry Smith +  dmc - the coarse grid DM
260047c6ae99SBarry Smith -  dmf - the fine grid DM
260147c6ae99SBarry Smith 
260247c6ae99SBarry Smith    Output Parameters:
260347c6ae99SBarry Smith .  rest - the restriction matrix (transpose of the projection matrix)
260447c6ae99SBarry Smith 
260547c6ae99SBarry Smith    Level: intermediate
260647c6ae99SBarry Smith 
260747c6ae99SBarry Smith .keywords: interpolation, restriction, multigrid
260847c6ae99SBarry Smith 
2609e727c939SJed Brown .seealso: DMRefine(), DMCreateInjection(), DMCreateInterpolation()
261047c6ae99SBarry Smith @*/
2611e727c939SJed Brown PetscErrorCode  DMCreateAggregates(DM dmc, DM dmf, Mat *rest)
261247c6ae99SBarry Smith {
261347c6ae99SBarry Smith   PetscErrorCode ierr;
261447c6ae99SBarry Smith 
261547c6ae99SBarry Smith   PetscFunctionBegin;
2616171400e9SBarry Smith   PetscValidHeaderSpecific(dmc,DM_CLASSID,1);
2617171400e9SBarry Smith   PetscValidHeaderSpecific(dmf,DM_CLASSID,2);
261847c6ae99SBarry Smith   ierr = (*dmc->ops->getaggregates)(dmc, dmf, rest);CHKERRQ(ierr);
261947c6ae99SBarry Smith   PetscFunctionReturn(0);
262047c6ae99SBarry Smith }
262147c6ae99SBarry Smith 
26221a266240SBarry Smith /*@C
26231a266240SBarry Smith     DMSetApplicationContextDestroy - Sets a user function that will be called to destroy the application context when the DM is destroyed
26241a266240SBarry Smith 
26251a266240SBarry Smith     Not Collective
26261a266240SBarry Smith 
26271a266240SBarry Smith     Input Parameters:
26281a266240SBarry Smith +   dm - the DM object
26291a266240SBarry Smith -   destroy - the destroy function
26301a266240SBarry Smith 
26311a266240SBarry Smith     Level: intermediate
26321a266240SBarry Smith 
2633e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
26341a266240SBarry Smith 
2635f07f9ceaSJed Brown @*/
26361a266240SBarry Smith PetscErrorCode  DMSetApplicationContextDestroy(DM dm,PetscErrorCode (*destroy)(void**))
26371a266240SBarry Smith {
26381a266240SBarry Smith   PetscFunctionBegin;
2639171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
26401a266240SBarry Smith   dm->ctxdestroy = destroy;
26411a266240SBarry Smith   PetscFunctionReturn(0);
26421a266240SBarry Smith }
26431a266240SBarry Smith 
2644b07ff414SBarry Smith /*@
26451b2093e4SBarry Smith     DMSetApplicationContext - Set a user context into a DM object
264647c6ae99SBarry Smith 
264747c6ae99SBarry Smith     Not Collective
264847c6ae99SBarry Smith 
264947c6ae99SBarry Smith     Input Parameters:
265047c6ae99SBarry Smith +   dm - the DM object
265147c6ae99SBarry Smith -   ctx - the user context
265247c6ae99SBarry Smith 
265347c6ae99SBarry Smith     Level: intermediate
265447c6ae99SBarry Smith 
2655e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
265647c6ae99SBarry Smith 
265747c6ae99SBarry Smith @*/
26581b2093e4SBarry Smith PetscErrorCode  DMSetApplicationContext(DM dm,void *ctx)
265947c6ae99SBarry Smith {
266047c6ae99SBarry Smith   PetscFunctionBegin;
2661171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
266247c6ae99SBarry Smith   dm->ctx = ctx;
266347c6ae99SBarry Smith   PetscFunctionReturn(0);
266447c6ae99SBarry Smith }
266547c6ae99SBarry Smith 
266647c6ae99SBarry Smith /*@
26671b2093e4SBarry Smith     DMGetApplicationContext - Gets a user context from a DM object
266847c6ae99SBarry Smith 
266947c6ae99SBarry Smith     Not Collective
267047c6ae99SBarry Smith 
267147c6ae99SBarry Smith     Input Parameter:
267247c6ae99SBarry Smith .   dm - the DM object
267347c6ae99SBarry Smith 
267447c6ae99SBarry Smith     Output Parameter:
267547c6ae99SBarry Smith .   ctx - the user context
267647c6ae99SBarry Smith 
267747c6ae99SBarry Smith     Level: intermediate
267847c6ae99SBarry Smith 
2679e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
268047c6ae99SBarry Smith 
268147c6ae99SBarry Smith @*/
26821b2093e4SBarry Smith PetscErrorCode  DMGetApplicationContext(DM dm,void *ctx)
268347c6ae99SBarry Smith {
268447c6ae99SBarry Smith   PetscFunctionBegin;
2685171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
26861b2093e4SBarry Smith   *(void**)ctx = dm->ctx;
268747c6ae99SBarry Smith   PetscFunctionReturn(0);
268847c6ae99SBarry Smith }
268947c6ae99SBarry Smith 
269008da532bSDmitry Karpeev /*@C
2691df3898eeSBarry Smith     DMSetVariableBounds - sets a function to compute the lower and upper bound vectors for SNESVI.
269208da532bSDmitry Karpeev 
269308da532bSDmitry Karpeev     Logically Collective on DM
269408da532bSDmitry Karpeev 
269508da532bSDmitry Karpeev     Input Parameter:
269608da532bSDmitry Karpeev +   dm - the DM object
26970298fd71SBarry Smith -   f - the function that computes variable bounds used by SNESVI (use NULL to cancel a previous function that was set)
269808da532bSDmitry Karpeev 
269908da532bSDmitry Karpeev     Level: intermediate
270008da532bSDmitry Karpeev 
2701835c3ec7SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext(),
270208da532bSDmitry Karpeev          DMSetJacobian()
270308da532bSDmitry Karpeev 
270408da532bSDmitry Karpeev @*/
270508da532bSDmitry Karpeev PetscErrorCode  DMSetVariableBounds(DM dm,PetscErrorCode (*f)(DM,Vec,Vec))
270608da532bSDmitry Karpeev {
270708da532bSDmitry Karpeev   PetscFunctionBegin;
270808da532bSDmitry Karpeev   dm->ops->computevariablebounds = f;
270908da532bSDmitry Karpeev   PetscFunctionReturn(0);
271008da532bSDmitry Karpeev }
271108da532bSDmitry Karpeev 
271208da532bSDmitry Karpeev /*@
271308da532bSDmitry Karpeev     DMHasVariableBounds - does the DM object have a variable bounds function?
271408da532bSDmitry Karpeev 
271508da532bSDmitry Karpeev     Not Collective
271608da532bSDmitry Karpeev 
271708da532bSDmitry Karpeev     Input Parameter:
271808da532bSDmitry Karpeev .   dm - the DM object to destroy
271908da532bSDmitry Karpeev 
272008da532bSDmitry Karpeev     Output Parameter:
272108da532bSDmitry Karpeev .   flg - PETSC_TRUE if the variable bounds function exists
272208da532bSDmitry Karpeev 
272308da532bSDmitry Karpeev     Level: developer
272408da532bSDmitry Karpeev 
272574e1e8c1SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
272608da532bSDmitry Karpeev 
272708da532bSDmitry Karpeev @*/
272808da532bSDmitry Karpeev PetscErrorCode  DMHasVariableBounds(DM dm,PetscBool  *flg)
272908da532bSDmitry Karpeev {
273008da532bSDmitry Karpeev   PetscFunctionBegin;
273108da532bSDmitry Karpeev   *flg =  (dm->ops->computevariablebounds) ? PETSC_TRUE : PETSC_FALSE;
273208da532bSDmitry Karpeev   PetscFunctionReturn(0);
273308da532bSDmitry Karpeev }
273408da532bSDmitry Karpeev 
273508da532bSDmitry Karpeev /*@C
273608da532bSDmitry Karpeev     DMComputeVariableBounds - compute variable bounds used by SNESVI.
273708da532bSDmitry Karpeev 
273808da532bSDmitry Karpeev     Logically Collective on DM
273908da532bSDmitry Karpeev 
274008da532bSDmitry Karpeev     Input Parameters:
2741907376e6SBarry Smith .   dm - the DM object
274208da532bSDmitry Karpeev 
274308da532bSDmitry Karpeev     Output parameters:
274408da532bSDmitry Karpeev +   xl - lower bound
274508da532bSDmitry Karpeev -   xu - upper bound
274608da532bSDmitry Karpeev 
2747907376e6SBarry Smith     Level: advanced
2748907376e6SBarry Smith 
2749907376e6SBarry Smith     Notes: This is generally not called by users. It calls the function provided by the user with DMSetVariableBounds()
275008da532bSDmitry Karpeev 
275174e1e8c1SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
275208da532bSDmitry Karpeev 
275308da532bSDmitry Karpeev @*/
275408da532bSDmitry Karpeev PetscErrorCode  DMComputeVariableBounds(DM dm, Vec xl, Vec xu)
275508da532bSDmitry Karpeev {
275608da532bSDmitry Karpeev   PetscErrorCode ierr;
27575fd66863SKarl Rupp 
275808da532bSDmitry Karpeev   PetscFunctionBegin;
275908da532bSDmitry Karpeev   PetscValidHeaderSpecific(xl,VEC_CLASSID,2);
276008da532bSDmitry Karpeev   PetscValidHeaderSpecific(xu,VEC_CLASSID,2);
276108da532bSDmitry Karpeev   if (dm->ops->computevariablebounds) {
276208da532bSDmitry Karpeev     ierr = (*dm->ops->computevariablebounds)(dm, xl,xu);CHKERRQ(ierr);
27638865f1eaSKarl Rupp   } else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, "This DM is incapable of computing variable bounds.");
276408da532bSDmitry Karpeev   PetscFunctionReturn(0);
276508da532bSDmitry Karpeev }
276608da532bSDmitry Karpeev 
2767b0ae01b7SPeter Brune /*@
2768b0ae01b7SPeter Brune     DMHasColoring - does the DM object have a method of providing a coloring?
2769b0ae01b7SPeter Brune 
2770b0ae01b7SPeter Brune     Not Collective
2771b0ae01b7SPeter Brune 
2772b0ae01b7SPeter Brune     Input Parameter:
2773b0ae01b7SPeter Brune .   dm - the DM object
2774b0ae01b7SPeter Brune 
2775b0ae01b7SPeter Brune     Output Parameter:
2776b0ae01b7SPeter Brune .   flg - PETSC_TRUE if the DM has facilities for DMCreateColoring().
2777b0ae01b7SPeter Brune 
2778b0ae01b7SPeter Brune     Level: developer
2779b0ae01b7SPeter Brune 
2780b0ae01b7SPeter Brune .seealso DMHasFunction(), DMCreateColoring()
2781b0ae01b7SPeter Brune 
2782b0ae01b7SPeter Brune @*/
2783b0ae01b7SPeter Brune PetscErrorCode  DMHasColoring(DM dm,PetscBool  *flg)
2784b0ae01b7SPeter Brune {
2785b0ae01b7SPeter Brune   PetscFunctionBegin;
2786b0ae01b7SPeter Brune   *flg =  (dm->ops->getcoloring) ? PETSC_TRUE : PETSC_FALSE;
2787b0ae01b7SPeter Brune   PetscFunctionReturn(0);
2788b0ae01b7SPeter Brune }
2789b0ae01b7SPeter Brune 
27903ad4599aSBarry Smith /*@
27913ad4599aSBarry Smith     DMHasCreateRestriction - does the DM object have a method of providing a restriction?
27923ad4599aSBarry Smith 
27933ad4599aSBarry Smith     Not Collective
27943ad4599aSBarry Smith 
27953ad4599aSBarry Smith     Input Parameter:
27963ad4599aSBarry Smith .   dm - the DM object
27973ad4599aSBarry Smith 
27983ad4599aSBarry Smith     Output Parameter:
27993ad4599aSBarry Smith .   flg - PETSC_TRUE if the DM has facilities for DMCreateRestriction().
28003ad4599aSBarry Smith 
28013ad4599aSBarry Smith     Level: developer
28023ad4599aSBarry Smith 
28033ad4599aSBarry Smith .seealso DMHasFunction(), DMCreateRestriction()
28043ad4599aSBarry Smith 
28053ad4599aSBarry Smith @*/
28063ad4599aSBarry Smith PetscErrorCode  DMHasCreateRestriction(DM dm,PetscBool  *flg)
28073ad4599aSBarry Smith {
28083ad4599aSBarry Smith   PetscFunctionBegin;
28093ad4599aSBarry Smith   *flg =  (dm->ops->createrestriction) ? PETSC_TRUE : PETSC_FALSE;
28103ad4599aSBarry Smith   PetscFunctionReturn(0);
28113ad4599aSBarry Smith }
28123ad4599aSBarry Smith 
2813748fac09SDmitry Karpeev /*@C
281408da532bSDmitry Karpeev     DMSetVec - set the vector at which to compute residual, Jacobian and VI bounds, if the problem is nonlinear.
281508da532bSDmitry Karpeev 
281608da532bSDmitry Karpeev     Collective on DM
281708da532bSDmitry Karpeev 
281808da532bSDmitry Karpeev     Input Parameter:
281908da532bSDmitry Karpeev +   dm - the DM object
28200298fd71SBarry Smith -   x - location to compute residual and Jacobian, if NULL is passed to those routines; will be NULL for linear problems.
282108da532bSDmitry Karpeev 
282208da532bSDmitry Karpeev     Level: developer
282308da532bSDmitry Karpeev 
282474e1e8c1SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
282508da532bSDmitry Karpeev 
282608da532bSDmitry Karpeev @*/
282708da532bSDmitry Karpeev PetscErrorCode  DMSetVec(DM dm,Vec x)
282808da532bSDmitry Karpeev {
282908da532bSDmitry Karpeev   PetscErrorCode ierr;
28305fd66863SKarl Rupp 
283108da532bSDmitry Karpeev   PetscFunctionBegin;
283208da532bSDmitry Karpeev   if (x) {
283308da532bSDmitry Karpeev     if (!dm->x) {
283408da532bSDmitry Karpeev       ierr = DMCreateGlobalVector(dm,&dm->x);CHKERRQ(ierr);
283508da532bSDmitry Karpeev     }
283608da532bSDmitry Karpeev     ierr = VecCopy(x,dm->x);CHKERRQ(ierr);
28378865f1eaSKarl Rupp   } else if (dm->x) {
283808da532bSDmitry Karpeev     ierr = VecDestroy(&dm->x);CHKERRQ(ierr);
283908da532bSDmitry Karpeev   }
284008da532bSDmitry Karpeev   PetscFunctionReturn(0);
284108da532bSDmitry Karpeev }
284208da532bSDmitry Karpeev 
28430298fd71SBarry Smith PetscFunctionList DMList              = NULL;
2844264ace61SBarry Smith PetscBool         DMRegisterAllCalled = PETSC_FALSE;
2845264ace61SBarry Smith 
2846264ace61SBarry Smith /*@C
2847264ace61SBarry Smith   DMSetType - Builds a DM, for a particular DM implementation.
2848264ace61SBarry Smith 
2849264ace61SBarry Smith   Collective on DM
2850264ace61SBarry Smith 
2851264ace61SBarry Smith   Input Parameters:
2852264ace61SBarry Smith + dm     - The DM object
2853264ace61SBarry Smith - method - The name of the DM type
2854264ace61SBarry Smith 
2855264ace61SBarry Smith   Options Database Key:
2856264ace61SBarry Smith . -dm_type <type> - Sets the DM type; use -help for a list of available types
2857264ace61SBarry Smith 
2858264ace61SBarry Smith   Notes:
2859e1589f56SBarry Smith   See "petsc/include/petscdm.h" for available DM types (for instance, DM1D, DM2D, or DM3D).
2860264ace61SBarry Smith 
2861264ace61SBarry Smith   Level: intermediate
2862264ace61SBarry Smith 
2863264ace61SBarry Smith .keywords: DM, set, type
2864264ace61SBarry Smith .seealso: DMGetType(), DMCreate()
2865264ace61SBarry Smith @*/
286619fd82e9SBarry Smith PetscErrorCode  DMSetType(DM dm, DMType method)
2867264ace61SBarry Smith {
2868264ace61SBarry Smith   PetscErrorCode (*r)(DM);
2869264ace61SBarry Smith   PetscBool      match;
2870264ace61SBarry Smith   PetscErrorCode ierr;
2871264ace61SBarry Smith 
2872264ace61SBarry Smith   PetscFunctionBegin;
2873264ace61SBarry Smith   PetscValidHeaderSpecific(dm, DM_CLASSID,1);
2874251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject) dm, method, &match);CHKERRQ(ierr);
2875264ace61SBarry Smith   if (match) PetscFunctionReturn(0);
2876264ace61SBarry Smith 
28770f51fdf8SToby Isaac   ierr = DMRegisterAll();CHKERRQ(ierr);
28781c9cd337SJed Brown   ierr = PetscFunctionListFind(DMList,method,&r);CHKERRQ(ierr);
2879ce94432eSBarry Smith   if (!r) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_UNKNOWN_TYPE, "Unknown DM type: %s", method);
2880264ace61SBarry Smith 
2881264ace61SBarry Smith   if (dm->ops->destroy) {
2882264ace61SBarry Smith     ierr             = (*dm->ops->destroy)(dm);CHKERRQ(ierr);
28830298fd71SBarry Smith     dm->ops->destroy = NULL;
2884264ace61SBarry Smith   }
2885264ace61SBarry Smith   ierr = (*r)(dm);CHKERRQ(ierr);
2886264ace61SBarry Smith   ierr = PetscObjectChangeTypeName((PetscObject)dm,method);CHKERRQ(ierr);
2887264ace61SBarry Smith   PetscFunctionReturn(0);
2888264ace61SBarry Smith }
2889264ace61SBarry Smith 
2890264ace61SBarry Smith /*@C
2891264ace61SBarry Smith   DMGetType - Gets the DM type name (as a string) from the DM.
2892264ace61SBarry Smith 
2893264ace61SBarry Smith   Not Collective
2894264ace61SBarry Smith 
2895264ace61SBarry Smith   Input Parameter:
2896264ace61SBarry Smith . dm  - The DM
2897264ace61SBarry Smith 
2898264ace61SBarry Smith   Output Parameter:
2899264ace61SBarry Smith . type - The DM type name
2900264ace61SBarry Smith 
2901264ace61SBarry Smith   Level: intermediate
2902264ace61SBarry Smith 
2903264ace61SBarry Smith .keywords: DM, get, type, name
2904264ace61SBarry Smith .seealso: DMSetType(), DMCreate()
2905264ace61SBarry Smith @*/
290619fd82e9SBarry Smith PetscErrorCode  DMGetType(DM dm, DMType *type)
2907264ace61SBarry Smith {
2908264ace61SBarry Smith   PetscErrorCode ierr;
2909264ace61SBarry Smith 
2910264ace61SBarry Smith   PetscFunctionBegin;
2911264ace61SBarry Smith   PetscValidHeaderSpecific(dm, DM_CLASSID,1);
2912c959eef4SJed Brown   PetscValidPointer(type,2);
2913607a6623SBarry Smith   ierr = DMRegisterAll();CHKERRQ(ierr);
2914264ace61SBarry Smith   *type = ((PetscObject)dm)->type_name;
2915264ace61SBarry Smith   PetscFunctionReturn(0);
2916264ace61SBarry Smith }
2917264ace61SBarry Smith 
291867a56275SMatthew G Knepley /*@C
291967a56275SMatthew G Knepley   DMConvert - Converts a DM to another DM, either of the same or different type.
292067a56275SMatthew G Knepley 
292167a56275SMatthew G Knepley   Collective on DM
292267a56275SMatthew G Knepley 
292367a56275SMatthew G Knepley   Input Parameters:
292467a56275SMatthew G Knepley + dm - the DM
292567a56275SMatthew G Knepley - newtype - new DM type (use "same" for the same type)
292667a56275SMatthew G Knepley 
292767a56275SMatthew G Knepley   Output Parameter:
292867a56275SMatthew G Knepley . M - pointer to new DM
292967a56275SMatthew G Knepley 
293067a56275SMatthew G Knepley   Notes:
293167a56275SMatthew G Knepley   Cannot be used to convert a sequential DM to parallel or parallel to sequential,
293267a56275SMatthew G Knepley   the MPI communicator of the generated DM is always the same as the communicator
293367a56275SMatthew G Knepley   of the input DM.
293467a56275SMatthew G Knepley 
293567a56275SMatthew G Knepley   Level: intermediate
293667a56275SMatthew G Knepley 
293767a56275SMatthew G Knepley .seealso: DMCreate()
293867a56275SMatthew G Knepley @*/
293919fd82e9SBarry Smith PetscErrorCode DMConvert(DM dm, DMType newtype, DM *M)
294067a56275SMatthew G Knepley {
294167a56275SMatthew G Knepley   DM             B;
294267a56275SMatthew G Knepley   char           convname[256];
2943c067b6caSMatthew G. Knepley   PetscBool      sametype/*, issame */;
294467a56275SMatthew G Knepley   PetscErrorCode ierr;
294567a56275SMatthew G Knepley 
294667a56275SMatthew G Knepley   PetscFunctionBegin;
294767a56275SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
294867a56275SMatthew G Knepley   PetscValidType(dm,1);
294967a56275SMatthew G Knepley   PetscValidPointer(M,3);
2950251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject) dm, newtype, &sametype);CHKERRQ(ierr);
2951c067b6caSMatthew G. Knepley   /* ierr = PetscStrcmp(newtype, "same", &issame);CHKERRQ(ierr); */
2952c067b6caSMatthew G. Knepley   if (sametype) {
2953c067b6caSMatthew G. Knepley     *M   = dm;
2954c067b6caSMatthew G. Knepley     ierr = PetscObjectReference((PetscObject) dm);CHKERRQ(ierr);
2955c067b6caSMatthew G. Knepley     PetscFunctionReturn(0);
2956c067b6caSMatthew G. Knepley   } else {
29570298fd71SBarry Smith     PetscErrorCode (*conv)(DM, DMType, DM*) = NULL;
295867a56275SMatthew G Knepley 
295967a56275SMatthew G Knepley     /*
296067a56275SMatthew G Knepley        Order of precedence:
296167a56275SMatthew G Knepley        1) See if a specialized converter is known to the current DM.
296267a56275SMatthew G Knepley        2) See if a specialized converter is known to the desired DM class.
296367a56275SMatthew G Knepley        3) See if a good general converter is registered for the desired class
296467a56275SMatthew G Knepley        4) See if a good general converter is known for the current matrix.
296567a56275SMatthew G Knepley        5) Use a really basic converter.
296667a56275SMatthew G Knepley     */
296767a56275SMatthew G Knepley 
296867a56275SMatthew G Knepley     /* 1) See if a specialized converter is known to the current DM and the desired class */
296967a56275SMatthew G Knepley     ierr = PetscStrcpy(convname,"DMConvert_");CHKERRQ(ierr);
297067a56275SMatthew G Knepley     ierr = PetscStrcat(convname,((PetscObject) dm)->type_name);CHKERRQ(ierr);
297167a56275SMatthew G Knepley     ierr = PetscStrcat(convname,"_");CHKERRQ(ierr);
297267a56275SMatthew G Knepley     ierr = PetscStrcat(convname,newtype);CHKERRQ(ierr);
297367a56275SMatthew G Knepley     ierr = PetscStrcat(convname,"_C");CHKERRQ(ierr);
29740005d66cSJed Brown     ierr = PetscObjectQueryFunction((PetscObject)dm,convname,&conv);CHKERRQ(ierr);
297567a56275SMatthew G Knepley     if (conv) goto foundconv;
297667a56275SMatthew G Knepley 
297767a56275SMatthew G Knepley     /* 2)  See if a specialized converter is known to the desired DM class. */
297882f516ccSBarry Smith     ierr = DMCreate(PetscObjectComm((PetscObject)dm), &B);CHKERRQ(ierr);
297967a56275SMatthew G Knepley     ierr = DMSetType(B, newtype);CHKERRQ(ierr);
298067a56275SMatthew G Knepley     ierr = PetscStrcpy(convname,"DMConvert_");CHKERRQ(ierr);
298167a56275SMatthew G Knepley     ierr = PetscStrcat(convname,((PetscObject) dm)->type_name);CHKERRQ(ierr);
298267a56275SMatthew G Knepley     ierr = PetscStrcat(convname,"_");CHKERRQ(ierr);
298367a56275SMatthew G Knepley     ierr = PetscStrcat(convname,newtype);CHKERRQ(ierr);
298467a56275SMatthew G Knepley     ierr = PetscStrcat(convname,"_C");CHKERRQ(ierr);
29850005d66cSJed Brown     ierr = PetscObjectQueryFunction((PetscObject)B,convname,&conv);CHKERRQ(ierr);
298667a56275SMatthew G Knepley     if (conv) {
2987fcfd50ebSBarry Smith       ierr = DMDestroy(&B);CHKERRQ(ierr);
298867a56275SMatthew G Knepley       goto foundconv;
298967a56275SMatthew G Knepley     }
299067a56275SMatthew G Knepley 
299167a56275SMatthew G Knepley #if 0
299267a56275SMatthew G Knepley     /* 3) See if a good general converter is registered for the desired class */
299367a56275SMatthew G Knepley     conv = B->ops->convertfrom;
2994fcfd50ebSBarry Smith     ierr = DMDestroy(&B);CHKERRQ(ierr);
299567a56275SMatthew G Knepley     if (conv) goto foundconv;
299667a56275SMatthew G Knepley 
299767a56275SMatthew G Knepley     /* 4) See if a good general converter is known for the current matrix */
299867a56275SMatthew G Knepley     if (dm->ops->convert) {
299967a56275SMatthew G Knepley       conv = dm->ops->convert;
300067a56275SMatthew G Knepley     }
300167a56275SMatthew G Knepley     if (conv) goto foundconv;
300267a56275SMatthew G Knepley #endif
300367a56275SMatthew G Knepley 
300467a56275SMatthew G Knepley     /* 5) Use a really basic converter. */
300582f516ccSBarry Smith     SETERRQ2(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "No conversion possible between DM types %s and %s", ((PetscObject) dm)->type_name, newtype);
300667a56275SMatthew G Knepley 
300767a56275SMatthew G Knepley foundconv:
300867a56275SMatthew G Knepley     ierr = PetscLogEventBegin(DM_Convert,dm,0,0,0);CHKERRQ(ierr);
300967a56275SMatthew G Knepley     ierr = (*conv)(dm,newtype,M);CHKERRQ(ierr);
301012fa691eSMatthew G. Knepley     /* Things that are independent of DM type: We should consult DMClone() here */
301112fa691eSMatthew G. Knepley     if (dm->maxCell) {
301212fa691eSMatthew G. Knepley       const PetscReal *maxCell, *L;
301312fa691eSMatthew G. Knepley       const DMBoundaryType *bd;
301412fa691eSMatthew G. Knepley       ierr = DMGetPeriodicity(dm, &maxCell, &L, &bd);CHKERRQ(ierr);
301512fa691eSMatthew G. Knepley       ierr = DMSetPeriodicity(*M,  maxCell,  L,  bd);CHKERRQ(ierr);
301612fa691eSMatthew G. Knepley     }
301767a56275SMatthew G Knepley     ierr = PetscLogEventEnd(DM_Convert,dm,0,0,0);CHKERRQ(ierr);
301867a56275SMatthew G Knepley   }
301967a56275SMatthew G Knepley   ierr = PetscObjectStateIncrease((PetscObject) *M);CHKERRQ(ierr);
302067a56275SMatthew G Knepley   PetscFunctionReturn(0);
302167a56275SMatthew G Knepley }
3022264ace61SBarry Smith 
3023264ace61SBarry Smith /*--------------------------------------------------------------------------------------------------------------------*/
3024264ace61SBarry Smith 
3025264ace61SBarry Smith /*@C
30261c84c290SBarry Smith   DMRegister -  Adds a new DM component implementation
30271c84c290SBarry Smith 
30281c84c290SBarry Smith   Not Collective
30291c84c290SBarry Smith 
30301c84c290SBarry Smith   Input Parameters:
30311c84c290SBarry Smith + name        - The name of a new user-defined creation routine
30321c84c290SBarry Smith - create_func - The creation routine itself
30331c84c290SBarry Smith 
30341c84c290SBarry Smith   Notes:
30351c84c290SBarry Smith   DMRegister() may be called multiple times to add several user-defined DMs
30361c84c290SBarry Smith 
30371c84c290SBarry Smith 
30381c84c290SBarry Smith   Sample usage:
30391c84c290SBarry Smith .vb
3040bdf89e91SBarry Smith     DMRegister("my_da", MyDMCreate);
30411c84c290SBarry Smith .ve
30421c84c290SBarry Smith 
30431c84c290SBarry Smith   Then, your DM type can be chosen with the procedural interface via
30441c84c290SBarry Smith .vb
30451c84c290SBarry Smith     DMCreate(MPI_Comm, DM *);
30461c84c290SBarry Smith     DMSetType(DM,"my_da");
30471c84c290SBarry Smith .ve
30481c84c290SBarry Smith    or at runtime via the option
30491c84c290SBarry Smith .vb
30501c84c290SBarry Smith     -da_type my_da
30511c84c290SBarry Smith .ve
3052264ace61SBarry Smith 
3053264ace61SBarry Smith   Level: advanced
30541c84c290SBarry Smith 
30551c84c290SBarry Smith .keywords: DM, register
3056bdf89e91SBarry Smith .seealso: DMRegisterAll(), DMRegisterDestroy()
30571c84c290SBarry Smith 
3058264ace61SBarry Smith @*/
3059bdf89e91SBarry Smith PetscErrorCode  DMRegister(const char sname[],PetscErrorCode (*function)(DM))
3060264ace61SBarry Smith {
3061264ace61SBarry Smith   PetscErrorCode ierr;
3062264ace61SBarry Smith 
3063264ace61SBarry Smith   PetscFunctionBegin;
3064a240a19fSJed Brown   ierr = PetscFunctionListAdd(&DMList,sname,function);CHKERRQ(ierr);
3065264ace61SBarry Smith   PetscFunctionReturn(0);
3066264ace61SBarry Smith }
3067264ace61SBarry Smith 
3068b859378eSBarry Smith /*@C
306955849f57SBarry Smith   DMLoad - Loads a DM that has been stored in binary  with DMView().
3070b859378eSBarry Smith 
3071b859378eSBarry Smith   Collective on PetscViewer
3072b859378eSBarry Smith 
3073b859378eSBarry Smith   Input Parameters:
3074b859378eSBarry Smith + newdm - the newly loaded DM, this needs to have been created with DMCreate() or
3075b859378eSBarry Smith            some related function before a call to DMLoad().
3076b859378eSBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen() or
3077b859378eSBarry Smith            HDF5 file viewer, obtained from PetscViewerHDF5Open()
3078b859378eSBarry Smith 
3079b859378eSBarry Smith    Level: intermediate
3080b859378eSBarry Smith 
3081b859378eSBarry Smith   Notes:
308255849f57SBarry Smith    The type is determined by the data in the file, any type set into the DM before this call is ignored.
3083b859378eSBarry Smith 
3084b859378eSBarry Smith   Notes for advanced users:
3085b859378eSBarry Smith   Most users should not need to know the details of the binary storage
3086b859378eSBarry Smith   format, since DMLoad() and DMView() completely hide these details.
3087b859378eSBarry Smith   But for anyone who's interested, the standard binary matrix storage
3088b859378eSBarry Smith   format is
3089b859378eSBarry Smith .vb
3090b859378eSBarry Smith      has not yet been determined
3091b859378eSBarry Smith .ve
3092b859378eSBarry Smith 
3093b859378eSBarry Smith .seealso: PetscViewerBinaryOpen(), DMView(), MatLoad(), VecLoad()
3094b859378eSBarry Smith @*/
3095b859378eSBarry Smith PetscErrorCode  DMLoad(DM newdm, PetscViewer viewer)
3096b859378eSBarry Smith {
30979331c7a4SMatthew G. Knepley   PetscBool      isbinary, ishdf5;
3098b859378eSBarry Smith   PetscErrorCode ierr;
3099b859378eSBarry Smith 
3100b859378eSBarry Smith   PetscFunctionBegin;
3101b859378eSBarry Smith   PetscValidHeaderSpecific(newdm,DM_CLASSID,1);
3102b859378eSBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
310332c0f0efSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
31049331c7a4SMatthew G. Knepley   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERHDF5,&ishdf5);CHKERRQ(ierr);
31059331c7a4SMatthew G. Knepley   if (isbinary) {
31069331c7a4SMatthew G. Knepley     PetscInt classid;
31079331c7a4SMatthew G. Knepley     char     type[256];
3108b859378eSBarry Smith 
3109060da220SMatthew G. Knepley     ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr);
31109200755eSBarry Smith     if (classid != DM_FILE_CLASSID) SETERRQ1(PetscObjectComm((PetscObject)newdm),PETSC_ERR_ARG_WRONG,"Not DM next in file, classid found %d",(int)classid);
3111060da220SMatthew G. Knepley     ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr);
311232c0f0efSBarry Smith     ierr = DMSetType(newdm, type);CHKERRQ(ierr);
31139331c7a4SMatthew G. Knepley     if (newdm->ops->load) {ierr = (*newdm->ops->load)(newdm,viewer);CHKERRQ(ierr);}
31149331c7a4SMatthew G. Knepley   } else if (ishdf5) {
31159331c7a4SMatthew G. Knepley     if (newdm->ops->load) {ierr = (*newdm->ops->load)(newdm,viewer);CHKERRQ(ierr);}
31169331c7a4SMatthew G. Knepley   } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen() or PetscViewerHDF5Open()");
3117b859378eSBarry Smith   PetscFunctionReturn(0);
3118b859378eSBarry Smith }
3119b859378eSBarry Smith 
31207da65231SMatthew G Knepley /******************************** FEM Support **********************************/
31217da65231SMatthew G Knepley 
3122a6dfd86eSKarl Rupp PetscErrorCode DMPrintCellVector(PetscInt c, const char name[], PetscInt len, const PetscScalar x[])
3123a6dfd86eSKarl Rupp {
31241d47ebbbSSatish Balay   PetscInt       f;
31251b30c384SMatthew G Knepley   PetscErrorCode ierr;
31261b30c384SMatthew G Knepley 
31277da65231SMatthew G Knepley   PetscFunctionBegin;
312874778d6cSJed Brown   ierr = PetscPrintf(PETSC_COMM_SELF, "Cell %D Element %s\n", c, name);CHKERRQ(ierr);
31291d47ebbbSSatish Balay   for (f = 0; f < len; ++f) {
313057622a8eSBarry Smith     ierr = PetscPrintf(PETSC_COMM_SELF, "  | %g |\n", (double)PetscRealPart(x[f]));CHKERRQ(ierr);
31317da65231SMatthew G Knepley   }
31327da65231SMatthew G Knepley   PetscFunctionReturn(0);
31337da65231SMatthew G Knepley }
31347da65231SMatthew G Knepley 
3135a6dfd86eSKarl Rupp PetscErrorCode DMPrintCellMatrix(PetscInt c, const char name[], PetscInt rows, PetscInt cols, const PetscScalar A[])
3136a6dfd86eSKarl Rupp {
31371b30c384SMatthew G Knepley   PetscInt       f, g;
31387da65231SMatthew G Knepley   PetscErrorCode ierr;
31397da65231SMatthew G Knepley 
31407da65231SMatthew G Knepley   PetscFunctionBegin;
314174778d6cSJed Brown   ierr = PetscPrintf(PETSC_COMM_SELF, "Cell %D Element %s\n", c, name);CHKERRQ(ierr);
31421d47ebbbSSatish Balay   for (f = 0; f < rows; ++f) {
314374778d6cSJed Brown     ierr = PetscPrintf(PETSC_COMM_SELF, "  |");CHKERRQ(ierr);
31441d47ebbbSSatish Balay     for (g = 0; g < cols; ++g) {
3145e3556bceSMatthew G. Knepley       ierr = PetscPrintf(PETSC_COMM_SELF, " % 9.5g", PetscRealPart(A[f*cols+g]));CHKERRQ(ierr);
31467da65231SMatthew G Knepley     }
314774778d6cSJed Brown     ierr = PetscPrintf(PETSC_COMM_SELF, " |\n");CHKERRQ(ierr);
31487da65231SMatthew G Knepley   }
31497da65231SMatthew G Knepley   PetscFunctionReturn(0);
31507da65231SMatthew G Knepley }
3151e7c4fc90SDmitry Karpeev 
31526113b454SMatthew G. Knepley PetscErrorCode DMPrintLocalVec(DM dm, const char name[], PetscReal tol, Vec X)
3153e759306cSMatthew G. Knepley {
3154e759306cSMatthew G. Knepley   PetscMPIInt    rank, numProcs;
3155e759306cSMatthew G. Knepley   PetscInt       p;
3156e759306cSMatthew G. Knepley   PetscErrorCode ierr;
3157e759306cSMatthew G. Knepley 
3158e759306cSMatthew G. Knepley   PetscFunctionBegin;
3159e759306cSMatthew G. Knepley   ierr = MPI_Comm_rank(PetscObjectComm((PetscObject) dm), &rank);CHKERRQ(ierr);
3160e759306cSMatthew G. Knepley   ierr = MPI_Comm_size(PetscObjectComm((PetscObject) dm), &numProcs);CHKERRQ(ierr);
3161e759306cSMatthew G. Knepley   ierr = PetscPrintf(PetscObjectComm((PetscObject) dm), "%s:\n", name);CHKERRQ(ierr);
3162e759306cSMatthew G. Knepley   for (p = 0; p < numProcs; ++p) {
3163e759306cSMatthew G. Knepley     if (p == rank) {
3164e759306cSMatthew G. Knepley       Vec x;
3165e759306cSMatthew G. Knepley 
3166e759306cSMatthew G. Knepley       ierr = VecDuplicate(X, &x);CHKERRQ(ierr);
3167e759306cSMatthew G. Knepley       ierr = VecCopy(X, x);CHKERRQ(ierr);
31686113b454SMatthew G. Knepley       ierr = VecChop(x, tol);CHKERRQ(ierr);
3169e759306cSMatthew G. Knepley       ierr = VecView(x, PETSC_VIEWER_STDOUT_SELF);CHKERRQ(ierr);
3170e759306cSMatthew G. Knepley       ierr = VecDestroy(&x);CHKERRQ(ierr);
3171e759306cSMatthew G. Knepley       ierr = PetscViewerFlush(PETSC_VIEWER_STDOUT_SELF);CHKERRQ(ierr);
3172e759306cSMatthew G. Knepley     }
3173e759306cSMatthew G. Knepley     ierr = PetscBarrier((PetscObject) dm);CHKERRQ(ierr);
3174e759306cSMatthew G. Knepley   }
3175e759306cSMatthew G. Knepley   PetscFunctionReturn(0);
3176e759306cSMatthew G. Knepley }
3177e759306cSMatthew G. Knepley 
317888ed4aceSMatthew G Knepley /*@
317988ed4aceSMatthew G Knepley   DMGetDefaultSection - Get the PetscSection encoding the local data layout for the DM.
318088ed4aceSMatthew G Knepley 
318188ed4aceSMatthew G Knepley   Input Parameter:
318288ed4aceSMatthew G Knepley . dm - The DM
318388ed4aceSMatthew G Knepley 
318488ed4aceSMatthew G Knepley   Output Parameter:
318588ed4aceSMatthew G Knepley . section - The PetscSection
318688ed4aceSMatthew G Knepley 
318788ed4aceSMatthew G Knepley   Level: intermediate
318888ed4aceSMatthew G Knepley 
318988ed4aceSMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSection.
319088ed4aceSMatthew G Knepley 
319188ed4aceSMatthew G Knepley .seealso: DMSetDefaultSection(), DMGetDefaultGlobalSection()
319288ed4aceSMatthew G Knepley @*/
31930adebc6cSBarry Smith PetscErrorCode DMGetDefaultSection(DM dm, PetscSection *section)
31940adebc6cSBarry Smith {
3195fd59a867SMatthew G. Knepley   PetscErrorCode ierr;
3196fd59a867SMatthew G. Knepley 
319788ed4aceSMatthew G Knepley   PetscFunctionBegin;
319888ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
319988ed4aceSMatthew G Knepley   PetscValidPointer(section, 2);
32002f0f8703SMatthew G. Knepley   if (!dm->defaultSection && dm->ops->createdefaultsection) {
32012f0f8703SMatthew G. Knepley     ierr = (*dm->ops->createdefaultsection)(dm);CHKERRQ(ierr);
3202ae71db08SMatthew G. Knepley     if (dm->defaultSection) {ierr = PetscObjectViewFromOptions((PetscObject) dm->defaultSection, NULL, "-dm_petscsection_view");CHKERRQ(ierr);}
32032f0f8703SMatthew G. Knepley   }
320488ed4aceSMatthew G Knepley   *section = dm->defaultSection;
320588ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
320688ed4aceSMatthew G Knepley }
320788ed4aceSMatthew G Knepley 
320888ed4aceSMatthew G Knepley /*@
320988ed4aceSMatthew G Knepley   DMSetDefaultSection - Set the PetscSection encoding the local data layout for the DM.
321088ed4aceSMatthew G Knepley 
321188ed4aceSMatthew G Knepley   Input Parameters:
321288ed4aceSMatthew G Knepley + dm - The DM
321388ed4aceSMatthew G Knepley - section - The PetscSection
321488ed4aceSMatthew G Knepley 
321588ed4aceSMatthew G Knepley   Level: intermediate
321688ed4aceSMatthew G Knepley 
321788ed4aceSMatthew G Knepley   Note: Any existing Section will be destroyed
321888ed4aceSMatthew G Knepley 
321988ed4aceSMatthew G Knepley .seealso: DMSetDefaultSection(), DMGetDefaultGlobalSection()
322088ed4aceSMatthew G Knepley @*/
32210adebc6cSBarry Smith PetscErrorCode DMSetDefaultSection(DM dm, PetscSection section)
32220adebc6cSBarry Smith {
3223c473ab19SMatthew G. Knepley   PetscInt       numFields = 0;
3224af122d2aSMatthew G Knepley   PetscInt       f;
322588ed4aceSMatthew G Knepley   PetscErrorCode ierr;
322688ed4aceSMatthew G Knepley 
322788ed4aceSMatthew G Knepley   PetscFunctionBegin;
322888ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
3229c473ab19SMatthew G. Knepley   if (section) {
32301d799100SJed Brown     PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2);
32311d799100SJed Brown     ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr);
3232c473ab19SMatthew G. Knepley   }
323388ed4aceSMatthew G Knepley   ierr = PetscSectionDestroy(&dm->defaultSection);CHKERRQ(ierr);
323488ed4aceSMatthew G Knepley   dm->defaultSection = section;
3235c473ab19SMatthew G. Knepley   if (section) {ierr = PetscSectionGetNumFields(dm->defaultSection, &numFields);CHKERRQ(ierr);}
3236af122d2aSMatthew G Knepley   if (numFields) {
3237af122d2aSMatthew G Knepley     ierr = DMSetNumFields(dm, numFields);CHKERRQ(ierr);
3238af122d2aSMatthew G Knepley     for (f = 0; f < numFields; ++f) {
32390f21e855SMatthew G. Knepley       PetscObject disc;
3240af122d2aSMatthew G Knepley       const char *name;
3241af122d2aSMatthew G Knepley 
3242af122d2aSMatthew G Knepley       ierr = PetscSectionGetFieldName(dm->defaultSection, f, &name);CHKERRQ(ierr);
32430f21e855SMatthew G. Knepley       ierr = DMGetField(dm, f, &disc);CHKERRQ(ierr);
32440f21e855SMatthew G. Knepley       ierr = PetscObjectSetName(disc, name);CHKERRQ(ierr);
3245af122d2aSMatthew G Knepley     }
3246af122d2aSMatthew G Knepley   }
32471d799100SJed Brown   /* The global section will be rebuilt in the next call to DMGetDefaultGlobalSection(). */
32481d799100SJed Brown   ierr = PetscSectionDestroy(&dm->defaultGlobalSection);CHKERRQ(ierr);
324988ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
325088ed4aceSMatthew G Knepley }
325188ed4aceSMatthew G Knepley 
32529435951eSToby Isaac /*@
32539435951eSToby Isaac   DMGetDefaultConstraints - Get the PetscSection and Mat the specify the local constraint interpolation. See DMSetDefaultConstraints() for a description of the purpose of constraint interpolation.
32549435951eSToby Isaac 
3255e228b242SToby Isaac   not collective
3256e228b242SToby Isaac 
32579435951eSToby Isaac   Input Parameter:
32589435951eSToby Isaac . dm - The DM
32599435951eSToby Isaac 
32609435951eSToby Isaac   Output Parameter:
32619435951eSToby 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.
32629435951eSToby 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.
32639435951eSToby Isaac 
32649435951eSToby Isaac   Level: advanced
32659435951eSToby Isaac 
32669435951eSToby Isaac   Note: This gets borrowed references, so the user should not destroy the PetscSection or the Mat.
32679435951eSToby Isaac 
32689435951eSToby Isaac .seealso: DMSetDefaultConstraints()
32699435951eSToby Isaac @*/
32709435951eSToby Isaac PetscErrorCode DMGetDefaultConstraints(DM dm, PetscSection *section, Mat *mat)
32719435951eSToby Isaac {
32729435951eSToby Isaac   PetscErrorCode ierr;
32739435951eSToby Isaac 
32749435951eSToby Isaac   PetscFunctionBegin;
32759435951eSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
32769435951eSToby Isaac   if (!dm->defaultConstraintSection && !dm->defaultConstraintMat && dm->ops->createdefaultconstraints) {ierr = (*dm->ops->createdefaultconstraints)(dm);CHKERRQ(ierr);}
327745a75d81SToby Isaac   if (section) {*section = dm->defaultConstraintSection;}
327845a75d81SToby Isaac   if (mat) {*mat = dm->defaultConstraintMat;}
32799435951eSToby Isaac   PetscFunctionReturn(0);
32809435951eSToby Isaac }
32819435951eSToby Isaac 
32829435951eSToby Isaac /*@
32839435951eSToby Isaac   DMSetDefaultConstraints - Set the PetscSection and Mat the specify the local constraint interpolation.
32849435951eSToby Isaac 
32859435951eSToby 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().
32869435951eSToby Isaac 
32879435951eSToby 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.
32889435951eSToby Isaac 
3289e228b242SToby Isaac   collective on dm
3290e228b242SToby Isaac 
32919435951eSToby Isaac   Input Parameters:
32929435951eSToby Isaac + dm - The DM
3293e228b242SToby 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).
3294e228b242SToby 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).
32959435951eSToby Isaac 
32969435951eSToby Isaac   Level: advanced
32979435951eSToby Isaac 
32989435951eSToby Isaac   Note: This increments the references of the PetscSection and the Mat, so they user can destroy them
32999435951eSToby Isaac 
33009435951eSToby Isaac .seealso: DMGetDefaultConstraints()
33019435951eSToby Isaac @*/
33029435951eSToby Isaac PetscErrorCode DMSetDefaultConstraints(DM dm, PetscSection section, Mat mat)
33039435951eSToby Isaac {
3304e228b242SToby Isaac   PetscMPIInt result;
33059435951eSToby Isaac   PetscErrorCode ierr;
33069435951eSToby Isaac 
33079435951eSToby Isaac   PetscFunctionBegin;
33089435951eSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
3309e228b242SToby Isaac   if (section) {
3310e228b242SToby Isaac     PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2);
3311e228b242SToby Isaac     ierr = MPI_Comm_compare(PETSC_COMM_SELF,PetscObjectComm((PetscObject)section),&result);CHKERRQ(ierr);
3312f60917d2SBarry Smith     if (result != MPI_CONGRUENT && result != MPI_IDENT) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NOTSAMECOMM,"constraint section must have local communicator");
3313e228b242SToby Isaac   }
3314e228b242SToby Isaac   if (mat) {
3315e228b242SToby Isaac     PetscValidHeaderSpecific(mat,MAT_CLASSID,3);
3316e228b242SToby Isaac     ierr = MPI_Comm_compare(PETSC_COMM_SELF,PetscObjectComm((PetscObject)mat),&result);CHKERRQ(ierr);
3317f60917d2SBarry Smith     if (result != MPI_CONGRUENT && result != MPI_IDENT) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NOTSAMECOMM,"constraint matrix must have local communicator");
3318e228b242SToby Isaac   }
33199435951eSToby Isaac   ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr);
33209435951eSToby Isaac   ierr = PetscSectionDestroy(&dm->defaultConstraintSection);CHKERRQ(ierr);
33219435951eSToby Isaac   dm->defaultConstraintSection = section;
33229435951eSToby Isaac   ierr = PetscObjectReference((PetscObject)mat);CHKERRQ(ierr);
33239435951eSToby Isaac   ierr = MatDestroy(&dm->defaultConstraintMat);CHKERRQ(ierr);
33249435951eSToby Isaac   dm->defaultConstraintMat = mat;
33259435951eSToby Isaac   PetscFunctionReturn(0);
33269435951eSToby Isaac }
33279435951eSToby Isaac 
3328f741bcd2SMatthew G. Knepley #ifdef PETSC_USE_DEBUG
3329507e4973SMatthew G. Knepley /*
3330507e4973SMatthew G. Knepley   DMDefaultSectionCheckConsistency - Check the consistentcy of the global and local sections.
3331507e4973SMatthew G. Knepley 
3332507e4973SMatthew G. Knepley   Input Parameters:
3333507e4973SMatthew G. Knepley + dm - The DM
3334507e4973SMatthew G. Knepley . localSection - PetscSection describing the local data layout
3335507e4973SMatthew G. Knepley - globalSection - PetscSection describing the global data layout
3336507e4973SMatthew G. Knepley 
3337507e4973SMatthew G. Knepley   Level: intermediate
3338507e4973SMatthew G. Knepley 
3339507e4973SMatthew G. Knepley .seealso: DMGetDefaultSF(), DMSetDefaultSF()
3340507e4973SMatthew G. Knepley */
3341f741bcd2SMatthew G. Knepley static PetscErrorCode DMDefaultSectionCheckConsistency_Internal(DM dm, PetscSection localSection, PetscSection globalSection)
3342507e4973SMatthew G. Knepley {
3343507e4973SMatthew G. Knepley   MPI_Comm        comm;
3344507e4973SMatthew G. Knepley   PetscLayout     layout;
3345507e4973SMatthew G. Knepley   const PetscInt *ranges;
3346507e4973SMatthew G. Knepley   PetscInt        pStart, pEnd, p, nroots;
3347507e4973SMatthew G. Knepley   PetscMPIInt     size, rank;
3348507e4973SMatthew G. Knepley   PetscBool       valid = PETSC_TRUE, gvalid;
3349507e4973SMatthew G. Knepley   PetscErrorCode  ierr;
3350507e4973SMatthew G. Knepley 
3351507e4973SMatthew G. Knepley   PetscFunctionBegin;
3352507e4973SMatthew G. Knepley   ierr = PetscObjectGetComm((PetscObject)dm,&comm);CHKERRQ(ierr);
3353507e4973SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
3354507e4973SMatthew G. Knepley   ierr = MPI_Comm_size(comm, &size);CHKERRQ(ierr);
3355507e4973SMatthew G. Knepley   ierr = MPI_Comm_rank(comm, &rank);CHKERRQ(ierr);
3356507e4973SMatthew G. Knepley   ierr = PetscSectionGetChart(globalSection, &pStart, &pEnd);CHKERRQ(ierr);
3357507e4973SMatthew G. Knepley   ierr = PetscSectionGetConstrainedStorageSize(globalSection, &nroots);CHKERRQ(ierr);
3358507e4973SMatthew G. Knepley   ierr = PetscLayoutCreate(comm, &layout);CHKERRQ(ierr);
3359507e4973SMatthew G. Knepley   ierr = PetscLayoutSetBlockSize(layout, 1);CHKERRQ(ierr);
3360507e4973SMatthew G. Knepley   ierr = PetscLayoutSetLocalSize(layout, nroots);CHKERRQ(ierr);
3361507e4973SMatthew G. Knepley   ierr = PetscLayoutSetUp(layout);CHKERRQ(ierr);
3362507e4973SMatthew G. Knepley   ierr = PetscLayoutGetRanges(layout, &ranges);CHKERRQ(ierr);
3363507e4973SMatthew G. Knepley   for (p = pStart; p < pEnd; ++p) {
3364f741bcd2SMatthew G. Knepley     PetscInt       dof, cdof, off, gdof, gcdof, goff, gsize, d;
3365507e4973SMatthew G. Knepley 
3366507e4973SMatthew G. Knepley     ierr = PetscSectionGetDof(localSection, p, &dof);CHKERRQ(ierr);
3367507e4973SMatthew G. Knepley     ierr = PetscSectionGetOffset(localSection, p, &off);CHKERRQ(ierr);
3368507e4973SMatthew G. Knepley     ierr = PetscSectionGetConstraintDof(localSection, p, &cdof);CHKERRQ(ierr);
3369507e4973SMatthew G. Knepley     ierr = PetscSectionGetDof(globalSection, p, &gdof);CHKERRQ(ierr);
3370507e4973SMatthew G. Knepley     ierr = PetscSectionGetConstraintDof(globalSection, p, &gcdof);CHKERRQ(ierr);
3371507e4973SMatthew G. Knepley     ierr = PetscSectionGetOffset(globalSection, p, &goff);CHKERRQ(ierr);
3372507e4973SMatthew G. Knepley     if (!gdof) continue; /* Censored point */
3373507e4973SMatthew 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;}
3374507e4973SMatthew 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;}
3375507e4973SMatthew G. Knepley     if (gdof < 0) {
3376507e4973SMatthew G. Knepley       gsize = gdof < 0 ? -(gdof+1)-gcdof : gdof-gcdof;
3377507e4973SMatthew G. Knepley       for (d = 0; d < gsize; ++d) {
3378507e4973SMatthew G. Knepley         PetscInt offset = -(goff+1) + d, r;
3379507e4973SMatthew G. Knepley 
3380507e4973SMatthew G. Knepley         ierr = PetscFindInt(offset,size+1,ranges,&r);CHKERRQ(ierr);
3381507e4973SMatthew G. Knepley         if (r < 0) r = -(r+2);
3382507e4973SMatthew 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;}
3383507e4973SMatthew G. Knepley       }
3384507e4973SMatthew G. Knepley     }
3385507e4973SMatthew G. Knepley   }
3386507e4973SMatthew G. Knepley   ierr = PetscLayoutDestroy(&layout);CHKERRQ(ierr);
3387507e4973SMatthew G. Knepley   ierr = PetscSynchronizedFlush(comm, NULL);CHKERRQ(ierr);
3388b2566f29SBarry Smith   ierr = MPIU_Allreduce(&valid, &gvalid, 1, MPIU_BOOL, MPI_LAND, comm);CHKERRQ(ierr);
3389507e4973SMatthew G. Knepley   if (!gvalid) {
3390507e4973SMatthew G. Knepley     ierr = DMView(dm, NULL);CHKERRQ(ierr);
3391507e4973SMatthew G. Knepley     SETERRQ(comm, PETSC_ERR_ARG_WRONG, "Inconsistent local and global sections");
3392507e4973SMatthew G. Knepley   }
3393507e4973SMatthew G. Knepley   PetscFunctionReturn(0);
3394507e4973SMatthew G. Knepley }
3395f741bcd2SMatthew G. Knepley #endif
3396507e4973SMatthew G. Knepley 
339788ed4aceSMatthew G Knepley /*@
339888ed4aceSMatthew G Knepley   DMGetDefaultGlobalSection - Get the PetscSection encoding the global data layout for the DM.
339988ed4aceSMatthew G Knepley 
34008b1ab98fSJed Brown   Collective on DM
34018b1ab98fSJed Brown 
340288ed4aceSMatthew G Knepley   Input Parameter:
340388ed4aceSMatthew G Knepley . dm - The DM
340488ed4aceSMatthew G Knepley 
340588ed4aceSMatthew G Knepley   Output Parameter:
340688ed4aceSMatthew G Knepley . section - The PetscSection
340788ed4aceSMatthew G Knepley 
340888ed4aceSMatthew G Knepley   Level: intermediate
340988ed4aceSMatthew G Knepley 
341088ed4aceSMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSection.
341188ed4aceSMatthew G Knepley 
341288ed4aceSMatthew G Knepley .seealso: DMSetDefaultSection(), DMGetDefaultSection()
341388ed4aceSMatthew G Knepley @*/
34140adebc6cSBarry Smith PetscErrorCode DMGetDefaultGlobalSection(DM dm, PetscSection *section)
34150adebc6cSBarry Smith {
341688ed4aceSMatthew G Knepley   PetscErrorCode ierr;
341788ed4aceSMatthew G Knepley 
341888ed4aceSMatthew G Knepley   PetscFunctionBegin;
341988ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
342088ed4aceSMatthew G Knepley   PetscValidPointer(section, 2);
342188ed4aceSMatthew G Knepley   if (!dm->defaultGlobalSection) {
3422fd59a867SMatthew G. Knepley     PetscSection s;
3423fd59a867SMatthew G. Knepley 
3424fd59a867SMatthew G. Knepley     ierr = DMGetDefaultSection(dm, &s);CHKERRQ(ierr);
3425fd59a867SMatthew 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");
3426fd59a867SMatthew 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");
342715b58121SMatthew G. Knepley     ierr = PetscSectionCreateGlobalSection(s, dm->sf, PETSC_FALSE, PETSC_FALSE, &dm->defaultGlobalSection);CHKERRQ(ierr);
3428cf06b437SMatthew G. Knepley     ierr = PetscLayoutDestroy(&dm->map);CHKERRQ(ierr);
3429ce94432eSBarry Smith     ierr = PetscSectionGetValueLayout(PetscObjectComm((PetscObject)dm), dm->defaultGlobalSection, &dm->map);CHKERRQ(ierr);
3430685405a1SBarry Smith     ierr = PetscSectionViewFromOptions(dm->defaultGlobalSection, NULL, "-global_section_view");CHKERRQ(ierr);
343188ed4aceSMatthew G Knepley   }
343288ed4aceSMatthew G Knepley   *section = dm->defaultGlobalSection;
343388ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
343488ed4aceSMatthew G Knepley }
343588ed4aceSMatthew G Knepley 
3436b21d0597SMatthew G Knepley /*@
3437b21d0597SMatthew G Knepley   DMSetDefaultGlobalSection - Set the PetscSection encoding the global data layout for the DM.
3438b21d0597SMatthew G Knepley 
3439b21d0597SMatthew G Knepley   Input Parameters:
3440b21d0597SMatthew G Knepley + dm - The DM
34415080bbdbSMatthew G Knepley - section - The PetscSection, or NULL
3442b21d0597SMatthew G Knepley 
3443b21d0597SMatthew G Knepley   Level: intermediate
3444b21d0597SMatthew G Knepley 
3445b21d0597SMatthew G Knepley   Note: Any existing Section will be destroyed
3446b21d0597SMatthew G Knepley 
3447b21d0597SMatthew G Knepley .seealso: DMGetDefaultGlobalSection(), DMSetDefaultSection()
3448b21d0597SMatthew G Knepley @*/
34490adebc6cSBarry Smith PetscErrorCode DMSetDefaultGlobalSection(DM dm, PetscSection section)
34500adebc6cSBarry Smith {
3451b21d0597SMatthew G Knepley   PetscErrorCode ierr;
3452b21d0597SMatthew G Knepley 
3453b21d0597SMatthew G Knepley   PetscFunctionBegin;
3454b21d0597SMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
34555080bbdbSMatthew G Knepley   if (section) PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2);
34561d799100SJed Brown   ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr);
3457b21d0597SMatthew G Knepley   ierr = PetscSectionDestroy(&dm->defaultGlobalSection);CHKERRQ(ierr);
3458b21d0597SMatthew G Knepley   dm->defaultGlobalSection = section;
3459507e4973SMatthew G. Knepley #ifdef PETSC_USE_DEBUG
3460f741bcd2SMatthew G. Knepley   if (section) {ierr = DMDefaultSectionCheckConsistency_Internal(dm, dm->defaultSection, section);CHKERRQ(ierr);}
3461507e4973SMatthew G. Knepley #endif
3462b21d0597SMatthew G Knepley   PetscFunctionReturn(0);
3463b21d0597SMatthew G Knepley }
3464b21d0597SMatthew G Knepley 
346588ed4aceSMatthew G Knepley /*@
346688ed4aceSMatthew G Knepley   DMGetDefaultSF - Get the PetscSF encoding the parallel dof overlap for the DM. If it has not been set,
346788ed4aceSMatthew G Knepley   it is created from the default PetscSection layouts in the DM.
346888ed4aceSMatthew G Knepley 
346988ed4aceSMatthew G Knepley   Input Parameter:
347088ed4aceSMatthew G Knepley . dm - The DM
347188ed4aceSMatthew G Knepley 
347288ed4aceSMatthew G Knepley   Output Parameter:
347388ed4aceSMatthew G Knepley . sf - The PetscSF
347488ed4aceSMatthew G Knepley 
347588ed4aceSMatthew G Knepley   Level: intermediate
347688ed4aceSMatthew G Knepley 
347788ed4aceSMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSF.
347888ed4aceSMatthew G Knepley 
347988ed4aceSMatthew G Knepley .seealso: DMSetDefaultSF(), DMCreateDefaultSF()
348088ed4aceSMatthew G Knepley @*/
34810adebc6cSBarry Smith PetscErrorCode DMGetDefaultSF(DM dm, PetscSF *sf)
34820adebc6cSBarry Smith {
348388ed4aceSMatthew G Knepley   PetscInt       nroots;
348488ed4aceSMatthew G Knepley   PetscErrorCode ierr;
348588ed4aceSMatthew G Knepley 
348688ed4aceSMatthew G Knepley   PetscFunctionBegin;
348788ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
348888ed4aceSMatthew G Knepley   PetscValidPointer(sf, 2);
34890298fd71SBarry Smith   ierr = PetscSFGetGraph(dm->defaultSF, &nroots, NULL, NULL, NULL);CHKERRQ(ierr);
349088ed4aceSMatthew G Knepley   if (nroots < 0) {
349188ed4aceSMatthew G Knepley     PetscSection section, gSection;
349288ed4aceSMatthew G Knepley 
349388ed4aceSMatthew G Knepley     ierr = DMGetDefaultSection(dm, &section);CHKERRQ(ierr);
349431ea6d37SMatthew G Knepley     if (section) {
349588ed4aceSMatthew G Knepley       ierr = DMGetDefaultGlobalSection(dm, &gSection);CHKERRQ(ierr);
349688ed4aceSMatthew G Knepley       ierr = DMCreateDefaultSF(dm, section, gSection);CHKERRQ(ierr);
349731ea6d37SMatthew G Knepley     } else {
34980298fd71SBarry Smith       *sf = NULL;
349931ea6d37SMatthew G Knepley       PetscFunctionReturn(0);
350031ea6d37SMatthew G Knepley     }
350188ed4aceSMatthew G Knepley   }
350288ed4aceSMatthew G Knepley   *sf = dm->defaultSF;
350388ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
350488ed4aceSMatthew G Knepley }
350588ed4aceSMatthew G Knepley 
350688ed4aceSMatthew G Knepley /*@
350788ed4aceSMatthew G Knepley   DMSetDefaultSF - Set the PetscSF encoding the parallel dof overlap for the DM
350888ed4aceSMatthew G Knepley 
350988ed4aceSMatthew G Knepley   Input Parameters:
351088ed4aceSMatthew G Knepley + dm - The DM
351188ed4aceSMatthew G Knepley - sf - The PetscSF
351288ed4aceSMatthew G Knepley 
351388ed4aceSMatthew G Knepley   Level: intermediate
351488ed4aceSMatthew G Knepley 
351588ed4aceSMatthew G Knepley   Note: Any previous SF is destroyed
351688ed4aceSMatthew G Knepley 
351788ed4aceSMatthew G Knepley .seealso: DMGetDefaultSF(), DMCreateDefaultSF()
351888ed4aceSMatthew G Knepley @*/
35190adebc6cSBarry Smith PetscErrorCode DMSetDefaultSF(DM dm, PetscSF sf)
35200adebc6cSBarry Smith {
352188ed4aceSMatthew G Knepley   PetscErrorCode ierr;
352288ed4aceSMatthew G Knepley 
352388ed4aceSMatthew G Knepley   PetscFunctionBegin;
352488ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
352588ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
352688ed4aceSMatthew G Knepley   ierr          = PetscSFDestroy(&dm->defaultSF);CHKERRQ(ierr);
352788ed4aceSMatthew G Knepley   dm->defaultSF = sf;
352888ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
352988ed4aceSMatthew G Knepley }
353088ed4aceSMatthew G Knepley 
353188ed4aceSMatthew G Knepley /*@C
353288ed4aceSMatthew G Knepley   DMCreateDefaultSF - Create the PetscSF encoding the parallel dof overlap for the DM based upon the PetscSections
353388ed4aceSMatthew G Knepley   describing the data layout.
353488ed4aceSMatthew G Knepley 
353588ed4aceSMatthew G Knepley   Input Parameters:
353688ed4aceSMatthew G Knepley + dm - The DM
353788ed4aceSMatthew G Knepley . localSection - PetscSection describing the local data layout
353888ed4aceSMatthew G Knepley - globalSection - PetscSection describing the global data layout
353988ed4aceSMatthew G Knepley 
354088ed4aceSMatthew G Knepley   Level: intermediate
354188ed4aceSMatthew G Knepley 
354288ed4aceSMatthew G Knepley .seealso: DMGetDefaultSF(), DMSetDefaultSF()
354388ed4aceSMatthew G Knepley @*/
354488ed4aceSMatthew G Knepley PetscErrorCode DMCreateDefaultSF(DM dm, PetscSection localSection, PetscSection globalSection)
354588ed4aceSMatthew G Knepley {
354682f516ccSBarry Smith   MPI_Comm       comm;
354788ed4aceSMatthew G Knepley   PetscLayout    layout;
354888ed4aceSMatthew G Knepley   const PetscInt *ranges;
354988ed4aceSMatthew G Knepley   PetscInt       *local;
355088ed4aceSMatthew G Knepley   PetscSFNode    *remote;
3551ecd73843SMatthew G. Knepley   PetscInt       pStart, pEnd, p, nroots, nleaves = 0, l;
355288ed4aceSMatthew G Knepley   PetscMPIInt    size, rank;
355388ed4aceSMatthew G Knepley   PetscErrorCode ierr;
355488ed4aceSMatthew G Knepley 
355588ed4aceSMatthew G Knepley   PetscFunctionBegin;
355682f516ccSBarry Smith   ierr = PetscObjectGetComm((PetscObject)dm,&comm);CHKERRQ(ierr);
355788ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
355888ed4aceSMatthew G Knepley   ierr = MPI_Comm_size(comm, &size);CHKERRQ(ierr);
355988ed4aceSMatthew G Knepley   ierr = MPI_Comm_rank(comm, &rank);CHKERRQ(ierr);
356088ed4aceSMatthew G Knepley   ierr = PetscSectionGetChart(globalSection, &pStart, &pEnd);CHKERRQ(ierr);
356188ed4aceSMatthew G Knepley   ierr = PetscSectionGetConstrainedStorageSize(globalSection, &nroots);CHKERRQ(ierr);
356288ed4aceSMatthew G Knepley   ierr = PetscLayoutCreate(comm, &layout);CHKERRQ(ierr);
356388ed4aceSMatthew G Knepley   ierr = PetscLayoutSetBlockSize(layout, 1);CHKERRQ(ierr);
356488ed4aceSMatthew G Knepley   ierr = PetscLayoutSetLocalSize(layout, nroots);CHKERRQ(ierr);
356588ed4aceSMatthew G Knepley   ierr = PetscLayoutSetUp(layout);CHKERRQ(ierr);
356688ed4aceSMatthew G Knepley   ierr = PetscLayoutGetRanges(layout, &ranges);CHKERRQ(ierr);
3567ecd73843SMatthew G. Knepley   for (p = pStart; p < pEnd; ++p) {
35686636e97aSMatthew G Knepley     PetscInt gdof, gcdof;
356988ed4aceSMatthew G Knepley 
35706636e97aSMatthew G Knepley     ierr     = PetscSectionGetDof(globalSection, p, &gdof);CHKERRQ(ierr);
35716636e97aSMatthew G Knepley     ierr     = PetscSectionGetConstraintDof(globalSection, p, &gcdof);CHKERRQ(ierr);
3572235fbf56SMatthew 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));
35736636e97aSMatthew G Knepley     nleaves += gdof < 0 ? -(gdof+1)-gcdof : gdof-gcdof;
357488ed4aceSMatthew G Knepley   }
3575785e854fSJed Brown   ierr = PetscMalloc1(nleaves, &local);CHKERRQ(ierr);
3576785e854fSJed Brown   ierr = PetscMalloc1(nleaves, &remote);CHKERRQ(ierr);
357788ed4aceSMatthew G Knepley   for (p = pStart, l = 0; p < pEnd; ++p) {
35781f588964SMatthew G Knepley     const PetscInt *cind;
35796636e97aSMatthew G Knepley     PetscInt       dof, cdof, off, gdof, gcdof, goff, gsize, d, c;
358088ed4aceSMatthew G Knepley 
358188ed4aceSMatthew G Knepley     ierr = PetscSectionGetDof(localSection, p, &dof);CHKERRQ(ierr);
358288ed4aceSMatthew G Knepley     ierr = PetscSectionGetOffset(localSection, p, &off);CHKERRQ(ierr);
358388ed4aceSMatthew G Knepley     ierr = PetscSectionGetConstraintDof(localSection, p, &cdof);CHKERRQ(ierr);
358488ed4aceSMatthew G Knepley     ierr = PetscSectionGetConstraintIndices(localSection, p, &cind);CHKERRQ(ierr);
358588ed4aceSMatthew G Knepley     ierr = PetscSectionGetDof(globalSection, p, &gdof);CHKERRQ(ierr);
35866636e97aSMatthew G Knepley     ierr = PetscSectionGetConstraintDof(globalSection, p, &gcdof);CHKERRQ(ierr);
358788ed4aceSMatthew G Knepley     ierr = PetscSectionGetOffset(globalSection, p, &goff);CHKERRQ(ierr);
35886636e97aSMatthew G Knepley     if (!gdof) continue; /* Censored point */
35896636e97aSMatthew G Knepley     gsize = gdof < 0 ? -(gdof+1)-gcdof : gdof-gcdof;
35906636e97aSMatthew G Knepley     if (gsize != dof-cdof) {
3591057b4bcdSMatthew 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);
35926636e97aSMatthew G Knepley       cdof = 0; /* Ignore constraints */
35936636e97aSMatthew G Knepley     }
359488ed4aceSMatthew G Knepley     for (d = 0, c = 0; d < dof; ++d) {
359588ed4aceSMatthew G Knepley       if ((c < cdof) && (cind[c] == d)) {++c; continue;}
359688ed4aceSMatthew G Knepley       local[l+d-c] = off+d;
359788ed4aceSMatthew G Knepley     }
359888ed4aceSMatthew G Knepley     if (gdof < 0) {
35996636e97aSMatthew G Knepley       for (d = 0; d < gsize; ++d, ++l) {
360088ed4aceSMatthew G Knepley         PetscInt offset = -(goff+1) + d, r;
360188ed4aceSMatthew G Knepley 
360205376888SMatthew G. Knepley         ierr = PetscFindInt(offset,size+1,ranges,&r);CHKERRQ(ierr);
360331d3f06eSJed Brown         if (r < 0) r = -(r+2);
360405376888SMatthew 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);
360588ed4aceSMatthew G Knepley         remote[l].rank  = r;
360688ed4aceSMatthew G Knepley         remote[l].index = offset - ranges[r];
360788ed4aceSMatthew G Knepley       }
360888ed4aceSMatthew G Knepley     } else {
36096636e97aSMatthew G Knepley       for (d = 0; d < gsize; ++d, ++l) {
361088ed4aceSMatthew G Knepley         remote[l].rank  = rank;
361188ed4aceSMatthew G Knepley         remote[l].index = goff+d - ranges[rank];
361288ed4aceSMatthew G Knepley       }
361388ed4aceSMatthew G Knepley     }
361488ed4aceSMatthew G Knepley   }
36156636e97aSMatthew G Knepley   if (l != nleaves) SETERRQ2(comm, PETSC_ERR_PLIB, "Iteration error, l %d != nleaves %d", l, nleaves);
361688ed4aceSMatthew G Knepley   ierr = PetscLayoutDestroy(&layout);CHKERRQ(ierr);
361788ed4aceSMatthew G Knepley   ierr = PetscSFSetGraph(dm->defaultSF, nroots, nleaves, local, PETSC_OWN_POINTER, remote, PETSC_OWN_POINTER);CHKERRQ(ierr);
361888ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
361988ed4aceSMatthew G Knepley }
3620af122d2aSMatthew G Knepley 
3621b21d0597SMatthew G Knepley /*@
3622b21d0597SMatthew G Knepley   DMGetPointSF - Get the PetscSF encoding the parallel section point overlap for the DM.
3623b21d0597SMatthew G Knepley 
3624b21d0597SMatthew G Knepley   Input Parameter:
3625b21d0597SMatthew G Knepley . dm - The DM
3626b21d0597SMatthew G Knepley 
3627b21d0597SMatthew G Knepley   Output Parameter:
3628b21d0597SMatthew G Knepley . sf - The PetscSF
3629b21d0597SMatthew G Knepley 
3630b21d0597SMatthew G Knepley   Level: intermediate
3631b21d0597SMatthew G Knepley 
3632b21d0597SMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSF.
3633b21d0597SMatthew G Knepley 
3634057b4bcdSMatthew G Knepley .seealso: DMSetPointSF(), DMGetDefaultSF(), DMSetDefaultSF(), DMCreateDefaultSF()
3635b21d0597SMatthew G Knepley @*/
36360adebc6cSBarry Smith PetscErrorCode DMGetPointSF(DM dm, PetscSF *sf)
36370adebc6cSBarry Smith {
3638b21d0597SMatthew G Knepley   PetscFunctionBegin;
3639b21d0597SMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
3640b21d0597SMatthew G Knepley   PetscValidPointer(sf, 2);
3641b21d0597SMatthew G Knepley   *sf = dm->sf;
3642b21d0597SMatthew G Knepley   PetscFunctionReturn(0);
3643b21d0597SMatthew G Knepley }
3644b21d0597SMatthew G Knepley 
3645057b4bcdSMatthew G Knepley /*@
3646057b4bcdSMatthew G Knepley   DMSetPointSF - Set the PetscSF encoding the parallel section point overlap for the DM.
3647057b4bcdSMatthew G Knepley 
3648057b4bcdSMatthew G Knepley   Input Parameters:
3649057b4bcdSMatthew G Knepley + dm - The DM
3650057b4bcdSMatthew G Knepley - sf - The PetscSF
3651057b4bcdSMatthew G Knepley 
3652057b4bcdSMatthew G Knepley   Level: intermediate
3653057b4bcdSMatthew G Knepley 
3654057b4bcdSMatthew G Knepley .seealso: DMGetPointSF(), DMGetDefaultSF(), DMSetDefaultSF(), DMCreateDefaultSF()
3655057b4bcdSMatthew G Knepley @*/
36560adebc6cSBarry Smith PetscErrorCode DMSetPointSF(DM dm, PetscSF sf)
36570adebc6cSBarry Smith {
3658057b4bcdSMatthew G Knepley   PetscErrorCode ierr;
3659057b4bcdSMatthew G Knepley 
3660057b4bcdSMatthew G Knepley   PetscFunctionBegin;
3661057b4bcdSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
3662057b4bcdSMatthew G Knepley   PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 1);
3663057b4bcdSMatthew G Knepley   ierr   = PetscSFDestroy(&dm->sf);CHKERRQ(ierr);
3664057b4bcdSMatthew G Knepley   ierr   = PetscObjectReference((PetscObject) sf);CHKERRQ(ierr);
3665057b4bcdSMatthew G Knepley   dm->sf = sf;
3666057b4bcdSMatthew G Knepley   PetscFunctionReturn(0);
3667057b4bcdSMatthew G Knepley }
3668057b4bcdSMatthew G Knepley 
36692764a2aaSMatthew G. Knepley /*@
36702764a2aaSMatthew G. Knepley   DMGetDS - Get the PetscDS
36712764a2aaSMatthew G. Knepley 
36722764a2aaSMatthew G. Knepley   Input Parameter:
36732764a2aaSMatthew G. Knepley . dm - The DM
36742764a2aaSMatthew G. Knepley 
36752764a2aaSMatthew G. Knepley   Output Parameter:
36762764a2aaSMatthew G. Knepley . prob - The PetscDS
36772764a2aaSMatthew G. Knepley 
36782764a2aaSMatthew G. Knepley   Level: developer
36792764a2aaSMatthew G. Knepley 
36802764a2aaSMatthew G. Knepley .seealso: DMSetDS()
36812764a2aaSMatthew G. Knepley @*/
36822764a2aaSMatthew G. Knepley PetscErrorCode DMGetDS(DM dm, PetscDS *prob)
3683af122d2aSMatthew G Knepley {
3684af122d2aSMatthew G Knepley   PetscFunctionBegin;
3685af122d2aSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
36860f21e855SMatthew G. Knepley   PetscValidPointer(prob, 2);
36870f21e855SMatthew G. Knepley   *prob = dm->prob;
36880f21e855SMatthew G. Knepley   PetscFunctionReturn(0);
36890f21e855SMatthew G. Knepley }
36900f21e855SMatthew G. Knepley 
36912764a2aaSMatthew G. Knepley /*@
36922764a2aaSMatthew G. Knepley   DMSetDS - Set the PetscDS
36932764a2aaSMatthew G. Knepley 
36942764a2aaSMatthew G. Knepley   Input Parameters:
36952764a2aaSMatthew G. Knepley + dm - The DM
36962764a2aaSMatthew G. Knepley - prob - The PetscDS
36972764a2aaSMatthew G. Knepley 
36982764a2aaSMatthew G. Knepley   Level: developer
36992764a2aaSMatthew G. Knepley 
37002764a2aaSMatthew G. Knepley .seealso: DMGetDS()
37012764a2aaSMatthew G. Knepley @*/
37022764a2aaSMatthew G. Knepley PetscErrorCode DMSetDS(DM dm, PetscDS prob)
37030f21e855SMatthew G. Knepley {
37040f21e855SMatthew G. Knepley   PetscErrorCode ierr;
37050f21e855SMatthew G. Knepley 
37060f21e855SMatthew G. Knepley   PetscFunctionBegin;
37070f21e855SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
37082764a2aaSMatthew G. Knepley   PetscValidHeaderSpecific(prob, PETSCDS_CLASSID, 2);
370937316535SToby Isaac   ierr = PetscObjectReference((PetscObject) prob);CHKERRQ(ierr);
37102764a2aaSMatthew G. Knepley   ierr = PetscDSDestroy(&dm->prob);CHKERRQ(ierr);
37110f21e855SMatthew G. Knepley   dm->prob = prob;
37120f21e855SMatthew G. Knepley   PetscFunctionReturn(0);
37130f21e855SMatthew G. Knepley }
37140f21e855SMatthew G. Knepley 
37150f21e855SMatthew G. Knepley PetscErrorCode DMGetNumFields(DM dm, PetscInt *numFields)
37160f21e855SMatthew G. Knepley {
37170f21e855SMatthew G. Knepley   PetscErrorCode ierr;
37180f21e855SMatthew G. Knepley 
37190f21e855SMatthew G. Knepley   PetscFunctionBegin;
37200f21e855SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
37212764a2aaSMatthew G. Knepley   ierr = PetscDSGetNumFields(dm->prob, numFields);CHKERRQ(ierr);
3722af122d2aSMatthew G Knepley   PetscFunctionReturn(0);
3723af122d2aSMatthew G Knepley }
3724af122d2aSMatthew G Knepley 
3725af122d2aSMatthew G Knepley PetscErrorCode DMSetNumFields(DM dm, PetscInt numFields)
3726af122d2aSMatthew G Knepley {
37270f21e855SMatthew G. Knepley   PetscInt       Nf, f;
3728af122d2aSMatthew G Knepley   PetscErrorCode ierr;
3729af122d2aSMatthew G Knepley 
3730af122d2aSMatthew G Knepley   PetscFunctionBegin;
3731af122d2aSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
37322764a2aaSMatthew G. Knepley   ierr = PetscDSGetNumFields(dm->prob, &Nf);CHKERRQ(ierr);
37330f21e855SMatthew G. Knepley   for (f = Nf; f < numFields; ++f) {
37340f21e855SMatthew G. Knepley     PetscContainer obj;
37350f21e855SMatthew G. Knepley 
37360f21e855SMatthew G. Knepley     ierr = PetscContainerCreate(PetscObjectComm((PetscObject) dm), &obj);CHKERRQ(ierr);
37372764a2aaSMatthew G. Knepley     ierr = PetscDSSetDiscretization(dm->prob, f, (PetscObject) obj);CHKERRQ(ierr);
37380f21e855SMatthew G. Knepley     ierr = PetscContainerDestroy(&obj);CHKERRQ(ierr);
3739af122d2aSMatthew G Knepley   }
3740af122d2aSMatthew G Knepley   PetscFunctionReturn(0);
3741af122d2aSMatthew G Knepley }
3742af122d2aSMatthew G Knepley 
3743c1929be8SMatthew G. Knepley /*@
3744c1929be8SMatthew G. Knepley   DMGetField - Return the discretization object for a given DM field
3745c1929be8SMatthew G. Knepley 
3746c1929be8SMatthew G. Knepley   Not collective
3747c1929be8SMatthew G. Knepley 
3748c1929be8SMatthew G. Knepley   Input Parameters:
3749c1929be8SMatthew G. Knepley + dm - The DM
3750c1929be8SMatthew G. Knepley - f  - The field number
3751c1929be8SMatthew G. Knepley 
3752c1929be8SMatthew G. Knepley   Output Parameter:
3753c1929be8SMatthew G. Knepley . field - The discretization object
3754c1929be8SMatthew G. Knepley 
3755c1929be8SMatthew G. Knepley   Level: developer
3756c1929be8SMatthew G. Knepley 
3757c1929be8SMatthew G. Knepley .seealso: DMSetField()
3758c1929be8SMatthew G. Knepley @*/
3759af122d2aSMatthew G Knepley PetscErrorCode DMGetField(DM dm, PetscInt f, PetscObject *field)
3760af122d2aSMatthew G Knepley {
37610f21e855SMatthew G. Knepley   PetscErrorCode ierr;
37620f21e855SMatthew G. Knepley 
3763af122d2aSMatthew G Knepley   PetscFunctionBegin;
3764af122d2aSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
37652764a2aaSMatthew G. Knepley   ierr = PetscDSGetDiscretization(dm->prob, f, field);CHKERRQ(ierr);
3766decb47aaSMatthew G. Knepley   PetscFunctionReturn(0);
3767decb47aaSMatthew G. Knepley }
3768decb47aaSMatthew G. Knepley 
3769c1929be8SMatthew G. Knepley /*@
3770c1929be8SMatthew G. Knepley   DMSetField - Set the discretization object for a given DM field
3771c1929be8SMatthew G. Knepley 
3772c1929be8SMatthew G. Knepley   Logically collective on DM
3773c1929be8SMatthew G. Knepley 
3774c1929be8SMatthew G. Knepley   Input Parameters:
3775c1929be8SMatthew G. Knepley + dm - The DM
3776c1929be8SMatthew G. Knepley . f  - The field number
3777c1929be8SMatthew G. Knepley - field - The discretization object
3778c1929be8SMatthew G. Knepley 
3779c1929be8SMatthew G. Knepley   Level: developer
3780c1929be8SMatthew G. Knepley 
3781c1929be8SMatthew G. Knepley .seealso: DMGetField()
3782c1929be8SMatthew G. Knepley @*/
3783decb47aaSMatthew G. Knepley PetscErrorCode DMSetField(DM dm, PetscInt f, PetscObject field)
3784decb47aaSMatthew G. Knepley {
3785decb47aaSMatthew G. Knepley   PetscErrorCode ierr;
3786decb47aaSMatthew G. Knepley 
3787decb47aaSMatthew G. Knepley   PetscFunctionBegin;
3788decb47aaSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
37892764a2aaSMatthew G. Knepley   ierr = PetscDSSetDiscretization(dm->prob, f, field);CHKERRQ(ierr);
3790af122d2aSMatthew G Knepley   PetscFunctionReturn(0);
3791af122d2aSMatthew G Knepley }
37926636e97aSMatthew G Knepley 
3793b64e0483SPeter Brune PetscErrorCode DMRestrictHook_Coordinates(DM dm,DM dmc,void *ctx)
3794b64e0483SPeter Brune {
3795b64e0483SPeter Brune   DM dm_coord,dmc_coord;
3796b64e0483SPeter Brune   PetscErrorCode ierr;
3797b64e0483SPeter Brune   Vec coords,ccoords;
37986dbf9973SLawrence Mitchell   Mat inject;
3799b64e0483SPeter Brune   PetscFunctionBegin;
3800b64e0483SPeter Brune   ierr = DMGetCoordinateDM(dm,&dm_coord);CHKERRQ(ierr);
3801b64e0483SPeter Brune   ierr = DMGetCoordinateDM(dmc,&dmc_coord);CHKERRQ(ierr);
3802b64e0483SPeter Brune   ierr = DMGetCoordinates(dm,&coords);CHKERRQ(ierr);
3803b64e0483SPeter Brune   ierr = DMGetCoordinates(dmc,&ccoords);CHKERRQ(ierr);
3804b64e0483SPeter Brune   if (coords && !ccoords) {
3805b64e0483SPeter Brune     ierr = DMCreateGlobalVector(dmc_coord,&ccoords);CHKERRQ(ierr);
38066668ed41SLisandro Dalcin     ierr = PetscObjectSetName((PetscObject)ccoords,"coordinates");CHKERRQ(ierr);
38076dbf9973SLawrence Mitchell     ierr = DMCreateInjection(dmc_coord,dm_coord,&inject);CHKERRQ(ierr);
38082adcf181SLawrence Mitchell     ierr = MatRestrict(inject,coords,ccoords);CHKERRQ(ierr);
38096dbf9973SLawrence Mitchell     ierr = MatDestroy(&inject);CHKERRQ(ierr);
3810b64e0483SPeter Brune     ierr = DMSetCoordinates(dmc,ccoords);CHKERRQ(ierr);
3811b64e0483SPeter Brune     ierr = VecDestroy(&ccoords);CHKERRQ(ierr);
3812b64e0483SPeter Brune   }
3813b64e0483SPeter Brune   PetscFunctionReturn(0);
3814b64e0483SPeter Brune }
3815b64e0483SPeter Brune 
381603dadc2fSPeter Brune static PetscErrorCode DMSubDomainHook_Coordinates(DM dm,DM subdm,void *ctx)
381703dadc2fSPeter Brune {
381803dadc2fSPeter Brune   DM dm_coord,subdm_coord;
381903dadc2fSPeter Brune   PetscErrorCode ierr;
382003dadc2fSPeter Brune   Vec coords,ccoords,clcoords;
382103dadc2fSPeter Brune   VecScatter *scat_i,*scat_g;
382203dadc2fSPeter Brune   PetscFunctionBegin;
382303dadc2fSPeter Brune   ierr = DMGetCoordinateDM(dm,&dm_coord);CHKERRQ(ierr);
382403dadc2fSPeter Brune   ierr = DMGetCoordinateDM(subdm,&subdm_coord);CHKERRQ(ierr);
382503dadc2fSPeter Brune   ierr = DMGetCoordinates(dm,&coords);CHKERRQ(ierr);
382603dadc2fSPeter Brune   ierr = DMGetCoordinates(subdm,&ccoords);CHKERRQ(ierr);
382703dadc2fSPeter Brune   if (coords && !ccoords) {
382803dadc2fSPeter Brune     ierr = DMCreateGlobalVector(subdm_coord,&ccoords);CHKERRQ(ierr);
38296668ed41SLisandro Dalcin     ierr = PetscObjectSetName((PetscObject)ccoords,"coordinates");CHKERRQ(ierr);
383003dadc2fSPeter Brune     ierr = DMCreateLocalVector(subdm_coord,&clcoords);CHKERRQ(ierr);
383124640c55SToby Isaac     ierr = PetscObjectSetName((PetscObject)clcoords,"coordinates");CHKERRQ(ierr);
383203dadc2fSPeter Brune     ierr = DMCreateDomainDecompositionScatters(dm_coord,1,&subdm_coord,NULL,&scat_i,&scat_g);CHKERRQ(ierr);
383303dadc2fSPeter Brune     ierr = VecScatterBegin(scat_i[0],coords,ccoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
383403dadc2fSPeter Brune     ierr = VecScatterBegin(scat_g[0],coords,clcoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
383503dadc2fSPeter Brune     ierr = VecScatterEnd(scat_i[0],coords,ccoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
383603dadc2fSPeter Brune     ierr = VecScatterEnd(scat_g[0],coords,clcoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
383703dadc2fSPeter Brune     ierr = DMSetCoordinates(subdm,ccoords);CHKERRQ(ierr);
383803dadc2fSPeter Brune     ierr = DMSetCoordinatesLocal(subdm,clcoords);CHKERRQ(ierr);
383903dadc2fSPeter Brune     ierr = VecScatterDestroy(&scat_i[0]);CHKERRQ(ierr);
384003dadc2fSPeter Brune     ierr = VecScatterDestroy(&scat_g[0]);CHKERRQ(ierr);
384103dadc2fSPeter Brune     ierr = VecDestroy(&ccoords);CHKERRQ(ierr);
384203dadc2fSPeter Brune     ierr = VecDestroy(&clcoords);CHKERRQ(ierr);
384303dadc2fSPeter Brune     ierr = PetscFree(scat_i);CHKERRQ(ierr);
384403dadc2fSPeter Brune     ierr = PetscFree(scat_g);CHKERRQ(ierr);
384503dadc2fSPeter Brune   }
384603dadc2fSPeter Brune   PetscFunctionReturn(0);
384703dadc2fSPeter Brune }
384803dadc2fSPeter Brune 
3849c73cfb54SMatthew G. Knepley /*@
3850c73cfb54SMatthew G. Knepley   DMGetDimension - Return the topological dimension of the DM
3851c73cfb54SMatthew G. Knepley 
3852c73cfb54SMatthew G. Knepley   Not collective
3853c73cfb54SMatthew G. Knepley 
3854c73cfb54SMatthew G. Knepley   Input Parameter:
3855c73cfb54SMatthew G. Knepley . dm - The DM
3856c73cfb54SMatthew G. Knepley 
3857c73cfb54SMatthew G. Knepley   Output Parameter:
3858c73cfb54SMatthew G. Knepley . dim - The topological dimension
3859c73cfb54SMatthew G. Knepley 
3860c73cfb54SMatthew G. Knepley   Level: beginner
3861c73cfb54SMatthew G. Knepley 
3862c73cfb54SMatthew G. Knepley .seealso: DMSetDimension(), DMCreate()
3863c73cfb54SMatthew G. Knepley @*/
3864c73cfb54SMatthew G. Knepley PetscErrorCode DMGetDimension(DM dm, PetscInt *dim)
3865c73cfb54SMatthew G. Knepley {
3866c73cfb54SMatthew G. Knepley   PetscFunctionBegin;
3867c73cfb54SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
3868c73cfb54SMatthew G. Knepley   PetscValidPointer(dim, 2);
3869c73cfb54SMatthew G. Knepley   *dim = dm->dim;
3870c73cfb54SMatthew G. Knepley   PetscFunctionReturn(0);
3871c73cfb54SMatthew G. Knepley }
3872c73cfb54SMatthew G. Knepley 
3873c73cfb54SMatthew G. Knepley /*@
3874c73cfb54SMatthew G. Knepley   DMSetDimension - Set the topological dimension of the DM
3875c73cfb54SMatthew G. Knepley 
3876c73cfb54SMatthew G. Knepley   Collective on dm
3877c73cfb54SMatthew G. Knepley 
3878c73cfb54SMatthew G. Knepley   Input Parameters:
3879c73cfb54SMatthew G. Knepley + dm - The DM
3880c73cfb54SMatthew G. Knepley - dim - The topological dimension
3881c73cfb54SMatthew G. Knepley 
3882c73cfb54SMatthew G. Knepley   Level: beginner
3883c73cfb54SMatthew G. Knepley 
3884c73cfb54SMatthew G. Knepley .seealso: DMGetDimension(), DMCreate()
3885c73cfb54SMatthew G. Knepley @*/
3886c73cfb54SMatthew G. Knepley PetscErrorCode DMSetDimension(DM dm, PetscInt dim)
3887c73cfb54SMatthew G. Knepley {
3888c73cfb54SMatthew G. Knepley   PetscFunctionBegin;
3889c73cfb54SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
3890c73cfb54SMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, dim, 2);
3891c73cfb54SMatthew G. Knepley   dm->dim = dim;
3892c73cfb54SMatthew G. Knepley   PetscFunctionReturn(0);
3893c73cfb54SMatthew G. Knepley }
3894c73cfb54SMatthew G. Knepley 
3895793f3fe5SMatthew G. Knepley /*@
3896793f3fe5SMatthew G. Knepley   DMGetDimPoints - Get the half-open interval for all points of a given dimension
3897793f3fe5SMatthew G. Knepley 
3898793f3fe5SMatthew G. Knepley   Collective on DM
3899793f3fe5SMatthew G. Knepley 
3900793f3fe5SMatthew G. Knepley   Input Parameters:
3901793f3fe5SMatthew G. Knepley + dm - the DM
3902793f3fe5SMatthew G. Knepley - dim - the dimension
3903793f3fe5SMatthew G. Knepley 
3904793f3fe5SMatthew G. Knepley   Output Parameters:
3905793f3fe5SMatthew G. Knepley + pStart - The first point of the given dimension
3906793f3fe5SMatthew G. Knepley . pEnd - The first point following points of the given dimension
3907793f3fe5SMatthew G. Knepley 
3908793f3fe5SMatthew G. Knepley   Note:
3909793f3fe5SMatthew G. Knepley   The points are vertices in the Hasse diagram encoding the topology. This is explained in
3910793f3fe5SMatthew G. Knepley   http://arxiv.org/abs/0908.4427. If not points exist of this dimension in the storage scheme,
3911793f3fe5SMatthew G. Knepley   then the interval is empty.
3912793f3fe5SMatthew G. Knepley 
3913793f3fe5SMatthew G. Knepley   Level: intermediate
3914793f3fe5SMatthew G. Knepley 
3915793f3fe5SMatthew G. Knepley .keywords: point, Hasse Diagram, dimension
3916793f3fe5SMatthew G. Knepley .seealso: DMPLEX, DMPlexGetDepthStratum(), DMPlexGetHeightStratum()
3917793f3fe5SMatthew G. Knepley @*/
3918793f3fe5SMatthew G. Knepley PetscErrorCode DMGetDimPoints(DM dm, PetscInt dim, PetscInt *pStart, PetscInt *pEnd)
3919793f3fe5SMatthew G. Knepley {
3920793f3fe5SMatthew G. Knepley   PetscInt       d;
3921793f3fe5SMatthew G. Knepley   PetscErrorCode ierr;
3922793f3fe5SMatthew G. Knepley 
3923793f3fe5SMatthew G. Knepley   PetscFunctionBegin;
3924793f3fe5SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3925793f3fe5SMatthew G. Knepley   ierr = DMGetDimension(dm, &d);CHKERRQ(ierr);
3926793f3fe5SMatthew G. Knepley   if ((dim < 0) || (dim > d)) SETERRQ2(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid dimension %d 1", dim, d);
3927793f3fe5SMatthew G. Knepley   ierr = (*dm->ops->getdimpoints)(dm, dim, pStart, pEnd);CHKERRQ(ierr);
3928793f3fe5SMatthew G. Knepley   PetscFunctionReturn(0);
3929793f3fe5SMatthew G. Knepley }
3930793f3fe5SMatthew G. Knepley 
39316636e97aSMatthew G Knepley /*@
39326636e97aSMatthew G Knepley   DMSetCoordinates - Sets into the DM a global vector that holds the coordinates
39336636e97aSMatthew G Knepley 
39346636e97aSMatthew G Knepley   Collective on DM
39356636e97aSMatthew G Knepley 
39366636e97aSMatthew G Knepley   Input Parameters:
39376636e97aSMatthew G Knepley + dm - the DM
39386636e97aSMatthew G Knepley - c - coordinate vector
39396636e97aSMatthew G Knepley 
39406636e97aSMatthew G Knepley   Note:
39416636e97aSMatthew G Knepley   The coordinates do include those for ghost points, which are in the local vector
39426636e97aSMatthew G Knepley 
39436636e97aSMatthew G Knepley   Level: intermediate
39446636e97aSMatthew G Knepley 
39456636e97aSMatthew G Knepley .keywords: distributed array, get, corners, nodes, local indices, coordinates
39466636e97aSMatthew G Knepley .seealso: DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLoca(), DMGetCoordinateDM()
39476636e97aSMatthew G Knepley @*/
39486636e97aSMatthew G Knepley PetscErrorCode DMSetCoordinates(DM dm, Vec c)
39496636e97aSMatthew G Knepley {
39506636e97aSMatthew G Knepley   PetscErrorCode ierr;
39516636e97aSMatthew G Knepley 
39526636e97aSMatthew G Knepley   PetscFunctionBegin;
39536636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
39546636e97aSMatthew G Knepley   PetscValidHeaderSpecific(c,VEC_CLASSID,2);
39556636e97aSMatthew G Knepley   ierr            = PetscObjectReference((PetscObject) c);CHKERRQ(ierr);
39566636e97aSMatthew G Knepley   ierr            = VecDestroy(&dm->coordinates);CHKERRQ(ierr);
39576636e97aSMatthew G Knepley   dm->coordinates = c;
39586636e97aSMatthew G Knepley   ierr            = VecDestroy(&dm->coordinatesLocal);CHKERRQ(ierr);
3959b64e0483SPeter Brune   ierr            = DMCoarsenHookAdd(dm,DMRestrictHook_Coordinates,NULL,NULL);CHKERRQ(ierr);
396003dadc2fSPeter Brune   ierr            = DMSubDomainHookAdd(dm,DMSubDomainHook_Coordinates,NULL,NULL);CHKERRQ(ierr);
39616636e97aSMatthew G Knepley   PetscFunctionReturn(0);
39626636e97aSMatthew G Knepley }
39636636e97aSMatthew G Knepley 
39646636e97aSMatthew G Knepley /*@
39656636e97aSMatthew G Knepley   DMSetCoordinatesLocal - Sets into the DM a local vector that holds the coordinates
39666636e97aSMatthew G Knepley 
39676636e97aSMatthew G Knepley   Collective on DM
39686636e97aSMatthew G Knepley 
39696636e97aSMatthew G Knepley    Input Parameters:
39706636e97aSMatthew G Knepley +  dm - the DM
39716636e97aSMatthew G Knepley -  c - coordinate vector
39726636e97aSMatthew G Knepley 
39736636e97aSMatthew G Knepley   Note:
39746636e97aSMatthew G Knepley   The coordinates of ghost points can be set using DMSetCoordinates()
39756636e97aSMatthew G Knepley   followed by DMGetCoordinatesLocal(). This is intended to enable the
39766636e97aSMatthew G Knepley   setting of ghost coordinates outside of the domain.
39776636e97aSMatthew G Knepley 
39786636e97aSMatthew G Knepley   Level: intermediate
39796636e97aSMatthew G Knepley 
39806636e97aSMatthew G Knepley .keywords: distributed array, get, corners, nodes, local indices, coordinates
39816636e97aSMatthew G Knepley .seealso: DMGetCoordinatesLocal(), DMSetCoordinates(), DMGetCoordinates(), DMGetCoordinateDM()
39826636e97aSMatthew G Knepley @*/
39836636e97aSMatthew G Knepley PetscErrorCode DMSetCoordinatesLocal(DM dm, Vec c)
39846636e97aSMatthew G Knepley {
39856636e97aSMatthew G Knepley   PetscErrorCode ierr;
39866636e97aSMatthew G Knepley 
39876636e97aSMatthew G Knepley   PetscFunctionBegin;
39886636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
39896636e97aSMatthew G Knepley   PetscValidHeaderSpecific(c,VEC_CLASSID,2);
39906636e97aSMatthew G Knepley   ierr = PetscObjectReference((PetscObject) c);CHKERRQ(ierr);
39916636e97aSMatthew G Knepley   ierr = VecDestroy(&dm->coordinatesLocal);CHKERRQ(ierr);
39928865f1eaSKarl Rupp 
39936636e97aSMatthew G Knepley   dm->coordinatesLocal = c;
39948865f1eaSKarl Rupp 
39956636e97aSMatthew G Knepley   ierr = VecDestroy(&dm->coordinates);CHKERRQ(ierr);
39966636e97aSMatthew G Knepley   PetscFunctionReturn(0);
39976636e97aSMatthew G Knepley }
39986636e97aSMatthew G Knepley 
39996636e97aSMatthew G Knepley /*@
40006636e97aSMatthew G Knepley   DMGetCoordinates - Gets a global vector with the coordinates associated with the DM.
40016636e97aSMatthew G Knepley 
40026636e97aSMatthew G Knepley   Not Collective
40036636e97aSMatthew G Knepley 
40046636e97aSMatthew G Knepley   Input Parameter:
40056636e97aSMatthew G Knepley . dm - the DM
40066636e97aSMatthew G Knepley 
40076636e97aSMatthew G Knepley   Output Parameter:
40086636e97aSMatthew G Knepley . c - global coordinate vector
40096636e97aSMatthew G Knepley 
40106636e97aSMatthew G Knepley   Note:
40116636e97aSMatthew G Knepley   This is a borrowed reference, so the user should NOT destroy this vector
40126636e97aSMatthew G Knepley 
40136636e97aSMatthew G Knepley   Each process has only the local coordinates (does NOT have the ghost coordinates).
40146636e97aSMatthew G Knepley 
40156636e97aSMatthew G Knepley   For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...)
40166636e97aSMatthew G Knepley   and (x_0,y_0,z_0,x_1,y_1,z_1...)
40176636e97aSMatthew G Knepley 
40186636e97aSMatthew G Knepley   Level: intermediate
40196636e97aSMatthew G Knepley 
40206636e97aSMatthew G Knepley .keywords: distributed array, get, corners, nodes, local indices, coordinates
40216636e97aSMatthew G Knepley .seealso: DMSetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM()
40226636e97aSMatthew G Knepley @*/
40236636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinates(DM dm, Vec *c)
40246636e97aSMatthew G Knepley {
40256636e97aSMatthew G Knepley   PetscErrorCode ierr;
40266636e97aSMatthew G Knepley 
40276636e97aSMatthew G Knepley   PetscFunctionBegin;
40286636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
40296636e97aSMatthew G Knepley   PetscValidPointer(c,2);
40301f588964SMatthew G Knepley   if (!dm->coordinates && dm->coordinatesLocal) {
40310298fd71SBarry Smith     DM cdm = NULL;
40326636e97aSMatthew G Knepley 
40336636e97aSMatthew G Knepley     ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
40346636e97aSMatthew G Knepley     ierr = DMCreateGlobalVector(cdm, &dm->coordinates);CHKERRQ(ierr);
40356636e97aSMatthew G Knepley     ierr = PetscObjectSetName((PetscObject) dm->coordinates, "coordinates");CHKERRQ(ierr);
40366636e97aSMatthew G Knepley     ierr = DMLocalToGlobalBegin(cdm, dm->coordinatesLocal, INSERT_VALUES, dm->coordinates);CHKERRQ(ierr);
40376636e97aSMatthew G Knepley     ierr = DMLocalToGlobalEnd(cdm, dm->coordinatesLocal, INSERT_VALUES, dm->coordinates);CHKERRQ(ierr);
40386636e97aSMatthew G Knepley   }
40396636e97aSMatthew G Knepley   *c = dm->coordinates;
40406636e97aSMatthew G Knepley   PetscFunctionReturn(0);
40416636e97aSMatthew G Knepley }
40426636e97aSMatthew G Knepley 
40436636e97aSMatthew G Knepley /*@
40446636e97aSMatthew G Knepley   DMGetCoordinatesLocal - Gets a local vector with the coordinates associated with the DM.
40456636e97aSMatthew G Knepley 
40466636e97aSMatthew G Knepley   Collective on DM
40476636e97aSMatthew G Knepley 
40486636e97aSMatthew G Knepley   Input Parameter:
40496636e97aSMatthew G Knepley . dm - the DM
40506636e97aSMatthew G Knepley 
40516636e97aSMatthew G Knepley   Output Parameter:
40526636e97aSMatthew G Knepley . c - coordinate vector
40536636e97aSMatthew G Knepley 
40546636e97aSMatthew G Knepley   Note:
40556636e97aSMatthew G Knepley   This is a borrowed reference, so the user should NOT destroy this vector
40566636e97aSMatthew G Knepley 
40576636e97aSMatthew G Knepley   Each process has the local and ghost coordinates
40586636e97aSMatthew G Knepley 
40596636e97aSMatthew G Knepley   For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...)
40606636e97aSMatthew G Knepley   and (x_0,y_0,z_0,x_1,y_1,z_1...)
40616636e97aSMatthew G Knepley 
40626636e97aSMatthew G Knepley   Level: intermediate
40636636e97aSMatthew G Knepley 
40646636e97aSMatthew G Knepley .keywords: distributed array, get, corners, nodes, local indices, coordinates
40656636e97aSMatthew G Knepley .seealso: DMSetCoordinatesLocal(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM()
40666636e97aSMatthew G Knepley @*/
40676636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinatesLocal(DM dm, Vec *c)
40686636e97aSMatthew G Knepley {
40696636e97aSMatthew G Knepley   PetscErrorCode ierr;
40706636e97aSMatthew G Knepley 
40716636e97aSMatthew G Knepley   PetscFunctionBegin;
40726636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
40736636e97aSMatthew G Knepley   PetscValidPointer(c,2);
40741f588964SMatthew G Knepley   if (!dm->coordinatesLocal && dm->coordinates) {
40750298fd71SBarry Smith     DM cdm = NULL;
40766636e97aSMatthew G Knepley 
40776636e97aSMatthew G Knepley     ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
40786636e97aSMatthew G Knepley     ierr = DMCreateLocalVector(cdm, &dm->coordinatesLocal);CHKERRQ(ierr);
40796636e97aSMatthew G Knepley     ierr = PetscObjectSetName((PetscObject) dm->coordinatesLocal, "coordinates");CHKERRQ(ierr);
40806636e97aSMatthew G Knepley     ierr = DMGlobalToLocalBegin(cdm, dm->coordinates, INSERT_VALUES, dm->coordinatesLocal);CHKERRQ(ierr);
40816636e97aSMatthew G Knepley     ierr = DMGlobalToLocalEnd(cdm, dm->coordinates, INSERT_VALUES, dm->coordinatesLocal);CHKERRQ(ierr);
40826636e97aSMatthew G Knepley   }
40836636e97aSMatthew G Knepley   *c = dm->coordinatesLocal;
40846636e97aSMatthew G Knepley   PetscFunctionReturn(0);
40856636e97aSMatthew G Knepley }
40866636e97aSMatthew G Knepley 
40876636e97aSMatthew G Knepley /*@
40881cfe2091SMatthew G. Knepley   DMGetCoordinateDM - Gets the DM that prescribes coordinate layout and scatters between global and local coordinates
40896636e97aSMatthew G Knepley 
40906636e97aSMatthew G Knepley   Collective on DM
40916636e97aSMatthew G Knepley 
40926636e97aSMatthew G Knepley   Input Parameter:
40936636e97aSMatthew G Knepley . dm - the DM
40946636e97aSMatthew G Knepley 
40956636e97aSMatthew G Knepley   Output Parameter:
40966636e97aSMatthew G Knepley . cdm - coordinate DM
40976636e97aSMatthew G Knepley 
40986636e97aSMatthew G Knepley   Level: intermediate
40996636e97aSMatthew G Knepley 
41006636e97aSMatthew G Knepley .keywords: distributed array, get, corners, nodes, local indices, coordinates
41011cfe2091SMatthew G. Knepley .seealso: DMSetCoordinateDM(), DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal()
41026636e97aSMatthew G Knepley @*/
41036636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinateDM(DM dm, DM *cdm)
41046636e97aSMatthew G Knepley {
41056636e97aSMatthew G Knepley   PetscErrorCode ierr;
41066636e97aSMatthew G Knepley 
41076636e97aSMatthew G Knepley   PetscFunctionBegin;
41086636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
41096636e97aSMatthew G Knepley   PetscValidPointer(cdm,2);
41106636e97aSMatthew G Knepley   if (!dm->coordinateDM) {
411182f516ccSBarry Smith     if (!dm->ops->createcoordinatedm) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Unable to create coordinates for this DM");
41126636e97aSMatthew G Knepley     ierr = (*dm->ops->createcoordinatedm)(dm, &dm->coordinateDM);CHKERRQ(ierr);
41136636e97aSMatthew G Knepley   }
41146636e97aSMatthew G Knepley   *cdm = dm->coordinateDM;
41156636e97aSMatthew G Knepley   PetscFunctionReturn(0);
41166636e97aSMatthew G Knepley }
4117e87bb0d3SMatthew G Knepley 
41181cfe2091SMatthew G. Knepley /*@
41191cfe2091SMatthew G. Knepley   DMSetCoordinateDM - Sets the DM that prescribes coordinate layout and scatters between global and local coordinates
41201cfe2091SMatthew G. Knepley 
41211cfe2091SMatthew G. Knepley   Logically Collective on DM
41221cfe2091SMatthew G. Knepley 
41231cfe2091SMatthew G. Knepley   Input Parameters:
41241cfe2091SMatthew G. Knepley + dm - the DM
41251cfe2091SMatthew G. Knepley - cdm - coordinate DM
41261cfe2091SMatthew G. Knepley 
41271cfe2091SMatthew G. Knepley   Level: intermediate
41281cfe2091SMatthew G. Knepley 
41291cfe2091SMatthew G. Knepley .keywords: distributed array, get, corners, nodes, local indices, coordinates
41301cfe2091SMatthew G. Knepley .seealso: DMGetCoordinateDM(), DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal()
41311cfe2091SMatthew G. Knepley @*/
41321cfe2091SMatthew G. Knepley PetscErrorCode DMSetCoordinateDM(DM dm, DM cdm)
41331cfe2091SMatthew G. Knepley {
41341cfe2091SMatthew G. Knepley   PetscErrorCode ierr;
41351cfe2091SMatthew G. Knepley 
41361cfe2091SMatthew G. Knepley   PetscFunctionBegin;
41371cfe2091SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
41381cfe2091SMatthew G. Knepley   PetscValidHeaderSpecific(cdm,DM_CLASSID,2);
4139f26b38b9SToby Isaac   ierr = PetscObjectReference((PetscObject)cdm);CHKERRQ(ierr);
41401cfe2091SMatthew G. Knepley   ierr = DMDestroy(&dm->coordinateDM);CHKERRQ(ierr);
41411cfe2091SMatthew G. Knepley   dm->coordinateDM = cdm;
41421cfe2091SMatthew G. Knepley   PetscFunctionReturn(0);
41431cfe2091SMatthew G. Knepley }
41441cfe2091SMatthew G. Knepley 
414546e270d4SMatthew G. Knepley /*@
414646e270d4SMatthew G. Knepley   DMGetCoordinateDim - Retrieve the dimension of embedding space for coordinate values.
414746e270d4SMatthew G. Knepley 
414846e270d4SMatthew G. Knepley   Not Collective
414946e270d4SMatthew G. Knepley 
415046e270d4SMatthew G. Knepley   Input Parameter:
415146e270d4SMatthew G. Knepley . dm - The DM object
415246e270d4SMatthew G. Knepley 
415346e270d4SMatthew G. Knepley   Output Parameter:
415446e270d4SMatthew G. Knepley . dim - The embedding dimension
415546e270d4SMatthew G. Knepley 
415646e270d4SMatthew G. Knepley   Level: intermediate
415746e270d4SMatthew G. Knepley 
415846e270d4SMatthew G. Knepley .keywords: mesh, coordinates
415946e270d4SMatthew G. Knepley .seealso: DMSetCoordinateDim(), DMGetCoordinateSection(), DMGetCoordinateDM(), DMGetDefaultSection(), DMSetDefaultSection()
416046e270d4SMatthew G. Knepley @*/
416146e270d4SMatthew G. Knepley PetscErrorCode DMGetCoordinateDim(DM dm, PetscInt *dim)
416246e270d4SMatthew G. Knepley {
416346e270d4SMatthew G. Knepley   PetscFunctionBegin;
416446e270d4SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
416546e270d4SMatthew G. Knepley   PetscValidPointer(dim, 2);
41669a9a41abSToby Isaac   if (dm->dimEmbed == PETSC_DEFAULT) {
41679a9a41abSToby Isaac     dm->dimEmbed = dm->dim;
41689a9a41abSToby Isaac   }
416946e270d4SMatthew G. Knepley   *dim = dm->dimEmbed;
417046e270d4SMatthew G. Knepley   PetscFunctionReturn(0);
417146e270d4SMatthew G. Knepley }
417246e270d4SMatthew G. Knepley 
417346e270d4SMatthew G. Knepley /*@
417446e270d4SMatthew G. Knepley   DMSetCoordinateDim - Set the dimension of the embedding space for coordinate values.
417546e270d4SMatthew G. Knepley 
417646e270d4SMatthew G. Knepley   Not Collective
417746e270d4SMatthew G. Knepley 
417846e270d4SMatthew G. Knepley   Input Parameters:
417946e270d4SMatthew G. Knepley + dm  - The DM object
418046e270d4SMatthew G. Knepley - dim - The embedding dimension
418146e270d4SMatthew G. Knepley 
418246e270d4SMatthew G. Knepley   Level: intermediate
418346e270d4SMatthew G. Knepley 
418446e270d4SMatthew G. Knepley .keywords: mesh, coordinates
418546e270d4SMatthew G. Knepley .seealso: DMGetCoordinateDim(), DMSetCoordinateSection(), DMGetCoordinateSection(), DMGetDefaultSection(), DMSetDefaultSection()
418646e270d4SMatthew G. Knepley @*/
418746e270d4SMatthew G. Knepley PetscErrorCode DMSetCoordinateDim(DM dm, PetscInt dim)
418846e270d4SMatthew G. Knepley {
418946e270d4SMatthew G. Knepley   PetscFunctionBegin;
419046e270d4SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
419146e270d4SMatthew G. Knepley   dm->dimEmbed = dim;
419246e270d4SMatthew G. Knepley   PetscFunctionReturn(0);
419346e270d4SMatthew G. Knepley }
419446e270d4SMatthew G. Knepley 
4195e8abe2deSMatthew G. Knepley /*@
4196e8abe2deSMatthew G. Knepley   DMGetCoordinateSection - Retrieve the layout of coordinate values over the mesh.
4197e8abe2deSMatthew G. Knepley 
4198e8abe2deSMatthew G. Knepley   Not Collective
4199e8abe2deSMatthew G. Knepley 
4200e8abe2deSMatthew G. Knepley   Input Parameter:
4201e8abe2deSMatthew G. Knepley . dm - The DM object
4202e8abe2deSMatthew G. Knepley 
4203e8abe2deSMatthew G. Knepley   Output Parameter:
4204e8abe2deSMatthew G. Knepley . section - The PetscSection object
4205e8abe2deSMatthew G. Knepley 
4206e8abe2deSMatthew G. Knepley   Level: intermediate
4207e8abe2deSMatthew G. Knepley 
4208e8abe2deSMatthew G. Knepley .keywords: mesh, coordinates
4209e8abe2deSMatthew G. Knepley .seealso: DMGetCoordinateDM(), DMGetDefaultSection(), DMSetDefaultSection()
4210e8abe2deSMatthew G. Knepley @*/
4211e8abe2deSMatthew G. Knepley PetscErrorCode DMGetCoordinateSection(DM dm, PetscSection *section)
4212e8abe2deSMatthew G. Knepley {
4213e8abe2deSMatthew G. Knepley   DM             cdm;
4214e8abe2deSMatthew G. Knepley   PetscErrorCode ierr;
4215e8abe2deSMatthew G. Knepley 
4216e8abe2deSMatthew G. Knepley   PetscFunctionBegin;
4217e8abe2deSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4218e8abe2deSMatthew G. Knepley   PetscValidPointer(section, 2);
4219e8abe2deSMatthew G. Knepley   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
4220e8abe2deSMatthew G. Knepley   ierr = DMGetDefaultSection(cdm, section);CHKERRQ(ierr);
4221e8abe2deSMatthew G. Knepley   PetscFunctionReturn(0);
4222e8abe2deSMatthew G. Knepley }
4223e8abe2deSMatthew G. Knepley 
4224e8abe2deSMatthew G. Knepley /*@
4225e8abe2deSMatthew G. Knepley   DMSetCoordinateSection - Set the layout of coordinate values over the mesh.
4226e8abe2deSMatthew G. Knepley 
4227e8abe2deSMatthew G. Knepley   Not Collective
4228e8abe2deSMatthew G. Knepley 
4229e8abe2deSMatthew G. Knepley   Input Parameters:
4230e8abe2deSMatthew G. Knepley + dm      - The DM object
423146e270d4SMatthew G. Knepley . dim     - The embedding dimension, or PETSC_DETERMINE
4232e8abe2deSMatthew G. Knepley - section - The PetscSection object
4233e8abe2deSMatthew G. Knepley 
4234e8abe2deSMatthew G. Knepley   Level: intermediate
4235e8abe2deSMatthew G. Knepley 
4236e8abe2deSMatthew G. Knepley .keywords: mesh, coordinates
4237e8abe2deSMatthew G. Knepley .seealso: DMGetCoordinateSection(), DMGetDefaultSection(), DMSetDefaultSection()
4238e8abe2deSMatthew G. Knepley @*/
423946e270d4SMatthew G. Knepley PetscErrorCode DMSetCoordinateSection(DM dm, PetscInt dim, PetscSection section)
4240e8abe2deSMatthew G. Knepley {
4241e8abe2deSMatthew G. Knepley   DM             cdm;
4242e8abe2deSMatthew G. Knepley   PetscErrorCode ierr;
4243e8abe2deSMatthew G. Knepley 
4244e8abe2deSMatthew G. Knepley   PetscFunctionBegin;
4245e8abe2deSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
424646e270d4SMatthew G. Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,3);
4247e8abe2deSMatthew G. Knepley   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
4248e8abe2deSMatthew G. Knepley   ierr = DMSetDefaultSection(cdm, section);CHKERRQ(ierr);
424946e270d4SMatthew G. Knepley   if (dim == PETSC_DETERMINE) {
425046e270d4SMatthew G. Knepley     PetscInt d = dim;
425146e270d4SMatthew G. Knepley     PetscInt pStart, pEnd, vStart, vEnd, v, dd;
425246e270d4SMatthew G. Knepley 
425346e270d4SMatthew G. Knepley     ierr = PetscSectionGetChart(section, &pStart, &pEnd);CHKERRQ(ierr);
425446e270d4SMatthew G. Knepley     ierr = DMGetDimPoints(dm, 0, &vStart, &vEnd);CHKERRQ(ierr);
425546e270d4SMatthew G. Knepley     pStart = PetscMax(vStart, pStart);
425646e270d4SMatthew G. Knepley     pEnd   = PetscMin(vEnd, pEnd);
425746e270d4SMatthew G. Knepley     for (v = pStart; v < pEnd; ++v) {
425846e270d4SMatthew G. Knepley       ierr = PetscSectionGetDof(section, v, &dd);CHKERRQ(ierr);
425946e270d4SMatthew G. Knepley       if (dd) {d = dd; break;}
426046e270d4SMatthew G. Knepley     }
42616be882deSMatthew G. Knepley     if (d < 0) d = PETSC_DEFAULT;
426246e270d4SMatthew G. Knepley     ierr = DMSetCoordinateDim(dm, d);CHKERRQ(ierr);
426346e270d4SMatthew G. Knepley   }
4264e8abe2deSMatthew G. Knepley   PetscFunctionReturn(0);
4265e8abe2deSMatthew G. Knepley }
4266e8abe2deSMatthew G. Knepley 
42675dc8c3f7SMatthew G. Knepley /*@C
42685dc8c3f7SMatthew G. Knepley   DMSetPeriodicity - Set the description of mesh periodicity
42695dc8c3f7SMatthew G. Knepley 
42705dc8c3f7SMatthew G. Knepley   Input Parameters:
42715dc8c3f7SMatthew G. Knepley + dm      - The DM object
42725dc8c3f7SMatthew 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
42735dc8c3f7SMatthew G. Knepley . L       - If we assume the mesh is a torus, this is the length of each coordinate
42745dc8c3f7SMatthew G. Knepley - bd      - This describes the type of periodicity in each topological dimension
42755dc8c3f7SMatthew G. Knepley 
42765dc8c3f7SMatthew G. Knepley   Level: developer
42775dc8c3f7SMatthew G. Knepley 
42785dc8c3f7SMatthew G. Knepley .seealso: DMGetPeriodicity()
42795dc8c3f7SMatthew G. Knepley @*/
42805dc8c3f7SMatthew G. Knepley PetscErrorCode DMGetPeriodicity(DM dm, const PetscReal **maxCell, const PetscReal **L, const DMBoundaryType **bd)
4281c6b900c6SMatthew G. Knepley {
4282c6b900c6SMatthew G. Knepley   PetscFunctionBegin;
4283c6b900c6SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
4284c6b900c6SMatthew G. Knepley   if (L)       *L       = dm->L;
4285c6b900c6SMatthew G. Knepley   if (maxCell) *maxCell = dm->maxCell;
42865dc8c3f7SMatthew G. Knepley   if (bd)      *bd      = dm->bdtype;
4287c6b900c6SMatthew G. Knepley   PetscFunctionReturn(0);
4288c6b900c6SMatthew G. Knepley }
4289c6b900c6SMatthew G. Knepley 
42905dc8c3f7SMatthew G. Knepley /*@C
42915dc8c3f7SMatthew G. Knepley   DMSetPeriodicity - Set the description of mesh periodicity
42925dc8c3f7SMatthew G. Knepley 
42935dc8c3f7SMatthew G. Knepley   Input Parameters:
42945dc8c3f7SMatthew G. Knepley + dm      - The DM object
42955dc8c3f7SMatthew 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
42965dc8c3f7SMatthew G. Knepley . L       - If we assume the mesh is a torus, this is the length of each coordinate
42975dc8c3f7SMatthew G. Knepley - bd      - This describes the type of periodicity in each topological dimension
42985dc8c3f7SMatthew G. Knepley 
42995dc8c3f7SMatthew G. Knepley   Level: developer
43005dc8c3f7SMatthew G. Knepley 
43015dc8c3f7SMatthew G. Knepley .seealso: DMGetPeriodicity()
43025dc8c3f7SMatthew G. Knepley @*/
43035dc8c3f7SMatthew G. Knepley PetscErrorCode DMSetPeriodicity(DM dm, const PetscReal maxCell[], const PetscReal L[], const DMBoundaryType bd[])
4304c6b900c6SMatthew G. Knepley {
4305c6b900c6SMatthew G. Knepley   PetscInt       dim, d;
4306c6b900c6SMatthew G. Knepley   PetscErrorCode ierr;
4307c6b900c6SMatthew G. Knepley 
4308c6b900c6SMatthew G. Knepley   PetscFunctionBegin;
4309c6b900c6SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
43105dc8c3f7SMatthew G. Knepley   PetscValidPointer(L,3);PetscValidPointer(maxCell,2);PetscValidPointer(bd,4);
43115dc8c3f7SMatthew G. Knepley   ierr = PetscFree3(dm->L,dm->maxCell,dm->bdtype);CHKERRQ(ierr);
43125dc8c3f7SMatthew G. Knepley   ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr);
43135dc8c3f7SMatthew G. Knepley   ierr = PetscMalloc3(dim,&dm->L,dim,&dm->maxCell,dim,&dm->bdtype);CHKERRQ(ierr);
43145dc8c3f7SMatthew G. Knepley   for (d = 0; d < dim; ++d) {dm->L[d] = L[d]; dm->maxCell[d] = maxCell[d]; dm->bdtype[d] = bd[d];}
4315c6b900c6SMatthew G. Knepley   PetscFunctionReturn(0);
4316c6b900c6SMatthew G. Knepley }
4317c6b900c6SMatthew G. Knepley 
43182e17dfb7SMatthew G. Knepley /*@
43192e17dfb7SMatthew 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.
43202e17dfb7SMatthew G. Knepley 
43212e17dfb7SMatthew G. Knepley   Input Parameters:
43222e17dfb7SMatthew G. Knepley + dm     - The DM
43232e17dfb7SMatthew G. Knepley - in     - The input coordinate point (dim numbers)
43242e17dfb7SMatthew G. Knepley 
43252e17dfb7SMatthew G. Knepley   Output Parameter:
43262e17dfb7SMatthew G. Knepley . out - The localized coordinate point
43272e17dfb7SMatthew G. Knepley 
43282e17dfb7SMatthew G. Knepley   Level: developer
43292e17dfb7SMatthew G. Knepley 
43302e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeAddCoordinate()
43312e17dfb7SMatthew G. Knepley @*/
43322e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinate(DM dm, const PetscScalar in[], PetscScalar out[])
43332e17dfb7SMatthew G. Knepley {
43342e17dfb7SMatthew G. Knepley   PetscInt       dim, d;
43352e17dfb7SMatthew G. Knepley   PetscErrorCode ierr;
43362e17dfb7SMatthew G. Knepley 
43372e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
43382e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &dim);CHKERRQ(ierr);
43392e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
43402e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] = in[d];
43412e17dfb7SMatthew G. Knepley   } else {
43422e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) {
43432e17dfb7SMatthew G. Knepley       out[d] = in[d] - dm->L[d]*floor(PetscRealPart(in[d])/dm->L[d]);
43442e17dfb7SMatthew G. Knepley     }
43452e17dfb7SMatthew G. Knepley   }
43462e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
43472e17dfb7SMatthew G. Knepley }
43482e17dfb7SMatthew G. Knepley 
43492e17dfb7SMatthew G. Knepley /*
43502e17dfb7SMatthew 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.
43512e17dfb7SMatthew G. Knepley 
43522e17dfb7SMatthew G. Knepley   Input Parameters:
43532e17dfb7SMatthew G. Knepley + dm     - The DM
43542e17dfb7SMatthew G. Knepley . dim    - The spatial dimension
43552e17dfb7SMatthew G. Knepley . anchor - The anchor point, the input point can be no more than maxCell away from it
43562e17dfb7SMatthew G. Knepley - in     - The input coordinate point (dim numbers)
43572e17dfb7SMatthew G. Knepley 
43582e17dfb7SMatthew G. Knepley   Output Parameter:
43592e17dfb7SMatthew G. Knepley . out - The localized coordinate point
43602e17dfb7SMatthew G. Knepley 
43612e17dfb7SMatthew G. Knepley   Level: developer
43622e17dfb7SMatthew G. Knepley 
43632e17dfb7SMatthew 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
43642e17dfb7SMatthew G. Knepley 
43652e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeAddCoordinate()
43662e17dfb7SMatthew G. Knepley */
43672e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinate_Internal(DM dm, PetscInt dim, const PetscScalar anchor[], const PetscScalar in[], PetscScalar out[])
43682e17dfb7SMatthew G. Knepley {
43692e17dfb7SMatthew G. Knepley   PetscInt d;
43702e17dfb7SMatthew G. Knepley 
43712e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
43722e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
43732e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] = in[d];
43742e17dfb7SMatthew G. Knepley   } else {
43752e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) {
43762e17dfb7SMatthew G. Knepley       if (PetscAbsScalar(anchor[d] - in[d]) > dm->maxCell[d]) {
43772e17dfb7SMatthew G. Knepley         out[d] = PetscRealPart(anchor[d]) > PetscRealPart(in[d]) ? dm->L[d] + in[d] : in[d] - dm->L[d];
43782e17dfb7SMatthew G. Knepley       } else {
43792e17dfb7SMatthew G. Knepley         out[d] = in[d];
43802e17dfb7SMatthew G. Knepley       }
43812e17dfb7SMatthew G. Knepley     }
43822e17dfb7SMatthew G. Knepley   }
43832e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
43842e17dfb7SMatthew G. Knepley }
43852e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinateReal_Internal(DM dm, PetscInt dim, const PetscReal anchor[], const PetscReal in[], PetscReal out[])
43862e17dfb7SMatthew G. Knepley {
43872e17dfb7SMatthew G. Knepley   PetscInt d;
43882e17dfb7SMatthew G. Knepley 
43892e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
43902e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
43912e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] = in[d];
43922e17dfb7SMatthew G. Knepley   } else {
43932e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) {
43942e17dfb7SMatthew G. Knepley       if (PetscAbsReal(anchor[d] - in[d]) > dm->maxCell[d]) {
43952e17dfb7SMatthew G. Knepley         out[d] = anchor[d] > in[d] ? dm->L[d] + in[d] : in[d] - dm->L[d];
43962e17dfb7SMatthew G. Knepley       } else {
43972e17dfb7SMatthew G. Knepley         out[d] = in[d];
43982e17dfb7SMatthew G. Knepley       }
43992e17dfb7SMatthew G. Knepley     }
44002e17dfb7SMatthew G. Knepley   }
44012e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
44022e17dfb7SMatthew G. Knepley }
44032e17dfb7SMatthew G. Knepley 
44042e17dfb7SMatthew G. Knepley /*
44052e17dfb7SMatthew 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.
44062e17dfb7SMatthew G. Knepley 
44072e17dfb7SMatthew G. Knepley   Input Parameters:
44082e17dfb7SMatthew G. Knepley + dm     - The DM
44092e17dfb7SMatthew G. Knepley . dim    - The spatial dimension
44102e17dfb7SMatthew G. Knepley . anchor - The anchor point, the input point can be no more than maxCell away from it
44112e17dfb7SMatthew G. Knepley . in     - The input coordinate delta (dim numbers)
44122e17dfb7SMatthew G. Knepley - out    - The input coordinate point (dim numbers)
44132e17dfb7SMatthew G. Knepley 
44142e17dfb7SMatthew G. Knepley   Output Parameter:
44152e17dfb7SMatthew G. Knepley . out    - The localized coordinate in + out
44162e17dfb7SMatthew G. Knepley 
44172e17dfb7SMatthew G. Knepley   Level: developer
44182e17dfb7SMatthew G. Knepley 
44192e17dfb7SMatthew 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
44202e17dfb7SMatthew G. Knepley 
44212e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeCoordinate()
44222e17dfb7SMatthew G. Knepley */
44232e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeAddCoordinate_Internal(DM dm, PetscInt dim, const PetscScalar anchor[], const PetscScalar in[], PetscScalar out[])
44242e17dfb7SMatthew G. Knepley {
44252e17dfb7SMatthew G. Knepley   PetscInt d;
44262e17dfb7SMatthew G. Knepley 
44272e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
44282e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
44292e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] += in[d];
44302e17dfb7SMatthew G. Knepley   } else {
44312e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) {
44322e17dfb7SMatthew G. Knepley       if (PetscAbsScalar(anchor[d] - in[d]) > dm->maxCell[d]) {
44332e17dfb7SMatthew G. Knepley         out[d] += PetscRealPart(anchor[d]) > PetscRealPart(in[d]) ? dm->L[d] + in[d] : in[d] - dm->L[d];
44342e17dfb7SMatthew G. Knepley       } else {
44352e17dfb7SMatthew G. Knepley         out[d] += in[d];
44362e17dfb7SMatthew G. Knepley       }
44372e17dfb7SMatthew G. Knepley     }
44382e17dfb7SMatthew G. Knepley   }
44392e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
44402e17dfb7SMatthew G. Knepley }
44412e17dfb7SMatthew G. Knepley 
44422e17dfb7SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMPlexGetDepthStratum(DM, PetscInt, PetscInt *, PetscInt *);
44432e17dfb7SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMPlexGetHeightStratum(DM, PetscInt, PetscInt *, PetscInt *);
44442e17dfb7SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMPlexVecGetClosure(DM, PetscSection, Vec, PetscInt, PetscInt *, PetscScalar *[]);
44452e17dfb7SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMPlexVecRestoreClosure(DM, PetscSection, Vec, PetscInt, PetscInt *, PetscScalar *[]);
44462e17dfb7SMatthew G. Knepley 
444736447a5eSToby Isaac /*@
444836447a5eSToby Isaac   DMGetCoordinatesLocalized - Check if the DM coordinates have been localized for cells
444936447a5eSToby Isaac 
445036447a5eSToby Isaac   Input Parameter:
445136447a5eSToby Isaac . dm - The DM
445236447a5eSToby Isaac 
445336447a5eSToby Isaac   Output Parameter:
445436447a5eSToby Isaac   areLocalized - True if localized
445536447a5eSToby Isaac 
445636447a5eSToby Isaac   Level: developer
445736447a5eSToby Isaac 
445836447a5eSToby Isaac .seealso: DMLocalizeCoordinates()
445936447a5eSToby Isaac @*/
446036447a5eSToby Isaac PetscErrorCode DMGetCoordinatesLocalized(DM dm,PetscBool *areLocalized)
446136447a5eSToby Isaac {
446236447a5eSToby Isaac   DM             cdm;
446336447a5eSToby Isaac   PetscSection   coordSection;
446436447a5eSToby Isaac   PetscInt       cStart, cEnd, c, sStart, sEnd, dof;
446536447a5eSToby Isaac   PetscBool      alreadyLocalized, alreadyLocalizedGlobal;
446636447a5eSToby Isaac   PetscErrorCode ierr;
446736447a5eSToby Isaac 
446836447a5eSToby Isaac   PetscFunctionBegin;
446936447a5eSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
44708b09590cSToby Isaac   if (!dm->maxCell) {
44718b09590cSToby Isaac     *areLocalized = PETSC_FALSE;
44728b09590cSToby Isaac     PetscFunctionReturn(0);
44738b09590cSToby Isaac   }
447436447a5eSToby Isaac   /* We need some generic way of refering to cells/vertices */
447536447a5eSToby Isaac   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
447636447a5eSToby Isaac   {
447736447a5eSToby Isaac     PetscBool isplex;
447836447a5eSToby Isaac 
447936447a5eSToby Isaac     ierr = PetscObjectTypeCompare((PetscObject) cdm, DMPLEX, &isplex);CHKERRQ(ierr);
448036447a5eSToby Isaac     if (isplex) {
448136447a5eSToby Isaac       ierr = DMPlexGetHeightStratum(cdm, 0, &cStart, &cEnd);CHKERRQ(ierr);
448236447a5eSToby Isaac     } else SETERRQ(PetscObjectComm((PetscObject) cdm), PETSC_ERR_ARG_WRONG, "Coordinate localization requires a DMPLEX coordinate DM");
448336447a5eSToby Isaac   }
448436447a5eSToby Isaac   ierr = DMGetCoordinateSection(dm, &coordSection);CHKERRQ(ierr);
448536447a5eSToby Isaac   ierr = PetscSectionGetChart(coordSection,&sStart,&sEnd);CHKERRQ(ierr);
44865a42012cSToby Isaac   alreadyLocalized = alreadyLocalizedGlobal = PETSC_FALSE;
448736447a5eSToby Isaac   for (c = cStart; c < cEnd; ++c) {
448836447a5eSToby Isaac     if (c < sStart || c >= sEnd) {
448936447a5eSToby Isaac       alreadyLocalized = PETSC_FALSE;
449036447a5eSToby Isaac       break;
449136447a5eSToby Isaac     }
449236447a5eSToby Isaac     ierr = PetscSectionGetDof(coordSection, c, &dof);CHKERRQ(ierr);
44935a42012cSToby Isaac     if (dof) {
44945a42012cSToby Isaac       alreadyLocalized = PETSC_TRUE;
449536447a5eSToby Isaac       break;
449636447a5eSToby Isaac     }
449736447a5eSToby Isaac   }
44985a42012cSToby Isaac   ierr = MPI_Allreduce(&alreadyLocalized,&alreadyLocalizedGlobal,1,MPIU_BOOL,MPI_LOR,PetscObjectComm((PetscObject)dm));CHKERRQ(ierr);
449936447a5eSToby Isaac   *areLocalized = alreadyLocalizedGlobal;
450036447a5eSToby Isaac   PetscFunctionReturn(0);
450136447a5eSToby Isaac }
450236447a5eSToby Isaac 
450336447a5eSToby Isaac 
45042e17dfb7SMatthew G. Knepley /*@
45052e17dfb7SMatthew G. Knepley   DMLocalizeCoordinates - If a mesh is periodic, create local coordinates for each cell
45062e17dfb7SMatthew G. Knepley 
45072e17dfb7SMatthew G. Knepley   Input Parameter:
45082e17dfb7SMatthew G. Knepley . dm - The DM
45092e17dfb7SMatthew G. Knepley 
45102e17dfb7SMatthew G. Knepley   Level: developer
45112e17dfb7SMatthew G. Knepley 
45122e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinate(), DMLocalizeAddCoordinate()
45132e17dfb7SMatthew G. Knepley @*/
45142e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinates(DM dm)
45152e17dfb7SMatthew G. Knepley {
45162e17dfb7SMatthew G. Knepley   DM             cdm;
45172e17dfb7SMatthew G. Knepley   PetscSection   coordSection, cSection;
45182e17dfb7SMatthew G. Knepley   Vec            coordinates,  cVec;
45193e922f36SToby Isaac   PetscScalar   *coords, *coords2, *anchor, *localized;
45203e922f36SToby Isaac   PetscInt       Nc, vStart, vEnd, v, sStart, sEnd, newStart = PETSC_MAX_INT, newEnd = PETSC_MIN_INT, dof, d, off, off2, bs, coordSize;
4521e0ae35bbSToby Isaac   PetscBool      alreadyLocalized, alreadyLocalizedGlobal;
45223e922f36SToby Isaac   PetscInt       maxHeight = 0, h;
45233e922f36SToby Isaac   PetscInt       *pStart = NULL, *pEnd = NULL;
45242e17dfb7SMatthew G. Knepley   PetscErrorCode ierr;
45252e17dfb7SMatthew G. Knepley 
45262e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
45272e17dfb7SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
45282e17dfb7SMatthew G. Knepley   if (!dm->maxCell) PetscFunctionReturn(0);
45292e17dfb7SMatthew G. Knepley   /* We need some generic way of refering to cells/vertices */
45302e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
45312e17dfb7SMatthew G. Knepley   {
45322e17dfb7SMatthew G. Knepley     PetscBool isplex;
45332e17dfb7SMatthew G. Knepley 
45342e17dfb7SMatthew G. Knepley     ierr = PetscObjectTypeCompare((PetscObject) cdm, DMPLEX, &isplex);CHKERRQ(ierr);
45352e17dfb7SMatthew G. Knepley     if (isplex) {
45362e17dfb7SMatthew G. Knepley       ierr = DMPlexGetDepthStratum(cdm, 0, &vStart, &vEnd);CHKERRQ(ierr);
45373e922f36SToby Isaac       ierr = DMPlexGetMaxProjectionHeight(cdm,&maxHeight);CHKERRQ(ierr);
45383e922f36SToby Isaac       ierr = DMGetWorkArray(dm,2*(maxHeight + 1),PETSC_INT,&pStart);CHKERRQ(ierr);
45393e922f36SToby Isaac       pEnd = &pStart[maxHeight + 1];
45403e922f36SToby Isaac       newStart = vStart;
45413e922f36SToby Isaac       newEnd   = vEnd;
45423e922f36SToby Isaac       for (h = 0; h <= maxHeight; h++) {
45433e922f36SToby Isaac         ierr = DMPlexGetHeightStratum(cdm, h, &pStart[h], &pEnd[h]);CHKERRQ(ierr);
45443e922f36SToby Isaac         newStart = PetscMin(newStart,pStart[h]);
45453e922f36SToby Isaac         newEnd   = PetscMax(newEnd,pEnd[h]);
45463e922f36SToby Isaac       }
45472e17dfb7SMatthew G. Knepley     } else SETERRQ(PetscObjectComm((PetscObject) cdm), PETSC_ERR_ARG_WRONG, "Coordinate localization requires a DMPLEX coordinate DM");
45482e17dfb7SMatthew G. Knepley   }
45492e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinatesLocal(dm, &coordinates);CHKERRQ(ierr);
45502e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinateSection(dm, &coordSection);CHKERRQ(ierr);
45513e922f36SToby Isaac   ierr = VecGetBlockSize(coordinates, &bs);CHKERRQ(ierr);
4552e0ae35bbSToby Isaac   ierr = PetscSectionGetChart(coordSection,&sStart,&sEnd);CHKERRQ(ierr);
45533e922f36SToby Isaac 
45542e17dfb7SMatthew G. Knepley   ierr = PetscSectionCreate(PetscObjectComm((PetscObject) dm), &cSection);CHKERRQ(ierr);
45552e17dfb7SMatthew G. Knepley   ierr = PetscSectionSetNumFields(cSection, 1);CHKERRQ(ierr);
45562e17dfb7SMatthew G. Knepley   ierr = PetscSectionGetFieldComponents(coordSection, 0, &Nc);CHKERRQ(ierr);
45572e17dfb7SMatthew G. Knepley   ierr = PetscSectionSetFieldComponents(cSection, 0, Nc);CHKERRQ(ierr);
45583e922f36SToby Isaac   ierr = PetscSectionSetChart(cSection, newStart, newEnd);CHKERRQ(ierr);
45593e922f36SToby Isaac 
45603e922f36SToby Isaac   ierr = DMGetWorkArray(dm, 2 * bs, PETSC_SCALAR, &anchor);CHKERRQ(ierr);
45613e922f36SToby Isaac   localized = &anchor[bs];
45623e922f36SToby Isaac   alreadyLocalized = alreadyLocalizedGlobal = PETSC_TRUE;
45633e922f36SToby Isaac   for (h = 0; h <= maxHeight; h++) {
45643e922f36SToby Isaac     PetscInt cStart = pStart[h], cEnd = pEnd[h], c;
45653e922f36SToby Isaac 
45663e922f36SToby Isaac     for (c = cStart; c < cEnd; ++c) {
45673e922f36SToby Isaac       PetscScalar *cellCoords = NULL;
45683e922f36SToby Isaac       PetscInt     b;
45693e922f36SToby Isaac 
45703e922f36SToby Isaac       if (c < sStart || c >= sEnd) alreadyLocalized = PETSC_FALSE;
45713e922f36SToby Isaac       ierr = DMPlexVecGetClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
45723e922f36SToby Isaac       for (b = 0; b < bs; ++b) anchor[b] = cellCoords[b];
45733e922f36SToby Isaac       for (d = 0; d < dof/bs; ++d) {
45743e922f36SToby Isaac         ierr = DMLocalizeCoordinate_Internal(dm, bs, anchor, &cellCoords[d*bs], localized);CHKERRQ(ierr);
45753e922f36SToby Isaac         for (b = 0; b < bs; b++) {
45763e922f36SToby Isaac           if (cellCoords[d*bs + b] != localized[b]) break;
45773e922f36SToby Isaac         }
45783e922f36SToby Isaac         if (b < bs) break;
45793e922f36SToby Isaac       }
45803e922f36SToby Isaac       if (d < dof/bs) {
45813e922f36SToby Isaac         if (c >= sStart && c < sEnd) {
45823e922f36SToby Isaac           PetscInt cdof;
45833e922f36SToby Isaac 
45843e922f36SToby Isaac           ierr = PetscSectionGetDof(coordSection, c, &cdof);CHKERRQ(ierr);
45853e922f36SToby Isaac           if (cdof != dof) alreadyLocalized = PETSC_FALSE;
45863e922f36SToby Isaac         }
45873e922f36SToby Isaac         ierr = PetscSectionSetDof(cSection, c, dof);CHKERRQ(ierr);
45883e922f36SToby Isaac         ierr = PetscSectionSetFieldDof(cSection, c, 0, dof);CHKERRQ(ierr);
45893e922f36SToby Isaac       }
45903e922f36SToby Isaac       ierr = DMPlexVecRestoreClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
45913e922f36SToby Isaac     }
45923e922f36SToby Isaac   }
45933e922f36SToby Isaac   ierr = MPI_Allreduce(&alreadyLocalized,&alreadyLocalizedGlobal,1,MPIU_BOOL,MPI_LAND,PetscObjectComm((PetscObject)dm));CHKERRQ(ierr);
45943e922f36SToby Isaac   if (alreadyLocalizedGlobal) {
45953e922f36SToby Isaac     ierr = DMRestoreWorkArray(dm, 2 * bs, PETSC_SCALAR, &anchor);CHKERRQ(ierr);
45963e922f36SToby Isaac     ierr = PetscSectionDestroy(&cSection);CHKERRQ(ierr);
45973e922f36SToby Isaac     ierr = DMRestoreWorkArray(dm,2*(maxHeight + 1),PETSC_INT,&pStart);CHKERRQ(ierr);
45983e922f36SToby Isaac     PetscFunctionReturn(0);
45993e922f36SToby Isaac   }
46002e17dfb7SMatthew G. Knepley   for (v = vStart; v < vEnd; ++v) {
46012e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetDof(coordSection, v, &dof);CHKERRQ(ierr);
46022e17dfb7SMatthew G. Knepley     ierr = PetscSectionSetDof(cSection,     v,  dof);CHKERRQ(ierr);
46032e17dfb7SMatthew G. Knepley     ierr = PetscSectionSetFieldDof(cSection, v, 0, dof);CHKERRQ(ierr);
46042e17dfb7SMatthew G. Knepley   }
46052e17dfb7SMatthew G. Knepley   ierr = PetscSectionSetUp(cSection);CHKERRQ(ierr);
46062e17dfb7SMatthew G. Knepley   ierr = PetscSectionGetStorageSize(cSection, &coordSize);CHKERRQ(ierr);
4607c2be7e5eSLisandro Dalcin   ierr = VecCreate(PETSC_COMM_SELF, &cVec);CHKERRQ(ierr);
46082e17dfb7SMatthew G. Knepley   ierr = PetscObjectSetName((PetscObject)cVec,"coordinates");CHKERRQ(ierr);
46092e17dfb7SMatthew G. Knepley   ierr = VecSetBlockSize(cVec,         bs);CHKERRQ(ierr);
46102e17dfb7SMatthew G. Knepley   ierr = VecSetSizes(cVec, coordSize, PETSC_DETERMINE);CHKERRQ(ierr);
46112e17dfb7SMatthew G. Knepley   ierr = VecSetType(cVec, VECSTANDARD);CHKERRQ(ierr);
4612c2be7e5eSLisandro Dalcin   ierr = VecGetArrayRead(coordinates, (const PetscScalar**)&coords);CHKERRQ(ierr);
46132e17dfb7SMatthew G. Knepley   ierr = VecGetArray(cVec, &coords2);CHKERRQ(ierr);
46142e17dfb7SMatthew G. Knepley   for (v = vStart; v < vEnd; ++v) {
46152e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetDof(coordSection, v, &dof);CHKERRQ(ierr);
46162e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetOffset(coordSection, v, &off);CHKERRQ(ierr);
46172e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetOffset(cSection,     v, &off2);CHKERRQ(ierr);
46182e17dfb7SMatthew G. Knepley     for (d = 0; d < dof; ++d) coords2[off2+d] = coords[off+d];
46192e17dfb7SMatthew G. Knepley   }
46203e922f36SToby Isaac   for (h = 0; h <= maxHeight; h++) {
46213e922f36SToby Isaac     PetscInt cStart = pStart[h], cEnd = pEnd[h], c;
46223e922f36SToby Isaac 
46232e17dfb7SMatthew G. Knepley     for (c = cStart; c < cEnd; ++c) {
46242e17dfb7SMatthew G. Knepley       PetscScalar *cellCoords = NULL;
46253e922f36SToby Isaac       PetscInt     b, cdof;
46262e17dfb7SMatthew G. Knepley 
46273e922f36SToby Isaac       ierr = PetscSectionGetDof(cSection,c,&cdof);CHKERRQ(ierr);
46283e922f36SToby Isaac       if (!cdof) continue;
46292e17dfb7SMatthew G. Knepley       ierr = DMPlexVecGetClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
46302e17dfb7SMatthew G. Knepley       ierr = PetscSectionGetOffset(cSection, c, &off2);CHKERRQ(ierr);
46312e17dfb7SMatthew G. Knepley       for (b = 0; b < bs; ++b) anchor[b] = cellCoords[b];
46322e17dfb7SMatthew G. Knepley       for (d = 0; d < dof/bs; ++d) {ierr = DMLocalizeCoordinate_Internal(dm, bs, anchor, &cellCoords[d*bs], &coords2[off2+d*bs]);CHKERRQ(ierr);}
46332e17dfb7SMatthew G. Knepley       ierr = DMPlexVecRestoreClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
46342e17dfb7SMatthew G. Knepley     }
46353e922f36SToby Isaac   }
46363e922f36SToby Isaac   ierr = DMRestoreWorkArray(dm, 2 * bs, PETSC_SCALAR, &anchor);CHKERRQ(ierr);
46373e922f36SToby Isaac   ierr = DMRestoreWorkArray(dm,2*(maxHeight + 1),PETSC_INT,&pStart);CHKERRQ(ierr);
4638c2be7e5eSLisandro Dalcin   ierr = VecRestoreArrayRead(coordinates, (const PetscScalar**)&coords);CHKERRQ(ierr);
46392e17dfb7SMatthew G. Knepley   ierr = VecRestoreArray(cVec, &coords2);CHKERRQ(ierr);
46402e17dfb7SMatthew G. Knepley   ierr = DMSetCoordinateSection(dm, PETSC_DETERMINE, cSection);CHKERRQ(ierr);
46412e17dfb7SMatthew G. Knepley   ierr = DMSetCoordinatesLocal(dm, cVec);CHKERRQ(ierr);
46422e17dfb7SMatthew G. Knepley   ierr = VecDestroy(&cVec);CHKERRQ(ierr);
46432e17dfb7SMatthew G. Knepley   ierr = PetscSectionDestroy(&cSection);CHKERRQ(ierr);
46442e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
46452e17dfb7SMatthew G. Knepley }
46462e17dfb7SMatthew G. Knepley 
4647e87bb0d3SMatthew G Knepley /*@
46483a93e3b7SToby Isaac   DMLocatePoints - Locate the points in v in the mesh and return a PetscSF of the containing cells
4649e87bb0d3SMatthew G Knepley 
46503a93e3b7SToby Isaac   Collective on Vec v (see explanation below)
4651e87bb0d3SMatthew G Knepley 
4652e87bb0d3SMatthew G Knepley   Input Parameters:
4653e87bb0d3SMatthew G Knepley + dm - The DM
46543a93e3b7SToby Isaac . v - The Vec of points
465562a38674SMatthew G. Knepley . ltype - The type of point location, e.g. DM_POINTLOCATION_NONE or DM_POINTLOCATION_NEAREST
46563a93e3b7SToby Isaac - cells - Points to either NULL, or a PetscSF with guesses for which cells contain each point.
4657e87bb0d3SMatthew G Knepley 
465861e3bb9bSMatthew G Knepley   Output Parameter:
465962a38674SMatthew G. Knepley + v - The Vec of points, which now contains the nearest mesh points to the given points if DM_POINTLOCATION_NEAREST is used
466062a38674SMatthew G. Knepley - cells - The PetscSF containing the ranks and local indices of the containing points.
46613a93e3b7SToby Isaac 
4662e87bb0d3SMatthew G Knepley 
4663e87bb0d3SMatthew G Knepley   Level: developer
466461e3bb9bSMatthew G Knepley 
466562a38674SMatthew G. Knepley   Notes:
46663a93e3b7SToby Isaac   To do a search of the local cells of the mesh, v should have PETSC_COMM_SELF as its communicator.
466762a38674SMatthew G. Knepley   To do a search of all the cells in the distributed mesh, v should have the same communicator as dm.
46683a93e3b7SToby Isaac 
46693a93e3b7SToby Isaac   If *cellSF is NULL on input, a PetscSF will be created.
467062a38674SMatthew G. Knepley   If *cellSF is not NULL on input, it should point to an existing PetscSF, whose graph will be used as initial guesses.
46713a93e3b7SToby Isaac 
46723a93e3b7SToby Isaac   An array that maps each point to its containing cell can be obtained with
46733a93e3b7SToby Isaac 
467462a38674SMatthew G. Knepley $    const PetscSFNode *cells;
467562a38674SMatthew G. Knepley $    PetscInt           nFound;
467662a38674SMatthew G. Knepley $    const PetscSFNode *found;
467762a38674SMatthew G. Knepley $
467862a38674SMatthew G. Knepley $    PetscSFGetGraph(cells,NULL,&nFound,&found,&cells);
46793a93e3b7SToby Isaac 
46803a93e3b7SToby 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
46813a93e3b7SToby Isaac   the index of the cell in its rank's local numbering.
46823a93e3b7SToby Isaac 
468361e3bb9bSMatthew G Knepley .keywords: point location, mesh
468462a38674SMatthew G. Knepley .seealso: DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal(), DMPointLocationType
468561e3bb9bSMatthew G Knepley @*/
468662a38674SMatthew G. Knepley PetscErrorCode DMLocatePoints(DM dm, Vec v, DMPointLocationType ltype, PetscSF *cellSF)
4687e87bb0d3SMatthew G Knepley {
4688735aa83eSMatthew G Knepley   PetscErrorCode ierr;
4689735aa83eSMatthew G Knepley 
4690e87bb0d3SMatthew G Knepley   PetscFunctionBegin;
4691e87bb0d3SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
4692e87bb0d3SMatthew G Knepley   PetscValidHeaderSpecific(v,VEC_CLASSID,2);
4693e0fc9d1bSMatthew G. Knepley   PetscValidPointer(cellSF,4);
46943a93e3b7SToby Isaac   if (*cellSF) {
46953a93e3b7SToby Isaac     PetscMPIInt result;
46963a93e3b7SToby Isaac 
4697e0fc9d1bSMatthew G. Knepley     PetscValidHeaderSpecific(*cellSF,PETSCSF_CLASSID,4);
46983a93e3b7SToby Isaac     ierr = MPI_Comm_compare(PetscObjectComm((PetscObject)v),PetscObjectComm((PetscObject)cellSF),&result);CHKERRQ(ierr);
46993a93e3b7SToby 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");
4700e0fc9d1bSMatthew G. Knepley   } else {
47013a93e3b7SToby Isaac     ierr = PetscSFCreate(PetscObjectComm((PetscObject)v),cellSF);CHKERRQ(ierr);
47023a93e3b7SToby Isaac   }
470347a35634SPatrick Farrell   ierr = PetscLogEventBegin(DM_LocatePoints,dm,0,0,0);CHKERRQ(ierr);
4704735aa83eSMatthew G Knepley   if (dm->ops->locatepoints) {
470562a38674SMatthew G. Knepley     ierr = (*dm->ops->locatepoints)(dm,v,ltype,*cellSF);CHKERRQ(ierr);
470682f516ccSBarry Smith   } else SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Point location not available for this DM");
470747a35634SPatrick Farrell   ierr = PetscLogEventEnd(DM_LocatePoints,dm,0,0,0);CHKERRQ(ierr);
4708e87bb0d3SMatthew G Knepley   PetscFunctionReturn(0);
4709e87bb0d3SMatthew G Knepley }
471014f150ffSMatthew G. Knepley 
4711f4d763aaSMatthew G. Knepley /*@
4712f4d763aaSMatthew G. Knepley   DMGetOutputDM - Retrieve the DM associated with the layout for output
4713f4d763aaSMatthew G. Knepley 
4714f4d763aaSMatthew G. Knepley   Input Parameter:
4715f4d763aaSMatthew G. Knepley . dm - The original DM
4716f4d763aaSMatthew G. Knepley 
4717f4d763aaSMatthew G. Knepley   Output Parameter:
4718f4d763aaSMatthew G. Knepley . odm - The DM which provides the layout for output
4719f4d763aaSMatthew G. Knepley 
4720f4d763aaSMatthew G. Knepley   Level: intermediate
4721f4d763aaSMatthew G. Knepley 
4722f4d763aaSMatthew G. Knepley .seealso: VecView(), DMGetDefaultGlobalSection()
4723f4d763aaSMatthew G. Knepley @*/
472414f150ffSMatthew G. Knepley PetscErrorCode DMGetOutputDM(DM dm, DM *odm)
472514f150ffSMatthew G. Knepley {
4726c26acbdeSMatthew G. Knepley   PetscSection   section;
47272d4e4a49SMatthew G. Knepley   PetscBool      hasConstraints, ghasConstraints;
472814f150ffSMatthew G. Knepley   PetscErrorCode ierr;
472914f150ffSMatthew G. Knepley 
473014f150ffSMatthew G. Knepley   PetscFunctionBegin;
473114f150ffSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
473214f150ffSMatthew G. Knepley   PetscValidPointer(odm,2);
4733c26acbdeSMatthew G. Knepley   ierr = DMGetDefaultSection(dm, &section);CHKERRQ(ierr);
4734c26acbdeSMatthew G. Knepley   ierr = PetscSectionHasConstraints(section, &hasConstraints);CHKERRQ(ierr);
4735127fe6b9SMatthew G. Knepley   ierr = MPI_Allreduce(&hasConstraints, &ghasConstraints, 1, MPIU_BOOL, MPI_LOR, PetscObjectComm((PetscObject) dm));CHKERRQ(ierr);
47362d4e4a49SMatthew G. Knepley   if (!ghasConstraints) {
4737c26acbdeSMatthew G. Knepley     *odm = dm;
4738c26acbdeSMatthew G. Knepley     PetscFunctionReturn(0);
4739c26acbdeSMatthew G. Knepley   }
474014f150ffSMatthew G. Knepley   if (!dm->dmBC) {
47410305aff6SMatthew G. Knepley     PetscDS      ds;
4742c26acbdeSMatthew G. Knepley     PetscSection newSection, gsection;
474314f150ffSMatthew G. Knepley     PetscSF      sf;
474414f150ffSMatthew G. Knepley 
474514f150ffSMatthew G. Knepley     ierr = DMClone(dm, &dm->dmBC);CHKERRQ(ierr);
47460305aff6SMatthew G. Knepley     ierr = DMGetDS(dm, &ds);CHKERRQ(ierr);
47470305aff6SMatthew G. Knepley     ierr = DMSetDS(dm->dmBC, ds);CHKERRQ(ierr);
474814f150ffSMatthew G. Knepley     ierr = PetscSectionClone(section, &newSection);CHKERRQ(ierr);
474914f150ffSMatthew G. Knepley     ierr = DMSetDefaultSection(dm->dmBC, newSection);CHKERRQ(ierr);
475014f150ffSMatthew G. Knepley     ierr = PetscSectionDestroy(&newSection);CHKERRQ(ierr);
475114f150ffSMatthew G. Knepley     ierr = DMGetPointSF(dm->dmBC, &sf);CHKERRQ(ierr);
475215b58121SMatthew G. Knepley     ierr = PetscSectionCreateGlobalSection(section, sf, PETSC_TRUE, PETSC_FALSE, &gsection);CHKERRQ(ierr);
475314f150ffSMatthew G. Knepley     ierr = DMSetDefaultGlobalSection(dm->dmBC, gsection);CHKERRQ(ierr);
475414f150ffSMatthew G. Knepley     ierr = PetscSectionDestroy(&gsection);CHKERRQ(ierr);
475514f150ffSMatthew G. Knepley   }
475614f150ffSMatthew G. Knepley   *odm = dm->dmBC;
475714f150ffSMatthew G. Knepley   PetscFunctionReturn(0);
475814f150ffSMatthew G. Knepley }
4759f4d763aaSMatthew G. Knepley 
4760f4d763aaSMatthew G. Knepley /*@
4761cdb7a50dSMatthew G. Knepley   DMGetOutputSequenceNumber - Retrieve the sequence number/value for output
4762f4d763aaSMatthew G. Knepley 
4763f4d763aaSMatthew G. Knepley   Input Parameter:
4764f4d763aaSMatthew G. Knepley . dm - The original DM
4765f4d763aaSMatthew G. Knepley 
4766cdb7a50dSMatthew G. Knepley   Output Parameters:
4767cdb7a50dSMatthew G. Knepley + num - The output sequence number
4768cdb7a50dSMatthew G. Knepley - val - The output sequence value
4769f4d763aaSMatthew G. Knepley 
4770f4d763aaSMatthew G. Knepley   Level: intermediate
4771f4d763aaSMatthew G. Knepley 
4772f4d763aaSMatthew G. Knepley   Note: This is intended for output that should appear in sequence, for instance
4773f4d763aaSMatthew G. Knepley   a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system.
4774f4d763aaSMatthew G. Knepley 
4775f4d763aaSMatthew G. Knepley .seealso: VecView()
4776f4d763aaSMatthew G. Knepley @*/
4777cdb7a50dSMatthew G. Knepley PetscErrorCode DMGetOutputSequenceNumber(DM dm, PetscInt *num, PetscReal *val)
4778f4d763aaSMatthew G. Knepley {
4779f4d763aaSMatthew G. Knepley   PetscFunctionBegin;
4780f4d763aaSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
4781cdb7a50dSMatthew G. Knepley   if (num) {PetscValidPointer(num,2); *num = dm->outputSequenceNum;}
4782cdb7a50dSMatthew G. Knepley   if (val) {PetscValidPointer(val,3);*val = dm->outputSequenceVal;}
4783f4d763aaSMatthew G. Knepley   PetscFunctionReturn(0);
4784f4d763aaSMatthew G. Knepley }
4785f4d763aaSMatthew G. Knepley 
4786f4d763aaSMatthew G. Knepley /*@
4787cdb7a50dSMatthew G. Knepley   DMSetOutputSequenceNumber - Set the sequence number/value for output
4788f4d763aaSMatthew G. Knepley 
4789f4d763aaSMatthew G. Knepley   Input Parameters:
4790f4d763aaSMatthew G. Knepley + dm - The original DM
4791cdb7a50dSMatthew G. Knepley . num - The output sequence number
4792cdb7a50dSMatthew G. Knepley - val - The output sequence value
4793f4d763aaSMatthew G. Knepley 
4794f4d763aaSMatthew G. Knepley   Level: intermediate
4795f4d763aaSMatthew G. Knepley 
4796f4d763aaSMatthew G. Knepley   Note: This is intended for output that should appear in sequence, for instance
4797f4d763aaSMatthew G. Knepley   a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system.
4798f4d763aaSMatthew G. Knepley 
4799f4d763aaSMatthew G. Knepley .seealso: VecView()
4800f4d763aaSMatthew G. Knepley @*/
4801cdb7a50dSMatthew G. Knepley PetscErrorCode DMSetOutputSequenceNumber(DM dm, PetscInt num, PetscReal val)
4802f4d763aaSMatthew G. Knepley {
4803f4d763aaSMatthew G. Knepley   PetscFunctionBegin;
4804f4d763aaSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
4805f4d763aaSMatthew G. Knepley   dm->outputSequenceNum = num;
4806cdb7a50dSMatthew G. Knepley   dm->outputSequenceVal = val;
4807cdb7a50dSMatthew G. Knepley   PetscFunctionReturn(0);
4808cdb7a50dSMatthew G. Knepley }
4809cdb7a50dSMatthew G. Knepley 
4810cdb7a50dSMatthew G. Knepley /*@C
4811cdb7a50dSMatthew G. Knepley   DMOutputSequenceLoad - Retrieve the sequence value from a Viewer
4812cdb7a50dSMatthew G. Knepley 
4813cdb7a50dSMatthew G. Knepley   Input Parameters:
4814cdb7a50dSMatthew G. Knepley + dm   - The original DM
4815cdb7a50dSMatthew G. Knepley . name - The sequence name
4816cdb7a50dSMatthew G. Knepley - num  - The output sequence number
4817cdb7a50dSMatthew G. Knepley 
4818cdb7a50dSMatthew G. Knepley   Output Parameter:
4819cdb7a50dSMatthew G. Knepley . val  - The output sequence value
4820cdb7a50dSMatthew G. Knepley 
4821cdb7a50dSMatthew G. Knepley   Level: intermediate
4822cdb7a50dSMatthew G. Knepley 
4823cdb7a50dSMatthew G. Knepley   Note: This is intended for output that should appear in sequence, for instance
4824cdb7a50dSMatthew G. Knepley   a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system.
4825cdb7a50dSMatthew G. Knepley 
4826cdb7a50dSMatthew G. Knepley .seealso: DMGetOutputSequenceNumber(), DMSetOutputSequenceNumber(), VecView()
4827cdb7a50dSMatthew G. Knepley @*/
4828cdb7a50dSMatthew G. Knepley PetscErrorCode DMOutputSequenceLoad(DM dm, PetscViewer viewer, const char *name, PetscInt num, PetscReal *val)
4829cdb7a50dSMatthew G. Knepley {
4830cdb7a50dSMatthew G. Knepley   PetscBool      ishdf5;
4831cdb7a50dSMatthew G. Knepley   PetscErrorCode ierr;
4832cdb7a50dSMatthew G. Knepley 
4833cdb7a50dSMatthew G. Knepley   PetscFunctionBegin;
4834cdb7a50dSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
4835cdb7a50dSMatthew G. Knepley   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
4836cdb7a50dSMatthew G. Knepley   PetscValidPointer(val,4);
4837cdb7a50dSMatthew G. Knepley   ierr = PetscObjectTypeCompare((PetscObject) viewer, PETSCVIEWERHDF5, &ishdf5);CHKERRQ(ierr);
4838cdb7a50dSMatthew G. Knepley   if (ishdf5) {
4839cdb7a50dSMatthew G. Knepley #if defined(PETSC_HAVE_HDF5)
4840cdb7a50dSMatthew G. Knepley     PetscScalar value;
4841cdb7a50dSMatthew G. Knepley 
4842cdb7a50dSMatthew G. Knepley     ierr = DMSequenceLoad_HDF5(dm, name, num, &value, viewer);CHKERRQ(ierr);
48434aeb217fSMatthew G. Knepley     *val = PetscRealPart(value);
4844cdb7a50dSMatthew G. Knepley #endif
4845cdb7a50dSMatthew G. Knepley   } else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Invalid viewer; open viewer with PetscViewerHDF5Open()");
4846f4d763aaSMatthew G. Knepley   PetscFunctionReturn(0);
4847f4d763aaSMatthew G. Knepley }
48488e4ac7eaSMatthew G. Knepley 
48498e4ac7eaSMatthew G. Knepley /*@
48508e4ac7eaSMatthew G. Knepley   DMGetUseNatural - Get the flag for creating a mapping to the natural order on distribution
48518e4ac7eaSMatthew G. Knepley 
48528e4ac7eaSMatthew G. Knepley   Not collective
48538e4ac7eaSMatthew G. Knepley 
48548e4ac7eaSMatthew G. Knepley   Input Parameter:
48558e4ac7eaSMatthew G. Knepley . dm - The DM
48568e4ac7eaSMatthew G. Knepley 
48578e4ac7eaSMatthew G. Knepley   Output Parameter:
48588e4ac7eaSMatthew G. Knepley . useNatural - The flag to build the mapping to a natural order during distribution
48598e4ac7eaSMatthew G. Knepley 
48608e4ac7eaSMatthew G. Knepley   Level: beginner
48618e4ac7eaSMatthew G. Knepley 
48628e4ac7eaSMatthew G. Knepley .seealso: DMSetUseNatural(), DMCreate()
48638e4ac7eaSMatthew G. Knepley @*/
48648e4ac7eaSMatthew G. Knepley PetscErrorCode DMGetUseNatural(DM dm, PetscBool *useNatural)
48658e4ac7eaSMatthew G. Knepley {
48668e4ac7eaSMatthew G. Knepley   PetscFunctionBegin;
48678e4ac7eaSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
48688e4ac7eaSMatthew G. Knepley   PetscValidPointer(useNatural, 2);
48698e4ac7eaSMatthew G. Knepley   *useNatural = dm->useNatural;
48708e4ac7eaSMatthew G. Knepley   PetscFunctionReturn(0);
48718e4ac7eaSMatthew G. Knepley }
48728e4ac7eaSMatthew G. Knepley 
48738e4ac7eaSMatthew G. Knepley /*@
48748e4ac7eaSMatthew G. Knepley   DMSetUseNatural - Set the flag for creating a mapping to the natural order on distribution
48758e4ac7eaSMatthew G. Knepley 
48768e4ac7eaSMatthew G. Knepley   Collective on dm
48778e4ac7eaSMatthew G. Knepley 
48788e4ac7eaSMatthew G. Knepley   Input Parameters:
48798e4ac7eaSMatthew G. Knepley + dm - The DM
48808e4ac7eaSMatthew G. Knepley - useNatural - The flag to build the mapping to a natural order during distribution
48818e4ac7eaSMatthew G. Knepley 
48828e4ac7eaSMatthew G. Knepley   Level: beginner
48838e4ac7eaSMatthew G. Knepley 
48848e4ac7eaSMatthew G. Knepley .seealso: DMGetUseNatural(), DMCreate()
48858e4ac7eaSMatthew G. Knepley @*/
48868e4ac7eaSMatthew G. Knepley PetscErrorCode DMSetUseNatural(DM dm, PetscBool useNatural)
48878e4ac7eaSMatthew G. Knepley {
48888e4ac7eaSMatthew G. Knepley   PetscFunctionBegin;
48898e4ac7eaSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
48908e4ac7eaSMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, useNatural, 2);
48918e4ac7eaSMatthew G. Knepley   dm->useNatural = useNatural;
48928e4ac7eaSMatthew G. Knepley   PetscFunctionReturn(0);
48938e4ac7eaSMatthew G. Knepley }
4894c58f1c22SToby Isaac 
4895c58f1c22SToby Isaac 
4896c58f1c22SToby Isaac /*@C
4897c58f1c22SToby Isaac   DMCreateLabel - Create a label of the given name if it does not already exist
4898c58f1c22SToby Isaac 
4899c58f1c22SToby Isaac   Not Collective
4900c58f1c22SToby Isaac 
4901c58f1c22SToby Isaac   Input Parameters:
4902c58f1c22SToby Isaac + dm   - The DM object
4903c58f1c22SToby Isaac - name - The label name
4904c58f1c22SToby Isaac 
4905c58f1c22SToby Isaac   Level: intermediate
4906c58f1c22SToby Isaac 
4907c58f1c22SToby Isaac .keywords: mesh
4908c58f1c22SToby Isaac .seealso: DMLabelCreate(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
4909c58f1c22SToby Isaac @*/
4910c58f1c22SToby Isaac PetscErrorCode DMCreateLabel(DM dm, const char name[])
4911c58f1c22SToby Isaac {
4912c58f1c22SToby Isaac   DMLabelLink    next  = dm->labels->next;
4913c58f1c22SToby Isaac   PetscBool      flg   = PETSC_FALSE;
4914c58f1c22SToby Isaac   PetscErrorCode ierr;
4915c58f1c22SToby Isaac 
4916c58f1c22SToby Isaac   PetscFunctionBegin;
4917c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4918c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
4919c58f1c22SToby Isaac   while (next) {
4920c58f1c22SToby Isaac     ierr = PetscStrcmp(name, next->label->name, &flg);CHKERRQ(ierr);
4921c58f1c22SToby Isaac     if (flg) break;
4922c58f1c22SToby Isaac     next = next->next;
4923c58f1c22SToby Isaac   }
4924c58f1c22SToby Isaac   if (!flg) {
4925c58f1c22SToby Isaac     DMLabelLink tmpLabel;
4926c58f1c22SToby Isaac 
4927c58f1c22SToby Isaac     ierr = PetscCalloc1(1, &tmpLabel);CHKERRQ(ierr);
4928c58f1c22SToby Isaac     ierr = DMLabelCreate(name, &tmpLabel->label);CHKERRQ(ierr);
4929c58f1c22SToby Isaac     tmpLabel->output = PETSC_TRUE;
4930c58f1c22SToby Isaac     tmpLabel->next   = dm->labels->next;
4931c58f1c22SToby Isaac     dm->labels->next = tmpLabel;
4932c58f1c22SToby Isaac   }
4933c58f1c22SToby Isaac   PetscFunctionReturn(0);
4934c58f1c22SToby Isaac }
4935c58f1c22SToby Isaac 
4936c58f1c22SToby Isaac /*@C
4937c58f1c22SToby Isaac   DMGetLabelValue - Get the value in a Sieve Label for the given point, with 0 as the default
4938c58f1c22SToby Isaac 
4939c58f1c22SToby Isaac   Not Collective
4940c58f1c22SToby Isaac 
4941c58f1c22SToby Isaac   Input Parameters:
4942c58f1c22SToby Isaac + dm   - The DM object
4943c58f1c22SToby Isaac . name - The label name
4944c58f1c22SToby Isaac - point - The mesh point
4945c58f1c22SToby Isaac 
4946c58f1c22SToby Isaac   Output Parameter:
4947c58f1c22SToby Isaac . value - The label value for this point, or -1 if the point is not in the label
4948c58f1c22SToby Isaac 
4949c58f1c22SToby Isaac   Level: beginner
4950c58f1c22SToby Isaac 
4951c58f1c22SToby Isaac .keywords: mesh
4952c58f1c22SToby Isaac .seealso: DMLabelGetValue(), DMSetLabelValue(), DMGetStratumIS()
4953c58f1c22SToby Isaac @*/
4954c58f1c22SToby Isaac PetscErrorCode DMGetLabelValue(DM dm, const char name[], PetscInt point, PetscInt *value)
4955c58f1c22SToby Isaac {
4956c58f1c22SToby Isaac   DMLabel        label;
4957c58f1c22SToby Isaac   PetscErrorCode ierr;
4958c58f1c22SToby Isaac 
4959c58f1c22SToby Isaac   PetscFunctionBegin;
4960c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4961c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
4962c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
4963c58f1c22SToby Isaac   if (!label) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "No label named %s was found", name);CHKERRQ(ierr);
4964c58f1c22SToby Isaac   ierr = DMLabelGetValue(label, point, value);CHKERRQ(ierr);
4965c58f1c22SToby Isaac   PetscFunctionReturn(0);
4966c58f1c22SToby Isaac }
4967c58f1c22SToby Isaac 
4968c58f1c22SToby Isaac /*@C
4969c58f1c22SToby Isaac   DMSetLabelValue - Add a point to a Sieve Label with given value
4970c58f1c22SToby Isaac 
4971c58f1c22SToby Isaac   Not Collective
4972c58f1c22SToby Isaac 
4973c58f1c22SToby Isaac   Input Parameters:
4974c58f1c22SToby Isaac + dm   - The DM object
4975c58f1c22SToby Isaac . name - The label name
4976c58f1c22SToby Isaac . point - The mesh point
4977c58f1c22SToby Isaac - value - The label value for this point
4978c58f1c22SToby Isaac 
4979c58f1c22SToby Isaac   Output Parameter:
4980c58f1c22SToby Isaac 
4981c58f1c22SToby Isaac   Level: beginner
4982c58f1c22SToby Isaac 
4983c58f1c22SToby Isaac .keywords: mesh
4984c58f1c22SToby Isaac .seealso: DMLabelSetValue(), DMGetStratumIS(), DMClearLabelValue()
4985c58f1c22SToby Isaac @*/
4986c58f1c22SToby Isaac PetscErrorCode DMSetLabelValue(DM dm, const char name[], PetscInt point, PetscInt value)
4987c58f1c22SToby Isaac {
4988c58f1c22SToby Isaac   DMLabel        label;
4989c58f1c22SToby Isaac   PetscErrorCode ierr;
4990c58f1c22SToby Isaac 
4991c58f1c22SToby Isaac   PetscFunctionBegin;
4992c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4993c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
4994c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
4995c58f1c22SToby Isaac   if (!label) {
4996c58f1c22SToby Isaac     ierr = DMCreateLabel(dm, name);CHKERRQ(ierr);
4997c58f1c22SToby Isaac     ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
4998c58f1c22SToby Isaac   }
4999c58f1c22SToby Isaac   ierr = DMLabelSetValue(label, point, value);CHKERRQ(ierr);
5000c58f1c22SToby Isaac   PetscFunctionReturn(0);
5001c58f1c22SToby Isaac }
5002c58f1c22SToby Isaac 
5003c58f1c22SToby Isaac /*@C
5004c58f1c22SToby Isaac   DMClearLabelValue - Remove a point from a Sieve Label with given value
5005c58f1c22SToby Isaac 
5006c58f1c22SToby Isaac   Not Collective
5007c58f1c22SToby Isaac 
5008c58f1c22SToby Isaac   Input Parameters:
5009c58f1c22SToby Isaac + dm   - The DM object
5010c58f1c22SToby Isaac . name - The label name
5011c58f1c22SToby Isaac . point - The mesh point
5012c58f1c22SToby Isaac - value - The label value for this point
5013c58f1c22SToby Isaac 
5014c58f1c22SToby Isaac   Output Parameter:
5015c58f1c22SToby Isaac 
5016c58f1c22SToby Isaac   Level: beginner
5017c58f1c22SToby Isaac 
5018c58f1c22SToby Isaac .keywords: mesh
5019c58f1c22SToby Isaac .seealso: DMLabelClearValue(), DMSetLabelValue(), DMGetStratumIS()
5020c58f1c22SToby Isaac @*/
5021c58f1c22SToby Isaac PetscErrorCode DMClearLabelValue(DM dm, const char name[], PetscInt point, PetscInt value)
5022c58f1c22SToby Isaac {
5023c58f1c22SToby Isaac   DMLabel        label;
5024c58f1c22SToby Isaac   PetscErrorCode ierr;
5025c58f1c22SToby Isaac 
5026c58f1c22SToby Isaac   PetscFunctionBegin;
5027c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5028c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
5029c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
5030c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
5031c58f1c22SToby Isaac   ierr = DMLabelClearValue(label, point, value);CHKERRQ(ierr);
5032c58f1c22SToby Isaac   PetscFunctionReturn(0);
5033c58f1c22SToby Isaac }
5034c58f1c22SToby Isaac 
5035c58f1c22SToby Isaac /*@C
5036c58f1c22SToby Isaac   DMGetLabelSize - Get the number of different integer ids in a Label
5037c58f1c22SToby Isaac 
5038c58f1c22SToby Isaac   Not Collective
5039c58f1c22SToby Isaac 
5040c58f1c22SToby Isaac   Input Parameters:
5041c58f1c22SToby Isaac + dm   - The DM object
5042c58f1c22SToby Isaac - name - The label name
5043c58f1c22SToby Isaac 
5044c58f1c22SToby Isaac   Output Parameter:
5045c58f1c22SToby Isaac . size - The number of different integer ids, or 0 if the label does not exist
5046c58f1c22SToby Isaac 
5047c58f1c22SToby Isaac   Level: beginner
5048c58f1c22SToby Isaac 
5049c58f1c22SToby Isaac .keywords: mesh
5050c58f1c22SToby Isaac .seealso: DMLabeGetNumValues(), DMSetLabelValue()
5051c58f1c22SToby Isaac @*/
5052c58f1c22SToby Isaac PetscErrorCode DMGetLabelSize(DM dm, const char name[], PetscInt *size)
5053c58f1c22SToby Isaac {
5054c58f1c22SToby Isaac   DMLabel        label;
5055c58f1c22SToby Isaac   PetscErrorCode ierr;
5056c58f1c22SToby Isaac 
5057c58f1c22SToby Isaac   PetscFunctionBegin;
5058c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5059c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
5060c58f1c22SToby Isaac   PetscValidPointer(size, 3);
5061c58f1c22SToby Isaac   ierr  = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
5062c58f1c22SToby Isaac   *size = 0;
5063c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
5064c58f1c22SToby Isaac   ierr = DMLabelGetNumValues(label, size);CHKERRQ(ierr);
5065c58f1c22SToby Isaac   PetscFunctionReturn(0);
5066c58f1c22SToby Isaac }
5067c58f1c22SToby Isaac 
5068c58f1c22SToby Isaac /*@C
5069c58f1c22SToby Isaac   DMGetLabelIdIS - Get the integer ids in a label
5070c58f1c22SToby Isaac 
5071c58f1c22SToby Isaac   Not Collective
5072c58f1c22SToby Isaac 
5073c58f1c22SToby Isaac   Input Parameters:
5074c58f1c22SToby Isaac + mesh - The DM object
5075c58f1c22SToby Isaac - name - The label name
5076c58f1c22SToby Isaac 
5077c58f1c22SToby Isaac   Output Parameter:
5078c58f1c22SToby Isaac . ids - The integer ids, or NULL if the label does not exist
5079c58f1c22SToby Isaac 
5080c58f1c22SToby Isaac   Level: beginner
5081c58f1c22SToby Isaac 
5082c58f1c22SToby Isaac .keywords: mesh
5083c58f1c22SToby Isaac .seealso: DMLabelGetValueIS(), DMGetLabelSize()
5084c58f1c22SToby Isaac @*/
5085c58f1c22SToby Isaac PetscErrorCode DMGetLabelIdIS(DM dm, const char name[], IS *ids)
5086c58f1c22SToby Isaac {
5087c58f1c22SToby Isaac   DMLabel        label;
5088c58f1c22SToby Isaac   PetscErrorCode ierr;
5089c58f1c22SToby Isaac 
5090c58f1c22SToby Isaac   PetscFunctionBegin;
5091c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5092c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
5093c58f1c22SToby Isaac   PetscValidPointer(ids, 3);
5094c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
5095c58f1c22SToby Isaac   *ids = NULL;
5096c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
5097c58f1c22SToby Isaac   ierr = DMLabelGetValueIS(label, ids);CHKERRQ(ierr);
5098c58f1c22SToby Isaac   PetscFunctionReturn(0);
5099c58f1c22SToby Isaac }
5100c58f1c22SToby Isaac 
5101c58f1c22SToby Isaac /*@C
5102c58f1c22SToby Isaac   DMGetStratumSize - Get the number of points in a label stratum
5103c58f1c22SToby Isaac 
5104c58f1c22SToby Isaac   Not Collective
5105c58f1c22SToby Isaac 
5106c58f1c22SToby Isaac   Input Parameters:
5107c58f1c22SToby Isaac + dm - The DM object
5108c58f1c22SToby Isaac . name - The label name
5109c58f1c22SToby Isaac - value - The stratum value
5110c58f1c22SToby Isaac 
5111c58f1c22SToby Isaac   Output Parameter:
5112c58f1c22SToby Isaac . size - The stratum size
5113c58f1c22SToby Isaac 
5114c58f1c22SToby Isaac   Level: beginner
5115c58f1c22SToby Isaac 
5116c58f1c22SToby Isaac .keywords: mesh
5117c58f1c22SToby Isaac .seealso: DMLabelGetStratumSize(), DMGetLabelSize(), DMGetLabelIds()
5118c58f1c22SToby Isaac @*/
5119c58f1c22SToby Isaac PetscErrorCode DMGetStratumSize(DM dm, const char name[], PetscInt value, PetscInt *size)
5120c58f1c22SToby Isaac {
5121c58f1c22SToby Isaac   DMLabel        label;
5122c58f1c22SToby Isaac   PetscErrorCode ierr;
5123c58f1c22SToby Isaac 
5124c58f1c22SToby Isaac   PetscFunctionBegin;
5125c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5126c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
5127c58f1c22SToby Isaac   PetscValidPointer(size, 4);
5128c58f1c22SToby Isaac   ierr  = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
5129c58f1c22SToby Isaac   *size = 0;
5130c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
5131c58f1c22SToby Isaac   ierr = DMLabelGetStratumSize(label, value, size);CHKERRQ(ierr);
5132c58f1c22SToby Isaac   PetscFunctionReturn(0);
5133c58f1c22SToby Isaac }
5134c58f1c22SToby Isaac 
5135c58f1c22SToby Isaac /*@C
5136c58f1c22SToby Isaac   DMGetStratumIS - Get the points in a label stratum
5137c58f1c22SToby Isaac 
5138c58f1c22SToby Isaac   Not Collective
5139c58f1c22SToby Isaac 
5140c58f1c22SToby Isaac   Input Parameters:
5141c58f1c22SToby Isaac + dm - The DM object
5142c58f1c22SToby Isaac . name - The label name
5143c58f1c22SToby Isaac - value - The stratum value
5144c58f1c22SToby Isaac 
5145c58f1c22SToby Isaac   Output Parameter:
5146c58f1c22SToby Isaac . points - The stratum points, or NULL if the label does not exist or does not have that value
5147c58f1c22SToby Isaac 
5148c58f1c22SToby Isaac   Level: beginner
5149c58f1c22SToby Isaac 
5150c58f1c22SToby Isaac .keywords: mesh
5151c58f1c22SToby Isaac .seealso: DMLabelGetStratumIS(), DMGetStratumSize()
5152c58f1c22SToby Isaac @*/
5153c58f1c22SToby Isaac PetscErrorCode DMGetStratumIS(DM dm, const char name[], PetscInt value, IS *points)
5154c58f1c22SToby Isaac {
5155c58f1c22SToby Isaac   DMLabel        label;
5156c58f1c22SToby Isaac   PetscErrorCode ierr;
5157c58f1c22SToby Isaac 
5158c58f1c22SToby Isaac   PetscFunctionBegin;
5159c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5160c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
5161c58f1c22SToby Isaac   PetscValidPointer(points, 4);
5162c58f1c22SToby Isaac   ierr    = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
5163c58f1c22SToby Isaac   *points = NULL;
5164c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
5165c58f1c22SToby Isaac   ierr = DMLabelGetStratumIS(label, value, points);CHKERRQ(ierr);
5166c58f1c22SToby Isaac   PetscFunctionReturn(0);
5167c58f1c22SToby Isaac }
5168c58f1c22SToby Isaac 
51694de306b1SToby Isaac /*@C
51704de306b1SToby Isaac   DMGetStratumIS - Set the points in a label stratum
51714de306b1SToby Isaac 
51724de306b1SToby Isaac   Not Collective
51734de306b1SToby Isaac 
51744de306b1SToby Isaac   Input Parameters:
51754de306b1SToby Isaac + dm - The DM object
51764de306b1SToby Isaac . name - The label name
51774de306b1SToby Isaac . value - The stratum value
51784de306b1SToby Isaac - points - The stratum points
51794de306b1SToby Isaac 
51804de306b1SToby Isaac   Level: beginner
51814de306b1SToby Isaac 
51824de306b1SToby Isaac .keywords: mesh
51834de306b1SToby Isaac .seealso: DMLabelSetStratumIS(), DMGetStratumSize()
51844de306b1SToby Isaac @*/
51854de306b1SToby Isaac PetscErrorCode DMSetStratumIS(DM dm, const char name[], PetscInt value, IS points)
51864de306b1SToby Isaac {
51874de306b1SToby Isaac   DMLabel        label;
51884de306b1SToby Isaac   PetscErrorCode ierr;
51894de306b1SToby Isaac 
51904de306b1SToby Isaac   PetscFunctionBegin;
51914de306b1SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
51924de306b1SToby Isaac   PetscValidCharPointer(name, 2);
51934de306b1SToby Isaac   PetscValidPointer(points, 4);
51944de306b1SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
51954de306b1SToby Isaac   if (!label) PetscFunctionReturn(0);
51964de306b1SToby Isaac   ierr = DMLabelSetStratumIS(label, value, points);CHKERRQ(ierr);
51974de306b1SToby Isaac   PetscFunctionReturn(0);
51984de306b1SToby Isaac }
51994de306b1SToby Isaac 
5200c58f1c22SToby Isaac /*@C
5201c58f1c22SToby Isaac   DMClearLabelStratum - Remove all points from a stratum from a Sieve Label
5202c58f1c22SToby Isaac 
5203c58f1c22SToby Isaac   Not Collective
5204c58f1c22SToby Isaac 
5205c58f1c22SToby Isaac   Input Parameters:
5206c58f1c22SToby Isaac + dm   - The DM object
5207c58f1c22SToby Isaac . name - The label name
5208c58f1c22SToby Isaac - value - The label value for this point
5209c58f1c22SToby Isaac 
5210c58f1c22SToby Isaac   Output Parameter:
5211c58f1c22SToby Isaac 
5212c58f1c22SToby Isaac   Level: beginner
5213c58f1c22SToby Isaac 
5214c58f1c22SToby Isaac .keywords: mesh
5215c58f1c22SToby Isaac .seealso: DMLabelClearStratum(), DMSetLabelValue(), DMGetStratumIS(), DMClearLabelValue()
5216c58f1c22SToby Isaac @*/
5217c58f1c22SToby Isaac PetscErrorCode DMClearLabelStratum(DM dm, const char name[], PetscInt value)
5218c58f1c22SToby Isaac {
5219c58f1c22SToby Isaac   DMLabel        label;
5220c58f1c22SToby Isaac   PetscErrorCode ierr;
5221c58f1c22SToby Isaac 
5222c58f1c22SToby Isaac   PetscFunctionBegin;
5223c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5224c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
5225c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
5226c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
5227c58f1c22SToby Isaac   ierr = DMLabelClearStratum(label, value);CHKERRQ(ierr);
5228c58f1c22SToby Isaac   PetscFunctionReturn(0);
5229c58f1c22SToby Isaac }
5230c58f1c22SToby Isaac 
5231c58f1c22SToby Isaac /*@
5232c58f1c22SToby Isaac   DMGetNumLabels - Return the number of labels defined by the mesh
5233c58f1c22SToby Isaac 
5234c58f1c22SToby Isaac   Not Collective
5235c58f1c22SToby Isaac 
5236c58f1c22SToby Isaac   Input Parameter:
5237c58f1c22SToby Isaac . dm   - The DM object
5238c58f1c22SToby Isaac 
5239c58f1c22SToby Isaac   Output Parameter:
5240c58f1c22SToby Isaac . numLabels - the number of Labels
5241c58f1c22SToby Isaac 
5242c58f1c22SToby Isaac   Level: intermediate
5243c58f1c22SToby Isaac 
5244c58f1c22SToby Isaac .keywords: mesh
5245c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
5246c58f1c22SToby Isaac @*/
5247c58f1c22SToby Isaac PetscErrorCode DMGetNumLabels(DM dm, PetscInt *numLabels)
5248c58f1c22SToby Isaac {
5249c58f1c22SToby Isaac   DMLabelLink next = dm->labels->next;
5250c58f1c22SToby Isaac   PetscInt  n    = 0;
5251c58f1c22SToby Isaac 
5252c58f1c22SToby Isaac   PetscFunctionBegin;
5253c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5254c58f1c22SToby Isaac   PetscValidPointer(numLabels, 2);
5255c58f1c22SToby Isaac   while (next) {++n; next = next->next;}
5256c58f1c22SToby Isaac   *numLabels = n;
5257c58f1c22SToby Isaac   PetscFunctionReturn(0);
5258c58f1c22SToby Isaac }
5259c58f1c22SToby Isaac 
5260c58f1c22SToby Isaac /*@C
5261c58f1c22SToby Isaac   DMGetLabelName - Return the name of nth label
5262c58f1c22SToby Isaac 
5263c58f1c22SToby Isaac   Not Collective
5264c58f1c22SToby Isaac 
5265c58f1c22SToby Isaac   Input Parameters:
5266c58f1c22SToby Isaac + dm - The DM object
5267c58f1c22SToby Isaac - n  - the label number
5268c58f1c22SToby Isaac 
5269c58f1c22SToby Isaac   Output Parameter:
5270c58f1c22SToby Isaac . name - the label name
5271c58f1c22SToby Isaac 
5272c58f1c22SToby Isaac   Level: intermediate
5273c58f1c22SToby Isaac 
5274c58f1c22SToby Isaac .keywords: mesh
5275c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
5276c58f1c22SToby Isaac @*/
5277c58f1c22SToby Isaac PetscErrorCode DMGetLabelName(DM dm, PetscInt n, const char **name)
5278c58f1c22SToby Isaac {
5279c58f1c22SToby Isaac   DMLabelLink next = dm->labels->next;
5280c58f1c22SToby Isaac   PetscInt  l    = 0;
5281c58f1c22SToby Isaac 
5282c58f1c22SToby Isaac   PetscFunctionBegin;
5283c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5284c58f1c22SToby Isaac   PetscValidPointer(name, 3);
5285c58f1c22SToby Isaac   while (next) {
5286c58f1c22SToby Isaac     if (l == n) {
5287c58f1c22SToby Isaac       *name = next->label->name;
5288c58f1c22SToby Isaac       PetscFunctionReturn(0);
5289c58f1c22SToby Isaac     }
5290c58f1c22SToby Isaac     ++l;
5291c58f1c22SToby Isaac     next = next->next;
5292c58f1c22SToby Isaac   }
5293c58f1c22SToby Isaac   SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %D does not exist in this DM", n);
5294c58f1c22SToby Isaac }
5295c58f1c22SToby Isaac 
5296c58f1c22SToby Isaac /*@C
5297c58f1c22SToby Isaac   DMHasLabel - Determine whether the mesh has a label of a given name
5298c58f1c22SToby Isaac 
5299c58f1c22SToby Isaac   Not Collective
5300c58f1c22SToby Isaac 
5301c58f1c22SToby Isaac   Input Parameters:
5302c58f1c22SToby Isaac + dm   - The DM object
5303c58f1c22SToby Isaac - name - The label name
5304c58f1c22SToby Isaac 
5305c58f1c22SToby Isaac   Output Parameter:
5306c58f1c22SToby Isaac . hasLabel - PETSC_TRUE if the label is present
5307c58f1c22SToby Isaac 
5308c58f1c22SToby Isaac   Level: intermediate
5309c58f1c22SToby Isaac 
5310c58f1c22SToby Isaac .keywords: mesh
5311c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
5312c58f1c22SToby Isaac @*/
5313c58f1c22SToby Isaac PetscErrorCode DMHasLabel(DM dm, const char name[], PetscBool *hasLabel)
5314c58f1c22SToby Isaac {
5315c58f1c22SToby Isaac   DMLabelLink    next = dm->labels->next;
5316c58f1c22SToby Isaac   PetscErrorCode ierr;
5317c58f1c22SToby Isaac 
5318c58f1c22SToby Isaac   PetscFunctionBegin;
5319c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5320c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
5321c58f1c22SToby Isaac   PetscValidPointer(hasLabel, 3);
5322c58f1c22SToby Isaac   *hasLabel = PETSC_FALSE;
5323c58f1c22SToby Isaac   while (next) {
5324c58f1c22SToby Isaac     ierr = PetscStrcmp(name, next->label->name, hasLabel);CHKERRQ(ierr);
5325c58f1c22SToby Isaac     if (*hasLabel) break;
5326c58f1c22SToby Isaac     next = next->next;
5327c58f1c22SToby Isaac   }
5328c58f1c22SToby Isaac   PetscFunctionReturn(0);
5329c58f1c22SToby Isaac }
5330c58f1c22SToby Isaac 
5331c58f1c22SToby Isaac /*@C
5332c58f1c22SToby Isaac   DMGetLabel - Return the label of a given name, or NULL
5333c58f1c22SToby Isaac 
5334c58f1c22SToby Isaac   Not Collective
5335c58f1c22SToby Isaac 
5336c58f1c22SToby Isaac   Input Parameters:
5337c58f1c22SToby Isaac + dm   - The DM object
5338c58f1c22SToby Isaac - name - The label name
5339c58f1c22SToby Isaac 
5340c58f1c22SToby Isaac   Output Parameter:
5341c58f1c22SToby Isaac . label - The DMLabel, or NULL if the label is absent
5342c58f1c22SToby Isaac 
5343c58f1c22SToby Isaac   Level: intermediate
5344c58f1c22SToby Isaac 
5345c58f1c22SToby Isaac .keywords: mesh
5346c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
5347c58f1c22SToby Isaac @*/
5348c58f1c22SToby Isaac PetscErrorCode DMGetLabel(DM dm, const char name[], DMLabel *label)
5349c58f1c22SToby Isaac {
5350c58f1c22SToby Isaac   DMLabelLink    next = dm->labels->next;
5351c58f1c22SToby Isaac   PetscBool      hasLabel;
5352c58f1c22SToby Isaac   PetscErrorCode ierr;
5353c58f1c22SToby Isaac 
5354c58f1c22SToby Isaac   PetscFunctionBegin;
5355c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5356c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
5357c58f1c22SToby Isaac   PetscValidPointer(label, 3);
5358c58f1c22SToby Isaac   *label = NULL;
5359c58f1c22SToby Isaac   while (next) {
5360c58f1c22SToby Isaac     ierr = PetscStrcmp(name, next->label->name, &hasLabel);CHKERRQ(ierr);
5361c58f1c22SToby Isaac     if (hasLabel) {
5362c58f1c22SToby Isaac       *label = next->label;
5363c58f1c22SToby Isaac       break;
5364c58f1c22SToby Isaac     }
5365c58f1c22SToby Isaac     next = next->next;
5366c58f1c22SToby Isaac   }
5367c58f1c22SToby Isaac   PetscFunctionReturn(0);
5368c58f1c22SToby Isaac }
5369c58f1c22SToby Isaac 
5370c58f1c22SToby Isaac /*@C
5371c58f1c22SToby Isaac   DMGetLabelByNum - Return the nth label
5372c58f1c22SToby Isaac 
5373c58f1c22SToby Isaac   Not Collective
5374c58f1c22SToby Isaac 
5375c58f1c22SToby Isaac   Input Parameters:
5376c58f1c22SToby Isaac + dm - The DM object
5377c58f1c22SToby Isaac - n  - the label number
5378c58f1c22SToby Isaac 
5379c58f1c22SToby Isaac   Output Parameter:
5380c58f1c22SToby Isaac . label - the label
5381c58f1c22SToby Isaac 
5382c58f1c22SToby Isaac   Level: intermediate
5383c58f1c22SToby Isaac 
5384c58f1c22SToby Isaac .keywords: mesh
5385c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
5386c58f1c22SToby Isaac @*/
5387c58f1c22SToby Isaac PetscErrorCode DMGetLabelByNum(DM dm, PetscInt n, DMLabel *label)
5388c58f1c22SToby Isaac {
5389c58f1c22SToby Isaac   DMLabelLink next = dm->labels->next;
5390c58f1c22SToby Isaac   PetscInt    l    = 0;
5391c58f1c22SToby Isaac 
5392c58f1c22SToby Isaac   PetscFunctionBegin;
5393c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5394c58f1c22SToby Isaac   PetscValidPointer(label, 3);
5395c58f1c22SToby Isaac   while (next) {
5396c58f1c22SToby Isaac     if (l == n) {
5397c58f1c22SToby Isaac       *label = next->label;
5398c58f1c22SToby Isaac       PetscFunctionReturn(0);
5399c58f1c22SToby Isaac     }
5400c58f1c22SToby Isaac     ++l;
5401c58f1c22SToby Isaac     next = next->next;
5402c58f1c22SToby Isaac   }
5403c58f1c22SToby Isaac   SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %D does not exist in this DM", n);
5404c58f1c22SToby Isaac }
5405c58f1c22SToby Isaac 
5406c58f1c22SToby Isaac /*@C
5407c58f1c22SToby Isaac   DMAddLabel - Add the label to this mesh
5408c58f1c22SToby Isaac 
5409c58f1c22SToby Isaac   Not Collective
5410c58f1c22SToby Isaac 
5411c58f1c22SToby Isaac   Input Parameters:
5412c58f1c22SToby Isaac + dm   - The DM object
5413c58f1c22SToby Isaac - label - The DMLabel
5414c58f1c22SToby Isaac 
5415c58f1c22SToby Isaac   Level: developer
5416c58f1c22SToby Isaac 
5417c58f1c22SToby Isaac .keywords: mesh
5418c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
5419c58f1c22SToby Isaac @*/
5420c58f1c22SToby Isaac PetscErrorCode DMAddLabel(DM dm, DMLabel label)
5421c58f1c22SToby Isaac {
5422c58f1c22SToby Isaac   DMLabelLink    tmpLabel;
5423c58f1c22SToby Isaac   PetscBool      hasLabel;
5424c58f1c22SToby Isaac   PetscErrorCode ierr;
5425c58f1c22SToby Isaac 
5426c58f1c22SToby Isaac   PetscFunctionBegin;
5427c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5428c58f1c22SToby Isaac   ierr = DMHasLabel(dm, label->name, &hasLabel);CHKERRQ(ierr);
5429c58f1c22SToby Isaac   if (hasLabel) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %s already exists in this DM", label->name);
5430c58f1c22SToby Isaac   ierr = PetscCalloc1(1, &tmpLabel);CHKERRQ(ierr);
5431c58f1c22SToby Isaac   tmpLabel->label  = label;
5432c58f1c22SToby Isaac   tmpLabel->output = PETSC_TRUE;
5433c58f1c22SToby Isaac   tmpLabel->next   = dm->labels->next;
5434c58f1c22SToby Isaac   dm->labels->next = tmpLabel;
5435c58f1c22SToby Isaac   PetscFunctionReturn(0);
5436c58f1c22SToby Isaac }
5437c58f1c22SToby Isaac 
5438c58f1c22SToby Isaac /*@C
5439c58f1c22SToby Isaac   DMRemoveLabel - Remove the label from this mesh
5440c58f1c22SToby Isaac 
5441c58f1c22SToby Isaac   Not Collective
5442c58f1c22SToby Isaac 
5443c58f1c22SToby Isaac   Input Parameters:
5444c58f1c22SToby Isaac + dm   - The DM object
5445c58f1c22SToby Isaac - name - The label name
5446c58f1c22SToby Isaac 
5447c58f1c22SToby Isaac   Output Parameter:
5448c58f1c22SToby Isaac . label - The DMLabel, or NULL if the label is absent
5449c58f1c22SToby Isaac 
5450c58f1c22SToby Isaac   Level: developer
5451c58f1c22SToby Isaac 
5452c58f1c22SToby Isaac .keywords: mesh
5453c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
5454c58f1c22SToby Isaac @*/
5455c58f1c22SToby Isaac PetscErrorCode DMRemoveLabel(DM dm, const char name[], DMLabel *label)
5456c58f1c22SToby Isaac {
5457c58f1c22SToby Isaac   DMLabelLink    next = dm->labels->next;
5458c58f1c22SToby Isaac   DMLabelLink    last = NULL;
5459c58f1c22SToby Isaac   PetscBool      hasLabel;
5460c58f1c22SToby Isaac   PetscErrorCode ierr;
5461c58f1c22SToby Isaac 
5462c58f1c22SToby Isaac   PetscFunctionBegin;
5463c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5464c58f1c22SToby Isaac   ierr   = DMHasLabel(dm, name, &hasLabel);CHKERRQ(ierr);
5465c58f1c22SToby Isaac   *label = NULL;
5466c58f1c22SToby Isaac   if (!hasLabel) PetscFunctionReturn(0);
5467c58f1c22SToby Isaac   while (next) {
5468c58f1c22SToby Isaac     ierr = PetscStrcmp(name, next->label->name, &hasLabel);CHKERRQ(ierr);
5469c58f1c22SToby Isaac     if (hasLabel) {
5470c58f1c22SToby Isaac       if (last) last->next       = next->next;
5471c58f1c22SToby Isaac       else      dm->labels->next = next->next;
5472c58f1c22SToby Isaac       next->next = NULL;
5473c58f1c22SToby Isaac       *label     = next->label;
5474c58f1c22SToby Isaac       ierr = PetscStrcmp(name, "depth", &hasLabel);CHKERRQ(ierr);
5475c58f1c22SToby Isaac       if (hasLabel) {
5476c58f1c22SToby Isaac         dm->depthLabel = NULL;
5477c58f1c22SToby Isaac       }
5478c58f1c22SToby Isaac       ierr = PetscFree(next);CHKERRQ(ierr);
5479c58f1c22SToby Isaac       break;
5480c58f1c22SToby Isaac     }
5481c58f1c22SToby Isaac     last = next;
5482c58f1c22SToby Isaac     next = next->next;
5483c58f1c22SToby Isaac   }
5484c58f1c22SToby Isaac   PetscFunctionReturn(0);
5485c58f1c22SToby Isaac }
5486c58f1c22SToby Isaac 
5487c58f1c22SToby Isaac /*@C
5488c58f1c22SToby Isaac   DMGetLabelOutput - Get the output flag for a given label
5489c58f1c22SToby Isaac 
5490c58f1c22SToby Isaac   Not Collective
5491c58f1c22SToby Isaac 
5492c58f1c22SToby Isaac   Input Parameters:
5493c58f1c22SToby Isaac + dm   - The DM object
5494c58f1c22SToby Isaac - name - The label name
5495c58f1c22SToby Isaac 
5496c58f1c22SToby Isaac   Output Parameter:
5497c58f1c22SToby Isaac . output - The flag for output
5498c58f1c22SToby Isaac 
5499c58f1c22SToby Isaac   Level: developer
5500c58f1c22SToby Isaac 
5501c58f1c22SToby Isaac .keywords: mesh
5502c58f1c22SToby Isaac .seealso: DMSetLabelOutput(), DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
5503c58f1c22SToby Isaac @*/
5504c58f1c22SToby Isaac PetscErrorCode DMGetLabelOutput(DM dm, const char name[], PetscBool *output)
5505c58f1c22SToby Isaac {
5506c58f1c22SToby Isaac   DMLabelLink    next = dm->labels->next;
5507c58f1c22SToby Isaac   PetscErrorCode ierr;
5508c58f1c22SToby Isaac 
5509c58f1c22SToby Isaac   PetscFunctionBegin;
5510c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5511c58f1c22SToby Isaac   PetscValidPointer(name, 2);
5512c58f1c22SToby Isaac   PetscValidPointer(output, 3);
5513c58f1c22SToby Isaac   while (next) {
5514c58f1c22SToby Isaac     PetscBool flg;
5515c58f1c22SToby Isaac 
5516c58f1c22SToby Isaac     ierr = PetscStrcmp(name, next->label->name, &flg);CHKERRQ(ierr);
5517c58f1c22SToby Isaac     if (flg) {*output = next->output; PetscFunctionReturn(0);}
5518c58f1c22SToby Isaac     next = next->next;
5519c58f1c22SToby Isaac   }
5520c58f1c22SToby Isaac   SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "No label named %s was present in this dm", name);
5521c58f1c22SToby Isaac }
5522c58f1c22SToby Isaac 
5523c58f1c22SToby Isaac /*@C
5524c58f1c22SToby Isaac   DMSetLabelOutput - Set the output flag for a given label
5525c58f1c22SToby Isaac 
5526c58f1c22SToby Isaac   Not Collective
5527c58f1c22SToby Isaac 
5528c58f1c22SToby Isaac   Input Parameters:
5529c58f1c22SToby Isaac + dm     - The DM object
5530c58f1c22SToby Isaac . name   - The label name
5531c58f1c22SToby Isaac - output - The flag for output
5532c58f1c22SToby Isaac 
5533c58f1c22SToby Isaac   Level: developer
5534c58f1c22SToby Isaac 
5535c58f1c22SToby Isaac .keywords: mesh
5536c58f1c22SToby Isaac .seealso: DMGetLabelOutput(), DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
5537c58f1c22SToby Isaac @*/
5538c58f1c22SToby Isaac PetscErrorCode DMSetLabelOutput(DM dm, const char name[], PetscBool output)
5539c58f1c22SToby Isaac {
5540c58f1c22SToby Isaac   DMLabelLink    next = dm->labels->next;
5541c58f1c22SToby Isaac   PetscErrorCode ierr;
5542c58f1c22SToby Isaac 
5543c58f1c22SToby Isaac   PetscFunctionBegin;
5544c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5545c58f1c22SToby Isaac   PetscValidPointer(name, 2);
5546c58f1c22SToby Isaac   while (next) {
5547c58f1c22SToby Isaac     PetscBool flg;
5548c58f1c22SToby Isaac 
5549c58f1c22SToby Isaac     ierr = PetscStrcmp(name, next->label->name, &flg);CHKERRQ(ierr);
5550c58f1c22SToby Isaac     if (flg) {next->output = output; PetscFunctionReturn(0);}
5551c58f1c22SToby Isaac     next = next->next;
5552c58f1c22SToby Isaac   }
5553c58f1c22SToby Isaac   SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "No label named %s was present in this dm", name);
5554c58f1c22SToby Isaac }
5555c58f1c22SToby Isaac 
5556c58f1c22SToby Isaac 
5557c58f1c22SToby Isaac /*@
5558c58f1c22SToby Isaac   DMCopyLabels - Copy labels from one mesh to another with a superset of the points
5559c58f1c22SToby Isaac 
5560c58f1c22SToby Isaac   Collective on DM
5561c58f1c22SToby Isaac 
5562c58f1c22SToby Isaac   Input Parameter:
55632e17dfb7SMatthew G. Knepley . dmA - The DM object with initial labels
5564c58f1c22SToby Isaac 
5565c58f1c22SToby Isaac   Output Parameter:
55662e17dfb7SMatthew G. Knepley . dmB - The DM object with copied labels
5567c58f1c22SToby Isaac 
5568c58f1c22SToby Isaac   Level: intermediate
5569c58f1c22SToby Isaac 
5570c58f1c22SToby Isaac   Note: This is typically used when interpolating or otherwise adding to a mesh
5571c58f1c22SToby Isaac 
5572c58f1c22SToby Isaac .keywords: mesh
5573c58f1c22SToby Isaac .seealso: DMCopyCoordinates(), DMGetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM(), DMGetCoordinateSection()
5574c58f1c22SToby Isaac @*/
5575c58f1c22SToby Isaac PetscErrorCode DMCopyLabels(DM dmA, DM dmB)
5576c58f1c22SToby Isaac {
5577c58f1c22SToby Isaac   PetscInt       numLabels, l;
5578c58f1c22SToby Isaac   PetscErrorCode ierr;
5579c58f1c22SToby Isaac 
5580c58f1c22SToby Isaac   PetscFunctionBegin;
5581c58f1c22SToby Isaac   if (dmA == dmB) PetscFunctionReturn(0);
5582c58f1c22SToby Isaac   ierr = DMGetNumLabels(dmA, &numLabels);CHKERRQ(ierr);
5583c58f1c22SToby Isaac   for (l = 0; l < numLabels; ++l) {
5584c58f1c22SToby Isaac     DMLabel     label, labelNew;
5585c58f1c22SToby Isaac     const char *name;
5586c58f1c22SToby Isaac     PetscBool   flg;
5587c58f1c22SToby Isaac 
5588c58f1c22SToby Isaac     ierr = DMGetLabelName(dmA, l, &name);CHKERRQ(ierr);
5589c58f1c22SToby Isaac     ierr = PetscStrcmp(name, "depth", &flg);CHKERRQ(ierr);
5590c58f1c22SToby Isaac     if (flg) continue;
5591c58f1c22SToby Isaac     ierr = DMGetLabel(dmA, name, &label);CHKERRQ(ierr);
5592c58f1c22SToby Isaac     ierr = DMLabelDuplicate(label, &labelNew);CHKERRQ(ierr);
5593c58f1c22SToby Isaac     ierr = DMAddLabel(dmB, labelNew);CHKERRQ(ierr);
5594c58f1c22SToby Isaac   }
5595c58f1c22SToby Isaac   PetscFunctionReturn(0);
5596c58f1c22SToby Isaac }
5597a8fb8f29SToby Isaac 
5598a8fb8f29SToby Isaac /*@
5599a8fb8f29SToby Isaac   DMGetCoarseDM - Get the coarse mesh from which this was obtained by refinement
5600a8fb8f29SToby Isaac 
5601a8fb8f29SToby Isaac   Input Parameter:
5602a8fb8f29SToby Isaac . dm - The DM object
5603a8fb8f29SToby Isaac 
5604a8fb8f29SToby Isaac   Output Parameter:
5605a8fb8f29SToby Isaac . cdm - The coarse DM
5606a8fb8f29SToby Isaac 
5607a8fb8f29SToby Isaac   Level: intermediate
5608a8fb8f29SToby Isaac 
5609a8fb8f29SToby Isaac .seealso: DMSetCoarseDM()
5610a8fb8f29SToby Isaac @*/
5611a8fb8f29SToby Isaac PetscErrorCode DMGetCoarseDM(DM dm, DM *cdm)
5612a8fb8f29SToby Isaac {
5613a8fb8f29SToby Isaac   PetscFunctionBegin;
5614a8fb8f29SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5615a8fb8f29SToby Isaac   PetscValidPointer(cdm, 2);
5616a8fb8f29SToby Isaac   *cdm = dm->coarseMesh;
5617a8fb8f29SToby Isaac   PetscFunctionReturn(0);
5618a8fb8f29SToby Isaac }
5619a8fb8f29SToby Isaac 
5620a8fb8f29SToby Isaac /*@
5621a8fb8f29SToby Isaac   DMSetCoarseDM - Set the coarse mesh from which this was obtained by refinement
5622a8fb8f29SToby Isaac 
5623a8fb8f29SToby Isaac   Input Parameters:
5624a8fb8f29SToby Isaac + dm - The DM object
5625a8fb8f29SToby Isaac - cdm - The coarse DM
5626a8fb8f29SToby Isaac 
5627a8fb8f29SToby Isaac   Level: intermediate
5628a8fb8f29SToby Isaac 
5629a8fb8f29SToby Isaac .seealso: DMGetCoarseDM()
5630a8fb8f29SToby Isaac @*/
5631a8fb8f29SToby Isaac PetscErrorCode DMSetCoarseDM(DM dm, DM cdm)
5632a8fb8f29SToby Isaac {
5633a8fb8f29SToby Isaac   PetscErrorCode ierr;
5634a8fb8f29SToby Isaac 
5635a8fb8f29SToby Isaac   PetscFunctionBegin;
5636a8fb8f29SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5637a8fb8f29SToby Isaac   if (cdm) PetscValidHeaderSpecific(cdm, DM_CLASSID, 2);
5638a8fb8f29SToby Isaac   ierr = PetscObjectReference((PetscObject)cdm);CHKERRQ(ierr);
5639a8fb8f29SToby Isaac   ierr = DMDestroy(&dm->coarseMesh);CHKERRQ(ierr);
5640a8fb8f29SToby Isaac   dm->coarseMesh = cdm;
5641a8fb8f29SToby Isaac   PetscFunctionReturn(0);
5642a8fb8f29SToby Isaac }
5643a8fb8f29SToby Isaac 
564488bdff64SToby Isaac /*@
564588bdff64SToby Isaac   DMGetFineDM - Get the fine mesh from which this was obtained by refinement
564688bdff64SToby Isaac 
564788bdff64SToby Isaac   Input Parameter:
564888bdff64SToby Isaac . dm - The DM object
564988bdff64SToby Isaac 
565088bdff64SToby Isaac   Output Parameter:
565188bdff64SToby Isaac . fdm - The fine DM
565288bdff64SToby Isaac 
565388bdff64SToby Isaac   Level: intermediate
565488bdff64SToby Isaac 
565588bdff64SToby Isaac .seealso: DMSetFineDM()
565688bdff64SToby Isaac @*/
565788bdff64SToby Isaac PetscErrorCode DMGetFineDM(DM dm, DM *fdm)
565888bdff64SToby Isaac {
565988bdff64SToby Isaac   PetscFunctionBegin;
566088bdff64SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
566188bdff64SToby Isaac   PetscValidPointer(fdm, 2);
566288bdff64SToby Isaac   *fdm = dm->fineMesh;
566388bdff64SToby Isaac   PetscFunctionReturn(0);
566488bdff64SToby Isaac }
566588bdff64SToby Isaac 
566688bdff64SToby Isaac /*@
566788bdff64SToby Isaac   DMSetFineDM - Set the fine mesh from which this was obtained by refinement
566888bdff64SToby Isaac 
566988bdff64SToby Isaac   Input Parameters:
567088bdff64SToby Isaac + dm - The DM object
567188bdff64SToby Isaac - fdm - The fine DM
567288bdff64SToby Isaac 
567388bdff64SToby Isaac   Level: intermediate
567488bdff64SToby Isaac 
567588bdff64SToby Isaac .seealso: DMGetFineDM()
567688bdff64SToby Isaac @*/
567788bdff64SToby Isaac PetscErrorCode DMSetFineDM(DM dm, DM fdm)
567888bdff64SToby Isaac {
567988bdff64SToby Isaac   PetscErrorCode ierr;
568088bdff64SToby Isaac 
568188bdff64SToby Isaac   PetscFunctionBegin;
568288bdff64SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
568388bdff64SToby Isaac   if (fdm) PetscValidHeaderSpecific(fdm, DM_CLASSID, 2);
568488bdff64SToby Isaac   ierr = PetscObjectReference((PetscObject)fdm);CHKERRQ(ierr);
568588bdff64SToby Isaac   ierr = DMDestroy(&dm->fineMesh);CHKERRQ(ierr);
568688bdff64SToby Isaac   dm->fineMesh = fdm;
568788bdff64SToby Isaac   PetscFunctionReturn(0);
568888bdff64SToby Isaac }
568988bdff64SToby Isaac 
5690a6ba4734SToby Isaac /*=== DMBoundary code ===*/
5691a6ba4734SToby Isaac 
5692a6ba4734SToby Isaac PetscErrorCode DMCopyBoundary(DM dm, DM dmNew)
5693a6ba4734SToby Isaac {
5694a6ba4734SToby Isaac   PetscErrorCode ierr;
5695a6ba4734SToby Isaac 
5696a6ba4734SToby Isaac   PetscFunctionBegin;
5697e6f8dbb6SToby Isaac   ierr = PetscDSCopyBoundary(dm->prob,dmNew->prob);CHKERRQ(ierr);
5698a6ba4734SToby Isaac   PetscFunctionReturn(0);
5699a6ba4734SToby Isaac }
5700a6ba4734SToby Isaac 
5701a6ba4734SToby Isaac /*@C
5702a6ba4734SToby Isaac   DMAddBoundary - Add a boundary condition to the model
5703a6ba4734SToby Isaac 
5704a6ba4734SToby Isaac   Input Parameters:
57054c258f51SMatthew G. Knepley + dm          - The DM, with a PetscDS that matches the problem being constrained
5706f971fd6bSMatthew G. Knepley . type        - The type of condition, e.g. DM_BC_ESSENTIAL_ANALYTIC/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann)
5707a6ba4734SToby Isaac . name        - The BC name
5708a6ba4734SToby Isaac . labelname   - The label defining constrained points
5709a6ba4734SToby Isaac . field       - The field to constrain
5710a6ba4734SToby Isaac . numcomps    - The number of constrained field components
5711a6ba4734SToby Isaac . comps       - An array of constrained component numbers
5712a6ba4734SToby Isaac . bcFunc      - A pointwise function giving boundary values
5713a6ba4734SToby Isaac . numids      - The number of DMLabel ids for constrained points
5714a6ba4734SToby Isaac . ids         - An array of ids for constrained points
5715a6ba4734SToby Isaac - ctx         - An optional user context for bcFunc
5716a6ba4734SToby Isaac 
5717a6ba4734SToby Isaac   Options Database Keys:
5718a6ba4734SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids
5719a6ba4734SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components
5720a6ba4734SToby Isaac 
5721a6ba4734SToby Isaac   Level: developer
5722a6ba4734SToby Isaac 
5723a6ba4734SToby Isaac .seealso: DMGetBoundary()
5724a6ba4734SToby Isaac @*/
5725f971fd6bSMatthew G. Knepley PetscErrorCode DMAddBoundary(DM dm, DMBoundaryConditionType type, const char name[], const char labelname[], PetscInt field, PetscInt numcomps, const PetscInt *comps, void (*bcFunc)(), PetscInt numids, const PetscInt *ids, void *ctx)
5726a6ba4734SToby Isaac {
5727a6ba4734SToby Isaac   PetscErrorCode ierr;
5728a6ba4734SToby Isaac 
5729a6ba4734SToby Isaac   PetscFunctionBegin;
5730a6ba4734SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5731f971fd6bSMatthew G. Knepley   ierr = PetscDSAddBoundary(dm->prob,type,name,labelname,field,numcomps,comps,bcFunc,numids,ids,ctx);CHKERRQ(ierr);
5732a6ba4734SToby Isaac   PetscFunctionReturn(0);
5733a6ba4734SToby Isaac }
5734a6ba4734SToby Isaac 
5735a6ba4734SToby Isaac /*@
5736a6ba4734SToby Isaac   DMGetNumBoundary - Get the number of registered BC
5737a6ba4734SToby Isaac 
5738a6ba4734SToby Isaac   Input Parameters:
5739a6ba4734SToby Isaac . dm - The mesh object
5740a6ba4734SToby Isaac 
5741a6ba4734SToby Isaac   Output Parameters:
5742a6ba4734SToby Isaac . numBd - The number of BC
5743a6ba4734SToby Isaac 
5744a6ba4734SToby Isaac   Level: intermediate
5745a6ba4734SToby Isaac 
5746a6ba4734SToby Isaac .seealso: DMAddBoundary(), DMGetBoundary()
5747a6ba4734SToby Isaac @*/
5748a6ba4734SToby Isaac PetscErrorCode DMGetNumBoundary(DM dm, PetscInt *numBd)
5749a6ba4734SToby Isaac {
575058ebd649SToby Isaac   PetscErrorCode ierr;
5751a6ba4734SToby Isaac 
5752a6ba4734SToby Isaac   PetscFunctionBegin;
5753a6ba4734SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
575458ebd649SToby Isaac   ierr = PetscDSGetNumBoundary(dm->prob,numBd);CHKERRQ(ierr);
5755a6ba4734SToby Isaac   PetscFunctionReturn(0);
5756a6ba4734SToby Isaac }
5757a6ba4734SToby Isaac 
5758a6ba4734SToby Isaac /*@C
5759a6ba4734SToby Isaac   DMGetBoundary - Add a boundary condition to the model
5760a6ba4734SToby Isaac 
5761a6ba4734SToby Isaac   Input Parameters:
5762a6ba4734SToby Isaac + dm          - The mesh object
5763a6ba4734SToby Isaac - bd          - The BC number
5764a6ba4734SToby Isaac 
5765a6ba4734SToby Isaac   Output Parameters:
5766f971fd6bSMatthew G. Knepley + type        - The type of condition, e.g. DM_BC_ESSENTIAL_ANALYTIC/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann)
5767a6ba4734SToby Isaac . name        - The BC name
5768a6ba4734SToby Isaac . labelname   - The label defining constrained points
5769a6ba4734SToby Isaac . field       - The field to constrain
5770a6ba4734SToby Isaac . numcomps    - The number of constrained field components
5771a6ba4734SToby Isaac . comps       - An array of constrained component numbers
5772a6ba4734SToby Isaac . bcFunc      - A pointwise function giving boundary values
5773a6ba4734SToby Isaac . numids      - The number of DMLabel ids for constrained points
5774a6ba4734SToby Isaac . ids         - An array of ids for constrained points
5775a6ba4734SToby Isaac - ctx         - An optional user context for bcFunc
5776a6ba4734SToby Isaac 
5777a6ba4734SToby Isaac   Options Database Keys:
5778a6ba4734SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids
5779a6ba4734SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components
5780a6ba4734SToby Isaac 
5781a6ba4734SToby Isaac   Level: developer
5782a6ba4734SToby Isaac 
5783a6ba4734SToby Isaac .seealso: DMAddBoundary()
5784a6ba4734SToby Isaac @*/
5785f971fd6bSMatthew G. Knepley PetscErrorCode DMGetBoundary(DM dm, PetscInt bd, DMBoundaryConditionType *type, const char **name, const char **labelname, PetscInt *field, PetscInt *numcomps, const PetscInt **comps, void (**func)(), PetscInt *numids, const PetscInt **ids, void **ctx)
5786a6ba4734SToby Isaac {
578758ebd649SToby Isaac   PetscErrorCode ierr;
5788a6ba4734SToby Isaac 
5789a6ba4734SToby Isaac   PetscFunctionBegin;
5790a6ba4734SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5791f971fd6bSMatthew G. Knepley   ierr = PetscDSGetBoundary(dm->prob,bd,type,name,labelname,field,numcomps,comps,func,numids,ids,ctx);CHKERRQ(ierr);
5792a6ba4734SToby Isaac   PetscFunctionReturn(0);
5793a6ba4734SToby Isaac }
5794a6ba4734SToby Isaac 
5795e6f8dbb6SToby Isaac static PetscErrorCode DMPopulateBoundary(DM dm)
5796e6f8dbb6SToby Isaac {
5797dff059c6SToby Isaac   DMBoundary *lastnext;
5798e6f8dbb6SToby Isaac   DSBoundary dsbound;
5799e6f8dbb6SToby Isaac   PetscErrorCode ierr;
5800e6f8dbb6SToby Isaac 
5801e6f8dbb6SToby Isaac   PetscFunctionBegin;
5802e6f8dbb6SToby Isaac   dsbound = dm->prob->boundary;
580347a1f5adSToby Isaac   if (dm->boundary) {
580447a1f5adSToby Isaac     DMBoundary next = dm->boundary;
580547a1f5adSToby Isaac 
580647a1f5adSToby Isaac     /* quick check to see if the PetscDS has changed */
580747a1f5adSToby Isaac     if (next->dsboundary == dsbound) PetscFunctionReturn(0);
580847a1f5adSToby Isaac     /* the PetscDS has changed: tear down and rebuild */
580947a1f5adSToby Isaac     while (next) {
581047a1f5adSToby Isaac       DMBoundary b = next;
581147a1f5adSToby Isaac 
581247a1f5adSToby Isaac       next = b->next;
581347a1f5adSToby Isaac       ierr = PetscFree(b);CHKERRQ(ierr);
5814a6ba4734SToby Isaac     }
581547a1f5adSToby Isaac     dm->boundary = NULL;
5816a6ba4734SToby Isaac   }
581747a1f5adSToby Isaac 
5818dff059c6SToby Isaac   lastnext = &(dm->boundary);
5819e6f8dbb6SToby Isaac   while (dsbound) {
5820e6f8dbb6SToby Isaac     DMBoundary dmbound;
5821e6f8dbb6SToby Isaac 
5822e6f8dbb6SToby Isaac     ierr = PetscNew(&dmbound);CHKERRQ(ierr);
5823e6f8dbb6SToby Isaac     dmbound->dsboundary = dsbound;
5824e6f8dbb6SToby Isaac     ierr = DMGetLabel(dm, dsbound->labelname, &(dmbound->label));CHKERRQ(ierr);
5825e6f8dbb6SToby Isaac     if (!dmbound->label) PetscInfo2(dm, "DSBoundary %s wants label %s, which is not in this dm.\n",dsbound->name,dsbound->labelname);CHKERRQ(ierr);
582647a1f5adSToby Isaac     /* push on the back instead of the front so that it is in the same order as in the PetscDS */
5827dff059c6SToby Isaac     *lastnext = dmbound;
5828dff059c6SToby Isaac     lastnext = &(dmbound->next);
5829dff059c6SToby Isaac     dsbound = dsbound->next;
5830a6ba4734SToby Isaac   }
5831a6ba4734SToby Isaac   PetscFunctionReturn(0);
5832a6ba4734SToby Isaac }
5833a6ba4734SToby Isaac 
5834a6ba4734SToby Isaac PetscErrorCode DMIsBoundaryPoint(DM dm, PetscInt point, PetscBool *isBd)
5835a6ba4734SToby Isaac {
5836b95f2879SToby Isaac   DMBoundary     b;
5837a6ba4734SToby Isaac   PetscErrorCode ierr;
5838a6ba4734SToby Isaac 
5839a6ba4734SToby Isaac   PetscFunctionBegin;
5840a6ba4734SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5841a6ba4734SToby Isaac   PetscValidPointer(isBd, 3);
5842a6ba4734SToby Isaac   *isBd = PETSC_FALSE;
5843e6f8dbb6SToby Isaac   ierr = DMPopulateBoundary(dm);CHKERRQ(ierr);
5844b95f2879SToby Isaac   b = dm->boundary;
5845a6ba4734SToby Isaac   while (b && !(*isBd)) {
5846e6f8dbb6SToby Isaac     DMLabel    label = b->label;
5847e6f8dbb6SToby Isaac     DSBoundary dsb = b->dsboundary;
58483424c85cSToby Isaac 
58493424c85cSToby Isaac     if (label) {
5850a6ba4734SToby Isaac       PetscInt i;
5851a6ba4734SToby Isaac 
5852e6f8dbb6SToby Isaac       for (i = 0; i < dsb->numids && !(*isBd); ++i) {
5853e6f8dbb6SToby Isaac         ierr = DMLabelStratumHasPoint(label, dsb->ids[i], point, isBd);CHKERRQ(ierr);
5854a6ba4734SToby Isaac       }
5855a6ba4734SToby Isaac     }
5856a6ba4734SToby Isaac     b = b->next;
5857a6ba4734SToby Isaac   }
5858a6ba4734SToby Isaac   PetscFunctionReturn(0);
5859a6ba4734SToby Isaac }
58604d6f44ffSToby Isaac 
58614d6f44ffSToby Isaac /*@C
58624d6f44ffSToby Isaac   DMProjectFunction - This projects the given function into the function space provided.
58634d6f44ffSToby Isaac 
58644d6f44ffSToby Isaac   Input Parameters:
58654d6f44ffSToby Isaac + dm      - The DM
58660709b2feSToby Isaac . time    - The time
58674d6f44ffSToby Isaac . funcs   - The coordinate functions to evaluate, one per field
58684d6f44ffSToby Isaac . ctxs    - Optional array of contexts to pass to each coordinate function.  ctxs itself may be null.
58694d6f44ffSToby Isaac - mode    - The insertion mode for values
58704d6f44ffSToby Isaac 
58714d6f44ffSToby Isaac   Output Parameter:
58724d6f44ffSToby Isaac . X - vector
58734d6f44ffSToby Isaac 
58744d6f44ffSToby Isaac    Calling sequence of func:
58750709b2feSToby Isaac $    func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nf, PetscScalar u[], void *ctx);
58764d6f44ffSToby Isaac 
58774d6f44ffSToby Isaac +  dim - The spatial dimension
58784d6f44ffSToby Isaac .  x   - The coordinates
58794d6f44ffSToby Isaac .  Nf  - The number of fields
58804d6f44ffSToby Isaac .  u   - The output field values
58814d6f44ffSToby Isaac -  ctx - optional user-defined function context
58824d6f44ffSToby Isaac 
58834d6f44ffSToby Isaac   Level: developer
58844d6f44ffSToby Isaac 
58852716604bSToby Isaac .seealso: DMComputeL2Diff()
58864d6f44ffSToby Isaac @*/
58870709b2feSToby Isaac PetscErrorCode DMProjectFunction(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec X)
58884d6f44ffSToby Isaac {
58894d6f44ffSToby Isaac   Vec            localX;
58904d6f44ffSToby Isaac   PetscErrorCode ierr;
58914d6f44ffSToby Isaac 
58924d6f44ffSToby Isaac   PetscFunctionBegin;
58934d6f44ffSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
58944d6f44ffSToby Isaac   ierr = DMGetLocalVector(dm, &localX);CHKERRQ(ierr);
58950709b2feSToby Isaac   ierr = DMProjectFunctionLocal(dm, time, funcs, ctxs, mode, localX);CHKERRQ(ierr);
58964d6f44ffSToby Isaac   ierr = DMLocalToGlobalBegin(dm, localX, mode, X);CHKERRQ(ierr);
58974d6f44ffSToby Isaac   ierr = DMLocalToGlobalEnd(dm, localX, mode, X);CHKERRQ(ierr);
58984d6f44ffSToby Isaac   ierr = DMRestoreLocalVector(dm, &localX);CHKERRQ(ierr);
58994d6f44ffSToby Isaac   PetscFunctionReturn(0);
59004d6f44ffSToby Isaac }
59014d6f44ffSToby Isaac 
59020709b2feSToby Isaac PetscErrorCode DMProjectFunctionLocal(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec localX)
59034d6f44ffSToby Isaac {
59044d6f44ffSToby Isaac   PetscErrorCode ierr;
59054d6f44ffSToby Isaac 
59064d6f44ffSToby Isaac   PetscFunctionBegin;
59074d6f44ffSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
59084d6f44ffSToby Isaac   PetscValidHeaderSpecific(localX,VEC_CLASSID,5);
59094d6f44ffSToby Isaac   if (!dm->ops->projectfunctionlocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implemnt DMProjectFunctionLocal",((PetscObject)dm)->type_name);
59100709b2feSToby Isaac   ierr = (dm->ops->projectfunctionlocal) (dm, time, funcs, ctxs, mode, localX);CHKERRQ(ierr);
59114d6f44ffSToby Isaac   PetscFunctionReturn(0);
59124d6f44ffSToby Isaac }
59134d6f44ffSToby Isaac 
59140709b2feSToby 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)
59154d6f44ffSToby Isaac {
59164d6f44ffSToby Isaac   PetscErrorCode ierr;
59174d6f44ffSToby Isaac 
59184d6f44ffSToby Isaac   PetscFunctionBegin;
59194d6f44ffSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
59204d6f44ffSToby Isaac   PetscValidHeaderSpecific(localX,VEC_CLASSID,5);
59214d6f44ffSToby Isaac   if (!dm->ops->projectfunctionlabellocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implemnt DMProjectFunctionLabelLocal",((PetscObject)dm)->type_name);
59220709b2feSToby Isaac   ierr = (dm->ops->projectfunctionlabellocal) (dm, time, label, numIds, ids, funcs, ctxs, mode, localX);CHKERRQ(ierr);
59234d6f44ffSToby Isaac   PetscFunctionReturn(0);
59244d6f44ffSToby Isaac }
59252716604bSToby Isaac 
59268c6c5593SMatthew G. Knepley PetscErrorCode DMProjectFieldLocal(DM dm, PetscReal time, Vec localU,
59278c6c5593SMatthew G. Knepley                                    void (**funcs)(PetscInt, PetscInt, PetscInt,
59288c6c5593SMatthew G. Knepley                                                   const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
59298c6c5593SMatthew G. Knepley                                                   const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
59308c6c5593SMatthew G. Knepley                                                   PetscReal, const PetscReal[], PetscScalar[]),
59318c6c5593SMatthew G. Knepley                                    InsertMode mode, Vec localX)
59328c6c5593SMatthew G. Knepley {
59338c6c5593SMatthew G. Knepley   PetscErrorCode ierr;
59348c6c5593SMatthew G. Knepley 
59358c6c5593SMatthew G. Knepley   PetscFunctionBegin;
59368c6c5593SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
59378c6c5593SMatthew G. Knepley   PetscValidHeaderSpecific(localU,VEC_CLASSID,3);
59388c6c5593SMatthew G. Knepley   PetscValidHeaderSpecific(localX,VEC_CLASSID,6);
59398c6c5593SMatthew G. Knepley   if (!dm->ops->projectfieldlocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implemnt DMProjectFieldLocal",((PetscObject)dm)->type_name);
59408c6c5593SMatthew G. Knepley   ierr = (dm->ops->projectfieldlocal) (dm, time, localU, funcs, mode, localX);CHKERRQ(ierr);
59418c6c5593SMatthew G. Knepley   PetscFunctionReturn(0);
59428c6c5593SMatthew G. Knepley }
59438c6c5593SMatthew G. Knepley 
59448c6c5593SMatthew G. Knepley PetscErrorCode DMProjectFieldLabelLocal(DM dm, PetscReal time, DMLabel label, PetscInt numIds, const PetscInt ids[], Vec localU,
59458c6c5593SMatthew G. Knepley                                         void (**funcs)(PetscInt, PetscInt, PetscInt,
59468c6c5593SMatthew G. Knepley                                                        const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
59478c6c5593SMatthew G. Knepley                                                        const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
59488c6c5593SMatthew G. Knepley                                                        PetscReal, const PetscReal[], PetscScalar[]),
59498c6c5593SMatthew G. Knepley                                         InsertMode mode, Vec localX)
59508c6c5593SMatthew G. Knepley {
59518c6c5593SMatthew G. Knepley   PetscErrorCode ierr;
59528c6c5593SMatthew G. Knepley 
59538c6c5593SMatthew G. Knepley   PetscFunctionBegin;
59548c6c5593SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
59558c6c5593SMatthew G. Knepley   PetscValidHeaderSpecific(localU,VEC_CLASSID,6);
59568c6c5593SMatthew G. Knepley   PetscValidHeaderSpecific(localX,VEC_CLASSID,9);
59578c6c5593SMatthew G. Knepley   if (!dm->ops->projectfieldlabellocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implemnt DMProjectFieldLocal",((PetscObject)dm)->type_name);
59588c6c5593SMatthew G. Knepley   ierr = (dm->ops->projectfieldlabellocal)(dm, time, label, numIds, ids, localU, funcs, mode, localX);CHKERRQ(ierr);
59598c6c5593SMatthew G. Knepley   PetscFunctionReturn(0);
59608c6c5593SMatthew G. Knepley }
59618c6c5593SMatthew G. Knepley 
59622716604bSToby Isaac /*@C
59632716604bSToby Isaac   DMComputeL2Diff - This function computes the L_2 difference between a function u and an FEM interpolant solution u_h.
59642716604bSToby Isaac 
59652716604bSToby Isaac   Input Parameters:
59662716604bSToby Isaac + dm    - The DM
59670709b2feSToby Isaac . time  - The time
59682716604bSToby Isaac . funcs - The functions to evaluate for each field component
59692716604bSToby Isaac . ctxs  - Optional array of contexts to pass to each function, or NULL.
59702716604bSToby Isaac - X     - The coefficient vector u_h
59712716604bSToby Isaac 
59722716604bSToby Isaac   Output Parameter:
59732716604bSToby Isaac . diff - The diff ||u - u_h||_2
59742716604bSToby Isaac 
59752716604bSToby Isaac   Level: developer
59762716604bSToby Isaac 
59771189c1efSToby Isaac .seealso: DMProjectFunction(), DMComputeL2FieldDiff(), DMComputeL2GradientDiff()
59782716604bSToby Isaac @*/
59790709b2feSToby Isaac PetscErrorCode DMComputeL2Diff(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, Vec X, PetscReal *diff)
59802716604bSToby Isaac {
59812716604bSToby Isaac   PetscErrorCode ierr;
59822716604bSToby Isaac 
59832716604bSToby Isaac   PetscFunctionBegin;
59842716604bSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
5985b698f381SToby Isaac   PetscValidHeaderSpecific(X,VEC_CLASSID,5);
59862716604bSToby Isaac   if (!dm->ops->computel2diff) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implemnt DMComputeL2Diff",((PetscObject)dm)->type_name);
59870709b2feSToby Isaac   ierr = (dm->ops->computel2diff)(dm,time,funcs,ctxs,X,diff);CHKERRQ(ierr);
59882716604bSToby Isaac   PetscFunctionReturn(0);
59892716604bSToby Isaac }
5990b698f381SToby Isaac 
5991b698f381SToby Isaac /*@C
5992b698f381SToby Isaac   DMComputeL2GradientDiff - This function computes the L_2 difference between the gradient of a function u and an FEM interpolant solution grad u_h.
5993b698f381SToby Isaac 
5994b698f381SToby Isaac   Input Parameters:
5995b698f381SToby Isaac + dm    - The DM
5996b698f381SToby Isaac , time  - The time
5997b698f381SToby Isaac . funcs - The gradient functions to evaluate for each field component
5998b698f381SToby Isaac . ctxs  - Optional array of contexts to pass to each function, or NULL.
5999b698f381SToby Isaac . X     - The coefficient vector u_h
6000b698f381SToby Isaac - n     - The vector to project along
6001b698f381SToby Isaac 
6002b698f381SToby Isaac   Output Parameter:
6003b698f381SToby Isaac . diff - The diff ||(grad u - grad u_h) . n||_2
6004b698f381SToby Isaac 
6005b698f381SToby Isaac   Level: developer
6006b698f381SToby Isaac 
6007b698f381SToby Isaac .seealso: DMProjectFunction(), DMComputeL2Diff()
6008b698f381SToby Isaac @*/
6009b698f381SToby 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)
6010b698f381SToby Isaac {
6011b698f381SToby Isaac   PetscErrorCode ierr;
6012b698f381SToby Isaac 
6013b698f381SToby Isaac   PetscFunctionBegin;
6014b698f381SToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6015b698f381SToby Isaac   PetscValidHeaderSpecific(X,VEC_CLASSID,5);
6016b698f381SToby Isaac   if (!dm->ops->computel2gradientdiff) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2GradientDiff",((PetscObject)dm)->type_name);
6017b698f381SToby Isaac   ierr = (dm->ops->computel2gradientdiff)(dm,time,funcs,ctxs,X,n,diff);CHKERRQ(ierr);
6018b698f381SToby Isaac   PetscFunctionReturn(0);
6019b698f381SToby Isaac }
6020b698f381SToby Isaac 
60212a16baeaSToby Isaac /*@C
60222a16baeaSToby Isaac   DMComputeL2FieldDiff - This function computes the L_2 difference between a function u and an FEM interpolant solution u_h, separated into field components.
60232a16baeaSToby Isaac 
60242a16baeaSToby Isaac   Input Parameters:
60252a16baeaSToby Isaac + dm    - The DM
60262a16baeaSToby Isaac . time  - The time
60272a16baeaSToby Isaac . funcs - The functions to evaluate for each field component
60282a16baeaSToby Isaac . ctxs  - Optional array of contexts to pass to each function, or NULL.
60292a16baeaSToby Isaac - X     - The coefficient vector u_h
60302a16baeaSToby Isaac 
60312a16baeaSToby Isaac   Output Parameter:
60322a16baeaSToby Isaac . diff - The array of differences, ||u^f - u^f_h||_2
60332a16baeaSToby Isaac 
60342a16baeaSToby Isaac   Level: developer
60352a16baeaSToby Isaac 
60361189c1efSToby Isaac .seealso: DMProjectFunction(), DMComputeL2FieldDiff(), DMComputeL2GradientDiff()
60372a16baeaSToby Isaac @*/
60381189c1efSToby Isaac PetscErrorCode DMComputeL2FieldDiff(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, Vec X, PetscReal diff[])
60392a16baeaSToby Isaac {
60402a16baeaSToby Isaac   PetscErrorCode ierr;
60412a16baeaSToby Isaac 
60422a16baeaSToby Isaac   PetscFunctionBegin;
60432a16baeaSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
60442a16baeaSToby Isaac   PetscValidHeaderSpecific(X,VEC_CLASSID,5);
60452a16baeaSToby Isaac   if (!dm->ops->computel2fielddiff) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implemnt DMComputeL2FieldDiff",((PetscObject)dm)->type_name);
60462a16baeaSToby Isaac   ierr = (dm->ops->computel2fielddiff)(dm,time,funcs,ctxs,X,diff);CHKERRQ(ierr);
60472a16baeaSToby Isaac   PetscFunctionReturn(0);
60482a16baeaSToby Isaac }
60492a16baeaSToby Isaac 
6050df0b854cSToby Isaac /*@C
6051df0b854cSToby Isaac   DMAdaptLabel - Adapt a dm based on a label with values interpreted as coarsening and refining flags.  Specific implementations of DM maybe have
6052cd3c525cSToby Isaac                  specialized flags, but all implementations should accept flag values DM_ADAPT_DETERMINE, DM_ADAPT_KEEP, DM_ADAPT_REFINE, and DM_ADAPT_COARSEN.
6053df0b854cSToby Isaac 
6054df0b854cSToby Isaac   Collective on dm
6055df0b854cSToby Isaac 
6056df0b854cSToby Isaac   Input parameters:
6057df0b854cSToby Isaac + dm - the pre-adaptation DM object
6058a1b0c543SToby Isaac - label - label with the flags
6059df0b854cSToby Isaac 
6060df0b854cSToby Isaac   Output parameters:
6061df0b854cSToby Isaac . adaptedDM - the adapted DM object: may be NULL if an adapted DM could not be produced.
6062df0b854cSToby Isaac 
6063df0b854cSToby Isaac   Level: intermediate
6064df0b854cSToby Isaac @*/
6065a1b0c543SToby Isaac PetscErrorCode DMAdaptLabel(DM dm, DMLabel label, DM *adaptedDM)
6066df0b854cSToby Isaac {
6067df0b854cSToby Isaac   PetscErrorCode ierr;
6068df0b854cSToby Isaac 
6069df0b854cSToby Isaac   PetscFunctionBegin;
6070df0b854cSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6071a1b0c543SToby Isaac   PetscValidPointer(label,2);
6072df0b854cSToby Isaac   PetscValidPointer(adaptedDM,3);
6073df0b854cSToby Isaac   *adaptedDM = NULL;
6074a1b0c543SToby Isaac   ierr = PetscTryMethod((PetscObject)dm,"DMAdaptLabel_C",(DM,DMLabel, DM*),(dm,label,adaptedDM));CHKERRQ(ierr);
6075df0b854cSToby Isaac   PetscFunctionReturn(0);
6076df0b854cSToby Isaac }
6077c4088d22SMatthew G. Knepley 
6078502a2867SDave May /*@C
6079502a2867SDave May  DMGetNeighbors - Gets an array containing the MPI rank of all the processes neighbors
6080502a2867SDave May 
6081502a2867SDave May  Not Collective
6082502a2867SDave May 
6083502a2867SDave May  Input Parameter:
6084502a2867SDave May  . dm    - The DM
6085502a2867SDave May 
6086502a2867SDave May  Output Parameter:
6087502a2867SDave May  . nranks - the number of neighbours
6088502a2867SDave May  . ranks - the neighbors ranks
6089502a2867SDave May 
6090502a2867SDave May  Notes:
6091502a2867SDave May  Do not free the array, it is freed when the DM is destroyed.
6092502a2867SDave May 
6093502a2867SDave May  Level: beginner
6094502a2867SDave May 
6095dee935c1SDave May  .seealso: DMDAGetNeighbors(), PetscSFGetRanks()
6096502a2867SDave May @*/
6097502a2867SDave May PetscErrorCode DMGetNeighbors(DM dm,PetscInt *nranks,const PetscMPIInt *ranks[])
6098502a2867SDave May {
6099502a2867SDave May   PetscErrorCode ierr;
6100502a2867SDave May 
6101502a2867SDave May   PetscFunctionBegin;
6102502a2867SDave May   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6103502a2867SDave May   if (!dm->ops->getneighbors) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implemnt DMGetNeighbors",((PetscObject)dm)->type_name);
6104502a2867SDave May   ierr = (dm->ops->getneighbors)(dm,nranks,ranks);CHKERRQ(ierr);
6105502a2867SDave May   PetscFunctionReturn(0);
6106502a2867SDave May }
6107502a2867SDave May 
6108531c7667SBarry Smith #include <petsc/private/matimpl.h> /* Needed because of coloring->ctype below */
6109531c7667SBarry Smith 
6110531c7667SBarry Smith /*
6111531c7667SBarry Smith     Converts the input vector to a ghosted vector and then calls the standard coloring code.
6112531c7667SBarry Smith     This has be a different function because it requires DM which is not defined in the Mat library
6113531c7667SBarry Smith */
6114531c7667SBarry Smith PetscErrorCode  MatFDColoringApply_AIJDM(Mat J,MatFDColoring coloring,Vec x1,void *sctx)
6115531c7667SBarry Smith {
6116531c7667SBarry Smith   PetscErrorCode ierr;
6117531c7667SBarry Smith 
6118531c7667SBarry Smith   PetscFunctionBegin;
6119531c7667SBarry Smith   if (coloring->ctype == IS_COLORING_LOCAL) {
6120531c7667SBarry Smith     Vec x1local;
6121531c7667SBarry Smith     DM  dm;
6122531c7667SBarry Smith     ierr = MatGetDM(J,&dm);CHKERRQ(ierr);
6123531c7667SBarry Smith     if (!dm) SETERRQ(PetscObjectComm((PetscObject)J),PETSC_ERR_ARG_INCOMP,"IS_COLORING_LOCAL requires a DM");
6124531c7667SBarry Smith     ierr = DMGetLocalVector(dm,&x1local);CHKERRQ(ierr);
6125531c7667SBarry Smith     ierr = DMGlobalToLocalBegin(dm,x1,INSERT_VALUES,x1local);CHKERRQ(ierr);
6126531c7667SBarry Smith     ierr = DMGlobalToLocalEnd(dm,x1,INSERT_VALUES,x1local);CHKERRQ(ierr);
6127531c7667SBarry Smith     x1   = x1local;
6128531c7667SBarry Smith   }
6129531c7667SBarry Smith   ierr = MatFDColoringApply_AIJ(J,coloring,x1,sctx);CHKERRQ(ierr);
6130531c7667SBarry Smith   if (coloring->ctype == IS_COLORING_LOCAL) {
6131531c7667SBarry Smith     DM  dm;
6132531c7667SBarry Smith     ierr = MatGetDM(J,&dm);CHKERRQ(ierr);
6133531c7667SBarry Smith     ierr = DMRestoreLocalVector(dm,&x1);CHKERRQ(ierr);
6134531c7667SBarry Smith   }
6135531c7667SBarry Smith   PetscFunctionReturn(0);
6136531c7667SBarry Smith }
6137531c7667SBarry Smith 
6138531c7667SBarry Smith /*@
6139531c7667SBarry Smith     MatFDColoringUseDM - allows a MatFDColoring object to use the DM associated with the matrix to use a IS_COLORING_LOCAL coloring
6140531c7667SBarry Smith 
6141531c7667SBarry Smith     Input Parameter:
6142531c7667SBarry Smith .    coloring - the MatFDColoring object
6143531c7667SBarry Smith 
6144531c7667SBarry Smith     Developer Notes: this routine exists because the PETSc Mat library does not know about the DM objects
6145531c7667SBarry Smith 
61461b266c99SBarry Smith     Level: advanced
61471b266c99SBarry Smith 
6148531c7667SBarry Smith .seealso: MatFDColoring, MatFDColoringCreate(), ISColoringType
6149531c7667SBarry Smith @*/
6150531c7667SBarry Smith PetscErrorCode  MatFDColoringUseDM(Mat coloring,MatFDColoring fdcoloring)
6151531c7667SBarry Smith {
6152531c7667SBarry Smith   PetscFunctionBegin;
6153531c7667SBarry Smith   coloring->ops->fdcoloringapply = MatFDColoringApply_AIJDM;
6154531c7667SBarry Smith   PetscFunctionReturn(0);
6155531c7667SBarry Smith }
6156