xref: /petsc/src/dm/interface/dm.c (revision 012bc3648b56b7befe35b618b2ec944650f76ae7)
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 
4639a42bb27SBarry Smith    Input Parameter:
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 
93847c6ae99SBarry Smith     Input Parameter:
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 
116847c6ae99SBarry Smith     Input Parameter:
1169a5bc1bf3SBarry Smith +   dmc - the DM object
1170a5bc1bf3SBarry Smith -   dmf - the second, finer DM object
117147c6ae99SBarry Smith 
117247c6ae99SBarry Smith     Output Parameter:
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 
12403ad4599aSBarry Smith     Input Parameter:
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 
127647c6ae99SBarry Smith     Input Parameter:
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 
1312bd041c0cSMatthew G. Knepley   Input Parameter:
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 
134147c6ae99SBarry Smith     Input Parameter:
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 
1452732e2eb9SMatthew G Knepley   Input Parameter:
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 
1477b06ff27eSHong Zhang   Input Parameter:
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
1499aa1993deSMatthew G Knepley . count - The minium 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
1547aa1993deSMatthew G Knepley . count - The minium 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 
19572adcc780SMatthew G. Knepley   Input Parameter:
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:
2064e30e807fSPeter Brune + n     - the number of scatters returned
2065e30e807fSPeter Brune . iscat - scatter from global vector to nonoverlapping global vector entries on subdomain
2066e30e807fSPeter Brune . oscat - scatter from global vector to overlapping global vector entries on subdomain
2067e30e807fSPeter Brune - gscat - scatter from global vector to local vector on subdomain (fills in ghosts)
2068e30e807fSPeter Brune 
206995452b02SPatrick Sanan   Notes:
207095452b02SPatrick Sanan     This is an alternative to the iis and ois arguments in DMCreateDomainDecomposition that allow for the solution
2071e30e807fSPeter Brune   of general nonlinear problems with overlapping subdomain methods.  While merely having index sets that enable subsets
2072e30e807fSPeter Brune   of the residual equations to be created is fine for linear problems, nonlinear problems require local assembly of
2073e30e807fSPeter Brune   solution and residual data.
2074e30e807fSPeter Brune 
2075e30e807fSPeter Brune   Level: developer
2076e30e807fSPeter Brune 
2077e30e807fSPeter Brune .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS()
2078e30e807fSPeter Brune @*/
2079e30e807fSPeter Brune PetscErrorCode DMCreateDomainDecompositionScatters(DM dm,PetscInt n,DM *subdms,VecScatter **iscat,VecScatter **oscat,VecScatter **gscat)
2080e30e807fSPeter Brune {
2081e30e807fSPeter Brune   PetscErrorCode ierr;
2082e30e807fSPeter Brune 
2083e30e807fSPeter Brune   PetscFunctionBegin;
2084e30e807fSPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2085e30e807fSPeter Brune   PetscValidPointer(subdms,3);
2086b9d85ea2SLisandro Dalcin   if (!dm->ops->createddscatters) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateDomainDecompositionScatters",((PetscObject)dm)->type_name);
2087e30e807fSPeter Brune   ierr = (*dm->ops->createddscatters)(dm,n,subdms,iscat,oscat,gscat);CHKERRQ(ierr);
2088e7c4fc90SDmitry Karpeev   PetscFunctionReturn(0);
2089e7c4fc90SDmitry Karpeev }
2090e7c4fc90SDmitry Karpeev 
209147c6ae99SBarry Smith /*@
209247c6ae99SBarry Smith   DMRefine - Refines a DM object
209347c6ae99SBarry Smith 
2094d083f849SBarry Smith   Collective on dm
209547c6ae99SBarry Smith 
209647c6ae99SBarry Smith   Input Parameter:
209747c6ae99SBarry Smith + dm   - the DM object
209891d95f02SJed Brown - comm - the communicator to contain the new DM object (or MPI_COMM_NULL)
209947c6ae99SBarry Smith 
210047c6ae99SBarry Smith   Output Parameter:
21010298fd71SBarry Smith . dmf - the refined DM, or NULL
2102ae0a1c52SMatthew G Knepley 
2103f27dd7c6SMatthew G. Knepley   Options Database Keys:
2104412e9a14SMatthew G. Knepley . -dm_plex_cell_refiner <strategy> - chooses the refinement strategy, e.g. regular, tohex
2105412e9a14SMatthew G. Knepley 
21060298fd71SBarry Smith   Note: If no refinement was done, the return value is NULL
210747c6ae99SBarry Smith 
210847c6ae99SBarry Smith   Level: developer
210947c6ae99SBarry Smith 
2110e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
211147c6ae99SBarry Smith @*/
21127087cfbeSBarry Smith PetscErrorCode  DMRefine(DM dm,MPI_Comm comm,DM *dmf)
211347c6ae99SBarry Smith {
211447c6ae99SBarry Smith   PetscErrorCode   ierr;
2115c833c3b5SJed Brown   DMRefineHookLink link;
211647c6ae99SBarry Smith 
211747c6ae99SBarry Smith   PetscFunctionBegin;
2118732e2eb9SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2119b9d85ea2SLisandro Dalcin   if (!dm->ops->refine) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMRefine",((PetscObject)dm)->type_name);
21201ac00216SMatthew G. Knepley   ierr = PetscLogEventBegin(DM_Refine,dm,0,0,0);CHKERRQ(ierr);
212147c6ae99SBarry Smith   ierr = (*dm->ops->refine)(dm,comm,dmf);CHKERRQ(ierr);
21224057135bSMatthew G Knepley   if (*dmf) {
212343842a1eSJed Brown     (*dmf)->ops->creatematrix = dm->ops->creatematrix;
21248865f1eaSKarl Rupp 
21258cd211a4SJed Brown     ierr = PetscObjectCopyFortranFunctionPointers((PetscObject)dm,(PetscObject)*dmf);CHKERRQ(ierr);
21268865f1eaSKarl Rupp 
2127644e2e5bSBarry Smith     (*dmf)->ctx       = dm->ctx;
21280598a293SJed Brown     (*dmf)->leveldown = dm->leveldown;
2129656b349aSBarry Smith     (*dmf)->levelup   = dm->levelup + 1;
21308865f1eaSKarl Rupp 
2131e4b4b23bSJed Brown     ierr = DMSetMatType(*dmf,dm->mattype);CHKERRQ(ierr);
2132c833c3b5SJed Brown     for (link=dm->refinehook; link; link=link->next) {
21338865f1eaSKarl Rupp       if (link->refinehook) {
21348865f1eaSKarl Rupp         ierr = (*link->refinehook)(dm,*dmf,link->ctx);CHKERRQ(ierr);
21358865f1eaSKarl Rupp       }
2136c833c3b5SJed Brown     }
2137c833c3b5SJed Brown   }
21381ac00216SMatthew G. Knepley   ierr = PetscLogEventEnd(DM_Refine,dm,0,0,0);CHKERRQ(ierr);
2139c833c3b5SJed Brown   PetscFunctionReturn(0);
2140c833c3b5SJed Brown }
2141c833c3b5SJed Brown 
2142bb9467b5SJed Brown /*@C
2143c833c3b5SJed Brown    DMRefineHookAdd - adds a callback to be run when interpolating a nonlinear problem to a finer grid
2144c833c3b5SJed Brown 
2145c833c3b5SJed Brown    Logically Collective
2146c833c3b5SJed Brown 
2147c833c3b5SJed Brown    Input Arguments:
2148c833c3b5SJed Brown +  coarse - nonlinear solver context on which to run a hook when restricting to a coarser level
2149c833c3b5SJed Brown .  refinehook - function to run when setting up a coarser level
2150c833c3b5SJed Brown .  interphook - function to run to update data on finer levels (once per SNESSolve())
21510298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
2152c833c3b5SJed Brown 
2153c833c3b5SJed Brown    Calling sequence of refinehook:
2154c833c3b5SJed Brown $    refinehook(DM coarse,DM fine,void *ctx);
2155c833c3b5SJed Brown 
2156c833c3b5SJed Brown +  coarse - coarse level DM
2157c833c3b5SJed Brown .  fine - fine level DM to interpolate problem to
2158c833c3b5SJed Brown -  ctx - optional user-defined function context
2159c833c3b5SJed Brown 
2160c833c3b5SJed Brown    Calling sequence for interphook:
2161c833c3b5SJed Brown $    interphook(DM coarse,Mat interp,DM fine,void *ctx)
2162c833c3b5SJed Brown 
2163c833c3b5SJed Brown +  coarse - coarse level DM
2164c833c3b5SJed Brown .  interp - matrix interpolating a coarse-level solution to the finer grid
2165c833c3b5SJed Brown .  fine - fine level DM to update
2166c833c3b5SJed Brown -  ctx - optional user-defined function context
2167c833c3b5SJed Brown 
2168c833c3b5SJed Brown    Level: advanced
2169c833c3b5SJed Brown 
2170c833c3b5SJed Brown    Notes:
2171c833c3b5SJed Brown    This function is only needed if auxiliary data needs to be passed to fine grids while grid sequencing
2172c833c3b5SJed Brown 
2173c833c3b5SJed Brown    If this function is called multiple times, the hooks will be run in the order they are added.
2174c833c3b5SJed Brown 
2175bb9467b5SJed Brown    This function is currently not available from Fortran.
2176bb9467b5SJed Brown 
2177c833c3b5SJed Brown .seealso: DMCoarsenHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
2178c833c3b5SJed Brown @*/
2179c833c3b5SJed Brown PetscErrorCode DMRefineHookAdd(DM coarse,PetscErrorCode (*refinehook)(DM,DM,void*),PetscErrorCode (*interphook)(DM,Mat,DM,void*),void *ctx)
2180c833c3b5SJed Brown {
2181c833c3b5SJed Brown   PetscErrorCode   ierr;
2182c833c3b5SJed Brown   DMRefineHookLink link,*p;
2183c833c3b5SJed Brown 
2184c833c3b5SJed Brown   PetscFunctionBegin;
2185c833c3b5SJed Brown   PetscValidHeaderSpecific(coarse,DM_CLASSID,1);
21863d8e3701SJed Brown   for (p=&coarse->refinehook; *p; p=&(*p)->next) { /* Scan to the end of the current list of hooks */
21873d8e3701SJed Brown     if ((*p)->refinehook == refinehook && (*p)->interphook == interphook && (*p)->ctx == ctx) PetscFunctionReturn(0);
21883d8e3701SJed Brown   }
218995dccacaSBarry Smith   ierr             = PetscNew(&link);CHKERRQ(ierr);
2190c833c3b5SJed Brown   link->refinehook = refinehook;
2191c833c3b5SJed Brown   link->interphook = interphook;
2192c833c3b5SJed Brown   link->ctx        = ctx;
21930298fd71SBarry Smith   link->next       = NULL;
2194c833c3b5SJed Brown   *p               = link;
2195c833c3b5SJed Brown   PetscFunctionReturn(0);
2196c833c3b5SJed Brown }
2197c833c3b5SJed Brown 
21983d8e3701SJed Brown /*@C
21993d8e3701SJed Brown    DMRefineHookRemove - remove a callback from the list of hooks to be run when interpolating a nonlinear problem to a finer grid
22003d8e3701SJed Brown 
22013d8e3701SJed Brown    Logically Collective
22023d8e3701SJed Brown 
22033d8e3701SJed Brown    Input Arguments:
22043d8e3701SJed Brown +  coarse - nonlinear solver context on which to run a hook when restricting to a coarser level
22053d8e3701SJed Brown .  refinehook - function to run when setting up a coarser level
22063d8e3701SJed Brown .  interphook - function to run to update data on finer levels (once per SNESSolve())
22073d8e3701SJed Brown -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
22083d8e3701SJed Brown 
22093d8e3701SJed Brown    Level: advanced
22103d8e3701SJed Brown 
22113d8e3701SJed Brown    Notes:
22123d8e3701SJed Brown    This function does nothing if the hook is not in the list.
22133d8e3701SJed Brown 
22143d8e3701SJed Brown    This function is currently not available from Fortran.
22153d8e3701SJed Brown 
22163d8e3701SJed Brown .seealso: DMCoarsenHookRemove(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
22173d8e3701SJed Brown @*/
22183d8e3701SJed Brown PetscErrorCode DMRefineHookRemove(DM coarse,PetscErrorCode (*refinehook)(DM,DM,void*),PetscErrorCode (*interphook)(DM,Mat,DM,void*),void *ctx)
22193d8e3701SJed Brown {
22203d8e3701SJed Brown   PetscErrorCode   ierr;
22213d8e3701SJed Brown   DMRefineHookLink link,*p;
22223d8e3701SJed Brown 
22233d8e3701SJed Brown   PetscFunctionBegin;
22243d8e3701SJed Brown   PetscValidHeaderSpecific(coarse,DM_CLASSID,1);
22253d8e3701SJed Brown   for (p=&coarse->refinehook; *p; p=&(*p)->next) { /* Search the list of current hooks */
22263d8e3701SJed Brown     if ((*p)->refinehook == refinehook && (*p)->interphook == interphook && (*p)->ctx == ctx) {
22273d8e3701SJed Brown       link = *p;
22283d8e3701SJed Brown       *p = link->next;
22293d8e3701SJed Brown       ierr = PetscFree(link);CHKERRQ(ierr);
22303d8e3701SJed Brown       break;
22313d8e3701SJed Brown     }
22323d8e3701SJed Brown   }
22333d8e3701SJed Brown   PetscFunctionReturn(0);
22343d8e3701SJed Brown }
22353d8e3701SJed Brown 
2236c833c3b5SJed Brown /*@
2237c833c3b5SJed Brown    DMInterpolate - interpolates user-defined problem data to a finer DM by running hooks registered by DMRefineHookAdd()
2238c833c3b5SJed Brown 
2239c833c3b5SJed Brown    Collective if any hooks are
2240c833c3b5SJed Brown 
2241c833c3b5SJed Brown    Input Arguments:
2242c833c3b5SJed Brown +  coarse - coarser DM to use as a base
2243e91eccc2SStefano Zampini .  interp - interpolation matrix, apply using MatInterpolate()
2244c833c3b5SJed Brown -  fine - finer DM to update
2245c833c3b5SJed Brown 
2246c833c3b5SJed Brown    Level: developer
2247c833c3b5SJed Brown 
2248c833c3b5SJed Brown .seealso: DMRefineHookAdd(), MatInterpolate()
2249c833c3b5SJed Brown @*/
2250c833c3b5SJed Brown PetscErrorCode DMInterpolate(DM coarse,Mat interp,DM fine)
2251c833c3b5SJed Brown {
2252c833c3b5SJed Brown   PetscErrorCode   ierr;
2253c833c3b5SJed Brown   DMRefineHookLink link;
2254c833c3b5SJed Brown 
2255c833c3b5SJed Brown   PetscFunctionBegin;
2256c833c3b5SJed Brown   for (link=fine->refinehook; link; link=link->next) {
22578865f1eaSKarl Rupp     if (link->interphook) {
22588865f1eaSKarl Rupp       ierr = (*link->interphook)(coarse,interp,fine,link->ctx);CHKERRQ(ierr);
22598865f1eaSKarl Rupp     }
22604057135bSMatthew G Knepley   }
226147c6ae99SBarry Smith   PetscFunctionReturn(0);
226247c6ae99SBarry Smith }
226347c6ae99SBarry Smith 
2264eb3f98d2SBarry Smith /*@
22651f3379b2SToby Isaac    DMInterpolateSolution - Interpolates a solution from a coarse mesh to a fine mesh.
22661f3379b2SToby Isaac 
22671f3379b2SToby Isaac    Collective on DM
22681f3379b2SToby Isaac 
22691f3379b2SToby Isaac    Input Arguments:
22701f3379b2SToby Isaac +  coarse - coarse DM
22711f3379b2SToby Isaac .  fine   - fine DM
22721f3379b2SToby Isaac .  interp - (optional) the matrix computed by DMCreateInterpolation().  Implementations may not need this, but if it
22731f3379b2SToby Isaac             is available it can avoid some recomputation.  If it is provided, MatInterpolate() will be used if
22741f3379b2SToby Isaac             the coarse DM does not have a specialized implementation.
22751f3379b2SToby Isaac -  coarseSol - solution on the coarse mesh
22761f3379b2SToby Isaac 
22771f3379b2SToby Isaac    Output Arguments:
22781f3379b2SToby Isaac .  fineSol - the interpolation of coarseSol to the fine mesh
22791f3379b2SToby Isaac 
22801f3379b2SToby Isaac    Level: developer
22811f3379b2SToby Isaac 
22821f3379b2SToby Isaac    Note: This function exists because the interpolation of a solution vector between meshes is not always a linear
22831f3379b2SToby Isaac    map.  For example, if a boundary value problem has an inhomogeneous Dirichlet boundary condition that is compressed
22841f3379b2SToby Isaac    out of the solution vector.  Or if interpolation is inherently a nonlinear operation, such as a method using
22851f3379b2SToby Isaac    slope-limiting reconstruction.
22861f3379b2SToby Isaac 
22871f3379b2SToby Isaac .seealso DMInterpolate(), DMCreateInterpolation()
22881f3379b2SToby Isaac @*/
22891f3379b2SToby Isaac PetscErrorCode DMInterpolateSolution(DM coarse, DM fine, Mat interp, Vec coarseSol, Vec fineSol)
22901f3379b2SToby Isaac {
22911f3379b2SToby Isaac   PetscErrorCode (*interpsol)(DM,DM,Mat,Vec,Vec) = NULL;
22921f3379b2SToby Isaac   PetscErrorCode ierr;
22931f3379b2SToby Isaac 
22941f3379b2SToby Isaac   PetscFunctionBegin;
22951f3379b2SToby Isaac   PetscValidHeaderSpecific(coarse,DM_CLASSID,1);
22961f3379b2SToby Isaac   if (interp) PetscValidHeaderSpecific(interp,MAT_CLASSID,3);
22971f3379b2SToby Isaac   PetscValidHeaderSpecific(coarseSol,VEC_CLASSID,4);
22981f3379b2SToby Isaac   PetscValidHeaderSpecific(fineSol,VEC_CLASSID,5);
22991f3379b2SToby Isaac 
23001f3379b2SToby Isaac   ierr = PetscObjectQueryFunction((PetscObject)coarse,"DMInterpolateSolution_C", &interpsol);CHKERRQ(ierr);
23011f3379b2SToby Isaac   if (interpsol) {
23021f3379b2SToby Isaac     ierr = (*interpsol)(coarse, fine, interp, coarseSol, fineSol);CHKERRQ(ierr);
23031f3379b2SToby Isaac   } else if (interp) {
23041f3379b2SToby Isaac     ierr = MatInterpolate(interp, coarseSol, fineSol);CHKERRQ(ierr);
23051f3379b2SToby Isaac   } else SETERRQ1(PetscObjectComm((PetscObject)coarse), PETSC_ERR_SUP, "DM %s does not implement DMInterpolateSolution()", ((PetscObject)coarse)->type_name);
23061f3379b2SToby Isaac   PetscFunctionReturn(0);
23071f3379b2SToby Isaac }
23081f3379b2SToby Isaac 
23091f3379b2SToby Isaac /*@
2310aed49f88SRichard Tran Mills     DMGetRefineLevel - Gets the number of refinements that have generated this DM.
2311eb3f98d2SBarry Smith 
2312eb3f98d2SBarry Smith     Not Collective
2313eb3f98d2SBarry Smith 
2314eb3f98d2SBarry Smith     Input Parameter:
2315eb3f98d2SBarry Smith .   dm - the DM object
2316eb3f98d2SBarry Smith 
2317eb3f98d2SBarry Smith     Output Parameter:
2318eb3f98d2SBarry Smith .   level - number of refinements
2319eb3f98d2SBarry Smith 
2320eb3f98d2SBarry Smith     Level: developer
2321eb3f98d2SBarry Smith 
23226a7d9d85SPeter Brune .seealso DMCoarsen(), DMGetCoarsenLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
2323eb3f98d2SBarry Smith 
2324eb3f98d2SBarry Smith @*/
2325eb3f98d2SBarry Smith PetscErrorCode  DMGetRefineLevel(DM dm,PetscInt *level)
2326eb3f98d2SBarry Smith {
2327eb3f98d2SBarry Smith   PetscFunctionBegin;
2328eb3f98d2SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2329eb3f98d2SBarry Smith   *level = dm->levelup;
2330eb3f98d2SBarry Smith   PetscFunctionReturn(0);
2331eb3f98d2SBarry Smith }
2332eb3f98d2SBarry Smith 
2333fef3a512SBarry Smith /*@
2334aed49f88SRichard Tran Mills     DMSetRefineLevel - Sets the number of refinements that have generated this DM.
2335fef3a512SBarry Smith 
2336fef3a512SBarry Smith     Not Collective
2337fef3a512SBarry Smith 
2338fef3a512SBarry Smith     Input Parameter:
2339fef3a512SBarry Smith +   dm - the DM object
2340fef3a512SBarry Smith -   level - number of refinements
2341fef3a512SBarry Smith 
2342fef3a512SBarry Smith     Level: advanced
2343fef3a512SBarry Smith 
234495452b02SPatrick Sanan     Notes:
234595452b02SPatrick Sanan     This value is used by PCMG to determine how many multigrid levels to use
2346fef3a512SBarry Smith 
2347fef3a512SBarry Smith .seealso DMCoarsen(), DMGetCoarsenLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
2348fef3a512SBarry Smith 
2349fef3a512SBarry Smith @*/
2350fef3a512SBarry Smith PetscErrorCode  DMSetRefineLevel(DM dm,PetscInt level)
2351fef3a512SBarry Smith {
2352fef3a512SBarry Smith   PetscFunctionBegin;
2353fef3a512SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2354fef3a512SBarry Smith   dm->levelup = level;
2355fef3a512SBarry Smith   PetscFunctionReturn(0);
2356fef3a512SBarry Smith }
2357fef3a512SBarry Smith 
2358ca3d3a14SMatthew G. Knepley PetscErrorCode DMGetBasisTransformDM_Internal(DM dm, DM *tdm)
2359ca3d3a14SMatthew G. Knepley {
2360ca3d3a14SMatthew G. Knepley   PetscFunctionBegin;
2361ca3d3a14SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2362ca3d3a14SMatthew G. Knepley   PetscValidPointer(tdm, 2);
2363ca3d3a14SMatthew G. Knepley   *tdm = dm->transformDM;
2364ca3d3a14SMatthew G. Knepley   PetscFunctionReturn(0);
2365ca3d3a14SMatthew G. Knepley }
2366ca3d3a14SMatthew G. Knepley 
2367ca3d3a14SMatthew G. Knepley PetscErrorCode DMGetBasisTransformVec_Internal(DM dm, Vec *tv)
2368ca3d3a14SMatthew G. Knepley {
2369ca3d3a14SMatthew G. Knepley   PetscFunctionBegin;
2370ca3d3a14SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2371ca3d3a14SMatthew G. Knepley   PetscValidPointer(tv, 2);
2372ca3d3a14SMatthew G. Knepley   *tv = dm->transform;
2373ca3d3a14SMatthew G. Knepley   PetscFunctionReturn(0);
2374ca3d3a14SMatthew G. Knepley }
2375ca3d3a14SMatthew G. Knepley 
2376ca3d3a14SMatthew G. Knepley /*@
2377c0f8e1fdSMatthew G. Knepley   DMHasBasisTransform - Whether we employ a basis transformation from functions in global vectors to functions in local vectors
2378ca3d3a14SMatthew G. Knepley 
2379ca3d3a14SMatthew G. Knepley   Input Parameter:
2380ca3d3a14SMatthew G. Knepley . dm - The DM
2381ca3d3a14SMatthew G. Knepley 
2382ca3d3a14SMatthew G. Knepley   Output Parameter:
2383ca3d3a14SMatthew G. Knepley . flg - PETSC_TRUE if a basis transformation should be done
2384ca3d3a14SMatthew G. Knepley 
2385ca3d3a14SMatthew G. Knepley   Level: developer
2386ca3d3a14SMatthew G. Knepley 
2387436bc73aSJed Brown .seealso: DMPlexGlobalToLocalBasis(), DMPlexLocalToGlobalBasis(), DMPlexCreateBasisRotation()
2388ca3d3a14SMatthew G. Knepley @*/
2389ca3d3a14SMatthew G. Knepley PetscErrorCode DMHasBasisTransform(DM dm, PetscBool *flg)
2390ca3d3a14SMatthew G. Knepley {
2391ca3d3a14SMatthew G. Knepley   Vec            tv;
2392ca3d3a14SMatthew G. Knepley   PetscErrorCode ierr;
2393ca3d3a14SMatthew G. Knepley 
2394ca3d3a14SMatthew G. Knepley   PetscFunctionBegin;
2395ca3d3a14SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2396534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg, 2);
2397ca3d3a14SMatthew G. Knepley   ierr = DMGetBasisTransformVec_Internal(dm, &tv);CHKERRQ(ierr);
2398ca3d3a14SMatthew G. Knepley   *flg = tv ? PETSC_TRUE : PETSC_FALSE;
2399ca3d3a14SMatthew G. Knepley   PetscFunctionReturn(0);
2400ca3d3a14SMatthew G. Knepley }
2401ca3d3a14SMatthew G. Knepley 
2402ca3d3a14SMatthew G. Knepley PetscErrorCode DMConstructBasisTransform_Internal(DM dm)
2403ca3d3a14SMatthew G. Knepley {
2404ca3d3a14SMatthew G. Knepley   PetscSection   s, ts;
2405ca3d3a14SMatthew G. Knepley   PetscScalar   *ta;
2406ca3d3a14SMatthew G. Knepley   PetscInt       cdim, pStart, pEnd, p, Nf, f, Nc, dof;
2407ca3d3a14SMatthew G. Knepley   PetscErrorCode ierr;
2408ca3d3a14SMatthew G. Knepley 
2409ca3d3a14SMatthew G. Knepley   PetscFunctionBegin;
2410ca3d3a14SMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
241192fd8e1eSJed Brown   ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr);
2412ca3d3a14SMatthew G. Knepley   ierr = PetscSectionGetChart(s, &pStart, &pEnd);CHKERRQ(ierr);
2413ca3d3a14SMatthew G. Knepley   ierr = PetscSectionGetNumFields(s, &Nf);CHKERRQ(ierr);
2414ca3d3a14SMatthew G. Knepley   ierr = DMClone(dm, &dm->transformDM);CHKERRQ(ierr);
241592fd8e1eSJed Brown   ierr = DMGetLocalSection(dm->transformDM, &ts);CHKERRQ(ierr);
2416ca3d3a14SMatthew G. Knepley   ierr = PetscSectionSetNumFields(ts, Nf);CHKERRQ(ierr);
2417ca3d3a14SMatthew G. Knepley   ierr = PetscSectionSetChart(ts, pStart, pEnd);CHKERRQ(ierr);
2418ca3d3a14SMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
2419ca3d3a14SMatthew G. Knepley     ierr = PetscSectionGetFieldComponents(s, f, &Nc);CHKERRQ(ierr);
2420ca3d3a14SMatthew G. Knepley     /* We could start to label fields by their transformation properties */
2421ca3d3a14SMatthew G. Knepley     if (Nc != cdim) continue;
2422ca3d3a14SMatthew G. Knepley     for (p = pStart; p < pEnd; ++p) {
2423ca3d3a14SMatthew G. Knepley       ierr = PetscSectionGetFieldDof(s, p, f, &dof);CHKERRQ(ierr);
2424ca3d3a14SMatthew G. Knepley       if (!dof) continue;
2425ca3d3a14SMatthew G. Knepley       ierr = PetscSectionSetFieldDof(ts, p, f, PetscSqr(cdim));CHKERRQ(ierr);
2426ca3d3a14SMatthew G. Knepley       ierr = PetscSectionAddDof(ts, p, PetscSqr(cdim));CHKERRQ(ierr);
2427ca3d3a14SMatthew G. Knepley     }
2428ca3d3a14SMatthew G. Knepley   }
2429ca3d3a14SMatthew G. Knepley   ierr = PetscSectionSetUp(ts);CHKERRQ(ierr);
2430ca3d3a14SMatthew G. Knepley   ierr = DMCreateLocalVector(dm->transformDM, &dm->transform);CHKERRQ(ierr);
2431ca3d3a14SMatthew G. Knepley   ierr = VecGetArray(dm->transform, &ta);CHKERRQ(ierr);
2432ca3d3a14SMatthew G. Knepley   for (p = pStart; p < pEnd; ++p) {
2433ca3d3a14SMatthew G. Knepley     for (f = 0; f < Nf; ++f) {
2434ca3d3a14SMatthew G. Knepley       ierr = PetscSectionGetFieldDof(ts, p, f, &dof);CHKERRQ(ierr);
2435ca3d3a14SMatthew G. Knepley       if (dof) {
2436ca3d3a14SMatthew G. Knepley         PetscReal          x[3] = {0.0, 0.0, 0.0};
2437ca3d3a14SMatthew G. Knepley         PetscScalar       *tva;
2438ca3d3a14SMatthew G. Knepley         const PetscScalar *A;
2439ca3d3a14SMatthew G. Knepley 
2440ca3d3a14SMatthew G. Knepley         /* TODO Get quadrature point for this dual basis vector for coordinate */
2441ca3d3a14SMatthew G. Knepley         ierr = (*dm->transformGetMatrix)(dm, x, PETSC_TRUE, &A, dm->transformCtx);CHKERRQ(ierr);
2442ca3d3a14SMatthew G. Knepley         ierr = DMPlexPointLocalFieldRef(dm->transformDM, p, f, ta, (void *) &tva);CHKERRQ(ierr);
2443580bdb30SBarry Smith         ierr = PetscArraycpy(tva, A, PetscSqr(cdim));CHKERRQ(ierr);
2444ca3d3a14SMatthew G. Knepley       }
2445ca3d3a14SMatthew G. Knepley     }
2446ca3d3a14SMatthew G. Knepley   }
2447ca3d3a14SMatthew G. Knepley   ierr = VecRestoreArray(dm->transform, &ta);CHKERRQ(ierr);
2448ca3d3a14SMatthew G. Knepley   PetscFunctionReturn(0);
2449ca3d3a14SMatthew G. Knepley }
2450ca3d3a14SMatthew G. Knepley 
2451ca3d3a14SMatthew G. Knepley PetscErrorCode DMCopyTransform(DM dm, DM newdm)
2452ca3d3a14SMatthew G. Knepley {
2453ca3d3a14SMatthew G. Knepley   PetscErrorCode ierr;
2454ca3d3a14SMatthew G. Knepley 
2455ca3d3a14SMatthew G. Knepley   PetscFunctionBegin;
2456ca3d3a14SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2457ca3d3a14SMatthew G. Knepley   PetscValidHeaderSpecific(newdm, DM_CLASSID, 2);
2458ca3d3a14SMatthew G. Knepley   newdm->transformCtx       = dm->transformCtx;
2459ca3d3a14SMatthew G. Knepley   newdm->transformSetUp     = dm->transformSetUp;
2460ca3d3a14SMatthew G. Knepley   newdm->transformDestroy   = NULL;
2461ca3d3a14SMatthew G. Knepley   newdm->transformGetMatrix = dm->transformGetMatrix;
2462ca3d3a14SMatthew G. Knepley   if (newdm->transformSetUp) {ierr = DMConstructBasisTransform_Internal(newdm);CHKERRQ(ierr);}
2463ca3d3a14SMatthew G. Knepley   PetscFunctionReturn(0);
2464ca3d3a14SMatthew G. Knepley }
2465ca3d3a14SMatthew G. Knepley 
2466bb9467b5SJed Brown /*@C
2467baf369e7SPeter Brune    DMGlobalToLocalHookAdd - adds a callback to be run when global to local is called
2468baf369e7SPeter Brune 
2469baf369e7SPeter Brune    Logically Collective
2470baf369e7SPeter Brune 
2471baf369e7SPeter Brune    Input Arguments:
2472baf369e7SPeter Brune +  dm - the DM
2473baf369e7SPeter Brune .  beginhook - function to run at the beginning of DMGlobalToLocalBegin()
2474baf369e7SPeter Brune .  endhook - function to run after DMGlobalToLocalEnd() has completed
24750298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
2476baf369e7SPeter Brune 
2477baf369e7SPeter Brune    Calling sequence for beginhook:
2478baf369e7SPeter Brune $    beginhook(DM fine,VecScatter out,VecScatter in,DM coarse,void *ctx)
2479baf369e7SPeter Brune 
2480baf369e7SPeter Brune +  dm - global DM
2481baf369e7SPeter Brune .  g - global vector
2482baf369e7SPeter Brune .  mode - mode
2483baf369e7SPeter Brune .  l - local vector
2484baf369e7SPeter Brune -  ctx - optional user-defined function context
2485baf369e7SPeter Brune 
2486baf369e7SPeter Brune    Calling sequence for endhook:
2487ec4806b8SPeter Brune $    endhook(DM fine,VecScatter out,VecScatter in,DM coarse,void *ctx)
2488baf369e7SPeter Brune 
2489baf369e7SPeter Brune +  global - global DM
2490baf369e7SPeter Brune -  ctx - optional user-defined function context
2491baf369e7SPeter Brune 
2492baf369e7SPeter Brune    Level: advanced
2493baf369e7SPeter Brune 
2494baf369e7SPeter Brune .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
2495baf369e7SPeter Brune @*/
2496baf369e7SPeter Brune PetscErrorCode DMGlobalToLocalHookAdd(DM dm,PetscErrorCode (*beginhook)(DM,Vec,InsertMode,Vec,void*),PetscErrorCode (*endhook)(DM,Vec,InsertMode,Vec,void*),void *ctx)
2497baf369e7SPeter Brune {
2498baf369e7SPeter Brune   PetscErrorCode          ierr;
2499baf369e7SPeter Brune   DMGlobalToLocalHookLink link,*p;
2500baf369e7SPeter Brune 
2501baf369e7SPeter Brune   PetscFunctionBegin;
2502baf369e7SPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2503baf369e7SPeter Brune   for (p=&dm->gtolhook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */
250495dccacaSBarry Smith   ierr            = PetscNew(&link);CHKERRQ(ierr);
2505baf369e7SPeter Brune   link->beginhook = beginhook;
2506baf369e7SPeter Brune   link->endhook   = endhook;
2507baf369e7SPeter Brune   link->ctx       = ctx;
25080298fd71SBarry Smith   link->next      = NULL;
2509baf369e7SPeter Brune   *p              = link;
2510baf369e7SPeter Brune   PetscFunctionReturn(0);
2511baf369e7SPeter Brune }
2512baf369e7SPeter Brune 
25134c274da1SToby Isaac static PetscErrorCode DMGlobalToLocalHook_Constraints(DM dm, Vec g, InsertMode mode, Vec l, void *ctx)
25144c274da1SToby Isaac {
25154c274da1SToby Isaac   Mat cMat;
25164c274da1SToby Isaac   Vec cVec;
25174c274da1SToby Isaac   PetscSection section, cSec;
25184c274da1SToby Isaac   PetscInt pStart, pEnd, p, dof;
25194c274da1SToby Isaac   PetscErrorCode ierr;
25204c274da1SToby Isaac 
25214c274da1SToby Isaac   PetscFunctionBegin;
25224c274da1SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
25234c274da1SToby Isaac   ierr = DMGetDefaultConstraints(dm,&cSec,&cMat);CHKERRQ(ierr);
25244c274da1SToby Isaac   if (cMat && (mode == INSERT_VALUES || mode == INSERT_ALL_VALUES || mode == INSERT_BC_VALUES)) {
25255db9a05bSToby Isaac     PetscInt nRows;
25265db9a05bSToby Isaac 
25275db9a05bSToby Isaac     ierr = MatGetSize(cMat,&nRows,NULL);CHKERRQ(ierr);
25285db9a05bSToby Isaac     if (nRows <= 0) PetscFunctionReturn(0);
252992fd8e1eSJed Brown     ierr = DMGetLocalSection(dm,&section);CHKERRQ(ierr);
25307711e48fSToby Isaac     ierr = MatCreateVecs(cMat,NULL,&cVec);CHKERRQ(ierr);
25314c274da1SToby Isaac     ierr = MatMult(cMat,l,cVec);CHKERRQ(ierr);
25324c274da1SToby Isaac     ierr = PetscSectionGetChart(cSec,&pStart,&pEnd);CHKERRQ(ierr);
25334c274da1SToby Isaac     for (p = pStart; p < pEnd; p++) {
25344c274da1SToby Isaac       ierr = PetscSectionGetDof(cSec,p,&dof);CHKERRQ(ierr);
25354c274da1SToby Isaac       if (dof) {
25364c274da1SToby Isaac         PetscScalar *vals;
25374c274da1SToby Isaac         ierr = VecGetValuesSection(cVec,cSec,p,&vals);CHKERRQ(ierr);
25384c274da1SToby Isaac         ierr = VecSetValuesSection(l,section,p,vals,INSERT_ALL_VALUES);CHKERRQ(ierr);
25394c274da1SToby Isaac       }
25404c274da1SToby Isaac     }
25414c274da1SToby Isaac     ierr = VecDestroy(&cVec);CHKERRQ(ierr);
25424c274da1SToby Isaac   }
25434c274da1SToby Isaac   PetscFunctionReturn(0);
25444c274da1SToby Isaac }
25454c274da1SToby Isaac 
254647c6ae99SBarry Smith /*@
254701729b5cSPatrick Sanan     DMGlobalToLocal - update local vectors from global vector
254801729b5cSPatrick Sanan 
2549d083f849SBarry Smith     Neighbor-wise Collective on dm
255001729b5cSPatrick Sanan 
255101729b5cSPatrick Sanan     Input Parameters:
255201729b5cSPatrick Sanan +   dm - the DM object
255301729b5cSPatrick Sanan .   g - the global vector
255401729b5cSPatrick Sanan .   mode - INSERT_VALUES or ADD_VALUES
255501729b5cSPatrick Sanan -   l - the local vector
255601729b5cSPatrick Sanan 
255701729b5cSPatrick Sanan     Notes:
255801729b5cSPatrick Sanan     The communication involved in this update can be overlapped with computation by using
255901729b5cSPatrick Sanan     DMGlobalToLocalBegin() and DMGlobalToLocalEnd().
256001729b5cSPatrick Sanan 
256101729b5cSPatrick Sanan     Level: beginner
256201729b5cSPatrick Sanan 
256301729b5cSPatrick Sanan .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin(), DMLocalToGlobal(), DMLocalToGlobalBegin(), DMLocalToGlobalEnd()
256401729b5cSPatrick Sanan 
256501729b5cSPatrick Sanan @*/
256601729b5cSPatrick Sanan PetscErrorCode DMGlobalToLocal(DM dm,Vec g,InsertMode mode,Vec l)
256701729b5cSPatrick Sanan {
256801729b5cSPatrick Sanan   PetscErrorCode ierr;
256901729b5cSPatrick Sanan 
257001729b5cSPatrick Sanan   PetscFunctionBegin;
257101729b5cSPatrick Sanan   ierr = DMGlobalToLocalBegin(dm,g,mode,l);CHKERRQ(ierr);
257201729b5cSPatrick Sanan   ierr = DMGlobalToLocalEnd(dm,g,mode,l);CHKERRQ(ierr);
257301729b5cSPatrick Sanan   PetscFunctionReturn(0);
257401729b5cSPatrick Sanan }
257501729b5cSPatrick Sanan 
257601729b5cSPatrick Sanan /*@
257747c6ae99SBarry Smith     DMGlobalToLocalBegin - Begins updating local vectors from global vector
257847c6ae99SBarry Smith 
2579d083f849SBarry Smith     Neighbor-wise Collective on dm
258047c6ae99SBarry Smith 
258147c6ae99SBarry Smith     Input Parameters:
258247c6ae99SBarry Smith +   dm - the DM object
258347c6ae99SBarry Smith .   g - the global vector
258447c6ae99SBarry Smith .   mode - INSERT_VALUES or ADD_VALUES
258547c6ae99SBarry Smith -   l - the local vector
258647c6ae99SBarry Smith 
258701729b5cSPatrick Sanan     Level: intermediate
258847c6ae99SBarry Smith 
258901729b5cSPatrick Sanan .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin(), DMLocalToGlobal(), DMLocalToGlobalBegin(), DMLocalToGlobalEnd()
259047c6ae99SBarry Smith 
259147c6ae99SBarry Smith @*/
25927087cfbeSBarry Smith PetscErrorCode  DMGlobalToLocalBegin(DM dm,Vec g,InsertMode mode,Vec l)
259347c6ae99SBarry Smith {
25947128ae9fSMatthew G Knepley   PetscSF                 sf;
259547c6ae99SBarry Smith   PetscErrorCode          ierr;
2596baf369e7SPeter Brune   DMGlobalToLocalHookLink link;
259747c6ae99SBarry Smith 
259847c6ae99SBarry Smith   PetscFunctionBegin;
2599171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2600baf369e7SPeter Brune   for (link=dm->gtolhook; link; link=link->next) {
26018865f1eaSKarl Rupp     if (link->beginhook) {
26028865f1eaSKarl Rupp       ierr = (*link->beginhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);
26038865f1eaSKarl Rupp     }
2604baf369e7SPeter Brune   }
26051bb6d2a8SBarry Smith   ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr);
26067128ae9fSMatthew G Knepley   if (sf) {
2607ae5cfb4aSMatthew G. Knepley     const PetscScalar *gArray;
2608ae5cfb4aSMatthew G. Knepley     PetscScalar       *lArray;
2609d0295fc0SJunchao Zhang     PetscMemType      lmtype,gmtype;
26107128ae9fSMatthew G Knepley 
261182f516ccSBarry Smith     if (mode == ADD_VALUES) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
2612a256111fSJunchao Zhang     ierr = VecGetArrayAndMemType(l, &lArray, &lmtype);CHKERRQ(ierr);
2613a256111fSJunchao Zhang     ierr = VecGetArrayReadAndMemType(g, &gArray, &gmtype);CHKERRQ(ierr);
2614ad227feaSJunchao Zhang     ierr = PetscSFBcastWithMemTypeBegin(sf, MPIU_SCALAR, gmtype, gArray, lmtype, lArray, MPI_REPLACE);CHKERRQ(ierr);
2615a256111fSJunchao Zhang     ierr = VecRestoreArrayAndMemType(l, &lArray);CHKERRQ(ierr);
2616a256111fSJunchao Zhang     ierr = VecRestoreArrayReadAndMemType(g, &gArray);CHKERRQ(ierr);
26177128ae9fSMatthew G Knepley   } else {
261833907cc2SStefano Zampini     if (!dm->ops->globaltolocalbegin) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMGlobalToLocalBegin() for type %s",((PetscObject)dm)->type_name);
2619843c4018SMatthew G Knepley     ierr = (*dm->ops->globaltolocalbegin)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
26207128ae9fSMatthew G Knepley   }
262147c6ae99SBarry Smith   PetscFunctionReturn(0);
262247c6ae99SBarry Smith }
262347c6ae99SBarry Smith 
262447c6ae99SBarry Smith /*@
262547c6ae99SBarry Smith     DMGlobalToLocalEnd - Ends updating local vectors from global vector
262647c6ae99SBarry Smith 
2627d083f849SBarry Smith     Neighbor-wise Collective on dm
262847c6ae99SBarry Smith 
262947c6ae99SBarry Smith     Input Parameters:
263047c6ae99SBarry Smith +   dm - the DM object
263147c6ae99SBarry Smith .   g - the global vector
263247c6ae99SBarry Smith .   mode - INSERT_VALUES or ADD_VALUES
263347c6ae99SBarry Smith -   l - the local vector
263447c6ae99SBarry Smith 
263501729b5cSPatrick Sanan     Level: intermediate
263647c6ae99SBarry Smith 
263701729b5cSPatrick Sanan .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMLocalToGlobalBegin(), DMLocalToGlobal(), DMLocalToGlobalBegin(), DMLocalToGlobalEnd()
263847c6ae99SBarry Smith 
263947c6ae99SBarry Smith @*/
26407087cfbeSBarry Smith PetscErrorCode  DMGlobalToLocalEnd(DM dm,Vec g,InsertMode mode,Vec l)
264147c6ae99SBarry Smith {
26427128ae9fSMatthew G Knepley   PetscSF                 sf;
264347c6ae99SBarry Smith   PetscErrorCode          ierr;
2644ae5cfb4aSMatthew G. Knepley   const PetscScalar      *gArray;
2645ae5cfb4aSMatthew G. Knepley   PetscScalar            *lArray;
2646ca3d3a14SMatthew G. Knepley   PetscBool               transform;
2647baf369e7SPeter Brune   DMGlobalToLocalHookLink link;
2648d0295fc0SJunchao Zhang   PetscMemType            lmtype,gmtype;
264947c6ae99SBarry Smith 
265047c6ae99SBarry Smith   PetscFunctionBegin;
2651171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
26521bb6d2a8SBarry Smith   ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr);
2653ca3d3a14SMatthew G. Knepley   ierr = DMHasBasisTransform(dm, &transform);CHKERRQ(ierr);
26547128ae9fSMatthew G Knepley   if (sf) {
265582f516ccSBarry Smith     if (mode == ADD_VALUES) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
26567128ae9fSMatthew G Knepley 
2657a256111fSJunchao Zhang     ierr = VecGetArrayAndMemType(l, &lArray, &lmtype);CHKERRQ(ierr);
2658a256111fSJunchao Zhang     ierr = VecGetArrayReadAndMemType(g, &gArray, &gmtype);CHKERRQ(ierr);
2659ad227feaSJunchao Zhang     ierr = PetscSFBcastEnd(sf, MPIU_SCALAR, gArray, lArray,MPI_REPLACE);CHKERRQ(ierr);
2660a256111fSJunchao Zhang     ierr = VecRestoreArrayAndMemType(l, &lArray);CHKERRQ(ierr);
2661a256111fSJunchao Zhang     ierr = VecRestoreArrayReadAndMemType(g, &gArray);CHKERRQ(ierr);
2662ca3d3a14SMatthew G. Knepley     if (transform) {ierr = DMPlexGlobalToLocalBasis(dm, l);CHKERRQ(ierr);}
26637128ae9fSMatthew G Knepley   } else {
266433907cc2SStefano Zampini     if (!dm->ops->globaltolocalend) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMGlobalToLocalEnd() for type %s",((PetscObject)dm)->type_name);
2665843c4018SMatthew G Knepley     ierr = (*dm->ops->globaltolocalend)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
26667128ae9fSMatthew G Knepley   }
26674c274da1SToby Isaac   ierr = DMGlobalToLocalHook_Constraints(dm,g,mode,l,NULL);CHKERRQ(ierr);
2668baf369e7SPeter Brune   for (link=dm->gtolhook; link; link=link->next) {
2669baf369e7SPeter Brune     if (link->endhook) {ierr = (*link->endhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);}
2670baf369e7SPeter Brune   }
267147c6ae99SBarry Smith   PetscFunctionReturn(0);
267247c6ae99SBarry Smith }
267347c6ae99SBarry Smith 
2674d4d07f1eSToby Isaac /*@C
2675d4d07f1eSToby Isaac    DMLocalToGlobalHookAdd - adds a callback to be run when a local to global is called
2676d4d07f1eSToby Isaac 
2677d4d07f1eSToby Isaac    Logically Collective
2678d4d07f1eSToby Isaac 
2679d4d07f1eSToby Isaac    Input Arguments:
2680d4d07f1eSToby Isaac +  dm - the DM
2681d4d07f1eSToby Isaac .  beginhook - function to run at the beginning of DMLocalToGlobalBegin()
2682d4d07f1eSToby Isaac .  endhook - function to run after DMLocalToGlobalEnd() has completed
2683d4d07f1eSToby Isaac -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
2684d4d07f1eSToby Isaac 
2685d4d07f1eSToby Isaac    Calling sequence for beginhook:
2686d4d07f1eSToby Isaac $    beginhook(DM fine,Vec l,InsertMode mode,Vec g,void *ctx)
2687d4d07f1eSToby Isaac 
2688d4d07f1eSToby Isaac +  dm - global DM
2689d4d07f1eSToby Isaac .  l - local vector
2690d4d07f1eSToby Isaac .  mode - mode
2691d4d07f1eSToby Isaac .  g - global vector
2692d4d07f1eSToby Isaac -  ctx - optional user-defined function context
2693d4d07f1eSToby Isaac 
2694d4d07f1eSToby Isaac    Calling sequence for endhook:
2695d4d07f1eSToby Isaac $    endhook(DM fine,Vec l,InsertMode mode,Vec g,void *ctx)
2696d4d07f1eSToby Isaac 
2697d4d07f1eSToby Isaac +  global - global DM
2698d4d07f1eSToby Isaac .  l - local vector
2699d4d07f1eSToby Isaac .  mode - mode
2700d4d07f1eSToby Isaac .  g - global vector
2701d4d07f1eSToby Isaac -  ctx - optional user-defined function context
2702d4d07f1eSToby Isaac 
2703d4d07f1eSToby Isaac    Level: advanced
2704d4d07f1eSToby Isaac 
2705d4d07f1eSToby Isaac .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
2706d4d07f1eSToby Isaac @*/
2707d4d07f1eSToby Isaac PetscErrorCode DMLocalToGlobalHookAdd(DM dm,PetscErrorCode (*beginhook)(DM,Vec,InsertMode,Vec,void*),PetscErrorCode (*endhook)(DM,Vec,InsertMode,Vec,void*),void *ctx)
2708d4d07f1eSToby Isaac {
2709d4d07f1eSToby Isaac   PetscErrorCode          ierr;
2710d4d07f1eSToby Isaac   DMLocalToGlobalHookLink link,*p;
2711d4d07f1eSToby Isaac 
2712d4d07f1eSToby Isaac   PetscFunctionBegin;
2713d4d07f1eSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2714d4d07f1eSToby Isaac   for (p=&dm->ltoghook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */
271595dccacaSBarry Smith   ierr            = PetscNew(&link);CHKERRQ(ierr);
2716d4d07f1eSToby Isaac   link->beginhook = beginhook;
2717d4d07f1eSToby Isaac   link->endhook   = endhook;
2718d4d07f1eSToby Isaac   link->ctx       = ctx;
2719d4d07f1eSToby Isaac   link->next      = NULL;
2720d4d07f1eSToby Isaac   *p              = link;
2721d4d07f1eSToby Isaac   PetscFunctionReturn(0);
2722d4d07f1eSToby Isaac }
2723d4d07f1eSToby Isaac 
27244c274da1SToby Isaac static PetscErrorCode DMLocalToGlobalHook_Constraints(DM dm, Vec l, InsertMode mode, Vec g, void *ctx)
27254c274da1SToby Isaac {
27264c274da1SToby Isaac   Mat cMat;
27274c274da1SToby Isaac   Vec cVec;
27284c274da1SToby Isaac   PetscSection section, cSec;
27294c274da1SToby Isaac   PetscInt pStart, pEnd, p, dof;
27304c274da1SToby Isaac   PetscErrorCode ierr;
27314c274da1SToby Isaac 
27324c274da1SToby Isaac   PetscFunctionBegin;
27334c274da1SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
27344c274da1SToby Isaac   ierr = DMGetDefaultConstraints(dm,&cSec,&cMat);CHKERRQ(ierr);
27354c274da1SToby Isaac   if (cMat && (mode == ADD_VALUES || mode == ADD_ALL_VALUES || mode == ADD_BC_VALUES)) {
27365db9a05bSToby Isaac     PetscInt nRows;
27375db9a05bSToby Isaac 
27385db9a05bSToby Isaac     ierr = MatGetSize(cMat,&nRows,NULL);CHKERRQ(ierr);
27395db9a05bSToby Isaac     if (nRows <= 0) PetscFunctionReturn(0);
274092fd8e1eSJed Brown     ierr = DMGetLocalSection(dm,&section);CHKERRQ(ierr);
27417711e48fSToby Isaac     ierr = MatCreateVecs(cMat,NULL,&cVec);CHKERRQ(ierr);
27424c274da1SToby Isaac     ierr = PetscSectionGetChart(cSec,&pStart,&pEnd);CHKERRQ(ierr);
27434c274da1SToby Isaac     for (p = pStart; p < pEnd; p++) {
27444c274da1SToby Isaac       ierr = PetscSectionGetDof(cSec,p,&dof);CHKERRQ(ierr);
27454c274da1SToby Isaac       if (dof) {
27464c274da1SToby Isaac         PetscInt d;
27474c274da1SToby Isaac         PetscScalar *vals;
27484c274da1SToby Isaac         ierr = VecGetValuesSection(l,section,p,&vals);CHKERRQ(ierr);
27494c274da1SToby Isaac         ierr = VecSetValuesSection(cVec,cSec,p,vals,mode);CHKERRQ(ierr);
27504c274da1SToby Isaac         /* for this to be the true transpose, we have to zero the values that
27514c274da1SToby Isaac          * we just extracted */
27524c274da1SToby Isaac         for (d = 0; d < dof; d++) {
27534c274da1SToby Isaac           vals[d] = 0.;
27544c274da1SToby Isaac         }
27554c274da1SToby Isaac       }
27564c274da1SToby Isaac     }
27574c274da1SToby Isaac     ierr = MatMultTransposeAdd(cMat,cVec,l,l);CHKERRQ(ierr);
27584c274da1SToby Isaac     ierr = VecDestroy(&cVec);CHKERRQ(ierr);
27594c274da1SToby Isaac   }
27604c274da1SToby Isaac   PetscFunctionReturn(0);
27614c274da1SToby Isaac }
276201729b5cSPatrick Sanan /*@
276301729b5cSPatrick Sanan     DMLocalToGlobal - updates global vectors from local vectors
276401729b5cSPatrick Sanan 
2765d083f849SBarry Smith     Neighbor-wise Collective on dm
276601729b5cSPatrick Sanan 
276701729b5cSPatrick Sanan     Input Parameters:
276801729b5cSPatrick Sanan +   dm - the DM object
276901729b5cSPatrick Sanan .   l - the local vector
277001729b5cSPatrick 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.
277101729b5cSPatrick Sanan -   g - the global vector
277201729b5cSPatrick Sanan 
277301729b5cSPatrick Sanan     Notes:
277401729b5cSPatrick Sanan     The communication involved in this update can be overlapped with computation by using
277501729b5cSPatrick Sanan     DMLocalToGlobalBegin() and DMLocalToGlobalEnd().
277601729b5cSPatrick Sanan 
277701729b5cSPatrick Sanan     In the ADD_VALUES case you normally would zero the receiving vector before beginning this operation.
277801729b5cSPatrick 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.
277901729b5cSPatrick Sanan 
278001729b5cSPatrick Sanan     Level: beginner
278101729b5cSPatrick Sanan 
278201729b5cSPatrick Sanan .seealso DMLocalToGlobalBegin(), DMLocalToGlobalEnd(), DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMGlobalToLocalEnd(), DMGlobalToLocalBegin()
278301729b5cSPatrick Sanan 
278401729b5cSPatrick Sanan @*/
278501729b5cSPatrick Sanan PetscErrorCode DMLocalToGlobal(DM dm,Vec l,InsertMode mode,Vec g)
278601729b5cSPatrick Sanan {
278701729b5cSPatrick Sanan   PetscErrorCode ierr;
278801729b5cSPatrick Sanan 
278901729b5cSPatrick Sanan   PetscFunctionBegin;
279001729b5cSPatrick Sanan   ierr = DMLocalToGlobalBegin(dm,l,mode,g);CHKERRQ(ierr);
279101729b5cSPatrick Sanan   ierr = DMLocalToGlobalEnd(dm,l,mode,g);CHKERRQ(ierr);
279201729b5cSPatrick Sanan   PetscFunctionReturn(0);
279301729b5cSPatrick Sanan }
27944c274da1SToby Isaac 
279547c6ae99SBarry Smith /*@
279601729b5cSPatrick Sanan     DMLocalToGlobalBegin - begins updating global vectors from local vectors
27979a42bb27SBarry Smith 
2798d083f849SBarry Smith     Neighbor-wise Collective on dm
27999a42bb27SBarry Smith 
28009a42bb27SBarry Smith     Input Parameters:
28019a42bb27SBarry Smith +   dm - the DM object
2802f6813fd5SJed Brown .   l - the local vector
28031eb28f2eSBarry 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.
28041eb28f2eSBarry Smith -   g - the global vector
28059a42bb27SBarry Smith 
280695452b02SPatrick Sanan     Notes:
280795452b02SPatrick Sanan     In the ADD_VALUES case you normally would zero the receiving vector before beginning this operation.
280884330215SMatthew 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.
28099a42bb27SBarry Smith 
281001729b5cSPatrick Sanan     Level: intermediate
28119a42bb27SBarry Smith 
281201729b5cSPatrick Sanan .seealso DMLocalToGlobal(), DMLocalToGlobalEnd(), DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMGlobalToLocalEnd(), DMGlobalToLocalBegin()
28139a42bb27SBarry Smith 
28149a42bb27SBarry Smith @*/
28157087cfbeSBarry Smith PetscErrorCode  DMLocalToGlobalBegin(DM dm,Vec l,InsertMode mode,Vec g)
28169a42bb27SBarry Smith {
28177128ae9fSMatthew G Knepley   PetscSF                 sf;
281884330215SMatthew G. Knepley   PetscSection            s, gs;
2819d4d07f1eSToby Isaac   DMLocalToGlobalHookLink link;
2820ca3d3a14SMatthew G. Knepley   Vec                     tmpl;
2821ae5cfb4aSMatthew G. Knepley   const PetscScalar      *lArray;
2822ae5cfb4aSMatthew G. Knepley   PetscScalar            *gArray;
2823fa88e482SJed Brown   PetscBool               isInsert, transform, l_inplace = PETSC_FALSE, g_inplace = PETSC_FALSE;
282484330215SMatthew G. Knepley   PetscErrorCode          ierr;
2825d0295fc0SJunchao Zhang   PetscMemType            lmtype=PETSC_MEMTYPE_HOST,gmtype=PETSC_MEMTYPE_HOST;
28269a42bb27SBarry Smith 
28279a42bb27SBarry Smith   PetscFunctionBegin;
2828171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2829d4d07f1eSToby Isaac   for (link=dm->ltoghook; link; link=link->next) {
2830d4d07f1eSToby Isaac     if (link->beginhook) {
2831d4d07f1eSToby Isaac       ierr = (*link->beginhook)(dm,l,mode,g,link->ctx);CHKERRQ(ierr);
2832d4d07f1eSToby Isaac     }
2833d4d07f1eSToby Isaac   }
28344c274da1SToby Isaac   ierr = DMLocalToGlobalHook_Constraints(dm,l,mode,g,NULL);CHKERRQ(ierr);
28351bb6d2a8SBarry Smith   ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr);
283692fd8e1eSJed Brown   ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr);
28377128ae9fSMatthew G Knepley   switch (mode) {
28387128ae9fSMatthew G Knepley   case INSERT_VALUES:
28397128ae9fSMatthew G Knepley   case INSERT_ALL_VALUES:
2840304ab55fSMatthew G. Knepley   case INSERT_BC_VALUES:
284184330215SMatthew G. Knepley     isInsert = PETSC_TRUE; break;
28427128ae9fSMatthew G Knepley   case ADD_VALUES:
28437128ae9fSMatthew G Knepley   case ADD_ALL_VALUES:
2844304ab55fSMatthew G. Knepley   case ADD_BC_VALUES:
284584330215SMatthew G. Knepley     isInsert = PETSC_FALSE; break;
28467128ae9fSMatthew G Knepley   default:
284782f516ccSBarry Smith     SETERRQ1(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
28487128ae9fSMatthew G Knepley   }
2849ca3d3a14SMatthew G. Knepley   if ((sf && !isInsert) || (s && isInsert)) {
2850ca3d3a14SMatthew G. Knepley     ierr = DMHasBasisTransform(dm, &transform);CHKERRQ(ierr);
2851ca3d3a14SMatthew G. Knepley     if (transform) {
2852ca3d3a14SMatthew G. Knepley       ierr = DMGetNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr);
2853ca3d3a14SMatthew G. Knepley       ierr = VecCopy(l, tmpl);CHKERRQ(ierr);
2854ca3d3a14SMatthew G. Knepley       ierr = DMPlexLocalToGlobalBasis(dm, tmpl);CHKERRQ(ierr);
2855ca3d3a14SMatthew G. Knepley       ierr = VecGetArrayRead(tmpl, &lArray);CHKERRQ(ierr);
2856fa88e482SJed Brown     } else if (isInsert) {
2857ae5cfb4aSMatthew G. Knepley       ierr = VecGetArrayRead(l, &lArray);CHKERRQ(ierr);
2858fa88e482SJed Brown     } else {
2859a256111fSJunchao Zhang       ierr = VecGetArrayReadAndMemType(l, &lArray, &lmtype);CHKERRQ(ierr);
2860fa88e482SJed Brown       l_inplace = PETSC_TRUE;
2861ca3d3a14SMatthew G. Knepley     }
2862fa88e482SJed Brown     if (s && isInsert) {
28637128ae9fSMatthew G Knepley       ierr = VecGetArray(g, &gArray);CHKERRQ(ierr);
2864fa88e482SJed Brown     } else {
2865a256111fSJunchao Zhang       ierr = VecGetArrayAndMemType(g, &gArray, &gmtype);CHKERRQ(ierr);
2866fa88e482SJed Brown       g_inplace = PETSC_TRUE;
2867fa88e482SJed Brown     }
2868ca3d3a14SMatthew G. Knepley     if (sf && !isInsert) {
2869d0295fc0SJunchao Zhang       ierr = PetscSFReduceWithMemTypeBegin(sf, MPIU_SCALAR, lmtype, lArray, gmtype, gArray, MPIU_SUM);CHKERRQ(ierr);
287084330215SMatthew G. Knepley     } else if (s && isInsert) {
287184330215SMatthew G. Knepley       PetscInt gStart, pStart, pEnd, p;
287284330215SMatthew G. Knepley 
2873e87a4003SBarry Smith       ierr = DMGetGlobalSection(dm, &gs);CHKERRQ(ierr);
287484330215SMatthew G. Knepley       ierr = PetscSectionGetChart(s, &pStart, &pEnd);CHKERRQ(ierr);
287584330215SMatthew G. Knepley       ierr = VecGetOwnershipRange(g, &gStart, NULL);CHKERRQ(ierr);
287684330215SMatthew G. Knepley       for (p = pStart; p < pEnd; ++p) {
2877b3b16f48SMatthew G. Knepley         PetscInt dof, gdof, cdof, gcdof, off, goff, d, e;
287884330215SMatthew G. Knepley 
287984330215SMatthew G. Knepley         ierr = PetscSectionGetDof(s, p, &dof);CHKERRQ(ierr);
288003442857SMatthew G. Knepley         ierr = PetscSectionGetDof(gs, p, &gdof);CHKERRQ(ierr);
288184330215SMatthew G. Knepley         ierr = PetscSectionGetConstraintDof(s, p, &cdof);CHKERRQ(ierr);
2882b3b16f48SMatthew G. Knepley         ierr = PetscSectionGetConstraintDof(gs, p, &gcdof);CHKERRQ(ierr);
288384330215SMatthew G. Knepley         ierr = PetscSectionGetOffset(s, p, &off);CHKERRQ(ierr);
288484330215SMatthew G. Knepley         ierr = PetscSectionGetOffset(gs, p, &goff);CHKERRQ(ierr);
2885b3b16f48SMatthew G. Knepley         /* Ignore off-process data and points with no global data */
288603442857SMatthew G. Knepley         if (!gdof || goff < 0) continue;
2887b3b16f48SMatthew 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);
2888b3b16f48SMatthew G. Knepley         /* If no constraints are enforced in the global vector */
2889b3b16f48SMatthew G. Knepley         if (!gcdof) {
289084330215SMatthew G. Knepley           for (d = 0; d < dof; ++d) gArray[goff-gStart+d] = lArray[off+d];
2891b3b16f48SMatthew G. Knepley           /* If constraints are enforced in the global vector */
2892b3b16f48SMatthew G. Knepley         } else if (cdof == gcdof) {
289384330215SMatthew G. Knepley           const PetscInt *cdofs;
289484330215SMatthew G. Knepley           PetscInt        cind = 0;
289584330215SMatthew G. Knepley 
289684330215SMatthew G. Knepley           ierr = PetscSectionGetConstraintIndices(s, p, &cdofs);CHKERRQ(ierr);
2897b3b16f48SMatthew G. Knepley           for (d = 0, e = 0; d < dof; ++d) {
289884330215SMatthew G. Knepley             if ((cind < cdof) && (d == cdofs[cind])) {++cind; continue;}
2899b3b16f48SMatthew G. Knepley             gArray[goff-gStart+e++] = lArray[off+d];
290084330215SMatthew G. Knepley           }
2901b3b16f48SMatthew 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);
290284330215SMatthew G. Knepley       }
2903ca3d3a14SMatthew G. Knepley     }
2904fa88e482SJed Brown     if (g_inplace) {
2905a256111fSJunchao Zhang       ierr = VecRestoreArrayAndMemType(g, &gArray);CHKERRQ(ierr);
2906fa88e482SJed Brown     } else {
29077128ae9fSMatthew G Knepley       ierr = VecRestoreArray(g, &gArray);CHKERRQ(ierr);
2908fa88e482SJed Brown     }
2909ca3d3a14SMatthew G. Knepley     if (transform) {
2910ca3d3a14SMatthew G. Knepley       ierr = VecRestoreArrayRead(tmpl, &lArray);CHKERRQ(ierr);
2911ca3d3a14SMatthew G. Knepley       ierr = DMRestoreNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr);
2912fa88e482SJed Brown     } else if (l_inplace) {
2913a256111fSJunchao Zhang       ierr = VecRestoreArrayReadAndMemType(l, &lArray);CHKERRQ(ierr);
2914ca3d3a14SMatthew G. Knepley     } else {
2915ca3d3a14SMatthew G. Knepley       ierr = VecRestoreArrayRead(l, &lArray);CHKERRQ(ierr);
2916ca3d3a14SMatthew G. Knepley     }
29177128ae9fSMatthew G Knepley   } else {
2918b9d85ea2SLisandro Dalcin     if (!dm->ops->localtoglobalbegin) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMLocalToGlobalBegin() for type %s",((PetscObject)dm)->type_name);
2919843c4018SMatthew G Knepley     ierr = (*dm->ops->localtoglobalbegin)(dm,l,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),g);CHKERRQ(ierr);
29207128ae9fSMatthew G Knepley   }
29219a42bb27SBarry Smith   PetscFunctionReturn(0);
29229a42bb27SBarry Smith }
29239a42bb27SBarry Smith 
29249a42bb27SBarry Smith /*@
29259a42bb27SBarry Smith     DMLocalToGlobalEnd - updates global vectors from local vectors
292647c6ae99SBarry Smith 
2927d083f849SBarry Smith     Neighbor-wise Collective on dm
292847c6ae99SBarry Smith 
292947c6ae99SBarry Smith     Input Parameters:
293047c6ae99SBarry Smith +   dm - the DM object
2931f6813fd5SJed Brown .   l - the local vector
293247c6ae99SBarry Smith .   mode - INSERT_VALUES or ADD_VALUES
2933f6813fd5SJed Brown -   g - the global vector
293447c6ae99SBarry Smith 
293501729b5cSPatrick Sanan     Level: intermediate
293647c6ae99SBarry Smith 
2937e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMGlobalToLocalEnd()
293847c6ae99SBarry Smith 
293947c6ae99SBarry Smith @*/
29407087cfbeSBarry Smith PetscErrorCode  DMLocalToGlobalEnd(DM dm,Vec l,InsertMode mode,Vec g)
294147c6ae99SBarry Smith {
29427128ae9fSMatthew G Knepley   PetscSF                 sf;
294384330215SMatthew G. Knepley   PetscSection            s;
2944d4d07f1eSToby Isaac   DMLocalToGlobalHookLink link;
2945ca3d3a14SMatthew G. Knepley   PetscBool               isInsert, transform;
294684330215SMatthew G. Knepley   PetscErrorCode          ierr;
294747c6ae99SBarry Smith 
294847c6ae99SBarry Smith   PetscFunctionBegin;
2949171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
29501bb6d2a8SBarry Smith   ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr);
295192fd8e1eSJed Brown   ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr);
29527128ae9fSMatthew G Knepley   switch (mode) {
29537128ae9fSMatthew G Knepley   case INSERT_VALUES:
29547128ae9fSMatthew G Knepley   case INSERT_ALL_VALUES:
295584330215SMatthew G. Knepley     isInsert = PETSC_TRUE; break;
29567128ae9fSMatthew G Knepley   case ADD_VALUES:
29577128ae9fSMatthew G Knepley   case ADD_ALL_VALUES:
295884330215SMatthew G. Knepley     isInsert = PETSC_FALSE; break;
29597128ae9fSMatthew G Knepley   default:
296082f516ccSBarry Smith     SETERRQ1(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
29617128ae9fSMatthew G Knepley   }
296284330215SMatthew G. Knepley   if (sf && !isInsert) {
2963ae5cfb4aSMatthew G. Knepley     const PetscScalar *lArray;
2964ae5cfb4aSMatthew G. Knepley     PetscScalar       *gArray;
2965ca3d3a14SMatthew G. Knepley     Vec                tmpl;
296684330215SMatthew G. Knepley 
2967ca3d3a14SMatthew G. Knepley     ierr = DMHasBasisTransform(dm, &transform);CHKERRQ(ierr);
2968ca3d3a14SMatthew G. Knepley     if (transform) {
2969ca3d3a14SMatthew G. Knepley       ierr = DMGetNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr);
2970ca3d3a14SMatthew G. Knepley       ierr = VecGetArrayRead(tmpl, &lArray);CHKERRQ(ierr);
2971ca3d3a14SMatthew G. Knepley     } else {
2972a256111fSJunchao Zhang       ierr = VecGetArrayReadAndMemType(l, &lArray, NULL);CHKERRQ(ierr);
2973ca3d3a14SMatthew G. Knepley     }
2974a256111fSJunchao Zhang     ierr = VecGetArrayAndMemType(g, &gArray, NULL);CHKERRQ(ierr);
2975a9b180a6SBarry Smith     ierr = PetscSFReduceEnd(sf, MPIU_SCALAR, lArray, gArray, MPIU_SUM);CHKERRQ(ierr);
2976ca3d3a14SMatthew G. Knepley     if (transform) {
2977ca3d3a14SMatthew G. Knepley       ierr = VecRestoreArrayRead(tmpl, &lArray);CHKERRQ(ierr);
2978ca3d3a14SMatthew G. Knepley       ierr = DMRestoreNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr);
2979ca3d3a14SMatthew G. Knepley     } else {
2980a256111fSJunchao Zhang       ierr = VecRestoreArrayReadAndMemType(l, &lArray);CHKERRQ(ierr);
2981ca3d3a14SMatthew G. Knepley     }
2982a256111fSJunchao Zhang     ierr = VecRestoreArrayAndMemType(g, &gArray);CHKERRQ(ierr);
298384330215SMatthew G. Knepley   } else if (s && isInsert) {
29847128ae9fSMatthew G Knepley   } else {
2985b9d85ea2SLisandro Dalcin     if (!dm->ops->localtoglobalend) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMLocalToGlobalEnd() for type %s",((PetscObject)dm)->type_name);
2986843c4018SMatthew G Knepley     ierr = (*dm->ops->localtoglobalend)(dm,l,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),g);CHKERRQ(ierr);
29877128ae9fSMatthew G Knepley   }
2988d4d07f1eSToby Isaac   for (link=dm->ltoghook; link; link=link->next) {
2989d4d07f1eSToby Isaac     if (link->endhook) {ierr = (*link->endhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);}
2990d4d07f1eSToby Isaac   }
299147c6ae99SBarry Smith   PetscFunctionReturn(0);
299247c6ae99SBarry Smith }
299347c6ae99SBarry Smith 
2994f089877aSRichard Tran Mills /*@
2995bc0a1609SRichard Tran Mills    DMLocalToLocalBegin - Maps from a local vector (including ghost points
2996bc0a1609SRichard Tran Mills    that contain irrelevant values) to another local vector where the ghost
2997d78e899eSRichard Tran Mills    points in the second are set correctly. Must be followed by DMLocalToLocalEnd().
2998f089877aSRichard Tran Mills 
2999d083f849SBarry Smith    Neighbor-wise Collective on dm
3000f089877aSRichard Tran Mills 
3001f089877aSRichard Tran Mills    Input Parameters:
3002f089877aSRichard Tran Mills +  dm - the DM object
3003bc0a1609SRichard Tran Mills .  g - the original local vector
3004bc0a1609SRichard Tran Mills -  mode - one of INSERT_VALUES or ADD_VALUES
3005f089877aSRichard Tran Mills 
3006bc0a1609SRichard Tran Mills    Output Parameter:
3007bc0a1609SRichard Tran Mills .  l  - the local vector with correct ghost values
3008f089877aSRichard Tran Mills 
3009f089877aSRichard Tran Mills    Level: intermediate
3010f089877aSRichard Tran Mills 
3011bc0a1609SRichard Tran Mills    Notes:
3012bc0a1609SRichard Tran Mills    The local vectors used here need not be the same as those
3013bc0a1609SRichard Tran Mills    obtained from DMCreateLocalVector(), BUT they
3014bc0a1609SRichard Tran Mills    must have the same parallel data layout; they could, for example, be
3015bc0a1609SRichard Tran Mills    obtained with VecDuplicate() from the DM originating vectors.
3016bc0a1609SRichard Tran Mills 
3017bc0a1609SRichard Tran Mills .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateLocalVector(), DMCreateGlobalVector(), DMCreateInterpolation(), DMLocalToLocalEnd(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin()
3018f089877aSRichard Tran Mills 
3019f089877aSRichard Tran Mills @*/
3020f089877aSRichard Tran Mills PetscErrorCode  DMLocalToLocalBegin(DM dm,Vec g,InsertMode mode,Vec l)
3021f089877aSRichard Tran Mills {
3022f089877aSRichard Tran Mills   PetscErrorCode          ierr;
3023f089877aSRichard Tran Mills 
3024f089877aSRichard Tran Mills   PetscFunctionBegin;
3025f089877aSRichard Tran Mills   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3026bb358533SPatrick Sanan   if (!dm->ops->localtolocalbegin) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"This DM does not support local to local maps");
3027f089877aSRichard Tran Mills   ierr = (*dm->ops->localtolocalbegin)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
3028f089877aSRichard Tran Mills   PetscFunctionReturn(0);
3029f089877aSRichard Tran Mills }
3030f089877aSRichard Tran Mills 
3031f089877aSRichard Tran Mills /*@
3032bc0a1609SRichard Tran Mills    DMLocalToLocalEnd - Maps from a local vector (including ghost points
3033bc0a1609SRichard Tran Mills    that contain irrelevant values) to another local vector where the ghost
3034d78e899eSRichard Tran Mills    points in the second are set correctly. Must be preceded by DMLocalToLocalBegin().
3035f089877aSRichard Tran Mills 
3036d083f849SBarry Smith    Neighbor-wise Collective on dm
3037f089877aSRichard Tran Mills 
3038f089877aSRichard Tran Mills    Input Parameters:
3039bc0a1609SRichard Tran Mills +  da - the DM object
3040bc0a1609SRichard Tran Mills .  g - the original local vector
3041bc0a1609SRichard Tran Mills -  mode - one of INSERT_VALUES or ADD_VALUES
3042f089877aSRichard Tran Mills 
3043bc0a1609SRichard Tran Mills    Output Parameter:
3044bc0a1609SRichard Tran Mills .  l  - the local vector with correct ghost values
3045f089877aSRichard Tran Mills 
3046f089877aSRichard Tran Mills    Level: intermediate
3047f089877aSRichard Tran Mills 
3048bc0a1609SRichard Tran Mills    Notes:
3049bc0a1609SRichard Tran Mills    The local vectors used here need not be the same as those
3050bc0a1609SRichard Tran Mills    obtained from DMCreateLocalVector(), BUT they
3051bc0a1609SRichard Tran Mills    must have the same parallel data layout; they could, for example, be
3052bc0a1609SRichard Tran Mills    obtained with VecDuplicate() from the DM originating vectors.
3053bc0a1609SRichard Tran Mills 
3054bc0a1609SRichard Tran Mills .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateLocalVector(), DMCreateGlobalVector(), DMCreateInterpolation(), DMLocalToLocalBegin(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin()
3055f089877aSRichard Tran Mills 
3056f089877aSRichard Tran Mills @*/
3057f089877aSRichard Tran Mills PetscErrorCode  DMLocalToLocalEnd(DM dm,Vec g,InsertMode mode,Vec l)
3058f089877aSRichard Tran Mills {
3059f089877aSRichard Tran Mills   PetscErrorCode          ierr;
3060f089877aSRichard Tran Mills 
3061f089877aSRichard Tran Mills   PetscFunctionBegin;
3062f089877aSRichard Tran Mills   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3063bb358533SPatrick Sanan   if (!dm->ops->localtolocalend) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"This DM does not support local to local maps");
3064f089877aSRichard Tran Mills   ierr = (*dm->ops->localtolocalend)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
3065f089877aSRichard Tran Mills   PetscFunctionReturn(0);
3066f089877aSRichard Tran Mills }
3067f089877aSRichard Tran Mills 
306847c6ae99SBarry Smith /*@
306947c6ae99SBarry Smith     DMCoarsen - Coarsens a DM object
307047c6ae99SBarry Smith 
3071d083f849SBarry Smith     Collective on dm
307247c6ae99SBarry Smith 
307347c6ae99SBarry Smith     Input Parameter:
307447c6ae99SBarry Smith +   dm - the DM object
307591d95f02SJed Brown -   comm - the communicator to contain the new DM object (or MPI_COMM_NULL)
307647c6ae99SBarry Smith 
307747c6ae99SBarry Smith     Output Parameter:
307847c6ae99SBarry Smith .   dmc - the coarsened DM
307947c6ae99SBarry Smith 
308047c6ae99SBarry Smith     Level: developer
308147c6ae99SBarry Smith 
3082e727c939SJed Brown .seealso DMRefine(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
308347c6ae99SBarry Smith 
308447c6ae99SBarry Smith @*/
30857087cfbeSBarry Smith PetscErrorCode DMCoarsen(DM dm, MPI_Comm comm, DM *dmc)
308647c6ae99SBarry Smith {
308747c6ae99SBarry Smith   PetscErrorCode    ierr;
3088b17ce1afSJed Brown   DMCoarsenHookLink link;
308947c6ae99SBarry Smith 
309047c6ae99SBarry Smith   PetscFunctionBegin;
3091171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3092b9d85ea2SLisandro Dalcin   if (!dm->ops->coarsen) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCoarsen",((PetscObject)dm)->type_name);
309347a35634SPatrick Farrell   ierr = PetscLogEventBegin(DM_Coarsen,dm,0,0,0);CHKERRQ(ierr);
309447c6ae99SBarry Smith   ierr = (*dm->ops->coarsen)(dm, comm, dmc);CHKERRQ(ierr);
3095b9d85ea2SLisandro Dalcin   if (*dmc) {
3096a8fb8f29SToby Isaac     ierr = DMSetCoarseDM(dm,*dmc);CHKERRQ(ierr);
309743842a1eSJed Brown     (*dmc)->ops->creatematrix = dm->ops->creatematrix;
30988cd211a4SJed Brown     ierr                      = PetscObjectCopyFortranFunctionPointers((PetscObject)dm,(PetscObject)*dmc);CHKERRQ(ierr);
3099644e2e5bSBarry Smith     (*dmc)->ctx               = dm->ctx;
31000598a293SJed Brown     (*dmc)->levelup           = dm->levelup;
3101656b349aSBarry Smith     (*dmc)->leveldown         = dm->leveldown + 1;
3102e4b4b23bSJed Brown     ierr                      = DMSetMatType(*dmc,dm->mattype);CHKERRQ(ierr);
3103b17ce1afSJed Brown     for (link=dm->coarsenhook; link; link=link->next) {
3104b17ce1afSJed Brown       if (link->coarsenhook) {ierr = (*link->coarsenhook)(dm,*dmc,link->ctx);CHKERRQ(ierr);}
3105b17ce1afSJed Brown     }
3106b9d85ea2SLisandro Dalcin   }
310747a35634SPatrick Farrell   ierr = PetscLogEventEnd(DM_Coarsen,dm,0,0,0);CHKERRQ(ierr);
3108b9d85ea2SLisandro Dalcin   if (!(*dmc)) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "NULL coarse mesh produced");
3109b17ce1afSJed Brown   PetscFunctionReturn(0);
3110b17ce1afSJed Brown }
3111b17ce1afSJed Brown 
3112bb9467b5SJed Brown /*@C
3113b17ce1afSJed Brown    DMCoarsenHookAdd - adds a callback to be run when restricting a nonlinear problem to the coarse grid
3114b17ce1afSJed Brown 
3115b17ce1afSJed Brown    Logically Collective
3116b17ce1afSJed Brown 
3117b17ce1afSJed Brown    Input Arguments:
3118b17ce1afSJed Brown +  fine - nonlinear solver context on which to run a hook when restricting to a coarser level
3119b17ce1afSJed Brown .  coarsenhook - function to run when setting up a coarser level
3120b17ce1afSJed Brown .  restricthook - function to run to update data on coarser levels (once per SNESSolve())
31210298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
3122b17ce1afSJed Brown 
3123b17ce1afSJed Brown    Calling sequence of coarsenhook:
3124b17ce1afSJed Brown $    coarsenhook(DM fine,DM coarse,void *ctx);
3125b17ce1afSJed Brown 
3126b17ce1afSJed Brown +  fine - fine level DM
3127b17ce1afSJed Brown .  coarse - coarse level DM to restrict problem to
3128b17ce1afSJed Brown -  ctx - optional user-defined function context
3129b17ce1afSJed Brown 
3130b17ce1afSJed Brown    Calling sequence for restricthook:
3131c833c3b5SJed Brown $    restricthook(DM fine,Mat mrestrict,Vec rscale,Mat inject,DM coarse,void *ctx)
3132b17ce1afSJed Brown 
3133b17ce1afSJed Brown +  fine - fine level DM
3134b17ce1afSJed Brown .  mrestrict - matrix restricting a fine-level solution to the coarse grid
3135c833c3b5SJed Brown .  rscale - scaling vector for restriction
3136c833c3b5SJed Brown .  inject - matrix restricting by injection
3137b17ce1afSJed Brown .  coarse - coarse level DM to update
3138b17ce1afSJed Brown -  ctx - optional user-defined function context
3139b17ce1afSJed Brown 
3140b17ce1afSJed Brown    Level: advanced
3141b17ce1afSJed Brown 
3142b17ce1afSJed Brown    Notes:
3143b17ce1afSJed Brown    This function is only needed if auxiliary data needs to be set up on coarse grids.
3144b17ce1afSJed Brown 
3145b17ce1afSJed Brown    If this function is called multiple times, the hooks will be run in the order they are added.
3146b17ce1afSJed Brown 
3147b17ce1afSJed Brown    In order to compose with nonlinear preconditioning without duplicating storage, the hook should be implemented to
3148b17ce1afSJed Brown    extract the finest level information from its context (instead of from the SNES).
3149b17ce1afSJed Brown 
3150bb9467b5SJed Brown    This function is currently not available from Fortran.
3151bb9467b5SJed Brown 
3152dc822a44SJed Brown .seealso: DMCoarsenHookRemove(), DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
3153b17ce1afSJed Brown @*/
3154b17ce1afSJed Brown PetscErrorCode DMCoarsenHookAdd(DM fine,PetscErrorCode (*coarsenhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,Mat,Vec,Mat,DM,void*),void *ctx)
3155b17ce1afSJed Brown {
3156b17ce1afSJed Brown   PetscErrorCode    ierr;
3157b17ce1afSJed Brown   DMCoarsenHookLink link,*p;
3158b17ce1afSJed Brown 
3159b17ce1afSJed Brown   PetscFunctionBegin;
3160b17ce1afSJed Brown   PetscValidHeaderSpecific(fine,DM_CLASSID,1);
31611e3d8eccSJed Brown   for (p=&fine->coarsenhook; *p; p=&(*p)->next) { /* Scan to the end of the current list of hooks */
31621e3d8eccSJed Brown     if ((*p)->coarsenhook == coarsenhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) PetscFunctionReturn(0);
31631e3d8eccSJed Brown   }
316495dccacaSBarry Smith   ierr               = PetscNew(&link);CHKERRQ(ierr);
3165b17ce1afSJed Brown   link->coarsenhook  = coarsenhook;
3166b17ce1afSJed Brown   link->restricthook = restricthook;
3167b17ce1afSJed Brown   link->ctx          = ctx;
31680298fd71SBarry Smith   link->next         = NULL;
3169b17ce1afSJed Brown   *p                 = link;
3170b17ce1afSJed Brown   PetscFunctionReturn(0);
3171b17ce1afSJed Brown }
3172b17ce1afSJed Brown 
3173dc822a44SJed Brown /*@C
3174dc822a44SJed Brown    DMCoarsenHookRemove - remove a callback from the list of hooks to be run when restricting a nonlinear problem to the coarse grid
3175dc822a44SJed Brown 
3176dc822a44SJed Brown    Logically Collective
3177dc822a44SJed Brown 
3178dc822a44SJed Brown    Input Arguments:
3179dc822a44SJed Brown +  fine - nonlinear solver context on which to run a hook when restricting to a coarser level
3180dc822a44SJed Brown .  coarsenhook - function to run when setting up a coarser level
3181dc822a44SJed Brown .  restricthook - function to run to update data on coarser levels (once per SNESSolve())
3182dc822a44SJed Brown -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
3183dc822a44SJed Brown 
3184dc822a44SJed Brown    Level: advanced
3185dc822a44SJed Brown 
3186dc822a44SJed Brown    Notes:
3187dc822a44SJed Brown    This function does nothing if the hook is not in the list.
3188dc822a44SJed Brown 
3189dc822a44SJed Brown    This function is currently not available from Fortran.
3190dc822a44SJed Brown 
3191dc822a44SJed Brown .seealso: DMCoarsenHookAdd(), DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
3192dc822a44SJed Brown @*/
3193dc822a44SJed Brown PetscErrorCode DMCoarsenHookRemove(DM fine,PetscErrorCode (*coarsenhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,Mat,Vec,Mat,DM,void*),void *ctx)
3194dc822a44SJed Brown {
3195dc822a44SJed Brown   PetscErrorCode    ierr;
3196dc822a44SJed Brown   DMCoarsenHookLink link,*p;
3197dc822a44SJed Brown 
3198dc822a44SJed Brown   PetscFunctionBegin;
3199dc822a44SJed Brown   PetscValidHeaderSpecific(fine,DM_CLASSID,1);
3200dc822a44SJed Brown   for (p=&fine->coarsenhook; *p; p=&(*p)->next) { /* Search the list of current hooks */
3201dc822a44SJed Brown     if ((*p)->coarsenhook == coarsenhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) {
3202dc822a44SJed Brown       link = *p;
3203dc822a44SJed Brown       *p = link->next;
3204dc822a44SJed Brown       ierr = PetscFree(link);CHKERRQ(ierr);
3205dc822a44SJed Brown       break;
3206dc822a44SJed Brown     }
3207dc822a44SJed Brown   }
3208dc822a44SJed Brown   PetscFunctionReturn(0);
3209dc822a44SJed Brown }
3210dc822a44SJed Brown 
3211b17ce1afSJed Brown /*@
3212b17ce1afSJed Brown    DMRestrict - restricts user-defined problem data to a coarser DM by running hooks registered by DMCoarsenHookAdd()
3213b17ce1afSJed Brown 
3214b17ce1afSJed Brown    Collective if any hooks are
3215b17ce1afSJed Brown 
3216b17ce1afSJed Brown    Input Arguments:
3217b17ce1afSJed Brown +  fine - finer DM to use as a base
3218b17ce1afSJed Brown .  restrct - restriction matrix, apply using MatRestrict()
3219e91eccc2SStefano Zampini .  rscale - scaling vector for restriction
3220b17ce1afSJed Brown .  inject - injection matrix, also use MatRestrict()
3221e91eccc2SStefano Zampini -  coarse - coarser DM to update
3222b17ce1afSJed Brown 
3223b17ce1afSJed Brown    Level: developer
3224b17ce1afSJed Brown 
3225b17ce1afSJed Brown .seealso: DMCoarsenHookAdd(), MatRestrict()
3226b17ce1afSJed Brown @*/
3227b17ce1afSJed Brown PetscErrorCode DMRestrict(DM fine,Mat restrct,Vec rscale,Mat inject,DM coarse)
3228b17ce1afSJed Brown {
3229b17ce1afSJed Brown   PetscErrorCode    ierr;
3230b17ce1afSJed Brown   DMCoarsenHookLink link;
3231b17ce1afSJed Brown 
3232b17ce1afSJed Brown   PetscFunctionBegin;
3233b17ce1afSJed Brown   for (link=fine->coarsenhook; link; link=link->next) {
32348865f1eaSKarl Rupp     if (link->restricthook) {
32358865f1eaSKarl Rupp       ierr = (*link->restricthook)(fine,restrct,rscale,inject,coarse,link->ctx);CHKERRQ(ierr);
32368865f1eaSKarl Rupp     }
3237b17ce1afSJed Brown   }
323847c6ae99SBarry Smith   PetscFunctionReturn(0);
323947c6ae99SBarry Smith }
324047c6ae99SBarry Smith 
3241bb9467b5SJed Brown /*@C
3242be081cd6SPeter Brune    DMSubDomainHookAdd - adds a callback to be run when restricting a problem to the coarse grid
32435dbd56e3SPeter Brune 
3244d083f849SBarry Smith    Logically Collective on global
32455dbd56e3SPeter Brune 
32465dbd56e3SPeter Brune    Input Arguments:
32475dbd56e3SPeter Brune +  global - global DM
3248ec4806b8SPeter Brune .  ddhook - function to run to pass data to the decomposition DM upon its creation
32495dbd56e3SPeter Brune .  restricthook - function to run to update data on block solve (at the beginning of the block solve)
32500298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
32515dbd56e3SPeter Brune 
3252ec4806b8SPeter Brune    Calling sequence for ddhook:
3253ec4806b8SPeter Brune $    ddhook(DM global,DM block,void *ctx)
3254ec4806b8SPeter Brune 
3255ec4806b8SPeter Brune +  global - global DM
3256ec4806b8SPeter Brune .  block  - block DM
3257ec4806b8SPeter Brune -  ctx - optional user-defined function context
3258ec4806b8SPeter Brune 
32595dbd56e3SPeter Brune    Calling sequence for restricthook:
3260ec4806b8SPeter Brune $    restricthook(DM global,VecScatter out,VecScatter in,DM block,void *ctx)
32615dbd56e3SPeter Brune 
32625dbd56e3SPeter Brune +  global - global DM
32635dbd56e3SPeter Brune .  out    - scatter to the outer (with ghost and overlap points) block vector
32645dbd56e3SPeter Brune .  in     - scatter to block vector values only owned locally
3265ec4806b8SPeter Brune .  block  - block DM
32665dbd56e3SPeter Brune -  ctx - optional user-defined function context
32675dbd56e3SPeter Brune 
32685dbd56e3SPeter Brune    Level: advanced
32695dbd56e3SPeter Brune 
32705dbd56e3SPeter Brune    Notes:
3271ec4806b8SPeter Brune    This function is only needed if auxiliary data needs to be set up on subdomain DMs.
32725dbd56e3SPeter Brune 
32735dbd56e3SPeter Brune    If this function is called multiple times, the hooks will be run in the order they are added.
32745dbd56e3SPeter Brune 
32755dbd56e3SPeter Brune    In order to compose with nonlinear preconditioning without duplicating storage, the hook should be implemented to
3276ec4806b8SPeter Brune    extract the global information from its context (instead of from the SNES).
32775dbd56e3SPeter Brune 
3278bb9467b5SJed Brown    This function is currently not available from Fortran.
3279bb9467b5SJed Brown 
32805dbd56e3SPeter Brune .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
32815dbd56e3SPeter Brune @*/
3282be081cd6SPeter Brune PetscErrorCode DMSubDomainHookAdd(DM global,PetscErrorCode (*ddhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,VecScatter,VecScatter,DM,void*),void *ctx)
32835dbd56e3SPeter Brune {
32845dbd56e3SPeter Brune   PetscErrorCode      ierr;
3285be081cd6SPeter Brune   DMSubDomainHookLink link,*p;
32865dbd56e3SPeter Brune 
32875dbd56e3SPeter Brune   PetscFunctionBegin;
32885dbd56e3SPeter Brune   PetscValidHeaderSpecific(global,DM_CLASSID,1);
3289b3a6b972SJed Brown   for (p=&global->subdomainhook; *p; p=&(*p)->next) { /* Scan to the end of the current list of hooks */
3290b3a6b972SJed Brown     if ((*p)->ddhook == ddhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) PetscFunctionReturn(0);
3291b3a6b972SJed Brown   }
329295dccacaSBarry Smith   ierr               = PetscNew(&link);CHKERRQ(ierr);
32935dbd56e3SPeter Brune   link->restricthook = restricthook;
3294be081cd6SPeter Brune   link->ddhook       = ddhook;
32955dbd56e3SPeter Brune   link->ctx          = ctx;
32960298fd71SBarry Smith   link->next         = NULL;
32975dbd56e3SPeter Brune   *p                 = link;
32985dbd56e3SPeter Brune   PetscFunctionReturn(0);
32995dbd56e3SPeter Brune }
33005dbd56e3SPeter Brune 
3301b3a6b972SJed Brown /*@C
3302b3a6b972SJed Brown    DMSubDomainHookRemove - remove a callback from the list to be run when restricting a problem to the coarse grid
3303b3a6b972SJed Brown 
3304b3a6b972SJed Brown    Logically Collective
3305b3a6b972SJed Brown 
3306b3a6b972SJed Brown    Input Arguments:
3307b3a6b972SJed Brown +  global - global DM
3308b3a6b972SJed Brown .  ddhook - function to run to pass data to the decomposition DM upon its creation
3309b3a6b972SJed Brown .  restricthook - function to run to update data on block solve (at the beginning of the block solve)
3310b3a6b972SJed Brown -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
3311b3a6b972SJed Brown 
3312b3a6b972SJed Brown    Level: advanced
3313b3a6b972SJed Brown 
3314b3a6b972SJed Brown    Notes:
3315b3a6b972SJed Brown 
3316b3a6b972SJed Brown    This function is currently not available from Fortran.
3317b3a6b972SJed Brown 
3318b3a6b972SJed Brown .seealso: DMSubDomainHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
3319b3a6b972SJed Brown @*/
3320b3a6b972SJed Brown PetscErrorCode DMSubDomainHookRemove(DM global,PetscErrorCode (*ddhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,VecScatter,VecScatter,DM,void*),void *ctx)
3321b3a6b972SJed Brown {
3322b3a6b972SJed Brown   PetscErrorCode      ierr;
3323b3a6b972SJed Brown   DMSubDomainHookLink link,*p;
3324b3a6b972SJed Brown 
3325b3a6b972SJed Brown   PetscFunctionBegin;
3326b3a6b972SJed Brown   PetscValidHeaderSpecific(global,DM_CLASSID,1);
3327b3a6b972SJed Brown   for (p=&global->subdomainhook; *p; p=&(*p)->next) { /* Search the list of current hooks */
3328b3a6b972SJed Brown     if ((*p)->ddhook == ddhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) {
3329b3a6b972SJed Brown       link = *p;
3330b3a6b972SJed Brown       *p = link->next;
3331b3a6b972SJed Brown       ierr = PetscFree(link);CHKERRQ(ierr);
3332b3a6b972SJed Brown       break;
3333b3a6b972SJed Brown     }
3334b3a6b972SJed Brown   }
3335b3a6b972SJed Brown   PetscFunctionReturn(0);
3336b3a6b972SJed Brown }
3337b3a6b972SJed Brown 
33385dbd56e3SPeter Brune /*@
3339be081cd6SPeter Brune    DMSubDomainRestrict - restricts user-defined problem data to a block DM by running hooks registered by DMSubDomainHookAdd()
33405dbd56e3SPeter Brune 
33415dbd56e3SPeter Brune    Collective if any hooks are
33425dbd56e3SPeter Brune 
33435dbd56e3SPeter Brune    Input Arguments:
33445dbd56e3SPeter Brune +  fine - finer DM to use as a base
3345be081cd6SPeter Brune .  oscatter - scatter from domain global vector filling subdomain global vector with overlap
3346be081cd6SPeter Brune .  gscatter - scatter from domain global vector filling subdomain local vector with ghosts
33475dbd56e3SPeter Brune -  coarse - coarer DM to update
33485dbd56e3SPeter Brune 
33495dbd56e3SPeter Brune    Level: developer
33505dbd56e3SPeter Brune 
33515dbd56e3SPeter Brune .seealso: DMCoarsenHookAdd(), MatRestrict()
33525dbd56e3SPeter Brune @*/
3353be081cd6SPeter Brune PetscErrorCode DMSubDomainRestrict(DM global,VecScatter oscatter,VecScatter gscatter,DM subdm)
33545dbd56e3SPeter Brune {
33555dbd56e3SPeter Brune   PetscErrorCode      ierr;
3356be081cd6SPeter Brune   DMSubDomainHookLink link;
33575dbd56e3SPeter Brune 
33585dbd56e3SPeter Brune   PetscFunctionBegin;
3359be081cd6SPeter Brune   for (link=global->subdomainhook; link; link=link->next) {
33608865f1eaSKarl Rupp     if (link->restricthook) {
33618865f1eaSKarl Rupp       ierr = (*link->restricthook)(global,oscatter,gscatter,subdm,link->ctx);CHKERRQ(ierr);
33628865f1eaSKarl Rupp     }
33635dbd56e3SPeter Brune   }
33645dbd56e3SPeter Brune   PetscFunctionReturn(0);
33655dbd56e3SPeter Brune }
33665dbd56e3SPeter Brune 
33675fe1f584SPeter Brune /*@
33686a7d9d85SPeter Brune     DMGetCoarsenLevel - Get's the number of coarsenings that have generated this DM.
33695fe1f584SPeter Brune 
33705fe1f584SPeter Brune     Not Collective
33715fe1f584SPeter Brune 
33725fe1f584SPeter Brune     Input Parameter:
33735fe1f584SPeter Brune .   dm - the DM object
33745fe1f584SPeter Brune 
33755fe1f584SPeter Brune     Output Parameter:
33766a7d9d85SPeter Brune .   level - number of coarsenings
33775fe1f584SPeter Brune 
33785fe1f584SPeter Brune     Level: developer
33795fe1f584SPeter Brune 
33806a7d9d85SPeter Brune .seealso DMCoarsen(), DMGetRefineLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
33815fe1f584SPeter Brune 
33825fe1f584SPeter Brune @*/
33835fe1f584SPeter Brune PetscErrorCode  DMGetCoarsenLevel(DM dm,PetscInt *level)
33845fe1f584SPeter Brune {
33855fe1f584SPeter Brune   PetscFunctionBegin;
33865fe1f584SPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3387b9d85ea2SLisandro Dalcin   PetscValidIntPointer(level,2);
33885fe1f584SPeter Brune   *level = dm->leveldown;
33895fe1f584SPeter Brune   PetscFunctionReturn(0);
33905fe1f584SPeter Brune }
33915fe1f584SPeter Brune 
33929a64c4a8SMatthew G. Knepley /*@
33939a64c4a8SMatthew G. Knepley     DMSetCoarsenLevel - Sets the number of coarsenings that have generated this DM.
33949a64c4a8SMatthew G. Knepley 
33959a64c4a8SMatthew G. Knepley     Not Collective
33969a64c4a8SMatthew G. Knepley 
33979a64c4a8SMatthew G. Knepley     Input Parameters:
33989a64c4a8SMatthew G. Knepley +   dm - the DM object
33999a64c4a8SMatthew G. Knepley -   level - number of coarsenings
34009a64c4a8SMatthew G. Knepley 
34019a64c4a8SMatthew G. Knepley     Level: developer
34029a64c4a8SMatthew G. Knepley 
34039a64c4a8SMatthew G. Knepley .seealso DMCoarsen(), DMGetCoarsenLevel(), DMGetRefineLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
34049a64c4a8SMatthew G. Knepley @*/
34059a64c4a8SMatthew G. Knepley PetscErrorCode DMSetCoarsenLevel(DM dm,PetscInt level)
34069a64c4a8SMatthew G. Knepley {
34079a64c4a8SMatthew G. Knepley   PetscFunctionBegin;
34089a64c4a8SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
34099a64c4a8SMatthew G. Knepley   dm->leveldown = level;
34109a64c4a8SMatthew G. Knepley   PetscFunctionReturn(0);
34119a64c4a8SMatthew G. Knepley }
34129a64c4a8SMatthew G. Knepley 
341347c6ae99SBarry Smith /*@C
341447c6ae99SBarry Smith     DMRefineHierarchy - Refines a DM object, all levels at once
341547c6ae99SBarry Smith 
3416d083f849SBarry Smith     Collective on dm
341747c6ae99SBarry Smith 
341847c6ae99SBarry Smith     Input Parameter:
341947c6ae99SBarry Smith +   dm - the DM object
342047c6ae99SBarry Smith -   nlevels - the number of levels of refinement
342147c6ae99SBarry Smith 
342247c6ae99SBarry Smith     Output Parameter:
342347c6ae99SBarry Smith .   dmf - the refined DM hierarchy
342447c6ae99SBarry Smith 
342547c6ae99SBarry Smith     Level: developer
342647c6ae99SBarry Smith 
3427e727c939SJed Brown .seealso DMCoarsenHierarchy(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
342847c6ae99SBarry Smith 
342947c6ae99SBarry Smith @*/
34307087cfbeSBarry Smith PetscErrorCode  DMRefineHierarchy(DM dm,PetscInt nlevels,DM dmf[])
343147c6ae99SBarry Smith {
343247c6ae99SBarry Smith   PetscErrorCode ierr;
343347c6ae99SBarry Smith 
343447c6ae99SBarry Smith   PetscFunctionBegin;
3435171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3436ce94432eSBarry Smith   if (nlevels < 0) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_OUTOFRANGE,"nlevels cannot be negative");
343747c6ae99SBarry Smith   if (nlevels == 0) PetscFunctionReturn(0);
3438b9d85ea2SLisandro Dalcin   PetscValidPointer(dmf,3);
343947c6ae99SBarry Smith   if (dm->ops->refinehierarchy) {
344047c6ae99SBarry Smith     ierr = (*dm->ops->refinehierarchy)(dm,nlevels,dmf);CHKERRQ(ierr);
344147c6ae99SBarry Smith   } else if (dm->ops->refine) {
344247c6ae99SBarry Smith     PetscInt i;
344347c6ae99SBarry Smith 
3444ce94432eSBarry Smith     ierr = DMRefine(dm,PetscObjectComm((PetscObject)dm),&dmf[0]);CHKERRQ(ierr);
344547c6ae99SBarry Smith     for (i=1; i<nlevels; i++) {
3446ce94432eSBarry Smith       ierr = DMRefine(dmf[i-1],PetscObjectComm((PetscObject)dm),&dmf[i]);CHKERRQ(ierr);
344747c6ae99SBarry Smith     }
3448ce94432eSBarry Smith   } else SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"No RefineHierarchy for this DM yet");
344947c6ae99SBarry Smith   PetscFunctionReturn(0);
345047c6ae99SBarry Smith }
345147c6ae99SBarry Smith 
345247c6ae99SBarry Smith /*@C
345347c6ae99SBarry Smith     DMCoarsenHierarchy - Coarsens a DM object, all levels at once
345447c6ae99SBarry Smith 
3455d083f849SBarry Smith     Collective on dm
345647c6ae99SBarry Smith 
345747c6ae99SBarry Smith     Input Parameter:
345847c6ae99SBarry Smith +   dm - the DM object
345947c6ae99SBarry Smith -   nlevels - the number of levels of coarsening
346047c6ae99SBarry Smith 
346147c6ae99SBarry Smith     Output Parameter:
346247c6ae99SBarry Smith .   dmc - the coarsened DM hierarchy
346347c6ae99SBarry Smith 
346447c6ae99SBarry Smith     Level: developer
346547c6ae99SBarry Smith 
3466e727c939SJed Brown .seealso DMRefineHierarchy(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
346747c6ae99SBarry Smith 
346847c6ae99SBarry Smith @*/
34697087cfbeSBarry Smith PetscErrorCode  DMCoarsenHierarchy(DM dm, PetscInt nlevels, DM dmc[])
347047c6ae99SBarry Smith {
347147c6ae99SBarry Smith   PetscErrorCode ierr;
347247c6ae99SBarry Smith 
347347c6ae99SBarry Smith   PetscFunctionBegin;
3474171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3475ce94432eSBarry Smith   if (nlevels < 0) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_OUTOFRANGE,"nlevels cannot be negative");
347647c6ae99SBarry Smith   if (nlevels == 0) PetscFunctionReturn(0);
347747c6ae99SBarry Smith   PetscValidPointer(dmc,3);
347847c6ae99SBarry Smith   if (dm->ops->coarsenhierarchy) {
347947c6ae99SBarry Smith     ierr = (*dm->ops->coarsenhierarchy)(dm, nlevels, dmc);CHKERRQ(ierr);
348047c6ae99SBarry Smith   } else if (dm->ops->coarsen) {
348147c6ae99SBarry Smith     PetscInt i;
348247c6ae99SBarry Smith 
3483ce94432eSBarry Smith     ierr = DMCoarsen(dm,PetscObjectComm((PetscObject)dm),&dmc[0]);CHKERRQ(ierr);
348447c6ae99SBarry Smith     for (i=1; i<nlevels; i++) {
3485ce94432eSBarry Smith       ierr = DMCoarsen(dmc[i-1],PetscObjectComm((PetscObject)dm),&dmc[i]);CHKERRQ(ierr);
348647c6ae99SBarry Smith     }
3487ce94432eSBarry Smith   } else SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"No CoarsenHierarchy for this DM yet");
348847c6ae99SBarry Smith   PetscFunctionReturn(0);
348947c6ae99SBarry Smith }
349047c6ae99SBarry Smith 
34911a266240SBarry Smith /*@C
34921a266240SBarry Smith     DMSetApplicationContextDestroy - Sets a user function that will be called to destroy the application context when the DM is destroyed
34931a266240SBarry Smith 
34941a266240SBarry Smith     Not Collective
34951a266240SBarry Smith 
34961a266240SBarry Smith     Input Parameters:
34971a266240SBarry Smith +   dm - the DM object
34981a266240SBarry Smith -   destroy - the destroy function
34991a266240SBarry Smith 
35001a266240SBarry Smith     Level: intermediate
35011a266240SBarry Smith 
3502e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
35031a266240SBarry Smith 
3504f07f9ceaSJed Brown @*/
35051a266240SBarry Smith PetscErrorCode  DMSetApplicationContextDestroy(DM dm,PetscErrorCode (*destroy)(void**))
35061a266240SBarry Smith {
35071a266240SBarry Smith   PetscFunctionBegin;
3508171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
35091a266240SBarry Smith   dm->ctxdestroy = destroy;
35101a266240SBarry Smith   PetscFunctionReturn(0);
35111a266240SBarry Smith }
35121a266240SBarry Smith 
3513b07ff414SBarry Smith /*@
35141b2093e4SBarry Smith     DMSetApplicationContext - Set a user context into a DM object
351547c6ae99SBarry Smith 
351647c6ae99SBarry Smith     Not Collective
351747c6ae99SBarry Smith 
351847c6ae99SBarry Smith     Input Parameters:
351947c6ae99SBarry Smith +   dm - the DM object
352047c6ae99SBarry Smith -   ctx - the user context
352147c6ae99SBarry Smith 
352247c6ae99SBarry Smith     Level: intermediate
352347c6ae99SBarry Smith 
3524e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
352547c6ae99SBarry Smith 
352647c6ae99SBarry Smith @*/
35271b2093e4SBarry Smith PetscErrorCode  DMSetApplicationContext(DM dm,void *ctx)
352847c6ae99SBarry Smith {
352947c6ae99SBarry Smith   PetscFunctionBegin;
3530171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
353147c6ae99SBarry Smith   dm->ctx = ctx;
353247c6ae99SBarry Smith   PetscFunctionReturn(0);
353347c6ae99SBarry Smith }
353447c6ae99SBarry Smith 
353547c6ae99SBarry Smith /*@
35361b2093e4SBarry Smith     DMGetApplicationContext - Gets a user context from a DM object
353747c6ae99SBarry Smith 
353847c6ae99SBarry Smith     Not Collective
353947c6ae99SBarry Smith 
354047c6ae99SBarry Smith     Input Parameter:
354147c6ae99SBarry Smith .   dm - the DM object
354247c6ae99SBarry Smith 
354347c6ae99SBarry Smith     Output Parameter:
354447c6ae99SBarry Smith .   ctx - the user context
354547c6ae99SBarry Smith 
354647c6ae99SBarry Smith     Level: intermediate
354747c6ae99SBarry Smith 
3548e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
354947c6ae99SBarry Smith 
355047c6ae99SBarry Smith @*/
35511b2093e4SBarry Smith PetscErrorCode  DMGetApplicationContext(DM dm,void *ctx)
355247c6ae99SBarry Smith {
355347c6ae99SBarry Smith   PetscFunctionBegin;
3554171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
35551b2093e4SBarry Smith   *(void**)ctx = dm->ctx;
355647c6ae99SBarry Smith   PetscFunctionReturn(0);
355747c6ae99SBarry Smith }
355847c6ae99SBarry Smith 
355908da532bSDmitry Karpeev /*@C
3560df3898eeSBarry Smith     DMSetVariableBounds - sets a function to compute the lower and upper bound vectors for SNESVI.
356108da532bSDmitry Karpeev 
3562d083f849SBarry Smith     Logically Collective on dm
356308da532bSDmitry Karpeev 
356408da532bSDmitry Karpeev     Input Parameter:
356508da532bSDmitry Karpeev +   dm - the DM object
35660298fd71SBarry Smith -   f - the function that computes variable bounds used by SNESVI (use NULL to cancel a previous function that was set)
356708da532bSDmitry Karpeev 
356808da532bSDmitry Karpeev     Level: intermediate
356908da532bSDmitry Karpeev 
3570835c3ec7SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext(),
357108da532bSDmitry Karpeev          DMSetJacobian()
357208da532bSDmitry Karpeev 
357308da532bSDmitry Karpeev @*/
357408da532bSDmitry Karpeev PetscErrorCode DMSetVariableBounds(DM dm,PetscErrorCode (*f)(DM,Vec,Vec))
357508da532bSDmitry Karpeev {
357608da532bSDmitry Karpeev   PetscFunctionBegin;
35775a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
357808da532bSDmitry Karpeev   dm->ops->computevariablebounds = f;
357908da532bSDmitry Karpeev   PetscFunctionReturn(0);
358008da532bSDmitry Karpeev }
358108da532bSDmitry Karpeev 
358208da532bSDmitry Karpeev /*@
358308da532bSDmitry Karpeev     DMHasVariableBounds - does the DM object have a variable bounds function?
358408da532bSDmitry Karpeev 
358508da532bSDmitry Karpeev     Not Collective
358608da532bSDmitry Karpeev 
358708da532bSDmitry Karpeev     Input Parameter:
358808da532bSDmitry Karpeev .   dm - the DM object to destroy
358908da532bSDmitry Karpeev 
359008da532bSDmitry Karpeev     Output Parameter:
359108da532bSDmitry Karpeev .   flg - PETSC_TRUE if the variable bounds function exists
359208da532bSDmitry Karpeev 
359308da532bSDmitry Karpeev     Level: developer
359408da532bSDmitry Karpeev 
359574e1e8c1SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
359608da532bSDmitry Karpeev 
359708da532bSDmitry Karpeev @*/
359808da532bSDmitry Karpeev PetscErrorCode DMHasVariableBounds(DM dm,PetscBool *flg)
359908da532bSDmitry Karpeev {
360008da532bSDmitry Karpeev   PetscFunctionBegin;
36015a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3602534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
360308da532bSDmitry Karpeev   *flg =  (dm->ops->computevariablebounds) ? PETSC_TRUE : PETSC_FALSE;
360408da532bSDmitry Karpeev   PetscFunctionReturn(0);
360508da532bSDmitry Karpeev }
360608da532bSDmitry Karpeev 
360708da532bSDmitry Karpeev /*@C
360808da532bSDmitry Karpeev     DMComputeVariableBounds - compute variable bounds used by SNESVI.
360908da532bSDmitry Karpeev 
3610d083f849SBarry Smith     Logically Collective on dm
361108da532bSDmitry Karpeev 
361208da532bSDmitry Karpeev     Input Parameters:
3613907376e6SBarry Smith .   dm - the DM object
361408da532bSDmitry Karpeev 
361508da532bSDmitry Karpeev     Output parameters:
361608da532bSDmitry Karpeev +   xl - lower bound
361708da532bSDmitry Karpeev -   xu - upper bound
361808da532bSDmitry Karpeev 
3619907376e6SBarry Smith     Level: advanced
3620907376e6SBarry Smith 
362195452b02SPatrick Sanan     Notes:
362295452b02SPatrick Sanan     This is generally not called by users. It calls the function provided by the user with DMSetVariableBounds()
362308da532bSDmitry Karpeev 
362474e1e8c1SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
362508da532bSDmitry Karpeev 
362608da532bSDmitry Karpeev @*/
362708da532bSDmitry Karpeev PetscErrorCode DMComputeVariableBounds(DM dm, Vec xl, Vec xu)
362808da532bSDmitry Karpeev {
362908da532bSDmitry Karpeev   PetscErrorCode ierr;
36305fd66863SKarl Rupp 
363108da532bSDmitry Karpeev   PetscFunctionBegin;
36325a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
363308da532bSDmitry Karpeev   PetscValidHeaderSpecific(xl,VEC_CLASSID,2);
36345a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(xu,VEC_CLASSID,3);
3635b9d85ea2SLisandro Dalcin   if (!dm->ops->computevariablebounds) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeVariableBounds",((PetscObject)dm)->type_name);
363608da532bSDmitry Karpeev   ierr = (*dm->ops->computevariablebounds)(dm, xl,xu);CHKERRQ(ierr);
363708da532bSDmitry Karpeev   PetscFunctionReturn(0);
363808da532bSDmitry Karpeev }
363908da532bSDmitry Karpeev 
3640b0ae01b7SPeter Brune /*@
3641b0ae01b7SPeter Brune     DMHasColoring - does the DM object have a method of providing a coloring?
3642b0ae01b7SPeter Brune 
3643b0ae01b7SPeter Brune     Not Collective
3644b0ae01b7SPeter Brune 
3645b0ae01b7SPeter Brune     Input Parameter:
3646b0ae01b7SPeter Brune .   dm - the DM object
3647b0ae01b7SPeter Brune 
3648b0ae01b7SPeter Brune     Output Parameter:
3649b0ae01b7SPeter Brune .   flg - PETSC_TRUE if the DM has facilities for DMCreateColoring().
3650b0ae01b7SPeter Brune 
3651b0ae01b7SPeter Brune     Level: developer
3652b0ae01b7SPeter Brune 
36531565f0a7SPatrick Sanan .seealso DMCreateColoring()
3654b0ae01b7SPeter Brune 
3655b0ae01b7SPeter Brune @*/
3656b0ae01b7SPeter Brune PetscErrorCode DMHasColoring(DM dm,PetscBool *flg)
3657b0ae01b7SPeter Brune {
3658b0ae01b7SPeter Brune   PetscFunctionBegin;
36595a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3660534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
3661b0ae01b7SPeter Brune   *flg =  (dm->ops->getcoloring) ? PETSC_TRUE : PETSC_FALSE;
3662b0ae01b7SPeter Brune   PetscFunctionReturn(0);
3663b0ae01b7SPeter Brune }
3664b0ae01b7SPeter Brune 
36653ad4599aSBarry Smith /*@
36663ad4599aSBarry Smith     DMHasCreateRestriction - does the DM object have a method of providing a restriction?
36673ad4599aSBarry Smith 
36683ad4599aSBarry Smith     Not Collective
36693ad4599aSBarry Smith 
36703ad4599aSBarry Smith     Input Parameter:
36713ad4599aSBarry Smith .   dm - the DM object
36723ad4599aSBarry Smith 
36733ad4599aSBarry Smith     Output Parameter:
36743ad4599aSBarry Smith .   flg - PETSC_TRUE if the DM has facilities for DMCreateRestriction().
36753ad4599aSBarry Smith 
36763ad4599aSBarry Smith     Level: developer
36773ad4599aSBarry Smith 
36781565f0a7SPatrick Sanan .seealso DMCreateRestriction()
36793ad4599aSBarry Smith 
36803ad4599aSBarry Smith @*/
36813ad4599aSBarry Smith PetscErrorCode DMHasCreateRestriction(DM dm,PetscBool *flg)
36823ad4599aSBarry Smith {
36833ad4599aSBarry Smith   PetscFunctionBegin;
36845a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3685534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
36863ad4599aSBarry Smith   *flg =  (dm->ops->createrestriction) ? PETSC_TRUE : PETSC_FALSE;
36873ad4599aSBarry Smith   PetscFunctionReturn(0);
36883ad4599aSBarry Smith }
36893ad4599aSBarry Smith 
3690a7058e45SLawrence Mitchell /*@
3691a7058e45SLawrence Mitchell     DMHasCreateInjection - does the DM object have a method of providing an injection?
3692a7058e45SLawrence Mitchell 
3693a7058e45SLawrence Mitchell     Not Collective
3694a7058e45SLawrence Mitchell 
3695a7058e45SLawrence Mitchell     Input Parameter:
3696a7058e45SLawrence Mitchell .   dm - the DM object
3697a7058e45SLawrence Mitchell 
3698a7058e45SLawrence Mitchell     Output Parameter:
3699a7058e45SLawrence Mitchell .   flg - PETSC_TRUE if the DM has facilities for DMCreateInjection().
3700a7058e45SLawrence Mitchell 
3701a7058e45SLawrence Mitchell     Level: developer
3702a7058e45SLawrence Mitchell 
37031565f0a7SPatrick Sanan .seealso DMCreateInjection()
3704a7058e45SLawrence Mitchell 
3705a7058e45SLawrence Mitchell @*/
3706a7058e45SLawrence Mitchell PetscErrorCode DMHasCreateInjection(DM dm,PetscBool *flg)
3707a7058e45SLawrence Mitchell {
37084a7a4c06SLawrence Mitchell   PetscErrorCode ierr;
37095a84ad33SLisandro Dalcin 
3710a7058e45SLawrence Mitchell   PetscFunctionBegin;
37115a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3712534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
37135a84ad33SLisandro Dalcin   if (dm->ops->hascreateinjection) {
37144a7a4c06SLawrence Mitchell     ierr = (*dm->ops->hascreateinjection)(dm,flg);CHKERRQ(ierr);
37155a84ad33SLisandro Dalcin   } else {
37165a84ad33SLisandro Dalcin     *flg = (dm->ops->createinjection) ? PETSC_TRUE : PETSC_FALSE;
37175a84ad33SLisandro Dalcin   }
3718a7058e45SLawrence Mitchell   PetscFunctionReturn(0);
3719a7058e45SLawrence Mitchell }
3720a7058e45SLawrence Mitchell 
37210298fd71SBarry Smith PetscFunctionList DMList              = NULL;
3722264ace61SBarry Smith PetscBool         DMRegisterAllCalled = PETSC_FALSE;
3723264ace61SBarry Smith 
3724264ace61SBarry Smith /*@C
3725264ace61SBarry Smith   DMSetType - Builds a DM, for a particular DM implementation.
3726264ace61SBarry Smith 
3727d083f849SBarry Smith   Collective on dm
3728264ace61SBarry Smith 
3729264ace61SBarry Smith   Input Parameters:
3730264ace61SBarry Smith + dm     - The DM object
3731264ace61SBarry Smith - method - The name of the DM type
3732264ace61SBarry Smith 
3733264ace61SBarry Smith   Options Database Key:
3734264ace61SBarry Smith . -dm_type <type> - Sets the DM type; use -help for a list of available types
3735264ace61SBarry Smith 
3736264ace61SBarry Smith   Notes:
3737e1589f56SBarry Smith   See "petsc/include/petscdm.h" for available DM types (for instance, DM1D, DM2D, or DM3D).
3738264ace61SBarry Smith 
3739264ace61SBarry Smith   Level: intermediate
3740264ace61SBarry Smith 
3741264ace61SBarry Smith .seealso: DMGetType(), DMCreate()
3742264ace61SBarry Smith @*/
374319fd82e9SBarry Smith PetscErrorCode  DMSetType(DM dm, DMType method)
3744264ace61SBarry Smith {
3745264ace61SBarry Smith   PetscErrorCode (*r)(DM);
3746264ace61SBarry Smith   PetscBool      match;
3747264ace61SBarry Smith   PetscErrorCode ierr;
3748264ace61SBarry Smith 
3749264ace61SBarry Smith   PetscFunctionBegin;
3750264ace61SBarry Smith   PetscValidHeaderSpecific(dm, DM_CLASSID,1);
3751251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject) dm, method, &match);CHKERRQ(ierr);
3752264ace61SBarry Smith   if (match) PetscFunctionReturn(0);
3753264ace61SBarry Smith 
37540f51fdf8SToby Isaac   ierr = DMRegisterAll();CHKERRQ(ierr);
37551c9cd337SJed Brown   ierr = PetscFunctionListFind(DMList,method,&r);CHKERRQ(ierr);
3756ce94432eSBarry Smith   if (!r) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_UNKNOWN_TYPE, "Unknown DM type: %s", method);
3757264ace61SBarry Smith 
3758264ace61SBarry Smith   if (dm->ops->destroy) {
3759264ace61SBarry Smith     ierr = (*dm->ops->destroy)(dm);CHKERRQ(ierr);
3760264ace61SBarry Smith   }
3761d57f96a3SLisandro Dalcin   ierr = PetscMemzero(dm->ops,sizeof(*dm->ops));CHKERRQ(ierr);
3762264ace61SBarry Smith   ierr = PetscObjectChangeTypeName((PetscObject)dm,method);CHKERRQ(ierr);
3763d57f96a3SLisandro Dalcin   ierr = (*r)(dm);CHKERRQ(ierr);
3764264ace61SBarry Smith   PetscFunctionReturn(0);
3765264ace61SBarry Smith }
3766264ace61SBarry Smith 
3767264ace61SBarry Smith /*@C
3768264ace61SBarry Smith   DMGetType - Gets the DM type name (as a string) from the DM.
3769264ace61SBarry Smith 
3770264ace61SBarry Smith   Not Collective
3771264ace61SBarry Smith 
3772264ace61SBarry Smith   Input Parameter:
3773264ace61SBarry Smith . dm  - The DM
3774264ace61SBarry Smith 
3775264ace61SBarry Smith   Output Parameter:
3776264ace61SBarry Smith . type - The DM type name
3777264ace61SBarry Smith 
3778264ace61SBarry Smith   Level: intermediate
3779264ace61SBarry Smith 
3780264ace61SBarry Smith .seealso: DMSetType(), DMCreate()
3781264ace61SBarry Smith @*/
378219fd82e9SBarry Smith PetscErrorCode  DMGetType(DM dm, DMType *type)
3783264ace61SBarry Smith {
3784264ace61SBarry Smith   PetscErrorCode ierr;
3785264ace61SBarry Smith 
3786264ace61SBarry Smith   PetscFunctionBegin;
3787264ace61SBarry Smith   PetscValidHeaderSpecific(dm, DM_CLASSID,1);
3788c959eef4SJed Brown   PetscValidPointer(type,2);
3789607a6623SBarry Smith   ierr = DMRegisterAll();CHKERRQ(ierr);
3790264ace61SBarry Smith   *type = ((PetscObject)dm)->type_name;
3791264ace61SBarry Smith   PetscFunctionReturn(0);
3792264ace61SBarry Smith }
3793264ace61SBarry Smith 
379467a56275SMatthew G Knepley /*@C
379567a56275SMatthew G Knepley   DMConvert - Converts a DM to another DM, either of the same or different type.
379667a56275SMatthew G Knepley 
3797d083f849SBarry Smith   Collective on dm
379867a56275SMatthew G Knepley 
379967a56275SMatthew G Knepley   Input Parameters:
380067a56275SMatthew G Knepley + dm - the DM
380167a56275SMatthew G Knepley - newtype - new DM type (use "same" for the same type)
380267a56275SMatthew G Knepley 
380367a56275SMatthew G Knepley   Output Parameter:
380467a56275SMatthew G Knepley . M - pointer to new DM
380567a56275SMatthew G Knepley 
380667a56275SMatthew G Knepley   Notes:
380767a56275SMatthew G Knepley   Cannot be used to convert a sequential DM to parallel or parallel to sequential,
380867a56275SMatthew G Knepley   the MPI communicator of the generated DM is always the same as the communicator
380967a56275SMatthew G Knepley   of the input DM.
381067a56275SMatthew G Knepley 
381167a56275SMatthew G Knepley   Level: intermediate
381267a56275SMatthew G Knepley 
381367a56275SMatthew G Knepley .seealso: DMCreate()
381467a56275SMatthew G Knepley @*/
381519fd82e9SBarry Smith PetscErrorCode DMConvert(DM dm, DMType newtype, DM *M)
381667a56275SMatthew G Knepley {
381767a56275SMatthew G Knepley   DM             B;
381867a56275SMatthew G Knepley   char           convname[256];
3819c067b6caSMatthew G. Knepley   PetscBool      sametype/*, issame */;
382067a56275SMatthew G Knepley   PetscErrorCode ierr;
382167a56275SMatthew G Knepley 
382267a56275SMatthew G Knepley   PetscFunctionBegin;
382367a56275SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
382467a56275SMatthew G Knepley   PetscValidType(dm,1);
382567a56275SMatthew G Knepley   PetscValidPointer(M,3);
3826251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject) dm, newtype, &sametype);CHKERRQ(ierr);
3827c067b6caSMatthew G. Knepley   /* ierr = PetscStrcmp(newtype, "same", &issame);CHKERRQ(ierr); */
3828c067b6caSMatthew G. Knepley   if (sametype) {
3829c067b6caSMatthew G. Knepley     *M   = dm;
3830c067b6caSMatthew G. Knepley     ierr = PetscObjectReference((PetscObject) dm);CHKERRQ(ierr);
3831c067b6caSMatthew G. Knepley     PetscFunctionReturn(0);
3832c067b6caSMatthew G. Knepley   } else {
38330298fd71SBarry Smith     PetscErrorCode (*conv)(DM, DMType, DM*) = NULL;
383467a56275SMatthew G Knepley 
383567a56275SMatthew G Knepley     /*
383667a56275SMatthew G Knepley        Order of precedence:
383767a56275SMatthew G Knepley        1) See if a specialized converter is known to the current DM.
383867a56275SMatthew G Knepley        2) See if a specialized converter is known to the desired DM class.
383967a56275SMatthew G Knepley        3) See if a good general converter is registered for the desired class
384067a56275SMatthew G Knepley        4) See if a good general converter is known for the current matrix.
384167a56275SMatthew G Knepley        5) Use a really basic converter.
384267a56275SMatthew G Knepley     */
384367a56275SMatthew G Knepley 
384467a56275SMatthew G Knepley     /* 1) See if a specialized converter is known to the current DM and the desired class */
3845a126751eSBarry Smith     ierr = PetscStrncpy(convname,"DMConvert_",sizeof(convname));CHKERRQ(ierr);
3846a126751eSBarry Smith     ierr = PetscStrlcat(convname,((PetscObject) dm)->type_name,sizeof(convname));CHKERRQ(ierr);
3847a126751eSBarry Smith     ierr = PetscStrlcat(convname,"_",sizeof(convname));CHKERRQ(ierr);
3848a126751eSBarry Smith     ierr = PetscStrlcat(convname,newtype,sizeof(convname));CHKERRQ(ierr);
3849a126751eSBarry Smith     ierr = PetscStrlcat(convname,"_C",sizeof(convname));CHKERRQ(ierr);
38500005d66cSJed Brown     ierr = PetscObjectQueryFunction((PetscObject)dm,convname,&conv);CHKERRQ(ierr);
385167a56275SMatthew G Knepley     if (conv) goto foundconv;
385267a56275SMatthew G Knepley 
385367a56275SMatthew G Knepley     /* 2)  See if a specialized converter is known to the desired DM class. */
385482f516ccSBarry Smith     ierr = DMCreate(PetscObjectComm((PetscObject)dm), &B);CHKERRQ(ierr);
385567a56275SMatthew G Knepley     ierr = DMSetType(B, newtype);CHKERRQ(ierr);
3856a126751eSBarry Smith     ierr = PetscStrncpy(convname,"DMConvert_",sizeof(convname));CHKERRQ(ierr);
3857a126751eSBarry Smith     ierr = PetscStrlcat(convname,((PetscObject) dm)->type_name,sizeof(convname));CHKERRQ(ierr);
3858a126751eSBarry Smith     ierr = PetscStrlcat(convname,"_",sizeof(convname));CHKERRQ(ierr);
3859a126751eSBarry Smith     ierr = PetscStrlcat(convname,newtype,sizeof(convname));CHKERRQ(ierr);
3860a126751eSBarry Smith     ierr = PetscStrlcat(convname,"_C",sizeof(convname));CHKERRQ(ierr);
38610005d66cSJed Brown     ierr = PetscObjectQueryFunction((PetscObject)B,convname,&conv);CHKERRQ(ierr);
386267a56275SMatthew G Knepley     if (conv) {
3863fcfd50ebSBarry Smith       ierr = DMDestroy(&B);CHKERRQ(ierr);
386467a56275SMatthew G Knepley       goto foundconv;
386567a56275SMatthew G Knepley     }
386667a56275SMatthew G Knepley 
386767a56275SMatthew G Knepley #if 0
386867a56275SMatthew G Knepley     /* 3) See if a good general converter is registered for the desired class */
386967a56275SMatthew G Knepley     conv = B->ops->convertfrom;
3870fcfd50ebSBarry Smith     ierr = DMDestroy(&B);CHKERRQ(ierr);
387167a56275SMatthew G Knepley     if (conv) goto foundconv;
387267a56275SMatthew G Knepley 
387367a56275SMatthew G Knepley     /* 4) See if a good general converter is known for the current matrix */
387467a56275SMatthew G Knepley     if (dm->ops->convert) {
387567a56275SMatthew G Knepley       conv = dm->ops->convert;
387667a56275SMatthew G Knepley     }
387767a56275SMatthew G Knepley     if (conv) goto foundconv;
387867a56275SMatthew G Knepley #endif
387967a56275SMatthew G Knepley 
388067a56275SMatthew G Knepley     /* 5) Use a really basic converter. */
388182f516ccSBarry Smith     SETERRQ2(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "No conversion possible between DM types %s and %s", ((PetscObject) dm)->type_name, newtype);
388267a56275SMatthew G Knepley 
388367a56275SMatthew G Knepley foundconv:
388467a56275SMatthew G Knepley     ierr = PetscLogEventBegin(DM_Convert,dm,0,0,0);CHKERRQ(ierr);
388567a56275SMatthew G Knepley     ierr = (*conv)(dm,newtype,M);CHKERRQ(ierr);
388612fa691eSMatthew G. Knepley     /* Things that are independent of DM type: We should consult DMClone() here */
388790b157c4SStefano Zampini     {
388890b157c4SStefano Zampini       PetscBool             isper;
388912fa691eSMatthew G. Knepley       const PetscReal      *maxCell, *L;
389012fa691eSMatthew G. Knepley       const DMBoundaryType *bd;
389190b157c4SStefano Zampini       ierr = DMGetPeriodicity(dm, &isper, &maxCell, &L, &bd);CHKERRQ(ierr);
389290b157c4SStefano Zampini       ierr = DMSetPeriodicity(*M, isper, maxCell,  L,  bd);CHKERRQ(ierr);
3893c8a6034eSMark       (*M)->prealloc_only = dm->prealloc_only;
3894a587d139SMark       ierr = PetscFree((*M)->vectype);CHKERRQ(ierr);
3895a587d139SMark       ierr = PetscStrallocpy(dm->vectype,(char**)&(*M)->vectype);CHKERRQ(ierr);
3896a587d139SMark       ierr = PetscFree((*M)->mattype);CHKERRQ(ierr);
3897a587d139SMark       ierr = PetscStrallocpy(dm->mattype,(char**)&(*M)->mattype);CHKERRQ(ierr);
389812fa691eSMatthew G. Knepley     }
389967a56275SMatthew G Knepley     ierr = PetscLogEventEnd(DM_Convert,dm,0,0,0);CHKERRQ(ierr);
390067a56275SMatthew G Knepley   }
390167a56275SMatthew G Knepley   ierr = PetscObjectStateIncrease((PetscObject) *M);CHKERRQ(ierr);
390267a56275SMatthew G Knepley   PetscFunctionReturn(0);
390367a56275SMatthew G Knepley }
3904264ace61SBarry Smith 
3905264ace61SBarry Smith /*--------------------------------------------------------------------------------------------------------------------*/
3906264ace61SBarry Smith 
3907264ace61SBarry Smith /*@C
39081c84c290SBarry Smith   DMRegister -  Adds a new DM component implementation
39091c84c290SBarry Smith 
39101c84c290SBarry Smith   Not Collective
39111c84c290SBarry Smith 
39121c84c290SBarry Smith   Input Parameters:
39131c84c290SBarry Smith + name        - The name of a new user-defined creation routine
39141c84c290SBarry Smith - create_func - The creation routine itself
39151c84c290SBarry Smith 
39161c84c290SBarry Smith   Notes:
39171c84c290SBarry Smith   DMRegister() may be called multiple times to add several user-defined DMs
39181c84c290SBarry Smith 
39191c84c290SBarry Smith   Sample usage:
39201c84c290SBarry Smith .vb
3921bdf89e91SBarry Smith     DMRegister("my_da", MyDMCreate);
39221c84c290SBarry Smith .ve
39231c84c290SBarry Smith 
39241c84c290SBarry Smith   Then, your DM type can be chosen with the procedural interface via
39251c84c290SBarry Smith .vb
39261c84c290SBarry Smith     DMCreate(MPI_Comm, DM *);
39271c84c290SBarry Smith     DMSetType(DM,"my_da");
39281c84c290SBarry Smith .ve
39291c84c290SBarry Smith    or at runtime via the option
39301c84c290SBarry Smith .vb
39311c84c290SBarry Smith     -da_type my_da
39321c84c290SBarry Smith .ve
3933264ace61SBarry Smith 
3934264ace61SBarry Smith   Level: advanced
39351c84c290SBarry Smith 
3936bdf89e91SBarry Smith .seealso: DMRegisterAll(), DMRegisterDestroy()
39371c84c290SBarry Smith 
3938264ace61SBarry Smith @*/
3939bdf89e91SBarry Smith PetscErrorCode  DMRegister(const char sname[],PetscErrorCode (*function)(DM))
3940264ace61SBarry Smith {
3941264ace61SBarry Smith   PetscErrorCode ierr;
3942264ace61SBarry Smith 
3943264ace61SBarry Smith   PetscFunctionBegin;
39441d36bdfdSBarry Smith   ierr = DMInitializePackage();CHKERRQ(ierr);
3945a240a19fSJed Brown   ierr = PetscFunctionListAdd(&DMList,sname,function);CHKERRQ(ierr);
3946264ace61SBarry Smith   PetscFunctionReturn(0);
3947264ace61SBarry Smith }
3948264ace61SBarry Smith 
3949b859378eSBarry Smith /*@C
395055849f57SBarry Smith   DMLoad - Loads a DM that has been stored in binary  with DMView().
3951b859378eSBarry Smith 
3952d083f849SBarry Smith   Collective on viewer
3953b859378eSBarry Smith 
3954b859378eSBarry Smith   Input Parameters:
3955b859378eSBarry Smith + newdm - the newly loaded DM, this needs to have been created with DMCreate() or
3956b859378eSBarry Smith            some related function before a call to DMLoad().
3957b859378eSBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen() or
3958b859378eSBarry Smith            HDF5 file viewer, obtained from PetscViewerHDF5Open()
3959b859378eSBarry Smith 
3960b859378eSBarry Smith    Level: intermediate
3961b859378eSBarry Smith 
3962b859378eSBarry Smith   Notes:
396355849f57SBarry Smith    The type is determined by the data in the file, any type set into the DM before this call is ignored.
3964b859378eSBarry Smith 
3965b859378eSBarry Smith   Notes for advanced users:
3966b859378eSBarry Smith   Most users should not need to know the details of the binary storage
3967b859378eSBarry Smith   format, since DMLoad() and DMView() completely hide these details.
3968b859378eSBarry Smith   But for anyone who's interested, the standard binary matrix storage
3969b859378eSBarry Smith   format is
3970b859378eSBarry Smith .vb
3971b859378eSBarry Smith      has not yet been determined
3972b859378eSBarry Smith .ve
3973b859378eSBarry Smith 
3974b859378eSBarry Smith .seealso: PetscViewerBinaryOpen(), DMView(), MatLoad(), VecLoad()
3975b859378eSBarry Smith @*/
3976b859378eSBarry Smith PetscErrorCode  DMLoad(DM newdm, PetscViewer viewer)
3977b859378eSBarry Smith {
39789331c7a4SMatthew G. Knepley   PetscBool      isbinary, ishdf5;
3979b859378eSBarry Smith   PetscErrorCode ierr;
3980b859378eSBarry Smith 
3981b859378eSBarry Smith   PetscFunctionBegin;
3982b859378eSBarry Smith   PetscValidHeaderSpecific(newdm,DM_CLASSID,1);
3983b859378eSBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
3984fb694a9eSVaclav Hapla   ierr = PetscViewerCheckReadable(viewer);CHKERRQ(ierr);
398532c0f0efSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
39869331c7a4SMatthew G. Knepley   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERHDF5,&ishdf5);CHKERRQ(ierr);
398758cd63d5SVaclav Hapla   ierr = PetscLogEventBegin(DM_Load,viewer,0,0,0);CHKERRQ(ierr);
39889331c7a4SMatthew G. Knepley   if (isbinary) {
39899331c7a4SMatthew G. Knepley     PetscInt classid;
39909331c7a4SMatthew G. Knepley     char     type[256];
3991b859378eSBarry Smith 
3992060da220SMatthew G. Knepley     ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr);
39939200755eSBarry Smith     if (classid != DM_FILE_CLASSID) SETERRQ1(PetscObjectComm((PetscObject)newdm),PETSC_ERR_ARG_WRONG,"Not DM next in file, classid found %d",(int)classid);
3994060da220SMatthew G. Knepley     ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr);
399532c0f0efSBarry Smith     ierr = DMSetType(newdm, type);CHKERRQ(ierr);
39969331c7a4SMatthew G. Knepley     if (newdm->ops->load) {ierr = (*newdm->ops->load)(newdm,viewer);CHKERRQ(ierr);}
39979331c7a4SMatthew G. Knepley   } else if (ishdf5) {
39989331c7a4SMatthew G. Knepley     if (newdm->ops->load) {ierr = (*newdm->ops->load)(newdm,viewer);CHKERRQ(ierr);}
39999331c7a4SMatthew G. Knepley   } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen() or PetscViewerHDF5Open()");
400058cd63d5SVaclav Hapla   ierr = PetscLogEventEnd(DM_Load,viewer,0,0,0);CHKERRQ(ierr);
4001b859378eSBarry Smith   PetscFunctionReturn(0);
4002b859378eSBarry Smith }
4003b859378eSBarry Smith 
4004b2e4378dSMatthew G. Knepley /*@
4005b2e4378dSMatthew G. Knepley   DMGetLocalBoundingBox - Returns the bounding box for the piece of the DM on this process.
4006b2e4378dSMatthew G. Knepley 
4007b2e4378dSMatthew G. Knepley   Not collective
4008b2e4378dSMatthew G. Knepley 
4009b2e4378dSMatthew G. Knepley   Input Parameter:
4010b2e4378dSMatthew G. Knepley . dm - the DM
4011b2e4378dSMatthew G. Knepley 
4012b2e4378dSMatthew G. Knepley   Output Parameters:
4013b2e4378dSMatthew G. Knepley + lmin - local minimum coordinates (length coord dim, optional)
4014b2e4378dSMatthew G. Knepley - lmax - local maximim coordinates (length coord dim, optional)
4015b2e4378dSMatthew G. Knepley 
4016b2e4378dSMatthew G. Knepley   Level: beginner
4017b2e4378dSMatthew G. Knepley 
4018b2e4378dSMatthew G. Knepley   Note: If the DM is a DMDA and has no coordinates, the index bounds are returned instead.
4019b2e4378dSMatthew G. Knepley 
4020b2e4378dSMatthew G. Knepley .seealso: DMGetCoordinates(), DMGetCoordinatesLocal(), DMGetBoundingBox()
4021b2e4378dSMatthew G. Knepley @*/
4022b2e4378dSMatthew G. Knepley PetscErrorCode DMGetLocalBoundingBox(DM dm, PetscReal lmin[], PetscReal lmax[])
4023b2e4378dSMatthew G. Knepley {
4024b2e4378dSMatthew G. Knepley   Vec                coords = NULL;
4025b2e4378dSMatthew G. Knepley   PetscReal          min[3] = {PETSC_MAX_REAL, PETSC_MAX_REAL, PETSC_MAX_REAL};
4026b2e4378dSMatthew G. Knepley   PetscReal          max[3] = {PETSC_MIN_REAL, PETSC_MIN_REAL, PETSC_MIN_REAL};
4027b2e4378dSMatthew G. Knepley   const PetscScalar *local_coords;
4028b2e4378dSMatthew G. Knepley   PetscInt           N, Ni;
4029b2e4378dSMatthew G. Knepley   PetscInt           cdim, i, j;
4030b2e4378dSMatthew G. Knepley   PetscErrorCode     ierr;
4031b2e4378dSMatthew G. Knepley 
4032b2e4378dSMatthew G. Knepley   PetscFunctionBegin;
4033b2e4378dSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4034b2e4378dSMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
4035b2e4378dSMatthew G. Knepley   ierr = DMGetCoordinates(dm, &coords);CHKERRQ(ierr);
4036b2e4378dSMatthew G. Knepley   if (coords) {
4037b2e4378dSMatthew G. Knepley     ierr = VecGetArrayRead(coords, &local_coords);CHKERRQ(ierr);
4038b2e4378dSMatthew G. Knepley     ierr = VecGetLocalSize(coords, &N);CHKERRQ(ierr);
4039b2e4378dSMatthew G. Knepley     Ni   = N/cdim;
4040b2e4378dSMatthew G. Knepley     for (i = 0; i < Ni; ++i) {
4041b2e4378dSMatthew G. Knepley       for (j = 0; j < 3; ++j) {
4042b2e4378dSMatthew G. Knepley         min[j] = j < cdim ? PetscMin(min[j], PetscRealPart(local_coords[i*cdim+j])) : 0;
4043b2e4378dSMatthew G. Knepley         max[j] = j < cdim ? PetscMax(max[j], PetscRealPart(local_coords[i*cdim+j])) : 0;
4044b2e4378dSMatthew G. Knepley       }
4045b2e4378dSMatthew G. Knepley     }
4046b2e4378dSMatthew G. Knepley     ierr = VecRestoreArrayRead(coords, &local_coords);CHKERRQ(ierr);
4047b2e4378dSMatthew G. Knepley   } else {
4048b2e4378dSMatthew G. Knepley     PetscBool isda;
4049b2e4378dSMatthew G. Knepley 
4050b2e4378dSMatthew G. Knepley     ierr = PetscObjectTypeCompare((PetscObject) dm, DMDA, &isda);CHKERRQ(ierr);
4051b2e4378dSMatthew G. Knepley     if (isda) {ierr = DMGetLocalBoundingIndices_DMDA(dm, min, max);CHKERRQ(ierr);}
4052b2e4378dSMatthew G. Knepley   }
4053b2e4378dSMatthew G. Knepley   if (lmin) {ierr = PetscArraycpy(lmin, min, cdim);CHKERRQ(ierr);}
4054b2e4378dSMatthew G. Knepley   if (lmax) {ierr = PetscArraycpy(lmax, max, cdim);CHKERRQ(ierr);}
4055b2e4378dSMatthew G. Knepley   PetscFunctionReturn(0);
4056b2e4378dSMatthew G. Knepley }
4057b2e4378dSMatthew G. Knepley 
4058b2e4378dSMatthew G. Knepley /*@
4059b2e4378dSMatthew G. Knepley   DMGetBoundingBox - Returns the global bounding box for the DM.
4060b2e4378dSMatthew G. Knepley 
4061b2e4378dSMatthew G. Knepley   Collective
4062b2e4378dSMatthew G. Knepley 
4063b2e4378dSMatthew G. Knepley   Input Parameter:
4064b2e4378dSMatthew G. Knepley . dm - the DM
4065b2e4378dSMatthew G. Knepley 
4066b2e4378dSMatthew G. Knepley   Output Parameters:
4067b2e4378dSMatthew G. Knepley + gmin - global minimum coordinates (length coord dim, optional)
4068b2e4378dSMatthew G. Knepley - gmax - global maximim coordinates (length coord dim, optional)
4069b2e4378dSMatthew G. Knepley 
4070b2e4378dSMatthew G. Knepley   Level: beginner
4071b2e4378dSMatthew G. Knepley 
4072b2e4378dSMatthew G. Knepley .seealso: DMGetLocalBoundingBox(), DMGetCoordinates(), DMGetCoordinatesLocal()
4073b2e4378dSMatthew G. Knepley @*/
4074b2e4378dSMatthew G. Knepley PetscErrorCode DMGetBoundingBox(DM dm, PetscReal gmin[], PetscReal gmax[])
4075b2e4378dSMatthew G. Knepley {
4076b2e4378dSMatthew G. Knepley   PetscReal      lmin[3], lmax[3];
40776ce308c4SMatthew G. Knepley   PetscInt       cdim;
40786ce308c4SMatthew G. Knepley   PetscMPIInt    count;
4079b2e4378dSMatthew G. Knepley   PetscErrorCode ierr;
4080b2e4378dSMatthew G. Knepley 
4081b2e4378dSMatthew G. Knepley   PetscFunctionBegin;
4082b2e4378dSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4083b2e4378dSMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
4084b2e4378dSMatthew G. Knepley   ierr = PetscMPIIntCast(cdim, &count);CHKERRQ(ierr);
4085b2e4378dSMatthew G. Knepley   ierr = DMGetLocalBoundingBox(dm, lmin, lmax);CHKERRQ(ierr);
4086820f2d46SBarry Smith   if (gmin) {ierr = MPIU_Allreduce(lmin, gmin, count, MPIU_REAL, MPIU_MIN, PetscObjectComm((PetscObject) dm));CHKERRMPI(ierr);}
4087820f2d46SBarry Smith   if (gmax) {ierr = MPIU_Allreduce(lmax, gmax, count, MPIU_REAL, MPIU_MAX, PetscObjectComm((PetscObject) dm));CHKERRMPI(ierr);}
4088b2e4378dSMatthew G. Knepley   PetscFunctionReturn(0);
4089b2e4378dSMatthew G. Knepley }
4090b2e4378dSMatthew G. Knepley 
40917da65231SMatthew G Knepley /******************************** FEM Support **********************************/
40927da65231SMatthew G Knepley 
4093a6dfd86eSKarl Rupp PetscErrorCode DMPrintCellVector(PetscInt c, const char name[], PetscInt len, const PetscScalar x[])
4094a6dfd86eSKarl Rupp {
40951d47ebbbSSatish Balay   PetscInt       f;
40961b30c384SMatthew G Knepley   PetscErrorCode ierr;
40971b30c384SMatthew G Knepley 
40987da65231SMatthew G Knepley   PetscFunctionBegin;
409974778d6cSJed Brown   ierr = PetscPrintf(PETSC_COMM_SELF, "Cell %D Element %s\n", c, name);CHKERRQ(ierr);
41001d47ebbbSSatish Balay   for (f = 0; f < len; ++f) {
410157622a8eSBarry Smith     ierr = PetscPrintf(PETSC_COMM_SELF, "  | %g |\n", (double)PetscRealPart(x[f]));CHKERRQ(ierr);
41027da65231SMatthew G Knepley   }
41037da65231SMatthew G Knepley   PetscFunctionReturn(0);
41047da65231SMatthew G Knepley }
41057da65231SMatthew G Knepley 
4106a6dfd86eSKarl Rupp PetscErrorCode DMPrintCellMatrix(PetscInt c, const char name[], PetscInt rows, PetscInt cols, const PetscScalar A[])
4107a6dfd86eSKarl Rupp {
41081b30c384SMatthew G Knepley   PetscInt       f, g;
41097da65231SMatthew G Knepley   PetscErrorCode ierr;
41107da65231SMatthew G Knepley 
41117da65231SMatthew G Knepley   PetscFunctionBegin;
411274778d6cSJed Brown   ierr = PetscPrintf(PETSC_COMM_SELF, "Cell %D Element %s\n", c, name);CHKERRQ(ierr);
41131d47ebbbSSatish Balay   for (f = 0; f < rows; ++f) {
411474778d6cSJed Brown     ierr = PetscPrintf(PETSC_COMM_SELF, "  |");CHKERRQ(ierr);
41151d47ebbbSSatish Balay     for (g = 0; g < cols; ++g) {
4116e3556bceSMatthew G. Knepley       ierr = PetscPrintf(PETSC_COMM_SELF, " % 9.5g", PetscRealPart(A[f*cols+g]));CHKERRQ(ierr);
41177da65231SMatthew G Knepley     }
411874778d6cSJed Brown     ierr = PetscPrintf(PETSC_COMM_SELF, " |\n");CHKERRQ(ierr);
41197da65231SMatthew G Knepley   }
41207da65231SMatthew G Knepley   PetscFunctionReturn(0);
41217da65231SMatthew G Knepley }
4122e7c4fc90SDmitry Karpeev 
41236113b454SMatthew G. Knepley PetscErrorCode DMPrintLocalVec(DM dm, const char name[], PetscReal tol, Vec X)
4124e759306cSMatthew G. Knepley {
41250c5b8624SToby Isaac   PetscInt          localSize, bs;
41260c5b8624SToby Isaac   PetscMPIInt       size;
41270c5b8624SToby Isaac   Vec               x, xglob;
41280c5b8624SToby Isaac   const PetscScalar *xarray;
4129e759306cSMatthew G. Knepley   PetscErrorCode    ierr;
4130e759306cSMatthew G. Knepley 
4131e759306cSMatthew G. Knepley   PetscFunctionBegin;
4132ffc4695bSBarry Smith   ierr = MPI_Comm_size(PetscObjectComm((PetscObject) dm),&size);CHKERRMPI(ierr);
4133e759306cSMatthew G. Knepley   ierr = VecDuplicate(X, &x);CHKERRQ(ierr);
4134e759306cSMatthew G. Knepley   ierr = VecCopy(X, x);CHKERRQ(ierr);
41356113b454SMatthew G. Knepley   ierr = VecChop(x, tol);CHKERRQ(ierr);
41360c5b8624SToby Isaac   ierr = PetscPrintf(PetscObjectComm((PetscObject) dm),"%s:\n",name);CHKERRQ(ierr);
41370c5b8624SToby Isaac   if (size > 1) {
41380c5b8624SToby Isaac     ierr = VecGetLocalSize(x,&localSize);CHKERRQ(ierr);
41390c5b8624SToby Isaac     ierr = VecGetArrayRead(x,&xarray);CHKERRQ(ierr);
41400c5b8624SToby Isaac     ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
41410c5b8624SToby Isaac     ierr = VecCreateMPIWithArray(PetscObjectComm((PetscObject) dm),bs,localSize,PETSC_DETERMINE,xarray,&xglob);CHKERRQ(ierr);
41420c5b8624SToby Isaac   } else {
41430c5b8624SToby Isaac     xglob = x;
41440c5b8624SToby Isaac   }
41450c5b8624SToby Isaac   ierr = VecView(xglob,PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject) dm)));CHKERRQ(ierr);
41460c5b8624SToby Isaac   if (size > 1) {
41470c5b8624SToby Isaac     ierr = VecDestroy(&xglob);CHKERRQ(ierr);
41480c5b8624SToby Isaac     ierr = VecRestoreArrayRead(x,&xarray);CHKERRQ(ierr);
41490c5b8624SToby Isaac   }
4150e759306cSMatthew G. Knepley   ierr = VecDestroy(&x);CHKERRQ(ierr);
4151e759306cSMatthew G. Knepley   PetscFunctionReturn(0);
4152e759306cSMatthew G. Knepley }
4153e759306cSMatthew G. Knepley 
415488ed4aceSMatthew G Knepley /*@
41551bb6d2a8SBarry Smith   DMGetSection - Get the PetscSection encoding the local data layout for the DM.   This is equivalent to DMGetLocalSection(). Deprecated in v3.12
4156061576a5SJed Brown 
4157061576a5SJed Brown   Input Parameter:
4158061576a5SJed Brown . dm - The DM
4159061576a5SJed Brown 
4160061576a5SJed Brown   Output Parameter:
4161061576a5SJed Brown . section - The PetscSection
4162061576a5SJed Brown 
4163061576a5SJed Brown   Options Database Keys:
4164061576a5SJed Brown . -dm_petscsection_view - View the Section created by the DM
4165061576a5SJed Brown 
4166061576a5SJed Brown   Level: advanced
4167061576a5SJed Brown 
4168061576a5SJed Brown   Notes:
4169061576a5SJed Brown   Use DMGetLocalSection() in new code.
4170061576a5SJed Brown 
4171061576a5SJed Brown   This gets a borrowed reference, so the user should not destroy this PetscSection.
4172061576a5SJed Brown 
4173061576a5SJed Brown .seealso: DMGetLocalSection(), DMSetLocalSection(), DMGetGlobalSection()
4174061576a5SJed Brown @*/
4175061576a5SJed Brown PetscErrorCode DMGetSection(DM dm, PetscSection *section)
4176061576a5SJed Brown {
4177061576a5SJed Brown   PetscErrorCode ierr;
4178061576a5SJed Brown 
4179061576a5SJed Brown   PetscFunctionBegin;
4180061576a5SJed Brown   ierr = DMGetLocalSection(dm,section);CHKERRQ(ierr);
4181061576a5SJed Brown   PetscFunctionReturn(0);
4182061576a5SJed Brown }
4183061576a5SJed Brown 
4184061576a5SJed Brown /*@
4185061576a5SJed Brown   DMGetLocalSection - Get the PetscSection encoding the local data layout for the DM.
418688ed4aceSMatthew G Knepley 
418788ed4aceSMatthew G Knepley   Input Parameter:
418888ed4aceSMatthew G Knepley . dm - The DM
418988ed4aceSMatthew G Knepley 
419088ed4aceSMatthew G Knepley   Output Parameter:
419188ed4aceSMatthew G Knepley . section - The PetscSection
419288ed4aceSMatthew G Knepley 
4193e5893cccSMatthew G. Knepley   Options Database Keys:
4194e5893cccSMatthew G. Knepley . -dm_petscsection_view - View the Section created by the DM
4195e5893cccSMatthew G. Knepley 
419688ed4aceSMatthew G Knepley   Level: intermediate
419788ed4aceSMatthew G Knepley 
419888ed4aceSMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSection.
419988ed4aceSMatthew G Knepley 
4200061576a5SJed Brown .seealso: DMSetLocalSection(), DMGetGlobalSection()
420188ed4aceSMatthew G Knepley @*/
4202061576a5SJed Brown PetscErrorCode DMGetLocalSection(DM dm, PetscSection *section)
42030adebc6cSBarry Smith {
4204fd59a867SMatthew G. Knepley   PetscErrorCode ierr;
4205fd59a867SMatthew G. Knepley 
420688ed4aceSMatthew G Knepley   PetscFunctionBegin;
420788ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
420888ed4aceSMatthew G Knepley   PetscValidPointer(section, 2);
42091bb6d2a8SBarry Smith   if (!dm->localSection && dm->ops->createlocalsection) {
4210e5e52638SMatthew G. Knepley     PetscInt d;
4211e5e52638SMatthew G. Knepley 
421245480ffeSMatthew G. Knepley     if (dm->setfromoptionscalled) {
421345480ffeSMatthew G. Knepley       PetscObject       obj = (PetscObject) dm;
421445480ffeSMatthew G. Knepley       PetscViewer       viewer;
421545480ffeSMatthew G. Knepley       PetscViewerFormat format;
421645480ffeSMatthew G. Knepley       PetscBool         flg;
421745480ffeSMatthew G. Knepley 
421845480ffeSMatthew G. Knepley       ierr = PetscOptionsGetViewer(PetscObjectComm(obj), obj->options, obj->prefix, "-dm_petscds_view", &viewer, &format, &flg);CHKERRQ(ierr);
421945480ffeSMatthew G. Knepley       if (flg) {ierr = PetscViewerPushFormat(viewer, format);CHKERRQ(ierr);}
422045480ffeSMatthew G. Knepley       for (d = 0; d < dm->Nds; ++d) {
422145480ffeSMatthew G. Knepley         ierr = PetscDSSetFromOptions(dm->probs[d].ds);CHKERRQ(ierr);
422245480ffeSMatthew G. Knepley         if (flg) {ierr = PetscDSView(dm->probs[d].ds, viewer);CHKERRQ(ierr);}
422345480ffeSMatthew G. Knepley       }
422445480ffeSMatthew G. Knepley       if (flg) {
422545480ffeSMatthew G. Knepley         ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
422645480ffeSMatthew G. Knepley         ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
422745480ffeSMatthew G. Knepley         ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
422845480ffeSMatthew G. Knepley       }
422945480ffeSMatthew G. Knepley     }
42301bb6d2a8SBarry Smith     ierr = (*dm->ops->createlocalsection)(dm);CHKERRQ(ierr);
42311bb6d2a8SBarry Smith     if (dm->localSection) {ierr = PetscObjectViewFromOptions((PetscObject) dm->localSection, NULL, "-dm_petscsection_view");CHKERRQ(ierr);}
42322f0f8703SMatthew G. Knepley   }
42331bb6d2a8SBarry Smith   *section = dm->localSection;
423488ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
423588ed4aceSMatthew G Knepley }
423688ed4aceSMatthew G Knepley 
423788ed4aceSMatthew G Knepley /*@
42381bb6d2a8SBarry Smith   DMSetSection - Set the PetscSection encoding the local data layout for the DM.  This is equivalent to DMSetLocalSection(). Deprecated in v3.12
4239061576a5SJed Brown 
4240061576a5SJed Brown   Input Parameters:
4241061576a5SJed Brown + dm - The DM
4242061576a5SJed Brown - section - The PetscSection
4243061576a5SJed Brown 
4244061576a5SJed Brown   Level: advanced
4245061576a5SJed Brown 
4246061576a5SJed Brown   Notes:
4247061576a5SJed Brown   Use DMSetLocalSection() in new code.
4248061576a5SJed Brown 
4249061576a5SJed Brown   Any existing Section will be destroyed
4250061576a5SJed Brown 
4251061576a5SJed Brown .seealso: DMSetLocalSection(), DMGetLocalSection(), DMSetGlobalSection()
4252061576a5SJed Brown @*/
4253061576a5SJed Brown PetscErrorCode DMSetSection(DM dm, PetscSection section)
4254061576a5SJed Brown {
4255061576a5SJed Brown   PetscErrorCode ierr;
4256061576a5SJed Brown 
4257061576a5SJed Brown   PetscFunctionBegin;
4258061576a5SJed Brown   ierr = DMSetLocalSection(dm,section);CHKERRQ(ierr);
4259061576a5SJed Brown   PetscFunctionReturn(0);
4260061576a5SJed Brown }
4261061576a5SJed Brown 
4262061576a5SJed Brown /*@
4263061576a5SJed Brown   DMSetLocalSection - Set the PetscSection encoding the local data layout for the DM.
426488ed4aceSMatthew G Knepley 
426588ed4aceSMatthew G Knepley   Input Parameters:
426688ed4aceSMatthew G Knepley + dm - The DM
426788ed4aceSMatthew G Knepley - section - The PetscSection
426888ed4aceSMatthew G Knepley 
426988ed4aceSMatthew G Knepley   Level: intermediate
427088ed4aceSMatthew G Knepley 
427188ed4aceSMatthew G Knepley   Note: Any existing Section will be destroyed
427288ed4aceSMatthew G Knepley 
4273061576a5SJed Brown .seealso: DMGetLocalSection(), DMSetGlobalSection()
427488ed4aceSMatthew G Knepley @*/
4275061576a5SJed Brown PetscErrorCode DMSetLocalSection(DM dm, PetscSection section)
42760adebc6cSBarry Smith {
4277c473ab19SMatthew G. Knepley   PetscInt       numFields = 0;
4278af122d2aSMatthew G Knepley   PetscInt       f;
427988ed4aceSMatthew G Knepley   PetscErrorCode ierr;
428088ed4aceSMatthew G Knepley 
428188ed4aceSMatthew G Knepley   PetscFunctionBegin;
428288ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4283b9d85ea2SLisandro Dalcin   if (section) PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2);
42841d799100SJed Brown   ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr);
42851bb6d2a8SBarry Smith   ierr = PetscSectionDestroy(&dm->localSection);CHKERRQ(ierr);
42861bb6d2a8SBarry Smith   dm->localSection = section;
42871bb6d2a8SBarry Smith   if (section) {ierr = PetscSectionGetNumFields(dm->localSection, &numFields);CHKERRQ(ierr);}
4288af122d2aSMatthew G Knepley   if (numFields) {
4289af122d2aSMatthew G Knepley     ierr = DMSetNumFields(dm, numFields);CHKERRQ(ierr);
4290af122d2aSMatthew G Knepley     for (f = 0; f < numFields; ++f) {
42910f21e855SMatthew G. Knepley       PetscObject disc;
4292af122d2aSMatthew G Knepley       const char *name;
4293af122d2aSMatthew G Knepley 
42941bb6d2a8SBarry Smith       ierr = PetscSectionGetFieldName(dm->localSection, f, &name);CHKERRQ(ierr);
429544a7f3ddSMatthew G. Knepley       ierr = DMGetField(dm, f, NULL, &disc);CHKERRQ(ierr);
42960f21e855SMatthew G. Knepley       ierr = PetscObjectSetName(disc, name);CHKERRQ(ierr);
4297af122d2aSMatthew G Knepley     }
4298af122d2aSMatthew G Knepley   }
4299e87a4003SBarry Smith   /* The global section will be rebuilt in the next call to DMGetGlobalSection(). */
43001bb6d2a8SBarry Smith   ierr = PetscSectionDestroy(&dm->globalSection);CHKERRQ(ierr);
430188ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
430288ed4aceSMatthew G Knepley }
430388ed4aceSMatthew G Knepley 
43049435951eSToby Isaac /*@
4305b7385021SStefano Zampini   DMGetDefaultConstraints - Get the PetscSection and Mat that specify the local constraint interpolation. See DMSetDefaultConstraints() for a description of the purpose of constraint interpolation.
43069435951eSToby Isaac 
4307e228b242SToby Isaac   not collective
4308e228b242SToby Isaac 
43099435951eSToby Isaac   Input Parameter:
43109435951eSToby Isaac . dm - The DM
43119435951eSToby Isaac 
43129435951eSToby Isaac   Output Parameter:
43139435951eSToby 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.
43149435951eSToby 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.
43159435951eSToby Isaac 
43169435951eSToby Isaac   Level: advanced
43179435951eSToby Isaac 
43189435951eSToby Isaac   Note: This gets borrowed references, so the user should not destroy the PetscSection or the Mat.
43199435951eSToby Isaac 
43209435951eSToby Isaac .seealso: DMSetDefaultConstraints()
43219435951eSToby Isaac @*/
43229435951eSToby Isaac PetscErrorCode DMGetDefaultConstraints(DM dm, PetscSection *section, Mat *mat)
43239435951eSToby Isaac {
43249435951eSToby Isaac   PetscErrorCode ierr;
43259435951eSToby Isaac 
43269435951eSToby Isaac   PetscFunctionBegin;
43279435951eSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
43289435951eSToby Isaac   if (!dm->defaultConstraintSection && !dm->defaultConstraintMat && dm->ops->createdefaultconstraints) {ierr = (*dm->ops->createdefaultconstraints)(dm);CHKERRQ(ierr);}
432945a75d81SToby Isaac   if (section) {*section = dm->defaultConstraintSection;}
433045a75d81SToby Isaac   if (mat) {*mat = dm->defaultConstraintMat;}
43319435951eSToby Isaac   PetscFunctionReturn(0);
43329435951eSToby Isaac }
43339435951eSToby Isaac 
43349435951eSToby Isaac /*@
4335b7385021SStefano Zampini   DMSetDefaultConstraints - Set the PetscSection and Mat that specify the local constraint interpolation.
43369435951eSToby Isaac 
43379435951eSToby 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().
43389435951eSToby Isaac 
43399435951eSToby 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.
43409435951eSToby Isaac 
4341e228b242SToby Isaac   collective on dm
4342e228b242SToby Isaac 
43439435951eSToby Isaac   Input Parameters:
43449435951eSToby Isaac + dm - The DM
4345e228b242SToby 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).
4346e228b242SToby 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).
43479435951eSToby Isaac 
43489435951eSToby Isaac   Level: advanced
43499435951eSToby Isaac 
43509435951eSToby Isaac   Note: This increments the references of the PetscSection and the Mat, so they user can destroy them
43519435951eSToby Isaac 
43529435951eSToby Isaac .seealso: DMGetDefaultConstraints()
43539435951eSToby Isaac @*/
43549435951eSToby Isaac PetscErrorCode DMSetDefaultConstraints(DM dm, PetscSection section, Mat mat)
43559435951eSToby Isaac {
4356e228b242SToby Isaac   PetscMPIInt result;
43579435951eSToby Isaac   PetscErrorCode ierr;
43589435951eSToby Isaac 
43599435951eSToby Isaac   PetscFunctionBegin;
43609435951eSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4361e228b242SToby Isaac   if (section) {
4362e228b242SToby Isaac     PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2);
4363ffc4695bSBarry Smith     ierr = MPI_Comm_compare(PETSC_COMM_SELF,PetscObjectComm((PetscObject)section),&result);CHKERRMPI(ierr);
4364f60917d2SBarry Smith     if (result != MPI_CONGRUENT && result != MPI_IDENT) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NOTSAMECOMM,"constraint section must have local communicator");
4365e228b242SToby Isaac   }
4366e228b242SToby Isaac   if (mat) {
4367e228b242SToby Isaac     PetscValidHeaderSpecific(mat,MAT_CLASSID,3);
4368ffc4695bSBarry Smith     ierr = MPI_Comm_compare(PETSC_COMM_SELF,PetscObjectComm((PetscObject)mat),&result);CHKERRMPI(ierr);
4369f60917d2SBarry Smith     if (result != MPI_CONGRUENT && result != MPI_IDENT) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NOTSAMECOMM,"constraint matrix must have local communicator");
4370e228b242SToby Isaac   }
43719435951eSToby Isaac   ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr);
43729435951eSToby Isaac   ierr = PetscSectionDestroy(&dm->defaultConstraintSection);CHKERRQ(ierr);
43739435951eSToby Isaac   dm->defaultConstraintSection = section;
43749435951eSToby Isaac   ierr = PetscObjectReference((PetscObject)mat);CHKERRQ(ierr);
43759435951eSToby Isaac   ierr = MatDestroy(&dm->defaultConstraintMat);CHKERRQ(ierr);
43769435951eSToby Isaac   dm->defaultConstraintMat = mat;
43779435951eSToby Isaac   PetscFunctionReturn(0);
43789435951eSToby Isaac }
43799435951eSToby Isaac 
4380497880caSRichard Tran Mills #if defined(PETSC_USE_DEBUG)
4381507e4973SMatthew G. Knepley /*
4382507e4973SMatthew G. Knepley   DMDefaultSectionCheckConsistency - Check the consistentcy of the global and local sections.
4383507e4973SMatthew G. Knepley 
4384507e4973SMatthew G. Knepley   Input Parameters:
4385507e4973SMatthew G. Knepley + dm - The DM
4386507e4973SMatthew G. Knepley . localSection - PetscSection describing the local data layout
4387507e4973SMatthew G. Knepley - globalSection - PetscSection describing the global data layout
4388507e4973SMatthew G. Knepley 
4389507e4973SMatthew G. Knepley   Level: intermediate
4390507e4973SMatthew G. Knepley 
43911bb6d2a8SBarry Smith .seealso: DMGetSectionSF(), DMSetSectionSF()
4392507e4973SMatthew G. Knepley */
4393f741bcd2SMatthew G. Knepley static PetscErrorCode DMDefaultSectionCheckConsistency_Internal(DM dm, PetscSection localSection, PetscSection globalSection)
4394507e4973SMatthew G. Knepley {
4395507e4973SMatthew G. Knepley   MPI_Comm        comm;
4396507e4973SMatthew G. Knepley   PetscLayout     layout;
4397507e4973SMatthew G. Knepley   const PetscInt *ranges;
4398507e4973SMatthew G. Knepley   PetscInt        pStart, pEnd, p, nroots;
4399507e4973SMatthew G. Knepley   PetscMPIInt     size, rank;
4400507e4973SMatthew G. Knepley   PetscBool       valid = PETSC_TRUE, gvalid;
4401507e4973SMatthew G. Knepley   PetscErrorCode  ierr;
4402507e4973SMatthew G. Knepley 
4403507e4973SMatthew G. Knepley   PetscFunctionBegin;
4404507e4973SMatthew G. Knepley   ierr = PetscObjectGetComm((PetscObject)dm,&comm);CHKERRQ(ierr);
4405507e4973SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4406ffc4695bSBarry Smith   ierr = MPI_Comm_size(comm, &size);CHKERRMPI(ierr);
4407ffc4695bSBarry Smith   ierr = MPI_Comm_rank(comm, &rank);CHKERRMPI(ierr);
4408507e4973SMatthew G. Knepley   ierr = PetscSectionGetChart(globalSection, &pStart, &pEnd);CHKERRQ(ierr);
4409507e4973SMatthew G. Knepley   ierr = PetscSectionGetConstrainedStorageSize(globalSection, &nroots);CHKERRQ(ierr);
4410507e4973SMatthew G. Knepley   ierr = PetscLayoutCreate(comm, &layout);CHKERRQ(ierr);
4411507e4973SMatthew G. Knepley   ierr = PetscLayoutSetBlockSize(layout, 1);CHKERRQ(ierr);
4412507e4973SMatthew G. Knepley   ierr = PetscLayoutSetLocalSize(layout, nroots);CHKERRQ(ierr);
4413507e4973SMatthew G. Knepley   ierr = PetscLayoutSetUp(layout);CHKERRQ(ierr);
4414507e4973SMatthew G. Knepley   ierr = PetscLayoutGetRanges(layout, &ranges);CHKERRQ(ierr);
4415507e4973SMatthew G. Knepley   for (p = pStart; p < pEnd; ++p) {
4416f741bcd2SMatthew G. Knepley     PetscInt       dof, cdof, off, gdof, gcdof, goff, gsize, d;
4417507e4973SMatthew G. Knepley 
4418507e4973SMatthew G. Knepley     ierr = PetscSectionGetDof(localSection, p, &dof);CHKERRQ(ierr);
4419507e4973SMatthew G. Knepley     ierr = PetscSectionGetOffset(localSection, p, &off);CHKERRQ(ierr);
4420507e4973SMatthew G. Knepley     ierr = PetscSectionGetConstraintDof(localSection, p, &cdof);CHKERRQ(ierr);
4421507e4973SMatthew G. Knepley     ierr = PetscSectionGetDof(globalSection, p, &gdof);CHKERRQ(ierr);
4422507e4973SMatthew G. Knepley     ierr = PetscSectionGetConstraintDof(globalSection, p, &gcdof);CHKERRQ(ierr);
4423507e4973SMatthew G. Knepley     ierr = PetscSectionGetOffset(globalSection, p, &goff);CHKERRQ(ierr);
4424507e4973SMatthew G. Knepley     if (!gdof) continue; /* Censored point */
4425507e4973SMatthew 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;}
4426507e4973SMatthew 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;}
4427507e4973SMatthew G. Knepley     if (gdof < 0) {
4428507e4973SMatthew G. Knepley       gsize = gdof < 0 ? -(gdof+1)-gcdof : gdof-gcdof;
4429507e4973SMatthew G. Knepley       for (d = 0; d < gsize; ++d) {
4430507e4973SMatthew G. Knepley         PetscInt offset = -(goff+1) + d, r;
4431507e4973SMatthew G. Knepley 
4432507e4973SMatthew G. Knepley         ierr = PetscFindInt(offset,size+1,ranges,&r);CHKERRQ(ierr);
4433507e4973SMatthew G. Knepley         if (r < 0) r = -(r+2);
4434507e4973SMatthew 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;}
4435507e4973SMatthew G. Knepley       }
4436507e4973SMatthew G. Knepley     }
4437507e4973SMatthew G. Knepley   }
4438507e4973SMatthew G. Knepley   ierr = PetscLayoutDestroy(&layout);CHKERRQ(ierr);
4439507e4973SMatthew G. Knepley   ierr = PetscSynchronizedFlush(comm, NULL);CHKERRQ(ierr);
4440820f2d46SBarry Smith   ierr = MPIU_Allreduce(&valid, &gvalid, 1, MPIU_BOOL, MPI_LAND, comm);CHKERRMPI(ierr);
4441507e4973SMatthew G. Knepley   if (!gvalid) {
4442507e4973SMatthew G. Knepley     ierr = DMView(dm, NULL);CHKERRQ(ierr);
4443507e4973SMatthew G. Knepley     SETERRQ(comm, PETSC_ERR_ARG_WRONG, "Inconsistent local and global sections");
4444507e4973SMatthew G. Knepley   }
4445507e4973SMatthew G. Knepley   PetscFunctionReturn(0);
4446507e4973SMatthew G. Knepley }
4447f741bcd2SMatthew G. Knepley #endif
4448507e4973SMatthew G. Knepley 
444988ed4aceSMatthew G Knepley /*@
4450e87a4003SBarry Smith   DMGetGlobalSection - Get the PetscSection encoding the global data layout for the DM.
445188ed4aceSMatthew G Knepley 
4452d083f849SBarry Smith   Collective on dm
44538b1ab98fSJed Brown 
445488ed4aceSMatthew G Knepley   Input Parameter:
445588ed4aceSMatthew G Knepley . dm - The DM
445688ed4aceSMatthew G Knepley 
445788ed4aceSMatthew G Knepley   Output Parameter:
445888ed4aceSMatthew G Knepley . section - The PetscSection
445988ed4aceSMatthew G Knepley 
446088ed4aceSMatthew G Knepley   Level: intermediate
446188ed4aceSMatthew G Knepley 
446288ed4aceSMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSection.
446388ed4aceSMatthew G Knepley 
446492fd8e1eSJed Brown .seealso: DMSetLocalSection(), DMGetLocalSection()
446588ed4aceSMatthew G Knepley @*/
4466e87a4003SBarry Smith PetscErrorCode DMGetGlobalSection(DM dm, PetscSection *section)
44670adebc6cSBarry Smith {
446888ed4aceSMatthew G Knepley   PetscErrorCode ierr;
446988ed4aceSMatthew G Knepley 
447088ed4aceSMatthew G Knepley   PetscFunctionBegin;
447188ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
447288ed4aceSMatthew G Knepley   PetscValidPointer(section, 2);
44731bb6d2a8SBarry Smith   if (!dm->globalSection) {
4474fd59a867SMatthew G. Knepley     PetscSection s;
4475fd59a867SMatthew G. Knepley 
447692fd8e1eSJed Brown     ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr);
4477fd59a867SMatthew 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");
447833907cc2SStefano 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");
44791bb6d2a8SBarry Smith     ierr = PetscSectionCreateGlobalSection(s, dm->sf, PETSC_FALSE, PETSC_FALSE, &dm->globalSection);CHKERRQ(ierr);
4480cf06b437SMatthew G. Knepley     ierr = PetscLayoutDestroy(&dm->map);CHKERRQ(ierr);
44811bb6d2a8SBarry Smith     ierr = PetscSectionGetValueLayout(PetscObjectComm((PetscObject)dm), dm->globalSection, &dm->map);CHKERRQ(ierr);
44821bb6d2a8SBarry Smith     ierr = PetscSectionViewFromOptions(dm->globalSection, NULL, "-global_section_view");CHKERRQ(ierr);
448388ed4aceSMatthew G Knepley   }
44841bb6d2a8SBarry Smith   *section = dm->globalSection;
448588ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
448688ed4aceSMatthew G Knepley }
448788ed4aceSMatthew G Knepley 
4488b21d0597SMatthew G Knepley /*@
4489e87a4003SBarry Smith   DMSetGlobalSection - Set the PetscSection encoding the global data layout for the DM.
4490b21d0597SMatthew G Knepley 
4491b21d0597SMatthew G Knepley   Input Parameters:
4492b21d0597SMatthew G Knepley + dm - The DM
44935080bbdbSMatthew G Knepley - section - The PetscSection, or NULL
4494b21d0597SMatthew G Knepley 
4495b21d0597SMatthew G Knepley   Level: intermediate
4496b21d0597SMatthew G Knepley 
4497b21d0597SMatthew G Knepley   Note: Any existing Section will be destroyed
4498b21d0597SMatthew G Knepley 
449992fd8e1eSJed Brown .seealso: DMGetGlobalSection(), DMSetLocalSection()
4500b21d0597SMatthew G Knepley @*/
4501e87a4003SBarry Smith PetscErrorCode DMSetGlobalSection(DM dm, PetscSection section)
45020adebc6cSBarry Smith {
4503b21d0597SMatthew G Knepley   PetscErrorCode ierr;
4504b21d0597SMatthew G Knepley 
4505b21d0597SMatthew G Knepley   PetscFunctionBegin;
4506b21d0597SMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
45075080bbdbSMatthew G Knepley   if (section) PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2);
45081d799100SJed Brown   ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr);
45091bb6d2a8SBarry Smith   ierr = PetscSectionDestroy(&dm->globalSection);CHKERRQ(ierr);
45101bb6d2a8SBarry Smith   dm->globalSection = section;
4511497880caSRichard Tran Mills #if defined(PETSC_USE_DEBUG)
45121bb6d2a8SBarry Smith   if (section) {ierr = DMDefaultSectionCheckConsistency_Internal(dm, dm->localSection, section);CHKERRQ(ierr);}
4513507e4973SMatthew G. Knepley #endif
4514b21d0597SMatthew G Knepley   PetscFunctionReturn(0);
4515b21d0597SMatthew G Knepley }
4516b21d0597SMatthew G Knepley 
451788ed4aceSMatthew G Knepley /*@
45181bb6d2a8SBarry Smith   DMGetSectionSF - Get the PetscSF encoding the parallel dof overlap for the DM. If it has not been set,
451988ed4aceSMatthew G Knepley   it is created from the default PetscSection layouts in the DM.
452088ed4aceSMatthew G Knepley 
452188ed4aceSMatthew G Knepley   Input Parameter:
452288ed4aceSMatthew G Knepley . dm - The DM
452388ed4aceSMatthew G Knepley 
452488ed4aceSMatthew G Knepley   Output Parameter:
452588ed4aceSMatthew G Knepley . sf - The PetscSF
452688ed4aceSMatthew G Knepley 
452788ed4aceSMatthew G Knepley   Level: intermediate
452888ed4aceSMatthew G Knepley 
452988ed4aceSMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSF.
453088ed4aceSMatthew G Knepley 
45311bb6d2a8SBarry Smith .seealso: DMSetSectionSF(), DMCreateSectionSF()
453288ed4aceSMatthew G Knepley @*/
45331bb6d2a8SBarry Smith PetscErrorCode DMGetSectionSF(DM dm, PetscSF *sf)
45340adebc6cSBarry Smith {
453588ed4aceSMatthew G Knepley   PetscInt       nroots;
453688ed4aceSMatthew G Knepley   PetscErrorCode ierr;
453788ed4aceSMatthew G Knepley 
453888ed4aceSMatthew G Knepley   PetscFunctionBegin;
453988ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
454088ed4aceSMatthew G Knepley   PetscValidPointer(sf, 2);
45411bb6d2a8SBarry Smith   if (!dm->sectionSF) {
45421bb6d2a8SBarry Smith     ierr = PetscSFCreate(PetscObjectComm((PetscObject)dm),&dm->sectionSF);CHKERRQ(ierr);
454333907cc2SStefano Zampini   }
45441bb6d2a8SBarry Smith   ierr = PetscSFGetGraph(dm->sectionSF, &nroots, NULL, NULL, NULL);CHKERRQ(ierr);
454588ed4aceSMatthew G Knepley   if (nroots < 0) {
454688ed4aceSMatthew G Knepley     PetscSection section, gSection;
454788ed4aceSMatthew G Knepley 
454892fd8e1eSJed Brown     ierr = DMGetLocalSection(dm, &section);CHKERRQ(ierr);
454931ea6d37SMatthew G Knepley     if (section) {
4550e87a4003SBarry Smith       ierr = DMGetGlobalSection(dm, &gSection);CHKERRQ(ierr);
45511bb6d2a8SBarry Smith       ierr = DMCreateSectionSF(dm, section, gSection);CHKERRQ(ierr);
455231ea6d37SMatthew G Knepley     } else {
45530298fd71SBarry Smith       *sf = NULL;
455431ea6d37SMatthew G Knepley       PetscFunctionReturn(0);
455531ea6d37SMatthew G Knepley     }
455688ed4aceSMatthew G Knepley   }
45571bb6d2a8SBarry Smith   *sf = dm->sectionSF;
455888ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
455988ed4aceSMatthew G Knepley }
456088ed4aceSMatthew G Knepley 
456188ed4aceSMatthew G Knepley /*@
45621bb6d2a8SBarry Smith   DMSetSectionSF - Set the PetscSF encoding the parallel dof overlap for the DM
456388ed4aceSMatthew G Knepley 
456488ed4aceSMatthew G Knepley   Input Parameters:
456588ed4aceSMatthew G Knepley + dm - The DM
456688ed4aceSMatthew G Knepley - sf - The PetscSF
456788ed4aceSMatthew G Knepley 
456888ed4aceSMatthew G Knepley   Level: intermediate
456988ed4aceSMatthew G Knepley 
457088ed4aceSMatthew G Knepley   Note: Any previous SF is destroyed
457188ed4aceSMatthew G Knepley 
45721bb6d2a8SBarry Smith .seealso: DMGetSectionSF(), DMCreateSectionSF()
457388ed4aceSMatthew G Knepley @*/
45741bb6d2a8SBarry Smith PetscErrorCode DMSetSectionSF(DM dm, PetscSF sf)
45750adebc6cSBarry Smith {
457688ed4aceSMatthew G Knepley   PetscErrorCode ierr;
457788ed4aceSMatthew G Knepley 
457888ed4aceSMatthew G Knepley   PetscFunctionBegin;
457988ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4580b9d85ea2SLisandro Dalcin   if (sf) PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
458133907cc2SStefano Zampini   ierr = PetscObjectReference((PetscObject) sf);CHKERRQ(ierr);
45821bb6d2a8SBarry Smith   ierr = PetscSFDestroy(&dm->sectionSF);CHKERRQ(ierr);
45831bb6d2a8SBarry Smith   dm->sectionSF = sf;
458488ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
458588ed4aceSMatthew G Knepley }
458688ed4aceSMatthew G Knepley 
458788ed4aceSMatthew G Knepley /*@C
45881bb6d2a8SBarry Smith   DMCreateSectionSF - Create the PetscSF encoding the parallel dof overlap for the DM based upon the PetscSections
458988ed4aceSMatthew G Knepley   describing the data layout.
459088ed4aceSMatthew G Knepley 
459188ed4aceSMatthew G Knepley   Input Parameters:
459288ed4aceSMatthew G Knepley + dm - The DM
459388ed4aceSMatthew G Knepley . localSection - PetscSection describing the local data layout
459488ed4aceSMatthew G Knepley - globalSection - PetscSection describing the global data layout
459588ed4aceSMatthew G Knepley 
45961bb6d2a8SBarry Smith   Notes: One usually uses DMGetSectionSF() to obtain the PetscSF
459788ed4aceSMatthew G Knepley 
45981bb6d2a8SBarry Smith   Level: developer
45991bb6d2a8SBarry Smith 
46001bb6d2a8SBarry Smith   Developer Note: Since this routine has for arguments the two sections from the DM and puts the resulting PetscSF
46011bb6d2a8SBarry Smith                   directly into the DM, perhaps this function should not take the local and global sections as
46021bb6d2a8SBarry Smith                   input and should just obtain them from the DM?
46031bb6d2a8SBarry Smith 
46041bb6d2a8SBarry Smith .seealso: DMGetSectionSF(), DMSetSectionSF(), DMGetLocalSection(), DMGetGlobalSection()
460588ed4aceSMatthew G Knepley @*/
46061bb6d2a8SBarry Smith PetscErrorCode DMCreateSectionSF(DM dm, PetscSection localSection, PetscSection globalSection)
460788ed4aceSMatthew G Knepley {
460888ed4aceSMatthew G Knepley   PetscErrorCode ierr;
460988ed4aceSMatthew G Knepley 
461088ed4aceSMatthew G Knepley   PetscFunctionBegin;
461188ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4612b0c7db22SLisandro Dalcin   ierr = PetscSFSetGraphSection(dm->sectionSF, localSection, globalSection);CHKERRQ(ierr);
461388ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
461488ed4aceSMatthew G Knepley }
4615af122d2aSMatthew G Knepley 
4616b21d0597SMatthew G Knepley /*@
4617b21d0597SMatthew G Knepley   DMGetPointSF - Get the PetscSF encoding the parallel section point overlap for the DM.
4618b21d0597SMatthew G Knepley 
4619b21d0597SMatthew G Knepley   Input Parameter:
4620b21d0597SMatthew G Knepley . dm - The DM
4621b21d0597SMatthew G Knepley 
4622b21d0597SMatthew G Knepley   Output Parameter:
4623b21d0597SMatthew G Knepley . sf - The PetscSF
4624b21d0597SMatthew G Knepley 
4625b21d0597SMatthew G Knepley   Level: intermediate
4626b21d0597SMatthew G Knepley 
4627b21d0597SMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSF.
4628b21d0597SMatthew G Knepley 
46291bb6d2a8SBarry Smith .seealso: DMSetPointSF(), DMGetSectionSF(), DMSetSectionSF(), DMCreateSectionSF()
4630b21d0597SMatthew G Knepley @*/
46310adebc6cSBarry Smith PetscErrorCode DMGetPointSF(DM dm, PetscSF *sf)
46320adebc6cSBarry Smith {
4633b21d0597SMatthew G Knepley   PetscFunctionBegin;
4634b21d0597SMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4635b21d0597SMatthew G Knepley   PetscValidPointer(sf, 2);
4636b21d0597SMatthew G Knepley   *sf = dm->sf;
4637b21d0597SMatthew G Knepley   PetscFunctionReturn(0);
4638b21d0597SMatthew G Knepley }
4639b21d0597SMatthew G Knepley 
4640057b4bcdSMatthew G Knepley /*@
4641057b4bcdSMatthew G Knepley   DMSetPointSF - Set the PetscSF encoding the parallel section point overlap for the DM.
4642057b4bcdSMatthew G Knepley 
4643057b4bcdSMatthew G Knepley   Input Parameters:
4644057b4bcdSMatthew G Knepley + dm - The DM
4645057b4bcdSMatthew G Knepley - sf - The PetscSF
4646057b4bcdSMatthew G Knepley 
4647057b4bcdSMatthew G Knepley   Level: intermediate
4648057b4bcdSMatthew G Knepley 
46491bb6d2a8SBarry Smith .seealso: DMGetPointSF(), DMGetSectionSF(), DMSetSectionSF(), DMCreateSectionSF()
4650057b4bcdSMatthew G Knepley @*/
46510adebc6cSBarry Smith PetscErrorCode DMSetPointSF(DM dm, PetscSF sf)
46520adebc6cSBarry Smith {
4653057b4bcdSMatthew G Knepley   PetscErrorCode ierr;
4654057b4bcdSMatthew G Knepley 
4655057b4bcdSMatthew G Knepley   PetscFunctionBegin;
4656057b4bcdSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4657b9d85ea2SLisandro Dalcin   if (sf) PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
4658057b4bcdSMatthew G Knepley   ierr = PetscObjectReference((PetscObject) sf);CHKERRQ(ierr);
465933907cc2SStefano Zampini   ierr = PetscSFDestroy(&dm->sf);CHKERRQ(ierr);
4660057b4bcdSMatthew G Knepley   dm->sf = sf;
4661057b4bcdSMatthew G Knepley   PetscFunctionReturn(0);
4662057b4bcdSMatthew G Knepley }
4663057b4bcdSMatthew G Knepley 
466434aa8a36SMatthew G. Knepley static PetscErrorCode DMSetDefaultAdjacency_Private(DM dm, PetscInt f, PetscObject disc)
466534aa8a36SMatthew G. Knepley {
466634aa8a36SMatthew G. Knepley   PetscClassId   id;
466734aa8a36SMatthew G. Knepley   PetscErrorCode ierr;
466834aa8a36SMatthew G. Knepley 
466934aa8a36SMatthew G. Knepley   PetscFunctionBegin;
467034aa8a36SMatthew G. Knepley   ierr = PetscObjectGetClassId(disc, &id);CHKERRQ(ierr);
467134aa8a36SMatthew G. Knepley   if (id == PETSCFE_CLASSID) {
467234aa8a36SMatthew G. Knepley     ierr = DMSetAdjacency(dm, f, PETSC_FALSE, PETSC_TRUE);CHKERRQ(ierr);
467334aa8a36SMatthew G. Knepley   } else if (id == PETSCFV_CLASSID) {
467434aa8a36SMatthew G. Knepley     ierr = DMSetAdjacency(dm, f, PETSC_TRUE, PETSC_FALSE);CHKERRQ(ierr);
467517c1d62eSMatthew G. Knepley   } else {
467617c1d62eSMatthew G. Knepley     ierr = DMSetAdjacency(dm, f, PETSC_FALSE, PETSC_TRUE);CHKERRQ(ierr);
467734aa8a36SMatthew G. Knepley   }
467834aa8a36SMatthew G. Knepley   PetscFunctionReturn(0);
467934aa8a36SMatthew G. Knepley }
468034aa8a36SMatthew G. Knepley 
468144a7f3ddSMatthew G. Knepley static PetscErrorCode DMFieldEnlarge_Static(DM dm, PetscInt NfNew)
468244a7f3ddSMatthew G. Knepley {
468344a7f3ddSMatthew G. Knepley   RegionField   *tmpr;
468444a7f3ddSMatthew G. Knepley   PetscInt       Nf = dm->Nf, f;
468544a7f3ddSMatthew G. Knepley   PetscErrorCode ierr;
468644a7f3ddSMatthew G. Knepley 
468744a7f3ddSMatthew G. Knepley   PetscFunctionBegin;
468844a7f3ddSMatthew G. Knepley   if (Nf >= NfNew) PetscFunctionReturn(0);
468944a7f3ddSMatthew G. Knepley   ierr = PetscMalloc1(NfNew, &tmpr);CHKERRQ(ierr);
469044a7f3ddSMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpr[f] = dm->fields[f];
4691e0b68406SMatthew Knepley   for (f = Nf; f < NfNew; ++f) {tmpr[f].disc = NULL; tmpr[f].label = NULL; tmpr[f].avoidTensor = PETSC_FALSE;}
469244a7f3ddSMatthew G. Knepley   ierr = PetscFree(dm->fields);CHKERRQ(ierr);
469344a7f3ddSMatthew G. Knepley   dm->Nf     = NfNew;
469444a7f3ddSMatthew G. Knepley   dm->fields = tmpr;
469544a7f3ddSMatthew G. Knepley   PetscFunctionReturn(0);
469644a7f3ddSMatthew G. Knepley }
469744a7f3ddSMatthew G. Knepley 
469844a7f3ddSMatthew G. Knepley /*@
469944a7f3ddSMatthew G. Knepley   DMClearFields - Remove all fields from the DM
470044a7f3ddSMatthew G. Knepley 
4701d083f849SBarry Smith   Logically collective on dm
470244a7f3ddSMatthew G. Knepley 
470344a7f3ddSMatthew G. Knepley   Input Parameter:
470444a7f3ddSMatthew G. Knepley . dm - The DM
470544a7f3ddSMatthew G. Knepley 
470644a7f3ddSMatthew G. Knepley   Level: intermediate
470744a7f3ddSMatthew G. Knepley 
470844a7f3ddSMatthew G. Knepley .seealso: DMGetNumFields(), DMSetNumFields(), DMSetField()
470944a7f3ddSMatthew G. Knepley @*/
471044a7f3ddSMatthew G. Knepley PetscErrorCode DMClearFields(DM dm)
471144a7f3ddSMatthew G. Knepley {
471244a7f3ddSMatthew G. Knepley   PetscInt       f;
471344a7f3ddSMatthew G. Knepley   PetscErrorCode ierr;
471444a7f3ddSMatthew G. Knepley 
471544a7f3ddSMatthew G. Knepley   PetscFunctionBegin;
471644a7f3ddSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
471744a7f3ddSMatthew G. Knepley   for (f = 0; f < dm->Nf; ++f) {
471844a7f3ddSMatthew G. Knepley     ierr = PetscObjectDestroy(&dm->fields[f].disc);CHKERRQ(ierr);
471944a7f3ddSMatthew G. Knepley     ierr = DMLabelDestroy(&dm->fields[f].label);CHKERRQ(ierr);
472044a7f3ddSMatthew G. Knepley   }
472144a7f3ddSMatthew G. Knepley   ierr = PetscFree(dm->fields);CHKERRQ(ierr);
472244a7f3ddSMatthew G. Knepley   dm->fields = NULL;
472344a7f3ddSMatthew G. Knepley   dm->Nf     = 0;
472444a7f3ddSMatthew G. Knepley   PetscFunctionReturn(0);
472544a7f3ddSMatthew G. Knepley }
472644a7f3ddSMatthew G. Knepley 
4727689b5837SMatthew G. Knepley /*@
4728689b5837SMatthew G. Knepley   DMGetNumFields - Get the number of fields in the DM
4729689b5837SMatthew G. Knepley 
4730689b5837SMatthew G. Knepley   Not collective
4731689b5837SMatthew G. Knepley 
4732689b5837SMatthew G. Knepley   Input Parameter:
4733689b5837SMatthew G. Knepley . dm - The DM
4734689b5837SMatthew G. Knepley 
4735689b5837SMatthew G. Knepley   Output Parameter:
4736689b5837SMatthew G. Knepley . Nf - The number of fields
4737689b5837SMatthew G. Knepley 
4738689b5837SMatthew G. Knepley   Level: intermediate
4739689b5837SMatthew G. Knepley 
4740689b5837SMatthew G. Knepley .seealso: DMSetNumFields(), DMSetField()
4741689b5837SMatthew G. Knepley @*/
47420f21e855SMatthew G. Knepley PetscErrorCode DMGetNumFields(DM dm, PetscInt *numFields)
47430f21e855SMatthew G. Knepley {
47440f21e855SMatthew G. Knepley   PetscFunctionBegin;
47450f21e855SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4746534a8f05SLisandro Dalcin   PetscValidIntPointer(numFields, 2);
474744a7f3ddSMatthew G. Knepley   *numFields = dm->Nf;
4748af122d2aSMatthew G Knepley   PetscFunctionReturn(0);
4749af122d2aSMatthew G Knepley }
4750af122d2aSMatthew G Knepley 
4751689b5837SMatthew G. Knepley /*@
4752689b5837SMatthew G. Knepley   DMSetNumFields - Set the number of fields in the DM
4753689b5837SMatthew G. Knepley 
4754d083f849SBarry Smith   Logically collective on dm
4755689b5837SMatthew G. Knepley 
4756689b5837SMatthew G. Knepley   Input Parameters:
4757689b5837SMatthew G. Knepley + dm - The DM
4758689b5837SMatthew G. Knepley - Nf - The number of fields
4759689b5837SMatthew G. Knepley 
4760689b5837SMatthew G. Knepley   Level: intermediate
4761689b5837SMatthew G. Knepley 
4762689b5837SMatthew G. Knepley .seealso: DMGetNumFields(), DMSetField()
4763689b5837SMatthew G. Knepley @*/
4764af122d2aSMatthew G Knepley PetscErrorCode DMSetNumFields(DM dm, PetscInt numFields)
4765af122d2aSMatthew G Knepley {
47660f21e855SMatthew G. Knepley   PetscInt       Nf, f;
4767af122d2aSMatthew G Knepley   PetscErrorCode ierr;
4768af122d2aSMatthew G Knepley 
4769af122d2aSMatthew G Knepley   PetscFunctionBegin;
4770af122d2aSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
477144a7f3ddSMatthew G. Knepley   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
47720f21e855SMatthew G. Knepley   for (f = Nf; f < numFields; ++f) {
47730f21e855SMatthew G. Knepley     PetscContainer obj;
47740f21e855SMatthew G. Knepley 
47750f21e855SMatthew G. Knepley     ierr = PetscContainerCreate(PetscObjectComm((PetscObject) dm), &obj);CHKERRQ(ierr);
477644a7f3ddSMatthew G. Knepley     ierr = DMAddField(dm, NULL, (PetscObject) obj);CHKERRQ(ierr);
47770f21e855SMatthew G. Knepley     ierr = PetscContainerDestroy(&obj);CHKERRQ(ierr);
4778af122d2aSMatthew G Knepley   }
4779af122d2aSMatthew G Knepley   PetscFunctionReturn(0);
4780af122d2aSMatthew G Knepley }
4781af122d2aSMatthew G Knepley 
4782c1929be8SMatthew G. Knepley /*@
4783c1929be8SMatthew G. Knepley   DMGetField - Return the discretization object for a given DM field
4784c1929be8SMatthew G. Knepley 
4785c1929be8SMatthew G. Knepley   Not collective
4786c1929be8SMatthew G. Knepley 
4787c1929be8SMatthew G. Knepley   Input Parameters:
4788c1929be8SMatthew G. Knepley + dm - The DM
4789c1929be8SMatthew G. Knepley - f  - The field number
4790c1929be8SMatthew G. Knepley 
479144a7f3ddSMatthew G. Knepley   Output Parameters:
479244a7f3ddSMatthew G. Knepley + label - The label indicating the support of the field, or NULL for the entire mesh
479344a7f3ddSMatthew G. Knepley - field - The discretization object
4794c1929be8SMatthew G. Knepley 
479544a7f3ddSMatthew G. Knepley   Level: intermediate
4796c1929be8SMatthew G. Knepley 
479744a7f3ddSMatthew G. Knepley .seealso: DMAddField(), DMSetField()
4798c1929be8SMatthew G. Knepley @*/
479944a7f3ddSMatthew G. Knepley PetscErrorCode DMGetField(DM dm, PetscInt f, DMLabel *label, PetscObject *field)
4800af122d2aSMatthew G Knepley {
4801af122d2aSMatthew G Knepley   PetscFunctionBegin;
4802af122d2aSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4803064a246eSJacob Faibussowitsch   PetscValidPointer(field, 4);
480444a7f3ddSMatthew 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);
480544a7f3ddSMatthew G. Knepley   if (label) *label = dm->fields[f].label;
480644a7f3ddSMatthew G. Knepley   if (field) *field = dm->fields[f].disc;
4807decb47aaSMatthew G. Knepley   PetscFunctionReturn(0);
4808decb47aaSMatthew G. Knepley }
4809decb47aaSMatthew G. Knepley 
4810083401c6SMatthew G. Knepley /* Does not clear the DS */
4811083401c6SMatthew G. Knepley PetscErrorCode DMSetField_Internal(DM dm, PetscInt f, DMLabel label, PetscObject field)
4812083401c6SMatthew G. Knepley {
4813083401c6SMatthew G. Knepley   PetscErrorCode ierr;
4814083401c6SMatthew G. Knepley 
4815083401c6SMatthew G. Knepley   PetscFunctionBegin;
4816083401c6SMatthew G. Knepley   ierr = DMFieldEnlarge_Static(dm, f+1);CHKERRQ(ierr);
4817083401c6SMatthew G. Knepley   ierr = DMLabelDestroy(&dm->fields[f].label);CHKERRQ(ierr);
4818083401c6SMatthew G. Knepley   ierr = PetscObjectDestroy(&dm->fields[f].disc);CHKERRQ(ierr);
4819083401c6SMatthew G. Knepley   dm->fields[f].label = label;
4820083401c6SMatthew G. Knepley   dm->fields[f].disc  = field;
4821083401c6SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr);
4822083401c6SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) field);CHKERRQ(ierr);
4823083401c6SMatthew G. Knepley   PetscFunctionReturn(0);
4824083401c6SMatthew G. Knepley }
4825083401c6SMatthew G. Knepley 
4826c1929be8SMatthew G. Knepley /*@
4827c1929be8SMatthew G. Knepley   DMSetField - Set the discretization object for a given DM field
4828c1929be8SMatthew G. Knepley 
4829d083f849SBarry Smith   Logically collective on dm
4830c1929be8SMatthew G. Knepley 
4831c1929be8SMatthew G. Knepley   Input Parameters:
4832c1929be8SMatthew G. Knepley + dm    - The DM
4833c1929be8SMatthew G. Knepley . f     - The field number
483444a7f3ddSMatthew G. Knepley . label - The label indicating the support of the field, or NULL for the entire mesh
4835c1929be8SMatthew G. Knepley - field - The discretization object
4836c1929be8SMatthew G. Knepley 
483744a7f3ddSMatthew G. Knepley   Level: intermediate
4838c1929be8SMatthew G. Knepley 
483944a7f3ddSMatthew G. Knepley .seealso: DMAddField(), DMGetField()
4840c1929be8SMatthew G. Knepley @*/
484144a7f3ddSMatthew G. Knepley PetscErrorCode DMSetField(DM dm, PetscInt f, DMLabel label, PetscObject field)
4842decb47aaSMatthew G. Knepley {
4843decb47aaSMatthew G. Knepley   PetscErrorCode ierr;
4844decb47aaSMatthew G. Knepley 
4845decb47aaSMatthew G. Knepley   PetscFunctionBegin;
4846decb47aaSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4847e5e52638SMatthew G. Knepley   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 3);
484844a7f3ddSMatthew G. Knepley   PetscValidHeader(field, 4);
4849e5e52638SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
4850083401c6SMatthew G. Knepley   ierr = DMSetField_Internal(dm, f, label, field);CHKERRQ(ierr);
485134aa8a36SMatthew G. Knepley   ierr = DMSetDefaultAdjacency_Private(dm, f, field);CHKERRQ(ierr);
48522df9ee95SMatthew G. Knepley   ierr = DMClearDS(dm);CHKERRQ(ierr);
485344a7f3ddSMatthew G. Knepley   PetscFunctionReturn(0);
485444a7f3ddSMatthew G. Knepley }
485544a7f3ddSMatthew G. Knepley 
485644a7f3ddSMatthew G. Knepley /*@
485744a7f3ddSMatthew G. Knepley   DMAddField - Add the discretization object for the given DM field
485844a7f3ddSMatthew G. Knepley 
4859d083f849SBarry Smith   Logically collective on dm
486044a7f3ddSMatthew G. Knepley 
486144a7f3ddSMatthew G. Knepley   Input Parameters:
486244a7f3ddSMatthew G. Knepley + dm    - The DM
486344a7f3ddSMatthew G. Knepley . label - The label indicating the support of the field, or NULL for the entire mesh
486444a7f3ddSMatthew G. Knepley - field - The discretization object
486544a7f3ddSMatthew G. Knepley 
486644a7f3ddSMatthew G. Knepley   Level: intermediate
486744a7f3ddSMatthew G. Knepley 
486844a7f3ddSMatthew G. Knepley .seealso: DMSetField(), DMGetField()
486944a7f3ddSMatthew G. Knepley @*/
487044a7f3ddSMatthew G. Knepley PetscErrorCode DMAddField(DM dm, DMLabel label, PetscObject field)
487144a7f3ddSMatthew G. Knepley {
487244a7f3ddSMatthew G. Knepley   PetscInt       Nf = dm->Nf;
487344a7f3ddSMatthew G. Knepley   PetscErrorCode ierr;
487444a7f3ddSMatthew G. Knepley 
487544a7f3ddSMatthew G. Knepley   PetscFunctionBegin;
487644a7f3ddSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4877064a246eSJacob Faibussowitsch   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
487844a7f3ddSMatthew G. Knepley   PetscValidHeader(field, 3);
487944a7f3ddSMatthew G. Knepley   ierr = DMFieldEnlarge_Static(dm, Nf+1);CHKERRQ(ierr);
488044a7f3ddSMatthew G. Knepley   dm->fields[Nf].label = label;
488144a7f3ddSMatthew G. Knepley   dm->fields[Nf].disc  = field;
488244a7f3ddSMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr);
488344a7f3ddSMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) field);CHKERRQ(ierr);
488434aa8a36SMatthew G. Knepley   ierr = DMSetDefaultAdjacency_Private(dm, Nf, field);CHKERRQ(ierr);
48852df9ee95SMatthew G. Knepley   ierr = DMClearDS(dm);CHKERRQ(ierr);
4886af122d2aSMatthew G Knepley   PetscFunctionReturn(0);
4887af122d2aSMatthew G Knepley }
48886636e97aSMatthew G Knepley 
4889e5e52638SMatthew G. Knepley /*@
4890e0b68406SMatthew Knepley   DMSetFieldAvoidTensor - Set flag to avoid defining the field on tensor cells
4891e0b68406SMatthew Knepley 
4892e0b68406SMatthew Knepley   Logically collective on dm
4893e0b68406SMatthew Knepley 
4894e0b68406SMatthew Knepley   Input Parameters:
4895e0b68406SMatthew Knepley + dm          - The DM
4896e0b68406SMatthew Knepley . f           - The field index
4897e0b68406SMatthew Knepley - avoidTensor - The flag to avoid defining the field on tensor cells
4898e0b68406SMatthew Knepley 
4899e0b68406SMatthew Knepley   Level: intermediate
4900e0b68406SMatthew Knepley 
4901e0b68406SMatthew Knepley .seealso: DMGetFieldAvoidTensor(), DMSetField(), DMGetField()
4902e0b68406SMatthew Knepley @*/
4903e0b68406SMatthew Knepley PetscErrorCode DMSetFieldAvoidTensor(DM dm, PetscInt f, PetscBool avoidTensor)
4904e0b68406SMatthew Knepley {
4905e0b68406SMatthew Knepley   PetscFunctionBegin;
4906e0b68406SMatthew 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);
4907e0b68406SMatthew Knepley   dm->fields[f].avoidTensor = avoidTensor;
4908e0b68406SMatthew Knepley   PetscFunctionReturn(0);
4909e0b68406SMatthew Knepley }
4910e0b68406SMatthew Knepley 
4911e0b68406SMatthew Knepley /*@
4912e0b68406SMatthew Knepley   DMGetFieldAvoidTensor - Get flag to avoid defining the field on tensor cells
4913e0b68406SMatthew Knepley 
4914e0b68406SMatthew Knepley   Logically collective on dm
4915e0b68406SMatthew Knepley 
4916e0b68406SMatthew Knepley   Input Parameters:
4917e0b68406SMatthew Knepley + dm          - The DM
4918e0b68406SMatthew Knepley - f           - The field index
4919e0b68406SMatthew Knepley 
4920e0b68406SMatthew Knepley   Output Parameter:
4921e0b68406SMatthew Knepley . avoidTensor - The flag to avoid defining the field on tensor cells
4922e0b68406SMatthew Knepley 
4923e0b68406SMatthew Knepley   Level: intermediate
4924e0b68406SMatthew Knepley 
4925e0b68406SMatthew Knepley .seealso: DMSetFieldAvoidTensor(), DMSetField(), DMGetField()
4926e0b68406SMatthew Knepley @*/
4927e0b68406SMatthew Knepley PetscErrorCode DMGetFieldAvoidTensor(DM dm, PetscInt f, PetscBool *avoidTensor)
4928e0b68406SMatthew Knepley {
4929e0b68406SMatthew Knepley   PetscFunctionBegin;
4930e0b68406SMatthew 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);
4931e0b68406SMatthew Knepley   *avoidTensor = dm->fields[f].avoidTensor;
4932e0b68406SMatthew Knepley   PetscFunctionReturn(0);
4933e0b68406SMatthew Knepley }
4934e0b68406SMatthew Knepley 
4935e0b68406SMatthew Knepley /*@
4936e5e52638SMatthew G. Knepley   DMCopyFields - Copy the discretizations for the DM into another DM
4937e5e52638SMatthew G. Knepley 
4938d083f849SBarry Smith   Collective on dm
4939e5e52638SMatthew G. Knepley 
4940e5e52638SMatthew G. Knepley   Input Parameter:
4941e5e52638SMatthew G. Knepley . dm - The DM
4942e5e52638SMatthew G. Knepley 
4943e5e52638SMatthew G. Knepley   Output Parameter:
4944e5e52638SMatthew G. Knepley . newdm - The DM
4945e5e52638SMatthew G. Knepley 
4946e5e52638SMatthew G. Knepley   Level: advanced
4947e5e52638SMatthew G. Knepley 
4948e5e52638SMatthew G. Knepley .seealso: DMGetField(), DMSetField(), DMAddField(), DMCopyDS(), DMGetDS(), DMGetCellDS()
4949e5e52638SMatthew G. Knepley @*/
4950e5e52638SMatthew G. Knepley PetscErrorCode DMCopyFields(DM dm, DM newdm)
4951e5e52638SMatthew G. Knepley {
4952e5e52638SMatthew G. Knepley   PetscInt       Nf, f;
4953e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
4954e5e52638SMatthew G. Knepley 
4955e5e52638SMatthew G. Knepley   PetscFunctionBegin;
4956e5e52638SMatthew G. Knepley   if (dm == newdm) PetscFunctionReturn(0);
4957e5e52638SMatthew G. Knepley   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
4958e5e52638SMatthew G. Knepley   ierr = DMClearFields(newdm);CHKERRQ(ierr);
4959e5e52638SMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
4960e5e52638SMatthew G. Knepley     DMLabel     label;
4961e5e52638SMatthew G. Knepley     PetscObject field;
496234aa8a36SMatthew G. Knepley     PetscBool   useCone, useClosure;
4963e5e52638SMatthew G. Knepley 
4964e5e52638SMatthew G. Knepley     ierr = DMGetField(dm, f, &label, &field);CHKERRQ(ierr);
4965e5e52638SMatthew G. Knepley     ierr = DMSetField(newdm, f, label, field);CHKERRQ(ierr);
496634aa8a36SMatthew G. Knepley     ierr = DMGetAdjacency(dm, f, &useCone, &useClosure);CHKERRQ(ierr);
496734aa8a36SMatthew G. Knepley     ierr = DMSetAdjacency(newdm, f, useCone, useClosure);CHKERRQ(ierr);
496834aa8a36SMatthew G. Knepley   }
496934aa8a36SMatthew G. Knepley   PetscFunctionReturn(0);
497034aa8a36SMatthew G. Knepley }
497134aa8a36SMatthew G. Knepley 
497234aa8a36SMatthew G. Knepley /*@
497334aa8a36SMatthew G. Knepley   DMGetAdjacency - Returns the flags for determining variable influence
497434aa8a36SMatthew G. Knepley 
497534aa8a36SMatthew G. Knepley   Not collective
497634aa8a36SMatthew G. Knepley 
497734aa8a36SMatthew G. Knepley   Input Parameters:
497834aa8a36SMatthew G. Knepley + dm - The DM object
497934aa8a36SMatthew G. Knepley - f  - The field number, or PETSC_DEFAULT for the default adjacency
498034aa8a36SMatthew G. Knepley 
498134aa8a36SMatthew G. Knepley   Output Parameter:
498234aa8a36SMatthew G. Knepley + useCone    - Flag for variable influence starting with the cone operation
498334aa8a36SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
498434aa8a36SMatthew G. Knepley 
498534aa8a36SMatthew G. Knepley   Notes:
498634aa8a36SMatthew G. Knepley $     FEM:   Two points p and q are adjacent if q \in closure(star(p)),   useCone = PETSC_FALSE, useClosure = PETSC_TRUE
498734aa8a36SMatthew G. Knepley $     FVM:   Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE,  useClosure = PETSC_FALSE
498834aa8a36SMatthew G. Knepley $     FVM++: Two points p and q are adjacent if q \in star(closure(p)),   useCone = PETSC_TRUE,  useClosure = PETSC_TRUE
4989979e053dSMatthew G. Knepley   Further explanation can be found in the User's Manual Section on the Influence of Variables on One Another.
499034aa8a36SMatthew G. Knepley 
499134aa8a36SMatthew G. Knepley   Level: developer
499234aa8a36SMatthew G. Knepley 
499334aa8a36SMatthew G. Knepley .seealso: DMSetAdjacency(), DMGetField(), DMSetField()
499434aa8a36SMatthew G. Knepley @*/
499534aa8a36SMatthew G. Knepley PetscErrorCode DMGetAdjacency(DM dm, PetscInt f, PetscBool *useCone, PetscBool *useClosure)
499634aa8a36SMatthew G. Knepley {
499734aa8a36SMatthew G. Knepley   PetscFunctionBegin;
499834aa8a36SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4999534a8f05SLisandro Dalcin   if (useCone)    PetscValidBoolPointer(useCone, 3);
5000534a8f05SLisandro Dalcin   if (useClosure) PetscValidBoolPointer(useClosure, 4);
500134aa8a36SMatthew G. Knepley   if (f < 0) {
500234aa8a36SMatthew G. Knepley     if (useCone)    *useCone    = dm->adjacency[0];
500334aa8a36SMatthew G. Knepley     if (useClosure) *useClosure = dm->adjacency[1];
500434aa8a36SMatthew G. Knepley   } else {
500534aa8a36SMatthew G. Knepley     PetscInt       Nf;
500634aa8a36SMatthew G. Knepley     PetscErrorCode ierr;
500734aa8a36SMatthew G. Knepley 
500834aa8a36SMatthew G. Knepley     ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
500934aa8a36SMatthew G. Knepley     if (f >= Nf) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, Nf);
501034aa8a36SMatthew G. Knepley     if (useCone)    *useCone    = dm->fields[f].adjacency[0];
501134aa8a36SMatthew G. Knepley     if (useClosure) *useClosure = dm->fields[f].adjacency[1];
501234aa8a36SMatthew G. Knepley   }
501334aa8a36SMatthew G. Knepley   PetscFunctionReturn(0);
501434aa8a36SMatthew G. Knepley }
501534aa8a36SMatthew G. Knepley 
501634aa8a36SMatthew G. Knepley /*@
501734aa8a36SMatthew G. Knepley   DMSetAdjacency - Set the flags for determining variable influence
501834aa8a36SMatthew G. Knepley 
501934aa8a36SMatthew G. Knepley   Not collective
502034aa8a36SMatthew G. Knepley 
502134aa8a36SMatthew G. Knepley   Input Parameters:
502234aa8a36SMatthew G. Knepley + dm         - The DM object
502334aa8a36SMatthew G. Knepley . f          - The field number
502434aa8a36SMatthew G. Knepley . useCone    - Flag for variable influence starting with the cone operation
502534aa8a36SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
502634aa8a36SMatthew G. Knepley 
502734aa8a36SMatthew G. Knepley   Notes:
502834aa8a36SMatthew G. Knepley $     FEM:   Two points p and q are adjacent if q \in closure(star(p)),   useCone = PETSC_FALSE, useClosure = PETSC_TRUE
502934aa8a36SMatthew G. Knepley $     FVM:   Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE,  useClosure = PETSC_FALSE
503034aa8a36SMatthew G. Knepley $     FVM++: Two points p and q are adjacent if q \in star(closure(p)),   useCone = PETSC_TRUE,  useClosure = PETSC_TRUE
5031979e053dSMatthew G. Knepley   Further explanation can be found in the User's Manual Section on the Influence of Variables on One Another.
503234aa8a36SMatthew G. Knepley 
503334aa8a36SMatthew G. Knepley   Level: developer
503434aa8a36SMatthew G. Knepley 
503534aa8a36SMatthew G. Knepley .seealso: DMGetAdjacency(), DMGetField(), DMSetField()
503634aa8a36SMatthew G. Knepley @*/
503734aa8a36SMatthew G. Knepley PetscErrorCode DMSetAdjacency(DM dm, PetscInt f, PetscBool useCone, PetscBool useClosure)
503834aa8a36SMatthew G. Knepley {
503934aa8a36SMatthew G. Knepley   PetscFunctionBegin;
504034aa8a36SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
504134aa8a36SMatthew G. Knepley   if (f < 0) {
504234aa8a36SMatthew G. Knepley     dm->adjacency[0] = useCone;
504334aa8a36SMatthew G. Knepley     dm->adjacency[1] = useClosure;
504434aa8a36SMatthew G. Knepley   } else {
504534aa8a36SMatthew G. Knepley     PetscInt       Nf;
504634aa8a36SMatthew G. Knepley     PetscErrorCode ierr;
504734aa8a36SMatthew G. Knepley 
504834aa8a36SMatthew G. Knepley     ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
504934aa8a36SMatthew G. Knepley     if (f >= Nf) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, Nf);
505034aa8a36SMatthew G. Knepley     dm->fields[f].adjacency[0] = useCone;
505134aa8a36SMatthew G. Knepley     dm->fields[f].adjacency[1] = useClosure;
5052e5e52638SMatthew G. Knepley   }
5053e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5054e5e52638SMatthew G. Knepley }
5055e5e52638SMatthew G. Knepley 
5056b0441da4SMatthew G. Knepley /*@
5057b0441da4SMatthew G. Knepley   DMGetBasicAdjacency - Returns the flags for determining variable influence, using either the default or field 0 if it is defined
5058b0441da4SMatthew G. Knepley 
5059b0441da4SMatthew G. Knepley   Not collective
5060b0441da4SMatthew G. Knepley 
5061b0441da4SMatthew G. Knepley   Input Parameters:
5062b0441da4SMatthew G. Knepley . dm - The DM object
5063b0441da4SMatthew G. Knepley 
5064b0441da4SMatthew G. Knepley   Output Parameter:
5065b0441da4SMatthew G. Knepley + useCone    - Flag for variable influence starting with the cone operation
5066b0441da4SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
5067b0441da4SMatthew G. Knepley 
5068b0441da4SMatthew G. Knepley   Notes:
5069b0441da4SMatthew G. Knepley $     FEM:   Two points p and q are adjacent if q \in closure(star(p)),   useCone = PETSC_FALSE, useClosure = PETSC_TRUE
5070b0441da4SMatthew G. Knepley $     FVM:   Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE,  useClosure = PETSC_FALSE
5071b0441da4SMatthew G. Knepley $     FVM++: Two points p and q are adjacent if q \in star(closure(p)),   useCone = PETSC_TRUE,  useClosure = PETSC_TRUE
5072b0441da4SMatthew G. Knepley 
5073b0441da4SMatthew G. Knepley   Level: developer
5074b0441da4SMatthew G. Knepley 
5075b0441da4SMatthew G. Knepley .seealso: DMSetBasicAdjacency(), DMGetField(), DMSetField()
5076b0441da4SMatthew G. Knepley @*/
5077b0441da4SMatthew G. Knepley PetscErrorCode DMGetBasicAdjacency(DM dm, PetscBool *useCone, PetscBool *useClosure)
5078b0441da4SMatthew G. Knepley {
5079b0441da4SMatthew G. Knepley   PetscInt       Nf;
5080b0441da4SMatthew G. Knepley   PetscErrorCode ierr;
5081b0441da4SMatthew G. Knepley 
5082b0441da4SMatthew G. Knepley   PetscFunctionBegin;
5083b0441da4SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5084064a246eSJacob Faibussowitsch   if (useCone)    PetscValidBoolPointer(useCone, 2);
5085064a246eSJacob Faibussowitsch   if (useClosure) PetscValidBoolPointer(useClosure, 3);
5086b0441da4SMatthew G. Knepley   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
5087b0441da4SMatthew G. Knepley   if (!Nf) {
5088b0441da4SMatthew G. Knepley     ierr = DMGetAdjacency(dm, PETSC_DEFAULT, useCone, useClosure);CHKERRQ(ierr);
5089b0441da4SMatthew G. Knepley   } else {
5090b0441da4SMatthew G. Knepley     ierr = DMGetAdjacency(dm, 0, useCone, useClosure);CHKERRQ(ierr);
5091b0441da4SMatthew G. Knepley   }
5092b0441da4SMatthew G. Knepley   PetscFunctionReturn(0);
5093b0441da4SMatthew G. Knepley }
5094b0441da4SMatthew G. Knepley 
5095b0441da4SMatthew G. Knepley /*@
5096b0441da4SMatthew G. Knepley   DMSetBasicAdjacency - Set the flags for determining variable influence, using either the default or field 0 if it is defined
5097b0441da4SMatthew G. Knepley 
5098b0441da4SMatthew G. Knepley   Not collective
5099b0441da4SMatthew G. Knepley 
5100b0441da4SMatthew G. Knepley   Input Parameters:
5101b0441da4SMatthew G. Knepley + dm         - The DM object
5102b0441da4SMatthew G. Knepley . useCone    - Flag for variable influence starting with the cone operation
5103b0441da4SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
5104b0441da4SMatthew G. Knepley 
5105b0441da4SMatthew G. Knepley   Notes:
5106b0441da4SMatthew G. Knepley $     FEM:   Two points p and q are adjacent if q \in closure(star(p)),   useCone = PETSC_FALSE, useClosure = PETSC_TRUE
5107b0441da4SMatthew G. Knepley $     FVM:   Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE,  useClosure = PETSC_FALSE
5108b0441da4SMatthew G. Knepley $     FVM++: Two points p and q are adjacent if q \in star(closure(p)),   useCone = PETSC_TRUE,  useClosure = PETSC_TRUE
5109b0441da4SMatthew G. Knepley 
5110b0441da4SMatthew G. Knepley   Level: developer
5111b0441da4SMatthew G. Knepley 
5112b0441da4SMatthew G. Knepley .seealso: DMGetBasicAdjacency(), DMGetField(), DMSetField()
5113b0441da4SMatthew G. Knepley @*/
5114b0441da4SMatthew G. Knepley PetscErrorCode DMSetBasicAdjacency(DM dm, PetscBool useCone, PetscBool useClosure)
5115b0441da4SMatthew G. Knepley {
5116b0441da4SMatthew G. Knepley   PetscInt       Nf;
5117b0441da4SMatthew G. Knepley   PetscErrorCode ierr;
5118b0441da4SMatthew G. Knepley 
5119b0441da4SMatthew G. Knepley   PetscFunctionBegin;
5120b0441da4SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5121b0441da4SMatthew G. Knepley   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
5122b0441da4SMatthew G. Knepley   if (!Nf) {
5123b0441da4SMatthew G. Knepley     ierr = DMSetAdjacency(dm, PETSC_DEFAULT, useCone, useClosure);CHKERRQ(ierr);
5124b0441da4SMatthew G. Knepley   } else {
5125b0441da4SMatthew G. Knepley     ierr = DMSetAdjacency(dm, 0, useCone, useClosure);CHKERRQ(ierr);
5126e5e52638SMatthew G. Knepley   }
5127e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5128e5e52638SMatthew G. Knepley }
5129e5e52638SMatthew G. Knepley 
5130783e2ec8SMatthew G. Knepley /* Complete labels that are being used for FEM BC */
513145480ffeSMatthew G. Knepley static PetscErrorCode DMCompleteBoundaryLabel_Internal(DM dm, PetscDS ds, PetscInt field, PetscInt bdNum, DMLabel label)
5132783e2ec8SMatthew G. Knepley {
5133783e2ec8SMatthew G. Knepley   PetscObject    obj;
5134783e2ec8SMatthew G. Knepley   PetscClassId   id;
5135783e2ec8SMatthew G. Knepley   PetscInt       Nbd, bd;
5136783e2ec8SMatthew G. Knepley   PetscBool      isFE      = PETSC_FALSE;
5137783e2ec8SMatthew G. Knepley   PetscBool      duplicate = PETSC_FALSE;
5138783e2ec8SMatthew G. Knepley   PetscErrorCode ierr;
5139783e2ec8SMatthew G. Knepley 
5140783e2ec8SMatthew G. Knepley   PetscFunctionBegin;
5141783e2ec8SMatthew G. Knepley   ierr = DMGetField(dm, field, NULL, &obj);CHKERRQ(ierr);
5142783e2ec8SMatthew G. Knepley   ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr);
5143783e2ec8SMatthew G. Knepley   if (id == PETSCFE_CLASSID) isFE = PETSC_TRUE;
5144783e2ec8SMatthew G. Knepley   if (isFE && label) {
5145783e2ec8SMatthew G. Knepley     /* Only want to modify label once */
5146783e2ec8SMatthew G. Knepley     ierr = PetscDSGetNumBoundary(ds, &Nbd);CHKERRQ(ierr);
5147783e2ec8SMatthew G. Knepley     for (bd = 0; bd < PetscMin(Nbd, bdNum); ++bd) {
514845480ffeSMatthew G. Knepley       DMLabel l;
5149783e2ec8SMatthew G. Knepley 
515045480ffeSMatthew G. Knepley       ierr = PetscDSGetBoundary(ds, bd, NULL, NULL, NULL, &l, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL);CHKERRQ(ierr);
515145480ffeSMatthew G. Knepley       duplicate = l == label ? PETSC_TRUE : PETSC_FALSE;
5152783e2ec8SMatthew G. Knepley       if (duplicate) break;
5153783e2ec8SMatthew G. Knepley     }
5154783e2ec8SMatthew G. Knepley     if (!duplicate) {
5155783e2ec8SMatthew G. Knepley       DM plex;
5156783e2ec8SMatthew G. Knepley 
5157783e2ec8SMatthew G. Knepley       ierr = DMConvert(dm, DMPLEX, &plex);CHKERRQ(ierr);
5158783e2ec8SMatthew G. Knepley       if (plex) {ierr = DMPlexLabelComplete(plex, label);CHKERRQ(ierr);}
5159783e2ec8SMatthew G. Knepley       ierr = DMDestroy(&plex);CHKERRQ(ierr);
5160783e2ec8SMatthew G. Knepley     }
5161783e2ec8SMatthew G. Knepley   }
5162783e2ec8SMatthew G. Knepley   PetscFunctionReturn(0);
5163783e2ec8SMatthew G. Knepley }
5164783e2ec8SMatthew G. Knepley 
5165e5e52638SMatthew G. Knepley static PetscErrorCode DMDSEnlarge_Static(DM dm, PetscInt NdsNew)
5166e5e52638SMatthew G. Knepley {
5167e5e52638SMatthew G. Knepley   DMSpace       *tmpd;
5168e5e52638SMatthew G. Knepley   PetscInt       Nds = dm->Nds, s;
5169e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5170e5e52638SMatthew G. Knepley 
5171e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5172e5e52638SMatthew G. Knepley   if (Nds >= NdsNew) PetscFunctionReturn(0);
5173e5e52638SMatthew G. Knepley   ierr = PetscMalloc1(NdsNew, &tmpd);CHKERRQ(ierr);
5174e5e52638SMatthew G. Knepley   for (s = 0; s < Nds; ++s) tmpd[s] = dm->probs[s];
5175b3cf3223SMatthew G. Knepley   for (s = Nds; s < NdsNew; ++s) {tmpd[s].ds = NULL; tmpd[s].label = NULL; tmpd[s].fields = NULL;}
5176e5e52638SMatthew G. Knepley   ierr = PetscFree(dm->probs);CHKERRQ(ierr);
5177e5e52638SMatthew G. Knepley   dm->Nds   = NdsNew;
5178e5e52638SMatthew G. Knepley   dm->probs = tmpd;
5179e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5180e5e52638SMatthew G. Knepley }
5181e5e52638SMatthew G. Knepley 
5182e5e52638SMatthew G. Knepley /*@
5183e5e52638SMatthew G. Knepley   DMGetNumDS - Get the number of discrete systems in the DM
5184e5e52638SMatthew G. Knepley 
5185e5e52638SMatthew G. Knepley   Not collective
5186e5e52638SMatthew G. Knepley 
5187e5e52638SMatthew G. Knepley   Input Parameter:
5188e5e52638SMatthew G. Knepley . dm - The DM
5189e5e52638SMatthew G. Knepley 
5190e5e52638SMatthew G. Knepley   Output Parameter:
5191e5e52638SMatthew G. Knepley . Nds - The number of PetscDS objects
5192e5e52638SMatthew G. Knepley 
5193e5e52638SMatthew G. Knepley   Level: intermediate
5194e5e52638SMatthew G. Knepley 
5195e5e52638SMatthew G. Knepley .seealso: DMGetDS(), DMGetCellDS()
5196e5e52638SMatthew G. Knepley @*/
5197e5e52638SMatthew G. Knepley PetscErrorCode DMGetNumDS(DM dm, PetscInt *Nds)
5198e5e52638SMatthew G. Knepley {
5199e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5200e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5201534a8f05SLisandro Dalcin   PetscValidIntPointer(Nds, 2);
5202e5e52638SMatthew G. Knepley   *Nds = dm->Nds;
5203e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5204e5e52638SMatthew G. Knepley }
5205e5e52638SMatthew G. Knepley 
5206e5e52638SMatthew G. Knepley /*@
5207e5e52638SMatthew G. Knepley   DMClearDS - Remove all discrete systems from the DM
5208e5e52638SMatthew G. Knepley 
5209d083f849SBarry Smith   Logically collective on dm
5210e5e52638SMatthew G. Knepley 
5211e5e52638SMatthew G. Knepley   Input Parameter:
5212e5e52638SMatthew G. Knepley . dm - The DM
5213e5e52638SMatthew G. Knepley 
5214e5e52638SMatthew G. Knepley   Level: intermediate
5215e5e52638SMatthew G. Knepley 
5216e5e52638SMatthew G. Knepley .seealso: DMGetNumDS(), DMGetDS(), DMSetField()
5217e5e52638SMatthew G. Knepley @*/
5218e5e52638SMatthew G. Knepley PetscErrorCode DMClearDS(DM dm)
5219e5e52638SMatthew G. Knepley {
5220e5e52638SMatthew G. Knepley   PetscInt       s;
5221e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5222e5e52638SMatthew G. Knepley 
5223e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5224e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5225e5e52638SMatthew G. Knepley   for (s = 0; s < dm->Nds; ++s) {
5226e5e52638SMatthew G. Knepley     ierr = PetscDSDestroy(&dm->probs[s].ds);CHKERRQ(ierr);
5227e5e52638SMatthew G. Knepley     ierr = DMLabelDestroy(&dm->probs[s].label);CHKERRQ(ierr);
5228b3cf3223SMatthew G. Knepley     ierr = ISDestroy(&dm->probs[s].fields);CHKERRQ(ierr);
5229e5e52638SMatthew G. Knepley   }
5230e5e52638SMatthew G. Knepley   ierr = PetscFree(dm->probs);CHKERRQ(ierr);
5231e5e52638SMatthew G. Knepley   dm->probs = NULL;
5232e5e52638SMatthew G. Knepley   dm->Nds   = 0;
5233e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5234e5e52638SMatthew G. Knepley }
5235e5e52638SMatthew G. Knepley 
5236e5e52638SMatthew G. Knepley /*@
5237e5e52638SMatthew G. Knepley   DMGetDS - Get the default PetscDS
5238e5e52638SMatthew G. Knepley 
5239e5e52638SMatthew G. Knepley   Not collective
5240e5e52638SMatthew G. Knepley 
5241e5e52638SMatthew G. Knepley   Input Parameter:
5242e5e52638SMatthew G. Knepley . dm    - The DM
5243e5e52638SMatthew G. Knepley 
5244e5e52638SMatthew G. Knepley   Output Parameter:
5245e5e52638SMatthew G. Knepley . prob - The default PetscDS
5246e5e52638SMatthew G. Knepley 
5247e5e52638SMatthew G. Knepley   Level: intermediate
5248e5e52638SMatthew G. Knepley 
5249e5e52638SMatthew G. Knepley .seealso: DMGetCellDS(), DMGetRegionDS()
5250e5e52638SMatthew G. Knepley @*/
5251e5e52638SMatthew G. Knepley PetscErrorCode DMGetDS(DM dm, PetscDS *prob)
5252e5e52638SMatthew G. Knepley {
5253b0143b4dSMatthew G. Knepley   PetscErrorCode ierr;
5254b0143b4dSMatthew G. Knepley 
5255e5e52638SMatthew G. Knepley   PetscFunctionBeginHot;
5256e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5257e5e52638SMatthew G. Knepley   PetscValidPointer(prob, 2);
5258b0143b4dSMatthew G. Knepley   if (dm->Nds <= 0) {
5259b0143b4dSMatthew G. Knepley     PetscDS ds;
5260b0143b4dSMatthew G. Knepley 
526145480ffeSMatthew G. Knepley     ierr = PetscDSCreate(PETSC_COMM_SELF, &ds);CHKERRQ(ierr);
5262b3cf3223SMatthew G. Knepley     ierr = DMSetRegionDS(dm, NULL, NULL, ds);CHKERRQ(ierr);
5263b0143b4dSMatthew G. Knepley     ierr = PetscDSDestroy(&ds);CHKERRQ(ierr);
5264b0143b4dSMatthew G. Knepley   }
5265b0143b4dSMatthew G. Knepley   *prob = dm->probs[0].ds;
5266e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5267e5e52638SMatthew G. Knepley }
5268e5e52638SMatthew G. Knepley 
5269e5e52638SMatthew G. Knepley /*@
5270e5e52638SMatthew G. Knepley   DMGetCellDS - Get the PetscDS defined on a given cell
5271e5e52638SMatthew G. Knepley 
5272e5e52638SMatthew G. Knepley   Not collective
5273e5e52638SMatthew G. Knepley 
5274e5e52638SMatthew G. Knepley   Input Parameters:
5275e5e52638SMatthew G. Knepley + dm    - The DM
5276e5e52638SMatthew G. Knepley - point - Cell for the DS
5277e5e52638SMatthew G. Knepley 
5278e5e52638SMatthew G. Knepley   Output Parameter:
5279e5e52638SMatthew G. Knepley . prob - The PetscDS defined on the given cell
5280e5e52638SMatthew G. Knepley 
5281e5e52638SMatthew G. Knepley   Level: developer
5282e5e52638SMatthew G. Knepley 
5283b0143b4dSMatthew G. Knepley .seealso: DMGetDS(), DMSetRegionDS()
5284e5e52638SMatthew G. Knepley @*/
5285e5e52638SMatthew G. Knepley PetscErrorCode DMGetCellDS(DM dm, PetscInt point, PetscDS *prob)
5286e5e52638SMatthew G. Knepley {
5287e5e52638SMatthew G. Knepley   PetscDS        probDef = NULL;
5288e5e52638SMatthew G. Knepley   PetscInt       s;
5289e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5290e5e52638SMatthew G. Knepley 
5291e5e52638SMatthew G. Knepley   PetscFunctionBeginHot;
5292e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5293e5e52638SMatthew G. Knepley   PetscValidPointer(prob, 3);
5294360cf244SMatthew G. Knepley   if (point < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Mesh point cannot be negative: %D", point);
5295e5e52638SMatthew G. Knepley   *prob = NULL;
5296e5e52638SMatthew G. Knepley   for (s = 0; s < dm->Nds; ++s) {
5297e5e52638SMatthew G. Knepley     PetscInt val;
5298e5e52638SMatthew G. Knepley 
5299e5e52638SMatthew G. Knepley     if (!dm->probs[s].label) {probDef = dm->probs[s].ds;}
5300e5e52638SMatthew G. Knepley     else {
5301e5e52638SMatthew G. Knepley       ierr = DMLabelGetValue(dm->probs[s].label, point, &val);CHKERRQ(ierr);
5302e5e52638SMatthew G. Knepley       if (val >= 0) {*prob = dm->probs[s].ds; break;}
5303e5e52638SMatthew G. Knepley     }
5304e5e52638SMatthew G. Knepley   }
5305e5e52638SMatthew G. Knepley   if (!*prob) *prob = probDef;
5306e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5307e5e52638SMatthew G. Knepley }
5308e5e52638SMatthew G. Knepley 
5309e5e52638SMatthew G. Knepley /*@
5310e5e52638SMatthew G. Knepley   DMGetRegionDS - Get the PetscDS for a given mesh region, defined by a DMLabel
5311e5e52638SMatthew G. Knepley 
5312e5e52638SMatthew G. Knepley   Not collective
5313e5e52638SMatthew G. Knepley 
5314e5e52638SMatthew G. Knepley   Input Parameters:
5315e5e52638SMatthew G. Knepley + dm    - The DM
5316e5e52638SMatthew G. Knepley - label - The DMLabel defining the mesh region, or NULL for the entire mesh
5317e5e52638SMatthew G. Knepley 
5318b3cf3223SMatthew G. Knepley   Output Parameters:
5319b3cf3223SMatthew G. Knepley + fields - The IS containing the DM field numbers for the fields in this DS, or NULL
5320b3cf3223SMatthew G. Knepley - prob - The PetscDS defined on the given region, or NULL
5321e5e52638SMatthew G. Knepley 
5322e5e52638SMatthew G. Knepley   Note: If the label is missing, this function returns an error
5323e5e52638SMatthew G. Knepley 
5324e5e52638SMatthew G. Knepley   Level: advanced
5325e5e52638SMatthew G. Knepley 
5326e5e52638SMatthew G. Knepley .seealso: DMGetRegionNumDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS()
5327e5e52638SMatthew G. Knepley @*/
5328b3cf3223SMatthew G. Knepley PetscErrorCode DMGetRegionDS(DM dm, DMLabel label, IS *fields, PetscDS *ds)
5329e5e52638SMatthew G. Knepley {
5330e5e52638SMatthew G. Knepley   PetscInt Nds = dm->Nds, s;
5331e5e52638SMatthew G. Knepley 
5332e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5333e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5334e5e52638SMatthew G. Knepley   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
5335b3cf3223SMatthew G. Knepley   if (fields) {PetscValidPointer(fields, 3); *fields = NULL;}
5336b3cf3223SMatthew G. Knepley   if (ds)     {PetscValidPointer(ds, 4);     *ds     = NULL;}
5337e5e52638SMatthew G. Knepley   for (s = 0; s < Nds; ++s) {
5338b3cf3223SMatthew G. Knepley     if (dm->probs[s].label == label) {
5339b3cf3223SMatthew G. Knepley       if (fields) *fields = dm->probs[s].fields;
5340b3cf3223SMatthew G. Knepley       if (ds)     *ds     = dm->probs[s].ds;
5341b3cf3223SMatthew G. Knepley       PetscFunctionReturn(0);
5342b3cf3223SMatthew G. Knepley     }
5343e5e52638SMatthew G. Knepley   }
53442df9ee95SMatthew G. Knepley   PetscFunctionReturn(0);
5345e5e52638SMatthew G. Knepley }
5346e5e52638SMatthew G. Knepley 
5347e5e52638SMatthew G. Knepley /*@
5348083401c6SMatthew G. Knepley   DMSetRegionDS - Set the PetscDS for a given mesh region, defined by a DMLabel
5349083401c6SMatthew G. Knepley 
5350083401c6SMatthew G. Knepley   Collective on dm
5351083401c6SMatthew G. Knepley 
5352083401c6SMatthew G. Knepley   Input Parameters:
5353083401c6SMatthew G. Knepley + dm     - The DM
5354083401c6SMatthew G. Knepley . label  - The DMLabel defining the mesh region, or NULL for the entire mesh
5355083401c6SMatthew G. Knepley . fields - The IS containing the DM field numbers for the fields in this DS, or NULL for all fields
5356083401c6SMatthew G. Knepley - prob   - The PetscDS defined on the given cell
5357083401c6SMatthew G. Knepley 
5358083401c6SMatthew 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,
5359083401c6SMatthew G. Knepley   the fields argument is ignored.
5360083401c6SMatthew G. Knepley 
5361083401c6SMatthew G. Knepley   Level: advanced
5362083401c6SMatthew G. Knepley 
5363083401c6SMatthew G. Knepley .seealso: DMGetRegionDS(), DMSetRegionNumDS(), DMGetDS(), DMGetCellDS()
5364083401c6SMatthew G. Knepley @*/
5365083401c6SMatthew G. Knepley PetscErrorCode DMSetRegionDS(DM dm, DMLabel label, IS fields, PetscDS ds)
5366083401c6SMatthew G. Knepley {
5367083401c6SMatthew G. Knepley   PetscInt       Nds = dm->Nds, s;
5368083401c6SMatthew G. Knepley   PetscErrorCode ierr;
5369083401c6SMatthew G. Knepley 
5370083401c6SMatthew G. Knepley   PetscFunctionBegin;
5371083401c6SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5372083401c6SMatthew G. Knepley   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
5373064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 4);
5374083401c6SMatthew G. Knepley   for (s = 0; s < Nds; ++s) {
5375083401c6SMatthew G. Knepley     if (dm->probs[s].label == label) {
5376083401c6SMatthew G. Knepley       ierr = PetscDSDestroy(&dm->probs[s].ds);CHKERRQ(ierr);
5377083401c6SMatthew G. Knepley       dm->probs[s].ds = ds;
5378083401c6SMatthew G. Knepley       PetscFunctionReturn(0);
5379083401c6SMatthew G. Knepley     }
5380083401c6SMatthew G. Knepley   }
5381083401c6SMatthew G. Knepley   ierr = DMDSEnlarge_Static(dm, Nds+1);CHKERRQ(ierr);
5382083401c6SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr);
5383083401c6SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) fields);CHKERRQ(ierr);
5384083401c6SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) ds);CHKERRQ(ierr);
5385083401c6SMatthew G. Knepley   if (!label) {
5386083401c6SMatthew G. Knepley     /* Put the NULL label at the front, so it is returned as the default */
5387083401c6SMatthew G. Knepley     for (s = Nds-1; s >=0; --s) dm->probs[s+1] = dm->probs[s];
5388083401c6SMatthew G. Knepley     Nds = 0;
5389083401c6SMatthew G. Knepley   }
5390083401c6SMatthew G. Knepley   dm->probs[Nds].label  = label;
5391083401c6SMatthew G. Knepley   dm->probs[Nds].fields = fields;
5392083401c6SMatthew G. Knepley   dm->probs[Nds].ds     = ds;
5393083401c6SMatthew G. Knepley   PetscFunctionReturn(0);
5394083401c6SMatthew G. Knepley }
5395083401c6SMatthew G. Knepley 
5396083401c6SMatthew G. Knepley /*@
5397e5e52638SMatthew G. Knepley   DMGetRegionNumDS - Get the PetscDS for a given mesh region, defined by the region number
5398e5e52638SMatthew G. Knepley 
5399e5e52638SMatthew G. Knepley   Not collective
5400e5e52638SMatthew G. Knepley 
5401e5e52638SMatthew G. Knepley   Input Parameters:
5402e5e52638SMatthew G. Knepley + dm  - The DM
5403e5e52638SMatthew G. Knepley - num - The region number, in [0, Nds)
5404e5e52638SMatthew G. Knepley 
5405e5e52638SMatthew G. Knepley   Output Parameters:
5406b3cf3223SMatthew G. Knepley + label  - The region label, or NULL
5407b3cf3223SMatthew G. Knepley . fields - The IS containing the DM field numbers for the fields in this DS, or NULL
5408083401c6SMatthew G. Knepley - ds     - The PetscDS defined on the given region, or NULL
5409e5e52638SMatthew G. Knepley 
5410e5e52638SMatthew G. Knepley   Level: advanced
5411e5e52638SMatthew G. Knepley 
5412e5e52638SMatthew G. Knepley .seealso: DMGetRegionDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS()
5413e5e52638SMatthew G. Knepley @*/
5414b3cf3223SMatthew G. Knepley PetscErrorCode DMGetRegionNumDS(DM dm, PetscInt num, DMLabel *label, IS *fields, PetscDS *ds)
5415e5e52638SMatthew G. Knepley {
5416e5e52638SMatthew G. Knepley   PetscInt       Nds;
5417e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5418e5e52638SMatthew G. Knepley 
5419e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5420e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5421e5e52638SMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
5422e5e52638SMatthew 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);
5423e5e52638SMatthew G. Knepley   if (label) {
5424e5e52638SMatthew G. Knepley     PetscValidPointer(label, 3);
5425e5e52638SMatthew G. Knepley     *label = dm->probs[num].label;
5426e5e52638SMatthew G. Knepley   }
5427b3cf3223SMatthew G. Knepley   if (fields) {
5428b3cf3223SMatthew G. Knepley     PetscValidPointer(fields, 4);
5429b3cf3223SMatthew G. Knepley     *fields = dm->probs[num].fields;
5430b3cf3223SMatthew G. Knepley   }
5431e5e52638SMatthew G. Knepley   if (ds) {
5432b3cf3223SMatthew G. Knepley     PetscValidPointer(ds, 5);
5433e5e52638SMatthew G. Knepley     *ds = dm->probs[num].ds;
5434e5e52638SMatthew G. Knepley   }
5435e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5436e5e52638SMatthew G. Knepley }
5437e5e52638SMatthew G. Knepley 
5438e5e52638SMatthew G. Knepley /*@
5439083401c6SMatthew G. Knepley   DMSetRegionNumDS - Set the PetscDS for a given mesh region, defined by the region number
5440e5e52638SMatthew G. Knepley 
5441083401c6SMatthew G. Knepley   Not collective
5442e5e52638SMatthew G. Knepley 
5443e5e52638SMatthew G. Knepley   Input Parameters:
5444e5e52638SMatthew G. Knepley + dm     - The DM
5445083401c6SMatthew G. Knepley . num    - The region number, in [0, Nds)
5446083401c6SMatthew G. Knepley . label  - The region label, or NULL
5447083401c6SMatthew G. Knepley . fields - The IS containing the DM field numbers for the fields in this DS, or NULL to prevent setting
5448083401c6SMatthew G. Knepley - ds     - The PetscDS defined on the given region, or NULL to prevent setting
5449e5e52638SMatthew G. Knepley 
5450e5e52638SMatthew G. Knepley   Level: advanced
5451e5e52638SMatthew G. Knepley 
5452083401c6SMatthew G. Knepley .seealso: DMGetRegionDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS()
5453e5e52638SMatthew G. Knepley @*/
5454083401c6SMatthew G. Knepley PetscErrorCode DMSetRegionNumDS(DM dm, PetscInt num, DMLabel label, IS fields, PetscDS ds)
5455e5e52638SMatthew G. Knepley {
5456083401c6SMatthew G. Knepley   PetscInt       Nds;
5457e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5458e5e52638SMatthew G. Knepley 
5459e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5460e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5461083401c6SMatthew G. Knepley   if (label) {PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 3);}
5462083401c6SMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
5463083401c6SMatthew 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);
5464e5e52638SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr);
5465083401c6SMatthew G. Knepley   ierr = DMLabelDestroy(&dm->probs[num].label);CHKERRQ(ierr);
5466083401c6SMatthew G. Knepley   dm->probs[num].label = label;
5467083401c6SMatthew G. Knepley   if (fields) {
5468083401c6SMatthew G. Knepley     PetscValidHeaderSpecific(fields, IS_CLASSID, 4);
5469b3cf3223SMatthew G. Knepley     ierr = PetscObjectReference((PetscObject) fields);CHKERRQ(ierr);
5470083401c6SMatthew G. Knepley     ierr = ISDestroy(&dm->probs[num].fields);CHKERRQ(ierr);
5471083401c6SMatthew G. Knepley     dm->probs[num].fields = fields;
5472e5e52638SMatthew G. Knepley   }
5473083401c6SMatthew G. Knepley   if (ds) {
5474083401c6SMatthew G. Knepley     PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 5);
5475083401c6SMatthew G. Knepley     ierr = PetscObjectReference((PetscObject) ds);CHKERRQ(ierr);
5476083401c6SMatthew G. Knepley     ierr = PetscDSDestroy(&dm->probs[num].ds);CHKERRQ(ierr);
5477083401c6SMatthew G. Knepley     dm->probs[num].ds = ds;
5478083401c6SMatthew G. Knepley   }
5479e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5480e5e52638SMatthew G. Knepley }
5481e5e52638SMatthew G. Knepley 
5482e5e52638SMatthew G. Knepley /*@
54831d3af9e0SMatthew G. Knepley   DMFindRegionNum - Find the region number for a given PetscDS, or -1 if it is not found.
54841d3af9e0SMatthew G. Knepley 
54851d3af9e0SMatthew G. Knepley   Not collective
54861d3af9e0SMatthew G. Knepley 
54871d3af9e0SMatthew G. Knepley   Input Parameters:
54881d3af9e0SMatthew G. Knepley + dm  - The DM
54891d3af9e0SMatthew G. Knepley - ds  - The PetscDS defined on the given region
54901d3af9e0SMatthew G. Knepley 
54911d3af9e0SMatthew G. Knepley   Output Parameter:
54921d3af9e0SMatthew G. Knepley . num - The region number, in [0, Nds), or -1 if not found
54931d3af9e0SMatthew G. Knepley 
54941d3af9e0SMatthew G. Knepley   Level: advanced
54951d3af9e0SMatthew G. Knepley 
54961d3af9e0SMatthew G. Knepley .seealso: DMGetRegionNumDS(), DMGetRegionDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS()
54971d3af9e0SMatthew G. Knepley @*/
54981d3af9e0SMatthew G. Knepley PetscErrorCode DMFindRegionNum(DM dm, PetscDS ds, PetscInt *num)
54991d3af9e0SMatthew G. Knepley {
55001d3af9e0SMatthew G. Knepley   PetscInt       Nds, n;
55011d3af9e0SMatthew G. Knepley   PetscErrorCode ierr;
55021d3af9e0SMatthew G. Knepley 
55031d3af9e0SMatthew G. Knepley   PetscFunctionBegin;
55041d3af9e0SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
55051d3af9e0SMatthew G. Knepley   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 2);
55061d3af9e0SMatthew G. Knepley   PetscValidPointer(num, 3);
55071d3af9e0SMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
55081d3af9e0SMatthew G. Knepley   for (n = 0; n < Nds; ++n) if (ds == dm->probs[n].ds) break;
55091d3af9e0SMatthew G. Knepley   if (n >= Nds) *num = -1;
55101d3af9e0SMatthew G. Knepley   else          *num = n;
55111d3af9e0SMatthew G. Knepley   PetscFunctionReturn(0);
55121d3af9e0SMatthew G. Knepley }
55131d3af9e0SMatthew G. Knepley 
55141d3af9e0SMatthew G. Knepley /*@
5515e5e52638SMatthew G. Knepley   DMCreateDS - Create the discrete systems for the DM based upon the fields added to the DM
5516e5e52638SMatthew G. Knepley 
5517d083f849SBarry Smith   Collective on dm
5518e5e52638SMatthew G. Knepley 
5519e5e52638SMatthew G. Knepley   Input Parameter:
5520e5e52638SMatthew G. Knepley . dm - The DM
5521e5e52638SMatthew G. Knepley 
552245480ffeSMatthew G. Knepley   Options Database Keys:
552345480ffeSMatthew G. Knepley . -dm_petscds_view - View all the PetscDS objects in this DM
552445480ffeSMatthew G. Knepley 
5525e5e52638SMatthew G. Knepley   Note: If the label has a DS defined, it will be replaced. Otherwise, it will be added to the DM.
5526e5e52638SMatthew G. Knepley 
5527e5e52638SMatthew G. Knepley   Level: intermediate
5528e5e52638SMatthew G. Knepley 
5529e5e52638SMatthew G. Knepley .seealso: DMSetField, DMAddField(), DMGetDS(), DMGetCellDS(), DMGetRegionDS(), DMSetRegionDS()
5530e5e52638SMatthew G. Knepley @*/
5531e5e52638SMatthew G. Knepley PetscErrorCode DMCreateDS(DM dm)
5532e5e52638SMatthew G. Knepley {
5533e5e52638SMatthew G. Knepley   MPI_Comm       comm;
5534083401c6SMatthew G. Knepley   PetscDS        dsDef;
5535083401c6SMatthew G. Knepley   DMLabel       *labelSet;
5536f9244615SMatthew G. Knepley   PetscInt       dE, Nf = dm->Nf, f, s, Nl, l, Ndef, k;
5537f9244615SMatthew G. Knepley   PetscBool      doSetup = PETSC_TRUE, flg;
5538e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5539e5e52638SMatthew G. Knepley 
5540e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5541e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5542e5e52638SMatthew G. Knepley   if (!dm->fields) PetscFunctionReturn(0);
5543e5e52638SMatthew G. Knepley   ierr = PetscObjectGetComm((PetscObject) dm, &comm);CHKERRQ(ierr);
5544083401c6SMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &dE);CHKERRQ(ierr);
5545083401c6SMatthew G. Knepley   /* Determine how many regions we have */
5546083401c6SMatthew G. Knepley   ierr = PetscMalloc1(Nf, &labelSet);CHKERRQ(ierr);
5547083401c6SMatthew G. Knepley   Nl   = 0;
5548083401c6SMatthew G. Knepley   Ndef = 0;
5549083401c6SMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
5550083401c6SMatthew G. Knepley     DMLabel  label = dm->fields[f].label;
5551083401c6SMatthew G. Knepley     PetscInt l;
5552083401c6SMatthew G. Knepley 
5553f918ec44SMatthew G. Knepley #ifdef PETSC_HAVE_LIBCEED
5554f918ec44SMatthew G. Knepley     /* Move CEED context to discretizations */
5555f918ec44SMatthew G. Knepley     {
5556f918ec44SMatthew G. Knepley       PetscClassId id;
5557f918ec44SMatthew G. Knepley 
5558f918ec44SMatthew G. Knepley       ierr = PetscObjectGetClassId(dm->fields[f].disc, &id);CHKERRQ(ierr);
5559f918ec44SMatthew G. Knepley       if (id == PETSCFE_CLASSID) {
5560f918ec44SMatthew G. Knepley         Ceed ceed;
5561f918ec44SMatthew G. Knepley 
5562f918ec44SMatthew G. Knepley         ierr = DMGetCeed(dm, &ceed);CHKERRQ(ierr);
5563f918ec44SMatthew G. Knepley         ierr = PetscFESetCeed((PetscFE) dm->fields[f].disc, ceed);CHKERRQ(ierr);
5564f918ec44SMatthew G. Knepley       }
5565f918ec44SMatthew G. Knepley     }
5566f918ec44SMatthew G. Knepley #endif
5567083401c6SMatthew G. Knepley     if (!label) {++Ndef; continue;}
5568083401c6SMatthew G. Knepley     for (l = 0; l < Nl; ++l) if (label == labelSet[l]) break;
5569083401c6SMatthew G. Knepley     if (l < Nl) continue;
5570083401c6SMatthew G. Knepley     labelSet[Nl++] = label;
5571083401c6SMatthew G. Knepley   }
5572083401c6SMatthew G. Knepley   /* Create default DS if there are no labels to intersect with */
5573083401c6SMatthew G. Knepley   ierr = DMGetRegionDS(dm, NULL, NULL, &dsDef);CHKERRQ(ierr);
5574083401c6SMatthew G. Knepley   if (!dsDef && Ndef && !Nl) {
5575b3cf3223SMatthew G. Knepley     IS        fields;
5576b3cf3223SMatthew G. Knepley     PetscInt *fld, nf;
5577b3cf3223SMatthew G. Knepley 
5578b3cf3223SMatthew G. Knepley     for (f = 0, nf = 0; f < Nf; ++f) if (!dm->fields[f].label) ++nf;
5579083401c6SMatthew G. Knepley     if (nf) {
5580b3cf3223SMatthew G. Knepley       ierr = PetscMalloc1(nf, &fld);CHKERRQ(ierr);
5581b3cf3223SMatthew G. Knepley       for (f = 0, nf = 0; f < Nf; ++f) if (!dm->fields[f].label) fld[nf++] = f;
558288f0c812SMatthew G. Knepley       ierr = ISCreate(PETSC_COMM_SELF, &fields);CHKERRQ(ierr);
558388f0c812SMatthew G. Knepley       ierr = PetscObjectSetOptionsPrefix((PetscObject) fields, "dm_fields_");CHKERRQ(ierr);
558488f0c812SMatthew G. Knepley       ierr = ISSetType(fields, ISGENERAL);CHKERRQ(ierr);
558588f0c812SMatthew G. Knepley       ierr = ISGeneralSetIndices(fields, nf, fld, PETSC_OWN_POINTER);CHKERRQ(ierr);
558688f0c812SMatthew G. Knepley 
558745480ffeSMatthew G. Knepley       ierr = PetscDSCreate(PETSC_COMM_SELF, &dsDef);CHKERRQ(ierr);
5588083401c6SMatthew G. Knepley       ierr = DMSetRegionDS(dm, NULL, fields, dsDef);CHKERRQ(ierr);
5589083401c6SMatthew G. Knepley       ierr = PetscDSDestroy(&dsDef);CHKERRQ(ierr);
5590b3cf3223SMatthew G. Knepley       ierr = ISDestroy(&fields);CHKERRQ(ierr);
55912df9ee95SMatthew G. Knepley     }
5592083401c6SMatthew G. Knepley   }
5593083401c6SMatthew G. Knepley   ierr = DMGetRegionDS(dm, NULL, NULL, &dsDef);CHKERRQ(ierr);
5594083401c6SMatthew G. Knepley   if (dsDef) {ierr = PetscDSSetCoordinateDimension(dsDef, dE);CHKERRQ(ierr);}
5595083401c6SMatthew G. Knepley   /* Intersect labels with default fields */
5596083401c6SMatthew G. Knepley   if (Ndef && Nl) {
55970122748bSMatthew G. Knepley     DM              plex;
5598083401c6SMatthew G. Knepley     DMLabel         cellLabel;
5599083401c6SMatthew G. Knepley     IS              fieldIS, allcellIS, defcellIS = NULL;
5600083401c6SMatthew G. Knepley     PetscInt       *fields;
5601083401c6SMatthew G. Knepley     const PetscInt *cells;
5602083401c6SMatthew G. Knepley     PetscInt        depth, nf = 0, n, c;
56030122748bSMatthew G. Knepley 
56040122748bSMatthew G. Knepley     ierr = DMConvert(dm, DMPLEX, &plex);CHKERRQ(ierr);
56050122748bSMatthew G. Knepley     ierr = DMPlexGetDepth(plex, &depth);CHKERRQ(ierr);
5606083401c6SMatthew G. Knepley     ierr = DMGetStratumIS(plex, "dim", depth, &allcellIS);CHKERRQ(ierr);
5607083401c6SMatthew G. Knepley     if (!allcellIS) {ierr = DMGetStratumIS(plex, "depth", depth, &allcellIS);CHKERRQ(ierr);}
5608083401c6SMatthew G. Knepley     for (l = 0; l < Nl; ++l) {
5609083401c6SMatthew G. Knepley       DMLabel label = labelSet[l];
5610083401c6SMatthew G. Knepley       IS      pointIS;
5611083401c6SMatthew G. Knepley 
5612083401c6SMatthew G. Knepley       ierr = ISDestroy(&defcellIS);CHKERRQ(ierr);
5613083401c6SMatthew G. Knepley       ierr = DMLabelGetStratumIS(label, 1, &pointIS);CHKERRQ(ierr);
5614083401c6SMatthew G. Knepley       ierr = ISDifference(allcellIS, pointIS, &defcellIS);CHKERRQ(ierr);
5615083401c6SMatthew G. Knepley       ierr = ISDestroy(&pointIS);CHKERRQ(ierr);
5616083401c6SMatthew G. Knepley     }
5617083401c6SMatthew G. Knepley     ierr = ISDestroy(&allcellIS);CHKERRQ(ierr);
5618083401c6SMatthew G. Knepley 
5619083401c6SMatthew G. Knepley     ierr = DMLabelCreate(PETSC_COMM_SELF, "defaultCells", &cellLabel);CHKERRQ(ierr);
5620083401c6SMatthew G. Knepley     ierr = ISGetLocalSize(defcellIS, &n);CHKERRQ(ierr);
5621083401c6SMatthew G. Knepley     ierr = ISGetIndices(defcellIS, &cells);CHKERRQ(ierr);
5622083401c6SMatthew G. Knepley     for (c = 0; c < n; ++c) {ierr = DMLabelSetValue(cellLabel, cells[c], 1);CHKERRQ(ierr);}
5623083401c6SMatthew G. Knepley     ierr = ISRestoreIndices(defcellIS, &cells);CHKERRQ(ierr);
5624083401c6SMatthew G. Knepley     ierr = ISDestroy(&defcellIS);CHKERRQ(ierr);
5625083401c6SMatthew G. Knepley     ierr = DMPlexLabelComplete(plex, cellLabel);CHKERRQ(ierr);
5626083401c6SMatthew G. Knepley 
5627083401c6SMatthew G. Knepley     ierr = PetscMalloc1(Ndef, &fields);CHKERRQ(ierr);
5628083401c6SMatthew G. Knepley     for (f = 0; f < Nf; ++f) if (!dm->fields[f].label) fields[nf++] = f;
5629083401c6SMatthew G. Knepley     ierr = ISCreate(PETSC_COMM_SELF, &fieldIS);CHKERRQ(ierr);
5630083401c6SMatthew G. Knepley     ierr = PetscObjectSetOptionsPrefix((PetscObject) fieldIS, "dm_fields_");CHKERRQ(ierr);
5631083401c6SMatthew G. Knepley     ierr = ISSetType(fieldIS, ISGENERAL);CHKERRQ(ierr);
5632083401c6SMatthew G. Knepley     ierr = ISGeneralSetIndices(fieldIS, nf, fields, PETSC_OWN_POINTER);CHKERRQ(ierr);
5633083401c6SMatthew G. Knepley 
563445480ffeSMatthew G. Knepley     ierr = PetscDSCreate(PETSC_COMM_SELF, &dsDef);CHKERRQ(ierr);
5635083401c6SMatthew G. Knepley     ierr = DMSetRegionDS(dm, cellLabel, fieldIS, dsDef);CHKERRQ(ierr);
5636083401c6SMatthew G. Knepley     ierr = DMLabelDestroy(&cellLabel);CHKERRQ(ierr);
5637083401c6SMatthew G. Knepley     ierr = PetscDSSetCoordinateDimension(dsDef, dE);CHKERRQ(ierr);
5638083401c6SMatthew G. Knepley     ierr = PetscDSDestroy(&dsDef);CHKERRQ(ierr);
5639083401c6SMatthew G. Knepley     ierr = ISDestroy(&fieldIS);CHKERRQ(ierr);
56400122748bSMatthew G. Knepley     ierr = DMDestroy(&plex);CHKERRQ(ierr);
5641083401c6SMatthew G. Knepley   }
5642083401c6SMatthew G. Knepley   /* Create label DSes
5643083401c6SMatthew G. Knepley      - WE ONLY SUPPORT IDENTICAL OR DISJOINT LABELS
5644083401c6SMatthew G. Knepley   */
5645083401c6SMatthew G. Knepley   /* TODO Should check that labels are disjoint */
5646083401c6SMatthew G. Knepley   for (l = 0; l < Nl; ++l) {
5647083401c6SMatthew G. Knepley     DMLabel   label = labelSet[l];
5648083401c6SMatthew G. Knepley     PetscDS   ds;
5649083401c6SMatthew G. Knepley     IS        fields;
5650083401c6SMatthew G. Knepley     PetscInt *fld, nf;
5651083401c6SMatthew G. Knepley 
565245480ffeSMatthew G. Knepley     ierr = PetscDSCreate(PETSC_COMM_SELF, &ds);CHKERRQ(ierr);
5653083401c6SMatthew G. Knepley     for (f = 0, nf = 0; f < Nf; ++f) if (label == dm->fields[f].label || !dm->fields[f].label) ++nf;
5654083401c6SMatthew G. Knepley     ierr = PetscMalloc1(nf, &fld);CHKERRQ(ierr);
5655083401c6SMatthew G. Knepley     for (f = 0, nf = 0; f < Nf; ++f) if (label == dm->fields[f].label || !dm->fields[f].label) fld[nf++] = f;
5656083401c6SMatthew G. Knepley     ierr = ISCreate(PETSC_COMM_SELF, &fields);CHKERRQ(ierr);
5657083401c6SMatthew G. Knepley     ierr = PetscObjectSetOptionsPrefix((PetscObject) fields, "dm_fields_");CHKERRQ(ierr);
5658083401c6SMatthew G. Knepley     ierr = ISSetType(fields, ISGENERAL);CHKERRQ(ierr);
5659083401c6SMatthew G. Knepley     ierr = ISGeneralSetIndices(fields, nf, fld, PETSC_OWN_POINTER);CHKERRQ(ierr);
5660083401c6SMatthew G. Knepley     ierr = DMSetRegionDS(dm, label, fields, ds);CHKERRQ(ierr);
5661083401c6SMatthew G. Knepley     ierr = ISDestroy(&fields);CHKERRQ(ierr);
5662083401c6SMatthew G. Knepley     ierr = PetscDSSetCoordinateDimension(ds, dE);CHKERRQ(ierr);
5663083401c6SMatthew G. Knepley     {
5664083401c6SMatthew G. Knepley       DMPolytopeType ct;
5665083401c6SMatthew G. Knepley       PetscInt       lStart, lEnd;
5666083401c6SMatthew G. Knepley       PetscBool      isHybridLocal = PETSC_FALSE, isHybrid;
56670122748bSMatthew G. Knepley 
5668e5e52638SMatthew G. Knepley       ierr = DMLabelGetBounds(label, &lStart, &lEnd);CHKERRQ(ierr);
5669665f567fSMatthew G. Knepley       if (lStart >= 0) {
5670412e9a14SMatthew G. Knepley         ierr = DMPlexGetCellType(dm, lStart, &ct);CHKERRQ(ierr);
5671412e9a14SMatthew G. Knepley         switch (ct) {
5672412e9a14SMatthew G. Knepley           case DM_POLYTOPE_POINT_PRISM_TENSOR:
5673412e9a14SMatthew G. Knepley           case DM_POLYTOPE_SEG_PRISM_TENSOR:
5674412e9a14SMatthew G. Knepley           case DM_POLYTOPE_TRI_PRISM_TENSOR:
5675412e9a14SMatthew G. Knepley           case DM_POLYTOPE_QUAD_PRISM_TENSOR:
5676083401c6SMatthew G. Knepley             isHybridLocal = PETSC_TRUE;break;
5677083401c6SMatthew G. Knepley           default: break;
5678412e9a14SMatthew G. Knepley         }
5679665f567fSMatthew G. Knepley       }
5680ffc4695bSBarry Smith       ierr = MPI_Allreduce(&isHybridLocal, &isHybrid, 1, MPIU_BOOL, MPI_LOR, comm);CHKERRMPI(ierr);
5681083401c6SMatthew G. Knepley       ierr = PetscDSSetHybrid(ds, isHybrid);CHKERRQ(ierr);
5682e5e52638SMatthew G. Knepley     }
5683083401c6SMatthew G. Knepley     ierr = PetscDSDestroy(&ds);CHKERRQ(ierr);
5684e5e52638SMatthew G. Knepley   }
5685083401c6SMatthew G. Knepley   ierr = PetscFree(labelSet);CHKERRQ(ierr);
5686e5e52638SMatthew G. Knepley   /* Set fields in DSes */
5687083401c6SMatthew G. Knepley   for (s = 0; s < dm->Nds; ++s) {
5688083401c6SMatthew G. Knepley     PetscDS         ds     = dm->probs[s].ds;
5689083401c6SMatthew G. Knepley     IS              fields = dm->probs[s].fields;
5690083401c6SMatthew G. Knepley     const PetscInt *fld;
5691083401c6SMatthew G. Knepley     PetscInt        nf;
5692e5e52638SMatthew G. Knepley 
5693083401c6SMatthew G. Knepley     ierr = ISGetLocalSize(fields, &nf);CHKERRQ(ierr);
5694083401c6SMatthew G. Knepley     ierr = ISGetIndices(fields, &fld);CHKERRQ(ierr);
5695083401c6SMatthew G. Knepley     for (f = 0; f < nf; ++f) {
5696083401c6SMatthew G. Knepley       PetscObject  disc  = dm->fields[fld[f]].disc;
5697083401c6SMatthew G. Knepley       PetscBool    isHybrid;
5698e5e52638SMatthew G. Knepley       PetscClassId id;
5699e5e52638SMatthew G. Knepley 
5700083401c6SMatthew G. Knepley       ierr = PetscDSGetHybrid(ds, &isHybrid);CHKERRQ(ierr);
5701083401c6SMatthew G. Knepley       /* If this is a cohesive cell, then it needs the lower dimensional discretization */
5702083401c6SMatthew G. Knepley       if (isHybrid && f < nf-1) {ierr = PetscFEGetHeightSubspace((PetscFE) disc, 1, (PetscFE *) &disc);CHKERRQ(ierr);}
5703083401c6SMatthew G. Knepley       ierr = PetscDSSetDiscretization(ds, f, disc);CHKERRQ(ierr);
5704083401c6SMatthew G. Knepley       /* We allow people to have placeholder fields and construct the Section by hand */
5705e5e52638SMatthew G. Knepley       ierr = PetscObjectGetClassId(disc, &id);CHKERRQ(ierr);
5706e5e52638SMatthew G. Knepley       if ((id != PETSCFE_CLASSID) && (id != PETSCFV_CLASSID)) doSetup = PETSC_FALSE;
5707e5e52638SMatthew G. Knepley     }
5708083401c6SMatthew G. Knepley     ierr = ISRestoreIndices(fields, &fld);CHKERRQ(ierr);
5709e5e52638SMatthew G. Knepley   }
5710f9244615SMatthew G. Knepley   /* Allow k-jet tabulation */
5711f9244615SMatthew G. Knepley   ierr = PetscOptionsGetInt(NULL, ((PetscObject) dm)->prefix, "-dm_ds_jet_degree", &k, &flg);CHKERRQ(ierr);
5712f9244615SMatthew G. Knepley   if (flg) {
57133b4aee56SMatthew G. Knepley     for (s = 0; s < dm->Nds; ++s) {
57143b4aee56SMatthew G. Knepley       PetscDS  ds = dm->probs[s].ds;
57153b4aee56SMatthew G. Knepley       PetscInt Nf, f;
57163b4aee56SMatthew G. Knepley 
57173b4aee56SMatthew G. Knepley       ierr = PetscDSGetNumFields(ds, &Nf);CHKERRQ(ierr);
57183b4aee56SMatthew G. Knepley       for (f = 0; f < Nf; ++f) {ierr = PetscDSSetJetDegree(ds, f, k);CHKERRQ(ierr);}
57193b4aee56SMatthew G. Knepley     }
5720f9244615SMatthew G. Knepley   }
5721e5e52638SMatthew G. Knepley   /* Setup DSes */
5722e5e52638SMatthew G. Knepley   if (doSetup) {
5723e5e52638SMatthew G. Knepley     for (s = 0; s < dm->Nds; ++s) {ierr = PetscDSSetUp(dm->probs[s].ds);CHKERRQ(ierr);}
5724e5e52638SMatthew G. Knepley   }
5725e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5726e5e52638SMatthew G. Knepley }
5727e5e52638SMatthew G. Knepley 
5728e5e52638SMatthew G. Knepley /*@
57297f96f943SMatthew G. Knepley   DMComputeExactSolution - Compute the exact solution for a given DM, using the PetscDS information.
57307f96f943SMatthew G. Knepley 
5731f2cacb80SMatthew G. Knepley   Collective on DM
5732f2cacb80SMatthew G. Knepley 
57337f96f943SMatthew G. Knepley   Input Parameters:
57347f96f943SMatthew G. Knepley + dm   - The DM
57357f96f943SMatthew G. Knepley - time - The time
57367f96f943SMatthew G. Knepley 
57377f96f943SMatthew G. Knepley   Output Parameters:
5738f2cacb80SMatthew G. Knepley + u    - The vector will be filled with exact solution values, or NULL
5739f2cacb80SMatthew G. Knepley - u_t  - The vector will be filled with the time derivative of exact solution values, or NULL
57407f96f943SMatthew G. Knepley 
57417f96f943SMatthew G. Knepley   Note: The user must call PetscDSSetExactSolution() beforehand
57427f96f943SMatthew G. Knepley 
57437f96f943SMatthew G. Knepley   Level: developer
57447f96f943SMatthew G. Knepley 
57457f96f943SMatthew G. Knepley .seealso: PetscDSSetExactSolution()
57467f96f943SMatthew G. Knepley @*/
5747f2cacb80SMatthew G. Knepley PetscErrorCode DMComputeExactSolution(DM dm, PetscReal time, Vec u, Vec u_t)
57487f96f943SMatthew G. Knepley {
57497f96f943SMatthew G. Knepley   PetscErrorCode (**exacts)(PetscInt, PetscReal, const PetscReal x[], PetscInt, PetscScalar *u, void *ctx);
57507f96f943SMatthew G. Knepley   void            **ectxs;
57517f96f943SMatthew G. Knepley   PetscInt          Nf, Nds, s;
57527f96f943SMatthew G. Knepley   PetscErrorCode    ierr;
57537f96f943SMatthew G. Knepley 
57547f96f943SMatthew G. Knepley   PetscFunctionBegin;
5755f2cacb80SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5756f2cacb80SMatthew G. Knepley   if (u)   PetscValidHeaderSpecific(u, VEC_CLASSID, 3);
5757f2cacb80SMatthew G. Knepley   if (u_t) PetscValidHeaderSpecific(u_t, VEC_CLASSID, 4);
57587f96f943SMatthew G. Knepley   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
57597f96f943SMatthew G. Knepley   ierr = PetscMalloc2(Nf, &exacts, Nf, &ectxs);CHKERRQ(ierr);
57607f96f943SMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
57617f96f943SMatthew G. Knepley   for (s = 0; s < Nds; ++s) {
57627f96f943SMatthew G. Knepley     PetscDS         ds;
57637f96f943SMatthew G. Knepley     DMLabel         label;
57647f96f943SMatthew G. Knepley     IS              fieldIS;
57657f96f943SMatthew G. Knepley     const PetscInt *fields, id = 1;
57667f96f943SMatthew G. Knepley     PetscInt        dsNf, f;
57677f96f943SMatthew G. Knepley 
57687f96f943SMatthew G. Knepley     ierr = DMGetRegionNumDS(dm, s, &label, &fieldIS, &ds);CHKERRQ(ierr);
57697f96f943SMatthew G. Knepley     ierr = PetscDSGetNumFields(ds, &dsNf);CHKERRQ(ierr);
57707f96f943SMatthew G. Knepley     ierr = ISGetIndices(fieldIS, &fields);CHKERRQ(ierr);
57717f96f943SMatthew G. Knepley     ierr = PetscArrayzero(exacts, Nf);CHKERRQ(ierr);
57727f96f943SMatthew G. Knepley     ierr = PetscArrayzero(ectxs, Nf);CHKERRQ(ierr);
5773f2cacb80SMatthew G. Knepley     if (u) {
57747f96f943SMatthew G. Knepley       for (f = 0; f < dsNf; ++f) {
57757f96f943SMatthew G. Knepley         const PetscInt field = fields[f];
57767f96f943SMatthew G. Knepley         ierr = PetscDSGetExactSolution(ds, field, &exacts[field], &ectxs[field]);CHKERRQ(ierr);
57777f96f943SMatthew G. Knepley       }
57787f96f943SMatthew G. Knepley       ierr = ISRestoreIndices(fieldIS, &fields);CHKERRQ(ierr);
57797f96f943SMatthew G. Knepley       if (label) {
57807f96f943SMatthew G. Knepley         ierr = DMProjectFunctionLabel(dm, time, label, 1, &id, 0, NULL, exacts, ectxs, INSERT_ALL_VALUES, u);CHKERRQ(ierr);
57817f96f943SMatthew G. Knepley       } else {
57827f96f943SMatthew G. Knepley         ierr = DMProjectFunction(dm, time, exacts, ectxs, INSERT_ALL_VALUES, u);CHKERRQ(ierr);
57837f96f943SMatthew G. Knepley       }
57847f96f943SMatthew G. Knepley     }
5785f2cacb80SMatthew G. Knepley     if (u_t) {
5786f2cacb80SMatthew G. Knepley       ierr = PetscArrayzero(exacts, Nf);CHKERRQ(ierr);
5787f2cacb80SMatthew G. Knepley       ierr = PetscArrayzero(ectxs, Nf);CHKERRQ(ierr);
5788f2cacb80SMatthew G. Knepley       for (f = 0; f < dsNf; ++f) {
5789f2cacb80SMatthew G. Knepley         const PetscInt field = fields[f];
5790f2cacb80SMatthew G. Knepley         ierr = PetscDSGetExactSolutionTimeDerivative(ds, field, &exacts[field], &ectxs[field]);CHKERRQ(ierr);
5791f2cacb80SMatthew G. Knepley       }
5792f2cacb80SMatthew G. Knepley       ierr = ISRestoreIndices(fieldIS, &fields);CHKERRQ(ierr);
5793f2cacb80SMatthew G. Knepley       if (label) {
5794f2cacb80SMatthew G. Knepley         ierr = DMProjectFunctionLabel(dm, time, label, 1, &id, 0, NULL, exacts, ectxs, INSERT_ALL_VALUES, u_t);CHKERRQ(ierr);
5795f2cacb80SMatthew G. Knepley       } else {
5796f2cacb80SMatthew G. Knepley         ierr = DMProjectFunction(dm, time, exacts, ectxs, INSERT_ALL_VALUES, u_t);CHKERRQ(ierr);
5797f2cacb80SMatthew G. Knepley       }
5798f2cacb80SMatthew G. Knepley     }
5799f2cacb80SMatthew G. Knepley   }
5800f2cacb80SMatthew G. Knepley   if (u) {
58017f96f943SMatthew G. Knepley     ierr = PetscObjectSetName((PetscObject) u, "Exact Solution");CHKERRQ(ierr);
58027f96f943SMatthew G. Knepley     ierr = PetscObjectSetOptionsPrefix((PetscObject) u, "exact_");CHKERRQ(ierr);
5803f2cacb80SMatthew G. Knepley   }
5804f2cacb80SMatthew G. Knepley   if (u_t) {
5805f2cacb80SMatthew G. Knepley     ierr = PetscObjectSetName((PetscObject) u, "Exact Solution Time Derivative");CHKERRQ(ierr);
5806f2cacb80SMatthew G. Knepley     ierr = PetscObjectSetOptionsPrefix((PetscObject) u_t, "exact_t_");CHKERRQ(ierr);
5807f2cacb80SMatthew G. Knepley   }
58087f96f943SMatthew G. Knepley   ierr = PetscFree2(exacts, ectxs);CHKERRQ(ierr);
58097f96f943SMatthew G. Knepley   PetscFunctionReturn(0);
58107f96f943SMatthew G. Knepley }
58117f96f943SMatthew G. Knepley 
581245480ffeSMatthew G. Knepley PetscErrorCode DMTransferDS_Internal(DM dm, DMLabel label, IS fields, PetscDS ds)
581345480ffeSMatthew G. Knepley {
581445480ffeSMatthew G. Knepley   PetscDS        dsNew;
581545480ffeSMatthew G. Knepley   DSBoundary     b;
581645480ffeSMatthew G. Knepley   PetscInt       cdim, Nf, f;
5817df911668SMatthew G. Knepley   PetscBool      isHybrid;
581845480ffeSMatthew G. Knepley   void          *ctx;
581945480ffeSMatthew G. Knepley   PetscErrorCode ierr;
582045480ffeSMatthew G. Knepley 
582145480ffeSMatthew G. Knepley   PetscFunctionBegin;
582245480ffeSMatthew G. Knepley   ierr = PetscDSCreate(PetscObjectComm((PetscObject) ds), &dsNew);CHKERRQ(ierr);
582345480ffeSMatthew G. Knepley   ierr = PetscDSCopyConstants(ds, dsNew);CHKERRQ(ierr);
582445480ffeSMatthew G. Knepley   ierr = PetscDSCopyExactSolutions(ds, dsNew);CHKERRQ(ierr);
582545480ffeSMatthew G. Knepley   ierr = PetscDSSelectDiscretizations(ds, PETSC_DETERMINE, NULL, dsNew);CHKERRQ(ierr);
582645480ffeSMatthew G. Knepley   ierr = PetscDSCopyEquations(ds, dsNew);CHKERRQ(ierr);
582745480ffeSMatthew G. Knepley   ierr = PetscDSGetNumFields(ds, &Nf);CHKERRQ(ierr);
582845480ffeSMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
582945480ffeSMatthew G. Knepley     ierr = PetscDSGetContext(ds, f, &ctx);CHKERRQ(ierr);
583045480ffeSMatthew G. Knepley     ierr = PetscDSSetContext(dsNew, f, ctx);CHKERRQ(ierr);
583145480ffeSMatthew G. Knepley   }
583245480ffeSMatthew G. Knepley   if (Nf) {
583345480ffeSMatthew G. Knepley     ierr = PetscDSGetCoordinateDimension(ds, &cdim);CHKERRQ(ierr);
583445480ffeSMatthew G. Knepley     ierr = PetscDSSetCoordinateDimension(dsNew, cdim);CHKERRQ(ierr);
583545480ffeSMatthew G. Knepley   }
583645480ffeSMatthew G. Knepley   ierr = PetscDSCopyBoundary(ds, PETSC_DETERMINE, NULL, dsNew);CHKERRQ(ierr);
583745480ffeSMatthew G. Knepley   for (b = dsNew->boundary; b; b = b->next) {
583845480ffeSMatthew G. Knepley     ierr = DMGetLabel(dm, b->lname, &b->label);CHKERRQ(ierr);
583945480ffeSMatthew G. Knepley     /* Do not check if label exists here, since p4est calls this for the reference tree which does not have the labels */
584045480ffeSMatthew G. Knepley     //if (!b->label) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Label %s missing in new DM", name);
584145480ffeSMatthew G. Knepley   }
5842df911668SMatthew G. Knepley   ierr = PetscDSGetHybrid(ds, &isHybrid);CHKERRQ(ierr);
5843df911668SMatthew G. Knepley   ierr = PetscDSSetHybrid(dsNew, isHybrid);CHKERRQ(ierr);
584445480ffeSMatthew G. Knepley 
584545480ffeSMatthew G. Knepley   ierr = DMSetRegionDS(dm, label, fields, dsNew);CHKERRQ(ierr);
584645480ffeSMatthew G. Knepley   ierr = PetscDSDestroy(&dsNew);CHKERRQ(ierr);
584745480ffeSMatthew G. Knepley   PetscFunctionReturn(0);
584845480ffeSMatthew G. Knepley }
584945480ffeSMatthew G. Knepley 
58507f96f943SMatthew G. Knepley /*@
5851e5e52638SMatthew G. Knepley   DMCopyDS - Copy the discrete systems for the DM into another DM
5852e5e52638SMatthew G. Knepley 
5853d083f849SBarry Smith   Collective on dm
5854e5e52638SMatthew G. Knepley 
5855e5e52638SMatthew G. Knepley   Input Parameter:
5856e5e52638SMatthew G. Knepley . dm - The DM
5857e5e52638SMatthew G. Knepley 
5858e5e52638SMatthew G. Knepley   Output Parameter:
5859e5e52638SMatthew G. Knepley . newdm - The DM
5860e5e52638SMatthew G. Knepley 
5861e5e52638SMatthew G. Knepley   Level: advanced
5862e5e52638SMatthew G. Knepley 
5863e5e52638SMatthew G. Knepley .seealso: DMCopyFields(), DMAddField(), DMGetDS(), DMGetCellDS(), DMGetRegionDS(), DMSetRegionDS()
5864e5e52638SMatthew G. Knepley @*/
5865e5e52638SMatthew G. Knepley PetscErrorCode DMCopyDS(DM dm, DM newdm)
5866e5e52638SMatthew G. Knepley {
5867e5e52638SMatthew G. Knepley   PetscInt       Nds, s;
5868e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5869e5e52638SMatthew G. Knepley 
5870e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5871e5e52638SMatthew G. Knepley   if (dm == newdm) PetscFunctionReturn(0);
5872e5e52638SMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
5873e5e52638SMatthew G. Knepley   ierr = DMClearDS(newdm);CHKERRQ(ierr);
5874e5e52638SMatthew G. Knepley   for (s = 0; s < Nds; ++s) {
5875e5e52638SMatthew G. Knepley     DMLabel  label;
5876b3cf3223SMatthew G. Knepley     IS       fields;
587745480ffeSMatthew G. Knepley     PetscDS  ds, newds;
5878783e2ec8SMatthew G. Knepley     PetscInt Nbd, bd;
5879e5e52638SMatthew G. Knepley 
5880b3cf3223SMatthew G. Knepley     ierr = DMGetRegionNumDS(dm, s, &label, &fields, &ds);CHKERRQ(ierr);
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) {
588645480ffeSMatthew G. Knepley       DMLabel  label;
5887783e2ec8SMatthew G. Knepley       PetscInt field;
5888783e2ec8SMatthew G. Knepley 
588945480ffeSMatthew G. Knepley       ierr = PetscDSGetBoundary(newds, bd, NULL, NULL, NULL, &label, NULL, NULL, &field, NULL, NULL, NULL, NULL, NULL);CHKERRQ(ierr);
589045480ffeSMatthew G. Knepley       ierr = DMCompleteBoundaryLabel_Internal(newdm, newds, field, bd, label);CHKERRQ(ierr);
5891783e2ec8SMatthew G. Knepley     }
5892e5e52638SMatthew G. Knepley   }
5893e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5894e5e52638SMatthew G. Knepley }
5895e5e52638SMatthew G. Knepley 
5896e5e52638SMatthew G. Knepley /*@
5897e5e52638SMatthew G. Knepley   DMCopyDisc - Copy the fields and discrete systems for the DM into another DM
5898e5e52638SMatthew G. Knepley 
5899d083f849SBarry Smith   Collective on dm
5900e5e52638SMatthew G. Knepley 
5901e5e52638SMatthew G. Knepley   Input Parameter:
5902e5e52638SMatthew G. Knepley . dm - The DM
5903e5e52638SMatthew G. Knepley 
5904e5e52638SMatthew G. Knepley   Output Parameter:
5905e5e52638SMatthew G. Knepley . newdm - The DM
5906e5e52638SMatthew G. Knepley 
5907e5e52638SMatthew G. Knepley   Level: advanced
5908e5e52638SMatthew G. Knepley 
5909e5e52638SMatthew G. Knepley .seealso: DMCopyFields(), DMCopyDS()
5910e5e52638SMatthew G. Knepley @*/
5911e5e52638SMatthew G. Knepley PetscErrorCode DMCopyDisc(DM dm, DM newdm)
5912e5e52638SMatthew G. Knepley {
5913e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5914e5e52638SMatthew G. Knepley 
5915e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5916e5e52638SMatthew G. Knepley   ierr = DMCopyFields(dm, newdm);CHKERRQ(ierr);
5917e5e52638SMatthew G. Knepley   ierr = DMCopyDS(dm, newdm);CHKERRQ(ierr);
5918e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5919e5e52638SMatthew G. Knepley }
5920e5e52638SMatthew G. Knepley 
5921b64e0483SPeter Brune PetscErrorCode DMRestrictHook_Coordinates(DM dm,DM dmc,void *ctx)
5922b64e0483SPeter Brune {
5923b64e0483SPeter Brune   DM dm_coord,dmc_coord;
5924b64e0483SPeter Brune   PetscErrorCode ierr;
5925b64e0483SPeter Brune   Vec coords,ccoords;
59266dbf9973SLawrence Mitchell   Mat inject;
5927b64e0483SPeter Brune   PetscFunctionBegin;
5928b64e0483SPeter Brune   ierr = DMGetCoordinateDM(dm,&dm_coord);CHKERRQ(ierr);
5929b64e0483SPeter Brune   ierr = DMGetCoordinateDM(dmc,&dmc_coord);CHKERRQ(ierr);
5930b64e0483SPeter Brune   ierr = DMGetCoordinates(dm,&coords);CHKERRQ(ierr);
5931b64e0483SPeter Brune   ierr = DMGetCoordinates(dmc,&ccoords);CHKERRQ(ierr);
5932b64e0483SPeter Brune   if (coords && !ccoords) {
5933b64e0483SPeter Brune     ierr = DMCreateGlobalVector(dmc_coord,&ccoords);CHKERRQ(ierr);
59346668ed41SLisandro Dalcin     ierr = PetscObjectSetName((PetscObject)ccoords,"coordinates");CHKERRQ(ierr);
59356dbf9973SLawrence Mitchell     ierr = DMCreateInjection(dmc_coord,dm_coord,&inject);CHKERRQ(ierr);
59362adcf181SLawrence Mitchell     ierr = MatRestrict(inject,coords,ccoords);CHKERRQ(ierr);
59376dbf9973SLawrence Mitchell     ierr = MatDestroy(&inject);CHKERRQ(ierr);
5938b64e0483SPeter Brune     ierr = DMSetCoordinates(dmc,ccoords);CHKERRQ(ierr);
5939b64e0483SPeter Brune     ierr = VecDestroy(&ccoords);CHKERRQ(ierr);
5940b64e0483SPeter Brune   }
5941b64e0483SPeter Brune   PetscFunctionReturn(0);
5942b64e0483SPeter Brune }
5943b64e0483SPeter Brune 
594403dadc2fSPeter Brune static PetscErrorCode DMSubDomainHook_Coordinates(DM dm,DM subdm,void *ctx)
594503dadc2fSPeter Brune {
594603dadc2fSPeter Brune   DM dm_coord,subdm_coord;
594703dadc2fSPeter Brune   PetscErrorCode ierr;
594803dadc2fSPeter Brune   Vec coords,ccoords,clcoords;
594903dadc2fSPeter Brune   VecScatter *scat_i,*scat_g;
595003dadc2fSPeter Brune   PetscFunctionBegin;
595103dadc2fSPeter Brune   ierr = DMGetCoordinateDM(dm,&dm_coord);CHKERRQ(ierr);
595203dadc2fSPeter Brune   ierr = DMGetCoordinateDM(subdm,&subdm_coord);CHKERRQ(ierr);
595303dadc2fSPeter Brune   ierr = DMGetCoordinates(dm,&coords);CHKERRQ(ierr);
595403dadc2fSPeter Brune   ierr = DMGetCoordinates(subdm,&ccoords);CHKERRQ(ierr);
595503dadc2fSPeter Brune   if (coords && !ccoords) {
595603dadc2fSPeter Brune     ierr = DMCreateGlobalVector(subdm_coord,&ccoords);CHKERRQ(ierr);
59576668ed41SLisandro Dalcin     ierr = PetscObjectSetName((PetscObject)ccoords,"coordinates");CHKERRQ(ierr);
595803dadc2fSPeter Brune     ierr = DMCreateLocalVector(subdm_coord,&clcoords);CHKERRQ(ierr);
595924640c55SToby Isaac     ierr = PetscObjectSetName((PetscObject)clcoords,"coordinates");CHKERRQ(ierr);
596003dadc2fSPeter Brune     ierr = DMCreateDomainDecompositionScatters(dm_coord,1,&subdm_coord,NULL,&scat_i,&scat_g);CHKERRQ(ierr);
596103dadc2fSPeter Brune     ierr = VecScatterBegin(scat_i[0],coords,ccoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
596203dadc2fSPeter Brune     ierr = VecScatterEnd(scat_i[0],coords,ccoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
59631ed9ada7SJunchao Zhang     ierr = VecScatterBegin(scat_g[0],coords,clcoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
596403dadc2fSPeter Brune     ierr = VecScatterEnd(scat_g[0],coords,clcoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
596503dadc2fSPeter Brune     ierr = DMSetCoordinates(subdm,ccoords);CHKERRQ(ierr);
596603dadc2fSPeter Brune     ierr = DMSetCoordinatesLocal(subdm,clcoords);CHKERRQ(ierr);
596703dadc2fSPeter Brune     ierr = VecScatterDestroy(&scat_i[0]);CHKERRQ(ierr);
596803dadc2fSPeter Brune     ierr = VecScatterDestroy(&scat_g[0]);CHKERRQ(ierr);
596903dadc2fSPeter Brune     ierr = VecDestroy(&ccoords);CHKERRQ(ierr);
597003dadc2fSPeter Brune     ierr = VecDestroy(&clcoords);CHKERRQ(ierr);
597103dadc2fSPeter Brune     ierr = PetscFree(scat_i);CHKERRQ(ierr);
597203dadc2fSPeter Brune     ierr = PetscFree(scat_g);CHKERRQ(ierr);
597303dadc2fSPeter Brune   }
597403dadc2fSPeter Brune   PetscFunctionReturn(0);
597503dadc2fSPeter Brune }
597603dadc2fSPeter Brune 
5977c73cfb54SMatthew G. Knepley /*@
5978c73cfb54SMatthew G. Knepley   DMGetDimension - Return the topological dimension of the DM
5979c73cfb54SMatthew G. Knepley 
5980c73cfb54SMatthew G. Knepley   Not collective
5981c73cfb54SMatthew G. Knepley 
5982c73cfb54SMatthew G. Knepley   Input Parameter:
5983c73cfb54SMatthew G. Knepley . dm - The DM
5984c73cfb54SMatthew G. Knepley 
5985c73cfb54SMatthew G. Knepley   Output Parameter:
5986c73cfb54SMatthew G. Knepley . dim - The topological dimension
5987c73cfb54SMatthew G. Knepley 
5988c73cfb54SMatthew G. Knepley   Level: beginner
5989c73cfb54SMatthew G. Knepley 
5990c73cfb54SMatthew G. Knepley .seealso: DMSetDimension(), DMCreate()
5991c73cfb54SMatthew G. Knepley @*/
5992c73cfb54SMatthew G. Knepley PetscErrorCode DMGetDimension(DM dm, PetscInt *dim)
5993c73cfb54SMatthew G. Knepley {
5994c73cfb54SMatthew G. Knepley   PetscFunctionBegin;
5995c73cfb54SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5996534a8f05SLisandro Dalcin   PetscValidIntPointer(dim, 2);
5997c73cfb54SMatthew G. Knepley   *dim = dm->dim;
5998c73cfb54SMatthew G. Knepley   PetscFunctionReturn(0);
5999c73cfb54SMatthew G. Knepley }
6000c73cfb54SMatthew G. Knepley 
6001c73cfb54SMatthew G. Knepley /*@
6002c73cfb54SMatthew G. Knepley   DMSetDimension - Set the topological dimension of the DM
6003c73cfb54SMatthew G. Knepley 
6004c73cfb54SMatthew G. Knepley   Collective on dm
6005c73cfb54SMatthew G. Knepley 
6006c73cfb54SMatthew G. Knepley   Input Parameters:
6007c73cfb54SMatthew G. Knepley + dm - The DM
6008c73cfb54SMatthew G. Knepley - dim - The topological dimension
6009c73cfb54SMatthew G. Knepley 
6010c73cfb54SMatthew G. Knepley   Level: beginner
6011c73cfb54SMatthew G. Knepley 
6012c73cfb54SMatthew G. Knepley .seealso: DMGetDimension(), DMCreate()
6013c73cfb54SMatthew G. Knepley @*/
6014c73cfb54SMatthew G. Knepley PetscErrorCode DMSetDimension(DM dm, PetscInt dim)
6015c73cfb54SMatthew G. Knepley {
6016e5e52638SMatthew G. Knepley   PetscDS        ds;
601745480ffeSMatthew G. Knepley   PetscInt       Nds, n;
6018f17e8794SMatthew G. Knepley   PetscErrorCode ierr;
6019f17e8794SMatthew G. Knepley 
6020c73cfb54SMatthew G. Knepley   PetscFunctionBegin;
6021c73cfb54SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6022c73cfb54SMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, dim, 2);
6023c73cfb54SMatthew G. Knepley   dm->dim = dim;
602445480ffeSMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
602545480ffeSMatthew G. Knepley   for (n = 0; n < Nds; ++n) {
602645480ffeSMatthew G. Knepley     ierr = DMGetRegionNumDS(dm, n, NULL, NULL, &ds);CHKERRQ(ierr);
602745480ffeSMatthew G. Knepley     if (ds->dimEmbed < 0) {ierr = PetscDSSetCoordinateDimension(ds, dim);CHKERRQ(ierr);}
602845480ffeSMatthew G. Knepley   }
6029c73cfb54SMatthew G. Knepley   PetscFunctionReturn(0);
6030c73cfb54SMatthew G. Knepley }
6031c73cfb54SMatthew G. Knepley 
6032793f3fe5SMatthew G. Knepley /*@
6033793f3fe5SMatthew G. Knepley   DMGetDimPoints - Get the half-open interval for all points of a given dimension
6034793f3fe5SMatthew G. Knepley 
6035d083f849SBarry Smith   Collective on dm
6036793f3fe5SMatthew G. Knepley 
6037793f3fe5SMatthew G. Knepley   Input Parameters:
6038793f3fe5SMatthew G. Knepley + dm - the DM
6039793f3fe5SMatthew G. Knepley - dim - the dimension
6040793f3fe5SMatthew G. Knepley 
6041793f3fe5SMatthew G. Knepley   Output Parameters:
6042793f3fe5SMatthew G. Knepley + pStart - The first point of the given dimension
6043aa049354SPatrick Sanan - pEnd - The first point following points of the given dimension
6044793f3fe5SMatthew G. Knepley 
6045793f3fe5SMatthew G. Knepley   Note:
6046793f3fe5SMatthew G. Knepley   The points are vertices in the Hasse diagram encoding the topology. This is explained in
6047a8d69d7bSBarry Smith   https://arxiv.org/abs/0908.4427. If no points exist of this dimension in the storage scheme,
6048793f3fe5SMatthew G. Knepley   then the interval is empty.
6049793f3fe5SMatthew G. Knepley 
6050793f3fe5SMatthew G. Knepley   Level: intermediate
6051793f3fe5SMatthew G. Knepley 
6052793f3fe5SMatthew G. Knepley .seealso: DMPLEX, DMPlexGetDepthStratum(), DMPlexGetHeightStratum()
6053793f3fe5SMatthew G. Knepley @*/
6054793f3fe5SMatthew G. Knepley PetscErrorCode DMGetDimPoints(DM dm, PetscInt dim, PetscInt *pStart, PetscInt *pEnd)
6055793f3fe5SMatthew G. Knepley {
6056793f3fe5SMatthew G. Knepley   PetscInt       d;
6057793f3fe5SMatthew G. Knepley   PetscErrorCode ierr;
6058793f3fe5SMatthew G. Knepley 
6059793f3fe5SMatthew G. Knepley   PetscFunctionBegin;
6060793f3fe5SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6061793f3fe5SMatthew G. Knepley   ierr = DMGetDimension(dm, &d);CHKERRQ(ierr);
6062793f3fe5SMatthew G. Knepley   if ((dim < 0) || (dim > d)) SETERRQ2(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid dimension %d 1", dim, d);
6063b9d85ea2SLisandro Dalcin   if (!dm->ops->getdimpoints) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "DM type %s does not implement DMGetDimPoints",((PetscObject)dm)->type_name);
6064793f3fe5SMatthew G. Knepley   ierr = (*dm->ops->getdimpoints)(dm, dim, pStart, pEnd);CHKERRQ(ierr);
6065793f3fe5SMatthew G. Knepley   PetscFunctionReturn(0);
6066793f3fe5SMatthew G. Knepley }
6067793f3fe5SMatthew G. Knepley 
60686636e97aSMatthew G Knepley /*@
60696636e97aSMatthew G Knepley   DMSetCoordinates - Sets into the DM a global vector that holds the coordinates
60706636e97aSMatthew G Knepley 
6071d083f849SBarry Smith   Collective on dm
60726636e97aSMatthew G Knepley 
60736636e97aSMatthew G Knepley   Input Parameters:
60746636e97aSMatthew G Knepley + dm - the DM
60756636e97aSMatthew G Knepley - c - coordinate vector
60766636e97aSMatthew G Knepley 
60772dd40e9bSPatrick Sanan   Notes:
60782dd40e9bSPatrick Sanan   The coordinates do include those for ghost points, which are in the local vector.
60792dd40e9bSPatrick Sanan 
60802dd40e9bSPatrick Sanan   The vector c should be destroyed by the caller.
60816636e97aSMatthew G Knepley 
60826636e97aSMatthew G Knepley   Level: intermediate
60836636e97aSMatthew G Knepley 
608460c22052SBarry Smith .seealso: DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM(), DMDASetUniformCoordinates()
60856636e97aSMatthew G Knepley @*/
60866636e97aSMatthew G Knepley PetscErrorCode DMSetCoordinates(DM dm, Vec c)
60876636e97aSMatthew G Knepley {
60886636e97aSMatthew G Knepley   PetscErrorCode ierr;
60896636e97aSMatthew G Knepley 
60906636e97aSMatthew G Knepley   PetscFunctionBegin;
60916636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
60926636e97aSMatthew G Knepley   PetscValidHeaderSpecific(c,VEC_CLASSID,2);
60936636e97aSMatthew G Knepley   ierr            = PetscObjectReference((PetscObject) c);CHKERRQ(ierr);
60946636e97aSMatthew G Knepley   ierr            = VecDestroy(&dm->coordinates);CHKERRQ(ierr);
60956636e97aSMatthew G Knepley   dm->coordinates = c;
60966636e97aSMatthew G Knepley   ierr            = VecDestroy(&dm->coordinatesLocal);CHKERRQ(ierr);
6097b64e0483SPeter Brune   ierr            = DMCoarsenHookAdd(dm,DMRestrictHook_Coordinates,NULL,NULL);CHKERRQ(ierr);
609803dadc2fSPeter Brune   ierr            = DMSubDomainHookAdd(dm,DMSubDomainHook_Coordinates,NULL,NULL);CHKERRQ(ierr);
60996636e97aSMatthew G Knepley   PetscFunctionReturn(0);
61006636e97aSMatthew G Knepley }
61016636e97aSMatthew G Knepley 
61026636e97aSMatthew G Knepley /*@
61036636e97aSMatthew G Knepley   DMSetCoordinatesLocal - Sets into the DM a local vector that holds the coordinates
61046636e97aSMatthew G Knepley 
61057058e716SVaclav Hapla   Not collective
61066636e97aSMatthew G Knepley 
61076636e97aSMatthew G Knepley    Input Parameters:
61086636e97aSMatthew G Knepley +  dm - the DM
61096636e97aSMatthew G Knepley -  c - coordinate vector
61106636e97aSMatthew G Knepley 
61112dd40e9bSPatrick Sanan   Notes:
61126636e97aSMatthew G Knepley   The coordinates of ghost points can be set using DMSetCoordinates()
61136636e97aSMatthew G Knepley   followed by DMGetCoordinatesLocal(). This is intended to enable the
61146636e97aSMatthew G Knepley   setting of ghost coordinates outside of the domain.
61156636e97aSMatthew G Knepley 
61162dd40e9bSPatrick Sanan   The vector c should be destroyed by the caller.
61172dd40e9bSPatrick Sanan 
61186636e97aSMatthew G Knepley   Level: intermediate
61196636e97aSMatthew G Knepley 
61206636e97aSMatthew G Knepley .seealso: DMGetCoordinatesLocal(), DMSetCoordinates(), DMGetCoordinates(), DMGetCoordinateDM()
61216636e97aSMatthew G Knepley @*/
61226636e97aSMatthew G Knepley PetscErrorCode DMSetCoordinatesLocal(DM dm, Vec c)
61236636e97aSMatthew G Knepley {
61246636e97aSMatthew G Knepley   PetscErrorCode ierr;
61256636e97aSMatthew G Knepley 
61266636e97aSMatthew G Knepley   PetscFunctionBegin;
61276636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
61286636e97aSMatthew G Knepley   PetscValidHeaderSpecific(c,VEC_CLASSID,2);
61296636e97aSMatthew G Knepley   ierr = PetscObjectReference((PetscObject) c);CHKERRQ(ierr);
61306636e97aSMatthew G Knepley   ierr = VecDestroy(&dm->coordinatesLocal);CHKERRQ(ierr);
61318865f1eaSKarl Rupp 
61326636e97aSMatthew G Knepley   dm->coordinatesLocal = c;
61338865f1eaSKarl Rupp 
61346636e97aSMatthew G Knepley   ierr = VecDestroy(&dm->coordinates);CHKERRQ(ierr);
61356636e97aSMatthew G Knepley   PetscFunctionReturn(0);
61366636e97aSMatthew G Knepley }
61376636e97aSMatthew G Knepley 
61386636e97aSMatthew G Knepley /*@
61396636e97aSMatthew G Knepley   DMGetCoordinates - Gets a global vector with the coordinates associated with the DM.
61406636e97aSMatthew G Knepley 
6141d083f849SBarry Smith   Collective on dm
61426636e97aSMatthew G Knepley 
61436636e97aSMatthew G Knepley   Input Parameter:
61446636e97aSMatthew G Knepley . dm - the DM
61456636e97aSMatthew G Knepley 
61466636e97aSMatthew G Knepley   Output Parameter:
61476636e97aSMatthew G Knepley . c - global coordinate vector
61486636e97aSMatthew G Knepley 
61496636e97aSMatthew G Knepley   Note:
615060c22052SBarry Smith   This is a borrowed reference, so the user should NOT destroy this vector. When the DM is
615160c22052SBarry Smith   destroyed the array will no longer be valid.
61526636e97aSMatthew G Knepley 
6153959c7569SPatrick Sanan   Each process has only the locally-owned portion of the global coordinates (does NOT have the ghost coordinates).
61546636e97aSMatthew G Knepley 
61556636e97aSMatthew G Knepley   For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...)
61566636e97aSMatthew G Knepley   and (x_0,y_0,z_0,x_1,y_1,z_1...)
61576636e97aSMatthew G Knepley 
61586636e97aSMatthew G Knepley   Level: intermediate
61596636e97aSMatthew G Knepley 
616060c22052SBarry Smith .seealso: DMSetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM(), DMDASetUniformCoordinates()
61616636e97aSMatthew G Knepley @*/
61626636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinates(DM dm, Vec *c)
61636636e97aSMatthew G Knepley {
61646636e97aSMatthew G Knepley   PetscErrorCode ierr;
61656636e97aSMatthew G Knepley 
61666636e97aSMatthew G Knepley   PetscFunctionBegin;
61676636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
61686636e97aSMatthew G Knepley   PetscValidPointer(c,2);
61691f588964SMatthew G Knepley   if (!dm->coordinates && dm->coordinatesLocal) {
61700298fd71SBarry Smith     DM        cdm = NULL;
61711970a576SMatthew G. Knepley     PetscBool localized;
61726636e97aSMatthew G Knepley 
61736636e97aSMatthew G Knepley     ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
61746636e97aSMatthew G Knepley     ierr = DMCreateGlobalVector(cdm, &dm->coordinates);CHKERRQ(ierr);
61751970a576SMatthew G. Knepley     ierr = DMGetCoordinatesLocalized(dm, &localized);CHKERRQ(ierr);
61761970a576SMatthew G. Knepley     /* Block size is not correctly set by CreateGlobalVector() if coordinates are localized */
61771970a576SMatthew G. Knepley     if (localized) {
61781970a576SMatthew G. Knepley       PetscInt cdim;
61791970a576SMatthew G. Knepley 
61801970a576SMatthew G. Knepley       ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
61811970a576SMatthew G. Knepley       ierr = VecSetBlockSize(dm->coordinates, cdim);CHKERRQ(ierr);
61821970a576SMatthew G. Knepley     }
61836636e97aSMatthew G Knepley     ierr = PetscObjectSetName((PetscObject) dm->coordinates, "coordinates");CHKERRQ(ierr);
61846636e97aSMatthew G Knepley     ierr = DMLocalToGlobalBegin(cdm, dm->coordinatesLocal, INSERT_VALUES, dm->coordinates);CHKERRQ(ierr);
61856636e97aSMatthew G Knepley     ierr = DMLocalToGlobalEnd(cdm, dm->coordinatesLocal, INSERT_VALUES, dm->coordinates);CHKERRQ(ierr);
61866636e97aSMatthew G Knepley   }
61876636e97aSMatthew G Knepley   *c = dm->coordinates;
61886636e97aSMatthew G Knepley   PetscFunctionReturn(0);
61896636e97aSMatthew G Knepley }
61906636e97aSMatthew G Knepley 
61916636e97aSMatthew G Knepley /*@
619281e9a530SVaclav Hapla   DMGetCoordinatesLocalSetUp - Prepares a local vector of coordinates, so that DMGetCoordinatesLocalNoncollective() can be used as non-collective afterwards.
619381e9a530SVaclav Hapla 
6194d083f849SBarry Smith   Collective on dm
619581e9a530SVaclav Hapla 
619681e9a530SVaclav Hapla   Input Parameter:
619781e9a530SVaclav Hapla . dm - the DM
619881e9a530SVaclav Hapla 
619981e9a530SVaclav Hapla   Level: advanced
620081e9a530SVaclav Hapla 
620181e9a530SVaclav Hapla .seealso: DMGetCoordinatesLocalNoncollective()
620281e9a530SVaclav Hapla @*/
620381e9a530SVaclav Hapla PetscErrorCode DMGetCoordinatesLocalSetUp(DM dm)
620481e9a530SVaclav Hapla {
620581e9a530SVaclav Hapla   PetscErrorCode ierr;
620681e9a530SVaclav Hapla 
620781e9a530SVaclav Hapla   PetscFunctionBegin;
620881e9a530SVaclav Hapla   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
620981e9a530SVaclav Hapla   if (!dm->coordinatesLocal && dm->coordinates) {
62101970a576SMatthew G. Knepley     DM        cdm = NULL;
62111970a576SMatthew G. Knepley     PetscBool localized;
62121970a576SMatthew G. Knepley 
621381e9a530SVaclav Hapla     ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
621481e9a530SVaclav Hapla     ierr = DMCreateLocalVector(cdm, &dm->coordinatesLocal);CHKERRQ(ierr);
62151970a576SMatthew G. Knepley     ierr = DMGetCoordinatesLocalized(dm, &localized);CHKERRQ(ierr);
62161970a576SMatthew G. Knepley     /* Block size is not correctly set by CreateLocalVector() if coordinates are localized */
62171970a576SMatthew G. Knepley     if (localized) {
62181970a576SMatthew G. Knepley       PetscInt cdim;
62191970a576SMatthew G. Knepley 
62201970a576SMatthew G. Knepley       ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
62211970a576SMatthew G. Knepley       ierr = VecSetBlockSize(dm->coordinates, cdim);CHKERRQ(ierr);
62221970a576SMatthew G. Knepley     }
622381e9a530SVaclav Hapla     ierr = PetscObjectSetName((PetscObject) dm->coordinatesLocal, "coordinates");CHKERRQ(ierr);
622481e9a530SVaclav Hapla     ierr = DMGlobalToLocalBegin(cdm, dm->coordinates, INSERT_VALUES, dm->coordinatesLocal);CHKERRQ(ierr);
622581e9a530SVaclav Hapla     ierr = DMGlobalToLocalEnd(cdm, dm->coordinates, INSERT_VALUES, dm->coordinatesLocal);CHKERRQ(ierr);
622681e9a530SVaclav Hapla   }
622781e9a530SVaclav Hapla   PetscFunctionReturn(0);
622881e9a530SVaclav Hapla }
622981e9a530SVaclav Hapla 
623081e9a530SVaclav Hapla /*@
62316636e97aSMatthew G Knepley   DMGetCoordinatesLocal - Gets a local vector with the coordinates associated with the DM.
62326636e97aSMatthew G Knepley 
6233d083f849SBarry Smith   Collective on dm
62346636e97aSMatthew G Knepley 
62356636e97aSMatthew G Knepley   Input Parameter:
62366636e97aSMatthew G Knepley . dm - the DM
62376636e97aSMatthew G Knepley 
62386636e97aSMatthew G Knepley   Output Parameter:
62396636e97aSMatthew G Knepley . c - coordinate vector
62406636e97aSMatthew G Knepley 
62416636e97aSMatthew G Knepley   Note:
62426636e97aSMatthew G Knepley   This is a borrowed reference, so the user should NOT destroy this vector
62436636e97aSMatthew G Knepley 
62446636e97aSMatthew G Knepley   Each process has the local and ghost coordinates
62456636e97aSMatthew G Knepley 
62466636e97aSMatthew G Knepley   For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...)
62476636e97aSMatthew G Knepley   and (x_0,y_0,z_0,x_1,y_1,z_1...)
62486636e97aSMatthew G Knepley 
62496636e97aSMatthew G Knepley   Level: intermediate
62506636e97aSMatthew G Knepley 
625181e9a530SVaclav Hapla .seealso: DMSetCoordinatesLocal(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM(), DMGetCoordinatesLocalNoncollective()
62526636e97aSMatthew G Knepley @*/
62536636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinatesLocal(DM dm, Vec *c)
62546636e97aSMatthew G Knepley {
62556636e97aSMatthew G Knepley   PetscErrorCode ierr;
62566636e97aSMatthew G Knepley 
62576636e97aSMatthew G Knepley   PetscFunctionBegin;
62586636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
62596636e97aSMatthew G Knepley   PetscValidPointer(c,2);
626081e9a530SVaclav Hapla   ierr = DMGetCoordinatesLocalSetUp(dm);CHKERRQ(ierr);
62616636e97aSMatthew G Knepley   *c = dm->coordinatesLocal;
62626636e97aSMatthew G Knepley   PetscFunctionReturn(0);
62636636e97aSMatthew G Knepley }
62646636e97aSMatthew G Knepley 
626581e9a530SVaclav Hapla /*@
626681e9a530SVaclav Hapla   DMGetCoordinatesLocalNoncollective - Non-collective version of DMGetCoordinatesLocal(). Fails if global coordinates have been set and DMGetCoordinatesLocalSetUp() not called.
626781e9a530SVaclav Hapla 
626881e9a530SVaclav Hapla   Not collective
626981e9a530SVaclav Hapla 
627081e9a530SVaclav Hapla   Input Parameter:
627181e9a530SVaclav Hapla . dm - the DM
627281e9a530SVaclav Hapla 
627381e9a530SVaclav Hapla   Output Parameter:
627481e9a530SVaclav Hapla . c - coordinate vector
627581e9a530SVaclav Hapla 
627681e9a530SVaclav Hapla   Level: advanced
627781e9a530SVaclav Hapla 
627881e9a530SVaclav Hapla .seealso: DMGetCoordinatesLocalSetUp(), DMGetCoordinatesLocal(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM()
627981e9a530SVaclav Hapla @*/
628081e9a530SVaclav Hapla PetscErrorCode DMGetCoordinatesLocalNoncollective(DM dm, Vec *c)
628181e9a530SVaclav Hapla {
628281e9a530SVaclav Hapla   PetscFunctionBegin;
628381e9a530SVaclav Hapla   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
628481e9a530SVaclav Hapla   PetscValidPointer(c,2);
628581e9a530SVaclav Hapla   if (!dm->coordinatesLocal && dm->coordinates) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DMGetCoordinatesLocalSetUp() has not been called");
62866636e97aSMatthew G Knepley   *c = dm->coordinatesLocal;
62876636e97aSMatthew G Knepley   PetscFunctionReturn(0);
62886636e97aSMatthew G Knepley }
62896636e97aSMatthew G Knepley 
62902db98f8dSVaclav Hapla /*@
62912db98f8dSVaclav Hapla   DMGetCoordinatesLocalTuple - Gets a local vector with the coordinates of specified points and section describing its layout.
62922db98f8dSVaclav Hapla 
62932db98f8dSVaclav Hapla   Not collective
62942db98f8dSVaclav Hapla 
62952db98f8dSVaclav Hapla   Input Parameter:
62962db98f8dSVaclav Hapla + dm - the DM
62972db98f8dSVaclav Hapla - p - the IS of points whose coordinates will be returned
62982db98f8dSVaclav Hapla 
62992db98f8dSVaclav Hapla   Output Parameter:
63002db98f8dSVaclav Hapla + pCoordSection - the PetscSection describing the layout of pCoord, i.e. each point corresponds to one point in p, and DOFs correspond to coordinates
63012db98f8dSVaclav Hapla - pCoord - the Vec with coordinates of points in p
63022db98f8dSVaclav Hapla 
63032db98f8dSVaclav Hapla   Note:
63042db98f8dSVaclav Hapla   DMGetCoordinatesLocalSetUp() must be called first. This function employs DMGetCoordinatesLocalNoncollective() so it is not collective.
63052db98f8dSVaclav Hapla 
63062db98f8dSVaclav Hapla   This creates a new vector, so the user SHOULD destroy this vector
63072db98f8dSVaclav Hapla 
63082db98f8dSVaclav Hapla   Each process has the local and ghost coordinates
63092db98f8dSVaclav Hapla 
63102db98f8dSVaclav Hapla   For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...)
63112db98f8dSVaclav Hapla   and (x_0,y_0,z_0,x_1,y_1,z_1...)
63122db98f8dSVaclav Hapla 
63132db98f8dSVaclav Hapla   Level: advanced
63142db98f8dSVaclav Hapla 
63152db98f8dSVaclav Hapla .seealso: DMSetCoordinatesLocal(), DMGetCoordinatesLocal(), DMGetCoordinatesLocalNoncollective(), DMGetCoordinatesLocalSetUp(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM()
63162db98f8dSVaclav Hapla @*/
63172db98f8dSVaclav Hapla PetscErrorCode DMGetCoordinatesLocalTuple(DM dm, IS p, PetscSection *pCoordSection, Vec *pCoord)
63182db98f8dSVaclav Hapla {
63192db98f8dSVaclav Hapla   PetscSection        cs, newcs;
63202db98f8dSVaclav Hapla   Vec                 coords;
63212db98f8dSVaclav Hapla   const PetscScalar   *arr;
63222db98f8dSVaclav Hapla   PetscScalar         *newarr=NULL;
63232db98f8dSVaclav Hapla   PetscInt            n;
63242db98f8dSVaclav Hapla   PetscErrorCode      ierr;
63252db98f8dSVaclav Hapla 
63262db98f8dSVaclav Hapla   PetscFunctionBegin;
63272db98f8dSVaclav Hapla   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
63282db98f8dSVaclav Hapla   PetscValidHeaderSpecific(p, IS_CLASSID, 2);
63292db98f8dSVaclav Hapla   if (pCoordSection) PetscValidPointer(pCoordSection, 3);
63302db98f8dSVaclav Hapla   if (pCoord) PetscValidPointer(pCoord, 4);
63312db98f8dSVaclav Hapla   if (!dm->coordinatesLocal) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DMGetCoordinatesLocalSetUp() has not been called or coordinates not set");
63321bb6d2a8SBarry Smith   if (!dm->coordinateDM || !dm->coordinateDM->localSection) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DM not supported");
63331bb6d2a8SBarry Smith   cs = dm->coordinateDM->localSection;
63342db98f8dSVaclav Hapla   coords = dm->coordinatesLocal;
63352db98f8dSVaclav Hapla   ierr = VecGetArrayRead(coords, &arr);CHKERRQ(ierr);
63362db98f8dSVaclav Hapla   ierr = PetscSectionExtractDofsFromArray(cs, MPIU_SCALAR, arr, p, &newcs, pCoord ? ((void**)&newarr) : NULL);CHKERRQ(ierr);
63372db98f8dSVaclav Hapla   ierr = VecRestoreArrayRead(coords, &arr);CHKERRQ(ierr);
63382db98f8dSVaclav Hapla   if (pCoord) {
63392db98f8dSVaclav Hapla     ierr = PetscSectionGetStorageSize(newcs, &n);CHKERRQ(ierr);
63402db98f8dSVaclav Hapla     /* set array in two steps to mimic PETSC_OWN_POINTER */
63412db98f8dSVaclav Hapla     ierr = VecCreateSeqWithArray(PetscObjectComm((PetscObject)p), 1, n, NULL, pCoord);CHKERRQ(ierr);
63422db98f8dSVaclav Hapla     ierr = VecReplaceArray(*pCoord, newarr);CHKERRQ(ierr);
6343ad9ac99dSVaclav Hapla   } else {
6344ad9ac99dSVaclav Hapla     ierr = PetscFree(newarr);CHKERRQ(ierr);
63452db98f8dSVaclav Hapla   }
6346ad9ac99dSVaclav Hapla   if (pCoordSection) {*pCoordSection = newcs;}
6347ad9ac99dSVaclav Hapla   else               {ierr = PetscSectionDestroy(&newcs);CHKERRQ(ierr);}
63482db98f8dSVaclav Hapla   PetscFunctionReturn(0);
63492db98f8dSVaclav Hapla }
63502db98f8dSVaclav Hapla 
6351f19dbd58SToby Isaac PetscErrorCode DMGetCoordinateField(DM dm, DMField *field)
6352f19dbd58SToby Isaac {
6353f19dbd58SToby Isaac   PetscErrorCode ierr;
6354f19dbd58SToby Isaac 
6355f19dbd58SToby Isaac   PetscFunctionBegin;
6356f19dbd58SToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6357f19dbd58SToby Isaac   PetscValidPointer(field,2);
6358f19dbd58SToby Isaac   if (!dm->coordinateField) {
6359f19dbd58SToby Isaac     if (dm->ops->createcoordinatefield) {
6360f19dbd58SToby Isaac       ierr = (*dm->ops->createcoordinatefield)(dm,&dm->coordinateField);CHKERRQ(ierr);
6361f19dbd58SToby Isaac     }
6362f19dbd58SToby Isaac   }
6363f19dbd58SToby Isaac   *field = dm->coordinateField;
6364f19dbd58SToby Isaac   PetscFunctionReturn(0);
6365f19dbd58SToby Isaac }
6366f19dbd58SToby Isaac 
6367f19dbd58SToby Isaac PetscErrorCode DMSetCoordinateField(DM dm, DMField field)
6368f19dbd58SToby Isaac {
6369f19dbd58SToby Isaac   PetscErrorCode ierr;
6370f19dbd58SToby Isaac 
6371f19dbd58SToby Isaac   PetscFunctionBegin;
6372f19dbd58SToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6373f19dbd58SToby Isaac   if (field) PetscValidHeaderSpecific(field,DMFIELD_CLASSID,2);
6374c4e6da2cSBarry Smith   ierr = PetscObjectReference((PetscObject)field);CHKERRQ(ierr);
6375f19dbd58SToby Isaac   ierr = DMFieldDestroy(&dm->coordinateField);CHKERRQ(ierr);
6376f19dbd58SToby Isaac   dm->coordinateField = field;
6377f19dbd58SToby Isaac   PetscFunctionReturn(0);
6378f19dbd58SToby Isaac }
6379f19dbd58SToby Isaac 
63806636e97aSMatthew G Knepley /*@
63811cfe2091SMatthew G. Knepley   DMGetCoordinateDM - Gets the DM that prescribes coordinate layout and scatters between global and local coordinates
63826636e97aSMatthew G Knepley 
6383d083f849SBarry Smith   Collective on dm
63846636e97aSMatthew G Knepley 
63856636e97aSMatthew G Knepley   Input Parameter:
63866636e97aSMatthew G Knepley . dm - the DM
63876636e97aSMatthew G Knepley 
63886636e97aSMatthew G Knepley   Output Parameter:
63896636e97aSMatthew G Knepley . cdm - coordinate DM
63906636e97aSMatthew G Knepley 
63916636e97aSMatthew G Knepley   Level: intermediate
63926636e97aSMatthew G Knepley 
63931cfe2091SMatthew G. Knepley .seealso: DMSetCoordinateDM(), DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal()
63946636e97aSMatthew G Knepley @*/
63956636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinateDM(DM dm, DM *cdm)
63966636e97aSMatthew G Knepley {
63976636e97aSMatthew G Knepley   PetscErrorCode ierr;
63986636e97aSMatthew G Knepley 
63996636e97aSMatthew G Knepley   PetscFunctionBegin;
64006636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
64016636e97aSMatthew G Knepley   PetscValidPointer(cdm,2);
64026636e97aSMatthew G Knepley   if (!dm->coordinateDM) {
6403308f8a94SToby Isaac     DM cdm;
6404308f8a94SToby Isaac 
640582f516ccSBarry Smith     if (!dm->ops->createcoordinatedm) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Unable to create coordinates for this DM");
6406308f8a94SToby Isaac     ierr = (*dm->ops->createcoordinatedm)(dm, &cdm);CHKERRQ(ierr);
6407308f8a94SToby Isaac     /* Just in case the DM sets the coordinate DM when creating it (DMP4est can do this, because it may not setup
6408308f8a94SToby Isaac      * until the call to CreateCoordinateDM) */
6409308f8a94SToby Isaac     ierr = DMDestroy(&dm->coordinateDM);CHKERRQ(ierr);
6410308f8a94SToby Isaac     dm->coordinateDM = cdm;
64116636e97aSMatthew G Knepley   }
64126636e97aSMatthew G Knepley   *cdm = dm->coordinateDM;
64136636e97aSMatthew G Knepley   PetscFunctionReturn(0);
64146636e97aSMatthew G Knepley }
6415e87bb0d3SMatthew G Knepley 
64161cfe2091SMatthew G. Knepley /*@
64171cfe2091SMatthew G. Knepley   DMSetCoordinateDM - Sets the DM that prescribes coordinate layout and scatters between global and local coordinates
64181cfe2091SMatthew G. Knepley 
6419d083f849SBarry Smith   Logically Collective on dm
64201cfe2091SMatthew G. Knepley 
64211cfe2091SMatthew G. Knepley   Input Parameters:
64221cfe2091SMatthew G. Knepley + dm - the DM
64231cfe2091SMatthew G. Knepley - cdm - coordinate DM
64241cfe2091SMatthew G. Knepley 
64251cfe2091SMatthew G. Knepley   Level: intermediate
64261cfe2091SMatthew G. Knepley 
64271cfe2091SMatthew G. Knepley .seealso: DMGetCoordinateDM(), DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal()
64281cfe2091SMatthew G. Knepley @*/
64291cfe2091SMatthew G. Knepley PetscErrorCode DMSetCoordinateDM(DM dm, DM cdm)
64301cfe2091SMatthew G. Knepley {
64311cfe2091SMatthew G. Knepley   PetscErrorCode ierr;
64321cfe2091SMatthew G. Knepley 
64331cfe2091SMatthew G. Knepley   PetscFunctionBegin;
64341cfe2091SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
64351cfe2091SMatthew G. Knepley   PetscValidHeaderSpecific(cdm,DM_CLASSID,2);
6436f26b38b9SToby Isaac   ierr = PetscObjectReference((PetscObject)cdm);CHKERRQ(ierr);
64371cfe2091SMatthew G. Knepley   ierr = DMDestroy(&dm->coordinateDM);CHKERRQ(ierr);
64381cfe2091SMatthew G. Knepley   dm->coordinateDM = cdm;
64391cfe2091SMatthew G. Knepley   PetscFunctionReturn(0);
64401cfe2091SMatthew G. Knepley }
64411cfe2091SMatthew G. Knepley 
644246e270d4SMatthew G. Knepley /*@
644346e270d4SMatthew G. Knepley   DMGetCoordinateDim - Retrieve the dimension of embedding space for coordinate values.
644446e270d4SMatthew G. Knepley 
644546e270d4SMatthew G. Knepley   Not Collective
644646e270d4SMatthew G. Knepley 
644746e270d4SMatthew G. Knepley   Input Parameter:
644846e270d4SMatthew G. Knepley . dm - The DM object
644946e270d4SMatthew G. Knepley 
645046e270d4SMatthew G. Knepley   Output Parameter:
645146e270d4SMatthew G. Knepley . dim - The embedding dimension
645246e270d4SMatthew G. Knepley 
645346e270d4SMatthew G. Knepley   Level: intermediate
645446e270d4SMatthew G. Knepley 
645592fd8e1eSJed Brown .seealso: DMSetCoordinateDim(), DMGetCoordinateSection(), DMGetCoordinateDM(), DMGetLocalSection(), DMSetLocalSection()
645646e270d4SMatthew G. Knepley @*/
645746e270d4SMatthew G. Knepley PetscErrorCode DMGetCoordinateDim(DM dm, PetscInt *dim)
645846e270d4SMatthew G. Knepley {
645946e270d4SMatthew G. Knepley   PetscFunctionBegin;
646046e270d4SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6461534a8f05SLisandro Dalcin   PetscValidIntPointer(dim, 2);
64629a9a41abSToby Isaac   if (dm->dimEmbed == PETSC_DEFAULT) {
64639a9a41abSToby Isaac     dm->dimEmbed = dm->dim;
64649a9a41abSToby Isaac   }
646546e270d4SMatthew G. Knepley   *dim = dm->dimEmbed;
646646e270d4SMatthew G. Knepley   PetscFunctionReturn(0);
646746e270d4SMatthew G. Knepley }
646846e270d4SMatthew G. Knepley 
646946e270d4SMatthew G. Knepley /*@
647046e270d4SMatthew G. Knepley   DMSetCoordinateDim - Set the dimension of the embedding space for coordinate values.
647146e270d4SMatthew G. Knepley 
647246e270d4SMatthew G. Knepley   Not Collective
647346e270d4SMatthew G. Knepley 
647446e270d4SMatthew G. Knepley   Input Parameters:
647546e270d4SMatthew G. Knepley + dm  - The DM object
647646e270d4SMatthew G. Knepley - dim - The embedding dimension
647746e270d4SMatthew G. Knepley 
647846e270d4SMatthew G. Knepley   Level: intermediate
647946e270d4SMatthew G. Knepley 
648092fd8e1eSJed Brown .seealso: DMGetCoordinateDim(), DMSetCoordinateSection(), DMGetCoordinateSection(), DMGetLocalSection(), DMSetLocalSection()
648146e270d4SMatthew G. Knepley @*/
648246e270d4SMatthew G. Knepley PetscErrorCode DMSetCoordinateDim(DM dm, PetscInt dim)
648346e270d4SMatthew G. Knepley {
6484e5e52638SMatthew G. Knepley   PetscDS        ds;
648545480ffeSMatthew G. Knepley   PetscInt       Nds, n;
6486f17e8794SMatthew G. Knepley   PetscErrorCode ierr;
6487f17e8794SMatthew G. Knepley 
648846e270d4SMatthew G. Knepley   PetscFunctionBegin;
648946e270d4SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
649046e270d4SMatthew G. Knepley   dm->dimEmbed = dim;
649145480ffeSMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
649245480ffeSMatthew G. Knepley   for (n = 0; n < Nds; ++n) {
649345480ffeSMatthew G. Knepley     ierr = DMGetRegionNumDS(dm, n, NULL, NULL, &ds);CHKERRQ(ierr);
6494e5e52638SMatthew G. Knepley     ierr = PetscDSSetCoordinateDimension(ds, dim);CHKERRQ(ierr);
649545480ffeSMatthew G. Knepley   }
649646e270d4SMatthew G. Knepley   PetscFunctionReturn(0);
649746e270d4SMatthew G. Knepley }
649846e270d4SMatthew G. Knepley 
6499e8abe2deSMatthew G. Knepley /*@
6500e8abe2deSMatthew G. Knepley   DMGetCoordinateSection - Retrieve the layout of coordinate values over the mesh.
6501e8abe2deSMatthew G. Knepley 
6502d083f849SBarry Smith   Collective on dm
6503e8abe2deSMatthew G. Knepley 
6504e8abe2deSMatthew G. Knepley   Input Parameter:
6505e8abe2deSMatthew G. Knepley . dm - The DM object
6506e8abe2deSMatthew G. Knepley 
6507e8abe2deSMatthew G. Knepley   Output Parameter:
6508e8abe2deSMatthew G. Knepley . section - The PetscSection object
6509e8abe2deSMatthew G. Knepley 
6510e8abe2deSMatthew G. Knepley   Level: intermediate
6511e8abe2deSMatthew G. Knepley 
651292fd8e1eSJed Brown .seealso: DMGetCoordinateDM(), DMGetLocalSection(), DMSetLocalSection()
6513e8abe2deSMatthew G. Knepley @*/
6514e8abe2deSMatthew G. Knepley PetscErrorCode DMGetCoordinateSection(DM dm, PetscSection *section)
6515e8abe2deSMatthew G. Knepley {
6516e8abe2deSMatthew G. Knepley   DM             cdm;
6517e8abe2deSMatthew G. Knepley   PetscErrorCode ierr;
6518e8abe2deSMatthew G. Knepley 
6519e8abe2deSMatthew G. Knepley   PetscFunctionBegin;
6520e8abe2deSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6521e8abe2deSMatthew G. Knepley   PetscValidPointer(section, 2);
6522e8abe2deSMatthew G. Knepley   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
652392fd8e1eSJed Brown   ierr = DMGetLocalSection(cdm, section);CHKERRQ(ierr);
6524e8abe2deSMatthew G. Knepley   PetscFunctionReturn(0);
6525e8abe2deSMatthew G. Knepley }
6526e8abe2deSMatthew G. Knepley 
6527e8abe2deSMatthew G. Knepley /*@
6528e8abe2deSMatthew G. Knepley   DMSetCoordinateSection - Set the layout of coordinate values over the mesh.
6529e8abe2deSMatthew G. Knepley 
6530e8abe2deSMatthew G. Knepley   Not Collective
6531e8abe2deSMatthew G. Knepley 
6532e8abe2deSMatthew G. Knepley   Input Parameters:
6533e8abe2deSMatthew G. Knepley + dm      - The DM object
653446e270d4SMatthew G. Knepley . dim     - The embedding dimension, or PETSC_DETERMINE
6535e8abe2deSMatthew G. Knepley - section - The PetscSection object
6536e8abe2deSMatthew G. Knepley 
6537e8abe2deSMatthew G. Knepley   Level: intermediate
6538e8abe2deSMatthew G. Knepley 
653992fd8e1eSJed Brown .seealso: DMGetCoordinateSection(), DMGetLocalSection(), DMSetLocalSection()
6540e8abe2deSMatthew G. Knepley @*/
654146e270d4SMatthew G. Knepley PetscErrorCode DMSetCoordinateSection(DM dm, PetscInt dim, PetscSection section)
6542e8abe2deSMatthew G. Knepley {
6543e8abe2deSMatthew G. Knepley   DM             cdm;
6544e8abe2deSMatthew G. Knepley   PetscErrorCode ierr;
6545e8abe2deSMatthew G. Knepley 
6546e8abe2deSMatthew G. Knepley   PetscFunctionBegin;
6547e8abe2deSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
654846e270d4SMatthew G. Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,3);
6549e8abe2deSMatthew G. Knepley   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
655092fd8e1eSJed Brown   ierr = DMSetLocalSection(cdm, section);CHKERRQ(ierr);
655146e270d4SMatthew G. Knepley   if (dim == PETSC_DETERMINE) {
65524c1069a6SMatthew G. Knepley     PetscInt d = PETSC_DEFAULT;
655346e270d4SMatthew G. Knepley     PetscInt pStart, pEnd, vStart, vEnd, v, dd;
655446e270d4SMatthew G. Knepley 
655546e270d4SMatthew G. Knepley     ierr = PetscSectionGetChart(section, &pStart, &pEnd);CHKERRQ(ierr);
655646e270d4SMatthew G. Knepley     ierr = DMGetDimPoints(dm, 0, &vStart, &vEnd);CHKERRQ(ierr);
655746e270d4SMatthew G. Knepley     pStart = PetscMax(vStart, pStart);
655846e270d4SMatthew G. Knepley     pEnd   = PetscMin(vEnd, pEnd);
655946e270d4SMatthew G. Knepley     for (v = pStart; v < pEnd; ++v) {
656046e270d4SMatthew G. Knepley       ierr = PetscSectionGetDof(section, v, &dd);CHKERRQ(ierr);
656146e270d4SMatthew G. Knepley       if (dd) {d = dd; break;}
656246e270d4SMatthew G. Knepley     }
6563ebfe4b0dSMatthew G. Knepley     if (d >= 0) {ierr = DMSetCoordinateDim(dm, d);CHKERRQ(ierr);}
656446e270d4SMatthew G. Knepley   }
6565e8abe2deSMatthew G. Knepley   PetscFunctionReturn(0);
6566e8abe2deSMatthew G. Knepley }
6567e8abe2deSMatthew G. Knepley 
6568d864a3eaSLisandro Dalcin /*@
6569d864a3eaSLisandro Dalcin   DMProjectCoordinates - Project coordinates to a different space
6570d864a3eaSLisandro Dalcin 
6571d864a3eaSLisandro Dalcin   Input Parameters:
6572d864a3eaSLisandro Dalcin + dm      - The DM object
6573d864a3eaSLisandro Dalcin - disc    - The new coordinate discretization
6574d864a3eaSLisandro Dalcin 
6575d864a3eaSLisandro Dalcin   Level: intermediate
6576d864a3eaSLisandro Dalcin 
6577d864a3eaSLisandro Dalcin .seealso: DMGetCoordinateField()
6578d864a3eaSLisandro Dalcin @*/
6579d864a3eaSLisandro Dalcin PetscErrorCode DMProjectCoordinates(DM dm, PetscFE disc)
6580d864a3eaSLisandro Dalcin {
6581d864a3eaSLisandro Dalcin   PetscObject    discOld;
6582d864a3eaSLisandro Dalcin   PetscClassId   classid;
6583d864a3eaSLisandro Dalcin   DM             cdmOld,cdmNew;
6584d864a3eaSLisandro Dalcin   Vec            coordsOld,coordsNew;
6585d864a3eaSLisandro Dalcin   Mat            matInterp;
6586d864a3eaSLisandro Dalcin   PetscErrorCode ierr;
6587d864a3eaSLisandro Dalcin 
6588d864a3eaSLisandro Dalcin   PetscFunctionBegin;
6589d864a3eaSLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6590d864a3eaSLisandro Dalcin   PetscValidHeaderSpecific(disc,PETSCFE_CLASSID,2);
6591d864a3eaSLisandro Dalcin 
6592d864a3eaSLisandro Dalcin   ierr = DMGetCoordinateDM(dm, &cdmOld);CHKERRQ(ierr);
6593d864a3eaSLisandro Dalcin   /* Check current discretization is compatible */
6594d864a3eaSLisandro Dalcin   ierr = DMGetField(cdmOld, 0, NULL, &discOld);CHKERRQ(ierr);
6595d864a3eaSLisandro Dalcin   ierr = PetscObjectGetClassId(discOld, &classid);CHKERRQ(ierr);
659629ad44c5SMatthew G. Knepley   if (classid != PETSCFE_CLASSID) {
659729ad44c5SMatthew G. Knepley     if (classid == PETSC_CONTAINER_CLASSID) {
659829ad44c5SMatthew G. Knepley       PetscFE        feLinear;
659929ad44c5SMatthew G. Knepley       DMPolytopeType ct;
660029ad44c5SMatthew G. Knepley       PetscInt       dim, dE, cStart;
660129ad44c5SMatthew G. Knepley       PetscBool      simplex;
660229ad44c5SMatthew G. Knepley 
660329ad44c5SMatthew G. Knepley       /* Assume linear vertex coordinates */
660429ad44c5SMatthew G. Knepley       ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr);
660529ad44c5SMatthew G. Knepley       ierr = DMGetCoordinateDim(dm, &dE);CHKERRQ(ierr);
660629ad44c5SMatthew G. Knepley       ierr = DMPlexGetHeightStratum(cdmOld, 0, &cStart, NULL);CHKERRQ(ierr);
660729ad44c5SMatthew G. Knepley       ierr = DMPlexGetCellType(dm, cStart, &ct);CHKERRQ(ierr);
660829ad44c5SMatthew G. Knepley       switch (ct) {
660929ad44c5SMatthew G. Knepley         case DM_POLYTOPE_TRI_PRISM:
661029ad44c5SMatthew G. Knepley         case DM_POLYTOPE_TRI_PRISM_TENSOR:
661129ad44c5SMatthew G. Knepley           SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SUP, "Cannot autoamtically create coordinate space for prisms");
661229ad44c5SMatthew G. Knepley         default: break;
661329ad44c5SMatthew G. Knepley       }
661429ad44c5SMatthew G. Knepley       simplex = DMPolytopeTypeGetNumVertices(ct) == DMPolytopeTypeGetDim(ct)+1 ? PETSC_TRUE : PETSC_FALSE;
661529ad44c5SMatthew G. Knepley       ierr = PetscFECreateLagrange(PETSC_COMM_SELF, dim, dE, simplex, 1, -1, &feLinear);CHKERRQ(ierr);
661629ad44c5SMatthew G. Knepley       ierr = DMSetField(cdmOld, 0, NULL, (PetscObject) feLinear);CHKERRQ(ierr);
661729ad44c5SMatthew G. Knepley       ierr = PetscFEDestroy(&feLinear);CHKERRQ(ierr);
661829ad44c5SMatthew G. Knepley       ierr = DMCreateDS(cdmOld);CHKERRQ(ierr);
661929ad44c5SMatthew G. Knepley     } else {
662029ad44c5SMatthew G. Knepley       const char *discname;
662129ad44c5SMatthew G. Knepley 
662229ad44c5SMatthew G. Knepley       ierr = PetscObjectGetType(discOld, &discname);CHKERRQ(ierr);
662329ad44c5SMatthew G. Knepley       SETERRQ1(PetscObjectComm(discOld), PETSC_ERR_SUP, "Discretization type %s not supported", discname);
662429ad44c5SMatthew G. Knepley     }
662529ad44c5SMatthew G. Knepley   }
6626d864a3eaSLisandro Dalcin   /* Make a fresh clone of the coordinate DM */
6627d864a3eaSLisandro Dalcin   ierr = DMClone(cdmOld, &cdmNew);CHKERRQ(ierr);
6628d864a3eaSLisandro Dalcin   ierr = DMSetField(cdmNew, 0, NULL, (PetscObject) disc);CHKERRQ(ierr);
6629d864a3eaSLisandro Dalcin   ierr = DMCreateDS(cdmNew);CHKERRQ(ierr);
6630d864a3eaSLisandro Dalcin   /* Project the coordinate vector from old to new space  */
6631d864a3eaSLisandro Dalcin   ierr = DMGetCoordinates(dm, &coordsOld);CHKERRQ(ierr);
6632d864a3eaSLisandro Dalcin   ierr = DMCreateGlobalVector(cdmNew, &coordsNew);CHKERRQ(ierr);
6633d864a3eaSLisandro Dalcin   ierr = DMCreateInterpolation(cdmOld, cdmNew, &matInterp, NULL);CHKERRQ(ierr);
6634d864a3eaSLisandro Dalcin   ierr = MatInterpolate(matInterp, coordsOld, coordsNew);CHKERRQ(ierr);
6635d864a3eaSLisandro Dalcin   ierr = MatDestroy(&matInterp);CHKERRQ(ierr);
6636d864a3eaSLisandro Dalcin   /* Set new coordinate structures */
6637d864a3eaSLisandro Dalcin   ierr = DMSetCoordinateField(dm, NULL);CHKERRQ(ierr);
6638d864a3eaSLisandro Dalcin   ierr = DMSetCoordinateDM(dm, cdmNew);CHKERRQ(ierr);
6639d864a3eaSLisandro Dalcin   ierr = DMSetCoordinates(dm, coordsNew);CHKERRQ(ierr);
6640d864a3eaSLisandro Dalcin   ierr = VecDestroy(&coordsNew);CHKERRQ(ierr);
6641d864a3eaSLisandro Dalcin   ierr = DMDestroy(&cdmNew);CHKERRQ(ierr);
6642d864a3eaSLisandro Dalcin   PetscFunctionReturn(0);
6643d864a3eaSLisandro Dalcin }
6644d864a3eaSLisandro Dalcin 
66455dc8c3f7SMatthew G. Knepley /*@C
664690b157c4SStefano Zampini   DMGetPeriodicity - Get the description of mesh periodicity
66475dc8c3f7SMatthew G. Knepley 
66485dc8c3f7SMatthew G. Knepley   Input Parameters:
664990b157c4SStefano Zampini . dm      - The DM object
665090b157c4SStefano Zampini 
665190b157c4SStefano Zampini   Output Parameters:
665290b157c4SStefano Zampini + per     - Whether the DM is periodic or not
66535dc8c3f7SMatthew 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
66545dc8c3f7SMatthew G. Knepley . L       - If we assume the mesh is a torus, this is the length of each coordinate
66555dc8c3f7SMatthew G. Knepley - bd      - This describes the type of periodicity in each topological dimension
66565dc8c3f7SMatthew G. Knepley 
66575dc8c3f7SMatthew G. Knepley   Level: developer
66585dc8c3f7SMatthew G. Knepley 
66595dc8c3f7SMatthew G. Knepley .seealso: DMGetPeriodicity()
66605dc8c3f7SMatthew G. Knepley @*/
666190b157c4SStefano Zampini PetscErrorCode DMGetPeriodicity(DM dm, PetscBool *per, const PetscReal **maxCell, const PetscReal **L, const DMBoundaryType **bd)
6662c6b900c6SMatthew G. Knepley {
6663c6b900c6SMatthew G. Knepley   PetscFunctionBegin;
6664c6b900c6SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
666590b157c4SStefano Zampini   if (per)     *per     = dm->periodic;
6666c6b900c6SMatthew G. Knepley   if (L)       *L       = dm->L;
6667c6b900c6SMatthew G. Knepley   if (maxCell) *maxCell = dm->maxCell;
66685dc8c3f7SMatthew G. Knepley   if (bd)      *bd      = dm->bdtype;
6669c6b900c6SMatthew G. Knepley   PetscFunctionReturn(0);
6670c6b900c6SMatthew G. Knepley }
6671c6b900c6SMatthew G. Knepley 
66725dc8c3f7SMatthew G. Knepley /*@C
66735dc8c3f7SMatthew G. Knepley   DMSetPeriodicity - Set the description of mesh periodicity
66745dc8c3f7SMatthew G. Knepley 
66755dc8c3f7SMatthew G. Knepley   Input Parameters:
66765dc8c3f7SMatthew G. Knepley + dm      - The DM object
6677db2bf62eSStefano Zampini . per     - Whether the DM is periodic or not.
6678db2bf62eSStefano 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.
66795dc8c3f7SMatthew G. Knepley . L       - If we assume the mesh is a torus, this is the length of each coordinate
66805dc8c3f7SMatthew G. Knepley - bd      - This describes the type of periodicity in each topological dimension
66815dc8c3f7SMatthew G. Knepley 
6682db2bf62eSStefano 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.
6683db2bf62eSStefano Zampini 
66845dc8c3f7SMatthew G. Knepley   Level: developer
66855dc8c3f7SMatthew G. Knepley 
66865dc8c3f7SMatthew G. Knepley .seealso: DMGetPeriodicity()
66875dc8c3f7SMatthew G. Knepley @*/
668890b157c4SStefano Zampini PetscErrorCode DMSetPeriodicity(DM dm, PetscBool per, const PetscReal maxCell[], const PetscReal L[], const DMBoundaryType bd[])
6689c6b900c6SMatthew G. Knepley {
6690c6b900c6SMatthew G. Knepley   PetscInt       dim, d;
6691c6b900c6SMatthew G. Knepley   PetscErrorCode ierr;
6692c6b900c6SMatthew G. Knepley 
6693c6b900c6SMatthew G. Knepley   PetscFunctionBegin;
6694c6b900c6SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
669590b157c4SStefano Zampini   PetscValidLogicalCollectiveBool(dm,per,2);
6696412e9a14SMatthew G. Knepley   if (maxCell) {PetscValidRealPointer(maxCell,3);}
6697412e9a14SMatthew G. Knepley   if (L)       {PetscValidRealPointer(L,4);}
6698412e9a14SMatthew G. Knepley   if (bd)      {PetscValidPointer(bd,5);}
66995dc8c3f7SMatthew G. Knepley   ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr);
670090b157c4SStefano Zampini   if (maxCell) {
6701412e9a14SMatthew G. Knepley     if (!dm->maxCell) {ierr = PetscMalloc1(dim, &dm->maxCell);CHKERRQ(ierr);}
6702412e9a14SMatthew G. Knepley     for (d = 0; d < dim; ++d) dm->maxCell[d] = maxCell[d];
6703db2bf62eSStefano Zampini   } else { /* remove maxCell information to disable automatic computation of localized vertices */
6704db2bf62eSStefano Zampini     ierr = PetscFree(dm->maxCell);CHKERRQ(ierr);
6705412e9a14SMatthew G. Knepley   }
6706db2bf62eSStefano Zampini 
6707412e9a14SMatthew G. Knepley   if (L) {
6708412e9a14SMatthew G. Knepley     if (!dm->L) {ierr = PetscMalloc1(dim, &dm->L);CHKERRQ(ierr);}
6709412e9a14SMatthew G. Knepley     for (d = 0; d < dim; ++d) dm->L[d] = L[d];
6710412e9a14SMatthew G. Knepley   }
6711412e9a14SMatthew G. Knepley   if (bd) {
6712412e9a14SMatthew G. Knepley     if (!dm->bdtype) {ierr = PetscMalloc1(dim, &dm->bdtype);CHKERRQ(ierr);}
6713412e9a14SMatthew G. Knepley     for (d = 0; d < dim; ++d) dm->bdtype[d] = bd[d];
671490b157c4SStefano Zampini   }
6715072d7d67SStefano Zampini   dm->periodic = per;
6716c6b900c6SMatthew G. Knepley   PetscFunctionReturn(0);
6717c6b900c6SMatthew G. Knepley }
6718c6b900c6SMatthew G. Knepley 
67192e17dfb7SMatthew G. Knepley /*@
67202e17dfb7SMatthew 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.
67212e17dfb7SMatthew G. Knepley 
67222e17dfb7SMatthew G. Knepley   Input Parameters:
67232e17dfb7SMatthew G. Knepley + dm     - The DM
672465da65dcSMatthew G. Knepley . in     - The input coordinate point (dim numbers)
672565da65dcSMatthew G. Knepley - endpoint - Include the endpoint L_i
67262e17dfb7SMatthew G. Knepley 
67272e17dfb7SMatthew G. Knepley   Output Parameter:
67282e17dfb7SMatthew G. Knepley . out - The localized coordinate point
67292e17dfb7SMatthew G. Knepley 
67302e17dfb7SMatthew G. Knepley   Level: developer
67312e17dfb7SMatthew G. Knepley 
67322e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeAddCoordinate()
67332e17dfb7SMatthew G. Knepley @*/
673465da65dcSMatthew G. Knepley PetscErrorCode DMLocalizeCoordinate(DM dm, const PetscScalar in[], PetscBool endpoint, PetscScalar out[])
67352e17dfb7SMatthew G. Knepley {
67362e17dfb7SMatthew G. Knepley   PetscInt       dim, d;
67372e17dfb7SMatthew G. Knepley   PetscErrorCode ierr;
67382e17dfb7SMatthew G. Knepley 
67392e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
67402e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &dim);CHKERRQ(ierr);
67412e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
67422e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] = in[d];
67432e17dfb7SMatthew G. Knepley   } else {
674465da65dcSMatthew G. Knepley     if (endpoint) {
674565da65dcSMatthew G. Knepley       for (d = 0; d < dim; ++d) {
6746da3333bfSMatthew 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)) {
6747da3333bfSMatthew G. Knepley           out[d] = in[d] - dm->L[d]*(PetscFloorReal(PetscRealPart(in[d])/dm->L[d]) - 1);
674865da65dcSMatthew G. Knepley         } else {
6749da3333bfSMatthew G. Knepley           out[d] = in[d] - dm->L[d]*PetscFloorReal(PetscRealPart(in[d])/dm->L[d]);
675065da65dcSMatthew G. Knepley         }
675165da65dcSMatthew G. Knepley       }
675265da65dcSMatthew G. Knepley     } else {
67532e17dfb7SMatthew G. Knepley       for (d = 0; d < dim; ++d) {
67541118d4bcSLisandro Dalcin         out[d] = in[d] - dm->L[d]*PetscFloorReal(PetscRealPart(in[d])/dm->L[d]);
67552e17dfb7SMatthew G. Knepley       }
67562e17dfb7SMatthew G. Knepley     }
675765da65dcSMatthew G. Knepley   }
67582e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
67592e17dfb7SMatthew G. Knepley }
67602e17dfb7SMatthew G. Knepley 
67612e17dfb7SMatthew G. Knepley /*
67622e17dfb7SMatthew 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.
67632e17dfb7SMatthew G. Knepley 
67642e17dfb7SMatthew G. Knepley   Input Parameters:
67652e17dfb7SMatthew G. Knepley + dm     - The DM
67662e17dfb7SMatthew G. Knepley . dim    - The spatial dimension
67672e17dfb7SMatthew G. Knepley . anchor - The anchor point, the input point can be no more than maxCell away from it
67682e17dfb7SMatthew G. Knepley - in     - The input coordinate point (dim numbers)
67692e17dfb7SMatthew G. Knepley 
67702e17dfb7SMatthew G. Knepley   Output Parameter:
67712e17dfb7SMatthew G. Knepley . out - The localized coordinate point
67722e17dfb7SMatthew G. Knepley 
67732e17dfb7SMatthew G. Knepley   Level: developer
67742e17dfb7SMatthew G. Knepley 
67752e17dfb7SMatthew 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
67762e17dfb7SMatthew G. Knepley 
67772e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeAddCoordinate()
67782e17dfb7SMatthew G. Knepley */
67792e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinate_Internal(DM dm, PetscInt dim, const PetscScalar anchor[], const PetscScalar in[], PetscScalar out[])
67802e17dfb7SMatthew G. Knepley {
67812e17dfb7SMatthew G. Knepley   PetscInt d;
67822e17dfb7SMatthew G. Knepley 
67832e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
67842e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
67852e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] = in[d];
67862e17dfb7SMatthew G. Knepley   } else {
67872e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) {
6788908eca10SMatthew G. Knepley       if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsScalar(anchor[d] - in[d]) > dm->maxCell[d])) {
67892e17dfb7SMatthew G. Knepley         out[d] = PetscRealPart(anchor[d]) > PetscRealPart(in[d]) ? dm->L[d] + in[d] : in[d] - dm->L[d];
67902e17dfb7SMatthew G. Knepley       } else {
67912e17dfb7SMatthew G. Knepley         out[d] = in[d];
67922e17dfb7SMatthew G. Knepley       }
67932e17dfb7SMatthew G. Knepley     }
67942e17dfb7SMatthew G. Knepley   }
67952e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
67962e17dfb7SMatthew G. Knepley }
6797a5801f52SStefano Zampini 
67982e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinateReal_Internal(DM dm, PetscInt dim, const PetscReal anchor[], const PetscReal in[], PetscReal out[])
67992e17dfb7SMatthew G. Knepley {
68002e17dfb7SMatthew G. Knepley   PetscInt d;
68012e17dfb7SMatthew G. Knepley 
68022e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
68032e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
68042e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] = in[d];
68052e17dfb7SMatthew G. Knepley   } else {
68062e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) {
6807908eca10SMatthew G. Knepley       if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsReal(anchor[d] - in[d]) > dm->maxCell[d])) {
68082e17dfb7SMatthew G. Knepley         out[d] = anchor[d] > in[d] ? dm->L[d] + in[d] : in[d] - dm->L[d];
68092e17dfb7SMatthew G. Knepley       } else {
68102e17dfb7SMatthew G. Knepley         out[d] = in[d];
68112e17dfb7SMatthew G. Knepley       }
68122e17dfb7SMatthew G. Knepley     }
68132e17dfb7SMatthew G. Knepley   }
68142e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
68152e17dfb7SMatthew G. Knepley }
68162e17dfb7SMatthew G. Knepley 
68172e17dfb7SMatthew G. Knepley /*
68182e17dfb7SMatthew 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.
68192e17dfb7SMatthew G. Knepley 
68202e17dfb7SMatthew G. Knepley   Input Parameters:
68212e17dfb7SMatthew G. Knepley + dm     - The DM
68222e17dfb7SMatthew G. Knepley . dim    - The spatial dimension
68232e17dfb7SMatthew G. Knepley . anchor - The anchor point, the input point can be no more than maxCell away from it
68242e17dfb7SMatthew G. Knepley . in     - The input coordinate delta (dim numbers)
68252e17dfb7SMatthew G. Knepley - out    - The input coordinate point (dim numbers)
68262e17dfb7SMatthew G. Knepley 
68272e17dfb7SMatthew G. Knepley   Output Parameter:
68282e17dfb7SMatthew G. Knepley . out    - The localized coordinate in + out
68292e17dfb7SMatthew G. Knepley 
68302e17dfb7SMatthew G. Knepley   Level: developer
68312e17dfb7SMatthew G. Knepley 
68322e17dfb7SMatthew 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
68332e17dfb7SMatthew G. Knepley 
68342e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeCoordinate()
68352e17dfb7SMatthew G. Knepley */
68362e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeAddCoordinate_Internal(DM dm, PetscInt dim, const PetscScalar anchor[], const PetscScalar in[], PetscScalar out[])
68372e17dfb7SMatthew G. Knepley {
68382e17dfb7SMatthew G. Knepley   PetscInt d;
68392e17dfb7SMatthew G. Knepley 
68402e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
68412e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
68422e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] += in[d];
68432e17dfb7SMatthew G. Knepley   } else {
68442e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) {
6845412e9a14SMatthew G. Knepley       const PetscReal maxC = dm->maxCell[d];
6846412e9a14SMatthew G. Knepley 
6847412e9a14SMatthew G. Knepley       if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsScalar(anchor[d] - in[d]) > maxC)) {
6848412e9a14SMatthew G. Knepley         const PetscScalar newCoord = PetscRealPart(anchor[d]) > PetscRealPart(in[d]) ? dm->L[d] + in[d] : in[d] - dm->L[d];
6849412e9a14SMatthew G. Knepley 
6850412e9a14SMatthew G. Knepley         if (PetscAbsScalar(newCoord - anchor[d]) > maxC)
6851412e9a14SMatthew 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]));
6852412e9a14SMatthew G. Knepley         out[d] += newCoord;
68532e17dfb7SMatthew G. Knepley       } else {
68542e17dfb7SMatthew G. Knepley         out[d] += in[d];
68552e17dfb7SMatthew G. Knepley       }
68562e17dfb7SMatthew G. Knepley     }
68572e17dfb7SMatthew G. Knepley   }
68582e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
68592e17dfb7SMatthew G. Knepley }
68602e17dfb7SMatthew G. Knepley 
686136447a5eSToby Isaac /*@
68628f700142SStefano Zampini   DMGetCoordinatesLocalizedLocal - Check if the DM coordinates have been localized for cells on this process
68638f700142SStefano Zampini 
68648f700142SStefano Zampini   Not collective
686536447a5eSToby Isaac 
686636447a5eSToby Isaac   Input Parameter:
686736447a5eSToby Isaac . dm - The DM
686836447a5eSToby Isaac 
686936447a5eSToby Isaac   Output Parameter:
687036447a5eSToby Isaac   areLocalized - True if localized
687136447a5eSToby Isaac 
687236447a5eSToby Isaac   Level: developer
687336447a5eSToby Isaac 
68748f700142SStefano Zampini .seealso: DMLocalizeCoordinates(), DMGetCoordinatesLocalized(), DMSetPeriodicity()
687536447a5eSToby Isaac @*/
68768f700142SStefano Zampini PetscErrorCode DMGetCoordinatesLocalizedLocal(DM dm,PetscBool *areLocalized)
687736447a5eSToby Isaac {
687836447a5eSToby Isaac   DM             cdm;
687936447a5eSToby Isaac   PetscSection   coordSection;
68802ccac677SMatthew G. Knepley   PetscInt       depth, cStart, cEnd, sStart, sEnd, c, dof;
688146a3a80fSLisandro Dalcin   PetscBool      isPlex, alreadyLocalized;
688236447a5eSToby Isaac   PetscErrorCode ierr;
688336447a5eSToby Isaac 
688436447a5eSToby Isaac   PetscFunctionBegin;
688536447a5eSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6886534a8f05SLisandro Dalcin   PetscValidBoolPointer(areLocalized, 2);
68878b09590cSToby Isaac   *areLocalized = PETSC_FALSE;
688846a3a80fSLisandro Dalcin 
688936447a5eSToby Isaac   /* We need some generic way of refering to cells/vertices */
689036447a5eSToby Isaac   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
689146a3a80fSLisandro Dalcin   ierr = PetscObjectTypeCompare((PetscObject) cdm, DMPLEX, &isPlex);CHKERRQ(ierr);
68929f7230bfSMatthew G. Knepley   if (!isPlex) PetscFunctionReturn(0);
68932ccac677SMatthew G. Knepley   ierr = DMPlexGetDepth(cdm, &depth);CHKERRQ(ierr);
68942ccac677SMatthew G. Knepley   if (!depth) PetscFunctionReturn(0);
689546a3a80fSLisandro Dalcin 
68969f7230bfSMatthew G. Knepley   ierr = DMGetCoordinateSection(dm, &coordSection);CHKERRQ(ierr);
689746a3a80fSLisandro Dalcin   ierr = DMPlexGetHeightStratum(cdm, 0, &cStart, &cEnd);CHKERRQ(ierr);
689836447a5eSToby Isaac   ierr = PetscSectionGetChart(coordSection, &sStart, &sEnd);CHKERRQ(ierr);
689936447a5eSToby Isaac   alreadyLocalized = PETSC_FALSE;
690046a3a80fSLisandro Dalcin   for (c = cStart; c < cEnd; ++c) {
690146a3a80fSLisandro Dalcin     if (c < sStart || c >= sEnd) continue;
690236447a5eSToby Isaac     ierr = PetscSectionGetDof(coordSection, c, &dof);CHKERRQ(ierr);
690346a3a80fSLisandro Dalcin     if (dof) { alreadyLocalized = PETSC_TRUE; break; }
690436447a5eSToby Isaac   }
69058f700142SStefano Zampini   *areLocalized = alreadyLocalized;
690636447a5eSToby Isaac   PetscFunctionReturn(0);
690736447a5eSToby Isaac }
690836447a5eSToby Isaac 
69098f700142SStefano Zampini /*@
69108f700142SStefano Zampini   DMGetCoordinatesLocalized - Check if the DM coordinates have been localized for cells
69118f700142SStefano Zampini 
69128f700142SStefano Zampini   Collective on dm
69138f700142SStefano Zampini 
69148f700142SStefano Zampini   Input Parameter:
69158f700142SStefano Zampini . dm - The DM
69168f700142SStefano Zampini 
69178f700142SStefano Zampini   Output Parameter:
69188f700142SStefano Zampini   areLocalized - True if localized
69198f700142SStefano Zampini 
69208f700142SStefano Zampini   Level: developer
69218f700142SStefano Zampini 
69228f700142SStefano Zampini .seealso: DMLocalizeCoordinates(), DMSetPeriodicity(), DMGetCoordinatesLocalizedLocal()
69238f700142SStefano Zampini @*/
69248f700142SStefano Zampini PetscErrorCode DMGetCoordinatesLocalized(DM dm,PetscBool *areLocalized)
69258f700142SStefano Zampini {
69268f700142SStefano Zampini   PetscBool      localized;
69278f700142SStefano Zampini   PetscErrorCode ierr;
69288f700142SStefano Zampini 
69298f700142SStefano Zampini   PetscFunctionBegin;
69308f700142SStefano Zampini   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6931534a8f05SLisandro Dalcin   PetscValidBoolPointer(areLocalized, 2);
69328f700142SStefano Zampini   ierr = DMGetCoordinatesLocalizedLocal(dm,&localized);CHKERRQ(ierr);
6933820f2d46SBarry Smith   ierr = MPIU_Allreduce(&localized,areLocalized,1,MPIU_BOOL,MPI_LOR,PetscObjectComm((PetscObject)dm));CHKERRMPI(ierr);
69348f700142SStefano Zampini   PetscFunctionReturn(0);
69358f700142SStefano Zampini }
693636447a5eSToby Isaac 
69372e17dfb7SMatthew G. Knepley /*@
6938492b8470SStefano Zampini   DMLocalizeCoordinates - If a mesh is periodic, create local coordinates for cells having periodic faces
69392e17dfb7SMatthew G. Knepley 
69408f700142SStefano Zampini   Collective on dm
69418f700142SStefano Zampini 
69422e17dfb7SMatthew G. Knepley   Input Parameter:
69432e17dfb7SMatthew G. Knepley . dm - The DM
69442e17dfb7SMatthew G. Knepley 
69452e17dfb7SMatthew G. Knepley   Level: developer
69462e17dfb7SMatthew G. Knepley 
69478f700142SStefano Zampini .seealso: DMSetPeriodicity(), DMLocalizeCoordinate(), DMLocalizeAddCoordinate()
69482e17dfb7SMatthew G. Knepley @*/
69492e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinates(DM dm)
69502e17dfb7SMatthew G. Knepley {
69512e17dfb7SMatthew G. Knepley   DM             cdm;
69522e17dfb7SMatthew G. Knepley   PetscSection   coordSection, cSection;
69532e17dfb7SMatthew G. Knepley   Vec            coordinates,  cVec;
69543e922f36SToby Isaac   PetscScalar   *coords, *coords2, *anchor, *localized;
69553e922f36SToby Isaac   PetscInt       Nc, vStart, vEnd, v, sStart, sEnd, newStart = PETSC_MAX_INT, newEnd = PETSC_MIN_INT, dof, d, off, off2, bs, coordSize;
6956e0ae35bbSToby Isaac   PetscBool      alreadyLocalized, alreadyLocalizedGlobal;
69573e922f36SToby Isaac   PetscInt       maxHeight = 0, h;
69583e922f36SToby Isaac   PetscInt       *pStart = NULL, *pEnd = NULL;
69592e17dfb7SMatthew G. Knepley   PetscErrorCode ierr;
69602e17dfb7SMatthew G. Knepley 
69612e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
69622e17dfb7SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
696392c9c85fSStefano Zampini   if (!dm->periodic) PetscFunctionReturn(0);
6964f7cbd40bSStefano Zampini   ierr = DMGetCoordinatesLocalized(dm, &alreadyLocalized);CHKERRQ(ierr);
6965f7cbd40bSStefano Zampini   if (alreadyLocalized) PetscFunctionReturn(0);
6966f7cbd40bSStefano Zampini 
69672e17dfb7SMatthew G. Knepley   /* We need some generic way of refering to cells/vertices */
69682e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
69692e17dfb7SMatthew G. Knepley   {
69702e17dfb7SMatthew G. Knepley     PetscBool isplex;
69712e17dfb7SMatthew G. Knepley 
69722e17dfb7SMatthew G. Knepley     ierr = PetscObjectTypeCompare((PetscObject) cdm, DMPLEX, &isplex);CHKERRQ(ierr);
69732e17dfb7SMatthew G. Knepley     if (isplex) {
69742e17dfb7SMatthew G. Knepley       ierr = DMPlexGetDepthStratum(cdm, 0, &vStart, &vEnd);CHKERRQ(ierr);
69753e922f36SToby Isaac       ierr = DMPlexGetMaxProjectionHeight(cdm,&maxHeight);CHKERRQ(ierr);
697669291d52SBarry Smith       ierr = DMGetWorkArray(dm,2*(maxHeight + 1),MPIU_INT,&pStart);CHKERRQ(ierr);
69773e922f36SToby Isaac       pEnd = &pStart[maxHeight + 1];
69783e922f36SToby Isaac       newStart = vStart;
69793e922f36SToby Isaac       newEnd   = vEnd;
69803e922f36SToby Isaac       for (h = 0; h <= maxHeight; h++) {
69813e922f36SToby Isaac         ierr = DMPlexGetHeightStratum(cdm, h, &pStart[h], &pEnd[h]);CHKERRQ(ierr);
69823e922f36SToby Isaac         newStart = PetscMin(newStart,pStart[h]);
69833e922f36SToby Isaac         newEnd   = PetscMax(newEnd,pEnd[h]);
69843e922f36SToby Isaac       }
69852e17dfb7SMatthew G. Knepley     } else SETERRQ(PetscObjectComm((PetscObject) cdm), PETSC_ERR_ARG_WRONG, "Coordinate localization requires a DMPLEX coordinate DM");
69862e17dfb7SMatthew G. Knepley   }
69872e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinatesLocal(dm, &coordinates);CHKERRQ(ierr);
698843eeeb2dSStefano Zampini   if (!coordinates) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"Missing local coordinates vector");
69892e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinateSection(dm, &coordSection);CHKERRQ(ierr);
69903e922f36SToby Isaac   ierr = VecGetBlockSize(coordinates, &bs);CHKERRQ(ierr);
6991e0ae35bbSToby Isaac   ierr = PetscSectionGetChart(coordSection,&sStart,&sEnd);CHKERRQ(ierr);
69923e922f36SToby Isaac 
69932e17dfb7SMatthew G. Knepley   ierr = PetscSectionCreate(PetscObjectComm((PetscObject) dm), &cSection);CHKERRQ(ierr);
69942e17dfb7SMatthew G. Knepley   ierr = PetscSectionSetNumFields(cSection, 1);CHKERRQ(ierr);
69952e17dfb7SMatthew G. Knepley   ierr = PetscSectionGetFieldComponents(coordSection, 0, &Nc);CHKERRQ(ierr);
69962e17dfb7SMatthew G. Knepley   ierr = PetscSectionSetFieldComponents(cSection, 0, Nc);CHKERRQ(ierr);
69973e922f36SToby Isaac   ierr = PetscSectionSetChart(cSection, newStart, newEnd);CHKERRQ(ierr);
69983e922f36SToby Isaac 
699969291d52SBarry Smith   ierr = DMGetWorkArray(dm, 2 * bs, MPIU_SCALAR, &anchor);CHKERRQ(ierr);
70003e922f36SToby Isaac   localized = &anchor[bs];
70013e922f36SToby Isaac   alreadyLocalized = alreadyLocalizedGlobal = PETSC_TRUE;
70023e922f36SToby Isaac   for (h = 0; h <= maxHeight; h++) {
70033e922f36SToby Isaac     PetscInt cStart = pStart[h], cEnd = pEnd[h], c;
70043e922f36SToby Isaac 
70053e922f36SToby Isaac     for (c = cStart; c < cEnd; ++c) {
70063e922f36SToby Isaac       PetscScalar *cellCoords = NULL;
70073e922f36SToby Isaac       PetscInt     b;
70083e922f36SToby Isaac 
70093e922f36SToby Isaac       if (c < sStart || c >= sEnd) alreadyLocalized = PETSC_FALSE;
70103e922f36SToby Isaac       ierr = DMPlexVecGetClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
70113e922f36SToby Isaac       for (b = 0; b < bs; ++b) anchor[b] = cellCoords[b];
70123e922f36SToby Isaac       for (d = 0; d < dof/bs; ++d) {
70133e922f36SToby Isaac         ierr = DMLocalizeCoordinate_Internal(dm, bs, anchor, &cellCoords[d*bs], localized);CHKERRQ(ierr);
70143e922f36SToby Isaac         for (b = 0; b < bs; b++) {
70153e922f36SToby Isaac           if (cellCoords[d*bs + b] != localized[b]) break;
70163e922f36SToby Isaac         }
70173e922f36SToby Isaac         if (b < bs) break;
70183e922f36SToby Isaac       }
70193e922f36SToby Isaac       if (d < dof/bs) {
70203e922f36SToby Isaac         if (c >= sStart && c < sEnd) {
70213e922f36SToby Isaac           PetscInt cdof;
70223e922f36SToby Isaac 
70233e922f36SToby Isaac           ierr = PetscSectionGetDof(coordSection, c, &cdof);CHKERRQ(ierr);
70243e922f36SToby Isaac           if (cdof != dof) alreadyLocalized = PETSC_FALSE;
70253e922f36SToby Isaac         }
70263e922f36SToby Isaac         ierr = PetscSectionSetDof(cSection, c, dof);CHKERRQ(ierr);
70273e922f36SToby Isaac         ierr = PetscSectionSetFieldDof(cSection, c, 0, dof);CHKERRQ(ierr);
70283e922f36SToby Isaac       }
70293e922f36SToby Isaac       ierr = DMPlexVecRestoreClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
70303e922f36SToby Isaac     }
70313e922f36SToby Isaac   }
7032ffc4695bSBarry Smith   ierr = MPI_Allreduce(&alreadyLocalized,&alreadyLocalizedGlobal,1,MPIU_BOOL,MPI_LAND,PetscObjectComm((PetscObject)dm));CHKERRMPI(ierr);
70333e922f36SToby Isaac   if (alreadyLocalizedGlobal) {
703469291d52SBarry Smith     ierr = DMRestoreWorkArray(dm, 2 * bs, MPIU_SCALAR, &anchor);CHKERRQ(ierr);
70353e922f36SToby Isaac     ierr = PetscSectionDestroy(&cSection);CHKERRQ(ierr);
703669291d52SBarry Smith     ierr = DMRestoreWorkArray(dm,2*(maxHeight + 1),MPIU_INT,&pStart);CHKERRQ(ierr);
70373e922f36SToby Isaac     PetscFunctionReturn(0);
70383e922f36SToby Isaac   }
70392e17dfb7SMatthew G. Knepley   for (v = vStart; v < vEnd; ++v) {
70402e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetDof(coordSection, v, &dof);CHKERRQ(ierr);
70412e17dfb7SMatthew G. Knepley     ierr = PetscSectionSetDof(cSection, v, dof);CHKERRQ(ierr);
70422e17dfb7SMatthew G. Knepley     ierr = PetscSectionSetFieldDof(cSection, v, 0, dof);CHKERRQ(ierr);
70432e17dfb7SMatthew G. Knepley   }
70442e17dfb7SMatthew G. Knepley   ierr = PetscSectionSetUp(cSection);CHKERRQ(ierr);
70452e17dfb7SMatthew G. Knepley   ierr = PetscSectionGetStorageSize(cSection, &coordSize);CHKERRQ(ierr);
7046c2be7e5eSLisandro Dalcin   ierr = VecCreate(PETSC_COMM_SELF, &cVec);CHKERRQ(ierr);
70472e17dfb7SMatthew G. Knepley   ierr = PetscObjectSetName((PetscObject)cVec,"coordinates");CHKERRQ(ierr);
70482e17dfb7SMatthew G. Knepley   ierr = VecSetBlockSize(cVec, bs);CHKERRQ(ierr);
70492e17dfb7SMatthew G. Knepley   ierr = VecSetSizes(cVec, coordSize, PETSC_DETERMINE);CHKERRQ(ierr);
70502e17dfb7SMatthew G. Knepley   ierr = VecSetType(cVec, VECSTANDARD);CHKERRQ(ierr);
7051c2be7e5eSLisandro Dalcin   ierr = VecGetArrayRead(coordinates, (const PetscScalar**)&coords);CHKERRQ(ierr);
70522e17dfb7SMatthew G. Knepley   ierr = VecGetArray(cVec, &coords2);CHKERRQ(ierr);
70532e17dfb7SMatthew G. Knepley   for (v = vStart; v < vEnd; ++v) {
70542e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetDof(coordSection, v, &dof);CHKERRQ(ierr);
70552e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetOffset(coordSection, v, &off);CHKERRQ(ierr);
70562e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetOffset(cSection,     v, &off2);CHKERRQ(ierr);
70572e17dfb7SMatthew G. Knepley     for (d = 0; d < dof; ++d) coords2[off2+d] = coords[off+d];
70582e17dfb7SMatthew G. Knepley   }
70593e922f36SToby Isaac   for (h = 0; h <= maxHeight; h++) {
70603e922f36SToby Isaac     PetscInt cStart = pStart[h], cEnd = pEnd[h], c;
70613e922f36SToby Isaac 
70622e17dfb7SMatthew G. Knepley     for (c = cStart; c < cEnd; ++c) {
70632e17dfb7SMatthew G. Knepley       PetscScalar *cellCoords = NULL;
70643e922f36SToby Isaac       PetscInt     b, cdof;
70652e17dfb7SMatthew G. Knepley 
70663e922f36SToby Isaac       ierr = PetscSectionGetDof(cSection,c,&cdof);CHKERRQ(ierr);
70673e922f36SToby Isaac       if (!cdof) continue;
70682e17dfb7SMatthew G. Knepley       ierr = DMPlexVecGetClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
70692e17dfb7SMatthew G. Knepley       ierr = PetscSectionGetOffset(cSection, c, &off2);CHKERRQ(ierr);
70702e17dfb7SMatthew G. Knepley       for (b = 0; b < bs; ++b) anchor[b] = cellCoords[b];
70712e17dfb7SMatthew G. Knepley       for (d = 0; d < dof/bs; ++d) {ierr = DMLocalizeCoordinate_Internal(dm, bs, anchor, &cellCoords[d*bs], &coords2[off2+d*bs]);CHKERRQ(ierr);}
70722e17dfb7SMatthew G. Knepley       ierr = DMPlexVecRestoreClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
70732e17dfb7SMatthew G. Knepley     }
70743e922f36SToby Isaac   }
707569291d52SBarry Smith   ierr = DMRestoreWorkArray(dm, 2 * bs, MPIU_SCALAR, &anchor);CHKERRQ(ierr);
707669291d52SBarry Smith   ierr = DMRestoreWorkArray(dm,2*(maxHeight + 1),MPIU_INT,&pStart);CHKERRQ(ierr);
7077c2be7e5eSLisandro Dalcin   ierr = VecRestoreArrayRead(coordinates, (const PetscScalar**)&coords);CHKERRQ(ierr);
70782e17dfb7SMatthew G. Knepley   ierr = VecRestoreArray(cVec, &coords2);CHKERRQ(ierr);
70792e17dfb7SMatthew G. Knepley   ierr = DMSetCoordinateSection(dm, PETSC_DETERMINE, cSection);CHKERRQ(ierr);
70802e17dfb7SMatthew G. Knepley   ierr = DMSetCoordinatesLocal(dm, cVec);CHKERRQ(ierr);
70812e17dfb7SMatthew G. Knepley   ierr = VecDestroy(&cVec);CHKERRQ(ierr);
70822e17dfb7SMatthew G. Knepley   ierr = PetscSectionDestroy(&cSection);CHKERRQ(ierr);
70832e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
70842e17dfb7SMatthew G. Knepley }
70852e17dfb7SMatthew G. Knepley 
7086e87bb0d3SMatthew G Knepley /*@
70873a93e3b7SToby Isaac   DMLocatePoints - Locate the points in v in the mesh and return a PetscSF of the containing cells
7088e87bb0d3SMatthew G Knepley 
7089d083f849SBarry Smith   Collective on v (see explanation below)
7090e87bb0d3SMatthew G Knepley 
7091e87bb0d3SMatthew G Knepley   Input Parameters:
7092e87bb0d3SMatthew G Knepley + dm - The DM
70933a93e3b7SToby Isaac . v - The Vec of points
709462a38674SMatthew G. Knepley . ltype - The type of point location, e.g. DM_POINTLOCATION_NONE or DM_POINTLOCATION_NEAREST
70953a93e3b7SToby Isaac - cells - Points to either NULL, or a PetscSF with guesses for which cells contain each point.
7096e87bb0d3SMatthew G Knepley 
709761e3bb9bSMatthew G Knepley   Output Parameter:
709862a38674SMatthew G. Knepley + v - The Vec of points, which now contains the nearest mesh points to the given points if DM_POINTLOCATION_NEAREST is used
709962a38674SMatthew G. Knepley - cells - The PetscSF containing the ranks and local indices of the containing points.
71003a93e3b7SToby Isaac 
7101e87bb0d3SMatthew G Knepley   Level: developer
710261e3bb9bSMatthew G Knepley 
710362a38674SMatthew G. Knepley   Notes:
71043a93e3b7SToby Isaac   To do a search of the local cells of the mesh, v should have PETSC_COMM_SELF as its communicator.
710562a38674SMatthew G. Knepley   To do a search of all the cells in the distributed mesh, v should have the same communicator as dm.
71063a93e3b7SToby Isaac 
71073a93e3b7SToby Isaac   If *cellSF is NULL on input, a PetscSF will be created.
710862a38674SMatthew G. Knepley   If *cellSF is not NULL on input, it should point to an existing PetscSF, whose graph will be used as initial guesses.
71093a93e3b7SToby Isaac 
71103a93e3b7SToby Isaac   An array that maps each point to its containing cell can be obtained with
71113a93e3b7SToby Isaac 
711262a38674SMatthew G. Knepley $    const PetscSFNode *cells;
711362a38674SMatthew G. Knepley $    PetscInt           nFound;
7114a6216909SToby Isaac $    const PetscInt    *found;
711562a38674SMatthew G. Knepley $
7116a6216909SToby Isaac $    PetscSFGetGraph(cellSF,NULL,&nFound,&found,&cells);
71173a93e3b7SToby Isaac 
71183a93e3b7SToby 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
71193a93e3b7SToby Isaac   the index of the cell in its rank's local numbering.
71203a93e3b7SToby Isaac 
712162a38674SMatthew G. Knepley .seealso: DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal(), DMPointLocationType
712261e3bb9bSMatthew G Knepley @*/
712362a38674SMatthew G. Knepley PetscErrorCode DMLocatePoints(DM dm, Vec v, DMPointLocationType ltype, PetscSF *cellSF)
7124e87bb0d3SMatthew G Knepley {
7125735aa83eSMatthew G Knepley   PetscErrorCode ierr;
7126735aa83eSMatthew G Knepley 
7127e87bb0d3SMatthew G Knepley   PetscFunctionBegin;
7128e87bb0d3SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
7129e87bb0d3SMatthew G Knepley   PetscValidHeaderSpecific(v,VEC_CLASSID,2);
7130e0fc9d1bSMatthew G. Knepley   PetscValidPointer(cellSF,4);
71313a93e3b7SToby Isaac   if (*cellSF) {
71323a93e3b7SToby Isaac     PetscMPIInt result;
71333a93e3b7SToby Isaac 
7134e0fc9d1bSMatthew G. Knepley     PetscValidHeaderSpecific(*cellSF,PETSCSF_CLASSID,4);
7135ffc4695bSBarry Smith     ierr = MPI_Comm_compare(PetscObjectComm((PetscObject)v),PetscObjectComm((PetscObject)*cellSF),&result);CHKERRMPI(ierr);
71363a93e3b7SToby 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");
7137e0fc9d1bSMatthew G. Knepley   } else {
71383a93e3b7SToby Isaac     ierr = PetscSFCreate(PetscObjectComm((PetscObject)v),cellSF);CHKERRQ(ierr);
71393a93e3b7SToby Isaac   }
7140b9d85ea2SLisandro Dalcin   if (!dm->ops->locatepoints) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Point location not available for this DM");
714147a35634SPatrick Farrell   ierr = PetscLogEventBegin(DM_LocatePoints,dm,0,0,0);CHKERRQ(ierr);
714262a38674SMatthew G. Knepley   ierr = (*dm->ops->locatepoints)(dm,v,ltype,*cellSF);CHKERRQ(ierr);
714347a35634SPatrick Farrell   ierr = PetscLogEventEnd(DM_LocatePoints,dm,0,0,0);CHKERRQ(ierr);
7144e87bb0d3SMatthew G Knepley   PetscFunctionReturn(0);
7145e87bb0d3SMatthew G Knepley }
714614f150ffSMatthew G. Knepley 
7147f4d763aaSMatthew G. Knepley /*@
7148f4d763aaSMatthew G. Knepley   DMGetOutputDM - Retrieve the DM associated with the layout for output
7149f4d763aaSMatthew G. Knepley 
71508f700142SStefano Zampini   Collective on dm
71518f700142SStefano Zampini 
7152f4d763aaSMatthew G. Knepley   Input Parameter:
7153f4d763aaSMatthew G. Knepley . dm - The original DM
7154f4d763aaSMatthew G. Knepley 
7155f4d763aaSMatthew G. Knepley   Output Parameter:
7156f4d763aaSMatthew G. Knepley . odm - The DM which provides the layout for output
7157f4d763aaSMatthew G. Knepley 
7158f4d763aaSMatthew G. Knepley   Level: intermediate
7159f4d763aaSMatthew G. Knepley 
7160e87a4003SBarry Smith .seealso: VecView(), DMGetGlobalSection()
7161f4d763aaSMatthew G. Knepley @*/
716214f150ffSMatthew G. Knepley PetscErrorCode DMGetOutputDM(DM dm, DM *odm)
716314f150ffSMatthew G. Knepley {
7164c26acbdeSMatthew G. Knepley   PetscSection   section;
71652d4e4a49SMatthew G. Knepley   PetscBool      hasConstraints, ghasConstraints;
716614f150ffSMatthew G. Knepley   PetscErrorCode ierr;
716714f150ffSMatthew G. Knepley 
716814f150ffSMatthew G. Knepley   PetscFunctionBegin;
716914f150ffSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
717014f150ffSMatthew G. Knepley   PetscValidPointer(odm,2);
717192fd8e1eSJed Brown   ierr = DMGetLocalSection(dm, &section);CHKERRQ(ierr);
7172c26acbdeSMatthew G. Knepley   ierr = PetscSectionHasConstraints(section, &hasConstraints);CHKERRQ(ierr);
7173ffc4695bSBarry Smith   ierr = MPI_Allreduce(&hasConstraints, &ghasConstraints, 1, MPIU_BOOL, MPI_LOR, PetscObjectComm((PetscObject) dm));CHKERRMPI(ierr);
71742d4e4a49SMatthew G. Knepley   if (!ghasConstraints) {
7175c26acbdeSMatthew G. Knepley     *odm = dm;
7176c26acbdeSMatthew G. Knepley     PetscFunctionReturn(0);
7177c26acbdeSMatthew G. Knepley   }
717814f150ffSMatthew G. Knepley   if (!dm->dmBC) {
7179c26acbdeSMatthew G. Knepley     PetscSection newSection, gsection;
718014f150ffSMatthew G. Knepley     PetscSF      sf;
718114f150ffSMatthew G. Knepley 
718214f150ffSMatthew G. Knepley     ierr = DMClone(dm, &dm->dmBC);CHKERRQ(ierr);
7183e5e52638SMatthew G. Knepley     ierr = DMCopyDisc(dm, dm->dmBC);CHKERRQ(ierr);
718414f150ffSMatthew G. Knepley     ierr = PetscSectionClone(section, &newSection);CHKERRQ(ierr);
718592fd8e1eSJed Brown     ierr = DMSetLocalSection(dm->dmBC, newSection);CHKERRQ(ierr);
718614f150ffSMatthew G. Knepley     ierr = PetscSectionDestroy(&newSection);CHKERRQ(ierr);
718714f150ffSMatthew G. Knepley     ierr = DMGetPointSF(dm->dmBC, &sf);CHKERRQ(ierr);
718815b58121SMatthew G. Knepley     ierr = PetscSectionCreateGlobalSection(section, sf, PETSC_TRUE, PETSC_FALSE, &gsection);CHKERRQ(ierr);
7189e87a4003SBarry Smith     ierr = DMSetGlobalSection(dm->dmBC, gsection);CHKERRQ(ierr);
719014f150ffSMatthew G. Knepley     ierr = PetscSectionDestroy(&gsection);CHKERRQ(ierr);
719114f150ffSMatthew G. Knepley   }
719214f150ffSMatthew G. Knepley   *odm = dm->dmBC;
719314f150ffSMatthew G. Knepley   PetscFunctionReturn(0);
719414f150ffSMatthew G. Knepley }
7195f4d763aaSMatthew G. Knepley 
7196f4d763aaSMatthew G. Knepley /*@
7197cdb7a50dSMatthew G. Knepley   DMGetOutputSequenceNumber - Retrieve the sequence number/value for output
7198f4d763aaSMatthew G. Knepley 
7199f4d763aaSMatthew G. Knepley   Input Parameter:
7200f4d763aaSMatthew G. Knepley . dm - The original DM
7201f4d763aaSMatthew G. Knepley 
7202cdb7a50dSMatthew G. Knepley   Output Parameters:
7203cdb7a50dSMatthew G. Knepley + num - The output sequence number
7204cdb7a50dSMatthew G. Knepley - val - The output sequence value
7205f4d763aaSMatthew G. Knepley 
7206f4d763aaSMatthew G. Knepley   Level: intermediate
7207f4d763aaSMatthew G. Knepley 
7208f4d763aaSMatthew G. Knepley   Note: This is intended for output that should appear in sequence, for instance
7209f4d763aaSMatthew G. Knepley   a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system.
7210f4d763aaSMatthew G. Knepley 
7211f4d763aaSMatthew G. Knepley .seealso: VecView()
7212f4d763aaSMatthew G. Knepley @*/
7213cdb7a50dSMatthew G. Knepley PetscErrorCode DMGetOutputSequenceNumber(DM dm, PetscInt *num, PetscReal *val)
7214f4d763aaSMatthew G. Knepley {
7215f4d763aaSMatthew G. Knepley   PetscFunctionBegin;
7216f4d763aaSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
7217534a8f05SLisandro Dalcin   if (num) {PetscValidIntPointer(num,2); *num = dm->outputSequenceNum;}
7218534a8f05SLisandro Dalcin   if (val) {PetscValidRealPointer(val,3);*val = dm->outputSequenceVal;}
7219f4d763aaSMatthew G. Knepley   PetscFunctionReturn(0);
7220f4d763aaSMatthew G. Knepley }
7221f4d763aaSMatthew G. Knepley 
7222f4d763aaSMatthew G. Knepley /*@
7223cdb7a50dSMatthew G. Knepley   DMSetOutputSequenceNumber - Set the sequence number/value for output
7224f4d763aaSMatthew G. Knepley 
7225f4d763aaSMatthew G. Knepley   Input Parameters:
7226f4d763aaSMatthew G. Knepley + dm - The original DM
7227cdb7a50dSMatthew G. Knepley . num - The output sequence number
7228cdb7a50dSMatthew G. Knepley - val - The output sequence value
7229f4d763aaSMatthew G. Knepley 
7230f4d763aaSMatthew G. Knepley   Level: intermediate
7231f4d763aaSMatthew G. Knepley 
7232f4d763aaSMatthew G. Knepley   Note: This is intended for output that should appear in sequence, for instance
7233f4d763aaSMatthew G. Knepley   a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system.
7234f4d763aaSMatthew G. Knepley 
7235f4d763aaSMatthew G. Knepley .seealso: VecView()
7236f4d763aaSMatthew G. Knepley @*/
7237cdb7a50dSMatthew G. Knepley PetscErrorCode DMSetOutputSequenceNumber(DM dm, PetscInt num, PetscReal val)
7238f4d763aaSMatthew G. Knepley {
7239f4d763aaSMatthew G. Knepley   PetscFunctionBegin;
7240f4d763aaSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
7241f4d763aaSMatthew G. Knepley   dm->outputSequenceNum = num;
7242cdb7a50dSMatthew G. Knepley   dm->outputSequenceVal = val;
7243cdb7a50dSMatthew G. Knepley   PetscFunctionReturn(0);
7244cdb7a50dSMatthew G. Knepley }
7245cdb7a50dSMatthew G. Knepley 
7246cdb7a50dSMatthew G. Knepley /*@C
7247cdb7a50dSMatthew G. Knepley   DMOutputSequenceLoad - Retrieve the sequence value from a Viewer
7248cdb7a50dSMatthew G. Knepley 
7249cdb7a50dSMatthew G. Knepley   Input Parameters:
7250cdb7a50dSMatthew G. Knepley + dm   - The original DM
7251cdb7a50dSMatthew G. Knepley . name - The sequence name
7252cdb7a50dSMatthew G. Knepley - num  - The output sequence number
7253cdb7a50dSMatthew G. Knepley 
7254cdb7a50dSMatthew G. Knepley   Output Parameter:
7255cdb7a50dSMatthew G. Knepley . val  - The output sequence value
7256cdb7a50dSMatthew G. Knepley 
7257cdb7a50dSMatthew G. Knepley   Level: intermediate
7258cdb7a50dSMatthew G. Knepley 
7259cdb7a50dSMatthew G. Knepley   Note: This is intended for output that should appear in sequence, for instance
7260cdb7a50dSMatthew G. Knepley   a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system.
7261cdb7a50dSMatthew G. Knepley 
7262cdb7a50dSMatthew G. Knepley .seealso: DMGetOutputSequenceNumber(), DMSetOutputSequenceNumber(), VecView()
7263cdb7a50dSMatthew G. Knepley @*/
7264cdb7a50dSMatthew G. Knepley PetscErrorCode DMOutputSequenceLoad(DM dm, PetscViewer viewer, const char *name, PetscInt num, PetscReal *val)
7265cdb7a50dSMatthew G. Knepley {
7266cdb7a50dSMatthew G. Knepley   PetscBool      ishdf5;
7267cdb7a50dSMatthew G. Knepley   PetscErrorCode ierr;
7268cdb7a50dSMatthew G. Knepley 
7269cdb7a50dSMatthew G. Knepley   PetscFunctionBegin;
7270cdb7a50dSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
7271cdb7a50dSMatthew G. Knepley   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
7272064a246eSJacob Faibussowitsch   PetscValidRealPointer(val,5);
7273cdb7a50dSMatthew G. Knepley   ierr = PetscObjectTypeCompare((PetscObject) viewer, PETSCVIEWERHDF5, &ishdf5);CHKERRQ(ierr);
7274cdb7a50dSMatthew G. Knepley   if (ishdf5) {
7275cdb7a50dSMatthew G. Knepley #if defined(PETSC_HAVE_HDF5)
7276cdb7a50dSMatthew G. Knepley     PetscScalar value;
7277cdb7a50dSMatthew G. Knepley 
727839d25373SMatthew G. Knepley     ierr = DMSequenceLoad_HDF5_Internal(dm, name, num, &value, viewer);CHKERRQ(ierr);
72794aeb217fSMatthew G. Knepley     *val = PetscRealPart(value);
7280cdb7a50dSMatthew G. Knepley #endif
7281cdb7a50dSMatthew G. Knepley   } else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Invalid viewer; open viewer with PetscViewerHDF5Open()");
7282f4d763aaSMatthew G. Knepley   PetscFunctionReturn(0);
7283f4d763aaSMatthew G. Knepley }
72848e4ac7eaSMatthew G. Knepley 
72858e4ac7eaSMatthew G. Knepley /*@
72868e4ac7eaSMatthew G. Knepley   DMGetUseNatural - Get the flag for creating a mapping to the natural order on distribution
72878e4ac7eaSMatthew G. Knepley 
72888e4ac7eaSMatthew G. Knepley   Not collective
72898e4ac7eaSMatthew G. Knepley 
72908e4ac7eaSMatthew G. Knepley   Input Parameter:
72918e4ac7eaSMatthew G. Knepley . dm - The DM
72928e4ac7eaSMatthew G. Knepley 
72938e4ac7eaSMatthew G. Knepley   Output Parameter:
72948e4ac7eaSMatthew G. Knepley . useNatural - The flag to build the mapping to a natural order during distribution
72958e4ac7eaSMatthew G. Knepley 
72968e4ac7eaSMatthew G. Knepley   Level: beginner
72978e4ac7eaSMatthew G. Knepley 
72988e4ac7eaSMatthew G. Knepley .seealso: DMSetUseNatural(), DMCreate()
72998e4ac7eaSMatthew G. Knepley @*/
73008e4ac7eaSMatthew G. Knepley PetscErrorCode DMGetUseNatural(DM dm, PetscBool *useNatural)
73018e4ac7eaSMatthew G. Knepley {
73028e4ac7eaSMatthew G. Knepley   PetscFunctionBegin;
73038e4ac7eaSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7304534a8f05SLisandro Dalcin   PetscValidBoolPointer(useNatural, 2);
73058e4ac7eaSMatthew G. Knepley   *useNatural = dm->useNatural;
73068e4ac7eaSMatthew G. Knepley   PetscFunctionReturn(0);
73078e4ac7eaSMatthew G. Knepley }
73088e4ac7eaSMatthew G. Knepley 
73098e4ac7eaSMatthew G. Knepley /*@
73105d3b26e6SMatthew G. Knepley   DMSetUseNatural - Set the flag for creating a mapping to the natural order after distribution
73118e4ac7eaSMatthew G. Knepley 
73128e4ac7eaSMatthew G. Knepley   Collective on dm
73138e4ac7eaSMatthew G. Knepley 
73148e4ac7eaSMatthew G. Knepley   Input Parameters:
73158e4ac7eaSMatthew G. Knepley + dm - The DM
73168e4ac7eaSMatthew G. Knepley - useNatural - The flag to build the mapping to a natural order during distribution
73178e4ac7eaSMatthew G. Knepley 
73185d3b26e6SMatthew G. Knepley   Note: This also causes the map to be build after DMCreateSubDM() and DMCreateSuperDM()
73195d3b26e6SMatthew G. Knepley 
73208e4ac7eaSMatthew G. Knepley   Level: beginner
73218e4ac7eaSMatthew G. Knepley 
73225d3b26e6SMatthew G. Knepley .seealso: DMGetUseNatural(), DMCreate(), DMPlexDistribute(), DMCreateSubDM(), DMCreateSuperDM()
73238e4ac7eaSMatthew G. Knepley @*/
73248e4ac7eaSMatthew G. Knepley PetscErrorCode DMSetUseNatural(DM dm, PetscBool useNatural)
73258e4ac7eaSMatthew G. Knepley {
73268e4ac7eaSMatthew G. Knepley   PetscFunctionBegin;
73278e4ac7eaSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
73288833efb5SBlaise Bourdin   PetscValidLogicalCollectiveBool(dm, useNatural, 2);
73298e4ac7eaSMatthew G. Knepley   dm->useNatural = useNatural;
73308e4ac7eaSMatthew G. Knepley   PetscFunctionReturn(0);
73318e4ac7eaSMatthew G. Knepley }
7332c58f1c22SToby Isaac 
7333c58f1c22SToby Isaac /*@C
7334c58f1c22SToby Isaac   DMCreateLabel - Create a label of the given name if it does not already exist
7335c58f1c22SToby Isaac 
7336c58f1c22SToby Isaac   Not Collective
7337c58f1c22SToby Isaac 
7338c58f1c22SToby Isaac   Input Parameters:
7339c58f1c22SToby Isaac + dm   - The DM object
7340c58f1c22SToby Isaac - name - The label name
7341c58f1c22SToby Isaac 
7342c58f1c22SToby Isaac   Level: intermediate
7343c58f1c22SToby Isaac 
7344c58f1c22SToby Isaac .seealso: DMLabelCreate(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7345c58f1c22SToby Isaac @*/
7346c58f1c22SToby Isaac PetscErrorCode DMCreateLabel(DM dm, const char name[])
7347c58f1c22SToby Isaac {
73485d80c0bfSVaclav Hapla   PetscBool      flg;
73495d80c0bfSVaclav Hapla   DMLabel        label;
7350c58f1c22SToby Isaac   PetscErrorCode ierr;
7351c58f1c22SToby Isaac 
7352c58f1c22SToby Isaac   PetscFunctionBegin;
7353c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7354c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
73555d80c0bfSVaclav Hapla   ierr = DMHasLabel(dm, name, &flg);CHKERRQ(ierr);
7356c58f1c22SToby Isaac   if (!flg) {
73575d80c0bfSVaclav Hapla     ierr = DMLabelCreate(PETSC_COMM_SELF, name, &label);CHKERRQ(ierr);
73585d80c0bfSVaclav Hapla     ierr = DMAddLabel(dm, label);CHKERRQ(ierr);
73595d80c0bfSVaclav Hapla     ierr = DMLabelDestroy(&label);CHKERRQ(ierr);
7360c58f1c22SToby Isaac   }
7361c58f1c22SToby Isaac   PetscFunctionReturn(0);
7362c58f1c22SToby Isaac }
7363c58f1c22SToby Isaac 
7364c58f1c22SToby Isaac /*@C
73650fdc7489SMatthew Knepley   DMCreateLabelAtIndex - Create a label of the given name at the iven index. If it already exists, move it to this index.
73660fdc7489SMatthew Knepley 
73670fdc7489SMatthew Knepley   Not Collective
73680fdc7489SMatthew Knepley 
73690fdc7489SMatthew Knepley   Input Parameters:
73700fdc7489SMatthew Knepley + dm   - The DM object
73710fdc7489SMatthew Knepley . l    - The index for the label
73720fdc7489SMatthew Knepley - name - The label name
73730fdc7489SMatthew Knepley 
73740fdc7489SMatthew Knepley   Level: intermediate
73750fdc7489SMatthew Knepley 
73760fdc7489SMatthew Knepley .seealso: DMCreateLabel(), DMLabelCreate(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
73770fdc7489SMatthew Knepley @*/
73780fdc7489SMatthew Knepley PetscErrorCode DMCreateLabelAtIndex(DM dm, PetscInt l, const char name[])
73790fdc7489SMatthew Knepley {
73800fdc7489SMatthew Knepley   DMLabelLink    orig, prev = NULL;
73810fdc7489SMatthew Knepley   DMLabel        label;
73820fdc7489SMatthew Knepley   PetscInt       Nl, m;
73830fdc7489SMatthew Knepley   PetscBool      flg, match;
73840fdc7489SMatthew Knepley   const char    *lname;
73850fdc7489SMatthew Knepley   PetscErrorCode ierr;
73860fdc7489SMatthew Knepley 
73870fdc7489SMatthew Knepley   PetscFunctionBegin;
73880fdc7489SMatthew Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7389064a246eSJacob Faibussowitsch   PetscValidCharPointer(name, 3);
73900fdc7489SMatthew Knepley   ierr = DMHasLabel(dm, name, &flg);CHKERRQ(ierr);
73910fdc7489SMatthew Knepley   if (!flg) {
73920fdc7489SMatthew Knepley     ierr = DMLabelCreate(PETSC_COMM_SELF, name, &label);CHKERRQ(ierr);
73930fdc7489SMatthew Knepley     ierr = DMAddLabel(dm, label);CHKERRQ(ierr);
73940fdc7489SMatthew Knepley     ierr = DMLabelDestroy(&label);CHKERRQ(ierr);
73950fdc7489SMatthew Knepley   }
73960fdc7489SMatthew Knepley   ierr = DMGetNumLabels(dm, &Nl);CHKERRQ(ierr);
73970fdc7489SMatthew Knepley   if (l >= Nl) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label index %D must be in [0, %D)", l, Nl);
73980fdc7489SMatthew Knepley   for (m = 0, orig = dm->labels; m < Nl; ++m, prev = orig, orig = orig->next) {
73990fdc7489SMatthew Knepley     ierr = PetscObjectGetName((PetscObject) orig->label, &lname);CHKERRQ(ierr);
74000fdc7489SMatthew Knepley     ierr = PetscStrcmp(name, lname, &match);CHKERRQ(ierr);
74010fdc7489SMatthew Knepley     if (match) break;
74020fdc7489SMatthew Knepley   }
74030fdc7489SMatthew Knepley   if (m == l) PetscFunctionReturn(0);
74040fdc7489SMatthew Knepley   if (!m) dm->labels = orig->next;
74050fdc7489SMatthew Knepley   else    prev->next = orig->next;
74060fdc7489SMatthew Knepley   if (!l) {
74070fdc7489SMatthew Knepley     orig->next = dm->labels;
74080fdc7489SMatthew Knepley     dm->labels = orig;
74090fdc7489SMatthew Knepley   } else {
74100fdc7489SMatthew Knepley     for (m = 0, prev = dm->labels; m < l-1; ++m, prev = prev->next);
74110fdc7489SMatthew Knepley     orig->next = prev->next;
74120fdc7489SMatthew Knepley     prev->next = orig;
74130fdc7489SMatthew Knepley   }
74140fdc7489SMatthew Knepley   PetscFunctionReturn(0);
74150fdc7489SMatthew Knepley }
74160fdc7489SMatthew Knepley 
74170fdc7489SMatthew Knepley /*@C
7418c58f1c22SToby Isaac   DMGetLabelValue - Get the value in a Sieve Label for the given point, with 0 as the default
7419c58f1c22SToby Isaac 
7420c58f1c22SToby Isaac   Not Collective
7421c58f1c22SToby Isaac 
7422c58f1c22SToby Isaac   Input Parameters:
7423c58f1c22SToby Isaac + dm   - The DM object
7424c58f1c22SToby Isaac . name - The label name
7425c58f1c22SToby Isaac - point - The mesh point
7426c58f1c22SToby Isaac 
7427c58f1c22SToby Isaac   Output Parameter:
7428c58f1c22SToby Isaac . value - The label value for this point, or -1 if the point is not in the label
7429c58f1c22SToby Isaac 
7430c58f1c22SToby Isaac   Level: beginner
7431c58f1c22SToby Isaac 
7432c58f1c22SToby Isaac .seealso: DMLabelGetValue(), DMSetLabelValue(), DMGetStratumIS()
7433c58f1c22SToby Isaac @*/
7434c58f1c22SToby Isaac PetscErrorCode DMGetLabelValue(DM dm, const char name[], PetscInt point, PetscInt *value)
7435c58f1c22SToby Isaac {
7436c58f1c22SToby Isaac   DMLabel        label;
7437c58f1c22SToby Isaac   PetscErrorCode ierr;
7438c58f1c22SToby Isaac 
7439c58f1c22SToby Isaac   PetscFunctionBegin;
7440c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7441c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7442c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
744313903a91SSatish Balay   if (!label) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "No label named %s was found", name);
7444c58f1c22SToby Isaac   ierr = DMLabelGetValue(label, point, value);CHKERRQ(ierr);
7445c58f1c22SToby Isaac   PetscFunctionReturn(0);
7446c58f1c22SToby Isaac }
7447c58f1c22SToby Isaac 
7448c58f1c22SToby Isaac /*@C
7449c58f1c22SToby Isaac   DMSetLabelValue - Add a point to a Sieve Label with given value
7450c58f1c22SToby Isaac 
7451c58f1c22SToby Isaac   Not Collective
7452c58f1c22SToby Isaac 
7453c58f1c22SToby Isaac   Input Parameters:
7454c58f1c22SToby Isaac + dm   - The DM object
7455c58f1c22SToby Isaac . name - The label name
7456c58f1c22SToby Isaac . point - The mesh point
7457c58f1c22SToby Isaac - value - The label value for this point
7458c58f1c22SToby Isaac 
7459c58f1c22SToby Isaac   Output Parameter:
7460c58f1c22SToby Isaac 
7461c58f1c22SToby Isaac   Level: beginner
7462c58f1c22SToby Isaac 
7463c58f1c22SToby Isaac .seealso: DMLabelSetValue(), DMGetStratumIS(), DMClearLabelValue()
7464c58f1c22SToby Isaac @*/
7465c58f1c22SToby Isaac PetscErrorCode DMSetLabelValue(DM dm, const char name[], PetscInt point, PetscInt value)
7466c58f1c22SToby Isaac {
7467c58f1c22SToby Isaac   DMLabel        label;
7468c58f1c22SToby Isaac   PetscErrorCode ierr;
7469c58f1c22SToby Isaac 
7470c58f1c22SToby Isaac   PetscFunctionBegin;
7471c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7472c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7473c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7474c58f1c22SToby Isaac   if (!label) {
7475c58f1c22SToby Isaac     ierr = DMCreateLabel(dm, name);CHKERRQ(ierr);
7476c58f1c22SToby Isaac     ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7477c58f1c22SToby Isaac   }
7478c58f1c22SToby Isaac   ierr = DMLabelSetValue(label, point, value);CHKERRQ(ierr);
7479c58f1c22SToby Isaac   PetscFunctionReturn(0);
7480c58f1c22SToby Isaac }
7481c58f1c22SToby Isaac 
7482c58f1c22SToby Isaac /*@C
7483c58f1c22SToby Isaac   DMClearLabelValue - Remove a point from a Sieve Label with given value
7484c58f1c22SToby Isaac 
7485c58f1c22SToby Isaac   Not Collective
7486c58f1c22SToby Isaac 
7487c58f1c22SToby Isaac   Input Parameters:
7488c58f1c22SToby Isaac + dm   - The DM object
7489c58f1c22SToby Isaac . name - The label name
7490c58f1c22SToby Isaac . point - The mesh point
7491c58f1c22SToby Isaac - value - The label value for this point
7492c58f1c22SToby Isaac 
7493c58f1c22SToby Isaac   Output Parameter:
7494c58f1c22SToby Isaac 
7495c58f1c22SToby Isaac   Level: beginner
7496c58f1c22SToby Isaac 
7497c58f1c22SToby Isaac .seealso: DMLabelClearValue(), DMSetLabelValue(), DMGetStratumIS()
7498c58f1c22SToby Isaac @*/
7499c58f1c22SToby Isaac PetscErrorCode DMClearLabelValue(DM dm, const char name[], PetscInt point, PetscInt value)
7500c58f1c22SToby Isaac {
7501c58f1c22SToby Isaac   DMLabel        label;
7502c58f1c22SToby Isaac   PetscErrorCode ierr;
7503c58f1c22SToby Isaac 
7504c58f1c22SToby Isaac   PetscFunctionBegin;
7505c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7506c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7507c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7508c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
7509c58f1c22SToby Isaac   ierr = DMLabelClearValue(label, point, value);CHKERRQ(ierr);
7510c58f1c22SToby Isaac   PetscFunctionReturn(0);
7511c58f1c22SToby Isaac }
7512c58f1c22SToby Isaac 
7513c58f1c22SToby Isaac /*@C
7514c58f1c22SToby Isaac   DMGetLabelSize - Get the number of different integer ids in a Label
7515c58f1c22SToby Isaac 
7516c58f1c22SToby Isaac   Not Collective
7517c58f1c22SToby Isaac 
7518c58f1c22SToby Isaac   Input Parameters:
7519c58f1c22SToby Isaac + dm   - The DM object
7520c58f1c22SToby Isaac - name - The label name
7521c58f1c22SToby Isaac 
7522c58f1c22SToby Isaac   Output Parameter:
7523c58f1c22SToby Isaac . size - The number of different integer ids, or 0 if the label does not exist
7524c58f1c22SToby Isaac 
7525c58f1c22SToby Isaac   Level: beginner
7526c58f1c22SToby Isaac 
7527df813f42SMatthew G. Knepley .seealso: DMLabelGetNumValues(), DMSetLabelValue()
7528c58f1c22SToby Isaac @*/
7529c58f1c22SToby Isaac PetscErrorCode DMGetLabelSize(DM dm, const char name[], PetscInt *size)
7530c58f1c22SToby Isaac {
7531c58f1c22SToby Isaac   DMLabel        label;
7532c58f1c22SToby Isaac   PetscErrorCode ierr;
7533c58f1c22SToby Isaac 
7534c58f1c22SToby Isaac   PetscFunctionBegin;
7535c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7536c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7537534a8f05SLisandro Dalcin   PetscValidIntPointer(size, 3);
7538c58f1c22SToby Isaac   ierr  = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7539c58f1c22SToby Isaac   *size = 0;
7540c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
7541c58f1c22SToby Isaac   ierr = DMLabelGetNumValues(label, size);CHKERRQ(ierr);
7542c58f1c22SToby Isaac   PetscFunctionReturn(0);
7543c58f1c22SToby Isaac }
7544c58f1c22SToby Isaac 
7545c58f1c22SToby Isaac /*@C
7546c58f1c22SToby Isaac   DMGetLabelIdIS - Get the integer ids in a label
7547c58f1c22SToby Isaac 
7548c58f1c22SToby Isaac   Not Collective
7549c58f1c22SToby Isaac 
7550c58f1c22SToby Isaac   Input Parameters:
7551c58f1c22SToby Isaac + mesh - The DM object
7552c58f1c22SToby Isaac - name - The label name
7553c58f1c22SToby Isaac 
7554c58f1c22SToby Isaac   Output Parameter:
7555c58f1c22SToby Isaac . ids - The integer ids, or NULL if the label does not exist
7556c58f1c22SToby Isaac 
7557c58f1c22SToby Isaac   Level: beginner
7558c58f1c22SToby Isaac 
7559c58f1c22SToby Isaac .seealso: DMLabelGetValueIS(), DMGetLabelSize()
7560c58f1c22SToby Isaac @*/
7561c58f1c22SToby Isaac PetscErrorCode DMGetLabelIdIS(DM dm, const char name[], IS *ids)
7562c58f1c22SToby Isaac {
7563c58f1c22SToby Isaac   DMLabel        label;
7564c58f1c22SToby Isaac   PetscErrorCode ierr;
7565c58f1c22SToby Isaac 
7566c58f1c22SToby Isaac   PetscFunctionBegin;
7567c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7568c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7569c58f1c22SToby Isaac   PetscValidPointer(ids, 3);
7570c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7571c58f1c22SToby Isaac   *ids = NULL;
7572dab2e251SBlaise Bourdin  if (label) {
7573c58f1c22SToby Isaac     ierr = DMLabelGetValueIS(label, ids);CHKERRQ(ierr);
7574dab2e251SBlaise Bourdin   } else {
7575dab2e251SBlaise Bourdin     /* returning an empty IS */
7576dab2e251SBlaise Bourdin     ierr = ISCreateGeneral(PETSC_COMM_SELF,0,NULL,PETSC_USE_POINTER,ids);CHKERRQ(ierr);
7577dab2e251SBlaise Bourdin   }
7578c58f1c22SToby Isaac   PetscFunctionReturn(0);
7579c58f1c22SToby Isaac }
7580c58f1c22SToby Isaac 
7581c58f1c22SToby Isaac /*@C
7582c58f1c22SToby Isaac   DMGetStratumSize - Get the number of points in a label stratum
7583c58f1c22SToby Isaac 
7584c58f1c22SToby Isaac   Not Collective
7585c58f1c22SToby Isaac 
7586c58f1c22SToby Isaac   Input Parameters:
7587c58f1c22SToby Isaac + dm - The DM object
7588c58f1c22SToby Isaac . name - The label name
7589c58f1c22SToby Isaac - value - The stratum value
7590c58f1c22SToby Isaac 
7591c58f1c22SToby Isaac   Output Parameter:
7592c58f1c22SToby Isaac . size - The stratum size
7593c58f1c22SToby Isaac 
7594c58f1c22SToby Isaac   Level: beginner
7595c58f1c22SToby Isaac 
7596c58f1c22SToby Isaac .seealso: DMLabelGetStratumSize(), DMGetLabelSize(), DMGetLabelIds()
7597c58f1c22SToby Isaac @*/
7598c58f1c22SToby Isaac PetscErrorCode DMGetStratumSize(DM dm, const char name[], PetscInt value, PetscInt *size)
7599c58f1c22SToby Isaac {
7600c58f1c22SToby Isaac   DMLabel        label;
7601c58f1c22SToby Isaac   PetscErrorCode ierr;
7602c58f1c22SToby Isaac 
7603c58f1c22SToby Isaac   PetscFunctionBegin;
7604c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7605c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7606534a8f05SLisandro Dalcin   PetscValidIntPointer(size, 4);
7607c58f1c22SToby Isaac   ierr  = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7608c58f1c22SToby Isaac   *size = 0;
7609c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
7610c58f1c22SToby Isaac   ierr = DMLabelGetStratumSize(label, value, size);CHKERRQ(ierr);
7611c58f1c22SToby Isaac   PetscFunctionReturn(0);
7612c58f1c22SToby Isaac }
7613c58f1c22SToby Isaac 
7614c58f1c22SToby Isaac /*@C
7615c58f1c22SToby Isaac   DMGetStratumIS - Get the points in a label stratum
7616c58f1c22SToby Isaac 
7617c58f1c22SToby Isaac   Not Collective
7618c58f1c22SToby Isaac 
7619c58f1c22SToby Isaac   Input Parameters:
7620c58f1c22SToby Isaac + dm - The DM object
7621c58f1c22SToby Isaac . name - The label name
7622c58f1c22SToby Isaac - value - The stratum value
7623c58f1c22SToby Isaac 
7624c58f1c22SToby Isaac   Output Parameter:
7625c58f1c22SToby Isaac . points - The stratum points, or NULL if the label does not exist or does not have that value
7626c58f1c22SToby Isaac 
7627c58f1c22SToby Isaac   Level: beginner
7628c58f1c22SToby Isaac 
7629c58f1c22SToby Isaac .seealso: DMLabelGetStratumIS(), DMGetStratumSize()
7630c58f1c22SToby Isaac @*/
7631c58f1c22SToby Isaac PetscErrorCode DMGetStratumIS(DM dm, const char name[], PetscInt value, IS *points)
7632c58f1c22SToby Isaac {
7633c58f1c22SToby Isaac   DMLabel        label;
7634c58f1c22SToby Isaac   PetscErrorCode ierr;
7635c58f1c22SToby Isaac 
7636c58f1c22SToby Isaac   PetscFunctionBegin;
7637c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7638c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7639c58f1c22SToby Isaac   PetscValidPointer(points, 4);
7640c58f1c22SToby Isaac   ierr    = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7641c58f1c22SToby Isaac   *points = NULL;
7642c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
7643c58f1c22SToby Isaac   ierr = DMLabelGetStratumIS(label, value, points);CHKERRQ(ierr);
7644c58f1c22SToby Isaac   PetscFunctionReturn(0);
7645c58f1c22SToby Isaac }
7646c58f1c22SToby Isaac 
76474de306b1SToby Isaac /*@C
76489044fa66SMatthew G. Knepley   DMSetStratumIS - Set the points in a label stratum
76494de306b1SToby Isaac 
76504de306b1SToby Isaac   Not Collective
76514de306b1SToby Isaac 
76524de306b1SToby Isaac   Input Parameters:
76534de306b1SToby Isaac + dm - The DM object
76544de306b1SToby Isaac . name - The label name
76554de306b1SToby Isaac . value - The stratum value
76564de306b1SToby Isaac - points - The stratum points
76574de306b1SToby Isaac 
76584de306b1SToby Isaac   Level: beginner
76594de306b1SToby Isaac 
76604de306b1SToby Isaac .seealso: DMLabelSetStratumIS(), DMGetStratumSize()
76614de306b1SToby Isaac @*/
76624de306b1SToby Isaac PetscErrorCode DMSetStratumIS(DM dm, const char name[], PetscInt value, IS points)
76634de306b1SToby Isaac {
76644de306b1SToby Isaac   DMLabel        label;
76654de306b1SToby Isaac   PetscErrorCode ierr;
76664de306b1SToby Isaac 
76674de306b1SToby Isaac   PetscFunctionBegin;
76684de306b1SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
76694de306b1SToby Isaac   PetscValidCharPointer(name, 2);
76704de306b1SToby Isaac   PetscValidPointer(points, 4);
76714de306b1SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
76724de306b1SToby Isaac   if (!label) PetscFunctionReturn(0);
76734de306b1SToby Isaac   ierr = DMLabelSetStratumIS(label, value, points);CHKERRQ(ierr);
76744de306b1SToby Isaac   PetscFunctionReturn(0);
76754de306b1SToby Isaac }
76764de306b1SToby Isaac 
7677c58f1c22SToby Isaac /*@C
7678c58f1c22SToby Isaac   DMClearLabelStratum - Remove all points from a stratum from a Sieve Label
7679c58f1c22SToby Isaac 
7680c58f1c22SToby Isaac   Not Collective
7681c58f1c22SToby Isaac 
7682c58f1c22SToby Isaac   Input Parameters:
7683c58f1c22SToby Isaac + dm   - The DM object
7684c58f1c22SToby Isaac . name - The label name
7685c58f1c22SToby Isaac - value - The label value for this point
7686c58f1c22SToby Isaac 
7687c58f1c22SToby Isaac   Output Parameter:
7688c58f1c22SToby Isaac 
7689c58f1c22SToby Isaac   Level: beginner
7690c58f1c22SToby Isaac 
7691c58f1c22SToby Isaac .seealso: DMLabelClearStratum(), DMSetLabelValue(), DMGetStratumIS(), DMClearLabelValue()
7692c58f1c22SToby Isaac @*/
7693c58f1c22SToby Isaac PetscErrorCode DMClearLabelStratum(DM dm, const char name[], PetscInt value)
7694c58f1c22SToby Isaac {
7695c58f1c22SToby Isaac   DMLabel        label;
7696c58f1c22SToby Isaac   PetscErrorCode ierr;
7697c58f1c22SToby Isaac 
7698c58f1c22SToby Isaac   PetscFunctionBegin;
7699c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7700c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7701c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7702c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
7703c58f1c22SToby Isaac   ierr = DMLabelClearStratum(label, value);CHKERRQ(ierr);
7704c58f1c22SToby Isaac   PetscFunctionReturn(0);
7705c58f1c22SToby Isaac }
7706c58f1c22SToby Isaac 
7707c58f1c22SToby Isaac /*@
7708c58f1c22SToby Isaac   DMGetNumLabels - Return the number of labels defined by the mesh
7709c58f1c22SToby Isaac 
7710c58f1c22SToby Isaac   Not Collective
7711c58f1c22SToby Isaac 
7712c58f1c22SToby Isaac   Input Parameter:
7713c58f1c22SToby Isaac . dm   - The DM object
7714c58f1c22SToby Isaac 
7715c58f1c22SToby Isaac   Output Parameter:
7716c58f1c22SToby Isaac . numLabels - the number of Labels
7717c58f1c22SToby Isaac 
7718c58f1c22SToby Isaac   Level: intermediate
7719c58f1c22SToby Isaac 
7720c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7721c58f1c22SToby Isaac @*/
7722c58f1c22SToby Isaac PetscErrorCode DMGetNumLabels(DM dm, PetscInt *numLabels)
7723c58f1c22SToby Isaac {
77245d80c0bfSVaclav Hapla   DMLabelLink next = dm->labels;
7725c58f1c22SToby Isaac   PetscInt  n    = 0;
7726c58f1c22SToby Isaac 
7727c58f1c22SToby Isaac   PetscFunctionBegin;
7728c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7729534a8f05SLisandro Dalcin   PetscValidIntPointer(numLabels, 2);
7730c58f1c22SToby Isaac   while (next) {++n; next = next->next;}
7731c58f1c22SToby Isaac   *numLabels = n;
7732c58f1c22SToby Isaac   PetscFunctionReturn(0);
7733c58f1c22SToby Isaac }
7734c58f1c22SToby Isaac 
7735c58f1c22SToby Isaac /*@C
7736c58f1c22SToby Isaac   DMGetLabelName - Return the name of nth label
7737c58f1c22SToby Isaac 
7738c58f1c22SToby Isaac   Not Collective
7739c58f1c22SToby Isaac 
7740c58f1c22SToby Isaac   Input Parameters:
7741c58f1c22SToby Isaac + dm - The DM object
7742c58f1c22SToby Isaac - n  - the label number
7743c58f1c22SToby Isaac 
7744c58f1c22SToby Isaac   Output Parameter:
7745c58f1c22SToby Isaac . name - the label name
7746c58f1c22SToby Isaac 
7747c58f1c22SToby Isaac   Level: intermediate
7748c58f1c22SToby Isaac 
7749c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7750c58f1c22SToby Isaac @*/
7751c58f1c22SToby Isaac PetscErrorCode DMGetLabelName(DM dm, PetscInt n, const char **name)
7752c58f1c22SToby Isaac {
77535d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
7754c58f1c22SToby Isaac   PetscInt       l    = 0;
7755d67d17b1SMatthew G. Knepley   PetscErrorCode ierr;
7756c58f1c22SToby Isaac 
7757c58f1c22SToby Isaac   PetscFunctionBegin;
7758c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7759c58f1c22SToby Isaac   PetscValidPointer(name, 3);
7760c58f1c22SToby Isaac   while (next) {
7761c58f1c22SToby Isaac     if (l == n) {
7762d67d17b1SMatthew G. Knepley       ierr = PetscObjectGetName((PetscObject) next->label, name);CHKERRQ(ierr);
7763c58f1c22SToby Isaac       PetscFunctionReturn(0);
7764c58f1c22SToby Isaac     }
7765c58f1c22SToby Isaac     ++l;
7766c58f1c22SToby Isaac     next = next->next;
7767c58f1c22SToby Isaac   }
7768c58f1c22SToby Isaac   SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %D does not exist in this DM", n);
7769c58f1c22SToby Isaac }
7770c58f1c22SToby Isaac 
7771c58f1c22SToby Isaac /*@C
7772c58f1c22SToby Isaac   DMHasLabel - Determine whether the mesh has a label of a given name
7773c58f1c22SToby Isaac 
7774c58f1c22SToby Isaac   Not Collective
7775c58f1c22SToby Isaac 
7776c58f1c22SToby Isaac   Input Parameters:
7777c58f1c22SToby Isaac + dm   - The DM object
7778c58f1c22SToby Isaac - name - The label name
7779c58f1c22SToby Isaac 
7780c58f1c22SToby Isaac   Output Parameter:
7781c58f1c22SToby Isaac . hasLabel - PETSC_TRUE if the label is present
7782c58f1c22SToby Isaac 
7783c58f1c22SToby Isaac   Level: intermediate
7784c58f1c22SToby Isaac 
7785c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7786c58f1c22SToby Isaac @*/
7787c58f1c22SToby Isaac PetscErrorCode DMHasLabel(DM dm, const char name[], PetscBool *hasLabel)
7788c58f1c22SToby Isaac {
77895d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
7790d67d17b1SMatthew G. Knepley   const char    *lname;
7791c58f1c22SToby Isaac   PetscErrorCode ierr;
7792c58f1c22SToby Isaac 
7793c58f1c22SToby Isaac   PetscFunctionBegin;
7794c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7795c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7796534a8f05SLisandro Dalcin   PetscValidBoolPointer(hasLabel, 3);
7797c58f1c22SToby Isaac   *hasLabel = PETSC_FALSE;
7798c58f1c22SToby Isaac   while (next) {
7799d67d17b1SMatthew G. Knepley     ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr);
7800d67d17b1SMatthew G. Knepley     ierr = PetscStrcmp(name, lname, hasLabel);CHKERRQ(ierr);
7801c58f1c22SToby Isaac     if (*hasLabel) break;
7802c58f1c22SToby Isaac     next = next->next;
7803c58f1c22SToby Isaac   }
7804c58f1c22SToby Isaac   PetscFunctionReturn(0);
7805c58f1c22SToby Isaac }
7806c58f1c22SToby Isaac 
7807c58f1c22SToby Isaac /*@C
7808c58f1c22SToby Isaac   DMGetLabel - Return the label of a given name, or NULL
7809c58f1c22SToby Isaac 
7810c58f1c22SToby Isaac   Not Collective
7811c58f1c22SToby Isaac 
7812c58f1c22SToby Isaac   Input Parameters:
7813c58f1c22SToby Isaac + dm   - The DM object
7814c58f1c22SToby Isaac - name - The label name
7815c58f1c22SToby Isaac 
7816c58f1c22SToby Isaac   Output Parameter:
7817c58f1c22SToby Isaac . label - The DMLabel, or NULL if the label is absent
7818c58f1c22SToby Isaac 
78196d7c9049SMatthew G. Knepley   Note: Some of the default labels in a DMPlex will be
78206d7c9049SMatthew G. Knepley $ "depth"       - Holds the depth (co-dimension) of each mesh point
78216d7c9049SMatthew G. Knepley $ "celltype"    - Holds the topological type of each cell
78226d7c9049SMatthew G. Knepley $ "ghost"       - If the DM is distributed with overlap, this marks the cells and faces in the overlap
78236d7c9049SMatthew G. Knepley $ "Cell Sets"   - Mirrors the cell sets defined by GMsh and ExodusII
78246d7c9049SMatthew G. Knepley $ "Face Sets"   - Mirrors the face sets defined by GMsh and ExodusII
78256d7c9049SMatthew G. Knepley $ "Vertex Sets" - Mirrors the vertex sets defined by GMsh
78266d7c9049SMatthew G. Knepley 
7827c58f1c22SToby Isaac   Level: intermediate
7828c58f1c22SToby Isaac 
78296d7c9049SMatthew G. Knepley .seealso: DMCreateLabel(), DMHasLabel(), DMPlexGetDepthLabel(), DMPlexGetCellType()
7830c58f1c22SToby Isaac @*/
7831c58f1c22SToby Isaac PetscErrorCode DMGetLabel(DM dm, const char name[], DMLabel *label)
7832c58f1c22SToby Isaac {
78335d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
7834c58f1c22SToby Isaac   PetscBool      hasLabel;
7835d67d17b1SMatthew G. Knepley   const char    *lname;
7836c58f1c22SToby Isaac   PetscErrorCode ierr;
7837c58f1c22SToby Isaac 
7838c58f1c22SToby Isaac   PetscFunctionBegin;
7839c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7840c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7841c58f1c22SToby Isaac   PetscValidPointer(label, 3);
7842c58f1c22SToby Isaac   *label = NULL;
7843c58f1c22SToby Isaac   while (next) {
7844d67d17b1SMatthew G. Knepley     ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr);
7845d67d17b1SMatthew G. Knepley     ierr = PetscStrcmp(name, lname, &hasLabel);CHKERRQ(ierr);
7846c58f1c22SToby Isaac     if (hasLabel) {
7847c58f1c22SToby Isaac       *label = next->label;
7848c58f1c22SToby Isaac       break;
7849c58f1c22SToby Isaac     }
7850c58f1c22SToby Isaac     next = next->next;
7851c58f1c22SToby Isaac   }
7852c58f1c22SToby Isaac   PetscFunctionReturn(0);
7853c58f1c22SToby Isaac }
7854c58f1c22SToby Isaac 
7855c58f1c22SToby Isaac /*@C
7856c58f1c22SToby Isaac   DMGetLabelByNum - Return the nth label
7857c58f1c22SToby Isaac 
7858c58f1c22SToby Isaac   Not Collective
7859c58f1c22SToby Isaac 
7860c58f1c22SToby Isaac   Input Parameters:
7861c58f1c22SToby Isaac + dm - The DM object
7862c58f1c22SToby Isaac - n  - the label number
7863c58f1c22SToby Isaac 
7864c58f1c22SToby Isaac   Output Parameter:
7865c58f1c22SToby Isaac . label - the label
7866c58f1c22SToby Isaac 
7867c58f1c22SToby Isaac   Level: intermediate
7868c58f1c22SToby Isaac 
7869c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7870c58f1c22SToby Isaac @*/
7871c58f1c22SToby Isaac PetscErrorCode DMGetLabelByNum(DM dm, PetscInt n, DMLabel *label)
7872c58f1c22SToby Isaac {
78735d80c0bfSVaclav Hapla   DMLabelLink next = dm->labels;
7874c58f1c22SToby Isaac   PetscInt    l    = 0;
7875c58f1c22SToby Isaac 
7876c58f1c22SToby Isaac   PetscFunctionBegin;
7877c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7878c58f1c22SToby Isaac   PetscValidPointer(label, 3);
7879c58f1c22SToby Isaac   while (next) {
7880c58f1c22SToby Isaac     if (l == n) {
7881c58f1c22SToby Isaac       *label = next->label;
7882c58f1c22SToby Isaac       PetscFunctionReturn(0);
7883c58f1c22SToby Isaac     }
7884c58f1c22SToby Isaac     ++l;
7885c58f1c22SToby Isaac     next = next->next;
7886c58f1c22SToby Isaac   }
7887c58f1c22SToby Isaac   SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %D does not exist in this DM", n);
7888c58f1c22SToby Isaac }
7889c58f1c22SToby Isaac 
7890c58f1c22SToby Isaac /*@C
7891c58f1c22SToby Isaac   DMAddLabel - Add the label to this mesh
7892c58f1c22SToby Isaac 
7893c58f1c22SToby Isaac   Not Collective
7894c58f1c22SToby Isaac 
7895c58f1c22SToby Isaac   Input Parameters:
7896c58f1c22SToby Isaac + dm   - The DM object
7897c58f1c22SToby Isaac - label - The DMLabel
7898c58f1c22SToby Isaac 
7899c58f1c22SToby Isaac   Level: developer
7900c58f1c22SToby Isaac 
7901c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7902c58f1c22SToby Isaac @*/
7903c58f1c22SToby Isaac PetscErrorCode DMAddLabel(DM dm, DMLabel label)
7904c58f1c22SToby Isaac {
79055d80c0bfSVaclav Hapla   DMLabelLink    l, *p, tmpLabel;
7906c58f1c22SToby Isaac   PetscBool      hasLabel;
7907d67d17b1SMatthew G. Knepley   const char    *lname;
79085d80c0bfSVaclav Hapla   PetscBool      flg;
7909c58f1c22SToby Isaac   PetscErrorCode ierr;
7910c58f1c22SToby Isaac 
7911c58f1c22SToby Isaac   PetscFunctionBegin;
7912c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7913d67d17b1SMatthew G. Knepley   ierr = PetscObjectGetName((PetscObject) label, &lname);CHKERRQ(ierr);
7914d67d17b1SMatthew G. Knepley   ierr = DMHasLabel(dm, lname, &hasLabel);CHKERRQ(ierr);
7915d67d17b1SMatthew G. Knepley   if (hasLabel) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %s already exists in this DM", lname);
7916c58f1c22SToby Isaac   ierr = PetscCalloc1(1, &tmpLabel);CHKERRQ(ierr);
7917c58f1c22SToby Isaac   tmpLabel->label  = label;
7918c58f1c22SToby Isaac   tmpLabel->output = PETSC_TRUE;
79195d80c0bfSVaclav Hapla   for (p=&dm->labels; (l=*p); p=&l->next) {}
79205d80c0bfSVaclav Hapla   *p = tmpLabel;
792108f633c4SVaclav Hapla   ierr = PetscObjectReference((PetscObject)label);CHKERRQ(ierr);
79225d80c0bfSVaclav Hapla   ierr = PetscStrcmp(lname, "depth", &flg);CHKERRQ(ierr);
79235d80c0bfSVaclav Hapla   if (flg) dm->depthLabel = label;
7924ba2698f1SMatthew G. Knepley   ierr = PetscStrcmp(lname, "celltype", &flg);CHKERRQ(ierr);
7925ba2698f1SMatthew G. Knepley   if (flg) dm->celltypeLabel = label;
7926c58f1c22SToby Isaac   PetscFunctionReturn(0);
7927c58f1c22SToby Isaac }
7928c58f1c22SToby Isaac 
7929c58f1c22SToby Isaac /*@C
79304a7ee7d0SMatthew G. Knepley   DMSetLabel - Replaces the label of a given name, or ignores it if the name is not present
79314a7ee7d0SMatthew G. Knepley 
79324a7ee7d0SMatthew G. Knepley   Not Collective
79334a7ee7d0SMatthew G. Knepley 
79344a7ee7d0SMatthew G. Knepley   Input Parameters:
79354a7ee7d0SMatthew G. Knepley + dm    - The DM object
79364a7ee7d0SMatthew G. Knepley - label - The DMLabel, having the same name, to substitute
79374a7ee7d0SMatthew G. Knepley 
79384a7ee7d0SMatthew G. Knepley   Note: Some of the default labels in a DMPlex will be
79394a7ee7d0SMatthew G. Knepley $ "depth"       - Holds the depth (co-dimension) of each mesh point
79404a7ee7d0SMatthew G. Knepley $ "celltype"    - Holds the topological type of each cell
79414a7ee7d0SMatthew G. Knepley $ "ghost"       - If the DM is distributed with overlap, this marks the cells and faces in the overlap
79424a7ee7d0SMatthew G. Knepley $ "Cell Sets"   - Mirrors the cell sets defined by GMsh and ExodusII
79434a7ee7d0SMatthew G. Knepley $ "Face Sets"   - Mirrors the face sets defined by GMsh and ExodusII
79444a7ee7d0SMatthew G. Knepley $ "Vertex Sets" - Mirrors the vertex sets defined by GMsh
79454a7ee7d0SMatthew G. Knepley 
79464a7ee7d0SMatthew G. Knepley   Level: intermediate
79474a7ee7d0SMatthew G. Knepley 
79484a7ee7d0SMatthew G. Knepley .seealso: DMCreateLabel(), DMHasLabel(), DMPlexGetDepthLabel(), DMPlexGetCellType()
79494a7ee7d0SMatthew G. Knepley @*/
79504a7ee7d0SMatthew G. Knepley PetscErrorCode DMSetLabel(DM dm, DMLabel label)
79514a7ee7d0SMatthew G. Knepley {
79524a7ee7d0SMatthew G. Knepley   DMLabelLink    next = dm->labels;
79534a7ee7d0SMatthew G. Knepley   PetscBool      hasLabel, flg;
79544a7ee7d0SMatthew G. Knepley   const char    *name, *lname;
79554a7ee7d0SMatthew G. Knepley   PetscErrorCode ierr;
79564a7ee7d0SMatthew G. Knepley 
79574a7ee7d0SMatthew G. Knepley   PetscFunctionBegin;
79584a7ee7d0SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
79594a7ee7d0SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
79604a7ee7d0SMatthew G. Knepley   ierr = PetscObjectGetName((PetscObject) label, &name);CHKERRQ(ierr);
79614a7ee7d0SMatthew G. Knepley   while (next) {
79624a7ee7d0SMatthew G. Knepley     ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr);
79634a7ee7d0SMatthew G. Knepley     ierr = PetscStrcmp(name, lname, &hasLabel);CHKERRQ(ierr);
79644a7ee7d0SMatthew G. Knepley     if (hasLabel) {
79654a7ee7d0SMatthew G. Knepley       ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr);
79664a7ee7d0SMatthew G. Knepley       ierr = PetscStrcmp(lname, "depth", &flg);CHKERRQ(ierr);
79674a7ee7d0SMatthew G. Knepley       if (flg) dm->depthLabel = label;
79684a7ee7d0SMatthew G. Knepley       ierr = PetscStrcmp(lname, "celltype", &flg);CHKERRQ(ierr);
79694a7ee7d0SMatthew G. Knepley       if (flg) dm->celltypeLabel = label;
79704a7ee7d0SMatthew G. Knepley       ierr = DMLabelDestroy(&next->label);CHKERRQ(ierr);
79714a7ee7d0SMatthew G. Knepley       next->label = label;
79724a7ee7d0SMatthew G. Knepley       break;
79734a7ee7d0SMatthew G. Knepley     }
79744a7ee7d0SMatthew G. Knepley     next = next->next;
79754a7ee7d0SMatthew G. Knepley   }
79764a7ee7d0SMatthew G. Knepley   PetscFunctionReturn(0);
79774a7ee7d0SMatthew G. Knepley }
79784a7ee7d0SMatthew G. Knepley 
79794a7ee7d0SMatthew G. Knepley /*@C
7980e5472504SVaclav Hapla   DMRemoveLabel - Remove the label given by name from this mesh
7981c58f1c22SToby Isaac 
7982c58f1c22SToby Isaac   Not Collective
7983c58f1c22SToby Isaac 
7984c58f1c22SToby Isaac   Input Parameters:
7985c58f1c22SToby Isaac + dm   - The DM object
7986c58f1c22SToby Isaac - name - The label name
7987c58f1c22SToby Isaac 
7988c58f1c22SToby Isaac   Output Parameter:
7989c58f1c22SToby Isaac . label - The DMLabel, or NULL if the label is absent
7990c58f1c22SToby Isaac 
7991c58f1c22SToby Isaac   Level: developer
7992c58f1c22SToby Isaac 
7993e5472504SVaclav Hapla   Notes:
7994e5472504SVaclav Hapla   DMRemoveLabel(dm,name,NULL) removes the label from dm and calls
7995e5472504SVaclav Hapla   DMLabelDestroy() on the label.
7996e5472504SVaclav Hapla 
7997e5472504SVaclav Hapla   DMRemoveLabel(dm,name,&label) removes the label from dm, but it DOES NOT
7998e5472504SVaclav Hapla   call DMLabelDestroy(). Instead, the label is returned and the user is
7999e5472504SVaclav Hapla   responsible of calling DMLabelDestroy() at some point.
8000e5472504SVaclav Hapla 
8001e5472504SVaclav Hapla .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabel(), DMGetLabelValue(), DMSetLabelValue(), DMLabelDestroy(), DMRemoveLabelBySelf()
8002c58f1c22SToby Isaac @*/
8003c58f1c22SToby Isaac PetscErrorCode DMRemoveLabel(DM dm, const char name[], DMLabel *label)
8004c58f1c22SToby Isaac {
800595d578d6SVaclav Hapla   DMLabelLink    link, *pnext;
8006c58f1c22SToby Isaac   PetscBool      hasLabel;
8007d67d17b1SMatthew G. Knepley   const char    *lname;
8008c58f1c22SToby Isaac   PetscErrorCode ierr;
8009c58f1c22SToby Isaac 
8010c58f1c22SToby Isaac   PetscFunctionBegin;
8011c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8012e5472504SVaclav Hapla   PetscValidCharPointer(name, 2);
8013e5472504SVaclav Hapla   if (label) {
8014e5472504SVaclav Hapla     PetscValidPointer(label, 3);
8015c58f1c22SToby Isaac     *label = NULL;
8016e5472504SVaclav Hapla   }
80175d80c0bfSVaclav Hapla   for (pnext=&dm->labels; (link=*pnext); pnext=&link->next) {
801895d578d6SVaclav Hapla     ierr = PetscObjectGetName((PetscObject) link->label, &lname);CHKERRQ(ierr);
8019d67d17b1SMatthew G. Knepley     ierr = PetscStrcmp(name, lname, &hasLabel);CHKERRQ(ierr);
8020c58f1c22SToby Isaac     if (hasLabel) {
802195d578d6SVaclav Hapla       *pnext = link->next; /* Remove from list */
8022c58f1c22SToby Isaac       ierr = PetscStrcmp(name, "depth", &hasLabel);CHKERRQ(ierr);
802395d578d6SVaclav Hapla       if (hasLabel) dm->depthLabel = NULL;
8024ba2698f1SMatthew G. Knepley       ierr = PetscStrcmp(name, "celltype", &hasLabel);CHKERRQ(ierr);
8025ba2698f1SMatthew G. Knepley       if (hasLabel) dm->celltypeLabel = NULL;
802695d578d6SVaclav Hapla       if (label) *label = link->label;
802795d578d6SVaclav Hapla       else       {ierr = DMLabelDestroy(&link->label);CHKERRQ(ierr);}
802895d578d6SVaclav Hapla       ierr = PetscFree(link);CHKERRQ(ierr);
8029c58f1c22SToby Isaac       break;
8030c58f1c22SToby Isaac     }
8031c58f1c22SToby Isaac   }
8032c58f1c22SToby Isaac   PetscFunctionReturn(0);
8033c58f1c22SToby Isaac }
8034c58f1c22SToby Isaac 
8035306894acSVaclav Hapla /*@
8036306894acSVaclav Hapla   DMRemoveLabelBySelf - Remove the label from this mesh
8037306894acSVaclav Hapla 
8038306894acSVaclav Hapla   Not Collective
8039306894acSVaclav Hapla 
8040306894acSVaclav Hapla   Input Parameters:
8041306894acSVaclav Hapla + dm   - The DM object
8042306894acSVaclav Hapla . label - (Optional) The DMLabel to be removed from the DM
8043306894acSVaclav Hapla - failNotFound - Should it fail if the label is not found in the DM?
8044306894acSVaclav Hapla 
8045306894acSVaclav Hapla   Level: developer
8046306894acSVaclav Hapla 
8047306894acSVaclav Hapla   Notes:
8048306894acSVaclav Hapla   Only exactly the same instance is removed if found, name match is ignored.
8049306894acSVaclav Hapla   If the DM has an exclusive reference to the label, it gets destroyed and
8050306894acSVaclav Hapla   *label nullified.
8051306894acSVaclav Hapla 
8052306894acSVaclav Hapla .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabel() DMGetLabelValue(), DMSetLabelValue(), DMLabelDestroy(), DMRemoveLabel()
8053306894acSVaclav Hapla @*/
8054306894acSVaclav Hapla PetscErrorCode DMRemoveLabelBySelf(DM dm, DMLabel *label, PetscBool failNotFound)
8055306894acSVaclav Hapla {
805643e45a93SVaclav Hapla   DMLabelLink    link, *pnext;
8057306894acSVaclav Hapla   PetscBool      hasLabel = PETSC_FALSE;
8058306894acSVaclav Hapla   PetscErrorCode ierr;
8059306894acSVaclav Hapla 
8060306894acSVaclav Hapla   PetscFunctionBegin;
8061306894acSVaclav Hapla   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8062306894acSVaclav Hapla   PetscValidPointer(label, 2);
8063f39a9ae0SVaclav Hapla   if (!*label && !failNotFound) PetscFunctionReturn(0);
8064306894acSVaclav Hapla   PetscValidHeaderSpecific(*label, DMLABEL_CLASSID, 2);
8065306894acSVaclav Hapla   PetscValidLogicalCollectiveBool(dm,failNotFound,3);
80665d80c0bfSVaclav Hapla   for (pnext=&dm->labels; (link=*pnext); pnext=&link->next) {
806743e45a93SVaclav Hapla     if (*label == link->label) {
8068306894acSVaclav Hapla       hasLabel = PETSC_TRUE;
806943e45a93SVaclav Hapla       *pnext = link->next; /* Remove from list */
8070306894acSVaclav Hapla       if (*label == dm->depthLabel) dm->depthLabel = NULL;
8071ba2698f1SMatthew G. Knepley       if (*label == dm->celltypeLabel) dm->celltypeLabel = NULL;
807243e45a93SVaclav Hapla       if (((PetscObject) link->label)->refct < 2) *label = NULL; /* nullify if exclusive reference */
807343e45a93SVaclav Hapla       ierr = DMLabelDestroy(&link->label);CHKERRQ(ierr);
807443e45a93SVaclav Hapla       ierr = PetscFree(link);CHKERRQ(ierr);
8075306894acSVaclav Hapla       break;
8076306894acSVaclav Hapla     }
8077306894acSVaclav Hapla   }
8078306894acSVaclav Hapla   if (!hasLabel && failNotFound) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONG, "Given label not found in DM");
8079306894acSVaclav Hapla   PetscFunctionReturn(0);
8080306894acSVaclav Hapla }
8081306894acSVaclav Hapla 
8082c58f1c22SToby Isaac /*@C
8083c58f1c22SToby Isaac   DMGetLabelOutput - Get the output flag for a given label
8084c58f1c22SToby Isaac 
8085c58f1c22SToby Isaac   Not Collective
8086c58f1c22SToby Isaac 
8087c58f1c22SToby Isaac   Input Parameters:
8088c58f1c22SToby Isaac + dm   - The DM object
8089c58f1c22SToby Isaac - name - The label name
8090c58f1c22SToby Isaac 
8091c58f1c22SToby Isaac   Output Parameter:
8092c58f1c22SToby Isaac . output - The flag for output
8093c58f1c22SToby Isaac 
8094c58f1c22SToby Isaac   Level: developer
8095c58f1c22SToby Isaac 
8096c58f1c22SToby Isaac .seealso: DMSetLabelOutput(), DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
8097c58f1c22SToby Isaac @*/
8098c58f1c22SToby Isaac PetscErrorCode DMGetLabelOutput(DM dm, const char name[], PetscBool *output)
8099c58f1c22SToby Isaac {
81005d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
8101d67d17b1SMatthew G. Knepley   const char    *lname;
8102c58f1c22SToby Isaac   PetscErrorCode ierr;
8103c58f1c22SToby Isaac 
8104c58f1c22SToby Isaac   PetscFunctionBegin;
8105c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8106c58f1c22SToby Isaac   PetscValidPointer(name, 2);
8107c58f1c22SToby Isaac   PetscValidPointer(output, 3);
8108c58f1c22SToby Isaac   while (next) {
8109c58f1c22SToby Isaac     PetscBool flg;
8110c58f1c22SToby Isaac 
8111d67d17b1SMatthew G. Knepley     ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr);
8112d67d17b1SMatthew G. Knepley     ierr = PetscStrcmp(name, lname, &flg);CHKERRQ(ierr);
8113c58f1c22SToby Isaac     if (flg) {*output = next->output; PetscFunctionReturn(0);}
8114c58f1c22SToby Isaac     next = next->next;
8115c58f1c22SToby Isaac   }
8116c58f1c22SToby Isaac   SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "No label named %s was present in this dm", name);
8117c58f1c22SToby Isaac }
8118c58f1c22SToby Isaac 
8119c58f1c22SToby Isaac /*@C
8120c58f1c22SToby Isaac   DMSetLabelOutput - Set the output flag for a given label
8121c58f1c22SToby Isaac 
8122c58f1c22SToby Isaac   Not Collective
8123c58f1c22SToby Isaac 
8124c58f1c22SToby Isaac   Input Parameters:
8125c58f1c22SToby Isaac + dm     - The DM object
8126c58f1c22SToby Isaac . name   - The label name
8127c58f1c22SToby Isaac - output - The flag for output
8128c58f1c22SToby Isaac 
8129c58f1c22SToby Isaac   Level: developer
8130c58f1c22SToby Isaac 
8131c58f1c22SToby Isaac .seealso: DMGetLabelOutput(), DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
8132c58f1c22SToby Isaac @*/
8133c58f1c22SToby Isaac PetscErrorCode DMSetLabelOutput(DM dm, const char name[], PetscBool output)
8134c58f1c22SToby Isaac {
81355d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
8136d67d17b1SMatthew G. Knepley   const char    *lname;
8137c58f1c22SToby Isaac   PetscErrorCode ierr;
8138c58f1c22SToby Isaac 
8139c58f1c22SToby Isaac   PetscFunctionBegin;
8140c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8141534a8f05SLisandro Dalcin   PetscValidCharPointer(name, 2);
8142c58f1c22SToby Isaac   while (next) {
8143c58f1c22SToby Isaac     PetscBool flg;
8144c58f1c22SToby Isaac 
8145d67d17b1SMatthew G. Knepley     ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr);
8146d67d17b1SMatthew G. Knepley     ierr = PetscStrcmp(name, lname, &flg);CHKERRQ(ierr);
8147c58f1c22SToby Isaac     if (flg) {next->output = output; PetscFunctionReturn(0);}
8148c58f1c22SToby Isaac     next = next->next;
8149c58f1c22SToby Isaac   }
8150c58f1c22SToby Isaac   SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "No label named %s was present in this dm", name);
8151c58f1c22SToby Isaac }
8152c58f1c22SToby Isaac 
8153c58f1c22SToby Isaac /*@
8154c58f1c22SToby Isaac   DMCopyLabels - Copy labels from one mesh to another with a superset of the points
8155c58f1c22SToby Isaac 
8156d083f849SBarry Smith   Collective on dmA
8157c58f1c22SToby Isaac 
8158c58f1c22SToby Isaac   Input Parameter:
81595d80c0bfSVaclav Hapla + dmA - The DM object with initial labels
81602e17dfb7SMatthew G. Knepley . dmB - The DM object with copied labels
81615d80c0bfSVaclav Hapla . mode - Copy labels by pointers (PETSC_OWN_POINTER) or duplicate them (PETSC_COPY_VALUES)
8162ba2698f1SMatthew G. Knepley - all  - Copy all labels including "depth", "dim", and "celltype" (PETSC_TRUE) which are otherwise ignored (PETSC_FALSE)
8163c58f1c22SToby Isaac 
8164c58f1c22SToby Isaac   Level: intermediate
8165c58f1c22SToby Isaac 
8166c58f1c22SToby Isaac   Note: This is typically used when interpolating or otherwise adding to a mesh
8167c58f1c22SToby Isaac 
81685d80c0bfSVaclav Hapla .seealso: DMGetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM(), DMGetCoordinateSection(), DMShareLabels()
8169c58f1c22SToby Isaac @*/
81705d80c0bfSVaclav Hapla PetscErrorCode DMCopyLabels(DM dmA, DM dmB, PetscCopyMode mode, PetscBool all)
8171c58f1c22SToby Isaac {
8172c58f1c22SToby Isaac   DMLabel        label, labelNew;
8173c58f1c22SToby Isaac   const char    *name;
8174c58f1c22SToby Isaac   PetscBool      flg;
81755d80c0bfSVaclav Hapla   DMLabelLink    link;
81765d80c0bfSVaclav Hapla   PetscErrorCode ierr;
8177c58f1c22SToby Isaac 
81785d80c0bfSVaclav Hapla   PetscFunctionBegin;
81795d80c0bfSVaclav Hapla   PetscValidHeaderSpecific(dmA, DM_CLASSID, 1);
81805d80c0bfSVaclav Hapla   PetscValidHeaderSpecific(dmB, DM_CLASSID, 2);
81815d80c0bfSVaclav Hapla   PetscValidLogicalCollectiveEnum(dmA, mode,3);
81825d80c0bfSVaclav Hapla   PetscValidLogicalCollectiveBool(dmA, all, 4);
81835d80c0bfSVaclav Hapla   if (mode==PETSC_USE_POINTER) SETERRQ(PetscObjectComm((PetscObject)dmA), PETSC_ERR_SUP, "PETSC_USE_POINTER not supported for objects");
81845d80c0bfSVaclav Hapla   if (dmA == dmB) PetscFunctionReturn(0);
81855d80c0bfSVaclav Hapla   for (link=dmA->labels; link; link=link->next) {
81865d80c0bfSVaclav Hapla     label=link->label;
81875d80c0bfSVaclav Hapla     ierr = PetscObjectGetName((PetscObject)label, &name);CHKERRQ(ierr);
81885d80c0bfSVaclav Hapla     if (!all) {
8189c58f1c22SToby Isaac       ierr = PetscStrcmp(name, "depth", &flg);CHKERRQ(ierr);
8190c58f1c22SToby Isaac       if (flg) continue;
81917d5acc75SStefano Zampini       ierr = PetscStrcmp(name, "dim", &flg);CHKERRQ(ierr);
81927d5acc75SStefano Zampini       if (flg) continue;
8193ba2698f1SMatthew G. Knepley       ierr = PetscStrcmp(name, "celltype", &flg);CHKERRQ(ierr);
8194ba2698f1SMatthew G. Knepley       if (flg) continue;
81955d80c0bfSVaclav Hapla     }
81965d80c0bfSVaclav Hapla     if (mode==PETSC_COPY_VALUES) {
8197c58f1c22SToby Isaac       ierr = DMLabelDuplicate(label, &labelNew);CHKERRQ(ierr);
81985d80c0bfSVaclav Hapla     } else {
81995d80c0bfSVaclav Hapla       labelNew = label;
82005d80c0bfSVaclav Hapla     }
8201c58f1c22SToby Isaac     ierr = DMAddLabel(dmB, labelNew);CHKERRQ(ierr);
82025d80c0bfSVaclav Hapla     if (mode==PETSC_COPY_VALUES) {ierr = DMLabelDestroy(&labelNew);CHKERRQ(ierr);}
8203c58f1c22SToby Isaac   }
8204c58f1c22SToby Isaac   PetscFunctionReturn(0);
8205c58f1c22SToby Isaac }
8206461a15a0SLisandro Dalcin 
8207461a15a0SLisandro Dalcin PetscErrorCode DMSetLabelValue_Fast(DM dm, DMLabel *label, const char name[], PetscInt point, PetscInt value)
8208461a15a0SLisandro Dalcin {
8209461a15a0SLisandro Dalcin   PetscErrorCode ierr;
8210461a15a0SLisandro Dalcin   PetscFunctionBegin;
8211461a15a0SLisandro Dalcin   PetscValidPointer(label,2);
8212461a15a0SLisandro Dalcin   if (!*label) {
8213461a15a0SLisandro Dalcin     ierr = DMCreateLabel(dm, name);CHKERRQ(ierr);
8214461a15a0SLisandro Dalcin     ierr = DMGetLabel(dm, name, label);CHKERRQ(ierr);
8215461a15a0SLisandro Dalcin   }
8216461a15a0SLisandro Dalcin   ierr = DMLabelSetValue(*label, point, value);CHKERRQ(ierr);
8217461a15a0SLisandro Dalcin   PetscFunctionReturn(0);
8218461a15a0SLisandro Dalcin }
8219461a15a0SLisandro Dalcin 
82200fdc7489SMatthew Knepley /*
82210fdc7489SMatthew Knepley   Many mesh programs, such as Triangle and TetGen, allow only a single label for each mesh point. Therefore, we would
82220fdc7489SMatthew Knepley   like to encode all label IDs using a single, universal label. We can do this by assigning an integer to every
82230fdc7489SMatthew Knepley   (label, id) pair in the DM.
82240fdc7489SMatthew Knepley 
82250fdc7489SMatthew Knepley   However, a mesh point can have multiple labels, so we must separate all these values. We will assign a bit range to
82260fdc7489SMatthew Knepley   each label.
82270fdc7489SMatthew Knepley */
82280fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelCreate(DM dm, DMUniversalLabel *universal)
82290fdc7489SMatthew Knepley {
82300fdc7489SMatthew Knepley   DMUniversalLabel ul;
82310fdc7489SMatthew Knepley   PetscBool       *active;
82320fdc7489SMatthew Knepley   PetscInt         pStart, pEnd, p, Nl, l, m;
82330fdc7489SMatthew Knepley   PetscErrorCode   ierr;
82340fdc7489SMatthew Knepley 
82350fdc7489SMatthew Knepley   PetscFunctionBegin;
82360fdc7489SMatthew Knepley   ierr = PetscMalloc1(1, &ul);CHKERRQ(ierr);
82370fdc7489SMatthew Knepley   ierr = DMLabelCreate(PETSC_COMM_SELF, "universal", &ul->label);CHKERRQ(ierr);
82380fdc7489SMatthew Knepley   ierr = DMGetNumLabels(dm, &Nl);CHKERRQ(ierr);
82390fdc7489SMatthew Knepley   ierr = PetscCalloc1(Nl, &active);CHKERRQ(ierr);
82400fdc7489SMatthew Knepley   ul->Nl = 0;
82410fdc7489SMatthew Knepley   for (l = 0; l < Nl; ++l) {
82420fdc7489SMatthew Knepley     PetscBool   isdepth, iscelltype;
82430fdc7489SMatthew Knepley     const char *name;
82440fdc7489SMatthew Knepley 
82450fdc7489SMatthew Knepley     ierr = DMGetLabelName(dm, l, &name);CHKERRQ(ierr);
82460fdc7489SMatthew Knepley     ierr = PetscStrncmp(name, "depth", 6, &isdepth);CHKERRQ(ierr);
82470fdc7489SMatthew Knepley     ierr = PetscStrncmp(name, "celltype", 9, &iscelltype);CHKERRQ(ierr);
82480fdc7489SMatthew Knepley     active[l] = !(isdepth || iscelltype) ? PETSC_TRUE : PETSC_FALSE;
82490fdc7489SMatthew Knepley     if (active[l]) ++ul->Nl;
82500fdc7489SMatthew Knepley   }
82510fdc7489SMatthew 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);
82520fdc7489SMatthew Knepley   ul->Nv = 0;
82530fdc7489SMatthew Knepley   for (l = 0, m = 0; l < Nl; ++l) {
82540fdc7489SMatthew Knepley     DMLabel     label;
82550fdc7489SMatthew Knepley     PetscInt    nv;
82560fdc7489SMatthew Knepley     const char *name;
82570fdc7489SMatthew Knepley 
82580fdc7489SMatthew Knepley     if (!active[l]) continue;
82590fdc7489SMatthew Knepley     ierr = DMGetLabelName(dm, l, &name);CHKERRQ(ierr);
82600fdc7489SMatthew Knepley     ierr = DMGetLabelByNum(dm, l, &label);CHKERRQ(ierr);
82610fdc7489SMatthew Knepley     ierr = DMLabelGetNumValues(label, &nv);CHKERRQ(ierr);
82620fdc7489SMatthew Knepley     ierr = PetscStrallocpy(name, &ul->names[m]);CHKERRQ(ierr);
82630fdc7489SMatthew Knepley     ul->indices[m]   = l;
82640fdc7489SMatthew Knepley     ul->Nv          += nv;
82650fdc7489SMatthew Knepley     ul->offsets[m+1] = nv;
82660fdc7489SMatthew Knepley     ul->bits[m+1]    = PetscCeilReal(PetscLog2Real(nv+1));
82670fdc7489SMatthew Knepley     ++m;
82680fdc7489SMatthew Knepley   }
82690fdc7489SMatthew Knepley   for (l = 1; l <= ul->Nl; ++l) {
82700fdc7489SMatthew Knepley     ul->offsets[l] = ul->offsets[l-1] + ul->offsets[l];
82710fdc7489SMatthew Knepley     ul->bits[l]    = ul->bits[l-1]    + ul->bits[l];
82720fdc7489SMatthew Knepley   }
82730fdc7489SMatthew Knepley   for (l = 0; l < ul->Nl; ++l) {
82740fdc7489SMatthew Knepley     PetscInt b;
82750fdc7489SMatthew Knepley 
82760fdc7489SMatthew Knepley     ul->masks[l] = 0;
82770fdc7489SMatthew Knepley     for (b = ul->bits[l]; b < ul->bits[l+1]; ++b) ul->masks[l] |= 1 << b;
82780fdc7489SMatthew Knepley   }
82790fdc7489SMatthew Knepley   ierr = PetscMalloc1(ul->Nv, &ul->values);CHKERRQ(ierr);
82800fdc7489SMatthew Knepley   for (l = 0, m = 0; l < Nl; ++l) {
82810fdc7489SMatthew Knepley     DMLabel         label;
82820fdc7489SMatthew Knepley     IS              valueIS;
82830fdc7489SMatthew Knepley     const PetscInt *varr;
82840fdc7489SMatthew Knepley     PetscInt        nv, v;
82850fdc7489SMatthew Knepley 
82860fdc7489SMatthew Knepley     if (!active[l]) continue;
82870fdc7489SMatthew Knepley     ierr = DMGetLabelByNum(dm, l, &label);CHKERRQ(ierr);
82880fdc7489SMatthew Knepley     ierr = DMLabelGetNumValues(label, &nv);CHKERRQ(ierr);
82890fdc7489SMatthew Knepley     ierr = DMLabelGetValueIS(label, &valueIS);CHKERRQ(ierr);
82900fdc7489SMatthew Knepley     ierr = ISGetIndices(valueIS, &varr);CHKERRQ(ierr);
82910fdc7489SMatthew Knepley     for (v = 0; v < nv; ++v) {
82920fdc7489SMatthew Knepley       ul->values[ul->offsets[m]+v] = varr[v];
82930fdc7489SMatthew Knepley     }
82940fdc7489SMatthew Knepley     ierr = ISRestoreIndices(valueIS, &varr);CHKERRQ(ierr);
82950fdc7489SMatthew Knepley     ierr = ISDestroy(&valueIS);CHKERRQ(ierr);
82960fdc7489SMatthew Knepley     ierr = PetscSortInt(nv, &ul->values[ul->offsets[m]]);CHKERRQ(ierr);
82970fdc7489SMatthew Knepley     ++m;
82980fdc7489SMatthew Knepley   }
82990fdc7489SMatthew Knepley   ierr = DMPlexGetChart(dm, &pStart, &pEnd);CHKERRQ(ierr);
83000fdc7489SMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
83010fdc7489SMatthew Knepley     PetscInt  uval = 0;
83020fdc7489SMatthew Knepley     PetscBool marked = PETSC_FALSE;
83030fdc7489SMatthew Knepley 
83040fdc7489SMatthew Knepley     for (l = 0, m = 0; l < Nl; ++l) {
83050fdc7489SMatthew Knepley       DMLabel  label;
83060649b39aSStefano Zampini       PetscInt val, defval, loc, nv;
83070fdc7489SMatthew Knepley 
83080fdc7489SMatthew Knepley       if (!active[l]) continue;
83090fdc7489SMatthew Knepley       ierr = DMGetLabelByNum(dm, l, &label);CHKERRQ(ierr);
83100fdc7489SMatthew Knepley       ierr = DMLabelGetValue(label, p, &val);CHKERRQ(ierr);
83110fdc7489SMatthew Knepley       ierr = DMLabelGetDefaultValue(label, &defval);CHKERRQ(ierr);
83120fdc7489SMatthew Knepley       if (val == defval) {++m; continue;}
83130649b39aSStefano Zampini       nv = ul->offsets[m+1]-ul->offsets[m];
83140fdc7489SMatthew Knepley       marked = PETSC_TRUE;
83150fdc7489SMatthew Knepley       ierr = PetscFindInt(val, nv, &ul->values[ul->offsets[m]], &loc);CHKERRQ(ierr);
83160fdc7489SMatthew Knepley       if (loc < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_PLIB, "Label value %D not found in compression array", val);
83170fdc7489SMatthew Knepley       uval += (loc+1) << ul->bits[m];
83180fdc7489SMatthew Knepley       ++m;
83190fdc7489SMatthew Knepley     }
83200fdc7489SMatthew Knepley     if (marked) {ierr = DMLabelSetValue(ul->label, p, uval);CHKERRQ(ierr);}
83210fdc7489SMatthew Knepley   }
83220fdc7489SMatthew Knepley   ierr = PetscFree(active);CHKERRQ(ierr);
83230fdc7489SMatthew Knepley   *universal = ul;
83240fdc7489SMatthew Knepley   PetscFunctionReturn(0);
83250fdc7489SMatthew Knepley }
83260fdc7489SMatthew Knepley 
83270fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelDestroy(DMUniversalLabel *universal)
83280fdc7489SMatthew Knepley {
83290fdc7489SMatthew Knepley   PetscInt       l;
83300fdc7489SMatthew Knepley   PetscErrorCode ierr;
83310fdc7489SMatthew Knepley 
83320fdc7489SMatthew Knepley   PetscFunctionBegin;
83330fdc7489SMatthew Knepley   for (l = 0; l < (*universal)->Nl; ++l) {ierr = PetscFree((*universal)->names[l]);CHKERRQ(ierr);}
83340fdc7489SMatthew Knepley   ierr = DMLabelDestroy(&(*universal)->label);CHKERRQ(ierr);
83350fdc7489SMatthew Knepley   ierr = PetscFree5((*universal)->names, (*universal)->indices, (*universal)->offsets, (*universal)->bits, (*universal)->masks);CHKERRQ(ierr);
83360fdc7489SMatthew Knepley   ierr = PetscFree((*universal)->values);CHKERRQ(ierr);
83370fdc7489SMatthew Knepley   ierr = PetscFree(*universal);CHKERRQ(ierr);
83380fdc7489SMatthew Knepley   *universal = NULL;
83390fdc7489SMatthew Knepley   PetscFunctionReturn(0);
83400fdc7489SMatthew Knepley }
83410fdc7489SMatthew Knepley 
83420fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelGetLabel(DMUniversalLabel ul, DMLabel *ulabel)
83430fdc7489SMatthew Knepley {
83440fdc7489SMatthew Knepley   PetscFunctionBegin;
83450fdc7489SMatthew Knepley   PetscValidPointer(ulabel, 2);
83460fdc7489SMatthew Knepley   *ulabel = ul->label;
83470fdc7489SMatthew Knepley   PetscFunctionReturn(0);
83480fdc7489SMatthew Knepley }
83490fdc7489SMatthew Knepley 
83500fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelCreateLabels(DMUniversalLabel ul, PetscBool preserveOrder, DM dm)
83510fdc7489SMatthew Knepley {
83520fdc7489SMatthew Knepley   PetscInt       Nl = ul->Nl, l;
83530fdc7489SMatthew Knepley   PetscErrorCode ierr;
83540fdc7489SMatthew Knepley 
83550fdc7489SMatthew Knepley   PetscFunctionBegin;
8356064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(dm, DM_CLASSID, 3);
83570fdc7489SMatthew Knepley   for (l = 0; l < Nl; ++l) {
83580fdc7489SMatthew Knepley     if (preserveOrder) {ierr = DMCreateLabelAtIndex(dm, ul->indices[l], ul->names[l]);CHKERRQ(ierr);}
83590fdc7489SMatthew Knepley     else               {ierr = DMCreateLabel(dm, ul->names[l]);CHKERRQ(ierr);}
83600fdc7489SMatthew Knepley   }
83610fdc7489SMatthew Knepley   if (preserveOrder) {
83620fdc7489SMatthew Knepley     for (l = 0; l < ul->Nl; ++l) {
83630fdc7489SMatthew Knepley       const char *name;
83640fdc7489SMatthew Knepley       PetscBool   match;
83650fdc7489SMatthew Knepley 
83660fdc7489SMatthew Knepley       ierr = DMGetLabelName(dm, ul->indices[l], &name);CHKERRQ(ierr);
83670fdc7489SMatthew Knepley       ierr = PetscStrcmp(name, ul->names[l], &match);CHKERRQ(ierr);
83680fdc7489SMatthew 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]);
83690fdc7489SMatthew Knepley     }
83700fdc7489SMatthew Knepley   }
83710fdc7489SMatthew Knepley   PetscFunctionReturn(0);
83720fdc7489SMatthew Knepley }
83730fdc7489SMatthew Knepley 
83740fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelSetLabelValue(DMUniversalLabel ul, DM dm, PetscBool useIndex, PetscInt p, PetscInt value)
83750fdc7489SMatthew Knepley {
83760fdc7489SMatthew Knepley   PetscInt       l;
83770fdc7489SMatthew Knepley   PetscErrorCode ierr;
83780fdc7489SMatthew Knepley 
83790fdc7489SMatthew Knepley   PetscFunctionBegin;
83800fdc7489SMatthew Knepley   for (l = 0; l < ul->Nl; ++l) {
83810fdc7489SMatthew Knepley     DMLabel  label;
83820fdc7489SMatthew Knepley     PetscInt lval = (value & ul->masks[l]) >> ul->bits[l];
83830fdc7489SMatthew Knepley 
83840fdc7489SMatthew Knepley     if (lval) {
83850fdc7489SMatthew Knepley       if (useIndex) {ierr = DMGetLabelByNum(dm, ul->indices[l], &label);CHKERRQ(ierr);}
83860fdc7489SMatthew Knepley       else          {ierr = DMGetLabel(dm, ul->names[l], &label);CHKERRQ(ierr);}
83870fdc7489SMatthew Knepley       ierr = DMLabelSetValue(label, p, ul->values[ul->offsets[l]+lval-1]);CHKERRQ(ierr);
83880fdc7489SMatthew Knepley     }
83890fdc7489SMatthew Knepley   }
83900fdc7489SMatthew Knepley   PetscFunctionReturn(0);
83910fdc7489SMatthew Knepley }
8392a8fb8f29SToby Isaac 
8393a8fb8f29SToby Isaac /*@
8394a8fb8f29SToby Isaac   DMGetCoarseDM - Get the coarse mesh from which this was obtained by refinement
8395a8fb8f29SToby Isaac 
8396a8fb8f29SToby Isaac   Input Parameter:
8397a8fb8f29SToby Isaac . dm - The DM object
8398a8fb8f29SToby Isaac 
8399a8fb8f29SToby Isaac   Output Parameter:
8400a8fb8f29SToby Isaac . cdm - The coarse DM
8401a8fb8f29SToby Isaac 
8402a8fb8f29SToby Isaac   Level: intermediate
8403a8fb8f29SToby Isaac 
8404a8fb8f29SToby Isaac .seealso: DMSetCoarseDM()
8405a8fb8f29SToby Isaac @*/
8406a8fb8f29SToby Isaac PetscErrorCode DMGetCoarseDM(DM dm, DM *cdm)
8407a8fb8f29SToby Isaac {
8408a8fb8f29SToby Isaac   PetscFunctionBegin;
8409a8fb8f29SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8410a8fb8f29SToby Isaac   PetscValidPointer(cdm, 2);
8411a8fb8f29SToby Isaac   *cdm = dm->coarseMesh;
8412a8fb8f29SToby Isaac   PetscFunctionReturn(0);
8413a8fb8f29SToby Isaac }
8414a8fb8f29SToby Isaac 
8415a8fb8f29SToby Isaac /*@
8416a8fb8f29SToby Isaac   DMSetCoarseDM - Set the coarse mesh from which this was obtained by refinement
8417a8fb8f29SToby Isaac 
8418a8fb8f29SToby Isaac   Input Parameters:
8419a8fb8f29SToby Isaac + dm - The DM object
8420a8fb8f29SToby Isaac - cdm - The coarse DM
8421a8fb8f29SToby Isaac 
8422a8fb8f29SToby Isaac   Level: intermediate
8423a8fb8f29SToby Isaac 
8424a8fb8f29SToby Isaac .seealso: DMGetCoarseDM()
8425a8fb8f29SToby Isaac @*/
8426a8fb8f29SToby Isaac PetscErrorCode DMSetCoarseDM(DM dm, DM cdm)
8427a8fb8f29SToby Isaac {
8428a8fb8f29SToby Isaac   PetscErrorCode ierr;
8429a8fb8f29SToby Isaac 
8430a8fb8f29SToby Isaac   PetscFunctionBegin;
8431a8fb8f29SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8432a8fb8f29SToby Isaac   if (cdm) PetscValidHeaderSpecific(cdm, DM_CLASSID, 2);
8433a8fb8f29SToby Isaac   ierr = PetscObjectReference((PetscObject)cdm);CHKERRQ(ierr);
8434a8fb8f29SToby Isaac   ierr = DMDestroy(&dm->coarseMesh);CHKERRQ(ierr);
8435a8fb8f29SToby Isaac   dm->coarseMesh = cdm;
8436a8fb8f29SToby Isaac   PetscFunctionReturn(0);
8437a8fb8f29SToby Isaac }
8438a8fb8f29SToby Isaac 
843988bdff64SToby Isaac /*@
844088bdff64SToby Isaac   DMGetFineDM - Get the fine mesh from which this was obtained by refinement
844188bdff64SToby Isaac 
844288bdff64SToby Isaac   Input Parameter:
844388bdff64SToby Isaac . dm - The DM object
844488bdff64SToby Isaac 
844588bdff64SToby Isaac   Output Parameter:
844688bdff64SToby Isaac . fdm - The fine DM
844788bdff64SToby Isaac 
844888bdff64SToby Isaac   Level: intermediate
844988bdff64SToby Isaac 
845088bdff64SToby Isaac .seealso: DMSetFineDM()
845188bdff64SToby Isaac @*/
845288bdff64SToby Isaac PetscErrorCode DMGetFineDM(DM dm, DM *fdm)
845388bdff64SToby Isaac {
845488bdff64SToby Isaac   PetscFunctionBegin;
845588bdff64SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
845688bdff64SToby Isaac   PetscValidPointer(fdm, 2);
845788bdff64SToby Isaac   *fdm = dm->fineMesh;
845888bdff64SToby Isaac   PetscFunctionReturn(0);
845988bdff64SToby Isaac }
846088bdff64SToby Isaac 
846188bdff64SToby Isaac /*@
846288bdff64SToby Isaac   DMSetFineDM - Set the fine mesh from which this was obtained by refinement
846388bdff64SToby Isaac 
846488bdff64SToby Isaac   Input Parameters:
846588bdff64SToby Isaac + dm - The DM object
846688bdff64SToby Isaac - fdm - The fine DM
846788bdff64SToby Isaac 
846888bdff64SToby Isaac   Level: intermediate
846988bdff64SToby Isaac 
847088bdff64SToby Isaac .seealso: DMGetFineDM()
847188bdff64SToby Isaac @*/
847288bdff64SToby Isaac PetscErrorCode DMSetFineDM(DM dm, DM fdm)
847388bdff64SToby Isaac {
847488bdff64SToby Isaac   PetscErrorCode ierr;
847588bdff64SToby Isaac 
847688bdff64SToby Isaac   PetscFunctionBegin;
847788bdff64SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
847888bdff64SToby Isaac   if (fdm) PetscValidHeaderSpecific(fdm, DM_CLASSID, 2);
847988bdff64SToby Isaac   ierr = PetscObjectReference((PetscObject)fdm);CHKERRQ(ierr);
848088bdff64SToby Isaac   ierr = DMDestroy(&dm->fineMesh);CHKERRQ(ierr);
848188bdff64SToby Isaac   dm->fineMesh = fdm;
848288bdff64SToby Isaac   PetscFunctionReturn(0);
848388bdff64SToby Isaac }
848488bdff64SToby Isaac 
8485a6ba4734SToby Isaac /*=== DMBoundary code ===*/
8486a6ba4734SToby Isaac 
8487a6ba4734SToby Isaac /*@C
8488a6ba4734SToby Isaac   DMAddBoundary - Add a boundary condition to the model
8489a6ba4734SToby Isaac 
8490783e2ec8SMatthew G. Knepley   Collective on dm
8491783e2ec8SMatthew G. Knepley 
8492a6ba4734SToby Isaac   Input Parameters:
84934c258f51SMatthew G. Knepley + dm       - The DM, with a PetscDS that matches the problem being constrained
8494f971fd6bSMatthew G. Knepley . type     - The type of condition, e.g. DM_BC_ESSENTIAL_ANALYTIC/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann)
8495a6ba4734SToby Isaac . name     - The BC name
849645480ffeSMatthew G. Knepley . label    - The label defining constrained points
849745480ffeSMatthew G. Knepley . Nv       - The number of DMLabel values for constrained points
849845480ffeSMatthew G. Knepley . values   - An array of values for constrained points
8499a6ba4734SToby Isaac . field    - The field to constrain
850045480ffeSMatthew G. Knepley . Nc       - The number of constrained field components (0 will constrain all fields)
8501a6ba4734SToby Isaac . comps    - An array of constrained component numbers
8502a6ba4734SToby Isaac . bcFunc   - A pointwise function giving boundary values
850356cf3b9cSMatthew G. Knepley . bcFunc_t - A pointwise function giving the time deriative of the boundary values, or NULL
8504a6ba4734SToby Isaac - ctx      - An optional user context for bcFunc
8505a6ba4734SToby Isaac 
850645480ffeSMatthew G. Knepley   Output Parameter:
850745480ffeSMatthew G. Knepley . bd          - (Optional) Boundary number
850845480ffeSMatthew G. Knepley 
8509a6ba4734SToby Isaac   Options Database Keys:
8510a6ba4734SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids
8511a6ba4734SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components
8512a6ba4734SToby Isaac 
851356cf3b9cSMatthew G. Knepley   Note:
851456cf3b9cSMatthew 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:
851556cf3b9cSMatthew G. Knepley 
851656cf3b9cSMatthew G. Knepley $ bcFunc(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nc, PetscScalar bcval[])
851756cf3b9cSMatthew G. Knepley 
851856cf3b9cSMatthew G. Knepley   If the type is DM_BC_ESSENTIAL_FIELD or other _FIELD value, then the calling sequence is:
851956cf3b9cSMatthew G. Knepley 
852056cf3b9cSMatthew G. Knepley $ bcFunc(PetscInt dim, PetscInt Nf, PetscInt NfAux,
852156cf3b9cSMatthew G. Knepley $        const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
852256cf3b9cSMatthew G. Knepley $        const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
852356cf3b9cSMatthew G. Knepley $        PetscReal time, const PetscReal x[], PetscScalar bcval[])
852456cf3b9cSMatthew G. Knepley 
852556cf3b9cSMatthew G. Knepley + dim - the spatial dimension
852656cf3b9cSMatthew G. Knepley . Nf - the number of fields
852756cf3b9cSMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
852856cf3b9cSMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
852956cf3b9cSMatthew G. Knepley . u - each field evaluated at the current point
853056cf3b9cSMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
853156cf3b9cSMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
853256cf3b9cSMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
853356cf3b9cSMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
853456cf3b9cSMatthew G. Knepley . a - each auxiliary field evaluated at the current point
853556cf3b9cSMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
853656cf3b9cSMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
853756cf3b9cSMatthew G. Knepley . t - current time
853856cf3b9cSMatthew G. Knepley . x - coordinates of the current point
853956cf3b9cSMatthew G. Knepley . numConstants - number of constant parameters
854056cf3b9cSMatthew G. Knepley . constants - constant parameters
854156cf3b9cSMatthew G. Knepley - bcval - output values at the current point
854256cf3b9cSMatthew G. Knepley 
8543a6ba4734SToby Isaac   Level: developer
8544a6ba4734SToby Isaac 
854545480ffeSMatthew G. Knepley .seealso: DSGetBoundary(), PetscDSAddBoundary()
8546a6ba4734SToby Isaac @*/
854745480ffeSMatthew 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)
8548a6ba4734SToby Isaac {
8549e5e52638SMatthew G. Knepley   PetscDS        ds;
8550a6ba4734SToby Isaac   PetscErrorCode ierr;
8551a6ba4734SToby Isaac 
8552a6ba4734SToby Isaac   PetscFunctionBegin;
8553a6ba4734SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8554783e2ec8SMatthew G. Knepley   PetscValidLogicalCollectiveEnum(dm, type, 2);
855545480ffeSMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 4);
855645480ffeSMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, Nv, 5);
855745480ffeSMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, field, 7);
855845480ffeSMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, Nc, 8);
8559e5e52638SMatthew G. Knepley   ierr = DMGetDS(dm, &ds);CHKERRQ(ierr);
856045480ffeSMatthew G. Knepley   ierr = DMCompleteBoundaryLabel_Internal(dm, ds, field, PETSC_MAX_INT, label);CHKERRQ(ierr);
856145480ffeSMatthew G. Knepley   ierr = PetscDSAddBoundary(ds, type, name, label, Nv, values, field, Nc, comps, bcFunc, bcFunc_t, ctx, bd);CHKERRQ(ierr);
8562a6ba4734SToby Isaac   PetscFunctionReturn(0);
8563a6ba4734SToby Isaac }
8564a6ba4734SToby Isaac 
856545480ffeSMatthew G. Knepley /* TODO Remove this since now the structures are the same */
8566e6f8dbb6SToby Isaac static PetscErrorCode DMPopulateBoundary(DM dm)
8567e6f8dbb6SToby Isaac {
8568e5e52638SMatthew G. Knepley   PetscDS        ds;
8569dff059c6SToby Isaac   DMBoundary    *lastnext;
8570e6f8dbb6SToby Isaac   DSBoundary     dsbound;
8571e6f8dbb6SToby Isaac   PetscErrorCode ierr;
8572e6f8dbb6SToby Isaac 
8573e6f8dbb6SToby Isaac   PetscFunctionBegin;
8574e5e52638SMatthew G. Knepley   ierr = DMGetDS(dm, &ds);CHKERRQ(ierr);
8575e5e52638SMatthew G. Knepley   dsbound = ds->boundary;
857647a1f5adSToby Isaac   if (dm->boundary) {
857747a1f5adSToby Isaac     DMBoundary next = dm->boundary;
857847a1f5adSToby Isaac 
857947a1f5adSToby Isaac     /* quick check to see if the PetscDS has changed */
858047a1f5adSToby Isaac     if (next->dsboundary == dsbound) PetscFunctionReturn(0);
858147a1f5adSToby Isaac     /* the PetscDS has changed: tear down and rebuild */
858247a1f5adSToby Isaac     while (next) {
858347a1f5adSToby Isaac       DMBoundary b = next;
858447a1f5adSToby Isaac 
858547a1f5adSToby Isaac       next = b->next;
858647a1f5adSToby Isaac       ierr = PetscFree(b);CHKERRQ(ierr);
8587a6ba4734SToby Isaac     }
858847a1f5adSToby Isaac     dm->boundary = NULL;
8589a6ba4734SToby Isaac   }
859047a1f5adSToby Isaac 
8591dff059c6SToby Isaac   lastnext = &(dm->boundary);
8592e6f8dbb6SToby Isaac   while (dsbound) {
8593e6f8dbb6SToby Isaac     DMBoundary dmbound;
8594e6f8dbb6SToby Isaac 
8595e6f8dbb6SToby Isaac     ierr = PetscNew(&dmbound);CHKERRQ(ierr);
8596e6f8dbb6SToby Isaac     dmbound->dsboundary = dsbound;
859745480ffeSMatthew G. Knepley     dmbound->label      = dsbound->label;
859847a1f5adSToby Isaac     /* push on the back instead of the front so that it is in the same order as in the PetscDS */
8599dff059c6SToby Isaac     *lastnext = dmbound;
8600dff059c6SToby Isaac     lastnext = &(dmbound->next);
8601dff059c6SToby Isaac     dsbound = dsbound->next;
8602a6ba4734SToby Isaac   }
8603a6ba4734SToby Isaac   PetscFunctionReturn(0);
8604a6ba4734SToby Isaac }
8605a6ba4734SToby Isaac 
8606a6ba4734SToby Isaac PetscErrorCode DMIsBoundaryPoint(DM dm, PetscInt point, PetscBool *isBd)
8607a6ba4734SToby Isaac {
8608b95f2879SToby Isaac   DMBoundary     b;
8609a6ba4734SToby Isaac   PetscErrorCode ierr;
8610a6ba4734SToby Isaac 
8611a6ba4734SToby Isaac   PetscFunctionBegin;
8612a6ba4734SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8613534a8f05SLisandro Dalcin   PetscValidBoolPointer(isBd, 3);
8614a6ba4734SToby Isaac   *isBd = PETSC_FALSE;
8615e6f8dbb6SToby Isaac   ierr = DMPopulateBoundary(dm);CHKERRQ(ierr);
8616b95f2879SToby Isaac   b = dm->boundary;
8617a6ba4734SToby Isaac   while (b && !(*isBd)) {
8618e6f8dbb6SToby Isaac     DMLabel    label = b->label;
8619e6f8dbb6SToby Isaac     DSBoundary dsb   = b->dsboundary;
8620a6ba4734SToby Isaac     PetscInt   i;
8621a6ba4734SToby Isaac 
862245480ffeSMatthew G. Knepley     if (label) {
862345480ffeSMatthew G. Knepley       for (i = 0; i < dsb->Nv && !(*isBd); ++i) {ierr = DMLabelStratumHasPoint(label, dsb->values[i], point, isBd);CHKERRQ(ierr);}
8624a6ba4734SToby Isaac     }
8625a6ba4734SToby Isaac     b = b->next;
8626a6ba4734SToby Isaac   }
8627a6ba4734SToby Isaac   PetscFunctionReturn(0);
8628a6ba4734SToby Isaac }
86294d6f44ffSToby Isaac 
86304d6f44ffSToby Isaac /*@C
8631a6e0b375SMatthew G. Knepley   DMProjectFunction - This projects the given function into the function space provided, putting the coefficients in a global vector.
8632a6e0b375SMatthew G. Knepley 
8633a6e0b375SMatthew G. Knepley   Collective on DM
86344d6f44ffSToby Isaac 
86354d6f44ffSToby Isaac   Input Parameters:
86364d6f44ffSToby Isaac + dm      - The DM
86370709b2feSToby Isaac . time    - The time
86384d6f44ffSToby Isaac . funcs   - The coordinate functions to evaluate, one per field
86394d6f44ffSToby Isaac . ctxs    - Optional array of contexts to pass to each coordinate function.  ctxs itself may be null.
86404d6f44ffSToby Isaac - mode    - The insertion mode for values
86414d6f44ffSToby Isaac 
86424d6f44ffSToby Isaac   Output Parameter:
86434d6f44ffSToby Isaac . X - vector
86444d6f44ffSToby Isaac 
86454d6f44ffSToby Isaac    Calling sequence of func:
86460709b2feSToby Isaac $    func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nf, PetscScalar u[], void *ctx);
86474d6f44ffSToby Isaac 
86484d6f44ffSToby Isaac +  dim - The spatial dimension
86498ec8862eSJed Brown .  time - The time at which to sample
86504d6f44ffSToby Isaac .  x   - The coordinates
86514d6f44ffSToby Isaac .  Nf  - The number of fields
86524d6f44ffSToby Isaac .  u   - The output field values
86534d6f44ffSToby Isaac -  ctx - optional user-defined function context
86544d6f44ffSToby Isaac 
86554d6f44ffSToby Isaac   Level: developer
86564d6f44ffSToby Isaac 
8657a6e0b375SMatthew G. Knepley .seealso: DMProjectFunctionLocal(), DMProjectFunctionLabel(), DMComputeL2Diff()
86584d6f44ffSToby Isaac @*/
86590709b2feSToby Isaac PetscErrorCode DMProjectFunction(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec X)
86604d6f44ffSToby Isaac {
86614d6f44ffSToby Isaac   Vec            localX;
86624d6f44ffSToby Isaac   PetscErrorCode ierr;
86634d6f44ffSToby Isaac 
86644d6f44ffSToby Isaac   PetscFunctionBegin;
86654d6f44ffSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
86664d6f44ffSToby Isaac   ierr = DMGetLocalVector(dm, &localX);CHKERRQ(ierr);
86670709b2feSToby Isaac   ierr = DMProjectFunctionLocal(dm, time, funcs, ctxs, mode, localX);CHKERRQ(ierr);
86684d6f44ffSToby Isaac   ierr = DMLocalToGlobalBegin(dm, localX, mode, X);CHKERRQ(ierr);
86694d6f44ffSToby Isaac   ierr = DMLocalToGlobalEnd(dm, localX, mode, X);CHKERRQ(ierr);
86704d6f44ffSToby Isaac   ierr = DMRestoreLocalVector(dm, &localX);CHKERRQ(ierr);
86714d6f44ffSToby Isaac   PetscFunctionReturn(0);
86724d6f44ffSToby Isaac }
86734d6f44ffSToby Isaac 
8674a6e0b375SMatthew G. Knepley /*@C
8675a6e0b375SMatthew G. Knepley   DMProjectFunctionLocal - This projects the given function into the function space provided, putting the coefficients in a local vector.
8676a6e0b375SMatthew G. Knepley 
8677a6e0b375SMatthew G. Knepley   Not collective
8678a6e0b375SMatthew G. Knepley 
8679a6e0b375SMatthew G. Knepley   Input Parameters:
8680a6e0b375SMatthew G. Knepley + dm      - The DM
8681a6e0b375SMatthew G. Knepley . time    - The time
8682a6e0b375SMatthew G. Knepley . funcs   - The coordinate functions to evaluate, one per field
8683a6e0b375SMatthew G. Knepley . ctxs    - Optional array of contexts to pass to each coordinate function.  ctxs itself may be null.
8684a6e0b375SMatthew G. Knepley - mode    - The insertion mode for values
8685a6e0b375SMatthew G. Knepley 
8686a6e0b375SMatthew G. Knepley   Output Parameter:
8687a6e0b375SMatthew G. Knepley . localX - vector
8688a6e0b375SMatthew G. Knepley 
8689a6e0b375SMatthew G. Knepley    Calling sequence of func:
8690a6e0b375SMatthew G. Knepley $    func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nf, PetscScalar u[], void *ctx);
8691a6e0b375SMatthew G. Knepley 
8692a6e0b375SMatthew G. Knepley +  dim - The spatial dimension
8693a6e0b375SMatthew G. Knepley .  x   - The coordinates
8694a6e0b375SMatthew G. Knepley .  Nf  - The number of fields
8695a6e0b375SMatthew G. Knepley .  u   - The output field values
8696a6e0b375SMatthew G. Knepley -  ctx - optional user-defined function context
8697a6e0b375SMatthew G. Knepley 
8698a6e0b375SMatthew G. Knepley   Level: developer
8699a6e0b375SMatthew G. Knepley 
8700a6e0b375SMatthew G. Knepley .seealso: DMProjectFunction(), DMProjectFunctionLabel(), DMComputeL2Diff()
8701a6e0b375SMatthew G. Knepley @*/
87020709b2feSToby Isaac PetscErrorCode DMProjectFunctionLocal(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec localX)
87034d6f44ffSToby Isaac {
87044d6f44ffSToby Isaac   PetscErrorCode ierr;
87054d6f44ffSToby Isaac 
87064d6f44ffSToby Isaac   PetscFunctionBegin;
87074d6f44ffSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
8708064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(localX,VEC_CLASSID,6);
87090918c465SMatthew G. Knepley   if (!dm->ops->projectfunctionlocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFunctionLocal",((PetscObject)dm)->type_name);
87100709b2feSToby Isaac   ierr = (dm->ops->projectfunctionlocal) (dm, time, funcs, ctxs, mode, localX);CHKERRQ(ierr);
87114d6f44ffSToby Isaac   PetscFunctionReturn(0);
87124d6f44ffSToby Isaac }
87134d6f44ffSToby Isaac 
8714a6e0b375SMatthew G. Knepley /*@C
8715a6e0b375SMatthew 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.
8716a6e0b375SMatthew G. Knepley 
8717a6e0b375SMatthew G. Knepley   Collective on DM
8718a6e0b375SMatthew G. Knepley 
8719a6e0b375SMatthew G. Knepley   Input Parameters:
8720a6e0b375SMatthew G. Knepley + dm      - The DM
8721a6e0b375SMatthew G. Knepley . time    - The time
8722a6e0b375SMatthew G. Knepley . label   - The DMLabel selecting the portion of the mesh for projection
8723a6e0b375SMatthew G. Knepley . funcs   - The coordinate functions to evaluate, one per field
8724a6e0b375SMatthew G. Knepley . ctxs    - Optional array of contexts to pass to each coordinate function.  ctxs itself may be null.
8725a6e0b375SMatthew G. Knepley - mode    - The insertion mode for values
8726a6e0b375SMatthew G. Knepley 
8727a6e0b375SMatthew G. Knepley   Output Parameter:
8728a6e0b375SMatthew G. Knepley . X - vector
8729a6e0b375SMatthew G. Knepley 
8730a6e0b375SMatthew G. Knepley    Calling sequence of func:
8731a6e0b375SMatthew G. Knepley $    func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nf, PetscScalar u[], void *ctx);
8732a6e0b375SMatthew G. Knepley 
8733a6e0b375SMatthew G. Knepley +  dim - The spatial dimension
8734a6e0b375SMatthew G. Knepley .  x   - The coordinates
8735a6e0b375SMatthew G. Knepley .  Nf  - The number of fields
8736a6e0b375SMatthew G. Knepley .  u   - The output field values
8737a6e0b375SMatthew G. Knepley -  ctx - optional user-defined function context
8738a6e0b375SMatthew G. Knepley 
8739a6e0b375SMatthew G. Knepley   Level: developer
8740a6e0b375SMatthew G. Knepley 
8741a6e0b375SMatthew G. Knepley .seealso: DMProjectFunction(), DMProjectFunctionLocal(), DMProjectFunctionLabelLocal(), DMComputeL2Diff()
8742a6e0b375SMatthew G. Knepley @*/
87432c53366bSMatthew 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)
87442c53366bSMatthew G. Knepley {
87452c53366bSMatthew G. Knepley   Vec            localX;
87462c53366bSMatthew G. Knepley   PetscErrorCode ierr;
87472c53366bSMatthew G. Knepley 
87482c53366bSMatthew G. Knepley   PetscFunctionBegin;
87492c53366bSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
87502c53366bSMatthew G. Knepley   ierr = DMGetLocalVector(dm, &localX);CHKERRQ(ierr);
87512c53366bSMatthew G. Knepley   ierr = DMProjectFunctionLabelLocal(dm, time, label, numIds, ids, Nc, comps, funcs, ctxs, mode, localX);CHKERRQ(ierr);
87522c53366bSMatthew G. Knepley   ierr = DMLocalToGlobalBegin(dm, localX, mode, X);CHKERRQ(ierr);
87532c53366bSMatthew G. Knepley   ierr = DMLocalToGlobalEnd(dm, localX, mode, X);CHKERRQ(ierr);
87542c53366bSMatthew G. Knepley   ierr = DMRestoreLocalVector(dm, &localX);CHKERRQ(ierr);
87552c53366bSMatthew G. Knepley   PetscFunctionReturn(0);
87562c53366bSMatthew G. Knepley }
87572c53366bSMatthew G. Knepley 
8758a6e0b375SMatthew G. Knepley /*@C
8759a6e0b375SMatthew 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.
8760a6e0b375SMatthew G. Knepley 
8761a6e0b375SMatthew G. Knepley   Not collective
8762a6e0b375SMatthew G. Knepley 
8763a6e0b375SMatthew G. Knepley   Input Parameters:
8764a6e0b375SMatthew G. Knepley + dm      - The DM
8765a6e0b375SMatthew G. Knepley . time    - The time
8766a6e0b375SMatthew G. Knepley . label   - The DMLabel selecting the portion of the mesh for projection
8767a6e0b375SMatthew G. Knepley . funcs   - The coordinate functions to evaluate, one per field
8768a6e0b375SMatthew G. Knepley . ctxs    - Optional array of contexts to pass to each coordinate function.  ctxs itself may be null.
8769a6e0b375SMatthew G. Knepley - mode    - The insertion mode for values
8770a6e0b375SMatthew G. Knepley 
8771a6e0b375SMatthew G. Knepley   Output Parameter:
8772a6e0b375SMatthew G. Knepley . localX - vector
8773a6e0b375SMatthew G. Knepley 
8774a6e0b375SMatthew G. Knepley    Calling sequence of func:
8775a6e0b375SMatthew G. Knepley $    func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nf, PetscScalar u[], void *ctx);
8776a6e0b375SMatthew G. Knepley 
8777a6e0b375SMatthew G. Knepley +  dim - The spatial dimension
8778a6e0b375SMatthew G. Knepley .  x   - The coordinates
8779a6e0b375SMatthew G. Knepley .  Nf  - The number of fields
8780a6e0b375SMatthew G. Knepley .  u   - The output field values
8781a6e0b375SMatthew G. Knepley -  ctx - optional user-defined function context
8782a6e0b375SMatthew G. Knepley 
8783a6e0b375SMatthew G. Knepley   Level: developer
8784a6e0b375SMatthew G. Knepley 
8785a6e0b375SMatthew G. Knepley .seealso: DMProjectFunction(), DMProjectFunctionLocal(), DMProjectFunctionLabel(), DMComputeL2Diff()
8786a6e0b375SMatthew G. Knepley @*/
87871c531cf8SMatthew 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)
87884d6f44ffSToby Isaac {
87894d6f44ffSToby Isaac   PetscErrorCode ierr;
87904d6f44ffSToby Isaac 
87914d6f44ffSToby Isaac   PetscFunctionBegin;
87924d6f44ffSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
8793064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(localX,VEC_CLASSID,11);
87940918c465SMatthew G. Knepley   if (!dm->ops->projectfunctionlabellocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFunctionLabelLocal",((PetscObject)dm)->type_name);
87951c531cf8SMatthew G. Knepley   ierr = (dm->ops->projectfunctionlabellocal) (dm, time, label, numIds, ids, Nc, comps, funcs, ctxs, mode, localX);CHKERRQ(ierr);
87964d6f44ffSToby Isaac   PetscFunctionReturn(0);
87974d6f44ffSToby Isaac }
87982716604bSToby Isaac 
8799a6e0b375SMatthew G. Knepley /*@C
8800a6e0b375SMatthew G. Knepley   DMProjectFieldLocal - This projects the given function of the input fields into the function space provided, putting the coefficients in a local vector.
8801a6e0b375SMatthew G. Knepley 
8802a6e0b375SMatthew G. Knepley   Not collective
8803a6e0b375SMatthew G. Knepley 
8804a6e0b375SMatthew G. Knepley   Input Parameters:
8805a6e0b375SMatthew G. Knepley + dm      - The DM
8806a6e0b375SMatthew G. Knepley . time    - The time
8807a6e0b375SMatthew G. Knepley . localU  - The input field vector
8808a6e0b375SMatthew G. Knepley . funcs   - The functions to evaluate, one per field
8809a6e0b375SMatthew G. Knepley - mode    - The insertion mode for values
8810a6e0b375SMatthew G. Knepley 
8811a6e0b375SMatthew G. Knepley   Output Parameter:
8812a6e0b375SMatthew G. Knepley . localX  - The output vector
8813a6e0b375SMatthew G. Knepley 
8814a6e0b375SMatthew G. Knepley    Calling sequence of func:
8815a6e0b375SMatthew G. Knepley $    func(PetscInt dim, PetscInt Nf, PetscInt NfAux,
8816a6e0b375SMatthew G. Knepley $         const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
8817a6e0b375SMatthew G. Knepley $         const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
8818a6e0b375SMatthew G. Knepley $         PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f[]);
8819a6e0b375SMatthew G. Knepley 
8820a6e0b375SMatthew G. Knepley +  dim          - The spatial dimension
8821a6e0b375SMatthew G. Knepley .  Nf           - The number of input fields
8822a6e0b375SMatthew G. Knepley .  NfAux        - The number of input auxiliary fields
8823a6e0b375SMatthew G. Knepley .  uOff         - The offset of each field in u[]
8824a6e0b375SMatthew G. Knepley .  uOff_x       - The offset of each field in u_x[]
8825a6e0b375SMatthew G. Knepley .  u            - The field values at this point in space
8826a6e0b375SMatthew G. Knepley .  u_t          - The field time derivative at this point in space (or NULL)
8827a6e0b375SMatthew G. Knepley .  u_x          - The field derivatives at this point in space
8828a6e0b375SMatthew G. Knepley .  aOff         - The offset of each auxiliary field in u[]
8829a6e0b375SMatthew G. Knepley .  aOff_x       - The offset of each auxiliary field in u_x[]
8830a6e0b375SMatthew G. Knepley .  a            - The auxiliary field values at this point in space
8831a6e0b375SMatthew G. Knepley .  a_t          - The auxiliary field time derivative at this point in space (or NULL)
8832a6e0b375SMatthew G. Knepley .  a_x          - The auxiliary field derivatives at this point in space
8833a6e0b375SMatthew G. Knepley .  t            - The current time
8834a6e0b375SMatthew G. Knepley .  x            - The coordinates of this point
8835a6e0b375SMatthew G. Knepley .  numConstants - The number of constants
8836a6e0b375SMatthew G. Knepley .  constants    - The value of each constant
8837a6e0b375SMatthew G. Knepley -  f            - The value of the function at this point in space
8838a6e0b375SMatthew G. Knepley 
8839a6e0b375SMatthew 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.
8840a6e0b375SMatthew 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
8841a6e0b375SMatthew 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
8842a6e0b375SMatthew 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.
8843a6e0b375SMatthew G. Knepley 
8844a6e0b375SMatthew G. Knepley   Level: intermediate
8845a6e0b375SMatthew G. Knepley 
8846a6e0b375SMatthew G. Knepley .seealso: DMProjectField(), DMProjectFieldLabelLocal(), DMProjectFunction(), DMComputeL2Diff()
8847a6e0b375SMatthew G. Knepley @*/
88488c6c5593SMatthew G. Knepley PetscErrorCode DMProjectFieldLocal(DM dm, PetscReal time, Vec localU,
88498c6c5593SMatthew G. Knepley                                    void (**funcs)(PetscInt, PetscInt, PetscInt,
88508c6c5593SMatthew G. Knepley                                                   const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
88518c6c5593SMatthew G. Knepley                                                   const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
8852191494d9SMatthew G. Knepley                                                   PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]),
88538c6c5593SMatthew G. Knepley                                    InsertMode mode, Vec localX)
88548c6c5593SMatthew G. Knepley {
88558c6c5593SMatthew G. Knepley   PetscErrorCode ierr;
88568c6c5593SMatthew G. Knepley 
88578c6c5593SMatthew G. Knepley   PetscFunctionBegin;
88588c6c5593SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
88598c6c5593SMatthew G. Knepley   PetscValidHeaderSpecific(localU,VEC_CLASSID,3);
88608c6c5593SMatthew G. Knepley   PetscValidHeaderSpecific(localX,VEC_CLASSID,6);
88610918c465SMatthew G. Knepley   if (!dm->ops->projectfieldlocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFieldLocal",((PetscObject)dm)->type_name);
88628c6c5593SMatthew G. Knepley   ierr = (dm->ops->projectfieldlocal) (dm, time, localU, funcs, mode, localX);CHKERRQ(ierr);
88638c6c5593SMatthew G. Knepley   PetscFunctionReturn(0);
88648c6c5593SMatthew G. Knepley }
88658c6c5593SMatthew G. Knepley 
8866a6e0b375SMatthew G. Knepley /*@C
8867a6e0b375SMatthew 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.
8868a6e0b375SMatthew G. Knepley 
8869a6e0b375SMatthew G. Knepley   Not collective
8870a6e0b375SMatthew G. Knepley 
8871a6e0b375SMatthew G. Knepley   Input Parameters:
8872a6e0b375SMatthew G. Knepley + dm      - The DM
8873a6e0b375SMatthew G. Knepley . time    - The time
8874a6e0b375SMatthew G. Knepley . label   - The DMLabel marking the portion of the domain to output
8875a6e0b375SMatthew G. Knepley . numIds  - The number of label ids to use
8876a6e0b375SMatthew G. Knepley . ids     - The label ids to use for marking
8877a6e0b375SMatthew G. Knepley . Nc      - The number of components to set in the output, or PETSC_DETERMINE for all components
8878a6e0b375SMatthew G. Knepley . comps   - The components to set in the output, or NULL for all components
8879a6e0b375SMatthew G. Knepley . localU  - The input field vector
8880a6e0b375SMatthew G. Knepley . funcs   - The functions to evaluate, one per field
8881a6e0b375SMatthew G. Knepley - mode    - The insertion mode for values
8882a6e0b375SMatthew G. Knepley 
8883a6e0b375SMatthew G. Knepley   Output Parameter:
8884a6e0b375SMatthew G. Knepley . localX  - The output vector
8885a6e0b375SMatthew G. Knepley 
8886a6e0b375SMatthew G. Knepley    Calling sequence of func:
8887a6e0b375SMatthew G. Knepley $    func(PetscInt dim, PetscInt Nf, PetscInt NfAux,
8888a6e0b375SMatthew G. Knepley $         const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
8889a6e0b375SMatthew G. Knepley $         const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
8890a6e0b375SMatthew G. Knepley $         PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f[]);
8891a6e0b375SMatthew G. Knepley 
8892a6e0b375SMatthew G. Knepley +  dim          - The spatial dimension
8893a6e0b375SMatthew G. Knepley .  Nf           - The number of input fields
8894a6e0b375SMatthew G. Knepley .  NfAux        - The number of input auxiliary fields
8895a6e0b375SMatthew G. Knepley .  uOff         - The offset of each field in u[]
8896a6e0b375SMatthew G. Knepley .  uOff_x       - The offset of each field in u_x[]
8897a6e0b375SMatthew G. Knepley .  u            - The field values at this point in space
8898a6e0b375SMatthew G. Knepley .  u_t          - The field time derivative at this point in space (or NULL)
8899a6e0b375SMatthew G. Knepley .  u_x          - The field derivatives at this point in space
8900a6e0b375SMatthew G. Knepley .  aOff         - The offset of each auxiliary field in u[]
8901a6e0b375SMatthew G. Knepley .  aOff_x       - The offset of each auxiliary field in u_x[]
8902a6e0b375SMatthew G. Knepley .  a            - The auxiliary field values at this point in space
8903a6e0b375SMatthew G. Knepley .  a_t          - The auxiliary field time derivative at this point in space (or NULL)
8904a6e0b375SMatthew G. Knepley .  a_x          - The auxiliary field derivatives at this point in space
8905a6e0b375SMatthew G. Knepley .  t            - The current time
8906a6e0b375SMatthew G. Knepley .  x            - The coordinates of this point
8907a6e0b375SMatthew G. Knepley .  numConstants - The number of constants
8908a6e0b375SMatthew G. Knepley .  constants    - The value of each constant
8909a6e0b375SMatthew G. Knepley -  f            - The value of the function at this point in space
8910a6e0b375SMatthew G. Knepley 
8911a6e0b375SMatthew 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.
8912a6e0b375SMatthew 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
8913a6e0b375SMatthew 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
8914a6e0b375SMatthew 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.
8915a6e0b375SMatthew G. Knepley 
8916a6e0b375SMatthew G. Knepley   Level: intermediate
8917a6e0b375SMatthew G. Knepley 
8918a6e0b375SMatthew G. Knepley .seealso: DMProjectField(), DMProjectFieldLabelLocal(), DMProjectFunction(), DMComputeL2Diff()
8919a6e0b375SMatthew G. Knepley @*/
89201c531cf8SMatthew G. Knepley PetscErrorCode DMProjectFieldLabelLocal(DM dm, PetscReal time, DMLabel label, PetscInt numIds, const PetscInt ids[], PetscInt Nc, const PetscInt comps[], Vec localU,
89218c6c5593SMatthew G. Knepley                                         void (**funcs)(PetscInt, PetscInt, PetscInt,
89228c6c5593SMatthew G. Knepley                                                        const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
89238c6c5593SMatthew G. Knepley                                                        const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
8924191494d9SMatthew G. Knepley                                                        PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]),
89258c6c5593SMatthew G. Knepley                                         InsertMode mode, Vec localX)
89268c6c5593SMatthew G. Knepley {
89278c6c5593SMatthew G. Knepley   PetscErrorCode ierr;
89288c6c5593SMatthew G. Knepley 
89298c6c5593SMatthew G. Knepley   PetscFunctionBegin;
89308c6c5593SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
8931064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(localU,VEC_CLASSID,8);
8932064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(localX,VEC_CLASSID,11);
8933ece3a9fcSMatthew G. Knepley   if (!dm->ops->projectfieldlabellocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFieldLabelLocal",((PetscObject)dm)->type_name);
89341c531cf8SMatthew G. Knepley   ierr = (dm->ops->projectfieldlabellocal)(dm, time, label, numIds, ids, Nc, comps, localU, funcs, mode, localX);CHKERRQ(ierr);
89358c6c5593SMatthew G. Knepley   PetscFunctionReturn(0);
89368c6c5593SMatthew G. Knepley }
89378c6c5593SMatthew G. Knepley 
89382716604bSToby Isaac /*@C
8939ece3a9fcSMatthew 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.
8940ece3a9fcSMatthew G. Knepley 
8941ece3a9fcSMatthew G. Knepley   Not collective
8942ece3a9fcSMatthew G. Knepley 
8943ece3a9fcSMatthew G. Knepley   Input Parameters:
8944ece3a9fcSMatthew G. Knepley + dm      - The DM
8945ece3a9fcSMatthew G. Knepley . time    - The time
8946ece3a9fcSMatthew G. Knepley . label   - The DMLabel marking the portion of the domain boundary to output
8947ece3a9fcSMatthew G. Knepley . numIds  - The number of label ids to use
8948ece3a9fcSMatthew G. Knepley . ids     - The label ids to use for marking
8949ece3a9fcSMatthew G. Knepley . Nc      - The number of components to set in the output, or PETSC_DETERMINE for all components
8950ece3a9fcSMatthew G. Knepley . comps   - The components to set in the output, or NULL for all components
8951ece3a9fcSMatthew G. Knepley . localU  - The input field vector
8952ece3a9fcSMatthew G. Knepley . funcs   - The functions to evaluate, one per field
8953ece3a9fcSMatthew G. Knepley - mode    - The insertion mode for values
8954ece3a9fcSMatthew G. Knepley 
8955ece3a9fcSMatthew G. Knepley   Output Parameter:
8956ece3a9fcSMatthew G. Knepley . localX  - The output vector
8957ece3a9fcSMatthew G. Knepley 
8958ece3a9fcSMatthew G. Knepley    Calling sequence of func:
8959ece3a9fcSMatthew G. Knepley $    func(PetscInt dim, PetscInt Nf, PetscInt NfAux,
8960ece3a9fcSMatthew G. Knepley $         const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
8961ece3a9fcSMatthew G. Knepley $         const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
8962ece3a9fcSMatthew G. Knepley $         PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f[]);
8963ece3a9fcSMatthew G. Knepley 
8964ece3a9fcSMatthew G. Knepley +  dim          - The spatial dimension
8965ece3a9fcSMatthew G. Knepley .  Nf           - The number of input fields
8966ece3a9fcSMatthew G. Knepley .  NfAux        - The number of input auxiliary fields
8967ece3a9fcSMatthew G. Knepley .  uOff         - The offset of each field in u[]
8968ece3a9fcSMatthew G. Knepley .  uOff_x       - The offset of each field in u_x[]
8969ece3a9fcSMatthew G. Knepley .  u            - The field values at this point in space
8970ece3a9fcSMatthew G. Knepley .  u_t          - The field time derivative at this point in space (or NULL)
8971ece3a9fcSMatthew G. Knepley .  u_x          - The field derivatives at this point in space
8972ece3a9fcSMatthew G. Knepley .  aOff         - The offset of each auxiliary field in u[]
8973ece3a9fcSMatthew G. Knepley .  aOff_x       - The offset of each auxiliary field in u_x[]
8974ece3a9fcSMatthew G. Knepley .  a            - The auxiliary field values at this point in space
8975ece3a9fcSMatthew G. Knepley .  a_t          - The auxiliary field time derivative at this point in space (or NULL)
8976ece3a9fcSMatthew G. Knepley .  a_x          - The auxiliary field derivatives at this point in space
8977ece3a9fcSMatthew G. Knepley .  t            - The current time
8978ece3a9fcSMatthew G. Knepley .  x            - The coordinates of this point
8979ece3a9fcSMatthew G. Knepley .  n            - The face normal
8980ece3a9fcSMatthew G. Knepley .  numConstants - The number of constants
8981ece3a9fcSMatthew G. Knepley .  constants    - The value of each constant
8982ece3a9fcSMatthew G. Knepley -  f            - The value of the function at this point in space
8983ece3a9fcSMatthew G. Knepley 
8984ece3a9fcSMatthew G. Knepley   Note:
8985ece3a9fcSMatthew 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.
8986ece3a9fcSMatthew 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
8987ece3a9fcSMatthew 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
8988ece3a9fcSMatthew 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.
8989ece3a9fcSMatthew G. Knepley 
8990ece3a9fcSMatthew G. Knepley   Level: intermediate
8991ece3a9fcSMatthew G. Knepley 
8992ece3a9fcSMatthew G. Knepley .seealso: DMProjectField(), DMProjectFieldLabelLocal(), DMProjectFunction(), DMComputeL2Diff()
8993ece3a9fcSMatthew G. Knepley @*/
8994ece3a9fcSMatthew G. Knepley PetscErrorCode DMProjectBdFieldLabelLocal(DM dm, PetscReal time, DMLabel label, PetscInt numIds, const PetscInt ids[], PetscInt Nc, const PetscInt comps[], Vec localU,
8995ece3a9fcSMatthew G. Knepley                                           void (**funcs)(PetscInt, PetscInt, PetscInt,
8996ece3a9fcSMatthew G. Knepley                                                          const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
8997ece3a9fcSMatthew G. Knepley                                                          const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
8998ece3a9fcSMatthew G. Knepley                                                          PetscReal, const PetscReal[], const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]),
8999ece3a9fcSMatthew G. Knepley                                           InsertMode mode, Vec localX)
9000ece3a9fcSMatthew G. Knepley {
9001ece3a9fcSMatthew G. Knepley   PetscErrorCode ierr;
9002ece3a9fcSMatthew G. Knepley 
9003ece3a9fcSMatthew G. Knepley   PetscFunctionBegin;
9004ece3a9fcSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
9005064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(localU,VEC_CLASSID,8);
9006064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(localX,VEC_CLASSID,11);
9007ece3a9fcSMatthew G. Knepley   if (!dm->ops->projectbdfieldlabellocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectBdFieldLabelLocal",((PetscObject)dm)->type_name);
9008ece3a9fcSMatthew G. Knepley   ierr = (dm->ops->projectbdfieldlabellocal)(dm, time, label, numIds, ids, Nc, comps, localU, funcs, mode, localX);CHKERRQ(ierr);
9009ece3a9fcSMatthew G. Knepley   PetscFunctionReturn(0);
9010ece3a9fcSMatthew G. Knepley }
9011ece3a9fcSMatthew G. Knepley 
9012ece3a9fcSMatthew G. Knepley /*@C
90132716604bSToby Isaac   DMComputeL2Diff - This function computes the L_2 difference between a function u and an FEM interpolant solution u_h.
90142716604bSToby Isaac 
90152716604bSToby Isaac   Input Parameters:
90162716604bSToby Isaac + dm    - The DM
90170709b2feSToby Isaac . time  - The time
90182716604bSToby Isaac . funcs - The functions to evaluate for each field component
90192716604bSToby Isaac . ctxs  - Optional array of contexts to pass to each function, or NULL.
9020574a98acSMatthew G. Knepley - X     - The coefficient vector u_h, a global vector
90212716604bSToby Isaac 
90222716604bSToby Isaac   Output Parameter:
90232716604bSToby Isaac . diff - The diff ||u - u_h||_2
90242716604bSToby Isaac 
90252716604bSToby Isaac   Level: developer
90262716604bSToby Isaac 
90271189c1efSToby Isaac .seealso: DMProjectFunction(), DMComputeL2FieldDiff(), DMComputeL2GradientDiff()
90282716604bSToby Isaac @*/
90290709b2feSToby Isaac PetscErrorCode DMComputeL2Diff(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, Vec X, PetscReal *diff)
90302716604bSToby Isaac {
90312716604bSToby Isaac   PetscErrorCode ierr;
90322716604bSToby Isaac 
90332716604bSToby Isaac   PetscFunctionBegin;
90342716604bSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
9035b698f381SToby Isaac   PetscValidHeaderSpecific(X,VEC_CLASSID,5);
90360918c465SMatthew G. Knepley   if (!dm->ops->computel2diff) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2Diff",((PetscObject)dm)->type_name);
90370709b2feSToby Isaac   ierr = (dm->ops->computel2diff)(dm,time,funcs,ctxs,X,diff);CHKERRQ(ierr);
90382716604bSToby Isaac   PetscFunctionReturn(0);
90392716604bSToby Isaac }
9040b698f381SToby Isaac 
9041b698f381SToby Isaac /*@C
9042b698f381SToby Isaac   DMComputeL2GradientDiff - This function computes the L_2 difference between the gradient of a function u and an FEM interpolant solution grad u_h.
9043b698f381SToby Isaac 
9044d083f849SBarry Smith   Collective on dm
9045d083f849SBarry Smith 
9046b698f381SToby Isaac   Input Parameters:
9047b698f381SToby Isaac + dm    - The DM
9048b698f381SToby Isaac , time  - The time
9049b698f381SToby Isaac . funcs - The gradient functions to evaluate for each field component
9050b698f381SToby Isaac . ctxs  - Optional array of contexts to pass to each function, or NULL.
9051574a98acSMatthew G. Knepley . X     - The coefficient vector u_h, a global vector
9052b698f381SToby Isaac - n     - The vector to project along
9053b698f381SToby Isaac 
9054b698f381SToby Isaac   Output Parameter:
9055b698f381SToby Isaac . diff - The diff ||(grad u - grad u_h) . n||_2
9056b698f381SToby Isaac 
9057b698f381SToby Isaac   Level: developer
9058b698f381SToby Isaac 
9059b698f381SToby Isaac .seealso: DMProjectFunction(), DMComputeL2Diff()
9060b698f381SToby Isaac @*/
9061b698f381SToby 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)
9062b698f381SToby Isaac {
9063b698f381SToby Isaac   PetscErrorCode ierr;
9064b698f381SToby Isaac 
9065b698f381SToby Isaac   PetscFunctionBegin;
9066b698f381SToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
9067b698f381SToby Isaac   PetscValidHeaderSpecific(X,VEC_CLASSID,5);
9068b698f381SToby Isaac   if (!dm->ops->computel2gradientdiff) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2GradientDiff",((PetscObject)dm)->type_name);
9069b698f381SToby Isaac   ierr = (dm->ops->computel2gradientdiff)(dm,time,funcs,ctxs,X,n,diff);CHKERRQ(ierr);
9070b698f381SToby Isaac   PetscFunctionReturn(0);
9071b698f381SToby Isaac }
9072b698f381SToby Isaac 
90732a16baeaSToby Isaac /*@C
90742a16baeaSToby Isaac   DMComputeL2FieldDiff - This function computes the L_2 difference between a function u and an FEM interpolant solution u_h, separated into field components.
90752a16baeaSToby Isaac 
9076d083f849SBarry Smith   Collective on dm
9077d083f849SBarry Smith 
90782a16baeaSToby Isaac   Input Parameters:
90792a16baeaSToby Isaac + dm    - The DM
90802a16baeaSToby Isaac . time  - The time
90812a16baeaSToby Isaac . funcs - The functions to evaluate for each field component
90822a16baeaSToby Isaac . ctxs  - Optional array of contexts to pass to each function, or NULL.
9083574a98acSMatthew G. Knepley - X     - The coefficient vector u_h, a global vector
90842a16baeaSToby Isaac 
90852a16baeaSToby Isaac   Output Parameter:
90862a16baeaSToby Isaac . diff - The array of differences, ||u^f - u^f_h||_2
90872a16baeaSToby Isaac 
90882a16baeaSToby Isaac   Level: developer
90892a16baeaSToby Isaac 
90901189c1efSToby Isaac .seealso: DMProjectFunction(), DMComputeL2FieldDiff(), DMComputeL2GradientDiff()
90912a16baeaSToby Isaac @*/
90921189c1efSToby Isaac PetscErrorCode DMComputeL2FieldDiff(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, Vec X, PetscReal diff[])
90932a16baeaSToby Isaac {
90942a16baeaSToby Isaac   PetscErrorCode ierr;
90952a16baeaSToby Isaac 
90962a16baeaSToby Isaac   PetscFunctionBegin;
90972a16baeaSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
90982a16baeaSToby Isaac   PetscValidHeaderSpecific(X,VEC_CLASSID,5);
90990918c465SMatthew G. Knepley   if (!dm->ops->computel2fielddiff) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2FieldDiff",((PetscObject)dm)->type_name);
91002a16baeaSToby Isaac   ierr = (dm->ops->computel2fielddiff)(dm,time,funcs,ctxs,X,diff);CHKERRQ(ierr);
91012a16baeaSToby Isaac   PetscFunctionReturn(0);
91022a16baeaSToby Isaac }
91032a16baeaSToby Isaac 
9104df0b854cSToby Isaac /*@C
9105df0b854cSToby Isaac   DMAdaptLabel - Adapt a dm based on a label with values interpreted as coarsening and refining flags.  Specific implementations of DM maybe have
9106cd3c525cSToby Isaac                  specialized flags, but all implementations should accept flag values DM_ADAPT_DETERMINE, DM_ADAPT_KEEP, DM_ADAPT_REFINE, and DM_ADAPT_COARSEN.
9107df0b854cSToby Isaac 
9108df0b854cSToby Isaac   Collective on dm
9109df0b854cSToby Isaac 
9110df0b854cSToby Isaac   Input parameters:
9111df0b854cSToby Isaac + dm - the pre-adaptation DM object
9112a1b0c543SToby Isaac - label - label with the flags
9113df0b854cSToby Isaac 
9114df0b854cSToby Isaac   Output parameters:
91150d1cd5e0SMatthew G. Knepley . dmAdapt - the adapted DM object: may be NULL if an adapted DM could not be produced.
9116df0b854cSToby Isaac 
9117df0b854cSToby Isaac   Level: intermediate
91180d1cd5e0SMatthew G. Knepley 
91190d1cd5e0SMatthew G. Knepley .seealso: DMAdaptMetric(), DMCoarsen(), DMRefine()
9120df0b854cSToby Isaac @*/
91210d1cd5e0SMatthew G. Knepley PetscErrorCode DMAdaptLabel(DM dm, DMLabel label, DM *dmAdapt)
9122df0b854cSToby Isaac {
9123df0b854cSToby Isaac   PetscErrorCode ierr;
9124df0b854cSToby Isaac 
9125df0b854cSToby Isaac   PetscFunctionBegin;
9126df0b854cSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
9127a1b0c543SToby Isaac   PetscValidPointer(label,2);
91280d1cd5e0SMatthew G. Knepley   PetscValidPointer(dmAdapt,3);
91290d1cd5e0SMatthew G. Knepley   *dmAdapt = NULL;
91306f25b0d8SLisandro Dalcin   if (!dm->ops->adaptlabel) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMAdaptLabel",((PetscObject)dm)->type_name);
91310d1cd5e0SMatthew G. Knepley   ierr = (dm->ops->adaptlabel)(dm, label, dmAdapt);CHKERRQ(ierr);
9132a587d139SMark   if (*dmAdapt) {
9133a587d139SMark     (*dmAdapt)->prealloc_only = dm->prealloc_only;  /* maybe this should go .... */
9134a587d139SMark     ierr = PetscFree((*dmAdapt)->vectype);CHKERRQ(ierr);
9135a587d139SMark     ierr = PetscStrallocpy(dm->vectype,(char**)&(*dmAdapt)->vectype);CHKERRQ(ierr);
9136a587d139SMark     ierr = PetscFree((*dmAdapt)->mattype);CHKERRQ(ierr);
9137a587d139SMark     ierr = PetscStrallocpy(dm->mattype,(char**)&(*dmAdapt)->mattype);CHKERRQ(ierr);
9138a587d139SMark   }
91390d1cd5e0SMatthew G. Knepley   PetscFunctionReturn(0);
91400d1cd5e0SMatthew G. Knepley }
91410d1cd5e0SMatthew G. Knepley 
91420d1cd5e0SMatthew G. Knepley /*@C
91430d1cd5e0SMatthew G. Knepley   DMAdaptMetric - Generates a mesh adapted to the specified metric field using the pragmatic library.
91440d1cd5e0SMatthew G. Knepley 
91450d1cd5e0SMatthew G. Knepley   Input Parameters:
91460d1cd5e0SMatthew G. Knepley + dm - The DM object
91470d1cd5e0SMatthew G. Knepley . metric - The metric to which the mesh is adapted, defined vertex-wise.
91486f25b0d8SLisandro 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_".
91490d1cd5e0SMatthew G. Knepley 
91500d1cd5e0SMatthew G. Knepley   Output Parameter:
91510d1cd5e0SMatthew G. Knepley . dmAdapt  - Pointer to the DM object containing the adapted mesh
91520d1cd5e0SMatthew G. Knepley 
91530d1cd5e0SMatthew G. Knepley   Note: The label in the adapted mesh will be registered under the name of the input DMLabel object
91540d1cd5e0SMatthew G. Knepley 
91550d1cd5e0SMatthew G. Knepley   Level: advanced
91560d1cd5e0SMatthew G. Knepley 
91570d1cd5e0SMatthew G. Knepley .seealso: DMAdaptLabel(), DMCoarsen(), DMRefine()
91580d1cd5e0SMatthew G. Knepley @*/
91590d1cd5e0SMatthew G. Knepley PetscErrorCode DMAdaptMetric(DM dm, Vec metric, DMLabel bdLabel, DM *dmAdapt)
91600d1cd5e0SMatthew G. Knepley {
91610d1cd5e0SMatthew G. Knepley   PetscErrorCode ierr;
91620d1cd5e0SMatthew G. Knepley 
91630d1cd5e0SMatthew G. Knepley   PetscFunctionBegin;
91640d1cd5e0SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
91650d1cd5e0SMatthew G. Knepley   PetscValidHeaderSpecific(metric, VEC_CLASSID, 2);
91660d1cd5e0SMatthew G. Knepley   if (bdLabel) PetscValidPointer(bdLabel, 3);
91670d1cd5e0SMatthew G. Knepley   PetscValidPointer(dmAdapt, 4);
91686f25b0d8SLisandro Dalcin   *dmAdapt = NULL;
91696f25b0d8SLisandro Dalcin   if (!dm->ops->adaptmetric) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMAdaptMetric",((PetscObject)dm)->type_name);
91700d1cd5e0SMatthew G. Knepley   ierr = (dm->ops->adaptmetric)(dm, metric, bdLabel, dmAdapt);CHKERRQ(ierr);
9171df0b854cSToby Isaac   PetscFunctionReturn(0);
9172df0b854cSToby Isaac }
9173c4088d22SMatthew G. Knepley 
9174502a2867SDave May /*@C
9175502a2867SDave May  DMGetNeighbors - Gets an array containing the MPI rank of all the processes neighbors
9176502a2867SDave May 
9177502a2867SDave May  Not Collective
9178502a2867SDave May 
9179502a2867SDave May  Input Parameter:
9180502a2867SDave May .  dm    - The DM
9181502a2867SDave May 
91820a19bb7dSprj-  Output Parameters:
91830a19bb7dSprj- +  nranks - the number of neighbours
91840a19bb7dSprj- -  ranks - the neighbors ranks
9185502a2867SDave May 
9186502a2867SDave May  Notes:
9187502a2867SDave May  Do not free the array, it is freed when the DM is destroyed.
9188502a2867SDave May 
9189502a2867SDave May  Level: beginner
9190502a2867SDave May 
9191dec1416fSJunchao Zhang  .seealso: DMDAGetNeighbors(), PetscSFGetRootRanks()
9192502a2867SDave May @*/
9193502a2867SDave May PetscErrorCode DMGetNeighbors(DM dm,PetscInt *nranks,const PetscMPIInt *ranks[])
9194502a2867SDave May {
9195502a2867SDave May   PetscErrorCode ierr;
9196502a2867SDave May 
9197502a2867SDave May   PetscFunctionBegin;
9198502a2867SDave May   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
91990918c465SMatthew G. Knepley   if (!dm->ops->getneighbors) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMGetNeighbors",((PetscObject)dm)->type_name);
9200502a2867SDave May   ierr = (dm->ops->getneighbors)(dm,nranks,ranks);CHKERRQ(ierr);
9201502a2867SDave May   PetscFunctionReturn(0);
9202502a2867SDave May }
9203502a2867SDave May 
9204531c7667SBarry Smith #include <petsc/private/matimpl.h> /* Needed because of coloring->ctype below */
9205531c7667SBarry Smith 
9206531c7667SBarry Smith /*
9207531c7667SBarry Smith     Converts the input vector to a ghosted vector and then calls the standard coloring code.
9208531c7667SBarry Smith     This has be a different function because it requires DM which is not defined in the Mat library
9209531c7667SBarry Smith */
9210531c7667SBarry Smith PetscErrorCode  MatFDColoringApply_AIJDM(Mat J,MatFDColoring coloring,Vec x1,void *sctx)
9211531c7667SBarry Smith {
9212531c7667SBarry Smith   PetscErrorCode ierr;
9213531c7667SBarry Smith 
9214531c7667SBarry Smith   PetscFunctionBegin;
9215531c7667SBarry Smith   if (coloring->ctype == IS_COLORING_LOCAL) {
9216531c7667SBarry Smith     Vec x1local;
9217531c7667SBarry Smith     DM  dm;
9218531c7667SBarry Smith     ierr = MatGetDM(J,&dm);CHKERRQ(ierr);
9219531c7667SBarry Smith     if (!dm) SETERRQ(PetscObjectComm((PetscObject)J),PETSC_ERR_ARG_INCOMP,"IS_COLORING_LOCAL requires a DM");
9220531c7667SBarry Smith     ierr = DMGetLocalVector(dm,&x1local);CHKERRQ(ierr);
9221531c7667SBarry Smith     ierr = DMGlobalToLocalBegin(dm,x1,INSERT_VALUES,x1local);CHKERRQ(ierr);
9222531c7667SBarry Smith     ierr = DMGlobalToLocalEnd(dm,x1,INSERT_VALUES,x1local);CHKERRQ(ierr);
9223531c7667SBarry Smith     x1   = x1local;
9224531c7667SBarry Smith   }
9225531c7667SBarry Smith   ierr = MatFDColoringApply_AIJ(J,coloring,x1,sctx);CHKERRQ(ierr);
9226531c7667SBarry Smith   if (coloring->ctype == IS_COLORING_LOCAL) {
9227531c7667SBarry Smith     DM  dm;
9228531c7667SBarry Smith     ierr = MatGetDM(J,&dm);CHKERRQ(ierr);
9229531c7667SBarry Smith     ierr = DMRestoreLocalVector(dm,&x1);CHKERRQ(ierr);
9230531c7667SBarry Smith   }
9231531c7667SBarry Smith   PetscFunctionReturn(0);
9232531c7667SBarry Smith }
9233531c7667SBarry Smith 
9234531c7667SBarry Smith /*@
9235531c7667SBarry Smith     MatFDColoringUseDM - allows a MatFDColoring object to use the DM associated with the matrix to use a IS_COLORING_LOCAL coloring
9236531c7667SBarry Smith 
9237531c7667SBarry Smith     Input Parameter:
9238531c7667SBarry Smith .    coloring - the MatFDColoring object
9239531c7667SBarry Smith 
924095452b02SPatrick Sanan     Developer Notes:
924195452b02SPatrick Sanan     this routine exists because the PETSc Mat library does not know about the DM objects
9242531c7667SBarry Smith 
92431b266c99SBarry Smith     Level: advanced
92441b266c99SBarry Smith 
9245531c7667SBarry Smith .seealso: MatFDColoring, MatFDColoringCreate(), ISColoringType
9246531c7667SBarry Smith @*/
9247531c7667SBarry Smith PetscErrorCode  MatFDColoringUseDM(Mat coloring,MatFDColoring fdcoloring)
9248531c7667SBarry Smith {
9249531c7667SBarry Smith   PetscFunctionBegin;
9250531c7667SBarry Smith   coloring->ops->fdcoloringapply = MatFDColoringApply_AIJDM;
9251531c7667SBarry Smith   PetscFunctionReturn(0);
9252531c7667SBarry Smith }
92538320bc6fSPatrick Sanan 
92548320bc6fSPatrick Sanan /*@
92558320bc6fSPatrick Sanan     DMGetCompatibility - determine if two DMs are compatible
92568320bc6fSPatrick Sanan 
92578320bc6fSPatrick Sanan     Collective
92588320bc6fSPatrick Sanan 
92598320bc6fSPatrick Sanan     Input Parameters:
9260a5bc1bf3SBarry Smith +    dm1 - the first DM
92618320bc6fSPatrick Sanan -    dm2 - the second DM
92628320bc6fSPatrick Sanan 
92638320bc6fSPatrick Sanan     Output Parameters:
92648320bc6fSPatrick Sanan +    compatible - whether or not the two DMs are compatible
92658320bc6fSPatrick Sanan -    set - whether or not the compatible value was set
92668320bc6fSPatrick Sanan 
92678320bc6fSPatrick Sanan     Notes:
92688320bc6fSPatrick Sanan     Two DMs are deemed compatible if they represent the same parallel decomposition
92693d862458SPatrick Sanan     of the same topology. This implies that the section (field data) on one
92708320bc6fSPatrick Sanan     "makes sense" with respect to the topology and parallel decomposition of the other.
92713d862458SPatrick Sanan     Loosely speaking, compatible DMs represent the same domain and parallel
92723d862458SPatrick Sanan     decomposition, but hold different data.
92738320bc6fSPatrick Sanan 
92748320bc6fSPatrick Sanan     Typically, one would confirm compatibility if intending to simultaneously iterate
92758320bc6fSPatrick Sanan     over a pair of vectors obtained from different DMs.
92768320bc6fSPatrick Sanan 
92778320bc6fSPatrick Sanan     For example, two DMDA objects are compatible if they have the same local
92788320bc6fSPatrick Sanan     and global sizes and the same stencil width. They can have different numbers
92798320bc6fSPatrick Sanan     of degrees of freedom per node. Thus, one could use the node numbering from
92808320bc6fSPatrick Sanan     either DM in bounds for a loop over vectors derived from either DM.
92818320bc6fSPatrick Sanan 
92828320bc6fSPatrick Sanan     Consider the operation of summing data living on a 2-dof DMDA to data living
92838320bc6fSPatrick Sanan     on a 1-dof DMDA, which should be compatible, as in the following snippet.
92848320bc6fSPatrick Sanan .vb
92858320bc6fSPatrick Sanan   ...
92868320bc6fSPatrick Sanan   ierr = DMGetCompatibility(da1,da2,&compatible,&set);CHKERRQ(ierr);
92878320bc6fSPatrick Sanan   if (set && compatible)  {
92888320bc6fSPatrick Sanan     ierr = DMDAVecGetArrayDOF(da1,vec1,&arr1);CHKERRQ(ierr);
92898320bc6fSPatrick Sanan     ierr = DMDAVecGetArrayDOF(da2,vec2,&arr2);CHKERRQ(ierr);
92903d862458SPatrick Sanan     ierr = DMDAGetCorners(da1,&x,&y,NULL,&m,&n,NULL);CHKERRQ(ierr);
92918320bc6fSPatrick Sanan     for (j=y; j<y+n; ++j) {
92928320bc6fSPatrick Sanan       for (i=x; i<x+m, ++i) {
92938320bc6fSPatrick Sanan         arr1[j][i][0] = arr2[j][i][0] + arr2[j][i][1];
92948320bc6fSPatrick Sanan       }
92958320bc6fSPatrick Sanan     }
92968320bc6fSPatrick Sanan     ierr = DMDAVecRestoreArrayDOF(da1,vec1,&arr1);CHKERRQ(ierr);
92978320bc6fSPatrick Sanan     ierr = DMDAVecRestoreArrayDOF(da2,vec2,&arr2);CHKERRQ(ierr);
92988320bc6fSPatrick Sanan   } else {
92998320bc6fSPatrick Sanan     SETERRQ(PetscObjectComm((PetscObject)da1,PETSC_ERR_ARG_INCOMP,"DMDA objects incompatible");
93008320bc6fSPatrick Sanan   }
93018320bc6fSPatrick Sanan   ...
93028320bc6fSPatrick Sanan .ve
93038320bc6fSPatrick Sanan 
93048320bc6fSPatrick Sanan     Checking compatibility might be expensive for a given implementation of DM,
93058320bc6fSPatrick Sanan     or might be impossible to unambiguously confirm or deny. For this reason,
93068320bc6fSPatrick Sanan     this function may decline to determine compatibility, and hence users should
93078320bc6fSPatrick Sanan     always check the "set" output parameter.
93088320bc6fSPatrick Sanan 
93098320bc6fSPatrick Sanan     A DM is always compatible with itself.
93108320bc6fSPatrick Sanan 
93118320bc6fSPatrick Sanan     In the current implementation, DMs which live on "unequal" communicators
93128320bc6fSPatrick Sanan     (MPI_UNEQUAL in the terminology of MPI_Comm_compare()) are always deemed
93138320bc6fSPatrick Sanan     incompatible.
93148320bc6fSPatrick Sanan 
93158320bc6fSPatrick Sanan     This function is labeled "Collective," as information about all subdomains
93168320bc6fSPatrick Sanan     is required on each rank. However, in DM implementations which store all this
93178320bc6fSPatrick Sanan     information locally, this function may be merely "Logically Collective".
93188320bc6fSPatrick Sanan 
93198320bc6fSPatrick Sanan     Developer Notes:
93203d862458SPatrick Sanan     Compatibility is assumed to be a symmetric concept; DM A is compatible with DM B
93213d862458SPatrick Sanan     iff B is compatible with A. Thus, this function checks the implementations
9322a5bc1bf3SBarry Smith     of both dm and dmc (if they are of different types), attempting to determine
93238320bc6fSPatrick Sanan     compatibility. It is left to DM implementers to ensure that symmetry is
93248320bc6fSPatrick Sanan     preserved. The simplest way to do this is, when implementing type-specific
93253d862458SPatrick Sanan     logic for this function, is to check for existing logic in the implementation
93263d862458SPatrick Sanan     of other DM types and let *set = PETSC_FALSE if found.
93278320bc6fSPatrick Sanan 
93288320bc6fSPatrick Sanan     Level: advanced
93298320bc6fSPatrick Sanan 
93303d862458SPatrick Sanan .seealso: DM, DMDACreateCompatibleDMDA(), DMStagCreateCompatibleDMStag()
93318320bc6fSPatrick Sanan @*/
93328320bc6fSPatrick Sanan 
9333a5bc1bf3SBarry Smith PetscErrorCode DMGetCompatibility(DM dm1,DM dm2,PetscBool *compatible,PetscBool *set)
93348320bc6fSPatrick Sanan {
93358320bc6fSPatrick Sanan   PetscErrorCode ierr;
93368320bc6fSPatrick Sanan   PetscMPIInt    compareResult;
93378320bc6fSPatrick Sanan   DMType         type,type2;
93388320bc6fSPatrick Sanan   PetscBool      sameType;
93398320bc6fSPatrick Sanan 
93408320bc6fSPatrick Sanan   PetscFunctionBegin;
9341a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(dm1,DM_CLASSID,1);
93428320bc6fSPatrick Sanan   PetscValidHeaderSpecific(dm2,DM_CLASSID,2);
93438320bc6fSPatrick Sanan 
93448320bc6fSPatrick Sanan   /* Declare a DM compatible with itself */
9345a5bc1bf3SBarry Smith   if (dm1 == dm2) {
93468320bc6fSPatrick Sanan     *set = PETSC_TRUE;
93478320bc6fSPatrick Sanan     *compatible = PETSC_TRUE;
93488320bc6fSPatrick Sanan     PetscFunctionReturn(0);
93498320bc6fSPatrick Sanan   }
93508320bc6fSPatrick Sanan 
93518320bc6fSPatrick Sanan   /* Declare a DM incompatible with a DM that lives on an "unequal"
93528320bc6fSPatrick Sanan      communicator. Note that this does not preclude compatibility with
93538320bc6fSPatrick Sanan      DMs living on "congruent" or "similar" communicators, but this must be
93548320bc6fSPatrick Sanan      determined by the implementation-specific logic */
9355ffc4695bSBarry Smith   ierr = MPI_Comm_compare(PetscObjectComm((PetscObject)dm1),PetscObjectComm((PetscObject)dm2),&compareResult);CHKERRMPI(ierr);
93568320bc6fSPatrick Sanan   if (compareResult == MPI_UNEQUAL) {
93578320bc6fSPatrick Sanan     *set = PETSC_TRUE;
93588320bc6fSPatrick Sanan     *compatible = PETSC_FALSE;
93598320bc6fSPatrick Sanan     PetscFunctionReturn(0);
93608320bc6fSPatrick Sanan   }
93618320bc6fSPatrick Sanan 
93628320bc6fSPatrick Sanan   /* Pass to the implementation-specific routine, if one exists. */
9363a5bc1bf3SBarry Smith   if (dm1->ops->getcompatibility) {
9364a5bc1bf3SBarry Smith     ierr = (*dm1->ops->getcompatibility)(dm1,dm2,compatible,set);CHKERRQ(ierr);
9365b9d85ea2SLisandro Dalcin     if (*set) PetscFunctionReturn(0);
93668320bc6fSPatrick Sanan   }
93678320bc6fSPatrick Sanan 
9368a5bc1bf3SBarry Smith   /* If dm1 and dm2 are of different types, then attempt to check compatibility
93698320bc6fSPatrick Sanan      with an implementation of this function from dm2 */
9370a5bc1bf3SBarry Smith   ierr = DMGetType(dm1,&type);CHKERRQ(ierr);
93718320bc6fSPatrick Sanan   ierr = DMGetType(dm2,&type2);CHKERRQ(ierr);
93728320bc6fSPatrick Sanan   ierr = PetscStrcmp(type,type2,&sameType);CHKERRQ(ierr);
93738320bc6fSPatrick Sanan   if (!sameType && dm2->ops->getcompatibility) {
9374a5bc1bf3SBarry Smith     ierr = (*dm2->ops->getcompatibility)(dm2,dm1,compatible,set);CHKERRQ(ierr); /* Note argument order */
93758320bc6fSPatrick Sanan   } else {
93768320bc6fSPatrick Sanan     *set = PETSC_FALSE;
93778320bc6fSPatrick Sanan   }
93788320bc6fSPatrick Sanan   PetscFunctionReturn(0);
93798320bc6fSPatrick Sanan }
9380c0f0dcc3SMatthew G. Knepley 
9381c0f0dcc3SMatthew G. Knepley /*@C
9382c0f0dcc3SMatthew G. Knepley   DMMonitorSet - Sets an ADDITIONAL function that is to be used after a solve to monitor discretization performance.
9383c0f0dcc3SMatthew G. Knepley 
9384c0f0dcc3SMatthew G. Knepley   Logically Collective on DM
9385c0f0dcc3SMatthew G. Knepley 
9386c0f0dcc3SMatthew G. Knepley   Input Parameters:
9387c0f0dcc3SMatthew G. Knepley + DM - the DM
9388c0f0dcc3SMatthew G. Knepley . f - the monitor function
9389c0f0dcc3SMatthew G. Knepley . mctx - [optional] user-defined context for private data for the monitor routine (use NULL if no context is desired)
9390c0f0dcc3SMatthew G. Knepley - monitordestroy - [optional] routine that frees monitor context (may be NULL)
9391c0f0dcc3SMatthew G. Knepley 
9392c0f0dcc3SMatthew G. Knepley   Options Database Keys:
9393c0f0dcc3SMatthew G. Knepley - -dm_monitor_cancel - cancels all monitors that have been hardwired into a code by calls to DMMonitorSet(), but
9394c0f0dcc3SMatthew G. Knepley                             does not cancel those set via the options database.
9395c0f0dcc3SMatthew G. Knepley 
9396c0f0dcc3SMatthew G. Knepley   Notes:
9397c0f0dcc3SMatthew G. Knepley   Several different monitoring routines may be set by calling
9398c0f0dcc3SMatthew G. Knepley   DMMonitorSet() multiple times; all will be called in the
9399c0f0dcc3SMatthew G. Knepley   order in which they were set.
9400c0f0dcc3SMatthew G. Knepley 
9401c0f0dcc3SMatthew G. Knepley   Fortran Notes:
9402c0f0dcc3SMatthew G. Knepley   Only a single monitor function can be set for each DM object
9403c0f0dcc3SMatthew G. Knepley 
9404c0f0dcc3SMatthew G. Knepley   Level: intermediate
9405c0f0dcc3SMatthew G. Knepley 
9406c0f0dcc3SMatthew G. Knepley .seealso: DMMonitorCancel()
9407c0f0dcc3SMatthew G. Knepley @*/
9408c0f0dcc3SMatthew G. Knepley PetscErrorCode DMMonitorSet(DM dm, PetscErrorCode (*f)(DM, void *), void *mctx, PetscErrorCode (*monitordestroy)(void**))
9409c0f0dcc3SMatthew G. Knepley {
9410c0f0dcc3SMatthew G. Knepley   PetscInt       m;
9411c0f0dcc3SMatthew G. Knepley   PetscErrorCode ierr;
9412c0f0dcc3SMatthew G. Knepley 
9413c0f0dcc3SMatthew G. Knepley   PetscFunctionBegin;
9414c0f0dcc3SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
9415c0f0dcc3SMatthew G. Knepley   for (m = 0; m < dm->numbermonitors; ++m) {
9416c0f0dcc3SMatthew G. Knepley     PetscBool identical;
9417c0f0dcc3SMatthew G. Knepley 
9418c0f0dcc3SMatthew G. Knepley     ierr = PetscMonitorCompare((PetscErrorCode (*)(void)) f, mctx, monitordestroy, (PetscErrorCode (*)(void)) dm->monitor[m], dm->monitorcontext[m], dm->monitordestroy[m], &identical);CHKERRQ(ierr);
9419c0f0dcc3SMatthew G. Knepley     if (identical) PetscFunctionReturn(0);
9420c0f0dcc3SMatthew G. Knepley   }
9421c0f0dcc3SMatthew G. Knepley   if (dm->numbermonitors >= MAXDMMONITORS) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Too many monitors set");
9422c0f0dcc3SMatthew G. Knepley   dm->monitor[dm->numbermonitors]          = f;
9423c0f0dcc3SMatthew G. Knepley   dm->monitordestroy[dm->numbermonitors]   = monitordestroy;
9424c0f0dcc3SMatthew G. Knepley   dm->monitorcontext[dm->numbermonitors++] = (void *) mctx;
9425c0f0dcc3SMatthew G. Knepley   PetscFunctionReturn(0);
9426c0f0dcc3SMatthew G. Knepley }
9427c0f0dcc3SMatthew G. Knepley 
9428c0f0dcc3SMatthew G. Knepley /*@
9429c0f0dcc3SMatthew G. Knepley   DMMonitorCancel - Clears all the monitor functions for a DM object.
9430c0f0dcc3SMatthew G. Knepley 
9431c0f0dcc3SMatthew G. Knepley   Logically Collective on DM
9432c0f0dcc3SMatthew G. Knepley 
9433c0f0dcc3SMatthew G. Knepley   Input Parameter:
9434c0f0dcc3SMatthew G. Knepley . dm - the DM
9435c0f0dcc3SMatthew G. Knepley 
9436c0f0dcc3SMatthew G. Knepley   Options Database Key:
9437c0f0dcc3SMatthew G. Knepley . -dm_monitor_cancel - cancels all monitors that have been hardwired
9438c0f0dcc3SMatthew G. Knepley   into a code by calls to DMonitorSet(), but does not cancel those
9439c0f0dcc3SMatthew G. Knepley   set via the options database
9440c0f0dcc3SMatthew G. Knepley 
9441c0f0dcc3SMatthew G. Knepley   Notes:
9442c0f0dcc3SMatthew G. Knepley   There is no way to clear one specific monitor from a DM object.
9443c0f0dcc3SMatthew G. Knepley 
9444c0f0dcc3SMatthew G. Knepley   Level: intermediate
9445c0f0dcc3SMatthew G. Knepley 
9446c0f0dcc3SMatthew G. Knepley .seealso: DMMonitorSet()
9447c0f0dcc3SMatthew G. Knepley @*/
9448c0f0dcc3SMatthew G. Knepley PetscErrorCode DMMonitorCancel(DM dm)
9449c0f0dcc3SMatthew G. Knepley {
9450c0f0dcc3SMatthew G. Knepley   PetscErrorCode ierr;
9451c0f0dcc3SMatthew G. Knepley   PetscInt       m;
9452c0f0dcc3SMatthew G. Knepley 
9453c0f0dcc3SMatthew G. Knepley   PetscFunctionBegin;
9454c0f0dcc3SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
9455c0f0dcc3SMatthew G. Knepley   for (m = 0; m < dm->numbermonitors; ++m) {
9456c0f0dcc3SMatthew G. Knepley     if (dm->monitordestroy[m]) {ierr = (*dm->monitordestroy[m])(&dm->monitorcontext[m]);CHKERRQ(ierr);}
9457c0f0dcc3SMatthew G. Knepley   }
9458c0f0dcc3SMatthew G. Knepley   dm->numbermonitors = 0;
9459c0f0dcc3SMatthew G. Knepley   PetscFunctionReturn(0);
9460c0f0dcc3SMatthew G. Knepley }
9461c0f0dcc3SMatthew G. Knepley 
9462c0f0dcc3SMatthew G. Knepley /*@C
9463c0f0dcc3SMatthew G. Knepley   DMMonitorSetFromOptions - Sets a monitor function and viewer appropriate for the type indicated by the user
9464c0f0dcc3SMatthew G. Knepley 
9465c0f0dcc3SMatthew G. Knepley   Collective on DM
9466c0f0dcc3SMatthew G. Knepley 
9467c0f0dcc3SMatthew G. Knepley   Input Parameters:
9468c0f0dcc3SMatthew G. Knepley + dm   - DM object you wish to monitor
9469c0f0dcc3SMatthew G. Knepley . name - the monitor type one is seeking
9470c0f0dcc3SMatthew G. Knepley . help - message indicating what monitoring is done
9471c0f0dcc3SMatthew G. Knepley . manual - manual page for the monitor
9472c0f0dcc3SMatthew G. Knepley . monitor - the monitor function
9473c0f0dcc3SMatthew 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
9474c0f0dcc3SMatthew G. Knepley 
9475c0f0dcc3SMatthew G. Knepley   Output Parameter:
9476c0f0dcc3SMatthew G. Knepley . flg - Flag set if the monitor was created
9477c0f0dcc3SMatthew G. Knepley 
9478c0f0dcc3SMatthew G. Knepley   Level: developer
9479c0f0dcc3SMatthew G. Knepley 
9480c0f0dcc3SMatthew G. Knepley .seealso: PetscOptionsGetViewer(), PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(),
9481c0f0dcc3SMatthew G. Knepley           PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool()
9482c0f0dcc3SMatthew G. Knepley           PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(),
9483c0f0dcc3SMatthew G. Knepley           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
9484c0f0dcc3SMatthew G. Knepley           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
9485c0f0dcc3SMatthew G. Knepley           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
9486c0f0dcc3SMatthew G. Knepley           PetscOptionsFList(), PetscOptionsEList()
9487c0f0dcc3SMatthew G. Knepley @*/
9488c0f0dcc3SMatthew 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)
9489c0f0dcc3SMatthew G. Knepley {
9490c0f0dcc3SMatthew G. Knepley   PetscViewer       viewer;
9491c0f0dcc3SMatthew G. Knepley   PetscViewerFormat format;
9492c0f0dcc3SMatthew G. Knepley   PetscErrorCode    ierr;
9493c0f0dcc3SMatthew G. Knepley 
9494c0f0dcc3SMatthew G. Knepley   PetscFunctionBegin;
9495c0f0dcc3SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
9496c0f0dcc3SMatthew G. Knepley   ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject) dm), ((PetscObject) dm)->options, ((PetscObject) dm)->prefix, name, &viewer, &format, flg);CHKERRQ(ierr);
9497c0f0dcc3SMatthew G. Knepley   if (*flg) {
9498c0f0dcc3SMatthew G. Knepley     PetscViewerAndFormat *vf;
9499c0f0dcc3SMatthew G. Knepley 
9500c0f0dcc3SMatthew G. Knepley     ierr = PetscViewerAndFormatCreate(viewer, format, &vf);CHKERRQ(ierr);
9501c0f0dcc3SMatthew G. Knepley     ierr = PetscObjectDereference((PetscObject) viewer);CHKERRQ(ierr);
9502c0f0dcc3SMatthew G. Knepley     if (monitorsetup) {ierr = (*monitorsetup)(dm, vf);CHKERRQ(ierr);}
9503c0f0dcc3SMatthew G. Knepley     ierr = DMMonitorSet(dm,(PetscErrorCode (*)(DM, void *)) monitor, vf, (PetscErrorCode (*)(void **)) PetscViewerAndFormatDestroy);CHKERRQ(ierr);
9504c0f0dcc3SMatthew G. Knepley   }
9505c0f0dcc3SMatthew G. Knepley   PetscFunctionReturn(0);
9506c0f0dcc3SMatthew G. Knepley }
9507c0f0dcc3SMatthew G. Knepley 
9508c0f0dcc3SMatthew G. Knepley /*@
9509c0f0dcc3SMatthew G. Knepley    DMMonitor - runs the user provided monitor routines, if they exist
9510c0f0dcc3SMatthew G. Knepley 
9511c0f0dcc3SMatthew G. Knepley    Collective on DM
9512c0f0dcc3SMatthew G. Knepley 
9513c0f0dcc3SMatthew G. Knepley    Input Parameters:
9514c0f0dcc3SMatthew G. Knepley .  dm - The DM
9515c0f0dcc3SMatthew G. Knepley 
9516c0f0dcc3SMatthew G. Knepley    Level: developer
9517c0f0dcc3SMatthew G. Knepley 
9518c0f0dcc3SMatthew G. Knepley .seealso: DMMonitorSet()
9519c0f0dcc3SMatthew G. Knepley @*/
9520c0f0dcc3SMatthew G. Knepley PetscErrorCode DMMonitor(DM dm)
9521c0f0dcc3SMatthew G. Knepley {
9522c0f0dcc3SMatthew G. Knepley   PetscInt       m;
9523c0f0dcc3SMatthew G. Knepley   PetscErrorCode ierr;
9524c0f0dcc3SMatthew G. Knepley 
9525c0f0dcc3SMatthew G. Knepley   PetscFunctionBegin;
9526c0f0dcc3SMatthew G. Knepley   if (!dm) PetscFunctionReturn(0);
9527c0f0dcc3SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
9528c0f0dcc3SMatthew G. Knepley   for (m = 0; m < dm->numbermonitors; ++m) {
9529c0f0dcc3SMatthew G. Knepley     ierr = (*dm->monitor[m])(dm, dm->monitorcontext[m]);CHKERRQ(ierr);
9530c0f0dcc3SMatthew G. Knepley   }
9531c0f0dcc3SMatthew G. Knepley   PetscFunctionReturn(0);
9532c0f0dcc3SMatthew G. Knepley }
95332e4af2aeSMatthew G. Knepley 
95342e4af2aeSMatthew G. Knepley /*@
95352e4af2aeSMatthew G. Knepley   DMComputeError - Computes the error assuming the user has given exact solution functions
95362e4af2aeSMatthew G. Knepley 
95372e4af2aeSMatthew G. Knepley   Collective on DM
95382e4af2aeSMatthew G. Knepley 
95392e4af2aeSMatthew G. Knepley   Input Parameters:
95402e4af2aeSMatthew G. Knepley + dm     - The DM
95412e4af2aeSMatthew G. Knepley . sol    - The solution vector
95422e4af2aeSMatthew G. Knepley . errors - An array of length Nf, the number of fields, or NULL for no output
954399c90e12SSatish Balay - errorVec - A Vec pointer, or NULL for no output
95442e4af2aeSMatthew G. Knepley 
95452e4af2aeSMatthew G. Knepley   Output Parameters:
95462e4af2aeSMatthew G. Knepley + errors   - The error in each field
95472e4af2aeSMatthew G. Knepley - errorVec - Creates a vector to hold the cellwise error
95482e4af2aeSMatthew G. Knepley 
95492e4af2aeSMatthew G. Knepley   Note: The exact solutions come from the PetscDS object, and the time comes from DMGetOutputSequenceNumber().
95502e4af2aeSMatthew G. Knepley 
95512e4af2aeSMatthew G. Knepley   Level: developer
95522e4af2aeSMatthew G. Knepley 
95532e4af2aeSMatthew G. Knepley .seealso: DMMonitorSet(), DMGetRegionNumDS(), PetscDSGetExactSolution(), DMGetOutputSequenceNumber()
95542e4af2aeSMatthew G. Knepley @*/
95552e4af2aeSMatthew G. Knepley PetscErrorCode DMComputeError(DM dm, Vec sol, PetscReal errors[], Vec *errorVec)
95562e4af2aeSMatthew G. Knepley {
95572e4af2aeSMatthew G. Knepley   PetscErrorCode (**exactSol)(PetscInt, PetscReal, const PetscReal[], PetscInt, PetscScalar[], void *);
95582e4af2aeSMatthew G. Knepley   void            **ctxs;
95592e4af2aeSMatthew G. Knepley   PetscReal         time;
95602e4af2aeSMatthew G. Knepley   PetscInt          Nf, f, Nds, s;
95612e4af2aeSMatthew G. Knepley   PetscErrorCode    ierr;
95622e4af2aeSMatthew G. Knepley 
95632e4af2aeSMatthew G. Knepley   PetscFunctionBegin;
95642e4af2aeSMatthew G. Knepley   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
95652e4af2aeSMatthew G. Knepley   ierr = PetscCalloc2(Nf, &exactSol, Nf, &ctxs);CHKERRQ(ierr);
95662e4af2aeSMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
95672e4af2aeSMatthew G. Knepley   for (s = 0; s < Nds; ++s) {
95682e4af2aeSMatthew G. Knepley     PetscDS         ds;
95692e4af2aeSMatthew G. Knepley     DMLabel         label;
95702e4af2aeSMatthew G. Knepley     IS              fieldIS;
95712e4af2aeSMatthew G. Knepley     const PetscInt *fields;
95722e4af2aeSMatthew G. Knepley     PetscInt        dsNf;
95732e4af2aeSMatthew G. Knepley 
95742e4af2aeSMatthew G. Knepley     ierr = DMGetRegionNumDS(dm, s, &label, &fieldIS, &ds);CHKERRQ(ierr);
95752e4af2aeSMatthew G. Knepley     ierr = PetscDSGetNumFields(ds, &dsNf);CHKERRQ(ierr);
95762e4af2aeSMatthew G. Knepley     if (fieldIS) {ierr = ISGetIndices(fieldIS, &fields);CHKERRQ(ierr);}
95772e4af2aeSMatthew G. Knepley     for (f = 0; f < dsNf; ++f) {
95782e4af2aeSMatthew G. Knepley       const PetscInt field = fields[f];
95792e4af2aeSMatthew G. Knepley       ierr = PetscDSGetExactSolution(ds, field, &exactSol[field], &ctxs[field]);CHKERRQ(ierr);
95802e4af2aeSMatthew G. Knepley     }
95812e4af2aeSMatthew G. Knepley     if (fieldIS) {ierr = ISRestoreIndices(fieldIS, &fields);CHKERRQ(ierr);}
95822e4af2aeSMatthew G. Knepley   }
95832e4af2aeSMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
95842e4af2aeSMatthew 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);
95852e4af2aeSMatthew G. Knepley   }
95862e4af2aeSMatthew G. Knepley   ierr = DMGetOutputSequenceNumber(dm, NULL, &time);CHKERRQ(ierr);
95872e4af2aeSMatthew G. Knepley   if (errors) {ierr = DMComputeL2FieldDiff(dm, time, exactSol, ctxs, sol, errors);CHKERRQ(ierr);}
95882e4af2aeSMatthew G. Knepley   if (errorVec) {
95892e4af2aeSMatthew G. Knepley     DM             edm;
95902e4af2aeSMatthew G. Knepley     DMPolytopeType ct;
95912e4af2aeSMatthew G. Knepley     PetscBool      simplex;
95922e4af2aeSMatthew G. Knepley     PetscInt       dim, cStart, Nf;
95932e4af2aeSMatthew G. Knepley 
95942e4af2aeSMatthew G. Knepley     ierr = DMClone(dm, &edm);CHKERRQ(ierr);
95952e4af2aeSMatthew G. Knepley     ierr = DMGetDimension(edm, &dim);CHKERRQ(ierr);
95962e4af2aeSMatthew G. Knepley     ierr = DMPlexGetHeightStratum(dm, 0, &cStart, NULL);CHKERRQ(ierr);
95972e4af2aeSMatthew G. Knepley     ierr = DMPlexGetCellType(dm, cStart, &ct);CHKERRQ(ierr);
95982e4af2aeSMatthew G. Knepley     simplex = DMPolytopeTypeGetNumVertices(ct) == DMPolytopeTypeGetDim(ct)+1 ? PETSC_TRUE : PETSC_FALSE;
95992e4af2aeSMatthew G. Knepley     ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
96002e4af2aeSMatthew G. Knepley     for (f = 0; f < Nf; ++f) {
96012e4af2aeSMatthew G. Knepley       PetscFE         fe, efe;
96022e4af2aeSMatthew G. Knepley       PetscQuadrature q;
96032e4af2aeSMatthew G. Knepley       const char     *name;
96042e4af2aeSMatthew G. Knepley 
96052e4af2aeSMatthew G. Knepley       ierr = DMGetField(dm, f, NULL, (PetscObject *) &fe);CHKERRQ(ierr);
96062e4af2aeSMatthew G. Knepley       ierr = PetscFECreateLagrange(PETSC_COMM_SELF, dim, Nf, simplex, 0, PETSC_DETERMINE, &efe);CHKERRQ(ierr);
96072e4af2aeSMatthew G. Knepley       ierr = PetscObjectGetName((PetscObject) fe, &name);CHKERRQ(ierr);
96082e4af2aeSMatthew G. Knepley       ierr = PetscObjectSetName((PetscObject) efe, name);CHKERRQ(ierr);
96092e4af2aeSMatthew G. Knepley       ierr = PetscFEGetQuadrature(fe, &q);CHKERRQ(ierr);
96102e4af2aeSMatthew G. Knepley       ierr = PetscFESetQuadrature(efe, q);CHKERRQ(ierr);
96112e4af2aeSMatthew G. Knepley       ierr = DMSetField(edm, f, NULL, (PetscObject) efe);CHKERRQ(ierr);
96122e4af2aeSMatthew G. Knepley       ierr = PetscFEDestroy(&efe);CHKERRQ(ierr);
96132e4af2aeSMatthew G. Knepley     }
96142e4af2aeSMatthew G. Knepley     ierr = DMCreateDS(edm);CHKERRQ(ierr);
96152e4af2aeSMatthew G. Knepley 
96161e1ea65dSPierre Jolivet     ierr = DMCreateGlobalVector(edm, errorVec);CHKERRQ(ierr);
96172e4af2aeSMatthew G. Knepley     ierr = PetscObjectSetName((PetscObject) *errorVec, "Error");CHKERRQ(ierr);
96182e4af2aeSMatthew G. Knepley     ierr = DMPlexComputeL2DiffVec(dm, time, exactSol, ctxs, sol, *errorVec);CHKERRQ(ierr);
96192e4af2aeSMatthew G. Knepley     ierr = DMDestroy(&edm);CHKERRQ(ierr);
96202e4af2aeSMatthew G. Knepley   }
96212e4af2aeSMatthew G. Knepley   ierr = PetscFree2(exactSol, ctxs);CHKERRQ(ierr);
96222e4af2aeSMatthew G. Knepley   PetscFunctionReturn(0);
96232e4af2aeSMatthew G. Knepley }
96249a2a23afSMatthew G. Knepley 
96259a2a23afSMatthew G. Knepley /*@
96269a2a23afSMatthew G. Knepley   DMGetNumAuxiliaryVec - Get the number of auxiliary vectors associated with this DM
96279a2a23afSMatthew G. Knepley 
96289a2a23afSMatthew G. Knepley   Not collective
96299a2a23afSMatthew G. Knepley 
96309a2a23afSMatthew G. Knepley   Input Parameter:
96319a2a23afSMatthew G. Knepley . dm     - The DM
96329a2a23afSMatthew G. Knepley 
96339a2a23afSMatthew G. Knepley   Output Parameter:
96349a2a23afSMatthew G. Knepley . numAux - The nubmer of auxiliary data vectors
96359a2a23afSMatthew G. Knepley 
96369a2a23afSMatthew G. Knepley   Level: advanced
96379a2a23afSMatthew G. Knepley 
96389a2a23afSMatthew G. Knepley .seealso: DMGetAuxiliaryLabels(), DMGetAuxiliaryVec(), DMSetAuxiliaryVec()
96399a2a23afSMatthew G. Knepley @*/
96409a2a23afSMatthew G. Knepley PetscErrorCode DMGetNumAuxiliaryVec(DM dm, PetscInt *numAux)
96419a2a23afSMatthew G. Knepley {
96429a2a23afSMatthew G. Knepley   PetscErrorCode ierr;
96439a2a23afSMatthew G. Knepley 
96449a2a23afSMatthew G. Knepley   PetscFunctionBegin;
96459a2a23afSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
96469a2a23afSMatthew G. Knepley   ierr = PetscHMapAuxGetSize(dm->auxData, numAux);CHKERRQ(ierr);
96479a2a23afSMatthew G. Knepley   PetscFunctionReturn(0);
96489a2a23afSMatthew G. Knepley }
96499a2a23afSMatthew G. Knepley 
96509a2a23afSMatthew G. Knepley /*@
96519a2a23afSMatthew G. Knepley   DMGetAuxiliaryVec - Get the auxiliary vector for region specified by the given label and value
96529a2a23afSMatthew G. Knepley 
96539a2a23afSMatthew G. Knepley   Not collective
96549a2a23afSMatthew G. Knepley 
96559a2a23afSMatthew G. Knepley   Input Parameters:
96569a2a23afSMatthew G. Knepley + dm     - The DM
96579a2a23afSMatthew G. Knepley . label  - The DMLabel
96589a2a23afSMatthew G. Knepley - value  - The label value indicating the region
96599a2a23afSMatthew G. Knepley 
96609a2a23afSMatthew G. Knepley   Output Parameter:
96619a2a23afSMatthew G. Knepley . aux    - The Vec holding auxiliary field data
96629a2a23afSMatthew G. Knepley 
966304c51a94SMatthew G. Knepley   Note: If no auxiliary vector is found for this (label, value), (NULL, 0) is checked as well.
966404c51a94SMatthew G. Knepley 
96659a2a23afSMatthew G. Knepley   Level: advanced
96669a2a23afSMatthew G. Knepley 
96679a2a23afSMatthew G. Knepley .seealso: DMSetAuxiliaryVec(), DMGetNumAuxiliaryVec()
96689a2a23afSMatthew G. Knepley @*/
96699a2a23afSMatthew G. Knepley PetscErrorCode DMGetAuxiliaryVec(DM dm, DMLabel label, PetscInt value, Vec *aux)
96709a2a23afSMatthew G. Knepley {
967104c51a94SMatthew G. Knepley   PetscHashAuxKey key, wild = {NULL, 0};
967204c51a94SMatthew G. Knepley   PetscBool       has;
96739a2a23afSMatthew G. Knepley   PetscErrorCode  ierr;
96749a2a23afSMatthew G. Knepley 
96759a2a23afSMatthew G. Knepley   PetscFunctionBegin;
96769a2a23afSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
96779a2a23afSMatthew G. Knepley   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
96789a2a23afSMatthew G. Knepley   key.label = label;
96799a2a23afSMatthew G. Knepley   key.value = value;
968004c51a94SMatthew G. Knepley   ierr = PetscHMapAuxHas(dm->auxData, key, &has);CHKERRQ(ierr);
968104c51a94SMatthew G. Knepley   if (has) {ierr = PetscHMapAuxGet(dm->auxData, key,  aux);CHKERRQ(ierr);}
968204c51a94SMatthew G. Knepley   else     {ierr = PetscHMapAuxGet(dm->auxData, wild, aux);CHKERRQ(ierr);}
96839a2a23afSMatthew G. Knepley   PetscFunctionReturn(0);
96849a2a23afSMatthew G. Knepley }
96859a2a23afSMatthew G. Knepley 
96869a2a23afSMatthew G. Knepley /*@
96879a2a23afSMatthew G. Knepley   DMSetAuxiliaryVec - Set the auxiliary vector for region specified by the given label and value
96889a2a23afSMatthew G. Knepley 
96899a2a23afSMatthew G. Knepley   Not collective
96909a2a23afSMatthew G. Knepley 
96919a2a23afSMatthew G. Knepley   Input Parameters:
96929a2a23afSMatthew G. Knepley + dm     - The DM
96939a2a23afSMatthew G. Knepley . label  - The DMLabel
96949a2a23afSMatthew G. Knepley . value  - The label value indicating the region
96959a2a23afSMatthew G. Knepley - aux    - The Vec holding auxiliary field data
96969a2a23afSMatthew G. Knepley 
96979a2a23afSMatthew G. Knepley   Level: advanced
96989a2a23afSMatthew G. Knepley 
96999a2a23afSMatthew G. Knepley .seealso: DMGetAuxiliaryVec()
97009a2a23afSMatthew G. Knepley @*/
97019a2a23afSMatthew G. Knepley PetscErrorCode DMSetAuxiliaryVec(DM dm, DMLabel label, PetscInt value, Vec aux)
97029a2a23afSMatthew G. Knepley {
97039a2a23afSMatthew G. Knepley   Vec             old;
97049a2a23afSMatthew G. Knepley   PetscHashAuxKey key;
97059a2a23afSMatthew G. Knepley   PetscErrorCode  ierr;
97069a2a23afSMatthew G. Knepley 
97079a2a23afSMatthew G. Knepley   PetscFunctionBegin;
97089a2a23afSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
97099a2a23afSMatthew G. Knepley   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
97109a2a23afSMatthew G. Knepley   key.label = label;
97119a2a23afSMatthew G. Knepley   key.value = value;
97129a2a23afSMatthew G. Knepley   ierr = PetscHMapAuxGet(dm->auxData, key, &old);CHKERRQ(ierr);
97139a2a23afSMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) aux);CHKERRQ(ierr);
97149a2a23afSMatthew G. Knepley   ierr = PetscObjectDereference((PetscObject) old);CHKERRQ(ierr);
97159a2a23afSMatthew G. Knepley   if (!aux) {ierr = PetscHMapAuxDel(dm->auxData, key);CHKERRQ(ierr);}
97169a2a23afSMatthew G. Knepley   else      {ierr = PetscHMapAuxSet(dm->auxData, key, aux);CHKERRQ(ierr);}
97179a2a23afSMatthew G. Knepley   PetscFunctionReturn(0);
97189a2a23afSMatthew G. Knepley }
97199a2a23afSMatthew G. Knepley 
97209a2a23afSMatthew G. Knepley /*@C
97219a2a23afSMatthew G. Knepley   DMGetAuxiliaryLabels - Get the labels and values for all auxiliary vectors in this DM
97229a2a23afSMatthew G. Knepley 
97239a2a23afSMatthew G. Knepley   Not collective
97249a2a23afSMatthew G. Knepley 
97259a2a23afSMatthew G. Knepley   Input Parameter:
97269a2a23afSMatthew G. Knepley . dm      - The DM
97279a2a23afSMatthew G. Knepley 
97289a2a23afSMatthew G. Knepley   Output Parameters:
97299a2a23afSMatthew G. Knepley + labels  - The DMLabels for each Vec
97309a2a23afSMatthew G. Knepley - values  - The label values for each Vec
97319a2a23afSMatthew G. Knepley 
97329a2a23afSMatthew G. Knepley   Note: The arrays passed in must be at least as large as DMGetNumAuxiliaryVec().
97339a2a23afSMatthew G. Knepley 
97349a2a23afSMatthew G. Knepley   Level: advanced
97359a2a23afSMatthew G. Knepley 
97369a2a23afSMatthew G. Knepley .seealso: DMGetNumAuxiliaryVec(), DMGetAuxiliaryVec(), DMSetAuxiliaryVec()
97379a2a23afSMatthew G. Knepley @*/
97389a2a23afSMatthew G. Knepley PetscErrorCode DMGetAuxiliaryLabels(DM dm, DMLabel labels[], PetscInt values[])
97399a2a23afSMatthew G. Knepley {
97409a2a23afSMatthew G. Knepley   PetscHashAuxKey *keys;
97419a2a23afSMatthew G. Knepley   PetscInt         n, i, off = 0;
97429a2a23afSMatthew G. Knepley   PetscErrorCode   ierr;
97439a2a23afSMatthew G. Knepley 
97449a2a23afSMatthew G. Knepley   PetscFunctionBegin;
97459a2a23afSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
97469a2a23afSMatthew G. Knepley   PetscValidPointer(labels, 2);
97479a2a23afSMatthew G. Knepley   PetscValidPointer(values, 3);
97489a2a23afSMatthew G. Knepley   ierr = DMGetNumAuxiliaryVec(dm, &n);CHKERRQ(ierr);
97499a2a23afSMatthew G. Knepley   ierr = PetscMalloc1(n, &keys);CHKERRQ(ierr);
97509a2a23afSMatthew G. Knepley   ierr = PetscHMapAuxGetKeys(dm->auxData, &off, keys);CHKERRQ(ierr);
97519a2a23afSMatthew G. Knepley   for (i = 0; i < n; ++i) {labels[i] = keys[i].label; values[i] = keys[i].value;}
97529a2a23afSMatthew G. Knepley   ierr = PetscFree(keys);CHKERRQ(ierr);
97539a2a23afSMatthew G. Knepley   PetscFunctionReturn(0);
97549a2a23afSMatthew G. Knepley }
97559a2a23afSMatthew G. Knepley 
97569a2a23afSMatthew G. Knepley /*@
97579a2a23afSMatthew G. Knepley   DMCopyAuxiliaryVec - Copy the auxiliary data to a new DM
97589a2a23afSMatthew G. Knepley 
97599a2a23afSMatthew G. Knepley   Not collective
97609a2a23afSMatthew G. Knepley 
97619a2a23afSMatthew G. Knepley   Input Parameter:
97629a2a23afSMatthew G. Knepley . dm    - The DM
97639a2a23afSMatthew G. Knepley 
97649a2a23afSMatthew G. Knepley   Output Parameter:
97659a2a23afSMatthew G. Knepley . dmNew - The new DM, now with the same auxiliary data
97669a2a23afSMatthew G. Knepley 
97679a2a23afSMatthew G. Knepley   Level: advanced
97689a2a23afSMatthew G. Knepley 
97699a2a23afSMatthew G. Knepley .seealso: DMGetNumAuxiliaryVec(), DMGetAuxiliaryVec(), DMSetAuxiliaryVec()
97709a2a23afSMatthew G. Knepley @*/
97719a2a23afSMatthew G. Knepley PetscErrorCode DMCopyAuxiliaryVec(DM dm, DM dmNew)
97729a2a23afSMatthew G. Knepley {
97739a2a23afSMatthew G. Knepley   PetscErrorCode ierr;
97749a2a23afSMatthew G. Knepley 
97759a2a23afSMatthew G. Knepley   PetscFunctionBegin;
97769a2a23afSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
97779a2a23afSMatthew G. Knepley   ierr = PetscHMapAuxDestroy(&dmNew->auxData);CHKERRQ(ierr);
97789a2a23afSMatthew G. Knepley   ierr = PetscHMapAuxDuplicate(dm->auxData, &dmNew->auxData);CHKERRQ(ierr);
97799a2a23afSMatthew G. Knepley   PetscFunctionReturn(0);
97809a2a23afSMatthew G. Knepley }
9781b5a892a1SMatthew G. Knepley 
9782b5a892a1SMatthew G. Knepley /*@C
9783b5a892a1SMatthew G. Knepley   DMPolytopeMatchOrientation - Determine an orientation that takes the source face arrangement to the target face arrangement
9784b5a892a1SMatthew G. Knepley 
9785b5a892a1SMatthew G. Knepley   Not collective
9786b5a892a1SMatthew G. Knepley 
9787b5a892a1SMatthew G. Knepley   Input Parameters:
9788b5a892a1SMatthew G. Knepley + ct         - The DMPolytopeType
9789b5a892a1SMatthew G. Knepley . sourceCone - The source arrangement of faces
9790b5a892a1SMatthew G. Knepley - targetCone - The target arrangement of faces
9791b5a892a1SMatthew G. Knepley 
9792b5a892a1SMatthew G. Knepley   Output Parameters:
9793b5a892a1SMatthew G. Knepley + ornt  - The orientation which will take the source arrangement to the target arrangement
9794b5a892a1SMatthew G. Knepley - found - Flag indicating that a suitable orientation was found
9795b5a892a1SMatthew G. Knepley 
9796b5a892a1SMatthew G. Knepley   Level: advanced
9797b5a892a1SMatthew G. Knepley 
9798b5a892a1SMatthew G. Knepley .seealso: DMPolytopeGetOrientation(), DMPolytopeMatchVertexOrientation()
9799b5a892a1SMatthew G. Knepley @*/
9800b5a892a1SMatthew G. Knepley PetscErrorCode DMPolytopeMatchOrientation(DMPolytopeType ct, const PetscInt sourceCone[], const PetscInt targetCone[], PetscInt *ornt, PetscBool *found)
9801b5a892a1SMatthew G. Knepley {
9802b5a892a1SMatthew G. Knepley   const PetscInt cS = DMPolytopeTypeGetConeSize(ct);
9803b5a892a1SMatthew G. Knepley   const PetscInt nO = DMPolytopeTypeGetNumArrangments(ct)/2;
9804b5a892a1SMatthew G. Knepley   PetscInt       o, c;
9805b5a892a1SMatthew G. Knepley 
9806b5a892a1SMatthew G. Knepley   PetscFunctionBegin;
9807b5a892a1SMatthew G. Knepley   if (!nO) {*ornt = 0; *found = PETSC_TRUE; PetscFunctionReturn(0);}
9808b5a892a1SMatthew G. Knepley   for (o = -nO; o < nO; ++o) {
9809b5a892a1SMatthew G. Knepley     const PetscInt *arr = DMPolytopeTypeGetArrangment(ct, o);
9810b5a892a1SMatthew G. Knepley 
9811b5a892a1SMatthew G. Knepley     for (c = 0; c < cS; ++c) if (sourceCone[arr[c*2]] != targetCone[c]) break;
9812b5a892a1SMatthew G. Knepley     if (c == cS) {*ornt = o; break;}
9813b5a892a1SMatthew G. Knepley   }
9814b5a892a1SMatthew G. Knepley   *found = o == nO ? PETSC_FALSE : PETSC_TRUE;
9815b5a892a1SMatthew G. Knepley   PetscFunctionReturn(0);
9816b5a892a1SMatthew G. Knepley }
9817b5a892a1SMatthew G. Knepley 
9818b5a892a1SMatthew G. Knepley /*@C
9819b5a892a1SMatthew G. Knepley   DMPolytopeGetOrientation - Determine an orientation that takes the source face arrangement to the target face arrangement
9820b5a892a1SMatthew G. Knepley 
9821b5a892a1SMatthew G. Knepley   Not collective
9822b5a892a1SMatthew G. Knepley 
9823b5a892a1SMatthew G. Knepley   Input Parameters:
9824b5a892a1SMatthew G. Knepley + ct         - The DMPolytopeType
9825b5a892a1SMatthew G. Knepley . sourceCone - The source arrangement of faces
9826b5a892a1SMatthew G. Knepley - targetCone - The target arrangement of faces
9827b5a892a1SMatthew G. Knepley 
9828b5a892a1SMatthew G. Knepley   Output Parameters:
9829b5a892a1SMatthew G. Knepley . ornt  - The orientation which will take the source arrangement to the target arrangement
9830b5a892a1SMatthew G. Knepley 
9831b5a892a1SMatthew G. Knepley   Note: This function will fail if no suitable orientation can be found.
9832b5a892a1SMatthew G. Knepley 
9833b5a892a1SMatthew G. Knepley   Level: advanced
9834b5a892a1SMatthew G. Knepley 
9835b5a892a1SMatthew G. Knepley .seealso: DMPolytopeMatchOrientation(), DMPolytopeGetVertexOrientation()
9836b5a892a1SMatthew G. Knepley @*/
9837b5a892a1SMatthew G. Knepley PetscErrorCode DMPolytopeGetOrientation(DMPolytopeType ct, const PetscInt sourceCone[], const PetscInt targetCone[], PetscInt *ornt)
9838b5a892a1SMatthew G. Knepley {
9839b5a892a1SMatthew G. Knepley   PetscBool      found;
9840b5a892a1SMatthew G. Knepley   PetscErrorCode ierr;
9841b5a892a1SMatthew G. Knepley 
9842b5a892a1SMatthew G. Knepley   PetscFunctionBegin;
9843b5a892a1SMatthew G. Knepley   ierr = DMPolytopeMatchOrientation(ct, sourceCone, targetCone, ornt, &found);CHKERRQ(ierr);
9844b5a892a1SMatthew G. Knepley   if (!found) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Could not find orientation for %s", DMPolytopeTypes[ct]);
9845b5a892a1SMatthew G. Knepley   PetscFunctionReturn(0);
9846b5a892a1SMatthew G. Knepley }
9847b5a892a1SMatthew G. Knepley 
9848b5a892a1SMatthew G. Knepley /*@C
9849b5a892a1SMatthew G. Knepley   DMPolytopeMatchVertexOrientation - Determine an orientation that takes the source vertex arrangement to the target vertex arrangement
9850b5a892a1SMatthew G. Knepley 
9851b5a892a1SMatthew G. Knepley   Not collective
9852b5a892a1SMatthew G. Knepley 
9853b5a892a1SMatthew G. Knepley   Input Parameters:
9854b5a892a1SMatthew G. Knepley + ct         - The DMPolytopeType
9855b5a892a1SMatthew G. Knepley . sourceVert - The source arrangement of vertices
9856b5a892a1SMatthew G. Knepley - targetVert - The target arrangement of vertices
9857b5a892a1SMatthew G. Knepley 
9858b5a892a1SMatthew G. Knepley   Output Parameters:
9859b5a892a1SMatthew G. Knepley + ornt  - The orientation which will take the source arrangement to the target arrangement
9860b5a892a1SMatthew G. Knepley - found - Flag indicating that a suitable orientation was found
9861b5a892a1SMatthew G. Knepley 
9862b5a892a1SMatthew G. Knepley   Level: advanced
9863b5a892a1SMatthew G. Knepley 
9864b5a892a1SMatthew G. Knepley .seealso: DMPolytopeGetOrientation(), DMPolytopeMatchOrientation()
9865b5a892a1SMatthew G. Knepley @*/
9866b5a892a1SMatthew G. Knepley PetscErrorCode DMPolytopeMatchVertexOrientation(DMPolytopeType ct, const PetscInt sourceVert[], const PetscInt targetVert[], PetscInt *ornt, PetscBool *found)
9867b5a892a1SMatthew G. Knepley {
9868b5a892a1SMatthew G. Knepley   const PetscInt cS = DMPolytopeTypeGetNumVertices(ct);
9869b5a892a1SMatthew G. Knepley   const PetscInt nO = DMPolytopeTypeGetNumArrangments(ct)/2;
9870b5a892a1SMatthew G. Knepley   PetscInt       o, c;
9871b5a892a1SMatthew G. Knepley 
9872b5a892a1SMatthew G. Knepley   PetscFunctionBegin;
9873b5a892a1SMatthew G. Knepley   if (!nO) {*ornt = 0; *found = PETSC_TRUE; PetscFunctionReturn(0);}
9874b5a892a1SMatthew G. Knepley   for (o = -nO; o < nO; ++o) {
9875b5a892a1SMatthew G. Knepley     const PetscInt *arr = DMPolytopeTypeGetVertexArrangment(ct, o);
9876b5a892a1SMatthew G. Knepley 
9877b5a892a1SMatthew G. Knepley     for (c = 0; c < cS; ++c) if (sourceVert[arr[c]] != targetVert[c]) break;
9878b5a892a1SMatthew G. Knepley     if (c == cS) {*ornt = o; break;}
9879b5a892a1SMatthew G. Knepley   }
9880b5a892a1SMatthew G. Knepley   *found = o == nO ? PETSC_FALSE : PETSC_TRUE;
9881b5a892a1SMatthew G. Knepley   PetscFunctionReturn(0);
9882b5a892a1SMatthew G. Knepley }
9883b5a892a1SMatthew G. Knepley 
9884b5a892a1SMatthew G. Knepley /*@C
9885b5a892a1SMatthew G. Knepley   DMPolytopeGetVertexOrientation - Determine an orientation that takes the source vertex arrangement to the target vertex arrangement
9886b5a892a1SMatthew G. Knepley 
9887b5a892a1SMatthew G. Knepley   Not collective
9888b5a892a1SMatthew G. Knepley 
9889b5a892a1SMatthew G. Knepley   Input Parameters:
9890b5a892a1SMatthew G. Knepley + ct         - The DMPolytopeType
9891b5a892a1SMatthew G. Knepley . sourceCone - The source arrangement of vertices
9892b5a892a1SMatthew G. Knepley - targetCone - The target arrangement of vertices
9893b5a892a1SMatthew G. Knepley 
9894b5a892a1SMatthew G. Knepley   Output Parameters:
9895b5a892a1SMatthew G. Knepley . ornt  - The orientation which will take the source arrangement to the target arrangement
9896b5a892a1SMatthew G. Knepley 
9897b5a892a1SMatthew G. Knepley   Note: This function will fail if no suitable orientation can be found.
9898b5a892a1SMatthew G. Knepley 
9899b5a892a1SMatthew G. Knepley   Level: advanced
9900b5a892a1SMatthew G. Knepley 
9901b5a892a1SMatthew G. Knepley .seealso: DMPolytopeMatchVertexOrientation(), DMPolytopeGetOrientation()
9902b5a892a1SMatthew G. Knepley @*/
9903b5a892a1SMatthew G. Knepley PetscErrorCode DMPolytopeGetVertexOrientation(DMPolytopeType ct, const PetscInt sourceCone[], const PetscInt targetCone[], PetscInt *ornt)
9904b5a892a1SMatthew G. Knepley {
9905b5a892a1SMatthew G. Knepley   PetscBool      found;
9906b5a892a1SMatthew G. Knepley   PetscErrorCode ierr;
9907b5a892a1SMatthew G. Knepley 
9908b5a892a1SMatthew G. Knepley   PetscFunctionBegin;
9909b5a892a1SMatthew G. Knepley   ierr = DMPolytopeMatchVertexOrientation(ct, sourceCone, targetCone, ornt, &found);CHKERRQ(ierr);
9910b5a892a1SMatthew G. Knepley   if (!found) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Could not find orientation for %s", DMPolytopeTypes[ct]);
9911b5a892a1SMatthew G. Knepley   PetscFunctionReturn(0);
9912b5a892a1SMatthew G. Knepley }
9913*012bc364SMatthew G. Knepley 
9914*012bc364SMatthew G. Knepley /*@C
9915*012bc364SMatthew G. Knepley   DMPolytopeInCellTest - Check whether a point lies inside the reference cell of given type
9916*012bc364SMatthew G. Knepley 
9917*012bc364SMatthew G. Knepley   Not collective
9918*012bc364SMatthew G. Knepley 
9919*012bc364SMatthew G. Knepley   Input Parameters:
9920*012bc364SMatthew G. Knepley + ct    - The DMPolytopeType
9921*012bc364SMatthew G. Knepley - point - Coordinates of the point
9922*012bc364SMatthew G. Knepley 
9923*012bc364SMatthew G. Knepley   Output Parameters:
9924*012bc364SMatthew G. Knepley . inside  - Flag indicating whether the point is inside the reference cell of given type
9925*012bc364SMatthew G. Knepley 
9926*012bc364SMatthew G. Knepley   Level: advanced
9927*012bc364SMatthew G. Knepley 
9928*012bc364SMatthew G. Knepley .seealso: DMLocatePoints()
9929*012bc364SMatthew G. Knepley @*/
9930*012bc364SMatthew G. Knepley PetscErrorCode DMPolytopeInCellTest(DMPolytopeType ct, const PetscReal point[], PetscBool *inside)
9931*012bc364SMatthew G. Knepley {
9932*012bc364SMatthew G. Knepley   PetscReal sum = 0.0;
9933*012bc364SMatthew G. Knepley   PetscInt  d;
9934*012bc364SMatthew G. Knepley 
9935*012bc364SMatthew G. Knepley   PetscFunctionBegin;
9936*012bc364SMatthew G. Knepley   *inside = PETSC_TRUE;
9937*012bc364SMatthew G. Knepley   switch (ct) {
9938*012bc364SMatthew G. Knepley   case DM_POLYTOPE_TRIANGLE:
9939*012bc364SMatthew G. Knepley   case DM_POLYTOPE_TETRAHEDRON:
9940*012bc364SMatthew G. Knepley     for (d = 0; d < DMPolytopeTypeGetDim(ct); ++d) {
9941*012bc364SMatthew G. Knepley       if (point[d] < -1.0) {*inside = PETSC_FALSE; break;}
9942*012bc364SMatthew G. Knepley       sum += point[d];
9943*012bc364SMatthew G. Knepley     }
9944*012bc364SMatthew G. Knepley     if (sum > PETSC_SMALL) {*inside = PETSC_FALSE; break;}
9945*012bc364SMatthew G. Knepley     break;
9946*012bc364SMatthew G. Knepley   case DM_POLYTOPE_QUADRILATERAL:
9947*012bc364SMatthew G. Knepley   case DM_POLYTOPE_HEXAHEDRON:
9948*012bc364SMatthew G. Knepley     for (d = 0; d < DMPolytopeTypeGetDim(ct); ++d)
9949*012bc364SMatthew G. Knepley       if (PetscAbsReal(point[d]) > 1.+PETSC_SMALL) {*inside = PETSC_FALSE; break;}
9950*012bc364SMatthew G. Knepley     break;
9951*012bc364SMatthew G. Knepley   default:
9952*012bc364SMatthew G. Knepley     SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Unsupported polytope type %s", DMPolytopeTypes[ct]);
9953*012bc364SMatthew G. Knepley   }
9954*012bc364SMatthew G. Knepley   PetscFunctionReturn(0);
9955*012bc364SMatthew G. Knepley }
9956