xref: /petsc/src/dm/interface/dm.c (revision 1e1ea65d8de51fde77ce8a787efbef25e407badc)
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 
138495452b02SPatrick Sanan     Notes:
138595452b02SPatrick Sanan     This properly preallocates the number of nonzeros in the sparse matrix so you
138694013140SBarry Smith        do not need to do it yourself.
138794013140SBarry Smith 
138894013140SBarry Smith        By default it also sets the nonzero structure and puts in the zero entries. To prevent setting
13897889ec69SBarry Smith        the nonzero pattern call DMSetMatrixPreallocateOnly()
139094013140SBarry Smith 
139194013140SBarry 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
139294013140SBarry Smith        internally by PETSc.
139394013140SBarry Smith 
139494013140SBarry Smith        For structured grid problems, in general it is easiest to use MatSetValuesStencil() or MatSetValuesLocal() to put values into the matrix because MatSetValues() requires
1395aa219208SBarry Smith        the indices for the global numbering for DMDAs which is complicated.
139694013140SBarry Smith 
1397b412c318SBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMSetMatType()
139847c6ae99SBarry Smith 
1399aab9d709SJed Brown @*/
1400b412c318SBarry Smith PetscErrorCode  DMCreateMatrix(DM dm,Mat *mat)
140147c6ae99SBarry Smith {
140247c6ae99SBarry Smith   PetscErrorCode ierr;
140347c6ae99SBarry Smith 
140447c6ae99SBarry Smith   PetscFunctionBegin;
1405171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1406064a246eSJacob Faibussowitsch   PetscValidPointer(mat,2);
1407b9d85ea2SLisandro Dalcin   if (!dm->ops->creatematrix) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateMatrix",((PetscObject)dm)->type_name);
14085a84ad33SLisandro Dalcin   ierr = MatInitializePackage();CHKERRQ(ierr);
1409fdc842d1SBarry Smith   ierr = PetscLogEventBegin(DM_CreateMatrix,0,0,0,0);CHKERRQ(ierr);
1410b412c318SBarry Smith   ierr = (*dm->ops->creatematrix)(dm,mat);CHKERRQ(ierr);
141176bd3646SJed Brown   if (PetscDefined(USE_DEBUG)) {
1412c6b011d8SStefano Zampini     DM mdm;
1413c6b011d8SStefano Zampini 
1414c6b011d8SStefano Zampini     ierr = MatGetDM(*mat,&mdm);CHKERRQ(ierr);
1415c6b011d8SStefano 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);
1416c6b011d8SStefano Zampini   }
1417e571a35bSMatthew G. Knepley   /* Handle nullspace and near nullspace */
1418e5e52638SMatthew G. Knepley   if (dm->Nf) {
1419e571a35bSMatthew G. Knepley     MatNullSpace nullSpace;
1420649ef022SMatthew Knepley     PetscInt     Nf, f;
1421e571a35bSMatthew G. Knepley 
1422e5e52638SMatthew G. Knepley     ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
1423649ef022SMatthew Knepley     for (f = 0; f < Nf; ++f) {
1424649ef022SMatthew Knepley       if (dm->nullspaceConstructors[f]) {
1425649ef022SMatthew Knepley         ierr = (*dm->nullspaceConstructors[f])(dm, f, f, &nullSpace);CHKERRQ(ierr);
1426e571a35bSMatthew G. Knepley         ierr = MatSetNullSpace(*mat, nullSpace);CHKERRQ(ierr);
1427e571a35bSMatthew G. Knepley         ierr = MatNullSpaceDestroy(&nullSpace);CHKERRQ(ierr);
1428649ef022SMatthew Knepley         break;
1429e571a35bSMatthew G. Knepley       }
1430649ef022SMatthew Knepley     }
1431649ef022SMatthew Knepley     for (f = 0; f < Nf; ++f) {
1432649ef022SMatthew Knepley       if (dm->nearnullspaceConstructors[f]) {
1433649ef022SMatthew Knepley         ierr = (*dm->nearnullspaceConstructors[f])(dm, f, f, &nullSpace);CHKERRQ(ierr);
1434e571a35bSMatthew G. Knepley         ierr = MatSetNearNullSpace(*mat, nullSpace);CHKERRQ(ierr);
1435e571a35bSMatthew G. Knepley         ierr = MatNullSpaceDestroy(&nullSpace);CHKERRQ(ierr);
1436e571a35bSMatthew G. Knepley       }
1437e571a35bSMatthew G. Knepley     }
1438e571a35bSMatthew G. Knepley   }
1439fdc842d1SBarry Smith   ierr = PetscLogEventEnd(DM_CreateMatrix,0,0,0,0);CHKERRQ(ierr);
144047c6ae99SBarry Smith   PetscFunctionReturn(0);
144147c6ae99SBarry Smith }
144247c6ae99SBarry Smith 
1443732e2eb9SMatthew G Knepley /*@
1444950540a4SJed Brown   DMSetMatrixPreallocateOnly - When DMCreateMatrix() is called the matrix will be properly
1445732e2eb9SMatthew G Knepley     preallocated but the nonzero structure and zero values will not be set.
1446732e2eb9SMatthew G Knepley 
1447d083f849SBarry Smith   Logically Collective on dm
1448732e2eb9SMatthew G Knepley 
1449732e2eb9SMatthew G Knepley   Input Parameter:
1450732e2eb9SMatthew G Knepley + dm - the DM
1451732e2eb9SMatthew G Knepley - only - PETSC_TRUE if only want preallocation
1452732e2eb9SMatthew G Knepley 
1453732e2eb9SMatthew G Knepley   Level: developer
1454b06ff27eSHong Zhang .seealso DMCreateMatrix(), DMSetMatrixStructureOnly()
1455732e2eb9SMatthew G Knepley @*/
1456732e2eb9SMatthew G Knepley PetscErrorCode DMSetMatrixPreallocateOnly(DM dm, PetscBool only)
1457732e2eb9SMatthew G Knepley {
1458732e2eb9SMatthew G Knepley   PetscFunctionBegin;
1459732e2eb9SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1460732e2eb9SMatthew G Knepley   dm->prealloc_only = only;
1461732e2eb9SMatthew G Knepley   PetscFunctionReturn(0);
1462732e2eb9SMatthew G Knepley }
1463732e2eb9SMatthew G Knepley 
1464b06ff27eSHong Zhang /*@
1465b06ff27eSHong Zhang   DMSetMatrixStructureOnly - When DMCreateMatrix() is called, the matrix structure will be created
1466b06ff27eSHong Zhang     but the array for values will not be allocated.
1467b06ff27eSHong Zhang 
1468d083f849SBarry Smith   Logically Collective on dm
1469b06ff27eSHong Zhang 
1470b06ff27eSHong Zhang   Input Parameter:
1471b06ff27eSHong Zhang + dm - the DM
1472b06ff27eSHong Zhang - only - PETSC_TRUE if only want matrix stucture
1473b06ff27eSHong Zhang 
1474b06ff27eSHong Zhang   Level: developer
1475b06ff27eSHong Zhang .seealso DMCreateMatrix(), DMSetMatrixPreallocateOnly()
1476b06ff27eSHong Zhang @*/
1477b06ff27eSHong Zhang PetscErrorCode DMSetMatrixStructureOnly(DM dm, PetscBool only)
1478b06ff27eSHong Zhang {
1479b06ff27eSHong Zhang   PetscFunctionBegin;
1480b06ff27eSHong Zhang   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1481b06ff27eSHong Zhang   dm->structure_only = only;
1482b06ff27eSHong Zhang   PetscFunctionReturn(0);
1483b06ff27eSHong Zhang }
1484b06ff27eSHong Zhang 
1485a89ea682SMatthew G Knepley /*@C
1486aa1993deSMatthew G Knepley   DMGetWorkArray - Gets a work array guaranteed to be at least the input size, restore with DMRestoreWorkArray()
1487a89ea682SMatthew G Knepley 
1488a89ea682SMatthew G Knepley   Not Collective
1489a89ea682SMatthew G Knepley 
1490a89ea682SMatthew G Knepley   Input Parameters:
1491a89ea682SMatthew G Knepley + dm - the DM object
1492aa1993deSMatthew G Knepley . count - The minium size
149369291d52SBarry Smith - dtype - MPI data type, often MPIU_REAL, MPIU_SCALAR, MPIU_INT)
1494a89ea682SMatthew G Knepley 
1495a89ea682SMatthew G Knepley   Output Parameter:
1496a89ea682SMatthew G Knepley . array - the work array
1497a89ea682SMatthew G Knepley 
1498a89ea682SMatthew G Knepley   Level: developer
1499a89ea682SMatthew G Knepley 
1500a89ea682SMatthew G Knepley .seealso DMDestroy(), DMCreate()
1501a89ea682SMatthew G Knepley @*/
150269291d52SBarry Smith PetscErrorCode DMGetWorkArray(DM dm,PetscInt count,MPI_Datatype dtype,void *mem)
1503a89ea682SMatthew G Knepley {
1504a89ea682SMatthew G Knepley   PetscErrorCode ierr;
1505aa1993deSMatthew G Knepley   DMWorkLink     link;
150669291d52SBarry Smith   PetscMPIInt    dsize;
1507a89ea682SMatthew G Knepley 
1508a89ea682SMatthew G Knepley   PetscFunctionBegin;
1509a89ea682SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1510aa1993deSMatthew G Knepley   PetscValidPointer(mem,4);
1511aa1993deSMatthew G Knepley   if (dm->workin) {
1512aa1993deSMatthew G Knepley     link       = dm->workin;
1513aa1993deSMatthew G Knepley     dm->workin = dm->workin->next;
1514aa1993deSMatthew G Knepley   } else {
1515b00a9115SJed Brown     ierr = PetscNewLog(dm,&link);CHKERRQ(ierr);
1516a89ea682SMatthew G Knepley   }
1517ffc4695bSBarry Smith   ierr = MPI_Type_size(dtype,&dsize);CHKERRMPI(ierr);
15185056fcd2SBarry Smith   if (((size_t)dsize*count) > link->bytes) {
1519aa1993deSMatthew G Knepley     ierr        = PetscFree(link->mem);CHKERRQ(ierr);
1520854ce69bSBarry Smith     ierr        = PetscMalloc(dsize*count,&link->mem);CHKERRQ(ierr);
1521854ce69bSBarry Smith     link->bytes = dsize*count;
1522aa1993deSMatthew G Knepley   }
1523aa1993deSMatthew G Knepley   link->next   = dm->workout;
1524aa1993deSMatthew G Knepley   dm->workout  = link;
152500d952a4SJed Brown #if defined(PETSC_HAVE_VALGRIND)
152600d952a4SJed Brown   VALGRIND_MAKE_MEM_NOACCESS((char*)link->mem + (size_t)dsize*count, link->bytes - (size_t)dsize*count);
152700d952a4SJed Brown   VALGRIND_MAKE_MEM_UNDEFINED(link->mem, (size_t)dsize*count);
152800d952a4SJed Brown #endif
1529aa1993deSMatthew G Knepley   *(void**)mem = link->mem;
1530a89ea682SMatthew G Knepley   PetscFunctionReturn(0);
1531a89ea682SMatthew G Knepley }
1532a89ea682SMatthew G Knepley 
1533aa1993deSMatthew G Knepley /*@C
1534aa1993deSMatthew G Knepley   DMRestoreWorkArray - Restores a work array guaranteed to be at least the input size, restore with DMRestoreWorkArray()
1535aa1993deSMatthew G Knepley 
1536aa1993deSMatthew G Knepley   Not Collective
1537aa1993deSMatthew G Knepley 
1538aa1993deSMatthew G Knepley   Input Parameters:
1539aa1993deSMatthew G Knepley + dm - the DM object
1540aa1993deSMatthew G Knepley . count - The minium size
154169291d52SBarry Smith - dtype - MPI data type, often MPIU_REAL, MPIU_SCALAR, MPIU_INT
1542aa1993deSMatthew G Knepley 
1543aa1993deSMatthew G Knepley   Output Parameter:
1544aa1993deSMatthew G Knepley . array - the work array
1545aa1993deSMatthew G Knepley 
1546aa1993deSMatthew G Knepley   Level: developer
1547aa1993deSMatthew G Knepley 
154895452b02SPatrick Sanan   Developer Notes:
154995452b02SPatrick Sanan     count and dtype are ignored, they are only needed for DMGetWorkArray()
1550aa1993deSMatthew G Knepley .seealso DMDestroy(), DMCreate()
1551aa1993deSMatthew G Knepley @*/
155269291d52SBarry Smith PetscErrorCode DMRestoreWorkArray(DM dm,PetscInt count,MPI_Datatype dtype,void *mem)
1553aa1993deSMatthew G Knepley {
1554aa1993deSMatthew G Knepley   DMWorkLink *p,link;
1555aa1993deSMatthew G Knepley 
1556aa1993deSMatthew G Knepley   PetscFunctionBegin;
1557aa1993deSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1558aa1993deSMatthew G Knepley   PetscValidPointer(mem,4);
1559aa1993deSMatthew G Knepley   for (p=&dm->workout; (link=*p); p=&link->next) {
1560aa1993deSMatthew G Knepley     if (link->mem == *(void**)mem) {
1561aa1993deSMatthew G Knepley       *p           = link->next;
1562aa1993deSMatthew G Knepley       link->next   = dm->workin;
1563aa1993deSMatthew G Knepley       dm->workin   = link;
15640298fd71SBarry Smith       *(void**)mem = NULL;
1565aa1993deSMatthew G Knepley       PetscFunctionReturn(0);
1566aa1993deSMatthew G Knepley     }
1567aa1993deSMatthew G Knepley   }
1568aa1993deSMatthew G Knepley   SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Array was not checked out");
1569aa1993deSMatthew G Knepley }
1570e7c4fc90SDmitry Karpeev 
15718cda7954SMatthew G. Knepley /*@C
15728cda7954SMatthew G. Knepley   DMSetNullSpaceConstructor - Provide a callback function which constructs the nullspace for a given field
15738cda7954SMatthew G. Knepley 
15748cda7954SMatthew G. Knepley   Logically collective on DM
15758cda7954SMatthew G. Knepley 
15768cda7954SMatthew G. Knepley   Input Parameters:
15778cda7954SMatthew G. Knepley + dm     - The DM
15788cda7954SMatthew G. Knepley . field  - The field number for the nullspace
15798cda7954SMatthew G. Knepley - nullsp - A callback to create the nullspace
15808cda7954SMatthew G. Knepley 
15818cda7954SMatthew G. Knepley   Notes:
15828cda7954SMatthew G. Knepley   The callback is intended to provide nullspaces when function spaces are joined or split, such as in DMCreateSubDM(). The calling sequence is
15838cda7954SMatthew G. Knepley $ PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace)
15848cda7954SMatthew G. Knepley $ dm        - The present DM
15858cda7954SMatthew G. Knepley $ origField - The field number given above, in the original DM
15868cda7954SMatthew G. Knepley $ field     - The field number in dm
15878cda7954SMatthew G. Knepley $ nullSpace - The nullspace for the given field
15888cda7954SMatthew G. Knepley 
15898cda7954SMatthew G. Knepley   This function is currently not available from Fortran.
15908cda7954SMatthew G. Knepley 
15918cda7954SMatthew G. Knepley .seealso: DMGetNullSpaceConstructor(), DMSetNearNullSpaceConstructor(), DMGetNearNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM()
15928cda7954SMatthew G. Knepley */
15938cda7954SMatthew G. Knepley PetscErrorCode DMSetNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (*nullsp)(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace))
1594435a35e8SMatthew G Knepley {
1595435a35e8SMatthew G Knepley   PetscFunctionBegin;
1596435a35e8SMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
159782f516ccSBarry Smith   if (field >= 10) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field);
1598435a35e8SMatthew G Knepley   dm->nullspaceConstructors[field] = nullsp;
1599435a35e8SMatthew G Knepley   PetscFunctionReturn(0);
1600435a35e8SMatthew G Knepley }
1601435a35e8SMatthew G Knepley 
16028cda7954SMatthew G. Knepley /*@C
16038cda7954SMatthew G. Knepley   DMGetNullSpaceConstructor - Return the callback function which constructs the nullspace for a given field, or NULL
16048cda7954SMatthew G. Knepley 
16058cda7954SMatthew G. Knepley   Not collective
16068cda7954SMatthew G. Knepley 
16078cda7954SMatthew G. Knepley   Input Parameters:
16088cda7954SMatthew G. Knepley + dm     - The DM
16098cda7954SMatthew G. Knepley - field  - The field number for the nullspace
16108cda7954SMatthew G. Knepley 
16118cda7954SMatthew G. Knepley   Output Parameter:
16128cda7954SMatthew G. Knepley . nullsp - A callback to create the nullspace
16138cda7954SMatthew G. Knepley 
16148cda7954SMatthew G. Knepley   Notes:
16158cda7954SMatthew G. Knepley   The callback is intended to provide nullspaces when function spaces are joined or split, such as in DMCreateSubDM(). The calling sequence is
16168cda7954SMatthew G. Knepley $ PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace)
16178cda7954SMatthew G. Knepley $ dm        - The present DM
16188cda7954SMatthew G. Knepley $ origField - The field number given above, in the original DM
16198cda7954SMatthew G. Knepley $ field     - The field number in dm
16208cda7954SMatthew G. Knepley $ nullSpace - The nullspace for the given field
16218cda7954SMatthew G. Knepley 
16228cda7954SMatthew G. Knepley   This function is currently not available from Fortran.
16238cda7954SMatthew G. Knepley 
16248cda7954SMatthew G. Knepley .seealso: DMSetNullSpaceConstructor(), DMSetNearNullSpaceConstructor(), DMGetNearNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM()
16258cda7954SMatthew G. Knepley */
16268cda7954SMatthew G. Knepley PetscErrorCode DMGetNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (**nullsp)(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace))
16270a50eb56SMatthew G. Knepley {
16280a50eb56SMatthew G. Knepley   PetscFunctionBegin;
16290a50eb56SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
1630f9d4088aSMatthew G. Knepley   PetscValidPointer(nullsp, 3);
16310a50eb56SMatthew G. Knepley   if (field >= 10) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field);
16320a50eb56SMatthew G. Knepley   *nullsp = dm->nullspaceConstructors[field];
16330a50eb56SMatthew G. Knepley   PetscFunctionReturn(0);
16340a50eb56SMatthew G. Knepley }
16350a50eb56SMatthew G. Knepley 
16368cda7954SMatthew G. Knepley /*@C
16378cda7954SMatthew G. Knepley   DMSetNearNullSpaceConstructor - Provide a callback function which constructs the near-nullspace for a given field
16388cda7954SMatthew G. Knepley 
16398cda7954SMatthew G. Knepley   Logically collective on DM
16408cda7954SMatthew G. Knepley 
16418cda7954SMatthew G. Knepley   Input Parameters:
16428cda7954SMatthew G. Knepley + dm     - The DM
16438cda7954SMatthew G. Knepley . field  - The field number for the nullspace
16448cda7954SMatthew G. Knepley - nullsp - A callback to create the near-nullspace
16458cda7954SMatthew G. Knepley 
16468cda7954SMatthew G. Knepley   Notes:
16478cda7954SMatthew G. Knepley   The callback is intended to provide nullspaces when function spaces are joined or split, such as in DMCreateSubDM(). The calling sequence is
16488cda7954SMatthew G. Knepley $ PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace)
16498cda7954SMatthew G. Knepley $ dm        - The present DM
16508cda7954SMatthew G. Knepley $ origField - The field number given above, in the original DM
16518cda7954SMatthew G. Knepley $ field     - The field number in dm
16528cda7954SMatthew G. Knepley $ nullSpace - The nullspace for the given field
16538cda7954SMatthew G. Knepley 
16548cda7954SMatthew G. Knepley   This function is currently not available from Fortran.
16558cda7954SMatthew G. Knepley 
16568cda7954SMatthew G. Knepley .seealso: DMGetNearNullSpaceConstructor(), DMSetNullSpaceConstructor(), DMGetNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM()
16578cda7954SMatthew G. Knepley */
16588cda7954SMatthew G. Knepley PetscErrorCode DMSetNearNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (*nullsp)(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace))
1659f9d4088aSMatthew G. Knepley {
1660f9d4088aSMatthew G. Knepley   PetscFunctionBegin;
1661f9d4088aSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
1662f9d4088aSMatthew G. Knepley   if (field >= 10) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field);
1663f9d4088aSMatthew G. Knepley   dm->nearnullspaceConstructors[field] = nullsp;
1664f9d4088aSMatthew G. Knepley   PetscFunctionReturn(0);
1665f9d4088aSMatthew G. Knepley }
1666f9d4088aSMatthew G. Knepley 
16678cda7954SMatthew G. Knepley /*@C
16688cda7954SMatthew G. Knepley   DMGetNearNullSpaceConstructor - Return the callback function which constructs the near-nullspace for a given field, or NULL
16698cda7954SMatthew G. Knepley 
16708cda7954SMatthew G. Knepley   Not collective
16718cda7954SMatthew G. Knepley 
16728cda7954SMatthew G. Knepley   Input Parameters:
16738cda7954SMatthew G. Knepley + dm     - The DM
16748cda7954SMatthew G. Knepley - field  - The field number for the nullspace
16758cda7954SMatthew G. Knepley 
16768cda7954SMatthew G. Knepley   Output Parameter:
16778cda7954SMatthew G. Knepley . nullsp - A callback to create the near-nullspace
16788cda7954SMatthew G. Knepley 
16798cda7954SMatthew G. Knepley   Notes:
16808cda7954SMatthew G. Knepley   The callback is intended to provide nullspaces when function spaces are joined or split, such as in DMCreateSubDM(). The calling sequence is
16818cda7954SMatthew G. Knepley $ PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace)
16828cda7954SMatthew G. Knepley $ dm        - The present DM
16838cda7954SMatthew G. Knepley $ origField - The field number given above, in the original DM
16848cda7954SMatthew G. Knepley $ field     - The field number in dm
16858cda7954SMatthew G. Knepley $ nullSpace - The nullspace for the given field
16868cda7954SMatthew G. Knepley 
16878cda7954SMatthew G. Knepley   This function is currently not available from Fortran.
16888cda7954SMatthew G. Knepley 
16898cda7954SMatthew G. Knepley .seealso: DMSetNearNullSpaceConstructor(), DMSetNullSpaceConstructor(), DMGetNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM()
16908cda7954SMatthew G. Knepley */
16918cda7954SMatthew G. Knepley PetscErrorCode DMGetNearNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (**nullsp)(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace))
1692f9d4088aSMatthew G. Knepley {
1693f9d4088aSMatthew G. Knepley   PetscFunctionBegin;
1694f9d4088aSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
1695f9d4088aSMatthew G. Knepley   PetscValidPointer(nullsp, 3);
1696f9d4088aSMatthew G. Knepley   if (field >= 10) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field);
1697f9d4088aSMatthew G. Knepley   *nullsp = dm->nearnullspaceConstructors[field];
1698f9d4088aSMatthew G. Knepley   PetscFunctionReturn(0);
1699f9d4088aSMatthew G. Knepley }
1700f9d4088aSMatthew G. Knepley 
17014f3b5142SJed Brown /*@C
17024d343eeaSMatthew G Knepley   DMCreateFieldIS - Creates a set of IS objects with the global indices of dofs for each field
17034d343eeaSMatthew G Knepley 
17044d343eeaSMatthew G Knepley   Not collective
17054d343eeaSMatthew G Knepley 
17064d343eeaSMatthew G Knepley   Input Parameter:
17074d343eeaSMatthew G Knepley . dm - the DM object
17084d343eeaSMatthew G Knepley 
17094d343eeaSMatthew G Knepley   Output Parameters:
17100298fd71SBarry Smith + numFields  - The number of fields (or NULL if not requested)
17110298fd71SBarry Smith . fieldNames - The name for each field (or NULL if not requested)
17120298fd71SBarry Smith - fields     - The global indices for each field (or NULL if not requested)
17134d343eeaSMatthew G Knepley 
17144d343eeaSMatthew G Knepley   Level: intermediate
17154d343eeaSMatthew G Knepley 
171621c9b008SJed Brown   Notes:
171721c9b008SJed Brown   The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with
171821c9b008SJed Brown   PetscFree(), every entry of fields should be destroyed with ISDestroy(), and both arrays should be freed with
171921c9b008SJed Brown   PetscFree().
172021c9b008SJed Brown 
17214d343eeaSMatthew G Knepley .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
17224d343eeaSMatthew G Knepley @*/
172337d0c07bSMatthew G Knepley PetscErrorCode DMCreateFieldIS(DM dm, PetscInt *numFields, char ***fieldNames, IS **fields)
17244d343eeaSMatthew G Knepley {
172537d0c07bSMatthew G Knepley   PetscSection   section, sectionGlobal;
17264d343eeaSMatthew G Knepley   PetscErrorCode ierr;
17274d343eeaSMatthew G Knepley 
17284d343eeaSMatthew G Knepley   PetscFunctionBegin;
17294d343eeaSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
173069ca1f37SDmitry Karpeev   if (numFields) {
1731534a8f05SLisandro Dalcin     PetscValidIntPointer(numFields,2);
173269ca1f37SDmitry Karpeev     *numFields = 0;
173369ca1f37SDmitry Karpeev   }
173437d0c07bSMatthew G Knepley   if (fieldNames) {
173537d0c07bSMatthew G Knepley     PetscValidPointer(fieldNames,3);
17360298fd71SBarry Smith     *fieldNames = NULL;
173769ca1f37SDmitry Karpeev   }
173869ca1f37SDmitry Karpeev   if (fields) {
173969ca1f37SDmitry Karpeev     PetscValidPointer(fields,4);
17400298fd71SBarry Smith     *fields = NULL;
174169ca1f37SDmitry Karpeev   }
174292fd8e1eSJed Brown   ierr = DMGetLocalSection(dm, &section);CHKERRQ(ierr);
174337d0c07bSMatthew G Knepley   if (section) {
17443a544194SStefano Zampini     PetscInt *fieldSizes, *fieldNc, **fieldIndices;
174537d0c07bSMatthew G Knepley     PetscInt nF, f, pStart, pEnd, p;
174637d0c07bSMatthew G Knepley 
1747e87a4003SBarry Smith     ierr = DMGetGlobalSection(dm, &sectionGlobal);CHKERRQ(ierr);
174837d0c07bSMatthew G Knepley     ierr = PetscSectionGetNumFields(section, &nF);CHKERRQ(ierr);
17493a544194SStefano Zampini     ierr = PetscMalloc3(nF,&fieldSizes,nF,&fieldNc,nF,&fieldIndices);CHKERRQ(ierr);
175037d0c07bSMatthew G Knepley     ierr = PetscSectionGetChart(sectionGlobal, &pStart, &pEnd);CHKERRQ(ierr);
175137d0c07bSMatthew G Knepley     for (f = 0; f < nF; ++f) {
175237d0c07bSMatthew G Knepley       fieldSizes[f] = 0;
17533a544194SStefano Zampini       ierr          = PetscSectionGetFieldComponents(section, f, &fieldNc[f]);CHKERRQ(ierr);
175437d0c07bSMatthew G Knepley     }
175537d0c07bSMatthew G Knepley     for (p = pStart; p < pEnd; ++p) {
175637d0c07bSMatthew G Knepley       PetscInt gdof;
175737d0c07bSMatthew G Knepley 
175837d0c07bSMatthew G Knepley       ierr = PetscSectionGetDof(sectionGlobal, p, &gdof);CHKERRQ(ierr);
175937d0c07bSMatthew G Knepley       if (gdof > 0) {
176037d0c07bSMatthew G Knepley         for (f = 0; f < nF; ++f) {
17613a544194SStefano Zampini           PetscInt fdof, fcdof, fpdof;
176237d0c07bSMatthew G Knepley 
176337d0c07bSMatthew G Knepley           ierr  = PetscSectionGetFieldDof(section, p, f, &fdof);CHKERRQ(ierr);
176437d0c07bSMatthew G Knepley           ierr  = PetscSectionGetFieldConstraintDof(section, p, f, &fcdof);CHKERRQ(ierr);
17653a544194SStefano Zampini           fpdof = fdof-fcdof;
17663a544194SStefano Zampini           if (fpdof && fpdof != fieldNc[f]) {
17673a544194SStefano Zampini             /* Layout does not admit a pointwise block size */
17683a544194SStefano Zampini             fieldNc[f] = 1;
17693a544194SStefano Zampini           }
17703a544194SStefano Zampini           fieldSizes[f] += fpdof;
177137d0c07bSMatthew G Knepley         }
177237d0c07bSMatthew G Knepley       }
177337d0c07bSMatthew G Knepley     }
177437d0c07bSMatthew G Knepley     for (f = 0; f < nF; ++f) {
1775785e854fSJed Brown       ierr          = PetscMalloc1(fieldSizes[f], &fieldIndices[f]);CHKERRQ(ierr);
177637d0c07bSMatthew G Knepley       fieldSizes[f] = 0;
177737d0c07bSMatthew G Knepley     }
177837d0c07bSMatthew G Knepley     for (p = pStart; p < pEnd; ++p) {
177937d0c07bSMatthew G Knepley       PetscInt gdof, goff;
178037d0c07bSMatthew G Knepley 
178137d0c07bSMatthew G Knepley       ierr = PetscSectionGetDof(sectionGlobal, p, &gdof);CHKERRQ(ierr);
178237d0c07bSMatthew G Knepley       if (gdof > 0) {
178337d0c07bSMatthew G Knepley         ierr = PetscSectionGetOffset(sectionGlobal, p, &goff);CHKERRQ(ierr);
178437d0c07bSMatthew G Knepley         for (f = 0; f < nF; ++f) {
178537d0c07bSMatthew G Knepley           PetscInt fdof, fcdof, fc;
178637d0c07bSMatthew G Knepley 
178737d0c07bSMatthew G Knepley           ierr = PetscSectionGetFieldDof(section, p, f, &fdof);CHKERRQ(ierr);
178837d0c07bSMatthew G Knepley           ierr = PetscSectionGetFieldConstraintDof(section, p, f, &fcdof);CHKERRQ(ierr);
178937d0c07bSMatthew G Knepley           for (fc = 0; fc < fdof-fcdof; ++fc, ++fieldSizes[f]) {
179037d0c07bSMatthew G Knepley             fieldIndices[f][fieldSizes[f]] = goff++;
179137d0c07bSMatthew G Knepley           }
179237d0c07bSMatthew G Knepley         }
179337d0c07bSMatthew G Knepley       }
179437d0c07bSMatthew G Knepley     }
17958865f1eaSKarl Rupp     if (numFields) *numFields = nF;
179637d0c07bSMatthew G Knepley     if (fieldNames) {
1797785e854fSJed Brown       ierr = PetscMalloc1(nF, fieldNames);CHKERRQ(ierr);
179837d0c07bSMatthew G Knepley       for (f = 0; f < nF; ++f) {
179937d0c07bSMatthew G Knepley         const char *fieldName;
180037d0c07bSMatthew G Knepley 
180137d0c07bSMatthew G Knepley         ierr = PetscSectionGetFieldName(section, f, &fieldName);CHKERRQ(ierr);
180237d0c07bSMatthew G Knepley         ierr = PetscStrallocpy(fieldName, (char**) &(*fieldNames)[f]);CHKERRQ(ierr);
180337d0c07bSMatthew G Knepley       }
180437d0c07bSMatthew G Knepley     }
180537d0c07bSMatthew G Knepley     if (fields) {
1806785e854fSJed Brown       ierr = PetscMalloc1(nF, fields);CHKERRQ(ierr);
180737d0c07bSMatthew G Knepley       for (f = 0; f < nF; ++f) {
18083a544194SStefano Zampini         PetscInt bs, in[2], out[2];
18093a544194SStefano Zampini 
181082f516ccSBarry Smith         ierr  = ISCreateGeneral(PetscObjectComm((PetscObject)dm), fieldSizes[f], fieldIndices[f], PETSC_OWN_POINTER, &(*fields)[f]);CHKERRQ(ierr);
18113a544194SStefano Zampini         in[0] = -fieldNc[f];
18123a544194SStefano Zampini         in[1] = fieldNc[f];
1813820f2d46SBarry Smith         ierr  = MPIU_Allreduce(in, out, 2, MPIU_INT, MPI_MAX, PetscObjectComm((PetscObject)dm));CHKERRMPI(ierr);
18143a544194SStefano Zampini         bs    = (-out[0] == out[1]) ? out[1] : 1;
18153a544194SStefano Zampini         ierr  = ISSetBlockSize((*fields)[f], bs);CHKERRQ(ierr);
181637d0c07bSMatthew G Knepley       }
181737d0c07bSMatthew G Knepley     }
18183a544194SStefano Zampini     ierr = PetscFree3(fieldSizes,fieldNc,fieldIndices);CHKERRQ(ierr);
18198865f1eaSKarl Rupp   } else if (dm->ops->createfieldis) {
18208865f1eaSKarl Rupp     ierr = (*dm->ops->createfieldis)(dm, numFields, fieldNames, fields);CHKERRQ(ierr);
182169ca1f37SDmitry Karpeev   }
18224d343eeaSMatthew G Knepley   PetscFunctionReturn(0);
18234d343eeaSMatthew G Knepley }
18244d343eeaSMatthew G Knepley 
182516621825SDmitry Karpeev /*@C
182616621825SDmitry Karpeev   DMCreateFieldDecomposition - Returns a list of IS objects defining a decomposition of a problem into subproblems
182716621825SDmitry Karpeev                           corresponding to different fields: each IS contains the global indices of the dofs of the
182816621825SDmitry Karpeev                           corresponding field. The optional list of DMs define the DM for each subproblem.
1829e7c4fc90SDmitry Karpeev                           Generalizes DMCreateFieldIS().
1830e7c4fc90SDmitry Karpeev 
1831e7c4fc90SDmitry Karpeev   Not collective
1832e7c4fc90SDmitry Karpeev 
1833e7c4fc90SDmitry Karpeev   Input Parameter:
1834e7c4fc90SDmitry Karpeev . dm - the DM object
1835e7c4fc90SDmitry Karpeev 
1836e7c4fc90SDmitry Karpeev   Output Parameters:
18370298fd71SBarry Smith + len       - The number of subproblems in the field decomposition (or NULL if not requested)
18380298fd71SBarry Smith . namelist  - The name for each field (or NULL if not requested)
18390298fd71SBarry Smith . islist    - The global indices for each field (or NULL if not requested)
18400298fd71SBarry Smith - dmlist    - The DMs for each field subproblem (or NULL, if not requested; if NULL is returned, no DMs are defined)
1841e7c4fc90SDmitry Karpeev 
1842e7c4fc90SDmitry Karpeev   Level: intermediate
1843e7c4fc90SDmitry Karpeev 
1844e7c4fc90SDmitry Karpeev   Notes:
1845e7c4fc90SDmitry Karpeev   The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with
1846e7c4fc90SDmitry Karpeev   PetscFree(), every entry of is should be destroyed with ISDestroy(), every entry of dm should be destroyed with DMDestroy(),
1847e7c4fc90SDmitry Karpeev   and all of the arrays should be freed with PetscFree().
1848e7c4fc90SDmitry Karpeev 
1849e7c4fc90SDmitry Karpeev .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS()
1850e7c4fc90SDmitry Karpeev @*/
185116621825SDmitry Karpeev PetscErrorCode DMCreateFieldDecomposition(DM dm, PetscInt *len, char ***namelist, IS **islist, DM **dmlist)
1852e7c4fc90SDmitry Karpeev {
1853e7c4fc90SDmitry Karpeev   PetscErrorCode ierr;
1854e7c4fc90SDmitry Karpeev 
1855e7c4fc90SDmitry Karpeev   PetscFunctionBegin;
1856e7c4fc90SDmitry Karpeev   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
18578865f1eaSKarl Rupp   if (len) {
1858534a8f05SLisandro Dalcin     PetscValidIntPointer(len,2);
18598865f1eaSKarl Rupp     *len = 0;
18608865f1eaSKarl Rupp   }
18618865f1eaSKarl Rupp   if (namelist) {
18628865f1eaSKarl Rupp     PetscValidPointer(namelist,3);
1863ea78f98cSLisandro Dalcin     *namelist = NULL;
18648865f1eaSKarl Rupp   }
18658865f1eaSKarl Rupp   if (islist) {
18668865f1eaSKarl Rupp     PetscValidPointer(islist,4);
1867ea78f98cSLisandro Dalcin     *islist = NULL;
18688865f1eaSKarl Rupp   }
18698865f1eaSKarl Rupp   if (dmlist) {
18708865f1eaSKarl Rupp     PetscValidPointer(dmlist,5);
1871ea78f98cSLisandro Dalcin     *dmlist = NULL;
18728865f1eaSKarl Rupp   }
1873f3f0edfdSDmitry Karpeev   /*
1874f3f0edfdSDmitry Karpeev    Is it a good idea to apply the following check across all impls?
1875f3f0edfdSDmitry Karpeev    Perhaps some impls can have a well-defined decomposition before DMSetUp?
1876f3f0edfdSDmitry Karpeev    This, however, follows the general principle that accessors are not well-behaved until the object is set up.
1877f3f0edfdSDmitry Karpeev    */
1878ce94432eSBarry Smith   if (!dm->setupcalled) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_WRONGSTATE, "Decomposition defined only after DMSetUp");
187916621825SDmitry Karpeev   if (!dm->ops->createfielddecomposition) {
1880435a35e8SMatthew G Knepley     PetscSection section;
1881435a35e8SMatthew G Knepley     PetscInt     numFields, f;
1882435a35e8SMatthew G Knepley 
188392fd8e1eSJed Brown     ierr = DMGetLocalSection(dm, &section);CHKERRQ(ierr);
1884435a35e8SMatthew G Knepley     if (section) {ierr = PetscSectionGetNumFields(section, &numFields);CHKERRQ(ierr);}
1885435a35e8SMatthew G Knepley     if (section && numFields && dm->ops->createsubdm) {
1886f25d98f1SMatthew G. Knepley       if (len) *len = numFields;
188703dc3394SMatthew G. Knepley       if (namelist) {ierr = PetscMalloc1(numFields,namelist);CHKERRQ(ierr);}
188803dc3394SMatthew G. Knepley       if (islist)   {ierr = PetscMalloc1(numFields,islist);CHKERRQ(ierr);}
188903dc3394SMatthew G. Knepley       if (dmlist)   {ierr = PetscMalloc1(numFields,dmlist);CHKERRQ(ierr);}
1890435a35e8SMatthew G Knepley       for (f = 0; f < numFields; ++f) {
1891435a35e8SMatthew G Knepley         const char *fieldName;
1892435a35e8SMatthew G Knepley 
189303dc3394SMatthew G. Knepley         ierr = DMCreateSubDM(dm, 1, &f, islist ? &(*islist)[f] : NULL, dmlist ? &(*dmlist)[f] : NULL);CHKERRQ(ierr);
189403dc3394SMatthew G. Knepley         if (namelist) {
1895435a35e8SMatthew G Knepley           ierr = PetscSectionGetFieldName(section, f, &fieldName);CHKERRQ(ierr);
1896435a35e8SMatthew G Knepley           ierr = PetscStrallocpy(fieldName, (char**) &(*namelist)[f]);CHKERRQ(ierr);
1897435a35e8SMatthew G Knepley         }
189803dc3394SMatthew G. Knepley       }
1899435a35e8SMatthew G Knepley     } else {
190069ca1f37SDmitry Karpeev       ierr = DMCreateFieldIS(dm, len, namelist, islist);CHKERRQ(ierr);
1901e7c4fc90SDmitry Karpeev       /* By default there are no DMs associated with subproblems. */
19020298fd71SBarry Smith       if (dmlist) *dmlist = NULL;
1903e7c4fc90SDmitry Karpeev     }
19048865f1eaSKarl Rupp   } else {
190516621825SDmitry Karpeev     ierr = (*dm->ops->createfielddecomposition)(dm,len,namelist,islist,dmlist);CHKERRQ(ierr);
190616621825SDmitry Karpeev   }
190716621825SDmitry Karpeev   PetscFunctionReturn(0);
190816621825SDmitry Karpeev }
190916621825SDmitry Karpeev 
1910564cec59SMatthew G. Knepley /*@
1911435a35e8SMatthew G Knepley   DMCreateSubDM - Returns an IS and DM encapsulating a subproblem defined by the fields passed in.
1912435a35e8SMatthew G Knepley                   The fields are defined by DMCreateFieldIS().
1913435a35e8SMatthew G Knepley 
1914435a35e8SMatthew G Knepley   Not collective
1915435a35e8SMatthew G Knepley 
1916435a35e8SMatthew G Knepley   Input Parameters:
19172adcc780SMatthew G. Knepley + dm        - The DM object
19182adcc780SMatthew G. Knepley . numFields - The number of fields in this subproblem
19192adcc780SMatthew G. Knepley - fields    - The field numbers of the selected fields
1920435a35e8SMatthew G Knepley 
1921435a35e8SMatthew G Knepley   Output Parameters:
19222adcc780SMatthew G. Knepley + is - The global indices for the subproblem
19232adcc780SMatthew G. Knepley - subdm - The DM for the subproblem
1924435a35e8SMatthew G Knepley 
19255d3b26e6SMatthew G. Knepley   Note: You need to call DMPlexSetMigrationSF() on the original DM if you want the Global-To-Natural map to be automatically constructed
19265d3b26e6SMatthew G. Knepley 
1927435a35e8SMatthew G Knepley   Level: intermediate
1928435a35e8SMatthew G Knepley 
19295d3b26e6SMatthew G. Knepley .seealso DMPlexSetMigrationSF(), DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS()
1930435a35e8SMatthew G Knepley @*/
193137bc7515SMatthew G. Knepley PetscErrorCode DMCreateSubDM(DM dm, PetscInt numFields, const PetscInt fields[], IS *is, DM *subdm)
1932435a35e8SMatthew G Knepley {
1933435a35e8SMatthew G Knepley   PetscErrorCode ierr;
1934435a35e8SMatthew G Knepley 
1935435a35e8SMatthew G Knepley   PetscFunctionBegin;
1936435a35e8SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1937435a35e8SMatthew G Knepley   PetscValidPointer(fields,3);
19388865f1eaSKarl Rupp   if (is) PetscValidPointer(is,4);
19398865f1eaSKarl Rupp   if (subdm) PetscValidPointer(subdm,5);
1940b9d85ea2SLisandro Dalcin   if (!dm->ops->createsubdm) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateSubDM",((PetscObject)dm)->type_name);
1941435a35e8SMatthew G Knepley   ierr = (*dm->ops->createsubdm)(dm, numFields, fields, is, subdm);CHKERRQ(ierr);
1942435a35e8SMatthew G Knepley   PetscFunctionReturn(0);
1943435a35e8SMatthew G Knepley }
1944435a35e8SMatthew G Knepley 
19452adcc780SMatthew G. Knepley /*@C
19462adcc780SMatthew G. Knepley   DMCreateSuperDM - Returns an arrays of ISes and DM encapsulating a superproblem defined by the DMs passed in.
19472adcc780SMatthew G. Knepley 
19482adcc780SMatthew G. Knepley   Not collective
19492adcc780SMatthew G. Knepley 
19502adcc780SMatthew G. Knepley   Input Parameter:
19512adcc780SMatthew G. Knepley + dms - The DM objects
19522adcc780SMatthew G. Knepley - len - The number of DMs
19532adcc780SMatthew G. Knepley 
19542adcc780SMatthew G. Knepley   Output Parameters:
1955a42bd24dSMatthew G. Knepley + is - The global indices for the subproblem, or NULL
19562adcc780SMatthew G. Knepley - superdm - The DM for the superproblem
19572adcc780SMatthew G. Knepley 
19585d3b26e6SMatthew G. Knepley   Note: You need to call DMPlexSetMigrationSF() on the original DM if you want the Global-To-Natural map to be automatically constructed
19595d3b26e6SMatthew G. Knepley 
19602adcc780SMatthew G. Knepley   Level: intermediate
19612adcc780SMatthew G. Knepley 
19625d3b26e6SMatthew G. Knepley .seealso DMPlexSetMigrationSF(), DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS()
19632adcc780SMatthew G. Knepley @*/
19642adcc780SMatthew G. Knepley PetscErrorCode DMCreateSuperDM(DM dms[], PetscInt len, IS **is, DM *superdm)
19652adcc780SMatthew G. Knepley {
19662adcc780SMatthew G. Knepley   PetscInt       i;
19672adcc780SMatthew G. Knepley   PetscErrorCode ierr;
19682adcc780SMatthew G. Knepley 
19692adcc780SMatthew G. Knepley   PetscFunctionBegin;
19702adcc780SMatthew G. Knepley   PetscValidPointer(dms,1);
19712adcc780SMatthew G. Knepley   for (i = 0; i < len; ++i) {PetscValidHeaderSpecific(dms[i],DM_CLASSID,1);}
19722adcc780SMatthew G. Knepley   if (is) PetscValidPointer(is,3);
1973a42bd24dSMatthew G. Knepley   PetscValidPointer(superdm,4);
19742adcc780SMatthew G. Knepley   if (len < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Number of DMs must be nonnegative: %D", len);
19752adcc780SMatthew G. Knepley   if (len) {
1976b9d85ea2SLisandro Dalcin     DM dm = dms[0];
1977b9d85ea2SLisandro Dalcin     if (!dm->ops->createsuperdm) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateSuperDM",((PetscObject)dm)->type_name);
1978b9d85ea2SLisandro Dalcin     ierr = (*dm->ops->createsuperdm)(dms, len, is, superdm);CHKERRQ(ierr);
19792adcc780SMatthew G. Knepley   }
19802adcc780SMatthew G. Knepley   PetscFunctionReturn(0);
19812adcc780SMatthew G. Knepley }
19822adcc780SMatthew G. Knepley 
198316621825SDmitry Karpeev /*@C
19848d4ac253SDmitry Karpeev   DMCreateDomainDecomposition - Returns lists of IS objects defining a decomposition of a problem into subproblems
19858d4ac253SDmitry Karpeev                           corresponding to restrictions to pairs nested subdomains: each IS contains the global
19868d4ac253SDmitry Karpeev                           indices of the dofs of the corresponding subdomains.  The inner subdomains conceptually
19878d4ac253SDmitry Karpeev                           define a nonoverlapping covering, while outer subdomains can overlap.
19888d4ac253SDmitry Karpeev                           The optional list of DMs define the DM for each subproblem.
198916621825SDmitry Karpeev 
199016621825SDmitry Karpeev   Not collective
199116621825SDmitry Karpeev 
199216621825SDmitry Karpeev   Input Parameter:
199316621825SDmitry Karpeev . dm - the DM object
199416621825SDmitry Karpeev 
199516621825SDmitry Karpeev   Output Parameters:
19960298fd71SBarry Smith + len         - The number of subproblems in the domain decomposition (or NULL if not requested)
19970298fd71SBarry Smith . namelist    - The name for each subdomain (or NULL if not requested)
19980298fd71SBarry Smith . innerislist - The global indices for each inner subdomain (or NULL, if not requested)
19990298fd71SBarry Smith . outerislist - The global indices for each outer subdomain (or NULL, if not requested)
20000298fd71SBarry Smith - dmlist      - The DMs for each subdomain subproblem (or NULL, if not requested; if NULL is returned, no DMs are defined)
200116621825SDmitry Karpeev 
200216621825SDmitry Karpeev   Level: intermediate
200316621825SDmitry Karpeev 
200416621825SDmitry Karpeev   Notes:
200516621825SDmitry Karpeev   The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with
200616621825SDmitry Karpeev   PetscFree(), every entry of is should be destroyed with ISDestroy(), every entry of dm should be destroyed with DMDestroy(),
200716621825SDmitry Karpeev   and all of the arrays should be freed with PetscFree().
200816621825SDmitry Karpeev 
2009245d9833Sprj- .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldDecomposition()
201016621825SDmitry Karpeev @*/
20118d4ac253SDmitry Karpeev PetscErrorCode DMCreateDomainDecomposition(DM dm, PetscInt *len, char ***namelist, IS **innerislist, IS **outerislist, DM **dmlist)
201216621825SDmitry Karpeev {
201316621825SDmitry Karpeev   PetscErrorCode      ierr;
2014be081cd6SPeter Brune   DMSubDomainHookLink link;
2015be081cd6SPeter Brune   PetscInt            i,l;
201616621825SDmitry Karpeev 
201716621825SDmitry Karpeev   PetscFunctionBegin;
201816621825SDmitry Karpeev   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
201914a18fd3SPeter Brune   if (len)           {PetscValidPointer(len,2);            *len         = 0;}
20200298fd71SBarry Smith   if (namelist)      {PetscValidPointer(namelist,3);       *namelist    = NULL;}
20210298fd71SBarry Smith   if (innerislist)   {PetscValidPointer(innerislist,4);    *innerislist = NULL;}
20220298fd71SBarry Smith   if (outerislist)   {PetscValidPointer(outerislist,5);    *outerislist = NULL;}
20230298fd71SBarry Smith   if (dmlist)        {PetscValidPointer(dmlist,6);         *dmlist      = NULL;}
2024f3f0edfdSDmitry Karpeev   /*
2025f3f0edfdSDmitry Karpeev    Is it a good idea to apply the following check across all impls?
2026f3f0edfdSDmitry Karpeev    Perhaps some impls can have a well-defined decomposition before DMSetUp?
2027f3f0edfdSDmitry Karpeev    This, however, follows the general principle that accessors are not well-behaved until the object is set up.
2028f3f0edfdSDmitry Karpeev    */
2029ce94432eSBarry Smith   if (!dm->setupcalled) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_WRONGSTATE, "Decomposition defined only after DMSetUp");
203016621825SDmitry Karpeev   if (dm->ops->createdomaindecomposition) {
2031be081cd6SPeter Brune     ierr = (*dm->ops->createdomaindecomposition)(dm,&l,namelist,innerislist,outerislist,dmlist);CHKERRQ(ierr);
203214a18fd3SPeter Brune     /* copy subdomain hooks and context over to the subdomain DMs */
2033f891f5b9SPatrick Sanan     if (dmlist && *dmlist) {
2034be081cd6SPeter Brune       for (i = 0; i < l; i++) {
2035be081cd6SPeter Brune         for (link=dm->subdomainhook; link; link=link->next) {
2036be081cd6SPeter Brune           if (link->ddhook) {ierr = (*link->ddhook)(dm,(*dmlist)[i],link->ctx);CHKERRQ(ierr);}
2037be081cd6SPeter Brune         }
2038648262bbSPatrick Sanan         if (dm->ctx) (*dmlist)[i]->ctx = dm->ctx;
2039e7c4fc90SDmitry Karpeev       }
204014a18fd3SPeter Brune     }
204114a18fd3SPeter Brune     if (len) *len = l;
204214a18fd3SPeter Brune   }
2043e30e807fSPeter Brune   PetscFunctionReturn(0);
2044e30e807fSPeter Brune }
2045e30e807fSPeter Brune 
2046e30e807fSPeter Brune /*@C
2047e30e807fSPeter Brune   DMCreateDomainDecompositionScatters - Returns scatters to the subdomain vectors from the global vector
2048e30e807fSPeter Brune 
2049e30e807fSPeter Brune   Not collective
2050e30e807fSPeter Brune 
2051e30e807fSPeter Brune   Input Parameters:
2052e30e807fSPeter Brune + dm - the DM object
2053e30e807fSPeter Brune . n  - the number of subdomain scatters
2054e30e807fSPeter Brune - subdms - the local subdomains
2055e30e807fSPeter Brune 
2056e30e807fSPeter Brune   Output Parameters:
2057e30e807fSPeter Brune + n     - the number of scatters returned
2058e30e807fSPeter Brune . iscat - scatter from global vector to nonoverlapping global vector entries on subdomain
2059e30e807fSPeter Brune . oscat - scatter from global vector to overlapping global vector entries on subdomain
2060e30e807fSPeter Brune - gscat - scatter from global vector to local vector on subdomain (fills in ghosts)
2061e30e807fSPeter Brune 
206295452b02SPatrick Sanan   Notes:
206395452b02SPatrick Sanan     This is an alternative to the iis and ois arguments in DMCreateDomainDecomposition that allow for the solution
2064e30e807fSPeter Brune   of general nonlinear problems with overlapping subdomain methods.  While merely having index sets that enable subsets
2065e30e807fSPeter Brune   of the residual equations to be created is fine for linear problems, nonlinear problems require local assembly of
2066e30e807fSPeter Brune   solution and residual data.
2067e30e807fSPeter Brune 
2068e30e807fSPeter Brune   Level: developer
2069e30e807fSPeter Brune 
2070e30e807fSPeter Brune .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS()
2071e30e807fSPeter Brune @*/
2072e30e807fSPeter Brune PetscErrorCode DMCreateDomainDecompositionScatters(DM dm,PetscInt n,DM *subdms,VecScatter **iscat,VecScatter **oscat,VecScatter **gscat)
2073e30e807fSPeter Brune {
2074e30e807fSPeter Brune   PetscErrorCode ierr;
2075e30e807fSPeter Brune 
2076e30e807fSPeter Brune   PetscFunctionBegin;
2077e30e807fSPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2078e30e807fSPeter Brune   PetscValidPointer(subdms,3);
2079b9d85ea2SLisandro Dalcin   if (!dm->ops->createddscatters) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateDomainDecompositionScatters",((PetscObject)dm)->type_name);
2080e30e807fSPeter Brune   ierr = (*dm->ops->createddscatters)(dm,n,subdms,iscat,oscat,gscat);CHKERRQ(ierr);
2081e7c4fc90SDmitry Karpeev   PetscFunctionReturn(0);
2082e7c4fc90SDmitry Karpeev }
2083e7c4fc90SDmitry Karpeev 
208447c6ae99SBarry Smith /*@
208547c6ae99SBarry Smith   DMRefine - Refines a DM object
208647c6ae99SBarry Smith 
2087d083f849SBarry Smith   Collective on dm
208847c6ae99SBarry Smith 
208947c6ae99SBarry Smith   Input Parameter:
209047c6ae99SBarry Smith + dm   - the DM object
209191d95f02SJed Brown - comm - the communicator to contain the new DM object (or MPI_COMM_NULL)
209247c6ae99SBarry Smith 
209347c6ae99SBarry Smith   Output Parameter:
20940298fd71SBarry Smith . dmf - the refined DM, or NULL
2095ae0a1c52SMatthew G Knepley 
2096412e9a14SMatthew G. Knepley   Options Dtabase Keys:
2097412e9a14SMatthew G. Knepley . -dm_plex_cell_refiner <strategy> - chooses the refinement strategy, e.g. regular, tohex
2098412e9a14SMatthew G. Knepley 
20990298fd71SBarry Smith   Note: If no refinement was done, the return value is NULL
210047c6ae99SBarry Smith 
210147c6ae99SBarry Smith   Level: developer
210247c6ae99SBarry Smith 
2103e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
210447c6ae99SBarry Smith @*/
21057087cfbeSBarry Smith PetscErrorCode  DMRefine(DM dm,MPI_Comm comm,DM *dmf)
210647c6ae99SBarry Smith {
210747c6ae99SBarry Smith   PetscErrorCode   ierr;
2108c833c3b5SJed Brown   DMRefineHookLink link;
210947c6ae99SBarry Smith 
211047c6ae99SBarry Smith   PetscFunctionBegin;
2111732e2eb9SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2112b9d85ea2SLisandro Dalcin   if (!dm->ops->refine) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMRefine",((PetscObject)dm)->type_name);
21131ac00216SMatthew G. Knepley   ierr = PetscLogEventBegin(DM_Refine,dm,0,0,0);CHKERRQ(ierr);
211447c6ae99SBarry Smith   ierr = (*dm->ops->refine)(dm,comm,dmf);CHKERRQ(ierr);
21154057135bSMatthew G Knepley   if (*dmf) {
211643842a1eSJed Brown     (*dmf)->ops->creatematrix = dm->ops->creatematrix;
21178865f1eaSKarl Rupp 
21188cd211a4SJed Brown     ierr = PetscObjectCopyFortranFunctionPointers((PetscObject)dm,(PetscObject)*dmf);CHKERRQ(ierr);
21198865f1eaSKarl Rupp 
2120644e2e5bSBarry Smith     (*dmf)->ctx       = dm->ctx;
21210598a293SJed Brown     (*dmf)->leveldown = dm->leveldown;
2122656b349aSBarry Smith     (*dmf)->levelup   = dm->levelup + 1;
21238865f1eaSKarl Rupp 
2124e4b4b23bSJed Brown     ierr = DMSetMatType(*dmf,dm->mattype);CHKERRQ(ierr);
2125c833c3b5SJed Brown     for (link=dm->refinehook; link; link=link->next) {
21268865f1eaSKarl Rupp       if (link->refinehook) {
21278865f1eaSKarl Rupp         ierr = (*link->refinehook)(dm,*dmf,link->ctx);CHKERRQ(ierr);
21288865f1eaSKarl Rupp       }
2129c833c3b5SJed Brown     }
2130c833c3b5SJed Brown   }
21311ac00216SMatthew G. Knepley   ierr = PetscLogEventEnd(DM_Refine,dm,0,0,0);CHKERRQ(ierr);
2132c833c3b5SJed Brown   PetscFunctionReturn(0);
2133c833c3b5SJed Brown }
2134c833c3b5SJed Brown 
2135bb9467b5SJed Brown /*@C
2136c833c3b5SJed Brown    DMRefineHookAdd - adds a callback to be run when interpolating a nonlinear problem to a finer grid
2137c833c3b5SJed Brown 
2138c833c3b5SJed Brown    Logically Collective
2139c833c3b5SJed Brown 
2140c833c3b5SJed Brown    Input Arguments:
2141c833c3b5SJed Brown +  coarse - nonlinear solver context on which to run a hook when restricting to a coarser level
2142c833c3b5SJed Brown .  refinehook - function to run when setting up a coarser level
2143c833c3b5SJed Brown .  interphook - function to run to update data on finer levels (once per SNESSolve())
21440298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
2145c833c3b5SJed Brown 
2146c833c3b5SJed Brown    Calling sequence of refinehook:
2147c833c3b5SJed Brown $    refinehook(DM coarse,DM fine,void *ctx);
2148c833c3b5SJed Brown 
2149c833c3b5SJed Brown +  coarse - coarse level DM
2150c833c3b5SJed Brown .  fine - fine level DM to interpolate problem to
2151c833c3b5SJed Brown -  ctx - optional user-defined function context
2152c833c3b5SJed Brown 
2153c833c3b5SJed Brown    Calling sequence for interphook:
2154c833c3b5SJed Brown $    interphook(DM coarse,Mat interp,DM fine,void *ctx)
2155c833c3b5SJed Brown 
2156c833c3b5SJed Brown +  coarse - coarse level DM
2157c833c3b5SJed Brown .  interp - matrix interpolating a coarse-level solution to the finer grid
2158c833c3b5SJed Brown .  fine - fine level DM to update
2159c833c3b5SJed Brown -  ctx - optional user-defined function context
2160c833c3b5SJed Brown 
2161c833c3b5SJed Brown    Level: advanced
2162c833c3b5SJed Brown 
2163c833c3b5SJed Brown    Notes:
2164c833c3b5SJed Brown    This function is only needed if auxiliary data needs to be passed to fine grids while grid sequencing
2165c833c3b5SJed Brown 
2166c833c3b5SJed Brown    If this function is called multiple times, the hooks will be run in the order they are added.
2167c833c3b5SJed Brown 
2168bb9467b5SJed Brown    This function is currently not available from Fortran.
2169bb9467b5SJed Brown 
2170c833c3b5SJed Brown .seealso: DMCoarsenHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
2171c833c3b5SJed Brown @*/
2172c833c3b5SJed Brown PetscErrorCode DMRefineHookAdd(DM coarse,PetscErrorCode (*refinehook)(DM,DM,void*),PetscErrorCode (*interphook)(DM,Mat,DM,void*),void *ctx)
2173c833c3b5SJed Brown {
2174c833c3b5SJed Brown   PetscErrorCode   ierr;
2175c833c3b5SJed Brown   DMRefineHookLink link,*p;
2176c833c3b5SJed Brown 
2177c833c3b5SJed Brown   PetscFunctionBegin;
2178c833c3b5SJed Brown   PetscValidHeaderSpecific(coarse,DM_CLASSID,1);
21793d8e3701SJed Brown   for (p=&coarse->refinehook; *p; p=&(*p)->next) { /* Scan to the end of the current list of hooks */
21803d8e3701SJed Brown     if ((*p)->refinehook == refinehook && (*p)->interphook == interphook && (*p)->ctx == ctx) PetscFunctionReturn(0);
21813d8e3701SJed Brown   }
218295dccacaSBarry Smith   ierr             = PetscNew(&link);CHKERRQ(ierr);
2183c833c3b5SJed Brown   link->refinehook = refinehook;
2184c833c3b5SJed Brown   link->interphook = interphook;
2185c833c3b5SJed Brown   link->ctx        = ctx;
21860298fd71SBarry Smith   link->next       = NULL;
2187c833c3b5SJed Brown   *p               = link;
2188c833c3b5SJed Brown   PetscFunctionReturn(0);
2189c833c3b5SJed Brown }
2190c833c3b5SJed Brown 
21913d8e3701SJed Brown /*@C
21923d8e3701SJed Brown    DMRefineHookRemove - remove a callback from the list of hooks to be run when interpolating a nonlinear problem to a finer grid
21933d8e3701SJed Brown 
21943d8e3701SJed Brown    Logically Collective
21953d8e3701SJed Brown 
21963d8e3701SJed Brown    Input Arguments:
21973d8e3701SJed Brown +  coarse - nonlinear solver context on which to run a hook when restricting to a coarser level
21983d8e3701SJed Brown .  refinehook - function to run when setting up a coarser level
21993d8e3701SJed Brown .  interphook - function to run to update data on finer levels (once per SNESSolve())
22003d8e3701SJed Brown -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
22013d8e3701SJed Brown 
22023d8e3701SJed Brown    Level: advanced
22033d8e3701SJed Brown 
22043d8e3701SJed Brown    Notes:
22053d8e3701SJed Brown    This function does nothing if the hook is not in the list.
22063d8e3701SJed Brown 
22073d8e3701SJed Brown    This function is currently not available from Fortran.
22083d8e3701SJed Brown 
22093d8e3701SJed Brown .seealso: DMCoarsenHookRemove(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
22103d8e3701SJed Brown @*/
22113d8e3701SJed Brown PetscErrorCode DMRefineHookRemove(DM coarse,PetscErrorCode (*refinehook)(DM,DM,void*),PetscErrorCode (*interphook)(DM,Mat,DM,void*),void *ctx)
22123d8e3701SJed Brown {
22133d8e3701SJed Brown   PetscErrorCode   ierr;
22143d8e3701SJed Brown   DMRefineHookLink link,*p;
22153d8e3701SJed Brown 
22163d8e3701SJed Brown   PetscFunctionBegin;
22173d8e3701SJed Brown   PetscValidHeaderSpecific(coarse,DM_CLASSID,1);
22183d8e3701SJed Brown   for (p=&coarse->refinehook; *p; p=&(*p)->next) { /* Search the list of current hooks */
22193d8e3701SJed Brown     if ((*p)->refinehook == refinehook && (*p)->interphook == interphook && (*p)->ctx == ctx) {
22203d8e3701SJed Brown       link = *p;
22213d8e3701SJed Brown       *p = link->next;
22223d8e3701SJed Brown       ierr = PetscFree(link);CHKERRQ(ierr);
22233d8e3701SJed Brown       break;
22243d8e3701SJed Brown     }
22253d8e3701SJed Brown   }
22263d8e3701SJed Brown   PetscFunctionReturn(0);
22273d8e3701SJed Brown }
22283d8e3701SJed Brown 
2229c833c3b5SJed Brown /*@
2230c833c3b5SJed Brown    DMInterpolate - interpolates user-defined problem data to a finer DM by running hooks registered by DMRefineHookAdd()
2231c833c3b5SJed Brown 
2232c833c3b5SJed Brown    Collective if any hooks are
2233c833c3b5SJed Brown 
2234c833c3b5SJed Brown    Input Arguments:
2235c833c3b5SJed Brown +  coarse - coarser DM to use as a base
2236e91eccc2SStefano Zampini .  interp - interpolation matrix, apply using MatInterpolate()
2237c833c3b5SJed Brown -  fine - finer DM to update
2238c833c3b5SJed Brown 
2239c833c3b5SJed Brown    Level: developer
2240c833c3b5SJed Brown 
2241c833c3b5SJed Brown .seealso: DMRefineHookAdd(), MatInterpolate()
2242c833c3b5SJed Brown @*/
2243c833c3b5SJed Brown PetscErrorCode DMInterpolate(DM coarse,Mat interp,DM fine)
2244c833c3b5SJed Brown {
2245c833c3b5SJed Brown   PetscErrorCode   ierr;
2246c833c3b5SJed Brown   DMRefineHookLink link;
2247c833c3b5SJed Brown 
2248c833c3b5SJed Brown   PetscFunctionBegin;
2249c833c3b5SJed Brown   for (link=fine->refinehook; link; link=link->next) {
22508865f1eaSKarl Rupp     if (link->interphook) {
22518865f1eaSKarl Rupp       ierr = (*link->interphook)(coarse,interp,fine,link->ctx);CHKERRQ(ierr);
22528865f1eaSKarl Rupp     }
22534057135bSMatthew G Knepley   }
225447c6ae99SBarry Smith   PetscFunctionReturn(0);
225547c6ae99SBarry Smith }
225647c6ae99SBarry Smith 
2257eb3f98d2SBarry Smith /*@
22581f3379b2SToby Isaac    DMInterpolateSolution - Interpolates a solution from a coarse mesh to a fine mesh.
22591f3379b2SToby Isaac 
22601f3379b2SToby Isaac    Collective on DM
22611f3379b2SToby Isaac 
22621f3379b2SToby Isaac    Input Arguments:
22631f3379b2SToby Isaac +  coarse - coarse DM
22641f3379b2SToby Isaac .  fine   - fine DM
22651f3379b2SToby Isaac .  interp - (optional) the matrix computed by DMCreateInterpolation().  Implementations may not need this, but if it
22661f3379b2SToby Isaac             is available it can avoid some recomputation.  If it is provided, MatInterpolate() will be used if
22671f3379b2SToby Isaac             the coarse DM does not have a specialized implementation.
22681f3379b2SToby Isaac -  coarseSol - solution on the coarse mesh
22691f3379b2SToby Isaac 
22701f3379b2SToby Isaac    Output Arguments:
22711f3379b2SToby Isaac .  fineSol - the interpolation of coarseSol to the fine mesh
22721f3379b2SToby Isaac 
22731f3379b2SToby Isaac    Level: developer
22741f3379b2SToby Isaac 
22751f3379b2SToby Isaac    Note: This function exists because the interpolation of a solution vector between meshes is not always a linear
22761f3379b2SToby Isaac    map.  For example, if a boundary value problem has an inhomogeneous Dirichlet boundary condition that is compressed
22771f3379b2SToby Isaac    out of the solution vector.  Or if interpolation is inherently a nonlinear operation, such as a method using
22781f3379b2SToby Isaac    slope-limiting reconstruction.
22791f3379b2SToby Isaac 
22801f3379b2SToby Isaac .seealso DMInterpolate(), DMCreateInterpolation()
22811f3379b2SToby Isaac @*/
22821f3379b2SToby Isaac PetscErrorCode DMInterpolateSolution(DM coarse, DM fine, Mat interp, Vec coarseSol, Vec fineSol)
22831f3379b2SToby Isaac {
22841f3379b2SToby Isaac   PetscErrorCode (*interpsol)(DM,DM,Mat,Vec,Vec) = NULL;
22851f3379b2SToby Isaac   PetscErrorCode ierr;
22861f3379b2SToby Isaac 
22871f3379b2SToby Isaac   PetscFunctionBegin;
22881f3379b2SToby Isaac   PetscValidHeaderSpecific(coarse,DM_CLASSID,1);
22891f3379b2SToby Isaac   if (interp) PetscValidHeaderSpecific(interp,MAT_CLASSID,3);
22901f3379b2SToby Isaac   PetscValidHeaderSpecific(coarseSol,VEC_CLASSID,4);
22911f3379b2SToby Isaac   PetscValidHeaderSpecific(fineSol,VEC_CLASSID,5);
22921f3379b2SToby Isaac 
22931f3379b2SToby Isaac   ierr = PetscObjectQueryFunction((PetscObject)coarse,"DMInterpolateSolution_C", &interpsol);CHKERRQ(ierr);
22941f3379b2SToby Isaac   if (interpsol) {
22951f3379b2SToby Isaac     ierr = (*interpsol)(coarse, fine, interp, coarseSol, fineSol);CHKERRQ(ierr);
22961f3379b2SToby Isaac   } else if (interp) {
22971f3379b2SToby Isaac     ierr = MatInterpolate(interp, coarseSol, fineSol);CHKERRQ(ierr);
22981f3379b2SToby Isaac   } else SETERRQ1(PetscObjectComm((PetscObject)coarse), PETSC_ERR_SUP, "DM %s does not implement DMInterpolateSolution()", ((PetscObject)coarse)->type_name);
22991f3379b2SToby Isaac   PetscFunctionReturn(0);
23001f3379b2SToby Isaac }
23011f3379b2SToby Isaac 
23021f3379b2SToby Isaac /*@
2303aed49f88SRichard Tran Mills     DMGetRefineLevel - Gets the number of refinements that have generated this DM.
2304eb3f98d2SBarry Smith 
2305eb3f98d2SBarry Smith     Not Collective
2306eb3f98d2SBarry Smith 
2307eb3f98d2SBarry Smith     Input Parameter:
2308eb3f98d2SBarry Smith .   dm - the DM object
2309eb3f98d2SBarry Smith 
2310eb3f98d2SBarry Smith     Output Parameter:
2311eb3f98d2SBarry Smith .   level - number of refinements
2312eb3f98d2SBarry Smith 
2313eb3f98d2SBarry Smith     Level: developer
2314eb3f98d2SBarry Smith 
23156a7d9d85SPeter Brune .seealso DMCoarsen(), DMGetCoarsenLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
2316eb3f98d2SBarry Smith 
2317eb3f98d2SBarry Smith @*/
2318eb3f98d2SBarry Smith PetscErrorCode  DMGetRefineLevel(DM dm,PetscInt *level)
2319eb3f98d2SBarry Smith {
2320eb3f98d2SBarry Smith   PetscFunctionBegin;
2321eb3f98d2SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2322eb3f98d2SBarry Smith   *level = dm->levelup;
2323eb3f98d2SBarry Smith   PetscFunctionReturn(0);
2324eb3f98d2SBarry Smith }
2325eb3f98d2SBarry Smith 
2326fef3a512SBarry Smith /*@
2327aed49f88SRichard Tran Mills     DMSetRefineLevel - Sets the number of refinements that have generated this DM.
2328fef3a512SBarry Smith 
2329fef3a512SBarry Smith     Not Collective
2330fef3a512SBarry Smith 
2331fef3a512SBarry Smith     Input Parameter:
2332fef3a512SBarry Smith +   dm - the DM object
2333fef3a512SBarry Smith -   level - number of refinements
2334fef3a512SBarry Smith 
2335fef3a512SBarry Smith     Level: advanced
2336fef3a512SBarry Smith 
233795452b02SPatrick Sanan     Notes:
233895452b02SPatrick Sanan     This value is used by PCMG to determine how many multigrid levels to use
2339fef3a512SBarry Smith 
2340fef3a512SBarry Smith .seealso DMCoarsen(), DMGetCoarsenLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
2341fef3a512SBarry Smith 
2342fef3a512SBarry Smith @*/
2343fef3a512SBarry Smith PetscErrorCode  DMSetRefineLevel(DM dm,PetscInt level)
2344fef3a512SBarry Smith {
2345fef3a512SBarry Smith   PetscFunctionBegin;
2346fef3a512SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2347fef3a512SBarry Smith   dm->levelup = level;
2348fef3a512SBarry Smith   PetscFunctionReturn(0);
2349fef3a512SBarry Smith }
2350fef3a512SBarry Smith 
2351ca3d3a14SMatthew G. Knepley PetscErrorCode DMGetBasisTransformDM_Internal(DM dm, DM *tdm)
2352ca3d3a14SMatthew G. Knepley {
2353ca3d3a14SMatthew G. Knepley   PetscFunctionBegin;
2354ca3d3a14SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2355ca3d3a14SMatthew G. Knepley   PetscValidPointer(tdm, 2);
2356ca3d3a14SMatthew G. Knepley   *tdm = dm->transformDM;
2357ca3d3a14SMatthew G. Knepley   PetscFunctionReturn(0);
2358ca3d3a14SMatthew G. Knepley }
2359ca3d3a14SMatthew G. Knepley 
2360ca3d3a14SMatthew G. Knepley PetscErrorCode DMGetBasisTransformVec_Internal(DM dm, Vec *tv)
2361ca3d3a14SMatthew G. Knepley {
2362ca3d3a14SMatthew G. Knepley   PetscFunctionBegin;
2363ca3d3a14SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2364ca3d3a14SMatthew G. Knepley   PetscValidPointer(tv, 2);
2365ca3d3a14SMatthew G. Knepley   *tv = dm->transform;
2366ca3d3a14SMatthew G. Knepley   PetscFunctionReturn(0);
2367ca3d3a14SMatthew G. Knepley }
2368ca3d3a14SMatthew G. Knepley 
2369ca3d3a14SMatthew G. Knepley /*@
2370c0f8e1fdSMatthew G. Knepley   DMHasBasisTransform - Whether we employ a basis transformation from functions in global vectors to functions in local vectors
2371ca3d3a14SMatthew G. Knepley 
2372ca3d3a14SMatthew G. Knepley   Input Parameter:
2373ca3d3a14SMatthew G. Knepley . dm - The DM
2374ca3d3a14SMatthew G. Knepley 
2375ca3d3a14SMatthew G. Knepley   Output Parameter:
2376ca3d3a14SMatthew G. Knepley . flg - PETSC_TRUE if a basis transformation should be done
2377ca3d3a14SMatthew G. Knepley 
2378ca3d3a14SMatthew G. Knepley   Level: developer
2379ca3d3a14SMatthew G. Knepley 
2380436bc73aSJed Brown .seealso: DMPlexGlobalToLocalBasis(), DMPlexLocalToGlobalBasis(), DMPlexCreateBasisRotation()
2381ca3d3a14SMatthew G. Knepley @*/
2382ca3d3a14SMatthew G. Knepley PetscErrorCode DMHasBasisTransform(DM dm, PetscBool *flg)
2383ca3d3a14SMatthew G. Knepley {
2384ca3d3a14SMatthew G. Knepley   Vec            tv;
2385ca3d3a14SMatthew G. Knepley   PetscErrorCode ierr;
2386ca3d3a14SMatthew G. Knepley 
2387ca3d3a14SMatthew G. Knepley   PetscFunctionBegin;
2388ca3d3a14SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2389534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg, 2);
2390ca3d3a14SMatthew G. Knepley   ierr = DMGetBasisTransformVec_Internal(dm, &tv);CHKERRQ(ierr);
2391ca3d3a14SMatthew G. Knepley   *flg = tv ? PETSC_TRUE : PETSC_FALSE;
2392ca3d3a14SMatthew G. Knepley   PetscFunctionReturn(0);
2393ca3d3a14SMatthew G. Knepley }
2394ca3d3a14SMatthew G. Knepley 
2395ca3d3a14SMatthew G. Knepley PetscErrorCode DMConstructBasisTransform_Internal(DM dm)
2396ca3d3a14SMatthew G. Knepley {
2397ca3d3a14SMatthew G. Knepley   PetscSection   s, ts;
2398ca3d3a14SMatthew G. Knepley   PetscScalar   *ta;
2399ca3d3a14SMatthew G. Knepley   PetscInt       cdim, pStart, pEnd, p, Nf, f, Nc, dof;
2400ca3d3a14SMatthew G. Knepley   PetscErrorCode ierr;
2401ca3d3a14SMatthew G. Knepley 
2402ca3d3a14SMatthew G. Knepley   PetscFunctionBegin;
2403ca3d3a14SMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
240492fd8e1eSJed Brown   ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr);
2405ca3d3a14SMatthew G. Knepley   ierr = PetscSectionGetChart(s, &pStart, &pEnd);CHKERRQ(ierr);
2406ca3d3a14SMatthew G. Knepley   ierr = PetscSectionGetNumFields(s, &Nf);CHKERRQ(ierr);
2407ca3d3a14SMatthew G. Knepley   ierr = DMClone(dm, &dm->transformDM);CHKERRQ(ierr);
240892fd8e1eSJed Brown   ierr = DMGetLocalSection(dm->transformDM, &ts);CHKERRQ(ierr);
2409ca3d3a14SMatthew G. Knepley   ierr = PetscSectionSetNumFields(ts, Nf);CHKERRQ(ierr);
2410ca3d3a14SMatthew G. Knepley   ierr = PetscSectionSetChart(ts, pStart, pEnd);CHKERRQ(ierr);
2411ca3d3a14SMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
2412ca3d3a14SMatthew G. Knepley     ierr = PetscSectionGetFieldComponents(s, f, &Nc);CHKERRQ(ierr);
2413ca3d3a14SMatthew G. Knepley     /* We could start to label fields by their transformation properties */
2414ca3d3a14SMatthew G. Knepley     if (Nc != cdim) continue;
2415ca3d3a14SMatthew G. Knepley     for (p = pStart; p < pEnd; ++p) {
2416ca3d3a14SMatthew G. Knepley       ierr = PetscSectionGetFieldDof(s, p, f, &dof);CHKERRQ(ierr);
2417ca3d3a14SMatthew G. Knepley       if (!dof) continue;
2418ca3d3a14SMatthew G. Knepley       ierr = PetscSectionSetFieldDof(ts, p, f, PetscSqr(cdim));CHKERRQ(ierr);
2419ca3d3a14SMatthew G. Knepley       ierr = PetscSectionAddDof(ts, p, PetscSqr(cdim));CHKERRQ(ierr);
2420ca3d3a14SMatthew G. Knepley     }
2421ca3d3a14SMatthew G. Knepley   }
2422ca3d3a14SMatthew G. Knepley   ierr = PetscSectionSetUp(ts);CHKERRQ(ierr);
2423ca3d3a14SMatthew G. Knepley   ierr = DMCreateLocalVector(dm->transformDM, &dm->transform);CHKERRQ(ierr);
2424ca3d3a14SMatthew G. Knepley   ierr = VecGetArray(dm->transform, &ta);CHKERRQ(ierr);
2425ca3d3a14SMatthew G. Knepley   for (p = pStart; p < pEnd; ++p) {
2426ca3d3a14SMatthew G. Knepley     for (f = 0; f < Nf; ++f) {
2427ca3d3a14SMatthew G. Knepley       ierr = PetscSectionGetFieldDof(ts, p, f, &dof);CHKERRQ(ierr);
2428ca3d3a14SMatthew G. Knepley       if (dof) {
2429ca3d3a14SMatthew G. Knepley         PetscReal          x[3] = {0.0, 0.0, 0.0};
2430ca3d3a14SMatthew G. Knepley         PetscScalar       *tva;
2431ca3d3a14SMatthew G. Knepley         const PetscScalar *A;
2432ca3d3a14SMatthew G. Knepley 
2433ca3d3a14SMatthew G. Knepley         /* TODO Get quadrature point for this dual basis vector for coordinate */
2434ca3d3a14SMatthew G. Knepley         ierr = (*dm->transformGetMatrix)(dm, x, PETSC_TRUE, &A, dm->transformCtx);CHKERRQ(ierr);
2435ca3d3a14SMatthew G. Knepley         ierr = DMPlexPointLocalFieldRef(dm->transformDM, p, f, ta, (void *) &tva);CHKERRQ(ierr);
2436580bdb30SBarry Smith         ierr = PetscArraycpy(tva, A, PetscSqr(cdim));CHKERRQ(ierr);
2437ca3d3a14SMatthew G. Knepley       }
2438ca3d3a14SMatthew G. Knepley     }
2439ca3d3a14SMatthew G. Knepley   }
2440ca3d3a14SMatthew G. Knepley   ierr = VecRestoreArray(dm->transform, &ta);CHKERRQ(ierr);
2441ca3d3a14SMatthew G. Knepley   PetscFunctionReturn(0);
2442ca3d3a14SMatthew G. Knepley }
2443ca3d3a14SMatthew G. Knepley 
2444ca3d3a14SMatthew G. Knepley PetscErrorCode DMCopyTransform(DM dm, DM newdm)
2445ca3d3a14SMatthew G. Knepley {
2446ca3d3a14SMatthew G. Knepley   PetscErrorCode ierr;
2447ca3d3a14SMatthew G. Knepley 
2448ca3d3a14SMatthew G. Knepley   PetscFunctionBegin;
2449ca3d3a14SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2450ca3d3a14SMatthew G. Knepley   PetscValidHeaderSpecific(newdm, DM_CLASSID, 2);
2451ca3d3a14SMatthew G. Knepley   newdm->transformCtx       = dm->transformCtx;
2452ca3d3a14SMatthew G. Knepley   newdm->transformSetUp     = dm->transformSetUp;
2453ca3d3a14SMatthew G. Knepley   newdm->transformDestroy   = NULL;
2454ca3d3a14SMatthew G. Knepley   newdm->transformGetMatrix = dm->transformGetMatrix;
2455ca3d3a14SMatthew G. Knepley   if (newdm->transformSetUp) {ierr = DMConstructBasisTransform_Internal(newdm);CHKERRQ(ierr);}
2456ca3d3a14SMatthew G. Knepley   PetscFunctionReturn(0);
2457ca3d3a14SMatthew G. Knepley }
2458ca3d3a14SMatthew G. Knepley 
2459bb9467b5SJed Brown /*@C
2460baf369e7SPeter Brune    DMGlobalToLocalHookAdd - adds a callback to be run when global to local is called
2461baf369e7SPeter Brune 
2462baf369e7SPeter Brune    Logically Collective
2463baf369e7SPeter Brune 
2464baf369e7SPeter Brune    Input Arguments:
2465baf369e7SPeter Brune +  dm - the DM
2466baf369e7SPeter Brune .  beginhook - function to run at the beginning of DMGlobalToLocalBegin()
2467baf369e7SPeter Brune .  endhook - function to run after DMGlobalToLocalEnd() has completed
24680298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
2469baf369e7SPeter Brune 
2470baf369e7SPeter Brune    Calling sequence for beginhook:
2471baf369e7SPeter Brune $    beginhook(DM fine,VecScatter out,VecScatter in,DM coarse,void *ctx)
2472baf369e7SPeter Brune 
2473baf369e7SPeter Brune +  dm - global DM
2474baf369e7SPeter Brune .  g - global vector
2475baf369e7SPeter Brune .  mode - mode
2476baf369e7SPeter Brune .  l - local vector
2477baf369e7SPeter Brune -  ctx - optional user-defined function context
2478baf369e7SPeter Brune 
2479baf369e7SPeter Brune    Calling sequence for endhook:
2480ec4806b8SPeter Brune $    endhook(DM fine,VecScatter out,VecScatter in,DM coarse,void *ctx)
2481baf369e7SPeter Brune 
2482baf369e7SPeter Brune +  global - global DM
2483baf369e7SPeter Brune -  ctx - optional user-defined function context
2484baf369e7SPeter Brune 
2485baf369e7SPeter Brune    Level: advanced
2486baf369e7SPeter Brune 
2487baf369e7SPeter Brune .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
2488baf369e7SPeter Brune @*/
2489baf369e7SPeter Brune PetscErrorCode DMGlobalToLocalHookAdd(DM dm,PetscErrorCode (*beginhook)(DM,Vec,InsertMode,Vec,void*),PetscErrorCode (*endhook)(DM,Vec,InsertMode,Vec,void*),void *ctx)
2490baf369e7SPeter Brune {
2491baf369e7SPeter Brune   PetscErrorCode          ierr;
2492baf369e7SPeter Brune   DMGlobalToLocalHookLink link,*p;
2493baf369e7SPeter Brune 
2494baf369e7SPeter Brune   PetscFunctionBegin;
2495baf369e7SPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2496baf369e7SPeter Brune   for (p=&dm->gtolhook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */
249795dccacaSBarry Smith   ierr            = PetscNew(&link);CHKERRQ(ierr);
2498baf369e7SPeter Brune   link->beginhook = beginhook;
2499baf369e7SPeter Brune   link->endhook   = endhook;
2500baf369e7SPeter Brune   link->ctx       = ctx;
25010298fd71SBarry Smith   link->next      = NULL;
2502baf369e7SPeter Brune   *p              = link;
2503baf369e7SPeter Brune   PetscFunctionReturn(0);
2504baf369e7SPeter Brune }
2505baf369e7SPeter Brune 
25064c274da1SToby Isaac static PetscErrorCode DMGlobalToLocalHook_Constraints(DM dm, Vec g, InsertMode mode, Vec l, void *ctx)
25074c274da1SToby Isaac {
25084c274da1SToby Isaac   Mat cMat;
25094c274da1SToby Isaac   Vec cVec;
25104c274da1SToby Isaac   PetscSection section, cSec;
25114c274da1SToby Isaac   PetscInt pStart, pEnd, p, dof;
25124c274da1SToby Isaac   PetscErrorCode ierr;
25134c274da1SToby Isaac 
25144c274da1SToby Isaac   PetscFunctionBegin;
25154c274da1SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
25164c274da1SToby Isaac   ierr = DMGetDefaultConstraints(dm,&cSec,&cMat);CHKERRQ(ierr);
25174c274da1SToby Isaac   if (cMat && (mode == INSERT_VALUES || mode == INSERT_ALL_VALUES || mode == INSERT_BC_VALUES)) {
25185db9a05bSToby Isaac     PetscInt nRows;
25195db9a05bSToby Isaac 
25205db9a05bSToby Isaac     ierr = MatGetSize(cMat,&nRows,NULL);CHKERRQ(ierr);
25215db9a05bSToby Isaac     if (nRows <= 0) PetscFunctionReturn(0);
252292fd8e1eSJed Brown     ierr = DMGetLocalSection(dm,&section);CHKERRQ(ierr);
25237711e48fSToby Isaac     ierr = MatCreateVecs(cMat,NULL,&cVec);CHKERRQ(ierr);
25244c274da1SToby Isaac     ierr = MatMult(cMat,l,cVec);CHKERRQ(ierr);
25254c274da1SToby Isaac     ierr = PetscSectionGetChart(cSec,&pStart,&pEnd);CHKERRQ(ierr);
25264c274da1SToby Isaac     for (p = pStart; p < pEnd; p++) {
25274c274da1SToby Isaac       ierr = PetscSectionGetDof(cSec,p,&dof);CHKERRQ(ierr);
25284c274da1SToby Isaac       if (dof) {
25294c274da1SToby Isaac         PetscScalar *vals;
25304c274da1SToby Isaac         ierr = VecGetValuesSection(cVec,cSec,p,&vals);CHKERRQ(ierr);
25314c274da1SToby Isaac         ierr = VecSetValuesSection(l,section,p,vals,INSERT_ALL_VALUES);CHKERRQ(ierr);
25324c274da1SToby Isaac       }
25334c274da1SToby Isaac     }
25344c274da1SToby Isaac     ierr = VecDestroy(&cVec);CHKERRQ(ierr);
25354c274da1SToby Isaac   }
25364c274da1SToby Isaac   PetscFunctionReturn(0);
25374c274da1SToby Isaac }
25384c274da1SToby Isaac 
253947c6ae99SBarry Smith /*@
254001729b5cSPatrick Sanan     DMGlobalToLocal - update local vectors from global vector
254101729b5cSPatrick Sanan 
2542d083f849SBarry Smith     Neighbor-wise Collective on dm
254301729b5cSPatrick Sanan 
254401729b5cSPatrick Sanan     Input Parameters:
254501729b5cSPatrick Sanan +   dm - the DM object
254601729b5cSPatrick Sanan .   g - the global vector
254701729b5cSPatrick Sanan .   mode - INSERT_VALUES or ADD_VALUES
254801729b5cSPatrick Sanan -   l - the local vector
254901729b5cSPatrick Sanan 
255001729b5cSPatrick Sanan     Notes:
255101729b5cSPatrick Sanan     The communication involved in this update can be overlapped with computation by using
255201729b5cSPatrick Sanan     DMGlobalToLocalBegin() and DMGlobalToLocalEnd().
255301729b5cSPatrick Sanan 
255401729b5cSPatrick Sanan     Level: beginner
255501729b5cSPatrick Sanan 
255601729b5cSPatrick Sanan .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin(), DMLocalToGlobal(), DMLocalToGlobalBegin(), DMLocalToGlobalEnd()
255701729b5cSPatrick Sanan 
255801729b5cSPatrick Sanan @*/
255901729b5cSPatrick Sanan PetscErrorCode DMGlobalToLocal(DM dm,Vec g,InsertMode mode,Vec l)
256001729b5cSPatrick Sanan {
256101729b5cSPatrick Sanan   PetscErrorCode ierr;
256201729b5cSPatrick Sanan 
256301729b5cSPatrick Sanan   PetscFunctionBegin;
256401729b5cSPatrick Sanan   ierr = DMGlobalToLocalBegin(dm,g,mode,l);CHKERRQ(ierr);
256501729b5cSPatrick Sanan   ierr = DMGlobalToLocalEnd(dm,g,mode,l);CHKERRQ(ierr);
256601729b5cSPatrick Sanan   PetscFunctionReturn(0);
256701729b5cSPatrick Sanan }
256801729b5cSPatrick Sanan 
256901729b5cSPatrick Sanan /*@
257047c6ae99SBarry Smith     DMGlobalToLocalBegin - Begins updating local vectors from global vector
257147c6ae99SBarry Smith 
2572d083f849SBarry Smith     Neighbor-wise Collective on dm
257347c6ae99SBarry Smith 
257447c6ae99SBarry Smith     Input Parameters:
257547c6ae99SBarry Smith +   dm - the DM object
257647c6ae99SBarry Smith .   g - the global vector
257747c6ae99SBarry Smith .   mode - INSERT_VALUES or ADD_VALUES
257847c6ae99SBarry Smith -   l - the local vector
257947c6ae99SBarry Smith 
258001729b5cSPatrick Sanan     Level: intermediate
258147c6ae99SBarry Smith 
258201729b5cSPatrick Sanan .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin(), DMLocalToGlobal(), DMLocalToGlobalBegin(), DMLocalToGlobalEnd()
258347c6ae99SBarry Smith 
258447c6ae99SBarry Smith @*/
25857087cfbeSBarry Smith PetscErrorCode  DMGlobalToLocalBegin(DM dm,Vec g,InsertMode mode,Vec l)
258647c6ae99SBarry Smith {
25877128ae9fSMatthew G Knepley   PetscSF                 sf;
258847c6ae99SBarry Smith   PetscErrorCode          ierr;
2589baf369e7SPeter Brune   DMGlobalToLocalHookLink link;
259047c6ae99SBarry Smith 
259147c6ae99SBarry Smith   PetscFunctionBegin;
2592171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2593baf369e7SPeter Brune   for (link=dm->gtolhook; link; link=link->next) {
25948865f1eaSKarl Rupp     if (link->beginhook) {
25958865f1eaSKarl Rupp       ierr = (*link->beginhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);
25968865f1eaSKarl Rupp     }
2597baf369e7SPeter Brune   }
25981bb6d2a8SBarry Smith   ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr);
25997128ae9fSMatthew G Knepley   if (sf) {
2600ae5cfb4aSMatthew G. Knepley     const PetscScalar *gArray;
2601ae5cfb4aSMatthew G. Knepley     PetscScalar       *lArray;
2602d0295fc0SJunchao Zhang     PetscMemType      lmtype,gmtype;
26037128ae9fSMatthew G Knepley 
260482f516ccSBarry Smith     if (mode == ADD_VALUES) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
2605a256111fSJunchao Zhang     ierr = VecGetArrayAndMemType(l, &lArray, &lmtype);CHKERRQ(ierr);
2606a256111fSJunchao Zhang     ierr = VecGetArrayReadAndMemType(g, &gArray, &gmtype);CHKERRQ(ierr);
2607ad227feaSJunchao Zhang     ierr = PetscSFBcastWithMemTypeBegin(sf, MPIU_SCALAR, gmtype, gArray, lmtype, lArray, MPI_REPLACE);CHKERRQ(ierr);
2608a256111fSJunchao Zhang     ierr = VecRestoreArrayAndMemType(l, &lArray);CHKERRQ(ierr);
2609a256111fSJunchao Zhang     ierr = VecRestoreArrayReadAndMemType(g, &gArray);CHKERRQ(ierr);
26107128ae9fSMatthew G Knepley   } else {
261133907cc2SStefano Zampini     if (!dm->ops->globaltolocalbegin) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMGlobalToLocalBegin() for type %s",((PetscObject)dm)->type_name);
2612843c4018SMatthew G Knepley     ierr = (*dm->ops->globaltolocalbegin)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
26137128ae9fSMatthew G Knepley   }
261447c6ae99SBarry Smith   PetscFunctionReturn(0);
261547c6ae99SBarry Smith }
261647c6ae99SBarry Smith 
261747c6ae99SBarry Smith /*@
261847c6ae99SBarry Smith     DMGlobalToLocalEnd - Ends updating local vectors from global vector
261947c6ae99SBarry Smith 
2620d083f849SBarry Smith     Neighbor-wise Collective on dm
262147c6ae99SBarry Smith 
262247c6ae99SBarry Smith     Input Parameters:
262347c6ae99SBarry Smith +   dm - the DM object
262447c6ae99SBarry Smith .   g - the global vector
262547c6ae99SBarry Smith .   mode - INSERT_VALUES or ADD_VALUES
262647c6ae99SBarry Smith -   l - the local vector
262747c6ae99SBarry Smith 
262801729b5cSPatrick Sanan     Level: intermediate
262947c6ae99SBarry Smith 
263001729b5cSPatrick Sanan .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMLocalToGlobalBegin(), DMLocalToGlobal(), DMLocalToGlobalBegin(), DMLocalToGlobalEnd()
263147c6ae99SBarry Smith 
263247c6ae99SBarry Smith @*/
26337087cfbeSBarry Smith PetscErrorCode  DMGlobalToLocalEnd(DM dm,Vec g,InsertMode mode,Vec l)
263447c6ae99SBarry Smith {
26357128ae9fSMatthew G Knepley   PetscSF                 sf;
263647c6ae99SBarry Smith   PetscErrorCode          ierr;
2637ae5cfb4aSMatthew G. Knepley   const PetscScalar      *gArray;
2638ae5cfb4aSMatthew G. Knepley   PetscScalar            *lArray;
2639ca3d3a14SMatthew G. Knepley   PetscBool               transform;
2640baf369e7SPeter Brune   DMGlobalToLocalHookLink link;
2641d0295fc0SJunchao Zhang   PetscMemType            lmtype,gmtype;
264247c6ae99SBarry Smith 
264347c6ae99SBarry Smith   PetscFunctionBegin;
2644171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
26451bb6d2a8SBarry Smith   ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr);
2646ca3d3a14SMatthew G. Knepley   ierr = DMHasBasisTransform(dm, &transform);CHKERRQ(ierr);
26477128ae9fSMatthew G Knepley   if (sf) {
264882f516ccSBarry Smith     if (mode == ADD_VALUES) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
26497128ae9fSMatthew G Knepley 
2650a256111fSJunchao Zhang     ierr = VecGetArrayAndMemType(l, &lArray, &lmtype);CHKERRQ(ierr);
2651a256111fSJunchao Zhang     ierr = VecGetArrayReadAndMemType(g, &gArray, &gmtype);CHKERRQ(ierr);
2652ad227feaSJunchao Zhang     ierr = PetscSFBcastEnd(sf, MPIU_SCALAR, gArray, lArray,MPI_REPLACE);CHKERRQ(ierr);
2653a256111fSJunchao Zhang     ierr = VecRestoreArrayAndMemType(l, &lArray);CHKERRQ(ierr);
2654a256111fSJunchao Zhang     ierr = VecRestoreArrayReadAndMemType(g, &gArray);CHKERRQ(ierr);
2655ca3d3a14SMatthew G. Knepley     if (transform) {ierr = DMPlexGlobalToLocalBasis(dm, l);CHKERRQ(ierr);}
26567128ae9fSMatthew G Knepley   } else {
265733907cc2SStefano Zampini     if (!dm->ops->globaltolocalend) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMGlobalToLocalEnd() for type %s",((PetscObject)dm)->type_name);
2658843c4018SMatthew G Knepley     ierr = (*dm->ops->globaltolocalend)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
26597128ae9fSMatthew G Knepley   }
26604c274da1SToby Isaac   ierr = DMGlobalToLocalHook_Constraints(dm,g,mode,l,NULL);CHKERRQ(ierr);
2661baf369e7SPeter Brune   for (link=dm->gtolhook; link; link=link->next) {
2662baf369e7SPeter Brune     if (link->endhook) {ierr = (*link->endhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);}
2663baf369e7SPeter Brune   }
266447c6ae99SBarry Smith   PetscFunctionReturn(0);
266547c6ae99SBarry Smith }
266647c6ae99SBarry Smith 
2667d4d07f1eSToby Isaac /*@C
2668d4d07f1eSToby Isaac    DMLocalToGlobalHookAdd - adds a callback to be run when a local to global is called
2669d4d07f1eSToby Isaac 
2670d4d07f1eSToby Isaac    Logically Collective
2671d4d07f1eSToby Isaac 
2672d4d07f1eSToby Isaac    Input Arguments:
2673d4d07f1eSToby Isaac +  dm - the DM
2674d4d07f1eSToby Isaac .  beginhook - function to run at the beginning of DMLocalToGlobalBegin()
2675d4d07f1eSToby Isaac .  endhook - function to run after DMLocalToGlobalEnd() has completed
2676d4d07f1eSToby Isaac -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
2677d4d07f1eSToby Isaac 
2678d4d07f1eSToby Isaac    Calling sequence for beginhook:
2679d4d07f1eSToby Isaac $    beginhook(DM fine,Vec l,InsertMode mode,Vec g,void *ctx)
2680d4d07f1eSToby Isaac 
2681d4d07f1eSToby Isaac +  dm - global DM
2682d4d07f1eSToby Isaac .  l - local vector
2683d4d07f1eSToby Isaac .  mode - mode
2684d4d07f1eSToby Isaac .  g - global vector
2685d4d07f1eSToby Isaac -  ctx - optional user-defined function context
2686d4d07f1eSToby Isaac 
2687d4d07f1eSToby Isaac    Calling sequence for endhook:
2688d4d07f1eSToby Isaac $    endhook(DM fine,Vec l,InsertMode mode,Vec g,void *ctx)
2689d4d07f1eSToby Isaac 
2690d4d07f1eSToby Isaac +  global - global DM
2691d4d07f1eSToby Isaac .  l - local vector
2692d4d07f1eSToby Isaac .  mode - mode
2693d4d07f1eSToby Isaac .  g - global vector
2694d4d07f1eSToby Isaac -  ctx - optional user-defined function context
2695d4d07f1eSToby Isaac 
2696d4d07f1eSToby Isaac    Level: advanced
2697d4d07f1eSToby Isaac 
2698d4d07f1eSToby Isaac .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
2699d4d07f1eSToby Isaac @*/
2700d4d07f1eSToby Isaac PetscErrorCode DMLocalToGlobalHookAdd(DM dm,PetscErrorCode (*beginhook)(DM,Vec,InsertMode,Vec,void*),PetscErrorCode (*endhook)(DM,Vec,InsertMode,Vec,void*),void *ctx)
2701d4d07f1eSToby Isaac {
2702d4d07f1eSToby Isaac   PetscErrorCode          ierr;
2703d4d07f1eSToby Isaac   DMLocalToGlobalHookLink link,*p;
2704d4d07f1eSToby Isaac 
2705d4d07f1eSToby Isaac   PetscFunctionBegin;
2706d4d07f1eSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2707d4d07f1eSToby Isaac   for (p=&dm->ltoghook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */
270895dccacaSBarry Smith   ierr            = PetscNew(&link);CHKERRQ(ierr);
2709d4d07f1eSToby Isaac   link->beginhook = beginhook;
2710d4d07f1eSToby Isaac   link->endhook   = endhook;
2711d4d07f1eSToby Isaac   link->ctx       = ctx;
2712d4d07f1eSToby Isaac   link->next      = NULL;
2713d4d07f1eSToby Isaac   *p              = link;
2714d4d07f1eSToby Isaac   PetscFunctionReturn(0);
2715d4d07f1eSToby Isaac }
2716d4d07f1eSToby Isaac 
27174c274da1SToby Isaac static PetscErrorCode DMLocalToGlobalHook_Constraints(DM dm, Vec l, InsertMode mode, Vec g, void *ctx)
27184c274da1SToby Isaac {
27194c274da1SToby Isaac   Mat cMat;
27204c274da1SToby Isaac   Vec cVec;
27214c274da1SToby Isaac   PetscSection section, cSec;
27224c274da1SToby Isaac   PetscInt pStart, pEnd, p, dof;
27234c274da1SToby Isaac   PetscErrorCode ierr;
27244c274da1SToby Isaac 
27254c274da1SToby Isaac   PetscFunctionBegin;
27264c274da1SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
27274c274da1SToby Isaac   ierr = DMGetDefaultConstraints(dm,&cSec,&cMat);CHKERRQ(ierr);
27284c274da1SToby Isaac   if (cMat && (mode == ADD_VALUES || mode == ADD_ALL_VALUES || mode == ADD_BC_VALUES)) {
27295db9a05bSToby Isaac     PetscInt nRows;
27305db9a05bSToby Isaac 
27315db9a05bSToby Isaac     ierr = MatGetSize(cMat,&nRows,NULL);CHKERRQ(ierr);
27325db9a05bSToby Isaac     if (nRows <= 0) PetscFunctionReturn(0);
273392fd8e1eSJed Brown     ierr = DMGetLocalSection(dm,&section);CHKERRQ(ierr);
27347711e48fSToby Isaac     ierr = MatCreateVecs(cMat,NULL,&cVec);CHKERRQ(ierr);
27354c274da1SToby Isaac     ierr = PetscSectionGetChart(cSec,&pStart,&pEnd);CHKERRQ(ierr);
27364c274da1SToby Isaac     for (p = pStart; p < pEnd; p++) {
27374c274da1SToby Isaac       ierr = PetscSectionGetDof(cSec,p,&dof);CHKERRQ(ierr);
27384c274da1SToby Isaac       if (dof) {
27394c274da1SToby Isaac         PetscInt d;
27404c274da1SToby Isaac         PetscScalar *vals;
27414c274da1SToby Isaac         ierr = VecGetValuesSection(l,section,p,&vals);CHKERRQ(ierr);
27424c274da1SToby Isaac         ierr = VecSetValuesSection(cVec,cSec,p,vals,mode);CHKERRQ(ierr);
27434c274da1SToby Isaac         /* for this to be the true transpose, we have to zero the values that
27444c274da1SToby Isaac          * we just extracted */
27454c274da1SToby Isaac         for (d = 0; d < dof; d++) {
27464c274da1SToby Isaac           vals[d] = 0.;
27474c274da1SToby Isaac         }
27484c274da1SToby Isaac       }
27494c274da1SToby Isaac     }
27504c274da1SToby Isaac     ierr = MatMultTransposeAdd(cMat,cVec,l,l);CHKERRQ(ierr);
27514c274da1SToby Isaac     ierr = VecDestroy(&cVec);CHKERRQ(ierr);
27524c274da1SToby Isaac   }
27534c274da1SToby Isaac   PetscFunctionReturn(0);
27544c274da1SToby Isaac }
275501729b5cSPatrick Sanan /*@
275601729b5cSPatrick Sanan     DMLocalToGlobal - updates global vectors from local vectors
275701729b5cSPatrick Sanan 
2758d083f849SBarry Smith     Neighbor-wise Collective on dm
275901729b5cSPatrick Sanan 
276001729b5cSPatrick Sanan     Input Parameters:
276101729b5cSPatrick Sanan +   dm - the DM object
276201729b5cSPatrick Sanan .   l - the local vector
276301729b5cSPatrick 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.
276401729b5cSPatrick Sanan -   g - the global vector
276501729b5cSPatrick Sanan 
276601729b5cSPatrick Sanan     Notes:
276701729b5cSPatrick Sanan     The communication involved in this update can be overlapped with computation by using
276801729b5cSPatrick Sanan     DMLocalToGlobalBegin() and DMLocalToGlobalEnd().
276901729b5cSPatrick Sanan 
277001729b5cSPatrick Sanan     In the ADD_VALUES case you normally would zero the receiving vector before beginning this operation.
277101729b5cSPatrick 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.
277201729b5cSPatrick Sanan 
277301729b5cSPatrick Sanan     Level: beginner
277401729b5cSPatrick Sanan 
277501729b5cSPatrick Sanan .seealso DMLocalToGlobalBegin(), DMLocalToGlobalEnd(), DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMGlobalToLocalEnd(), DMGlobalToLocalBegin()
277601729b5cSPatrick Sanan 
277701729b5cSPatrick Sanan @*/
277801729b5cSPatrick Sanan PetscErrorCode DMLocalToGlobal(DM dm,Vec l,InsertMode mode,Vec g)
277901729b5cSPatrick Sanan {
278001729b5cSPatrick Sanan   PetscErrorCode ierr;
278101729b5cSPatrick Sanan 
278201729b5cSPatrick Sanan   PetscFunctionBegin;
278301729b5cSPatrick Sanan   ierr = DMLocalToGlobalBegin(dm,l,mode,g);CHKERRQ(ierr);
278401729b5cSPatrick Sanan   ierr = DMLocalToGlobalEnd(dm,l,mode,g);CHKERRQ(ierr);
278501729b5cSPatrick Sanan   PetscFunctionReturn(0);
278601729b5cSPatrick Sanan }
27874c274da1SToby Isaac 
278847c6ae99SBarry Smith /*@
278901729b5cSPatrick Sanan     DMLocalToGlobalBegin - begins updating global vectors from local vectors
27909a42bb27SBarry Smith 
2791d083f849SBarry Smith     Neighbor-wise Collective on dm
27929a42bb27SBarry Smith 
27939a42bb27SBarry Smith     Input Parameters:
27949a42bb27SBarry Smith +   dm - the DM object
2795f6813fd5SJed Brown .   l - the local vector
27961eb28f2eSBarry 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.
27971eb28f2eSBarry Smith -   g - the global vector
27989a42bb27SBarry Smith 
279995452b02SPatrick Sanan     Notes:
280095452b02SPatrick Sanan     In the ADD_VALUES case you normally would zero the receiving vector before beginning this operation.
280184330215SMatthew 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.
28029a42bb27SBarry Smith 
280301729b5cSPatrick Sanan     Level: intermediate
28049a42bb27SBarry Smith 
280501729b5cSPatrick Sanan .seealso DMLocalToGlobal(), DMLocalToGlobalEnd(), DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMGlobalToLocalEnd(), DMGlobalToLocalBegin()
28069a42bb27SBarry Smith 
28079a42bb27SBarry Smith @*/
28087087cfbeSBarry Smith PetscErrorCode  DMLocalToGlobalBegin(DM dm,Vec l,InsertMode mode,Vec g)
28099a42bb27SBarry Smith {
28107128ae9fSMatthew G Knepley   PetscSF                 sf;
281184330215SMatthew G. Knepley   PetscSection            s, gs;
2812d4d07f1eSToby Isaac   DMLocalToGlobalHookLink link;
2813ca3d3a14SMatthew G. Knepley   Vec                     tmpl;
2814ae5cfb4aSMatthew G. Knepley   const PetscScalar      *lArray;
2815ae5cfb4aSMatthew G. Knepley   PetscScalar            *gArray;
2816fa88e482SJed Brown   PetscBool               isInsert, transform, l_inplace = PETSC_FALSE, g_inplace = PETSC_FALSE;
281784330215SMatthew G. Knepley   PetscErrorCode          ierr;
2818d0295fc0SJunchao Zhang   PetscMemType            lmtype=PETSC_MEMTYPE_HOST,gmtype=PETSC_MEMTYPE_HOST;
28199a42bb27SBarry Smith 
28209a42bb27SBarry Smith   PetscFunctionBegin;
2821171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2822d4d07f1eSToby Isaac   for (link=dm->ltoghook; link; link=link->next) {
2823d4d07f1eSToby Isaac     if (link->beginhook) {
2824d4d07f1eSToby Isaac       ierr = (*link->beginhook)(dm,l,mode,g,link->ctx);CHKERRQ(ierr);
2825d4d07f1eSToby Isaac     }
2826d4d07f1eSToby Isaac   }
28274c274da1SToby Isaac   ierr = DMLocalToGlobalHook_Constraints(dm,l,mode,g,NULL);CHKERRQ(ierr);
28281bb6d2a8SBarry Smith   ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr);
282992fd8e1eSJed Brown   ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr);
28307128ae9fSMatthew G Knepley   switch (mode) {
28317128ae9fSMatthew G Knepley   case INSERT_VALUES:
28327128ae9fSMatthew G Knepley   case INSERT_ALL_VALUES:
2833304ab55fSMatthew G. Knepley   case INSERT_BC_VALUES:
283484330215SMatthew G. Knepley     isInsert = PETSC_TRUE; break;
28357128ae9fSMatthew G Knepley   case ADD_VALUES:
28367128ae9fSMatthew G Knepley   case ADD_ALL_VALUES:
2837304ab55fSMatthew G. Knepley   case ADD_BC_VALUES:
283884330215SMatthew G. Knepley     isInsert = PETSC_FALSE; break;
28397128ae9fSMatthew G Knepley   default:
284082f516ccSBarry Smith     SETERRQ1(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
28417128ae9fSMatthew G Knepley   }
2842ca3d3a14SMatthew G. Knepley   if ((sf && !isInsert) || (s && isInsert)) {
2843ca3d3a14SMatthew G. Knepley     ierr = DMHasBasisTransform(dm, &transform);CHKERRQ(ierr);
2844ca3d3a14SMatthew G. Knepley     if (transform) {
2845ca3d3a14SMatthew G. Knepley       ierr = DMGetNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr);
2846ca3d3a14SMatthew G. Knepley       ierr = VecCopy(l, tmpl);CHKERRQ(ierr);
2847ca3d3a14SMatthew G. Knepley       ierr = DMPlexLocalToGlobalBasis(dm, tmpl);CHKERRQ(ierr);
2848ca3d3a14SMatthew G. Knepley       ierr = VecGetArrayRead(tmpl, &lArray);CHKERRQ(ierr);
2849fa88e482SJed Brown     } else if (isInsert) {
2850ae5cfb4aSMatthew G. Knepley       ierr = VecGetArrayRead(l, &lArray);CHKERRQ(ierr);
2851fa88e482SJed Brown     } else {
2852a256111fSJunchao Zhang       ierr = VecGetArrayReadAndMemType(l, &lArray, &lmtype);CHKERRQ(ierr);
2853fa88e482SJed Brown       l_inplace = PETSC_TRUE;
2854ca3d3a14SMatthew G. Knepley     }
2855fa88e482SJed Brown     if (s && isInsert) {
28567128ae9fSMatthew G Knepley       ierr = VecGetArray(g, &gArray);CHKERRQ(ierr);
2857fa88e482SJed Brown     } else {
2858a256111fSJunchao Zhang       ierr = VecGetArrayAndMemType(g, &gArray, &gmtype);CHKERRQ(ierr);
2859fa88e482SJed Brown       g_inplace = PETSC_TRUE;
2860fa88e482SJed Brown     }
2861ca3d3a14SMatthew G. Knepley     if (sf && !isInsert) {
2862d0295fc0SJunchao Zhang       ierr = PetscSFReduceWithMemTypeBegin(sf, MPIU_SCALAR, lmtype, lArray, gmtype, gArray, MPIU_SUM);CHKERRQ(ierr);
286384330215SMatthew G. Knepley     } else if (s && isInsert) {
286484330215SMatthew G. Knepley       PetscInt gStart, pStart, pEnd, p;
286584330215SMatthew G. Knepley 
2866e87a4003SBarry Smith       ierr = DMGetGlobalSection(dm, &gs);CHKERRQ(ierr);
286784330215SMatthew G. Knepley       ierr = PetscSectionGetChart(s, &pStart, &pEnd);CHKERRQ(ierr);
286884330215SMatthew G. Knepley       ierr = VecGetOwnershipRange(g, &gStart, NULL);CHKERRQ(ierr);
286984330215SMatthew G. Knepley       for (p = pStart; p < pEnd; ++p) {
2870b3b16f48SMatthew G. Knepley         PetscInt dof, gdof, cdof, gcdof, off, goff, d, e;
287184330215SMatthew G. Knepley 
287284330215SMatthew G. Knepley         ierr = PetscSectionGetDof(s, p, &dof);CHKERRQ(ierr);
287303442857SMatthew G. Knepley         ierr = PetscSectionGetDof(gs, p, &gdof);CHKERRQ(ierr);
287484330215SMatthew G. Knepley         ierr = PetscSectionGetConstraintDof(s, p, &cdof);CHKERRQ(ierr);
2875b3b16f48SMatthew G. Knepley         ierr = PetscSectionGetConstraintDof(gs, p, &gcdof);CHKERRQ(ierr);
287684330215SMatthew G. Knepley         ierr = PetscSectionGetOffset(s, p, &off);CHKERRQ(ierr);
287784330215SMatthew G. Knepley         ierr = PetscSectionGetOffset(gs, p, &goff);CHKERRQ(ierr);
2878b3b16f48SMatthew G. Knepley         /* Ignore off-process data and points with no global data */
287903442857SMatthew G. Knepley         if (!gdof || goff < 0) continue;
2880b3b16f48SMatthew 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);
2881b3b16f48SMatthew G. Knepley         /* If no constraints are enforced in the global vector */
2882b3b16f48SMatthew G. Knepley         if (!gcdof) {
288384330215SMatthew G. Knepley           for (d = 0; d < dof; ++d) gArray[goff-gStart+d] = lArray[off+d];
2884b3b16f48SMatthew G. Knepley           /* If constraints are enforced in the global vector */
2885b3b16f48SMatthew G. Knepley         } else if (cdof == gcdof) {
288684330215SMatthew G. Knepley           const PetscInt *cdofs;
288784330215SMatthew G. Knepley           PetscInt        cind = 0;
288884330215SMatthew G. Knepley 
288984330215SMatthew G. Knepley           ierr = PetscSectionGetConstraintIndices(s, p, &cdofs);CHKERRQ(ierr);
2890b3b16f48SMatthew G. Knepley           for (d = 0, e = 0; d < dof; ++d) {
289184330215SMatthew G. Knepley             if ((cind < cdof) && (d == cdofs[cind])) {++cind; continue;}
2892b3b16f48SMatthew G. Knepley             gArray[goff-gStart+e++] = lArray[off+d];
289384330215SMatthew G. Knepley           }
2894b3b16f48SMatthew 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);
289584330215SMatthew G. Knepley       }
2896ca3d3a14SMatthew G. Knepley     }
2897fa88e482SJed Brown     if (g_inplace) {
2898a256111fSJunchao Zhang       ierr = VecRestoreArrayAndMemType(g, &gArray);CHKERRQ(ierr);
2899fa88e482SJed Brown     } else {
29007128ae9fSMatthew G Knepley       ierr = VecRestoreArray(g, &gArray);CHKERRQ(ierr);
2901fa88e482SJed Brown     }
2902ca3d3a14SMatthew G. Knepley     if (transform) {
2903ca3d3a14SMatthew G. Knepley       ierr = VecRestoreArrayRead(tmpl, &lArray);CHKERRQ(ierr);
2904ca3d3a14SMatthew G. Knepley       ierr = DMRestoreNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr);
2905fa88e482SJed Brown     } else if (l_inplace) {
2906a256111fSJunchao Zhang       ierr = VecRestoreArrayReadAndMemType(l, &lArray);CHKERRQ(ierr);
2907ca3d3a14SMatthew G. Knepley     } else {
2908ca3d3a14SMatthew G. Knepley       ierr = VecRestoreArrayRead(l, &lArray);CHKERRQ(ierr);
2909ca3d3a14SMatthew G. Knepley     }
29107128ae9fSMatthew G Knepley   } else {
2911b9d85ea2SLisandro Dalcin     if (!dm->ops->localtoglobalbegin) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMLocalToGlobalBegin() for type %s",((PetscObject)dm)->type_name);
2912843c4018SMatthew G Knepley     ierr = (*dm->ops->localtoglobalbegin)(dm,l,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),g);CHKERRQ(ierr);
29137128ae9fSMatthew G Knepley   }
29149a42bb27SBarry Smith   PetscFunctionReturn(0);
29159a42bb27SBarry Smith }
29169a42bb27SBarry Smith 
29179a42bb27SBarry Smith /*@
29189a42bb27SBarry Smith     DMLocalToGlobalEnd - updates global vectors from local vectors
291947c6ae99SBarry Smith 
2920d083f849SBarry Smith     Neighbor-wise Collective on dm
292147c6ae99SBarry Smith 
292247c6ae99SBarry Smith     Input Parameters:
292347c6ae99SBarry Smith +   dm - the DM object
2924f6813fd5SJed Brown .   l - the local vector
292547c6ae99SBarry Smith .   mode - INSERT_VALUES or ADD_VALUES
2926f6813fd5SJed Brown -   g - the global vector
292747c6ae99SBarry Smith 
292801729b5cSPatrick Sanan     Level: intermediate
292947c6ae99SBarry Smith 
2930e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMGlobalToLocalEnd()
293147c6ae99SBarry Smith 
293247c6ae99SBarry Smith @*/
29337087cfbeSBarry Smith PetscErrorCode  DMLocalToGlobalEnd(DM dm,Vec l,InsertMode mode,Vec g)
293447c6ae99SBarry Smith {
29357128ae9fSMatthew G Knepley   PetscSF                 sf;
293684330215SMatthew G. Knepley   PetscSection            s;
2937d4d07f1eSToby Isaac   DMLocalToGlobalHookLink link;
2938ca3d3a14SMatthew G. Knepley   PetscBool               isInsert, transform;
293984330215SMatthew G. Knepley   PetscErrorCode          ierr;
294047c6ae99SBarry Smith 
294147c6ae99SBarry Smith   PetscFunctionBegin;
2942171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
29431bb6d2a8SBarry Smith   ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr);
294492fd8e1eSJed Brown   ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr);
29457128ae9fSMatthew G Knepley   switch (mode) {
29467128ae9fSMatthew G Knepley   case INSERT_VALUES:
29477128ae9fSMatthew G Knepley   case INSERT_ALL_VALUES:
294884330215SMatthew G. Knepley     isInsert = PETSC_TRUE; break;
29497128ae9fSMatthew G Knepley   case ADD_VALUES:
29507128ae9fSMatthew G Knepley   case ADD_ALL_VALUES:
295184330215SMatthew G. Knepley     isInsert = PETSC_FALSE; break;
29527128ae9fSMatthew G Knepley   default:
295382f516ccSBarry Smith     SETERRQ1(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
29547128ae9fSMatthew G Knepley   }
295584330215SMatthew G. Knepley   if (sf && !isInsert) {
2956ae5cfb4aSMatthew G. Knepley     const PetscScalar *lArray;
2957ae5cfb4aSMatthew G. Knepley     PetscScalar       *gArray;
2958ca3d3a14SMatthew G. Knepley     Vec                tmpl;
295984330215SMatthew G. Knepley 
2960ca3d3a14SMatthew G. Knepley     ierr = DMHasBasisTransform(dm, &transform);CHKERRQ(ierr);
2961ca3d3a14SMatthew G. Knepley     if (transform) {
2962ca3d3a14SMatthew G. Knepley       ierr = DMGetNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr);
2963ca3d3a14SMatthew G. Knepley       ierr = VecGetArrayRead(tmpl, &lArray);CHKERRQ(ierr);
2964ca3d3a14SMatthew G. Knepley     } else {
2965a256111fSJunchao Zhang       ierr = VecGetArrayReadAndMemType(l, &lArray, NULL);CHKERRQ(ierr);
2966ca3d3a14SMatthew G. Knepley     }
2967a256111fSJunchao Zhang     ierr = VecGetArrayAndMemType(g, &gArray, NULL);CHKERRQ(ierr);
2968a9b180a6SBarry Smith     ierr = PetscSFReduceEnd(sf, MPIU_SCALAR, lArray, gArray, MPIU_SUM);CHKERRQ(ierr);
2969ca3d3a14SMatthew G. Knepley     if (transform) {
2970ca3d3a14SMatthew G. Knepley       ierr = VecRestoreArrayRead(tmpl, &lArray);CHKERRQ(ierr);
2971ca3d3a14SMatthew G. Knepley       ierr = DMRestoreNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr);
2972ca3d3a14SMatthew G. Knepley     } else {
2973a256111fSJunchao Zhang       ierr = VecRestoreArrayReadAndMemType(l, &lArray);CHKERRQ(ierr);
2974ca3d3a14SMatthew G. Knepley     }
2975a256111fSJunchao Zhang     ierr = VecRestoreArrayAndMemType(g, &gArray);CHKERRQ(ierr);
297684330215SMatthew G. Knepley   } else if (s && isInsert) {
29777128ae9fSMatthew G Knepley   } else {
2978b9d85ea2SLisandro Dalcin     if (!dm->ops->localtoglobalend) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMLocalToGlobalEnd() for type %s",((PetscObject)dm)->type_name);
2979843c4018SMatthew G Knepley     ierr = (*dm->ops->localtoglobalend)(dm,l,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),g);CHKERRQ(ierr);
29807128ae9fSMatthew G Knepley   }
2981d4d07f1eSToby Isaac   for (link=dm->ltoghook; link; link=link->next) {
2982d4d07f1eSToby Isaac     if (link->endhook) {ierr = (*link->endhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);}
2983d4d07f1eSToby Isaac   }
298447c6ae99SBarry Smith   PetscFunctionReturn(0);
298547c6ae99SBarry Smith }
298647c6ae99SBarry Smith 
2987f089877aSRichard Tran Mills /*@
2988bc0a1609SRichard Tran Mills    DMLocalToLocalBegin - Maps from a local vector (including ghost points
2989bc0a1609SRichard Tran Mills    that contain irrelevant values) to another local vector where the ghost
2990d78e899eSRichard Tran Mills    points in the second are set correctly. Must be followed by DMLocalToLocalEnd().
2991f089877aSRichard Tran Mills 
2992d083f849SBarry Smith    Neighbor-wise Collective on dm
2993f089877aSRichard Tran Mills 
2994f089877aSRichard Tran Mills    Input Parameters:
2995f089877aSRichard Tran Mills +  dm - the DM object
2996bc0a1609SRichard Tran Mills .  g - the original local vector
2997bc0a1609SRichard Tran Mills -  mode - one of INSERT_VALUES or ADD_VALUES
2998f089877aSRichard Tran Mills 
2999bc0a1609SRichard Tran Mills    Output Parameter:
3000bc0a1609SRichard Tran Mills .  l  - the local vector with correct ghost values
3001f089877aSRichard Tran Mills 
3002f089877aSRichard Tran Mills    Level: intermediate
3003f089877aSRichard Tran Mills 
3004bc0a1609SRichard Tran Mills    Notes:
3005bc0a1609SRichard Tran Mills    The local vectors used here need not be the same as those
3006bc0a1609SRichard Tran Mills    obtained from DMCreateLocalVector(), BUT they
3007bc0a1609SRichard Tran Mills    must have the same parallel data layout; they could, for example, be
3008bc0a1609SRichard Tran Mills    obtained with VecDuplicate() from the DM originating vectors.
3009bc0a1609SRichard Tran Mills 
3010bc0a1609SRichard Tran Mills .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateLocalVector(), DMCreateGlobalVector(), DMCreateInterpolation(), DMLocalToLocalEnd(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin()
3011f089877aSRichard Tran Mills 
3012f089877aSRichard Tran Mills @*/
3013f089877aSRichard Tran Mills PetscErrorCode  DMLocalToLocalBegin(DM dm,Vec g,InsertMode mode,Vec l)
3014f089877aSRichard Tran Mills {
3015f089877aSRichard Tran Mills   PetscErrorCode          ierr;
3016f089877aSRichard Tran Mills 
3017f089877aSRichard Tran Mills   PetscFunctionBegin;
3018f089877aSRichard Tran Mills   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3019bb358533SPatrick Sanan   if (!dm->ops->localtolocalbegin) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"This DM does not support local to local maps");
3020f089877aSRichard Tran Mills   ierr = (*dm->ops->localtolocalbegin)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
3021f089877aSRichard Tran Mills   PetscFunctionReturn(0);
3022f089877aSRichard Tran Mills }
3023f089877aSRichard Tran Mills 
3024f089877aSRichard Tran Mills /*@
3025bc0a1609SRichard Tran Mills    DMLocalToLocalEnd - Maps from a local vector (including ghost points
3026bc0a1609SRichard Tran Mills    that contain irrelevant values) to another local vector where the ghost
3027d78e899eSRichard Tran Mills    points in the second are set correctly. Must be preceded by DMLocalToLocalBegin().
3028f089877aSRichard Tran Mills 
3029d083f849SBarry Smith    Neighbor-wise Collective on dm
3030f089877aSRichard Tran Mills 
3031f089877aSRichard Tran Mills    Input Parameters:
3032bc0a1609SRichard Tran Mills +  da - the DM object
3033bc0a1609SRichard Tran Mills .  g - the original local vector
3034bc0a1609SRichard Tran Mills -  mode - one of INSERT_VALUES or ADD_VALUES
3035f089877aSRichard Tran Mills 
3036bc0a1609SRichard Tran Mills    Output Parameter:
3037bc0a1609SRichard Tran Mills .  l  - the local vector with correct ghost values
3038f089877aSRichard Tran Mills 
3039f089877aSRichard Tran Mills    Level: intermediate
3040f089877aSRichard Tran Mills 
3041bc0a1609SRichard Tran Mills    Notes:
3042bc0a1609SRichard Tran Mills    The local vectors used here need not be the same as those
3043bc0a1609SRichard Tran Mills    obtained from DMCreateLocalVector(), BUT they
3044bc0a1609SRichard Tran Mills    must have the same parallel data layout; they could, for example, be
3045bc0a1609SRichard Tran Mills    obtained with VecDuplicate() from the DM originating vectors.
3046bc0a1609SRichard Tran Mills 
3047bc0a1609SRichard Tran Mills .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateLocalVector(), DMCreateGlobalVector(), DMCreateInterpolation(), DMLocalToLocalBegin(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin()
3048f089877aSRichard Tran Mills 
3049f089877aSRichard Tran Mills @*/
3050f089877aSRichard Tran Mills PetscErrorCode  DMLocalToLocalEnd(DM dm,Vec g,InsertMode mode,Vec l)
3051f089877aSRichard Tran Mills {
3052f089877aSRichard Tran Mills   PetscErrorCode          ierr;
3053f089877aSRichard Tran Mills 
3054f089877aSRichard Tran Mills   PetscFunctionBegin;
3055f089877aSRichard Tran Mills   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3056bb358533SPatrick Sanan   if (!dm->ops->localtolocalend) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"This DM does not support local to local maps");
3057f089877aSRichard Tran Mills   ierr = (*dm->ops->localtolocalend)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
3058f089877aSRichard Tran Mills   PetscFunctionReturn(0);
3059f089877aSRichard Tran Mills }
3060f089877aSRichard Tran Mills 
306147c6ae99SBarry Smith /*@
306247c6ae99SBarry Smith     DMCoarsen - Coarsens a DM object
306347c6ae99SBarry Smith 
3064d083f849SBarry Smith     Collective on dm
306547c6ae99SBarry Smith 
306647c6ae99SBarry Smith     Input Parameter:
306747c6ae99SBarry Smith +   dm - the DM object
306891d95f02SJed Brown -   comm - the communicator to contain the new DM object (or MPI_COMM_NULL)
306947c6ae99SBarry Smith 
307047c6ae99SBarry Smith     Output Parameter:
307147c6ae99SBarry Smith .   dmc - the coarsened DM
307247c6ae99SBarry Smith 
307347c6ae99SBarry Smith     Level: developer
307447c6ae99SBarry Smith 
3075e727c939SJed Brown .seealso DMRefine(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
307647c6ae99SBarry Smith 
307747c6ae99SBarry Smith @*/
30787087cfbeSBarry Smith PetscErrorCode DMCoarsen(DM dm, MPI_Comm comm, DM *dmc)
307947c6ae99SBarry Smith {
308047c6ae99SBarry Smith   PetscErrorCode    ierr;
3081b17ce1afSJed Brown   DMCoarsenHookLink link;
308247c6ae99SBarry Smith 
308347c6ae99SBarry Smith   PetscFunctionBegin;
3084171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3085b9d85ea2SLisandro Dalcin   if (!dm->ops->coarsen) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCoarsen",((PetscObject)dm)->type_name);
308647a35634SPatrick Farrell   ierr = PetscLogEventBegin(DM_Coarsen,dm,0,0,0);CHKERRQ(ierr);
308747c6ae99SBarry Smith   ierr = (*dm->ops->coarsen)(dm, comm, dmc);CHKERRQ(ierr);
3088b9d85ea2SLisandro Dalcin   if (*dmc) {
3089a8fb8f29SToby Isaac     ierr = DMSetCoarseDM(dm,*dmc);CHKERRQ(ierr);
309043842a1eSJed Brown     (*dmc)->ops->creatematrix = dm->ops->creatematrix;
30918cd211a4SJed Brown     ierr                      = PetscObjectCopyFortranFunctionPointers((PetscObject)dm,(PetscObject)*dmc);CHKERRQ(ierr);
3092644e2e5bSBarry Smith     (*dmc)->ctx               = dm->ctx;
30930598a293SJed Brown     (*dmc)->levelup           = dm->levelup;
3094656b349aSBarry Smith     (*dmc)->leveldown         = dm->leveldown + 1;
3095e4b4b23bSJed Brown     ierr                      = DMSetMatType(*dmc,dm->mattype);CHKERRQ(ierr);
3096b17ce1afSJed Brown     for (link=dm->coarsenhook; link; link=link->next) {
3097b17ce1afSJed Brown       if (link->coarsenhook) {ierr = (*link->coarsenhook)(dm,*dmc,link->ctx);CHKERRQ(ierr);}
3098b17ce1afSJed Brown     }
3099b9d85ea2SLisandro Dalcin   }
310047a35634SPatrick Farrell   ierr = PetscLogEventEnd(DM_Coarsen,dm,0,0,0);CHKERRQ(ierr);
3101b9d85ea2SLisandro Dalcin   if (!(*dmc)) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "NULL coarse mesh produced");
3102b17ce1afSJed Brown   PetscFunctionReturn(0);
3103b17ce1afSJed Brown }
3104b17ce1afSJed Brown 
3105bb9467b5SJed Brown /*@C
3106b17ce1afSJed Brown    DMCoarsenHookAdd - adds a callback to be run when restricting a nonlinear problem to the coarse grid
3107b17ce1afSJed Brown 
3108b17ce1afSJed Brown    Logically Collective
3109b17ce1afSJed Brown 
3110b17ce1afSJed Brown    Input Arguments:
3111b17ce1afSJed Brown +  fine - nonlinear solver context on which to run a hook when restricting to a coarser level
3112b17ce1afSJed Brown .  coarsenhook - function to run when setting up a coarser level
3113b17ce1afSJed Brown .  restricthook - function to run to update data on coarser levels (once per SNESSolve())
31140298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
3115b17ce1afSJed Brown 
3116b17ce1afSJed Brown    Calling sequence of coarsenhook:
3117b17ce1afSJed Brown $    coarsenhook(DM fine,DM coarse,void *ctx);
3118b17ce1afSJed Brown 
3119b17ce1afSJed Brown +  fine - fine level DM
3120b17ce1afSJed Brown .  coarse - coarse level DM to restrict problem to
3121b17ce1afSJed Brown -  ctx - optional user-defined function context
3122b17ce1afSJed Brown 
3123b17ce1afSJed Brown    Calling sequence for restricthook:
3124c833c3b5SJed Brown $    restricthook(DM fine,Mat mrestrict,Vec rscale,Mat inject,DM coarse,void *ctx)
3125b17ce1afSJed Brown 
3126b17ce1afSJed Brown +  fine - fine level DM
3127b17ce1afSJed Brown .  mrestrict - matrix restricting a fine-level solution to the coarse grid
3128c833c3b5SJed Brown .  rscale - scaling vector for restriction
3129c833c3b5SJed Brown .  inject - matrix restricting by injection
3130b17ce1afSJed Brown .  coarse - coarse level DM to update
3131b17ce1afSJed Brown -  ctx - optional user-defined function context
3132b17ce1afSJed Brown 
3133b17ce1afSJed Brown    Level: advanced
3134b17ce1afSJed Brown 
3135b17ce1afSJed Brown    Notes:
3136b17ce1afSJed Brown    This function is only needed if auxiliary data needs to be set up on coarse grids.
3137b17ce1afSJed Brown 
3138b17ce1afSJed Brown    If this function is called multiple times, the hooks will be run in the order they are added.
3139b17ce1afSJed Brown 
3140b17ce1afSJed Brown    In order to compose with nonlinear preconditioning without duplicating storage, the hook should be implemented to
3141b17ce1afSJed Brown    extract the finest level information from its context (instead of from the SNES).
3142b17ce1afSJed Brown 
3143bb9467b5SJed Brown    This function is currently not available from Fortran.
3144bb9467b5SJed Brown 
3145dc822a44SJed Brown .seealso: DMCoarsenHookRemove(), DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
3146b17ce1afSJed Brown @*/
3147b17ce1afSJed Brown PetscErrorCode DMCoarsenHookAdd(DM fine,PetscErrorCode (*coarsenhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,Mat,Vec,Mat,DM,void*),void *ctx)
3148b17ce1afSJed Brown {
3149b17ce1afSJed Brown   PetscErrorCode    ierr;
3150b17ce1afSJed Brown   DMCoarsenHookLink link,*p;
3151b17ce1afSJed Brown 
3152b17ce1afSJed Brown   PetscFunctionBegin;
3153b17ce1afSJed Brown   PetscValidHeaderSpecific(fine,DM_CLASSID,1);
31541e3d8eccSJed Brown   for (p=&fine->coarsenhook; *p; p=&(*p)->next) { /* Scan to the end of the current list of hooks */
31551e3d8eccSJed Brown     if ((*p)->coarsenhook == coarsenhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) PetscFunctionReturn(0);
31561e3d8eccSJed Brown   }
315795dccacaSBarry Smith   ierr               = PetscNew(&link);CHKERRQ(ierr);
3158b17ce1afSJed Brown   link->coarsenhook  = coarsenhook;
3159b17ce1afSJed Brown   link->restricthook = restricthook;
3160b17ce1afSJed Brown   link->ctx          = ctx;
31610298fd71SBarry Smith   link->next         = NULL;
3162b17ce1afSJed Brown   *p                 = link;
3163b17ce1afSJed Brown   PetscFunctionReturn(0);
3164b17ce1afSJed Brown }
3165b17ce1afSJed Brown 
3166dc822a44SJed Brown /*@C
3167dc822a44SJed Brown    DMCoarsenHookRemove - remove a callback from the list of hooks to be run when restricting a nonlinear problem to the coarse grid
3168dc822a44SJed Brown 
3169dc822a44SJed Brown    Logically Collective
3170dc822a44SJed Brown 
3171dc822a44SJed Brown    Input Arguments:
3172dc822a44SJed Brown +  fine - nonlinear solver context on which to run a hook when restricting to a coarser level
3173dc822a44SJed Brown .  coarsenhook - function to run when setting up a coarser level
3174dc822a44SJed Brown .  restricthook - function to run to update data on coarser levels (once per SNESSolve())
3175dc822a44SJed Brown -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
3176dc822a44SJed Brown 
3177dc822a44SJed Brown    Level: advanced
3178dc822a44SJed Brown 
3179dc822a44SJed Brown    Notes:
3180dc822a44SJed Brown    This function does nothing if the hook is not in the list.
3181dc822a44SJed Brown 
3182dc822a44SJed Brown    This function is currently not available from Fortran.
3183dc822a44SJed Brown 
3184dc822a44SJed Brown .seealso: DMCoarsenHookAdd(), DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
3185dc822a44SJed Brown @*/
3186dc822a44SJed Brown PetscErrorCode DMCoarsenHookRemove(DM fine,PetscErrorCode (*coarsenhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,Mat,Vec,Mat,DM,void*),void *ctx)
3187dc822a44SJed Brown {
3188dc822a44SJed Brown   PetscErrorCode    ierr;
3189dc822a44SJed Brown   DMCoarsenHookLink link,*p;
3190dc822a44SJed Brown 
3191dc822a44SJed Brown   PetscFunctionBegin;
3192dc822a44SJed Brown   PetscValidHeaderSpecific(fine,DM_CLASSID,1);
3193dc822a44SJed Brown   for (p=&fine->coarsenhook; *p; p=&(*p)->next) { /* Search the list of current hooks */
3194dc822a44SJed Brown     if ((*p)->coarsenhook == coarsenhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) {
3195dc822a44SJed Brown       link = *p;
3196dc822a44SJed Brown       *p = link->next;
3197dc822a44SJed Brown       ierr = PetscFree(link);CHKERRQ(ierr);
3198dc822a44SJed Brown       break;
3199dc822a44SJed Brown     }
3200dc822a44SJed Brown   }
3201dc822a44SJed Brown   PetscFunctionReturn(0);
3202dc822a44SJed Brown }
3203dc822a44SJed Brown 
3204b17ce1afSJed Brown /*@
3205b17ce1afSJed Brown    DMRestrict - restricts user-defined problem data to a coarser DM by running hooks registered by DMCoarsenHookAdd()
3206b17ce1afSJed Brown 
3207b17ce1afSJed Brown    Collective if any hooks are
3208b17ce1afSJed Brown 
3209b17ce1afSJed Brown    Input Arguments:
3210b17ce1afSJed Brown +  fine - finer DM to use as a base
3211b17ce1afSJed Brown .  restrct - restriction matrix, apply using MatRestrict()
3212e91eccc2SStefano Zampini .  rscale - scaling vector for restriction
3213b17ce1afSJed Brown .  inject - injection matrix, also use MatRestrict()
3214e91eccc2SStefano Zampini -  coarse - coarser DM to update
3215b17ce1afSJed Brown 
3216b17ce1afSJed Brown    Level: developer
3217b17ce1afSJed Brown 
3218b17ce1afSJed Brown .seealso: DMCoarsenHookAdd(), MatRestrict()
3219b17ce1afSJed Brown @*/
3220b17ce1afSJed Brown PetscErrorCode DMRestrict(DM fine,Mat restrct,Vec rscale,Mat inject,DM coarse)
3221b17ce1afSJed Brown {
3222b17ce1afSJed Brown   PetscErrorCode    ierr;
3223b17ce1afSJed Brown   DMCoarsenHookLink link;
3224b17ce1afSJed Brown 
3225b17ce1afSJed Brown   PetscFunctionBegin;
3226b17ce1afSJed Brown   for (link=fine->coarsenhook; link; link=link->next) {
32278865f1eaSKarl Rupp     if (link->restricthook) {
32288865f1eaSKarl Rupp       ierr = (*link->restricthook)(fine,restrct,rscale,inject,coarse,link->ctx);CHKERRQ(ierr);
32298865f1eaSKarl Rupp     }
3230b17ce1afSJed Brown   }
323147c6ae99SBarry Smith   PetscFunctionReturn(0);
323247c6ae99SBarry Smith }
323347c6ae99SBarry Smith 
3234bb9467b5SJed Brown /*@C
3235be081cd6SPeter Brune    DMSubDomainHookAdd - adds a callback to be run when restricting a problem to the coarse grid
32365dbd56e3SPeter Brune 
3237d083f849SBarry Smith    Logically Collective on global
32385dbd56e3SPeter Brune 
32395dbd56e3SPeter Brune    Input Arguments:
32405dbd56e3SPeter Brune +  global - global DM
3241ec4806b8SPeter Brune .  ddhook - function to run to pass data to the decomposition DM upon its creation
32425dbd56e3SPeter Brune .  restricthook - function to run to update data on block solve (at the beginning of the block solve)
32430298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
32445dbd56e3SPeter Brune 
3245ec4806b8SPeter Brune    Calling sequence for ddhook:
3246ec4806b8SPeter Brune $    ddhook(DM global,DM block,void *ctx)
3247ec4806b8SPeter Brune 
3248ec4806b8SPeter Brune +  global - global DM
3249ec4806b8SPeter Brune .  block  - block DM
3250ec4806b8SPeter Brune -  ctx - optional user-defined function context
3251ec4806b8SPeter Brune 
32525dbd56e3SPeter Brune    Calling sequence for restricthook:
3253ec4806b8SPeter Brune $    restricthook(DM global,VecScatter out,VecScatter in,DM block,void *ctx)
32545dbd56e3SPeter Brune 
32555dbd56e3SPeter Brune +  global - global DM
32565dbd56e3SPeter Brune .  out    - scatter to the outer (with ghost and overlap points) block vector
32575dbd56e3SPeter Brune .  in     - scatter to block vector values only owned locally
3258ec4806b8SPeter Brune .  block  - block DM
32595dbd56e3SPeter Brune -  ctx - optional user-defined function context
32605dbd56e3SPeter Brune 
32615dbd56e3SPeter Brune    Level: advanced
32625dbd56e3SPeter Brune 
32635dbd56e3SPeter Brune    Notes:
3264ec4806b8SPeter Brune    This function is only needed if auxiliary data needs to be set up on subdomain DMs.
32655dbd56e3SPeter Brune 
32665dbd56e3SPeter Brune    If this function is called multiple times, the hooks will be run in the order they are added.
32675dbd56e3SPeter Brune 
32685dbd56e3SPeter Brune    In order to compose with nonlinear preconditioning without duplicating storage, the hook should be implemented to
3269ec4806b8SPeter Brune    extract the global information from its context (instead of from the SNES).
32705dbd56e3SPeter Brune 
3271bb9467b5SJed Brown    This function is currently not available from Fortran.
3272bb9467b5SJed Brown 
32735dbd56e3SPeter Brune .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
32745dbd56e3SPeter Brune @*/
3275be081cd6SPeter Brune PetscErrorCode DMSubDomainHookAdd(DM global,PetscErrorCode (*ddhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,VecScatter,VecScatter,DM,void*),void *ctx)
32765dbd56e3SPeter Brune {
32775dbd56e3SPeter Brune   PetscErrorCode      ierr;
3278be081cd6SPeter Brune   DMSubDomainHookLink link,*p;
32795dbd56e3SPeter Brune 
32805dbd56e3SPeter Brune   PetscFunctionBegin;
32815dbd56e3SPeter Brune   PetscValidHeaderSpecific(global,DM_CLASSID,1);
3282b3a6b972SJed Brown   for (p=&global->subdomainhook; *p; p=&(*p)->next) { /* Scan to the end of the current list of hooks */
3283b3a6b972SJed Brown     if ((*p)->ddhook == ddhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) PetscFunctionReturn(0);
3284b3a6b972SJed Brown   }
328595dccacaSBarry Smith   ierr               = PetscNew(&link);CHKERRQ(ierr);
32865dbd56e3SPeter Brune   link->restricthook = restricthook;
3287be081cd6SPeter Brune   link->ddhook       = ddhook;
32885dbd56e3SPeter Brune   link->ctx          = ctx;
32890298fd71SBarry Smith   link->next         = NULL;
32905dbd56e3SPeter Brune   *p                 = link;
32915dbd56e3SPeter Brune   PetscFunctionReturn(0);
32925dbd56e3SPeter Brune }
32935dbd56e3SPeter Brune 
3294b3a6b972SJed Brown /*@C
3295b3a6b972SJed Brown    DMSubDomainHookRemove - remove a callback from the list to be run when restricting a problem to the coarse grid
3296b3a6b972SJed Brown 
3297b3a6b972SJed Brown    Logically Collective
3298b3a6b972SJed Brown 
3299b3a6b972SJed Brown    Input Arguments:
3300b3a6b972SJed Brown +  global - global DM
3301b3a6b972SJed Brown .  ddhook - function to run to pass data to the decomposition DM upon its creation
3302b3a6b972SJed Brown .  restricthook - function to run to update data on block solve (at the beginning of the block solve)
3303b3a6b972SJed Brown -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
3304b3a6b972SJed Brown 
3305b3a6b972SJed Brown    Level: advanced
3306b3a6b972SJed Brown 
3307b3a6b972SJed Brown    Notes:
3308b3a6b972SJed Brown 
3309b3a6b972SJed Brown    This function is currently not available from Fortran.
3310b3a6b972SJed Brown 
3311b3a6b972SJed Brown .seealso: DMSubDomainHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
3312b3a6b972SJed Brown @*/
3313b3a6b972SJed Brown PetscErrorCode DMSubDomainHookRemove(DM global,PetscErrorCode (*ddhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,VecScatter,VecScatter,DM,void*),void *ctx)
3314b3a6b972SJed Brown {
3315b3a6b972SJed Brown   PetscErrorCode      ierr;
3316b3a6b972SJed Brown   DMSubDomainHookLink link,*p;
3317b3a6b972SJed Brown 
3318b3a6b972SJed Brown   PetscFunctionBegin;
3319b3a6b972SJed Brown   PetscValidHeaderSpecific(global,DM_CLASSID,1);
3320b3a6b972SJed Brown   for (p=&global->subdomainhook; *p; p=&(*p)->next) { /* Search the list of current hooks */
3321b3a6b972SJed Brown     if ((*p)->ddhook == ddhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) {
3322b3a6b972SJed Brown       link = *p;
3323b3a6b972SJed Brown       *p = link->next;
3324b3a6b972SJed Brown       ierr = PetscFree(link);CHKERRQ(ierr);
3325b3a6b972SJed Brown       break;
3326b3a6b972SJed Brown     }
3327b3a6b972SJed Brown   }
3328b3a6b972SJed Brown   PetscFunctionReturn(0);
3329b3a6b972SJed Brown }
3330b3a6b972SJed Brown 
33315dbd56e3SPeter Brune /*@
3332be081cd6SPeter Brune    DMSubDomainRestrict - restricts user-defined problem data to a block DM by running hooks registered by DMSubDomainHookAdd()
33335dbd56e3SPeter Brune 
33345dbd56e3SPeter Brune    Collective if any hooks are
33355dbd56e3SPeter Brune 
33365dbd56e3SPeter Brune    Input Arguments:
33375dbd56e3SPeter Brune +  fine - finer DM to use as a base
3338be081cd6SPeter Brune .  oscatter - scatter from domain global vector filling subdomain global vector with overlap
3339be081cd6SPeter Brune .  gscatter - scatter from domain global vector filling subdomain local vector with ghosts
33405dbd56e3SPeter Brune -  coarse - coarer DM to update
33415dbd56e3SPeter Brune 
33425dbd56e3SPeter Brune    Level: developer
33435dbd56e3SPeter Brune 
33445dbd56e3SPeter Brune .seealso: DMCoarsenHookAdd(), MatRestrict()
33455dbd56e3SPeter Brune @*/
3346be081cd6SPeter Brune PetscErrorCode DMSubDomainRestrict(DM global,VecScatter oscatter,VecScatter gscatter,DM subdm)
33475dbd56e3SPeter Brune {
33485dbd56e3SPeter Brune   PetscErrorCode      ierr;
3349be081cd6SPeter Brune   DMSubDomainHookLink link;
33505dbd56e3SPeter Brune 
33515dbd56e3SPeter Brune   PetscFunctionBegin;
3352be081cd6SPeter Brune   for (link=global->subdomainhook; link; link=link->next) {
33538865f1eaSKarl Rupp     if (link->restricthook) {
33548865f1eaSKarl Rupp       ierr = (*link->restricthook)(global,oscatter,gscatter,subdm,link->ctx);CHKERRQ(ierr);
33558865f1eaSKarl Rupp     }
33565dbd56e3SPeter Brune   }
33575dbd56e3SPeter Brune   PetscFunctionReturn(0);
33585dbd56e3SPeter Brune }
33595dbd56e3SPeter Brune 
33605fe1f584SPeter Brune /*@
33616a7d9d85SPeter Brune     DMGetCoarsenLevel - Get's the number of coarsenings that have generated this DM.
33625fe1f584SPeter Brune 
33635fe1f584SPeter Brune     Not Collective
33645fe1f584SPeter Brune 
33655fe1f584SPeter Brune     Input Parameter:
33665fe1f584SPeter Brune .   dm - the DM object
33675fe1f584SPeter Brune 
33685fe1f584SPeter Brune     Output Parameter:
33696a7d9d85SPeter Brune .   level - number of coarsenings
33705fe1f584SPeter Brune 
33715fe1f584SPeter Brune     Level: developer
33725fe1f584SPeter Brune 
33736a7d9d85SPeter Brune .seealso DMCoarsen(), DMGetRefineLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
33745fe1f584SPeter Brune 
33755fe1f584SPeter Brune @*/
33765fe1f584SPeter Brune PetscErrorCode  DMGetCoarsenLevel(DM dm,PetscInt *level)
33775fe1f584SPeter Brune {
33785fe1f584SPeter Brune   PetscFunctionBegin;
33795fe1f584SPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3380b9d85ea2SLisandro Dalcin   PetscValidIntPointer(level,2);
33815fe1f584SPeter Brune   *level = dm->leveldown;
33825fe1f584SPeter Brune   PetscFunctionReturn(0);
33835fe1f584SPeter Brune }
33845fe1f584SPeter Brune 
33859a64c4a8SMatthew G. Knepley /*@
33869a64c4a8SMatthew G. Knepley     DMSetCoarsenLevel - Sets the number of coarsenings that have generated this DM.
33879a64c4a8SMatthew G. Knepley 
33889a64c4a8SMatthew G. Knepley     Not Collective
33899a64c4a8SMatthew G. Knepley 
33909a64c4a8SMatthew G. Knepley     Input Parameters:
33919a64c4a8SMatthew G. Knepley +   dm - the DM object
33929a64c4a8SMatthew G. Knepley -   level - number of coarsenings
33939a64c4a8SMatthew G. Knepley 
33949a64c4a8SMatthew G. Knepley     Level: developer
33959a64c4a8SMatthew G. Knepley 
33969a64c4a8SMatthew G. Knepley .seealso DMCoarsen(), DMGetCoarsenLevel(), DMGetRefineLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
33979a64c4a8SMatthew G. Knepley @*/
33989a64c4a8SMatthew G. Knepley PetscErrorCode DMSetCoarsenLevel(DM dm,PetscInt level)
33999a64c4a8SMatthew G. Knepley {
34009a64c4a8SMatthew G. Knepley   PetscFunctionBegin;
34019a64c4a8SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
34029a64c4a8SMatthew G. Knepley   dm->leveldown = level;
34039a64c4a8SMatthew G. Knepley   PetscFunctionReturn(0);
34049a64c4a8SMatthew G. Knepley }
34059a64c4a8SMatthew G. Knepley 
340647c6ae99SBarry Smith /*@C
340747c6ae99SBarry Smith     DMRefineHierarchy - Refines a DM object, all levels at once
340847c6ae99SBarry Smith 
3409d083f849SBarry Smith     Collective on dm
341047c6ae99SBarry Smith 
341147c6ae99SBarry Smith     Input Parameter:
341247c6ae99SBarry Smith +   dm - the DM object
341347c6ae99SBarry Smith -   nlevels - the number of levels of refinement
341447c6ae99SBarry Smith 
341547c6ae99SBarry Smith     Output Parameter:
341647c6ae99SBarry Smith .   dmf - the refined DM hierarchy
341747c6ae99SBarry Smith 
341847c6ae99SBarry Smith     Level: developer
341947c6ae99SBarry Smith 
3420e727c939SJed Brown .seealso DMCoarsenHierarchy(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
342147c6ae99SBarry Smith 
342247c6ae99SBarry Smith @*/
34237087cfbeSBarry Smith PetscErrorCode  DMRefineHierarchy(DM dm,PetscInt nlevels,DM dmf[])
342447c6ae99SBarry Smith {
342547c6ae99SBarry Smith   PetscErrorCode ierr;
342647c6ae99SBarry Smith 
342747c6ae99SBarry Smith   PetscFunctionBegin;
3428171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3429ce94432eSBarry Smith   if (nlevels < 0) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_OUTOFRANGE,"nlevels cannot be negative");
343047c6ae99SBarry Smith   if (nlevels == 0) PetscFunctionReturn(0);
3431b9d85ea2SLisandro Dalcin   PetscValidPointer(dmf,3);
343247c6ae99SBarry Smith   if (dm->ops->refinehierarchy) {
343347c6ae99SBarry Smith     ierr = (*dm->ops->refinehierarchy)(dm,nlevels,dmf);CHKERRQ(ierr);
343447c6ae99SBarry Smith   } else if (dm->ops->refine) {
343547c6ae99SBarry Smith     PetscInt i;
343647c6ae99SBarry Smith 
3437ce94432eSBarry Smith     ierr = DMRefine(dm,PetscObjectComm((PetscObject)dm),&dmf[0]);CHKERRQ(ierr);
343847c6ae99SBarry Smith     for (i=1; i<nlevels; i++) {
3439ce94432eSBarry Smith       ierr = DMRefine(dmf[i-1],PetscObjectComm((PetscObject)dm),&dmf[i]);CHKERRQ(ierr);
344047c6ae99SBarry Smith     }
3441ce94432eSBarry Smith   } else SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"No RefineHierarchy for this DM yet");
344247c6ae99SBarry Smith   PetscFunctionReturn(0);
344347c6ae99SBarry Smith }
344447c6ae99SBarry Smith 
344547c6ae99SBarry Smith /*@C
344647c6ae99SBarry Smith     DMCoarsenHierarchy - Coarsens a DM object, all levels at once
344747c6ae99SBarry Smith 
3448d083f849SBarry Smith     Collective on dm
344947c6ae99SBarry Smith 
345047c6ae99SBarry Smith     Input Parameter:
345147c6ae99SBarry Smith +   dm - the DM object
345247c6ae99SBarry Smith -   nlevels - the number of levels of coarsening
345347c6ae99SBarry Smith 
345447c6ae99SBarry Smith     Output Parameter:
345547c6ae99SBarry Smith .   dmc - the coarsened DM hierarchy
345647c6ae99SBarry Smith 
345747c6ae99SBarry Smith     Level: developer
345847c6ae99SBarry Smith 
3459e727c939SJed Brown .seealso DMRefineHierarchy(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
346047c6ae99SBarry Smith 
346147c6ae99SBarry Smith @*/
34627087cfbeSBarry Smith PetscErrorCode  DMCoarsenHierarchy(DM dm, PetscInt nlevels, DM dmc[])
346347c6ae99SBarry Smith {
346447c6ae99SBarry Smith   PetscErrorCode ierr;
346547c6ae99SBarry Smith 
346647c6ae99SBarry Smith   PetscFunctionBegin;
3467171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3468ce94432eSBarry Smith   if (nlevels < 0) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_OUTOFRANGE,"nlevels cannot be negative");
346947c6ae99SBarry Smith   if (nlevels == 0) PetscFunctionReturn(0);
347047c6ae99SBarry Smith   PetscValidPointer(dmc,3);
347147c6ae99SBarry Smith   if (dm->ops->coarsenhierarchy) {
347247c6ae99SBarry Smith     ierr = (*dm->ops->coarsenhierarchy)(dm, nlevels, dmc);CHKERRQ(ierr);
347347c6ae99SBarry Smith   } else if (dm->ops->coarsen) {
347447c6ae99SBarry Smith     PetscInt i;
347547c6ae99SBarry Smith 
3476ce94432eSBarry Smith     ierr = DMCoarsen(dm,PetscObjectComm((PetscObject)dm),&dmc[0]);CHKERRQ(ierr);
347747c6ae99SBarry Smith     for (i=1; i<nlevels; i++) {
3478ce94432eSBarry Smith       ierr = DMCoarsen(dmc[i-1],PetscObjectComm((PetscObject)dm),&dmc[i]);CHKERRQ(ierr);
347947c6ae99SBarry Smith     }
3480ce94432eSBarry Smith   } else SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"No CoarsenHierarchy for this DM yet");
348147c6ae99SBarry Smith   PetscFunctionReturn(0);
348247c6ae99SBarry Smith }
348347c6ae99SBarry Smith 
34841a266240SBarry Smith /*@C
34851a266240SBarry Smith     DMSetApplicationContextDestroy - Sets a user function that will be called to destroy the application context when the DM is destroyed
34861a266240SBarry Smith 
34871a266240SBarry Smith     Not Collective
34881a266240SBarry Smith 
34891a266240SBarry Smith     Input Parameters:
34901a266240SBarry Smith +   dm - the DM object
34911a266240SBarry Smith -   destroy - the destroy function
34921a266240SBarry Smith 
34931a266240SBarry Smith     Level: intermediate
34941a266240SBarry Smith 
3495e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
34961a266240SBarry Smith 
3497f07f9ceaSJed Brown @*/
34981a266240SBarry Smith PetscErrorCode  DMSetApplicationContextDestroy(DM dm,PetscErrorCode (*destroy)(void**))
34991a266240SBarry Smith {
35001a266240SBarry Smith   PetscFunctionBegin;
3501171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
35021a266240SBarry Smith   dm->ctxdestroy = destroy;
35031a266240SBarry Smith   PetscFunctionReturn(0);
35041a266240SBarry Smith }
35051a266240SBarry Smith 
3506b07ff414SBarry Smith /*@
35071b2093e4SBarry Smith     DMSetApplicationContext - Set a user context into a DM object
350847c6ae99SBarry Smith 
350947c6ae99SBarry Smith     Not Collective
351047c6ae99SBarry Smith 
351147c6ae99SBarry Smith     Input Parameters:
351247c6ae99SBarry Smith +   dm - the DM object
351347c6ae99SBarry Smith -   ctx - the user context
351447c6ae99SBarry Smith 
351547c6ae99SBarry Smith     Level: intermediate
351647c6ae99SBarry Smith 
3517e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
351847c6ae99SBarry Smith 
351947c6ae99SBarry Smith @*/
35201b2093e4SBarry Smith PetscErrorCode  DMSetApplicationContext(DM dm,void *ctx)
352147c6ae99SBarry Smith {
352247c6ae99SBarry Smith   PetscFunctionBegin;
3523171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
352447c6ae99SBarry Smith   dm->ctx = ctx;
352547c6ae99SBarry Smith   PetscFunctionReturn(0);
352647c6ae99SBarry Smith }
352747c6ae99SBarry Smith 
352847c6ae99SBarry Smith /*@
35291b2093e4SBarry Smith     DMGetApplicationContext - Gets a user context from a DM object
353047c6ae99SBarry Smith 
353147c6ae99SBarry Smith     Not Collective
353247c6ae99SBarry Smith 
353347c6ae99SBarry Smith     Input Parameter:
353447c6ae99SBarry Smith .   dm - the DM object
353547c6ae99SBarry Smith 
353647c6ae99SBarry Smith     Output Parameter:
353747c6ae99SBarry Smith .   ctx - the user context
353847c6ae99SBarry Smith 
353947c6ae99SBarry Smith     Level: intermediate
354047c6ae99SBarry Smith 
3541e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
354247c6ae99SBarry Smith 
354347c6ae99SBarry Smith @*/
35441b2093e4SBarry Smith PetscErrorCode  DMGetApplicationContext(DM dm,void *ctx)
354547c6ae99SBarry Smith {
354647c6ae99SBarry Smith   PetscFunctionBegin;
3547171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
35481b2093e4SBarry Smith   *(void**)ctx = dm->ctx;
354947c6ae99SBarry Smith   PetscFunctionReturn(0);
355047c6ae99SBarry Smith }
355147c6ae99SBarry Smith 
355208da532bSDmitry Karpeev /*@C
3553df3898eeSBarry Smith     DMSetVariableBounds - sets a function to compute the lower and upper bound vectors for SNESVI.
355408da532bSDmitry Karpeev 
3555d083f849SBarry Smith     Logically Collective on dm
355608da532bSDmitry Karpeev 
355708da532bSDmitry Karpeev     Input Parameter:
355808da532bSDmitry Karpeev +   dm - the DM object
35590298fd71SBarry Smith -   f - the function that computes variable bounds used by SNESVI (use NULL to cancel a previous function that was set)
356008da532bSDmitry Karpeev 
356108da532bSDmitry Karpeev     Level: intermediate
356208da532bSDmitry Karpeev 
3563835c3ec7SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext(),
356408da532bSDmitry Karpeev          DMSetJacobian()
356508da532bSDmitry Karpeev 
356608da532bSDmitry Karpeev @*/
356708da532bSDmitry Karpeev PetscErrorCode DMSetVariableBounds(DM dm,PetscErrorCode (*f)(DM,Vec,Vec))
356808da532bSDmitry Karpeev {
356908da532bSDmitry Karpeev   PetscFunctionBegin;
35705a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
357108da532bSDmitry Karpeev   dm->ops->computevariablebounds = f;
357208da532bSDmitry Karpeev   PetscFunctionReturn(0);
357308da532bSDmitry Karpeev }
357408da532bSDmitry Karpeev 
357508da532bSDmitry Karpeev /*@
357608da532bSDmitry Karpeev     DMHasVariableBounds - does the DM object have a variable bounds function?
357708da532bSDmitry Karpeev 
357808da532bSDmitry Karpeev     Not Collective
357908da532bSDmitry Karpeev 
358008da532bSDmitry Karpeev     Input Parameter:
358108da532bSDmitry Karpeev .   dm - the DM object to destroy
358208da532bSDmitry Karpeev 
358308da532bSDmitry Karpeev     Output Parameter:
358408da532bSDmitry Karpeev .   flg - PETSC_TRUE if the variable bounds function exists
358508da532bSDmitry Karpeev 
358608da532bSDmitry Karpeev     Level: developer
358708da532bSDmitry Karpeev 
358874e1e8c1SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
358908da532bSDmitry Karpeev 
359008da532bSDmitry Karpeev @*/
359108da532bSDmitry Karpeev PetscErrorCode DMHasVariableBounds(DM dm,PetscBool *flg)
359208da532bSDmitry Karpeev {
359308da532bSDmitry Karpeev   PetscFunctionBegin;
35945a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3595534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
359608da532bSDmitry Karpeev   *flg =  (dm->ops->computevariablebounds) ? PETSC_TRUE : PETSC_FALSE;
359708da532bSDmitry Karpeev   PetscFunctionReturn(0);
359808da532bSDmitry Karpeev }
359908da532bSDmitry Karpeev 
360008da532bSDmitry Karpeev /*@C
360108da532bSDmitry Karpeev     DMComputeVariableBounds - compute variable bounds used by SNESVI.
360208da532bSDmitry Karpeev 
3603d083f849SBarry Smith     Logically Collective on dm
360408da532bSDmitry Karpeev 
360508da532bSDmitry Karpeev     Input Parameters:
3606907376e6SBarry Smith .   dm - the DM object
360708da532bSDmitry Karpeev 
360808da532bSDmitry Karpeev     Output parameters:
360908da532bSDmitry Karpeev +   xl - lower bound
361008da532bSDmitry Karpeev -   xu - upper bound
361108da532bSDmitry Karpeev 
3612907376e6SBarry Smith     Level: advanced
3613907376e6SBarry Smith 
361495452b02SPatrick Sanan     Notes:
361595452b02SPatrick Sanan     This is generally not called by users. It calls the function provided by the user with DMSetVariableBounds()
361608da532bSDmitry Karpeev 
361774e1e8c1SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
361808da532bSDmitry Karpeev 
361908da532bSDmitry Karpeev @*/
362008da532bSDmitry Karpeev PetscErrorCode DMComputeVariableBounds(DM dm, Vec xl, Vec xu)
362108da532bSDmitry Karpeev {
362208da532bSDmitry Karpeev   PetscErrorCode ierr;
36235fd66863SKarl Rupp 
362408da532bSDmitry Karpeev   PetscFunctionBegin;
36255a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
362608da532bSDmitry Karpeev   PetscValidHeaderSpecific(xl,VEC_CLASSID,2);
36275a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(xu,VEC_CLASSID,3);
3628b9d85ea2SLisandro Dalcin   if (!dm->ops->computevariablebounds) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeVariableBounds",((PetscObject)dm)->type_name);
362908da532bSDmitry Karpeev   ierr = (*dm->ops->computevariablebounds)(dm, xl,xu);CHKERRQ(ierr);
363008da532bSDmitry Karpeev   PetscFunctionReturn(0);
363108da532bSDmitry Karpeev }
363208da532bSDmitry Karpeev 
3633b0ae01b7SPeter Brune /*@
3634b0ae01b7SPeter Brune     DMHasColoring - does the DM object have a method of providing a coloring?
3635b0ae01b7SPeter Brune 
3636b0ae01b7SPeter Brune     Not Collective
3637b0ae01b7SPeter Brune 
3638b0ae01b7SPeter Brune     Input Parameter:
3639b0ae01b7SPeter Brune .   dm - the DM object
3640b0ae01b7SPeter Brune 
3641b0ae01b7SPeter Brune     Output Parameter:
3642b0ae01b7SPeter Brune .   flg - PETSC_TRUE if the DM has facilities for DMCreateColoring().
3643b0ae01b7SPeter Brune 
3644b0ae01b7SPeter Brune     Level: developer
3645b0ae01b7SPeter Brune 
36461565f0a7SPatrick Sanan .seealso DMCreateColoring()
3647b0ae01b7SPeter Brune 
3648b0ae01b7SPeter Brune @*/
3649b0ae01b7SPeter Brune PetscErrorCode DMHasColoring(DM dm,PetscBool *flg)
3650b0ae01b7SPeter Brune {
3651b0ae01b7SPeter Brune   PetscFunctionBegin;
36525a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3653534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
3654b0ae01b7SPeter Brune   *flg =  (dm->ops->getcoloring) ? PETSC_TRUE : PETSC_FALSE;
3655b0ae01b7SPeter Brune   PetscFunctionReturn(0);
3656b0ae01b7SPeter Brune }
3657b0ae01b7SPeter Brune 
36583ad4599aSBarry Smith /*@
36593ad4599aSBarry Smith     DMHasCreateRestriction - does the DM object have a method of providing a restriction?
36603ad4599aSBarry Smith 
36613ad4599aSBarry Smith     Not Collective
36623ad4599aSBarry Smith 
36633ad4599aSBarry Smith     Input Parameter:
36643ad4599aSBarry Smith .   dm - the DM object
36653ad4599aSBarry Smith 
36663ad4599aSBarry Smith     Output Parameter:
36673ad4599aSBarry Smith .   flg - PETSC_TRUE if the DM has facilities for DMCreateRestriction().
36683ad4599aSBarry Smith 
36693ad4599aSBarry Smith     Level: developer
36703ad4599aSBarry Smith 
36711565f0a7SPatrick Sanan .seealso DMCreateRestriction()
36723ad4599aSBarry Smith 
36733ad4599aSBarry Smith @*/
36743ad4599aSBarry Smith PetscErrorCode DMHasCreateRestriction(DM dm,PetscBool *flg)
36753ad4599aSBarry Smith {
36763ad4599aSBarry Smith   PetscFunctionBegin;
36775a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3678534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
36793ad4599aSBarry Smith   *flg =  (dm->ops->createrestriction) ? PETSC_TRUE : PETSC_FALSE;
36803ad4599aSBarry Smith   PetscFunctionReturn(0);
36813ad4599aSBarry Smith }
36823ad4599aSBarry Smith 
3683a7058e45SLawrence Mitchell /*@
3684a7058e45SLawrence Mitchell     DMHasCreateInjection - does the DM object have a method of providing an injection?
3685a7058e45SLawrence Mitchell 
3686a7058e45SLawrence Mitchell     Not Collective
3687a7058e45SLawrence Mitchell 
3688a7058e45SLawrence Mitchell     Input Parameter:
3689a7058e45SLawrence Mitchell .   dm - the DM object
3690a7058e45SLawrence Mitchell 
3691a7058e45SLawrence Mitchell     Output Parameter:
3692a7058e45SLawrence Mitchell .   flg - PETSC_TRUE if the DM has facilities for DMCreateInjection().
3693a7058e45SLawrence Mitchell 
3694a7058e45SLawrence Mitchell     Level: developer
3695a7058e45SLawrence Mitchell 
36961565f0a7SPatrick Sanan .seealso DMCreateInjection()
3697a7058e45SLawrence Mitchell 
3698a7058e45SLawrence Mitchell @*/
3699a7058e45SLawrence Mitchell PetscErrorCode DMHasCreateInjection(DM dm,PetscBool *flg)
3700a7058e45SLawrence Mitchell {
37014a7a4c06SLawrence Mitchell   PetscErrorCode ierr;
37025a84ad33SLisandro Dalcin 
3703a7058e45SLawrence Mitchell   PetscFunctionBegin;
37045a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3705534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
37065a84ad33SLisandro Dalcin   if (dm->ops->hascreateinjection) {
37074a7a4c06SLawrence Mitchell     ierr = (*dm->ops->hascreateinjection)(dm,flg);CHKERRQ(ierr);
37085a84ad33SLisandro Dalcin   } else {
37095a84ad33SLisandro Dalcin     *flg = (dm->ops->createinjection) ? PETSC_TRUE : PETSC_FALSE;
37105a84ad33SLisandro Dalcin   }
3711a7058e45SLawrence Mitchell   PetscFunctionReturn(0);
3712a7058e45SLawrence Mitchell }
3713a7058e45SLawrence Mitchell 
37140298fd71SBarry Smith PetscFunctionList DMList              = NULL;
3715264ace61SBarry Smith PetscBool         DMRegisterAllCalled = PETSC_FALSE;
3716264ace61SBarry Smith 
3717264ace61SBarry Smith /*@C
3718264ace61SBarry Smith   DMSetType - Builds a DM, for a particular DM implementation.
3719264ace61SBarry Smith 
3720d083f849SBarry Smith   Collective on dm
3721264ace61SBarry Smith 
3722264ace61SBarry Smith   Input Parameters:
3723264ace61SBarry Smith + dm     - The DM object
3724264ace61SBarry Smith - method - The name of the DM type
3725264ace61SBarry Smith 
3726264ace61SBarry Smith   Options Database Key:
3727264ace61SBarry Smith . -dm_type <type> - Sets the DM type; use -help for a list of available types
3728264ace61SBarry Smith 
3729264ace61SBarry Smith   Notes:
3730e1589f56SBarry Smith   See "petsc/include/petscdm.h" for available DM types (for instance, DM1D, DM2D, or DM3D).
3731264ace61SBarry Smith 
3732264ace61SBarry Smith   Level: intermediate
3733264ace61SBarry Smith 
3734264ace61SBarry Smith .seealso: DMGetType(), DMCreate()
3735264ace61SBarry Smith @*/
373619fd82e9SBarry Smith PetscErrorCode  DMSetType(DM dm, DMType method)
3737264ace61SBarry Smith {
3738264ace61SBarry Smith   PetscErrorCode (*r)(DM);
3739264ace61SBarry Smith   PetscBool      match;
3740264ace61SBarry Smith   PetscErrorCode ierr;
3741264ace61SBarry Smith 
3742264ace61SBarry Smith   PetscFunctionBegin;
3743264ace61SBarry Smith   PetscValidHeaderSpecific(dm, DM_CLASSID,1);
3744251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject) dm, method, &match);CHKERRQ(ierr);
3745264ace61SBarry Smith   if (match) PetscFunctionReturn(0);
3746264ace61SBarry Smith 
37470f51fdf8SToby Isaac   ierr = DMRegisterAll();CHKERRQ(ierr);
37481c9cd337SJed Brown   ierr = PetscFunctionListFind(DMList,method,&r);CHKERRQ(ierr);
3749ce94432eSBarry Smith   if (!r) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_UNKNOWN_TYPE, "Unknown DM type: %s", method);
3750264ace61SBarry Smith 
3751264ace61SBarry Smith   if (dm->ops->destroy) {
3752264ace61SBarry Smith     ierr = (*dm->ops->destroy)(dm);CHKERRQ(ierr);
3753264ace61SBarry Smith   }
3754d57f96a3SLisandro Dalcin   ierr = PetscMemzero(dm->ops,sizeof(*dm->ops));CHKERRQ(ierr);
3755264ace61SBarry Smith   ierr = PetscObjectChangeTypeName((PetscObject)dm,method);CHKERRQ(ierr);
3756d57f96a3SLisandro Dalcin   ierr = (*r)(dm);CHKERRQ(ierr);
3757264ace61SBarry Smith   PetscFunctionReturn(0);
3758264ace61SBarry Smith }
3759264ace61SBarry Smith 
3760264ace61SBarry Smith /*@C
3761264ace61SBarry Smith   DMGetType - Gets the DM type name (as a string) from the DM.
3762264ace61SBarry Smith 
3763264ace61SBarry Smith   Not Collective
3764264ace61SBarry Smith 
3765264ace61SBarry Smith   Input Parameter:
3766264ace61SBarry Smith . dm  - The DM
3767264ace61SBarry Smith 
3768264ace61SBarry Smith   Output Parameter:
3769264ace61SBarry Smith . type - The DM type name
3770264ace61SBarry Smith 
3771264ace61SBarry Smith   Level: intermediate
3772264ace61SBarry Smith 
3773264ace61SBarry Smith .seealso: DMSetType(), DMCreate()
3774264ace61SBarry Smith @*/
377519fd82e9SBarry Smith PetscErrorCode  DMGetType(DM dm, DMType *type)
3776264ace61SBarry Smith {
3777264ace61SBarry Smith   PetscErrorCode ierr;
3778264ace61SBarry Smith 
3779264ace61SBarry Smith   PetscFunctionBegin;
3780264ace61SBarry Smith   PetscValidHeaderSpecific(dm, DM_CLASSID,1);
3781c959eef4SJed Brown   PetscValidPointer(type,2);
3782607a6623SBarry Smith   ierr = DMRegisterAll();CHKERRQ(ierr);
3783264ace61SBarry Smith   *type = ((PetscObject)dm)->type_name;
3784264ace61SBarry Smith   PetscFunctionReturn(0);
3785264ace61SBarry Smith }
3786264ace61SBarry Smith 
378767a56275SMatthew G Knepley /*@C
378867a56275SMatthew G Knepley   DMConvert - Converts a DM to another DM, either of the same or different type.
378967a56275SMatthew G Knepley 
3790d083f849SBarry Smith   Collective on dm
379167a56275SMatthew G Knepley 
379267a56275SMatthew G Knepley   Input Parameters:
379367a56275SMatthew G Knepley + dm - the DM
379467a56275SMatthew G Knepley - newtype - new DM type (use "same" for the same type)
379567a56275SMatthew G Knepley 
379667a56275SMatthew G Knepley   Output Parameter:
379767a56275SMatthew G Knepley . M - pointer to new DM
379867a56275SMatthew G Knepley 
379967a56275SMatthew G Knepley   Notes:
380067a56275SMatthew G Knepley   Cannot be used to convert a sequential DM to parallel or parallel to sequential,
380167a56275SMatthew G Knepley   the MPI communicator of the generated DM is always the same as the communicator
380267a56275SMatthew G Knepley   of the input DM.
380367a56275SMatthew G Knepley 
380467a56275SMatthew G Knepley   Level: intermediate
380567a56275SMatthew G Knepley 
380667a56275SMatthew G Knepley .seealso: DMCreate()
380767a56275SMatthew G Knepley @*/
380819fd82e9SBarry Smith PetscErrorCode DMConvert(DM dm, DMType newtype, DM *M)
380967a56275SMatthew G Knepley {
381067a56275SMatthew G Knepley   DM             B;
381167a56275SMatthew G Knepley   char           convname[256];
3812c067b6caSMatthew G. Knepley   PetscBool      sametype/*, issame */;
381367a56275SMatthew G Knepley   PetscErrorCode ierr;
381467a56275SMatthew G Knepley 
381567a56275SMatthew G Knepley   PetscFunctionBegin;
381667a56275SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
381767a56275SMatthew G Knepley   PetscValidType(dm,1);
381867a56275SMatthew G Knepley   PetscValidPointer(M,3);
3819251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject) dm, newtype, &sametype);CHKERRQ(ierr);
3820c067b6caSMatthew G. Knepley   /* ierr = PetscStrcmp(newtype, "same", &issame);CHKERRQ(ierr); */
3821c067b6caSMatthew G. Knepley   if (sametype) {
3822c067b6caSMatthew G. Knepley     *M   = dm;
3823c067b6caSMatthew G. Knepley     ierr = PetscObjectReference((PetscObject) dm);CHKERRQ(ierr);
3824c067b6caSMatthew G. Knepley     PetscFunctionReturn(0);
3825c067b6caSMatthew G. Knepley   } else {
38260298fd71SBarry Smith     PetscErrorCode (*conv)(DM, DMType, DM*) = NULL;
382767a56275SMatthew G Knepley 
382867a56275SMatthew G Knepley     /*
382967a56275SMatthew G Knepley        Order of precedence:
383067a56275SMatthew G Knepley        1) See if a specialized converter is known to the current DM.
383167a56275SMatthew G Knepley        2) See if a specialized converter is known to the desired DM class.
383267a56275SMatthew G Knepley        3) See if a good general converter is registered for the desired class
383367a56275SMatthew G Knepley        4) See if a good general converter is known for the current matrix.
383467a56275SMatthew G Knepley        5) Use a really basic converter.
383567a56275SMatthew G Knepley     */
383667a56275SMatthew G Knepley 
383767a56275SMatthew G Knepley     /* 1) See if a specialized converter is known to the current DM and the desired class */
3838a126751eSBarry Smith     ierr = PetscStrncpy(convname,"DMConvert_",sizeof(convname));CHKERRQ(ierr);
3839a126751eSBarry Smith     ierr = PetscStrlcat(convname,((PetscObject) dm)->type_name,sizeof(convname));CHKERRQ(ierr);
3840a126751eSBarry Smith     ierr = PetscStrlcat(convname,"_",sizeof(convname));CHKERRQ(ierr);
3841a126751eSBarry Smith     ierr = PetscStrlcat(convname,newtype,sizeof(convname));CHKERRQ(ierr);
3842a126751eSBarry Smith     ierr = PetscStrlcat(convname,"_C",sizeof(convname));CHKERRQ(ierr);
38430005d66cSJed Brown     ierr = PetscObjectQueryFunction((PetscObject)dm,convname,&conv);CHKERRQ(ierr);
384467a56275SMatthew G Knepley     if (conv) goto foundconv;
384567a56275SMatthew G Knepley 
384667a56275SMatthew G Knepley     /* 2)  See if a specialized converter is known to the desired DM class. */
384782f516ccSBarry Smith     ierr = DMCreate(PetscObjectComm((PetscObject)dm), &B);CHKERRQ(ierr);
384867a56275SMatthew G Knepley     ierr = DMSetType(B, newtype);CHKERRQ(ierr);
3849a126751eSBarry Smith     ierr = PetscStrncpy(convname,"DMConvert_",sizeof(convname));CHKERRQ(ierr);
3850a126751eSBarry Smith     ierr = PetscStrlcat(convname,((PetscObject) dm)->type_name,sizeof(convname));CHKERRQ(ierr);
3851a126751eSBarry Smith     ierr = PetscStrlcat(convname,"_",sizeof(convname));CHKERRQ(ierr);
3852a126751eSBarry Smith     ierr = PetscStrlcat(convname,newtype,sizeof(convname));CHKERRQ(ierr);
3853a126751eSBarry Smith     ierr = PetscStrlcat(convname,"_C",sizeof(convname));CHKERRQ(ierr);
38540005d66cSJed Brown     ierr = PetscObjectQueryFunction((PetscObject)B,convname,&conv);CHKERRQ(ierr);
385567a56275SMatthew G Knepley     if (conv) {
3856fcfd50ebSBarry Smith       ierr = DMDestroy(&B);CHKERRQ(ierr);
385767a56275SMatthew G Knepley       goto foundconv;
385867a56275SMatthew G Knepley     }
385967a56275SMatthew G Knepley 
386067a56275SMatthew G Knepley #if 0
386167a56275SMatthew G Knepley     /* 3) See if a good general converter is registered for the desired class */
386267a56275SMatthew G Knepley     conv = B->ops->convertfrom;
3863fcfd50ebSBarry Smith     ierr = DMDestroy(&B);CHKERRQ(ierr);
386467a56275SMatthew G Knepley     if (conv) goto foundconv;
386567a56275SMatthew G Knepley 
386667a56275SMatthew G Knepley     /* 4) See if a good general converter is known for the current matrix */
386767a56275SMatthew G Knepley     if (dm->ops->convert) {
386867a56275SMatthew G Knepley       conv = dm->ops->convert;
386967a56275SMatthew G Knepley     }
387067a56275SMatthew G Knepley     if (conv) goto foundconv;
387167a56275SMatthew G Knepley #endif
387267a56275SMatthew G Knepley 
387367a56275SMatthew G Knepley     /* 5) Use a really basic converter. */
387482f516ccSBarry Smith     SETERRQ2(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "No conversion possible between DM types %s and %s", ((PetscObject) dm)->type_name, newtype);
387567a56275SMatthew G Knepley 
387667a56275SMatthew G Knepley foundconv:
387767a56275SMatthew G Knepley     ierr = PetscLogEventBegin(DM_Convert,dm,0,0,0);CHKERRQ(ierr);
387867a56275SMatthew G Knepley     ierr = (*conv)(dm,newtype,M);CHKERRQ(ierr);
387912fa691eSMatthew G. Knepley     /* Things that are independent of DM type: We should consult DMClone() here */
388090b157c4SStefano Zampini     {
388190b157c4SStefano Zampini       PetscBool             isper;
388212fa691eSMatthew G. Knepley       const PetscReal      *maxCell, *L;
388312fa691eSMatthew G. Knepley       const DMBoundaryType *bd;
388490b157c4SStefano Zampini       ierr = DMGetPeriodicity(dm, &isper, &maxCell, &L, &bd);CHKERRQ(ierr);
388590b157c4SStefano Zampini       ierr = DMSetPeriodicity(*M, isper, maxCell,  L,  bd);CHKERRQ(ierr);
3886c8a6034eSMark       (*M)->prealloc_only = dm->prealloc_only;
3887a587d139SMark       ierr = PetscFree((*M)->vectype);CHKERRQ(ierr);
3888a587d139SMark       ierr = PetscStrallocpy(dm->vectype,(char**)&(*M)->vectype);CHKERRQ(ierr);
3889a587d139SMark       ierr = PetscFree((*M)->mattype);CHKERRQ(ierr);
3890a587d139SMark       ierr = PetscStrallocpy(dm->mattype,(char**)&(*M)->mattype);CHKERRQ(ierr);
389112fa691eSMatthew G. Knepley     }
389267a56275SMatthew G Knepley     ierr = PetscLogEventEnd(DM_Convert,dm,0,0,0);CHKERRQ(ierr);
389367a56275SMatthew G Knepley   }
389467a56275SMatthew G Knepley   ierr = PetscObjectStateIncrease((PetscObject) *M);CHKERRQ(ierr);
389567a56275SMatthew G Knepley   PetscFunctionReturn(0);
389667a56275SMatthew G Knepley }
3897264ace61SBarry Smith 
3898264ace61SBarry Smith /*--------------------------------------------------------------------------------------------------------------------*/
3899264ace61SBarry Smith 
3900264ace61SBarry Smith /*@C
39011c84c290SBarry Smith   DMRegister -  Adds a new DM component implementation
39021c84c290SBarry Smith 
39031c84c290SBarry Smith   Not Collective
39041c84c290SBarry Smith 
39051c84c290SBarry Smith   Input Parameters:
39061c84c290SBarry Smith + name        - The name of a new user-defined creation routine
39071c84c290SBarry Smith - create_func - The creation routine itself
39081c84c290SBarry Smith 
39091c84c290SBarry Smith   Notes:
39101c84c290SBarry Smith   DMRegister() may be called multiple times to add several user-defined DMs
39111c84c290SBarry Smith 
39121c84c290SBarry Smith   Sample usage:
39131c84c290SBarry Smith .vb
3914bdf89e91SBarry Smith     DMRegister("my_da", MyDMCreate);
39151c84c290SBarry Smith .ve
39161c84c290SBarry Smith 
39171c84c290SBarry Smith   Then, your DM type can be chosen with the procedural interface via
39181c84c290SBarry Smith .vb
39191c84c290SBarry Smith     DMCreate(MPI_Comm, DM *);
39201c84c290SBarry Smith     DMSetType(DM,"my_da");
39211c84c290SBarry Smith .ve
39221c84c290SBarry Smith    or at runtime via the option
39231c84c290SBarry Smith .vb
39241c84c290SBarry Smith     -da_type my_da
39251c84c290SBarry Smith .ve
3926264ace61SBarry Smith 
3927264ace61SBarry Smith   Level: advanced
39281c84c290SBarry Smith 
3929bdf89e91SBarry Smith .seealso: DMRegisterAll(), DMRegisterDestroy()
39301c84c290SBarry Smith 
3931264ace61SBarry Smith @*/
3932bdf89e91SBarry Smith PetscErrorCode  DMRegister(const char sname[],PetscErrorCode (*function)(DM))
3933264ace61SBarry Smith {
3934264ace61SBarry Smith   PetscErrorCode ierr;
3935264ace61SBarry Smith 
3936264ace61SBarry Smith   PetscFunctionBegin;
39371d36bdfdSBarry Smith   ierr = DMInitializePackage();CHKERRQ(ierr);
3938a240a19fSJed Brown   ierr = PetscFunctionListAdd(&DMList,sname,function);CHKERRQ(ierr);
3939264ace61SBarry Smith   PetscFunctionReturn(0);
3940264ace61SBarry Smith }
3941264ace61SBarry Smith 
3942b859378eSBarry Smith /*@C
394355849f57SBarry Smith   DMLoad - Loads a DM that has been stored in binary  with DMView().
3944b859378eSBarry Smith 
3945d083f849SBarry Smith   Collective on viewer
3946b859378eSBarry Smith 
3947b859378eSBarry Smith   Input Parameters:
3948b859378eSBarry Smith + newdm - the newly loaded DM, this needs to have been created with DMCreate() or
3949b859378eSBarry Smith            some related function before a call to DMLoad().
3950b859378eSBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen() or
3951b859378eSBarry Smith            HDF5 file viewer, obtained from PetscViewerHDF5Open()
3952b859378eSBarry Smith 
3953b859378eSBarry Smith    Level: intermediate
3954b859378eSBarry Smith 
3955b859378eSBarry Smith   Notes:
395655849f57SBarry Smith    The type is determined by the data in the file, any type set into the DM before this call is ignored.
3957b859378eSBarry Smith 
3958b859378eSBarry Smith   Notes for advanced users:
3959b859378eSBarry Smith   Most users should not need to know the details of the binary storage
3960b859378eSBarry Smith   format, since DMLoad() and DMView() completely hide these details.
3961b859378eSBarry Smith   But for anyone who's interested, the standard binary matrix storage
3962b859378eSBarry Smith   format is
3963b859378eSBarry Smith .vb
3964b859378eSBarry Smith      has not yet been determined
3965b859378eSBarry Smith .ve
3966b859378eSBarry Smith 
3967b859378eSBarry Smith .seealso: PetscViewerBinaryOpen(), DMView(), MatLoad(), VecLoad()
3968b859378eSBarry Smith @*/
3969b859378eSBarry Smith PetscErrorCode  DMLoad(DM newdm, PetscViewer viewer)
3970b859378eSBarry Smith {
39719331c7a4SMatthew G. Knepley   PetscBool      isbinary, ishdf5;
3972b859378eSBarry Smith   PetscErrorCode ierr;
3973b859378eSBarry Smith 
3974b859378eSBarry Smith   PetscFunctionBegin;
3975b859378eSBarry Smith   PetscValidHeaderSpecific(newdm,DM_CLASSID,1);
3976b859378eSBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
3977fb694a9eSVaclav Hapla   ierr = PetscViewerCheckReadable(viewer);CHKERRQ(ierr);
397832c0f0efSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
39799331c7a4SMatthew G. Knepley   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERHDF5,&ishdf5);CHKERRQ(ierr);
398058cd63d5SVaclav Hapla   ierr = PetscLogEventBegin(DM_Load,viewer,0,0,0);CHKERRQ(ierr);
39819331c7a4SMatthew G. Knepley   if (isbinary) {
39829331c7a4SMatthew G. Knepley     PetscInt classid;
39839331c7a4SMatthew G. Knepley     char     type[256];
3984b859378eSBarry Smith 
3985060da220SMatthew G. Knepley     ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr);
39869200755eSBarry Smith     if (classid != DM_FILE_CLASSID) SETERRQ1(PetscObjectComm((PetscObject)newdm),PETSC_ERR_ARG_WRONG,"Not DM next in file, classid found %d",(int)classid);
3987060da220SMatthew G. Knepley     ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr);
398832c0f0efSBarry Smith     ierr = DMSetType(newdm, type);CHKERRQ(ierr);
39899331c7a4SMatthew G. Knepley     if (newdm->ops->load) {ierr = (*newdm->ops->load)(newdm,viewer);CHKERRQ(ierr);}
39909331c7a4SMatthew G. Knepley   } else if (ishdf5) {
39919331c7a4SMatthew G. Knepley     if (newdm->ops->load) {ierr = (*newdm->ops->load)(newdm,viewer);CHKERRQ(ierr);}
39929331c7a4SMatthew G. Knepley   } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen() or PetscViewerHDF5Open()");
399358cd63d5SVaclav Hapla   ierr = PetscLogEventEnd(DM_Load,viewer,0,0,0);CHKERRQ(ierr);
3994b859378eSBarry Smith   PetscFunctionReturn(0);
3995b859378eSBarry Smith }
3996b859378eSBarry Smith 
3997b2e4378dSMatthew G. Knepley /*@
3998b2e4378dSMatthew G. Knepley   DMGetLocalBoundingBox - Returns the bounding box for the piece of the DM on this process.
3999b2e4378dSMatthew G. Knepley 
4000b2e4378dSMatthew G. Knepley   Not collective
4001b2e4378dSMatthew G. Knepley 
4002b2e4378dSMatthew G. Knepley   Input Parameter:
4003b2e4378dSMatthew G. Knepley . dm - the DM
4004b2e4378dSMatthew G. Knepley 
4005b2e4378dSMatthew G. Knepley   Output Parameters:
4006b2e4378dSMatthew G. Knepley + lmin - local minimum coordinates (length coord dim, optional)
4007b2e4378dSMatthew G. Knepley - lmax - local maximim coordinates (length coord dim, optional)
4008b2e4378dSMatthew G. Knepley 
4009b2e4378dSMatthew G. Knepley   Level: beginner
4010b2e4378dSMatthew G. Knepley 
4011b2e4378dSMatthew G. Knepley   Note: If the DM is a DMDA and has no coordinates, the index bounds are returned instead.
4012b2e4378dSMatthew G. Knepley 
4013b2e4378dSMatthew G. Knepley .seealso: DMGetCoordinates(), DMGetCoordinatesLocal(), DMGetBoundingBox()
4014b2e4378dSMatthew G. Knepley @*/
4015b2e4378dSMatthew G. Knepley PetscErrorCode DMGetLocalBoundingBox(DM dm, PetscReal lmin[], PetscReal lmax[])
4016b2e4378dSMatthew G. Knepley {
4017b2e4378dSMatthew G. Knepley   Vec                coords = NULL;
4018b2e4378dSMatthew G. Knepley   PetscReal          min[3] = {PETSC_MAX_REAL, PETSC_MAX_REAL, PETSC_MAX_REAL};
4019b2e4378dSMatthew G. Knepley   PetscReal          max[3] = {PETSC_MIN_REAL, PETSC_MIN_REAL, PETSC_MIN_REAL};
4020b2e4378dSMatthew G. Knepley   const PetscScalar *local_coords;
4021b2e4378dSMatthew G. Knepley   PetscInt           N, Ni;
4022b2e4378dSMatthew G. Knepley   PetscInt           cdim, i, j;
4023b2e4378dSMatthew G. Knepley   PetscErrorCode     ierr;
4024b2e4378dSMatthew G. Knepley 
4025b2e4378dSMatthew G. Knepley   PetscFunctionBegin;
4026b2e4378dSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4027b2e4378dSMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
4028b2e4378dSMatthew G. Knepley   ierr = DMGetCoordinates(dm, &coords);CHKERRQ(ierr);
4029b2e4378dSMatthew G. Knepley   if (coords) {
4030b2e4378dSMatthew G. Knepley     ierr = VecGetArrayRead(coords, &local_coords);CHKERRQ(ierr);
4031b2e4378dSMatthew G. Knepley     ierr = VecGetLocalSize(coords, &N);CHKERRQ(ierr);
4032b2e4378dSMatthew G. Knepley     Ni   = N/cdim;
4033b2e4378dSMatthew G. Knepley     for (i = 0; i < Ni; ++i) {
4034b2e4378dSMatthew G. Knepley       for (j = 0; j < 3; ++j) {
4035b2e4378dSMatthew G. Knepley         min[j] = j < cdim ? PetscMin(min[j], PetscRealPart(local_coords[i*cdim+j])) : 0;
4036b2e4378dSMatthew G. Knepley         max[j] = j < cdim ? PetscMax(max[j], PetscRealPart(local_coords[i*cdim+j])) : 0;
4037b2e4378dSMatthew G. Knepley       }
4038b2e4378dSMatthew G. Knepley     }
4039b2e4378dSMatthew G. Knepley     ierr = VecRestoreArrayRead(coords, &local_coords);CHKERRQ(ierr);
4040b2e4378dSMatthew G. Knepley   } else {
4041b2e4378dSMatthew G. Knepley     PetscBool isda;
4042b2e4378dSMatthew G. Knepley 
4043b2e4378dSMatthew G. Knepley     ierr = PetscObjectTypeCompare((PetscObject) dm, DMDA, &isda);CHKERRQ(ierr);
4044b2e4378dSMatthew G. Knepley     if (isda) {ierr = DMGetLocalBoundingIndices_DMDA(dm, min, max);CHKERRQ(ierr);}
4045b2e4378dSMatthew G. Knepley   }
4046b2e4378dSMatthew G. Knepley   if (lmin) {ierr = PetscArraycpy(lmin, min, cdim);CHKERRQ(ierr);}
4047b2e4378dSMatthew G. Knepley   if (lmax) {ierr = PetscArraycpy(lmax, max, cdim);CHKERRQ(ierr);}
4048b2e4378dSMatthew G. Knepley   PetscFunctionReturn(0);
4049b2e4378dSMatthew G. Knepley }
4050b2e4378dSMatthew G. Knepley 
4051b2e4378dSMatthew G. Knepley /*@
4052b2e4378dSMatthew G. Knepley   DMGetBoundingBox - Returns the global bounding box for the DM.
4053b2e4378dSMatthew G. Knepley 
4054b2e4378dSMatthew G. Knepley   Collective
4055b2e4378dSMatthew G. Knepley 
4056b2e4378dSMatthew G. Knepley   Input Parameter:
4057b2e4378dSMatthew G. Knepley . dm - the DM
4058b2e4378dSMatthew G. Knepley 
4059b2e4378dSMatthew G. Knepley   Output Parameters:
4060b2e4378dSMatthew G. Knepley + gmin - global minimum coordinates (length coord dim, optional)
4061b2e4378dSMatthew G. Knepley - gmax - global maximim coordinates (length coord dim, optional)
4062b2e4378dSMatthew G. Knepley 
4063b2e4378dSMatthew G. Knepley   Level: beginner
4064b2e4378dSMatthew G. Knepley 
4065b2e4378dSMatthew G. Knepley .seealso: DMGetLocalBoundingBox(), DMGetCoordinates(), DMGetCoordinatesLocal()
4066b2e4378dSMatthew G. Knepley @*/
4067b2e4378dSMatthew G. Knepley PetscErrorCode DMGetBoundingBox(DM dm, PetscReal gmin[], PetscReal gmax[])
4068b2e4378dSMatthew G. Knepley {
4069b2e4378dSMatthew G. Knepley   PetscReal      lmin[3], lmax[3];
40706ce308c4SMatthew G. Knepley   PetscInt       cdim;
40716ce308c4SMatthew G. Knepley   PetscMPIInt    count;
4072b2e4378dSMatthew G. Knepley   PetscErrorCode ierr;
4073b2e4378dSMatthew G. Knepley 
4074b2e4378dSMatthew G. Knepley   PetscFunctionBegin;
4075b2e4378dSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4076b2e4378dSMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
4077b2e4378dSMatthew G. Knepley   ierr = PetscMPIIntCast(cdim, &count);CHKERRQ(ierr);
4078b2e4378dSMatthew G. Knepley   ierr = DMGetLocalBoundingBox(dm, lmin, lmax);CHKERRQ(ierr);
4079820f2d46SBarry Smith   if (gmin) {ierr = MPIU_Allreduce(lmin, gmin, count, MPIU_REAL, MPIU_MIN, PetscObjectComm((PetscObject) dm));CHKERRMPI(ierr);}
4080820f2d46SBarry Smith   if (gmax) {ierr = MPIU_Allreduce(lmax, gmax, count, MPIU_REAL, MPIU_MAX, PetscObjectComm((PetscObject) dm));CHKERRMPI(ierr);}
4081b2e4378dSMatthew G. Knepley   PetscFunctionReturn(0);
4082b2e4378dSMatthew G. Knepley }
4083b2e4378dSMatthew G. Knepley 
40847da65231SMatthew G Knepley /******************************** FEM Support **********************************/
40857da65231SMatthew G Knepley 
4086a6dfd86eSKarl Rupp PetscErrorCode DMPrintCellVector(PetscInt c, const char name[], PetscInt len, const PetscScalar x[])
4087a6dfd86eSKarl Rupp {
40881d47ebbbSSatish Balay   PetscInt       f;
40891b30c384SMatthew G Knepley   PetscErrorCode ierr;
40901b30c384SMatthew G Knepley 
40917da65231SMatthew G Knepley   PetscFunctionBegin;
409274778d6cSJed Brown   ierr = PetscPrintf(PETSC_COMM_SELF, "Cell %D Element %s\n", c, name);CHKERRQ(ierr);
40931d47ebbbSSatish Balay   for (f = 0; f < len; ++f) {
409457622a8eSBarry Smith     ierr = PetscPrintf(PETSC_COMM_SELF, "  | %g |\n", (double)PetscRealPart(x[f]));CHKERRQ(ierr);
40957da65231SMatthew G Knepley   }
40967da65231SMatthew G Knepley   PetscFunctionReturn(0);
40977da65231SMatthew G Knepley }
40987da65231SMatthew G Knepley 
4099a6dfd86eSKarl Rupp PetscErrorCode DMPrintCellMatrix(PetscInt c, const char name[], PetscInt rows, PetscInt cols, const PetscScalar A[])
4100a6dfd86eSKarl Rupp {
41011b30c384SMatthew G Knepley   PetscInt       f, g;
41027da65231SMatthew G Knepley   PetscErrorCode ierr;
41037da65231SMatthew G Knepley 
41047da65231SMatthew G Knepley   PetscFunctionBegin;
410574778d6cSJed Brown   ierr = PetscPrintf(PETSC_COMM_SELF, "Cell %D Element %s\n", c, name);CHKERRQ(ierr);
41061d47ebbbSSatish Balay   for (f = 0; f < rows; ++f) {
410774778d6cSJed Brown     ierr = PetscPrintf(PETSC_COMM_SELF, "  |");CHKERRQ(ierr);
41081d47ebbbSSatish Balay     for (g = 0; g < cols; ++g) {
4109e3556bceSMatthew G. Knepley       ierr = PetscPrintf(PETSC_COMM_SELF, " % 9.5g", PetscRealPart(A[f*cols+g]));CHKERRQ(ierr);
41107da65231SMatthew G Knepley     }
411174778d6cSJed Brown     ierr = PetscPrintf(PETSC_COMM_SELF, " |\n");CHKERRQ(ierr);
41127da65231SMatthew G Knepley   }
41137da65231SMatthew G Knepley   PetscFunctionReturn(0);
41147da65231SMatthew G Knepley }
4115e7c4fc90SDmitry Karpeev 
41166113b454SMatthew G. Knepley PetscErrorCode DMPrintLocalVec(DM dm, const char name[], PetscReal tol, Vec X)
4117e759306cSMatthew G. Knepley {
41180c5b8624SToby Isaac   PetscInt          localSize, bs;
41190c5b8624SToby Isaac   PetscMPIInt       size;
41200c5b8624SToby Isaac   Vec               x, xglob;
41210c5b8624SToby Isaac   const PetscScalar *xarray;
4122e759306cSMatthew G. Knepley   PetscErrorCode    ierr;
4123e759306cSMatthew G. Knepley 
4124e759306cSMatthew G. Knepley   PetscFunctionBegin;
4125ffc4695bSBarry Smith   ierr = MPI_Comm_size(PetscObjectComm((PetscObject) dm),&size);CHKERRMPI(ierr);
4126e759306cSMatthew G. Knepley   ierr = VecDuplicate(X, &x);CHKERRQ(ierr);
4127e759306cSMatthew G. Knepley   ierr = VecCopy(X, x);CHKERRQ(ierr);
41286113b454SMatthew G. Knepley   ierr = VecChop(x, tol);CHKERRQ(ierr);
41290c5b8624SToby Isaac   ierr = PetscPrintf(PetscObjectComm((PetscObject) dm),"%s:\n",name);CHKERRQ(ierr);
41300c5b8624SToby Isaac   if (size > 1) {
41310c5b8624SToby Isaac     ierr = VecGetLocalSize(x,&localSize);CHKERRQ(ierr);
41320c5b8624SToby Isaac     ierr = VecGetArrayRead(x,&xarray);CHKERRQ(ierr);
41330c5b8624SToby Isaac     ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
41340c5b8624SToby Isaac     ierr = VecCreateMPIWithArray(PetscObjectComm((PetscObject) dm),bs,localSize,PETSC_DETERMINE,xarray,&xglob);CHKERRQ(ierr);
41350c5b8624SToby Isaac   } else {
41360c5b8624SToby Isaac     xglob = x;
41370c5b8624SToby Isaac   }
41380c5b8624SToby Isaac   ierr = VecView(xglob,PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject) dm)));CHKERRQ(ierr);
41390c5b8624SToby Isaac   if (size > 1) {
41400c5b8624SToby Isaac     ierr = VecDestroy(&xglob);CHKERRQ(ierr);
41410c5b8624SToby Isaac     ierr = VecRestoreArrayRead(x,&xarray);CHKERRQ(ierr);
41420c5b8624SToby Isaac   }
4143e759306cSMatthew G. Knepley   ierr = VecDestroy(&x);CHKERRQ(ierr);
4144e759306cSMatthew G. Knepley   PetscFunctionReturn(0);
4145e759306cSMatthew G. Knepley }
4146e759306cSMatthew G. Knepley 
414788ed4aceSMatthew G Knepley /*@
41481bb6d2a8SBarry Smith   DMGetSection - Get the PetscSection encoding the local data layout for the DM.   This is equivalent to DMGetLocalSection(). Deprecated in v3.12
4149061576a5SJed Brown 
4150061576a5SJed Brown   Input Parameter:
4151061576a5SJed Brown . dm - The DM
4152061576a5SJed Brown 
4153061576a5SJed Brown   Output Parameter:
4154061576a5SJed Brown . section - The PetscSection
4155061576a5SJed Brown 
4156061576a5SJed Brown   Options Database Keys:
4157061576a5SJed Brown . -dm_petscsection_view - View the Section created by the DM
4158061576a5SJed Brown 
4159061576a5SJed Brown   Level: advanced
4160061576a5SJed Brown 
4161061576a5SJed Brown   Notes:
4162061576a5SJed Brown   Use DMGetLocalSection() in new code.
4163061576a5SJed Brown 
4164061576a5SJed Brown   This gets a borrowed reference, so the user should not destroy this PetscSection.
4165061576a5SJed Brown 
4166061576a5SJed Brown .seealso: DMGetLocalSection(), DMSetLocalSection(), DMGetGlobalSection()
4167061576a5SJed Brown @*/
4168061576a5SJed Brown PetscErrorCode DMGetSection(DM dm, PetscSection *section)
4169061576a5SJed Brown {
4170061576a5SJed Brown   PetscErrorCode ierr;
4171061576a5SJed Brown 
4172061576a5SJed Brown   PetscFunctionBegin;
4173061576a5SJed Brown   ierr = DMGetLocalSection(dm,section);CHKERRQ(ierr);
4174061576a5SJed Brown   PetscFunctionReturn(0);
4175061576a5SJed Brown }
4176061576a5SJed Brown 
4177061576a5SJed Brown /*@
4178061576a5SJed Brown   DMGetLocalSection - Get the PetscSection encoding the local data layout for the DM.
417988ed4aceSMatthew G Knepley 
418088ed4aceSMatthew G Knepley   Input Parameter:
418188ed4aceSMatthew G Knepley . dm - The DM
418288ed4aceSMatthew G Knepley 
418388ed4aceSMatthew G Knepley   Output Parameter:
418488ed4aceSMatthew G Knepley . section - The PetscSection
418588ed4aceSMatthew G Knepley 
4186e5893cccSMatthew G. Knepley   Options Database Keys:
4187e5893cccSMatthew G. Knepley . -dm_petscsection_view - View the Section created by the DM
4188e5893cccSMatthew G. Knepley 
418988ed4aceSMatthew G Knepley   Level: intermediate
419088ed4aceSMatthew G Knepley 
419188ed4aceSMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSection.
419288ed4aceSMatthew G Knepley 
4193061576a5SJed Brown .seealso: DMSetLocalSection(), DMGetGlobalSection()
419488ed4aceSMatthew G Knepley @*/
4195061576a5SJed Brown PetscErrorCode DMGetLocalSection(DM dm, PetscSection *section)
41960adebc6cSBarry Smith {
4197fd59a867SMatthew G. Knepley   PetscErrorCode ierr;
4198fd59a867SMatthew G. Knepley 
419988ed4aceSMatthew G Knepley   PetscFunctionBegin;
420088ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
420188ed4aceSMatthew G Knepley   PetscValidPointer(section, 2);
42021bb6d2a8SBarry Smith   if (!dm->localSection && dm->ops->createlocalsection) {
4203e5e52638SMatthew G. Knepley     PetscInt d;
4204e5e52638SMatthew G. Knepley 
420545480ffeSMatthew G. Knepley     if (dm->setfromoptionscalled) {
420645480ffeSMatthew G. Knepley       PetscObject       obj = (PetscObject) dm;
420745480ffeSMatthew G. Knepley       PetscViewer       viewer;
420845480ffeSMatthew G. Knepley       PetscViewerFormat format;
420945480ffeSMatthew G. Knepley       PetscBool         flg;
421045480ffeSMatthew G. Knepley 
421145480ffeSMatthew G. Knepley       ierr = PetscOptionsGetViewer(PetscObjectComm(obj), obj->options, obj->prefix, "-dm_petscds_view", &viewer, &format, &flg);CHKERRQ(ierr);
421245480ffeSMatthew G. Knepley       if (flg) {ierr = PetscViewerPushFormat(viewer, format);CHKERRQ(ierr);}
421345480ffeSMatthew G. Knepley       for (d = 0; d < dm->Nds; ++d) {
421445480ffeSMatthew G. Knepley         ierr = PetscDSSetFromOptions(dm->probs[d].ds);CHKERRQ(ierr);
421545480ffeSMatthew G. Knepley         if (flg) {ierr = PetscDSView(dm->probs[d].ds, viewer);CHKERRQ(ierr);}
421645480ffeSMatthew G. Knepley       }
421745480ffeSMatthew G. Knepley       if (flg) {
421845480ffeSMatthew G. Knepley         ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
421945480ffeSMatthew G. Knepley         ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
422045480ffeSMatthew G. Knepley         ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
422145480ffeSMatthew G. Knepley       }
422245480ffeSMatthew G. Knepley     }
42231bb6d2a8SBarry Smith     ierr = (*dm->ops->createlocalsection)(dm);CHKERRQ(ierr);
42241bb6d2a8SBarry Smith     if (dm->localSection) {ierr = PetscObjectViewFromOptions((PetscObject) dm->localSection, NULL, "-dm_petscsection_view");CHKERRQ(ierr);}
42252f0f8703SMatthew G. Knepley   }
42261bb6d2a8SBarry Smith   *section = dm->localSection;
422788ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
422888ed4aceSMatthew G Knepley }
422988ed4aceSMatthew G Knepley 
423088ed4aceSMatthew G Knepley /*@
42311bb6d2a8SBarry Smith   DMSetSection - Set the PetscSection encoding the local data layout for the DM.  This is equivalent to DMSetLocalSection(). Deprecated in v3.12
4232061576a5SJed Brown 
4233061576a5SJed Brown   Input Parameters:
4234061576a5SJed Brown + dm - The DM
4235061576a5SJed Brown - section - The PetscSection
4236061576a5SJed Brown 
4237061576a5SJed Brown   Level: advanced
4238061576a5SJed Brown 
4239061576a5SJed Brown   Notes:
4240061576a5SJed Brown   Use DMSetLocalSection() in new code.
4241061576a5SJed Brown 
4242061576a5SJed Brown   Any existing Section will be destroyed
4243061576a5SJed Brown 
4244061576a5SJed Brown .seealso: DMSetLocalSection(), DMGetLocalSection(), DMSetGlobalSection()
4245061576a5SJed Brown @*/
4246061576a5SJed Brown PetscErrorCode DMSetSection(DM dm, PetscSection section)
4247061576a5SJed Brown {
4248061576a5SJed Brown   PetscErrorCode ierr;
4249061576a5SJed Brown 
4250061576a5SJed Brown   PetscFunctionBegin;
4251061576a5SJed Brown   ierr = DMSetLocalSection(dm,section);CHKERRQ(ierr);
4252061576a5SJed Brown   PetscFunctionReturn(0);
4253061576a5SJed Brown }
4254061576a5SJed Brown 
4255061576a5SJed Brown /*@
4256061576a5SJed Brown   DMSetLocalSection - Set the PetscSection encoding the local data layout for the DM.
425788ed4aceSMatthew G Knepley 
425888ed4aceSMatthew G Knepley   Input Parameters:
425988ed4aceSMatthew G Knepley + dm - The DM
426088ed4aceSMatthew G Knepley - section - The PetscSection
426188ed4aceSMatthew G Knepley 
426288ed4aceSMatthew G Knepley   Level: intermediate
426388ed4aceSMatthew G Knepley 
426488ed4aceSMatthew G Knepley   Note: Any existing Section will be destroyed
426588ed4aceSMatthew G Knepley 
4266061576a5SJed Brown .seealso: DMGetLocalSection(), DMSetGlobalSection()
426788ed4aceSMatthew G Knepley @*/
4268061576a5SJed Brown PetscErrorCode DMSetLocalSection(DM dm, PetscSection section)
42690adebc6cSBarry Smith {
4270c473ab19SMatthew G. Knepley   PetscInt       numFields = 0;
4271af122d2aSMatthew G Knepley   PetscInt       f;
427288ed4aceSMatthew G Knepley   PetscErrorCode ierr;
427388ed4aceSMatthew G Knepley 
427488ed4aceSMatthew G Knepley   PetscFunctionBegin;
427588ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4276b9d85ea2SLisandro Dalcin   if (section) PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2);
42771d799100SJed Brown   ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr);
42781bb6d2a8SBarry Smith   ierr = PetscSectionDestroy(&dm->localSection);CHKERRQ(ierr);
42791bb6d2a8SBarry Smith   dm->localSection = section;
42801bb6d2a8SBarry Smith   if (section) {ierr = PetscSectionGetNumFields(dm->localSection, &numFields);CHKERRQ(ierr);}
4281af122d2aSMatthew G Knepley   if (numFields) {
4282af122d2aSMatthew G Knepley     ierr = DMSetNumFields(dm, numFields);CHKERRQ(ierr);
4283af122d2aSMatthew G Knepley     for (f = 0; f < numFields; ++f) {
42840f21e855SMatthew G. Knepley       PetscObject disc;
4285af122d2aSMatthew G Knepley       const char *name;
4286af122d2aSMatthew G Knepley 
42871bb6d2a8SBarry Smith       ierr = PetscSectionGetFieldName(dm->localSection, f, &name);CHKERRQ(ierr);
428844a7f3ddSMatthew G. Knepley       ierr = DMGetField(dm, f, NULL, &disc);CHKERRQ(ierr);
42890f21e855SMatthew G. Knepley       ierr = PetscObjectSetName(disc, name);CHKERRQ(ierr);
4290af122d2aSMatthew G Knepley     }
4291af122d2aSMatthew G Knepley   }
4292e87a4003SBarry Smith   /* The global section will be rebuilt in the next call to DMGetGlobalSection(). */
42931bb6d2a8SBarry Smith   ierr = PetscSectionDestroy(&dm->globalSection);CHKERRQ(ierr);
429488ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
429588ed4aceSMatthew G Knepley }
429688ed4aceSMatthew G Knepley 
42979435951eSToby Isaac /*@
4298b7385021SStefano Zampini   DMGetDefaultConstraints - Get the PetscSection and Mat that specify the local constraint interpolation. See DMSetDefaultConstraints() for a description of the purpose of constraint interpolation.
42999435951eSToby Isaac 
4300e228b242SToby Isaac   not collective
4301e228b242SToby Isaac 
43029435951eSToby Isaac   Input Parameter:
43039435951eSToby Isaac . dm - The DM
43049435951eSToby Isaac 
43059435951eSToby Isaac   Output Parameter:
43069435951eSToby 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.
43079435951eSToby 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.
43089435951eSToby Isaac 
43099435951eSToby Isaac   Level: advanced
43109435951eSToby Isaac 
43119435951eSToby Isaac   Note: This gets borrowed references, so the user should not destroy the PetscSection or the Mat.
43129435951eSToby Isaac 
43139435951eSToby Isaac .seealso: DMSetDefaultConstraints()
43149435951eSToby Isaac @*/
43159435951eSToby Isaac PetscErrorCode DMGetDefaultConstraints(DM dm, PetscSection *section, Mat *mat)
43169435951eSToby Isaac {
43179435951eSToby Isaac   PetscErrorCode ierr;
43189435951eSToby Isaac 
43199435951eSToby Isaac   PetscFunctionBegin;
43209435951eSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
43219435951eSToby Isaac   if (!dm->defaultConstraintSection && !dm->defaultConstraintMat && dm->ops->createdefaultconstraints) {ierr = (*dm->ops->createdefaultconstraints)(dm);CHKERRQ(ierr);}
432245a75d81SToby Isaac   if (section) {*section = dm->defaultConstraintSection;}
432345a75d81SToby Isaac   if (mat) {*mat = dm->defaultConstraintMat;}
43249435951eSToby Isaac   PetscFunctionReturn(0);
43259435951eSToby Isaac }
43269435951eSToby Isaac 
43279435951eSToby Isaac /*@
4328b7385021SStefano Zampini   DMSetDefaultConstraints - Set the PetscSection and Mat that specify the local constraint interpolation.
43299435951eSToby Isaac 
43309435951eSToby 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().
43319435951eSToby Isaac 
43329435951eSToby 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.
43339435951eSToby Isaac 
4334e228b242SToby Isaac   collective on dm
4335e228b242SToby Isaac 
43369435951eSToby Isaac   Input Parameters:
43379435951eSToby Isaac + dm - The DM
4338e228b242SToby 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).
4339e228b242SToby 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).
43409435951eSToby Isaac 
43419435951eSToby Isaac   Level: advanced
43429435951eSToby Isaac 
43439435951eSToby Isaac   Note: This increments the references of the PetscSection and the Mat, so they user can destroy them
43449435951eSToby Isaac 
43459435951eSToby Isaac .seealso: DMGetDefaultConstraints()
43469435951eSToby Isaac @*/
43479435951eSToby Isaac PetscErrorCode DMSetDefaultConstraints(DM dm, PetscSection section, Mat mat)
43489435951eSToby Isaac {
4349e228b242SToby Isaac   PetscMPIInt result;
43509435951eSToby Isaac   PetscErrorCode ierr;
43519435951eSToby Isaac 
43529435951eSToby Isaac   PetscFunctionBegin;
43539435951eSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4354e228b242SToby Isaac   if (section) {
4355e228b242SToby Isaac     PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2);
4356ffc4695bSBarry Smith     ierr = MPI_Comm_compare(PETSC_COMM_SELF,PetscObjectComm((PetscObject)section),&result);CHKERRMPI(ierr);
4357f60917d2SBarry Smith     if (result != MPI_CONGRUENT && result != MPI_IDENT) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NOTSAMECOMM,"constraint section must have local communicator");
4358e228b242SToby Isaac   }
4359e228b242SToby Isaac   if (mat) {
4360e228b242SToby Isaac     PetscValidHeaderSpecific(mat,MAT_CLASSID,3);
4361ffc4695bSBarry Smith     ierr = MPI_Comm_compare(PETSC_COMM_SELF,PetscObjectComm((PetscObject)mat),&result);CHKERRMPI(ierr);
4362f60917d2SBarry Smith     if (result != MPI_CONGRUENT && result != MPI_IDENT) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NOTSAMECOMM,"constraint matrix must have local communicator");
4363e228b242SToby Isaac   }
43649435951eSToby Isaac   ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr);
43659435951eSToby Isaac   ierr = PetscSectionDestroy(&dm->defaultConstraintSection);CHKERRQ(ierr);
43669435951eSToby Isaac   dm->defaultConstraintSection = section;
43679435951eSToby Isaac   ierr = PetscObjectReference((PetscObject)mat);CHKERRQ(ierr);
43689435951eSToby Isaac   ierr = MatDestroy(&dm->defaultConstraintMat);CHKERRQ(ierr);
43699435951eSToby Isaac   dm->defaultConstraintMat = mat;
43709435951eSToby Isaac   PetscFunctionReturn(0);
43719435951eSToby Isaac }
43729435951eSToby Isaac 
4373497880caSRichard Tran Mills #if defined(PETSC_USE_DEBUG)
4374507e4973SMatthew G. Knepley /*
4375507e4973SMatthew G. Knepley   DMDefaultSectionCheckConsistency - Check the consistentcy of the global and local sections.
4376507e4973SMatthew G. Knepley 
4377507e4973SMatthew G. Knepley   Input Parameters:
4378507e4973SMatthew G. Knepley + dm - The DM
4379507e4973SMatthew G. Knepley . localSection - PetscSection describing the local data layout
4380507e4973SMatthew G. Knepley - globalSection - PetscSection describing the global data layout
4381507e4973SMatthew G. Knepley 
4382507e4973SMatthew G. Knepley   Level: intermediate
4383507e4973SMatthew G. Knepley 
43841bb6d2a8SBarry Smith .seealso: DMGetSectionSF(), DMSetSectionSF()
4385507e4973SMatthew G. Knepley */
4386f741bcd2SMatthew G. Knepley static PetscErrorCode DMDefaultSectionCheckConsistency_Internal(DM dm, PetscSection localSection, PetscSection globalSection)
4387507e4973SMatthew G. Knepley {
4388507e4973SMatthew G. Knepley   MPI_Comm        comm;
4389507e4973SMatthew G. Knepley   PetscLayout     layout;
4390507e4973SMatthew G. Knepley   const PetscInt *ranges;
4391507e4973SMatthew G. Knepley   PetscInt        pStart, pEnd, p, nroots;
4392507e4973SMatthew G. Knepley   PetscMPIInt     size, rank;
4393507e4973SMatthew G. Knepley   PetscBool       valid = PETSC_TRUE, gvalid;
4394507e4973SMatthew G. Knepley   PetscErrorCode  ierr;
4395507e4973SMatthew G. Knepley 
4396507e4973SMatthew G. Knepley   PetscFunctionBegin;
4397507e4973SMatthew G. Knepley   ierr = PetscObjectGetComm((PetscObject)dm,&comm);CHKERRQ(ierr);
4398507e4973SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4399ffc4695bSBarry Smith   ierr = MPI_Comm_size(comm, &size);CHKERRMPI(ierr);
4400ffc4695bSBarry Smith   ierr = MPI_Comm_rank(comm, &rank);CHKERRMPI(ierr);
4401507e4973SMatthew G. Knepley   ierr = PetscSectionGetChart(globalSection, &pStart, &pEnd);CHKERRQ(ierr);
4402507e4973SMatthew G. Knepley   ierr = PetscSectionGetConstrainedStorageSize(globalSection, &nroots);CHKERRQ(ierr);
4403507e4973SMatthew G. Knepley   ierr = PetscLayoutCreate(comm, &layout);CHKERRQ(ierr);
4404507e4973SMatthew G. Knepley   ierr = PetscLayoutSetBlockSize(layout, 1);CHKERRQ(ierr);
4405507e4973SMatthew G. Knepley   ierr = PetscLayoutSetLocalSize(layout, nroots);CHKERRQ(ierr);
4406507e4973SMatthew G. Knepley   ierr = PetscLayoutSetUp(layout);CHKERRQ(ierr);
4407507e4973SMatthew G. Knepley   ierr = PetscLayoutGetRanges(layout, &ranges);CHKERRQ(ierr);
4408507e4973SMatthew G. Knepley   for (p = pStart; p < pEnd; ++p) {
4409f741bcd2SMatthew G. Knepley     PetscInt       dof, cdof, off, gdof, gcdof, goff, gsize, d;
4410507e4973SMatthew G. Knepley 
4411507e4973SMatthew G. Knepley     ierr = PetscSectionGetDof(localSection, p, &dof);CHKERRQ(ierr);
4412507e4973SMatthew G. Knepley     ierr = PetscSectionGetOffset(localSection, p, &off);CHKERRQ(ierr);
4413507e4973SMatthew G. Knepley     ierr = PetscSectionGetConstraintDof(localSection, p, &cdof);CHKERRQ(ierr);
4414507e4973SMatthew G. Knepley     ierr = PetscSectionGetDof(globalSection, p, &gdof);CHKERRQ(ierr);
4415507e4973SMatthew G. Knepley     ierr = PetscSectionGetConstraintDof(globalSection, p, &gcdof);CHKERRQ(ierr);
4416507e4973SMatthew G. Knepley     ierr = PetscSectionGetOffset(globalSection, p, &goff);CHKERRQ(ierr);
4417507e4973SMatthew G. Knepley     if (!gdof) continue; /* Censored point */
4418507e4973SMatthew 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;}
4419507e4973SMatthew 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;}
4420507e4973SMatthew G. Knepley     if (gdof < 0) {
4421507e4973SMatthew G. Knepley       gsize = gdof < 0 ? -(gdof+1)-gcdof : gdof-gcdof;
4422507e4973SMatthew G. Knepley       for (d = 0; d < gsize; ++d) {
4423507e4973SMatthew G. Knepley         PetscInt offset = -(goff+1) + d, r;
4424507e4973SMatthew G. Knepley 
4425507e4973SMatthew G. Knepley         ierr = PetscFindInt(offset,size+1,ranges,&r);CHKERRQ(ierr);
4426507e4973SMatthew G. Knepley         if (r < 0) r = -(r+2);
4427507e4973SMatthew 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;}
4428507e4973SMatthew G. Knepley       }
4429507e4973SMatthew G. Knepley     }
4430507e4973SMatthew G. Knepley   }
4431507e4973SMatthew G. Knepley   ierr = PetscLayoutDestroy(&layout);CHKERRQ(ierr);
4432507e4973SMatthew G. Knepley   ierr = PetscSynchronizedFlush(comm, NULL);CHKERRQ(ierr);
4433820f2d46SBarry Smith   ierr = MPIU_Allreduce(&valid, &gvalid, 1, MPIU_BOOL, MPI_LAND, comm);CHKERRMPI(ierr);
4434507e4973SMatthew G. Knepley   if (!gvalid) {
4435507e4973SMatthew G. Knepley     ierr = DMView(dm, NULL);CHKERRQ(ierr);
4436507e4973SMatthew G. Knepley     SETERRQ(comm, PETSC_ERR_ARG_WRONG, "Inconsistent local and global sections");
4437507e4973SMatthew G. Knepley   }
4438507e4973SMatthew G. Knepley   PetscFunctionReturn(0);
4439507e4973SMatthew G. Knepley }
4440f741bcd2SMatthew G. Knepley #endif
4441507e4973SMatthew G. Knepley 
444288ed4aceSMatthew G Knepley /*@
4443e87a4003SBarry Smith   DMGetGlobalSection - Get the PetscSection encoding the global data layout for the DM.
444488ed4aceSMatthew G Knepley 
4445d083f849SBarry Smith   Collective on dm
44468b1ab98fSJed Brown 
444788ed4aceSMatthew G Knepley   Input Parameter:
444888ed4aceSMatthew G Knepley . dm - The DM
444988ed4aceSMatthew G Knepley 
445088ed4aceSMatthew G Knepley   Output Parameter:
445188ed4aceSMatthew G Knepley . section - The PetscSection
445288ed4aceSMatthew G Knepley 
445388ed4aceSMatthew G Knepley   Level: intermediate
445488ed4aceSMatthew G Knepley 
445588ed4aceSMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSection.
445688ed4aceSMatthew G Knepley 
445792fd8e1eSJed Brown .seealso: DMSetLocalSection(), DMGetLocalSection()
445888ed4aceSMatthew G Knepley @*/
4459e87a4003SBarry Smith PetscErrorCode DMGetGlobalSection(DM dm, PetscSection *section)
44600adebc6cSBarry Smith {
446188ed4aceSMatthew G Knepley   PetscErrorCode ierr;
446288ed4aceSMatthew G Knepley 
446388ed4aceSMatthew G Knepley   PetscFunctionBegin;
446488ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
446588ed4aceSMatthew G Knepley   PetscValidPointer(section, 2);
44661bb6d2a8SBarry Smith   if (!dm->globalSection) {
4467fd59a867SMatthew G. Knepley     PetscSection s;
4468fd59a867SMatthew G. Knepley 
446992fd8e1eSJed Brown     ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr);
4470fd59a867SMatthew 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");
447133907cc2SStefano 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");
44721bb6d2a8SBarry Smith     ierr = PetscSectionCreateGlobalSection(s, dm->sf, PETSC_FALSE, PETSC_FALSE, &dm->globalSection);CHKERRQ(ierr);
4473cf06b437SMatthew G. Knepley     ierr = PetscLayoutDestroy(&dm->map);CHKERRQ(ierr);
44741bb6d2a8SBarry Smith     ierr = PetscSectionGetValueLayout(PetscObjectComm((PetscObject)dm), dm->globalSection, &dm->map);CHKERRQ(ierr);
44751bb6d2a8SBarry Smith     ierr = PetscSectionViewFromOptions(dm->globalSection, NULL, "-global_section_view");CHKERRQ(ierr);
447688ed4aceSMatthew G Knepley   }
44771bb6d2a8SBarry Smith   *section = dm->globalSection;
447888ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
447988ed4aceSMatthew G Knepley }
448088ed4aceSMatthew G Knepley 
4481b21d0597SMatthew G Knepley /*@
4482e87a4003SBarry Smith   DMSetGlobalSection - Set the PetscSection encoding the global data layout for the DM.
4483b21d0597SMatthew G Knepley 
4484b21d0597SMatthew G Knepley   Input Parameters:
4485b21d0597SMatthew G Knepley + dm - The DM
44865080bbdbSMatthew G Knepley - section - The PetscSection, or NULL
4487b21d0597SMatthew G Knepley 
4488b21d0597SMatthew G Knepley   Level: intermediate
4489b21d0597SMatthew G Knepley 
4490b21d0597SMatthew G Knepley   Note: Any existing Section will be destroyed
4491b21d0597SMatthew G Knepley 
449292fd8e1eSJed Brown .seealso: DMGetGlobalSection(), DMSetLocalSection()
4493b21d0597SMatthew G Knepley @*/
4494e87a4003SBarry Smith PetscErrorCode DMSetGlobalSection(DM dm, PetscSection section)
44950adebc6cSBarry Smith {
4496b21d0597SMatthew G Knepley   PetscErrorCode ierr;
4497b21d0597SMatthew G Knepley 
4498b21d0597SMatthew G Knepley   PetscFunctionBegin;
4499b21d0597SMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
45005080bbdbSMatthew G Knepley   if (section) PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2);
45011d799100SJed Brown   ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr);
45021bb6d2a8SBarry Smith   ierr = PetscSectionDestroy(&dm->globalSection);CHKERRQ(ierr);
45031bb6d2a8SBarry Smith   dm->globalSection = section;
4504497880caSRichard Tran Mills #if defined(PETSC_USE_DEBUG)
45051bb6d2a8SBarry Smith   if (section) {ierr = DMDefaultSectionCheckConsistency_Internal(dm, dm->localSection, section);CHKERRQ(ierr);}
4506507e4973SMatthew G. Knepley #endif
4507b21d0597SMatthew G Knepley   PetscFunctionReturn(0);
4508b21d0597SMatthew G Knepley }
4509b21d0597SMatthew G Knepley 
451088ed4aceSMatthew G Knepley /*@
45111bb6d2a8SBarry Smith   DMGetSectionSF - Get the PetscSF encoding the parallel dof overlap for the DM. If it has not been set,
451288ed4aceSMatthew G Knepley   it is created from the default PetscSection layouts in the DM.
451388ed4aceSMatthew G Knepley 
451488ed4aceSMatthew G Knepley   Input Parameter:
451588ed4aceSMatthew G Knepley . dm - The DM
451688ed4aceSMatthew G Knepley 
451788ed4aceSMatthew G Knepley   Output Parameter:
451888ed4aceSMatthew G Knepley . sf - The PetscSF
451988ed4aceSMatthew G Knepley 
452088ed4aceSMatthew G Knepley   Level: intermediate
452188ed4aceSMatthew G Knepley 
452288ed4aceSMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSF.
452388ed4aceSMatthew G Knepley 
45241bb6d2a8SBarry Smith .seealso: DMSetSectionSF(), DMCreateSectionSF()
452588ed4aceSMatthew G Knepley @*/
45261bb6d2a8SBarry Smith PetscErrorCode DMGetSectionSF(DM dm, PetscSF *sf)
45270adebc6cSBarry Smith {
452888ed4aceSMatthew G Knepley   PetscInt       nroots;
452988ed4aceSMatthew G Knepley   PetscErrorCode ierr;
453088ed4aceSMatthew G Knepley 
453188ed4aceSMatthew G Knepley   PetscFunctionBegin;
453288ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
453388ed4aceSMatthew G Knepley   PetscValidPointer(sf, 2);
45341bb6d2a8SBarry Smith   if (!dm->sectionSF) {
45351bb6d2a8SBarry Smith     ierr = PetscSFCreate(PetscObjectComm((PetscObject)dm),&dm->sectionSF);CHKERRQ(ierr);
453633907cc2SStefano Zampini   }
45371bb6d2a8SBarry Smith   ierr = PetscSFGetGraph(dm->sectionSF, &nroots, NULL, NULL, NULL);CHKERRQ(ierr);
453888ed4aceSMatthew G Knepley   if (nroots < 0) {
453988ed4aceSMatthew G Knepley     PetscSection section, gSection;
454088ed4aceSMatthew G Knepley 
454192fd8e1eSJed Brown     ierr = DMGetLocalSection(dm, &section);CHKERRQ(ierr);
454231ea6d37SMatthew G Knepley     if (section) {
4543e87a4003SBarry Smith       ierr = DMGetGlobalSection(dm, &gSection);CHKERRQ(ierr);
45441bb6d2a8SBarry Smith       ierr = DMCreateSectionSF(dm, section, gSection);CHKERRQ(ierr);
454531ea6d37SMatthew G Knepley     } else {
45460298fd71SBarry Smith       *sf = NULL;
454731ea6d37SMatthew G Knepley       PetscFunctionReturn(0);
454831ea6d37SMatthew G Knepley     }
454988ed4aceSMatthew G Knepley   }
45501bb6d2a8SBarry Smith   *sf = dm->sectionSF;
455188ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
455288ed4aceSMatthew G Knepley }
455388ed4aceSMatthew G Knepley 
455488ed4aceSMatthew G Knepley /*@
45551bb6d2a8SBarry Smith   DMSetSectionSF - Set the PetscSF encoding the parallel dof overlap for the DM
455688ed4aceSMatthew G Knepley 
455788ed4aceSMatthew G Knepley   Input Parameters:
455888ed4aceSMatthew G Knepley + dm - The DM
455988ed4aceSMatthew G Knepley - sf - The PetscSF
456088ed4aceSMatthew G Knepley 
456188ed4aceSMatthew G Knepley   Level: intermediate
456288ed4aceSMatthew G Knepley 
456388ed4aceSMatthew G Knepley   Note: Any previous SF is destroyed
456488ed4aceSMatthew G Knepley 
45651bb6d2a8SBarry Smith .seealso: DMGetSectionSF(), DMCreateSectionSF()
456688ed4aceSMatthew G Knepley @*/
45671bb6d2a8SBarry Smith PetscErrorCode DMSetSectionSF(DM dm, PetscSF sf)
45680adebc6cSBarry Smith {
456988ed4aceSMatthew G Knepley   PetscErrorCode ierr;
457088ed4aceSMatthew G Knepley 
457188ed4aceSMatthew G Knepley   PetscFunctionBegin;
457288ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4573b9d85ea2SLisandro Dalcin   if (sf) PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
457433907cc2SStefano Zampini   ierr = PetscObjectReference((PetscObject) sf);CHKERRQ(ierr);
45751bb6d2a8SBarry Smith   ierr = PetscSFDestroy(&dm->sectionSF);CHKERRQ(ierr);
45761bb6d2a8SBarry Smith   dm->sectionSF = sf;
457788ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
457888ed4aceSMatthew G Knepley }
457988ed4aceSMatthew G Knepley 
458088ed4aceSMatthew G Knepley /*@C
45811bb6d2a8SBarry Smith   DMCreateSectionSF - Create the PetscSF encoding the parallel dof overlap for the DM based upon the PetscSections
458288ed4aceSMatthew G Knepley   describing the data layout.
458388ed4aceSMatthew G Knepley 
458488ed4aceSMatthew G Knepley   Input Parameters:
458588ed4aceSMatthew G Knepley + dm - The DM
458688ed4aceSMatthew G Knepley . localSection - PetscSection describing the local data layout
458788ed4aceSMatthew G Knepley - globalSection - PetscSection describing the global data layout
458888ed4aceSMatthew G Knepley 
45891bb6d2a8SBarry Smith   Notes: One usually uses DMGetSectionSF() to obtain the PetscSF
459088ed4aceSMatthew G Knepley 
45911bb6d2a8SBarry Smith   Level: developer
45921bb6d2a8SBarry Smith 
45931bb6d2a8SBarry Smith   Developer Note: Since this routine has for arguments the two sections from the DM and puts the resulting PetscSF
45941bb6d2a8SBarry Smith                   directly into the DM, perhaps this function should not take the local and global sections as
45951bb6d2a8SBarry Smith                   input and should just obtain them from the DM?
45961bb6d2a8SBarry Smith 
45971bb6d2a8SBarry Smith .seealso: DMGetSectionSF(), DMSetSectionSF(), DMGetLocalSection(), DMGetGlobalSection()
459888ed4aceSMatthew G Knepley @*/
45991bb6d2a8SBarry Smith PetscErrorCode DMCreateSectionSF(DM dm, PetscSection localSection, PetscSection globalSection)
460088ed4aceSMatthew G Knepley {
460188ed4aceSMatthew G Knepley   PetscErrorCode ierr;
460288ed4aceSMatthew G Knepley 
460388ed4aceSMatthew G Knepley   PetscFunctionBegin;
460488ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4605b0c7db22SLisandro Dalcin   ierr = PetscSFSetGraphSection(dm->sectionSF, localSection, globalSection);CHKERRQ(ierr);
460688ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
460788ed4aceSMatthew G Knepley }
4608af122d2aSMatthew G Knepley 
4609b21d0597SMatthew G Knepley /*@
4610b21d0597SMatthew G Knepley   DMGetPointSF - Get the PetscSF encoding the parallel section point overlap for the DM.
4611b21d0597SMatthew G Knepley 
4612b21d0597SMatthew G Knepley   Input Parameter:
4613b21d0597SMatthew G Knepley . dm - The DM
4614b21d0597SMatthew G Knepley 
4615b21d0597SMatthew G Knepley   Output Parameter:
4616b21d0597SMatthew G Knepley . sf - The PetscSF
4617b21d0597SMatthew G Knepley 
4618b21d0597SMatthew G Knepley   Level: intermediate
4619b21d0597SMatthew G Knepley 
4620b21d0597SMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSF.
4621b21d0597SMatthew G Knepley 
46221bb6d2a8SBarry Smith .seealso: DMSetPointSF(), DMGetSectionSF(), DMSetSectionSF(), DMCreateSectionSF()
4623b21d0597SMatthew G Knepley @*/
46240adebc6cSBarry Smith PetscErrorCode DMGetPointSF(DM dm, PetscSF *sf)
46250adebc6cSBarry Smith {
4626b21d0597SMatthew G Knepley   PetscFunctionBegin;
4627b21d0597SMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4628b21d0597SMatthew G Knepley   PetscValidPointer(sf, 2);
4629b21d0597SMatthew G Knepley   *sf = dm->sf;
4630b21d0597SMatthew G Knepley   PetscFunctionReturn(0);
4631b21d0597SMatthew G Knepley }
4632b21d0597SMatthew G Knepley 
4633057b4bcdSMatthew G Knepley /*@
4634057b4bcdSMatthew G Knepley   DMSetPointSF - Set the PetscSF encoding the parallel section point overlap for the DM.
4635057b4bcdSMatthew G Knepley 
4636057b4bcdSMatthew G Knepley   Input Parameters:
4637057b4bcdSMatthew G Knepley + dm - The DM
4638057b4bcdSMatthew G Knepley - sf - The PetscSF
4639057b4bcdSMatthew G Knepley 
4640057b4bcdSMatthew G Knepley   Level: intermediate
4641057b4bcdSMatthew G Knepley 
46421bb6d2a8SBarry Smith .seealso: DMGetPointSF(), DMGetSectionSF(), DMSetSectionSF(), DMCreateSectionSF()
4643057b4bcdSMatthew G Knepley @*/
46440adebc6cSBarry Smith PetscErrorCode DMSetPointSF(DM dm, PetscSF sf)
46450adebc6cSBarry Smith {
4646057b4bcdSMatthew G Knepley   PetscErrorCode ierr;
4647057b4bcdSMatthew G Knepley 
4648057b4bcdSMatthew G Knepley   PetscFunctionBegin;
4649057b4bcdSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4650b9d85ea2SLisandro Dalcin   if (sf) PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
4651057b4bcdSMatthew G Knepley   ierr = PetscObjectReference((PetscObject) sf);CHKERRQ(ierr);
465233907cc2SStefano Zampini   ierr = PetscSFDestroy(&dm->sf);CHKERRQ(ierr);
4653057b4bcdSMatthew G Knepley   dm->sf = sf;
4654057b4bcdSMatthew G Knepley   PetscFunctionReturn(0);
4655057b4bcdSMatthew G Knepley }
4656057b4bcdSMatthew G Knepley 
465734aa8a36SMatthew G. Knepley static PetscErrorCode DMSetDefaultAdjacency_Private(DM dm, PetscInt f, PetscObject disc)
465834aa8a36SMatthew G. Knepley {
465934aa8a36SMatthew G. Knepley   PetscClassId   id;
466034aa8a36SMatthew G. Knepley   PetscErrorCode ierr;
466134aa8a36SMatthew G. Knepley 
466234aa8a36SMatthew G. Knepley   PetscFunctionBegin;
466334aa8a36SMatthew G. Knepley   ierr = PetscObjectGetClassId(disc, &id);CHKERRQ(ierr);
466434aa8a36SMatthew G. Knepley   if (id == PETSCFE_CLASSID) {
466534aa8a36SMatthew G. Knepley     ierr = DMSetAdjacency(dm, f, PETSC_FALSE, PETSC_TRUE);CHKERRQ(ierr);
466634aa8a36SMatthew G. Knepley   } else if (id == PETSCFV_CLASSID) {
466734aa8a36SMatthew G. Knepley     ierr = DMSetAdjacency(dm, f, PETSC_TRUE, PETSC_FALSE);CHKERRQ(ierr);
466817c1d62eSMatthew G. Knepley   } else {
466917c1d62eSMatthew G. Knepley     ierr = DMSetAdjacency(dm, f, PETSC_FALSE, PETSC_TRUE);CHKERRQ(ierr);
467034aa8a36SMatthew G. Knepley   }
467134aa8a36SMatthew G. Knepley   PetscFunctionReturn(0);
467234aa8a36SMatthew G. Knepley }
467334aa8a36SMatthew G. Knepley 
467444a7f3ddSMatthew G. Knepley static PetscErrorCode DMFieldEnlarge_Static(DM dm, PetscInt NfNew)
467544a7f3ddSMatthew G. Knepley {
467644a7f3ddSMatthew G. Knepley   RegionField   *tmpr;
467744a7f3ddSMatthew G. Knepley   PetscInt       Nf = dm->Nf, f;
467844a7f3ddSMatthew G. Knepley   PetscErrorCode ierr;
467944a7f3ddSMatthew G. Knepley 
468044a7f3ddSMatthew G. Knepley   PetscFunctionBegin;
468144a7f3ddSMatthew G. Knepley   if (Nf >= NfNew) PetscFunctionReturn(0);
468244a7f3ddSMatthew G. Knepley   ierr = PetscMalloc1(NfNew, &tmpr);CHKERRQ(ierr);
468344a7f3ddSMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpr[f] = dm->fields[f];
4684e0b68406SMatthew Knepley   for (f = Nf; f < NfNew; ++f) {tmpr[f].disc = NULL; tmpr[f].label = NULL; tmpr[f].avoidTensor = PETSC_FALSE;}
468544a7f3ddSMatthew G. Knepley   ierr = PetscFree(dm->fields);CHKERRQ(ierr);
468644a7f3ddSMatthew G. Knepley   dm->Nf     = NfNew;
468744a7f3ddSMatthew G. Knepley   dm->fields = tmpr;
468844a7f3ddSMatthew G. Knepley   PetscFunctionReturn(0);
468944a7f3ddSMatthew G. Knepley }
469044a7f3ddSMatthew G. Knepley 
469144a7f3ddSMatthew G. Knepley /*@
469244a7f3ddSMatthew G. Knepley   DMClearFields - Remove all fields from the DM
469344a7f3ddSMatthew G. Knepley 
4694d083f849SBarry Smith   Logically collective on dm
469544a7f3ddSMatthew G. Knepley 
469644a7f3ddSMatthew G. Knepley   Input Parameter:
469744a7f3ddSMatthew G. Knepley . dm - The DM
469844a7f3ddSMatthew G. Knepley 
469944a7f3ddSMatthew G. Knepley   Level: intermediate
470044a7f3ddSMatthew G. Knepley 
470144a7f3ddSMatthew G. Knepley .seealso: DMGetNumFields(), DMSetNumFields(), DMSetField()
470244a7f3ddSMatthew G. Knepley @*/
470344a7f3ddSMatthew G. Knepley PetscErrorCode DMClearFields(DM dm)
470444a7f3ddSMatthew G. Knepley {
470544a7f3ddSMatthew G. Knepley   PetscInt       f;
470644a7f3ddSMatthew G. Knepley   PetscErrorCode ierr;
470744a7f3ddSMatthew G. Knepley 
470844a7f3ddSMatthew G. Knepley   PetscFunctionBegin;
470944a7f3ddSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
471044a7f3ddSMatthew G. Knepley   for (f = 0; f < dm->Nf; ++f) {
471144a7f3ddSMatthew G. Knepley     ierr = PetscObjectDestroy(&dm->fields[f].disc);CHKERRQ(ierr);
471244a7f3ddSMatthew G. Knepley     ierr = DMLabelDestroy(&dm->fields[f].label);CHKERRQ(ierr);
471344a7f3ddSMatthew G. Knepley   }
471444a7f3ddSMatthew G. Knepley   ierr = PetscFree(dm->fields);CHKERRQ(ierr);
471544a7f3ddSMatthew G. Knepley   dm->fields = NULL;
471644a7f3ddSMatthew G. Knepley   dm->Nf     = 0;
471744a7f3ddSMatthew G. Knepley   PetscFunctionReturn(0);
471844a7f3ddSMatthew G. Knepley }
471944a7f3ddSMatthew G. Knepley 
4720689b5837SMatthew G. Knepley /*@
4721689b5837SMatthew G. Knepley   DMGetNumFields - Get the number of fields in the DM
4722689b5837SMatthew G. Knepley 
4723689b5837SMatthew G. Knepley   Not collective
4724689b5837SMatthew G. Knepley 
4725689b5837SMatthew G. Knepley   Input Parameter:
4726689b5837SMatthew G. Knepley . dm - The DM
4727689b5837SMatthew G. Knepley 
4728689b5837SMatthew G. Knepley   Output Parameter:
4729689b5837SMatthew G. Knepley . Nf - The number of fields
4730689b5837SMatthew G. Knepley 
4731689b5837SMatthew G. Knepley   Level: intermediate
4732689b5837SMatthew G. Knepley 
4733689b5837SMatthew G. Knepley .seealso: DMSetNumFields(), DMSetField()
4734689b5837SMatthew G. Knepley @*/
47350f21e855SMatthew G. Knepley PetscErrorCode DMGetNumFields(DM dm, PetscInt *numFields)
47360f21e855SMatthew G. Knepley {
47370f21e855SMatthew G. Knepley   PetscFunctionBegin;
47380f21e855SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4739534a8f05SLisandro Dalcin   PetscValidIntPointer(numFields, 2);
474044a7f3ddSMatthew G. Knepley   *numFields = dm->Nf;
4741af122d2aSMatthew G Knepley   PetscFunctionReturn(0);
4742af122d2aSMatthew G Knepley }
4743af122d2aSMatthew G Knepley 
4744689b5837SMatthew G. Knepley /*@
4745689b5837SMatthew G. Knepley   DMSetNumFields - Set the number of fields in the DM
4746689b5837SMatthew G. Knepley 
4747d083f849SBarry Smith   Logically collective on dm
4748689b5837SMatthew G. Knepley 
4749689b5837SMatthew G. Knepley   Input Parameters:
4750689b5837SMatthew G. Knepley + dm - The DM
4751689b5837SMatthew G. Knepley - Nf - The number of fields
4752689b5837SMatthew G. Knepley 
4753689b5837SMatthew G. Knepley   Level: intermediate
4754689b5837SMatthew G. Knepley 
4755689b5837SMatthew G. Knepley .seealso: DMGetNumFields(), DMSetField()
4756689b5837SMatthew G. Knepley @*/
4757af122d2aSMatthew G Knepley PetscErrorCode DMSetNumFields(DM dm, PetscInt numFields)
4758af122d2aSMatthew G Knepley {
47590f21e855SMatthew G. Knepley   PetscInt       Nf, f;
4760af122d2aSMatthew G Knepley   PetscErrorCode ierr;
4761af122d2aSMatthew G Knepley 
4762af122d2aSMatthew G Knepley   PetscFunctionBegin;
4763af122d2aSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
476444a7f3ddSMatthew G. Knepley   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
47650f21e855SMatthew G. Knepley   for (f = Nf; f < numFields; ++f) {
47660f21e855SMatthew G. Knepley     PetscContainer obj;
47670f21e855SMatthew G. Knepley 
47680f21e855SMatthew G. Knepley     ierr = PetscContainerCreate(PetscObjectComm((PetscObject) dm), &obj);CHKERRQ(ierr);
476944a7f3ddSMatthew G. Knepley     ierr = DMAddField(dm, NULL, (PetscObject) obj);CHKERRQ(ierr);
47700f21e855SMatthew G. Knepley     ierr = PetscContainerDestroy(&obj);CHKERRQ(ierr);
4771af122d2aSMatthew G Knepley   }
4772af122d2aSMatthew G Knepley   PetscFunctionReturn(0);
4773af122d2aSMatthew G Knepley }
4774af122d2aSMatthew G Knepley 
4775c1929be8SMatthew G. Knepley /*@
4776c1929be8SMatthew G. Knepley   DMGetField - Return the discretization object for a given DM field
4777c1929be8SMatthew G. Knepley 
4778c1929be8SMatthew G. Knepley   Not collective
4779c1929be8SMatthew G. Knepley 
4780c1929be8SMatthew G. Knepley   Input Parameters:
4781c1929be8SMatthew G. Knepley + dm - The DM
4782c1929be8SMatthew G. Knepley - f  - The field number
4783c1929be8SMatthew G. Knepley 
478444a7f3ddSMatthew G. Knepley   Output Parameters:
478544a7f3ddSMatthew G. Knepley + label - The label indicating the support of the field, or NULL for the entire mesh
478644a7f3ddSMatthew G. Knepley - field - The discretization object
4787c1929be8SMatthew G. Knepley 
478844a7f3ddSMatthew G. Knepley   Level: intermediate
4789c1929be8SMatthew G. Knepley 
479044a7f3ddSMatthew G. Knepley .seealso: DMAddField(), DMSetField()
4791c1929be8SMatthew G. Knepley @*/
479244a7f3ddSMatthew G. Knepley PetscErrorCode DMGetField(DM dm, PetscInt f, DMLabel *label, PetscObject *field)
4793af122d2aSMatthew G Knepley {
4794af122d2aSMatthew G Knepley   PetscFunctionBegin;
4795af122d2aSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4796064a246eSJacob Faibussowitsch   PetscValidPointer(field, 4);
479744a7f3ddSMatthew 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);
479844a7f3ddSMatthew G. Knepley   if (label) *label = dm->fields[f].label;
479944a7f3ddSMatthew G. Knepley   if (field) *field = dm->fields[f].disc;
4800decb47aaSMatthew G. Knepley   PetscFunctionReturn(0);
4801decb47aaSMatthew G. Knepley }
4802decb47aaSMatthew G. Knepley 
4803083401c6SMatthew G. Knepley /* Does not clear the DS */
4804083401c6SMatthew G. Knepley PetscErrorCode DMSetField_Internal(DM dm, PetscInt f, DMLabel label, PetscObject field)
4805083401c6SMatthew G. Knepley {
4806083401c6SMatthew G. Knepley   PetscErrorCode ierr;
4807083401c6SMatthew G. Knepley 
4808083401c6SMatthew G. Knepley   PetscFunctionBegin;
4809083401c6SMatthew G. Knepley   ierr = DMFieldEnlarge_Static(dm, f+1);CHKERRQ(ierr);
4810083401c6SMatthew G. Knepley   ierr = DMLabelDestroy(&dm->fields[f].label);CHKERRQ(ierr);
4811083401c6SMatthew G. Knepley   ierr = PetscObjectDestroy(&dm->fields[f].disc);CHKERRQ(ierr);
4812083401c6SMatthew G. Knepley   dm->fields[f].label = label;
4813083401c6SMatthew G. Knepley   dm->fields[f].disc  = field;
4814083401c6SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr);
4815083401c6SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) field);CHKERRQ(ierr);
4816083401c6SMatthew G. Knepley   PetscFunctionReturn(0);
4817083401c6SMatthew G. Knepley }
4818083401c6SMatthew G. Knepley 
4819c1929be8SMatthew G. Knepley /*@
4820c1929be8SMatthew G. Knepley   DMSetField - Set the discretization object for a given DM field
4821c1929be8SMatthew G. Knepley 
4822d083f849SBarry Smith   Logically collective on dm
4823c1929be8SMatthew G. Knepley 
4824c1929be8SMatthew G. Knepley   Input Parameters:
4825c1929be8SMatthew G. Knepley + dm    - The DM
4826c1929be8SMatthew G. Knepley . f     - The field number
482744a7f3ddSMatthew G. Knepley . label - The label indicating the support of the field, or NULL for the entire mesh
4828c1929be8SMatthew G. Knepley - field - The discretization object
4829c1929be8SMatthew G. Knepley 
483044a7f3ddSMatthew G. Knepley   Level: intermediate
4831c1929be8SMatthew G. Knepley 
483244a7f3ddSMatthew G. Knepley .seealso: DMAddField(), DMGetField()
4833c1929be8SMatthew G. Knepley @*/
483444a7f3ddSMatthew G. Knepley PetscErrorCode DMSetField(DM dm, PetscInt f, DMLabel label, PetscObject field)
4835decb47aaSMatthew G. Knepley {
4836decb47aaSMatthew G. Knepley   PetscErrorCode ierr;
4837decb47aaSMatthew G. Knepley 
4838decb47aaSMatthew G. Knepley   PetscFunctionBegin;
4839decb47aaSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4840e5e52638SMatthew G. Knepley   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 3);
484144a7f3ddSMatthew G. Knepley   PetscValidHeader(field, 4);
4842e5e52638SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
4843083401c6SMatthew G. Knepley   ierr = DMSetField_Internal(dm, f, label, field);CHKERRQ(ierr);
484434aa8a36SMatthew G. Knepley   ierr = DMSetDefaultAdjacency_Private(dm, f, field);CHKERRQ(ierr);
48452df9ee95SMatthew G. Knepley   ierr = DMClearDS(dm);CHKERRQ(ierr);
484644a7f3ddSMatthew G. Knepley   PetscFunctionReturn(0);
484744a7f3ddSMatthew G. Knepley }
484844a7f3ddSMatthew G. Knepley 
484944a7f3ddSMatthew G. Knepley /*@
485044a7f3ddSMatthew G. Knepley   DMAddField - Add the discretization object for the given DM field
485144a7f3ddSMatthew G. Knepley 
4852d083f849SBarry Smith   Logically collective on dm
485344a7f3ddSMatthew G. Knepley 
485444a7f3ddSMatthew G. Knepley   Input Parameters:
485544a7f3ddSMatthew G. Knepley + dm    - The DM
485644a7f3ddSMatthew G. Knepley . label - The label indicating the support of the field, or NULL for the entire mesh
485744a7f3ddSMatthew G. Knepley - field - The discretization object
485844a7f3ddSMatthew G. Knepley 
485944a7f3ddSMatthew G. Knepley   Level: intermediate
486044a7f3ddSMatthew G. Knepley 
486144a7f3ddSMatthew G. Knepley .seealso: DMSetField(), DMGetField()
486244a7f3ddSMatthew G. Knepley @*/
486344a7f3ddSMatthew G. Knepley PetscErrorCode DMAddField(DM dm, DMLabel label, PetscObject field)
486444a7f3ddSMatthew G. Knepley {
486544a7f3ddSMatthew G. Knepley   PetscInt       Nf = dm->Nf;
486644a7f3ddSMatthew G. Knepley   PetscErrorCode ierr;
486744a7f3ddSMatthew G. Knepley 
486844a7f3ddSMatthew G. Knepley   PetscFunctionBegin;
486944a7f3ddSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4870064a246eSJacob Faibussowitsch   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
487144a7f3ddSMatthew G. Knepley   PetscValidHeader(field, 3);
487244a7f3ddSMatthew G. Knepley   ierr = DMFieldEnlarge_Static(dm, Nf+1);CHKERRQ(ierr);
487344a7f3ddSMatthew G. Knepley   dm->fields[Nf].label = label;
487444a7f3ddSMatthew G. Knepley   dm->fields[Nf].disc  = field;
487544a7f3ddSMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr);
487644a7f3ddSMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) field);CHKERRQ(ierr);
487734aa8a36SMatthew G. Knepley   ierr = DMSetDefaultAdjacency_Private(dm, Nf, field);CHKERRQ(ierr);
48782df9ee95SMatthew G. Knepley   ierr = DMClearDS(dm);CHKERRQ(ierr);
4879af122d2aSMatthew G Knepley   PetscFunctionReturn(0);
4880af122d2aSMatthew G Knepley }
48816636e97aSMatthew G Knepley 
4882e5e52638SMatthew G. Knepley /*@
4883e0b68406SMatthew Knepley   DMSetFieldAvoidTensor - Set flag to avoid defining the field on tensor cells
4884e0b68406SMatthew Knepley 
4885e0b68406SMatthew Knepley   Logically collective on dm
4886e0b68406SMatthew Knepley 
4887e0b68406SMatthew Knepley   Input Parameters:
4888e0b68406SMatthew Knepley + dm          - The DM
4889e0b68406SMatthew Knepley . f           - The field index
4890e0b68406SMatthew Knepley - avoidTensor - The flag to avoid defining the field on tensor cells
4891e0b68406SMatthew Knepley 
4892e0b68406SMatthew Knepley   Level: intermediate
4893e0b68406SMatthew Knepley 
4894e0b68406SMatthew Knepley .seealso: DMGetFieldAvoidTensor(), DMSetField(), DMGetField()
4895e0b68406SMatthew Knepley @*/
4896e0b68406SMatthew Knepley PetscErrorCode DMSetFieldAvoidTensor(DM dm, PetscInt f, PetscBool avoidTensor)
4897e0b68406SMatthew Knepley {
4898e0b68406SMatthew Knepley   PetscFunctionBegin;
4899e0b68406SMatthew 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);
4900e0b68406SMatthew Knepley   dm->fields[f].avoidTensor = avoidTensor;
4901e0b68406SMatthew Knepley   PetscFunctionReturn(0);
4902e0b68406SMatthew Knepley }
4903e0b68406SMatthew Knepley 
4904e0b68406SMatthew Knepley /*@
4905e0b68406SMatthew Knepley   DMGetFieldAvoidTensor - Get flag to avoid defining the field on tensor cells
4906e0b68406SMatthew Knepley 
4907e0b68406SMatthew Knepley   Logically collective on dm
4908e0b68406SMatthew Knepley 
4909e0b68406SMatthew Knepley   Input Parameters:
4910e0b68406SMatthew Knepley + dm          - The DM
4911e0b68406SMatthew Knepley - f           - The field index
4912e0b68406SMatthew Knepley 
4913e0b68406SMatthew Knepley   Output Parameter:
4914e0b68406SMatthew Knepley . avoidTensor - The flag to avoid defining the field on tensor cells
4915e0b68406SMatthew Knepley 
4916e0b68406SMatthew Knepley   Level: intermediate
4917e0b68406SMatthew Knepley 
4918e0b68406SMatthew Knepley .seealso: DMSetFieldAvoidTensor(), DMSetField(), DMGetField()
4919e0b68406SMatthew Knepley @*/
4920e0b68406SMatthew Knepley PetscErrorCode DMGetFieldAvoidTensor(DM dm, PetscInt f, PetscBool *avoidTensor)
4921e0b68406SMatthew Knepley {
4922e0b68406SMatthew Knepley   PetscFunctionBegin;
4923e0b68406SMatthew 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);
4924e0b68406SMatthew Knepley   *avoidTensor = dm->fields[f].avoidTensor;
4925e0b68406SMatthew Knepley   PetscFunctionReturn(0);
4926e0b68406SMatthew Knepley }
4927e0b68406SMatthew Knepley 
4928e0b68406SMatthew Knepley /*@
4929e5e52638SMatthew G. Knepley   DMCopyFields - Copy the discretizations for the DM into another DM
4930e5e52638SMatthew G. Knepley 
4931d083f849SBarry Smith   Collective on dm
4932e5e52638SMatthew G. Knepley 
4933e5e52638SMatthew G. Knepley   Input Parameter:
4934e5e52638SMatthew G. Knepley . dm - The DM
4935e5e52638SMatthew G. Knepley 
4936e5e52638SMatthew G. Knepley   Output Parameter:
4937e5e52638SMatthew G. Knepley . newdm - The DM
4938e5e52638SMatthew G. Knepley 
4939e5e52638SMatthew G. Knepley   Level: advanced
4940e5e52638SMatthew G. Knepley 
4941e5e52638SMatthew G. Knepley .seealso: DMGetField(), DMSetField(), DMAddField(), DMCopyDS(), DMGetDS(), DMGetCellDS()
4942e5e52638SMatthew G. Knepley @*/
4943e5e52638SMatthew G. Knepley PetscErrorCode DMCopyFields(DM dm, DM newdm)
4944e5e52638SMatthew G. Knepley {
4945e5e52638SMatthew G. Knepley   PetscInt       Nf, f;
4946e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
4947e5e52638SMatthew G. Knepley 
4948e5e52638SMatthew G. Knepley   PetscFunctionBegin;
4949e5e52638SMatthew G. Knepley   if (dm == newdm) PetscFunctionReturn(0);
4950e5e52638SMatthew G. Knepley   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
4951e5e52638SMatthew G. Knepley   ierr = DMClearFields(newdm);CHKERRQ(ierr);
4952e5e52638SMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
4953e5e52638SMatthew G. Knepley     DMLabel     label;
4954e5e52638SMatthew G. Knepley     PetscObject field;
495534aa8a36SMatthew G. Knepley     PetscBool   useCone, useClosure;
4956e5e52638SMatthew G. Knepley 
4957e5e52638SMatthew G. Knepley     ierr = DMGetField(dm, f, &label, &field);CHKERRQ(ierr);
4958e5e52638SMatthew G. Knepley     ierr = DMSetField(newdm, f, label, field);CHKERRQ(ierr);
495934aa8a36SMatthew G. Knepley     ierr = DMGetAdjacency(dm, f, &useCone, &useClosure);CHKERRQ(ierr);
496034aa8a36SMatthew G. Knepley     ierr = DMSetAdjacency(newdm, f, useCone, useClosure);CHKERRQ(ierr);
496134aa8a36SMatthew G. Knepley   }
496234aa8a36SMatthew G. Knepley   PetscFunctionReturn(0);
496334aa8a36SMatthew G. Knepley }
496434aa8a36SMatthew G. Knepley 
496534aa8a36SMatthew G. Knepley /*@
496634aa8a36SMatthew G. Knepley   DMGetAdjacency - Returns the flags for determining variable influence
496734aa8a36SMatthew G. Knepley 
496834aa8a36SMatthew G. Knepley   Not collective
496934aa8a36SMatthew G. Knepley 
497034aa8a36SMatthew G. Knepley   Input Parameters:
497134aa8a36SMatthew G. Knepley + dm - The DM object
497234aa8a36SMatthew G. Knepley - f  - The field number, or PETSC_DEFAULT for the default adjacency
497334aa8a36SMatthew G. Knepley 
497434aa8a36SMatthew G. Knepley   Output Parameter:
497534aa8a36SMatthew G. Knepley + useCone    - Flag for variable influence starting with the cone operation
497634aa8a36SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
497734aa8a36SMatthew G. Knepley 
497834aa8a36SMatthew G. Knepley   Notes:
497934aa8a36SMatthew G. Knepley $     FEM:   Two points p and q are adjacent if q \in closure(star(p)),   useCone = PETSC_FALSE, useClosure = PETSC_TRUE
498034aa8a36SMatthew G. Knepley $     FVM:   Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE,  useClosure = PETSC_FALSE
498134aa8a36SMatthew G. Knepley $     FVM++: Two points p and q are adjacent if q \in star(closure(p)),   useCone = PETSC_TRUE,  useClosure = PETSC_TRUE
4982979e053dSMatthew G. Knepley   Further explanation can be found in the User's Manual Section on the Influence of Variables on One Another.
498334aa8a36SMatthew G. Knepley 
498434aa8a36SMatthew G. Knepley   Level: developer
498534aa8a36SMatthew G. Knepley 
498634aa8a36SMatthew G. Knepley .seealso: DMSetAdjacency(), DMGetField(), DMSetField()
498734aa8a36SMatthew G. Knepley @*/
498834aa8a36SMatthew G. Knepley PetscErrorCode DMGetAdjacency(DM dm, PetscInt f, PetscBool *useCone, PetscBool *useClosure)
498934aa8a36SMatthew G. Knepley {
499034aa8a36SMatthew G. Knepley   PetscFunctionBegin;
499134aa8a36SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4992534a8f05SLisandro Dalcin   if (useCone)    PetscValidBoolPointer(useCone, 3);
4993534a8f05SLisandro Dalcin   if (useClosure) PetscValidBoolPointer(useClosure, 4);
499434aa8a36SMatthew G. Knepley   if (f < 0) {
499534aa8a36SMatthew G. Knepley     if (useCone)    *useCone    = dm->adjacency[0];
499634aa8a36SMatthew G. Knepley     if (useClosure) *useClosure = dm->adjacency[1];
499734aa8a36SMatthew G. Knepley   } else {
499834aa8a36SMatthew G. Knepley     PetscInt       Nf;
499934aa8a36SMatthew G. Knepley     PetscErrorCode ierr;
500034aa8a36SMatthew G. Knepley 
500134aa8a36SMatthew G. Knepley     ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
500234aa8a36SMatthew G. Knepley     if (f >= Nf) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, Nf);
500334aa8a36SMatthew G. Knepley     if (useCone)    *useCone    = dm->fields[f].adjacency[0];
500434aa8a36SMatthew G. Knepley     if (useClosure) *useClosure = dm->fields[f].adjacency[1];
500534aa8a36SMatthew G. Knepley   }
500634aa8a36SMatthew G. Knepley   PetscFunctionReturn(0);
500734aa8a36SMatthew G. Knepley }
500834aa8a36SMatthew G. Knepley 
500934aa8a36SMatthew G. Knepley /*@
501034aa8a36SMatthew G. Knepley   DMSetAdjacency - Set the flags for determining variable influence
501134aa8a36SMatthew G. Knepley 
501234aa8a36SMatthew G. Knepley   Not collective
501334aa8a36SMatthew G. Knepley 
501434aa8a36SMatthew G. Knepley   Input Parameters:
501534aa8a36SMatthew G. Knepley + dm         - The DM object
501634aa8a36SMatthew G. Knepley . f          - The field number
501734aa8a36SMatthew G. Knepley . useCone    - Flag for variable influence starting with the cone operation
501834aa8a36SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
501934aa8a36SMatthew G. Knepley 
502034aa8a36SMatthew G. Knepley   Notes:
502134aa8a36SMatthew G. Knepley $     FEM:   Two points p and q are adjacent if q \in closure(star(p)),   useCone = PETSC_FALSE, useClosure = PETSC_TRUE
502234aa8a36SMatthew G. Knepley $     FVM:   Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE,  useClosure = PETSC_FALSE
502334aa8a36SMatthew G. Knepley $     FVM++: Two points p and q are adjacent if q \in star(closure(p)),   useCone = PETSC_TRUE,  useClosure = PETSC_TRUE
5024979e053dSMatthew G. Knepley   Further explanation can be found in the User's Manual Section on the Influence of Variables on One Another.
502534aa8a36SMatthew G. Knepley 
502634aa8a36SMatthew G. Knepley   Level: developer
502734aa8a36SMatthew G. Knepley 
502834aa8a36SMatthew G. Knepley .seealso: DMGetAdjacency(), DMGetField(), DMSetField()
502934aa8a36SMatthew G. Knepley @*/
503034aa8a36SMatthew G. Knepley PetscErrorCode DMSetAdjacency(DM dm, PetscInt f, PetscBool useCone, PetscBool useClosure)
503134aa8a36SMatthew G. Knepley {
503234aa8a36SMatthew G. Knepley   PetscFunctionBegin;
503334aa8a36SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
503434aa8a36SMatthew G. Knepley   if (f < 0) {
503534aa8a36SMatthew G. Knepley     dm->adjacency[0] = useCone;
503634aa8a36SMatthew G. Knepley     dm->adjacency[1] = useClosure;
503734aa8a36SMatthew G. Knepley   } else {
503834aa8a36SMatthew G. Knepley     PetscInt       Nf;
503934aa8a36SMatthew G. Knepley     PetscErrorCode ierr;
504034aa8a36SMatthew G. Knepley 
504134aa8a36SMatthew G. Knepley     ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
504234aa8a36SMatthew G. Knepley     if (f >= Nf) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, Nf);
504334aa8a36SMatthew G. Knepley     dm->fields[f].adjacency[0] = useCone;
504434aa8a36SMatthew G. Knepley     dm->fields[f].adjacency[1] = useClosure;
5045e5e52638SMatthew G. Knepley   }
5046e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5047e5e52638SMatthew G. Knepley }
5048e5e52638SMatthew G. Knepley 
5049b0441da4SMatthew G. Knepley /*@
5050b0441da4SMatthew G. Knepley   DMGetBasicAdjacency - Returns the flags for determining variable influence, using either the default or field 0 if it is defined
5051b0441da4SMatthew G. Knepley 
5052b0441da4SMatthew G. Knepley   Not collective
5053b0441da4SMatthew G. Knepley 
5054b0441da4SMatthew G. Knepley   Input Parameters:
5055b0441da4SMatthew G. Knepley . dm - The DM object
5056b0441da4SMatthew G. Knepley 
5057b0441da4SMatthew G. Knepley   Output Parameter:
5058b0441da4SMatthew G. Knepley + useCone    - Flag for variable influence starting with the cone operation
5059b0441da4SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
5060b0441da4SMatthew G. Knepley 
5061b0441da4SMatthew G. Knepley   Notes:
5062b0441da4SMatthew G. Knepley $     FEM:   Two points p and q are adjacent if q \in closure(star(p)),   useCone = PETSC_FALSE, useClosure = PETSC_TRUE
5063b0441da4SMatthew G. Knepley $     FVM:   Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE,  useClosure = PETSC_FALSE
5064b0441da4SMatthew G. Knepley $     FVM++: Two points p and q are adjacent if q \in star(closure(p)),   useCone = PETSC_TRUE,  useClosure = PETSC_TRUE
5065b0441da4SMatthew G. Knepley 
5066b0441da4SMatthew G. Knepley   Level: developer
5067b0441da4SMatthew G. Knepley 
5068b0441da4SMatthew G. Knepley .seealso: DMSetBasicAdjacency(), DMGetField(), DMSetField()
5069b0441da4SMatthew G. Knepley @*/
5070b0441da4SMatthew G. Knepley PetscErrorCode DMGetBasicAdjacency(DM dm, PetscBool *useCone, PetscBool *useClosure)
5071b0441da4SMatthew G. Knepley {
5072b0441da4SMatthew G. Knepley   PetscInt       Nf;
5073b0441da4SMatthew G. Knepley   PetscErrorCode ierr;
5074b0441da4SMatthew G. Knepley 
5075b0441da4SMatthew G. Knepley   PetscFunctionBegin;
5076b0441da4SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5077064a246eSJacob Faibussowitsch   if (useCone)    PetscValidBoolPointer(useCone, 2);
5078064a246eSJacob Faibussowitsch   if (useClosure) PetscValidBoolPointer(useClosure, 3);
5079b0441da4SMatthew G. Knepley   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
5080b0441da4SMatthew G. Knepley   if (!Nf) {
5081b0441da4SMatthew G. Knepley     ierr = DMGetAdjacency(dm, PETSC_DEFAULT, useCone, useClosure);CHKERRQ(ierr);
5082b0441da4SMatthew G. Knepley   } else {
5083b0441da4SMatthew G. Knepley     ierr = DMGetAdjacency(dm, 0, useCone, useClosure);CHKERRQ(ierr);
5084b0441da4SMatthew G. Knepley   }
5085b0441da4SMatthew G. Knepley   PetscFunctionReturn(0);
5086b0441da4SMatthew G. Knepley }
5087b0441da4SMatthew G. Knepley 
5088b0441da4SMatthew G. Knepley /*@
5089b0441da4SMatthew G. Knepley   DMSetBasicAdjacency - Set the flags for determining variable influence, using either the default or field 0 if it is defined
5090b0441da4SMatthew G. Knepley 
5091b0441da4SMatthew G. Knepley   Not collective
5092b0441da4SMatthew G. Knepley 
5093b0441da4SMatthew G. Knepley   Input Parameters:
5094b0441da4SMatthew G. Knepley + dm         - The DM object
5095b0441da4SMatthew G. Knepley . useCone    - Flag for variable influence starting with the cone operation
5096b0441da4SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
5097b0441da4SMatthew G. Knepley 
5098b0441da4SMatthew G. Knepley   Notes:
5099b0441da4SMatthew G. Knepley $     FEM:   Two points p and q are adjacent if q \in closure(star(p)),   useCone = PETSC_FALSE, useClosure = PETSC_TRUE
5100b0441da4SMatthew G. Knepley $     FVM:   Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE,  useClosure = PETSC_FALSE
5101b0441da4SMatthew G. Knepley $     FVM++: Two points p and q are adjacent if q \in star(closure(p)),   useCone = PETSC_TRUE,  useClosure = PETSC_TRUE
5102b0441da4SMatthew G. Knepley 
5103b0441da4SMatthew G. Knepley   Level: developer
5104b0441da4SMatthew G. Knepley 
5105b0441da4SMatthew G. Knepley .seealso: DMGetBasicAdjacency(), DMGetField(), DMSetField()
5106b0441da4SMatthew G. Knepley @*/
5107b0441da4SMatthew G. Knepley PetscErrorCode DMSetBasicAdjacency(DM dm, PetscBool useCone, PetscBool useClosure)
5108b0441da4SMatthew G. Knepley {
5109b0441da4SMatthew G. Knepley   PetscInt       Nf;
5110b0441da4SMatthew G. Knepley   PetscErrorCode ierr;
5111b0441da4SMatthew G. Knepley 
5112b0441da4SMatthew G. Knepley   PetscFunctionBegin;
5113b0441da4SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5114b0441da4SMatthew G. Knepley   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
5115b0441da4SMatthew G. Knepley   if (!Nf) {
5116b0441da4SMatthew G. Knepley     ierr = DMSetAdjacency(dm, PETSC_DEFAULT, useCone, useClosure);CHKERRQ(ierr);
5117b0441da4SMatthew G. Knepley   } else {
5118b0441da4SMatthew G. Knepley     ierr = DMSetAdjacency(dm, 0, useCone, useClosure);CHKERRQ(ierr);
5119e5e52638SMatthew G. Knepley   }
5120e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5121e5e52638SMatthew G. Knepley }
5122e5e52638SMatthew G. Knepley 
5123783e2ec8SMatthew G. Knepley /* Complete labels that are being used for FEM BC */
512445480ffeSMatthew G. Knepley static PetscErrorCode DMCompleteBoundaryLabel_Internal(DM dm, PetscDS ds, PetscInt field, PetscInt bdNum, DMLabel label)
5125783e2ec8SMatthew G. Knepley {
5126783e2ec8SMatthew G. Knepley   PetscObject    obj;
5127783e2ec8SMatthew G. Knepley   PetscClassId   id;
5128783e2ec8SMatthew G. Knepley   PetscInt       Nbd, bd;
5129783e2ec8SMatthew G. Knepley   PetscBool      isFE      = PETSC_FALSE;
5130783e2ec8SMatthew G. Knepley   PetscBool      duplicate = PETSC_FALSE;
5131783e2ec8SMatthew G. Knepley   PetscErrorCode ierr;
5132783e2ec8SMatthew G. Knepley 
5133783e2ec8SMatthew G. Knepley   PetscFunctionBegin;
5134783e2ec8SMatthew G. Knepley   ierr = DMGetField(dm, field, NULL, &obj);CHKERRQ(ierr);
5135783e2ec8SMatthew G. Knepley   ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr);
5136783e2ec8SMatthew G. Knepley   if (id == PETSCFE_CLASSID) isFE = PETSC_TRUE;
5137783e2ec8SMatthew G. Knepley   if (isFE && label) {
5138783e2ec8SMatthew G. Knepley     /* Only want to modify label once */
5139783e2ec8SMatthew G. Knepley     ierr = PetscDSGetNumBoundary(ds, &Nbd);CHKERRQ(ierr);
5140783e2ec8SMatthew G. Knepley     for (bd = 0; bd < PetscMin(Nbd, bdNum); ++bd) {
514145480ffeSMatthew G. Knepley       DMLabel l;
5142783e2ec8SMatthew G. Knepley 
514345480ffeSMatthew G. Knepley       ierr = PetscDSGetBoundary(ds, bd, NULL, NULL, NULL, &l, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL);CHKERRQ(ierr);
514445480ffeSMatthew G. Knepley       duplicate = l == label ? PETSC_TRUE : PETSC_FALSE;
5145783e2ec8SMatthew G. Knepley       if (duplicate) break;
5146783e2ec8SMatthew G. Knepley     }
5147783e2ec8SMatthew G. Knepley     if (!duplicate) {
5148783e2ec8SMatthew G. Knepley       DM plex;
5149783e2ec8SMatthew G. Knepley 
5150783e2ec8SMatthew G. Knepley       ierr = DMConvert(dm, DMPLEX, &plex);CHKERRQ(ierr);
5151783e2ec8SMatthew G. Knepley       if (plex) {ierr = DMPlexLabelComplete(plex, label);CHKERRQ(ierr);}
5152783e2ec8SMatthew G. Knepley       ierr = DMDestroy(&plex);CHKERRQ(ierr);
5153783e2ec8SMatthew G. Knepley     }
5154783e2ec8SMatthew G. Knepley   }
5155783e2ec8SMatthew G. Knepley   PetscFunctionReturn(0);
5156783e2ec8SMatthew G. Knepley }
5157783e2ec8SMatthew G. Knepley 
5158e5e52638SMatthew G. Knepley static PetscErrorCode DMDSEnlarge_Static(DM dm, PetscInt NdsNew)
5159e5e52638SMatthew G. Knepley {
5160e5e52638SMatthew G. Knepley   DMSpace       *tmpd;
5161e5e52638SMatthew G. Knepley   PetscInt       Nds = dm->Nds, s;
5162e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5163e5e52638SMatthew G. Knepley 
5164e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5165e5e52638SMatthew G. Knepley   if (Nds >= NdsNew) PetscFunctionReturn(0);
5166e5e52638SMatthew G. Knepley   ierr = PetscMalloc1(NdsNew, &tmpd);CHKERRQ(ierr);
5167e5e52638SMatthew G. Knepley   for (s = 0; s < Nds; ++s) tmpd[s] = dm->probs[s];
5168b3cf3223SMatthew G. Knepley   for (s = Nds; s < NdsNew; ++s) {tmpd[s].ds = NULL; tmpd[s].label = NULL; tmpd[s].fields = NULL;}
5169e5e52638SMatthew G. Knepley   ierr = PetscFree(dm->probs);CHKERRQ(ierr);
5170e5e52638SMatthew G. Knepley   dm->Nds   = NdsNew;
5171e5e52638SMatthew G. Knepley   dm->probs = tmpd;
5172e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5173e5e52638SMatthew G. Knepley }
5174e5e52638SMatthew G. Knepley 
5175e5e52638SMatthew G. Knepley /*@
5176e5e52638SMatthew G. Knepley   DMGetNumDS - Get the number of discrete systems in the DM
5177e5e52638SMatthew G. Knepley 
5178e5e52638SMatthew G. Knepley   Not collective
5179e5e52638SMatthew G. Knepley 
5180e5e52638SMatthew G. Knepley   Input Parameter:
5181e5e52638SMatthew G. Knepley . dm - The DM
5182e5e52638SMatthew G. Knepley 
5183e5e52638SMatthew G. Knepley   Output Parameter:
5184e5e52638SMatthew G. Knepley . Nds - The number of PetscDS objects
5185e5e52638SMatthew G. Knepley 
5186e5e52638SMatthew G. Knepley   Level: intermediate
5187e5e52638SMatthew G. Knepley 
5188e5e52638SMatthew G. Knepley .seealso: DMGetDS(), DMGetCellDS()
5189e5e52638SMatthew G. Knepley @*/
5190e5e52638SMatthew G. Knepley PetscErrorCode DMGetNumDS(DM dm, PetscInt *Nds)
5191e5e52638SMatthew G. Knepley {
5192e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5193e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5194534a8f05SLisandro Dalcin   PetscValidIntPointer(Nds, 2);
5195e5e52638SMatthew G. Knepley   *Nds = dm->Nds;
5196e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5197e5e52638SMatthew G. Knepley }
5198e5e52638SMatthew G. Knepley 
5199e5e52638SMatthew G. Knepley /*@
5200e5e52638SMatthew G. Knepley   DMClearDS - Remove all discrete systems from the DM
5201e5e52638SMatthew G. Knepley 
5202d083f849SBarry Smith   Logically collective on dm
5203e5e52638SMatthew G. Knepley 
5204e5e52638SMatthew G. Knepley   Input Parameter:
5205e5e52638SMatthew G. Knepley . dm - The DM
5206e5e52638SMatthew G. Knepley 
5207e5e52638SMatthew G. Knepley   Level: intermediate
5208e5e52638SMatthew G. Knepley 
5209e5e52638SMatthew G. Knepley .seealso: DMGetNumDS(), DMGetDS(), DMSetField()
5210e5e52638SMatthew G. Knepley @*/
5211e5e52638SMatthew G. Knepley PetscErrorCode DMClearDS(DM dm)
5212e5e52638SMatthew G. Knepley {
5213e5e52638SMatthew G. Knepley   PetscInt       s;
5214e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5215e5e52638SMatthew G. Knepley 
5216e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5217e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5218e5e52638SMatthew G. Knepley   for (s = 0; s < dm->Nds; ++s) {
5219e5e52638SMatthew G. Knepley     ierr = PetscDSDestroy(&dm->probs[s].ds);CHKERRQ(ierr);
5220e5e52638SMatthew G. Knepley     ierr = DMLabelDestroy(&dm->probs[s].label);CHKERRQ(ierr);
5221b3cf3223SMatthew G. Knepley     ierr = ISDestroy(&dm->probs[s].fields);CHKERRQ(ierr);
5222e5e52638SMatthew G. Knepley   }
5223e5e52638SMatthew G. Knepley   ierr = PetscFree(dm->probs);CHKERRQ(ierr);
5224e5e52638SMatthew G. Knepley   dm->probs = NULL;
5225e5e52638SMatthew G. Knepley   dm->Nds   = 0;
5226e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5227e5e52638SMatthew G. Knepley }
5228e5e52638SMatthew G. Knepley 
5229e5e52638SMatthew G. Knepley /*@
5230e5e52638SMatthew G. Knepley   DMGetDS - Get the default PetscDS
5231e5e52638SMatthew G. Knepley 
5232e5e52638SMatthew G. Knepley   Not collective
5233e5e52638SMatthew G. Knepley 
5234e5e52638SMatthew G. Knepley   Input Parameter:
5235e5e52638SMatthew G. Knepley . dm    - The DM
5236e5e52638SMatthew G. Knepley 
5237e5e52638SMatthew G. Knepley   Output Parameter:
5238e5e52638SMatthew G. Knepley . prob - The default PetscDS
5239e5e52638SMatthew G. Knepley 
5240e5e52638SMatthew G. Knepley   Level: intermediate
5241e5e52638SMatthew G. Knepley 
5242e5e52638SMatthew G. Knepley .seealso: DMGetCellDS(), DMGetRegionDS()
5243e5e52638SMatthew G. Knepley @*/
5244e5e52638SMatthew G. Knepley PetscErrorCode DMGetDS(DM dm, PetscDS *prob)
5245e5e52638SMatthew G. Knepley {
5246b0143b4dSMatthew G. Knepley   PetscErrorCode ierr;
5247b0143b4dSMatthew G. Knepley 
5248e5e52638SMatthew G. Knepley   PetscFunctionBeginHot;
5249e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5250e5e52638SMatthew G. Knepley   PetscValidPointer(prob, 2);
5251b0143b4dSMatthew G. Knepley   if (dm->Nds <= 0) {
5252b0143b4dSMatthew G. Knepley     PetscDS ds;
5253b0143b4dSMatthew G. Knepley 
525445480ffeSMatthew G. Knepley     ierr = PetscDSCreate(PETSC_COMM_SELF, &ds);CHKERRQ(ierr);
5255b3cf3223SMatthew G. Knepley     ierr = DMSetRegionDS(dm, NULL, NULL, ds);CHKERRQ(ierr);
5256b0143b4dSMatthew G. Knepley     ierr = PetscDSDestroy(&ds);CHKERRQ(ierr);
5257b0143b4dSMatthew G. Knepley   }
5258b0143b4dSMatthew G. Knepley   *prob = dm->probs[0].ds;
5259e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5260e5e52638SMatthew G. Knepley }
5261e5e52638SMatthew G. Knepley 
5262e5e52638SMatthew G. Knepley /*@
5263e5e52638SMatthew G. Knepley   DMGetCellDS - Get the PetscDS defined on a given cell
5264e5e52638SMatthew G. Knepley 
5265e5e52638SMatthew G. Knepley   Not collective
5266e5e52638SMatthew G. Knepley 
5267e5e52638SMatthew G. Knepley   Input Parameters:
5268e5e52638SMatthew G. Knepley + dm    - The DM
5269e5e52638SMatthew G. Knepley - point - Cell for the DS
5270e5e52638SMatthew G. Knepley 
5271e5e52638SMatthew G. Knepley   Output Parameter:
5272e5e52638SMatthew G. Knepley . prob - The PetscDS defined on the given cell
5273e5e52638SMatthew G. Knepley 
5274e5e52638SMatthew G. Knepley   Level: developer
5275e5e52638SMatthew G. Knepley 
5276b0143b4dSMatthew G. Knepley .seealso: DMGetDS(), DMSetRegionDS()
5277e5e52638SMatthew G. Knepley @*/
5278e5e52638SMatthew G. Knepley PetscErrorCode DMGetCellDS(DM dm, PetscInt point, PetscDS *prob)
5279e5e52638SMatthew G. Knepley {
5280e5e52638SMatthew G. Knepley   PetscDS        probDef = NULL;
5281e5e52638SMatthew G. Knepley   PetscInt       s;
5282e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5283e5e52638SMatthew G. Knepley 
5284e5e52638SMatthew G. Knepley   PetscFunctionBeginHot;
5285e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5286e5e52638SMatthew G. Knepley   PetscValidPointer(prob, 3);
5287360cf244SMatthew G. Knepley   if (point < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Mesh point cannot be negative: %D", point);
5288e5e52638SMatthew G. Knepley   *prob = NULL;
5289e5e52638SMatthew G. Knepley   for (s = 0; s < dm->Nds; ++s) {
5290e5e52638SMatthew G. Knepley     PetscInt val;
5291e5e52638SMatthew G. Knepley 
5292e5e52638SMatthew G. Knepley     if (!dm->probs[s].label) {probDef = dm->probs[s].ds;}
5293e5e52638SMatthew G. Knepley     else {
5294e5e52638SMatthew G. Knepley       ierr = DMLabelGetValue(dm->probs[s].label, point, &val);CHKERRQ(ierr);
5295e5e52638SMatthew G. Knepley       if (val >= 0) {*prob = dm->probs[s].ds; break;}
5296e5e52638SMatthew G. Knepley     }
5297e5e52638SMatthew G. Knepley   }
5298e5e52638SMatthew G. Knepley   if (!*prob) *prob = probDef;
5299e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5300e5e52638SMatthew G. Knepley }
5301e5e52638SMatthew G. Knepley 
5302e5e52638SMatthew G. Knepley /*@
5303e5e52638SMatthew G. Knepley   DMGetRegionDS - Get the PetscDS for a given mesh region, defined by a DMLabel
5304e5e52638SMatthew G. Knepley 
5305e5e52638SMatthew G. Knepley   Not collective
5306e5e52638SMatthew G. Knepley 
5307e5e52638SMatthew G. Knepley   Input Parameters:
5308e5e52638SMatthew G. Knepley + dm    - The DM
5309e5e52638SMatthew G. Knepley - label - The DMLabel defining the mesh region, or NULL for the entire mesh
5310e5e52638SMatthew G. Knepley 
5311b3cf3223SMatthew G. Knepley   Output Parameters:
5312b3cf3223SMatthew G. Knepley + fields - The IS containing the DM field numbers for the fields in this DS, or NULL
5313b3cf3223SMatthew G. Knepley - prob - The PetscDS defined on the given region, or NULL
5314e5e52638SMatthew G. Knepley 
5315e5e52638SMatthew G. Knepley   Note: If the label is missing, this function returns an error
5316e5e52638SMatthew G. Knepley 
5317e5e52638SMatthew G. Knepley   Level: advanced
5318e5e52638SMatthew G. Knepley 
5319e5e52638SMatthew G. Knepley .seealso: DMGetRegionNumDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS()
5320e5e52638SMatthew G. Knepley @*/
5321b3cf3223SMatthew G. Knepley PetscErrorCode DMGetRegionDS(DM dm, DMLabel label, IS *fields, PetscDS *ds)
5322e5e52638SMatthew G. Knepley {
5323e5e52638SMatthew G. Knepley   PetscInt Nds = dm->Nds, s;
5324e5e52638SMatthew G. Knepley 
5325e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5326e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5327e5e52638SMatthew G. Knepley   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
5328b3cf3223SMatthew G. Knepley   if (fields) {PetscValidPointer(fields, 3); *fields = NULL;}
5329b3cf3223SMatthew G. Knepley   if (ds)     {PetscValidPointer(ds, 4);     *ds     = NULL;}
5330e5e52638SMatthew G. Knepley   for (s = 0; s < Nds; ++s) {
5331b3cf3223SMatthew G. Knepley     if (dm->probs[s].label == label) {
5332b3cf3223SMatthew G. Knepley       if (fields) *fields = dm->probs[s].fields;
5333b3cf3223SMatthew G. Knepley       if (ds)     *ds     = dm->probs[s].ds;
5334b3cf3223SMatthew G. Knepley       PetscFunctionReturn(0);
5335b3cf3223SMatthew G. Knepley     }
5336e5e52638SMatthew G. Knepley   }
53372df9ee95SMatthew G. Knepley   PetscFunctionReturn(0);
5338e5e52638SMatthew G. Knepley }
5339e5e52638SMatthew G. Knepley 
5340e5e52638SMatthew G. Knepley /*@
5341083401c6SMatthew G. Knepley   DMSetRegionDS - Set the PetscDS for a given mesh region, defined by a DMLabel
5342083401c6SMatthew G. Knepley 
5343083401c6SMatthew G. Knepley   Collective on dm
5344083401c6SMatthew G. Knepley 
5345083401c6SMatthew G. Knepley   Input Parameters:
5346083401c6SMatthew G. Knepley + dm     - The DM
5347083401c6SMatthew G. Knepley . label  - The DMLabel defining the mesh region, or NULL for the entire mesh
5348083401c6SMatthew G. Knepley . fields - The IS containing the DM field numbers for the fields in this DS, or NULL for all fields
5349083401c6SMatthew G. Knepley - prob   - The PetscDS defined on the given cell
5350083401c6SMatthew G. Knepley 
5351083401c6SMatthew 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,
5352083401c6SMatthew G. Knepley   the fields argument is ignored.
5353083401c6SMatthew G. Knepley 
5354083401c6SMatthew G. Knepley   Level: advanced
5355083401c6SMatthew G. Knepley 
5356083401c6SMatthew G. Knepley .seealso: DMGetRegionDS(), DMSetRegionNumDS(), DMGetDS(), DMGetCellDS()
5357083401c6SMatthew G. Knepley @*/
5358083401c6SMatthew G. Knepley PetscErrorCode DMSetRegionDS(DM dm, DMLabel label, IS fields, PetscDS ds)
5359083401c6SMatthew G. Knepley {
5360083401c6SMatthew G. Knepley   PetscInt       Nds = dm->Nds, s;
5361083401c6SMatthew G. Knepley   PetscErrorCode ierr;
5362083401c6SMatthew G. Knepley 
5363083401c6SMatthew G. Knepley   PetscFunctionBegin;
5364083401c6SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5365083401c6SMatthew G. Knepley   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
5366064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 4);
5367083401c6SMatthew G. Knepley   for (s = 0; s < Nds; ++s) {
5368083401c6SMatthew G. Knepley     if (dm->probs[s].label == label) {
5369083401c6SMatthew G. Knepley       ierr = PetscDSDestroy(&dm->probs[s].ds);CHKERRQ(ierr);
5370083401c6SMatthew G. Knepley       dm->probs[s].ds = ds;
5371083401c6SMatthew G. Knepley       PetscFunctionReturn(0);
5372083401c6SMatthew G. Knepley     }
5373083401c6SMatthew G. Knepley   }
5374083401c6SMatthew G. Knepley   ierr = DMDSEnlarge_Static(dm, Nds+1);CHKERRQ(ierr);
5375083401c6SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr);
5376083401c6SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) fields);CHKERRQ(ierr);
5377083401c6SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) ds);CHKERRQ(ierr);
5378083401c6SMatthew G. Knepley   if (!label) {
5379083401c6SMatthew G. Knepley     /* Put the NULL label at the front, so it is returned as the default */
5380083401c6SMatthew G. Knepley     for (s = Nds-1; s >=0; --s) dm->probs[s+1] = dm->probs[s];
5381083401c6SMatthew G. Knepley     Nds = 0;
5382083401c6SMatthew G. Knepley   }
5383083401c6SMatthew G. Knepley   dm->probs[Nds].label  = label;
5384083401c6SMatthew G. Knepley   dm->probs[Nds].fields = fields;
5385083401c6SMatthew G. Knepley   dm->probs[Nds].ds     = ds;
5386083401c6SMatthew G. Knepley   PetscFunctionReturn(0);
5387083401c6SMatthew G. Knepley }
5388083401c6SMatthew G. Knepley 
5389083401c6SMatthew G. Knepley /*@
5390e5e52638SMatthew G. Knepley   DMGetRegionNumDS - Get the PetscDS for a given mesh region, defined by the region number
5391e5e52638SMatthew G. Knepley 
5392e5e52638SMatthew G. Knepley   Not collective
5393e5e52638SMatthew G. Knepley 
5394e5e52638SMatthew G. Knepley   Input Parameters:
5395e5e52638SMatthew G. Knepley + dm  - The DM
5396e5e52638SMatthew G. Knepley - num - The region number, in [0, Nds)
5397e5e52638SMatthew G. Knepley 
5398e5e52638SMatthew G. Knepley   Output Parameters:
5399b3cf3223SMatthew G. Knepley + label  - The region label, or NULL
5400b3cf3223SMatthew G. Knepley . fields - The IS containing the DM field numbers for the fields in this DS, or NULL
5401083401c6SMatthew G. Knepley - ds     - The PetscDS defined on the given region, or NULL
5402e5e52638SMatthew G. Knepley 
5403e5e52638SMatthew G. Knepley   Level: advanced
5404e5e52638SMatthew G. Knepley 
5405e5e52638SMatthew G. Knepley .seealso: DMGetRegionDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS()
5406e5e52638SMatthew G. Knepley @*/
5407b3cf3223SMatthew G. Knepley PetscErrorCode DMGetRegionNumDS(DM dm, PetscInt num, DMLabel *label, IS *fields, PetscDS *ds)
5408e5e52638SMatthew G. Knepley {
5409e5e52638SMatthew G. Knepley   PetscInt       Nds;
5410e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5411e5e52638SMatthew G. Knepley 
5412e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5413e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5414e5e52638SMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
5415e5e52638SMatthew 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);
5416e5e52638SMatthew G. Knepley   if (label) {
5417e5e52638SMatthew G. Knepley     PetscValidPointer(label, 3);
5418e5e52638SMatthew G. Knepley     *label = dm->probs[num].label;
5419e5e52638SMatthew G. Knepley   }
5420b3cf3223SMatthew G. Knepley   if (fields) {
5421b3cf3223SMatthew G. Knepley     PetscValidPointer(fields, 4);
5422b3cf3223SMatthew G. Knepley     *fields = dm->probs[num].fields;
5423b3cf3223SMatthew G. Knepley   }
5424e5e52638SMatthew G. Knepley   if (ds) {
5425b3cf3223SMatthew G. Knepley     PetscValidPointer(ds, 5);
5426e5e52638SMatthew G. Knepley     *ds = dm->probs[num].ds;
5427e5e52638SMatthew G. Knepley   }
5428e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5429e5e52638SMatthew G. Knepley }
5430e5e52638SMatthew G. Knepley 
5431e5e52638SMatthew G. Knepley /*@
5432083401c6SMatthew G. Knepley   DMSetRegionNumDS - Set the PetscDS for a given mesh region, defined by the region number
5433e5e52638SMatthew G. Knepley 
5434083401c6SMatthew G. Knepley   Not collective
5435e5e52638SMatthew G. Knepley 
5436e5e52638SMatthew G. Knepley   Input Parameters:
5437e5e52638SMatthew G. Knepley + dm     - The DM
5438083401c6SMatthew G. Knepley . num    - The region number, in [0, Nds)
5439083401c6SMatthew G. Knepley . label  - The region label, or NULL
5440083401c6SMatthew G. Knepley . fields - The IS containing the DM field numbers for the fields in this DS, or NULL to prevent setting
5441083401c6SMatthew G. Knepley - ds     - The PetscDS defined on the given region, or NULL to prevent setting
5442e5e52638SMatthew G. Knepley 
5443e5e52638SMatthew G. Knepley   Level: advanced
5444e5e52638SMatthew G. Knepley 
5445083401c6SMatthew G. Knepley .seealso: DMGetRegionDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS()
5446e5e52638SMatthew G. Knepley @*/
5447083401c6SMatthew G. Knepley PetscErrorCode DMSetRegionNumDS(DM dm, PetscInt num, DMLabel label, IS fields, PetscDS ds)
5448e5e52638SMatthew G. Knepley {
5449083401c6SMatthew G. Knepley   PetscInt       Nds;
5450e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5451e5e52638SMatthew G. Knepley 
5452e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5453e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5454083401c6SMatthew G. Knepley   if (label) {PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 3);}
5455083401c6SMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
5456083401c6SMatthew 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);
5457e5e52638SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr);
5458083401c6SMatthew G. Knepley   ierr = DMLabelDestroy(&dm->probs[num].label);CHKERRQ(ierr);
5459083401c6SMatthew G. Knepley   dm->probs[num].label = label;
5460083401c6SMatthew G. Knepley   if (fields) {
5461083401c6SMatthew G. Knepley     PetscValidHeaderSpecific(fields, IS_CLASSID, 4);
5462b3cf3223SMatthew G. Knepley     ierr = PetscObjectReference((PetscObject) fields);CHKERRQ(ierr);
5463083401c6SMatthew G. Knepley     ierr = ISDestroy(&dm->probs[num].fields);CHKERRQ(ierr);
5464083401c6SMatthew G. Knepley     dm->probs[num].fields = fields;
5465e5e52638SMatthew G. Knepley   }
5466083401c6SMatthew G. Knepley   if (ds) {
5467083401c6SMatthew G. Knepley     PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 5);
5468083401c6SMatthew G. Knepley     ierr = PetscObjectReference((PetscObject) ds);CHKERRQ(ierr);
5469083401c6SMatthew G. Knepley     ierr = PetscDSDestroy(&dm->probs[num].ds);CHKERRQ(ierr);
5470083401c6SMatthew G. Knepley     dm->probs[num].ds = ds;
5471083401c6SMatthew G. Knepley   }
5472e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5473e5e52638SMatthew G. Knepley }
5474e5e52638SMatthew G. Knepley 
5475e5e52638SMatthew G. Knepley /*@
54761d3af9e0SMatthew G. Knepley   DMFindRegionNum - Find the region number for a given PetscDS, or -1 if it is not found.
54771d3af9e0SMatthew G. Knepley 
54781d3af9e0SMatthew G. Knepley   Not collective
54791d3af9e0SMatthew G. Knepley 
54801d3af9e0SMatthew G. Knepley   Input Parameters:
54811d3af9e0SMatthew G. Knepley + dm  - The DM
54821d3af9e0SMatthew G. Knepley - ds  - The PetscDS defined on the given region
54831d3af9e0SMatthew G. Knepley 
54841d3af9e0SMatthew G. Knepley   Output Parameter:
54851d3af9e0SMatthew G. Knepley . num - The region number, in [0, Nds), or -1 if not found
54861d3af9e0SMatthew G. Knepley 
54871d3af9e0SMatthew G. Knepley   Level: advanced
54881d3af9e0SMatthew G. Knepley 
54891d3af9e0SMatthew G. Knepley .seealso: DMGetRegionNumDS(), DMGetRegionDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS()
54901d3af9e0SMatthew G. Knepley @*/
54911d3af9e0SMatthew G. Knepley PetscErrorCode DMFindRegionNum(DM dm, PetscDS ds, PetscInt *num)
54921d3af9e0SMatthew G. Knepley {
54931d3af9e0SMatthew G. Knepley   PetscInt       Nds, n;
54941d3af9e0SMatthew G. Knepley   PetscErrorCode ierr;
54951d3af9e0SMatthew G. Knepley 
54961d3af9e0SMatthew G. Knepley   PetscFunctionBegin;
54971d3af9e0SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
54981d3af9e0SMatthew G. Knepley   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 2);
54991d3af9e0SMatthew G. Knepley   PetscValidPointer(num, 3);
55001d3af9e0SMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
55011d3af9e0SMatthew G. Knepley   for (n = 0; n < Nds; ++n) if (ds == dm->probs[n].ds) break;
55021d3af9e0SMatthew G. Knepley   if (n >= Nds) *num = -1;
55031d3af9e0SMatthew G. Knepley   else          *num = n;
55041d3af9e0SMatthew G. Knepley   PetscFunctionReturn(0);
55051d3af9e0SMatthew G. Knepley }
55061d3af9e0SMatthew G. Knepley 
55071d3af9e0SMatthew G. Knepley /*@
5508e5e52638SMatthew G. Knepley   DMCreateDS - Create the discrete systems for the DM based upon the fields added to the DM
5509e5e52638SMatthew G. Knepley 
5510d083f849SBarry Smith   Collective on dm
5511e5e52638SMatthew G. Knepley 
5512e5e52638SMatthew G. Knepley   Input Parameter:
5513e5e52638SMatthew G. Knepley . dm - The DM
5514e5e52638SMatthew G. Knepley 
551545480ffeSMatthew G. Knepley   Options Database Keys:
551645480ffeSMatthew G. Knepley . -dm_petscds_view - View all the PetscDS objects in this DM
551745480ffeSMatthew G. Knepley 
5518e5e52638SMatthew G. Knepley   Note: If the label has a DS defined, it will be replaced. Otherwise, it will be added to the DM.
5519e5e52638SMatthew G. Knepley 
5520e5e52638SMatthew G. Knepley   Level: intermediate
5521e5e52638SMatthew G. Knepley 
5522e5e52638SMatthew G. Knepley .seealso: DMSetField, DMAddField(), DMGetDS(), DMGetCellDS(), DMGetRegionDS(), DMSetRegionDS()
5523e5e52638SMatthew G. Knepley @*/
5524e5e52638SMatthew G. Knepley PetscErrorCode DMCreateDS(DM dm)
5525e5e52638SMatthew G. Knepley {
5526e5e52638SMatthew G. Knepley   MPI_Comm       comm;
5527083401c6SMatthew G. Knepley   PetscDS        dsDef;
5528083401c6SMatthew G. Knepley   DMLabel       *labelSet;
5529f9244615SMatthew G. Knepley   PetscInt       dE, Nf = dm->Nf, f, s, Nl, l, Ndef, k;
5530f9244615SMatthew G. Knepley   PetscBool      doSetup = PETSC_TRUE, flg;
5531e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5532e5e52638SMatthew G. Knepley 
5533e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5534e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5535e5e52638SMatthew G. Knepley   if (!dm->fields) PetscFunctionReturn(0);
5536e5e52638SMatthew G. Knepley   ierr = PetscObjectGetComm((PetscObject) dm, &comm);CHKERRQ(ierr);
5537083401c6SMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &dE);CHKERRQ(ierr);
5538083401c6SMatthew G. Knepley   /* Determine how many regions we have */
5539083401c6SMatthew G. Knepley   ierr = PetscMalloc1(Nf, &labelSet);CHKERRQ(ierr);
5540083401c6SMatthew G. Knepley   Nl   = 0;
5541083401c6SMatthew G. Knepley   Ndef = 0;
5542083401c6SMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
5543083401c6SMatthew G. Knepley     DMLabel  label = dm->fields[f].label;
5544083401c6SMatthew G. Knepley     PetscInt l;
5545083401c6SMatthew G. Knepley 
5546f918ec44SMatthew G. Knepley #ifdef PETSC_HAVE_LIBCEED
5547f918ec44SMatthew G. Knepley     /* Move CEED context to discretizations */
5548f918ec44SMatthew G. Knepley     {
5549f918ec44SMatthew G. Knepley       PetscClassId id;
5550f918ec44SMatthew G. Knepley 
5551f918ec44SMatthew G. Knepley       ierr = PetscObjectGetClassId(dm->fields[f].disc, &id);CHKERRQ(ierr);
5552f918ec44SMatthew G. Knepley       if (id == PETSCFE_CLASSID) {
5553f918ec44SMatthew G. Knepley         Ceed ceed;
5554f918ec44SMatthew G. Knepley 
5555f918ec44SMatthew G. Knepley         ierr = DMGetCeed(dm, &ceed);CHKERRQ(ierr);
5556f918ec44SMatthew G. Knepley         ierr = PetscFESetCeed((PetscFE) dm->fields[f].disc, ceed);CHKERRQ(ierr);
5557f918ec44SMatthew G. Knepley       }
5558f918ec44SMatthew G. Knepley     }
5559f918ec44SMatthew G. Knepley #endif
5560083401c6SMatthew G. Knepley     if (!label) {++Ndef; continue;}
5561083401c6SMatthew G. Knepley     for (l = 0; l < Nl; ++l) if (label == labelSet[l]) break;
5562083401c6SMatthew G. Knepley     if (l < Nl) continue;
5563083401c6SMatthew G. Knepley     labelSet[Nl++] = label;
5564083401c6SMatthew G. Knepley   }
5565083401c6SMatthew G. Knepley   /* Create default DS if there are no labels to intersect with */
5566083401c6SMatthew G. Knepley   ierr = DMGetRegionDS(dm, NULL, NULL, &dsDef);CHKERRQ(ierr);
5567083401c6SMatthew G. Knepley   if (!dsDef && Ndef && !Nl) {
5568b3cf3223SMatthew G. Knepley     IS        fields;
5569b3cf3223SMatthew G. Knepley     PetscInt *fld, nf;
5570b3cf3223SMatthew G. Knepley 
5571b3cf3223SMatthew G. Knepley     for (f = 0, nf = 0; f < Nf; ++f) if (!dm->fields[f].label) ++nf;
5572083401c6SMatthew G. Knepley     if (nf) {
5573b3cf3223SMatthew G. Knepley       ierr = PetscMalloc1(nf, &fld);CHKERRQ(ierr);
5574b3cf3223SMatthew G. Knepley       for (f = 0, nf = 0; f < Nf; ++f) if (!dm->fields[f].label) fld[nf++] = f;
557588f0c812SMatthew G. Knepley       ierr = ISCreate(PETSC_COMM_SELF, &fields);CHKERRQ(ierr);
557688f0c812SMatthew G. Knepley       ierr = PetscObjectSetOptionsPrefix((PetscObject) fields, "dm_fields_");CHKERRQ(ierr);
557788f0c812SMatthew G. Knepley       ierr = ISSetType(fields, ISGENERAL);CHKERRQ(ierr);
557888f0c812SMatthew G. Knepley       ierr = ISGeneralSetIndices(fields, nf, fld, PETSC_OWN_POINTER);CHKERRQ(ierr);
557988f0c812SMatthew G. Knepley 
558045480ffeSMatthew G. Knepley       ierr = PetscDSCreate(PETSC_COMM_SELF, &dsDef);CHKERRQ(ierr);
5581083401c6SMatthew G. Knepley       ierr = DMSetRegionDS(dm, NULL, fields, dsDef);CHKERRQ(ierr);
5582083401c6SMatthew G. Knepley       ierr = PetscDSDestroy(&dsDef);CHKERRQ(ierr);
5583b3cf3223SMatthew G. Knepley       ierr = ISDestroy(&fields);CHKERRQ(ierr);
55842df9ee95SMatthew G. Knepley     }
5585083401c6SMatthew G. Knepley   }
5586083401c6SMatthew G. Knepley   ierr = DMGetRegionDS(dm, NULL, NULL, &dsDef);CHKERRQ(ierr);
5587083401c6SMatthew G. Knepley   if (dsDef) {ierr = PetscDSSetCoordinateDimension(dsDef, dE);CHKERRQ(ierr);}
5588083401c6SMatthew G. Knepley   /* Intersect labels with default fields */
5589083401c6SMatthew G. Knepley   if (Ndef && Nl) {
55900122748bSMatthew G. Knepley     DM              plex;
5591083401c6SMatthew G. Knepley     DMLabel         cellLabel;
5592083401c6SMatthew G. Knepley     IS              fieldIS, allcellIS, defcellIS = NULL;
5593083401c6SMatthew G. Knepley     PetscInt       *fields;
5594083401c6SMatthew G. Knepley     const PetscInt *cells;
5595083401c6SMatthew G. Knepley     PetscInt        depth, nf = 0, n, c;
55960122748bSMatthew G. Knepley 
55970122748bSMatthew G. Knepley     ierr = DMConvert(dm, DMPLEX, &plex);CHKERRQ(ierr);
55980122748bSMatthew G. Knepley     ierr = DMPlexGetDepth(plex, &depth);CHKERRQ(ierr);
5599083401c6SMatthew G. Knepley     ierr = DMGetStratumIS(plex, "dim", depth, &allcellIS);CHKERRQ(ierr);
5600083401c6SMatthew G. Knepley     if (!allcellIS) {ierr = DMGetStratumIS(plex, "depth", depth, &allcellIS);CHKERRQ(ierr);}
5601083401c6SMatthew G. Knepley     for (l = 0; l < Nl; ++l) {
5602083401c6SMatthew G. Knepley       DMLabel label = labelSet[l];
5603083401c6SMatthew G. Knepley       IS      pointIS;
5604083401c6SMatthew G. Knepley 
5605083401c6SMatthew G. Knepley       ierr = ISDestroy(&defcellIS);CHKERRQ(ierr);
5606083401c6SMatthew G. Knepley       ierr = DMLabelGetStratumIS(label, 1, &pointIS);CHKERRQ(ierr);
5607083401c6SMatthew G. Knepley       ierr = ISDifference(allcellIS, pointIS, &defcellIS);CHKERRQ(ierr);
5608083401c6SMatthew G. Knepley       ierr = ISDestroy(&pointIS);CHKERRQ(ierr);
5609083401c6SMatthew G. Knepley     }
5610083401c6SMatthew G. Knepley     ierr = ISDestroy(&allcellIS);CHKERRQ(ierr);
5611083401c6SMatthew G. Knepley 
5612083401c6SMatthew G. Knepley     ierr = DMLabelCreate(PETSC_COMM_SELF, "defaultCells", &cellLabel);CHKERRQ(ierr);
5613083401c6SMatthew G. Knepley     ierr = ISGetLocalSize(defcellIS, &n);CHKERRQ(ierr);
5614083401c6SMatthew G. Knepley     ierr = ISGetIndices(defcellIS, &cells);CHKERRQ(ierr);
5615083401c6SMatthew G. Knepley     for (c = 0; c < n; ++c) {ierr = DMLabelSetValue(cellLabel, cells[c], 1);CHKERRQ(ierr);}
5616083401c6SMatthew G. Knepley     ierr = ISRestoreIndices(defcellIS, &cells);CHKERRQ(ierr);
5617083401c6SMatthew G. Knepley     ierr = ISDestroy(&defcellIS);CHKERRQ(ierr);
5618083401c6SMatthew G. Knepley     ierr = DMPlexLabelComplete(plex, cellLabel);CHKERRQ(ierr);
5619083401c6SMatthew G. Knepley 
5620083401c6SMatthew G. Knepley     ierr = PetscMalloc1(Ndef, &fields);CHKERRQ(ierr);
5621083401c6SMatthew G. Knepley     for (f = 0; f < Nf; ++f) if (!dm->fields[f].label) fields[nf++] = f;
5622083401c6SMatthew G. Knepley     ierr = ISCreate(PETSC_COMM_SELF, &fieldIS);CHKERRQ(ierr);
5623083401c6SMatthew G. Knepley     ierr = PetscObjectSetOptionsPrefix((PetscObject) fieldIS, "dm_fields_");CHKERRQ(ierr);
5624083401c6SMatthew G. Knepley     ierr = ISSetType(fieldIS, ISGENERAL);CHKERRQ(ierr);
5625083401c6SMatthew G. Knepley     ierr = ISGeneralSetIndices(fieldIS, nf, fields, PETSC_OWN_POINTER);CHKERRQ(ierr);
5626083401c6SMatthew G. Knepley 
562745480ffeSMatthew G. Knepley     ierr = PetscDSCreate(PETSC_COMM_SELF, &dsDef);CHKERRQ(ierr);
5628083401c6SMatthew G. Knepley     ierr = DMSetRegionDS(dm, cellLabel, fieldIS, dsDef);CHKERRQ(ierr);
5629083401c6SMatthew G. Knepley     ierr = DMLabelDestroy(&cellLabel);CHKERRQ(ierr);
5630083401c6SMatthew G. Knepley     ierr = PetscDSSetCoordinateDimension(dsDef, dE);CHKERRQ(ierr);
5631083401c6SMatthew G. Knepley     ierr = PetscDSDestroy(&dsDef);CHKERRQ(ierr);
5632083401c6SMatthew G. Knepley     ierr = ISDestroy(&fieldIS);CHKERRQ(ierr);
56330122748bSMatthew G. Knepley     ierr = DMDestroy(&plex);CHKERRQ(ierr);
5634083401c6SMatthew G. Knepley   }
5635083401c6SMatthew G. Knepley   /* Create label DSes
5636083401c6SMatthew G. Knepley      - WE ONLY SUPPORT IDENTICAL OR DISJOINT LABELS
5637083401c6SMatthew G. Knepley   */
5638083401c6SMatthew G. Knepley   /* TODO Should check that labels are disjoint */
5639083401c6SMatthew G. Knepley   for (l = 0; l < Nl; ++l) {
5640083401c6SMatthew G. Knepley     DMLabel   label = labelSet[l];
5641083401c6SMatthew G. Knepley     PetscDS   ds;
5642083401c6SMatthew G. Knepley     IS        fields;
5643083401c6SMatthew G. Knepley     PetscInt *fld, nf;
5644083401c6SMatthew G. Knepley 
564545480ffeSMatthew G. Knepley     ierr = PetscDSCreate(PETSC_COMM_SELF, &ds);CHKERRQ(ierr);
5646083401c6SMatthew G. Knepley     for (f = 0, nf = 0; f < Nf; ++f) if (label == dm->fields[f].label || !dm->fields[f].label) ++nf;
5647083401c6SMatthew G. Knepley     ierr = PetscMalloc1(nf, &fld);CHKERRQ(ierr);
5648083401c6SMatthew G. Knepley     for (f = 0, nf = 0; f < Nf; ++f) if (label == dm->fields[f].label || !dm->fields[f].label) fld[nf++] = f;
5649083401c6SMatthew G. Knepley     ierr = ISCreate(PETSC_COMM_SELF, &fields);CHKERRQ(ierr);
5650083401c6SMatthew G. Knepley     ierr = PetscObjectSetOptionsPrefix((PetscObject) fields, "dm_fields_");CHKERRQ(ierr);
5651083401c6SMatthew G. Knepley     ierr = ISSetType(fields, ISGENERAL);CHKERRQ(ierr);
5652083401c6SMatthew G. Knepley     ierr = ISGeneralSetIndices(fields, nf, fld, PETSC_OWN_POINTER);CHKERRQ(ierr);
5653083401c6SMatthew G. Knepley     ierr = DMSetRegionDS(dm, label, fields, ds);CHKERRQ(ierr);
5654083401c6SMatthew G. Knepley     ierr = ISDestroy(&fields);CHKERRQ(ierr);
5655083401c6SMatthew G. Knepley     ierr = PetscDSSetCoordinateDimension(ds, dE);CHKERRQ(ierr);
5656083401c6SMatthew G. Knepley     {
5657083401c6SMatthew G. Knepley       DMPolytopeType ct;
5658083401c6SMatthew G. Knepley       PetscInt       lStart, lEnd;
5659083401c6SMatthew G. Knepley       PetscBool      isHybridLocal = PETSC_FALSE, isHybrid;
56600122748bSMatthew G. Knepley 
5661e5e52638SMatthew G. Knepley       ierr = DMLabelGetBounds(label, &lStart, &lEnd);CHKERRQ(ierr);
5662665f567fSMatthew G. Knepley       if (lStart >= 0) {
5663412e9a14SMatthew G. Knepley         ierr = DMPlexGetCellType(dm, lStart, &ct);CHKERRQ(ierr);
5664412e9a14SMatthew G. Knepley         switch (ct) {
5665412e9a14SMatthew G. Knepley           case DM_POLYTOPE_POINT_PRISM_TENSOR:
5666412e9a14SMatthew G. Knepley           case DM_POLYTOPE_SEG_PRISM_TENSOR:
5667412e9a14SMatthew G. Knepley           case DM_POLYTOPE_TRI_PRISM_TENSOR:
5668412e9a14SMatthew G. Knepley           case DM_POLYTOPE_QUAD_PRISM_TENSOR:
5669083401c6SMatthew G. Knepley             isHybridLocal = PETSC_TRUE;break;
5670083401c6SMatthew G. Knepley           default: break;
5671412e9a14SMatthew G. Knepley         }
5672665f567fSMatthew G. Knepley       }
5673ffc4695bSBarry Smith       ierr = MPI_Allreduce(&isHybridLocal, &isHybrid, 1, MPIU_BOOL, MPI_LOR, comm);CHKERRMPI(ierr);
5674083401c6SMatthew G. Knepley       ierr = PetscDSSetHybrid(ds, isHybrid);CHKERRQ(ierr);
5675e5e52638SMatthew G. Knepley     }
5676083401c6SMatthew G. Knepley     ierr = PetscDSDestroy(&ds);CHKERRQ(ierr);
5677e5e52638SMatthew G. Knepley   }
5678083401c6SMatthew G. Knepley   ierr = PetscFree(labelSet);CHKERRQ(ierr);
5679e5e52638SMatthew G. Knepley   /* Set fields in DSes */
5680083401c6SMatthew G. Knepley   for (s = 0; s < dm->Nds; ++s) {
5681083401c6SMatthew G. Knepley     PetscDS         ds     = dm->probs[s].ds;
5682083401c6SMatthew G. Knepley     IS              fields = dm->probs[s].fields;
5683083401c6SMatthew G. Knepley     const PetscInt *fld;
5684083401c6SMatthew G. Knepley     PetscInt        nf;
5685e5e52638SMatthew G. Knepley 
5686083401c6SMatthew G. Knepley     ierr = ISGetLocalSize(fields, &nf);CHKERRQ(ierr);
5687083401c6SMatthew G. Knepley     ierr = ISGetIndices(fields, &fld);CHKERRQ(ierr);
5688083401c6SMatthew G. Knepley     for (f = 0; f < nf; ++f) {
5689083401c6SMatthew G. Knepley       PetscObject  disc  = dm->fields[fld[f]].disc;
5690083401c6SMatthew G. Knepley       PetscBool    isHybrid;
5691e5e52638SMatthew G. Knepley       PetscClassId id;
5692e5e52638SMatthew G. Knepley 
5693083401c6SMatthew G. Knepley       ierr = PetscDSGetHybrid(ds, &isHybrid);CHKERRQ(ierr);
5694083401c6SMatthew G. Knepley       /* If this is a cohesive cell, then it needs the lower dimensional discretization */
5695083401c6SMatthew G. Knepley       if (isHybrid && f < nf-1) {ierr = PetscFEGetHeightSubspace((PetscFE) disc, 1, (PetscFE *) &disc);CHKERRQ(ierr);}
5696083401c6SMatthew G. Knepley       ierr = PetscDSSetDiscretization(ds, f, disc);CHKERRQ(ierr);
5697083401c6SMatthew G. Knepley       /* We allow people to have placeholder fields and construct the Section by hand */
5698e5e52638SMatthew G. Knepley       ierr = PetscObjectGetClassId(disc, &id);CHKERRQ(ierr);
5699e5e52638SMatthew G. Knepley       if ((id != PETSCFE_CLASSID) && (id != PETSCFV_CLASSID)) doSetup = PETSC_FALSE;
5700e5e52638SMatthew G. Knepley     }
5701083401c6SMatthew G. Knepley     ierr = ISRestoreIndices(fields, &fld);CHKERRQ(ierr);
5702e5e52638SMatthew G. Knepley   }
5703f9244615SMatthew G. Knepley   /* Allow k-jet tabulation */
5704f9244615SMatthew G. Knepley   ierr = PetscOptionsGetInt(NULL, ((PetscObject) dm)->prefix, "-dm_ds_jet_degree", &k, &flg);CHKERRQ(ierr);
5705f9244615SMatthew G. Knepley   if (flg) {
57063b4aee56SMatthew G. Knepley     for (s = 0; s < dm->Nds; ++s) {
57073b4aee56SMatthew G. Knepley       PetscDS  ds = dm->probs[s].ds;
57083b4aee56SMatthew G. Knepley       PetscInt Nf, f;
57093b4aee56SMatthew G. Knepley 
57103b4aee56SMatthew G. Knepley       ierr = PetscDSGetNumFields(ds, &Nf);CHKERRQ(ierr);
57113b4aee56SMatthew G. Knepley       for (f = 0; f < Nf; ++f) {ierr = PetscDSSetJetDegree(ds, f, k);CHKERRQ(ierr);}
57123b4aee56SMatthew G. Knepley     }
5713f9244615SMatthew G. Knepley   }
5714e5e52638SMatthew G. Knepley   /* Setup DSes */
5715e5e52638SMatthew G. Knepley   if (doSetup) {
5716e5e52638SMatthew G. Knepley     for (s = 0; s < dm->Nds; ++s) {ierr = PetscDSSetUp(dm->probs[s].ds);CHKERRQ(ierr);}
5717e5e52638SMatthew G. Knepley   }
5718e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5719e5e52638SMatthew G. Knepley }
5720e5e52638SMatthew G. Knepley 
5721e5e52638SMatthew G. Knepley /*@
57227f96f943SMatthew G. Knepley   DMComputeExactSolution - Compute the exact solution for a given DM, using the PetscDS information.
57237f96f943SMatthew G. Knepley 
5724f2cacb80SMatthew G. Knepley   Collective on DM
5725f2cacb80SMatthew G. Knepley 
57267f96f943SMatthew G. Knepley   Input Parameters:
57277f96f943SMatthew G. Knepley + dm   - The DM
57287f96f943SMatthew G. Knepley - time - The time
57297f96f943SMatthew G. Knepley 
57307f96f943SMatthew G. Knepley   Output Parameters:
5731f2cacb80SMatthew G. Knepley + u    - The vector will be filled with exact solution values, or NULL
5732f2cacb80SMatthew G. Knepley - u_t  - The vector will be filled with the time derivative of exact solution values, or NULL
57337f96f943SMatthew G. Knepley 
57347f96f943SMatthew G. Knepley   Note: The user must call PetscDSSetExactSolution() beforehand
57357f96f943SMatthew G. Knepley 
57367f96f943SMatthew G. Knepley   Level: developer
57377f96f943SMatthew G. Knepley 
57387f96f943SMatthew G. Knepley .seealso: PetscDSSetExactSolution()
57397f96f943SMatthew G. Knepley @*/
5740f2cacb80SMatthew G. Knepley PetscErrorCode DMComputeExactSolution(DM dm, PetscReal time, Vec u, Vec u_t)
57417f96f943SMatthew G. Knepley {
57427f96f943SMatthew G. Knepley   PetscErrorCode (**exacts)(PetscInt, PetscReal, const PetscReal x[], PetscInt, PetscScalar *u, void *ctx);
57437f96f943SMatthew G. Knepley   void            **ectxs;
57447f96f943SMatthew G. Knepley   PetscInt          Nf, Nds, s;
57457f96f943SMatthew G. Knepley   PetscErrorCode    ierr;
57467f96f943SMatthew G. Knepley 
57477f96f943SMatthew G. Knepley   PetscFunctionBegin;
5748f2cacb80SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5749f2cacb80SMatthew G. Knepley   if (u)   PetscValidHeaderSpecific(u, VEC_CLASSID, 3);
5750f2cacb80SMatthew G. Knepley   if (u_t) PetscValidHeaderSpecific(u_t, VEC_CLASSID, 4);
57517f96f943SMatthew G. Knepley   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
57527f96f943SMatthew G. Knepley   ierr = PetscMalloc2(Nf, &exacts, Nf, &ectxs);CHKERRQ(ierr);
57537f96f943SMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
57547f96f943SMatthew G. Knepley   for (s = 0; s < Nds; ++s) {
57557f96f943SMatthew G. Knepley     PetscDS         ds;
57567f96f943SMatthew G. Knepley     DMLabel         label;
57577f96f943SMatthew G. Knepley     IS              fieldIS;
57587f96f943SMatthew G. Knepley     const PetscInt *fields, id = 1;
57597f96f943SMatthew G. Knepley     PetscInt        dsNf, f;
57607f96f943SMatthew G. Knepley 
57617f96f943SMatthew G. Knepley     ierr = DMGetRegionNumDS(dm, s, &label, &fieldIS, &ds);CHKERRQ(ierr);
57627f96f943SMatthew G. Knepley     ierr = PetscDSGetNumFields(ds, &dsNf);CHKERRQ(ierr);
57637f96f943SMatthew G. Knepley     ierr = ISGetIndices(fieldIS, &fields);CHKERRQ(ierr);
57647f96f943SMatthew G. Knepley     ierr = PetscArrayzero(exacts, Nf);CHKERRQ(ierr);
57657f96f943SMatthew G. Knepley     ierr = PetscArrayzero(ectxs, Nf);CHKERRQ(ierr);
5766f2cacb80SMatthew G. Knepley     if (u) {
57677f96f943SMatthew G. Knepley       for (f = 0; f < dsNf; ++f) {
57687f96f943SMatthew G. Knepley         const PetscInt field = fields[f];
57697f96f943SMatthew G. Knepley         ierr = PetscDSGetExactSolution(ds, field, &exacts[field], &ectxs[field]);CHKERRQ(ierr);
57707f96f943SMatthew G. Knepley       }
57717f96f943SMatthew G. Knepley       ierr = ISRestoreIndices(fieldIS, &fields);CHKERRQ(ierr);
57727f96f943SMatthew G. Knepley       if (label) {
57737f96f943SMatthew G. Knepley         ierr = DMProjectFunctionLabel(dm, time, label, 1, &id, 0, NULL, exacts, ectxs, INSERT_ALL_VALUES, u);CHKERRQ(ierr);
57747f96f943SMatthew G. Knepley       } else {
57757f96f943SMatthew G. Knepley         ierr = DMProjectFunction(dm, time, exacts, ectxs, INSERT_ALL_VALUES, u);CHKERRQ(ierr);
57767f96f943SMatthew G. Knepley       }
57777f96f943SMatthew G. Knepley     }
5778f2cacb80SMatthew G. Knepley     if (u_t) {
5779f2cacb80SMatthew G. Knepley       ierr = PetscArrayzero(exacts, Nf);CHKERRQ(ierr);
5780f2cacb80SMatthew G. Knepley       ierr = PetscArrayzero(ectxs, Nf);CHKERRQ(ierr);
5781f2cacb80SMatthew G. Knepley       for (f = 0; f < dsNf; ++f) {
5782f2cacb80SMatthew G. Knepley         const PetscInt field = fields[f];
5783f2cacb80SMatthew G. Knepley         ierr = PetscDSGetExactSolutionTimeDerivative(ds, field, &exacts[field], &ectxs[field]);CHKERRQ(ierr);
5784f2cacb80SMatthew G. Knepley       }
5785f2cacb80SMatthew G. Knepley       ierr = ISRestoreIndices(fieldIS, &fields);CHKERRQ(ierr);
5786f2cacb80SMatthew G. Knepley       if (label) {
5787f2cacb80SMatthew G. Knepley         ierr = DMProjectFunctionLabel(dm, time, label, 1, &id, 0, NULL, exacts, ectxs, INSERT_ALL_VALUES, u_t);CHKERRQ(ierr);
5788f2cacb80SMatthew G. Knepley       } else {
5789f2cacb80SMatthew G. Knepley         ierr = DMProjectFunction(dm, time, exacts, ectxs, INSERT_ALL_VALUES, u_t);CHKERRQ(ierr);
5790f2cacb80SMatthew G. Knepley       }
5791f2cacb80SMatthew G. Knepley     }
5792f2cacb80SMatthew G. Knepley   }
5793f2cacb80SMatthew G. Knepley   if (u) {
57947f96f943SMatthew G. Knepley     ierr = PetscObjectSetName((PetscObject) u, "Exact Solution");CHKERRQ(ierr);
57957f96f943SMatthew G. Knepley     ierr = PetscObjectSetOptionsPrefix((PetscObject) u, "exact_");CHKERRQ(ierr);
5796f2cacb80SMatthew G. Knepley   }
5797f2cacb80SMatthew G. Knepley   if (u_t) {
5798f2cacb80SMatthew G. Knepley     ierr = PetscObjectSetName((PetscObject) u, "Exact Solution Time Derivative");CHKERRQ(ierr);
5799f2cacb80SMatthew G. Knepley     ierr = PetscObjectSetOptionsPrefix((PetscObject) u_t, "exact_t_");CHKERRQ(ierr);
5800f2cacb80SMatthew G. Knepley   }
58017f96f943SMatthew G. Knepley   ierr = PetscFree2(exacts, ectxs);CHKERRQ(ierr);
58027f96f943SMatthew G. Knepley   PetscFunctionReturn(0);
58037f96f943SMatthew G. Knepley }
58047f96f943SMatthew G. Knepley 
580545480ffeSMatthew G. Knepley PetscErrorCode DMTransferDS_Internal(DM dm, DMLabel label, IS fields, PetscDS ds)
580645480ffeSMatthew G. Knepley {
580745480ffeSMatthew G. Knepley   PetscDS        dsNew;
580845480ffeSMatthew G. Knepley   DSBoundary     b;
580945480ffeSMatthew G. Knepley   PetscInt       cdim, Nf, f;
5810df911668SMatthew G. Knepley   PetscBool      isHybrid;
581145480ffeSMatthew G. Knepley   void          *ctx;
581245480ffeSMatthew G. Knepley   PetscErrorCode ierr;
581345480ffeSMatthew G. Knepley 
581445480ffeSMatthew G. Knepley   PetscFunctionBegin;
581545480ffeSMatthew G. Knepley   ierr = PetscDSCreate(PetscObjectComm((PetscObject) ds), &dsNew);CHKERRQ(ierr);
581645480ffeSMatthew G. Knepley   ierr = PetscDSCopyConstants(ds, dsNew);CHKERRQ(ierr);
581745480ffeSMatthew G. Knepley   ierr = PetscDSCopyExactSolutions(ds, dsNew);CHKERRQ(ierr);
581845480ffeSMatthew G. Knepley   ierr = PetscDSSelectDiscretizations(ds, PETSC_DETERMINE, NULL, dsNew);CHKERRQ(ierr);
581945480ffeSMatthew G. Knepley   ierr = PetscDSCopyEquations(ds, dsNew);CHKERRQ(ierr);
582045480ffeSMatthew G. Knepley   ierr = PetscDSGetNumFields(ds, &Nf);CHKERRQ(ierr);
582145480ffeSMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
582245480ffeSMatthew G. Knepley     ierr = PetscDSGetContext(ds, f, &ctx);CHKERRQ(ierr);
582345480ffeSMatthew G. Knepley     ierr = PetscDSSetContext(dsNew, f, ctx);CHKERRQ(ierr);
582445480ffeSMatthew G. Knepley   }
582545480ffeSMatthew G. Knepley   if (Nf) {
582645480ffeSMatthew G. Knepley     ierr = PetscDSGetCoordinateDimension(ds, &cdim);CHKERRQ(ierr);
582745480ffeSMatthew G. Knepley     ierr = PetscDSSetCoordinateDimension(dsNew, cdim);CHKERRQ(ierr);
582845480ffeSMatthew G. Knepley   }
582945480ffeSMatthew G. Knepley   ierr = PetscDSCopyBoundary(ds, PETSC_DETERMINE, NULL, dsNew);CHKERRQ(ierr);
583045480ffeSMatthew G. Knepley   for (b = dsNew->boundary; b; b = b->next) {
583145480ffeSMatthew G. Knepley     ierr = DMGetLabel(dm, b->lname, &b->label);CHKERRQ(ierr);
583245480ffeSMatthew G. Knepley     /* Do not check if label exists here, since p4est calls this for the reference tree which does not have the labels */
583345480ffeSMatthew G. Knepley     //if (!b->label) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Label %s missing in new DM", name);
583445480ffeSMatthew G. Knepley   }
5835df911668SMatthew G. Knepley   ierr = PetscDSGetHybrid(ds, &isHybrid);CHKERRQ(ierr);
5836df911668SMatthew G. Knepley   ierr = PetscDSSetHybrid(dsNew, isHybrid);CHKERRQ(ierr);
583745480ffeSMatthew G. Knepley 
583845480ffeSMatthew G. Knepley   ierr = DMSetRegionDS(dm, label, fields, dsNew);CHKERRQ(ierr);
583945480ffeSMatthew G. Knepley   ierr = PetscDSDestroy(&dsNew);CHKERRQ(ierr);
584045480ffeSMatthew G. Knepley   PetscFunctionReturn(0);
584145480ffeSMatthew G. Knepley }
584245480ffeSMatthew G. Knepley 
58437f96f943SMatthew G. Knepley /*@
5844e5e52638SMatthew G. Knepley   DMCopyDS - Copy the discrete systems for the DM into another DM
5845e5e52638SMatthew G. Knepley 
5846d083f849SBarry Smith   Collective on dm
5847e5e52638SMatthew G. Knepley 
5848e5e52638SMatthew G. Knepley   Input Parameter:
5849e5e52638SMatthew G. Knepley . dm - The DM
5850e5e52638SMatthew G. Knepley 
5851e5e52638SMatthew G. Knepley   Output Parameter:
5852e5e52638SMatthew G. Knepley . newdm - The DM
5853e5e52638SMatthew G. Knepley 
5854e5e52638SMatthew G. Knepley   Level: advanced
5855e5e52638SMatthew G. Knepley 
5856e5e52638SMatthew G. Knepley .seealso: DMCopyFields(), DMAddField(), DMGetDS(), DMGetCellDS(), DMGetRegionDS(), DMSetRegionDS()
5857e5e52638SMatthew G. Knepley @*/
5858e5e52638SMatthew G. Knepley PetscErrorCode DMCopyDS(DM dm, DM newdm)
5859e5e52638SMatthew G. Knepley {
5860e5e52638SMatthew G. Knepley   PetscInt       Nds, s;
5861e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5862e5e52638SMatthew G. Knepley 
5863e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5864e5e52638SMatthew G. Knepley   if (dm == newdm) PetscFunctionReturn(0);
5865e5e52638SMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
5866e5e52638SMatthew G. Knepley   ierr = DMClearDS(newdm);CHKERRQ(ierr);
5867e5e52638SMatthew G. Knepley   for (s = 0; s < Nds; ++s) {
5868e5e52638SMatthew G. Knepley     DMLabel  label;
5869b3cf3223SMatthew G. Knepley     IS       fields;
587045480ffeSMatthew G. Knepley     PetscDS  ds, newds;
5871783e2ec8SMatthew G. Knepley     PetscInt Nbd, bd;
5872e5e52638SMatthew G. Knepley 
5873b3cf3223SMatthew G. Knepley     ierr = DMGetRegionNumDS(dm, s, &label, &fields, &ds);CHKERRQ(ierr);
587445480ffeSMatthew G. Knepley     ierr = DMTransferDS_Internal(newdm, label, fields, ds);CHKERRQ(ierr);
587545480ffeSMatthew G. Knepley     /* Commplete new labels in the new DS */
587645480ffeSMatthew G. Knepley     ierr = DMGetRegionDS(newdm, label, NULL, &newds);CHKERRQ(ierr);
587745480ffeSMatthew G. Knepley     ierr = PetscDSGetNumBoundary(newds, &Nbd);CHKERRQ(ierr);
5878783e2ec8SMatthew G. Knepley     for (bd = 0; bd < Nbd; ++bd) {
587945480ffeSMatthew G. Knepley       DMLabel  label;
5880783e2ec8SMatthew G. Knepley       PetscInt field;
5881783e2ec8SMatthew G. Knepley 
588245480ffeSMatthew G. Knepley       ierr = PetscDSGetBoundary(newds, bd, NULL, NULL, NULL, &label, NULL, NULL, &field, NULL, NULL, NULL, NULL, NULL);CHKERRQ(ierr);
588345480ffeSMatthew G. Knepley       ierr = DMCompleteBoundaryLabel_Internal(newdm, newds, field, bd, label);CHKERRQ(ierr);
5884783e2ec8SMatthew G. Knepley     }
5885e5e52638SMatthew G. Knepley   }
5886e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5887e5e52638SMatthew G. Knepley }
5888e5e52638SMatthew G. Knepley 
5889e5e52638SMatthew G. Knepley /*@
5890e5e52638SMatthew G. Knepley   DMCopyDisc - Copy the fields and discrete systems for the DM into another DM
5891e5e52638SMatthew G. Knepley 
5892d083f849SBarry Smith   Collective on dm
5893e5e52638SMatthew G. Knepley 
5894e5e52638SMatthew G. Knepley   Input Parameter:
5895e5e52638SMatthew G. Knepley . dm - The DM
5896e5e52638SMatthew G. Knepley 
5897e5e52638SMatthew G. Knepley   Output Parameter:
5898e5e52638SMatthew G. Knepley . newdm - The DM
5899e5e52638SMatthew G. Knepley 
5900e5e52638SMatthew G. Knepley   Level: advanced
5901e5e52638SMatthew G. Knepley 
5902e5e52638SMatthew G. Knepley .seealso: DMCopyFields(), DMCopyDS()
5903e5e52638SMatthew G. Knepley @*/
5904e5e52638SMatthew G. Knepley PetscErrorCode DMCopyDisc(DM dm, DM newdm)
5905e5e52638SMatthew G. Knepley {
5906e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5907e5e52638SMatthew G. Knepley 
5908e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5909e5e52638SMatthew G. Knepley   ierr = DMCopyFields(dm, newdm);CHKERRQ(ierr);
5910e5e52638SMatthew G. Knepley   ierr = DMCopyDS(dm, newdm);CHKERRQ(ierr);
5911e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5912e5e52638SMatthew G. Knepley }
5913e5e52638SMatthew G. Knepley 
5914b64e0483SPeter Brune PetscErrorCode DMRestrictHook_Coordinates(DM dm,DM dmc,void *ctx)
5915b64e0483SPeter Brune {
5916b64e0483SPeter Brune   DM dm_coord,dmc_coord;
5917b64e0483SPeter Brune   PetscErrorCode ierr;
5918b64e0483SPeter Brune   Vec coords,ccoords;
59196dbf9973SLawrence Mitchell   Mat inject;
5920b64e0483SPeter Brune   PetscFunctionBegin;
5921b64e0483SPeter Brune   ierr = DMGetCoordinateDM(dm,&dm_coord);CHKERRQ(ierr);
5922b64e0483SPeter Brune   ierr = DMGetCoordinateDM(dmc,&dmc_coord);CHKERRQ(ierr);
5923b64e0483SPeter Brune   ierr = DMGetCoordinates(dm,&coords);CHKERRQ(ierr);
5924b64e0483SPeter Brune   ierr = DMGetCoordinates(dmc,&ccoords);CHKERRQ(ierr);
5925b64e0483SPeter Brune   if (coords && !ccoords) {
5926b64e0483SPeter Brune     ierr = DMCreateGlobalVector(dmc_coord,&ccoords);CHKERRQ(ierr);
59276668ed41SLisandro Dalcin     ierr = PetscObjectSetName((PetscObject)ccoords,"coordinates");CHKERRQ(ierr);
59286dbf9973SLawrence Mitchell     ierr = DMCreateInjection(dmc_coord,dm_coord,&inject);CHKERRQ(ierr);
59292adcf181SLawrence Mitchell     ierr = MatRestrict(inject,coords,ccoords);CHKERRQ(ierr);
59306dbf9973SLawrence Mitchell     ierr = MatDestroy(&inject);CHKERRQ(ierr);
5931b64e0483SPeter Brune     ierr = DMSetCoordinates(dmc,ccoords);CHKERRQ(ierr);
5932b64e0483SPeter Brune     ierr = VecDestroy(&ccoords);CHKERRQ(ierr);
5933b64e0483SPeter Brune   }
5934b64e0483SPeter Brune   PetscFunctionReturn(0);
5935b64e0483SPeter Brune }
5936b64e0483SPeter Brune 
593703dadc2fSPeter Brune static PetscErrorCode DMSubDomainHook_Coordinates(DM dm,DM subdm,void *ctx)
593803dadc2fSPeter Brune {
593903dadc2fSPeter Brune   DM dm_coord,subdm_coord;
594003dadc2fSPeter Brune   PetscErrorCode ierr;
594103dadc2fSPeter Brune   Vec coords,ccoords,clcoords;
594203dadc2fSPeter Brune   VecScatter *scat_i,*scat_g;
594303dadc2fSPeter Brune   PetscFunctionBegin;
594403dadc2fSPeter Brune   ierr = DMGetCoordinateDM(dm,&dm_coord);CHKERRQ(ierr);
594503dadc2fSPeter Brune   ierr = DMGetCoordinateDM(subdm,&subdm_coord);CHKERRQ(ierr);
594603dadc2fSPeter Brune   ierr = DMGetCoordinates(dm,&coords);CHKERRQ(ierr);
594703dadc2fSPeter Brune   ierr = DMGetCoordinates(subdm,&ccoords);CHKERRQ(ierr);
594803dadc2fSPeter Brune   if (coords && !ccoords) {
594903dadc2fSPeter Brune     ierr = DMCreateGlobalVector(subdm_coord,&ccoords);CHKERRQ(ierr);
59506668ed41SLisandro Dalcin     ierr = PetscObjectSetName((PetscObject)ccoords,"coordinates");CHKERRQ(ierr);
595103dadc2fSPeter Brune     ierr = DMCreateLocalVector(subdm_coord,&clcoords);CHKERRQ(ierr);
595224640c55SToby Isaac     ierr = PetscObjectSetName((PetscObject)clcoords,"coordinates");CHKERRQ(ierr);
595303dadc2fSPeter Brune     ierr = DMCreateDomainDecompositionScatters(dm_coord,1,&subdm_coord,NULL,&scat_i,&scat_g);CHKERRQ(ierr);
595403dadc2fSPeter Brune     ierr = VecScatterBegin(scat_i[0],coords,ccoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
595503dadc2fSPeter Brune     ierr = VecScatterEnd(scat_i[0],coords,ccoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
59561ed9ada7SJunchao Zhang     ierr = VecScatterBegin(scat_g[0],coords,clcoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
595703dadc2fSPeter Brune     ierr = VecScatterEnd(scat_g[0],coords,clcoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
595803dadc2fSPeter Brune     ierr = DMSetCoordinates(subdm,ccoords);CHKERRQ(ierr);
595903dadc2fSPeter Brune     ierr = DMSetCoordinatesLocal(subdm,clcoords);CHKERRQ(ierr);
596003dadc2fSPeter Brune     ierr = VecScatterDestroy(&scat_i[0]);CHKERRQ(ierr);
596103dadc2fSPeter Brune     ierr = VecScatterDestroy(&scat_g[0]);CHKERRQ(ierr);
596203dadc2fSPeter Brune     ierr = VecDestroy(&ccoords);CHKERRQ(ierr);
596303dadc2fSPeter Brune     ierr = VecDestroy(&clcoords);CHKERRQ(ierr);
596403dadc2fSPeter Brune     ierr = PetscFree(scat_i);CHKERRQ(ierr);
596503dadc2fSPeter Brune     ierr = PetscFree(scat_g);CHKERRQ(ierr);
596603dadc2fSPeter Brune   }
596703dadc2fSPeter Brune   PetscFunctionReturn(0);
596803dadc2fSPeter Brune }
596903dadc2fSPeter Brune 
5970c73cfb54SMatthew G. Knepley /*@
5971c73cfb54SMatthew G. Knepley   DMGetDimension - Return the topological dimension of the DM
5972c73cfb54SMatthew G. Knepley 
5973c73cfb54SMatthew G. Knepley   Not collective
5974c73cfb54SMatthew G. Knepley 
5975c73cfb54SMatthew G. Knepley   Input Parameter:
5976c73cfb54SMatthew G. Knepley . dm - The DM
5977c73cfb54SMatthew G. Knepley 
5978c73cfb54SMatthew G. Knepley   Output Parameter:
5979c73cfb54SMatthew G. Knepley . dim - The topological dimension
5980c73cfb54SMatthew G. Knepley 
5981c73cfb54SMatthew G. Knepley   Level: beginner
5982c73cfb54SMatthew G. Knepley 
5983c73cfb54SMatthew G. Knepley .seealso: DMSetDimension(), DMCreate()
5984c73cfb54SMatthew G. Knepley @*/
5985c73cfb54SMatthew G. Knepley PetscErrorCode DMGetDimension(DM dm, PetscInt *dim)
5986c73cfb54SMatthew G. Knepley {
5987c73cfb54SMatthew G. Knepley   PetscFunctionBegin;
5988c73cfb54SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5989534a8f05SLisandro Dalcin   PetscValidIntPointer(dim, 2);
5990c73cfb54SMatthew G. Knepley   *dim = dm->dim;
5991c73cfb54SMatthew G. Knepley   PetscFunctionReturn(0);
5992c73cfb54SMatthew G. Knepley }
5993c73cfb54SMatthew G. Knepley 
5994c73cfb54SMatthew G. Knepley /*@
5995c73cfb54SMatthew G. Knepley   DMSetDimension - Set the topological dimension of the DM
5996c73cfb54SMatthew G. Knepley 
5997c73cfb54SMatthew G. Knepley   Collective on dm
5998c73cfb54SMatthew G. Knepley 
5999c73cfb54SMatthew G. Knepley   Input Parameters:
6000c73cfb54SMatthew G. Knepley + dm - The DM
6001c73cfb54SMatthew G. Knepley - dim - The topological dimension
6002c73cfb54SMatthew G. Knepley 
6003c73cfb54SMatthew G. Knepley   Level: beginner
6004c73cfb54SMatthew G. Knepley 
6005c73cfb54SMatthew G. Knepley .seealso: DMGetDimension(), DMCreate()
6006c73cfb54SMatthew G. Knepley @*/
6007c73cfb54SMatthew G. Knepley PetscErrorCode DMSetDimension(DM dm, PetscInt dim)
6008c73cfb54SMatthew G. Knepley {
6009e5e52638SMatthew G. Knepley   PetscDS        ds;
601045480ffeSMatthew G. Knepley   PetscInt       Nds, n;
6011f17e8794SMatthew G. Knepley   PetscErrorCode ierr;
6012f17e8794SMatthew G. Knepley 
6013c73cfb54SMatthew G. Knepley   PetscFunctionBegin;
6014c73cfb54SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6015c73cfb54SMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, dim, 2);
6016c73cfb54SMatthew G. Knepley   dm->dim = dim;
601745480ffeSMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
601845480ffeSMatthew G. Knepley   for (n = 0; n < Nds; ++n) {
601945480ffeSMatthew G. Knepley     ierr = DMGetRegionNumDS(dm, n, NULL, NULL, &ds);CHKERRQ(ierr);
602045480ffeSMatthew G. Knepley     if (ds->dimEmbed < 0) {ierr = PetscDSSetCoordinateDimension(ds, dim);CHKERRQ(ierr);}
602145480ffeSMatthew G. Knepley   }
6022c73cfb54SMatthew G. Knepley   PetscFunctionReturn(0);
6023c73cfb54SMatthew G. Knepley }
6024c73cfb54SMatthew G. Knepley 
6025793f3fe5SMatthew G. Knepley /*@
6026793f3fe5SMatthew G. Knepley   DMGetDimPoints - Get the half-open interval for all points of a given dimension
6027793f3fe5SMatthew G. Knepley 
6028d083f849SBarry Smith   Collective on dm
6029793f3fe5SMatthew G. Knepley 
6030793f3fe5SMatthew G. Knepley   Input Parameters:
6031793f3fe5SMatthew G. Knepley + dm - the DM
6032793f3fe5SMatthew G. Knepley - dim - the dimension
6033793f3fe5SMatthew G. Knepley 
6034793f3fe5SMatthew G. Knepley   Output Parameters:
6035793f3fe5SMatthew G. Knepley + pStart - The first point of the given dimension
6036aa049354SPatrick Sanan - pEnd - The first point following points of the given dimension
6037793f3fe5SMatthew G. Knepley 
6038793f3fe5SMatthew G. Knepley   Note:
6039793f3fe5SMatthew G. Knepley   The points are vertices in the Hasse diagram encoding the topology. This is explained in
6040a8d69d7bSBarry Smith   https://arxiv.org/abs/0908.4427. If no points exist of this dimension in the storage scheme,
6041793f3fe5SMatthew G. Knepley   then the interval is empty.
6042793f3fe5SMatthew G. Knepley 
6043793f3fe5SMatthew G. Knepley   Level: intermediate
6044793f3fe5SMatthew G. Knepley 
6045793f3fe5SMatthew G. Knepley .seealso: DMPLEX, DMPlexGetDepthStratum(), DMPlexGetHeightStratum()
6046793f3fe5SMatthew G. Knepley @*/
6047793f3fe5SMatthew G. Knepley PetscErrorCode DMGetDimPoints(DM dm, PetscInt dim, PetscInt *pStart, PetscInt *pEnd)
6048793f3fe5SMatthew G. Knepley {
6049793f3fe5SMatthew G. Knepley   PetscInt       d;
6050793f3fe5SMatthew G. Knepley   PetscErrorCode ierr;
6051793f3fe5SMatthew G. Knepley 
6052793f3fe5SMatthew G. Knepley   PetscFunctionBegin;
6053793f3fe5SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6054793f3fe5SMatthew G. Knepley   ierr = DMGetDimension(dm, &d);CHKERRQ(ierr);
6055793f3fe5SMatthew G. Knepley   if ((dim < 0) || (dim > d)) SETERRQ2(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid dimension %d 1", dim, d);
6056b9d85ea2SLisandro Dalcin   if (!dm->ops->getdimpoints) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "DM type %s does not implement DMGetDimPoints",((PetscObject)dm)->type_name);
6057793f3fe5SMatthew G. Knepley   ierr = (*dm->ops->getdimpoints)(dm, dim, pStart, pEnd);CHKERRQ(ierr);
6058793f3fe5SMatthew G. Knepley   PetscFunctionReturn(0);
6059793f3fe5SMatthew G. Knepley }
6060793f3fe5SMatthew G. Knepley 
60616636e97aSMatthew G Knepley /*@
60626636e97aSMatthew G Knepley   DMSetCoordinates - Sets into the DM a global vector that holds the coordinates
60636636e97aSMatthew G Knepley 
6064d083f849SBarry Smith   Collective on dm
60656636e97aSMatthew G Knepley 
60666636e97aSMatthew G Knepley   Input Parameters:
60676636e97aSMatthew G Knepley + dm - the DM
60686636e97aSMatthew G Knepley - c - coordinate vector
60696636e97aSMatthew G Knepley 
60702dd40e9bSPatrick Sanan   Notes:
60712dd40e9bSPatrick Sanan   The coordinates do include those for ghost points, which are in the local vector.
60722dd40e9bSPatrick Sanan 
60732dd40e9bSPatrick Sanan   The vector c should be destroyed by the caller.
60746636e97aSMatthew G Knepley 
60756636e97aSMatthew G Knepley   Level: intermediate
60766636e97aSMatthew G Knepley 
607760c22052SBarry Smith .seealso: DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM(), DMDASetUniformCoordinates()
60786636e97aSMatthew G Knepley @*/
60796636e97aSMatthew G Knepley PetscErrorCode DMSetCoordinates(DM dm, Vec c)
60806636e97aSMatthew G Knepley {
60816636e97aSMatthew G Knepley   PetscErrorCode ierr;
60826636e97aSMatthew G Knepley 
60836636e97aSMatthew G Knepley   PetscFunctionBegin;
60846636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
60856636e97aSMatthew G Knepley   PetscValidHeaderSpecific(c,VEC_CLASSID,2);
60866636e97aSMatthew G Knepley   ierr            = PetscObjectReference((PetscObject) c);CHKERRQ(ierr);
60876636e97aSMatthew G Knepley   ierr            = VecDestroy(&dm->coordinates);CHKERRQ(ierr);
60886636e97aSMatthew G Knepley   dm->coordinates = c;
60896636e97aSMatthew G Knepley   ierr            = VecDestroy(&dm->coordinatesLocal);CHKERRQ(ierr);
6090b64e0483SPeter Brune   ierr            = DMCoarsenHookAdd(dm,DMRestrictHook_Coordinates,NULL,NULL);CHKERRQ(ierr);
609103dadc2fSPeter Brune   ierr            = DMSubDomainHookAdd(dm,DMSubDomainHook_Coordinates,NULL,NULL);CHKERRQ(ierr);
60926636e97aSMatthew G Knepley   PetscFunctionReturn(0);
60936636e97aSMatthew G Knepley }
60946636e97aSMatthew G Knepley 
60956636e97aSMatthew G Knepley /*@
60966636e97aSMatthew G Knepley   DMSetCoordinatesLocal - Sets into the DM a local vector that holds the coordinates
60976636e97aSMatthew G Knepley 
60987058e716SVaclav Hapla   Not collective
60996636e97aSMatthew G Knepley 
61006636e97aSMatthew G Knepley    Input Parameters:
61016636e97aSMatthew G Knepley +  dm - the DM
61026636e97aSMatthew G Knepley -  c - coordinate vector
61036636e97aSMatthew G Knepley 
61042dd40e9bSPatrick Sanan   Notes:
61056636e97aSMatthew G Knepley   The coordinates of ghost points can be set using DMSetCoordinates()
61066636e97aSMatthew G Knepley   followed by DMGetCoordinatesLocal(). This is intended to enable the
61076636e97aSMatthew G Knepley   setting of ghost coordinates outside of the domain.
61086636e97aSMatthew G Knepley 
61092dd40e9bSPatrick Sanan   The vector c should be destroyed by the caller.
61102dd40e9bSPatrick Sanan 
61116636e97aSMatthew G Knepley   Level: intermediate
61126636e97aSMatthew G Knepley 
61136636e97aSMatthew G Knepley .seealso: DMGetCoordinatesLocal(), DMSetCoordinates(), DMGetCoordinates(), DMGetCoordinateDM()
61146636e97aSMatthew G Knepley @*/
61156636e97aSMatthew G Knepley PetscErrorCode DMSetCoordinatesLocal(DM dm, Vec c)
61166636e97aSMatthew G Knepley {
61176636e97aSMatthew G Knepley   PetscErrorCode ierr;
61186636e97aSMatthew G Knepley 
61196636e97aSMatthew G Knepley   PetscFunctionBegin;
61206636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
61216636e97aSMatthew G Knepley   PetscValidHeaderSpecific(c,VEC_CLASSID,2);
61226636e97aSMatthew G Knepley   ierr = PetscObjectReference((PetscObject) c);CHKERRQ(ierr);
61236636e97aSMatthew G Knepley   ierr = VecDestroy(&dm->coordinatesLocal);CHKERRQ(ierr);
61248865f1eaSKarl Rupp 
61256636e97aSMatthew G Knepley   dm->coordinatesLocal = c;
61268865f1eaSKarl Rupp 
61276636e97aSMatthew G Knepley   ierr = VecDestroy(&dm->coordinates);CHKERRQ(ierr);
61286636e97aSMatthew G Knepley   PetscFunctionReturn(0);
61296636e97aSMatthew G Knepley }
61306636e97aSMatthew G Knepley 
61316636e97aSMatthew G Knepley /*@
61326636e97aSMatthew G Knepley   DMGetCoordinates - Gets a global vector with the coordinates associated with the DM.
61336636e97aSMatthew G Knepley 
6134d083f849SBarry Smith   Collective on dm
61356636e97aSMatthew G Knepley 
61366636e97aSMatthew G Knepley   Input Parameter:
61376636e97aSMatthew G Knepley . dm - the DM
61386636e97aSMatthew G Knepley 
61396636e97aSMatthew G Knepley   Output Parameter:
61406636e97aSMatthew G Knepley . c - global coordinate vector
61416636e97aSMatthew G Knepley 
61426636e97aSMatthew G Knepley   Note:
614360c22052SBarry Smith   This is a borrowed reference, so the user should NOT destroy this vector. When the DM is
614460c22052SBarry Smith   destroyed the array will no longer be valid.
61456636e97aSMatthew G Knepley 
6146959c7569SPatrick Sanan   Each process has only the locally-owned portion of the global coordinates (does NOT have the ghost coordinates).
61476636e97aSMatthew G Knepley 
61486636e97aSMatthew G Knepley   For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...)
61496636e97aSMatthew G Knepley   and (x_0,y_0,z_0,x_1,y_1,z_1...)
61506636e97aSMatthew G Knepley 
61516636e97aSMatthew G Knepley   Level: intermediate
61526636e97aSMatthew G Knepley 
615360c22052SBarry Smith .seealso: DMSetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM(), DMDASetUniformCoordinates()
61546636e97aSMatthew G Knepley @*/
61556636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinates(DM dm, Vec *c)
61566636e97aSMatthew G Knepley {
61576636e97aSMatthew G Knepley   PetscErrorCode ierr;
61586636e97aSMatthew G Knepley 
61596636e97aSMatthew G Knepley   PetscFunctionBegin;
61606636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
61616636e97aSMatthew G Knepley   PetscValidPointer(c,2);
61621f588964SMatthew G Knepley   if (!dm->coordinates && dm->coordinatesLocal) {
61630298fd71SBarry Smith     DM        cdm = NULL;
61641970a576SMatthew G. Knepley     PetscBool localized;
61656636e97aSMatthew G Knepley 
61666636e97aSMatthew G Knepley     ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
61676636e97aSMatthew G Knepley     ierr = DMCreateGlobalVector(cdm, &dm->coordinates);CHKERRQ(ierr);
61681970a576SMatthew G. Knepley     ierr = DMGetCoordinatesLocalized(dm, &localized);CHKERRQ(ierr);
61691970a576SMatthew G. Knepley     /* Block size is not correctly set by CreateGlobalVector() if coordinates are localized */
61701970a576SMatthew G. Knepley     if (localized) {
61711970a576SMatthew G. Knepley       PetscInt cdim;
61721970a576SMatthew G. Knepley 
61731970a576SMatthew G. Knepley       ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
61741970a576SMatthew G. Knepley       ierr = VecSetBlockSize(dm->coordinates, cdim);CHKERRQ(ierr);
61751970a576SMatthew G. Knepley     }
61766636e97aSMatthew G Knepley     ierr = PetscObjectSetName((PetscObject) dm->coordinates, "coordinates");CHKERRQ(ierr);
61776636e97aSMatthew G Knepley     ierr = DMLocalToGlobalBegin(cdm, dm->coordinatesLocal, INSERT_VALUES, dm->coordinates);CHKERRQ(ierr);
61786636e97aSMatthew G Knepley     ierr = DMLocalToGlobalEnd(cdm, dm->coordinatesLocal, INSERT_VALUES, dm->coordinates);CHKERRQ(ierr);
61796636e97aSMatthew G Knepley   }
61806636e97aSMatthew G Knepley   *c = dm->coordinates;
61816636e97aSMatthew G Knepley   PetscFunctionReturn(0);
61826636e97aSMatthew G Knepley }
61836636e97aSMatthew G Knepley 
61846636e97aSMatthew G Knepley /*@
618581e9a530SVaclav Hapla   DMGetCoordinatesLocalSetUp - Prepares a local vector of coordinates, so that DMGetCoordinatesLocalNoncollective() can be used as non-collective afterwards.
618681e9a530SVaclav Hapla 
6187d083f849SBarry Smith   Collective on dm
618881e9a530SVaclav Hapla 
618981e9a530SVaclav Hapla   Input Parameter:
619081e9a530SVaclav Hapla . dm - the DM
619181e9a530SVaclav Hapla 
619281e9a530SVaclav Hapla   Level: advanced
619381e9a530SVaclav Hapla 
619481e9a530SVaclav Hapla .seealso: DMGetCoordinatesLocalNoncollective()
619581e9a530SVaclav Hapla @*/
619681e9a530SVaclav Hapla PetscErrorCode DMGetCoordinatesLocalSetUp(DM dm)
619781e9a530SVaclav Hapla {
619881e9a530SVaclav Hapla   PetscErrorCode ierr;
619981e9a530SVaclav Hapla 
620081e9a530SVaclav Hapla   PetscFunctionBegin;
620181e9a530SVaclav Hapla   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
620281e9a530SVaclav Hapla   if (!dm->coordinatesLocal && dm->coordinates) {
62031970a576SMatthew G. Knepley     DM        cdm = NULL;
62041970a576SMatthew G. Knepley     PetscBool localized;
62051970a576SMatthew G. Knepley 
620681e9a530SVaclav Hapla     ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
620781e9a530SVaclav Hapla     ierr = DMCreateLocalVector(cdm, &dm->coordinatesLocal);CHKERRQ(ierr);
62081970a576SMatthew G. Knepley     ierr = DMGetCoordinatesLocalized(dm, &localized);CHKERRQ(ierr);
62091970a576SMatthew G. Knepley     /* Block size is not correctly set by CreateLocalVector() if coordinates are localized */
62101970a576SMatthew G. Knepley     if (localized) {
62111970a576SMatthew G. Knepley       PetscInt cdim;
62121970a576SMatthew G. Knepley 
62131970a576SMatthew G. Knepley       ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
62141970a576SMatthew G. Knepley       ierr = VecSetBlockSize(dm->coordinates, cdim);CHKERRQ(ierr);
62151970a576SMatthew G. Knepley     }
621681e9a530SVaclav Hapla     ierr = PetscObjectSetName((PetscObject) dm->coordinatesLocal, "coordinates");CHKERRQ(ierr);
621781e9a530SVaclav Hapla     ierr = DMGlobalToLocalBegin(cdm, dm->coordinates, INSERT_VALUES, dm->coordinatesLocal);CHKERRQ(ierr);
621881e9a530SVaclav Hapla     ierr = DMGlobalToLocalEnd(cdm, dm->coordinates, INSERT_VALUES, dm->coordinatesLocal);CHKERRQ(ierr);
621981e9a530SVaclav Hapla   }
622081e9a530SVaclav Hapla   PetscFunctionReturn(0);
622181e9a530SVaclav Hapla }
622281e9a530SVaclav Hapla 
622381e9a530SVaclav Hapla /*@
62246636e97aSMatthew G Knepley   DMGetCoordinatesLocal - Gets a local vector with the coordinates associated with the DM.
62256636e97aSMatthew G Knepley 
6226d083f849SBarry Smith   Collective on dm
62276636e97aSMatthew G Knepley 
62286636e97aSMatthew G Knepley   Input Parameter:
62296636e97aSMatthew G Knepley . dm - the DM
62306636e97aSMatthew G Knepley 
62316636e97aSMatthew G Knepley   Output Parameter:
62326636e97aSMatthew G Knepley . c - coordinate vector
62336636e97aSMatthew G Knepley 
62346636e97aSMatthew G Knepley   Note:
62356636e97aSMatthew G Knepley   This is a borrowed reference, so the user should NOT destroy this vector
62366636e97aSMatthew G Knepley 
62376636e97aSMatthew G Knepley   Each process has the local and ghost coordinates
62386636e97aSMatthew G Knepley 
62396636e97aSMatthew G Knepley   For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...)
62406636e97aSMatthew G Knepley   and (x_0,y_0,z_0,x_1,y_1,z_1...)
62416636e97aSMatthew G Knepley 
62426636e97aSMatthew G Knepley   Level: intermediate
62436636e97aSMatthew G Knepley 
624481e9a530SVaclav Hapla .seealso: DMSetCoordinatesLocal(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM(), DMGetCoordinatesLocalNoncollective()
62456636e97aSMatthew G Knepley @*/
62466636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinatesLocal(DM dm, Vec *c)
62476636e97aSMatthew G Knepley {
62486636e97aSMatthew G Knepley   PetscErrorCode ierr;
62496636e97aSMatthew G Knepley 
62506636e97aSMatthew G Knepley   PetscFunctionBegin;
62516636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
62526636e97aSMatthew G Knepley   PetscValidPointer(c,2);
625381e9a530SVaclav Hapla   ierr = DMGetCoordinatesLocalSetUp(dm);CHKERRQ(ierr);
62546636e97aSMatthew G Knepley   *c = dm->coordinatesLocal;
62556636e97aSMatthew G Knepley   PetscFunctionReturn(0);
62566636e97aSMatthew G Knepley }
62576636e97aSMatthew G Knepley 
625881e9a530SVaclav Hapla /*@
625981e9a530SVaclav Hapla   DMGetCoordinatesLocalNoncollective - Non-collective version of DMGetCoordinatesLocal(). Fails if global coordinates have been set and DMGetCoordinatesLocalSetUp() not called.
626081e9a530SVaclav Hapla 
626181e9a530SVaclav Hapla   Not collective
626281e9a530SVaclav Hapla 
626381e9a530SVaclav Hapla   Input Parameter:
626481e9a530SVaclav Hapla . dm - the DM
626581e9a530SVaclav Hapla 
626681e9a530SVaclav Hapla   Output Parameter:
626781e9a530SVaclav Hapla . c - coordinate vector
626881e9a530SVaclav Hapla 
626981e9a530SVaclav Hapla   Level: advanced
627081e9a530SVaclav Hapla 
627181e9a530SVaclav Hapla .seealso: DMGetCoordinatesLocalSetUp(), DMGetCoordinatesLocal(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM()
627281e9a530SVaclav Hapla @*/
627381e9a530SVaclav Hapla PetscErrorCode DMGetCoordinatesLocalNoncollective(DM dm, Vec *c)
627481e9a530SVaclav Hapla {
627581e9a530SVaclav Hapla   PetscFunctionBegin;
627681e9a530SVaclav Hapla   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
627781e9a530SVaclav Hapla   PetscValidPointer(c,2);
627881e9a530SVaclav Hapla   if (!dm->coordinatesLocal && dm->coordinates) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DMGetCoordinatesLocalSetUp() has not been called");
62796636e97aSMatthew G Knepley   *c = dm->coordinatesLocal;
62806636e97aSMatthew G Knepley   PetscFunctionReturn(0);
62816636e97aSMatthew G Knepley }
62826636e97aSMatthew G Knepley 
62832db98f8dSVaclav Hapla /*@
62842db98f8dSVaclav Hapla   DMGetCoordinatesLocalTuple - Gets a local vector with the coordinates of specified points and section describing its layout.
62852db98f8dSVaclav Hapla 
62862db98f8dSVaclav Hapla   Not collective
62872db98f8dSVaclav Hapla 
62882db98f8dSVaclav Hapla   Input Parameter:
62892db98f8dSVaclav Hapla + dm - the DM
62902db98f8dSVaclav Hapla - p - the IS of points whose coordinates will be returned
62912db98f8dSVaclav Hapla 
62922db98f8dSVaclav Hapla   Output Parameter:
62932db98f8dSVaclav Hapla + pCoordSection - the PetscSection describing the layout of pCoord, i.e. each point corresponds to one point in p, and DOFs correspond to coordinates
62942db98f8dSVaclav Hapla - pCoord - the Vec with coordinates of points in p
62952db98f8dSVaclav Hapla 
62962db98f8dSVaclav Hapla   Note:
62972db98f8dSVaclav Hapla   DMGetCoordinatesLocalSetUp() must be called first. This function employs DMGetCoordinatesLocalNoncollective() so it is not collective.
62982db98f8dSVaclav Hapla 
62992db98f8dSVaclav Hapla   This creates a new vector, so the user SHOULD destroy this vector
63002db98f8dSVaclav Hapla 
63012db98f8dSVaclav Hapla   Each process has the local and ghost coordinates
63022db98f8dSVaclav Hapla 
63032db98f8dSVaclav Hapla   For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...)
63042db98f8dSVaclav Hapla   and (x_0,y_0,z_0,x_1,y_1,z_1...)
63052db98f8dSVaclav Hapla 
63062db98f8dSVaclav Hapla   Level: advanced
63072db98f8dSVaclav Hapla 
63082db98f8dSVaclav Hapla .seealso: DMSetCoordinatesLocal(), DMGetCoordinatesLocal(), DMGetCoordinatesLocalNoncollective(), DMGetCoordinatesLocalSetUp(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM()
63092db98f8dSVaclav Hapla @*/
63102db98f8dSVaclav Hapla PetscErrorCode DMGetCoordinatesLocalTuple(DM dm, IS p, PetscSection *pCoordSection, Vec *pCoord)
63112db98f8dSVaclav Hapla {
63122db98f8dSVaclav Hapla   PetscSection        cs, newcs;
63132db98f8dSVaclav Hapla   Vec                 coords;
63142db98f8dSVaclav Hapla   const PetscScalar   *arr;
63152db98f8dSVaclav Hapla   PetscScalar         *newarr=NULL;
63162db98f8dSVaclav Hapla   PetscInt            n;
63172db98f8dSVaclav Hapla   PetscErrorCode      ierr;
63182db98f8dSVaclav Hapla 
63192db98f8dSVaclav Hapla   PetscFunctionBegin;
63202db98f8dSVaclav Hapla   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
63212db98f8dSVaclav Hapla   PetscValidHeaderSpecific(p, IS_CLASSID, 2);
63222db98f8dSVaclav Hapla   if (pCoordSection) PetscValidPointer(pCoordSection, 3);
63232db98f8dSVaclav Hapla   if (pCoord) PetscValidPointer(pCoord, 4);
63242db98f8dSVaclav Hapla   if (!dm->coordinatesLocal) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DMGetCoordinatesLocalSetUp() has not been called or coordinates not set");
63251bb6d2a8SBarry Smith   if (!dm->coordinateDM || !dm->coordinateDM->localSection) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DM not supported");
63261bb6d2a8SBarry Smith   cs = dm->coordinateDM->localSection;
63272db98f8dSVaclav Hapla   coords = dm->coordinatesLocal;
63282db98f8dSVaclav Hapla   ierr = VecGetArrayRead(coords, &arr);CHKERRQ(ierr);
63292db98f8dSVaclav Hapla   ierr = PetscSectionExtractDofsFromArray(cs, MPIU_SCALAR, arr, p, &newcs, pCoord ? ((void**)&newarr) : NULL);CHKERRQ(ierr);
63302db98f8dSVaclav Hapla   ierr = VecRestoreArrayRead(coords, &arr);CHKERRQ(ierr);
63312db98f8dSVaclav Hapla   if (pCoord) {
63322db98f8dSVaclav Hapla     ierr = PetscSectionGetStorageSize(newcs, &n);CHKERRQ(ierr);
63332db98f8dSVaclav Hapla     /* set array in two steps to mimic PETSC_OWN_POINTER */
63342db98f8dSVaclav Hapla     ierr = VecCreateSeqWithArray(PetscObjectComm((PetscObject)p), 1, n, NULL, pCoord);CHKERRQ(ierr);
63352db98f8dSVaclav Hapla     ierr = VecReplaceArray(*pCoord, newarr);CHKERRQ(ierr);
6336ad9ac99dSVaclav Hapla   } else {
6337ad9ac99dSVaclav Hapla     ierr = PetscFree(newarr);CHKERRQ(ierr);
63382db98f8dSVaclav Hapla   }
6339ad9ac99dSVaclav Hapla   if (pCoordSection) {*pCoordSection = newcs;}
6340ad9ac99dSVaclav Hapla   else               {ierr = PetscSectionDestroy(&newcs);CHKERRQ(ierr);}
63412db98f8dSVaclav Hapla   PetscFunctionReturn(0);
63422db98f8dSVaclav Hapla }
63432db98f8dSVaclav Hapla 
6344f19dbd58SToby Isaac PetscErrorCode DMGetCoordinateField(DM dm, DMField *field)
6345f19dbd58SToby Isaac {
6346f19dbd58SToby Isaac   PetscErrorCode ierr;
6347f19dbd58SToby Isaac 
6348f19dbd58SToby Isaac   PetscFunctionBegin;
6349f19dbd58SToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6350f19dbd58SToby Isaac   PetscValidPointer(field,2);
6351f19dbd58SToby Isaac   if (!dm->coordinateField) {
6352f19dbd58SToby Isaac     if (dm->ops->createcoordinatefield) {
6353f19dbd58SToby Isaac       ierr = (*dm->ops->createcoordinatefield)(dm,&dm->coordinateField);CHKERRQ(ierr);
6354f19dbd58SToby Isaac     }
6355f19dbd58SToby Isaac   }
6356f19dbd58SToby Isaac   *field = dm->coordinateField;
6357f19dbd58SToby Isaac   PetscFunctionReturn(0);
6358f19dbd58SToby Isaac }
6359f19dbd58SToby Isaac 
6360f19dbd58SToby Isaac PetscErrorCode DMSetCoordinateField(DM dm, DMField field)
6361f19dbd58SToby Isaac {
6362f19dbd58SToby Isaac   PetscErrorCode ierr;
6363f19dbd58SToby Isaac 
6364f19dbd58SToby Isaac   PetscFunctionBegin;
6365f19dbd58SToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6366f19dbd58SToby Isaac   if (field) PetscValidHeaderSpecific(field,DMFIELD_CLASSID,2);
6367c4e6da2cSBarry Smith   ierr = PetscObjectReference((PetscObject)field);CHKERRQ(ierr);
6368f19dbd58SToby Isaac   ierr = DMFieldDestroy(&dm->coordinateField);CHKERRQ(ierr);
6369f19dbd58SToby Isaac   dm->coordinateField = field;
6370f19dbd58SToby Isaac   PetscFunctionReturn(0);
6371f19dbd58SToby Isaac }
6372f19dbd58SToby Isaac 
63736636e97aSMatthew G Knepley /*@
63741cfe2091SMatthew G. Knepley   DMGetCoordinateDM - Gets the DM that prescribes coordinate layout and scatters between global and local coordinates
63756636e97aSMatthew G Knepley 
6376d083f849SBarry Smith   Collective on dm
63776636e97aSMatthew G Knepley 
63786636e97aSMatthew G Knepley   Input Parameter:
63796636e97aSMatthew G Knepley . dm - the DM
63806636e97aSMatthew G Knepley 
63816636e97aSMatthew G Knepley   Output Parameter:
63826636e97aSMatthew G Knepley . cdm - coordinate DM
63836636e97aSMatthew G Knepley 
63846636e97aSMatthew G Knepley   Level: intermediate
63856636e97aSMatthew G Knepley 
63861cfe2091SMatthew G. Knepley .seealso: DMSetCoordinateDM(), DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal()
63876636e97aSMatthew G Knepley @*/
63886636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinateDM(DM dm, DM *cdm)
63896636e97aSMatthew G Knepley {
63906636e97aSMatthew G Knepley   PetscErrorCode ierr;
63916636e97aSMatthew G Knepley 
63926636e97aSMatthew G Knepley   PetscFunctionBegin;
63936636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
63946636e97aSMatthew G Knepley   PetscValidPointer(cdm,2);
63956636e97aSMatthew G Knepley   if (!dm->coordinateDM) {
6396308f8a94SToby Isaac     DM cdm;
6397308f8a94SToby Isaac 
639882f516ccSBarry Smith     if (!dm->ops->createcoordinatedm) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Unable to create coordinates for this DM");
6399308f8a94SToby Isaac     ierr = (*dm->ops->createcoordinatedm)(dm, &cdm);CHKERRQ(ierr);
6400308f8a94SToby Isaac     /* Just in case the DM sets the coordinate DM when creating it (DMP4est can do this, because it may not setup
6401308f8a94SToby Isaac      * until the call to CreateCoordinateDM) */
6402308f8a94SToby Isaac     ierr = DMDestroy(&dm->coordinateDM);CHKERRQ(ierr);
6403308f8a94SToby Isaac     dm->coordinateDM = cdm;
64046636e97aSMatthew G Knepley   }
64056636e97aSMatthew G Knepley   *cdm = dm->coordinateDM;
64066636e97aSMatthew G Knepley   PetscFunctionReturn(0);
64076636e97aSMatthew G Knepley }
6408e87bb0d3SMatthew G Knepley 
64091cfe2091SMatthew G. Knepley /*@
64101cfe2091SMatthew G. Knepley   DMSetCoordinateDM - Sets the DM that prescribes coordinate layout and scatters between global and local coordinates
64111cfe2091SMatthew G. Knepley 
6412d083f849SBarry Smith   Logically Collective on dm
64131cfe2091SMatthew G. Knepley 
64141cfe2091SMatthew G. Knepley   Input Parameters:
64151cfe2091SMatthew G. Knepley + dm - the DM
64161cfe2091SMatthew G. Knepley - cdm - coordinate DM
64171cfe2091SMatthew G. Knepley 
64181cfe2091SMatthew G. Knepley   Level: intermediate
64191cfe2091SMatthew G. Knepley 
64201cfe2091SMatthew G. Knepley .seealso: DMGetCoordinateDM(), DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal()
64211cfe2091SMatthew G. Knepley @*/
64221cfe2091SMatthew G. Knepley PetscErrorCode DMSetCoordinateDM(DM dm, DM cdm)
64231cfe2091SMatthew G. Knepley {
64241cfe2091SMatthew G. Knepley   PetscErrorCode ierr;
64251cfe2091SMatthew G. Knepley 
64261cfe2091SMatthew G. Knepley   PetscFunctionBegin;
64271cfe2091SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
64281cfe2091SMatthew G. Knepley   PetscValidHeaderSpecific(cdm,DM_CLASSID,2);
6429f26b38b9SToby Isaac   ierr = PetscObjectReference((PetscObject)cdm);CHKERRQ(ierr);
64301cfe2091SMatthew G. Knepley   ierr = DMDestroy(&dm->coordinateDM);CHKERRQ(ierr);
64311cfe2091SMatthew G. Knepley   dm->coordinateDM = cdm;
64321cfe2091SMatthew G. Knepley   PetscFunctionReturn(0);
64331cfe2091SMatthew G. Knepley }
64341cfe2091SMatthew G. Knepley 
643546e270d4SMatthew G. Knepley /*@
643646e270d4SMatthew G. Knepley   DMGetCoordinateDim - Retrieve the dimension of embedding space for coordinate values.
643746e270d4SMatthew G. Knepley 
643846e270d4SMatthew G. Knepley   Not Collective
643946e270d4SMatthew G. Knepley 
644046e270d4SMatthew G. Knepley   Input Parameter:
644146e270d4SMatthew G. Knepley . dm - The DM object
644246e270d4SMatthew G. Knepley 
644346e270d4SMatthew G. Knepley   Output Parameter:
644446e270d4SMatthew G. Knepley . dim - The embedding dimension
644546e270d4SMatthew G. Knepley 
644646e270d4SMatthew G. Knepley   Level: intermediate
644746e270d4SMatthew G. Knepley 
644892fd8e1eSJed Brown .seealso: DMSetCoordinateDim(), DMGetCoordinateSection(), DMGetCoordinateDM(), DMGetLocalSection(), DMSetLocalSection()
644946e270d4SMatthew G. Knepley @*/
645046e270d4SMatthew G. Knepley PetscErrorCode DMGetCoordinateDim(DM dm, PetscInt *dim)
645146e270d4SMatthew G. Knepley {
645246e270d4SMatthew G. Knepley   PetscFunctionBegin;
645346e270d4SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6454534a8f05SLisandro Dalcin   PetscValidIntPointer(dim, 2);
64559a9a41abSToby Isaac   if (dm->dimEmbed == PETSC_DEFAULT) {
64569a9a41abSToby Isaac     dm->dimEmbed = dm->dim;
64579a9a41abSToby Isaac   }
645846e270d4SMatthew G. Knepley   *dim = dm->dimEmbed;
645946e270d4SMatthew G. Knepley   PetscFunctionReturn(0);
646046e270d4SMatthew G. Knepley }
646146e270d4SMatthew G. Knepley 
646246e270d4SMatthew G. Knepley /*@
646346e270d4SMatthew G. Knepley   DMSetCoordinateDim - Set the dimension of the embedding space for coordinate values.
646446e270d4SMatthew G. Knepley 
646546e270d4SMatthew G. Knepley   Not Collective
646646e270d4SMatthew G. Knepley 
646746e270d4SMatthew G. Knepley   Input Parameters:
646846e270d4SMatthew G. Knepley + dm  - The DM object
646946e270d4SMatthew G. Knepley - dim - The embedding dimension
647046e270d4SMatthew G. Knepley 
647146e270d4SMatthew G. Knepley   Level: intermediate
647246e270d4SMatthew G. Knepley 
647392fd8e1eSJed Brown .seealso: DMGetCoordinateDim(), DMSetCoordinateSection(), DMGetCoordinateSection(), DMGetLocalSection(), DMSetLocalSection()
647446e270d4SMatthew G. Knepley @*/
647546e270d4SMatthew G. Knepley PetscErrorCode DMSetCoordinateDim(DM dm, PetscInt dim)
647646e270d4SMatthew G. Knepley {
6477e5e52638SMatthew G. Knepley   PetscDS        ds;
647845480ffeSMatthew G. Knepley   PetscInt       Nds, n;
6479f17e8794SMatthew G. Knepley   PetscErrorCode ierr;
6480f17e8794SMatthew G. Knepley 
648146e270d4SMatthew G. Knepley   PetscFunctionBegin;
648246e270d4SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
648346e270d4SMatthew G. Knepley   dm->dimEmbed = dim;
648445480ffeSMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
648545480ffeSMatthew G. Knepley   for (n = 0; n < Nds; ++n) {
648645480ffeSMatthew G. Knepley     ierr = DMGetRegionNumDS(dm, n, NULL, NULL, &ds);CHKERRQ(ierr);
6487e5e52638SMatthew G. Knepley     ierr = PetscDSSetCoordinateDimension(ds, dim);CHKERRQ(ierr);
648845480ffeSMatthew G. Knepley   }
648946e270d4SMatthew G. Knepley   PetscFunctionReturn(0);
649046e270d4SMatthew G. Knepley }
649146e270d4SMatthew G. Knepley 
6492e8abe2deSMatthew G. Knepley /*@
6493e8abe2deSMatthew G. Knepley   DMGetCoordinateSection - Retrieve the layout of coordinate values over the mesh.
6494e8abe2deSMatthew G. Knepley 
6495d083f849SBarry Smith   Collective on dm
6496e8abe2deSMatthew G. Knepley 
6497e8abe2deSMatthew G. Knepley   Input Parameter:
6498e8abe2deSMatthew G. Knepley . dm - The DM object
6499e8abe2deSMatthew G. Knepley 
6500e8abe2deSMatthew G. Knepley   Output Parameter:
6501e8abe2deSMatthew G. Knepley . section - The PetscSection object
6502e8abe2deSMatthew G. Knepley 
6503e8abe2deSMatthew G. Knepley   Level: intermediate
6504e8abe2deSMatthew G. Knepley 
650592fd8e1eSJed Brown .seealso: DMGetCoordinateDM(), DMGetLocalSection(), DMSetLocalSection()
6506e8abe2deSMatthew G. Knepley @*/
6507e8abe2deSMatthew G. Knepley PetscErrorCode DMGetCoordinateSection(DM dm, PetscSection *section)
6508e8abe2deSMatthew G. Knepley {
6509e8abe2deSMatthew G. Knepley   DM             cdm;
6510e8abe2deSMatthew G. Knepley   PetscErrorCode ierr;
6511e8abe2deSMatthew G. Knepley 
6512e8abe2deSMatthew G. Knepley   PetscFunctionBegin;
6513e8abe2deSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6514e8abe2deSMatthew G. Knepley   PetscValidPointer(section, 2);
6515e8abe2deSMatthew G. Knepley   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
651692fd8e1eSJed Brown   ierr = DMGetLocalSection(cdm, section);CHKERRQ(ierr);
6517e8abe2deSMatthew G. Knepley   PetscFunctionReturn(0);
6518e8abe2deSMatthew G. Knepley }
6519e8abe2deSMatthew G. Knepley 
6520e8abe2deSMatthew G. Knepley /*@
6521e8abe2deSMatthew G. Knepley   DMSetCoordinateSection - Set the layout of coordinate values over the mesh.
6522e8abe2deSMatthew G. Knepley 
6523e8abe2deSMatthew G. Knepley   Not Collective
6524e8abe2deSMatthew G. Knepley 
6525e8abe2deSMatthew G. Knepley   Input Parameters:
6526e8abe2deSMatthew G. Knepley + dm      - The DM object
652746e270d4SMatthew G. Knepley . dim     - The embedding dimension, or PETSC_DETERMINE
6528e8abe2deSMatthew G. Knepley - section - The PetscSection object
6529e8abe2deSMatthew G. Knepley 
6530e8abe2deSMatthew G. Knepley   Level: intermediate
6531e8abe2deSMatthew G. Knepley 
653292fd8e1eSJed Brown .seealso: DMGetCoordinateSection(), DMGetLocalSection(), DMSetLocalSection()
6533e8abe2deSMatthew G. Knepley @*/
653446e270d4SMatthew G. Knepley PetscErrorCode DMSetCoordinateSection(DM dm, PetscInt dim, PetscSection section)
6535e8abe2deSMatthew G. Knepley {
6536e8abe2deSMatthew G. Knepley   DM             cdm;
6537e8abe2deSMatthew G. Knepley   PetscErrorCode ierr;
6538e8abe2deSMatthew G. Knepley 
6539e8abe2deSMatthew G. Knepley   PetscFunctionBegin;
6540e8abe2deSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
654146e270d4SMatthew G. Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,3);
6542e8abe2deSMatthew G. Knepley   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
654392fd8e1eSJed Brown   ierr = DMSetLocalSection(cdm, section);CHKERRQ(ierr);
654446e270d4SMatthew G. Knepley   if (dim == PETSC_DETERMINE) {
65454c1069a6SMatthew G. Knepley     PetscInt d = PETSC_DEFAULT;
654646e270d4SMatthew G. Knepley     PetscInt pStart, pEnd, vStart, vEnd, v, dd;
654746e270d4SMatthew G. Knepley 
654846e270d4SMatthew G. Knepley     ierr = PetscSectionGetChart(section, &pStart, &pEnd);CHKERRQ(ierr);
654946e270d4SMatthew G. Knepley     ierr = DMGetDimPoints(dm, 0, &vStart, &vEnd);CHKERRQ(ierr);
655046e270d4SMatthew G. Knepley     pStart = PetscMax(vStart, pStart);
655146e270d4SMatthew G. Knepley     pEnd   = PetscMin(vEnd, pEnd);
655246e270d4SMatthew G. Knepley     for (v = pStart; v < pEnd; ++v) {
655346e270d4SMatthew G. Knepley       ierr = PetscSectionGetDof(section, v, &dd);CHKERRQ(ierr);
655446e270d4SMatthew G. Knepley       if (dd) {d = dd; break;}
655546e270d4SMatthew G. Knepley     }
6556ebfe4b0dSMatthew G. Knepley     if (d >= 0) {ierr = DMSetCoordinateDim(dm, d);CHKERRQ(ierr);}
655746e270d4SMatthew G. Knepley   }
6558e8abe2deSMatthew G. Knepley   PetscFunctionReturn(0);
6559e8abe2deSMatthew G. Knepley }
6560e8abe2deSMatthew G. Knepley 
6561d864a3eaSLisandro Dalcin /*@
6562d864a3eaSLisandro Dalcin   DMProjectCoordinates - Project coordinates to a different space
6563d864a3eaSLisandro Dalcin 
6564d864a3eaSLisandro Dalcin   Input Parameters:
6565d864a3eaSLisandro Dalcin + dm      - The DM object
6566d864a3eaSLisandro Dalcin - disc    - The new coordinate discretization
6567d864a3eaSLisandro Dalcin 
6568d864a3eaSLisandro Dalcin   Level: intermediate
6569d864a3eaSLisandro Dalcin 
6570d864a3eaSLisandro Dalcin .seealso: DMGetCoordinateField()
6571d864a3eaSLisandro Dalcin @*/
6572d864a3eaSLisandro Dalcin PetscErrorCode DMProjectCoordinates(DM dm, PetscFE disc)
6573d864a3eaSLisandro Dalcin {
6574d864a3eaSLisandro Dalcin   PetscObject    discOld;
6575d864a3eaSLisandro Dalcin   PetscClassId   classid;
6576d864a3eaSLisandro Dalcin   DM             cdmOld,cdmNew;
6577d864a3eaSLisandro Dalcin   Vec            coordsOld,coordsNew;
6578d864a3eaSLisandro Dalcin   Mat            matInterp;
6579d864a3eaSLisandro Dalcin   PetscErrorCode ierr;
6580d864a3eaSLisandro Dalcin 
6581d864a3eaSLisandro Dalcin   PetscFunctionBegin;
6582d864a3eaSLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6583d864a3eaSLisandro Dalcin   PetscValidHeaderSpecific(disc,PETSCFE_CLASSID,2);
6584d864a3eaSLisandro Dalcin 
6585d864a3eaSLisandro Dalcin   ierr = DMGetCoordinateDM(dm, &cdmOld);CHKERRQ(ierr);
6586d864a3eaSLisandro Dalcin   /* Check current discretization is compatible */
6587d864a3eaSLisandro Dalcin   ierr = DMGetField(cdmOld, 0, NULL, &discOld);CHKERRQ(ierr);
6588d864a3eaSLisandro Dalcin   ierr = PetscObjectGetClassId(discOld, &classid);CHKERRQ(ierr);
658929ad44c5SMatthew G. Knepley   if (classid != PETSCFE_CLASSID) {
659029ad44c5SMatthew G. Knepley     if (classid == PETSC_CONTAINER_CLASSID) {
659129ad44c5SMatthew G. Knepley       PetscFE        feLinear;
659229ad44c5SMatthew G. Knepley       DMPolytopeType ct;
659329ad44c5SMatthew G. Knepley       PetscInt       dim, dE, cStart;
659429ad44c5SMatthew G. Knepley       PetscBool      simplex;
659529ad44c5SMatthew G. Knepley 
659629ad44c5SMatthew G. Knepley       /* Assume linear vertex coordinates */
659729ad44c5SMatthew G. Knepley       ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr);
659829ad44c5SMatthew G. Knepley       ierr = DMGetCoordinateDim(dm, &dE);CHKERRQ(ierr);
659929ad44c5SMatthew G. Knepley       ierr = DMPlexGetHeightStratum(cdmOld, 0, &cStart, NULL);CHKERRQ(ierr);
660029ad44c5SMatthew G. Knepley       ierr = DMPlexGetCellType(dm, cStart, &ct);CHKERRQ(ierr);
660129ad44c5SMatthew G. Knepley       switch (ct) {
660229ad44c5SMatthew G. Knepley         case DM_POLYTOPE_TRI_PRISM:
660329ad44c5SMatthew G. Knepley         case DM_POLYTOPE_TRI_PRISM_TENSOR:
660429ad44c5SMatthew G. Knepley           SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SUP, "Cannot autoamtically create coordinate space for prisms");
660529ad44c5SMatthew G. Knepley         default: break;
660629ad44c5SMatthew G. Knepley       }
660729ad44c5SMatthew G. Knepley       simplex = DMPolytopeTypeGetNumVertices(ct) == DMPolytopeTypeGetDim(ct)+1 ? PETSC_TRUE : PETSC_FALSE;
660829ad44c5SMatthew G. Knepley       ierr = PetscFECreateLagrange(PETSC_COMM_SELF, dim, dE, simplex, 1, -1, &feLinear);CHKERRQ(ierr);
660929ad44c5SMatthew G. Knepley       ierr = DMSetField(cdmOld, 0, NULL, (PetscObject) feLinear);CHKERRQ(ierr);
661029ad44c5SMatthew G. Knepley       ierr = PetscFEDestroy(&feLinear);CHKERRQ(ierr);
661129ad44c5SMatthew G. Knepley       ierr = DMCreateDS(cdmOld);CHKERRQ(ierr);
661229ad44c5SMatthew G. Knepley     } else {
661329ad44c5SMatthew G. Knepley       const char *discname;
661429ad44c5SMatthew G. Knepley 
661529ad44c5SMatthew G. Knepley       ierr = PetscObjectGetType(discOld, &discname);CHKERRQ(ierr);
661629ad44c5SMatthew G. Knepley       SETERRQ1(PetscObjectComm(discOld), PETSC_ERR_SUP, "Discretization type %s not supported", discname);
661729ad44c5SMatthew G. Knepley     }
661829ad44c5SMatthew G. Knepley   }
6619d864a3eaSLisandro Dalcin   /* Make a fresh clone of the coordinate DM */
6620d864a3eaSLisandro Dalcin   ierr = DMClone(cdmOld, &cdmNew);CHKERRQ(ierr);
6621d864a3eaSLisandro Dalcin   ierr = DMSetField(cdmNew, 0, NULL, (PetscObject) disc);CHKERRQ(ierr);
6622d864a3eaSLisandro Dalcin   ierr = DMCreateDS(cdmNew);CHKERRQ(ierr);
6623d864a3eaSLisandro Dalcin   /* Project the coordinate vector from old to new space  */
6624d864a3eaSLisandro Dalcin   ierr = DMGetCoordinates(dm, &coordsOld);CHKERRQ(ierr);
6625d864a3eaSLisandro Dalcin   ierr = DMCreateGlobalVector(cdmNew, &coordsNew);CHKERRQ(ierr);
6626d864a3eaSLisandro Dalcin   ierr = DMCreateInterpolation(cdmOld, cdmNew, &matInterp, NULL);CHKERRQ(ierr);
6627d864a3eaSLisandro Dalcin   ierr = MatInterpolate(matInterp, coordsOld, coordsNew);CHKERRQ(ierr);
6628d864a3eaSLisandro Dalcin   ierr = MatDestroy(&matInterp);CHKERRQ(ierr);
6629d864a3eaSLisandro Dalcin   /* Set new coordinate structures */
6630d864a3eaSLisandro Dalcin   ierr = DMSetCoordinateField(dm, NULL);CHKERRQ(ierr);
6631d864a3eaSLisandro Dalcin   ierr = DMSetCoordinateDM(dm, cdmNew);CHKERRQ(ierr);
6632d864a3eaSLisandro Dalcin   ierr = DMSetCoordinates(dm, coordsNew);CHKERRQ(ierr);
6633d864a3eaSLisandro Dalcin   ierr = VecDestroy(&coordsNew);CHKERRQ(ierr);
6634d864a3eaSLisandro Dalcin   ierr = DMDestroy(&cdmNew);CHKERRQ(ierr);
6635d864a3eaSLisandro Dalcin   PetscFunctionReturn(0);
6636d864a3eaSLisandro Dalcin }
6637d864a3eaSLisandro Dalcin 
66385dc8c3f7SMatthew G. Knepley /*@C
663990b157c4SStefano Zampini   DMGetPeriodicity - Get the description of mesh periodicity
66405dc8c3f7SMatthew G. Knepley 
66415dc8c3f7SMatthew G. Knepley   Input Parameters:
664290b157c4SStefano Zampini . dm      - The DM object
664390b157c4SStefano Zampini 
664490b157c4SStefano Zampini   Output Parameters:
664590b157c4SStefano Zampini + per     - Whether the DM is periodic or not
66465dc8c3f7SMatthew 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
66475dc8c3f7SMatthew G. Knepley . L       - If we assume the mesh is a torus, this is the length of each coordinate
66485dc8c3f7SMatthew G. Knepley - bd      - This describes the type of periodicity in each topological dimension
66495dc8c3f7SMatthew G. Knepley 
66505dc8c3f7SMatthew G. Knepley   Level: developer
66515dc8c3f7SMatthew G. Knepley 
66525dc8c3f7SMatthew G. Knepley .seealso: DMGetPeriodicity()
66535dc8c3f7SMatthew G. Knepley @*/
665490b157c4SStefano Zampini PetscErrorCode DMGetPeriodicity(DM dm, PetscBool *per, const PetscReal **maxCell, const PetscReal **L, const DMBoundaryType **bd)
6655c6b900c6SMatthew G. Knepley {
6656c6b900c6SMatthew G. Knepley   PetscFunctionBegin;
6657c6b900c6SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
665890b157c4SStefano Zampini   if (per)     *per     = dm->periodic;
6659c6b900c6SMatthew G. Knepley   if (L)       *L       = dm->L;
6660c6b900c6SMatthew G. Knepley   if (maxCell) *maxCell = dm->maxCell;
66615dc8c3f7SMatthew G. Knepley   if (bd)      *bd      = dm->bdtype;
6662c6b900c6SMatthew G. Knepley   PetscFunctionReturn(0);
6663c6b900c6SMatthew G. Knepley }
6664c6b900c6SMatthew G. Knepley 
66655dc8c3f7SMatthew G. Knepley /*@C
66665dc8c3f7SMatthew G. Knepley   DMSetPeriodicity - Set the description of mesh periodicity
66675dc8c3f7SMatthew G. Knepley 
66685dc8c3f7SMatthew G. Knepley   Input Parameters:
66695dc8c3f7SMatthew G. Knepley + dm      - The DM object
6670db2bf62eSStefano Zampini . per     - Whether the DM is periodic or not.
6671db2bf62eSStefano 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.
66725dc8c3f7SMatthew G. Knepley . L       - If we assume the mesh is a torus, this is the length of each coordinate
66735dc8c3f7SMatthew G. Knepley - bd      - This describes the type of periodicity in each topological dimension
66745dc8c3f7SMatthew G. Knepley 
6675db2bf62eSStefano 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.
6676db2bf62eSStefano Zampini 
66775dc8c3f7SMatthew G. Knepley   Level: developer
66785dc8c3f7SMatthew G. Knepley 
66795dc8c3f7SMatthew G. Knepley .seealso: DMGetPeriodicity()
66805dc8c3f7SMatthew G. Knepley @*/
668190b157c4SStefano Zampini PetscErrorCode DMSetPeriodicity(DM dm, PetscBool per, const PetscReal maxCell[], const PetscReal L[], const DMBoundaryType bd[])
6682c6b900c6SMatthew G. Knepley {
6683c6b900c6SMatthew G. Knepley   PetscInt       dim, d;
6684c6b900c6SMatthew G. Knepley   PetscErrorCode ierr;
6685c6b900c6SMatthew G. Knepley 
6686c6b900c6SMatthew G. Knepley   PetscFunctionBegin;
6687c6b900c6SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
668890b157c4SStefano Zampini   PetscValidLogicalCollectiveBool(dm,per,2);
6689412e9a14SMatthew G. Knepley   if (maxCell) {PetscValidRealPointer(maxCell,3);}
6690412e9a14SMatthew G. Knepley   if (L)       {PetscValidRealPointer(L,4);}
6691412e9a14SMatthew G. Knepley   if (bd)      {PetscValidPointer(bd,5);}
66925dc8c3f7SMatthew G. Knepley   ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr);
669390b157c4SStefano Zampini   if (maxCell) {
6694412e9a14SMatthew G. Knepley     if (!dm->maxCell) {ierr = PetscMalloc1(dim, &dm->maxCell);CHKERRQ(ierr);}
6695412e9a14SMatthew G. Knepley     for (d = 0; d < dim; ++d) dm->maxCell[d] = maxCell[d];
6696db2bf62eSStefano Zampini   } else { /* remove maxCell information to disable automatic computation of localized vertices */
6697db2bf62eSStefano Zampini     ierr = PetscFree(dm->maxCell);CHKERRQ(ierr);
6698412e9a14SMatthew G. Knepley   }
6699db2bf62eSStefano Zampini 
6700412e9a14SMatthew G. Knepley   if (L) {
6701412e9a14SMatthew G. Knepley     if (!dm->L) {ierr = PetscMalloc1(dim, &dm->L);CHKERRQ(ierr);}
6702412e9a14SMatthew G. Knepley     for (d = 0; d < dim; ++d) dm->L[d] = L[d];
6703412e9a14SMatthew G. Knepley   }
6704412e9a14SMatthew G. Knepley   if (bd) {
6705412e9a14SMatthew G. Knepley     if (!dm->bdtype) {ierr = PetscMalloc1(dim, &dm->bdtype);CHKERRQ(ierr);}
6706412e9a14SMatthew G. Knepley     for (d = 0; d < dim; ++d) dm->bdtype[d] = bd[d];
670790b157c4SStefano Zampini   }
6708072d7d67SStefano Zampini   dm->periodic = per;
6709c6b900c6SMatthew G. Knepley   PetscFunctionReturn(0);
6710c6b900c6SMatthew G. Knepley }
6711c6b900c6SMatthew G. Knepley 
67122e17dfb7SMatthew G. Knepley /*@
67132e17dfb7SMatthew 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.
67142e17dfb7SMatthew G. Knepley 
67152e17dfb7SMatthew G. Knepley   Input Parameters:
67162e17dfb7SMatthew G. Knepley + dm     - The DM
671765da65dcSMatthew G. Knepley . in     - The input coordinate point (dim numbers)
671865da65dcSMatthew G. Knepley - endpoint - Include the endpoint L_i
67192e17dfb7SMatthew G. Knepley 
67202e17dfb7SMatthew G. Knepley   Output Parameter:
67212e17dfb7SMatthew G. Knepley . out - The localized coordinate point
67222e17dfb7SMatthew G. Knepley 
67232e17dfb7SMatthew G. Knepley   Level: developer
67242e17dfb7SMatthew G. Knepley 
67252e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeAddCoordinate()
67262e17dfb7SMatthew G. Knepley @*/
672765da65dcSMatthew G. Knepley PetscErrorCode DMLocalizeCoordinate(DM dm, const PetscScalar in[], PetscBool endpoint, PetscScalar out[])
67282e17dfb7SMatthew G. Knepley {
67292e17dfb7SMatthew G. Knepley   PetscInt       dim, d;
67302e17dfb7SMatthew G. Knepley   PetscErrorCode ierr;
67312e17dfb7SMatthew G. Knepley 
67322e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
67332e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &dim);CHKERRQ(ierr);
67342e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
67352e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] = in[d];
67362e17dfb7SMatthew G. Knepley   } else {
673765da65dcSMatthew G. Knepley     if (endpoint) {
673865da65dcSMatthew G. Knepley       for (d = 0; d < dim; ++d) {
6739da3333bfSMatthew 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)) {
6740da3333bfSMatthew G. Knepley           out[d] = in[d] - dm->L[d]*(PetscFloorReal(PetscRealPart(in[d])/dm->L[d]) - 1);
674165da65dcSMatthew G. Knepley         } else {
6742da3333bfSMatthew G. Knepley           out[d] = in[d] - dm->L[d]*PetscFloorReal(PetscRealPart(in[d])/dm->L[d]);
674365da65dcSMatthew G. Knepley         }
674465da65dcSMatthew G. Knepley       }
674565da65dcSMatthew G. Knepley     } else {
67462e17dfb7SMatthew G. Knepley       for (d = 0; d < dim; ++d) {
67471118d4bcSLisandro Dalcin         out[d] = in[d] - dm->L[d]*PetscFloorReal(PetscRealPart(in[d])/dm->L[d]);
67482e17dfb7SMatthew G. Knepley       }
67492e17dfb7SMatthew G. Knepley     }
675065da65dcSMatthew G. Knepley   }
67512e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
67522e17dfb7SMatthew G. Knepley }
67532e17dfb7SMatthew G. Knepley 
67542e17dfb7SMatthew G. Knepley /*
67552e17dfb7SMatthew 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.
67562e17dfb7SMatthew G. Knepley 
67572e17dfb7SMatthew G. Knepley   Input Parameters:
67582e17dfb7SMatthew G. Knepley + dm     - The DM
67592e17dfb7SMatthew G. Knepley . dim    - The spatial dimension
67602e17dfb7SMatthew G. Knepley . anchor - The anchor point, the input point can be no more than maxCell away from it
67612e17dfb7SMatthew G. Knepley - in     - The input coordinate point (dim numbers)
67622e17dfb7SMatthew G. Knepley 
67632e17dfb7SMatthew G. Knepley   Output Parameter:
67642e17dfb7SMatthew G. Knepley . out - The localized coordinate point
67652e17dfb7SMatthew G. Knepley 
67662e17dfb7SMatthew G. Knepley   Level: developer
67672e17dfb7SMatthew G. Knepley 
67682e17dfb7SMatthew 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
67692e17dfb7SMatthew G. Knepley 
67702e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeAddCoordinate()
67712e17dfb7SMatthew G. Knepley */
67722e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinate_Internal(DM dm, PetscInt dim, const PetscScalar anchor[], const PetscScalar in[], PetscScalar out[])
67732e17dfb7SMatthew G. Knepley {
67742e17dfb7SMatthew G. Knepley   PetscInt d;
67752e17dfb7SMatthew G. Knepley 
67762e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
67772e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
67782e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] = in[d];
67792e17dfb7SMatthew G. Knepley   } else {
67802e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) {
6781908eca10SMatthew G. Knepley       if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsScalar(anchor[d] - in[d]) > dm->maxCell[d])) {
67822e17dfb7SMatthew G. Knepley         out[d] = PetscRealPart(anchor[d]) > PetscRealPart(in[d]) ? dm->L[d] + in[d] : in[d] - dm->L[d];
67832e17dfb7SMatthew G. Knepley       } else {
67842e17dfb7SMatthew G. Knepley         out[d] = in[d];
67852e17dfb7SMatthew G. Knepley       }
67862e17dfb7SMatthew G. Knepley     }
67872e17dfb7SMatthew G. Knepley   }
67882e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
67892e17dfb7SMatthew G. Knepley }
6790a5801f52SStefano Zampini 
67912e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinateReal_Internal(DM dm, PetscInt dim, const PetscReal anchor[], const PetscReal in[], PetscReal out[])
67922e17dfb7SMatthew G. Knepley {
67932e17dfb7SMatthew G. Knepley   PetscInt d;
67942e17dfb7SMatthew G. Knepley 
67952e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
67962e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
67972e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] = in[d];
67982e17dfb7SMatthew G. Knepley   } else {
67992e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) {
6800908eca10SMatthew G. Knepley       if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsReal(anchor[d] - in[d]) > dm->maxCell[d])) {
68012e17dfb7SMatthew G. Knepley         out[d] = anchor[d] > in[d] ? dm->L[d] + in[d] : in[d] - dm->L[d];
68022e17dfb7SMatthew G. Knepley       } else {
68032e17dfb7SMatthew G. Knepley         out[d] = in[d];
68042e17dfb7SMatthew G. Knepley       }
68052e17dfb7SMatthew G. Knepley     }
68062e17dfb7SMatthew G. Knepley   }
68072e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
68082e17dfb7SMatthew G. Knepley }
68092e17dfb7SMatthew G. Knepley 
68102e17dfb7SMatthew G. Knepley /*
68112e17dfb7SMatthew 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.
68122e17dfb7SMatthew G. Knepley 
68132e17dfb7SMatthew G. Knepley   Input Parameters:
68142e17dfb7SMatthew G. Knepley + dm     - The DM
68152e17dfb7SMatthew G. Knepley . dim    - The spatial dimension
68162e17dfb7SMatthew G. Knepley . anchor - The anchor point, the input point can be no more than maxCell away from it
68172e17dfb7SMatthew G. Knepley . in     - The input coordinate delta (dim numbers)
68182e17dfb7SMatthew G. Knepley - out    - The input coordinate point (dim numbers)
68192e17dfb7SMatthew G. Knepley 
68202e17dfb7SMatthew G. Knepley   Output Parameter:
68212e17dfb7SMatthew G. Knepley . out    - The localized coordinate in + out
68222e17dfb7SMatthew G. Knepley 
68232e17dfb7SMatthew G. Knepley   Level: developer
68242e17dfb7SMatthew G. Knepley 
68252e17dfb7SMatthew 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
68262e17dfb7SMatthew G. Knepley 
68272e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeCoordinate()
68282e17dfb7SMatthew G. Knepley */
68292e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeAddCoordinate_Internal(DM dm, PetscInt dim, const PetscScalar anchor[], const PetscScalar in[], PetscScalar out[])
68302e17dfb7SMatthew G. Knepley {
68312e17dfb7SMatthew G. Knepley   PetscInt d;
68322e17dfb7SMatthew G. Knepley 
68332e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
68342e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
68352e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] += in[d];
68362e17dfb7SMatthew G. Knepley   } else {
68372e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) {
6838412e9a14SMatthew G. Knepley       const PetscReal maxC = dm->maxCell[d];
6839412e9a14SMatthew G. Knepley 
6840412e9a14SMatthew G. Knepley       if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsScalar(anchor[d] - in[d]) > maxC)) {
6841412e9a14SMatthew G. Knepley         const PetscScalar newCoord = PetscRealPart(anchor[d]) > PetscRealPart(in[d]) ? dm->L[d] + in[d] : in[d] - dm->L[d];
6842412e9a14SMatthew G. Knepley 
6843412e9a14SMatthew G. Knepley         if (PetscAbsScalar(newCoord - anchor[d]) > maxC)
6844412e9a14SMatthew 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]));
6845412e9a14SMatthew G. Knepley         out[d] += newCoord;
68462e17dfb7SMatthew G. Knepley       } else {
68472e17dfb7SMatthew G. Knepley         out[d] += in[d];
68482e17dfb7SMatthew G. Knepley       }
68492e17dfb7SMatthew G. Knepley     }
68502e17dfb7SMatthew G. Knepley   }
68512e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
68522e17dfb7SMatthew G. Knepley }
68532e17dfb7SMatthew G. Knepley 
685436447a5eSToby Isaac /*@
68558f700142SStefano Zampini   DMGetCoordinatesLocalizedLocal - Check if the DM coordinates have been localized for cells on this process
68568f700142SStefano Zampini 
68578f700142SStefano Zampini   Not collective
685836447a5eSToby Isaac 
685936447a5eSToby Isaac   Input Parameter:
686036447a5eSToby Isaac . dm - The DM
686136447a5eSToby Isaac 
686236447a5eSToby Isaac   Output Parameter:
686336447a5eSToby Isaac   areLocalized - True if localized
686436447a5eSToby Isaac 
686536447a5eSToby Isaac   Level: developer
686636447a5eSToby Isaac 
68678f700142SStefano Zampini .seealso: DMLocalizeCoordinates(), DMGetCoordinatesLocalized(), DMSetPeriodicity()
686836447a5eSToby Isaac @*/
68698f700142SStefano Zampini PetscErrorCode DMGetCoordinatesLocalizedLocal(DM dm,PetscBool *areLocalized)
687036447a5eSToby Isaac {
687136447a5eSToby Isaac   DM             cdm;
687236447a5eSToby Isaac   PetscSection   coordSection;
68732ccac677SMatthew G. Knepley   PetscInt       depth, cStart, cEnd, sStart, sEnd, c, dof;
687446a3a80fSLisandro Dalcin   PetscBool      isPlex, alreadyLocalized;
687536447a5eSToby Isaac   PetscErrorCode ierr;
687636447a5eSToby Isaac 
687736447a5eSToby Isaac   PetscFunctionBegin;
687836447a5eSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6879534a8f05SLisandro Dalcin   PetscValidBoolPointer(areLocalized, 2);
68808b09590cSToby Isaac   *areLocalized = PETSC_FALSE;
688146a3a80fSLisandro Dalcin 
688236447a5eSToby Isaac   /* We need some generic way of refering to cells/vertices */
688336447a5eSToby Isaac   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
688446a3a80fSLisandro Dalcin   ierr = PetscObjectTypeCompare((PetscObject) cdm, DMPLEX, &isPlex);CHKERRQ(ierr);
68859f7230bfSMatthew G. Knepley   if (!isPlex) PetscFunctionReturn(0);
68862ccac677SMatthew G. Knepley   ierr = DMPlexGetDepth(cdm, &depth);CHKERRQ(ierr);
68872ccac677SMatthew G. Knepley   if (!depth) PetscFunctionReturn(0);
688846a3a80fSLisandro Dalcin 
68899f7230bfSMatthew G. Knepley   ierr = DMGetCoordinateSection(dm, &coordSection);CHKERRQ(ierr);
689046a3a80fSLisandro Dalcin   ierr = DMPlexGetHeightStratum(cdm, 0, &cStart, &cEnd);CHKERRQ(ierr);
689136447a5eSToby Isaac   ierr = PetscSectionGetChart(coordSection, &sStart, &sEnd);CHKERRQ(ierr);
689236447a5eSToby Isaac   alreadyLocalized = PETSC_FALSE;
689346a3a80fSLisandro Dalcin   for (c = cStart; c < cEnd; ++c) {
689446a3a80fSLisandro Dalcin     if (c < sStart || c >= sEnd) continue;
689536447a5eSToby Isaac     ierr = PetscSectionGetDof(coordSection, c, &dof);CHKERRQ(ierr);
689646a3a80fSLisandro Dalcin     if (dof) { alreadyLocalized = PETSC_TRUE; break; }
689736447a5eSToby Isaac   }
68988f700142SStefano Zampini   *areLocalized = alreadyLocalized;
689936447a5eSToby Isaac   PetscFunctionReturn(0);
690036447a5eSToby Isaac }
690136447a5eSToby Isaac 
69028f700142SStefano Zampini /*@
69038f700142SStefano Zampini   DMGetCoordinatesLocalized - Check if the DM coordinates have been localized for cells
69048f700142SStefano Zampini 
69058f700142SStefano Zampini   Collective on dm
69068f700142SStefano Zampini 
69078f700142SStefano Zampini   Input Parameter:
69088f700142SStefano Zampini . dm - The DM
69098f700142SStefano Zampini 
69108f700142SStefano Zampini   Output Parameter:
69118f700142SStefano Zampini   areLocalized - True if localized
69128f700142SStefano Zampini 
69138f700142SStefano Zampini   Level: developer
69148f700142SStefano Zampini 
69158f700142SStefano Zampini .seealso: DMLocalizeCoordinates(), DMSetPeriodicity(), DMGetCoordinatesLocalizedLocal()
69168f700142SStefano Zampini @*/
69178f700142SStefano Zampini PetscErrorCode DMGetCoordinatesLocalized(DM dm,PetscBool *areLocalized)
69188f700142SStefano Zampini {
69198f700142SStefano Zampini   PetscBool      localized;
69208f700142SStefano Zampini   PetscErrorCode ierr;
69218f700142SStefano Zampini 
69228f700142SStefano Zampini   PetscFunctionBegin;
69238f700142SStefano Zampini   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6924534a8f05SLisandro Dalcin   PetscValidBoolPointer(areLocalized, 2);
69258f700142SStefano Zampini   ierr = DMGetCoordinatesLocalizedLocal(dm,&localized);CHKERRQ(ierr);
6926820f2d46SBarry Smith   ierr = MPIU_Allreduce(&localized,areLocalized,1,MPIU_BOOL,MPI_LOR,PetscObjectComm((PetscObject)dm));CHKERRMPI(ierr);
69278f700142SStefano Zampini   PetscFunctionReturn(0);
69288f700142SStefano Zampini }
692936447a5eSToby Isaac 
69302e17dfb7SMatthew G. Knepley /*@
6931492b8470SStefano Zampini   DMLocalizeCoordinates - If a mesh is periodic, create local coordinates for cells having periodic faces
69322e17dfb7SMatthew G. Knepley 
69338f700142SStefano Zampini   Collective on dm
69348f700142SStefano Zampini 
69352e17dfb7SMatthew G. Knepley   Input Parameter:
69362e17dfb7SMatthew G. Knepley . dm - The DM
69372e17dfb7SMatthew G. Knepley 
69382e17dfb7SMatthew G. Knepley   Level: developer
69392e17dfb7SMatthew G. Knepley 
69408f700142SStefano Zampini .seealso: DMSetPeriodicity(), DMLocalizeCoordinate(), DMLocalizeAddCoordinate()
69412e17dfb7SMatthew G. Knepley @*/
69422e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinates(DM dm)
69432e17dfb7SMatthew G. Knepley {
69442e17dfb7SMatthew G. Knepley   DM             cdm;
69452e17dfb7SMatthew G. Knepley   PetscSection   coordSection, cSection;
69462e17dfb7SMatthew G. Knepley   Vec            coordinates,  cVec;
69473e922f36SToby Isaac   PetscScalar   *coords, *coords2, *anchor, *localized;
69483e922f36SToby Isaac   PetscInt       Nc, vStart, vEnd, v, sStart, sEnd, newStart = PETSC_MAX_INT, newEnd = PETSC_MIN_INT, dof, d, off, off2, bs, coordSize;
6949e0ae35bbSToby Isaac   PetscBool      alreadyLocalized, alreadyLocalizedGlobal;
69503e922f36SToby Isaac   PetscInt       maxHeight = 0, h;
69513e922f36SToby Isaac   PetscInt       *pStart = NULL, *pEnd = NULL;
69522e17dfb7SMatthew G. Knepley   PetscErrorCode ierr;
69532e17dfb7SMatthew G. Knepley 
69542e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
69552e17dfb7SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
695692c9c85fSStefano Zampini   if (!dm->periodic) PetscFunctionReturn(0);
6957f7cbd40bSStefano Zampini   ierr = DMGetCoordinatesLocalized(dm, &alreadyLocalized);CHKERRQ(ierr);
6958f7cbd40bSStefano Zampini   if (alreadyLocalized) PetscFunctionReturn(0);
6959f7cbd40bSStefano Zampini 
69602e17dfb7SMatthew G. Knepley   /* We need some generic way of refering to cells/vertices */
69612e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
69622e17dfb7SMatthew G. Knepley   {
69632e17dfb7SMatthew G. Knepley     PetscBool isplex;
69642e17dfb7SMatthew G. Knepley 
69652e17dfb7SMatthew G. Knepley     ierr = PetscObjectTypeCompare((PetscObject) cdm, DMPLEX, &isplex);CHKERRQ(ierr);
69662e17dfb7SMatthew G. Knepley     if (isplex) {
69672e17dfb7SMatthew G. Knepley       ierr = DMPlexGetDepthStratum(cdm, 0, &vStart, &vEnd);CHKERRQ(ierr);
69683e922f36SToby Isaac       ierr = DMPlexGetMaxProjectionHeight(cdm,&maxHeight);CHKERRQ(ierr);
696969291d52SBarry Smith       ierr = DMGetWorkArray(dm,2*(maxHeight + 1),MPIU_INT,&pStart);CHKERRQ(ierr);
69703e922f36SToby Isaac       pEnd = &pStart[maxHeight + 1];
69713e922f36SToby Isaac       newStart = vStart;
69723e922f36SToby Isaac       newEnd   = vEnd;
69733e922f36SToby Isaac       for (h = 0; h <= maxHeight; h++) {
69743e922f36SToby Isaac         ierr = DMPlexGetHeightStratum(cdm, h, &pStart[h], &pEnd[h]);CHKERRQ(ierr);
69753e922f36SToby Isaac         newStart = PetscMin(newStart,pStart[h]);
69763e922f36SToby Isaac         newEnd   = PetscMax(newEnd,pEnd[h]);
69773e922f36SToby Isaac       }
69782e17dfb7SMatthew G. Knepley     } else SETERRQ(PetscObjectComm((PetscObject) cdm), PETSC_ERR_ARG_WRONG, "Coordinate localization requires a DMPLEX coordinate DM");
69792e17dfb7SMatthew G. Knepley   }
69802e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinatesLocal(dm, &coordinates);CHKERRQ(ierr);
698143eeeb2dSStefano Zampini   if (!coordinates) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"Missing local coordinates vector");
69822e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinateSection(dm, &coordSection);CHKERRQ(ierr);
69833e922f36SToby Isaac   ierr = VecGetBlockSize(coordinates, &bs);CHKERRQ(ierr);
6984e0ae35bbSToby Isaac   ierr = PetscSectionGetChart(coordSection,&sStart,&sEnd);CHKERRQ(ierr);
69853e922f36SToby Isaac 
69862e17dfb7SMatthew G. Knepley   ierr = PetscSectionCreate(PetscObjectComm((PetscObject) dm), &cSection);CHKERRQ(ierr);
69872e17dfb7SMatthew G. Knepley   ierr = PetscSectionSetNumFields(cSection, 1);CHKERRQ(ierr);
69882e17dfb7SMatthew G. Knepley   ierr = PetscSectionGetFieldComponents(coordSection, 0, &Nc);CHKERRQ(ierr);
69892e17dfb7SMatthew G. Knepley   ierr = PetscSectionSetFieldComponents(cSection, 0, Nc);CHKERRQ(ierr);
69903e922f36SToby Isaac   ierr = PetscSectionSetChart(cSection, newStart, newEnd);CHKERRQ(ierr);
69913e922f36SToby Isaac 
699269291d52SBarry Smith   ierr = DMGetWorkArray(dm, 2 * bs, MPIU_SCALAR, &anchor);CHKERRQ(ierr);
69933e922f36SToby Isaac   localized = &anchor[bs];
69943e922f36SToby Isaac   alreadyLocalized = alreadyLocalizedGlobal = PETSC_TRUE;
69953e922f36SToby Isaac   for (h = 0; h <= maxHeight; h++) {
69963e922f36SToby Isaac     PetscInt cStart = pStart[h], cEnd = pEnd[h], c;
69973e922f36SToby Isaac 
69983e922f36SToby Isaac     for (c = cStart; c < cEnd; ++c) {
69993e922f36SToby Isaac       PetscScalar *cellCoords = NULL;
70003e922f36SToby Isaac       PetscInt     b;
70013e922f36SToby Isaac 
70023e922f36SToby Isaac       if (c < sStart || c >= sEnd) alreadyLocalized = PETSC_FALSE;
70033e922f36SToby Isaac       ierr = DMPlexVecGetClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
70043e922f36SToby Isaac       for (b = 0; b < bs; ++b) anchor[b] = cellCoords[b];
70053e922f36SToby Isaac       for (d = 0; d < dof/bs; ++d) {
70063e922f36SToby Isaac         ierr = DMLocalizeCoordinate_Internal(dm, bs, anchor, &cellCoords[d*bs], localized);CHKERRQ(ierr);
70073e922f36SToby Isaac         for (b = 0; b < bs; b++) {
70083e922f36SToby Isaac           if (cellCoords[d*bs + b] != localized[b]) break;
70093e922f36SToby Isaac         }
70103e922f36SToby Isaac         if (b < bs) break;
70113e922f36SToby Isaac       }
70123e922f36SToby Isaac       if (d < dof/bs) {
70133e922f36SToby Isaac         if (c >= sStart && c < sEnd) {
70143e922f36SToby Isaac           PetscInt cdof;
70153e922f36SToby Isaac 
70163e922f36SToby Isaac           ierr = PetscSectionGetDof(coordSection, c, &cdof);CHKERRQ(ierr);
70173e922f36SToby Isaac           if (cdof != dof) alreadyLocalized = PETSC_FALSE;
70183e922f36SToby Isaac         }
70193e922f36SToby Isaac         ierr = PetscSectionSetDof(cSection, c, dof);CHKERRQ(ierr);
70203e922f36SToby Isaac         ierr = PetscSectionSetFieldDof(cSection, c, 0, dof);CHKERRQ(ierr);
70213e922f36SToby Isaac       }
70223e922f36SToby Isaac       ierr = DMPlexVecRestoreClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
70233e922f36SToby Isaac     }
70243e922f36SToby Isaac   }
7025ffc4695bSBarry Smith   ierr = MPI_Allreduce(&alreadyLocalized,&alreadyLocalizedGlobal,1,MPIU_BOOL,MPI_LAND,PetscObjectComm((PetscObject)dm));CHKERRMPI(ierr);
70263e922f36SToby Isaac   if (alreadyLocalizedGlobal) {
702769291d52SBarry Smith     ierr = DMRestoreWorkArray(dm, 2 * bs, MPIU_SCALAR, &anchor);CHKERRQ(ierr);
70283e922f36SToby Isaac     ierr = PetscSectionDestroy(&cSection);CHKERRQ(ierr);
702969291d52SBarry Smith     ierr = DMRestoreWorkArray(dm,2*(maxHeight + 1),MPIU_INT,&pStart);CHKERRQ(ierr);
70303e922f36SToby Isaac     PetscFunctionReturn(0);
70313e922f36SToby Isaac   }
70322e17dfb7SMatthew G. Knepley   for (v = vStart; v < vEnd; ++v) {
70332e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetDof(coordSection, v, &dof);CHKERRQ(ierr);
70342e17dfb7SMatthew G. Knepley     ierr = PetscSectionSetDof(cSection, v, dof);CHKERRQ(ierr);
70352e17dfb7SMatthew G. Knepley     ierr = PetscSectionSetFieldDof(cSection, v, 0, dof);CHKERRQ(ierr);
70362e17dfb7SMatthew G. Knepley   }
70372e17dfb7SMatthew G. Knepley   ierr = PetscSectionSetUp(cSection);CHKERRQ(ierr);
70382e17dfb7SMatthew G. Knepley   ierr = PetscSectionGetStorageSize(cSection, &coordSize);CHKERRQ(ierr);
7039c2be7e5eSLisandro Dalcin   ierr = VecCreate(PETSC_COMM_SELF, &cVec);CHKERRQ(ierr);
70402e17dfb7SMatthew G. Knepley   ierr = PetscObjectSetName((PetscObject)cVec,"coordinates");CHKERRQ(ierr);
70412e17dfb7SMatthew G. Knepley   ierr = VecSetBlockSize(cVec, bs);CHKERRQ(ierr);
70422e17dfb7SMatthew G. Knepley   ierr = VecSetSizes(cVec, coordSize, PETSC_DETERMINE);CHKERRQ(ierr);
70432e17dfb7SMatthew G. Knepley   ierr = VecSetType(cVec, VECSTANDARD);CHKERRQ(ierr);
7044c2be7e5eSLisandro Dalcin   ierr = VecGetArrayRead(coordinates, (const PetscScalar**)&coords);CHKERRQ(ierr);
70452e17dfb7SMatthew G. Knepley   ierr = VecGetArray(cVec, &coords2);CHKERRQ(ierr);
70462e17dfb7SMatthew G. Knepley   for (v = vStart; v < vEnd; ++v) {
70472e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetDof(coordSection, v, &dof);CHKERRQ(ierr);
70482e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetOffset(coordSection, v, &off);CHKERRQ(ierr);
70492e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetOffset(cSection,     v, &off2);CHKERRQ(ierr);
70502e17dfb7SMatthew G. Knepley     for (d = 0; d < dof; ++d) coords2[off2+d] = coords[off+d];
70512e17dfb7SMatthew G. Knepley   }
70523e922f36SToby Isaac   for (h = 0; h <= maxHeight; h++) {
70533e922f36SToby Isaac     PetscInt cStart = pStart[h], cEnd = pEnd[h], c;
70543e922f36SToby Isaac 
70552e17dfb7SMatthew G. Knepley     for (c = cStart; c < cEnd; ++c) {
70562e17dfb7SMatthew G. Knepley       PetscScalar *cellCoords = NULL;
70573e922f36SToby Isaac       PetscInt     b, cdof;
70582e17dfb7SMatthew G. Knepley 
70593e922f36SToby Isaac       ierr = PetscSectionGetDof(cSection,c,&cdof);CHKERRQ(ierr);
70603e922f36SToby Isaac       if (!cdof) continue;
70612e17dfb7SMatthew G. Knepley       ierr = DMPlexVecGetClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
70622e17dfb7SMatthew G. Knepley       ierr = PetscSectionGetOffset(cSection, c, &off2);CHKERRQ(ierr);
70632e17dfb7SMatthew G. Knepley       for (b = 0; b < bs; ++b) anchor[b] = cellCoords[b];
70642e17dfb7SMatthew G. Knepley       for (d = 0; d < dof/bs; ++d) {ierr = DMLocalizeCoordinate_Internal(dm, bs, anchor, &cellCoords[d*bs], &coords2[off2+d*bs]);CHKERRQ(ierr);}
70652e17dfb7SMatthew G. Knepley       ierr = DMPlexVecRestoreClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
70662e17dfb7SMatthew G. Knepley     }
70673e922f36SToby Isaac   }
706869291d52SBarry Smith   ierr = DMRestoreWorkArray(dm, 2 * bs, MPIU_SCALAR, &anchor);CHKERRQ(ierr);
706969291d52SBarry Smith   ierr = DMRestoreWorkArray(dm,2*(maxHeight + 1),MPIU_INT,&pStart);CHKERRQ(ierr);
7070c2be7e5eSLisandro Dalcin   ierr = VecRestoreArrayRead(coordinates, (const PetscScalar**)&coords);CHKERRQ(ierr);
70712e17dfb7SMatthew G. Knepley   ierr = VecRestoreArray(cVec, &coords2);CHKERRQ(ierr);
70722e17dfb7SMatthew G. Knepley   ierr = DMSetCoordinateSection(dm, PETSC_DETERMINE, cSection);CHKERRQ(ierr);
70732e17dfb7SMatthew G. Knepley   ierr = DMSetCoordinatesLocal(dm, cVec);CHKERRQ(ierr);
70742e17dfb7SMatthew G. Knepley   ierr = VecDestroy(&cVec);CHKERRQ(ierr);
70752e17dfb7SMatthew G. Knepley   ierr = PetscSectionDestroy(&cSection);CHKERRQ(ierr);
70762e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
70772e17dfb7SMatthew G. Knepley }
70782e17dfb7SMatthew G. Knepley 
7079e87bb0d3SMatthew G Knepley /*@
70803a93e3b7SToby Isaac   DMLocatePoints - Locate the points in v in the mesh and return a PetscSF of the containing cells
7081e87bb0d3SMatthew G Knepley 
7082d083f849SBarry Smith   Collective on v (see explanation below)
7083e87bb0d3SMatthew G Knepley 
7084e87bb0d3SMatthew G Knepley   Input Parameters:
7085e87bb0d3SMatthew G Knepley + dm - The DM
70863a93e3b7SToby Isaac . v - The Vec of points
708762a38674SMatthew G. Knepley . ltype - The type of point location, e.g. DM_POINTLOCATION_NONE or DM_POINTLOCATION_NEAREST
70883a93e3b7SToby Isaac - cells - Points to either NULL, or a PetscSF with guesses for which cells contain each point.
7089e87bb0d3SMatthew G Knepley 
709061e3bb9bSMatthew G Knepley   Output Parameter:
709162a38674SMatthew G. Knepley + v - The Vec of points, which now contains the nearest mesh points to the given points if DM_POINTLOCATION_NEAREST is used
709262a38674SMatthew G. Knepley - cells - The PetscSF containing the ranks and local indices of the containing points.
70933a93e3b7SToby Isaac 
7094e87bb0d3SMatthew G Knepley   Level: developer
709561e3bb9bSMatthew G Knepley 
709662a38674SMatthew G. Knepley   Notes:
70973a93e3b7SToby Isaac   To do a search of the local cells of the mesh, v should have PETSC_COMM_SELF as its communicator.
709862a38674SMatthew G. Knepley   To do a search of all the cells in the distributed mesh, v should have the same communicator as dm.
70993a93e3b7SToby Isaac 
71003a93e3b7SToby Isaac   If *cellSF is NULL on input, a PetscSF will be created.
710162a38674SMatthew G. Knepley   If *cellSF is not NULL on input, it should point to an existing PetscSF, whose graph will be used as initial guesses.
71023a93e3b7SToby Isaac 
71033a93e3b7SToby Isaac   An array that maps each point to its containing cell can be obtained with
71043a93e3b7SToby Isaac 
710562a38674SMatthew G. Knepley $    const PetscSFNode *cells;
710662a38674SMatthew G. Knepley $    PetscInt           nFound;
7107a6216909SToby Isaac $    const PetscInt    *found;
710862a38674SMatthew G. Knepley $
7109a6216909SToby Isaac $    PetscSFGetGraph(cellSF,NULL,&nFound,&found,&cells);
71103a93e3b7SToby Isaac 
71113a93e3b7SToby 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
71123a93e3b7SToby Isaac   the index of the cell in its rank's local numbering.
71133a93e3b7SToby Isaac 
711462a38674SMatthew G. Knepley .seealso: DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal(), DMPointLocationType
711561e3bb9bSMatthew G Knepley @*/
711662a38674SMatthew G. Knepley PetscErrorCode DMLocatePoints(DM dm, Vec v, DMPointLocationType ltype, PetscSF *cellSF)
7117e87bb0d3SMatthew G Knepley {
7118735aa83eSMatthew G Knepley   PetscErrorCode ierr;
7119735aa83eSMatthew G Knepley 
7120e87bb0d3SMatthew G Knepley   PetscFunctionBegin;
7121e87bb0d3SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
7122e87bb0d3SMatthew G Knepley   PetscValidHeaderSpecific(v,VEC_CLASSID,2);
7123e0fc9d1bSMatthew G. Knepley   PetscValidPointer(cellSF,4);
71243a93e3b7SToby Isaac   if (*cellSF) {
71253a93e3b7SToby Isaac     PetscMPIInt result;
71263a93e3b7SToby Isaac 
7127e0fc9d1bSMatthew G. Knepley     PetscValidHeaderSpecific(*cellSF,PETSCSF_CLASSID,4);
7128ffc4695bSBarry Smith     ierr = MPI_Comm_compare(PetscObjectComm((PetscObject)v),PetscObjectComm((PetscObject)*cellSF),&result);CHKERRMPI(ierr);
71293a93e3b7SToby 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");
7130e0fc9d1bSMatthew G. Knepley   } else {
71313a93e3b7SToby Isaac     ierr = PetscSFCreate(PetscObjectComm((PetscObject)v),cellSF);CHKERRQ(ierr);
71323a93e3b7SToby Isaac   }
7133b9d85ea2SLisandro Dalcin   if (!dm->ops->locatepoints) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Point location not available for this DM");
713447a35634SPatrick Farrell   ierr = PetscLogEventBegin(DM_LocatePoints,dm,0,0,0);CHKERRQ(ierr);
713562a38674SMatthew G. Knepley   ierr = (*dm->ops->locatepoints)(dm,v,ltype,*cellSF);CHKERRQ(ierr);
713647a35634SPatrick Farrell   ierr = PetscLogEventEnd(DM_LocatePoints,dm,0,0,0);CHKERRQ(ierr);
7137e87bb0d3SMatthew G Knepley   PetscFunctionReturn(0);
7138e87bb0d3SMatthew G Knepley }
713914f150ffSMatthew G. Knepley 
7140f4d763aaSMatthew G. Knepley /*@
7141f4d763aaSMatthew G. Knepley   DMGetOutputDM - Retrieve the DM associated with the layout for output
7142f4d763aaSMatthew G. Knepley 
71438f700142SStefano Zampini   Collective on dm
71448f700142SStefano Zampini 
7145f4d763aaSMatthew G. Knepley   Input Parameter:
7146f4d763aaSMatthew G. Knepley . dm - The original DM
7147f4d763aaSMatthew G. Knepley 
7148f4d763aaSMatthew G. Knepley   Output Parameter:
7149f4d763aaSMatthew G. Knepley . odm - The DM which provides the layout for output
7150f4d763aaSMatthew G. Knepley 
7151f4d763aaSMatthew G. Knepley   Level: intermediate
7152f4d763aaSMatthew G. Knepley 
7153e87a4003SBarry Smith .seealso: VecView(), DMGetGlobalSection()
7154f4d763aaSMatthew G. Knepley @*/
715514f150ffSMatthew G. Knepley PetscErrorCode DMGetOutputDM(DM dm, DM *odm)
715614f150ffSMatthew G. Knepley {
7157c26acbdeSMatthew G. Knepley   PetscSection   section;
71582d4e4a49SMatthew G. Knepley   PetscBool      hasConstraints, ghasConstraints;
715914f150ffSMatthew G. Knepley   PetscErrorCode ierr;
716014f150ffSMatthew G. Knepley 
716114f150ffSMatthew G. Knepley   PetscFunctionBegin;
716214f150ffSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
716314f150ffSMatthew G. Knepley   PetscValidPointer(odm,2);
716492fd8e1eSJed Brown   ierr = DMGetLocalSection(dm, &section);CHKERRQ(ierr);
7165c26acbdeSMatthew G. Knepley   ierr = PetscSectionHasConstraints(section, &hasConstraints);CHKERRQ(ierr);
7166ffc4695bSBarry Smith   ierr = MPI_Allreduce(&hasConstraints, &ghasConstraints, 1, MPIU_BOOL, MPI_LOR, PetscObjectComm((PetscObject) dm));CHKERRMPI(ierr);
71672d4e4a49SMatthew G. Knepley   if (!ghasConstraints) {
7168c26acbdeSMatthew G. Knepley     *odm = dm;
7169c26acbdeSMatthew G. Knepley     PetscFunctionReturn(0);
7170c26acbdeSMatthew G. Knepley   }
717114f150ffSMatthew G. Knepley   if (!dm->dmBC) {
7172c26acbdeSMatthew G. Knepley     PetscSection newSection, gsection;
717314f150ffSMatthew G. Knepley     PetscSF      sf;
717414f150ffSMatthew G. Knepley 
717514f150ffSMatthew G. Knepley     ierr = DMClone(dm, &dm->dmBC);CHKERRQ(ierr);
7176e5e52638SMatthew G. Knepley     ierr = DMCopyDisc(dm, dm->dmBC);CHKERRQ(ierr);
717714f150ffSMatthew G. Knepley     ierr = PetscSectionClone(section, &newSection);CHKERRQ(ierr);
717892fd8e1eSJed Brown     ierr = DMSetLocalSection(dm->dmBC, newSection);CHKERRQ(ierr);
717914f150ffSMatthew G. Knepley     ierr = PetscSectionDestroy(&newSection);CHKERRQ(ierr);
718014f150ffSMatthew G. Knepley     ierr = DMGetPointSF(dm->dmBC, &sf);CHKERRQ(ierr);
718115b58121SMatthew G. Knepley     ierr = PetscSectionCreateGlobalSection(section, sf, PETSC_TRUE, PETSC_FALSE, &gsection);CHKERRQ(ierr);
7182e87a4003SBarry Smith     ierr = DMSetGlobalSection(dm->dmBC, gsection);CHKERRQ(ierr);
718314f150ffSMatthew G. Knepley     ierr = PetscSectionDestroy(&gsection);CHKERRQ(ierr);
718414f150ffSMatthew G. Knepley   }
718514f150ffSMatthew G. Knepley   *odm = dm->dmBC;
718614f150ffSMatthew G. Knepley   PetscFunctionReturn(0);
718714f150ffSMatthew G. Knepley }
7188f4d763aaSMatthew G. Knepley 
7189f4d763aaSMatthew G. Knepley /*@
7190cdb7a50dSMatthew G. Knepley   DMGetOutputSequenceNumber - Retrieve the sequence number/value for output
7191f4d763aaSMatthew G. Knepley 
7192f4d763aaSMatthew G. Knepley   Input Parameter:
7193f4d763aaSMatthew G. Knepley . dm - The original DM
7194f4d763aaSMatthew G. Knepley 
7195cdb7a50dSMatthew G. Knepley   Output Parameters:
7196cdb7a50dSMatthew G. Knepley + num - The output sequence number
7197cdb7a50dSMatthew G. Knepley - val - The output sequence value
7198f4d763aaSMatthew G. Knepley 
7199f4d763aaSMatthew G. Knepley   Level: intermediate
7200f4d763aaSMatthew G. Knepley 
7201f4d763aaSMatthew G. Knepley   Note: This is intended for output that should appear in sequence, for instance
7202f4d763aaSMatthew G. Knepley   a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system.
7203f4d763aaSMatthew G. Knepley 
7204f4d763aaSMatthew G. Knepley .seealso: VecView()
7205f4d763aaSMatthew G. Knepley @*/
7206cdb7a50dSMatthew G. Knepley PetscErrorCode DMGetOutputSequenceNumber(DM dm, PetscInt *num, PetscReal *val)
7207f4d763aaSMatthew G. Knepley {
7208f4d763aaSMatthew G. Knepley   PetscFunctionBegin;
7209f4d763aaSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
7210534a8f05SLisandro Dalcin   if (num) {PetscValidIntPointer(num,2); *num = dm->outputSequenceNum;}
7211534a8f05SLisandro Dalcin   if (val) {PetscValidRealPointer(val,3);*val = dm->outputSequenceVal;}
7212f4d763aaSMatthew G. Knepley   PetscFunctionReturn(0);
7213f4d763aaSMatthew G. Knepley }
7214f4d763aaSMatthew G. Knepley 
7215f4d763aaSMatthew G. Knepley /*@
7216cdb7a50dSMatthew G. Knepley   DMSetOutputSequenceNumber - Set the sequence number/value for output
7217f4d763aaSMatthew G. Knepley 
7218f4d763aaSMatthew G. Knepley   Input Parameters:
7219f4d763aaSMatthew G. Knepley + dm - The original DM
7220cdb7a50dSMatthew G. Knepley . num - The output sequence number
7221cdb7a50dSMatthew G. Knepley - val - The output sequence value
7222f4d763aaSMatthew G. Knepley 
7223f4d763aaSMatthew G. Knepley   Level: intermediate
7224f4d763aaSMatthew G. Knepley 
7225f4d763aaSMatthew G. Knepley   Note: This is intended for output that should appear in sequence, for instance
7226f4d763aaSMatthew G. Knepley   a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system.
7227f4d763aaSMatthew G. Knepley 
7228f4d763aaSMatthew G. Knepley .seealso: VecView()
7229f4d763aaSMatthew G. Knepley @*/
7230cdb7a50dSMatthew G. Knepley PetscErrorCode DMSetOutputSequenceNumber(DM dm, PetscInt num, PetscReal val)
7231f4d763aaSMatthew G. Knepley {
7232f4d763aaSMatthew G. Knepley   PetscFunctionBegin;
7233f4d763aaSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
7234f4d763aaSMatthew G. Knepley   dm->outputSequenceNum = num;
7235cdb7a50dSMatthew G. Knepley   dm->outputSequenceVal = val;
7236cdb7a50dSMatthew G. Knepley   PetscFunctionReturn(0);
7237cdb7a50dSMatthew G. Knepley }
7238cdb7a50dSMatthew G. Knepley 
7239cdb7a50dSMatthew G. Knepley /*@C
7240cdb7a50dSMatthew G. Knepley   DMOutputSequenceLoad - Retrieve the sequence value from a Viewer
7241cdb7a50dSMatthew G. Knepley 
7242cdb7a50dSMatthew G. Knepley   Input Parameters:
7243cdb7a50dSMatthew G. Knepley + dm   - The original DM
7244cdb7a50dSMatthew G. Knepley . name - The sequence name
7245cdb7a50dSMatthew G. Knepley - num  - The output sequence number
7246cdb7a50dSMatthew G. Knepley 
7247cdb7a50dSMatthew G. Knepley   Output Parameter:
7248cdb7a50dSMatthew G. Knepley . val  - The output sequence value
7249cdb7a50dSMatthew G. Knepley 
7250cdb7a50dSMatthew G. Knepley   Level: intermediate
7251cdb7a50dSMatthew G. Knepley 
7252cdb7a50dSMatthew G. Knepley   Note: This is intended for output that should appear in sequence, for instance
7253cdb7a50dSMatthew G. Knepley   a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system.
7254cdb7a50dSMatthew G. Knepley 
7255cdb7a50dSMatthew G. Knepley .seealso: DMGetOutputSequenceNumber(), DMSetOutputSequenceNumber(), VecView()
7256cdb7a50dSMatthew G. Knepley @*/
7257cdb7a50dSMatthew G. Knepley PetscErrorCode DMOutputSequenceLoad(DM dm, PetscViewer viewer, const char *name, PetscInt num, PetscReal *val)
7258cdb7a50dSMatthew G. Knepley {
7259cdb7a50dSMatthew G. Knepley   PetscBool      ishdf5;
7260cdb7a50dSMatthew G. Knepley   PetscErrorCode ierr;
7261cdb7a50dSMatthew G. Knepley 
7262cdb7a50dSMatthew G. Knepley   PetscFunctionBegin;
7263cdb7a50dSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
7264cdb7a50dSMatthew G. Knepley   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
7265064a246eSJacob Faibussowitsch   PetscValidRealPointer(val,5);
7266cdb7a50dSMatthew G. Knepley   ierr = PetscObjectTypeCompare((PetscObject) viewer, PETSCVIEWERHDF5, &ishdf5);CHKERRQ(ierr);
7267cdb7a50dSMatthew G. Knepley   if (ishdf5) {
7268cdb7a50dSMatthew G. Knepley #if defined(PETSC_HAVE_HDF5)
7269cdb7a50dSMatthew G. Knepley     PetscScalar value;
7270cdb7a50dSMatthew G. Knepley 
727139d25373SMatthew G. Knepley     ierr = DMSequenceLoad_HDF5_Internal(dm, name, num, &value, viewer);CHKERRQ(ierr);
72724aeb217fSMatthew G. Knepley     *val = PetscRealPart(value);
7273cdb7a50dSMatthew G. Knepley #endif
7274cdb7a50dSMatthew G. Knepley   } else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Invalid viewer; open viewer with PetscViewerHDF5Open()");
7275f4d763aaSMatthew G. Knepley   PetscFunctionReturn(0);
7276f4d763aaSMatthew G. Knepley }
72778e4ac7eaSMatthew G. Knepley 
72788e4ac7eaSMatthew G. Knepley /*@
72798e4ac7eaSMatthew G. Knepley   DMGetUseNatural - Get the flag for creating a mapping to the natural order on distribution
72808e4ac7eaSMatthew G. Knepley 
72818e4ac7eaSMatthew G. Knepley   Not collective
72828e4ac7eaSMatthew G. Knepley 
72838e4ac7eaSMatthew G. Knepley   Input Parameter:
72848e4ac7eaSMatthew G. Knepley . dm - The DM
72858e4ac7eaSMatthew G. Knepley 
72868e4ac7eaSMatthew G. Knepley   Output Parameter:
72878e4ac7eaSMatthew G. Knepley . useNatural - The flag to build the mapping to a natural order during distribution
72888e4ac7eaSMatthew G. Knepley 
72898e4ac7eaSMatthew G. Knepley   Level: beginner
72908e4ac7eaSMatthew G. Knepley 
72918e4ac7eaSMatthew G. Knepley .seealso: DMSetUseNatural(), DMCreate()
72928e4ac7eaSMatthew G. Knepley @*/
72938e4ac7eaSMatthew G. Knepley PetscErrorCode DMGetUseNatural(DM dm, PetscBool *useNatural)
72948e4ac7eaSMatthew G. Knepley {
72958e4ac7eaSMatthew G. Knepley   PetscFunctionBegin;
72968e4ac7eaSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7297534a8f05SLisandro Dalcin   PetscValidBoolPointer(useNatural, 2);
72988e4ac7eaSMatthew G. Knepley   *useNatural = dm->useNatural;
72998e4ac7eaSMatthew G. Knepley   PetscFunctionReturn(0);
73008e4ac7eaSMatthew G. Knepley }
73018e4ac7eaSMatthew G. Knepley 
73028e4ac7eaSMatthew G. Knepley /*@
73035d3b26e6SMatthew G. Knepley   DMSetUseNatural - Set the flag for creating a mapping to the natural order after distribution
73048e4ac7eaSMatthew G. Knepley 
73058e4ac7eaSMatthew G. Knepley   Collective on dm
73068e4ac7eaSMatthew G. Knepley 
73078e4ac7eaSMatthew G. Knepley   Input Parameters:
73088e4ac7eaSMatthew G. Knepley + dm - The DM
73098e4ac7eaSMatthew G. Knepley - useNatural - The flag to build the mapping to a natural order during distribution
73108e4ac7eaSMatthew G. Knepley 
73115d3b26e6SMatthew G. Knepley   Note: This also causes the map to be build after DMCreateSubDM() and DMCreateSuperDM()
73125d3b26e6SMatthew G. Knepley 
73138e4ac7eaSMatthew G. Knepley   Level: beginner
73148e4ac7eaSMatthew G. Knepley 
73155d3b26e6SMatthew G. Knepley .seealso: DMGetUseNatural(), DMCreate(), DMPlexDistribute(), DMCreateSubDM(), DMCreateSuperDM()
73168e4ac7eaSMatthew G. Knepley @*/
73178e4ac7eaSMatthew G. Knepley PetscErrorCode DMSetUseNatural(DM dm, PetscBool useNatural)
73188e4ac7eaSMatthew G. Knepley {
73198e4ac7eaSMatthew G. Knepley   PetscFunctionBegin;
73208e4ac7eaSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
73218833efb5SBlaise Bourdin   PetscValidLogicalCollectiveBool(dm, useNatural, 2);
73228e4ac7eaSMatthew G. Knepley   dm->useNatural = useNatural;
73238e4ac7eaSMatthew G. Knepley   PetscFunctionReturn(0);
73248e4ac7eaSMatthew G. Knepley }
7325c58f1c22SToby Isaac 
7326c58f1c22SToby Isaac /*@C
7327c58f1c22SToby Isaac   DMCreateLabel - Create a label of the given name if it does not already exist
7328c58f1c22SToby Isaac 
7329c58f1c22SToby Isaac   Not Collective
7330c58f1c22SToby Isaac 
7331c58f1c22SToby Isaac   Input Parameters:
7332c58f1c22SToby Isaac + dm   - The DM object
7333c58f1c22SToby Isaac - name - The label name
7334c58f1c22SToby Isaac 
7335c58f1c22SToby Isaac   Level: intermediate
7336c58f1c22SToby Isaac 
7337c58f1c22SToby Isaac .seealso: DMLabelCreate(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7338c58f1c22SToby Isaac @*/
7339c58f1c22SToby Isaac PetscErrorCode DMCreateLabel(DM dm, const char name[])
7340c58f1c22SToby Isaac {
73415d80c0bfSVaclav Hapla   PetscBool      flg;
73425d80c0bfSVaclav Hapla   DMLabel        label;
7343c58f1c22SToby Isaac   PetscErrorCode ierr;
7344c58f1c22SToby Isaac 
7345c58f1c22SToby Isaac   PetscFunctionBegin;
7346c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7347c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
73485d80c0bfSVaclav Hapla   ierr = DMHasLabel(dm, name, &flg);CHKERRQ(ierr);
7349c58f1c22SToby Isaac   if (!flg) {
73505d80c0bfSVaclav Hapla     ierr = DMLabelCreate(PETSC_COMM_SELF, name, &label);CHKERRQ(ierr);
73515d80c0bfSVaclav Hapla     ierr = DMAddLabel(dm, label);CHKERRQ(ierr);
73525d80c0bfSVaclav Hapla     ierr = DMLabelDestroy(&label);CHKERRQ(ierr);
7353c58f1c22SToby Isaac   }
7354c58f1c22SToby Isaac   PetscFunctionReturn(0);
7355c58f1c22SToby Isaac }
7356c58f1c22SToby Isaac 
7357c58f1c22SToby Isaac /*@C
73580fdc7489SMatthew Knepley   DMCreateLabelAtIndex - Create a label of the given name at the iven index. If it already exists, move it to this index.
73590fdc7489SMatthew Knepley 
73600fdc7489SMatthew Knepley   Not Collective
73610fdc7489SMatthew Knepley 
73620fdc7489SMatthew Knepley   Input Parameters:
73630fdc7489SMatthew Knepley + dm   - The DM object
73640fdc7489SMatthew Knepley . l    - The index for the label
73650fdc7489SMatthew Knepley - name - The label name
73660fdc7489SMatthew Knepley 
73670fdc7489SMatthew Knepley   Level: intermediate
73680fdc7489SMatthew Knepley 
73690fdc7489SMatthew Knepley .seealso: DMCreateLabel(), DMLabelCreate(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
73700fdc7489SMatthew Knepley @*/
73710fdc7489SMatthew Knepley PetscErrorCode DMCreateLabelAtIndex(DM dm, PetscInt l, const char name[])
73720fdc7489SMatthew Knepley {
73730fdc7489SMatthew Knepley   DMLabelLink    orig, prev = NULL;
73740fdc7489SMatthew Knepley   DMLabel        label;
73750fdc7489SMatthew Knepley   PetscInt       Nl, m;
73760fdc7489SMatthew Knepley   PetscBool      flg, match;
73770fdc7489SMatthew Knepley   const char    *lname;
73780fdc7489SMatthew Knepley   PetscErrorCode ierr;
73790fdc7489SMatthew Knepley 
73800fdc7489SMatthew Knepley   PetscFunctionBegin;
73810fdc7489SMatthew Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7382064a246eSJacob Faibussowitsch   PetscValidCharPointer(name, 3);
73830fdc7489SMatthew Knepley   ierr = DMHasLabel(dm, name, &flg);CHKERRQ(ierr);
73840fdc7489SMatthew Knepley   if (!flg) {
73850fdc7489SMatthew Knepley     ierr = DMLabelCreate(PETSC_COMM_SELF, name, &label);CHKERRQ(ierr);
73860fdc7489SMatthew Knepley     ierr = DMAddLabel(dm, label);CHKERRQ(ierr);
73870fdc7489SMatthew Knepley     ierr = DMLabelDestroy(&label);CHKERRQ(ierr);
73880fdc7489SMatthew Knepley   }
73890fdc7489SMatthew Knepley   ierr = DMGetNumLabels(dm, &Nl);CHKERRQ(ierr);
73900fdc7489SMatthew Knepley   if (l >= Nl) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label index %D must be in [0, %D)", l, Nl);
73910fdc7489SMatthew Knepley   for (m = 0, orig = dm->labels; m < Nl; ++m, prev = orig, orig = orig->next) {
73920fdc7489SMatthew Knepley     ierr = PetscObjectGetName((PetscObject) orig->label, &lname);CHKERRQ(ierr);
73930fdc7489SMatthew Knepley     ierr = PetscStrcmp(name, lname, &match);CHKERRQ(ierr);
73940fdc7489SMatthew Knepley     if (match) break;
73950fdc7489SMatthew Knepley   }
73960fdc7489SMatthew Knepley   if (m == l) PetscFunctionReturn(0);
73970fdc7489SMatthew Knepley   if (!m) dm->labels = orig->next;
73980fdc7489SMatthew Knepley   else    prev->next = orig->next;
73990fdc7489SMatthew Knepley   if (!l) {
74000fdc7489SMatthew Knepley     orig->next = dm->labels;
74010fdc7489SMatthew Knepley     dm->labels = orig;
74020fdc7489SMatthew Knepley   } else {
74030fdc7489SMatthew Knepley     for (m = 0, prev = dm->labels; m < l-1; ++m, prev = prev->next);
74040fdc7489SMatthew Knepley     orig->next = prev->next;
74050fdc7489SMatthew Knepley     prev->next = orig;
74060fdc7489SMatthew Knepley   }
74070fdc7489SMatthew Knepley   PetscFunctionReturn(0);
74080fdc7489SMatthew Knepley }
74090fdc7489SMatthew Knepley 
74100fdc7489SMatthew Knepley /*@C
7411c58f1c22SToby Isaac   DMGetLabelValue - Get the value in a Sieve Label for the given point, with 0 as the default
7412c58f1c22SToby Isaac 
7413c58f1c22SToby Isaac   Not Collective
7414c58f1c22SToby Isaac 
7415c58f1c22SToby Isaac   Input Parameters:
7416c58f1c22SToby Isaac + dm   - The DM object
7417c58f1c22SToby Isaac . name - The label name
7418c58f1c22SToby Isaac - point - The mesh point
7419c58f1c22SToby Isaac 
7420c58f1c22SToby Isaac   Output Parameter:
7421c58f1c22SToby Isaac . value - The label value for this point, or -1 if the point is not in the label
7422c58f1c22SToby Isaac 
7423c58f1c22SToby Isaac   Level: beginner
7424c58f1c22SToby Isaac 
7425c58f1c22SToby Isaac .seealso: DMLabelGetValue(), DMSetLabelValue(), DMGetStratumIS()
7426c58f1c22SToby Isaac @*/
7427c58f1c22SToby Isaac PetscErrorCode DMGetLabelValue(DM dm, const char name[], PetscInt point, PetscInt *value)
7428c58f1c22SToby Isaac {
7429c58f1c22SToby Isaac   DMLabel        label;
7430c58f1c22SToby Isaac   PetscErrorCode ierr;
7431c58f1c22SToby Isaac 
7432c58f1c22SToby Isaac   PetscFunctionBegin;
7433c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7434c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7435c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
743613903a91SSatish Balay   if (!label) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "No label named %s was found", name);
7437c58f1c22SToby Isaac   ierr = DMLabelGetValue(label, point, value);CHKERRQ(ierr);
7438c58f1c22SToby Isaac   PetscFunctionReturn(0);
7439c58f1c22SToby Isaac }
7440c58f1c22SToby Isaac 
7441c58f1c22SToby Isaac /*@C
7442c58f1c22SToby Isaac   DMSetLabelValue - Add a point to a Sieve Label with given value
7443c58f1c22SToby Isaac 
7444c58f1c22SToby Isaac   Not Collective
7445c58f1c22SToby Isaac 
7446c58f1c22SToby Isaac   Input Parameters:
7447c58f1c22SToby Isaac + dm   - The DM object
7448c58f1c22SToby Isaac . name - The label name
7449c58f1c22SToby Isaac . point - The mesh point
7450c58f1c22SToby Isaac - value - The label value for this point
7451c58f1c22SToby Isaac 
7452c58f1c22SToby Isaac   Output Parameter:
7453c58f1c22SToby Isaac 
7454c58f1c22SToby Isaac   Level: beginner
7455c58f1c22SToby Isaac 
7456c58f1c22SToby Isaac .seealso: DMLabelSetValue(), DMGetStratumIS(), DMClearLabelValue()
7457c58f1c22SToby Isaac @*/
7458c58f1c22SToby Isaac PetscErrorCode DMSetLabelValue(DM dm, const char name[], PetscInt point, PetscInt value)
7459c58f1c22SToby Isaac {
7460c58f1c22SToby Isaac   DMLabel        label;
7461c58f1c22SToby Isaac   PetscErrorCode ierr;
7462c58f1c22SToby Isaac 
7463c58f1c22SToby Isaac   PetscFunctionBegin;
7464c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7465c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7466c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7467c58f1c22SToby Isaac   if (!label) {
7468c58f1c22SToby Isaac     ierr = DMCreateLabel(dm, name);CHKERRQ(ierr);
7469c58f1c22SToby Isaac     ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7470c58f1c22SToby Isaac   }
7471c58f1c22SToby Isaac   ierr = DMLabelSetValue(label, point, value);CHKERRQ(ierr);
7472c58f1c22SToby Isaac   PetscFunctionReturn(0);
7473c58f1c22SToby Isaac }
7474c58f1c22SToby Isaac 
7475c58f1c22SToby Isaac /*@C
7476c58f1c22SToby Isaac   DMClearLabelValue - Remove a point from a Sieve Label with given value
7477c58f1c22SToby Isaac 
7478c58f1c22SToby Isaac   Not Collective
7479c58f1c22SToby Isaac 
7480c58f1c22SToby Isaac   Input Parameters:
7481c58f1c22SToby Isaac + dm   - The DM object
7482c58f1c22SToby Isaac . name - The label name
7483c58f1c22SToby Isaac . point - The mesh point
7484c58f1c22SToby Isaac - value - The label value for this point
7485c58f1c22SToby Isaac 
7486c58f1c22SToby Isaac   Output Parameter:
7487c58f1c22SToby Isaac 
7488c58f1c22SToby Isaac   Level: beginner
7489c58f1c22SToby Isaac 
7490c58f1c22SToby Isaac .seealso: DMLabelClearValue(), DMSetLabelValue(), DMGetStratumIS()
7491c58f1c22SToby Isaac @*/
7492c58f1c22SToby Isaac PetscErrorCode DMClearLabelValue(DM dm, const char name[], PetscInt point, PetscInt value)
7493c58f1c22SToby Isaac {
7494c58f1c22SToby Isaac   DMLabel        label;
7495c58f1c22SToby Isaac   PetscErrorCode ierr;
7496c58f1c22SToby Isaac 
7497c58f1c22SToby Isaac   PetscFunctionBegin;
7498c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7499c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7500c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7501c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
7502c58f1c22SToby Isaac   ierr = DMLabelClearValue(label, point, value);CHKERRQ(ierr);
7503c58f1c22SToby Isaac   PetscFunctionReturn(0);
7504c58f1c22SToby Isaac }
7505c58f1c22SToby Isaac 
7506c58f1c22SToby Isaac /*@C
7507c58f1c22SToby Isaac   DMGetLabelSize - Get the number of different integer ids in a Label
7508c58f1c22SToby Isaac 
7509c58f1c22SToby Isaac   Not Collective
7510c58f1c22SToby Isaac 
7511c58f1c22SToby Isaac   Input Parameters:
7512c58f1c22SToby Isaac + dm   - The DM object
7513c58f1c22SToby Isaac - name - The label name
7514c58f1c22SToby Isaac 
7515c58f1c22SToby Isaac   Output Parameter:
7516c58f1c22SToby Isaac . size - The number of different integer ids, or 0 if the label does not exist
7517c58f1c22SToby Isaac 
7518c58f1c22SToby Isaac   Level: beginner
7519c58f1c22SToby Isaac 
7520df813f42SMatthew G. Knepley .seealso: DMLabelGetNumValues(), DMSetLabelValue()
7521c58f1c22SToby Isaac @*/
7522c58f1c22SToby Isaac PetscErrorCode DMGetLabelSize(DM dm, const char name[], PetscInt *size)
7523c58f1c22SToby Isaac {
7524c58f1c22SToby Isaac   DMLabel        label;
7525c58f1c22SToby Isaac   PetscErrorCode ierr;
7526c58f1c22SToby Isaac 
7527c58f1c22SToby Isaac   PetscFunctionBegin;
7528c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7529c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7530534a8f05SLisandro Dalcin   PetscValidIntPointer(size, 3);
7531c58f1c22SToby Isaac   ierr  = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7532c58f1c22SToby Isaac   *size = 0;
7533c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
7534c58f1c22SToby Isaac   ierr = DMLabelGetNumValues(label, size);CHKERRQ(ierr);
7535c58f1c22SToby Isaac   PetscFunctionReturn(0);
7536c58f1c22SToby Isaac }
7537c58f1c22SToby Isaac 
7538c58f1c22SToby Isaac /*@C
7539c58f1c22SToby Isaac   DMGetLabelIdIS - Get the integer ids in a label
7540c58f1c22SToby Isaac 
7541c58f1c22SToby Isaac   Not Collective
7542c58f1c22SToby Isaac 
7543c58f1c22SToby Isaac   Input Parameters:
7544c58f1c22SToby Isaac + mesh - The DM object
7545c58f1c22SToby Isaac - name - The label name
7546c58f1c22SToby Isaac 
7547c58f1c22SToby Isaac   Output Parameter:
7548c58f1c22SToby Isaac . ids - The integer ids, or NULL if the label does not exist
7549c58f1c22SToby Isaac 
7550c58f1c22SToby Isaac   Level: beginner
7551c58f1c22SToby Isaac 
7552c58f1c22SToby Isaac .seealso: DMLabelGetValueIS(), DMGetLabelSize()
7553c58f1c22SToby Isaac @*/
7554c58f1c22SToby Isaac PetscErrorCode DMGetLabelIdIS(DM dm, const char name[], IS *ids)
7555c58f1c22SToby Isaac {
7556c58f1c22SToby Isaac   DMLabel        label;
7557c58f1c22SToby Isaac   PetscErrorCode ierr;
7558c58f1c22SToby Isaac 
7559c58f1c22SToby Isaac   PetscFunctionBegin;
7560c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7561c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7562c58f1c22SToby Isaac   PetscValidPointer(ids, 3);
7563c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7564c58f1c22SToby Isaac   *ids = NULL;
7565dab2e251SBlaise Bourdin  if (label) {
7566c58f1c22SToby Isaac     ierr = DMLabelGetValueIS(label, ids);CHKERRQ(ierr);
7567dab2e251SBlaise Bourdin   } else {
7568dab2e251SBlaise Bourdin     /* returning an empty IS */
7569dab2e251SBlaise Bourdin     ierr = ISCreateGeneral(PETSC_COMM_SELF,0,NULL,PETSC_USE_POINTER,ids);CHKERRQ(ierr);
7570dab2e251SBlaise Bourdin   }
7571c58f1c22SToby Isaac   PetscFunctionReturn(0);
7572c58f1c22SToby Isaac }
7573c58f1c22SToby Isaac 
7574c58f1c22SToby Isaac /*@C
7575c58f1c22SToby Isaac   DMGetStratumSize - Get the number of points in a label stratum
7576c58f1c22SToby Isaac 
7577c58f1c22SToby Isaac   Not Collective
7578c58f1c22SToby Isaac 
7579c58f1c22SToby Isaac   Input Parameters:
7580c58f1c22SToby Isaac + dm - The DM object
7581c58f1c22SToby Isaac . name - The label name
7582c58f1c22SToby Isaac - value - The stratum value
7583c58f1c22SToby Isaac 
7584c58f1c22SToby Isaac   Output Parameter:
7585c58f1c22SToby Isaac . size - The stratum size
7586c58f1c22SToby Isaac 
7587c58f1c22SToby Isaac   Level: beginner
7588c58f1c22SToby Isaac 
7589c58f1c22SToby Isaac .seealso: DMLabelGetStratumSize(), DMGetLabelSize(), DMGetLabelIds()
7590c58f1c22SToby Isaac @*/
7591c58f1c22SToby Isaac PetscErrorCode DMGetStratumSize(DM dm, const char name[], PetscInt value, PetscInt *size)
7592c58f1c22SToby Isaac {
7593c58f1c22SToby Isaac   DMLabel        label;
7594c58f1c22SToby Isaac   PetscErrorCode ierr;
7595c58f1c22SToby Isaac 
7596c58f1c22SToby Isaac   PetscFunctionBegin;
7597c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7598c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7599534a8f05SLisandro Dalcin   PetscValidIntPointer(size, 4);
7600c58f1c22SToby Isaac   ierr  = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7601c58f1c22SToby Isaac   *size = 0;
7602c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
7603c58f1c22SToby Isaac   ierr = DMLabelGetStratumSize(label, value, size);CHKERRQ(ierr);
7604c58f1c22SToby Isaac   PetscFunctionReturn(0);
7605c58f1c22SToby Isaac }
7606c58f1c22SToby Isaac 
7607c58f1c22SToby Isaac /*@C
7608c58f1c22SToby Isaac   DMGetStratumIS - Get the points in a label stratum
7609c58f1c22SToby Isaac 
7610c58f1c22SToby Isaac   Not Collective
7611c58f1c22SToby Isaac 
7612c58f1c22SToby Isaac   Input Parameters:
7613c58f1c22SToby Isaac + dm - The DM object
7614c58f1c22SToby Isaac . name - The label name
7615c58f1c22SToby Isaac - value - The stratum value
7616c58f1c22SToby Isaac 
7617c58f1c22SToby Isaac   Output Parameter:
7618c58f1c22SToby Isaac . points - The stratum points, or NULL if the label does not exist or does not have that value
7619c58f1c22SToby Isaac 
7620c58f1c22SToby Isaac   Level: beginner
7621c58f1c22SToby Isaac 
7622c58f1c22SToby Isaac .seealso: DMLabelGetStratumIS(), DMGetStratumSize()
7623c58f1c22SToby Isaac @*/
7624c58f1c22SToby Isaac PetscErrorCode DMGetStratumIS(DM dm, const char name[], PetscInt value, IS *points)
7625c58f1c22SToby Isaac {
7626c58f1c22SToby Isaac   DMLabel        label;
7627c58f1c22SToby Isaac   PetscErrorCode ierr;
7628c58f1c22SToby Isaac 
7629c58f1c22SToby Isaac   PetscFunctionBegin;
7630c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7631c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7632c58f1c22SToby Isaac   PetscValidPointer(points, 4);
7633c58f1c22SToby Isaac   ierr    = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7634c58f1c22SToby Isaac   *points = NULL;
7635c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
7636c58f1c22SToby Isaac   ierr = DMLabelGetStratumIS(label, value, points);CHKERRQ(ierr);
7637c58f1c22SToby Isaac   PetscFunctionReturn(0);
7638c58f1c22SToby Isaac }
7639c58f1c22SToby Isaac 
76404de306b1SToby Isaac /*@C
76419044fa66SMatthew G. Knepley   DMSetStratumIS - Set the points in a label stratum
76424de306b1SToby Isaac 
76434de306b1SToby Isaac   Not Collective
76444de306b1SToby Isaac 
76454de306b1SToby Isaac   Input Parameters:
76464de306b1SToby Isaac + dm - The DM object
76474de306b1SToby Isaac . name - The label name
76484de306b1SToby Isaac . value - The stratum value
76494de306b1SToby Isaac - points - The stratum points
76504de306b1SToby Isaac 
76514de306b1SToby Isaac   Level: beginner
76524de306b1SToby Isaac 
76534de306b1SToby Isaac .seealso: DMLabelSetStratumIS(), DMGetStratumSize()
76544de306b1SToby Isaac @*/
76554de306b1SToby Isaac PetscErrorCode DMSetStratumIS(DM dm, const char name[], PetscInt value, IS points)
76564de306b1SToby Isaac {
76574de306b1SToby Isaac   DMLabel        label;
76584de306b1SToby Isaac   PetscErrorCode ierr;
76594de306b1SToby Isaac 
76604de306b1SToby Isaac   PetscFunctionBegin;
76614de306b1SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
76624de306b1SToby Isaac   PetscValidCharPointer(name, 2);
76634de306b1SToby Isaac   PetscValidPointer(points, 4);
76644de306b1SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
76654de306b1SToby Isaac   if (!label) PetscFunctionReturn(0);
76664de306b1SToby Isaac   ierr = DMLabelSetStratumIS(label, value, points);CHKERRQ(ierr);
76674de306b1SToby Isaac   PetscFunctionReturn(0);
76684de306b1SToby Isaac }
76694de306b1SToby Isaac 
7670c58f1c22SToby Isaac /*@C
7671c58f1c22SToby Isaac   DMClearLabelStratum - Remove all points from a stratum from a Sieve Label
7672c58f1c22SToby Isaac 
7673c58f1c22SToby Isaac   Not Collective
7674c58f1c22SToby Isaac 
7675c58f1c22SToby Isaac   Input Parameters:
7676c58f1c22SToby Isaac + dm   - The DM object
7677c58f1c22SToby Isaac . name - The label name
7678c58f1c22SToby Isaac - value - The label value for this point
7679c58f1c22SToby Isaac 
7680c58f1c22SToby Isaac   Output Parameter:
7681c58f1c22SToby Isaac 
7682c58f1c22SToby Isaac   Level: beginner
7683c58f1c22SToby Isaac 
7684c58f1c22SToby Isaac .seealso: DMLabelClearStratum(), DMSetLabelValue(), DMGetStratumIS(), DMClearLabelValue()
7685c58f1c22SToby Isaac @*/
7686c58f1c22SToby Isaac PetscErrorCode DMClearLabelStratum(DM dm, const char name[], PetscInt value)
7687c58f1c22SToby Isaac {
7688c58f1c22SToby Isaac   DMLabel        label;
7689c58f1c22SToby Isaac   PetscErrorCode ierr;
7690c58f1c22SToby Isaac 
7691c58f1c22SToby Isaac   PetscFunctionBegin;
7692c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7693c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7694c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7695c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
7696c58f1c22SToby Isaac   ierr = DMLabelClearStratum(label, value);CHKERRQ(ierr);
7697c58f1c22SToby Isaac   PetscFunctionReturn(0);
7698c58f1c22SToby Isaac }
7699c58f1c22SToby Isaac 
7700c58f1c22SToby Isaac /*@
7701c58f1c22SToby Isaac   DMGetNumLabels - Return the number of labels defined by the mesh
7702c58f1c22SToby Isaac 
7703c58f1c22SToby Isaac   Not Collective
7704c58f1c22SToby Isaac 
7705c58f1c22SToby Isaac   Input Parameter:
7706c58f1c22SToby Isaac . dm   - The DM object
7707c58f1c22SToby Isaac 
7708c58f1c22SToby Isaac   Output Parameter:
7709c58f1c22SToby Isaac . numLabels - the number of Labels
7710c58f1c22SToby Isaac 
7711c58f1c22SToby Isaac   Level: intermediate
7712c58f1c22SToby Isaac 
7713c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7714c58f1c22SToby Isaac @*/
7715c58f1c22SToby Isaac PetscErrorCode DMGetNumLabels(DM dm, PetscInt *numLabels)
7716c58f1c22SToby Isaac {
77175d80c0bfSVaclav Hapla   DMLabelLink next = dm->labels;
7718c58f1c22SToby Isaac   PetscInt  n    = 0;
7719c58f1c22SToby Isaac 
7720c58f1c22SToby Isaac   PetscFunctionBegin;
7721c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7722534a8f05SLisandro Dalcin   PetscValidIntPointer(numLabels, 2);
7723c58f1c22SToby Isaac   while (next) {++n; next = next->next;}
7724c58f1c22SToby Isaac   *numLabels = n;
7725c58f1c22SToby Isaac   PetscFunctionReturn(0);
7726c58f1c22SToby Isaac }
7727c58f1c22SToby Isaac 
7728c58f1c22SToby Isaac /*@C
7729c58f1c22SToby Isaac   DMGetLabelName - Return the name of nth label
7730c58f1c22SToby Isaac 
7731c58f1c22SToby Isaac   Not Collective
7732c58f1c22SToby Isaac 
7733c58f1c22SToby Isaac   Input Parameters:
7734c58f1c22SToby Isaac + dm - The DM object
7735c58f1c22SToby Isaac - n  - the label number
7736c58f1c22SToby Isaac 
7737c58f1c22SToby Isaac   Output Parameter:
7738c58f1c22SToby Isaac . name - the label name
7739c58f1c22SToby Isaac 
7740c58f1c22SToby Isaac   Level: intermediate
7741c58f1c22SToby Isaac 
7742c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7743c58f1c22SToby Isaac @*/
7744c58f1c22SToby Isaac PetscErrorCode DMGetLabelName(DM dm, PetscInt n, const char **name)
7745c58f1c22SToby Isaac {
77465d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
7747c58f1c22SToby Isaac   PetscInt       l    = 0;
7748d67d17b1SMatthew G. Knepley   PetscErrorCode ierr;
7749c58f1c22SToby Isaac 
7750c58f1c22SToby Isaac   PetscFunctionBegin;
7751c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7752c58f1c22SToby Isaac   PetscValidPointer(name, 3);
7753c58f1c22SToby Isaac   while (next) {
7754c58f1c22SToby Isaac     if (l == n) {
7755d67d17b1SMatthew G. Knepley       ierr = PetscObjectGetName((PetscObject) next->label, name);CHKERRQ(ierr);
7756c58f1c22SToby Isaac       PetscFunctionReturn(0);
7757c58f1c22SToby Isaac     }
7758c58f1c22SToby Isaac     ++l;
7759c58f1c22SToby Isaac     next = next->next;
7760c58f1c22SToby Isaac   }
7761c58f1c22SToby Isaac   SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %D does not exist in this DM", n);
7762c58f1c22SToby Isaac }
7763c58f1c22SToby Isaac 
7764c58f1c22SToby Isaac /*@C
7765c58f1c22SToby Isaac   DMHasLabel - Determine whether the mesh has a label of a given name
7766c58f1c22SToby Isaac 
7767c58f1c22SToby Isaac   Not Collective
7768c58f1c22SToby Isaac 
7769c58f1c22SToby Isaac   Input Parameters:
7770c58f1c22SToby Isaac + dm   - The DM object
7771c58f1c22SToby Isaac - name - The label name
7772c58f1c22SToby Isaac 
7773c58f1c22SToby Isaac   Output Parameter:
7774c58f1c22SToby Isaac . hasLabel - PETSC_TRUE if the label is present
7775c58f1c22SToby Isaac 
7776c58f1c22SToby Isaac   Level: intermediate
7777c58f1c22SToby Isaac 
7778c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7779c58f1c22SToby Isaac @*/
7780c58f1c22SToby Isaac PetscErrorCode DMHasLabel(DM dm, const char name[], PetscBool *hasLabel)
7781c58f1c22SToby Isaac {
77825d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
7783d67d17b1SMatthew G. Knepley   const char    *lname;
7784c58f1c22SToby Isaac   PetscErrorCode ierr;
7785c58f1c22SToby Isaac 
7786c58f1c22SToby Isaac   PetscFunctionBegin;
7787c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7788c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7789534a8f05SLisandro Dalcin   PetscValidBoolPointer(hasLabel, 3);
7790c58f1c22SToby Isaac   *hasLabel = PETSC_FALSE;
7791c58f1c22SToby Isaac   while (next) {
7792d67d17b1SMatthew G. Knepley     ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr);
7793d67d17b1SMatthew G. Knepley     ierr = PetscStrcmp(name, lname, hasLabel);CHKERRQ(ierr);
7794c58f1c22SToby Isaac     if (*hasLabel) break;
7795c58f1c22SToby Isaac     next = next->next;
7796c58f1c22SToby Isaac   }
7797c58f1c22SToby Isaac   PetscFunctionReturn(0);
7798c58f1c22SToby Isaac }
7799c58f1c22SToby Isaac 
7800c58f1c22SToby Isaac /*@C
7801c58f1c22SToby Isaac   DMGetLabel - Return the label of a given name, or NULL
7802c58f1c22SToby Isaac 
7803c58f1c22SToby Isaac   Not Collective
7804c58f1c22SToby Isaac 
7805c58f1c22SToby Isaac   Input Parameters:
7806c58f1c22SToby Isaac + dm   - The DM object
7807c58f1c22SToby Isaac - name - The label name
7808c58f1c22SToby Isaac 
7809c58f1c22SToby Isaac   Output Parameter:
7810c58f1c22SToby Isaac . label - The DMLabel, or NULL if the label is absent
7811c58f1c22SToby Isaac 
78126d7c9049SMatthew G. Knepley   Note: Some of the default labels in a DMPlex will be
78136d7c9049SMatthew G. Knepley $ "depth"       - Holds the depth (co-dimension) of each mesh point
78146d7c9049SMatthew G. Knepley $ "celltype"    - Holds the topological type of each cell
78156d7c9049SMatthew G. Knepley $ "ghost"       - If the DM is distributed with overlap, this marks the cells and faces in the overlap
78166d7c9049SMatthew G. Knepley $ "Cell Sets"   - Mirrors the cell sets defined by GMsh and ExodusII
78176d7c9049SMatthew G. Knepley $ "Face Sets"   - Mirrors the face sets defined by GMsh and ExodusII
78186d7c9049SMatthew G. Knepley $ "Vertex Sets" - Mirrors the vertex sets defined by GMsh
78196d7c9049SMatthew G. Knepley 
7820c58f1c22SToby Isaac   Level: intermediate
7821c58f1c22SToby Isaac 
78226d7c9049SMatthew G. Knepley .seealso: DMCreateLabel(), DMHasLabel(), DMPlexGetDepthLabel(), DMPlexGetCellType()
7823c58f1c22SToby Isaac @*/
7824c58f1c22SToby Isaac PetscErrorCode DMGetLabel(DM dm, const char name[], DMLabel *label)
7825c58f1c22SToby Isaac {
78265d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
7827c58f1c22SToby Isaac   PetscBool      hasLabel;
7828d67d17b1SMatthew G. Knepley   const char    *lname;
7829c58f1c22SToby Isaac   PetscErrorCode ierr;
7830c58f1c22SToby Isaac 
7831c58f1c22SToby Isaac   PetscFunctionBegin;
7832c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7833c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7834c58f1c22SToby Isaac   PetscValidPointer(label, 3);
7835c58f1c22SToby Isaac   *label = NULL;
7836c58f1c22SToby Isaac   while (next) {
7837d67d17b1SMatthew G. Knepley     ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr);
7838d67d17b1SMatthew G. Knepley     ierr = PetscStrcmp(name, lname, &hasLabel);CHKERRQ(ierr);
7839c58f1c22SToby Isaac     if (hasLabel) {
7840c58f1c22SToby Isaac       *label = next->label;
7841c58f1c22SToby Isaac       break;
7842c58f1c22SToby Isaac     }
7843c58f1c22SToby Isaac     next = next->next;
7844c58f1c22SToby Isaac   }
7845c58f1c22SToby Isaac   PetscFunctionReturn(0);
7846c58f1c22SToby Isaac }
7847c58f1c22SToby Isaac 
7848c58f1c22SToby Isaac /*@C
7849c58f1c22SToby Isaac   DMGetLabelByNum - Return the nth label
7850c58f1c22SToby Isaac 
7851c58f1c22SToby Isaac   Not Collective
7852c58f1c22SToby Isaac 
7853c58f1c22SToby Isaac   Input Parameters:
7854c58f1c22SToby Isaac + dm - The DM object
7855c58f1c22SToby Isaac - n  - the label number
7856c58f1c22SToby Isaac 
7857c58f1c22SToby Isaac   Output Parameter:
7858c58f1c22SToby Isaac . label - the label
7859c58f1c22SToby Isaac 
7860c58f1c22SToby Isaac   Level: intermediate
7861c58f1c22SToby Isaac 
7862c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7863c58f1c22SToby Isaac @*/
7864c58f1c22SToby Isaac PetscErrorCode DMGetLabelByNum(DM dm, PetscInt n, DMLabel *label)
7865c58f1c22SToby Isaac {
78665d80c0bfSVaclav Hapla   DMLabelLink next = dm->labels;
7867c58f1c22SToby Isaac   PetscInt    l    = 0;
7868c58f1c22SToby Isaac 
7869c58f1c22SToby Isaac   PetscFunctionBegin;
7870c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7871c58f1c22SToby Isaac   PetscValidPointer(label, 3);
7872c58f1c22SToby Isaac   while (next) {
7873c58f1c22SToby Isaac     if (l == n) {
7874c58f1c22SToby Isaac       *label = next->label;
7875c58f1c22SToby Isaac       PetscFunctionReturn(0);
7876c58f1c22SToby Isaac     }
7877c58f1c22SToby Isaac     ++l;
7878c58f1c22SToby Isaac     next = next->next;
7879c58f1c22SToby Isaac   }
7880c58f1c22SToby Isaac   SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %D does not exist in this DM", n);
7881c58f1c22SToby Isaac }
7882c58f1c22SToby Isaac 
7883c58f1c22SToby Isaac /*@C
7884c58f1c22SToby Isaac   DMAddLabel - Add the label to this mesh
7885c58f1c22SToby Isaac 
7886c58f1c22SToby Isaac   Not Collective
7887c58f1c22SToby Isaac 
7888c58f1c22SToby Isaac   Input Parameters:
7889c58f1c22SToby Isaac + dm   - The DM object
7890c58f1c22SToby Isaac - label - The DMLabel
7891c58f1c22SToby Isaac 
7892c58f1c22SToby Isaac   Level: developer
7893c58f1c22SToby Isaac 
7894c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7895c58f1c22SToby Isaac @*/
7896c58f1c22SToby Isaac PetscErrorCode DMAddLabel(DM dm, DMLabel label)
7897c58f1c22SToby Isaac {
78985d80c0bfSVaclav Hapla   DMLabelLink    l, *p, tmpLabel;
7899c58f1c22SToby Isaac   PetscBool      hasLabel;
7900d67d17b1SMatthew G. Knepley   const char    *lname;
79015d80c0bfSVaclav Hapla   PetscBool      flg;
7902c58f1c22SToby Isaac   PetscErrorCode ierr;
7903c58f1c22SToby Isaac 
7904c58f1c22SToby Isaac   PetscFunctionBegin;
7905c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7906d67d17b1SMatthew G. Knepley   ierr = PetscObjectGetName((PetscObject) label, &lname);CHKERRQ(ierr);
7907d67d17b1SMatthew G. Knepley   ierr = DMHasLabel(dm, lname, &hasLabel);CHKERRQ(ierr);
7908d67d17b1SMatthew G. Knepley   if (hasLabel) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %s already exists in this DM", lname);
7909c58f1c22SToby Isaac   ierr = PetscCalloc1(1, &tmpLabel);CHKERRQ(ierr);
7910c58f1c22SToby Isaac   tmpLabel->label  = label;
7911c58f1c22SToby Isaac   tmpLabel->output = PETSC_TRUE;
79125d80c0bfSVaclav Hapla   for (p=&dm->labels; (l=*p); p=&l->next) {}
79135d80c0bfSVaclav Hapla   *p = tmpLabel;
791408f633c4SVaclav Hapla   ierr = PetscObjectReference((PetscObject)label);CHKERRQ(ierr);
79155d80c0bfSVaclav Hapla   ierr = PetscStrcmp(lname, "depth", &flg);CHKERRQ(ierr);
79165d80c0bfSVaclav Hapla   if (flg) dm->depthLabel = label;
7917ba2698f1SMatthew G. Knepley   ierr = PetscStrcmp(lname, "celltype", &flg);CHKERRQ(ierr);
7918ba2698f1SMatthew G. Knepley   if (flg) dm->celltypeLabel = label;
7919c58f1c22SToby Isaac   PetscFunctionReturn(0);
7920c58f1c22SToby Isaac }
7921c58f1c22SToby Isaac 
7922c58f1c22SToby Isaac /*@C
79234a7ee7d0SMatthew G. Knepley   DMSetLabel - Replaces the label of a given name, or ignores it if the name is not present
79244a7ee7d0SMatthew G. Knepley 
79254a7ee7d0SMatthew G. Knepley   Not Collective
79264a7ee7d0SMatthew G. Knepley 
79274a7ee7d0SMatthew G. Knepley   Input Parameters:
79284a7ee7d0SMatthew G. Knepley + dm    - The DM object
79294a7ee7d0SMatthew G. Knepley - label - The DMLabel, having the same name, to substitute
79304a7ee7d0SMatthew G. Knepley 
79314a7ee7d0SMatthew G. Knepley   Note: Some of the default labels in a DMPlex will be
79324a7ee7d0SMatthew G. Knepley $ "depth"       - Holds the depth (co-dimension) of each mesh point
79334a7ee7d0SMatthew G. Knepley $ "celltype"    - Holds the topological type of each cell
79344a7ee7d0SMatthew G. Knepley $ "ghost"       - If the DM is distributed with overlap, this marks the cells and faces in the overlap
79354a7ee7d0SMatthew G. Knepley $ "Cell Sets"   - Mirrors the cell sets defined by GMsh and ExodusII
79364a7ee7d0SMatthew G. Knepley $ "Face Sets"   - Mirrors the face sets defined by GMsh and ExodusII
79374a7ee7d0SMatthew G. Knepley $ "Vertex Sets" - Mirrors the vertex sets defined by GMsh
79384a7ee7d0SMatthew G. Knepley 
79394a7ee7d0SMatthew G. Knepley   Level: intermediate
79404a7ee7d0SMatthew G. Knepley 
79414a7ee7d0SMatthew G. Knepley .seealso: DMCreateLabel(), DMHasLabel(), DMPlexGetDepthLabel(), DMPlexGetCellType()
79424a7ee7d0SMatthew G. Knepley @*/
79434a7ee7d0SMatthew G. Knepley PetscErrorCode DMSetLabel(DM dm, DMLabel label)
79444a7ee7d0SMatthew G. Knepley {
79454a7ee7d0SMatthew G. Knepley   DMLabelLink    next = dm->labels;
79464a7ee7d0SMatthew G. Knepley   PetscBool      hasLabel, flg;
79474a7ee7d0SMatthew G. Knepley   const char    *name, *lname;
79484a7ee7d0SMatthew G. Knepley   PetscErrorCode ierr;
79494a7ee7d0SMatthew G. Knepley 
79504a7ee7d0SMatthew G. Knepley   PetscFunctionBegin;
79514a7ee7d0SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
79524a7ee7d0SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
79534a7ee7d0SMatthew G. Knepley   ierr = PetscObjectGetName((PetscObject) label, &name);CHKERRQ(ierr);
79544a7ee7d0SMatthew G. Knepley   while (next) {
79554a7ee7d0SMatthew G. Knepley     ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr);
79564a7ee7d0SMatthew G. Knepley     ierr = PetscStrcmp(name, lname, &hasLabel);CHKERRQ(ierr);
79574a7ee7d0SMatthew G. Knepley     if (hasLabel) {
79584a7ee7d0SMatthew G. Knepley       ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr);
79594a7ee7d0SMatthew G. Knepley       ierr = PetscStrcmp(lname, "depth", &flg);CHKERRQ(ierr);
79604a7ee7d0SMatthew G. Knepley       if (flg) dm->depthLabel = label;
79614a7ee7d0SMatthew G. Knepley       ierr = PetscStrcmp(lname, "celltype", &flg);CHKERRQ(ierr);
79624a7ee7d0SMatthew G. Knepley       if (flg) dm->celltypeLabel = label;
79634a7ee7d0SMatthew G. Knepley       ierr = DMLabelDestroy(&next->label);CHKERRQ(ierr);
79644a7ee7d0SMatthew G. Knepley       next->label = label;
79654a7ee7d0SMatthew G. Knepley       break;
79664a7ee7d0SMatthew G. Knepley     }
79674a7ee7d0SMatthew G. Knepley     next = next->next;
79684a7ee7d0SMatthew G. Knepley   }
79694a7ee7d0SMatthew G. Knepley   PetscFunctionReturn(0);
79704a7ee7d0SMatthew G. Knepley }
79714a7ee7d0SMatthew G. Knepley 
79724a7ee7d0SMatthew G. Knepley /*@C
7973e5472504SVaclav Hapla   DMRemoveLabel - Remove the label given by name from this mesh
7974c58f1c22SToby Isaac 
7975c58f1c22SToby Isaac   Not Collective
7976c58f1c22SToby Isaac 
7977c58f1c22SToby Isaac   Input Parameters:
7978c58f1c22SToby Isaac + dm   - The DM object
7979c58f1c22SToby Isaac - name - The label name
7980c58f1c22SToby Isaac 
7981c58f1c22SToby Isaac   Output Parameter:
7982c58f1c22SToby Isaac . label - The DMLabel, or NULL if the label is absent
7983c58f1c22SToby Isaac 
7984c58f1c22SToby Isaac   Level: developer
7985c58f1c22SToby Isaac 
7986e5472504SVaclav Hapla   Notes:
7987e5472504SVaclav Hapla   DMRemoveLabel(dm,name,NULL) removes the label from dm and calls
7988e5472504SVaclav Hapla   DMLabelDestroy() on the label.
7989e5472504SVaclav Hapla 
7990e5472504SVaclav Hapla   DMRemoveLabel(dm,name,&label) removes the label from dm, but it DOES NOT
7991e5472504SVaclav Hapla   call DMLabelDestroy(). Instead, the label is returned and the user is
7992e5472504SVaclav Hapla   responsible of calling DMLabelDestroy() at some point.
7993e5472504SVaclav Hapla 
7994e5472504SVaclav Hapla .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabel(), DMGetLabelValue(), DMSetLabelValue(), DMLabelDestroy(), DMRemoveLabelBySelf()
7995c58f1c22SToby Isaac @*/
7996c58f1c22SToby Isaac PetscErrorCode DMRemoveLabel(DM dm, const char name[], DMLabel *label)
7997c58f1c22SToby Isaac {
799895d578d6SVaclav Hapla   DMLabelLink    link, *pnext;
7999c58f1c22SToby Isaac   PetscBool      hasLabel;
8000d67d17b1SMatthew G. Knepley   const char    *lname;
8001c58f1c22SToby Isaac   PetscErrorCode ierr;
8002c58f1c22SToby Isaac 
8003c58f1c22SToby Isaac   PetscFunctionBegin;
8004c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8005e5472504SVaclav Hapla   PetscValidCharPointer(name, 2);
8006e5472504SVaclav Hapla   if (label) {
8007e5472504SVaclav Hapla     PetscValidPointer(label, 3);
8008c58f1c22SToby Isaac     *label = NULL;
8009e5472504SVaclav Hapla   }
80105d80c0bfSVaclav Hapla   for (pnext=&dm->labels; (link=*pnext); pnext=&link->next) {
801195d578d6SVaclav Hapla     ierr = PetscObjectGetName((PetscObject) link->label, &lname);CHKERRQ(ierr);
8012d67d17b1SMatthew G. Knepley     ierr = PetscStrcmp(name, lname, &hasLabel);CHKERRQ(ierr);
8013c58f1c22SToby Isaac     if (hasLabel) {
801495d578d6SVaclav Hapla       *pnext = link->next; /* Remove from list */
8015c58f1c22SToby Isaac       ierr = PetscStrcmp(name, "depth", &hasLabel);CHKERRQ(ierr);
801695d578d6SVaclav Hapla       if (hasLabel) dm->depthLabel = NULL;
8017ba2698f1SMatthew G. Knepley       ierr = PetscStrcmp(name, "celltype", &hasLabel);CHKERRQ(ierr);
8018ba2698f1SMatthew G. Knepley       if (hasLabel) dm->celltypeLabel = NULL;
801995d578d6SVaclav Hapla       if (label) *label = link->label;
802095d578d6SVaclav Hapla       else       {ierr = DMLabelDestroy(&link->label);CHKERRQ(ierr);}
802195d578d6SVaclav Hapla       ierr = PetscFree(link);CHKERRQ(ierr);
8022c58f1c22SToby Isaac       break;
8023c58f1c22SToby Isaac     }
8024c58f1c22SToby Isaac   }
8025c58f1c22SToby Isaac   PetscFunctionReturn(0);
8026c58f1c22SToby Isaac }
8027c58f1c22SToby Isaac 
8028306894acSVaclav Hapla /*@
8029306894acSVaclav Hapla   DMRemoveLabelBySelf - Remove the label from this mesh
8030306894acSVaclav Hapla 
8031306894acSVaclav Hapla   Not Collective
8032306894acSVaclav Hapla 
8033306894acSVaclav Hapla   Input Parameters:
8034306894acSVaclav Hapla + dm   - The DM object
8035306894acSVaclav Hapla . label - (Optional) The DMLabel to be removed from the DM
8036306894acSVaclav Hapla - failNotFound - Should it fail if the label is not found in the DM?
8037306894acSVaclav Hapla 
8038306894acSVaclav Hapla   Level: developer
8039306894acSVaclav Hapla 
8040306894acSVaclav Hapla   Notes:
8041306894acSVaclav Hapla   Only exactly the same instance is removed if found, name match is ignored.
8042306894acSVaclav Hapla   If the DM has an exclusive reference to the label, it gets destroyed and
8043306894acSVaclav Hapla   *label nullified.
8044306894acSVaclav Hapla 
8045306894acSVaclav Hapla .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabel() DMGetLabelValue(), DMSetLabelValue(), DMLabelDestroy(), DMRemoveLabel()
8046306894acSVaclav Hapla @*/
8047306894acSVaclav Hapla PetscErrorCode DMRemoveLabelBySelf(DM dm, DMLabel *label, PetscBool failNotFound)
8048306894acSVaclav Hapla {
804943e45a93SVaclav Hapla   DMLabelLink    link, *pnext;
8050306894acSVaclav Hapla   PetscBool      hasLabel = PETSC_FALSE;
8051306894acSVaclav Hapla   PetscErrorCode ierr;
8052306894acSVaclav Hapla 
8053306894acSVaclav Hapla   PetscFunctionBegin;
8054306894acSVaclav Hapla   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8055306894acSVaclav Hapla   PetscValidPointer(label, 2);
8056f39a9ae0SVaclav Hapla   if (!*label && !failNotFound) PetscFunctionReturn(0);
8057306894acSVaclav Hapla   PetscValidHeaderSpecific(*label, DMLABEL_CLASSID, 2);
8058306894acSVaclav Hapla   PetscValidLogicalCollectiveBool(dm,failNotFound,3);
80595d80c0bfSVaclav Hapla   for (pnext=&dm->labels; (link=*pnext); pnext=&link->next) {
806043e45a93SVaclav Hapla     if (*label == link->label) {
8061306894acSVaclav Hapla       hasLabel = PETSC_TRUE;
806243e45a93SVaclav Hapla       *pnext = link->next; /* Remove from list */
8063306894acSVaclav Hapla       if (*label == dm->depthLabel) dm->depthLabel = NULL;
8064ba2698f1SMatthew G. Knepley       if (*label == dm->celltypeLabel) dm->celltypeLabel = NULL;
806543e45a93SVaclav Hapla       if (((PetscObject) link->label)->refct < 2) *label = NULL; /* nullify if exclusive reference */
806643e45a93SVaclav Hapla       ierr = DMLabelDestroy(&link->label);CHKERRQ(ierr);
806743e45a93SVaclav Hapla       ierr = PetscFree(link);CHKERRQ(ierr);
8068306894acSVaclav Hapla       break;
8069306894acSVaclav Hapla     }
8070306894acSVaclav Hapla   }
8071306894acSVaclav Hapla   if (!hasLabel && failNotFound) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONG, "Given label not found in DM");
8072306894acSVaclav Hapla   PetscFunctionReturn(0);
8073306894acSVaclav Hapla }
8074306894acSVaclav Hapla 
8075c58f1c22SToby Isaac /*@C
8076c58f1c22SToby Isaac   DMGetLabelOutput - Get the output flag for a given label
8077c58f1c22SToby Isaac 
8078c58f1c22SToby Isaac   Not Collective
8079c58f1c22SToby Isaac 
8080c58f1c22SToby Isaac   Input Parameters:
8081c58f1c22SToby Isaac + dm   - The DM object
8082c58f1c22SToby Isaac - name - The label name
8083c58f1c22SToby Isaac 
8084c58f1c22SToby Isaac   Output Parameter:
8085c58f1c22SToby Isaac . output - The flag for output
8086c58f1c22SToby Isaac 
8087c58f1c22SToby Isaac   Level: developer
8088c58f1c22SToby Isaac 
8089c58f1c22SToby Isaac .seealso: DMSetLabelOutput(), DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
8090c58f1c22SToby Isaac @*/
8091c58f1c22SToby Isaac PetscErrorCode DMGetLabelOutput(DM dm, const char name[], PetscBool *output)
8092c58f1c22SToby Isaac {
80935d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
8094d67d17b1SMatthew G. Knepley   const char    *lname;
8095c58f1c22SToby Isaac   PetscErrorCode ierr;
8096c58f1c22SToby Isaac 
8097c58f1c22SToby Isaac   PetscFunctionBegin;
8098c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8099c58f1c22SToby Isaac   PetscValidPointer(name, 2);
8100c58f1c22SToby Isaac   PetscValidPointer(output, 3);
8101c58f1c22SToby Isaac   while (next) {
8102c58f1c22SToby Isaac     PetscBool flg;
8103c58f1c22SToby Isaac 
8104d67d17b1SMatthew G. Knepley     ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr);
8105d67d17b1SMatthew G. Knepley     ierr = PetscStrcmp(name, lname, &flg);CHKERRQ(ierr);
8106c58f1c22SToby Isaac     if (flg) {*output = next->output; PetscFunctionReturn(0);}
8107c58f1c22SToby Isaac     next = next->next;
8108c58f1c22SToby Isaac   }
8109c58f1c22SToby Isaac   SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "No label named %s was present in this dm", name);
8110c58f1c22SToby Isaac }
8111c58f1c22SToby Isaac 
8112c58f1c22SToby Isaac /*@C
8113c58f1c22SToby Isaac   DMSetLabelOutput - Set the output flag for a given label
8114c58f1c22SToby Isaac 
8115c58f1c22SToby Isaac   Not Collective
8116c58f1c22SToby Isaac 
8117c58f1c22SToby Isaac   Input Parameters:
8118c58f1c22SToby Isaac + dm     - The DM object
8119c58f1c22SToby Isaac . name   - The label name
8120c58f1c22SToby Isaac - output - The flag for output
8121c58f1c22SToby Isaac 
8122c58f1c22SToby Isaac   Level: developer
8123c58f1c22SToby Isaac 
8124c58f1c22SToby Isaac .seealso: DMGetLabelOutput(), DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
8125c58f1c22SToby Isaac @*/
8126c58f1c22SToby Isaac PetscErrorCode DMSetLabelOutput(DM dm, const char name[], PetscBool output)
8127c58f1c22SToby Isaac {
81285d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
8129d67d17b1SMatthew G. Knepley   const char    *lname;
8130c58f1c22SToby Isaac   PetscErrorCode ierr;
8131c58f1c22SToby Isaac 
8132c58f1c22SToby Isaac   PetscFunctionBegin;
8133c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8134534a8f05SLisandro Dalcin   PetscValidCharPointer(name, 2);
8135c58f1c22SToby Isaac   while (next) {
8136c58f1c22SToby Isaac     PetscBool flg;
8137c58f1c22SToby Isaac 
8138d67d17b1SMatthew G. Knepley     ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr);
8139d67d17b1SMatthew G. Knepley     ierr = PetscStrcmp(name, lname, &flg);CHKERRQ(ierr);
8140c58f1c22SToby Isaac     if (flg) {next->output = output; PetscFunctionReturn(0);}
8141c58f1c22SToby Isaac     next = next->next;
8142c58f1c22SToby Isaac   }
8143c58f1c22SToby Isaac   SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "No label named %s was present in this dm", name);
8144c58f1c22SToby Isaac }
8145c58f1c22SToby Isaac 
8146c58f1c22SToby Isaac /*@
8147c58f1c22SToby Isaac   DMCopyLabels - Copy labels from one mesh to another with a superset of the points
8148c58f1c22SToby Isaac 
8149d083f849SBarry Smith   Collective on dmA
8150c58f1c22SToby Isaac 
8151c58f1c22SToby Isaac   Input Parameter:
81525d80c0bfSVaclav Hapla + dmA - The DM object with initial labels
81532e17dfb7SMatthew G. Knepley . dmB - The DM object with copied labels
81545d80c0bfSVaclav Hapla . mode - Copy labels by pointers (PETSC_OWN_POINTER) or duplicate them (PETSC_COPY_VALUES)
8155ba2698f1SMatthew G. Knepley - all  - Copy all labels including "depth", "dim", and "celltype" (PETSC_TRUE) which are otherwise ignored (PETSC_FALSE)
8156c58f1c22SToby Isaac 
8157c58f1c22SToby Isaac   Level: intermediate
8158c58f1c22SToby Isaac 
8159c58f1c22SToby Isaac   Note: This is typically used when interpolating or otherwise adding to a mesh
8160c58f1c22SToby Isaac 
81615d80c0bfSVaclav Hapla .seealso: DMGetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM(), DMGetCoordinateSection(), DMShareLabels()
8162c58f1c22SToby Isaac @*/
81635d80c0bfSVaclav Hapla PetscErrorCode DMCopyLabels(DM dmA, DM dmB, PetscCopyMode mode, PetscBool all)
8164c58f1c22SToby Isaac {
8165c58f1c22SToby Isaac   DMLabel        label, labelNew;
8166c58f1c22SToby Isaac   const char    *name;
8167c58f1c22SToby Isaac   PetscBool      flg;
81685d80c0bfSVaclav Hapla   DMLabelLink    link;
81695d80c0bfSVaclav Hapla   PetscErrorCode ierr;
8170c58f1c22SToby Isaac 
81715d80c0bfSVaclav Hapla   PetscFunctionBegin;
81725d80c0bfSVaclav Hapla   PetscValidHeaderSpecific(dmA, DM_CLASSID, 1);
81735d80c0bfSVaclav Hapla   PetscValidHeaderSpecific(dmB, DM_CLASSID, 2);
81745d80c0bfSVaclav Hapla   PetscValidLogicalCollectiveEnum(dmA, mode,3);
81755d80c0bfSVaclav Hapla   PetscValidLogicalCollectiveBool(dmA, all, 4);
81765d80c0bfSVaclav Hapla   if (mode==PETSC_USE_POINTER) SETERRQ(PetscObjectComm((PetscObject)dmA), PETSC_ERR_SUP, "PETSC_USE_POINTER not supported for objects");
81775d80c0bfSVaclav Hapla   if (dmA == dmB) PetscFunctionReturn(0);
81785d80c0bfSVaclav Hapla   for (link=dmA->labels; link; link=link->next) {
81795d80c0bfSVaclav Hapla     label=link->label;
81805d80c0bfSVaclav Hapla     ierr = PetscObjectGetName((PetscObject)label, &name);CHKERRQ(ierr);
81815d80c0bfSVaclav Hapla     if (!all) {
8182c58f1c22SToby Isaac       ierr = PetscStrcmp(name, "depth", &flg);CHKERRQ(ierr);
8183c58f1c22SToby Isaac       if (flg) continue;
81847d5acc75SStefano Zampini       ierr = PetscStrcmp(name, "dim", &flg);CHKERRQ(ierr);
81857d5acc75SStefano Zampini       if (flg) continue;
8186ba2698f1SMatthew G. Knepley       ierr = PetscStrcmp(name, "celltype", &flg);CHKERRQ(ierr);
8187ba2698f1SMatthew G. Knepley       if (flg) continue;
81885d80c0bfSVaclav Hapla     }
81895d80c0bfSVaclav Hapla     if (mode==PETSC_COPY_VALUES) {
8190c58f1c22SToby Isaac       ierr = DMLabelDuplicate(label, &labelNew);CHKERRQ(ierr);
81915d80c0bfSVaclav Hapla     } else {
81925d80c0bfSVaclav Hapla       labelNew = label;
81935d80c0bfSVaclav Hapla     }
8194c58f1c22SToby Isaac     ierr = DMAddLabel(dmB, labelNew);CHKERRQ(ierr);
81955d80c0bfSVaclav Hapla     if (mode==PETSC_COPY_VALUES) {ierr = DMLabelDestroy(&labelNew);CHKERRQ(ierr);}
8196c58f1c22SToby Isaac   }
8197c58f1c22SToby Isaac   PetscFunctionReturn(0);
8198c58f1c22SToby Isaac }
8199461a15a0SLisandro Dalcin 
8200461a15a0SLisandro Dalcin PetscErrorCode DMSetLabelValue_Fast(DM dm, DMLabel *label, const char name[], PetscInt point, PetscInt value)
8201461a15a0SLisandro Dalcin {
8202461a15a0SLisandro Dalcin   PetscErrorCode ierr;
8203461a15a0SLisandro Dalcin   PetscFunctionBegin;
8204461a15a0SLisandro Dalcin   PetscValidPointer(label,2);
8205461a15a0SLisandro Dalcin   if (!*label) {
8206461a15a0SLisandro Dalcin     ierr = DMCreateLabel(dm, name);CHKERRQ(ierr);
8207461a15a0SLisandro Dalcin     ierr = DMGetLabel(dm, name, label);CHKERRQ(ierr);
8208461a15a0SLisandro Dalcin   }
8209461a15a0SLisandro Dalcin   ierr = DMLabelSetValue(*label, point, value);CHKERRQ(ierr);
8210461a15a0SLisandro Dalcin   PetscFunctionReturn(0);
8211461a15a0SLisandro Dalcin }
8212461a15a0SLisandro Dalcin 
82130fdc7489SMatthew Knepley /*
82140fdc7489SMatthew Knepley   Many mesh programs, such as Triangle and TetGen, allow only a single label for each mesh point. Therefore, we would
82150fdc7489SMatthew Knepley   like to encode all label IDs using a single, universal label. We can do this by assigning an integer to every
82160fdc7489SMatthew Knepley   (label, id) pair in the DM.
82170fdc7489SMatthew Knepley 
82180fdc7489SMatthew Knepley   However, a mesh point can have multiple labels, so we must separate all these values. We will assign a bit range to
82190fdc7489SMatthew Knepley   each label.
82200fdc7489SMatthew Knepley */
82210fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelCreate(DM dm, DMUniversalLabel *universal)
82220fdc7489SMatthew Knepley {
82230fdc7489SMatthew Knepley   DMUniversalLabel ul;
82240fdc7489SMatthew Knepley   PetscBool       *active;
82250fdc7489SMatthew Knepley   PetscInt         pStart, pEnd, p, Nl, l, m;
82260fdc7489SMatthew Knepley   PetscErrorCode   ierr;
82270fdc7489SMatthew Knepley 
82280fdc7489SMatthew Knepley   PetscFunctionBegin;
82290fdc7489SMatthew Knepley   ierr = PetscMalloc1(1, &ul);CHKERRQ(ierr);
82300fdc7489SMatthew Knepley   ierr = DMLabelCreate(PETSC_COMM_SELF, "universal", &ul->label);CHKERRQ(ierr);
82310fdc7489SMatthew Knepley   ierr = DMGetNumLabels(dm, &Nl);CHKERRQ(ierr);
82320fdc7489SMatthew Knepley   ierr = PetscCalloc1(Nl, &active);CHKERRQ(ierr);
82330fdc7489SMatthew Knepley   ul->Nl = 0;
82340fdc7489SMatthew Knepley   for (l = 0; l < Nl; ++l) {
82350fdc7489SMatthew Knepley     PetscBool   isdepth, iscelltype;
82360fdc7489SMatthew Knepley     const char *name;
82370fdc7489SMatthew Knepley 
82380fdc7489SMatthew Knepley     ierr = DMGetLabelName(dm, l, &name);CHKERRQ(ierr);
82390fdc7489SMatthew Knepley     ierr = PetscStrncmp(name, "depth", 6, &isdepth);CHKERRQ(ierr);
82400fdc7489SMatthew Knepley     ierr = PetscStrncmp(name, "celltype", 9, &iscelltype);CHKERRQ(ierr);
82410fdc7489SMatthew Knepley     active[l] = !(isdepth || iscelltype) ? PETSC_TRUE : PETSC_FALSE;
82420fdc7489SMatthew Knepley     if (active[l]) ++ul->Nl;
82430fdc7489SMatthew Knepley   }
82440fdc7489SMatthew 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);
82450fdc7489SMatthew Knepley   ul->Nv = 0;
82460fdc7489SMatthew Knepley   for (l = 0, m = 0; l < Nl; ++l) {
82470fdc7489SMatthew Knepley     DMLabel     label;
82480fdc7489SMatthew Knepley     PetscInt    nv;
82490fdc7489SMatthew Knepley     const char *name;
82500fdc7489SMatthew Knepley 
82510fdc7489SMatthew Knepley     if (!active[l]) continue;
82520fdc7489SMatthew Knepley     ierr = DMGetLabelName(dm, l, &name);CHKERRQ(ierr);
82530fdc7489SMatthew Knepley     ierr = DMGetLabelByNum(dm, l, &label);CHKERRQ(ierr);
82540fdc7489SMatthew Knepley     ierr = DMLabelGetNumValues(label, &nv);CHKERRQ(ierr);
82550fdc7489SMatthew Knepley     ierr = PetscStrallocpy(name, &ul->names[m]);CHKERRQ(ierr);
82560fdc7489SMatthew Knepley     ul->indices[m]   = l;
82570fdc7489SMatthew Knepley     ul->Nv          += nv;
82580fdc7489SMatthew Knepley     ul->offsets[m+1] = nv;
82590fdc7489SMatthew Knepley     ul->bits[m+1]    = PetscCeilReal(PetscLog2Real(nv+1));
82600fdc7489SMatthew Knepley     ++m;
82610fdc7489SMatthew Knepley   }
82620fdc7489SMatthew Knepley   for (l = 1; l <= ul->Nl; ++l) {
82630fdc7489SMatthew Knepley     ul->offsets[l] = ul->offsets[l-1] + ul->offsets[l];
82640fdc7489SMatthew Knepley     ul->bits[l]    = ul->bits[l-1]    + ul->bits[l];
82650fdc7489SMatthew Knepley   }
82660fdc7489SMatthew Knepley   for (l = 0; l < ul->Nl; ++l) {
82670fdc7489SMatthew Knepley     PetscInt b;
82680fdc7489SMatthew Knepley 
82690fdc7489SMatthew Knepley     ul->masks[l] = 0;
82700fdc7489SMatthew Knepley     for (b = ul->bits[l]; b < ul->bits[l+1]; ++b) ul->masks[l] |= 1 << b;
82710fdc7489SMatthew Knepley   }
82720fdc7489SMatthew Knepley   ierr = PetscMalloc1(ul->Nv, &ul->values);CHKERRQ(ierr);
82730fdc7489SMatthew Knepley   for (l = 0, m = 0; l < Nl; ++l) {
82740fdc7489SMatthew Knepley     DMLabel         label;
82750fdc7489SMatthew Knepley     IS              valueIS;
82760fdc7489SMatthew Knepley     const PetscInt *varr;
82770fdc7489SMatthew Knepley     PetscInt        nv, v;
82780fdc7489SMatthew Knepley 
82790fdc7489SMatthew Knepley     if (!active[l]) continue;
82800fdc7489SMatthew Knepley     ierr = DMGetLabelByNum(dm, l, &label);CHKERRQ(ierr);
82810fdc7489SMatthew Knepley     ierr = DMLabelGetNumValues(label, &nv);CHKERRQ(ierr);
82820fdc7489SMatthew Knepley     ierr = DMLabelGetValueIS(label, &valueIS);CHKERRQ(ierr);
82830fdc7489SMatthew Knepley     ierr = ISGetIndices(valueIS, &varr);CHKERRQ(ierr);
82840fdc7489SMatthew Knepley     for (v = 0; v < nv; ++v) {
82850fdc7489SMatthew Knepley       ul->values[ul->offsets[m]+v] = varr[v];
82860fdc7489SMatthew Knepley     }
82870fdc7489SMatthew Knepley     ierr = ISRestoreIndices(valueIS, &varr);CHKERRQ(ierr);
82880fdc7489SMatthew Knepley     ierr = ISDestroy(&valueIS);CHKERRQ(ierr);
82890fdc7489SMatthew Knepley     ierr = PetscSortInt(nv, &ul->values[ul->offsets[m]]);CHKERRQ(ierr);
82900fdc7489SMatthew Knepley     ++m;
82910fdc7489SMatthew Knepley   }
82920fdc7489SMatthew Knepley   ierr = DMPlexGetChart(dm, &pStart, &pEnd);CHKERRQ(ierr);
82930fdc7489SMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
82940fdc7489SMatthew Knepley     PetscInt  uval = 0;
82950fdc7489SMatthew Knepley     PetscBool marked = PETSC_FALSE;
82960fdc7489SMatthew Knepley 
82970fdc7489SMatthew Knepley     for (l = 0, m = 0; l < Nl; ++l) {
82980fdc7489SMatthew Knepley       DMLabel  label;
82990649b39aSStefano Zampini       PetscInt val, defval, loc, nv;
83000fdc7489SMatthew Knepley 
83010fdc7489SMatthew Knepley       if (!active[l]) continue;
83020fdc7489SMatthew Knepley       ierr = DMGetLabelByNum(dm, l, &label);CHKERRQ(ierr);
83030fdc7489SMatthew Knepley       ierr = DMLabelGetValue(label, p, &val);CHKERRQ(ierr);
83040fdc7489SMatthew Knepley       ierr = DMLabelGetDefaultValue(label, &defval);CHKERRQ(ierr);
83050fdc7489SMatthew Knepley       if (val == defval) {++m; continue;}
83060649b39aSStefano Zampini       nv = ul->offsets[m+1]-ul->offsets[m];
83070fdc7489SMatthew Knepley       marked = PETSC_TRUE;
83080fdc7489SMatthew Knepley       ierr = PetscFindInt(val, nv, &ul->values[ul->offsets[m]], &loc);CHKERRQ(ierr);
83090fdc7489SMatthew Knepley       if (loc < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_PLIB, "Label value %D not found in compression array", val);
83100fdc7489SMatthew Knepley       uval += (loc+1) << ul->bits[m];
83110fdc7489SMatthew Knepley       ++m;
83120fdc7489SMatthew Knepley     }
83130fdc7489SMatthew Knepley     if (marked) {ierr = DMLabelSetValue(ul->label, p, uval);CHKERRQ(ierr);}
83140fdc7489SMatthew Knepley   }
83150fdc7489SMatthew Knepley   ierr = PetscFree(active);CHKERRQ(ierr);
83160fdc7489SMatthew Knepley   *universal = ul;
83170fdc7489SMatthew Knepley   PetscFunctionReturn(0);
83180fdc7489SMatthew Knepley }
83190fdc7489SMatthew Knepley 
83200fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelDestroy(DMUniversalLabel *universal)
83210fdc7489SMatthew Knepley {
83220fdc7489SMatthew Knepley   PetscInt       l;
83230fdc7489SMatthew Knepley   PetscErrorCode ierr;
83240fdc7489SMatthew Knepley 
83250fdc7489SMatthew Knepley   PetscFunctionBegin;
83260fdc7489SMatthew Knepley   for (l = 0; l < (*universal)->Nl; ++l) {ierr = PetscFree((*universal)->names[l]);CHKERRQ(ierr);}
83270fdc7489SMatthew Knepley   ierr = DMLabelDestroy(&(*universal)->label);CHKERRQ(ierr);
83280fdc7489SMatthew Knepley   ierr = PetscFree5((*universal)->names, (*universal)->indices, (*universal)->offsets, (*universal)->bits, (*universal)->masks);CHKERRQ(ierr);
83290fdc7489SMatthew Knepley   ierr = PetscFree((*universal)->values);CHKERRQ(ierr);
83300fdc7489SMatthew Knepley   ierr = PetscFree(*universal);CHKERRQ(ierr);
83310fdc7489SMatthew Knepley   *universal = NULL;
83320fdc7489SMatthew Knepley   PetscFunctionReturn(0);
83330fdc7489SMatthew Knepley }
83340fdc7489SMatthew Knepley 
83350fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelGetLabel(DMUniversalLabel ul, DMLabel *ulabel)
83360fdc7489SMatthew Knepley {
83370fdc7489SMatthew Knepley   PetscFunctionBegin;
83380fdc7489SMatthew Knepley   PetscValidPointer(ulabel, 2);
83390fdc7489SMatthew Knepley   *ulabel = ul->label;
83400fdc7489SMatthew Knepley   PetscFunctionReturn(0);
83410fdc7489SMatthew Knepley }
83420fdc7489SMatthew Knepley 
83430fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelCreateLabels(DMUniversalLabel ul, PetscBool preserveOrder, DM dm)
83440fdc7489SMatthew Knepley {
83450fdc7489SMatthew Knepley   PetscInt       Nl = ul->Nl, l;
83460fdc7489SMatthew Knepley   PetscErrorCode ierr;
83470fdc7489SMatthew Knepley 
83480fdc7489SMatthew Knepley   PetscFunctionBegin;
8349064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(dm, DM_CLASSID, 3);
83500fdc7489SMatthew Knepley   for (l = 0; l < Nl; ++l) {
83510fdc7489SMatthew Knepley     if (preserveOrder) {ierr = DMCreateLabelAtIndex(dm, ul->indices[l], ul->names[l]);CHKERRQ(ierr);}
83520fdc7489SMatthew Knepley     else               {ierr = DMCreateLabel(dm, ul->names[l]);CHKERRQ(ierr);}
83530fdc7489SMatthew Knepley   }
83540fdc7489SMatthew Knepley   if (preserveOrder) {
83550fdc7489SMatthew Knepley     for (l = 0; l < ul->Nl; ++l) {
83560fdc7489SMatthew Knepley       const char *name;
83570fdc7489SMatthew Knepley       PetscBool   match;
83580fdc7489SMatthew Knepley 
83590fdc7489SMatthew Knepley       ierr = DMGetLabelName(dm, ul->indices[l], &name);CHKERRQ(ierr);
83600fdc7489SMatthew Knepley       ierr = PetscStrcmp(name, ul->names[l], &match);CHKERRQ(ierr);
83610fdc7489SMatthew 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]);
83620fdc7489SMatthew Knepley     }
83630fdc7489SMatthew Knepley   }
83640fdc7489SMatthew Knepley   PetscFunctionReturn(0);
83650fdc7489SMatthew Knepley }
83660fdc7489SMatthew Knepley 
83670fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelSetLabelValue(DMUniversalLabel ul, DM dm, PetscBool useIndex, PetscInt p, PetscInt value)
83680fdc7489SMatthew Knepley {
83690fdc7489SMatthew Knepley   PetscInt       l;
83700fdc7489SMatthew Knepley   PetscErrorCode ierr;
83710fdc7489SMatthew Knepley 
83720fdc7489SMatthew Knepley   PetscFunctionBegin;
83730fdc7489SMatthew Knepley   for (l = 0; l < ul->Nl; ++l) {
83740fdc7489SMatthew Knepley     DMLabel  label;
83750fdc7489SMatthew Knepley     PetscInt lval = (value & ul->masks[l]) >> ul->bits[l];
83760fdc7489SMatthew Knepley 
83770fdc7489SMatthew Knepley     if (lval) {
83780fdc7489SMatthew Knepley       if (useIndex) {ierr = DMGetLabelByNum(dm, ul->indices[l], &label);CHKERRQ(ierr);}
83790fdc7489SMatthew Knepley       else          {ierr = DMGetLabel(dm, ul->names[l], &label);CHKERRQ(ierr);}
83800fdc7489SMatthew Knepley       ierr = DMLabelSetValue(label, p, ul->values[ul->offsets[l]+lval-1]);CHKERRQ(ierr);
83810fdc7489SMatthew Knepley     }
83820fdc7489SMatthew Knepley   }
83830fdc7489SMatthew Knepley   PetscFunctionReturn(0);
83840fdc7489SMatthew Knepley }
8385a8fb8f29SToby Isaac 
8386a8fb8f29SToby Isaac /*@
8387a8fb8f29SToby Isaac   DMGetCoarseDM - Get the coarse mesh from which this was obtained by refinement
8388a8fb8f29SToby Isaac 
8389a8fb8f29SToby Isaac   Input Parameter:
8390a8fb8f29SToby Isaac . dm - The DM object
8391a8fb8f29SToby Isaac 
8392a8fb8f29SToby Isaac   Output Parameter:
8393a8fb8f29SToby Isaac . cdm - The coarse DM
8394a8fb8f29SToby Isaac 
8395a8fb8f29SToby Isaac   Level: intermediate
8396a8fb8f29SToby Isaac 
8397a8fb8f29SToby Isaac .seealso: DMSetCoarseDM()
8398a8fb8f29SToby Isaac @*/
8399a8fb8f29SToby Isaac PetscErrorCode DMGetCoarseDM(DM dm, DM *cdm)
8400a8fb8f29SToby Isaac {
8401a8fb8f29SToby Isaac   PetscFunctionBegin;
8402a8fb8f29SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8403a8fb8f29SToby Isaac   PetscValidPointer(cdm, 2);
8404a8fb8f29SToby Isaac   *cdm = dm->coarseMesh;
8405a8fb8f29SToby Isaac   PetscFunctionReturn(0);
8406a8fb8f29SToby Isaac }
8407a8fb8f29SToby Isaac 
8408a8fb8f29SToby Isaac /*@
8409a8fb8f29SToby Isaac   DMSetCoarseDM - Set the coarse mesh from which this was obtained by refinement
8410a8fb8f29SToby Isaac 
8411a8fb8f29SToby Isaac   Input Parameters:
8412a8fb8f29SToby Isaac + dm - The DM object
8413a8fb8f29SToby Isaac - cdm - The coarse DM
8414a8fb8f29SToby Isaac 
8415a8fb8f29SToby Isaac   Level: intermediate
8416a8fb8f29SToby Isaac 
8417a8fb8f29SToby Isaac .seealso: DMGetCoarseDM()
8418a8fb8f29SToby Isaac @*/
8419a8fb8f29SToby Isaac PetscErrorCode DMSetCoarseDM(DM dm, DM cdm)
8420a8fb8f29SToby Isaac {
8421a8fb8f29SToby Isaac   PetscErrorCode ierr;
8422a8fb8f29SToby Isaac 
8423a8fb8f29SToby Isaac   PetscFunctionBegin;
8424a8fb8f29SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8425a8fb8f29SToby Isaac   if (cdm) PetscValidHeaderSpecific(cdm, DM_CLASSID, 2);
8426a8fb8f29SToby Isaac   ierr = PetscObjectReference((PetscObject)cdm);CHKERRQ(ierr);
8427a8fb8f29SToby Isaac   ierr = DMDestroy(&dm->coarseMesh);CHKERRQ(ierr);
8428a8fb8f29SToby Isaac   dm->coarseMesh = cdm;
8429a8fb8f29SToby Isaac   PetscFunctionReturn(0);
8430a8fb8f29SToby Isaac }
8431a8fb8f29SToby Isaac 
843288bdff64SToby Isaac /*@
843388bdff64SToby Isaac   DMGetFineDM - Get the fine mesh from which this was obtained by refinement
843488bdff64SToby Isaac 
843588bdff64SToby Isaac   Input Parameter:
843688bdff64SToby Isaac . dm - The DM object
843788bdff64SToby Isaac 
843888bdff64SToby Isaac   Output Parameter:
843988bdff64SToby Isaac . fdm - The fine DM
844088bdff64SToby Isaac 
844188bdff64SToby Isaac   Level: intermediate
844288bdff64SToby Isaac 
844388bdff64SToby Isaac .seealso: DMSetFineDM()
844488bdff64SToby Isaac @*/
844588bdff64SToby Isaac PetscErrorCode DMGetFineDM(DM dm, DM *fdm)
844688bdff64SToby Isaac {
844788bdff64SToby Isaac   PetscFunctionBegin;
844888bdff64SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
844988bdff64SToby Isaac   PetscValidPointer(fdm, 2);
845088bdff64SToby Isaac   *fdm = dm->fineMesh;
845188bdff64SToby Isaac   PetscFunctionReturn(0);
845288bdff64SToby Isaac }
845388bdff64SToby Isaac 
845488bdff64SToby Isaac /*@
845588bdff64SToby Isaac   DMSetFineDM - Set the fine mesh from which this was obtained by refinement
845688bdff64SToby Isaac 
845788bdff64SToby Isaac   Input Parameters:
845888bdff64SToby Isaac + dm - The DM object
845988bdff64SToby Isaac - fdm - The fine DM
846088bdff64SToby Isaac 
846188bdff64SToby Isaac   Level: intermediate
846288bdff64SToby Isaac 
846388bdff64SToby Isaac .seealso: DMGetFineDM()
846488bdff64SToby Isaac @*/
846588bdff64SToby Isaac PetscErrorCode DMSetFineDM(DM dm, DM fdm)
846688bdff64SToby Isaac {
846788bdff64SToby Isaac   PetscErrorCode ierr;
846888bdff64SToby Isaac 
846988bdff64SToby Isaac   PetscFunctionBegin;
847088bdff64SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
847188bdff64SToby Isaac   if (fdm) PetscValidHeaderSpecific(fdm, DM_CLASSID, 2);
847288bdff64SToby Isaac   ierr = PetscObjectReference((PetscObject)fdm);CHKERRQ(ierr);
847388bdff64SToby Isaac   ierr = DMDestroy(&dm->fineMesh);CHKERRQ(ierr);
847488bdff64SToby Isaac   dm->fineMesh = fdm;
847588bdff64SToby Isaac   PetscFunctionReturn(0);
847688bdff64SToby Isaac }
847788bdff64SToby Isaac 
8478a6ba4734SToby Isaac /*=== DMBoundary code ===*/
8479a6ba4734SToby Isaac 
8480a6ba4734SToby Isaac /*@C
8481a6ba4734SToby Isaac   DMAddBoundary - Add a boundary condition to the model
8482a6ba4734SToby Isaac 
8483783e2ec8SMatthew G. Knepley   Collective on dm
8484783e2ec8SMatthew G. Knepley 
8485a6ba4734SToby Isaac   Input Parameters:
84864c258f51SMatthew G. Knepley + dm       - The DM, with a PetscDS that matches the problem being constrained
8487f971fd6bSMatthew G. Knepley . type     - The type of condition, e.g. DM_BC_ESSENTIAL_ANALYTIC/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann)
8488a6ba4734SToby Isaac . name     - The BC name
848945480ffeSMatthew G. Knepley . label    - The label defining constrained points
849045480ffeSMatthew G. Knepley . Nv       - The number of DMLabel values for constrained points
849145480ffeSMatthew G. Knepley . values   - An array of values for constrained points
8492a6ba4734SToby Isaac . field    - The field to constrain
849345480ffeSMatthew G. Knepley . Nc       - The number of constrained field components (0 will constrain all fields)
8494a6ba4734SToby Isaac . comps    - An array of constrained component numbers
8495a6ba4734SToby Isaac . bcFunc   - A pointwise function giving boundary values
849656cf3b9cSMatthew G. Knepley . bcFunc_t - A pointwise function giving the time deriative of the boundary values, or NULL
8497a6ba4734SToby Isaac - ctx      - An optional user context for bcFunc
8498a6ba4734SToby Isaac 
849945480ffeSMatthew G. Knepley   Output Parameter:
850045480ffeSMatthew G. Knepley . bd          - (Optional) Boundary number
850145480ffeSMatthew G. Knepley 
8502a6ba4734SToby Isaac   Options Database Keys:
8503a6ba4734SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids
8504a6ba4734SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components
8505a6ba4734SToby Isaac 
850656cf3b9cSMatthew G. Knepley   Note:
850756cf3b9cSMatthew 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:
850856cf3b9cSMatthew G. Knepley 
850956cf3b9cSMatthew G. Knepley $ bcFunc(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nc, PetscScalar bcval[])
851056cf3b9cSMatthew G. Knepley 
851156cf3b9cSMatthew G. Knepley   If the type is DM_BC_ESSENTIAL_FIELD or other _FIELD value, then the calling sequence is:
851256cf3b9cSMatthew G. Knepley 
851356cf3b9cSMatthew G. Knepley $ bcFunc(PetscInt dim, PetscInt Nf, PetscInt NfAux,
851456cf3b9cSMatthew G. Knepley $        const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
851556cf3b9cSMatthew G. Knepley $        const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
851656cf3b9cSMatthew G. Knepley $        PetscReal time, const PetscReal x[], PetscScalar bcval[])
851756cf3b9cSMatthew G. Knepley 
851856cf3b9cSMatthew G. Knepley + dim - the spatial dimension
851956cf3b9cSMatthew G. Knepley . Nf - the number of fields
852056cf3b9cSMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
852156cf3b9cSMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
852256cf3b9cSMatthew G. Knepley . u - each field evaluated at the current point
852356cf3b9cSMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
852456cf3b9cSMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
852556cf3b9cSMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
852656cf3b9cSMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
852756cf3b9cSMatthew G. Knepley . a - each auxiliary field evaluated at the current point
852856cf3b9cSMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
852956cf3b9cSMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
853056cf3b9cSMatthew G. Knepley . t - current time
853156cf3b9cSMatthew G. Knepley . x - coordinates of the current point
853256cf3b9cSMatthew G. Knepley . numConstants - number of constant parameters
853356cf3b9cSMatthew G. Knepley . constants - constant parameters
853456cf3b9cSMatthew G. Knepley - bcval - output values at the current point
853556cf3b9cSMatthew G. Knepley 
8536a6ba4734SToby Isaac   Level: developer
8537a6ba4734SToby Isaac 
853845480ffeSMatthew G. Knepley .seealso: DSGetBoundary(), PetscDSAddBoundary()
8539a6ba4734SToby Isaac @*/
854045480ffeSMatthew 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)
8541a6ba4734SToby Isaac {
8542e5e52638SMatthew G. Knepley   PetscDS        ds;
8543a6ba4734SToby Isaac   PetscErrorCode ierr;
8544a6ba4734SToby Isaac 
8545a6ba4734SToby Isaac   PetscFunctionBegin;
8546a6ba4734SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8547783e2ec8SMatthew G. Knepley   PetscValidLogicalCollectiveEnum(dm, type, 2);
854845480ffeSMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 4);
854945480ffeSMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, Nv, 5);
855045480ffeSMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, field, 7);
855145480ffeSMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, Nc, 8);
8552e5e52638SMatthew G. Knepley   ierr = DMGetDS(dm, &ds);CHKERRQ(ierr);
855345480ffeSMatthew G. Knepley   ierr = DMCompleteBoundaryLabel_Internal(dm, ds, field, PETSC_MAX_INT, label);CHKERRQ(ierr);
855445480ffeSMatthew G. Knepley   ierr = PetscDSAddBoundary(ds, type, name, label, Nv, values, field, Nc, comps, bcFunc, bcFunc_t, ctx, bd);CHKERRQ(ierr);
8555a6ba4734SToby Isaac   PetscFunctionReturn(0);
8556a6ba4734SToby Isaac }
8557a6ba4734SToby Isaac 
855845480ffeSMatthew G. Knepley /* TODO Remove this since now the structures are the same */
8559e6f8dbb6SToby Isaac static PetscErrorCode DMPopulateBoundary(DM dm)
8560e6f8dbb6SToby Isaac {
8561e5e52638SMatthew G. Knepley   PetscDS        ds;
8562dff059c6SToby Isaac   DMBoundary    *lastnext;
8563e6f8dbb6SToby Isaac   DSBoundary     dsbound;
8564e6f8dbb6SToby Isaac   PetscErrorCode ierr;
8565e6f8dbb6SToby Isaac 
8566e6f8dbb6SToby Isaac   PetscFunctionBegin;
8567e5e52638SMatthew G. Knepley   ierr = DMGetDS(dm, &ds);CHKERRQ(ierr);
8568e5e52638SMatthew G. Knepley   dsbound = ds->boundary;
856947a1f5adSToby Isaac   if (dm->boundary) {
857047a1f5adSToby Isaac     DMBoundary next = dm->boundary;
857147a1f5adSToby Isaac 
857247a1f5adSToby Isaac     /* quick check to see if the PetscDS has changed */
857347a1f5adSToby Isaac     if (next->dsboundary == dsbound) PetscFunctionReturn(0);
857447a1f5adSToby Isaac     /* the PetscDS has changed: tear down and rebuild */
857547a1f5adSToby Isaac     while (next) {
857647a1f5adSToby Isaac       DMBoundary b = next;
857747a1f5adSToby Isaac 
857847a1f5adSToby Isaac       next = b->next;
857947a1f5adSToby Isaac       ierr = PetscFree(b);CHKERRQ(ierr);
8580a6ba4734SToby Isaac     }
858147a1f5adSToby Isaac     dm->boundary = NULL;
8582a6ba4734SToby Isaac   }
858347a1f5adSToby Isaac 
8584dff059c6SToby Isaac   lastnext = &(dm->boundary);
8585e6f8dbb6SToby Isaac   while (dsbound) {
8586e6f8dbb6SToby Isaac     DMBoundary dmbound;
8587e6f8dbb6SToby Isaac 
8588e6f8dbb6SToby Isaac     ierr = PetscNew(&dmbound);CHKERRQ(ierr);
8589e6f8dbb6SToby Isaac     dmbound->dsboundary = dsbound;
859045480ffeSMatthew G. Knepley     dmbound->label      = dsbound->label;
859147a1f5adSToby Isaac     /* push on the back instead of the front so that it is in the same order as in the PetscDS */
8592dff059c6SToby Isaac     *lastnext = dmbound;
8593dff059c6SToby Isaac     lastnext = &(dmbound->next);
8594dff059c6SToby Isaac     dsbound = dsbound->next;
8595a6ba4734SToby Isaac   }
8596a6ba4734SToby Isaac   PetscFunctionReturn(0);
8597a6ba4734SToby Isaac }
8598a6ba4734SToby Isaac 
8599a6ba4734SToby Isaac PetscErrorCode DMIsBoundaryPoint(DM dm, PetscInt point, PetscBool *isBd)
8600a6ba4734SToby Isaac {
8601b95f2879SToby Isaac   DMBoundary     b;
8602a6ba4734SToby Isaac   PetscErrorCode ierr;
8603a6ba4734SToby Isaac 
8604a6ba4734SToby Isaac   PetscFunctionBegin;
8605a6ba4734SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8606534a8f05SLisandro Dalcin   PetscValidBoolPointer(isBd, 3);
8607a6ba4734SToby Isaac   *isBd = PETSC_FALSE;
8608e6f8dbb6SToby Isaac   ierr = DMPopulateBoundary(dm);CHKERRQ(ierr);
8609b95f2879SToby Isaac   b = dm->boundary;
8610a6ba4734SToby Isaac   while (b && !(*isBd)) {
8611e6f8dbb6SToby Isaac     DMLabel    label = b->label;
8612e6f8dbb6SToby Isaac     DSBoundary dsb   = b->dsboundary;
8613a6ba4734SToby Isaac     PetscInt   i;
8614a6ba4734SToby Isaac 
861545480ffeSMatthew G. Knepley     if (label) {
861645480ffeSMatthew G. Knepley       for (i = 0; i < dsb->Nv && !(*isBd); ++i) {ierr = DMLabelStratumHasPoint(label, dsb->values[i], point, isBd);CHKERRQ(ierr);}
8617a6ba4734SToby Isaac     }
8618a6ba4734SToby Isaac     b = b->next;
8619a6ba4734SToby Isaac   }
8620a6ba4734SToby Isaac   PetscFunctionReturn(0);
8621a6ba4734SToby Isaac }
86224d6f44ffSToby Isaac 
86234d6f44ffSToby Isaac /*@C
8624a6e0b375SMatthew G. Knepley   DMProjectFunction - This projects the given function into the function space provided, putting the coefficients in a global vector.
8625a6e0b375SMatthew G. Knepley 
8626a6e0b375SMatthew G. Knepley   Collective on DM
86274d6f44ffSToby Isaac 
86284d6f44ffSToby Isaac   Input Parameters:
86294d6f44ffSToby Isaac + dm      - The DM
86300709b2feSToby Isaac . time    - The time
86314d6f44ffSToby Isaac . funcs   - The coordinate functions to evaluate, one per field
86324d6f44ffSToby Isaac . ctxs    - Optional array of contexts to pass to each coordinate function.  ctxs itself may be null.
86334d6f44ffSToby Isaac - mode    - The insertion mode for values
86344d6f44ffSToby Isaac 
86354d6f44ffSToby Isaac   Output Parameter:
86364d6f44ffSToby Isaac . X - vector
86374d6f44ffSToby Isaac 
86384d6f44ffSToby Isaac    Calling sequence of func:
86390709b2feSToby Isaac $    func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nf, PetscScalar u[], void *ctx);
86404d6f44ffSToby Isaac 
86414d6f44ffSToby Isaac +  dim - The spatial dimension
86428ec8862eSJed Brown .  time - The time at which to sample
86434d6f44ffSToby Isaac .  x   - The coordinates
86444d6f44ffSToby Isaac .  Nf  - The number of fields
86454d6f44ffSToby Isaac .  u   - The output field values
86464d6f44ffSToby Isaac -  ctx - optional user-defined function context
86474d6f44ffSToby Isaac 
86484d6f44ffSToby Isaac   Level: developer
86494d6f44ffSToby Isaac 
8650a6e0b375SMatthew G. Knepley .seealso: DMProjectFunctionLocal(), DMProjectFunctionLabel(), DMComputeL2Diff()
86514d6f44ffSToby Isaac @*/
86520709b2feSToby Isaac PetscErrorCode DMProjectFunction(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec X)
86534d6f44ffSToby Isaac {
86544d6f44ffSToby Isaac   Vec            localX;
86554d6f44ffSToby Isaac   PetscErrorCode ierr;
86564d6f44ffSToby Isaac 
86574d6f44ffSToby Isaac   PetscFunctionBegin;
86584d6f44ffSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
86594d6f44ffSToby Isaac   ierr = DMGetLocalVector(dm, &localX);CHKERRQ(ierr);
86600709b2feSToby Isaac   ierr = DMProjectFunctionLocal(dm, time, funcs, ctxs, mode, localX);CHKERRQ(ierr);
86614d6f44ffSToby Isaac   ierr = DMLocalToGlobalBegin(dm, localX, mode, X);CHKERRQ(ierr);
86624d6f44ffSToby Isaac   ierr = DMLocalToGlobalEnd(dm, localX, mode, X);CHKERRQ(ierr);
86634d6f44ffSToby Isaac   ierr = DMRestoreLocalVector(dm, &localX);CHKERRQ(ierr);
86644d6f44ffSToby Isaac   PetscFunctionReturn(0);
86654d6f44ffSToby Isaac }
86664d6f44ffSToby Isaac 
8667a6e0b375SMatthew G. Knepley /*@C
8668a6e0b375SMatthew G. Knepley   DMProjectFunctionLocal - This projects the given function into the function space provided, putting the coefficients in a local vector.
8669a6e0b375SMatthew G. Knepley 
8670a6e0b375SMatthew G. Knepley   Not collective
8671a6e0b375SMatthew G. Knepley 
8672a6e0b375SMatthew G. Knepley   Input Parameters:
8673a6e0b375SMatthew G. Knepley + dm      - The DM
8674a6e0b375SMatthew G. Knepley . time    - The time
8675a6e0b375SMatthew G. Knepley . funcs   - The coordinate functions to evaluate, one per field
8676a6e0b375SMatthew G. Knepley . ctxs    - Optional array of contexts to pass to each coordinate function.  ctxs itself may be null.
8677a6e0b375SMatthew G. Knepley - mode    - The insertion mode for values
8678a6e0b375SMatthew G. Knepley 
8679a6e0b375SMatthew G. Knepley   Output Parameter:
8680a6e0b375SMatthew G. Knepley . localX - vector
8681a6e0b375SMatthew G. Knepley 
8682a6e0b375SMatthew G. Knepley    Calling sequence of func:
8683a6e0b375SMatthew G. Knepley $    func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nf, PetscScalar u[], void *ctx);
8684a6e0b375SMatthew G. Knepley 
8685a6e0b375SMatthew G. Knepley +  dim - The spatial dimension
8686a6e0b375SMatthew G. Knepley .  x   - The coordinates
8687a6e0b375SMatthew G. Knepley .  Nf  - The number of fields
8688a6e0b375SMatthew G. Knepley .  u   - The output field values
8689a6e0b375SMatthew G. Knepley -  ctx - optional user-defined function context
8690a6e0b375SMatthew G. Knepley 
8691a6e0b375SMatthew G. Knepley   Level: developer
8692a6e0b375SMatthew G. Knepley 
8693a6e0b375SMatthew G. Knepley .seealso: DMProjectFunction(), DMProjectFunctionLabel(), DMComputeL2Diff()
8694a6e0b375SMatthew G. Knepley @*/
86950709b2feSToby Isaac PetscErrorCode DMProjectFunctionLocal(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec localX)
86964d6f44ffSToby Isaac {
86974d6f44ffSToby Isaac   PetscErrorCode ierr;
86984d6f44ffSToby Isaac 
86994d6f44ffSToby Isaac   PetscFunctionBegin;
87004d6f44ffSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
8701064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(localX,VEC_CLASSID,6);
87020918c465SMatthew G. Knepley   if (!dm->ops->projectfunctionlocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFunctionLocal",((PetscObject)dm)->type_name);
87030709b2feSToby Isaac   ierr = (dm->ops->projectfunctionlocal) (dm, time, funcs, ctxs, mode, localX);CHKERRQ(ierr);
87044d6f44ffSToby Isaac   PetscFunctionReturn(0);
87054d6f44ffSToby Isaac }
87064d6f44ffSToby Isaac 
8707a6e0b375SMatthew G. Knepley /*@C
8708a6e0b375SMatthew 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.
8709a6e0b375SMatthew G. Knepley 
8710a6e0b375SMatthew G. Knepley   Collective on DM
8711a6e0b375SMatthew G. Knepley 
8712a6e0b375SMatthew G. Knepley   Input Parameters:
8713a6e0b375SMatthew G. Knepley + dm      - The DM
8714a6e0b375SMatthew G. Knepley . time    - The time
8715a6e0b375SMatthew G. Knepley . label   - The DMLabel selecting the portion of the mesh for projection
8716a6e0b375SMatthew G. Knepley . funcs   - The coordinate functions to evaluate, one per field
8717a6e0b375SMatthew G. Knepley . ctxs    - Optional array of contexts to pass to each coordinate function.  ctxs itself may be null.
8718a6e0b375SMatthew G. Knepley - mode    - The insertion mode for values
8719a6e0b375SMatthew G. Knepley 
8720a6e0b375SMatthew G. Knepley   Output Parameter:
8721a6e0b375SMatthew G. Knepley . X - vector
8722a6e0b375SMatthew G. Knepley 
8723a6e0b375SMatthew G. Knepley    Calling sequence of func:
8724a6e0b375SMatthew G. Knepley $    func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nf, PetscScalar u[], void *ctx);
8725a6e0b375SMatthew G. Knepley 
8726a6e0b375SMatthew G. Knepley +  dim - The spatial dimension
8727a6e0b375SMatthew G. Knepley .  x   - The coordinates
8728a6e0b375SMatthew G. Knepley .  Nf  - The number of fields
8729a6e0b375SMatthew G. Knepley .  u   - The output field values
8730a6e0b375SMatthew G. Knepley -  ctx - optional user-defined function context
8731a6e0b375SMatthew G. Knepley 
8732a6e0b375SMatthew G. Knepley   Level: developer
8733a6e0b375SMatthew G. Knepley 
8734a6e0b375SMatthew G. Knepley .seealso: DMProjectFunction(), DMProjectFunctionLocal(), DMProjectFunctionLabelLocal(), DMComputeL2Diff()
8735a6e0b375SMatthew G. Knepley @*/
87362c53366bSMatthew 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)
87372c53366bSMatthew G. Knepley {
87382c53366bSMatthew G. Knepley   Vec            localX;
87392c53366bSMatthew G. Knepley   PetscErrorCode ierr;
87402c53366bSMatthew G. Knepley 
87412c53366bSMatthew G. Knepley   PetscFunctionBegin;
87422c53366bSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
87432c53366bSMatthew G. Knepley   ierr = DMGetLocalVector(dm, &localX);CHKERRQ(ierr);
87442c53366bSMatthew G. Knepley   ierr = DMProjectFunctionLabelLocal(dm, time, label, numIds, ids, Nc, comps, funcs, ctxs, mode, localX);CHKERRQ(ierr);
87452c53366bSMatthew G. Knepley   ierr = DMLocalToGlobalBegin(dm, localX, mode, X);CHKERRQ(ierr);
87462c53366bSMatthew G. Knepley   ierr = DMLocalToGlobalEnd(dm, localX, mode, X);CHKERRQ(ierr);
87472c53366bSMatthew G. Knepley   ierr = DMRestoreLocalVector(dm, &localX);CHKERRQ(ierr);
87482c53366bSMatthew G. Knepley   PetscFunctionReturn(0);
87492c53366bSMatthew G. Knepley }
87502c53366bSMatthew G. Knepley 
8751a6e0b375SMatthew G. Knepley /*@C
8752a6e0b375SMatthew 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.
8753a6e0b375SMatthew G. Knepley 
8754a6e0b375SMatthew G. Knepley   Not collective
8755a6e0b375SMatthew G. Knepley 
8756a6e0b375SMatthew G. Knepley   Input Parameters:
8757a6e0b375SMatthew G. Knepley + dm      - The DM
8758a6e0b375SMatthew G. Knepley . time    - The time
8759a6e0b375SMatthew G. Knepley . label   - The DMLabel selecting the portion of the mesh for projection
8760a6e0b375SMatthew G. Knepley . funcs   - The coordinate functions to evaluate, one per field
8761a6e0b375SMatthew G. Knepley . ctxs    - Optional array of contexts to pass to each coordinate function.  ctxs itself may be null.
8762a6e0b375SMatthew G. Knepley - mode    - The insertion mode for values
8763a6e0b375SMatthew G. Knepley 
8764a6e0b375SMatthew G. Knepley   Output Parameter:
8765a6e0b375SMatthew G. Knepley . localX - vector
8766a6e0b375SMatthew G. Knepley 
8767a6e0b375SMatthew G. Knepley    Calling sequence of func:
8768a6e0b375SMatthew G. Knepley $    func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nf, PetscScalar u[], void *ctx);
8769a6e0b375SMatthew G. Knepley 
8770a6e0b375SMatthew G. Knepley +  dim - The spatial dimension
8771a6e0b375SMatthew G. Knepley .  x   - The coordinates
8772a6e0b375SMatthew G. Knepley .  Nf  - The number of fields
8773a6e0b375SMatthew G. Knepley .  u   - The output field values
8774a6e0b375SMatthew G. Knepley -  ctx - optional user-defined function context
8775a6e0b375SMatthew G. Knepley 
8776a6e0b375SMatthew G. Knepley   Level: developer
8777a6e0b375SMatthew G. Knepley 
8778a6e0b375SMatthew G. Knepley .seealso: DMProjectFunction(), DMProjectFunctionLocal(), DMProjectFunctionLabel(), DMComputeL2Diff()
8779a6e0b375SMatthew G. Knepley @*/
87801c531cf8SMatthew 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)
87814d6f44ffSToby Isaac {
87824d6f44ffSToby Isaac   PetscErrorCode ierr;
87834d6f44ffSToby Isaac 
87844d6f44ffSToby Isaac   PetscFunctionBegin;
87854d6f44ffSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
8786064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(localX,VEC_CLASSID,11);
87870918c465SMatthew G. Knepley   if (!dm->ops->projectfunctionlabellocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFunctionLabelLocal",((PetscObject)dm)->type_name);
87881c531cf8SMatthew G. Knepley   ierr = (dm->ops->projectfunctionlabellocal) (dm, time, label, numIds, ids, Nc, comps, funcs, ctxs, mode, localX);CHKERRQ(ierr);
87894d6f44ffSToby Isaac   PetscFunctionReturn(0);
87904d6f44ffSToby Isaac }
87912716604bSToby Isaac 
8792a6e0b375SMatthew G. Knepley /*@C
8793a6e0b375SMatthew G. Knepley   DMProjectFieldLocal - This projects the given function of the input fields into the function space provided, putting the coefficients in a local vector.
8794a6e0b375SMatthew G. Knepley 
8795a6e0b375SMatthew G. Knepley   Not collective
8796a6e0b375SMatthew G. Knepley 
8797a6e0b375SMatthew G. Knepley   Input Parameters:
8798a6e0b375SMatthew G. Knepley + dm      - The DM
8799a6e0b375SMatthew G. Knepley . time    - The time
8800a6e0b375SMatthew G. Knepley . localU  - The input field vector
8801a6e0b375SMatthew G. Knepley . funcs   - The functions to evaluate, one per field
8802a6e0b375SMatthew G. Knepley - mode    - The insertion mode for values
8803a6e0b375SMatthew G. Knepley 
8804a6e0b375SMatthew G. Knepley   Output Parameter:
8805a6e0b375SMatthew G. Knepley . localX  - The output vector
8806a6e0b375SMatthew G. Knepley 
8807a6e0b375SMatthew G. Knepley    Calling sequence of func:
8808a6e0b375SMatthew G. Knepley $    func(PetscInt dim, PetscInt Nf, PetscInt NfAux,
8809a6e0b375SMatthew G. Knepley $         const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
8810a6e0b375SMatthew G. Knepley $         const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
8811a6e0b375SMatthew G. Knepley $         PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f[]);
8812a6e0b375SMatthew G. Knepley 
8813a6e0b375SMatthew G. Knepley +  dim          - The spatial dimension
8814a6e0b375SMatthew G. Knepley .  Nf           - The number of input fields
8815a6e0b375SMatthew G. Knepley .  NfAux        - The number of input auxiliary fields
8816a6e0b375SMatthew G. Knepley .  uOff         - The offset of each field in u[]
8817a6e0b375SMatthew G. Knepley .  uOff_x       - The offset of each field in u_x[]
8818a6e0b375SMatthew G. Knepley .  u            - The field values at this point in space
8819a6e0b375SMatthew G. Knepley .  u_t          - The field time derivative at this point in space (or NULL)
8820a6e0b375SMatthew G. Knepley .  u_x          - The field derivatives at this point in space
8821a6e0b375SMatthew G. Knepley .  aOff         - The offset of each auxiliary field in u[]
8822a6e0b375SMatthew G. Knepley .  aOff_x       - The offset of each auxiliary field in u_x[]
8823a6e0b375SMatthew G. Knepley .  a            - The auxiliary field values at this point in space
8824a6e0b375SMatthew G. Knepley .  a_t          - The auxiliary field time derivative at this point in space (or NULL)
8825a6e0b375SMatthew G. Knepley .  a_x          - The auxiliary field derivatives at this point in space
8826a6e0b375SMatthew G. Knepley .  t            - The current time
8827a6e0b375SMatthew G. Knepley .  x            - The coordinates of this point
8828a6e0b375SMatthew G. Knepley .  numConstants - The number of constants
8829a6e0b375SMatthew G. Knepley .  constants    - The value of each constant
8830a6e0b375SMatthew G. Knepley -  f            - The value of the function at this point in space
8831a6e0b375SMatthew G. Knepley 
8832a6e0b375SMatthew 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.
8833a6e0b375SMatthew 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
8834a6e0b375SMatthew 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
8835a6e0b375SMatthew 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.
8836a6e0b375SMatthew G. Knepley 
8837a6e0b375SMatthew G. Knepley   Level: intermediate
8838a6e0b375SMatthew G. Knepley 
8839a6e0b375SMatthew G. Knepley .seealso: DMProjectField(), DMProjectFieldLabelLocal(), DMProjectFunction(), DMComputeL2Diff()
8840a6e0b375SMatthew G. Knepley @*/
88418c6c5593SMatthew G. Knepley PetscErrorCode DMProjectFieldLocal(DM dm, PetscReal time, Vec localU,
88428c6c5593SMatthew G. Knepley                                    void (**funcs)(PetscInt, PetscInt, PetscInt,
88438c6c5593SMatthew G. Knepley                                                   const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
88448c6c5593SMatthew G. Knepley                                                   const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
8845191494d9SMatthew G. Knepley                                                   PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]),
88468c6c5593SMatthew G. Knepley                                    InsertMode mode, Vec localX)
88478c6c5593SMatthew G. Knepley {
88488c6c5593SMatthew G. Knepley   PetscErrorCode ierr;
88498c6c5593SMatthew G. Knepley 
88508c6c5593SMatthew G. Knepley   PetscFunctionBegin;
88518c6c5593SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
88528c6c5593SMatthew G. Knepley   PetscValidHeaderSpecific(localU,VEC_CLASSID,3);
88538c6c5593SMatthew G. Knepley   PetscValidHeaderSpecific(localX,VEC_CLASSID,6);
88540918c465SMatthew G. Knepley   if (!dm->ops->projectfieldlocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFieldLocal",((PetscObject)dm)->type_name);
88558c6c5593SMatthew G. Knepley   ierr = (dm->ops->projectfieldlocal) (dm, time, localU, funcs, mode, localX);CHKERRQ(ierr);
88568c6c5593SMatthew G. Knepley   PetscFunctionReturn(0);
88578c6c5593SMatthew G. Knepley }
88588c6c5593SMatthew G. Knepley 
8859a6e0b375SMatthew G. Knepley /*@C
8860a6e0b375SMatthew 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.
8861a6e0b375SMatthew G. Knepley 
8862a6e0b375SMatthew G. Knepley   Not collective
8863a6e0b375SMatthew G. Knepley 
8864a6e0b375SMatthew G. Knepley   Input Parameters:
8865a6e0b375SMatthew G. Knepley + dm      - The DM
8866a6e0b375SMatthew G. Knepley . time    - The time
8867a6e0b375SMatthew G. Knepley . label   - The DMLabel marking the portion of the domain to output
8868a6e0b375SMatthew G. Knepley . numIds  - The number of label ids to use
8869a6e0b375SMatthew G. Knepley . ids     - The label ids to use for marking
8870a6e0b375SMatthew G. Knepley . Nc      - The number of components to set in the output, or PETSC_DETERMINE for all components
8871a6e0b375SMatthew G. Knepley . comps   - The components to set in the output, or NULL for all components
8872a6e0b375SMatthew G. Knepley . localU  - The input field vector
8873a6e0b375SMatthew G. Knepley . funcs   - The functions to evaluate, one per field
8874a6e0b375SMatthew G. Knepley - mode    - The insertion mode for values
8875a6e0b375SMatthew G. Knepley 
8876a6e0b375SMatthew G. Knepley   Output Parameter:
8877a6e0b375SMatthew G. Knepley . localX  - The output vector
8878a6e0b375SMatthew G. Knepley 
8879a6e0b375SMatthew G. Knepley    Calling sequence of func:
8880a6e0b375SMatthew G. Knepley $    func(PetscInt dim, PetscInt Nf, PetscInt NfAux,
8881a6e0b375SMatthew G. Knepley $         const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
8882a6e0b375SMatthew G. Knepley $         const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
8883a6e0b375SMatthew G. Knepley $         PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f[]);
8884a6e0b375SMatthew G. Knepley 
8885a6e0b375SMatthew G. Knepley +  dim          - The spatial dimension
8886a6e0b375SMatthew G. Knepley .  Nf           - The number of input fields
8887a6e0b375SMatthew G. Knepley .  NfAux        - The number of input auxiliary fields
8888a6e0b375SMatthew G. Knepley .  uOff         - The offset of each field in u[]
8889a6e0b375SMatthew G. Knepley .  uOff_x       - The offset of each field in u_x[]
8890a6e0b375SMatthew G. Knepley .  u            - The field values at this point in space
8891a6e0b375SMatthew G. Knepley .  u_t          - The field time derivative at this point in space (or NULL)
8892a6e0b375SMatthew G. Knepley .  u_x          - The field derivatives at this point in space
8893a6e0b375SMatthew G. Knepley .  aOff         - The offset of each auxiliary field in u[]
8894a6e0b375SMatthew G. Knepley .  aOff_x       - The offset of each auxiliary field in u_x[]
8895a6e0b375SMatthew G. Knepley .  a            - The auxiliary field values at this point in space
8896a6e0b375SMatthew G. Knepley .  a_t          - The auxiliary field time derivative at this point in space (or NULL)
8897a6e0b375SMatthew G. Knepley .  a_x          - The auxiliary field derivatives at this point in space
8898a6e0b375SMatthew G. Knepley .  t            - The current time
8899a6e0b375SMatthew G. Knepley .  x            - The coordinates of this point
8900a6e0b375SMatthew G. Knepley .  numConstants - The number of constants
8901a6e0b375SMatthew G. Knepley .  constants    - The value of each constant
8902a6e0b375SMatthew G. Knepley -  f            - The value of the function at this point in space
8903a6e0b375SMatthew G. Knepley 
8904a6e0b375SMatthew 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.
8905a6e0b375SMatthew 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
8906a6e0b375SMatthew 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
8907a6e0b375SMatthew 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.
8908a6e0b375SMatthew G. Knepley 
8909a6e0b375SMatthew G. Knepley   Level: intermediate
8910a6e0b375SMatthew G. Knepley 
8911a6e0b375SMatthew G. Knepley .seealso: DMProjectField(), DMProjectFieldLabelLocal(), DMProjectFunction(), DMComputeL2Diff()
8912a6e0b375SMatthew G. Knepley @*/
89131c531cf8SMatthew G. Knepley PetscErrorCode DMProjectFieldLabelLocal(DM dm, PetscReal time, DMLabel label, PetscInt numIds, const PetscInt ids[], PetscInt Nc, const PetscInt comps[], Vec localU,
89148c6c5593SMatthew G. Knepley                                         void (**funcs)(PetscInt, PetscInt, PetscInt,
89158c6c5593SMatthew G. Knepley                                                        const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
89168c6c5593SMatthew G. Knepley                                                        const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
8917191494d9SMatthew G. Knepley                                                        PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]),
89188c6c5593SMatthew G. Knepley                                         InsertMode mode, Vec localX)
89198c6c5593SMatthew G. Knepley {
89208c6c5593SMatthew G. Knepley   PetscErrorCode ierr;
89218c6c5593SMatthew G. Knepley 
89228c6c5593SMatthew G. Knepley   PetscFunctionBegin;
89238c6c5593SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
8924064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(localU,VEC_CLASSID,8);
8925064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(localX,VEC_CLASSID,11);
8926ece3a9fcSMatthew G. Knepley   if (!dm->ops->projectfieldlabellocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFieldLabelLocal",((PetscObject)dm)->type_name);
89271c531cf8SMatthew G. Knepley   ierr = (dm->ops->projectfieldlabellocal)(dm, time, label, numIds, ids, Nc, comps, localU, funcs, mode, localX);CHKERRQ(ierr);
89288c6c5593SMatthew G. Knepley   PetscFunctionReturn(0);
89298c6c5593SMatthew G. Knepley }
89308c6c5593SMatthew G. Knepley 
89312716604bSToby Isaac /*@C
8932ece3a9fcSMatthew 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.
8933ece3a9fcSMatthew G. Knepley 
8934ece3a9fcSMatthew G. Knepley   Not collective
8935ece3a9fcSMatthew G. Knepley 
8936ece3a9fcSMatthew G. Knepley   Input Parameters:
8937ece3a9fcSMatthew G. Knepley + dm      - The DM
8938ece3a9fcSMatthew G. Knepley . time    - The time
8939ece3a9fcSMatthew G. Knepley . label   - The DMLabel marking the portion of the domain boundary to output
8940ece3a9fcSMatthew G. Knepley . numIds  - The number of label ids to use
8941ece3a9fcSMatthew G. Knepley . ids     - The label ids to use for marking
8942ece3a9fcSMatthew G. Knepley . Nc      - The number of components to set in the output, or PETSC_DETERMINE for all components
8943ece3a9fcSMatthew G. Knepley . comps   - The components to set in the output, or NULL for all components
8944ece3a9fcSMatthew G. Knepley . localU  - The input field vector
8945ece3a9fcSMatthew G. Knepley . funcs   - The functions to evaluate, one per field
8946ece3a9fcSMatthew G. Knepley - mode    - The insertion mode for values
8947ece3a9fcSMatthew G. Knepley 
8948ece3a9fcSMatthew G. Knepley   Output Parameter:
8949ece3a9fcSMatthew G. Knepley . localX  - The output vector
8950ece3a9fcSMatthew G. Knepley 
8951ece3a9fcSMatthew G. Knepley    Calling sequence of func:
8952ece3a9fcSMatthew G. Knepley $    func(PetscInt dim, PetscInt Nf, PetscInt NfAux,
8953ece3a9fcSMatthew G. Knepley $         const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
8954ece3a9fcSMatthew G. Knepley $         const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
8955ece3a9fcSMatthew G. Knepley $         PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f[]);
8956ece3a9fcSMatthew G. Knepley 
8957ece3a9fcSMatthew G. Knepley +  dim          - The spatial dimension
8958ece3a9fcSMatthew G. Knepley .  Nf           - The number of input fields
8959ece3a9fcSMatthew G. Knepley .  NfAux        - The number of input auxiliary fields
8960ece3a9fcSMatthew G. Knepley .  uOff         - The offset of each field in u[]
8961ece3a9fcSMatthew G. Knepley .  uOff_x       - The offset of each field in u_x[]
8962ece3a9fcSMatthew G. Knepley .  u            - The field values at this point in space
8963ece3a9fcSMatthew G. Knepley .  u_t          - The field time derivative at this point in space (or NULL)
8964ece3a9fcSMatthew G. Knepley .  u_x          - The field derivatives at this point in space
8965ece3a9fcSMatthew G. Knepley .  aOff         - The offset of each auxiliary field in u[]
8966ece3a9fcSMatthew G. Knepley .  aOff_x       - The offset of each auxiliary field in u_x[]
8967ece3a9fcSMatthew G. Knepley .  a            - The auxiliary field values at this point in space
8968ece3a9fcSMatthew G. Knepley .  a_t          - The auxiliary field time derivative at this point in space (or NULL)
8969ece3a9fcSMatthew G. Knepley .  a_x          - The auxiliary field derivatives at this point in space
8970ece3a9fcSMatthew G. Knepley .  t            - The current time
8971ece3a9fcSMatthew G. Knepley .  x            - The coordinates of this point
8972ece3a9fcSMatthew G. Knepley .  n            - The face normal
8973ece3a9fcSMatthew G. Knepley .  numConstants - The number of constants
8974ece3a9fcSMatthew G. Knepley .  constants    - The value of each constant
8975ece3a9fcSMatthew G. Knepley -  f            - The value of the function at this point in space
8976ece3a9fcSMatthew G. Knepley 
8977ece3a9fcSMatthew G. Knepley   Note:
8978ece3a9fcSMatthew 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.
8979ece3a9fcSMatthew 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
8980ece3a9fcSMatthew 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
8981ece3a9fcSMatthew 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.
8982ece3a9fcSMatthew G. Knepley 
8983ece3a9fcSMatthew G. Knepley   Level: intermediate
8984ece3a9fcSMatthew G. Knepley 
8985ece3a9fcSMatthew G. Knepley .seealso: DMProjectField(), DMProjectFieldLabelLocal(), DMProjectFunction(), DMComputeL2Diff()
8986ece3a9fcSMatthew G. Knepley @*/
8987ece3a9fcSMatthew G. Knepley PetscErrorCode DMProjectBdFieldLabelLocal(DM dm, PetscReal time, DMLabel label, PetscInt numIds, const PetscInt ids[], PetscInt Nc, const PetscInt comps[], Vec localU,
8988ece3a9fcSMatthew G. Knepley                                           void (**funcs)(PetscInt, PetscInt, PetscInt,
8989ece3a9fcSMatthew G. Knepley                                                          const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
8990ece3a9fcSMatthew G. Knepley                                                          const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
8991ece3a9fcSMatthew G. Knepley                                                          PetscReal, const PetscReal[], const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]),
8992ece3a9fcSMatthew G. Knepley                                           InsertMode mode, Vec localX)
8993ece3a9fcSMatthew G. Knepley {
8994ece3a9fcSMatthew G. Knepley   PetscErrorCode ierr;
8995ece3a9fcSMatthew G. Knepley 
8996ece3a9fcSMatthew G. Knepley   PetscFunctionBegin;
8997ece3a9fcSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
8998064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(localU,VEC_CLASSID,8);
8999064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(localX,VEC_CLASSID,11);
9000ece3a9fcSMatthew G. Knepley   if (!dm->ops->projectbdfieldlabellocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectBdFieldLabelLocal",((PetscObject)dm)->type_name);
9001ece3a9fcSMatthew G. Knepley   ierr = (dm->ops->projectbdfieldlabellocal)(dm, time, label, numIds, ids, Nc, comps, localU, funcs, mode, localX);CHKERRQ(ierr);
9002ece3a9fcSMatthew G. Knepley   PetscFunctionReturn(0);
9003ece3a9fcSMatthew G. Knepley }
9004ece3a9fcSMatthew G. Knepley 
9005ece3a9fcSMatthew G. Knepley /*@C
90062716604bSToby Isaac   DMComputeL2Diff - This function computes the L_2 difference between a function u and an FEM interpolant solution u_h.
90072716604bSToby Isaac 
90082716604bSToby Isaac   Input Parameters:
90092716604bSToby Isaac + dm    - The DM
90100709b2feSToby Isaac . time  - The time
90112716604bSToby Isaac . funcs - The functions to evaluate for each field component
90122716604bSToby Isaac . ctxs  - Optional array of contexts to pass to each function, or NULL.
9013574a98acSMatthew G. Knepley - X     - The coefficient vector u_h, a global vector
90142716604bSToby Isaac 
90152716604bSToby Isaac   Output Parameter:
90162716604bSToby Isaac . diff - The diff ||u - u_h||_2
90172716604bSToby Isaac 
90182716604bSToby Isaac   Level: developer
90192716604bSToby Isaac 
90201189c1efSToby Isaac .seealso: DMProjectFunction(), DMComputeL2FieldDiff(), DMComputeL2GradientDiff()
90212716604bSToby Isaac @*/
90220709b2feSToby Isaac PetscErrorCode DMComputeL2Diff(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, Vec X, PetscReal *diff)
90232716604bSToby Isaac {
90242716604bSToby Isaac   PetscErrorCode ierr;
90252716604bSToby Isaac 
90262716604bSToby Isaac   PetscFunctionBegin;
90272716604bSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
9028b698f381SToby Isaac   PetscValidHeaderSpecific(X,VEC_CLASSID,5);
90290918c465SMatthew G. Knepley   if (!dm->ops->computel2diff) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2Diff",((PetscObject)dm)->type_name);
90300709b2feSToby Isaac   ierr = (dm->ops->computel2diff)(dm,time,funcs,ctxs,X,diff);CHKERRQ(ierr);
90312716604bSToby Isaac   PetscFunctionReturn(0);
90322716604bSToby Isaac }
9033b698f381SToby Isaac 
9034b698f381SToby Isaac /*@C
9035b698f381SToby Isaac   DMComputeL2GradientDiff - This function computes the L_2 difference between the gradient of a function u and an FEM interpolant solution grad u_h.
9036b698f381SToby Isaac 
9037d083f849SBarry Smith   Collective on dm
9038d083f849SBarry Smith 
9039b698f381SToby Isaac   Input Parameters:
9040b698f381SToby Isaac + dm    - The DM
9041b698f381SToby Isaac , time  - The time
9042b698f381SToby Isaac . funcs - The gradient functions to evaluate for each field component
9043b698f381SToby Isaac . ctxs  - Optional array of contexts to pass to each function, or NULL.
9044574a98acSMatthew G. Knepley . X     - The coefficient vector u_h, a global vector
9045b698f381SToby Isaac - n     - The vector to project along
9046b698f381SToby Isaac 
9047b698f381SToby Isaac   Output Parameter:
9048b698f381SToby Isaac . diff - The diff ||(grad u - grad u_h) . n||_2
9049b698f381SToby Isaac 
9050b698f381SToby Isaac   Level: developer
9051b698f381SToby Isaac 
9052b698f381SToby Isaac .seealso: DMProjectFunction(), DMComputeL2Diff()
9053b698f381SToby Isaac @*/
9054b698f381SToby 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)
9055b698f381SToby Isaac {
9056b698f381SToby Isaac   PetscErrorCode ierr;
9057b698f381SToby Isaac 
9058b698f381SToby Isaac   PetscFunctionBegin;
9059b698f381SToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
9060b698f381SToby Isaac   PetscValidHeaderSpecific(X,VEC_CLASSID,5);
9061b698f381SToby Isaac   if (!dm->ops->computel2gradientdiff) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2GradientDiff",((PetscObject)dm)->type_name);
9062b698f381SToby Isaac   ierr = (dm->ops->computel2gradientdiff)(dm,time,funcs,ctxs,X,n,diff);CHKERRQ(ierr);
9063b698f381SToby Isaac   PetscFunctionReturn(0);
9064b698f381SToby Isaac }
9065b698f381SToby Isaac 
90662a16baeaSToby Isaac /*@C
90672a16baeaSToby Isaac   DMComputeL2FieldDiff - This function computes the L_2 difference between a function u and an FEM interpolant solution u_h, separated into field components.
90682a16baeaSToby Isaac 
9069d083f849SBarry Smith   Collective on dm
9070d083f849SBarry Smith 
90712a16baeaSToby Isaac   Input Parameters:
90722a16baeaSToby Isaac + dm    - The DM
90732a16baeaSToby Isaac . time  - The time
90742a16baeaSToby Isaac . funcs - The functions to evaluate for each field component
90752a16baeaSToby Isaac . ctxs  - Optional array of contexts to pass to each function, or NULL.
9076574a98acSMatthew G. Knepley - X     - The coefficient vector u_h, a global vector
90772a16baeaSToby Isaac 
90782a16baeaSToby Isaac   Output Parameter:
90792a16baeaSToby Isaac . diff - The array of differences, ||u^f - u^f_h||_2
90802a16baeaSToby Isaac 
90812a16baeaSToby Isaac   Level: developer
90822a16baeaSToby Isaac 
90831189c1efSToby Isaac .seealso: DMProjectFunction(), DMComputeL2FieldDiff(), DMComputeL2GradientDiff()
90842a16baeaSToby Isaac @*/
90851189c1efSToby Isaac PetscErrorCode DMComputeL2FieldDiff(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, Vec X, PetscReal diff[])
90862a16baeaSToby Isaac {
90872a16baeaSToby Isaac   PetscErrorCode ierr;
90882a16baeaSToby Isaac 
90892a16baeaSToby Isaac   PetscFunctionBegin;
90902a16baeaSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
90912a16baeaSToby Isaac   PetscValidHeaderSpecific(X,VEC_CLASSID,5);
90920918c465SMatthew G. Knepley   if (!dm->ops->computel2fielddiff) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2FieldDiff",((PetscObject)dm)->type_name);
90932a16baeaSToby Isaac   ierr = (dm->ops->computel2fielddiff)(dm,time,funcs,ctxs,X,diff);CHKERRQ(ierr);
90942a16baeaSToby Isaac   PetscFunctionReturn(0);
90952a16baeaSToby Isaac }
90962a16baeaSToby Isaac 
9097df0b854cSToby Isaac /*@C
9098df0b854cSToby Isaac   DMAdaptLabel - Adapt a dm based on a label with values interpreted as coarsening and refining flags.  Specific implementations of DM maybe have
9099cd3c525cSToby Isaac                  specialized flags, but all implementations should accept flag values DM_ADAPT_DETERMINE, DM_ADAPT_KEEP, DM_ADAPT_REFINE, and DM_ADAPT_COARSEN.
9100df0b854cSToby Isaac 
9101df0b854cSToby Isaac   Collective on dm
9102df0b854cSToby Isaac 
9103df0b854cSToby Isaac   Input parameters:
9104df0b854cSToby Isaac + dm - the pre-adaptation DM object
9105a1b0c543SToby Isaac - label - label with the flags
9106df0b854cSToby Isaac 
9107df0b854cSToby Isaac   Output parameters:
91080d1cd5e0SMatthew G. Knepley . dmAdapt - the adapted DM object: may be NULL if an adapted DM could not be produced.
9109df0b854cSToby Isaac 
9110df0b854cSToby Isaac   Level: intermediate
91110d1cd5e0SMatthew G. Knepley 
91120d1cd5e0SMatthew G. Knepley .seealso: DMAdaptMetric(), DMCoarsen(), DMRefine()
9113df0b854cSToby Isaac @*/
91140d1cd5e0SMatthew G. Knepley PetscErrorCode DMAdaptLabel(DM dm, DMLabel label, DM *dmAdapt)
9115df0b854cSToby Isaac {
9116df0b854cSToby Isaac   PetscErrorCode ierr;
9117df0b854cSToby Isaac 
9118df0b854cSToby Isaac   PetscFunctionBegin;
9119df0b854cSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
9120a1b0c543SToby Isaac   PetscValidPointer(label,2);
91210d1cd5e0SMatthew G. Knepley   PetscValidPointer(dmAdapt,3);
91220d1cd5e0SMatthew G. Knepley   *dmAdapt = NULL;
91236f25b0d8SLisandro Dalcin   if (!dm->ops->adaptlabel) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMAdaptLabel",((PetscObject)dm)->type_name);
91240d1cd5e0SMatthew G. Knepley   ierr = (dm->ops->adaptlabel)(dm, label, dmAdapt);CHKERRQ(ierr);
9125a587d139SMark   if (*dmAdapt) {
9126a587d139SMark     (*dmAdapt)->prealloc_only = dm->prealloc_only;  /* maybe this should go .... */
9127a587d139SMark     ierr = PetscFree((*dmAdapt)->vectype);CHKERRQ(ierr);
9128a587d139SMark     ierr = PetscStrallocpy(dm->vectype,(char**)&(*dmAdapt)->vectype);CHKERRQ(ierr);
9129a587d139SMark     ierr = PetscFree((*dmAdapt)->mattype);CHKERRQ(ierr);
9130a587d139SMark     ierr = PetscStrallocpy(dm->mattype,(char**)&(*dmAdapt)->mattype);CHKERRQ(ierr);
9131a587d139SMark   }
91320d1cd5e0SMatthew G. Knepley   PetscFunctionReturn(0);
91330d1cd5e0SMatthew G. Knepley }
91340d1cd5e0SMatthew G. Knepley 
91350d1cd5e0SMatthew G. Knepley /*@C
91360d1cd5e0SMatthew G. Knepley   DMAdaptMetric - Generates a mesh adapted to the specified metric field using the pragmatic library.
91370d1cd5e0SMatthew G. Knepley 
91380d1cd5e0SMatthew G. Knepley   Input Parameters:
91390d1cd5e0SMatthew G. Knepley + dm - The DM object
91400d1cd5e0SMatthew G. Knepley . metric - The metric to which the mesh is adapted, defined vertex-wise.
91416f25b0d8SLisandro 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_".
91420d1cd5e0SMatthew G. Knepley 
91430d1cd5e0SMatthew G. Knepley   Output Parameter:
91440d1cd5e0SMatthew G. Knepley . dmAdapt  - Pointer to the DM object containing the adapted mesh
91450d1cd5e0SMatthew G. Knepley 
91460d1cd5e0SMatthew G. Knepley   Note: The label in the adapted mesh will be registered under the name of the input DMLabel object
91470d1cd5e0SMatthew G. Knepley 
91480d1cd5e0SMatthew G. Knepley   Level: advanced
91490d1cd5e0SMatthew G. Knepley 
91500d1cd5e0SMatthew G. Knepley .seealso: DMAdaptLabel(), DMCoarsen(), DMRefine()
91510d1cd5e0SMatthew G. Knepley @*/
91520d1cd5e0SMatthew G. Knepley PetscErrorCode DMAdaptMetric(DM dm, Vec metric, DMLabel bdLabel, DM *dmAdapt)
91530d1cd5e0SMatthew G. Knepley {
91540d1cd5e0SMatthew G. Knepley   PetscErrorCode ierr;
91550d1cd5e0SMatthew G. Knepley 
91560d1cd5e0SMatthew G. Knepley   PetscFunctionBegin;
91570d1cd5e0SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
91580d1cd5e0SMatthew G. Knepley   PetscValidHeaderSpecific(metric, VEC_CLASSID, 2);
91590d1cd5e0SMatthew G. Knepley   if (bdLabel) PetscValidPointer(bdLabel, 3);
91600d1cd5e0SMatthew G. Knepley   PetscValidPointer(dmAdapt, 4);
91616f25b0d8SLisandro Dalcin   *dmAdapt = NULL;
91626f25b0d8SLisandro Dalcin   if (!dm->ops->adaptmetric) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMAdaptMetric",((PetscObject)dm)->type_name);
91630d1cd5e0SMatthew G. Knepley   ierr = (dm->ops->adaptmetric)(dm, metric, bdLabel, dmAdapt);CHKERRQ(ierr);
9164df0b854cSToby Isaac   PetscFunctionReturn(0);
9165df0b854cSToby Isaac }
9166c4088d22SMatthew G. Knepley 
9167502a2867SDave May /*@C
9168502a2867SDave May  DMGetNeighbors - Gets an array containing the MPI rank of all the processes neighbors
9169502a2867SDave May 
9170502a2867SDave May  Not Collective
9171502a2867SDave May 
9172502a2867SDave May  Input Parameter:
9173502a2867SDave May .  dm    - The DM
9174502a2867SDave May 
91750a19bb7dSprj-  Output Parameters:
91760a19bb7dSprj- +  nranks - the number of neighbours
91770a19bb7dSprj- -  ranks - the neighbors ranks
9178502a2867SDave May 
9179502a2867SDave May  Notes:
9180502a2867SDave May  Do not free the array, it is freed when the DM is destroyed.
9181502a2867SDave May 
9182502a2867SDave May  Level: beginner
9183502a2867SDave May 
9184dec1416fSJunchao Zhang  .seealso: DMDAGetNeighbors(), PetscSFGetRootRanks()
9185502a2867SDave May @*/
9186502a2867SDave May PetscErrorCode DMGetNeighbors(DM dm,PetscInt *nranks,const PetscMPIInt *ranks[])
9187502a2867SDave May {
9188502a2867SDave May   PetscErrorCode ierr;
9189502a2867SDave May 
9190502a2867SDave May   PetscFunctionBegin;
9191502a2867SDave May   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
91920918c465SMatthew G. Knepley   if (!dm->ops->getneighbors) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMGetNeighbors",((PetscObject)dm)->type_name);
9193502a2867SDave May   ierr = (dm->ops->getneighbors)(dm,nranks,ranks);CHKERRQ(ierr);
9194502a2867SDave May   PetscFunctionReturn(0);
9195502a2867SDave May }
9196502a2867SDave May 
9197531c7667SBarry Smith #include <petsc/private/matimpl.h> /* Needed because of coloring->ctype below */
9198531c7667SBarry Smith 
9199531c7667SBarry Smith /*
9200531c7667SBarry Smith     Converts the input vector to a ghosted vector and then calls the standard coloring code.
9201531c7667SBarry Smith     This has be a different function because it requires DM which is not defined in the Mat library
9202531c7667SBarry Smith */
9203531c7667SBarry Smith PetscErrorCode  MatFDColoringApply_AIJDM(Mat J,MatFDColoring coloring,Vec x1,void *sctx)
9204531c7667SBarry Smith {
9205531c7667SBarry Smith   PetscErrorCode ierr;
9206531c7667SBarry Smith 
9207531c7667SBarry Smith   PetscFunctionBegin;
9208531c7667SBarry Smith   if (coloring->ctype == IS_COLORING_LOCAL) {
9209531c7667SBarry Smith     Vec x1local;
9210531c7667SBarry Smith     DM  dm;
9211531c7667SBarry Smith     ierr = MatGetDM(J,&dm);CHKERRQ(ierr);
9212531c7667SBarry Smith     if (!dm) SETERRQ(PetscObjectComm((PetscObject)J),PETSC_ERR_ARG_INCOMP,"IS_COLORING_LOCAL requires a DM");
9213531c7667SBarry Smith     ierr = DMGetLocalVector(dm,&x1local);CHKERRQ(ierr);
9214531c7667SBarry Smith     ierr = DMGlobalToLocalBegin(dm,x1,INSERT_VALUES,x1local);CHKERRQ(ierr);
9215531c7667SBarry Smith     ierr = DMGlobalToLocalEnd(dm,x1,INSERT_VALUES,x1local);CHKERRQ(ierr);
9216531c7667SBarry Smith     x1   = x1local;
9217531c7667SBarry Smith   }
9218531c7667SBarry Smith   ierr = MatFDColoringApply_AIJ(J,coloring,x1,sctx);CHKERRQ(ierr);
9219531c7667SBarry Smith   if (coloring->ctype == IS_COLORING_LOCAL) {
9220531c7667SBarry Smith     DM  dm;
9221531c7667SBarry Smith     ierr = MatGetDM(J,&dm);CHKERRQ(ierr);
9222531c7667SBarry Smith     ierr = DMRestoreLocalVector(dm,&x1);CHKERRQ(ierr);
9223531c7667SBarry Smith   }
9224531c7667SBarry Smith   PetscFunctionReturn(0);
9225531c7667SBarry Smith }
9226531c7667SBarry Smith 
9227531c7667SBarry Smith /*@
9228531c7667SBarry Smith     MatFDColoringUseDM - allows a MatFDColoring object to use the DM associated with the matrix to use a IS_COLORING_LOCAL coloring
9229531c7667SBarry Smith 
9230531c7667SBarry Smith     Input Parameter:
9231531c7667SBarry Smith .    coloring - the MatFDColoring object
9232531c7667SBarry Smith 
923395452b02SPatrick Sanan     Developer Notes:
923495452b02SPatrick Sanan     this routine exists because the PETSc Mat library does not know about the DM objects
9235531c7667SBarry Smith 
92361b266c99SBarry Smith     Level: advanced
92371b266c99SBarry Smith 
9238531c7667SBarry Smith .seealso: MatFDColoring, MatFDColoringCreate(), ISColoringType
9239531c7667SBarry Smith @*/
9240531c7667SBarry Smith PetscErrorCode  MatFDColoringUseDM(Mat coloring,MatFDColoring fdcoloring)
9241531c7667SBarry Smith {
9242531c7667SBarry Smith   PetscFunctionBegin;
9243531c7667SBarry Smith   coloring->ops->fdcoloringapply = MatFDColoringApply_AIJDM;
9244531c7667SBarry Smith   PetscFunctionReturn(0);
9245531c7667SBarry Smith }
92468320bc6fSPatrick Sanan 
92478320bc6fSPatrick Sanan /*@
92488320bc6fSPatrick Sanan     DMGetCompatibility - determine if two DMs are compatible
92498320bc6fSPatrick Sanan 
92508320bc6fSPatrick Sanan     Collective
92518320bc6fSPatrick Sanan 
92528320bc6fSPatrick Sanan     Input Parameters:
9253a5bc1bf3SBarry Smith +    dm1 - the first DM
92548320bc6fSPatrick Sanan -    dm2 - the second DM
92558320bc6fSPatrick Sanan 
92568320bc6fSPatrick Sanan     Output Parameters:
92578320bc6fSPatrick Sanan +    compatible - whether or not the two DMs are compatible
92588320bc6fSPatrick Sanan -    set - whether or not the compatible value was set
92598320bc6fSPatrick Sanan 
92608320bc6fSPatrick Sanan     Notes:
92618320bc6fSPatrick Sanan     Two DMs are deemed compatible if they represent the same parallel decomposition
92623d862458SPatrick Sanan     of the same topology. This implies that the section (field data) on one
92638320bc6fSPatrick Sanan     "makes sense" with respect to the topology and parallel decomposition of the other.
92643d862458SPatrick Sanan     Loosely speaking, compatible DMs represent the same domain and parallel
92653d862458SPatrick Sanan     decomposition, but hold different data.
92668320bc6fSPatrick Sanan 
92678320bc6fSPatrick Sanan     Typically, one would confirm compatibility if intending to simultaneously iterate
92688320bc6fSPatrick Sanan     over a pair of vectors obtained from different DMs.
92698320bc6fSPatrick Sanan 
92708320bc6fSPatrick Sanan     For example, two DMDA objects are compatible if they have the same local
92718320bc6fSPatrick Sanan     and global sizes and the same stencil width. They can have different numbers
92728320bc6fSPatrick Sanan     of degrees of freedom per node. Thus, one could use the node numbering from
92738320bc6fSPatrick Sanan     either DM in bounds for a loop over vectors derived from either DM.
92748320bc6fSPatrick Sanan 
92758320bc6fSPatrick Sanan     Consider the operation of summing data living on a 2-dof DMDA to data living
92768320bc6fSPatrick Sanan     on a 1-dof DMDA, which should be compatible, as in the following snippet.
92778320bc6fSPatrick Sanan .vb
92788320bc6fSPatrick Sanan   ...
92798320bc6fSPatrick Sanan   ierr = DMGetCompatibility(da1,da2,&compatible,&set);CHKERRQ(ierr);
92808320bc6fSPatrick Sanan   if (set && compatible)  {
92818320bc6fSPatrick Sanan     ierr = DMDAVecGetArrayDOF(da1,vec1,&arr1);CHKERRQ(ierr);
92828320bc6fSPatrick Sanan     ierr = DMDAVecGetArrayDOF(da2,vec2,&arr2);CHKERRQ(ierr);
92833d862458SPatrick Sanan     ierr = DMDAGetCorners(da1,&x,&y,NULL,&m,&n,NULL);CHKERRQ(ierr);
92848320bc6fSPatrick Sanan     for (j=y; j<y+n; ++j) {
92858320bc6fSPatrick Sanan       for (i=x; i<x+m, ++i) {
92868320bc6fSPatrick Sanan         arr1[j][i][0] = arr2[j][i][0] + arr2[j][i][1];
92878320bc6fSPatrick Sanan       }
92888320bc6fSPatrick Sanan     }
92898320bc6fSPatrick Sanan     ierr = DMDAVecRestoreArrayDOF(da1,vec1,&arr1);CHKERRQ(ierr);
92908320bc6fSPatrick Sanan     ierr = DMDAVecRestoreArrayDOF(da2,vec2,&arr2);CHKERRQ(ierr);
92918320bc6fSPatrick Sanan   } else {
92928320bc6fSPatrick Sanan     SETERRQ(PetscObjectComm((PetscObject)da1,PETSC_ERR_ARG_INCOMP,"DMDA objects incompatible");
92938320bc6fSPatrick Sanan   }
92948320bc6fSPatrick Sanan   ...
92958320bc6fSPatrick Sanan .ve
92968320bc6fSPatrick Sanan 
92978320bc6fSPatrick Sanan     Checking compatibility might be expensive for a given implementation of DM,
92988320bc6fSPatrick Sanan     or might be impossible to unambiguously confirm or deny. For this reason,
92998320bc6fSPatrick Sanan     this function may decline to determine compatibility, and hence users should
93008320bc6fSPatrick Sanan     always check the "set" output parameter.
93018320bc6fSPatrick Sanan 
93028320bc6fSPatrick Sanan     A DM is always compatible with itself.
93038320bc6fSPatrick Sanan 
93048320bc6fSPatrick Sanan     In the current implementation, DMs which live on "unequal" communicators
93058320bc6fSPatrick Sanan     (MPI_UNEQUAL in the terminology of MPI_Comm_compare()) are always deemed
93068320bc6fSPatrick Sanan     incompatible.
93078320bc6fSPatrick Sanan 
93088320bc6fSPatrick Sanan     This function is labeled "Collective," as information about all subdomains
93098320bc6fSPatrick Sanan     is required on each rank. However, in DM implementations which store all this
93108320bc6fSPatrick Sanan     information locally, this function may be merely "Logically Collective".
93118320bc6fSPatrick Sanan 
93128320bc6fSPatrick Sanan     Developer Notes:
93133d862458SPatrick Sanan     Compatibility is assumed to be a symmetric concept; DM A is compatible with DM B
93143d862458SPatrick Sanan     iff B is compatible with A. Thus, this function checks the implementations
9315a5bc1bf3SBarry Smith     of both dm and dmc (if they are of different types), attempting to determine
93168320bc6fSPatrick Sanan     compatibility. It is left to DM implementers to ensure that symmetry is
93178320bc6fSPatrick Sanan     preserved. The simplest way to do this is, when implementing type-specific
93183d862458SPatrick Sanan     logic for this function, is to check for existing logic in the implementation
93193d862458SPatrick Sanan     of other DM types and let *set = PETSC_FALSE if found.
93208320bc6fSPatrick Sanan 
93218320bc6fSPatrick Sanan     Level: advanced
93228320bc6fSPatrick Sanan 
93233d862458SPatrick Sanan .seealso: DM, DMDACreateCompatibleDMDA(), DMStagCreateCompatibleDMStag()
93248320bc6fSPatrick Sanan @*/
93258320bc6fSPatrick Sanan 
9326a5bc1bf3SBarry Smith PetscErrorCode DMGetCompatibility(DM dm1,DM dm2,PetscBool *compatible,PetscBool *set)
93278320bc6fSPatrick Sanan {
93288320bc6fSPatrick Sanan   PetscErrorCode ierr;
93298320bc6fSPatrick Sanan   PetscMPIInt    compareResult;
93308320bc6fSPatrick Sanan   DMType         type,type2;
93318320bc6fSPatrick Sanan   PetscBool      sameType;
93328320bc6fSPatrick Sanan 
93338320bc6fSPatrick Sanan   PetscFunctionBegin;
9334a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(dm1,DM_CLASSID,1);
93358320bc6fSPatrick Sanan   PetscValidHeaderSpecific(dm2,DM_CLASSID,2);
93368320bc6fSPatrick Sanan 
93378320bc6fSPatrick Sanan   /* Declare a DM compatible with itself */
9338a5bc1bf3SBarry Smith   if (dm1 == dm2) {
93398320bc6fSPatrick Sanan     *set = PETSC_TRUE;
93408320bc6fSPatrick Sanan     *compatible = PETSC_TRUE;
93418320bc6fSPatrick Sanan     PetscFunctionReturn(0);
93428320bc6fSPatrick Sanan   }
93438320bc6fSPatrick Sanan 
93448320bc6fSPatrick Sanan   /* Declare a DM incompatible with a DM that lives on an "unequal"
93458320bc6fSPatrick Sanan      communicator. Note that this does not preclude compatibility with
93468320bc6fSPatrick Sanan      DMs living on "congruent" or "similar" communicators, but this must be
93478320bc6fSPatrick Sanan      determined by the implementation-specific logic */
9348ffc4695bSBarry Smith   ierr = MPI_Comm_compare(PetscObjectComm((PetscObject)dm1),PetscObjectComm((PetscObject)dm2),&compareResult);CHKERRMPI(ierr);
93498320bc6fSPatrick Sanan   if (compareResult == MPI_UNEQUAL) {
93508320bc6fSPatrick Sanan     *set = PETSC_TRUE;
93518320bc6fSPatrick Sanan     *compatible = PETSC_FALSE;
93528320bc6fSPatrick Sanan     PetscFunctionReturn(0);
93538320bc6fSPatrick Sanan   }
93548320bc6fSPatrick Sanan 
93558320bc6fSPatrick Sanan   /* Pass to the implementation-specific routine, if one exists. */
9356a5bc1bf3SBarry Smith   if (dm1->ops->getcompatibility) {
9357a5bc1bf3SBarry Smith     ierr = (*dm1->ops->getcompatibility)(dm1,dm2,compatible,set);CHKERRQ(ierr);
9358b9d85ea2SLisandro Dalcin     if (*set) PetscFunctionReturn(0);
93598320bc6fSPatrick Sanan   }
93608320bc6fSPatrick Sanan 
9361a5bc1bf3SBarry Smith   /* If dm1 and dm2 are of different types, then attempt to check compatibility
93628320bc6fSPatrick Sanan      with an implementation of this function from dm2 */
9363a5bc1bf3SBarry Smith   ierr = DMGetType(dm1,&type);CHKERRQ(ierr);
93648320bc6fSPatrick Sanan   ierr = DMGetType(dm2,&type2);CHKERRQ(ierr);
93658320bc6fSPatrick Sanan   ierr = PetscStrcmp(type,type2,&sameType);CHKERRQ(ierr);
93668320bc6fSPatrick Sanan   if (!sameType && dm2->ops->getcompatibility) {
9367a5bc1bf3SBarry Smith     ierr = (*dm2->ops->getcompatibility)(dm2,dm1,compatible,set);CHKERRQ(ierr); /* Note argument order */
93688320bc6fSPatrick Sanan   } else {
93698320bc6fSPatrick Sanan     *set = PETSC_FALSE;
93708320bc6fSPatrick Sanan   }
93718320bc6fSPatrick Sanan   PetscFunctionReturn(0);
93728320bc6fSPatrick Sanan }
9373c0f0dcc3SMatthew G. Knepley 
9374c0f0dcc3SMatthew G. Knepley /*@C
9375c0f0dcc3SMatthew G. Knepley   DMMonitorSet - Sets an ADDITIONAL function that is to be used after a solve to monitor discretization performance.
9376c0f0dcc3SMatthew G. Knepley 
9377c0f0dcc3SMatthew G. Knepley   Logically Collective on DM
9378c0f0dcc3SMatthew G. Knepley 
9379c0f0dcc3SMatthew G. Knepley   Input Parameters:
9380c0f0dcc3SMatthew G. Knepley + DM - the DM
9381c0f0dcc3SMatthew G. Knepley . f - the monitor function
9382c0f0dcc3SMatthew G. Knepley . mctx - [optional] user-defined context for private data for the monitor routine (use NULL if no context is desired)
9383c0f0dcc3SMatthew G. Knepley - monitordestroy - [optional] routine that frees monitor context (may be NULL)
9384c0f0dcc3SMatthew G. Knepley 
9385c0f0dcc3SMatthew G. Knepley   Options Database Keys:
9386c0f0dcc3SMatthew G. Knepley - -dm_monitor_cancel - cancels all monitors that have been hardwired into a code by calls to DMMonitorSet(), but
9387c0f0dcc3SMatthew G. Knepley                             does not cancel those set via the options database.
9388c0f0dcc3SMatthew G. Knepley 
9389c0f0dcc3SMatthew G. Knepley   Notes:
9390c0f0dcc3SMatthew G. Knepley   Several different monitoring routines may be set by calling
9391c0f0dcc3SMatthew G. Knepley   DMMonitorSet() multiple times; all will be called in the
9392c0f0dcc3SMatthew G. Knepley   order in which they were set.
9393c0f0dcc3SMatthew G. Knepley 
9394c0f0dcc3SMatthew G. Knepley   Fortran Notes:
9395c0f0dcc3SMatthew G. Knepley   Only a single monitor function can be set for each DM object
9396c0f0dcc3SMatthew G. Knepley 
9397c0f0dcc3SMatthew G. Knepley   Level: intermediate
9398c0f0dcc3SMatthew G. Knepley 
9399c0f0dcc3SMatthew G. Knepley .seealso: DMMonitorCancel()
9400c0f0dcc3SMatthew G. Knepley @*/
9401c0f0dcc3SMatthew G. Knepley PetscErrorCode DMMonitorSet(DM dm, PetscErrorCode (*f)(DM, void *), void *mctx, PetscErrorCode (*monitordestroy)(void**))
9402c0f0dcc3SMatthew G. Knepley {
9403c0f0dcc3SMatthew G. Knepley   PetscInt       m;
9404c0f0dcc3SMatthew G. Knepley   PetscErrorCode ierr;
9405c0f0dcc3SMatthew G. Knepley 
9406c0f0dcc3SMatthew G. Knepley   PetscFunctionBegin;
9407c0f0dcc3SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
9408c0f0dcc3SMatthew G. Knepley   for (m = 0; m < dm->numbermonitors; ++m) {
9409c0f0dcc3SMatthew G. Knepley     PetscBool identical;
9410c0f0dcc3SMatthew G. Knepley 
9411c0f0dcc3SMatthew G. Knepley     ierr = PetscMonitorCompare((PetscErrorCode (*)(void)) f, mctx, monitordestroy, (PetscErrorCode (*)(void)) dm->monitor[m], dm->monitorcontext[m], dm->monitordestroy[m], &identical);CHKERRQ(ierr);
9412c0f0dcc3SMatthew G. Knepley     if (identical) PetscFunctionReturn(0);
9413c0f0dcc3SMatthew G. Knepley   }
9414c0f0dcc3SMatthew G. Knepley   if (dm->numbermonitors >= MAXDMMONITORS) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Too many monitors set");
9415c0f0dcc3SMatthew G. Knepley   dm->monitor[dm->numbermonitors]          = f;
9416c0f0dcc3SMatthew G. Knepley   dm->monitordestroy[dm->numbermonitors]   = monitordestroy;
9417c0f0dcc3SMatthew G. Knepley   dm->monitorcontext[dm->numbermonitors++] = (void *) mctx;
9418c0f0dcc3SMatthew G. Knepley   PetscFunctionReturn(0);
9419c0f0dcc3SMatthew G. Knepley }
9420c0f0dcc3SMatthew G. Knepley 
9421c0f0dcc3SMatthew G. Knepley /*@
9422c0f0dcc3SMatthew G. Knepley   DMMonitorCancel - Clears all the monitor functions for a DM object.
9423c0f0dcc3SMatthew G. Knepley 
9424c0f0dcc3SMatthew G. Knepley   Logically Collective on DM
9425c0f0dcc3SMatthew G. Knepley 
9426c0f0dcc3SMatthew G. Knepley   Input Parameter:
9427c0f0dcc3SMatthew G. Knepley . dm - the DM
9428c0f0dcc3SMatthew G. Knepley 
9429c0f0dcc3SMatthew G. Knepley   Options Database Key:
9430c0f0dcc3SMatthew G. Knepley . -dm_monitor_cancel - cancels all monitors that have been hardwired
9431c0f0dcc3SMatthew G. Knepley   into a code by calls to DMonitorSet(), but does not cancel those
9432c0f0dcc3SMatthew G. Knepley   set via the options database
9433c0f0dcc3SMatthew G. Knepley 
9434c0f0dcc3SMatthew G. Knepley   Notes:
9435c0f0dcc3SMatthew G. Knepley   There is no way to clear one specific monitor from a DM object.
9436c0f0dcc3SMatthew G. Knepley 
9437c0f0dcc3SMatthew G. Knepley   Level: intermediate
9438c0f0dcc3SMatthew G. Knepley 
9439c0f0dcc3SMatthew G. Knepley .seealso: DMMonitorSet()
9440c0f0dcc3SMatthew G. Knepley @*/
9441c0f0dcc3SMatthew G. Knepley PetscErrorCode DMMonitorCancel(DM dm)
9442c0f0dcc3SMatthew G. Knepley {
9443c0f0dcc3SMatthew G. Knepley   PetscErrorCode ierr;
9444c0f0dcc3SMatthew G. Knepley   PetscInt       m;
9445c0f0dcc3SMatthew G. Knepley 
9446c0f0dcc3SMatthew G. Knepley   PetscFunctionBegin;
9447c0f0dcc3SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
9448c0f0dcc3SMatthew G. Knepley   for (m = 0; m < dm->numbermonitors; ++m) {
9449c0f0dcc3SMatthew G. Knepley     if (dm->monitordestroy[m]) {ierr = (*dm->monitordestroy[m])(&dm->monitorcontext[m]);CHKERRQ(ierr);}
9450c0f0dcc3SMatthew G. Knepley   }
9451c0f0dcc3SMatthew G. Knepley   dm->numbermonitors = 0;
9452c0f0dcc3SMatthew G. Knepley   PetscFunctionReturn(0);
9453c0f0dcc3SMatthew G. Knepley }
9454c0f0dcc3SMatthew G. Knepley 
9455c0f0dcc3SMatthew G. Knepley /*@C
9456c0f0dcc3SMatthew G. Knepley   DMMonitorSetFromOptions - Sets a monitor function and viewer appropriate for the type indicated by the user
9457c0f0dcc3SMatthew G. Knepley 
9458c0f0dcc3SMatthew G. Knepley   Collective on DM
9459c0f0dcc3SMatthew G. Knepley 
9460c0f0dcc3SMatthew G. Knepley   Input Parameters:
9461c0f0dcc3SMatthew G. Knepley + dm   - DM object you wish to monitor
9462c0f0dcc3SMatthew G. Knepley . name - the monitor type one is seeking
9463c0f0dcc3SMatthew G. Knepley . help - message indicating what monitoring is done
9464c0f0dcc3SMatthew G. Knepley . manual - manual page for the monitor
9465c0f0dcc3SMatthew G. Knepley . monitor - the monitor function
9466c0f0dcc3SMatthew 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
9467c0f0dcc3SMatthew G. Knepley 
9468c0f0dcc3SMatthew G. Knepley   Output Parameter:
9469c0f0dcc3SMatthew G. Knepley . flg - Flag set if the monitor was created
9470c0f0dcc3SMatthew G. Knepley 
9471c0f0dcc3SMatthew G. Knepley   Level: developer
9472c0f0dcc3SMatthew G. Knepley 
9473c0f0dcc3SMatthew G. Knepley .seealso: PetscOptionsGetViewer(), PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(),
9474c0f0dcc3SMatthew G. Knepley           PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool()
9475c0f0dcc3SMatthew G. Knepley           PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(),
9476c0f0dcc3SMatthew G. Knepley           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
9477c0f0dcc3SMatthew G. Knepley           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
9478c0f0dcc3SMatthew G. Knepley           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
9479c0f0dcc3SMatthew G. Knepley           PetscOptionsFList(), PetscOptionsEList()
9480c0f0dcc3SMatthew G. Knepley @*/
9481c0f0dcc3SMatthew 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)
9482c0f0dcc3SMatthew G. Knepley {
9483c0f0dcc3SMatthew G. Knepley   PetscViewer       viewer;
9484c0f0dcc3SMatthew G. Knepley   PetscViewerFormat format;
9485c0f0dcc3SMatthew G. Knepley   PetscErrorCode    ierr;
9486c0f0dcc3SMatthew G. Knepley 
9487c0f0dcc3SMatthew G. Knepley   PetscFunctionBegin;
9488c0f0dcc3SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
9489c0f0dcc3SMatthew G. Knepley   ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject) dm), ((PetscObject) dm)->options, ((PetscObject) dm)->prefix, name, &viewer, &format, flg);CHKERRQ(ierr);
9490c0f0dcc3SMatthew G. Knepley   if (*flg) {
9491c0f0dcc3SMatthew G. Knepley     PetscViewerAndFormat *vf;
9492c0f0dcc3SMatthew G. Knepley 
9493c0f0dcc3SMatthew G. Knepley     ierr = PetscViewerAndFormatCreate(viewer, format, &vf);CHKERRQ(ierr);
9494c0f0dcc3SMatthew G. Knepley     ierr = PetscObjectDereference((PetscObject) viewer);CHKERRQ(ierr);
9495c0f0dcc3SMatthew G. Knepley     if (monitorsetup) {ierr = (*monitorsetup)(dm, vf);CHKERRQ(ierr);}
9496c0f0dcc3SMatthew G. Knepley     ierr = DMMonitorSet(dm,(PetscErrorCode (*)(DM, void *)) monitor, vf, (PetscErrorCode (*)(void **)) PetscViewerAndFormatDestroy);CHKERRQ(ierr);
9497c0f0dcc3SMatthew G. Knepley   }
9498c0f0dcc3SMatthew G. Knepley   PetscFunctionReturn(0);
9499c0f0dcc3SMatthew G. Knepley }
9500c0f0dcc3SMatthew G. Knepley 
9501c0f0dcc3SMatthew G. Knepley /*@
9502c0f0dcc3SMatthew G. Knepley    DMMonitor - runs the user provided monitor routines, if they exist
9503c0f0dcc3SMatthew G. Knepley 
9504c0f0dcc3SMatthew G. Knepley    Collective on DM
9505c0f0dcc3SMatthew G. Knepley 
9506c0f0dcc3SMatthew G. Knepley    Input Parameters:
9507c0f0dcc3SMatthew G. Knepley .  dm - The DM
9508c0f0dcc3SMatthew G. Knepley 
9509c0f0dcc3SMatthew G. Knepley    Level: developer
9510c0f0dcc3SMatthew G. Knepley 
9511c0f0dcc3SMatthew G. Knepley .seealso: DMMonitorSet()
9512c0f0dcc3SMatthew G. Knepley @*/
9513c0f0dcc3SMatthew G. Knepley PetscErrorCode DMMonitor(DM dm)
9514c0f0dcc3SMatthew G. Knepley {
9515c0f0dcc3SMatthew G. Knepley   PetscInt       m;
9516c0f0dcc3SMatthew G. Knepley   PetscErrorCode ierr;
9517c0f0dcc3SMatthew G. Knepley 
9518c0f0dcc3SMatthew G. Knepley   PetscFunctionBegin;
9519c0f0dcc3SMatthew G. Knepley   if (!dm) PetscFunctionReturn(0);
9520c0f0dcc3SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
9521c0f0dcc3SMatthew G. Knepley   for (m = 0; m < dm->numbermonitors; ++m) {
9522c0f0dcc3SMatthew G. Knepley     ierr = (*dm->monitor[m])(dm, dm->monitorcontext[m]);CHKERRQ(ierr);
9523c0f0dcc3SMatthew G. Knepley   }
9524c0f0dcc3SMatthew G. Knepley   PetscFunctionReturn(0);
9525c0f0dcc3SMatthew G. Knepley }
95262e4af2aeSMatthew G. Knepley 
95272e4af2aeSMatthew G. Knepley /*@
95282e4af2aeSMatthew G. Knepley   DMComputeError - Computes the error assuming the user has given exact solution functions
95292e4af2aeSMatthew G. Knepley 
95302e4af2aeSMatthew G. Knepley   Collective on DM
95312e4af2aeSMatthew G. Knepley 
95322e4af2aeSMatthew G. Knepley   Input Parameters:
95332e4af2aeSMatthew G. Knepley + dm     - The DM
95342e4af2aeSMatthew G. Knepley . sol    - The solution vector
95352e4af2aeSMatthew G. Knepley . errors - An array of length Nf, the number of fields, or NULL for no output
953699c90e12SSatish Balay - errorVec - A Vec pointer, or NULL for no output
95372e4af2aeSMatthew G. Knepley 
95382e4af2aeSMatthew G. Knepley   Output Parameters:
95392e4af2aeSMatthew G. Knepley + errors   - The error in each field
95402e4af2aeSMatthew G. Knepley - errorVec - Creates a vector to hold the cellwise error
95412e4af2aeSMatthew G. Knepley 
95422e4af2aeSMatthew G. Knepley   Note: The exact solutions come from the PetscDS object, and the time comes from DMGetOutputSequenceNumber().
95432e4af2aeSMatthew G. Knepley 
95442e4af2aeSMatthew G. Knepley   Level: developer
95452e4af2aeSMatthew G. Knepley 
95462e4af2aeSMatthew G. Knepley .seealso: DMMonitorSet(), DMGetRegionNumDS(), PetscDSGetExactSolution(), DMGetOutputSequenceNumber()
95472e4af2aeSMatthew G. Knepley @*/
95482e4af2aeSMatthew G. Knepley PetscErrorCode DMComputeError(DM dm, Vec sol, PetscReal errors[], Vec *errorVec)
95492e4af2aeSMatthew G. Knepley {
95502e4af2aeSMatthew G. Knepley   PetscErrorCode (**exactSol)(PetscInt, PetscReal, const PetscReal[], PetscInt, PetscScalar[], void *);
95512e4af2aeSMatthew G. Knepley   void            **ctxs;
95522e4af2aeSMatthew G. Knepley   PetscReal         time;
95532e4af2aeSMatthew G. Knepley   PetscInt          Nf, f, Nds, s;
95542e4af2aeSMatthew G. Knepley   PetscErrorCode    ierr;
95552e4af2aeSMatthew G. Knepley 
95562e4af2aeSMatthew G. Knepley   PetscFunctionBegin;
95572e4af2aeSMatthew G. Knepley   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
95582e4af2aeSMatthew G. Knepley   ierr = PetscCalloc2(Nf, &exactSol, Nf, &ctxs);CHKERRQ(ierr);
95592e4af2aeSMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
95602e4af2aeSMatthew G. Knepley   for (s = 0; s < Nds; ++s) {
95612e4af2aeSMatthew G. Knepley     PetscDS         ds;
95622e4af2aeSMatthew G. Knepley     DMLabel         label;
95632e4af2aeSMatthew G. Knepley     IS              fieldIS;
95642e4af2aeSMatthew G. Knepley     const PetscInt *fields;
95652e4af2aeSMatthew G. Knepley     PetscInt        dsNf;
95662e4af2aeSMatthew G. Knepley 
95672e4af2aeSMatthew G. Knepley     ierr = DMGetRegionNumDS(dm, s, &label, &fieldIS, &ds);CHKERRQ(ierr);
95682e4af2aeSMatthew G. Knepley     ierr = PetscDSGetNumFields(ds, &dsNf);CHKERRQ(ierr);
95692e4af2aeSMatthew G. Knepley     if (fieldIS) {ierr = ISGetIndices(fieldIS, &fields);CHKERRQ(ierr);}
95702e4af2aeSMatthew G. Knepley     for (f = 0; f < dsNf; ++f) {
95712e4af2aeSMatthew G. Knepley       const PetscInt field = fields[f];
95722e4af2aeSMatthew G. Knepley       ierr = PetscDSGetExactSolution(ds, field, &exactSol[field], &ctxs[field]);CHKERRQ(ierr);
95732e4af2aeSMatthew G. Knepley     }
95742e4af2aeSMatthew G. Knepley     if (fieldIS) {ierr = ISRestoreIndices(fieldIS, &fields);CHKERRQ(ierr);}
95752e4af2aeSMatthew G. Knepley   }
95762e4af2aeSMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
95772e4af2aeSMatthew 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);
95782e4af2aeSMatthew G. Knepley   }
95792e4af2aeSMatthew G. Knepley   ierr = DMGetOutputSequenceNumber(dm, NULL, &time);CHKERRQ(ierr);
95802e4af2aeSMatthew G. Knepley   if (errors) {ierr = DMComputeL2FieldDiff(dm, time, exactSol, ctxs, sol, errors);CHKERRQ(ierr);}
95812e4af2aeSMatthew G. Knepley   if (errorVec) {
95822e4af2aeSMatthew G. Knepley     DM             edm;
95832e4af2aeSMatthew G. Knepley     DMPolytopeType ct;
95842e4af2aeSMatthew G. Knepley     PetscBool      simplex;
95852e4af2aeSMatthew G. Knepley     PetscInt       dim, cStart, Nf;
95862e4af2aeSMatthew G. Knepley 
95872e4af2aeSMatthew G. Knepley     ierr = DMClone(dm, &edm);CHKERRQ(ierr);
95882e4af2aeSMatthew G. Knepley     ierr = DMGetDimension(edm, &dim);CHKERRQ(ierr);
95892e4af2aeSMatthew G. Knepley     ierr = DMPlexGetHeightStratum(dm, 0, &cStart, NULL);CHKERRQ(ierr);
95902e4af2aeSMatthew G. Knepley     ierr = DMPlexGetCellType(dm, cStart, &ct);CHKERRQ(ierr);
95912e4af2aeSMatthew G. Knepley     simplex = DMPolytopeTypeGetNumVertices(ct) == DMPolytopeTypeGetDim(ct)+1 ? PETSC_TRUE : PETSC_FALSE;
95922e4af2aeSMatthew G. Knepley     ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
95932e4af2aeSMatthew G. Knepley     for (f = 0; f < Nf; ++f) {
95942e4af2aeSMatthew G. Knepley       PetscFE         fe, efe;
95952e4af2aeSMatthew G. Knepley       PetscQuadrature q;
95962e4af2aeSMatthew G. Knepley       const char     *name;
95972e4af2aeSMatthew G. Knepley 
95982e4af2aeSMatthew G. Knepley       ierr = DMGetField(dm, f, NULL, (PetscObject *) &fe);CHKERRQ(ierr);
95992e4af2aeSMatthew G. Knepley       ierr = PetscFECreateLagrange(PETSC_COMM_SELF, dim, Nf, simplex, 0, PETSC_DETERMINE, &efe);CHKERRQ(ierr);
96002e4af2aeSMatthew G. Knepley       ierr = PetscObjectGetName((PetscObject) fe, &name);CHKERRQ(ierr);
96012e4af2aeSMatthew G. Knepley       ierr = PetscObjectSetName((PetscObject) efe, name);CHKERRQ(ierr);
96022e4af2aeSMatthew G. Knepley       ierr = PetscFEGetQuadrature(fe, &q);CHKERRQ(ierr);
96032e4af2aeSMatthew G. Knepley       ierr = PetscFESetQuadrature(efe, q);CHKERRQ(ierr);
96042e4af2aeSMatthew G. Knepley       ierr = DMSetField(edm, f, NULL, (PetscObject) efe);CHKERRQ(ierr);
96052e4af2aeSMatthew G. Knepley       ierr = PetscFEDestroy(&efe);CHKERRQ(ierr);
96062e4af2aeSMatthew G. Knepley     }
96072e4af2aeSMatthew G. Knepley     ierr = DMCreateDS(edm);CHKERRQ(ierr);
96082e4af2aeSMatthew G. Knepley 
9609*1e1ea65dSPierre Jolivet     ierr = DMCreateGlobalVector(edm, errorVec);CHKERRQ(ierr);
96102e4af2aeSMatthew G. Knepley     ierr = PetscObjectSetName((PetscObject) *errorVec, "Error");CHKERRQ(ierr);
96112e4af2aeSMatthew G. Knepley     ierr = DMPlexComputeL2DiffVec(dm, time, exactSol, ctxs, sol, *errorVec);CHKERRQ(ierr);
96122e4af2aeSMatthew G. Knepley     ierr = DMDestroy(&edm);CHKERRQ(ierr);
96132e4af2aeSMatthew G. Knepley   }
96142e4af2aeSMatthew G. Knepley   ierr = PetscFree2(exactSol, ctxs);CHKERRQ(ierr);
96152e4af2aeSMatthew G. Knepley   PetscFunctionReturn(0);
96162e4af2aeSMatthew G. Knepley }
96179a2a23afSMatthew G. Knepley 
96189a2a23afSMatthew G. Knepley /*@
96199a2a23afSMatthew G. Knepley   DMGetNumAuxiliaryVec - Get the number of auxiliary vectors associated with this DM
96209a2a23afSMatthew G. Knepley 
96219a2a23afSMatthew G. Knepley   Not collective
96229a2a23afSMatthew G. Knepley 
96239a2a23afSMatthew G. Knepley   Input Parameter:
96249a2a23afSMatthew G. Knepley . dm     - The DM
96259a2a23afSMatthew G. Knepley 
96269a2a23afSMatthew G. Knepley   Output Parameter:
96279a2a23afSMatthew G. Knepley . numAux - The nubmer of auxiliary data vectors
96289a2a23afSMatthew G. Knepley 
96299a2a23afSMatthew G. Knepley   Level: advanced
96309a2a23afSMatthew G. Knepley 
96319a2a23afSMatthew G. Knepley .seealso: DMGetAuxiliaryLabels(), DMGetAuxiliaryVec(), DMSetAuxiliaryVec()
96329a2a23afSMatthew G. Knepley @*/
96339a2a23afSMatthew G. Knepley PetscErrorCode DMGetNumAuxiliaryVec(DM dm, PetscInt *numAux)
96349a2a23afSMatthew G. Knepley {
96359a2a23afSMatthew G. Knepley   PetscErrorCode ierr;
96369a2a23afSMatthew G. Knepley 
96379a2a23afSMatthew G. Knepley   PetscFunctionBegin;
96389a2a23afSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
96399a2a23afSMatthew G. Knepley   ierr = PetscHMapAuxGetSize(dm->auxData, numAux);CHKERRQ(ierr);
96409a2a23afSMatthew G. Knepley   PetscFunctionReturn(0);
96419a2a23afSMatthew G. Knepley }
96429a2a23afSMatthew G. Knepley 
96439a2a23afSMatthew G. Knepley /*@
96449a2a23afSMatthew G. Knepley   DMGetAuxiliaryVec - Get the auxiliary vector for region specified by the given label and value
96459a2a23afSMatthew G. Knepley 
96469a2a23afSMatthew G. Knepley   Not collective
96479a2a23afSMatthew G. Knepley 
96489a2a23afSMatthew G. Knepley   Input Parameters:
96499a2a23afSMatthew G. Knepley + dm     - The DM
96509a2a23afSMatthew G. Knepley . label  - The DMLabel
96519a2a23afSMatthew G. Knepley - value  - The label value indicating the region
96529a2a23afSMatthew G. Knepley 
96539a2a23afSMatthew G. Knepley   Output Parameter:
96549a2a23afSMatthew G. Knepley . aux    - The Vec holding auxiliary field data
96559a2a23afSMatthew G. Knepley 
965604c51a94SMatthew G. Knepley   Note: If no auxiliary vector is found for this (label, value), (NULL, 0) is checked as well.
965704c51a94SMatthew G. Knepley 
96589a2a23afSMatthew G. Knepley   Level: advanced
96599a2a23afSMatthew G. Knepley 
96609a2a23afSMatthew G. Knepley .seealso: DMSetAuxiliaryVec(), DMGetNumAuxiliaryVec()
96619a2a23afSMatthew G. Knepley @*/
96629a2a23afSMatthew G. Knepley PetscErrorCode DMGetAuxiliaryVec(DM dm, DMLabel label, PetscInt value, Vec *aux)
96639a2a23afSMatthew G. Knepley {
966404c51a94SMatthew G. Knepley   PetscHashAuxKey key, wild = {NULL, 0};
966504c51a94SMatthew G. Knepley   PetscBool       has;
96669a2a23afSMatthew G. Knepley   PetscErrorCode  ierr;
96679a2a23afSMatthew G. Knepley 
96689a2a23afSMatthew G. Knepley   PetscFunctionBegin;
96699a2a23afSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
96709a2a23afSMatthew G. Knepley   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
96719a2a23afSMatthew G. Knepley   key.label = label;
96729a2a23afSMatthew G. Knepley   key.value = value;
967304c51a94SMatthew G. Knepley   ierr = PetscHMapAuxHas(dm->auxData, key, &has);CHKERRQ(ierr);
967404c51a94SMatthew G. Knepley   if (has) {ierr = PetscHMapAuxGet(dm->auxData, key,  aux);CHKERRQ(ierr);}
967504c51a94SMatthew G. Knepley   else     {ierr = PetscHMapAuxGet(dm->auxData, wild, aux);CHKERRQ(ierr);}
96769a2a23afSMatthew G. Knepley   PetscFunctionReturn(0);
96779a2a23afSMatthew G. Knepley }
96789a2a23afSMatthew G. Knepley 
96799a2a23afSMatthew G. Knepley /*@
96809a2a23afSMatthew G. Knepley   DMSetAuxiliaryVec - Set the auxiliary vector for region specified by the given label and value
96819a2a23afSMatthew G. Knepley 
96829a2a23afSMatthew G. Knepley   Not collective
96839a2a23afSMatthew G. Knepley 
96849a2a23afSMatthew G. Knepley   Input Parameters:
96859a2a23afSMatthew G. Knepley + dm     - The DM
96869a2a23afSMatthew G. Knepley . label  - The DMLabel
96879a2a23afSMatthew G. Knepley . value  - The label value indicating the region
96889a2a23afSMatthew G. Knepley - aux    - The Vec holding auxiliary field data
96899a2a23afSMatthew G. Knepley 
96909a2a23afSMatthew G. Knepley   Level: advanced
96919a2a23afSMatthew G. Knepley 
96929a2a23afSMatthew G. Knepley .seealso: DMGetAuxiliaryVec()
96939a2a23afSMatthew G. Knepley @*/
96949a2a23afSMatthew G. Knepley PetscErrorCode DMSetAuxiliaryVec(DM dm, DMLabel label, PetscInt value, Vec aux)
96959a2a23afSMatthew G. Knepley {
96969a2a23afSMatthew G. Knepley   Vec             old;
96979a2a23afSMatthew G. Knepley   PetscHashAuxKey key;
96989a2a23afSMatthew G. Knepley   PetscErrorCode  ierr;
96999a2a23afSMatthew G. Knepley 
97009a2a23afSMatthew G. Knepley   PetscFunctionBegin;
97019a2a23afSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
97029a2a23afSMatthew G. Knepley   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
97039a2a23afSMatthew G. Knepley   key.label = label;
97049a2a23afSMatthew G. Knepley   key.value = value;
97059a2a23afSMatthew G. Knepley   ierr = PetscHMapAuxGet(dm->auxData, key, &old);CHKERRQ(ierr);
97069a2a23afSMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) aux);CHKERRQ(ierr);
97079a2a23afSMatthew G. Knepley   ierr = PetscObjectDereference((PetscObject) old);CHKERRQ(ierr);
97089a2a23afSMatthew G. Knepley   if (!aux) {ierr = PetscHMapAuxDel(dm->auxData, key);CHKERRQ(ierr);}
97099a2a23afSMatthew G. Knepley   else      {ierr = PetscHMapAuxSet(dm->auxData, key, aux);CHKERRQ(ierr);}
97109a2a23afSMatthew G. Knepley   PetscFunctionReturn(0);
97119a2a23afSMatthew G. Knepley }
97129a2a23afSMatthew G. Knepley 
97139a2a23afSMatthew G. Knepley /*@C
97149a2a23afSMatthew G. Knepley   DMGetAuxiliaryLabels - Get the labels and values for all auxiliary vectors in this DM
97159a2a23afSMatthew G. Knepley 
97169a2a23afSMatthew G. Knepley   Not collective
97179a2a23afSMatthew G. Knepley 
97189a2a23afSMatthew G. Knepley   Input Parameter:
97199a2a23afSMatthew G. Knepley . dm      - The DM
97209a2a23afSMatthew G. Knepley 
97219a2a23afSMatthew G. Knepley   Output Parameters:
97229a2a23afSMatthew G. Knepley + labels  - The DMLabels for each Vec
97239a2a23afSMatthew G. Knepley - values  - The label values for each Vec
97249a2a23afSMatthew G. Knepley 
97259a2a23afSMatthew G. Knepley   Note: The arrays passed in must be at least as large as DMGetNumAuxiliaryVec().
97269a2a23afSMatthew G. Knepley 
97279a2a23afSMatthew G. Knepley   Level: advanced
97289a2a23afSMatthew G. Knepley 
97299a2a23afSMatthew G. Knepley .seealso: DMGetNumAuxiliaryVec(), DMGetAuxiliaryVec(), DMSetAuxiliaryVec()
97309a2a23afSMatthew G. Knepley @*/
97319a2a23afSMatthew G. Knepley PetscErrorCode DMGetAuxiliaryLabels(DM dm, DMLabel labels[], PetscInt values[])
97329a2a23afSMatthew G. Knepley {
97339a2a23afSMatthew G. Knepley   PetscHashAuxKey *keys;
97349a2a23afSMatthew G. Knepley   PetscInt         n, i, off = 0;
97359a2a23afSMatthew G. Knepley   PetscErrorCode   ierr;
97369a2a23afSMatthew G. Knepley 
97379a2a23afSMatthew G. Knepley   PetscFunctionBegin;
97389a2a23afSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
97399a2a23afSMatthew G. Knepley   PetscValidPointer(labels, 2);
97409a2a23afSMatthew G. Knepley   PetscValidPointer(values, 3);
97419a2a23afSMatthew G. Knepley   ierr = DMGetNumAuxiliaryVec(dm, &n);CHKERRQ(ierr);
97429a2a23afSMatthew G. Knepley   ierr = PetscMalloc1(n, &keys);CHKERRQ(ierr);
97439a2a23afSMatthew G. Knepley   ierr = PetscHMapAuxGetKeys(dm->auxData, &off, keys);CHKERRQ(ierr);
97449a2a23afSMatthew G. Knepley   for (i = 0; i < n; ++i) {labels[i] = keys[i].label; values[i] = keys[i].value;}
97459a2a23afSMatthew G. Knepley   ierr = PetscFree(keys);CHKERRQ(ierr);
97469a2a23afSMatthew G. Knepley   PetscFunctionReturn(0);
97479a2a23afSMatthew G. Knepley }
97489a2a23afSMatthew G. Knepley 
97499a2a23afSMatthew G. Knepley /*@
97509a2a23afSMatthew G. Knepley   DMCopyAuxiliaryVec - Copy the auxiliary data to a new DM
97519a2a23afSMatthew G. Knepley 
97529a2a23afSMatthew G. Knepley   Not collective
97539a2a23afSMatthew G. Knepley 
97549a2a23afSMatthew G. Knepley   Input Parameter:
97559a2a23afSMatthew G. Knepley . dm    - The DM
97569a2a23afSMatthew G. Knepley 
97579a2a23afSMatthew G. Knepley   Output Parameter:
97589a2a23afSMatthew G. Knepley . dmNew - The new DM, now with the same auxiliary data
97599a2a23afSMatthew G. Knepley 
97609a2a23afSMatthew G. Knepley   Level: advanced
97619a2a23afSMatthew G. Knepley 
97629a2a23afSMatthew G. Knepley .seealso: DMGetNumAuxiliaryVec(), DMGetAuxiliaryVec(), DMSetAuxiliaryVec()
97639a2a23afSMatthew G. Knepley @*/
97649a2a23afSMatthew G. Knepley PetscErrorCode DMCopyAuxiliaryVec(DM dm, DM dmNew)
97659a2a23afSMatthew G. Knepley {
97669a2a23afSMatthew G. Knepley   PetscErrorCode ierr;
97679a2a23afSMatthew G. Knepley 
97689a2a23afSMatthew G. Knepley   PetscFunctionBegin;
97699a2a23afSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
97709a2a23afSMatthew G. Knepley   ierr = PetscHMapAuxDestroy(&dmNew->auxData);CHKERRQ(ierr);
97719a2a23afSMatthew G. Knepley   ierr = PetscHMapAuxDuplicate(dm->auxData, &dmNew->auxData);CHKERRQ(ierr);
97729a2a23afSMatthew G. Knepley   PetscFunctionReturn(0);
97739a2a23afSMatthew G. Knepley }
9774