xref: /petsc/src/dm/interface/dm.c (revision 609dae6e2730bae419e2deb5e31e4255cfb16660)
1d0295fc0SJunchao Zhang #include <petscvec.h>
2af0996ceSBarry Smith #include <petsc/private/dmimpl.h>           /*I      "petscdm.h"          I*/
3c58f1c22SToby Isaac #include <petsc/private/dmlabelimpl.h>      /*I      "petscdmlabel.h"     I*/
4e6f8dbb6SToby Isaac #include <petsc/private/petscdsimpl.h>      /*I      "petscds.h"     I*/
53e922f36SToby Isaac #include <petscdmplex.h>
6f19dbd58SToby Isaac #include <petscdmfield.h>
70c312b8eSJed Brown #include <petscsf.h>
82764a2aaSMatthew G. Knepley #include <petscds.h>
947c6ae99SBarry Smith 
10f918ec44SMatthew G. Knepley #ifdef PETSC_HAVE_LIBCEED
11f918ec44SMatthew G. Knepley #include <petscfeceed.h>
12f918ec44SMatthew G. Knepley #endif
13f918ec44SMatthew G. Knepley 
1400d952a4SJed Brown #if defined(PETSC_HAVE_VALGRIND)
1500d952a4SJed Brown #  include <valgrind/memcheck.h>
1600d952a4SJed Brown #endif
1700d952a4SJed Brown 
18732e2eb9SMatthew G Knepley PetscClassId  DM_CLASSID;
19d67d17b1SMatthew G. Knepley PetscClassId  DMLABEL_CLASSID;
20557cf195SMatthew 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;
2167a56275SMatthew G Knepley 
22ea78f98cSLisandro Dalcin const char *const DMBoundaryTypes[] = {"NONE","GHOSTED","MIRROR","PERIODIC","TWIST","DMBoundaryType","DM_BOUNDARY_", NULL};
23d1b3049bSMatthew G. Knepley const char *const DMBoundaryConditionTypes[] = {"INVALID","ESSENTIAL","NATURAL","INVALID","INVALID","ESSENTIAL_FIELD","NATURAL_FIELD","INVALID","INVALID","ESSENTIAL_BD_FIELD","NATURAL_RIEMANN","DMBoundaryConditionType","DM_BC_", NULL};
24da9060c4SMatthew G. Knepley const char *const DMPolytopeTypes[] = {"vertex", "segment", "tensor_segment", "triangle", "quadrilateral", "tensor_quad", "tetrahedron", "hexahedron", "triangular_prism", "tensor_triangular_prism", "tensor_quadrilateral_prism", "pyramid", "FV_ghost_cell", "interior_ghost_cell", "unknown", "invalid", "DMPolytopeType", "DM_POLYTOPE_", NULL};
2560c22052SBarry Smith 
26a4121054SBarry Smith /*@
27de043629SMatthew G Knepley   DMCreate - Creates an empty DM object. The type can then be set with DMSetType().
28a4121054SBarry Smith 
29a4121054SBarry Smith    If you never  call DMSetType()  it will generate an
30a4121054SBarry Smith    error when you try to use the vector.
31a4121054SBarry Smith 
32d083f849SBarry Smith   Collective
33a4121054SBarry Smith 
34a4121054SBarry Smith   Input Parameter:
35a4121054SBarry Smith . comm - The communicator for the DM object
36a4121054SBarry Smith 
37a4121054SBarry Smith   Output Parameter:
38a4121054SBarry Smith . dm - The DM object
39a4121054SBarry Smith 
40a4121054SBarry Smith   Level: beginner
41a4121054SBarry Smith 
428472ad0fSDave May .seealso: DMSetType(), DMDA, DMSLICED, DMCOMPOSITE, DMPLEX, DMMOAB, DMNETWORK
43a4121054SBarry Smith @*/
447087cfbeSBarry Smith PetscErrorCode  DMCreate(MPI_Comm comm,DM *dm)
45a4121054SBarry Smith {
46a4121054SBarry Smith   DM             v;
47e5e52638SMatthew G. Knepley   PetscDS        ds;
48a4121054SBarry Smith   PetscErrorCode ierr;
49a4121054SBarry Smith 
50a4121054SBarry Smith   PetscFunctionBegin;
511411c6eeSJed Brown   PetscValidPointer(dm,2);
520298fd71SBarry Smith   *dm = NULL;
53607a6623SBarry Smith   ierr = DMInitializePackage();CHKERRQ(ierr);
54a4121054SBarry Smith 
5573107ff1SLisandro Dalcin   ierr = PetscHeaderCreate(v, DM_CLASSID, "DM", "Distribution Manager", "DM", comm, DMDestroy, DMView);CHKERRQ(ierr);
56e7c4fc90SDmitry Karpeev 
5749be4549SMatthew G. Knepley   v->setupcalled              = PETSC_FALSE;
5849be4549SMatthew G. Knepley   v->setfromoptionscalled     = PETSC_FALSE;
590298fd71SBarry Smith   v->ltogmap                  = NULL;
601411c6eeSJed Brown   v->bs                       = 1;
61171400e9SBarry Smith   v->coloringtype             = IS_COLORING_GLOBAL;
6288ed4aceSMatthew G Knepley   ierr                        = PetscSFCreate(comm, &v->sf);CHKERRQ(ierr);
631bb6d2a8SBarry Smith   ierr                        = PetscSFCreate(comm, &v->sectionSF);CHKERRQ(ierr);
64c58f1c22SToby Isaac   v->labels                   = NULL;
6534aa8a36SMatthew G. Knepley   v->adjacency[0]             = PETSC_FALSE;
6634aa8a36SMatthew G. Knepley   v->adjacency[1]             = PETSC_TRUE;
67c58f1c22SToby Isaac   v->depthLabel               = NULL;
68ba2698f1SMatthew G. Knepley   v->celltypeLabel            = NULL;
691bb6d2a8SBarry Smith   v->localSection             = NULL;
701bb6d2a8SBarry Smith   v->globalSection            = NULL;
71fba222abSToby Isaac   v->defaultConstraintSection = NULL;
72fba222abSToby Isaac   v->defaultConstraintMat     = NULL;
73c6b900c6SMatthew G. Knepley   v->L                        = NULL;
74c6b900c6SMatthew G. Knepley   v->maxCell                  = NULL;
755dc8c3f7SMatthew G. Knepley   v->bdtype                   = NULL;
769a9a41abSToby Isaac   v->dimEmbed                 = PETSC_DEFAULT;
7796173672SStefano Zampini   v->dim                      = PETSC_DETERMINE;
78435a35e8SMatthew G Knepley   {
79435a35e8SMatthew G Knepley     PetscInt i;
80435a35e8SMatthew G Knepley     for (i = 0; i < 10; ++i) {
810298fd71SBarry Smith       v->nullspaceConstructors[i] = NULL;
82f9d4088aSMatthew G. Knepley       v->nearnullspaceConstructors[i] = NULL;
83435a35e8SMatthew G Knepley     }
84435a35e8SMatthew G Knepley   }
8545480ffeSMatthew G. Knepley   ierr = PetscDSCreate(PETSC_COMM_SELF, &ds);CHKERRQ(ierr);
86b3cf3223SMatthew G. Knepley   ierr = DMSetRegionDS(v, NULL, NULL, ds);CHKERRQ(ierr);
87e5e52638SMatthew G. Knepley   ierr = PetscDSDestroy(&ds);CHKERRQ(ierr);
889a2a23afSMatthew G. Knepley   ierr = PetscHMapAuxCreate(&v->auxData);CHKERRQ(ierr);
8914f150ffSMatthew G. Knepley   v->dmBC = NULL;
90a8fb8f29SToby Isaac   v->coarseMesh = NULL;
91f4d763aaSMatthew G. Knepley   v->outputSequenceNum = -1;
92cdb7a50dSMatthew G. Knepley   v->outputSequenceVal = 0.0;
93c0dedaeaSBarry Smith   ierr = DMSetVecType(v,VECSTANDARD);CHKERRQ(ierr);
94b412c318SBarry Smith   ierr = DMSetMatType(v,MATAIJ);CHKERRQ(ierr);
954a7a4c06SLawrence Mitchell 
961411c6eeSJed Brown   *dm = v;
97a4121054SBarry Smith   PetscFunctionReturn(0);
98a4121054SBarry Smith }
99a4121054SBarry Smith 
10038221697SMatthew G. Knepley /*@
10138221697SMatthew G. Knepley   DMClone - Creates a DM object with the same topology as the original.
10238221697SMatthew G. Knepley 
103d083f849SBarry Smith   Collective
10438221697SMatthew G. Knepley 
10538221697SMatthew G. Knepley   Input Parameter:
10638221697SMatthew G. Knepley . dm - The original DM object
10738221697SMatthew G. Knepley 
10838221697SMatthew G. Knepley   Output Parameter:
10938221697SMatthew G. Knepley . newdm  - The new DM object
11038221697SMatthew G. Knepley 
11138221697SMatthew G. Knepley   Level: beginner
11238221697SMatthew G. Knepley 
1131cb8cacdSPatrick Sanan   Notes:
1141cb8cacdSPatrick Sanan   For some DM implementations this is a shallow clone, the result of which may share (referent counted) information with its parent. For example,
1151cb8cacdSPatrick Sanan   DMClone() applied to a DMPLEX object will result in a new DMPLEX that shares the topology with the original DMPLEX. It does not
1161cb8cacdSPatrick Sanan   share the PetscSection of the original DM.
1171bb6d2a8SBarry Smith 
11889706ed2SPatrick Sanan   The clone is considered set up iff the original is.
11989706ed2SPatrick Sanan 
12092cfd99aSMartin Diehl .seealso: DMDestroy(), DMCreate(), DMSetType(), DMSetLocalSection(), DMSetGlobalSection()
1211bb6d2a8SBarry Smith 
12238221697SMatthew G. Knepley @*/
12338221697SMatthew G. Knepley PetscErrorCode DMClone(DM dm, DM *newdm)
12438221697SMatthew G. Knepley {
12538221697SMatthew G. Knepley   PetscSF        sf;
12638221697SMatthew G. Knepley   Vec            coords;
12738221697SMatthew G. Knepley   void          *ctx;
128a3219837SMatthew G. Knepley   PetscInt       dim, cdim;
12938221697SMatthew G. Knepley   PetscErrorCode ierr;
13038221697SMatthew G. Knepley 
13138221697SMatthew G. Knepley   PetscFunctionBegin;
13238221697SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
13338221697SMatthew G. Knepley   PetscValidPointer(newdm,2);
13438221697SMatthew G. Knepley   ierr = DMCreate(PetscObjectComm((PetscObject) dm), newdm);CHKERRQ(ierr);
1355d80c0bfSVaclav Hapla   ierr = DMCopyLabels(dm, *newdm, PETSC_COPY_VALUES, PETSC_TRUE);CHKERRQ(ierr);
136ddf8437dSMatthew G. Knepley   (*newdm)->leveldown  = dm->leveldown;
137ddf8437dSMatthew G. Knepley   (*newdm)->levelup    = dm->levelup;
138c8a6034eSMark   (*newdm)->prealloc_only = dm->prealloc_only;
139a587d139SMark   ierr = PetscFree((*newdm)->vectype);CHKERRQ(ierr);
140a587d139SMark   ierr = PetscStrallocpy(dm->vectype,(char**)&(*newdm)->vectype);CHKERRQ(ierr);
141a587d139SMark   ierr = PetscFree((*newdm)->mattype);CHKERRQ(ierr);
142a587d139SMark   ierr = PetscStrallocpy(dm->mattype,(char**)&(*newdm)->mattype);CHKERRQ(ierr);
1431de53e9aSMatthew G. Knepley   ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr);
1441de53e9aSMatthew G. Knepley   ierr = DMSetDimension(*newdm, dim);CHKERRQ(ierr);
14538221697SMatthew G. Knepley   if (dm->ops->clone) {
14638221697SMatthew G. Knepley     ierr = (*dm->ops->clone)(dm, newdm);CHKERRQ(ierr);
14738221697SMatthew G. Knepley   }
1483f22bcbcSToby Isaac   (*newdm)->setupcalled = dm->setupcalled;
14938221697SMatthew G. Knepley   ierr = DMGetPointSF(dm, &sf);CHKERRQ(ierr);
15038221697SMatthew G. Knepley   ierr = DMSetPointSF(*newdm, sf);CHKERRQ(ierr);
15138221697SMatthew G. Knepley   ierr = DMGetApplicationContext(dm, &ctx);CHKERRQ(ierr);
15238221697SMatthew G. Knepley   ierr = DMSetApplicationContext(*newdm, ctx);CHKERRQ(ierr);
153be4c1c3eSMatthew G. Knepley   if (dm->coordinateDM) {
154be4c1c3eSMatthew G. Knepley     DM           ncdm;
155be4c1c3eSMatthew G. Knepley     PetscSection cs;
1565a0206caSToby Isaac     PetscInt     pEnd = -1, pEndMax = -1;
157be4c1c3eSMatthew G. Knepley 
15892fd8e1eSJed Brown     ierr = DMGetLocalSection(dm->coordinateDM, &cs);CHKERRQ(ierr);
159be4c1c3eSMatthew G. Knepley     if (cs) {ierr = PetscSectionGetChart(cs, NULL, &pEnd);CHKERRQ(ierr);}
160ffc4695bSBarry Smith     ierr = MPI_Allreduce(&pEnd,&pEndMax,1,MPIU_INT,MPI_MAX,PetscObjectComm((PetscObject)dm));CHKERRMPI(ierr);
1615a0206caSToby Isaac     if (pEndMax >= 0) {
162be4c1c3eSMatthew G. Knepley       ierr = DMClone(dm->coordinateDM, &ncdm);CHKERRQ(ierr);
16383bfc06fSMatthew Knepley       ierr = DMCopyDisc(dm->coordinateDM, ncdm);CHKERRQ(ierr);
16492fd8e1eSJed Brown       ierr = DMSetLocalSection(ncdm, cs);CHKERRQ(ierr);
165a61e840bSMatthew G. Knepley       ierr = DMSetCoordinateDM(*newdm, ncdm);CHKERRQ(ierr);
166be4c1c3eSMatthew G. Knepley       ierr = DMDestroy(&ncdm);CHKERRQ(ierr);
167be4c1c3eSMatthew G. Knepley     }
168be4c1c3eSMatthew G. Knepley   }
169a3219837SMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
170a3219837SMatthew G. Knepley   ierr = DMSetCoordinateDim(*newdm, cdim);CHKERRQ(ierr);
17138221697SMatthew G. Knepley   ierr = DMGetCoordinatesLocal(dm, &coords);CHKERRQ(ierr);
17238221697SMatthew G. Knepley   if (coords) {
17338221697SMatthew G. Knepley     ierr = DMSetCoordinatesLocal(*newdm, coords);CHKERRQ(ierr);
17438221697SMatthew G. Knepley   } else {
17538221697SMatthew G. Knepley     ierr = DMGetCoordinates(dm, &coords);CHKERRQ(ierr);
17638221697SMatthew G. Knepley     if (coords) {ierr = DMSetCoordinates(*newdm, coords);CHKERRQ(ierr);}
17738221697SMatthew G. Knepley   }
17890b157c4SStefano Zampini   {
17990b157c4SStefano Zampini     PetscBool             isper;
180c6b900c6SMatthew G. Knepley     const PetscReal      *maxCell, *L;
1815dc8c3f7SMatthew G. Knepley     const DMBoundaryType *bd;
18290b157c4SStefano Zampini     ierr = DMGetPeriodicity(dm, &isper, &maxCell, &L, &bd);CHKERRQ(ierr);
18390b157c4SStefano Zampini     ierr = DMSetPeriodicity(*newdm, isper, maxCell,  L,  bd);CHKERRQ(ierr);
184c6b900c6SMatthew G. Knepley   }
18534aa8a36SMatthew G. Knepley   {
18634aa8a36SMatthew G. Knepley     PetscBool useCone, useClosure;
18734aa8a36SMatthew G. Knepley 
18834aa8a36SMatthew G. Knepley     ierr = DMGetAdjacency(dm, PETSC_DEFAULT, &useCone, &useClosure);CHKERRQ(ierr);
18934aa8a36SMatthew G. Knepley     ierr = DMSetAdjacency(*newdm, PETSC_DEFAULT, useCone, useClosure);CHKERRQ(ierr);
19034aa8a36SMatthew G. Knepley   }
19138221697SMatthew G. Knepley   PetscFunctionReturn(0);
19238221697SMatthew G. Knepley }
19338221697SMatthew G. Knepley 
1949a42bb27SBarry Smith /*@C
195564755cdSBarry Smith        DMSetVecType - Sets the type of vector created with DMCreateLocalVector() and DMCreateGlobalVector()
1969a42bb27SBarry Smith 
197d083f849SBarry Smith    Logically Collective on da
1989a42bb27SBarry Smith 
1999a42bb27SBarry Smith    Input Parameter:
2009a42bb27SBarry Smith +  da - initial distributed array
201e9e886b6SKarl Rupp .  ctype - the vector type, currently either VECSTANDARD, VECCUDA, or VECVIENNACL
2029a42bb27SBarry Smith 
2039a42bb27SBarry Smith    Options Database:
204dd85299cSBarry Smith .   -dm_vec_type ctype
2059a42bb27SBarry Smith 
2069a42bb27SBarry Smith    Level: intermediate
2079a42bb27SBarry Smith 
208a2a9ebe5SBarry Smith .seealso: DMCreate(), DMDestroy(), DM, DMDAInterpolationType, VecType, DMGetVecType(), DMSetMatType(), DMGetMatType()
2099a42bb27SBarry Smith @*/
21019fd82e9SBarry Smith PetscErrorCode  DMSetVecType(DM da,VecType ctype)
2119a42bb27SBarry Smith {
2129a42bb27SBarry Smith   PetscErrorCode ierr;
2139a42bb27SBarry Smith 
2149a42bb27SBarry Smith   PetscFunctionBegin;
2159a42bb27SBarry Smith   PetscValidHeaderSpecific(da,DM_CLASSID,1);
2169a42bb27SBarry Smith   ierr = PetscFree(da->vectype);CHKERRQ(ierr);
21719fd82e9SBarry Smith   ierr = PetscStrallocpy(ctype,(char**)&da->vectype);CHKERRQ(ierr);
2189a42bb27SBarry Smith   PetscFunctionReturn(0);
2199a42bb27SBarry Smith }
2209a42bb27SBarry Smith 
221c0dedaeaSBarry Smith /*@C
222c0dedaeaSBarry Smith        DMGetVecType - Gets the type of vector created with DMCreateLocalVector() and DMCreateGlobalVector()
223c0dedaeaSBarry Smith 
224d083f849SBarry Smith    Logically Collective on da
225c0dedaeaSBarry Smith 
226c0dedaeaSBarry Smith    Input Parameter:
227c0dedaeaSBarry Smith .  da - initial distributed array
228c0dedaeaSBarry Smith 
229c0dedaeaSBarry Smith    Output Parameter:
230c0dedaeaSBarry Smith .  ctype - the vector type
231c0dedaeaSBarry Smith 
232c0dedaeaSBarry Smith    Level: intermediate
233c0dedaeaSBarry Smith 
234a2a9ebe5SBarry Smith .seealso: DMCreate(), DMDestroy(), DM, DMDAInterpolationType, VecType, DMSetMatType(), DMGetMatType(), DMSetVecType()
235c0dedaeaSBarry Smith @*/
236c0dedaeaSBarry Smith PetscErrorCode  DMGetVecType(DM da,VecType *ctype)
237c0dedaeaSBarry Smith {
238c0dedaeaSBarry Smith   PetscFunctionBegin;
239c0dedaeaSBarry Smith   PetscValidHeaderSpecific(da,DM_CLASSID,1);
240c0dedaeaSBarry Smith   *ctype = da->vectype;
241c0dedaeaSBarry Smith   PetscFunctionReturn(0);
242c0dedaeaSBarry Smith }
243c0dedaeaSBarry Smith 
2445f1ad066SMatthew G Knepley /*@
24534f98d34SBarry Smith   VecGetDM - Gets the DM defining the data layout of the vector
2465f1ad066SMatthew G Knepley 
2475f1ad066SMatthew G Knepley   Not collective
2485f1ad066SMatthew G Knepley 
2495f1ad066SMatthew G Knepley   Input Parameter:
2505f1ad066SMatthew G Knepley . v - The Vec
2515f1ad066SMatthew G Knepley 
2525f1ad066SMatthew G Knepley   Output Parameter:
2535f1ad066SMatthew G Knepley . dm - The DM
2545f1ad066SMatthew G Knepley 
2555f1ad066SMatthew G Knepley   Level: intermediate
2565f1ad066SMatthew G Knepley 
2575f1ad066SMatthew G Knepley .seealso: VecSetDM(), DMGetLocalVector(), DMGetGlobalVector(), DMSetVecType()
2585f1ad066SMatthew G Knepley @*/
2595f1ad066SMatthew G Knepley PetscErrorCode VecGetDM(Vec v, DM *dm)
2605f1ad066SMatthew G Knepley {
2615f1ad066SMatthew G Knepley   PetscErrorCode ierr;
2625f1ad066SMatthew G Knepley 
2635f1ad066SMatthew G Knepley   PetscFunctionBegin;
2645f1ad066SMatthew G Knepley   PetscValidHeaderSpecific(v,VEC_CLASSID,1);
2655f1ad066SMatthew G Knepley   PetscValidPointer(dm,2);
2665f1ad066SMatthew G Knepley   ierr = PetscObjectQuery((PetscObject) v, "__PETSc_dm", (PetscObject*) dm);CHKERRQ(ierr);
2675f1ad066SMatthew G Knepley   PetscFunctionReturn(0);
2685f1ad066SMatthew G Knepley }
2695f1ad066SMatthew G Knepley 
2705f1ad066SMatthew G Knepley /*@
271d9805387SMatthew G. Knepley   VecSetDM - Sets the DM defining the data layout of the vector.
2725f1ad066SMatthew G Knepley 
2735f1ad066SMatthew G Knepley   Not collective
2745f1ad066SMatthew G Knepley 
2755f1ad066SMatthew G Knepley   Input Parameters:
2765f1ad066SMatthew G Knepley + v - The Vec
2775f1ad066SMatthew G Knepley - dm - The DM
2785f1ad066SMatthew G Knepley 
279d9805387SMatthew 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.
280d9805387SMatthew G. Knepley 
2815f1ad066SMatthew G Knepley   Level: intermediate
2825f1ad066SMatthew G Knepley 
2835f1ad066SMatthew G Knepley .seealso: VecGetDM(), DMGetLocalVector(), DMGetGlobalVector(), DMSetVecType()
2845f1ad066SMatthew G Knepley @*/
2855f1ad066SMatthew G Knepley PetscErrorCode VecSetDM(Vec v, DM dm)
2865f1ad066SMatthew G Knepley {
2875f1ad066SMatthew G Knepley   PetscErrorCode ierr;
2885f1ad066SMatthew G Knepley 
2895f1ad066SMatthew G Knepley   PetscFunctionBegin;
2905f1ad066SMatthew G Knepley   PetscValidHeaderSpecific(v,VEC_CLASSID,1);
291d7f50e27SLisandro Dalcin   if (dm) PetscValidHeaderSpecific(dm,DM_CLASSID,2);
2925f1ad066SMatthew G Knepley   ierr = PetscObjectCompose((PetscObject) v, "__PETSc_dm", (PetscObject) dm);CHKERRQ(ierr);
2935f1ad066SMatthew G Knepley   PetscFunctionReturn(0);
2945f1ad066SMatthew G Knepley }
2955f1ad066SMatthew G Knepley 
296521d9a4cSLisandro Dalcin /*@C
2978f1509bcSBarry Smith        DMSetISColoringType - Sets the type of coloring, global or local, that is created by the DM
2988f1509bcSBarry Smith 
299d083f849SBarry Smith    Logically Collective on dm
3008f1509bcSBarry Smith 
3018f1509bcSBarry Smith    Input Parameters:
3028f1509bcSBarry Smith +  dm - the DM context
3038f1509bcSBarry Smith -  ctype - the matrix type
3048f1509bcSBarry Smith 
3058f1509bcSBarry Smith    Options Database:
3068f1509bcSBarry Smith .   -dm_is_coloring_type - global or local
3078f1509bcSBarry Smith 
3088f1509bcSBarry Smith    Level: intermediate
3098f1509bcSBarry Smith 
3108f1509bcSBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMGetMatType(),
3118f1509bcSBarry Smith           DMGetISColoringType()
3128f1509bcSBarry Smith @*/
3138f1509bcSBarry Smith PetscErrorCode  DMSetISColoringType(DM dm,ISColoringType ctype)
3148f1509bcSBarry Smith {
3158f1509bcSBarry Smith   PetscFunctionBegin;
3168f1509bcSBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3178f1509bcSBarry Smith   dm->coloringtype = ctype;
3188f1509bcSBarry Smith   PetscFunctionReturn(0);
3198f1509bcSBarry Smith }
3208f1509bcSBarry Smith 
3218f1509bcSBarry Smith /*@C
3228f1509bcSBarry Smith        DMGetISColoringType - Gets the type of coloring, global or local, that is created by the DM
323521d9a4cSLisandro Dalcin 
324d083f849SBarry Smith    Logically Collective on dm
325521d9a4cSLisandro Dalcin 
326521d9a4cSLisandro Dalcin    Input Parameter:
3278f1509bcSBarry Smith .  dm - the DM context
3288f1509bcSBarry Smith 
3298f1509bcSBarry Smith    Output Parameter:
3308f1509bcSBarry Smith .  ctype - the matrix type
3318f1509bcSBarry Smith 
3328f1509bcSBarry Smith    Options Database:
3338f1509bcSBarry Smith .   -dm_is_coloring_type - global or local
3348f1509bcSBarry Smith 
3358f1509bcSBarry Smith    Level: intermediate
3368f1509bcSBarry Smith 
3378f1509bcSBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMGetMatType(),
3388f1509bcSBarry Smith           DMGetISColoringType()
3398f1509bcSBarry Smith @*/
3408f1509bcSBarry Smith PetscErrorCode  DMGetISColoringType(DM dm,ISColoringType *ctype)
3418f1509bcSBarry Smith {
3428f1509bcSBarry Smith   PetscFunctionBegin;
3438f1509bcSBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3448f1509bcSBarry Smith   *ctype = dm->coloringtype;
3458f1509bcSBarry Smith   PetscFunctionReturn(0);
3468f1509bcSBarry Smith }
3478f1509bcSBarry Smith 
3488f1509bcSBarry Smith /*@C
3498f1509bcSBarry Smith        DMSetMatType - Sets the type of matrix created with DMCreateMatrix()
3508f1509bcSBarry Smith 
351d083f849SBarry Smith    Logically Collective on dm
3528f1509bcSBarry Smith 
3538f1509bcSBarry Smith    Input Parameters:
354521d9a4cSLisandro Dalcin +  dm - the DM context
355a2b5a043SBarry Smith -  ctype - the matrix type
356521d9a4cSLisandro Dalcin 
357521d9a4cSLisandro Dalcin    Options Database:
358521d9a4cSLisandro Dalcin .   -dm_mat_type ctype
359521d9a4cSLisandro Dalcin 
360521d9a4cSLisandro Dalcin    Level: intermediate
361521d9a4cSLisandro Dalcin 
362a2a9ebe5SBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMGetMatType(), DMSetMatType(), DMGetMatType()
363521d9a4cSLisandro Dalcin @*/
36419fd82e9SBarry Smith PetscErrorCode  DMSetMatType(DM dm,MatType ctype)
365521d9a4cSLisandro Dalcin {
366521d9a4cSLisandro Dalcin   PetscErrorCode ierr;
36788f0584fSBarry Smith 
368521d9a4cSLisandro Dalcin   PetscFunctionBegin;
369521d9a4cSLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
370521d9a4cSLisandro Dalcin   ierr = PetscFree(dm->mattype);CHKERRQ(ierr);
37119fd82e9SBarry Smith   ierr = PetscStrallocpy(ctype,(char**)&dm->mattype);CHKERRQ(ierr);
372521d9a4cSLisandro Dalcin   PetscFunctionReturn(0);
373521d9a4cSLisandro Dalcin }
374521d9a4cSLisandro Dalcin 
375c0dedaeaSBarry Smith /*@C
376c0dedaeaSBarry Smith        DMGetMatType - Gets the type of matrix created with DMCreateMatrix()
377c0dedaeaSBarry Smith 
378d083f849SBarry Smith    Logically Collective on dm
379c0dedaeaSBarry Smith 
380c0dedaeaSBarry Smith    Input Parameter:
381c0dedaeaSBarry Smith .  dm - the DM context
382c0dedaeaSBarry Smith 
383c0dedaeaSBarry Smith    Output Parameter:
384c0dedaeaSBarry Smith .  ctype - the matrix type
385c0dedaeaSBarry Smith 
386c0dedaeaSBarry Smith    Options Database:
387c0dedaeaSBarry Smith .   -dm_mat_type ctype
388c0dedaeaSBarry Smith 
389c0dedaeaSBarry Smith    Level: intermediate
390c0dedaeaSBarry Smith 
391a2a9ebe5SBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMSetMatType(), DMSetMatType(), DMGetMatType()
392c0dedaeaSBarry Smith @*/
393c0dedaeaSBarry Smith PetscErrorCode  DMGetMatType(DM dm,MatType *ctype)
394c0dedaeaSBarry Smith {
395c0dedaeaSBarry Smith   PetscFunctionBegin;
396c0dedaeaSBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
397c0dedaeaSBarry Smith   *ctype = dm->mattype;
398c0dedaeaSBarry Smith   PetscFunctionReturn(0);
399c0dedaeaSBarry Smith }
400c0dedaeaSBarry Smith 
401c688c046SMatthew G Knepley /*@
40234f98d34SBarry Smith   MatGetDM - Gets the DM defining the data layout of the matrix
403c688c046SMatthew G Knepley 
404c688c046SMatthew G Knepley   Not collective
405c688c046SMatthew G Knepley 
406c688c046SMatthew G Knepley   Input Parameter:
407c688c046SMatthew G Knepley . A - The Mat
408c688c046SMatthew G Knepley 
409c688c046SMatthew G Knepley   Output Parameter:
410c688c046SMatthew G Knepley . dm - The DM
411c688c046SMatthew G Knepley 
412c688c046SMatthew G Knepley   Level: intermediate
413c688c046SMatthew G Knepley 
4148f1509bcSBarry Smith   Developer Note: Since the Mat class doesn't know about the DM class the DM object is associated with
4158f1509bcSBarry Smith                   the Mat through a PetscObjectCompose() operation
4168f1509bcSBarry Smith 
417c688c046SMatthew G Knepley .seealso: MatSetDM(), DMCreateMatrix(), DMSetMatType()
418c688c046SMatthew G Knepley @*/
419c688c046SMatthew G Knepley PetscErrorCode MatGetDM(Mat A, DM *dm)
420c688c046SMatthew G Knepley {
421c688c046SMatthew G Knepley   PetscErrorCode ierr;
422c688c046SMatthew G Knepley 
423c688c046SMatthew G Knepley   PetscFunctionBegin;
424c688c046SMatthew G Knepley   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
425c688c046SMatthew G Knepley   PetscValidPointer(dm,2);
426c688c046SMatthew G Knepley   ierr = PetscObjectQuery((PetscObject) A, "__PETSc_dm", (PetscObject*) dm);CHKERRQ(ierr);
427c688c046SMatthew G Knepley   PetscFunctionReturn(0);
428c688c046SMatthew G Knepley }
429c688c046SMatthew G Knepley 
430c688c046SMatthew G Knepley /*@
431c688c046SMatthew G Knepley   MatSetDM - Sets the DM defining the data layout of the matrix
432c688c046SMatthew G Knepley 
433c688c046SMatthew G Knepley   Not collective
434c688c046SMatthew G Knepley 
435c688c046SMatthew G Knepley   Input Parameters:
436c688c046SMatthew G Knepley + A - The Mat
437c688c046SMatthew G Knepley - dm - The DM
438c688c046SMatthew G Knepley 
439c688c046SMatthew G Knepley   Level: intermediate
440c688c046SMatthew G Knepley 
4418f1509bcSBarry Smith   Developer Note: Since the Mat class doesn't know about the DM class the DM object is associated with
4428f1509bcSBarry Smith                   the Mat through a PetscObjectCompose() operation
4438f1509bcSBarry Smith 
444c688c046SMatthew G Knepley .seealso: MatGetDM(), DMCreateMatrix(), DMSetMatType()
445c688c046SMatthew G Knepley @*/
446c688c046SMatthew G Knepley PetscErrorCode MatSetDM(Mat A, DM dm)
447c688c046SMatthew G Knepley {
448c688c046SMatthew G Knepley   PetscErrorCode ierr;
449c688c046SMatthew G Knepley 
450c688c046SMatthew G Knepley   PetscFunctionBegin;
451c688c046SMatthew G Knepley   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
4528865f1eaSKarl Rupp   if (dm) PetscValidHeaderSpecific(dm,DM_CLASSID,2);
453c688c046SMatthew G Knepley   ierr = PetscObjectCompose((PetscObject) A, "__PETSc_dm", (PetscObject) dm);CHKERRQ(ierr);
454c688c046SMatthew G Knepley   PetscFunctionReturn(0);
455c688c046SMatthew G Knepley }
456c688c046SMatthew G Knepley 
4579a42bb27SBarry Smith /*@C
4589a42bb27SBarry Smith    DMSetOptionsPrefix - Sets the prefix used for searching for all
4596757b960SDave May    DM options in the database.
4609a42bb27SBarry Smith 
461d083f849SBarry Smith    Logically Collective on dm
4629a42bb27SBarry Smith 
463d8d19677SJose E. Roman    Input Parameters:
4648353ddbbSDave May +  da - the DM context
4659a42bb27SBarry Smith -  prefix - the prefix to prepend to all option names
4669a42bb27SBarry Smith 
4679a42bb27SBarry Smith    Notes:
4689a42bb27SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
4699a42bb27SBarry Smith    The first character of all runtime options is AUTOMATICALLY the hyphen.
4709a42bb27SBarry Smith 
4719a42bb27SBarry Smith    Level: advanced
4729a42bb27SBarry Smith 
4739a42bb27SBarry Smith .seealso: DMSetFromOptions()
4749a42bb27SBarry Smith @*/
4757087cfbeSBarry Smith PetscErrorCode  DMSetOptionsPrefix(DM dm,const char prefix[])
4769a42bb27SBarry Smith {
4779a42bb27SBarry Smith   PetscErrorCode ierr;
4789a42bb27SBarry Smith 
4799a42bb27SBarry Smith   PetscFunctionBegin;
4809a42bb27SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
4819a42bb27SBarry Smith   ierr = PetscObjectSetOptionsPrefix((PetscObject)dm,prefix);CHKERRQ(ierr);
482691be533SLawrence Mitchell   if (dm->sf) {
483691be533SLawrence Mitchell     ierr = PetscObjectSetOptionsPrefix((PetscObject)dm->sf,prefix);CHKERRQ(ierr);
484691be533SLawrence Mitchell   }
4851bb6d2a8SBarry Smith   if (dm->sectionSF) {
4861bb6d2a8SBarry Smith     ierr = PetscObjectSetOptionsPrefix((PetscObject)dm->sectionSF,prefix);CHKERRQ(ierr);
487691be533SLawrence Mitchell   }
4889a42bb27SBarry Smith   PetscFunctionReturn(0);
4899a42bb27SBarry Smith }
4909a42bb27SBarry Smith 
49131697293SDave May /*@C
49231697293SDave May    DMAppendOptionsPrefix - Appends to the prefix used for searching for all
49331697293SDave May    DM options in the database.
49431697293SDave May 
495d083f849SBarry Smith    Logically Collective on dm
49631697293SDave May 
49731697293SDave May    Input Parameters:
49831697293SDave May +  dm - the DM context
49931697293SDave May -  prefix - the prefix string to prepend to all DM option requests
50031697293SDave May 
50131697293SDave May    Notes:
50231697293SDave May    A hyphen (-) must NOT be given at the beginning of the prefix name.
50331697293SDave May    The first character of all runtime options is AUTOMATICALLY the hyphen.
50431697293SDave May 
50531697293SDave May    Level: advanced
50631697293SDave May 
50731697293SDave May .seealso: DMSetOptionsPrefix(), DMGetOptionsPrefix()
50831697293SDave May @*/
50931697293SDave May PetscErrorCode  DMAppendOptionsPrefix(DM dm,const char prefix[])
51031697293SDave May {
51131697293SDave May   PetscErrorCode ierr;
51231697293SDave May 
51331697293SDave May   PetscFunctionBegin;
51431697293SDave May   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
51531697293SDave May   ierr = PetscObjectAppendOptionsPrefix((PetscObject)dm,prefix);CHKERRQ(ierr);
51631697293SDave May   PetscFunctionReturn(0);
51731697293SDave May }
51831697293SDave May 
51931697293SDave May /*@C
52031697293SDave May    DMGetOptionsPrefix - Gets the prefix used for searching for all
52131697293SDave May    DM options in the database.
52231697293SDave May 
52331697293SDave May    Not Collective
52431697293SDave May 
52531697293SDave May    Input Parameters:
52631697293SDave May .  dm - the DM context
52731697293SDave May 
52831697293SDave May    Output Parameters:
52931697293SDave May .  prefix - pointer to the prefix string used is returned
53031697293SDave May 
53195452b02SPatrick Sanan    Notes:
53295452b02SPatrick Sanan     On the fortran side, the user should pass in a string 'prefix' of
53331697293SDave May    sufficient length to hold the prefix.
53431697293SDave May 
53531697293SDave May    Level: advanced
53631697293SDave May 
53731697293SDave May .seealso: DMSetOptionsPrefix(), DMAppendOptionsPrefix()
53831697293SDave May @*/
53931697293SDave May PetscErrorCode  DMGetOptionsPrefix(DM dm,const char *prefix[])
54031697293SDave May {
54131697293SDave May   PetscErrorCode ierr;
54231697293SDave May 
54331697293SDave May   PetscFunctionBegin;
54431697293SDave May   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
54531697293SDave May   ierr = PetscObjectGetOptionsPrefix((PetscObject)dm,prefix);CHKERRQ(ierr);
54631697293SDave May   PetscFunctionReturn(0);
54731697293SDave May }
54831697293SDave May 
54988bdff64SToby Isaac static PetscErrorCode DMCountNonCyclicReferences(DM dm, PetscBool recurseCoarse, PetscBool recurseFine, PetscInt *ncrefct)
55088bdff64SToby Isaac {
5516eb26441SStefano Zampini   PetscInt       refct = ((PetscObject) dm)->refct;
55288bdff64SToby Isaac   PetscErrorCode ierr;
55388bdff64SToby Isaac 
55488bdff64SToby Isaac   PetscFunctionBegin;
555aab5bcd8SJed Brown   *ncrefct = 0;
55688bdff64SToby Isaac   if (dm->coarseMesh && dm->coarseMesh->fineMesh == dm) {
55788bdff64SToby Isaac     refct--;
55888bdff64SToby Isaac     if (recurseCoarse) {
55988bdff64SToby Isaac       PetscInt coarseCount;
56088bdff64SToby Isaac 
56188bdff64SToby Isaac       ierr = DMCountNonCyclicReferences(dm->coarseMesh, PETSC_TRUE, PETSC_FALSE,&coarseCount);CHKERRQ(ierr);
56288bdff64SToby Isaac       refct += coarseCount;
56388bdff64SToby Isaac     }
56488bdff64SToby Isaac   }
56588bdff64SToby Isaac   if (dm->fineMesh && dm->fineMesh->coarseMesh == dm) {
56688bdff64SToby Isaac     refct--;
56788bdff64SToby Isaac     if (recurseFine) {
56888bdff64SToby Isaac       PetscInt fineCount;
56988bdff64SToby Isaac 
57088bdff64SToby Isaac       ierr = DMCountNonCyclicReferences(dm->fineMesh, PETSC_FALSE, PETSC_TRUE,&fineCount);CHKERRQ(ierr);
57188bdff64SToby Isaac       refct += fineCount;
57288bdff64SToby Isaac     }
57388bdff64SToby Isaac   }
57488bdff64SToby Isaac   *ncrefct = refct;
57588bdff64SToby Isaac   PetscFunctionReturn(0);
57688bdff64SToby Isaac }
57788bdff64SToby Isaac 
578f4cdcedcSVaclav Hapla PetscErrorCode DMDestroyLabelLinkList_Internal(DM dm)
579354557abSToby Isaac {
5805d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
581354557abSToby Isaac   PetscErrorCode ierr;
582354557abSToby Isaac 
583354557abSToby Isaac   PetscFunctionBegin;
584354557abSToby Isaac   /* destroy the labels */
585354557abSToby Isaac   while (next) {
586354557abSToby Isaac     DMLabelLink tmp = next->next;
587354557abSToby Isaac 
5885d80c0bfSVaclav Hapla     if (next->label == dm->depthLabel)    dm->depthLabel    = NULL;
589ba2698f1SMatthew G. Knepley     if (next->label == dm->celltypeLabel) dm->celltypeLabel = NULL;
590354557abSToby Isaac     ierr = DMLabelDestroy(&next->label);CHKERRQ(ierr);
591354557abSToby Isaac     ierr = PetscFree(next);CHKERRQ(ierr);
592354557abSToby Isaac     next = tmp;
593354557abSToby Isaac   }
5945d80c0bfSVaclav Hapla   dm->labels = NULL;
595354557abSToby Isaac   PetscFunctionReturn(0);
596354557abSToby Isaac }
597354557abSToby Isaac 
5981fb7b255SJunchao Zhang /*@C
5998472ad0fSDave May     DMDestroy - Destroys a vector packer or DM.
60047c6ae99SBarry Smith 
601d083f849SBarry Smith     Collective on dm
60247c6ae99SBarry Smith 
60347c6ae99SBarry Smith     Input Parameter:
60447c6ae99SBarry Smith .   dm - the DM object to destroy
60547c6ae99SBarry Smith 
60647c6ae99SBarry Smith     Level: developer
60747c6ae99SBarry Smith 
608e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
60947c6ae99SBarry Smith 
61047c6ae99SBarry Smith @*/
611fcfd50ebSBarry Smith PetscErrorCode  DMDestroy(DM *dm)
61247c6ae99SBarry Smith {
6136eb26441SStefano Zampini   PetscInt       cnt;
614dfe15315SJed Brown   DMNamedVecLink nlink,nnext;
61547c6ae99SBarry Smith   PetscErrorCode ierr;
61647c6ae99SBarry Smith 
61747c6ae99SBarry Smith   PetscFunctionBegin;
6186bf464f9SBarry Smith   if (!*dm) PetscFunctionReturn(0);
6196bf464f9SBarry Smith   PetscValidHeaderSpecific((*dm),DM_CLASSID,1);
62087e657c6SBarry Smith 
62188bdff64SToby Isaac   /* count all non-cyclic references in the doubly-linked list of coarse<->fine meshes */
62288bdff64SToby Isaac   ierr = DMCountNonCyclicReferences(*dm,PETSC_TRUE,PETSC_TRUE,&cnt);CHKERRQ(ierr);
62388bdff64SToby Isaac   --((PetscObject)(*dm))->refct;
624ea78f98cSLisandro Dalcin   if (--cnt > 0) {*dm = NULL; PetscFunctionReturn(0);}
6256bf464f9SBarry Smith   if (((PetscObject)(*dm))->refct < 0) PetscFunctionReturn(0);
6266bf464f9SBarry Smith   ((PetscObject)(*dm))->refct = 0;
6276eb26441SStefano Zampini 
6286eb26441SStefano Zampini   ierr = DMClearGlobalVectors(*dm);CHKERRQ(ierr);
6296eb26441SStefano Zampini   ierr = DMClearLocalVectors(*dm);CHKERRQ(ierr);
6306eb26441SStefano Zampini 
631f490541aSPeter Brune   nnext=(*dm)->namedglobal;
6320298fd71SBarry Smith   (*dm)->namedglobal = NULL;
633f490541aSPeter Brune   for (nlink=nnext; nlink; nlink=nnext) { /* Destroy the named vectors */
6342348bcf4SPeter Brune     nnext = nlink->next;
6352348bcf4SPeter 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);
6362348bcf4SPeter Brune     ierr = PetscFree(nlink->name);CHKERRQ(ierr);
6372348bcf4SPeter Brune     ierr = VecDestroy(&nlink->X);CHKERRQ(ierr);
6382348bcf4SPeter Brune     ierr = PetscFree(nlink);CHKERRQ(ierr);
6392348bcf4SPeter Brune   }
640f490541aSPeter Brune   nnext=(*dm)->namedlocal;
6410298fd71SBarry Smith   (*dm)->namedlocal = NULL;
642f490541aSPeter Brune   for (nlink=nnext; nlink; nlink=nnext) { /* Destroy the named local vectors */
643f490541aSPeter Brune     nnext = nlink->next;
644f490541aSPeter 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);
645f490541aSPeter Brune     ierr = PetscFree(nlink->name);CHKERRQ(ierr);
646f490541aSPeter Brune     ierr = VecDestroy(&nlink->X);CHKERRQ(ierr);
647f490541aSPeter Brune     ierr = PetscFree(nlink);CHKERRQ(ierr);
648f490541aSPeter Brune   }
6492348bcf4SPeter Brune 
650b17ce1afSJed Brown   /* Destroy the list of hooks */
651c833c3b5SJed Brown   {
652c833c3b5SJed Brown     DMCoarsenHookLink link,next;
653b17ce1afSJed Brown     for (link=(*dm)->coarsenhook; link; link=next) {
654b17ce1afSJed Brown       next = link->next;
655b17ce1afSJed Brown       ierr = PetscFree(link);CHKERRQ(ierr);
656b17ce1afSJed Brown     }
6570298fd71SBarry Smith     (*dm)->coarsenhook = NULL;
658c833c3b5SJed Brown   }
659c833c3b5SJed Brown   {
660c833c3b5SJed Brown     DMRefineHookLink link,next;
661c833c3b5SJed Brown     for (link=(*dm)->refinehook; link; link=next) {
662c833c3b5SJed Brown       next = link->next;
663c833c3b5SJed Brown       ierr = PetscFree(link);CHKERRQ(ierr);
664c833c3b5SJed Brown     }
6650298fd71SBarry Smith     (*dm)->refinehook = NULL;
666c833c3b5SJed Brown   }
667be081cd6SPeter Brune   {
668be081cd6SPeter Brune     DMSubDomainHookLink link,next;
669be081cd6SPeter Brune     for (link=(*dm)->subdomainhook; link; link=next) {
670be081cd6SPeter Brune       next = link->next;
671be081cd6SPeter Brune       ierr = PetscFree(link);CHKERRQ(ierr);
672be081cd6SPeter Brune     }
6730298fd71SBarry Smith     (*dm)->subdomainhook = NULL;
674be081cd6SPeter Brune   }
675baf369e7SPeter Brune   {
676baf369e7SPeter Brune     DMGlobalToLocalHookLink link,next;
677baf369e7SPeter Brune     for (link=(*dm)->gtolhook; link; link=next) {
678baf369e7SPeter Brune       next = link->next;
679baf369e7SPeter Brune       ierr = PetscFree(link);CHKERRQ(ierr);
680baf369e7SPeter Brune     }
6810298fd71SBarry Smith     (*dm)->gtolhook = NULL;
682baf369e7SPeter Brune   }
683d4d07f1eSToby Isaac   {
684d4d07f1eSToby Isaac     DMLocalToGlobalHookLink link,next;
685d4d07f1eSToby Isaac     for (link=(*dm)->ltoghook; link; link=next) {
686d4d07f1eSToby Isaac       next = link->next;
687d4d07f1eSToby Isaac       ierr = PetscFree(link);CHKERRQ(ierr);
688d4d07f1eSToby Isaac     }
689d4d07f1eSToby Isaac     (*dm)->ltoghook = NULL;
690d4d07f1eSToby Isaac   }
691aa1993deSMatthew G Knepley   /* Destroy the work arrays */
692aa1993deSMatthew G Knepley   {
693aa1993deSMatthew G Knepley     DMWorkLink link,next;
694aa1993deSMatthew G Knepley     if ((*dm)->workout) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Work array still checked out");
695aa1993deSMatthew G Knepley     for (link=(*dm)->workin; link; link=next) {
696aa1993deSMatthew G Knepley       next = link->next;
697aa1993deSMatthew G Knepley       ierr = PetscFree(link->mem);CHKERRQ(ierr);
698aa1993deSMatthew G Knepley       ierr = PetscFree(link);CHKERRQ(ierr);
699aa1993deSMatthew G Knepley     }
7000298fd71SBarry Smith     (*dm)->workin = NULL;
701aa1993deSMatthew G Knepley   }
702c58f1c22SToby Isaac   /* destroy the labels */
703f4cdcedcSVaclav Hapla   ierr = DMDestroyLabelLinkList_Internal(*dm);CHKERRQ(ierr);
704f4cdcedcSVaclav Hapla   /* destroy the fields */
705e5e52638SMatthew G. Knepley   ierr = DMClearFields(*dm);CHKERRQ(ierr);
706f4cdcedcSVaclav Hapla   /* destroy the boundaries */
707e6f8dbb6SToby Isaac   {
708e6f8dbb6SToby Isaac     DMBoundary next = (*dm)->boundary;
709e6f8dbb6SToby Isaac     while (next) {
710e6f8dbb6SToby Isaac       DMBoundary b = next;
711e6f8dbb6SToby Isaac 
712e6f8dbb6SToby Isaac       next = b->next;
713e6f8dbb6SToby Isaac       ierr = PetscFree(b);CHKERRQ(ierr);
714e6f8dbb6SToby Isaac     }
715e6f8dbb6SToby Isaac   }
716b17ce1afSJed Brown 
71752536dc3SBarry Smith   ierr = PetscObjectDestroy(&(*dm)->dmksp);CHKERRQ(ierr);
71852536dc3SBarry Smith   ierr = PetscObjectDestroy(&(*dm)->dmsnes);CHKERRQ(ierr);
71952536dc3SBarry Smith   ierr = PetscObjectDestroy(&(*dm)->dmts);CHKERRQ(ierr);
72052536dc3SBarry Smith 
7211a266240SBarry Smith   if ((*dm)->ctx && (*dm)->ctxdestroy) {
7221a266240SBarry Smith     ierr = (*(*dm)->ctxdestroy)(&(*dm)->ctx);CHKERRQ(ierr);
7231a266240SBarry Smith   }
72471cd77b2SBarry Smith   ierr = MatFDColoringDestroy(&(*dm)->fd);CHKERRQ(ierr);
7256bf464f9SBarry Smith   ierr = ISLocalToGlobalMappingDestroy(&(*dm)->ltogmap);CHKERRQ(ierr);
7266bf464f9SBarry Smith   ierr = PetscFree((*dm)->vectype);CHKERRQ(ierr);
727073dac72SJed Brown   ierr = PetscFree((*dm)->mattype);CHKERRQ(ierr);
72888ed4aceSMatthew G Knepley 
7291bb6d2a8SBarry Smith   ierr = PetscSectionDestroy(&(*dm)->localSection);CHKERRQ(ierr);
7301bb6d2a8SBarry Smith   ierr = PetscSectionDestroy(&(*dm)->globalSection);CHKERRQ(ierr);
7318b1ab98fSJed Brown   ierr = PetscLayoutDestroy(&(*dm)->map);CHKERRQ(ierr);
732fba222abSToby Isaac   ierr = PetscSectionDestroy(&(*dm)->defaultConstraintSection);CHKERRQ(ierr);
733fba222abSToby Isaac   ierr = MatDestroy(&(*dm)->defaultConstraintMat);CHKERRQ(ierr);
73488ed4aceSMatthew G Knepley   ierr = PetscSFDestroy(&(*dm)->sf);CHKERRQ(ierr);
7351bb6d2a8SBarry Smith   ierr = PetscSFDestroy(&(*dm)->sectionSF);CHKERRQ(ierr);
736736995cdSBlaise Bourdin   if ((*dm)->useNatural) {
737736995cdSBlaise Bourdin     if ((*dm)->sfNatural) {
7388e4ac7eaSMatthew G. Knepley       ierr = PetscSFDestroy(&(*dm)->sfNatural);CHKERRQ(ierr);
739736995cdSBlaise Bourdin     }
740736995cdSBlaise Bourdin     ierr = PetscObjectDereference((PetscObject) (*dm)->sfMigration);CHKERRQ(ierr);
741736995cdSBlaise Bourdin   }
7429a2a23afSMatthew G. Knepley   {
7439a2a23afSMatthew G. Knepley     Vec     *auxData;
7449a2a23afSMatthew G. Knepley     PetscInt n, i, off = 0;
7459a2a23afSMatthew G. Knepley 
7469a2a23afSMatthew G. Knepley     ierr = PetscHMapAuxGetSize((*dm)->auxData, &n);CHKERRQ(ierr);
7479a2a23afSMatthew G. Knepley     ierr = PetscMalloc1(n, &auxData);CHKERRQ(ierr);
7489a2a23afSMatthew G. Knepley     ierr = PetscHMapAuxGetVals((*dm)->auxData, &off, auxData);CHKERRQ(ierr);
7499a2a23afSMatthew G. Knepley     for (i = 0; i < n; ++i) {ierr = VecDestroy(&auxData[i]);CHKERRQ(ierr);}
7509a2a23afSMatthew G. Knepley     ierr = PetscFree(auxData);CHKERRQ(ierr);
7519a2a23afSMatthew G. Knepley     ierr = PetscHMapAuxDestroy(&(*dm)->auxData);CHKERRQ(ierr);
7529a2a23afSMatthew G. Knepley   }
75388bdff64SToby Isaac   if ((*dm)->coarseMesh && (*dm)->coarseMesh->fineMesh == *dm) {
75488bdff64SToby Isaac     ierr = DMSetFineDM((*dm)->coarseMesh,NULL);CHKERRQ(ierr);
75588bdff64SToby Isaac   }
7566eb26441SStefano Zampini 
757a8fb8f29SToby Isaac   ierr = DMDestroy(&(*dm)->coarseMesh);CHKERRQ(ierr);
75888bdff64SToby Isaac   if ((*dm)->fineMesh && (*dm)->fineMesh->coarseMesh == *dm) {
75988bdff64SToby Isaac     ierr = DMSetCoarseDM((*dm)->fineMesh,NULL);CHKERRQ(ierr);
76088bdff64SToby Isaac   }
76188bdff64SToby Isaac   ierr = DMDestroy(&(*dm)->fineMesh);CHKERRQ(ierr);
762f19dbd58SToby Isaac   ierr = DMFieldDestroy(&(*dm)->coordinateField);CHKERRQ(ierr);
7636636e97aSMatthew G Knepley   ierr = DMDestroy(&(*dm)->coordinateDM);CHKERRQ(ierr);
7646636e97aSMatthew G Knepley   ierr = VecDestroy(&(*dm)->coordinates);CHKERRQ(ierr);
7656636e97aSMatthew G Knepley   ierr = VecDestroy(&(*dm)->coordinatesLocal);CHKERRQ(ierr);
766412e9a14SMatthew G. Knepley   ierr = PetscFree((*dm)->L);CHKERRQ(ierr);
767412e9a14SMatthew G. Knepley   ierr = PetscFree((*dm)->maxCell);CHKERRQ(ierr);
768412e9a14SMatthew G. Knepley   ierr = PetscFree((*dm)->bdtype);CHKERRQ(ierr);
769ca3d3a14SMatthew G. Knepley   if ((*dm)->transformDestroy) {ierr = (*(*dm)->transformDestroy)(*dm, (*dm)->transformCtx);CHKERRQ(ierr);}
770ca3d3a14SMatthew G. Knepley   ierr = DMDestroy(&(*dm)->transformDM);CHKERRQ(ierr);
771ca3d3a14SMatthew G. Knepley   ierr = VecDestroy(&(*dm)->transform);CHKERRQ(ierr);
7726636e97aSMatthew G Knepley 
773e5e52638SMatthew G. Knepley   ierr = DMClearDS(*dm);CHKERRQ(ierr);
77414f150ffSMatthew G. Knepley   ierr = DMDestroy(&(*dm)->dmBC);CHKERRQ(ierr);
775e04113cfSBarry Smith   /* if memory was published with SAWs then destroy it */
776e04113cfSBarry Smith   ierr = PetscObjectSAWsViewOff((PetscObject)*dm);CHKERRQ(ierr);
777732e2eb9SMatthew G Knepley 
778ed3c66a1SDave May   if ((*dm)->ops->destroy) {
7796bf464f9SBarry Smith     ierr = (*(*dm)->ops->destroy)(*dm);CHKERRQ(ierr);
780ed3c66a1SDave May   }
781c0f0dcc3SMatthew G. Knepley   ierr = DMMonitorCancel(*dm);CHKERRQ(ierr);
782f918ec44SMatthew G. Knepley #ifdef PETSC_HAVE_LIBCEED
783f918ec44SMatthew G. Knepley   ierr = CeedElemRestrictionDestroy(&(*dm)->ceedERestrict);CHKERRQ(ierr);
784f918ec44SMatthew G. Knepley   ierr = CeedDestroy(&(*dm)->ceed);CHKERRQ(ierr);
785f918ec44SMatthew G. Knepley #endif
786435a35e8SMatthew G Knepley   /* We do not destroy (*dm)->data here so that we can reference count backend objects */
787732e2eb9SMatthew G Knepley   ierr = PetscHeaderDestroy(dm);CHKERRQ(ierr);
78847c6ae99SBarry Smith   PetscFunctionReturn(0);
78947c6ae99SBarry Smith }
79047c6ae99SBarry Smith 
791d7bf68aeSBarry Smith /*@
792d7bf68aeSBarry Smith     DMSetUp - sets up the data structures inside a DM object
793d7bf68aeSBarry Smith 
794d083f849SBarry Smith     Collective on dm
795d7bf68aeSBarry Smith 
796d7bf68aeSBarry Smith     Input Parameter:
797d7bf68aeSBarry Smith .   dm - the DM object to setup
798d7bf68aeSBarry Smith 
799d7bf68aeSBarry Smith     Level: developer
800d7bf68aeSBarry Smith 
801e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
802d7bf68aeSBarry Smith 
803d7bf68aeSBarry Smith @*/
8047087cfbeSBarry Smith PetscErrorCode  DMSetUp(DM dm)
805d7bf68aeSBarry Smith {
806d7bf68aeSBarry Smith   PetscErrorCode ierr;
807d7bf68aeSBarry Smith 
808d7bf68aeSBarry Smith   PetscFunctionBegin;
809171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
8108387afaaSJed Brown   if (dm->setupcalled) PetscFunctionReturn(0);
811d7bf68aeSBarry Smith   if (dm->ops->setup) {
812d7bf68aeSBarry Smith     ierr = (*dm->ops->setup)(dm);CHKERRQ(ierr);
813d7bf68aeSBarry Smith   }
8148387afaaSJed Brown   dm->setupcalled = PETSC_TRUE;
815d7bf68aeSBarry Smith   PetscFunctionReturn(0);
816d7bf68aeSBarry Smith }
817d7bf68aeSBarry Smith 
818d7bf68aeSBarry Smith /*@
819d7bf68aeSBarry Smith     DMSetFromOptions - sets parameters in a DM from the options database
820d7bf68aeSBarry Smith 
821d083f849SBarry Smith     Collective on dm
822d7bf68aeSBarry Smith 
823d7bf68aeSBarry Smith     Input Parameter:
824d7bf68aeSBarry Smith .   dm - the DM object to set options for
825d7bf68aeSBarry Smith 
826732e2eb9SMatthew G Knepley     Options Database:
8274164ae61SDominic Meiser +   -dm_preallocate_only - Only preallocate the matrix for DMCreateMatrix(), but do not fill it with zeros
8284164ae61SDominic Meiser .   -dm_vec_type <type>  - type of vector to create inside DM
8294164ae61SDominic Meiser .   -dm_mat_type <type>  - type of matrix to create inside DM
8308f1509bcSBarry Smith -   -dm_is_coloring_type - <global or local>
831732e2eb9SMatthew G Knepley 
8329318fe57SMatthew G. Knepley     DMPLEX Specific creation options
8339318fe57SMatthew G. Knepley + -dm_plex_filename <str>           - File containing a mesh
8349318fe57SMatthew G. Knepley . -dm_plex_boundary_filename <str>  - File containing a mesh boundary
8359318fe57SMatthew G. Knepley . -dm_plex_shape <shape>            - The domain shape, such as DM_SHAPE_BOX, DM_SHAPE_SPHERE, etc.
8369318fe57SMatthew G. Knepley . -dm_plex_cell <ct>                - Cell shape
8379318fe57SMatthew G. Knepley . -dm_plex_reference_cell_domain <bool> - Use a reference cell domain
8389318fe57SMatthew G. Knepley . -dm_plex_dim <dim>                - Set the topological dimension
8399318fe57SMatthew G. Knepley . -dm_plex_simplex <bool>           - PETSC_TRUE for simplex elements, PETSC_FALSE for tensor elements
8409318fe57SMatthew G. Knepley . -dm_plex_interpolate <bool>       - PETSC_TRUE turns on topological interpolation (creating edges and faces)
8419318fe57SMatthew G. Knepley . -dm_plex_scale <sc>               - Scale factor for mesh coordinates
8429318fe57SMatthew G. Knepley . -dm_plex_box_faces <m,n,p>        - Number of faces along each dimension
8439318fe57SMatthew G. Knepley . -dm_plex_box_lower <x,y,z>        - Specify lower-left-bottom coordinates for the box
8449318fe57SMatthew G. Knepley . -dm_plex_box_upper <x,y,z>        - Specify upper-right-top coordinates for the box
8459318fe57SMatthew G. Knepley . -dm_plex_box_bd <bx,by,bz>        - Specify the DMBoundaryType for each direction
8469318fe57SMatthew G. Knepley . -dm_plex_sphere_radius <r>        - The sphere radius
8479318fe57SMatthew G. Knepley . -dm_plex_ball_radius <r>          - Radius of the ball
8489318fe57SMatthew G. Knepley . -dm_plex_cylinder_bd <bz>         - Boundary type in the z direction
8499318fe57SMatthew G. Knepley . -dm_plex_cylinder_num_wedges <n>  - Number of wedges around the cylinder
8509318fe57SMatthew G. Knepley . -dm_refine_pre <n>                - The number of refinements before distribution
8519318fe57SMatthew G. Knepley . -dm_refine_uniform_pre <bool>     - Flag for uniform refinement before distribution
8529318fe57SMatthew G. Knepley . -dm_refine_volume_limit_pre <v>   - The maximum cell volume after refinement before distribution
8539318fe57SMatthew G. Knepley . -dm_refine <n>                    - The number of refinements after distribution
8549318fe57SMatthew G. Knepley . -dm_extrude_layers <l>            - The number of layers to extrude
8559318fe57SMatthew G. Knepley . -dm_extrude_thickness <t>         - The thickness of the layer to be extruded
8569318fe57SMatthew G. Knepley . -dm_extrude_column_first <bool>   - Order the cells in a vertical column first
857909dfd52SMatthew G. Knepley . -dm_plex_create_fv_ghost_cells    - Flag to create finite volume ghost cells on the boundary
858909dfd52SMatthew G. Knepley . -dm_plex_fv_ghost_cells_label <name> - Label name for ghost cells boundary
8599318fe57SMatthew G. Knepley . -dm_distribute <bool>             - Flag to redistribute a mesh among processes
8609318fe57SMatthew G. Knepley . -dm_distribute_overlap <n>        - The size of the overlap halo
8619318fe57SMatthew G. Knepley . -dm_plex_adj_cone <bool>          - Set adjacency direction
8629318fe57SMatthew G. Knepley - -dm_plex_adj_closure <bool>       - Set adjacency size
8639318fe57SMatthew G. Knepley 
864384a6580SVaclav Hapla     DMPLEX Specific Checks
865384a6580SVaclav Hapla +   -dm_plex_check_symmetry        - Check that the adjacency information in the mesh is symmetric - DMPlexCheckSymmetry()
866384a6580SVaclav Hapla .   -dm_plex_check_skeleton        - Check that each cell has the correct number of vertices (only for homogeneous simplex or tensor meshes) - DMPlexCheckSkeleton()
867384a6580SVaclav 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()
868384a6580SVaclav Hapla .   -dm_plex_check_geometry        - Check that cells have positive volume - DMPlexCheckGeometry()
869384a6580SVaclav Hapla .   -dm_plex_check_pointsf         - Check some necessary conditions for PointSF - DMPlexCheckPointSF()
870384a6580SVaclav Hapla .   -dm_plex_check_interface_cones - Check points on inter-partition interfaces have conforming order of cone points - DMPlexCheckInterfaceCones()
871384a6580SVaclav Hapla -   -dm_plex_check_all             - Perform all the checks above
872d7bf68aeSBarry Smith 
87395eb5ee5SVaclav Hapla     Level: intermediate
87495eb5ee5SVaclav Hapla 
87595eb5ee5SVaclav Hapla .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(),
87695eb5ee5SVaclav Hapla     DMPlexCheckSymmetry(), DMPlexCheckSkeleton(), DMPlexCheckFaces(), DMPlexCheckGeometry(), DMPlexCheckPointSF(), DMPlexCheckInterfaceCones()
877d7bf68aeSBarry Smith 
878d7bf68aeSBarry Smith @*/
8797087cfbeSBarry Smith PetscErrorCode DMSetFromOptions(DM dm)
880d7bf68aeSBarry Smith {
8817781c08eSBarry Smith   char           typeName[256];
882ca266f36SBarry Smith   PetscBool      flg;
883d7bf68aeSBarry Smith   PetscErrorCode ierr;
884d7bf68aeSBarry Smith 
885d7bf68aeSBarry Smith   PetscFunctionBegin;
886171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
88749be4549SMatthew G. Knepley   dm->setfromoptionscalled = PETSC_TRUE;
88849be4549SMatthew G. Knepley   if (dm->sf) {ierr = PetscSFSetFromOptions(dm->sf);CHKERRQ(ierr);}
8891bb6d2a8SBarry Smith   if (dm->sectionSF) {ierr = PetscSFSetFromOptions(dm->sectionSF);CHKERRQ(ierr);}
8903194b578SJed Brown   ierr = PetscObjectOptionsBegin((PetscObject)dm);CHKERRQ(ierr);
8910298fd71SBarry 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);
892a264d7a6SBarry Smith   ierr = PetscOptionsFList("-dm_vec_type","Vector type used for created vectors","DMSetVecType",VecList,dm->vectype,typeName,256,&flg);CHKERRQ(ierr);
893f9ba7244SBarry Smith   if (flg) {
894f9ba7244SBarry Smith     ierr = DMSetVecType(dm,typeName);CHKERRQ(ierr);
895f9ba7244SBarry Smith   }
896a264d7a6SBarry 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);
897073dac72SJed Brown   if (flg) {
898521d9a4cSLisandro Dalcin     ierr = DMSetMatType(dm,typeName);CHKERRQ(ierr);
899073dac72SJed Brown   }
9008f1509bcSBarry Smith   ierr = PetscOptionsEnum("-dm_is_coloring_type","Global or local coloring of Jacobian","DMSetISColoringType",ISColoringTypes,(PetscEnum)dm->coloringtype,(PetscEnum*)&dm->coloringtype,NULL);CHKERRQ(ierr);
901f9ba7244SBarry Smith   if (dm->ops->setfromoptions) {
902e55864a3SBarry Smith     ierr = (*dm->ops->setfromoptions)(PetscOptionsObject,dm);CHKERRQ(ierr);
903f9ba7244SBarry Smith   }
904f9ba7244SBarry Smith   /* process any options handlers added with PetscObjectAddOptionsHandler() */
9050633abcbSJed Brown   ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject) dm);CHKERRQ(ierr);
90682fcb398SMatthew G Knepley   ierr = PetscOptionsEnd();CHKERRQ(ierr);
907d7bf68aeSBarry Smith   PetscFunctionReturn(0);
908d7bf68aeSBarry Smith }
909d7bf68aeSBarry Smith 
910fc9bc008SSatish Balay /*@C
911fe2efc57SMark    DMViewFromOptions - View from Options
912fe2efc57SMark 
913fe2efc57SMark    Collective on DM
914fe2efc57SMark 
915fe2efc57SMark    Input Parameters:
916fe2efc57SMark +  dm - the DM object
917736c3998SJose E. Roman .  obj - Optional object
918736c3998SJose E. Roman -  name - command line option
919fe2efc57SMark 
920fe2efc57SMark    Level: intermediate
921fe2efc57SMark .seealso:  DM, DMView, PetscObjectViewFromOptions(), DMCreate()
922fe2efc57SMark @*/
923fe2efc57SMark PetscErrorCode  DMViewFromOptions(DM dm,PetscObject obj,const char name[])
924fe2efc57SMark {
925fe2efc57SMark   PetscErrorCode ierr;
926fe2efc57SMark 
927fe2efc57SMark   PetscFunctionBegin;
928fe2efc57SMark   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
929fe2efc57SMark   ierr = PetscObjectViewFromOptions((PetscObject)dm,obj,name);CHKERRQ(ierr);
930fe2efc57SMark   PetscFunctionReturn(0);
931fe2efc57SMark }
932fe2efc57SMark 
933fe2efc57SMark /*@C
934224748a4SBarry Smith     DMView - Views a DM
93547c6ae99SBarry Smith 
936d083f849SBarry Smith     Collective on dm
93747c6ae99SBarry Smith 
938d8d19677SJose E. Roman     Input Parameters:
93947c6ae99SBarry Smith +   dm - the DM object to view
94047c6ae99SBarry Smith -   v - the viewer
94147c6ae99SBarry Smith 
942224748a4SBarry Smith     Level: beginner
94347c6ae99SBarry Smith 
944e727c939SJed Brown .seealso DMDestroy(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
94547c6ae99SBarry Smith 
94647c6ae99SBarry Smith @*/
9477087cfbeSBarry Smith PetscErrorCode  DMView(DM dm,PetscViewer v)
94847c6ae99SBarry Smith {
94947c6ae99SBarry Smith   PetscErrorCode    ierr;
95032c0f0efSBarry Smith   PetscBool         isbinary;
95176a8abe0SBarry Smith   PetscMPIInt       size;
95276a8abe0SBarry Smith   PetscViewerFormat format;
95347c6ae99SBarry Smith 
95447c6ae99SBarry Smith   PetscFunctionBegin;
955171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
9563014e516SBarry Smith   if (!v) {
957ce94432eSBarry Smith     ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)dm),&v);CHKERRQ(ierr);
9583014e516SBarry Smith   }
959b1b135c8SBarry Smith   PetscValidHeaderSpecific(v,PETSC_VIEWER_CLASSID,2);
96074903a4fSStefano Zampini   /* Ideally, we would like to have this test on.
96174903a4fSStefano Zampini      However, it currently breaks socket viz via GLVis.
96274903a4fSStefano Zampini      During DMView(parallel_mesh,glvis_viewer), each
96374903a4fSStefano Zampini      process opens a sequential ASCII socket to visualize
96474903a4fSStefano Zampini      the local mesh, and PetscObjectView(dm,local_socket)
96574903a4fSStefano Zampini      is internally called inside VecView_GLVis, incurring
96674903a4fSStefano Zampini      in an error here */
96774903a4fSStefano Zampini   /* PetscCheckSameComm(dm,1,v,2); */
9688bfd1ab9SVaclav Hapla   ierr = PetscViewerCheckWritable(v);CHKERRQ(ierr);
969b1b135c8SBarry Smith 
97076a8abe0SBarry Smith   ierr = PetscViewerGetFormat(v,&format);CHKERRQ(ierr);
971ffc4695bSBarry Smith   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)dm),&size);CHKERRMPI(ierr);
97276a8abe0SBarry Smith   if (size == 1 && format == PETSC_VIEWER_LOAD_BALANCE) PetscFunctionReturn(0);
97398c3331eSBarry Smith   ierr = PetscObjectPrintClassNamePrefixType((PetscObject)dm,v);CHKERRQ(ierr);
97432c0f0efSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)v,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
97532c0f0efSBarry Smith   if (isbinary) {
97655849f57SBarry Smith     PetscInt classid = DM_FILE_CLASSID;
97732c0f0efSBarry Smith     char     type[256];
97832c0f0efSBarry Smith 
979f253e43cSLisandro Dalcin     ierr = PetscViewerBinaryWrite(v,&classid,1,PETSC_INT);CHKERRQ(ierr);
98032c0f0efSBarry Smith     ierr = PetscStrncpy(type,((PetscObject)dm)->type_name,256);CHKERRQ(ierr);
981f253e43cSLisandro Dalcin     ierr = PetscViewerBinaryWrite(v,type,256,PETSC_CHAR);CHKERRQ(ierr);
98232c0f0efSBarry Smith   }
9830c010503SBarry Smith   if (dm->ops->view) {
9840c010503SBarry Smith     ierr = (*dm->ops->view)(dm,v);CHKERRQ(ierr);
98547c6ae99SBarry Smith   }
98647c6ae99SBarry Smith   PetscFunctionReturn(0);
98747c6ae99SBarry Smith }
98847c6ae99SBarry Smith 
98947c6ae99SBarry Smith /*@
9908472ad0fSDave May     DMCreateGlobalVector - Creates a global vector from a DM object
99147c6ae99SBarry Smith 
992d083f849SBarry Smith     Collective on dm
99347c6ae99SBarry Smith 
99447c6ae99SBarry Smith     Input Parameter:
99547c6ae99SBarry Smith .   dm - the DM object
99647c6ae99SBarry Smith 
99747c6ae99SBarry Smith     Output Parameter:
99847c6ae99SBarry Smith .   vec - the global vector
99947c6ae99SBarry Smith 
1000073dac72SJed Brown     Level: beginner
100147c6ae99SBarry Smith 
1002ec075b9fSPatrick Sanan .seealso DMCreateLocalVector(), DMGetGlobalVector(), DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
100347c6ae99SBarry Smith 
100447c6ae99SBarry Smith @*/
10057087cfbeSBarry Smith PetscErrorCode  DMCreateGlobalVector(DM dm,Vec *vec)
100647c6ae99SBarry Smith {
100747c6ae99SBarry Smith   PetscErrorCode ierr;
100847c6ae99SBarry Smith 
100947c6ae99SBarry Smith   PetscFunctionBegin;
1010171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1011b9d85ea2SLisandro Dalcin   PetscValidPointer(vec,2);
1012b9d85ea2SLisandro Dalcin   if (!dm->ops->createglobalvector) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateGlobalVector",((PetscObject)dm)->type_name);
101347c6ae99SBarry Smith   ierr = (*dm->ops->createglobalvector)(dm,vec);CHKERRQ(ierr);
101476bd3646SJed Brown   if (PetscDefined(USE_DEBUG)) {
1015c6b011d8SStefano Zampini     DM vdm;
1016c6b011d8SStefano Zampini 
1017c6b011d8SStefano Zampini     ierr = VecGetDM(*vec,&vdm);CHKERRQ(ierr);
1018c6b011d8SStefano 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);
1019c6b011d8SStefano Zampini   }
102047c6ae99SBarry Smith   PetscFunctionReturn(0);
102147c6ae99SBarry Smith }
102247c6ae99SBarry Smith 
102347c6ae99SBarry Smith /*@
10248472ad0fSDave May     DMCreateLocalVector - Creates a local vector from a DM object
102547c6ae99SBarry Smith 
102647c6ae99SBarry Smith     Not Collective
102747c6ae99SBarry Smith 
102847c6ae99SBarry Smith     Input Parameter:
102947c6ae99SBarry Smith .   dm - the DM object
103047c6ae99SBarry Smith 
103147c6ae99SBarry Smith     Output Parameter:
103247c6ae99SBarry Smith .   vec - the local vector
103347c6ae99SBarry Smith 
1034073dac72SJed Brown     Level: beginner
103547c6ae99SBarry Smith 
1036ec075b9fSPatrick Sanan .seealso DMCreateGlobalVector(), DMGetLocalVector(), DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
103747c6ae99SBarry Smith 
103847c6ae99SBarry Smith @*/
10397087cfbeSBarry Smith PetscErrorCode  DMCreateLocalVector(DM dm,Vec *vec)
104047c6ae99SBarry Smith {
104147c6ae99SBarry Smith   PetscErrorCode ierr;
104247c6ae99SBarry Smith 
104347c6ae99SBarry Smith   PetscFunctionBegin;
1044171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1045b9d85ea2SLisandro Dalcin   PetscValidPointer(vec,2);
1046b9d85ea2SLisandro Dalcin   if (!dm->ops->createlocalvector) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateLocalVector",((PetscObject)dm)->type_name);
104747c6ae99SBarry Smith   ierr = (*dm->ops->createlocalvector)(dm,vec);CHKERRQ(ierr);
104876bd3646SJed Brown   if (PetscDefined(USE_DEBUG)) {
1049c6b011d8SStefano Zampini     DM vdm;
1050c6b011d8SStefano Zampini 
1051c6b011d8SStefano Zampini     ierr = VecGetDM(*vec,&vdm);CHKERRQ(ierr);
1052c6b011d8SStefano 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);
1053c6b011d8SStefano Zampini   }
105447c6ae99SBarry Smith   PetscFunctionReturn(0);
105547c6ae99SBarry Smith }
105647c6ae99SBarry Smith 
10571411c6eeSJed Brown /*@
10581411c6eeSJed Brown    DMGetLocalToGlobalMapping - Accesses the local-to-global mapping in a DM.
10591411c6eeSJed Brown 
1060d083f849SBarry Smith    Collective on dm
10611411c6eeSJed Brown 
10621411c6eeSJed Brown    Input Parameter:
10631411c6eeSJed Brown .  dm - the DM that provides the mapping
10641411c6eeSJed Brown 
10651411c6eeSJed Brown    Output Parameter:
10661411c6eeSJed Brown .  ltog - the mapping
10671411c6eeSJed Brown 
10681411c6eeSJed Brown    Level: intermediate
10691411c6eeSJed Brown 
10701411c6eeSJed Brown    Notes:
10711411c6eeSJed Brown    This mapping can then be used by VecSetLocalToGlobalMapping() or
10721411c6eeSJed Brown    MatSetLocalToGlobalMapping().
10731411c6eeSJed Brown 
1074fc31e74dSBarry Smith .seealso: DMCreateLocalVector()
10751411c6eeSJed Brown @*/
10767087cfbeSBarry Smith PetscErrorCode DMGetLocalToGlobalMapping(DM dm,ISLocalToGlobalMapping *ltog)
10771411c6eeSJed Brown {
10780be3e97aSMatthew G. Knepley   PetscInt       bs = -1, bsLocal[2], bsMinMax[2];
10791411c6eeSJed Brown   PetscErrorCode ierr;
10801411c6eeSJed Brown 
10811411c6eeSJed Brown   PetscFunctionBegin;
10821411c6eeSJed Brown   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
10831411c6eeSJed Brown   PetscValidPointer(ltog,2);
10841411c6eeSJed Brown   if (!dm->ltogmap) {
108537d0c07bSMatthew G Knepley     PetscSection section, sectionGlobal;
108637d0c07bSMatthew G Knepley 
108792fd8e1eSJed Brown     ierr = DMGetLocalSection(dm, &section);CHKERRQ(ierr);
108837d0c07bSMatthew G Knepley     if (section) {
1089a974ec88SMatthew G. Knepley       const PetscInt *cdofs;
109037d0c07bSMatthew G Knepley       PetscInt       *ltog;
1091ccf3bd66SMatthew G. Knepley       PetscInt        pStart, pEnd, n, p, k, l;
109237d0c07bSMatthew G Knepley 
1093e87a4003SBarry Smith       ierr = DMGetGlobalSection(dm, &sectionGlobal);CHKERRQ(ierr);
109437d0c07bSMatthew G Knepley       ierr = PetscSectionGetChart(section, &pStart, &pEnd);CHKERRQ(ierr);
1095ccf3bd66SMatthew G. Knepley       ierr = PetscSectionGetStorageSize(section, &n);CHKERRQ(ierr);
1096ccf3bd66SMatthew G. Knepley       ierr = PetscMalloc1(n, &ltog);CHKERRQ(ierr); /* We want the local+overlap size */
109737d0c07bSMatthew G Knepley       for (p = pStart, l = 0; p < pEnd; ++p) {
1098a974ec88SMatthew G. Knepley         PetscInt bdof, cdof, dof, off, c, cind = 0;
109937d0c07bSMatthew G Knepley 
110037d0c07bSMatthew G Knepley         /* Should probably use constrained dofs */
110137d0c07bSMatthew G Knepley         ierr = PetscSectionGetDof(section, p, &dof);CHKERRQ(ierr);
1102a974ec88SMatthew G. Knepley         ierr = PetscSectionGetConstraintDof(section, p, &cdof);CHKERRQ(ierr);
1103a974ec88SMatthew G. Knepley         ierr = PetscSectionGetConstraintIndices(section, p, &cdofs);CHKERRQ(ierr);
110437d0c07bSMatthew G Knepley         ierr = PetscSectionGetOffset(sectionGlobal, p, &off);CHKERRQ(ierr);
11051a7dc684SMatthew G. Knepley         /* If you have dofs, and constraints, and they are unequal, we set the blocksize to 1 */
11061a7dc684SMatthew G. Knepley         bdof = cdof && (dof-cdof) ? 1 : dof;
11071a7dc684SMatthew G. Knepley         if (dof) {
1108b190aa46SMatthew G. Knepley           if (bs < 0)          {bs = bdof;}
1109b190aa46SMatthew G. Knepley           else if (bs != bdof) {bs = 1;}
11101a7dc684SMatthew G. Knepley         }
111137d0c07bSMatthew G Knepley         for (c = 0; c < dof; ++c, ++l) {
1112a974ec88SMatthew G. Knepley           if ((cind < cdof) && (c == cdofs[cind])) ltog[l] = off < 0 ? off-c : off+c;
1113a974ec88SMatthew G. Knepley           else                                     ltog[l] = (off < 0 ? -(off+1) : off) + c;
111437d0c07bSMatthew G Knepley         }
111537d0c07bSMatthew G Knepley       }
1116bff27382SMatthew G. Knepley       /* Must have same blocksize on all procs (some might have no points) */
11170be3e97aSMatthew G. Knepley       bsLocal[0] = bs < 0 ? PETSC_MAX_INT : bs; bsLocal[1] = bs;
11180be3e97aSMatthew G. Knepley       ierr = PetscGlobalMinMaxInt(PetscObjectComm((PetscObject) dm), bsLocal, bsMinMax);CHKERRQ(ierr);
11190be3e97aSMatthew G. Knepley       if (bsMinMax[0] != bsMinMax[1]) {bs = 1;}
11200be3e97aSMatthew G. Knepley       else                            {bs = bsMinMax[0];}
11217591dbb2SMatthew G. Knepley       bs = bs < 0 ? 1 : bs;
11227591dbb2SMatthew G. Knepley       /* Must reduce indices by blocksize */
1123ccf3bd66SMatthew G. Knepley       if (bs > 1) {
1124ccf3bd66SMatthew G. Knepley         for (l = 0, k = 0; l < n; l += bs, ++k) ltog[k] = ltog[l]/bs;
1125ccf3bd66SMatthew G. Knepley         n /= bs;
1126ccf3bd66SMatthew G. Knepley       }
1127ccf3bd66SMatthew G. Knepley       ierr = ISLocalToGlobalMappingCreate(PetscObjectComm((PetscObject)dm), bs, n, ltog, PETSC_OWN_POINTER, &dm->ltogmap);CHKERRQ(ierr);
11283bb1ff40SBarry Smith       ierr = PetscLogObjectParent((PetscObject)dm, (PetscObject)dm->ltogmap);CHKERRQ(ierr);
112937d0c07bSMatthew G Knepley     } else {
1130b9d85ea2SLisandro Dalcin       if (!dm->ops->getlocaltoglobalmapping) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMGetLocalToGlobalMapping",((PetscObject)dm)->type_name);
1131184d77edSJed Brown       ierr = (*dm->ops->getlocaltoglobalmapping)(dm);CHKERRQ(ierr);
11321411c6eeSJed Brown     }
113337d0c07bSMatthew G Knepley   }
11341411c6eeSJed Brown   *ltog = dm->ltogmap;
11351411c6eeSJed Brown   PetscFunctionReturn(0);
11361411c6eeSJed Brown }
11371411c6eeSJed Brown 
11381411c6eeSJed Brown /*@
11391411c6eeSJed Brown    DMGetBlockSize - Gets the inherent block size associated with a DM
11401411c6eeSJed Brown 
11411411c6eeSJed Brown    Not Collective
11421411c6eeSJed Brown 
11431411c6eeSJed Brown    Input Parameter:
11441411c6eeSJed Brown .  dm - the DM with block structure
11451411c6eeSJed Brown 
11461411c6eeSJed Brown    Output Parameter:
11471411c6eeSJed Brown .  bs - the block size, 1 implies no exploitable block structure
11481411c6eeSJed Brown 
11491411c6eeSJed Brown    Level: intermediate
11501411c6eeSJed Brown 
1151fc31e74dSBarry Smith .seealso: ISCreateBlock(), VecSetBlockSize(), MatSetBlockSize(), DMGetLocalToGlobalMapping()
11521411c6eeSJed Brown @*/
11537087cfbeSBarry Smith PetscErrorCode  DMGetBlockSize(DM dm,PetscInt *bs)
11541411c6eeSJed Brown {
11551411c6eeSJed Brown   PetscFunctionBegin;
11561411c6eeSJed Brown   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1157534a8f05SLisandro Dalcin   PetscValidIntPointer(bs,2);
11581411c6eeSJed 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");
11591411c6eeSJed Brown   *bs = dm->bs;
11601411c6eeSJed Brown   PetscFunctionReturn(0);
11611411c6eeSJed Brown }
11621411c6eeSJed Brown 
116348eeb7c8SBarry Smith /*@C
11648472ad0fSDave May     DMCreateInterpolation - Gets interpolation matrix between two DM objects
116547c6ae99SBarry Smith 
1166a5bc1bf3SBarry Smith     Collective on dmc
116747c6ae99SBarry Smith 
1168d8d19677SJose E. Roman     Input Parameters:
1169a5bc1bf3SBarry Smith +   dmc - the DM object
1170a5bc1bf3SBarry Smith -   dmf - the second, finer DM object
117147c6ae99SBarry Smith 
1172d8d19677SJose E. Roman     Output Parameters:
117347c6ae99SBarry Smith +  mat - the interpolation
117447c6ae99SBarry Smith -  vec - the scaling (optional)
117547c6ae99SBarry Smith 
117647c6ae99SBarry Smith     Level: developer
117747c6ae99SBarry Smith 
117895452b02SPatrick Sanan     Notes:
117995452b02SPatrick 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
118085afcc9aSBarry Smith         DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the interpolation.
1181d52bd9f3SBarry Smith 
11821f588964SMatthew G Knepley         For DMDA objects you can use this interpolation (more precisely the interpolation from the DMGetCoordinateDM()) to interpolate the mesh coordinate vectors
1183d52bd9f3SBarry Smith         EXCEPT in the periodic case where it does not make sense since the coordinate vectors are not periodic.
118485afcc9aSBarry Smith 
11852ed6491fSPatrick Sanan .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateRestriction(), DMCreateInterpolationScale()
118647c6ae99SBarry Smith 
118747c6ae99SBarry Smith @*/
1188a5bc1bf3SBarry Smith PetscErrorCode  DMCreateInterpolation(DM dmc,DM dmf,Mat *mat,Vec *vec)
118947c6ae99SBarry Smith {
119047c6ae99SBarry Smith   PetscErrorCode ierr;
119147c6ae99SBarry Smith 
119247c6ae99SBarry Smith   PetscFunctionBegin;
1193a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(dmc,DM_CLASSID,1);
1194a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(dmf,DM_CLASSID,2);
1195c7d20fa0SStefano Zampini   PetscValidPointer(mat,3);
1196a5bc1bf3SBarry Smith   if (!dmc->ops->createinterpolation) SETERRQ1(PetscObjectComm((PetscObject)dmc),PETSC_ERR_SUP,"DM type %s does not implement DMCreateInterpolation",((PetscObject)dmc)->type_name);
1197a5bc1bf3SBarry Smith   ierr = PetscLogEventBegin(DM_CreateInterpolation,dmc,dmf,0,0);CHKERRQ(ierr);
1198a5bc1bf3SBarry Smith   ierr = (*dmc->ops->createinterpolation)(dmc,dmf,mat,vec);CHKERRQ(ierr);
1199a5bc1bf3SBarry Smith   ierr = PetscLogEventEnd(DM_CreateInterpolation,dmc,dmf,0,0);CHKERRQ(ierr);
120047c6ae99SBarry Smith   PetscFunctionReturn(0);
120147c6ae99SBarry Smith }
120247c6ae99SBarry Smith 
12033ad4599aSBarry Smith /*@
1204d3e313eaSPatrick Sanan     DMCreateInterpolationScale - Forms L = 1/(R*1) such that diag(L)*R preserves scale and is thus suitable for state (versus residual) restriction.
12052ed6491fSPatrick Sanan 
12062ed6491fSPatrick Sanan   Input Parameters:
12072ed6491fSPatrick Sanan +      dac - DM that defines a coarse mesh
12082ed6491fSPatrick Sanan .      daf - DM that defines a fine mesh
12092ed6491fSPatrick Sanan -      mat - the restriction (or interpolation operator) from fine to coarse
12102ed6491fSPatrick Sanan 
12112ed6491fSPatrick Sanan   Output Parameter:
12122ed6491fSPatrick Sanan .    scale - the scaled vector
12132ed6491fSPatrick Sanan 
12142ed6491fSPatrick Sanan   Level: developer
12152ed6491fSPatrick Sanan 
12162ed6491fSPatrick Sanan .seealso: DMCreateInterpolation()
12172ed6491fSPatrick Sanan 
12182ed6491fSPatrick Sanan @*/
12192ed6491fSPatrick Sanan PetscErrorCode  DMCreateInterpolationScale(DM dac,DM daf,Mat mat,Vec *scale)
12202ed6491fSPatrick Sanan {
12212ed6491fSPatrick Sanan   PetscErrorCode ierr;
12222ed6491fSPatrick Sanan   Vec            fine;
12232ed6491fSPatrick Sanan   PetscScalar    one = 1.0;
12242ed6491fSPatrick Sanan 
12252ed6491fSPatrick Sanan   PetscFunctionBegin;
12262ed6491fSPatrick Sanan   ierr = DMCreateGlobalVector(daf,&fine);CHKERRQ(ierr);
12272ed6491fSPatrick Sanan   ierr = DMCreateGlobalVector(dac,scale);CHKERRQ(ierr);
12282ed6491fSPatrick Sanan   ierr = VecSet(fine,one);CHKERRQ(ierr);
12292ed6491fSPatrick Sanan   ierr = MatRestrict(mat,fine,*scale);CHKERRQ(ierr);
12302ed6491fSPatrick Sanan   ierr = VecDestroy(&fine);CHKERRQ(ierr);
12312ed6491fSPatrick Sanan   ierr = VecReciprocal(*scale);CHKERRQ(ierr);
12322ed6491fSPatrick Sanan   PetscFunctionReturn(0);
12332ed6491fSPatrick Sanan }
12342ed6491fSPatrick Sanan 
12352ed6491fSPatrick Sanan /*@
12363ad4599aSBarry Smith     DMCreateRestriction - Gets restriction matrix between two DM objects
12373ad4599aSBarry Smith 
1238a5bc1bf3SBarry Smith     Collective on dmc
12393ad4599aSBarry Smith 
1240d8d19677SJose E. Roman     Input Parameters:
1241a5bc1bf3SBarry Smith +   dmc - the DM object
1242a5bc1bf3SBarry Smith -   dmf - the second, finer DM object
12433ad4599aSBarry Smith 
12443ad4599aSBarry Smith     Output Parameter:
12453ad4599aSBarry Smith .  mat - the restriction
12463ad4599aSBarry Smith 
12473ad4599aSBarry Smith     Level: developer
12483ad4599aSBarry Smith 
124995452b02SPatrick Sanan     Notes:
125095452b02SPatrick 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
12513ad4599aSBarry Smith         DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the interpolation.
12523ad4599aSBarry Smith 
12533ad4599aSBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateInterpolation()
12543ad4599aSBarry Smith 
12553ad4599aSBarry Smith @*/
1256a5bc1bf3SBarry Smith PetscErrorCode  DMCreateRestriction(DM dmc,DM dmf,Mat *mat)
12573ad4599aSBarry Smith {
12583ad4599aSBarry Smith   PetscErrorCode ierr;
12593ad4599aSBarry Smith 
12603ad4599aSBarry Smith   PetscFunctionBegin;
1261a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(dmc,DM_CLASSID,1);
1262a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(dmf,DM_CLASSID,2);
12635a84ad33SLisandro Dalcin   PetscValidPointer(mat,3);
1264a5bc1bf3SBarry Smith   if (!dmc->ops->createrestriction) SETERRQ1(PetscObjectComm((PetscObject)dmc),PETSC_ERR_SUP,"DM type %s does not implement DMCreateRestriction",((PetscObject)dmc)->type_name);
1265a5bc1bf3SBarry Smith   ierr = PetscLogEventBegin(DM_CreateRestriction,dmc,dmf,0,0);CHKERRQ(ierr);
1266a5bc1bf3SBarry Smith   ierr = (*dmc->ops->createrestriction)(dmc,dmf,mat);CHKERRQ(ierr);
1267a5bc1bf3SBarry Smith   ierr = PetscLogEventEnd(DM_CreateRestriction,dmc,dmf,0,0);CHKERRQ(ierr);
12683ad4599aSBarry Smith   PetscFunctionReturn(0);
12693ad4599aSBarry Smith }
12703ad4599aSBarry Smith 
127147c6ae99SBarry Smith /*@
12728472ad0fSDave May     DMCreateInjection - Gets injection matrix between two DM objects
127347c6ae99SBarry Smith 
1274a5bc1bf3SBarry Smith     Collective on dac
127547c6ae99SBarry Smith 
1276d8d19677SJose E. Roman     Input Parameters:
1277a5bc1bf3SBarry Smith +   dac - the DM object
1278a5bc1bf3SBarry Smith -   daf - the second, finer DM object
127947c6ae99SBarry Smith 
128047c6ae99SBarry Smith     Output Parameter:
12816dbf9973SLawrence Mitchell .   mat - the injection
128247c6ae99SBarry Smith 
128347c6ae99SBarry Smith     Level: developer
128447c6ae99SBarry Smith 
128595452b02SPatrick Sanan    Notes:
128695452b02SPatrick 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
128785afcc9aSBarry Smith         DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the injection.
128885afcc9aSBarry Smith 
1289e727c939SJed Brown .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMCreateInterpolation()
129047c6ae99SBarry Smith 
129147c6ae99SBarry Smith @*/
1292a5bc1bf3SBarry Smith PetscErrorCode  DMCreateInjection(DM dac,DM daf,Mat *mat)
129347c6ae99SBarry Smith {
129447c6ae99SBarry Smith   PetscErrorCode ierr;
129547c6ae99SBarry Smith 
129647c6ae99SBarry Smith   PetscFunctionBegin;
1297a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(dac,DM_CLASSID,1);
1298a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(daf,DM_CLASSID,2);
12995a84ad33SLisandro Dalcin   PetscValidPointer(mat,3);
1300a5bc1bf3SBarry Smith   if (!dac->ops->createinjection) SETERRQ1(PetscObjectComm((PetscObject)dac),PETSC_ERR_SUP,"DM type %s does not implement DMCreateInjection",((PetscObject)dac)->type_name);
1301a5bc1bf3SBarry Smith   ierr = PetscLogEventBegin(DM_CreateInjection,dac,daf,0,0);CHKERRQ(ierr);
1302a5bc1bf3SBarry Smith   ierr = (*dac->ops->createinjection)(dac,daf,mat);CHKERRQ(ierr);
1303a5bc1bf3SBarry Smith   ierr = PetscLogEventEnd(DM_CreateInjection,dac,daf,0,0);CHKERRQ(ierr);
130447c6ae99SBarry Smith   PetscFunctionReturn(0);
130547c6ae99SBarry Smith }
130647c6ae99SBarry Smith 
1307b412c318SBarry Smith /*@
1308bd041c0cSMatthew G. Knepley   DMCreateMassMatrix - Gets mass matrix between two DM objects, M_ij = \int \phi_i \psi_j
1309bd041c0cSMatthew G. Knepley 
1310a5bc1bf3SBarry Smith   Collective on dac
1311bd041c0cSMatthew G. Knepley 
1312d8d19677SJose E. Roman   Input Parameters:
1313a5bc1bf3SBarry Smith + dac - the DM object
1314a5bc1bf3SBarry Smith - daf - the second, finer DM object
1315bd041c0cSMatthew G. Knepley 
1316bd041c0cSMatthew G. Knepley   Output Parameter:
1317bd041c0cSMatthew G. Knepley . mat - the interpolation
1318bd041c0cSMatthew G. Knepley 
1319bd041c0cSMatthew G. Knepley   Level: developer
1320bd041c0cSMatthew G. Knepley 
1321bd041c0cSMatthew G. Knepley .seealso DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateRestriction(), DMCreateInterpolation(), DMCreateInjection()
1322bd041c0cSMatthew G. Knepley @*/
1323a5bc1bf3SBarry Smith PetscErrorCode DMCreateMassMatrix(DM dac, DM daf, Mat *mat)
1324bd041c0cSMatthew G. Knepley {
1325bd041c0cSMatthew G. Knepley   PetscErrorCode ierr;
1326bd041c0cSMatthew G. Knepley 
1327bd041c0cSMatthew G. Knepley   PetscFunctionBegin;
1328a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(dac, DM_CLASSID, 1);
1329a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(daf, DM_CLASSID, 2);
13305a84ad33SLisandro Dalcin   PetscValidPointer(mat,3);
1331a5bc1bf3SBarry Smith   if (!dac->ops->createmassmatrix) SETERRQ1(PetscObjectComm((PetscObject)dac),PETSC_ERR_SUP,"DM type %s does not implement DMCreateMassMatrix",((PetscObject)dac)->type_name);
1332a5bc1bf3SBarry Smith   ierr = (*dac->ops->createmassmatrix)(dac, daf, mat);CHKERRQ(ierr);
1333bd041c0cSMatthew G. Knepley   PetscFunctionReturn(0);
1334bd041c0cSMatthew G. Knepley }
1335bd041c0cSMatthew G. Knepley 
1336bd041c0cSMatthew G. Knepley /*@
1337b412c318SBarry Smith     DMCreateColoring - Gets coloring for a DM
133847c6ae99SBarry Smith 
1339d083f849SBarry Smith     Collective on dm
134047c6ae99SBarry Smith 
1341d8d19677SJose E. Roman     Input Parameters:
134247c6ae99SBarry Smith +   dm - the DM object
13435bdb020cSBarry Smith -   ctype - IS_COLORING_LOCAL or IS_COLORING_GLOBAL
134447c6ae99SBarry Smith 
134547c6ae99SBarry Smith     Output Parameter:
134647c6ae99SBarry Smith .   coloring - the coloring
134747c6ae99SBarry Smith 
1348ec5066bdSBarry Smith     Notes:
1349ec5066bdSBarry 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
1350ec5066bdSBarry Smith        matrix comes from. In general using the mesh produces a more optimal coloring (fewer colors).
1351ec5066bdSBarry Smith 
1352ec5066bdSBarry Smith        This produces a coloring with the distance of 2, see MatSetColoringDistance() which can be used for efficiently computing Jacobians with MatFDColoringCreate()
1353ec5066bdSBarry Smith 
135447c6ae99SBarry Smith     Level: developer
135547c6ae99SBarry Smith 
1356ec5066bdSBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateMatrix(), DMSetMatType(), MatColoring, MatFDColoringCreate()
135747c6ae99SBarry Smith 
1358aab9d709SJed Brown @*/
1359b412c318SBarry Smith PetscErrorCode  DMCreateColoring(DM dm,ISColoringType ctype,ISColoring *coloring)
136047c6ae99SBarry Smith {
136147c6ae99SBarry Smith   PetscErrorCode ierr;
136247c6ae99SBarry Smith 
136347c6ae99SBarry Smith   PetscFunctionBegin;
1364171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
13655a84ad33SLisandro Dalcin   PetscValidPointer(coloring,3);
1366b9d85ea2SLisandro Dalcin   if (!dm->ops->getcoloring) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateColoring",((PetscObject)dm)->type_name);
1367b412c318SBarry Smith   ierr = (*dm->ops->getcoloring)(dm,ctype,coloring);CHKERRQ(ierr);
136847c6ae99SBarry Smith   PetscFunctionReturn(0);
136947c6ae99SBarry Smith }
137047c6ae99SBarry Smith 
1371b412c318SBarry Smith /*@
13728472ad0fSDave May     DMCreateMatrix - Gets empty Jacobian for a DM
137347c6ae99SBarry Smith 
1374d083f849SBarry Smith     Collective on dm
137547c6ae99SBarry Smith 
137647c6ae99SBarry Smith     Input Parameter:
1377b412c318SBarry Smith .   dm - the DM object
137847c6ae99SBarry Smith 
137947c6ae99SBarry Smith     Output Parameter:
138047c6ae99SBarry Smith .   mat - the empty Jacobian
138147c6ae99SBarry Smith 
1382073dac72SJed Brown     Level: beginner
138347c6ae99SBarry Smith 
1384f27dd7c6SMatthew G. Knepley     Options Database Keys:
1385f27dd7c6SMatthew G. Knepley . -dm_preallocate_only - Only preallocate the matrix for DMCreateMatrix(), but do not fill it with zeros
1386f27dd7c6SMatthew G. Knepley 
138795452b02SPatrick Sanan     Notes:
138895452b02SPatrick Sanan     This properly preallocates the number of nonzeros in the sparse matrix so you
138994013140SBarry Smith        do not need to do it yourself.
139094013140SBarry Smith 
139194013140SBarry Smith        By default it also sets the nonzero structure and puts in the zero entries. To prevent setting
13927889ec69SBarry Smith        the nonzero pattern call DMSetMatrixPreallocateOnly()
139394013140SBarry Smith 
139494013140SBarry 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
139594013140SBarry Smith        internally by PETSc.
139694013140SBarry Smith 
139794013140SBarry Smith        For structured grid problems, in general it is easiest to use MatSetValuesStencil() or MatSetValuesLocal() to put values into the matrix because MatSetValues() requires
1398aa219208SBarry Smith        the indices for the global numbering for DMDAs which is complicated.
139994013140SBarry Smith 
1400b412c318SBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMSetMatType()
140147c6ae99SBarry Smith 
1402aab9d709SJed Brown @*/
1403b412c318SBarry Smith PetscErrorCode  DMCreateMatrix(DM dm,Mat *mat)
140447c6ae99SBarry Smith {
140547c6ae99SBarry Smith   PetscErrorCode ierr;
140647c6ae99SBarry Smith 
140747c6ae99SBarry Smith   PetscFunctionBegin;
1408171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1409064a246eSJacob Faibussowitsch   PetscValidPointer(mat,2);
1410b9d85ea2SLisandro Dalcin   if (!dm->ops->creatematrix) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateMatrix",((PetscObject)dm)->type_name);
14115a84ad33SLisandro Dalcin   ierr = MatInitializePackage();CHKERRQ(ierr);
1412fdc842d1SBarry Smith   ierr = PetscLogEventBegin(DM_CreateMatrix,0,0,0,0);CHKERRQ(ierr);
1413b412c318SBarry Smith   ierr = (*dm->ops->creatematrix)(dm,mat);CHKERRQ(ierr);
141476bd3646SJed Brown   if (PetscDefined(USE_DEBUG)) {
1415c6b011d8SStefano Zampini     DM mdm;
1416c6b011d8SStefano Zampini 
1417c6b011d8SStefano Zampini     ierr = MatGetDM(*mat,&mdm);CHKERRQ(ierr);
1418c6b011d8SStefano 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);
1419c6b011d8SStefano Zampini   }
1420e571a35bSMatthew G. Knepley   /* Handle nullspace and near nullspace */
1421e5e52638SMatthew G. Knepley   if (dm->Nf) {
1422e571a35bSMatthew G. Knepley     MatNullSpace nullSpace;
1423649ef022SMatthew Knepley     PetscInt     Nf, f;
1424e571a35bSMatthew G. Knepley 
1425e5e52638SMatthew G. Knepley     ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
1426649ef022SMatthew Knepley     for (f = 0; f < Nf; ++f) {
1427649ef022SMatthew Knepley       if (dm->nullspaceConstructors[f]) {
1428649ef022SMatthew Knepley         ierr = (*dm->nullspaceConstructors[f])(dm, f, f, &nullSpace);CHKERRQ(ierr);
1429e571a35bSMatthew G. Knepley         ierr = MatSetNullSpace(*mat, nullSpace);CHKERRQ(ierr);
1430e571a35bSMatthew G. Knepley         ierr = MatNullSpaceDestroy(&nullSpace);CHKERRQ(ierr);
1431649ef022SMatthew Knepley         break;
1432e571a35bSMatthew G. Knepley       }
1433649ef022SMatthew Knepley     }
1434649ef022SMatthew Knepley     for (f = 0; f < Nf; ++f) {
1435649ef022SMatthew Knepley       if (dm->nearnullspaceConstructors[f]) {
1436649ef022SMatthew Knepley         ierr = (*dm->nearnullspaceConstructors[f])(dm, f, f, &nullSpace);CHKERRQ(ierr);
1437e571a35bSMatthew G. Knepley         ierr = MatSetNearNullSpace(*mat, nullSpace);CHKERRQ(ierr);
1438e571a35bSMatthew G. Knepley         ierr = MatNullSpaceDestroy(&nullSpace);CHKERRQ(ierr);
1439e571a35bSMatthew G. Knepley       }
1440e571a35bSMatthew G. Knepley     }
1441e571a35bSMatthew G. Knepley   }
1442fdc842d1SBarry Smith   ierr = PetscLogEventEnd(DM_CreateMatrix,0,0,0,0);CHKERRQ(ierr);
144347c6ae99SBarry Smith   PetscFunctionReturn(0);
144447c6ae99SBarry Smith }
144547c6ae99SBarry Smith 
1446732e2eb9SMatthew G Knepley /*@
1447950540a4SJed Brown   DMSetMatrixPreallocateOnly - When DMCreateMatrix() is called the matrix will be properly
1448732e2eb9SMatthew G Knepley     preallocated but the nonzero structure and zero values will not be set.
1449732e2eb9SMatthew G Knepley 
1450d083f849SBarry Smith   Logically Collective on dm
1451732e2eb9SMatthew G Knepley 
1452d8d19677SJose E. Roman   Input Parameters:
1453732e2eb9SMatthew G Knepley + dm - the DM
1454732e2eb9SMatthew G Knepley - only - PETSC_TRUE if only want preallocation
1455732e2eb9SMatthew G Knepley 
1456732e2eb9SMatthew G Knepley   Level: developer
1457f27dd7c6SMatthew G. Knepley 
1458f27dd7c6SMatthew G. Knepley   Options Database Keys:
1459f27dd7c6SMatthew G. Knepley . -dm_preallocate_only - Only preallocate the matrix for DMCreateMatrix(), but do not fill it with zeros
1460f27dd7c6SMatthew G. Knepley 
1461b06ff27eSHong Zhang .seealso DMCreateMatrix(), DMSetMatrixStructureOnly()
1462732e2eb9SMatthew G Knepley @*/
1463732e2eb9SMatthew G Knepley PetscErrorCode DMSetMatrixPreallocateOnly(DM dm, PetscBool only)
1464732e2eb9SMatthew G Knepley {
1465732e2eb9SMatthew G Knepley   PetscFunctionBegin;
1466732e2eb9SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1467732e2eb9SMatthew G Knepley   dm->prealloc_only = only;
1468732e2eb9SMatthew G Knepley   PetscFunctionReturn(0);
1469732e2eb9SMatthew G Knepley }
1470732e2eb9SMatthew G Knepley 
1471b06ff27eSHong Zhang /*@
1472b06ff27eSHong Zhang   DMSetMatrixStructureOnly - When DMCreateMatrix() is called, the matrix structure will be created
1473b06ff27eSHong Zhang     but the array for values will not be allocated.
1474b06ff27eSHong Zhang 
1475d083f849SBarry Smith   Logically Collective on dm
1476b06ff27eSHong Zhang 
1477d8d19677SJose E. Roman   Input Parameters:
1478b06ff27eSHong Zhang + dm - the DM
1479b06ff27eSHong Zhang - only - PETSC_TRUE if only want matrix stucture
1480b06ff27eSHong Zhang 
1481b06ff27eSHong Zhang   Level: developer
1482b06ff27eSHong Zhang .seealso DMCreateMatrix(), DMSetMatrixPreallocateOnly()
1483b06ff27eSHong Zhang @*/
1484b06ff27eSHong Zhang PetscErrorCode DMSetMatrixStructureOnly(DM dm, PetscBool only)
1485b06ff27eSHong Zhang {
1486b06ff27eSHong Zhang   PetscFunctionBegin;
1487b06ff27eSHong Zhang   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1488b06ff27eSHong Zhang   dm->structure_only = only;
1489b06ff27eSHong Zhang   PetscFunctionReturn(0);
1490b06ff27eSHong Zhang }
1491b06ff27eSHong Zhang 
1492a89ea682SMatthew G Knepley /*@C
1493aa1993deSMatthew G Knepley   DMGetWorkArray - Gets a work array guaranteed to be at least the input size, restore with DMRestoreWorkArray()
1494a89ea682SMatthew G Knepley 
1495a89ea682SMatthew G Knepley   Not Collective
1496a89ea682SMatthew G Knepley 
1497a89ea682SMatthew G Knepley   Input Parameters:
1498a89ea682SMatthew G Knepley + dm - the DM object
1499a5b23f4aSJose E. Roman . count - The minimum size
150069291d52SBarry Smith - dtype - MPI data type, often MPIU_REAL, MPIU_SCALAR, MPIU_INT)
1501a89ea682SMatthew G Knepley 
1502a89ea682SMatthew G Knepley   Output Parameter:
1503a89ea682SMatthew G Knepley . array - the work array
1504a89ea682SMatthew G Knepley 
1505a89ea682SMatthew G Knepley   Level: developer
1506a89ea682SMatthew G Knepley 
1507a89ea682SMatthew G Knepley .seealso DMDestroy(), DMCreate()
1508a89ea682SMatthew G Knepley @*/
150969291d52SBarry Smith PetscErrorCode DMGetWorkArray(DM dm,PetscInt count,MPI_Datatype dtype,void *mem)
1510a89ea682SMatthew G Knepley {
1511a89ea682SMatthew G Knepley   PetscErrorCode ierr;
1512aa1993deSMatthew G Knepley   DMWorkLink     link;
151369291d52SBarry Smith   PetscMPIInt    dsize;
1514a89ea682SMatthew G Knepley 
1515a89ea682SMatthew G Knepley   PetscFunctionBegin;
1516a89ea682SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1517aa1993deSMatthew G Knepley   PetscValidPointer(mem,4);
1518aa1993deSMatthew G Knepley   if (dm->workin) {
1519aa1993deSMatthew G Knepley     link       = dm->workin;
1520aa1993deSMatthew G Knepley     dm->workin = dm->workin->next;
1521aa1993deSMatthew G Knepley   } else {
1522b00a9115SJed Brown     ierr = PetscNewLog(dm,&link);CHKERRQ(ierr);
1523a89ea682SMatthew G Knepley   }
1524ffc4695bSBarry Smith   ierr = MPI_Type_size(dtype,&dsize);CHKERRMPI(ierr);
15255056fcd2SBarry Smith   if (((size_t)dsize*count) > link->bytes) {
1526aa1993deSMatthew G Knepley     ierr        = PetscFree(link->mem);CHKERRQ(ierr);
1527854ce69bSBarry Smith     ierr        = PetscMalloc(dsize*count,&link->mem);CHKERRQ(ierr);
1528854ce69bSBarry Smith     link->bytes = dsize*count;
1529aa1993deSMatthew G Knepley   }
1530aa1993deSMatthew G Knepley   link->next   = dm->workout;
1531aa1993deSMatthew G Knepley   dm->workout  = link;
153200d952a4SJed Brown #if defined(PETSC_HAVE_VALGRIND)
153300d952a4SJed Brown   VALGRIND_MAKE_MEM_NOACCESS((char*)link->mem + (size_t)dsize*count, link->bytes - (size_t)dsize*count);
153400d952a4SJed Brown   VALGRIND_MAKE_MEM_UNDEFINED(link->mem, (size_t)dsize*count);
153500d952a4SJed Brown #endif
1536aa1993deSMatthew G Knepley   *(void**)mem = link->mem;
1537a89ea682SMatthew G Knepley   PetscFunctionReturn(0);
1538a89ea682SMatthew G Knepley }
1539a89ea682SMatthew G Knepley 
1540aa1993deSMatthew G Knepley /*@C
1541aa1993deSMatthew G Knepley   DMRestoreWorkArray - Restores a work array guaranteed to be at least the input size, restore with DMRestoreWorkArray()
1542aa1993deSMatthew G Knepley 
1543aa1993deSMatthew G Knepley   Not Collective
1544aa1993deSMatthew G Knepley 
1545aa1993deSMatthew G Knepley   Input Parameters:
1546aa1993deSMatthew G Knepley + dm - the DM object
1547a5b23f4aSJose E. Roman . count - The minimum size
154869291d52SBarry Smith - dtype - MPI data type, often MPIU_REAL, MPIU_SCALAR, MPIU_INT
1549aa1993deSMatthew G Knepley 
1550aa1993deSMatthew G Knepley   Output Parameter:
1551aa1993deSMatthew G Knepley . array - the work array
1552aa1993deSMatthew G Knepley 
1553aa1993deSMatthew G Knepley   Level: developer
1554aa1993deSMatthew G Knepley 
155595452b02SPatrick Sanan   Developer Notes:
155695452b02SPatrick Sanan     count and dtype are ignored, they are only needed for DMGetWorkArray()
1557aa1993deSMatthew G Knepley .seealso DMDestroy(), DMCreate()
1558aa1993deSMatthew G Knepley @*/
155969291d52SBarry Smith PetscErrorCode DMRestoreWorkArray(DM dm,PetscInt count,MPI_Datatype dtype,void *mem)
1560aa1993deSMatthew G Knepley {
1561aa1993deSMatthew G Knepley   DMWorkLink *p,link;
1562aa1993deSMatthew G Knepley 
1563aa1993deSMatthew G Knepley   PetscFunctionBegin;
1564aa1993deSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1565aa1993deSMatthew G Knepley   PetscValidPointer(mem,4);
1566aa1993deSMatthew G Knepley   for (p=&dm->workout; (link=*p); p=&link->next) {
1567aa1993deSMatthew G Knepley     if (link->mem == *(void**)mem) {
1568aa1993deSMatthew G Knepley       *p           = link->next;
1569aa1993deSMatthew G Knepley       link->next   = dm->workin;
1570aa1993deSMatthew G Knepley       dm->workin   = link;
15710298fd71SBarry Smith       *(void**)mem = NULL;
1572aa1993deSMatthew G Knepley       PetscFunctionReturn(0);
1573aa1993deSMatthew G Knepley     }
1574aa1993deSMatthew G Knepley   }
1575aa1993deSMatthew G Knepley   SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Array was not checked out");
1576aa1993deSMatthew G Knepley }
1577e7c4fc90SDmitry Karpeev 
15788cda7954SMatthew G. Knepley /*@C
15798cda7954SMatthew G. Knepley   DMSetNullSpaceConstructor - Provide a callback function which constructs the nullspace for a given field
15808cda7954SMatthew G. Knepley 
15818cda7954SMatthew G. Knepley   Logically collective on DM
15828cda7954SMatthew G. Knepley 
15838cda7954SMatthew G. Knepley   Input Parameters:
15848cda7954SMatthew G. Knepley + dm     - The DM
15858cda7954SMatthew G. Knepley . field  - The field number for the nullspace
15868cda7954SMatthew G. Knepley - nullsp - A callback to create the nullspace
15878cda7954SMatthew G. Knepley 
15888cda7954SMatthew G. Knepley   Notes:
15898cda7954SMatthew G. Knepley   The callback is intended to provide nullspaces when function spaces are joined or split, such as in DMCreateSubDM(). The calling sequence is
15908cda7954SMatthew G. Knepley $ PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace)
15918cda7954SMatthew G. Knepley $ dm        - The present DM
15928cda7954SMatthew G. Knepley $ origField - The field number given above, in the original DM
15938cda7954SMatthew G. Knepley $ field     - The field number in dm
15948cda7954SMatthew G. Knepley $ nullSpace - The nullspace for the given field
15958cda7954SMatthew G. Knepley 
15968cda7954SMatthew G. Knepley   This function is currently not available from Fortran.
15978cda7954SMatthew G. Knepley 
15988cda7954SMatthew G. Knepley .seealso: DMGetNullSpaceConstructor(), DMSetNearNullSpaceConstructor(), DMGetNearNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM()
15998cda7954SMatthew G. Knepley */
16008cda7954SMatthew G. Knepley PetscErrorCode DMSetNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (*nullsp)(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace))
1601435a35e8SMatthew G Knepley {
1602435a35e8SMatthew G Knepley   PetscFunctionBegin;
1603435a35e8SMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
160482f516ccSBarry Smith   if (field >= 10) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field);
1605435a35e8SMatthew G Knepley   dm->nullspaceConstructors[field] = nullsp;
1606435a35e8SMatthew G Knepley   PetscFunctionReturn(0);
1607435a35e8SMatthew G Knepley }
1608435a35e8SMatthew G Knepley 
16098cda7954SMatthew G. Knepley /*@C
16108cda7954SMatthew G. Knepley   DMGetNullSpaceConstructor - Return the callback function which constructs the nullspace for a given field, or NULL
16118cda7954SMatthew G. Knepley 
16128cda7954SMatthew G. Knepley   Not collective
16138cda7954SMatthew G. Knepley 
16148cda7954SMatthew G. Knepley   Input Parameters:
16158cda7954SMatthew G. Knepley + dm     - The DM
16168cda7954SMatthew G. Knepley - field  - The field number for the nullspace
16178cda7954SMatthew G. Knepley 
16188cda7954SMatthew G. Knepley   Output Parameter:
16198cda7954SMatthew G. Knepley . nullsp - A callback to create the nullspace
16208cda7954SMatthew G. Knepley 
16218cda7954SMatthew G. Knepley   Notes:
16228cda7954SMatthew G. Knepley   The callback is intended to provide nullspaces when function spaces are joined or split, such as in DMCreateSubDM(). The calling sequence is
16238cda7954SMatthew G. Knepley $ PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace)
16248cda7954SMatthew G. Knepley $ dm        - The present DM
16258cda7954SMatthew G. Knepley $ origField - The field number given above, in the original DM
16268cda7954SMatthew G. Knepley $ field     - The field number in dm
16278cda7954SMatthew G. Knepley $ nullSpace - The nullspace for the given field
16288cda7954SMatthew G. Knepley 
16298cda7954SMatthew G. Knepley   This function is currently not available from Fortran.
16308cda7954SMatthew G. Knepley 
16318cda7954SMatthew G. Knepley .seealso: DMSetNullSpaceConstructor(), DMSetNearNullSpaceConstructor(), DMGetNearNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM()
16328cda7954SMatthew G. Knepley */
16338cda7954SMatthew G. Knepley PetscErrorCode DMGetNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (**nullsp)(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace))
16340a50eb56SMatthew G. Knepley {
16350a50eb56SMatthew G. Knepley   PetscFunctionBegin;
16360a50eb56SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
1637f9d4088aSMatthew G. Knepley   PetscValidPointer(nullsp, 3);
16380a50eb56SMatthew G. Knepley   if (field >= 10) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field);
16390a50eb56SMatthew G. Knepley   *nullsp = dm->nullspaceConstructors[field];
16400a50eb56SMatthew G. Knepley   PetscFunctionReturn(0);
16410a50eb56SMatthew G. Knepley }
16420a50eb56SMatthew G. Knepley 
16438cda7954SMatthew G. Knepley /*@C
16448cda7954SMatthew G. Knepley   DMSetNearNullSpaceConstructor - Provide a callback function which constructs the near-nullspace for a given field
16458cda7954SMatthew G. Knepley 
16468cda7954SMatthew G. Knepley   Logically collective on DM
16478cda7954SMatthew G. Knepley 
16488cda7954SMatthew G. Knepley   Input Parameters:
16498cda7954SMatthew G. Knepley + dm     - The DM
16508cda7954SMatthew G. Knepley . field  - The field number for the nullspace
16518cda7954SMatthew G. Knepley - nullsp - A callback to create the near-nullspace
16528cda7954SMatthew G. Knepley 
16538cda7954SMatthew G. Knepley   Notes:
16548cda7954SMatthew G. Knepley   The callback is intended to provide nullspaces when function spaces are joined or split, such as in DMCreateSubDM(). The calling sequence is
16558cda7954SMatthew G. Knepley $ PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace)
16568cda7954SMatthew G. Knepley $ dm        - The present DM
16578cda7954SMatthew G. Knepley $ origField - The field number given above, in the original DM
16588cda7954SMatthew G. Knepley $ field     - The field number in dm
16598cda7954SMatthew G. Knepley $ nullSpace - The nullspace for the given field
16608cda7954SMatthew G. Knepley 
16618cda7954SMatthew G. Knepley   This function is currently not available from Fortran.
16628cda7954SMatthew G. Knepley 
16638cda7954SMatthew G. Knepley .seealso: DMGetNearNullSpaceConstructor(), DMSetNullSpaceConstructor(), DMGetNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM()
16648cda7954SMatthew G. Knepley */
16658cda7954SMatthew G. Knepley PetscErrorCode DMSetNearNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (*nullsp)(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace))
1666f9d4088aSMatthew G. Knepley {
1667f9d4088aSMatthew G. Knepley   PetscFunctionBegin;
1668f9d4088aSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
1669f9d4088aSMatthew G. Knepley   if (field >= 10) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field);
1670f9d4088aSMatthew G. Knepley   dm->nearnullspaceConstructors[field] = nullsp;
1671f9d4088aSMatthew G. Knepley   PetscFunctionReturn(0);
1672f9d4088aSMatthew G. Knepley }
1673f9d4088aSMatthew G. Knepley 
16748cda7954SMatthew G. Knepley /*@C
16758cda7954SMatthew G. Knepley   DMGetNearNullSpaceConstructor - Return the callback function which constructs the near-nullspace for a given field, or NULL
16768cda7954SMatthew G. Knepley 
16778cda7954SMatthew G. Knepley   Not collective
16788cda7954SMatthew G. Knepley 
16798cda7954SMatthew G. Knepley   Input Parameters:
16808cda7954SMatthew G. Knepley + dm     - The DM
16818cda7954SMatthew G. Knepley - field  - The field number for the nullspace
16828cda7954SMatthew G. Knepley 
16838cda7954SMatthew G. Knepley   Output Parameter:
16848cda7954SMatthew G. Knepley . nullsp - A callback to create the near-nullspace
16858cda7954SMatthew G. Knepley 
16868cda7954SMatthew G. Knepley   Notes:
16878cda7954SMatthew G. Knepley   The callback is intended to provide nullspaces when function spaces are joined or split, such as in DMCreateSubDM(). The calling sequence is
16888cda7954SMatthew G. Knepley $ PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace)
16898cda7954SMatthew G. Knepley $ dm        - The present DM
16908cda7954SMatthew G. Knepley $ origField - The field number given above, in the original DM
16918cda7954SMatthew G. Knepley $ field     - The field number in dm
16928cda7954SMatthew G. Knepley $ nullSpace - The nullspace for the given field
16938cda7954SMatthew G. Knepley 
16948cda7954SMatthew G. Knepley   This function is currently not available from Fortran.
16958cda7954SMatthew G. Knepley 
16968cda7954SMatthew G. Knepley .seealso: DMSetNearNullSpaceConstructor(), DMSetNullSpaceConstructor(), DMGetNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM()
16978cda7954SMatthew G. Knepley */
16988cda7954SMatthew G. Knepley PetscErrorCode DMGetNearNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (**nullsp)(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace))
1699f9d4088aSMatthew G. Knepley {
1700f9d4088aSMatthew G. Knepley   PetscFunctionBegin;
1701f9d4088aSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
1702f9d4088aSMatthew G. Knepley   PetscValidPointer(nullsp, 3);
1703f9d4088aSMatthew G. Knepley   if (field >= 10) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field);
1704f9d4088aSMatthew G. Knepley   *nullsp = dm->nearnullspaceConstructors[field];
1705f9d4088aSMatthew G. Knepley   PetscFunctionReturn(0);
1706f9d4088aSMatthew G. Knepley }
1707f9d4088aSMatthew G. Knepley 
17084f3b5142SJed Brown /*@C
17094d343eeaSMatthew G Knepley   DMCreateFieldIS - Creates a set of IS objects with the global indices of dofs for each field
17104d343eeaSMatthew G Knepley 
17114d343eeaSMatthew G Knepley   Not collective
17124d343eeaSMatthew G Knepley 
17134d343eeaSMatthew G Knepley   Input Parameter:
17144d343eeaSMatthew G Knepley . dm - the DM object
17154d343eeaSMatthew G Knepley 
17164d343eeaSMatthew G Knepley   Output Parameters:
17170298fd71SBarry Smith + numFields  - The number of fields (or NULL if not requested)
17180298fd71SBarry Smith . fieldNames - The name for each field (or NULL if not requested)
17190298fd71SBarry Smith - fields     - The global indices for each field (or NULL if not requested)
17204d343eeaSMatthew G Knepley 
17214d343eeaSMatthew G Knepley   Level: intermediate
17224d343eeaSMatthew G Knepley 
172321c9b008SJed Brown   Notes:
172421c9b008SJed Brown   The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with
172521c9b008SJed Brown   PetscFree(), every entry of fields should be destroyed with ISDestroy(), and both arrays should be freed with
172621c9b008SJed Brown   PetscFree().
172721c9b008SJed Brown 
17284d343eeaSMatthew G Knepley .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
17294d343eeaSMatthew G Knepley @*/
173037d0c07bSMatthew G Knepley PetscErrorCode DMCreateFieldIS(DM dm, PetscInt *numFields, char ***fieldNames, IS **fields)
17314d343eeaSMatthew G Knepley {
173237d0c07bSMatthew G Knepley   PetscSection   section, sectionGlobal;
17334d343eeaSMatthew G Knepley   PetscErrorCode ierr;
17344d343eeaSMatthew G Knepley 
17354d343eeaSMatthew G Knepley   PetscFunctionBegin;
17364d343eeaSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
173769ca1f37SDmitry Karpeev   if (numFields) {
1738534a8f05SLisandro Dalcin     PetscValidIntPointer(numFields,2);
173969ca1f37SDmitry Karpeev     *numFields = 0;
174069ca1f37SDmitry Karpeev   }
174137d0c07bSMatthew G Knepley   if (fieldNames) {
174237d0c07bSMatthew G Knepley     PetscValidPointer(fieldNames,3);
17430298fd71SBarry Smith     *fieldNames = NULL;
174469ca1f37SDmitry Karpeev   }
174569ca1f37SDmitry Karpeev   if (fields) {
174669ca1f37SDmitry Karpeev     PetscValidPointer(fields,4);
17470298fd71SBarry Smith     *fields = NULL;
174869ca1f37SDmitry Karpeev   }
174992fd8e1eSJed Brown   ierr = DMGetLocalSection(dm, &section);CHKERRQ(ierr);
175037d0c07bSMatthew G Knepley   if (section) {
17513a544194SStefano Zampini     PetscInt *fieldSizes, *fieldNc, **fieldIndices;
175237d0c07bSMatthew G Knepley     PetscInt nF, f, pStart, pEnd, p;
175337d0c07bSMatthew G Knepley 
1754e87a4003SBarry Smith     ierr = DMGetGlobalSection(dm, &sectionGlobal);CHKERRQ(ierr);
175537d0c07bSMatthew G Knepley     ierr = PetscSectionGetNumFields(section, &nF);CHKERRQ(ierr);
17563a544194SStefano Zampini     ierr = PetscMalloc3(nF,&fieldSizes,nF,&fieldNc,nF,&fieldIndices);CHKERRQ(ierr);
175737d0c07bSMatthew G Knepley     ierr = PetscSectionGetChart(sectionGlobal, &pStart, &pEnd);CHKERRQ(ierr);
175837d0c07bSMatthew G Knepley     for (f = 0; f < nF; ++f) {
175937d0c07bSMatthew G Knepley       fieldSizes[f] = 0;
17603a544194SStefano Zampini       ierr          = PetscSectionGetFieldComponents(section, f, &fieldNc[f]);CHKERRQ(ierr);
176137d0c07bSMatthew G Knepley     }
176237d0c07bSMatthew G Knepley     for (p = pStart; p < pEnd; ++p) {
176337d0c07bSMatthew G Knepley       PetscInt gdof;
176437d0c07bSMatthew G Knepley 
176537d0c07bSMatthew G Knepley       ierr = PetscSectionGetDof(sectionGlobal, p, &gdof);CHKERRQ(ierr);
176637d0c07bSMatthew G Knepley       if (gdof > 0) {
176737d0c07bSMatthew G Knepley         for (f = 0; f < nF; ++f) {
17683a544194SStefano Zampini           PetscInt fdof, fcdof, fpdof;
176937d0c07bSMatthew G Knepley 
177037d0c07bSMatthew G Knepley           ierr  = PetscSectionGetFieldDof(section, p, f, &fdof);CHKERRQ(ierr);
177137d0c07bSMatthew G Knepley           ierr  = PetscSectionGetFieldConstraintDof(section, p, f, &fcdof);CHKERRQ(ierr);
17723a544194SStefano Zampini           fpdof = fdof-fcdof;
17733a544194SStefano Zampini           if (fpdof && fpdof != fieldNc[f]) {
17743a544194SStefano Zampini             /* Layout does not admit a pointwise block size */
17753a544194SStefano Zampini             fieldNc[f] = 1;
17763a544194SStefano Zampini           }
17773a544194SStefano Zampini           fieldSizes[f] += fpdof;
177837d0c07bSMatthew G Knepley         }
177937d0c07bSMatthew G Knepley       }
178037d0c07bSMatthew G Knepley     }
178137d0c07bSMatthew G Knepley     for (f = 0; f < nF; ++f) {
1782785e854fSJed Brown       ierr          = PetscMalloc1(fieldSizes[f], &fieldIndices[f]);CHKERRQ(ierr);
178337d0c07bSMatthew G Knepley       fieldSizes[f] = 0;
178437d0c07bSMatthew G Knepley     }
178537d0c07bSMatthew G Knepley     for (p = pStart; p < pEnd; ++p) {
178637d0c07bSMatthew G Knepley       PetscInt gdof, goff;
178737d0c07bSMatthew G Knepley 
178837d0c07bSMatthew G Knepley       ierr = PetscSectionGetDof(sectionGlobal, p, &gdof);CHKERRQ(ierr);
178937d0c07bSMatthew G Knepley       if (gdof > 0) {
179037d0c07bSMatthew G Knepley         ierr = PetscSectionGetOffset(sectionGlobal, p, &goff);CHKERRQ(ierr);
179137d0c07bSMatthew G Knepley         for (f = 0; f < nF; ++f) {
179237d0c07bSMatthew G Knepley           PetscInt fdof, fcdof, fc;
179337d0c07bSMatthew G Knepley 
179437d0c07bSMatthew G Knepley           ierr = PetscSectionGetFieldDof(section, p, f, &fdof);CHKERRQ(ierr);
179537d0c07bSMatthew G Knepley           ierr = PetscSectionGetFieldConstraintDof(section, p, f, &fcdof);CHKERRQ(ierr);
179637d0c07bSMatthew G Knepley           for (fc = 0; fc < fdof-fcdof; ++fc, ++fieldSizes[f]) {
179737d0c07bSMatthew G Knepley             fieldIndices[f][fieldSizes[f]] = goff++;
179837d0c07bSMatthew G Knepley           }
179937d0c07bSMatthew G Knepley         }
180037d0c07bSMatthew G Knepley       }
180137d0c07bSMatthew G Knepley     }
18028865f1eaSKarl Rupp     if (numFields) *numFields = nF;
180337d0c07bSMatthew G Knepley     if (fieldNames) {
1804785e854fSJed Brown       ierr = PetscMalloc1(nF, fieldNames);CHKERRQ(ierr);
180537d0c07bSMatthew G Knepley       for (f = 0; f < nF; ++f) {
180637d0c07bSMatthew G Knepley         const char *fieldName;
180737d0c07bSMatthew G Knepley 
180837d0c07bSMatthew G Knepley         ierr = PetscSectionGetFieldName(section, f, &fieldName);CHKERRQ(ierr);
180937d0c07bSMatthew G Knepley         ierr = PetscStrallocpy(fieldName, (char**) &(*fieldNames)[f]);CHKERRQ(ierr);
181037d0c07bSMatthew G Knepley       }
181137d0c07bSMatthew G Knepley     }
181237d0c07bSMatthew G Knepley     if (fields) {
1813785e854fSJed Brown       ierr = PetscMalloc1(nF, fields);CHKERRQ(ierr);
181437d0c07bSMatthew G Knepley       for (f = 0; f < nF; ++f) {
18153a544194SStefano Zampini         PetscInt bs, in[2], out[2];
18163a544194SStefano Zampini 
181782f516ccSBarry Smith         ierr  = ISCreateGeneral(PetscObjectComm((PetscObject)dm), fieldSizes[f], fieldIndices[f], PETSC_OWN_POINTER, &(*fields)[f]);CHKERRQ(ierr);
18183a544194SStefano Zampini         in[0] = -fieldNc[f];
18193a544194SStefano Zampini         in[1] = fieldNc[f];
1820820f2d46SBarry Smith         ierr  = MPIU_Allreduce(in, out, 2, MPIU_INT, MPI_MAX, PetscObjectComm((PetscObject)dm));CHKERRMPI(ierr);
18213a544194SStefano Zampini         bs    = (-out[0] == out[1]) ? out[1] : 1;
18223a544194SStefano Zampini         ierr  = ISSetBlockSize((*fields)[f], bs);CHKERRQ(ierr);
182337d0c07bSMatthew G Knepley       }
182437d0c07bSMatthew G Knepley     }
18253a544194SStefano Zampini     ierr = PetscFree3(fieldSizes,fieldNc,fieldIndices);CHKERRQ(ierr);
18268865f1eaSKarl Rupp   } else if (dm->ops->createfieldis) {
18278865f1eaSKarl Rupp     ierr = (*dm->ops->createfieldis)(dm, numFields, fieldNames, fields);CHKERRQ(ierr);
182869ca1f37SDmitry Karpeev   }
18294d343eeaSMatthew G Knepley   PetscFunctionReturn(0);
18304d343eeaSMatthew G Knepley }
18314d343eeaSMatthew G Knepley 
183216621825SDmitry Karpeev /*@C
183316621825SDmitry Karpeev   DMCreateFieldDecomposition - Returns a list of IS objects defining a decomposition of a problem into subproblems
183416621825SDmitry Karpeev                           corresponding to different fields: each IS contains the global indices of the dofs of the
183516621825SDmitry Karpeev                           corresponding field. The optional list of DMs define the DM for each subproblem.
1836e7c4fc90SDmitry Karpeev                           Generalizes DMCreateFieldIS().
1837e7c4fc90SDmitry Karpeev 
1838e7c4fc90SDmitry Karpeev   Not collective
1839e7c4fc90SDmitry Karpeev 
1840e7c4fc90SDmitry Karpeev   Input Parameter:
1841e7c4fc90SDmitry Karpeev . dm - the DM object
1842e7c4fc90SDmitry Karpeev 
1843e7c4fc90SDmitry Karpeev   Output Parameters:
18440298fd71SBarry Smith + len       - The number of subproblems in the field decomposition (or NULL if not requested)
18450298fd71SBarry Smith . namelist  - The name for each field (or NULL if not requested)
18460298fd71SBarry Smith . islist    - The global indices for each field (or NULL if not requested)
18470298fd71SBarry Smith - dmlist    - The DMs for each field subproblem (or NULL, if not requested; if NULL is returned, no DMs are defined)
1848e7c4fc90SDmitry Karpeev 
1849e7c4fc90SDmitry Karpeev   Level: intermediate
1850e7c4fc90SDmitry Karpeev 
1851e7c4fc90SDmitry Karpeev   Notes:
1852e7c4fc90SDmitry Karpeev   The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with
1853e7c4fc90SDmitry Karpeev   PetscFree(), every entry of is should be destroyed with ISDestroy(), every entry of dm should be destroyed with DMDestroy(),
1854e7c4fc90SDmitry Karpeev   and all of the arrays should be freed with PetscFree().
1855e7c4fc90SDmitry Karpeev 
1856e7c4fc90SDmitry Karpeev .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS()
1857e7c4fc90SDmitry Karpeev @*/
185816621825SDmitry Karpeev PetscErrorCode DMCreateFieldDecomposition(DM dm, PetscInt *len, char ***namelist, IS **islist, DM **dmlist)
1859e7c4fc90SDmitry Karpeev {
1860e7c4fc90SDmitry Karpeev   PetscErrorCode ierr;
1861e7c4fc90SDmitry Karpeev 
1862e7c4fc90SDmitry Karpeev   PetscFunctionBegin;
1863e7c4fc90SDmitry Karpeev   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
18648865f1eaSKarl Rupp   if (len) {
1865534a8f05SLisandro Dalcin     PetscValidIntPointer(len,2);
18668865f1eaSKarl Rupp     *len = 0;
18678865f1eaSKarl Rupp   }
18688865f1eaSKarl Rupp   if (namelist) {
18698865f1eaSKarl Rupp     PetscValidPointer(namelist,3);
1870ea78f98cSLisandro Dalcin     *namelist = NULL;
18718865f1eaSKarl Rupp   }
18728865f1eaSKarl Rupp   if (islist) {
18738865f1eaSKarl Rupp     PetscValidPointer(islist,4);
1874ea78f98cSLisandro Dalcin     *islist = NULL;
18758865f1eaSKarl Rupp   }
18768865f1eaSKarl Rupp   if (dmlist) {
18778865f1eaSKarl Rupp     PetscValidPointer(dmlist,5);
1878ea78f98cSLisandro Dalcin     *dmlist = NULL;
18798865f1eaSKarl Rupp   }
1880f3f0edfdSDmitry Karpeev   /*
1881f3f0edfdSDmitry Karpeev    Is it a good idea to apply the following check across all impls?
1882f3f0edfdSDmitry Karpeev    Perhaps some impls can have a well-defined decomposition before DMSetUp?
1883f3f0edfdSDmitry Karpeev    This, however, follows the general principle that accessors are not well-behaved until the object is set up.
1884f3f0edfdSDmitry Karpeev    */
1885ce94432eSBarry Smith   if (!dm->setupcalled) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_WRONGSTATE, "Decomposition defined only after DMSetUp");
188616621825SDmitry Karpeev   if (!dm->ops->createfielddecomposition) {
1887435a35e8SMatthew G Knepley     PetscSection section;
1888435a35e8SMatthew G Knepley     PetscInt     numFields, f;
1889435a35e8SMatthew G Knepley 
189092fd8e1eSJed Brown     ierr = DMGetLocalSection(dm, &section);CHKERRQ(ierr);
1891435a35e8SMatthew G Knepley     if (section) {ierr = PetscSectionGetNumFields(section, &numFields);CHKERRQ(ierr);}
1892435a35e8SMatthew G Knepley     if (section && numFields && dm->ops->createsubdm) {
1893f25d98f1SMatthew G. Knepley       if (len) *len = numFields;
189403dc3394SMatthew G. Knepley       if (namelist) {ierr = PetscMalloc1(numFields,namelist);CHKERRQ(ierr);}
189503dc3394SMatthew G. Knepley       if (islist)   {ierr = PetscMalloc1(numFields,islist);CHKERRQ(ierr);}
189603dc3394SMatthew G. Knepley       if (dmlist)   {ierr = PetscMalloc1(numFields,dmlist);CHKERRQ(ierr);}
1897435a35e8SMatthew G Knepley       for (f = 0; f < numFields; ++f) {
1898435a35e8SMatthew G Knepley         const char *fieldName;
1899435a35e8SMatthew G Knepley 
190003dc3394SMatthew G. Knepley         ierr = DMCreateSubDM(dm, 1, &f, islist ? &(*islist)[f] : NULL, dmlist ? &(*dmlist)[f] : NULL);CHKERRQ(ierr);
190103dc3394SMatthew G. Knepley         if (namelist) {
1902435a35e8SMatthew G Knepley           ierr = PetscSectionGetFieldName(section, f, &fieldName);CHKERRQ(ierr);
1903435a35e8SMatthew G Knepley           ierr = PetscStrallocpy(fieldName, (char**) &(*namelist)[f]);CHKERRQ(ierr);
1904435a35e8SMatthew G Knepley         }
190503dc3394SMatthew G. Knepley       }
1906435a35e8SMatthew G Knepley     } else {
190769ca1f37SDmitry Karpeev       ierr = DMCreateFieldIS(dm, len, namelist, islist);CHKERRQ(ierr);
1908e7c4fc90SDmitry Karpeev       /* By default there are no DMs associated with subproblems. */
19090298fd71SBarry Smith       if (dmlist) *dmlist = NULL;
1910e7c4fc90SDmitry Karpeev     }
19118865f1eaSKarl Rupp   } else {
191216621825SDmitry Karpeev     ierr = (*dm->ops->createfielddecomposition)(dm,len,namelist,islist,dmlist);CHKERRQ(ierr);
191316621825SDmitry Karpeev   }
191416621825SDmitry Karpeev   PetscFunctionReturn(0);
191516621825SDmitry Karpeev }
191616621825SDmitry Karpeev 
1917564cec59SMatthew G. Knepley /*@
1918435a35e8SMatthew G Knepley   DMCreateSubDM - Returns an IS and DM encapsulating a subproblem defined by the fields passed in.
1919435a35e8SMatthew G Knepley                   The fields are defined by DMCreateFieldIS().
1920435a35e8SMatthew G Knepley 
1921435a35e8SMatthew G Knepley   Not collective
1922435a35e8SMatthew G Knepley 
1923435a35e8SMatthew G Knepley   Input Parameters:
19242adcc780SMatthew G. Knepley + dm        - The DM object
19252adcc780SMatthew G. Knepley . numFields - The number of fields in this subproblem
19262adcc780SMatthew G. Knepley - fields    - The field numbers of the selected fields
1927435a35e8SMatthew G Knepley 
1928435a35e8SMatthew G Knepley   Output Parameters:
19292adcc780SMatthew G. Knepley + is - The global indices for the subproblem
19302adcc780SMatthew G. Knepley - subdm - The DM for the subproblem
1931435a35e8SMatthew G Knepley 
19325d3b26e6SMatthew G. Knepley   Note: You need to call DMPlexSetMigrationSF() on the original DM if you want the Global-To-Natural map to be automatically constructed
19335d3b26e6SMatthew G. Knepley 
1934435a35e8SMatthew G Knepley   Level: intermediate
1935435a35e8SMatthew G Knepley 
19365d3b26e6SMatthew G. Knepley .seealso DMPlexSetMigrationSF(), DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS()
1937435a35e8SMatthew G Knepley @*/
193837bc7515SMatthew G. Knepley PetscErrorCode DMCreateSubDM(DM dm, PetscInt numFields, const PetscInt fields[], IS *is, DM *subdm)
1939435a35e8SMatthew G Knepley {
1940435a35e8SMatthew G Knepley   PetscErrorCode ierr;
1941435a35e8SMatthew G Knepley 
1942435a35e8SMatthew G Knepley   PetscFunctionBegin;
1943435a35e8SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1944435a35e8SMatthew G Knepley   PetscValidPointer(fields,3);
19458865f1eaSKarl Rupp   if (is) PetscValidPointer(is,4);
19468865f1eaSKarl Rupp   if (subdm) PetscValidPointer(subdm,5);
1947b9d85ea2SLisandro Dalcin   if (!dm->ops->createsubdm) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateSubDM",((PetscObject)dm)->type_name);
1948435a35e8SMatthew G Knepley   ierr = (*dm->ops->createsubdm)(dm, numFields, fields, is, subdm);CHKERRQ(ierr);
1949435a35e8SMatthew G Knepley   PetscFunctionReturn(0);
1950435a35e8SMatthew G Knepley }
1951435a35e8SMatthew G Knepley 
19522adcc780SMatthew G. Knepley /*@C
19532adcc780SMatthew G. Knepley   DMCreateSuperDM - Returns an arrays of ISes and DM encapsulating a superproblem defined by the DMs passed in.
19542adcc780SMatthew G. Knepley 
19552adcc780SMatthew G. Knepley   Not collective
19562adcc780SMatthew G. Knepley 
1957d8d19677SJose E. Roman   Input Parameters:
19582adcc780SMatthew G. Knepley + dms - The DM objects
19592adcc780SMatthew G. Knepley - len - The number of DMs
19602adcc780SMatthew G. Knepley 
19612adcc780SMatthew G. Knepley   Output Parameters:
1962a42bd24dSMatthew G. Knepley + is - The global indices for the subproblem, or NULL
19632adcc780SMatthew G. Knepley - superdm - The DM for the superproblem
19642adcc780SMatthew G. Knepley 
19655d3b26e6SMatthew G. Knepley   Note: You need to call DMPlexSetMigrationSF() on the original DM if you want the Global-To-Natural map to be automatically constructed
19665d3b26e6SMatthew G. Knepley 
19672adcc780SMatthew G. Knepley   Level: intermediate
19682adcc780SMatthew G. Knepley 
19695d3b26e6SMatthew G. Knepley .seealso DMPlexSetMigrationSF(), DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS()
19702adcc780SMatthew G. Knepley @*/
19712adcc780SMatthew G. Knepley PetscErrorCode DMCreateSuperDM(DM dms[], PetscInt len, IS **is, DM *superdm)
19722adcc780SMatthew G. Knepley {
19732adcc780SMatthew G. Knepley   PetscInt       i;
19742adcc780SMatthew G. Knepley   PetscErrorCode ierr;
19752adcc780SMatthew G. Knepley 
19762adcc780SMatthew G. Knepley   PetscFunctionBegin;
19772adcc780SMatthew G. Knepley   PetscValidPointer(dms,1);
19782adcc780SMatthew G. Knepley   for (i = 0; i < len; ++i) {PetscValidHeaderSpecific(dms[i],DM_CLASSID,1);}
19792adcc780SMatthew G. Knepley   if (is) PetscValidPointer(is,3);
1980a42bd24dSMatthew G. Knepley   PetscValidPointer(superdm,4);
19812adcc780SMatthew G. Knepley   if (len < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Number of DMs must be nonnegative: %D", len);
19822adcc780SMatthew G. Knepley   if (len) {
1983b9d85ea2SLisandro Dalcin     DM dm = dms[0];
1984b9d85ea2SLisandro Dalcin     if (!dm->ops->createsuperdm) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateSuperDM",((PetscObject)dm)->type_name);
1985b9d85ea2SLisandro Dalcin     ierr = (*dm->ops->createsuperdm)(dms, len, is, superdm);CHKERRQ(ierr);
19862adcc780SMatthew G. Knepley   }
19872adcc780SMatthew G. Knepley   PetscFunctionReturn(0);
19882adcc780SMatthew G. Knepley }
19892adcc780SMatthew G. Knepley 
199016621825SDmitry Karpeev /*@C
19918d4ac253SDmitry Karpeev   DMCreateDomainDecomposition - Returns lists of IS objects defining a decomposition of a problem into subproblems
19928d4ac253SDmitry Karpeev                           corresponding to restrictions to pairs nested subdomains: each IS contains the global
19938d4ac253SDmitry Karpeev                           indices of the dofs of the corresponding subdomains.  The inner subdomains conceptually
19948d4ac253SDmitry Karpeev                           define a nonoverlapping covering, while outer subdomains can overlap.
19958d4ac253SDmitry Karpeev                           The optional list of DMs define the DM for each subproblem.
199616621825SDmitry Karpeev 
199716621825SDmitry Karpeev   Not collective
199816621825SDmitry Karpeev 
199916621825SDmitry Karpeev   Input Parameter:
200016621825SDmitry Karpeev . dm - the DM object
200116621825SDmitry Karpeev 
200216621825SDmitry Karpeev   Output Parameters:
20030298fd71SBarry Smith + len         - The number of subproblems in the domain decomposition (or NULL if not requested)
20040298fd71SBarry Smith . namelist    - The name for each subdomain (or NULL if not requested)
20050298fd71SBarry Smith . innerislist - The global indices for each inner subdomain (or NULL, if not requested)
20060298fd71SBarry Smith . outerislist - The global indices for each outer subdomain (or NULL, if not requested)
20070298fd71SBarry Smith - dmlist      - The DMs for each subdomain subproblem (or NULL, if not requested; if NULL is returned, no DMs are defined)
200816621825SDmitry Karpeev 
200916621825SDmitry Karpeev   Level: intermediate
201016621825SDmitry Karpeev 
201116621825SDmitry Karpeev   Notes:
201216621825SDmitry Karpeev   The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with
201316621825SDmitry Karpeev   PetscFree(), every entry of is should be destroyed with ISDestroy(), every entry of dm should be destroyed with DMDestroy(),
201416621825SDmitry Karpeev   and all of the arrays should be freed with PetscFree().
201516621825SDmitry Karpeev 
2016245d9833Sprj- .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldDecomposition()
201716621825SDmitry Karpeev @*/
20188d4ac253SDmitry Karpeev PetscErrorCode DMCreateDomainDecomposition(DM dm, PetscInt *len, char ***namelist, IS **innerislist, IS **outerislist, DM **dmlist)
201916621825SDmitry Karpeev {
202016621825SDmitry Karpeev   PetscErrorCode      ierr;
2021be081cd6SPeter Brune   DMSubDomainHookLink link;
2022be081cd6SPeter Brune   PetscInt            i,l;
202316621825SDmitry Karpeev 
202416621825SDmitry Karpeev   PetscFunctionBegin;
202516621825SDmitry Karpeev   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
202614a18fd3SPeter Brune   if (len)           {PetscValidPointer(len,2);            *len         = 0;}
20270298fd71SBarry Smith   if (namelist)      {PetscValidPointer(namelist,3);       *namelist    = NULL;}
20280298fd71SBarry Smith   if (innerislist)   {PetscValidPointer(innerislist,4);    *innerislist = NULL;}
20290298fd71SBarry Smith   if (outerislist)   {PetscValidPointer(outerislist,5);    *outerislist = NULL;}
20300298fd71SBarry Smith   if (dmlist)        {PetscValidPointer(dmlist,6);         *dmlist      = NULL;}
2031f3f0edfdSDmitry Karpeev   /*
2032f3f0edfdSDmitry Karpeev    Is it a good idea to apply the following check across all impls?
2033f3f0edfdSDmitry Karpeev    Perhaps some impls can have a well-defined decomposition before DMSetUp?
2034f3f0edfdSDmitry Karpeev    This, however, follows the general principle that accessors are not well-behaved until the object is set up.
2035f3f0edfdSDmitry Karpeev    */
2036ce94432eSBarry Smith   if (!dm->setupcalled) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_WRONGSTATE, "Decomposition defined only after DMSetUp");
203716621825SDmitry Karpeev   if (dm->ops->createdomaindecomposition) {
2038be081cd6SPeter Brune     ierr = (*dm->ops->createdomaindecomposition)(dm,&l,namelist,innerislist,outerislist,dmlist);CHKERRQ(ierr);
203914a18fd3SPeter Brune     /* copy subdomain hooks and context over to the subdomain DMs */
2040f891f5b9SPatrick Sanan     if (dmlist && *dmlist) {
2041be081cd6SPeter Brune       for (i = 0; i < l; i++) {
2042be081cd6SPeter Brune         for (link=dm->subdomainhook; link; link=link->next) {
2043be081cd6SPeter Brune           if (link->ddhook) {ierr = (*link->ddhook)(dm,(*dmlist)[i],link->ctx);CHKERRQ(ierr);}
2044be081cd6SPeter Brune         }
2045648262bbSPatrick Sanan         if (dm->ctx) (*dmlist)[i]->ctx = dm->ctx;
2046e7c4fc90SDmitry Karpeev       }
204714a18fd3SPeter Brune     }
204814a18fd3SPeter Brune     if (len) *len = l;
204914a18fd3SPeter Brune   }
2050e30e807fSPeter Brune   PetscFunctionReturn(0);
2051e30e807fSPeter Brune }
2052e30e807fSPeter Brune 
2053e30e807fSPeter Brune /*@C
2054e30e807fSPeter Brune   DMCreateDomainDecompositionScatters - Returns scatters to the subdomain vectors from the global vector
2055e30e807fSPeter Brune 
2056e30e807fSPeter Brune   Not collective
2057e30e807fSPeter Brune 
2058e30e807fSPeter Brune   Input Parameters:
2059e30e807fSPeter Brune + dm - the DM object
2060e30e807fSPeter Brune . n  - the number of subdomain scatters
2061e30e807fSPeter Brune - subdms - the local subdomains
2062e30e807fSPeter Brune 
2063e30e807fSPeter Brune   Output Parameters:
20646b867d5aSJose E. Roman + iscat - scatter from global vector to nonoverlapping global vector entries on subdomain
2065e30e807fSPeter Brune . oscat - scatter from global vector to overlapping global vector entries on subdomain
2066e30e807fSPeter Brune - gscat - scatter from global vector to local vector on subdomain (fills in ghosts)
2067e30e807fSPeter Brune 
206895452b02SPatrick Sanan   Notes:
206995452b02SPatrick Sanan     This is an alternative to the iis and ois arguments in DMCreateDomainDecomposition that allow for the solution
2070e30e807fSPeter Brune   of general nonlinear problems with overlapping subdomain methods.  While merely having index sets that enable subsets
2071e30e807fSPeter Brune   of the residual equations to be created is fine for linear problems, nonlinear problems require local assembly of
2072e30e807fSPeter Brune   solution and residual data.
2073e30e807fSPeter Brune 
2074e30e807fSPeter Brune   Level: developer
2075e30e807fSPeter Brune 
2076e30e807fSPeter Brune .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS()
2077e30e807fSPeter Brune @*/
2078e30e807fSPeter Brune PetscErrorCode DMCreateDomainDecompositionScatters(DM dm,PetscInt n,DM *subdms,VecScatter **iscat,VecScatter **oscat,VecScatter **gscat)
2079e30e807fSPeter Brune {
2080e30e807fSPeter Brune   PetscErrorCode ierr;
2081e30e807fSPeter Brune 
2082e30e807fSPeter Brune   PetscFunctionBegin;
2083e30e807fSPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2084e30e807fSPeter Brune   PetscValidPointer(subdms,3);
2085b9d85ea2SLisandro Dalcin   if (!dm->ops->createddscatters) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateDomainDecompositionScatters",((PetscObject)dm)->type_name);
2086e30e807fSPeter Brune   ierr = (*dm->ops->createddscatters)(dm,n,subdms,iscat,oscat,gscat);CHKERRQ(ierr);
2087e7c4fc90SDmitry Karpeev   PetscFunctionReturn(0);
2088e7c4fc90SDmitry Karpeev }
2089e7c4fc90SDmitry Karpeev 
209047c6ae99SBarry Smith /*@
209147c6ae99SBarry Smith   DMRefine - Refines a DM object
209247c6ae99SBarry Smith 
2093d083f849SBarry Smith   Collective on dm
209447c6ae99SBarry Smith 
2095d8d19677SJose E. Roman   Input Parameters:
209647c6ae99SBarry Smith + dm   - the DM object
209791d95f02SJed Brown - comm - the communicator to contain the new DM object (or MPI_COMM_NULL)
209847c6ae99SBarry Smith 
209947c6ae99SBarry Smith   Output Parameter:
21000298fd71SBarry Smith . dmf - the refined DM, or NULL
2101ae0a1c52SMatthew G Knepley 
2102f27dd7c6SMatthew G. Knepley   Options Database Keys:
2103412e9a14SMatthew G. Knepley . -dm_plex_cell_refiner <strategy> - chooses the refinement strategy, e.g. regular, tohex
2104412e9a14SMatthew G. Knepley 
21050298fd71SBarry Smith   Note: If no refinement was done, the return value is NULL
210647c6ae99SBarry Smith 
210747c6ae99SBarry Smith   Level: developer
210847c6ae99SBarry Smith 
2109e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
211047c6ae99SBarry Smith @*/
21117087cfbeSBarry Smith PetscErrorCode  DMRefine(DM dm,MPI_Comm comm,DM *dmf)
211247c6ae99SBarry Smith {
211347c6ae99SBarry Smith   PetscErrorCode   ierr;
2114c833c3b5SJed Brown   DMRefineHookLink link;
211547c6ae99SBarry Smith 
211647c6ae99SBarry Smith   PetscFunctionBegin;
2117732e2eb9SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2118b9d85ea2SLisandro Dalcin   if (!dm->ops->refine) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMRefine",((PetscObject)dm)->type_name);
21191ac00216SMatthew G. Knepley   ierr = PetscLogEventBegin(DM_Refine,dm,0,0,0);CHKERRQ(ierr);
212047c6ae99SBarry Smith   ierr = (*dm->ops->refine)(dm,comm,dmf);CHKERRQ(ierr);
21214057135bSMatthew G Knepley   if (*dmf) {
212243842a1eSJed Brown     (*dmf)->ops->creatematrix = dm->ops->creatematrix;
21238865f1eaSKarl Rupp 
21248cd211a4SJed Brown     ierr = PetscObjectCopyFortranFunctionPointers((PetscObject)dm,(PetscObject)*dmf);CHKERRQ(ierr);
21258865f1eaSKarl Rupp 
2126644e2e5bSBarry Smith     (*dmf)->ctx       = dm->ctx;
21270598a293SJed Brown     (*dmf)->leveldown = dm->leveldown;
2128656b349aSBarry Smith     (*dmf)->levelup   = dm->levelup + 1;
21298865f1eaSKarl Rupp 
2130e4b4b23bSJed Brown     ierr = DMSetMatType(*dmf,dm->mattype);CHKERRQ(ierr);
2131c833c3b5SJed Brown     for (link=dm->refinehook; link; link=link->next) {
21328865f1eaSKarl Rupp       if (link->refinehook) {
21338865f1eaSKarl Rupp         ierr = (*link->refinehook)(dm,*dmf,link->ctx);CHKERRQ(ierr);
21348865f1eaSKarl Rupp       }
2135c833c3b5SJed Brown     }
2136c833c3b5SJed Brown   }
21371ac00216SMatthew G. Knepley   ierr = PetscLogEventEnd(DM_Refine,dm,0,0,0);CHKERRQ(ierr);
2138c833c3b5SJed Brown   PetscFunctionReturn(0);
2139c833c3b5SJed Brown }
2140c833c3b5SJed Brown 
2141bb9467b5SJed Brown /*@C
2142c833c3b5SJed Brown    DMRefineHookAdd - adds a callback to be run when interpolating a nonlinear problem to a finer grid
2143c833c3b5SJed Brown 
2144c833c3b5SJed Brown    Logically Collective
2145c833c3b5SJed Brown 
21464165533cSJose E. Roman    Input Parameters:
2147c833c3b5SJed Brown +  coarse - nonlinear solver context on which to run a hook when restricting to a coarser level
2148c833c3b5SJed Brown .  refinehook - function to run when setting up a coarser level
2149c833c3b5SJed Brown .  interphook - function to run to update data on finer levels (once per SNESSolve())
21500298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
2151c833c3b5SJed Brown 
2152c833c3b5SJed Brown    Calling sequence of refinehook:
2153c833c3b5SJed Brown $    refinehook(DM coarse,DM fine,void *ctx);
2154c833c3b5SJed Brown 
2155c833c3b5SJed Brown +  coarse - coarse level DM
2156c833c3b5SJed Brown .  fine - fine level DM to interpolate problem to
2157c833c3b5SJed Brown -  ctx - optional user-defined function context
2158c833c3b5SJed Brown 
2159c833c3b5SJed Brown    Calling sequence for interphook:
2160c833c3b5SJed Brown $    interphook(DM coarse,Mat interp,DM fine,void *ctx)
2161c833c3b5SJed Brown 
2162c833c3b5SJed Brown +  coarse - coarse level DM
2163c833c3b5SJed Brown .  interp - matrix interpolating a coarse-level solution to the finer grid
2164c833c3b5SJed Brown .  fine - fine level DM to update
2165c833c3b5SJed Brown -  ctx - optional user-defined function context
2166c833c3b5SJed Brown 
2167c833c3b5SJed Brown    Level: advanced
2168c833c3b5SJed Brown 
2169c833c3b5SJed Brown    Notes:
2170c833c3b5SJed Brown    This function is only needed if auxiliary data needs to be passed to fine grids while grid sequencing
2171c833c3b5SJed Brown 
2172c833c3b5SJed Brown    If this function is called multiple times, the hooks will be run in the order they are added.
2173c833c3b5SJed Brown 
2174bb9467b5SJed Brown    This function is currently not available from Fortran.
2175bb9467b5SJed Brown 
2176c833c3b5SJed Brown .seealso: DMCoarsenHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
2177c833c3b5SJed Brown @*/
2178c833c3b5SJed Brown PetscErrorCode DMRefineHookAdd(DM coarse,PetscErrorCode (*refinehook)(DM,DM,void*),PetscErrorCode (*interphook)(DM,Mat,DM,void*),void *ctx)
2179c833c3b5SJed Brown {
2180c833c3b5SJed Brown   PetscErrorCode   ierr;
2181c833c3b5SJed Brown   DMRefineHookLink link,*p;
2182c833c3b5SJed Brown 
2183c833c3b5SJed Brown   PetscFunctionBegin;
2184c833c3b5SJed Brown   PetscValidHeaderSpecific(coarse,DM_CLASSID,1);
21853d8e3701SJed Brown   for (p=&coarse->refinehook; *p; p=&(*p)->next) { /* Scan to the end of the current list of hooks */
21863d8e3701SJed Brown     if ((*p)->refinehook == refinehook && (*p)->interphook == interphook && (*p)->ctx == ctx) PetscFunctionReturn(0);
21873d8e3701SJed Brown   }
218895dccacaSBarry Smith   ierr             = PetscNew(&link);CHKERRQ(ierr);
2189c833c3b5SJed Brown   link->refinehook = refinehook;
2190c833c3b5SJed Brown   link->interphook = interphook;
2191c833c3b5SJed Brown   link->ctx        = ctx;
21920298fd71SBarry Smith   link->next       = NULL;
2193c833c3b5SJed Brown   *p               = link;
2194c833c3b5SJed Brown   PetscFunctionReturn(0);
2195c833c3b5SJed Brown }
2196c833c3b5SJed Brown 
21973d8e3701SJed Brown /*@C
21983d8e3701SJed Brown    DMRefineHookRemove - remove a callback from the list of hooks to be run when interpolating a nonlinear problem to a finer grid
21993d8e3701SJed Brown 
22003d8e3701SJed Brown    Logically Collective
22013d8e3701SJed Brown 
22024165533cSJose E. Roman    Input Parameters:
22033d8e3701SJed Brown +  coarse - nonlinear solver context on which to run a hook when restricting to a coarser level
22043d8e3701SJed Brown .  refinehook - function to run when setting up a coarser level
22053d8e3701SJed Brown .  interphook - function to run to update data on finer levels (once per SNESSolve())
22063d8e3701SJed Brown -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
22073d8e3701SJed Brown 
22083d8e3701SJed Brown    Level: advanced
22093d8e3701SJed Brown 
22103d8e3701SJed Brown    Notes:
22113d8e3701SJed Brown    This function does nothing if the hook is not in the list.
22123d8e3701SJed Brown 
22133d8e3701SJed Brown    This function is currently not available from Fortran.
22143d8e3701SJed Brown 
22153d8e3701SJed Brown .seealso: DMCoarsenHookRemove(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
22163d8e3701SJed Brown @*/
22173d8e3701SJed Brown PetscErrorCode DMRefineHookRemove(DM coarse,PetscErrorCode (*refinehook)(DM,DM,void*),PetscErrorCode (*interphook)(DM,Mat,DM,void*),void *ctx)
22183d8e3701SJed Brown {
22193d8e3701SJed Brown   PetscErrorCode   ierr;
22203d8e3701SJed Brown   DMRefineHookLink link,*p;
22213d8e3701SJed Brown 
22223d8e3701SJed Brown   PetscFunctionBegin;
22233d8e3701SJed Brown   PetscValidHeaderSpecific(coarse,DM_CLASSID,1);
22243d8e3701SJed Brown   for (p=&coarse->refinehook; *p; p=&(*p)->next) { /* Search the list of current hooks */
22253d8e3701SJed Brown     if ((*p)->refinehook == refinehook && (*p)->interphook == interphook && (*p)->ctx == ctx) {
22263d8e3701SJed Brown       link = *p;
22273d8e3701SJed Brown       *p = link->next;
22283d8e3701SJed Brown       ierr = PetscFree(link);CHKERRQ(ierr);
22293d8e3701SJed Brown       break;
22303d8e3701SJed Brown     }
22313d8e3701SJed Brown   }
22323d8e3701SJed Brown   PetscFunctionReturn(0);
22333d8e3701SJed Brown }
22343d8e3701SJed Brown 
2235c833c3b5SJed Brown /*@
2236c833c3b5SJed Brown    DMInterpolate - interpolates user-defined problem data to a finer DM by running hooks registered by DMRefineHookAdd()
2237c833c3b5SJed Brown 
2238c833c3b5SJed Brown    Collective if any hooks are
2239c833c3b5SJed Brown 
22404165533cSJose E. Roman    Input Parameters:
2241c833c3b5SJed Brown +  coarse - coarser DM to use as a base
2242e91eccc2SStefano Zampini .  interp - interpolation matrix, apply using MatInterpolate()
2243c833c3b5SJed Brown -  fine - finer DM to update
2244c833c3b5SJed Brown 
2245c833c3b5SJed Brown    Level: developer
2246c833c3b5SJed Brown 
2247c833c3b5SJed Brown .seealso: DMRefineHookAdd(), MatInterpolate()
2248c833c3b5SJed Brown @*/
2249c833c3b5SJed Brown PetscErrorCode DMInterpolate(DM coarse,Mat interp,DM fine)
2250c833c3b5SJed Brown {
2251c833c3b5SJed Brown   PetscErrorCode   ierr;
2252c833c3b5SJed Brown   DMRefineHookLink link;
2253c833c3b5SJed Brown 
2254c833c3b5SJed Brown   PetscFunctionBegin;
2255c833c3b5SJed Brown   for (link=fine->refinehook; link; link=link->next) {
22568865f1eaSKarl Rupp     if (link->interphook) {
22578865f1eaSKarl Rupp       ierr = (*link->interphook)(coarse,interp,fine,link->ctx);CHKERRQ(ierr);
22588865f1eaSKarl Rupp     }
22594057135bSMatthew G Knepley   }
226047c6ae99SBarry Smith   PetscFunctionReturn(0);
226147c6ae99SBarry Smith }
226247c6ae99SBarry Smith 
2263eb3f98d2SBarry Smith /*@
22641f3379b2SToby Isaac    DMInterpolateSolution - Interpolates a solution from a coarse mesh to a fine mesh.
22651f3379b2SToby Isaac 
22661f3379b2SToby Isaac    Collective on DM
22671f3379b2SToby Isaac 
22684165533cSJose E. Roman    Input Parameters:
22691f3379b2SToby Isaac +  coarse - coarse DM
22701f3379b2SToby Isaac .  fine   - fine DM
22711f3379b2SToby Isaac .  interp - (optional) the matrix computed by DMCreateInterpolation().  Implementations may not need this, but if it
22721f3379b2SToby Isaac             is available it can avoid some recomputation.  If it is provided, MatInterpolate() will be used if
22731f3379b2SToby Isaac             the coarse DM does not have a specialized implementation.
22741f3379b2SToby Isaac -  coarseSol - solution on the coarse mesh
22751f3379b2SToby Isaac 
22764165533cSJose E. Roman    Output Parameter:
22771f3379b2SToby Isaac .  fineSol - the interpolation of coarseSol to the fine mesh
22781f3379b2SToby Isaac 
22791f3379b2SToby Isaac    Level: developer
22801f3379b2SToby Isaac 
22811f3379b2SToby Isaac    Note: This function exists because the interpolation of a solution vector between meshes is not always a linear
22821f3379b2SToby Isaac    map.  For example, if a boundary value problem has an inhomogeneous Dirichlet boundary condition that is compressed
22831f3379b2SToby Isaac    out of the solution vector.  Or if interpolation is inherently a nonlinear operation, such as a method using
22841f3379b2SToby Isaac    slope-limiting reconstruction.
22851f3379b2SToby Isaac 
22861f3379b2SToby Isaac .seealso DMInterpolate(), DMCreateInterpolation()
22871f3379b2SToby Isaac @*/
22881f3379b2SToby Isaac PetscErrorCode DMInterpolateSolution(DM coarse, DM fine, Mat interp, Vec coarseSol, Vec fineSol)
22891f3379b2SToby Isaac {
22901f3379b2SToby Isaac   PetscErrorCode (*interpsol)(DM,DM,Mat,Vec,Vec) = NULL;
22911f3379b2SToby Isaac   PetscErrorCode ierr;
22921f3379b2SToby Isaac 
22931f3379b2SToby Isaac   PetscFunctionBegin;
22941f3379b2SToby Isaac   PetscValidHeaderSpecific(coarse,DM_CLASSID,1);
22951f3379b2SToby Isaac   if (interp) PetscValidHeaderSpecific(interp,MAT_CLASSID,3);
22961f3379b2SToby Isaac   PetscValidHeaderSpecific(coarseSol,VEC_CLASSID,4);
22971f3379b2SToby Isaac   PetscValidHeaderSpecific(fineSol,VEC_CLASSID,5);
22981f3379b2SToby Isaac 
22991f3379b2SToby Isaac   ierr = PetscObjectQueryFunction((PetscObject)coarse,"DMInterpolateSolution_C", &interpsol);CHKERRQ(ierr);
23001f3379b2SToby Isaac   if (interpsol) {
23011f3379b2SToby Isaac     ierr = (*interpsol)(coarse, fine, interp, coarseSol, fineSol);CHKERRQ(ierr);
23021f3379b2SToby Isaac   } else if (interp) {
23031f3379b2SToby Isaac     ierr = MatInterpolate(interp, coarseSol, fineSol);CHKERRQ(ierr);
23041f3379b2SToby Isaac   } else SETERRQ1(PetscObjectComm((PetscObject)coarse), PETSC_ERR_SUP, "DM %s does not implement DMInterpolateSolution()", ((PetscObject)coarse)->type_name);
23051f3379b2SToby Isaac   PetscFunctionReturn(0);
23061f3379b2SToby Isaac }
23071f3379b2SToby Isaac 
23081f3379b2SToby Isaac /*@
2309aed49f88SRichard Tran Mills     DMGetRefineLevel - Gets the number of refinements that have generated this DM.
2310eb3f98d2SBarry Smith 
2311eb3f98d2SBarry Smith     Not Collective
2312eb3f98d2SBarry Smith 
2313eb3f98d2SBarry Smith     Input Parameter:
2314eb3f98d2SBarry Smith .   dm - the DM object
2315eb3f98d2SBarry Smith 
2316eb3f98d2SBarry Smith     Output Parameter:
2317eb3f98d2SBarry Smith .   level - number of refinements
2318eb3f98d2SBarry Smith 
2319eb3f98d2SBarry Smith     Level: developer
2320eb3f98d2SBarry Smith 
23216a7d9d85SPeter Brune .seealso DMCoarsen(), DMGetCoarsenLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
2322eb3f98d2SBarry Smith 
2323eb3f98d2SBarry Smith @*/
2324eb3f98d2SBarry Smith PetscErrorCode  DMGetRefineLevel(DM dm,PetscInt *level)
2325eb3f98d2SBarry Smith {
2326eb3f98d2SBarry Smith   PetscFunctionBegin;
2327eb3f98d2SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2328eb3f98d2SBarry Smith   *level = dm->levelup;
2329eb3f98d2SBarry Smith   PetscFunctionReturn(0);
2330eb3f98d2SBarry Smith }
2331eb3f98d2SBarry Smith 
2332fef3a512SBarry Smith /*@
2333aed49f88SRichard Tran Mills     DMSetRefineLevel - Sets the number of refinements that have generated this DM.
2334fef3a512SBarry Smith 
2335fef3a512SBarry Smith     Not Collective
2336fef3a512SBarry Smith 
2337d8d19677SJose E. Roman     Input Parameters:
2338fef3a512SBarry Smith +   dm - the DM object
2339fef3a512SBarry Smith -   level - number of refinements
2340fef3a512SBarry Smith 
2341fef3a512SBarry Smith     Level: advanced
2342fef3a512SBarry Smith 
234395452b02SPatrick Sanan     Notes:
234495452b02SPatrick Sanan     This value is used by PCMG to determine how many multigrid levels to use
2345fef3a512SBarry Smith 
2346fef3a512SBarry Smith .seealso DMCoarsen(), DMGetCoarsenLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
2347fef3a512SBarry Smith 
2348fef3a512SBarry Smith @*/
2349fef3a512SBarry Smith PetscErrorCode  DMSetRefineLevel(DM dm,PetscInt level)
2350fef3a512SBarry Smith {
2351fef3a512SBarry Smith   PetscFunctionBegin;
2352fef3a512SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2353fef3a512SBarry Smith   dm->levelup = level;
2354fef3a512SBarry Smith   PetscFunctionReturn(0);
2355fef3a512SBarry Smith }
2356fef3a512SBarry Smith 
2357ca3d3a14SMatthew G. Knepley PetscErrorCode DMGetBasisTransformDM_Internal(DM dm, DM *tdm)
2358ca3d3a14SMatthew G. Knepley {
2359ca3d3a14SMatthew G. Knepley   PetscFunctionBegin;
2360ca3d3a14SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2361ca3d3a14SMatthew G. Knepley   PetscValidPointer(tdm, 2);
2362ca3d3a14SMatthew G. Knepley   *tdm = dm->transformDM;
2363ca3d3a14SMatthew G. Knepley   PetscFunctionReturn(0);
2364ca3d3a14SMatthew G. Knepley }
2365ca3d3a14SMatthew G. Knepley 
2366ca3d3a14SMatthew G. Knepley PetscErrorCode DMGetBasisTransformVec_Internal(DM dm, Vec *tv)
2367ca3d3a14SMatthew G. Knepley {
2368ca3d3a14SMatthew G. Knepley   PetscFunctionBegin;
2369ca3d3a14SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2370ca3d3a14SMatthew G. Knepley   PetscValidPointer(tv, 2);
2371ca3d3a14SMatthew G. Knepley   *tv = dm->transform;
2372ca3d3a14SMatthew G. Knepley   PetscFunctionReturn(0);
2373ca3d3a14SMatthew G. Knepley }
2374ca3d3a14SMatthew G. Knepley 
2375ca3d3a14SMatthew G. Knepley /*@
2376c0f8e1fdSMatthew G. Knepley   DMHasBasisTransform - Whether we employ a basis transformation from functions in global vectors to functions in local vectors
2377ca3d3a14SMatthew G. Knepley 
2378ca3d3a14SMatthew G. Knepley   Input Parameter:
2379ca3d3a14SMatthew G. Knepley . dm - The DM
2380ca3d3a14SMatthew G. Knepley 
2381ca3d3a14SMatthew G. Knepley   Output Parameter:
2382ca3d3a14SMatthew G. Knepley . flg - PETSC_TRUE if a basis transformation should be done
2383ca3d3a14SMatthew G. Knepley 
2384ca3d3a14SMatthew G. Knepley   Level: developer
2385ca3d3a14SMatthew G. Knepley 
2386436bc73aSJed Brown .seealso: DMPlexGlobalToLocalBasis(), DMPlexLocalToGlobalBasis(), DMPlexCreateBasisRotation()
2387ca3d3a14SMatthew G. Knepley @*/
2388ca3d3a14SMatthew G. Knepley PetscErrorCode DMHasBasisTransform(DM dm, PetscBool *flg)
2389ca3d3a14SMatthew G. Knepley {
2390ca3d3a14SMatthew G. Knepley   Vec            tv;
2391ca3d3a14SMatthew G. Knepley   PetscErrorCode ierr;
2392ca3d3a14SMatthew G. Knepley 
2393ca3d3a14SMatthew G. Knepley   PetscFunctionBegin;
2394ca3d3a14SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2395534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg, 2);
2396ca3d3a14SMatthew G. Knepley   ierr = DMGetBasisTransformVec_Internal(dm, &tv);CHKERRQ(ierr);
2397ca3d3a14SMatthew G. Knepley   *flg = tv ? PETSC_TRUE : PETSC_FALSE;
2398ca3d3a14SMatthew G. Knepley   PetscFunctionReturn(0);
2399ca3d3a14SMatthew G. Knepley }
2400ca3d3a14SMatthew G. Knepley 
2401ca3d3a14SMatthew G. Knepley PetscErrorCode DMConstructBasisTransform_Internal(DM dm)
2402ca3d3a14SMatthew G. Knepley {
2403ca3d3a14SMatthew G. Knepley   PetscSection   s, ts;
2404ca3d3a14SMatthew G. Knepley   PetscScalar   *ta;
2405ca3d3a14SMatthew G. Knepley   PetscInt       cdim, pStart, pEnd, p, Nf, f, Nc, dof;
2406ca3d3a14SMatthew G. Knepley   PetscErrorCode ierr;
2407ca3d3a14SMatthew G. Knepley 
2408ca3d3a14SMatthew G. Knepley   PetscFunctionBegin;
2409ca3d3a14SMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
241092fd8e1eSJed Brown   ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr);
2411ca3d3a14SMatthew G. Knepley   ierr = PetscSectionGetChart(s, &pStart, &pEnd);CHKERRQ(ierr);
2412ca3d3a14SMatthew G. Knepley   ierr = PetscSectionGetNumFields(s, &Nf);CHKERRQ(ierr);
2413ca3d3a14SMatthew G. Knepley   ierr = DMClone(dm, &dm->transformDM);CHKERRQ(ierr);
241492fd8e1eSJed Brown   ierr = DMGetLocalSection(dm->transformDM, &ts);CHKERRQ(ierr);
2415ca3d3a14SMatthew G. Knepley   ierr = PetscSectionSetNumFields(ts, Nf);CHKERRQ(ierr);
2416ca3d3a14SMatthew G. Knepley   ierr = PetscSectionSetChart(ts, pStart, pEnd);CHKERRQ(ierr);
2417ca3d3a14SMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
2418ca3d3a14SMatthew G. Knepley     ierr = PetscSectionGetFieldComponents(s, f, &Nc);CHKERRQ(ierr);
2419ca3d3a14SMatthew G. Knepley     /* We could start to label fields by their transformation properties */
2420ca3d3a14SMatthew G. Knepley     if (Nc != cdim) continue;
2421ca3d3a14SMatthew G. Knepley     for (p = pStart; p < pEnd; ++p) {
2422ca3d3a14SMatthew G. Knepley       ierr = PetscSectionGetFieldDof(s, p, f, &dof);CHKERRQ(ierr);
2423ca3d3a14SMatthew G. Knepley       if (!dof) continue;
2424ca3d3a14SMatthew G. Knepley       ierr = PetscSectionSetFieldDof(ts, p, f, PetscSqr(cdim));CHKERRQ(ierr);
2425ca3d3a14SMatthew G. Knepley       ierr = PetscSectionAddDof(ts, p, PetscSqr(cdim));CHKERRQ(ierr);
2426ca3d3a14SMatthew G. Knepley     }
2427ca3d3a14SMatthew G. Knepley   }
2428ca3d3a14SMatthew G. Knepley   ierr = PetscSectionSetUp(ts);CHKERRQ(ierr);
2429ca3d3a14SMatthew G. Knepley   ierr = DMCreateLocalVector(dm->transformDM, &dm->transform);CHKERRQ(ierr);
2430ca3d3a14SMatthew G. Knepley   ierr = VecGetArray(dm->transform, &ta);CHKERRQ(ierr);
2431ca3d3a14SMatthew G. Knepley   for (p = pStart; p < pEnd; ++p) {
2432ca3d3a14SMatthew G. Knepley     for (f = 0; f < Nf; ++f) {
2433ca3d3a14SMatthew G. Knepley       ierr = PetscSectionGetFieldDof(ts, p, f, &dof);CHKERRQ(ierr);
2434ca3d3a14SMatthew G. Knepley       if (dof) {
2435ca3d3a14SMatthew G. Knepley         PetscReal          x[3] = {0.0, 0.0, 0.0};
2436ca3d3a14SMatthew G. Knepley         PetscScalar       *tva;
2437ca3d3a14SMatthew G. Knepley         const PetscScalar *A;
2438ca3d3a14SMatthew G. Knepley 
2439ca3d3a14SMatthew G. Knepley         /* TODO Get quadrature point for this dual basis vector for coordinate */
2440ca3d3a14SMatthew G. Knepley         ierr = (*dm->transformGetMatrix)(dm, x, PETSC_TRUE, &A, dm->transformCtx);CHKERRQ(ierr);
2441ca3d3a14SMatthew G. Knepley         ierr = DMPlexPointLocalFieldRef(dm->transformDM, p, f, ta, (void *) &tva);CHKERRQ(ierr);
2442580bdb30SBarry Smith         ierr = PetscArraycpy(tva, A, PetscSqr(cdim));CHKERRQ(ierr);
2443ca3d3a14SMatthew G. Knepley       }
2444ca3d3a14SMatthew G. Knepley     }
2445ca3d3a14SMatthew G. Knepley   }
2446ca3d3a14SMatthew G. Knepley   ierr = VecRestoreArray(dm->transform, &ta);CHKERRQ(ierr);
2447ca3d3a14SMatthew G. Knepley   PetscFunctionReturn(0);
2448ca3d3a14SMatthew G. Knepley }
2449ca3d3a14SMatthew G. Knepley 
2450ca3d3a14SMatthew G. Knepley PetscErrorCode DMCopyTransform(DM dm, DM newdm)
2451ca3d3a14SMatthew G. Knepley {
2452ca3d3a14SMatthew G. Knepley   PetscErrorCode ierr;
2453ca3d3a14SMatthew G. Knepley 
2454ca3d3a14SMatthew G. Knepley   PetscFunctionBegin;
2455ca3d3a14SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2456ca3d3a14SMatthew G. Knepley   PetscValidHeaderSpecific(newdm, DM_CLASSID, 2);
2457ca3d3a14SMatthew G. Knepley   newdm->transformCtx       = dm->transformCtx;
2458ca3d3a14SMatthew G. Knepley   newdm->transformSetUp     = dm->transformSetUp;
2459ca3d3a14SMatthew G. Knepley   newdm->transformDestroy   = NULL;
2460ca3d3a14SMatthew G. Knepley   newdm->transformGetMatrix = dm->transformGetMatrix;
2461ca3d3a14SMatthew G. Knepley   if (newdm->transformSetUp) {ierr = DMConstructBasisTransform_Internal(newdm);CHKERRQ(ierr);}
2462ca3d3a14SMatthew G. Knepley   PetscFunctionReturn(0);
2463ca3d3a14SMatthew G. Knepley }
2464ca3d3a14SMatthew G. Knepley 
2465bb9467b5SJed Brown /*@C
2466baf369e7SPeter Brune    DMGlobalToLocalHookAdd - adds a callback to be run when global to local is called
2467baf369e7SPeter Brune 
2468baf369e7SPeter Brune    Logically Collective
2469baf369e7SPeter Brune 
24704165533cSJose E. Roman    Input Parameters:
2471baf369e7SPeter Brune +  dm - the DM
2472baf369e7SPeter Brune .  beginhook - function to run at the beginning of DMGlobalToLocalBegin()
2473baf369e7SPeter Brune .  endhook - function to run after DMGlobalToLocalEnd() has completed
24740298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
2475baf369e7SPeter Brune 
2476baf369e7SPeter Brune    Calling sequence for beginhook:
2477baf369e7SPeter Brune $    beginhook(DM fine,VecScatter out,VecScatter in,DM coarse,void *ctx)
2478baf369e7SPeter Brune 
2479baf369e7SPeter Brune +  dm - global DM
2480baf369e7SPeter Brune .  g - global vector
2481baf369e7SPeter Brune .  mode - mode
2482baf369e7SPeter Brune .  l - local vector
2483baf369e7SPeter Brune -  ctx - optional user-defined function context
2484baf369e7SPeter Brune 
2485baf369e7SPeter Brune    Calling sequence for endhook:
2486ec4806b8SPeter Brune $    endhook(DM fine,VecScatter out,VecScatter in,DM coarse,void *ctx)
2487baf369e7SPeter Brune 
2488baf369e7SPeter Brune +  global - global DM
2489baf369e7SPeter Brune -  ctx - optional user-defined function context
2490baf369e7SPeter Brune 
2491baf369e7SPeter Brune    Level: advanced
2492baf369e7SPeter Brune 
2493baf369e7SPeter Brune .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
2494baf369e7SPeter Brune @*/
2495baf369e7SPeter Brune PetscErrorCode DMGlobalToLocalHookAdd(DM dm,PetscErrorCode (*beginhook)(DM,Vec,InsertMode,Vec,void*),PetscErrorCode (*endhook)(DM,Vec,InsertMode,Vec,void*),void *ctx)
2496baf369e7SPeter Brune {
2497baf369e7SPeter Brune   PetscErrorCode          ierr;
2498baf369e7SPeter Brune   DMGlobalToLocalHookLink link,*p;
2499baf369e7SPeter Brune 
2500baf369e7SPeter Brune   PetscFunctionBegin;
2501baf369e7SPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2502baf369e7SPeter Brune   for (p=&dm->gtolhook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */
250395dccacaSBarry Smith   ierr            = PetscNew(&link);CHKERRQ(ierr);
2504baf369e7SPeter Brune   link->beginhook = beginhook;
2505baf369e7SPeter Brune   link->endhook   = endhook;
2506baf369e7SPeter Brune   link->ctx       = ctx;
25070298fd71SBarry Smith   link->next      = NULL;
2508baf369e7SPeter Brune   *p              = link;
2509baf369e7SPeter Brune   PetscFunctionReturn(0);
2510baf369e7SPeter Brune }
2511baf369e7SPeter Brune 
25124c274da1SToby Isaac static PetscErrorCode DMGlobalToLocalHook_Constraints(DM dm, Vec g, InsertMode mode, Vec l, void *ctx)
25134c274da1SToby Isaac {
25144c274da1SToby Isaac   Mat cMat;
25154c274da1SToby Isaac   Vec cVec;
25164c274da1SToby Isaac   PetscSection section, cSec;
25174c274da1SToby Isaac   PetscInt pStart, pEnd, p, dof;
25184c274da1SToby Isaac   PetscErrorCode ierr;
25194c274da1SToby Isaac 
25204c274da1SToby Isaac   PetscFunctionBegin;
25214c274da1SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
25224c274da1SToby Isaac   ierr = DMGetDefaultConstraints(dm,&cSec,&cMat);CHKERRQ(ierr);
25234c274da1SToby Isaac   if (cMat && (mode == INSERT_VALUES || mode == INSERT_ALL_VALUES || mode == INSERT_BC_VALUES)) {
25245db9a05bSToby Isaac     PetscInt nRows;
25255db9a05bSToby Isaac 
25265db9a05bSToby Isaac     ierr = MatGetSize(cMat,&nRows,NULL);CHKERRQ(ierr);
25275db9a05bSToby Isaac     if (nRows <= 0) PetscFunctionReturn(0);
252892fd8e1eSJed Brown     ierr = DMGetLocalSection(dm,&section);CHKERRQ(ierr);
25297711e48fSToby Isaac     ierr = MatCreateVecs(cMat,NULL,&cVec);CHKERRQ(ierr);
25304c274da1SToby Isaac     ierr = MatMult(cMat,l,cVec);CHKERRQ(ierr);
25314c274da1SToby Isaac     ierr = PetscSectionGetChart(cSec,&pStart,&pEnd);CHKERRQ(ierr);
25324c274da1SToby Isaac     for (p = pStart; p < pEnd; p++) {
25334c274da1SToby Isaac       ierr = PetscSectionGetDof(cSec,p,&dof);CHKERRQ(ierr);
25344c274da1SToby Isaac       if (dof) {
25354c274da1SToby Isaac         PetscScalar *vals;
25364c274da1SToby Isaac         ierr = VecGetValuesSection(cVec,cSec,p,&vals);CHKERRQ(ierr);
25374c274da1SToby Isaac         ierr = VecSetValuesSection(l,section,p,vals,INSERT_ALL_VALUES);CHKERRQ(ierr);
25384c274da1SToby Isaac       }
25394c274da1SToby Isaac     }
25404c274da1SToby Isaac     ierr = VecDestroy(&cVec);CHKERRQ(ierr);
25414c274da1SToby Isaac   }
25424c274da1SToby Isaac   PetscFunctionReturn(0);
25434c274da1SToby Isaac }
25444c274da1SToby Isaac 
254547c6ae99SBarry Smith /*@
254601729b5cSPatrick Sanan     DMGlobalToLocal - update local vectors from global vector
254701729b5cSPatrick Sanan 
2548d083f849SBarry Smith     Neighbor-wise Collective on dm
254901729b5cSPatrick Sanan 
255001729b5cSPatrick Sanan     Input Parameters:
255101729b5cSPatrick Sanan +   dm - the DM object
255201729b5cSPatrick Sanan .   g - the global vector
255301729b5cSPatrick Sanan .   mode - INSERT_VALUES or ADD_VALUES
255401729b5cSPatrick Sanan -   l - the local vector
255501729b5cSPatrick Sanan 
255601729b5cSPatrick Sanan     Notes:
255701729b5cSPatrick Sanan     The communication involved in this update can be overlapped with computation by using
255801729b5cSPatrick Sanan     DMGlobalToLocalBegin() and DMGlobalToLocalEnd().
255901729b5cSPatrick Sanan 
256001729b5cSPatrick Sanan     Level: beginner
256101729b5cSPatrick Sanan 
256201729b5cSPatrick Sanan .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin(), DMLocalToGlobal(), DMLocalToGlobalBegin(), DMLocalToGlobalEnd()
256301729b5cSPatrick Sanan 
256401729b5cSPatrick Sanan @*/
256501729b5cSPatrick Sanan PetscErrorCode DMGlobalToLocal(DM dm,Vec g,InsertMode mode,Vec l)
256601729b5cSPatrick Sanan {
256701729b5cSPatrick Sanan   PetscErrorCode ierr;
256801729b5cSPatrick Sanan 
256901729b5cSPatrick Sanan   PetscFunctionBegin;
257001729b5cSPatrick Sanan   ierr = DMGlobalToLocalBegin(dm,g,mode,l);CHKERRQ(ierr);
257101729b5cSPatrick Sanan   ierr = DMGlobalToLocalEnd(dm,g,mode,l);CHKERRQ(ierr);
257201729b5cSPatrick Sanan   PetscFunctionReturn(0);
257301729b5cSPatrick Sanan }
257401729b5cSPatrick Sanan 
257501729b5cSPatrick Sanan /*@
257647c6ae99SBarry Smith     DMGlobalToLocalBegin - Begins updating local vectors from global vector
257747c6ae99SBarry Smith 
2578d083f849SBarry Smith     Neighbor-wise Collective on dm
257947c6ae99SBarry Smith 
258047c6ae99SBarry Smith     Input Parameters:
258147c6ae99SBarry Smith +   dm - the DM object
258247c6ae99SBarry Smith .   g - the global vector
258347c6ae99SBarry Smith .   mode - INSERT_VALUES or ADD_VALUES
258447c6ae99SBarry Smith -   l - the local vector
258547c6ae99SBarry Smith 
258601729b5cSPatrick Sanan     Level: intermediate
258747c6ae99SBarry Smith 
258801729b5cSPatrick Sanan .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin(), DMLocalToGlobal(), DMLocalToGlobalBegin(), DMLocalToGlobalEnd()
258947c6ae99SBarry Smith 
259047c6ae99SBarry Smith @*/
25917087cfbeSBarry Smith PetscErrorCode  DMGlobalToLocalBegin(DM dm,Vec g,InsertMode mode,Vec l)
259247c6ae99SBarry Smith {
25937128ae9fSMatthew G Knepley   PetscSF                 sf;
259447c6ae99SBarry Smith   PetscErrorCode          ierr;
2595baf369e7SPeter Brune   DMGlobalToLocalHookLink link;
259647c6ae99SBarry Smith 
259747c6ae99SBarry Smith   PetscFunctionBegin;
2598171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2599baf369e7SPeter Brune   for (link=dm->gtolhook; link; link=link->next) {
26008865f1eaSKarl Rupp     if (link->beginhook) {
26018865f1eaSKarl Rupp       ierr = (*link->beginhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);
26028865f1eaSKarl Rupp     }
2603baf369e7SPeter Brune   }
26041bb6d2a8SBarry Smith   ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr);
26057128ae9fSMatthew G Knepley   if (sf) {
2606ae5cfb4aSMatthew G. Knepley     const PetscScalar *gArray;
2607ae5cfb4aSMatthew G. Knepley     PetscScalar       *lArray;
2608d0295fc0SJunchao Zhang     PetscMemType      lmtype,gmtype;
26097128ae9fSMatthew G Knepley 
261082f516ccSBarry Smith     if (mode == ADD_VALUES) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
2611a256111fSJunchao Zhang     ierr = VecGetArrayAndMemType(l, &lArray, &lmtype);CHKERRQ(ierr);
2612a256111fSJunchao Zhang     ierr = VecGetArrayReadAndMemType(g, &gArray, &gmtype);CHKERRQ(ierr);
2613ad227feaSJunchao Zhang     ierr = PetscSFBcastWithMemTypeBegin(sf, MPIU_SCALAR, gmtype, gArray, lmtype, lArray, MPI_REPLACE);CHKERRQ(ierr);
2614a256111fSJunchao Zhang     ierr = VecRestoreArrayAndMemType(l, &lArray);CHKERRQ(ierr);
2615a256111fSJunchao Zhang     ierr = VecRestoreArrayReadAndMemType(g, &gArray);CHKERRQ(ierr);
26167128ae9fSMatthew G Knepley   } else {
261733907cc2SStefano Zampini     if (!dm->ops->globaltolocalbegin) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMGlobalToLocalBegin() for type %s",((PetscObject)dm)->type_name);
2618843c4018SMatthew G Knepley     ierr = (*dm->ops->globaltolocalbegin)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
26197128ae9fSMatthew G Knepley   }
262047c6ae99SBarry Smith   PetscFunctionReturn(0);
262147c6ae99SBarry Smith }
262247c6ae99SBarry Smith 
262347c6ae99SBarry Smith /*@
262447c6ae99SBarry Smith     DMGlobalToLocalEnd - Ends updating local vectors from global vector
262547c6ae99SBarry Smith 
2626d083f849SBarry Smith     Neighbor-wise Collective on dm
262747c6ae99SBarry Smith 
262847c6ae99SBarry Smith     Input Parameters:
262947c6ae99SBarry Smith +   dm - the DM object
263047c6ae99SBarry Smith .   g - the global vector
263147c6ae99SBarry Smith .   mode - INSERT_VALUES or ADD_VALUES
263247c6ae99SBarry Smith -   l - the local vector
263347c6ae99SBarry Smith 
263401729b5cSPatrick Sanan     Level: intermediate
263547c6ae99SBarry Smith 
263601729b5cSPatrick Sanan .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMLocalToGlobalBegin(), DMLocalToGlobal(), DMLocalToGlobalBegin(), DMLocalToGlobalEnd()
263747c6ae99SBarry Smith 
263847c6ae99SBarry Smith @*/
26397087cfbeSBarry Smith PetscErrorCode  DMGlobalToLocalEnd(DM dm,Vec g,InsertMode mode,Vec l)
264047c6ae99SBarry Smith {
26417128ae9fSMatthew G Knepley   PetscSF                 sf;
264247c6ae99SBarry Smith   PetscErrorCode          ierr;
2643ae5cfb4aSMatthew G. Knepley   const PetscScalar      *gArray;
2644ae5cfb4aSMatthew G. Knepley   PetscScalar            *lArray;
2645ca3d3a14SMatthew G. Knepley   PetscBool               transform;
2646baf369e7SPeter Brune   DMGlobalToLocalHookLink link;
2647d0295fc0SJunchao Zhang   PetscMemType            lmtype,gmtype;
264847c6ae99SBarry Smith 
264947c6ae99SBarry Smith   PetscFunctionBegin;
2650171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
26511bb6d2a8SBarry Smith   ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr);
2652ca3d3a14SMatthew G. Knepley   ierr = DMHasBasisTransform(dm, &transform);CHKERRQ(ierr);
26537128ae9fSMatthew G Knepley   if (sf) {
265482f516ccSBarry Smith     if (mode == ADD_VALUES) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
26557128ae9fSMatthew G Knepley 
2656a256111fSJunchao Zhang     ierr = VecGetArrayAndMemType(l, &lArray, &lmtype);CHKERRQ(ierr);
2657a256111fSJunchao Zhang     ierr = VecGetArrayReadAndMemType(g, &gArray, &gmtype);CHKERRQ(ierr);
2658ad227feaSJunchao Zhang     ierr = PetscSFBcastEnd(sf, MPIU_SCALAR, gArray, lArray,MPI_REPLACE);CHKERRQ(ierr);
2659a256111fSJunchao Zhang     ierr = VecRestoreArrayAndMemType(l, &lArray);CHKERRQ(ierr);
2660a256111fSJunchao Zhang     ierr = VecRestoreArrayReadAndMemType(g, &gArray);CHKERRQ(ierr);
2661ca3d3a14SMatthew G. Knepley     if (transform) {ierr = DMPlexGlobalToLocalBasis(dm, l);CHKERRQ(ierr);}
26627128ae9fSMatthew G Knepley   } else {
266333907cc2SStefano Zampini     if (!dm->ops->globaltolocalend) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMGlobalToLocalEnd() for type %s",((PetscObject)dm)->type_name);
2664843c4018SMatthew G Knepley     ierr = (*dm->ops->globaltolocalend)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
26657128ae9fSMatthew G Knepley   }
26664c274da1SToby Isaac   ierr = DMGlobalToLocalHook_Constraints(dm,g,mode,l,NULL);CHKERRQ(ierr);
2667baf369e7SPeter Brune   for (link=dm->gtolhook; link; link=link->next) {
2668baf369e7SPeter Brune     if (link->endhook) {ierr = (*link->endhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);}
2669baf369e7SPeter Brune   }
267047c6ae99SBarry Smith   PetscFunctionReturn(0);
267147c6ae99SBarry Smith }
267247c6ae99SBarry Smith 
2673d4d07f1eSToby Isaac /*@C
2674d4d07f1eSToby Isaac    DMLocalToGlobalHookAdd - adds a callback to be run when a local to global is called
2675d4d07f1eSToby Isaac 
2676d4d07f1eSToby Isaac    Logically Collective
2677d4d07f1eSToby Isaac 
26784165533cSJose E. Roman    Input Parameters:
2679d4d07f1eSToby Isaac +  dm - the DM
2680d4d07f1eSToby Isaac .  beginhook - function to run at the beginning of DMLocalToGlobalBegin()
2681d4d07f1eSToby Isaac .  endhook - function to run after DMLocalToGlobalEnd() has completed
2682d4d07f1eSToby Isaac -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
2683d4d07f1eSToby Isaac 
2684d4d07f1eSToby Isaac    Calling sequence for beginhook:
2685d4d07f1eSToby Isaac $    beginhook(DM fine,Vec l,InsertMode mode,Vec g,void *ctx)
2686d4d07f1eSToby Isaac 
2687d4d07f1eSToby Isaac +  dm - global DM
2688d4d07f1eSToby Isaac .  l - local vector
2689d4d07f1eSToby Isaac .  mode - mode
2690d4d07f1eSToby Isaac .  g - global vector
2691d4d07f1eSToby Isaac -  ctx - optional user-defined function context
2692d4d07f1eSToby Isaac 
2693d4d07f1eSToby Isaac    Calling sequence for endhook:
2694d4d07f1eSToby Isaac $    endhook(DM fine,Vec l,InsertMode mode,Vec g,void *ctx)
2695d4d07f1eSToby Isaac 
2696d4d07f1eSToby Isaac +  global - global DM
2697d4d07f1eSToby Isaac .  l - local vector
2698d4d07f1eSToby Isaac .  mode - mode
2699d4d07f1eSToby Isaac .  g - global vector
2700d4d07f1eSToby Isaac -  ctx - optional user-defined function context
2701d4d07f1eSToby Isaac 
2702d4d07f1eSToby Isaac    Level: advanced
2703d4d07f1eSToby Isaac 
2704d4d07f1eSToby Isaac .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
2705d4d07f1eSToby Isaac @*/
2706d4d07f1eSToby Isaac PetscErrorCode DMLocalToGlobalHookAdd(DM dm,PetscErrorCode (*beginhook)(DM,Vec,InsertMode,Vec,void*),PetscErrorCode (*endhook)(DM,Vec,InsertMode,Vec,void*),void *ctx)
2707d4d07f1eSToby Isaac {
2708d4d07f1eSToby Isaac   PetscErrorCode          ierr;
2709d4d07f1eSToby Isaac   DMLocalToGlobalHookLink link,*p;
2710d4d07f1eSToby Isaac 
2711d4d07f1eSToby Isaac   PetscFunctionBegin;
2712d4d07f1eSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2713d4d07f1eSToby Isaac   for (p=&dm->ltoghook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */
271495dccacaSBarry Smith   ierr            = PetscNew(&link);CHKERRQ(ierr);
2715d4d07f1eSToby Isaac   link->beginhook = beginhook;
2716d4d07f1eSToby Isaac   link->endhook   = endhook;
2717d4d07f1eSToby Isaac   link->ctx       = ctx;
2718d4d07f1eSToby Isaac   link->next      = NULL;
2719d4d07f1eSToby Isaac   *p              = link;
2720d4d07f1eSToby Isaac   PetscFunctionReturn(0);
2721d4d07f1eSToby Isaac }
2722d4d07f1eSToby Isaac 
27234c274da1SToby Isaac static PetscErrorCode DMLocalToGlobalHook_Constraints(DM dm, Vec l, InsertMode mode, Vec g, void *ctx)
27244c274da1SToby Isaac {
27254c274da1SToby Isaac   Mat cMat;
27264c274da1SToby Isaac   Vec cVec;
27274c274da1SToby Isaac   PetscSection section, cSec;
27284c274da1SToby Isaac   PetscInt pStart, pEnd, p, dof;
27294c274da1SToby Isaac   PetscErrorCode ierr;
27304c274da1SToby Isaac 
27314c274da1SToby Isaac   PetscFunctionBegin;
27324c274da1SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
27334c274da1SToby Isaac   ierr = DMGetDefaultConstraints(dm,&cSec,&cMat);CHKERRQ(ierr);
27344c274da1SToby Isaac   if (cMat && (mode == ADD_VALUES || mode == ADD_ALL_VALUES || mode == ADD_BC_VALUES)) {
27355db9a05bSToby Isaac     PetscInt nRows;
27365db9a05bSToby Isaac 
27375db9a05bSToby Isaac     ierr = MatGetSize(cMat,&nRows,NULL);CHKERRQ(ierr);
27385db9a05bSToby Isaac     if (nRows <= 0) PetscFunctionReturn(0);
273992fd8e1eSJed Brown     ierr = DMGetLocalSection(dm,&section);CHKERRQ(ierr);
27407711e48fSToby Isaac     ierr = MatCreateVecs(cMat,NULL,&cVec);CHKERRQ(ierr);
27414c274da1SToby Isaac     ierr = PetscSectionGetChart(cSec,&pStart,&pEnd);CHKERRQ(ierr);
27424c274da1SToby Isaac     for (p = pStart; p < pEnd; p++) {
27434c274da1SToby Isaac       ierr = PetscSectionGetDof(cSec,p,&dof);CHKERRQ(ierr);
27444c274da1SToby Isaac       if (dof) {
27454c274da1SToby Isaac         PetscInt d;
27464c274da1SToby Isaac         PetscScalar *vals;
27474c274da1SToby Isaac         ierr = VecGetValuesSection(l,section,p,&vals);CHKERRQ(ierr);
27484c274da1SToby Isaac         ierr = VecSetValuesSection(cVec,cSec,p,vals,mode);CHKERRQ(ierr);
27494c274da1SToby Isaac         /* for this to be the true transpose, we have to zero the values that
27504c274da1SToby Isaac          * we just extracted */
27514c274da1SToby Isaac         for (d = 0; d < dof; d++) {
27524c274da1SToby Isaac           vals[d] = 0.;
27534c274da1SToby Isaac         }
27544c274da1SToby Isaac       }
27554c274da1SToby Isaac     }
27564c274da1SToby Isaac     ierr = MatMultTransposeAdd(cMat,cVec,l,l);CHKERRQ(ierr);
27574c274da1SToby Isaac     ierr = VecDestroy(&cVec);CHKERRQ(ierr);
27584c274da1SToby Isaac   }
27594c274da1SToby Isaac   PetscFunctionReturn(0);
27604c274da1SToby Isaac }
276101729b5cSPatrick Sanan /*@
276201729b5cSPatrick Sanan     DMLocalToGlobal - updates global vectors from local vectors
276301729b5cSPatrick Sanan 
2764d083f849SBarry Smith     Neighbor-wise Collective on dm
276501729b5cSPatrick Sanan 
276601729b5cSPatrick Sanan     Input Parameters:
276701729b5cSPatrick Sanan +   dm - the DM object
276801729b5cSPatrick Sanan .   l - the local vector
276901729b5cSPatrick 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.
277001729b5cSPatrick Sanan -   g - the global vector
277101729b5cSPatrick Sanan 
277201729b5cSPatrick Sanan     Notes:
277301729b5cSPatrick Sanan     The communication involved in this update can be overlapped with computation by using
277401729b5cSPatrick Sanan     DMLocalToGlobalBegin() and DMLocalToGlobalEnd().
277501729b5cSPatrick Sanan 
277601729b5cSPatrick Sanan     In the ADD_VALUES case you normally would zero the receiving vector before beginning this operation.
277701729b5cSPatrick 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.
277801729b5cSPatrick Sanan 
277901729b5cSPatrick Sanan     Level: beginner
278001729b5cSPatrick Sanan 
278101729b5cSPatrick Sanan .seealso DMLocalToGlobalBegin(), DMLocalToGlobalEnd(), DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMGlobalToLocalEnd(), DMGlobalToLocalBegin()
278201729b5cSPatrick Sanan 
278301729b5cSPatrick Sanan @*/
278401729b5cSPatrick Sanan PetscErrorCode DMLocalToGlobal(DM dm,Vec l,InsertMode mode,Vec g)
278501729b5cSPatrick Sanan {
278601729b5cSPatrick Sanan   PetscErrorCode ierr;
278701729b5cSPatrick Sanan 
278801729b5cSPatrick Sanan   PetscFunctionBegin;
278901729b5cSPatrick Sanan   ierr = DMLocalToGlobalBegin(dm,l,mode,g);CHKERRQ(ierr);
279001729b5cSPatrick Sanan   ierr = DMLocalToGlobalEnd(dm,l,mode,g);CHKERRQ(ierr);
279101729b5cSPatrick Sanan   PetscFunctionReturn(0);
279201729b5cSPatrick Sanan }
27934c274da1SToby Isaac 
279447c6ae99SBarry Smith /*@
279501729b5cSPatrick Sanan     DMLocalToGlobalBegin - begins updating global vectors from local vectors
27969a42bb27SBarry Smith 
2797d083f849SBarry Smith     Neighbor-wise Collective on dm
27989a42bb27SBarry Smith 
27999a42bb27SBarry Smith     Input Parameters:
28009a42bb27SBarry Smith +   dm - the DM object
2801f6813fd5SJed Brown .   l - the local vector
28021eb28f2eSBarry 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.
28031eb28f2eSBarry Smith -   g - the global vector
28049a42bb27SBarry Smith 
280595452b02SPatrick Sanan     Notes:
280695452b02SPatrick Sanan     In the ADD_VALUES case you normally would zero the receiving vector before beginning this operation.
280784330215SMatthew 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.
28089a42bb27SBarry Smith 
280901729b5cSPatrick Sanan     Level: intermediate
28109a42bb27SBarry Smith 
281101729b5cSPatrick Sanan .seealso DMLocalToGlobal(), DMLocalToGlobalEnd(), DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMGlobalToLocalEnd(), DMGlobalToLocalBegin()
28129a42bb27SBarry Smith 
28139a42bb27SBarry Smith @*/
28147087cfbeSBarry Smith PetscErrorCode  DMLocalToGlobalBegin(DM dm,Vec l,InsertMode mode,Vec g)
28159a42bb27SBarry Smith {
28167128ae9fSMatthew G Knepley   PetscSF                 sf;
281784330215SMatthew G. Knepley   PetscSection            s, gs;
2818d4d07f1eSToby Isaac   DMLocalToGlobalHookLink link;
2819ca3d3a14SMatthew G. Knepley   Vec                     tmpl;
2820ae5cfb4aSMatthew G. Knepley   const PetscScalar      *lArray;
2821ae5cfb4aSMatthew G. Knepley   PetscScalar            *gArray;
2822fa88e482SJed Brown   PetscBool               isInsert, transform, l_inplace = PETSC_FALSE, g_inplace = PETSC_FALSE;
282384330215SMatthew G. Knepley   PetscErrorCode          ierr;
2824d0295fc0SJunchao Zhang   PetscMemType            lmtype=PETSC_MEMTYPE_HOST,gmtype=PETSC_MEMTYPE_HOST;
28259a42bb27SBarry Smith 
28269a42bb27SBarry Smith   PetscFunctionBegin;
2827171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2828d4d07f1eSToby Isaac   for (link=dm->ltoghook; link; link=link->next) {
2829d4d07f1eSToby Isaac     if (link->beginhook) {
2830d4d07f1eSToby Isaac       ierr = (*link->beginhook)(dm,l,mode,g,link->ctx);CHKERRQ(ierr);
2831d4d07f1eSToby Isaac     }
2832d4d07f1eSToby Isaac   }
28334c274da1SToby Isaac   ierr = DMLocalToGlobalHook_Constraints(dm,l,mode,g,NULL);CHKERRQ(ierr);
28341bb6d2a8SBarry Smith   ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr);
283592fd8e1eSJed Brown   ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr);
28367128ae9fSMatthew G Knepley   switch (mode) {
28377128ae9fSMatthew G Knepley   case INSERT_VALUES:
28387128ae9fSMatthew G Knepley   case INSERT_ALL_VALUES:
2839304ab55fSMatthew G. Knepley   case INSERT_BC_VALUES:
284084330215SMatthew G. Knepley     isInsert = PETSC_TRUE; break;
28417128ae9fSMatthew G Knepley   case ADD_VALUES:
28427128ae9fSMatthew G Knepley   case ADD_ALL_VALUES:
2843304ab55fSMatthew G. Knepley   case ADD_BC_VALUES:
284484330215SMatthew G. Knepley     isInsert = PETSC_FALSE; break;
28457128ae9fSMatthew G Knepley   default:
284682f516ccSBarry Smith     SETERRQ1(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
28477128ae9fSMatthew G Knepley   }
2848ca3d3a14SMatthew G. Knepley   if ((sf && !isInsert) || (s && isInsert)) {
2849ca3d3a14SMatthew G. Knepley     ierr = DMHasBasisTransform(dm, &transform);CHKERRQ(ierr);
2850ca3d3a14SMatthew G. Knepley     if (transform) {
2851ca3d3a14SMatthew G. Knepley       ierr = DMGetNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr);
2852ca3d3a14SMatthew G. Knepley       ierr = VecCopy(l, tmpl);CHKERRQ(ierr);
2853ca3d3a14SMatthew G. Knepley       ierr = DMPlexLocalToGlobalBasis(dm, tmpl);CHKERRQ(ierr);
2854ca3d3a14SMatthew G. Knepley       ierr = VecGetArrayRead(tmpl, &lArray);CHKERRQ(ierr);
2855fa88e482SJed Brown     } else if (isInsert) {
2856ae5cfb4aSMatthew G. Knepley       ierr = VecGetArrayRead(l, &lArray);CHKERRQ(ierr);
2857fa88e482SJed Brown     } else {
2858a256111fSJunchao Zhang       ierr = VecGetArrayReadAndMemType(l, &lArray, &lmtype);CHKERRQ(ierr);
2859fa88e482SJed Brown       l_inplace = PETSC_TRUE;
2860ca3d3a14SMatthew G. Knepley     }
2861fa88e482SJed Brown     if (s && isInsert) {
28627128ae9fSMatthew G Knepley       ierr = VecGetArray(g, &gArray);CHKERRQ(ierr);
2863fa88e482SJed Brown     } else {
2864a256111fSJunchao Zhang       ierr = VecGetArrayAndMemType(g, &gArray, &gmtype);CHKERRQ(ierr);
2865fa88e482SJed Brown       g_inplace = PETSC_TRUE;
2866fa88e482SJed Brown     }
2867ca3d3a14SMatthew G. Knepley     if (sf && !isInsert) {
2868d0295fc0SJunchao Zhang       ierr = PetscSFReduceWithMemTypeBegin(sf, MPIU_SCALAR, lmtype, lArray, gmtype, gArray, MPIU_SUM);CHKERRQ(ierr);
286984330215SMatthew G. Knepley     } else if (s && isInsert) {
287084330215SMatthew G. Knepley       PetscInt gStart, pStart, pEnd, p;
287184330215SMatthew G. Knepley 
2872e87a4003SBarry Smith       ierr = DMGetGlobalSection(dm, &gs);CHKERRQ(ierr);
287384330215SMatthew G. Knepley       ierr = PetscSectionGetChart(s, &pStart, &pEnd);CHKERRQ(ierr);
287484330215SMatthew G. Knepley       ierr = VecGetOwnershipRange(g, &gStart, NULL);CHKERRQ(ierr);
287584330215SMatthew G. Knepley       for (p = pStart; p < pEnd; ++p) {
2876b3b16f48SMatthew G. Knepley         PetscInt dof, gdof, cdof, gcdof, off, goff, d, e;
287784330215SMatthew G. Knepley 
287884330215SMatthew G. Knepley         ierr = PetscSectionGetDof(s, p, &dof);CHKERRQ(ierr);
287903442857SMatthew G. Knepley         ierr = PetscSectionGetDof(gs, p, &gdof);CHKERRQ(ierr);
288084330215SMatthew G. Knepley         ierr = PetscSectionGetConstraintDof(s, p, &cdof);CHKERRQ(ierr);
2881b3b16f48SMatthew G. Knepley         ierr = PetscSectionGetConstraintDof(gs, p, &gcdof);CHKERRQ(ierr);
288284330215SMatthew G. Knepley         ierr = PetscSectionGetOffset(s, p, &off);CHKERRQ(ierr);
288384330215SMatthew G. Knepley         ierr = PetscSectionGetOffset(gs, p, &goff);CHKERRQ(ierr);
2884b3b16f48SMatthew G. Knepley         /* Ignore off-process data and points with no global data */
288503442857SMatthew G. Knepley         if (!gdof || goff < 0) continue;
2886b3b16f48SMatthew 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);
2887b3b16f48SMatthew G. Knepley         /* If no constraints are enforced in the global vector */
2888b3b16f48SMatthew G. Knepley         if (!gcdof) {
288984330215SMatthew G. Knepley           for (d = 0; d < dof; ++d) gArray[goff-gStart+d] = lArray[off+d];
2890b3b16f48SMatthew G. Knepley           /* If constraints are enforced in the global vector */
2891b3b16f48SMatthew G. Knepley         } else if (cdof == gcdof) {
289284330215SMatthew G. Knepley           const PetscInt *cdofs;
289384330215SMatthew G. Knepley           PetscInt        cind = 0;
289484330215SMatthew G. Knepley 
289584330215SMatthew G. Knepley           ierr = PetscSectionGetConstraintIndices(s, p, &cdofs);CHKERRQ(ierr);
2896b3b16f48SMatthew G. Knepley           for (d = 0, e = 0; d < dof; ++d) {
289784330215SMatthew G. Knepley             if ((cind < cdof) && (d == cdofs[cind])) {++cind; continue;}
2898b3b16f48SMatthew G. Knepley             gArray[goff-gStart+e++] = lArray[off+d];
289984330215SMatthew G. Knepley           }
2900b3b16f48SMatthew 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);
290184330215SMatthew G. Knepley       }
2902ca3d3a14SMatthew G. Knepley     }
2903fa88e482SJed Brown     if (g_inplace) {
2904a256111fSJunchao Zhang       ierr = VecRestoreArrayAndMemType(g, &gArray);CHKERRQ(ierr);
2905fa88e482SJed Brown     } else {
29067128ae9fSMatthew G Knepley       ierr = VecRestoreArray(g, &gArray);CHKERRQ(ierr);
2907fa88e482SJed Brown     }
2908ca3d3a14SMatthew G. Knepley     if (transform) {
2909ca3d3a14SMatthew G. Knepley       ierr = VecRestoreArrayRead(tmpl, &lArray);CHKERRQ(ierr);
2910ca3d3a14SMatthew G. Knepley       ierr = DMRestoreNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr);
2911fa88e482SJed Brown     } else if (l_inplace) {
2912a256111fSJunchao Zhang       ierr = VecRestoreArrayReadAndMemType(l, &lArray);CHKERRQ(ierr);
2913ca3d3a14SMatthew G. Knepley     } else {
2914ca3d3a14SMatthew G. Knepley       ierr = VecRestoreArrayRead(l, &lArray);CHKERRQ(ierr);
2915ca3d3a14SMatthew G. Knepley     }
29167128ae9fSMatthew G Knepley   } else {
2917b9d85ea2SLisandro Dalcin     if (!dm->ops->localtoglobalbegin) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMLocalToGlobalBegin() for type %s",((PetscObject)dm)->type_name);
2918843c4018SMatthew G Knepley     ierr = (*dm->ops->localtoglobalbegin)(dm,l,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),g);CHKERRQ(ierr);
29197128ae9fSMatthew G Knepley   }
29209a42bb27SBarry Smith   PetscFunctionReturn(0);
29219a42bb27SBarry Smith }
29229a42bb27SBarry Smith 
29239a42bb27SBarry Smith /*@
29249a42bb27SBarry Smith     DMLocalToGlobalEnd - updates global vectors from local vectors
292547c6ae99SBarry Smith 
2926d083f849SBarry Smith     Neighbor-wise Collective on dm
292747c6ae99SBarry Smith 
292847c6ae99SBarry Smith     Input Parameters:
292947c6ae99SBarry Smith +   dm - the DM object
2930f6813fd5SJed Brown .   l - the local vector
293147c6ae99SBarry Smith .   mode - INSERT_VALUES or ADD_VALUES
2932f6813fd5SJed Brown -   g - the global vector
293347c6ae99SBarry Smith 
293401729b5cSPatrick Sanan     Level: intermediate
293547c6ae99SBarry Smith 
2936e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMGlobalToLocalEnd()
293747c6ae99SBarry Smith 
293847c6ae99SBarry Smith @*/
29397087cfbeSBarry Smith PetscErrorCode  DMLocalToGlobalEnd(DM dm,Vec l,InsertMode mode,Vec g)
294047c6ae99SBarry Smith {
29417128ae9fSMatthew G Knepley   PetscSF                 sf;
294284330215SMatthew G. Knepley   PetscSection            s;
2943d4d07f1eSToby Isaac   DMLocalToGlobalHookLink link;
2944ca3d3a14SMatthew G. Knepley   PetscBool               isInsert, transform;
294584330215SMatthew G. Knepley   PetscErrorCode          ierr;
294647c6ae99SBarry Smith 
294747c6ae99SBarry Smith   PetscFunctionBegin;
2948171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
29491bb6d2a8SBarry Smith   ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr);
295092fd8e1eSJed Brown   ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr);
29517128ae9fSMatthew G Knepley   switch (mode) {
29527128ae9fSMatthew G Knepley   case INSERT_VALUES:
29537128ae9fSMatthew G Knepley   case INSERT_ALL_VALUES:
295484330215SMatthew G. Knepley     isInsert = PETSC_TRUE; break;
29557128ae9fSMatthew G Knepley   case ADD_VALUES:
29567128ae9fSMatthew G Knepley   case ADD_ALL_VALUES:
295784330215SMatthew G. Knepley     isInsert = PETSC_FALSE; break;
29587128ae9fSMatthew G Knepley   default:
295982f516ccSBarry Smith     SETERRQ1(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
29607128ae9fSMatthew G Knepley   }
296184330215SMatthew G. Knepley   if (sf && !isInsert) {
2962ae5cfb4aSMatthew G. Knepley     const PetscScalar *lArray;
2963ae5cfb4aSMatthew G. Knepley     PetscScalar       *gArray;
2964ca3d3a14SMatthew G. Knepley     Vec                tmpl;
296584330215SMatthew G. Knepley 
2966ca3d3a14SMatthew G. Knepley     ierr = DMHasBasisTransform(dm, &transform);CHKERRQ(ierr);
2967ca3d3a14SMatthew G. Knepley     if (transform) {
2968ca3d3a14SMatthew G. Knepley       ierr = DMGetNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr);
2969ca3d3a14SMatthew G. Knepley       ierr = VecGetArrayRead(tmpl, &lArray);CHKERRQ(ierr);
2970ca3d3a14SMatthew G. Knepley     } else {
2971a256111fSJunchao Zhang       ierr = VecGetArrayReadAndMemType(l, &lArray, NULL);CHKERRQ(ierr);
2972ca3d3a14SMatthew G. Knepley     }
2973a256111fSJunchao Zhang     ierr = VecGetArrayAndMemType(g, &gArray, NULL);CHKERRQ(ierr);
2974a9b180a6SBarry Smith     ierr = PetscSFReduceEnd(sf, MPIU_SCALAR, lArray, gArray, MPIU_SUM);CHKERRQ(ierr);
2975ca3d3a14SMatthew G. Knepley     if (transform) {
2976ca3d3a14SMatthew G. Knepley       ierr = VecRestoreArrayRead(tmpl, &lArray);CHKERRQ(ierr);
2977ca3d3a14SMatthew G. Knepley       ierr = DMRestoreNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr);
2978ca3d3a14SMatthew G. Knepley     } else {
2979a256111fSJunchao Zhang       ierr = VecRestoreArrayReadAndMemType(l, &lArray);CHKERRQ(ierr);
2980ca3d3a14SMatthew G. Knepley     }
2981a256111fSJunchao Zhang     ierr = VecRestoreArrayAndMemType(g, &gArray);CHKERRQ(ierr);
298284330215SMatthew G. Knepley   } else if (s && isInsert) {
29837128ae9fSMatthew G Knepley   } else {
2984b9d85ea2SLisandro Dalcin     if (!dm->ops->localtoglobalend) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMLocalToGlobalEnd() for type %s",((PetscObject)dm)->type_name);
2985843c4018SMatthew G Knepley     ierr = (*dm->ops->localtoglobalend)(dm,l,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),g);CHKERRQ(ierr);
29867128ae9fSMatthew G Knepley   }
2987d4d07f1eSToby Isaac   for (link=dm->ltoghook; link; link=link->next) {
2988d4d07f1eSToby Isaac     if (link->endhook) {ierr = (*link->endhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);}
2989d4d07f1eSToby Isaac   }
299047c6ae99SBarry Smith   PetscFunctionReturn(0);
299147c6ae99SBarry Smith }
299247c6ae99SBarry Smith 
2993f089877aSRichard Tran Mills /*@
2994bc0a1609SRichard Tran Mills    DMLocalToLocalBegin - Maps from a local vector (including ghost points
2995bc0a1609SRichard Tran Mills    that contain irrelevant values) to another local vector where the ghost
2996d78e899eSRichard Tran Mills    points in the second are set correctly. Must be followed by DMLocalToLocalEnd().
2997f089877aSRichard Tran Mills 
2998d083f849SBarry Smith    Neighbor-wise Collective on dm
2999f089877aSRichard Tran Mills 
3000f089877aSRichard Tran Mills    Input Parameters:
3001f089877aSRichard Tran Mills +  dm - the DM object
3002bc0a1609SRichard Tran Mills .  g - the original local vector
3003bc0a1609SRichard Tran Mills -  mode - one of INSERT_VALUES or ADD_VALUES
3004f089877aSRichard Tran Mills 
3005bc0a1609SRichard Tran Mills    Output Parameter:
3006bc0a1609SRichard Tran Mills .  l  - the local vector with correct ghost values
3007f089877aSRichard Tran Mills 
3008f089877aSRichard Tran Mills    Level: intermediate
3009f089877aSRichard Tran Mills 
3010bc0a1609SRichard Tran Mills    Notes:
3011bc0a1609SRichard Tran Mills    The local vectors used here need not be the same as those
3012bc0a1609SRichard Tran Mills    obtained from DMCreateLocalVector(), BUT they
3013bc0a1609SRichard Tran Mills    must have the same parallel data layout; they could, for example, be
3014bc0a1609SRichard Tran Mills    obtained with VecDuplicate() from the DM originating vectors.
3015bc0a1609SRichard Tran Mills 
3016bc0a1609SRichard Tran Mills .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateLocalVector(), DMCreateGlobalVector(), DMCreateInterpolation(), DMLocalToLocalEnd(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin()
3017f089877aSRichard Tran Mills 
3018f089877aSRichard Tran Mills @*/
3019f089877aSRichard Tran Mills PetscErrorCode  DMLocalToLocalBegin(DM dm,Vec g,InsertMode mode,Vec l)
3020f089877aSRichard Tran Mills {
3021f089877aSRichard Tran Mills   PetscErrorCode          ierr;
3022f089877aSRichard Tran Mills 
3023f089877aSRichard Tran Mills   PetscFunctionBegin;
3024f089877aSRichard Tran Mills   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3025bb358533SPatrick Sanan   if (!dm->ops->localtolocalbegin) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"This DM does not support local to local maps");
3026f089877aSRichard Tran Mills   ierr = (*dm->ops->localtolocalbegin)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
3027f089877aSRichard Tran Mills   PetscFunctionReturn(0);
3028f089877aSRichard Tran Mills }
3029f089877aSRichard Tran Mills 
3030f089877aSRichard Tran Mills /*@
3031bc0a1609SRichard Tran Mills    DMLocalToLocalEnd - Maps from a local vector (including ghost points
3032bc0a1609SRichard Tran Mills    that contain irrelevant values) to another local vector where the ghost
3033d78e899eSRichard Tran Mills    points in the second are set correctly. Must be preceded by DMLocalToLocalBegin().
3034f089877aSRichard Tran Mills 
3035d083f849SBarry Smith    Neighbor-wise Collective on dm
3036f089877aSRichard Tran Mills 
3037f089877aSRichard Tran Mills    Input Parameters:
3038bc0a1609SRichard Tran Mills +  da - the DM object
3039bc0a1609SRichard Tran Mills .  g - the original local vector
3040bc0a1609SRichard Tran Mills -  mode - one of INSERT_VALUES or ADD_VALUES
3041f089877aSRichard Tran Mills 
3042bc0a1609SRichard Tran Mills    Output Parameter:
3043bc0a1609SRichard Tran Mills .  l  - the local vector with correct ghost values
3044f089877aSRichard Tran Mills 
3045f089877aSRichard Tran Mills    Level: intermediate
3046f089877aSRichard Tran Mills 
3047bc0a1609SRichard Tran Mills    Notes:
3048bc0a1609SRichard Tran Mills    The local vectors used here need not be the same as those
3049bc0a1609SRichard Tran Mills    obtained from DMCreateLocalVector(), BUT they
3050bc0a1609SRichard Tran Mills    must have the same parallel data layout; they could, for example, be
3051bc0a1609SRichard Tran Mills    obtained with VecDuplicate() from the DM originating vectors.
3052bc0a1609SRichard Tran Mills 
3053bc0a1609SRichard Tran Mills .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateLocalVector(), DMCreateGlobalVector(), DMCreateInterpolation(), DMLocalToLocalBegin(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin()
3054f089877aSRichard Tran Mills 
3055f089877aSRichard Tran Mills @*/
3056f089877aSRichard Tran Mills PetscErrorCode  DMLocalToLocalEnd(DM dm,Vec g,InsertMode mode,Vec l)
3057f089877aSRichard Tran Mills {
3058f089877aSRichard Tran Mills   PetscErrorCode          ierr;
3059f089877aSRichard Tran Mills 
3060f089877aSRichard Tran Mills   PetscFunctionBegin;
3061f089877aSRichard Tran Mills   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3062bb358533SPatrick Sanan   if (!dm->ops->localtolocalend) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"This DM does not support local to local maps");
3063f089877aSRichard Tran Mills   ierr = (*dm->ops->localtolocalend)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
3064f089877aSRichard Tran Mills   PetscFunctionReturn(0);
3065f089877aSRichard Tran Mills }
3066f089877aSRichard Tran Mills 
306747c6ae99SBarry Smith /*@
306847c6ae99SBarry Smith     DMCoarsen - Coarsens a DM object
306947c6ae99SBarry Smith 
3070d083f849SBarry Smith     Collective on dm
307147c6ae99SBarry Smith 
3072d8d19677SJose E. Roman     Input Parameters:
307347c6ae99SBarry Smith +   dm - the DM object
307491d95f02SJed Brown -   comm - the communicator to contain the new DM object (or MPI_COMM_NULL)
307547c6ae99SBarry Smith 
307647c6ae99SBarry Smith     Output Parameter:
307747c6ae99SBarry Smith .   dmc - the coarsened DM
307847c6ae99SBarry Smith 
307947c6ae99SBarry Smith     Level: developer
308047c6ae99SBarry Smith 
3081e727c939SJed Brown .seealso DMRefine(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
308247c6ae99SBarry Smith 
308347c6ae99SBarry Smith @*/
30847087cfbeSBarry Smith PetscErrorCode DMCoarsen(DM dm, MPI_Comm comm, DM *dmc)
308547c6ae99SBarry Smith {
308647c6ae99SBarry Smith   PetscErrorCode    ierr;
3087b17ce1afSJed Brown   DMCoarsenHookLink link;
308847c6ae99SBarry Smith 
308947c6ae99SBarry Smith   PetscFunctionBegin;
3090171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3091b9d85ea2SLisandro Dalcin   if (!dm->ops->coarsen) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCoarsen",((PetscObject)dm)->type_name);
309247a35634SPatrick Farrell   ierr = PetscLogEventBegin(DM_Coarsen,dm,0,0,0);CHKERRQ(ierr);
309347c6ae99SBarry Smith   ierr = (*dm->ops->coarsen)(dm, comm, dmc);CHKERRQ(ierr);
3094b9d85ea2SLisandro Dalcin   if (*dmc) {
3095a8fb8f29SToby Isaac     ierr = DMSetCoarseDM(dm,*dmc);CHKERRQ(ierr);
309643842a1eSJed Brown     (*dmc)->ops->creatematrix = dm->ops->creatematrix;
30978cd211a4SJed Brown     ierr                      = PetscObjectCopyFortranFunctionPointers((PetscObject)dm,(PetscObject)*dmc);CHKERRQ(ierr);
3098644e2e5bSBarry Smith     (*dmc)->ctx               = dm->ctx;
30990598a293SJed Brown     (*dmc)->levelup           = dm->levelup;
3100656b349aSBarry Smith     (*dmc)->leveldown         = dm->leveldown + 1;
3101e4b4b23bSJed Brown     ierr                      = DMSetMatType(*dmc,dm->mattype);CHKERRQ(ierr);
3102b17ce1afSJed Brown     for (link=dm->coarsenhook; link; link=link->next) {
3103b17ce1afSJed Brown       if (link->coarsenhook) {ierr = (*link->coarsenhook)(dm,*dmc,link->ctx);CHKERRQ(ierr);}
3104b17ce1afSJed Brown     }
3105b9d85ea2SLisandro Dalcin   }
310647a35634SPatrick Farrell   ierr = PetscLogEventEnd(DM_Coarsen,dm,0,0,0);CHKERRQ(ierr);
3107b9d85ea2SLisandro Dalcin   if (!(*dmc)) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "NULL coarse mesh produced");
3108b17ce1afSJed Brown   PetscFunctionReturn(0);
3109b17ce1afSJed Brown }
3110b17ce1afSJed Brown 
3111bb9467b5SJed Brown /*@C
3112b17ce1afSJed Brown    DMCoarsenHookAdd - adds a callback to be run when restricting a nonlinear problem to the coarse grid
3113b17ce1afSJed Brown 
3114b17ce1afSJed Brown    Logically Collective
3115b17ce1afSJed Brown 
31164165533cSJose E. Roman    Input Parameters:
3117b17ce1afSJed Brown +  fine - nonlinear solver context on which to run a hook when restricting to a coarser level
3118b17ce1afSJed Brown .  coarsenhook - function to run when setting up a coarser level
3119b17ce1afSJed Brown .  restricthook - function to run to update data on coarser levels (once per SNESSolve())
31200298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
3121b17ce1afSJed Brown 
3122b17ce1afSJed Brown    Calling sequence of coarsenhook:
3123b17ce1afSJed Brown $    coarsenhook(DM fine,DM coarse,void *ctx);
3124b17ce1afSJed Brown 
3125b17ce1afSJed Brown +  fine - fine level DM
3126b17ce1afSJed Brown .  coarse - coarse level DM to restrict problem to
3127b17ce1afSJed Brown -  ctx - optional user-defined function context
3128b17ce1afSJed Brown 
3129b17ce1afSJed Brown    Calling sequence for restricthook:
3130c833c3b5SJed Brown $    restricthook(DM fine,Mat mrestrict,Vec rscale,Mat inject,DM coarse,void *ctx)
3131b17ce1afSJed Brown 
3132b17ce1afSJed Brown +  fine - fine level DM
3133b17ce1afSJed Brown .  mrestrict - matrix restricting a fine-level solution to the coarse grid
3134c833c3b5SJed Brown .  rscale - scaling vector for restriction
3135c833c3b5SJed Brown .  inject - matrix restricting by injection
3136b17ce1afSJed Brown .  coarse - coarse level DM to update
3137b17ce1afSJed Brown -  ctx - optional user-defined function context
3138b17ce1afSJed Brown 
3139b17ce1afSJed Brown    Level: advanced
3140b17ce1afSJed Brown 
3141b17ce1afSJed Brown    Notes:
3142b17ce1afSJed Brown    This function is only needed if auxiliary data needs to be set up on coarse grids.
3143b17ce1afSJed Brown 
3144b17ce1afSJed Brown    If this function is called multiple times, the hooks will be run in the order they are added.
3145b17ce1afSJed Brown 
3146b17ce1afSJed Brown    In order to compose with nonlinear preconditioning without duplicating storage, the hook should be implemented to
3147b17ce1afSJed Brown    extract the finest level information from its context (instead of from the SNES).
3148b17ce1afSJed Brown 
3149bb9467b5SJed Brown    This function is currently not available from Fortran.
3150bb9467b5SJed Brown 
3151dc822a44SJed Brown .seealso: DMCoarsenHookRemove(), DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
3152b17ce1afSJed Brown @*/
3153b17ce1afSJed Brown PetscErrorCode DMCoarsenHookAdd(DM fine,PetscErrorCode (*coarsenhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,Mat,Vec,Mat,DM,void*),void *ctx)
3154b17ce1afSJed Brown {
3155b17ce1afSJed Brown   PetscErrorCode    ierr;
3156b17ce1afSJed Brown   DMCoarsenHookLink link,*p;
3157b17ce1afSJed Brown 
3158b17ce1afSJed Brown   PetscFunctionBegin;
3159b17ce1afSJed Brown   PetscValidHeaderSpecific(fine,DM_CLASSID,1);
31601e3d8eccSJed Brown   for (p=&fine->coarsenhook; *p; p=&(*p)->next) { /* Scan to the end of the current list of hooks */
31611e3d8eccSJed Brown     if ((*p)->coarsenhook == coarsenhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) PetscFunctionReturn(0);
31621e3d8eccSJed Brown   }
316395dccacaSBarry Smith   ierr               = PetscNew(&link);CHKERRQ(ierr);
3164b17ce1afSJed Brown   link->coarsenhook  = coarsenhook;
3165b17ce1afSJed Brown   link->restricthook = restricthook;
3166b17ce1afSJed Brown   link->ctx          = ctx;
31670298fd71SBarry Smith   link->next         = NULL;
3168b17ce1afSJed Brown   *p                 = link;
3169b17ce1afSJed Brown   PetscFunctionReturn(0);
3170b17ce1afSJed Brown }
3171b17ce1afSJed Brown 
3172dc822a44SJed Brown /*@C
3173dc822a44SJed Brown    DMCoarsenHookRemove - remove a callback from the list of hooks to be run when restricting a nonlinear problem to the coarse grid
3174dc822a44SJed Brown 
3175dc822a44SJed Brown    Logically Collective
3176dc822a44SJed Brown 
31774165533cSJose E. Roman    Input Parameters:
3178dc822a44SJed Brown +  fine - nonlinear solver context on which to run a hook when restricting to a coarser level
3179dc822a44SJed Brown .  coarsenhook - function to run when setting up a coarser level
3180dc822a44SJed Brown .  restricthook - function to run to update data on coarser levels (once per SNESSolve())
3181dc822a44SJed Brown -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
3182dc822a44SJed Brown 
3183dc822a44SJed Brown    Level: advanced
3184dc822a44SJed Brown 
3185dc822a44SJed Brown    Notes:
3186dc822a44SJed Brown    This function does nothing if the hook is not in the list.
3187dc822a44SJed Brown 
3188dc822a44SJed Brown    This function is currently not available from Fortran.
3189dc822a44SJed Brown 
3190dc822a44SJed Brown .seealso: DMCoarsenHookAdd(), DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
3191dc822a44SJed Brown @*/
3192dc822a44SJed Brown PetscErrorCode DMCoarsenHookRemove(DM fine,PetscErrorCode (*coarsenhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,Mat,Vec,Mat,DM,void*),void *ctx)
3193dc822a44SJed Brown {
3194dc822a44SJed Brown   PetscErrorCode    ierr;
3195dc822a44SJed Brown   DMCoarsenHookLink link,*p;
3196dc822a44SJed Brown 
3197dc822a44SJed Brown   PetscFunctionBegin;
3198dc822a44SJed Brown   PetscValidHeaderSpecific(fine,DM_CLASSID,1);
3199dc822a44SJed Brown   for (p=&fine->coarsenhook; *p; p=&(*p)->next) { /* Search the list of current hooks */
3200dc822a44SJed Brown     if ((*p)->coarsenhook == coarsenhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) {
3201dc822a44SJed Brown       link = *p;
3202dc822a44SJed Brown       *p = link->next;
3203dc822a44SJed Brown       ierr = PetscFree(link);CHKERRQ(ierr);
3204dc822a44SJed Brown       break;
3205dc822a44SJed Brown     }
3206dc822a44SJed Brown   }
3207dc822a44SJed Brown   PetscFunctionReturn(0);
3208dc822a44SJed Brown }
3209dc822a44SJed Brown 
3210b17ce1afSJed Brown /*@
3211b17ce1afSJed Brown    DMRestrict - restricts user-defined problem data to a coarser DM by running hooks registered by DMCoarsenHookAdd()
3212b17ce1afSJed Brown 
3213b17ce1afSJed Brown    Collective if any hooks are
3214b17ce1afSJed Brown 
32154165533cSJose E. Roman    Input Parameters:
3216b17ce1afSJed Brown +  fine - finer DM to use as a base
3217b17ce1afSJed Brown .  restrct - restriction matrix, apply using MatRestrict()
3218e91eccc2SStefano Zampini .  rscale - scaling vector for restriction
3219b17ce1afSJed Brown .  inject - injection matrix, also use MatRestrict()
3220e91eccc2SStefano Zampini -  coarse - coarser DM to update
3221b17ce1afSJed Brown 
3222b17ce1afSJed Brown    Level: developer
3223b17ce1afSJed Brown 
3224b17ce1afSJed Brown .seealso: DMCoarsenHookAdd(), MatRestrict()
3225b17ce1afSJed Brown @*/
3226b17ce1afSJed Brown PetscErrorCode DMRestrict(DM fine,Mat restrct,Vec rscale,Mat inject,DM coarse)
3227b17ce1afSJed Brown {
3228b17ce1afSJed Brown   PetscErrorCode    ierr;
3229b17ce1afSJed Brown   DMCoarsenHookLink link;
3230b17ce1afSJed Brown 
3231b17ce1afSJed Brown   PetscFunctionBegin;
3232b17ce1afSJed Brown   for (link=fine->coarsenhook; link; link=link->next) {
32338865f1eaSKarl Rupp     if (link->restricthook) {
32348865f1eaSKarl Rupp       ierr = (*link->restricthook)(fine,restrct,rscale,inject,coarse,link->ctx);CHKERRQ(ierr);
32358865f1eaSKarl Rupp     }
3236b17ce1afSJed Brown   }
323747c6ae99SBarry Smith   PetscFunctionReturn(0);
323847c6ae99SBarry Smith }
323947c6ae99SBarry Smith 
3240bb9467b5SJed Brown /*@C
3241be081cd6SPeter Brune    DMSubDomainHookAdd - adds a callback to be run when restricting a problem to the coarse grid
32425dbd56e3SPeter Brune 
3243d083f849SBarry Smith    Logically Collective on global
32445dbd56e3SPeter Brune 
32454165533cSJose E. Roman    Input Parameters:
32465dbd56e3SPeter Brune +  global - global DM
3247ec4806b8SPeter Brune .  ddhook - function to run to pass data to the decomposition DM upon its creation
32485dbd56e3SPeter Brune .  restricthook - function to run to update data on block solve (at the beginning of the block solve)
32490298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
32505dbd56e3SPeter Brune 
3251ec4806b8SPeter Brune    Calling sequence for ddhook:
3252ec4806b8SPeter Brune $    ddhook(DM global,DM block,void *ctx)
3253ec4806b8SPeter Brune 
3254ec4806b8SPeter Brune +  global - global DM
3255ec4806b8SPeter Brune .  block  - block DM
3256ec4806b8SPeter Brune -  ctx - optional user-defined function context
3257ec4806b8SPeter Brune 
32585dbd56e3SPeter Brune    Calling sequence for restricthook:
3259ec4806b8SPeter Brune $    restricthook(DM global,VecScatter out,VecScatter in,DM block,void *ctx)
32605dbd56e3SPeter Brune 
32615dbd56e3SPeter Brune +  global - global DM
32625dbd56e3SPeter Brune .  out    - scatter to the outer (with ghost and overlap points) block vector
32635dbd56e3SPeter Brune .  in     - scatter to block vector values only owned locally
3264ec4806b8SPeter Brune .  block  - block DM
32655dbd56e3SPeter Brune -  ctx - optional user-defined function context
32665dbd56e3SPeter Brune 
32675dbd56e3SPeter Brune    Level: advanced
32685dbd56e3SPeter Brune 
32695dbd56e3SPeter Brune    Notes:
3270ec4806b8SPeter Brune    This function is only needed if auxiliary data needs to be set up on subdomain DMs.
32715dbd56e3SPeter Brune 
32725dbd56e3SPeter Brune    If this function is called multiple times, the hooks will be run in the order they are added.
32735dbd56e3SPeter Brune 
32745dbd56e3SPeter Brune    In order to compose with nonlinear preconditioning without duplicating storage, the hook should be implemented to
3275ec4806b8SPeter Brune    extract the global information from its context (instead of from the SNES).
32765dbd56e3SPeter Brune 
3277bb9467b5SJed Brown    This function is currently not available from Fortran.
3278bb9467b5SJed Brown 
32795dbd56e3SPeter Brune .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
32805dbd56e3SPeter Brune @*/
3281be081cd6SPeter Brune PetscErrorCode DMSubDomainHookAdd(DM global,PetscErrorCode (*ddhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,VecScatter,VecScatter,DM,void*),void *ctx)
32825dbd56e3SPeter Brune {
32835dbd56e3SPeter Brune   PetscErrorCode      ierr;
3284be081cd6SPeter Brune   DMSubDomainHookLink link,*p;
32855dbd56e3SPeter Brune 
32865dbd56e3SPeter Brune   PetscFunctionBegin;
32875dbd56e3SPeter Brune   PetscValidHeaderSpecific(global,DM_CLASSID,1);
3288b3a6b972SJed Brown   for (p=&global->subdomainhook; *p; p=&(*p)->next) { /* Scan to the end of the current list of hooks */
3289b3a6b972SJed Brown     if ((*p)->ddhook == ddhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) PetscFunctionReturn(0);
3290b3a6b972SJed Brown   }
329195dccacaSBarry Smith   ierr               = PetscNew(&link);CHKERRQ(ierr);
32925dbd56e3SPeter Brune   link->restricthook = restricthook;
3293be081cd6SPeter Brune   link->ddhook       = ddhook;
32945dbd56e3SPeter Brune   link->ctx          = ctx;
32950298fd71SBarry Smith   link->next         = NULL;
32965dbd56e3SPeter Brune   *p                 = link;
32975dbd56e3SPeter Brune   PetscFunctionReturn(0);
32985dbd56e3SPeter Brune }
32995dbd56e3SPeter Brune 
3300b3a6b972SJed Brown /*@C
3301b3a6b972SJed Brown    DMSubDomainHookRemove - remove a callback from the list to be run when restricting a problem to the coarse grid
3302b3a6b972SJed Brown 
3303b3a6b972SJed Brown    Logically Collective
3304b3a6b972SJed Brown 
33054165533cSJose E. Roman    Input Parameters:
3306b3a6b972SJed Brown +  global - global DM
3307b3a6b972SJed Brown .  ddhook - function to run to pass data to the decomposition DM upon its creation
3308b3a6b972SJed Brown .  restricthook - function to run to update data on block solve (at the beginning of the block solve)
3309b3a6b972SJed Brown -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
3310b3a6b972SJed Brown 
3311b3a6b972SJed Brown    Level: advanced
3312b3a6b972SJed Brown 
3313b3a6b972SJed Brown    Notes:
3314b3a6b972SJed Brown 
3315b3a6b972SJed Brown    This function is currently not available from Fortran.
3316b3a6b972SJed Brown 
3317b3a6b972SJed Brown .seealso: DMSubDomainHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
3318b3a6b972SJed Brown @*/
3319b3a6b972SJed Brown PetscErrorCode DMSubDomainHookRemove(DM global,PetscErrorCode (*ddhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,VecScatter,VecScatter,DM,void*),void *ctx)
3320b3a6b972SJed Brown {
3321b3a6b972SJed Brown   PetscErrorCode      ierr;
3322b3a6b972SJed Brown   DMSubDomainHookLink link,*p;
3323b3a6b972SJed Brown 
3324b3a6b972SJed Brown   PetscFunctionBegin;
3325b3a6b972SJed Brown   PetscValidHeaderSpecific(global,DM_CLASSID,1);
3326b3a6b972SJed Brown   for (p=&global->subdomainhook; *p; p=&(*p)->next) { /* Search the list of current hooks */
3327b3a6b972SJed Brown     if ((*p)->ddhook == ddhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) {
3328b3a6b972SJed Brown       link = *p;
3329b3a6b972SJed Brown       *p = link->next;
3330b3a6b972SJed Brown       ierr = PetscFree(link);CHKERRQ(ierr);
3331b3a6b972SJed Brown       break;
3332b3a6b972SJed Brown     }
3333b3a6b972SJed Brown   }
3334b3a6b972SJed Brown   PetscFunctionReturn(0);
3335b3a6b972SJed Brown }
3336b3a6b972SJed Brown 
33375dbd56e3SPeter Brune /*@
3338be081cd6SPeter Brune    DMSubDomainRestrict - restricts user-defined problem data to a block DM by running hooks registered by DMSubDomainHookAdd()
33395dbd56e3SPeter Brune 
33405dbd56e3SPeter Brune    Collective if any hooks are
33415dbd56e3SPeter Brune 
33424165533cSJose E. Roman    Input Parameters:
33435dbd56e3SPeter Brune +  fine - finer DM to use as a base
3344be081cd6SPeter Brune .  oscatter - scatter from domain global vector filling subdomain global vector with overlap
3345be081cd6SPeter Brune .  gscatter - scatter from domain global vector filling subdomain local vector with ghosts
33465dbd56e3SPeter Brune -  coarse - coarer DM to update
33475dbd56e3SPeter Brune 
33485dbd56e3SPeter Brune    Level: developer
33495dbd56e3SPeter Brune 
33505dbd56e3SPeter Brune .seealso: DMCoarsenHookAdd(), MatRestrict()
33515dbd56e3SPeter Brune @*/
3352be081cd6SPeter Brune PetscErrorCode DMSubDomainRestrict(DM global,VecScatter oscatter,VecScatter gscatter,DM subdm)
33535dbd56e3SPeter Brune {
33545dbd56e3SPeter Brune   PetscErrorCode      ierr;
3355be081cd6SPeter Brune   DMSubDomainHookLink link;
33565dbd56e3SPeter Brune 
33575dbd56e3SPeter Brune   PetscFunctionBegin;
3358be081cd6SPeter Brune   for (link=global->subdomainhook; link; link=link->next) {
33598865f1eaSKarl Rupp     if (link->restricthook) {
33608865f1eaSKarl Rupp       ierr = (*link->restricthook)(global,oscatter,gscatter,subdm,link->ctx);CHKERRQ(ierr);
33618865f1eaSKarl Rupp     }
33625dbd56e3SPeter Brune   }
33635dbd56e3SPeter Brune   PetscFunctionReturn(0);
33645dbd56e3SPeter Brune }
33655dbd56e3SPeter Brune 
33665fe1f584SPeter Brune /*@
33676a7d9d85SPeter Brune     DMGetCoarsenLevel - Get's the number of coarsenings that have generated this DM.
33685fe1f584SPeter Brune 
33695fe1f584SPeter Brune     Not Collective
33705fe1f584SPeter Brune 
33715fe1f584SPeter Brune     Input Parameter:
33725fe1f584SPeter Brune .   dm - the DM object
33735fe1f584SPeter Brune 
33745fe1f584SPeter Brune     Output Parameter:
33756a7d9d85SPeter Brune .   level - number of coarsenings
33765fe1f584SPeter Brune 
33775fe1f584SPeter Brune     Level: developer
33785fe1f584SPeter Brune 
33796a7d9d85SPeter Brune .seealso DMCoarsen(), DMGetRefineLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
33805fe1f584SPeter Brune 
33815fe1f584SPeter Brune @*/
33825fe1f584SPeter Brune PetscErrorCode  DMGetCoarsenLevel(DM dm,PetscInt *level)
33835fe1f584SPeter Brune {
33845fe1f584SPeter Brune   PetscFunctionBegin;
33855fe1f584SPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3386b9d85ea2SLisandro Dalcin   PetscValidIntPointer(level,2);
33875fe1f584SPeter Brune   *level = dm->leveldown;
33885fe1f584SPeter Brune   PetscFunctionReturn(0);
33895fe1f584SPeter Brune }
33905fe1f584SPeter Brune 
33919a64c4a8SMatthew G. Knepley /*@
33929a64c4a8SMatthew G. Knepley     DMSetCoarsenLevel - Sets the number of coarsenings that have generated this DM.
33939a64c4a8SMatthew G. Knepley 
33949a64c4a8SMatthew G. Knepley     Not Collective
33959a64c4a8SMatthew G. Knepley 
33969a64c4a8SMatthew G. Knepley     Input Parameters:
33979a64c4a8SMatthew G. Knepley +   dm - the DM object
33989a64c4a8SMatthew G. Knepley -   level - number of coarsenings
33999a64c4a8SMatthew G. Knepley 
34009a64c4a8SMatthew G. Knepley     Level: developer
34019a64c4a8SMatthew G. Knepley 
34029a64c4a8SMatthew G. Knepley .seealso DMCoarsen(), DMGetCoarsenLevel(), DMGetRefineLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
34039a64c4a8SMatthew G. Knepley @*/
34049a64c4a8SMatthew G. Knepley PetscErrorCode DMSetCoarsenLevel(DM dm,PetscInt level)
34059a64c4a8SMatthew G. Knepley {
34069a64c4a8SMatthew G. Knepley   PetscFunctionBegin;
34079a64c4a8SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
34089a64c4a8SMatthew G. Knepley   dm->leveldown = level;
34099a64c4a8SMatthew G. Knepley   PetscFunctionReturn(0);
34109a64c4a8SMatthew G. Knepley }
34119a64c4a8SMatthew G. Knepley 
341247c6ae99SBarry Smith /*@C
341347c6ae99SBarry Smith     DMRefineHierarchy - Refines a DM object, all levels at once
341447c6ae99SBarry Smith 
3415d083f849SBarry Smith     Collective on dm
341647c6ae99SBarry Smith 
3417d8d19677SJose E. Roman     Input Parameters:
341847c6ae99SBarry Smith +   dm - the DM object
341947c6ae99SBarry Smith -   nlevels - the number of levels of refinement
342047c6ae99SBarry Smith 
342147c6ae99SBarry Smith     Output Parameter:
342247c6ae99SBarry Smith .   dmf - the refined DM hierarchy
342347c6ae99SBarry Smith 
342447c6ae99SBarry Smith     Level: developer
342547c6ae99SBarry Smith 
3426e727c939SJed Brown .seealso DMCoarsenHierarchy(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
342747c6ae99SBarry Smith 
342847c6ae99SBarry Smith @*/
34297087cfbeSBarry Smith PetscErrorCode  DMRefineHierarchy(DM dm,PetscInt nlevels,DM dmf[])
343047c6ae99SBarry Smith {
343147c6ae99SBarry Smith   PetscErrorCode ierr;
343247c6ae99SBarry Smith 
343347c6ae99SBarry Smith   PetscFunctionBegin;
3434171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3435ce94432eSBarry Smith   if (nlevels < 0) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_OUTOFRANGE,"nlevels cannot be negative");
343647c6ae99SBarry Smith   if (nlevels == 0) PetscFunctionReturn(0);
3437b9d85ea2SLisandro Dalcin   PetscValidPointer(dmf,3);
343847c6ae99SBarry Smith   if (dm->ops->refinehierarchy) {
343947c6ae99SBarry Smith     ierr = (*dm->ops->refinehierarchy)(dm,nlevels,dmf);CHKERRQ(ierr);
344047c6ae99SBarry Smith   } else if (dm->ops->refine) {
344147c6ae99SBarry Smith     PetscInt i;
344247c6ae99SBarry Smith 
3443ce94432eSBarry Smith     ierr = DMRefine(dm,PetscObjectComm((PetscObject)dm),&dmf[0]);CHKERRQ(ierr);
344447c6ae99SBarry Smith     for (i=1; i<nlevels; i++) {
3445ce94432eSBarry Smith       ierr = DMRefine(dmf[i-1],PetscObjectComm((PetscObject)dm),&dmf[i]);CHKERRQ(ierr);
344647c6ae99SBarry Smith     }
3447ce94432eSBarry Smith   } else SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"No RefineHierarchy for this DM yet");
344847c6ae99SBarry Smith   PetscFunctionReturn(0);
344947c6ae99SBarry Smith }
345047c6ae99SBarry Smith 
345147c6ae99SBarry Smith /*@C
345247c6ae99SBarry Smith     DMCoarsenHierarchy - Coarsens a DM object, all levels at once
345347c6ae99SBarry Smith 
3454d083f849SBarry Smith     Collective on dm
345547c6ae99SBarry Smith 
3456d8d19677SJose E. Roman     Input Parameters:
345747c6ae99SBarry Smith +   dm - the DM object
345847c6ae99SBarry Smith -   nlevels - the number of levels of coarsening
345947c6ae99SBarry Smith 
346047c6ae99SBarry Smith     Output Parameter:
346147c6ae99SBarry Smith .   dmc - the coarsened DM hierarchy
346247c6ae99SBarry Smith 
346347c6ae99SBarry Smith     Level: developer
346447c6ae99SBarry Smith 
3465e727c939SJed Brown .seealso DMRefineHierarchy(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
346647c6ae99SBarry Smith 
346747c6ae99SBarry Smith @*/
34687087cfbeSBarry Smith PetscErrorCode  DMCoarsenHierarchy(DM dm, PetscInt nlevels, DM dmc[])
346947c6ae99SBarry Smith {
347047c6ae99SBarry Smith   PetscErrorCode ierr;
347147c6ae99SBarry Smith 
347247c6ae99SBarry Smith   PetscFunctionBegin;
3473171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3474ce94432eSBarry Smith   if (nlevels < 0) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_OUTOFRANGE,"nlevels cannot be negative");
347547c6ae99SBarry Smith   if (nlevels == 0) PetscFunctionReturn(0);
347647c6ae99SBarry Smith   PetscValidPointer(dmc,3);
347747c6ae99SBarry Smith   if (dm->ops->coarsenhierarchy) {
347847c6ae99SBarry Smith     ierr = (*dm->ops->coarsenhierarchy)(dm, nlevels, dmc);CHKERRQ(ierr);
347947c6ae99SBarry Smith   } else if (dm->ops->coarsen) {
348047c6ae99SBarry Smith     PetscInt i;
348147c6ae99SBarry Smith 
3482ce94432eSBarry Smith     ierr = DMCoarsen(dm,PetscObjectComm((PetscObject)dm),&dmc[0]);CHKERRQ(ierr);
348347c6ae99SBarry Smith     for (i=1; i<nlevels; i++) {
3484ce94432eSBarry Smith       ierr = DMCoarsen(dmc[i-1],PetscObjectComm((PetscObject)dm),&dmc[i]);CHKERRQ(ierr);
348547c6ae99SBarry Smith     }
3486ce94432eSBarry Smith   } else SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"No CoarsenHierarchy for this DM yet");
348747c6ae99SBarry Smith   PetscFunctionReturn(0);
348847c6ae99SBarry Smith }
348947c6ae99SBarry Smith 
34901a266240SBarry Smith /*@C
34911a266240SBarry Smith     DMSetApplicationContextDestroy - Sets a user function that will be called to destroy the application context when the DM is destroyed
34921a266240SBarry Smith 
34931a266240SBarry Smith     Not Collective
34941a266240SBarry Smith 
34951a266240SBarry Smith     Input Parameters:
34961a266240SBarry Smith +   dm - the DM object
34971a266240SBarry Smith -   destroy - the destroy function
34981a266240SBarry Smith 
34991a266240SBarry Smith     Level: intermediate
35001a266240SBarry Smith 
3501e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
35021a266240SBarry Smith 
3503f07f9ceaSJed Brown @*/
35041a266240SBarry Smith PetscErrorCode  DMSetApplicationContextDestroy(DM dm,PetscErrorCode (*destroy)(void**))
35051a266240SBarry Smith {
35061a266240SBarry Smith   PetscFunctionBegin;
3507171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
35081a266240SBarry Smith   dm->ctxdestroy = destroy;
35091a266240SBarry Smith   PetscFunctionReturn(0);
35101a266240SBarry Smith }
35111a266240SBarry Smith 
3512b07ff414SBarry Smith /*@
35131b2093e4SBarry Smith     DMSetApplicationContext - Set a user context into a DM object
351447c6ae99SBarry Smith 
351547c6ae99SBarry Smith     Not Collective
351647c6ae99SBarry Smith 
351747c6ae99SBarry Smith     Input Parameters:
351847c6ae99SBarry Smith +   dm - the DM object
351947c6ae99SBarry Smith -   ctx - the user context
352047c6ae99SBarry Smith 
352147c6ae99SBarry Smith     Level: intermediate
352247c6ae99SBarry Smith 
3523e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
352447c6ae99SBarry Smith 
352547c6ae99SBarry Smith @*/
35261b2093e4SBarry Smith PetscErrorCode  DMSetApplicationContext(DM dm,void *ctx)
352747c6ae99SBarry Smith {
352847c6ae99SBarry Smith   PetscFunctionBegin;
3529171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
353047c6ae99SBarry Smith   dm->ctx = ctx;
353147c6ae99SBarry Smith   PetscFunctionReturn(0);
353247c6ae99SBarry Smith }
353347c6ae99SBarry Smith 
353447c6ae99SBarry Smith /*@
35351b2093e4SBarry Smith     DMGetApplicationContext - Gets a user context from a DM object
353647c6ae99SBarry Smith 
353747c6ae99SBarry Smith     Not Collective
353847c6ae99SBarry Smith 
353947c6ae99SBarry Smith     Input Parameter:
354047c6ae99SBarry Smith .   dm - the DM object
354147c6ae99SBarry Smith 
354247c6ae99SBarry Smith     Output Parameter:
354347c6ae99SBarry Smith .   ctx - the user context
354447c6ae99SBarry Smith 
354547c6ae99SBarry Smith     Level: intermediate
354647c6ae99SBarry Smith 
3547e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
354847c6ae99SBarry Smith 
354947c6ae99SBarry Smith @*/
35501b2093e4SBarry Smith PetscErrorCode  DMGetApplicationContext(DM dm,void *ctx)
355147c6ae99SBarry Smith {
355247c6ae99SBarry Smith   PetscFunctionBegin;
3553171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
35541b2093e4SBarry Smith   *(void**)ctx = dm->ctx;
355547c6ae99SBarry Smith   PetscFunctionReturn(0);
355647c6ae99SBarry Smith }
355747c6ae99SBarry Smith 
355808da532bSDmitry Karpeev /*@C
3559df3898eeSBarry Smith     DMSetVariableBounds - sets a function to compute the lower and upper bound vectors for SNESVI.
356008da532bSDmitry Karpeev 
3561d083f849SBarry Smith     Logically Collective on dm
356208da532bSDmitry Karpeev 
3563d8d19677SJose E. Roman     Input Parameters:
356408da532bSDmitry Karpeev +   dm - the DM object
35650298fd71SBarry Smith -   f - the function that computes variable bounds used by SNESVI (use NULL to cancel a previous function that was set)
356608da532bSDmitry Karpeev 
356708da532bSDmitry Karpeev     Level: intermediate
356808da532bSDmitry Karpeev 
3569835c3ec7SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext(),
357008da532bSDmitry Karpeev          DMSetJacobian()
357108da532bSDmitry Karpeev 
357208da532bSDmitry Karpeev @*/
357308da532bSDmitry Karpeev PetscErrorCode DMSetVariableBounds(DM dm,PetscErrorCode (*f)(DM,Vec,Vec))
357408da532bSDmitry Karpeev {
357508da532bSDmitry Karpeev   PetscFunctionBegin;
35765a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
357708da532bSDmitry Karpeev   dm->ops->computevariablebounds = f;
357808da532bSDmitry Karpeev   PetscFunctionReturn(0);
357908da532bSDmitry Karpeev }
358008da532bSDmitry Karpeev 
358108da532bSDmitry Karpeev /*@
358208da532bSDmitry Karpeev     DMHasVariableBounds - does the DM object have a variable bounds function?
358308da532bSDmitry Karpeev 
358408da532bSDmitry Karpeev     Not Collective
358508da532bSDmitry Karpeev 
358608da532bSDmitry Karpeev     Input Parameter:
358708da532bSDmitry Karpeev .   dm - the DM object to destroy
358808da532bSDmitry Karpeev 
358908da532bSDmitry Karpeev     Output Parameter:
359008da532bSDmitry Karpeev .   flg - PETSC_TRUE if the variable bounds function exists
359108da532bSDmitry Karpeev 
359208da532bSDmitry Karpeev     Level: developer
359308da532bSDmitry Karpeev 
359474e1e8c1SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
359508da532bSDmitry Karpeev 
359608da532bSDmitry Karpeev @*/
359708da532bSDmitry Karpeev PetscErrorCode DMHasVariableBounds(DM dm,PetscBool *flg)
359808da532bSDmitry Karpeev {
359908da532bSDmitry Karpeev   PetscFunctionBegin;
36005a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3601534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
360208da532bSDmitry Karpeev   *flg =  (dm->ops->computevariablebounds) ? PETSC_TRUE : PETSC_FALSE;
360308da532bSDmitry Karpeev   PetscFunctionReturn(0);
360408da532bSDmitry Karpeev }
360508da532bSDmitry Karpeev 
360608da532bSDmitry Karpeev /*@C
360708da532bSDmitry Karpeev     DMComputeVariableBounds - compute variable bounds used by SNESVI.
360808da532bSDmitry Karpeev 
3609d083f849SBarry Smith     Logically Collective on dm
361008da532bSDmitry Karpeev 
3611f899ff85SJose E. Roman     Input Parameter:
3612907376e6SBarry Smith .   dm - the DM object
361308da532bSDmitry Karpeev 
361408da532bSDmitry Karpeev     Output parameters:
361508da532bSDmitry Karpeev +   xl - lower bound
361608da532bSDmitry Karpeev -   xu - upper bound
361708da532bSDmitry Karpeev 
3618907376e6SBarry Smith     Level: advanced
3619907376e6SBarry Smith 
362095452b02SPatrick Sanan     Notes:
362195452b02SPatrick Sanan     This is generally not called by users. It calls the function provided by the user with DMSetVariableBounds()
362208da532bSDmitry Karpeev 
362374e1e8c1SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
362408da532bSDmitry Karpeev 
362508da532bSDmitry Karpeev @*/
362608da532bSDmitry Karpeev PetscErrorCode DMComputeVariableBounds(DM dm, Vec xl, Vec xu)
362708da532bSDmitry Karpeev {
362808da532bSDmitry Karpeev   PetscErrorCode ierr;
36295fd66863SKarl Rupp 
363008da532bSDmitry Karpeev   PetscFunctionBegin;
36315a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
363208da532bSDmitry Karpeev   PetscValidHeaderSpecific(xl,VEC_CLASSID,2);
36335a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(xu,VEC_CLASSID,3);
3634b9d85ea2SLisandro Dalcin   if (!dm->ops->computevariablebounds) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeVariableBounds",((PetscObject)dm)->type_name);
363508da532bSDmitry Karpeev   ierr = (*dm->ops->computevariablebounds)(dm, xl,xu);CHKERRQ(ierr);
363608da532bSDmitry Karpeev   PetscFunctionReturn(0);
363708da532bSDmitry Karpeev }
363808da532bSDmitry Karpeev 
3639b0ae01b7SPeter Brune /*@
3640b0ae01b7SPeter Brune     DMHasColoring - does the DM object have a method of providing a coloring?
3641b0ae01b7SPeter Brune 
3642b0ae01b7SPeter Brune     Not Collective
3643b0ae01b7SPeter Brune 
3644b0ae01b7SPeter Brune     Input Parameter:
3645b0ae01b7SPeter Brune .   dm - the DM object
3646b0ae01b7SPeter Brune 
3647b0ae01b7SPeter Brune     Output Parameter:
3648b0ae01b7SPeter Brune .   flg - PETSC_TRUE if the DM has facilities for DMCreateColoring().
3649b0ae01b7SPeter Brune 
3650b0ae01b7SPeter Brune     Level: developer
3651b0ae01b7SPeter Brune 
36521565f0a7SPatrick Sanan .seealso DMCreateColoring()
3653b0ae01b7SPeter Brune 
3654b0ae01b7SPeter Brune @*/
3655b0ae01b7SPeter Brune PetscErrorCode DMHasColoring(DM dm,PetscBool *flg)
3656b0ae01b7SPeter Brune {
3657b0ae01b7SPeter Brune   PetscFunctionBegin;
36585a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3659534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
3660b0ae01b7SPeter Brune   *flg =  (dm->ops->getcoloring) ? PETSC_TRUE : PETSC_FALSE;
3661b0ae01b7SPeter Brune   PetscFunctionReturn(0);
3662b0ae01b7SPeter Brune }
3663b0ae01b7SPeter Brune 
36643ad4599aSBarry Smith /*@
36653ad4599aSBarry Smith     DMHasCreateRestriction - does the DM object have a method of providing a restriction?
36663ad4599aSBarry Smith 
36673ad4599aSBarry Smith     Not Collective
36683ad4599aSBarry Smith 
36693ad4599aSBarry Smith     Input Parameter:
36703ad4599aSBarry Smith .   dm - the DM object
36713ad4599aSBarry Smith 
36723ad4599aSBarry Smith     Output Parameter:
36733ad4599aSBarry Smith .   flg - PETSC_TRUE if the DM has facilities for DMCreateRestriction().
36743ad4599aSBarry Smith 
36753ad4599aSBarry Smith     Level: developer
36763ad4599aSBarry Smith 
36771565f0a7SPatrick Sanan .seealso DMCreateRestriction()
36783ad4599aSBarry Smith 
36793ad4599aSBarry Smith @*/
36803ad4599aSBarry Smith PetscErrorCode DMHasCreateRestriction(DM dm,PetscBool *flg)
36813ad4599aSBarry Smith {
36823ad4599aSBarry Smith   PetscFunctionBegin;
36835a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3684534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
36853ad4599aSBarry Smith   *flg =  (dm->ops->createrestriction) ? PETSC_TRUE : PETSC_FALSE;
36863ad4599aSBarry Smith   PetscFunctionReturn(0);
36873ad4599aSBarry Smith }
36883ad4599aSBarry Smith 
3689a7058e45SLawrence Mitchell /*@
3690a7058e45SLawrence Mitchell     DMHasCreateInjection - does the DM object have a method of providing an injection?
3691a7058e45SLawrence Mitchell 
3692a7058e45SLawrence Mitchell     Not Collective
3693a7058e45SLawrence Mitchell 
3694a7058e45SLawrence Mitchell     Input Parameter:
3695a7058e45SLawrence Mitchell .   dm - the DM object
3696a7058e45SLawrence Mitchell 
3697a7058e45SLawrence Mitchell     Output Parameter:
3698a7058e45SLawrence Mitchell .   flg - PETSC_TRUE if the DM has facilities for DMCreateInjection().
3699a7058e45SLawrence Mitchell 
3700a7058e45SLawrence Mitchell     Level: developer
3701a7058e45SLawrence Mitchell 
37021565f0a7SPatrick Sanan .seealso DMCreateInjection()
3703a7058e45SLawrence Mitchell 
3704a7058e45SLawrence Mitchell @*/
3705a7058e45SLawrence Mitchell PetscErrorCode DMHasCreateInjection(DM dm,PetscBool *flg)
3706a7058e45SLawrence Mitchell {
37074a7a4c06SLawrence Mitchell   PetscErrorCode ierr;
37085a84ad33SLisandro Dalcin 
3709a7058e45SLawrence Mitchell   PetscFunctionBegin;
37105a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3711534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
37125a84ad33SLisandro Dalcin   if (dm->ops->hascreateinjection) {
37134a7a4c06SLawrence Mitchell     ierr = (*dm->ops->hascreateinjection)(dm,flg);CHKERRQ(ierr);
37145a84ad33SLisandro Dalcin   } else {
37155a84ad33SLisandro Dalcin     *flg = (dm->ops->createinjection) ? PETSC_TRUE : PETSC_FALSE;
37165a84ad33SLisandro Dalcin   }
3717a7058e45SLawrence Mitchell   PetscFunctionReturn(0);
3718a7058e45SLawrence Mitchell }
3719a7058e45SLawrence Mitchell 
37200298fd71SBarry Smith PetscFunctionList DMList              = NULL;
3721264ace61SBarry Smith PetscBool         DMRegisterAllCalled = PETSC_FALSE;
3722264ace61SBarry Smith 
3723264ace61SBarry Smith /*@C
3724264ace61SBarry Smith   DMSetType - Builds a DM, for a particular DM implementation.
3725264ace61SBarry Smith 
3726d083f849SBarry Smith   Collective on dm
3727264ace61SBarry Smith 
3728264ace61SBarry Smith   Input Parameters:
3729264ace61SBarry Smith + dm     - The DM object
3730264ace61SBarry Smith - method - The name of the DM type
3731264ace61SBarry Smith 
3732264ace61SBarry Smith   Options Database Key:
3733264ace61SBarry Smith . -dm_type <type> - Sets the DM type; use -help for a list of available types
3734264ace61SBarry Smith 
3735264ace61SBarry Smith   Notes:
3736e1589f56SBarry Smith   See "petsc/include/petscdm.h" for available DM types (for instance, DM1D, DM2D, or DM3D).
3737264ace61SBarry Smith 
3738264ace61SBarry Smith   Level: intermediate
3739264ace61SBarry Smith 
3740264ace61SBarry Smith .seealso: DMGetType(), DMCreate()
3741264ace61SBarry Smith @*/
374219fd82e9SBarry Smith PetscErrorCode  DMSetType(DM dm, DMType method)
3743264ace61SBarry Smith {
3744264ace61SBarry Smith   PetscErrorCode (*r)(DM);
3745264ace61SBarry Smith   PetscBool      match;
3746264ace61SBarry Smith   PetscErrorCode ierr;
3747264ace61SBarry Smith 
3748264ace61SBarry Smith   PetscFunctionBegin;
3749264ace61SBarry Smith   PetscValidHeaderSpecific(dm, DM_CLASSID,1);
3750251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject) dm, method, &match);CHKERRQ(ierr);
3751264ace61SBarry Smith   if (match) PetscFunctionReturn(0);
3752264ace61SBarry Smith 
37530f51fdf8SToby Isaac   ierr = DMRegisterAll();CHKERRQ(ierr);
37541c9cd337SJed Brown   ierr = PetscFunctionListFind(DMList,method,&r);CHKERRQ(ierr);
3755ce94432eSBarry Smith   if (!r) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_UNKNOWN_TYPE, "Unknown DM type: %s", method);
3756264ace61SBarry Smith 
3757264ace61SBarry Smith   if (dm->ops->destroy) {
3758264ace61SBarry Smith     ierr = (*dm->ops->destroy)(dm);CHKERRQ(ierr);
3759264ace61SBarry Smith   }
3760d57f96a3SLisandro Dalcin   ierr = PetscMemzero(dm->ops,sizeof(*dm->ops));CHKERRQ(ierr);
3761264ace61SBarry Smith   ierr = PetscObjectChangeTypeName((PetscObject)dm,method);CHKERRQ(ierr);
3762d57f96a3SLisandro Dalcin   ierr = (*r)(dm);CHKERRQ(ierr);
3763264ace61SBarry Smith   PetscFunctionReturn(0);
3764264ace61SBarry Smith }
3765264ace61SBarry Smith 
3766264ace61SBarry Smith /*@C
3767264ace61SBarry Smith   DMGetType - Gets the DM type name (as a string) from the DM.
3768264ace61SBarry Smith 
3769264ace61SBarry Smith   Not Collective
3770264ace61SBarry Smith 
3771264ace61SBarry Smith   Input Parameter:
3772264ace61SBarry Smith . dm  - The DM
3773264ace61SBarry Smith 
3774264ace61SBarry Smith   Output Parameter:
3775264ace61SBarry Smith . type - The DM type name
3776264ace61SBarry Smith 
3777264ace61SBarry Smith   Level: intermediate
3778264ace61SBarry Smith 
3779264ace61SBarry Smith .seealso: DMSetType(), DMCreate()
3780264ace61SBarry Smith @*/
378119fd82e9SBarry Smith PetscErrorCode  DMGetType(DM dm, DMType *type)
3782264ace61SBarry Smith {
3783264ace61SBarry Smith   PetscErrorCode ierr;
3784264ace61SBarry Smith 
3785264ace61SBarry Smith   PetscFunctionBegin;
3786264ace61SBarry Smith   PetscValidHeaderSpecific(dm, DM_CLASSID,1);
3787c959eef4SJed Brown   PetscValidPointer(type,2);
3788607a6623SBarry Smith   ierr = DMRegisterAll();CHKERRQ(ierr);
3789264ace61SBarry Smith   *type = ((PetscObject)dm)->type_name;
3790264ace61SBarry Smith   PetscFunctionReturn(0);
3791264ace61SBarry Smith }
3792264ace61SBarry Smith 
379367a56275SMatthew G Knepley /*@C
379467a56275SMatthew G Knepley   DMConvert - Converts a DM to another DM, either of the same or different type.
379567a56275SMatthew G Knepley 
3796d083f849SBarry Smith   Collective on dm
379767a56275SMatthew G Knepley 
379867a56275SMatthew G Knepley   Input Parameters:
379967a56275SMatthew G Knepley + dm - the DM
380067a56275SMatthew G Knepley - newtype - new DM type (use "same" for the same type)
380167a56275SMatthew G Knepley 
380267a56275SMatthew G Knepley   Output Parameter:
380367a56275SMatthew G Knepley . M - pointer to new DM
380467a56275SMatthew G Knepley 
380567a56275SMatthew G Knepley   Notes:
380667a56275SMatthew G Knepley   Cannot be used to convert a sequential DM to parallel or parallel to sequential,
380767a56275SMatthew G Knepley   the MPI communicator of the generated DM is always the same as the communicator
380867a56275SMatthew G Knepley   of the input DM.
380967a56275SMatthew G Knepley 
381067a56275SMatthew G Knepley   Level: intermediate
381167a56275SMatthew G Knepley 
381267a56275SMatthew G Knepley .seealso: DMCreate()
381367a56275SMatthew G Knepley @*/
381419fd82e9SBarry Smith PetscErrorCode DMConvert(DM dm, DMType newtype, DM *M)
381567a56275SMatthew G Knepley {
381667a56275SMatthew G Knepley   DM             B;
381767a56275SMatthew G Knepley   char           convname[256];
3818c067b6caSMatthew G. Knepley   PetscBool      sametype/*, issame */;
381967a56275SMatthew G Knepley   PetscErrorCode ierr;
382067a56275SMatthew G Knepley 
382167a56275SMatthew G Knepley   PetscFunctionBegin;
382267a56275SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
382367a56275SMatthew G Knepley   PetscValidType(dm,1);
382467a56275SMatthew G Knepley   PetscValidPointer(M,3);
3825251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject) dm, newtype, &sametype);CHKERRQ(ierr);
3826c067b6caSMatthew G. Knepley   /* ierr = PetscStrcmp(newtype, "same", &issame);CHKERRQ(ierr); */
3827c067b6caSMatthew G. Knepley   if (sametype) {
3828c067b6caSMatthew G. Knepley     *M   = dm;
3829c067b6caSMatthew G. Knepley     ierr = PetscObjectReference((PetscObject) dm);CHKERRQ(ierr);
3830c067b6caSMatthew G. Knepley     PetscFunctionReturn(0);
3831c067b6caSMatthew G. Knepley   } else {
38320298fd71SBarry Smith     PetscErrorCode (*conv)(DM, DMType, DM*) = NULL;
383367a56275SMatthew G Knepley 
383467a56275SMatthew G Knepley     /*
383567a56275SMatthew G Knepley        Order of precedence:
383667a56275SMatthew G Knepley        1) See if a specialized converter is known to the current DM.
383767a56275SMatthew G Knepley        2) See if a specialized converter is known to the desired DM class.
383867a56275SMatthew G Knepley        3) See if a good general converter is registered for the desired class
383967a56275SMatthew G Knepley        4) See if a good general converter is known for the current matrix.
384067a56275SMatthew G Knepley        5) Use a really basic converter.
384167a56275SMatthew G Knepley     */
384267a56275SMatthew G Knepley 
384367a56275SMatthew G Knepley     /* 1) See if a specialized converter is known to the current DM and the desired class */
3844a126751eSBarry Smith     ierr = PetscStrncpy(convname,"DMConvert_",sizeof(convname));CHKERRQ(ierr);
3845a126751eSBarry Smith     ierr = PetscStrlcat(convname,((PetscObject) dm)->type_name,sizeof(convname));CHKERRQ(ierr);
3846a126751eSBarry Smith     ierr = PetscStrlcat(convname,"_",sizeof(convname));CHKERRQ(ierr);
3847a126751eSBarry Smith     ierr = PetscStrlcat(convname,newtype,sizeof(convname));CHKERRQ(ierr);
3848a126751eSBarry Smith     ierr = PetscStrlcat(convname,"_C",sizeof(convname));CHKERRQ(ierr);
38490005d66cSJed Brown     ierr = PetscObjectQueryFunction((PetscObject)dm,convname,&conv);CHKERRQ(ierr);
385067a56275SMatthew G Knepley     if (conv) goto foundconv;
385167a56275SMatthew G Knepley 
385267a56275SMatthew G Knepley     /* 2)  See if a specialized converter is known to the desired DM class. */
385382f516ccSBarry Smith     ierr = DMCreate(PetscObjectComm((PetscObject)dm), &B);CHKERRQ(ierr);
385467a56275SMatthew G Knepley     ierr = DMSetType(B, newtype);CHKERRQ(ierr);
3855a126751eSBarry Smith     ierr = PetscStrncpy(convname,"DMConvert_",sizeof(convname));CHKERRQ(ierr);
3856a126751eSBarry Smith     ierr = PetscStrlcat(convname,((PetscObject) dm)->type_name,sizeof(convname));CHKERRQ(ierr);
3857a126751eSBarry Smith     ierr = PetscStrlcat(convname,"_",sizeof(convname));CHKERRQ(ierr);
3858a126751eSBarry Smith     ierr = PetscStrlcat(convname,newtype,sizeof(convname));CHKERRQ(ierr);
3859a126751eSBarry Smith     ierr = PetscStrlcat(convname,"_C",sizeof(convname));CHKERRQ(ierr);
38600005d66cSJed Brown     ierr = PetscObjectQueryFunction((PetscObject)B,convname,&conv);CHKERRQ(ierr);
386167a56275SMatthew G Knepley     if (conv) {
3862fcfd50ebSBarry Smith       ierr = DMDestroy(&B);CHKERRQ(ierr);
386367a56275SMatthew G Knepley       goto foundconv;
386467a56275SMatthew G Knepley     }
386567a56275SMatthew G Knepley 
386667a56275SMatthew G Knepley #if 0
386767a56275SMatthew G Knepley     /* 3) See if a good general converter is registered for the desired class */
386867a56275SMatthew G Knepley     conv = B->ops->convertfrom;
3869fcfd50ebSBarry Smith     ierr = DMDestroy(&B);CHKERRQ(ierr);
387067a56275SMatthew G Knepley     if (conv) goto foundconv;
387167a56275SMatthew G Knepley 
387267a56275SMatthew G Knepley     /* 4) See if a good general converter is known for the current matrix */
387367a56275SMatthew G Knepley     if (dm->ops->convert) {
387467a56275SMatthew G Knepley       conv = dm->ops->convert;
387567a56275SMatthew G Knepley     }
387667a56275SMatthew G Knepley     if (conv) goto foundconv;
387767a56275SMatthew G Knepley #endif
387867a56275SMatthew G Knepley 
387967a56275SMatthew G Knepley     /* 5) Use a really basic converter. */
388082f516ccSBarry Smith     SETERRQ2(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "No conversion possible between DM types %s and %s", ((PetscObject) dm)->type_name, newtype);
388167a56275SMatthew G Knepley 
388267a56275SMatthew G Knepley foundconv:
388367a56275SMatthew G Knepley     ierr = PetscLogEventBegin(DM_Convert,dm,0,0,0);CHKERRQ(ierr);
388467a56275SMatthew G Knepley     ierr = (*conv)(dm,newtype,M);CHKERRQ(ierr);
388512fa691eSMatthew G. Knepley     /* Things that are independent of DM type: We should consult DMClone() here */
388690b157c4SStefano Zampini     {
388790b157c4SStefano Zampini       PetscBool             isper;
388812fa691eSMatthew G. Knepley       const PetscReal      *maxCell, *L;
388912fa691eSMatthew G. Knepley       const DMBoundaryType *bd;
389090b157c4SStefano Zampini       ierr = DMGetPeriodicity(dm, &isper, &maxCell, &L, &bd);CHKERRQ(ierr);
389190b157c4SStefano Zampini       ierr = DMSetPeriodicity(*M, isper, maxCell,  L,  bd);CHKERRQ(ierr);
3892c8a6034eSMark       (*M)->prealloc_only = dm->prealloc_only;
3893a587d139SMark       ierr = PetscFree((*M)->vectype);CHKERRQ(ierr);
3894a587d139SMark       ierr = PetscStrallocpy(dm->vectype,(char**)&(*M)->vectype);CHKERRQ(ierr);
3895a587d139SMark       ierr = PetscFree((*M)->mattype);CHKERRQ(ierr);
3896a587d139SMark       ierr = PetscStrallocpy(dm->mattype,(char**)&(*M)->mattype);CHKERRQ(ierr);
389712fa691eSMatthew G. Knepley     }
389867a56275SMatthew G Knepley     ierr = PetscLogEventEnd(DM_Convert,dm,0,0,0);CHKERRQ(ierr);
389967a56275SMatthew G Knepley   }
390067a56275SMatthew G Knepley   ierr = PetscObjectStateIncrease((PetscObject) *M);CHKERRQ(ierr);
390167a56275SMatthew G Knepley   PetscFunctionReturn(0);
390267a56275SMatthew G Knepley }
3903264ace61SBarry Smith 
3904264ace61SBarry Smith /*--------------------------------------------------------------------------------------------------------------------*/
3905264ace61SBarry Smith 
3906264ace61SBarry Smith /*@C
39071c84c290SBarry Smith   DMRegister -  Adds a new DM component implementation
39081c84c290SBarry Smith 
39091c84c290SBarry Smith   Not Collective
39101c84c290SBarry Smith 
39111c84c290SBarry Smith   Input Parameters:
39121c84c290SBarry Smith + name        - The name of a new user-defined creation routine
39131c84c290SBarry Smith - create_func - The creation routine itself
39141c84c290SBarry Smith 
39151c84c290SBarry Smith   Notes:
39161c84c290SBarry Smith   DMRegister() may be called multiple times to add several user-defined DMs
39171c84c290SBarry Smith 
39181c84c290SBarry Smith   Sample usage:
39191c84c290SBarry Smith .vb
3920bdf89e91SBarry Smith     DMRegister("my_da", MyDMCreate);
39211c84c290SBarry Smith .ve
39221c84c290SBarry Smith 
39231c84c290SBarry Smith   Then, your DM type can be chosen with the procedural interface via
39241c84c290SBarry Smith .vb
39251c84c290SBarry Smith     DMCreate(MPI_Comm, DM *);
39261c84c290SBarry Smith     DMSetType(DM,"my_da");
39271c84c290SBarry Smith .ve
39281c84c290SBarry Smith    or at runtime via the option
39291c84c290SBarry Smith .vb
39301c84c290SBarry Smith     -da_type my_da
39311c84c290SBarry Smith .ve
3932264ace61SBarry Smith 
3933264ace61SBarry Smith   Level: advanced
39341c84c290SBarry Smith 
3935bdf89e91SBarry Smith .seealso: DMRegisterAll(), DMRegisterDestroy()
39361c84c290SBarry Smith 
3937264ace61SBarry Smith @*/
3938bdf89e91SBarry Smith PetscErrorCode  DMRegister(const char sname[],PetscErrorCode (*function)(DM))
3939264ace61SBarry Smith {
3940264ace61SBarry Smith   PetscErrorCode ierr;
3941264ace61SBarry Smith 
3942264ace61SBarry Smith   PetscFunctionBegin;
39431d36bdfdSBarry Smith   ierr = DMInitializePackage();CHKERRQ(ierr);
3944a240a19fSJed Brown   ierr = PetscFunctionListAdd(&DMList,sname,function);CHKERRQ(ierr);
3945264ace61SBarry Smith   PetscFunctionReturn(0);
3946264ace61SBarry Smith }
3947264ace61SBarry Smith 
3948b859378eSBarry Smith /*@C
394955849f57SBarry Smith   DMLoad - Loads a DM that has been stored in binary  with DMView().
3950b859378eSBarry Smith 
3951d083f849SBarry Smith   Collective on viewer
3952b859378eSBarry Smith 
3953b859378eSBarry Smith   Input Parameters:
3954b859378eSBarry Smith + newdm - the newly loaded DM, this needs to have been created with DMCreate() or
3955b859378eSBarry Smith            some related function before a call to DMLoad().
3956b859378eSBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen() or
3957b859378eSBarry Smith            HDF5 file viewer, obtained from PetscViewerHDF5Open()
3958b859378eSBarry Smith 
3959b859378eSBarry Smith    Level: intermediate
3960b859378eSBarry Smith 
3961b859378eSBarry Smith   Notes:
396255849f57SBarry Smith    The type is determined by the data in the file, any type set into the DM before this call is ignored.
3963b859378eSBarry Smith 
3964b859378eSBarry Smith   Notes for advanced users:
3965b859378eSBarry Smith   Most users should not need to know the details of the binary storage
3966b859378eSBarry Smith   format, since DMLoad() and DMView() completely hide these details.
3967b859378eSBarry Smith   But for anyone who's interested, the standard binary matrix storage
3968b859378eSBarry Smith   format is
3969b859378eSBarry Smith .vb
3970b859378eSBarry Smith      has not yet been determined
3971b859378eSBarry Smith .ve
3972b859378eSBarry Smith 
3973b859378eSBarry Smith .seealso: PetscViewerBinaryOpen(), DMView(), MatLoad(), VecLoad()
3974b859378eSBarry Smith @*/
3975b859378eSBarry Smith PetscErrorCode  DMLoad(DM newdm, PetscViewer viewer)
3976b859378eSBarry Smith {
39779331c7a4SMatthew G. Knepley   PetscBool      isbinary, ishdf5;
3978b859378eSBarry Smith   PetscErrorCode ierr;
3979b859378eSBarry Smith 
3980b859378eSBarry Smith   PetscFunctionBegin;
3981b859378eSBarry Smith   PetscValidHeaderSpecific(newdm,DM_CLASSID,1);
3982b859378eSBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
3983fb694a9eSVaclav Hapla   ierr = PetscViewerCheckReadable(viewer);CHKERRQ(ierr);
398432c0f0efSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
39859331c7a4SMatthew G. Knepley   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERHDF5,&ishdf5);CHKERRQ(ierr);
398658cd63d5SVaclav Hapla   ierr = PetscLogEventBegin(DM_Load,viewer,0,0,0);CHKERRQ(ierr);
39879331c7a4SMatthew G. Knepley   if (isbinary) {
39889331c7a4SMatthew G. Knepley     PetscInt classid;
39899331c7a4SMatthew G. Knepley     char     type[256];
3990b859378eSBarry Smith 
3991060da220SMatthew G. Knepley     ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr);
39929200755eSBarry Smith     if (classid != DM_FILE_CLASSID) SETERRQ1(PetscObjectComm((PetscObject)newdm),PETSC_ERR_ARG_WRONG,"Not DM next in file, classid found %d",(int)classid);
3993060da220SMatthew G. Knepley     ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr);
399432c0f0efSBarry Smith     ierr = DMSetType(newdm, type);CHKERRQ(ierr);
39959331c7a4SMatthew G. Knepley     if (newdm->ops->load) {ierr = (*newdm->ops->load)(newdm,viewer);CHKERRQ(ierr);}
39969331c7a4SMatthew G. Knepley   } else if (ishdf5) {
39979331c7a4SMatthew G. Knepley     if (newdm->ops->load) {ierr = (*newdm->ops->load)(newdm,viewer);CHKERRQ(ierr);}
39989331c7a4SMatthew G. Knepley   } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen() or PetscViewerHDF5Open()");
399958cd63d5SVaclav Hapla   ierr = PetscLogEventEnd(DM_Load,viewer,0,0,0);CHKERRQ(ierr);
4000b859378eSBarry Smith   PetscFunctionReturn(0);
4001b859378eSBarry Smith }
4002b859378eSBarry Smith 
4003b2e4378dSMatthew G. Knepley /*@
4004b2e4378dSMatthew G. Knepley   DMGetLocalBoundingBox - Returns the bounding box for the piece of the DM on this process.
4005b2e4378dSMatthew G. Knepley 
4006b2e4378dSMatthew G. Knepley   Not collective
4007b2e4378dSMatthew G. Knepley 
4008b2e4378dSMatthew G. Knepley   Input Parameter:
4009b2e4378dSMatthew G. Knepley . dm - the DM
4010b2e4378dSMatthew G. Knepley 
4011b2e4378dSMatthew G. Knepley   Output Parameters:
4012b2e4378dSMatthew G. Knepley + lmin - local minimum coordinates (length coord dim, optional)
4013b2e4378dSMatthew G. Knepley - lmax - local maximim coordinates (length coord dim, optional)
4014b2e4378dSMatthew G. Knepley 
4015b2e4378dSMatthew G. Knepley   Level: beginner
4016b2e4378dSMatthew G. Knepley 
4017b2e4378dSMatthew G. Knepley   Note: If the DM is a DMDA and has no coordinates, the index bounds are returned instead.
4018b2e4378dSMatthew G. Knepley 
4019b2e4378dSMatthew G. Knepley .seealso: DMGetCoordinates(), DMGetCoordinatesLocal(), DMGetBoundingBox()
4020b2e4378dSMatthew G. Knepley @*/
4021b2e4378dSMatthew G. Knepley PetscErrorCode DMGetLocalBoundingBox(DM dm, PetscReal lmin[], PetscReal lmax[])
4022b2e4378dSMatthew G. Knepley {
4023b2e4378dSMatthew G. Knepley   Vec                coords = NULL;
4024b2e4378dSMatthew G. Knepley   PetscReal          min[3] = {PETSC_MAX_REAL, PETSC_MAX_REAL, PETSC_MAX_REAL};
4025b2e4378dSMatthew G. Knepley   PetscReal          max[3] = {PETSC_MIN_REAL, PETSC_MIN_REAL, PETSC_MIN_REAL};
4026b2e4378dSMatthew G. Knepley   const PetscScalar *local_coords;
4027b2e4378dSMatthew G. Knepley   PetscInt           N, Ni;
4028b2e4378dSMatthew G. Knepley   PetscInt           cdim, i, j;
4029b2e4378dSMatthew G. Knepley   PetscErrorCode     ierr;
4030b2e4378dSMatthew G. Knepley 
4031b2e4378dSMatthew G. Knepley   PetscFunctionBegin;
4032b2e4378dSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4033b2e4378dSMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
4034b2e4378dSMatthew G. Knepley   ierr = DMGetCoordinates(dm, &coords);CHKERRQ(ierr);
4035b2e4378dSMatthew G. Knepley   if (coords) {
4036b2e4378dSMatthew G. Knepley     ierr = VecGetArrayRead(coords, &local_coords);CHKERRQ(ierr);
4037b2e4378dSMatthew G. Knepley     ierr = VecGetLocalSize(coords, &N);CHKERRQ(ierr);
4038b2e4378dSMatthew G. Knepley     Ni   = N/cdim;
4039b2e4378dSMatthew G. Knepley     for (i = 0; i < Ni; ++i) {
4040b2e4378dSMatthew G. Knepley       for (j = 0; j < 3; ++j) {
4041b2e4378dSMatthew G. Knepley         min[j] = j < cdim ? PetscMin(min[j], PetscRealPart(local_coords[i*cdim+j])) : 0;
4042b2e4378dSMatthew G. Knepley         max[j] = j < cdim ? PetscMax(max[j], PetscRealPart(local_coords[i*cdim+j])) : 0;
4043b2e4378dSMatthew G. Knepley       }
4044b2e4378dSMatthew G. Knepley     }
4045b2e4378dSMatthew G. Knepley     ierr = VecRestoreArrayRead(coords, &local_coords);CHKERRQ(ierr);
4046b2e4378dSMatthew G. Knepley   } else {
4047b2e4378dSMatthew G. Knepley     PetscBool isda;
4048b2e4378dSMatthew G. Knepley 
4049b2e4378dSMatthew G. Knepley     ierr = PetscObjectTypeCompare((PetscObject) dm, DMDA, &isda);CHKERRQ(ierr);
4050b2e4378dSMatthew G. Knepley     if (isda) {ierr = DMGetLocalBoundingIndices_DMDA(dm, min, max);CHKERRQ(ierr);}
4051b2e4378dSMatthew G. Knepley   }
4052b2e4378dSMatthew G. Knepley   if (lmin) {ierr = PetscArraycpy(lmin, min, cdim);CHKERRQ(ierr);}
4053b2e4378dSMatthew G. Knepley   if (lmax) {ierr = PetscArraycpy(lmax, max, cdim);CHKERRQ(ierr);}
4054b2e4378dSMatthew G. Knepley   PetscFunctionReturn(0);
4055b2e4378dSMatthew G. Knepley }
4056b2e4378dSMatthew G. Knepley 
4057b2e4378dSMatthew G. Knepley /*@
4058b2e4378dSMatthew G. Knepley   DMGetBoundingBox - Returns the global bounding box for the DM.
4059b2e4378dSMatthew G. Knepley 
4060b2e4378dSMatthew G. Knepley   Collective
4061b2e4378dSMatthew G. Knepley 
4062b2e4378dSMatthew G. Knepley   Input Parameter:
4063b2e4378dSMatthew G. Knepley . dm - the DM
4064b2e4378dSMatthew G. Knepley 
4065b2e4378dSMatthew G. Knepley   Output Parameters:
4066b2e4378dSMatthew G. Knepley + gmin - global minimum coordinates (length coord dim, optional)
4067b2e4378dSMatthew G. Knepley - gmax - global maximim coordinates (length coord dim, optional)
4068b2e4378dSMatthew G. Knepley 
4069b2e4378dSMatthew G. Knepley   Level: beginner
4070b2e4378dSMatthew G. Knepley 
4071b2e4378dSMatthew G. Knepley .seealso: DMGetLocalBoundingBox(), DMGetCoordinates(), DMGetCoordinatesLocal()
4072b2e4378dSMatthew G. Knepley @*/
4073b2e4378dSMatthew G. Knepley PetscErrorCode DMGetBoundingBox(DM dm, PetscReal gmin[], PetscReal gmax[])
4074b2e4378dSMatthew G. Knepley {
4075b2e4378dSMatthew G. Knepley   PetscReal      lmin[3], lmax[3];
40766ce308c4SMatthew G. Knepley   PetscInt       cdim;
40776ce308c4SMatthew G. Knepley   PetscMPIInt    count;
4078b2e4378dSMatthew G. Knepley   PetscErrorCode ierr;
4079b2e4378dSMatthew G. Knepley 
4080b2e4378dSMatthew G. Knepley   PetscFunctionBegin;
4081b2e4378dSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4082b2e4378dSMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
4083b2e4378dSMatthew G. Knepley   ierr = PetscMPIIntCast(cdim, &count);CHKERRQ(ierr);
4084b2e4378dSMatthew G. Knepley   ierr = DMGetLocalBoundingBox(dm, lmin, lmax);CHKERRQ(ierr);
4085820f2d46SBarry Smith   if (gmin) {ierr = MPIU_Allreduce(lmin, gmin, count, MPIU_REAL, MPIU_MIN, PetscObjectComm((PetscObject) dm));CHKERRMPI(ierr);}
4086820f2d46SBarry Smith   if (gmax) {ierr = MPIU_Allreduce(lmax, gmax, count, MPIU_REAL, MPIU_MAX, PetscObjectComm((PetscObject) dm));CHKERRMPI(ierr);}
4087b2e4378dSMatthew G. Knepley   PetscFunctionReturn(0);
4088b2e4378dSMatthew G. Knepley }
4089b2e4378dSMatthew G. Knepley 
40907da65231SMatthew G Knepley /******************************** FEM Support **********************************/
40917da65231SMatthew G Knepley 
4092a6dfd86eSKarl Rupp PetscErrorCode DMPrintCellVector(PetscInt c, const char name[], PetscInt len, const PetscScalar x[])
4093a6dfd86eSKarl Rupp {
40941d47ebbbSSatish Balay   PetscInt       f;
40951b30c384SMatthew G Knepley   PetscErrorCode ierr;
40961b30c384SMatthew G Knepley 
40977da65231SMatthew G Knepley   PetscFunctionBegin;
409874778d6cSJed Brown   ierr = PetscPrintf(PETSC_COMM_SELF, "Cell %D Element %s\n", c, name);CHKERRQ(ierr);
40991d47ebbbSSatish Balay   for (f = 0; f < len; ++f) {
410057622a8eSBarry Smith     ierr = PetscPrintf(PETSC_COMM_SELF, "  | %g |\n", (double)PetscRealPart(x[f]));CHKERRQ(ierr);
41017da65231SMatthew G Knepley   }
41027da65231SMatthew G Knepley   PetscFunctionReturn(0);
41037da65231SMatthew G Knepley }
41047da65231SMatthew G Knepley 
4105a6dfd86eSKarl Rupp PetscErrorCode DMPrintCellMatrix(PetscInt c, const char name[], PetscInt rows, PetscInt cols, const PetscScalar A[])
4106a6dfd86eSKarl Rupp {
41071b30c384SMatthew G Knepley   PetscInt       f, g;
41087da65231SMatthew G Knepley   PetscErrorCode ierr;
41097da65231SMatthew G Knepley 
41107da65231SMatthew G Knepley   PetscFunctionBegin;
411174778d6cSJed Brown   ierr = PetscPrintf(PETSC_COMM_SELF, "Cell %D Element %s\n", c, name);CHKERRQ(ierr);
41121d47ebbbSSatish Balay   for (f = 0; f < rows; ++f) {
411374778d6cSJed Brown     ierr = PetscPrintf(PETSC_COMM_SELF, "  |");CHKERRQ(ierr);
41141d47ebbbSSatish Balay     for (g = 0; g < cols; ++g) {
4115e3556bceSMatthew G. Knepley       ierr = PetscPrintf(PETSC_COMM_SELF, " % 9.5g", PetscRealPart(A[f*cols+g]));CHKERRQ(ierr);
41167da65231SMatthew G Knepley     }
411774778d6cSJed Brown     ierr = PetscPrintf(PETSC_COMM_SELF, " |\n");CHKERRQ(ierr);
41187da65231SMatthew G Knepley   }
41197da65231SMatthew G Knepley   PetscFunctionReturn(0);
41207da65231SMatthew G Knepley }
4121e7c4fc90SDmitry Karpeev 
41226113b454SMatthew G. Knepley PetscErrorCode DMPrintLocalVec(DM dm, const char name[], PetscReal tol, Vec X)
4123e759306cSMatthew G. Knepley {
41240c5b8624SToby Isaac   PetscInt          localSize, bs;
41250c5b8624SToby Isaac   PetscMPIInt       size;
41260c5b8624SToby Isaac   Vec               x, xglob;
41270c5b8624SToby Isaac   const PetscScalar *xarray;
4128e759306cSMatthew G. Knepley   PetscErrorCode    ierr;
4129e759306cSMatthew G. Knepley 
4130e759306cSMatthew G. Knepley   PetscFunctionBegin;
4131ffc4695bSBarry Smith   ierr = MPI_Comm_size(PetscObjectComm((PetscObject) dm),&size);CHKERRMPI(ierr);
4132e759306cSMatthew G. Knepley   ierr = VecDuplicate(X, &x);CHKERRQ(ierr);
4133e759306cSMatthew G. Knepley   ierr = VecCopy(X, x);CHKERRQ(ierr);
41346113b454SMatthew G. Knepley   ierr = VecChop(x, tol);CHKERRQ(ierr);
41350c5b8624SToby Isaac   ierr = PetscPrintf(PetscObjectComm((PetscObject) dm),"%s:\n",name);CHKERRQ(ierr);
41360c5b8624SToby Isaac   if (size > 1) {
41370c5b8624SToby Isaac     ierr = VecGetLocalSize(x,&localSize);CHKERRQ(ierr);
41380c5b8624SToby Isaac     ierr = VecGetArrayRead(x,&xarray);CHKERRQ(ierr);
41390c5b8624SToby Isaac     ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
41400c5b8624SToby Isaac     ierr = VecCreateMPIWithArray(PetscObjectComm((PetscObject) dm),bs,localSize,PETSC_DETERMINE,xarray,&xglob);CHKERRQ(ierr);
41410c5b8624SToby Isaac   } else {
41420c5b8624SToby Isaac     xglob = x;
41430c5b8624SToby Isaac   }
41440c5b8624SToby Isaac   ierr = VecView(xglob,PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject) dm)));CHKERRQ(ierr);
41450c5b8624SToby Isaac   if (size > 1) {
41460c5b8624SToby Isaac     ierr = VecDestroy(&xglob);CHKERRQ(ierr);
41470c5b8624SToby Isaac     ierr = VecRestoreArrayRead(x,&xarray);CHKERRQ(ierr);
41480c5b8624SToby Isaac   }
4149e759306cSMatthew G. Knepley   ierr = VecDestroy(&x);CHKERRQ(ierr);
4150e759306cSMatthew G. Knepley   PetscFunctionReturn(0);
4151e759306cSMatthew G. Knepley }
4152e759306cSMatthew G. Knepley 
415388ed4aceSMatthew G Knepley /*@
41541bb6d2a8SBarry Smith   DMGetSection - Get the PetscSection encoding the local data layout for the DM.   This is equivalent to DMGetLocalSection(). Deprecated in v3.12
4155061576a5SJed Brown 
4156061576a5SJed Brown   Input Parameter:
4157061576a5SJed Brown . dm - The DM
4158061576a5SJed Brown 
4159061576a5SJed Brown   Output Parameter:
4160061576a5SJed Brown . section - The PetscSection
4161061576a5SJed Brown 
4162061576a5SJed Brown   Options Database Keys:
4163061576a5SJed Brown . -dm_petscsection_view - View the Section created by the DM
4164061576a5SJed Brown 
4165061576a5SJed Brown   Level: advanced
4166061576a5SJed Brown 
4167061576a5SJed Brown   Notes:
4168061576a5SJed Brown   Use DMGetLocalSection() in new code.
4169061576a5SJed Brown 
4170061576a5SJed Brown   This gets a borrowed reference, so the user should not destroy this PetscSection.
4171061576a5SJed Brown 
4172061576a5SJed Brown .seealso: DMGetLocalSection(), DMSetLocalSection(), DMGetGlobalSection()
4173061576a5SJed Brown @*/
4174061576a5SJed Brown PetscErrorCode DMGetSection(DM dm, PetscSection *section)
4175061576a5SJed Brown {
4176061576a5SJed Brown   PetscErrorCode ierr;
4177061576a5SJed Brown 
4178061576a5SJed Brown   PetscFunctionBegin;
4179061576a5SJed Brown   ierr = DMGetLocalSection(dm,section);CHKERRQ(ierr);
4180061576a5SJed Brown   PetscFunctionReturn(0);
4181061576a5SJed Brown }
4182061576a5SJed Brown 
4183061576a5SJed Brown /*@
4184061576a5SJed Brown   DMGetLocalSection - Get the PetscSection encoding the local data layout for the DM.
418588ed4aceSMatthew G Knepley 
418688ed4aceSMatthew G Knepley   Input Parameter:
418788ed4aceSMatthew G Knepley . dm - The DM
418888ed4aceSMatthew G Knepley 
418988ed4aceSMatthew G Knepley   Output Parameter:
419088ed4aceSMatthew G Knepley . section - The PetscSection
419188ed4aceSMatthew G Knepley 
4192e5893cccSMatthew G. Knepley   Options Database Keys:
4193e5893cccSMatthew G. Knepley . -dm_petscsection_view - View the Section created by the DM
4194e5893cccSMatthew G. Knepley 
419588ed4aceSMatthew G Knepley   Level: intermediate
419688ed4aceSMatthew G Knepley 
419788ed4aceSMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSection.
419888ed4aceSMatthew G Knepley 
4199061576a5SJed Brown .seealso: DMSetLocalSection(), DMGetGlobalSection()
420088ed4aceSMatthew G Knepley @*/
4201061576a5SJed Brown PetscErrorCode DMGetLocalSection(DM dm, PetscSection *section)
42020adebc6cSBarry Smith {
4203fd59a867SMatthew G. Knepley   PetscErrorCode ierr;
4204fd59a867SMatthew G. Knepley 
420588ed4aceSMatthew G Knepley   PetscFunctionBegin;
420688ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
420788ed4aceSMatthew G Knepley   PetscValidPointer(section, 2);
42081bb6d2a8SBarry Smith   if (!dm->localSection && dm->ops->createlocalsection) {
4209e5e52638SMatthew G. Knepley     PetscInt d;
4210e5e52638SMatthew G. Knepley 
421145480ffeSMatthew G. Knepley     if (dm->setfromoptionscalled) {
421245480ffeSMatthew G. Knepley       PetscObject       obj = (PetscObject) dm;
421345480ffeSMatthew G. Knepley       PetscViewer       viewer;
421445480ffeSMatthew G. Knepley       PetscViewerFormat format;
421545480ffeSMatthew G. Knepley       PetscBool         flg;
421645480ffeSMatthew G. Knepley 
421745480ffeSMatthew G. Knepley       ierr = PetscOptionsGetViewer(PetscObjectComm(obj), obj->options, obj->prefix, "-dm_petscds_view", &viewer, &format, &flg);CHKERRQ(ierr);
421845480ffeSMatthew G. Knepley       if (flg) {ierr = PetscViewerPushFormat(viewer, format);CHKERRQ(ierr);}
421945480ffeSMatthew G. Knepley       for (d = 0; d < dm->Nds; ++d) {
422045480ffeSMatthew G. Knepley         ierr = PetscDSSetFromOptions(dm->probs[d].ds);CHKERRQ(ierr);
422145480ffeSMatthew G. Knepley         if (flg) {ierr = PetscDSView(dm->probs[d].ds, viewer);CHKERRQ(ierr);}
422245480ffeSMatthew G. Knepley       }
422345480ffeSMatthew G. Knepley       if (flg) {
422445480ffeSMatthew G. Knepley         ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
422545480ffeSMatthew G. Knepley         ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
422645480ffeSMatthew G. Knepley         ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
422745480ffeSMatthew G. Knepley       }
422845480ffeSMatthew G. Knepley     }
42291bb6d2a8SBarry Smith     ierr = (*dm->ops->createlocalsection)(dm);CHKERRQ(ierr);
42301bb6d2a8SBarry Smith     if (dm->localSection) {ierr = PetscObjectViewFromOptions((PetscObject) dm->localSection, NULL, "-dm_petscsection_view");CHKERRQ(ierr);}
42312f0f8703SMatthew G. Knepley   }
42321bb6d2a8SBarry Smith   *section = dm->localSection;
423388ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
423488ed4aceSMatthew G Knepley }
423588ed4aceSMatthew G Knepley 
423688ed4aceSMatthew G Knepley /*@
42371bb6d2a8SBarry Smith   DMSetSection - Set the PetscSection encoding the local data layout for the DM.  This is equivalent to DMSetLocalSection(). Deprecated in v3.12
4238061576a5SJed Brown 
4239061576a5SJed Brown   Input Parameters:
4240061576a5SJed Brown + dm - The DM
4241061576a5SJed Brown - section - The PetscSection
4242061576a5SJed Brown 
4243061576a5SJed Brown   Level: advanced
4244061576a5SJed Brown 
4245061576a5SJed Brown   Notes:
4246061576a5SJed Brown   Use DMSetLocalSection() in new code.
4247061576a5SJed Brown 
4248061576a5SJed Brown   Any existing Section will be destroyed
4249061576a5SJed Brown 
4250061576a5SJed Brown .seealso: DMSetLocalSection(), DMGetLocalSection(), DMSetGlobalSection()
4251061576a5SJed Brown @*/
4252061576a5SJed Brown PetscErrorCode DMSetSection(DM dm, PetscSection section)
4253061576a5SJed Brown {
4254061576a5SJed Brown   PetscErrorCode ierr;
4255061576a5SJed Brown 
4256061576a5SJed Brown   PetscFunctionBegin;
4257061576a5SJed Brown   ierr = DMSetLocalSection(dm,section);CHKERRQ(ierr);
4258061576a5SJed Brown   PetscFunctionReturn(0);
4259061576a5SJed Brown }
4260061576a5SJed Brown 
4261061576a5SJed Brown /*@
4262061576a5SJed Brown   DMSetLocalSection - Set the PetscSection encoding the local data layout for the DM.
426388ed4aceSMatthew G Knepley 
426488ed4aceSMatthew G Knepley   Input Parameters:
426588ed4aceSMatthew G Knepley + dm - The DM
426688ed4aceSMatthew G Knepley - section - The PetscSection
426788ed4aceSMatthew G Knepley 
426888ed4aceSMatthew G Knepley   Level: intermediate
426988ed4aceSMatthew G Knepley 
427088ed4aceSMatthew G Knepley   Note: Any existing Section will be destroyed
427188ed4aceSMatthew G Knepley 
4272061576a5SJed Brown .seealso: DMGetLocalSection(), DMSetGlobalSection()
427388ed4aceSMatthew G Knepley @*/
4274061576a5SJed Brown PetscErrorCode DMSetLocalSection(DM dm, PetscSection section)
42750adebc6cSBarry Smith {
4276c473ab19SMatthew G. Knepley   PetscInt       numFields = 0;
4277af122d2aSMatthew G Knepley   PetscInt       f;
427888ed4aceSMatthew G Knepley   PetscErrorCode ierr;
427988ed4aceSMatthew G Knepley 
428088ed4aceSMatthew G Knepley   PetscFunctionBegin;
428188ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4282b9d85ea2SLisandro Dalcin   if (section) PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2);
42831d799100SJed Brown   ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr);
42841bb6d2a8SBarry Smith   ierr = PetscSectionDestroy(&dm->localSection);CHKERRQ(ierr);
42851bb6d2a8SBarry Smith   dm->localSection = section;
42861bb6d2a8SBarry Smith   if (section) {ierr = PetscSectionGetNumFields(dm->localSection, &numFields);CHKERRQ(ierr);}
4287af122d2aSMatthew G Knepley   if (numFields) {
4288af122d2aSMatthew G Knepley     ierr = DMSetNumFields(dm, numFields);CHKERRQ(ierr);
4289af122d2aSMatthew G Knepley     for (f = 0; f < numFields; ++f) {
42900f21e855SMatthew G. Knepley       PetscObject disc;
4291af122d2aSMatthew G Knepley       const char *name;
4292af122d2aSMatthew G Knepley 
42931bb6d2a8SBarry Smith       ierr = PetscSectionGetFieldName(dm->localSection, f, &name);CHKERRQ(ierr);
429444a7f3ddSMatthew G. Knepley       ierr = DMGetField(dm, f, NULL, &disc);CHKERRQ(ierr);
42950f21e855SMatthew G. Knepley       ierr = PetscObjectSetName(disc, name);CHKERRQ(ierr);
4296af122d2aSMatthew G Knepley     }
4297af122d2aSMatthew G Knepley   }
4298e87a4003SBarry Smith   /* The global section will be rebuilt in the next call to DMGetGlobalSection(). */
42991bb6d2a8SBarry Smith   ierr = PetscSectionDestroy(&dm->globalSection);CHKERRQ(ierr);
430088ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
430188ed4aceSMatthew G Knepley }
430288ed4aceSMatthew G Knepley 
43039435951eSToby Isaac /*@
4304b7385021SStefano Zampini   DMGetDefaultConstraints - Get the PetscSection and Mat that specify the local constraint interpolation. See DMSetDefaultConstraints() for a description of the purpose of constraint interpolation.
43059435951eSToby Isaac 
4306e228b242SToby Isaac   not collective
4307e228b242SToby Isaac 
43089435951eSToby Isaac   Input Parameter:
43099435951eSToby Isaac . dm - The DM
43109435951eSToby Isaac 
4311d8d19677SJose E. Roman   Output Parameters:
43129435951eSToby 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.
43139435951eSToby 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.
43149435951eSToby Isaac 
43159435951eSToby Isaac   Level: advanced
43169435951eSToby Isaac 
43179435951eSToby Isaac   Note: This gets borrowed references, so the user should not destroy the PetscSection or the Mat.
43189435951eSToby Isaac 
43199435951eSToby Isaac .seealso: DMSetDefaultConstraints()
43209435951eSToby Isaac @*/
43219435951eSToby Isaac PetscErrorCode DMGetDefaultConstraints(DM dm, PetscSection *section, Mat *mat)
43229435951eSToby Isaac {
43239435951eSToby Isaac   PetscErrorCode ierr;
43249435951eSToby Isaac 
43259435951eSToby Isaac   PetscFunctionBegin;
43269435951eSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
43279435951eSToby Isaac   if (!dm->defaultConstraintSection && !dm->defaultConstraintMat && dm->ops->createdefaultconstraints) {ierr = (*dm->ops->createdefaultconstraints)(dm);CHKERRQ(ierr);}
432845a75d81SToby Isaac   if (section) {*section = dm->defaultConstraintSection;}
432945a75d81SToby Isaac   if (mat) {*mat = dm->defaultConstraintMat;}
43309435951eSToby Isaac   PetscFunctionReturn(0);
43319435951eSToby Isaac }
43329435951eSToby Isaac 
43339435951eSToby Isaac /*@
4334b7385021SStefano Zampini   DMSetDefaultConstraints - Set the PetscSection and Mat that specify the local constraint interpolation.
43359435951eSToby Isaac 
43369435951eSToby 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().
43379435951eSToby Isaac 
43389435951eSToby 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.
43399435951eSToby Isaac 
4340e228b242SToby Isaac   collective on dm
4341e228b242SToby Isaac 
43429435951eSToby Isaac   Input Parameters:
43439435951eSToby Isaac + dm - The DM
4344e228b242SToby 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).
4345e228b242SToby 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).
43469435951eSToby Isaac 
43479435951eSToby Isaac   Level: advanced
43489435951eSToby Isaac 
43499435951eSToby Isaac   Note: This increments the references of the PetscSection and the Mat, so they user can destroy them
43509435951eSToby Isaac 
43519435951eSToby Isaac .seealso: DMGetDefaultConstraints()
43529435951eSToby Isaac @*/
43539435951eSToby Isaac PetscErrorCode DMSetDefaultConstraints(DM dm, PetscSection section, Mat mat)
43549435951eSToby Isaac {
4355e228b242SToby Isaac   PetscMPIInt result;
43569435951eSToby Isaac   PetscErrorCode ierr;
43579435951eSToby Isaac 
43589435951eSToby Isaac   PetscFunctionBegin;
43599435951eSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4360e228b242SToby Isaac   if (section) {
4361e228b242SToby Isaac     PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2);
4362ffc4695bSBarry Smith     ierr = MPI_Comm_compare(PETSC_COMM_SELF,PetscObjectComm((PetscObject)section),&result);CHKERRMPI(ierr);
4363f60917d2SBarry Smith     if (result != MPI_CONGRUENT && result != MPI_IDENT) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NOTSAMECOMM,"constraint section must have local communicator");
4364e228b242SToby Isaac   }
4365e228b242SToby Isaac   if (mat) {
4366e228b242SToby Isaac     PetscValidHeaderSpecific(mat,MAT_CLASSID,3);
4367ffc4695bSBarry Smith     ierr = MPI_Comm_compare(PETSC_COMM_SELF,PetscObjectComm((PetscObject)mat),&result);CHKERRMPI(ierr);
4368f60917d2SBarry Smith     if (result != MPI_CONGRUENT && result != MPI_IDENT) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NOTSAMECOMM,"constraint matrix must have local communicator");
4369e228b242SToby Isaac   }
43709435951eSToby Isaac   ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr);
43719435951eSToby Isaac   ierr = PetscSectionDestroy(&dm->defaultConstraintSection);CHKERRQ(ierr);
43729435951eSToby Isaac   dm->defaultConstraintSection = section;
43739435951eSToby Isaac   ierr = PetscObjectReference((PetscObject)mat);CHKERRQ(ierr);
43749435951eSToby Isaac   ierr = MatDestroy(&dm->defaultConstraintMat);CHKERRQ(ierr);
43759435951eSToby Isaac   dm->defaultConstraintMat = mat;
43769435951eSToby Isaac   PetscFunctionReturn(0);
43779435951eSToby Isaac }
43789435951eSToby Isaac 
4379497880caSRichard Tran Mills #if defined(PETSC_USE_DEBUG)
4380507e4973SMatthew G. Knepley /*
4381507e4973SMatthew G. Knepley   DMDefaultSectionCheckConsistency - Check the consistentcy of the global and local sections.
4382507e4973SMatthew G. Knepley 
4383507e4973SMatthew G. Knepley   Input Parameters:
4384507e4973SMatthew G. Knepley + dm - The DM
4385507e4973SMatthew G. Knepley . localSection - PetscSection describing the local data layout
4386507e4973SMatthew G. Knepley - globalSection - PetscSection describing the global data layout
4387507e4973SMatthew G. Knepley 
4388507e4973SMatthew G. Knepley   Level: intermediate
4389507e4973SMatthew G. Knepley 
43901bb6d2a8SBarry Smith .seealso: DMGetSectionSF(), DMSetSectionSF()
4391507e4973SMatthew G. Knepley */
4392f741bcd2SMatthew G. Knepley static PetscErrorCode DMDefaultSectionCheckConsistency_Internal(DM dm, PetscSection localSection, PetscSection globalSection)
4393507e4973SMatthew G. Knepley {
4394507e4973SMatthew G. Knepley   MPI_Comm        comm;
4395507e4973SMatthew G. Knepley   PetscLayout     layout;
4396507e4973SMatthew G. Knepley   const PetscInt *ranges;
4397507e4973SMatthew G. Knepley   PetscInt        pStart, pEnd, p, nroots;
4398507e4973SMatthew G. Knepley   PetscMPIInt     size, rank;
4399507e4973SMatthew G. Knepley   PetscBool       valid = PETSC_TRUE, gvalid;
4400507e4973SMatthew G. Knepley   PetscErrorCode  ierr;
4401507e4973SMatthew G. Knepley 
4402507e4973SMatthew G. Knepley   PetscFunctionBegin;
4403507e4973SMatthew G. Knepley   ierr = PetscObjectGetComm((PetscObject)dm,&comm);CHKERRQ(ierr);
4404507e4973SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4405ffc4695bSBarry Smith   ierr = MPI_Comm_size(comm, &size);CHKERRMPI(ierr);
4406ffc4695bSBarry Smith   ierr = MPI_Comm_rank(comm, &rank);CHKERRMPI(ierr);
4407507e4973SMatthew G. Knepley   ierr = PetscSectionGetChart(globalSection, &pStart, &pEnd);CHKERRQ(ierr);
4408507e4973SMatthew G. Knepley   ierr = PetscSectionGetConstrainedStorageSize(globalSection, &nroots);CHKERRQ(ierr);
4409507e4973SMatthew G. Knepley   ierr = PetscLayoutCreate(comm, &layout);CHKERRQ(ierr);
4410507e4973SMatthew G. Knepley   ierr = PetscLayoutSetBlockSize(layout, 1);CHKERRQ(ierr);
4411507e4973SMatthew G. Knepley   ierr = PetscLayoutSetLocalSize(layout, nroots);CHKERRQ(ierr);
4412507e4973SMatthew G. Knepley   ierr = PetscLayoutSetUp(layout);CHKERRQ(ierr);
4413507e4973SMatthew G. Knepley   ierr = PetscLayoutGetRanges(layout, &ranges);CHKERRQ(ierr);
4414507e4973SMatthew G. Knepley   for (p = pStart; p < pEnd; ++p) {
4415f741bcd2SMatthew G. Knepley     PetscInt       dof, cdof, off, gdof, gcdof, goff, gsize, d;
4416507e4973SMatthew G. Knepley 
4417507e4973SMatthew G. Knepley     ierr = PetscSectionGetDof(localSection, p, &dof);CHKERRQ(ierr);
4418507e4973SMatthew G. Knepley     ierr = PetscSectionGetOffset(localSection, p, &off);CHKERRQ(ierr);
4419507e4973SMatthew G. Knepley     ierr = PetscSectionGetConstraintDof(localSection, p, &cdof);CHKERRQ(ierr);
4420507e4973SMatthew G. Knepley     ierr = PetscSectionGetDof(globalSection, p, &gdof);CHKERRQ(ierr);
4421507e4973SMatthew G. Knepley     ierr = PetscSectionGetConstraintDof(globalSection, p, &gcdof);CHKERRQ(ierr);
4422507e4973SMatthew G. Knepley     ierr = PetscSectionGetOffset(globalSection, p, &goff);CHKERRQ(ierr);
4423507e4973SMatthew G. Knepley     if (!gdof) continue; /* Censored point */
4424507e4973SMatthew 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;}
4425507e4973SMatthew 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;}
4426507e4973SMatthew G. Knepley     if (gdof < 0) {
4427507e4973SMatthew G. Knepley       gsize = gdof < 0 ? -(gdof+1)-gcdof : gdof-gcdof;
4428507e4973SMatthew G. Knepley       for (d = 0; d < gsize; ++d) {
4429507e4973SMatthew G. Knepley         PetscInt offset = -(goff+1) + d, r;
4430507e4973SMatthew G. Knepley 
4431507e4973SMatthew G. Knepley         ierr = PetscFindInt(offset,size+1,ranges,&r);CHKERRQ(ierr);
4432507e4973SMatthew G. Knepley         if (r < 0) r = -(r+2);
4433507e4973SMatthew 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;}
4434507e4973SMatthew G. Knepley       }
4435507e4973SMatthew G. Knepley     }
4436507e4973SMatthew G. Knepley   }
4437507e4973SMatthew G. Knepley   ierr = PetscLayoutDestroy(&layout);CHKERRQ(ierr);
4438507e4973SMatthew G. Knepley   ierr = PetscSynchronizedFlush(comm, NULL);CHKERRQ(ierr);
4439820f2d46SBarry Smith   ierr = MPIU_Allreduce(&valid, &gvalid, 1, MPIU_BOOL, MPI_LAND, comm);CHKERRMPI(ierr);
4440507e4973SMatthew G. Knepley   if (!gvalid) {
4441507e4973SMatthew G. Knepley     ierr = DMView(dm, NULL);CHKERRQ(ierr);
4442507e4973SMatthew G. Knepley     SETERRQ(comm, PETSC_ERR_ARG_WRONG, "Inconsistent local and global sections");
4443507e4973SMatthew G. Knepley   }
4444507e4973SMatthew G. Knepley   PetscFunctionReturn(0);
4445507e4973SMatthew G. Knepley }
4446f741bcd2SMatthew G. Knepley #endif
4447507e4973SMatthew G. Knepley 
444888ed4aceSMatthew G Knepley /*@
4449e87a4003SBarry Smith   DMGetGlobalSection - Get the PetscSection encoding the global data layout for the DM.
445088ed4aceSMatthew G Knepley 
4451d083f849SBarry Smith   Collective on dm
44528b1ab98fSJed Brown 
445388ed4aceSMatthew G Knepley   Input Parameter:
445488ed4aceSMatthew G Knepley . dm - The DM
445588ed4aceSMatthew G Knepley 
445688ed4aceSMatthew G Knepley   Output Parameter:
445788ed4aceSMatthew G Knepley . section - The PetscSection
445888ed4aceSMatthew G Knepley 
445988ed4aceSMatthew G Knepley   Level: intermediate
446088ed4aceSMatthew G Knepley 
446188ed4aceSMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSection.
446288ed4aceSMatthew G Knepley 
446392fd8e1eSJed Brown .seealso: DMSetLocalSection(), DMGetLocalSection()
446488ed4aceSMatthew G Knepley @*/
4465e87a4003SBarry Smith PetscErrorCode DMGetGlobalSection(DM dm, PetscSection *section)
44660adebc6cSBarry Smith {
446788ed4aceSMatthew G Knepley   PetscErrorCode ierr;
446888ed4aceSMatthew G Knepley 
446988ed4aceSMatthew G Knepley   PetscFunctionBegin;
447088ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
447188ed4aceSMatthew G Knepley   PetscValidPointer(section, 2);
44721bb6d2a8SBarry Smith   if (!dm->globalSection) {
4473fd59a867SMatthew G. Knepley     PetscSection s;
4474fd59a867SMatthew G. Knepley 
447592fd8e1eSJed Brown     ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr);
4476fd59a867SMatthew 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");
447733907cc2SStefano 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");
44781bb6d2a8SBarry Smith     ierr = PetscSectionCreateGlobalSection(s, dm->sf, PETSC_FALSE, PETSC_FALSE, &dm->globalSection);CHKERRQ(ierr);
4479cf06b437SMatthew G. Knepley     ierr = PetscLayoutDestroy(&dm->map);CHKERRQ(ierr);
44801bb6d2a8SBarry Smith     ierr = PetscSectionGetValueLayout(PetscObjectComm((PetscObject)dm), dm->globalSection, &dm->map);CHKERRQ(ierr);
44811bb6d2a8SBarry Smith     ierr = PetscSectionViewFromOptions(dm->globalSection, NULL, "-global_section_view");CHKERRQ(ierr);
448288ed4aceSMatthew G Knepley   }
44831bb6d2a8SBarry Smith   *section = dm->globalSection;
448488ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
448588ed4aceSMatthew G Knepley }
448688ed4aceSMatthew G Knepley 
4487b21d0597SMatthew G Knepley /*@
4488e87a4003SBarry Smith   DMSetGlobalSection - Set the PetscSection encoding the global data layout for the DM.
4489b21d0597SMatthew G Knepley 
4490b21d0597SMatthew G Knepley   Input Parameters:
4491b21d0597SMatthew G Knepley + dm - The DM
44925080bbdbSMatthew G Knepley - section - The PetscSection, or NULL
4493b21d0597SMatthew G Knepley 
4494b21d0597SMatthew G Knepley   Level: intermediate
4495b21d0597SMatthew G Knepley 
4496b21d0597SMatthew G Knepley   Note: Any existing Section will be destroyed
4497b21d0597SMatthew G Knepley 
449892fd8e1eSJed Brown .seealso: DMGetGlobalSection(), DMSetLocalSection()
4499b21d0597SMatthew G Knepley @*/
4500e87a4003SBarry Smith PetscErrorCode DMSetGlobalSection(DM dm, PetscSection section)
45010adebc6cSBarry Smith {
4502b21d0597SMatthew G Knepley   PetscErrorCode ierr;
4503b21d0597SMatthew G Knepley 
4504b21d0597SMatthew G Knepley   PetscFunctionBegin;
4505b21d0597SMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
45065080bbdbSMatthew G Knepley   if (section) PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2);
45071d799100SJed Brown   ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr);
45081bb6d2a8SBarry Smith   ierr = PetscSectionDestroy(&dm->globalSection);CHKERRQ(ierr);
45091bb6d2a8SBarry Smith   dm->globalSection = section;
4510497880caSRichard Tran Mills #if defined(PETSC_USE_DEBUG)
45111bb6d2a8SBarry Smith   if (section) {ierr = DMDefaultSectionCheckConsistency_Internal(dm, dm->localSection, section);CHKERRQ(ierr);}
4512507e4973SMatthew G. Knepley #endif
4513b21d0597SMatthew G Knepley   PetscFunctionReturn(0);
4514b21d0597SMatthew G Knepley }
4515b21d0597SMatthew G Knepley 
451688ed4aceSMatthew G Knepley /*@
45171bb6d2a8SBarry Smith   DMGetSectionSF - Get the PetscSF encoding the parallel dof overlap for the DM. If it has not been set,
451888ed4aceSMatthew G Knepley   it is created from the default PetscSection layouts in the DM.
451988ed4aceSMatthew G Knepley 
452088ed4aceSMatthew G Knepley   Input Parameter:
452188ed4aceSMatthew G Knepley . dm - The DM
452288ed4aceSMatthew G Knepley 
452388ed4aceSMatthew G Knepley   Output Parameter:
452488ed4aceSMatthew G Knepley . sf - The PetscSF
452588ed4aceSMatthew G Knepley 
452688ed4aceSMatthew G Knepley   Level: intermediate
452788ed4aceSMatthew G Knepley 
452888ed4aceSMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSF.
452988ed4aceSMatthew G Knepley 
45301bb6d2a8SBarry Smith .seealso: DMSetSectionSF(), DMCreateSectionSF()
453188ed4aceSMatthew G Knepley @*/
45321bb6d2a8SBarry Smith PetscErrorCode DMGetSectionSF(DM dm, PetscSF *sf)
45330adebc6cSBarry Smith {
453488ed4aceSMatthew G Knepley   PetscInt       nroots;
453588ed4aceSMatthew G Knepley   PetscErrorCode ierr;
453688ed4aceSMatthew G Knepley 
453788ed4aceSMatthew G Knepley   PetscFunctionBegin;
453888ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
453988ed4aceSMatthew G Knepley   PetscValidPointer(sf, 2);
45401bb6d2a8SBarry Smith   if (!dm->sectionSF) {
45411bb6d2a8SBarry Smith     ierr = PetscSFCreate(PetscObjectComm((PetscObject)dm),&dm->sectionSF);CHKERRQ(ierr);
454233907cc2SStefano Zampini   }
45431bb6d2a8SBarry Smith   ierr = PetscSFGetGraph(dm->sectionSF, &nroots, NULL, NULL, NULL);CHKERRQ(ierr);
454488ed4aceSMatthew G Knepley   if (nroots < 0) {
454588ed4aceSMatthew G Knepley     PetscSection section, gSection;
454688ed4aceSMatthew G Knepley 
454792fd8e1eSJed Brown     ierr = DMGetLocalSection(dm, &section);CHKERRQ(ierr);
454831ea6d37SMatthew G Knepley     if (section) {
4549e87a4003SBarry Smith       ierr = DMGetGlobalSection(dm, &gSection);CHKERRQ(ierr);
45501bb6d2a8SBarry Smith       ierr = DMCreateSectionSF(dm, section, gSection);CHKERRQ(ierr);
455131ea6d37SMatthew G Knepley     } else {
45520298fd71SBarry Smith       *sf = NULL;
455331ea6d37SMatthew G Knepley       PetscFunctionReturn(0);
455431ea6d37SMatthew G Knepley     }
455588ed4aceSMatthew G Knepley   }
45561bb6d2a8SBarry Smith   *sf = dm->sectionSF;
455788ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
455888ed4aceSMatthew G Knepley }
455988ed4aceSMatthew G Knepley 
456088ed4aceSMatthew G Knepley /*@
45611bb6d2a8SBarry Smith   DMSetSectionSF - Set the PetscSF encoding the parallel dof overlap for the DM
456288ed4aceSMatthew G Knepley 
456388ed4aceSMatthew G Knepley   Input Parameters:
456488ed4aceSMatthew G Knepley + dm - The DM
456588ed4aceSMatthew G Knepley - sf - The PetscSF
456688ed4aceSMatthew G Knepley 
456788ed4aceSMatthew G Knepley   Level: intermediate
456888ed4aceSMatthew G Knepley 
456988ed4aceSMatthew G Knepley   Note: Any previous SF is destroyed
457088ed4aceSMatthew G Knepley 
45711bb6d2a8SBarry Smith .seealso: DMGetSectionSF(), DMCreateSectionSF()
457288ed4aceSMatthew G Knepley @*/
45731bb6d2a8SBarry Smith PetscErrorCode DMSetSectionSF(DM dm, PetscSF sf)
45740adebc6cSBarry Smith {
457588ed4aceSMatthew G Knepley   PetscErrorCode ierr;
457688ed4aceSMatthew G Knepley 
457788ed4aceSMatthew G Knepley   PetscFunctionBegin;
457888ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4579b9d85ea2SLisandro Dalcin   if (sf) PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
458033907cc2SStefano Zampini   ierr = PetscObjectReference((PetscObject) sf);CHKERRQ(ierr);
45811bb6d2a8SBarry Smith   ierr = PetscSFDestroy(&dm->sectionSF);CHKERRQ(ierr);
45821bb6d2a8SBarry Smith   dm->sectionSF = sf;
458388ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
458488ed4aceSMatthew G Knepley }
458588ed4aceSMatthew G Knepley 
458688ed4aceSMatthew G Knepley /*@C
45871bb6d2a8SBarry Smith   DMCreateSectionSF - Create the PetscSF encoding the parallel dof overlap for the DM based upon the PetscSections
458888ed4aceSMatthew G Knepley   describing the data layout.
458988ed4aceSMatthew G Knepley 
459088ed4aceSMatthew G Knepley   Input Parameters:
459188ed4aceSMatthew G Knepley + dm - The DM
459288ed4aceSMatthew G Knepley . localSection - PetscSection describing the local data layout
459388ed4aceSMatthew G Knepley - globalSection - PetscSection describing the global data layout
459488ed4aceSMatthew G Knepley 
45951bb6d2a8SBarry Smith   Notes: One usually uses DMGetSectionSF() to obtain the PetscSF
459688ed4aceSMatthew G Knepley 
45971bb6d2a8SBarry Smith   Level: developer
45981bb6d2a8SBarry Smith 
45991bb6d2a8SBarry Smith   Developer Note: Since this routine has for arguments the two sections from the DM and puts the resulting PetscSF
46001bb6d2a8SBarry Smith                   directly into the DM, perhaps this function should not take the local and global sections as
46011bb6d2a8SBarry Smith                   input and should just obtain them from the DM?
46021bb6d2a8SBarry Smith 
46031bb6d2a8SBarry Smith .seealso: DMGetSectionSF(), DMSetSectionSF(), DMGetLocalSection(), DMGetGlobalSection()
460488ed4aceSMatthew G Knepley @*/
46051bb6d2a8SBarry Smith PetscErrorCode DMCreateSectionSF(DM dm, PetscSection localSection, PetscSection globalSection)
460688ed4aceSMatthew G Knepley {
460788ed4aceSMatthew G Knepley   PetscErrorCode ierr;
460888ed4aceSMatthew G Knepley 
460988ed4aceSMatthew G Knepley   PetscFunctionBegin;
461088ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4611b0c7db22SLisandro Dalcin   ierr = PetscSFSetGraphSection(dm->sectionSF, localSection, globalSection);CHKERRQ(ierr);
461288ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
461388ed4aceSMatthew G Knepley }
4614af122d2aSMatthew G Knepley 
4615b21d0597SMatthew G Knepley /*@
4616b21d0597SMatthew G Knepley   DMGetPointSF - Get the PetscSF encoding the parallel section point overlap for the DM.
4617b21d0597SMatthew G Knepley 
4618b21d0597SMatthew G Knepley   Input Parameter:
4619b21d0597SMatthew G Knepley . dm - The DM
4620b21d0597SMatthew G Knepley 
4621b21d0597SMatthew G Knepley   Output Parameter:
4622b21d0597SMatthew G Knepley . sf - The PetscSF
4623b21d0597SMatthew G Knepley 
4624b21d0597SMatthew G Knepley   Level: intermediate
4625b21d0597SMatthew G Knepley 
4626b21d0597SMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSF.
4627b21d0597SMatthew G Knepley 
46281bb6d2a8SBarry Smith .seealso: DMSetPointSF(), DMGetSectionSF(), DMSetSectionSF(), DMCreateSectionSF()
4629b21d0597SMatthew G Knepley @*/
46300adebc6cSBarry Smith PetscErrorCode DMGetPointSF(DM dm, PetscSF *sf)
46310adebc6cSBarry Smith {
4632b21d0597SMatthew G Knepley   PetscFunctionBegin;
4633b21d0597SMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4634b21d0597SMatthew G Knepley   PetscValidPointer(sf, 2);
4635b21d0597SMatthew G Knepley   *sf = dm->sf;
4636b21d0597SMatthew G Knepley   PetscFunctionReturn(0);
4637b21d0597SMatthew G Knepley }
4638b21d0597SMatthew G Knepley 
4639057b4bcdSMatthew G Knepley /*@
4640057b4bcdSMatthew G Knepley   DMSetPointSF - Set the PetscSF encoding the parallel section point overlap for the DM.
4641057b4bcdSMatthew G Knepley 
4642057b4bcdSMatthew G Knepley   Input Parameters:
4643057b4bcdSMatthew G Knepley + dm - The DM
4644057b4bcdSMatthew G Knepley - sf - The PetscSF
4645057b4bcdSMatthew G Knepley 
4646057b4bcdSMatthew G Knepley   Level: intermediate
4647057b4bcdSMatthew G Knepley 
46481bb6d2a8SBarry Smith .seealso: DMGetPointSF(), DMGetSectionSF(), DMSetSectionSF(), DMCreateSectionSF()
4649057b4bcdSMatthew G Knepley @*/
46500adebc6cSBarry Smith PetscErrorCode DMSetPointSF(DM dm, PetscSF sf)
46510adebc6cSBarry Smith {
4652057b4bcdSMatthew G Knepley   PetscErrorCode ierr;
4653057b4bcdSMatthew G Knepley 
4654057b4bcdSMatthew G Knepley   PetscFunctionBegin;
4655057b4bcdSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4656b9d85ea2SLisandro Dalcin   if (sf) PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
4657057b4bcdSMatthew G Knepley   ierr = PetscObjectReference((PetscObject) sf);CHKERRQ(ierr);
465833907cc2SStefano Zampini   ierr = PetscSFDestroy(&dm->sf);CHKERRQ(ierr);
4659057b4bcdSMatthew G Knepley   dm->sf = sf;
4660057b4bcdSMatthew G Knepley   PetscFunctionReturn(0);
4661057b4bcdSMatthew G Knepley }
4662057b4bcdSMatthew G Knepley 
466334aa8a36SMatthew G. Knepley static PetscErrorCode DMSetDefaultAdjacency_Private(DM dm, PetscInt f, PetscObject disc)
466434aa8a36SMatthew G. Knepley {
466534aa8a36SMatthew G. Knepley   PetscClassId   id;
466634aa8a36SMatthew G. Knepley   PetscErrorCode ierr;
466734aa8a36SMatthew G. Knepley 
466834aa8a36SMatthew G. Knepley   PetscFunctionBegin;
466934aa8a36SMatthew G. Knepley   ierr = PetscObjectGetClassId(disc, &id);CHKERRQ(ierr);
467034aa8a36SMatthew G. Knepley   if (id == PETSCFE_CLASSID) {
467134aa8a36SMatthew G. Knepley     ierr = DMSetAdjacency(dm, f, PETSC_FALSE, PETSC_TRUE);CHKERRQ(ierr);
467234aa8a36SMatthew G. Knepley   } else if (id == PETSCFV_CLASSID) {
467334aa8a36SMatthew G. Knepley     ierr = DMSetAdjacency(dm, f, PETSC_TRUE, PETSC_FALSE);CHKERRQ(ierr);
467417c1d62eSMatthew G. Knepley   } else {
467517c1d62eSMatthew G. Knepley     ierr = DMSetAdjacency(dm, f, PETSC_FALSE, PETSC_TRUE);CHKERRQ(ierr);
467634aa8a36SMatthew G. Knepley   }
467734aa8a36SMatthew G. Knepley   PetscFunctionReturn(0);
467834aa8a36SMatthew G. Knepley }
467934aa8a36SMatthew G. Knepley 
468044a7f3ddSMatthew G. Knepley static PetscErrorCode DMFieldEnlarge_Static(DM dm, PetscInt NfNew)
468144a7f3ddSMatthew G. Knepley {
468244a7f3ddSMatthew G. Knepley   RegionField   *tmpr;
468344a7f3ddSMatthew G. Knepley   PetscInt       Nf = dm->Nf, f;
468444a7f3ddSMatthew G. Knepley   PetscErrorCode ierr;
468544a7f3ddSMatthew G. Knepley 
468644a7f3ddSMatthew G. Knepley   PetscFunctionBegin;
468744a7f3ddSMatthew G. Knepley   if (Nf >= NfNew) PetscFunctionReturn(0);
468844a7f3ddSMatthew G. Knepley   ierr = PetscMalloc1(NfNew, &tmpr);CHKERRQ(ierr);
468944a7f3ddSMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpr[f] = dm->fields[f];
4690e0b68406SMatthew Knepley   for (f = Nf; f < NfNew; ++f) {tmpr[f].disc = NULL; tmpr[f].label = NULL; tmpr[f].avoidTensor = PETSC_FALSE;}
469144a7f3ddSMatthew G. Knepley   ierr = PetscFree(dm->fields);CHKERRQ(ierr);
469244a7f3ddSMatthew G. Knepley   dm->Nf     = NfNew;
469344a7f3ddSMatthew G. Knepley   dm->fields = tmpr;
469444a7f3ddSMatthew G. Knepley   PetscFunctionReturn(0);
469544a7f3ddSMatthew G. Knepley }
469644a7f3ddSMatthew G. Knepley 
469744a7f3ddSMatthew G. Knepley /*@
469844a7f3ddSMatthew G. Knepley   DMClearFields - Remove all fields from the DM
469944a7f3ddSMatthew G. Knepley 
4700d083f849SBarry Smith   Logically collective on dm
470144a7f3ddSMatthew G. Knepley 
470244a7f3ddSMatthew G. Knepley   Input Parameter:
470344a7f3ddSMatthew G. Knepley . dm - The DM
470444a7f3ddSMatthew G. Knepley 
470544a7f3ddSMatthew G. Knepley   Level: intermediate
470644a7f3ddSMatthew G. Knepley 
470744a7f3ddSMatthew G. Knepley .seealso: DMGetNumFields(), DMSetNumFields(), DMSetField()
470844a7f3ddSMatthew G. Knepley @*/
470944a7f3ddSMatthew G. Knepley PetscErrorCode DMClearFields(DM dm)
471044a7f3ddSMatthew G. Knepley {
471144a7f3ddSMatthew G. Knepley   PetscInt       f;
471244a7f3ddSMatthew G. Knepley   PetscErrorCode ierr;
471344a7f3ddSMatthew G. Knepley 
471444a7f3ddSMatthew G. Knepley   PetscFunctionBegin;
471544a7f3ddSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
471644a7f3ddSMatthew G. Knepley   for (f = 0; f < dm->Nf; ++f) {
471744a7f3ddSMatthew G. Knepley     ierr = PetscObjectDestroy(&dm->fields[f].disc);CHKERRQ(ierr);
471844a7f3ddSMatthew G. Knepley     ierr = DMLabelDestroy(&dm->fields[f].label);CHKERRQ(ierr);
471944a7f3ddSMatthew G. Knepley   }
472044a7f3ddSMatthew G. Knepley   ierr = PetscFree(dm->fields);CHKERRQ(ierr);
472144a7f3ddSMatthew G. Knepley   dm->fields = NULL;
472244a7f3ddSMatthew G. Knepley   dm->Nf     = 0;
472344a7f3ddSMatthew G. Knepley   PetscFunctionReturn(0);
472444a7f3ddSMatthew G. Knepley }
472544a7f3ddSMatthew G. Knepley 
4726689b5837SMatthew G. Knepley /*@
4727689b5837SMatthew G. Knepley   DMGetNumFields - Get the number of fields in the DM
4728689b5837SMatthew G. Knepley 
4729689b5837SMatthew G. Knepley   Not collective
4730689b5837SMatthew G. Knepley 
4731689b5837SMatthew G. Knepley   Input Parameter:
4732689b5837SMatthew G. Knepley . dm - The DM
4733689b5837SMatthew G. Knepley 
4734689b5837SMatthew G. Knepley   Output Parameter:
4735689b5837SMatthew G. Knepley . Nf - The number of fields
4736689b5837SMatthew G. Knepley 
4737689b5837SMatthew G. Knepley   Level: intermediate
4738689b5837SMatthew G. Knepley 
4739689b5837SMatthew G. Knepley .seealso: DMSetNumFields(), DMSetField()
4740689b5837SMatthew G. Knepley @*/
47410f21e855SMatthew G. Knepley PetscErrorCode DMGetNumFields(DM dm, PetscInt *numFields)
47420f21e855SMatthew G. Knepley {
47430f21e855SMatthew G. Knepley   PetscFunctionBegin;
47440f21e855SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4745534a8f05SLisandro Dalcin   PetscValidIntPointer(numFields, 2);
474644a7f3ddSMatthew G. Knepley   *numFields = dm->Nf;
4747af122d2aSMatthew G Knepley   PetscFunctionReturn(0);
4748af122d2aSMatthew G Knepley }
4749af122d2aSMatthew G Knepley 
4750689b5837SMatthew G. Knepley /*@
4751689b5837SMatthew G. Knepley   DMSetNumFields - Set the number of fields in the DM
4752689b5837SMatthew G. Knepley 
4753d083f849SBarry Smith   Logically collective on dm
4754689b5837SMatthew G. Knepley 
4755689b5837SMatthew G. Knepley   Input Parameters:
4756689b5837SMatthew G. Knepley + dm - The DM
4757689b5837SMatthew G. Knepley - Nf - The number of fields
4758689b5837SMatthew G. Knepley 
4759689b5837SMatthew G. Knepley   Level: intermediate
4760689b5837SMatthew G. Knepley 
4761689b5837SMatthew G. Knepley .seealso: DMGetNumFields(), DMSetField()
4762689b5837SMatthew G. Knepley @*/
4763af122d2aSMatthew G Knepley PetscErrorCode DMSetNumFields(DM dm, PetscInt numFields)
4764af122d2aSMatthew G Knepley {
47650f21e855SMatthew G. Knepley   PetscInt       Nf, f;
4766af122d2aSMatthew G Knepley   PetscErrorCode ierr;
4767af122d2aSMatthew G Knepley 
4768af122d2aSMatthew G Knepley   PetscFunctionBegin;
4769af122d2aSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
477044a7f3ddSMatthew G. Knepley   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
47710f21e855SMatthew G. Knepley   for (f = Nf; f < numFields; ++f) {
47720f21e855SMatthew G. Knepley     PetscContainer obj;
47730f21e855SMatthew G. Knepley 
47740f21e855SMatthew G. Knepley     ierr = PetscContainerCreate(PetscObjectComm((PetscObject) dm), &obj);CHKERRQ(ierr);
477544a7f3ddSMatthew G. Knepley     ierr = DMAddField(dm, NULL, (PetscObject) obj);CHKERRQ(ierr);
47760f21e855SMatthew G. Knepley     ierr = PetscContainerDestroy(&obj);CHKERRQ(ierr);
4777af122d2aSMatthew G Knepley   }
4778af122d2aSMatthew G Knepley   PetscFunctionReturn(0);
4779af122d2aSMatthew G Knepley }
4780af122d2aSMatthew G Knepley 
4781c1929be8SMatthew G. Knepley /*@
4782c1929be8SMatthew G. Knepley   DMGetField - Return the discretization object for a given DM field
4783c1929be8SMatthew G. Knepley 
4784c1929be8SMatthew G. Knepley   Not collective
4785c1929be8SMatthew G. Knepley 
4786c1929be8SMatthew G. Knepley   Input Parameters:
4787c1929be8SMatthew G. Knepley + dm - The DM
4788c1929be8SMatthew G. Knepley - f  - The field number
4789c1929be8SMatthew G. Knepley 
479044a7f3ddSMatthew G. Knepley   Output Parameters:
479144a7f3ddSMatthew G. Knepley + label - The label indicating the support of the field, or NULL for the entire mesh
479244a7f3ddSMatthew G. Knepley - field - The discretization object
4793c1929be8SMatthew G. Knepley 
479444a7f3ddSMatthew G. Knepley   Level: intermediate
4795c1929be8SMatthew G. Knepley 
479644a7f3ddSMatthew G. Knepley .seealso: DMAddField(), DMSetField()
4797c1929be8SMatthew G. Knepley @*/
479844a7f3ddSMatthew G. Knepley PetscErrorCode DMGetField(DM dm, PetscInt f, DMLabel *label, PetscObject *field)
4799af122d2aSMatthew G Knepley {
4800af122d2aSMatthew G Knepley   PetscFunctionBegin;
4801af122d2aSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4802064a246eSJacob Faibussowitsch   PetscValidPointer(field, 4);
480344a7f3ddSMatthew 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);
480444a7f3ddSMatthew G. Knepley   if (label) *label = dm->fields[f].label;
480544a7f3ddSMatthew G. Knepley   if (field) *field = dm->fields[f].disc;
4806decb47aaSMatthew G. Knepley   PetscFunctionReturn(0);
4807decb47aaSMatthew G. Knepley }
4808decb47aaSMatthew G. Knepley 
4809083401c6SMatthew G. Knepley /* Does not clear the DS */
4810083401c6SMatthew G. Knepley PetscErrorCode DMSetField_Internal(DM dm, PetscInt f, DMLabel label, PetscObject field)
4811083401c6SMatthew G. Knepley {
4812083401c6SMatthew G. Knepley   PetscErrorCode ierr;
4813083401c6SMatthew G. Knepley 
4814083401c6SMatthew G. Knepley   PetscFunctionBegin;
4815083401c6SMatthew G. Knepley   ierr = DMFieldEnlarge_Static(dm, f+1);CHKERRQ(ierr);
4816083401c6SMatthew G. Knepley   ierr = DMLabelDestroy(&dm->fields[f].label);CHKERRQ(ierr);
4817083401c6SMatthew G. Knepley   ierr = PetscObjectDestroy(&dm->fields[f].disc);CHKERRQ(ierr);
4818083401c6SMatthew G. Knepley   dm->fields[f].label = label;
4819083401c6SMatthew G. Knepley   dm->fields[f].disc  = field;
4820083401c6SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr);
4821083401c6SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) field);CHKERRQ(ierr);
4822083401c6SMatthew G. Knepley   PetscFunctionReturn(0);
4823083401c6SMatthew G. Knepley }
4824083401c6SMatthew G. Knepley 
4825c1929be8SMatthew G. Knepley /*@
4826c1929be8SMatthew G. Knepley   DMSetField - Set the discretization object for a given DM field
4827c1929be8SMatthew G. Knepley 
4828d083f849SBarry Smith   Logically collective on dm
4829c1929be8SMatthew G. Knepley 
4830c1929be8SMatthew G. Knepley   Input Parameters:
4831c1929be8SMatthew G. Knepley + dm    - The DM
4832c1929be8SMatthew G. Knepley . f     - The field number
483344a7f3ddSMatthew G. Knepley . label - The label indicating the support of the field, or NULL for the entire mesh
4834c1929be8SMatthew G. Knepley - field - The discretization object
4835c1929be8SMatthew G. Knepley 
483644a7f3ddSMatthew G. Knepley   Level: intermediate
4837c1929be8SMatthew G. Knepley 
483844a7f3ddSMatthew G. Knepley .seealso: DMAddField(), DMGetField()
4839c1929be8SMatthew G. Knepley @*/
484044a7f3ddSMatthew G. Knepley PetscErrorCode DMSetField(DM dm, PetscInt f, DMLabel label, PetscObject field)
4841decb47aaSMatthew G. Knepley {
4842decb47aaSMatthew G. Knepley   PetscErrorCode ierr;
4843decb47aaSMatthew G. Knepley 
4844decb47aaSMatthew G. Knepley   PetscFunctionBegin;
4845decb47aaSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4846e5e52638SMatthew G. Knepley   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 3);
484744a7f3ddSMatthew G. Knepley   PetscValidHeader(field, 4);
4848e5e52638SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
4849083401c6SMatthew G. Knepley   ierr = DMSetField_Internal(dm, f, label, field);CHKERRQ(ierr);
485034aa8a36SMatthew G. Knepley   ierr = DMSetDefaultAdjacency_Private(dm, f, field);CHKERRQ(ierr);
48512df9ee95SMatthew G. Knepley   ierr = DMClearDS(dm);CHKERRQ(ierr);
485244a7f3ddSMatthew G. Knepley   PetscFunctionReturn(0);
485344a7f3ddSMatthew G. Knepley }
485444a7f3ddSMatthew G. Knepley 
485544a7f3ddSMatthew G. Knepley /*@
485644a7f3ddSMatthew G. Knepley   DMAddField - Add the discretization object for the given DM field
485744a7f3ddSMatthew G. Knepley 
4858d083f849SBarry Smith   Logically collective on dm
485944a7f3ddSMatthew G. Knepley 
486044a7f3ddSMatthew G. Knepley   Input Parameters:
486144a7f3ddSMatthew G. Knepley + dm    - The DM
486244a7f3ddSMatthew G. Knepley . label - The label indicating the support of the field, or NULL for the entire mesh
486344a7f3ddSMatthew G. Knepley - field - The discretization object
486444a7f3ddSMatthew G. Knepley 
486544a7f3ddSMatthew G. Knepley   Level: intermediate
486644a7f3ddSMatthew G. Knepley 
486744a7f3ddSMatthew G. Knepley .seealso: DMSetField(), DMGetField()
486844a7f3ddSMatthew G. Knepley @*/
486944a7f3ddSMatthew G. Knepley PetscErrorCode DMAddField(DM dm, DMLabel label, PetscObject field)
487044a7f3ddSMatthew G. Knepley {
487144a7f3ddSMatthew G. Knepley   PetscInt       Nf = dm->Nf;
487244a7f3ddSMatthew G. Knepley   PetscErrorCode ierr;
487344a7f3ddSMatthew G. Knepley 
487444a7f3ddSMatthew G. Knepley   PetscFunctionBegin;
487544a7f3ddSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4876064a246eSJacob Faibussowitsch   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
487744a7f3ddSMatthew G. Knepley   PetscValidHeader(field, 3);
487844a7f3ddSMatthew G. Knepley   ierr = DMFieldEnlarge_Static(dm, Nf+1);CHKERRQ(ierr);
487944a7f3ddSMatthew G. Knepley   dm->fields[Nf].label = label;
488044a7f3ddSMatthew G. Knepley   dm->fields[Nf].disc  = field;
488144a7f3ddSMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr);
488244a7f3ddSMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) field);CHKERRQ(ierr);
488334aa8a36SMatthew G. Knepley   ierr = DMSetDefaultAdjacency_Private(dm, Nf, field);CHKERRQ(ierr);
48842df9ee95SMatthew G. Knepley   ierr = DMClearDS(dm);CHKERRQ(ierr);
4885af122d2aSMatthew G Knepley   PetscFunctionReturn(0);
4886af122d2aSMatthew G Knepley }
48876636e97aSMatthew G Knepley 
4888e5e52638SMatthew G. Knepley /*@
4889e0b68406SMatthew Knepley   DMSetFieldAvoidTensor - Set flag to avoid defining the field on tensor cells
4890e0b68406SMatthew Knepley 
4891e0b68406SMatthew Knepley   Logically collective on dm
4892e0b68406SMatthew Knepley 
4893e0b68406SMatthew Knepley   Input Parameters:
4894e0b68406SMatthew Knepley + dm          - The DM
4895e0b68406SMatthew Knepley . f           - The field index
4896e0b68406SMatthew Knepley - avoidTensor - The flag to avoid defining the field on tensor cells
4897e0b68406SMatthew Knepley 
4898e0b68406SMatthew Knepley   Level: intermediate
4899e0b68406SMatthew Knepley 
4900e0b68406SMatthew Knepley .seealso: DMGetFieldAvoidTensor(), DMSetField(), DMGetField()
4901e0b68406SMatthew Knepley @*/
4902e0b68406SMatthew Knepley PetscErrorCode DMSetFieldAvoidTensor(DM dm, PetscInt f, PetscBool avoidTensor)
4903e0b68406SMatthew Knepley {
4904e0b68406SMatthew Knepley   PetscFunctionBegin;
4905e0b68406SMatthew Knepley   if ((f < 0) || (f >= dm->Nf)) SETERRQ2(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Field %D is not in [0, %D)", f, dm->Nf);
4906e0b68406SMatthew Knepley   dm->fields[f].avoidTensor = avoidTensor;
4907e0b68406SMatthew Knepley   PetscFunctionReturn(0);
4908e0b68406SMatthew Knepley }
4909e0b68406SMatthew Knepley 
4910e0b68406SMatthew Knepley /*@
4911e0b68406SMatthew Knepley   DMGetFieldAvoidTensor - Get flag to avoid defining the field on tensor cells
4912e0b68406SMatthew Knepley 
4913e0b68406SMatthew Knepley   Logically collective on dm
4914e0b68406SMatthew Knepley 
4915e0b68406SMatthew Knepley   Input Parameters:
4916e0b68406SMatthew Knepley + dm          - The DM
4917e0b68406SMatthew Knepley - f           - The field index
4918e0b68406SMatthew Knepley 
4919e0b68406SMatthew Knepley   Output Parameter:
4920e0b68406SMatthew Knepley . avoidTensor - The flag to avoid defining the field on tensor cells
4921e0b68406SMatthew Knepley 
4922e0b68406SMatthew Knepley   Level: intermediate
4923e0b68406SMatthew Knepley 
4924e0b68406SMatthew Knepley .seealso: DMSetFieldAvoidTensor(), DMSetField(), DMGetField()
4925e0b68406SMatthew Knepley @*/
4926e0b68406SMatthew Knepley PetscErrorCode DMGetFieldAvoidTensor(DM dm, PetscInt f, PetscBool *avoidTensor)
4927e0b68406SMatthew Knepley {
4928e0b68406SMatthew Knepley   PetscFunctionBegin;
4929e0b68406SMatthew Knepley   if ((f < 0) || (f >= dm->Nf)) SETERRQ2(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Field %D is not in [0, %D)", f, dm->Nf);
4930e0b68406SMatthew Knepley   *avoidTensor = dm->fields[f].avoidTensor;
4931e0b68406SMatthew Knepley   PetscFunctionReturn(0);
4932e0b68406SMatthew Knepley }
4933e0b68406SMatthew Knepley 
4934e0b68406SMatthew Knepley /*@
4935e5e52638SMatthew G. Knepley   DMCopyFields - Copy the discretizations for the DM into another DM
4936e5e52638SMatthew G. Knepley 
4937d083f849SBarry Smith   Collective on dm
4938e5e52638SMatthew G. Knepley 
4939e5e52638SMatthew G. Knepley   Input Parameter:
4940e5e52638SMatthew G. Knepley . dm - The DM
4941e5e52638SMatthew G. Knepley 
4942e5e52638SMatthew G. Knepley   Output Parameter:
4943e5e52638SMatthew G. Knepley . newdm - The DM
4944e5e52638SMatthew G. Knepley 
4945e5e52638SMatthew G. Knepley   Level: advanced
4946e5e52638SMatthew G. Knepley 
4947e5e52638SMatthew G. Knepley .seealso: DMGetField(), DMSetField(), DMAddField(), DMCopyDS(), DMGetDS(), DMGetCellDS()
4948e5e52638SMatthew G. Knepley @*/
4949e5e52638SMatthew G. Knepley PetscErrorCode DMCopyFields(DM dm, DM newdm)
4950e5e52638SMatthew G. Knepley {
4951e5e52638SMatthew G. Knepley   PetscInt       Nf, f;
4952e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
4953e5e52638SMatthew G. Knepley 
4954e5e52638SMatthew G. Knepley   PetscFunctionBegin;
4955e5e52638SMatthew G. Knepley   if (dm == newdm) PetscFunctionReturn(0);
4956e5e52638SMatthew G. Knepley   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
4957e5e52638SMatthew G. Knepley   ierr = DMClearFields(newdm);CHKERRQ(ierr);
4958e5e52638SMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
4959e5e52638SMatthew G. Knepley     DMLabel     label;
4960e5e52638SMatthew G. Knepley     PetscObject field;
496134aa8a36SMatthew G. Knepley     PetscBool   useCone, useClosure;
4962e5e52638SMatthew G. Knepley 
4963e5e52638SMatthew G. Knepley     ierr = DMGetField(dm, f, &label, &field);CHKERRQ(ierr);
4964e5e52638SMatthew G. Knepley     ierr = DMSetField(newdm, f, label, field);CHKERRQ(ierr);
496534aa8a36SMatthew G. Knepley     ierr = DMGetAdjacency(dm, f, &useCone, &useClosure);CHKERRQ(ierr);
496634aa8a36SMatthew G. Knepley     ierr = DMSetAdjacency(newdm, f, useCone, useClosure);CHKERRQ(ierr);
496734aa8a36SMatthew G. Knepley   }
496834aa8a36SMatthew G. Knepley   PetscFunctionReturn(0);
496934aa8a36SMatthew G. Knepley }
497034aa8a36SMatthew G. Knepley 
497134aa8a36SMatthew G. Knepley /*@
497234aa8a36SMatthew G. Knepley   DMGetAdjacency - Returns the flags for determining variable influence
497334aa8a36SMatthew G. Knepley 
497434aa8a36SMatthew G. Knepley   Not collective
497534aa8a36SMatthew G. Knepley 
497634aa8a36SMatthew G. Knepley   Input Parameters:
497734aa8a36SMatthew G. Knepley + dm - The DM object
497834aa8a36SMatthew G. Knepley - f  - The field number, or PETSC_DEFAULT for the default adjacency
497934aa8a36SMatthew G. Knepley 
4980d8d19677SJose E. Roman   Output Parameters:
498134aa8a36SMatthew G. Knepley + useCone    - Flag for variable influence starting with the cone operation
498234aa8a36SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
498334aa8a36SMatthew G. Knepley 
498434aa8a36SMatthew G. Knepley   Notes:
498534aa8a36SMatthew G. Knepley $     FEM:   Two points p and q are adjacent if q \in closure(star(p)),   useCone = PETSC_FALSE, useClosure = PETSC_TRUE
498634aa8a36SMatthew G. Knepley $     FVM:   Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE,  useClosure = PETSC_FALSE
498734aa8a36SMatthew G. Knepley $     FVM++: Two points p and q are adjacent if q \in star(closure(p)),   useCone = PETSC_TRUE,  useClosure = PETSC_TRUE
4988979e053dSMatthew G. Knepley   Further explanation can be found in the User's Manual Section on the Influence of Variables on One Another.
498934aa8a36SMatthew G. Knepley 
499034aa8a36SMatthew G. Knepley   Level: developer
499134aa8a36SMatthew G. Knepley 
499234aa8a36SMatthew G. Knepley .seealso: DMSetAdjacency(), DMGetField(), DMSetField()
499334aa8a36SMatthew G. Knepley @*/
499434aa8a36SMatthew G. Knepley PetscErrorCode DMGetAdjacency(DM dm, PetscInt f, PetscBool *useCone, PetscBool *useClosure)
499534aa8a36SMatthew G. Knepley {
499634aa8a36SMatthew G. Knepley   PetscFunctionBegin;
499734aa8a36SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4998534a8f05SLisandro Dalcin   if (useCone)    PetscValidBoolPointer(useCone, 3);
4999534a8f05SLisandro Dalcin   if (useClosure) PetscValidBoolPointer(useClosure, 4);
500034aa8a36SMatthew G. Knepley   if (f < 0) {
500134aa8a36SMatthew G. Knepley     if (useCone)    *useCone    = dm->adjacency[0];
500234aa8a36SMatthew G. Knepley     if (useClosure) *useClosure = dm->adjacency[1];
500334aa8a36SMatthew G. Knepley   } else {
500434aa8a36SMatthew G. Knepley     PetscInt       Nf;
500534aa8a36SMatthew G. Knepley     PetscErrorCode ierr;
500634aa8a36SMatthew G. Knepley 
500734aa8a36SMatthew G. Knepley     ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
500834aa8a36SMatthew G. Knepley     if (f >= Nf) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, Nf);
500934aa8a36SMatthew G. Knepley     if (useCone)    *useCone    = dm->fields[f].adjacency[0];
501034aa8a36SMatthew G. Knepley     if (useClosure) *useClosure = dm->fields[f].adjacency[1];
501134aa8a36SMatthew G. Knepley   }
501234aa8a36SMatthew G. Knepley   PetscFunctionReturn(0);
501334aa8a36SMatthew G. Knepley }
501434aa8a36SMatthew G. Knepley 
501534aa8a36SMatthew G. Knepley /*@
501634aa8a36SMatthew G. Knepley   DMSetAdjacency - Set the flags for determining variable influence
501734aa8a36SMatthew G. Knepley 
501834aa8a36SMatthew G. Knepley   Not collective
501934aa8a36SMatthew G. Knepley 
502034aa8a36SMatthew G. Knepley   Input Parameters:
502134aa8a36SMatthew G. Knepley + dm         - The DM object
502234aa8a36SMatthew G. Knepley . f          - The field number
502334aa8a36SMatthew G. Knepley . useCone    - Flag for variable influence starting with the cone operation
502434aa8a36SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
502534aa8a36SMatthew G. Knepley 
502634aa8a36SMatthew G. Knepley   Notes:
502734aa8a36SMatthew G. Knepley $     FEM:   Two points p and q are adjacent if q \in closure(star(p)),   useCone = PETSC_FALSE, useClosure = PETSC_TRUE
502834aa8a36SMatthew G. Knepley $     FVM:   Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE,  useClosure = PETSC_FALSE
502934aa8a36SMatthew G. Knepley $     FVM++: Two points p and q are adjacent if q \in star(closure(p)),   useCone = PETSC_TRUE,  useClosure = PETSC_TRUE
5030979e053dSMatthew G. Knepley   Further explanation can be found in the User's Manual Section on the Influence of Variables on One Another.
503134aa8a36SMatthew G. Knepley 
503234aa8a36SMatthew G. Knepley   Level: developer
503334aa8a36SMatthew G. Knepley 
503434aa8a36SMatthew G. Knepley .seealso: DMGetAdjacency(), DMGetField(), DMSetField()
503534aa8a36SMatthew G. Knepley @*/
503634aa8a36SMatthew G. Knepley PetscErrorCode DMSetAdjacency(DM dm, PetscInt f, PetscBool useCone, PetscBool useClosure)
503734aa8a36SMatthew G. Knepley {
503834aa8a36SMatthew G. Knepley   PetscFunctionBegin;
503934aa8a36SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
504034aa8a36SMatthew G. Knepley   if (f < 0) {
504134aa8a36SMatthew G. Knepley     dm->adjacency[0] = useCone;
504234aa8a36SMatthew G. Knepley     dm->adjacency[1] = useClosure;
504334aa8a36SMatthew G. Knepley   } else {
504434aa8a36SMatthew G. Knepley     PetscInt       Nf;
504534aa8a36SMatthew G. Knepley     PetscErrorCode ierr;
504634aa8a36SMatthew G. Knepley 
504734aa8a36SMatthew G. Knepley     ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
504834aa8a36SMatthew G. Knepley     if (f >= Nf) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, Nf);
504934aa8a36SMatthew G. Knepley     dm->fields[f].adjacency[0] = useCone;
505034aa8a36SMatthew G. Knepley     dm->fields[f].adjacency[1] = useClosure;
5051e5e52638SMatthew G. Knepley   }
5052e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5053e5e52638SMatthew G. Knepley }
5054e5e52638SMatthew G. Knepley 
5055b0441da4SMatthew G. Knepley /*@
5056b0441da4SMatthew G. Knepley   DMGetBasicAdjacency - Returns the flags for determining variable influence, using either the default or field 0 if it is defined
5057b0441da4SMatthew G. Knepley 
5058b0441da4SMatthew G. Knepley   Not collective
5059b0441da4SMatthew G. Knepley 
5060f899ff85SJose E. Roman   Input Parameter:
5061b0441da4SMatthew G. Knepley . dm - The DM object
5062b0441da4SMatthew G. Knepley 
5063d8d19677SJose E. Roman   Output Parameters:
5064b0441da4SMatthew G. Knepley + useCone    - Flag for variable influence starting with the cone operation
5065b0441da4SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
5066b0441da4SMatthew G. Knepley 
5067b0441da4SMatthew G. Knepley   Notes:
5068b0441da4SMatthew G. Knepley $     FEM:   Two points p and q are adjacent if q \in closure(star(p)),   useCone = PETSC_FALSE, useClosure = PETSC_TRUE
5069b0441da4SMatthew G. Knepley $     FVM:   Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE,  useClosure = PETSC_FALSE
5070b0441da4SMatthew G. Knepley $     FVM++: Two points p and q are adjacent if q \in star(closure(p)),   useCone = PETSC_TRUE,  useClosure = PETSC_TRUE
5071b0441da4SMatthew G. Knepley 
5072b0441da4SMatthew G. Knepley   Level: developer
5073b0441da4SMatthew G. Knepley 
5074b0441da4SMatthew G. Knepley .seealso: DMSetBasicAdjacency(), DMGetField(), DMSetField()
5075b0441da4SMatthew G. Knepley @*/
5076b0441da4SMatthew G. Knepley PetscErrorCode DMGetBasicAdjacency(DM dm, PetscBool *useCone, PetscBool *useClosure)
5077b0441da4SMatthew G. Knepley {
5078b0441da4SMatthew G. Knepley   PetscInt       Nf;
5079b0441da4SMatthew G. Knepley   PetscErrorCode ierr;
5080b0441da4SMatthew G. Knepley 
5081b0441da4SMatthew G. Knepley   PetscFunctionBegin;
5082b0441da4SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5083064a246eSJacob Faibussowitsch   if (useCone)    PetscValidBoolPointer(useCone, 2);
5084064a246eSJacob Faibussowitsch   if (useClosure) PetscValidBoolPointer(useClosure, 3);
5085b0441da4SMatthew G. Knepley   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
5086b0441da4SMatthew G. Knepley   if (!Nf) {
5087b0441da4SMatthew G. Knepley     ierr = DMGetAdjacency(dm, PETSC_DEFAULT, useCone, useClosure);CHKERRQ(ierr);
5088b0441da4SMatthew G. Knepley   } else {
5089b0441da4SMatthew G. Knepley     ierr = DMGetAdjacency(dm, 0, useCone, useClosure);CHKERRQ(ierr);
5090b0441da4SMatthew G. Knepley   }
5091b0441da4SMatthew G. Knepley   PetscFunctionReturn(0);
5092b0441da4SMatthew G. Knepley }
5093b0441da4SMatthew G. Knepley 
5094b0441da4SMatthew G. Knepley /*@
5095b0441da4SMatthew G. Knepley   DMSetBasicAdjacency - Set the flags for determining variable influence, using either the default or field 0 if it is defined
5096b0441da4SMatthew G. Knepley 
5097b0441da4SMatthew G. Knepley   Not collective
5098b0441da4SMatthew G. Knepley 
5099b0441da4SMatthew G. Knepley   Input Parameters:
5100b0441da4SMatthew G. Knepley + dm         - The DM object
5101b0441da4SMatthew G. Knepley . useCone    - Flag for variable influence starting with the cone operation
5102b0441da4SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
5103b0441da4SMatthew G. Knepley 
5104b0441da4SMatthew G. Knepley   Notes:
5105b0441da4SMatthew G. Knepley $     FEM:   Two points p and q are adjacent if q \in closure(star(p)),   useCone = PETSC_FALSE, useClosure = PETSC_TRUE
5106b0441da4SMatthew G. Knepley $     FVM:   Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE,  useClosure = PETSC_FALSE
5107b0441da4SMatthew G. Knepley $     FVM++: Two points p and q are adjacent if q \in star(closure(p)),   useCone = PETSC_TRUE,  useClosure = PETSC_TRUE
5108b0441da4SMatthew G. Knepley 
5109b0441da4SMatthew G. Knepley   Level: developer
5110b0441da4SMatthew G. Knepley 
5111b0441da4SMatthew G. Knepley .seealso: DMGetBasicAdjacency(), DMGetField(), DMSetField()
5112b0441da4SMatthew G. Knepley @*/
5113b0441da4SMatthew G. Knepley PetscErrorCode DMSetBasicAdjacency(DM dm, PetscBool useCone, PetscBool useClosure)
5114b0441da4SMatthew G. Knepley {
5115b0441da4SMatthew G. Knepley   PetscInt       Nf;
5116b0441da4SMatthew G. Knepley   PetscErrorCode ierr;
5117b0441da4SMatthew G. Knepley 
5118b0441da4SMatthew G. Knepley   PetscFunctionBegin;
5119b0441da4SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5120b0441da4SMatthew G. Knepley   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
5121b0441da4SMatthew G. Knepley   if (!Nf) {
5122b0441da4SMatthew G. Knepley     ierr = DMSetAdjacency(dm, PETSC_DEFAULT, useCone, useClosure);CHKERRQ(ierr);
5123b0441da4SMatthew G. Knepley   } else {
5124b0441da4SMatthew G. Knepley     ierr = DMSetAdjacency(dm, 0, useCone, useClosure);CHKERRQ(ierr);
5125e5e52638SMatthew G. Knepley   }
5126e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5127e5e52638SMatthew G. Knepley }
5128e5e52638SMatthew G. Knepley 
5129783e2ec8SMatthew G. Knepley /* Complete labels that are being used for FEM BC */
513045480ffeSMatthew G. Knepley static PetscErrorCode DMCompleteBoundaryLabel_Internal(DM dm, PetscDS ds, PetscInt field, PetscInt bdNum, DMLabel label)
5131783e2ec8SMatthew G. Knepley {
5132783e2ec8SMatthew G. Knepley   PetscObject    obj;
5133783e2ec8SMatthew G. Knepley   PetscClassId   id;
5134783e2ec8SMatthew G. Knepley   PetscInt       Nbd, bd;
5135783e2ec8SMatthew G. Knepley   PetscBool      isFE      = PETSC_FALSE;
5136783e2ec8SMatthew G. Knepley   PetscBool      duplicate = PETSC_FALSE;
5137783e2ec8SMatthew G. Knepley   PetscErrorCode ierr;
5138783e2ec8SMatthew G. Knepley 
5139783e2ec8SMatthew G. Knepley   PetscFunctionBegin;
5140783e2ec8SMatthew G. Knepley   ierr = DMGetField(dm, field, NULL, &obj);CHKERRQ(ierr);
5141783e2ec8SMatthew G. Knepley   ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr);
5142783e2ec8SMatthew G. Knepley   if (id == PETSCFE_CLASSID) isFE = PETSC_TRUE;
5143783e2ec8SMatthew G. Knepley   if (isFE && label) {
5144783e2ec8SMatthew G. Knepley     /* Only want to modify label once */
5145783e2ec8SMatthew G. Knepley     ierr = PetscDSGetNumBoundary(ds, &Nbd);CHKERRQ(ierr);
5146783e2ec8SMatthew G. Knepley     for (bd = 0; bd < PetscMin(Nbd, bdNum); ++bd) {
514745480ffeSMatthew G. Knepley       DMLabel l;
5148783e2ec8SMatthew G. Knepley 
514945480ffeSMatthew G. Knepley       ierr = PetscDSGetBoundary(ds, bd, NULL, NULL, NULL, &l, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL);CHKERRQ(ierr);
515045480ffeSMatthew G. Knepley       duplicate = l == label ? PETSC_TRUE : PETSC_FALSE;
5151783e2ec8SMatthew G. Knepley       if (duplicate) break;
5152783e2ec8SMatthew G. Knepley     }
5153783e2ec8SMatthew G. Knepley     if (!duplicate) {
5154783e2ec8SMatthew G. Knepley       DM plex;
5155783e2ec8SMatthew G. Knepley 
5156783e2ec8SMatthew G. Knepley       ierr = DMConvert(dm, DMPLEX, &plex);CHKERRQ(ierr);
5157783e2ec8SMatthew G. Knepley       if (plex) {ierr = DMPlexLabelComplete(plex, label);CHKERRQ(ierr);}
5158783e2ec8SMatthew G. Knepley       ierr = DMDestroy(&plex);CHKERRQ(ierr);
5159783e2ec8SMatthew G. Knepley     }
5160783e2ec8SMatthew G. Knepley   }
5161783e2ec8SMatthew G. Knepley   PetscFunctionReturn(0);
5162783e2ec8SMatthew G. Knepley }
5163783e2ec8SMatthew G. Knepley 
5164e5e52638SMatthew G. Knepley static PetscErrorCode DMDSEnlarge_Static(DM dm, PetscInt NdsNew)
5165e5e52638SMatthew G. Knepley {
5166e5e52638SMatthew G. Knepley   DMSpace       *tmpd;
5167e5e52638SMatthew G. Knepley   PetscInt       Nds = dm->Nds, s;
5168e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5169e5e52638SMatthew G. Knepley 
5170e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5171e5e52638SMatthew G. Knepley   if (Nds >= NdsNew) PetscFunctionReturn(0);
5172e5e52638SMatthew G. Knepley   ierr = PetscMalloc1(NdsNew, &tmpd);CHKERRQ(ierr);
5173e5e52638SMatthew G. Knepley   for (s = 0; s < Nds; ++s) tmpd[s] = dm->probs[s];
5174b3cf3223SMatthew G. Knepley   for (s = Nds; s < NdsNew; ++s) {tmpd[s].ds = NULL; tmpd[s].label = NULL; tmpd[s].fields = NULL;}
5175e5e52638SMatthew G. Knepley   ierr = PetscFree(dm->probs);CHKERRQ(ierr);
5176e5e52638SMatthew G. Knepley   dm->Nds   = NdsNew;
5177e5e52638SMatthew G. Knepley   dm->probs = tmpd;
5178e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5179e5e52638SMatthew G. Knepley }
5180e5e52638SMatthew G. Knepley 
5181e5e52638SMatthew G. Knepley /*@
5182e5e52638SMatthew G. Knepley   DMGetNumDS - Get the number of discrete systems in the DM
5183e5e52638SMatthew G. Knepley 
5184e5e52638SMatthew G. Knepley   Not collective
5185e5e52638SMatthew G. Knepley 
5186e5e52638SMatthew G. Knepley   Input Parameter:
5187e5e52638SMatthew G. Knepley . dm - The DM
5188e5e52638SMatthew G. Knepley 
5189e5e52638SMatthew G. Knepley   Output Parameter:
5190e5e52638SMatthew G. Knepley . Nds - The number of PetscDS objects
5191e5e52638SMatthew G. Knepley 
5192e5e52638SMatthew G. Knepley   Level: intermediate
5193e5e52638SMatthew G. Knepley 
5194e5e52638SMatthew G. Knepley .seealso: DMGetDS(), DMGetCellDS()
5195e5e52638SMatthew G. Knepley @*/
5196e5e52638SMatthew G. Knepley PetscErrorCode DMGetNumDS(DM dm, PetscInt *Nds)
5197e5e52638SMatthew G. Knepley {
5198e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5199e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5200534a8f05SLisandro Dalcin   PetscValidIntPointer(Nds, 2);
5201e5e52638SMatthew G. Knepley   *Nds = dm->Nds;
5202e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5203e5e52638SMatthew G. Knepley }
5204e5e52638SMatthew G. Knepley 
5205e5e52638SMatthew G. Knepley /*@
5206e5e52638SMatthew G. Knepley   DMClearDS - Remove all discrete systems from the DM
5207e5e52638SMatthew G. Knepley 
5208d083f849SBarry Smith   Logically collective on dm
5209e5e52638SMatthew G. Knepley 
5210e5e52638SMatthew G. Knepley   Input Parameter:
5211e5e52638SMatthew G. Knepley . dm - The DM
5212e5e52638SMatthew G. Knepley 
5213e5e52638SMatthew G. Knepley   Level: intermediate
5214e5e52638SMatthew G. Knepley 
5215e5e52638SMatthew G. Knepley .seealso: DMGetNumDS(), DMGetDS(), DMSetField()
5216e5e52638SMatthew G. Knepley @*/
5217e5e52638SMatthew G. Knepley PetscErrorCode DMClearDS(DM dm)
5218e5e52638SMatthew G. Knepley {
5219e5e52638SMatthew G. Knepley   PetscInt       s;
5220e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5221e5e52638SMatthew G. Knepley 
5222e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5223e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5224e5e52638SMatthew G. Knepley   for (s = 0; s < dm->Nds; ++s) {
5225e5e52638SMatthew G. Knepley     ierr = PetscDSDestroy(&dm->probs[s].ds);CHKERRQ(ierr);
5226e5e52638SMatthew G. Knepley     ierr = DMLabelDestroy(&dm->probs[s].label);CHKERRQ(ierr);
5227b3cf3223SMatthew G. Knepley     ierr = ISDestroy(&dm->probs[s].fields);CHKERRQ(ierr);
5228e5e52638SMatthew G. Knepley   }
5229e5e52638SMatthew G. Knepley   ierr = PetscFree(dm->probs);CHKERRQ(ierr);
5230e5e52638SMatthew G. Knepley   dm->probs = NULL;
5231e5e52638SMatthew G. Knepley   dm->Nds   = 0;
5232e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5233e5e52638SMatthew G. Knepley }
5234e5e52638SMatthew G. Knepley 
5235e5e52638SMatthew G. Knepley /*@
5236e5e52638SMatthew G. Knepley   DMGetDS - Get the default PetscDS
5237e5e52638SMatthew G. Knepley 
5238e5e52638SMatthew G. Knepley   Not collective
5239e5e52638SMatthew G. Knepley 
5240e5e52638SMatthew G. Knepley   Input Parameter:
5241e5e52638SMatthew G. Knepley . dm    - The DM
5242e5e52638SMatthew G. Knepley 
5243e5e52638SMatthew G. Knepley   Output Parameter:
5244e5e52638SMatthew G. Knepley . prob - The default PetscDS
5245e5e52638SMatthew G. Knepley 
5246e5e52638SMatthew G. Knepley   Level: intermediate
5247e5e52638SMatthew G. Knepley 
5248e5e52638SMatthew G. Knepley .seealso: DMGetCellDS(), DMGetRegionDS()
5249e5e52638SMatthew G. Knepley @*/
5250e5e52638SMatthew G. Knepley PetscErrorCode DMGetDS(DM dm, PetscDS *prob)
5251e5e52638SMatthew G. Knepley {
5252b0143b4dSMatthew G. Knepley   PetscErrorCode ierr;
5253b0143b4dSMatthew G. Knepley 
5254e5e52638SMatthew G. Knepley   PetscFunctionBeginHot;
5255e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5256e5e52638SMatthew G. Knepley   PetscValidPointer(prob, 2);
5257b0143b4dSMatthew G. Knepley   if (dm->Nds <= 0) {
5258b0143b4dSMatthew G. Knepley     PetscDS ds;
5259b0143b4dSMatthew G. Knepley 
526045480ffeSMatthew G. Knepley     ierr = PetscDSCreate(PETSC_COMM_SELF, &ds);CHKERRQ(ierr);
5261b3cf3223SMatthew G. Knepley     ierr = DMSetRegionDS(dm, NULL, NULL, ds);CHKERRQ(ierr);
5262b0143b4dSMatthew G. Knepley     ierr = PetscDSDestroy(&ds);CHKERRQ(ierr);
5263b0143b4dSMatthew G. Knepley   }
5264b0143b4dSMatthew G. Knepley   *prob = dm->probs[0].ds;
5265e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5266e5e52638SMatthew G. Knepley }
5267e5e52638SMatthew G. Knepley 
5268e5e52638SMatthew G. Knepley /*@
5269e5e52638SMatthew G. Knepley   DMGetCellDS - Get the PetscDS defined on a given cell
5270e5e52638SMatthew G. Knepley 
5271e5e52638SMatthew G. Knepley   Not collective
5272e5e52638SMatthew G. Knepley 
5273e5e52638SMatthew G. Knepley   Input Parameters:
5274e5e52638SMatthew G. Knepley + dm    - The DM
5275e5e52638SMatthew G. Knepley - point - Cell for the DS
5276e5e52638SMatthew G. Knepley 
5277e5e52638SMatthew G. Knepley   Output Parameter:
5278e5e52638SMatthew G. Knepley . prob - The PetscDS defined on the given cell
5279e5e52638SMatthew G. Knepley 
5280e5e52638SMatthew G. Knepley   Level: developer
5281e5e52638SMatthew G. Knepley 
5282b0143b4dSMatthew G. Knepley .seealso: DMGetDS(), DMSetRegionDS()
5283e5e52638SMatthew G. Knepley @*/
5284e5e52638SMatthew G. Knepley PetscErrorCode DMGetCellDS(DM dm, PetscInt point, PetscDS *prob)
5285e5e52638SMatthew G. Knepley {
5286e5e52638SMatthew G. Knepley   PetscDS        probDef = NULL;
5287e5e52638SMatthew G. Knepley   PetscInt       s;
5288e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5289e5e52638SMatthew G. Knepley 
5290e5e52638SMatthew G. Knepley   PetscFunctionBeginHot;
5291e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5292e5e52638SMatthew G. Knepley   PetscValidPointer(prob, 3);
5293360cf244SMatthew G. Knepley   if (point < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Mesh point cannot be negative: %D", point);
5294e5e52638SMatthew G. Knepley   *prob = NULL;
5295e5e52638SMatthew G. Knepley   for (s = 0; s < dm->Nds; ++s) {
5296e5e52638SMatthew G. Knepley     PetscInt val;
5297e5e52638SMatthew G. Knepley 
5298e5e52638SMatthew G. Knepley     if (!dm->probs[s].label) {probDef = dm->probs[s].ds;}
5299e5e52638SMatthew G. Knepley     else {
5300e5e52638SMatthew G. Knepley       ierr = DMLabelGetValue(dm->probs[s].label, point, &val);CHKERRQ(ierr);
5301e5e52638SMatthew G. Knepley       if (val >= 0) {*prob = dm->probs[s].ds; break;}
5302e5e52638SMatthew G. Knepley     }
5303e5e52638SMatthew G. Knepley   }
5304e5e52638SMatthew G. Knepley   if (!*prob) *prob = probDef;
5305e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5306e5e52638SMatthew G. Knepley }
5307e5e52638SMatthew G. Knepley 
5308e5e52638SMatthew G. Knepley /*@
5309e5e52638SMatthew G. Knepley   DMGetRegionDS - Get the PetscDS for a given mesh region, defined by a DMLabel
5310e5e52638SMatthew G. Knepley 
5311e5e52638SMatthew G. Knepley   Not collective
5312e5e52638SMatthew G. Knepley 
5313e5e52638SMatthew G. Knepley   Input Parameters:
5314e5e52638SMatthew G. Knepley + dm    - The DM
5315e5e52638SMatthew G. Knepley - label - The DMLabel defining the mesh region, or NULL for the entire mesh
5316e5e52638SMatthew G. Knepley 
5317b3cf3223SMatthew G. Knepley   Output Parameters:
5318b3cf3223SMatthew G. Knepley + fields - The IS containing the DM field numbers for the fields in this DS, or NULL
5319b3cf3223SMatthew G. Knepley - prob - The PetscDS defined on the given region, or NULL
5320e5e52638SMatthew G. Knepley 
5321e5e52638SMatthew G. Knepley   Note: If the label is missing, this function returns an error
5322e5e52638SMatthew G. Knepley 
5323e5e52638SMatthew G. Knepley   Level: advanced
5324e5e52638SMatthew G. Knepley 
5325e5e52638SMatthew G. Knepley .seealso: DMGetRegionNumDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS()
5326e5e52638SMatthew G. Knepley @*/
5327b3cf3223SMatthew G. Knepley PetscErrorCode DMGetRegionDS(DM dm, DMLabel label, IS *fields, PetscDS *ds)
5328e5e52638SMatthew G. Knepley {
5329e5e52638SMatthew G. Knepley   PetscInt Nds = dm->Nds, s;
5330e5e52638SMatthew G. Knepley 
5331e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5332e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5333e5e52638SMatthew G. Knepley   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
5334b3cf3223SMatthew G. Knepley   if (fields) {PetscValidPointer(fields, 3); *fields = NULL;}
5335b3cf3223SMatthew G. Knepley   if (ds)     {PetscValidPointer(ds, 4);     *ds     = NULL;}
5336e5e52638SMatthew G. Knepley   for (s = 0; s < Nds; ++s) {
5337b3cf3223SMatthew G. Knepley     if (dm->probs[s].label == label) {
5338b3cf3223SMatthew G. Knepley       if (fields) *fields = dm->probs[s].fields;
5339b3cf3223SMatthew G. Knepley       if (ds)     *ds     = dm->probs[s].ds;
5340b3cf3223SMatthew G. Knepley       PetscFunctionReturn(0);
5341b3cf3223SMatthew G. Knepley     }
5342e5e52638SMatthew G. Knepley   }
53432df9ee95SMatthew G. Knepley   PetscFunctionReturn(0);
5344e5e52638SMatthew G. Knepley }
5345e5e52638SMatthew G. Knepley 
5346e5e52638SMatthew G. Knepley /*@
5347083401c6SMatthew G. Knepley   DMSetRegionDS - Set the PetscDS for a given mesh region, defined by a DMLabel
5348083401c6SMatthew G. Knepley 
5349083401c6SMatthew G. Knepley   Collective on dm
5350083401c6SMatthew G. Knepley 
5351083401c6SMatthew G. Knepley   Input Parameters:
5352083401c6SMatthew G. Knepley + dm     - The DM
5353083401c6SMatthew G. Knepley . label  - The DMLabel defining the mesh region, or NULL for the entire mesh
5354083401c6SMatthew G. Knepley . fields - The IS containing the DM field numbers for the fields in this DS, or NULL for all fields
5355083401c6SMatthew G. Knepley - prob   - The PetscDS defined on the given cell
5356083401c6SMatthew G. Knepley 
5357083401c6SMatthew 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,
5358083401c6SMatthew G. Knepley   the fields argument is ignored.
5359083401c6SMatthew G. Knepley 
5360083401c6SMatthew G. Knepley   Level: advanced
5361083401c6SMatthew G. Knepley 
5362083401c6SMatthew G. Knepley .seealso: DMGetRegionDS(), DMSetRegionNumDS(), DMGetDS(), DMGetCellDS()
5363083401c6SMatthew G. Knepley @*/
5364083401c6SMatthew G. Knepley PetscErrorCode DMSetRegionDS(DM dm, DMLabel label, IS fields, PetscDS ds)
5365083401c6SMatthew G. Knepley {
5366083401c6SMatthew G. Knepley   PetscInt       Nds = dm->Nds, s;
5367083401c6SMatthew G. Knepley   PetscErrorCode ierr;
5368083401c6SMatthew G. Knepley 
5369083401c6SMatthew G. Knepley   PetscFunctionBegin;
5370083401c6SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5371083401c6SMatthew G. Knepley   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
5372064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 4);
5373083401c6SMatthew G. Knepley   for (s = 0; s < Nds; ++s) {
5374083401c6SMatthew G. Knepley     if (dm->probs[s].label == label) {
5375083401c6SMatthew G. Knepley       ierr = PetscDSDestroy(&dm->probs[s].ds);CHKERRQ(ierr);
5376083401c6SMatthew G. Knepley       dm->probs[s].ds = ds;
5377083401c6SMatthew G. Knepley       PetscFunctionReturn(0);
5378083401c6SMatthew G. Knepley     }
5379083401c6SMatthew G. Knepley   }
5380083401c6SMatthew G. Knepley   ierr = DMDSEnlarge_Static(dm, Nds+1);CHKERRQ(ierr);
5381083401c6SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr);
5382083401c6SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) fields);CHKERRQ(ierr);
5383083401c6SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) ds);CHKERRQ(ierr);
5384083401c6SMatthew G. Knepley   if (!label) {
5385083401c6SMatthew G. Knepley     /* Put the NULL label at the front, so it is returned as the default */
5386083401c6SMatthew G. Knepley     for (s = Nds-1; s >=0; --s) dm->probs[s+1] = dm->probs[s];
5387083401c6SMatthew G. Knepley     Nds = 0;
5388083401c6SMatthew G. Knepley   }
5389083401c6SMatthew G. Knepley   dm->probs[Nds].label  = label;
5390083401c6SMatthew G. Knepley   dm->probs[Nds].fields = fields;
5391083401c6SMatthew G. Knepley   dm->probs[Nds].ds     = ds;
5392083401c6SMatthew G. Knepley   PetscFunctionReturn(0);
5393083401c6SMatthew G. Knepley }
5394083401c6SMatthew G. Knepley 
5395083401c6SMatthew G. Knepley /*@
5396e5e52638SMatthew G. Knepley   DMGetRegionNumDS - Get the PetscDS for a given mesh region, defined by the region number
5397e5e52638SMatthew G. Knepley 
5398e5e52638SMatthew G. Knepley   Not collective
5399e5e52638SMatthew G. Knepley 
5400e5e52638SMatthew G. Knepley   Input Parameters:
5401e5e52638SMatthew G. Knepley + dm  - The DM
5402e5e52638SMatthew G. Knepley - num - The region number, in [0, Nds)
5403e5e52638SMatthew G. Knepley 
5404e5e52638SMatthew G. Knepley   Output Parameters:
5405b3cf3223SMatthew G. Knepley + label  - The region label, or NULL
5406b3cf3223SMatthew G. Knepley . fields - The IS containing the DM field numbers for the fields in this DS, or NULL
5407083401c6SMatthew G. Knepley - ds     - The PetscDS defined on the given region, or NULL
5408e5e52638SMatthew G. Knepley 
5409e5e52638SMatthew G. Knepley   Level: advanced
5410e5e52638SMatthew G. Knepley 
5411e5e52638SMatthew G. Knepley .seealso: DMGetRegionDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS()
5412e5e52638SMatthew G. Knepley @*/
5413b3cf3223SMatthew G. Knepley PetscErrorCode DMGetRegionNumDS(DM dm, PetscInt num, DMLabel *label, IS *fields, PetscDS *ds)
5414e5e52638SMatthew G. Knepley {
5415e5e52638SMatthew G. Knepley   PetscInt       Nds;
5416e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5417e5e52638SMatthew G. Knepley 
5418e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5419e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5420e5e52638SMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
5421e5e52638SMatthew 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);
5422e5e52638SMatthew G. Knepley   if (label) {
5423e5e52638SMatthew G. Knepley     PetscValidPointer(label, 3);
5424e5e52638SMatthew G. Knepley     *label = dm->probs[num].label;
5425e5e52638SMatthew G. Knepley   }
5426b3cf3223SMatthew G. Knepley   if (fields) {
5427b3cf3223SMatthew G. Knepley     PetscValidPointer(fields, 4);
5428b3cf3223SMatthew G. Knepley     *fields = dm->probs[num].fields;
5429b3cf3223SMatthew G. Knepley   }
5430e5e52638SMatthew G. Knepley   if (ds) {
5431b3cf3223SMatthew G. Knepley     PetscValidPointer(ds, 5);
5432e5e52638SMatthew G. Knepley     *ds = dm->probs[num].ds;
5433e5e52638SMatthew G. Knepley   }
5434e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5435e5e52638SMatthew G. Knepley }
5436e5e52638SMatthew G. Knepley 
5437e5e52638SMatthew G. Knepley /*@
5438083401c6SMatthew G. Knepley   DMSetRegionNumDS - Set the PetscDS for a given mesh region, defined by the region number
5439e5e52638SMatthew G. Knepley 
5440083401c6SMatthew G. Knepley   Not collective
5441e5e52638SMatthew G. Knepley 
5442e5e52638SMatthew G. Knepley   Input Parameters:
5443e5e52638SMatthew G. Knepley + dm     - The DM
5444083401c6SMatthew G. Knepley . num    - The region number, in [0, Nds)
5445083401c6SMatthew G. Knepley . label  - The region label, or NULL
5446083401c6SMatthew G. Knepley . fields - The IS containing the DM field numbers for the fields in this DS, or NULL to prevent setting
5447083401c6SMatthew G. Knepley - ds     - The PetscDS defined on the given region, or NULL to prevent setting
5448e5e52638SMatthew G. Knepley 
5449e5e52638SMatthew G. Knepley   Level: advanced
5450e5e52638SMatthew G. Knepley 
5451083401c6SMatthew G. Knepley .seealso: DMGetRegionDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS()
5452e5e52638SMatthew G. Knepley @*/
5453083401c6SMatthew G. Knepley PetscErrorCode DMSetRegionNumDS(DM dm, PetscInt num, DMLabel label, IS fields, PetscDS ds)
5454e5e52638SMatthew G. Knepley {
5455083401c6SMatthew G. Knepley   PetscInt       Nds;
5456e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5457e5e52638SMatthew G. Knepley 
5458e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5459e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5460083401c6SMatthew G. Knepley   if (label) {PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 3);}
5461083401c6SMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
5462083401c6SMatthew 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);
5463e5e52638SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr);
5464083401c6SMatthew G. Knepley   ierr = DMLabelDestroy(&dm->probs[num].label);CHKERRQ(ierr);
5465083401c6SMatthew G. Knepley   dm->probs[num].label = label;
5466083401c6SMatthew G. Knepley   if (fields) {
5467083401c6SMatthew G. Knepley     PetscValidHeaderSpecific(fields, IS_CLASSID, 4);
5468b3cf3223SMatthew G. Knepley     ierr = PetscObjectReference((PetscObject) fields);CHKERRQ(ierr);
5469083401c6SMatthew G. Knepley     ierr = ISDestroy(&dm->probs[num].fields);CHKERRQ(ierr);
5470083401c6SMatthew G. Knepley     dm->probs[num].fields = fields;
5471e5e52638SMatthew G. Knepley   }
5472083401c6SMatthew G. Knepley   if (ds) {
5473083401c6SMatthew G. Knepley     PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 5);
5474083401c6SMatthew G. Knepley     ierr = PetscObjectReference((PetscObject) ds);CHKERRQ(ierr);
5475083401c6SMatthew G. Knepley     ierr = PetscDSDestroy(&dm->probs[num].ds);CHKERRQ(ierr);
5476083401c6SMatthew G. Knepley     dm->probs[num].ds = ds;
5477083401c6SMatthew G. Knepley   }
5478e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5479e5e52638SMatthew G. Knepley }
5480e5e52638SMatthew G. Knepley 
5481e5e52638SMatthew G. Knepley /*@
54821d3af9e0SMatthew G. Knepley   DMFindRegionNum - Find the region number for a given PetscDS, or -1 if it is not found.
54831d3af9e0SMatthew G. Knepley 
54841d3af9e0SMatthew G. Knepley   Not collective
54851d3af9e0SMatthew G. Knepley 
54861d3af9e0SMatthew G. Knepley   Input Parameters:
54871d3af9e0SMatthew G. Knepley + dm  - The DM
54881d3af9e0SMatthew G. Knepley - ds  - The PetscDS defined on the given region
54891d3af9e0SMatthew G. Knepley 
54901d3af9e0SMatthew G. Knepley   Output Parameter:
54911d3af9e0SMatthew G. Knepley . num - The region number, in [0, Nds), or -1 if not found
54921d3af9e0SMatthew G. Knepley 
54931d3af9e0SMatthew G. Knepley   Level: advanced
54941d3af9e0SMatthew G. Knepley 
54951d3af9e0SMatthew G. Knepley .seealso: DMGetRegionNumDS(), DMGetRegionDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS()
54961d3af9e0SMatthew G. Knepley @*/
54971d3af9e0SMatthew G. Knepley PetscErrorCode DMFindRegionNum(DM dm, PetscDS ds, PetscInt *num)
54981d3af9e0SMatthew G. Knepley {
54991d3af9e0SMatthew G. Knepley   PetscInt       Nds, n;
55001d3af9e0SMatthew G. Knepley   PetscErrorCode ierr;
55011d3af9e0SMatthew G. Knepley 
55021d3af9e0SMatthew G. Knepley   PetscFunctionBegin;
55031d3af9e0SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
55041d3af9e0SMatthew G. Knepley   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 2);
55051d3af9e0SMatthew G. Knepley   PetscValidPointer(num, 3);
55061d3af9e0SMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
55071d3af9e0SMatthew G. Knepley   for (n = 0; n < Nds; ++n) if (ds == dm->probs[n].ds) break;
55081d3af9e0SMatthew G. Knepley   if (n >= Nds) *num = -1;
55091d3af9e0SMatthew G. Knepley   else          *num = n;
55101d3af9e0SMatthew G. Knepley   PetscFunctionReturn(0);
55111d3af9e0SMatthew G. Knepley }
55121d3af9e0SMatthew G. Knepley 
55131d3af9e0SMatthew G. Knepley /*@
5514e5e52638SMatthew G. Knepley   DMCreateDS - Create the discrete systems for the DM based upon the fields added to the DM
5515e5e52638SMatthew G. Knepley 
5516d083f849SBarry Smith   Collective on dm
5517e5e52638SMatthew G. Knepley 
5518e5e52638SMatthew G. Knepley   Input Parameter:
5519e5e52638SMatthew G. Knepley . dm - The DM
5520e5e52638SMatthew G. Knepley 
552145480ffeSMatthew G. Knepley   Options Database Keys:
552245480ffeSMatthew G. Knepley . -dm_petscds_view - View all the PetscDS objects in this DM
552345480ffeSMatthew G. Knepley 
5524e5e52638SMatthew G. Knepley   Note: If the label has a DS defined, it will be replaced. Otherwise, it will be added to the DM.
5525e5e52638SMatthew G. Knepley 
5526e5e52638SMatthew G. Knepley   Level: intermediate
5527e5e52638SMatthew G. Knepley 
5528e5e52638SMatthew G. Knepley .seealso: DMSetField, DMAddField(), DMGetDS(), DMGetCellDS(), DMGetRegionDS(), DMSetRegionDS()
5529e5e52638SMatthew G. Knepley @*/
5530e5e52638SMatthew G. Knepley PetscErrorCode DMCreateDS(DM dm)
5531e5e52638SMatthew G. Knepley {
5532e5e52638SMatthew G. Knepley   MPI_Comm       comm;
5533083401c6SMatthew G. Knepley   PetscDS        dsDef;
5534083401c6SMatthew G. Knepley   DMLabel       *labelSet;
5535f9244615SMatthew G. Knepley   PetscInt       dE, Nf = dm->Nf, f, s, Nl, l, Ndef, k;
5536f9244615SMatthew G. Knepley   PetscBool      doSetup = PETSC_TRUE, flg;
5537e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5538e5e52638SMatthew G. Knepley 
5539e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5540e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5541e5e52638SMatthew G. Knepley   if (!dm->fields) PetscFunctionReturn(0);
5542e5e52638SMatthew G. Knepley   ierr = PetscObjectGetComm((PetscObject) dm, &comm);CHKERRQ(ierr);
5543083401c6SMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &dE);CHKERRQ(ierr);
5544083401c6SMatthew G. Knepley   /* Determine how many regions we have */
5545083401c6SMatthew G. Knepley   ierr = PetscMalloc1(Nf, &labelSet);CHKERRQ(ierr);
5546083401c6SMatthew G. Knepley   Nl   = 0;
5547083401c6SMatthew G. Knepley   Ndef = 0;
5548083401c6SMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
5549083401c6SMatthew G. Knepley     DMLabel  label = dm->fields[f].label;
5550083401c6SMatthew G. Knepley     PetscInt l;
5551083401c6SMatthew G. Knepley 
5552f918ec44SMatthew G. Knepley #ifdef PETSC_HAVE_LIBCEED
5553f918ec44SMatthew G. Knepley     /* Move CEED context to discretizations */
5554f918ec44SMatthew G. Knepley     {
5555f918ec44SMatthew G. Knepley       PetscClassId id;
5556f918ec44SMatthew G. Knepley 
5557f918ec44SMatthew G. Knepley       ierr = PetscObjectGetClassId(dm->fields[f].disc, &id);CHKERRQ(ierr);
5558f918ec44SMatthew G. Knepley       if (id == PETSCFE_CLASSID) {
5559f918ec44SMatthew G. Knepley         Ceed ceed;
5560f918ec44SMatthew G. Knepley 
5561f918ec44SMatthew G. Knepley         ierr = DMGetCeed(dm, &ceed);CHKERRQ(ierr);
5562f918ec44SMatthew G. Knepley         ierr = PetscFESetCeed((PetscFE) dm->fields[f].disc, ceed);CHKERRQ(ierr);
5563f918ec44SMatthew G. Knepley       }
5564f918ec44SMatthew G. Knepley     }
5565f918ec44SMatthew G. Knepley #endif
5566083401c6SMatthew G. Knepley     if (!label) {++Ndef; continue;}
5567083401c6SMatthew G. Knepley     for (l = 0; l < Nl; ++l) if (label == labelSet[l]) break;
5568083401c6SMatthew G. Knepley     if (l < Nl) continue;
5569083401c6SMatthew G. Knepley     labelSet[Nl++] = label;
5570083401c6SMatthew G. Knepley   }
5571083401c6SMatthew G. Knepley   /* Create default DS if there are no labels to intersect with */
5572083401c6SMatthew G. Knepley   ierr = DMGetRegionDS(dm, NULL, NULL, &dsDef);CHKERRQ(ierr);
5573083401c6SMatthew G. Knepley   if (!dsDef && Ndef && !Nl) {
5574b3cf3223SMatthew G. Knepley     IS        fields;
5575b3cf3223SMatthew G. Knepley     PetscInt *fld, nf;
5576b3cf3223SMatthew G. Knepley 
5577b3cf3223SMatthew G. Knepley     for (f = 0, nf = 0; f < Nf; ++f) if (!dm->fields[f].label) ++nf;
5578083401c6SMatthew G. Knepley     if (nf) {
5579b3cf3223SMatthew G. Knepley       ierr = PetscMalloc1(nf, &fld);CHKERRQ(ierr);
5580b3cf3223SMatthew G. Knepley       for (f = 0, nf = 0; f < Nf; ++f) if (!dm->fields[f].label) fld[nf++] = f;
558188f0c812SMatthew G. Knepley       ierr = ISCreate(PETSC_COMM_SELF, &fields);CHKERRQ(ierr);
558288f0c812SMatthew G. Knepley       ierr = PetscObjectSetOptionsPrefix((PetscObject) fields, "dm_fields_");CHKERRQ(ierr);
558388f0c812SMatthew G. Knepley       ierr = ISSetType(fields, ISGENERAL);CHKERRQ(ierr);
558488f0c812SMatthew G. Knepley       ierr = ISGeneralSetIndices(fields, nf, fld, PETSC_OWN_POINTER);CHKERRQ(ierr);
558588f0c812SMatthew G. Knepley 
558645480ffeSMatthew G. Knepley       ierr = PetscDSCreate(PETSC_COMM_SELF, &dsDef);CHKERRQ(ierr);
5587083401c6SMatthew G. Knepley       ierr = DMSetRegionDS(dm, NULL, fields, dsDef);CHKERRQ(ierr);
5588083401c6SMatthew G. Knepley       ierr = PetscDSDestroy(&dsDef);CHKERRQ(ierr);
5589b3cf3223SMatthew G. Knepley       ierr = ISDestroy(&fields);CHKERRQ(ierr);
55902df9ee95SMatthew G. Knepley     }
5591083401c6SMatthew G. Knepley   }
5592083401c6SMatthew G. Knepley   ierr = DMGetRegionDS(dm, NULL, NULL, &dsDef);CHKERRQ(ierr);
5593083401c6SMatthew G. Knepley   if (dsDef) {ierr = PetscDSSetCoordinateDimension(dsDef, dE);CHKERRQ(ierr);}
5594083401c6SMatthew G. Knepley   /* Intersect labels with default fields */
5595083401c6SMatthew G. Knepley   if (Ndef && Nl) {
55960122748bSMatthew G. Knepley     DM              plex;
5597083401c6SMatthew G. Knepley     DMLabel         cellLabel;
5598083401c6SMatthew G. Knepley     IS              fieldIS, allcellIS, defcellIS = NULL;
5599083401c6SMatthew G. Knepley     PetscInt       *fields;
5600083401c6SMatthew G. Knepley     const PetscInt *cells;
5601083401c6SMatthew G. Knepley     PetscInt        depth, nf = 0, n, c;
56020122748bSMatthew G. Knepley 
56030122748bSMatthew G. Knepley     ierr = DMConvert(dm, DMPLEX, &plex);CHKERRQ(ierr);
56040122748bSMatthew G. Knepley     ierr = DMPlexGetDepth(plex, &depth);CHKERRQ(ierr);
5605083401c6SMatthew G. Knepley     ierr = DMGetStratumIS(plex, "dim", depth, &allcellIS);CHKERRQ(ierr);
5606083401c6SMatthew G. Knepley     if (!allcellIS) {ierr = DMGetStratumIS(plex, "depth", depth, &allcellIS);CHKERRQ(ierr);}
5607083401c6SMatthew G. Knepley     for (l = 0; l < Nl; ++l) {
5608083401c6SMatthew G. Knepley       DMLabel label = labelSet[l];
5609083401c6SMatthew G. Knepley       IS      pointIS;
5610083401c6SMatthew G. Knepley 
5611083401c6SMatthew G. Knepley       ierr = ISDestroy(&defcellIS);CHKERRQ(ierr);
5612083401c6SMatthew G. Knepley       ierr = DMLabelGetStratumIS(label, 1, &pointIS);CHKERRQ(ierr);
5613083401c6SMatthew G. Knepley       ierr = ISDifference(allcellIS, pointIS, &defcellIS);CHKERRQ(ierr);
5614083401c6SMatthew G. Knepley       ierr = ISDestroy(&pointIS);CHKERRQ(ierr);
5615083401c6SMatthew G. Knepley     }
5616083401c6SMatthew G. Knepley     ierr = ISDestroy(&allcellIS);CHKERRQ(ierr);
5617083401c6SMatthew G. Knepley 
5618083401c6SMatthew G. Knepley     ierr = DMLabelCreate(PETSC_COMM_SELF, "defaultCells", &cellLabel);CHKERRQ(ierr);
5619083401c6SMatthew G. Knepley     ierr = ISGetLocalSize(defcellIS, &n);CHKERRQ(ierr);
5620083401c6SMatthew G. Knepley     ierr = ISGetIndices(defcellIS, &cells);CHKERRQ(ierr);
5621083401c6SMatthew G. Knepley     for (c = 0; c < n; ++c) {ierr = DMLabelSetValue(cellLabel, cells[c], 1);CHKERRQ(ierr);}
5622083401c6SMatthew G. Knepley     ierr = ISRestoreIndices(defcellIS, &cells);CHKERRQ(ierr);
5623083401c6SMatthew G. Knepley     ierr = ISDestroy(&defcellIS);CHKERRQ(ierr);
5624083401c6SMatthew G. Knepley     ierr = DMPlexLabelComplete(plex, cellLabel);CHKERRQ(ierr);
5625083401c6SMatthew G. Knepley 
5626083401c6SMatthew G. Knepley     ierr = PetscMalloc1(Ndef, &fields);CHKERRQ(ierr);
5627083401c6SMatthew G. Knepley     for (f = 0; f < Nf; ++f) if (!dm->fields[f].label) fields[nf++] = f;
5628083401c6SMatthew G. Knepley     ierr = ISCreate(PETSC_COMM_SELF, &fieldIS);CHKERRQ(ierr);
5629083401c6SMatthew G. Knepley     ierr = PetscObjectSetOptionsPrefix((PetscObject) fieldIS, "dm_fields_");CHKERRQ(ierr);
5630083401c6SMatthew G. Knepley     ierr = ISSetType(fieldIS, ISGENERAL);CHKERRQ(ierr);
5631083401c6SMatthew G. Knepley     ierr = ISGeneralSetIndices(fieldIS, nf, fields, PETSC_OWN_POINTER);CHKERRQ(ierr);
5632083401c6SMatthew G. Knepley 
563345480ffeSMatthew G. Knepley     ierr = PetscDSCreate(PETSC_COMM_SELF, &dsDef);CHKERRQ(ierr);
5634083401c6SMatthew G. Knepley     ierr = DMSetRegionDS(dm, cellLabel, fieldIS, dsDef);CHKERRQ(ierr);
5635083401c6SMatthew G. Knepley     ierr = DMLabelDestroy(&cellLabel);CHKERRQ(ierr);
5636083401c6SMatthew G. Knepley     ierr = PetscDSSetCoordinateDimension(dsDef, dE);CHKERRQ(ierr);
5637083401c6SMatthew G. Knepley     ierr = PetscDSDestroy(&dsDef);CHKERRQ(ierr);
5638083401c6SMatthew G. Knepley     ierr = ISDestroy(&fieldIS);CHKERRQ(ierr);
56390122748bSMatthew G. Knepley     ierr = DMDestroy(&plex);CHKERRQ(ierr);
5640083401c6SMatthew G. Knepley   }
5641083401c6SMatthew G. Knepley   /* Create label DSes
5642083401c6SMatthew G. Knepley      - WE ONLY SUPPORT IDENTICAL OR DISJOINT LABELS
5643083401c6SMatthew G. Knepley   */
5644083401c6SMatthew G. Knepley   /* TODO Should check that labels are disjoint */
5645083401c6SMatthew G. Knepley   for (l = 0; l < Nl; ++l) {
5646083401c6SMatthew G. Knepley     DMLabel   label = labelSet[l];
5647083401c6SMatthew G. Knepley     PetscDS   ds;
5648083401c6SMatthew G. Knepley     IS        fields;
5649083401c6SMatthew G. Knepley     PetscInt *fld, nf;
5650083401c6SMatthew G. Knepley 
565145480ffeSMatthew G. Knepley     ierr = PetscDSCreate(PETSC_COMM_SELF, &ds);CHKERRQ(ierr);
5652083401c6SMatthew G. Knepley     for (f = 0, nf = 0; f < Nf; ++f) if (label == dm->fields[f].label || !dm->fields[f].label) ++nf;
5653083401c6SMatthew G. Knepley     ierr = PetscMalloc1(nf, &fld);CHKERRQ(ierr);
5654083401c6SMatthew G. Knepley     for (f = 0, nf = 0; f < Nf; ++f) if (label == dm->fields[f].label || !dm->fields[f].label) fld[nf++] = f;
5655083401c6SMatthew G. Knepley     ierr = ISCreate(PETSC_COMM_SELF, &fields);CHKERRQ(ierr);
5656083401c6SMatthew G. Knepley     ierr = PetscObjectSetOptionsPrefix((PetscObject) fields, "dm_fields_");CHKERRQ(ierr);
5657083401c6SMatthew G. Knepley     ierr = ISSetType(fields, ISGENERAL);CHKERRQ(ierr);
5658083401c6SMatthew G. Knepley     ierr = ISGeneralSetIndices(fields, nf, fld, PETSC_OWN_POINTER);CHKERRQ(ierr);
5659083401c6SMatthew G. Knepley     ierr = DMSetRegionDS(dm, label, fields, ds);CHKERRQ(ierr);
5660083401c6SMatthew G. Knepley     ierr = ISDestroy(&fields);CHKERRQ(ierr);
5661083401c6SMatthew G. Knepley     ierr = PetscDSSetCoordinateDimension(ds, dE);CHKERRQ(ierr);
5662083401c6SMatthew G. Knepley     {
5663083401c6SMatthew G. Knepley       DMPolytopeType ct;
5664083401c6SMatthew G. Knepley       PetscInt       lStart, lEnd;
5665083401c6SMatthew G. Knepley       PetscBool      isHybridLocal = PETSC_FALSE, isHybrid;
56660122748bSMatthew G. Knepley 
5667e5e52638SMatthew G. Knepley       ierr = DMLabelGetBounds(label, &lStart, &lEnd);CHKERRQ(ierr);
5668665f567fSMatthew G. Knepley       if (lStart >= 0) {
5669412e9a14SMatthew G. Knepley         ierr = DMPlexGetCellType(dm, lStart, &ct);CHKERRQ(ierr);
5670412e9a14SMatthew G. Knepley         switch (ct) {
5671412e9a14SMatthew G. Knepley           case DM_POLYTOPE_POINT_PRISM_TENSOR:
5672412e9a14SMatthew G. Knepley           case DM_POLYTOPE_SEG_PRISM_TENSOR:
5673412e9a14SMatthew G. Knepley           case DM_POLYTOPE_TRI_PRISM_TENSOR:
5674412e9a14SMatthew G. Knepley           case DM_POLYTOPE_QUAD_PRISM_TENSOR:
5675083401c6SMatthew G. Knepley             isHybridLocal = PETSC_TRUE;break;
5676083401c6SMatthew G. Knepley           default: break;
5677412e9a14SMatthew G. Knepley         }
5678665f567fSMatthew G. Knepley       }
5679ffc4695bSBarry Smith       ierr = MPI_Allreduce(&isHybridLocal, &isHybrid, 1, MPIU_BOOL, MPI_LOR, comm);CHKERRMPI(ierr);
5680083401c6SMatthew G. Knepley       ierr = PetscDSSetHybrid(ds, isHybrid);CHKERRQ(ierr);
5681e5e52638SMatthew G. Knepley     }
5682083401c6SMatthew G. Knepley     ierr = PetscDSDestroy(&ds);CHKERRQ(ierr);
5683e5e52638SMatthew G. Knepley   }
5684083401c6SMatthew G. Knepley   ierr = PetscFree(labelSet);CHKERRQ(ierr);
5685e5e52638SMatthew G. Knepley   /* Set fields in DSes */
5686083401c6SMatthew G. Knepley   for (s = 0; s < dm->Nds; ++s) {
5687083401c6SMatthew G. Knepley     PetscDS         ds     = dm->probs[s].ds;
5688083401c6SMatthew G. Knepley     IS              fields = dm->probs[s].fields;
5689083401c6SMatthew G. Knepley     const PetscInt *fld;
5690083401c6SMatthew G. Knepley     PetscInt        nf;
5691e5e52638SMatthew G. Knepley 
5692083401c6SMatthew G. Knepley     ierr = ISGetLocalSize(fields, &nf);CHKERRQ(ierr);
5693083401c6SMatthew G. Knepley     ierr = ISGetIndices(fields, &fld);CHKERRQ(ierr);
5694083401c6SMatthew G. Knepley     for (f = 0; f < nf; ++f) {
5695083401c6SMatthew G. Knepley       PetscObject  disc  = dm->fields[fld[f]].disc;
5696083401c6SMatthew G. Knepley       PetscBool    isHybrid;
5697e5e52638SMatthew G. Knepley       PetscClassId id;
5698e5e52638SMatthew G. Knepley 
5699083401c6SMatthew G. Knepley       ierr = PetscDSGetHybrid(ds, &isHybrid);CHKERRQ(ierr);
5700083401c6SMatthew G. Knepley       /* If this is a cohesive cell, then it needs the lower dimensional discretization */
5701083401c6SMatthew G. Knepley       if (isHybrid && f < nf-1) {ierr = PetscFEGetHeightSubspace((PetscFE) disc, 1, (PetscFE *) &disc);CHKERRQ(ierr);}
5702083401c6SMatthew G. Knepley       ierr = PetscDSSetDiscretization(ds, f, disc);CHKERRQ(ierr);
5703083401c6SMatthew G. Knepley       /* We allow people to have placeholder fields and construct the Section by hand */
5704e5e52638SMatthew G. Knepley       ierr = PetscObjectGetClassId(disc, &id);CHKERRQ(ierr);
5705e5e52638SMatthew G. Knepley       if ((id != PETSCFE_CLASSID) && (id != PETSCFV_CLASSID)) doSetup = PETSC_FALSE;
5706e5e52638SMatthew G. Knepley     }
5707083401c6SMatthew G. Knepley     ierr = ISRestoreIndices(fields, &fld);CHKERRQ(ierr);
5708e5e52638SMatthew G. Knepley   }
5709f9244615SMatthew G. Knepley   /* Allow k-jet tabulation */
5710f9244615SMatthew G. Knepley   ierr = PetscOptionsGetInt(NULL, ((PetscObject) dm)->prefix, "-dm_ds_jet_degree", &k, &flg);CHKERRQ(ierr);
5711f9244615SMatthew G. Knepley   if (flg) {
57123b4aee56SMatthew G. Knepley     for (s = 0; s < dm->Nds; ++s) {
57133b4aee56SMatthew G. Knepley       PetscDS  ds = dm->probs[s].ds;
57143b4aee56SMatthew G. Knepley       PetscInt Nf, f;
57153b4aee56SMatthew G. Knepley 
57163b4aee56SMatthew G. Knepley       ierr = PetscDSGetNumFields(ds, &Nf);CHKERRQ(ierr);
57173b4aee56SMatthew G. Knepley       for (f = 0; f < Nf; ++f) {ierr = PetscDSSetJetDegree(ds, f, k);CHKERRQ(ierr);}
57183b4aee56SMatthew G. Knepley     }
5719f9244615SMatthew G. Knepley   }
5720e5e52638SMatthew G. Knepley   /* Setup DSes */
5721e5e52638SMatthew G. Knepley   if (doSetup) {
5722e5e52638SMatthew G. Knepley     for (s = 0; s < dm->Nds; ++s) {ierr = PetscDSSetUp(dm->probs[s].ds);CHKERRQ(ierr);}
5723e5e52638SMatthew G. Knepley   }
5724e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5725e5e52638SMatthew G. Knepley }
5726e5e52638SMatthew G. Knepley 
5727e5e52638SMatthew G. Knepley /*@
57287f96f943SMatthew G. Knepley   DMComputeExactSolution - Compute the exact solution for a given DM, using the PetscDS information.
57297f96f943SMatthew G. Knepley 
5730f2cacb80SMatthew G. Knepley   Collective on DM
5731f2cacb80SMatthew G. Knepley 
57327f96f943SMatthew G. Knepley   Input Parameters:
57337f96f943SMatthew G. Knepley + dm   - The DM
57347f96f943SMatthew G. Knepley - time - The time
57357f96f943SMatthew G. Knepley 
57367f96f943SMatthew G. Knepley   Output Parameters:
5737f2cacb80SMatthew G. Knepley + u    - The vector will be filled with exact solution values, or NULL
5738f2cacb80SMatthew G. Knepley - u_t  - The vector will be filled with the time derivative of exact solution values, or NULL
57397f96f943SMatthew G. Knepley 
57407f96f943SMatthew G. Knepley   Note: The user must call PetscDSSetExactSolution() beforehand
57417f96f943SMatthew G. Knepley 
57427f96f943SMatthew G. Knepley   Level: developer
57437f96f943SMatthew G. Knepley 
57447f96f943SMatthew G. Knepley .seealso: PetscDSSetExactSolution()
57457f96f943SMatthew G. Knepley @*/
5746f2cacb80SMatthew G. Knepley PetscErrorCode DMComputeExactSolution(DM dm, PetscReal time, Vec u, Vec u_t)
57477f96f943SMatthew G. Knepley {
57487f96f943SMatthew G. Knepley   PetscErrorCode (**exacts)(PetscInt, PetscReal, const PetscReal x[], PetscInt, PetscScalar *u, void *ctx);
57497f96f943SMatthew G. Knepley   void            **ectxs;
57507f96f943SMatthew G. Knepley   PetscInt          Nf, Nds, s;
57517f96f943SMatthew G. Knepley   PetscErrorCode    ierr;
57527f96f943SMatthew G. Knepley 
57537f96f943SMatthew G. Knepley   PetscFunctionBegin;
5754f2cacb80SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5755f2cacb80SMatthew G. Knepley   if (u)   PetscValidHeaderSpecific(u, VEC_CLASSID, 3);
5756f2cacb80SMatthew G. Knepley   if (u_t) PetscValidHeaderSpecific(u_t, VEC_CLASSID, 4);
57577f96f943SMatthew G. Knepley   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
57587f96f943SMatthew G. Knepley   ierr = PetscMalloc2(Nf, &exacts, Nf, &ectxs);CHKERRQ(ierr);
57597f96f943SMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
57607f96f943SMatthew G. Knepley   for (s = 0; s < Nds; ++s) {
57617f96f943SMatthew G. Knepley     PetscDS         ds;
57627f96f943SMatthew G. Knepley     DMLabel         label;
57637f96f943SMatthew G. Knepley     IS              fieldIS;
57647f96f943SMatthew G. Knepley     const PetscInt *fields, id = 1;
57657f96f943SMatthew G. Knepley     PetscInt        dsNf, f;
57667f96f943SMatthew G. Knepley 
57677f96f943SMatthew G. Knepley     ierr = DMGetRegionNumDS(dm, s, &label, &fieldIS, &ds);CHKERRQ(ierr);
57687f96f943SMatthew G. Knepley     ierr = PetscDSGetNumFields(ds, &dsNf);CHKERRQ(ierr);
57697f96f943SMatthew G. Knepley     ierr = ISGetIndices(fieldIS, &fields);CHKERRQ(ierr);
57707f96f943SMatthew G. Knepley     ierr = PetscArrayzero(exacts, Nf);CHKERRQ(ierr);
57717f96f943SMatthew G. Knepley     ierr = PetscArrayzero(ectxs, Nf);CHKERRQ(ierr);
5772f2cacb80SMatthew G. Knepley     if (u) {
57737f96f943SMatthew G. Knepley       for (f = 0; f < dsNf; ++f) {
57747f96f943SMatthew G. Knepley         const PetscInt field = fields[f];
57757f96f943SMatthew G. Knepley         ierr = PetscDSGetExactSolution(ds, field, &exacts[field], &ectxs[field]);CHKERRQ(ierr);
57767f96f943SMatthew G. Knepley       }
57777f96f943SMatthew G. Knepley       ierr = ISRestoreIndices(fieldIS, &fields);CHKERRQ(ierr);
57787f96f943SMatthew G. Knepley       if (label) {
57797f96f943SMatthew G. Knepley         ierr = DMProjectFunctionLabel(dm, time, label, 1, &id, 0, NULL, exacts, ectxs, INSERT_ALL_VALUES, u);CHKERRQ(ierr);
57807f96f943SMatthew G. Knepley       } else {
57817f96f943SMatthew G. Knepley         ierr = DMProjectFunction(dm, time, exacts, ectxs, INSERT_ALL_VALUES, u);CHKERRQ(ierr);
57827f96f943SMatthew G. Knepley       }
57837f96f943SMatthew G. Knepley     }
5784f2cacb80SMatthew G. Knepley     if (u_t) {
5785f2cacb80SMatthew G. Knepley       ierr = PetscArrayzero(exacts, Nf);CHKERRQ(ierr);
5786f2cacb80SMatthew G. Knepley       ierr = PetscArrayzero(ectxs, Nf);CHKERRQ(ierr);
5787f2cacb80SMatthew G. Knepley       for (f = 0; f < dsNf; ++f) {
5788f2cacb80SMatthew G. Knepley         const PetscInt field = fields[f];
5789f2cacb80SMatthew G. Knepley         ierr = PetscDSGetExactSolutionTimeDerivative(ds, field, &exacts[field], &ectxs[field]);CHKERRQ(ierr);
5790f2cacb80SMatthew G. Knepley       }
5791f2cacb80SMatthew G. Knepley       ierr = ISRestoreIndices(fieldIS, &fields);CHKERRQ(ierr);
5792f2cacb80SMatthew G. Knepley       if (label) {
5793f2cacb80SMatthew G. Knepley         ierr = DMProjectFunctionLabel(dm, time, label, 1, &id, 0, NULL, exacts, ectxs, INSERT_ALL_VALUES, u_t);CHKERRQ(ierr);
5794f2cacb80SMatthew G. Knepley       } else {
5795f2cacb80SMatthew G. Knepley         ierr = DMProjectFunction(dm, time, exacts, ectxs, INSERT_ALL_VALUES, u_t);CHKERRQ(ierr);
5796f2cacb80SMatthew G. Knepley       }
5797f2cacb80SMatthew G. Knepley     }
5798f2cacb80SMatthew G. Knepley   }
5799f2cacb80SMatthew G. Knepley   if (u) {
58007f96f943SMatthew G. Knepley     ierr = PetscObjectSetName((PetscObject) u, "Exact Solution");CHKERRQ(ierr);
58017f96f943SMatthew G. Knepley     ierr = PetscObjectSetOptionsPrefix((PetscObject) u, "exact_");CHKERRQ(ierr);
5802f2cacb80SMatthew G. Knepley   }
5803f2cacb80SMatthew G. Knepley   if (u_t) {
5804f2cacb80SMatthew G. Knepley     ierr = PetscObjectSetName((PetscObject) u, "Exact Solution Time Derivative");CHKERRQ(ierr);
5805f2cacb80SMatthew G. Knepley     ierr = PetscObjectSetOptionsPrefix((PetscObject) u_t, "exact_t_");CHKERRQ(ierr);
5806f2cacb80SMatthew G. Knepley   }
58077f96f943SMatthew G. Knepley   ierr = PetscFree2(exacts, ectxs);CHKERRQ(ierr);
58087f96f943SMatthew G. Knepley   PetscFunctionReturn(0);
58097f96f943SMatthew G. Knepley }
58107f96f943SMatthew G. Knepley 
581145480ffeSMatthew G. Knepley PetscErrorCode DMTransferDS_Internal(DM dm, DMLabel label, IS fields, PetscDS ds)
581245480ffeSMatthew G. Knepley {
581345480ffeSMatthew G. Knepley   PetscDS        dsNew;
581445480ffeSMatthew G. Knepley   DSBoundary     b;
581545480ffeSMatthew G. Knepley   PetscInt       cdim, Nf, f;
5816df911668SMatthew G. Knepley   PetscBool      isHybrid;
581745480ffeSMatthew G. Knepley   void          *ctx;
581845480ffeSMatthew G. Knepley   PetscErrorCode ierr;
581945480ffeSMatthew G. Knepley 
582045480ffeSMatthew G. Knepley   PetscFunctionBegin;
582145480ffeSMatthew G. Knepley   ierr = PetscDSCreate(PetscObjectComm((PetscObject) ds), &dsNew);CHKERRQ(ierr);
582245480ffeSMatthew G. Knepley   ierr = PetscDSCopyConstants(ds, dsNew);CHKERRQ(ierr);
582345480ffeSMatthew G. Knepley   ierr = PetscDSCopyExactSolutions(ds, dsNew);CHKERRQ(ierr);
582445480ffeSMatthew G. Knepley   ierr = PetscDSSelectDiscretizations(ds, PETSC_DETERMINE, NULL, dsNew);CHKERRQ(ierr);
582545480ffeSMatthew G. Knepley   ierr = PetscDSCopyEquations(ds, dsNew);CHKERRQ(ierr);
582645480ffeSMatthew G. Knepley   ierr = PetscDSGetNumFields(ds, &Nf);CHKERRQ(ierr);
582745480ffeSMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
582845480ffeSMatthew G. Knepley     ierr = PetscDSGetContext(ds, f, &ctx);CHKERRQ(ierr);
582945480ffeSMatthew G. Knepley     ierr = PetscDSSetContext(dsNew, f, ctx);CHKERRQ(ierr);
583045480ffeSMatthew G. Knepley   }
583145480ffeSMatthew G. Knepley   if (Nf) {
583245480ffeSMatthew G. Knepley     ierr = PetscDSGetCoordinateDimension(ds, &cdim);CHKERRQ(ierr);
583345480ffeSMatthew G. Knepley     ierr = PetscDSSetCoordinateDimension(dsNew, cdim);CHKERRQ(ierr);
583445480ffeSMatthew G. Knepley   }
583545480ffeSMatthew G. Knepley   ierr = PetscDSCopyBoundary(ds, PETSC_DETERMINE, NULL, dsNew);CHKERRQ(ierr);
583645480ffeSMatthew G. Knepley   for (b = dsNew->boundary; b; b = b->next) {
583745480ffeSMatthew G. Knepley     ierr = DMGetLabel(dm, b->lname, &b->label);CHKERRQ(ierr);
583845480ffeSMatthew G. Knepley     /* Do not check if label exists here, since p4est calls this for the reference tree which does not have the labels */
583945480ffeSMatthew G. Knepley     //if (!b->label) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Label %s missing in new DM", name);
584045480ffeSMatthew G. Knepley   }
5841df911668SMatthew G. Knepley   ierr = PetscDSGetHybrid(ds, &isHybrid);CHKERRQ(ierr);
5842df911668SMatthew G. Knepley   ierr = PetscDSSetHybrid(dsNew, isHybrid);CHKERRQ(ierr);
584345480ffeSMatthew G. Knepley 
584445480ffeSMatthew G. Knepley   ierr = DMSetRegionDS(dm, label, fields, dsNew);CHKERRQ(ierr);
584545480ffeSMatthew G. Knepley   ierr = PetscDSDestroy(&dsNew);CHKERRQ(ierr);
584645480ffeSMatthew G. Knepley   PetscFunctionReturn(0);
584745480ffeSMatthew G. Knepley }
584845480ffeSMatthew G. Knepley 
58497f96f943SMatthew G. Knepley /*@
5850e5e52638SMatthew G. Knepley   DMCopyDS - Copy the discrete systems for the DM into another DM
5851e5e52638SMatthew G. Knepley 
5852d083f849SBarry Smith   Collective on dm
5853e5e52638SMatthew G. Knepley 
5854e5e52638SMatthew G. Knepley   Input Parameter:
5855e5e52638SMatthew G. Knepley . dm - The DM
5856e5e52638SMatthew G. Knepley 
5857e5e52638SMatthew G. Knepley   Output Parameter:
5858e5e52638SMatthew G. Knepley . newdm - The DM
5859e5e52638SMatthew G. Knepley 
5860e5e52638SMatthew G. Knepley   Level: advanced
5861e5e52638SMatthew G. Knepley 
5862e5e52638SMatthew G. Knepley .seealso: DMCopyFields(), DMAddField(), DMGetDS(), DMGetCellDS(), DMGetRegionDS(), DMSetRegionDS()
5863e5e52638SMatthew G. Knepley @*/
5864e5e52638SMatthew G. Knepley PetscErrorCode DMCopyDS(DM dm, DM newdm)
5865e5e52638SMatthew G. Knepley {
5866e5e52638SMatthew G. Knepley   PetscInt       Nds, s;
5867e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5868e5e52638SMatthew G. Knepley 
5869e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5870e5e52638SMatthew G. Knepley   if (dm == newdm) PetscFunctionReturn(0);
5871e5e52638SMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
5872e5e52638SMatthew G. Knepley   ierr = DMClearDS(newdm);CHKERRQ(ierr);
5873e5e52638SMatthew G. Knepley   for (s = 0; s < Nds; ++s) {
5874e5e52638SMatthew G. Knepley     DMLabel  label;
5875b3cf3223SMatthew G. Knepley     IS       fields;
587645480ffeSMatthew G. Knepley     PetscDS  ds, newds;
5877783e2ec8SMatthew G. Knepley     PetscInt Nbd, bd;
5878e5e52638SMatthew G. Knepley 
5879b3cf3223SMatthew G. Knepley     ierr = DMGetRegionNumDS(dm, s, &label, &fields, &ds);CHKERRQ(ierr);
5880b8025e53SMatthew G. Knepley     /* TODO: We need to change all keys from labels in the old DM to labels in the new DM */
588145480ffeSMatthew G. Knepley     ierr = DMTransferDS_Internal(newdm, label, fields, ds);CHKERRQ(ierr);
588245480ffeSMatthew G. Knepley     /* Commplete new labels in the new DS */
588345480ffeSMatthew G. Knepley     ierr = DMGetRegionDS(newdm, label, NULL, &newds);CHKERRQ(ierr);
588445480ffeSMatthew G. Knepley     ierr = PetscDSGetNumBoundary(newds, &Nbd);CHKERRQ(ierr);
5885783e2ec8SMatthew G. Knepley     for (bd = 0; bd < Nbd; ++bd) {
5886b8025e53SMatthew G. Knepley       PetscWeakForm wf;
588745480ffeSMatthew G. Knepley       DMLabel       label;
5888783e2ec8SMatthew G. Knepley       PetscInt      field;
5889783e2ec8SMatthew G. Knepley 
5890b8025e53SMatthew G. Knepley       ierr = PetscDSGetBoundary(newds, bd, &wf, NULL, NULL, &label, NULL, NULL, &field, NULL, NULL, NULL, NULL, NULL);CHKERRQ(ierr);
589145480ffeSMatthew G. Knepley       ierr = DMCompleteBoundaryLabel_Internal(newdm, newds, field, bd, label);CHKERRQ(ierr);
5892b8025e53SMatthew G. Knepley       ierr = PetscWeakFormReplaceLabel(wf, label);CHKERRQ(ierr);
5893783e2ec8SMatthew G. Knepley     }
5894e5e52638SMatthew G. Knepley   }
5895e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5896e5e52638SMatthew G. Knepley }
5897e5e52638SMatthew G. Knepley 
5898e5e52638SMatthew G. Knepley /*@
5899e5e52638SMatthew G. Knepley   DMCopyDisc - Copy the fields and discrete systems for the DM into another DM
5900e5e52638SMatthew G. Knepley 
5901d083f849SBarry Smith   Collective on dm
5902e5e52638SMatthew G. Knepley 
5903e5e52638SMatthew G. Knepley   Input Parameter:
5904e5e52638SMatthew G. Knepley . dm - The DM
5905e5e52638SMatthew G. Knepley 
5906e5e52638SMatthew G. Knepley   Output Parameter:
5907e5e52638SMatthew G. Knepley . newdm - The DM
5908e5e52638SMatthew G. Knepley 
5909e5e52638SMatthew G. Knepley   Level: advanced
5910e5e52638SMatthew G. Knepley 
5911e5e52638SMatthew G. Knepley .seealso: DMCopyFields(), DMCopyDS()
5912e5e52638SMatthew G. Knepley @*/
5913e5e52638SMatthew G. Knepley PetscErrorCode DMCopyDisc(DM dm, DM newdm)
5914e5e52638SMatthew G. Knepley {
5915e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5916e5e52638SMatthew G. Knepley 
5917e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5918e5e52638SMatthew G. Knepley   ierr = DMCopyFields(dm, newdm);CHKERRQ(ierr);
5919e5e52638SMatthew G. Knepley   ierr = DMCopyDS(dm, newdm);CHKERRQ(ierr);
5920e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5921e5e52638SMatthew G. Knepley }
5922e5e52638SMatthew G. Knepley 
5923b64e0483SPeter Brune PetscErrorCode DMRestrictHook_Coordinates(DM dm,DM dmc,void *ctx)
5924b64e0483SPeter Brune {
5925b64e0483SPeter Brune   DM dm_coord,dmc_coord;
5926b64e0483SPeter Brune   PetscErrorCode ierr;
5927b64e0483SPeter Brune   Vec coords,ccoords;
59286dbf9973SLawrence Mitchell   Mat inject;
5929b64e0483SPeter Brune   PetscFunctionBegin;
5930b64e0483SPeter Brune   ierr = DMGetCoordinateDM(dm,&dm_coord);CHKERRQ(ierr);
5931b64e0483SPeter Brune   ierr = DMGetCoordinateDM(dmc,&dmc_coord);CHKERRQ(ierr);
5932b64e0483SPeter Brune   ierr = DMGetCoordinates(dm,&coords);CHKERRQ(ierr);
5933b64e0483SPeter Brune   ierr = DMGetCoordinates(dmc,&ccoords);CHKERRQ(ierr);
5934b64e0483SPeter Brune   if (coords && !ccoords) {
5935b64e0483SPeter Brune     ierr = DMCreateGlobalVector(dmc_coord,&ccoords);CHKERRQ(ierr);
59366668ed41SLisandro Dalcin     ierr = PetscObjectSetName((PetscObject)ccoords,"coordinates");CHKERRQ(ierr);
59376dbf9973SLawrence Mitchell     ierr = DMCreateInjection(dmc_coord,dm_coord,&inject);CHKERRQ(ierr);
59382adcf181SLawrence Mitchell     ierr = MatRestrict(inject,coords,ccoords);CHKERRQ(ierr);
59396dbf9973SLawrence Mitchell     ierr = MatDestroy(&inject);CHKERRQ(ierr);
5940b64e0483SPeter Brune     ierr = DMSetCoordinates(dmc,ccoords);CHKERRQ(ierr);
5941b64e0483SPeter Brune     ierr = VecDestroy(&ccoords);CHKERRQ(ierr);
5942b64e0483SPeter Brune   }
5943b64e0483SPeter Brune   PetscFunctionReturn(0);
5944b64e0483SPeter Brune }
5945b64e0483SPeter Brune 
594603dadc2fSPeter Brune static PetscErrorCode DMSubDomainHook_Coordinates(DM dm,DM subdm,void *ctx)
594703dadc2fSPeter Brune {
594803dadc2fSPeter Brune   DM dm_coord,subdm_coord;
594903dadc2fSPeter Brune   PetscErrorCode ierr;
595003dadc2fSPeter Brune   Vec coords,ccoords,clcoords;
595103dadc2fSPeter Brune   VecScatter *scat_i,*scat_g;
595203dadc2fSPeter Brune   PetscFunctionBegin;
595303dadc2fSPeter Brune   ierr = DMGetCoordinateDM(dm,&dm_coord);CHKERRQ(ierr);
595403dadc2fSPeter Brune   ierr = DMGetCoordinateDM(subdm,&subdm_coord);CHKERRQ(ierr);
595503dadc2fSPeter Brune   ierr = DMGetCoordinates(dm,&coords);CHKERRQ(ierr);
595603dadc2fSPeter Brune   ierr = DMGetCoordinates(subdm,&ccoords);CHKERRQ(ierr);
595703dadc2fSPeter Brune   if (coords && !ccoords) {
595803dadc2fSPeter Brune     ierr = DMCreateGlobalVector(subdm_coord,&ccoords);CHKERRQ(ierr);
59596668ed41SLisandro Dalcin     ierr = PetscObjectSetName((PetscObject)ccoords,"coordinates");CHKERRQ(ierr);
596003dadc2fSPeter Brune     ierr = DMCreateLocalVector(subdm_coord,&clcoords);CHKERRQ(ierr);
596124640c55SToby Isaac     ierr = PetscObjectSetName((PetscObject)clcoords,"coordinates");CHKERRQ(ierr);
596203dadc2fSPeter Brune     ierr = DMCreateDomainDecompositionScatters(dm_coord,1,&subdm_coord,NULL,&scat_i,&scat_g);CHKERRQ(ierr);
596303dadc2fSPeter Brune     ierr = VecScatterBegin(scat_i[0],coords,ccoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
596403dadc2fSPeter Brune     ierr = VecScatterEnd(scat_i[0],coords,ccoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
59651ed9ada7SJunchao Zhang     ierr = VecScatterBegin(scat_g[0],coords,clcoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
596603dadc2fSPeter Brune     ierr = VecScatterEnd(scat_g[0],coords,clcoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
596703dadc2fSPeter Brune     ierr = DMSetCoordinates(subdm,ccoords);CHKERRQ(ierr);
596803dadc2fSPeter Brune     ierr = DMSetCoordinatesLocal(subdm,clcoords);CHKERRQ(ierr);
596903dadc2fSPeter Brune     ierr = VecScatterDestroy(&scat_i[0]);CHKERRQ(ierr);
597003dadc2fSPeter Brune     ierr = VecScatterDestroy(&scat_g[0]);CHKERRQ(ierr);
597103dadc2fSPeter Brune     ierr = VecDestroy(&ccoords);CHKERRQ(ierr);
597203dadc2fSPeter Brune     ierr = VecDestroy(&clcoords);CHKERRQ(ierr);
597303dadc2fSPeter Brune     ierr = PetscFree(scat_i);CHKERRQ(ierr);
597403dadc2fSPeter Brune     ierr = PetscFree(scat_g);CHKERRQ(ierr);
597503dadc2fSPeter Brune   }
597603dadc2fSPeter Brune   PetscFunctionReturn(0);
597703dadc2fSPeter Brune }
597803dadc2fSPeter Brune 
5979c73cfb54SMatthew G. Knepley /*@
5980c73cfb54SMatthew G. Knepley   DMGetDimension - Return the topological dimension of the DM
5981c73cfb54SMatthew G. Knepley 
5982c73cfb54SMatthew G. Knepley   Not collective
5983c73cfb54SMatthew G. Knepley 
5984c73cfb54SMatthew G. Knepley   Input Parameter:
5985c73cfb54SMatthew G. Knepley . dm - The DM
5986c73cfb54SMatthew G. Knepley 
5987c73cfb54SMatthew G. Knepley   Output Parameter:
5988c73cfb54SMatthew G. Knepley . dim - The topological dimension
5989c73cfb54SMatthew G. Knepley 
5990c73cfb54SMatthew G. Knepley   Level: beginner
5991c73cfb54SMatthew G. Knepley 
5992c73cfb54SMatthew G. Knepley .seealso: DMSetDimension(), DMCreate()
5993c73cfb54SMatthew G. Knepley @*/
5994c73cfb54SMatthew G. Knepley PetscErrorCode DMGetDimension(DM dm, PetscInt *dim)
5995c73cfb54SMatthew G. Knepley {
5996c73cfb54SMatthew G. Knepley   PetscFunctionBegin;
5997c73cfb54SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5998534a8f05SLisandro Dalcin   PetscValidIntPointer(dim, 2);
5999c73cfb54SMatthew G. Knepley   *dim = dm->dim;
6000c73cfb54SMatthew G. Knepley   PetscFunctionReturn(0);
6001c73cfb54SMatthew G. Knepley }
6002c73cfb54SMatthew G. Knepley 
6003c73cfb54SMatthew G. Knepley /*@
6004c73cfb54SMatthew G. Knepley   DMSetDimension - Set the topological dimension of the DM
6005c73cfb54SMatthew G. Knepley 
6006c73cfb54SMatthew G. Knepley   Collective on dm
6007c73cfb54SMatthew G. Knepley 
6008c73cfb54SMatthew G. Knepley   Input Parameters:
6009c73cfb54SMatthew G. Knepley + dm - The DM
6010c73cfb54SMatthew G. Knepley - dim - The topological dimension
6011c73cfb54SMatthew G. Knepley 
6012c73cfb54SMatthew G. Knepley   Level: beginner
6013c73cfb54SMatthew G. Knepley 
6014c73cfb54SMatthew G. Knepley .seealso: DMGetDimension(), DMCreate()
6015c73cfb54SMatthew G. Knepley @*/
6016c73cfb54SMatthew G. Knepley PetscErrorCode DMSetDimension(DM dm, PetscInt dim)
6017c73cfb54SMatthew G. Knepley {
6018e5e52638SMatthew G. Knepley   PetscDS        ds;
601945480ffeSMatthew G. Knepley   PetscInt       Nds, n;
6020f17e8794SMatthew G. Knepley   PetscErrorCode ierr;
6021f17e8794SMatthew G. Knepley 
6022c73cfb54SMatthew G. Knepley   PetscFunctionBegin;
6023c73cfb54SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6024c73cfb54SMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, dim, 2);
6025c73cfb54SMatthew G. Knepley   dm->dim = dim;
602645480ffeSMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
602745480ffeSMatthew G. Knepley   for (n = 0; n < Nds; ++n) {
602845480ffeSMatthew G. Knepley     ierr = DMGetRegionNumDS(dm, n, NULL, NULL, &ds);CHKERRQ(ierr);
602945480ffeSMatthew G. Knepley     if (ds->dimEmbed < 0) {ierr = PetscDSSetCoordinateDimension(ds, dim);CHKERRQ(ierr);}
603045480ffeSMatthew G. Knepley   }
6031c73cfb54SMatthew G. Knepley   PetscFunctionReturn(0);
6032c73cfb54SMatthew G. Knepley }
6033c73cfb54SMatthew G. Knepley 
6034793f3fe5SMatthew G. Knepley /*@
6035793f3fe5SMatthew G. Knepley   DMGetDimPoints - Get the half-open interval for all points of a given dimension
6036793f3fe5SMatthew G. Knepley 
6037d083f849SBarry Smith   Collective on dm
6038793f3fe5SMatthew G. Knepley 
6039793f3fe5SMatthew G. Knepley   Input Parameters:
6040793f3fe5SMatthew G. Knepley + dm - the DM
6041793f3fe5SMatthew G. Knepley - dim - the dimension
6042793f3fe5SMatthew G. Knepley 
6043793f3fe5SMatthew G. Knepley   Output Parameters:
6044793f3fe5SMatthew G. Knepley + pStart - The first point of the given dimension
6045aa049354SPatrick Sanan - pEnd - The first point following points of the given dimension
6046793f3fe5SMatthew G. Knepley 
6047793f3fe5SMatthew G. Knepley   Note:
6048793f3fe5SMatthew G. Knepley   The points are vertices in the Hasse diagram encoding the topology. This is explained in
6049a8d69d7bSBarry Smith   https://arxiv.org/abs/0908.4427. If no points exist of this dimension in the storage scheme,
6050793f3fe5SMatthew G. Knepley   then the interval is empty.
6051793f3fe5SMatthew G. Knepley 
6052793f3fe5SMatthew G. Knepley   Level: intermediate
6053793f3fe5SMatthew G. Knepley 
6054793f3fe5SMatthew G. Knepley .seealso: DMPLEX, DMPlexGetDepthStratum(), DMPlexGetHeightStratum()
6055793f3fe5SMatthew G. Knepley @*/
6056793f3fe5SMatthew G. Knepley PetscErrorCode DMGetDimPoints(DM dm, PetscInt dim, PetscInt *pStart, PetscInt *pEnd)
6057793f3fe5SMatthew G. Knepley {
6058793f3fe5SMatthew G. Knepley   PetscInt       d;
6059793f3fe5SMatthew G. Knepley   PetscErrorCode ierr;
6060793f3fe5SMatthew G. Knepley 
6061793f3fe5SMatthew G. Knepley   PetscFunctionBegin;
6062793f3fe5SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6063793f3fe5SMatthew G. Knepley   ierr = DMGetDimension(dm, &d);CHKERRQ(ierr);
6064793f3fe5SMatthew G. Knepley   if ((dim < 0) || (dim > d)) SETERRQ2(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid dimension %d 1", dim, d);
6065b9d85ea2SLisandro Dalcin   if (!dm->ops->getdimpoints) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "DM type %s does not implement DMGetDimPoints",((PetscObject)dm)->type_name);
6066793f3fe5SMatthew G. Knepley   ierr = (*dm->ops->getdimpoints)(dm, dim, pStart, pEnd);CHKERRQ(ierr);
6067793f3fe5SMatthew G. Knepley   PetscFunctionReturn(0);
6068793f3fe5SMatthew G. Knepley }
6069793f3fe5SMatthew G. Knepley 
60706636e97aSMatthew G Knepley /*@
60716636e97aSMatthew G Knepley   DMSetCoordinates - Sets into the DM a global vector that holds the coordinates
60726636e97aSMatthew G Knepley 
6073d083f849SBarry Smith   Collective on dm
60746636e97aSMatthew G Knepley 
60756636e97aSMatthew G Knepley   Input Parameters:
60766636e97aSMatthew G Knepley + dm - the DM
60776636e97aSMatthew G Knepley - c - coordinate vector
60786636e97aSMatthew G Knepley 
60792dd40e9bSPatrick Sanan   Notes:
60802dd40e9bSPatrick Sanan   The coordinates do include those for ghost points, which are in the local vector.
60812dd40e9bSPatrick Sanan 
60822dd40e9bSPatrick Sanan   The vector c should be destroyed by the caller.
60836636e97aSMatthew G Knepley 
60846636e97aSMatthew G Knepley   Level: intermediate
60856636e97aSMatthew G Knepley 
608660c22052SBarry Smith .seealso: DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM(), DMDASetUniformCoordinates()
60876636e97aSMatthew G Knepley @*/
60886636e97aSMatthew G Knepley PetscErrorCode DMSetCoordinates(DM dm, Vec c)
60896636e97aSMatthew G Knepley {
60906636e97aSMatthew G Knepley   PetscErrorCode ierr;
60916636e97aSMatthew G Knepley 
60926636e97aSMatthew G Knepley   PetscFunctionBegin;
60936636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
60946636e97aSMatthew G Knepley   PetscValidHeaderSpecific(c,VEC_CLASSID,2);
60956636e97aSMatthew G Knepley   ierr            = PetscObjectReference((PetscObject) c);CHKERRQ(ierr);
60966636e97aSMatthew G Knepley   ierr            = VecDestroy(&dm->coordinates);CHKERRQ(ierr);
60976636e97aSMatthew G Knepley   dm->coordinates = c;
60986636e97aSMatthew G Knepley   ierr            = VecDestroy(&dm->coordinatesLocal);CHKERRQ(ierr);
6099b64e0483SPeter Brune   ierr            = DMCoarsenHookAdd(dm,DMRestrictHook_Coordinates,NULL,NULL);CHKERRQ(ierr);
610003dadc2fSPeter Brune   ierr            = DMSubDomainHookAdd(dm,DMSubDomainHook_Coordinates,NULL,NULL);CHKERRQ(ierr);
61016636e97aSMatthew G Knepley   PetscFunctionReturn(0);
61026636e97aSMatthew G Knepley }
61036636e97aSMatthew G Knepley 
61046636e97aSMatthew G Knepley /*@
61056636e97aSMatthew G Knepley   DMSetCoordinatesLocal - Sets into the DM a local vector that holds the coordinates
61066636e97aSMatthew G Knepley 
61077058e716SVaclav Hapla   Not collective
61086636e97aSMatthew G Knepley 
61096636e97aSMatthew G Knepley    Input Parameters:
61106636e97aSMatthew G Knepley +  dm - the DM
61116636e97aSMatthew G Knepley -  c - coordinate vector
61126636e97aSMatthew G Knepley 
61132dd40e9bSPatrick Sanan   Notes:
61146636e97aSMatthew G Knepley   The coordinates of ghost points can be set using DMSetCoordinates()
61156636e97aSMatthew G Knepley   followed by DMGetCoordinatesLocal(). This is intended to enable the
61166636e97aSMatthew G Knepley   setting of ghost coordinates outside of the domain.
61176636e97aSMatthew G Knepley 
61182dd40e9bSPatrick Sanan   The vector c should be destroyed by the caller.
61192dd40e9bSPatrick Sanan 
61206636e97aSMatthew G Knepley   Level: intermediate
61216636e97aSMatthew G Knepley 
61226636e97aSMatthew G Knepley .seealso: DMGetCoordinatesLocal(), DMSetCoordinates(), DMGetCoordinates(), DMGetCoordinateDM()
61236636e97aSMatthew G Knepley @*/
61246636e97aSMatthew G Knepley PetscErrorCode DMSetCoordinatesLocal(DM dm, Vec c)
61256636e97aSMatthew G Knepley {
61266636e97aSMatthew G Knepley   PetscErrorCode ierr;
61276636e97aSMatthew G Knepley 
61286636e97aSMatthew G Knepley   PetscFunctionBegin;
61296636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
61306636e97aSMatthew G Knepley   PetscValidHeaderSpecific(c,VEC_CLASSID,2);
61316636e97aSMatthew G Knepley   ierr = PetscObjectReference((PetscObject) c);CHKERRQ(ierr);
61326636e97aSMatthew G Knepley   ierr = VecDestroy(&dm->coordinatesLocal);CHKERRQ(ierr);
61338865f1eaSKarl Rupp 
61346636e97aSMatthew G Knepley   dm->coordinatesLocal = c;
61358865f1eaSKarl Rupp 
61366636e97aSMatthew G Knepley   ierr = VecDestroy(&dm->coordinates);CHKERRQ(ierr);
61376636e97aSMatthew G Knepley   PetscFunctionReturn(0);
61386636e97aSMatthew G Knepley }
61396636e97aSMatthew G Knepley 
61406636e97aSMatthew G Knepley /*@
61416636e97aSMatthew G Knepley   DMGetCoordinates - Gets a global vector with the coordinates associated with the DM.
61426636e97aSMatthew G Knepley 
6143d083f849SBarry Smith   Collective on dm
61446636e97aSMatthew G Knepley 
61456636e97aSMatthew G Knepley   Input Parameter:
61466636e97aSMatthew G Knepley . dm - the DM
61476636e97aSMatthew G Knepley 
61486636e97aSMatthew G Knepley   Output Parameter:
61496636e97aSMatthew G Knepley . c - global coordinate vector
61506636e97aSMatthew G Knepley 
61516636e97aSMatthew G Knepley   Note:
615260c22052SBarry Smith   This is a borrowed reference, so the user should NOT destroy this vector. When the DM is
615360c22052SBarry Smith   destroyed the array will no longer be valid.
61546636e97aSMatthew G Knepley 
6155959c7569SPatrick Sanan   Each process has only the locally-owned portion of the global coordinates (does NOT have the ghost coordinates).
61566636e97aSMatthew G Knepley 
61576636e97aSMatthew G Knepley   For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...)
61586636e97aSMatthew G Knepley   and (x_0,y_0,z_0,x_1,y_1,z_1...)
61596636e97aSMatthew G Knepley 
61606636e97aSMatthew G Knepley   Level: intermediate
61616636e97aSMatthew G Knepley 
616260c22052SBarry Smith .seealso: DMSetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM(), DMDASetUniformCoordinates()
61636636e97aSMatthew G Knepley @*/
61646636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinates(DM dm, Vec *c)
61656636e97aSMatthew G Knepley {
61666636e97aSMatthew G Knepley   PetscErrorCode ierr;
61676636e97aSMatthew G Knepley 
61686636e97aSMatthew G Knepley   PetscFunctionBegin;
61696636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
61706636e97aSMatthew G Knepley   PetscValidPointer(c,2);
61711f588964SMatthew G Knepley   if (!dm->coordinates && dm->coordinatesLocal) {
61720298fd71SBarry Smith     DM        cdm = NULL;
61731970a576SMatthew G. Knepley     PetscBool localized;
61746636e97aSMatthew G Knepley 
61756636e97aSMatthew G Knepley     ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
61766636e97aSMatthew G Knepley     ierr = DMCreateGlobalVector(cdm, &dm->coordinates);CHKERRQ(ierr);
61771970a576SMatthew G. Knepley     ierr = DMGetCoordinatesLocalized(dm, &localized);CHKERRQ(ierr);
61781970a576SMatthew G. Knepley     /* Block size is not correctly set by CreateGlobalVector() if coordinates are localized */
61791970a576SMatthew G. Knepley     if (localized) {
61801970a576SMatthew G. Knepley       PetscInt cdim;
61811970a576SMatthew G. Knepley 
61821970a576SMatthew G. Knepley       ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
61831970a576SMatthew G. Knepley       ierr = VecSetBlockSize(dm->coordinates, cdim);CHKERRQ(ierr);
61841970a576SMatthew G. Knepley     }
61856636e97aSMatthew G Knepley     ierr = PetscObjectSetName((PetscObject) dm->coordinates, "coordinates");CHKERRQ(ierr);
61866636e97aSMatthew G Knepley     ierr = DMLocalToGlobalBegin(cdm, dm->coordinatesLocal, INSERT_VALUES, dm->coordinates);CHKERRQ(ierr);
61876636e97aSMatthew G Knepley     ierr = DMLocalToGlobalEnd(cdm, dm->coordinatesLocal, INSERT_VALUES, dm->coordinates);CHKERRQ(ierr);
61886636e97aSMatthew G Knepley   }
61896636e97aSMatthew G Knepley   *c = dm->coordinates;
61906636e97aSMatthew G Knepley   PetscFunctionReturn(0);
61916636e97aSMatthew G Knepley }
61926636e97aSMatthew G Knepley 
61936636e97aSMatthew G Knepley /*@
619481e9a530SVaclav Hapla   DMGetCoordinatesLocalSetUp - Prepares a local vector of coordinates, so that DMGetCoordinatesLocalNoncollective() can be used as non-collective afterwards.
619581e9a530SVaclav Hapla 
6196d083f849SBarry Smith   Collective on dm
619781e9a530SVaclav Hapla 
619881e9a530SVaclav Hapla   Input Parameter:
619981e9a530SVaclav Hapla . dm - the DM
620081e9a530SVaclav Hapla 
620181e9a530SVaclav Hapla   Level: advanced
620281e9a530SVaclav Hapla 
620381e9a530SVaclav Hapla .seealso: DMGetCoordinatesLocalNoncollective()
620481e9a530SVaclav Hapla @*/
620581e9a530SVaclav Hapla PetscErrorCode DMGetCoordinatesLocalSetUp(DM dm)
620681e9a530SVaclav Hapla {
620781e9a530SVaclav Hapla   PetscErrorCode ierr;
620881e9a530SVaclav Hapla 
620981e9a530SVaclav Hapla   PetscFunctionBegin;
621081e9a530SVaclav Hapla   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
621181e9a530SVaclav Hapla   if (!dm->coordinatesLocal && dm->coordinates) {
62121970a576SMatthew G. Knepley     DM        cdm = NULL;
62131970a576SMatthew G. Knepley     PetscBool localized;
62141970a576SMatthew G. Knepley 
621581e9a530SVaclav Hapla     ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
621681e9a530SVaclav Hapla     ierr = DMCreateLocalVector(cdm, &dm->coordinatesLocal);CHKERRQ(ierr);
62171970a576SMatthew G. Knepley     ierr = DMGetCoordinatesLocalized(dm, &localized);CHKERRQ(ierr);
62181970a576SMatthew G. Knepley     /* Block size is not correctly set by CreateLocalVector() if coordinates are localized */
62191970a576SMatthew G. Knepley     if (localized) {
62201970a576SMatthew G. Knepley       PetscInt cdim;
62211970a576SMatthew G. Knepley 
62221970a576SMatthew G. Knepley       ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
62231970a576SMatthew G. Knepley       ierr = VecSetBlockSize(dm->coordinates, cdim);CHKERRQ(ierr);
62241970a576SMatthew G. Knepley     }
622581e9a530SVaclav Hapla     ierr = PetscObjectSetName((PetscObject) dm->coordinatesLocal, "coordinates");CHKERRQ(ierr);
622681e9a530SVaclav Hapla     ierr = DMGlobalToLocalBegin(cdm, dm->coordinates, INSERT_VALUES, dm->coordinatesLocal);CHKERRQ(ierr);
622781e9a530SVaclav Hapla     ierr = DMGlobalToLocalEnd(cdm, dm->coordinates, INSERT_VALUES, dm->coordinatesLocal);CHKERRQ(ierr);
622881e9a530SVaclav Hapla   }
622981e9a530SVaclav Hapla   PetscFunctionReturn(0);
623081e9a530SVaclav Hapla }
623181e9a530SVaclav Hapla 
623281e9a530SVaclav Hapla /*@
62336636e97aSMatthew G Knepley   DMGetCoordinatesLocal - Gets a local vector with the coordinates associated with the DM.
62346636e97aSMatthew G Knepley 
6235d083f849SBarry Smith   Collective on dm
62366636e97aSMatthew G Knepley 
62376636e97aSMatthew G Knepley   Input Parameter:
62386636e97aSMatthew G Knepley . dm - the DM
62396636e97aSMatthew G Knepley 
62406636e97aSMatthew G Knepley   Output Parameter:
62416636e97aSMatthew G Knepley . c - coordinate vector
62426636e97aSMatthew G Knepley 
62436636e97aSMatthew G Knepley   Note:
62446636e97aSMatthew G Knepley   This is a borrowed reference, so the user should NOT destroy this vector
62456636e97aSMatthew G Knepley 
62466636e97aSMatthew G Knepley   Each process has the local and ghost coordinates
62476636e97aSMatthew G Knepley 
62486636e97aSMatthew G Knepley   For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...)
62496636e97aSMatthew G Knepley   and (x_0,y_0,z_0,x_1,y_1,z_1...)
62506636e97aSMatthew G Knepley 
62516636e97aSMatthew G Knepley   Level: intermediate
62526636e97aSMatthew G Knepley 
625381e9a530SVaclav Hapla .seealso: DMSetCoordinatesLocal(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM(), DMGetCoordinatesLocalNoncollective()
62546636e97aSMatthew G Knepley @*/
62556636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinatesLocal(DM dm, Vec *c)
62566636e97aSMatthew G Knepley {
62576636e97aSMatthew G Knepley   PetscErrorCode ierr;
62586636e97aSMatthew G Knepley 
62596636e97aSMatthew G Knepley   PetscFunctionBegin;
62606636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
62616636e97aSMatthew G Knepley   PetscValidPointer(c,2);
626281e9a530SVaclav Hapla   ierr = DMGetCoordinatesLocalSetUp(dm);CHKERRQ(ierr);
62636636e97aSMatthew G Knepley   *c = dm->coordinatesLocal;
62646636e97aSMatthew G Knepley   PetscFunctionReturn(0);
62656636e97aSMatthew G Knepley }
62666636e97aSMatthew G Knepley 
626781e9a530SVaclav Hapla /*@
626881e9a530SVaclav Hapla   DMGetCoordinatesLocalNoncollective - Non-collective version of DMGetCoordinatesLocal(). Fails if global coordinates have been set and DMGetCoordinatesLocalSetUp() not called.
626981e9a530SVaclav Hapla 
627081e9a530SVaclav Hapla   Not collective
627181e9a530SVaclav Hapla 
627281e9a530SVaclav Hapla   Input Parameter:
627381e9a530SVaclav Hapla . dm - the DM
627481e9a530SVaclav Hapla 
627581e9a530SVaclav Hapla   Output Parameter:
627681e9a530SVaclav Hapla . c - coordinate vector
627781e9a530SVaclav Hapla 
627881e9a530SVaclav Hapla   Level: advanced
627981e9a530SVaclav Hapla 
628081e9a530SVaclav Hapla .seealso: DMGetCoordinatesLocalSetUp(), DMGetCoordinatesLocal(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM()
628181e9a530SVaclav Hapla @*/
628281e9a530SVaclav Hapla PetscErrorCode DMGetCoordinatesLocalNoncollective(DM dm, Vec *c)
628381e9a530SVaclav Hapla {
628481e9a530SVaclav Hapla   PetscFunctionBegin;
628581e9a530SVaclav Hapla   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
628681e9a530SVaclav Hapla   PetscValidPointer(c,2);
628781e9a530SVaclav Hapla   if (!dm->coordinatesLocal && dm->coordinates) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DMGetCoordinatesLocalSetUp() has not been called");
62886636e97aSMatthew G Knepley   *c = dm->coordinatesLocal;
62896636e97aSMatthew G Knepley   PetscFunctionReturn(0);
62906636e97aSMatthew G Knepley }
62916636e97aSMatthew G Knepley 
62922db98f8dSVaclav Hapla /*@
62932db98f8dSVaclav Hapla   DMGetCoordinatesLocalTuple - Gets a local vector with the coordinates of specified points and section describing its layout.
62942db98f8dSVaclav Hapla 
62952db98f8dSVaclav Hapla   Not collective
62962db98f8dSVaclav Hapla 
6297d8d19677SJose E. Roman   Input Parameters:
62982db98f8dSVaclav Hapla + dm - the DM
62992db98f8dSVaclav Hapla - p - the IS of points whose coordinates will be returned
63002db98f8dSVaclav Hapla 
6301d8d19677SJose E. Roman   Output Parameters:
63022db98f8dSVaclav Hapla + pCoordSection - the PetscSection describing the layout of pCoord, i.e. each point corresponds to one point in p, and DOFs correspond to coordinates
63032db98f8dSVaclav Hapla - pCoord - the Vec with coordinates of points in p
63042db98f8dSVaclav Hapla 
63052db98f8dSVaclav Hapla   Note:
63062db98f8dSVaclav Hapla   DMGetCoordinatesLocalSetUp() must be called first. This function employs DMGetCoordinatesLocalNoncollective() so it is not collective.
63072db98f8dSVaclav Hapla 
63082db98f8dSVaclav Hapla   This creates a new vector, so the user SHOULD destroy this vector
63092db98f8dSVaclav Hapla 
63102db98f8dSVaclav Hapla   Each process has the local and ghost coordinates
63112db98f8dSVaclav Hapla 
63122db98f8dSVaclav Hapla   For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...)
63132db98f8dSVaclav Hapla   and (x_0,y_0,z_0,x_1,y_1,z_1...)
63142db98f8dSVaclav Hapla 
63152db98f8dSVaclav Hapla   Level: advanced
63162db98f8dSVaclav Hapla 
63172db98f8dSVaclav Hapla .seealso: DMSetCoordinatesLocal(), DMGetCoordinatesLocal(), DMGetCoordinatesLocalNoncollective(), DMGetCoordinatesLocalSetUp(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM()
63182db98f8dSVaclav Hapla @*/
63192db98f8dSVaclav Hapla PetscErrorCode DMGetCoordinatesLocalTuple(DM dm, IS p, PetscSection *pCoordSection, Vec *pCoord)
63202db98f8dSVaclav Hapla {
63212db98f8dSVaclav Hapla   PetscSection        cs, newcs;
63222db98f8dSVaclav Hapla   Vec                 coords;
63232db98f8dSVaclav Hapla   const PetscScalar   *arr;
63242db98f8dSVaclav Hapla   PetscScalar         *newarr=NULL;
63252db98f8dSVaclav Hapla   PetscInt            n;
63262db98f8dSVaclav Hapla   PetscErrorCode      ierr;
63272db98f8dSVaclav Hapla 
63282db98f8dSVaclav Hapla   PetscFunctionBegin;
63292db98f8dSVaclav Hapla   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
63302db98f8dSVaclav Hapla   PetscValidHeaderSpecific(p, IS_CLASSID, 2);
63312db98f8dSVaclav Hapla   if (pCoordSection) PetscValidPointer(pCoordSection, 3);
63322db98f8dSVaclav Hapla   if (pCoord) PetscValidPointer(pCoord, 4);
63332db98f8dSVaclav Hapla   if (!dm->coordinatesLocal) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DMGetCoordinatesLocalSetUp() has not been called or coordinates not set");
63341bb6d2a8SBarry Smith   if (!dm->coordinateDM || !dm->coordinateDM->localSection) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DM not supported");
63351bb6d2a8SBarry Smith   cs = dm->coordinateDM->localSection;
63362db98f8dSVaclav Hapla   coords = dm->coordinatesLocal;
63372db98f8dSVaclav Hapla   ierr = VecGetArrayRead(coords, &arr);CHKERRQ(ierr);
63382db98f8dSVaclav Hapla   ierr = PetscSectionExtractDofsFromArray(cs, MPIU_SCALAR, arr, p, &newcs, pCoord ? ((void**)&newarr) : NULL);CHKERRQ(ierr);
63392db98f8dSVaclav Hapla   ierr = VecRestoreArrayRead(coords, &arr);CHKERRQ(ierr);
63402db98f8dSVaclav Hapla   if (pCoord) {
63412db98f8dSVaclav Hapla     ierr = PetscSectionGetStorageSize(newcs, &n);CHKERRQ(ierr);
63422db98f8dSVaclav Hapla     /* set array in two steps to mimic PETSC_OWN_POINTER */
63432db98f8dSVaclav Hapla     ierr = VecCreateSeqWithArray(PetscObjectComm((PetscObject)p), 1, n, NULL, pCoord);CHKERRQ(ierr);
63442db98f8dSVaclav Hapla     ierr = VecReplaceArray(*pCoord, newarr);CHKERRQ(ierr);
6345ad9ac99dSVaclav Hapla   } else {
6346ad9ac99dSVaclav Hapla     ierr = PetscFree(newarr);CHKERRQ(ierr);
63472db98f8dSVaclav Hapla   }
6348ad9ac99dSVaclav Hapla   if (pCoordSection) {*pCoordSection = newcs;}
6349ad9ac99dSVaclav Hapla   else               {ierr = PetscSectionDestroy(&newcs);CHKERRQ(ierr);}
63502db98f8dSVaclav Hapla   PetscFunctionReturn(0);
63512db98f8dSVaclav Hapla }
63522db98f8dSVaclav Hapla 
6353f19dbd58SToby Isaac PetscErrorCode DMGetCoordinateField(DM dm, DMField *field)
6354f19dbd58SToby Isaac {
6355f19dbd58SToby Isaac   PetscErrorCode ierr;
6356f19dbd58SToby Isaac 
6357f19dbd58SToby Isaac   PetscFunctionBegin;
6358f19dbd58SToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6359f19dbd58SToby Isaac   PetscValidPointer(field,2);
6360f19dbd58SToby Isaac   if (!dm->coordinateField) {
6361f19dbd58SToby Isaac     if (dm->ops->createcoordinatefield) {
6362f19dbd58SToby Isaac       ierr = (*dm->ops->createcoordinatefield)(dm,&dm->coordinateField);CHKERRQ(ierr);
6363f19dbd58SToby Isaac     }
6364f19dbd58SToby Isaac   }
6365f19dbd58SToby Isaac   *field = dm->coordinateField;
6366f19dbd58SToby Isaac   PetscFunctionReturn(0);
6367f19dbd58SToby Isaac }
6368f19dbd58SToby Isaac 
6369f19dbd58SToby Isaac PetscErrorCode DMSetCoordinateField(DM dm, DMField field)
6370f19dbd58SToby Isaac {
6371f19dbd58SToby Isaac   PetscErrorCode ierr;
6372f19dbd58SToby Isaac 
6373f19dbd58SToby Isaac   PetscFunctionBegin;
6374f19dbd58SToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6375f19dbd58SToby Isaac   if (field) PetscValidHeaderSpecific(field,DMFIELD_CLASSID,2);
6376c4e6da2cSBarry Smith   ierr = PetscObjectReference((PetscObject)field);CHKERRQ(ierr);
6377f19dbd58SToby Isaac   ierr = DMFieldDestroy(&dm->coordinateField);CHKERRQ(ierr);
6378f19dbd58SToby Isaac   dm->coordinateField = field;
6379f19dbd58SToby Isaac   PetscFunctionReturn(0);
6380f19dbd58SToby Isaac }
6381f19dbd58SToby Isaac 
63826636e97aSMatthew G Knepley /*@
63831cfe2091SMatthew G. Knepley   DMGetCoordinateDM - Gets the DM that prescribes coordinate layout and scatters between global and local coordinates
63846636e97aSMatthew G Knepley 
6385d083f849SBarry Smith   Collective on dm
63866636e97aSMatthew G Knepley 
63876636e97aSMatthew G Knepley   Input Parameter:
63886636e97aSMatthew G Knepley . dm - the DM
63896636e97aSMatthew G Knepley 
63906636e97aSMatthew G Knepley   Output Parameter:
63916636e97aSMatthew G Knepley . cdm - coordinate DM
63926636e97aSMatthew G Knepley 
63936636e97aSMatthew G Knepley   Level: intermediate
63946636e97aSMatthew G Knepley 
63951cfe2091SMatthew G. Knepley .seealso: DMSetCoordinateDM(), DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal()
63966636e97aSMatthew G Knepley @*/
63976636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinateDM(DM dm, DM *cdm)
63986636e97aSMatthew G Knepley {
63996636e97aSMatthew G Knepley   PetscErrorCode ierr;
64006636e97aSMatthew G Knepley 
64016636e97aSMatthew G Knepley   PetscFunctionBegin;
64026636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
64036636e97aSMatthew G Knepley   PetscValidPointer(cdm,2);
64046636e97aSMatthew G Knepley   if (!dm->coordinateDM) {
6405308f8a94SToby Isaac     DM cdm;
6406308f8a94SToby Isaac 
640782f516ccSBarry Smith     if (!dm->ops->createcoordinatedm) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Unable to create coordinates for this DM");
6408308f8a94SToby Isaac     ierr = (*dm->ops->createcoordinatedm)(dm, &cdm);CHKERRQ(ierr);
6409308f8a94SToby Isaac     /* Just in case the DM sets the coordinate DM when creating it (DMP4est can do this, because it may not setup
6410308f8a94SToby Isaac      * until the call to CreateCoordinateDM) */
6411308f8a94SToby Isaac     ierr = DMDestroy(&dm->coordinateDM);CHKERRQ(ierr);
6412308f8a94SToby Isaac     dm->coordinateDM = cdm;
64136636e97aSMatthew G Knepley   }
64146636e97aSMatthew G Knepley   *cdm = dm->coordinateDM;
64156636e97aSMatthew G Knepley   PetscFunctionReturn(0);
64166636e97aSMatthew G Knepley }
6417e87bb0d3SMatthew G Knepley 
64181cfe2091SMatthew G. Knepley /*@
64191cfe2091SMatthew G. Knepley   DMSetCoordinateDM - Sets the DM that prescribes coordinate layout and scatters between global and local coordinates
64201cfe2091SMatthew G. Knepley 
6421d083f849SBarry Smith   Logically Collective on dm
64221cfe2091SMatthew G. Knepley 
64231cfe2091SMatthew G. Knepley   Input Parameters:
64241cfe2091SMatthew G. Knepley + dm - the DM
64251cfe2091SMatthew G. Knepley - cdm - coordinate DM
64261cfe2091SMatthew G. Knepley 
64271cfe2091SMatthew G. Knepley   Level: intermediate
64281cfe2091SMatthew G. Knepley 
64291cfe2091SMatthew G. Knepley .seealso: DMGetCoordinateDM(), DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal()
64301cfe2091SMatthew G. Knepley @*/
64311cfe2091SMatthew G. Knepley PetscErrorCode DMSetCoordinateDM(DM dm, DM cdm)
64321cfe2091SMatthew G. Knepley {
64331cfe2091SMatthew G. Knepley   PetscErrorCode ierr;
64341cfe2091SMatthew G. Knepley 
64351cfe2091SMatthew G. Knepley   PetscFunctionBegin;
64361cfe2091SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
64371cfe2091SMatthew G. Knepley   PetscValidHeaderSpecific(cdm,DM_CLASSID,2);
6438f26b38b9SToby Isaac   ierr = PetscObjectReference((PetscObject)cdm);CHKERRQ(ierr);
64391cfe2091SMatthew G. Knepley   ierr = DMDestroy(&dm->coordinateDM);CHKERRQ(ierr);
64401cfe2091SMatthew G. Knepley   dm->coordinateDM = cdm;
64411cfe2091SMatthew G. Knepley   PetscFunctionReturn(0);
64421cfe2091SMatthew G. Knepley }
64431cfe2091SMatthew G. Knepley 
644446e270d4SMatthew G. Knepley /*@
644546e270d4SMatthew G. Knepley   DMGetCoordinateDim - Retrieve the dimension of embedding space for coordinate values.
644646e270d4SMatthew G. Knepley 
644746e270d4SMatthew G. Knepley   Not Collective
644846e270d4SMatthew G. Knepley 
644946e270d4SMatthew G. Knepley   Input Parameter:
645046e270d4SMatthew G. Knepley . dm - The DM object
645146e270d4SMatthew G. Knepley 
645246e270d4SMatthew G. Knepley   Output Parameter:
645346e270d4SMatthew G. Knepley . dim - The embedding dimension
645446e270d4SMatthew G. Knepley 
645546e270d4SMatthew G. Knepley   Level: intermediate
645646e270d4SMatthew G. Knepley 
645792fd8e1eSJed Brown .seealso: DMSetCoordinateDim(), DMGetCoordinateSection(), DMGetCoordinateDM(), DMGetLocalSection(), DMSetLocalSection()
645846e270d4SMatthew G. Knepley @*/
645946e270d4SMatthew G. Knepley PetscErrorCode DMGetCoordinateDim(DM dm, PetscInt *dim)
646046e270d4SMatthew G. Knepley {
646146e270d4SMatthew G. Knepley   PetscFunctionBegin;
646246e270d4SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6463534a8f05SLisandro Dalcin   PetscValidIntPointer(dim, 2);
64649a9a41abSToby Isaac   if (dm->dimEmbed == PETSC_DEFAULT) {
64659a9a41abSToby Isaac     dm->dimEmbed = dm->dim;
64669a9a41abSToby Isaac   }
646746e270d4SMatthew G. Knepley   *dim = dm->dimEmbed;
646846e270d4SMatthew G. Knepley   PetscFunctionReturn(0);
646946e270d4SMatthew G. Knepley }
647046e270d4SMatthew G. Knepley 
647146e270d4SMatthew G. Knepley /*@
647246e270d4SMatthew G. Knepley   DMSetCoordinateDim - Set the dimension of the embedding space for coordinate values.
647346e270d4SMatthew G. Knepley 
647446e270d4SMatthew G. Knepley   Not Collective
647546e270d4SMatthew G. Knepley 
647646e270d4SMatthew G. Knepley   Input Parameters:
647746e270d4SMatthew G. Knepley + dm  - The DM object
647846e270d4SMatthew G. Knepley - dim - The embedding dimension
647946e270d4SMatthew G. Knepley 
648046e270d4SMatthew G. Knepley   Level: intermediate
648146e270d4SMatthew G. Knepley 
648292fd8e1eSJed Brown .seealso: DMGetCoordinateDim(), DMSetCoordinateSection(), DMGetCoordinateSection(), DMGetLocalSection(), DMSetLocalSection()
648346e270d4SMatthew G. Knepley @*/
648446e270d4SMatthew G. Knepley PetscErrorCode DMSetCoordinateDim(DM dm, PetscInt dim)
648546e270d4SMatthew G. Knepley {
6486e5e52638SMatthew G. Knepley   PetscDS        ds;
648745480ffeSMatthew G. Knepley   PetscInt       Nds, n;
6488f17e8794SMatthew G. Knepley   PetscErrorCode ierr;
6489f17e8794SMatthew G. Knepley 
649046e270d4SMatthew G. Knepley   PetscFunctionBegin;
649146e270d4SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
649246e270d4SMatthew G. Knepley   dm->dimEmbed = dim;
649345480ffeSMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
649445480ffeSMatthew G. Knepley   for (n = 0; n < Nds; ++n) {
649545480ffeSMatthew G. Knepley     ierr = DMGetRegionNumDS(dm, n, NULL, NULL, &ds);CHKERRQ(ierr);
6496e5e52638SMatthew G. Knepley     ierr = PetscDSSetCoordinateDimension(ds, dim);CHKERRQ(ierr);
649745480ffeSMatthew G. Knepley   }
649846e270d4SMatthew G. Knepley   PetscFunctionReturn(0);
649946e270d4SMatthew G. Knepley }
650046e270d4SMatthew G. Knepley 
6501e8abe2deSMatthew G. Knepley /*@
6502e8abe2deSMatthew G. Knepley   DMGetCoordinateSection - Retrieve the layout of coordinate values over the mesh.
6503e8abe2deSMatthew G. Knepley 
6504d083f849SBarry Smith   Collective on dm
6505e8abe2deSMatthew G. Knepley 
6506e8abe2deSMatthew G. Knepley   Input Parameter:
6507e8abe2deSMatthew G. Knepley . dm - The DM object
6508e8abe2deSMatthew G. Knepley 
6509e8abe2deSMatthew G. Knepley   Output Parameter:
6510e8abe2deSMatthew G. Knepley . section - The PetscSection object
6511e8abe2deSMatthew G. Knepley 
6512e8abe2deSMatthew G. Knepley   Level: intermediate
6513e8abe2deSMatthew G. Knepley 
651492fd8e1eSJed Brown .seealso: DMGetCoordinateDM(), DMGetLocalSection(), DMSetLocalSection()
6515e8abe2deSMatthew G. Knepley @*/
6516e8abe2deSMatthew G. Knepley PetscErrorCode DMGetCoordinateSection(DM dm, PetscSection *section)
6517e8abe2deSMatthew G. Knepley {
6518e8abe2deSMatthew G. Knepley   DM             cdm;
6519e8abe2deSMatthew G. Knepley   PetscErrorCode ierr;
6520e8abe2deSMatthew G. Knepley 
6521e8abe2deSMatthew G. Knepley   PetscFunctionBegin;
6522e8abe2deSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6523e8abe2deSMatthew G. Knepley   PetscValidPointer(section, 2);
6524e8abe2deSMatthew G. Knepley   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
652592fd8e1eSJed Brown   ierr = DMGetLocalSection(cdm, section);CHKERRQ(ierr);
6526e8abe2deSMatthew G. Knepley   PetscFunctionReturn(0);
6527e8abe2deSMatthew G. Knepley }
6528e8abe2deSMatthew G. Knepley 
6529e8abe2deSMatthew G. Knepley /*@
6530e8abe2deSMatthew G. Knepley   DMSetCoordinateSection - Set the layout of coordinate values over the mesh.
6531e8abe2deSMatthew G. Knepley 
6532e8abe2deSMatthew G. Knepley   Not Collective
6533e8abe2deSMatthew G. Knepley 
6534e8abe2deSMatthew G. Knepley   Input Parameters:
6535e8abe2deSMatthew G. Knepley + dm      - The DM object
653646e270d4SMatthew G. Knepley . dim     - The embedding dimension, or PETSC_DETERMINE
6537e8abe2deSMatthew G. Knepley - section - The PetscSection object
6538e8abe2deSMatthew G. Knepley 
6539e8abe2deSMatthew G. Knepley   Level: intermediate
6540e8abe2deSMatthew G. Knepley 
654192fd8e1eSJed Brown .seealso: DMGetCoordinateSection(), DMGetLocalSection(), DMSetLocalSection()
6542e8abe2deSMatthew G. Knepley @*/
654346e270d4SMatthew G. Knepley PetscErrorCode DMSetCoordinateSection(DM dm, PetscInt dim, PetscSection section)
6544e8abe2deSMatthew G. Knepley {
6545e8abe2deSMatthew G. Knepley   DM             cdm;
6546e8abe2deSMatthew G. Knepley   PetscErrorCode ierr;
6547e8abe2deSMatthew G. Knepley 
6548e8abe2deSMatthew G. Knepley   PetscFunctionBegin;
6549e8abe2deSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
655046e270d4SMatthew G. Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,3);
6551e8abe2deSMatthew G. Knepley   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
655292fd8e1eSJed Brown   ierr = DMSetLocalSection(cdm, section);CHKERRQ(ierr);
655346e270d4SMatthew G. Knepley   if (dim == PETSC_DETERMINE) {
65544c1069a6SMatthew G. Knepley     PetscInt d = PETSC_DEFAULT;
655546e270d4SMatthew G. Knepley     PetscInt pStart, pEnd, vStart, vEnd, v, dd;
655646e270d4SMatthew G. Knepley 
655746e270d4SMatthew G. Knepley     ierr = PetscSectionGetChart(section, &pStart, &pEnd);CHKERRQ(ierr);
655846e270d4SMatthew G. Knepley     ierr = DMGetDimPoints(dm, 0, &vStart, &vEnd);CHKERRQ(ierr);
655946e270d4SMatthew G. Knepley     pStart = PetscMax(vStart, pStart);
656046e270d4SMatthew G. Knepley     pEnd   = PetscMin(vEnd, pEnd);
656146e270d4SMatthew G. Knepley     for (v = pStart; v < pEnd; ++v) {
656246e270d4SMatthew G. Knepley       ierr = PetscSectionGetDof(section, v, &dd);CHKERRQ(ierr);
656346e270d4SMatthew G. Knepley       if (dd) {d = dd; break;}
656446e270d4SMatthew G. Knepley     }
6565ebfe4b0dSMatthew G. Knepley     if (d >= 0) {ierr = DMSetCoordinateDim(dm, d);CHKERRQ(ierr);}
656646e270d4SMatthew G. Knepley   }
6567e8abe2deSMatthew G. Knepley   PetscFunctionReturn(0);
6568e8abe2deSMatthew G. Knepley }
6569e8abe2deSMatthew G. Knepley 
6570d864a3eaSLisandro Dalcin /*@
6571d864a3eaSLisandro Dalcin   DMProjectCoordinates - Project coordinates to a different space
6572d864a3eaSLisandro Dalcin 
6573d864a3eaSLisandro Dalcin   Input Parameters:
6574d864a3eaSLisandro Dalcin + dm      - The DM object
6575d864a3eaSLisandro Dalcin - disc    - The new coordinate discretization
6576d864a3eaSLisandro Dalcin 
6577d864a3eaSLisandro Dalcin   Level: intermediate
6578d864a3eaSLisandro Dalcin 
6579d864a3eaSLisandro Dalcin .seealso: DMGetCoordinateField()
6580d864a3eaSLisandro Dalcin @*/
6581d864a3eaSLisandro Dalcin PetscErrorCode DMProjectCoordinates(DM dm, PetscFE disc)
6582d864a3eaSLisandro Dalcin {
6583d864a3eaSLisandro Dalcin   PetscObject    discOld;
6584d864a3eaSLisandro Dalcin   PetscClassId   classid;
6585d864a3eaSLisandro Dalcin   DM             cdmOld,cdmNew;
6586d864a3eaSLisandro Dalcin   Vec            coordsOld,coordsNew;
6587d864a3eaSLisandro Dalcin   Mat            matInterp;
6588d864a3eaSLisandro Dalcin   PetscErrorCode ierr;
6589d864a3eaSLisandro Dalcin 
6590d864a3eaSLisandro Dalcin   PetscFunctionBegin;
6591d864a3eaSLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6592d864a3eaSLisandro Dalcin   PetscValidHeaderSpecific(disc,PETSCFE_CLASSID,2);
6593d864a3eaSLisandro Dalcin 
6594d864a3eaSLisandro Dalcin   ierr = DMGetCoordinateDM(dm, &cdmOld);CHKERRQ(ierr);
6595d864a3eaSLisandro Dalcin   /* Check current discretization is compatible */
6596d864a3eaSLisandro Dalcin   ierr = DMGetField(cdmOld, 0, NULL, &discOld);CHKERRQ(ierr);
6597d864a3eaSLisandro Dalcin   ierr = PetscObjectGetClassId(discOld, &classid);CHKERRQ(ierr);
659829ad44c5SMatthew G. Knepley   if (classid != PETSCFE_CLASSID) {
659929ad44c5SMatthew G. Knepley     if (classid == PETSC_CONTAINER_CLASSID) {
660029ad44c5SMatthew G. Knepley       PetscFE        feLinear;
660129ad44c5SMatthew G. Knepley       DMPolytopeType ct;
660229ad44c5SMatthew G. Knepley       PetscInt       dim, dE, cStart;
660329ad44c5SMatthew G. Knepley       PetscBool      simplex;
660429ad44c5SMatthew G. Knepley 
660529ad44c5SMatthew G. Knepley       /* Assume linear vertex coordinates */
660629ad44c5SMatthew G. Knepley       ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr);
660729ad44c5SMatthew G. Knepley       ierr = DMGetCoordinateDim(dm, &dE);CHKERRQ(ierr);
660829ad44c5SMatthew G. Knepley       ierr = DMPlexGetHeightStratum(cdmOld, 0, &cStart, NULL);CHKERRQ(ierr);
660929ad44c5SMatthew G. Knepley       ierr = DMPlexGetCellType(dm, cStart, &ct);CHKERRQ(ierr);
661029ad44c5SMatthew G. Knepley       switch (ct) {
661129ad44c5SMatthew G. Knepley         case DM_POLYTOPE_TRI_PRISM:
661229ad44c5SMatthew G. Knepley         case DM_POLYTOPE_TRI_PRISM_TENSOR:
661329ad44c5SMatthew G. Knepley           SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SUP, "Cannot autoamtically create coordinate space for prisms");
661429ad44c5SMatthew G. Knepley         default: break;
661529ad44c5SMatthew G. Knepley       }
661629ad44c5SMatthew G. Knepley       simplex = DMPolytopeTypeGetNumVertices(ct) == DMPolytopeTypeGetDim(ct)+1 ? PETSC_TRUE : PETSC_FALSE;
661729ad44c5SMatthew G. Knepley       ierr = PetscFECreateLagrange(PETSC_COMM_SELF, dim, dE, simplex, 1, -1, &feLinear);CHKERRQ(ierr);
661829ad44c5SMatthew G. Knepley       ierr = DMSetField(cdmOld, 0, NULL, (PetscObject) feLinear);CHKERRQ(ierr);
661929ad44c5SMatthew G. Knepley       ierr = PetscFEDestroy(&feLinear);CHKERRQ(ierr);
662029ad44c5SMatthew G. Knepley       ierr = DMCreateDS(cdmOld);CHKERRQ(ierr);
662129ad44c5SMatthew G. Knepley     } else {
662229ad44c5SMatthew G. Knepley       const char *discname;
662329ad44c5SMatthew G. Knepley 
662429ad44c5SMatthew G. Knepley       ierr = PetscObjectGetType(discOld, &discname);CHKERRQ(ierr);
662529ad44c5SMatthew G. Knepley       SETERRQ1(PetscObjectComm(discOld), PETSC_ERR_SUP, "Discretization type %s not supported", discname);
662629ad44c5SMatthew G. Knepley     }
662729ad44c5SMatthew G. Knepley   }
6628d864a3eaSLisandro Dalcin   /* Make a fresh clone of the coordinate DM */
6629d864a3eaSLisandro Dalcin   ierr = DMClone(cdmOld, &cdmNew);CHKERRQ(ierr);
6630d864a3eaSLisandro Dalcin   ierr = DMSetField(cdmNew, 0, NULL, (PetscObject) disc);CHKERRQ(ierr);
6631d864a3eaSLisandro Dalcin   ierr = DMCreateDS(cdmNew);CHKERRQ(ierr);
6632d864a3eaSLisandro Dalcin   /* Project the coordinate vector from old to new space  */
6633d864a3eaSLisandro Dalcin   ierr = DMGetCoordinates(dm, &coordsOld);CHKERRQ(ierr);
6634d864a3eaSLisandro Dalcin   ierr = DMCreateGlobalVector(cdmNew, &coordsNew);CHKERRQ(ierr);
6635d864a3eaSLisandro Dalcin   ierr = DMCreateInterpolation(cdmOld, cdmNew, &matInterp, NULL);CHKERRQ(ierr);
6636d864a3eaSLisandro Dalcin   ierr = MatInterpolate(matInterp, coordsOld, coordsNew);CHKERRQ(ierr);
6637d864a3eaSLisandro Dalcin   ierr = MatDestroy(&matInterp);CHKERRQ(ierr);
6638d864a3eaSLisandro Dalcin   /* Set new coordinate structures */
6639d864a3eaSLisandro Dalcin   ierr = DMSetCoordinateField(dm, NULL);CHKERRQ(ierr);
6640d864a3eaSLisandro Dalcin   ierr = DMSetCoordinateDM(dm, cdmNew);CHKERRQ(ierr);
6641d864a3eaSLisandro Dalcin   ierr = DMSetCoordinates(dm, coordsNew);CHKERRQ(ierr);
6642d864a3eaSLisandro Dalcin   ierr = VecDestroy(&coordsNew);CHKERRQ(ierr);
6643d864a3eaSLisandro Dalcin   ierr = DMDestroy(&cdmNew);CHKERRQ(ierr);
6644d864a3eaSLisandro Dalcin   PetscFunctionReturn(0);
6645d864a3eaSLisandro Dalcin }
6646d864a3eaSLisandro Dalcin 
66475dc8c3f7SMatthew G. Knepley /*@C
664890b157c4SStefano Zampini   DMGetPeriodicity - Get the description of mesh periodicity
66495dc8c3f7SMatthew G. Knepley 
6650f899ff85SJose E. Roman   Input Parameter:
665190b157c4SStefano Zampini . dm      - The DM object
665290b157c4SStefano Zampini 
665390b157c4SStefano Zampini   Output Parameters:
665490b157c4SStefano Zampini + per     - Whether the DM is periodic or not
66555dc8c3f7SMatthew 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
66565dc8c3f7SMatthew G. Knepley . L       - If we assume the mesh is a torus, this is the length of each coordinate
66575dc8c3f7SMatthew G. Knepley - bd      - This describes the type of periodicity in each topological dimension
66585dc8c3f7SMatthew G. Knepley 
66595dc8c3f7SMatthew G. Knepley   Level: developer
66605dc8c3f7SMatthew G. Knepley 
66615dc8c3f7SMatthew G. Knepley .seealso: DMGetPeriodicity()
66625dc8c3f7SMatthew G. Knepley @*/
666390b157c4SStefano Zampini PetscErrorCode DMGetPeriodicity(DM dm, PetscBool *per, const PetscReal **maxCell, const PetscReal **L, const DMBoundaryType **bd)
6664c6b900c6SMatthew G. Knepley {
6665c6b900c6SMatthew G. Knepley   PetscFunctionBegin;
6666c6b900c6SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
666790b157c4SStefano Zampini   if (per)     *per     = dm->periodic;
6668c6b900c6SMatthew G. Knepley   if (L)       *L       = dm->L;
6669c6b900c6SMatthew G. Knepley   if (maxCell) *maxCell = dm->maxCell;
66705dc8c3f7SMatthew G. Knepley   if (bd)      *bd      = dm->bdtype;
6671c6b900c6SMatthew G. Knepley   PetscFunctionReturn(0);
6672c6b900c6SMatthew G. Knepley }
6673c6b900c6SMatthew G. Knepley 
66745dc8c3f7SMatthew G. Knepley /*@C
66755dc8c3f7SMatthew G. Knepley   DMSetPeriodicity - Set the description of mesh periodicity
66765dc8c3f7SMatthew G. Knepley 
66775dc8c3f7SMatthew G. Knepley   Input Parameters:
66785dc8c3f7SMatthew G. Knepley + dm      - The DM object
6679db2bf62eSStefano Zampini . per     - Whether the DM is periodic or not.
6680db2bf62eSStefano 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.
66815dc8c3f7SMatthew G. Knepley . L       - If we assume the mesh is a torus, this is the length of each coordinate
66825dc8c3f7SMatthew G. Knepley - bd      - This describes the type of periodicity in each topological dimension
66835dc8c3f7SMatthew G. Knepley 
6684db2bf62eSStefano 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.
6685db2bf62eSStefano Zampini 
66865dc8c3f7SMatthew G. Knepley   Level: developer
66875dc8c3f7SMatthew G. Knepley 
66885dc8c3f7SMatthew G. Knepley .seealso: DMGetPeriodicity()
66895dc8c3f7SMatthew G. Knepley @*/
669090b157c4SStefano Zampini PetscErrorCode DMSetPeriodicity(DM dm, PetscBool per, const PetscReal maxCell[], const PetscReal L[], const DMBoundaryType bd[])
6691c6b900c6SMatthew G. Knepley {
6692c6b900c6SMatthew G. Knepley   PetscInt       dim, d;
6693c6b900c6SMatthew G. Knepley   PetscErrorCode ierr;
6694c6b900c6SMatthew G. Knepley 
6695c6b900c6SMatthew G. Knepley   PetscFunctionBegin;
6696c6b900c6SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
669790b157c4SStefano Zampini   PetscValidLogicalCollectiveBool(dm,per,2);
6698412e9a14SMatthew G. Knepley   if (maxCell) {PetscValidRealPointer(maxCell,3);}
6699412e9a14SMatthew G. Knepley   if (L)       {PetscValidRealPointer(L,4);}
6700412e9a14SMatthew G. Knepley   if (bd)      {PetscValidPointer(bd,5);}
67015dc8c3f7SMatthew G. Knepley   ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr);
670290b157c4SStefano Zampini   if (maxCell) {
6703412e9a14SMatthew G. Knepley     if (!dm->maxCell) {ierr = PetscMalloc1(dim, &dm->maxCell);CHKERRQ(ierr);}
6704412e9a14SMatthew G. Knepley     for (d = 0; d < dim; ++d) dm->maxCell[d] = maxCell[d];
6705db2bf62eSStefano Zampini   } else { /* remove maxCell information to disable automatic computation of localized vertices */
6706db2bf62eSStefano Zampini     ierr = PetscFree(dm->maxCell);CHKERRQ(ierr);
6707412e9a14SMatthew G. Knepley   }
6708db2bf62eSStefano Zampini 
6709412e9a14SMatthew G. Knepley   if (L) {
6710412e9a14SMatthew G. Knepley     if (!dm->L) {ierr = PetscMalloc1(dim, &dm->L);CHKERRQ(ierr);}
6711412e9a14SMatthew G. Knepley     for (d = 0; d < dim; ++d) dm->L[d] = L[d];
6712412e9a14SMatthew G. Knepley   }
6713412e9a14SMatthew G. Knepley   if (bd) {
6714412e9a14SMatthew G. Knepley     if (!dm->bdtype) {ierr = PetscMalloc1(dim, &dm->bdtype);CHKERRQ(ierr);}
6715412e9a14SMatthew G. Knepley     for (d = 0; d < dim; ++d) dm->bdtype[d] = bd[d];
671690b157c4SStefano Zampini   }
6717072d7d67SStefano Zampini   dm->periodic = per;
6718c6b900c6SMatthew G. Knepley   PetscFunctionReturn(0);
6719c6b900c6SMatthew G. Knepley }
6720c6b900c6SMatthew G. Knepley 
67212e17dfb7SMatthew G. Knepley /*@
67222e17dfb7SMatthew 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.
67232e17dfb7SMatthew G. Knepley 
67242e17dfb7SMatthew G. Knepley   Input Parameters:
67252e17dfb7SMatthew G. Knepley + dm     - The DM
672665da65dcSMatthew G. Knepley . in     - The input coordinate point (dim numbers)
672765da65dcSMatthew G. Knepley - endpoint - Include the endpoint L_i
67282e17dfb7SMatthew G. Knepley 
67292e17dfb7SMatthew G. Knepley   Output Parameter:
67302e17dfb7SMatthew G. Knepley . out - The localized coordinate point
67312e17dfb7SMatthew G. Knepley 
67322e17dfb7SMatthew G. Knepley   Level: developer
67332e17dfb7SMatthew G. Knepley 
67342e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeAddCoordinate()
67352e17dfb7SMatthew G. Knepley @*/
673665da65dcSMatthew G. Knepley PetscErrorCode DMLocalizeCoordinate(DM dm, const PetscScalar in[], PetscBool endpoint, PetscScalar out[])
67372e17dfb7SMatthew G. Knepley {
67382e17dfb7SMatthew G. Knepley   PetscInt       dim, d;
67392e17dfb7SMatthew G. Knepley   PetscErrorCode ierr;
67402e17dfb7SMatthew G. Knepley 
67412e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
67422e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &dim);CHKERRQ(ierr);
67432e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
67442e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] = in[d];
67452e17dfb7SMatthew G. Knepley   } else {
674665da65dcSMatthew G. Knepley     if (endpoint) {
674765da65dcSMatthew G. Knepley       for (d = 0; d < dim; ++d) {
6748da3333bfSMatthew 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)) {
6749da3333bfSMatthew G. Knepley           out[d] = in[d] - dm->L[d]*(PetscFloorReal(PetscRealPart(in[d])/dm->L[d]) - 1);
675065da65dcSMatthew G. Knepley         } else {
6751da3333bfSMatthew G. Knepley           out[d] = in[d] - dm->L[d]*PetscFloorReal(PetscRealPart(in[d])/dm->L[d]);
675265da65dcSMatthew G. Knepley         }
675365da65dcSMatthew G. Knepley       }
675465da65dcSMatthew G. Knepley     } else {
67552e17dfb7SMatthew G. Knepley       for (d = 0; d < dim; ++d) {
67561118d4bcSLisandro Dalcin         out[d] = in[d] - dm->L[d]*PetscFloorReal(PetscRealPart(in[d])/dm->L[d]);
67572e17dfb7SMatthew G. Knepley       }
67582e17dfb7SMatthew G. Knepley     }
675965da65dcSMatthew G. Knepley   }
67602e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
67612e17dfb7SMatthew G. Knepley }
67622e17dfb7SMatthew G. Knepley 
67632e17dfb7SMatthew G. Knepley /*
67642e17dfb7SMatthew 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.
67652e17dfb7SMatthew G. Knepley 
67662e17dfb7SMatthew G. Knepley   Input Parameters:
67672e17dfb7SMatthew G. Knepley + dm     - The DM
67682e17dfb7SMatthew G. Knepley . dim    - The spatial dimension
67692e17dfb7SMatthew G. Knepley . anchor - The anchor point, the input point can be no more than maxCell away from it
67702e17dfb7SMatthew G. Knepley - in     - The input coordinate point (dim numbers)
67712e17dfb7SMatthew G. Knepley 
67722e17dfb7SMatthew G. Knepley   Output Parameter:
67732e17dfb7SMatthew G. Knepley . out - The localized coordinate point
67742e17dfb7SMatthew G. Knepley 
67752e17dfb7SMatthew G. Knepley   Level: developer
67762e17dfb7SMatthew G. Knepley 
67772e17dfb7SMatthew 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
67782e17dfb7SMatthew G. Knepley 
67792e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeAddCoordinate()
67802e17dfb7SMatthew G. Knepley */
67812e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinate_Internal(DM dm, PetscInt dim, const PetscScalar anchor[], const PetscScalar in[], PetscScalar out[])
67822e17dfb7SMatthew G. Knepley {
67832e17dfb7SMatthew G. Knepley   PetscInt d;
67842e17dfb7SMatthew G. Knepley 
67852e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
67862e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
67872e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] = in[d];
67882e17dfb7SMatthew G. Knepley   } else {
67892e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) {
6790908eca10SMatthew G. Knepley       if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsScalar(anchor[d] - in[d]) > dm->maxCell[d])) {
67912e17dfb7SMatthew G. Knepley         out[d] = PetscRealPart(anchor[d]) > PetscRealPart(in[d]) ? dm->L[d] + in[d] : in[d] - dm->L[d];
67922e17dfb7SMatthew G. Knepley       } else {
67932e17dfb7SMatthew G. Knepley         out[d] = in[d];
67942e17dfb7SMatthew G. Knepley       }
67952e17dfb7SMatthew G. Knepley     }
67962e17dfb7SMatthew G. Knepley   }
67972e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
67982e17dfb7SMatthew G. Knepley }
6799a5801f52SStefano Zampini 
68002e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinateReal_Internal(DM dm, PetscInt dim, const PetscReal anchor[], const PetscReal in[], PetscReal out[])
68012e17dfb7SMatthew G. Knepley {
68022e17dfb7SMatthew G. Knepley   PetscInt d;
68032e17dfb7SMatthew G. Knepley 
68042e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
68052e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
68062e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] = in[d];
68072e17dfb7SMatthew G. Knepley   } else {
68082e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) {
6809908eca10SMatthew G. Knepley       if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsReal(anchor[d] - in[d]) > dm->maxCell[d])) {
68102e17dfb7SMatthew G. Knepley         out[d] = anchor[d] > in[d] ? dm->L[d] + in[d] : in[d] - dm->L[d];
68112e17dfb7SMatthew G. Knepley       } else {
68122e17dfb7SMatthew G. Knepley         out[d] = in[d];
68132e17dfb7SMatthew G. Knepley       }
68142e17dfb7SMatthew G. Knepley     }
68152e17dfb7SMatthew G. Knepley   }
68162e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
68172e17dfb7SMatthew G. Knepley }
68182e17dfb7SMatthew G. Knepley 
68192e17dfb7SMatthew G. Knepley /*
68202e17dfb7SMatthew 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.
68212e17dfb7SMatthew G. Knepley 
68222e17dfb7SMatthew G. Knepley   Input Parameters:
68232e17dfb7SMatthew G. Knepley + dm     - The DM
68242e17dfb7SMatthew G. Knepley . dim    - The spatial dimension
68252e17dfb7SMatthew G. Knepley . anchor - The anchor point, the input point can be no more than maxCell away from it
68262e17dfb7SMatthew G. Knepley . in     - The input coordinate delta (dim numbers)
68272e17dfb7SMatthew G. Knepley - out    - The input coordinate point (dim numbers)
68282e17dfb7SMatthew G. Knepley 
68292e17dfb7SMatthew G. Knepley   Output Parameter:
68302e17dfb7SMatthew G. Knepley . out    - The localized coordinate in + out
68312e17dfb7SMatthew G. Knepley 
68322e17dfb7SMatthew G. Knepley   Level: developer
68332e17dfb7SMatthew G. Knepley 
68342e17dfb7SMatthew 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
68352e17dfb7SMatthew G. Knepley 
68362e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeCoordinate()
68372e17dfb7SMatthew G. Knepley */
68382e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeAddCoordinate_Internal(DM dm, PetscInt dim, const PetscScalar anchor[], const PetscScalar in[], PetscScalar out[])
68392e17dfb7SMatthew G. Knepley {
68402e17dfb7SMatthew G. Knepley   PetscInt d;
68412e17dfb7SMatthew G. Knepley 
68422e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
68432e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
68442e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] += in[d];
68452e17dfb7SMatthew G. Knepley   } else {
68462e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) {
6847412e9a14SMatthew G. Knepley       const PetscReal maxC = dm->maxCell[d];
6848412e9a14SMatthew G. Knepley 
6849412e9a14SMatthew G. Knepley       if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsScalar(anchor[d] - in[d]) > maxC)) {
6850412e9a14SMatthew G. Knepley         const PetscScalar newCoord = PetscRealPart(anchor[d]) > PetscRealPart(in[d]) ? dm->L[d] + in[d] : in[d] - dm->L[d];
6851412e9a14SMatthew G. Knepley 
6852412e9a14SMatthew G. Knepley         if (PetscAbsScalar(newCoord - anchor[d]) > maxC)
6853412e9a14SMatthew 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]));
6854412e9a14SMatthew G. Knepley         out[d] += newCoord;
68552e17dfb7SMatthew G. Knepley       } else {
68562e17dfb7SMatthew G. Knepley         out[d] += in[d];
68572e17dfb7SMatthew G. Knepley       }
68582e17dfb7SMatthew G. Knepley     }
68592e17dfb7SMatthew G. Knepley   }
68602e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
68612e17dfb7SMatthew G. Knepley }
68622e17dfb7SMatthew G. Knepley 
686336447a5eSToby Isaac /*@
68648f700142SStefano Zampini   DMGetCoordinatesLocalizedLocal - Check if the DM coordinates have been localized for cells on this process
68658f700142SStefano Zampini 
68668f700142SStefano Zampini   Not collective
686736447a5eSToby Isaac 
686836447a5eSToby Isaac   Input Parameter:
686936447a5eSToby Isaac . dm - The DM
687036447a5eSToby Isaac 
687136447a5eSToby Isaac   Output Parameter:
687236447a5eSToby Isaac   areLocalized - True if localized
687336447a5eSToby Isaac 
687436447a5eSToby Isaac   Level: developer
687536447a5eSToby Isaac 
68768f700142SStefano Zampini .seealso: DMLocalizeCoordinates(), DMGetCoordinatesLocalized(), DMSetPeriodicity()
687736447a5eSToby Isaac @*/
68788f700142SStefano Zampini PetscErrorCode DMGetCoordinatesLocalizedLocal(DM dm,PetscBool *areLocalized)
687936447a5eSToby Isaac {
688036447a5eSToby Isaac   DM             cdm;
688136447a5eSToby Isaac   PetscSection   coordSection;
68822ccac677SMatthew G. Knepley   PetscInt       depth, cStart, cEnd, sStart, sEnd, c, dof;
688346a3a80fSLisandro Dalcin   PetscBool      isPlex, alreadyLocalized;
688436447a5eSToby Isaac   PetscErrorCode ierr;
688536447a5eSToby Isaac 
688636447a5eSToby Isaac   PetscFunctionBegin;
688736447a5eSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6888534a8f05SLisandro Dalcin   PetscValidBoolPointer(areLocalized, 2);
68898b09590cSToby Isaac   *areLocalized = PETSC_FALSE;
689046a3a80fSLisandro Dalcin 
689136447a5eSToby Isaac   /* We need some generic way of refering to cells/vertices */
689236447a5eSToby Isaac   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
689346a3a80fSLisandro Dalcin   ierr = PetscObjectTypeCompare((PetscObject) cdm, DMPLEX, &isPlex);CHKERRQ(ierr);
68949f7230bfSMatthew G. Knepley   if (!isPlex) PetscFunctionReturn(0);
68952ccac677SMatthew G. Knepley   ierr = DMPlexGetDepth(cdm, &depth);CHKERRQ(ierr);
68962ccac677SMatthew G. Knepley   if (!depth) PetscFunctionReturn(0);
689746a3a80fSLisandro Dalcin 
68989f7230bfSMatthew G. Knepley   ierr = DMGetCoordinateSection(dm, &coordSection);CHKERRQ(ierr);
689946a3a80fSLisandro Dalcin   ierr = DMPlexGetHeightStratum(cdm, 0, &cStart, &cEnd);CHKERRQ(ierr);
690036447a5eSToby Isaac   ierr = PetscSectionGetChart(coordSection, &sStart, &sEnd);CHKERRQ(ierr);
690136447a5eSToby Isaac   alreadyLocalized = PETSC_FALSE;
690246a3a80fSLisandro Dalcin   for (c = cStart; c < cEnd; ++c) {
690346a3a80fSLisandro Dalcin     if (c < sStart || c >= sEnd) continue;
690436447a5eSToby Isaac     ierr = PetscSectionGetDof(coordSection, c, &dof);CHKERRQ(ierr);
690546a3a80fSLisandro Dalcin     if (dof) { alreadyLocalized = PETSC_TRUE; break; }
690636447a5eSToby Isaac   }
69078f700142SStefano Zampini   *areLocalized = alreadyLocalized;
690836447a5eSToby Isaac   PetscFunctionReturn(0);
690936447a5eSToby Isaac }
691036447a5eSToby Isaac 
69118f700142SStefano Zampini /*@
69128f700142SStefano Zampini   DMGetCoordinatesLocalized - Check if the DM coordinates have been localized for cells
69138f700142SStefano Zampini 
69148f700142SStefano Zampini   Collective on dm
69158f700142SStefano Zampini 
69168f700142SStefano Zampini   Input Parameter:
69178f700142SStefano Zampini . dm - The DM
69188f700142SStefano Zampini 
69198f700142SStefano Zampini   Output Parameter:
69208f700142SStefano Zampini   areLocalized - True if localized
69218f700142SStefano Zampini 
69228f700142SStefano Zampini   Level: developer
69238f700142SStefano Zampini 
69248f700142SStefano Zampini .seealso: DMLocalizeCoordinates(), DMSetPeriodicity(), DMGetCoordinatesLocalizedLocal()
69258f700142SStefano Zampini @*/
69268f700142SStefano Zampini PetscErrorCode DMGetCoordinatesLocalized(DM dm,PetscBool *areLocalized)
69278f700142SStefano Zampini {
69288f700142SStefano Zampini   PetscBool      localized;
69298f700142SStefano Zampini   PetscErrorCode ierr;
69308f700142SStefano Zampini 
69318f700142SStefano Zampini   PetscFunctionBegin;
69328f700142SStefano Zampini   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6933534a8f05SLisandro Dalcin   PetscValidBoolPointer(areLocalized, 2);
69348f700142SStefano Zampini   ierr = DMGetCoordinatesLocalizedLocal(dm,&localized);CHKERRQ(ierr);
6935820f2d46SBarry Smith   ierr = MPIU_Allreduce(&localized,areLocalized,1,MPIU_BOOL,MPI_LOR,PetscObjectComm((PetscObject)dm));CHKERRMPI(ierr);
69368f700142SStefano Zampini   PetscFunctionReturn(0);
69378f700142SStefano Zampini }
693836447a5eSToby Isaac 
69392e17dfb7SMatthew G. Knepley /*@
6940492b8470SStefano Zampini   DMLocalizeCoordinates - If a mesh is periodic, create local coordinates for cells having periodic faces
69412e17dfb7SMatthew G. Knepley 
69428f700142SStefano Zampini   Collective on dm
69438f700142SStefano Zampini 
69442e17dfb7SMatthew G. Knepley   Input Parameter:
69452e17dfb7SMatthew G. Knepley . dm - The DM
69462e17dfb7SMatthew G. Knepley 
69472e17dfb7SMatthew G. Knepley   Level: developer
69482e17dfb7SMatthew G. Knepley 
69498f700142SStefano Zampini .seealso: DMSetPeriodicity(), DMLocalizeCoordinate(), DMLocalizeAddCoordinate()
69502e17dfb7SMatthew G. Knepley @*/
69512e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinates(DM dm)
69522e17dfb7SMatthew G. Knepley {
69532e17dfb7SMatthew G. Knepley   DM             cdm;
69542e17dfb7SMatthew G. Knepley   PetscSection   coordSection, cSection;
69552e17dfb7SMatthew G. Knepley   Vec            coordinates,  cVec;
69563e922f36SToby Isaac   PetscScalar   *coords, *coords2, *anchor, *localized;
69573e922f36SToby Isaac   PetscInt       Nc, vStart, vEnd, v, sStart, sEnd, newStart = PETSC_MAX_INT, newEnd = PETSC_MIN_INT, dof, d, off, off2, bs, coordSize;
6958e0ae35bbSToby Isaac   PetscBool      alreadyLocalized, alreadyLocalizedGlobal;
69593e922f36SToby Isaac   PetscInt       maxHeight = 0, h;
69603e922f36SToby Isaac   PetscInt       *pStart = NULL, *pEnd = NULL;
69612e17dfb7SMatthew G. Knepley   PetscErrorCode ierr;
69622e17dfb7SMatthew G. Knepley 
69632e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
69642e17dfb7SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
696592c9c85fSStefano Zampini   if (!dm->periodic) PetscFunctionReturn(0);
6966f7cbd40bSStefano Zampini   ierr = DMGetCoordinatesLocalized(dm, &alreadyLocalized);CHKERRQ(ierr);
6967f7cbd40bSStefano Zampini   if (alreadyLocalized) PetscFunctionReturn(0);
6968f7cbd40bSStefano Zampini 
69692e17dfb7SMatthew G. Knepley   /* We need some generic way of refering to cells/vertices */
69702e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
69712e17dfb7SMatthew G. Knepley   {
69722e17dfb7SMatthew G. Knepley     PetscBool isplex;
69732e17dfb7SMatthew G. Knepley 
69742e17dfb7SMatthew G. Knepley     ierr = PetscObjectTypeCompare((PetscObject) cdm, DMPLEX, &isplex);CHKERRQ(ierr);
69752e17dfb7SMatthew G. Knepley     if (isplex) {
69762e17dfb7SMatthew G. Knepley       ierr = DMPlexGetDepthStratum(cdm, 0, &vStart, &vEnd);CHKERRQ(ierr);
69773e922f36SToby Isaac       ierr = DMPlexGetMaxProjectionHeight(cdm,&maxHeight);CHKERRQ(ierr);
697869291d52SBarry Smith       ierr = DMGetWorkArray(dm,2*(maxHeight + 1),MPIU_INT,&pStart);CHKERRQ(ierr);
69793e922f36SToby Isaac       pEnd = &pStart[maxHeight + 1];
69803e922f36SToby Isaac       newStart = vStart;
69813e922f36SToby Isaac       newEnd   = vEnd;
69823e922f36SToby Isaac       for (h = 0; h <= maxHeight; h++) {
69833e922f36SToby Isaac         ierr = DMPlexGetHeightStratum(cdm, h, &pStart[h], &pEnd[h]);CHKERRQ(ierr);
69843e922f36SToby Isaac         newStart = PetscMin(newStart,pStart[h]);
69853e922f36SToby Isaac         newEnd   = PetscMax(newEnd,pEnd[h]);
69863e922f36SToby Isaac       }
69872e17dfb7SMatthew G. Knepley     } else SETERRQ(PetscObjectComm((PetscObject) cdm), PETSC_ERR_ARG_WRONG, "Coordinate localization requires a DMPLEX coordinate DM");
69882e17dfb7SMatthew G. Knepley   }
69892e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinatesLocal(dm, &coordinates);CHKERRQ(ierr);
699043eeeb2dSStefano Zampini   if (!coordinates) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"Missing local coordinates vector");
69912e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinateSection(dm, &coordSection);CHKERRQ(ierr);
69923e922f36SToby Isaac   ierr = VecGetBlockSize(coordinates, &bs);CHKERRQ(ierr);
6993e0ae35bbSToby Isaac   ierr = PetscSectionGetChart(coordSection,&sStart,&sEnd);CHKERRQ(ierr);
69943e922f36SToby Isaac 
69952e17dfb7SMatthew G. Knepley   ierr = PetscSectionCreate(PetscObjectComm((PetscObject) dm), &cSection);CHKERRQ(ierr);
69962e17dfb7SMatthew G. Knepley   ierr = PetscSectionSetNumFields(cSection, 1);CHKERRQ(ierr);
69972e17dfb7SMatthew G. Knepley   ierr = PetscSectionGetFieldComponents(coordSection, 0, &Nc);CHKERRQ(ierr);
69982e17dfb7SMatthew G. Knepley   ierr = PetscSectionSetFieldComponents(cSection, 0, Nc);CHKERRQ(ierr);
69993e922f36SToby Isaac   ierr = PetscSectionSetChart(cSection, newStart, newEnd);CHKERRQ(ierr);
70003e922f36SToby Isaac 
700169291d52SBarry Smith   ierr = DMGetWorkArray(dm, 2 * bs, MPIU_SCALAR, &anchor);CHKERRQ(ierr);
70023e922f36SToby Isaac   localized = &anchor[bs];
70033e922f36SToby Isaac   alreadyLocalized = alreadyLocalizedGlobal = PETSC_TRUE;
70043e922f36SToby Isaac   for (h = 0; h <= maxHeight; h++) {
70053e922f36SToby Isaac     PetscInt cStart = pStart[h], cEnd = pEnd[h], c;
70063e922f36SToby Isaac 
70073e922f36SToby Isaac     for (c = cStart; c < cEnd; ++c) {
70083e922f36SToby Isaac       PetscScalar *cellCoords = NULL;
70093e922f36SToby Isaac       PetscInt     b;
70103e922f36SToby Isaac 
70113e922f36SToby Isaac       if (c < sStart || c >= sEnd) alreadyLocalized = PETSC_FALSE;
70123e922f36SToby Isaac       ierr = DMPlexVecGetClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
70133e922f36SToby Isaac       for (b = 0; b < bs; ++b) anchor[b] = cellCoords[b];
70143e922f36SToby Isaac       for (d = 0; d < dof/bs; ++d) {
70153e922f36SToby Isaac         ierr = DMLocalizeCoordinate_Internal(dm, bs, anchor, &cellCoords[d*bs], localized);CHKERRQ(ierr);
70163e922f36SToby Isaac         for (b = 0; b < bs; b++) {
70173e922f36SToby Isaac           if (cellCoords[d*bs + b] != localized[b]) break;
70183e922f36SToby Isaac         }
70193e922f36SToby Isaac         if (b < bs) break;
70203e922f36SToby Isaac       }
70213e922f36SToby Isaac       if (d < dof/bs) {
70223e922f36SToby Isaac         if (c >= sStart && c < sEnd) {
70233e922f36SToby Isaac           PetscInt cdof;
70243e922f36SToby Isaac 
70253e922f36SToby Isaac           ierr = PetscSectionGetDof(coordSection, c, &cdof);CHKERRQ(ierr);
70263e922f36SToby Isaac           if (cdof != dof) alreadyLocalized = PETSC_FALSE;
70273e922f36SToby Isaac         }
70283e922f36SToby Isaac         ierr = PetscSectionSetDof(cSection, c, dof);CHKERRQ(ierr);
70293e922f36SToby Isaac         ierr = PetscSectionSetFieldDof(cSection, c, 0, dof);CHKERRQ(ierr);
70303e922f36SToby Isaac       }
70313e922f36SToby Isaac       ierr = DMPlexVecRestoreClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
70323e922f36SToby Isaac     }
70333e922f36SToby Isaac   }
7034ffc4695bSBarry Smith   ierr = MPI_Allreduce(&alreadyLocalized,&alreadyLocalizedGlobal,1,MPIU_BOOL,MPI_LAND,PetscObjectComm((PetscObject)dm));CHKERRMPI(ierr);
70353e922f36SToby Isaac   if (alreadyLocalizedGlobal) {
703669291d52SBarry Smith     ierr = DMRestoreWorkArray(dm, 2 * bs, MPIU_SCALAR, &anchor);CHKERRQ(ierr);
70373e922f36SToby Isaac     ierr = PetscSectionDestroy(&cSection);CHKERRQ(ierr);
703869291d52SBarry Smith     ierr = DMRestoreWorkArray(dm,2*(maxHeight + 1),MPIU_INT,&pStart);CHKERRQ(ierr);
70393e922f36SToby Isaac     PetscFunctionReturn(0);
70403e922f36SToby Isaac   }
70412e17dfb7SMatthew G. Knepley   for (v = vStart; v < vEnd; ++v) {
70422e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetDof(coordSection, v, &dof);CHKERRQ(ierr);
70432e17dfb7SMatthew G. Knepley     ierr = PetscSectionSetDof(cSection, v, dof);CHKERRQ(ierr);
70442e17dfb7SMatthew G. Knepley     ierr = PetscSectionSetFieldDof(cSection, v, 0, dof);CHKERRQ(ierr);
70452e17dfb7SMatthew G. Knepley   }
70462e17dfb7SMatthew G. Knepley   ierr = PetscSectionSetUp(cSection);CHKERRQ(ierr);
70472e17dfb7SMatthew G. Knepley   ierr = PetscSectionGetStorageSize(cSection, &coordSize);CHKERRQ(ierr);
7048c2be7e5eSLisandro Dalcin   ierr = VecCreate(PETSC_COMM_SELF, &cVec);CHKERRQ(ierr);
70492e17dfb7SMatthew G. Knepley   ierr = PetscObjectSetName((PetscObject)cVec,"coordinates");CHKERRQ(ierr);
70502e17dfb7SMatthew G. Knepley   ierr = VecSetBlockSize(cVec, bs);CHKERRQ(ierr);
70512e17dfb7SMatthew G. Knepley   ierr = VecSetSizes(cVec, coordSize, PETSC_DETERMINE);CHKERRQ(ierr);
70522e17dfb7SMatthew G. Knepley   ierr = VecSetType(cVec, VECSTANDARD);CHKERRQ(ierr);
7053c2be7e5eSLisandro Dalcin   ierr = VecGetArrayRead(coordinates, (const PetscScalar**)&coords);CHKERRQ(ierr);
70542e17dfb7SMatthew G. Knepley   ierr = VecGetArray(cVec, &coords2);CHKERRQ(ierr);
70552e17dfb7SMatthew G. Knepley   for (v = vStart; v < vEnd; ++v) {
70562e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetDof(coordSection, v, &dof);CHKERRQ(ierr);
70572e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetOffset(coordSection, v, &off);CHKERRQ(ierr);
70582e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetOffset(cSection,     v, &off2);CHKERRQ(ierr);
70592e17dfb7SMatthew G. Knepley     for (d = 0; d < dof; ++d) coords2[off2+d] = coords[off+d];
70602e17dfb7SMatthew G. Knepley   }
70613e922f36SToby Isaac   for (h = 0; h <= maxHeight; h++) {
70623e922f36SToby Isaac     PetscInt cStart = pStart[h], cEnd = pEnd[h], c;
70633e922f36SToby Isaac 
70642e17dfb7SMatthew G. Knepley     for (c = cStart; c < cEnd; ++c) {
70652e17dfb7SMatthew G. Knepley       PetscScalar *cellCoords = NULL;
70663e922f36SToby Isaac       PetscInt     b, cdof;
70672e17dfb7SMatthew G. Knepley 
70683e922f36SToby Isaac       ierr = PetscSectionGetDof(cSection,c,&cdof);CHKERRQ(ierr);
70693e922f36SToby Isaac       if (!cdof) continue;
70702e17dfb7SMatthew G. Knepley       ierr = DMPlexVecGetClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
70712e17dfb7SMatthew G. Knepley       ierr = PetscSectionGetOffset(cSection, c, &off2);CHKERRQ(ierr);
70722e17dfb7SMatthew G. Knepley       for (b = 0; b < bs; ++b) anchor[b] = cellCoords[b];
70732e17dfb7SMatthew G. Knepley       for (d = 0; d < dof/bs; ++d) {ierr = DMLocalizeCoordinate_Internal(dm, bs, anchor, &cellCoords[d*bs], &coords2[off2+d*bs]);CHKERRQ(ierr);}
70742e17dfb7SMatthew G. Knepley       ierr = DMPlexVecRestoreClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
70752e17dfb7SMatthew G. Knepley     }
70763e922f36SToby Isaac   }
707769291d52SBarry Smith   ierr = DMRestoreWorkArray(dm, 2 * bs, MPIU_SCALAR, &anchor);CHKERRQ(ierr);
707869291d52SBarry Smith   ierr = DMRestoreWorkArray(dm,2*(maxHeight + 1),MPIU_INT,&pStart);CHKERRQ(ierr);
7079c2be7e5eSLisandro Dalcin   ierr = VecRestoreArrayRead(coordinates, (const PetscScalar**)&coords);CHKERRQ(ierr);
70802e17dfb7SMatthew G. Knepley   ierr = VecRestoreArray(cVec, &coords2);CHKERRQ(ierr);
70812e17dfb7SMatthew G. Knepley   ierr = DMSetCoordinateSection(dm, PETSC_DETERMINE, cSection);CHKERRQ(ierr);
70822e17dfb7SMatthew G. Knepley   ierr = DMSetCoordinatesLocal(dm, cVec);CHKERRQ(ierr);
70832e17dfb7SMatthew G. Knepley   ierr = VecDestroy(&cVec);CHKERRQ(ierr);
70842e17dfb7SMatthew G. Knepley   ierr = PetscSectionDestroy(&cSection);CHKERRQ(ierr);
70852e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
70862e17dfb7SMatthew G. Knepley }
70872e17dfb7SMatthew G. Knepley 
7088e87bb0d3SMatthew G Knepley /*@
70893a93e3b7SToby Isaac   DMLocatePoints - Locate the points in v in the mesh and return a PetscSF of the containing cells
7090e87bb0d3SMatthew G Knepley 
7091d083f849SBarry Smith   Collective on v (see explanation below)
7092e87bb0d3SMatthew G Knepley 
7093e87bb0d3SMatthew G Knepley   Input Parameters:
7094e87bb0d3SMatthew G Knepley + dm - The DM
70956b867d5aSJose E. Roman - ltype - The type of point location, e.g. DM_POINTLOCATION_NONE or DM_POINTLOCATION_NEAREST
7096e87bb0d3SMatthew G Knepley 
70976b867d5aSJose E. Roman   Input/Output Parameters:
70986b867d5aSJose E. Roman + v - The Vec of points, on output contains the nearest mesh points to the given points if DM_POINTLOCATION_NEAREST is used
70996b867d5aSJose E. Roman - cellSF - Points to either NULL, or a PetscSF with guesses for which cells contain each point;
71006b867d5aSJose E. Roman            on output, the PetscSF containing the ranks and local indices of the containing points
71013a93e3b7SToby Isaac 
7102e87bb0d3SMatthew G Knepley   Level: developer
710361e3bb9bSMatthew G Knepley 
710462a38674SMatthew G. Knepley   Notes:
71053a93e3b7SToby Isaac   To do a search of the local cells of the mesh, v should have PETSC_COMM_SELF as its communicator.
710662a38674SMatthew G. Knepley   To do a search of all the cells in the distributed mesh, v should have the same communicator as dm.
71073a93e3b7SToby Isaac 
71083a93e3b7SToby Isaac   If *cellSF is NULL on input, a PetscSF will be created.
710962a38674SMatthew G. Knepley   If *cellSF is not NULL on input, it should point to an existing PetscSF, whose graph will be used as initial guesses.
71103a93e3b7SToby Isaac 
71113a93e3b7SToby Isaac   An array that maps each point to its containing cell can be obtained with
71123a93e3b7SToby Isaac 
711362a38674SMatthew G. Knepley $    const PetscSFNode *cells;
711462a38674SMatthew G. Knepley $    PetscInt           nFound;
7115a6216909SToby Isaac $    const PetscInt    *found;
711662a38674SMatthew G. Knepley $
7117a6216909SToby Isaac $    PetscSFGetGraph(cellSF,NULL,&nFound,&found,&cells);
71183a93e3b7SToby Isaac 
71193a93e3b7SToby 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
71203a93e3b7SToby Isaac   the index of the cell in its rank's local numbering.
71213a93e3b7SToby Isaac 
712262a38674SMatthew G. Knepley .seealso: DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal(), DMPointLocationType
712361e3bb9bSMatthew G Knepley @*/
712462a38674SMatthew G. Knepley PetscErrorCode DMLocatePoints(DM dm, Vec v, DMPointLocationType ltype, PetscSF *cellSF)
7125e87bb0d3SMatthew G Knepley {
7126735aa83eSMatthew G Knepley   PetscErrorCode ierr;
7127735aa83eSMatthew G Knepley 
7128e87bb0d3SMatthew G Knepley   PetscFunctionBegin;
7129e87bb0d3SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
7130e87bb0d3SMatthew G Knepley   PetscValidHeaderSpecific(v,VEC_CLASSID,2);
7131e0fc9d1bSMatthew G. Knepley   PetscValidPointer(cellSF,4);
71323a93e3b7SToby Isaac   if (*cellSF) {
71333a93e3b7SToby Isaac     PetscMPIInt result;
71343a93e3b7SToby Isaac 
7135e0fc9d1bSMatthew G. Knepley     PetscValidHeaderSpecific(*cellSF,PETSCSF_CLASSID,4);
7136ffc4695bSBarry Smith     ierr = MPI_Comm_compare(PetscObjectComm((PetscObject)v),PetscObjectComm((PetscObject)*cellSF),&result);CHKERRMPI(ierr);
71373a93e3b7SToby 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");
7138e0fc9d1bSMatthew G. Knepley   } else {
71393a93e3b7SToby Isaac     ierr = PetscSFCreate(PetscObjectComm((PetscObject)v),cellSF);CHKERRQ(ierr);
71403a93e3b7SToby Isaac   }
7141b9d85ea2SLisandro Dalcin   if (!dm->ops->locatepoints) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Point location not available for this DM");
714247a35634SPatrick Farrell   ierr = PetscLogEventBegin(DM_LocatePoints,dm,0,0,0);CHKERRQ(ierr);
714362a38674SMatthew G. Knepley   ierr = (*dm->ops->locatepoints)(dm,v,ltype,*cellSF);CHKERRQ(ierr);
714447a35634SPatrick Farrell   ierr = PetscLogEventEnd(DM_LocatePoints,dm,0,0,0);CHKERRQ(ierr);
7145e87bb0d3SMatthew G Knepley   PetscFunctionReturn(0);
7146e87bb0d3SMatthew G Knepley }
714714f150ffSMatthew G. Knepley 
7148f4d763aaSMatthew G. Knepley /*@
7149f4d763aaSMatthew G. Knepley   DMGetOutputDM - Retrieve the DM associated with the layout for output
7150f4d763aaSMatthew G. Knepley 
71518f700142SStefano Zampini   Collective on dm
71528f700142SStefano Zampini 
7153f4d763aaSMatthew G. Knepley   Input Parameter:
7154f4d763aaSMatthew G. Knepley . dm - The original DM
7155f4d763aaSMatthew G. Knepley 
7156f4d763aaSMatthew G. Knepley   Output Parameter:
7157f4d763aaSMatthew G. Knepley . odm - The DM which provides the layout for output
7158f4d763aaSMatthew G. Knepley 
7159f4d763aaSMatthew G. Knepley   Level: intermediate
7160f4d763aaSMatthew G. Knepley 
7161e87a4003SBarry Smith .seealso: VecView(), DMGetGlobalSection()
7162f4d763aaSMatthew G. Knepley @*/
716314f150ffSMatthew G. Knepley PetscErrorCode DMGetOutputDM(DM dm, DM *odm)
716414f150ffSMatthew G. Knepley {
7165c26acbdeSMatthew G. Knepley   PetscSection   section;
71662d4e4a49SMatthew G. Knepley   PetscBool      hasConstraints, ghasConstraints;
716714f150ffSMatthew G. Knepley   PetscErrorCode ierr;
716814f150ffSMatthew G. Knepley 
716914f150ffSMatthew G. Knepley   PetscFunctionBegin;
717014f150ffSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
717114f150ffSMatthew G. Knepley   PetscValidPointer(odm,2);
717292fd8e1eSJed Brown   ierr = DMGetLocalSection(dm, &section);CHKERRQ(ierr);
7173c26acbdeSMatthew G. Knepley   ierr = PetscSectionHasConstraints(section, &hasConstraints);CHKERRQ(ierr);
7174ffc4695bSBarry Smith   ierr = MPI_Allreduce(&hasConstraints, &ghasConstraints, 1, MPIU_BOOL, MPI_LOR, PetscObjectComm((PetscObject) dm));CHKERRMPI(ierr);
71752d4e4a49SMatthew G. Knepley   if (!ghasConstraints) {
7176c26acbdeSMatthew G. Knepley     *odm = dm;
7177c26acbdeSMatthew G. Knepley     PetscFunctionReturn(0);
7178c26acbdeSMatthew G. Knepley   }
717914f150ffSMatthew G. Knepley   if (!dm->dmBC) {
7180c26acbdeSMatthew G. Knepley     PetscSection newSection, gsection;
718114f150ffSMatthew G. Knepley     PetscSF      sf;
718214f150ffSMatthew G. Knepley 
718314f150ffSMatthew G. Knepley     ierr = DMClone(dm, &dm->dmBC);CHKERRQ(ierr);
7184e5e52638SMatthew G. Knepley     ierr = DMCopyDisc(dm, dm->dmBC);CHKERRQ(ierr);
718514f150ffSMatthew G. Knepley     ierr = PetscSectionClone(section, &newSection);CHKERRQ(ierr);
718692fd8e1eSJed Brown     ierr = DMSetLocalSection(dm->dmBC, newSection);CHKERRQ(ierr);
718714f150ffSMatthew G. Knepley     ierr = PetscSectionDestroy(&newSection);CHKERRQ(ierr);
718814f150ffSMatthew G. Knepley     ierr = DMGetPointSF(dm->dmBC, &sf);CHKERRQ(ierr);
718915b58121SMatthew G. Knepley     ierr = PetscSectionCreateGlobalSection(section, sf, PETSC_TRUE, PETSC_FALSE, &gsection);CHKERRQ(ierr);
7190e87a4003SBarry Smith     ierr = DMSetGlobalSection(dm->dmBC, gsection);CHKERRQ(ierr);
719114f150ffSMatthew G. Knepley     ierr = PetscSectionDestroy(&gsection);CHKERRQ(ierr);
719214f150ffSMatthew G. Knepley   }
719314f150ffSMatthew G. Knepley   *odm = dm->dmBC;
719414f150ffSMatthew G. Knepley   PetscFunctionReturn(0);
719514f150ffSMatthew G. Knepley }
7196f4d763aaSMatthew G. Knepley 
7197f4d763aaSMatthew G. Knepley /*@
7198cdb7a50dSMatthew G. Knepley   DMGetOutputSequenceNumber - Retrieve the sequence number/value for output
7199f4d763aaSMatthew G. Knepley 
7200f4d763aaSMatthew G. Knepley   Input Parameter:
7201f4d763aaSMatthew G. Knepley . dm - The original DM
7202f4d763aaSMatthew G. Knepley 
7203cdb7a50dSMatthew G. Knepley   Output Parameters:
7204cdb7a50dSMatthew G. Knepley + num - The output sequence number
7205cdb7a50dSMatthew G. Knepley - val - The output sequence value
7206f4d763aaSMatthew G. Knepley 
7207f4d763aaSMatthew G. Knepley   Level: intermediate
7208f4d763aaSMatthew G. Knepley 
7209f4d763aaSMatthew G. Knepley   Note: This is intended for output that should appear in sequence, for instance
7210f4d763aaSMatthew G. Knepley   a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system.
7211f4d763aaSMatthew G. Knepley 
7212f4d763aaSMatthew G. Knepley .seealso: VecView()
7213f4d763aaSMatthew G. Knepley @*/
7214cdb7a50dSMatthew G. Knepley PetscErrorCode DMGetOutputSequenceNumber(DM dm, PetscInt *num, PetscReal *val)
7215f4d763aaSMatthew G. Knepley {
7216f4d763aaSMatthew G. Knepley   PetscFunctionBegin;
7217f4d763aaSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
7218534a8f05SLisandro Dalcin   if (num) {PetscValidIntPointer(num,2); *num = dm->outputSequenceNum;}
7219534a8f05SLisandro Dalcin   if (val) {PetscValidRealPointer(val,3);*val = dm->outputSequenceVal;}
7220f4d763aaSMatthew G. Knepley   PetscFunctionReturn(0);
7221f4d763aaSMatthew G. Knepley }
7222f4d763aaSMatthew G. Knepley 
7223f4d763aaSMatthew G. Knepley /*@
7224cdb7a50dSMatthew G. Knepley   DMSetOutputSequenceNumber - Set the sequence number/value for output
7225f4d763aaSMatthew G. Knepley 
7226f4d763aaSMatthew G. Knepley   Input Parameters:
7227f4d763aaSMatthew G. Knepley + dm - The original DM
7228cdb7a50dSMatthew G. Knepley . num - The output sequence number
7229cdb7a50dSMatthew G. Knepley - val - The output sequence value
7230f4d763aaSMatthew G. Knepley 
7231f4d763aaSMatthew G. Knepley   Level: intermediate
7232f4d763aaSMatthew G. Knepley 
7233f4d763aaSMatthew G. Knepley   Note: This is intended for output that should appear in sequence, for instance
7234f4d763aaSMatthew G. Knepley   a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system.
7235f4d763aaSMatthew G. Knepley 
7236f4d763aaSMatthew G. Knepley .seealso: VecView()
7237f4d763aaSMatthew G. Knepley @*/
7238cdb7a50dSMatthew G. Knepley PetscErrorCode DMSetOutputSequenceNumber(DM dm, PetscInt num, PetscReal val)
7239f4d763aaSMatthew G. Knepley {
7240f4d763aaSMatthew G. Knepley   PetscFunctionBegin;
7241f4d763aaSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
7242f4d763aaSMatthew G. Knepley   dm->outputSequenceNum = num;
7243cdb7a50dSMatthew G. Knepley   dm->outputSequenceVal = val;
7244cdb7a50dSMatthew G. Knepley   PetscFunctionReturn(0);
7245cdb7a50dSMatthew G. Knepley }
7246cdb7a50dSMatthew G. Knepley 
7247cdb7a50dSMatthew G. Knepley /*@C
7248cdb7a50dSMatthew G. Knepley   DMOutputSequenceLoad - Retrieve the sequence value from a Viewer
7249cdb7a50dSMatthew G. Knepley 
7250cdb7a50dSMatthew G. Knepley   Input Parameters:
7251cdb7a50dSMatthew G. Knepley + dm   - The original DM
7252cdb7a50dSMatthew G. Knepley . name - The sequence name
7253cdb7a50dSMatthew G. Knepley - num  - The output sequence number
7254cdb7a50dSMatthew G. Knepley 
7255cdb7a50dSMatthew G. Knepley   Output Parameter:
7256cdb7a50dSMatthew G. Knepley . val  - The output sequence value
7257cdb7a50dSMatthew G. Knepley 
7258cdb7a50dSMatthew G. Knepley   Level: intermediate
7259cdb7a50dSMatthew G. Knepley 
7260cdb7a50dSMatthew G. Knepley   Note: This is intended for output that should appear in sequence, for instance
7261cdb7a50dSMatthew G. Knepley   a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system.
7262cdb7a50dSMatthew G. Knepley 
7263cdb7a50dSMatthew G. Knepley .seealso: DMGetOutputSequenceNumber(), DMSetOutputSequenceNumber(), VecView()
7264cdb7a50dSMatthew G. Knepley @*/
7265cdb7a50dSMatthew G. Knepley PetscErrorCode DMOutputSequenceLoad(DM dm, PetscViewer viewer, const char *name, PetscInt num, PetscReal *val)
7266cdb7a50dSMatthew G. Knepley {
7267cdb7a50dSMatthew G. Knepley   PetscBool      ishdf5;
7268cdb7a50dSMatthew G. Knepley   PetscErrorCode ierr;
7269cdb7a50dSMatthew G. Knepley 
7270cdb7a50dSMatthew G. Knepley   PetscFunctionBegin;
7271cdb7a50dSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
7272cdb7a50dSMatthew G. Knepley   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
7273064a246eSJacob Faibussowitsch   PetscValidRealPointer(val,5);
7274cdb7a50dSMatthew G. Knepley   ierr = PetscObjectTypeCompare((PetscObject) viewer, PETSCVIEWERHDF5, &ishdf5);CHKERRQ(ierr);
7275cdb7a50dSMatthew G. Knepley   if (ishdf5) {
7276cdb7a50dSMatthew G. Knepley #if defined(PETSC_HAVE_HDF5)
7277cdb7a50dSMatthew G. Knepley     PetscScalar value;
7278cdb7a50dSMatthew G. Knepley 
727939d25373SMatthew G. Knepley     ierr = DMSequenceLoad_HDF5_Internal(dm, name, num, &value, viewer);CHKERRQ(ierr);
72804aeb217fSMatthew G. Knepley     *val = PetscRealPart(value);
7281cdb7a50dSMatthew G. Knepley #endif
7282cdb7a50dSMatthew G. Knepley   } else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Invalid viewer; open viewer with PetscViewerHDF5Open()");
7283f4d763aaSMatthew G. Knepley   PetscFunctionReturn(0);
7284f4d763aaSMatthew G. Knepley }
72858e4ac7eaSMatthew G. Knepley 
72868e4ac7eaSMatthew G. Knepley /*@
72878e4ac7eaSMatthew G. Knepley   DMGetUseNatural - Get the flag for creating a mapping to the natural order on distribution
72888e4ac7eaSMatthew G. Knepley 
72898e4ac7eaSMatthew G. Knepley   Not collective
72908e4ac7eaSMatthew G. Knepley 
72918e4ac7eaSMatthew G. Knepley   Input Parameter:
72928e4ac7eaSMatthew G. Knepley . dm - The DM
72938e4ac7eaSMatthew G. Knepley 
72948e4ac7eaSMatthew G. Knepley   Output Parameter:
72958e4ac7eaSMatthew G. Knepley . useNatural - The flag to build the mapping to a natural order during distribution
72968e4ac7eaSMatthew G. Knepley 
72978e4ac7eaSMatthew G. Knepley   Level: beginner
72988e4ac7eaSMatthew G. Knepley 
72998e4ac7eaSMatthew G. Knepley .seealso: DMSetUseNatural(), DMCreate()
73008e4ac7eaSMatthew G. Knepley @*/
73018e4ac7eaSMatthew G. Knepley PetscErrorCode DMGetUseNatural(DM dm, PetscBool *useNatural)
73028e4ac7eaSMatthew G. Knepley {
73038e4ac7eaSMatthew G. Knepley   PetscFunctionBegin;
73048e4ac7eaSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7305534a8f05SLisandro Dalcin   PetscValidBoolPointer(useNatural, 2);
73068e4ac7eaSMatthew G. Knepley   *useNatural = dm->useNatural;
73078e4ac7eaSMatthew G. Knepley   PetscFunctionReturn(0);
73088e4ac7eaSMatthew G. Knepley }
73098e4ac7eaSMatthew G. Knepley 
73108e4ac7eaSMatthew G. Knepley /*@
73115d3b26e6SMatthew G. Knepley   DMSetUseNatural - Set the flag for creating a mapping to the natural order after distribution
73128e4ac7eaSMatthew G. Knepley 
73138e4ac7eaSMatthew G. Knepley   Collective on dm
73148e4ac7eaSMatthew G. Knepley 
73158e4ac7eaSMatthew G. Knepley   Input Parameters:
73168e4ac7eaSMatthew G. Knepley + dm - The DM
73178e4ac7eaSMatthew G. Knepley - useNatural - The flag to build the mapping to a natural order during distribution
73188e4ac7eaSMatthew G. Knepley 
73195d3b26e6SMatthew G. Knepley   Note: This also causes the map to be build after DMCreateSubDM() and DMCreateSuperDM()
73205d3b26e6SMatthew G. Knepley 
73218e4ac7eaSMatthew G. Knepley   Level: beginner
73228e4ac7eaSMatthew G. Knepley 
73235d3b26e6SMatthew G. Knepley .seealso: DMGetUseNatural(), DMCreate(), DMPlexDistribute(), DMCreateSubDM(), DMCreateSuperDM()
73248e4ac7eaSMatthew G. Knepley @*/
73258e4ac7eaSMatthew G. Knepley PetscErrorCode DMSetUseNatural(DM dm, PetscBool useNatural)
73268e4ac7eaSMatthew G. Knepley {
73278e4ac7eaSMatthew G. Knepley   PetscFunctionBegin;
73288e4ac7eaSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
73298833efb5SBlaise Bourdin   PetscValidLogicalCollectiveBool(dm, useNatural, 2);
73308e4ac7eaSMatthew G. Knepley   dm->useNatural = useNatural;
73318e4ac7eaSMatthew G. Knepley   PetscFunctionReturn(0);
73328e4ac7eaSMatthew G. Knepley }
7333c58f1c22SToby Isaac 
7334c58f1c22SToby Isaac /*@C
7335c58f1c22SToby Isaac   DMCreateLabel - Create a label of the given name if it does not already exist
7336c58f1c22SToby Isaac 
7337c58f1c22SToby Isaac   Not Collective
7338c58f1c22SToby Isaac 
7339c58f1c22SToby Isaac   Input Parameters:
7340c58f1c22SToby Isaac + dm   - The DM object
7341c58f1c22SToby Isaac - name - The label name
7342c58f1c22SToby Isaac 
7343c58f1c22SToby Isaac   Level: intermediate
7344c58f1c22SToby Isaac 
7345c58f1c22SToby Isaac .seealso: DMLabelCreate(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7346c58f1c22SToby Isaac @*/
7347c58f1c22SToby Isaac PetscErrorCode DMCreateLabel(DM dm, const char name[])
7348c58f1c22SToby Isaac {
73495d80c0bfSVaclav Hapla   PetscBool      flg;
73505d80c0bfSVaclav Hapla   DMLabel        label;
7351c58f1c22SToby Isaac   PetscErrorCode ierr;
7352c58f1c22SToby Isaac 
7353c58f1c22SToby Isaac   PetscFunctionBegin;
7354c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7355c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
73565d80c0bfSVaclav Hapla   ierr = DMHasLabel(dm, name, &flg);CHKERRQ(ierr);
7357c58f1c22SToby Isaac   if (!flg) {
73585d80c0bfSVaclav Hapla     ierr = DMLabelCreate(PETSC_COMM_SELF, name, &label);CHKERRQ(ierr);
73595d80c0bfSVaclav Hapla     ierr = DMAddLabel(dm, label);CHKERRQ(ierr);
73605d80c0bfSVaclav Hapla     ierr = DMLabelDestroy(&label);CHKERRQ(ierr);
7361c58f1c22SToby Isaac   }
7362c58f1c22SToby Isaac   PetscFunctionReturn(0);
7363c58f1c22SToby Isaac }
7364c58f1c22SToby Isaac 
7365c58f1c22SToby Isaac /*@C
73660fdc7489SMatthew Knepley   DMCreateLabelAtIndex - Create a label of the given name at the iven index. If it already exists, move it to this index.
73670fdc7489SMatthew Knepley 
73680fdc7489SMatthew Knepley   Not Collective
73690fdc7489SMatthew Knepley 
73700fdc7489SMatthew Knepley   Input Parameters:
73710fdc7489SMatthew Knepley + dm   - The DM object
73720fdc7489SMatthew Knepley . l    - The index for the label
73730fdc7489SMatthew Knepley - name - The label name
73740fdc7489SMatthew Knepley 
73750fdc7489SMatthew Knepley   Level: intermediate
73760fdc7489SMatthew Knepley 
73770fdc7489SMatthew Knepley .seealso: DMCreateLabel(), DMLabelCreate(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
73780fdc7489SMatthew Knepley @*/
73790fdc7489SMatthew Knepley PetscErrorCode DMCreateLabelAtIndex(DM dm, PetscInt l, const char name[])
73800fdc7489SMatthew Knepley {
73810fdc7489SMatthew Knepley   DMLabelLink    orig, prev = NULL;
73820fdc7489SMatthew Knepley   DMLabel        label;
73830fdc7489SMatthew Knepley   PetscInt       Nl, m;
73840fdc7489SMatthew Knepley   PetscBool      flg, match;
73850fdc7489SMatthew Knepley   const char    *lname;
73860fdc7489SMatthew Knepley   PetscErrorCode ierr;
73870fdc7489SMatthew Knepley 
73880fdc7489SMatthew Knepley   PetscFunctionBegin;
73890fdc7489SMatthew Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7390064a246eSJacob Faibussowitsch   PetscValidCharPointer(name, 3);
73910fdc7489SMatthew Knepley   ierr = DMHasLabel(dm, name, &flg);CHKERRQ(ierr);
73920fdc7489SMatthew Knepley   if (!flg) {
73930fdc7489SMatthew Knepley     ierr = DMLabelCreate(PETSC_COMM_SELF, name, &label);CHKERRQ(ierr);
73940fdc7489SMatthew Knepley     ierr = DMAddLabel(dm, label);CHKERRQ(ierr);
73950fdc7489SMatthew Knepley     ierr = DMLabelDestroy(&label);CHKERRQ(ierr);
73960fdc7489SMatthew Knepley   }
73970fdc7489SMatthew Knepley   ierr = DMGetNumLabels(dm, &Nl);CHKERRQ(ierr);
73980fdc7489SMatthew Knepley   if (l >= Nl) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label index %D must be in [0, %D)", l, Nl);
73990fdc7489SMatthew Knepley   for (m = 0, orig = dm->labels; m < Nl; ++m, prev = orig, orig = orig->next) {
74000fdc7489SMatthew Knepley     ierr = PetscObjectGetName((PetscObject) orig->label, &lname);CHKERRQ(ierr);
74010fdc7489SMatthew Knepley     ierr = PetscStrcmp(name, lname, &match);CHKERRQ(ierr);
74020fdc7489SMatthew Knepley     if (match) break;
74030fdc7489SMatthew Knepley   }
74040fdc7489SMatthew Knepley   if (m == l) PetscFunctionReturn(0);
74050fdc7489SMatthew Knepley   if (!m) dm->labels = orig->next;
74060fdc7489SMatthew Knepley   else    prev->next = orig->next;
74070fdc7489SMatthew Knepley   if (!l) {
74080fdc7489SMatthew Knepley     orig->next = dm->labels;
74090fdc7489SMatthew Knepley     dm->labels = orig;
74100fdc7489SMatthew Knepley   } else {
74110fdc7489SMatthew Knepley     for (m = 0, prev = dm->labels; m < l-1; ++m, prev = prev->next);
74120fdc7489SMatthew Knepley     orig->next = prev->next;
74130fdc7489SMatthew Knepley     prev->next = orig;
74140fdc7489SMatthew Knepley   }
74150fdc7489SMatthew Knepley   PetscFunctionReturn(0);
74160fdc7489SMatthew Knepley }
74170fdc7489SMatthew Knepley 
74180fdc7489SMatthew Knepley /*@C
7419c58f1c22SToby Isaac   DMGetLabelValue - Get the value in a Sieve Label for the given point, with 0 as the default
7420c58f1c22SToby Isaac 
7421c58f1c22SToby Isaac   Not Collective
7422c58f1c22SToby Isaac 
7423c58f1c22SToby Isaac   Input Parameters:
7424c58f1c22SToby Isaac + dm   - The DM object
7425c58f1c22SToby Isaac . name - The label name
7426c58f1c22SToby Isaac - point - The mesh point
7427c58f1c22SToby Isaac 
7428c58f1c22SToby Isaac   Output Parameter:
7429c58f1c22SToby Isaac . value - The label value for this point, or -1 if the point is not in the label
7430c58f1c22SToby Isaac 
7431c58f1c22SToby Isaac   Level: beginner
7432c58f1c22SToby Isaac 
7433c58f1c22SToby Isaac .seealso: DMLabelGetValue(), DMSetLabelValue(), DMGetStratumIS()
7434c58f1c22SToby Isaac @*/
7435c58f1c22SToby Isaac PetscErrorCode DMGetLabelValue(DM dm, const char name[], PetscInt point, PetscInt *value)
7436c58f1c22SToby Isaac {
7437c58f1c22SToby Isaac   DMLabel        label;
7438c58f1c22SToby Isaac   PetscErrorCode ierr;
7439c58f1c22SToby Isaac 
7440c58f1c22SToby Isaac   PetscFunctionBegin;
7441c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7442c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7443c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
744413903a91SSatish Balay   if (!label) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "No label named %s was found", name);
7445c58f1c22SToby Isaac   ierr = DMLabelGetValue(label, point, value);CHKERRQ(ierr);
7446c58f1c22SToby Isaac   PetscFunctionReturn(0);
7447c58f1c22SToby Isaac }
7448c58f1c22SToby Isaac 
7449c58f1c22SToby Isaac /*@C
7450c58f1c22SToby Isaac   DMSetLabelValue - Add a point to a Sieve Label with given value
7451c58f1c22SToby Isaac 
7452c58f1c22SToby Isaac   Not Collective
7453c58f1c22SToby Isaac 
7454c58f1c22SToby Isaac   Input Parameters:
7455c58f1c22SToby Isaac + dm   - The DM object
7456c58f1c22SToby Isaac . name - The label name
7457c58f1c22SToby Isaac . point - The mesh point
7458c58f1c22SToby Isaac - value - The label value for this point
7459c58f1c22SToby Isaac 
7460c58f1c22SToby Isaac   Output Parameter:
7461c58f1c22SToby Isaac 
7462c58f1c22SToby Isaac   Level: beginner
7463c58f1c22SToby Isaac 
7464c58f1c22SToby Isaac .seealso: DMLabelSetValue(), DMGetStratumIS(), DMClearLabelValue()
7465c58f1c22SToby Isaac @*/
7466c58f1c22SToby Isaac PetscErrorCode DMSetLabelValue(DM dm, const char name[], PetscInt point, PetscInt value)
7467c58f1c22SToby Isaac {
7468c58f1c22SToby Isaac   DMLabel        label;
7469c58f1c22SToby Isaac   PetscErrorCode ierr;
7470c58f1c22SToby Isaac 
7471c58f1c22SToby Isaac   PetscFunctionBegin;
7472c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7473c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7474c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7475c58f1c22SToby Isaac   if (!label) {
7476c58f1c22SToby Isaac     ierr = DMCreateLabel(dm, name);CHKERRQ(ierr);
7477c58f1c22SToby Isaac     ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7478c58f1c22SToby Isaac   }
7479c58f1c22SToby Isaac   ierr = DMLabelSetValue(label, point, value);CHKERRQ(ierr);
7480c58f1c22SToby Isaac   PetscFunctionReturn(0);
7481c58f1c22SToby Isaac }
7482c58f1c22SToby Isaac 
7483c58f1c22SToby Isaac /*@C
7484c58f1c22SToby Isaac   DMClearLabelValue - Remove a point from a Sieve Label with given value
7485c58f1c22SToby Isaac 
7486c58f1c22SToby Isaac   Not Collective
7487c58f1c22SToby Isaac 
7488c58f1c22SToby Isaac   Input Parameters:
7489c58f1c22SToby Isaac + dm   - The DM object
7490c58f1c22SToby Isaac . name - The label name
7491c58f1c22SToby Isaac . point - The mesh point
7492c58f1c22SToby Isaac - value - The label value for this point
7493c58f1c22SToby Isaac 
7494c58f1c22SToby Isaac   Output Parameter:
7495c58f1c22SToby Isaac 
7496c58f1c22SToby Isaac   Level: beginner
7497c58f1c22SToby Isaac 
7498c58f1c22SToby Isaac .seealso: DMLabelClearValue(), DMSetLabelValue(), DMGetStratumIS()
7499c58f1c22SToby Isaac @*/
7500c58f1c22SToby Isaac PetscErrorCode DMClearLabelValue(DM dm, const char name[], PetscInt point, PetscInt value)
7501c58f1c22SToby Isaac {
7502c58f1c22SToby Isaac   DMLabel        label;
7503c58f1c22SToby Isaac   PetscErrorCode ierr;
7504c58f1c22SToby Isaac 
7505c58f1c22SToby Isaac   PetscFunctionBegin;
7506c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7507c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7508c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7509c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
7510c58f1c22SToby Isaac   ierr = DMLabelClearValue(label, point, value);CHKERRQ(ierr);
7511c58f1c22SToby Isaac   PetscFunctionReturn(0);
7512c58f1c22SToby Isaac }
7513c58f1c22SToby Isaac 
7514c58f1c22SToby Isaac /*@C
7515c58f1c22SToby Isaac   DMGetLabelSize - Get the number of different integer ids in a Label
7516c58f1c22SToby Isaac 
7517c58f1c22SToby Isaac   Not Collective
7518c58f1c22SToby Isaac 
7519c58f1c22SToby Isaac   Input Parameters:
7520c58f1c22SToby Isaac + dm   - The DM object
7521c58f1c22SToby Isaac - name - The label name
7522c58f1c22SToby Isaac 
7523c58f1c22SToby Isaac   Output Parameter:
7524c58f1c22SToby Isaac . size - The number of different integer ids, or 0 if the label does not exist
7525c58f1c22SToby Isaac 
7526c58f1c22SToby Isaac   Level: beginner
7527c58f1c22SToby Isaac 
7528df813f42SMatthew G. Knepley .seealso: DMLabelGetNumValues(), DMSetLabelValue()
7529c58f1c22SToby Isaac @*/
7530c58f1c22SToby Isaac PetscErrorCode DMGetLabelSize(DM dm, const char name[], PetscInt *size)
7531c58f1c22SToby Isaac {
7532c58f1c22SToby Isaac   DMLabel        label;
7533c58f1c22SToby Isaac   PetscErrorCode ierr;
7534c58f1c22SToby Isaac 
7535c58f1c22SToby Isaac   PetscFunctionBegin;
7536c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7537c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7538534a8f05SLisandro Dalcin   PetscValidIntPointer(size, 3);
7539c58f1c22SToby Isaac   ierr  = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7540c58f1c22SToby Isaac   *size = 0;
7541c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
7542c58f1c22SToby Isaac   ierr = DMLabelGetNumValues(label, size);CHKERRQ(ierr);
7543c58f1c22SToby Isaac   PetscFunctionReturn(0);
7544c58f1c22SToby Isaac }
7545c58f1c22SToby Isaac 
7546c58f1c22SToby Isaac /*@C
7547c58f1c22SToby Isaac   DMGetLabelIdIS - Get the integer ids in a label
7548c58f1c22SToby Isaac 
7549c58f1c22SToby Isaac   Not Collective
7550c58f1c22SToby Isaac 
7551c58f1c22SToby Isaac   Input Parameters:
7552c58f1c22SToby Isaac + mesh - The DM object
7553c58f1c22SToby Isaac - name - The label name
7554c58f1c22SToby Isaac 
7555c58f1c22SToby Isaac   Output Parameter:
7556c58f1c22SToby Isaac . ids - The integer ids, or NULL if the label does not exist
7557c58f1c22SToby Isaac 
7558c58f1c22SToby Isaac   Level: beginner
7559c58f1c22SToby Isaac 
7560c58f1c22SToby Isaac .seealso: DMLabelGetValueIS(), DMGetLabelSize()
7561c58f1c22SToby Isaac @*/
7562c58f1c22SToby Isaac PetscErrorCode DMGetLabelIdIS(DM dm, const char name[], IS *ids)
7563c58f1c22SToby Isaac {
7564c58f1c22SToby Isaac   DMLabel        label;
7565c58f1c22SToby Isaac   PetscErrorCode ierr;
7566c58f1c22SToby Isaac 
7567c58f1c22SToby Isaac   PetscFunctionBegin;
7568c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7569c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7570c58f1c22SToby Isaac   PetscValidPointer(ids, 3);
7571c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7572c58f1c22SToby Isaac   *ids = NULL;
7573dab2e251SBlaise Bourdin  if (label) {
7574c58f1c22SToby Isaac     ierr = DMLabelGetValueIS(label, ids);CHKERRQ(ierr);
7575dab2e251SBlaise Bourdin   } else {
7576dab2e251SBlaise Bourdin     /* returning an empty IS */
7577dab2e251SBlaise Bourdin     ierr = ISCreateGeneral(PETSC_COMM_SELF,0,NULL,PETSC_USE_POINTER,ids);CHKERRQ(ierr);
7578dab2e251SBlaise Bourdin   }
7579c58f1c22SToby Isaac   PetscFunctionReturn(0);
7580c58f1c22SToby Isaac }
7581c58f1c22SToby Isaac 
7582c58f1c22SToby Isaac /*@C
7583c58f1c22SToby Isaac   DMGetStratumSize - Get the number of points in a label stratum
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 - value - The stratum value
7591c58f1c22SToby Isaac 
7592c58f1c22SToby Isaac   Output Parameter:
7593c58f1c22SToby Isaac . size - The stratum size
7594c58f1c22SToby Isaac 
7595c58f1c22SToby Isaac   Level: beginner
7596c58f1c22SToby Isaac 
7597c58f1c22SToby Isaac .seealso: DMLabelGetStratumSize(), DMGetLabelSize(), DMGetLabelIds()
7598c58f1c22SToby Isaac @*/
7599c58f1c22SToby Isaac PetscErrorCode DMGetStratumSize(DM dm, const char name[], PetscInt value, PetscInt *size)
7600c58f1c22SToby Isaac {
7601c58f1c22SToby Isaac   DMLabel        label;
7602c58f1c22SToby Isaac   PetscErrorCode ierr;
7603c58f1c22SToby Isaac 
7604c58f1c22SToby Isaac   PetscFunctionBegin;
7605c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7606c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7607534a8f05SLisandro Dalcin   PetscValidIntPointer(size, 4);
7608c58f1c22SToby Isaac   ierr  = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7609c58f1c22SToby Isaac   *size = 0;
7610c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
7611c58f1c22SToby Isaac   ierr = DMLabelGetStratumSize(label, value, size);CHKERRQ(ierr);
7612c58f1c22SToby Isaac   PetscFunctionReturn(0);
7613c58f1c22SToby Isaac }
7614c58f1c22SToby Isaac 
7615c58f1c22SToby Isaac /*@C
7616c58f1c22SToby Isaac   DMGetStratumIS - Get the points in a label stratum
7617c58f1c22SToby Isaac 
7618c58f1c22SToby Isaac   Not Collective
7619c58f1c22SToby Isaac 
7620c58f1c22SToby Isaac   Input Parameters:
7621c58f1c22SToby Isaac + dm - The DM object
7622c58f1c22SToby Isaac . name - The label name
7623c58f1c22SToby Isaac - value - The stratum value
7624c58f1c22SToby Isaac 
7625c58f1c22SToby Isaac   Output Parameter:
7626c58f1c22SToby Isaac . points - The stratum points, or NULL if the label does not exist or does not have that value
7627c58f1c22SToby Isaac 
7628c58f1c22SToby Isaac   Level: beginner
7629c58f1c22SToby Isaac 
7630c58f1c22SToby Isaac .seealso: DMLabelGetStratumIS(), DMGetStratumSize()
7631c58f1c22SToby Isaac @*/
7632c58f1c22SToby Isaac PetscErrorCode DMGetStratumIS(DM dm, const char name[], PetscInt value, IS *points)
7633c58f1c22SToby Isaac {
7634c58f1c22SToby Isaac   DMLabel        label;
7635c58f1c22SToby Isaac   PetscErrorCode ierr;
7636c58f1c22SToby Isaac 
7637c58f1c22SToby Isaac   PetscFunctionBegin;
7638c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7639c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7640c58f1c22SToby Isaac   PetscValidPointer(points, 4);
7641c58f1c22SToby Isaac   ierr    = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7642c58f1c22SToby Isaac   *points = NULL;
7643c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
7644c58f1c22SToby Isaac   ierr = DMLabelGetStratumIS(label, value, points);CHKERRQ(ierr);
7645c58f1c22SToby Isaac   PetscFunctionReturn(0);
7646c58f1c22SToby Isaac }
7647c58f1c22SToby Isaac 
76484de306b1SToby Isaac /*@C
76499044fa66SMatthew G. Knepley   DMSetStratumIS - Set the points in a label stratum
76504de306b1SToby Isaac 
76514de306b1SToby Isaac   Not Collective
76524de306b1SToby Isaac 
76534de306b1SToby Isaac   Input Parameters:
76544de306b1SToby Isaac + dm - The DM object
76554de306b1SToby Isaac . name - The label name
76564de306b1SToby Isaac . value - The stratum value
76574de306b1SToby Isaac - points - The stratum points
76584de306b1SToby Isaac 
76594de306b1SToby Isaac   Level: beginner
76604de306b1SToby Isaac 
76614de306b1SToby Isaac .seealso: DMLabelSetStratumIS(), DMGetStratumSize()
76624de306b1SToby Isaac @*/
76634de306b1SToby Isaac PetscErrorCode DMSetStratumIS(DM dm, const char name[], PetscInt value, IS points)
76644de306b1SToby Isaac {
76654de306b1SToby Isaac   DMLabel        label;
76664de306b1SToby Isaac   PetscErrorCode ierr;
76674de306b1SToby Isaac 
76684de306b1SToby Isaac   PetscFunctionBegin;
76694de306b1SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
76704de306b1SToby Isaac   PetscValidCharPointer(name, 2);
76714de306b1SToby Isaac   PetscValidPointer(points, 4);
76724de306b1SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
76734de306b1SToby Isaac   if (!label) PetscFunctionReturn(0);
76744de306b1SToby Isaac   ierr = DMLabelSetStratumIS(label, value, points);CHKERRQ(ierr);
76754de306b1SToby Isaac   PetscFunctionReturn(0);
76764de306b1SToby Isaac }
76774de306b1SToby Isaac 
7678c58f1c22SToby Isaac /*@C
7679c58f1c22SToby Isaac   DMClearLabelStratum - Remove all points from a stratum from a Sieve Label
7680c58f1c22SToby Isaac 
7681c58f1c22SToby Isaac   Not Collective
7682c58f1c22SToby Isaac 
7683c58f1c22SToby Isaac   Input Parameters:
7684c58f1c22SToby Isaac + dm   - The DM object
7685c58f1c22SToby Isaac . name - The label name
7686c58f1c22SToby Isaac - value - The label value for this point
7687c58f1c22SToby Isaac 
7688c58f1c22SToby Isaac   Output Parameter:
7689c58f1c22SToby Isaac 
7690c58f1c22SToby Isaac   Level: beginner
7691c58f1c22SToby Isaac 
7692c58f1c22SToby Isaac .seealso: DMLabelClearStratum(), DMSetLabelValue(), DMGetStratumIS(), DMClearLabelValue()
7693c58f1c22SToby Isaac @*/
7694c58f1c22SToby Isaac PetscErrorCode DMClearLabelStratum(DM dm, const char name[], PetscInt value)
7695c58f1c22SToby Isaac {
7696c58f1c22SToby Isaac   DMLabel        label;
7697c58f1c22SToby Isaac   PetscErrorCode ierr;
7698c58f1c22SToby Isaac 
7699c58f1c22SToby Isaac   PetscFunctionBegin;
7700c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7701c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7702c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7703c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
7704c58f1c22SToby Isaac   ierr = DMLabelClearStratum(label, value);CHKERRQ(ierr);
7705c58f1c22SToby Isaac   PetscFunctionReturn(0);
7706c58f1c22SToby Isaac }
7707c58f1c22SToby Isaac 
7708c58f1c22SToby Isaac /*@
7709c58f1c22SToby Isaac   DMGetNumLabels - Return the number of labels defined by the mesh
7710c58f1c22SToby Isaac 
7711c58f1c22SToby Isaac   Not Collective
7712c58f1c22SToby Isaac 
7713c58f1c22SToby Isaac   Input Parameter:
7714c58f1c22SToby Isaac . dm   - The DM object
7715c58f1c22SToby Isaac 
7716c58f1c22SToby Isaac   Output Parameter:
7717c58f1c22SToby Isaac . numLabels - the number of Labels
7718c58f1c22SToby Isaac 
7719c58f1c22SToby Isaac   Level: intermediate
7720c58f1c22SToby Isaac 
7721c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7722c58f1c22SToby Isaac @*/
7723c58f1c22SToby Isaac PetscErrorCode DMGetNumLabels(DM dm, PetscInt *numLabels)
7724c58f1c22SToby Isaac {
77255d80c0bfSVaclav Hapla   DMLabelLink next = dm->labels;
7726c58f1c22SToby Isaac   PetscInt  n    = 0;
7727c58f1c22SToby Isaac 
7728c58f1c22SToby Isaac   PetscFunctionBegin;
7729c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7730534a8f05SLisandro Dalcin   PetscValidIntPointer(numLabels, 2);
7731c58f1c22SToby Isaac   while (next) {++n; next = next->next;}
7732c58f1c22SToby Isaac   *numLabels = n;
7733c58f1c22SToby Isaac   PetscFunctionReturn(0);
7734c58f1c22SToby Isaac }
7735c58f1c22SToby Isaac 
7736c58f1c22SToby Isaac /*@C
7737c58f1c22SToby Isaac   DMGetLabelName - Return the name of nth label
7738c58f1c22SToby Isaac 
7739c58f1c22SToby Isaac   Not Collective
7740c58f1c22SToby Isaac 
7741c58f1c22SToby Isaac   Input Parameters:
7742c58f1c22SToby Isaac + dm - The DM object
7743c58f1c22SToby Isaac - n  - the label number
7744c58f1c22SToby Isaac 
7745c58f1c22SToby Isaac   Output Parameter:
7746c58f1c22SToby Isaac . name - the label name
7747c58f1c22SToby Isaac 
7748c58f1c22SToby Isaac   Level: intermediate
7749c58f1c22SToby Isaac 
7750c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7751c58f1c22SToby Isaac @*/
7752c58f1c22SToby Isaac PetscErrorCode DMGetLabelName(DM dm, PetscInt n, const char **name)
7753c58f1c22SToby Isaac {
77545d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
7755c58f1c22SToby Isaac   PetscInt       l    = 0;
7756d67d17b1SMatthew G. Knepley   PetscErrorCode ierr;
7757c58f1c22SToby Isaac 
7758c58f1c22SToby Isaac   PetscFunctionBegin;
7759c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7760c58f1c22SToby Isaac   PetscValidPointer(name, 3);
7761c58f1c22SToby Isaac   while (next) {
7762c58f1c22SToby Isaac     if (l == n) {
7763d67d17b1SMatthew G. Knepley       ierr = PetscObjectGetName((PetscObject) next->label, name);CHKERRQ(ierr);
7764c58f1c22SToby Isaac       PetscFunctionReturn(0);
7765c58f1c22SToby Isaac     }
7766c58f1c22SToby Isaac     ++l;
7767c58f1c22SToby Isaac     next = next->next;
7768c58f1c22SToby Isaac   }
7769c58f1c22SToby Isaac   SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %D does not exist in this DM", n);
7770c58f1c22SToby Isaac }
7771c58f1c22SToby Isaac 
7772c58f1c22SToby Isaac /*@C
7773c58f1c22SToby Isaac   DMHasLabel - Determine whether the mesh has a label of a given name
7774c58f1c22SToby Isaac 
7775c58f1c22SToby Isaac   Not Collective
7776c58f1c22SToby Isaac 
7777c58f1c22SToby Isaac   Input Parameters:
7778c58f1c22SToby Isaac + dm   - The DM object
7779c58f1c22SToby Isaac - name - The label name
7780c58f1c22SToby Isaac 
7781c58f1c22SToby Isaac   Output Parameter:
7782c58f1c22SToby Isaac . hasLabel - PETSC_TRUE if the label is present
7783c58f1c22SToby Isaac 
7784c58f1c22SToby Isaac   Level: intermediate
7785c58f1c22SToby Isaac 
7786c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7787c58f1c22SToby Isaac @*/
7788c58f1c22SToby Isaac PetscErrorCode DMHasLabel(DM dm, const char name[], PetscBool *hasLabel)
7789c58f1c22SToby Isaac {
77905d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
7791d67d17b1SMatthew G. Knepley   const char    *lname;
7792c58f1c22SToby Isaac   PetscErrorCode ierr;
7793c58f1c22SToby Isaac 
7794c58f1c22SToby Isaac   PetscFunctionBegin;
7795c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7796c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7797534a8f05SLisandro Dalcin   PetscValidBoolPointer(hasLabel, 3);
7798c58f1c22SToby Isaac   *hasLabel = PETSC_FALSE;
7799c58f1c22SToby Isaac   while (next) {
7800d67d17b1SMatthew G. Knepley     ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr);
7801d67d17b1SMatthew G. Knepley     ierr = PetscStrcmp(name, lname, hasLabel);CHKERRQ(ierr);
7802c58f1c22SToby Isaac     if (*hasLabel) break;
7803c58f1c22SToby Isaac     next = next->next;
7804c58f1c22SToby Isaac   }
7805c58f1c22SToby Isaac   PetscFunctionReturn(0);
7806c58f1c22SToby Isaac }
7807c58f1c22SToby Isaac 
7808c58f1c22SToby Isaac /*@C
7809c58f1c22SToby Isaac   DMGetLabel - Return the label of a given name, or NULL
7810c58f1c22SToby Isaac 
7811c58f1c22SToby Isaac   Not Collective
7812c58f1c22SToby Isaac 
7813c58f1c22SToby Isaac   Input Parameters:
7814c58f1c22SToby Isaac + dm   - The DM object
7815c58f1c22SToby Isaac - name - The label name
7816c58f1c22SToby Isaac 
7817c58f1c22SToby Isaac   Output Parameter:
7818c58f1c22SToby Isaac . label - The DMLabel, or NULL if the label is absent
7819c58f1c22SToby Isaac 
78206d7c9049SMatthew G. Knepley   Note: Some of the default labels in a DMPlex will be
78216d7c9049SMatthew G. Knepley $ "depth"       - Holds the depth (co-dimension) of each mesh point
78226d7c9049SMatthew G. Knepley $ "celltype"    - Holds the topological type of each cell
78236d7c9049SMatthew G. Knepley $ "ghost"       - If the DM is distributed with overlap, this marks the cells and faces in the overlap
78246d7c9049SMatthew G. Knepley $ "Cell Sets"   - Mirrors the cell sets defined by GMsh and ExodusII
78256d7c9049SMatthew G. Knepley $ "Face Sets"   - Mirrors the face sets defined by GMsh and ExodusII
78266d7c9049SMatthew G. Knepley $ "Vertex Sets" - Mirrors the vertex sets defined by GMsh
78276d7c9049SMatthew G. Knepley 
7828c58f1c22SToby Isaac   Level: intermediate
7829c58f1c22SToby Isaac 
78306d7c9049SMatthew G. Knepley .seealso: DMCreateLabel(), DMHasLabel(), DMPlexGetDepthLabel(), DMPlexGetCellType()
7831c58f1c22SToby Isaac @*/
7832c58f1c22SToby Isaac PetscErrorCode DMGetLabel(DM dm, const char name[], DMLabel *label)
7833c58f1c22SToby Isaac {
78345d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
7835c58f1c22SToby Isaac   PetscBool      hasLabel;
7836d67d17b1SMatthew G. Knepley   const char    *lname;
7837c58f1c22SToby Isaac   PetscErrorCode ierr;
7838c58f1c22SToby Isaac 
7839c58f1c22SToby Isaac   PetscFunctionBegin;
7840c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7841c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7842c58f1c22SToby Isaac   PetscValidPointer(label, 3);
7843c58f1c22SToby Isaac   *label = NULL;
7844c58f1c22SToby Isaac   while (next) {
7845d67d17b1SMatthew G. Knepley     ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr);
7846d67d17b1SMatthew G. Knepley     ierr = PetscStrcmp(name, lname, &hasLabel);CHKERRQ(ierr);
7847c58f1c22SToby Isaac     if (hasLabel) {
7848c58f1c22SToby Isaac       *label = next->label;
7849c58f1c22SToby Isaac       break;
7850c58f1c22SToby Isaac     }
7851c58f1c22SToby Isaac     next = next->next;
7852c58f1c22SToby Isaac   }
7853c58f1c22SToby Isaac   PetscFunctionReturn(0);
7854c58f1c22SToby Isaac }
7855c58f1c22SToby Isaac 
7856c58f1c22SToby Isaac /*@C
7857c58f1c22SToby Isaac   DMGetLabelByNum - Return the nth label
7858c58f1c22SToby Isaac 
7859c58f1c22SToby Isaac   Not Collective
7860c58f1c22SToby Isaac 
7861c58f1c22SToby Isaac   Input Parameters:
7862c58f1c22SToby Isaac + dm - The DM object
7863c58f1c22SToby Isaac - n  - the label number
7864c58f1c22SToby Isaac 
7865c58f1c22SToby Isaac   Output Parameter:
7866c58f1c22SToby Isaac . label - the label
7867c58f1c22SToby Isaac 
7868c58f1c22SToby Isaac   Level: intermediate
7869c58f1c22SToby Isaac 
7870c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7871c58f1c22SToby Isaac @*/
7872c58f1c22SToby Isaac PetscErrorCode DMGetLabelByNum(DM dm, PetscInt n, DMLabel *label)
7873c58f1c22SToby Isaac {
78745d80c0bfSVaclav Hapla   DMLabelLink next = dm->labels;
7875c58f1c22SToby Isaac   PetscInt    l    = 0;
7876c58f1c22SToby Isaac 
7877c58f1c22SToby Isaac   PetscFunctionBegin;
7878c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7879c58f1c22SToby Isaac   PetscValidPointer(label, 3);
7880c58f1c22SToby Isaac   while (next) {
7881c58f1c22SToby Isaac     if (l == n) {
7882c58f1c22SToby Isaac       *label = next->label;
7883c58f1c22SToby Isaac       PetscFunctionReturn(0);
7884c58f1c22SToby Isaac     }
7885c58f1c22SToby Isaac     ++l;
7886c58f1c22SToby Isaac     next = next->next;
7887c58f1c22SToby Isaac   }
7888c58f1c22SToby Isaac   SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %D does not exist in this DM", n);
7889c58f1c22SToby Isaac }
7890c58f1c22SToby Isaac 
7891c58f1c22SToby Isaac /*@C
7892c58f1c22SToby Isaac   DMAddLabel - Add the label to this mesh
7893c58f1c22SToby Isaac 
7894c58f1c22SToby Isaac   Not Collective
7895c58f1c22SToby Isaac 
7896c58f1c22SToby Isaac   Input Parameters:
7897c58f1c22SToby Isaac + dm   - The DM object
7898c58f1c22SToby Isaac - label - The DMLabel
7899c58f1c22SToby Isaac 
7900c58f1c22SToby Isaac   Level: developer
7901c58f1c22SToby Isaac 
7902c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7903c58f1c22SToby Isaac @*/
7904c58f1c22SToby Isaac PetscErrorCode DMAddLabel(DM dm, DMLabel label)
7905c58f1c22SToby Isaac {
79065d80c0bfSVaclav Hapla   DMLabelLink    l, *p, tmpLabel;
7907c58f1c22SToby Isaac   PetscBool      hasLabel;
7908d67d17b1SMatthew G. Knepley   const char    *lname;
79095d80c0bfSVaclav Hapla   PetscBool      flg;
7910c58f1c22SToby Isaac   PetscErrorCode ierr;
7911c58f1c22SToby Isaac 
7912c58f1c22SToby Isaac   PetscFunctionBegin;
7913c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7914d67d17b1SMatthew G. Knepley   ierr = PetscObjectGetName((PetscObject) label, &lname);CHKERRQ(ierr);
7915d67d17b1SMatthew G. Knepley   ierr = DMHasLabel(dm, lname, &hasLabel);CHKERRQ(ierr);
7916d67d17b1SMatthew G. Knepley   if (hasLabel) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %s already exists in this DM", lname);
7917c58f1c22SToby Isaac   ierr = PetscCalloc1(1, &tmpLabel);CHKERRQ(ierr);
7918c58f1c22SToby Isaac   tmpLabel->label  = label;
7919c58f1c22SToby Isaac   tmpLabel->output = PETSC_TRUE;
79205d80c0bfSVaclav Hapla   for (p=&dm->labels; (l=*p); p=&l->next) {}
79215d80c0bfSVaclav Hapla   *p = tmpLabel;
792208f633c4SVaclav Hapla   ierr = PetscObjectReference((PetscObject)label);CHKERRQ(ierr);
79235d80c0bfSVaclav Hapla   ierr = PetscStrcmp(lname, "depth", &flg);CHKERRQ(ierr);
79245d80c0bfSVaclav Hapla   if (flg) dm->depthLabel = label;
7925ba2698f1SMatthew G. Knepley   ierr = PetscStrcmp(lname, "celltype", &flg);CHKERRQ(ierr);
7926ba2698f1SMatthew G. Knepley   if (flg) dm->celltypeLabel = label;
7927c58f1c22SToby Isaac   PetscFunctionReturn(0);
7928c58f1c22SToby Isaac }
7929c58f1c22SToby Isaac 
7930c58f1c22SToby Isaac /*@C
79314a7ee7d0SMatthew G. Knepley   DMSetLabel - Replaces the label of a given name, or ignores it if the name is not present
79324a7ee7d0SMatthew G. Knepley 
79334a7ee7d0SMatthew G. Knepley   Not Collective
79344a7ee7d0SMatthew G. Knepley 
79354a7ee7d0SMatthew G. Knepley   Input Parameters:
79364a7ee7d0SMatthew G. Knepley + dm    - The DM object
79374a7ee7d0SMatthew G. Knepley - label - The DMLabel, having the same name, to substitute
79384a7ee7d0SMatthew G. Knepley 
79394a7ee7d0SMatthew G. Knepley   Note: Some of the default labels in a DMPlex will be
79404a7ee7d0SMatthew G. Knepley $ "depth"       - Holds the depth (co-dimension) of each mesh point
79414a7ee7d0SMatthew G. Knepley $ "celltype"    - Holds the topological type of each cell
79424a7ee7d0SMatthew G. Knepley $ "ghost"       - If the DM is distributed with overlap, this marks the cells and faces in the overlap
79434a7ee7d0SMatthew G. Knepley $ "Cell Sets"   - Mirrors the cell sets defined by GMsh and ExodusII
79444a7ee7d0SMatthew G. Knepley $ "Face Sets"   - Mirrors the face sets defined by GMsh and ExodusII
79454a7ee7d0SMatthew G. Knepley $ "Vertex Sets" - Mirrors the vertex sets defined by GMsh
79464a7ee7d0SMatthew G. Knepley 
79474a7ee7d0SMatthew G. Knepley   Level: intermediate
79484a7ee7d0SMatthew G. Knepley 
79494a7ee7d0SMatthew G. Knepley .seealso: DMCreateLabel(), DMHasLabel(), DMPlexGetDepthLabel(), DMPlexGetCellType()
79504a7ee7d0SMatthew G. Knepley @*/
79514a7ee7d0SMatthew G. Knepley PetscErrorCode DMSetLabel(DM dm, DMLabel label)
79524a7ee7d0SMatthew G. Knepley {
79534a7ee7d0SMatthew G. Knepley   DMLabelLink    next = dm->labels;
79544a7ee7d0SMatthew G. Knepley   PetscBool      hasLabel, flg;
79554a7ee7d0SMatthew G. Knepley   const char    *name, *lname;
79564a7ee7d0SMatthew G. Knepley   PetscErrorCode ierr;
79574a7ee7d0SMatthew G. Knepley 
79584a7ee7d0SMatthew G. Knepley   PetscFunctionBegin;
79594a7ee7d0SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
79604a7ee7d0SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
79614a7ee7d0SMatthew G. Knepley   ierr = PetscObjectGetName((PetscObject) label, &name);CHKERRQ(ierr);
79624a7ee7d0SMatthew G. Knepley   while (next) {
79634a7ee7d0SMatthew G. Knepley     ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr);
79644a7ee7d0SMatthew G. Knepley     ierr = PetscStrcmp(name, lname, &hasLabel);CHKERRQ(ierr);
79654a7ee7d0SMatthew G. Knepley     if (hasLabel) {
79664a7ee7d0SMatthew G. Knepley       ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr);
79674a7ee7d0SMatthew G. Knepley       ierr = PetscStrcmp(lname, "depth", &flg);CHKERRQ(ierr);
79684a7ee7d0SMatthew G. Knepley       if (flg) dm->depthLabel = label;
79694a7ee7d0SMatthew G. Knepley       ierr = PetscStrcmp(lname, "celltype", &flg);CHKERRQ(ierr);
79704a7ee7d0SMatthew G. Knepley       if (flg) dm->celltypeLabel = label;
79714a7ee7d0SMatthew G. Knepley       ierr = DMLabelDestroy(&next->label);CHKERRQ(ierr);
79724a7ee7d0SMatthew G. Knepley       next->label = label;
79734a7ee7d0SMatthew G. Knepley       break;
79744a7ee7d0SMatthew G. Knepley     }
79754a7ee7d0SMatthew G. Knepley     next = next->next;
79764a7ee7d0SMatthew G. Knepley   }
79774a7ee7d0SMatthew G. Knepley   PetscFunctionReturn(0);
79784a7ee7d0SMatthew G. Knepley }
79794a7ee7d0SMatthew G. Knepley 
79804a7ee7d0SMatthew G. Knepley /*@C
7981e5472504SVaclav Hapla   DMRemoveLabel - Remove the label given by name from this mesh
7982c58f1c22SToby Isaac 
7983c58f1c22SToby Isaac   Not Collective
7984c58f1c22SToby Isaac 
7985c58f1c22SToby Isaac   Input Parameters:
7986c58f1c22SToby Isaac + dm   - The DM object
7987c58f1c22SToby Isaac - name - The label name
7988c58f1c22SToby Isaac 
7989c58f1c22SToby Isaac   Output Parameter:
7990c58f1c22SToby Isaac . label - The DMLabel, or NULL if the label is absent
7991c58f1c22SToby Isaac 
7992c58f1c22SToby Isaac   Level: developer
7993c58f1c22SToby Isaac 
7994e5472504SVaclav Hapla   Notes:
7995e5472504SVaclav Hapla   DMRemoveLabel(dm,name,NULL) removes the label from dm and calls
7996e5472504SVaclav Hapla   DMLabelDestroy() on the label.
7997e5472504SVaclav Hapla 
7998e5472504SVaclav Hapla   DMRemoveLabel(dm,name,&label) removes the label from dm, but it DOES NOT
7999e5472504SVaclav Hapla   call DMLabelDestroy(). Instead, the label is returned and the user is
8000e5472504SVaclav Hapla   responsible of calling DMLabelDestroy() at some point.
8001e5472504SVaclav Hapla 
8002e5472504SVaclav Hapla .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabel(), DMGetLabelValue(), DMSetLabelValue(), DMLabelDestroy(), DMRemoveLabelBySelf()
8003c58f1c22SToby Isaac @*/
8004c58f1c22SToby Isaac PetscErrorCode DMRemoveLabel(DM dm, const char name[], DMLabel *label)
8005c58f1c22SToby Isaac {
800695d578d6SVaclav Hapla   DMLabelLink    link, *pnext;
8007c58f1c22SToby Isaac   PetscBool      hasLabel;
8008d67d17b1SMatthew G. Knepley   const char    *lname;
8009c58f1c22SToby Isaac   PetscErrorCode ierr;
8010c58f1c22SToby Isaac 
8011c58f1c22SToby Isaac   PetscFunctionBegin;
8012c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8013e5472504SVaclav Hapla   PetscValidCharPointer(name, 2);
8014e5472504SVaclav Hapla   if (label) {
8015e5472504SVaclav Hapla     PetscValidPointer(label, 3);
8016c58f1c22SToby Isaac     *label = NULL;
8017e5472504SVaclav Hapla   }
80185d80c0bfSVaclav Hapla   for (pnext=&dm->labels; (link=*pnext); pnext=&link->next) {
801995d578d6SVaclav Hapla     ierr = PetscObjectGetName((PetscObject) link->label, &lname);CHKERRQ(ierr);
8020d67d17b1SMatthew G. Knepley     ierr = PetscStrcmp(name, lname, &hasLabel);CHKERRQ(ierr);
8021c58f1c22SToby Isaac     if (hasLabel) {
802295d578d6SVaclav Hapla       *pnext = link->next; /* Remove from list */
8023c58f1c22SToby Isaac       ierr = PetscStrcmp(name, "depth", &hasLabel);CHKERRQ(ierr);
802495d578d6SVaclav Hapla       if (hasLabel) dm->depthLabel = NULL;
8025ba2698f1SMatthew G. Knepley       ierr = PetscStrcmp(name, "celltype", &hasLabel);CHKERRQ(ierr);
8026ba2698f1SMatthew G. Knepley       if (hasLabel) dm->celltypeLabel = NULL;
802795d578d6SVaclav Hapla       if (label) *label = link->label;
802895d578d6SVaclav Hapla       else       {ierr = DMLabelDestroy(&link->label);CHKERRQ(ierr);}
802995d578d6SVaclav Hapla       ierr = PetscFree(link);CHKERRQ(ierr);
8030c58f1c22SToby Isaac       break;
8031c58f1c22SToby Isaac     }
8032c58f1c22SToby Isaac   }
8033c58f1c22SToby Isaac   PetscFunctionReturn(0);
8034c58f1c22SToby Isaac }
8035c58f1c22SToby Isaac 
8036306894acSVaclav Hapla /*@
8037306894acSVaclav Hapla   DMRemoveLabelBySelf - Remove the label from this mesh
8038306894acSVaclav Hapla 
8039306894acSVaclav Hapla   Not Collective
8040306894acSVaclav Hapla 
8041306894acSVaclav Hapla   Input Parameters:
8042306894acSVaclav Hapla + dm   - The DM object
8043306894acSVaclav Hapla . label - (Optional) The DMLabel to be removed from the DM
8044306894acSVaclav Hapla - failNotFound - Should it fail if the label is not found in the DM?
8045306894acSVaclav Hapla 
8046306894acSVaclav Hapla   Level: developer
8047306894acSVaclav Hapla 
8048306894acSVaclav Hapla   Notes:
8049306894acSVaclav Hapla   Only exactly the same instance is removed if found, name match is ignored.
8050306894acSVaclav Hapla   If the DM has an exclusive reference to the label, it gets destroyed and
8051306894acSVaclav Hapla   *label nullified.
8052306894acSVaclav Hapla 
8053306894acSVaclav Hapla .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabel() DMGetLabelValue(), DMSetLabelValue(), DMLabelDestroy(), DMRemoveLabel()
8054306894acSVaclav Hapla @*/
8055306894acSVaclav Hapla PetscErrorCode DMRemoveLabelBySelf(DM dm, DMLabel *label, PetscBool failNotFound)
8056306894acSVaclav Hapla {
805743e45a93SVaclav Hapla   DMLabelLink    link, *pnext;
8058306894acSVaclav Hapla   PetscBool      hasLabel = PETSC_FALSE;
8059306894acSVaclav Hapla   PetscErrorCode ierr;
8060306894acSVaclav Hapla 
8061306894acSVaclav Hapla   PetscFunctionBegin;
8062306894acSVaclav Hapla   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8063306894acSVaclav Hapla   PetscValidPointer(label, 2);
8064f39a9ae0SVaclav Hapla   if (!*label && !failNotFound) PetscFunctionReturn(0);
8065306894acSVaclav Hapla   PetscValidHeaderSpecific(*label, DMLABEL_CLASSID, 2);
8066306894acSVaclav Hapla   PetscValidLogicalCollectiveBool(dm,failNotFound,3);
80675d80c0bfSVaclav Hapla   for (pnext=&dm->labels; (link=*pnext); pnext=&link->next) {
806843e45a93SVaclav Hapla     if (*label == link->label) {
8069306894acSVaclav Hapla       hasLabel = PETSC_TRUE;
807043e45a93SVaclav Hapla       *pnext = link->next; /* Remove from list */
8071306894acSVaclav Hapla       if (*label == dm->depthLabel) dm->depthLabel = NULL;
8072ba2698f1SMatthew G. Knepley       if (*label == dm->celltypeLabel) dm->celltypeLabel = NULL;
807343e45a93SVaclav Hapla       if (((PetscObject) link->label)->refct < 2) *label = NULL; /* nullify if exclusive reference */
807443e45a93SVaclav Hapla       ierr = DMLabelDestroy(&link->label);CHKERRQ(ierr);
807543e45a93SVaclav Hapla       ierr = PetscFree(link);CHKERRQ(ierr);
8076306894acSVaclav Hapla       break;
8077306894acSVaclav Hapla     }
8078306894acSVaclav Hapla   }
8079306894acSVaclav Hapla   if (!hasLabel && failNotFound) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONG, "Given label not found in DM");
8080306894acSVaclav Hapla   PetscFunctionReturn(0);
8081306894acSVaclav Hapla }
8082306894acSVaclav Hapla 
8083c58f1c22SToby Isaac /*@C
8084c58f1c22SToby Isaac   DMGetLabelOutput - Get the output flag for a given label
8085c58f1c22SToby Isaac 
8086c58f1c22SToby Isaac   Not Collective
8087c58f1c22SToby Isaac 
8088c58f1c22SToby Isaac   Input Parameters:
8089c58f1c22SToby Isaac + dm   - The DM object
8090c58f1c22SToby Isaac - name - The label name
8091c58f1c22SToby Isaac 
8092c58f1c22SToby Isaac   Output Parameter:
8093c58f1c22SToby Isaac . output - The flag for output
8094c58f1c22SToby Isaac 
8095c58f1c22SToby Isaac   Level: developer
8096c58f1c22SToby Isaac 
8097c58f1c22SToby Isaac .seealso: DMSetLabelOutput(), DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
8098c58f1c22SToby Isaac @*/
8099c58f1c22SToby Isaac PetscErrorCode DMGetLabelOutput(DM dm, const char name[], PetscBool *output)
8100c58f1c22SToby Isaac {
81015d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
8102d67d17b1SMatthew G. Knepley   const char    *lname;
8103c58f1c22SToby Isaac   PetscErrorCode ierr;
8104c58f1c22SToby Isaac 
8105c58f1c22SToby Isaac   PetscFunctionBegin;
8106c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8107c58f1c22SToby Isaac   PetscValidPointer(name, 2);
8108c58f1c22SToby Isaac   PetscValidPointer(output, 3);
8109c58f1c22SToby Isaac   while (next) {
8110c58f1c22SToby Isaac     PetscBool flg;
8111c58f1c22SToby Isaac 
8112d67d17b1SMatthew G. Knepley     ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr);
8113d67d17b1SMatthew G. Knepley     ierr = PetscStrcmp(name, lname, &flg);CHKERRQ(ierr);
8114c58f1c22SToby Isaac     if (flg) {*output = next->output; PetscFunctionReturn(0);}
8115c58f1c22SToby Isaac     next = next->next;
8116c58f1c22SToby Isaac   }
8117c58f1c22SToby Isaac   SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "No label named %s was present in this dm", name);
8118c58f1c22SToby Isaac }
8119c58f1c22SToby Isaac 
8120c58f1c22SToby Isaac /*@C
8121c58f1c22SToby Isaac   DMSetLabelOutput - Set the output flag for a given label
8122c58f1c22SToby Isaac 
8123c58f1c22SToby Isaac   Not Collective
8124c58f1c22SToby Isaac 
8125c58f1c22SToby Isaac   Input Parameters:
8126c58f1c22SToby Isaac + dm     - The DM object
8127c58f1c22SToby Isaac . name   - The label name
8128c58f1c22SToby Isaac - output - The flag for output
8129c58f1c22SToby Isaac 
8130c58f1c22SToby Isaac   Level: developer
8131c58f1c22SToby Isaac 
8132c58f1c22SToby Isaac .seealso: DMGetLabelOutput(), DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
8133c58f1c22SToby Isaac @*/
8134c58f1c22SToby Isaac PetscErrorCode DMSetLabelOutput(DM dm, const char name[], PetscBool output)
8135c58f1c22SToby Isaac {
81365d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
8137d67d17b1SMatthew G. Knepley   const char    *lname;
8138c58f1c22SToby Isaac   PetscErrorCode ierr;
8139c58f1c22SToby Isaac 
8140c58f1c22SToby Isaac   PetscFunctionBegin;
8141c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8142534a8f05SLisandro Dalcin   PetscValidCharPointer(name, 2);
8143c58f1c22SToby Isaac   while (next) {
8144c58f1c22SToby Isaac     PetscBool flg;
8145c58f1c22SToby Isaac 
8146d67d17b1SMatthew G. Knepley     ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr);
8147d67d17b1SMatthew G. Knepley     ierr = PetscStrcmp(name, lname, &flg);CHKERRQ(ierr);
8148c58f1c22SToby Isaac     if (flg) {next->output = output; PetscFunctionReturn(0);}
8149c58f1c22SToby Isaac     next = next->next;
8150c58f1c22SToby Isaac   }
8151c58f1c22SToby Isaac   SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "No label named %s was present in this dm", name);
8152c58f1c22SToby Isaac }
8153c58f1c22SToby Isaac 
8154c58f1c22SToby Isaac /*@
8155c58f1c22SToby Isaac   DMCopyLabels - Copy labels from one mesh to another with a superset of the points
8156c58f1c22SToby Isaac 
8157d083f849SBarry Smith   Collective on dmA
8158c58f1c22SToby Isaac 
8159d8d19677SJose E. Roman   Input Parameters:
81605d80c0bfSVaclav Hapla + dmA - The DM object with initial labels
81612e17dfb7SMatthew G. Knepley . dmB - The DM object with copied labels
81625d80c0bfSVaclav Hapla . mode - Copy labels by pointers (PETSC_OWN_POINTER) or duplicate them (PETSC_COPY_VALUES)
8163ba2698f1SMatthew G. Knepley - all  - Copy all labels including "depth", "dim", and "celltype" (PETSC_TRUE) which are otherwise ignored (PETSC_FALSE)
8164c58f1c22SToby Isaac 
8165c58f1c22SToby Isaac   Level: intermediate
8166c58f1c22SToby Isaac 
8167c58f1c22SToby Isaac   Note: This is typically used when interpolating or otherwise adding to a mesh
8168c58f1c22SToby Isaac 
81695d80c0bfSVaclav Hapla .seealso: DMGetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM(), DMGetCoordinateSection(), DMShareLabels()
8170c58f1c22SToby Isaac @*/
81715d80c0bfSVaclav Hapla PetscErrorCode DMCopyLabels(DM dmA, DM dmB, PetscCopyMode mode, PetscBool all)
8172c58f1c22SToby Isaac {
8173c58f1c22SToby Isaac   DMLabel        label, labelNew;
8174c58f1c22SToby Isaac   const char    *name;
8175c58f1c22SToby Isaac   PetscBool      flg;
81765d80c0bfSVaclav Hapla   DMLabelLink    link;
81775d80c0bfSVaclav Hapla   PetscErrorCode ierr;
8178c58f1c22SToby Isaac 
81795d80c0bfSVaclav Hapla   PetscFunctionBegin;
81805d80c0bfSVaclav Hapla   PetscValidHeaderSpecific(dmA, DM_CLASSID, 1);
81815d80c0bfSVaclav Hapla   PetscValidHeaderSpecific(dmB, DM_CLASSID, 2);
81825d80c0bfSVaclav Hapla   PetscValidLogicalCollectiveEnum(dmA, mode,3);
81835d80c0bfSVaclav Hapla   PetscValidLogicalCollectiveBool(dmA, all, 4);
81845d80c0bfSVaclav Hapla   if (mode==PETSC_USE_POINTER) SETERRQ(PetscObjectComm((PetscObject)dmA), PETSC_ERR_SUP, "PETSC_USE_POINTER not supported for objects");
81855d80c0bfSVaclav Hapla   if (dmA == dmB) PetscFunctionReturn(0);
81865d80c0bfSVaclav Hapla   for (link=dmA->labels; link; link=link->next) {
81875d80c0bfSVaclav Hapla     label=link->label;
81885d80c0bfSVaclav Hapla     ierr = PetscObjectGetName((PetscObject)label, &name);CHKERRQ(ierr);
81895d80c0bfSVaclav Hapla     if (!all) {
8190c58f1c22SToby Isaac       ierr = PetscStrcmp(name, "depth", &flg);CHKERRQ(ierr);
8191c58f1c22SToby Isaac       if (flg) continue;
81927d5acc75SStefano Zampini       ierr = PetscStrcmp(name, "dim", &flg);CHKERRQ(ierr);
81937d5acc75SStefano Zampini       if (flg) continue;
8194ba2698f1SMatthew G. Knepley       ierr = PetscStrcmp(name, "celltype", &flg);CHKERRQ(ierr);
8195ba2698f1SMatthew G. Knepley       if (flg) continue;
81965d80c0bfSVaclav Hapla     }
81975d80c0bfSVaclav Hapla     if (mode==PETSC_COPY_VALUES) {
8198c58f1c22SToby Isaac       ierr = DMLabelDuplicate(label, &labelNew);CHKERRQ(ierr);
81995d80c0bfSVaclav Hapla     } else {
82005d80c0bfSVaclav Hapla       labelNew = label;
82015d80c0bfSVaclav Hapla     }
8202c58f1c22SToby Isaac     ierr = DMAddLabel(dmB, labelNew);CHKERRQ(ierr);
82035d80c0bfSVaclav Hapla     if (mode==PETSC_COPY_VALUES) {ierr = DMLabelDestroy(&labelNew);CHKERRQ(ierr);}
8204c58f1c22SToby Isaac   }
8205c58f1c22SToby Isaac   PetscFunctionReturn(0);
8206c58f1c22SToby Isaac }
8207461a15a0SLisandro Dalcin 
8208*609dae6eSVaclav Hapla /*@C
8209*609dae6eSVaclav Hapla   DMCompareLabels - Compare labels of two DMPlex meshes
8210*609dae6eSVaclav Hapla 
8211*609dae6eSVaclav Hapla   Collective on dmA
8212*609dae6eSVaclav Hapla 
8213*609dae6eSVaclav Hapla   Input Parameters:
8214*609dae6eSVaclav Hapla + dm0 - First DM object
8215*609dae6eSVaclav Hapla - dm1 - Second DM object
8216*609dae6eSVaclav Hapla 
8217*609dae6eSVaclav Hapla   Output Parameters
8218*609dae6eSVaclav Hapla + same    - (Optional) Flag whether labels of dm0 and dm1 are the same
8219*609dae6eSVaclav Hapla - message - (Optional) Message describing the difference, or NULL if there is no difference
8220*609dae6eSVaclav Hapla 
8221*609dae6eSVaclav Hapla   Level: intermediate
8222*609dae6eSVaclav Hapla 
8223*609dae6eSVaclav Hapla   Notes:
8224*609dae6eSVaclav Hapla   If both same and message is passed as NULL, and difference is found, an error is thrown with a message describing the difference.
8225*609dae6eSVaclav Hapla 
8226*609dae6eSVaclav Hapla   Message must be freed by user.
8227*609dae6eSVaclav Hapla 
8228*609dae6eSVaclav Hapla   Labels are matched by name. If the number of labels and their names are equal,
8229*609dae6eSVaclav Hapla   DMLabelCompare() is used to compare each pair of labels with the same name.
8230*609dae6eSVaclav Hapla 
8231*609dae6eSVaclav Hapla   Fortran Notes:
8232*609dae6eSVaclav Hapla   This function is currently not available from Fortran.
8233*609dae6eSVaclav Hapla 
8234*609dae6eSVaclav Hapla .seealso: DMAddLabel(), DMCopyLabelsMode, DMLabelCompare()
8235*609dae6eSVaclav Hapla @*/
8236*609dae6eSVaclav Hapla PetscErrorCode DMCompareLabels(DM dm0, DM dm1, PetscBool *same, char **message)
8237*609dae6eSVaclav Hapla {
8238*609dae6eSVaclav Hapla   PetscInt        n0, n1, i;
8239*609dae6eSVaclav Hapla   char            msg[PETSC_MAX_PATH_LEN] = "";
8240*609dae6eSVaclav Hapla   MPI_Comm        comm;
8241*609dae6eSVaclav Hapla   PetscErrorCode  ierr;
8242*609dae6eSVaclav Hapla 
8243*609dae6eSVaclav Hapla   PetscFunctionBegin;
8244*609dae6eSVaclav Hapla   PetscValidHeaderSpecific(dm0,DM_CLASSID,1);
8245*609dae6eSVaclav Hapla   PetscValidHeaderSpecific(dm1,DM_CLASSID,2);
8246*609dae6eSVaclav Hapla   PetscCheckSameComm(dm0,1,dm1,2);
8247*609dae6eSVaclav Hapla   if (same) PetscValidBoolPointer(same,3);
8248*609dae6eSVaclav Hapla   if (message) PetscValidPointer(message, 4);
8249*609dae6eSVaclav Hapla   ierr = PetscObjectGetComm((PetscObject)dm0, &comm);CHKERRQ(ierr);
8250*609dae6eSVaclav Hapla   ierr = DMGetNumLabels(dm0, &n0);CHKERRQ(ierr);
8251*609dae6eSVaclav Hapla   ierr = DMGetNumLabels(dm1, &n1);CHKERRQ(ierr);
8252*609dae6eSVaclav Hapla   if (n0 != n1) {
8253*609dae6eSVaclav Hapla     ierr = PetscSNPrintf(msg, sizeof(msg), "Number of labels in dm0 = %D != %D = Number of labels in dm1", n0, n1);CHKERRQ(ierr);
8254*609dae6eSVaclav Hapla     goto finish;
8255*609dae6eSVaclav Hapla   }
8256*609dae6eSVaclav Hapla   for (i=0; i<n0; i++) {
8257*609dae6eSVaclav Hapla     DMLabel     l0, l1;
8258*609dae6eSVaclav Hapla     const char *name;
8259*609dae6eSVaclav Hapla     char       *msgInner;
8260*609dae6eSVaclav Hapla 
8261*609dae6eSVaclav Hapla     /* Ignore label order */
8262*609dae6eSVaclav Hapla     ierr = DMGetLabelByNum(dm0, i, &l0);CHKERRQ(ierr);
8263*609dae6eSVaclav Hapla     ierr = PetscObjectGetName((PetscObject)l0, &name);CHKERRQ(ierr);
8264*609dae6eSVaclav Hapla     ierr = DMGetLabel(dm1, name, &l1);CHKERRQ(ierr);
8265*609dae6eSVaclav Hapla     if (!l1) {
8266*609dae6eSVaclav Hapla       ierr = PetscSNPrintf(msg, sizeof(msg), "Label \"%s\" (#%D in dm0) not found in dm1", name, i);CHKERRQ(ierr);
8267*609dae6eSVaclav Hapla       goto finish;
8268*609dae6eSVaclav Hapla     }
8269*609dae6eSVaclav Hapla     ierr = DMLabelCompare(l0, l1, NULL, &msgInner);CHKERRQ(ierr);
8270*609dae6eSVaclav Hapla     ierr = PetscStrncpy(msg, msgInner, sizeof(msg));CHKERRQ(ierr);
8271*609dae6eSVaclav Hapla     ierr = PetscFree(msgInner);CHKERRQ(ierr);
8272*609dae6eSVaclav Hapla     if (msg[0]) goto finish;
8273*609dae6eSVaclav Hapla   }
8274*609dae6eSVaclav Hapla finish:
8275*609dae6eSVaclav Hapla   if (msg[0] && !same && !message) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_INCOMP, msg);
8276*609dae6eSVaclav Hapla   if (same) *same = (PetscBool) !msg[0];
8277*609dae6eSVaclav Hapla   if (message) {
8278*609dae6eSVaclav Hapla     *message = NULL;
8279*609dae6eSVaclav Hapla     if (msg[0]) {
8280*609dae6eSVaclav Hapla       ierr = PetscStrallocpy(msg, message);CHKERRQ(ierr);
8281*609dae6eSVaclav Hapla     }
8282*609dae6eSVaclav Hapla   }
8283*609dae6eSVaclav Hapla   PetscFunctionReturn(0);
8284*609dae6eSVaclav Hapla }
8285*609dae6eSVaclav Hapla 
8286461a15a0SLisandro Dalcin PetscErrorCode DMSetLabelValue_Fast(DM dm, DMLabel *label, const char name[], PetscInt point, PetscInt value)
8287461a15a0SLisandro Dalcin {
8288461a15a0SLisandro Dalcin   PetscErrorCode ierr;
8289*609dae6eSVaclav Hapla 
8290461a15a0SLisandro Dalcin   PetscFunctionBegin;
8291461a15a0SLisandro Dalcin   PetscValidPointer(label,2);
8292461a15a0SLisandro Dalcin   if (!*label) {
8293461a15a0SLisandro Dalcin     ierr = DMCreateLabel(dm, name);CHKERRQ(ierr);
8294461a15a0SLisandro Dalcin     ierr = DMGetLabel(dm, name, label);CHKERRQ(ierr);
8295461a15a0SLisandro Dalcin   }
8296461a15a0SLisandro Dalcin   ierr = DMLabelSetValue(*label, point, value);CHKERRQ(ierr);
8297461a15a0SLisandro Dalcin   PetscFunctionReturn(0);
8298461a15a0SLisandro Dalcin }
8299461a15a0SLisandro Dalcin 
83000fdc7489SMatthew Knepley /*
83010fdc7489SMatthew Knepley   Many mesh programs, such as Triangle and TetGen, allow only a single label for each mesh point. Therefore, we would
83020fdc7489SMatthew Knepley   like to encode all label IDs using a single, universal label. We can do this by assigning an integer to every
83030fdc7489SMatthew Knepley   (label, id) pair in the DM.
83040fdc7489SMatthew Knepley 
83050fdc7489SMatthew Knepley   However, a mesh point can have multiple labels, so we must separate all these values. We will assign a bit range to
83060fdc7489SMatthew Knepley   each label.
83070fdc7489SMatthew Knepley */
83080fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelCreate(DM dm, DMUniversalLabel *universal)
83090fdc7489SMatthew Knepley {
83100fdc7489SMatthew Knepley   DMUniversalLabel ul;
83110fdc7489SMatthew Knepley   PetscBool       *active;
83120fdc7489SMatthew Knepley   PetscInt         pStart, pEnd, p, Nl, l, m;
83130fdc7489SMatthew Knepley   PetscErrorCode   ierr;
83140fdc7489SMatthew Knepley 
83150fdc7489SMatthew Knepley   PetscFunctionBegin;
83160fdc7489SMatthew Knepley   ierr = PetscMalloc1(1, &ul);CHKERRQ(ierr);
83170fdc7489SMatthew Knepley   ierr = DMLabelCreate(PETSC_COMM_SELF, "universal", &ul->label);CHKERRQ(ierr);
83180fdc7489SMatthew Knepley   ierr = DMGetNumLabels(dm, &Nl);CHKERRQ(ierr);
83190fdc7489SMatthew Knepley   ierr = PetscCalloc1(Nl, &active);CHKERRQ(ierr);
83200fdc7489SMatthew Knepley   ul->Nl = 0;
83210fdc7489SMatthew Knepley   for (l = 0; l < Nl; ++l) {
83220fdc7489SMatthew Knepley     PetscBool   isdepth, iscelltype;
83230fdc7489SMatthew Knepley     const char *name;
83240fdc7489SMatthew Knepley 
83250fdc7489SMatthew Knepley     ierr = DMGetLabelName(dm, l, &name);CHKERRQ(ierr);
83260fdc7489SMatthew Knepley     ierr = PetscStrncmp(name, "depth", 6, &isdepth);CHKERRQ(ierr);
83270fdc7489SMatthew Knepley     ierr = PetscStrncmp(name, "celltype", 9, &iscelltype);CHKERRQ(ierr);
83280fdc7489SMatthew Knepley     active[l] = !(isdepth || iscelltype) ? PETSC_TRUE : PETSC_FALSE;
83290fdc7489SMatthew Knepley     if (active[l]) ++ul->Nl;
83300fdc7489SMatthew Knepley   }
83310fdc7489SMatthew Knepley   ierr = PetscCalloc5(ul->Nl, &ul->names, ul->Nl, &ul->indices, ul->Nl+1, &ul->offsets, ul->Nl+1, &ul->bits, ul->Nl, &ul->masks);CHKERRQ(ierr);
83320fdc7489SMatthew Knepley   ul->Nv = 0;
83330fdc7489SMatthew Knepley   for (l = 0, m = 0; l < Nl; ++l) {
83340fdc7489SMatthew Knepley     DMLabel     label;
83350fdc7489SMatthew Knepley     PetscInt    nv;
83360fdc7489SMatthew Knepley     const char *name;
83370fdc7489SMatthew Knepley 
83380fdc7489SMatthew Knepley     if (!active[l]) continue;
83390fdc7489SMatthew Knepley     ierr = DMGetLabelName(dm, l, &name);CHKERRQ(ierr);
83400fdc7489SMatthew Knepley     ierr = DMGetLabelByNum(dm, l, &label);CHKERRQ(ierr);
83410fdc7489SMatthew Knepley     ierr = DMLabelGetNumValues(label, &nv);CHKERRQ(ierr);
83420fdc7489SMatthew Knepley     ierr = PetscStrallocpy(name, &ul->names[m]);CHKERRQ(ierr);
83430fdc7489SMatthew Knepley     ul->indices[m]   = l;
83440fdc7489SMatthew Knepley     ul->Nv          += nv;
83450fdc7489SMatthew Knepley     ul->offsets[m+1] = nv;
83460fdc7489SMatthew Knepley     ul->bits[m+1]    = PetscCeilReal(PetscLog2Real(nv+1));
83470fdc7489SMatthew Knepley     ++m;
83480fdc7489SMatthew Knepley   }
83490fdc7489SMatthew Knepley   for (l = 1; l <= ul->Nl; ++l) {
83500fdc7489SMatthew Knepley     ul->offsets[l] = ul->offsets[l-1] + ul->offsets[l];
83510fdc7489SMatthew Knepley     ul->bits[l]    = ul->bits[l-1]    + ul->bits[l];
83520fdc7489SMatthew Knepley   }
83530fdc7489SMatthew Knepley   for (l = 0; l < ul->Nl; ++l) {
83540fdc7489SMatthew Knepley     PetscInt b;
83550fdc7489SMatthew Knepley 
83560fdc7489SMatthew Knepley     ul->masks[l] = 0;
83570fdc7489SMatthew Knepley     for (b = ul->bits[l]; b < ul->bits[l+1]; ++b) ul->masks[l] |= 1 << b;
83580fdc7489SMatthew Knepley   }
83590fdc7489SMatthew Knepley   ierr = PetscMalloc1(ul->Nv, &ul->values);CHKERRQ(ierr);
83600fdc7489SMatthew Knepley   for (l = 0, m = 0; l < Nl; ++l) {
83610fdc7489SMatthew Knepley     DMLabel         label;
83620fdc7489SMatthew Knepley     IS              valueIS;
83630fdc7489SMatthew Knepley     const PetscInt *varr;
83640fdc7489SMatthew Knepley     PetscInt        nv, v;
83650fdc7489SMatthew Knepley 
83660fdc7489SMatthew Knepley     if (!active[l]) continue;
83670fdc7489SMatthew Knepley     ierr = DMGetLabelByNum(dm, l, &label);CHKERRQ(ierr);
83680fdc7489SMatthew Knepley     ierr = DMLabelGetNumValues(label, &nv);CHKERRQ(ierr);
83690fdc7489SMatthew Knepley     ierr = DMLabelGetValueIS(label, &valueIS);CHKERRQ(ierr);
83700fdc7489SMatthew Knepley     ierr = ISGetIndices(valueIS, &varr);CHKERRQ(ierr);
83710fdc7489SMatthew Knepley     for (v = 0; v < nv; ++v) {
83720fdc7489SMatthew Knepley       ul->values[ul->offsets[m]+v] = varr[v];
83730fdc7489SMatthew Knepley     }
83740fdc7489SMatthew Knepley     ierr = ISRestoreIndices(valueIS, &varr);CHKERRQ(ierr);
83750fdc7489SMatthew Knepley     ierr = ISDestroy(&valueIS);CHKERRQ(ierr);
83760fdc7489SMatthew Knepley     ierr = PetscSortInt(nv, &ul->values[ul->offsets[m]]);CHKERRQ(ierr);
83770fdc7489SMatthew Knepley     ++m;
83780fdc7489SMatthew Knepley   }
83790fdc7489SMatthew Knepley   ierr = DMPlexGetChart(dm, &pStart, &pEnd);CHKERRQ(ierr);
83800fdc7489SMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
83810fdc7489SMatthew Knepley     PetscInt  uval = 0;
83820fdc7489SMatthew Knepley     PetscBool marked = PETSC_FALSE;
83830fdc7489SMatthew Knepley 
83840fdc7489SMatthew Knepley     for (l = 0, m = 0; l < Nl; ++l) {
83850fdc7489SMatthew Knepley       DMLabel  label;
83860649b39aSStefano Zampini       PetscInt val, defval, loc, nv;
83870fdc7489SMatthew Knepley 
83880fdc7489SMatthew Knepley       if (!active[l]) continue;
83890fdc7489SMatthew Knepley       ierr = DMGetLabelByNum(dm, l, &label);CHKERRQ(ierr);
83900fdc7489SMatthew Knepley       ierr = DMLabelGetValue(label, p, &val);CHKERRQ(ierr);
83910fdc7489SMatthew Knepley       ierr = DMLabelGetDefaultValue(label, &defval);CHKERRQ(ierr);
83920fdc7489SMatthew Knepley       if (val == defval) {++m; continue;}
83930649b39aSStefano Zampini       nv = ul->offsets[m+1]-ul->offsets[m];
83940fdc7489SMatthew Knepley       marked = PETSC_TRUE;
83950fdc7489SMatthew Knepley       ierr = PetscFindInt(val, nv, &ul->values[ul->offsets[m]], &loc);CHKERRQ(ierr);
83960fdc7489SMatthew Knepley       if (loc < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_PLIB, "Label value %D not found in compression array", val);
83970fdc7489SMatthew Knepley       uval += (loc+1) << ul->bits[m];
83980fdc7489SMatthew Knepley       ++m;
83990fdc7489SMatthew Knepley     }
84000fdc7489SMatthew Knepley     if (marked) {ierr = DMLabelSetValue(ul->label, p, uval);CHKERRQ(ierr);}
84010fdc7489SMatthew Knepley   }
84020fdc7489SMatthew Knepley   ierr = PetscFree(active);CHKERRQ(ierr);
84030fdc7489SMatthew Knepley   *universal = ul;
84040fdc7489SMatthew Knepley   PetscFunctionReturn(0);
84050fdc7489SMatthew Knepley }
84060fdc7489SMatthew Knepley 
84070fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelDestroy(DMUniversalLabel *universal)
84080fdc7489SMatthew Knepley {
84090fdc7489SMatthew Knepley   PetscInt       l;
84100fdc7489SMatthew Knepley   PetscErrorCode ierr;
84110fdc7489SMatthew Knepley 
84120fdc7489SMatthew Knepley   PetscFunctionBegin;
84130fdc7489SMatthew Knepley   for (l = 0; l < (*universal)->Nl; ++l) {ierr = PetscFree((*universal)->names[l]);CHKERRQ(ierr);}
84140fdc7489SMatthew Knepley   ierr = DMLabelDestroy(&(*universal)->label);CHKERRQ(ierr);
84150fdc7489SMatthew Knepley   ierr = PetscFree5((*universal)->names, (*universal)->indices, (*universal)->offsets, (*universal)->bits, (*universal)->masks);CHKERRQ(ierr);
84160fdc7489SMatthew Knepley   ierr = PetscFree((*universal)->values);CHKERRQ(ierr);
84170fdc7489SMatthew Knepley   ierr = PetscFree(*universal);CHKERRQ(ierr);
84180fdc7489SMatthew Knepley   *universal = NULL;
84190fdc7489SMatthew Knepley   PetscFunctionReturn(0);
84200fdc7489SMatthew Knepley }
84210fdc7489SMatthew Knepley 
84220fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelGetLabel(DMUniversalLabel ul, DMLabel *ulabel)
84230fdc7489SMatthew Knepley {
84240fdc7489SMatthew Knepley   PetscFunctionBegin;
84250fdc7489SMatthew Knepley   PetscValidPointer(ulabel, 2);
84260fdc7489SMatthew Knepley   *ulabel = ul->label;
84270fdc7489SMatthew Knepley   PetscFunctionReturn(0);
84280fdc7489SMatthew Knepley }
84290fdc7489SMatthew Knepley 
84300fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelCreateLabels(DMUniversalLabel ul, PetscBool preserveOrder, DM dm)
84310fdc7489SMatthew Knepley {
84320fdc7489SMatthew Knepley   PetscInt       Nl = ul->Nl, l;
84330fdc7489SMatthew Knepley   PetscErrorCode ierr;
84340fdc7489SMatthew Knepley 
84350fdc7489SMatthew Knepley   PetscFunctionBegin;
8436064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(dm, DM_CLASSID, 3);
84370fdc7489SMatthew Knepley   for (l = 0; l < Nl; ++l) {
84380fdc7489SMatthew Knepley     if (preserveOrder) {ierr = DMCreateLabelAtIndex(dm, ul->indices[l], ul->names[l]);CHKERRQ(ierr);}
84390fdc7489SMatthew Knepley     else               {ierr = DMCreateLabel(dm, ul->names[l]);CHKERRQ(ierr);}
84400fdc7489SMatthew Knepley   }
84410fdc7489SMatthew Knepley   if (preserveOrder) {
84420fdc7489SMatthew Knepley     for (l = 0; l < ul->Nl; ++l) {
84430fdc7489SMatthew Knepley       const char *name;
84440fdc7489SMatthew Knepley       PetscBool   match;
84450fdc7489SMatthew Knepley 
84460fdc7489SMatthew Knepley       ierr = DMGetLabelName(dm, ul->indices[l], &name);CHKERRQ(ierr);
84470fdc7489SMatthew Knepley       ierr = PetscStrcmp(name, ul->names[l], &match);CHKERRQ(ierr);
84480fdc7489SMatthew Knepley       if (!match) SETERRQ3(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_WRONG, "Label %D name %s does not match new name %s", l, name, ul->names[l]);
84490fdc7489SMatthew Knepley     }
84500fdc7489SMatthew Knepley   }
84510fdc7489SMatthew Knepley   PetscFunctionReturn(0);
84520fdc7489SMatthew Knepley }
84530fdc7489SMatthew Knepley 
84540fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelSetLabelValue(DMUniversalLabel ul, DM dm, PetscBool useIndex, PetscInt p, PetscInt value)
84550fdc7489SMatthew Knepley {
84560fdc7489SMatthew Knepley   PetscInt       l;
84570fdc7489SMatthew Knepley   PetscErrorCode ierr;
84580fdc7489SMatthew Knepley 
84590fdc7489SMatthew Knepley   PetscFunctionBegin;
84600fdc7489SMatthew Knepley   for (l = 0; l < ul->Nl; ++l) {
84610fdc7489SMatthew Knepley     DMLabel  label;
84620fdc7489SMatthew Knepley     PetscInt lval = (value & ul->masks[l]) >> ul->bits[l];
84630fdc7489SMatthew Knepley 
84640fdc7489SMatthew Knepley     if (lval) {
84650fdc7489SMatthew Knepley       if (useIndex) {ierr = DMGetLabelByNum(dm, ul->indices[l], &label);CHKERRQ(ierr);}
84660fdc7489SMatthew Knepley       else          {ierr = DMGetLabel(dm, ul->names[l], &label);CHKERRQ(ierr);}
84670fdc7489SMatthew Knepley       ierr = DMLabelSetValue(label, p, ul->values[ul->offsets[l]+lval-1]);CHKERRQ(ierr);
84680fdc7489SMatthew Knepley     }
84690fdc7489SMatthew Knepley   }
84700fdc7489SMatthew Knepley   PetscFunctionReturn(0);
84710fdc7489SMatthew Knepley }
8472a8fb8f29SToby Isaac 
8473a8fb8f29SToby Isaac /*@
8474a8fb8f29SToby Isaac   DMGetCoarseDM - Get the coarse mesh from which this was obtained by refinement
8475a8fb8f29SToby Isaac 
8476a8fb8f29SToby Isaac   Input Parameter:
8477a8fb8f29SToby Isaac . dm - The DM object
8478a8fb8f29SToby Isaac 
8479a8fb8f29SToby Isaac   Output Parameter:
8480a8fb8f29SToby Isaac . cdm - The coarse DM
8481a8fb8f29SToby Isaac 
8482a8fb8f29SToby Isaac   Level: intermediate
8483a8fb8f29SToby Isaac 
8484a8fb8f29SToby Isaac .seealso: DMSetCoarseDM()
8485a8fb8f29SToby Isaac @*/
8486a8fb8f29SToby Isaac PetscErrorCode DMGetCoarseDM(DM dm, DM *cdm)
8487a8fb8f29SToby Isaac {
8488a8fb8f29SToby Isaac   PetscFunctionBegin;
8489a8fb8f29SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8490a8fb8f29SToby Isaac   PetscValidPointer(cdm, 2);
8491a8fb8f29SToby Isaac   *cdm = dm->coarseMesh;
8492a8fb8f29SToby Isaac   PetscFunctionReturn(0);
8493a8fb8f29SToby Isaac }
8494a8fb8f29SToby Isaac 
8495a8fb8f29SToby Isaac /*@
8496a8fb8f29SToby Isaac   DMSetCoarseDM - Set the coarse mesh from which this was obtained by refinement
8497a8fb8f29SToby Isaac 
8498a8fb8f29SToby Isaac   Input Parameters:
8499a8fb8f29SToby Isaac + dm - The DM object
8500a8fb8f29SToby Isaac - cdm - The coarse DM
8501a8fb8f29SToby Isaac 
8502a8fb8f29SToby Isaac   Level: intermediate
8503a8fb8f29SToby Isaac 
8504a8fb8f29SToby Isaac .seealso: DMGetCoarseDM()
8505a8fb8f29SToby Isaac @*/
8506a8fb8f29SToby Isaac PetscErrorCode DMSetCoarseDM(DM dm, DM cdm)
8507a8fb8f29SToby Isaac {
8508a8fb8f29SToby Isaac   PetscErrorCode ierr;
8509a8fb8f29SToby Isaac 
8510a8fb8f29SToby Isaac   PetscFunctionBegin;
8511a8fb8f29SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8512a8fb8f29SToby Isaac   if (cdm) PetscValidHeaderSpecific(cdm, DM_CLASSID, 2);
8513a8fb8f29SToby Isaac   ierr = PetscObjectReference((PetscObject)cdm);CHKERRQ(ierr);
8514a8fb8f29SToby Isaac   ierr = DMDestroy(&dm->coarseMesh);CHKERRQ(ierr);
8515a8fb8f29SToby Isaac   dm->coarseMesh = cdm;
8516a8fb8f29SToby Isaac   PetscFunctionReturn(0);
8517a8fb8f29SToby Isaac }
8518a8fb8f29SToby Isaac 
851988bdff64SToby Isaac /*@
852088bdff64SToby Isaac   DMGetFineDM - Get the fine mesh from which this was obtained by refinement
852188bdff64SToby Isaac 
852288bdff64SToby Isaac   Input Parameter:
852388bdff64SToby Isaac . dm - The DM object
852488bdff64SToby Isaac 
852588bdff64SToby Isaac   Output Parameter:
852688bdff64SToby Isaac . fdm - The fine DM
852788bdff64SToby Isaac 
852888bdff64SToby Isaac   Level: intermediate
852988bdff64SToby Isaac 
853088bdff64SToby Isaac .seealso: DMSetFineDM()
853188bdff64SToby Isaac @*/
853288bdff64SToby Isaac PetscErrorCode DMGetFineDM(DM dm, DM *fdm)
853388bdff64SToby Isaac {
853488bdff64SToby Isaac   PetscFunctionBegin;
853588bdff64SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
853688bdff64SToby Isaac   PetscValidPointer(fdm, 2);
853788bdff64SToby Isaac   *fdm = dm->fineMesh;
853888bdff64SToby Isaac   PetscFunctionReturn(0);
853988bdff64SToby Isaac }
854088bdff64SToby Isaac 
854188bdff64SToby Isaac /*@
854288bdff64SToby Isaac   DMSetFineDM - Set the fine mesh from which this was obtained by refinement
854388bdff64SToby Isaac 
854488bdff64SToby Isaac   Input Parameters:
854588bdff64SToby Isaac + dm - The DM object
854688bdff64SToby Isaac - fdm - The fine DM
854788bdff64SToby Isaac 
854888bdff64SToby Isaac   Level: intermediate
854988bdff64SToby Isaac 
855088bdff64SToby Isaac .seealso: DMGetFineDM()
855188bdff64SToby Isaac @*/
855288bdff64SToby Isaac PetscErrorCode DMSetFineDM(DM dm, DM fdm)
855388bdff64SToby Isaac {
855488bdff64SToby Isaac   PetscErrorCode ierr;
855588bdff64SToby Isaac 
855688bdff64SToby Isaac   PetscFunctionBegin;
855788bdff64SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
855888bdff64SToby Isaac   if (fdm) PetscValidHeaderSpecific(fdm, DM_CLASSID, 2);
855988bdff64SToby Isaac   ierr = PetscObjectReference((PetscObject)fdm);CHKERRQ(ierr);
856088bdff64SToby Isaac   ierr = DMDestroy(&dm->fineMesh);CHKERRQ(ierr);
856188bdff64SToby Isaac   dm->fineMesh = fdm;
856288bdff64SToby Isaac   PetscFunctionReturn(0);
856388bdff64SToby Isaac }
856488bdff64SToby Isaac 
8565a6ba4734SToby Isaac /*=== DMBoundary code ===*/
8566a6ba4734SToby Isaac 
8567a6ba4734SToby Isaac /*@C
8568a6ba4734SToby Isaac   DMAddBoundary - Add a boundary condition to the model
8569a6ba4734SToby Isaac 
8570783e2ec8SMatthew G. Knepley   Collective on dm
8571783e2ec8SMatthew G. Knepley 
8572a6ba4734SToby Isaac   Input Parameters:
85734c258f51SMatthew G. Knepley + dm       - The DM, with a PetscDS that matches the problem being constrained
8574f971fd6bSMatthew G. Knepley . type     - The type of condition, e.g. DM_BC_ESSENTIAL_ANALYTIC/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann)
8575a6ba4734SToby Isaac . name     - The BC name
857645480ffeSMatthew G. Knepley . label    - The label defining constrained points
857745480ffeSMatthew G. Knepley . Nv       - The number of DMLabel values for constrained points
857845480ffeSMatthew G. Knepley . values   - An array of values for constrained points
8579a6ba4734SToby Isaac . field    - The field to constrain
858045480ffeSMatthew G. Knepley . Nc       - The number of constrained field components (0 will constrain all fields)
8581a6ba4734SToby Isaac . comps    - An array of constrained component numbers
8582a6ba4734SToby Isaac . bcFunc   - A pointwise function giving boundary values
858356cf3b9cSMatthew G. Knepley . bcFunc_t - A pointwise function giving the time deriative of the boundary values, or NULL
8584a6ba4734SToby Isaac - ctx      - An optional user context for bcFunc
8585a6ba4734SToby Isaac 
858645480ffeSMatthew G. Knepley   Output Parameter:
858745480ffeSMatthew G. Knepley . bd          - (Optional) Boundary number
858845480ffeSMatthew G. Knepley 
8589a6ba4734SToby Isaac   Options Database Keys:
8590a6ba4734SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids
8591a6ba4734SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components
8592a6ba4734SToby Isaac 
859356cf3b9cSMatthew G. Knepley   Note:
859456cf3b9cSMatthew 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:
859556cf3b9cSMatthew G. Knepley 
859656cf3b9cSMatthew G. Knepley $ bcFunc(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nc, PetscScalar bcval[])
859756cf3b9cSMatthew G. Knepley 
859856cf3b9cSMatthew G. Knepley   If the type is DM_BC_ESSENTIAL_FIELD or other _FIELD value, then the calling sequence is:
859956cf3b9cSMatthew G. Knepley 
860056cf3b9cSMatthew G. Knepley $ bcFunc(PetscInt dim, PetscInt Nf, PetscInt NfAux,
860156cf3b9cSMatthew G. Knepley $        const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
860256cf3b9cSMatthew G. Knepley $        const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
860356cf3b9cSMatthew G. Knepley $        PetscReal time, const PetscReal x[], PetscScalar bcval[])
860456cf3b9cSMatthew G. Knepley 
860556cf3b9cSMatthew G. Knepley + dim - the spatial dimension
860656cf3b9cSMatthew G. Knepley . Nf - the number of fields
860756cf3b9cSMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
860856cf3b9cSMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
860956cf3b9cSMatthew G. Knepley . u - each field evaluated at the current point
861056cf3b9cSMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
861156cf3b9cSMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
861256cf3b9cSMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
861356cf3b9cSMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
861456cf3b9cSMatthew G. Knepley . a - each auxiliary field evaluated at the current point
861556cf3b9cSMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
861656cf3b9cSMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
861756cf3b9cSMatthew G. Knepley . t - current time
861856cf3b9cSMatthew G. Knepley . x - coordinates of the current point
861956cf3b9cSMatthew G. Knepley . numConstants - number of constant parameters
862056cf3b9cSMatthew G. Knepley . constants - constant parameters
862156cf3b9cSMatthew G. Knepley - bcval - output values at the current point
862256cf3b9cSMatthew G. Knepley 
8623a6ba4734SToby Isaac   Level: developer
8624a6ba4734SToby Isaac 
862545480ffeSMatthew G. Knepley .seealso: DSGetBoundary(), PetscDSAddBoundary()
8626a6ba4734SToby Isaac @*/
862745480ffeSMatthew G. Knepley PetscErrorCode DMAddBoundary(DM dm, DMBoundaryConditionType type, const char name[], DMLabel label, PetscInt Nv, const PetscInt values[], PetscInt field, PetscInt Nc, const PetscInt comps[], void (*bcFunc)(void), void (*bcFunc_t)(void), void *ctx, PetscInt *bd)
8628a6ba4734SToby Isaac {
8629e5e52638SMatthew G. Knepley   PetscDS        ds;
8630a6ba4734SToby Isaac   PetscErrorCode ierr;
8631a6ba4734SToby Isaac 
8632a6ba4734SToby Isaac   PetscFunctionBegin;
8633a6ba4734SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8634783e2ec8SMatthew G. Knepley   PetscValidLogicalCollectiveEnum(dm, type, 2);
863545480ffeSMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 4);
863645480ffeSMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, Nv, 5);
863745480ffeSMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, field, 7);
863845480ffeSMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, Nc, 8);
8639e5e52638SMatthew G. Knepley   ierr = DMGetDS(dm, &ds);CHKERRQ(ierr);
864045480ffeSMatthew G. Knepley   ierr = DMCompleteBoundaryLabel_Internal(dm, ds, field, PETSC_MAX_INT, label);CHKERRQ(ierr);
864145480ffeSMatthew G. Knepley   ierr = PetscDSAddBoundary(ds, type, name, label, Nv, values, field, Nc, comps, bcFunc, bcFunc_t, ctx, bd);CHKERRQ(ierr);
8642a6ba4734SToby Isaac   PetscFunctionReturn(0);
8643a6ba4734SToby Isaac }
8644a6ba4734SToby Isaac 
864545480ffeSMatthew G. Knepley /* TODO Remove this since now the structures are the same */
8646e6f8dbb6SToby Isaac static PetscErrorCode DMPopulateBoundary(DM dm)
8647e6f8dbb6SToby Isaac {
8648e5e52638SMatthew G. Knepley   PetscDS        ds;
8649dff059c6SToby Isaac   DMBoundary    *lastnext;
8650e6f8dbb6SToby Isaac   DSBoundary     dsbound;
8651e6f8dbb6SToby Isaac   PetscErrorCode ierr;
8652e6f8dbb6SToby Isaac 
8653e6f8dbb6SToby Isaac   PetscFunctionBegin;
8654e5e52638SMatthew G. Knepley   ierr = DMGetDS(dm, &ds);CHKERRQ(ierr);
8655e5e52638SMatthew G. Knepley   dsbound = ds->boundary;
865647a1f5adSToby Isaac   if (dm->boundary) {
865747a1f5adSToby Isaac     DMBoundary next = dm->boundary;
865847a1f5adSToby Isaac 
865947a1f5adSToby Isaac     /* quick check to see if the PetscDS has changed */
866047a1f5adSToby Isaac     if (next->dsboundary == dsbound) PetscFunctionReturn(0);
866147a1f5adSToby Isaac     /* the PetscDS has changed: tear down and rebuild */
866247a1f5adSToby Isaac     while (next) {
866347a1f5adSToby Isaac       DMBoundary b = next;
866447a1f5adSToby Isaac 
866547a1f5adSToby Isaac       next = b->next;
866647a1f5adSToby Isaac       ierr = PetscFree(b);CHKERRQ(ierr);
8667a6ba4734SToby Isaac     }
866847a1f5adSToby Isaac     dm->boundary = NULL;
8669a6ba4734SToby Isaac   }
867047a1f5adSToby Isaac 
8671dff059c6SToby Isaac   lastnext = &(dm->boundary);
8672e6f8dbb6SToby Isaac   while (dsbound) {
8673e6f8dbb6SToby Isaac     DMBoundary dmbound;
8674e6f8dbb6SToby Isaac 
8675e6f8dbb6SToby Isaac     ierr = PetscNew(&dmbound);CHKERRQ(ierr);
8676e6f8dbb6SToby Isaac     dmbound->dsboundary = dsbound;
867745480ffeSMatthew G. Knepley     dmbound->label      = dsbound->label;
867847a1f5adSToby Isaac     /* push on the back instead of the front so that it is in the same order as in the PetscDS */
8679dff059c6SToby Isaac     *lastnext = dmbound;
8680dff059c6SToby Isaac     lastnext = &(dmbound->next);
8681dff059c6SToby Isaac     dsbound = dsbound->next;
8682a6ba4734SToby Isaac   }
8683a6ba4734SToby Isaac   PetscFunctionReturn(0);
8684a6ba4734SToby Isaac }
8685a6ba4734SToby Isaac 
8686a6ba4734SToby Isaac PetscErrorCode DMIsBoundaryPoint(DM dm, PetscInt point, PetscBool *isBd)
8687a6ba4734SToby Isaac {
8688b95f2879SToby Isaac   DMBoundary     b;
8689a6ba4734SToby Isaac   PetscErrorCode ierr;
8690a6ba4734SToby Isaac 
8691a6ba4734SToby Isaac   PetscFunctionBegin;
8692a6ba4734SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8693534a8f05SLisandro Dalcin   PetscValidBoolPointer(isBd, 3);
8694a6ba4734SToby Isaac   *isBd = PETSC_FALSE;
8695e6f8dbb6SToby Isaac   ierr = DMPopulateBoundary(dm);CHKERRQ(ierr);
8696b95f2879SToby Isaac   b = dm->boundary;
8697a6ba4734SToby Isaac   while (b && !(*isBd)) {
8698e6f8dbb6SToby Isaac     DMLabel    label = b->label;
8699e6f8dbb6SToby Isaac     DSBoundary dsb   = b->dsboundary;
8700a6ba4734SToby Isaac     PetscInt   i;
8701a6ba4734SToby Isaac 
870245480ffeSMatthew G. Knepley     if (label) {
870345480ffeSMatthew G. Knepley       for (i = 0; i < dsb->Nv && !(*isBd); ++i) {ierr = DMLabelStratumHasPoint(label, dsb->values[i], point, isBd);CHKERRQ(ierr);}
8704a6ba4734SToby Isaac     }
8705a6ba4734SToby Isaac     b = b->next;
8706a6ba4734SToby Isaac   }
8707a6ba4734SToby Isaac   PetscFunctionReturn(0);
8708a6ba4734SToby Isaac }
87094d6f44ffSToby Isaac 
87104d6f44ffSToby Isaac /*@C
8711a6e0b375SMatthew G. Knepley   DMProjectFunction - This projects the given function into the function space provided, putting the coefficients in a global vector.
8712a6e0b375SMatthew G. Knepley 
8713a6e0b375SMatthew G. Knepley   Collective on DM
87144d6f44ffSToby Isaac 
87154d6f44ffSToby Isaac   Input Parameters:
87164d6f44ffSToby Isaac + dm      - The DM
87170709b2feSToby Isaac . time    - The time
87184d6f44ffSToby Isaac . funcs   - The coordinate functions to evaluate, one per field
87194d6f44ffSToby Isaac . ctxs    - Optional array of contexts to pass to each coordinate function.  ctxs itself may be null.
87204d6f44ffSToby Isaac - mode    - The insertion mode for values
87214d6f44ffSToby Isaac 
87224d6f44ffSToby Isaac   Output Parameter:
87234d6f44ffSToby Isaac . X - vector
87244d6f44ffSToby Isaac 
87254d6f44ffSToby Isaac    Calling sequence of func:
87260709b2feSToby Isaac $    func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nf, PetscScalar u[], void *ctx);
87274d6f44ffSToby Isaac 
87284d6f44ffSToby Isaac +  dim - The spatial dimension
87298ec8862eSJed Brown .  time - The time at which to sample
87304d6f44ffSToby Isaac .  x   - The coordinates
87314d6f44ffSToby Isaac .  Nf  - The number of fields
87324d6f44ffSToby Isaac .  u   - The output field values
87334d6f44ffSToby Isaac -  ctx - optional user-defined function context
87344d6f44ffSToby Isaac 
87354d6f44ffSToby Isaac   Level: developer
87364d6f44ffSToby Isaac 
8737a6e0b375SMatthew G. Knepley .seealso: DMProjectFunctionLocal(), DMProjectFunctionLabel(), DMComputeL2Diff()
87384d6f44ffSToby Isaac @*/
87390709b2feSToby Isaac PetscErrorCode DMProjectFunction(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec X)
87404d6f44ffSToby Isaac {
87414d6f44ffSToby Isaac   Vec            localX;
87424d6f44ffSToby Isaac   PetscErrorCode ierr;
87434d6f44ffSToby Isaac 
87444d6f44ffSToby Isaac   PetscFunctionBegin;
87454d6f44ffSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
87464d6f44ffSToby Isaac   ierr = DMGetLocalVector(dm, &localX);CHKERRQ(ierr);
87470709b2feSToby Isaac   ierr = DMProjectFunctionLocal(dm, time, funcs, ctxs, mode, localX);CHKERRQ(ierr);
87484d6f44ffSToby Isaac   ierr = DMLocalToGlobalBegin(dm, localX, mode, X);CHKERRQ(ierr);
87494d6f44ffSToby Isaac   ierr = DMLocalToGlobalEnd(dm, localX, mode, X);CHKERRQ(ierr);
87504d6f44ffSToby Isaac   ierr = DMRestoreLocalVector(dm, &localX);CHKERRQ(ierr);
87514d6f44ffSToby Isaac   PetscFunctionReturn(0);
87524d6f44ffSToby Isaac }
87534d6f44ffSToby Isaac 
8754a6e0b375SMatthew G. Knepley /*@C
8755a6e0b375SMatthew G. Knepley   DMProjectFunctionLocal - This projects the given function into the function space provided, putting the coefficients in a local vector.
8756a6e0b375SMatthew G. Knepley 
8757a6e0b375SMatthew G. Knepley   Not collective
8758a6e0b375SMatthew G. Knepley 
8759a6e0b375SMatthew G. Knepley   Input Parameters:
8760a6e0b375SMatthew G. Knepley + dm      - The DM
8761a6e0b375SMatthew G. Knepley . time    - The time
8762a6e0b375SMatthew G. Knepley . funcs   - The coordinate functions to evaluate, one per field
8763a6e0b375SMatthew G. Knepley . ctxs    - Optional array of contexts to pass to each coordinate function.  ctxs itself may be null.
8764a6e0b375SMatthew G. Knepley - mode    - The insertion mode for values
8765a6e0b375SMatthew G. Knepley 
8766a6e0b375SMatthew G. Knepley   Output Parameter:
8767a6e0b375SMatthew G. Knepley . localX - vector
8768a6e0b375SMatthew G. Knepley 
8769a6e0b375SMatthew G. Knepley    Calling sequence of func:
8770a6e0b375SMatthew G. Knepley $    func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nf, PetscScalar u[], void *ctx);
8771a6e0b375SMatthew G. Knepley 
8772a6e0b375SMatthew G. Knepley +  dim - The spatial dimension
8773a6e0b375SMatthew G. Knepley .  x   - The coordinates
8774a6e0b375SMatthew G. Knepley .  Nf  - The number of fields
8775a6e0b375SMatthew G. Knepley .  u   - The output field values
8776a6e0b375SMatthew G. Knepley -  ctx - optional user-defined function context
8777a6e0b375SMatthew G. Knepley 
8778a6e0b375SMatthew G. Knepley   Level: developer
8779a6e0b375SMatthew G. Knepley 
8780a6e0b375SMatthew G. Knepley .seealso: DMProjectFunction(), DMProjectFunctionLabel(), DMComputeL2Diff()
8781a6e0b375SMatthew G. Knepley @*/
87820709b2feSToby Isaac PetscErrorCode DMProjectFunctionLocal(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec localX)
87834d6f44ffSToby Isaac {
87844d6f44ffSToby Isaac   PetscErrorCode ierr;
87854d6f44ffSToby Isaac 
87864d6f44ffSToby Isaac   PetscFunctionBegin;
87874d6f44ffSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
8788064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(localX,VEC_CLASSID,6);
87890918c465SMatthew G. Knepley   if (!dm->ops->projectfunctionlocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFunctionLocal",((PetscObject)dm)->type_name);
87900709b2feSToby Isaac   ierr = (dm->ops->projectfunctionlocal) (dm, time, funcs, ctxs, mode, localX);CHKERRQ(ierr);
87914d6f44ffSToby Isaac   PetscFunctionReturn(0);
87924d6f44ffSToby Isaac }
87934d6f44ffSToby Isaac 
8794a6e0b375SMatthew G. Knepley /*@C
8795a6e0b375SMatthew 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.
8796a6e0b375SMatthew G. Knepley 
8797a6e0b375SMatthew G. Knepley   Collective on DM
8798a6e0b375SMatthew G. Knepley 
8799a6e0b375SMatthew G. Knepley   Input Parameters:
8800a6e0b375SMatthew G. Knepley + dm      - The DM
8801a6e0b375SMatthew G. Knepley . time    - The time
8802a6e0b375SMatthew G. Knepley . label   - The DMLabel selecting the portion of the mesh for projection
8803a6e0b375SMatthew G. Knepley . funcs   - The coordinate functions to evaluate, one per field
8804a6e0b375SMatthew G. Knepley . ctxs    - Optional array of contexts to pass to each coordinate function.  ctxs itself may be null.
8805a6e0b375SMatthew G. Knepley - mode    - The insertion mode for values
8806a6e0b375SMatthew G. Knepley 
8807a6e0b375SMatthew G. Knepley   Output Parameter:
8808a6e0b375SMatthew G. Knepley . X - vector
8809a6e0b375SMatthew G. Knepley 
8810a6e0b375SMatthew G. Knepley    Calling sequence of func:
8811a6e0b375SMatthew G. Knepley $    func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nf, PetscScalar u[], void *ctx);
8812a6e0b375SMatthew G. Knepley 
8813a6e0b375SMatthew G. Knepley +  dim - The spatial dimension
8814a6e0b375SMatthew G. Knepley .  x   - The coordinates
8815a6e0b375SMatthew G. Knepley .  Nf  - The number of fields
8816a6e0b375SMatthew G. Knepley .  u   - The output field values
8817a6e0b375SMatthew G. Knepley -  ctx - optional user-defined function context
8818a6e0b375SMatthew G. Knepley 
8819a6e0b375SMatthew G. Knepley   Level: developer
8820a6e0b375SMatthew G. Knepley 
8821a6e0b375SMatthew G. Knepley .seealso: DMProjectFunction(), DMProjectFunctionLocal(), DMProjectFunctionLabelLocal(), DMComputeL2Diff()
8822a6e0b375SMatthew G. Knepley @*/
88232c53366bSMatthew 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)
88242c53366bSMatthew G. Knepley {
88252c53366bSMatthew G. Knepley   Vec            localX;
88262c53366bSMatthew G. Knepley   PetscErrorCode ierr;
88272c53366bSMatthew G. Knepley 
88282c53366bSMatthew G. Knepley   PetscFunctionBegin;
88292c53366bSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
88302c53366bSMatthew G. Knepley   ierr = DMGetLocalVector(dm, &localX);CHKERRQ(ierr);
88312c53366bSMatthew G. Knepley   ierr = DMProjectFunctionLabelLocal(dm, time, label, numIds, ids, Nc, comps, funcs, ctxs, mode, localX);CHKERRQ(ierr);
88322c53366bSMatthew G. Knepley   ierr = DMLocalToGlobalBegin(dm, localX, mode, X);CHKERRQ(ierr);
88332c53366bSMatthew G. Knepley   ierr = DMLocalToGlobalEnd(dm, localX, mode, X);CHKERRQ(ierr);
88342c53366bSMatthew G. Knepley   ierr = DMRestoreLocalVector(dm, &localX);CHKERRQ(ierr);
88352c53366bSMatthew G. Knepley   PetscFunctionReturn(0);
88362c53366bSMatthew G. Knepley }
88372c53366bSMatthew G. Knepley 
8838a6e0b375SMatthew G. Knepley /*@C
8839a6e0b375SMatthew 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.
8840a6e0b375SMatthew G. Knepley 
8841a6e0b375SMatthew G. Knepley   Not collective
8842a6e0b375SMatthew G. Knepley 
8843a6e0b375SMatthew G. Knepley   Input Parameters:
8844a6e0b375SMatthew G. Knepley + dm      - The DM
8845a6e0b375SMatthew G. Knepley . time    - The time
8846a6e0b375SMatthew G. Knepley . label   - The DMLabel selecting the portion of the mesh for projection
8847a6e0b375SMatthew G. Knepley . funcs   - The coordinate functions to evaluate, one per field
8848a6e0b375SMatthew G. Knepley . ctxs    - Optional array of contexts to pass to each coordinate function.  ctxs itself may be null.
8849a6e0b375SMatthew G. Knepley - mode    - The insertion mode for values
8850a6e0b375SMatthew G. Knepley 
8851a6e0b375SMatthew G. Knepley   Output Parameter:
8852a6e0b375SMatthew G. Knepley . localX - vector
8853a6e0b375SMatthew G. Knepley 
8854a6e0b375SMatthew G. Knepley    Calling sequence of func:
8855a6e0b375SMatthew G. Knepley $    func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nf, PetscScalar u[], void *ctx);
8856a6e0b375SMatthew G. Knepley 
8857a6e0b375SMatthew G. Knepley +  dim - The spatial dimension
8858a6e0b375SMatthew G. Knepley .  x   - The coordinates
8859a6e0b375SMatthew G. Knepley .  Nf  - The number of fields
8860a6e0b375SMatthew G. Knepley .  u   - The output field values
8861a6e0b375SMatthew G. Knepley -  ctx - optional user-defined function context
8862a6e0b375SMatthew G. Knepley 
8863a6e0b375SMatthew G. Knepley   Level: developer
8864a6e0b375SMatthew G. Knepley 
8865a6e0b375SMatthew G. Knepley .seealso: DMProjectFunction(), DMProjectFunctionLocal(), DMProjectFunctionLabel(), DMComputeL2Diff()
8866a6e0b375SMatthew G. Knepley @*/
88671c531cf8SMatthew 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)
88684d6f44ffSToby Isaac {
88694d6f44ffSToby Isaac   PetscErrorCode ierr;
88704d6f44ffSToby Isaac 
88714d6f44ffSToby Isaac   PetscFunctionBegin;
88724d6f44ffSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
8873064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(localX,VEC_CLASSID,11);
88740918c465SMatthew G. Knepley   if (!dm->ops->projectfunctionlabellocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFunctionLabelLocal",((PetscObject)dm)->type_name);
88751c531cf8SMatthew G. Knepley   ierr = (dm->ops->projectfunctionlabellocal) (dm, time, label, numIds, ids, Nc, comps, funcs, ctxs, mode, localX);CHKERRQ(ierr);
88764d6f44ffSToby Isaac   PetscFunctionReturn(0);
88774d6f44ffSToby Isaac }
88782716604bSToby Isaac 
8879a6e0b375SMatthew G. Knepley /*@C
8880a6e0b375SMatthew G. Knepley   DMProjectFieldLocal - This projects the given function of the input fields into the function space provided, putting the coefficients in a local vector.
8881a6e0b375SMatthew G. Knepley 
8882a6e0b375SMatthew G. Knepley   Not collective
8883a6e0b375SMatthew G. Knepley 
8884a6e0b375SMatthew G. Knepley   Input Parameters:
8885a6e0b375SMatthew G. Knepley + dm      - The DM
8886a6e0b375SMatthew G. Knepley . time    - The time
8887a6e0b375SMatthew G. Knepley . localU  - The input field vector
8888a6e0b375SMatthew G. Knepley . funcs   - The functions to evaluate, one per field
8889a6e0b375SMatthew G. Knepley - mode    - The insertion mode for values
8890a6e0b375SMatthew G. Knepley 
8891a6e0b375SMatthew G. Knepley   Output Parameter:
8892a6e0b375SMatthew G. Knepley . localX  - The output vector
8893a6e0b375SMatthew G. Knepley 
8894a6e0b375SMatthew G. Knepley    Calling sequence of func:
8895a6e0b375SMatthew G. Knepley $    func(PetscInt dim, PetscInt Nf, PetscInt NfAux,
8896a6e0b375SMatthew G. Knepley $         const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
8897a6e0b375SMatthew G. Knepley $         const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
8898a6e0b375SMatthew G. Knepley $         PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f[]);
8899a6e0b375SMatthew G. Knepley 
8900a6e0b375SMatthew G. Knepley +  dim          - The spatial dimension
8901a6e0b375SMatthew G. Knepley .  Nf           - The number of input fields
8902a6e0b375SMatthew G. Knepley .  NfAux        - The number of input auxiliary fields
8903a6e0b375SMatthew G. Knepley .  uOff         - The offset of each field in u[]
8904a6e0b375SMatthew G. Knepley .  uOff_x       - The offset of each field in u_x[]
8905a6e0b375SMatthew G. Knepley .  u            - The field values at this point in space
8906a6e0b375SMatthew G. Knepley .  u_t          - The field time derivative at this point in space (or NULL)
8907a6e0b375SMatthew G. Knepley .  u_x          - The field derivatives at this point in space
8908a6e0b375SMatthew G. Knepley .  aOff         - The offset of each auxiliary field in u[]
8909a6e0b375SMatthew G. Knepley .  aOff_x       - The offset of each auxiliary field in u_x[]
8910a6e0b375SMatthew G. Knepley .  a            - The auxiliary field values at this point in space
8911a6e0b375SMatthew G. Knepley .  a_t          - The auxiliary field time derivative at this point in space (or NULL)
8912a6e0b375SMatthew G. Knepley .  a_x          - The auxiliary field derivatives at this point in space
8913a6e0b375SMatthew G. Knepley .  t            - The current time
8914a6e0b375SMatthew G. Knepley .  x            - The coordinates of this point
8915a6e0b375SMatthew G. Knepley .  numConstants - The number of constants
8916a6e0b375SMatthew G. Knepley .  constants    - The value of each constant
8917a6e0b375SMatthew G. Knepley -  f            - The value of the function at this point in space
8918a6e0b375SMatthew G. Knepley 
8919a6e0b375SMatthew 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.
8920a6e0b375SMatthew 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
8921a6e0b375SMatthew 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
8922a6e0b375SMatthew 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.
8923a6e0b375SMatthew G. Knepley 
8924a6e0b375SMatthew G. Knepley   Level: intermediate
8925a6e0b375SMatthew G. Knepley 
8926a6e0b375SMatthew G. Knepley .seealso: DMProjectField(), DMProjectFieldLabelLocal(), DMProjectFunction(), DMComputeL2Diff()
8927a6e0b375SMatthew G. Knepley @*/
89288c6c5593SMatthew G. Knepley PetscErrorCode DMProjectFieldLocal(DM dm, PetscReal time, Vec localU,
89298c6c5593SMatthew G. Knepley                                    void (**funcs)(PetscInt, PetscInt, PetscInt,
89308c6c5593SMatthew G. Knepley                                                   const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
89318c6c5593SMatthew G. Knepley                                                   const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
8932191494d9SMatthew G. Knepley                                                   PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]),
89338c6c5593SMatthew G. Knepley                                    InsertMode mode, Vec localX)
89348c6c5593SMatthew G. Knepley {
89358c6c5593SMatthew G. Knepley   PetscErrorCode ierr;
89368c6c5593SMatthew G. Knepley 
89378c6c5593SMatthew G. Knepley   PetscFunctionBegin;
89388c6c5593SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
89398c6c5593SMatthew G. Knepley   PetscValidHeaderSpecific(localU,VEC_CLASSID,3);
89408c6c5593SMatthew G. Knepley   PetscValidHeaderSpecific(localX,VEC_CLASSID,6);
89410918c465SMatthew G. Knepley   if (!dm->ops->projectfieldlocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFieldLocal",((PetscObject)dm)->type_name);
89428c6c5593SMatthew G. Knepley   ierr = (dm->ops->projectfieldlocal) (dm, time, localU, funcs, mode, localX);CHKERRQ(ierr);
89438c6c5593SMatthew G. Knepley   PetscFunctionReturn(0);
89448c6c5593SMatthew G. Knepley }
89458c6c5593SMatthew G. Knepley 
8946a6e0b375SMatthew G. Knepley /*@C
8947a6e0b375SMatthew 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.
8948a6e0b375SMatthew G. Knepley 
8949a6e0b375SMatthew G. Knepley   Not collective
8950a6e0b375SMatthew G. Knepley 
8951a6e0b375SMatthew G. Knepley   Input Parameters:
8952a6e0b375SMatthew G. Knepley + dm      - The DM
8953a6e0b375SMatthew G. Knepley . time    - The time
8954a6e0b375SMatthew G. Knepley . label   - The DMLabel marking the portion of the domain to output
8955a6e0b375SMatthew G. Knepley . numIds  - The number of label ids to use
8956a6e0b375SMatthew G. Knepley . ids     - The label ids to use for marking
8957a6e0b375SMatthew G. Knepley . Nc      - The number of components to set in the output, or PETSC_DETERMINE for all components
8958a6e0b375SMatthew G. Knepley . comps   - The components to set in the output, or NULL for all components
8959a6e0b375SMatthew G. Knepley . localU  - The input field vector
8960a6e0b375SMatthew G. Knepley . funcs   - The functions to evaluate, one per field
8961a6e0b375SMatthew G. Knepley - mode    - The insertion mode for values
8962a6e0b375SMatthew G. Knepley 
8963a6e0b375SMatthew G. Knepley   Output Parameter:
8964a6e0b375SMatthew G. Knepley . localX  - The output vector
8965a6e0b375SMatthew G. Knepley 
8966a6e0b375SMatthew G. Knepley    Calling sequence of func:
8967a6e0b375SMatthew G. Knepley $    func(PetscInt dim, PetscInt Nf, PetscInt NfAux,
8968a6e0b375SMatthew G. Knepley $         const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
8969a6e0b375SMatthew G. Knepley $         const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
8970a6e0b375SMatthew G. Knepley $         PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f[]);
8971a6e0b375SMatthew G. Knepley 
8972a6e0b375SMatthew G. Knepley +  dim          - The spatial dimension
8973a6e0b375SMatthew G. Knepley .  Nf           - The number of input fields
8974a6e0b375SMatthew G. Knepley .  NfAux        - The number of input auxiliary fields
8975a6e0b375SMatthew G. Knepley .  uOff         - The offset of each field in u[]
8976a6e0b375SMatthew G. Knepley .  uOff_x       - The offset of each field in u_x[]
8977a6e0b375SMatthew G. Knepley .  u            - The field values at this point in space
8978a6e0b375SMatthew G. Knepley .  u_t          - The field time derivative at this point in space (or NULL)
8979a6e0b375SMatthew G. Knepley .  u_x          - The field derivatives at this point in space
8980a6e0b375SMatthew G. Knepley .  aOff         - The offset of each auxiliary field in u[]
8981a6e0b375SMatthew G. Knepley .  aOff_x       - The offset of each auxiliary field in u_x[]
8982a6e0b375SMatthew G. Knepley .  a            - The auxiliary field values at this point in space
8983a6e0b375SMatthew G. Knepley .  a_t          - The auxiliary field time derivative at this point in space (or NULL)
8984a6e0b375SMatthew G. Knepley .  a_x          - The auxiliary field derivatives at this point in space
8985a6e0b375SMatthew G. Knepley .  t            - The current time
8986a6e0b375SMatthew G. Knepley .  x            - The coordinates of this point
8987a6e0b375SMatthew G. Knepley .  numConstants - The number of constants
8988a6e0b375SMatthew G. Knepley .  constants    - The value of each constant
8989a6e0b375SMatthew G. Knepley -  f            - The value of the function at this point in space
8990a6e0b375SMatthew G. Knepley 
8991a6e0b375SMatthew 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.
8992a6e0b375SMatthew 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
8993a6e0b375SMatthew 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
8994a6e0b375SMatthew 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.
8995a6e0b375SMatthew G. Knepley 
8996a6e0b375SMatthew G. Knepley   Level: intermediate
8997a6e0b375SMatthew G. Knepley 
8998a6e0b375SMatthew G. Knepley .seealso: DMProjectField(), DMProjectFieldLabelLocal(), DMProjectFunction(), DMComputeL2Diff()
8999a6e0b375SMatthew G. Knepley @*/
90001c531cf8SMatthew G. Knepley PetscErrorCode DMProjectFieldLabelLocal(DM dm, PetscReal time, DMLabel label, PetscInt numIds, const PetscInt ids[], PetscInt Nc, const PetscInt comps[], Vec localU,
90018c6c5593SMatthew G. Knepley                                         void (**funcs)(PetscInt, PetscInt, PetscInt,
90028c6c5593SMatthew G. Knepley                                                        const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
90038c6c5593SMatthew G. Knepley                                                        const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
9004191494d9SMatthew G. Knepley                                                        PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]),
90058c6c5593SMatthew G. Knepley                                         InsertMode mode, Vec localX)
90068c6c5593SMatthew G. Knepley {
90078c6c5593SMatthew G. Knepley   PetscErrorCode ierr;
90088c6c5593SMatthew G. Knepley 
90098c6c5593SMatthew G. Knepley   PetscFunctionBegin;
90108c6c5593SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
9011064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(localU,VEC_CLASSID,8);
9012064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(localX,VEC_CLASSID,11);
9013ece3a9fcSMatthew G. Knepley   if (!dm->ops->projectfieldlabellocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFieldLabelLocal",((PetscObject)dm)->type_name);
90141c531cf8SMatthew G. Knepley   ierr = (dm->ops->projectfieldlabellocal)(dm, time, label, numIds, ids, Nc, comps, localU, funcs, mode, localX);CHKERRQ(ierr);
90158c6c5593SMatthew G. Knepley   PetscFunctionReturn(0);
90168c6c5593SMatthew G. Knepley }
90178c6c5593SMatthew G. Knepley 
90182716604bSToby Isaac /*@C
9019ece3a9fcSMatthew 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.
9020ece3a9fcSMatthew G. Knepley 
9021ece3a9fcSMatthew G. Knepley   Not collective
9022ece3a9fcSMatthew G. Knepley 
9023ece3a9fcSMatthew G. Knepley   Input Parameters:
9024ece3a9fcSMatthew G. Knepley + dm      - The DM
9025ece3a9fcSMatthew G. Knepley . time    - The time
9026ece3a9fcSMatthew G. Knepley . label   - The DMLabel marking the portion of the domain boundary to output
9027ece3a9fcSMatthew G. Knepley . numIds  - The number of label ids to use
9028ece3a9fcSMatthew G. Knepley . ids     - The label ids to use for marking
9029ece3a9fcSMatthew G. Knepley . Nc      - The number of components to set in the output, or PETSC_DETERMINE for all components
9030ece3a9fcSMatthew G. Knepley . comps   - The components to set in the output, or NULL for all components
9031ece3a9fcSMatthew G. Knepley . localU  - The input field vector
9032ece3a9fcSMatthew G. Knepley . funcs   - The functions to evaluate, one per field
9033ece3a9fcSMatthew G. Knepley - mode    - The insertion mode for values
9034ece3a9fcSMatthew G. Knepley 
9035ece3a9fcSMatthew G. Knepley   Output Parameter:
9036ece3a9fcSMatthew G. Knepley . localX  - The output vector
9037ece3a9fcSMatthew G. Knepley 
9038ece3a9fcSMatthew G. Knepley    Calling sequence of func:
9039ece3a9fcSMatthew G. Knepley $    func(PetscInt dim, PetscInt Nf, PetscInt NfAux,
9040ece3a9fcSMatthew G. Knepley $         const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
9041ece3a9fcSMatthew G. Knepley $         const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
9042ece3a9fcSMatthew G. Knepley $         PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f[]);
9043ece3a9fcSMatthew G. Knepley 
9044ece3a9fcSMatthew G. Knepley +  dim          - The spatial dimension
9045ece3a9fcSMatthew G. Knepley .  Nf           - The number of input fields
9046ece3a9fcSMatthew G. Knepley .  NfAux        - The number of input auxiliary fields
9047ece3a9fcSMatthew G. Knepley .  uOff         - The offset of each field in u[]
9048ece3a9fcSMatthew G. Knepley .  uOff_x       - The offset of each field in u_x[]
9049ece3a9fcSMatthew G. Knepley .  u            - The field values at this point in space
9050ece3a9fcSMatthew G. Knepley .  u_t          - The field time derivative at this point in space (or NULL)
9051ece3a9fcSMatthew G. Knepley .  u_x          - The field derivatives at this point in space
9052ece3a9fcSMatthew G. Knepley .  aOff         - The offset of each auxiliary field in u[]
9053ece3a9fcSMatthew G. Knepley .  aOff_x       - The offset of each auxiliary field in u_x[]
9054ece3a9fcSMatthew G. Knepley .  a            - The auxiliary field values at this point in space
9055ece3a9fcSMatthew G. Knepley .  a_t          - The auxiliary field time derivative at this point in space (or NULL)
9056ece3a9fcSMatthew G. Knepley .  a_x          - The auxiliary field derivatives at this point in space
9057ece3a9fcSMatthew G. Knepley .  t            - The current time
9058ece3a9fcSMatthew G. Knepley .  x            - The coordinates of this point
9059ece3a9fcSMatthew G. Knepley .  n            - The face normal
9060ece3a9fcSMatthew G. Knepley .  numConstants - The number of constants
9061ece3a9fcSMatthew G. Knepley .  constants    - The value of each constant
9062ece3a9fcSMatthew G. Knepley -  f            - The value of the function at this point in space
9063ece3a9fcSMatthew G. Knepley 
9064ece3a9fcSMatthew G. Knepley   Note:
9065ece3a9fcSMatthew 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.
9066ece3a9fcSMatthew 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
9067ece3a9fcSMatthew 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
9068ece3a9fcSMatthew 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.
9069ece3a9fcSMatthew G. Knepley 
9070ece3a9fcSMatthew G. Knepley   Level: intermediate
9071ece3a9fcSMatthew G. Knepley 
9072ece3a9fcSMatthew G. Knepley .seealso: DMProjectField(), DMProjectFieldLabelLocal(), DMProjectFunction(), DMComputeL2Diff()
9073ece3a9fcSMatthew G. Knepley @*/
9074ece3a9fcSMatthew G. Knepley PetscErrorCode DMProjectBdFieldLabelLocal(DM dm, PetscReal time, DMLabel label, PetscInt numIds, const PetscInt ids[], PetscInt Nc, const PetscInt comps[], Vec localU,
9075ece3a9fcSMatthew G. Knepley                                           void (**funcs)(PetscInt, PetscInt, PetscInt,
9076ece3a9fcSMatthew G. Knepley                                                          const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
9077ece3a9fcSMatthew G. Knepley                                                          const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
9078ece3a9fcSMatthew G. Knepley                                                          PetscReal, const PetscReal[], const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]),
9079ece3a9fcSMatthew G. Knepley                                           InsertMode mode, Vec localX)
9080ece3a9fcSMatthew G. Knepley {
9081ece3a9fcSMatthew G. Knepley   PetscErrorCode ierr;
9082ece3a9fcSMatthew G. Knepley 
9083ece3a9fcSMatthew G. Knepley   PetscFunctionBegin;
9084ece3a9fcSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
9085064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(localU,VEC_CLASSID,8);
9086064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(localX,VEC_CLASSID,11);
9087ece3a9fcSMatthew G. Knepley   if (!dm->ops->projectbdfieldlabellocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectBdFieldLabelLocal",((PetscObject)dm)->type_name);
9088ece3a9fcSMatthew G. Knepley   ierr = (dm->ops->projectbdfieldlabellocal)(dm, time, label, numIds, ids, Nc, comps, localU, funcs, mode, localX);CHKERRQ(ierr);
9089ece3a9fcSMatthew G. Knepley   PetscFunctionReturn(0);
9090ece3a9fcSMatthew G. Knepley }
9091ece3a9fcSMatthew G. Knepley 
9092ece3a9fcSMatthew G. Knepley /*@C
90932716604bSToby Isaac   DMComputeL2Diff - This function computes the L_2 difference between a function u and an FEM interpolant solution u_h.
90942716604bSToby Isaac 
90952716604bSToby Isaac   Input Parameters:
90962716604bSToby Isaac + dm    - The DM
90970709b2feSToby Isaac . time  - The time
90982716604bSToby Isaac . funcs - The functions to evaluate for each field component
90992716604bSToby Isaac . ctxs  - Optional array of contexts to pass to each function, or NULL.
9100574a98acSMatthew G. Knepley - X     - The coefficient vector u_h, a global vector
91012716604bSToby Isaac 
91022716604bSToby Isaac   Output Parameter:
91032716604bSToby Isaac . diff - The diff ||u - u_h||_2
91042716604bSToby Isaac 
91052716604bSToby Isaac   Level: developer
91062716604bSToby Isaac 
91071189c1efSToby Isaac .seealso: DMProjectFunction(), DMComputeL2FieldDiff(), DMComputeL2GradientDiff()
91082716604bSToby Isaac @*/
91090709b2feSToby Isaac PetscErrorCode DMComputeL2Diff(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, Vec X, PetscReal *diff)
91102716604bSToby Isaac {
91112716604bSToby Isaac   PetscErrorCode ierr;
91122716604bSToby Isaac 
91132716604bSToby Isaac   PetscFunctionBegin;
91142716604bSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
9115b698f381SToby Isaac   PetscValidHeaderSpecific(X,VEC_CLASSID,5);
91160918c465SMatthew G. Knepley   if (!dm->ops->computel2diff) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2Diff",((PetscObject)dm)->type_name);
91170709b2feSToby Isaac   ierr = (dm->ops->computel2diff)(dm,time,funcs,ctxs,X,diff);CHKERRQ(ierr);
91182716604bSToby Isaac   PetscFunctionReturn(0);
91192716604bSToby Isaac }
9120b698f381SToby Isaac 
9121b698f381SToby Isaac /*@C
9122b698f381SToby Isaac   DMComputeL2GradientDiff - This function computes the L_2 difference between the gradient of a function u and an FEM interpolant solution grad u_h.
9123b698f381SToby Isaac 
9124d083f849SBarry Smith   Collective on dm
9125d083f849SBarry Smith 
9126b698f381SToby Isaac   Input Parameters:
9127b698f381SToby Isaac + dm    - The DM
9128b698f381SToby Isaac , time  - The time
9129b698f381SToby Isaac . funcs - The gradient functions to evaluate for each field component
9130b698f381SToby Isaac . ctxs  - Optional array of contexts to pass to each function, or NULL.
9131574a98acSMatthew G. Knepley . X     - The coefficient vector u_h, a global vector
9132b698f381SToby Isaac - n     - The vector to project along
9133b698f381SToby Isaac 
9134b698f381SToby Isaac   Output Parameter:
9135b698f381SToby Isaac . diff - The diff ||(grad u - grad u_h) . n||_2
9136b698f381SToby Isaac 
9137b698f381SToby Isaac   Level: developer
9138b698f381SToby Isaac 
9139b698f381SToby Isaac .seealso: DMProjectFunction(), DMComputeL2Diff()
9140b698f381SToby Isaac @*/
9141b698f381SToby 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)
9142b698f381SToby Isaac {
9143b698f381SToby Isaac   PetscErrorCode ierr;
9144b698f381SToby Isaac 
9145b698f381SToby Isaac   PetscFunctionBegin;
9146b698f381SToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
9147b698f381SToby Isaac   PetscValidHeaderSpecific(X,VEC_CLASSID,5);
9148b698f381SToby Isaac   if (!dm->ops->computel2gradientdiff) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2GradientDiff",((PetscObject)dm)->type_name);
9149b698f381SToby Isaac   ierr = (dm->ops->computel2gradientdiff)(dm,time,funcs,ctxs,X,n,diff);CHKERRQ(ierr);
9150b698f381SToby Isaac   PetscFunctionReturn(0);
9151b698f381SToby Isaac }
9152b698f381SToby Isaac 
91532a16baeaSToby Isaac /*@C
91542a16baeaSToby Isaac   DMComputeL2FieldDiff - This function computes the L_2 difference between a function u and an FEM interpolant solution u_h, separated into field components.
91552a16baeaSToby Isaac 
9156d083f849SBarry Smith   Collective on dm
9157d083f849SBarry Smith 
91582a16baeaSToby Isaac   Input Parameters:
91592a16baeaSToby Isaac + dm    - The DM
91602a16baeaSToby Isaac . time  - The time
91612a16baeaSToby Isaac . funcs - The functions to evaluate for each field component
91622a16baeaSToby Isaac . ctxs  - Optional array of contexts to pass to each function, or NULL.
9163574a98acSMatthew G. Knepley - X     - The coefficient vector u_h, a global vector
91642a16baeaSToby Isaac 
91652a16baeaSToby Isaac   Output Parameter:
91662a16baeaSToby Isaac . diff - The array of differences, ||u^f - u^f_h||_2
91672a16baeaSToby Isaac 
91682a16baeaSToby Isaac   Level: developer
91692a16baeaSToby Isaac 
91701189c1efSToby Isaac .seealso: DMProjectFunction(), DMComputeL2FieldDiff(), DMComputeL2GradientDiff()
91712a16baeaSToby Isaac @*/
91721189c1efSToby Isaac PetscErrorCode DMComputeL2FieldDiff(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, Vec X, PetscReal diff[])
91732a16baeaSToby Isaac {
91742a16baeaSToby Isaac   PetscErrorCode ierr;
91752a16baeaSToby Isaac 
91762a16baeaSToby Isaac   PetscFunctionBegin;
91772a16baeaSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
91782a16baeaSToby Isaac   PetscValidHeaderSpecific(X,VEC_CLASSID,5);
91790918c465SMatthew G. Knepley   if (!dm->ops->computel2fielddiff) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2FieldDiff",((PetscObject)dm)->type_name);
91802a16baeaSToby Isaac   ierr = (dm->ops->computel2fielddiff)(dm,time,funcs,ctxs,X,diff);CHKERRQ(ierr);
91812a16baeaSToby Isaac   PetscFunctionReturn(0);
91822a16baeaSToby Isaac }
91832a16baeaSToby Isaac 
9184df0b854cSToby Isaac /*@C
9185df0b854cSToby Isaac   DMAdaptLabel - Adapt a dm based on a label with values interpreted as coarsening and refining flags.  Specific implementations of DM maybe have
9186cd3c525cSToby Isaac                  specialized flags, but all implementations should accept flag values DM_ADAPT_DETERMINE, DM_ADAPT_KEEP, DM_ADAPT_REFINE, and DM_ADAPT_COARSEN.
9187df0b854cSToby Isaac 
9188df0b854cSToby Isaac   Collective on dm
9189df0b854cSToby Isaac 
9190df0b854cSToby Isaac   Input parameters:
9191df0b854cSToby Isaac + dm - the pre-adaptation DM object
9192a1b0c543SToby Isaac - label - label with the flags
9193df0b854cSToby Isaac 
9194df0b854cSToby Isaac   Output parameters:
91950d1cd5e0SMatthew G. Knepley . dmAdapt - the adapted DM object: may be NULL if an adapted DM could not be produced.
9196df0b854cSToby Isaac 
9197df0b854cSToby Isaac   Level: intermediate
91980d1cd5e0SMatthew G. Knepley 
91990d1cd5e0SMatthew G. Knepley .seealso: DMAdaptMetric(), DMCoarsen(), DMRefine()
9200df0b854cSToby Isaac @*/
92010d1cd5e0SMatthew G. Knepley PetscErrorCode DMAdaptLabel(DM dm, DMLabel label, DM *dmAdapt)
9202df0b854cSToby Isaac {
9203df0b854cSToby Isaac   PetscErrorCode ierr;
9204df0b854cSToby Isaac 
9205df0b854cSToby Isaac   PetscFunctionBegin;
9206df0b854cSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
9207a1b0c543SToby Isaac   PetscValidPointer(label,2);
92080d1cd5e0SMatthew G. Knepley   PetscValidPointer(dmAdapt,3);
92090d1cd5e0SMatthew G. Knepley   *dmAdapt = NULL;
92106f25b0d8SLisandro Dalcin   if (!dm->ops->adaptlabel) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMAdaptLabel",((PetscObject)dm)->type_name);
92110d1cd5e0SMatthew G. Knepley   ierr = (dm->ops->adaptlabel)(dm, label, dmAdapt);CHKERRQ(ierr);
9212a587d139SMark   if (*dmAdapt) {
9213a587d139SMark     (*dmAdapt)->prealloc_only = dm->prealloc_only;  /* maybe this should go .... */
9214a587d139SMark     ierr = PetscFree((*dmAdapt)->vectype);CHKERRQ(ierr);
9215a587d139SMark     ierr = PetscStrallocpy(dm->vectype,(char**)&(*dmAdapt)->vectype);CHKERRQ(ierr);
9216a587d139SMark     ierr = PetscFree((*dmAdapt)->mattype);CHKERRQ(ierr);
9217a587d139SMark     ierr = PetscStrallocpy(dm->mattype,(char**)&(*dmAdapt)->mattype);CHKERRQ(ierr);
9218a587d139SMark   }
92190d1cd5e0SMatthew G. Knepley   PetscFunctionReturn(0);
92200d1cd5e0SMatthew G. Knepley }
92210d1cd5e0SMatthew G. Knepley 
92220d1cd5e0SMatthew G. Knepley /*@C
92230d1cd5e0SMatthew G. Knepley   DMAdaptMetric - Generates a mesh adapted to the specified metric field using the pragmatic library.
92240d1cd5e0SMatthew G. Knepley 
92250d1cd5e0SMatthew G. Knepley   Input Parameters:
92260d1cd5e0SMatthew G. Knepley + dm - The DM object
92270d1cd5e0SMatthew G. Knepley . metric - The metric to which the mesh is adapted, defined vertex-wise.
92286f25b0d8SLisandro 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_".
92290d1cd5e0SMatthew G. Knepley 
92300d1cd5e0SMatthew G. Knepley   Output Parameter:
92310d1cd5e0SMatthew G. Knepley . dmAdapt  - Pointer to the DM object containing the adapted mesh
92320d1cd5e0SMatthew G. Knepley 
92330d1cd5e0SMatthew G. Knepley   Note: The label in the adapted mesh will be registered under the name of the input DMLabel object
92340d1cd5e0SMatthew G. Knepley 
92350d1cd5e0SMatthew G. Knepley   Level: advanced
92360d1cd5e0SMatthew G. Knepley 
92370d1cd5e0SMatthew G. Knepley .seealso: DMAdaptLabel(), DMCoarsen(), DMRefine()
92380d1cd5e0SMatthew G. Knepley @*/
92390d1cd5e0SMatthew G. Knepley PetscErrorCode DMAdaptMetric(DM dm, Vec metric, DMLabel bdLabel, DM *dmAdapt)
92400d1cd5e0SMatthew G. Knepley {
92410d1cd5e0SMatthew G. Knepley   PetscErrorCode ierr;
92420d1cd5e0SMatthew G. Knepley 
92430d1cd5e0SMatthew G. Knepley   PetscFunctionBegin;
92440d1cd5e0SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
92450d1cd5e0SMatthew G. Knepley   PetscValidHeaderSpecific(metric, VEC_CLASSID, 2);
92460d1cd5e0SMatthew G. Knepley   if (bdLabel) PetscValidPointer(bdLabel, 3);
92470d1cd5e0SMatthew G. Knepley   PetscValidPointer(dmAdapt, 4);
92486f25b0d8SLisandro Dalcin   *dmAdapt = NULL;
92496f25b0d8SLisandro Dalcin   if (!dm->ops->adaptmetric) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMAdaptMetric",((PetscObject)dm)->type_name);
92500d1cd5e0SMatthew G. Knepley   ierr = (dm->ops->adaptmetric)(dm, metric, bdLabel, dmAdapt);CHKERRQ(ierr);
9251df0b854cSToby Isaac   PetscFunctionReturn(0);
9252df0b854cSToby Isaac }
9253c4088d22SMatthew G. Knepley 
9254502a2867SDave May /*@C
9255502a2867SDave May  DMGetNeighbors - Gets an array containing the MPI rank of all the processes neighbors
9256502a2867SDave May 
9257502a2867SDave May  Not Collective
9258502a2867SDave May 
9259502a2867SDave May  Input Parameter:
9260502a2867SDave May .  dm    - The DM
9261502a2867SDave May 
92620a19bb7dSprj-  Output Parameters:
92630a19bb7dSprj- +  nranks - the number of neighbours
92640a19bb7dSprj- -  ranks - the neighbors ranks
9265502a2867SDave May 
9266502a2867SDave May  Notes:
9267502a2867SDave May  Do not free the array, it is freed when the DM is destroyed.
9268502a2867SDave May 
9269502a2867SDave May  Level: beginner
9270502a2867SDave May 
9271dec1416fSJunchao Zhang  .seealso: DMDAGetNeighbors(), PetscSFGetRootRanks()
9272502a2867SDave May @*/
9273502a2867SDave May PetscErrorCode DMGetNeighbors(DM dm,PetscInt *nranks,const PetscMPIInt *ranks[])
9274502a2867SDave May {
9275502a2867SDave May   PetscErrorCode ierr;
9276502a2867SDave May 
9277502a2867SDave May   PetscFunctionBegin;
9278502a2867SDave May   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
92790918c465SMatthew G. Knepley   if (!dm->ops->getneighbors) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMGetNeighbors",((PetscObject)dm)->type_name);
9280502a2867SDave May   ierr = (dm->ops->getneighbors)(dm,nranks,ranks);CHKERRQ(ierr);
9281502a2867SDave May   PetscFunctionReturn(0);
9282502a2867SDave May }
9283502a2867SDave May 
9284531c7667SBarry Smith #include <petsc/private/matimpl.h> /* Needed because of coloring->ctype below */
9285531c7667SBarry Smith 
9286531c7667SBarry Smith /*
9287531c7667SBarry Smith     Converts the input vector to a ghosted vector and then calls the standard coloring code.
9288531c7667SBarry Smith     This has be a different function because it requires DM which is not defined in the Mat library
9289531c7667SBarry Smith */
9290531c7667SBarry Smith PetscErrorCode  MatFDColoringApply_AIJDM(Mat J,MatFDColoring coloring,Vec x1,void *sctx)
9291531c7667SBarry Smith {
9292531c7667SBarry Smith   PetscErrorCode ierr;
9293531c7667SBarry Smith 
9294531c7667SBarry Smith   PetscFunctionBegin;
9295531c7667SBarry Smith   if (coloring->ctype == IS_COLORING_LOCAL) {
9296531c7667SBarry Smith     Vec x1local;
9297531c7667SBarry Smith     DM  dm;
9298531c7667SBarry Smith     ierr = MatGetDM(J,&dm);CHKERRQ(ierr);
9299531c7667SBarry Smith     if (!dm) SETERRQ(PetscObjectComm((PetscObject)J),PETSC_ERR_ARG_INCOMP,"IS_COLORING_LOCAL requires a DM");
9300531c7667SBarry Smith     ierr = DMGetLocalVector(dm,&x1local);CHKERRQ(ierr);
9301531c7667SBarry Smith     ierr = DMGlobalToLocalBegin(dm,x1,INSERT_VALUES,x1local);CHKERRQ(ierr);
9302531c7667SBarry Smith     ierr = DMGlobalToLocalEnd(dm,x1,INSERT_VALUES,x1local);CHKERRQ(ierr);
9303531c7667SBarry Smith     x1   = x1local;
9304531c7667SBarry Smith   }
9305531c7667SBarry Smith   ierr = MatFDColoringApply_AIJ(J,coloring,x1,sctx);CHKERRQ(ierr);
9306531c7667SBarry Smith   if (coloring->ctype == IS_COLORING_LOCAL) {
9307531c7667SBarry Smith     DM  dm;
9308531c7667SBarry Smith     ierr = MatGetDM(J,&dm);CHKERRQ(ierr);
9309531c7667SBarry Smith     ierr = DMRestoreLocalVector(dm,&x1);CHKERRQ(ierr);
9310531c7667SBarry Smith   }
9311531c7667SBarry Smith   PetscFunctionReturn(0);
9312531c7667SBarry Smith }
9313531c7667SBarry Smith 
9314531c7667SBarry Smith /*@
9315531c7667SBarry Smith     MatFDColoringUseDM - allows a MatFDColoring object to use the DM associated with the matrix to use a IS_COLORING_LOCAL coloring
9316531c7667SBarry Smith 
9317531c7667SBarry Smith     Input Parameter:
9318531c7667SBarry Smith .    coloring - the MatFDColoring object
9319531c7667SBarry Smith 
932095452b02SPatrick Sanan     Developer Notes:
932195452b02SPatrick Sanan     this routine exists because the PETSc Mat library does not know about the DM objects
9322531c7667SBarry Smith 
93231b266c99SBarry Smith     Level: advanced
93241b266c99SBarry Smith 
9325531c7667SBarry Smith .seealso: MatFDColoring, MatFDColoringCreate(), ISColoringType
9326531c7667SBarry Smith @*/
9327531c7667SBarry Smith PetscErrorCode  MatFDColoringUseDM(Mat coloring,MatFDColoring fdcoloring)
9328531c7667SBarry Smith {
9329531c7667SBarry Smith   PetscFunctionBegin;
9330531c7667SBarry Smith   coloring->ops->fdcoloringapply = MatFDColoringApply_AIJDM;
9331531c7667SBarry Smith   PetscFunctionReturn(0);
9332531c7667SBarry Smith }
93338320bc6fSPatrick Sanan 
93348320bc6fSPatrick Sanan /*@
93358320bc6fSPatrick Sanan     DMGetCompatibility - determine if two DMs are compatible
93368320bc6fSPatrick Sanan 
93378320bc6fSPatrick Sanan     Collective
93388320bc6fSPatrick Sanan 
93398320bc6fSPatrick Sanan     Input Parameters:
9340a5bc1bf3SBarry Smith +    dm1 - the first DM
93418320bc6fSPatrick Sanan -    dm2 - the second DM
93428320bc6fSPatrick Sanan 
93438320bc6fSPatrick Sanan     Output Parameters:
93448320bc6fSPatrick Sanan +    compatible - whether or not the two DMs are compatible
93458320bc6fSPatrick Sanan -    set - whether or not the compatible value was set
93468320bc6fSPatrick Sanan 
93478320bc6fSPatrick Sanan     Notes:
93488320bc6fSPatrick Sanan     Two DMs are deemed compatible if they represent the same parallel decomposition
93493d862458SPatrick Sanan     of the same topology. This implies that the section (field data) on one
93508320bc6fSPatrick Sanan     "makes sense" with respect to the topology and parallel decomposition of the other.
93513d862458SPatrick Sanan     Loosely speaking, compatible DMs represent the same domain and parallel
93523d862458SPatrick Sanan     decomposition, but hold different data.
93538320bc6fSPatrick Sanan 
93548320bc6fSPatrick Sanan     Typically, one would confirm compatibility if intending to simultaneously iterate
93558320bc6fSPatrick Sanan     over a pair of vectors obtained from different DMs.
93568320bc6fSPatrick Sanan 
93578320bc6fSPatrick Sanan     For example, two DMDA objects are compatible if they have the same local
93588320bc6fSPatrick Sanan     and global sizes and the same stencil width. They can have different numbers
93598320bc6fSPatrick Sanan     of degrees of freedom per node. Thus, one could use the node numbering from
93608320bc6fSPatrick Sanan     either DM in bounds for a loop over vectors derived from either DM.
93618320bc6fSPatrick Sanan 
93628320bc6fSPatrick Sanan     Consider the operation of summing data living on a 2-dof DMDA to data living
93638320bc6fSPatrick Sanan     on a 1-dof DMDA, which should be compatible, as in the following snippet.
93648320bc6fSPatrick Sanan .vb
93658320bc6fSPatrick Sanan   ...
93668320bc6fSPatrick Sanan   ierr = DMGetCompatibility(da1,da2,&compatible,&set);CHKERRQ(ierr);
93678320bc6fSPatrick Sanan   if (set && compatible)  {
93688320bc6fSPatrick Sanan     ierr = DMDAVecGetArrayDOF(da1,vec1,&arr1);CHKERRQ(ierr);
93698320bc6fSPatrick Sanan     ierr = DMDAVecGetArrayDOF(da2,vec2,&arr2);CHKERRQ(ierr);
93703d862458SPatrick Sanan     ierr = DMDAGetCorners(da1,&x,&y,NULL,&m,&n,NULL);CHKERRQ(ierr);
93718320bc6fSPatrick Sanan     for (j=y; j<y+n; ++j) {
93728320bc6fSPatrick Sanan       for (i=x; i<x+m, ++i) {
93738320bc6fSPatrick Sanan         arr1[j][i][0] = arr2[j][i][0] + arr2[j][i][1];
93748320bc6fSPatrick Sanan       }
93758320bc6fSPatrick Sanan     }
93768320bc6fSPatrick Sanan     ierr = DMDAVecRestoreArrayDOF(da1,vec1,&arr1);CHKERRQ(ierr);
93778320bc6fSPatrick Sanan     ierr = DMDAVecRestoreArrayDOF(da2,vec2,&arr2);CHKERRQ(ierr);
93788320bc6fSPatrick Sanan   } else {
93798320bc6fSPatrick Sanan     SETERRQ(PetscObjectComm((PetscObject)da1,PETSC_ERR_ARG_INCOMP,"DMDA objects incompatible");
93808320bc6fSPatrick Sanan   }
93818320bc6fSPatrick Sanan   ...
93828320bc6fSPatrick Sanan .ve
93838320bc6fSPatrick Sanan 
93848320bc6fSPatrick Sanan     Checking compatibility might be expensive for a given implementation of DM,
93858320bc6fSPatrick Sanan     or might be impossible to unambiguously confirm or deny. For this reason,
93868320bc6fSPatrick Sanan     this function may decline to determine compatibility, and hence users should
93878320bc6fSPatrick Sanan     always check the "set" output parameter.
93888320bc6fSPatrick Sanan 
93898320bc6fSPatrick Sanan     A DM is always compatible with itself.
93908320bc6fSPatrick Sanan 
93918320bc6fSPatrick Sanan     In the current implementation, DMs which live on "unequal" communicators
93928320bc6fSPatrick Sanan     (MPI_UNEQUAL in the terminology of MPI_Comm_compare()) are always deemed
93938320bc6fSPatrick Sanan     incompatible.
93948320bc6fSPatrick Sanan 
93958320bc6fSPatrick Sanan     This function is labeled "Collective," as information about all subdomains
93968320bc6fSPatrick Sanan     is required on each rank. However, in DM implementations which store all this
93978320bc6fSPatrick Sanan     information locally, this function may be merely "Logically Collective".
93988320bc6fSPatrick Sanan 
93998320bc6fSPatrick Sanan     Developer Notes:
94003d862458SPatrick Sanan     Compatibility is assumed to be a symmetric concept; DM A is compatible with DM B
94013d862458SPatrick Sanan     iff B is compatible with A. Thus, this function checks the implementations
9402a5bc1bf3SBarry Smith     of both dm and dmc (if they are of different types), attempting to determine
94038320bc6fSPatrick Sanan     compatibility. It is left to DM implementers to ensure that symmetry is
94048320bc6fSPatrick Sanan     preserved. The simplest way to do this is, when implementing type-specific
94053d862458SPatrick Sanan     logic for this function, is to check for existing logic in the implementation
94063d862458SPatrick Sanan     of other DM types and let *set = PETSC_FALSE if found.
94078320bc6fSPatrick Sanan 
94088320bc6fSPatrick Sanan     Level: advanced
94098320bc6fSPatrick Sanan 
94103d862458SPatrick Sanan .seealso: DM, DMDACreateCompatibleDMDA(), DMStagCreateCompatibleDMStag()
94118320bc6fSPatrick Sanan @*/
94128320bc6fSPatrick Sanan 
9413a5bc1bf3SBarry Smith PetscErrorCode DMGetCompatibility(DM dm1,DM dm2,PetscBool *compatible,PetscBool *set)
94148320bc6fSPatrick Sanan {
94158320bc6fSPatrick Sanan   PetscErrorCode ierr;
94168320bc6fSPatrick Sanan   PetscMPIInt    compareResult;
94178320bc6fSPatrick Sanan   DMType         type,type2;
94188320bc6fSPatrick Sanan   PetscBool      sameType;
94198320bc6fSPatrick Sanan 
94208320bc6fSPatrick Sanan   PetscFunctionBegin;
9421a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(dm1,DM_CLASSID,1);
94228320bc6fSPatrick Sanan   PetscValidHeaderSpecific(dm2,DM_CLASSID,2);
94238320bc6fSPatrick Sanan 
94248320bc6fSPatrick Sanan   /* Declare a DM compatible with itself */
9425a5bc1bf3SBarry Smith   if (dm1 == dm2) {
94268320bc6fSPatrick Sanan     *set = PETSC_TRUE;
94278320bc6fSPatrick Sanan     *compatible = PETSC_TRUE;
94288320bc6fSPatrick Sanan     PetscFunctionReturn(0);
94298320bc6fSPatrick Sanan   }
94308320bc6fSPatrick Sanan 
94318320bc6fSPatrick Sanan   /* Declare a DM incompatible with a DM that lives on an "unequal"
94328320bc6fSPatrick Sanan      communicator. Note that this does not preclude compatibility with
94338320bc6fSPatrick Sanan      DMs living on "congruent" or "similar" communicators, but this must be
94348320bc6fSPatrick Sanan      determined by the implementation-specific logic */
9435ffc4695bSBarry Smith   ierr = MPI_Comm_compare(PetscObjectComm((PetscObject)dm1),PetscObjectComm((PetscObject)dm2),&compareResult);CHKERRMPI(ierr);
94368320bc6fSPatrick Sanan   if (compareResult == MPI_UNEQUAL) {
94378320bc6fSPatrick Sanan     *set = PETSC_TRUE;
94388320bc6fSPatrick Sanan     *compatible = PETSC_FALSE;
94398320bc6fSPatrick Sanan     PetscFunctionReturn(0);
94408320bc6fSPatrick Sanan   }
94418320bc6fSPatrick Sanan 
94428320bc6fSPatrick Sanan   /* Pass to the implementation-specific routine, if one exists. */
9443a5bc1bf3SBarry Smith   if (dm1->ops->getcompatibility) {
9444a5bc1bf3SBarry Smith     ierr = (*dm1->ops->getcompatibility)(dm1,dm2,compatible,set);CHKERRQ(ierr);
9445b9d85ea2SLisandro Dalcin     if (*set) PetscFunctionReturn(0);
94468320bc6fSPatrick Sanan   }
94478320bc6fSPatrick Sanan 
9448a5bc1bf3SBarry Smith   /* If dm1 and dm2 are of different types, then attempt to check compatibility
94498320bc6fSPatrick Sanan      with an implementation of this function from dm2 */
9450a5bc1bf3SBarry Smith   ierr = DMGetType(dm1,&type);CHKERRQ(ierr);
94518320bc6fSPatrick Sanan   ierr = DMGetType(dm2,&type2);CHKERRQ(ierr);
94528320bc6fSPatrick Sanan   ierr = PetscStrcmp(type,type2,&sameType);CHKERRQ(ierr);
94538320bc6fSPatrick Sanan   if (!sameType && dm2->ops->getcompatibility) {
9454a5bc1bf3SBarry Smith     ierr = (*dm2->ops->getcompatibility)(dm2,dm1,compatible,set);CHKERRQ(ierr); /* Note argument order */
94558320bc6fSPatrick Sanan   } else {
94568320bc6fSPatrick Sanan     *set = PETSC_FALSE;
94578320bc6fSPatrick Sanan   }
94588320bc6fSPatrick Sanan   PetscFunctionReturn(0);
94598320bc6fSPatrick Sanan }
9460c0f0dcc3SMatthew G. Knepley 
9461c0f0dcc3SMatthew G. Knepley /*@C
9462c0f0dcc3SMatthew G. Knepley   DMMonitorSet - Sets an ADDITIONAL function that is to be used after a solve to monitor discretization performance.
9463c0f0dcc3SMatthew G. Knepley 
9464c0f0dcc3SMatthew G. Knepley   Logically Collective on DM
9465c0f0dcc3SMatthew G. Knepley 
9466c0f0dcc3SMatthew G. Knepley   Input Parameters:
9467c0f0dcc3SMatthew G. Knepley + DM - the DM
9468c0f0dcc3SMatthew G. Knepley . f - the monitor function
9469c0f0dcc3SMatthew G. Knepley . mctx - [optional] user-defined context for private data for the monitor routine (use NULL if no context is desired)
9470c0f0dcc3SMatthew G. Knepley - monitordestroy - [optional] routine that frees monitor context (may be NULL)
9471c0f0dcc3SMatthew G. Knepley 
9472c0f0dcc3SMatthew G. Knepley   Options Database Keys:
9473c0f0dcc3SMatthew G. Knepley - -dm_monitor_cancel - cancels all monitors that have been hardwired into a code by calls to DMMonitorSet(), but
9474c0f0dcc3SMatthew G. Knepley                             does not cancel those set via the options database.
9475c0f0dcc3SMatthew G. Knepley 
9476c0f0dcc3SMatthew G. Knepley   Notes:
9477c0f0dcc3SMatthew G. Knepley   Several different monitoring routines may be set by calling
9478c0f0dcc3SMatthew G. Knepley   DMMonitorSet() multiple times; all will be called in the
9479c0f0dcc3SMatthew G. Knepley   order in which they were set.
9480c0f0dcc3SMatthew G. Knepley 
9481c0f0dcc3SMatthew G. Knepley   Fortran Notes:
9482c0f0dcc3SMatthew G. Knepley   Only a single monitor function can be set for each DM object
9483c0f0dcc3SMatthew G. Knepley 
9484c0f0dcc3SMatthew G. Knepley   Level: intermediate
9485c0f0dcc3SMatthew G. Knepley 
9486c0f0dcc3SMatthew G. Knepley .seealso: DMMonitorCancel()
9487c0f0dcc3SMatthew G. Knepley @*/
9488c0f0dcc3SMatthew G. Knepley PetscErrorCode DMMonitorSet(DM dm, PetscErrorCode (*f)(DM, void *), void *mctx, PetscErrorCode (*monitordestroy)(void**))
9489c0f0dcc3SMatthew G. Knepley {
9490c0f0dcc3SMatthew G. Knepley   PetscInt       m;
9491c0f0dcc3SMatthew G. Knepley   PetscErrorCode ierr;
9492c0f0dcc3SMatthew G. Knepley 
9493c0f0dcc3SMatthew G. Knepley   PetscFunctionBegin;
9494c0f0dcc3SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
9495c0f0dcc3SMatthew G. Knepley   for (m = 0; m < dm->numbermonitors; ++m) {
9496c0f0dcc3SMatthew G. Knepley     PetscBool identical;
9497c0f0dcc3SMatthew G. Knepley 
9498c0f0dcc3SMatthew G. Knepley     ierr = PetscMonitorCompare((PetscErrorCode (*)(void)) f, mctx, monitordestroy, (PetscErrorCode (*)(void)) dm->monitor[m], dm->monitorcontext[m], dm->monitordestroy[m], &identical);CHKERRQ(ierr);
9499c0f0dcc3SMatthew G. Knepley     if (identical) PetscFunctionReturn(0);
9500c0f0dcc3SMatthew G. Knepley   }
9501c0f0dcc3SMatthew G. Knepley   if (dm->numbermonitors >= MAXDMMONITORS) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Too many monitors set");
9502c0f0dcc3SMatthew G. Knepley   dm->monitor[dm->numbermonitors]          = f;
9503c0f0dcc3SMatthew G. Knepley   dm->monitordestroy[dm->numbermonitors]   = monitordestroy;
9504c0f0dcc3SMatthew G. Knepley   dm->monitorcontext[dm->numbermonitors++] = (void *) mctx;
9505c0f0dcc3SMatthew G. Knepley   PetscFunctionReturn(0);
9506c0f0dcc3SMatthew G. Knepley }
9507c0f0dcc3SMatthew G. Knepley 
9508c0f0dcc3SMatthew G. Knepley /*@
9509c0f0dcc3SMatthew G. Knepley   DMMonitorCancel - Clears all the monitor functions for a DM object.
9510c0f0dcc3SMatthew G. Knepley 
9511c0f0dcc3SMatthew G. Knepley   Logically Collective on DM
9512c0f0dcc3SMatthew G. Knepley 
9513c0f0dcc3SMatthew G. Knepley   Input Parameter:
9514c0f0dcc3SMatthew G. Knepley . dm - the DM
9515c0f0dcc3SMatthew G. Knepley 
9516c0f0dcc3SMatthew G. Knepley   Options Database Key:
9517c0f0dcc3SMatthew G. Knepley . -dm_monitor_cancel - cancels all monitors that have been hardwired
9518c0f0dcc3SMatthew G. Knepley   into a code by calls to DMonitorSet(), but does not cancel those
9519c0f0dcc3SMatthew G. Knepley   set via the options database
9520c0f0dcc3SMatthew G. Knepley 
9521c0f0dcc3SMatthew G. Knepley   Notes:
9522c0f0dcc3SMatthew G. Knepley   There is no way to clear one specific monitor from a DM object.
9523c0f0dcc3SMatthew G. Knepley 
9524c0f0dcc3SMatthew G. Knepley   Level: intermediate
9525c0f0dcc3SMatthew G. Knepley 
9526c0f0dcc3SMatthew G. Knepley .seealso: DMMonitorSet()
9527c0f0dcc3SMatthew G. Knepley @*/
9528c0f0dcc3SMatthew G. Knepley PetscErrorCode DMMonitorCancel(DM dm)
9529c0f0dcc3SMatthew G. Knepley {
9530c0f0dcc3SMatthew G. Knepley   PetscErrorCode ierr;
9531c0f0dcc3SMatthew G. Knepley   PetscInt       m;
9532c0f0dcc3SMatthew G. Knepley 
9533c0f0dcc3SMatthew G. Knepley   PetscFunctionBegin;
9534c0f0dcc3SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
9535c0f0dcc3SMatthew G. Knepley   for (m = 0; m < dm->numbermonitors; ++m) {
9536c0f0dcc3SMatthew G. Knepley     if (dm->monitordestroy[m]) {ierr = (*dm->monitordestroy[m])(&dm->monitorcontext[m]);CHKERRQ(ierr);}
9537c0f0dcc3SMatthew G. Knepley   }
9538c0f0dcc3SMatthew G. Knepley   dm->numbermonitors = 0;
9539c0f0dcc3SMatthew G. Knepley   PetscFunctionReturn(0);
9540c0f0dcc3SMatthew G. Knepley }
9541c0f0dcc3SMatthew G. Knepley 
9542c0f0dcc3SMatthew G. Knepley /*@C
9543c0f0dcc3SMatthew G. Knepley   DMMonitorSetFromOptions - Sets a monitor function and viewer appropriate for the type indicated by the user
9544c0f0dcc3SMatthew G. Knepley 
9545c0f0dcc3SMatthew G. Knepley   Collective on DM
9546c0f0dcc3SMatthew G. Knepley 
9547c0f0dcc3SMatthew G. Knepley   Input Parameters:
9548c0f0dcc3SMatthew G. Knepley + dm   - DM object you wish to monitor
9549c0f0dcc3SMatthew G. Knepley . name - the monitor type one is seeking
9550c0f0dcc3SMatthew G. Knepley . help - message indicating what monitoring is done
9551c0f0dcc3SMatthew G. Knepley . manual - manual page for the monitor
9552c0f0dcc3SMatthew G. Knepley . monitor - the monitor function
9553c0f0dcc3SMatthew 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
9554c0f0dcc3SMatthew G. Knepley 
9555c0f0dcc3SMatthew G. Knepley   Output Parameter:
9556c0f0dcc3SMatthew G. Knepley . flg - Flag set if the monitor was created
9557c0f0dcc3SMatthew G. Knepley 
9558c0f0dcc3SMatthew G. Knepley   Level: developer
9559c0f0dcc3SMatthew G. Knepley 
9560c0f0dcc3SMatthew G. Knepley .seealso: PetscOptionsGetViewer(), PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(),
9561c0f0dcc3SMatthew G. Knepley           PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool()
9562c0f0dcc3SMatthew G. Knepley           PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(),
9563c0f0dcc3SMatthew G. Knepley           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
9564c0f0dcc3SMatthew G. Knepley           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
9565c0f0dcc3SMatthew G. Knepley           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
9566c0f0dcc3SMatthew G. Knepley           PetscOptionsFList(), PetscOptionsEList()
9567c0f0dcc3SMatthew G. Knepley @*/
9568c0f0dcc3SMatthew 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)
9569c0f0dcc3SMatthew G. Knepley {
9570c0f0dcc3SMatthew G. Knepley   PetscViewer       viewer;
9571c0f0dcc3SMatthew G. Knepley   PetscViewerFormat format;
9572c0f0dcc3SMatthew G. Knepley   PetscErrorCode    ierr;
9573c0f0dcc3SMatthew G. Knepley 
9574c0f0dcc3SMatthew G. Knepley   PetscFunctionBegin;
9575c0f0dcc3SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
9576c0f0dcc3SMatthew G. Knepley   ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject) dm), ((PetscObject) dm)->options, ((PetscObject) dm)->prefix, name, &viewer, &format, flg);CHKERRQ(ierr);
9577c0f0dcc3SMatthew G. Knepley   if (*flg) {
9578c0f0dcc3SMatthew G. Knepley     PetscViewerAndFormat *vf;
9579c0f0dcc3SMatthew G. Knepley 
9580c0f0dcc3SMatthew G. Knepley     ierr = PetscViewerAndFormatCreate(viewer, format, &vf);CHKERRQ(ierr);
9581c0f0dcc3SMatthew G. Knepley     ierr = PetscObjectDereference((PetscObject) viewer);CHKERRQ(ierr);
9582c0f0dcc3SMatthew G. Knepley     if (monitorsetup) {ierr = (*monitorsetup)(dm, vf);CHKERRQ(ierr);}
9583c0f0dcc3SMatthew G. Knepley     ierr = DMMonitorSet(dm,(PetscErrorCode (*)(DM, void *)) monitor, vf, (PetscErrorCode (*)(void **)) PetscViewerAndFormatDestroy);CHKERRQ(ierr);
9584c0f0dcc3SMatthew G. Knepley   }
9585c0f0dcc3SMatthew G. Knepley   PetscFunctionReturn(0);
9586c0f0dcc3SMatthew G. Knepley }
9587c0f0dcc3SMatthew G. Knepley 
9588c0f0dcc3SMatthew G. Knepley /*@
9589c0f0dcc3SMatthew G. Knepley    DMMonitor - runs the user provided monitor routines, if they exist
9590c0f0dcc3SMatthew G. Knepley 
9591c0f0dcc3SMatthew G. Knepley    Collective on DM
9592c0f0dcc3SMatthew G. Knepley 
9593c0f0dcc3SMatthew G. Knepley    Input Parameters:
9594c0f0dcc3SMatthew G. Knepley .  dm - The DM
9595c0f0dcc3SMatthew G. Knepley 
9596c0f0dcc3SMatthew G. Knepley    Level: developer
9597c0f0dcc3SMatthew G. Knepley 
9598c0f0dcc3SMatthew G. Knepley .seealso: DMMonitorSet()
9599c0f0dcc3SMatthew G. Knepley @*/
9600c0f0dcc3SMatthew G. Knepley PetscErrorCode DMMonitor(DM dm)
9601c0f0dcc3SMatthew G. Knepley {
9602c0f0dcc3SMatthew G. Knepley   PetscInt       m;
9603c0f0dcc3SMatthew G. Knepley   PetscErrorCode ierr;
9604c0f0dcc3SMatthew G. Knepley 
9605c0f0dcc3SMatthew G. Knepley   PetscFunctionBegin;
9606c0f0dcc3SMatthew G. Knepley   if (!dm) PetscFunctionReturn(0);
9607c0f0dcc3SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
9608c0f0dcc3SMatthew G. Knepley   for (m = 0; m < dm->numbermonitors; ++m) {
9609c0f0dcc3SMatthew G. Knepley     ierr = (*dm->monitor[m])(dm, dm->monitorcontext[m]);CHKERRQ(ierr);
9610c0f0dcc3SMatthew G. Knepley   }
9611c0f0dcc3SMatthew G. Knepley   PetscFunctionReturn(0);
9612c0f0dcc3SMatthew G. Knepley }
96132e4af2aeSMatthew G. Knepley 
96142e4af2aeSMatthew G. Knepley /*@
96152e4af2aeSMatthew G. Knepley   DMComputeError - Computes the error assuming the user has given exact solution functions
96162e4af2aeSMatthew G. Knepley 
96172e4af2aeSMatthew G. Knepley   Collective on DM
96182e4af2aeSMatthew G. Knepley 
96192e4af2aeSMatthew G. Knepley   Input Parameters:
96202e4af2aeSMatthew G. Knepley + dm     - The DM
96216b867d5aSJose E. Roman - sol    - The solution vector
96222e4af2aeSMatthew G. Knepley 
96236b867d5aSJose E. Roman   Input/Output Parameter:
96246b867d5aSJose E. Roman . errors - An array of length Nf, the number of fields, or NULL for no output; on output
96256b867d5aSJose E. Roman            contains the error in each field
96266b867d5aSJose E. Roman 
96276b867d5aSJose E. Roman   Output Parameter:
96286b867d5aSJose E. Roman . errorVec - A vector to hold the cellwise error (may be NULL)
96292e4af2aeSMatthew G. Knepley 
96302e4af2aeSMatthew G. Knepley   Note: The exact solutions come from the PetscDS object, and the time comes from DMGetOutputSequenceNumber().
96312e4af2aeSMatthew G. Knepley 
96322e4af2aeSMatthew G. Knepley   Level: developer
96332e4af2aeSMatthew G. Knepley 
96342e4af2aeSMatthew G. Knepley .seealso: DMMonitorSet(), DMGetRegionNumDS(), PetscDSGetExactSolution(), DMGetOutputSequenceNumber()
96352e4af2aeSMatthew G. Knepley @*/
96362e4af2aeSMatthew G. Knepley PetscErrorCode DMComputeError(DM dm, Vec sol, PetscReal errors[], Vec *errorVec)
96372e4af2aeSMatthew G. Knepley {
96382e4af2aeSMatthew G. Knepley   PetscErrorCode (**exactSol)(PetscInt, PetscReal, const PetscReal[], PetscInt, PetscScalar[], void *);
96392e4af2aeSMatthew G. Knepley   void            **ctxs;
96402e4af2aeSMatthew G. Knepley   PetscReal         time;
96412e4af2aeSMatthew G. Knepley   PetscInt          Nf, f, Nds, s;
96422e4af2aeSMatthew G. Knepley   PetscErrorCode    ierr;
96432e4af2aeSMatthew G. Knepley 
96442e4af2aeSMatthew G. Knepley   PetscFunctionBegin;
96452e4af2aeSMatthew G. Knepley   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
96462e4af2aeSMatthew G. Knepley   ierr = PetscCalloc2(Nf, &exactSol, Nf, &ctxs);CHKERRQ(ierr);
96472e4af2aeSMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
96482e4af2aeSMatthew G. Knepley   for (s = 0; s < Nds; ++s) {
96492e4af2aeSMatthew G. Knepley     PetscDS         ds;
96502e4af2aeSMatthew G. Knepley     DMLabel         label;
96512e4af2aeSMatthew G. Knepley     IS              fieldIS;
96522e4af2aeSMatthew G. Knepley     const PetscInt *fields;
96532e4af2aeSMatthew G. Knepley     PetscInt        dsNf;
96542e4af2aeSMatthew G. Knepley 
96552e4af2aeSMatthew G. Knepley     ierr = DMGetRegionNumDS(dm, s, &label, &fieldIS, &ds);CHKERRQ(ierr);
96562e4af2aeSMatthew G. Knepley     ierr = PetscDSGetNumFields(ds, &dsNf);CHKERRQ(ierr);
96572e4af2aeSMatthew G. Knepley     if (fieldIS) {ierr = ISGetIndices(fieldIS, &fields);CHKERRQ(ierr);}
96582e4af2aeSMatthew G. Knepley     for (f = 0; f < dsNf; ++f) {
96592e4af2aeSMatthew G. Knepley       const PetscInt field = fields[f];
96602e4af2aeSMatthew G. Knepley       ierr = PetscDSGetExactSolution(ds, field, &exactSol[field], &ctxs[field]);CHKERRQ(ierr);
96612e4af2aeSMatthew G. Knepley     }
96622e4af2aeSMatthew G. Knepley     if (fieldIS) {ierr = ISRestoreIndices(fieldIS, &fields);CHKERRQ(ierr);}
96632e4af2aeSMatthew G. Knepley   }
96642e4af2aeSMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
96652e4af2aeSMatthew G. Knepley     if (!exactSol[f]) SETERRQ1(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_WRONG, "DS must contain exact solution functions in order to calculate error, missing for field %D", f);
96662e4af2aeSMatthew G. Knepley   }
96672e4af2aeSMatthew G. Knepley   ierr = DMGetOutputSequenceNumber(dm, NULL, &time);CHKERRQ(ierr);
96682e4af2aeSMatthew G. Knepley   if (errors) {ierr = DMComputeL2FieldDiff(dm, time, exactSol, ctxs, sol, errors);CHKERRQ(ierr);}
96692e4af2aeSMatthew G. Knepley   if (errorVec) {
96702e4af2aeSMatthew G. Knepley     DM             edm;
96712e4af2aeSMatthew G. Knepley     DMPolytopeType ct;
96722e4af2aeSMatthew G. Knepley     PetscBool      simplex;
96732e4af2aeSMatthew G. Knepley     PetscInt       dim, cStart, Nf;
96742e4af2aeSMatthew G. Knepley 
96752e4af2aeSMatthew G. Knepley     ierr = DMClone(dm, &edm);CHKERRQ(ierr);
96762e4af2aeSMatthew G. Knepley     ierr = DMGetDimension(edm, &dim);CHKERRQ(ierr);
96772e4af2aeSMatthew G. Knepley     ierr = DMPlexGetHeightStratum(dm, 0, &cStart, NULL);CHKERRQ(ierr);
96782e4af2aeSMatthew G. Knepley     ierr = DMPlexGetCellType(dm, cStart, &ct);CHKERRQ(ierr);
96792e4af2aeSMatthew G. Knepley     simplex = DMPolytopeTypeGetNumVertices(ct) == DMPolytopeTypeGetDim(ct)+1 ? PETSC_TRUE : PETSC_FALSE;
96802e4af2aeSMatthew G. Knepley     ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
96812e4af2aeSMatthew G. Knepley     for (f = 0; f < Nf; ++f) {
96822e4af2aeSMatthew G. Knepley       PetscFE         fe, efe;
96832e4af2aeSMatthew G. Knepley       PetscQuadrature q;
96842e4af2aeSMatthew G. Knepley       const char     *name;
96852e4af2aeSMatthew G. Knepley 
96862e4af2aeSMatthew G. Knepley       ierr = DMGetField(dm, f, NULL, (PetscObject *) &fe);CHKERRQ(ierr);
96872e4af2aeSMatthew G. Knepley       ierr = PetscFECreateLagrange(PETSC_COMM_SELF, dim, Nf, simplex, 0, PETSC_DETERMINE, &efe);CHKERRQ(ierr);
96882e4af2aeSMatthew G. Knepley       ierr = PetscObjectGetName((PetscObject) fe, &name);CHKERRQ(ierr);
96892e4af2aeSMatthew G. Knepley       ierr = PetscObjectSetName((PetscObject) efe, name);CHKERRQ(ierr);
96902e4af2aeSMatthew G. Knepley       ierr = PetscFEGetQuadrature(fe, &q);CHKERRQ(ierr);
96912e4af2aeSMatthew G. Knepley       ierr = PetscFESetQuadrature(efe, q);CHKERRQ(ierr);
96922e4af2aeSMatthew G. Knepley       ierr = DMSetField(edm, f, NULL, (PetscObject) efe);CHKERRQ(ierr);
96932e4af2aeSMatthew G. Knepley       ierr = PetscFEDestroy(&efe);CHKERRQ(ierr);
96942e4af2aeSMatthew G. Knepley     }
96952e4af2aeSMatthew G. Knepley     ierr = DMCreateDS(edm);CHKERRQ(ierr);
96962e4af2aeSMatthew G. Knepley 
96971e1ea65dSPierre Jolivet     ierr = DMCreateGlobalVector(edm, errorVec);CHKERRQ(ierr);
96982e4af2aeSMatthew G. Knepley     ierr = PetscObjectSetName((PetscObject) *errorVec, "Error");CHKERRQ(ierr);
96992e4af2aeSMatthew G. Knepley     ierr = DMPlexComputeL2DiffVec(dm, time, exactSol, ctxs, sol, *errorVec);CHKERRQ(ierr);
97002e4af2aeSMatthew G. Knepley     ierr = DMDestroy(&edm);CHKERRQ(ierr);
97012e4af2aeSMatthew G. Knepley   }
97022e4af2aeSMatthew G. Knepley   ierr = PetscFree2(exactSol, ctxs);CHKERRQ(ierr);
97032e4af2aeSMatthew G. Knepley   PetscFunctionReturn(0);
97042e4af2aeSMatthew G. Knepley }
97059a2a23afSMatthew G. Knepley 
97069a2a23afSMatthew G. Knepley /*@
97079a2a23afSMatthew G. Knepley   DMGetNumAuxiliaryVec - Get the number of auxiliary vectors associated with this DM
97089a2a23afSMatthew G. Knepley 
97099a2a23afSMatthew G. Knepley   Not collective
97109a2a23afSMatthew G. Knepley 
97119a2a23afSMatthew G. Knepley   Input Parameter:
97129a2a23afSMatthew G. Knepley . dm     - The DM
97139a2a23afSMatthew G. Knepley 
97149a2a23afSMatthew G. Knepley   Output Parameter:
9715a5b23f4aSJose E. Roman . numAux - The number of auxiliary data vectors
97169a2a23afSMatthew G. Knepley 
97179a2a23afSMatthew G. Knepley   Level: advanced
97189a2a23afSMatthew G. Knepley 
97199a2a23afSMatthew G. Knepley .seealso: DMGetAuxiliaryLabels(), DMGetAuxiliaryVec(), DMSetAuxiliaryVec()
97209a2a23afSMatthew G. Knepley @*/
97219a2a23afSMatthew G. Knepley PetscErrorCode DMGetNumAuxiliaryVec(DM dm, PetscInt *numAux)
97229a2a23afSMatthew G. Knepley {
97239a2a23afSMatthew G. Knepley   PetscErrorCode ierr;
97249a2a23afSMatthew G. Knepley 
97259a2a23afSMatthew G. Knepley   PetscFunctionBegin;
97269a2a23afSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
97279a2a23afSMatthew G. Knepley   ierr = PetscHMapAuxGetSize(dm->auxData, numAux);CHKERRQ(ierr);
97289a2a23afSMatthew G. Knepley   PetscFunctionReturn(0);
97299a2a23afSMatthew G. Knepley }
97309a2a23afSMatthew G. Knepley 
97319a2a23afSMatthew G. Knepley /*@
97329a2a23afSMatthew G. Knepley   DMGetAuxiliaryVec - Get the auxiliary vector for region specified by the given label and value
97339a2a23afSMatthew G. Knepley 
97349a2a23afSMatthew G. Knepley   Not collective
97359a2a23afSMatthew G. Knepley 
97369a2a23afSMatthew G. Knepley   Input Parameters:
97379a2a23afSMatthew G. Knepley + dm     - The DM
97389a2a23afSMatthew G. Knepley . label  - The DMLabel
97399a2a23afSMatthew G. Knepley - value  - The label value indicating the region
97409a2a23afSMatthew G. Knepley 
97419a2a23afSMatthew G. Knepley   Output Parameter:
97429a2a23afSMatthew G. Knepley . aux    - The Vec holding auxiliary field data
97439a2a23afSMatthew G. Knepley 
974404c51a94SMatthew G. Knepley   Note: If no auxiliary vector is found for this (label, value), (NULL, 0) is checked as well.
974504c51a94SMatthew G. Knepley 
97469a2a23afSMatthew G. Knepley   Level: advanced
97479a2a23afSMatthew G. Knepley 
97489a2a23afSMatthew G. Knepley .seealso: DMSetAuxiliaryVec(), DMGetNumAuxiliaryVec()
97499a2a23afSMatthew G. Knepley @*/
97509a2a23afSMatthew G. Knepley PetscErrorCode DMGetAuxiliaryVec(DM dm, DMLabel label, PetscInt value, Vec *aux)
97519a2a23afSMatthew G. Knepley {
975204c51a94SMatthew G. Knepley   PetscHashAuxKey key, wild = {NULL, 0};
975304c51a94SMatthew G. Knepley   PetscBool       has;
97549a2a23afSMatthew G. Knepley   PetscErrorCode  ierr;
97559a2a23afSMatthew G. Knepley 
97569a2a23afSMatthew G. Knepley   PetscFunctionBegin;
97579a2a23afSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
97589a2a23afSMatthew G. Knepley   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
97599a2a23afSMatthew G. Knepley   key.label = label;
97609a2a23afSMatthew G. Knepley   key.value = value;
976104c51a94SMatthew G. Knepley   ierr = PetscHMapAuxHas(dm->auxData, key, &has);CHKERRQ(ierr);
976204c51a94SMatthew G. Knepley   if (has) {ierr = PetscHMapAuxGet(dm->auxData, key,  aux);CHKERRQ(ierr);}
976304c51a94SMatthew G. Knepley   else     {ierr = PetscHMapAuxGet(dm->auxData, wild, aux);CHKERRQ(ierr);}
97649a2a23afSMatthew G. Knepley   PetscFunctionReturn(0);
97659a2a23afSMatthew G. Knepley }
97669a2a23afSMatthew G. Knepley 
97679a2a23afSMatthew G. Knepley /*@
97689a2a23afSMatthew G. Knepley   DMSetAuxiliaryVec - Set the auxiliary vector for region specified by the given label and value
97699a2a23afSMatthew G. Knepley 
97709a2a23afSMatthew G. Knepley   Not collective
97719a2a23afSMatthew G. Knepley 
97729a2a23afSMatthew G. Knepley   Input Parameters:
97739a2a23afSMatthew G. Knepley + dm     - The DM
97749a2a23afSMatthew G. Knepley . label  - The DMLabel
97759a2a23afSMatthew G. Knepley . value  - The label value indicating the region
97769a2a23afSMatthew G. Knepley - aux    - The Vec holding auxiliary field data
97779a2a23afSMatthew G. Knepley 
97789a2a23afSMatthew G. Knepley   Level: advanced
97799a2a23afSMatthew G. Knepley 
97809a2a23afSMatthew G. Knepley .seealso: DMGetAuxiliaryVec()
97819a2a23afSMatthew G. Knepley @*/
97829a2a23afSMatthew G. Knepley PetscErrorCode DMSetAuxiliaryVec(DM dm, DMLabel label, PetscInt value, Vec aux)
97839a2a23afSMatthew G. Knepley {
97849a2a23afSMatthew G. Knepley   Vec             old;
97859a2a23afSMatthew G. Knepley   PetscHashAuxKey key;
97869a2a23afSMatthew G. Knepley   PetscErrorCode  ierr;
97879a2a23afSMatthew G. Knepley 
97889a2a23afSMatthew G. Knepley   PetscFunctionBegin;
97899a2a23afSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
97909a2a23afSMatthew G. Knepley   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
97919a2a23afSMatthew G. Knepley   key.label = label;
97929a2a23afSMatthew G. Knepley   key.value = value;
97939a2a23afSMatthew G. Knepley   ierr = PetscHMapAuxGet(dm->auxData, key, &old);CHKERRQ(ierr);
97949a2a23afSMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) aux);CHKERRQ(ierr);
97959a2a23afSMatthew G. Knepley   ierr = PetscObjectDereference((PetscObject) old);CHKERRQ(ierr);
97969a2a23afSMatthew G. Knepley   if (!aux) {ierr = PetscHMapAuxDel(dm->auxData, key);CHKERRQ(ierr);}
97979a2a23afSMatthew G. Knepley   else      {ierr = PetscHMapAuxSet(dm->auxData, key, aux);CHKERRQ(ierr);}
97989a2a23afSMatthew G. Knepley   PetscFunctionReturn(0);
97999a2a23afSMatthew G. Knepley }
98009a2a23afSMatthew G. Knepley 
98019a2a23afSMatthew G. Knepley /*@C
98029a2a23afSMatthew G. Knepley   DMGetAuxiliaryLabels - Get the labels and values for all auxiliary vectors in this DM
98039a2a23afSMatthew G. Knepley 
98049a2a23afSMatthew G. Knepley   Not collective
98059a2a23afSMatthew G. Knepley 
98069a2a23afSMatthew G. Knepley   Input Parameter:
98079a2a23afSMatthew G. Knepley . dm      - The DM
98089a2a23afSMatthew G. Knepley 
98099a2a23afSMatthew G. Knepley   Output Parameters:
98109a2a23afSMatthew G. Knepley + labels  - The DMLabels for each Vec
98119a2a23afSMatthew G. Knepley - values  - The label values for each Vec
98129a2a23afSMatthew G. Knepley 
98139a2a23afSMatthew G. Knepley   Note: The arrays passed in must be at least as large as DMGetNumAuxiliaryVec().
98149a2a23afSMatthew G. Knepley 
98159a2a23afSMatthew G. Knepley   Level: advanced
98169a2a23afSMatthew G. Knepley 
98179a2a23afSMatthew G. Knepley .seealso: DMGetNumAuxiliaryVec(), DMGetAuxiliaryVec(), DMSetAuxiliaryVec()
98189a2a23afSMatthew G. Knepley @*/
98199a2a23afSMatthew G. Knepley PetscErrorCode DMGetAuxiliaryLabels(DM dm, DMLabel labels[], PetscInt values[])
98209a2a23afSMatthew G. Knepley {
98219a2a23afSMatthew G. Knepley   PetscHashAuxKey *keys;
98229a2a23afSMatthew G. Knepley   PetscInt         n, i, off = 0;
98239a2a23afSMatthew G. Knepley   PetscErrorCode   ierr;
98249a2a23afSMatthew G. Knepley 
98259a2a23afSMatthew G. Knepley   PetscFunctionBegin;
98269a2a23afSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
98279a2a23afSMatthew G. Knepley   PetscValidPointer(labels, 2);
98289a2a23afSMatthew G. Knepley   PetscValidPointer(values, 3);
98299a2a23afSMatthew G. Knepley   ierr = DMGetNumAuxiliaryVec(dm, &n);CHKERRQ(ierr);
98309a2a23afSMatthew G. Knepley   ierr = PetscMalloc1(n, &keys);CHKERRQ(ierr);
98319a2a23afSMatthew G. Knepley   ierr = PetscHMapAuxGetKeys(dm->auxData, &off, keys);CHKERRQ(ierr);
98329a2a23afSMatthew G. Knepley   for (i = 0; i < n; ++i) {labels[i] = keys[i].label; values[i] = keys[i].value;}
98339a2a23afSMatthew G. Knepley   ierr = PetscFree(keys);CHKERRQ(ierr);
98349a2a23afSMatthew G. Knepley   PetscFunctionReturn(0);
98359a2a23afSMatthew G. Knepley }
98369a2a23afSMatthew G. Knepley 
98379a2a23afSMatthew G. Knepley /*@
98389a2a23afSMatthew G. Knepley   DMCopyAuxiliaryVec - Copy the auxiliary data to a new DM
98399a2a23afSMatthew G. Knepley 
98409a2a23afSMatthew G. Knepley   Not collective
98419a2a23afSMatthew G. Knepley 
98429a2a23afSMatthew G. Knepley   Input Parameter:
98439a2a23afSMatthew G. Knepley . dm    - The DM
98449a2a23afSMatthew G. Knepley 
98459a2a23afSMatthew G. Knepley   Output Parameter:
98469a2a23afSMatthew G. Knepley . dmNew - The new DM, now with the same auxiliary data
98479a2a23afSMatthew G. Knepley 
98489a2a23afSMatthew G. Knepley   Level: advanced
98499a2a23afSMatthew G. Knepley 
98509a2a23afSMatthew G. Knepley .seealso: DMGetNumAuxiliaryVec(), DMGetAuxiliaryVec(), DMSetAuxiliaryVec()
98519a2a23afSMatthew G. Knepley @*/
98529a2a23afSMatthew G. Knepley PetscErrorCode DMCopyAuxiliaryVec(DM dm, DM dmNew)
98539a2a23afSMatthew G. Knepley {
98549a2a23afSMatthew G. Knepley   PetscErrorCode ierr;
98559a2a23afSMatthew G. Knepley 
98569a2a23afSMatthew G. Knepley   PetscFunctionBegin;
98579a2a23afSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
98589a2a23afSMatthew G. Knepley   ierr = PetscHMapAuxDestroy(&dmNew->auxData);CHKERRQ(ierr);
98599a2a23afSMatthew G. Knepley   ierr = PetscHMapAuxDuplicate(dm->auxData, &dmNew->auxData);CHKERRQ(ierr);
98609a2a23afSMatthew G. Knepley   PetscFunctionReturn(0);
98619a2a23afSMatthew G. Knepley }
9862b5a892a1SMatthew G. Knepley 
9863b5a892a1SMatthew G. Knepley /*@C
9864b5a892a1SMatthew G. Knepley   DMPolytopeMatchOrientation - Determine an orientation that takes the source face arrangement to the target face arrangement
9865b5a892a1SMatthew G. Knepley 
9866b5a892a1SMatthew G. Knepley   Not collective
9867b5a892a1SMatthew G. Knepley 
9868b5a892a1SMatthew G. Knepley   Input Parameters:
9869b5a892a1SMatthew G. Knepley + ct         - The DMPolytopeType
9870b5a892a1SMatthew G. Knepley . sourceCone - The source arrangement of faces
9871b5a892a1SMatthew G. Knepley - targetCone - The target arrangement of faces
9872b5a892a1SMatthew G. Knepley 
9873b5a892a1SMatthew G. Knepley   Output Parameters:
9874b5a892a1SMatthew G. Knepley + ornt  - The orientation which will take the source arrangement to the target arrangement
9875b5a892a1SMatthew G. Knepley - found - Flag indicating that a suitable orientation was found
9876b5a892a1SMatthew G. Knepley 
9877b5a892a1SMatthew G. Knepley   Level: advanced
9878b5a892a1SMatthew G. Knepley 
9879b5a892a1SMatthew G. Knepley .seealso: DMPolytopeGetOrientation(), DMPolytopeMatchVertexOrientation()
9880b5a892a1SMatthew G. Knepley @*/
9881b5a892a1SMatthew G. Knepley PetscErrorCode DMPolytopeMatchOrientation(DMPolytopeType ct, const PetscInt sourceCone[], const PetscInt targetCone[], PetscInt *ornt, PetscBool *found)
9882b5a892a1SMatthew G. Knepley {
9883b5a892a1SMatthew G. Knepley   const PetscInt cS = DMPolytopeTypeGetConeSize(ct);
9884b5a892a1SMatthew G. Knepley   const PetscInt nO = DMPolytopeTypeGetNumArrangments(ct)/2;
9885b5a892a1SMatthew G. Knepley   PetscInt       o, c;
9886b5a892a1SMatthew G. Knepley 
9887b5a892a1SMatthew G. Knepley   PetscFunctionBegin;
9888b5a892a1SMatthew G. Knepley   if (!nO) {*ornt = 0; *found = PETSC_TRUE; PetscFunctionReturn(0);}
9889b5a892a1SMatthew G. Knepley   for (o = -nO; o < nO; ++o) {
9890b5a892a1SMatthew G. Knepley     const PetscInt *arr = DMPolytopeTypeGetArrangment(ct, o);
9891b5a892a1SMatthew G. Knepley 
9892b5a892a1SMatthew G. Knepley     for (c = 0; c < cS; ++c) if (sourceCone[arr[c*2]] != targetCone[c]) break;
9893b5a892a1SMatthew G. Knepley     if (c == cS) {*ornt = o; break;}
9894b5a892a1SMatthew G. Knepley   }
9895b5a892a1SMatthew G. Knepley   *found = o == nO ? PETSC_FALSE : PETSC_TRUE;
9896b5a892a1SMatthew G. Knepley   PetscFunctionReturn(0);
9897b5a892a1SMatthew G. Knepley }
9898b5a892a1SMatthew G. Knepley 
9899b5a892a1SMatthew G. Knepley /*@C
9900b5a892a1SMatthew G. Knepley   DMPolytopeGetOrientation - Determine an orientation that takes the source face arrangement to the target face arrangement
9901b5a892a1SMatthew G. Knepley 
9902b5a892a1SMatthew G. Knepley   Not collective
9903b5a892a1SMatthew G. Knepley 
9904b5a892a1SMatthew G. Knepley   Input Parameters:
9905b5a892a1SMatthew G. Knepley + ct         - The DMPolytopeType
9906b5a892a1SMatthew G. Knepley . sourceCone - The source arrangement of faces
9907b5a892a1SMatthew G. Knepley - targetCone - The target arrangement of faces
9908b5a892a1SMatthew G. Knepley 
9909b5a892a1SMatthew G. Knepley   Output Parameters:
9910b5a892a1SMatthew G. Knepley . ornt  - The orientation which will take the source arrangement to the target arrangement
9911b5a892a1SMatthew G. Knepley 
9912b5a892a1SMatthew G. Knepley   Note: This function will fail if no suitable orientation can be found.
9913b5a892a1SMatthew G. Knepley 
9914b5a892a1SMatthew G. Knepley   Level: advanced
9915b5a892a1SMatthew G. Knepley 
9916b5a892a1SMatthew G. Knepley .seealso: DMPolytopeMatchOrientation(), DMPolytopeGetVertexOrientation()
9917b5a892a1SMatthew G. Knepley @*/
9918b5a892a1SMatthew G. Knepley PetscErrorCode DMPolytopeGetOrientation(DMPolytopeType ct, const PetscInt sourceCone[], const PetscInt targetCone[], PetscInt *ornt)
9919b5a892a1SMatthew G. Knepley {
9920b5a892a1SMatthew G. Knepley   PetscBool      found;
9921b5a892a1SMatthew G. Knepley   PetscErrorCode ierr;
9922b5a892a1SMatthew G. Knepley 
9923b5a892a1SMatthew G. Knepley   PetscFunctionBegin;
9924b5a892a1SMatthew G. Knepley   ierr = DMPolytopeMatchOrientation(ct, sourceCone, targetCone, ornt, &found);CHKERRQ(ierr);
9925b5a892a1SMatthew G. Knepley   if (!found) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Could not find orientation for %s", DMPolytopeTypes[ct]);
9926b5a892a1SMatthew G. Knepley   PetscFunctionReturn(0);
9927b5a892a1SMatthew G. Knepley }
9928b5a892a1SMatthew G. Knepley 
9929b5a892a1SMatthew G. Knepley /*@C
9930b5a892a1SMatthew G. Knepley   DMPolytopeMatchVertexOrientation - Determine an orientation that takes the source vertex arrangement to the target vertex arrangement
9931b5a892a1SMatthew G. Knepley 
9932b5a892a1SMatthew G. Knepley   Not collective
9933b5a892a1SMatthew G. Knepley 
9934b5a892a1SMatthew G. Knepley   Input Parameters:
9935b5a892a1SMatthew G. Knepley + ct         - The DMPolytopeType
9936b5a892a1SMatthew G. Knepley . sourceVert - The source arrangement of vertices
9937b5a892a1SMatthew G. Knepley - targetVert - The target arrangement of vertices
9938b5a892a1SMatthew G. Knepley 
9939b5a892a1SMatthew G. Knepley   Output Parameters:
9940b5a892a1SMatthew G. Knepley + ornt  - The orientation which will take the source arrangement to the target arrangement
9941b5a892a1SMatthew G. Knepley - found - Flag indicating that a suitable orientation was found
9942b5a892a1SMatthew G. Knepley 
9943b5a892a1SMatthew G. Knepley   Level: advanced
9944b5a892a1SMatthew G. Knepley 
9945b5a892a1SMatthew G. Knepley .seealso: DMPolytopeGetOrientation(), DMPolytopeMatchOrientation()
9946b5a892a1SMatthew G. Knepley @*/
9947b5a892a1SMatthew G. Knepley PetscErrorCode DMPolytopeMatchVertexOrientation(DMPolytopeType ct, const PetscInt sourceVert[], const PetscInt targetVert[], PetscInt *ornt, PetscBool *found)
9948b5a892a1SMatthew G. Knepley {
9949b5a892a1SMatthew G. Knepley   const PetscInt cS = DMPolytopeTypeGetNumVertices(ct);
9950b5a892a1SMatthew G. Knepley   const PetscInt nO = DMPolytopeTypeGetNumArrangments(ct)/2;
9951b5a892a1SMatthew G. Knepley   PetscInt       o, c;
9952b5a892a1SMatthew G. Knepley 
9953b5a892a1SMatthew G. Knepley   PetscFunctionBegin;
9954b5a892a1SMatthew G. Knepley   if (!nO) {*ornt = 0; *found = PETSC_TRUE; PetscFunctionReturn(0);}
9955b5a892a1SMatthew G. Knepley   for (o = -nO; o < nO; ++o) {
9956b5a892a1SMatthew G. Knepley     const PetscInt *arr = DMPolytopeTypeGetVertexArrangment(ct, o);
9957b5a892a1SMatthew G. Knepley 
9958b5a892a1SMatthew G. Knepley     for (c = 0; c < cS; ++c) if (sourceVert[arr[c]] != targetVert[c]) break;
9959b5a892a1SMatthew G. Knepley     if (c == cS) {*ornt = o; break;}
9960b5a892a1SMatthew G. Knepley   }
9961b5a892a1SMatthew G. Knepley   *found = o == nO ? PETSC_FALSE : PETSC_TRUE;
9962b5a892a1SMatthew G. Knepley   PetscFunctionReturn(0);
9963b5a892a1SMatthew G. Knepley }
9964b5a892a1SMatthew G. Knepley 
9965b5a892a1SMatthew G. Knepley /*@C
9966b5a892a1SMatthew G. Knepley   DMPolytopeGetVertexOrientation - Determine an orientation that takes the source vertex arrangement to the target vertex arrangement
9967b5a892a1SMatthew G. Knepley 
9968b5a892a1SMatthew G. Knepley   Not collective
9969b5a892a1SMatthew G. Knepley 
9970b5a892a1SMatthew G. Knepley   Input Parameters:
9971b5a892a1SMatthew G. Knepley + ct         - The DMPolytopeType
9972b5a892a1SMatthew G. Knepley . sourceCone - The source arrangement of vertices
9973b5a892a1SMatthew G. Knepley - targetCone - The target arrangement of vertices
9974b5a892a1SMatthew G. Knepley 
9975b5a892a1SMatthew G. Knepley   Output Parameters:
9976b5a892a1SMatthew G. Knepley . ornt  - The orientation which will take the source arrangement to the target arrangement
9977b5a892a1SMatthew G. Knepley 
9978b5a892a1SMatthew G. Knepley   Note: This function will fail if no suitable orientation can be found.
9979b5a892a1SMatthew G. Knepley 
9980b5a892a1SMatthew G. Knepley   Level: advanced
9981b5a892a1SMatthew G. Knepley 
9982b5a892a1SMatthew G. Knepley .seealso: DMPolytopeMatchVertexOrientation(), DMPolytopeGetOrientation()
9983b5a892a1SMatthew G. Knepley @*/
9984b5a892a1SMatthew G. Knepley PetscErrorCode DMPolytopeGetVertexOrientation(DMPolytopeType ct, const PetscInt sourceCone[], const PetscInt targetCone[], PetscInt *ornt)
9985b5a892a1SMatthew G. Knepley {
9986b5a892a1SMatthew G. Knepley   PetscBool      found;
9987b5a892a1SMatthew G. Knepley   PetscErrorCode ierr;
9988b5a892a1SMatthew G. Knepley 
9989b5a892a1SMatthew G. Knepley   PetscFunctionBegin;
9990b5a892a1SMatthew G. Knepley   ierr = DMPolytopeMatchVertexOrientation(ct, sourceCone, targetCone, ornt, &found);CHKERRQ(ierr);
9991b5a892a1SMatthew G. Knepley   if (!found) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Could not find orientation for %s", DMPolytopeTypes[ct]);
9992b5a892a1SMatthew G. Knepley   PetscFunctionReturn(0);
9993b5a892a1SMatthew G. Knepley }
9994012bc364SMatthew G. Knepley 
9995012bc364SMatthew G. Knepley /*@C
9996012bc364SMatthew G. Knepley   DMPolytopeInCellTest - Check whether a point lies inside the reference cell of given type
9997012bc364SMatthew G. Knepley 
9998012bc364SMatthew G. Knepley   Not collective
9999012bc364SMatthew G. Knepley 
10000012bc364SMatthew G. Knepley   Input Parameters:
10001012bc364SMatthew G. Knepley + ct    - The DMPolytopeType
10002012bc364SMatthew G. Knepley - point - Coordinates of the point
10003012bc364SMatthew G. Knepley 
10004012bc364SMatthew G. Knepley   Output Parameters:
10005012bc364SMatthew G. Knepley . inside  - Flag indicating whether the point is inside the reference cell of given type
10006012bc364SMatthew G. Knepley 
10007012bc364SMatthew G. Knepley   Level: advanced
10008012bc364SMatthew G. Knepley 
10009012bc364SMatthew G. Knepley .seealso: DMLocatePoints()
10010012bc364SMatthew G. Knepley @*/
10011012bc364SMatthew G. Knepley PetscErrorCode DMPolytopeInCellTest(DMPolytopeType ct, const PetscReal point[], PetscBool *inside)
10012012bc364SMatthew G. Knepley {
10013012bc364SMatthew G. Knepley   PetscReal sum = 0.0;
10014012bc364SMatthew G. Knepley   PetscInt  d;
10015012bc364SMatthew G. Knepley 
10016012bc364SMatthew G. Knepley   PetscFunctionBegin;
10017012bc364SMatthew G. Knepley   *inside = PETSC_TRUE;
10018012bc364SMatthew G. Knepley   switch (ct) {
10019012bc364SMatthew G. Knepley   case DM_POLYTOPE_TRIANGLE:
10020012bc364SMatthew G. Knepley   case DM_POLYTOPE_TETRAHEDRON:
10021012bc364SMatthew G. Knepley     for (d = 0; d < DMPolytopeTypeGetDim(ct); ++d) {
10022012bc364SMatthew G. Knepley       if (point[d] < -1.0) {*inside = PETSC_FALSE; break;}
10023012bc364SMatthew G. Knepley       sum += point[d];
10024012bc364SMatthew G. Knepley     }
10025012bc364SMatthew G. Knepley     if (sum > PETSC_SMALL) {*inside = PETSC_FALSE; break;}
10026012bc364SMatthew G. Knepley     break;
10027012bc364SMatthew G. Knepley   case DM_POLYTOPE_QUADRILATERAL:
10028012bc364SMatthew G. Knepley   case DM_POLYTOPE_HEXAHEDRON:
10029012bc364SMatthew G. Knepley     for (d = 0; d < DMPolytopeTypeGetDim(ct); ++d)
10030012bc364SMatthew G. Knepley       if (PetscAbsReal(point[d]) > 1.+PETSC_SMALL) {*inside = PETSC_FALSE; break;}
10031012bc364SMatthew G. Knepley     break;
10032012bc364SMatthew G. Knepley   default:
10033012bc364SMatthew G. Knepley     SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Unsupported polytope type %s", DMPolytopeTypes[ct]);
10034012bc364SMatthew G. Knepley   }
10035012bc364SMatthew G. Knepley   PetscFunctionReturn(0);
10036012bc364SMatthew G. Knepley }
10037