xref: /petsc/src/dm/interface/dm.c (revision 649ef02298b68fc2f97d35399272455b55304a51)
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>
5f19dbd58SToby Isaac #include <petscdmfield.h>
60c312b8eSJed Brown #include <petscsf.h>
72764a2aaSMatthew G. Knepley #include <petscds.h>
847c6ae99SBarry Smith 
900d952a4SJed Brown #if defined(PETSC_HAVE_VALGRIND)
1000d952a4SJed Brown #  include <valgrind/memcheck.h>
1100d952a4SJed Brown #endif
1200d952a4SJed Brown 
13732e2eb9SMatthew G Knepley PetscClassId  DM_CLASSID;
14d67d17b1SMatthew G. Knepley PetscClassId  DMLABEL_CLASSID;
15557cf195SMatthew G. Knepley PetscLogEvent DM_Convert, DM_GlobalToLocal, DM_LocalToGlobal, DM_LocalToLocal, DM_LocatePoints, DM_Coarsen, DM_Refine, DM_CreateInterpolation, DM_CreateRestriction, DM_CreateInjection, DM_CreateMatrix, DM_Load, DM_AdaptInterpolator;
1667a56275SMatthew G Knepley 
17ea78f98cSLisandro Dalcin const char *const DMBoundaryTypes[] = {"NONE","GHOSTED","MIRROR","PERIODIC","TWIST","DMBoundaryType","DM_BOUNDARY_", NULL};
18ea78f98cSLisandro Dalcin const char *const DMBoundaryConditionTypes[] = {"INVALID","ESSENTIAL","NATURAL","INVALID","INVALID","ESSENTIAL_FIELD","NATURAL_FIELD","INVALID","INVALID","INVALID","NATURAL_RIEMANN","DMBoundaryConditionType","DM_BC_", NULL};
19ea78f98cSLisandro Dalcin const char *const DMPolytopeTypes[] = {"vertex", "segment", "tensor_segment", "triangle", "quadrilateral", "tensor_quad", "tetrahedron", "hexahedron", "triangular_prism", "tensor_triangular_prism", "tensor_quadrilateral_prism", "FV_ghost_cell", "interior_ghost_cell", "unknown", "invalid", "DMPolytopeType", "DM_POLYTOPE_", NULL};
20a4121054SBarry Smith /*@
21de043629SMatthew G Knepley   DMCreate - Creates an empty DM object. The type can then be set with DMSetType().
22a4121054SBarry Smith 
23a4121054SBarry Smith    If you never  call DMSetType()  it will generate an
24a4121054SBarry Smith    error when you try to use the vector.
25a4121054SBarry Smith 
26d083f849SBarry Smith   Collective
27a4121054SBarry Smith 
28a4121054SBarry Smith   Input Parameter:
29a4121054SBarry Smith . comm - The communicator for the DM object
30a4121054SBarry Smith 
31a4121054SBarry Smith   Output Parameter:
32a4121054SBarry Smith . dm - The DM object
33a4121054SBarry Smith 
34a4121054SBarry Smith   Level: beginner
35a4121054SBarry Smith 
368472ad0fSDave May .seealso: DMSetType(), DMDA, DMSLICED, DMCOMPOSITE, DMPLEX, DMMOAB, DMNETWORK
37a4121054SBarry Smith @*/
387087cfbeSBarry Smith PetscErrorCode  DMCreate(MPI_Comm comm,DM *dm)
39a4121054SBarry Smith {
40a4121054SBarry Smith   DM             v;
41e5e52638SMatthew G. Knepley   PetscDS        ds;
42a4121054SBarry Smith   PetscErrorCode ierr;
43a4121054SBarry Smith 
44a4121054SBarry Smith   PetscFunctionBegin;
451411c6eeSJed Brown   PetscValidPointer(dm,2);
460298fd71SBarry Smith   *dm = NULL;
47607a6623SBarry Smith   ierr = DMInitializePackage();CHKERRQ(ierr);
48a4121054SBarry Smith 
4973107ff1SLisandro Dalcin   ierr = PetscHeaderCreate(v, DM_CLASSID, "DM", "Distribution Manager", "DM", comm, DMDestroy, DMView);CHKERRQ(ierr);
50e7c4fc90SDmitry Karpeev 
5149be4549SMatthew G. Knepley   v->setupcalled              = PETSC_FALSE;
5249be4549SMatthew G. Knepley   v->setfromoptionscalled     = PETSC_FALSE;
530298fd71SBarry Smith   v->ltogmap                  = NULL;
541411c6eeSJed Brown   v->bs                       = 1;
55171400e9SBarry Smith   v->coloringtype             = IS_COLORING_GLOBAL;
5688ed4aceSMatthew G Knepley   ierr                        = PetscSFCreate(comm, &v->sf);CHKERRQ(ierr);
571bb6d2a8SBarry Smith   ierr                        = PetscSFCreate(comm, &v->sectionSF);CHKERRQ(ierr);
58c58f1c22SToby Isaac   v->labels                   = NULL;
5934aa8a36SMatthew G. Knepley   v->adjacency[0]             = PETSC_FALSE;
6034aa8a36SMatthew G. Knepley   v->adjacency[1]             = PETSC_TRUE;
61c58f1c22SToby Isaac   v->depthLabel               = NULL;
62ba2698f1SMatthew G. Knepley   v->celltypeLabel            = NULL;
631bb6d2a8SBarry Smith   v->localSection             = NULL;
641bb6d2a8SBarry Smith   v->globalSection            = NULL;
65fba222abSToby Isaac   v->defaultConstraintSection = NULL;
66fba222abSToby Isaac   v->defaultConstraintMat     = NULL;
67c6b900c6SMatthew G. Knepley   v->L                        = NULL;
68c6b900c6SMatthew G. Knepley   v->maxCell                  = NULL;
695dc8c3f7SMatthew G. Knepley   v->bdtype                   = NULL;
709a9a41abSToby Isaac   v->dimEmbed                 = PETSC_DEFAULT;
7196173672SStefano Zampini   v->dim                      = PETSC_DETERMINE;
72435a35e8SMatthew G Knepley   {
73435a35e8SMatthew G Knepley     PetscInt i;
74435a35e8SMatthew G Knepley     for (i = 0; i < 10; ++i) {
750298fd71SBarry Smith       v->nullspaceConstructors[i] = NULL;
76f9d4088aSMatthew G. Knepley       v->nearnullspaceConstructors[i] = NULL;
77435a35e8SMatthew G Knepley     }
78435a35e8SMatthew G Knepley   }
79e5e52638SMatthew G. Knepley   ierr = PetscDSCreate(PetscObjectComm((PetscObject) v), &ds);CHKERRQ(ierr);
80b3cf3223SMatthew G. Knepley   ierr = DMSetRegionDS(v, NULL, NULL, ds);CHKERRQ(ierr);
81e5e52638SMatthew G. Knepley   ierr = PetscDSDestroy(&ds);CHKERRQ(ierr);
8214f150ffSMatthew G. Knepley   v->dmBC = NULL;
83a8fb8f29SToby Isaac   v->coarseMesh = NULL;
84f4d763aaSMatthew G. Knepley   v->outputSequenceNum = -1;
85cdb7a50dSMatthew G. Knepley   v->outputSequenceVal = 0.0;
86c0dedaeaSBarry Smith   ierr = DMSetVecType(v,VECSTANDARD);CHKERRQ(ierr);
87b412c318SBarry Smith   ierr = DMSetMatType(v,MATAIJ);CHKERRQ(ierr);
884a7a4c06SLawrence Mitchell 
891411c6eeSJed Brown   *dm = v;
90a4121054SBarry Smith   PetscFunctionReturn(0);
91a4121054SBarry Smith }
92a4121054SBarry Smith 
9338221697SMatthew G. Knepley /*@
9438221697SMatthew G. Knepley   DMClone - Creates a DM object with the same topology as the original.
9538221697SMatthew G. Knepley 
96d083f849SBarry Smith   Collective
9738221697SMatthew G. Knepley 
9838221697SMatthew G. Knepley   Input Parameter:
9938221697SMatthew G. Knepley . dm - The original DM object
10038221697SMatthew G. Knepley 
10138221697SMatthew G. Knepley   Output Parameter:
10238221697SMatthew G. Knepley . newdm  - The new DM object
10338221697SMatthew G. Knepley 
10438221697SMatthew G. Knepley   Level: beginner
10538221697SMatthew G. Knepley 
1061cb8cacdSPatrick Sanan   Notes:
1071cb8cacdSPatrick Sanan   For some DM implementations this is a shallow clone, the result of which may share (referent counted) information with its parent. For example,
1081cb8cacdSPatrick Sanan   DMClone() applied to a DMPLEX object will result in a new DMPLEX that shares the topology with the original DMPLEX. It does not
1091cb8cacdSPatrick Sanan   share the PetscSection of the original DM.
1101bb6d2a8SBarry Smith 
11189706ed2SPatrick Sanan   The clone is considered set up iff the original is.
11289706ed2SPatrick Sanan 
11392cfd99aSMartin Diehl .seealso: DMDestroy(), DMCreate(), DMSetType(), DMSetLocalSection(), DMSetGlobalSection()
1141bb6d2a8SBarry Smith 
11538221697SMatthew G. Knepley @*/
11638221697SMatthew G. Knepley PetscErrorCode DMClone(DM dm, DM *newdm)
11738221697SMatthew G. Knepley {
11838221697SMatthew G. Knepley   PetscSF        sf;
11938221697SMatthew G. Knepley   Vec            coords;
12038221697SMatthew G. Knepley   void          *ctx;
121a3219837SMatthew G. Knepley   PetscInt       dim, cdim;
12238221697SMatthew G. Knepley   PetscErrorCode ierr;
12338221697SMatthew G. Knepley 
12438221697SMatthew G. Knepley   PetscFunctionBegin;
12538221697SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
12638221697SMatthew G. Knepley   PetscValidPointer(newdm,2);
12738221697SMatthew G. Knepley   ierr = DMCreate(PetscObjectComm((PetscObject) dm), newdm);CHKERRQ(ierr);
1285d80c0bfSVaclav Hapla   ierr = DMCopyLabels(dm, *newdm, PETSC_COPY_VALUES, PETSC_TRUE);CHKERRQ(ierr);
129ddf8437dSMatthew G. Knepley   (*newdm)->leveldown  = dm->leveldown;
130ddf8437dSMatthew G. Knepley   (*newdm)->levelup    = dm->levelup;
1311de53e9aSMatthew G. Knepley   ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr);
1321de53e9aSMatthew G. Knepley   ierr = DMSetDimension(*newdm, dim);CHKERRQ(ierr);
13338221697SMatthew G. Knepley   if (dm->ops->clone) {
13438221697SMatthew G. Knepley     ierr = (*dm->ops->clone)(dm, newdm);CHKERRQ(ierr);
13538221697SMatthew G. Knepley   }
1363f22bcbcSToby Isaac   (*newdm)->setupcalled = dm->setupcalled;
13738221697SMatthew G. Knepley   ierr = DMGetPointSF(dm, &sf);CHKERRQ(ierr);
13838221697SMatthew G. Knepley   ierr = DMSetPointSF(*newdm, sf);CHKERRQ(ierr);
13938221697SMatthew G. Knepley   ierr = DMGetApplicationContext(dm, &ctx);CHKERRQ(ierr);
14038221697SMatthew G. Knepley   ierr = DMSetApplicationContext(*newdm, ctx);CHKERRQ(ierr);
141be4c1c3eSMatthew G. Knepley   if (dm->coordinateDM) {
142be4c1c3eSMatthew G. Knepley     DM           ncdm;
143be4c1c3eSMatthew G. Knepley     PetscSection cs;
1445a0206caSToby Isaac     PetscInt     pEnd = -1, pEndMax = -1;
145be4c1c3eSMatthew G. Knepley 
14692fd8e1eSJed Brown     ierr = DMGetLocalSection(dm->coordinateDM, &cs);CHKERRQ(ierr);
147be4c1c3eSMatthew G. Knepley     if (cs) {ierr = PetscSectionGetChart(cs, NULL, &pEnd);CHKERRQ(ierr);}
1485a0206caSToby Isaac     ierr = MPI_Allreduce(&pEnd,&pEndMax,1,MPIU_INT,MPI_MAX,PetscObjectComm((PetscObject)dm));CHKERRQ(ierr);
1495a0206caSToby Isaac     if (pEndMax >= 0) {
150be4c1c3eSMatthew G. Knepley       ierr = DMClone(dm->coordinateDM, &ncdm);CHKERRQ(ierr);
15183bfc06fSMatthew Knepley       ierr = DMCopyDisc(dm->coordinateDM, ncdm);CHKERRQ(ierr);
15292fd8e1eSJed Brown       ierr = DMSetLocalSection(ncdm, cs);CHKERRQ(ierr);
153a61e840bSMatthew G. Knepley       ierr = DMSetCoordinateDM(*newdm, ncdm);CHKERRQ(ierr);
154be4c1c3eSMatthew G. Knepley       ierr = DMDestroy(&ncdm);CHKERRQ(ierr);
155be4c1c3eSMatthew G. Knepley     }
156be4c1c3eSMatthew G. Knepley   }
157a3219837SMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
158a3219837SMatthew G. Knepley   ierr = DMSetCoordinateDim(*newdm, cdim);CHKERRQ(ierr);
15938221697SMatthew G. Knepley   ierr = DMGetCoordinatesLocal(dm, &coords);CHKERRQ(ierr);
16038221697SMatthew G. Knepley   if (coords) {
16138221697SMatthew G. Knepley     ierr = DMSetCoordinatesLocal(*newdm, coords);CHKERRQ(ierr);
16238221697SMatthew G. Knepley   } else {
16338221697SMatthew G. Knepley     ierr = DMGetCoordinates(dm, &coords);CHKERRQ(ierr);
16438221697SMatthew G. Knepley     if (coords) {ierr = DMSetCoordinates(*newdm, coords);CHKERRQ(ierr);}
16538221697SMatthew G. Knepley   }
16690b157c4SStefano Zampini   {
16790b157c4SStefano Zampini     PetscBool             isper;
168c6b900c6SMatthew G. Knepley     const PetscReal      *maxCell, *L;
1695dc8c3f7SMatthew G. Knepley     const DMBoundaryType *bd;
17090b157c4SStefano Zampini     ierr = DMGetPeriodicity(dm, &isper, &maxCell, &L, &bd);CHKERRQ(ierr);
17190b157c4SStefano Zampini     ierr = DMSetPeriodicity(*newdm, isper, maxCell,  L,  bd);CHKERRQ(ierr);
172c6b900c6SMatthew G. Knepley   }
17334aa8a36SMatthew G. Knepley   {
17434aa8a36SMatthew G. Knepley     PetscBool useCone, useClosure;
17534aa8a36SMatthew G. Knepley 
17634aa8a36SMatthew G. Knepley     ierr = DMGetAdjacency(dm, PETSC_DEFAULT, &useCone, &useClosure);CHKERRQ(ierr);
17734aa8a36SMatthew G. Knepley     ierr = DMSetAdjacency(*newdm, PETSC_DEFAULT, useCone, useClosure);CHKERRQ(ierr);
17834aa8a36SMatthew G. Knepley   }
17938221697SMatthew G. Knepley   PetscFunctionReturn(0);
18038221697SMatthew G. Knepley }
18138221697SMatthew G. Knepley 
1829a42bb27SBarry Smith /*@C
183564755cdSBarry Smith        DMSetVecType - Sets the type of vector created with DMCreateLocalVector() and DMCreateGlobalVector()
1849a42bb27SBarry Smith 
185d083f849SBarry Smith    Logically Collective on da
1869a42bb27SBarry Smith 
1879a42bb27SBarry Smith    Input Parameter:
1889a42bb27SBarry Smith +  da - initial distributed array
189e9e886b6SKarl Rupp .  ctype - the vector type, currently either VECSTANDARD, VECCUDA, or VECVIENNACL
1909a42bb27SBarry Smith 
1919a42bb27SBarry Smith    Options Database:
192dd85299cSBarry Smith .   -dm_vec_type ctype
1939a42bb27SBarry Smith 
1949a42bb27SBarry Smith    Level: intermediate
1959a42bb27SBarry Smith 
196a2a9ebe5SBarry Smith .seealso: DMCreate(), DMDestroy(), DM, DMDAInterpolationType, VecType, DMGetVecType(), DMSetMatType(), DMGetMatType()
1979a42bb27SBarry Smith @*/
19819fd82e9SBarry Smith PetscErrorCode  DMSetVecType(DM da,VecType ctype)
1999a42bb27SBarry Smith {
2009a42bb27SBarry Smith   PetscErrorCode ierr;
2019a42bb27SBarry Smith 
2029a42bb27SBarry Smith   PetscFunctionBegin;
2039a42bb27SBarry Smith   PetscValidHeaderSpecific(da,DM_CLASSID,1);
2049a42bb27SBarry Smith   ierr = PetscFree(da->vectype);CHKERRQ(ierr);
20519fd82e9SBarry Smith   ierr = PetscStrallocpy(ctype,(char**)&da->vectype);CHKERRQ(ierr);
2069a42bb27SBarry Smith   PetscFunctionReturn(0);
2079a42bb27SBarry Smith }
2089a42bb27SBarry Smith 
209c0dedaeaSBarry Smith /*@C
210c0dedaeaSBarry Smith        DMGetVecType - Gets the type of vector created with DMCreateLocalVector() and DMCreateGlobalVector()
211c0dedaeaSBarry Smith 
212d083f849SBarry Smith    Logically Collective on da
213c0dedaeaSBarry Smith 
214c0dedaeaSBarry Smith    Input Parameter:
215c0dedaeaSBarry Smith .  da - initial distributed array
216c0dedaeaSBarry Smith 
217c0dedaeaSBarry Smith    Output Parameter:
218c0dedaeaSBarry Smith .  ctype - the vector type
219c0dedaeaSBarry Smith 
220c0dedaeaSBarry Smith    Level: intermediate
221c0dedaeaSBarry Smith 
222a2a9ebe5SBarry Smith .seealso: DMCreate(), DMDestroy(), DM, DMDAInterpolationType, VecType, DMSetMatType(), DMGetMatType(), DMSetVecType()
223c0dedaeaSBarry Smith @*/
224c0dedaeaSBarry Smith PetscErrorCode  DMGetVecType(DM da,VecType *ctype)
225c0dedaeaSBarry Smith {
226c0dedaeaSBarry Smith   PetscFunctionBegin;
227c0dedaeaSBarry Smith   PetscValidHeaderSpecific(da,DM_CLASSID,1);
228c0dedaeaSBarry Smith   *ctype = da->vectype;
229c0dedaeaSBarry Smith   PetscFunctionReturn(0);
230c0dedaeaSBarry Smith }
231c0dedaeaSBarry Smith 
2325f1ad066SMatthew G Knepley /*@
23334f98d34SBarry Smith   VecGetDM - Gets the DM defining the data layout of the vector
2345f1ad066SMatthew G Knepley 
2355f1ad066SMatthew G Knepley   Not collective
2365f1ad066SMatthew G Knepley 
2375f1ad066SMatthew G Knepley   Input Parameter:
2385f1ad066SMatthew G Knepley . v - The Vec
2395f1ad066SMatthew G Knepley 
2405f1ad066SMatthew G Knepley   Output Parameter:
2415f1ad066SMatthew G Knepley . dm - The DM
2425f1ad066SMatthew G Knepley 
2435f1ad066SMatthew G Knepley   Level: intermediate
2445f1ad066SMatthew G Knepley 
2455f1ad066SMatthew G Knepley .seealso: VecSetDM(), DMGetLocalVector(), DMGetGlobalVector(), DMSetVecType()
2465f1ad066SMatthew G Knepley @*/
2475f1ad066SMatthew G Knepley PetscErrorCode VecGetDM(Vec v, DM *dm)
2485f1ad066SMatthew G Knepley {
2495f1ad066SMatthew G Knepley   PetscErrorCode ierr;
2505f1ad066SMatthew G Knepley 
2515f1ad066SMatthew G Knepley   PetscFunctionBegin;
2525f1ad066SMatthew G Knepley   PetscValidHeaderSpecific(v,VEC_CLASSID,1);
2535f1ad066SMatthew G Knepley   PetscValidPointer(dm,2);
2545f1ad066SMatthew G Knepley   ierr = PetscObjectQuery((PetscObject) v, "__PETSc_dm", (PetscObject*) dm);CHKERRQ(ierr);
2555f1ad066SMatthew G Knepley   PetscFunctionReturn(0);
2565f1ad066SMatthew G Knepley }
2575f1ad066SMatthew G Knepley 
2585f1ad066SMatthew G Knepley /*@
259d9805387SMatthew G. Knepley   VecSetDM - Sets the DM defining the data layout of the vector.
2605f1ad066SMatthew G Knepley 
2615f1ad066SMatthew G Knepley   Not collective
2625f1ad066SMatthew G Knepley 
2635f1ad066SMatthew G Knepley   Input Parameters:
2645f1ad066SMatthew G Knepley + v - The Vec
2655f1ad066SMatthew G Knepley - dm - The DM
2665f1ad066SMatthew G Knepley 
267d9805387SMatthew 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.
268d9805387SMatthew G. Knepley 
2695f1ad066SMatthew G Knepley   Level: intermediate
2705f1ad066SMatthew G Knepley 
2715f1ad066SMatthew G Knepley .seealso: VecGetDM(), DMGetLocalVector(), DMGetGlobalVector(), DMSetVecType()
2725f1ad066SMatthew G Knepley @*/
2735f1ad066SMatthew G Knepley PetscErrorCode VecSetDM(Vec v, DM dm)
2745f1ad066SMatthew G Knepley {
2755f1ad066SMatthew G Knepley   PetscErrorCode ierr;
2765f1ad066SMatthew G Knepley 
2775f1ad066SMatthew G Knepley   PetscFunctionBegin;
2785f1ad066SMatthew G Knepley   PetscValidHeaderSpecific(v,VEC_CLASSID,1);
279d7f50e27SLisandro Dalcin   if (dm) PetscValidHeaderSpecific(dm,DM_CLASSID,2);
2805f1ad066SMatthew G Knepley   ierr = PetscObjectCompose((PetscObject) v, "__PETSc_dm", (PetscObject) dm);CHKERRQ(ierr);
2815f1ad066SMatthew G Knepley   PetscFunctionReturn(0);
2825f1ad066SMatthew G Knepley }
2835f1ad066SMatthew G Knepley 
284521d9a4cSLisandro Dalcin /*@C
2858f1509bcSBarry Smith        DMSetISColoringType - Sets the type of coloring, global or local, that is created by the DM
2868f1509bcSBarry Smith 
287d083f849SBarry Smith    Logically Collective on dm
2888f1509bcSBarry Smith 
2898f1509bcSBarry Smith    Input Parameters:
2908f1509bcSBarry Smith +  dm - the DM context
2918f1509bcSBarry Smith -  ctype - the matrix type
2928f1509bcSBarry Smith 
2938f1509bcSBarry Smith    Options Database:
2948f1509bcSBarry Smith .   -dm_is_coloring_type - global or local
2958f1509bcSBarry Smith 
2968f1509bcSBarry Smith    Level: intermediate
2978f1509bcSBarry Smith 
2988f1509bcSBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMGetMatType(),
2998f1509bcSBarry Smith           DMGetISColoringType()
3008f1509bcSBarry Smith @*/
3018f1509bcSBarry Smith PetscErrorCode  DMSetISColoringType(DM dm,ISColoringType ctype)
3028f1509bcSBarry Smith {
3038f1509bcSBarry Smith   PetscFunctionBegin;
3048f1509bcSBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3058f1509bcSBarry Smith   dm->coloringtype = ctype;
3068f1509bcSBarry Smith   PetscFunctionReturn(0);
3078f1509bcSBarry Smith }
3088f1509bcSBarry Smith 
3098f1509bcSBarry Smith /*@C
3108f1509bcSBarry Smith        DMGetISColoringType - Gets the type of coloring, global or local, that is created by the DM
311521d9a4cSLisandro Dalcin 
312d083f849SBarry Smith    Logically Collective on dm
313521d9a4cSLisandro Dalcin 
314521d9a4cSLisandro Dalcin    Input Parameter:
3158f1509bcSBarry Smith .  dm - the DM context
3168f1509bcSBarry Smith 
3178f1509bcSBarry Smith    Output Parameter:
3188f1509bcSBarry Smith .  ctype - the matrix type
3198f1509bcSBarry Smith 
3208f1509bcSBarry Smith    Options Database:
3218f1509bcSBarry Smith .   -dm_is_coloring_type - global or local
3228f1509bcSBarry Smith 
3238f1509bcSBarry Smith    Level: intermediate
3248f1509bcSBarry Smith 
3258f1509bcSBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMGetMatType(),
3268f1509bcSBarry Smith           DMGetISColoringType()
3278f1509bcSBarry Smith @*/
3288f1509bcSBarry Smith PetscErrorCode  DMGetISColoringType(DM dm,ISColoringType *ctype)
3298f1509bcSBarry Smith {
3308f1509bcSBarry Smith   PetscFunctionBegin;
3318f1509bcSBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3328f1509bcSBarry Smith   *ctype = dm->coloringtype;
3338f1509bcSBarry Smith   PetscFunctionReturn(0);
3348f1509bcSBarry Smith }
3358f1509bcSBarry Smith 
3368f1509bcSBarry Smith /*@C
3378f1509bcSBarry Smith        DMSetMatType - Sets the type of matrix created with DMCreateMatrix()
3388f1509bcSBarry Smith 
339d083f849SBarry Smith    Logically Collective on dm
3408f1509bcSBarry Smith 
3418f1509bcSBarry Smith    Input Parameters:
342521d9a4cSLisandro Dalcin +  dm - the DM context
343a2b5a043SBarry Smith -  ctype - the matrix type
344521d9a4cSLisandro Dalcin 
345521d9a4cSLisandro Dalcin    Options Database:
346521d9a4cSLisandro Dalcin .   -dm_mat_type ctype
347521d9a4cSLisandro Dalcin 
348521d9a4cSLisandro Dalcin    Level: intermediate
349521d9a4cSLisandro Dalcin 
350a2a9ebe5SBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMGetMatType(), DMSetMatType(), DMGetMatType()
351521d9a4cSLisandro Dalcin @*/
35219fd82e9SBarry Smith PetscErrorCode  DMSetMatType(DM dm,MatType ctype)
353521d9a4cSLisandro Dalcin {
354521d9a4cSLisandro Dalcin   PetscErrorCode ierr;
35588f0584fSBarry Smith 
356521d9a4cSLisandro Dalcin   PetscFunctionBegin;
357521d9a4cSLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
358521d9a4cSLisandro Dalcin   ierr = PetscFree(dm->mattype);CHKERRQ(ierr);
35919fd82e9SBarry Smith   ierr = PetscStrallocpy(ctype,(char**)&dm->mattype);CHKERRQ(ierr);
360521d9a4cSLisandro Dalcin   PetscFunctionReturn(0);
361521d9a4cSLisandro Dalcin }
362521d9a4cSLisandro Dalcin 
363c0dedaeaSBarry Smith /*@C
364c0dedaeaSBarry Smith        DMGetMatType - Gets the type of matrix created with DMCreateMatrix()
365c0dedaeaSBarry Smith 
366d083f849SBarry Smith    Logically Collective on dm
367c0dedaeaSBarry Smith 
368c0dedaeaSBarry Smith    Input Parameter:
369c0dedaeaSBarry Smith .  dm - the DM context
370c0dedaeaSBarry Smith 
371c0dedaeaSBarry Smith    Output Parameter:
372c0dedaeaSBarry Smith .  ctype - the matrix type
373c0dedaeaSBarry Smith 
374c0dedaeaSBarry Smith    Options Database:
375c0dedaeaSBarry Smith .   -dm_mat_type ctype
376c0dedaeaSBarry Smith 
377c0dedaeaSBarry Smith    Level: intermediate
378c0dedaeaSBarry Smith 
379a2a9ebe5SBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMSetMatType(), DMSetMatType(), DMGetMatType()
380c0dedaeaSBarry Smith @*/
381c0dedaeaSBarry Smith PetscErrorCode  DMGetMatType(DM dm,MatType *ctype)
382c0dedaeaSBarry Smith {
383c0dedaeaSBarry Smith   PetscFunctionBegin;
384c0dedaeaSBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
385c0dedaeaSBarry Smith   *ctype = dm->mattype;
386c0dedaeaSBarry Smith   PetscFunctionReturn(0);
387c0dedaeaSBarry Smith }
388c0dedaeaSBarry Smith 
389c688c046SMatthew G Knepley /*@
39034f98d34SBarry Smith   MatGetDM - Gets the DM defining the data layout of the matrix
391c688c046SMatthew G Knepley 
392c688c046SMatthew G Knepley   Not collective
393c688c046SMatthew G Knepley 
394c688c046SMatthew G Knepley   Input Parameter:
395c688c046SMatthew G Knepley . A - The Mat
396c688c046SMatthew G Knepley 
397c688c046SMatthew G Knepley   Output Parameter:
398c688c046SMatthew G Knepley . dm - The DM
399c688c046SMatthew G Knepley 
400c688c046SMatthew G Knepley   Level: intermediate
401c688c046SMatthew G Knepley 
4028f1509bcSBarry Smith   Developer Note: Since the Mat class doesn't know about the DM class the DM object is associated with
4038f1509bcSBarry Smith                   the Mat through a PetscObjectCompose() operation
4048f1509bcSBarry Smith 
405c688c046SMatthew G Knepley .seealso: MatSetDM(), DMCreateMatrix(), DMSetMatType()
406c688c046SMatthew G Knepley @*/
407c688c046SMatthew G Knepley PetscErrorCode MatGetDM(Mat A, DM *dm)
408c688c046SMatthew G Knepley {
409c688c046SMatthew G Knepley   PetscErrorCode ierr;
410c688c046SMatthew G Knepley 
411c688c046SMatthew G Knepley   PetscFunctionBegin;
412c688c046SMatthew G Knepley   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
413c688c046SMatthew G Knepley   PetscValidPointer(dm,2);
414c688c046SMatthew G Knepley   ierr = PetscObjectQuery((PetscObject) A, "__PETSc_dm", (PetscObject*) dm);CHKERRQ(ierr);
415c688c046SMatthew G Knepley   PetscFunctionReturn(0);
416c688c046SMatthew G Knepley }
417c688c046SMatthew G Knepley 
418c688c046SMatthew G Knepley /*@
419c688c046SMatthew G Knepley   MatSetDM - Sets the DM defining the data layout of the matrix
420c688c046SMatthew G Knepley 
421c688c046SMatthew G Knepley   Not collective
422c688c046SMatthew G Knepley 
423c688c046SMatthew G Knepley   Input Parameters:
424c688c046SMatthew G Knepley + A - The Mat
425c688c046SMatthew G Knepley - dm - The DM
426c688c046SMatthew G Knepley 
427c688c046SMatthew G Knepley   Level: intermediate
428c688c046SMatthew G Knepley 
4298f1509bcSBarry Smith   Developer Note: Since the Mat class doesn't know about the DM class the DM object is associated with
4308f1509bcSBarry Smith                   the Mat through a PetscObjectCompose() operation
4318f1509bcSBarry Smith 
4328f1509bcSBarry Smith 
433c688c046SMatthew G Knepley .seealso: MatGetDM(), DMCreateMatrix(), DMSetMatType()
434c688c046SMatthew G Knepley @*/
435c688c046SMatthew G Knepley PetscErrorCode MatSetDM(Mat A, DM dm)
436c688c046SMatthew G Knepley {
437c688c046SMatthew G Knepley   PetscErrorCode ierr;
438c688c046SMatthew G Knepley 
439c688c046SMatthew G Knepley   PetscFunctionBegin;
440c688c046SMatthew G Knepley   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
4418865f1eaSKarl Rupp   if (dm) PetscValidHeaderSpecific(dm,DM_CLASSID,2);
442c688c046SMatthew G Knepley   ierr = PetscObjectCompose((PetscObject) A, "__PETSc_dm", (PetscObject) dm);CHKERRQ(ierr);
443c688c046SMatthew G Knepley   PetscFunctionReturn(0);
444c688c046SMatthew G Knepley }
445c688c046SMatthew G Knepley 
4469a42bb27SBarry Smith /*@C
4479a42bb27SBarry Smith    DMSetOptionsPrefix - Sets the prefix used for searching for all
4486757b960SDave May    DM options in the database.
4499a42bb27SBarry Smith 
450d083f849SBarry Smith    Logically Collective on dm
4519a42bb27SBarry Smith 
4529a42bb27SBarry Smith    Input Parameter:
4538353ddbbSDave May +  da - the DM context
4549a42bb27SBarry Smith -  prefix - the prefix to prepend to all option names
4559a42bb27SBarry Smith 
4569a42bb27SBarry Smith    Notes:
4579a42bb27SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
4589a42bb27SBarry Smith    The first character of all runtime options is AUTOMATICALLY the hyphen.
4599a42bb27SBarry Smith 
4609a42bb27SBarry Smith    Level: advanced
4619a42bb27SBarry Smith 
4629a42bb27SBarry Smith .seealso: DMSetFromOptions()
4639a42bb27SBarry Smith @*/
4647087cfbeSBarry Smith PetscErrorCode  DMSetOptionsPrefix(DM dm,const char prefix[])
4659a42bb27SBarry Smith {
4669a42bb27SBarry Smith   PetscErrorCode ierr;
4679a42bb27SBarry Smith 
4689a42bb27SBarry Smith   PetscFunctionBegin;
4699a42bb27SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
4709a42bb27SBarry Smith   ierr = PetscObjectSetOptionsPrefix((PetscObject)dm,prefix);CHKERRQ(ierr);
471691be533SLawrence Mitchell   if (dm->sf) {
472691be533SLawrence Mitchell     ierr = PetscObjectSetOptionsPrefix((PetscObject)dm->sf,prefix);CHKERRQ(ierr);
473691be533SLawrence Mitchell   }
4741bb6d2a8SBarry Smith   if (dm->sectionSF) {
4751bb6d2a8SBarry Smith     ierr = PetscObjectSetOptionsPrefix((PetscObject)dm->sectionSF,prefix);CHKERRQ(ierr);
476691be533SLawrence Mitchell   }
4779a42bb27SBarry Smith   PetscFunctionReturn(0);
4789a42bb27SBarry Smith }
4799a42bb27SBarry Smith 
48031697293SDave May /*@C
48131697293SDave May    DMAppendOptionsPrefix - Appends to the prefix used for searching for all
48231697293SDave May    DM options in the database.
48331697293SDave May 
484d083f849SBarry Smith    Logically Collective on dm
48531697293SDave May 
48631697293SDave May    Input Parameters:
48731697293SDave May +  dm - the DM context
48831697293SDave May -  prefix - the prefix string to prepend to all DM option requests
48931697293SDave May 
49031697293SDave May    Notes:
49131697293SDave May    A hyphen (-) must NOT be given at the beginning of the prefix name.
49231697293SDave May    The first character of all runtime options is AUTOMATICALLY the hyphen.
49331697293SDave May 
49431697293SDave May    Level: advanced
49531697293SDave May 
49631697293SDave May .seealso: DMSetOptionsPrefix(), DMGetOptionsPrefix()
49731697293SDave May @*/
49831697293SDave May PetscErrorCode  DMAppendOptionsPrefix(DM dm,const char prefix[])
49931697293SDave May {
50031697293SDave May   PetscErrorCode ierr;
50131697293SDave May 
50231697293SDave May   PetscFunctionBegin;
50331697293SDave May   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
50431697293SDave May   ierr = PetscObjectAppendOptionsPrefix((PetscObject)dm,prefix);CHKERRQ(ierr);
50531697293SDave May   PetscFunctionReturn(0);
50631697293SDave May }
50731697293SDave May 
50831697293SDave May /*@C
50931697293SDave May    DMGetOptionsPrefix - Gets the prefix used for searching for all
51031697293SDave May    DM options in the database.
51131697293SDave May 
51231697293SDave May    Not Collective
51331697293SDave May 
51431697293SDave May    Input Parameters:
51531697293SDave May .  dm - the DM context
51631697293SDave May 
51731697293SDave May    Output Parameters:
51831697293SDave May .  prefix - pointer to the prefix string used is returned
51931697293SDave May 
52095452b02SPatrick Sanan    Notes:
52195452b02SPatrick Sanan     On the fortran side, the user should pass in a string 'prefix' of
52231697293SDave May    sufficient length to hold the prefix.
52331697293SDave May 
52431697293SDave May    Level: advanced
52531697293SDave May 
52631697293SDave May .seealso: DMSetOptionsPrefix(), DMAppendOptionsPrefix()
52731697293SDave May @*/
52831697293SDave May PetscErrorCode  DMGetOptionsPrefix(DM dm,const char *prefix[])
52931697293SDave May {
53031697293SDave May   PetscErrorCode ierr;
53131697293SDave May 
53231697293SDave May   PetscFunctionBegin;
53331697293SDave May   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
53431697293SDave May   ierr = PetscObjectGetOptionsPrefix((PetscObject)dm,prefix);CHKERRQ(ierr);
53531697293SDave May   PetscFunctionReturn(0);
53631697293SDave May }
53731697293SDave May 
53888bdff64SToby Isaac static PetscErrorCode DMCountNonCyclicReferences(DM dm, PetscBool recurseCoarse, PetscBool recurseFine, PetscInt *ncrefct)
53988bdff64SToby Isaac {
5406eb26441SStefano Zampini   PetscInt       refct = ((PetscObject) dm)->refct;
54188bdff64SToby Isaac   PetscErrorCode ierr;
54288bdff64SToby Isaac 
54388bdff64SToby Isaac   PetscFunctionBegin;
544aab5bcd8SJed Brown   *ncrefct = 0;
54588bdff64SToby Isaac   if (dm->coarseMesh && dm->coarseMesh->fineMesh == dm) {
54688bdff64SToby Isaac     refct--;
54788bdff64SToby Isaac     if (recurseCoarse) {
54888bdff64SToby Isaac       PetscInt coarseCount;
54988bdff64SToby Isaac 
55088bdff64SToby Isaac       ierr = DMCountNonCyclicReferences(dm->coarseMesh, PETSC_TRUE, PETSC_FALSE,&coarseCount);CHKERRQ(ierr);
55188bdff64SToby Isaac       refct += coarseCount;
55288bdff64SToby Isaac     }
55388bdff64SToby Isaac   }
55488bdff64SToby Isaac   if (dm->fineMesh && dm->fineMesh->coarseMesh == dm) {
55588bdff64SToby Isaac     refct--;
55688bdff64SToby Isaac     if (recurseFine) {
55788bdff64SToby Isaac       PetscInt fineCount;
55888bdff64SToby Isaac 
55988bdff64SToby Isaac       ierr = DMCountNonCyclicReferences(dm->fineMesh, PETSC_FALSE, PETSC_TRUE,&fineCount);CHKERRQ(ierr);
56088bdff64SToby Isaac       refct += fineCount;
56188bdff64SToby Isaac     }
56288bdff64SToby Isaac   }
56388bdff64SToby Isaac   *ncrefct = refct;
56488bdff64SToby Isaac   PetscFunctionReturn(0);
56588bdff64SToby Isaac }
56688bdff64SToby Isaac 
567f4cdcedcSVaclav Hapla PetscErrorCode DMDestroyLabelLinkList_Internal(DM dm)
568354557abSToby Isaac {
5695d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
570354557abSToby Isaac   PetscErrorCode ierr;
571354557abSToby Isaac 
572354557abSToby Isaac   PetscFunctionBegin;
573354557abSToby Isaac   /* destroy the labels */
574354557abSToby Isaac   while (next) {
575354557abSToby Isaac     DMLabelLink tmp = next->next;
576354557abSToby Isaac 
5775d80c0bfSVaclav Hapla     if (next->label == dm->depthLabel)    dm->depthLabel    = NULL;
578ba2698f1SMatthew G. Knepley     if (next->label == dm->celltypeLabel) dm->celltypeLabel = NULL;
579354557abSToby Isaac     ierr = DMLabelDestroy(&next->label);CHKERRQ(ierr);
580354557abSToby Isaac     ierr = PetscFree(next);CHKERRQ(ierr);
581354557abSToby Isaac     next = tmp;
582354557abSToby Isaac   }
5835d80c0bfSVaclav Hapla   dm->labels = NULL;
584354557abSToby Isaac   PetscFunctionReturn(0);
585354557abSToby Isaac }
586354557abSToby Isaac 
58747c6ae99SBarry Smith /*@
5888472ad0fSDave May     DMDestroy - Destroys a vector packer or DM.
58947c6ae99SBarry Smith 
590d083f849SBarry Smith     Collective on dm
59147c6ae99SBarry Smith 
59247c6ae99SBarry Smith     Input Parameter:
59347c6ae99SBarry Smith .   dm - the DM object to destroy
59447c6ae99SBarry Smith 
59547c6ae99SBarry Smith     Level: developer
59647c6ae99SBarry Smith 
597e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
59847c6ae99SBarry Smith 
59947c6ae99SBarry Smith @*/
600fcfd50ebSBarry Smith PetscErrorCode  DMDestroy(DM *dm)
60147c6ae99SBarry Smith {
6026eb26441SStefano Zampini   PetscInt       cnt;
603dfe15315SJed Brown   DMNamedVecLink nlink,nnext;
60447c6ae99SBarry Smith   PetscErrorCode ierr;
60547c6ae99SBarry Smith 
60647c6ae99SBarry Smith   PetscFunctionBegin;
6076bf464f9SBarry Smith   if (!*dm) PetscFunctionReturn(0);
6086bf464f9SBarry Smith   PetscValidHeaderSpecific((*dm),DM_CLASSID,1);
60987e657c6SBarry Smith 
61088bdff64SToby Isaac   /* count all non-cyclic references in the doubly-linked list of coarse<->fine meshes */
61188bdff64SToby Isaac   ierr = DMCountNonCyclicReferences(*dm,PETSC_TRUE,PETSC_TRUE,&cnt);CHKERRQ(ierr);
61288bdff64SToby Isaac   --((PetscObject)(*dm))->refct;
613ea78f98cSLisandro Dalcin   if (--cnt > 0) {*dm = NULL; PetscFunctionReturn(0);}
6146bf464f9SBarry Smith   if (((PetscObject)(*dm))->refct < 0) PetscFunctionReturn(0);
6156bf464f9SBarry Smith   ((PetscObject)(*dm))->refct = 0;
6166eb26441SStefano Zampini 
6176eb26441SStefano Zampini   ierr = DMClearGlobalVectors(*dm);CHKERRQ(ierr);
6186eb26441SStefano Zampini   ierr = DMClearLocalVectors(*dm);CHKERRQ(ierr);
6196eb26441SStefano Zampini 
620f490541aSPeter Brune   nnext=(*dm)->namedglobal;
6210298fd71SBarry Smith   (*dm)->namedglobal = NULL;
622f490541aSPeter Brune   for (nlink=nnext; nlink; nlink=nnext) { /* Destroy the named vectors */
6232348bcf4SPeter Brune     nnext = nlink->next;
6242348bcf4SPeter 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);
6252348bcf4SPeter Brune     ierr = PetscFree(nlink->name);CHKERRQ(ierr);
6262348bcf4SPeter Brune     ierr = VecDestroy(&nlink->X);CHKERRQ(ierr);
6272348bcf4SPeter Brune     ierr = PetscFree(nlink);CHKERRQ(ierr);
6282348bcf4SPeter Brune   }
629f490541aSPeter Brune   nnext=(*dm)->namedlocal;
6300298fd71SBarry Smith   (*dm)->namedlocal = NULL;
631f490541aSPeter Brune   for (nlink=nnext; nlink; nlink=nnext) { /* Destroy the named local vectors */
632f490541aSPeter Brune     nnext = nlink->next;
633f490541aSPeter 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);
634f490541aSPeter Brune     ierr = PetscFree(nlink->name);CHKERRQ(ierr);
635f490541aSPeter Brune     ierr = VecDestroy(&nlink->X);CHKERRQ(ierr);
636f490541aSPeter Brune     ierr = PetscFree(nlink);CHKERRQ(ierr);
637f490541aSPeter Brune   }
6382348bcf4SPeter Brune 
639b17ce1afSJed Brown   /* Destroy the list of hooks */
640c833c3b5SJed Brown   {
641c833c3b5SJed Brown     DMCoarsenHookLink link,next;
642b17ce1afSJed Brown     for (link=(*dm)->coarsenhook; link; link=next) {
643b17ce1afSJed Brown       next = link->next;
644b17ce1afSJed Brown       ierr = PetscFree(link);CHKERRQ(ierr);
645b17ce1afSJed Brown     }
6460298fd71SBarry Smith     (*dm)->coarsenhook = NULL;
647c833c3b5SJed Brown   }
648c833c3b5SJed Brown   {
649c833c3b5SJed Brown     DMRefineHookLink link,next;
650c833c3b5SJed Brown     for (link=(*dm)->refinehook; link; link=next) {
651c833c3b5SJed Brown       next = link->next;
652c833c3b5SJed Brown       ierr = PetscFree(link);CHKERRQ(ierr);
653c833c3b5SJed Brown     }
6540298fd71SBarry Smith     (*dm)->refinehook = NULL;
655c833c3b5SJed Brown   }
656be081cd6SPeter Brune   {
657be081cd6SPeter Brune     DMSubDomainHookLink link,next;
658be081cd6SPeter Brune     for (link=(*dm)->subdomainhook; link; link=next) {
659be081cd6SPeter Brune       next = link->next;
660be081cd6SPeter Brune       ierr = PetscFree(link);CHKERRQ(ierr);
661be081cd6SPeter Brune     }
6620298fd71SBarry Smith     (*dm)->subdomainhook = NULL;
663be081cd6SPeter Brune   }
664baf369e7SPeter Brune   {
665baf369e7SPeter Brune     DMGlobalToLocalHookLink link,next;
666baf369e7SPeter Brune     for (link=(*dm)->gtolhook; link; link=next) {
667baf369e7SPeter Brune       next = link->next;
668baf369e7SPeter Brune       ierr = PetscFree(link);CHKERRQ(ierr);
669baf369e7SPeter Brune     }
6700298fd71SBarry Smith     (*dm)->gtolhook = NULL;
671baf369e7SPeter Brune   }
672d4d07f1eSToby Isaac   {
673d4d07f1eSToby Isaac     DMLocalToGlobalHookLink link,next;
674d4d07f1eSToby Isaac     for (link=(*dm)->ltoghook; link; link=next) {
675d4d07f1eSToby Isaac       next = link->next;
676d4d07f1eSToby Isaac       ierr = PetscFree(link);CHKERRQ(ierr);
677d4d07f1eSToby Isaac     }
678d4d07f1eSToby Isaac     (*dm)->ltoghook = NULL;
679d4d07f1eSToby Isaac   }
680aa1993deSMatthew G Knepley   /* Destroy the work arrays */
681aa1993deSMatthew G Knepley   {
682aa1993deSMatthew G Knepley     DMWorkLink link,next;
683aa1993deSMatthew G Knepley     if ((*dm)->workout) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Work array still checked out");
684aa1993deSMatthew G Knepley     for (link=(*dm)->workin; link; link=next) {
685aa1993deSMatthew G Knepley       next = link->next;
686aa1993deSMatthew G Knepley       ierr = PetscFree(link->mem);CHKERRQ(ierr);
687aa1993deSMatthew G Knepley       ierr = PetscFree(link);CHKERRQ(ierr);
688aa1993deSMatthew G Knepley     }
6890298fd71SBarry Smith     (*dm)->workin = NULL;
690aa1993deSMatthew G Knepley   }
691c58f1c22SToby Isaac   /* destroy the labels */
692f4cdcedcSVaclav Hapla   ierr = DMDestroyLabelLinkList_Internal(*dm);CHKERRQ(ierr);
693f4cdcedcSVaclav Hapla   /* destroy the fields */
694e5e52638SMatthew G. Knepley   ierr = DMClearFields(*dm);CHKERRQ(ierr);
695f4cdcedcSVaclav Hapla   /* destroy the boundaries */
696e6f8dbb6SToby Isaac   {
697e6f8dbb6SToby Isaac     DMBoundary next = (*dm)->boundary;
698e6f8dbb6SToby Isaac     while (next) {
699e6f8dbb6SToby Isaac       DMBoundary b = next;
700e6f8dbb6SToby Isaac 
701e6f8dbb6SToby Isaac       next = b->next;
702e6f8dbb6SToby Isaac       ierr = PetscFree(b);CHKERRQ(ierr);
703e6f8dbb6SToby Isaac     }
704e6f8dbb6SToby Isaac   }
705b17ce1afSJed Brown 
70652536dc3SBarry Smith   ierr = PetscObjectDestroy(&(*dm)->dmksp);CHKERRQ(ierr);
70752536dc3SBarry Smith   ierr = PetscObjectDestroy(&(*dm)->dmsnes);CHKERRQ(ierr);
70852536dc3SBarry Smith   ierr = PetscObjectDestroy(&(*dm)->dmts);CHKERRQ(ierr);
70952536dc3SBarry Smith 
7101a266240SBarry Smith   if ((*dm)->ctx && (*dm)->ctxdestroy) {
7111a266240SBarry Smith     ierr = (*(*dm)->ctxdestroy)(&(*dm)->ctx);CHKERRQ(ierr);
7121a266240SBarry Smith   }
71371cd77b2SBarry Smith   ierr = MatFDColoringDestroy(&(*dm)->fd);CHKERRQ(ierr);
7146bf464f9SBarry Smith   ierr = ISLocalToGlobalMappingDestroy(&(*dm)->ltogmap);CHKERRQ(ierr);
7156bf464f9SBarry Smith   ierr = PetscFree((*dm)->vectype);CHKERRQ(ierr);
716073dac72SJed Brown   ierr = PetscFree((*dm)->mattype);CHKERRQ(ierr);
71788ed4aceSMatthew G Knepley 
7181bb6d2a8SBarry Smith   ierr = PetscSectionDestroy(&(*dm)->localSection);CHKERRQ(ierr);
7191bb6d2a8SBarry Smith   ierr = PetscSectionDestroy(&(*dm)->globalSection);CHKERRQ(ierr);
7208b1ab98fSJed Brown   ierr = PetscLayoutDestroy(&(*dm)->map);CHKERRQ(ierr);
721fba222abSToby Isaac   ierr = PetscSectionDestroy(&(*dm)->defaultConstraintSection);CHKERRQ(ierr);
722fba222abSToby Isaac   ierr = MatDestroy(&(*dm)->defaultConstraintMat);CHKERRQ(ierr);
72388ed4aceSMatthew G Knepley   ierr = PetscSFDestroy(&(*dm)->sf);CHKERRQ(ierr);
7241bb6d2a8SBarry Smith   ierr = PetscSFDestroy(&(*dm)->sectionSF);CHKERRQ(ierr);
725736995cdSBlaise Bourdin   if ((*dm)->useNatural) {
726736995cdSBlaise Bourdin     if ((*dm)->sfNatural) {
7278e4ac7eaSMatthew G. Knepley       ierr = PetscSFDestroy(&(*dm)->sfNatural);CHKERRQ(ierr);
728736995cdSBlaise Bourdin     }
729736995cdSBlaise Bourdin     ierr = PetscObjectDereference((PetscObject) (*dm)->sfMigration);CHKERRQ(ierr);
730736995cdSBlaise Bourdin   }
73188bdff64SToby Isaac   if ((*dm)->coarseMesh && (*dm)->coarseMesh->fineMesh == *dm) {
73288bdff64SToby Isaac     ierr = DMSetFineDM((*dm)->coarseMesh,NULL);CHKERRQ(ierr);
73388bdff64SToby Isaac   }
7346eb26441SStefano Zampini 
735a8fb8f29SToby Isaac   ierr = DMDestroy(&(*dm)->coarseMesh);CHKERRQ(ierr);
73688bdff64SToby Isaac   if ((*dm)->fineMesh && (*dm)->fineMesh->coarseMesh == *dm) {
73788bdff64SToby Isaac     ierr = DMSetCoarseDM((*dm)->fineMesh,NULL);CHKERRQ(ierr);
73888bdff64SToby Isaac   }
73988bdff64SToby Isaac   ierr = DMDestroy(&(*dm)->fineMesh);CHKERRQ(ierr);
740f19dbd58SToby Isaac   ierr = DMFieldDestroy(&(*dm)->coordinateField);CHKERRQ(ierr);
7416636e97aSMatthew G Knepley   ierr = DMDestroy(&(*dm)->coordinateDM);CHKERRQ(ierr);
7426636e97aSMatthew G Knepley   ierr = VecDestroy(&(*dm)->coordinates);CHKERRQ(ierr);
7436636e97aSMatthew G Knepley   ierr = VecDestroy(&(*dm)->coordinatesLocal);CHKERRQ(ierr);
744412e9a14SMatthew G. Knepley   ierr = PetscFree((*dm)->L);CHKERRQ(ierr);
745412e9a14SMatthew G. Knepley   ierr = PetscFree((*dm)->maxCell);CHKERRQ(ierr);
746412e9a14SMatthew G. Knepley   ierr = PetscFree((*dm)->bdtype);CHKERRQ(ierr);
747ca3d3a14SMatthew G. Knepley   if ((*dm)->transformDestroy) {ierr = (*(*dm)->transformDestroy)(*dm, (*dm)->transformCtx);CHKERRQ(ierr);}
748ca3d3a14SMatthew G. Knepley   ierr = DMDestroy(&(*dm)->transformDM);CHKERRQ(ierr);
749ca3d3a14SMatthew G. Knepley   ierr = VecDestroy(&(*dm)->transform);CHKERRQ(ierr);
7506636e97aSMatthew G Knepley 
751e5e52638SMatthew G. Knepley   ierr = DMClearDS(*dm);CHKERRQ(ierr);
75214f150ffSMatthew G. Knepley   ierr = DMDestroy(&(*dm)->dmBC);CHKERRQ(ierr);
753e04113cfSBarry Smith   /* if memory was published with SAWs then destroy it */
754e04113cfSBarry Smith   ierr = PetscObjectSAWsViewOff((PetscObject)*dm);CHKERRQ(ierr);
755732e2eb9SMatthew G Knepley 
756ed3c66a1SDave May   if ((*dm)->ops->destroy) {
7576bf464f9SBarry Smith     ierr = (*(*dm)->ops->destroy)(*dm);CHKERRQ(ierr);
758ed3c66a1SDave May   }
759c0f0dcc3SMatthew G. Knepley   ierr = DMMonitorCancel(*dm);CHKERRQ(ierr);
760435a35e8SMatthew G Knepley   /* We do not destroy (*dm)->data here so that we can reference count backend objects */
761732e2eb9SMatthew G Knepley   ierr = PetscHeaderDestroy(dm);CHKERRQ(ierr);
76247c6ae99SBarry Smith   PetscFunctionReturn(0);
76347c6ae99SBarry Smith }
76447c6ae99SBarry Smith 
765d7bf68aeSBarry Smith /*@
766d7bf68aeSBarry Smith     DMSetUp - sets up the data structures inside a DM object
767d7bf68aeSBarry Smith 
768d083f849SBarry Smith     Collective on dm
769d7bf68aeSBarry Smith 
770d7bf68aeSBarry Smith     Input Parameter:
771d7bf68aeSBarry Smith .   dm - the DM object to setup
772d7bf68aeSBarry Smith 
773d7bf68aeSBarry Smith     Level: developer
774d7bf68aeSBarry Smith 
775e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
776d7bf68aeSBarry Smith 
777d7bf68aeSBarry Smith @*/
7787087cfbeSBarry Smith PetscErrorCode  DMSetUp(DM dm)
779d7bf68aeSBarry Smith {
780d7bf68aeSBarry Smith   PetscErrorCode ierr;
781d7bf68aeSBarry Smith 
782d7bf68aeSBarry Smith   PetscFunctionBegin;
783171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
7848387afaaSJed Brown   if (dm->setupcalled) PetscFunctionReturn(0);
785d7bf68aeSBarry Smith   if (dm->ops->setup) {
786d7bf68aeSBarry Smith     ierr = (*dm->ops->setup)(dm);CHKERRQ(ierr);
787d7bf68aeSBarry Smith   }
7888387afaaSJed Brown   dm->setupcalled = PETSC_TRUE;
789d7bf68aeSBarry Smith   PetscFunctionReturn(0);
790d7bf68aeSBarry Smith }
791d7bf68aeSBarry Smith 
792d7bf68aeSBarry Smith /*@
793d7bf68aeSBarry Smith     DMSetFromOptions - sets parameters in a DM from the options database
794d7bf68aeSBarry Smith 
795d083f849SBarry Smith     Collective on dm
796d7bf68aeSBarry Smith 
797d7bf68aeSBarry Smith     Input Parameter:
798d7bf68aeSBarry Smith .   dm - the DM object to set options for
799d7bf68aeSBarry Smith 
800732e2eb9SMatthew G Knepley     Options Database:
8014164ae61SDominic Meiser +   -dm_preallocate_only - Only preallocate the matrix for DMCreateMatrix(), but do not fill it with zeros
8024164ae61SDominic Meiser .   -dm_vec_type <type>  - type of vector to create inside DM
8034164ae61SDominic Meiser .   -dm_mat_type <type>  - type of matrix to create inside DM
8048f1509bcSBarry Smith -   -dm_is_coloring_type - <global or local>
805732e2eb9SMatthew G Knepley 
806384a6580SVaclav Hapla     DMPLEX Specific Checks
807384a6580SVaclav Hapla +   -dm_plex_check_symmetry        - Check that the adjacency information in the mesh is symmetric - DMPlexCheckSymmetry()
808384a6580SVaclav Hapla .   -dm_plex_check_skeleton        - Check that each cell has the correct number of vertices (only for homogeneous simplex or tensor meshes) - DMPlexCheckSkeleton()
809384a6580SVaclav Hapla .   -dm_plex_check_faces           - Check that the faces of each cell give a vertex order this is consistent with what we expect from the cell type - DMPlexCheckFaces()
810384a6580SVaclav Hapla .   -dm_plex_check_geometry        - Check that cells have positive volume - DMPlexCheckGeometry()
811384a6580SVaclav Hapla .   -dm_plex_check_pointsf         - Check some necessary conditions for PointSF - DMPlexCheckPointSF()
812384a6580SVaclav Hapla .   -dm_plex_check_interface_cones - Check points on inter-partition interfaces have conforming order of cone points - DMPlexCheckInterfaceCones()
813384a6580SVaclav Hapla -   -dm_plex_check_all             - Perform all the checks above
814d7bf68aeSBarry Smith 
81595eb5ee5SVaclav Hapla     Level: intermediate
81695eb5ee5SVaclav Hapla 
81795eb5ee5SVaclav Hapla .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(),
81895eb5ee5SVaclav Hapla     DMPlexCheckSymmetry(), DMPlexCheckSkeleton(), DMPlexCheckFaces(), DMPlexCheckGeometry(), DMPlexCheckPointSF(), DMPlexCheckInterfaceCones()
819d7bf68aeSBarry Smith 
820d7bf68aeSBarry Smith @*/
8217087cfbeSBarry Smith PetscErrorCode DMSetFromOptions(DM dm)
822d7bf68aeSBarry Smith {
8237781c08eSBarry Smith   char           typeName[256];
824ca266f36SBarry Smith   PetscBool      flg;
825d7bf68aeSBarry Smith   PetscErrorCode ierr;
826d7bf68aeSBarry Smith 
827d7bf68aeSBarry Smith   PetscFunctionBegin;
828171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
82949be4549SMatthew G. Knepley   dm->setfromoptionscalled = PETSC_TRUE;
83049be4549SMatthew G. Knepley   if (dm->sf) {ierr = PetscSFSetFromOptions(dm->sf);CHKERRQ(ierr);}
8311bb6d2a8SBarry Smith   if (dm->sectionSF) {ierr = PetscSFSetFromOptions(dm->sectionSF);CHKERRQ(ierr);}
8323194b578SJed Brown   ierr = PetscObjectOptionsBegin((PetscObject)dm);CHKERRQ(ierr);
8330298fd71SBarry 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);
834a264d7a6SBarry Smith   ierr = PetscOptionsFList("-dm_vec_type","Vector type used for created vectors","DMSetVecType",VecList,dm->vectype,typeName,256,&flg);CHKERRQ(ierr);
835f9ba7244SBarry Smith   if (flg) {
836f9ba7244SBarry Smith     ierr = DMSetVecType(dm,typeName);CHKERRQ(ierr);
837f9ba7244SBarry Smith   }
838a264d7a6SBarry 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);
839073dac72SJed Brown   if (flg) {
840521d9a4cSLisandro Dalcin     ierr = DMSetMatType(dm,typeName);CHKERRQ(ierr);
841073dac72SJed Brown   }
8428f1509bcSBarry Smith   ierr = PetscOptionsEnum("-dm_is_coloring_type","Global or local coloring of Jacobian","DMSetISColoringType",ISColoringTypes,(PetscEnum)dm->coloringtype,(PetscEnum*)&dm->coloringtype,NULL);CHKERRQ(ierr);
843f9ba7244SBarry Smith   if (dm->ops->setfromoptions) {
844e55864a3SBarry Smith     ierr = (*dm->ops->setfromoptions)(PetscOptionsObject,dm);CHKERRQ(ierr);
845f9ba7244SBarry Smith   }
846f9ba7244SBarry Smith   /* process any options handlers added with PetscObjectAddOptionsHandler() */
8470633abcbSJed Brown   ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject) dm);CHKERRQ(ierr);
84882fcb398SMatthew G Knepley   ierr = PetscOptionsEnd();CHKERRQ(ierr);
849d7bf68aeSBarry Smith   PetscFunctionReturn(0);
850d7bf68aeSBarry Smith }
851d7bf68aeSBarry Smith 
852fc9bc008SSatish Balay /*@C
853fe2efc57SMark    DMViewFromOptions - View from Options
854fe2efc57SMark 
855fe2efc57SMark    Collective on DM
856fe2efc57SMark 
857fe2efc57SMark    Input Parameters:
858fe2efc57SMark +  dm - the DM object
859736c3998SJose E. Roman .  obj - Optional object
860736c3998SJose E. Roman -  name - command line option
861fe2efc57SMark 
862fe2efc57SMark    Level: intermediate
863fe2efc57SMark .seealso:  DM, DMView, PetscObjectViewFromOptions(), DMCreate()
864fe2efc57SMark @*/
865fe2efc57SMark PetscErrorCode  DMViewFromOptions(DM dm,PetscObject obj,const char name[])
866fe2efc57SMark {
867fe2efc57SMark   PetscErrorCode ierr;
868fe2efc57SMark 
869fe2efc57SMark   PetscFunctionBegin;
870fe2efc57SMark   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
871fe2efc57SMark   ierr = PetscObjectViewFromOptions((PetscObject)dm,obj,name);CHKERRQ(ierr);
872fe2efc57SMark   PetscFunctionReturn(0);
873fe2efc57SMark }
874fe2efc57SMark 
875fe2efc57SMark /*@C
876224748a4SBarry Smith     DMView - Views a DM
87747c6ae99SBarry Smith 
878d083f849SBarry Smith     Collective on dm
87947c6ae99SBarry Smith 
88047c6ae99SBarry Smith     Input Parameter:
88147c6ae99SBarry Smith +   dm - the DM object to view
88247c6ae99SBarry Smith -   v - the viewer
88347c6ae99SBarry Smith 
884224748a4SBarry Smith     Level: beginner
88547c6ae99SBarry Smith 
886e727c939SJed Brown .seealso DMDestroy(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
88747c6ae99SBarry Smith 
88847c6ae99SBarry Smith @*/
8897087cfbeSBarry Smith PetscErrorCode  DMView(DM dm,PetscViewer v)
89047c6ae99SBarry Smith {
89147c6ae99SBarry Smith   PetscErrorCode    ierr;
89232c0f0efSBarry Smith   PetscBool         isbinary;
89376a8abe0SBarry Smith   PetscMPIInt       size;
89476a8abe0SBarry Smith   PetscViewerFormat format;
89547c6ae99SBarry Smith 
89647c6ae99SBarry Smith   PetscFunctionBegin;
897171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
8983014e516SBarry Smith   if (!v) {
899ce94432eSBarry Smith     ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)dm),&v);CHKERRQ(ierr);
9003014e516SBarry Smith   }
901b1b135c8SBarry Smith   PetscValidHeaderSpecific(v,PETSC_VIEWER_CLASSID,2);
90274903a4fSStefano Zampini   /* Ideally, we would like to have this test on.
90374903a4fSStefano Zampini      However, it currently breaks socket viz via GLVis.
90474903a4fSStefano Zampini      During DMView(parallel_mesh,glvis_viewer), each
90574903a4fSStefano Zampini      process opens a sequential ASCII socket to visualize
90674903a4fSStefano Zampini      the local mesh, and PetscObjectView(dm,local_socket)
90774903a4fSStefano Zampini      is internally called inside VecView_GLVis, incurring
90874903a4fSStefano Zampini      in an error here */
90974903a4fSStefano Zampini   /* PetscCheckSameComm(dm,1,v,2); */
9108bfd1ab9SVaclav Hapla   ierr = PetscViewerCheckWritable(v);CHKERRQ(ierr);
911b1b135c8SBarry Smith 
91276a8abe0SBarry Smith   ierr = PetscViewerGetFormat(v,&format);CHKERRQ(ierr);
91376a8abe0SBarry Smith   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)dm),&size);CHKERRQ(ierr);
91476a8abe0SBarry Smith   if (size == 1 && format == PETSC_VIEWER_LOAD_BALANCE) PetscFunctionReturn(0);
91598c3331eSBarry Smith   ierr = PetscObjectPrintClassNamePrefixType((PetscObject)dm,v);CHKERRQ(ierr);
91632c0f0efSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)v,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
91732c0f0efSBarry Smith   if (isbinary) {
91855849f57SBarry Smith     PetscInt classid = DM_FILE_CLASSID;
91932c0f0efSBarry Smith     char     type[256];
92032c0f0efSBarry Smith 
921f253e43cSLisandro Dalcin     ierr = PetscViewerBinaryWrite(v,&classid,1,PETSC_INT);CHKERRQ(ierr);
92232c0f0efSBarry Smith     ierr = PetscStrncpy(type,((PetscObject)dm)->type_name,256);CHKERRQ(ierr);
923f253e43cSLisandro Dalcin     ierr = PetscViewerBinaryWrite(v,type,256,PETSC_CHAR);CHKERRQ(ierr);
92432c0f0efSBarry Smith   }
9250c010503SBarry Smith   if (dm->ops->view) {
9260c010503SBarry Smith     ierr = (*dm->ops->view)(dm,v);CHKERRQ(ierr);
92747c6ae99SBarry Smith   }
92847c6ae99SBarry Smith   PetscFunctionReturn(0);
92947c6ae99SBarry Smith }
93047c6ae99SBarry Smith 
93147c6ae99SBarry Smith /*@
9328472ad0fSDave May     DMCreateGlobalVector - Creates a global vector from a DM object
93347c6ae99SBarry Smith 
934d083f849SBarry Smith     Collective on dm
93547c6ae99SBarry Smith 
93647c6ae99SBarry Smith     Input Parameter:
93747c6ae99SBarry Smith .   dm - the DM object
93847c6ae99SBarry Smith 
93947c6ae99SBarry Smith     Output Parameter:
94047c6ae99SBarry Smith .   vec - the global vector
94147c6ae99SBarry Smith 
942073dac72SJed Brown     Level: beginner
94347c6ae99SBarry Smith 
944e727c939SJed Brown .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
94547c6ae99SBarry Smith 
94647c6ae99SBarry Smith @*/
9477087cfbeSBarry Smith PetscErrorCode  DMCreateGlobalVector(DM dm,Vec *vec)
94847c6ae99SBarry Smith {
94947c6ae99SBarry Smith   PetscErrorCode ierr;
95047c6ae99SBarry Smith 
95147c6ae99SBarry Smith   PetscFunctionBegin;
952171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
953b9d85ea2SLisandro Dalcin   PetscValidPointer(vec,2);
954b9d85ea2SLisandro Dalcin   if (!dm->ops->createglobalvector) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateGlobalVector",((PetscObject)dm)->type_name);
95547c6ae99SBarry Smith   ierr = (*dm->ops->createglobalvector)(dm,vec);CHKERRQ(ierr);
95676bd3646SJed Brown   if (PetscDefined(USE_DEBUG)) {
957c6b011d8SStefano Zampini     DM vdm;
958c6b011d8SStefano Zampini 
959c6b011d8SStefano Zampini     ierr = VecGetDM(*vec,&vdm);CHKERRQ(ierr);
960c6b011d8SStefano Zampini     if (!vdm) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_PLIB,"DM type '%s' did not attach the DM to the vector\n",((PetscObject)dm)->type_name);
961c6b011d8SStefano Zampini   }
96247c6ae99SBarry Smith   PetscFunctionReturn(0);
96347c6ae99SBarry Smith }
96447c6ae99SBarry Smith 
96547c6ae99SBarry Smith /*@
9668472ad0fSDave May     DMCreateLocalVector - Creates a local vector from a DM object
96747c6ae99SBarry Smith 
96847c6ae99SBarry Smith     Not Collective
96947c6ae99SBarry Smith 
97047c6ae99SBarry Smith     Input Parameter:
97147c6ae99SBarry Smith .   dm - the DM object
97247c6ae99SBarry Smith 
97347c6ae99SBarry Smith     Output Parameter:
97447c6ae99SBarry Smith .   vec - the local vector
97547c6ae99SBarry Smith 
976073dac72SJed Brown     Level: beginner
97747c6ae99SBarry Smith 
978e727c939SJed Brown .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
97947c6ae99SBarry Smith 
98047c6ae99SBarry Smith @*/
9817087cfbeSBarry Smith PetscErrorCode  DMCreateLocalVector(DM dm,Vec *vec)
98247c6ae99SBarry Smith {
98347c6ae99SBarry Smith   PetscErrorCode ierr;
98447c6ae99SBarry Smith 
98547c6ae99SBarry Smith   PetscFunctionBegin;
986171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
987b9d85ea2SLisandro Dalcin   PetscValidPointer(vec,2);
988b9d85ea2SLisandro Dalcin   if (!dm->ops->createlocalvector) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateLocalVector",((PetscObject)dm)->type_name);
98947c6ae99SBarry Smith   ierr = (*dm->ops->createlocalvector)(dm,vec);CHKERRQ(ierr);
99076bd3646SJed Brown   if (PetscDefined(USE_DEBUG)) {
991c6b011d8SStefano Zampini     DM vdm;
992c6b011d8SStefano Zampini 
993c6b011d8SStefano Zampini     ierr = VecGetDM(*vec,&vdm);CHKERRQ(ierr);
994c6b011d8SStefano Zampini     if (!vdm) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_LIB,"DM type '%s' did not attach the DM to the vector\n",((PetscObject)dm)->type_name);
995c6b011d8SStefano Zampini   }
99647c6ae99SBarry Smith   PetscFunctionReturn(0);
99747c6ae99SBarry Smith }
99847c6ae99SBarry Smith 
9991411c6eeSJed Brown /*@
10001411c6eeSJed Brown    DMGetLocalToGlobalMapping - Accesses the local-to-global mapping in a DM.
10011411c6eeSJed Brown 
1002d083f849SBarry Smith    Collective on dm
10031411c6eeSJed Brown 
10041411c6eeSJed Brown    Input Parameter:
10051411c6eeSJed Brown .  dm - the DM that provides the mapping
10061411c6eeSJed Brown 
10071411c6eeSJed Brown    Output Parameter:
10081411c6eeSJed Brown .  ltog - the mapping
10091411c6eeSJed Brown 
10101411c6eeSJed Brown    Level: intermediate
10111411c6eeSJed Brown 
10121411c6eeSJed Brown    Notes:
10131411c6eeSJed Brown    This mapping can then be used by VecSetLocalToGlobalMapping() or
10141411c6eeSJed Brown    MatSetLocalToGlobalMapping().
10151411c6eeSJed Brown 
1016fc31e74dSBarry Smith .seealso: DMCreateLocalVector()
10171411c6eeSJed Brown @*/
10187087cfbeSBarry Smith PetscErrorCode DMGetLocalToGlobalMapping(DM dm,ISLocalToGlobalMapping *ltog)
10191411c6eeSJed Brown {
10200be3e97aSMatthew G. Knepley   PetscInt       bs = -1, bsLocal[2], bsMinMax[2];
10211411c6eeSJed Brown   PetscErrorCode ierr;
10221411c6eeSJed Brown 
10231411c6eeSJed Brown   PetscFunctionBegin;
10241411c6eeSJed Brown   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
10251411c6eeSJed Brown   PetscValidPointer(ltog,2);
10261411c6eeSJed Brown   if (!dm->ltogmap) {
102737d0c07bSMatthew G Knepley     PetscSection section, sectionGlobal;
102837d0c07bSMatthew G Knepley 
102992fd8e1eSJed Brown     ierr = DMGetLocalSection(dm, &section);CHKERRQ(ierr);
103037d0c07bSMatthew G Knepley     if (section) {
1031a974ec88SMatthew G. Knepley       const PetscInt *cdofs;
103237d0c07bSMatthew G Knepley       PetscInt       *ltog;
1033ccf3bd66SMatthew G. Knepley       PetscInt        pStart, pEnd, n, p, k, l;
103437d0c07bSMatthew G Knepley 
1035e87a4003SBarry Smith       ierr = DMGetGlobalSection(dm, &sectionGlobal);CHKERRQ(ierr);
103637d0c07bSMatthew G Knepley       ierr = PetscSectionGetChart(section, &pStart, &pEnd);CHKERRQ(ierr);
1037ccf3bd66SMatthew G. Knepley       ierr = PetscSectionGetStorageSize(section, &n);CHKERRQ(ierr);
1038ccf3bd66SMatthew G. Knepley       ierr = PetscMalloc1(n, &ltog);CHKERRQ(ierr); /* We want the local+overlap size */
103937d0c07bSMatthew G Knepley       for (p = pStart, l = 0; p < pEnd; ++p) {
1040a974ec88SMatthew G. Knepley         PetscInt bdof, cdof, dof, off, c, cind = 0;
104137d0c07bSMatthew G Knepley 
104237d0c07bSMatthew G Knepley         /* Should probably use constrained dofs */
104337d0c07bSMatthew G Knepley         ierr = PetscSectionGetDof(section, p, &dof);CHKERRQ(ierr);
1044a974ec88SMatthew G. Knepley         ierr = PetscSectionGetConstraintDof(section, p, &cdof);CHKERRQ(ierr);
1045a974ec88SMatthew G. Knepley         ierr = PetscSectionGetConstraintIndices(section, p, &cdofs);CHKERRQ(ierr);
104637d0c07bSMatthew G Knepley         ierr = PetscSectionGetOffset(sectionGlobal, p, &off);CHKERRQ(ierr);
10471a7dc684SMatthew G. Knepley         /* If you have dofs, and constraints, and they are unequal, we set the blocksize to 1 */
10481a7dc684SMatthew G. Knepley         bdof = cdof && (dof-cdof) ? 1 : dof;
10491a7dc684SMatthew G. Knepley         if (dof) {
1050b190aa46SMatthew G. Knepley           if (bs < 0)          {bs = bdof;}
1051b190aa46SMatthew G. Knepley           else if (bs != bdof) {bs = 1;}
10521a7dc684SMatthew G. Knepley         }
105337d0c07bSMatthew G Knepley         for (c = 0; c < dof; ++c, ++l) {
1054a974ec88SMatthew G. Knepley           if ((cind < cdof) && (c == cdofs[cind])) ltog[l] = off < 0 ? off-c : off+c;
1055a974ec88SMatthew G. Knepley           else                                     ltog[l] = (off < 0 ? -(off+1) : off) + c;
105637d0c07bSMatthew G Knepley         }
105737d0c07bSMatthew G Knepley       }
1058bff27382SMatthew G. Knepley       /* Must have same blocksize on all procs (some might have no points) */
10590be3e97aSMatthew G. Knepley       bsLocal[0] = bs < 0 ? PETSC_MAX_INT : bs; bsLocal[1] = bs;
10600be3e97aSMatthew G. Knepley       ierr = PetscGlobalMinMaxInt(PetscObjectComm((PetscObject) dm), bsLocal, bsMinMax);CHKERRQ(ierr);
10610be3e97aSMatthew G. Knepley       if (bsMinMax[0] != bsMinMax[1]) {bs = 1;}
10620be3e97aSMatthew G. Knepley       else                            {bs = bsMinMax[0];}
10637591dbb2SMatthew G. Knepley       bs = bs < 0 ? 1 : bs;
10647591dbb2SMatthew G. Knepley       /* Must reduce indices by blocksize */
1065ccf3bd66SMatthew G. Knepley       if (bs > 1) {
1066ccf3bd66SMatthew G. Knepley         for (l = 0, k = 0; l < n; l += bs, ++k) ltog[k] = ltog[l]/bs;
1067ccf3bd66SMatthew G. Knepley         n /= bs;
1068ccf3bd66SMatthew G. Knepley       }
1069ccf3bd66SMatthew G. Knepley       ierr = ISLocalToGlobalMappingCreate(PetscObjectComm((PetscObject)dm), bs, n, ltog, PETSC_OWN_POINTER, &dm->ltogmap);CHKERRQ(ierr);
10703bb1ff40SBarry Smith       ierr = PetscLogObjectParent((PetscObject)dm, (PetscObject)dm->ltogmap);CHKERRQ(ierr);
107137d0c07bSMatthew G Knepley     } else {
1072b9d85ea2SLisandro Dalcin       if (!dm->ops->getlocaltoglobalmapping) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMGetLocalToGlobalMapping",((PetscObject)dm)->type_name);
1073184d77edSJed Brown       ierr = (*dm->ops->getlocaltoglobalmapping)(dm);CHKERRQ(ierr);
10741411c6eeSJed Brown     }
107537d0c07bSMatthew G Knepley   }
10761411c6eeSJed Brown   *ltog = dm->ltogmap;
10771411c6eeSJed Brown   PetscFunctionReturn(0);
10781411c6eeSJed Brown }
10791411c6eeSJed Brown 
10801411c6eeSJed Brown /*@
10811411c6eeSJed Brown    DMGetBlockSize - Gets the inherent block size associated with a DM
10821411c6eeSJed Brown 
10831411c6eeSJed Brown    Not Collective
10841411c6eeSJed Brown 
10851411c6eeSJed Brown    Input Parameter:
10861411c6eeSJed Brown .  dm - the DM with block structure
10871411c6eeSJed Brown 
10881411c6eeSJed Brown    Output Parameter:
10891411c6eeSJed Brown .  bs - the block size, 1 implies no exploitable block structure
10901411c6eeSJed Brown 
10911411c6eeSJed Brown    Level: intermediate
10921411c6eeSJed Brown 
1093fc31e74dSBarry Smith .seealso: ISCreateBlock(), VecSetBlockSize(), MatSetBlockSize(), DMGetLocalToGlobalMapping()
10941411c6eeSJed Brown @*/
10957087cfbeSBarry Smith PetscErrorCode  DMGetBlockSize(DM dm,PetscInt *bs)
10961411c6eeSJed Brown {
10971411c6eeSJed Brown   PetscFunctionBegin;
10981411c6eeSJed Brown   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1099534a8f05SLisandro Dalcin   PetscValidIntPointer(bs,2);
11001411c6eeSJed 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");
11011411c6eeSJed Brown   *bs = dm->bs;
11021411c6eeSJed Brown   PetscFunctionReturn(0);
11031411c6eeSJed Brown }
11041411c6eeSJed Brown 
110547c6ae99SBarry Smith /*@
11068472ad0fSDave May     DMCreateInterpolation - Gets interpolation matrix between two DM objects
110747c6ae99SBarry Smith 
1108a5bc1bf3SBarry Smith     Collective on dmc
110947c6ae99SBarry Smith 
111047c6ae99SBarry Smith     Input Parameter:
1111a5bc1bf3SBarry Smith +   dmc - the DM object
1112a5bc1bf3SBarry Smith -   dmf - the second, finer DM object
111347c6ae99SBarry Smith 
111447c6ae99SBarry Smith     Output Parameter:
111547c6ae99SBarry Smith +  mat - the interpolation
111647c6ae99SBarry Smith -  vec - the scaling (optional)
111747c6ae99SBarry Smith 
111847c6ae99SBarry Smith     Level: developer
111947c6ae99SBarry Smith 
112095452b02SPatrick Sanan     Notes:
112195452b02SPatrick Sanan     For DMDA objects this only works for "uniform refinement", that is the refined mesh was obtained DMRefine() or the coarse mesh was obtained by
112285afcc9aSBarry Smith         DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the interpolation.
1123d52bd9f3SBarry Smith 
11241f588964SMatthew G Knepley         For DMDA objects you can use this interpolation (more precisely the interpolation from the DMGetCoordinateDM()) to interpolate the mesh coordinate vectors
1125d52bd9f3SBarry Smith         EXCEPT in the periodic case where it does not make sense since the coordinate vectors are not periodic.
112685afcc9aSBarry Smith 
112785afcc9aSBarry Smith 
11282ed6491fSPatrick Sanan .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateRestriction(), DMCreateInterpolationScale()
112947c6ae99SBarry Smith 
113047c6ae99SBarry Smith @*/
1131a5bc1bf3SBarry Smith PetscErrorCode  DMCreateInterpolation(DM dmc,DM dmf,Mat *mat,Vec *vec)
113247c6ae99SBarry Smith {
113347c6ae99SBarry Smith   PetscErrorCode ierr;
113447c6ae99SBarry Smith 
113547c6ae99SBarry Smith   PetscFunctionBegin;
1136a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(dmc,DM_CLASSID,1);
1137a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(dmf,DM_CLASSID,2);
1138c7d20fa0SStefano Zampini   PetscValidPointer(mat,3);
1139a5bc1bf3SBarry Smith   if (!dmc->ops->createinterpolation) SETERRQ1(PetscObjectComm((PetscObject)dmc),PETSC_ERR_SUP,"DM type %s does not implement DMCreateInterpolation",((PetscObject)dmc)->type_name);
1140a5bc1bf3SBarry Smith   ierr = PetscLogEventBegin(DM_CreateInterpolation,dmc,dmf,0,0);CHKERRQ(ierr);
1141a5bc1bf3SBarry Smith   ierr = (*dmc->ops->createinterpolation)(dmc,dmf,mat,vec);CHKERRQ(ierr);
1142a5bc1bf3SBarry Smith   ierr = PetscLogEventEnd(DM_CreateInterpolation,dmc,dmf,0,0);CHKERRQ(ierr);
114347c6ae99SBarry Smith   PetscFunctionReturn(0);
114447c6ae99SBarry Smith }
114547c6ae99SBarry Smith 
11463ad4599aSBarry Smith /*@
1147d3e313eaSPatrick Sanan     DMCreateInterpolationScale - Forms L = 1/(R*1) such that diag(L)*R preserves scale and is thus suitable for state (versus residual) restriction.
11482ed6491fSPatrick Sanan 
11492ed6491fSPatrick Sanan   Input Parameters:
11502ed6491fSPatrick Sanan +      dac - DM that defines a coarse mesh
11512ed6491fSPatrick Sanan .      daf - DM that defines a fine mesh
11522ed6491fSPatrick Sanan -      mat - the restriction (or interpolation operator) from fine to coarse
11532ed6491fSPatrick Sanan 
11542ed6491fSPatrick Sanan   Output Parameter:
11552ed6491fSPatrick Sanan .    scale - the scaled vector
11562ed6491fSPatrick Sanan 
11572ed6491fSPatrick Sanan   Level: developer
11582ed6491fSPatrick Sanan 
11592ed6491fSPatrick Sanan .seealso: DMCreateInterpolation()
11602ed6491fSPatrick Sanan 
11612ed6491fSPatrick Sanan @*/
11622ed6491fSPatrick Sanan PetscErrorCode  DMCreateInterpolationScale(DM dac,DM daf,Mat mat,Vec *scale)
11632ed6491fSPatrick Sanan {
11642ed6491fSPatrick Sanan   PetscErrorCode ierr;
11652ed6491fSPatrick Sanan   Vec            fine;
11662ed6491fSPatrick Sanan   PetscScalar    one = 1.0;
11672ed6491fSPatrick Sanan 
11682ed6491fSPatrick Sanan   PetscFunctionBegin;
11692ed6491fSPatrick Sanan   ierr = DMCreateGlobalVector(daf,&fine);CHKERRQ(ierr);
11702ed6491fSPatrick Sanan   ierr = DMCreateGlobalVector(dac,scale);CHKERRQ(ierr);
11712ed6491fSPatrick Sanan   ierr = VecSet(fine,one);CHKERRQ(ierr);
11722ed6491fSPatrick Sanan   ierr = MatRestrict(mat,fine,*scale);CHKERRQ(ierr);
11732ed6491fSPatrick Sanan   ierr = VecDestroy(&fine);CHKERRQ(ierr);
11742ed6491fSPatrick Sanan   ierr = VecReciprocal(*scale);CHKERRQ(ierr);
11752ed6491fSPatrick Sanan   PetscFunctionReturn(0);
11762ed6491fSPatrick Sanan }
11772ed6491fSPatrick Sanan 
11782ed6491fSPatrick Sanan /*@
11793ad4599aSBarry Smith     DMCreateRestriction - Gets restriction matrix between two DM objects
11803ad4599aSBarry Smith 
1181a5bc1bf3SBarry Smith     Collective on dmc
11823ad4599aSBarry Smith 
11833ad4599aSBarry Smith     Input Parameter:
1184a5bc1bf3SBarry Smith +   dmc - the DM object
1185a5bc1bf3SBarry Smith -   dmf - the second, finer DM object
11863ad4599aSBarry Smith 
11873ad4599aSBarry Smith     Output Parameter:
11883ad4599aSBarry Smith .  mat - the restriction
11893ad4599aSBarry Smith 
11903ad4599aSBarry Smith 
11913ad4599aSBarry Smith     Level: developer
11923ad4599aSBarry Smith 
119395452b02SPatrick Sanan     Notes:
119495452b02SPatrick Sanan     For DMDA objects this only works for "uniform refinement", that is the refined mesh was obtained DMRefine() or the coarse mesh was obtained by
11953ad4599aSBarry Smith         DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the interpolation.
11963ad4599aSBarry Smith 
11973ad4599aSBarry Smith 
11983ad4599aSBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateInterpolation()
11993ad4599aSBarry Smith 
12003ad4599aSBarry Smith @*/
1201a5bc1bf3SBarry Smith PetscErrorCode  DMCreateRestriction(DM dmc,DM dmf,Mat *mat)
12023ad4599aSBarry Smith {
12033ad4599aSBarry Smith   PetscErrorCode ierr;
12043ad4599aSBarry Smith 
12053ad4599aSBarry Smith   PetscFunctionBegin;
1206a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(dmc,DM_CLASSID,1);
1207a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(dmf,DM_CLASSID,2);
12085a84ad33SLisandro Dalcin   PetscValidPointer(mat,3);
1209a5bc1bf3SBarry Smith   if (!dmc->ops->createrestriction) SETERRQ1(PetscObjectComm((PetscObject)dmc),PETSC_ERR_SUP,"DM type %s does not implement DMCreateRestriction",((PetscObject)dmc)->type_name);
1210a5bc1bf3SBarry Smith   ierr = PetscLogEventBegin(DM_CreateRestriction,dmc,dmf,0,0);CHKERRQ(ierr);
1211a5bc1bf3SBarry Smith   ierr = (*dmc->ops->createrestriction)(dmc,dmf,mat);CHKERRQ(ierr);
1212a5bc1bf3SBarry Smith   ierr = PetscLogEventEnd(DM_CreateRestriction,dmc,dmf,0,0);CHKERRQ(ierr);
12133ad4599aSBarry Smith   PetscFunctionReturn(0);
12143ad4599aSBarry Smith }
12153ad4599aSBarry Smith 
121647c6ae99SBarry Smith /*@
12178472ad0fSDave May     DMCreateInjection - Gets injection matrix between two DM objects
121847c6ae99SBarry Smith 
1219a5bc1bf3SBarry Smith     Collective on dac
122047c6ae99SBarry Smith 
122147c6ae99SBarry Smith     Input Parameter:
1222a5bc1bf3SBarry Smith +   dac - the DM object
1223a5bc1bf3SBarry Smith -   daf - the second, finer DM object
122447c6ae99SBarry Smith 
122547c6ae99SBarry Smith     Output Parameter:
12266dbf9973SLawrence Mitchell .   mat - the injection
122747c6ae99SBarry Smith 
122847c6ae99SBarry Smith     Level: developer
122947c6ae99SBarry Smith 
123095452b02SPatrick Sanan    Notes:
123195452b02SPatrick Sanan     For DMDA objects this only works for "uniform refinement", that is the refined mesh was obtained DMRefine() or the coarse mesh was obtained by
123285afcc9aSBarry Smith         DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the injection.
123385afcc9aSBarry Smith 
1234e727c939SJed Brown .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMCreateInterpolation()
123547c6ae99SBarry Smith 
123647c6ae99SBarry Smith @*/
1237a5bc1bf3SBarry Smith PetscErrorCode  DMCreateInjection(DM dac,DM daf,Mat *mat)
123847c6ae99SBarry Smith {
123947c6ae99SBarry Smith   PetscErrorCode ierr;
124047c6ae99SBarry Smith 
124147c6ae99SBarry Smith   PetscFunctionBegin;
1242a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(dac,DM_CLASSID,1);
1243a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(daf,DM_CLASSID,2);
12445a84ad33SLisandro Dalcin   PetscValidPointer(mat,3);
1245a5bc1bf3SBarry Smith   if (!dac->ops->createinjection) SETERRQ1(PetscObjectComm((PetscObject)dac),PETSC_ERR_SUP,"DM type %s does not implement DMCreateInjection",((PetscObject)dac)->type_name);
1246a5bc1bf3SBarry Smith   ierr = PetscLogEventBegin(DM_CreateInjection,dac,daf,0,0);CHKERRQ(ierr);
1247a5bc1bf3SBarry Smith   ierr = (*dac->ops->createinjection)(dac,daf,mat);CHKERRQ(ierr);
1248a5bc1bf3SBarry Smith   ierr = PetscLogEventEnd(DM_CreateInjection,dac,daf,0,0);CHKERRQ(ierr);
124947c6ae99SBarry Smith   PetscFunctionReturn(0);
125047c6ae99SBarry Smith }
125147c6ae99SBarry Smith 
1252b412c318SBarry Smith /*@
1253bd041c0cSMatthew G. Knepley   DMCreateMassMatrix - Gets mass matrix between two DM objects, M_ij = \int \phi_i \psi_j
1254bd041c0cSMatthew G. Knepley 
1255a5bc1bf3SBarry Smith   Collective on dac
1256bd041c0cSMatthew G. Knepley 
1257bd041c0cSMatthew G. Knepley   Input Parameter:
1258a5bc1bf3SBarry Smith + dac - the DM object
1259a5bc1bf3SBarry Smith - daf - the second, finer DM object
1260bd041c0cSMatthew G. Knepley 
1261bd041c0cSMatthew G. Knepley   Output Parameter:
1262bd041c0cSMatthew G. Knepley . mat - the interpolation
1263bd041c0cSMatthew G. Knepley 
1264bd041c0cSMatthew G. Knepley   Level: developer
1265bd041c0cSMatthew G. Knepley 
1266bd041c0cSMatthew G. Knepley .seealso DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateRestriction(), DMCreateInterpolation(), DMCreateInjection()
1267bd041c0cSMatthew G. Knepley @*/
1268a5bc1bf3SBarry Smith PetscErrorCode DMCreateMassMatrix(DM dac, DM daf, Mat *mat)
1269bd041c0cSMatthew G. Knepley {
1270bd041c0cSMatthew G. Knepley   PetscErrorCode ierr;
1271bd041c0cSMatthew G. Knepley 
1272bd041c0cSMatthew G. Knepley   PetscFunctionBegin;
1273a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(dac, DM_CLASSID, 1);
1274a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(daf, DM_CLASSID, 2);
12755a84ad33SLisandro Dalcin   PetscValidPointer(mat,3);
1276a5bc1bf3SBarry Smith   if (!dac->ops->createmassmatrix) SETERRQ1(PetscObjectComm((PetscObject)dac),PETSC_ERR_SUP,"DM type %s does not implement DMCreateMassMatrix",((PetscObject)dac)->type_name);
1277a5bc1bf3SBarry Smith   ierr = (*dac->ops->createmassmatrix)(dac, daf, mat);CHKERRQ(ierr);
1278bd041c0cSMatthew G. Knepley   PetscFunctionReturn(0);
1279bd041c0cSMatthew G. Knepley }
1280bd041c0cSMatthew G. Knepley 
1281bd041c0cSMatthew G. Knepley /*@
1282b412c318SBarry Smith     DMCreateColoring - Gets coloring for a DM
128347c6ae99SBarry Smith 
1284d083f849SBarry Smith     Collective on dm
128547c6ae99SBarry Smith 
128647c6ae99SBarry Smith     Input Parameter:
128747c6ae99SBarry Smith +   dm - the DM object
12885bdb020cSBarry Smith -   ctype - IS_COLORING_LOCAL or IS_COLORING_GLOBAL
128947c6ae99SBarry Smith 
129047c6ae99SBarry Smith     Output Parameter:
129147c6ae99SBarry Smith .   coloring - the coloring
129247c6ae99SBarry Smith 
1293ec5066bdSBarry Smith     Notes:
1294ec5066bdSBarry Smith        Coloring of matrices can be computed directly from the sparse matrix nonzero structure via the MatColoring object or from the mesh from which the
1295ec5066bdSBarry Smith        matrix comes from. In general using the mesh produces a more optimal coloring (fewer colors).
1296ec5066bdSBarry Smith 
1297ec5066bdSBarry Smith        This produces a coloring with the distance of 2, see MatSetColoringDistance() which can be used for efficiently computing Jacobians with MatFDColoringCreate()
1298ec5066bdSBarry Smith 
129947c6ae99SBarry Smith     Level: developer
130047c6ae99SBarry Smith 
1301ec5066bdSBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateMatrix(), DMSetMatType(), MatColoring, MatFDColoringCreate()
130247c6ae99SBarry Smith 
1303aab9d709SJed Brown @*/
1304b412c318SBarry Smith PetscErrorCode  DMCreateColoring(DM dm,ISColoringType ctype,ISColoring *coloring)
130547c6ae99SBarry Smith {
130647c6ae99SBarry Smith   PetscErrorCode ierr;
130747c6ae99SBarry Smith 
130847c6ae99SBarry Smith   PetscFunctionBegin;
1309171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
13105a84ad33SLisandro Dalcin   PetscValidPointer(coloring,3);
1311b9d85ea2SLisandro Dalcin   if (!dm->ops->getcoloring) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateColoring",((PetscObject)dm)->type_name);
1312b412c318SBarry Smith   ierr = (*dm->ops->getcoloring)(dm,ctype,coloring);CHKERRQ(ierr);
131347c6ae99SBarry Smith   PetscFunctionReturn(0);
131447c6ae99SBarry Smith }
131547c6ae99SBarry Smith 
1316b412c318SBarry Smith /*@
13178472ad0fSDave May     DMCreateMatrix - Gets empty Jacobian for a DM
131847c6ae99SBarry Smith 
1319d083f849SBarry Smith     Collective on dm
132047c6ae99SBarry Smith 
132147c6ae99SBarry Smith     Input Parameter:
1322b412c318SBarry Smith .   dm - the DM object
132347c6ae99SBarry Smith 
132447c6ae99SBarry Smith     Output Parameter:
132547c6ae99SBarry Smith .   mat - the empty Jacobian
132647c6ae99SBarry Smith 
1327073dac72SJed Brown     Level: beginner
132847c6ae99SBarry Smith 
132995452b02SPatrick Sanan     Notes:
133095452b02SPatrick Sanan     This properly preallocates the number of nonzeros in the sparse matrix so you
133194013140SBarry Smith        do not need to do it yourself.
133294013140SBarry Smith 
133394013140SBarry Smith        By default it also sets the nonzero structure and puts in the zero entries. To prevent setting
13347889ec69SBarry Smith        the nonzero pattern call DMSetMatrixPreallocateOnly()
133594013140SBarry Smith 
133694013140SBarry 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
133794013140SBarry Smith        internally by PETSc.
133894013140SBarry Smith 
133994013140SBarry Smith        For structured grid problems, in general it is easiest to use MatSetValuesStencil() or MatSetValuesLocal() to put values into the matrix because MatSetValues() requires
1340aa219208SBarry Smith        the indices for the global numbering for DMDAs which is complicated.
134194013140SBarry Smith 
1342b412c318SBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMSetMatType()
134347c6ae99SBarry Smith 
1344aab9d709SJed Brown @*/
1345b412c318SBarry Smith PetscErrorCode  DMCreateMatrix(DM dm,Mat *mat)
134647c6ae99SBarry Smith {
134747c6ae99SBarry Smith   PetscErrorCode ierr;
134847c6ae99SBarry Smith 
134947c6ae99SBarry Smith   PetscFunctionBegin;
1350171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1351c7b7c8a4SJed Brown   PetscValidPointer(mat,3);
1352b9d85ea2SLisandro Dalcin   if (!dm->ops->creatematrix) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateMatrix",((PetscObject)dm)->type_name);
13535a84ad33SLisandro Dalcin   ierr = MatInitializePackage();CHKERRQ(ierr);
1354fdc842d1SBarry Smith   ierr = PetscLogEventBegin(DM_CreateMatrix,0,0,0,0);CHKERRQ(ierr);
1355b412c318SBarry Smith   ierr = (*dm->ops->creatematrix)(dm,mat);CHKERRQ(ierr);
135676bd3646SJed Brown   if (PetscDefined(USE_DEBUG)) {
1357c6b011d8SStefano Zampini     DM mdm;
1358c6b011d8SStefano Zampini 
1359c6b011d8SStefano Zampini     ierr = MatGetDM(*mat,&mdm);CHKERRQ(ierr);
1360c6b011d8SStefano Zampini     if (!mdm) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_PLIB,"DM type '%s' did not attach the DM to the matrix\n",((PetscObject)dm)->type_name);
1361c6b011d8SStefano Zampini   }
1362e571a35bSMatthew G. Knepley   /* Handle nullspace and near nullspace */
1363e5e52638SMatthew G. Knepley   if (dm->Nf) {
1364e571a35bSMatthew G. Knepley     MatNullSpace nullSpace;
1365*649ef022SMatthew Knepley     PetscInt     Nf, f;
1366e571a35bSMatthew G. Knepley 
1367e5e52638SMatthew G. Knepley     ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
1368*649ef022SMatthew Knepley     for (f = 0; f < Nf; ++f) {
1369*649ef022SMatthew Knepley       if (dm->nullspaceConstructors[f]) {
1370*649ef022SMatthew Knepley         ierr = (*dm->nullspaceConstructors[f])(dm, f, f, &nullSpace);CHKERRQ(ierr);
1371e571a35bSMatthew G. Knepley         ierr = MatSetNullSpace(*mat, nullSpace);CHKERRQ(ierr);
1372e571a35bSMatthew G. Knepley         ierr = MatNullSpaceDestroy(&nullSpace);CHKERRQ(ierr);
1373*649ef022SMatthew Knepley         break;
1374e571a35bSMatthew G. Knepley       }
1375*649ef022SMatthew Knepley     }
1376*649ef022SMatthew Knepley     for (f = 0; f < Nf; ++f) {
1377*649ef022SMatthew Knepley       if (dm->nearnullspaceConstructors[f]) {
1378*649ef022SMatthew Knepley         ierr = (*dm->nearnullspaceConstructors[f])(dm, f, f, &nullSpace);CHKERRQ(ierr);
1379e571a35bSMatthew G. Knepley         ierr = MatSetNearNullSpace(*mat, nullSpace);CHKERRQ(ierr);
1380e571a35bSMatthew G. Knepley         ierr = MatNullSpaceDestroy(&nullSpace);CHKERRQ(ierr);
1381e571a35bSMatthew G. Knepley       }
1382e571a35bSMatthew G. Knepley     }
1383e571a35bSMatthew G. Knepley   }
1384fdc842d1SBarry Smith   ierr = PetscLogEventEnd(DM_CreateMatrix,0,0,0,0);CHKERRQ(ierr);
138547c6ae99SBarry Smith   PetscFunctionReturn(0);
138647c6ae99SBarry Smith }
138747c6ae99SBarry Smith 
1388732e2eb9SMatthew G Knepley /*@
1389950540a4SJed Brown   DMSetMatrixPreallocateOnly - When DMCreateMatrix() is called the matrix will be properly
1390732e2eb9SMatthew G Knepley     preallocated but the nonzero structure and zero values will not be set.
1391732e2eb9SMatthew G Knepley 
1392d083f849SBarry Smith   Logically Collective on dm
1393732e2eb9SMatthew G Knepley 
1394732e2eb9SMatthew G Knepley   Input Parameter:
1395732e2eb9SMatthew G Knepley + dm - the DM
1396732e2eb9SMatthew G Knepley - only - PETSC_TRUE if only want preallocation
1397732e2eb9SMatthew G Knepley 
1398732e2eb9SMatthew G Knepley   Level: developer
1399b06ff27eSHong Zhang .seealso DMCreateMatrix(), DMSetMatrixStructureOnly()
1400732e2eb9SMatthew G Knepley @*/
1401732e2eb9SMatthew G Knepley PetscErrorCode DMSetMatrixPreallocateOnly(DM dm, PetscBool only)
1402732e2eb9SMatthew G Knepley {
1403732e2eb9SMatthew G Knepley   PetscFunctionBegin;
1404732e2eb9SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1405732e2eb9SMatthew G Knepley   dm->prealloc_only = only;
1406732e2eb9SMatthew G Knepley   PetscFunctionReturn(0);
1407732e2eb9SMatthew G Knepley }
1408732e2eb9SMatthew G Knepley 
1409b06ff27eSHong Zhang /*@
1410b06ff27eSHong Zhang   DMSetMatrixStructureOnly - When DMCreateMatrix() is called, the matrix structure will be created
1411b06ff27eSHong Zhang     but the array for values will not be allocated.
1412b06ff27eSHong Zhang 
1413d083f849SBarry Smith   Logically Collective on dm
1414b06ff27eSHong Zhang 
1415b06ff27eSHong Zhang   Input Parameter:
1416b06ff27eSHong Zhang + dm - the DM
1417b06ff27eSHong Zhang - only - PETSC_TRUE if only want matrix stucture
1418b06ff27eSHong Zhang 
1419b06ff27eSHong Zhang   Level: developer
1420b06ff27eSHong Zhang .seealso DMCreateMatrix(), DMSetMatrixPreallocateOnly()
1421b06ff27eSHong Zhang @*/
1422b06ff27eSHong Zhang PetscErrorCode DMSetMatrixStructureOnly(DM dm, PetscBool only)
1423b06ff27eSHong Zhang {
1424b06ff27eSHong Zhang   PetscFunctionBegin;
1425b06ff27eSHong Zhang   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1426b06ff27eSHong Zhang   dm->structure_only = only;
1427b06ff27eSHong Zhang   PetscFunctionReturn(0);
1428b06ff27eSHong Zhang }
1429b06ff27eSHong Zhang 
1430a89ea682SMatthew G Knepley /*@C
1431aa1993deSMatthew G Knepley   DMGetWorkArray - Gets a work array guaranteed to be at least the input size, restore with DMRestoreWorkArray()
1432a89ea682SMatthew G Knepley 
1433a89ea682SMatthew G Knepley   Not Collective
1434a89ea682SMatthew G Knepley 
1435a89ea682SMatthew G Knepley   Input Parameters:
1436a89ea682SMatthew G Knepley + dm - the DM object
1437aa1993deSMatthew G Knepley . count - The minium size
143869291d52SBarry Smith - dtype - MPI data type, often MPIU_REAL, MPIU_SCALAR, MPIU_INT)
1439a89ea682SMatthew G Knepley 
1440a89ea682SMatthew G Knepley   Output Parameter:
1441a89ea682SMatthew G Knepley . array - the work array
1442a89ea682SMatthew G Knepley 
1443a89ea682SMatthew G Knepley   Level: developer
1444a89ea682SMatthew G Knepley 
1445a89ea682SMatthew G Knepley .seealso DMDestroy(), DMCreate()
1446a89ea682SMatthew G Knepley @*/
144769291d52SBarry Smith PetscErrorCode DMGetWorkArray(DM dm,PetscInt count,MPI_Datatype dtype,void *mem)
1448a89ea682SMatthew G Knepley {
1449a89ea682SMatthew G Knepley   PetscErrorCode ierr;
1450aa1993deSMatthew G Knepley   DMWorkLink     link;
145169291d52SBarry Smith   PetscMPIInt    dsize;
1452a89ea682SMatthew G Knepley 
1453a89ea682SMatthew G Knepley   PetscFunctionBegin;
1454a89ea682SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1455aa1993deSMatthew G Knepley   PetscValidPointer(mem,4);
1456aa1993deSMatthew G Knepley   if (dm->workin) {
1457aa1993deSMatthew G Knepley     link       = dm->workin;
1458aa1993deSMatthew G Knepley     dm->workin = dm->workin->next;
1459aa1993deSMatthew G Knepley   } else {
1460b00a9115SJed Brown     ierr = PetscNewLog(dm,&link);CHKERRQ(ierr);
1461a89ea682SMatthew G Knepley   }
146269291d52SBarry Smith   ierr = MPI_Type_size(dtype,&dsize);CHKERRQ(ierr);
14635056fcd2SBarry Smith   if (((size_t)dsize*count) > link->bytes) {
1464aa1993deSMatthew G Knepley     ierr        = PetscFree(link->mem);CHKERRQ(ierr);
1465854ce69bSBarry Smith     ierr        = PetscMalloc(dsize*count,&link->mem);CHKERRQ(ierr);
1466854ce69bSBarry Smith     link->bytes = dsize*count;
1467aa1993deSMatthew G Knepley   }
1468aa1993deSMatthew G Knepley   link->next   = dm->workout;
1469aa1993deSMatthew G Knepley   dm->workout  = link;
147000d952a4SJed Brown #if defined(PETSC_HAVE_VALGRIND)
147100d952a4SJed Brown   VALGRIND_MAKE_MEM_NOACCESS((char*)link->mem + (size_t)dsize*count, link->bytes - (size_t)dsize*count);
147200d952a4SJed Brown   VALGRIND_MAKE_MEM_UNDEFINED(link->mem, (size_t)dsize*count);
147300d952a4SJed Brown #endif
1474aa1993deSMatthew G Knepley   *(void**)mem = link->mem;
1475a89ea682SMatthew G Knepley   PetscFunctionReturn(0);
1476a89ea682SMatthew G Knepley }
1477a89ea682SMatthew G Knepley 
1478aa1993deSMatthew G Knepley /*@C
1479aa1993deSMatthew G Knepley   DMRestoreWorkArray - Restores a work array guaranteed to be at least the input size, restore with DMRestoreWorkArray()
1480aa1993deSMatthew G Knepley 
1481aa1993deSMatthew G Knepley   Not Collective
1482aa1993deSMatthew G Knepley 
1483aa1993deSMatthew G Knepley   Input Parameters:
1484aa1993deSMatthew G Knepley + dm - the DM object
1485aa1993deSMatthew G Knepley . count - The minium size
148669291d52SBarry Smith - dtype - MPI data type, often MPIU_REAL, MPIU_SCALAR, MPIU_INT
1487aa1993deSMatthew G Knepley 
1488aa1993deSMatthew G Knepley   Output Parameter:
1489aa1993deSMatthew G Knepley . array - the work array
1490aa1993deSMatthew G Knepley 
1491aa1993deSMatthew G Knepley   Level: developer
1492aa1993deSMatthew G Knepley 
149395452b02SPatrick Sanan   Developer Notes:
149495452b02SPatrick Sanan     count and dtype are ignored, they are only needed for DMGetWorkArray()
1495aa1993deSMatthew G Knepley .seealso DMDestroy(), DMCreate()
1496aa1993deSMatthew G Knepley @*/
149769291d52SBarry Smith PetscErrorCode DMRestoreWorkArray(DM dm,PetscInt count,MPI_Datatype dtype,void *mem)
1498aa1993deSMatthew G Knepley {
1499aa1993deSMatthew G Knepley   DMWorkLink *p,link;
1500aa1993deSMatthew G Knepley 
1501aa1993deSMatthew G Knepley   PetscFunctionBegin;
1502aa1993deSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1503aa1993deSMatthew G Knepley   PetscValidPointer(mem,4);
1504aa1993deSMatthew G Knepley   for (p=&dm->workout; (link=*p); p=&link->next) {
1505aa1993deSMatthew G Knepley     if (link->mem == *(void**)mem) {
1506aa1993deSMatthew G Knepley       *p           = link->next;
1507aa1993deSMatthew G Knepley       link->next   = dm->workin;
1508aa1993deSMatthew G Knepley       dm->workin   = link;
15090298fd71SBarry Smith       *(void**)mem = NULL;
1510aa1993deSMatthew G Knepley       PetscFunctionReturn(0);
1511aa1993deSMatthew G Knepley     }
1512aa1993deSMatthew G Knepley   }
1513aa1993deSMatthew G Knepley   SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Array was not checked out");
1514aa1993deSMatthew G Knepley }
1515e7c4fc90SDmitry Karpeev 
15168cda7954SMatthew G. Knepley /*@C
15178cda7954SMatthew G. Knepley   DMSetNullSpaceConstructor - Provide a callback function which constructs the nullspace for a given field
15188cda7954SMatthew G. Knepley 
15198cda7954SMatthew G. Knepley   Logically collective on DM
15208cda7954SMatthew G. Knepley 
15218cda7954SMatthew G. Knepley   Input Parameters:
15228cda7954SMatthew G. Knepley + dm     - The DM
15238cda7954SMatthew G. Knepley . field  - The field number for the nullspace
15248cda7954SMatthew G. Knepley - nullsp - A callback to create the nullspace
15258cda7954SMatthew G. Knepley 
15268cda7954SMatthew G. Knepley   Notes:
15278cda7954SMatthew G. Knepley   The callback is intended to provide nullspaces when function spaces are joined or split, such as in DMCreateSubDM(). The calling sequence is
15288cda7954SMatthew G. Knepley $ PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace)
15298cda7954SMatthew G. Knepley $ dm        - The present DM
15308cda7954SMatthew G. Knepley $ origField - The field number given above, in the original DM
15318cda7954SMatthew G. Knepley $ field     - The field number in dm
15328cda7954SMatthew G. Knepley $ nullSpace - The nullspace for the given field
15338cda7954SMatthew G. Knepley 
15348cda7954SMatthew G. Knepley   This function is currently not available from Fortran.
15358cda7954SMatthew G. Knepley 
15368cda7954SMatthew G. Knepley .seealso: DMGetNullSpaceConstructor(), DMSetNearNullSpaceConstructor(), DMGetNearNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM()
15378cda7954SMatthew G. Knepley */
15388cda7954SMatthew G. Knepley PetscErrorCode DMSetNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (*nullsp)(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace))
1539435a35e8SMatthew G Knepley {
1540435a35e8SMatthew G Knepley   PetscFunctionBegin;
1541435a35e8SMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
154282f516ccSBarry Smith   if (field >= 10) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field);
1543435a35e8SMatthew G Knepley   dm->nullspaceConstructors[field] = nullsp;
1544435a35e8SMatthew G Knepley   PetscFunctionReturn(0);
1545435a35e8SMatthew G Knepley }
1546435a35e8SMatthew G Knepley 
15478cda7954SMatthew G. Knepley /*@C
15488cda7954SMatthew G. Knepley   DMGetNullSpaceConstructor - Return the callback function which constructs the nullspace for a given field, or NULL
15498cda7954SMatthew G. Knepley 
15508cda7954SMatthew G. Knepley   Not collective
15518cda7954SMatthew G. Knepley 
15528cda7954SMatthew G. Knepley   Input Parameters:
15538cda7954SMatthew G. Knepley + dm     - The DM
15548cda7954SMatthew G. Knepley - field  - The field number for the nullspace
15558cda7954SMatthew G. Knepley 
15568cda7954SMatthew G. Knepley   Output Parameter:
15578cda7954SMatthew G. Knepley . nullsp - A callback to create the nullspace
15588cda7954SMatthew G. Knepley 
15598cda7954SMatthew G. Knepley   Notes:
15608cda7954SMatthew G. Knepley   The callback is intended to provide nullspaces when function spaces are joined or split, such as in DMCreateSubDM(). The calling sequence is
15618cda7954SMatthew G. Knepley $ PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace)
15628cda7954SMatthew G. Knepley $ dm        - The present DM
15638cda7954SMatthew G. Knepley $ origField - The field number given above, in the original DM
15648cda7954SMatthew G. Knepley $ field     - The field number in dm
15658cda7954SMatthew G. Knepley $ nullSpace - The nullspace for the given field
15668cda7954SMatthew G. Knepley 
15678cda7954SMatthew G. Knepley   This function is currently not available from Fortran.
15688cda7954SMatthew G. Knepley 
15698cda7954SMatthew G. Knepley .seealso: DMSetNullSpaceConstructor(), DMSetNearNullSpaceConstructor(), DMGetNearNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM()
15708cda7954SMatthew G. Knepley */
15718cda7954SMatthew G. Knepley PetscErrorCode DMGetNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (**nullsp)(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace))
15720a50eb56SMatthew G. Knepley {
15730a50eb56SMatthew G. Knepley   PetscFunctionBegin;
15740a50eb56SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
1575f9d4088aSMatthew G. Knepley   PetscValidPointer(nullsp, 3);
15760a50eb56SMatthew G. Knepley   if (field >= 10) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field);
15770a50eb56SMatthew G. Knepley   *nullsp = dm->nullspaceConstructors[field];
15780a50eb56SMatthew G. Knepley   PetscFunctionReturn(0);
15790a50eb56SMatthew G. Knepley }
15800a50eb56SMatthew G. Knepley 
15818cda7954SMatthew G. Knepley /*@C
15828cda7954SMatthew G. Knepley   DMSetNearNullSpaceConstructor - Provide a callback function which constructs the near-nullspace for a given field
15838cda7954SMatthew G. Knepley 
15848cda7954SMatthew G. Knepley   Logically collective on DM
15858cda7954SMatthew G. Knepley 
15868cda7954SMatthew G. Knepley   Input Parameters:
15878cda7954SMatthew G. Knepley + dm     - The DM
15888cda7954SMatthew G. Knepley . field  - The field number for the nullspace
15898cda7954SMatthew G. Knepley - nullsp - A callback to create the near-nullspace
15908cda7954SMatthew G. Knepley 
15918cda7954SMatthew G. Knepley   Notes:
15928cda7954SMatthew G. Knepley   The callback is intended to provide nullspaces when function spaces are joined or split, such as in DMCreateSubDM(). The calling sequence is
15938cda7954SMatthew G. Knepley $ PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace)
15948cda7954SMatthew G. Knepley $ dm        - The present DM
15958cda7954SMatthew G. Knepley $ origField - The field number given above, in the original DM
15968cda7954SMatthew G. Knepley $ field     - The field number in dm
15978cda7954SMatthew G. Knepley $ nullSpace - The nullspace for the given field
15988cda7954SMatthew G. Knepley 
15998cda7954SMatthew G. Knepley   This function is currently not available from Fortran.
16008cda7954SMatthew G. Knepley 
16018cda7954SMatthew G. Knepley .seealso: DMGetNearNullSpaceConstructor(), DMSetNullSpaceConstructor(), DMGetNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM()
16028cda7954SMatthew G. Knepley */
16038cda7954SMatthew G. Knepley PetscErrorCode DMSetNearNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (*nullsp)(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace))
1604f9d4088aSMatthew G. Knepley {
1605f9d4088aSMatthew G. Knepley   PetscFunctionBegin;
1606f9d4088aSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
1607f9d4088aSMatthew G. Knepley   if (field >= 10) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field);
1608f9d4088aSMatthew G. Knepley   dm->nearnullspaceConstructors[field] = nullsp;
1609f9d4088aSMatthew G. Knepley   PetscFunctionReturn(0);
1610f9d4088aSMatthew G. Knepley }
1611f9d4088aSMatthew G. Knepley 
16128cda7954SMatthew G. Knepley /*@C
16138cda7954SMatthew G. Knepley   DMGetNearNullSpaceConstructor - Return the callback function which constructs the near-nullspace for a given field, or NULL
16148cda7954SMatthew G. Knepley 
16158cda7954SMatthew G. Knepley   Not collective
16168cda7954SMatthew G. Knepley 
16178cda7954SMatthew G. Knepley   Input Parameters:
16188cda7954SMatthew G. Knepley + dm     - The DM
16198cda7954SMatthew G. Knepley - field  - The field number for the nullspace
16208cda7954SMatthew G. Knepley 
16218cda7954SMatthew G. Knepley   Output Parameter:
16228cda7954SMatthew G. Knepley . nullsp - A callback to create the near-nullspace
16238cda7954SMatthew G. Knepley 
16248cda7954SMatthew G. Knepley   Notes:
16258cda7954SMatthew G. Knepley   The callback is intended to provide nullspaces when function spaces are joined or split, such as in DMCreateSubDM(). The calling sequence is
16268cda7954SMatthew G. Knepley $ PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace)
16278cda7954SMatthew G. Knepley $ dm        - The present DM
16288cda7954SMatthew G. Knepley $ origField - The field number given above, in the original DM
16298cda7954SMatthew G. Knepley $ field     - The field number in dm
16308cda7954SMatthew G. Knepley $ nullSpace - The nullspace for the given field
16318cda7954SMatthew G. Knepley 
16328cda7954SMatthew G. Knepley   This function is currently not available from Fortran.
16338cda7954SMatthew G. Knepley 
16348cda7954SMatthew G. Knepley .seealso: DMSetNearNullSpaceConstructor(), DMSetNullSpaceConstructor(), DMGetNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM()
16358cda7954SMatthew G. Knepley */
16368cda7954SMatthew G. Knepley PetscErrorCode DMGetNearNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (**nullsp)(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace))
1637f9d4088aSMatthew G. Knepley {
1638f9d4088aSMatthew G. Knepley   PetscFunctionBegin;
1639f9d4088aSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
1640f9d4088aSMatthew G. Knepley   PetscValidPointer(nullsp, 3);
1641f9d4088aSMatthew G. Knepley   if (field >= 10) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field);
1642f9d4088aSMatthew G. Knepley   *nullsp = dm->nearnullspaceConstructors[field];
1643f9d4088aSMatthew G. Knepley   PetscFunctionReturn(0);
1644f9d4088aSMatthew G. Knepley }
1645f9d4088aSMatthew G. Knepley 
16464f3b5142SJed Brown /*@C
16474d343eeaSMatthew G Knepley   DMCreateFieldIS - Creates a set of IS objects with the global indices of dofs for each field
16484d343eeaSMatthew G Knepley 
16494d343eeaSMatthew G Knepley   Not collective
16504d343eeaSMatthew G Knepley 
16514d343eeaSMatthew G Knepley   Input Parameter:
16524d343eeaSMatthew G Knepley . dm - the DM object
16534d343eeaSMatthew G Knepley 
16544d343eeaSMatthew G Knepley   Output Parameters:
16550298fd71SBarry Smith + numFields  - The number of fields (or NULL if not requested)
16560298fd71SBarry Smith . fieldNames - The name for each field (or NULL if not requested)
16570298fd71SBarry Smith - fields     - The global indices for each field (or NULL if not requested)
16584d343eeaSMatthew G Knepley 
16594d343eeaSMatthew G Knepley   Level: intermediate
16604d343eeaSMatthew G Knepley 
166121c9b008SJed Brown   Notes:
166221c9b008SJed Brown   The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with
166321c9b008SJed Brown   PetscFree(), every entry of fields should be destroyed with ISDestroy(), and both arrays should be freed with
166421c9b008SJed Brown   PetscFree().
166521c9b008SJed Brown 
16664d343eeaSMatthew G Knepley .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
16674d343eeaSMatthew G Knepley @*/
166837d0c07bSMatthew G Knepley PetscErrorCode DMCreateFieldIS(DM dm, PetscInt *numFields, char ***fieldNames, IS **fields)
16694d343eeaSMatthew G Knepley {
167037d0c07bSMatthew G Knepley   PetscSection   section, sectionGlobal;
16714d343eeaSMatthew G Knepley   PetscErrorCode ierr;
16724d343eeaSMatthew G Knepley 
16734d343eeaSMatthew G Knepley   PetscFunctionBegin;
16744d343eeaSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
167569ca1f37SDmitry Karpeev   if (numFields) {
1676534a8f05SLisandro Dalcin     PetscValidIntPointer(numFields,2);
167769ca1f37SDmitry Karpeev     *numFields = 0;
167869ca1f37SDmitry Karpeev   }
167937d0c07bSMatthew G Knepley   if (fieldNames) {
168037d0c07bSMatthew G Knepley     PetscValidPointer(fieldNames,3);
16810298fd71SBarry Smith     *fieldNames = NULL;
168269ca1f37SDmitry Karpeev   }
168369ca1f37SDmitry Karpeev   if (fields) {
168469ca1f37SDmitry Karpeev     PetscValidPointer(fields,4);
16850298fd71SBarry Smith     *fields = NULL;
168669ca1f37SDmitry Karpeev   }
168792fd8e1eSJed Brown   ierr = DMGetLocalSection(dm, &section);CHKERRQ(ierr);
168837d0c07bSMatthew G Knepley   if (section) {
16893a544194SStefano Zampini     PetscInt *fieldSizes, *fieldNc, **fieldIndices;
169037d0c07bSMatthew G Knepley     PetscInt nF, f, pStart, pEnd, p;
169137d0c07bSMatthew G Knepley 
1692e87a4003SBarry Smith     ierr = DMGetGlobalSection(dm, &sectionGlobal);CHKERRQ(ierr);
169337d0c07bSMatthew G Knepley     ierr = PetscSectionGetNumFields(section, &nF);CHKERRQ(ierr);
16943a544194SStefano Zampini     ierr = PetscMalloc3(nF,&fieldSizes,nF,&fieldNc,nF,&fieldIndices);CHKERRQ(ierr);
169537d0c07bSMatthew G Knepley     ierr = PetscSectionGetChart(sectionGlobal, &pStart, &pEnd);CHKERRQ(ierr);
169637d0c07bSMatthew G Knepley     for (f = 0; f < nF; ++f) {
169737d0c07bSMatthew G Knepley       fieldSizes[f] = 0;
16983a544194SStefano Zampini       ierr          = PetscSectionGetFieldComponents(section, f, &fieldNc[f]);CHKERRQ(ierr);
169937d0c07bSMatthew G Knepley     }
170037d0c07bSMatthew G Knepley     for (p = pStart; p < pEnd; ++p) {
170137d0c07bSMatthew G Knepley       PetscInt gdof;
170237d0c07bSMatthew G Knepley 
170337d0c07bSMatthew G Knepley       ierr = PetscSectionGetDof(sectionGlobal, p, &gdof);CHKERRQ(ierr);
170437d0c07bSMatthew G Knepley       if (gdof > 0) {
170537d0c07bSMatthew G Knepley         for (f = 0; f < nF; ++f) {
17063a544194SStefano Zampini           PetscInt fdof, fcdof, fpdof;
170737d0c07bSMatthew G Knepley 
170837d0c07bSMatthew G Knepley           ierr  = PetscSectionGetFieldDof(section, p, f, &fdof);CHKERRQ(ierr);
170937d0c07bSMatthew G Knepley           ierr  = PetscSectionGetFieldConstraintDof(section, p, f, &fcdof);CHKERRQ(ierr);
17103a544194SStefano Zampini           fpdof = fdof-fcdof;
17113a544194SStefano Zampini           if (fpdof && fpdof != fieldNc[f]) {
17123a544194SStefano Zampini             /* Layout does not admit a pointwise block size */
17133a544194SStefano Zampini             fieldNc[f] = 1;
17143a544194SStefano Zampini           }
17153a544194SStefano Zampini           fieldSizes[f] += fpdof;
171637d0c07bSMatthew G Knepley         }
171737d0c07bSMatthew G Knepley       }
171837d0c07bSMatthew G Knepley     }
171937d0c07bSMatthew G Knepley     for (f = 0; f < nF; ++f) {
1720785e854fSJed Brown       ierr          = PetscMalloc1(fieldSizes[f], &fieldIndices[f]);CHKERRQ(ierr);
172137d0c07bSMatthew G Knepley       fieldSizes[f] = 0;
172237d0c07bSMatthew G Knepley     }
172337d0c07bSMatthew G Knepley     for (p = pStart; p < pEnd; ++p) {
172437d0c07bSMatthew G Knepley       PetscInt gdof, goff;
172537d0c07bSMatthew G Knepley 
172637d0c07bSMatthew G Knepley       ierr = PetscSectionGetDof(sectionGlobal, p, &gdof);CHKERRQ(ierr);
172737d0c07bSMatthew G Knepley       if (gdof > 0) {
172837d0c07bSMatthew G Knepley         ierr = PetscSectionGetOffset(sectionGlobal, p, &goff);CHKERRQ(ierr);
172937d0c07bSMatthew G Knepley         for (f = 0; f < nF; ++f) {
173037d0c07bSMatthew G Knepley           PetscInt fdof, fcdof, fc;
173137d0c07bSMatthew G Knepley 
173237d0c07bSMatthew G Knepley           ierr = PetscSectionGetFieldDof(section, p, f, &fdof);CHKERRQ(ierr);
173337d0c07bSMatthew G Knepley           ierr = PetscSectionGetFieldConstraintDof(section, p, f, &fcdof);CHKERRQ(ierr);
173437d0c07bSMatthew G Knepley           for (fc = 0; fc < fdof-fcdof; ++fc, ++fieldSizes[f]) {
173537d0c07bSMatthew G Knepley             fieldIndices[f][fieldSizes[f]] = goff++;
173637d0c07bSMatthew G Knepley           }
173737d0c07bSMatthew G Knepley         }
173837d0c07bSMatthew G Knepley       }
173937d0c07bSMatthew G Knepley     }
17408865f1eaSKarl Rupp     if (numFields) *numFields = nF;
174137d0c07bSMatthew G Knepley     if (fieldNames) {
1742785e854fSJed Brown       ierr = PetscMalloc1(nF, fieldNames);CHKERRQ(ierr);
174337d0c07bSMatthew G Knepley       for (f = 0; f < nF; ++f) {
174437d0c07bSMatthew G Knepley         const char *fieldName;
174537d0c07bSMatthew G Knepley 
174637d0c07bSMatthew G Knepley         ierr = PetscSectionGetFieldName(section, f, &fieldName);CHKERRQ(ierr);
174737d0c07bSMatthew G Knepley         ierr = PetscStrallocpy(fieldName, (char**) &(*fieldNames)[f]);CHKERRQ(ierr);
174837d0c07bSMatthew G Knepley       }
174937d0c07bSMatthew G Knepley     }
175037d0c07bSMatthew G Knepley     if (fields) {
1751785e854fSJed Brown       ierr = PetscMalloc1(nF, fields);CHKERRQ(ierr);
175237d0c07bSMatthew G Knepley       for (f = 0; f < nF; ++f) {
17533a544194SStefano Zampini         PetscInt bs, in[2], out[2];
17543a544194SStefano Zampini 
175582f516ccSBarry Smith         ierr  = ISCreateGeneral(PetscObjectComm((PetscObject)dm), fieldSizes[f], fieldIndices[f], PETSC_OWN_POINTER, &(*fields)[f]);CHKERRQ(ierr);
17563a544194SStefano Zampini         in[0] = -fieldNc[f];
17573a544194SStefano Zampini         in[1] = fieldNc[f];
17583a544194SStefano Zampini         ierr  = MPIU_Allreduce(in, out, 2, MPIU_INT, MPI_MAX, PetscObjectComm((PetscObject)dm));CHKERRQ(ierr);
17593a544194SStefano Zampini         bs    = (-out[0] == out[1]) ? out[1] : 1;
17603a544194SStefano Zampini         ierr  = ISSetBlockSize((*fields)[f], bs);CHKERRQ(ierr);
176137d0c07bSMatthew G Knepley       }
176237d0c07bSMatthew G Knepley     }
17633a544194SStefano Zampini     ierr = PetscFree3(fieldSizes,fieldNc,fieldIndices);CHKERRQ(ierr);
17648865f1eaSKarl Rupp   } else if (dm->ops->createfieldis) {
17658865f1eaSKarl Rupp     ierr = (*dm->ops->createfieldis)(dm, numFields, fieldNames, fields);CHKERRQ(ierr);
176669ca1f37SDmitry Karpeev   }
17674d343eeaSMatthew G Knepley   PetscFunctionReturn(0);
17684d343eeaSMatthew G Knepley }
17694d343eeaSMatthew G Knepley 
177016621825SDmitry Karpeev 
177116621825SDmitry Karpeev /*@C
177216621825SDmitry Karpeev   DMCreateFieldDecomposition - Returns a list of IS objects defining a decomposition of a problem into subproblems
177316621825SDmitry Karpeev                           corresponding to different fields: each IS contains the global indices of the dofs of the
177416621825SDmitry Karpeev                           corresponding field. The optional list of DMs define the DM for each subproblem.
1775e7c4fc90SDmitry Karpeev                           Generalizes DMCreateFieldIS().
1776e7c4fc90SDmitry Karpeev 
1777e7c4fc90SDmitry Karpeev   Not collective
1778e7c4fc90SDmitry Karpeev 
1779e7c4fc90SDmitry Karpeev   Input Parameter:
1780e7c4fc90SDmitry Karpeev . dm - the DM object
1781e7c4fc90SDmitry Karpeev 
1782e7c4fc90SDmitry Karpeev   Output Parameters:
17830298fd71SBarry Smith + len       - The number of subproblems in the field decomposition (or NULL if not requested)
17840298fd71SBarry Smith . namelist  - The name for each field (or NULL if not requested)
17850298fd71SBarry Smith . islist    - The global indices for each field (or NULL if not requested)
17860298fd71SBarry Smith - dmlist    - The DMs for each field subproblem (or NULL, if not requested; if NULL is returned, no DMs are defined)
1787e7c4fc90SDmitry Karpeev 
1788e7c4fc90SDmitry Karpeev   Level: intermediate
1789e7c4fc90SDmitry Karpeev 
1790e7c4fc90SDmitry Karpeev   Notes:
1791e7c4fc90SDmitry Karpeev   The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with
1792e7c4fc90SDmitry Karpeev   PetscFree(), every entry of is should be destroyed with ISDestroy(), every entry of dm should be destroyed with DMDestroy(),
1793e7c4fc90SDmitry Karpeev   and all of the arrays should be freed with PetscFree().
1794e7c4fc90SDmitry Karpeev 
1795e7c4fc90SDmitry Karpeev .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS()
1796e7c4fc90SDmitry Karpeev @*/
179716621825SDmitry Karpeev PetscErrorCode DMCreateFieldDecomposition(DM dm, PetscInt *len, char ***namelist, IS **islist, DM **dmlist)
1798e7c4fc90SDmitry Karpeev {
1799e7c4fc90SDmitry Karpeev   PetscErrorCode ierr;
1800e7c4fc90SDmitry Karpeev 
1801e7c4fc90SDmitry Karpeev   PetscFunctionBegin;
1802e7c4fc90SDmitry Karpeev   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
18038865f1eaSKarl Rupp   if (len) {
1804534a8f05SLisandro Dalcin     PetscValidIntPointer(len,2);
18058865f1eaSKarl Rupp     *len = 0;
18068865f1eaSKarl Rupp   }
18078865f1eaSKarl Rupp   if (namelist) {
18088865f1eaSKarl Rupp     PetscValidPointer(namelist,3);
1809ea78f98cSLisandro Dalcin     *namelist = NULL;
18108865f1eaSKarl Rupp   }
18118865f1eaSKarl Rupp   if (islist) {
18128865f1eaSKarl Rupp     PetscValidPointer(islist,4);
1813ea78f98cSLisandro Dalcin     *islist = NULL;
18148865f1eaSKarl Rupp   }
18158865f1eaSKarl Rupp   if (dmlist) {
18168865f1eaSKarl Rupp     PetscValidPointer(dmlist,5);
1817ea78f98cSLisandro Dalcin     *dmlist = NULL;
18188865f1eaSKarl Rupp   }
1819f3f0edfdSDmitry Karpeev   /*
1820f3f0edfdSDmitry Karpeev    Is it a good idea to apply the following check across all impls?
1821f3f0edfdSDmitry Karpeev    Perhaps some impls can have a well-defined decomposition before DMSetUp?
1822f3f0edfdSDmitry Karpeev    This, however, follows the general principle that accessors are not well-behaved until the object is set up.
1823f3f0edfdSDmitry Karpeev    */
1824ce94432eSBarry Smith   if (!dm->setupcalled) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_WRONGSTATE, "Decomposition defined only after DMSetUp");
182516621825SDmitry Karpeev   if (!dm->ops->createfielddecomposition) {
1826435a35e8SMatthew G Knepley     PetscSection section;
1827435a35e8SMatthew G Knepley     PetscInt     numFields, f;
1828435a35e8SMatthew G Knepley 
182992fd8e1eSJed Brown     ierr = DMGetLocalSection(dm, &section);CHKERRQ(ierr);
1830435a35e8SMatthew G Knepley     if (section) {ierr = PetscSectionGetNumFields(section, &numFields);CHKERRQ(ierr);}
1831435a35e8SMatthew G Knepley     if (section && numFields && dm->ops->createsubdm) {
1832f25d98f1SMatthew G. Knepley       if (len) *len = numFields;
183303dc3394SMatthew G. Knepley       if (namelist) {ierr = PetscMalloc1(numFields,namelist);CHKERRQ(ierr);}
183403dc3394SMatthew G. Knepley       if (islist)   {ierr = PetscMalloc1(numFields,islist);CHKERRQ(ierr);}
183503dc3394SMatthew G. Knepley       if (dmlist)   {ierr = PetscMalloc1(numFields,dmlist);CHKERRQ(ierr);}
1836435a35e8SMatthew G Knepley       for (f = 0; f < numFields; ++f) {
1837435a35e8SMatthew G Knepley         const char *fieldName;
1838435a35e8SMatthew G Knepley 
183903dc3394SMatthew G. Knepley         ierr = DMCreateSubDM(dm, 1, &f, islist ? &(*islist)[f] : NULL, dmlist ? &(*dmlist)[f] : NULL);CHKERRQ(ierr);
184003dc3394SMatthew G. Knepley         if (namelist) {
1841435a35e8SMatthew G Knepley           ierr = PetscSectionGetFieldName(section, f, &fieldName);CHKERRQ(ierr);
1842435a35e8SMatthew G Knepley           ierr = PetscStrallocpy(fieldName, (char**) &(*namelist)[f]);CHKERRQ(ierr);
1843435a35e8SMatthew G Knepley         }
184403dc3394SMatthew G. Knepley       }
1845435a35e8SMatthew G Knepley     } else {
184669ca1f37SDmitry Karpeev       ierr = DMCreateFieldIS(dm, len, namelist, islist);CHKERRQ(ierr);
1847e7c4fc90SDmitry Karpeev       /* By default there are no DMs associated with subproblems. */
18480298fd71SBarry Smith       if (dmlist) *dmlist = NULL;
1849e7c4fc90SDmitry Karpeev     }
18508865f1eaSKarl Rupp   } else {
185116621825SDmitry Karpeev     ierr = (*dm->ops->createfielddecomposition)(dm,len,namelist,islist,dmlist);CHKERRQ(ierr);
185216621825SDmitry Karpeev   }
185316621825SDmitry Karpeev   PetscFunctionReturn(0);
185416621825SDmitry Karpeev }
185516621825SDmitry Karpeev 
1856564cec59SMatthew G. Knepley /*@
1857435a35e8SMatthew G Knepley   DMCreateSubDM - Returns an IS and DM encapsulating a subproblem defined by the fields passed in.
1858435a35e8SMatthew G Knepley                   The fields are defined by DMCreateFieldIS().
1859435a35e8SMatthew G Knepley 
1860435a35e8SMatthew G Knepley   Not collective
1861435a35e8SMatthew G Knepley 
1862435a35e8SMatthew G Knepley   Input Parameters:
18632adcc780SMatthew G. Knepley + dm        - The DM object
18642adcc780SMatthew G. Knepley . numFields - The number of fields in this subproblem
18652adcc780SMatthew G. Knepley - fields    - The field numbers of the selected fields
1866435a35e8SMatthew G Knepley 
1867435a35e8SMatthew G Knepley   Output Parameters:
18682adcc780SMatthew G. Knepley + is - The global indices for the subproblem
18692adcc780SMatthew G. Knepley - subdm - The DM for the subproblem
1870435a35e8SMatthew G Knepley 
18715d3b26e6SMatthew G. Knepley   Note: You need to call DMPlexSetMigrationSF() on the original DM if you want the Global-To-Natural map to be automatically constructed
18725d3b26e6SMatthew G. Knepley 
1873435a35e8SMatthew G Knepley   Level: intermediate
1874435a35e8SMatthew G Knepley 
18755d3b26e6SMatthew G. Knepley .seealso DMPlexSetMigrationSF(), DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS()
1876435a35e8SMatthew G Knepley @*/
187737bc7515SMatthew G. Knepley PetscErrorCode DMCreateSubDM(DM dm, PetscInt numFields, const PetscInt fields[], IS *is, DM *subdm)
1878435a35e8SMatthew G Knepley {
1879435a35e8SMatthew G Knepley   PetscErrorCode ierr;
1880435a35e8SMatthew G Knepley 
1881435a35e8SMatthew G Knepley   PetscFunctionBegin;
1882435a35e8SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1883435a35e8SMatthew G Knepley   PetscValidPointer(fields,3);
18848865f1eaSKarl Rupp   if (is) PetscValidPointer(is,4);
18858865f1eaSKarl Rupp   if (subdm) PetscValidPointer(subdm,5);
1886b9d85ea2SLisandro Dalcin   if (!dm->ops->createsubdm) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateSubDM",((PetscObject)dm)->type_name);
1887435a35e8SMatthew G Knepley   ierr = (*dm->ops->createsubdm)(dm, numFields, fields, is, subdm);CHKERRQ(ierr);
1888435a35e8SMatthew G Knepley   PetscFunctionReturn(0);
1889435a35e8SMatthew G Knepley }
1890435a35e8SMatthew G Knepley 
18912adcc780SMatthew G. Knepley /*@C
18922adcc780SMatthew G. Knepley   DMCreateSuperDM - Returns an arrays of ISes and DM encapsulating a superproblem defined by the DMs passed in.
18932adcc780SMatthew G. Knepley 
18942adcc780SMatthew G. Knepley   Not collective
18952adcc780SMatthew G. Knepley 
18962adcc780SMatthew G. Knepley   Input Parameter:
18972adcc780SMatthew G. Knepley + dms - The DM objects
18982adcc780SMatthew G. Knepley - len - The number of DMs
18992adcc780SMatthew G. Knepley 
19002adcc780SMatthew G. Knepley   Output Parameters:
1901a42bd24dSMatthew G. Knepley + is - The global indices for the subproblem, or NULL
19022adcc780SMatthew G. Knepley - superdm - The DM for the superproblem
19032adcc780SMatthew G. Knepley 
19045d3b26e6SMatthew G. Knepley   Note: You need to call DMPlexSetMigrationSF() on the original DM if you want the Global-To-Natural map to be automatically constructed
19055d3b26e6SMatthew G. Knepley 
19062adcc780SMatthew G. Knepley   Level: intermediate
19072adcc780SMatthew G. Knepley 
19085d3b26e6SMatthew G. Knepley .seealso DMPlexSetMigrationSF(), DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS()
19092adcc780SMatthew G. Knepley @*/
19102adcc780SMatthew G. Knepley PetscErrorCode DMCreateSuperDM(DM dms[], PetscInt len, IS **is, DM *superdm)
19112adcc780SMatthew G. Knepley {
19122adcc780SMatthew G. Knepley   PetscInt       i;
19132adcc780SMatthew G. Knepley   PetscErrorCode ierr;
19142adcc780SMatthew G. Knepley 
19152adcc780SMatthew G. Knepley   PetscFunctionBegin;
19162adcc780SMatthew G. Knepley   PetscValidPointer(dms,1);
19172adcc780SMatthew G. Knepley   for (i = 0; i < len; ++i) {PetscValidHeaderSpecific(dms[i],DM_CLASSID,1);}
19182adcc780SMatthew G. Knepley   if (is) PetscValidPointer(is,3);
1919a42bd24dSMatthew G. Knepley   PetscValidPointer(superdm,4);
19202adcc780SMatthew G. Knepley   if (len < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Number of DMs must be nonnegative: %D", len);
19212adcc780SMatthew G. Knepley   if (len) {
1922b9d85ea2SLisandro Dalcin     DM dm = dms[0];
1923b9d85ea2SLisandro Dalcin     if (!dm->ops->createsuperdm) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateSuperDM",((PetscObject)dm)->type_name);
1924b9d85ea2SLisandro Dalcin     ierr = (*dm->ops->createsuperdm)(dms, len, is, superdm);CHKERRQ(ierr);
19252adcc780SMatthew G. Knepley   }
19262adcc780SMatthew G. Knepley   PetscFunctionReturn(0);
19272adcc780SMatthew G. Knepley }
19282adcc780SMatthew G. Knepley 
192916621825SDmitry Karpeev 
193016621825SDmitry Karpeev /*@C
19318d4ac253SDmitry Karpeev   DMCreateDomainDecomposition - Returns lists of IS objects defining a decomposition of a problem into subproblems
19328d4ac253SDmitry Karpeev                           corresponding to restrictions to pairs nested subdomains: each IS contains the global
19338d4ac253SDmitry Karpeev                           indices of the dofs of the corresponding subdomains.  The inner subdomains conceptually
19348d4ac253SDmitry Karpeev                           define a nonoverlapping covering, while outer subdomains can overlap.
19358d4ac253SDmitry Karpeev                           The optional list of DMs define the DM for each subproblem.
193616621825SDmitry Karpeev 
193716621825SDmitry Karpeev   Not collective
193816621825SDmitry Karpeev 
193916621825SDmitry Karpeev   Input Parameter:
194016621825SDmitry Karpeev . dm - the DM object
194116621825SDmitry Karpeev 
194216621825SDmitry Karpeev   Output Parameters:
19430298fd71SBarry Smith + len         - The number of subproblems in the domain decomposition (or NULL if not requested)
19440298fd71SBarry Smith . namelist    - The name for each subdomain (or NULL if not requested)
19450298fd71SBarry Smith . innerislist - The global indices for each inner subdomain (or NULL, if not requested)
19460298fd71SBarry Smith . outerislist - The global indices for each outer subdomain (or NULL, if not requested)
19470298fd71SBarry Smith - dmlist      - The DMs for each subdomain subproblem (or NULL, if not requested; if NULL is returned, no DMs are defined)
194816621825SDmitry Karpeev 
194916621825SDmitry Karpeev   Level: intermediate
195016621825SDmitry Karpeev 
195116621825SDmitry Karpeev   Notes:
195216621825SDmitry Karpeev   The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with
195316621825SDmitry Karpeev   PetscFree(), every entry of is should be destroyed with ISDestroy(), every entry of dm should be destroyed with DMDestroy(),
195416621825SDmitry Karpeev   and all of the arrays should be freed with PetscFree().
195516621825SDmitry Karpeev 
1956245d9833Sprj- .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldDecomposition()
195716621825SDmitry Karpeev @*/
19588d4ac253SDmitry Karpeev PetscErrorCode DMCreateDomainDecomposition(DM dm, PetscInt *len, char ***namelist, IS **innerislist, IS **outerislist, DM **dmlist)
195916621825SDmitry Karpeev {
196016621825SDmitry Karpeev   PetscErrorCode      ierr;
1961be081cd6SPeter Brune   DMSubDomainHookLink link;
1962be081cd6SPeter Brune   PetscInt            i,l;
196316621825SDmitry Karpeev 
196416621825SDmitry Karpeev   PetscFunctionBegin;
196516621825SDmitry Karpeev   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
196614a18fd3SPeter Brune   if (len)           {PetscValidPointer(len,2);            *len         = 0;}
19670298fd71SBarry Smith   if (namelist)      {PetscValidPointer(namelist,3);       *namelist    = NULL;}
19680298fd71SBarry Smith   if (innerislist)   {PetscValidPointer(innerislist,4);    *innerislist = NULL;}
19690298fd71SBarry Smith   if (outerislist)   {PetscValidPointer(outerislist,5);    *outerislist = NULL;}
19700298fd71SBarry Smith   if (dmlist)        {PetscValidPointer(dmlist,6);         *dmlist      = NULL;}
1971f3f0edfdSDmitry Karpeev   /*
1972f3f0edfdSDmitry Karpeev    Is it a good idea to apply the following check across all impls?
1973f3f0edfdSDmitry Karpeev    Perhaps some impls can have a well-defined decomposition before DMSetUp?
1974f3f0edfdSDmitry Karpeev    This, however, follows the general principle that accessors are not well-behaved until the object is set up.
1975f3f0edfdSDmitry Karpeev    */
1976ce94432eSBarry Smith   if (!dm->setupcalled) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_WRONGSTATE, "Decomposition defined only after DMSetUp");
197716621825SDmitry Karpeev   if (dm->ops->createdomaindecomposition) {
1978be081cd6SPeter Brune     ierr = (*dm->ops->createdomaindecomposition)(dm,&l,namelist,innerislist,outerislist,dmlist);CHKERRQ(ierr);
197914a18fd3SPeter Brune     /* copy subdomain hooks and context over to the subdomain DMs */
1980f891f5b9SPatrick Sanan     if (dmlist && *dmlist) {
1981be081cd6SPeter Brune       for (i = 0; i < l; i++) {
1982be081cd6SPeter Brune         for (link=dm->subdomainhook; link; link=link->next) {
1983be081cd6SPeter Brune           if (link->ddhook) {ierr = (*link->ddhook)(dm,(*dmlist)[i],link->ctx);CHKERRQ(ierr);}
1984be081cd6SPeter Brune         }
1985648262bbSPatrick Sanan         if (dm->ctx) (*dmlist)[i]->ctx = dm->ctx;
1986e7c4fc90SDmitry Karpeev       }
198714a18fd3SPeter Brune     }
198814a18fd3SPeter Brune     if (len) *len = l;
198914a18fd3SPeter Brune   }
1990e30e807fSPeter Brune   PetscFunctionReturn(0);
1991e30e807fSPeter Brune }
1992e30e807fSPeter Brune 
1993e30e807fSPeter Brune 
1994e30e807fSPeter Brune /*@C
1995e30e807fSPeter Brune   DMCreateDomainDecompositionScatters - Returns scatters to the subdomain vectors from the global vector
1996e30e807fSPeter Brune 
1997e30e807fSPeter Brune   Not collective
1998e30e807fSPeter Brune 
1999e30e807fSPeter Brune   Input Parameters:
2000e30e807fSPeter Brune + dm - the DM object
2001e30e807fSPeter Brune . n  - the number of subdomain scatters
2002e30e807fSPeter Brune - subdms - the local subdomains
2003e30e807fSPeter Brune 
2004e30e807fSPeter Brune   Output Parameters:
2005e30e807fSPeter Brune + n     - the number of scatters returned
2006e30e807fSPeter Brune . iscat - scatter from global vector to nonoverlapping global vector entries on subdomain
2007e30e807fSPeter Brune . oscat - scatter from global vector to overlapping global vector entries on subdomain
2008e30e807fSPeter Brune - gscat - scatter from global vector to local vector on subdomain (fills in ghosts)
2009e30e807fSPeter Brune 
201095452b02SPatrick Sanan   Notes:
201195452b02SPatrick Sanan     This is an alternative to the iis and ois arguments in DMCreateDomainDecomposition that allow for the solution
2012e30e807fSPeter Brune   of general nonlinear problems with overlapping subdomain methods.  While merely having index sets that enable subsets
2013e30e807fSPeter Brune   of the residual equations to be created is fine for linear problems, nonlinear problems require local assembly of
2014e30e807fSPeter Brune   solution and residual data.
2015e30e807fSPeter Brune 
2016e30e807fSPeter Brune   Level: developer
2017e30e807fSPeter Brune 
2018e30e807fSPeter Brune .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS()
2019e30e807fSPeter Brune @*/
2020e30e807fSPeter Brune PetscErrorCode DMCreateDomainDecompositionScatters(DM dm,PetscInt n,DM *subdms,VecScatter **iscat,VecScatter **oscat,VecScatter **gscat)
2021e30e807fSPeter Brune {
2022e30e807fSPeter Brune   PetscErrorCode ierr;
2023e30e807fSPeter Brune 
2024e30e807fSPeter Brune   PetscFunctionBegin;
2025e30e807fSPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2026e30e807fSPeter Brune   PetscValidPointer(subdms,3);
2027b9d85ea2SLisandro Dalcin   if (!dm->ops->createddscatters) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateDomainDecompositionScatters",((PetscObject)dm)->type_name);
2028e30e807fSPeter Brune   ierr = (*dm->ops->createddscatters)(dm,n,subdms,iscat,oscat,gscat);CHKERRQ(ierr);
2029e7c4fc90SDmitry Karpeev   PetscFunctionReturn(0);
2030e7c4fc90SDmitry Karpeev }
2031e7c4fc90SDmitry Karpeev 
203247c6ae99SBarry Smith /*@
203347c6ae99SBarry Smith   DMRefine - Refines a DM object
203447c6ae99SBarry Smith 
2035d083f849SBarry Smith   Collective on dm
203647c6ae99SBarry Smith 
203747c6ae99SBarry Smith   Input Parameter:
203847c6ae99SBarry Smith + dm   - the DM object
203991d95f02SJed Brown - comm - the communicator to contain the new DM object (or MPI_COMM_NULL)
204047c6ae99SBarry Smith 
204147c6ae99SBarry Smith   Output Parameter:
20420298fd71SBarry Smith . dmf - the refined DM, or NULL
2043ae0a1c52SMatthew G Knepley 
2044412e9a14SMatthew G. Knepley   Options Dtabase Keys:
2045412e9a14SMatthew G. Knepley . -dm_plex_cell_refiner <strategy> - chooses the refinement strategy, e.g. regular, tohex
2046412e9a14SMatthew G. Knepley 
20470298fd71SBarry Smith   Note: If no refinement was done, the return value is NULL
204847c6ae99SBarry Smith 
204947c6ae99SBarry Smith   Level: developer
205047c6ae99SBarry Smith 
2051e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
205247c6ae99SBarry Smith @*/
20537087cfbeSBarry Smith PetscErrorCode  DMRefine(DM dm,MPI_Comm comm,DM *dmf)
205447c6ae99SBarry Smith {
205547c6ae99SBarry Smith   PetscErrorCode   ierr;
2056c833c3b5SJed Brown   DMRefineHookLink link;
205747c6ae99SBarry Smith 
205847c6ae99SBarry Smith   PetscFunctionBegin;
2059732e2eb9SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2060b9d85ea2SLisandro Dalcin   if (!dm->ops->refine) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMRefine",((PetscObject)dm)->type_name);
20611ac00216SMatthew G. Knepley   ierr = PetscLogEventBegin(DM_Refine,dm,0,0,0);CHKERRQ(ierr);
206247c6ae99SBarry Smith   ierr = (*dm->ops->refine)(dm,comm,dmf);CHKERRQ(ierr);
20634057135bSMatthew G Knepley   if (*dmf) {
206443842a1eSJed Brown     (*dmf)->ops->creatematrix = dm->ops->creatematrix;
20658865f1eaSKarl Rupp 
20668cd211a4SJed Brown     ierr = PetscObjectCopyFortranFunctionPointers((PetscObject)dm,(PetscObject)*dmf);CHKERRQ(ierr);
20678865f1eaSKarl Rupp 
2068644e2e5bSBarry Smith     (*dmf)->ctx       = dm->ctx;
20690598a293SJed Brown     (*dmf)->leveldown = dm->leveldown;
2070656b349aSBarry Smith     (*dmf)->levelup   = dm->levelup + 1;
20718865f1eaSKarl Rupp 
2072e4b4b23bSJed Brown     ierr = DMSetMatType(*dmf,dm->mattype);CHKERRQ(ierr);
2073c833c3b5SJed Brown     for (link=dm->refinehook; link; link=link->next) {
20748865f1eaSKarl Rupp       if (link->refinehook) {
20758865f1eaSKarl Rupp         ierr = (*link->refinehook)(dm,*dmf,link->ctx);CHKERRQ(ierr);
20768865f1eaSKarl Rupp       }
2077c833c3b5SJed Brown     }
2078c833c3b5SJed Brown   }
20791ac00216SMatthew G. Knepley   ierr = PetscLogEventEnd(DM_Refine,dm,0,0,0);CHKERRQ(ierr);
2080c833c3b5SJed Brown   PetscFunctionReturn(0);
2081c833c3b5SJed Brown }
2082c833c3b5SJed Brown 
2083bb9467b5SJed Brown /*@C
2084c833c3b5SJed Brown    DMRefineHookAdd - adds a callback to be run when interpolating a nonlinear problem to a finer grid
2085c833c3b5SJed Brown 
2086c833c3b5SJed Brown    Logically Collective
2087c833c3b5SJed Brown 
2088c833c3b5SJed Brown    Input Arguments:
2089c833c3b5SJed Brown +  coarse - nonlinear solver context on which to run a hook when restricting to a coarser level
2090c833c3b5SJed Brown .  refinehook - function to run when setting up a coarser level
2091c833c3b5SJed Brown .  interphook - function to run to update data on finer levels (once per SNESSolve())
20920298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
2093c833c3b5SJed Brown 
2094c833c3b5SJed Brown    Calling sequence of refinehook:
2095c833c3b5SJed Brown $    refinehook(DM coarse,DM fine,void *ctx);
2096c833c3b5SJed Brown 
2097c833c3b5SJed Brown +  coarse - coarse level DM
2098c833c3b5SJed Brown .  fine - fine level DM to interpolate problem to
2099c833c3b5SJed Brown -  ctx - optional user-defined function context
2100c833c3b5SJed Brown 
2101c833c3b5SJed Brown    Calling sequence for interphook:
2102c833c3b5SJed Brown $    interphook(DM coarse,Mat interp,DM fine,void *ctx)
2103c833c3b5SJed Brown 
2104c833c3b5SJed Brown +  coarse - coarse level DM
2105c833c3b5SJed Brown .  interp - matrix interpolating a coarse-level solution to the finer grid
2106c833c3b5SJed Brown .  fine - fine level DM to update
2107c833c3b5SJed Brown -  ctx - optional user-defined function context
2108c833c3b5SJed Brown 
2109c833c3b5SJed Brown    Level: advanced
2110c833c3b5SJed Brown 
2111c833c3b5SJed Brown    Notes:
2112c833c3b5SJed Brown    This function is only needed if auxiliary data needs to be passed to fine grids while grid sequencing
2113c833c3b5SJed Brown 
2114c833c3b5SJed Brown    If this function is called multiple times, the hooks will be run in the order they are added.
2115c833c3b5SJed Brown 
2116bb9467b5SJed Brown    This function is currently not available from Fortran.
2117bb9467b5SJed Brown 
2118c833c3b5SJed Brown .seealso: DMCoarsenHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
2119c833c3b5SJed Brown @*/
2120c833c3b5SJed Brown PetscErrorCode DMRefineHookAdd(DM coarse,PetscErrorCode (*refinehook)(DM,DM,void*),PetscErrorCode (*interphook)(DM,Mat,DM,void*),void *ctx)
2121c833c3b5SJed Brown {
2122c833c3b5SJed Brown   PetscErrorCode   ierr;
2123c833c3b5SJed Brown   DMRefineHookLink link,*p;
2124c833c3b5SJed Brown 
2125c833c3b5SJed Brown   PetscFunctionBegin;
2126c833c3b5SJed Brown   PetscValidHeaderSpecific(coarse,DM_CLASSID,1);
21273d8e3701SJed Brown   for (p=&coarse->refinehook; *p; p=&(*p)->next) { /* Scan to the end of the current list of hooks */
21283d8e3701SJed Brown     if ((*p)->refinehook == refinehook && (*p)->interphook == interphook && (*p)->ctx == ctx) PetscFunctionReturn(0);
21293d8e3701SJed Brown   }
213095dccacaSBarry Smith   ierr             = PetscNew(&link);CHKERRQ(ierr);
2131c833c3b5SJed Brown   link->refinehook = refinehook;
2132c833c3b5SJed Brown   link->interphook = interphook;
2133c833c3b5SJed Brown   link->ctx        = ctx;
21340298fd71SBarry Smith   link->next       = NULL;
2135c833c3b5SJed Brown   *p               = link;
2136c833c3b5SJed Brown   PetscFunctionReturn(0);
2137c833c3b5SJed Brown }
2138c833c3b5SJed Brown 
21393d8e3701SJed Brown /*@C
21403d8e3701SJed Brown    DMRefineHookRemove - remove a callback from the list of hooks to be run when interpolating a nonlinear problem to a finer grid
21413d8e3701SJed Brown 
21423d8e3701SJed Brown    Logically Collective
21433d8e3701SJed Brown 
21443d8e3701SJed Brown    Input Arguments:
21453d8e3701SJed Brown +  coarse - nonlinear solver context on which to run a hook when restricting to a coarser level
21463d8e3701SJed Brown .  refinehook - function to run when setting up a coarser level
21473d8e3701SJed Brown .  interphook - function to run to update data on finer levels (once per SNESSolve())
21483d8e3701SJed Brown -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
21493d8e3701SJed Brown 
21503d8e3701SJed Brown    Level: advanced
21513d8e3701SJed Brown 
21523d8e3701SJed Brown    Notes:
21533d8e3701SJed Brown    This function does nothing if the hook is not in the list.
21543d8e3701SJed Brown 
21553d8e3701SJed Brown    This function is currently not available from Fortran.
21563d8e3701SJed Brown 
21573d8e3701SJed Brown .seealso: DMCoarsenHookRemove(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
21583d8e3701SJed Brown @*/
21593d8e3701SJed Brown PetscErrorCode DMRefineHookRemove(DM coarse,PetscErrorCode (*refinehook)(DM,DM,void*),PetscErrorCode (*interphook)(DM,Mat,DM,void*),void *ctx)
21603d8e3701SJed Brown {
21613d8e3701SJed Brown   PetscErrorCode   ierr;
21623d8e3701SJed Brown   DMRefineHookLink link,*p;
21633d8e3701SJed Brown 
21643d8e3701SJed Brown   PetscFunctionBegin;
21653d8e3701SJed Brown   PetscValidHeaderSpecific(coarse,DM_CLASSID,1);
21663d8e3701SJed Brown   for (p=&coarse->refinehook; *p; p=&(*p)->next) { /* Search the list of current hooks */
21673d8e3701SJed Brown     if ((*p)->refinehook == refinehook && (*p)->interphook == interphook && (*p)->ctx == ctx) {
21683d8e3701SJed Brown       link = *p;
21693d8e3701SJed Brown       *p = link->next;
21703d8e3701SJed Brown       ierr = PetscFree(link);CHKERRQ(ierr);
21713d8e3701SJed Brown       break;
21723d8e3701SJed Brown     }
21733d8e3701SJed Brown   }
21743d8e3701SJed Brown   PetscFunctionReturn(0);
21753d8e3701SJed Brown }
21763d8e3701SJed Brown 
2177c833c3b5SJed Brown /*@
2178c833c3b5SJed Brown    DMInterpolate - interpolates user-defined problem data to a finer DM by running hooks registered by DMRefineHookAdd()
2179c833c3b5SJed Brown 
2180c833c3b5SJed Brown    Collective if any hooks are
2181c833c3b5SJed Brown 
2182c833c3b5SJed Brown    Input Arguments:
2183c833c3b5SJed Brown +  coarse - coarser DM to use as a base
2184e91eccc2SStefano Zampini .  interp - interpolation matrix, apply using MatInterpolate()
2185c833c3b5SJed Brown -  fine - finer DM to update
2186c833c3b5SJed Brown 
2187c833c3b5SJed Brown    Level: developer
2188c833c3b5SJed Brown 
2189c833c3b5SJed Brown .seealso: DMRefineHookAdd(), MatInterpolate()
2190c833c3b5SJed Brown @*/
2191c833c3b5SJed Brown PetscErrorCode DMInterpolate(DM coarse,Mat interp,DM fine)
2192c833c3b5SJed Brown {
2193c833c3b5SJed Brown   PetscErrorCode   ierr;
2194c833c3b5SJed Brown   DMRefineHookLink link;
2195c833c3b5SJed Brown 
2196c833c3b5SJed Brown   PetscFunctionBegin;
2197c833c3b5SJed Brown   for (link=fine->refinehook; link; link=link->next) {
21988865f1eaSKarl Rupp     if (link->interphook) {
21998865f1eaSKarl Rupp       ierr = (*link->interphook)(coarse,interp,fine,link->ctx);CHKERRQ(ierr);
22008865f1eaSKarl Rupp     }
22014057135bSMatthew G Knepley   }
220247c6ae99SBarry Smith   PetscFunctionReturn(0);
220347c6ae99SBarry Smith }
220447c6ae99SBarry Smith 
2205eb3f98d2SBarry Smith /*@
2206aed49f88SRichard Tran Mills     DMGetRefineLevel - Gets the number of refinements that have generated this DM.
2207eb3f98d2SBarry Smith 
2208eb3f98d2SBarry Smith     Not Collective
2209eb3f98d2SBarry Smith 
2210eb3f98d2SBarry Smith     Input Parameter:
2211eb3f98d2SBarry Smith .   dm - the DM object
2212eb3f98d2SBarry Smith 
2213eb3f98d2SBarry Smith     Output Parameter:
2214eb3f98d2SBarry Smith .   level - number of refinements
2215eb3f98d2SBarry Smith 
2216eb3f98d2SBarry Smith     Level: developer
2217eb3f98d2SBarry Smith 
22186a7d9d85SPeter Brune .seealso DMCoarsen(), DMGetCoarsenLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
2219eb3f98d2SBarry Smith 
2220eb3f98d2SBarry Smith @*/
2221eb3f98d2SBarry Smith PetscErrorCode  DMGetRefineLevel(DM dm,PetscInt *level)
2222eb3f98d2SBarry Smith {
2223eb3f98d2SBarry Smith   PetscFunctionBegin;
2224eb3f98d2SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2225eb3f98d2SBarry Smith   *level = dm->levelup;
2226eb3f98d2SBarry Smith   PetscFunctionReturn(0);
2227eb3f98d2SBarry Smith }
2228eb3f98d2SBarry Smith 
2229fef3a512SBarry Smith /*@
2230aed49f88SRichard Tran Mills     DMSetRefineLevel - Sets the number of refinements that have generated this DM.
2231fef3a512SBarry Smith 
2232fef3a512SBarry Smith     Not Collective
2233fef3a512SBarry Smith 
2234fef3a512SBarry Smith     Input Parameter:
2235fef3a512SBarry Smith +   dm - the DM object
2236fef3a512SBarry Smith -   level - number of refinements
2237fef3a512SBarry Smith 
2238fef3a512SBarry Smith     Level: advanced
2239fef3a512SBarry Smith 
224095452b02SPatrick Sanan     Notes:
224195452b02SPatrick Sanan     This value is used by PCMG to determine how many multigrid levels to use
2242fef3a512SBarry Smith 
2243fef3a512SBarry Smith .seealso DMCoarsen(), DMGetCoarsenLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
2244fef3a512SBarry Smith 
2245fef3a512SBarry Smith @*/
2246fef3a512SBarry Smith PetscErrorCode  DMSetRefineLevel(DM dm,PetscInt level)
2247fef3a512SBarry Smith {
2248fef3a512SBarry Smith   PetscFunctionBegin;
2249fef3a512SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2250fef3a512SBarry Smith   dm->levelup = level;
2251fef3a512SBarry Smith   PetscFunctionReturn(0);
2252fef3a512SBarry Smith }
2253fef3a512SBarry Smith 
2254ca3d3a14SMatthew G. Knepley PetscErrorCode DMGetBasisTransformDM_Internal(DM dm, DM *tdm)
2255ca3d3a14SMatthew G. Knepley {
2256ca3d3a14SMatthew G. Knepley   PetscFunctionBegin;
2257ca3d3a14SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2258ca3d3a14SMatthew G. Knepley   PetscValidPointer(tdm, 2);
2259ca3d3a14SMatthew G. Knepley   *tdm = dm->transformDM;
2260ca3d3a14SMatthew G. Knepley   PetscFunctionReturn(0);
2261ca3d3a14SMatthew G. Knepley }
2262ca3d3a14SMatthew G. Knepley 
2263ca3d3a14SMatthew G. Knepley PetscErrorCode DMGetBasisTransformVec_Internal(DM dm, Vec *tv)
2264ca3d3a14SMatthew G. Knepley {
2265ca3d3a14SMatthew G. Knepley   PetscFunctionBegin;
2266ca3d3a14SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2267ca3d3a14SMatthew G. Knepley   PetscValidPointer(tv, 2);
2268ca3d3a14SMatthew G. Knepley   *tv = dm->transform;
2269ca3d3a14SMatthew G. Knepley   PetscFunctionReturn(0);
2270ca3d3a14SMatthew G. Knepley }
2271ca3d3a14SMatthew G. Knepley 
2272ca3d3a14SMatthew G. Knepley /*@
2273c0f8e1fdSMatthew G. Knepley   DMHasBasisTransform - Whether we employ a basis transformation from functions in global vectors to functions in local vectors
2274ca3d3a14SMatthew G. Knepley 
2275ca3d3a14SMatthew G. Knepley   Input Parameter:
2276ca3d3a14SMatthew G. Knepley . dm - The DM
2277ca3d3a14SMatthew G. Knepley 
2278ca3d3a14SMatthew G. Knepley   Output Parameter:
2279ca3d3a14SMatthew G. Knepley . flg - PETSC_TRUE if a basis transformation should be done
2280ca3d3a14SMatthew G. Knepley 
2281ca3d3a14SMatthew G. Knepley   Level: developer
2282ca3d3a14SMatthew G. Knepley 
2283436bc73aSJed Brown .seealso: DMPlexGlobalToLocalBasis(), DMPlexLocalToGlobalBasis(), DMPlexCreateBasisRotation()
2284ca3d3a14SMatthew G. Knepley @*/
2285ca3d3a14SMatthew G. Knepley PetscErrorCode DMHasBasisTransform(DM dm, PetscBool *flg)
2286ca3d3a14SMatthew G. Knepley {
2287ca3d3a14SMatthew G. Knepley   Vec            tv;
2288ca3d3a14SMatthew G. Knepley   PetscErrorCode ierr;
2289ca3d3a14SMatthew G. Knepley 
2290ca3d3a14SMatthew G. Knepley   PetscFunctionBegin;
2291ca3d3a14SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2292534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg, 2);
2293ca3d3a14SMatthew G. Knepley   ierr = DMGetBasisTransformVec_Internal(dm, &tv);CHKERRQ(ierr);
2294ca3d3a14SMatthew G. Knepley   *flg = tv ? PETSC_TRUE : PETSC_FALSE;
2295ca3d3a14SMatthew G. Knepley   PetscFunctionReturn(0);
2296ca3d3a14SMatthew G. Knepley }
2297ca3d3a14SMatthew G. Knepley 
2298ca3d3a14SMatthew G. Knepley PetscErrorCode DMConstructBasisTransform_Internal(DM dm)
2299ca3d3a14SMatthew G. Knepley {
2300ca3d3a14SMatthew G. Knepley   PetscSection   s, ts;
2301ca3d3a14SMatthew G. Knepley   PetscScalar   *ta;
2302ca3d3a14SMatthew G. Knepley   PetscInt       cdim, pStart, pEnd, p, Nf, f, Nc, dof;
2303ca3d3a14SMatthew G. Knepley   PetscErrorCode ierr;
2304ca3d3a14SMatthew G. Knepley 
2305ca3d3a14SMatthew G. Knepley   PetscFunctionBegin;
2306ca3d3a14SMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
230792fd8e1eSJed Brown   ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr);
2308ca3d3a14SMatthew G. Knepley   ierr = PetscSectionGetChart(s, &pStart, &pEnd);CHKERRQ(ierr);
2309ca3d3a14SMatthew G. Knepley   ierr = PetscSectionGetNumFields(s, &Nf);CHKERRQ(ierr);
2310ca3d3a14SMatthew G. Knepley   ierr = DMClone(dm, &dm->transformDM);CHKERRQ(ierr);
231192fd8e1eSJed Brown   ierr = DMGetLocalSection(dm->transformDM, &ts);CHKERRQ(ierr);
2312ca3d3a14SMatthew G. Knepley   ierr = PetscSectionSetNumFields(ts, Nf);CHKERRQ(ierr);
2313ca3d3a14SMatthew G. Knepley   ierr = PetscSectionSetChart(ts, pStart, pEnd);CHKERRQ(ierr);
2314ca3d3a14SMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
2315ca3d3a14SMatthew G. Knepley     ierr = PetscSectionGetFieldComponents(s, f, &Nc);CHKERRQ(ierr);
2316ca3d3a14SMatthew G. Knepley     /* We could start to label fields by their transformation properties */
2317ca3d3a14SMatthew G. Knepley     if (Nc != cdim) continue;
2318ca3d3a14SMatthew G. Knepley     for (p = pStart; p < pEnd; ++p) {
2319ca3d3a14SMatthew G. Knepley       ierr = PetscSectionGetFieldDof(s, p, f, &dof);CHKERRQ(ierr);
2320ca3d3a14SMatthew G. Knepley       if (!dof) continue;
2321ca3d3a14SMatthew G. Knepley       ierr = PetscSectionSetFieldDof(ts, p, f, PetscSqr(cdim));CHKERRQ(ierr);
2322ca3d3a14SMatthew G. Knepley       ierr = PetscSectionAddDof(ts, p, PetscSqr(cdim));CHKERRQ(ierr);
2323ca3d3a14SMatthew G. Knepley     }
2324ca3d3a14SMatthew G. Knepley   }
2325ca3d3a14SMatthew G. Knepley   ierr = PetscSectionSetUp(ts);CHKERRQ(ierr);
2326ca3d3a14SMatthew G. Knepley   ierr = DMCreateLocalVector(dm->transformDM, &dm->transform);CHKERRQ(ierr);
2327ca3d3a14SMatthew G. Knepley   ierr = VecGetArray(dm->transform, &ta);CHKERRQ(ierr);
2328ca3d3a14SMatthew G. Knepley   for (p = pStart; p < pEnd; ++p) {
2329ca3d3a14SMatthew G. Knepley     for (f = 0; f < Nf; ++f) {
2330ca3d3a14SMatthew G. Knepley       ierr = PetscSectionGetFieldDof(ts, p, f, &dof);CHKERRQ(ierr);
2331ca3d3a14SMatthew G. Knepley       if (dof) {
2332ca3d3a14SMatthew G. Knepley         PetscReal          x[3] = {0.0, 0.0, 0.0};
2333ca3d3a14SMatthew G. Knepley         PetscScalar       *tva;
2334ca3d3a14SMatthew G. Knepley         const PetscScalar *A;
2335ca3d3a14SMatthew G. Knepley 
2336ca3d3a14SMatthew G. Knepley         /* TODO Get quadrature point for this dual basis vector for coordinate */
2337ca3d3a14SMatthew G. Knepley         ierr = (*dm->transformGetMatrix)(dm, x, PETSC_TRUE, &A, dm->transformCtx);CHKERRQ(ierr);
2338ca3d3a14SMatthew G. Knepley         ierr = DMPlexPointLocalFieldRef(dm->transformDM, p, f, ta, (void *) &tva);CHKERRQ(ierr);
2339580bdb30SBarry Smith         ierr = PetscArraycpy(tva, A, PetscSqr(cdim));CHKERRQ(ierr);
2340ca3d3a14SMatthew G. Knepley       }
2341ca3d3a14SMatthew G. Knepley     }
2342ca3d3a14SMatthew G. Knepley   }
2343ca3d3a14SMatthew G. Knepley   ierr = VecRestoreArray(dm->transform, &ta);CHKERRQ(ierr);
2344ca3d3a14SMatthew G. Knepley   PetscFunctionReturn(0);
2345ca3d3a14SMatthew G. Knepley }
2346ca3d3a14SMatthew G. Knepley 
2347ca3d3a14SMatthew G. Knepley PetscErrorCode DMCopyTransform(DM dm, DM newdm)
2348ca3d3a14SMatthew G. Knepley {
2349ca3d3a14SMatthew G. Knepley   PetscErrorCode ierr;
2350ca3d3a14SMatthew G. Knepley 
2351ca3d3a14SMatthew G. Knepley   PetscFunctionBegin;
2352ca3d3a14SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2353ca3d3a14SMatthew G. Knepley   PetscValidHeaderSpecific(newdm, DM_CLASSID, 2);
2354ca3d3a14SMatthew G. Knepley   newdm->transformCtx       = dm->transformCtx;
2355ca3d3a14SMatthew G. Knepley   newdm->transformSetUp     = dm->transformSetUp;
2356ca3d3a14SMatthew G. Knepley   newdm->transformDestroy   = NULL;
2357ca3d3a14SMatthew G. Knepley   newdm->transformGetMatrix = dm->transformGetMatrix;
2358ca3d3a14SMatthew G. Knepley   if (newdm->transformSetUp) {ierr = DMConstructBasisTransform_Internal(newdm);CHKERRQ(ierr);}
2359ca3d3a14SMatthew G. Knepley   PetscFunctionReturn(0);
2360ca3d3a14SMatthew G. Knepley }
2361ca3d3a14SMatthew G. Knepley 
2362bb9467b5SJed Brown /*@C
2363baf369e7SPeter Brune    DMGlobalToLocalHookAdd - adds a callback to be run when global to local is called
2364baf369e7SPeter Brune 
2365baf369e7SPeter Brune    Logically Collective
2366baf369e7SPeter Brune 
2367baf369e7SPeter Brune    Input Arguments:
2368baf369e7SPeter Brune +  dm - the DM
2369baf369e7SPeter Brune .  beginhook - function to run at the beginning of DMGlobalToLocalBegin()
2370baf369e7SPeter Brune .  endhook - function to run after DMGlobalToLocalEnd() has completed
23710298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
2372baf369e7SPeter Brune 
2373baf369e7SPeter Brune    Calling sequence for beginhook:
2374baf369e7SPeter Brune $    beginhook(DM fine,VecScatter out,VecScatter in,DM coarse,void *ctx)
2375baf369e7SPeter Brune 
2376baf369e7SPeter Brune +  dm - global DM
2377baf369e7SPeter Brune .  g - global vector
2378baf369e7SPeter Brune .  mode - mode
2379baf369e7SPeter Brune .  l - local vector
2380baf369e7SPeter Brune -  ctx - optional user-defined function context
2381baf369e7SPeter Brune 
2382baf369e7SPeter Brune 
2383baf369e7SPeter Brune    Calling sequence for endhook:
2384ec4806b8SPeter Brune $    endhook(DM fine,VecScatter out,VecScatter in,DM coarse,void *ctx)
2385baf369e7SPeter Brune 
2386baf369e7SPeter Brune +  global - global DM
2387baf369e7SPeter Brune -  ctx - optional user-defined function context
2388baf369e7SPeter Brune 
2389baf369e7SPeter Brune    Level: advanced
2390baf369e7SPeter Brune 
2391baf369e7SPeter Brune .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
2392baf369e7SPeter Brune @*/
2393baf369e7SPeter Brune PetscErrorCode DMGlobalToLocalHookAdd(DM dm,PetscErrorCode (*beginhook)(DM,Vec,InsertMode,Vec,void*),PetscErrorCode (*endhook)(DM,Vec,InsertMode,Vec,void*),void *ctx)
2394baf369e7SPeter Brune {
2395baf369e7SPeter Brune   PetscErrorCode          ierr;
2396baf369e7SPeter Brune   DMGlobalToLocalHookLink link,*p;
2397baf369e7SPeter Brune 
2398baf369e7SPeter Brune   PetscFunctionBegin;
2399baf369e7SPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2400baf369e7SPeter Brune   for (p=&dm->gtolhook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */
240195dccacaSBarry Smith   ierr            = PetscNew(&link);CHKERRQ(ierr);
2402baf369e7SPeter Brune   link->beginhook = beginhook;
2403baf369e7SPeter Brune   link->endhook   = endhook;
2404baf369e7SPeter Brune   link->ctx       = ctx;
24050298fd71SBarry Smith   link->next      = NULL;
2406baf369e7SPeter Brune   *p              = link;
2407baf369e7SPeter Brune   PetscFunctionReturn(0);
2408baf369e7SPeter Brune }
2409baf369e7SPeter Brune 
24104c274da1SToby Isaac static PetscErrorCode DMGlobalToLocalHook_Constraints(DM dm, Vec g, InsertMode mode, Vec l, void *ctx)
24114c274da1SToby Isaac {
24124c274da1SToby Isaac   Mat cMat;
24134c274da1SToby Isaac   Vec cVec;
24144c274da1SToby Isaac   PetscSection section, cSec;
24154c274da1SToby Isaac   PetscInt pStart, pEnd, p, dof;
24164c274da1SToby Isaac   PetscErrorCode ierr;
24174c274da1SToby Isaac 
24184c274da1SToby Isaac   PetscFunctionBegin;
24194c274da1SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
24204c274da1SToby Isaac   ierr = DMGetDefaultConstraints(dm,&cSec,&cMat);CHKERRQ(ierr);
24214c274da1SToby Isaac   if (cMat && (mode == INSERT_VALUES || mode == INSERT_ALL_VALUES || mode == INSERT_BC_VALUES)) {
24225db9a05bSToby Isaac     PetscInt nRows;
24235db9a05bSToby Isaac 
24245db9a05bSToby Isaac     ierr = MatGetSize(cMat,&nRows,NULL);CHKERRQ(ierr);
24255db9a05bSToby Isaac     if (nRows <= 0) PetscFunctionReturn(0);
242692fd8e1eSJed Brown     ierr = DMGetLocalSection(dm,&section);CHKERRQ(ierr);
24277711e48fSToby Isaac     ierr = MatCreateVecs(cMat,NULL,&cVec);CHKERRQ(ierr);
24284c274da1SToby Isaac     ierr = MatMult(cMat,l,cVec);CHKERRQ(ierr);
24294c274da1SToby Isaac     ierr = PetscSectionGetChart(cSec,&pStart,&pEnd);CHKERRQ(ierr);
24304c274da1SToby Isaac     for (p = pStart; p < pEnd; p++) {
24314c274da1SToby Isaac       ierr = PetscSectionGetDof(cSec,p,&dof);CHKERRQ(ierr);
24324c274da1SToby Isaac       if (dof) {
24334c274da1SToby Isaac         PetscScalar *vals;
24344c274da1SToby Isaac         ierr = VecGetValuesSection(cVec,cSec,p,&vals);CHKERRQ(ierr);
24354c274da1SToby Isaac         ierr = VecSetValuesSection(l,section,p,vals,INSERT_ALL_VALUES);CHKERRQ(ierr);
24364c274da1SToby Isaac       }
24374c274da1SToby Isaac     }
24384c274da1SToby Isaac     ierr = VecDestroy(&cVec);CHKERRQ(ierr);
24394c274da1SToby Isaac   }
24404c274da1SToby Isaac   PetscFunctionReturn(0);
24414c274da1SToby Isaac }
24424c274da1SToby Isaac 
244347c6ae99SBarry Smith /*@
244401729b5cSPatrick Sanan     DMGlobalToLocal - update local vectors from global vector
244501729b5cSPatrick Sanan 
2446d083f849SBarry Smith     Neighbor-wise Collective on dm
244701729b5cSPatrick Sanan 
244801729b5cSPatrick Sanan     Input Parameters:
244901729b5cSPatrick Sanan +   dm - the DM object
245001729b5cSPatrick Sanan .   g - the global vector
245101729b5cSPatrick Sanan .   mode - INSERT_VALUES or ADD_VALUES
245201729b5cSPatrick Sanan -   l - the local vector
245301729b5cSPatrick Sanan 
245401729b5cSPatrick Sanan     Notes:
245501729b5cSPatrick Sanan     The communication involved in this update can be overlapped with computation by using
245601729b5cSPatrick Sanan     DMGlobalToLocalBegin() and DMGlobalToLocalEnd().
245701729b5cSPatrick Sanan 
245801729b5cSPatrick Sanan     Level: beginner
245901729b5cSPatrick Sanan 
246001729b5cSPatrick Sanan .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin(), DMLocalToGlobal(), DMLocalToGlobalBegin(), DMLocalToGlobalEnd()
246101729b5cSPatrick Sanan 
246201729b5cSPatrick Sanan @*/
246301729b5cSPatrick Sanan PetscErrorCode DMGlobalToLocal(DM dm,Vec g,InsertMode mode,Vec l)
246401729b5cSPatrick Sanan {
246501729b5cSPatrick Sanan   PetscErrorCode ierr;
246601729b5cSPatrick Sanan 
246701729b5cSPatrick Sanan   PetscFunctionBegin;
246801729b5cSPatrick Sanan   ierr = DMGlobalToLocalBegin(dm,g,mode,l);CHKERRQ(ierr);
246901729b5cSPatrick Sanan   ierr = DMGlobalToLocalEnd(dm,g,mode,l);CHKERRQ(ierr);
247001729b5cSPatrick Sanan   PetscFunctionReturn(0);
247101729b5cSPatrick Sanan }
247201729b5cSPatrick Sanan 
247301729b5cSPatrick Sanan /*@
247447c6ae99SBarry Smith     DMGlobalToLocalBegin - Begins updating local vectors from global vector
247547c6ae99SBarry Smith 
2476d083f849SBarry Smith     Neighbor-wise Collective on dm
247747c6ae99SBarry Smith 
247847c6ae99SBarry Smith     Input Parameters:
247947c6ae99SBarry Smith +   dm - the DM object
248047c6ae99SBarry Smith .   g - the global vector
248147c6ae99SBarry Smith .   mode - INSERT_VALUES or ADD_VALUES
248247c6ae99SBarry Smith -   l - the local vector
248347c6ae99SBarry Smith 
248401729b5cSPatrick Sanan     Level: intermediate
248547c6ae99SBarry Smith 
248601729b5cSPatrick Sanan .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin(), DMLocalToGlobal(), DMLocalToGlobalBegin(), DMLocalToGlobalEnd()
248747c6ae99SBarry Smith 
248847c6ae99SBarry Smith @*/
24897087cfbeSBarry Smith PetscErrorCode  DMGlobalToLocalBegin(DM dm,Vec g,InsertMode mode,Vec l)
249047c6ae99SBarry Smith {
24917128ae9fSMatthew G Knepley   PetscSF                 sf;
249247c6ae99SBarry Smith   PetscErrorCode          ierr;
2493baf369e7SPeter Brune   DMGlobalToLocalHookLink link;
249447c6ae99SBarry Smith 
249547c6ae99SBarry Smith   PetscFunctionBegin;
2496171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2497baf369e7SPeter Brune   for (link=dm->gtolhook; link; link=link->next) {
24988865f1eaSKarl Rupp     if (link->beginhook) {
24998865f1eaSKarl Rupp       ierr = (*link->beginhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);
25008865f1eaSKarl Rupp     }
2501baf369e7SPeter Brune   }
25021bb6d2a8SBarry Smith   ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr);
25037128ae9fSMatthew G Knepley   if (sf) {
2504ae5cfb4aSMatthew G. Knepley     const PetscScalar *gArray;
2505ae5cfb4aSMatthew G. Knepley     PetscScalar       *lArray;
25067128ae9fSMatthew G Knepley 
250782f516ccSBarry Smith     if (mode == ADD_VALUES) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
2508fa88e482SJed Brown     ierr = VecGetArrayInPlace(l, &lArray);CHKERRQ(ierr);
2509fa88e482SJed Brown     ierr = VecGetArrayReadInPlace(g, &gArray);CHKERRQ(ierr);
25107128ae9fSMatthew G Knepley     ierr = PetscSFBcastBegin(sf, MPIU_SCALAR, gArray, lArray);CHKERRQ(ierr);
2511fa88e482SJed Brown     ierr = VecRestoreArrayInPlace(l, &lArray);CHKERRQ(ierr);
2512fa88e482SJed Brown     ierr = VecRestoreArrayReadInPlace(g, &gArray);CHKERRQ(ierr);
25137128ae9fSMatthew G Knepley   } else {
251433907cc2SStefano Zampini     if (!dm->ops->globaltolocalbegin) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMGlobalToLocalBegin() for type %s",((PetscObject)dm)->type_name);
2515843c4018SMatthew G Knepley     ierr = (*dm->ops->globaltolocalbegin)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
25167128ae9fSMatthew G Knepley   }
251747c6ae99SBarry Smith   PetscFunctionReturn(0);
251847c6ae99SBarry Smith }
251947c6ae99SBarry Smith 
252047c6ae99SBarry Smith /*@
252147c6ae99SBarry Smith     DMGlobalToLocalEnd - Ends updating local vectors from global vector
252247c6ae99SBarry Smith 
2523d083f849SBarry Smith     Neighbor-wise Collective on dm
252447c6ae99SBarry Smith 
252547c6ae99SBarry Smith     Input Parameters:
252647c6ae99SBarry Smith +   dm - the DM object
252747c6ae99SBarry Smith .   g - the global vector
252847c6ae99SBarry Smith .   mode - INSERT_VALUES or ADD_VALUES
252947c6ae99SBarry Smith -   l - the local vector
253047c6ae99SBarry Smith 
253101729b5cSPatrick Sanan     Level: intermediate
253247c6ae99SBarry Smith 
253301729b5cSPatrick Sanan .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMLocalToGlobalBegin(), DMLocalToGlobal(), DMLocalToGlobalBegin(), DMLocalToGlobalEnd()
253447c6ae99SBarry Smith 
253547c6ae99SBarry Smith @*/
25367087cfbeSBarry Smith PetscErrorCode  DMGlobalToLocalEnd(DM dm,Vec g,InsertMode mode,Vec l)
253747c6ae99SBarry Smith {
25387128ae9fSMatthew G Knepley   PetscSF                 sf;
253947c6ae99SBarry Smith   PetscErrorCode          ierr;
2540ae5cfb4aSMatthew G. Knepley   const PetscScalar      *gArray;
2541ae5cfb4aSMatthew G. Knepley   PetscScalar            *lArray;
2542ca3d3a14SMatthew G. Knepley   PetscBool               transform;
2543baf369e7SPeter Brune   DMGlobalToLocalHookLink link;
254447c6ae99SBarry Smith 
254547c6ae99SBarry Smith   PetscFunctionBegin;
2546171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
25471bb6d2a8SBarry Smith   ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr);
2548ca3d3a14SMatthew G. Knepley   ierr = DMHasBasisTransform(dm, &transform);CHKERRQ(ierr);
25497128ae9fSMatthew G Knepley   if (sf) {
255082f516ccSBarry Smith     if (mode == ADD_VALUES) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
25517128ae9fSMatthew G Knepley 
2552fa88e482SJed Brown     ierr = VecGetArrayInPlace(l, &lArray);CHKERRQ(ierr);
2553fa88e482SJed Brown     ierr = VecGetArrayReadInPlace(g, &gArray);CHKERRQ(ierr);
25547128ae9fSMatthew G Knepley     ierr = PetscSFBcastEnd(sf, MPIU_SCALAR, gArray, lArray);CHKERRQ(ierr);
2555fa88e482SJed Brown     ierr = VecRestoreArrayInPlace(l, &lArray);CHKERRQ(ierr);
2556fa88e482SJed Brown     ierr = VecRestoreArrayReadInPlace(g, &gArray);CHKERRQ(ierr);
2557ca3d3a14SMatthew G. Knepley     if (transform) {ierr = DMPlexGlobalToLocalBasis(dm, l);CHKERRQ(ierr);}
25587128ae9fSMatthew G Knepley   } else {
255933907cc2SStefano Zampini     if (!dm->ops->globaltolocalend) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMGlobalToLocalEnd() for type %s",((PetscObject)dm)->type_name);
2560843c4018SMatthew G Knepley     ierr = (*dm->ops->globaltolocalend)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
25617128ae9fSMatthew G Knepley   }
25624c274da1SToby Isaac   ierr = DMGlobalToLocalHook_Constraints(dm,g,mode,l,NULL);CHKERRQ(ierr);
2563baf369e7SPeter Brune   for (link=dm->gtolhook; link; link=link->next) {
2564baf369e7SPeter Brune     if (link->endhook) {ierr = (*link->endhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);}
2565baf369e7SPeter Brune   }
256647c6ae99SBarry Smith   PetscFunctionReturn(0);
256747c6ae99SBarry Smith }
256847c6ae99SBarry Smith 
2569d4d07f1eSToby Isaac /*@C
2570d4d07f1eSToby Isaac    DMLocalToGlobalHookAdd - adds a callback to be run when a local to global is called
2571d4d07f1eSToby Isaac 
2572d4d07f1eSToby Isaac    Logically Collective
2573d4d07f1eSToby Isaac 
2574d4d07f1eSToby Isaac    Input Arguments:
2575d4d07f1eSToby Isaac +  dm - the DM
2576d4d07f1eSToby Isaac .  beginhook - function to run at the beginning of DMLocalToGlobalBegin()
2577d4d07f1eSToby Isaac .  endhook - function to run after DMLocalToGlobalEnd() has completed
2578d4d07f1eSToby Isaac -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
2579d4d07f1eSToby Isaac 
2580d4d07f1eSToby Isaac    Calling sequence for beginhook:
2581d4d07f1eSToby Isaac $    beginhook(DM fine,Vec l,InsertMode mode,Vec g,void *ctx)
2582d4d07f1eSToby Isaac 
2583d4d07f1eSToby Isaac +  dm - global DM
2584d4d07f1eSToby Isaac .  l - local vector
2585d4d07f1eSToby Isaac .  mode - mode
2586d4d07f1eSToby Isaac .  g - global vector
2587d4d07f1eSToby Isaac -  ctx - optional user-defined function context
2588d4d07f1eSToby Isaac 
2589d4d07f1eSToby Isaac 
2590d4d07f1eSToby Isaac    Calling sequence for endhook:
2591d4d07f1eSToby Isaac $    endhook(DM fine,Vec l,InsertMode mode,Vec g,void *ctx)
2592d4d07f1eSToby Isaac 
2593d4d07f1eSToby Isaac +  global - global DM
2594d4d07f1eSToby Isaac .  l - local vector
2595d4d07f1eSToby Isaac .  mode - mode
2596d4d07f1eSToby Isaac .  g - global vector
2597d4d07f1eSToby Isaac -  ctx - optional user-defined function context
2598d4d07f1eSToby Isaac 
2599d4d07f1eSToby Isaac    Level: advanced
2600d4d07f1eSToby Isaac 
2601d4d07f1eSToby Isaac .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
2602d4d07f1eSToby Isaac @*/
2603d4d07f1eSToby Isaac PetscErrorCode DMLocalToGlobalHookAdd(DM dm,PetscErrorCode (*beginhook)(DM,Vec,InsertMode,Vec,void*),PetscErrorCode (*endhook)(DM,Vec,InsertMode,Vec,void*),void *ctx)
2604d4d07f1eSToby Isaac {
2605d4d07f1eSToby Isaac   PetscErrorCode          ierr;
2606d4d07f1eSToby Isaac   DMLocalToGlobalHookLink link,*p;
2607d4d07f1eSToby Isaac 
2608d4d07f1eSToby Isaac   PetscFunctionBegin;
2609d4d07f1eSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2610d4d07f1eSToby Isaac   for (p=&dm->ltoghook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */
261195dccacaSBarry Smith   ierr            = PetscNew(&link);CHKERRQ(ierr);
2612d4d07f1eSToby Isaac   link->beginhook = beginhook;
2613d4d07f1eSToby Isaac   link->endhook   = endhook;
2614d4d07f1eSToby Isaac   link->ctx       = ctx;
2615d4d07f1eSToby Isaac   link->next      = NULL;
2616d4d07f1eSToby Isaac   *p              = link;
2617d4d07f1eSToby Isaac   PetscFunctionReturn(0);
2618d4d07f1eSToby Isaac }
2619d4d07f1eSToby Isaac 
26204c274da1SToby Isaac static PetscErrorCode DMLocalToGlobalHook_Constraints(DM dm, Vec l, InsertMode mode, Vec g, void *ctx)
26214c274da1SToby Isaac {
26224c274da1SToby Isaac   Mat cMat;
26234c274da1SToby Isaac   Vec cVec;
26244c274da1SToby Isaac   PetscSection section, cSec;
26254c274da1SToby Isaac   PetscInt pStart, pEnd, p, dof;
26264c274da1SToby Isaac   PetscErrorCode ierr;
26274c274da1SToby Isaac 
26284c274da1SToby Isaac   PetscFunctionBegin;
26294c274da1SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
26304c274da1SToby Isaac   ierr = DMGetDefaultConstraints(dm,&cSec,&cMat);CHKERRQ(ierr);
26314c274da1SToby Isaac   if (cMat && (mode == ADD_VALUES || mode == ADD_ALL_VALUES || mode == ADD_BC_VALUES)) {
26325db9a05bSToby Isaac     PetscInt nRows;
26335db9a05bSToby Isaac 
26345db9a05bSToby Isaac     ierr = MatGetSize(cMat,&nRows,NULL);CHKERRQ(ierr);
26355db9a05bSToby Isaac     if (nRows <= 0) PetscFunctionReturn(0);
263692fd8e1eSJed Brown     ierr = DMGetLocalSection(dm,&section);CHKERRQ(ierr);
26377711e48fSToby Isaac     ierr = MatCreateVecs(cMat,NULL,&cVec);CHKERRQ(ierr);
26384c274da1SToby Isaac     ierr = PetscSectionGetChart(cSec,&pStart,&pEnd);CHKERRQ(ierr);
26394c274da1SToby Isaac     for (p = pStart; p < pEnd; p++) {
26404c274da1SToby Isaac       ierr = PetscSectionGetDof(cSec,p,&dof);CHKERRQ(ierr);
26414c274da1SToby Isaac       if (dof) {
26424c274da1SToby Isaac         PetscInt d;
26434c274da1SToby Isaac         PetscScalar *vals;
26444c274da1SToby Isaac         ierr = VecGetValuesSection(l,section,p,&vals);CHKERRQ(ierr);
26454c274da1SToby Isaac         ierr = VecSetValuesSection(cVec,cSec,p,vals,mode);CHKERRQ(ierr);
26464c274da1SToby Isaac         /* for this to be the true transpose, we have to zero the values that
26474c274da1SToby Isaac          * we just extracted */
26484c274da1SToby Isaac         for (d = 0; d < dof; d++) {
26494c274da1SToby Isaac           vals[d] = 0.;
26504c274da1SToby Isaac         }
26514c274da1SToby Isaac       }
26524c274da1SToby Isaac     }
26534c274da1SToby Isaac     ierr = MatMultTransposeAdd(cMat,cVec,l,l);CHKERRQ(ierr);
26544c274da1SToby Isaac     ierr = VecDestroy(&cVec);CHKERRQ(ierr);
26554c274da1SToby Isaac   }
26564c274da1SToby Isaac   PetscFunctionReturn(0);
26574c274da1SToby Isaac }
265801729b5cSPatrick Sanan /*@
265901729b5cSPatrick Sanan     DMLocalToGlobal - updates global vectors from local vectors
266001729b5cSPatrick Sanan 
2661d083f849SBarry Smith     Neighbor-wise Collective on dm
266201729b5cSPatrick Sanan 
266301729b5cSPatrick Sanan     Input Parameters:
266401729b5cSPatrick Sanan +   dm - the DM object
266501729b5cSPatrick Sanan .   l - the local vector
266601729b5cSPatrick Sanan .   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.
266701729b5cSPatrick Sanan -   g - the global vector
266801729b5cSPatrick Sanan 
266901729b5cSPatrick Sanan     Notes:
267001729b5cSPatrick Sanan     The communication involved in this update can be overlapped with computation by using
267101729b5cSPatrick Sanan     DMLocalToGlobalBegin() and DMLocalToGlobalEnd().
267201729b5cSPatrick Sanan 
267301729b5cSPatrick Sanan     In the ADD_VALUES case you normally would zero the receiving vector before beginning this operation.
267401729b5cSPatrick Sanan            INSERT_VALUES is not supported for DMDA; in that case simply compute the values directly into a global vector instead of a local one.
267501729b5cSPatrick Sanan 
267601729b5cSPatrick Sanan     Level: beginner
267701729b5cSPatrick Sanan 
267801729b5cSPatrick Sanan .seealso DMLocalToGlobalBegin(), DMLocalToGlobalEnd(), DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMGlobalToLocalEnd(), DMGlobalToLocalBegin()
267901729b5cSPatrick Sanan 
268001729b5cSPatrick Sanan @*/
268101729b5cSPatrick Sanan PetscErrorCode DMLocalToGlobal(DM dm,Vec l,InsertMode mode,Vec g)
268201729b5cSPatrick Sanan {
268301729b5cSPatrick Sanan   PetscErrorCode ierr;
268401729b5cSPatrick Sanan 
268501729b5cSPatrick Sanan   PetscFunctionBegin;
268601729b5cSPatrick Sanan   ierr = DMLocalToGlobalBegin(dm,l,mode,g);CHKERRQ(ierr);
268701729b5cSPatrick Sanan   ierr = DMLocalToGlobalEnd(dm,l,mode,g);CHKERRQ(ierr);
268801729b5cSPatrick Sanan   PetscFunctionReturn(0);
268901729b5cSPatrick Sanan }
26904c274da1SToby Isaac 
269147c6ae99SBarry Smith /*@
269201729b5cSPatrick Sanan     DMLocalToGlobalBegin - begins updating global vectors from local vectors
26939a42bb27SBarry Smith 
2694d083f849SBarry Smith     Neighbor-wise Collective on dm
26959a42bb27SBarry Smith 
26969a42bb27SBarry Smith     Input Parameters:
26979a42bb27SBarry Smith +   dm - the DM object
2698f6813fd5SJed Brown .   l - the local vector
26991eb28f2eSBarry 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.
27001eb28f2eSBarry Smith -   g - the global vector
27019a42bb27SBarry Smith 
270295452b02SPatrick Sanan     Notes:
270395452b02SPatrick Sanan     In the ADD_VALUES case you normally would zero the receiving vector before beginning this operation.
270484330215SMatthew 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.
27059a42bb27SBarry Smith 
270601729b5cSPatrick Sanan     Level: intermediate
27079a42bb27SBarry Smith 
270801729b5cSPatrick Sanan .seealso DMLocalToGlobal(), DMLocalToGlobalEnd(), DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMGlobalToLocalEnd(), DMGlobalToLocalBegin()
27099a42bb27SBarry Smith 
27109a42bb27SBarry Smith @*/
27117087cfbeSBarry Smith PetscErrorCode  DMLocalToGlobalBegin(DM dm,Vec l,InsertMode mode,Vec g)
27129a42bb27SBarry Smith {
27137128ae9fSMatthew G Knepley   PetscSF                 sf;
271484330215SMatthew G. Knepley   PetscSection            s, gs;
2715d4d07f1eSToby Isaac   DMLocalToGlobalHookLink link;
2716ca3d3a14SMatthew G. Knepley   Vec                     tmpl;
2717ae5cfb4aSMatthew G. Knepley   const PetscScalar      *lArray;
2718ae5cfb4aSMatthew G. Knepley   PetscScalar            *gArray;
2719fa88e482SJed Brown   PetscBool               isInsert, transform, l_inplace = PETSC_FALSE, g_inplace = PETSC_FALSE;
272084330215SMatthew G. Knepley   PetscErrorCode          ierr;
27219a42bb27SBarry Smith 
27229a42bb27SBarry Smith   PetscFunctionBegin;
2723171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2724d4d07f1eSToby Isaac   for (link=dm->ltoghook; link; link=link->next) {
2725d4d07f1eSToby Isaac     if (link->beginhook) {
2726d4d07f1eSToby Isaac       ierr = (*link->beginhook)(dm,l,mode,g,link->ctx);CHKERRQ(ierr);
2727d4d07f1eSToby Isaac     }
2728d4d07f1eSToby Isaac   }
27294c274da1SToby Isaac   ierr = DMLocalToGlobalHook_Constraints(dm,l,mode,g,NULL);CHKERRQ(ierr);
27301bb6d2a8SBarry Smith   ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr);
273192fd8e1eSJed Brown   ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr);
27327128ae9fSMatthew G Knepley   switch (mode) {
27337128ae9fSMatthew G Knepley   case INSERT_VALUES:
27347128ae9fSMatthew G Knepley   case INSERT_ALL_VALUES:
2735304ab55fSMatthew G. Knepley   case INSERT_BC_VALUES:
273684330215SMatthew G. Knepley     isInsert = PETSC_TRUE; break;
27377128ae9fSMatthew G Knepley   case ADD_VALUES:
27387128ae9fSMatthew G Knepley   case ADD_ALL_VALUES:
2739304ab55fSMatthew G. Knepley   case ADD_BC_VALUES:
274084330215SMatthew G. Knepley     isInsert = PETSC_FALSE; break;
27417128ae9fSMatthew G Knepley   default:
274282f516ccSBarry Smith     SETERRQ1(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
27437128ae9fSMatthew G Knepley   }
2744ca3d3a14SMatthew G. Knepley   if ((sf && !isInsert) || (s && isInsert)) {
2745ca3d3a14SMatthew G. Knepley     ierr = DMHasBasisTransform(dm, &transform);CHKERRQ(ierr);
2746ca3d3a14SMatthew G. Knepley     if (transform) {
2747ca3d3a14SMatthew G. Knepley       ierr = DMGetNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr);
2748ca3d3a14SMatthew G. Knepley       ierr = VecCopy(l, tmpl);CHKERRQ(ierr);
2749ca3d3a14SMatthew G. Knepley       ierr = DMPlexLocalToGlobalBasis(dm, tmpl);CHKERRQ(ierr);
2750ca3d3a14SMatthew G. Knepley       ierr = VecGetArrayRead(tmpl, &lArray);CHKERRQ(ierr);
2751fa88e482SJed Brown     } else if (isInsert) {
2752ae5cfb4aSMatthew G. Knepley       ierr = VecGetArrayRead(l, &lArray);CHKERRQ(ierr);
2753fa88e482SJed Brown     } else {
2754fa88e482SJed Brown       ierr = VecGetArrayReadInPlace(l, &lArray);CHKERRQ(ierr);
2755fa88e482SJed Brown       l_inplace = PETSC_TRUE;
2756ca3d3a14SMatthew G. Knepley     }
2757fa88e482SJed Brown     if (s && isInsert) {
27587128ae9fSMatthew G Knepley       ierr = VecGetArray(g, &gArray);CHKERRQ(ierr);
2759fa88e482SJed Brown     } else {
2760fa88e482SJed Brown       ierr = VecGetArrayInPlace(g, &gArray);CHKERRQ(ierr);
2761fa88e482SJed Brown       g_inplace = PETSC_TRUE;
2762fa88e482SJed Brown     }
2763ca3d3a14SMatthew G. Knepley     if (sf && !isInsert) {
2764a9b180a6SBarry Smith       ierr = PetscSFReduceBegin(sf, MPIU_SCALAR, lArray, gArray, MPIU_SUM);CHKERRQ(ierr);
276584330215SMatthew G. Knepley     } else if (s && isInsert) {
276684330215SMatthew G. Knepley       PetscInt gStart, pStart, pEnd, p;
276784330215SMatthew G. Knepley 
2768e87a4003SBarry Smith       ierr = DMGetGlobalSection(dm, &gs);CHKERRQ(ierr);
276984330215SMatthew G. Knepley       ierr = PetscSectionGetChart(s, &pStart, &pEnd);CHKERRQ(ierr);
277084330215SMatthew G. Knepley       ierr = VecGetOwnershipRange(g, &gStart, NULL);CHKERRQ(ierr);
277184330215SMatthew G. Knepley       for (p = pStart; p < pEnd; ++p) {
2772b3b16f48SMatthew G. Knepley         PetscInt dof, gdof, cdof, gcdof, off, goff, d, e;
277384330215SMatthew G. Knepley 
277484330215SMatthew G. Knepley         ierr = PetscSectionGetDof(s, p, &dof);CHKERRQ(ierr);
277503442857SMatthew G. Knepley         ierr = PetscSectionGetDof(gs, p, &gdof);CHKERRQ(ierr);
277684330215SMatthew G. Knepley         ierr = PetscSectionGetConstraintDof(s, p, &cdof);CHKERRQ(ierr);
2777b3b16f48SMatthew G. Knepley         ierr = PetscSectionGetConstraintDof(gs, p, &gcdof);CHKERRQ(ierr);
277884330215SMatthew G. Knepley         ierr = PetscSectionGetOffset(s, p, &off);CHKERRQ(ierr);
277984330215SMatthew G. Knepley         ierr = PetscSectionGetOffset(gs, p, &goff);CHKERRQ(ierr);
2780b3b16f48SMatthew G. Knepley         /* Ignore off-process data and points with no global data */
278103442857SMatthew G. Knepley         if (!gdof || goff < 0) continue;
2782b3b16f48SMatthew 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);
2783b3b16f48SMatthew G. Knepley         /* If no constraints are enforced in the global vector */
2784b3b16f48SMatthew G. Knepley         if (!gcdof) {
278584330215SMatthew G. Knepley           for (d = 0; d < dof; ++d) gArray[goff-gStart+d] = lArray[off+d];
2786b3b16f48SMatthew G. Knepley           /* If constraints are enforced in the global vector */
2787b3b16f48SMatthew G. Knepley         } else if (cdof == gcdof) {
278884330215SMatthew G. Knepley           const PetscInt *cdofs;
278984330215SMatthew G. Knepley           PetscInt        cind = 0;
279084330215SMatthew G. Knepley 
279184330215SMatthew G. Knepley           ierr = PetscSectionGetConstraintIndices(s, p, &cdofs);CHKERRQ(ierr);
2792b3b16f48SMatthew G. Knepley           for (d = 0, e = 0; d < dof; ++d) {
279384330215SMatthew G. Knepley             if ((cind < cdof) && (d == cdofs[cind])) {++cind; continue;}
2794b3b16f48SMatthew G. Knepley             gArray[goff-gStart+e++] = lArray[off+d];
279584330215SMatthew G. Knepley           }
2796b3b16f48SMatthew 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);
279784330215SMatthew G. Knepley       }
2798ca3d3a14SMatthew G. Knepley     }
2799fa88e482SJed Brown     if (g_inplace) {
2800fa88e482SJed Brown       ierr = VecRestoreArrayInPlace(g, &gArray);CHKERRQ(ierr);
2801fa88e482SJed Brown     } else {
28027128ae9fSMatthew G Knepley       ierr = VecRestoreArray(g, &gArray);CHKERRQ(ierr);
2803fa88e482SJed Brown     }
2804ca3d3a14SMatthew G. Knepley     if (transform) {
2805ca3d3a14SMatthew G. Knepley       ierr = VecRestoreArrayRead(tmpl, &lArray);CHKERRQ(ierr);
2806ca3d3a14SMatthew G. Knepley       ierr = DMRestoreNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr);
2807fa88e482SJed Brown     } else if (l_inplace) {
2808fa88e482SJed Brown       ierr = VecRestoreArrayReadInPlace(l, &lArray);CHKERRQ(ierr);
2809ca3d3a14SMatthew G. Knepley     } else {
2810ca3d3a14SMatthew G. Knepley       ierr = VecRestoreArrayRead(l, &lArray);CHKERRQ(ierr);
2811ca3d3a14SMatthew G. Knepley     }
28127128ae9fSMatthew G Knepley   } else {
2813b9d85ea2SLisandro Dalcin     if (!dm->ops->localtoglobalbegin) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMLocalToGlobalBegin() for type %s",((PetscObject)dm)->type_name);
2814843c4018SMatthew G Knepley     ierr = (*dm->ops->localtoglobalbegin)(dm,l,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),g);CHKERRQ(ierr);
28157128ae9fSMatthew G Knepley   }
28169a42bb27SBarry Smith   PetscFunctionReturn(0);
28179a42bb27SBarry Smith }
28189a42bb27SBarry Smith 
28199a42bb27SBarry Smith /*@
28209a42bb27SBarry Smith     DMLocalToGlobalEnd - updates global vectors from local vectors
282147c6ae99SBarry Smith 
2822d083f849SBarry Smith     Neighbor-wise Collective on dm
282347c6ae99SBarry Smith 
282447c6ae99SBarry Smith     Input Parameters:
282547c6ae99SBarry Smith +   dm - the DM object
2826f6813fd5SJed Brown .   l - the local vector
282747c6ae99SBarry Smith .   mode - INSERT_VALUES or ADD_VALUES
2828f6813fd5SJed Brown -   g - the global vector
282947c6ae99SBarry Smith 
283001729b5cSPatrick Sanan     Level: intermediate
283147c6ae99SBarry Smith 
2832e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMGlobalToLocalEnd()
283347c6ae99SBarry Smith 
283447c6ae99SBarry Smith @*/
28357087cfbeSBarry Smith PetscErrorCode  DMLocalToGlobalEnd(DM dm,Vec l,InsertMode mode,Vec g)
283647c6ae99SBarry Smith {
28377128ae9fSMatthew G Knepley   PetscSF                 sf;
283884330215SMatthew G. Knepley   PetscSection            s;
2839d4d07f1eSToby Isaac   DMLocalToGlobalHookLink link;
2840ca3d3a14SMatthew G. Knepley   PetscBool               isInsert, transform;
284184330215SMatthew G. Knepley   PetscErrorCode          ierr;
284247c6ae99SBarry Smith 
284347c6ae99SBarry Smith   PetscFunctionBegin;
2844171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
28451bb6d2a8SBarry Smith   ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr);
284692fd8e1eSJed Brown   ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr);
28477128ae9fSMatthew G Knepley   switch (mode) {
28487128ae9fSMatthew G Knepley   case INSERT_VALUES:
28497128ae9fSMatthew G Knepley   case INSERT_ALL_VALUES:
285084330215SMatthew G. Knepley     isInsert = PETSC_TRUE; break;
28517128ae9fSMatthew G Knepley   case ADD_VALUES:
28527128ae9fSMatthew G Knepley   case ADD_ALL_VALUES:
285384330215SMatthew G. Knepley     isInsert = PETSC_FALSE; break;
28547128ae9fSMatthew G Knepley   default:
285582f516ccSBarry Smith     SETERRQ1(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
28567128ae9fSMatthew G Knepley   }
285784330215SMatthew G. Knepley   if (sf && !isInsert) {
2858ae5cfb4aSMatthew G. Knepley     const PetscScalar *lArray;
2859ae5cfb4aSMatthew G. Knepley     PetscScalar       *gArray;
2860ca3d3a14SMatthew G. Knepley     Vec                tmpl;
286184330215SMatthew G. Knepley 
2862ca3d3a14SMatthew G. Knepley     ierr = DMHasBasisTransform(dm, &transform);CHKERRQ(ierr);
2863ca3d3a14SMatthew G. Knepley     if (transform) {
2864ca3d3a14SMatthew G. Knepley       ierr = DMGetNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr);
2865ca3d3a14SMatthew G. Knepley       ierr = VecGetArrayRead(tmpl, &lArray);CHKERRQ(ierr);
2866ca3d3a14SMatthew G. Knepley     } else {
2867fa88e482SJed Brown       ierr = VecGetArrayReadInPlace(l, &lArray);CHKERRQ(ierr);
2868ca3d3a14SMatthew G. Knepley     }
2869fa88e482SJed Brown     ierr = VecGetArrayInPlace(g, &gArray);CHKERRQ(ierr);
2870a9b180a6SBarry Smith     ierr = PetscSFReduceEnd(sf, MPIU_SCALAR, lArray, gArray, MPIU_SUM);CHKERRQ(ierr);
2871ca3d3a14SMatthew G. Knepley     if (transform) {
2872ca3d3a14SMatthew G. Knepley       ierr = VecRestoreArrayRead(tmpl, &lArray);CHKERRQ(ierr);
2873ca3d3a14SMatthew G. Knepley       ierr = DMRestoreNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr);
2874ca3d3a14SMatthew G. Knepley     } else {
2875fa88e482SJed Brown       ierr = VecRestoreArrayReadInPlace(l, &lArray);CHKERRQ(ierr);
2876ca3d3a14SMatthew G. Knepley     }
2877fa88e482SJed Brown     ierr = VecRestoreArrayInPlace(g, &gArray);CHKERRQ(ierr);
287884330215SMatthew G. Knepley   } else if (s && isInsert) {
28797128ae9fSMatthew G Knepley   } else {
2880b9d85ea2SLisandro Dalcin     if (!dm->ops->localtoglobalend) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMLocalToGlobalEnd() for type %s",((PetscObject)dm)->type_name);
2881843c4018SMatthew G Knepley     ierr = (*dm->ops->localtoglobalend)(dm,l,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),g);CHKERRQ(ierr);
28827128ae9fSMatthew G Knepley   }
2883d4d07f1eSToby Isaac   for (link=dm->ltoghook; link; link=link->next) {
2884d4d07f1eSToby Isaac     if (link->endhook) {ierr = (*link->endhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);}
2885d4d07f1eSToby Isaac   }
288647c6ae99SBarry Smith   PetscFunctionReturn(0);
288747c6ae99SBarry Smith }
288847c6ae99SBarry Smith 
2889f089877aSRichard Tran Mills /*@
2890bc0a1609SRichard Tran Mills    DMLocalToLocalBegin - Maps from a local vector (including ghost points
2891bc0a1609SRichard Tran Mills    that contain irrelevant values) to another local vector where the ghost
2892d78e899eSRichard Tran Mills    points in the second are set correctly. Must be followed by DMLocalToLocalEnd().
2893f089877aSRichard Tran Mills 
2894d083f849SBarry Smith    Neighbor-wise Collective on dm
2895f089877aSRichard Tran Mills 
2896f089877aSRichard Tran Mills    Input Parameters:
2897f089877aSRichard Tran Mills +  dm - the DM object
2898bc0a1609SRichard Tran Mills .  g - the original local vector
2899bc0a1609SRichard Tran Mills -  mode - one of INSERT_VALUES or ADD_VALUES
2900f089877aSRichard Tran Mills 
2901bc0a1609SRichard Tran Mills    Output Parameter:
2902bc0a1609SRichard Tran Mills .  l  - the local vector with correct ghost values
2903f089877aSRichard Tran Mills 
2904f089877aSRichard Tran Mills    Level: intermediate
2905f089877aSRichard Tran Mills 
2906bc0a1609SRichard Tran Mills    Notes:
2907bc0a1609SRichard Tran Mills    The local vectors used here need not be the same as those
2908bc0a1609SRichard Tran Mills    obtained from DMCreateLocalVector(), BUT they
2909bc0a1609SRichard Tran Mills    must have the same parallel data layout; they could, for example, be
2910bc0a1609SRichard Tran Mills    obtained with VecDuplicate() from the DM originating vectors.
2911bc0a1609SRichard Tran Mills 
2912bc0a1609SRichard Tran Mills .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateLocalVector(), DMCreateGlobalVector(), DMCreateInterpolation(), DMLocalToLocalEnd(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin()
2913f089877aSRichard Tran Mills 
2914f089877aSRichard Tran Mills @*/
2915f089877aSRichard Tran Mills PetscErrorCode  DMLocalToLocalBegin(DM dm,Vec g,InsertMode mode,Vec l)
2916f089877aSRichard Tran Mills {
2917f089877aSRichard Tran Mills   PetscErrorCode          ierr;
2918f089877aSRichard Tran Mills 
2919f089877aSRichard Tran Mills   PetscFunctionBegin;
2920f089877aSRichard Tran Mills   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2921bb358533SPatrick Sanan   if (!dm->ops->localtolocalbegin) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"This DM does not support local to local maps");
2922f089877aSRichard Tran Mills   ierr = (*dm->ops->localtolocalbegin)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
2923f089877aSRichard Tran Mills   PetscFunctionReturn(0);
2924f089877aSRichard Tran Mills }
2925f089877aSRichard Tran Mills 
2926f089877aSRichard Tran Mills /*@
2927bc0a1609SRichard Tran Mills    DMLocalToLocalEnd - Maps from a local vector (including ghost points
2928bc0a1609SRichard Tran Mills    that contain irrelevant values) to another local vector where the ghost
2929d78e899eSRichard Tran Mills    points in the second are set correctly. Must be preceded by DMLocalToLocalBegin().
2930f089877aSRichard Tran Mills 
2931d083f849SBarry Smith    Neighbor-wise Collective on dm
2932f089877aSRichard Tran Mills 
2933f089877aSRichard Tran Mills    Input Parameters:
2934bc0a1609SRichard Tran Mills +  da - the DM object
2935bc0a1609SRichard Tran Mills .  g - the original local vector
2936bc0a1609SRichard Tran Mills -  mode - one of INSERT_VALUES or ADD_VALUES
2937f089877aSRichard Tran Mills 
2938bc0a1609SRichard Tran Mills    Output Parameter:
2939bc0a1609SRichard Tran Mills .  l  - the local vector with correct ghost values
2940f089877aSRichard Tran Mills 
2941f089877aSRichard Tran Mills    Level: intermediate
2942f089877aSRichard Tran Mills 
2943bc0a1609SRichard Tran Mills    Notes:
2944bc0a1609SRichard Tran Mills    The local vectors used here need not be the same as those
2945bc0a1609SRichard Tran Mills    obtained from DMCreateLocalVector(), BUT they
2946bc0a1609SRichard Tran Mills    must have the same parallel data layout; they could, for example, be
2947bc0a1609SRichard Tran Mills    obtained with VecDuplicate() from the DM originating vectors.
2948bc0a1609SRichard Tran Mills 
2949bc0a1609SRichard Tran Mills .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateLocalVector(), DMCreateGlobalVector(), DMCreateInterpolation(), DMLocalToLocalBegin(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin()
2950f089877aSRichard Tran Mills 
2951f089877aSRichard Tran Mills @*/
2952f089877aSRichard Tran Mills PetscErrorCode  DMLocalToLocalEnd(DM dm,Vec g,InsertMode mode,Vec l)
2953f089877aSRichard Tran Mills {
2954f089877aSRichard Tran Mills   PetscErrorCode          ierr;
2955f089877aSRichard Tran Mills 
2956f089877aSRichard Tran Mills   PetscFunctionBegin;
2957f089877aSRichard Tran Mills   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2958bb358533SPatrick Sanan   if (!dm->ops->localtolocalend) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"This DM does not support local to local maps");
2959f089877aSRichard Tran Mills   ierr = (*dm->ops->localtolocalend)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
2960f089877aSRichard Tran Mills   PetscFunctionReturn(0);
2961f089877aSRichard Tran Mills }
2962f089877aSRichard Tran Mills 
2963f089877aSRichard Tran Mills 
296447c6ae99SBarry Smith /*@
296547c6ae99SBarry Smith     DMCoarsen - Coarsens a DM object
296647c6ae99SBarry Smith 
2967d083f849SBarry Smith     Collective on dm
296847c6ae99SBarry Smith 
296947c6ae99SBarry Smith     Input Parameter:
297047c6ae99SBarry Smith +   dm - the DM object
297191d95f02SJed Brown -   comm - the communicator to contain the new DM object (or MPI_COMM_NULL)
297247c6ae99SBarry Smith 
297347c6ae99SBarry Smith     Output Parameter:
297447c6ae99SBarry Smith .   dmc - the coarsened DM
297547c6ae99SBarry Smith 
297647c6ae99SBarry Smith     Level: developer
297747c6ae99SBarry Smith 
2978e727c939SJed Brown .seealso DMRefine(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
297947c6ae99SBarry Smith 
298047c6ae99SBarry Smith @*/
29817087cfbeSBarry Smith PetscErrorCode DMCoarsen(DM dm, MPI_Comm comm, DM *dmc)
298247c6ae99SBarry Smith {
298347c6ae99SBarry Smith   PetscErrorCode    ierr;
2984b17ce1afSJed Brown   DMCoarsenHookLink link;
298547c6ae99SBarry Smith 
298647c6ae99SBarry Smith   PetscFunctionBegin;
2987171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2988b9d85ea2SLisandro Dalcin   if (!dm->ops->coarsen) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCoarsen",((PetscObject)dm)->type_name);
298947a35634SPatrick Farrell   ierr = PetscLogEventBegin(DM_Coarsen,dm,0,0,0);CHKERRQ(ierr);
299047c6ae99SBarry Smith   ierr = (*dm->ops->coarsen)(dm, comm, dmc);CHKERRQ(ierr);
2991b9d85ea2SLisandro Dalcin   if (*dmc) {
2992a8fb8f29SToby Isaac     ierr = DMSetCoarseDM(dm,*dmc);CHKERRQ(ierr);
299343842a1eSJed Brown     (*dmc)->ops->creatematrix = dm->ops->creatematrix;
29948cd211a4SJed Brown     ierr                      = PetscObjectCopyFortranFunctionPointers((PetscObject)dm,(PetscObject)*dmc);CHKERRQ(ierr);
2995644e2e5bSBarry Smith     (*dmc)->ctx               = dm->ctx;
29960598a293SJed Brown     (*dmc)->levelup           = dm->levelup;
2997656b349aSBarry Smith     (*dmc)->leveldown         = dm->leveldown + 1;
2998e4b4b23bSJed Brown     ierr                      = DMSetMatType(*dmc,dm->mattype);CHKERRQ(ierr);
2999b17ce1afSJed Brown     for (link=dm->coarsenhook; link; link=link->next) {
3000b17ce1afSJed Brown       if (link->coarsenhook) {ierr = (*link->coarsenhook)(dm,*dmc,link->ctx);CHKERRQ(ierr);}
3001b17ce1afSJed Brown     }
3002b9d85ea2SLisandro Dalcin   }
300347a35634SPatrick Farrell   ierr = PetscLogEventEnd(DM_Coarsen,dm,0,0,0);CHKERRQ(ierr);
3004b9d85ea2SLisandro Dalcin   if (!(*dmc)) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "NULL coarse mesh produced");
3005b17ce1afSJed Brown   PetscFunctionReturn(0);
3006b17ce1afSJed Brown }
3007b17ce1afSJed Brown 
3008bb9467b5SJed Brown /*@C
3009b17ce1afSJed Brown    DMCoarsenHookAdd - adds a callback to be run when restricting a nonlinear problem to the coarse grid
3010b17ce1afSJed Brown 
3011b17ce1afSJed Brown    Logically Collective
3012b17ce1afSJed Brown 
3013b17ce1afSJed Brown    Input Arguments:
3014b17ce1afSJed Brown +  fine - nonlinear solver context on which to run a hook when restricting to a coarser level
3015b17ce1afSJed Brown .  coarsenhook - function to run when setting up a coarser level
3016b17ce1afSJed Brown .  restricthook - function to run to update data on coarser levels (once per SNESSolve())
30170298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
3018b17ce1afSJed Brown 
3019b17ce1afSJed Brown    Calling sequence of coarsenhook:
3020b17ce1afSJed Brown $    coarsenhook(DM fine,DM coarse,void *ctx);
3021b17ce1afSJed Brown 
3022b17ce1afSJed Brown +  fine - fine level DM
3023b17ce1afSJed Brown .  coarse - coarse level DM to restrict problem to
3024b17ce1afSJed Brown -  ctx - optional user-defined function context
3025b17ce1afSJed Brown 
3026b17ce1afSJed Brown    Calling sequence for restricthook:
3027c833c3b5SJed Brown $    restricthook(DM fine,Mat mrestrict,Vec rscale,Mat inject,DM coarse,void *ctx)
3028b17ce1afSJed Brown 
3029b17ce1afSJed Brown +  fine - fine level DM
3030b17ce1afSJed Brown .  mrestrict - matrix restricting a fine-level solution to the coarse grid
3031c833c3b5SJed Brown .  rscale - scaling vector for restriction
3032c833c3b5SJed Brown .  inject - matrix restricting by injection
3033b17ce1afSJed Brown .  coarse - coarse level DM to update
3034b17ce1afSJed Brown -  ctx - optional user-defined function context
3035b17ce1afSJed Brown 
3036b17ce1afSJed Brown    Level: advanced
3037b17ce1afSJed Brown 
3038b17ce1afSJed Brown    Notes:
3039b17ce1afSJed Brown    This function is only needed if auxiliary data needs to be set up on coarse grids.
3040b17ce1afSJed Brown 
3041b17ce1afSJed Brown    If this function is called multiple times, the hooks will be run in the order they are added.
3042b17ce1afSJed Brown 
3043b17ce1afSJed Brown    In order to compose with nonlinear preconditioning without duplicating storage, the hook should be implemented to
3044b17ce1afSJed Brown    extract the finest level information from its context (instead of from the SNES).
3045b17ce1afSJed Brown 
3046bb9467b5SJed Brown    This function is currently not available from Fortran.
3047bb9467b5SJed Brown 
3048dc822a44SJed Brown .seealso: DMCoarsenHookRemove(), DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
3049b17ce1afSJed Brown @*/
3050b17ce1afSJed Brown PetscErrorCode DMCoarsenHookAdd(DM fine,PetscErrorCode (*coarsenhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,Mat,Vec,Mat,DM,void*),void *ctx)
3051b17ce1afSJed Brown {
3052b17ce1afSJed Brown   PetscErrorCode    ierr;
3053b17ce1afSJed Brown   DMCoarsenHookLink link,*p;
3054b17ce1afSJed Brown 
3055b17ce1afSJed Brown   PetscFunctionBegin;
3056b17ce1afSJed Brown   PetscValidHeaderSpecific(fine,DM_CLASSID,1);
30571e3d8eccSJed Brown   for (p=&fine->coarsenhook; *p; p=&(*p)->next) { /* Scan to the end of the current list of hooks */
30581e3d8eccSJed Brown     if ((*p)->coarsenhook == coarsenhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) PetscFunctionReturn(0);
30591e3d8eccSJed Brown   }
306095dccacaSBarry Smith   ierr               = PetscNew(&link);CHKERRQ(ierr);
3061b17ce1afSJed Brown   link->coarsenhook  = coarsenhook;
3062b17ce1afSJed Brown   link->restricthook = restricthook;
3063b17ce1afSJed Brown   link->ctx          = ctx;
30640298fd71SBarry Smith   link->next         = NULL;
3065b17ce1afSJed Brown   *p                 = link;
3066b17ce1afSJed Brown   PetscFunctionReturn(0);
3067b17ce1afSJed Brown }
3068b17ce1afSJed Brown 
3069dc822a44SJed Brown /*@C
3070dc822a44SJed Brown    DMCoarsenHookRemove - remove a callback from the list of hooks to be run when restricting a nonlinear problem to the coarse grid
3071dc822a44SJed Brown 
3072dc822a44SJed Brown    Logically Collective
3073dc822a44SJed Brown 
3074dc822a44SJed Brown    Input Arguments:
3075dc822a44SJed Brown +  fine - nonlinear solver context on which to run a hook when restricting to a coarser level
3076dc822a44SJed Brown .  coarsenhook - function to run when setting up a coarser level
3077dc822a44SJed Brown .  restricthook - function to run to update data on coarser levels (once per SNESSolve())
3078dc822a44SJed Brown -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
3079dc822a44SJed Brown 
3080dc822a44SJed Brown    Level: advanced
3081dc822a44SJed Brown 
3082dc822a44SJed Brown    Notes:
3083dc822a44SJed Brown    This function does nothing if the hook is not in the list.
3084dc822a44SJed Brown 
3085dc822a44SJed Brown    This function is currently not available from Fortran.
3086dc822a44SJed Brown 
3087dc822a44SJed Brown .seealso: DMCoarsenHookAdd(), DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
3088dc822a44SJed Brown @*/
3089dc822a44SJed Brown PetscErrorCode DMCoarsenHookRemove(DM fine,PetscErrorCode (*coarsenhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,Mat,Vec,Mat,DM,void*),void *ctx)
3090dc822a44SJed Brown {
3091dc822a44SJed Brown   PetscErrorCode    ierr;
3092dc822a44SJed Brown   DMCoarsenHookLink link,*p;
3093dc822a44SJed Brown 
3094dc822a44SJed Brown   PetscFunctionBegin;
3095dc822a44SJed Brown   PetscValidHeaderSpecific(fine,DM_CLASSID,1);
3096dc822a44SJed Brown   for (p=&fine->coarsenhook; *p; p=&(*p)->next) { /* Search the list of current hooks */
3097dc822a44SJed Brown     if ((*p)->coarsenhook == coarsenhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) {
3098dc822a44SJed Brown       link = *p;
3099dc822a44SJed Brown       *p = link->next;
3100dc822a44SJed Brown       ierr = PetscFree(link);CHKERRQ(ierr);
3101dc822a44SJed Brown       break;
3102dc822a44SJed Brown     }
3103dc822a44SJed Brown   }
3104dc822a44SJed Brown   PetscFunctionReturn(0);
3105dc822a44SJed Brown }
3106dc822a44SJed Brown 
3107dc822a44SJed Brown 
3108b17ce1afSJed Brown /*@
3109b17ce1afSJed Brown    DMRestrict - restricts user-defined problem data to a coarser DM by running hooks registered by DMCoarsenHookAdd()
3110b17ce1afSJed Brown 
3111b17ce1afSJed Brown    Collective if any hooks are
3112b17ce1afSJed Brown 
3113b17ce1afSJed Brown    Input Arguments:
3114b17ce1afSJed Brown +  fine - finer DM to use as a base
3115b17ce1afSJed Brown .  restrct - restriction matrix, apply using MatRestrict()
3116e91eccc2SStefano Zampini .  rscale - scaling vector for restriction
3117b17ce1afSJed Brown .  inject - injection matrix, also use MatRestrict()
3118e91eccc2SStefano Zampini -  coarse - coarser DM to update
3119b17ce1afSJed Brown 
3120b17ce1afSJed Brown    Level: developer
3121b17ce1afSJed Brown 
3122b17ce1afSJed Brown .seealso: DMCoarsenHookAdd(), MatRestrict()
3123b17ce1afSJed Brown @*/
3124b17ce1afSJed Brown PetscErrorCode DMRestrict(DM fine,Mat restrct,Vec rscale,Mat inject,DM coarse)
3125b17ce1afSJed Brown {
3126b17ce1afSJed Brown   PetscErrorCode    ierr;
3127b17ce1afSJed Brown   DMCoarsenHookLink link;
3128b17ce1afSJed Brown 
3129b17ce1afSJed Brown   PetscFunctionBegin;
3130b17ce1afSJed Brown   for (link=fine->coarsenhook; link; link=link->next) {
31318865f1eaSKarl Rupp     if (link->restricthook) {
31328865f1eaSKarl Rupp       ierr = (*link->restricthook)(fine,restrct,rscale,inject,coarse,link->ctx);CHKERRQ(ierr);
31338865f1eaSKarl Rupp     }
3134b17ce1afSJed Brown   }
313547c6ae99SBarry Smith   PetscFunctionReturn(0);
313647c6ae99SBarry Smith }
313747c6ae99SBarry Smith 
3138bb9467b5SJed Brown /*@C
3139be081cd6SPeter Brune    DMSubDomainHookAdd - adds a callback to be run when restricting a problem to the coarse grid
31405dbd56e3SPeter Brune 
3141d083f849SBarry Smith    Logically Collective on global
31425dbd56e3SPeter Brune 
31435dbd56e3SPeter Brune    Input Arguments:
31445dbd56e3SPeter Brune +  global - global DM
3145ec4806b8SPeter Brune .  ddhook - function to run to pass data to the decomposition DM upon its creation
31465dbd56e3SPeter Brune .  restricthook - function to run to update data on block solve (at the beginning of the block solve)
31470298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
31485dbd56e3SPeter Brune 
3149ec4806b8SPeter Brune 
3150ec4806b8SPeter Brune    Calling sequence for ddhook:
3151ec4806b8SPeter Brune $    ddhook(DM global,DM block,void *ctx)
3152ec4806b8SPeter Brune 
3153ec4806b8SPeter Brune +  global - global DM
3154ec4806b8SPeter Brune .  block  - block DM
3155ec4806b8SPeter Brune -  ctx - optional user-defined function context
3156ec4806b8SPeter Brune 
31575dbd56e3SPeter Brune    Calling sequence for restricthook:
3158ec4806b8SPeter Brune $    restricthook(DM global,VecScatter out,VecScatter in,DM block,void *ctx)
31595dbd56e3SPeter Brune 
31605dbd56e3SPeter Brune +  global - global DM
31615dbd56e3SPeter Brune .  out    - scatter to the outer (with ghost and overlap points) block vector
31625dbd56e3SPeter Brune .  in     - scatter to block vector values only owned locally
3163ec4806b8SPeter Brune .  block  - block DM
31645dbd56e3SPeter Brune -  ctx - optional user-defined function context
31655dbd56e3SPeter Brune 
31665dbd56e3SPeter Brune    Level: advanced
31675dbd56e3SPeter Brune 
31685dbd56e3SPeter Brune    Notes:
3169ec4806b8SPeter Brune    This function is only needed if auxiliary data needs to be set up on subdomain DMs.
31705dbd56e3SPeter Brune 
31715dbd56e3SPeter Brune    If this function is called multiple times, the hooks will be run in the order they are added.
31725dbd56e3SPeter Brune 
31735dbd56e3SPeter Brune    In order to compose with nonlinear preconditioning without duplicating storage, the hook should be implemented to
3174ec4806b8SPeter Brune    extract the global information from its context (instead of from the SNES).
31755dbd56e3SPeter Brune 
3176bb9467b5SJed Brown    This function is currently not available from Fortran.
3177bb9467b5SJed Brown 
31785dbd56e3SPeter Brune .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
31795dbd56e3SPeter Brune @*/
3180be081cd6SPeter Brune PetscErrorCode DMSubDomainHookAdd(DM global,PetscErrorCode (*ddhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,VecScatter,VecScatter,DM,void*),void *ctx)
31815dbd56e3SPeter Brune {
31825dbd56e3SPeter Brune   PetscErrorCode      ierr;
3183be081cd6SPeter Brune   DMSubDomainHookLink link,*p;
31845dbd56e3SPeter Brune 
31855dbd56e3SPeter Brune   PetscFunctionBegin;
31865dbd56e3SPeter Brune   PetscValidHeaderSpecific(global,DM_CLASSID,1);
3187b3a6b972SJed Brown   for (p=&global->subdomainhook; *p; p=&(*p)->next) { /* Scan to the end of the current list of hooks */
3188b3a6b972SJed Brown     if ((*p)->ddhook == ddhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) PetscFunctionReturn(0);
3189b3a6b972SJed Brown   }
319095dccacaSBarry Smith   ierr               = PetscNew(&link);CHKERRQ(ierr);
31915dbd56e3SPeter Brune   link->restricthook = restricthook;
3192be081cd6SPeter Brune   link->ddhook       = ddhook;
31935dbd56e3SPeter Brune   link->ctx          = ctx;
31940298fd71SBarry Smith   link->next         = NULL;
31955dbd56e3SPeter Brune   *p                 = link;
31965dbd56e3SPeter Brune   PetscFunctionReturn(0);
31975dbd56e3SPeter Brune }
31985dbd56e3SPeter Brune 
3199b3a6b972SJed Brown /*@C
3200b3a6b972SJed Brown    DMSubDomainHookRemove - remove a callback from the list to be run when restricting a problem to the coarse grid
3201b3a6b972SJed Brown 
3202b3a6b972SJed Brown    Logically Collective
3203b3a6b972SJed Brown 
3204b3a6b972SJed Brown    Input Arguments:
3205b3a6b972SJed Brown +  global - global DM
3206b3a6b972SJed Brown .  ddhook - function to run to pass data to the decomposition DM upon its creation
3207b3a6b972SJed Brown .  restricthook - function to run to update data on block solve (at the beginning of the block solve)
3208b3a6b972SJed Brown -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
3209b3a6b972SJed Brown 
3210b3a6b972SJed Brown    Level: advanced
3211b3a6b972SJed Brown 
3212b3a6b972SJed Brown    Notes:
3213b3a6b972SJed Brown 
3214b3a6b972SJed Brown    This function is currently not available from Fortran.
3215b3a6b972SJed Brown 
3216b3a6b972SJed Brown .seealso: DMSubDomainHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
3217b3a6b972SJed Brown @*/
3218b3a6b972SJed Brown PetscErrorCode DMSubDomainHookRemove(DM global,PetscErrorCode (*ddhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,VecScatter,VecScatter,DM,void*),void *ctx)
3219b3a6b972SJed Brown {
3220b3a6b972SJed Brown   PetscErrorCode      ierr;
3221b3a6b972SJed Brown   DMSubDomainHookLink link,*p;
3222b3a6b972SJed Brown 
3223b3a6b972SJed Brown   PetscFunctionBegin;
3224b3a6b972SJed Brown   PetscValidHeaderSpecific(global,DM_CLASSID,1);
3225b3a6b972SJed Brown   for (p=&global->subdomainhook; *p; p=&(*p)->next) { /* Search the list of current hooks */
3226b3a6b972SJed Brown     if ((*p)->ddhook == ddhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) {
3227b3a6b972SJed Brown       link = *p;
3228b3a6b972SJed Brown       *p = link->next;
3229b3a6b972SJed Brown       ierr = PetscFree(link);CHKERRQ(ierr);
3230b3a6b972SJed Brown       break;
3231b3a6b972SJed Brown     }
3232b3a6b972SJed Brown   }
3233b3a6b972SJed Brown   PetscFunctionReturn(0);
3234b3a6b972SJed Brown }
3235b3a6b972SJed Brown 
32365dbd56e3SPeter Brune /*@
3237be081cd6SPeter Brune    DMSubDomainRestrict - restricts user-defined problem data to a block DM by running hooks registered by DMSubDomainHookAdd()
32385dbd56e3SPeter Brune 
32395dbd56e3SPeter Brune    Collective if any hooks are
32405dbd56e3SPeter Brune 
32415dbd56e3SPeter Brune    Input Arguments:
32425dbd56e3SPeter Brune +  fine - finer DM to use as a base
3243be081cd6SPeter Brune .  oscatter - scatter from domain global vector filling subdomain global vector with overlap
3244be081cd6SPeter Brune .  gscatter - scatter from domain global vector filling subdomain local vector with ghosts
32455dbd56e3SPeter Brune -  coarse - coarer DM to update
32465dbd56e3SPeter Brune 
32475dbd56e3SPeter Brune    Level: developer
32485dbd56e3SPeter Brune 
32495dbd56e3SPeter Brune .seealso: DMCoarsenHookAdd(), MatRestrict()
32505dbd56e3SPeter Brune @*/
3251be081cd6SPeter Brune PetscErrorCode DMSubDomainRestrict(DM global,VecScatter oscatter,VecScatter gscatter,DM subdm)
32525dbd56e3SPeter Brune {
32535dbd56e3SPeter Brune   PetscErrorCode      ierr;
3254be081cd6SPeter Brune   DMSubDomainHookLink link;
32555dbd56e3SPeter Brune 
32565dbd56e3SPeter Brune   PetscFunctionBegin;
3257be081cd6SPeter Brune   for (link=global->subdomainhook; link; link=link->next) {
32588865f1eaSKarl Rupp     if (link->restricthook) {
32598865f1eaSKarl Rupp       ierr = (*link->restricthook)(global,oscatter,gscatter,subdm,link->ctx);CHKERRQ(ierr);
32608865f1eaSKarl Rupp     }
32615dbd56e3SPeter Brune   }
32625dbd56e3SPeter Brune   PetscFunctionReturn(0);
32635dbd56e3SPeter Brune }
32645dbd56e3SPeter Brune 
32655fe1f584SPeter Brune /*@
32666a7d9d85SPeter Brune     DMGetCoarsenLevel - Get's the number of coarsenings that have generated this DM.
32675fe1f584SPeter Brune 
32685fe1f584SPeter Brune     Not Collective
32695fe1f584SPeter Brune 
32705fe1f584SPeter Brune     Input Parameter:
32715fe1f584SPeter Brune .   dm - the DM object
32725fe1f584SPeter Brune 
32735fe1f584SPeter Brune     Output Parameter:
32746a7d9d85SPeter Brune .   level - number of coarsenings
32755fe1f584SPeter Brune 
32765fe1f584SPeter Brune     Level: developer
32775fe1f584SPeter Brune 
32786a7d9d85SPeter Brune .seealso DMCoarsen(), DMGetRefineLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
32795fe1f584SPeter Brune 
32805fe1f584SPeter Brune @*/
32815fe1f584SPeter Brune PetscErrorCode  DMGetCoarsenLevel(DM dm,PetscInt *level)
32825fe1f584SPeter Brune {
32835fe1f584SPeter Brune   PetscFunctionBegin;
32845fe1f584SPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3285b9d85ea2SLisandro Dalcin   PetscValidIntPointer(level,2);
32865fe1f584SPeter Brune   *level = dm->leveldown;
32875fe1f584SPeter Brune   PetscFunctionReturn(0);
32885fe1f584SPeter Brune }
32895fe1f584SPeter Brune 
32909a64c4a8SMatthew G. Knepley /*@
32919a64c4a8SMatthew G. Knepley     DMSetCoarsenLevel - Sets the number of coarsenings that have generated this DM.
32929a64c4a8SMatthew G. Knepley 
32939a64c4a8SMatthew G. Knepley     Not Collective
32949a64c4a8SMatthew G. Knepley 
32959a64c4a8SMatthew G. Knepley     Input Parameters:
32969a64c4a8SMatthew G. Knepley +   dm - the DM object
32979a64c4a8SMatthew G. Knepley -   level - number of coarsenings
32989a64c4a8SMatthew G. Knepley 
32999a64c4a8SMatthew G. Knepley     Level: developer
33009a64c4a8SMatthew G. Knepley 
33019a64c4a8SMatthew G. Knepley .seealso DMCoarsen(), DMGetCoarsenLevel(), DMGetRefineLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
33029a64c4a8SMatthew G. Knepley @*/
33039a64c4a8SMatthew G. Knepley PetscErrorCode DMSetCoarsenLevel(DM dm,PetscInt level)
33049a64c4a8SMatthew G. Knepley {
33059a64c4a8SMatthew G. Knepley   PetscFunctionBegin;
33069a64c4a8SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
33079a64c4a8SMatthew G. Knepley   dm->leveldown = level;
33089a64c4a8SMatthew G. Knepley   PetscFunctionReturn(0);
33099a64c4a8SMatthew G. Knepley }
33109a64c4a8SMatthew G. Knepley 
33115fe1f584SPeter Brune 
33125fe1f584SPeter Brune 
331347c6ae99SBarry Smith /*@C
331447c6ae99SBarry Smith     DMRefineHierarchy - Refines a DM object, all levels at once
331547c6ae99SBarry Smith 
3316d083f849SBarry Smith     Collective on dm
331747c6ae99SBarry Smith 
331847c6ae99SBarry Smith     Input Parameter:
331947c6ae99SBarry Smith +   dm - the DM object
332047c6ae99SBarry Smith -   nlevels - the number of levels of refinement
332147c6ae99SBarry Smith 
332247c6ae99SBarry Smith     Output Parameter:
332347c6ae99SBarry Smith .   dmf - the refined DM hierarchy
332447c6ae99SBarry Smith 
332547c6ae99SBarry Smith     Level: developer
332647c6ae99SBarry Smith 
3327e727c939SJed Brown .seealso DMCoarsenHierarchy(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
332847c6ae99SBarry Smith 
332947c6ae99SBarry Smith @*/
33307087cfbeSBarry Smith PetscErrorCode  DMRefineHierarchy(DM dm,PetscInt nlevels,DM dmf[])
333147c6ae99SBarry Smith {
333247c6ae99SBarry Smith   PetscErrorCode ierr;
333347c6ae99SBarry Smith 
333447c6ae99SBarry Smith   PetscFunctionBegin;
3335171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3336ce94432eSBarry Smith   if (nlevels < 0) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_OUTOFRANGE,"nlevels cannot be negative");
333747c6ae99SBarry Smith   if (nlevels == 0) PetscFunctionReturn(0);
3338b9d85ea2SLisandro Dalcin   PetscValidPointer(dmf,3);
333947c6ae99SBarry Smith   if (dm->ops->refinehierarchy) {
334047c6ae99SBarry Smith     ierr = (*dm->ops->refinehierarchy)(dm,nlevels,dmf);CHKERRQ(ierr);
334147c6ae99SBarry Smith   } else if (dm->ops->refine) {
334247c6ae99SBarry Smith     PetscInt i;
334347c6ae99SBarry Smith 
3344ce94432eSBarry Smith     ierr = DMRefine(dm,PetscObjectComm((PetscObject)dm),&dmf[0]);CHKERRQ(ierr);
334547c6ae99SBarry Smith     for (i=1; i<nlevels; i++) {
3346ce94432eSBarry Smith       ierr = DMRefine(dmf[i-1],PetscObjectComm((PetscObject)dm),&dmf[i]);CHKERRQ(ierr);
334747c6ae99SBarry Smith     }
3348ce94432eSBarry Smith   } else SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"No RefineHierarchy for this DM yet");
334947c6ae99SBarry Smith   PetscFunctionReturn(0);
335047c6ae99SBarry Smith }
335147c6ae99SBarry Smith 
335247c6ae99SBarry Smith /*@C
335347c6ae99SBarry Smith     DMCoarsenHierarchy - Coarsens a DM object, all levels at once
335447c6ae99SBarry Smith 
3355d083f849SBarry Smith     Collective on dm
335647c6ae99SBarry Smith 
335747c6ae99SBarry Smith     Input Parameter:
335847c6ae99SBarry Smith +   dm - the DM object
335947c6ae99SBarry Smith -   nlevels - the number of levels of coarsening
336047c6ae99SBarry Smith 
336147c6ae99SBarry Smith     Output Parameter:
336247c6ae99SBarry Smith .   dmc - the coarsened DM hierarchy
336347c6ae99SBarry Smith 
336447c6ae99SBarry Smith     Level: developer
336547c6ae99SBarry Smith 
3366e727c939SJed Brown .seealso DMRefineHierarchy(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
336747c6ae99SBarry Smith 
336847c6ae99SBarry Smith @*/
33697087cfbeSBarry Smith PetscErrorCode  DMCoarsenHierarchy(DM dm, PetscInt nlevels, DM dmc[])
337047c6ae99SBarry Smith {
337147c6ae99SBarry Smith   PetscErrorCode ierr;
337247c6ae99SBarry Smith 
337347c6ae99SBarry Smith   PetscFunctionBegin;
3374171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3375ce94432eSBarry Smith   if (nlevels < 0) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_OUTOFRANGE,"nlevels cannot be negative");
337647c6ae99SBarry Smith   if (nlevels == 0) PetscFunctionReturn(0);
337747c6ae99SBarry Smith   PetscValidPointer(dmc,3);
337847c6ae99SBarry Smith   if (dm->ops->coarsenhierarchy) {
337947c6ae99SBarry Smith     ierr = (*dm->ops->coarsenhierarchy)(dm, nlevels, dmc);CHKERRQ(ierr);
338047c6ae99SBarry Smith   } else if (dm->ops->coarsen) {
338147c6ae99SBarry Smith     PetscInt i;
338247c6ae99SBarry Smith 
3383ce94432eSBarry Smith     ierr = DMCoarsen(dm,PetscObjectComm((PetscObject)dm),&dmc[0]);CHKERRQ(ierr);
338447c6ae99SBarry Smith     for (i=1; i<nlevels; i++) {
3385ce94432eSBarry Smith       ierr = DMCoarsen(dmc[i-1],PetscObjectComm((PetscObject)dm),&dmc[i]);CHKERRQ(ierr);
338647c6ae99SBarry Smith     }
3387ce94432eSBarry Smith   } else SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"No CoarsenHierarchy for this DM yet");
338847c6ae99SBarry Smith   PetscFunctionReturn(0);
338947c6ae99SBarry Smith }
339047c6ae99SBarry Smith 
33911a266240SBarry Smith /*@C
33921a266240SBarry Smith     DMSetApplicationContextDestroy - Sets a user function that will be called to destroy the application context when the DM is destroyed
33931a266240SBarry Smith 
33941a266240SBarry Smith     Not Collective
33951a266240SBarry Smith 
33961a266240SBarry Smith     Input Parameters:
33971a266240SBarry Smith +   dm - the DM object
33981a266240SBarry Smith -   destroy - the destroy function
33991a266240SBarry Smith 
34001a266240SBarry Smith     Level: intermediate
34011a266240SBarry Smith 
3402e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
34031a266240SBarry Smith 
3404f07f9ceaSJed Brown @*/
34051a266240SBarry Smith PetscErrorCode  DMSetApplicationContextDestroy(DM dm,PetscErrorCode (*destroy)(void**))
34061a266240SBarry Smith {
34071a266240SBarry Smith   PetscFunctionBegin;
3408171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
34091a266240SBarry Smith   dm->ctxdestroy = destroy;
34101a266240SBarry Smith   PetscFunctionReturn(0);
34111a266240SBarry Smith }
34121a266240SBarry Smith 
3413b07ff414SBarry Smith /*@
34141b2093e4SBarry Smith     DMSetApplicationContext - Set a user context into a DM object
341547c6ae99SBarry Smith 
341647c6ae99SBarry Smith     Not Collective
341747c6ae99SBarry Smith 
341847c6ae99SBarry Smith     Input Parameters:
341947c6ae99SBarry Smith +   dm - the DM object
342047c6ae99SBarry Smith -   ctx - the user context
342147c6ae99SBarry Smith 
342247c6ae99SBarry Smith     Level: intermediate
342347c6ae99SBarry Smith 
3424e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
342547c6ae99SBarry Smith 
342647c6ae99SBarry Smith @*/
34271b2093e4SBarry Smith PetscErrorCode  DMSetApplicationContext(DM dm,void *ctx)
342847c6ae99SBarry Smith {
342947c6ae99SBarry Smith   PetscFunctionBegin;
3430171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
343147c6ae99SBarry Smith   dm->ctx = ctx;
343247c6ae99SBarry Smith   PetscFunctionReturn(0);
343347c6ae99SBarry Smith }
343447c6ae99SBarry Smith 
343547c6ae99SBarry Smith /*@
34361b2093e4SBarry Smith     DMGetApplicationContext - Gets a user context from a DM object
343747c6ae99SBarry Smith 
343847c6ae99SBarry Smith     Not Collective
343947c6ae99SBarry Smith 
344047c6ae99SBarry Smith     Input Parameter:
344147c6ae99SBarry Smith .   dm - the DM object
344247c6ae99SBarry Smith 
344347c6ae99SBarry Smith     Output Parameter:
344447c6ae99SBarry Smith .   ctx - the user context
344547c6ae99SBarry Smith 
344647c6ae99SBarry Smith     Level: intermediate
344747c6ae99SBarry Smith 
3448e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
344947c6ae99SBarry Smith 
345047c6ae99SBarry Smith @*/
34511b2093e4SBarry Smith PetscErrorCode  DMGetApplicationContext(DM dm,void *ctx)
345247c6ae99SBarry Smith {
345347c6ae99SBarry Smith   PetscFunctionBegin;
3454171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
34551b2093e4SBarry Smith   *(void**)ctx = dm->ctx;
345647c6ae99SBarry Smith   PetscFunctionReturn(0);
345747c6ae99SBarry Smith }
345847c6ae99SBarry Smith 
345908da532bSDmitry Karpeev /*@C
3460df3898eeSBarry Smith     DMSetVariableBounds - sets a function to compute the lower and upper bound vectors for SNESVI.
346108da532bSDmitry Karpeev 
3462d083f849SBarry Smith     Logically Collective on dm
346308da532bSDmitry Karpeev 
346408da532bSDmitry Karpeev     Input Parameter:
346508da532bSDmitry Karpeev +   dm - the DM object
34660298fd71SBarry Smith -   f - the function that computes variable bounds used by SNESVI (use NULL to cancel a previous function that was set)
346708da532bSDmitry Karpeev 
346808da532bSDmitry Karpeev     Level: intermediate
346908da532bSDmitry Karpeev 
3470835c3ec7SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext(),
347108da532bSDmitry Karpeev          DMSetJacobian()
347208da532bSDmitry Karpeev 
347308da532bSDmitry Karpeev @*/
347408da532bSDmitry Karpeev PetscErrorCode DMSetVariableBounds(DM dm,PetscErrorCode (*f)(DM,Vec,Vec))
347508da532bSDmitry Karpeev {
347608da532bSDmitry Karpeev   PetscFunctionBegin;
34775a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
347808da532bSDmitry Karpeev   dm->ops->computevariablebounds = f;
347908da532bSDmitry Karpeev   PetscFunctionReturn(0);
348008da532bSDmitry Karpeev }
348108da532bSDmitry Karpeev 
348208da532bSDmitry Karpeev /*@
348308da532bSDmitry Karpeev     DMHasVariableBounds - does the DM object have a variable bounds function?
348408da532bSDmitry Karpeev 
348508da532bSDmitry Karpeev     Not Collective
348608da532bSDmitry Karpeev 
348708da532bSDmitry Karpeev     Input Parameter:
348808da532bSDmitry Karpeev .   dm - the DM object to destroy
348908da532bSDmitry Karpeev 
349008da532bSDmitry Karpeev     Output Parameter:
349108da532bSDmitry Karpeev .   flg - PETSC_TRUE if the variable bounds function exists
349208da532bSDmitry Karpeev 
349308da532bSDmitry Karpeev     Level: developer
349408da532bSDmitry Karpeev 
349574e1e8c1SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
349608da532bSDmitry Karpeev 
349708da532bSDmitry Karpeev @*/
349808da532bSDmitry Karpeev PetscErrorCode DMHasVariableBounds(DM dm,PetscBool *flg)
349908da532bSDmitry Karpeev {
350008da532bSDmitry Karpeev   PetscFunctionBegin;
35015a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3502534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
350308da532bSDmitry Karpeev   *flg =  (dm->ops->computevariablebounds) ? PETSC_TRUE : PETSC_FALSE;
350408da532bSDmitry Karpeev   PetscFunctionReturn(0);
350508da532bSDmitry Karpeev }
350608da532bSDmitry Karpeev 
350708da532bSDmitry Karpeev /*@C
350808da532bSDmitry Karpeev     DMComputeVariableBounds - compute variable bounds used by SNESVI.
350908da532bSDmitry Karpeev 
3510d083f849SBarry Smith     Logically Collective on dm
351108da532bSDmitry Karpeev 
351208da532bSDmitry Karpeev     Input Parameters:
3513907376e6SBarry Smith .   dm - the DM object
351408da532bSDmitry Karpeev 
351508da532bSDmitry Karpeev     Output parameters:
351608da532bSDmitry Karpeev +   xl - lower bound
351708da532bSDmitry Karpeev -   xu - upper bound
351808da532bSDmitry Karpeev 
3519907376e6SBarry Smith     Level: advanced
3520907376e6SBarry Smith 
352195452b02SPatrick Sanan     Notes:
352295452b02SPatrick Sanan     This is generally not called by users. It calls the function provided by the user with DMSetVariableBounds()
352308da532bSDmitry Karpeev 
352474e1e8c1SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
352508da532bSDmitry Karpeev 
352608da532bSDmitry Karpeev @*/
352708da532bSDmitry Karpeev PetscErrorCode DMComputeVariableBounds(DM dm, Vec xl, Vec xu)
352808da532bSDmitry Karpeev {
352908da532bSDmitry Karpeev   PetscErrorCode ierr;
35305fd66863SKarl Rupp 
353108da532bSDmitry Karpeev   PetscFunctionBegin;
35325a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
353308da532bSDmitry Karpeev   PetscValidHeaderSpecific(xl,VEC_CLASSID,2);
35345a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(xu,VEC_CLASSID,3);
3535b9d85ea2SLisandro Dalcin   if (!dm->ops->computevariablebounds) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeVariableBounds",((PetscObject)dm)->type_name);
353608da532bSDmitry Karpeev   ierr = (*dm->ops->computevariablebounds)(dm, xl,xu);CHKERRQ(ierr);
353708da532bSDmitry Karpeev   PetscFunctionReturn(0);
353808da532bSDmitry Karpeev }
353908da532bSDmitry Karpeev 
3540b0ae01b7SPeter Brune /*@
3541b0ae01b7SPeter Brune     DMHasColoring - does the DM object have a method of providing a coloring?
3542b0ae01b7SPeter Brune 
3543b0ae01b7SPeter Brune     Not Collective
3544b0ae01b7SPeter Brune 
3545b0ae01b7SPeter Brune     Input Parameter:
3546b0ae01b7SPeter Brune .   dm - the DM object
3547b0ae01b7SPeter Brune 
3548b0ae01b7SPeter Brune     Output Parameter:
3549b0ae01b7SPeter Brune .   flg - PETSC_TRUE if the DM has facilities for DMCreateColoring().
3550b0ae01b7SPeter Brune 
3551b0ae01b7SPeter Brune     Level: developer
3552b0ae01b7SPeter Brune 
35531565f0a7SPatrick Sanan .seealso DMCreateColoring()
3554b0ae01b7SPeter Brune 
3555b0ae01b7SPeter Brune @*/
3556b0ae01b7SPeter Brune PetscErrorCode DMHasColoring(DM dm,PetscBool *flg)
3557b0ae01b7SPeter Brune {
3558b0ae01b7SPeter Brune   PetscFunctionBegin;
35595a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3560534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
3561b0ae01b7SPeter Brune   *flg =  (dm->ops->getcoloring) ? PETSC_TRUE : PETSC_FALSE;
3562b0ae01b7SPeter Brune   PetscFunctionReturn(0);
3563b0ae01b7SPeter Brune }
3564b0ae01b7SPeter Brune 
35653ad4599aSBarry Smith /*@
35663ad4599aSBarry Smith     DMHasCreateRestriction - does the DM object have a method of providing a restriction?
35673ad4599aSBarry Smith 
35683ad4599aSBarry Smith     Not Collective
35693ad4599aSBarry Smith 
35703ad4599aSBarry Smith     Input Parameter:
35713ad4599aSBarry Smith .   dm - the DM object
35723ad4599aSBarry Smith 
35733ad4599aSBarry Smith     Output Parameter:
35743ad4599aSBarry Smith .   flg - PETSC_TRUE if the DM has facilities for DMCreateRestriction().
35753ad4599aSBarry Smith 
35763ad4599aSBarry Smith     Level: developer
35773ad4599aSBarry Smith 
35781565f0a7SPatrick Sanan .seealso DMCreateRestriction()
35793ad4599aSBarry Smith 
35803ad4599aSBarry Smith @*/
35813ad4599aSBarry Smith PetscErrorCode DMHasCreateRestriction(DM dm,PetscBool *flg)
35823ad4599aSBarry Smith {
35833ad4599aSBarry Smith   PetscFunctionBegin;
35845a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3585534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
35863ad4599aSBarry Smith   *flg =  (dm->ops->createrestriction) ? PETSC_TRUE : PETSC_FALSE;
35873ad4599aSBarry Smith   PetscFunctionReturn(0);
35883ad4599aSBarry Smith }
35893ad4599aSBarry Smith 
3590a7058e45SLawrence Mitchell 
3591a7058e45SLawrence Mitchell /*@
3592a7058e45SLawrence Mitchell     DMHasCreateInjection - does the DM object have a method of providing an injection?
3593a7058e45SLawrence Mitchell 
3594a7058e45SLawrence Mitchell     Not Collective
3595a7058e45SLawrence Mitchell 
3596a7058e45SLawrence Mitchell     Input Parameter:
3597a7058e45SLawrence Mitchell .   dm - the DM object
3598a7058e45SLawrence Mitchell 
3599a7058e45SLawrence Mitchell     Output Parameter:
3600a7058e45SLawrence Mitchell .   flg - PETSC_TRUE if the DM has facilities for DMCreateInjection().
3601a7058e45SLawrence Mitchell 
3602a7058e45SLawrence Mitchell     Level: developer
3603a7058e45SLawrence Mitchell 
36041565f0a7SPatrick Sanan .seealso DMCreateInjection()
3605a7058e45SLawrence Mitchell 
3606a7058e45SLawrence Mitchell @*/
3607a7058e45SLawrence Mitchell PetscErrorCode DMHasCreateInjection(DM dm,PetscBool *flg)
3608a7058e45SLawrence Mitchell {
36094a7a4c06SLawrence Mitchell   PetscErrorCode ierr;
36105a84ad33SLisandro Dalcin 
3611a7058e45SLawrence Mitchell   PetscFunctionBegin;
36125a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3613534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
36145a84ad33SLisandro Dalcin   if (dm->ops->hascreateinjection) {
36154a7a4c06SLawrence Mitchell     ierr = (*dm->ops->hascreateinjection)(dm,flg);CHKERRQ(ierr);
36165a84ad33SLisandro Dalcin   } else {
36175a84ad33SLisandro Dalcin     *flg = (dm->ops->createinjection) ? PETSC_TRUE : PETSC_FALSE;
36185a84ad33SLisandro Dalcin   }
3619a7058e45SLawrence Mitchell   PetscFunctionReturn(0);
3620a7058e45SLawrence Mitchell }
3621a7058e45SLawrence Mitchell 
36220298fd71SBarry Smith PetscFunctionList DMList              = NULL;
3623264ace61SBarry Smith PetscBool         DMRegisterAllCalled = PETSC_FALSE;
3624264ace61SBarry Smith 
3625264ace61SBarry Smith /*@C
3626264ace61SBarry Smith   DMSetType - Builds a DM, for a particular DM implementation.
3627264ace61SBarry Smith 
3628d083f849SBarry Smith   Collective on dm
3629264ace61SBarry Smith 
3630264ace61SBarry Smith   Input Parameters:
3631264ace61SBarry Smith + dm     - The DM object
3632264ace61SBarry Smith - method - The name of the DM type
3633264ace61SBarry Smith 
3634264ace61SBarry Smith   Options Database Key:
3635264ace61SBarry Smith . -dm_type <type> - Sets the DM type; use -help for a list of available types
3636264ace61SBarry Smith 
3637264ace61SBarry Smith   Notes:
3638e1589f56SBarry Smith   See "petsc/include/petscdm.h" for available DM types (for instance, DM1D, DM2D, or DM3D).
3639264ace61SBarry Smith 
3640264ace61SBarry Smith   Level: intermediate
3641264ace61SBarry Smith 
3642264ace61SBarry Smith .seealso: DMGetType(), DMCreate()
3643264ace61SBarry Smith @*/
364419fd82e9SBarry Smith PetscErrorCode  DMSetType(DM dm, DMType method)
3645264ace61SBarry Smith {
3646264ace61SBarry Smith   PetscErrorCode (*r)(DM);
3647264ace61SBarry Smith   PetscBool      match;
3648264ace61SBarry Smith   PetscErrorCode ierr;
3649264ace61SBarry Smith 
3650264ace61SBarry Smith   PetscFunctionBegin;
3651264ace61SBarry Smith   PetscValidHeaderSpecific(dm, DM_CLASSID,1);
3652251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject) dm, method, &match);CHKERRQ(ierr);
3653264ace61SBarry Smith   if (match) PetscFunctionReturn(0);
3654264ace61SBarry Smith 
36550f51fdf8SToby Isaac   ierr = DMRegisterAll();CHKERRQ(ierr);
36561c9cd337SJed Brown   ierr = PetscFunctionListFind(DMList,method,&r);CHKERRQ(ierr);
3657ce94432eSBarry Smith   if (!r) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_UNKNOWN_TYPE, "Unknown DM type: %s", method);
3658264ace61SBarry Smith 
3659264ace61SBarry Smith   if (dm->ops->destroy) {
3660264ace61SBarry Smith     ierr = (*dm->ops->destroy)(dm);CHKERRQ(ierr);
3661264ace61SBarry Smith   }
3662d57f96a3SLisandro Dalcin   ierr = PetscMemzero(dm->ops,sizeof(*dm->ops));CHKERRQ(ierr);
3663264ace61SBarry Smith   ierr = PetscObjectChangeTypeName((PetscObject)dm,method);CHKERRQ(ierr);
3664d57f96a3SLisandro Dalcin   ierr = (*r)(dm);CHKERRQ(ierr);
3665264ace61SBarry Smith   PetscFunctionReturn(0);
3666264ace61SBarry Smith }
3667264ace61SBarry Smith 
3668264ace61SBarry Smith /*@C
3669264ace61SBarry Smith   DMGetType - Gets the DM type name (as a string) from the DM.
3670264ace61SBarry Smith 
3671264ace61SBarry Smith   Not Collective
3672264ace61SBarry Smith 
3673264ace61SBarry Smith   Input Parameter:
3674264ace61SBarry Smith . dm  - The DM
3675264ace61SBarry Smith 
3676264ace61SBarry Smith   Output Parameter:
3677264ace61SBarry Smith . type - The DM type name
3678264ace61SBarry Smith 
3679264ace61SBarry Smith   Level: intermediate
3680264ace61SBarry Smith 
3681264ace61SBarry Smith .seealso: DMSetType(), DMCreate()
3682264ace61SBarry Smith @*/
368319fd82e9SBarry Smith PetscErrorCode  DMGetType(DM dm, DMType *type)
3684264ace61SBarry Smith {
3685264ace61SBarry Smith   PetscErrorCode ierr;
3686264ace61SBarry Smith 
3687264ace61SBarry Smith   PetscFunctionBegin;
3688264ace61SBarry Smith   PetscValidHeaderSpecific(dm, DM_CLASSID,1);
3689c959eef4SJed Brown   PetscValidPointer(type,2);
3690607a6623SBarry Smith   ierr = DMRegisterAll();CHKERRQ(ierr);
3691264ace61SBarry Smith   *type = ((PetscObject)dm)->type_name;
3692264ace61SBarry Smith   PetscFunctionReturn(0);
3693264ace61SBarry Smith }
3694264ace61SBarry Smith 
369567a56275SMatthew G Knepley /*@C
369667a56275SMatthew G Knepley   DMConvert - Converts a DM to another DM, either of the same or different type.
369767a56275SMatthew G Knepley 
3698d083f849SBarry Smith   Collective on dm
369967a56275SMatthew G Knepley 
370067a56275SMatthew G Knepley   Input Parameters:
370167a56275SMatthew G Knepley + dm - the DM
370267a56275SMatthew G Knepley - newtype - new DM type (use "same" for the same type)
370367a56275SMatthew G Knepley 
370467a56275SMatthew G Knepley   Output Parameter:
370567a56275SMatthew G Knepley . M - pointer to new DM
370667a56275SMatthew G Knepley 
370767a56275SMatthew G Knepley   Notes:
370867a56275SMatthew G Knepley   Cannot be used to convert a sequential DM to parallel or parallel to sequential,
370967a56275SMatthew G Knepley   the MPI communicator of the generated DM is always the same as the communicator
371067a56275SMatthew G Knepley   of the input DM.
371167a56275SMatthew G Knepley 
371267a56275SMatthew G Knepley   Level: intermediate
371367a56275SMatthew G Knepley 
371467a56275SMatthew G Knepley .seealso: DMCreate()
371567a56275SMatthew G Knepley @*/
371619fd82e9SBarry Smith PetscErrorCode DMConvert(DM dm, DMType newtype, DM *M)
371767a56275SMatthew G Knepley {
371867a56275SMatthew G Knepley   DM             B;
371967a56275SMatthew G Knepley   char           convname[256];
3720c067b6caSMatthew G. Knepley   PetscBool      sametype/*, issame */;
372167a56275SMatthew G Knepley   PetscErrorCode ierr;
372267a56275SMatthew G Knepley 
372367a56275SMatthew G Knepley   PetscFunctionBegin;
372467a56275SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
372567a56275SMatthew G Knepley   PetscValidType(dm,1);
372667a56275SMatthew G Knepley   PetscValidPointer(M,3);
3727251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject) dm, newtype, &sametype);CHKERRQ(ierr);
3728c067b6caSMatthew G. Knepley   /* ierr = PetscStrcmp(newtype, "same", &issame);CHKERRQ(ierr); */
3729c067b6caSMatthew G. Knepley   if (sametype) {
3730c067b6caSMatthew G. Knepley     *M   = dm;
3731c067b6caSMatthew G. Knepley     ierr = PetscObjectReference((PetscObject) dm);CHKERRQ(ierr);
3732c067b6caSMatthew G. Knepley     PetscFunctionReturn(0);
3733c067b6caSMatthew G. Knepley   } else {
37340298fd71SBarry Smith     PetscErrorCode (*conv)(DM, DMType, DM*) = NULL;
373567a56275SMatthew G Knepley 
373667a56275SMatthew G Knepley     /*
373767a56275SMatthew G Knepley        Order of precedence:
373867a56275SMatthew G Knepley        1) See if a specialized converter is known to the current DM.
373967a56275SMatthew G Knepley        2) See if a specialized converter is known to the desired DM class.
374067a56275SMatthew G Knepley        3) See if a good general converter is registered for the desired class
374167a56275SMatthew G Knepley        4) See if a good general converter is known for the current matrix.
374267a56275SMatthew G Knepley        5) Use a really basic converter.
374367a56275SMatthew G Knepley     */
374467a56275SMatthew G Knepley 
374567a56275SMatthew G Knepley     /* 1) See if a specialized converter is known to the current DM and the desired class */
3746a126751eSBarry Smith     ierr = PetscStrncpy(convname,"DMConvert_",sizeof(convname));CHKERRQ(ierr);
3747a126751eSBarry Smith     ierr = PetscStrlcat(convname,((PetscObject) dm)->type_name,sizeof(convname));CHKERRQ(ierr);
3748a126751eSBarry Smith     ierr = PetscStrlcat(convname,"_",sizeof(convname));CHKERRQ(ierr);
3749a126751eSBarry Smith     ierr = PetscStrlcat(convname,newtype,sizeof(convname));CHKERRQ(ierr);
3750a126751eSBarry Smith     ierr = PetscStrlcat(convname,"_C",sizeof(convname));CHKERRQ(ierr);
37510005d66cSJed Brown     ierr = PetscObjectQueryFunction((PetscObject)dm,convname,&conv);CHKERRQ(ierr);
375267a56275SMatthew G Knepley     if (conv) goto foundconv;
375367a56275SMatthew G Knepley 
375467a56275SMatthew G Knepley     /* 2)  See if a specialized converter is known to the desired DM class. */
375582f516ccSBarry Smith     ierr = DMCreate(PetscObjectComm((PetscObject)dm), &B);CHKERRQ(ierr);
375667a56275SMatthew G Knepley     ierr = DMSetType(B, newtype);CHKERRQ(ierr);
3757a126751eSBarry Smith     ierr = PetscStrncpy(convname,"DMConvert_",sizeof(convname));CHKERRQ(ierr);
3758a126751eSBarry Smith     ierr = PetscStrlcat(convname,((PetscObject) dm)->type_name,sizeof(convname));CHKERRQ(ierr);
3759a126751eSBarry Smith     ierr = PetscStrlcat(convname,"_",sizeof(convname));CHKERRQ(ierr);
3760a126751eSBarry Smith     ierr = PetscStrlcat(convname,newtype,sizeof(convname));CHKERRQ(ierr);
3761a126751eSBarry Smith     ierr = PetscStrlcat(convname,"_C",sizeof(convname));CHKERRQ(ierr);
37620005d66cSJed Brown     ierr = PetscObjectQueryFunction((PetscObject)B,convname,&conv);CHKERRQ(ierr);
376367a56275SMatthew G Knepley     if (conv) {
3764fcfd50ebSBarry Smith       ierr = DMDestroy(&B);CHKERRQ(ierr);
376567a56275SMatthew G Knepley       goto foundconv;
376667a56275SMatthew G Knepley     }
376767a56275SMatthew G Knepley 
376867a56275SMatthew G Knepley #if 0
376967a56275SMatthew G Knepley     /* 3) See if a good general converter is registered for the desired class */
377067a56275SMatthew G Knepley     conv = B->ops->convertfrom;
3771fcfd50ebSBarry Smith     ierr = DMDestroy(&B);CHKERRQ(ierr);
377267a56275SMatthew G Knepley     if (conv) goto foundconv;
377367a56275SMatthew G Knepley 
377467a56275SMatthew G Knepley     /* 4) See if a good general converter is known for the current matrix */
377567a56275SMatthew G Knepley     if (dm->ops->convert) {
377667a56275SMatthew G Knepley       conv = dm->ops->convert;
377767a56275SMatthew G Knepley     }
377867a56275SMatthew G Knepley     if (conv) goto foundconv;
377967a56275SMatthew G Knepley #endif
378067a56275SMatthew G Knepley 
378167a56275SMatthew G Knepley     /* 5) Use a really basic converter. */
378282f516ccSBarry Smith     SETERRQ2(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "No conversion possible between DM types %s and %s", ((PetscObject) dm)->type_name, newtype);
378367a56275SMatthew G Knepley 
378467a56275SMatthew G Knepley foundconv:
378567a56275SMatthew G Knepley     ierr = PetscLogEventBegin(DM_Convert,dm,0,0,0);CHKERRQ(ierr);
378667a56275SMatthew G Knepley     ierr = (*conv)(dm,newtype,M);CHKERRQ(ierr);
378712fa691eSMatthew G. Knepley     /* Things that are independent of DM type: We should consult DMClone() here */
378890b157c4SStefano Zampini     {
378990b157c4SStefano Zampini       PetscBool             isper;
379012fa691eSMatthew G. Knepley       const PetscReal      *maxCell, *L;
379112fa691eSMatthew G. Knepley       const DMBoundaryType *bd;
379290b157c4SStefano Zampini       ierr = DMGetPeriodicity(dm, &isper, &maxCell, &L, &bd);CHKERRQ(ierr);
379390b157c4SStefano Zampini       ierr = DMSetPeriodicity(*M, isper, maxCell,  L,  bd);CHKERRQ(ierr);
379412fa691eSMatthew G. Knepley     }
379567a56275SMatthew G Knepley     ierr = PetscLogEventEnd(DM_Convert,dm,0,0,0);CHKERRQ(ierr);
379667a56275SMatthew G Knepley   }
379767a56275SMatthew G Knepley   ierr = PetscObjectStateIncrease((PetscObject) *M);CHKERRQ(ierr);
379867a56275SMatthew G Knepley   PetscFunctionReturn(0);
379967a56275SMatthew G Knepley }
3800264ace61SBarry Smith 
3801264ace61SBarry Smith /*--------------------------------------------------------------------------------------------------------------------*/
3802264ace61SBarry Smith 
3803264ace61SBarry Smith /*@C
38041c84c290SBarry Smith   DMRegister -  Adds a new DM component implementation
38051c84c290SBarry Smith 
38061c84c290SBarry Smith   Not Collective
38071c84c290SBarry Smith 
38081c84c290SBarry Smith   Input Parameters:
38091c84c290SBarry Smith + name        - The name of a new user-defined creation routine
38101c84c290SBarry Smith - create_func - The creation routine itself
38111c84c290SBarry Smith 
38121c84c290SBarry Smith   Notes:
38131c84c290SBarry Smith   DMRegister() may be called multiple times to add several user-defined DMs
38141c84c290SBarry Smith 
38151c84c290SBarry Smith 
38161c84c290SBarry Smith   Sample usage:
38171c84c290SBarry Smith .vb
3818bdf89e91SBarry Smith     DMRegister("my_da", MyDMCreate);
38191c84c290SBarry Smith .ve
38201c84c290SBarry Smith 
38211c84c290SBarry Smith   Then, your DM type can be chosen with the procedural interface via
38221c84c290SBarry Smith .vb
38231c84c290SBarry Smith     DMCreate(MPI_Comm, DM *);
38241c84c290SBarry Smith     DMSetType(DM,"my_da");
38251c84c290SBarry Smith .ve
38261c84c290SBarry Smith    or at runtime via the option
38271c84c290SBarry Smith .vb
38281c84c290SBarry Smith     -da_type my_da
38291c84c290SBarry Smith .ve
3830264ace61SBarry Smith 
3831264ace61SBarry Smith   Level: advanced
38321c84c290SBarry Smith 
3833bdf89e91SBarry Smith .seealso: DMRegisterAll(), DMRegisterDestroy()
38341c84c290SBarry Smith 
3835264ace61SBarry Smith @*/
3836bdf89e91SBarry Smith PetscErrorCode  DMRegister(const char sname[],PetscErrorCode (*function)(DM))
3837264ace61SBarry Smith {
3838264ace61SBarry Smith   PetscErrorCode ierr;
3839264ace61SBarry Smith 
3840264ace61SBarry Smith   PetscFunctionBegin;
38411d36bdfdSBarry Smith   ierr = DMInitializePackage();CHKERRQ(ierr);
3842a240a19fSJed Brown   ierr = PetscFunctionListAdd(&DMList,sname,function);CHKERRQ(ierr);
3843264ace61SBarry Smith   PetscFunctionReturn(0);
3844264ace61SBarry Smith }
3845264ace61SBarry Smith 
3846b859378eSBarry Smith /*@C
384755849f57SBarry Smith   DMLoad - Loads a DM that has been stored in binary  with DMView().
3848b859378eSBarry Smith 
3849d083f849SBarry Smith   Collective on viewer
3850b859378eSBarry Smith 
3851b859378eSBarry Smith   Input Parameters:
3852b859378eSBarry Smith + newdm - the newly loaded DM, this needs to have been created with DMCreate() or
3853b859378eSBarry Smith            some related function before a call to DMLoad().
3854b859378eSBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen() or
3855b859378eSBarry Smith            HDF5 file viewer, obtained from PetscViewerHDF5Open()
3856b859378eSBarry Smith 
3857b859378eSBarry Smith    Level: intermediate
3858b859378eSBarry Smith 
3859b859378eSBarry Smith   Notes:
386055849f57SBarry Smith    The type is determined by the data in the file, any type set into the DM before this call is ignored.
3861b859378eSBarry Smith 
3862b859378eSBarry Smith   Notes for advanced users:
3863b859378eSBarry Smith   Most users should not need to know the details of the binary storage
3864b859378eSBarry Smith   format, since DMLoad() and DMView() completely hide these details.
3865b859378eSBarry Smith   But for anyone who's interested, the standard binary matrix storage
3866b859378eSBarry Smith   format is
3867b859378eSBarry Smith .vb
3868b859378eSBarry Smith      has not yet been determined
3869b859378eSBarry Smith .ve
3870b859378eSBarry Smith 
3871b859378eSBarry Smith .seealso: PetscViewerBinaryOpen(), DMView(), MatLoad(), VecLoad()
3872b859378eSBarry Smith @*/
3873b859378eSBarry Smith PetscErrorCode  DMLoad(DM newdm, PetscViewer viewer)
3874b859378eSBarry Smith {
38759331c7a4SMatthew G. Knepley   PetscBool      isbinary, ishdf5;
3876b859378eSBarry Smith   PetscErrorCode ierr;
3877b859378eSBarry Smith 
3878b859378eSBarry Smith   PetscFunctionBegin;
3879b859378eSBarry Smith   PetscValidHeaderSpecific(newdm,DM_CLASSID,1);
3880b859378eSBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
3881fb694a9eSVaclav Hapla   ierr = PetscViewerCheckReadable(viewer);CHKERRQ(ierr);
388232c0f0efSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
38839331c7a4SMatthew G. Knepley   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERHDF5,&ishdf5);CHKERRQ(ierr);
388458cd63d5SVaclav Hapla   ierr = PetscLogEventBegin(DM_Load,viewer,0,0,0);CHKERRQ(ierr);
38859331c7a4SMatthew G. Knepley   if (isbinary) {
38869331c7a4SMatthew G. Knepley     PetscInt classid;
38879331c7a4SMatthew G. Knepley     char     type[256];
3888b859378eSBarry Smith 
3889060da220SMatthew G. Knepley     ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr);
38909200755eSBarry Smith     if (classid != DM_FILE_CLASSID) SETERRQ1(PetscObjectComm((PetscObject)newdm),PETSC_ERR_ARG_WRONG,"Not DM next in file, classid found %d",(int)classid);
3891060da220SMatthew G. Knepley     ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr);
389232c0f0efSBarry Smith     ierr = DMSetType(newdm, type);CHKERRQ(ierr);
38939331c7a4SMatthew G. Knepley     if (newdm->ops->load) {ierr = (*newdm->ops->load)(newdm,viewer);CHKERRQ(ierr);}
38949331c7a4SMatthew G. Knepley   } else if (ishdf5) {
38959331c7a4SMatthew G. Knepley     if (newdm->ops->load) {ierr = (*newdm->ops->load)(newdm,viewer);CHKERRQ(ierr);}
38969331c7a4SMatthew G. Knepley   } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen() or PetscViewerHDF5Open()");
389758cd63d5SVaclav Hapla   ierr = PetscLogEventEnd(DM_Load,viewer,0,0,0);CHKERRQ(ierr);
3898b859378eSBarry Smith   PetscFunctionReturn(0);
3899b859378eSBarry Smith }
3900b859378eSBarry Smith 
3901b2e4378dSMatthew G. Knepley /*@
3902b2e4378dSMatthew G. Knepley   DMGetLocalBoundingBox - Returns the bounding box for the piece of the DM on this process.
3903b2e4378dSMatthew G. Knepley 
3904b2e4378dSMatthew G. Knepley   Not collective
3905b2e4378dSMatthew G. Knepley 
3906b2e4378dSMatthew G. Knepley   Input Parameter:
3907b2e4378dSMatthew G. Knepley . dm - the DM
3908b2e4378dSMatthew G. Knepley 
3909b2e4378dSMatthew G. Knepley   Output Parameters:
3910b2e4378dSMatthew G. Knepley + lmin - local minimum coordinates (length coord dim, optional)
3911b2e4378dSMatthew G. Knepley - lmax - local maximim coordinates (length coord dim, optional)
3912b2e4378dSMatthew G. Knepley 
3913b2e4378dSMatthew G. Knepley   Level: beginner
3914b2e4378dSMatthew G. Knepley 
3915b2e4378dSMatthew G. Knepley   Note: If the DM is a DMDA and has no coordinates, the index bounds are returned instead.
3916b2e4378dSMatthew G. Knepley 
3917b2e4378dSMatthew G. Knepley 
3918b2e4378dSMatthew G. Knepley .seealso: DMGetCoordinates(), DMGetCoordinatesLocal(), DMGetBoundingBox()
3919b2e4378dSMatthew G. Knepley @*/
3920b2e4378dSMatthew G. Knepley PetscErrorCode DMGetLocalBoundingBox(DM dm, PetscReal lmin[], PetscReal lmax[])
3921b2e4378dSMatthew G. Knepley {
3922b2e4378dSMatthew G. Knepley   Vec                coords = NULL;
3923b2e4378dSMatthew G. Knepley   PetscReal          min[3] = {PETSC_MAX_REAL, PETSC_MAX_REAL, PETSC_MAX_REAL};
3924b2e4378dSMatthew G. Knepley   PetscReal          max[3] = {PETSC_MIN_REAL, PETSC_MIN_REAL, PETSC_MIN_REAL};
3925b2e4378dSMatthew G. Knepley   const PetscScalar *local_coords;
3926b2e4378dSMatthew G. Knepley   PetscInt           N, Ni;
3927b2e4378dSMatthew G. Knepley   PetscInt           cdim, i, j;
3928b2e4378dSMatthew G. Knepley   PetscErrorCode     ierr;
3929b2e4378dSMatthew G. Knepley 
3930b2e4378dSMatthew G. Knepley   PetscFunctionBegin;
3931b2e4378dSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
3932b2e4378dSMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
3933b2e4378dSMatthew G. Knepley   ierr = DMGetCoordinates(dm, &coords);CHKERRQ(ierr);
3934b2e4378dSMatthew G. Knepley   if (coords) {
3935b2e4378dSMatthew G. Knepley     ierr = VecGetArrayRead(coords, &local_coords);CHKERRQ(ierr);
3936b2e4378dSMatthew G. Knepley     ierr = VecGetLocalSize(coords, &N);CHKERRQ(ierr);
3937b2e4378dSMatthew G. Knepley     Ni   = N/cdim;
3938b2e4378dSMatthew G. Knepley     for (i = 0; i < Ni; ++i) {
3939b2e4378dSMatthew G. Knepley       for (j = 0; j < 3; ++j) {
3940b2e4378dSMatthew G. Knepley         min[j] = j < cdim ? PetscMin(min[j], PetscRealPart(local_coords[i*cdim+j])) : 0;
3941b2e4378dSMatthew G. Knepley         max[j] = j < cdim ? PetscMax(max[j], PetscRealPart(local_coords[i*cdim+j])) : 0;
3942b2e4378dSMatthew G. Knepley       }
3943b2e4378dSMatthew G. Knepley     }
3944b2e4378dSMatthew G. Knepley     ierr = VecRestoreArrayRead(coords, &local_coords);CHKERRQ(ierr);
3945b2e4378dSMatthew G. Knepley   } else {
3946b2e4378dSMatthew G. Knepley     PetscBool isda;
3947b2e4378dSMatthew G. Knepley 
3948b2e4378dSMatthew G. Knepley     ierr = PetscObjectTypeCompare((PetscObject) dm, DMDA, &isda);CHKERRQ(ierr);
3949b2e4378dSMatthew G. Knepley     if (isda) {ierr = DMGetLocalBoundingIndices_DMDA(dm, min, max);CHKERRQ(ierr);}
3950b2e4378dSMatthew G. Knepley   }
3951b2e4378dSMatthew G. Knepley   if (lmin) {ierr = PetscArraycpy(lmin, min, cdim);CHKERRQ(ierr);}
3952b2e4378dSMatthew G. Knepley   if (lmax) {ierr = PetscArraycpy(lmax, max, cdim);CHKERRQ(ierr);}
3953b2e4378dSMatthew G. Knepley   PetscFunctionReturn(0);
3954b2e4378dSMatthew G. Knepley }
3955b2e4378dSMatthew G. Knepley 
3956b2e4378dSMatthew G. Knepley /*@
3957b2e4378dSMatthew G. Knepley   DMGetBoundingBox - Returns the global bounding box for the DM.
3958b2e4378dSMatthew G. Knepley 
3959b2e4378dSMatthew G. Knepley   Collective
3960b2e4378dSMatthew G. Knepley 
3961b2e4378dSMatthew G. Knepley   Input Parameter:
3962b2e4378dSMatthew G. Knepley . dm - the DM
3963b2e4378dSMatthew G. Knepley 
3964b2e4378dSMatthew G. Knepley   Output Parameters:
3965b2e4378dSMatthew G. Knepley + gmin - global minimum coordinates (length coord dim, optional)
3966b2e4378dSMatthew G. Knepley - gmax - global maximim coordinates (length coord dim, optional)
3967b2e4378dSMatthew G. Knepley 
3968b2e4378dSMatthew G. Knepley   Level: beginner
3969b2e4378dSMatthew G. Knepley 
3970b2e4378dSMatthew G. Knepley .seealso: DMGetLocalBoundingBox(), DMGetCoordinates(), DMGetCoordinatesLocal()
3971b2e4378dSMatthew G. Knepley @*/
3972b2e4378dSMatthew G. Knepley PetscErrorCode DMGetBoundingBox(DM dm, PetscReal gmin[], PetscReal gmax[])
3973b2e4378dSMatthew G. Knepley {
3974b2e4378dSMatthew G. Knepley   PetscReal      lmin[3], lmax[3];
39756ce308c4SMatthew G. Knepley   PetscInt       cdim;
39766ce308c4SMatthew G. Knepley   PetscMPIInt    count;
3977b2e4378dSMatthew G. Knepley   PetscErrorCode ierr;
3978b2e4378dSMatthew G. Knepley 
3979b2e4378dSMatthew G. Knepley   PetscFunctionBegin;
3980b2e4378dSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
3981b2e4378dSMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
3982b2e4378dSMatthew G. Knepley   ierr = PetscMPIIntCast(cdim, &count);CHKERRQ(ierr);
3983b2e4378dSMatthew G. Knepley   ierr = DMGetLocalBoundingBox(dm, lmin, lmax);CHKERRQ(ierr);
3984b2e4378dSMatthew G. Knepley   if (gmin) {ierr = MPIU_Allreduce(lmin, gmin, count, MPIU_REAL, MPIU_MIN, PetscObjectComm((PetscObject) dm));CHKERRQ(ierr);}
3985b2e4378dSMatthew G. Knepley   if (gmax) {ierr = MPIU_Allreduce(lmax, gmax, count, MPIU_REAL, MPIU_MAX, PetscObjectComm((PetscObject) dm));CHKERRQ(ierr);}
3986b2e4378dSMatthew G. Knepley   PetscFunctionReturn(0);
3987b2e4378dSMatthew G. Knepley }
3988b2e4378dSMatthew G. Knepley 
39897da65231SMatthew G Knepley /******************************** FEM Support **********************************/
39907da65231SMatthew G Knepley 
3991a6dfd86eSKarl Rupp PetscErrorCode DMPrintCellVector(PetscInt c, const char name[], PetscInt len, const PetscScalar x[])
3992a6dfd86eSKarl Rupp {
39931d47ebbbSSatish Balay   PetscInt       f;
39941b30c384SMatthew G Knepley   PetscErrorCode ierr;
39951b30c384SMatthew G Knepley 
39967da65231SMatthew G Knepley   PetscFunctionBegin;
399774778d6cSJed Brown   ierr = PetscPrintf(PETSC_COMM_SELF, "Cell %D Element %s\n", c, name);CHKERRQ(ierr);
39981d47ebbbSSatish Balay   for (f = 0; f < len; ++f) {
399957622a8eSBarry Smith     ierr = PetscPrintf(PETSC_COMM_SELF, "  | %g |\n", (double)PetscRealPart(x[f]));CHKERRQ(ierr);
40007da65231SMatthew G Knepley   }
40017da65231SMatthew G Knepley   PetscFunctionReturn(0);
40027da65231SMatthew G Knepley }
40037da65231SMatthew G Knepley 
4004a6dfd86eSKarl Rupp PetscErrorCode DMPrintCellMatrix(PetscInt c, const char name[], PetscInt rows, PetscInt cols, const PetscScalar A[])
4005a6dfd86eSKarl Rupp {
40061b30c384SMatthew G Knepley   PetscInt       f, g;
40077da65231SMatthew G Knepley   PetscErrorCode ierr;
40087da65231SMatthew G Knepley 
40097da65231SMatthew G Knepley   PetscFunctionBegin;
401074778d6cSJed Brown   ierr = PetscPrintf(PETSC_COMM_SELF, "Cell %D Element %s\n", c, name);CHKERRQ(ierr);
40111d47ebbbSSatish Balay   for (f = 0; f < rows; ++f) {
401274778d6cSJed Brown     ierr = PetscPrintf(PETSC_COMM_SELF, "  |");CHKERRQ(ierr);
40131d47ebbbSSatish Balay     for (g = 0; g < cols; ++g) {
4014e3556bceSMatthew G. Knepley       ierr = PetscPrintf(PETSC_COMM_SELF, " % 9.5g", PetscRealPart(A[f*cols+g]));CHKERRQ(ierr);
40157da65231SMatthew G Knepley     }
401674778d6cSJed Brown     ierr = PetscPrintf(PETSC_COMM_SELF, " |\n");CHKERRQ(ierr);
40177da65231SMatthew G Knepley   }
40187da65231SMatthew G Knepley   PetscFunctionReturn(0);
40197da65231SMatthew G Knepley }
4020e7c4fc90SDmitry Karpeev 
40216113b454SMatthew G. Knepley PetscErrorCode DMPrintLocalVec(DM dm, const char name[], PetscReal tol, Vec X)
4022e759306cSMatthew G. Knepley {
40230c5b8624SToby Isaac   PetscInt          localSize, bs;
40240c5b8624SToby Isaac   PetscMPIInt       size;
40250c5b8624SToby Isaac   Vec               x, xglob;
40260c5b8624SToby Isaac   const PetscScalar *xarray;
4027e759306cSMatthew G. Knepley   PetscErrorCode    ierr;
4028e759306cSMatthew G. Knepley 
4029e759306cSMatthew G. Knepley   PetscFunctionBegin;
40309852e123SBarry Smith   ierr = MPI_Comm_size(PetscObjectComm((PetscObject) dm),&size);CHKERRQ(ierr);
4031e759306cSMatthew G. Knepley   ierr = VecDuplicate(X, &x);CHKERRQ(ierr);
4032e759306cSMatthew G. Knepley   ierr = VecCopy(X, x);CHKERRQ(ierr);
40336113b454SMatthew G. Knepley   ierr = VecChop(x, tol);CHKERRQ(ierr);
40340c5b8624SToby Isaac   ierr = PetscPrintf(PetscObjectComm((PetscObject) dm),"%s:\n",name);CHKERRQ(ierr);
40350c5b8624SToby Isaac   if (size > 1) {
40360c5b8624SToby Isaac     ierr = VecGetLocalSize(x,&localSize);CHKERRQ(ierr);
40370c5b8624SToby Isaac     ierr = VecGetArrayRead(x,&xarray);CHKERRQ(ierr);
40380c5b8624SToby Isaac     ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
40390c5b8624SToby Isaac     ierr = VecCreateMPIWithArray(PetscObjectComm((PetscObject) dm),bs,localSize,PETSC_DETERMINE,xarray,&xglob);CHKERRQ(ierr);
40400c5b8624SToby Isaac   } else {
40410c5b8624SToby Isaac     xglob = x;
40420c5b8624SToby Isaac   }
40430c5b8624SToby Isaac   ierr = VecView(xglob,PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject) dm)));CHKERRQ(ierr);
40440c5b8624SToby Isaac   if (size > 1) {
40450c5b8624SToby Isaac     ierr = VecDestroy(&xglob);CHKERRQ(ierr);
40460c5b8624SToby Isaac     ierr = VecRestoreArrayRead(x,&xarray);CHKERRQ(ierr);
40470c5b8624SToby Isaac   }
4048e759306cSMatthew G. Knepley   ierr = VecDestroy(&x);CHKERRQ(ierr);
4049e759306cSMatthew G. Knepley   PetscFunctionReturn(0);
4050e759306cSMatthew G. Knepley }
4051e759306cSMatthew G. Knepley 
405288ed4aceSMatthew G Knepley /*@
40531bb6d2a8SBarry Smith   DMGetSection - Get the PetscSection encoding the local data layout for the DM.   This is equivalent to DMGetLocalSection(). Deprecated in v3.12
4054061576a5SJed Brown 
4055061576a5SJed Brown   Input Parameter:
4056061576a5SJed Brown . dm - The DM
4057061576a5SJed Brown 
4058061576a5SJed Brown   Output Parameter:
4059061576a5SJed Brown . section - The PetscSection
4060061576a5SJed Brown 
4061061576a5SJed Brown   Options Database Keys:
4062061576a5SJed Brown . -dm_petscsection_view - View the Section created by the DM
4063061576a5SJed Brown 
4064061576a5SJed Brown   Level: advanced
4065061576a5SJed Brown 
4066061576a5SJed Brown   Notes:
4067061576a5SJed Brown   Use DMGetLocalSection() in new code.
4068061576a5SJed Brown 
4069061576a5SJed Brown   This gets a borrowed reference, so the user should not destroy this PetscSection.
4070061576a5SJed Brown 
4071061576a5SJed Brown .seealso: DMGetLocalSection(), DMSetLocalSection(), DMGetGlobalSection()
4072061576a5SJed Brown @*/
4073061576a5SJed Brown PetscErrorCode DMGetSection(DM dm, PetscSection *section)
4074061576a5SJed Brown {
4075061576a5SJed Brown   PetscErrorCode ierr;
4076061576a5SJed Brown 
4077061576a5SJed Brown   PetscFunctionBegin;
4078061576a5SJed Brown   ierr = DMGetLocalSection(dm,section);CHKERRQ(ierr);
4079061576a5SJed Brown   PetscFunctionReturn(0);
4080061576a5SJed Brown }
4081061576a5SJed Brown 
4082061576a5SJed Brown /*@
4083061576a5SJed Brown   DMGetLocalSection - Get the PetscSection encoding the local data layout for the DM.
408488ed4aceSMatthew G Knepley 
408588ed4aceSMatthew G Knepley   Input Parameter:
408688ed4aceSMatthew G Knepley . dm - The DM
408788ed4aceSMatthew G Knepley 
408888ed4aceSMatthew G Knepley   Output Parameter:
408988ed4aceSMatthew G Knepley . section - The PetscSection
409088ed4aceSMatthew G Knepley 
4091e5893cccSMatthew G. Knepley   Options Database Keys:
4092e5893cccSMatthew G. Knepley . -dm_petscsection_view - View the Section created by the DM
4093e5893cccSMatthew G. Knepley 
409488ed4aceSMatthew G Knepley   Level: intermediate
409588ed4aceSMatthew G Knepley 
409688ed4aceSMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSection.
409788ed4aceSMatthew G Knepley 
4098061576a5SJed Brown .seealso: DMSetLocalSection(), DMGetGlobalSection()
409988ed4aceSMatthew G Knepley @*/
4100061576a5SJed Brown PetscErrorCode DMGetLocalSection(DM dm, PetscSection *section)
41010adebc6cSBarry Smith {
4102fd59a867SMatthew G. Knepley   PetscErrorCode ierr;
4103fd59a867SMatthew G. Knepley 
410488ed4aceSMatthew G Knepley   PetscFunctionBegin;
410588ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
410688ed4aceSMatthew G Knepley   PetscValidPointer(section, 2);
41071bb6d2a8SBarry Smith   if (!dm->localSection && dm->ops->createlocalsection) {
4108e5e52638SMatthew G. Knepley     PetscInt d;
4109e5e52638SMatthew G. Knepley 
4110e5e52638SMatthew G. Knepley     if (dm->setfromoptionscalled) for (d = 0; d < dm->Nds; ++d) {ierr = PetscDSSetFromOptions(dm->probs[d].ds);CHKERRQ(ierr);}
41111bb6d2a8SBarry Smith     ierr = (*dm->ops->createlocalsection)(dm);CHKERRQ(ierr);
41121bb6d2a8SBarry Smith     if (dm->localSection) {ierr = PetscObjectViewFromOptions((PetscObject) dm->localSection, NULL, "-dm_petscsection_view");CHKERRQ(ierr);}
41132f0f8703SMatthew G. Knepley   }
41141bb6d2a8SBarry Smith   *section = dm->localSection;
411588ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
411688ed4aceSMatthew G Knepley }
411788ed4aceSMatthew G Knepley 
411888ed4aceSMatthew G Knepley /*@
41191bb6d2a8SBarry Smith   DMSetSection - Set the PetscSection encoding the local data layout for the DM.  This is equivalent to DMSetLocalSection(). Deprecated in v3.12
4120061576a5SJed Brown 
4121061576a5SJed Brown   Input Parameters:
4122061576a5SJed Brown + dm - The DM
4123061576a5SJed Brown - section - The PetscSection
4124061576a5SJed Brown 
4125061576a5SJed Brown   Level: advanced
4126061576a5SJed Brown 
4127061576a5SJed Brown   Notes:
4128061576a5SJed Brown   Use DMSetLocalSection() in new code.
4129061576a5SJed Brown 
4130061576a5SJed Brown   Any existing Section will be destroyed
4131061576a5SJed Brown 
4132061576a5SJed Brown .seealso: DMSetLocalSection(), DMGetLocalSection(), DMSetGlobalSection()
4133061576a5SJed Brown @*/
4134061576a5SJed Brown PetscErrorCode DMSetSection(DM dm, PetscSection section)
4135061576a5SJed Brown {
4136061576a5SJed Brown   PetscErrorCode ierr;
4137061576a5SJed Brown 
4138061576a5SJed Brown   PetscFunctionBegin;
4139061576a5SJed Brown   ierr = DMSetLocalSection(dm,section);CHKERRQ(ierr);
4140061576a5SJed Brown   PetscFunctionReturn(0);
4141061576a5SJed Brown }
4142061576a5SJed Brown 
4143061576a5SJed Brown /*@
4144061576a5SJed Brown   DMSetLocalSection - Set the PetscSection encoding the local data layout for the DM.
414588ed4aceSMatthew G Knepley 
414688ed4aceSMatthew G Knepley   Input Parameters:
414788ed4aceSMatthew G Knepley + dm - The DM
414888ed4aceSMatthew G Knepley - section - The PetscSection
414988ed4aceSMatthew G Knepley 
415088ed4aceSMatthew G Knepley   Level: intermediate
415188ed4aceSMatthew G Knepley 
415288ed4aceSMatthew G Knepley   Note: Any existing Section will be destroyed
415388ed4aceSMatthew G Knepley 
4154061576a5SJed Brown .seealso: DMGetLocalSection(), DMSetGlobalSection()
415588ed4aceSMatthew G Knepley @*/
4156061576a5SJed Brown PetscErrorCode DMSetLocalSection(DM dm, PetscSection section)
41570adebc6cSBarry Smith {
4158c473ab19SMatthew G. Knepley   PetscInt       numFields = 0;
4159af122d2aSMatthew G Knepley   PetscInt       f;
416088ed4aceSMatthew G Knepley   PetscErrorCode ierr;
416188ed4aceSMatthew G Knepley 
416288ed4aceSMatthew G Knepley   PetscFunctionBegin;
416388ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4164b9d85ea2SLisandro Dalcin   if (section) PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2);
41651d799100SJed Brown   ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr);
41661bb6d2a8SBarry Smith   ierr = PetscSectionDestroy(&dm->localSection);CHKERRQ(ierr);
41671bb6d2a8SBarry Smith   dm->localSection = section;
41681bb6d2a8SBarry Smith   if (section) {ierr = PetscSectionGetNumFields(dm->localSection, &numFields);CHKERRQ(ierr);}
4169af122d2aSMatthew G Knepley   if (numFields) {
4170af122d2aSMatthew G Knepley     ierr = DMSetNumFields(dm, numFields);CHKERRQ(ierr);
4171af122d2aSMatthew G Knepley     for (f = 0; f < numFields; ++f) {
41720f21e855SMatthew G. Knepley       PetscObject disc;
4173af122d2aSMatthew G Knepley       const char *name;
4174af122d2aSMatthew G Knepley 
41751bb6d2a8SBarry Smith       ierr = PetscSectionGetFieldName(dm->localSection, f, &name);CHKERRQ(ierr);
417644a7f3ddSMatthew G. Knepley       ierr = DMGetField(dm, f, NULL, &disc);CHKERRQ(ierr);
41770f21e855SMatthew G. Knepley       ierr = PetscObjectSetName(disc, name);CHKERRQ(ierr);
4178af122d2aSMatthew G Knepley     }
4179af122d2aSMatthew G Knepley   }
4180e87a4003SBarry Smith   /* The global section will be rebuilt in the next call to DMGetGlobalSection(). */
41811bb6d2a8SBarry Smith   ierr = PetscSectionDestroy(&dm->globalSection);CHKERRQ(ierr);
418288ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
418388ed4aceSMatthew G Knepley }
418488ed4aceSMatthew G Knepley 
41859435951eSToby Isaac /*@
4186b7385021SStefano Zampini   DMGetDefaultConstraints - Get the PetscSection and Mat that specify the local constraint interpolation. See DMSetDefaultConstraints() for a description of the purpose of constraint interpolation.
41879435951eSToby Isaac 
4188e228b242SToby Isaac   not collective
4189e228b242SToby Isaac 
41909435951eSToby Isaac   Input Parameter:
41919435951eSToby Isaac . dm - The DM
41929435951eSToby Isaac 
41939435951eSToby Isaac   Output Parameter:
41949435951eSToby 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.
41959435951eSToby 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.
41969435951eSToby Isaac 
41979435951eSToby Isaac   Level: advanced
41989435951eSToby Isaac 
41999435951eSToby Isaac   Note: This gets borrowed references, so the user should not destroy the PetscSection or the Mat.
42009435951eSToby Isaac 
42019435951eSToby Isaac .seealso: DMSetDefaultConstraints()
42029435951eSToby Isaac @*/
42039435951eSToby Isaac PetscErrorCode DMGetDefaultConstraints(DM dm, PetscSection *section, Mat *mat)
42049435951eSToby Isaac {
42059435951eSToby Isaac   PetscErrorCode ierr;
42069435951eSToby Isaac 
42079435951eSToby Isaac   PetscFunctionBegin;
42089435951eSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
42099435951eSToby Isaac   if (!dm->defaultConstraintSection && !dm->defaultConstraintMat && dm->ops->createdefaultconstraints) {ierr = (*dm->ops->createdefaultconstraints)(dm);CHKERRQ(ierr);}
421045a75d81SToby Isaac   if (section) {*section = dm->defaultConstraintSection;}
421145a75d81SToby Isaac   if (mat) {*mat = dm->defaultConstraintMat;}
42129435951eSToby Isaac   PetscFunctionReturn(0);
42139435951eSToby Isaac }
42149435951eSToby Isaac 
42159435951eSToby Isaac /*@
4216b7385021SStefano Zampini   DMSetDefaultConstraints - Set the PetscSection and Mat that specify the local constraint interpolation.
42179435951eSToby Isaac 
42189435951eSToby 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().
42199435951eSToby Isaac 
42209435951eSToby 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.
42219435951eSToby Isaac 
4222e228b242SToby Isaac   collective on dm
4223e228b242SToby Isaac 
42249435951eSToby Isaac   Input Parameters:
42259435951eSToby Isaac + dm - The DM
4226e228b242SToby 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).
4227e228b242SToby 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).
42289435951eSToby Isaac 
42299435951eSToby Isaac   Level: advanced
42309435951eSToby Isaac 
42319435951eSToby Isaac   Note: This increments the references of the PetscSection and the Mat, so they user can destroy them
42329435951eSToby Isaac 
42339435951eSToby Isaac .seealso: DMGetDefaultConstraints()
42349435951eSToby Isaac @*/
42359435951eSToby Isaac PetscErrorCode DMSetDefaultConstraints(DM dm, PetscSection section, Mat mat)
42369435951eSToby Isaac {
4237e228b242SToby Isaac   PetscMPIInt result;
42389435951eSToby Isaac   PetscErrorCode ierr;
42399435951eSToby Isaac 
42409435951eSToby Isaac   PetscFunctionBegin;
42419435951eSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4242e228b242SToby Isaac   if (section) {
4243e228b242SToby Isaac     PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2);
4244e228b242SToby Isaac     ierr = MPI_Comm_compare(PETSC_COMM_SELF,PetscObjectComm((PetscObject)section),&result);CHKERRQ(ierr);
4245f60917d2SBarry Smith     if (result != MPI_CONGRUENT && result != MPI_IDENT) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NOTSAMECOMM,"constraint section must have local communicator");
4246e228b242SToby Isaac   }
4247e228b242SToby Isaac   if (mat) {
4248e228b242SToby Isaac     PetscValidHeaderSpecific(mat,MAT_CLASSID,3);
4249e228b242SToby Isaac     ierr = MPI_Comm_compare(PETSC_COMM_SELF,PetscObjectComm((PetscObject)mat),&result);CHKERRQ(ierr);
4250f60917d2SBarry Smith     if (result != MPI_CONGRUENT && result != MPI_IDENT) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NOTSAMECOMM,"constraint matrix must have local communicator");
4251e228b242SToby Isaac   }
42529435951eSToby Isaac   ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr);
42539435951eSToby Isaac   ierr = PetscSectionDestroy(&dm->defaultConstraintSection);CHKERRQ(ierr);
42549435951eSToby Isaac   dm->defaultConstraintSection = section;
42559435951eSToby Isaac   ierr = PetscObjectReference((PetscObject)mat);CHKERRQ(ierr);
42569435951eSToby Isaac   ierr = MatDestroy(&dm->defaultConstraintMat);CHKERRQ(ierr);
42579435951eSToby Isaac   dm->defaultConstraintMat = mat;
42589435951eSToby Isaac   PetscFunctionReturn(0);
42599435951eSToby Isaac }
42609435951eSToby Isaac 
4261497880caSRichard Tran Mills #if defined(PETSC_USE_DEBUG)
4262507e4973SMatthew G. Knepley /*
4263507e4973SMatthew G. Knepley   DMDefaultSectionCheckConsistency - Check the consistentcy of the global and local sections.
4264507e4973SMatthew G. Knepley 
4265507e4973SMatthew G. Knepley   Input Parameters:
4266507e4973SMatthew G. Knepley + dm - The DM
4267507e4973SMatthew G. Knepley . localSection - PetscSection describing the local data layout
4268507e4973SMatthew G. Knepley - globalSection - PetscSection describing the global data layout
4269507e4973SMatthew G. Knepley 
4270507e4973SMatthew G. Knepley   Level: intermediate
4271507e4973SMatthew G. Knepley 
42721bb6d2a8SBarry Smith .seealso: DMGetSectionSF(), DMSetSectionSF()
4273507e4973SMatthew G. Knepley */
4274f741bcd2SMatthew G. Knepley static PetscErrorCode DMDefaultSectionCheckConsistency_Internal(DM dm, PetscSection localSection, PetscSection globalSection)
4275507e4973SMatthew G. Knepley {
4276507e4973SMatthew G. Knepley   MPI_Comm        comm;
4277507e4973SMatthew G. Knepley   PetscLayout     layout;
4278507e4973SMatthew G. Knepley   const PetscInt *ranges;
4279507e4973SMatthew G. Knepley   PetscInt        pStart, pEnd, p, nroots;
4280507e4973SMatthew G. Knepley   PetscMPIInt     size, rank;
4281507e4973SMatthew G. Knepley   PetscBool       valid = PETSC_TRUE, gvalid;
4282507e4973SMatthew G. Knepley   PetscErrorCode  ierr;
4283507e4973SMatthew G. Knepley 
4284507e4973SMatthew G. Knepley   PetscFunctionBegin;
4285507e4973SMatthew G. Knepley   ierr = PetscObjectGetComm((PetscObject)dm,&comm);CHKERRQ(ierr);
4286507e4973SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4287507e4973SMatthew G. Knepley   ierr = MPI_Comm_size(comm, &size);CHKERRQ(ierr);
4288507e4973SMatthew G. Knepley   ierr = MPI_Comm_rank(comm, &rank);CHKERRQ(ierr);
4289507e4973SMatthew G. Knepley   ierr = PetscSectionGetChart(globalSection, &pStart, &pEnd);CHKERRQ(ierr);
4290507e4973SMatthew G. Knepley   ierr = PetscSectionGetConstrainedStorageSize(globalSection, &nroots);CHKERRQ(ierr);
4291507e4973SMatthew G. Knepley   ierr = PetscLayoutCreate(comm, &layout);CHKERRQ(ierr);
4292507e4973SMatthew G. Knepley   ierr = PetscLayoutSetBlockSize(layout, 1);CHKERRQ(ierr);
4293507e4973SMatthew G. Knepley   ierr = PetscLayoutSetLocalSize(layout, nroots);CHKERRQ(ierr);
4294507e4973SMatthew G. Knepley   ierr = PetscLayoutSetUp(layout);CHKERRQ(ierr);
4295507e4973SMatthew G. Knepley   ierr = PetscLayoutGetRanges(layout, &ranges);CHKERRQ(ierr);
4296507e4973SMatthew G. Knepley   for (p = pStart; p < pEnd; ++p) {
4297f741bcd2SMatthew G. Knepley     PetscInt       dof, cdof, off, gdof, gcdof, goff, gsize, d;
4298507e4973SMatthew G. Knepley 
4299507e4973SMatthew G. Knepley     ierr = PetscSectionGetDof(localSection, p, &dof);CHKERRQ(ierr);
4300507e4973SMatthew G. Knepley     ierr = PetscSectionGetOffset(localSection, p, &off);CHKERRQ(ierr);
4301507e4973SMatthew G. Knepley     ierr = PetscSectionGetConstraintDof(localSection, p, &cdof);CHKERRQ(ierr);
4302507e4973SMatthew G. Knepley     ierr = PetscSectionGetDof(globalSection, p, &gdof);CHKERRQ(ierr);
4303507e4973SMatthew G. Knepley     ierr = PetscSectionGetConstraintDof(globalSection, p, &gcdof);CHKERRQ(ierr);
4304507e4973SMatthew G. Knepley     ierr = PetscSectionGetOffset(globalSection, p, &goff);CHKERRQ(ierr);
4305507e4973SMatthew G. Knepley     if (!gdof) continue; /* Censored point */
4306507e4973SMatthew 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;}
4307507e4973SMatthew 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;}
4308507e4973SMatthew G. Knepley     if (gdof < 0) {
4309507e4973SMatthew G. Knepley       gsize = gdof < 0 ? -(gdof+1)-gcdof : gdof-gcdof;
4310507e4973SMatthew G. Knepley       for (d = 0; d < gsize; ++d) {
4311507e4973SMatthew G. Knepley         PetscInt offset = -(goff+1) + d, r;
4312507e4973SMatthew G. Knepley 
4313507e4973SMatthew G. Knepley         ierr = PetscFindInt(offset,size+1,ranges,&r);CHKERRQ(ierr);
4314507e4973SMatthew G. Knepley         if (r < 0) r = -(r+2);
4315507e4973SMatthew 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;}
4316507e4973SMatthew G. Knepley       }
4317507e4973SMatthew G. Knepley     }
4318507e4973SMatthew G. Knepley   }
4319507e4973SMatthew G. Knepley   ierr = PetscLayoutDestroy(&layout);CHKERRQ(ierr);
4320507e4973SMatthew G. Knepley   ierr = PetscSynchronizedFlush(comm, NULL);CHKERRQ(ierr);
4321b2566f29SBarry Smith   ierr = MPIU_Allreduce(&valid, &gvalid, 1, MPIU_BOOL, MPI_LAND, comm);CHKERRQ(ierr);
4322507e4973SMatthew G. Knepley   if (!gvalid) {
4323507e4973SMatthew G. Knepley     ierr = DMView(dm, NULL);CHKERRQ(ierr);
4324507e4973SMatthew G. Knepley     SETERRQ(comm, PETSC_ERR_ARG_WRONG, "Inconsistent local and global sections");
4325507e4973SMatthew G. Knepley   }
4326507e4973SMatthew G. Knepley   PetscFunctionReturn(0);
4327507e4973SMatthew G. Knepley }
4328f741bcd2SMatthew G. Knepley #endif
4329507e4973SMatthew G. Knepley 
433088ed4aceSMatthew G Knepley /*@
4331e87a4003SBarry Smith   DMGetGlobalSection - Get the PetscSection encoding the global data layout for the DM.
433288ed4aceSMatthew G Knepley 
4333d083f849SBarry Smith   Collective on dm
43348b1ab98fSJed Brown 
433588ed4aceSMatthew G Knepley   Input Parameter:
433688ed4aceSMatthew G Knepley . dm - The DM
433788ed4aceSMatthew G Knepley 
433888ed4aceSMatthew G Knepley   Output Parameter:
433988ed4aceSMatthew G Knepley . section - The PetscSection
434088ed4aceSMatthew G Knepley 
434188ed4aceSMatthew G Knepley   Level: intermediate
434288ed4aceSMatthew G Knepley 
434388ed4aceSMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSection.
434488ed4aceSMatthew G Knepley 
434592fd8e1eSJed Brown .seealso: DMSetLocalSection(), DMGetLocalSection()
434688ed4aceSMatthew G Knepley @*/
4347e87a4003SBarry Smith PetscErrorCode DMGetGlobalSection(DM dm, PetscSection *section)
43480adebc6cSBarry Smith {
434988ed4aceSMatthew G Knepley   PetscErrorCode ierr;
435088ed4aceSMatthew G Knepley 
435188ed4aceSMatthew G Knepley   PetscFunctionBegin;
435288ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
435388ed4aceSMatthew G Knepley   PetscValidPointer(section, 2);
43541bb6d2a8SBarry Smith   if (!dm->globalSection) {
4355fd59a867SMatthew G. Knepley     PetscSection s;
4356fd59a867SMatthew G. Knepley 
435792fd8e1eSJed Brown     ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr);
4358fd59a867SMatthew 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");
435933907cc2SStefano Zampini     if (!dm->sf) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DM must have a point PetscSF in order to create a global PetscSection");
43601bb6d2a8SBarry Smith     ierr = PetscSectionCreateGlobalSection(s, dm->sf, PETSC_FALSE, PETSC_FALSE, &dm->globalSection);CHKERRQ(ierr);
4361cf06b437SMatthew G. Knepley     ierr = PetscLayoutDestroy(&dm->map);CHKERRQ(ierr);
43621bb6d2a8SBarry Smith     ierr = PetscSectionGetValueLayout(PetscObjectComm((PetscObject)dm), dm->globalSection, &dm->map);CHKERRQ(ierr);
43631bb6d2a8SBarry Smith     ierr = PetscSectionViewFromOptions(dm->globalSection, NULL, "-global_section_view");CHKERRQ(ierr);
436488ed4aceSMatthew G Knepley   }
43651bb6d2a8SBarry Smith   *section = dm->globalSection;
436688ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
436788ed4aceSMatthew G Knepley }
436888ed4aceSMatthew G Knepley 
4369b21d0597SMatthew G Knepley /*@
4370e87a4003SBarry Smith   DMSetGlobalSection - Set the PetscSection encoding the global data layout for the DM.
4371b21d0597SMatthew G Knepley 
4372b21d0597SMatthew G Knepley   Input Parameters:
4373b21d0597SMatthew G Knepley + dm - The DM
43745080bbdbSMatthew G Knepley - section - The PetscSection, or NULL
4375b21d0597SMatthew G Knepley 
4376b21d0597SMatthew G Knepley   Level: intermediate
4377b21d0597SMatthew G Knepley 
4378b21d0597SMatthew G Knepley   Note: Any existing Section will be destroyed
4379b21d0597SMatthew G Knepley 
438092fd8e1eSJed Brown .seealso: DMGetGlobalSection(), DMSetLocalSection()
4381b21d0597SMatthew G Knepley @*/
4382e87a4003SBarry Smith PetscErrorCode DMSetGlobalSection(DM dm, PetscSection section)
43830adebc6cSBarry Smith {
4384b21d0597SMatthew G Knepley   PetscErrorCode ierr;
4385b21d0597SMatthew G Knepley 
4386b21d0597SMatthew G Knepley   PetscFunctionBegin;
4387b21d0597SMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
43885080bbdbSMatthew G Knepley   if (section) PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2);
43891d799100SJed Brown   ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr);
43901bb6d2a8SBarry Smith   ierr = PetscSectionDestroy(&dm->globalSection);CHKERRQ(ierr);
43911bb6d2a8SBarry Smith   dm->globalSection = section;
4392497880caSRichard Tran Mills #if defined(PETSC_USE_DEBUG)
43931bb6d2a8SBarry Smith   if (section) {ierr = DMDefaultSectionCheckConsistency_Internal(dm, dm->localSection, section);CHKERRQ(ierr);}
4394507e4973SMatthew G. Knepley #endif
4395b21d0597SMatthew G Knepley   PetscFunctionReturn(0);
4396b21d0597SMatthew G Knepley }
4397b21d0597SMatthew G Knepley 
439888ed4aceSMatthew G Knepley /*@
43991bb6d2a8SBarry Smith   DMGetSectionSF - Get the PetscSF encoding the parallel dof overlap for the DM. If it has not been set,
440088ed4aceSMatthew G Knepley   it is created from the default PetscSection layouts in the DM.
440188ed4aceSMatthew G Knepley 
440288ed4aceSMatthew G Knepley   Input Parameter:
440388ed4aceSMatthew G Knepley . dm - The DM
440488ed4aceSMatthew G Knepley 
440588ed4aceSMatthew G Knepley   Output Parameter:
440688ed4aceSMatthew G Knepley . sf - The PetscSF
440788ed4aceSMatthew G Knepley 
440888ed4aceSMatthew G Knepley   Level: intermediate
440988ed4aceSMatthew G Knepley 
441088ed4aceSMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSF.
441188ed4aceSMatthew G Knepley 
44121bb6d2a8SBarry Smith .seealso: DMSetSectionSF(), DMCreateSectionSF()
441388ed4aceSMatthew G Knepley @*/
44141bb6d2a8SBarry Smith PetscErrorCode DMGetSectionSF(DM dm, PetscSF *sf)
44150adebc6cSBarry Smith {
441688ed4aceSMatthew G Knepley   PetscInt       nroots;
441788ed4aceSMatthew G Knepley   PetscErrorCode ierr;
441888ed4aceSMatthew G Knepley 
441988ed4aceSMatthew G Knepley   PetscFunctionBegin;
442088ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
442188ed4aceSMatthew G Knepley   PetscValidPointer(sf, 2);
44221bb6d2a8SBarry Smith   if (!dm->sectionSF) {
44231bb6d2a8SBarry Smith     ierr = PetscSFCreate(PetscObjectComm((PetscObject)dm),&dm->sectionSF);CHKERRQ(ierr);
442433907cc2SStefano Zampini   }
44251bb6d2a8SBarry Smith   ierr = PetscSFGetGraph(dm->sectionSF, &nroots, NULL, NULL, NULL);CHKERRQ(ierr);
442688ed4aceSMatthew G Knepley   if (nroots < 0) {
442788ed4aceSMatthew G Knepley     PetscSection section, gSection;
442888ed4aceSMatthew G Knepley 
442992fd8e1eSJed Brown     ierr = DMGetLocalSection(dm, &section);CHKERRQ(ierr);
443031ea6d37SMatthew G Knepley     if (section) {
4431e87a4003SBarry Smith       ierr = DMGetGlobalSection(dm, &gSection);CHKERRQ(ierr);
44321bb6d2a8SBarry Smith       ierr = DMCreateSectionSF(dm, section, gSection);CHKERRQ(ierr);
443331ea6d37SMatthew G Knepley     } else {
44340298fd71SBarry Smith       *sf = NULL;
443531ea6d37SMatthew G Knepley       PetscFunctionReturn(0);
443631ea6d37SMatthew G Knepley     }
443788ed4aceSMatthew G Knepley   }
44381bb6d2a8SBarry Smith   *sf = dm->sectionSF;
443988ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
444088ed4aceSMatthew G Knepley }
444188ed4aceSMatthew G Knepley 
444288ed4aceSMatthew G Knepley /*@
44431bb6d2a8SBarry Smith   DMSetSectionSF - Set the PetscSF encoding the parallel dof overlap for the DM
444488ed4aceSMatthew G Knepley 
444588ed4aceSMatthew G Knepley   Input Parameters:
444688ed4aceSMatthew G Knepley + dm - The DM
444788ed4aceSMatthew G Knepley - sf - The PetscSF
444888ed4aceSMatthew G Knepley 
444988ed4aceSMatthew G Knepley   Level: intermediate
445088ed4aceSMatthew G Knepley 
445188ed4aceSMatthew G Knepley   Note: Any previous SF is destroyed
445288ed4aceSMatthew G Knepley 
44531bb6d2a8SBarry Smith .seealso: DMGetSectionSF(), DMCreateSectionSF()
445488ed4aceSMatthew G Knepley @*/
44551bb6d2a8SBarry Smith PetscErrorCode DMSetSectionSF(DM dm, PetscSF sf)
44560adebc6cSBarry Smith {
445788ed4aceSMatthew G Knepley   PetscErrorCode ierr;
445888ed4aceSMatthew G Knepley 
445988ed4aceSMatthew G Knepley   PetscFunctionBegin;
446088ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4461b9d85ea2SLisandro Dalcin   if (sf) PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
446233907cc2SStefano Zampini   ierr = PetscObjectReference((PetscObject) sf);CHKERRQ(ierr);
44631bb6d2a8SBarry Smith   ierr = PetscSFDestroy(&dm->sectionSF);CHKERRQ(ierr);
44641bb6d2a8SBarry Smith   dm->sectionSF = sf;
446588ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
446688ed4aceSMatthew G Knepley }
446788ed4aceSMatthew G Knepley 
446888ed4aceSMatthew G Knepley /*@C
44691bb6d2a8SBarry Smith   DMCreateSectionSF - Create the PetscSF encoding the parallel dof overlap for the DM based upon the PetscSections
447088ed4aceSMatthew G Knepley   describing the data layout.
447188ed4aceSMatthew G Knepley 
447288ed4aceSMatthew G Knepley   Input Parameters:
447388ed4aceSMatthew G Knepley + dm - The DM
447488ed4aceSMatthew G Knepley . localSection - PetscSection describing the local data layout
447588ed4aceSMatthew G Knepley - globalSection - PetscSection describing the global data layout
447688ed4aceSMatthew G Knepley 
44771bb6d2a8SBarry Smith   Notes: One usually uses DMGetSectionSF() to obtain the PetscSF
447888ed4aceSMatthew G Knepley 
44791bb6d2a8SBarry Smith   Level: developer
44801bb6d2a8SBarry Smith 
44811bb6d2a8SBarry Smith   Developer Note: Since this routine has for arguments the two sections from the DM and puts the resulting PetscSF
44821bb6d2a8SBarry Smith                   directly into the DM, perhaps this function should not take the local and global sections as
44831bb6d2a8SBarry Smith                   input and should just obtain them from the DM?
44841bb6d2a8SBarry Smith 
44851bb6d2a8SBarry Smith .seealso: DMGetSectionSF(), DMSetSectionSF(), DMGetLocalSection(), DMGetGlobalSection()
448688ed4aceSMatthew G Knepley @*/
44871bb6d2a8SBarry Smith PetscErrorCode DMCreateSectionSF(DM dm, PetscSection localSection, PetscSection globalSection)
448888ed4aceSMatthew G Knepley {
448982f516ccSBarry Smith   MPI_Comm       comm;
449088ed4aceSMatthew G Knepley   PetscLayout    layout;
449188ed4aceSMatthew G Knepley   const PetscInt *ranges;
449288ed4aceSMatthew G Knepley   PetscInt       *local;
449388ed4aceSMatthew G Knepley   PetscSFNode    *remote;
4494ecd73843SMatthew G. Knepley   PetscInt       pStart, pEnd, p, nroots, nleaves = 0, l;
449588ed4aceSMatthew G Knepley   PetscMPIInt    size, rank;
449688ed4aceSMatthew G Knepley   PetscErrorCode ierr;
449788ed4aceSMatthew G Knepley 
449888ed4aceSMatthew G Knepley   PetscFunctionBegin;
449988ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4500367003a6SStefano Zampini   ierr = PetscObjectGetComm((PetscObject)dm,&comm);CHKERRQ(ierr);
450188ed4aceSMatthew G Knepley   ierr = MPI_Comm_size(comm, &size);CHKERRQ(ierr);
450288ed4aceSMatthew G Knepley   ierr = MPI_Comm_rank(comm, &rank);CHKERRQ(ierr);
450388ed4aceSMatthew G Knepley   ierr = PetscSectionGetChart(globalSection, &pStart, &pEnd);CHKERRQ(ierr);
450488ed4aceSMatthew G Knepley   ierr = PetscSectionGetConstrainedStorageSize(globalSection, &nroots);CHKERRQ(ierr);
450588ed4aceSMatthew G Knepley   ierr = PetscLayoutCreate(comm, &layout);CHKERRQ(ierr);
450688ed4aceSMatthew G Knepley   ierr = PetscLayoutSetBlockSize(layout, 1);CHKERRQ(ierr);
450788ed4aceSMatthew G Knepley   ierr = PetscLayoutSetLocalSize(layout, nroots);CHKERRQ(ierr);
450888ed4aceSMatthew G Knepley   ierr = PetscLayoutSetUp(layout);CHKERRQ(ierr);
450988ed4aceSMatthew G Knepley   ierr = PetscLayoutGetRanges(layout, &ranges);CHKERRQ(ierr);
4510ecd73843SMatthew G. Knepley   for (p = pStart; p < pEnd; ++p) {
45116636e97aSMatthew G Knepley     PetscInt gdof, gcdof;
451288ed4aceSMatthew G Knepley 
45136636e97aSMatthew G Knepley     ierr = PetscSectionGetDof(globalSection, p, &gdof);CHKERRQ(ierr);
45146636e97aSMatthew G Knepley     ierr = PetscSectionGetConstraintDof(globalSection, p, &gcdof);CHKERRQ(ierr);
4515235fbf56SMatthew 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));
45166636e97aSMatthew G Knepley     nleaves += gdof < 0 ? -(gdof+1)-gcdof : gdof-gcdof;
451788ed4aceSMatthew G Knepley   }
4518785e854fSJed Brown   ierr = PetscMalloc1(nleaves, &local);CHKERRQ(ierr);
4519785e854fSJed Brown   ierr = PetscMalloc1(nleaves, &remote);CHKERRQ(ierr);
452088ed4aceSMatthew G Knepley   for (p = pStart, l = 0; p < pEnd; ++p) {
45211f588964SMatthew G Knepley     const PetscInt *cind;
45226636e97aSMatthew G Knepley     PetscInt       dof, cdof, off, gdof, gcdof, goff, gsize, d, c;
452388ed4aceSMatthew G Knepley 
452488ed4aceSMatthew G Knepley     ierr = PetscSectionGetDof(localSection, p, &dof);CHKERRQ(ierr);
452588ed4aceSMatthew G Knepley     ierr = PetscSectionGetOffset(localSection, p, &off);CHKERRQ(ierr);
452688ed4aceSMatthew G Knepley     ierr = PetscSectionGetConstraintDof(localSection, p, &cdof);CHKERRQ(ierr);
452788ed4aceSMatthew G Knepley     ierr = PetscSectionGetConstraintIndices(localSection, p, &cind);CHKERRQ(ierr);
452888ed4aceSMatthew G Knepley     ierr = PetscSectionGetDof(globalSection, p, &gdof);CHKERRQ(ierr);
45296636e97aSMatthew G Knepley     ierr = PetscSectionGetConstraintDof(globalSection, p, &gcdof);CHKERRQ(ierr);
453088ed4aceSMatthew G Knepley     ierr = PetscSectionGetOffset(globalSection, p, &goff);CHKERRQ(ierr);
45316636e97aSMatthew G Knepley     if (!gdof) continue; /* Censored point */
45326636e97aSMatthew G Knepley     gsize = gdof < 0 ? -(gdof+1)-gcdof : gdof-gcdof;
45336636e97aSMatthew G Knepley     if (gsize != dof-cdof) {
4534057b4bcdSMatthew 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);
45356636e97aSMatthew G Knepley       cdof = 0; /* Ignore constraints */
45366636e97aSMatthew G Knepley     }
453788ed4aceSMatthew G Knepley     for (d = 0, c = 0; d < dof; ++d) {
453888ed4aceSMatthew G Knepley       if ((c < cdof) && (cind[c] == d)) {++c; continue;}
453988ed4aceSMatthew G Knepley       local[l+d-c] = off+d;
454088ed4aceSMatthew G Knepley     }
454188ed4aceSMatthew G Knepley     if (gdof < 0) {
45426636e97aSMatthew G Knepley       for (d = 0; d < gsize; ++d, ++l) {
454388ed4aceSMatthew G Knepley         PetscInt offset = -(goff+1) + d, r;
454488ed4aceSMatthew G Knepley 
454505376888SMatthew G. Knepley         ierr = PetscFindInt(offset,size+1,ranges,&r);CHKERRQ(ierr);
454631d3f06eSJed Brown         if (r < 0) r = -(r+2);
454705376888SMatthew 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);
454888ed4aceSMatthew G Knepley         remote[l].rank  = r;
454988ed4aceSMatthew G Knepley         remote[l].index = offset - ranges[r];
455088ed4aceSMatthew G Knepley       }
455188ed4aceSMatthew G Knepley     } else {
45526636e97aSMatthew G Knepley       for (d = 0; d < gsize; ++d, ++l) {
455388ed4aceSMatthew G Knepley         remote[l].rank  = rank;
455488ed4aceSMatthew G Knepley         remote[l].index = goff+d - ranges[rank];
455588ed4aceSMatthew G Knepley       }
455688ed4aceSMatthew G Knepley     }
455788ed4aceSMatthew G Knepley   }
45586636e97aSMatthew G Knepley   if (l != nleaves) SETERRQ2(comm, PETSC_ERR_PLIB, "Iteration error, l %d != nleaves %d", l, nleaves);
455988ed4aceSMatthew G Knepley   ierr = PetscLayoutDestroy(&layout);CHKERRQ(ierr);
45601bb6d2a8SBarry Smith   ierr = PetscSFSetGraph(dm->sectionSF, nroots, nleaves, local, PETSC_OWN_POINTER, remote, PETSC_OWN_POINTER);CHKERRQ(ierr);
456188ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
456288ed4aceSMatthew G Knepley }
4563af122d2aSMatthew G Knepley 
4564b21d0597SMatthew G Knepley /*@
4565b21d0597SMatthew G Knepley   DMGetPointSF - Get the PetscSF encoding the parallel section point overlap for the DM.
4566b21d0597SMatthew G Knepley 
4567b21d0597SMatthew G Knepley   Input Parameter:
4568b21d0597SMatthew G Knepley . dm - The DM
4569b21d0597SMatthew G Knepley 
4570b21d0597SMatthew G Knepley   Output Parameter:
4571b21d0597SMatthew G Knepley . sf - The PetscSF
4572b21d0597SMatthew G Knepley 
4573b21d0597SMatthew G Knepley   Level: intermediate
4574b21d0597SMatthew G Knepley 
4575b21d0597SMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSF.
4576b21d0597SMatthew G Knepley 
45771bb6d2a8SBarry Smith .seealso: DMSetPointSF(), DMGetSectionSF(), DMSetSectionSF(), DMCreateSectionSF()
4578b21d0597SMatthew G Knepley @*/
45790adebc6cSBarry Smith PetscErrorCode DMGetPointSF(DM dm, PetscSF *sf)
45800adebc6cSBarry Smith {
4581b21d0597SMatthew G Knepley   PetscFunctionBegin;
4582b21d0597SMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4583b21d0597SMatthew G Knepley   PetscValidPointer(sf, 2);
4584b21d0597SMatthew G Knepley   *sf = dm->sf;
4585b21d0597SMatthew G Knepley   PetscFunctionReturn(0);
4586b21d0597SMatthew G Knepley }
4587b21d0597SMatthew G Knepley 
4588057b4bcdSMatthew G Knepley /*@
4589057b4bcdSMatthew G Knepley   DMSetPointSF - Set the PetscSF encoding the parallel section point overlap for the DM.
4590057b4bcdSMatthew G Knepley 
4591057b4bcdSMatthew G Knepley   Input Parameters:
4592057b4bcdSMatthew G Knepley + dm - The DM
4593057b4bcdSMatthew G Knepley - sf - The PetscSF
4594057b4bcdSMatthew G Knepley 
4595057b4bcdSMatthew G Knepley   Level: intermediate
4596057b4bcdSMatthew G Knepley 
45971bb6d2a8SBarry Smith .seealso: DMGetPointSF(), DMGetSectionSF(), DMSetSectionSF(), DMCreateSectionSF()
4598057b4bcdSMatthew G Knepley @*/
45990adebc6cSBarry Smith PetscErrorCode DMSetPointSF(DM dm, PetscSF sf)
46000adebc6cSBarry Smith {
4601057b4bcdSMatthew G Knepley   PetscErrorCode ierr;
4602057b4bcdSMatthew G Knepley 
4603057b4bcdSMatthew G Knepley   PetscFunctionBegin;
4604057b4bcdSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4605b9d85ea2SLisandro Dalcin   if (sf) PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
4606057b4bcdSMatthew G Knepley   ierr = PetscObjectReference((PetscObject) sf);CHKERRQ(ierr);
460733907cc2SStefano Zampini   ierr = PetscSFDestroy(&dm->sf);CHKERRQ(ierr);
4608057b4bcdSMatthew G Knepley   dm->sf = sf;
4609057b4bcdSMatthew G Knepley   PetscFunctionReturn(0);
4610057b4bcdSMatthew G Knepley }
4611057b4bcdSMatthew G Knepley 
461234aa8a36SMatthew G. Knepley static PetscErrorCode DMSetDefaultAdjacency_Private(DM dm, PetscInt f, PetscObject disc)
461334aa8a36SMatthew G. Knepley {
461434aa8a36SMatthew G. Knepley   PetscClassId   id;
461534aa8a36SMatthew G. Knepley   PetscErrorCode ierr;
461634aa8a36SMatthew G. Knepley 
461734aa8a36SMatthew G. Knepley   PetscFunctionBegin;
461834aa8a36SMatthew G. Knepley   ierr = PetscObjectGetClassId(disc, &id);CHKERRQ(ierr);
461934aa8a36SMatthew G. Knepley   if (id == PETSCFE_CLASSID) {
462034aa8a36SMatthew G. Knepley     ierr = DMSetAdjacency(dm, f, PETSC_FALSE, PETSC_TRUE);CHKERRQ(ierr);
462134aa8a36SMatthew G. Knepley   } else if (id == PETSCFV_CLASSID) {
462234aa8a36SMatthew G. Knepley     ierr = DMSetAdjacency(dm, f, PETSC_TRUE, PETSC_FALSE);CHKERRQ(ierr);
462317c1d62eSMatthew G. Knepley   } else {
462417c1d62eSMatthew G. Knepley     ierr = DMSetAdjacency(dm, f, PETSC_FALSE, PETSC_TRUE);CHKERRQ(ierr);
462534aa8a36SMatthew G. Knepley   }
462634aa8a36SMatthew G. Knepley   PetscFunctionReturn(0);
462734aa8a36SMatthew G. Knepley }
462834aa8a36SMatthew G. Knepley 
462944a7f3ddSMatthew G. Knepley static PetscErrorCode DMFieldEnlarge_Static(DM dm, PetscInt NfNew)
463044a7f3ddSMatthew G. Knepley {
463144a7f3ddSMatthew G. Knepley   RegionField   *tmpr;
463244a7f3ddSMatthew G. Knepley   PetscInt       Nf = dm->Nf, f;
463344a7f3ddSMatthew G. Knepley   PetscErrorCode ierr;
463444a7f3ddSMatthew G. Knepley 
463544a7f3ddSMatthew G. Knepley   PetscFunctionBegin;
463644a7f3ddSMatthew G. Knepley   if (Nf >= NfNew) PetscFunctionReturn(0);
463744a7f3ddSMatthew G. Knepley   ierr = PetscMalloc1(NfNew, &tmpr);CHKERRQ(ierr);
463844a7f3ddSMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpr[f] = dm->fields[f];
463944a7f3ddSMatthew G. Knepley   for (f = Nf; f < NfNew; ++f) {tmpr[f].disc = NULL; tmpr[f].label = NULL;}
464044a7f3ddSMatthew G. Knepley   ierr = PetscFree(dm->fields);CHKERRQ(ierr);
464144a7f3ddSMatthew G. Knepley   dm->Nf     = NfNew;
464244a7f3ddSMatthew G. Knepley   dm->fields = tmpr;
464344a7f3ddSMatthew G. Knepley   PetscFunctionReturn(0);
464444a7f3ddSMatthew G. Knepley }
464544a7f3ddSMatthew G. Knepley 
464644a7f3ddSMatthew G. Knepley /*@
464744a7f3ddSMatthew G. Knepley   DMClearFields - Remove all fields from the DM
464844a7f3ddSMatthew G. Knepley 
4649d083f849SBarry Smith   Logically collective on dm
465044a7f3ddSMatthew G. Knepley 
465144a7f3ddSMatthew G. Knepley   Input Parameter:
465244a7f3ddSMatthew G. Knepley . dm - The DM
465344a7f3ddSMatthew G. Knepley 
465444a7f3ddSMatthew G. Knepley   Level: intermediate
465544a7f3ddSMatthew G. Knepley 
465644a7f3ddSMatthew G. Knepley .seealso: DMGetNumFields(), DMSetNumFields(), DMSetField()
465744a7f3ddSMatthew G. Knepley @*/
465844a7f3ddSMatthew G. Knepley PetscErrorCode DMClearFields(DM dm)
465944a7f3ddSMatthew G. Knepley {
466044a7f3ddSMatthew G. Knepley   PetscInt       f;
466144a7f3ddSMatthew G. Knepley   PetscErrorCode ierr;
466244a7f3ddSMatthew G. Knepley 
466344a7f3ddSMatthew G. Knepley   PetscFunctionBegin;
466444a7f3ddSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
466544a7f3ddSMatthew G. Knepley   for (f = 0; f < dm->Nf; ++f) {
466644a7f3ddSMatthew G. Knepley     ierr = PetscObjectDestroy(&dm->fields[f].disc);CHKERRQ(ierr);
466744a7f3ddSMatthew G. Knepley     ierr = DMLabelDestroy(&dm->fields[f].label);CHKERRQ(ierr);
466844a7f3ddSMatthew G. Knepley   }
466944a7f3ddSMatthew G. Knepley   ierr = PetscFree(dm->fields);CHKERRQ(ierr);
467044a7f3ddSMatthew G. Knepley   dm->fields = NULL;
467144a7f3ddSMatthew G. Knepley   dm->Nf     = 0;
467244a7f3ddSMatthew G. Knepley   PetscFunctionReturn(0);
467344a7f3ddSMatthew G. Knepley }
467444a7f3ddSMatthew G. Knepley 
4675689b5837SMatthew G. Knepley /*@
4676689b5837SMatthew G. Knepley   DMGetNumFields - Get the number of fields in the DM
4677689b5837SMatthew G. Knepley 
4678689b5837SMatthew G. Knepley   Not collective
4679689b5837SMatthew G. Knepley 
4680689b5837SMatthew G. Knepley   Input Parameter:
4681689b5837SMatthew G. Knepley . dm - The DM
4682689b5837SMatthew G. Knepley 
4683689b5837SMatthew G. Knepley   Output Parameter:
4684689b5837SMatthew G. Knepley . Nf - The number of fields
4685689b5837SMatthew G. Knepley 
4686689b5837SMatthew G. Knepley   Level: intermediate
4687689b5837SMatthew G. Knepley 
4688689b5837SMatthew G. Knepley .seealso: DMSetNumFields(), DMSetField()
4689689b5837SMatthew G. Knepley @*/
46900f21e855SMatthew G. Knepley PetscErrorCode DMGetNumFields(DM dm, PetscInt *numFields)
46910f21e855SMatthew G. Knepley {
46920f21e855SMatthew G. Knepley   PetscFunctionBegin;
46930f21e855SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4694534a8f05SLisandro Dalcin   PetscValidIntPointer(numFields, 2);
469544a7f3ddSMatthew G. Knepley   *numFields = dm->Nf;
4696af122d2aSMatthew G Knepley   PetscFunctionReturn(0);
4697af122d2aSMatthew G Knepley }
4698af122d2aSMatthew G Knepley 
4699689b5837SMatthew G. Knepley /*@
4700689b5837SMatthew G. Knepley   DMSetNumFields - Set the number of fields in the DM
4701689b5837SMatthew G. Knepley 
4702d083f849SBarry Smith   Logically collective on dm
4703689b5837SMatthew G. Knepley 
4704689b5837SMatthew G. Knepley   Input Parameters:
4705689b5837SMatthew G. Knepley + dm - The DM
4706689b5837SMatthew G. Knepley - Nf - The number of fields
4707689b5837SMatthew G. Knepley 
4708689b5837SMatthew G. Knepley   Level: intermediate
4709689b5837SMatthew G. Knepley 
4710689b5837SMatthew G. Knepley .seealso: DMGetNumFields(), DMSetField()
4711689b5837SMatthew G. Knepley @*/
4712af122d2aSMatthew G Knepley PetscErrorCode DMSetNumFields(DM dm, PetscInt numFields)
4713af122d2aSMatthew G Knepley {
47140f21e855SMatthew G. Knepley   PetscInt       Nf, f;
4715af122d2aSMatthew G Knepley   PetscErrorCode ierr;
4716af122d2aSMatthew G Knepley 
4717af122d2aSMatthew G Knepley   PetscFunctionBegin;
4718af122d2aSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
471944a7f3ddSMatthew G. Knepley   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
47200f21e855SMatthew G. Knepley   for (f = Nf; f < numFields; ++f) {
47210f21e855SMatthew G. Knepley     PetscContainer obj;
47220f21e855SMatthew G. Knepley 
47230f21e855SMatthew G. Knepley     ierr = PetscContainerCreate(PetscObjectComm((PetscObject) dm), &obj);CHKERRQ(ierr);
472444a7f3ddSMatthew G. Knepley     ierr = DMAddField(dm, NULL, (PetscObject) obj);CHKERRQ(ierr);
47250f21e855SMatthew G. Knepley     ierr = PetscContainerDestroy(&obj);CHKERRQ(ierr);
4726af122d2aSMatthew G Knepley   }
4727af122d2aSMatthew G Knepley   PetscFunctionReturn(0);
4728af122d2aSMatthew G Knepley }
4729af122d2aSMatthew G Knepley 
4730c1929be8SMatthew G. Knepley /*@
4731c1929be8SMatthew G. Knepley   DMGetField - Return the discretization object for a given DM field
4732c1929be8SMatthew G. Knepley 
4733c1929be8SMatthew G. Knepley   Not collective
4734c1929be8SMatthew G. Knepley 
4735c1929be8SMatthew G. Knepley   Input Parameters:
4736c1929be8SMatthew G. Knepley + dm - The DM
4737c1929be8SMatthew G. Knepley - f  - The field number
4738c1929be8SMatthew G. Knepley 
473944a7f3ddSMatthew G. Knepley   Output Parameters:
474044a7f3ddSMatthew G. Knepley + label - The label indicating the support of the field, or NULL for the entire mesh
474144a7f3ddSMatthew G. Knepley - field - The discretization object
4742c1929be8SMatthew G. Knepley 
474344a7f3ddSMatthew G. Knepley   Level: intermediate
4744c1929be8SMatthew G. Knepley 
474544a7f3ddSMatthew G. Knepley .seealso: DMAddField(), DMSetField()
4746c1929be8SMatthew G. Knepley @*/
474744a7f3ddSMatthew G. Knepley PetscErrorCode DMGetField(DM dm, PetscInt f, DMLabel *label, PetscObject *field)
4748af122d2aSMatthew G Knepley {
4749af122d2aSMatthew G Knepley   PetscFunctionBegin;
4750af122d2aSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
475144a7f3ddSMatthew G. Knepley   PetscValidPointer(field, 3);
475244a7f3ddSMatthew G. Knepley   if ((f < 0) || (f >= dm->Nf)) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, dm->Nf);
475344a7f3ddSMatthew G. Knepley   if (label) *label = dm->fields[f].label;
475444a7f3ddSMatthew G. Knepley   if (field) *field = dm->fields[f].disc;
4755decb47aaSMatthew G. Knepley   PetscFunctionReturn(0);
4756decb47aaSMatthew G. Knepley }
4757decb47aaSMatthew G. Knepley 
4758083401c6SMatthew G. Knepley /* Does not clear the DS */
4759083401c6SMatthew G. Knepley PetscErrorCode DMSetField_Internal(DM dm, PetscInt f, DMLabel label, PetscObject field)
4760083401c6SMatthew G. Knepley {
4761083401c6SMatthew G. Knepley   PetscErrorCode ierr;
4762083401c6SMatthew G. Knepley 
4763083401c6SMatthew G. Knepley   PetscFunctionBegin;
4764083401c6SMatthew G. Knepley   ierr = DMFieldEnlarge_Static(dm, f+1);CHKERRQ(ierr);
4765083401c6SMatthew G. Knepley   ierr = DMLabelDestroy(&dm->fields[f].label);CHKERRQ(ierr);
4766083401c6SMatthew G. Knepley   ierr = PetscObjectDestroy(&dm->fields[f].disc);CHKERRQ(ierr);
4767083401c6SMatthew G. Knepley   dm->fields[f].label = label;
4768083401c6SMatthew G. Knepley   dm->fields[f].disc  = field;
4769083401c6SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr);
4770083401c6SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) field);CHKERRQ(ierr);
4771083401c6SMatthew G. Knepley   PetscFunctionReturn(0);
4772083401c6SMatthew G. Knepley }
4773083401c6SMatthew G. Knepley 
4774c1929be8SMatthew G. Knepley /*@
4775c1929be8SMatthew G. Knepley   DMSetField - Set the discretization object for a given DM field
4776c1929be8SMatthew G. Knepley 
4777d083f849SBarry Smith   Logically collective on dm
4778c1929be8SMatthew G. Knepley 
4779c1929be8SMatthew G. Knepley   Input Parameters:
4780c1929be8SMatthew G. Knepley + dm    - The DM
4781c1929be8SMatthew G. Knepley . f     - The field number
478244a7f3ddSMatthew G. Knepley . label - The label indicating the support of the field, or NULL for the entire mesh
4783c1929be8SMatthew G. Knepley - field - The discretization object
4784c1929be8SMatthew G. Knepley 
478544a7f3ddSMatthew G. Knepley   Level: intermediate
4786c1929be8SMatthew G. Knepley 
478744a7f3ddSMatthew G. Knepley .seealso: DMAddField(), DMGetField()
4788c1929be8SMatthew G. Knepley @*/
478944a7f3ddSMatthew G. Knepley PetscErrorCode DMSetField(DM dm, PetscInt f, DMLabel label, PetscObject field)
4790decb47aaSMatthew G. Knepley {
4791decb47aaSMatthew G. Knepley   PetscErrorCode ierr;
4792decb47aaSMatthew G. Knepley 
4793decb47aaSMatthew G. Knepley   PetscFunctionBegin;
4794decb47aaSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4795e5e52638SMatthew G. Knepley   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 3);
479644a7f3ddSMatthew G. Knepley   PetscValidHeader(field, 4);
4797e5e52638SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
4798083401c6SMatthew G. Knepley   ierr = DMSetField_Internal(dm, f, label, field);CHKERRQ(ierr);
479934aa8a36SMatthew G. Knepley   ierr = DMSetDefaultAdjacency_Private(dm, f, field);CHKERRQ(ierr);
48002df9ee95SMatthew G. Knepley   ierr = DMClearDS(dm);CHKERRQ(ierr);
480144a7f3ddSMatthew G. Knepley   PetscFunctionReturn(0);
480244a7f3ddSMatthew G. Knepley }
480344a7f3ddSMatthew G. Knepley 
480444a7f3ddSMatthew G. Knepley /*@
480544a7f3ddSMatthew G. Knepley   DMAddField - Add the discretization object for the given DM field
480644a7f3ddSMatthew G. Knepley 
4807d083f849SBarry Smith   Logically collective on dm
480844a7f3ddSMatthew G. Knepley 
480944a7f3ddSMatthew G. Knepley   Input Parameters:
481044a7f3ddSMatthew G. Knepley + dm    - The DM
481144a7f3ddSMatthew G. Knepley . label - The label indicating the support of the field, or NULL for the entire mesh
481244a7f3ddSMatthew G. Knepley - field - The discretization object
481344a7f3ddSMatthew G. Knepley 
481444a7f3ddSMatthew G. Knepley   Level: intermediate
481544a7f3ddSMatthew G. Knepley 
481644a7f3ddSMatthew G. Knepley .seealso: DMSetField(), DMGetField()
481744a7f3ddSMatthew G. Knepley @*/
481844a7f3ddSMatthew G. Knepley PetscErrorCode DMAddField(DM dm, DMLabel label, PetscObject field)
481944a7f3ddSMatthew G. Knepley {
482044a7f3ddSMatthew G. Knepley   PetscInt       Nf = dm->Nf;
482144a7f3ddSMatthew G. Knepley   PetscErrorCode ierr;
482244a7f3ddSMatthew G. Knepley 
482344a7f3ddSMatthew G. Knepley   PetscFunctionBegin;
482444a7f3ddSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
482544a7f3ddSMatthew G. Knepley   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 3);
482644a7f3ddSMatthew G. Knepley   PetscValidHeader(field, 3);
482744a7f3ddSMatthew G. Knepley   ierr = DMFieldEnlarge_Static(dm, Nf+1);CHKERRQ(ierr);
482844a7f3ddSMatthew G. Knepley   dm->fields[Nf].label = label;
482944a7f3ddSMatthew G. Knepley   dm->fields[Nf].disc  = field;
483044a7f3ddSMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr);
483144a7f3ddSMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) field);CHKERRQ(ierr);
483234aa8a36SMatthew G. Knepley   ierr = DMSetDefaultAdjacency_Private(dm, Nf, field);CHKERRQ(ierr);
48332df9ee95SMatthew G. Knepley   ierr = DMClearDS(dm);CHKERRQ(ierr);
4834af122d2aSMatthew G Knepley   PetscFunctionReturn(0);
4835af122d2aSMatthew G Knepley }
48366636e97aSMatthew G Knepley 
4837e5e52638SMatthew G. Knepley /*@
4838e5e52638SMatthew G. Knepley   DMCopyFields - Copy the discretizations for the DM into another DM
4839e5e52638SMatthew G. Knepley 
4840d083f849SBarry Smith   Collective on dm
4841e5e52638SMatthew G. Knepley 
4842e5e52638SMatthew G. Knepley   Input Parameter:
4843e5e52638SMatthew G. Knepley . dm - The DM
4844e5e52638SMatthew G. Knepley 
4845e5e52638SMatthew G. Knepley   Output Parameter:
4846e5e52638SMatthew G. Knepley . newdm - The DM
4847e5e52638SMatthew G. Knepley 
4848e5e52638SMatthew G. Knepley   Level: advanced
4849e5e52638SMatthew G. Knepley 
4850e5e52638SMatthew G. Knepley .seealso: DMGetField(), DMSetField(), DMAddField(), DMCopyDS(), DMGetDS(), DMGetCellDS()
4851e5e52638SMatthew G. Knepley @*/
4852e5e52638SMatthew G. Knepley PetscErrorCode DMCopyFields(DM dm, DM newdm)
4853e5e52638SMatthew G. Knepley {
4854e5e52638SMatthew G. Knepley   PetscInt       Nf, f;
4855e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
4856e5e52638SMatthew G. Knepley 
4857e5e52638SMatthew G. Knepley   PetscFunctionBegin;
4858e5e52638SMatthew G. Knepley   if (dm == newdm) PetscFunctionReturn(0);
4859e5e52638SMatthew G. Knepley   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
4860e5e52638SMatthew G. Knepley   ierr = DMClearFields(newdm);CHKERRQ(ierr);
4861e5e52638SMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
4862e5e52638SMatthew G. Knepley     DMLabel     label;
4863e5e52638SMatthew G. Knepley     PetscObject field;
486434aa8a36SMatthew G. Knepley     PetscBool   useCone, useClosure;
4865e5e52638SMatthew G. Knepley 
4866e5e52638SMatthew G. Knepley     ierr = DMGetField(dm, f, &label, &field);CHKERRQ(ierr);
4867e5e52638SMatthew G. Knepley     ierr = DMSetField(newdm, f, label, field);CHKERRQ(ierr);
486834aa8a36SMatthew G. Knepley     ierr = DMGetAdjacency(dm, f, &useCone, &useClosure);CHKERRQ(ierr);
486934aa8a36SMatthew G. Knepley     ierr = DMSetAdjacency(newdm, f, useCone, useClosure);CHKERRQ(ierr);
487034aa8a36SMatthew G. Knepley   }
487134aa8a36SMatthew G. Knepley   PetscFunctionReturn(0);
487234aa8a36SMatthew G. Knepley }
487334aa8a36SMatthew G. Knepley 
487434aa8a36SMatthew G. Knepley /*@
487534aa8a36SMatthew G. Knepley   DMGetAdjacency - Returns the flags for determining variable influence
487634aa8a36SMatthew G. Knepley 
487734aa8a36SMatthew G. Knepley   Not collective
487834aa8a36SMatthew G. Knepley 
487934aa8a36SMatthew G. Knepley   Input Parameters:
488034aa8a36SMatthew G. Knepley + dm - The DM object
488134aa8a36SMatthew G. Knepley - f  - The field number, or PETSC_DEFAULT for the default adjacency
488234aa8a36SMatthew G. Knepley 
488334aa8a36SMatthew G. Knepley   Output Parameter:
488434aa8a36SMatthew G. Knepley + useCone    - Flag for variable influence starting with the cone operation
488534aa8a36SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
488634aa8a36SMatthew G. Knepley 
488734aa8a36SMatthew G. Knepley   Notes:
488834aa8a36SMatthew G. Knepley $     FEM:   Two points p and q are adjacent if q \in closure(star(p)),   useCone = PETSC_FALSE, useClosure = PETSC_TRUE
488934aa8a36SMatthew G. Knepley $     FVM:   Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE,  useClosure = PETSC_FALSE
489034aa8a36SMatthew G. Knepley $     FVM++: Two points p and q are adjacent if q \in star(closure(p)),   useCone = PETSC_TRUE,  useClosure = PETSC_TRUE
4891979e053dSMatthew G. Knepley   Further explanation can be found in the User's Manual Section on the Influence of Variables on One Another.
489234aa8a36SMatthew G. Knepley 
489334aa8a36SMatthew G. Knepley   Level: developer
489434aa8a36SMatthew G. Knepley 
489534aa8a36SMatthew G. Knepley .seealso: DMSetAdjacency(), DMGetField(), DMSetField()
489634aa8a36SMatthew G. Knepley @*/
489734aa8a36SMatthew G. Knepley PetscErrorCode DMGetAdjacency(DM dm, PetscInt f, PetscBool *useCone, PetscBool *useClosure)
489834aa8a36SMatthew G. Knepley {
489934aa8a36SMatthew G. Knepley   PetscFunctionBegin;
490034aa8a36SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4901534a8f05SLisandro Dalcin   if (useCone)    PetscValidBoolPointer(useCone, 3);
4902534a8f05SLisandro Dalcin   if (useClosure) PetscValidBoolPointer(useClosure, 4);
490334aa8a36SMatthew G. Knepley   if (f < 0) {
490434aa8a36SMatthew G. Knepley     if (useCone)    *useCone    = dm->adjacency[0];
490534aa8a36SMatthew G. Knepley     if (useClosure) *useClosure = dm->adjacency[1];
490634aa8a36SMatthew G. Knepley   } else {
490734aa8a36SMatthew G. Knepley     PetscInt       Nf;
490834aa8a36SMatthew G. Knepley     PetscErrorCode ierr;
490934aa8a36SMatthew G. Knepley 
491034aa8a36SMatthew G. Knepley     ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
491134aa8a36SMatthew G. Knepley     if (f >= Nf) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, Nf);
491234aa8a36SMatthew G. Knepley     if (useCone)    *useCone    = dm->fields[f].adjacency[0];
491334aa8a36SMatthew G. Knepley     if (useClosure) *useClosure = dm->fields[f].adjacency[1];
491434aa8a36SMatthew G. Knepley   }
491534aa8a36SMatthew G. Knepley   PetscFunctionReturn(0);
491634aa8a36SMatthew G. Knepley }
491734aa8a36SMatthew G. Knepley 
491834aa8a36SMatthew G. Knepley /*@
491934aa8a36SMatthew G. Knepley   DMSetAdjacency - Set the flags for determining variable influence
492034aa8a36SMatthew G. Knepley 
492134aa8a36SMatthew G. Knepley   Not collective
492234aa8a36SMatthew G. Knepley 
492334aa8a36SMatthew G. Knepley   Input Parameters:
492434aa8a36SMatthew G. Knepley + dm         - The DM object
492534aa8a36SMatthew G. Knepley . f          - The field number
492634aa8a36SMatthew G. Knepley . useCone    - Flag for variable influence starting with the cone operation
492734aa8a36SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
492834aa8a36SMatthew G. Knepley 
492934aa8a36SMatthew G. Knepley   Notes:
493034aa8a36SMatthew G. Knepley $     FEM:   Two points p and q are adjacent if q \in closure(star(p)),   useCone = PETSC_FALSE, useClosure = PETSC_TRUE
493134aa8a36SMatthew G. Knepley $     FVM:   Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE,  useClosure = PETSC_FALSE
493234aa8a36SMatthew G. Knepley $     FVM++: Two points p and q are adjacent if q \in star(closure(p)),   useCone = PETSC_TRUE,  useClosure = PETSC_TRUE
4933979e053dSMatthew G. Knepley   Further explanation can be found in the User's Manual Section on the Influence of Variables on One Another.
493434aa8a36SMatthew G. Knepley 
493534aa8a36SMatthew G. Knepley   Level: developer
493634aa8a36SMatthew G. Knepley 
493734aa8a36SMatthew G. Knepley .seealso: DMGetAdjacency(), DMGetField(), DMSetField()
493834aa8a36SMatthew G. Knepley @*/
493934aa8a36SMatthew G. Knepley PetscErrorCode DMSetAdjacency(DM dm, PetscInt f, PetscBool useCone, PetscBool useClosure)
494034aa8a36SMatthew G. Knepley {
494134aa8a36SMatthew G. Knepley   PetscFunctionBegin;
494234aa8a36SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
494334aa8a36SMatthew G. Knepley   if (f < 0) {
494434aa8a36SMatthew G. Knepley     dm->adjacency[0] = useCone;
494534aa8a36SMatthew G. Knepley     dm->adjacency[1] = useClosure;
494634aa8a36SMatthew G. Knepley   } else {
494734aa8a36SMatthew G. Knepley     PetscInt       Nf;
494834aa8a36SMatthew G. Knepley     PetscErrorCode ierr;
494934aa8a36SMatthew G. Knepley 
495034aa8a36SMatthew G. Knepley     ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
495134aa8a36SMatthew G. Knepley     if (f >= Nf) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, Nf);
495234aa8a36SMatthew G. Knepley     dm->fields[f].adjacency[0] = useCone;
495334aa8a36SMatthew G. Knepley     dm->fields[f].adjacency[1] = useClosure;
4954e5e52638SMatthew G. Knepley   }
4955e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
4956e5e52638SMatthew G. Knepley }
4957e5e52638SMatthew G. Knepley 
4958b0441da4SMatthew G. Knepley /*@
4959b0441da4SMatthew G. Knepley   DMGetBasicAdjacency - Returns the flags for determining variable influence, using either the default or field 0 if it is defined
4960b0441da4SMatthew G. Knepley 
4961b0441da4SMatthew G. Knepley   Not collective
4962b0441da4SMatthew G. Knepley 
4963b0441da4SMatthew G. Knepley   Input Parameters:
4964b0441da4SMatthew G. Knepley . dm - The DM object
4965b0441da4SMatthew G. Knepley 
4966b0441da4SMatthew G. Knepley   Output Parameter:
4967b0441da4SMatthew G. Knepley + useCone    - Flag for variable influence starting with the cone operation
4968b0441da4SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
4969b0441da4SMatthew G. Knepley 
4970b0441da4SMatthew G. Knepley   Notes:
4971b0441da4SMatthew G. Knepley $     FEM:   Two points p and q are adjacent if q \in closure(star(p)),   useCone = PETSC_FALSE, useClosure = PETSC_TRUE
4972b0441da4SMatthew G. Knepley $     FVM:   Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE,  useClosure = PETSC_FALSE
4973b0441da4SMatthew G. Knepley $     FVM++: Two points p and q are adjacent if q \in star(closure(p)),   useCone = PETSC_TRUE,  useClosure = PETSC_TRUE
4974b0441da4SMatthew G. Knepley 
4975b0441da4SMatthew G. Knepley   Level: developer
4976b0441da4SMatthew G. Knepley 
4977b0441da4SMatthew G. Knepley .seealso: DMSetBasicAdjacency(), DMGetField(), DMSetField()
4978b0441da4SMatthew G. Knepley @*/
4979b0441da4SMatthew G. Knepley PetscErrorCode DMGetBasicAdjacency(DM dm, PetscBool *useCone, PetscBool *useClosure)
4980b0441da4SMatthew G. Knepley {
4981b0441da4SMatthew G. Knepley   PetscInt       Nf;
4982b0441da4SMatthew G. Knepley   PetscErrorCode ierr;
4983b0441da4SMatthew G. Knepley 
4984b0441da4SMatthew G. Knepley   PetscFunctionBegin;
4985b0441da4SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4986534a8f05SLisandro Dalcin   if (useCone)    PetscValidBoolPointer(useCone, 3);
4987534a8f05SLisandro Dalcin   if (useClosure) PetscValidBoolPointer(useClosure, 4);
4988b0441da4SMatthew G. Knepley   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
4989b0441da4SMatthew G. Knepley   if (!Nf) {
4990b0441da4SMatthew G. Knepley     ierr = DMGetAdjacency(dm, PETSC_DEFAULT, useCone, useClosure);CHKERRQ(ierr);
4991b0441da4SMatthew G. Knepley   } else {
4992b0441da4SMatthew G. Knepley     ierr = DMGetAdjacency(dm, 0, useCone, useClosure);CHKERRQ(ierr);
4993b0441da4SMatthew G. Knepley   }
4994b0441da4SMatthew G. Knepley   PetscFunctionReturn(0);
4995b0441da4SMatthew G. Knepley }
4996b0441da4SMatthew G. Knepley 
4997b0441da4SMatthew G. Knepley /*@
4998b0441da4SMatthew G. Knepley   DMSetBasicAdjacency - Set the flags for determining variable influence, using either the default or field 0 if it is defined
4999b0441da4SMatthew G. Knepley 
5000b0441da4SMatthew G. Knepley   Not collective
5001b0441da4SMatthew G. Knepley 
5002b0441da4SMatthew G. Knepley   Input Parameters:
5003b0441da4SMatthew G. Knepley + dm         - The DM object
5004b0441da4SMatthew G. Knepley . useCone    - Flag for variable influence starting with the cone operation
5005b0441da4SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
5006b0441da4SMatthew G. Knepley 
5007b0441da4SMatthew G. Knepley   Notes:
5008b0441da4SMatthew G. Knepley $     FEM:   Two points p and q are adjacent if q \in closure(star(p)),   useCone = PETSC_FALSE, useClosure = PETSC_TRUE
5009b0441da4SMatthew G. Knepley $     FVM:   Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE,  useClosure = PETSC_FALSE
5010b0441da4SMatthew G. Knepley $     FVM++: Two points p and q are adjacent if q \in star(closure(p)),   useCone = PETSC_TRUE,  useClosure = PETSC_TRUE
5011b0441da4SMatthew G. Knepley 
5012b0441da4SMatthew G. Knepley   Level: developer
5013b0441da4SMatthew G. Knepley 
5014b0441da4SMatthew G. Knepley .seealso: DMGetBasicAdjacency(), DMGetField(), DMSetField()
5015b0441da4SMatthew G. Knepley @*/
5016b0441da4SMatthew G. Knepley PetscErrorCode DMSetBasicAdjacency(DM dm, PetscBool useCone, PetscBool useClosure)
5017b0441da4SMatthew G. Knepley {
5018b0441da4SMatthew G. Knepley   PetscInt       Nf;
5019b0441da4SMatthew G. Knepley   PetscErrorCode ierr;
5020b0441da4SMatthew G. Knepley 
5021b0441da4SMatthew G. Knepley   PetscFunctionBegin;
5022b0441da4SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5023b0441da4SMatthew G. Knepley   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
5024b0441da4SMatthew G. Knepley   if (!Nf) {
5025b0441da4SMatthew G. Knepley     ierr = DMSetAdjacency(dm, PETSC_DEFAULT, useCone, useClosure);CHKERRQ(ierr);
5026b0441da4SMatthew G. Knepley   } else {
5027b0441da4SMatthew G. Knepley     ierr = DMSetAdjacency(dm, 0, useCone, useClosure);CHKERRQ(ierr);
5028e5e52638SMatthew G. Knepley   }
5029e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5030e5e52638SMatthew G. Knepley }
5031e5e52638SMatthew G. Knepley 
5032783e2ec8SMatthew G. Knepley /* Complete labels that are being used for FEM BC */
5033783e2ec8SMatthew G. Knepley static PetscErrorCode DMCompleteBoundaryLabel_Internal(DM dm, PetscDS ds, PetscInt field, PetscInt bdNum, const char labelname[])
5034783e2ec8SMatthew G. Knepley {
5035783e2ec8SMatthew G. Knepley   DMLabel        label;
5036783e2ec8SMatthew G. Knepley   PetscObject    obj;
5037783e2ec8SMatthew G. Knepley   PetscClassId   id;
5038783e2ec8SMatthew G. Knepley   PetscInt       Nbd, bd;
5039783e2ec8SMatthew G. Knepley   PetscBool      isFE      = PETSC_FALSE;
5040783e2ec8SMatthew G. Knepley   PetscBool      duplicate = PETSC_FALSE;
5041783e2ec8SMatthew G. Knepley   PetscErrorCode ierr;
5042783e2ec8SMatthew G. Knepley 
5043783e2ec8SMatthew G. Knepley   PetscFunctionBegin;
5044783e2ec8SMatthew G. Knepley   ierr = DMGetField(dm, field, NULL, &obj);CHKERRQ(ierr);
5045783e2ec8SMatthew G. Knepley   ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr);
5046783e2ec8SMatthew G. Knepley   if (id == PETSCFE_CLASSID) isFE = PETSC_TRUE;
5047783e2ec8SMatthew G. Knepley   ierr = DMGetLabel(dm, labelname, &label);CHKERRQ(ierr);
5048783e2ec8SMatthew G. Knepley   if (isFE && label) {
5049783e2ec8SMatthew G. Knepley     /* Only want to modify label once */
5050783e2ec8SMatthew G. Knepley     ierr = PetscDSGetNumBoundary(ds, &Nbd);CHKERRQ(ierr);
5051783e2ec8SMatthew G. Knepley     for (bd = 0; bd < PetscMin(Nbd, bdNum); ++bd) {
5052783e2ec8SMatthew G. Knepley       const char *lname;
5053783e2ec8SMatthew G. Knepley 
505456cf3b9cSMatthew G. Knepley       ierr = PetscDSGetBoundary(ds, bd, NULL, NULL, &lname, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL);CHKERRQ(ierr);
5055783e2ec8SMatthew G. Knepley       ierr = PetscStrcmp(lname, labelname, &duplicate);CHKERRQ(ierr);
5056783e2ec8SMatthew G. Knepley       if (duplicate) break;
5057783e2ec8SMatthew G. Knepley     }
5058783e2ec8SMatthew G. Knepley     if (!duplicate) {
5059783e2ec8SMatthew G. Knepley       DM plex;
5060783e2ec8SMatthew G. Knepley 
5061783e2ec8SMatthew G. Knepley       ierr = DMConvert(dm, DMPLEX, &plex);CHKERRQ(ierr);
5062783e2ec8SMatthew G. Knepley       if (plex) {ierr = DMPlexLabelComplete(plex, label);CHKERRQ(ierr);}
5063783e2ec8SMatthew G. Knepley       ierr = DMDestroy(&plex);CHKERRQ(ierr);
5064783e2ec8SMatthew G. Knepley     }
5065783e2ec8SMatthew G. Knepley   }
5066783e2ec8SMatthew G. Knepley   PetscFunctionReturn(0);
5067783e2ec8SMatthew G. Knepley }
5068783e2ec8SMatthew G. Knepley 
5069e5e52638SMatthew G. Knepley static PetscErrorCode DMDSEnlarge_Static(DM dm, PetscInt NdsNew)
5070e5e52638SMatthew G. Knepley {
5071e5e52638SMatthew G. Knepley   DMSpace       *tmpd;
5072e5e52638SMatthew G. Knepley   PetscInt       Nds = dm->Nds, s;
5073e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5074e5e52638SMatthew G. Knepley 
5075e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5076e5e52638SMatthew G. Knepley   if (Nds >= NdsNew) PetscFunctionReturn(0);
5077e5e52638SMatthew G. Knepley   ierr = PetscMalloc1(NdsNew, &tmpd);CHKERRQ(ierr);
5078e5e52638SMatthew G. Knepley   for (s = 0; s < Nds; ++s) tmpd[s] = dm->probs[s];
5079b3cf3223SMatthew G. Knepley   for (s = Nds; s < NdsNew; ++s) {tmpd[s].ds = NULL; tmpd[s].label = NULL; tmpd[s].fields = NULL;}
5080e5e52638SMatthew G. Knepley   ierr = PetscFree(dm->probs);CHKERRQ(ierr);
5081e5e52638SMatthew G. Knepley   dm->Nds   = NdsNew;
5082e5e52638SMatthew G. Knepley   dm->probs = tmpd;
5083e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5084e5e52638SMatthew G. Knepley }
5085e5e52638SMatthew G. Knepley 
5086e5e52638SMatthew G. Knepley /*@
5087e5e52638SMatthew G. Knepley   DMGetNumDS - Get the number of discrete systems in the DM
5088e5e52638SMatthew G. Knepley 
5089e5e52638SMatthew G. Knepley   Not collective
5090e5e52638SMatthew G. Knepley 
5091e5e52638SMatthew G. Knepley   Input Parameter:
5092e5e52638SMatthew G. Knepley . dm - The DM
5093e5e52638SMatthew G. Knepley 
5094e5e52638SMatthew G. Knepley   Output Parameter:
5095e5e52638SMatthew G. Knepley . Nds - The number of PetscDS objects
5096e5e52638SMatthew G. Knepley 
5097e5e52638SMatthew G. Knepley   Level: intermediate
5098e5e52638SMatthew G. Knepley 
5099e5e52638SMatthew G. Knepley .seealso: DMGetDS(), DMGetCellDS()
5100e5e52638SMatthew G. Knepley @*/
5101e5e52638SMatthew G. Knepley PetscErrorCode DMGetNumDS(DM dm, PetscInt *Nds)
5102e5e52638SMatthew G. Knepley {
5103e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5104e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5105534a8f05SLisandro Dalcin   PetscValidIntPointer(Nds, 2);
5106e5e52638SMatthew G. Knepley   *Nds = dm->Nds;
5107e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5108e5e52638SMatthew G. Knepley }
5109e5e52638SMatthew G. Knepley 
5110e5e52638SMatthew G. Knepley /*@
5111e5e52638SMatthew G. Knepley   DMClearDS - Remove all discrete systems from the DM
5112e5e52638SMatthew G. Knepley 
5113d083f849SBarry Smith   Logically collective on dm
5114e5e52638SMatthew G. Knepley 
5115e5e52638SMatthew G. Knepley   Input Parameter:
5116e5e52638SMatthew G. Knepley . dm - The DM
5117e5e52638SMatthew G. Knepley 
5118e5e52638SMatthew G. Knepley   Level: intermediate
5119e5e52638SMatthew G. Knepley 
5120e5e52638SMatthew G. Knepley .seealso: DMGetNumDS(), DMGetDS(), DMSetField()
5121e5e52638SMatthew G. Knepley @*/
5122e5e52638SMatthew G. Knepley PetscErrorCode DMClearDS(DM dm)
5123e5e52638SMatthew G. Knepley {
5124e5e52638SMatthew G. Knepley   PetscInt       s;
5125e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5126e5e52638SMatthew G. Knepley 
5127e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5128e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5129e5e52638SMatthew G. Knepley   for (s = 0; s < dm->Nds; ++s) {
5130e5e52638SMatthew G. Knepley     ierr = PetscDSDestroy(&dm->probs[s].ds);CHKERRQ(ierr);
5131e5e52638SMatthew G. Knepley     ierr = DMLabelDestroy(&dm->probs[s].label);CHKERRQ(ierr);
5132b3cf3223SMatthew G. Knepley     ierr = ISDestroy(&dm->probs[s].fields);CHKERRQ(ierr);
5133e5e52638SMatthew G. Knepley   }
5134e5e52638SMatthew G. Knepley   ierr = PetscFree(dm->probs);CHKERRQ(ierr);
5135e5e52638SMatthew G. Knepley   dm->probs = NULL;
5136e5e52638SMatthew G. Knepley   dm->Nds   = 0;
5137e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5138e5e52638SMatthew G. Knepley }
5139e5e52638SMatthew G. Knepley 
5140e5e52638SMatthew G. Knepley /*@
5141e5e52638SMatthew G. Knepley   DMGetDS - Get the default PetscDS
5142e5e52638SMatthew G. Knepley 
5143e5e52638SMatthew G. Knepley   Not collective
5144e5e52638SMatthew G. Knepley 
5145e5e52638SMatthew G. Knepley   Input Parameter:
5146e5e52638SMatthew G. Knepley . dm    - The DM
5147e5e52638SMatthew G. Knepley 
5148e5e52638SMatthew G. Knepley   Output Parameter:
5149e5e52638SMatthew G. Knepley . prob - The default PetscDS
5150e5e52638SMatthew G. Knepley 
5151e5e52638SMatthew G. Knepley   Level: intermediate
5152e5e52638SMatthew G. Knepley 
5153e5e52638SMatthew G. Knepley .seealso: DMGetCellDS(), DMGetRegionDS()
5154e5e52638SMatthew G. Knepley @*/
5155e5e52638SMatthew G. Knepley PetscErrorCode DMGetDS(DM dm, PetscDS *prob)
5156e5e52638SMatthew G. Knepley {
5157b0143b4dSMatthew G. Knepley   PetscErrorCode ierr;
5158b0143b4dSMatthew G. Knepley 
5159e5e52638SMatthew G. Knepley   PetscFunctionBeginHot;
5160e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5161e5e52638SMatthew G. Knepley   PetscValidPointer(prob, 2);
5162b0143b4dSMatthew G. Knepley   if (dm->Nds <= 0) {
5163b0143b4dSMatthew G. Knepley     PetscDS ds;
5164b0143b4dSMatthew G. Knepley 
5165b0143b4dSMatthew G. Knepley     ierr = PetscDSCreate(PetscObjectComm((PetscObject) dm), &ds);CHKERRQ(ierr);
5166b3cf3223SMatthew G. Knepley     ierr = DMSetRegionDS(dm, NULL, NULL, ds);CHKERRQ(ierr);
5167b0143b4dSMatthew G. Knepley     ierr = PetscDSDestroy(&ds);CHKERRQ(ierr);
5168b0143b4dSMatthew G. Knepley   }
5169b0143b4dSMatthew G. Knepley   *prob = dm->probs[0].ds;
5170e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5171e5e52638SMatthew G. Knepley }
5172e5e52638SMatthew G. Knepley 
5173e5e52638SMatthew G. Knepley /*@
5174e5e52638SMatthew G. Knepley   DMGetCellDS - Get the PetscDS defined on a given cell
5175e5e52638SMatthew G. Knepley 
5176e5e52638SMatthew G. Knepley   Not collective
5177e5e52638SMatthew G. Knepley 
5178e5e52638SMatthew G. Knepley   Input Parameters:
5179e5e52638SMatthew G. Knepley + dm    - The DM
5180e5e52638SMatthew G. Knepley - point - Cell for the DS
5181e5e52638SMatthew G. Knepley 
5182e5e52638SMatthew G. Knepley   Output Parameter:
5183e5e52638SMatthew G. Knepley . prob - The PetscDS defined on the given cell
5184e5e52638SMatthew G. Knepley 
5185e5e52638SMatthew G. Knepley   Level: developer
5186e5e52638SMatthew G. Knepley 
5187b0143b4dSMatthew G. Knepley .seealso: DMGetDS(), DMSetRegionDS()
5188e5e52638SMatthew G. Knepley @*/
5189e5e52638SMatthew G. Knepley PetscErrorCode DMGetCellDS(DM dm, PetscInt point, PetscDS *prob)
5190e5e52638SMatthew G. Knepley {
5191e5e52638SMatthew G. Knepley   PetscDS        probDef = NULL;
5192e5e52638SMatthew G. Knepley   PetscInt       s;
5193e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5194e5e52638SMatthew G. Knepley 
5195e5e52638SMatthew G. Knepley   PetscFunctionBeginHot;
5196e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5197e5e52638SMatthew G. Knepley   PetscValidPointer(prob, 3);
5198360cf244SMatthew G. Knepley   if (point < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Mesh point cannot be negative: %D", point);
5199e5e52638SMatthew G. Knepley   *prob = NULL;
5200e5e52638SMatthew G. Knepley   for (s = 0; s < dm->Nds; ++s) {
5201e5e52638SMatthew G. Knepley     PetscInt val;
5202e5e52638SMatthew G. Knepley 
5203e5e52638SMatthew G. Knepley     if (!dm->probs[s].label) {probDef = dm->probs[s].ds;}
5204e5e52638SMatthew G. Knepley     else {
5205e5e52638SMatthew G. Knepley       ierr = DMLabelGetValue(dm->probs[s].label, point, &val);CHKERRQ(ierr);
5206e5e52638SMatthew G. Knepley       if (val >= 0) {*prob = dm->probs[s].ds; break;}
5207e5e52638SMatthew G. Knepley     }
5208e5e52638SMatthew G. Knepley   }
5209e5e52638SMatthew G. Knepley   if (!*prob) *prob = probDef;
5210e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5211e5e52638SMatthew G. Knepley }
5212e5e52638SMatthew G. Knepley 
5213e5e52638SMatthew G. Knepley /*@
5214e5e52638SMatthew G. Knepley   DMGetRegionDS - Get the PetscDS for a given mesh region, defined by a DMLabel
5215e5e52638SMatthew G. Knepley 
5216e5e52638SMatthew G. Knepley   Not collective
5217e5e52638SMatthew G. Knepley 
5218e5e52638SMatthew G. Knepley   Input Parameters:
5219e5e52638SMatthew G. Knepley + dm    - The DM
5220e5e52638SMatthew G. Knepley - label - The DMLabel defining the mesh region, or NULL for the entire mesh
5221e5e52638SMatthew G. Knepley 
5222b3cf3223SMatthew G. Knepley   Output Parameters:
5223b3cf3223SMatthew G. Knepley + fields - The IS containing the DM field numbers for the fields in this DS, or NULL
5224b3cf3223SMatthew G. Knepley - prob - The PetscDS defined on the given region, or NULL
5225e5e52638SMatthew G. Knepley 
5226e5e52638SMatthew G. Knepley   Note: If the label is missing, this function returns an error
5227e5e52638SMatthew G. Knepley 
5228e5e52638SMatthew G. Knepley   Level: advanced
5229e5e52638SMatthew G. Knepley 
5230e5e52638SMatthew G. Knepley .seealso: DMGetRegionNumDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS()
5231e5e52638SMatthew G. Knepley @*/
5232b3cf3223SMatthew G. Knepley PetscErrorCode DMGetRegionDS(DM dm, DMLabel label, IS *fields, PetscDS *ds)
5233e5e52638SMatthew G. Knepley {
5234e5e52638SMatthew G. Knepley   PetscInt Nds = dm->Nds, s;
5235e5e52638SMatthew G. Knepley 
5236e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5237e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5238e5e52638SMatthew G. Knepley   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
5239b3cf3223SMatthew G. Knepley   if (fields) {PetscValidPointer(fields, 3); *fields = NULL;}
5240b3cf3223SMatthew G. Knepley   if (ds)     {PetscValidPointer(ds, 4);     *ds     = NULL;}
5241e5e52638SMatthew G. Knepley   for (s = 0; s < Nds; ++s) {
5242b3cf3223SMatthew G. Knepley     if (dm->probs[s].label == label) {
5243b3cf3223SMatthew G. Knepley       if (fields) *fields = dm->probs[s].fields;
5244b3cf3223SMatthew G. Knepley       if (ds)     *ds     = dm->probs[s].ds;
5245b3cf3223SMatthew G. Knepley       PetscFunctionReturn(0);
5246b3cf3223SMatthew G. Knepley     }
5247e5e52638SMatthew G. Knepley   }
52482df9ee95SMatthew G. Knepley   PetscFunctionReturn(0);
5249e5e52638SMatthew G. Knepley }
5250e5e52638SMatthew G. Knepley 
5251e5e52638SMatthew G. Knepley /*@
5252083401c6SMatthew G. Knepley   DMSetRegionDS - Set the PetscDS for a given mesh region, defined by a DMLabel
5253083401c6SMatthew G. Knepley 
5254083401c6SMatthew G. Knepley   Collective on dm
5255083401c6SMatthew G. Knepley 
5256083401c6SMatthew G. Knepley   Input Parameters:
5257083401c6SMatthew G. Knepley + dm     - The DM
5258083401c6SMatthew G. Knepley . label  - The DMLabel defining the mesh region, or NULL for the entire mesh
5259083401c6SMatthew G. Knepley . fields - The IS containing the DM field numbers for the fields in this DS, or NULL for all fields
5260083401c6SMatthew G. Knepley - prob   - The PetscDS defined on the given cell
5261083401c6SMatthew G. Knepley 
5262083401c6SMatthew G. Knepley   Note: If the label has a DS defined, it will be replaced. Otherwise, it will be added to the DM. If DS is replaced,
5263083401c6SMatthew G. Knepley   the fields argument is ignored.
5264083401c6SMatthew G. Knepley 
5265083401c6SMatthew G. Knepley   Level: advanced
5266083401c6SMatthew G. Knepley 
5267083401c6SMatthew G. Knepley .seealso: DMGetRegionDS(), DMSetRegionNumDS(), DMGetDS(), DMGetCellDS()
5268083401c6SMatthew G. Knepley @*/
5269083401c6SMatthew G. Knepley PetscErrorCode DMSetRegionDS(DM dm, DMLabel label, IS fields, PetscDS ds)
5270083401c6SMatthew G. Knepley {
5271083401c6SMatthew G. Knepley   PetscInt       Nds = dm->Nds, s;
5272083401c6SMatthew G. Knepley   PetscErrorCode ierr;
5273083401c6SMatthew G. Knepley 
5274083401c6SMatthew G. Knepley   PetscFunctionBegin;
5275083401c6SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5276083401c6SMatthew G. Knepley   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
5277083401c6SMatthew G. Knepley   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 3);
5278083401c6SMatthew G. Knepley   for (s = 0; s < Nds; ++s) {
5279083401c6SMatthew G. Knepley     if (dm->probs[s].label == label) {
5280083401c6SMatthew G. Knepley       ierr = PetscDSDestroy(&dm->probs[s].ds);CHKERRQ(ierr);
5281083401c6SMatthew G. Knepley       dm->probs[s].ds = ds;
5282083401c6SMatthew G. Knepley       PetscFunctionReturn(0);
5283083401c6SMatthew G. Knepley     }
5284083401c6SMatthew G. Knepley   }
5285083401c6SMatthew G. Knepley   ierr = DMDSEnlarge_Static(dm, Nds+1);CHKERRQ(ierr);
5286083401c6SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr);
5287083401c6SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) fields);CHKERRQ(ierr);
5288083401c6SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) ds);CHKERRQ(ierr);
5289083401c6SMatthew G. Knepley   if (!label) {
5290083401c6SMatthew G. Knepley     /* Put the NULL label at the front, so it is returned as the default */
5291083401c6SMatthew G. Knepley     for (s = Nds-1; s >=0; --s) dm->probs[s+1] = dm->probs[s];
5292083401c6SMatthew G. Knepley     Nds = 0;
5293083401c6SMatthew G. Knepley   }
5294083401c6SMatthew G. Knepley   dm->probs[Nds].label  = label;
5295083401c6SMatthew G. Knepley   dm->probs[Nds].fields = fields;
5296083401c6SMatthew G. Knepley   dm->probs[Nds].ds     = ds;
5297083401c6SMatthew G. Knepley   PetscFunctionReturn(0);
5298083401c6SMatthew G. Knepley }
5299083401c6SMatthew G. Knepley 
5300083401c6SMatthew G. Knepley /*@
5301e5e52638SMatthew G. Knepley   DMGetRegionNumDS - Get the PetscDS for a given mesh region, defined by the region number
5302e5e52638SMatthew G. Knepley 
5303e5e52638SMatthew G. Knepley   Not collective
5304e5e52638SMatthew G. Knepley 
5305e5e52638SMatthew G. Knepley   Input Parameters:
5306e5e52638SMatthew G. Knepley + dm  - The DM
5307e5e52638SMatthew G. Knepley - num - The region number, in [0, Nds)
5308e5e52638SMatthew G. Knepley 
5309e5e52638SMatthew G. Knepley   Output Parameters:
5310b3cf3223SMatthew G. Knepley + label  - The region label, or NULL
5311b3cf3223SMatthew G. Knepley . fields - The IS containing the DM field numbers for the fields in this DS, or NULL
5312083401c6SMatthew G. Knepley - ds     - The PetscDS defined on the given region, or NULL
5313e5e52638SMatthew G. Knepley 
5314e5e52638SMatthew G. Knepley   Level: advanced
5315e5e52638SMatthew G. Knepley 
5316e5e52638SMatthew G. Knepley .seealso: DMGetRegionDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS()
5317e5e52638SMatthew G. Knepley @*/
5318b3cf3223SMatthew G. Knepley PetscErrorCode DMGetRegionNumDS(DM dm, PetscInt num, DMLabel *label, IS *fields, PetscDS *ds)
5319e5e52638SMatthew G. Knepley {
5320e5e52638SMatthew G. Knepley   PetscInt       Nds;
5321e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5322e5e52638SMatthew G. Knepley 
5323e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5324e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5325e5e52638SMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
5326e5e52638SMatthew G. Knepley   if ((num < 0) || (num >= Nds)) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Region number %D is not in [0, %D)", num, Nds);
5327e5e52638SMatthew G. Knepley   if (label) {
5328e5e52638SMatthew G. Knepley     PetscValidPointer(label, 3);
5329e5e52638SMatthew G. Knepley     *label = dm->probs[num].label;
5330e5e52638SMatthew G. Knepley   }
5331b3cf3223SMatthew G. Knepley   if (fields) {
5332b3cf3223SMatthew G. Knepley     PetscValidPointer(fields, 4);
5333b3cf3223SMatthew G. Knepley     *fields = dm->probs[num].fields;
5334b3cf3223SMatthew G. Knepley   }
5335e5e52638SMatthew G. Knepley   if (ds) {
5336b3cf3223SMatthew G. Knepley     PetscValidPointer(ds, 5);
5337e5e52638SMatthew G. Knepley     *ds = dm->probs[num].ds;
5338e5e52638SMatthew G. Knepley   }
5339e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5340e5e52638SMatthew G. Knepley }
5341e5e52638SMatthew G. Knepley 
5342e5e52638SMatthew G. Knepley /*@
5343083401c6SMatthew G. Knepley   DMSetRegionNumDS - Set the PetscDS for a given mesh region, defined by the region number
5344e5e52638SMatthew G. Knepley 
5345083401c6SMatthew G. Knepley   Not collective
5346e5e52638SMatthew G. Knepley 
5347e5e52638SMatthew G. Knepley   Input Parameters:
5348e5e52638SMatthew G. Knepley + dm     - The DM
5349083401c6SMatthew G. Knepley . num    - The region number, in [0, Nds)
5350083401c6SMatthew G. Knepley . label  - The region label, or NULL
5351083401c6SMatthew G. Knepley . fields - The IS containing the DM field numbers for the fields in this DS, or NULL to prevent setting
5352083401c6SMatthew G. Knepley - ds     - The PetscDS defined on the given region, or NULL to prevent setting
5353e5e52638SMatthew G. Knepley 
5354e5e52638SMatthew G. Knepley   Level: advanced
5355e5e52638SMatthew G. Knepley 
5356083401c6SMatthew G. Knepley .seealso: DMGetRegionDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS()
5357e5e52638SMatthew G. Knepley @*/
5358083401c6SMatthew G. Knepley PetscErrorCode DMSetRegionNumDS(DM dm, PetscInt num, DMLabel label, IS fields, PetscDS ds)
5359e5e52638SMatthew G. Knepley {
5360083401c6SMatthew G. Knepley   PetscInt       Nds;
5361e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5362e5e52638SMatthew G. Knepley 
5363e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5364e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5365083401c6SMatthew G. Knepley   if (label) {PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 3);}
5366083401c6SMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
5367083401c6SMatthew G. Knepley   if ((num < 0) || (num >= Nds)) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Region number %D is not in [0, %D)", num, Nds);
5368e5e52638SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr);
5369083401c6SMatthew G. Knepley   ierr = DMLabelDestroy(&dm->probs[num].label);CHKERRQ(ierr);
5370083401c6SMatthew G. Knepley   dm->probs[num].label = label;
5371083401c6SMatthew G. Knepley   if (fields) {
5372083401c6SMatthew G. Knepley     PetscValidHeaderSpecific(fields, IS_CLASSID, 4);
5373b3cf3223SMatthew G. Knepley     ierr = PetscObjectReference((PetscObject) fields);CHKERRQ(ierr);
5374083401c6SMatthew G. Knepley     ierr = ISDestroy(&dm->probs[num].fields);CHKERRQ(ierr);
5375083401c6SMatthew G. Knepley     dm->probs[num].fields = fields;
5376e5e52638SMatthew G. Knepley   }
5377083401c6SMatthew G. Knepley   if (ds) {
5378083401c6SMatthew G. Knepley     PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 5);
5379083401c6SMatthew G. Knepley     ierr = PetscObjectReference((PetscObject) ds);CHKERRQ(ierr);
5380083401c6SMatthew G. Knepley     ierr = PetscDSDestroy(&dm->probs[num].ds);CHKERRQ(ierr);
5381083401c6SMatthew G. Knepley     dm->probs[num].ds = ds;
5382083401c6SMatthew G. Knepley   }
5383e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5384e5e52638SMatthew G. Knepley }
5385e5e52638SMatthew G. Knepley 
5386e5e52638SMatthew G. Knepley /*@
53871d3af9e0SMatthew G. Knepley   DMFindRegionNum - Find the region number for a given PetscDS, or -1 if it is not found.
53881d3af9e0SMatthew G. Knepley 
53891d3af9e0SMatthew G. Knepley   Not collective
53901d3af9e0SMatthew G. Knepley 
53911d3af9e0SMatthew G. Knepley   Input Parameters:
53921d3af9e0SMatthew G. Knepley + dm  - The DM
53931d3af9e0SMatthew G. Knepley - ds  - The PetscDS defined on the given region
53941d3af9e0SMatthew G. Knepley 
53951d3af9e0SMatthew G. Knepley   Output Parameter:
53961d3af9e0SMatthew G. Knepley . num - The region number, in [0, Nds), or -1 if not found
53971d3af9e0SMatthew G. Knepley 
53981d3af9e0SMatthew G. Knepley   Level: advanced
53991d3af9e0SMatthew G. Knepley 
54001d3af9e0SMatthew G. Knepley .seealso: DMGetRegionNumDS(), DMGetRegionDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS()
54011d3af9e0SMatthew G. Knepley @*/
54021d3af9e0SMatthew G. Knepley PetscErrorCode DMFindRegionNum(DM dm, PetscDS ds, PetscInt *num)
54031d3af9e0SMatthew G. Knepley {
54041d3af9e0SMatthew G. Knepley   PetscInt       Nds, n;
54051d3af9e0SMatthew G. Knepley   PetscErrorCode ierr;
54061d3af9e0SMatthew G. Knepley 
54071d3af9e0SMatthew G. Knepley   PetscFunctionBegin;
54081d3af9e0SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
54091d3af9e0SMatthew G. Knepley   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 2);
54101d3af9e0SMatthew G. Knepley   PetscValidPointer(num, 3);
54111d3af9e0SMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
54121d3af9e0SMatthew G. Knepley   for (n = 0; n < Nds; ++n) if (ds == dm->probs[n].ds) break;
54131d3af9e0SMatthew G. Knepley   if (n >= Nds) *num = -1;
54141d3af9e0SMatthew G. Knepley   else          *num = n;
54151d3af9e0SMatthew G. Knepley   PetscFunctionReturn(0);
54161d3af9e0SMatthew G. Knepley }
54171d3af9e0SMatthew G. Knepley 
54181d3af9e0SMatthew G. Knepley /*@
5419e5e52638SMatthew G. Knepley   DMCreateDS - Create the discrete systems for the DM based upon the fields added to the DM
5420e5e52638SMatthew G. Knepley 
5421d083f849SBarry Smith   Collective on dm
5422e5e52638SMatthew G. Knepley 
5423e5e52638SMatthew G. Knepley   Input Parameter:
5424e5e52638SMatthew G. Knepley . dm - The DM
5425e5e52638SMatthew G. Knepley 
5426e5e52638SMatthew G. Knepley   Note: If the label has a DS defined, it will be replaced. Otherwise, it will be added to the DM.
5427e5e52638SMatthew G. Knepley 
5428e5e52638SMatthew G. Knepley   Level: intermediate
5429e5e52638SMatthew G. Knepley 
5430e5e52638SMatthew G. Knepley .seealso: DMSetField, DMAddField(), DMGetDS(), DMGetCellDS(), DMGetRegionDS(), DMSetRegionDS()
5431e5e52638SMatthew G. Knepley @*/
5432e5e52638SMatthew G. Knepley PetscErrorCode DMCreateDS(DM dm)
5433e5e52638SMatthew G. Knepley {
5434e5e52638SMatthew G. Knepley   MPI_Comm       comm;
5435083401c6SMatthew G. Knepley   PetscDS        dsDef;
5436083401c6SMatthew G. Knepley   DMLabel       *labelSet;
5437083401c6SMatthew G. Knepley   PetscInt       dE, Nf = dm->Nf, f, s, Nl, l, Ndef;
5438e5e52638SMatthew G. Knepley   PetscBool      doSetup = PETSC_TRUE;
5439e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5440e5e52638SMatthew G. Knepley 
5441e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5442e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5443e5e52638SMatthew G. Knepley   if (!dm->fields) PetscFunctionReturn(0);
5444e5e52638SMatthew G. Knepley   ierr = PetscObjectGetComm((PetscObject) dm, &comm);CHKERRQ(ierr);
5445083401c6SMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &dE);CHKERRQ(ierr);
5446083401c6SMatthew G. Knepley   /* Determine how many regions we have */
5447083401c6SMatthew G. Knepley   ierr = PetscMalloc1(Nf, &labelSet);CHKERRQ(ierr);
5448083401c6SMatthew G. Knepley   Nl   = 0;
5449083401c6SMatthew G. Knepley   Ndef = 0;
5450083401c6SMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
5451083401c6SMatthew G. Knepley     DMLabel  label = dm->fields[f].label;
5452083401c6SMatthew G. Knepley     PetscInt l;
5453083401c6SMatthew G. Knepley 
5454083401c6SMatthew G. Knepley     if (!label) {++Ndef; continue;}
5455083401c6SMatthew G. Knepley     for (l = 0; l < Nl; ++l) if (label == labelSet[l]) break;
5456083401c6SMatthew G. Knepley     if (l < Nl) continue;
5457083401c6SMatthew G. Knepley     labelSet[Nl++] = label;
5458083401c6SMatthew G. Knepley   }
5459083401c6SMatthew G. Knepley   /* Create default DS if there are no labels to intersect with */
5460083401c6SMatthew G. Knepley   ierr = DMGetRegionDS(dm, NULL, NULL, &dsDef);CHKERRQ(ierr);
5461083401c6SMatthew G. Knepley   if (!dsDef && Ndef && !Nl) {
5462b3cf3223SMatthew G. Knepley     IS        fields;
5463b3cf3223SMatthew G. Knepley     PetscInt *fld, nf;
5464b3cf3223SMatthew G. Knepley 
5465b3cf3223SMatthew G. Knepley     for (f = 0, nf = 0; f < Nf; ++f) if (!dm->fields[f].label) ++nf;
5466083401c6SMatthew G. Knepley     if (nf) {
5467b3cf3223SMatthew G. Knepley       ierr = PetscMalloc1(nf, &fld);CHKERRQ(ierr);
5468b3cf3223SMatthew G. Knepley       for (f = 0, nf = 0; f < Nf; ++f) if (!dm->fields[f].label) fld[nf++] = f;
546988f0c812SMatthew G. Knepley       ierr = ISCreate(PETSC_COMM_SELF, &fields);CHKERRQ(ierr);
547088f0c812SMatthew G. Knepley       ierr = PetscObjectSetOptionsPrefix((PetscObject) fields, "dm_fields_");CHKERRQ(ierr);
547188f0c812SMatthew G. Knepley       ierr = ISSetType(fields, ISGENERAL);CHKERRQ(ierr);
547288f0c812SMatthew G. Knepley       ierr = ISGeneralSetIndices(fields, nf, fld, PETSC_OWN_POINTER);CHKERRQ(ierr);
547388f0c812SMatthew G. Knepley 
5474083401c6SMatthew G. Knepley       ierr = PetscDSCreate(comm, &dsDef);CHKERRQ(ierr);
5475083401c6SMatthew G. Knepley       ierr = DMSetRegionDS(dm, NULL, fields, dsDef);CHKERRQ(ierr);
5476083401c6SMatthew G. Knepley       ierr = PetscDSDestroy(&dsDef);CHKERRQ(ierr);
5477b3cf3223SMatthew G. Knepley       ierr = ISDestroy(&fields);CHKERRQ(ierr);
54782df9ee95SMatthew G. Knepley     }
5479083401c6SMatthew G. Knepley   }
5480083401c6SMatthew G. Knepley   ierr = DMGetRegionDS(dm, NULL, NULL, &dsDef);CHKERRQ(ierr);
5481083401c6SMatthew G. Knepley   if (dsDef) {ierr = PetscDSSetCoordinateDimension(dsDef, dE);CHKERRQ(ierr);}
5482083401c6SMatthew G. Knepley   /* Intersect labels with default fields */
5483083401c6SMatthew G. Knepley   if (Ndef && Nl) {
54840122748bSMatthew G. Knepley     DM              plex;
5485083401c6SMatthew G. Knepley     DMLabel         cellLabel;
5486083401c6SMatthew G. Knepley     IS              fieldIS, allcellIS, defcellIS = NULL;
5487083401c6SMatthew G. Knepley     PetscInt       *fields;
5488083401c6SMatthew G. Knepley     const PetscInt *cells;
5489083401c6SMatthew G. Knepley     PetscInt        depth, nf = 0, n, c;
54900122748bSMatthew G. Knepley 
54910122748bSMatthew G. Knepley     ierr = DMConvert(dm, DMPLEX, &plex);CHKERRQ(ierr);
54920122748bSMatthew G. Knepley     ierr = DMPlexGetDepth(plex, &depth);CHKERRQ(ierr);
5493083401c6SMatthew G. Knepley     ierr = DMGetStratumIS(plex, "dim", depth, &allcellIS);CHKERRQ(ierr);
5494083401c6SMatthew G. Knepley     if (!allcellIS) {ierr = DMGetStratumIS(plex, "depth", depth, &allcellIS);CHKERRQ(ierr);}
5495083401c6SMatthew G. Knepley     for (l = 0; l < Nl; ++l) {
5496083401c6SMatthew G. Knepley       DMLabel label = labelSet[l];
5497083401c6SMatthew G. Knepley       IS      pointIS;
5498083401c6SMatthew G. Knepley 
5499083401c6SMatthew G. Knepley       ierr = ISDestroy(&defcellIS);CHKERRQ(ierr);
5500083401c6SMatthew G. Knepley       ierr = DMLabelGetStratumIS(label, 1, &pointIS);CHKERRQ(ierr);
5501083401c6SMatthew G. Knepley       ierr = ISDifference(allcellIS, pointIS, &defcellIS);CHKERRQ(ierr);
5502083401c6SMatthew G. Knepley       ierr = ISDestroy(&pointIS);CHKERRQ(ierr);
5503083401c6SMatthew G. Knepley     }
5504083401c6SMatthew G. Knepley     ierr = ISDestroy(&allcellIS);CHKERRQ(ierr);
5505083401c6SMatthew G. Knepley 
5506083401c6SMatthew G. Knepley     ierr = DMLabelCreate(PETSC_COMM_SELF, "defaultCells", &cellLabel);CHKERRQ(ierr);
5507083401c6SMatthew G. Knepley     ierr = ISGetLocalSize(defcellIS, &n);CHKERRQ(ierr);
5508083401c6SMatthew G. Knepley     ierr = ISGetIndices(defcellIS, &cells);CHKERRQ(ierr);
5509083401c6SMatthew G. Knepley     for (c = 0; c < n; ++c) {ierr = DMLabelSetValue(cellLabel, cells[c], 1);CHKERRQ(ierr);}
5510083401c6SMatthew G. Knepley     ierr = ISRestoreIndices(defcellIS, &cells);CHKERRQ(ierr);
5511083401c6SMatthew G. Knepley     ierr = ISDestroy(&defcellIS);CHKERRQ(ierr);
5512083401c6SMatthew G. Knepley     ierr = DMPlexLabelComplete(plex, cellLabel);CHKERRQ(ierr);
5513083401c6SMatthew G. Knepley 
5514083401c6SMatthew G. Knepley     ierr = PetscMalloc1(Ndef, &fields);CHKERRQ(ierr);
5515083401c6SMatthew G. Knepley     for (f = 0; f < Nf; ++f) if (!dm->fields[f].label) fields[nf++] = f;
5516083401c6SMatthew G. Knepley     ierr = ISCreate(PETSC_COMM_SELF, &fieldIS);CHKERRQ(ierr);
5517083401c6SMatthew G. Knepley     ierr = PetscObjectSetOptionsPrefix((PetscObject) fieldIS, "dm_fields_");CHKERRQ(ierr);
5518083401c6SMatthew G. Knepley     ierr = ISSetType(fieldIS, ISGENERAL);CHKERRQ(ierr);
5519083401c6SMatthew G. Knepley     ierr = ISGeneralSetIndices(fieldIS, nf, fields, PETSC_OWN_POINTER);CHKERRQ(ierr);
5520083401c6SMatthew G. Knepley 
5521083401c6SMatthew G. Knepley     ierr = PetscDSCreate(comm, &dsDef);CHKERRQ(ierr);
5522083401c6SMatthew G. Knepley     ierr = DMSetRegionDS(dm, cellLabel, fieldIS, dsDef);CHKERRQ(ierr);
5523083401c6SMatthew G. Knepley     ierr = DMLabelDestroy(&cellLabel);CHKERRQ(ierr);
5524083401c6SMatthew G. Knepley     ierr = PetscDSSetCoordinateDimension(dsDef, dE);CHKERRQ(ierr);
5525083401c6SMatthew G. Knepley     ierr = PetscDSDestroy(&dsDef);CHKERRQ(ierr);
5526083401c6SMatthew G. Knepley     ierr = ISDestroy(&fieldIS);CHKERRQ(ierr);
55270122748bSMatthew G. Knepley     ierr = DMDestroy(&plex);CHKERRQ(ierr);
5528083401c6SMatthew G. Knepley   }
5529083401c6SMatthew G. Knepley   /* Create label DSes
5530083401c6SMatthew G. Knepley      - WE ONLY SUPPORT IDENTICAL OR DISJOINT LABELS
5531083401c6SMatthew G. Knepley   */
5532083401c6SMatthew G. Knepley   /* TODO Should check that labels are disjoint */
5533083401c6SMatthew G. Knepley   for (l = 0; l < Nl; ++l) {
5534083401c6SMatthew G. Knepley     DMLabel   label = labelSet[l];
5535083401c6SMatthew G. Knepley     PetscDS   ds;
5536083401c6SMatthew G. Knepley     IS        fields;
5537083401c6SMatthew G. Knepley     PetscInt *fld, nf;
5538083401c6SMatthew G. Knepley 
5539083401c6SMatthew G. Knepley     ierr = PetscDSCreate(comm, &ds);CHKERRQ(ierr);
5540083401c6SMatthew G. Knepley     for (f = 0, nf = 0; f < Nf; ++f) if (label == dm->fields[f].label || !dm->fields[f].label) ++nf;
5541083401c6SMatthew G. Knepley     ierr = PetscMalloc1(nf, &fld);CHKERRQ(ierr);
5542083401c6SMatthew G. Knepley     for (f = 0, nf = 0; f < Nf; ++f) if (label == dm->fields[f].label || !dm->fields[f].label) fld[nf++] = f;
5543083401c6SMatthew G. Knepley     ierr = ISCreate(PETSC_COMM_SELF, &fields);CHKERRQ(ierr);
5544083401c6SMatthew G. Knepley     ierr = PetscObjectSetOptionsPrefix((PetscObject) fields, "dm_fields_");CHKERRQ(ierr);
5545083401c6SMatthew G. Knepley     ierr = ISSetType(fields, ISGENERAL);CHKERRQ(ierr);
5546083401c6SMatthew G. Knepley     ierr = ISGeneralSetIndices(fields, nf, fld, PETSC_OWN_POINTER);CHKERRQ(ierr);
5547083401c6SMatthew G. Knepley     ierr = DMSetRegionDS(dm, label, fields, ds);CHKERRQ(ierr);
5548083401c6SMatthew G. Knepley     ierr = ISDestroy(&fields);CHKERRQ(ierr);
5549083401c6SMatthew G. Knepley     ierr = PetscDSSetCoordinateDimension(ds, dE);CHKERRQ(ierr);
5550083401c6SMatthew G. Knepley     {
5551083401c6SMatthew G. Knepley       DMPolytopeType ct;
5552083401c6SMatthew G. Knepley       PetscInt       lStart, lEnd;
5553083401c6SMatthew G. Knepley       PetscBool      isHybridLocal = PETSC_FALSE, isHybrid;
55540122748bSMatthew G. Knepley 
5555e5e52638SMatthew G. Knepley       ierr = DMLabelGetBounds(label, &lStart, &lEnd);CHKERRQ(ierr);
5556665f567fSMatthew G. Knepley       if (lStart >= 0) {
5557412e9a14SMatthew G. Knepley         ierr = DMPlexGetCellType(dm, lStart, &ct);CHKERRQ(ierr);
5558412e9a14SMatthew G. Knepley         switch (ct) {
5559412e9a14SMatthew G. Knepley           case DM_POLYTOPE_POINT_PRISM_TENSOR:
5560412e9a14SMatthew G. Knepley           case DM_POLYTOPE_SEG_PRISM_TENSOR:
5561412e9a14SMatthew G. Knepley           case DM_POLYTOPE_TRI_PRISM_TENSOR:
5562412e9a14SMatthew G. Knepley           case DM_POLYTOPE_QUAD_PRISM_TENSOR:
5563083401c6SMatthew G. Knepley             isHybridLocal = PETSC_TRUE;break;
5564083401c6SMatthew G. Knepley           default: break;
5565412e9a14SMatthew G. Knepley         }
5566665f567fSMatthew G. Knepley       }
5567083401c6SMatthew G. Knepley       ierr = MPI_Allreduce(&isHybridLocal, &isHybrid, 1, MPIU_BOOL, MPI_LOR, comm);CHKERRQ(ierr);
5568083401c6SMatthew G. Knepley       ierr = PetscDSSetHybrid(ds, isHybrid);CHKERRQ(ierr);
5569e5e52638SMatthew G. Knepley     }
5570083401c6SMatthew G. Knepley     ierr = PetscDSDestroy(&ds);CHKERRQ(ierr);
5571e5e52638SMatthew G. Knepley   }
5572083401c6SMatthew G. Knepley   ierr = PetscFree(labelSet);CHKERRQ(ierr);
5573e5e52638SMatthew G. Knepley   /* Set fields in DSes */
5574083401c6SMatthew G. Knepley   for (s = 0; s < dm->Nds; ++s) {
5575083401c6SMatthew G. Knepley     PetscDS         ds     = dm->probs[s].ds;
5576083401c6SMatthew G. Knepley     IS              fields = dm->probs[s].fields;
5577083401c6SMatthew G. Knepley     const PetscInt *fld;
5578083401c6SMatthew G. Knepley     PetscInt        nf;
5579e5e52638SMatthew G. Knepley 
5580083401c6SMatthew G. Knepley     ierr = ISGetLocalSize(fields, &nf);CHKERRQ(ierr);
5581083401c6SMatthew G. Knepley     ierr = ISGetIndices(fields, &fld);CHKERRQ(ierr);
5582083401c6SMatthew G. Knepley     for (f = 0; f < nf; ++f) {
5583083401c6SMatthew G. Knepley       PetscObject  disc  = dm->fields[fld[f]].disc;
5584083401c6SMatthew G. Knepley       PetscBool    isHybrid;
5585e5e52638SMatthew G. Knepley       PetscClassId id;
5586e5e52638SMatthew G. Knepley 
5587083401c6SMatthew G. Knepley       ierr = PetscDSGetHybrid(ds, &isHybrid);CHKERRQ(ierr);
5588083401c6SMatthew G. Knepley       /* If this is a cohesive cell, then it needs the lower dimensional discretization */
5589083401c6SMatthew G. Knepley       if (isHybrid && f < nf-1) {ierr = PetscFEGetHeightSubspace((PetscFE) disc, 1, (PetscFE *) &disc);CHKERRQ(ierr);}
5590083401c6SMatthew G. Knepley       ierr = PetscDSSetDiscretization(ds, f, disc);CHKERRQ(ierr);
5591083401c6SMatthew G. Knepley       /* We allow people to have placeholder fields and construct the Section by hand */
5592e5e52638SMatthew G. Knepley       ierr = PetscObjectGetClassId(disc, &id);CHKERRQ(ierr);
5593e5e52638SMatthew G. Knepley       if ((id != PETSCFE_CLASSID) && (id != PETSCFV_CLASSID)) doSetup = PETSC_FALSE;
5594e5e52638SMatthew G. Knepley     }
5595083401c6SMatthew G. Knepley     ierr = ISRestoreIndices(fields, &fld);CHKERRQ(ierr);
5596e5e52638SMatthew G. Knepley   }
5597e5e52638SMatthew G. Knepley   /* Setup DSes */
5598e5e52638SMatthew G. Knepley   if (doSetup) {
5599e5e52638SMatthew G. Knepley     for (s = 0; s < dm->Nds; ++s) {ierr = PetscDSSetUp(dm->probs[s].ds);CHKERRQ(ierr);}
5600e5e52638SMatthew G. Knepley   }
5601e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5602e5e52638SMatthew G. Knepley }
5603e5e52638SMatthew G. Knepley 
5604e5e52638SMatthew G. Knepley /*@
56057f96f943SMatthew G. Knepley   DMComputeExactSolution - Compute the exact solution for a given DM, using the PetscDS information.
56067f96f943SMatthew G. Knepley 
5607f2cacb80SMatthew G. Knepley   Collective on DM
5608f2cacb80SMatthew G. Knepley 
56097f96f943SMatthew G. Knepley   Input Parameters:
56107f96f943SMatthew G. Knepley + dm   - The DM
56117f96f943SMatthew G. Knepley - time - The time
56127f96f943SMatthew G. Knepley 
56137f96f943SMatthew G. Knepley   Output Parameters:
5614f2cacb80SMatthew G. Knepley + u    - The vector will be filled with exact solution values, or NULL
5615f2cacb80SMatthew G. Knepley - u_t  - The vector will be filled with the time derivative of exact solution values, or NULL
56167f96f943SMatthew G. Knepley 
56177f96f943SMatthew G. Knepley   Note: The user must call PetscDSSetExactSolution() beforehand
56187f96f943SMatthew G. Knepley 
56197f96f943SMatthew G. Knepley   Level: developer
56207f96f943SMatthew G. Knepley 
56217f96f943SMatthew G. Knepley .seealso: PetscDSSetExactSolution()
56227f96f943SMatthew G. Knepley @*/
5623f2cacb80SMatthew G. Knepley PetscErrorCode DMComputeExactSolution(DM dm, PetscReal time, Vec u, Vec u_t)
56247f96f943SMatthew G. Knepley {
56257f96f943SMatthew G. Knepley   PetscErrorCode (**exacts)(PetscInt, PetscReal, const PetscReal x[], PetscInt, PetscScalar *u, void *ctx);
56267f96f943SMatthew G. Knepley   void            **ectxs;
56277f96f943SMatthew G. Knepley   PetscInt          Nf, Nds, s;
56287f96f943SMatthew G. Knepley   PetscErrorCode    ierr;
56297f96f943SMatthew G. Knepley 
56307f96f943SMatthew G. Knepley   PetscFunctionBegin;
5631f2cacb80SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5632f2cacb80SMatthew G. Knepley   if (u)   PetscValidHeaderSpecific(u, VEC_CLASSID, 3);
5633f2cacb80SMatthew G. Knepley   if (u_t) PetscValidHeaderSpecific(u_t, VEC_CLASSID, 4);
56347f96f943SMatthew G. Knepley   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
56357f96f943SMatthew G. Knepley   ierr = PetscMalloc2(Nf, &exacts, Nf, &ectxs);CHKERRQ(ierr);
56367f96f943SMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
56377f96f943SMatthew G. Knepley   for (s = 0; s < Nds; ++s) {
56387f96f943SMatthew G. Knepley     PetscDS         ds;
56397f96f943SMatthew G. Knepley     DMLabel         label;
56407f96f943SMatthew G. Knepley     IS              fieldIS;
56417f96f943SMatthew G. Knepley     const PetscInt *fields, id = 1;
56427f96f943SMatthew G. Knepley     PetscInt        dsNf, f;
56437f96f943SMatthew G. Knepley 
56447f96f943SMatthew G. Knepley     ierr = DMGetRegionNumDS(dm, s, &label, &fieldIS, &ds);CHKERRQ(ierr);
56457f96f943SMatthew G. Knepley     ierr = PetscDSGetNumFields(ds, &dsNf);CHKERRQ(ierr);
56467f96f943SMatthew G. Knepley     ierr = ISGetIndices(fieldIS, &fields);CHKERRQ(ierr);
56477f96f943SMatthew G. Knepley     ierr = PetscArrayzero(exacts, Nf);CHKERRQ(ierr);
56487f96f943SMatthew G. Knepley     ierr = PetscArrayzero(ectxs, Nf);CHKERRQ(ierr);
5649f2cacb80SMatthew G. Knepley     if (u) {
56507f96f943SMatthew G. Knepley       for (f = 0; f < dsNf; ++f) {
56517f96f943SMatthew G. Knepley         const PetscInt field = fields[f];
56527f96f943SMatthew G. Knepley         ierr = PetscDSGetExactSolution(ds, field, &exacts[field], &ectxs[field]);CHKERRQ(ierr);
56537f96f943SMatthew G. Knepley       }
56547f96f943SMatthew G. Knepley       ierr = ISRestoreIndices(fieldIS, &fields);CHKERRQ(ierr);
56557f96f943SMatthew G. Knepley       if (label) {
56567f96f943SMatthew G. Knepley         ierr = DMProjectFunctionLabel(dm, time, label, 1, &id, 0, NULL, exacts, ectxs, INSERT_ALL_VALUES, u);CHKERRQ(ierr);
56577f96f943SMatthew G. Knepley       } else {
56587f96f943SMatthew G. Knepley         ierr = DMProjectFunction(dm, time, exacts, ectxs, INSERT_ALL_VALUES, u);CHKERRQ(ierr);
56597f96f943SMatthew G. Knepley       }
56607f96f943SMatthew G. Knepley     }
5661f2cacb80SMatthew G. Knepley     if (u_t) {
5662f2cacb80SMatthew G. Knepley       ierr = PetscArrayzero(exacts, Nf);CHKERRQ(ierr);
5663f2cacb80SMatthew G. Knepley       ierr = PetscArrayzero(ectxs, Nf);CHKERRQ(ierr);
5664f2cacb80SMatthew G. Knepley       for (f = 0; f < dsNf; ++f) {
5665f2cacb80SMatthew G. Knepley         const PetscInt field = fields[f];
5666f2cacb80SMatthew G. Knepley         ierr = PetscDSGetExactSolutionTimeDerivative(ds, field, &exacts[field], &ectxs[field]);CHKERRQ(ierr);
5667f2cacb80SMatthew G. Knepley       }
5668f2cacb80SMatthew G. Knepley       ierr = ISRestoreIndices(fieldIS, &fields);CHKERRQ(ierr);
5669f2cacb80SMatthew G. Knepley       if (label) {
5670f2cacb80SMatthew G. Knepley         ierr = DMProjectFunctionLabel(dm, time, label, 1, &id, 0, NULL, exacts, ectxs, INSERT_ALL_VALUES, u_t);CHKERRQ(ierr);
5671f2cacb80SMatthew G. Knepley       } else {
5672f2cacb80SMatthew G. Knepley         ierr = DMProjectFunction(dm, time, exacts, ectxs, INSERT_ALL_VALUES, u_t);CHKERRQ(ierr);
5673f2cacb80SMatthew G. Knepley       }
5674f2cacb80SMatthew G. Knepley     }
5675f2cacb80SMatthew G. Knepley   }
5676f2cacb80SMatthew G. Knepley   if (u) {
56777f96f943SMatthew G. Knepley     ierr = PetscObjectSetName((PetscObject) u, "Exact Solution");CHKERRQ(ierr);
56787f96f943SMatthew G. Knepley     ierr = PetscObjectSetOptionsPrefix((PetscObject) u, "exact_");CHKERRQ(ierr);
5679f2cacb80SMatthew G. Knepley   }
5680f2cacb80SMatthew G. Knepley   if (u_t) {
5681f2cacb80SMatthew G. Knepley     ierr = PetscObjectSetName((PetscObject) u, "Exact Solution Time Derivative");CHKERRQ(ierr);
5682f2cacb80SMatthew G. Knepley     ierr = PetscObjectSetOptionsPrefix((PetscObject) u_t, "exact_t_");CHKERRQ(ierr);
5683f2cacb80SMatthew G. Knepley   }
56847f96f943SMatthew G. Knepley   ierr = PetscFree2(exacts, ectxs);CHKERRQ(ierr);
56857f96f943SMatthew G. Knepley   PetscFunctionReturn(0);
56867f96f943SMatthew G. Knepley }
56877f96f943SMatthew G. Knepley 
56887f96f943SMatthew G. Knepley /*@
5689e5e52638SMatthew G. Knepley   DMCopyDS - Copy the discrete systems for the DM into another DM
5690e5e52638SMatthew G. Knepley 
5691d083f849SBarry Smith   Collective on dm
5692e5e52638SMatthew G. Knepley 
5693e5e52638SMatthew G. Knepley   Input Parameter:
5694e5e52638SMatthew G. Knepley . dm - The DM
5695e5e52638SMatthew G. Knepley 
5696e5e52638SMatthew G. Knepley   Output Parameter:
5697e5e52638SMatthew G. Knepley . newdm - The DM
5698e5e52638SMatthew G. Knepley 
5699e5e52638SMatthew G. Knepley   Level: advanced
5700e5e52638SMatthew G. Knepley 
5701e5e52638SMatthew G. Knepley .seealso: DMCopyFields(), DMAddField(), DMGetDS(), DMGetCellDS(), DMGetRegionDS(), DMSetRegionDS()
5702e5e52638SMatthew G. Knepley @*/
5703e5e52638SMatthew G. Knepley PetscErrorCode DMCopyDS(DM dm, DM newdm)
5704e5e52638SMatthew G. Knepley {
5705e5e52638SMatthew G. Knepley   PetscInt       Nds, s;
5706e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5707e5e52638SMatthew G. Knepley 
5708e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5709e5e52638SMatthew G. Knepley   if (dm == newdm) PetscFunctionReturn(0);
5710e5e52638SMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
5711e5e52638SMatthew G. Knepley   ierr = DMClearDS(newdm);CHKERRQ(ierr);
5712e5e52638SMatthew G. Knepley   for (s = 0; s < Nds; ++s) {
5713e5e52638SMatthew G. Knepley     DMLabel  label;
5714b3cf3223SMatthew G. Knepley     IS       fields;
5715e5e52638SMatthew G. Knepley     PetscDS  ds;
5716783e2ec8SMatthew G. Knepley     PetscInt Nbd, bd;
5717e5e52638SMatthew G. Knepley 
5718b3cf3223SMatthew G. Knepley     ierr = DMGetRegionNumDS(dm, s, &label, &fields, &ds);CHKERRQ(ierr);
5719b3cf3223SMatthew G. Knepley     ierr = DMSetRegionDS(newdm, label, fields, ds);CHKERRQ(ierr);
5720783e2ec8SMatthew G. Knepley     ierr = PetscDSGetNumBoundary(ds, &Nbd);CHKERRQ(ierr);
5721783e2ec8SMatthew G. Knepley     for (bd = 0; bd < Nbd; ++bd) {
5722783e2ec8SMatthew G. Knepley       const char *labelname, *name;
5723783e2ec8SMatthew G. Knepley       PetscInt    field;
5724783e2ec8SMatthew G. Knepley 
5725783e2ec8SMatthew G. Knepley       /* Do not check if label exists here, since p4est calls this for the reference tree which does not have the labels */
572656cf3b9cSMatthew G. Knepley       ierr = PetscDSGetBoundary(ds, bd, NULL, &name, &labelname, &field, NULL, NULL, NULL, NULL, NULL, NULL, NULL);CHKERRQ(ierr);
5727783e2ec8SMatthew G. Knepley       ierr = DMCompleteBoundaryLabel_Internal(newdm, ds, field, bd, labelname);CHKERRQ(ierr);
5728783e2ec8SMatthew G. Knepley     }
5729e5e52638SMatthew G. Knepley   }
5730e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5731e5e52638SMatthew G. Knepley }
5732e5e52638SMatthew G. Knepley 
5733e5e52638SMatthew G. Knepley /*@
5734e5e52638SMatthew G. Knepley   DMCopyDisc - Copy the fields and discrete systems for the DM into another DM
5735e5e52638SMatthew G. Knepley 
5736d083f849SBarry Smith   Collective on dm
5737e5e52638SMatthew G. Knepley 
5738e5e52638SMatthew G. Knepley   Input Parameter:
5739e5e52638SMatthew G. Knepley . dm - The DM
5740e5e52638SMatthew G. Knepley 
5741e5e52638SMatthew G. Knepley   Output Parameter:
5742e5e52638SMatthew G. Knepley . newdm - The DM
5743e5e52638SMatthew G. Knepley 
5744e5e52638SMatthew G. Knepley   Level: advanced
5745e5e52638SMatthew G. Knepley 
5746e5e52638SMatthew G. Knepley .seealso: DMCopyFields(), DMCopyDS()
5747e5e52638SMatthew G. Knepley @*/
5748e5e52638SMatthew G. Knepley PetscErrorCode DMCopyDisc(DM dm, DM newdm)
5749e5e52638SMatthew G. Knepley {
5750e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5751e5e52638SMatthew G. Knepley 
5752e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5753e5e52638SMatthew G. Knepley   ierr = DMCopyFields(dm, newdm);CHKERRQ(ierr);
5754e5e52638SMatthew G. Knepley   ierr = DMCopyDS(dm, newdm);CHKERRQ(ierr);
5755e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5756e5e52638SMatthew G. Knepley }
5757e5e52638SMatthew G. Knepley 
5758b64e0483SPeter Brune PetscErrorCode DMRestrictHook_Coordinates(DM dm,DM dmc,void *ctx)
5759b64e0483SPeter Brune {
5760b64e0483SPeter Brune   DM dm_coord,dmc_coord;
5761b64e0483SPeter Brune   PetscErrorCode ierr;
5762b64e0483SPeter Brune   Vec coords,ccoords;
57636dbf9973SLawrence Mitchell   Mat inject;
5764b64e0483SPeter Brune   PetscFunctionBegin;
5765b64e0483SPeter Brune   ierr = DMGetCoordinateDM(dm,&dm_coord);CHKERRQ(ierr);
5766b64e0483SPeter Brune   ierr = DMGetCoordinateDM(dmc,&dmc_coord);CHKERRQ(ierr);
5767b64e0483SPeter Brune   ierr = DMGetCoordinates(dm,&coords);CHKERRQ(ierr);
5768b64e0483SPeter Brune   ierr = DMGetCoordinates(dmc,&ccoords);CHKERRQ(ierr);
5769b64e0483SPeter Brune   if (coords && !ccoords) {
5770b64e0483SPeter Brune     ierr = DMCreateGlobalVector(dmc_coord,&ccoords);CHKERRQ(ierr);
57716668ed41SLisandro Dalcin     ierr = PetscObjectSetName((PetscObject)ccoords,"coordinates");CHKERRQ(ierr);
57726dbf9973SLawrence Mitchell     ierr = DMCreateInjection(dmc_coord,dm_coord,&inject);CHKERRQ(ierr);
57732adcf181SLawrence Mitchell     ierr = MatRestrict(inject,coords,ccoords);CHKERRQ(ierr);
57746dbf9973SLawrence Mitchell     ierr = MatDestroy(&inject);CHKERRQ(ierr);
5775b64e0483SPeter Brune     ierr = DMSetCoordinates(dmc,ccoords);CHKERRQ(ierr);
5776b64e0483SPeter Brune     ierr = VecDestroy(&ccoords);CHKERRQ(ierr);
5777b64e0483SPeter Brune   }
5778b64e0483SPeter Brune   PetscFunctionReturn(0);
5779b64e0483SPeter Brune }
5780b64e0483SPeter Brune 
578103dadc2fSPeter Brune static PetscErrorCode DMSubDomainHook_Coordinates(DM dm,DM subdm,void *ctx)
578203dadc2fSPeter Brune {
578303dadc2fSPeter Brune   DM dm_coord,subdm_coord;
578403dadc2fSPeter Brune   PetscErrorCode ierr;
578503dadc2fSPeter Brune   Vec coords,ccoords,clcoords;
578603dadc2fSPeter Brune   VecScatter *scat_i,*scat_g;
578703dadc2fSPeter Brune   PetscFunctionBegin;
578803dadc2fSPeter Brune   ierr = DMGetCoordinateDM(dm,&dm_coord);CHKERRQ(ierr);
578903dadc2fSPeter Brune   ierr = DMGetCoordinateDM(subdm,&subdm_coord);CHKERRQ(ierr);
579003dadc2fSPeter Brune   ierr = DMGetCoordinates(dm,&coords);CHKERRQ(ierr);
579103dadc2fSPeter Brune   ierr = DMGetCoordinates(subdm,&ccoords);CHKERRQ(ierr);
579203dadc2fSPeter Brune   if (coords && !ccoords) {
579303dadc2fSPeter Brune     ierr = DMCreateGlobalVector(subdm_coord,&ccoords);CHKERRQ(ierr);
57946668ed41SLisandro Dalcin     ierr = PetscObjectSetName((PetscObject)ccoords,"coordinates");CHKERRQ(ierr);
579503dadc2fSPeter Brune     ierr = DMCreateLocalVector(subdm_coord,&clcoords);CHKERRQ(ierr);
579624640c55SToby Isaac     ierr = PetscObjectSetName((PetscObject)clcoords,"coordinates");CHKERRQ(ierr);
579703dadc2fSPeter Brune     ierr = DMCreateDomainDecompositionScatters(dm_coord,1,&subdm_coord,NULL,&scat_i,&scat_g);CHKERRQ(ierr);
579803dadc2fSPeter Brune     ierr = VecScatterBegin(scat_i[0],coords,ccoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
579903dadc2fSPeter Brune     ierr = VecScatterEnd(scat_i[0],coords,ccoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
58001ed9ada7SJunchao Zhang     ierr = VecScatterBegin(scat_g[0],coords,clcoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
580103dadc2fSPeter Brune     ierr = VecScatterEnd(scat_g[0],coords,clcoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
580203dadc2fSPeter Brune     ierr = DMSetCoordinates(subdm,ccoords);CHKERRQ(ierr);
580303dadc2fSPeter Brune     ierr = DMSetCoordinatesLocal(subdm,clcoords);CHKERRQ(ierr);
580403dadc2fSPeter Brune     ierr = VecScatterDestroy(&scat_i[0]);CHKERRQ(ierr);
580503dadc2fSPeter Brune     ierr = VecScatterDestroy(&scat_g[0]);CHKERRQ(ierr);
580603dadc2fSPeter Brune     ierr = VecDestroy(&ccoords);CHKERRQ(ierr);
580703dadc2fSPeter Brune     ierr = VecDestroy(&clcoords);CHKERRQ(ierr);
580803dadc2fSPeter Brune     ierr = PetscFree(scat_i);CHKERRQ(ierr);
580903dadc2fSPeter Brune     ierr = PetscFree(scat_g);CHKERRQ(ierr);
581003dadc2fSPeter Brune   }
581103dadc2fSPeter Brune   PetscFunctionReturn(0);
581203dadc2fSPeter Brune }
581303dadc2fSPeter Brune 
5814c73cfb54SMatthew G. Knepley /*@
5815c73cfb54SMatthew G. Knepley   DMGetDimension - Return the topological dimension of the DM
5816c73cfb54SMatthew G. Knepley 
5817c73cfb54SMatthew G. Knepley   Not collective
5818c73cfb54SMatthew G. Knepley 
5819c73cfb54SMatthew G. Knepley   Input Parameter:
5820c73cfb54SMatthew G. Knepley . dm - The DM
5821c73cfb54SMatthew G. Knepley 
5822c73cfb54SMatthew G. Knepley   Output Parameter:
5823c73cfb54SMatthew G. Knepley . dim - The topological dimension
5824c73cfb54SMatthew G. Knepley 
5825c73cfb54SMatthew G. Knepley   Level: beginner
5826c73cfb54SMatthew G. Knepley 
5827c73cfb54SMatthew G. Knepley .seealso: DMSetDimension(), DMCreate()
5828c73cfb54SMatthew G. Knepley @*/
5829c73cfb54SMatthew G. Knepley PetscErrorCode DMGetDimension(DM dm, PetscInt *dim)
5830c73cfb54SMatthew G. Knepley {
5831c73cfb54SMatthew G. Knepley   PetscFunctionBegin;
5832c73cfb54SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5833534a8f05SLisandro Dalcin   PetscValidIntPointer(dim, 2);
5834c73cfb54SMatthew G. Knepley   *dim = dm->dim;
5835c73cfb54SMatthew G. Knepley   PetscFunctionReturn(0);
5836c73cfb54SMatthew G. Knepley }
5837c73cfb54SMatthew G. Knepley 
5838c73cfb54SMatthew G. Knepley /*@
5839c73cfb54SMatthew G. Knepley   DMSetDimension - Set the topological dimension of the DM
5840c73cfb54SMatthew G. Knepley 
5841c73cfb54SMatthew G. Knepley   Collective on dm
5842c73cfb54SMatthew G. Knepley 
5843c73cfb54SMatthew G. Knepley   Input Parameters:
5844c73cfb54SMatthew G. Knepley + dm - The DM
5845c73cfb54SMatthew G. Knepley - dim - The topological dimension
5846c73cfb54SMatthew G. Knepley 
5847c73cfb54SMatthew G. Knepley   Level: beginner
5848c73cfb54SMatthew G. Knepley 
5849c73cfb54SMatthew G. Knepley .seealso: DMGetDimension(), DMCreate()
5850c73cfb54SMatthew G. Knepley @*/
5851c73cfb54SMatthew G. Knepley PetscErrorCode DMSetDimension(DM dm, PetscInt dim)
5852c73cfb54SMatthew G. Knepley {
5853e5e52638SMatthew G. Knepley   PetscDS        ds;
5854f17e8794SMatthew G. Knepley   PetscErrorCode ierr;
5855f17e8794SMatthew G. Knepley 
5856c73cfb54SMatthew G. Knepley   PetscFunctionBegin;
5857c73cfb54SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5858c73cfb54SMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, dim, 2);
5859c73cfb54SMatthew G. Knepley   dm->dim = dim;
5860e5e52638SMatthew G. Knepley   ierr = DMGetDS(dm, &ds);CHKERRQ(ierr);
5861e5e52638SMatthew G. Knepley   if (ds->dimEmbed < 0) {ierr = PetscDSSetCoordinateDimension(ds, dm->dim);CHKERRQ(ierr);}
5862c73cfb54SMatthew G. Knepley   PetscFunctionReturn(0);
5863c73cfb54SMatthew G. Knepley }
5864c73cfb54SMatthew G. Knepley 
5865793f3fe5SMatthew G. Knepley /*@
5866793f3fe5SMatthew G. Knepley   DMGetDimPoints - Get the half-open interval for all points of a given dimension
5867793f3fe5SMatthew G. Knepley 
5868d083f849SBarry Smith   Collective on dm
5869793f3fe5SMatthew G. Knepley 
5870793f3fe5SMatthew G. Knepley   Input Parameters:
5871793f3fe5SMatthew G. Knepley + dm - the DM
5872793f3fe5SMatthew G. Knepley - dim - the dimension
5873793f3fe5SMatthew G. Knepley 
5874793f3fe5SMatthew G. Knepley   Output Parameters:
5875793f3fe5SMatthew G. Knepley + pStart - The first point of the given dimension
5876aa049354SPatrick Sanan - pEnd - The first point following points of the given dimension
5877793f3fe5SMatthew G. Knepley 
5878793f3fe5SMatthew G. Knepley   Note:
5879793f3fe5SMatthew G. Knepley   The points are vertices in the Hasse diagram encoding the topology. This is explained in
5880a8d69d7bSBarry Smith   https://arxiv.org/abs/0908.4427. If no points exist of this dimension in the storage scheme,
5881793f3fe5SMatthew G. Knepley   then the interval is empty.
5882793f3fe5SMatthew G. Knepley 
5883793f3fe5SMatthew G. Knepley   Level: intermediate
5884793f3fe5SMatthew G. Knepley 
5885793f3fe5SMatthew G. Knepley .seealso: DMPLEX, DMPlexGetDepthStratum(), DMPlexGetHeightStratum()
5886793f3fe5SMatthew G. Knepley @*/
5887793f3fe5SMatthew G. Knepley PetscErrorCode DMGetDimPoints(DM dm, PetscInt dim, PetscInt *pStart, PetscInt *pEnd)
5888793f3fe5SMatthew G. Knepley {
5889793f3fe5SMatthew G. Knepley   PetscInt       d;
5890793f3fe5SMatthew G. Knepley   PetscErrorCode ierr;
5891793f3fe5SMatthew G. Knepley 
5892793f3fe5SMatthew G. Knepley   PetscFunctionBegin;
5893793f3fe5SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
5894793f3fe5SMatthew G. Knepley   ierr = DMGetDimension(dm, &d);CHKERRQ(ierr);
5895793f3fe5SMatthew G. Knepley   if ((dim < 0) || (dim > d)) SETERRQ2(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid dimension %d 1", dim, d);
5896b9d85ea2SLisandro Dalcin   if (!dm->ops->getdimpoints) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "DM type %s does not implement DMGetDimPoints",((PetscObject)dm)->type_name);
5897793f3fe5SMatthew G. Knepley   ierr = (*dm->ops->getdimpoints)(dm, dim, pStart, pEnd);CHKERRQ(ierr);
5898793f3fe5SMatthew G. Knepley   PetscFunctionReturn(0);
5899793f3fe5SMatthew G. Knepley }
5900793f3fe5SMatthew G. Knepley 
59016636e97aSMatthew G Knepley /*@
59026636e97aSMatthew G Knepley   DMSetCoordinates - Sets into the DM a global vector that holds the coordinates
59036636e97aSMatthew G Knepley 
5904d083f849SBarry Smith   Collective on dm
59056636e97aSMatthew G Knepley 
59066636e97aSMatthew G Knepley   Input Parameters:
59076636e97aSMatthew G Knepley + dm - the DM
59086636e97aSMatthew G Knepley - c - coordinate vector
59096636e97aSMatthew G Knepley 
59102dd40e9bSPatrick Sanan   Notes:
59112dd40e9bSPatrick Sanan   The coordinates do include those for ghost points, which are in the local vector.
59122dd40e9bSPatrick Sanan 
59132dd40e9bSPatrick Sanan   The vector c should be destroyed by the caller.
59146636e97aSMatthew G Knepley 
59156636e97aSMatthew G Knepley   Level: intermediate
59166636e97aSMatthew G Knepley 
59172dd40e9bSPatrick Sanan .seealso: DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM()
59186636e97aSMatthew G Knepley @*/
59196636e97aSMatthew G Knepley PetscErrorCode DMSetCoordinates(DM dm, Vec c)
59206636e97aSMatthew G Knepley {
59216636e97aSMatthew G Knepley   PetscErrorCode ierr;
59226636e97aSMatthew G Knepley 
59236636e97aSMatthew G Knepley   PetscFunctionBegin;
59246636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
59256636e97aSMatthew G Knepley   PetscValidHeaderSpecific(c,VEC_CLASSID,2);
59266636e97aSMatthew G Knepley   ierr            = PetscObjectReference((PetscObject) c);CHKERRQ(ierr);
59276636e97aSMatthew G Knepley   ierr            = VecDestroy(&dm->coordinates);CHKERRQ(ierr);
59286636e97aSMatthew G Knepley   dm->coordinates = c;
59296636e97aSMatthew G Knepley   ierr            = VecDestroy(&dm->coordinatesLocal);CHKERRQ(ierr);
5930b64e0483SPeter Brune   ierr            = DMCoarsenHookAdd(dm,DMRestrictHook_Coordinates,NULL,NULL);CHKERRQ(ierr);
593103dadc2fSPeter Brune   ierr            = DMSubDomainHookAdd(dm,DMSubDomainHook_Coordinates,NULL,NULL);CHKERRQ(ierr);
59326636e97aSMatthew G Knepley   PetscFunctionReturn(0);
59336636e97aSMatthew G Knepley }
59346636e97aSMatthew G Knepley 
59356636e97aSMatthew G Knepley /*@
59366636e97aSMatthew G Knepley   DMSetCoordinatesLocal - Sets into the DM a local vector that holds the coordinates
59376636e97aSMatthew G Knepley 
59387058e716SVaclav Hapla   Not collective
59396636e97aSMatthew G Knepley 
59406636e97aSMatthew G Knepley    Input Parameters:
59416636e97aSMatthew G Knepley +  dm - the DM
59426636e97aSMatthew G Knepley -  c - coordinate vector
59436636e97aSMatthew G Knepley 
59442dd40e9bSPatrick Sanan   Notes:
59456636e97aSMatthew G Knepley   The coordinates of ghost points can be set using DMSetCoordinates()
59466636e97aSMatthew G Knepley   followed by DMGetCoordinatesLocal(). This is intended to enable the
59476636e97aSMatthew G Knepley   setting of ghost coordinates outside of the domain.
59486636e97aSMatthew G Knepley 
59492dd40e9bSPatrick Sanan   The vector c should be destroyed by the caller.
59502dd40e9bSPatrick Sanan 
59516636e97aSMatthew G Knepley   Level: intermediate
59526636e97aSMatthew G Knepley 
59536636e97aSMatthew G Knepley .seealso: DMGetCoordinatesLocal(), DMSetCoordinates(), DMGetCoordinates(), DMGetCoordinateDM()
59546636e97aSMatthew G Knepley @*/
59556636e97aSMatthew G Knepley PetscErrorCode DMSetCoordinatesLocal(DM dm, Vec c)
59566636e97aSMatthew G Knepley {
59576636e97aSMatthew G Knepley   PetscErrorCode ierr;
59586636e97aSMatthew G Knepley 
59596636e97aSMatthew G Knepley   PetscFunctionBegin;
59606636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
59616636e97aSMatthew G Knepley   PetscValidHeaderSpecific(c,VEC_CLASSID,2);
59626636e97aSMatthew G Knepley   ierr = PetscObjectReference((PetscObject) c);CHKERRQ(ierr);
59636636e97aSMatthew G Knepley   ierr = VecDestroy(&dm->coordinatesLocal);CHKERRQ(ierr);
59648865f1eaSKarl Rupp 
59656636e97aSMatthew G Knepley   dm->coordinatesLocal = c;
59668865f1eaSKarl Rupp 
59676636e97aSMatthew G Knepley   ierr = VecDestroy(&dm->coordinates);CHKERRQ(ierr);
59686636e97aSMatthew G Knepley   PetscFunctionReturn(0);
59696636e97aSMatthew G Knepley }
59706636e97aSMatthew G Knepley 
59716636e97aSMatthew G Knepley /*@
59726636e97aSMatthew G Knepley   DMGetCoordinates - Gets a global vector with the coordinates associated with the DM.
59736636e97aSMatthew G Knepley 
5974d083f849SBarry Smith   Collective on dm
59756636e97aSMatthew G Knepley 
59766636e97aSMatthew G Knepley   Input Parameter:
59776636e97aSMatthew G Knepley . dm - the DM
59786636e97aSMatthew G Knepley 
59796636e97aSMatthew G Knepley   Output Parameter:
59806636e97aSMatthew G Knepley . c - global coordinate vector
59816636e97aSMatthew G Knepley 
59826636e97aSMatthew G Knepley   Note:
59836636e97aSMatthew G Knepley   This is a borrowed reference, so the user should NOT destroy this vector
59846636e97aSMatthew G Knepley 
59856636e97aSMatthew G Knepley   Each process has only the local coordinates (does NOT have the ghost coordinates).
59866636e97aSMatthew G Knepley 
59876636e97aSMatthew G Knepley   For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...)
59886636e97aSMatthew G Knepley   and (x_0,y_0,z_0,x_1,y_1,z_1...)
59896636e97aSMatthew G Knepley 
59906636e97aSMatthew G Knepley   Level: intermediate
59916636e97aSMatthew G Knepley 
59926636e97aSMatthew G Knepley .seealso: DMSetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM()
59936636e97aSMatthew G Knepley @*/
59946636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinates(DM dm, Vec *c)
59956636e97aSMatthew G Knepley {
59966636e97aSMatthew G Knepley   PetscErrorCode ierr;
59976636e97aSMatthew G Knepley 
59986636e97aSMatthew G Knepley   PetscFunctionBegin;
59996636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
60006636e97aSMatthew G Knepley   PetscValidPointer(c,2);
60011f588964SMatthew G Knepley   if (!dm->coordinates && dm->coordinatesLocal) {
60020298fd71SBarry Smith     DM        cdm = NULL;
60031970a576SMatthew G. Knepley     PetscBool localized;
60046636e97aSMatthew G Knepley 
60056636e97aSMatthew G Knepley     ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
60066636e97aSMatthew G Knepley     ierr = DMCreateGlobalVector(cdm, &dm->coordinates);CHKERRQ(ierr);
60071970a576SMatthew G. Knepley     ierr = DMGetCoordinatesLocalized(dm, &localized);CHKERRQ(ierr);
60081970a576SMatthew G. Knepley     /* Block size is not correctly set by CreateGlobalVector() if coordinates are localized */
60091970a576SMatthew G. Knepley     if (localized) {
60101970a576SMatthew G. Knepley       PetscInt cdim;
60111970a576SMatthew G. Knepley 
60121970a576SMatthew G. Knepley       ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
60131970a576SMatthew G. Knepley       ierr = VecSetBlockSize(dm->coordinates, cdim);CHKERRQ(ierr);
60141970a576SMatthew G. Knepley     }
60156636e97aSMatthew G Knepley     ierr = PetscObjectSetName((PetscObject) dm->coordinates, "coordinates");CHKERRQ(ierr);
60166636e97aSMatthew G Knepley     ierr = DMLocalToGlobalBegin(cdm, dm->coordinatesLocal, INSERT_VALUES, dm->coordinates);CHKERRQ(ierr);
60176636e97aSMatthew G Knepley     ierr = DMLocalToGlobalEnd(cdm, dm->coordinatesLocal, INSERT_VALUES, dm->coordinates);CHKERRQ(ierr);
60186636e97aSMatthew G Knepley   }
60196636e97aSMatthew G Knepley   *c = dm->coordinates;
60206636e97aSMatthew G Knepley   PetscFunctionReturn(0);
60216636e97aSMatthew G Knepley }
60226636e97aSMatthew G Knepley 
60236636e97aSMatthew G Knepley /*@
602481e9a530SVaclav Hapla   DMGetCoordinatesLocalSetUp - Prepares a local vector of coordinates, so that DMGetCoordinatesLocalNoncollective() can be used as non-collective afterwards.
602581e9a530SVaclav Hapla 
6026d083f849SBarry Smith   Collective on dm
602781e9a530SVaclav Hapla 
602881e9a530SVaclav Hapla   Input Parameter:
602981e9a530SVaclav Hapla . dm - the DM
603081e9a530SVaclav Hapla 
603181e9a530SVaclav Hapla   Level: advanced
603281e9a530SVaclav Hapla 
603381e9a530SVaclav Hapla .seealso: DMGetCoordinatesLocalNoncollective()
603481e9a530SVaclav Hapla @*/
603581e9a530SVaclav Hapla PetscErrorCode DMGetCoordinatesLocalSetUp(DM dm)
603681e9a530SVaclav Hapla {
603781e9a530SVaclav Hapla   PetscErrorCode ierr;
603881e9a530SVaclav Hapla 
603981e9a530SVaclav Hapla   PetscFunctionBegin;
604081e9a530SVaclav Hapla   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
604181e9a530SVaclav Hapla   if (!dm->coordinatesLocal && dm->coordinates) {
60421970a576SMatthew G. Knepley     DM        cdm = NULL;
60431970a576SMatthew G. Knepley     PetscBool localized;
60441970a576SMatthew G. Knepley 
604581e9a530SVaclav Hapla     ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
604681e9a530SVaclav Hapla     ierr = DMCreateLocalVector(cdm, &dm->coordinatesLocal);CHKERRQ(ierr);
60471970a576SMatthew G. Knepley     ierr = DMGetCoordinatesLocalized(dm, &localized);CHKERRQ(ierr);
60481970a576SMatthew G. Knepley     /* Block size is not correctly set by CreateLocalVector() if coordinates are localized */
60491970a576SMatthew G. Knepley     if (localized) {
60501970a576SMatthew G. Knepley       PetscInt cdim;
60511970a576SMatthew G. Knepley 
60521970a576SMatthew G. Knepley       ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
60531970a576SMatthew G. Knepley       ierr = VecSetBlockSize(dm->coordinates, cdim);CHKERRQ(ierr);
60541970a576SMatthew G. Knepley     }
605581e9a530SVaclav Hapla     ierr = PetscObjectSetName((PetscObject) dm->coordinatesLocal, "coordinates");CHKERRQ(ierr);
605681e9a530SVaclav Hapla     ierr = DMGlobalToLocalBegin(cdm, dm->coordinates, INSERT_VALUES, dm->coordinatesLocal);CHKERRQ(ierr);
605781e9a530SVaclav Hapla     ierr = DMGlobalToLocalEnd(cdm, dm->coordinates, INSERT_VALUES, dm->coordinatesLocal);CHKERRQ(ierr);
605881e9a530SVaclav Hapla   }
605981e9a530SVaclav Hapla   PetscFunctionReturn(0);
606081e9a530SVaclav Hapla }
606181e9a530SVaclav Hapla 
606281e9a530SVaclav Hapla /*@
60636636e97aSMatthew G Knepley   DMGetCoordinatesLocal - Gets a local vector with the coordinates associated with the DM.
60646636e97aSMatthew G Knepley 
6065d083f849SBarry Smith   Collective on dm
60666636e97aSMatthew G Knepley 
60676636e97aSMatthew G Knepley   Input Parameter:
60686636e97aSMatthew G Knepley . dm - the DM
60696636e97aSMatthew G Knepley 
60706636e97aSMatthew G Knepley   Output Parameter:
60716636e97aSMatthew G Knepley . c - coordinate vector
60726636e97aSMatthew G Knepley 
60736636e97aSMatthew G Knepley   Note:
60746636e97aSMatthew G Knepley   This is a borrowed reference, so the user should NOT destroy this vector
60756636e97aSMatthew G Knepley 
60766636e97aSMatthew G Knepley   Each process has the local and ghost coordinates
60776636e97aSMatthew G Knepley 
60786636e97aSMatthew G Knepley   For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...)
60796636e97aSMatthew G Knepley   and (x_0,y_0,z_0,x_1,y_1,z_1...)
60806636e97aSMatthew G Knepley 
60816636e97aSMatthew G Knepley   Level: intermediate
60826636e97aSMatthew G Knepley 
608381e9a530SVaclav Hapla .seealso: DMSetCoordinatesLocal(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM(), DMGetCoordinatesLocalNoncollective()
60846636e97aSMatthew G Knepley @*/
60856636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinatesLocal(DM dm, Vec *c)
60866636e97aSMatthew G Knepley {
60876636e97aSMatthew G Knepley   PetscErrorCode ierr;
60886636e97aSMatthew G Knepley 
60896636e97aSMatthew G Knepley   PetscFunctionBegin;
60906636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
60916636e97aSMatthew G Knepley   PetscValidPointer(c,2);
609281e9a530SVaclav Hapla   ierr = DMGetCoordinatesLocalSetUp(dm);CHKERRQ(ierr);
60936636e97aSMatthew G Knepley   *c = dm->coordinatesLocal;
60946636e97aSMatthew G Knepley   PetscFunctionReturn(0);
60956636e97aSMatthew G Knepley }
60966636e97aSMatthew G Knepley 
609781e9a530SVaclav Hapla /*@
609881e9a530SVaclav Hapla   DMGetCoordinatesLocalNoncollective - Non-collective version of DMGetCoordinatesLocal(). Fails if global coordinates have been set and DMGetCoordinatesLocalSetUp() not called.
609981e9a530SVaclav Hapla 
610081e9a530SVaclav Hapla   Not collective
610181e9a530SVaclav Hapla 
610281e9a530SVaclav Hapla   Input Parameter:
610381e9a530SVaclav Hapla . dm - the DM
610481e9a530SVaclav Hapla 
610581e9a530SVaclav Hapla   Output Parameter:
610681e9a530SVaclav Hapla . c - coordinate vector
610781e9a530SVaclav Hapla 
610881e9a530SVaclav Hapla   Level: advanced
610981e9a530SVaclav Hapla 
611081e9a530SVaclav Hapla .seealso: DMGetCoordinatesLocalSetUp(), DMGetCoordinatesLocal(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM()
611181e9a530SVaclav Hapla @*/
611281e9a530SVaclav Hapla PetscErrorCode DMGetCoordinatesLocalNoncollective(DM dm, Vec *c)
611381e9a530SVaclav Hapla {
611481e9a530SVaclav Hapla   PetscFunctionBegin;
611581e9a530SVaclav Hapla   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
611681e9a530SVaclav Hapla   PetscValidPointer(c,2);
611781e9a530SVaclav Hapla   if (!dm->coordinatesLocal && dm->coordinates) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DMGetCoordinatesLocalSetUp() has not been called");
61186636e97aSMatthew G Knepley   *c = dm->coordinatesLocal;
61196636e97aSMatthew G Knepley   PetscFunctionReturn(0);
61206636e97aSMatthew G Knepley }
61216636e97aSMatthew G Knepley 
61222db98f8dSVaclav Hapla /*@
61232db98f8dSVaclav Hapla   DMGetCoordinatesLocalTuple - Gets a local vector with the coordinates of specified points and section describing its layout.
61242db98f8dSVaclav Hapla 
61252db98f8dSVaclav Hapla   Not collective
61262db98f8dSVaclav Hapla 
61272db98f8dSVaclav Hapla   Input Parameter:
61282db98f8dSVaclav Hapla + dm - the DM
61292db98f8dSVaclav Hapla - p - the IS of points whose coordinates will be returned
61302db98f8dSVaclav Hapla 
61312db98f8dSVaclav Hapla   Output Parameter:
61322db98f8dSVaclav Hapla + pCoordSection - the PetscSection describing the layout of pCoord, i.e. each point corresponds to one point in p, and DOFs correspond to coordinates
61332db98f8dSVaclav Hapla - pCoord - the Vec with coordinates of points in p
61342db98f8dSVaclav Hapla 
61352db98f8dSVaclav Hapla   Note:
61362db98f8dSVaclav Hapla   DMGetCoordinatesLocalSetUp() must be called first. This function employs DMGetCoordinatesLocalNoncollective() so it is not collective.
61372db98f8dSVaclav Hapla 
61382db98f8dSVaclav Hapla   This creates a new vector, so the user SHOULD destroy this vector
61392db98f8dSVaclav Hapla 
61402db98f8dSVaclav Hapla   Each process has the local and ghost coordinates
61412db98f8dSVaclav Hapla 
61422db98f8dSVaclav Hapla   For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...)
61432db98f8dSVaclav Hapla   and (x_0,y_0,z_0,x_1,y_1,z_1...)
61442db98f8dSVaclav Hapla 
61452db98f8dSVaclav Hapla   Level: advanced
61462db98f8dSVaclav Hapla 
61472db98f8dSVaclav Hapla .seealso: DMSetCoordinatesLocal(), DMGetCoordinatesLocal(), DMGetCoordinatesLocalNoncollective(), DMGetCoordinatesLocalSetUp(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM()
61482db98f8dSVaclav Hapla @*/
61492db98f8dSVaclav Hapla PetscErrorCode DMGetCoordinatesLocalTuple(DM dm, IS p, PetscSection *pCoordSection, Vec *pCoord)
61502db98f8dSVaclav Hapla {
61512db98f8dSVaclav Hapla   PetscSection        cs, newcs;
61522db98f8dSVaclav Hapla   Vec                 coords;
61532db98f8dSVaclav Hapla   const PetscScalar   *arr;
61542db98f8dSVaclav Hapla   PetscScalar         *newarr=NULL;
61552db98f8dSVaclav Hapla   PetscInt            n;
61562db98f8dSVaclav Hapla   PetscErrorCode      ierr;
61572db98f8dSVaclav Hapla 
61582db98f8dSVaclav Hapla   PetscFunctionBegin;
61592db98f8dSVaclav Hapla   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
61602db98f8dSVaclav Hapla   PetscValidHeaderSpecific(p, IS_CLASSID, 2);
61612db98f8dSVaclav Hapla   if (pCoordSection) PetscValidPointer(pCoordSection, 3);
61622db98f8dSVaclav Hapla   if (pCoord) PetscValidPointer(pCoord, 4);
61632db98f8dSVaclav Hapla   if (!dm->coordinatesLocal) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DMGetCoordinatesLocalSetUp() has not been called or coordinates not set");
61641bb6d2a8SBarry Smith   if (!dm->coordinateDM || !dm->coordinateDM->localSection) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DM not supported");
61651bb6d2a8SBarry Smith   cs = dm->coordinateDM->localSection;
61662db98f8dSVaclav Hapla   coords = dm->coordinatesLocal;
61672db98f8dSVaclav Hapla   ierr = VecGetArrayRead(coords, &arr);CHKERRQ(ierr);
61682db98f8dSVaclav Hapla   ierr = PetscSectionExtractDofsFromArray(cs, MPIU_SCALAR, arr, p, &newcs, pCoord ? ((void**)&newarr) : NULL);CHKERRQ(ierr);
61692db98f8dSVaclav Hapla   ierr = VecRestoreArrayRead(coords, &arr);CHKERRQ(ierr);
61702db98f8dSVaclav Hapla   if (pCoord) {
61712db98f8dSVaclav Hapla     ierr = PetscSectionGetStorageSize(newcs, &n);CHKERRQ(ierr);
61722db98f8dSVaclav Hapla     /* set array in two steps to mimic PETSC_OWN_POINTER */
61732db98f8dSVaclav Hapla     ierr = VecCreateSeqWithArray(PetscObjectComm((PetscObject)p), 1, n, NULL, pCoord);CHKERRQ(ierr);
61742db98f8dSVaclav Hapla     ierr = VecReplaceArray(*pCoord, newarr);CHKERRQ(ierr);
6175ad9ac99dSVaclav Hapla   } else {
6176ad9ac99dSVaclav Hapla     ierr = PetscFree(newarr);CHKERRQ(ierr);
61772db98f8dSVaclav Hapla   }
6178ad9ac99dSVaclav Hapla   if (pCoordSection) {*pCoordSection = newcs;}
6179ad9ac99dSVaclav Hapla   else               {ierr = PetscSectionDestroy(&newcs);CHKERRQ(ierr);}
61802db98f8dSVaclav Hapla   PetscFunctionReturn(0);
61812db98f8dSVaclav Hapla }
61822db98f8dSVaclav Hapla 
6183f19dbd58SToby Isaac PetscErrorCode DMGetCoordinateField(DM dm, DMField *field)
6184f19dbd58SToby Isaac {
6185f19dbd58SToby Isaac   PetscErrorCode ierr;
6186f19dbd58SToby Isaac 
6187f19dbd58SToby Isaac   PetscFunctionBegin;
6188f19dbd58SToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6189f19dbd58SToby Isaac   PetscValidPointer(field,2);
6190f19dbd58SToby Isaac   if (!dm->coordinateField) {
6191f19dbd58SToby Isaac     if (dm->ops->createcoordinatefield) {
6192f19dbd58SToby Isaac       ierr = (*dm->ops->createcoordinatefield)(dm,&dm->coordinateField);CHKERRQ(ierr);
6193f19dbd58SToby Isaac     }
6194f19dbd58SToby Isaac   }
6195f19dbd58SToby Isaac   *field = dm->coordinateField;
6196f19dbd58SToby Isaac   PetscFunctionReturn(0);
6197f19dbd58SToby Isaac }
6198f19dbd58SToby Isaac 
6199f19dbd58SToby Isaac PetscErrorCode DMSetCoordinateField(DM dm, DMField field)
6200f19dbd58SToby Isaac {
6201f19dbd58SToby Isaac   PetscErrorCode ierr;
6202f19dbd58SToby Isaac 
6203f19dbd58SToby Isaac   PetscFunctionBegin;
6204f19dbd58SToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6205f19dbd58SToby Isaac   if (field) PetscValidHeaderSpecific(field,DMFIELD_CLASSID,2);
6206c4e6da2cSBarry Smith   ierr = PetscObjectReference((PetscObject)field);CHKERRQ(ierr);
6207f19dbd58SToby Isaac   ierr = DMFieldDestroy(&dm->coordinateField);CHKERRQ(ierr);
6208f19dbd58SToby Isaac   dm->coordinateField = field;
6209f19dbd58SToby Isaac   PetscFunctionReturn(0);
6210f19dbd58SToby Isaac }
6211f19dbd58SToby Isaac 
62126636e97aSMatthew G Knepley /*@
62131cfe2091SMatthew G. Knepley   DMGetCoordinateDM - Gets the DM that prescribes coordinate layout and scatters between global and local coordinates
62146636e97aSMatthew G Knepley 
6215d083f849SBarry Smith   Collective on dm
62166636e97aSMatthew G Knepley 
62176636e97aSMatthew G Knepley   Input Parameter:
62186636e97aSMatthew G Knepley . dm - the DM
62196636e97aSMatthew G Knepley 
62206636e97aSMatthew G Knepley   Output Parameter:
62216636e97aSMatthew G Knepley . cdm - coordinate DM
62226636e97aSMatthew G Knepley 
62236636e97aSMatthew G Knepley   Level: intermediate
62246636e97aSMatthew G Knepley 
62251cfe2091SMatthew G. Knepley .seealso: DMSetCoordinateDM(), DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal()
62266636e97aSMatthew G Knepley @*/
62276636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinateDM(DM dm, DM *cdm)
62286636e97aSMatthew G Knepley {
62296636e97aSMatthew G Knepley   PetscErrorCode ierr;
62306636e97aSMatthew G Knepley 
62316636e97aSMatthew G Knepley   PetscFunctionBegin;
62326636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
62336636e97aSMatthew G Knepley   PetscValidPointer(cdm,2);
62346636e97aSMatthew G Knepley   if (!dm->coordinateDM) {
6235308f8a94SToby Isaac     DM cdm;
6236308f8a94SToby Isaac 
623782f516ccSBarry Smith     if (!dm->ops->createcoordinatedm) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Unable to create coordinates for this DM");
6238308f8a94SToby Isaac     ierr = (*dm->ops->createcoordinatedm)(dm, &cdm);CHKERRQ(ierr);
6239308f8a94SToby Isaac     /* Just in case the DM sets the coordinate DM when creating it (DMP4est can do this, because it may not setup
6240308f8a94SToby Isaac      * until the call to CreateCoordinateDM) */
6241308f8a94SToby Isaac     ierr = DMDestroy(&dm->coordinateDM);CHKERRQ(ierr);
6242308f8a94SToby Isaac     dm->coordinateDM = cdm;
62436636e97aSMatthew G Knepley   }
62446636e97aSMatthew G Knepley   *cdm = dm->coordinateDM;
62456636e97aSMatthew G Knepley   PetscFunctionReturn(0);
62466636e97aSMatthew G Knepley }
6247e87bb0d3SMatthew G Knepley 
62481cfe2091SMatthew G. Knepley /*@
62491cfe2091SMatthew G. Knepley   DMSetCoordinateDM - Sets the DM that prescribes coordinate layout and scatters between global and local coordinates
62501cfe2091SMatthew G. Knepley 
6251d083f849SBarry Smith   Logically Collective on dm
62521cfe2091SMatthew G. Knepley 
62531cfe2091SMatthew G. Knepley   Input Parameters:
62541cfe2091SMatthew G. Knepley + dm - the DM
62551cfe2091SMatthew G. Knepley - cdm - coordinate DM
62561cfe2091SMatthew G. Knepley 
62571cfe2091SMatthew G. Knepley   Level: intermediate
62581cfe2091SMatthew G. Knepley 
62591cfe2091SMatthew G. Knepley .seealso: DMGetCoordinateDM(), DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal()
62601cfe2091SMatthew G. Knepley @*/
62611cfe2091SMatthew G. Knepley PetscErrorCode DMSetCoordinateDM(DM dm, DM cdm)
62621cfe2091SMatthew G. Knepley {
62631cfe2091SMatthew G. Knepley   PetscErrorCode ierr;
62641cfe2091SMatthew G. Knepley 
62651cfe2091SMatthew G. Knepley   PetscFunctionBegin;
62661cfe2091SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
62671cfe2091SMatthew G. Knepley   PetscValidHeaderSpecific(cdm,DM_CLASSID,2);
6268f26b38b9SToby Isaac   ierr = PetscObjectReference((PetscObject)cdm);CHKERRQ(ierr);
62691cfe2091SMatthew G. Knepley   ierr = DMDestroy(&dm->coordinateDM);CHKERRQ(ierr);
62701cfe2091SMatthew G. Knepley   dm->coordinateDM = cdm;
62711cfe2091SMatthew G. Knepley   PetscFunctionReturn(0);
62721cfe2091SMatthew G. Knepley }
62731cfe2091SMatthew G. Knepley 
627446e270d4SMatthew G. Knepley /*@
627546e270d4SMatthew G. Knepley   DMGetCoordinateDim - Retrieve the dimension of embedding space for coordinate values.
627646e270d4SMatthew G. Knepley 
627746e270d4SMatthew G. Knepley   Not Collective
627846e270d4SMatthew G. Knepley 
627946e270d4SMatthew G. Knepley   Input Parameter:
628046e270d4SMatthew G. Knepley . dm - The DM object
628146e270d4SMatthew G. Knepley 
628246e270d4SMatthew G. Knepley   Output Parameter:
628346e270d4SMatthew G. Knepley . dim - The embedding dimension
628446e270d4SMatthew G. Knepley 
628546e270d4SMatthew G. Knepley   Level: intermediate
628646e270d4SMatthew G. Knepley 
628792fd8e1eSJed Brown .seealso: DMSetCoordinateDim(), DMGetCoordinateSection(), DMGetCoordinateDM(), DMGetLocalSection(), DMSetLocalSection()
628846e270d4SMatthew G. Knepley @*/
628946e270d4SMatthew G. Knepley PetscErrorCode DMGetCoordinateDim(DM dm, PetscInt *dim)
629046e270d4SMatthew G. Knepley {
629146e270d4SMatthew G. Knepley   PetscFunctionBegin;
629246e270d4SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6293534a8f05SLisandro Dalcin   PetscValidIntPointer(dim, 2);
62949a9a41abSToby Isaac   if (dm->dimEmbed == PETSC_DEFAULT) {
62959a9a41abSToby Isaac     dm->dimEmbed = dm->dim;
62969a9a41abSToby Isaac   }
629746e270d4SMatthew G. Knepley   *dim = dm->dimEmbed;
629846e270d4SMatthew G. Knepley   PetscFunctionReturn(0);
629946e270d4SMatthew G. Knepley }
630046e270d4SMatthew G. Knepley 
630146e270d4SMatthew G. Knepley /*@
630246e270d4SMatthew G. Knepley   DMSetCoordinateDim - Set the dimension of the embedding space for coordinate values.
630346e270d4SMatthew G. Knepley 
630446e270d4SMatthew G. Knepley   Not Collective
630546e270d4SMatthew G. Knepley 
630646e270d4SMatthew G. Knepley   Input Parameters:
630746e270d4SMatthew G. Knepley + dm  - The DM object
630846e270d4SMatthew G. Knepley - dim - The embedding dimension
630946e270d4SMatthew G. Knepley 
631046e270d4SMatthew G. Knepley   Level: intermediate
631146e270d4SMatthew G. Knepley 
631292fd8e1eSJed Brown .seealso: DMGetCoordinateDim(), DMSetCoordinateSection(), DMGetCoordinateSection(), DMGetLocalSection(), DMSetLocalSection()
631346e270d4SMatthew G. Knepley @*/
631446e270d4SMatthew G. Knepley PetscErrorCode DMSetCoordinateDim(DM dm, PetscInt dim)
631546e270d4SMatthew G. Knepley {
6316e5e52638SMatthew G. Knepley   PetscDS        ds;
6317f17e8794SMatthew G. Knepley   PetscErrorCode ierr;
6318f17e8794SMatthew G. Knepley 
631946e270d4SMatthew G. Knepley   PetscFunctionBegin;
632046e270d4SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
632146e270d4SMatthew G. Knepley   dm->dimEmbed = dim;
6322e5e52638SMatthew G. Knepley   ierr = DMGetDS(dm, &ds);CHKERRQ(ierr);
6323e5e52638SMatthew G. Knepley   ierr = PetscDSSetCoordinateDimension(ds, dim);CHKERRQ(ierr);
632446e270d4SMatthew G. Knepley   PetscFunctionReturn(0);
632546e270d4SMatthew G. Knepley }
632646e270d4SMatthew G. Knepley 
6327e8abe2deSMatthew G. Knepley /*@
6328e8abe2deSMatthew G. Knepley   DMGetCoordinateSection - Retrieve the layout of coordinate values over the mesh.
6329e8abe2deSMatthew G. Knepley 
6330d083f849SBarry Smith   Collective on dm
6331e8abe2deSMatthew G. Knepley 
6332e8abe2deSMatthew G. Knepley   Input Parameter:
6333e8abe2deSMatthew G. Knepley . dm - The DM object
6334e8abe2deSMatthew G. Knepley 
6335e8abe2deSMatthew G. Knepley   Output Parameter:
6336e8abe2deSMatthew G. Knepley . section - The PetscSection object
6337e8abe2deSMatthew G. Knepley 
6338e8abe2deSMatthew G. Knepley   Level: intermediate
6339e8abe2deSMatthew G. Knepley 
634092fd8e1eSJed Brown .seealso: DMGetCoordinateDM(), DMGetLocalSection(), DMSetLocalSection()
6341e8abe2deSMatthew G. Knepley @*/
6342e8abe2deSMatthew G. Knepley PetscErrorCode DMGetCoordinateSection(DM dm, PetscSection *section)
6343e8abe2deSMatthew G. Knepley {
6344e8abe2deSMatthew G. Knepley   DM             cdm;
6345e8abe2deSMatthew G. Knepley   PetscErrorCode ierr;
6346e8abe2deSMatthew G. Knepley 
6347e8abe2deSMatthew G. Knepley   PetscFunctionBegin;
6348e8abe2deSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6349e8abe2deSMatthew G. Knepley   PetscValidPointer(section, 2);
6350e8abe2deSMatthew G. Knepley   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
635192fd8e1eSJed Brown   ierr = DMGetLocalSection(cdm, section);CHKERRQ(ierr);
6352e8abe2deSMatthew G. Knepley   PetscFunctionReturn(0);
6353e8abe2deSMatthew G. Knepley }
6354e8abe2deSMatthew G. Knepley 
6355e8abe2deSMatthew G. Knepley /*@
6356e8abe2deSMatthew G. Knepley   DMSetCoordinateSection - Set the layout of coordinate values over the mesh.
6357e8abe2deSMatthew G. Knepley 
6358e8abe2deSMatthew G. Knepley   Not Collective
6359e8abe2deSMatthew G. Knepley 
6360e8abe2deSMatthew G. Knepley   Input Parameters:
6361e8abe2deSMatthew G. Knepley + dm      - The DM object
636246e270d4SMatthew G. Knepley . dim     - The embedding dimension, or PETSC_DETERMINE
6363e8abe2deSMatthew G. Knepley - section - The PetscSection object
6364e8abe2deSMatthew G. Knepley 
6365e8abe2deSMatthew G. Knepley   Level: intermediate
6366e8abe2deSMatthew G. Knepley 
636792fd8e1eSJed Brown .seealso: DMGetCoordinateSection(), DMGetLocalSection(), DMSetLocalSection()
6368e8abe2deSMatthew G. Knepley @*/
636946e270d4SMatthew G. Knepley PetscErrorCode DMSetCoordinateSection(DM dm, PetscInt dim, PetscSection section)
6370e8abe2deSMatthew G. Knepley {
6371e8abe2deSMatthew G. Knepley   DM             cdm;
6372e8abe2deSMatthew G. Knepley   PetscErrorCode ierr;
6373e8abe2deSMatthew G. Knepley 
6374e8abe2deSMatthew G. Knepley   PetscFunctionBegin;
6375e8abe2deSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
637646e270d4SMatthew G. Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,3);
6377e8abe2deSMatthew G. Knepley   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
637892fd8e1eSJed Brown   ierr = DMSetLocalSection(cdm, section);CHKERRQ(ierr);
637946e270d4SMatthew G. Knepley   if (dim == PETSC_DETERMINE) {
63804c1069a6SMatthew G. Knepley     PetscInt d = PETSC_DEFAULT;
638146e270d4SMatthew G. Knepley     PetscInt pStart, pEnd, vStart, vEnd, v, dd;
638246e270d4SMatthew G. Knepley 
638346e270d4SMatthew G. Knepley     ierr = PetscSectionGetChart(section, &pStart, &pEnd);CHKERRQ(ierr);
638446e270d4SMatthew G. Knepley     ierr = DMGetDimPoints(dm, 0, &vStart, &vEnd);CHKERRQ(ierr);
638546e270d4SMatthew G. Knepley     pStart = PetscMax(vStart, pStart);
638646e270d4SMatthew G. Knepley     pEnd   = PetscMin(vEnd, pEnd);
638746e270d4SMatthew G. Knepley     for (v = pStart; v < pEnd; ++v) {
638846e270d4SMatthew G. Knepley       ierr = PetscSectionGetDof(section, v, &dd);CHKERRQ(ierr);
638946e270d4SMatthew G. Knepley       if (dd) {d = dd; break;}
639046e270d4SMatthew G. Knepley     }
6391ebfe4b0dSMatthew G. Knepley     if (d >= 0) {ierr = DMSetCoordinateDim(dm, d);CHKERRQ(ierr);}
639246e270d4SMatthew G. Knepley   }
6393e8abe2deSMatthew G. Knepley   PetscFunctionReturn(0);
6394e8abe2deSMatthew G. Knepley }
6395e8abe2deSMatthew G. Knepley 
6396d864a3eaSLisandro Dalcin /*@
6397d864a3eaSLisandro Dalcin   DMProjectCoordinates - Project coordinates to a different space
6398d864a3eaSLisandro Dalcin 
6399d864a3eaSLisandro Dalcin   Input Parameters:
6400d864a3eaSLisandro Dalcin + dm      - The DM object
6401d864a3eaSLisandro Dalcin - disc    - The new coordinate discretization
6402d864a3eaSLisandro Dalcin 
6403d864a3eaSLisandro Dalcin   Level: intermediate
6404d864a3eaSLisandro Dalcin 
6405d864a3eaSLisandro Dalcin .seealso: DMGetCoordinateField()
6406d864a3eaSLisandro Dalcin @*/
6407d864a3eaSLisandro Dalcin PetscErrorCode DMProjectCoordinates(DM dm, PetscFE disc)
6408d864a3eaSLisandro Dalcin {
6409d864a3eaSLisandro Dalcin   PetscObject    discOld;
6410d864a3eaSLisandro Dalcin   PetscClassId   classid;
6411d864a3eaSLisandro Dalcin   DM             cdmOld,cdmNew;
6412d864a3eaSLisandro Dalcin   Vec            coordsOld,coordsNew;
6413d864a3eaSLisandro Dalcin   Mat            matInterp;
6414d864a3eaSLisandro Dalcin   PetscErrorCode ierr;
6415d864a3eaSLisandro Dalcin 
6416d864a3eaSLisandro Dalcin   PetscFunctionBegin;
6417d864a3eaSLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6418d864a3eaSLisandro Dalcin   PetscValidHeaderSpecific(disc,PETSCFE_CLASSID,2);
6419d864a3eaSLisandro Dalcin 
6420d864a3eaSLisandro Dalcin   ierr = DMGetCoordinateDM(dm, &cdmOld);CHKERRQ(ierr);
6421d864a3eaSLisandro Dalcin   /* Check current discretization is compatible */
6422d864a3eaSLisandro Dalcin   ierr = DMGetField(cdmOld, 0, NULL, &discOld);CHKERRQ(ierr);
6423d864a3eaSLisandro Dalcin   ierr = PetscObjectGetClassId(discOld, &classid);CHKERRQ(ierr);
642429ad44c5SMatthew G. Knepley   if (classid != PETSCFE_CLASSID) {
642529ad44c5SMatthew G. Knepley     if (classid == PETSC_CONTAINER_CLASSID) {
642629ad44c5SMatthew G. Knepley       PetscFE        feLinear;
642729ad44c5SMatthew G. Knepley       DMPolytopeType ct;
642829ad44c5SMatthew G. Knepley       PetscInt       dim, dE, cStart;
642929ad44c5SMatthew G. Knepley       PetscBool      simplex;
643029ad44c5SMatthew G. Knepley 
643129ad44c5SMatthew G. Knepley       /* Assume linear vertex coordinates */
643229ad44c5SMatthew G. Knepley       ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr);
643329ad44c5SMatthew G. Knepley       ierr = DMGetCoordinateDim(dm, &dE);CHKERRQ(ierr);
643429ad44c5SMatthew G. Knepley       ierr = DMPlexGetHeightStratum(cdmOld, 0, &cStart, NULL);CHKERRQ(ierr);
643529ad44c5SMatthew G. Knepley       ierr = DMPlexGetCellType(dm, cStart, &ct);CHKERRQ(ierr);
643629ad44c5SMatthew G. Knepley       switch (ct) {
643729ad44c5SMatthew G. Knepley         case DM_POLYTOPE_TRI_PRISM:
643829ad44c5SMatthew G. Knepley         case DM_POLYTOPE_TRI_PRISM_TENSOR:
643929ad44c5SMatthew G. Knepley           SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SUP, "Cannot autoamtically create coordinate space for prisms");
644029ad44c5SMatthew G. Knepley         default: break;
644129ad44c5SMatthew G. Knepley       }
644229ad44c5SMatthew G. Knepley       simplex = DMPolytopeTypeGetNumVertices(ct) == DMPolytopeTypeGetDim(ct)+1 ? PETSC_TRUE : PETSC_FALSE;
644329ad44c5SMatthew G. Knepley       ierr = PetscFECreateLagrange(PETSC_COMM_SELF, dim, dE, simplex, 1, -1, &feLinear);CHKERRQ(ierr);
644429ad44c5SMatthew G. Knepley       ierr = DMSetField(cdmOld, 0, NULL, (PetscObject) feLinear);CHKERRQ(ierr);
644529ad44c5SMatthew G. Knepley       ierr = PetscFEDestroy(&feLinear);CHKERRQ(ierr);
644629ad44c5SMatthew G. Knepley       ierr = DMCreateDS(cdmOld);CHKERRQ(ierr);
644729ad44c5SMatthew G. Knepley     } else {
644829ad44c5SMatthew G. Knepley       const char *discname;
644929ad44c5SMatthew G. Knepley 
645029ad44c5SMatthew G. Knepley       ierr = PetscObjectGetType(discOld, &discname);CHKERRQ(ierr);
645129ad44c5SMatthew G. Knepley       SETERRQ1(PetscObjectComm(discOld), PETSC_ERR_SUP, "Discretization type %s not supported", discname);
645229ad44c5SMatthew G. Knepley     }
645329ad44c5SMatthew G. Knepley   }
6454d864a3eaSLisandro Dalcin   /* Make a fresh clone of the coordinate DM */
6455d864a3eaSLisandro Dalcin   ierr = DMClone(cdmOld, &cdmNew);CHKERRQ(ierr);
6456d864a3eaSLisandro Dalcin   ierr = DMSetField(cdmNew, 0, NULL, (PetscObject) disc);CHKERRQ(ierr);
6457d864a3eaSLisandro Dalcin   ierr = DMCreateDS(cdmNew);CHKERRQ(ierr);
6458d864a3eaSLisandro Dalcin   /* Project the coordinate vector from old to new space  */
6459d864a3eaSLisandro Dalcin   ierr = DMGetCoordinates(dm, &coordsOld);CHKERRQ(ierr);
6460d864a3eaSLisandro Dalcin   ierr = DMCreateGlobalVector(cdmNew, &coordsNew);CHKERRQ(ierr);
6461d864a3eaSLisandro Dalcin   ierr = DMCreateInterpolation(cdmOld, cdmNew, &matInterp, NULL);CHKERRQ(ierr);
6462d864a3eaSLisandro Dalcin   ierr = MatInterpolate(matInterp, coordsOld, coordsNew);CHKERRQ(ierr);
6463d864a3eaSLisandro Dalcin   ierr = MatDestroy(&matInterp);CHKERRQ(ierr);
6464d864a3eaSLisandro Dalcin   /* Set new coordinate structures */
6465d864a3eaSLisandro Dalcin   ierr = DMSetCoordinateField(dm, NULL);CHKERRQ(ierr);
6466d864a3eaSLisandro Dalcin   ierr = DMSetCoordinateDM(dm, cdmNew);CHKERRQ(ierr);
6467d864a3eaSLisandro Dalcin   ierr = DMSetCoordinates(dm, coordsNew);CHKERRQ(ierr);
6468d864a3eaSLisandro Dalcin   ierr = VecDestroy(&coordsNew);CHKERRQ(ierr);
6469d864a3eaSLisandro Dalcin   ierr = DMDestroy(&cdmNew);CHKERRQ(ierr);
6470d864a3eaSLisandro Dalcin   PetscFunctionReturn(0);
6471d864a3eaSLisandro Dalcin }
6472d864a3eaSLisandro Dalcin 
64735dc8c3f7SMatthew G. Knepley /*@C
647490b157c4SStefano Zampini   DMGetPeriodicity - Get the description of mesh periodicity
64755dc8c3f7SMatthew G. Knepley 
64765dc8c3f7SMatthew G. Knepley   Input Parameters:
647790b157c4SStefano Zampini . dm      - The DM object
647890b157c4SStefano Zampini 
647990b157c4SStefano Zampini   Output Parameters:
648090b157c4SStefano Zampini + per     - Whether the DM is periodic or not
64815dc8c3f7SMatthew 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
64825dc8c3f7SMatthew G. Knepley . L       - If we assume the mesh is a torus, this is the length of each coordinate
64835dc8c3f7SMatthew G. Knepley - bd      - This describes the type of periodicity in each topological dimension
64845dc8c3f7SMatthew G. Knepley 
64855dc8c3f7SMatthew G. Knepley   Level: developer
64865dc8c3f7SMatthew G. Knepley 
64875dc8c3f7SMatthew G. Knepley .seealso: DMGetPeriodicity()
64885dc8c3f7SMatthew G. Knepley @*/
648990b157c4SStefano Zampini PetscErrorCode DMGetPeriodicity(DM dm, PetscBool *per, const PetscReal **maxCell, const PetscReal **L, const DMBoundaryType **bd)
6490c6b900c6SMatthew G. Knepley {
6491c6b900c6SMatthew G. Knepley   PetscFunctionBegin;
6492c6b900c6SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
649390b157c4SStefano Zampini   if (per)     *per     = dm->periodic;
6494c6b900c6SMatthew G. Knepley   if (L)       *L       = dm->L;
6495c6b900c6SMatthew G. Knepley   if (maxCell) *maxCell = dm->maxCell;
64965dc8c3f7SMatthew G. Knepley   if (bd)      *bd      = dm->bdtype;
6497c6b900c6SMatthew G. Knepley   PetscFunctionReturn(0);
6498c6b900c6SMatthew G. Knepley }
6499c6b900c6SMatthew G. Knepley 
65005dc8c3f7SMatthew G. Knepley /*@C
65015dc8c3f7SMatthew G. Knepley   DMSetPeriodicity - Set the description of mesh periodicity
65025dc8c3f7SMatthew G. Knepley 
65035dc8c3f7SMatthew G. Knepley   Input Parameters:
65045dc8c3f7SMatthew G. Knepley + dm      - The DM object
6505db2bf62eSStefano Zampini . per     - Whether the DM is periodic or not.
6506db2bf62eSStefano Zampini . maxCell - Over distances greater than this, we can assume a point has crossed over to another sheet, when trying to localize cell coordinates. Pass NULL to remove such information.
65075dc8c3f7SMatthew G. Knepley . L       - If we assume the mesh is a torus, this is the length of each coordinate
65085dc8c3f7SMatthew G. Knepley - bd      - This describes the type of periodicity in each topological dimension
65095dc8c3f7SMatthew G. Knepley 
6510db2bf62eSStefano Zampini   Notes: If per is PETSC_TRUE and maxCell is not provided, coordinates need to be already localized, or must be localized by hand by the user.
6511db2bf62eSStefano Zampini 
65125dc8c3f7SMatthew G. Knepley   Level: developer
65135dc8c3f7SMatthew G. Knepley 
65145dc8c3f7SMatthew G. Knepley .seealso: DMGetPeriodicity()
65155dc8c3f7SMatthew G. Knepley @*/
651690b157c4SStefano Zampini PetscErrorCode DMSetPeriodicity(DM dm, PetscBool per, const PetscReal maxCell[], const PetscReal L[], const DMBoundaryType bd[])
6517c6b900c6SMatthew G. Knepley {
6518c6b900c6SMatthew G. Knepley   PetscInt       dim, d;
6519c6b900c6SMatthew G. Knepley   PetscErrorCode ierr;
6520c6b900c6SMatthew G. Knepley 
6521c6b900c6SMatthew G. Knepley   PetscFunctionBegin;
6522c6b900c6SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
652390b157c4SStefano Zampini   PetscValidLogicalCollectiveBool(dm,per,2);
6524412e9a14SMatthew G. Knepley   if (maxCell) {PetscValidRealPointer(maxCell,3);}
6525412e9a14SMatthew G. Knepley   if (L)       {PetscValidRealPointer(L,4);}
6526412e9a14SMatthew G. Knepley   if (bd)      {PetscValidPointer(bd,5);}
65275dc8c3f7SMatthew G. Knepley   ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr);
652890b157c4SStefano Zampini   if (maxCell) {
6529412e9a14SMatthew G. Knepley     if (!dm->maxCell) {ierr = PetscMalloc1(dim, &dm->maxCell);CHKERRQ(ierr);}
6530412e9a14SMatthew G. Knepley     for (d = 0; d < dim; ++d) dm->maxCell[d] = maxCell[d];
6531db2bf62eSStefano Zampini   } else { /* remove maxCell information to disable automatic computation of localized vertices */
6532db2bf62eSStefano Zampini     ierr = PetscFree(dm->maxCell);CHKERRQ(ierr);
6533412e9a14SMatthew G. Knepley   }
6534db2bf62eSStefano Zampini 
6535412e9a14SMatthew G. Knepley   if (L) {
6536412e9a14SMatthew G. Knepley     if (!dm->L) {ierr = PetscMalloc1(dim, &dm->L);CHKERRQ(ierr);}
6537412e9a14SMatthew G. Knepley     for (d = 0; d < dim; ++d) dm->L[d] = L[d];
6538412e9a14SMatthew G. Knepley   }
6539412e9a14SMatthew G. Knepley   if (bd) {
6540412e9a14SMatthew G. Knepley     if (!dm->bdtype) {ierr = PetscMalloc1(dim, &dm->bdtype);CHKERRQ(ierr);}
6541412e9a14SMatthew G. Knepley     for (d = 0; d < dim; ++d) dm->bdtype[d] = bd[d];
654290b157c4SStefano Zampini   }
6543072d7d67SStefano Zampini   dm->periodic = per;
6544c6b900c6SMatthew G. Knepley   PetscFunctionReturn(0);
6545c6b900c6SMatthew G. Knepley }
6546c6b900c6SMatthew G. Knepley 
65472e17dfb7SMatthew G. Knepley /*@
65482e17dfb7SMatthew 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.
65492e17dfb7SMatthew G. Knepley 
65502e17dfb7SMatthew G. Knepley   Input Parameters:
65512e17dfb7SMatthew G. Knepley + dm     - The DM
655265da65dcSMatthew G. Knepley . in     - The input coordinate point (dim numbers)
655365da65dcSMatthew G. Knepley - endpoint - Include the endpoint L_i
65542e17dfb7SMatthew G. Knepley 
65552e17dfb7SMatthew G. Knepley   Output Parameter:
65562e17dfb7SMatthew G. Knepley . out - The localized coordinate point
65572e17dfb7SMatthew G. Knepley 
65582e17dfb7SMatthew G. Knepley   Level: developer
65592e17dfb7SMatthew G. Knepley 
65602e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeAddCoordinate()
65612e17dfb7SMatthew G. Knepley @*/
656265da65dcSMatthew G. Knepley PetscErrorCode DMLocalizeCoordinate(DM dm, const PetscScalar in[], PetscBool endpoint, PetscScalar out[])
65632e17dfb7SMatthew G. Knepley {
65642e17dfb7SMatthew G. Knepley   PetscInt       dim, d;
65652e17dfb7SMatthew G. Knepley   PetscErrorCode ierr;
65662e17dfb7SMatthew G. Knepley 
65672e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
65682e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &dim);CHKERRQ(ierr);
65692e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
65702e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] = in[d];
65712e17dfb7SMatthew G. Knepley   } else {
657265da65dcSMatthew G. Knepley     if (endpoint) {
657365da65dcSMatthew G. Knepley       for (d = 0; d < dim; ++d) {
6574da3333bfSMatthew G. Knepley         if ((PetscAbsReal(PetscRealPart(in[d])/dm->L[d] - PetscFloorReal(PetscRealPart(in[d])/dm->L[d])) < PETSC_SMALL) && (PetscRealPart(in[d])/dm->L[d] > PETSC_SMALL)) {
6575da3333bfSMatthew G. Knepley           out[d] = in[d] - dm->L[d]*(PetscFloorReal(PetscRealPart(in[d])/dm->L[d]) - 1);
657665da65dcSMatthew G. Knepley         } else {
6577da3333bfSMatthew G. Knepley           out[d] = in[d] - dm->L[d]*PetscFloorReal(PetscRealPart(in[d])/dm->L[d]);
657865da65dcSMatthew G. Knepley         }
657965da65dcSMatthew G. Knepley       }
658065da65dcSMatthew G. Knepley     } else {
65812e17dfb7SMatthew G. Knepley       for (d = 0; d < dim; ++d) {
65821118d4bcSLisandro Dalcin         out[d] = in[d] - dm->L[d]*PetscFloorReal(PetscRealPart(in[d])/dm->L[d]);
65832e17dfb7SMatthew G. Knepley       }
65842e17dfb7SMatthew G. Knepley     }
658565da65dcSMatthew G. Knepley   }
65862e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
65872e17dfb7SMatthew G. Knepley }
65882e17dfb7SMatthew G. Knepley 
65892e17dfb7SMatthew G. Knepley /*
65902e17dfb7SMatthew 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.
65912e17dfb7SMatthew G. Knepley 
65922e17dfb7SMatthew G. Knepley   Input Parameters:
65932e17dfb7SMatthew G. Knepley + dm     - The DM
65942e17dfb7SMatthew G. Knepley . dim    - The spatial dimension
65952e17dfb7SMatthew G. Knepley . anchor - The anchor point, the input point can be no more than maxCell away from it
65962e17dfb7SMatthew G. Knepley - in     - The input coordinate point (dim numbers)
65972e17dfb7SMatthew G. Knepley 
65982e17dfb7SMatthew G. Knepley   Output Parameter:
65992e17dfb7SMatthew G. Knepley . out - The localized coordinate point
66002e17dfb7SMatthew G. Knepley 
66012e17dfb7SMatthew G. Knepley   Level: developer
66022e17dfb7SMatthew G. Knepley 
66032e17dfb7SMatthew 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
66042e17dfb7SMatthew G. Knepley 
66052e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeAddCoordinate()
66062e17dfb7SMatthew G. Knepley */
66072e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinate_Internal(DM dm, PetscInt dim, const PetscScalar anchor[], const PetscScalar in[], PetscScalar out[])
66082e17dfb7SMatthew G. Knepley {
66092e17dfb7SMatthew G. Knepley   PetscInt d;
66102e17dfb7SMatthew G. Knepley 
66112e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
66122e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
66132e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] = in[d];
66142e17dfb7SMatthew G. Knepley   } else {
66152e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) {
6616908eca10SMatthew G. Knepley       if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsScalar(anchor[d] - in[d]) > dm->maxCell[d])) {
66172e17dfb7SMatthew G. Knepley         out[d] = PetscRealPart(anchor[d]) > PetscRealPart(in[d]) ? dm->L[d] + in[d] : in[d] - dm->L[d];
66182e17dfb7SMatthew G. Knepley       } else {
66192e17dfb7SMatthew G. Knepley         out[d] = in[d];
66202e17dfb7SMatthew G. Knepley       }
66212e17dfb7SMatthew G. Knepley     }
66222e17dfb7SMatthew G. Knepley   }
66232e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
66242e17dfb7SMatthew G. Knepley }
6625a5801f52SStefano Zampini 
66262e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinateReal_Internal(DM dm, PetscInt dim, const PetscReal anchor[], const PetscReal in[], PetscReal out[])
66272e17dfb7SMatthew G. Knepley {
66282e17dfb7SMatthew G. Knepley   PetscInt d;
66292e17dfb7SMatthew G. Knepley 
66302e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
66312e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
66322e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] = in[d];
66332e17dfb7SMatthew G. Knepley   } else {
66342e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) {
6635908eca10SMatthew G. Knepley       if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsReal(anchor[d] - in[d]) > dm->maxCell[d])) {
66362e17dfb7SMatthew G. Knepley         out[d] = anchor[d] > in[d] ? dm->L[d] + in[d] : in[d] - dm->L[d];
66372e17dfb7SMatthew G. Knepley       } else {
66382e17dfb7SMatthew G. Knepley         out[d] = in[d];
66392e17dfb7SMatthew G. Knepley       }
66402e17dfb7SMatthew G. Knepley     }
66412e17dfb7SMatthew G. Knepley   }
66422e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
66432e17dfb7SMatthew G. Knepley }
66442e17dfb7SMatthew G. Knepley 
66452e17dfb7SMatthew G. Knepley /*
66462e17dfb7SMatthew 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.
66472e17dfb7SMatthew G. Knepley 
66482e17dfb7SMatthew G. Knepley   Input Parameters:
66492e17dfb7SMatthew G. Knepley + dm     - The DM
66502e17dfb7SMatthew G. Knepley . dim    - The spatial dimension
66512e17dfb7SMatthew G. Knepley . anchor - The anchor point, the input point can be no more than maxCell away from it
66522e17dfb7SMatthew G. Knepley . in     - The input coordinate delta (dim numbers)
66532e17dfb7SMatthew G. Knepley - out    - The input coordinate point (dim numbers)
66542e17dfb7SMatthew G. Knepley 
66552e17dfb7SMatthew G. Knepley   Output Parameter:
66562e17dfb7SMatthew G. Knepley . out    - The localized coordinate in + out
66572e17dfb7SMatthew G. Knepley 
66582e17dfb7SMatthew G. Knepley   Level: developer
66592e17dfb7SMatthew G. Knepley 
66602e17dfb7SMatthew 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
66612e17dfb7SMatthew G. Knepley 
66622e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeCoordinate()
66632e17dfb7SMatthew G. Knepley */
66642e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeAddCoordinate_Internal(DM dm, PetscInt dim, const PetscScalar anchor[], const PetscScalar in[], PetscScalar out[])
66652e17dfb7SMatthew G. Knepley {
66662e17dfb7SMatthew G. Knepley   PetscInt d;
66672e17dfb7SMatthew G. Knepley 
66682e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
66692e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
66702e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] += in[d];
66712e17dfb7SMatthew G. Knepley   } else {
66722e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) {
6673412e9a14SMatthew G. Knepley       const PetscReal maxC = dm->maxCell[d];
6674412e9a14SMatthew G. Knepley 
6675412e9a14SMatthew G. Knepley       if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsScalar(anchor[d] - in[d]) > maxC)) {
6676412e9a14SMatthew G. Knepley         const PetscScalar newCoord = PetscRealPart(anchor[d]) > PetscRealPart(in[d]) ? dm->L[d] + in[d] : in[d] - dm->L[d];
6677412e9a14SMatthew G. Knepley 
6678412e9a14SMatthew G. Knepley         if (PetscAbsScalar(newCoord - anchor[d]) > maxC)
6679412e9a14SMatthew G. Knepley           SETERRQ4(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "%D-Coordinate %g more than %g away from anchor %g", d, (double) PetscRealPart(in[d]), (double) maxC, (double) PetscRealPart(anchor[d]));
6680412e9a14SMatthew G. Knepley         out[d] += newCoord;
66812e17dfb7SMatthew G. Knepley       } else {
66822e17dfb7SMatthew G. Knepley         out[d] += in[d];
66832e17dfb7SMatthew G. Knepley       }
66842e17dfb7SMatthew G. Knepley     }
66852e17dfb7SMatthew G. Knepley   }
66862e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
66872e17dfb7SMatthew G. Knepley }
66882e17dfb7SMatthew G. Knepley 
668936447a5eSToby Isaac /*@
66908f700142SStefano Zampini   DMGetCoordinatesLocalizedLocal - Check if the DM coordinates have been localized for cells on this process
66918f700142SStefano Zampini 
66928f700142SStefano Zampini   Not collective
669336447a5eSToby Isaac 
669436447a5eSToby Isaac   Input Parameter:
669536447a5eSToby Isaac . dm - The DM
669636447a5eSToby Isaac 
669736447a5eSToby Isaac   Output Parameter:
669836447a5eSToby Isaac   areLocalized - True if localized
669936447a5eSToby Isaac 
670036447a5eSToby Isaac   Level: developer
670136447a5eSToby Isaac 
67028f700142SStefano Zampini .seealso: DMLocalizeCoordinates(), DMGetCoordinatesLocalized(), DMSetPeriodicity()
670336447a5eSToby Isaac @*/
67048f700142SStefano Zampini PetscErrorCode DMGetCoordinatesLocalizedLocal(DM dm,PetscBool *areLocalized)
670536447a5eSToby Isaac {
670636447a5eSToby Isaac   DM             cdm;
670736447a5eSToby Isaac   PetscSection   coordSection;
670846a3a80fSLisandro Dalcin   PetscInt       cStart, cEnd, sStart, sEnd, c, dof;
670946a3a80fSLisandro Dalcin   PetscBool      isPlex, alreadyLocalized;
671036447a5eSToby Isaac   PetscErrorCode ierr;
671136447a5eSToby Isaac 
671236447a5eSToby Isaac   PetscFunctionBegin;
671336447a5eSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6714534a8f05SLisandro Dalcin   PetscValidBoolPointer(areLocalized, 2);
67158b09590cSToby Isaac   *areLocalized = PETSC_FALSE;
671646a3a80fSLisandro Dalcin 
671736447a5eSToby Isaac   /* We need some generic way of refering to cells/vertices */
671836447a5eSToby Isaac   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
671946a3a80fSLisandro Dalcin   ierr = PetscObjectTypeCompare((PetscObject) cdm, DMPLEX, &isPlex);CHKERRQ(ierr);
67209f7230bfSMatthew G. Knepley   if (!isPlex) PetscFunctionReturn(0);
672146a3a80fSLisandro Dalcin 
67229f7230bfSMatthew G. Knepley   ierr = DMGetCoordinateSection(dm, &coordSection);CHKERRQ(ierr);
672346a3a80fSLisandro Dalcin   ierr = DMPlexGetHeightStratum(cdm, 0, &cStart, &cEnd);CHKERRQ(ierr);
672436447a5eSToby Isaac   ierr = PetscSectionGetChart(coordSection, &sStart, &sEnd);CHKERRQ(ierr);
672536447a5eSToby Isaac   alreadyLocalized = PETSC_FALSE;
672646a3a80fSLisandro Dalcin   for (c = cStart; c < cEnd; ++c) {
672746a3a80fSLisandro Dalcin     if (c < sStart || c >= sEnd) continue;
672836447a5eSToby Isaac     ierr = PetscSectionGetDof(coordSection, c, &dof);CHKERRQ(ierr);
672946a3a80fSLisandro Dalcin     if (dof) { alreadyLocalized = PETSC_TRUE; break; }
673036447a5eSToby Isaac   }
67318f700142SStefano Zampini   *areLocalized = alreadyLocalized;
673236447a5eSToby Isaac   PetscFunctionReturn(0);
673336447a5eSToby Isaac }
673436447a5eSToby Isaac 
67358f700142SStefano Zampini /*@
67368f700142SStefano Zampini   DMGetCoordinatesLocalized - Check if the DM coordinates have been localized for cells
67378f700142SStefano Zampini 
67388f700142SStefano Zampini   Collective on dm
67398f700142SStefano Zampini 
67408f700142SStefano Zampini   Input Parameter:
67418f700142SStefano Zampini . dm - The DM
67428f700142SStefano Zampini 
67438f700142SStefano Zampini   Output Parameter:
67448f700142SStefano Zampini   areLocalized - True if localized
67458f700142SStefano Zampini 
67468f700142SStefano Zampini   Level: developer
67478f700142SStefano Zampini 
67488f700142SStefano Zampini .seealso: DMLocalizeCoordinates(), DMSetPeriodicity(), DMGetCoordinatesLocalizedLocal()
67498f700142SStefano Zampini @*/
67508f700142SStefano Zampini PetscErrorCode DMGetCoordinatesLocalized(DM dm,PetscBool *areLocalized)
67518f700142SStefano Zampini {
67528f700142SStefano Zampini   PetscBool      localized;
67538f700142SStefano Zampini   PetscErrorCode ierr;
67548f700142SStefano Zampini 
67558f700142SStefano Zampini   PetscFunctionBegin;
67568f700142SStefano Zampini   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6757534a8f05SLisandro Dalcin   PetscValidBoolPointer(areLocalized, 2);
67588f700142SStefano Zampini   ierr = DMGetCoordinatesLocalizedLocal(dm,&localized);CHKERRQ(ierr);
67598f700142SStefano Zampini   ierr = MPIU_Allreduce(&localized,areLocalized,1,MPIU_BOOL,MPI_LOR,PetscObjectComm((PetscObject)dm));CHKERRQ(ierr);
67608f700142SStefano Zampini   PetscFunctionReturn(0);
67618f700142SStefano Zampini }
676236447a5eSToby Isaac 
67632e17dfb7SMatthew G. Knepley /*@
6764492b8470SStefano Zampini   DMLocalizeCoordinates - If a mesh is periodic, create local coordinates for cells having periodic faces
67652e17dfb7SMatthew G. Knepley 
67668f700142SStefano Zampini   Collective on dm
67678f700142SStefano Zampini 
67682e17dfb7SMatthew G. Knepley   Input Parameter:
67692e17dfb7SMatthew G. Knepley . dm - The DM
67702e17dfb7SMatthew G. Knepley 
67712e17dfb7SMatthew G. Knepley   Level: developer
67722e17dfb7SMatthew G. Knepley 
67738f700142SStefano Zampini .seealso: DMSetPeriodicity(), DMLocalizeCoordinate(), DMLocalizeAddCoordinate()
67742e17dfb7SMatthew G. Knepley @*/
67752e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinates(DM dm)
67762e17dfb7SMatthew G. Knepley {
67772e17dfb7SMatthew G. Knepley   DM             cdm;
67782e17dfb7SMatthew G. Knepley   PetscSection   coordSection, cSection;
67792e17dfb7SMatthew G. Knepley   Vec            coordinates,  cVec;
67803e922f36SToby Isaac   PetscScalar   *coords, *coords2, *anchor, *localized;
67813e922f36SToby Isaac   PetscInt       Nc, vStart, vEnd, v, sStart, sEnd, newStart = PETSC_MAX_INT, newEnd = PETSC_MIN_INT, dof, d, off, off2, bs, coordSize;
6782e0ae35bbSToby Isaac   PetscBool      alreadyLocalized, alreadyLocalizedGlobal;
67833e922f36SToby Isaac   PetscInt       maxHeight = 0, h;
67843e922f36SToby Isaac   PetscInt       *pStart = NULL, *pEnd = NULL;
67852e17dfb7SMatthew G. Knepley   PetscErrorCode ierr;
67862e17dfb7SMatthew G. Knepley 
67872e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
67882e17dfb7SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
678992c9c85fSStefano Zampini   if (!dm->periodic) PetscFunctionReturn(0);
6790f7cbd40bSStefano Zampini   ierr = DMGetCoordinatesLocalized(dm, &alreadyLocalized);CHKERRQ(ierr);
6791f7cbd40bSStefano Zampini   if (alreadyLocalized) PetscFunctionReturn(0);
6792f7cbd40bSStefano Zampini 
67932e17dfb7SMatthew G. Knepley   /* We need some generic way of refering to cells/vertices */
67942e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
67952e17dfb7SMatthew G. Knepley   {
67962e17dfb7SMatthew G. Knepley     PetscBool isplex;
67972e17dfb7SMatthew G. Knepley 
67982e17dfb7SMatthew G. Knepley     ierr = PetscObjectTypeCompare((PetscObject) cdm, DMPLEX, &isplex);CHKERRQ(ierr);
67992e17dfb7SMatthew G. Knepley     if (isplex) {
68002e17dfb7SMatthew G. Knepley       ierr = DMPlexGetDepthStratum(cdm, 0, &vStart, &vEnd);CHKERRQ(ierr);
68013e922f36SToby Isaac       ierr = DMPlexGetMaxProjectionHeight(cdm,&maxHeight);CHKERRQ(ierr);
680269291d52SBarry Smith       ierr = DMGetWorkArray(dm,2*(maxHeight + 1),MPIU_INT,&pStart);CHKERRQ(ierr);
68033e922f36SToby Isaac       pEnd = &pStart[maxHeight + 1];
68043e922f36SToby Isaac       newStart = vStart;
68053e922f36SToby Isaac       newEnd   = vEnd;
68063e922f36SToby Isaac       for (h = 0; h <= maxHeight; h++) {
68073e922f36SToby Isaac         ierr = DMPlexGetHeightStratum(cdm, h, &pStart[h], &pEnd[h]);CHKERRQ(ierr);
68083e922f36SToby Isaac         newStart = PetscMin(newStart,pStart[h]);
68093e922f36SToby Isaac         newEnd   = PetscMax(newEnd,pEnd[h]);
68103e922f36SToby Isaac       }
68112e17dfb7SMatthew G. Knepley     } else SETERRQ(PetscObjectComm((PetscObject) cdm), PETSC_ERR_ARG_WRONG, "Coordinate localization requires a DMPLEX coordinate DM");
68122e17dfb7SMatthew G. Knepley   }
68132e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinatesLocal(dm, &coordinates);CHKERRQ(ierr);
681443eeeb2dSStefano Zampini   if (!coordinates) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"Missing local coordinates vector");
68152e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinateSection(dm, &coordSection);CHKERRQ(ierr);
68163e922f36SToby Isaac   ierr = VecGetBlockSize(coordinates, &bs);CHKERRQ(ierr);
6817e0ae35bbSToby Isaac   ierr = PetscSectionGetChart(coordSection,&sStart,&sEnd);CHKERRQ(ierr);
68183e922f36SToby Isaac 
68192e17dfb7SMatthew G. Knepley   ierr = PetscSectionCreate(PetscObjectComm((PetscObject) dm), &cSection);CHKERRQ(ierr);
68202e17dfb7SMatthew G. Knepley   ierr = PetscSectionSetNumFields(cSection, 1);CHKERRQ(ierr);
68212e17dfb7SMatthew G. Knepley   ierr = PetscSectionGetFieldComponents(coordSection, 0, &Nc);CHKERRQ(ierr);
68222e17dfb7SMatthew G. Knepley   ierr = PetscSectionSetFieldComponents(cSection, 0, Nc);CHKERRQ(ierr);
68233e922f36SToby Isaac   ierr = PetscSectionSetChart(cSection, newStart, newEnd);CHKERRQ(ierr);
68243e922f36SToby Isaac 
682569291d52SBarry Smith   ierr = DMGetWorkArray(dm, 2 * bs, MPIU_SCALAR, &anchor);CHKERRQ(ierr);
68263e922f36SToby Isaac   localized = &anchor[bs];
68273e922f36SToby Isaac   alreadyLocalized = alreadyLocalizedGlobal = PETSC_TRUE;
68283e922f36SToby Isaac   for (h = 0; h <= maxHeight; h++) {
68293e922f36SToby Isaac     PetscInt cStart = pStart[h], cEnd = pEnd[h], c;
68303e922f36SToby Isaac 
68313e922f36SToby Isaac     for (c = cStart; c < cEnd; ++c) {
68323e922f36SToby Isaac       PetscScalar *cellCoords = NULL;
68333e922f36SToby Isaac       PetscInt     b;
68343e922f36SToby Isaac 
68353e922f36SToby Isaac       if (c < sStart || c >= sEnd) alreadyLocalized = PETSC_FALSE;
68363e922f36SToby Isaac       ierr = DMPlexVecGetClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
68373e922f36SToby Isaac       for (b = 0; b < bs; ++b) anchor[b] = cellCoords[b];
68383e922f36SToby Isaac       for (d = 0; d < dof/bs; ++d) {
68393e922f36SToby Isaac         ierr = DMLocalizeCoordinate_Internal(dm, bs, anchor, &cellCoords[d*bs], localized);CHKERRQ(ierr);
68403e922f36SToby Isaac         for (b = 0; b < bs; b++) {
68413e922f36SToby Isaac           if (cellCoords[d*bs + b] != localized[b]) break;
68423e922f36SToby Isaac         }
68433e922f36SToby Isaac         if (b < bs) break;
68443e922f36SToby Isaac       }
68453e922f36SToby Isaac       if (d < dof/bs) {
68463e922f36SToby Isaac         if (c >= sStart && c < sEnd) {
68473e922f36SToby Isaac           PetscInt cdof;
68483e922f36SToby Isaac 
68493e922f36SToby Isaac           ierr = PetscSectionGetDof(coordSection, c, &cdof);CHKERRQ(ierr);
68503e922f36SToby Isaac           if (cdof != dof) alreadyLocalized = PETSC_FALSE;
68513e922f36SToby Isaac         }
68523e922f36SToby Isaac         ierr = PetscSectionSetDof(cSection, c, dof);CHKERRQ(ierr);
68533e922f36SToby Isaac         ierr = PetscSectionSetFieldDof(cSection, c, 0, dof);CHKERRQ(ierr);
68543e922f36SToby Isaac       }
68553e922f36SToby Isaac       ierr = DMPlexVecRestoreClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
68563e922f36SToby Isaac     }
68573e922f36SToby Isaac   }
68583e922f36SToby Isaac   ierr = MPI_Allreduce(&alreadyLocalized,&alreadyLocalizedGlobal,1,MPIU_BOOL,MPI_LAND,PetscObjectComm((PetscObject)dm));CHKERRQ(ierr);
68593e922f36SToby Isaac   if (alreadyLocalizedGlobal) {
686069291d52SBarry Smith     ierr = DMRestoreWorkArray(dm, 2 * bs, MPIU_SCALAR, &anchor);CHKERRQ(ierr);
68613e922f36SToby Isaac     ierr = PetscSectionDestroy(&cSection);CHKERRQ(ierr);
686269291d52SBarry Smith     ierr = DMRestoreWorkArray(dm,2*(maxHeight + 1),MPIU_INT,&pStart);CHKERRQ(ierr);
68633e922f36SToby Isaac     PetscFunctionReturn(0);
68643e922f36SToby Isaac   }
68652e17dfb7SMatthew G. Knepley   for (v = vStart; v < vEnd; ++v) {
68662e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetDof(coordSection, v, &dof);CHKERRQ(ierr);
68672e17dfb7SMatthew G. Knepley     ierr = PetscSectionSetDof(cSection, v, dof);CHKERRQ(ierr);
68682e17dfb7SMatthew G. Knepley     ierr = PetscSectionSetFieldDof(cSection, v, 0, dof);CHKERRQ(ierr);
68692e17dfb7SMatthew G. Knepley   }
68702e17dfb7SMatthew G. Knepley   ierr = PetscSectionSetUp(cSection);CHKERRQ(ierr);
68712e17dfb7SMatthew G. Knepley   ierr = PetscSectionGetStorageSize(cSection, &coordSize);CHKERRQ(ierr);
6872c2be7e5eSLisandro Dalcin   ierr = VecCreate(PETSC_COMM_SELF, &cVec);CHKERRQ(ierr);
68732e17dfb7SMatthew G. Knepley   ierr = PetscObjectSetName((PetscObject)cVec,"coordinates");CHKERRQ(ierr);
68742e17dfb7SMatthew G. Knepley   ierr = VecSetBlockSize(cVec, bs);CHKERRQ(ierr);
68752e17dfb7SMatthew G. Knepley   ierr = VecSetSizes(cVec, coordSize, PETSC_DETERMINE);CHKERRQ(ierr);
68762e17dfb7SMatthew G. Knepley   ierr = VecSetType(cVec, VECSTANDARD);CHKERRQ(ierr);
6877c2be7e5eSLisandro Dalcin   ierr = VecGetArrayRead(coordinates, (const PetscScalar**)&coords);CHKERRQ(ierr);
68782e17dfb7SMatthew G. Knepley   ierr = VecGetArray(cVec, &coords2);CHKERRQ(ierr);
68792e17dfb7SMatthew G. Knepley   for (v = vStart; v < vEnd; ++v) {
68802e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetDof(coordSection, v, &dof);CHKERRQ(ierr);
68812e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetOffset(coordSection, v, &off);CHKERRQ(ierr);
68822e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetOffset(cSection,     v, &off2);CHKERRQ(ierr);
68832e17dfb7SMatthew G. Knepley     for (d = 0; d < dof; ++d) coords2[off2+d] = coords[off+d];
68842e17dfb7SMatthew G. Knepley   }
68853e922f36SToby Isaac   for (h = 0; h <= maxHeight; h++) {
68863e922f36SToby Isaac     PetscInt cStart = pStart[h], cEnd = pEnd[h], c;
68873e922f36SToby Isaac 
68882e17dfb7SMatthew G. Knepley     for (c = cStart; c < cEnd; ++c) {
68892e17dfb7SMatthew G. Knepley       PetscScalar *cellCoords = NULL;
68903e922f36SToby Isaac       PetscInt     b, cdof;
68912e17dfb7SMatthew G. Knepley 
68923e922f36SToby Isaac       ierr = PetscSectionGetDof(cSection,c,&cdof);CHKERRQ(ierr);
68933e922f36SToby Isaac       if (!cdof) continue;
68942e17dfb7SMatthew G. Knepley       ierr = DMPlexVecGetClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
68952e17dfb7SMatthew G. Knepley       ierr = PetscSectionGetOffset(cSection, c, &off2);CHKERRQ(ierr);
68962e17dfb7SMatthew G. Knepley       for (b = 0; b < bs; ++b) anchor[b] = cellCoords[b];
68972e17dfb7SMatthew G. Knepley       for (d = 0; d < dof/bs; ++d) {ierr = DMLocalizeCoordinate_Internal(dm, bs, anchor, &cellCoords[d*bs], &coords2[off2+d*bs]);CHKERRQ(ierr);}
68982e17dfb7SMatthew G. Knepley       ierr = DMPlexVecRestoreClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
68992e17dfb7SMatthew G. Knepley     }
69003e922f36SToby Isaac   }
690169291d52SBarry Smith   ierr = DMRestoreWorkArray(dm, 2 * bs, MPIU_SCALAR, &anchor);CHKERRQ(ierr);
690269291d52SBarry Smith   ierr = DMRestoreWorkArray(dm,2*(maxHeight + 1),MPIU_INT,&pStart);CHKERRQ(ierr);
6903c2be7e5eSLisandro Dalcin   ierr = VecRestoreArrayRead(coordinates, (const PetscScalar**)&coords);CHKERRQ(ierr);
69042e17dfb7SMatthew G. Knepley   ierr = VecRestoreArray(cVec, &coords2);CHKERRQ(ierr);
69052e17dfb7SMatthew G. Knepley   ierr = DMSetCoordinateSection(dm, PETSC_DETERMINE, cSection);CHKERRQ(ierr);
69062e17dfb7SMatthew G. Knepley   ierr = DMSetCoordinatesLocal(dm, cVec);CHKERRQ(ierr);
69072e17dfb7SMatthew G. Knepley   ierr = VecDestroy(&cVec);CHKERRQ(ierr);
69082e17dfb7SMatthew G. Knepley   ierr = PetscSectionDestroy(&cSection);CHKERRQ(ierr);
69092e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
69102e17dfb7SMatthew G. Knepley }
69112e17dfb7SMatthew G. Knepley 
6912e87bb0d3SMatthew G Knepley /*@
69133a93e3b7SToby Isaac   DMLocatePoints - Locate the points in v in the mesh and return a PetscSF of the containing cells
6914e87bb0d3SMatthew G Knepley 
6915d083f849SBarry Smith   Collective on v (see explanation below)
6916e87bb0d3SMatthew G Knepley 
6917e87bb0d3SMatthew G Knepley   Input Parameters:
6918e87bb0d3SMatthew G Knepley + dm - The DM
69193a93e3b7SToby Isaac . v - The Vec of points
692062a38674SMatthew G. Knepley . ltype - The type of point location, e.g. DM_POINTLOCATION_NONE or DM_POINTLOCATION_NEAREST
69213a93e3b7SToby Isaac - cells - Points to either NULL, or a PetscSF with guesses for which cells contain each point.
6922e87bb0d3SMatthew G Knepley 
692361e3bb9bSMatthew G Knepley   Output Parameter:
692462a38674SMatthew G. Knepley + v - The Vec of points, which now contains the nearest mesh points to the given points if DM_POINTLOCATION_NEAREST is used
692562a38674SMatthew G. Knepley - cells - The PetscSF containing the ranks and local indices of the containing points.
69263a93e3b7SToby Isaac 
6927e87bb0d3SMatthew G Knepley 
6928e87bb0d3SMatthew G Knepley   Level: developer
692961e3bb9bSMatthew G Knepley 
693062a38674SMatthew G. Knepley   Notes:
69313a93e3b7SToby Isaac   To do a search of the local cells of the mesh, v should have PETSC_COMM_SELF as its communicator.
693262a38674SMatthew G. Knepley   To do a search of all the cells in the distributed mesh, v should have the same communicator as dm.
69333a93e3b7SToby Isaac 
69343a93e3b7SToby Isaac   If *cellSF is NULL on input, a PetscSF will be created.
693562a38674SMatthew G. Knepley   If *cellSF is not NULL on input, it should point to an existing PetscSF, whose graph will be used as initial guesses.
69363a93e3b7SToby Isaac 
69373a93e3b7SToby Isaac   An array that maps each point to its containing cell can be obtained with
69383a93e3b7SToby Isaac 
693962a38674SMatthew G. Knepley $    const PetscSFNode *cells;
694062a38674SMatthew G. Knepley $    PetscInt           nFound;
6941a6216909SToby Isaac $    const PetscInt    *found;
694262a38674SMatthew G. Knepley $
6943a6216909SToby Isaac $    PetscSFGetGraph(cellSF,NULL,&nFound,&found,&cells);
69443a93e3b7SToby Isaac 
69453a93e3b7SToby 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
69463a93e3b7SToby Isaac   the index of the cell in its rank's local numbering.
69473a93e3b7SToby Isaac 
694862a38674SMatthew G. Knepley .seealso: DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal(), DMPointLocationType
694961e3bb9bSMatthew G Knepley @*/
695062a38674SMatthew G. Knepley PetscErrorCode DMLocatePoints(DM dm, Vec v, DMPointLocationType ltype, PetscSF *cellSF)
6951e87bb0d3SMatthew G Knepley {
6952735aa83eSMatthew G Knepley   PetscErrorCode ierr;
6953735aa83eSMatthew G Knepley 
6954e87bb0d3SMatthew G Knepley   PetscFunctionBegin;
6955e87bb0d3SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6956e87bb0d3SMatthew G Knepley   PetscValidHeaderSpecific(v,VEC_CLASSID,2);
6957e0fc9d1bSMatthew G. Knepley   PetscValidPointer(cellSF,4);
69583a93e3b7SToby Isaac   if (*cellSF) {
69593a93e3b7SToby Isaac     PetscMPIInt result;
69603a93e3b7SToby Isaac 
6961e0fc9d1bSMatthew G. Knepley     PetscValidHeaderSpecific(*cellSF,PETSCSF_CLASSID,4);
6962a4f09dd6SDave May     ierr = MPI_Comm_compare(PetscObjectComm((PetscObject)v),PetscObjectComm((PetscObject)*cellSF),&result);CHKERRQ(ierr);
69633a93e3b7SToby 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");
6964e0fc9d1bSMatthew G. Knepley   } else {
69653a93e3b7SToby Isaac     ierr = PetscSFCreate(PetscObjectComm((PetscObject)v),cellSF);CHKERRQ(ierr);
69663a93e3b7SToby Isaac   }
6967b9d85ea2SLisandro Dalcin   if (!dm->ops->locatepoints) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Point location not available for this DM");
696847a35634SPatrick Farrell   ierr = PetscLogEventBegin(DM_LocatePoints,dm,0,0,0);CHKERRQ(ierr);
696962a38674SMatthew G. Knepley   ierr = (*dm->ops->locatepoints)(dm,v,ltype,*cellSF);CHKERRQ(ierr);
697047a35634SPatrick Farrell   ierr = PetscLogEventEnd(DM_LocatePoints,dm,0,0,0);CHKERRQ(ierr);
6971e87bb0d3SMatthew G Knepley   PetscFunctionReturn(0);
6972e87bb0d3SMatthew G Knepley }
697314f150ffSMatthew G. Knepley 
6974f4d763aaSMatthew G. Knepley /*@
6975f4d763aaSMatthew G. Knepley   DMGetOutputDM - Retrieve the DM associated with the layout for output
6976f4d763aaSMatthew G. Knepley 
69778f700142SStefano Zampini   Collective on dm
69788f700142SStefano Zampini 
6979f4d763aaSMatthew G. Knepley   Input Parameter:
6980f4d763aaSMatthew G. Knepley . dm - The original DM
6981f4d763aaSMatthew G. Knepley 
6982f4d763aaSMatthew G. Knepley   Output Parameter:
6983f4d763aaSMatthew G. Knepley . odm - The DM which provides the layout for output
6984f4d763aaSMatthew G. Knepley 
6985f4d763aaSMatthew G. Knepley   Level: intermediate
6986f4d763aaSMatthew G. Knepley 
6987e87a4003SBarry Smith .seealso: VecView(), DMGetGlobalSection()
6988f4d763aaSMatthew G. Knepley @*/
698914f150ffSMatthew G. Knepley PetscErrorCode DMGetOutputDM(DM dm, DM *odm)
699014f150ffSMatthew G. Knepley {
6991c26acbdeSMatthew G. Knepley   PetscSection   section;
69922d4e4a49SMatthew G. Knepley   PetscBool      hasConstraints, ghasConstraints;
699314f150ffSMatthew G. Knepley   PetscErrorCode ierr;
699414f150ffSMatthew G. Knepley 
699514f150ffSMatthew G. Knepley   PetscFunctionBegin;
699614f150ffSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
699714f150ffSMatthew G. Knepley   PetscValidPointer(odm,2);
699892fd8e1eSJed Brown   ierr = DMGetLocalSection(dm, &section);CHKERRQ(ierr);
6999c26acbdeSMatthew G. Knepley   ierr = PetscSectionHasConstraints(section, &hasConstraints);CHKERRQ(ierr);
7000127fe6b9SMatthew G. Knepley   ierr = MPI_Allreduce(&hasConstraints, &ghasConstraints, 1, MPIU_BOOL, MPI_LOR, PetscObjectComm((PetscObject) dm));CHKERRQ(ierr);
70012d4e4a49SMatthew G. Knepley   if (!ghasConstraints) {
7002c26acbdeSMatthew G. Knepley     *odm = dm;
7003c26acbdeSMatthew G. Knepley     PetscFunctionReturn(0);
7004c26acbdeSMatthew G. Knepley   }
700514f150ffSMatthew G. Knepley   if (!dm->dmBC) {
7006c26acbdeSMatthew G. Knepley     PetscSection newSection, gsection;
700714f150ffSMatthew G. Knepley     PetscSF      sf;
700814f150ffSMatthew G. Knepley 
700914f150ffSMatthew G. Knepley     ierr = DMClone(dm, &dm->dmBC);CHKERRQ(ierr);
7010e5e52638SMatthew G. Knepley     ierr = DMCopyDisc(dm, dm->dmBC);CHKERRQ(ierr);
701114f150ffSMatthew G. Knepley     ierr = PetscSectionClone(section, &newSection);CHKERRQ(ierr);
701292fd8e1eSJed Brown     ierr = DMSetLocalSection(dm->dmBC, newSection);CHKERRQ(ierr);
701314f150ffSMatthew G. Knepley     ierr = PetscSectionDestroy(&newSection);CHKERRQ(ierr);
701414f150ffSMatthew G. Knepley     ierr = DMGetPointSF(dm->dmBC, &sf);CHKERRQ(ierr);
701515b58121SMatthew G. Knepley     ierr = PetscSectionCreateGlobalSection(section, sf, PETSC_TRUE, PETSC_FALSE, &gsection);CHKERRQ(ierr);
7016e87a4003SBarry Smith     ierr = DMSetGlobalSection(dm->dmBC, gsection);CHKERRQ(ierr);
701714f150ffSMatthew G. Knepley     ierr = PetscSectionDestroy(&gsection);CHKERRQ(ierr);
701814f150ffSMatthew G. Knepley   }
701914f150ffSMatthew G. Knepley   *odm = dm->dmBC;
702014f150ffSMatthew G. Knepley   PetscFunctionReturn(0);
702114f150ffSMatthew G. Knepley }
7022f4d763aaSMatthew G. Knepley 
7023f4d763aaSMatthew G. Knepley /*@
7024cdb7a50dSMatthew G. Knepley   DMGetOutputSequenceNumber - Retrieve the sequence number/value for output
7025f4d763aaSMatthew G. Knepley 
7026f4d763aaSMatthew G. Knepley   Input Parameter:
7027f4d763aaSMatthew G. Knepley . dm - The original DM
7028f4d763aaSMatthew G. Knepley 
7029cdb7a50dSMatthew G. Knepley   Output Parameters:
7030cdb7a50dSMatthew G. Knepley + num - The output sequence number
7031cdb7a50dSMatthew G. Knepley - val - The output sequence value
7032f4d763aaSMatthew G. Knepley 
7033f4d763aaSMatthew G. Knepley   Level: intermediate
7034f4d763aaSMatthew G. Knepley 
7035f4d763aaSMatthew G. Knepley   Note: This is intended for output that should appear in sequence, for instance
7036f4d763aaSMatthew G. Knepley   a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system.
7037f4d763aaSMatthew G. Knepley 
7038f4d763aaSMatthew G. Knepley .seealso: VecView()
7039f4d763aaSMatthew G. Knepley @*/
7040cdb7a50dSMatthew G. Knepley PetscErrorCode DMGetOutputSequenceNumber(DM dm, PetscInt *num, PetscReal *val)
7041f4d763aaSMatthew G. Knepley {
7042f4d763aaSMatthew G. Knepley   PetscFunctionBegin;
7043f4d763aaSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
7044534a8f05SLisandro Dalcin   if (num) {PetscValidIntPointer(num,2); *num = dm->outputSequenceNum;}
7045534a8f05SLisandro Dalcin   if (val) {PetscValidRealPointer(val,3);*val = dm->outputSequenceVal;}
7046f4d763aaSMatthew G. Knepley   PetscFunctionReturn(0);
7047f4d763aaSMatthew G. Knepley }
7048f4d763aaSMatthew G. Knepley 
7049f4d763aaSMatthew G. Knepley /*@
7050cdb7a50dSMatthew G. Knepley   DMSetOutputSequenceNumber - Set the sequence number/value for output
7051f4d763aaSMatthew G. Knepley 
7052f4d763aaSMatthew G. Knepley   Input Parameters:
7053f4d763aaSMatthew G. Knepley + dm - The original DM
7054cdb7a50dSMatthew G. Knepley . num - The output sequence number
7055cdb7a50dSMatthew G. Knepley - val - The output sequence value
7056f4d763aaSMatthew G. Knepley 
7057f4d763aaSMatthew G. Knepley   Level: intermediate
7058f4d763aaSMatthew G. Knepley 
7059f4d763aaSMatthew G. Knepley   Note: This is intended for output that should appear in sequence, for instance
7060f4d763aaSMatthew G. Knepley   a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system.
7061f4d763aaSMatthew G. Knepley 
7062f4d763aaSMatthew G. Knepley .seealso: VecView()
7063f4d763aaSMatthew G. Knepley @*/
7064cdb7a50dSMatthew G. Knepley PetscErrorCode DMSetOutputSequenceNumber(DM dm, PetscInt num, PetscReal val)
7065f4d763aaSMatthew G. Knepley {
7066f4d763aaSMatthew G. Knepley   PetscFunctionBegin;
7067f4d763aaSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
7068f4d763aaSMatthew G. Knepley   dm->outputSequenceNum = num;
7069cdb7a50dSMatthew G. Knepley   dm->outputSequenceVal = val;
7070cdb7a50dSMatthew G. Knepley   PetscFunctionReturn(0);
7071cdb7a50dSMatthew G. Knepley }
7072cdb7a50dSMatthew G. Knepley 
7073cdb7a50dSMatthew G. Knepley /*@C
7074cdb7a50dSMatthew G. Knepley   DMOutputSequenceLoad - Retrieve the sequence value from a Viewer
7075cdb7a50dSMatthew G. Knepley 
7076cdb7a50dSMatthew G. Knepley   Input Parameters:
7077cdb7a50dSMatthew G. Knepley + dm   - The original DM
7078cdb7a50dSMatthew G. Knepley . name - The sequence name
7079cdb7a50dSMatthew G. Knepley - num  - The output sequence number
7080cdb7a50dSMatthew G. Knepley 
7081cdb7a50dSMatthew G. Knepley   Output Parameter:
7082cdb7a50dSMatthew G. Knepley . val  - The output sequence value
7083cdb7a50dSMatthew G. Knepley 
7084cdb7a50dSMatthew G. Knepley   Level: intermediate
7085cdb7a50dSMatthew G. Knepley 
7086cdb7a50dSMatthew G. Knepley   Note: This is intended for output that should appear in sequence, for instance
7087cdb7a50dSMatthew G. Knepley   a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system.
7088cdb7a50dSMatthew G. Knepley 
7089cdb7a50dSMatthew G. Knepley .seealso: DMGetOutputSequenceNumber(), DMSetOutputSequenceNumber(), VecView()
7090cdb7a50dSMatthew G. Knepley @*/
7091cdb7a50dSMatthew G. Knepley PetscErrorCode DMOutputSequenceLoad(DM dm, PetscViewer viewer, const char *name, PetscInt num, PetscReal *val)
7092cdb7a50dSMatthew G. Knepley {
7093cdb7a50dSMatthew G. Knepley   PetscBool      ishdf5;
7094cdb7a50dSMatthew G. Knepley   PetscErrorCode ierr;
7095cdb7a50dSMatthew G. Knepley 
7096cdb7a50dSMatthew G. Knepley   PetscFunctionBegin;
7097cdb7a50dSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
7098cdb7a50dSMatthew G. Knepley   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
7099534a8f05SLisandro Dalcin   PetscValidRealPointer(val,4);
7100cdb7a50dSMatthew G. Knepley   ierr = PetscObjectTypeCompare((PetscObject) viewer, PETSCVIEWERHDF5, &ishdf5);CHKERRQ(ierr);
7101cdb7a50dSMatthew G. Knepley   if (ishdf5) {
7102cdb7a50dSMatthew G. Knepley #if defined(PETSC_HAVE_HDF5)
7103cdb7a50dSMatthew G. Knepley     PetscScalar value;
7104cdb7a50dSMatthew G. Knepley 
710539d25373SMatthew G. Knepley     ierr = DMSequenceLoad_HDF5_Internal(dm, name, num, &value, viewer);CHKERRQ(ierr);
71064aeb217fSMatthew G. Knepley     *val = PetscRealPart(value);
7107cdb7a50dSMatthew G. Knepley #endif
7108cdb7a50dSMatthew G. Knepley   } else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Invalid viewer; open viewer with PetscViewerHDF5Open()");
7109f4d763aaSMatthew G. Knepley   PetscFunctionReturn(0);
7110f4d763aaSMatthew G. Knepley }
71118e4ac7eaSMatthew G. Knepley 
71128e4ac7eaSMatthew G. Knepley /*@
71138e4ac7eaSMatthew G. Knepley   DMGetUseNatural - Get the flag for creating a mapping to the natural order on distribution
71148e4ac7eaSMatthew G. Knepley 
71158e4ac7eaSMatthew G. Knepley   Not collective
71168e4ac7eaSMatthew G. Knepley 
71178e4ac7eaSMatthew G. Knepley   Input Parameter:
71188e4ac7eaSMatthew G. Knepley . dm - The DM
71198e4ac7eaSMatthew G. Knepley 
71208e4ac7eaSMatthew G. Knepley   Output Parameter:
71218e4ac7eaSMatthew G. Knepley . useNatural - The flag to build the mapping to a natural order during distribution
71228e4ac7eaSMatthew G. Knepley 
71238e4ac7eaSMatthew G. Knepley   Level: beginner
71248e4ac7eaSMatthew G. Knepley 
71258e4ac7eaSMatthew G. Knepley .seealso: DMSetUseNatural(), DMCreate()
71268e4ac7eaSMatthew G. Knepley @*/
71278e4ac7eaSMatthew G. Knepley PetscErrorCode DMGetUseNatural(DM dm, PetscBool *useNatural)
71288e4ac7eaSMatthew G. Knepley {
71298e4ac7eaSMatthew G. Knepley   PetscFunctionBegin;
71308e4ac7eaSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7131534a8f05SLisandro Dalcin   PetscValidBoolPointer(useNatural, 2);
71328e4ac7eaSMatthew G. Knepley   *useNatural = dm->useNatural;
71338e4ac7eaSMatthew G. Knepley   PetscFunctionReturn(0);
71348e4ac7eaSMatthew G. Knepley }
71358e4ac7eaSMatthew G. Knepley 
71368e4ac7eaSMatthew G. Knepley /*@
71375d3b26e6SMatthew G. Knepley   DMSetUseNatural - Set the flag for creating a mapping to the natural order after distribution
71388e4ac7eaSMatthew G. Knepley 
71398e4ac7eaSMatthew G. Knepley   Collective on dm
71408e4ac7eaSMatthew G. Knepley 
71418e4ac7eaSMatthew G. Knepley   Input Parameters:
71428e4ac7eaSMatthew G. Knepley + dm - The DM
71438e4ac7eaSMatthew G. Knepley - useNatural - The flag to build the mapping to a natural order during distribution
71448e4ac7eaSMatthew G. Knepley 
71455d3b26e6SMatthew G. Knepley   Note: This also causes the map to be build after DMCreateSubDM() and DMCreateSuperDM()
71465d3b26e6SMatthew G. Knepley 
71478e4ac7eaSMatthew G. Knepley   Level: beginner
71488e4ac7eaSMatthew G. Knepley 
71495d3b26e6SMatthew G. Knepley .seealso: DMGetUseNatural(), DMCreate(), DMPlexDistribute(), DMCreateSubDM(), DMCreateSuperDM()
71508e4ac7eaSMatthew G. Knepley @*/
71518e4ac7eaSMatthew G. Knepley PetscErrorCode DMSetUseNatural(DM dm, PetscBool useNatural)
71528e4ac7eaSMatthew G. Knepley {
71538e4ac7eaSMatthew G. Knepley   PetscFunctionBegin;
71548e4ac7eaSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
71558833efb5SBlaise Bourdin   PetscValidLogicalCollectiveBool(dm, useNatural, 2);
71568e4ac7eaSMatthew G. Knepley   dm->useNatural = useNatural;
71578e4ac7eaSMatthew G. Knepley   PetscFunctionReturn(0);
71588e4ac7eaSMatthew G. Knepley }
7159c58f1c22SToby Isaac 
7160c58f1c22SToby Isaac 
7161c58f1c22SToby Isaac /*@C
7162c58f1c22SToby Isaac   DMCreateLabel - Create a label of the given name if it does not already exist
7163c58f1c22SToby Isaac 
7164c58f1c22SToby Isaac   Not Collective
7165c58f1c22SToby Isaac 
7166c58f1c22SToby Isaac   Input Parameters:
7167c58f1c22SToby Isaac + dm   - The DM object
7168c58f1c22SToby Isaac - name - The label name
7169c58f1c22SToby Isaac 
7170c58f1c22SToby Isaac   Level: intermediate
7171c58f1c22SToby Isaac 
7172c58f1c22SToby Isaac .seealso: DMLabelCreate(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7173c58f1c22SToby Isaac @*/
7174c58f1c22SToby Isaac PetscErrorCode DMCreateLabel(DM dm, const char name[])
7175c58f1c22SToby Isaac {
71765d80c0bfSVaclav Hapla   PetscBool      flg;
71775d80c0bfSVaclav Hapla   DMLabel        label;
7178c58f1c22SToby Isaac   PetscErrorCode ierr;
7179c58f1c22SToby Isaac 
7180c58f1c22SToby Isaac   PetscFunctionBegin;
7181c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7182c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
71835d80c0bfSVaclav Hapla   ierr = DMHasLabel(dm, name, &flg);CHKERRQ(ierr);
7184c58f1c22SToby Isaac   if (!flg) {
71855d80c0bfSVaclav Hapla     ierr = DMLabelCreate(PETSC_COMM_SELF, name, &label);CHKERRQ(ierr);
71865d80c0bfSVaclav Hapla     ierr = DMAddLabel(dm, label);CHKERRQ(ierr);
71875d80c0bfSVaclav Hapla     ierr = DMLabelDestroy(&label);CHKERRQ(ierr);
7188c58f1c22SToby Isaac   }
7189c58f1c22SToby Isaac   PetscFunctionReturn(0);
7190c58f1c22SToby Isaac }
7191c58f1c22SToby Isaac 
7192c58f1c22SToby Isaac /*@C
7193c58f1c22SToby Isaac   DMGetLabelValue - Get the value in a Sieve Label for the given point, with 0 as the default
7194c58f1c22SToby Isaac 
7195c58f1c22SToby Isaac   Not Collective
7196c58f1c22SToby Isaac 
7197c58f1c22SToby Isaac   Input Parameters:
7198c58f1c22SToby Isaac + dm   - The DM object
7199c58f1c22SToby Isaac . name - The label name
7200c58f1c22SToby Isaac - point - The mesh point
7201c58f1c22SToby Isaac 
7202c58f1c22SToby Isaac   Output Parameter:
7203c58f1c22SToby Isaac . value - The label value for this point, or -1 if the point is not in the label
7204c58f1c22SToby Isaac 
7205c58f1c22SToby Isaac   Level: beginner
7206c58f1c22SToby Isaac 
7207c58f1c22SToby Isaac .seealso: DMLabelGetValue(), DMSetLabelValue(), DMGetStratumIS()
7208c58f1c22SToby Isaac @*/
7209c58f1c22SToby Isaac PetscErrorCode DMGetLabelValue(DM dm, const char name[], PetscInt point, PetscInt *value)
7210c58f1c22SToby Isaac {
7211c58f1c22SToby Isaac   DMLabel        label;
7212c58f1c22SToby Isaac   PetscErrorCode ierr;
7213c58f1c22SToby Isaac 
7214c58f1c22SToby Isaac   PetscFunctionBegin;
7215c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7216c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7217c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
721813903a91SSatish Balay   if (!label) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "No label named %s was found", name);
7219c58f1c22SToby Isaac   ierr = DMLabelGetValue(label, point, value);CHKERRQ(ierr);
7220c58f1c22SToby Isaac   PetscFunctionReturn(0);
7221c58f1c22SToby Isaac }
7222c58f1c22SToby Isaac 
7223c58f1c22SToby Isaac /*@C
7224c58f1c22SToby Isaac   DMSetLabelValue - Add a point to a Sieve Label with given value
7225c58f1c22SToby Isaac 
7226c58f1c22SToby Isaac   Not Collective
7227c58f1c22SToby Isaac 
7228c58f1c22SToby Isaac   Input Parameters:
7229c58f1c22SToby Isaac + dm   - The DM object
7230c58f1c22SToby Isaac . name - The label name
7231c58f1c22SToby Isaac . point - The mesh point
7232c58f1c22SToby Isaac - value - The label value for this point
7233c58f1c22SToby Isaac 
7234c58f1c22SToby Isaac   Output Parameter:
7235c58f1c22SToby Isaac 
7236c58f1c22SToby Isaac   Level: beginner
7237c58f1c22SToby Isaac 
7238c58f1c22SToby Isaac .seealso: DMLabelSetValue(), DMGetStratumIS(), DMClearLabelValue()
7239c58f1c22SToby Isaac @*/
7240c58f1c22SToby Isaac PetscErrorCode DMSetLabelValue(DM dm, const char name[], PetscInt point, PetscInt value)
7241c58f1c22SToby Isaac {
7242c58f1c22SToby Isaac   DMLabel        label;
7243c58f1c22SToby Isaac   PetscErrorCode ierr;
7244c58f1c22SToby Isaac 
7245c58f1c22SToby Isaac   PetscFunctionBegin;
7246c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7247c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7248c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7249c58f1c22SToby Isaac   if (!label) {
7250c58f1c22SToby Isaac     ierr = DMCreateLabel(dm, name);CHKERRQ(ierr);
7251c58f1c22SToby Isaac     ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7252c58f1c22SToby Isaac   }
7253c58f1c22SToby Isaac   ierr = DMLabelSetValue(label, point, value);CHKERRQ(ierr);
7254c58f1c22SToby Isaac   PetscFunctionReturn(0);
7255c58f1c22SToby Isaac }
7256c58f1c22SToby Isaac 
7257c58f1c22SToby Isaac /*@C
7258c58f1c22SToby Isaac   DMClearLabelValue - Remove a point from a Sieve Label with given value
7259c58f1c22SToby Isaac 
7260c58f1c22SToby Isaac   Not Collective
7261c58f1c22SToby Isaac 
7262c58f1c22SToby Isaac   Input Parameters:
7263c58f1c22SToby Isaac + dm   - The DM object
7264c58f1c22SToby Isaac . name - The label name
7265c58f1c22SToby Isaac . point - The mesh point
7266c58f1c22SToby Isaac - value - The label value for this point
7267c58f1c22SToby Isaac 
7268c58f1c22SToby Isaac   Output Parameter:
7269c58f1c22SToby Isaac 
7270c58f1c22SToby Isaac   Level: beginner
7271c58f1c22SToby Isaac 
7272c58f1c22SToby Isaac .seealso: DMLabelClearValue(), DMSetLabelValue(), DMGetStratumIS()
7273c58f1c22SToby Isaac @*/
7274c58f1c22SToby Isaac PetscErrorCode DMClearLabelValue(DM dm, const char name[], PetscInt point, PetscInt value)
7275c58f1c22SToby Isaac {
7276c58f1c22SToby Isaac   DMLabel        label;
7277c58f1c22SToby Isaac   PetscErrorCode ierr;
7278c58f1c22SToby Isaac 
7279c58f1c22SToby Isaac   PetscFunctionBegin;
7280c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7281c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7282c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7283c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
7284c58f1c22SToby Isaac   ierr = DMLabelClearValue(label, point, value);CHKERRQ(ierr);
7285c58f1c22SToby Isaac   PetscFunctionReturn(0);
7286c58f1c22SToby Isaac }
7287c58f1c22SToby Isaac 
7288c58f1c22SToby Isaac /*@C
7289c58f1c22SToby Isaac   DMGetLabelSize - Get the number of different integer ids in a Label
7290c58f1c22SToby Isaac 
7291c58f1c22SToby Isaac   Not Collective
7292c58f1c22SToby Isaac 
7293c58f1c22SToby Isaac   Input Parameters:
7294c58f1c22SToby Isaac + dm   - The DM object
7295c58f1c22SToby Isaac - name - The label name
7296c58f1c22SToby Isaac 
7297c58f1c22SToby Isaac   Output Parameter:
7298c58f1c22SToby Isaac . size - The number of different integer ids, or 0 if the label does not exist
7299c58f1c22SToby Isaac 
7300c58f1c22SToby Isaac   Level: beginner
7301c58f1c22SToby Isaac 
7302df813f42SMatthew G. Knepley .seealso: DMLabelGetNumValues(), DMSetLabelValue()
7303c58f1c22SToby Isaac @*/
7304c58f1c22SToby Isaac PetscErrorCode DMGetLabelSize(DM dm, const char name[], PetscInt *size)
7305c58f1c22SToby Isaac {
7306c58f1c22SToby Isaac   DMLabel        label;
7307c58f1c22SToby Isaac   PetscErrorCode ierr;
7308c58f1c22SToby Isaac 
7309c58f1c22SToby Isaac   PetscFunctionBegin;
7310c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7311c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7312534a8f05SLisandro Dalcin   PetscValidIntPointer(size, 3);
7313c58f1c22SToby Isaac   ierr  = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7314c58f1c22SToby Isaac   *size = 0;
7315c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
7316c58f1c22SToby Isaac   ierr = DMLabelGetNumValues(label, size);CHKERRQ(ierr);
7317c58f1c22SToby Isaac   PetscFunctionReturn(0);
7318c58f1c22SToby Isaac }
7319c58f1c22SToby Isaac 
7320c58f1c22SToby Isaac /*@C
7321c58f1c22SToby Isaac   DMGetLabelIdIS - Get the integer ids in a label
7322c58f1c22SToby Isaac 
7323c58f1c22SToby Isaac   Not Collective
7324c58f1c22SToby Isaac 
7325c58f1c22SToby Isaac   Input Parameters:
7326c58f1c22SToby Isaac + mesh - The DM object
7327c58f1c22SToby Isaac - name - The label name
7328c58f1c22SToby Isaac 
7329c58f1c22SToby Isaac   Output Parameter:
7330c58f1c22SToby Isaac . ids - The integer ids, or NULL if the label does not exist
7331c58f1c22SToby Isaac 
7332c58f1c22SToby Isaac   Level: beginner
7333c58f1c22SToby Isaac 
7334c58f1c22SToby Isaac .seealso: DMLabelGetValueIS(), DMGetLabelSize()
7335c58f1c22SToby Isaac @*/
7336c58f1c22SToby Isaac PetscErrorCode DMGetLabelIdIS(DM dm, const char name[], IS *ids)
7337c58f1c22SToby Isaac {
7338c58f1c22SToby Isaac   DMLabel        label;
7339c58f1c22SToby Isaac   PetscErrorCode ierr;
7340c58f1c22SToby Isaac 
7341c58f1c22SToby Isaac   PetscFunctionBegin;
7342c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7343c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7344c58f1c22SToby Isaac   PetscValidPointer(ids, 3);
7345c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7346c58f1c22SToby Isaac   *ids = NULL;
7347dab2e251SBlaise Bourdin  if (label) {
7348c58f1c22SToby Isaac     ierr = DMLabelGetValueIS(label, ids);CHKERRQ(ierr);
7349dab2e251SBlaise Bourdin   } else {
7350dab2e251SBlaise Bourdin     /* returning an empty IS */
7351dab2e251SBlaise Bourdin     ierr = ISCreateGeneral(PETSC_COMM_SELF,0,NULL,PETSC_USE_POINTER,ids);CHKERRQ(ierr);
7352dab2e251SBlaise Bourdin   }
7353c58f1c22SToby Isaac   PetscFunctionReturn(0);
7354c58f1c22SToby Isaac }
7355c58f1c22SToby Isaac 
7356c58f1c22SToby Isaac /*@C
7357c58f1c22SToby Isaac   DMGetStratumSize - Get the number of points in a label stratum
7358c58f1c22SToby Isaac 
7359c58f1c22SToby Isaac   Not Collective
7360c58f1c22SToby Isaac 
7361c58f1c22SToby Isaac   Input Parameters:
7362c58f1c22SToby Isaac + dm - The DM object
7363c58f1c22SToby Isaac . name - The label name
7364c58f1c22SToby Isaac - value - The stratum value
7365c58f1c22SToby Isaac 
7366c58f1c22SToby Isaac   Output Parameter:
7367c58f1c22SToby Isaac . size - The stratum size
7368c58f1c22SToby Isaac 
7369c58f1c22SToby Isaac   Level: beginner
7370c58f1c22SToby Isaac 
7371c58f1c22SToby Isaac .seealso: DMLabelGetStratumSize(), DMGetLabelSize(), DMGetLabelIds()
7372c58f1c22SToby Isaac @*/
7373c58f1c22SToby Isaac PetscErrorCode DMGetStratumSize(DM dm, const char name[], PetscInt value, PetscInt *size)
7374c58f1c22SToby Isaac {
7375c58f1c22SToby Isaac   DMLabel        label;
7376c58f1c22SToby Isaac   PetscErrorCode ierr;
7377c58f1c22SToby Isaac 
7378c58f1c22SToby Isaac   PetscFunctionBegin;
7379c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7380c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7381534a8f05SLisandro Dalcin   PetscValidIntPointer(size, 4);
7382c58f1c22SToby Isaac   ierr  = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7383c58f1c22SToby Isaac   *size = 0;
7384c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
7385c58f1c22SToby Isaac   ierr = DMLabelGetStratumSize(label, value, size);CHKERRQ(ierr);
7386c58f1c22SToby Isaac   PetscFunctionReturn(0);
7387c58f1c22SToby Isaac }
7388c58f1c22SToby Isaac 
7389c58f1c22SToby Isaac /*@C
7390c58f1c22SToby Isaac   DMGetStratumIS - Get the points in a label stratum
7391c58f1c22SToby Isaac 
7392c58f1c22SToby Isaac   Not Collective
7393c58f1c22SToby Isaac 
7394c58f1c22SToby Isaac   Input Parameters:
7395c58f1c22SToby Isaac + dm - The DM object
7396c58f1c22SToby Isaac . name - The label name
7397c58f1c22SToby Isaac - value - The stratum value
7398c58f1c22SToby Isaac 
7399c58f1c22SToby Isaac   Output Parameter:
7400c58f1c22SToby Isaac . points - The stratum points, or NULL if the label does not exist or does not have that value
7401c58f1c22SToby Isaac 
7402c58f1c22SToby Isaac   Level: beginner
7403c58f1c22SToby Isaac 
7404c58f1c22SToby Isaac .seealso: DMLabelGetStratumIS(), DMGetStratumSize()
7405c58f1c22SToby Isaac @*/
7406c58f1c22SToby Isaac PetscErrorCode DMGetStratumIS(DM dm, const char name[], PetscInt value, IS *points)
7407c58f1c22SToby Isaac {
7408c58f1c22SToby Isaac   DMLabel        label;
7409c58f1c22SToby Isaac   PetscErrorCode ierr;
7410c58f1c22SToby Isaac 
7411c58f1c22SToby Isaac   PetscFunctionBegin;
7412c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7413c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7414c58f1c22SToby Isaac   PetscValidPointer(points, 4);
7415c58f1c22SToby Isaac   ierr    = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7416c58f1c22SToby Isaac   *points = NULL;
7417c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
7418c58f1c22SToby Isaac   ierr = DMLabelGetStratumIS(label, value, points);CHKERRQ(ierr);
7419c58f1c22SToby Isaac   PetscFunctionReturn(0);
7420c58f1c22SToby Isaac }
7421c58f1c22SToby Isaac 
74224de306b1SToby Isaac /*@C
74239044fa66SMatthew G. Knepley   DMSetStratumIS - Set the points in a label stratum
74244de306b1SToby Isaac 
74254de306b1SToby Isaac   Not Collective
74264de306b1SToby Isaac 
74274de306b1SToby Isaac   Input Parameters:
74284de306b1SToby Isaac + dm - The DM object
74294de306b1SToby Isaac . name - The label name
74304de306b1SToby Isaac . value - The stratum value
74314de306b1SToby Isaac - points - The stratum points
74324de306b1SToby Isaac 
74334de306b1SToby Isaac   Level: beginner
74344de306b1SToby Isaac 
74354de306b1SToby Isaac .seealso: DMLabelSetStratumIS(), DMGetStratumSize()
74364de306b1SToby Isaac @*/
74374de306b1SToby Isaac PetscErrorCode DMSetStratumIS(DM dm, const char name[], PetscInt value, IS points)
74384de306b1SToby Isaac {
74394de306b1SToby Isaac   DMLabel        label;
74404de306b1SToby Isaac   PetscErrorCode ierr;
74414de306b1SToby Isaac 
74424de306b1SToby Isaac   PetscFunctionBegin;
74434de306b1SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
74444de306b1SToby Isaac   PetscValidCharPointer(name, 2);
74454de306b1SToby Isaac   PetscValidPointer(points, 4);
74464de306b1SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
74474de306b1SToby Isaac   if (!label) PetscFunctionReturn(0);
74484de306b1SToby Isaac   ierr = DMLabelSetStratumIS(label, value, points);CHKERRQ(ierr);
74494de306b1SToby Isaac   PetscFunctionReturn(0);
74504de306b1SToby Isaac }
74514de306b1SToby Isaac 
7452c58f1c22SToby Isaac /*@C
7453c58f1c22SToby Isaac   DMClearLabelStratum - Remove all points from a stratum from a Sieve Label
7454c58f1c22SToby Isaac 
7455c58f1c22SToby Isaac   Not Collective
7456c58f1c22SToby Isaac 
7457c58f1c22SToby Isaac   Input Parameters:
7458c58f1c22SToby Isaac + dm   - The DM object
7459c58f1c22SToby Isaac . name - The label name
7460c58f1c22SToby Isaac - value - The label value for this point
7461c58f1c22SToby Isaac 
7462c58f1c22SToby Isaac   Output Parameter:
7463c58f1c22SToby Isaac 
7464c58f1c22SToby Isaac   Level: beginner
7465c58f1c22SToby Isaac 
7466c58f1c22SToby Isaac .seealso: DMLabelClearStratum(), DMSetLabelValue(), DMGetStratumIS(), DMClearLabelValue()
7467c58f1c22SToby Isaac @*/
7468c58f1c22SToby Isaac PetscErrorCode DMClearLabelStratum(DM dm, const char name[], PetscInt value)
7469c58f1c22SToby Isaac {
7470c58f1c22SToby Isaac   DMLabel        label;
7471c58f1c22SToby Isaac   PetscErrorCode ierr;
7472c58f1c22SToby Isaac 
7473c58f1c22SToby Isaac   PetscFunctionBegin;
7474c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7475c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7476c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7477c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
7478c58f1c22SToby Isaac   ierr = DMLabelClearStratum(label, value);CHKERRQ(ierr);
7479c58f1c22SToby Isaac   PetscFunctionReturn(0);
7480c58f1c22SToby Isaac }
7481c58f1c22SToby Isaac 
7482c58f1c22SToby Isaac /*@
7483c58f1c22SToby Isaac   DMGetNumLabels - Return the number of labels defined by the mesh
7484c58f1c22SToby Isaac 
7485c58f1c22SToby Isaac   Not Collective
7486c58f1c22SToby Isaac 
7487c58f1c22SToby Isaac   Input Parameter:
7488c58f1c22SToby Isaac . dm   - The DM object
7489c58f1c22SToby Isaac 
7490c58f1c22SToby Isaac   Output Parameter:
7491c58f1c22SToby Isaac . numLabels - the number of Labels
7492c58f1c22SToby Isaac 
7493c58f1c22SToby Isaac   Level: intermediate
7494c58f1c22SToby Isaac 
7495c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7496c58f1c22SToby Isaac @*/
7497c58f1c22SToby Isaac PetscErrorCode DMGetNumLabels(DM dm, PetscInt *numLabels)
7498c58f1c22SToby Isaac {
74995d80c0bfSVaclav Hapla   DMLabelLink next = dm->labels;
7500c58f1c22SToby Isaac   PetscInt  n    = 0;
7501c58f1c22SToby Isaac 
7502c58f1c22SToby Isaac   PetscFunctionBegin;
7503c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7504534a8f05SLisandro Dalcin   PetscValidIntPointer(numLabels, 2);
7505c58f1c22SToby Isaac   while (next) {++n; next = next->next;}
7506c58f1c22SToby Isaac   *numLabels = n;
7507c58f1c22SToby Isaac   PetscFunctionReturn(0);
7508c58f1c22SToby Isaac }
7509c58f1c22SToby Isaac 
7510c58f1c22SToby Isaac /*@C
7511c58f1c22SToby Isaac   DMGetLabelName - Return the name of nth label
7512c58f1c22SToby Isaac 
7513c58f1c22SToby Isaac   Not Collective
7514c58f1c22SToby Isaac 
7515c58f1c22SToby Isaac   Input Parameters:
7516c58f1c22SToby Isaac + dm - The DM object
7517c58f1c22SToby Isaac - n  - the label number
7518c58f1c22SToby Isaac 
7519c58f1c22SToby Isaac   Output Parameter:
7520c58f1c22SToby Isaac . name - the label name
7521c58f1c22SToby Isaac 
7522c58f1c22SToby Isaac   Level: intermediate
7523c58f1c22SToby Isaac 
7524c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7525c58f1c22SToby Isaac @*/
7526c58f1c22SToby Isaac PetscErrorCode DMGetLabelName(DM dm, PetscInt n, const char **name)
7527c58f1c22SToby Isaac {
75285d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
7529c58f1c22SToby Isaac   PetscInt       l    = 0;
7530d67d17b1SMatthew G. Knepley   PetscErrorCode ierr;
7531c58f1c22SToby Isaac 
7532c58f1c22SToby Isaac   PetscFunctionBegin;
7533c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7534c58f1c22SToby Isaac   PetscValidPointer(name, 3);
7535c58f1c22SToby Isaac   while (next) {
7536c58f1c22SToby Isaac     if (l == n) {
7537d67d17b1SMatthew G. Knepley       ierr = PetscObjectGetName((PetscObject) next->label, name);CHKERRQ(ierr);
7538c58f1c22SToby Isaac       PetscFunctionReturn(0);
7539c58f1c22SToby Isaac     }
7540c58f1c22SToby Isaac     ++l;
7541c58f1c22SToby Isaac     next = next->next;
7542c58f1c22SToby Isaac   }
7543c58f1c22SToby Isaac   SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %D does not exist in this DM", n);
7544c58f1c22SToby Isaac }
7545c58f1c22SToby Isaac 
7546c58f1c22SToby Isaac /*@C
7547c58f1c22SToby Isaac   DMHasLabel - Determine whether the mesh has a label of a given name
7548c58f1c22SToby Isaac 
7549c58f1c22SToby Isaac   Not Collective
7550c58f1c22SToby Isaac 
7551c58f1c22SToby Isaac   Input Parameters:
7552c58f1c22SToby Isaac + dm   - The DM object
7553c58f1c22SToby Isaac - name - The label name
7554c58f1c22SToby Isaac 
7555c58f1c22SToby Isaac   Output Parameter:
7556c58f1c22SToby Isaac . hasLabel - PETSC_TRUE if the label is present
7557c58f1c22SToby Isaac 
7558c58f1c22SToby Isaac   Level: intermediate
7559c58f1c22SToby Isaac 
7560c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7561c58f1c22SToby Isaac @*/
7562c58f1c22SToby Isaac PetscErrorCode DMHasLabel(DM dm, const char name[], PetscBool *hasLabel)
7563c58f1c22SToby Isaac {
75645d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
7565d67d17b1SMatthew G. Knepley   const char    *lname;
7566c58f1c22SToby Isaac   PetscErrorCode ierr;
7567c58f1c22SToby Isaac 
7568c58f1c22SToby Isaac   PetscFunctionBegin;
7569c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7570c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7571534a8f05SLisandro Dalcin   PetscValidBoolPointer(hasLabel, 3);
7572c58f1c22SToby Isaac   *hasLabel = PETSC_FALSE;
7573c58f1c22SToby Isaac   while (next) {
7574d67d17b1SMatthew G. Knepley     ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr);
7575d67d17b1SMatthew G. Knepley     ierr = PetscStrcmp(name, lname, hasLabel);CHKERRQ(ierr);
7576c58f1c22SToby Isaac     if (*hasLabel) break;
7577c58f1c22SToby Isaac     next = next->next;
7578c58f1c22SToby Isaac   }
7579c58f1c22SToby Isaac   PetscFunctionReturn(0);
7580c58f1c22SToby Isaac }
7581c58f1c22SToby Isaac 
7582c58f1c22SToby Isaac /*@C
7583c58f1c22SToby Isaac   DMGetLabel - Return the label of a given name, or NULL
7584c58f1c22SToby Isaac 
7585c58f1c22SToby Isaac   Not Collective
7586c58f1c22SToby Isaac 
7587c58f1c22SToby Isaac   Input Parameters:
7588c58f1c22SToby Isaac + dm   - The DM object
7589c58f1c22SToby Isaac - name - The label name
7590c58f1c22SToby Isaac 
7591c58f1c22SToby Isaac   Output Parameter:
7592c58f1c22SToby Isaac . label - The DMLabel, or NULL if the label is absent
7593c58f1c22SToby Isaac 
7594c58f1c22SToby Isaac   Level: intermediate
7595c58f1c22SToby Isaac 
7596c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7597c58f1c22SToby Isaac @*/
7598c58f1c22SToby Isaac PetscErrorCode DMGetLabel(DM dm, const char name[], DMLabel *label)
7599c58f1c22SToby Isaac {
76005d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
7601c58f1c22SToby Isaac   PetscBool      hasLabel;
7602d67d17b1SMatthew G. Knepley   const char    *lname;
7603c58f1c22SToby Isaac   PetscErrorCode ierr;
7604c58f1c22SToby Isaac 
7605c58f1c22SToby Isaac   PetscFunctionBegin;
7606c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7607c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7608c58f1c22SToby Isaac   PetscValidPointer(label, 3);
7609c58f1c22SToby Isaac   *label = NULL;
7610c58f1c22SToby Isaac   while (next) {
7611d67d17b1SMatthew G. Knepley     ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr);
7612d67d17b1SMatthew G. Knepley     ierr = PetscStrcmp(name, lname, &hasLabel);CHKERRQ(ierr);
7613c58f1c22SToby Isaac     if (hasLabel) {
7614c58f1c22SToby Isaac       *label = next->label;
7615c58f1c22SToby Isaac       break;
7616c58f1c22SToby Isaac     }
7617c58f1c22SToby Isaac     next = next->next;
7618c58f1c22SToby Isaac   }
7619c58f1c22SToby Isaac   PetscFunctionReturn(0);
7620c58f1c22SToby Isaac }
7621c58f1c22SToby Isaac 
7622c58f1c22SToby Isaac /*@C
7623c58f1c22SToby Isaac   DMGetLabelByNum - Return the nth label
7624c58f1c22SToby Isaac 
7625c58f1c22SToby Isaac   Not Collective
7626c58f1c22SToby Isaac 
7627c58f1c22SToby Isaac   Input Parameters:
7628c58f1c22SToby Isaac + dm - The DM object
7629c58f1c22SToby Isaac - n  - the label number
7630c58f1c22SToby Isaac 
7631c58f1c22SToby Isaac   Output Parameter:
7632c58f1c22SToby Isaac . label - the label
7633c58f1c22SToby Isaac 
7634c58f1c22SToby Isaac   Level: intermediate
7635c58f1c22SToby Isaac 
7636c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7637c58f1c22SToby Isaac @*/
7638c58f1c22SToby Isaac PetscErrorCode DMGetLabelByNum(DM dm, PetscInt n, DMLabel *label)
7639c58f1c22SToby Isaac {
76405d80c0bfSVaclav Hapla   DMLabelLink next = dm->labels;
7641c58f1c22SToby Isaac   PetscInt    l    = 0;
7642c58f1c22SToby Isaac 
7643c58f1c22SToby Isaac   PetscFunctionBegin;
7644c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7645c58f1c22SToby Isaac   PetscValidPointer(label, 3);
7646c58f1c22SToby Isaac   while (next) {
7647c58f1c22SToby Isaac     if (l == n) {
7648c58f1c22SToby Isaac       *label = next->label;
7649c58f1c22SToby Isaac       PetscFunctionReturn(0);
7650c58f1c22SToby Isaac     }
7651c58f1c22SToby Isaac     ++l;
7652c58f1c22SToby Isaac     next = next->next;
7653c58f1c22SToby Isaac   }
7654c58f1c22SToby Isaac   SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %D does not exist in this DM", n);
7655c58f1c22SToby Isaac }
7656c58f1c22SToby Isaac 
7657c58f1c22SToby Isaac /*@C
7658c58f1c22SToby Isaac   DMAddLabel - Add the label to this mesh
7659c58f1c22SToby Isaac 
7660c58f1c22SToby Isaac   Not Collective
7661c58f1c22SToby Isaac 
7662c58f1c22SToby Isaac   Input Parameters:
7663c58f1c22SToby Isaac + dm   - The DM object
7664c58f1c22SToby Isaac - label - The DMLabel
7665c58f1c22SToby Isaac 
7666c58f1c22SToby Isaac   Level: developer
7667c58f1c22SToby Isaac 
7668c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7669c58f1c22SToby Isaac @*/
7670c58f1c22SToby Isaac PetscErrorCode DMAddLabel(DM dm, DMLabel label)
7671c58f1c22SToby Isaac {
76725d80c0bfSVaclav Hapla   DMLabelLink    l, *p, tmpLabel;
7673c58f1c22SToby Isaac   PetscBool      hasLabel;
7674d67d17b1SMatthew G. Knepley   const char    *lname;
76755d80c0bfSVaclav Hapla   PetscBool      flg;
7676c58f1c22SToby Isaac   PetscErrorCode ierr;
7677c58f1c22SToby Isaac 
7678c58f1c22SToby Isaac   PetscFunctionBegin;
7679c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7680d67d17b1SMatthew G. Knepley   ierr = PetscObjectGetName((PetscObject) label, &lname);CHKERRQ(ierr);
7681d67d17b1SMatthew G. Knepley   ierr = DMHasLabel(dm, lname, &hasLabel);CHKERRQ(ierr);
7682d67d17b1SMatthew G. Knepley   if (hasLabel) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %s already exists in this DM", lname);
7683c58f1c22SToby Isaac   ierr = PetscCalloc1(1, &tmpLabel);CHKERRQ(ierr);
7684c58f1c22SToby Isaac   tmpLabel->label  = label;
7685c58f1c22SToby Isaac   tmpLabel->output = PETSC_TRUE;
76865d80c0bfSVaclav Hapla   for (p=&dm->labels; (l=*p); p=&l->next) {}
76875d80c0bfSVaclav Hapla   *p = tmpLabel;
768808f633c4SVaclav Hapla   ierr = PetscObjectReference((PetscObject)label);CHKERRQ(ierr);
76895d80c0bfSVaclav Hapla   ierr = PetscStrcmp(lname, "depth", &flg);CHKERRQ(ierr);
76905d80c0bfSVaclav Hapla   if (flg) dm->depthLabel = label;
7691ba2698f1SMatthew G. Knepley   ierr = PetscStrcmp(lname, "celltype", &flg);CHKERRQ(ierr);
7692ba2698f1SMatthew G. Knepley   if (flg) dm->celltypeLabel = label;
7693c58f1c22SToby Isaac   PetscFunctionReturn(0);
7694c58f1c22SToby Isaac }
7695c58f1c22SToby Isaac 
7696c58f1c22SToby Isaac /*@C
7697e5472504SVaclav Hapla   DMRemoveLabel - Remove the label given by name from this mesh
7698c58f1c22SToby Isaac 
7699c58f1c22SToby Isaac   Not Collective
7700c58f1c22SToby Isaac 
7701c58f1c22SToby Isaac   Input Parameters:
7702c58f1c22SToby Isaac + dm   - The DM object
7703c58f1c22SToby Isaac - name - The label name
7704c58f1c22SToby Isaac 
7705c58f1c22SToby Isaac   Output Parameter:
7706c58f1c22SToby Isaac . label - The DMLabel, or NULL if the label is absent
7707c58f1c22SToby Isaac 
7708c58f1c22SToby Isaac   Level: developer
7709c58f1c22SToby Isaac 
7710e5472504SVaclav Hapla   Notes:
7711e5472504SVaclav Hapla   DMRemoveLabel(dm,name,NULL) removes the label from dm and calls
7712e5472504SVaclav Hapla   DMLabelDestroy() on the label.
7713e5472504SVaclav Hapla 
7714e5472504SVaclav Hapla   DMRemoveLabel(dm,name,&label) removes the label from dm, but it DOES NOT
7715e5472504SVaclav Hapla   call DMLabelDestroy(). Instead, the label is returned and the user is
7716e5472504SVaclav Hapla   responsible of calling DMLabelDestroy() at some point.
7717e5472504SVaclav Hapla 
7718e5472504SVaclav Hapla .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabel(), DMGetLabelValue(), DMSetLabelValue(), DMLabelDestroy(), DMRemoveLabelBySelf()
7719c58f1c22SToby Isaac @*/
7720c58f1c22SToby Isaac PetscErrorCode DMRemoveLabel(DM dm, const char name[], DMLabel *label)
7721c58f1c22SToby Isaac {
772295d578d6SVaclav Hapla   DMLabelLink    link, *pnext;
7723c58f1c22SToby Isaac   PetscBool      hasLabel;
7724d67d17b1SMatthew G. Knepley   const char    *lname;
7725c58f1c22SToby Isaac   PetscErrorCode ierr;
7726c58f1c22SToby Isaac 
7727c58f1c22SToby Isaac   PetscFunctionBegin;
7728c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7729e5472504SVaclav Hapla   PetscValidCharPointer(name, 2);
7730e5472504SVaclav Hapla   if (label) {
7731e5472504SVaclav Hapla     PetscValidPointer(label, 3);
7732c58f1c22SToby Isaac     *label = NULL;
7733e5472504SVaclav Hapla   }
77345d80c0bfSVaclav Hapla   for (pnext=&dm->labels; (link=*pnext); pnext=&link->next) {
773595d578d6SVaclav Hapla     ierr = PetscObjectGetName((PetscObject) link->label, &lname);CHKERRQ(ierr);
7736d67d17b1SMatthew G. Knepley     ierr = PetscStrcmp(name, lname, &hasLabel);CHKERRQ(ierr);
7737c58f1c22SToby Isaac     if (hasLabel) {
773895d578d6SVaclav Hapla       *pnext = link->next; /* Remove from list */
7739c58f1c22SToby Isaac       ierr = PetscStrcmp(name, "depth", &hasLabel);CHKERRQ(ierr);
774095d578d6SVaclav Hapla       if (hasLabel) dm->depthLabel = NULL;
7741ba2698f1SMatthew G. Knepley       ierr = PetscStrcmp(name, "celltype", &hasLabel);CHKERRQ(ierr);
7742ba2698f1SMatthew G. Knepley       if (hasLabel) dm->celltypeLabel = NULL;
774395d578d6SVaclav Hapla       if (label) *label = link->label;
774495d578d6SVaclav Hapla       else       {ierr = DMLabelDestroy(&link->label);CHKERRQ(ierr);}
774595d578d6SVaclav Hapla       ierr = PetscFree(link);CHKERRQ(ierr);
7746c58f1c22SToby Isaac       break;
7747c58f1c22SToby Isaac     }
7748c58f1c22SToby Isaac   }
7749c58f1c22SToby Isaac   PetscFunctionReturn(0);
7750c58f1c22SToby Isaac }
7751c58f1c22SToby Isaac 
7752306894acSVaclav Hapla /*@
7753306894acSVaclav Hapla   DMRemoveLabelBySelf - Remove the label from this mesh
7754306894acSVaclav Hapla 
7755306894acSVaclav Hapla   Not Collective
7756306894acSVaclav Hapla 
7757306894acSVaclav Hapla   Input Parameters:
7758306894acSVaclav Hapla + dm   - The DM object
7759306894acSVaclav Hapla . label - (Optional) The DMLabel to be removed from the DM
7760306894acSVaclav Hapla - failNotFound - Should it fail if the label is not found in the DM?
7761306894acSVaclav Hapla 
7762306894acSVaclav Hapla   Level: developer
7763306894acSVaclav Hapla 
7764306894acSVaclav Hapla   Notes:
7765306894acSVaclav Hapla   Only exactly the same instance is removed if found, name match is ignored.
7766306894acSVaclav Hapla   If the DM has an exclusive reference to the label, it gets destroyed and
7767306894acSVaclav Hapla   *label nullified.
7768306894acSVaclav Hapla 
7769306894acSVaclav Hapla .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabel() DMGetLabelValue(), DMSetLabelValue(), DMLabelDestroy(), DMRemoveLabel()
7770306894acSVaclav Hapla @*/
7771306894acSVaclav Hapla PetscErrorCode DMRemoveLabelBySelf(DM dm, DMLabel *label, PetscBool failNotFound)
7772306894acSVaclav Hapla {
777343e45a93SVaclav Hapla   DMLabelLink    link, *pnext;
7774306894acSVaclav Hapla   PetscBool      hasLabel = PETSC_FALSE;
7775306894acSVaclav Hapla   PetscErrorCode ierr;
7776306894acSVaclav Hapla 
7777306894acSVaclav Hapla   PetscFunctionBegin;
7778306894acSVaclav Hapla   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7779306894acSVaclav Hapla   PetscValidPointer(label, 2);
7780f39a9ae0SVaclav Hapla   if (!*label && !failNotFound) PetscFunctionReturn(0);
7781306894acSVaclav Hapla   PetscValidHeaderSpecific(*label, DMLABEL_CLASSID, 2);
7782306894acSVaclav Hapla   PetscValidLogicalCollectiveBool(dm,failNotFound,3);
77835d80c0bfSVaclav Hapla   for (pnext=&dm->labels; (link=*pnext); pnext=&link->next) {
778443e45a93SVaclav Hapla     if (*label == link->label) {
7785306894acSVaclav Hapla       hasLabel = PETSC_TRUE;
778643e45a93SVaclav Hapla       *pnext = link->next; /* Remove from list */
7787306894acSVaclav Hapla       if (*label == dm->depthLabel) dm->depthLabel = NULL;
7788ba2698f1SMatthew G. Knepley       if (*label == dm->celltypeLabel) dm->celltypeLabel = NULL;
778943e45a93SVaclav Hapla       if (((PetscObject) link->label)->refct < 2) *label = NULL; /* nullify if exclusive reference */
779043e45a93SVaclav Hapla       ierr = DMLabelDestroy(&link->label);CHKERRQ(ierr);
779143e45a93SVaclav Hapla       ierr = PetscFree(link);CHKERRQ(ierr);
7792306894acSVaclav Hapla       break;
7793306894acSVaclav Hapla     }
7794306894acSVaclav Hapla   }
7795306894acSVaclav Hapla   if (!hasLabel && failNotFound) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONG, "Given label not found in DM");
7796306894acSVaclav Hapla   PetscFunctionReturn(0);
7797306894acSVaclav Hapla }
7798306894acSVaclav Hapla 
7799c58f1c22SToby Isaac /*@C
7800c58f1c22SToby Isaac   DMGetLabelOutput - Get the output flag for a given label
7801c58f1c22SToby Isaac 
7802c58f1c22SToby Isaac   Not Collective
7803c58f1c22SToby Isaac 
7804c58f1c22SToby Isaac   Input Parameters:
7805c58f1c22SToby Isaac + dm   - The DM object
7806c58f1c22SToby Isaac - name - The label name
7807c58f1c22SToby Isaac 
7808c58f1c22SToby Isaac   Output Parameter:
7809c58f1c22SToby Isaac . output - The flag for output
7810c58f1c22SToby Isaac 
7811c58f1c22SToby Isaac   Level: developer
7812c58f1c22SToby Isaac 
7813c58f1c22SToby Isaac .seealso: DMSetLabelOutput(), DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7814c58f1c22SToby Isaac @*/
7815c58f1c22SToby Isaac PetscErrorCode DMGetLabelOutput(DM dm, const char name[], PetscBool *output)
7816c58f1c22SToby Isaac {
78175d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
7818d67d17b1SMatthew G. Knepley   const char    *lname;
7819c58f1c22SToby Isaac   PetscErrorCode ierr;
7820c58f1c22SToby Isaac 
7821c58f1c22SToby Isaac   PetscFunctionBegin;
7822c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7823c58f1c22SToby Isaac   PetscValidPointer(name, 2);
7824c58f1c22SToby Isaac   PetscValidPointer(output, 3);
7825c58f1c22SToby Isaac   while (next) {
7826c58f1c22SToby Isaac     PetscBool flg;
7827c58f1c22SToby Isaac 
7828d67d17b1SMatthew G. Knepley     ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr);
7829d67d17b1SMatthew G. Knepley     ierr = PetscStrcmp(name, lname, &flg);CHKERRQ(ierr);
7830c58f1c22SToby Isaac     if (flg) {*output = next->output; PetscFunctionReturn(0);}
7831c58f1c22SToby Isaac     next = next->next;
7832c58f1c22SToby Isaac   }
7833c58f1c22SToby Isaac   SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "No label named %s was present in this dm", name);
7834c58f1c22SToby Isaac }
7835c58f1c22SToby Isaac 
7836c58f1c22SToby Isaac /*@C
7837c58f1c22SToby Isaac   DMSetLabelOutput - Set the output flag for a given label
7838c58f1c22SToby Isaac 
7839c58f1c22SToby Isaac   Not Collective
7840c58f1c22SToby Isaac 
7841c58f1c22SToby Isaac   Input Parameters:
7842c58f1c22SToby Isaac + dm     - The DM object
7843c58f1c22SToby Isaac . name   - The label name
7844c58f1c22SToby Isaac - output - The flag for output
7845c58f1c22SToby Isaac 
7846c58f1c22SToby Isaac   Level: developer
7847c58f1c22SToby Isaac 
7848c58f1c22SToby Isaac .seealso: DMGetLabelOutput(), DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7849c58f1c22SToby Isaac @*/
7850c58f1c22SToby Isaac PetscErrorCode DMSetLabelOutput(DM dm, const char name[], PetscBool output)
7851c58f1c22SToby Isaac {
78525d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
7853d67d17b1SMatthew G. Knepley   const char    *lname;
7854c58f1c22SToby Isaac   PetscErrorCode ierr;
7855c58f1c22SToby Isaac 
7856c58f1c22SToby Isaac   PetscFunctionBegin;
7857c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7858534a8f05SLisandro Dalcin   PetscValidCharPointer(name, 2);
7859c58f1c22SToby Isaac   while (next) {
7860c58f1c22SToby Isaac     PetscBool flg;
7861c58f1c22SToby Isaac 
7862d67d17b1SMatthew G. Knepley     ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr);
7863d67d17b1SMatthew G. Knepley     ierr = PetscStrcmp(name, lname, &flg);CHKERRQ(ierr);
7864c58f1c22SToby Isaac     if (flg) {next->output = output; PetscFunctionReturn(0);}
7865c58f1c22SToby Isaac     next = next->next;
7866c58f1c22SToby Isaac   }
7867c58f1c22SToby Isaac   SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "No label named %s was present in this dm", name);
7868c58f1c22SToby Isaac }
7869c58f1c22SToby Isaac 
7870c58f1c22SToby Isaac /*@
7871c58f1c22SToby Isaac   DMCopyLabels - Copy labels from one mesh to another with a superset of the points
7872c58f1c22SToby Isaac 
7873d083f849SBarry Smith   Collective on dmA
7874c58f1c22SToby Isaac 
7875c58f1c22SToby Isaac   Input Parameter:
78765d80c0bfSVaclav Hapla + dmA - The DM object with initial labels
78772e17dfb7SMatthew G. Knepley . dmB - The DM object with copied labels
78785d80c0bfSVaclav Hapla . mode - Copy labels by pointers (PETSC_OWN_POINTER) or duplicate them (PETSC_COPY_VALUES)
7879ba2698f1SMatthew G. Knepley - all  - Copy all labels including "depth", "dim", and "celltype" (PETSC_TRUE) which are otherwise ignored (PETSC_FALSE)
7880c58f1c22SToby Isaac 
7881c58f1c22SToby Isaac   Level: intermediate
7882c58f1c22SToby Isaac 
7883c58f1c22SToby Isaac   Note: This is typically used when interpolating or otherwise adding to a mesh
7884c58f1c22SToby Isaac 
78855d80c0bfSVaclav Hapla .seealso: DMGetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM(), DMGetCoordinateSection(), DMShareLabels()
7886c58f1c22SToby Isaac @*/
78875d80c0bfSVaclav Hapla PetscErrorCode DMCopyLabels(DM dmA, DM dmB, PetscCopyMode mode, PetscBool all)
7888c58f1c22SToby Isaac {
7889c58f1c22SToby Isaac   DMLabel        label, labelNew;
7890c58f1c22SToby Isaac   const char    *name;
7891c58f1c22SToby Isaac   PetscBool      flg;
78925d80c0bfSVaclav Hapla   DMLabelLink    link;
78935d80c0bfSVaclav Hapla   PetscErrorCode ierr;
7894c58f1c22SToby Isaac 
78955d80c0bfSVaclav Hapla   PetscFunctionBegin;
78965d80c0bfSVaclav Hapla   PetscValidHeaderSpecific(dmA, DM_CLASSID, 1);
78975d80c0bfSVaclav Hapla   PetscValidHeaderSpecific(dmB, DM_CLASSID, 2);
78985d80c0bfSVaclav Hapla   PetscValidLogicalCollectiveEnum(dmA, mode,3);
78995d80c0bfSVaclav Hapla   PetscValidLogicalCollectiveBool(dmA, all, 4);
79005d80c0bfSVaclav Hapla   if (mode==PETSC_USE_POINTER) SETERRQ(PetscObjectComm((PetscObject)dmA), PETSC_ERR_SUP, "PETSC_USE_POINTER not supported for objects");
79015d80c0bfSVaclav Hapla   if (dmA == dmB) PetscFunctionReturn(0);
79025d80c0bfSVaclav Hapla   for (link=dmA->labels; link; link=link->next) {
79035d80c0bfSVaclav Hapla     label=link->label;
79045d80c0bfSVaclav Hapla     ierr = PetscObjectGetName((PetscObject)label, &name);CHKERRQ(ierr);
79055d80c0bfSVaclav Hapla     if (!all) {
7906c58f1c22SToby Isaac       ierr = PetscStrcmp(name, "depth", &flg);CHKERRQ(ierr);
7907c58f1c22SToby Isaac       if (flg) continue;
79087d5acc75SStefano Zampini       ierr = PetscStrcmp(name, "dim", &flg);CHKERRQ(ierr);
79097d5acc75SStefano Zampini       if (flg) continue;
7910ba2698f1SMatthew G. Knepley       ierr = PetscStrcmp(name, "celltype", &flg);CHKERRQ(ierr);
7911ba2698f1SMatthew G. Knepley       if (flg) continue;
79125d80c0bfSVaclav Hapla     }
79135d80c0bfSVaclav Hapla     if (mode==PETSC_COPY_VALUES) {
7914c58f1c22SToby Isaac       ierr = DMLabelDuplicate(label, &labelNew);CHKERRQ(ierr);
79155d80c0bfSVaclav Hapla     } else {
79165d80c0bfSVaclav Hapla       labelNew = label;
79175d80c0bfSVaclav Hapla     }
7918c58f1c22SToby Isaac     ierr = DMAddLabel(dmB, labelNew);CHKERRQ(ierr);
79195d80c0bfSVaclav Hapla     if (mode==PETSC_COPY_VALUES) {ierr = DMLabelDestroy(&labelNew);CHKERRQ(ierr);}
7920c58f1c22SToby Isaac   }
7921c58f1c22SToby Isaac   PetscFunctionReturn(0);
7922c58f1c22SToby Isaac }
7923a8fb8f29SToby Isaac 
7924a8fb8f29SToby Isaac /*@
7925a8fb8f29SToby Isaac   DMGetCoarseDM - Get the coarse mesh from which this was obtained by refinement
7926a8fb8f29SToby Isaac 
7927a8fb8f29SToby Isaac   Input Parameter:
7928a8fb8f29SToby Isaac . dm - The DM object
7929a8fb8f29SToby Isaac 
7930a8fb8f29SToby Isaac   Output Parameter:
7931a8fb8f29SToby Isaac . cdm - The coarse DM
7932a8fb8f29SToby Isaac 
7933a8fb8f29SToby Isaac   Level: intermediate
7934a8fb8f29SToby Isaac 
7935a8fb8f29SToby Isaac .seealso: DMSetCoarseDM()
7936a8fb8f29SToby Isaac @*/
7937a8fb8f29SToby Isaac PetscErrorCode DMGetCoarseDM(DM dm, DM *cdm)
7938a8fb8f29SToby Isaac {
7939a8fb8f29SToby Isaac   PetscFunctionBegin;
7940a8fb8f29SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7941a8fb8f29SToby Isaac   PetscValidPointer(cdm, 2);
7942a8fb8f29SToby Isaac   *cdm = dm->coarseMesh;
7943a8fb8f29SToby Isaac   PetscFunctionReturn(0);
7944a8fb8f29SToby Isaac }
7945a8fb8f29SToby Isaac 
7946a8fb8f29SToby Isaac /*@
7947a8fb8f29SToby Isaac   DMSetCoarseDM - Set the coarse mesh from which this was obtained by refinement
7948a8fb8f29SToby Isaac 
7949a8fb8f29SToby Isaac   Input Parameters:
7950a8fb8f29SToby Isaac + dm - The DM object
7951a8fb8f29SToby Isaac - cdm - The coarse DM
7952a8fb8f29SToby Isaac 
7953a8fb8f29SToby Isaac   Level: intermediate
7954a8fb8f29SToby Isaac 
7955a8fb8f29SToby Isaac .seealso: DMGetCoarseDM()
7956a8fb8f29SToby Isaac @*/
7957a8fb8f29SToby Isaac PetscErrorCode DMSetCoarseDM(DM dm, DM cdm)
7958a8fb8f29SToby Isaac {
7959a8fb8f29SToby Isaac   PetscErrorCode ierr;
7960a8fb8f29SToby Isaac 
7961a8fb8f29SToby Isaac   PetscFunctionBegin;
7962a8fb8f29SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7963a8fb8f29SToby Isaac   if (cdm) PetscValidHeaderSpecific(cdm, DM_CLASSID, 2);
7964a8fb8f29SToby Isaac   ierr = PetscObjectReference((PetscObject)cdm);CHKERRQ(ierr);
7965a8fb8f29SToby Isaac   ierr = DMDestroy(&dm->coarseMesh);CHKERRQ(ierr);
7966a8fb8f29SToby Isaac   dm->coarseMesh = cdm;
7967a8fb8f29SToby Isaac   PetscFunctionReturn(0);
7968a8fb8f29SToby Isaac }
7969a8fb8f29SToby Isaac 
797088bdff64SToby Isaac /*@
797188bdff64SToby Isaac   DMGetFineDM - Get the fine mesh from which this was obtained by refinement
797288bdff64SToby Isaac 
797388bdff64SToby Isaac   Input Parameter:
797488bdff64SToby Isaac . dm - The DM object
797588bdff64SToby Isaac 
797688bdff64SToby Isaac   Output Parameter:
797788bdff64SToby Isaac . fdm - The fine DM
797888bdff64SToby Isaac 
797988bdff64SToby Isaac   Level: intermediate
798088bdff64SToby Isaac 
798188bdff64SToby Isaac .seealso: DMSetFineDM()
798288bdff64SToby Isaac @*/
798388bdff64SToby Isaac PetscErrorCode DMGetFineDM(DM dm, DM *fdm)
798488bdff64SToby Isaac {
798588bdff64SToby Isaac   PetscFunctionBegin;
798688bdff64SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
798788bdff64SToby Isaac   PetscValidPointer(fdm, 2);
798888bdff64SToby Isaac   *fdm = dm->fineMesh;
798988bdff64SToby Isaac   PetscFunctionReturn(0);
799088bdff64SToby Isaac }
799188bdff64SToby Isaac 
799288bdff64SToby Isaac /*@
799388bdff64SToby Isaac   DMSetFineDM - Set the fine mesh from which this was obtained by refinement
799488bdff64SToby Isaac 
799588bdff64SToby Isaac   Input Parameters:
799688bdff64SToby Isaac + dm - The DM object
799788bdff64SToby Isaac - fdm - The fine DM
799888bdff64SToby Isaac 
799988bdff64SToby Isaac   Level: intermediate
800088bdff64SToby Isaac 
800188bdff64SToby Isaac .seealso: DMGetFineDM()
800288bdff64SToby Isaac @*/
800388bdff64SToby Isaac PetscErrorCode DMSetFineDM(DM dm, DM fdm)
800488bdff64SToby Isaac {
800588bdff64SToby Isaac   PetscErrorCode ierr;
800688bdff64SToby Isaac 
800788bdff64SToby Isaac   PetscFunctionBegin;
800888bdff64SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
800988bdff64SToby Isaac   if (fdm) PetscValidHeaderSpecific(fdm, DM_CLASSID, 2);
801088bdff64SToby Isaac   ierr = PetscObjectReference((PetscObject)fdm);CHKERRQ(ierr);
801188bdff64SToby Isaac   ierr = DMDestroy(&dm->fineMesh);CHKERRQ(ierr);
801288bdff64SToby Isaac   dm->fineMesh = fdm;
801388bdff64SToby Isaac   PetscFunctionReturn(0);
801488bdff64SToby Isaac }
801588bdff64SToby Isaac 
8016a6ba4734SToby Isaac /*=== DMBoundary code ===*/
8017a6ba4734SToby Isaac 
8018a6ba4734SToby Isaac PetscErrorCode DMCopyBoundary(DM dm, DM dmNew)
8019a6ba4734SToby Isaac {
8020e5e52638SMatthew G. Knepley   PetscInt       d;
8021a6ba4734SToby Isaac   PetscErrorCode ierr;
8022a6ba4734SToby Isaac 
8023a6ba4734SToby Isaac   PetscFunctionBegin;
8024e5e52638SMatthew G. Knepley   for (d = 0; d < dm->Nds; ++d) {
8025e5e52638SMatthew G. Knepley     ierr = PetscDSCopyBoundary(dm->probs[d].ds, dmNew->probs[d].ds);CHKERRQ(ierr);
8026e5e52638SMatthew G. Knepley   }
8027a6ba4734SToby Isaac   PetscFunctionReturn(0);
8028a6ba4734SToby Isaac }
8029a6ba4734SToby Isaac 
8030a6ba4734SToby Isaac /*@C
8031a6ba4734SToby Isaac   DMAddBoundary - Add a boundary condition to the model
8032a6ba4734SToby Isaac 
8033783e2ec8SMatthew G. Knepley   Collective on dm
8034783e2ec8SMatthew G. Knepley 
8035a6ba4734SToby Isaac   Input Parameters:
80364c258f51SMatthew G. Knepley + dm          - The DM, with a PetscDS that matches the problem being constrained
8037f971fd6bSMatthew G. Knepley . type        - The type of condition, e.g. DM_BC_ESSENTIAL_ANALYTIC/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann)
8038a6ba4734SToby Isaac . name        - The BC name
8039a6ba4734SToby Isaac . labelname   - The label defining constrained points
8040a6ba4734SToby Isaac . field       - The field to constrain
8041e8ecbf3fSStefano Zampini . numcomps    - The number of constrained field components (0 will constrain all fields)
8042a6ba4734SToby Isaac . comps       - An array of constrained component numbers
8043a6ba4734SToby Isaac . bcFunc      - A pointwise function giving boundary values
804456cf3b9cSMatthew G. Knepley . bcFunc_t    - A pointwise function giving the time deriative of the boundary values, or NULL
8045a6ba4734SToby Isaac . numids      - The number of DMLabel ids for constrained points
8046a6ba4734SToby Isaac . ids         - An array of ids for constrained points
8047a6ba4734SToby Isaac - ctx         - An optional user context for bcFunc
8048a6ba4734SToby Isaac 
8049a6ba4734SToby Isaac   Options Database Keys:
8050a6ba4734SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids
8051a6ba4734SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components
8052a6ba4734SToby Isaac 
805356cf3b9cSMatthew G. Knepley   Note:
805456cf3b9cSMatthew G. Knepley   Both bcFunc abd bcFunc_t will depend on the boundary condition type. If the type if DM_BC_ESSENTIAL, Then the calling sequence is:
805556cf3b9cSMatthew G. Knepley 
805656cf3b9cSMatthew G. Knepley $ bcFunc(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nc, PetscScalar bcval[])
805756cf3b9cSMatthew G. Knepley 
805856cf3b9cSMatthew G. Knepley   If the type is DM_BC_ESSENTIAL_FIELD or other _FIELD value, then the calling sequence is:
805956cf3b9cSMatthew G. Knepley 
806056cf3b9cSMatthew G. Knepley $ bcFunc(PetscInt dim, PetscInt Nf, PetscInt NfAux,
806156cf3b9cSMatthew G. Knepley $        const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
806256cf3b9cSMatthew G. Knepley $        const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
806356cf3b9cSMatthew G. Knepley $        PetscReal time, const PetscReal x[], PetscScalar bcval[])
806456cf3b9cSMatthew G. Knepley 
806556cf3b9cSMatthew G. Knepley + dim - the spatial dimension
806656cf3b9cSMatthew G. Knepley . Nf - the number of fields
806756cf3b9cSMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
806856cf3b9cSMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
806956cf3b9cSMatthew G. Knepley . u - each field evaluated at the current point
807056cf3b9cSMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
807156cf3b9cSMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
807256cf3b9cSMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
807356cf3b9cSMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
807456cf3b9cSMatthew G. Knepley . a - each auxiliary field evaluated at the current point
807556cf3b9cSMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
807656cf3b9cSMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
807756cf3b9cSMatthew G. Knepley . t - current time
807856cf3b9cSMatthew G. Knepley . x - coordinates of the current point
807956cf3b9cSMatthew G. Knepley . numConstants - number of constant parameters
808056cf3b9cSMatthew G. Knepley . constants - constant parameters
808156cf3b9cSMatthew G. Knepley - bcval - output values at the current point
808256cf3b9cSMatthew G. Knepley 
8083a6ba4734SToby Isaac   Level: developer
8084a6ba4734SToby Isaac 
808556cf3b9cSMatthew G. Knepley .seealso: DMGetBoundary(), PetscDSAddBoundary()
8086a6ba4734SToby Isaac @*/
808756cf3b9cSMatthew G. Knepley PetscErrorCode DMAddBoundary(DM dm, DMBoundaryConditionType type, const char name[], const char labelname[], PetscInt field, PetscInt numcomps, const PetscInt *comps, void (*bcFunc)(void), void (*bcFunc_t)(void), PetscInt numids, const PetscInt *ids, void *ctx)
8088a6ba4734SToby Isaac {
8089e5e52638SMatthew G. Knepley   PetscDS        ds;
8090a6ba4734SToby Isaac   PetscErrorCode ierr;
8091a6ba4734SToby Isaac 
8092a6ba4734SToby Isaac   PetscFunctionBegin;
8093a6ba4734SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8094783e2ec8SMatthew G. Knepley   PetscValidLogicalCollectiveEnum(dm, type, 2);
8095783e2ec8SMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, field, 5);
8096783e2ec8SMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, numcomps, 6);
8097783e2ec8SMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, numids, 9);
8098e5e52638SMatthew G. Knepley   ierr = DMGetDS(dm, &ds);CHKERRQ(ierr);
8099783e2ec8SMatthew G. Knepley   ierr = DMCompleteBoundaryLabel_Internal(dm, ds, field, PETSC_MAX_INT, labelname);CHKERRQ(ierr);
810056cf3b9cSMatthew G. Knepley   ierr = PetscDSAddBoundary(ds, type,name, labelname, field, numcomps, comps, bcFunc, bcFunc_t, numids, ids, ctx);CHKERRQ(ierr);
8101a6ba4734SToby Isaac   PetscFunctionReturn(0);
8102a6ba4734SToby Isaac }
8103a6ba4734SToby Isaac 
8104a6ba4734SToby Isaac /*@
8105a6ba4734SToby Isaac   DMGetNumBoundary - Get the number of registered BC
8106a6ba4734SToby Isaac 
8107a6ba4734SToby Isaac   Input Parameters:
8108a6ba4734SToby Isaac . dm - The mesh object
8109a6ba4734SToby Isaac 
8110a6ba4734SToby Isaac   Output Parameters:
8111a6ba4734SToby Isaac . numBd - The number of BC
8112a6ba4734SToby Isaac 
8113a6ba4734SToby Isaac   Level: intermediate
8114a6ba4734SToby Isaac 
8115a6ba4734SToby Isaac .seealso: DMAddBoundary(), DMGetBoundary()
8116a6ba4734SToby Isaac @*/
8117a6ba4734SToby Isaac PetscErrorCode DMGetNumBoundary(DM dm, PetscInt *numBd)
8118a6ba4734SToby Isaac {
8119e5e52638SMatthew G. Knepley   PetscDS        ds;
812058ebd649SToby Isaac   PetscErrorCode ierr;
8121a6ba4734SToby Isaac 
8122a6ba4734SToby Isaac   PetscFunctionBegin;
8123a6ba4734SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8124e5e52638SMatthew G. Knepley   ierr = DMGetDS(dm, &ds);CHKERRQ(ierr);
8125e5e52638SMatthew G. Knepley   ierr = PetscDSGetNumBoundary(ds, numBd);CHKERRQ(ierr);
8126a6ba4734SToby Isaac   PetscFunctionReturn(0);
8127a6ba4734SToby Isaac }
8128a6ba4734SToby Isaac 
8129a6ba4734SToby Isaac /*@C
81301c531cf8SMatthew G. Knepley   DMGetBoundary - Get a model boundary condition
8131a6ba4734SToby Isaac 
8132a6ba4734SToby Isaac   Input Parameters:
8133a6ba4734SToby Isaac + dm          - The mesh object
8134a6ba4734SToby Isaac - bd          - The BC number
8135a6ba4734SToby Isaac 
8136a6ba4734SToby Isaac   Output Parameters:
8137f971fd6bSMatthew G. Knepley + type        - The type of condition, e.g. DM_BC_ESSENTIAL_ANALYTIC/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann)
8138a6ba4734SToby Isaac . name        - The BC name
8139a6ba4734SToby Isaac . labelname   - The label defining constrained points
8140a6ba4734SToby Isaac . field       - The field to constrain
8141a6ba4734SToby Isaac . numcomps    - The number of constrained field components
8142a6ba4734SToby Isaac . comps       - An array of constrained component numbers
8143a6ba4734SToby Isaac . bcFunc      - A pointwise function giving boundary values
814456cf3b9cSMatthew G. Knepley . bcFunc_t    - A pointwise function giving the time derviative of the boundary values
8145a6ba4734SToby Isaac . numids      - The number of DMLabel ids for constrained points
8146a6ba4734SToby Isaac . ids         - An array of ids for constrained points
8147a6ba4734SToby Isaac - ctx         - An optional user context for bcFunc
8148a6ba4734SToby Isaac 
8149a6ba4734SToby Isaac   Options Database Keys:
8150a6ba4734SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids
8151a6ba4734SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components
8152a6ba4734SToby Isaac 
8153a6ba4734SToby Isaac   Level: developer
8154a6ba4734SToby Isaac 
8155a6ba4734SToby Isaac .seealso: DMAddBoundary()
8156a6ba4734SToby Isaac @*/
815756cf3b9cSMatthew 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)(void), void (**func_t)(void), PetscInt *numids, const PetscInt **ids, void **ctx)
8158a6ba4734SToby Isaac {
8159e5e52638SMatthew G. Knepley   PetscDS        ds;
816058ebd649SToby Isaac   PetscErrorCode ierr;
8161a6ba4734SToby Isaac 
8162a6ba4734SToby Isaac   PetscFunctionBegin;
8163a6ba4734SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8164e5e52638SMatthew G. Knepley   ierr = DMGetDS(dm, &ds);CHKERRQ(ierr);
816556cf3b9cSMatthew G. Knepley   ierr = PetscDSGetBoundary(ds, bd, type, name, labelname, field, numcomps, comps, func, func_t, numids, ids, ctx);CHKERRQ(ierr);
8166a6ba4734SToby Isaac   PetscFunctionReturn(0);
8167a6ba4734SToby Isaac }
8168a6ba4734SToby Isaac 
8169e6f8dbb6SToby Isaac static PetscErrorCode DMPopulateBoundary(DM dm)
8170e6f8dbb6SToby Isaac {
8171e5e52638SMatthew G. Knepley   PetscDS        ds;
8172dff059c6SToby Isaac   DMBoundary    *lastnext;
8173e6f8dbb6SToby Isaac   DSBoundary     dsbound;
8174e6f8dbb6SToby Isaac   PetscErrorCode ierr;
8175e6f8dbb6SToby Isaac 
8176e6f8dbb6SToby Isaac   PetscFunctionBegin;
8177e5e52638SMatthew G. Knepley   ierr = DMGetDS(dm, &ds);CHKERRQ(ierr);
8178e5e52638SMatthew G. Knepley   dsbound = ds->boundary;
817947a1f5adSToby Isaac   if (dm->boundary) {
818047a1f5adSToby Isaac     DMBoundary next = dm->boundary;
818147a1f5adSToby Isaac 
818247a1f5adSToby Isaac     /* quick check to see if the PetscDS has changed */
818347a1f5adSToby Isaac     if (next->dsboundary == dsbound) PetscFunctionReturn(0);
818447a1f5adSToby Isaac     /* the PetscDS has changed: tear down and rebuild */
818547a1f5adSToby Isaac     while (next) {
818647a1f5adSToby Isaac       DMBoundary b = next;
818747a1f5adSToby Isaac 
818847a1f5adSToby Isaac       next = b->next;
818947a1f5adSToby Isaac       ierr = PetscFree(b);CHKERRQ(ierr);
8190a6ba4734SToby Isaac     }
819147a1f5adSToby Isaac     dm->boundary = NULL;
8192a6ba4734SToby Isaac   }
819347a1f5adSToby Isaac 
8194dff059c6SToby Isaac   lastnext = &(dm->boundary);
8195e6f8dbb6SToby Isaac   while (dsbound) {
8196e6f8dbb6SToby Isaac     DMBoundary dmbound;
8197e6f8dbb6SToby Isaac 
8198e6f8dbb6SToby Isaac     ierr = PetscNew(&dmbound);CHKERRQ(ierr);
8199e6f8dbb6SToby Isaac     dmbound->dsboundary = dsbound;
8200e6f8dbb6SToby Isaac     ierr = DMGetLabel(dm, dsbound->labelname, &(dmbound->label));CHKERRQ(ierr);
8201994fe344SLisandro Dalcin     if (!dmbound->label) {ierr = PetscInfo2(dm, "DSBoundary %s wants label %s, which is not in this dm.\n",dsbound->name,dsbound->labelname);CHKERRQ(ierr);}
820247a1f5adSToby Isaac     /* push on the back instead of the front so that it is in the same order as in the PetscDS */
8203dff059c6SToby Isaac     *lastnext = dmbound;
8204dff059c6SToby Isaac     lastnext = &(dmbound->next);
8205dff059c6SToby Isaac     dsbound = dsbound->next;
8206a6ba4734SToby Isaac   }
8207a6ba4734SToby Isaac   PetscFunctionReturn(0);
8208a6ba4734SToby Isaac }
8209a6ba4734SToby Isaac 
8210a6ba4734SToby Isaac PetscErrorCode DMIsBoundaryPoint(DM dm, PetscInt point, PetscBool *isBd)
8211a6ba4734SToby Isaac {
8212b95f2879SToby Isaac   DMBoundary     b;
8213a6ba4734SToby Isaac   PetscErrorCode ierr;
8214a6ba4734SToby Isaac 
8215a6ba4734SToby Isaac   PetscFunctionBegin;
8216a6ba4734SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8217534a8f05SLisandro Dalcin   PetscValidBoolPointer(isBd, 3);
8218a6ba4734SToby Isaac   *isBd = PETSC_FALSE;
8219e6f8dbb6SToby Isaac   ierr = DMPopulateBoundary(dm);CHKERRQ(ierr);
8220b95f2879SToby Isaac   b = dm->boundary;
8221a6ba4734SToby Isaac   while (b && !(*isBd)) {
8222e6f8dbb6SToby Isaac     DMLabel    label = b->label;
8223e6f8dbb6SToby Isaac     DSBoundary dsb = b->dsboundary;
82243424c85cSToby Isaac 
82253424c85cSToby Isaac     if (label) {
8226a6ba4734SToby Isaac       PetscInt i;
8227a6ba4734SToby Isaac 
8228e6f8dbb6SToby Isaac       for (i = 0; i < dsb->numids && !(*isBd); ++i) {
8229e6f8dbb6SToby Isaac         ierr = DMLabelStratumHasPoint(label, dsb->ids[i], point, isBd);CHKERRQ(ierr);
8230a6ba4734SToby Isaac       }
8231a6ba4734SToby Isaac     }
8232a6ba4734SToby Isaac     b = b->next;
8233a6ba4734SToby Isaac   }
8234a6ba4734SToby Isaac   PetscFunctionReturn(0);
8235a6ba4734SToby Isaac }
82364d6f44ffSToby Isaac 
82374d6f44ffSToby Isaac /*@C
8238a6e0b375SMatthew G. Knepley   DMProjectFunction - This projects the given function into the function space provided, putting the coefficients in a global vector.
8239a6e0b375SMatthew G. Knepley 
8240a6e0b375SMatthew G. Knepley   Collective on DM
82414d6f44ffSToby Isaac 
82424d6f44ffSToby Isaac   Input Parameters:
82434d6f44ffSToby Isaac + dm      - The DM
82440709b2feSToby Isaac . time    - The time
82454d6f44ffSToby Isaac . funcs   - The coordinate functions to evaluate, one per field
82464d6f44ffSToby Isaac . ctxs    - Optional array of contexts to pass to each coordinate function.  ctxs itself may be null.
82474d6f44ffSToby Isaac - mode    - The insertion mode for values
82484d6f44ffSToby Isaac 
82494d6f44ffSToby Isaac   Output Parameter:
82504d6f44ffSToby Isaac . X - vector
82514d6f44ffSToby Isaac 
82524d6f44ffSToby Isaac    Calling sequence of func:
82530709b2feSToby Isaac $    func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nf, PetscScalar u[], void *ctx);
82544d6f44ffSToby Isaac 
82554d6f44ffSToby Isaac +  dim - The spatial dimension
82568ec8862eSJed Brown .  time - The time at which to sample
82574d6f44ffSToby Isaac .  x   - The coordinates
82584d6f44ffSToby Isaac .  Nf  - The number of fields
82594d6f44ffSToby Isaac .  u   - The output field values
82604d6f44ffSToby Isaac -  ctx - optional user-defined function context
82614d6f44ffSToby Isaac 
82624d6f44ffSToby Isaac   Level: developer
82634d6f44ffSToby Isaac 
8264a6e0b375SMatthew G. Knepley .seealso: DMProjectFunctionLocal(), DMProjectFunctionLabel(), DMComputeL2Diff()
82654d6f44ffSToby Isaac @*/
82660709b2feSToby Isaac PetscErrorCode DMProjectFunction(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec X)
82674d6f44ffSToby Isaac {
82684d6f44ffSToby Isaac   Vec            localX;
82694d6f44ffSToby Isaac   PetscErrorCode ierr;
82704d6f44ffSToby Isaac 
82714d6f44ffSToby Isaac   PetscFunctionBegin;
82724d6f44ffSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
82734d6f44ffSToby Isaac   ierr = DMGetLocalVector(dm, &localX);CHKERRQ(ierr);
82740709b2feSToby Isaac   ierr = DMProjectFunctionLocal(dm, time, funcs, ctxs, mode, localX);CHKERRQ(ierr);
82754d6f44ffSToby Isaac   ierr = DMLocalToGlobalBegin(dm, localX, mode, X);CHKERRQ(ierr);
82764d6f44ffSToby Isaac   ierr = DMLocalToGlobalEnd(dm, localX, mode, X);CHKERRQ(ierr);
82774d6f44ffSToby Isaac   ierr = DMRestoreLocalVector(dm, &localX);CHKERRQ(ierr);
82784d6f44ffSToby Isaac   PetscFunctionReturn(0);
82794d6f44ffSToby Isaac }
82804d6f44ffSToby Isaac 
8281a6e0b375SMatthew G. Knepley /*@C
8282a6e0b375SMatthew G. Knepley   DMProjectFunctionLocal - This projects the given function into the function space provided, putting the coefficients in a local vector.
8283a6e0b375SMatthew G. Knepley 
8284a6e0b375SMatthew G. Knepley   Not collective
8285a6e0b375SMatthew G. Knepley 
8286a6e0b375SMatthew G. Knepley   Input Parameters:
8287a6e0b375SMatthew G. Knepley + dm      - The DM
8288a6e0b375SMatthew G. Knepley . time    - The time
8289a6e0b375SMatthew G. Knepley . funcs   - The coordinate functions to evaluate, one per field
8290a6e0b375SMatthew G. Knepley . ctxs    - Optional array of contexts to pass to each coordinate function.  ctxs itself may be null.
8291a6e0b375SMatthew G. Knepley - mode    - The insertion mode for values
8292a6e0b375SMatthew G. Knepley 
8293a6e0b375SMatthew G. Knepley   Output Parameter:
8294a6e0b375SMatthew G. Knepley . localX - vector
8295a6e0b375SMatthew G. Knepley 
8296a6e0b375SMatthew G. Knepley    Calling sequence of func:
8297a6e0b375SMatthew G. Knepley $    func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nf, PetscScalar u[], void *ctx);
8298a6e0b375SMatthew G. Knepley 
8299a6e0b375SMatthew G. Knepley +  dim - The spatial dimension
8300a6e0b375SMatthew G. Knepley .  x   - The coordinates
8301a6e0b375SMatthew G. Knepley .  Nf  - The number of fields
8302a6e0b375SMatthew G. Knepley .  u   - The output field values
8303a6e0b375SMatthew G. Knepley -  ctx - optional user-defined function context
8304a6e0b375SMatthew G. Knepley 
8305a6e0b375SMatthew G. Knepley   Level: developer
8306a6e0b375SMatthew G. Knepley 
8307a6e0b375SMatthew G. Knepley .seealso: DMProjectFunction(), DMProjectFunctionLabel(), DMComputeL2Diff()
8308a6e0b375SMatthew G. Knepley @*/
83090709b2feSToby Isaac PetscErrorCode DMProjectFunctionLocal(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec localX)
83104d6f44ffSToby Isaac {
83114d6f44ffSToby Isaac   PetscErrorCode ierr;
83124d6f44ffSToby Isaac 
83134d6f44ffSToby Isaac   PetscFunctionBegin;
83144d6f44ffSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
83154d6f44ffSToby Isaac   PetscValidHeaderSpecific(localX,VEC_CLASSID,5);
83160918c465SMatthew G. Knepley   if (!dm->ops->projectfunctionlocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFunctionLocal",((PetscObject)dm)->type_name);
83170709b2feSToby Isaac   ierr = (dm->ops->projectfunctionlocal) (dm, time, funcs, ctxs, mode, localX);CHKERRQ(ierr);
83184d6f44ffSToby Isaac   PetscFunctionReturn(0);
83194d6f44ffSToby Isaac }
83204d6f44ffSToby Isaac 
8321a6e0b375SMatthew G. Knepley /*@C
8322a6e0b375SMatthew G. Knepley   DMProjectFunctionLabel - This projects the given function into the function space provided, putting the coefficients in a global vector, setting values only for points in the given label.
8323a6e0b375SMatthew G. Knepley 
8324a6e0b375SMatthew G. Knepley   Collective on DM
8325a6e0b375SMatthew G. Knepley 
8326a6e0b375SMatthew G. Knepley   Input Parameters:
8327a6e0b375SMatthew G. Knepley + dm      - The DM
8328a6e0b375SMatthew G. Knepley . time    - The time
8329a6e0b375SMatthew G. Knepley . label   - The DMLabel selecting the portion of the mesh for projection
8330a6e0b375SMatthew G. Knepley . funcs   - The coordinate functions to evaluate, one per field
8331a6e0b375SMatthew G. Knepley . ctxs    - Optional array of contexts to pass to each coordinate function.  ctxs itself may be null.
8332a6e0b375SMatthew G. Knepley - mode    - The insertion mode for values
8333a6e0b375SMatthew G. Knepley 
8334a6e0b375SMatthew G. Knepley   Output Parameter:
8335a6e0b375SMatthew G. Knepley . X - vector
8336a6e0b375SMatthew G. Knepley 
8337a6e0b375SMatthew G. Knepley    Calling sequence of func:
8338a6e0b375SMatthew G. Knepley $    func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nf, PetscScalar u[], void *ctx);
8339a6e0b375SMatthew G. Knepley 
8340a6e0b375SMatthew G. Knepley +  dim - The spatial dimension
8341a6e0b375SMatthew G. Knepley .  x   - The coordinates
8342a6e0b375SMatthew G. Knepley .  Nf  - The number of fields
8343a6e0b375SMatthew G. Knepley .  u   - The output field values
8344a6e0b375SMatthew G. Knepley -  ctx - optional user-defined function context
8345a6e0b375SMatthew G. Knepley 
8346a6e0b375SMatthew G. Knepley   Level: developer
8347a6e0b375SMatthew G. Knepley 
8348a6e0b375SMatthew G. Knepley .seealso: DMProjectFunction(), DMProjectFunctionLocal(), DMProjectFunctionLabelLocal(), DMComputeL2Diff()
8349a6e0b375SMatthew G. Knepley @*/
83502c53366bSMatthew G. Knepley PetscErrorCode DMProjectFunctionLabel(DM dm, PetscReal time, DMLabel label, PetscInt numIds, const PetscInt ids[], PetscInt Nc, const PetscInt comps[], PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec X)
83512c53366bSMatthew G. Knepley {
83522c53366bSMatthew G. Knepley   Vec            localX;
83532c53366bSMatthew G. Knepley   PetscErrorCode ierr;
83542c53366bSMatthew G. Knepley 
83552c53366bSMatthew G. Knepley   PetscFunctionBegin;
83562c53366bSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
83572c53366bSMatthew G. Knepley   ierr = DMGetLocalVector(dm, &localX);CHKERRQ(ierr);
83582c53366bSMatthew G. Knepley   ierr = DMProjectFunctionLabelLocal(dm, time, label, numIds, ids, Nc, comps, funcs, ctxs, mode, localX);CHKERRQ(ierr);
83592c53366bSMatthew G. Knepley   ierr = DMLocalToGlobalBegin(dm, localX, mode, X);CHKERRQ(ierr);
83602c53366bSMatthew G. Knepley   ierr = DMLocalToGlobalEnd(dm, localX, mode, X);CHKERRQ(ierr);
83612c53366bSMatthew G. Knepley   ierr = DMRestoreLocalVector(dm, &localX);CHKERRQ(ierr);
83622c53366bSMatthew G. Knepley   PetscFunctionReturn(0);
83632c53366bSMatthew G. Knepley }
83642c53366bSMatthew G. Knepley 
8365a6e0b375SMatthew G. Knepley /*@C
8366a6e0b375SMatthew G. Knepley   DMProjectFunctionLabelLocal - This projects the given function into the function space provided, putting the coefficients in a local vector, setting values only for points in the given label.
8367a6e0b375SMatthew G. Knepley 
8368a6e0b375SMatthew G. Knepley   Not collective
8369a6e0b375SMatthew G. Knepley 
8370a6e0b375SMatthew G. Knepley   Input Parameters:
8371a6e0b375SMatthew G. Knepley + dm      - The DM
8372a6e0b375SMatthew G. Knepley . time    - The time
8373a6e0b375SMatthew G. Knepley . label   - The DMLabel selecting the portion of the mesh for projection
8374a6e0b375SMatthew G. Knepley . funcs   - The coordinate functions to evaluate, one per field
8375a6e0b375SMatthew G. Knepley . ctxs    - Optional array of contexts to pass to each coordinate function.  ctxs itself may be null.
8376a6e0b375SMatthew G. Knepley - mode    - The insertion mode for values
8377a6e0b375SMatthew G. Knepley 
8378a6e0b375SMatthew G. Knepley   Output Parameter:
8379a6e0b375SMatthew G. Knepley . localX - vector
8380a6e0b375SMatthew G. Knepley 
8381a6e0b375SMatthew G. Knepley    Calling sequence of func:
8382a6e0b375SMatthew G. Knepley $    func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nf, PetscScalar u[], void *ctx);
8383a6e0b375SMatthew G. Knepley 
8384a6e0b375SMatthew G. Knepley +  dim - The spatial dimension
8385a6e0b375SMatthew G. Knepley .  x   - The coordinates
8386a6e0b375SMatthew G. Knepley .  Nf  - The number of fields
8387a6e0b375SMatthew G. Knepley .  u   - The output field values
8388a6e0b375SMatthew G. Knepley -  ctx - optional user-defined function context
8389a6e0b375SMatthew G. Knepley 
8390a6e0b375SMatthew G. Knepley   Level: developer
8391a6e0b375SMatthew G. Knepley 
8392a6e0b375SMatthew G. Knepley .seealso: DMProjectFunction(), DMProjectFunctionLocal(), DMProjectFunctionLabel(), DMComputeL2Diff()
8393a6e0b375SMatthew G. Knepley @*/
83941c531cf8SMatthew G. Knepley PetscErrorCode DMProjectFunctionLabelLocal(DM dm, PetscReal time, DMLabel label, PetscInt numIds, const PetscInt ids[], PetscInt Nc, const PetscInt comps[], PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec localX)
83954d6f44ffSToby Isaac {
83964d6f44ffSToby Isaac   PetscErrorCode ierr;
83974d6f44ffSToby Isaac 
83984d6f44ffSToby Isaac   PetscFunctionBegin;
83994d6f44ffSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
84004d6f44ffSToby Isaac   PetscValidHeaderSpecific(localX,VEC_CLASSID,5);
84010918c465SMatthew G. Knepley   if (!dm->ops->projectfunctionlabellocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFunctionLabelLocal",((PetscObject)dm)->type_name);
84021c531cf8SMatthew G. Knepley   ierr = (dm->ops->projectfunctionlabellocal) (dm, time, label, numIds, ids, Nc, comps, funcs, ctxs, mode, localX);CHKERRQ(ierr);
84034d6f44ffSToby Isaac   PetscFunctionReturn(0);
84044d6f44ffSToby Isaac }
84052716604bSToby Isaac 
8406a6e0b375SMatthew G. Knepley /*@C
8407a6e0b375SMatthew G. Knepley   DMProjectFieldLocal - This projects the given function of the input fields into the function space provided, putting the coefficients in a local vector.
8408a6e0b375SMatthew G. Knepley 
8409a6e0b375SMatthew G. Knepley   Not collective
8410a6e0b375SMatthew G. Knepley 
8411a6e0b375SMatthew G. Knepley   Input Parameters:
8412a6e0b375SMatthew G. Knepley + dm      - The DM
8413a6e0b375SMatthew G. Knepley . time    - The time
8414a6e0b375SMatthew G. Knepley . localU  - The input field vector
8415a6e0b375SMatthew G. Knepley . funcs   - The functions to evaluate, one per field
8416a6e0b375SMatthew G. Knepley - mode    - The insertion mode for values
8417a6e0b375SMatthew G. Knepley 
8418a6e0b375SMatthew G. Knepley   Output Parameter:
8419a6e0b375SMatthew G. Knepley . localX  - The output vector
8420a6e0b375SMatthew G. Knepley 
8421a6e0b375SMatthew G. Knepley    Calling sequence of func:
8422a6e0b375SMatthew G. Knepley $    func(PetscInt dim, PetscInt Nf, PetscInt NfAux,
8423a6e0b375SMatthew G. Knepley $         const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
8424a6e0b375SMatthew G. Knepley $         const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
8425a6e0b375SMatthew G. Knepley $         PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f[]);
8426a6e0b375SMatthew G. Knepley 
8427a6e0b375SMatthew G. Knepley +  dim          - The spatial dimension
8428a6e0b375SMatthew G. Knepley .  Nf           - The number of input fields
8429a6e0b375SMatthew G. Knepley .  NfAux        - The number of input auxiliary fields
8430a6e0b375SMatthew G. Knepley .  uOff         - The offset of each field in u[]
8431a6e0b375SMatthew G. Knepley .  uOff_x       - The offset of each field in u_x[]
8432a6e0b375SMatthew G. Knepley .  u            - The field values at this point in space
8433a6e0b375SMatthew G. Knepley .  u_t          - The field time derivative at this point in space (or NULL)
8434a6e0b375SMatthew G. Knepley .  u_x          - The field derivatives at this point in space
8435a6e0b375SMatthew G. Knepley .  aOff         - The offset of each auxiliary field in u[]
8436a6e0b375SMatthew G. Knepley .  aOff_x       - The offset of each auxiliary field in u_x[]
8437a6e0b375SMatthew G. Knepley .  a            - The auxiliary field values at this point in space
8438a6e0b375SMatthew G. Knepley .  a_t          - The auxiliary field time derivative at this point in space (or NULL)
8439a6e0b375SMatthew G. Knepley .  a_x          - The auxiliary field derivatives at this point in space
8440a6e0b375SMatthew G. Knepley .  t            - The current time
8441a6e0b375SMatthew G. Knepley .  x            - The coordinates of this point
8442a6e0b375SMatthew G. Knepley .  numConstants - The number of constants
8443a6e0b375SMatthew G. Knepley .  constants    - The value of each constant
8444a6e0b375SMatthew G. Knepley -  f            - The value of the function at this point in space
8445a6e0b375SMatthew G. Knepley 
8446a6e0b375SMatthew G. Knepley   Note: There are three different DMs that potentially interact in this function. The output DM, dm, specifies the layout of the values calculates by funcs.
8447a6e0b375SMatthew G. Knepley   The input DM, attached to U, may be different. For example, you can input the solution over the full domain, but output over a piece of the boundary, or
8448a6e0b375SMatthew G. Knepley   a subdomain. You can also output a different number of fields than the input, with different discretizations. Last the auxiliary DM, attached to the
8449a6e0b375SMatthew G. Knepley   auxiliary field vector, which is attached to dm, can also be different. It can have a different topology, number of fields, and discretizations.
8450a6e0b375SMatthew G. Knepley 
8451a6e0b375SMatthew G. Knepley   Level: intermediate
8452a6e0b375SMatthew G. Knepley 
8453a6e0b375SMatthew G. Knepley .seealso: DMProjectField(), DMProjectFieldLabelLocal(), DMProjectFunction(), DMComputeL2Diff()
8454a6e0b375SMatthew G. Knepley @*/
84558c6c5593SMatthew G. Knepley PetscErrorCode DMProjectFieldLocal(DM dm, PetscReal time, Vec localU,
84568c6c5593SMatthew G. Knepley                                    void (**funcs)(PetscInt, PetscInt, PetscInt,
84578c6c5593SMatthew G. Knepley                                                   const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
84588c6c5593SMatthew G. Knepley                                                   const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
8459191494d9SMatthew G. Knepley                                                   PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]),
84608c6c5593SMatthew G. Knepley                                    InsertMode mode, Vec localX)
84618c6c5593SMatthew G. Knepley {
84628c6c5593SMatthew G. Knepley   PetscErrorCode ierr;
84638c6c5593SMatthew G. Knepley 
84648c6c5593SMatthew G. Knepley   PetscFunctionBegin;
84658c6c5593SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
84668c6c5593SMatthew G. Knepley   PetscValidHeaderSpecific(localU,VEC_CLASSID,3);
84678c6c5593SMatthew G. Knepley   PetscValidHeaderSpecific(localX,VEC_CLASSID,6);
84680918c465SMatthew G. Knepley   if (!dm->ops->projectfieldlocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFieldLocal",((PetscObject)dm)->type_name);
84698c6c5593SMatthew G. Knepley   ierr = (dm->ops->projectfieldlocal) (dm, time, localU, funcs, mode, localX);CHKERRQ(ierr);
84708c6c5593SMatthew G. Knepley   PetscFunctionReturn(0);
84718c6c5593SMatthew G. Knepley }
84728c6c5593SMatthew G. Knepley 
8473a6e0b375SMatthew G. Knepley /*@C
8474a6e0b375SMatthew G. Knepley   DMProjectFieldLabelLocal - This projects the given function of the input fields into the function space provided, putting the coefficients in a local vector, calculating only over the portion of the domain specified by the label.
8475a6e0b375SMatthew G. Knepley 
8476a6e0b375SMatthew G. Knepley   Not collective
8477a6e0b375SMatthew G. Knepley 
8478a6e0b375SMatthew G. Knepley   Input Parameters:
8479a6e0b375SMatthew G. Knepley + dm      - The DM
8480a6e0b375SMatthew G. Knepley . time    - The time
8481a6e0b375SMatthew G. Knepley . label   - The DMLabel marking the portion of the domain to output
8482a6e0b375SMatthew G. Knepley . numIds  - The number of label ids to use
8483a6e0b375SMatthew G. Knepley . ids     - The label ids to use for marking
8484a6e0b375SMatthew G. Knepley . Nc      - The number of components to set in the output, or PETSC_DETERMINE for all components
8485a6e0b375SMatthew G. Knepley . comps   - The components to set in the output, or NULL for all components
8486a6e0b375SMatthew G. Knepley . localU  - The input field vector
8487a6e0b375SMatthew G. Knepley . funcs   - The functions to evaluate, one per field
8488a6e0b375SMatthew G. Knepley - mode    - The insertion mode for values
8489a6e0b375SMatthew G. Knepley 
8490a6e0b375SMatthew G. Knepley   Output Parameter:
8491a6e0b375SMatthew G. Knepley . localX  - The output vector
8492a6e0b375SMatthew G. Knepley 
8493a6e0b375SMatthew G. Knepley    Calling sequence of func:
8494a6e0b375SMatthew G. Knepley $    func(PetscInt dim, PetscInt Nf, PetscInt NfAux,
8495a6e0b375SMatthew G. Knepley $         const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
8496a6e0b375SMatthew G. Knepley $         const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
8497a6e0b375SMatthew G. Knepley $         PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f[]);
8498a6e0b375SMatthew G. Knepley 
8499a6e0b375SMatthew G. Knepley +  dim          - The spatial dimension
8500a6e0b375SMatthew G. Knepley .  Nf           - The number of input fields
8501a6e0b375SMatthew G. Knepley .  NfAux        - The number of input auxiliary fields
8502a6e0b375SMatthew G. Knepley .  uOff         - The offset of each field in u[]
8503a6e0b375SMatthew G. Knepley .  uOff_x       - The offset of each field in u_x[]
8504a6e0b375SMatthew G. Knepley .  u            - The field values at this point in space
8505a6e0b375SMatthew G. Knepley .  u_t          - The field time derivative at this point in space (or NULL)
8506a6e0b375SMatthew G. Knepley .  u_x          - The field derivatives at this point in space
8507a6e0b375SMatthew G. Knepley .  aOff         - The offset of each auxiliary field in u[]
8508a6e0b375SMatthew G. Knepley .  aOff_x       - The offset of each auxiliary field in u_x[]
8509a6e0b375SMatthew G. Knepley .  a            - The auxiliary field values at this point in space
8510a6e0b375SMatthew G. Knepley .  a_t          - The auxiliary field time derivative at this point in space (or NULL)
8511a6e0b375SMatthew G. Knepley .  a_x          - The auxiliary field derivatives at this point in space
8512a6e0b375SMatthew G. Knepley .  t            - The current time
8513a6e0b375SMatthew G. Knepley .  x            - The coordinates of this point
8514a6e0b375SMatthew G. Knepley .  numConstants - The number of constants
8515a6e0b375SMatthew G. Knepley .  constants    - The value of each constant
8516a6e0b375SMatthew G. Knepley -  f            - The value of the function at this point in space
8517a6e0b375SMatthew G. Knepley 
8518a6e0b375SMatthew G. Knepley   Note: There are three different DMs that potentially interact in this function. The output DM, dm, specifies the layout of the values calculates by funcs.
8519a6e0b375SMatthew G. Knepley   The input DM, attached to U, may be different. For example, you can input the solution over the full domain, but output over a piece of the boundary, or
8520a6e0b375SMatthew G. Knepley   a subdomain. You can also output a different number of fields than the input, with different discretizations. Last the auxiliary DM, attached to the
8521a6e0b375SMatthew G. Knepley   auxiliary field vector, which is attached to dm, can also be different. It can have a different topology, number of fields, and discretizations.
8522a6e0b375SMatthew G. Knepley 
8523a6e0b375SMatthew G. Knepley   Level: intermediate
8524a6e0b375SMatthew G. Knepley 
8525a6e0b375SMatthew G. Knepley .seealso: DMProjectField(), DMProjectFieldLabelLocal(), DMProjectFunction(), DMComputeL2Diff()
8526a6e0b375SMatthew G. Knepley @*/
85271c531cf8SMatthew G. Knepley PetscErrorCode DMProjectFieldLabelLocal(DM dm, PetscReal time, DMLabel label, PetscInt numIds, const PetscInt ids[], PetscInt Nc, const PetscInt comps[], Vec localU,
85288c6c5593SMatthew G. Knepley                                         void (**funcs)(PetscInt, PetscInt, PetscInt,
85298c6c5593SMatthew G. Knepley                                                        const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
85308c6c5593SMatthew G. Knepley                                                        const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
8531191494d9SMatthew G. Knepley                                                        PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]),
85328c6c5593SMatthew G. Knepley                                         InsertMode mode, Vec localX)
85338c6c5593SMatthew G. Knepley {
85348c6c5593SMatthew G. Knepley   PetscErrorCode ierr;
85358c6c5593SMatthew G. Knepley 
85368c6c5593SMatthew G. Knepley   PetscFunctionBegin;
85378c6c5593SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
85388c6c5593SMatthew G. Knepley   PetscValidHeaderSpecific(localU,VEC_CLASSID,6);
85398c6c5593SMatthew G. Knepley   PetscValidHeaderSpecific(localX,VEC_CLASSID,9);
8540ece3a9fcSMatthew G. Knepley   if (!dm->ops->projectfieldlabellocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFieldLabelLocal",((PetscObject)dm)->type_name);
85411c531cf8SMatthew G. Knepley   ierr = (dm->ops->projectfieldlabellocal)(dm, time, label, numIds, ids, Nc, comps, localU, funcs, mode, localX);CHKERRQ(ierr);
85428c6c5593SMatthew G. Knepley   PetscFunctionReturn(0);
85438c6c5593SMatthew G. Knepley }
85448c6c5593SMatthew G. Knepley 
85452716604bSToby Isaac /*@C
8546ece3a9fcSMatthew G. Knepley   DMProjectBdFieldLabelLocal - This projects the given function of the input fields into the function space provided, putting the coefficients in a local vector, calculating only over the portion of the domain boundary specified by the label.
8547ece3a9fcSMatthew G. Knepley 
8548ece3a9fcSMatthew G. Knepley   Not collective
8549ece3a9fcSMatthew G. Knepley 
8550ece3a9fcSMatthew G. Knepley   Input Parameters:
8551ece3a9fcSMatthew G. Knepley + dm      - The DM
8552ece3a9fcSMatthew G. Knepley . time    - The time
8553ece3a9fcSMatthew G. Knepley . label   - The DMLabel marking the portion of the domain boundary to output
8554ece3a9fcSMatthew G. Knepley . numIds  - The number of label ids to use
8555ece3a9fcSMatthew G. Knepley . ids     - The label ids to use for marking
8556ece3a9fcSMatthew G. Knepley . Nc      - The number of components to set in the output, or PETSC_DETERMINE for all components
8557ece3a9fcSMatthew G. Knepley . comps   - The components to set in the output, or NULL for all components
8558ece3a9fcSMatthew G. Knepley . localU  - The input field vector
8559ece3a9fcSMatthew G. Knepley . funcs   - The functions to evaluate, one per field
8560ece3a9fcSMatthew G. Knepley - mode    - The insertion mode for values
8561ece3a9fcSMatthew G. Knepley 
8562ece3a9fcSMatthew G. Knepley   Output Parameter:
8563ece3a9fcSMatthew G. Knepley . localX  - The output vector
8564ece3a9fcSMatthew G. Knepley 
8565ece3a9fcSMatthew G. Knepley    Calling sequence of func:
8566ece3a9fcSMatthew G. Knepley $    func(PetscInt dim, PetscInt Nf, PetscInt NfAux,
8567ece3a9fcSMatthew G. Knepley $         const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
8568ece3a9fcSMatthew G. Knepley $         const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
8569ece3a9fcSMatthew G. Knepley $         PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f[]);
8570ece3a9fcSMatthew G. Knepley 
8571ece3a9fcSMatthew G. Knepley +  dim          - The spatial dimension
8572ece3a9fcSMatthew G. Knepley .  Nf           - The number of input fields
8573ece3a9fcSMatthew G. Knepley .  NfAux        - The number of input auxiliary fields
8574ece3a9fcSMatthew G. Knepley .  uOff         - The offset of each field in u[]
8575ece3a9fcSMatthew G. Knepley .  uOff_x       - The offset of each field in u_x[]
8576ece3a9fcSMatthew G. Knepley .  u            - The field values at this point in space
8577ece3a9fcSMatthew G. Knepley .  u_t          - The field time derivative at this point in space (or NULL)
8578ece3a9fcSMatthew G. Knepley .  u_x          - The field derivatives at this point in space
8579ece3a9fcSMatthew G. Knepley .  aOff         - The offset of each auxiliary field in u[]
8580ece3a9fcSMatthew G. Knepley .  aOff_x       - The offset of each auxiliary field in u_x[]
8581ece3a9fcSMatthew G. Knepley .  a            - The auxiliary field values at this point in space
8582ece3a9fcSMatthew G. Knepley .  a_t          - The auxiliary field time derivative at this point in space (or NULL)
8583ece3a9fcSMatthew G. Knepley .  a_x          - The auxiliary field derivatives at this point in space
8584ece3a9fcSMatthew G. Knepley .  t            - The current time
8585ece3a9fcSMatthew G. Knepley .  x            - The coordinates of this point
8586ece3a9fcSMatthew G. Knepley .  n            - The face normal
8587ece3a9fcSMatthew G. Knepley .  numConstants - The number of constants
8588ece3a9fcSMatthew G. Knepley .  constants    - The value of each constant
8589ece3a9fcSMatthew G. Knepley -  f            - The value of the function at this point in space
8590ece3a9fcSMatthew G. Knepley 
8591ece3a9fcSMatthew G. Knepley   Note:
8592ece3a9fcSMatthew G. Knepley   There are three different DMs that potentially interact in this function. The output DM, dm, specifies the layout of the values calculates by funcs.
8593ece3a9fcSMatthew G. Knepley   The input DM, attached to U, may be different. For example, you can input the solution over the full domain, but output over a piece of the boundary, or
8594ece3a9fcSMatthew G. Knepley   a subdomain. You can also output a different number of fields than the input, with different discretizations. Last the auxiliary DM, attached to the
8595ece3a9fcSMatthew G. Knepley   auxiliary field vector, which is attached to dm, can also be different. It can have a different topology, number of fields, and discretizations.
8596ece3a9fcSMatthew G. Knepley 
8597ece3a9fcSMatthew G. Knepley   Level: intermediate
8598ece3a9fcSMatthew G. Knepley 
8599ece3a9fcSMatthew G. Knepley .seealso: DMProjectField(), DMProjectFieldLabelLocal(), DMProjectFunction(), DMComputeL2Diff()
8600ece3a9fcSMatthew G. Knepley @*/
8601ece3a9fcSMatthew G. Knepley PetscErrorCode DMProjectBdFieldLabelLocal(DM dm, PetscReal time, DMLabel label, PetscInt numIds, const PetscInt ids[], PetscInt Nc, const PetscInt comps[], Vec localU,
8602ece3a9fcSMatthew G. Knepley                                           void (**funcs)(PetscInt, PetscInt, PetscInt,
8603ece3a9fcSMatthew G. Knepley                                                          const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
8604ece3a9fcSMatthew G. Knepley                                                          const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
8605ece3a9fcSMatthew G. Knepley                                                          PetscReal, const PetscReal[], const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]),
8606ece3a9fcSMatthew G. Knepley                                           InsertMode mode, Vec localX)
8607ece3a9fcSMatthew G. Knepley {
8608ece3a9fcSMatthew G. Knepley   PetscErrorCode ierr;
8609ece3a9fcSMatthew G. Knepley 
8610ece3a9fcSMatthew G. Knepley   PetscFunctionBegin;
8611ece3a9fcSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
8612ece3a9fcSMatthew G. Knepley   PetscValidHeaderSpecific(localU,VEC_CLASSID,6);
8613ece3a9fcSMatthew G. Knepley   PetscValidHeaderSpecific(localX,VEC_CLASSID,9);
8614ece3a9fcSMatthew G. Knepley   if (!dm->ops->projectbdfieldlabellocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectBdFieldLabelLocal",((PetscObject)dm)->type_name);
8615ece3a9fcSMatthew G. Knepley   ierr = (dm->ops->projectbdfieldlabellocal)(dm, time, label, numIds, ids, Nc, comps, localU, funcs, mode, localX);CHKERRQ(ierr);
8616ece3a9fcSMatthew G. Knepley   PetscFunctionReturn(0);
8617ece3a9fcSMatthew G. Knepley }
8618ece3a9fcSMatthew G. Knepley 
8619ece3a9fcSMatthew G. Knepley /*@C
86202716604bSToby Isaac   DMComputeL2Diff - This function computes the L_2 difference between a function u and an FEM interpolant solution u_h.
86212716604bSToby Isaac 
86222716604bSToby Isaac   Input Parameters:
86232716604bSToby Isaac + dm    - The DM
86240709b2feSToby Isaac . time  - The time
86252716604bSToby Isaac . funcs - The functions to evaluate for each field component
86262716604bSToby Isaac . ctxs  - Optional array of contexts to pass to each function, or NULL.
8627574a98acSMatthew G. Knepley - X     - The coefficient vector u_h, a global vector
86282716604bSToby Isaac 
86292716604bSToby Isaac   Output Parameter:
86302716604bSToby Isaac . diff - The diff ||u - u_h||_2
86312716604bSToby Isaac 
86322716604bSToby Isaac   Level: developer
86332716604bSToby Isaac 
86341189c1efSToby Isaac .seealso: DMProjectFunction(), DMComputeL2FieldDiff(), DMComputeL2GradientDiff()
86352716604bSToby Isaac @*/
86360709b2feSToby Isaac PetscErrorCode DMComputeL2Diff(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, Vec X, PetscReal *diff)
86372716604bSToby Isaac {
86382716604bSToby Isaac   PetscErrorCode ierr;
86392716604bSToby Isaac 
86402716604bSToby Isaac   PetscFunctionBegin;
86412716604bSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
8642b698f381SToby Isaac   PetscValidHeaderSpecific(X,VEC_CLASSID,5);
86430918c465SMatthew G. Knepley   if (!dm->ops->computel2diff) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2Diff",((PetscObject)dm)->type_name);
86440709b2feSToby Isaac   ierr = (dm->ops->computel2diff)(dm,time,funcs,ctxs,X,diff);CHKERRQ(ierr);
86452716604bSToby Isaac   PetscFunctionReturn(0);
86462716604bSToby Isaac }
8647b698f381SToby Isaac 
8648b698f381SToby Isaac /*@C
8649b698f381SToby Isaac   DMComputeL2GradientDiff - This function computes the L_2 difference between the gradient of a function u and an FEM interpolant solution grad u_h.
8650b698f381SToby Isaac 
8651d083f849SBarry Smith   Collective on dm
8652d083f849SBarry Smith 
8653b698f381SToby Isaac   Input Parameters:
8654b698f381SToby Isaac + dm    - The DM
8655b698f381SToby Isaac , time  - The time
8656b698f381SToby Isaac . funcs - The gradient functions to evaluate for each field component
8657b698f381SToby Isaac . ctxs  - Optional array of contexts to pass to each function, or NULL.
8658574a98acSMatthew G. Knepley . X     - The coefficient vector u_h, a global vector
8659b698f381SToby Isaac - n     - The vector to project along
8660b698f381SToby Isaac 
8661b698f381SToby Isaac   Output Parameter:
8662b698f381SToby Isaac . diff - The diff ||(grad u - grad u_h) . n||_2
8663b698f381SToby Isaac 
8664b698f381SToby Isaac   Level: developer
8665b698f381SToby Isaac 
8666b698f381SToby Isaac .seealso: DMProjectFunction(), DMComputeL2Diff()
8667b698f381SToby Isaac @*/
8668b698f381SToby 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)
8669b698f381SToby Isaac {
8670b698f381SToby Isaac   PetscErrorCode ierr;
8671b698f381SToby Isaac 
8672b698f381SToby Isaac   PetscFunctionBegin;
8673b698f381SToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
8674b698f381SToby Isaac   PetscValidHeaderSpecific(X,VEC_CLASSID,5);
8675b698f381SToby Isaac   if (!dm->ops->computel2gradientdiff) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2GradientDiff",((PetscObject)dm)->type_name);
8676b698f381SToby Isaac   ierr = (dm->ops->computel2gradientdiff)(dm,time,funcs,ctxs,X,n,diff);CHKERRQ(ierr);
8677b698f381SToby Isaac   PetscFunctionReturn(0);
8678b698f381SToby Isaac }
8679b698f381SToby Isaac 
86802a16baeaSToby Isaac /*@C
86812a16baeaSToby Isaac   DMComputeL2FieldDiff - This function computes the L_2 difference between a function u and an FEM interpolant solution u_h, separated into field components.
86822a16baeaSToby Isaac 
8683d083f849SBarry Smith   Collective on dm
8684d083f849SBarry Smith 
86852a16baeaSToby Isaac   Input Parameters:
86862a16baeaSToby Isaac + dm    - The DM
86872a16baeaSToby Isaac . time  - The time
86882a16baeaSToby Isaac . funcs - The functions to evaluate for each field component
86892a16baeaSToby Isaac . ctxs  - Optional array of contexts to pass to each function, or NULL.
8690574a98acSMatthew G. Knepley - X     - The coefficient vector u_h, a global vector
86912a16baeaSToby Isaac 
86922a16baeaSToby Isaac   Output Parameter:
86932a16baeaSToby Isaac . diff - The array of differences, ||u^f - u^f_h||_2
86942a16baeaSToby Isaac 
86952a16baeaSToby Isaac   Level: developer
86962a16baeaSToby Isaac 
86971189c1efSToby Isaac .seealso: DMProjectFunction(), DMComputeL2FieldDiff(), DMComputeL2GradientDiff()
86982a16baeaSToby Isaac @*/
86991189c1efSToby Isaac PetscErrorCode DMComputeL2FieldDiff(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, Vec X, PetscReal diff[])
87002a16baeaSToby Isaac {
87012a16baeaSToby Isaac   PetscErrorCode ierr;
87022a16baeaSToby Isaac 
87032a16baeaSToby Isaac   PetscFunctionBegin;
87042a16baeaSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
87052a16baeaSToby Isaac   PetscValidHeaderSpecific(X,VEC_CLASSID,5);
87060918c465SMatthew G. Knepley   if (!dm->ops->computel2fielddiff) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2FieldDiff",((PetscObject)dm)->type_name);
87072a16baeaSToby Isaac   ierr = (dm->ops->computel2fielddiff)(dm,time,funcs,ctxs,X,diff);CHKERRQ(ierr);
87082a16baeaSToby Isaac   PetscFunctionReturn(0);
87092a16baeaSToby Isaac }
87102a16baeaSToby Isaac 
8711df0b854cSToby Isaac /*@C
8712df0b854cSToby Isaac   DMAdaptLabel - Adapt a dm based on a label with values interpreted as coarsening and refining flags.  Specific implementations of DM maybe have
8713cd3c525cSToby Isaac                  specialized flags, but all implementations should accept flag values DM_ADAPT_DETERMINE, DM_ADAPT_KEEP, DM_ADAPT_REFINE, and DM_ADAPT_COARSEN.
8714df0b854cSToby Isaac 
8715df0b854cSToby Isaac   Collective on dm
8716df0b854cSToby Isaac 
8717df0b854cSToby Isaac   Input parameters:
8718df0b854cSToby Isaac + dm - the pre-adaptation DM object
8719a1b0c543SToby Isaac - label - label with the flags
8720df0b854cSToby Isaac 
8721df0b854cSToby Isaac   Output parameters:
87220d1cd5e0SMatthew G. Knepley . dmAdapt - the adapted DM object: may be NULL if an adapted DM could not be produced.
8723df0b854cSToby Isaac 
8724df0b854cSToby Isaac   Level: intermediate
87250d1cd5e0SMatthew G. Knepley 
87260d1cd5e0SMatthew G. Knepley .seealso: DMAdaptMetric(), DMCoarsen(), DMRefine()
8727df0b854cSToby Isaac @*/
87280d1cd5e0SMatthew G. Knepley PetscErrorCode DMAdaptLabel(DM dm, DMLabel label, DM *dmAdapt)
8729df0b854cSToby Isaac {
8730df0b854cSToby Isaac   PetscErrorCode ierr;
8731df0b854cSToby Isaac 
8732df0b854cSToby Isaac   PetscFunctionBegin;
8733df0b854cSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8734a1b0c543SToby Isaac   PetscValidPointer(label,2);
87350d1cd5e0SMatthew G. Knepley   PetscValidPointer(dmAdapt,3);
87360d1cd5e0SMatthew G. Knepley   *dmAdapt = NULL;
87376f25b0d8SLisandro Dalcin   if (!dm->ops->adaptlabel) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMAdaptLabel",((PetscObject)dm)->type_name);
87380d1cd5e0SMatthew G. Knepley   ierr = (dm->ops->adaptlabel)(dm, label, dmAdapt);CHKERRQ(ierr);
87390d1cd5e0SMatthew G. Knepley   PetscFunctionReturn(0);
87400d1cd5e0SMatthew G. Knepley }
87410d1cd5e0SMatthew G. Knepley 
87420d1cd5e0SMatthew G. Knepley /*@C
87430d1cd5e0SMatthew G. Knepley   DMAdaptMetric - Generates a mesh adapted to the specified metric field using the pragmatic library.
87440d1cd5e0SMatthew G. Knepley 
87450d1cd5e0SMatthew G. Knepley   Input Parameters:
87460d1cd5e0SMatthew G. Knepley + dm - The DM object
87470d1cd5e0SMatthew G. Knepley . metric - The metric to which the mesh is adapted, defined vertex-wise.
87486f25b0d8SLisandro Dalcin - bdLabel - Label for boundary tags, which will be preserved in the output mesh. bdLabel should be NULL if there is no such label, and should be different from "_boundary_".
87490d1cd5e0SMatthew G. Knepley 
87500d1cd5e0SMatthew G. Knepley   Output Parameter:
87510d1cd5e0SMatthew G. Knepley . dmAdapt  - Pointer to the DM object containing the adapted mesh
87520d1cd5e0SMatthew G. Knepley 
87530d1cd5e0SMatthew G. Knepley   Note: The label in the adapted mesh will be registered under the name of the input DMLabel object
87540d1cd5e0SMatthew G. Knepley 
87550d1cd5e0SMatthew G. Knepley   Level: advanced
87560d1cd5e0SMatthew G. Knepley 
87570d1cd5e0SMatthew G. Knepley .seealso: DMAdaptLabel(), DMCoarsen(), DMRefine()
87580d1cd5e0SMatthew G. Knepley @*/
87590d1cd5e0SMatthew G. Knepley PetscErrorCode DMAdaptMetric(DM dm, Vec metric, DMLabel bdLabel, DM *dmAdapt)
87600d1cd5e0SMatthew G. Knepley {
87610d1cd5e0SMatthew G. Knepley   PetscErrorCode ierr;
87620d1cd5e0SMatthew G. Knepley 
87630d1cd5e0SMatthew G. Knepley   PetscFunctionBegin;
87640d1cd5e0SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
87650d1cd5e0SMatthew G. Knepley   PetscValidHeaderSpecific(metric, VEC_CLASSID, 2);
87660d1cd5e0SMatthew G. Knepley   if (bdLabel) PetscValidPointer(bdLabel, 3);
87670d1cd5e0SMatthew G. Knepley   PetscValidPointer(dmAdapt, 4);
87686f25b0d8SLisandro Dalcin   *dmAdapt = NULL;
87696f25b0d8SLisandro Dalcin   if (!dm->ops->adaptmetric) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMAdaptMetric",((PetscObject)dm)->type_name);
87700d1cd5e0SMatthew G. Knepley   ierr = (dm->ops->adaptmetric)(dm, metric, bdLabel, dmAdapt);CHKERRQ(ierr);
8771df0b854cSToby Isaac   PetscFunctionReturn(0);
8772df0b854cSToby Isaac }
8773c4088d22SMatthew G. Knepley 
8774502a2867SDave May /*@C
8775502a2867SDave May  DMGetNeighbors - Gets an array containing the MPI rank of all the processes neighbors
8776502a2867SDave May 
8777502a2867SDave May  Not Collective
8778502a2867SDave May 
8779502a2867SDave May  Input Parameter:
8780502a2867SDave May .  dm    - The DM
8781502a2867SDave May 
87820a19bb7dSprj-  Output Parameters:
87830a19bb7dSprj- +  nranks - the number of neighbours
87840a19bb7dSprj- -  ranks - the neighbors ranks
8785502a2867SDave May 
8786502a2867SDave May  Notes:
8787502a2867SDave May  Do not free the array, it is freed when the DM is destroyed.
8788502a2867SDave May 
8789502a2867SDave May  Level: beginner
8790502a2867SDave May 
8791dec1416fSJunchao Zhang  .seealso: DMDAGetNeighbors(), PetscSFGetRootRanks()
8792502a2867SDave May @*/
8793502a2867SDave May PetscErrorCode DMGetNeighbors(DM dm,PetscInt *nranks,const PetscMPIInt *ranks[])
8794502a2867SDave May {
8795502a2867SDave May   PetscErrorCode ierr;
8796502a2867SDave May 
8797502a2867SDave May   PetscFunctionBegin;
8798502a2867SDave May   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
87990918c465SMatthew G. Knepley   if (!dm->ops->getneighbors) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMGetNeighbors",((PetscObject)dm)->type_name);
8800502a2867SDave May   ierr = (dm->ops->getneighbors)(dm,nranks,ranks);CHKERRQ(ierr);
8801502a2867SDave May   PetscFunctionReturn(0);
8802502a2867SDave May }
8803502a2867SDave May 
8804531c7667SBarry Smith #include <petsc/private/matimpl.h> /* Needed because of coloring->ctype below */
8805531c7667SBarry Smith 
8806531c7667SBarry Smith /*
8807531c7667SBarry Smith     Converts the input vector to a ghosted vector and then calls the standard coloring code.
8808531c7667SBarry Smith     This has be a different function because it requires DM which is not defined in the Mat library
8809531c7667SBarry Smith */
8810531c7667SBarry Smith PetscErrorCode  MatFDColoringApply_AIJDM(Mat J,MatFDColoring coloring,Vec x1,void *sctx)
8811531c7667SBarry Smith {
8812531c7667SBarry Smith   PetscErrorCode ierr;
8813531c7667SBarry Smith 
8814531c7667SBarry Smith   PetscFunctionBegin;
8815531c7667SBarry Smith   if (coloring->ctype == IS_COLORING_LOCAL) {
8816531c7667SBarry Smith     Vec x1local;
8817531c7667SBarry Smith     DM  dm;
8818531c7667SBarry Smith     ierr = MatGetDM(J,&dm);CHKERRQ(ierr);
8819531c7667SBarry Smith     if (!dm) SETERRQ(PetscObjectComm((PetscObject)J),PETSC_ERR_ARG_INCOMP,"IS_COLORING_LOCAL requires a DM");
8820531c7667SBarry Smith     ierr = DMGetLocalVector(dm,&x1local);CHKERRQ(ierr);
8821531c7667SBarry Smith     ierr = DMGlobalToLocalBegin(dm,x1,INSERT_VALUES,x1local);CHKERRQ(ierr);
8822531c7667SBarry Smith     ierr = DMGlobalToLocalEnd(dm,x1,INSERT_VALUES,x1local);CHKERRQ(ierr);
8823531c7667SBarry Smith     x1   = x1local;
8824531c7667SBarry Smith   }
8825531c7667SBarry Smith   ierr = MatFDColoringApply_AIJ(J,coloring,x1,sctx);CHKERRQ(ierr);
8826531c7667SBarry Smith   if (coloring->ctype == IS_COLORING_LOCAL) {
8827531c7667SBarry Smith     DM  dm;
8828531c7667SBarry Smith     ierr = MatGetDM(J,&dm);CHKERRQ(ierr);
8829531c7667SBarry Smith     ierr = DMRestoreLocalVector(dm,&x1);CHKERRQ(ierr);
8830531c7667SBarry Smith   }
8831531c7667SBarry Smith   PetscFunctionReturn(0);
8832531c7667SBarry Smith }
8833531c7667SBarry Smith 
8834531c7667SBarry Smith /*@
8835531c7667SBarry Smith     MatFDColoringUseDM - allows a MatFDColoring object to use the DM associated with the matrix to use a IS_COLORING_LOCAL coloring
8836531c7667SBarry Smith 
8837531c7667SBarry Smith     Input Parameter:
8838531c7667SBarry Smith .    coloring - the MatFDColoring object
8839531c7667SBarry Smith 
884095452b02SPatrick Sanan     Developer Notes:
884195452b02SPatrick Sanan     this routine exists because the PETSc Mat library does not know about the DM objects
8842531c7667SBarry Smith 
88431b266c99SBarry Smith     Level: advanced
88441b266c99SBarry Smith 
8845531c7667SBarry Smith .seealso: MatFDColoring, MatFDColoringCreate(), ISColoringType
8846531c7667SBarry Smith @*/
8847531c7667SBarry Smith PetscErrorCode  MatFDColoringUseDM(Mat coloring,MatFDColoring fdcoloring)
8848531c7667SBarry Smith {
8849531c7667SBarry Smith   PetscFunctionBegin;
8850531c7667SBarry Smith   coloring->ops->fdcoloringapply = MatFDColoringApply_AIJDM;
8851531c7667SBarry Smith   PetscFunctionReturn(0);
8852531c7667SBarry Smith }
88538320bc6fSPatrick Sanan 
88548320bc6fSPatrick Sanan /*@
88558320bc6fSPatrick Sanan     DMGetCompatibility - determine if two DMs are compatible
88568320bc6fSPatrick Sanan 
88578320bc6fSPatrick Sanan     Collective
88588320bc6fSPatrick Sanan 
88598320bc6fSPatrick Sanan     Input Parameters:
8860a5bc1bf3SBarry Smith +    dm1 - the first DM
88618320bc6fSPatrick Sanan -    dm2 - the second DM
88628320bc6fSPatrick Sanan 
88638320bc6fSPatrick Sanan     Output Parameters:
88648320bc6fSPatrick Sanan +    compatible - whether or not the two DMs are compatible
88658320bc6fSPatrick Sanan -    set - whether or not the compatible value was set
88668320bc6fSPatrick Sanan 
88678320bc6fSPatrick Sanan     Notes:
88688320bc6fSPatrick Sanan     Two DMs are deemed compatible if they represent the same parallel decomposition
88693d862458SPatrick Sanan     of the same topology. This implies that the section (field data) on one
88708320bc6fSPatrick Sanan     "makes sense" with respect to the topology and parallel decomposition of the other.
88713d862458SPatrick Sanan     Loosely speaking, compatible DMs represent the same domain and parallel
88723d862458SPatrick Sanan     decomposition, but hold different data.
88738320bc6fSPatrick Sanan 
88748320bc6fSPatrick Sanan     Typically, one would confirm compatibility if intending to simultaneously iterate
88758320bc6fSPatrick Sanan     over a pair of vectors obtained from different DMs.
88768320bc6fSPatrick Sanan 
88778320bc6fSPatrick Sanan     For example, two DMDA objects are compatible if they have the same local
88788320bc6fSPatrick Sanan     and global sizes and the same stencil width. They can have different numbers
88798320bc6fSPatrick Sanan     of degrees of freedom per node. Thus, one could use the node numbering from
88808320bc6fSPatrick Sanan     either DM in bounds for a loop over vectors derived from either DM.
88818320bc6fSPatrick Sanan 
88828320bc6fSPatrick Sanan     Consider the operation of summing data living on a 2-dof DMDA to data living
88838320bc6fSPatrick Sanan     on a 1-dof DMDA, which should be compatible, as in the following snippet.
88848320bc6fSPatrick Sanan .vb
88858320bc6fSPatrick Sanan   ...
88868320bc6fSPatrick Sanan   ierr = DMGetCompatibility(da1,da2,&compatible,&set);CHKERRQ(ierr);
88878320bc6fSPatrick Sanan   if (set && compatible)  {
88888320bc6fSPatrick Sanan     ierr = DMDAVecGetArrayDOF(da1,vec1,&arr1);CHKERRQ(ierr);
88898320bc6fSPatrick Sanan     ierr = DMDAVecGetArrayDOF(da2,vec2,&arr2);CHKERRQ(ierr);
88903d862458SPatrick Sanan     ierr = DMDAGetCorners(da1,&x,&y,NULL,&m,&n,NULL);CHKERRQ(ierr);
88918320bc6fSPatrick Sanan     for (j=y; j<y+n; ++j) {
88928320bc6fSPatrick Sanan       for (i=x; i<x+m, ++i) {
88938320bc6fSPatrick Sanan         arr1[j][i][0] = arr2[j][i][0] + arr2[j][i][1];
88948320bc6fSPatrick Sanan       }
88958320bc6fSPatrick Sanan     }
88968320bc6fSPatrick Sanan     ierr = DMDAVecRestoreArrayDOF(da1,vec1,&arr1);CHKERRQ(ierr);
88978320bc6fSPatrick Sanan     ierr = DMDAVecRestoreArrayDOF(da2,vec2,&arr2);CHKERRQ(ierr);
88988320bc6fSPatrick Sanan   } else {
88998320bc6fSPatrick Sanan     SETERRQ(PetscObjectComm((PetscObject)da1,PETSC_ERR_ARG_INCOMP,"DMDA objects incompatible");
89008320bc6fSPatrick Sanan   }
89018320bc6fSPatrick Sanan   ...
89028320bc6fSPatrick Sanan .ve
89038320bc6fSPatrick Sanan 
89048320bc6fSPatrick Sanan     Checking compatibility might be expensive for a given implementation of DM,
89058320bc6fSPatrick Sanan     or might be impossible to unambiguously confirm or deny. For this reason,
89068320bc6fSPatrick Sanan     this function may decline to determine compatibility, and hence users should
89078320bc6fSPatrick Sanan     always check the "set" output parameter.
89088320bc6fSPatrick Sanan 
89098320bc6fSPatrick Sanan     A DM is always compatible with itself.
89108320bc6fSPatrick Sanan 
89118320bc6fSPatrick Sanan     In the current implementation, DMs which live on "unequal" communicators
89128320bc6fSPatrick Sanan     (MPI_UNEQUAL in the terminology of MPI_Comm_compare()) are always deemed
89138320bc6fSPatrick Sanan     incompatible.
89148320bc6fSPatrick Sanan 
89158320bc6fSPatrick Sanan     This function is labeled "Collective," as information about all subdomains
89168320bc6fSPatrick Sanan     is required on each rank. However, in DM implementations which store all this
89178320bc6fSPatrick Sanan     information locally, this function may be merely "Logically Collective".
89188320bc6fSPatrick Sanan 
89198320bc6fSPatrick Sanan     Developer Notes:
89203d862458SPatrick Sanan     Compatibility is assumed to be a symmetric concept; DM A is compatible with DM B
89213d862458SPatrick Sanan     iff B is compatible with A. Thus, this function checks the implementations
8922a5bc1bf3SBarry Smith     of both dm and dmc (if they are of different types), attempting to determine
89238320bc6fSPatrick Sanan     compatibility. It is left to DM implementers to ensure that symmetry is
89248320bc6fSPatrick Sanan     preserved. The simplest way to do this is, when implementing type-specific
89253d862458SPatrick Sanan     logic for this function, is to check for existing logic in the implementation
89263d862458SPatrick Sanan     of other DM types and let *set = PETSC_FALSE if found.
89278320bc6fSPatrick Sanan 
89288320bc6fSPatrick Sanan     Level: advanced
89298320bc6fSPatrick Sanan 
89303d862458SPatrick Sanan .seealso: DM, DMDACreateCompatibleDMDA(), DMStagCreateCompatibleDMStag()
89318320bc6fSPatrick Sanan @*/
89328320bc6fSPatrick Sanan 
8933a5bc1bf3SBarry Smith PetscErrorCode DMGetCompatibility(DM dm1,DM dm2,PetscBool *compatible,PetscBool *set)
89348320bc6fSPatrick Sanan {
89358320bc6fSPatrick Sanan   PetscErrorCode ierr;
89368320bc6fSPatrick Sanan   PetscMPIInt    compareResult;
89378320bc6fSPatrick Sanan   DMType         type,type2;
89388320bc6fSPatrick Sanan   PetscBool      sameType;
89398320bc6fSPatrick Sanan 
89408320bc6fSPatrick Sanan   PetscFunctionBegin;
8941a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(dm1,DM_CLASSID,1);
89428320bc6fSPatrick Sanan   PetscValidHeaderSpecific(dm2,DM_CLASSID,2);
89438320bc6fSPatrick Sanan 
89448320bc6fSPatrick Sanan   /* Declare a DM compatible with itself */
8945a5bc1bf3SBarry Smith   if (dm1 == dm2) {
89468320bc6fSPatrick Sanan     *set = PETSC_TRUE;
89478320bc6fSPatrick Sanan     *compatible = PETSC_TRUE;
89488320bc6fSPatrick Sanan     PetscFunctionReturn(0);
89498320bc6fSPatrick Sanan   }
89508320bc6fSPatrick Sanan 
89518320bc6fSPatrick Sanan   /* Declare a DM incompatible with a DM that lives on an "unequal"
89528320bc6fSPatrick Sanan      communicator. Note that this does not preclude compatibility with
89538320bc6fSPatrick Sanan      DMs living on "congruent" or "similar" communicators, but this must be
89548320bc6fSPatrick Sanan      determined by the implementation-specific logic */
8955a5bc1bf3SBarry Smith   ierr = MPI_Comm_compare(PetscObjectComm((PetscObject)dm1),PetscObjectComm((PetscObject)dm2),&compareResult);CHKERRQ(ierr);
89568320bc6fSPatrick Sanan   if (compareResult == MPI_UNEQUAL) {
89578320bc6fSPatrick Sanan     *set = PETSC_TRUE;
89588320bc6fSPatrick Sanan     *compatible = PETSC_FALSE;
89598320bc6fSPatrick Sanan     PetscFunctionReturn(0);
89608320bc6fSPatrick Sanan   }
89618320bc6fSPatrick Sanan 
89628320bc6fSPatrick Sanan   /* Pass to the implementation-specific routine, if one exists. */
8963a5bc1bf3SBarry Smith   if (dm1->ops->getcompatibility) {
8964a5bc1bf3SBarry Smith     ierr = (*dm1->ops->getcompatibility)(dm1,dm2,compatible,set);CHKERRQ(ierr);
8965b9d85ea2SLisandro Dalcin     if (*set) PetscFunctionReturn(0);
89668320bc6fSPatrick Sanan   }
89678320bc6fSPatrick Sanan 
8968a5bc1bf3SBarry Smith   /* If dm1 and dm2 are of different types, then attempt to check compatibility
89698320bc6fSPatrick Sanan      with an implementation of this function from dm2 */
8970a5bc1bf3SBarry Smith   ierr = DMGetType(dm1,&type);CHKERRQ(ierr);
89718320bc6fSPatrick Sanan   ierr = DMGetType(dm2,&type2);CHKERRQ(ierr);
89728320bc6fSPatrick Sanan   ierr = PetscStrcmp(type,type2,&sameType);CHKERRQ(ierr);
89738320bc6fSPatrick Sanan   if (!sameType && dm2->ops->getcompatibility) {
8974a5bc1bf3SBarry Smith     ierr = (*dm2->ops->getcompatibility)(dm2,dm1,compatible,set);CHKERRQ(ierr); /* Note argument order */
89758320bc6fSPatrick Sanan   } else {
89768320bc6fSPatrick Sanan     *set = PETSC_FALSE;
89778320bc6fSPatrick Sanan   }
89788320bc6fSPatrick Sanan   PetscFunctionReturn(0);
89798320bc6fSPatrick Sanan }
8980c0f0dcc3SMatthew G. Knepley 
8981c0f0dcc3SMatthew G. Knepley /*@C
8982c0f0dcc3SMatthew G. Knepley   DMMonitorSet - Sets an ADDITIONAL function that is to be used after a solve to monitor discretization performance.
8983c0f0dcc3SMatthew G. Knepley 
8984c0f0dcc3SMatthew G. Knepley   Logically Collective on DM
8985c0f0dcc3SMatthew G. Knepley 
8986c0f0dcc3SMatthew G. Knepley   Input Parameters:
8987c0f0dcc3SMatthew G. Knepley + DM - the DM
8988c0f0dcc3SMatthew G. Knepley . f - the monitor function
8989c0f0dcc3SMatthew G. Knepley . mctx - [optional] user-defined context for private data for the monitor routine (use NULL if no context is desired)
8990c0f0dcc3SMatthew G. Knepley - monitordestroy - [optional] routine that frees monitor context (may be NULL)
8991c0f0dcc3SMatthew G. Knepley 
8992c0f0dcc3SMatthew G. Knepley   Options Database Keys:
8993c0f0dcc3SMatthew G. Knepley - -dm_monitor_cancel - cancels all monitors that have been hardwired into a code by calls to DMMonitorSet(), but
8994c0f0dcc3SMatthew G. Knepley                             does not cancel those set via the options database.
8995c0f0dcc3SMatthew G. Knepley 
8996c0f0dcc3SMatthew G. Knepley   Notes:
8997c0f0dcc3SMatthew G. Knepley   Several different monitoring routines may be set by calling
8998c0f0dcc3SMatthew G. Knepley   DMMonitorSet() multiple times; all will be called in the
8999c0f0dcc3SMatthew G. Knepley   order in which they were set.
9000c0f0dcc3SMatthew G. Knepley 
9001c0f0dcc3SMatthew G. Knepley   Fortran Notes:
9002c0f0dcc3SMatthew G. Knepley   Only a single monitor function can be set for each DM object
9003c0f0dcc3SMatthew G. Knepley 
9004c0f0dcc3SMatthew G. Knepley   Level: intermediate
9005c0f0dcc3SMatthew G. Knepley 
9006c0f0dcc3SMatthew G. Knepley .seealso: DMMonitorCancel()
9007c0f0dcc3SMatthew G. Knepley @*/
9008c0f0dcc3SMatthew G. Knepley PetscErrorCode DMMonitorSet(DM dm, PetscErrorCode (*f)(DM, void *), void *mctx, PetscErrorCode (*monitordestroy)(void**))
9009c0f0dcc3SMatthew G. Knepley {
9010c0f0dcc3SMatthew G. Knepley   PetscInt       m;
9011c0f0dcc3SMatthew G. Knepley   PetscErrorCode ierr;
9012c0f0dcc3SMatthew G. Knepley 
9013c0f0dcc3SMatthew G. Knepley   PetscFunctionBegin;
9014c0f0dcc3SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
9015c0f0dcc3SMatthew G. Knepley   for (m = 0; m < dm->numbermonitors; ++m) {
9016c0f0dcc3SMatthew G. Knepley     PetscBool identical;
9017c0f0dcc3SMatthew G. Knepley 
9018c0f0dcc3SMatthew G. Knepley     ierr = PetscMonitorCompare((PetscErrorCode (*)(void)) f, mctx, monitordestroy, (PetscErrorCode (*)(void)) dm->monitor[m], dm->monitorcontext[m], dm->monitordestroy[m], &identical);CHKERRQ(ierr);
9019c0f0dcc3SMatthew G. Knepley     if (identical) PetscFunctionReturn(0);
9020c0f0dcc3SMatthew G. Knepley   }
9021c0f0dcc3SMatthew G. Knepley   if (dm->numbermonitors >= MAXDMMONITORS) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Too many monitors set");
9022c0f0dcc3SMatthew G. Knepley   dm->monitor[dm->numbermonitors]          = f;
9023c0f0dcc3SMatthew G. Knepley   dm->monitordestroy[dm->numbermonitors]   = monitordestroy;
9024c0f0dcc3SMatthew G. Knepley   dm->monitorcontext[dm->numbermonitors++] = (void *) mctx;
9025c0f0dcc3SMatthew G. Knepley   PetscFunctionReturn(0);
9026c0f0dcc3SMatthew G. Knepley }
9027c0f0dcc3SMatthew G. Knepley 
9028c0f0dcc3SMatthew G. Knepley /*@
9029c0f0dcc3SMatthew G. Knepley   DMMonitorCancel - Clears all the monitor functions for a DM object.
9030c0f0dcc3SMatthew G. Knepley 
9031c0f0dcc3SMatthew G. Knepley   Logically Collective on DM
9032c0f0dcc3SMatthew G. Knepley 
9033c0f0dcc3SMatthew G. Knepley   Input Parameter:
9034c0f0dcc3SMatthew G. Knepley . dm - the DM
9035c0f0dcc3SMatthew G. Knepley 
9036c0f0dcc3SMatthew G. Knepley   Options Database Key:
9037c0f0dcc3SMatthew G. Knepley . -dm_monitor_cancel - cancels all monitors that have been hardwired
9038c0f0dcc3SMatthew G. Knepley   into a code by calls to DMonitorSet(), but does not cancel those
9039c0f0dcc3SMatthew G. Knepley   set via the options database
9040c0f0dcc3SMatthew G. Knepley 
9041c0f0dcc3SMatthew G. Knepley   Notes:
9042c0f0dcc3SMatthew G. Knepley   There is no way to clear one specific monitor from a DM object.
9043c0f0dcc3SMatthew G. Knepley 
9044c0f0dcc3SMatthew G. Knepley   Level: intermediate
9045c0f0dcc3SMatthew G. Knepley 
9046c0f0dcc3SMatthew G. Knepley .seealso: DMMonitorSet()
9047c0f0dcc3SMatthew G. Knepley @*/
9048c0f0dcc3SMatthew G. Knepley PetscErrorCode DMMonitorCancel(DM dm)
9049c0f0dcc3SMatthew G. Knepley {
9050c0f0dcc3SMatthew G. Knepley   PetscErrorCode ierr;
9051c0f0dcc3SMatthew G. Knepley   PetscInt       m;
9052c0f0dcc3SMatthew G. Knepley 
9053c0f0dcc3SMatthew G. Knepley   PetscFunctionBegin;
9054c0f0dcc3SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
9055c0f0dcc3SMatthew G. Knepley   for (m = 0; m < dm->numbermonitors; ++m) {
9056c0f0dcc3SMatthew G. Knepley     if (dm->monitordestroy[m]) {ierr = (*dm->monitordestroy[m])(&dm->monitorcontext[m]);CHKERRQ(ierr);}
9057c0f0dcc3SMatthew G. Knepley   }
9058c0f0dcc3SMatthew G. Knepley   dm->numbermonitors = 0;
9059c0f0dcc3SMatthew G. Knepley   PetscFunctionReturn(0);
9060c0f0dcc3SMatthew G. Knepley }
9061c0f0dcc3SMatthew G. Knepley 
9062c0f0dcc3SMatthew G. Knepley /*@C
9063c0f0dcc3SMatthew G. Knepley   DMMonitorSetFromOptions - Sets a monitor function and viewer appropriate for the type indicated by the user
9064c0f0dcc3SMatthew G. Knepley 
9065c0f0dcc3SMatthew G. Knepley   Collective on DM
9066c0f0dcc3SMatthew G. Knepley 
9067c0f0dcc3SMatthew G. Knepley   Input Parameters:
9068c0f0dcc3SMatthew G. Knepley + dm   - DM object you wish to monitor
9069c0f0dcc3SMatthew G. Knepley . name - the monitor type one is seeking
9070c0f0dcc3SMatthew G. Knepley . help - message indicating what monitoring is done
9071c0f0dcc3SMatthew G. Knepley . manual - manual page for the monitor
9072c0f0dcc3SMatthew G. Knepley . monitor - the monitor function
9073c0f0dcc3SMatthew G. Knepley - monitorsetup - a function that is called once ONLY if the user selected this monitor that may set additional features of the DM or PetscViewer objects
9074c0f0dcc3SMatthew G. Knepley 
9075c0f0dcc3SMatthew G. Knepley   Output Parameter:
9076c0f0dcc3SMatthew G. Knepley . flg - Flag set if the monitor was created
9077c0f0dcc3SMatthew G. Knepley 
9078c0f0dcc3SMatthew G. Knepley   Level: developer
9079c0f0dcc3SMatthew G. Knepley 
9080c0f0dcc3SMatthew G. Knepley .seealso: PetscOptionsGetViewer(), PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(),
9081c0f0dcc3SMatthew G. Knepley           PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool()
9082c0f0dcc3SMatthew G. Knepley           PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(),
9083c0f0dcc3SMatthew G. Knepley           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
9084c0f0dcc3SMatthew G. Knepley           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
9085c0f0dcc3SMatthew G. Knepley           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
9086c0f0dcc3SMatthew G. Knepley           PetscOptionsFList(), PetscOptionsEList()
9087c0f0dcc3SMatthew G. Knepley @*/
9088c0f0dcc3SMatthew G. Knepley PetscErrorCode DMMonitorSetFromOptions(DM dm, const char name[], const char help[], const char manual[], PetscErrorCode (*monitor)(DM, void *), PetscErrorCode (*monitorsetup)(DM, PetscViewerAndFormat *), PetscBool *flg)
9089c0f0dcc3SMatthew G. Knepley {
9090c0f0dcc3SMatthew G. Knepley   PetscViewer       viewer;
9091c0f0dcc3SMatthew G. Knepley   PetscViewerFormat format;
9092c0f0dcc3SMatthew G. Knepley   PetscErrorCode    ierr;
9093c0f0dcc3SMatthew G. Knepley 
9094c0f0dcc3SMatthew G. Knepley   PetscFunctionBegin;
9095c0f0dcc3SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
9096c0f0dcc3SMatthew G. Knepley   ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject) dm), ((PetscObject) dm)->options, ((PetscObject) dm)->prefix, name, &viewer, &format, flg);CHKERRQ(ierr);
9097c0f0dcc3SMatthew G. Knepley   if (*flg) {
9098c0f0dcc3SMatthew G. Knepley     PetscViewerAndFormat *vf;
9099c0f0dcc3SMatthew G. Knepley 
9100c0f0dcc3SMatthew G. Knepley     ierr = PetscViewerAndFormatCreate(viewer, format, &vf);CHKERRQ(ierr);
9101c0f0dcc3SMatthew G. Knepley     ierr = PetscObjectDereference((PetscObject) viewer);CHKERRQ(ierr);
9102c0f0dcc3SMatthew G. Knepley     if (monitorsetup) {ierr = (*monitorsetup)(dm, vf);CHKERRQ(ierr);}
9103c0f0dcc3SMatthew G. Knepley     ierr = DMMonitorSet(dm,(PetscErrorCode (*)(DM, void *)) monitor, vf, (PetscErrorCode (*)(void **)) PetscViewerAndFormatDestroy);CHKERRQ(ierr);
9104c0f0dcc3SMatthew G. Knepley   }
9105c0f0dcc3SMatthew G. Knepley   PetscFunctionReturn(0);
9106c0f0dcc3SMatthew G. Knepley }
9107c0f0dcc3SMatthew G. Knepley 
9108c0f0dcc3SMatthew G. Knepley /*@
9109c0f0dcc3SMatthew G. Knepley    DMMonitor - runs the user provided monitor routines, if they exist
9110c0f0dcc3SMatthew G. Knepley 
9111c0f0dcc3SMatthew G. Knepley    Collective on DM
9112c0f0dcc3SMatthew G. Knepley 
9113c0f0dcc3SMatthew G. Knepley    Input Parameters:
9114c0f0dcc3SMatthew G. Knepley .  dm - The DM
9115c0f0dcc3SMatthew G. Knepley 
9116c0f0dcc3SMatthew G. Knepley    Level: developer
9117c0f0dcc3SMatthew G. Knepley 
9118c0f0dcc3SMatthew G. Knepley .seealso: DMMonitorSet()
9119c0f0dcc3SMatthew G. Knepley @*/
9120c0f0dcc3SMatthew G. Knepley PetscErrorCode DMMonitor(DM dm)
9121c0f0dcc3SMatthew G. Knepley {
9122c0f0dcc3SMatthew G. Knepley   PetscInt       m;
9123c0f0dcc3SMatthew G. Knepley   PetscErrorCode ierr;
9124c0f0dcc3SMatthew G. Knepley 
9125c0f0dcc3SMatthew G. Knepley   PetscFunctionBegin;
9126c0f0dcc3SMatthew G. Knepley   if (!dm) PetscFunctionReturn(0);
9127c0f0dcc3SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
9128c0f0dcc3SMatthew G. Knepley   for (m = 0; m < dm->numbermonitors; ++m) {
9129c0f0dcc3SMatthew G. Knepley     ierr = (*dm->monitor[m])(dm, dm->monitorcontext[m]);CHKERRQ(ierr);
9130c0f0dcc3SMatthew G. Knepley   }
9131c0f0dcc3SMatthew G. Knepley   PetscFunctionReturn(0);
9132c0f0dcc3SMatthew G. Knepley }
9133